1 // SPDX-License-Identifier: GPL-2.0-only
3 * db-export.c: Support for exporting data suitable for import to a database
4 * Copyright (c) 2014, Intel Corporation.
18 #include "thread-stack.h"
19 #include "callchain.h"
20 #include "call-path.h"
21 #include "db-export.h"
22 #include <linux/zalloc.h>
24 int db_export__init(struct db_export *dbe)
26 memset(dbe, 0, sizeof(struct db_export));
30 void db_export__exit(struct db_export *dbe)
32 call_return_processor__free(dbe->crp);
36 int db_export__evsel(struct db_export *dbe, struct evsel *evsel)
41 evsel->db_id = ++dbe->evsel_last_db_id;
43 if (dbe->export_evsel)
44 return dbe->export_evsel(dbe, evsel);
49 int db_export__machine(struct db_export *dbe, struct machine *machine)
54 machine->db_id = ++dbe->machine_last_db_id;
56 if (dbe->export_machine)
57 return dbe->export_machine(dbe, machine);
62 int db_export__thread(struct db_export *dbe, struct thread *thread,
63 struct machine *machine, struct thread *main_thread)
65 u64 main_thread_db_id = 0;
70 thread->db_id = ++dbe->thread_last_db_id;
73 main_thread_db_id = main_thread->db_id;
75 if (dbe->export_thread)
76 return dbe->export_thread(dbe, thread, main_thread_db_id,
82 static int __db_export__comm(struct db_export *dbe, struct comm *comm,
83 struct thread *thread)
85 comm->db_id = ++dbe->comm_last_db_id;
88 return dbe->export_comm(dbe, comm, thread);
93 int db_export__comm(struct db_export *dbe, struct comm *comm,
94 struct thread *thread)
99 return __db_export__comm(dbe, comm, thread);
103 * Export the "exec" comm. The "exec" comm is the program / application command
104 * name at the time it first executes. It is used to group threads for the same
105 * program. Note that the main thread pid (or thread group id tgid) cannot be
106 * used because it does not change when a new program is exec'ed.
108 int db_export__exec_comm(struct db_export *dbe, struct comm *comm,
109 struct thread *main_thread)
116 err = __db_export__comm(dbe, comm, main_thread);
121 * Record the main thread for this comm. Note that the main thread can
122 * have many "exec" comms because there will be a new one every time it
123 * exec's. An "exec" comm however will only ever have 1 main thread.
124 * That is different to any other threads for that same program because
125 * exec() will effectively kill them, so the relationship between the
126 * "exec" comm and non-main threads is 1-to-1. That is why
127 * db_export__comm_thread() is called here for the main thread, but it
128 * is called for non-main threads when they are exported.
130 return db_export__comm_thread(dbe, comm, main_thread);
133 int db_export__comm_thread(struct db_export *dbe, struct comm *comm,
134 struct thread *thread)
138 db_id = ++dbe->comm_thread_last_db_id;
140 if (dbe->export_comm_thread)
141 return dbe->export_comm_thread(dbe, db_id, comm, thread);
146 int db_export__dso(struct db_export *dbe, struct dso *dso,
147 struct machine *machine)
152 dso->db_id = ++dbe->dso_last_db_id;
155 return dbe->export_dso(dbe, dso, machine);
160 int db_export__symbol(struct db_export *dbe, struct symbol *sym,
163 u64 *sym_db_id = symbol__priv(sym);
168 *sym_db_id = ++dbe->symbol_last_db_id;
170 if (dbe->export_symbol)
171 return dbe->export_symbol(dbe, sym, dso);
176 static int db_ids_from_al(struct db_export *dbe, struct addr_location *al,
177 u64 *dso_db_id, u64 *sym_db_id, u64 *offset)
182 struct dso *dso = al->map->dso;
184 err = db_export__dso(dbe, dso, al->maps->machine);
187 *dso_db_id = dso->db_id;
190 al->sym = symbol__new(al->addr, 0, 0, 0, "unknown");
192 dso__insert_symbol(dso, al->sym);
196 u64 *db_id = symbol__priv(al->sym);
198 err = db_export__symbol(dbe, al->sym, dso);
202 *offset = al->addr - al->sym->start;
209 static struct call_path *call_path_from_sample(struct db_export *dbe,
210 struct machine *machine,
211 struct thread *thread,
212 struct perf_sample *sample,
215 u64 kernel_start = machine__kernel_start(machine);
216 struct call_path *current = &dbe->cpr->call_path;
217 enum chain_order saved_order = callchain_param.order;
220 if (!symbol_conf.use_callchain || !sample->callchain)
224 * Since the call path tree must be built starting with the root, we
225 * must use ORDER_CALL for call chain resolution, in order to process
226 * the callchain starting with the root node and ending with the leaf.
228 callchain_param.order = ORDER_CALLER;
229 err = thread__resolve_callchain(thread, &callchain_cursor, evsel,
230 sample, NULL, NULL, PERF_MAX_STACK_DEPTH);
232 callchain_param.order = saved_order;
235 callchain_cursor_commit(&callchain_cursor);
238 struct callchain_cursor_node *node;
239 struct addr_location al;
240 u64 dso_db_id = 0, sym_db_id = 0, offset = 0;
242 memset(&al, 0, sizeof(al));
244 node = callchain_cursor_current(&callchain_cursor);
248 * Handle export of symbol and dso for this node by
249 * constructing an addr_location struct and then passing it to
250 * db_ids_from_al() to perform the export.
252 al.sym = node->ms.sym;
253 al.map = node->ms.map;
254 al.maps = thread->maps;
257 if (al.map && !al.sym)
258 al.sym = dso__find_symbol(al.map->dso, al.addr);
260 db_ids_from_al(dbe, &al, &dso_db_id, &sym_db_id, &offset);
262 /* add node to the call path tree if it doesn't exist */
263 current = call_path__findnew(dbe->cpr, current,
267 callchain_cursor_advance(&callchain_cursor);
270 /* Reset the callchain order to its prior value. */
271 callchain_param.order = saved_order;
273 if (current == &dbe->cpr->call_path) {
274 /* Bail because the callchain was empty. */
281 int db_export__branch_type(struct db_export *dbe, u32 branch_type,
284 if (dbe->export_branch_type)
285 return dbe->export_branch_type(dbe, branch_type, name);
290 static int db_export__threads(struct db_export *dbe, struct thread *thread,
291 struct thread *main_thread,
292 struct machine *machine, struct comm **comm_ptr)
294 struct comm *comm = NULL;
295 struct comm *curr_comm;
300 * A thread has a reference to the main thread, so export the
303 err = db_export__thread(dbe, main_thread, machine, main_thread);
307 * Export comm before exporting the non-main thread because
308 * db_export__comm_thread() can be called further below.
310 comm = machine__thread_exec_comm(machine, main_thread);
312 err = db_export__exec_comm(dbe, comm, main_thread);
319 if (thread != main_thread) {
321 * For a non-main thread, db_export__comm_thread() must be
322 * called only if thread has not previously been exported.
324 bool export_comm_thread = comm && !thread->db_id;
326 err = db_export__thread(dbe, thread, machine, main_thread);
330 if (export_comm_thread) {
331 err = db_export__comm_thread(dbe, comm, thread);
337 curr_comm = thread__comm(thread);
339 return db_export__comm(dbe, curr_comm, thread);
344 int db_export__sample(struct db_export *dbe, union perf_event *event,
345 struct perf_sample *sample, struct evsel *evsel,
346 struct addr_location *al, struct addr_location *addr_al)
348 struct thread *thread = al->thread;
349 struct export_sample es = {
355 struct thread *main_thread;
356 struct comm *comm = NULL;
359 err = db_export__evsel(dbe, evsel);
363 err = db_export__machine(dbe, al->maps->machine);
367 main_thread = thread__main_thread(al->maps->machine, thread);
369 err = db_export__threads(dbe, thread, main_thread, al->maps->machine, &comm);
374 es.comm_db_id = comm->db_id;
376 es.db_id = ++dbe->sample_last_db_id;
378 err = db_ids_from_al(dbe, al, &es.dso_db_id, &es.sym_db_id, &es.offset);
383 struct call_path *cp = call_path_from_sample(dbe, al->maps->machine,
387 db_export__call_path(dbe, cp);
388 es.call_path_id = cp->db_id;
393 err = db_ids_from_al(dbe, addr_al, &es.addr_dso_db_id,
394 &es.addr_sym_db_id, &es.addr_offset);
398 err = thread_stack__process(thread, comm, sample, al,
406 if (dbe->export_sample)
407 err = dbe->export_sample(dbe, &es);
410 thread__put(main_thread);
419 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
420 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
421 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "conditional jump"},
422 {PERF_IP_FLAG_BRANCH, "unconditional jump"},
423 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT,
424 "software interrupt"},
425 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT,
426 "return from interrupt"},
427 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET,
429 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET,
430 "return from system call"},
431 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "asynchronous branch"},
432 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC |
433 PERF_IP_FLAG_INTERRUPT, "hardware interrupt"},
434 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "transaction abort"},
435 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "trace begin"},
436 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "trace end"},
437 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_VMENTRY, "vm entry"},
438 {PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_VMEXIT, "vm exit"},
442 int db_export__branch_types(struct db_export *dbe)
446 for (i = 0; branch_types[i].name ; i++) {
447 err = db_export__branch_type(dbe, branch_types[i].branch_type,
448 branch_types[i].name);
453 /* Add trace begin / end variants */
454 for (i = 0; branch_types[i].name ; i++) {
455 const char *name = branch_types[i].name;
456 u32 type = branch_types[i].branch_type;
459 if (type == PERF_IP_FLAG_BRANCH ||
460 (type & (PERF_IP_FLAG_TRACE_BEGIN | PERF_IP_FLAG_TRACE_END)))
463 snprintf(buf, sizeof(buf), "trace begin / %s", name);
464 err = db_export__branch_type(dbe, type | PERF_IP_FLAG_TRACE_BEGIN, buf);
468 snprintf(buf, sizeof(buf), "%s / trace end", name);
469 err = db_export__branch_type(dbe, type | PERF_IP_FLAG_TRACE_END, buf);
477 int db_export__call_path(struct db_export *dbe, struct call_path *cp)
485 err = db_export__call_path(dbe, cp->parent);
490 cp->db_id = ++dbe->call_path_last_db_id;
492 if (dbe->export_call_path)
493 return dbe->export_call_path(dbe, cp);
498 int db_export__call_return(struct db_export *dbe, struct call_return *cr,
503 err = db_export__call_path(dbe, cr->cp);
508 cr->db_id = ++dbe->call_return_last_db_id;
512 *parent_db_id = ++dbe->call_return_last_db_id;
513 cr->parent_db_id = *parent_db_id;
516 if (dbe->export_call_return)
517 return dbe->export_call_return(dbe, cr);
522 static int db_export__pid_tid(struct db_export *dbe, struct machine *machine,
523 pid_t pid, pid_t tid, u64 *db_id,
524 struct comm **comm_ptr, bool *is_idle)
526 struct thread *thread = machine__find_thread(machine, pid, tid);
527 struct thread *main_thread;
530 if (!thread || !thread->comm_set)
533 *is_idle = !thread->pid_ && !thread->tid;
535 main_thread = thread__main_thread(machine, thread);
537 err = db_export__threads(dbe, thread, main_thread, machine, comm_ptr);
539 *db_id = thread->db_id;
541 thread__put(main_thread);
548 int db_export__switch(struct db_export *dbe, union perf_event *event,
549 struct perf_sample *sample, struct machine *machine)
551 bool out = event->header.misc & PERF_RECORD_MISC_SWITCH_OUT;
552 bool out_preempt = out &&
553 (event->header.misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT);
554 int flags = out | (out_preempt << 1);
555 bool is_idle_a = false, is_idle_b = false;
556 u64 th_a_id = 0, th_b_id = 0;
557 u64 comm_out_id, comm_in_id;
558 struct comm *comm_a = NULL;
559 struct comm *comm_b = NULL;
560 u64 th_out_id, th_in_id;
564 err = db_export__machine(dbe, machine);
568 err = db_export__pid_tid(dbe, machine, sample->pid, sample->tid,
569 &th_a_id, &comm_a, &is_idle_a);
573 if (event->header.type == PERF_RECORD_SWITCH_CPU_WIDE) {
574 pid_t pid = event->context_switch.next_prev_pid;
575 pid_t tid = event->context_switch.next_prev_tid;
577 err = db_export__pid_tid(dbe, machine, pid, tid, &th_b_id,
578 &comm_b, &is_idle_b);
584 * Do not export if both threads are unknown (i.e. not being traced),
585 * or one is unknown and the other is the idle task.
587 if ((!th_a_id || is_idle_a) && (!th_b_id || is_idle_b))
590 db_id = ++dbe->context_switch_last_db_id;
595 comm_out_id = comm_a ? comm_a->db_id : 0;
596 comm_in_id = comm_b ? comm_b->db_id : 0;
600 comm_out_id = comm_b ? comm_b->db_id : 0;
601 comm_in_id = comm_a ? comm_a->db_id : 0;
604 if (dbe->export_context_switch)
605 return dbe->export_context_switch(dbe, db_id, machine, sample,
606 th_out_id, comm_out_id,
607 th_in_id, comm_in_id, flags);