Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef __PERF_MAP_H
3#define __PERF_MAP_H
4
5#include <linux/refcount.h>
6#include <linux/compiler.h>
7#include <linux/list.h>
8#include <linux/rbtree.h>
9#include <stdio.h>
10#include <string.h>
11#include <stdbool.h>
12#include <linux/types.h>
13
14struct dso;
15struct maps;
16struct machine;
17
18struct map {
19 union {
20 struct rb_node rb_node;
21 struct list_head node;
22 };
23 u64 start;
24 u64 end;
25 bool erange_warned:1;
26 bool priv:1;
27 u32 prot;
28 u64 pgoff;
29 u64 reloc;
30
31 /* ip -> dso rip */
32 u64 (*map_ip)(struct map *, u64);
33 /* dso rip -> ip */
34 u64 (*unmap_ip)(struct map *, u64);
35
36 struct dso *dso;
37 refcount_t refcnt;
38 u32 flags;
39};
40
41struct kmap;
42
43struct kmap *__map__kmap(struct map *map);
44struct kmap *map__kmap(struct map *map);
45struct maps *map__kmaps(struct map *map);
46
47static inline u64 map__map_ip(struct map *map, u64 ip)
48{
49 return ip - map->start + map->pgoff;
50}
51
52static inline u64 map__unmap_ip(struct map *map, u64 ip)
53{
54 return ip + map->start - map->pgoff;
55}
56
57static inline u64 identity__map_ip(struct map *map __maybe_unused, u64 ip)
58{
59 return ip;
60}
61
62static inline size_t map__size(const struct map *map)
63{
64 return map->end - map->start;
65}
66
67/* rip/ip <-> addr suitable for passing to `objdump --start-address=` */
68u64 map__rip_2objdump(struct map *map, u64 rip);
69
70/* objdump address -> memory address */
71u64 map__objdump_2mem(struct map *map, u64 ip);
72
73struct symbol;
74struct thread;
75
76/* map__for_each_symbol - iterate over the symbols in the given map
77 *
78 * @map: the 'struct map *' in which symbols are iterated
79 * @pos: the 'struct symbol *' to use as a loop cursor
80 * @n: the 'struct rb_node *' to use as a temporary storage
81 * Note: caller must ensure map->dso is not NULL (map is loaded).
82 */
83#define map__for_each_symbol(map, pos, n) \
84 dso__for_each_symbol(map->dso, pos, n)
85
86/* map__for_each_symbol_with_name - iterate over the symbols in the given map
87 * that have the given name
88 *
89 * @map: the 'struct map *' in which symbols are iterated
90 * @sym_name: the symbol name
91 * @pos: the 'struct symbol *' to use as a loop cursor
92 */
93#define __map__for_each_symbol_by_name(map, sym_name, pos) \
94 for (pos = map__find_symbol_by_name(map, sym_name); \
95 pos && \
96 !symbol__match_symbol_name(pos->name, sym_name, \
97 SYMBOL_TAG_INCLUDE__DEFAULT_ONLY); \
98 pos = symbol__next_by_name(pos))
99
100#define map__for_each_symbol_by_name(map, sym_name, pos) \
101 __map__for_each_symbol_by_name(map, sym_name, (pos))
102
103void map__init(struct map *map,
104 u64 start, u64 end, u64 pgoff, struct dso *dso);
105
106struct dso_id;
107struct build_id;
108
109struct map *map__new(struct machine *machine, u64 start, u64 len,
110 u64 pgoff, struct dso_id *id, u32 prot, u32 flags,
111 struct build_id *bid, char *filename, struct thread *thread);
112struct map *map__new2(u64 start, struct dso *dso);
113void map__delete(struct map *map);
114struct map *map__clone(struct map *map);
115
116static inline struct map *map__get(struct map *map)
117{
118 if (map)
119 refcount_inc(&map->refcnt);
120 return map;
121}
122
123void map__put(struct map *map);
124
125static inline void __map__zput(struct map **map)
126{
127 map__put(*map);
128 *map = NULL;
129}
130
131#define map__zput(map) __map__zput(&map)
132
133size_t map__fprintf(struct map *map, FILE *fp);
134size_t map__fprintf_dsoname(struct map *map, FILE *fp);
135char *map__srcline(struct map *map, u64 addr, struct symbol *sym);
136int map__fprintf_srcline(struct map *map, u64 addr, const char *prefix,
137 FILE *fp);
138
139int map__load(struct map *map);
140struct symbol *map__find_symbol(struct map *map, u64 addr);
141struct symbol *map__find_symbol_by_name(struct map *map, const char *name);
142void map__fixup_start(struct map *map);
143void map__fixup_end(struct map *map);
144
145int map__set_kallsyms_ref_reloc_sym(struct map *map, const char *symbol_name,
146 u64 addr);
147
148bool __map__is_kernel(const struct map *map);
149bool __map__is_extra_kernel_map(const struct map *map);
150bool __map__is_bpf_prog(const struct map *map);
151bool __map__is_bpf_image(const struct map *map);
152bool __map__is_ool(const struct map *map);
153
154static inline bool __map__is_kmodule(const struct map *map)
155{
156 return !__map__is_kernel(map) && !__map__is_extra_kernel_map(map) &&
157 !__map__is_bpf_prog(map) && !__map__is_ool(map) &&
158 !__map__is_bpf_image(map);
159}
160
161bool map__has_symbols(const struct map *map);
162
163#define ENTRY_TRAMPOLINE_NAME "__entry_SYSCALL_64_trampoline"
164
165static inline bool is_entry_trampoline(const char *name)
166{
167 return !strcmp(name, ENTRY_TRAMPOLINE_NAME);
168}
169
170static inline bool is_bpf_image(const char *name)
171{
172 return strncmp(name, "bpf_trampoline_", sizeof("bpf_trampoline_") - 1) == 0 ||
173 strncmp(name, "bpf_dispatcher_", sizeof("bpf_dispatcher_") - 1) == 0;
174}
175
176static inline int is_anon_memory(const char *filename)
177{
178 return !strcmp(filename, "//anon") ||
179 !strncmp(filename, "/dev/zero", sizeof("/dev/zero") - 1) ||
180 !strncmp(filename, "/anon_hugepage", sizeof("/anon_hugepage") - 1);
181}
182
183static inline int is_no_dso_memory(const char *filename)
184{
185 return !strncmp(filename, "[stack", 6) ||
186 !strncmp(filename, "/SYSV", 5) ||
187 !strcmp(filename, "[heap]");
188}
189#endif /* __PERF_MAP_H */