GNU Linux-libre 4.9.330-gnu1
[releases.git] / tools / perf / util / machine.h
1 #ifndef __PERF_MACHINE_H
2 #define __PERF_MACHINE_H
3
4 #include <sys/types.h>
5 #include <linux/rbtree.h>
6 #include "map.h"
7 #include "dso.h"
8 #include "event.h"
9
10 struct addr_location;
11 struct branch_stack;
12 struct perf_evsel;
13 struct perf_sample;
14 struct symbol;
15 struct thread;
16 union perf_event;
17
18 /* Native host kernel uses -1 as pid index in machine */
19 #define HOST_KERNEL_ID                  (-1)
20 #define DEFAULT_GUEST_KERNEL_ID         (0)
21
22 extern const char *ref_reloc_sym_names[];
23
24 struct vdso_info;
25
26 struct machine {
27         struct rb_node    rb_node;
28         pid_t             pid;
29         u16               id_hdr_size;
30         bool              comm_exec;
31         bool              kptr_restrict_warned;
32         char              *root_dir;
33         struct rb_root    threads;
34         pthread_rwlock_t  threads_lock;
35         unsigned int      nr_threads;
36         struct list_head  dead_threads;
37         struct thread     *last_match;
38         struct vdso_info  *vdso_info;
39         struct perf_env   *env;
40         struct dsos       dsos;
41         struct map_groups kmaps;
42         struct map        *vmlinux_maps[MAP__NR_TYPES];
43         u64               kernel_start;
44         pid_t             *current_tid;
45         union { /* Tool specific area */
46                 void      *priv;
47                 u64       db_id;
48         };
49 };
50
51 static inline
52 struct map *__machine__kernel_map(struct machine *machine, enum map_type type)
53 {
54         return machine->vmlinux_maps[type];
55 }
56
57 static inline
58 struct map *machine__kernel_map(struct machine *machine)
59 {
60         return __machine__kernel_map(machine, MAP__FUNCTION);
61 }
62
63 int machine__get_kernel_start(struct machine *machine);
64
65 static inline u64 machine__kernel_start(struct machine *machine)
66 {
67         if (!machine->kernel_start)
68                 machine__get_kernel_start(machine);
69         return machine->kernel_start;
70 }
71
72 static inline bool machine__kernel_ip(struct machine *machine, u64 ip)
73 {
74         u64 kernel_start = machine__kernel_start(machine);
75
76         return ip >= kernel_start;
77 }
78
79 struct thread *machine__find_thread(struct machine *machine, pid_t pid,
80                                     pid_t tid);
81 struct comm *machine__thread_exec_comm(struct machine *machine,
82                                        struct thread *thread);
83
84 int machine__process_comm_event(struct machine *machine, union perf_event *event,
85                                 struct perf_sample *sample);
86 int machine__process_exit_event(struct machine *machine, union perf_event *event,
87                                 struct perf_sample *sample);
88 int machine__process_fork_event(struct machine *machine, union perf_event *event,
89                                 struct perf_sample *sample);
90 int machine__process_lost_event(struct machine *machine, union perf_event *event,
91                                 struct perf_sample *sample);
92 int machine__process_lost_samples_event(struct machine *machine, union perf_event *event,
93                                         struct perf_sample *sample);
94 int machine__process_aux_event(struct machine *machine,
95                                union perf_event *event);
96 int machine__process_itrace_start_event(struct machine *machine,
97                                         union perf_event *event);
98 int machine__process_switch_event(struct machine *machine,
99                                   union perf_event *event);
100 int machine__process_mmap_event(struct machine *machine, union perf_event *event,
101                                 struct perf_sample *sample);
102 int machine__process_mmap2_event(struct machine *machine, union perf_event *event,
103                                  struct perf_sample *sample);
104 int machine__process_event(struct machine *machine, union perf_event *event,
105                                 struct perf_sample *sample);
106
107 typedef void (*machine__process_t)(struct machine *machine, void *data);
108
109 struct machines {
110         struct machine host;
111         struct rb_root guests;
112 };
113
114 void machines__init(struct machines *machines);
115 void machines__exit(struct machines *machines);
116
117 void machines__process_guests(struct machines *machines,
118                               machine__process_t process, void *data);
119
120 struct machine *machines__add(struct machines *machines, pid_t pid,
121                               const char *root_dir);
122 struct machine *machines__find_host(struct machines *machines);
123 struct machine *machines__find(struct machines *machines, pid_t pid);
124 struct machine *machines__findnew(struct machines *machines, pid_t pid);
125
126 void machines__set_id_hdr_size(struct machines *machines, u16 id_hdr_size);
127 char *machine__mmap_name(struct machine *machine, char *bf, size_t size);
128
129 void machines__set_comm_exec(struct machines *machines, bool comm_exec);
130
131 struct machine *machine__new_host(void);
132 int machine__init(struct machine *machine, const char *root_dir, pid_t pid);
133 void machine__exit(struct machine *machine);
134 void machine__delete_threads(struct machine *machine);
135 void machine__delete(struct machine *machine);
136 void machine__remove_thread(struct machine *machine, struct thread *th);
137
138 struct branch_info *sample__resolve_bstack(struct perf_sample *sample,
139                                            struct addr_location *al);
140 struct mem_info *sample__resolve_mem(struct perf_sample *sample,
141                                      struct addr_location *al);
142
143 struct callchain_cursor;
144
145 int thread__resolve_callchain(struct thread *thread,
146                               struct callchain_cursor *cursor,
147                               struct perf_evsel *evsel,
148                               struct perf_sample *sample,
149                               struct symbol **parent,
150                               struct addr_location *root_al,
151                               int max_stack);
152
153 /*
154  * Default guest kernel is defined by parameter --guestkallsyms
155  * and --guestmodules
156  */
157 static inline bool machine__is_default_guest(struct machine *machine)
158 {
159         return machine ? machine->pid == DEFAULT_GUEST_KERNEL_ID : false;
160 }
161
162 static inline bool machine__is_host(struct machine *machine)
163 {
164         return machine ? machine->pid == HOST_KERNEL_ID : false;
165 }
166
167 struct thread *__machine__findnew_thread(struct machine *machine, pid_t pid, pid_t tid);
168 struct thread *machine__findnew_thread(struct machine *machine, pid_t pid, pid_t tid);
169
170 struct dso *machine__findnew_dso(struct machine *machine, const char *filename);
171
172 size_t machine__fprintf(struct machine *machine, FILE *fp);
173
174 static inline
175 struct symbol *machine__find_kernel_symbol(struct machine *machine,
176                                            enum map_type type, u64 addr,
177                                            struct map **mapp)
178 {
179         return map_groups__find_symbol(&machine->kmaps, type, addr, mapp);
180 }
181
182 static inline
183 struct symbol *machine__find_kernel_symbol_by_name(struct machine *machine,
184                                                    enum map_type type, const char *name,
185                                                    struct map **mapp)
186 {
187         return map_groups__find_symbol_by_name(&machine->kmaps, type, name, mapp);
188 }
189
190 static inline
191 struct symbol *machine__find_kernel_function(struct machine *machine, u64 addr,
192                                              struct map **mapp)
193 {
194         return machine__find_kernel_symbol(machine, MAP__FUNCTION, addr,
195                                            mapp);
196 }
197
198 static inline
199 struct symbol *machine__find_kernel_function_by_name(struct machine *machine,
200                                                      const char *name,
201                                                      struct map **mapp)
202 {
203         return map_groups__find_function_by_name(&machine->kmaps, name, mapp);
204 }
205
206 struct map *machine__findnew_module_map(struct machine *machine, u64 start,
207                                         const char *filename);
208 int arch__fix_module_text_start(u64 *start, u64 *size, const char *name);
209
210 int __machine__load_kallsyms(struct machine *machine, const char *filename,
211                              enum map_type type, bool no_kcore);
212 int machine__load_kallsyms(struct machine *machine, const char *filename,
213                            enum map_type type);
214 int machine__load_vmlinux_path(struct machine *machine, enum map_type type);
215
216 size_t machine__fprintf_dsos_buildid(struct machine *machine, FILE *fp,
217                                      bool (skip)(struct dso *dso, int parm), int parm);
218 size_t machines__fprintf_dsos(struct machines *machines, FILE *fp);
219 size_t machines__fprintf_dsos_buildid(struct machines *machines, FILE *fp,
220                                      bool (skip)(struct dso *dso, int parm), int parm);
221
222 void machine__destroy_kernel_maps(struct machine *machine);
223 int __machine__create_kernel_maps(struct machine *machine, struct dso *kernel);
224 int machine__create_kernel_maps(struct machine *machine);
225
226 int machines__create_kernel_maps(struct machines *machines, pid_t pid);
227 int machines__create_guest_kernel_maps(struct machines *machines);
228 void machines__destroy_kernel_maps(struct machines *machines);
229
230 size_t machine__fprintf_vmlinux_path(struct machine *machine, FILE *fp);
231
232 int machine__for_each_thread(struct machine *machine,
233                              int (*fn)(struct thread *thread, void *p),
234                              void *priv);
235 int machines__for_each_thread(struct machines *machines,
236                               int (*fn)(struct thread *thread, void *p),
237                               void *priv);
238
239 int __machine__synthesize_threads(struct machine *machine, struct perf_tool *tool,
240                                   struct target *target, struct thread_map *threads,
241                                   perf_event__handler_t process, bool data_mmap,
242                                   unsigned int proc_map_timeout);
243 static inline
244 int machine__synthesize_threads(struct machine *machine, struct target *target,
245                                 struct thread_map *threads, bool data_mmap,
246                                 unsigned int proc_map_timeout)
247 {
248         return __machine__synthesize_threads(machine, NULL, target, threads,
249                                              perf_event__process, data_mmap,
250                                              proc_map_timeout);
251 }
252
253 pid_t machine__get_current_tid(struct machine *machine, int cpu);
254 int machine__set_current_tid(struct machine *machine, int cpu, pid_t pid,
255                              pid_t tid);
256 /*
257  * For use with libtraceevent's pevent_set_function_resolver()
258  */
259 char *machine__resolve_kernel_addr(void *vmachine, unsigned long long *addrp, char **modp);
260
261 #endif /* __PERF_MACHINE_H */