Merge branch 'work.iov_iter' of git://git.kernel.org/pub/scm/linux/kernel/git/viro/vfs
[linux-2.6-block.git] / include / linux / trace_events.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
bac5fb97 2
645df987
SRRH
3#ifndef _LINUX_TRACE_EVENT_H
4#define _LINUX_TRACE_EVENT_H
97f20251 5
97f20251 6#include <linux/ring_buffer.h>
16bb8eb1 7#include <linux/trace_seq.h>
be74b73a 8#include <linux/percpu.h>
20ab4425 9#include <linux/hardirq.h>
430ad5a6 10#include <linux/perf_event.h>
de7b2973 11#include <linux/tracepoint.h>
97f20251
SR
12
13struct trace_array;
1c5eb448 14struct array_buffer;
97f20251 15struct tracer;
6d723736 16struct dentry;
2541517c 17struct bpf_prog;
97f20251 18
645df987
SRRH
19const char *trace_print_flags_seq(struct trace_seq *p, const char *delim,
20 unsigned long flags,
21 const struct trace_print_flags *flag_array);
be74b73a 22
645df987
SRRH
23const char *trace_print_symbols_seq(struct trace_seq *p, unsigned long val,
24 const struct trace_print_flags *symbol_array);
0f4fc29d 25
2fc1b6f0 26#if BITS_PER_LONG == 32
d3213e8f
RZ
27const char *trace_print_flags_seq_u64(struct trace_seq *p, const char *delim,
28 unsigned long long flags,
29 const struct trace_print_flags_u64 *flag_array);
30
645df987
SRRH
31const char *trace_print_symbols_seq_u64(struct trace_seq *p,
32 unsigned long long val,
33 const struct trace_print_flags_u64
2fc1b6f0 34 *symbol_array);
35#endif
36
645df987
SRRH
37const char *trace_print_bitmask_seq(struct trace_seq *p, void *bitmask_ptr,
38 unsigned int bitmask_size);
4449bf92 39
645df987 40const char *trace_print_hex_seq(struct trace_seq *p,
2acae0d5 41 const unsigned char *buf, int len,
3898fac1 42 bool concatenate);
5a2e3995 43
645df987 44const char *trace_print_array_seq(struct trace_seq *p,
ac01ce14 45 const void *buf, int count,
6ea22486
DM
46 size_t el_size);
47
ef56e047
PM
48const char *
49trace_print_hex_dump_seq(struct trace_seq *p, const char *prefix_str,
50 int prefix_type, int rowsize, int groupsize,
51 const void *buf, size_t len, bool ascii);
52
f71130de
LZ
53struct trace_iterator;
54struct trace_event;
55
892c505a
SRRH
56int trace_raw_output_prep(struct trace_iterator *iter,
57 struct trace_event *event);
efbbdaa2
MH
58extern __printf(2, 3)
59void trace_event_printf(struct trace_iterator *iter, const char *fmt, ...);
f71130de 60
97f20251
SR
61/*
62 * The trace entry - the most basic unit of tracing. This is what
63 * is printed in the end as a single line in the trace output, such as:
64 *
65 * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
66 */
67struct trace_entry {
89ec0dee 68 unsigned short type;
97f20251
SR
69 unsigned char flags;
70 unsigned char preempt_count;
71 int pid;
97f20251
SR
72};
73
609a7404 74#define TRACE_EVENT_TYPE_MAX \
89ec0dee
SR
75 ((1 << (sizeof(((struct trace_entry *)0)->type) * 8)) - 1)
76
97f20251
SR
77/*
78 * Trace iterator - used by printout routines who present trace
79 * results to users and which routines might sleep, etc:
80 */
81struct trace_iterator {
82 struct trace_array *tr;
83 struct tracer *trace;
1c5eb448 84 struct array_buffer *array_buffer;
97f20251
SR
85 void *private;
86 int cpu_file;
87 struct mutex mutex;
6d158a81 88 struct ring_buffer_iter **buffer_iter;
112f38a7 89 unsigned long iter_flags;
ff895103
SRV
90 void *temp; /* temp holder */
91 unsigned int temp_size;
efbbdaa2
MH
92 char *fmt; /* modified format holder */
93 unsigned int fmt_size;
97f20251 94
bc289ae9
LJ
95 /* trace_seq for __print_flags() and __print_symbolic() etc. */
96 struct trace_seq tmp_seq;
97
ed5467da
AV
98 cpumask_var_t started;
99
100 /* it's true when current open file is snapshot */
101 bool snapshot;
102
97f20251
SR
103 /* The below is zeroed out in pipe_read */
104 struct trace_seq seq;
105 struct trace_entry *ent;
bc21b478 106 unsigned long lost_events;
a63ce5b3 107 int leftover;
4a9bd3f1 108 int ent_size;
97f20251
SR
109 int cpu;
110 u64 ts;
111
97f20251
SR
112 loff_t pos;
113 long idx;
114
ed5467da 115 /* All new field here will be zeroed out in pipe_read */
97f20251
SR
116};
117
8be0709f
DS
118enum trace_iter_flags {
119 TRACE_FILE_LAT_FMT = 1,
120 TRACE_FILE_ANNOTATE = 2,
121 TRACE_FILE_TIME_IN_NS = 4,
122};
123
97f20251
SR
124
125typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter,
a9a57763
SR
126 int flags, struct trace_event *event);
127
128struct trace_event_functions {
97f20251
SR
129 trace_print_func trace;
130 trace_print_func raw;
131 trace_print_func hex;
132 trace_print_func binary;
133};
134
a9a57763
SR
135struct trace_event {
136 struct hlist_node node;
137 struct list_head list;
138 int type;
139 struct trace_event_functions *funcs;
140};
141
9023c930
SRRH
142extern int register_trace_event(struct trace_event *event);
143extern int unregister_trace_event(struct trace_event *event);
97f20251
SR
144
145/* Return values for print_line callback */
146enum print_line_t {
147 TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
148 TRACE_TYPE_HANDLED = 1,
149 TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */
150 TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */
151};
152
af0009fc 153enum print_line_t trace_handle_return(struct trace_seq *s);
19a7fe20 154
36590c50
SAS
155static inline void tracing_generic_entry_update(struct trace_entry *entry,
156 unsigned short type,
157 unsigned int trace_ctx)
158{
36590c50 159 entry->preempt_count = trace_ctx & 0xff;
58177084 160 entry->pid = current->pid;
36590c50
SAS
161 entry->type = type;
162 entry->flags = trace_ctx >> 16;
163}
164
0c02006e
SAS
165unsigned int tracing_gen_ctx_irq_test(unsigned int irqs_status);
166
167enum trace_flag_type {
168 TRACE_FLAG_IRQS_OFF = 0x01,
169 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
170 TRACE_FLAG_NEED_RESCHED = 0x04,
171 TRACE_FLAG_HARDIRQ = 0x08,
172 TRACE_FLAG_SOFTIRQ = 0x10,
173 TRACE_FLAG_PREEMPT_RESCHED = 0x20,
174 TRACE_FLAG_NMI = 0x40,
175};
176
177#ifdef CONFIG_TRACE_IRQFLAGS_SUPPORT
178static inline unsigned int tracing_gen_ctx_flags(unsigned long irqflags)
179{
180 unsigned int irq_status = irqs_disabled_flags(irqflags) ?
181 TRACE_FLAG_IRQS_OFF : 0;
182 return tracing_gen_ctx_irq_test(irq_status);
183}
184static inline unsigned int tracing_gen_ctx(void)
185{
186 unsigned long irqflags;
187
188 local_save_flags(irqflags);
189 return tracing_gen_ctx_flags(irqflags);
190}
191#else
192
193static inline unsigned int tracing_gen_ctx_flags(unsigned long irqflags)
194{
195 return tracing_gen_ctx_irq_test(TRACE_FLAG_IRQS_NOSUPPORT);
196}
197static inline unsigned int tracing_gen_ctx(void)
198{
199 return tracing_gen_ctx_irq_test(TRACE_FLAG_IRQS_NOSUPPORT);
200}
201#endif
202
203static inline unsigned int tracing_gen_ctx_dec(void)
204{
205 unsigned int trace_ctx;
206
207 trace_ctx = tracing_gen_ctx();
208 /*
f2cc020d 209 * Subtract one from the preemption counter if preemption is enabled,
0c02006e
SAS
210 * see trace_event_buffer_reserve()for details.
211 */
212 if (IS_ENABLED(CONFIG_PREEMPTION))
213 trace_ctx--;
214 return trace_ctx;
215}
36590c50 216
7f1d2f82 217struct trace_event_file;
ccb469a1
SR
218
219struct ring_buffer_event *
13292494 220trace_event_buffer_lock_reserve(struct trace_buffer **current_buffer,
7f1d2f82 221 struct trace_event_file *trace_file,
ccb469a1 222 int type, unsigned long len,
36590c50 223 unsigned int trace_ctx);
97f20251 224
d914ba37
JF
225#define TRACE_RECORD_CMDLINE BIT(0)
226#define TRACE_RECORD_TGID BIT(1)
227
228void tracing_record_taskinfo(struct task_struct *task, int flags);
229void tracing_record_taskinfo_sched_switch(struct task_struct *prev,
230 struct task_struct *next, int flags);
231
232void tracing_record_cmdline(struct task_struct *task);
233void tracing_record_tgid(struct task_struct *task);
97f20251 234
892c505a 235int trace_output_call(struct trace_iterator *iter, char *name, char *fmt, ...);
1d6bae96 236
1f9963cb
LZ
237struct event_filter;
238
2239291a
SR
239enum trace_reg {
240 TRACE_REG_REGISTER,
241 TRACE_REG_UNREGISTER,
37d73998 242#ifdef CONFIG_PERF_EVENTS
2239291a
SR
243 TRACE_REG_PERF_REGISTER,
244 TRACE_REG_PERF_UNREGISTER,
ceec0b6f
JO
245 TRACE_REG_PERF_OPEN,
246 TRACE_REG_PERF_CLOSE,
466c81c4
PZ
247 /*
248 * These (ADD/DEL) use a 'boolean' return value, where 1 (true) means a
249 * custom action was taken and the default action is not to be
250 * performed.
251 */
489c75c3
JO
252 TRACE_REG_PERF_ADD,
253 TRACE_REG_PERF_DEL,
37d73998 254#endif
2239291a
SR
255};
256
2425bcb9 257struct trace_event_call;
2239291a 258
04ae87a5
PZ
259#define TRACE_FUNCTION_TYPE ((const char *)~0UL)
260
261struct trace_event_fields {
262 const char *type;
263 union {
264 struct {
265 const char *name;
266 const int size;
267 const int align;
268 const int is_signed;
269 const int filter_type;
270 };
271 int (*define_fields)(struct trace_event_call *);
272 };
273};
274
2425bcb9 275struct trace_event_class {
acd388fd 276 const char *system;
2239291a
SR
277 void *probe;
278#ifdef CONFIG_PERF_EVENTS
279 void *perf_probe;
280#endif
2425bcb9 281 int (*reg)(struct trace_event_call *event,
ceec0b6f 282 enum trace_reg type, void *data);
04ae87a5 283 struct trace_event_fields *fields_array;
2425bcb9 284 struct list_head *(*get_fields)(struct trace_event_call *);
2e33af02 285 struct list_head fields;
2425bcb9 286 int (*raw_init)(struct trace_event_call *);
8f082018
SR
287};
288
2425bcb9 289extern int trace_event_reg(struct trace_event_call *event,
ceec0b6f 290 enum trace_reg type, void *data);
a1d0ce82 291
3f795dcf 292struct trace_event_buffer {
13292494 293 struct trace_buffer *buffer;
3fd40d1e 294 struct ring_buffer_event *event;
7f1d2f82 295 struct trace_event_file *trace_file;
3fd40d1e 296 void *entry;
36590c50 297 unsigned int trace_ctx;
8cfcf155 298 struct pt_regs *regs;
3fd40d1e
SR
299};
300
3f795dcf 301void *trace_event_buffer_reserve(struct trace_event_buffer *fbuffer,
7f1d2f82 302 struct trace_event_file *trace_file,
3fd40d1e
SR
303 unsigned long len);
304
3f795dcf 305void trace_event_buffer_commit(struct trace_event_buffer *fbuffer);
3fd40d1e 306
553552ce 307enum {
553552ce 308 TRACE_EVENT_FL_FILTERED_BIT,
61c32659 309 TRACE_EVENT_FL_CAP_ANY_BIT,
27b14b56 310 TRACE_EVENT_FL_NO_SET_FILTER_BIT,
9b63776f 311 TRACE_EVENT_FL_IGNORE_ENABLE_BIT,
de7b2973 312 TRACE_EVENT_FL_TRACEPOINT_BIT,
8b0e6c74 313 TRACE_EVENT_FL_DYNAMIC_BIT,
72cbbc89 314 TRACE_EVENT_FL_KPROBE_BIT,
04a22fae 315 TRACE_EVENT_FL_UPROBE_BIT,
7491e2c4 316 TRACE_EVENT_FL_EPROBE_BIT,
553552ce
SR
317};
318
ae63b31e
SR
319/*
320 * Event flags:
321 * FILTERED - The event has a filter attached
322 * CAP_ANY - Any user can enable for perf
323 * NO_SET_FILTER - Set when filter has error and is to be ignored
5d6ad960 324 * IGNORE_ENABLE - For trace internal events, do not enable with debugfs file
de7b2973 325 * TRACEPOINT - Event is a tracepoint
8b0e6c74 326 * DYNAMIC - Event is a dynamic event (created at run time)
72cbbc89 327 * KPROBE - Event is a kprobe
04a22fae 328 * UPROBE - Event is a uprobe
7491e2c4 329 * EPROBE - Event is an event probe
ae63b31e 330 */
553552ce 331enum {
e870e9a1 332 TRACE_EVENT_FL_FILTERED = (1 << TRACE_EVENT_FL_FILTERED_BIT),
61c32659 333 TRACE_EVENT_FL_CAP_ANY = (1 << TRACE_EVENT_FL_CAP_ANY_BIT),
27b14b56 334 TRACE_EVENT_FL_NO_SET_FILTER = (1 << TRACE_EVENT_FL_NO_SET_FILTER_BIT),
9b63776f 335 TRACE_EVENT_FL_IGNORE_ENABLE = (1 << TRACE_EVENT_FL_IGNORE_ENABLE_BIT),
de7b2973 336 TRACE_EVENT_FL_TRACEPOINT = (1 << TRACE_EVENT_FL_TRACEPOINT_BIT),
8b0e6c74 337 TRACE_EVENT_FL_DYNAMIC = (1 << TRACE_EVENT_FL_DYNAMIC_BIT),
72cbbc89 338 TRACE_EVENT_FL_KPROBE = (1 << TRACE_EVENT_FL_KPROBE_BIT),
04a22fae 339 TRACE_EVENT_FL_UPROBE = (1 << TRACE_EVENT_FL_UPROBE_BIT),
7491e2c4 340 TRACE_EVENT_FL_EPROBE = (1 << TRACE_EVENT_FL_EPROBE_BIT),
553552ce
SR
341};
342
04a22fae
WN
343#define TRACE_EVENT_FL_UKPROBE (TRACE_EVENT_FL_KPROBE | TRACE_EVENT_FL_UPROBE)
344
2425bcb9 345struct trace_event_call {
a59fd602 346 struct list_head list;
2425bcb9 347 struct trace_event_class *class;
de7b2973
MD
348 union {
349 char *name;
350 /* Set TRACE_EVENT_FL_TRACEPOINT flag when using "tp" */
351 struct tracepoint *tp;
352 };
80decc70 353 struct trace_event event;
0c564a53 354 char *print_fmt;
1f9963cb 355 struct event_filter *filter;
1d18538e
SRV
356 /*
357 * Static events can disappear with modules,
358 * where as dynamic ones need their own ref count.
359 */
360 union {
361 void *module;
362 atomic_t refcnt;
363 };
69fd4f0e 364 void *data;
f9f34447
SRV
365
366 /* See the TRACE_EVENT_FL_* flags above */
ae63b31e
SR
367 int flags; /* static flags of different events */
368
369#ifdef CONFIG_PERF_EVENTS
370 int perf_refcount;
371 struct hlist_head __percpu *perf_events;
e87c6bc3 372 struct bpf_prog_array __rcu *prog_array;
d5b5f391 373
2425bcb9 374 int (*perf_perm)(struct trace_event_call *,
d5b5f391 375 struct perf_event *);
ae63b31e
SR
376#endif
377};
378
1d18538e
SRV
379#ifdef CONFIG_DYNAMIC_EVENTS
380bool trace_event_dyn_try_get_ref(struct trace_event_call *call);
381void trace_event_dyn_put_ref(struct trace_event_call *call);
382bool trace_event_dyn_busy(struct trace_event_call *call);
383#else
384static inline bool trace_event_dyn_try_get_ref(struct trace_event_call *call)
385{
386 /* Without DYNAMIC_EVENTS configured, nothing should be calling this */
387 return false;
388}
389static inline void trace_event_dyn_put_ref(struct trace_event_call *call)
390{
391}
392static inline bool trace_event_dyn_busy(struct trace_event_call *call)
393{
394 /* Nothing should call this without DYNAIMIC_EVENTS configured. */
395 return true;
396}
397#endif
398
399static inline bool trace_event_try_get_ref(struct trace_event_call *call)
400{
401 if (call->flags & TRACE_EVENT_FL_DYNAMIC)
402 return trace_event_dyn_try_get_ref(call);
403 else
404 return try_module_get(call->module);
405}
406
407static inline void trace_event_put_ref(struct trace_event_call *call)
408{
409 if (call->flags & TRACE_EVENT_FL_DYNAMIC)
410 trace_event_dyn_put_ref(call);
411 else
412 module_put(call->module);
413}
414
e87c6bc3
YS
415#ifdef CONFIG_PERF_EVENTS
416static inline bool bpf_prog_array_valid(struct trace_event_call *call)
417{
418 /*
419 * This inline function checks whether call->prog_array
420 * is valid or not. The function is called in various places,
421 * outside rcu_read_lock/unlock, as a heuristic to speed up execution.
422 *
423 * If this function returns true, and later call->prog_array
424 * becomes false inside rcu_read_lock/unlock region,
425 * we bail out then. If this function return false,
426 * there is a risk that we might miss a few events if the checking
427 * were delayed until inside rcu_read_lock/unlock region and
428 * call->prog_array happened to become non-NULL then.
429 *
430 * Here, READ_ONCE() is used instead of rcu_access_pointer().
431 * rcu_access_pointer() requires the actual definition of
432 * "struct bpf_prog_array" while READ_ONCE() only needs
433 * a declaration of the same type.
434 */
435 return !!READ_ONCE(call->prog_array);
436}
437#endif
438
de7b2973 439static inline const char *
687fcc4a 440trace_event_name(struct trace_event_call *call)
de7b2973
MD
441{
442 if (call->flags & TRACE_EVENT_FL_TRACEPOINT)
443 return call->tp ? call->tp->name : NULL;
444 else
445 return call->name;
446}
447
0aeb1def
CW
448static inline struct list_head *
449trace_get_fields(struct trace_event_call *event_call)
450{
451 if (!event_call->class->get_fields)
452 return &event_call->class->fields;
453 return event_call->class->get_fields(event_call);
454}
455
7967b3e0 456struct trace_subsystem_dir;
ae63b31e
SR
457
458enum {
5d6ad960
SRRH
459 EVENT_FILE_FL_ENABLED_BIT,
460 EVENT_FILE_FL_RECORDED_CMD_BIT,
d914ba37 461 EVENT_FILE_FL_RECORDED_TGID_BIT,
5d6ad960
SRRH
462 EVENT_FILE_FL_FILTERED_BIT,
463 EVENT_FILE_FL_NO_SET_FILTER_BIT,
464 EVENT_FILE_FL_SOFT_MODE_BIT,
465 EVENT_FILE_FL_SOFT_DISABLED_BIT,
466 EVENT_FILE_FL_TRIGGER_MODE_BIT,
467 EVENT_FILE_FL_TRIGGER_COND_BIT,
3fdaf80f 468 EVENT_FILE_FL_PID_FILTER_BIT,
065e63f9 469 EVENT_FILE_FL_WAS_ENABLED_BIT,
ae63b31e
SR
470};
471
e3e2a2cc
TZ
472extern struct trace_event_file *trace_get_event_file(const char *instance,
473 const char *system,
474 const char *event);
475extern void trace_put_event_file(struct trace_event_file *file);
476
86c5426b
TZ
477#define MAX_DYNEVENT_CMD_LEN (2048)
478
479enum dynevent_type {
35ca5207 480 DYNEVENT_TYPE_SYNTH = 1,
2a588dd1 481 DYNEVENT_TYPE_KPROBE,
86c5426b
TZ
482 DYNEVENT_TYPE_NONE,
483};
484
485struct dynevent_cmd;
486
487typedef int (*dynevent_create_fn_t)(struct dynevent_cmd *cmd);
488
489struct dynevent_cmd {
2b90927c 490 struct seq_buf seq;
86c5426b 491 const char *event_name;
86c5426b
TZ
492 unsigned int n_fields;
493 enum dynevent_type type;
494 dynevent_create_fn_t run_command;
495 void *private_data;
496};
497
498extern int dynevent_create(struct dynevent_cmd *cmd);
499
f5f6b255
TZ
500extern int synth_event_delete(const char *name);
501
35ca5207
TZ
502extern void synth_event_cmd_init(struct dynevent_cmd *cmd,
503 char *buf, int maxlen);
504
505extern int __synth_event_gen_cmd_start(struct dynevent_cmd *cmd,
506 const char *name,
507 struct module *mod, ...);
508
509#define synth_event_gen_cmd_start(cmd, name, mod, ...) \
510 __synth_event_gen_cmd_start(cmd, name, mod, ## __VA_ARGS__, NULL)
511
512struct synth_field_desc {
513 const char *type;
514 const char *name;
515};
516
517extern int synth_event_gen_cmd_array_start(struct dynevent_cmd *cmd,
518 const char *name,
519 struct module *mod,
520 struct synth_field_desc *fields,
521 unsigned int n_fields);
522extern int synth_event_create(const char *name,
523 struct synth_field_desc *fields,
524 unsigned int n_fields, struct module *mod);
525
526extern int synth_event_add_field(struct dynevent_cmd *cmd,
527 const char *type,
528 const char *name);
529extern int synth_event_add_field_str(struct dynevent_cmd *cmd,
530 const char *type_name);
531extern int synth_event_add_fields(struct dynevent_cmd *cmd,
532 struct synth_field_desc *fields,
533 unsigned int n_fields);
534
535#define synth_event_gen_cmd_end(cmd) \
536 dynevent_create(cmd)
537
8dcc53ad
TZ
538struct synth_event;
539
540struct synth_event_trace_state {
541 struct trace_event_buffer fbuffer;
542 struct synth_trace_event *entry;
543 struct trace_buffer *buffer;
544 struct synth_event *event;
545 unsigned int cur_field;
546 unsigned int n_u64;
7276531d 547 bool disabled;
8dcc53ad
TZ
548 bool add_next;
549 bool add_name;
550};
551
552extern int synth_event_trace(struct trace_event_file *file,
553 unsigned int n_vals, ...);
554extern int synth_event_trace_array(struct trace_event_file *file, u64 *vals,
555 unsigned int n_vals);
556extern int synth_event_trace_start(struct trace_event_file *file,
557 struct synth_event_trace_state *trace_state);
558extern int synth_event_add_next_val(u64 val,
559 struct synth_event_trace_state *trace_state);
560extern int synth_event_add_val(const char *field_name, u64 val,
561 struct synth_event_trace_state *trace_state);
562extern int synth_event_trace_end(struct synth_event_trace_state *trace_state);
563
2a588dd1
TZ
564extern int kprobe_event_delete(const char *name);
565
566extern void kprobe_event_cmd_init(struct dynevent_cmd *cmd,
567 char *buf, int maxlen);
568
569#define kprobe_event_gen_cmd_start(cmd, name, loc, ...) \
570 __kprobe_event_gen_cmd_start(cmd, false, name, loc, ## __VA_ARGS__, NULL)
571
572#define kretprobe_event_gen_cmd_start(cmd, name, loc, ...) \
573 __kprobe_event_gen_cmd_start(cmd, true, name, loc, ## __VA_ARGS__, NULL)
574
575extern int __kprobe_event_gen_cmd_start(struct dynevent_cmd *cmd,
576 bool kretprobe,
577 const char *name,
578 const char *loc, ...);
579
580#define kprobe_event_add_fields(cmd, ...) \
581 __kprobe_event_add_fields(cmd, ## __VA_ARGS__, NULL)
582
583#define kprobe_event_add_field(cmd, field) \
584 __kprobe_event_add_fields(cmd, field, NULL)
585
586extern int __kprobe_event_add_fields(struct dynevent_cmd *cmd, ...);
587
588#define kprobe_event_gen_cmd_end(cmd) \
589 dynevent_create(cmd)
590
591#define kretprobe_event_gen_cmd_end(cmd) \
592 dynevent_create(cmd)
593
ae63b31e 594/*
5d6ad960 595 * Event file flags:
57d01ad0 596 * ENABLED - The event is enabled
ae63b31e 597 * RECORDED_CMD - The comms should be recorded at sched_switch
d914ba37 598 * RECORDED_TGID - The tgids should be recorded at sched_switch
f306cc82
TZ
599 * FILTERED - The event has a filter attached
600 * NO_SET_FILTER - Set when filter has error and is to be ignored
417944c4
SRRH
601 * SOFT_MODE - The event is enabled/disabled by SOFT_DISABLED
602 * SOFT_DISABLED - When set, do not trace the event (even though its
603 * tracepoint may be enabled)
85f2b082 604 * TRIGGER_MODE - When set, invoke the triggers associated with the event
bac5fb97 605 * TRIGGER_COND - When set, one or more triggers has an associated filter
3fdaf80f 606 * PID_FILTER - When set, the event is filtered based on pid
065e63f9 607 * WAS_ENABLED - Set when enabled to know to clear trace on module removal
ae63b31e
SR
608 */
609enum {
5d6ad960
SRRH
610 EVENT_FILE_FL_ENABLED = (1 << EVENT_FILE_FL_ENABLED_BIT),
611 EVENT_FILE_FL_RECORDED_CMD = (1 << EVENT_FILE_FL_RECORDED_CMD_BIT),
d914ba37 612 EVENT_FILE_FL_RECORDED_TGID = (1 << EVENT_FILE_FL_RECORDED_TGID_BIT),
5d6ad960
SRRH
613 EVENT_FILE_FL_FILTERED = (1 << EVENT_FILE_FL_FILTERED_BIT),
614 EVENT_FILE_FL_NO_SET_FILTER = (1 << EVENT_FILE_FL_NO_SET_FILTER_BIT),
615 EVENT_FILE_FL_SOFT_MODE = (1 << EVENT_FILE_FL_SOFT_MODE_BIT),
616 EVENT_FILE_FL_SOFT_DISABLED = (1 << EVENT_FILE_FL_SOFT_DISABLED_BIT),
617 EVENT_FILE_FL_TRIGGER_MODE = (1 << EVENT_FILE_FL_TRIGGER_MODE_BIT),
618 EVENT_FILE_FL_TRIGGER_COND = (1 << EVENT_FILE_FL_TRIGGER_COND_BIT),
3fdaf80f 619 EVENT_FILE_FL_PID_FILTER = (1 << EVENT_FILE_FL_PID_FILTER_BIT),
065e63f9 620 EVENT_FILE_FL_WAS_ENABLED = (1 << EVENT_FILE_FL_WAS_ENABLED_BIT),
ae63b31e
SR
621};
622
7f1d2f82 623struct trace_event_file {
ae63b31e 624 struct list_head list;
2425bcb9 625 struct trace_event_call *event_call;
f86f4180 626 struct event_filter __rcu *filter;
ae63b31e
SR
627 struct dentry *dir;
628 struct trace_array *tr;
7967b3e0 629 struct trace_subsystem_dir *system;
85f2b082 630 struct list_head triggers;
97f20251 631
553552ce
SR
632 /*
633 * 32 bit flags:
57d01ad0
SRRH
634 * bit 0: enabled
635 * bit 1: enabled cmd record
417944c4
SRRH
636 * bit 2: enable/disable with the soft disable bit
637 * bit 3: soft disabled
85f2b082 638 * bit 4: trigger enabled
553552ce 639 *
417944c4
SRRH
640 * Note: The bits must be set atomically to prevent races
641 * from other writers. Reads of flags do not need to be in
642 * sync as they occur in critical sections. But the way flags
ae63b31e 643 * is currently used, these changes do not affect the code
1eaa4787
SR
644 * except that when a change is made, it may have a slight
645 * delay in propagating the changes to other CPUs due to
417944c4 646 * caching and such. Which is mostly OK ;-)
553552ce 647 */
417944c4 648 unsigned long flags;
1cf4c073 649 atomic_t sm_ref; /* soft-mode reference counter */
85f2b082 650 atomic_t tm_ref; /* trigger-mode reference counter */
97f20251
SR
651};
652
53cf810b
FW
653#define __TRACE_EVENT_FLAGS(name, value) \
654 static int __init trace_init_flags_##name(void) \
655 { \
de7b2973 656 event_##name.flags |= value; \
53cf810b
FW
657 return 0; \
658 } \
659 early_initcall(trace_init_flags_##name);
660
d5b5f391 661#define __TRACE_EVENT_PERF_PERM(name, expr...) \
2425bcb9 662 static int perf_perm_##name(struct trace_event_call *tp_event, \
d5b5f391
PZ
663 struct perf_event *p_event) \
664 { \
665 return ({ expr; }); \
666 } \
667 static int __init trace_init_perf_perm_##name(void) \
668 { \
669 event_##name.perf_perm = &perf_perm_##name; \
670 return 0; \
671 } \
672 early_initcall(trace_init_perf_perm_##name);
673
97d5a220 674#define PERF_MAX_TRACE_SIZE 2048
20ab4425 675
16bb8eb1 676#define MAX_FILTER_STR_VAL 256 /* Should handle KSYM_SYMBOL_LEN */
97f20251 677
85f2b082
TZ
678enum event_trigger_type {
679 ETT_NONE = (0),
2a2df321 680 ETT_TRACE_ONOFF = (1 << 0),
93e31ffb 681 ETT_SNAPSHOT = (1 << 1),
f21ecbb3 682 ETT_STACKTRACE = (1 << 2),
7862ad18 683 ETT_EVENT_ENABLE = (1 << 3),
7ef224d1 684 ETT_EVENT_HIST = (1 << 4),
d0bad49b 685 ETT_HIST_ENABLE = (1 << 5),
7491e2c4 686 ETT_EVENT_EPROBE = (1 << 6),
85f2b082
TZ
687};
688
6fb2915d 689extern int filter_match_preds(struct event_filter *filter, void *rec);
f306cc82 690
1ac4f51c 691extern enum event_trigger_type
b47e3302
SRV
692event_triggers_call(struct trace_event_file *file,
693 struct trace_buffer *buffer, void *rec,
1ac4f51c
TZ
694 struct ring_buffer_event *event);
695extern void
696event_triggers_post_call(struct trace_event_file *file,
c94e45bc 697 enum event_trigger_type tt);
97f20251 698
3fdaf80f
SRRH
699bool trace_event_ignore_this_pid(struct trace_event_file *trace_file);
700
13a1e4ae 701/**
09a5059a 702 * trace_trigger_soft_disabled - do triggers and test if soft disabled
13a1e4ae
SRRH
703 * @file: The file pointer of the event to test
704 *
705 * If any triggers without filters are attached to this event, they
706 * will be called here. If the event is soft disabled and has no
707 * triggers that require testing the fields, it will return true,
708 * otherwise false.
709 */
710static inline bool
09a5059a 711trace_trigger_soft_disabled(struct trace_event_file *file)
13a1e4ae
SRRH
712{
713 unsigned long eflags = file->flags;
714
5d6ad960
SRRH
715 if (!(eflags & EVENT_FILE_FL_TRIGGER_COND)) {
716 if (eflags & EVENT_FILE_FL_TRIGGER_MODE)
b47e3302 717 event_triggers_call(file, NULL, NULL, NULL);
5d6ad960 718 if (eflags & EVENT_FILE_FL_SOFT_DISABLED)
13a1e4ae 719 return true;
3fdaf80f
SRRH
720 if (eflags & EVENT_FILE_FL_PID_FILTER)
721 return trace_event_ignore_this_pid(file);
13a1e4ae
SRRH
722 }
723 return false;
724}
725
098d2164 726#ifdef CONFIG_BPF_EVENTS
e87c6bc3 727unsigned int trace_call_bpf(struct trace_event_call *call, void *ctx);
82e6b1ee 728int perf_event_attach_bpf_prog(struct perf_event *event, struct bpf_prog *prog, u64 bpf_cookie);
e87c6bc3 729void perf_event_detach_bpf_prog(struct perf_event *event);
f4e2298e 730int perf_event_query_prog_array(struct perf_event *event, void __user *info);
c4f6699d
AS
731int bpf_probe_register(struct bpf_raw_event_map *btp, struct bpf_prog *prog);
732int bpf_probe_unregister(struct bpf_raw_event_map *btp, struct bpf_prog *prog);
a38d1107
MM
733struct bpf_raw_event_map *bpf_get_raw_tracepoint(const char *name);
734void bpf_put_raw_tracepoint(struct bpf_raw_event_map *btp);
41bdc4b4
YS
735int bpf_get_perf_event_info(const struct perf_event *event, u32 *prog_id,
736 u32 *fd_type, const char **buf,
737 u64 *probe_offset, u64 *probe_addr);
2541517c 738#else
e87c6bc3 739static inline unsigned int trace_call_bpf(struct trace_event_call *call, void *ctx)
2541517c
AS
740{
741 return 1;
742}
e87c6bc3
YS
743
744static inline int
82e6b1ee 745perf_event_attach_bpf_prog(struct perf_event *event, struct bpf_prog *prog, u64 bpf_cookie)
e87c6bc3
YS
746{
747 return -EOPNOTSUPP;
748}
749
750static inline void perf_event_detach_bpf_prog(struct perf_event *event) { }
751
f4e2298e
YS
752static inline int
753perf_event_query_prog_array(struct perf_event *event, void __user *info)
754{
755 return -EOPNOTSUPP;
756}
c4f6699d
AS
757static inline int bpf_probe_register(struct bpf_raw_event_map *btp, struct bpf_prog *p)
758{
759 return -EOPNOTSUPP;
760}
761static inline int bpf_probe_unregister(struct bpf_raw_event_map *btp, struct bpf_prog *p)
762{
763 return -EOPNOTSUPP;
764}
a38d1107 765static inline struct bpf_raw_event_map *bpf_get_raw_tracepoint(const char *name)
c4f6699d
AS
766{
767 return NULL;
768}
a38d1107
MM
769static inline void bpf_put_raw_tracepoint(struct bpf_raw_event_map *btp)
770{
771}
41bdc4b4
YS
772static inline int bpf_get_perf_event_info(const struct perf_event *event,
773 u32 *prog_id, u32 *fd_type,
774 const char **buf, u64 *probe_offset,
775 u64 *probe_addr)
776{
777 return -EOPNOTSUPP;
778}
2541517c
AS
779#endif
780
43b51ead
LZ
781enum {
782 FILTER_OTHER = 0,
783 FILTER_STATIC_STRING,
784 FILTER_DYN_STRING,
87a342f5 785 FILTER_PTR_STRING,
02aa3162 786 FILTER_TRACE_FN,
e57cbaf0
SRRH
787 FILTER_COMM,
788 FILTER_CPU,
43b51ead
LZ
789};
790
2425bcb9
SRRH
791extern int trace_event_raw_init(struct trace_event_call *call);
792extern int trace_define_field(struct trace_event_call *call, const char *type,
aeaeae11
FW
793 const char *name, int offset, int size,
794 int is_signed, int filter_type);
2425bcb9
SRRH
795extern int trace_add_event_call(struct trace_event_call *call);
796extern int trace_remove_event_call(struct trace_event_call *call);
32bbe007 797extern int trace_event_get_offsets(struct trace_event_call *call);
97f20251 798
d2802d07 799#define is_signed_type(type) (((type)(-1)) < (type)1)
97f20251 800
595a438c 801int ftrace_set_clr_event(struct trace_array *tr, char *buf, int set);
4671c794 802int trace_set_clr_event(const char *system, const char *event, int set);
28879787
DI
803int trace_array_set_clr_event(struct trace_array *tr, const char *system,
804 const char *event, bool enable);
97f20251
SR
805/*
806 * The double __builtin_constant_p is because gcc will give us an error
807 * if we try to allocate the static variable to fmt if it is not a
808 * constant. Even with the outer if statement optimizing out.
809 */
810#define event_trace_printk(ip, fmt, args...) \
811do { \
812 __trace_printk_check_format(fmt, ##args); \
813 tracing_record_cmdline(current); \
814 if (__builtin_constant_p(fmt)) { \
815 static const char *trace_printk_fmt \
33def849 816 __section("__trace_printk_fmt") = \
97f20251
SR
817 __builtin_constant_p(fmt) ? fmt : NULL; \
818 \
819 __trace_bprintk(ip, trace_printk_fmt, ##args); \
820 } else \
821 __trace_printk(ip, fmt, ##args); \
822} while (0)
823
07b139c8 824#ifdef CONFIG_PERF_EVENTS
6fb2915d 825struct perf_event;
c530665c
FW
826
827DECLARE_PER_CPU(struct pt_regs, perf_trace_regs);
9802d865 828DECLARE_PER_CPU(int, bpf_kprobe_override);
c530665c 829
1c024eca
PZ
830extern int perf_trace_init(struct perf_event *event);
831extern void perf_trace_destroy(struct perf_event *event);
a4eaf7f1
PZ
832extern int perf_trace_add(struct perf_event *event, int flags);
833extern void perf_trace_del(struct perf_event *event, int flags);
e12f03d7
SL
834#ifdef CONFIG_KPROBE_EVENTS
835extern int perf_kprobe_init(struct perf_event *event, bool is_retprobe);
836extern void perf_kprobe_destroy(struct perf_event *event);
41bdc4b4
YS
837extern int bpf_get_kprobe_info(const struct perf_event *event,
838 u32 *fd_type, const char **symbol,
839 u64 *probe_offset, u64 *probe_addr,
840 bool perf_type_tracepoint);
e12f03d7 841#endif
33ea4b24 842#ifdef CONFIG_UPROBE_EVENTS
a6ca88b2
SL
843extern int perf_uprobe_init(struct perf_event *event,
844 unsigned long ref_ctr_offset, bool is_retprobe);
33ea4b24 845extern void perf_uprobe_destroy(struct perf_event *event);
41bdc4b4
YS
846extern int bpf_get_uprobe_info(const struct perf_event *event,
847 u32 *fd_type, const char **filename,
848 u64 *probe_offset, bool perf_type_tracepoint);
33ea4b24 849#endif
1c024eca 850extern int ftrace_profile_set_filter(struct perf_event *event, int event_id,
6fb2915d
LZ
851 char *filter_str);
852extern void ftrace_profile_free_filter(struct perf_event *event);
1e1dcd93
AS
853void perf_trace_buf_update(void *record, u16 type);
854void *perf_trace_buf_alloc(int size, struct pt_regs **regs, int *rctxp);
430ad5a6 855
82e6b1ee 856int perf_event_set_bpf_prog(struct perf_event *event, struct bpf_prog *prog, u64 bpf_cookie);
b89fbfbb
AN
857void perf_event_free_bpf_prog(struct perf_event *event);
858
c4f6699d
AS
859void bpf_trace_run1(struct bpf_prog *prog, u64 arg1);
860void bpf_trace_run2(struct bpf_prog *prog, u64 arg1, u64 arg2);
861void bpf_trace_run3(struct bpf_prog *prog, u64 arg1, u64 arg2,
862 u64 arg3);
863void bpf_trace_run4(struct bpf_prog *prog, u64 arg1, u64 arg2,
864 u64 arg3, u64 arg4);
865void bpf_trace_run5(struct bpf_prog *prog, u64 arg1, u64 arg2,
866 u64 arg3, u64 arg4, u64 arg5);
867void bpf_trace_run6(struct bpf_prog *prog, u64 arg1, u64 arg2,
868 u64 arg3, u64 arg4, u64 arg5, u64 arg6);
869void bpf_trace_run7(struct bpf_prog *prog, u64 arg1, u64 arg2,
870 u64 arg3, u64 arg4, u64 arg5, u64 arg6, u64 arg7);
871void bpf_trace_run8(struct bpf_prog *prog, u64 arg1, u64 arg2,
872 u64 arg3, u64 arg4, u64 arg5, u64 arg6, u64 arg7,
873 u64 arg8);
874void bpf_trace_run9(struct bpf_prog *prog, u64 arg1, u64 arg2,
875 u64 arg3, u64 arg4, u64 arg5, u64 arg6, u64 arg7,
876 u64 arg8, u64 arg9);
877void bpf_trace_run10(struct bpf_prog *prog, u64 arg1, u64 arg2,
878 u64 arg3, u64 arg4, u64 arg5, u64 arg6, u64 arg7,
879 u64 arg8, u64 arg9, u64 arg10);
880void bpf_trace_run11(struct bpf_prog *prog, u64 arg1, u64 arg2,
881 u64 arg3, u64 arg4, u64 arg5, u64 arg6, u64 arg7,
882 u64 arg8, u64 arg9, u64 arg10, u64 arg11);
883void bpf_trace_run12(struct bpf_prog *prog, u64 arg1, u64 arg2,
884 u64 arg3, u64 arg4, u64 arg5, u64 arg6, u64 arg7,
885 u64 arg8, u64 arg9, u64 arg10, u64 arg11, u64 arg12);
85b67bcb
AS
886void perf_trace_run_bpf_submit(void *raw_data, int size, int rctx,
887 struct trace_event_call *call, u64 count,
888 struct pt_regs *regs, struct hlist_head *head,
889 struct task_struct *task);
890
430ad5a6 891static inline void
1e1dcd93 892perf_trace_buf_submit(void *raw_data, int size, int rctx, u16 type,
e6dab5ff 893 u64 count, struct pt_regs *regs, void *head,
8fd0fbbe 894 struct task_struct *task)
430ad5a6 895{
8fd0fbbe 896 perf_tp_event(type, count, raw_data, size, regs, head, rctx, task);
430ad5a6 897}
e87c6bc3 898
6fb2915d
LZ
899#endif
900
2425bcb9 901#endif /* _LINUX_TRACE_EVENT_H */