xref: /linux/tools/perf/util/maps.h (revision e91c37f1)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_MAPS_H
3 #define __PERF_MAPS_H
4 
5 #include <linux/refcount.h>
6 #include <linux/rbtree.h>
7 #include <stdio.h>
8 #include <stdbool.h>
9 #include <linux/types.h>
10 #include "rwsem.h"
11 #include <internal/rc_check.h>
12 
13 struct ref_reloc_sym;
14 struct machine;
15 struct map;
16 struct maps;
17 
18 struct map_list_node {
19 	struct list_head node;
20 	struct map *map;
21 };
22 
23 static inline struct map_list_node *map_list_node__new(void)
24 {
25 	return malloc(sizeof(struct map_list_node));
26 }
27 
28 struct map *maps__find(struct maps *maps, u64 addr);
29 
30 DECLARE_RC_STRUCT(maps) {
31 	struct rb_root      entries;
32 	struct rw_semaphore lock;
33 	struct machine	 *machine;
34 	struct map	 *last_search_by_name;
35 	struct map	 **maps_by_name;
36 	refcount_t	 refcnt;
37 	unsigned int	 nr_maps;
38 	unsigned int	 nr_maps_allocated;
39 #ifdef HAVE_LIBUNWIND_SUPPORT
40 	void				*addr_space;
41 	const struct unwind_libunwind_ops *unwind_libunwind_ops;
42 #endif
43 };
44 
45 #define KMAP_NAME_LEN 256
46 
47 struct kmap {
48 	struct ref_reloc_sym *ref_reloc_sym;
49 	struct maps	     *kmaps;
50 	char		     name[KMAP_NAME_LEN];
51 };
52 
53 struct maps *maps__new(struct machine *machine);
54 bool maps__empty(struct maps *maps);
55 int maps__copy_from(struct maps *maps, struct maps *parent);
56 
57 struct maps *maps__get(struct maps *maps);
58 void maps__put(struct maps *maps);
59 
60 static inline void __maps__zput(struct maps **map)
61 {
62 	maps__put(*map);
63 	*map = NULL;
64 }
65 
66 #define maps__zput(map) __maps__zput(&map)
67 
68 /* Iterate over map calling cb for each entry. */
69 int maps__for_each_map(struct maps *maps, int (*cb)(struct map *map, void *data), void *data);
70 /* Iterate over map removing an entry if cb returns true. */
71 void maps__remove_maps(struct maps *maps, bool (*cb)(struct map *map, void *data), void *data);
72 
73 static inline struct machine *maps__machine(struct maps *maps)
74 {
75 	return RC_CHK_ACCESS(maps)->machine;
76 }
77 
78 static inline unsigned int maps__nr_maps(const struct maps *maps)
79 {
80 	return RC_CHK_ACCESS(maps)->nr_maps;
81 }
82 
83 static inline refcount_t *maps__refcnt(struct maps *maps)
84 {
85 	return &RC_CHK_ACCESS(maps)->refcnt;
86 }
87 
88 #ifdef HAVE_LIBUNWIND_SUPPORT
89 static inline void *maps__addr_space(struct maps *maps)
90 {
91 	return RC_CHK_ACCESS(maps)->addr_space;
92 }
93 
94 static inline const struct unwind_libunwind_ops *maps__unwind_libunwind_ops(const struct maps *maps)
95 {
96 	return RC_CHK_ACCESS(maps)->unwind_libunwind_ops;
97 }
98 #endif
99 
100 size_t maps__fprintf(struct maps *maps, FILE *fp);
101 
102 int maps__insert(struct maps *maps, struct map *map);
103 void maps__remove(struct maps *maps, struct map *map);
104 
105 struct symbol *maps__find_symbol(struct maps *maps, u64 addr, struct map **mapp);
106 struct symbol *maps__find_symbol_by_name(struct maps *maps, const char *name, struct map **mapp);
107 
108 struct addr_map_symbol;
109 
110 int maps__find_ams(struct maps *maps, struct addr_map_symbol *ams);
111 
112 int maps__fixup_overlap_and_insert(struct maps *maps, struct map *new);
113 
114 struct map *maps__find_by_name(struct maps *maps, const char *name);
115 
116 struct map *maps__find_next_entry(struct maps *maps, struct map *map);
117 
118 int maps__merge_in(struct maps *kmaps, struct map *new_map);
119 
120 void __maps__sort_by_name(struct maps *maps);
121 
122 void maps__fixup_end(struct maps *maps);
123 
124 void maps__load_first(struct maps *maps);
125 
126 #endif // __PERF_MAPS_H
127