Commit | Line | Data |
---|---|---|
97f20251 SR |
1 | #ifndef _LINUX_FTRACE_EVENT_H |
2 | #define _LINUX_FTRACE_EVENT_H | |
3 | ||
97f20251 | 4 | #include <linux/ring_buffer.h> |
16bb8eb1 | 5 | #include <linux/trace_seq.h> |
be74b73a | 6 | #include <linux/percpu.h> |
20ab4425 | 7 | #include <linux/hardirq.h> |
430ad5a6 | 8 | #include <linux/perf_event.h> |
97f20251 SR |
9 | |
10 | struct trace_array; | |
11 | struct tracer; | |
6d723736 | 12 | struct dentry; |
97f20251 | 13 | |
be74b73a SR |
14 | struct trace_print_flags { |
15 | unsigned long mask; | |
16 | const char *name; | |
17 | }; | |
18 | ||
2fc1b6f0 | 19 | struct trace_print_flags_u64 { |
20 | unsigned long long mask; | |
21 | const char *name; | |
22 | }; | |
23 | ||
be74b73a SR |
24 | const char *ftrace_print_flags_seq(struct trace_seq *p, const char *delim, |
25 | unsigned long flags, | |
26 | const struct trace_print_flags *flag_array); | |
27 | ||
0f4fc29d SR |
28 | const char *ftrace_print_symbols_seq(struct trace_seq *p, unsigned long val, |
29 | const struct trace_print_flags *symbol_array); | |
30 | ||
2fc1b6f0 | 31 | #if BITS_PER_LONG == 32 |
32 | const char *ftrace_print_symbols_seq_u64(struct trace_seq *p, | |
33 | unsigned long long val, | |
34 | const struct trace_print_flags_u64 | |
35 | *symbol_array); | |
36 | #endif | |
37 | ||
5a2e3995 KT |
38 | const char *ftrace_print_hex_seq(struct trace_seq *p, |
39 | const unsigned char *buf, int len); | |
40 | ||
97f20251 SR |
41 | /* |
42 | * The trace entry - the most basic unit of tracing. This is what | |
43 | * is printed in the end as a single line in the trace output, such as: | |
44 | * | |
45 | * bash-15816 [01] 235.197585: idle_cpu <- irq_enter | |
46 | */ | |
47 | struct trace_entry { | |
89ec0dee | 48 | unsigned short type; |
97f20251 SR |
49 | unsigned char flags; |
50 | unsigned char preempt_count; | |
51 | int pid; | |
97f20251 SR |
52 | }; |
53 | ||
89ec0dee SR |
54 | #define FTRACE_MAX_EVENT \ |
55 | ((1 << (sizeof(((struct trace_entry *)0)->type) * 8)) - 1) | |
56 | ||
97f20251 SR |
57 | /* |
58 | * Trace iterator - used by printout routines who present trace | |
59 | * results to users and which routines might sleep, etc: | |
60 | */ | |
61 | struct trace_iterator { | |
62 | struct trace_array *tr; | |
63 | struct tracer *trace; | |
64 | void *private; | |
65 | int cpu_file; | |
66 | struct mutex mutex; | |
6d158a81 | 67 | struct ring_buffer_iter **buffer_iter; |
112f38a7 | 68 | unsigned long iter_flags; |
97f20251 | 69 | |
bc289ae9 LJ |
70 | /* trace_seq for __print_flags() and __print_symbolic() etc. */ |
71 | struct trace_seq tmp_seq; | |
72 | ||
97f20251 SR |
73 | /* The below is zeroed out in pipe_read */ |
74 | struct trace_seq seq; | |
75 | struct trace_entry *ent; | |
bc21b478 | 76 | unsigned long lost_events; |
a63ce5b3 | 77 | int leftover; |
4a9bd3f1 | 78 | int ent_size; |
97f20251 SR |
79 | int cpu; |
80 | u64 ts; | |
81 | ||
97f20251 SR |
82 | loff_t pos; |
83 | long idx; | |
84 | ||
85 | cpumask_var_t started; | |
debdd57f HT |
86 | |
87 | /* it's true when current open file is snapshot */ | |
88 | bool snapshot; | |
97f20251 SR |
89 | }; |
90 | ||
8be0709f DS |
91 | enum trace_iter_flags { |
92 | TRACE_FILE_LAT_FMT = 1, | |
93 | TRACE_FILE_ANNOTATE = 2, | |
94 | TRACE_FILE_TIME_IN_NS = 4, | |
95 | }; | |
96 | ||
97f20251 | 97 | |
a9a57763 SR |
98 | struct trace_event; |
99 | ||
97f20251 | 100 | typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter, |
a9a57763 SR |
101 | int flags, struct trace_event *event); |
102 | ||
103 | struct trace_event_functions { | |
97f20251 SR |
104 | trace_print_func trace; |
105 | trace_print_func raw; | |
106 | trace_print_func hex; | |
107 | trace_print_func binary; | |
108 | }; | |
109 | ||
a9a57763 SR |
110 | struct trace_event { |
111 | struct hlist_node node; | |
112 | struct list_head list; | |
113 | int type; | |
114 | struct trace_event_functions *funcs; | |
115 | }; | |
116 | ||
97f20251 SR |
117 | extern int register_ftrace_event(struct trace_event *event); |
118 | extern int unregister_ftrace_event(struct trace_event *event); | |
119 | ||
120 | /* Return values for print_line callback */ | |
121 | enum print_line_t { | |
122 | TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */ | |
123 | TRACE_TYPE_HANDLED = 1, | |
124 | TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */ | |
125 | TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */ | |
126 | }; | |
127 | ||
f413cdb8 FW |
128 | void tracing_generic_entry_update(struct trace_entry *entry, |
129 | unsigned long flags, | |
130 | int pc); | |
97f20251 | 131 | struct ring_buffer_event * |
e77405ad SR |
132 | trace_current_buffer_lock_reserve(struct ring_buffer **current_buffer, |
133 | int type, unsigned long len, | |
97f20251 | 134 | unsigned long flags, int pc); |
e77405ad SR |
135 | void trace_current_buffer_unlock_commit(struct ring_buffer *buffer, |
136 | struct ring_buffer_event *event, | |
97f20251 | 137 | unsigned long flags, int pc); |
0d5c6e1c SR |
138 | void trace_buffer_unlock_commit(struct ring_buffer *buffer, |
139 | struct ring_buffer_event *event, | |
140 | unsigned long flags, int pc); | |
141 | void trace_buffer_unlock_commit_regs(struct ring_buffer *buffer, | |
142 | struct ring_buffer_event *event, | |
143 | unsigned long flags, int pc, | |
144 | struct pt_regs *regs); | |
e77405ad SR |
145 | void trace_current_buffer_discard_commit(struct ring_buffer *buffer, |
146 | struct ring_buffer_event *event); | |
97f20251 SR |
147 | |
148 | void tracing_record_cmdline(struct task_struct *tsk); | |
149 | ||
1f9963cb LZ |
150 | struct event_filter; |
151 | ||
2239291a SR |
152 | enum trace_reg { |
153 | TRACE_REG_REGISTER, | |
154 | TRACE_REG_UNREGISTER, | |
37d73998 | 155 | #ifdef CONFIG_PERF_EVENTS |
2239291a SR |
156 | TRACE_REG_PERF_REGISTER, |
157 | TRACE_REG_PERF_UNREGISTER, | |
ceec0b6f JO |
158 | TRACE_REG_PERF_OPEN, |
159 | TRACE_REG_PERF_CLOSE, | |
489c75c3 JO |
160 | TRACE_REG_PERF_ADD, |
161 | TRACE_REG_PERF_DEL, | |
37d73998 | 162 | #endif |
2239291a SR |
163 | }; |
164 | ||
165 | struct ftrace_event_call; | |
166 | ||
8f082018 SR |
167 | struct ftrace_event_class { |
168 | char *system; | |
2239291a SR |
169 | void *probe; |
170 | #ifdef CONFIG_PERF_EVENTS | |
171 | void *perf_probe; | |
172 | #endif | |
173 | int (*reg)(struct ftrace_event_call *event, | |
ceec0b6f | 174 | enum trace_reg type, void *data); |
2e33af02 SR |
175 | int (*define_fields)(struct ftrace_event_call *); |
176 | struct list_head *(*get_fields)(struct ftrace_event_call *); | |
177 | struct list_head fields; | |
0405ab80 | 178 | int (*raw_init)(struct ftrace_event_call *); |
8f082018 SR |
179 | }; |
180 | ||
a1d0ce82 | 181 | extern int ftrace_event_reg(struct ftrace_event_call *event, |
ceec0b6f | 182 | enum trace_reg type, void *data); |
a1d0ce82 | 183 | |
553552ce SR |
184 | enum { |
185 | TRACE_EVENT_FL_ENABLED_BIT, | |
186 | TRACE_EVENT_FL_FILTERED_BIT, | |
e870e9a1 | 187 | TRACE_EVENT_FL_RECORDED_CMD_BIT, |
61c32659 | 188 | TRACE_EVENT_FL_CAP_ANY_BIT, |
27b14b56 | 189 | TRACE_EVENT_FL_NO_SET_FILTER_BIT, |
9b63776f | 190 | TRACE_EVENT_FL_IGNORE_ENABLE_BIT, |
553552ce SR |
191 | }; |
192 | ||
193 | enum { | |
e870e9a1 LZ |
194 | TRACE_EVENT_FL_ENABLED = (1 << TRACE_EVENT_FL_ENABLED_BIT), |
195 | TRACE_EVENT_FL_FILTERED = (1 << TRACE_EVENT_FL_FILTERED_BIT), | |
196 | TRACE_EVENT_FL_RECORDED_CMD = (1 << TRACE_EVENT_FL_RECORDED_CMD_BIT), | |
61c32659 | 197 | TRACE_EVENT_FL_CAP_ANY = (1 << TRACE_EVENT_FL_CAP_ANY_BIT), |
27b14b56 | 198 | TRACE_EVENT_FL_NO_SET_FILTER = (1 << TRACE_EVENT_FL_NO_SET_FILTER_BIT), |
9b63776f | 199 | TRACE_EVENT_FL_IGNORE_ENABLE = (1 << TRACE_EVENT_FL_IGNORE_ENABLE_BIT), |
553552ce SR |
200 | }; |
201 | ||
97f20251 | 202 | struct ftrace_event_call { |
a59fd602 | 203 | struct list_head list; |
8f082018 | 204 | struct ftrace_event_class *class; |
97f20251 | 205 | char *name; |
97f20251 | 206 | struct dentry *dir; |
80decc70 | 207 | struct trace_event event; |
509e760c | 208 | const char *print_fmt; |
1f9963cb | 209 | struct event_filter *filter; |
6d723736 | 210 | void *mod; |
69fd4f0e | 211 | void *data; |
97f20251 | 212 | |
553552ce SR |
213 | /* |
214 | * 32 bit flags: | |
215 | * bit 1: enabled | |
216 | * bit 2: filter_active | |
e870e9a1 | 217 | * bit 3: enabled cmd record |
5da43bed SR |
218 | * bit 4: allow trace by non root (cap any) |
219 | * bit 5: failed to apply filter | |
220 | * bit 6: ftrace internal event (do not enable) | |
553552ce | 221 | * |
1eaa4787 SR |
222 | * Changes to flags must hold the event_mutex. |
223 | * | |
224 | * Note: Reads of flags do not hold the event_mutex since | |
225 | * they occur in critical sections. But the way flags | |
226 | * is currently used, these changes do no affect the code | |
227 | * except that when a change is made, it may have a slight | |
228 | * delay in propagating the changes to other CPUs due to | |
229 | * caching and such. | |
553552ce SR |
230 | */ |
231 | unsigned int flags; | |
232 | ||
ff5f149b | 233 | #ifdef CONFIG_PERF_EVENTS |
6016ee13 NK |
234 | int perf_refcount; |
235 | struct hlist_head __percpu *perf_events; | |
ff5f149b | 236 | #endif |
97f20251 SR |
237 | }; |
238 | ||
53cf810b FW |
239 | #define __TRACE_EVENT_FLAGS(name, value) \ |
240 | static int __init trace_init_flags_##name(void) \ | |
241 | { \ | |
242 | event_##name.flags = value; \ | |
243 | return 0; \ | |
244 | } \ | |
245 | early_initcall(trace_init_flags_##name); | |
246 | ||
97d5a220 | 247 | #define PERF_MAX_TRACE_SIZE 2048 |
20ab4425 | 248 | |
16bb8eb1 | 249 | #define MAX_FILTER_STR_VAL 256 /* Should handle KSYM_SYMBOL_LEN */ |
97f20251 | 250 | |
2df75e41 | 251 | extern void destroy_preds(struct ftrace_event_call *call); |
6fb2915d | 252 | extern int filter_match_preds(struct event_filter *filter, void *rec); |
e77405ad SR |
253 | extern int filter_current_check_discard(struct ring_buffer *buffer, |
254 | struct ftrace_event_call *call, | |
97f20251 SR |
255 | void *rec, |
256 | struct ring_buffer_event *event); | |
257 | ||
43b51ead LZ |
258 | enum { |
259 | FILTER_OTHER = 0, | |
260 | FILTER_STATIC_STRING, | |
261 | FILTER_DYN_STRING, | |
87a342f5 | 262 | FILTER_PTR_STRING, |
02aa3162 | 263 | FILTER_TRACE_FN, |
43b51ead LZ |
264 | }; |
265 | ||
04295780 SR |
266 | #define EVENT_STORAGE_SIZE 128 |
267 | extern struct mutex event_storage_mutex; | |
268 | extern char event_storage[EVENT_STORAGE_SIZE]; | |
269 | ||
87d9b4e1 | 270 | extern int trace_event_raw_init(struct ftrace_event_call *call); |
aeaeae11 FW |
271 | extern int trace_define_field(struct ftrace_event_call *call, const char *type, |
272 | const char *name, int offset, int size, | |
273 | int is_signed, int filter_type); | |
bd1a5c84 MH |
274 | extern int trace_add_event_call(struct ftrace_event_call *call); |
275 | extern void trace_remove_event_call(struct ftrace_event_call *call); | |
97f20251 | 276 | |
418c59e4 | 277 | #define is_signed_type(type) (((type)(-1)) < (type)0) |
97f20251 | 278 | |
4671c794 SR |
279 | int trace_set_clr_event(const char *system, const char *event, int set); |
280 | ||
97f20251 SR |
281 | /* |
282 | * The double __builtin_constant_p is because gcc will give us an error | |
283 | * if we try to allocate the static variable to fmt if it is not a | |
284 | * constant. Even with the outer if statement optimizing out. | |
285 | */ | |
286 | #define event_trace_printk(ip, fmt, args...) \ | |
287 | do { \ | |
288 | __trace_printk_check_format(fmt, ##args); \ | |
289 | tracing_record_cmdline(current); \ | |
290 | if (__builtin_constant_p(fmt)) { \ | |
291 | static const char *trace_printk_fmt \ | |
292 | __attribute__((section("__trace_printk_fmt"))) = \ | |
293 | __builtin_constant_p(fmt) ? fmt : NULL; \ | |
294 | \ | |
295 | __trace_bprintk(ip, trace_printk_fmt, ##args); \ | |
296 | } else \ | |
297 | __trace_printk(ip, fmt, ##args); \ | |
298 | } while (0) | |
299 | ||
07b139c8 | 300 | #ifdef CONFIG_PERF_EVENTS |
6fb2915d | 301 | struct perf_event; |
c530665c FW |
302 | |
303 | DECLARE_PER_CPU(struct pt_regs, perf_trace_regs); | |
304 | ||
1c024eca PZ |
305 | extern int perf_trace_init(struct perf_event *event); |
306 | extern void perf_trace_destroy(struct perf_event *event); | |
a4eaf7f1 PZ |
307 | extern int perf_trace_add(struct perf_event *event, int flags); |
308 | extern void perf_trace_del(struct perf_event *event, int flags); | |
1c024eca | 309 | extern int ftrace_profile_set_filter(struct perf_event *event, int event_id, |
6fb2915d LZ |
310 | char *filter_str); |
311 | extern void ftrace_profile_free_filter(struct perf_event *event); | |
b7e2ecef PZ |
312 | extern void *perf_trace_buf_prepare(int size, unsigned short type, |
313 | struct pt_regs *regs, int *rctxp); | |
430ad5a6 XG |
314 | |
315 | static inline void | |
97d5a220 | 316 | perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr, |
e6dab5ff AV |
317 | u64 count, struct pt_regs *regs, void *head, |
318 | struct task_struct *task) | |
430ad5a6 | 319 | { |
e6dab5ff | 320 | perf_tp_event(addr, count, raw_data, size, regs, head, rctx, task); |
430ad5a6 | 321 | } |
6fb2915d LZ |
322 | #endif |
323 | ||
97f20251 | 324 | #endif /* _LINUX_FTRACE_EVENT_H */ |