Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
perf dso: kernel-doc for enum dso_binary_type
There are many and non-obvious meanings to the dso_binary_type enum
values. Add kernel-doc to speed interpretting their meanings.
Acked-by: Arnaldo Carvalho de Melo <acme@redhat.com>
Signed-off-by: Ian Rogers <irogers@google.com>
Reviewed-by: Namhyung Kim <namhyung@kernel.org>
Link: https://lore.kernel.org/r/20250319050741.269828-3-irogers@google.com
Signed-off-by: Namhyung Kim <namhyung@kernel.org>
authored by
Ian Rogers
and committed by
Namhyung Kim
4773175c
f1794ecb
+57
+57
tools/perf/util/dso.h
+57
tools/perf/util/dso.h
···
20
20
#define DSO__NAME_KALLSYMS "[kernel.kallsyms]"
21
21
#define DSO__NAME_KCORE "[kernel.kcore]"
22
22
23
+
/**
24
+
* enum dso_binary_type - The kind of DSO generally associated with a memory
25
+
* region (struct map).
26
+
*/
23
27
enum dso_binary_type {
28
+
/** @DSO_BINARY_TYPE__KALLSYMS: Symbols from /proc/kallsyms file. */
24
29
DSO_BINARY_TYPE__KALLSYMS = 0,
30
+
/** @DSO_BINARY_TYPE__GUEST_KALLSYMS: Guest /proc/kallsyms file. */
25
31
DSO_BINARY_TYPE__GUEST_KALLSYMS,
32
+
/** @DSO_BINARY_TYPE__VMLINUX: Path to kernel /boot/vmlinux file. */
26
33
DSO_BINARY_TYPE__VMLINUX,
34
+
/** @DSO_BINARY_TYPE__GUEST_VMLINUX: Path to guest kernel /boot/vmlinux file. */
27
35
DSO_BINARY_TYPE__GUEST_VMLINUX,
36
+
/** @DSO_BINARY_TYPE__JAVA_JIT: Symbols from /tmp/perf.map file. */
28
37
DSO_BINARY_TYPE__JAVA_JIT,
38
+
/**
39
+
* @DSO_BINARY_TYPE__DEBUGLINK: Debug file readable from the file path
40
+
* in the .gnu_debuglink ELF section of the dso.
41
+
*/
29
42
DSO_BINARY_TYPE__DEBUGLINK,
43
+
/**
44
+
* @DSO_BINARY_TYPE__BUILD_ID_CACHE: File named after buildid located in
45
+
* the buildid cache with an elf filename.
46
+
*/
30
47
DSO_BINARY_TYPE__BUILD_ID_CACHE,
48
+
/**
49
+
* @DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO: File named after buildid
50
+
* located in the buildid cache with a debug filename.
51
+
*/
31
52
DSO_BINARY_TYPE__BUILD_ID_CACHE_DEBUGINFO,
53
+
/**
54
+
* @DSO_BINARY_TYPE__FEDORA_DEBUGINFO: Debug file in /usr/lib/debug
55
+
* with .debug suffix.
56
+
*/
32
57
DSO_BINARY_TYPE__FEDORA_DEBUGINFO,
58
+
/** @DSO_BINARY_TYPE__UBUNTU_DEBUGINFO: Debug file in /usr/lib/debug. */
33
59
DSO_BINARY_TYPE__UBUNTU_DEBUGINFO,
60
+
/**
61
+
* @DSO_BINARY_TYPE__MIXEDUP_UBUNTU_DEBUGINFO: dso__long_name debuginfo
62
+
* file in /usr/lib/debug/lib rather than the expected
63
+
* /usr/lib/debug/usr/lib.
64
+
*/
34
65
DSO_BINARY_TYPE__MIXEDUP_UBUNTU_DEBUGINFO,
66
+
/**
67
+
* @DSO_BINARY_TYPE__BUILDID_DEBUGINFO: File named after buildid located
68
+
* in /usr/lib/debug/.build-id/.
69
+
*/
35
70
DSO_BINARY_TYPE__BUILDID_DEBUGINFO,
71
+
/**
72
+
* @DSO_BINARY_TYPE__GNU_DEBUGDATA: MiniDebuginfo where a compressed
73
+
* ELF file is placed in a .gnu_debugdata section.
74
+
*/
36
75
DSO_BINARY_TYPE__GNU_DEBUGDATA,
76
+
/** @DSO_BINARY_TYPE__SYSTEM_PATH_DSO: A regular executable/shared-object file. */
37
77
DSO_BINARY_TYPE__SYSTEM_PATH_DSO,
78
+
/** @DSO_BINARY_TYPE__GUEST_KMODULE: Guest kernel module .ko file. */
38
79
DSO_BINARY_TYPE__GUEST_KMODULE,
80
+
/** @DSO_BINARY_TYPE__GUEST_KMODULE_COMP: Guest kernel module .ko.gz file. */
39
81
DSO_BINARY_TYPE__GUEST_KMODULE_COMP,
82
+
/** @DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE: Kernel module .ko file. */
40
83
DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE,
84
+
/** @DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP: Kernel module .ko.gz file. */
41
85
DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE_COMP,
86
+
/** @DSO_BINARY_TYPE__KCORE: /proc/kcore file. */
42
87
DSO_BINARY_TYPE__KCORE,
88
+
/** @DSO_BINARY_TYPE__GUEST_KCORE: Guest /proc/kcore file. */
43
89
DSO_BINARY_TYPE__GUEST_KCORE,
90
+
/**
91
+
* @DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO: Openembedded/Yocto -dbg
92
+
* package debug info.
93
+
*/
44
94
DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO,
95
+
/** @DSO_BINARY_TYPE__BPF_PROG_INFO: jitted BPF code. */
45
96
DSO_BINARY_TYPE__BPF_PROG_INFO,
97
+
/** @DSO_BINARY_TYPE__BPF_IMAGE: jitted BPF trampoline or dispatcher code. */
46
98
DSO_BINARY_TYPE__BPF_IMAGE,
99
+
/**
100
+
* @DSO_BINARY_TYPE__OOL: out of line code such as kprobe-replaced
101
+
* instructions or optimized kprobes or ftrace trampolines.
102
+
*/
47
103
DSO_BINARY_TYPE__OOL,
104
+
/** @DSO_BINARY_TYPE__NOT_FOUND: Unknown DSO kind. */
48
105
DSO_BINARY_TYPE__NOT_FOUND,
49
106
};
50
107