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