1 /* 2 * thread-stack.h: Synthesize a thread's stack using call / return events 3 * Copyright (c) 2014, Intel Corporation. 4 * 5 * This program is free software; you can redistribute it and/or modify it 6 * under the terms and conditions of the GNU General Public License, 7 * version 2, as published by the Free Software Foundation. 8 * 9 * This program is distributed in the hope it will be useful, but WITHOUT 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 12 * more details. 13 * 14 */ 15 16 #ifndef __PERF_THREAD_STACK_H 17 #define __PERF_THREAD_STACK_H 18 19 #include <sys/types.h> 20 21 #include <linux/types.h> 22 23 struct thread; 24 struct comm; 25 struct ip_callchain; 26 struct symbol; 27 struct dso; 28 struct comm; 29 struct perf_sample; 30 struct addr_location; 31 struct call_path; 32 33 /* 34 * Call/Return flags. 35 * 36 * CALL_RETURN_NO_CALL: 'return' but no matching 'call' 37 * CALL_RETURN_NO_RETURN: 'call' but no matching 'return' 38 * CALL_RETURN_NON_CALL: a branch but not a 'call' to the start of a different 39 * symbol 40 */ 41 enum { 42 CALL_RETURN_NO_CALL = 1 << 0, 43 CALL_RETURN_NO_RETURN = 1 << 1, 44 CALL_RETURN_NON_CALL = 1 << 2, 45 }; 46 47 /** 48 * struct call_return - paired call/return information. 49 * @thread: thread in which call/return occurred 50 * @comm: comm in which call/return occurred 51 * @cp: call path 52 * @call_time: timestamp of call (if known) 53 * @return_time: timestamp of return (if known) 54 * @branch_count: number of branches seen between call and return 55 * @call_ref: external reference to 'call' sample (e.g. db_id) 56 * @return_ref: external reference to 'return' sample (e.g. db_id) 57 * @db_id: id used for db-export 58 * @flags: Call/Return flags 59 */ 60 struct call_return { 61 struct thread *thread; 62 struct comm *comm; 63 struct call_path *cp; 64 u64 call_time; 65 u64 return_time; 66 u64 branch_count; 67 u64 call_ref; 68 u64 return_ref; 69 u64 db_id; 70 u32 flags; 71 }; 72 73 /** 74 * struct call_return_processor - provides a call-back to consume call-return 75 * information. 76 * @cpr: call path root 77 * @process: call-back that accepts call/return information 78 * @data: anonymous data for call-back 79 */ 80 struct call_return_processor { 81 struct call_path_root *cpr; 82 int (*process)(struct call_return *cr, void *data); 83 void *data; 84 }; 85 86 int thread_stack__event(struct thread *thread, int cpu, u32 flags, u64 from_ip, 87 u64 to_ip, u16 insn_len, u64 trace_nr); 88 void thread_stack__set_trace_nr(struct thread *thread, int cpu, u64 trace_nr); 89 void thread_stack__sample(struct thread *thread, int cpu, struct ip_callchain *chain, 90 size_t sz, u64 ip, u64 kernel_start); 91 int thread_stack__flush(struct thread *thread); 92 void thread_stack__free(struct thread *thread); 93 size_t thread_stack__depth(struct thread *thread, int cpu); 94 95 struct call_return_processor * 96 call_return_processor__new(int (*process)(struct call_return *cr, void *data), 97 void *data); 98 void call_return_processor__free(struct call_return_processor *crp); 99 int thread_stack__process(struct thread *thread, struct comm *comm, 100 struct perf_sample *sample, 101 struct addr_location *from_al, 102 struct addr_location *to_al, u64 ref, 103 struct call_return_processor *crp); 104 105 #endif 106