1 // SPDX-License-Identifier: GPL-2.0
2
3 #ifndef _LINUX_KERNEL_TRACE_H
4 #define _LINUX_KERNEL_TRACE_H
5
6 #include <linux/fs.h>
7 #include <linux/atomic.h>
8 #include <linux/sched.h>
9 #include <linux/clocksource.h>
10 #include <linux/ring_buffer.h>
11 #include <linux/mmiotrace.h>
12 #include <linux/tracepoint.h>
13 #include <linux/ftrace.h>
14 #include <linux/trace.h>
15 #include <linux/hw_breakpoint.h>
16 #include <linux/trace_seq.h>
17 #include <linux/trace_events.h>
18 #include <linux/compiler.h>
19 #include <linux/glob.h>
20 #include <linux/irq_work.h>
21 #include <linux/workqueue.h>
22 #include <linux/ctype.h>
23 #include <linux/once_lite.h>
24
25 #include "pid_list.h"
26
27 #ifdef CONFIG_FTRACE_SYSCALLS
28 #include <asm/unistd.h> /* For NR_syscalls */
29 #include <asm/syscall.h> /* some archs define it here */
30 #endif
31
32 #define TRACE_MODE_WRITE 0640
33 #define TRACE_MODE_READ 0440
34
35 enum trace_type {
36 __TRACE_FIRST_TYPE = 0,
37
38 TRACE_FN,
39 TRACE_CTX,
40 TRACE_WAKE,
41 TRACE_STACK,
42 TRACE_PRINT,
43 TRACE_BPRINT,
44 TRACE_MMIO_RW,
45 TRACE_MMIO_MAP,
46 TRACE_BRANCH,
47 TRACE_GRAPH_RET,
48 TRACE_GRAPH_ENT,
49 TRACE_USER_STACK,
50 TRACE_BLK,
51 TRACE_BPUTS,
52 TRACE_HWLAT,
53 TRACE_OSNOISE,
54 TRACE_TIMERLAT,
55 TRACE_RAW_DATA,
56 TRACE_FUNC_REPEATS,
57
58 __TRACE_LAST_TYPE,
59 };
60
61
62 #undef __field
63 #define __field(type, item) type item;
64
65 #undef __field_fn
66 #define __field_fn(type, item) type item;
67
68 #undef __field_struct
69 #define __field_struct(type, item) __field(type, item)
70
71 #undef __field_desc
72 #define __field_desc(type, container, item)
73
74 #undef __field_packed
75 #define __field_packed(type, container, item)
76
77 #undef __array
78 #define __array(type, item, size) type item[size];
79
80 /*
81 * For backward compatibility, older user space expects to see the
82 * kernel_stack event with a fixed size caller field. But today the fix
83 * size is ignored by the kernel, and the real structure is dynamic.
84 * Expose to user space: "unsigned long caller[8];" but the real structure
85 * will be "unsigned long caller[] __counted_by(size)"
86 */
87 #undef __stack_array
88 #define __stack_array(type, item, size, field) type item[] __counted_by(field);
89
90 #undef __array_desc
91 #define __array_desc(type, container, item, size)
92
93 #undef __dynamic_array
94 #define __dynamic_array(type, item) type item[];
95
96 #undef __rel_dynamic_array
97 #define __rel_dynamic_array(type, item) type item[];
98
99 #undef F_STRUCT
100 #define F_STRUCT(args...) args
101
102 #undef FTRACE_ENTRY
103 #define FTRACE_ENTRY(name, struct_name, id, tstruct, print) \
104 struct struct_name { \
105 struct trace_entry ent; \
106 tstruct \
107 }
108
109 #undef FTRACE_ENTRY_DUP
110 #define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk)
111
112 #undef FTRACE_ENTRY_REG
113 #define FTRACE_ENTRY_REG(name, struct_name, id, tstruct, print, regfn) \
114 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print))
115
116 #undef FTRACE_ENTRY_PACKED
117 #define FTRACE_ENTRY_PACKED(name, struct_name, id, tstruct, print) \
118 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print)) __packed
119
120 #include "trace_entries.h"
121
122 /* Use this for memory failure errors */
123 #define MEM_FAIL(condition, fmt, ...) \
124 DO_ONCE_LITE_IF(condition, pr_err, "ERROR: " fmt, ##__VA_ARGS__)
125
126 #define FAULT_STRING "(fault)"
127
128 #define HIST_STACKTRACE_DEPTH 16
129 #define HIST_STACKTRACE_SIZE (HIST_STACKTRACE_DEPTH * sizeof(unsigned long))
130 #define HIST_STACKTRACE_SKIP 5
131
132 /*
133 * syscalls are special, and need special handling, this is why
134 * they are not included in trace_entries.h
135 */
136 struct syscall_trace_enter {
137 struct trace_entry ent;
138 int nr;
139 unsigned long args[];
140 };
141
142 struct syscall_trace_exit {
143 struct trace_entry ent;
144 int nr;
145 long ret;
146 };
147
148 struct kprobe_trace_entry_head {
149 struct trace_entry ent;
150 unsigned long ip;
151 };
152
153 struct eprobe_trace_entry_head {
154 struct trace_entry ent;
155 };
156
157 struct kretprobe_trace_entry_head {
158 struct trace_entry ent;
159 unsigned long func;
160 unsigned long ret_ip;
161 };
162
163 struct fentry_trace_entry_head {
164 struct trace_entry ent;
165 unsigned long ip;
166 };
167
168 struct fexit_trace_entry_head {
169 struct trace_entry ent;
170 unsigned long func;
171 unsigned long ret_ip;
172 };
173
174 #define TRACE_BUF_SIZE 1024
175
176 struct trace_array;
177
178 /*
179 * The CPU trace array - it consists of thousands of trace entries
180 * plus some other descriptor data: (for example which task started
181 * the trace, etc.)
182 */
183 struct trace_array_cpu {
184 atomic_t disabled;
185 void *buffer_page; /* ring buffer spare */
186
187 unsigned long entries;
188 unsigned long saved_latency;
189 unsigned long critical_start;
190 unsigned long critical_end;
191 unsigned long critical_sequence;
192 unsigned long nice;
193 unsigned long policy;
194 unsigned long rt_priority;
195 unsigned long skipped_entries;
196 u64 preempt_timestamp;
197 pid_t pid;
198 kuid_t uid;
199 char comm[TASK_COMM_LEN];
200
201 #ifdef CONFIG_FUNCTION_TRACER
202 int ftrace_ignore_pid;
203 #endif
204 bool ignore_pid;
205 };
206
207 struct tracer;
208 struct trace_option_dentry;
209
210 struct array_buffer {
211 struct trace_array *tr;
212 struct trace_buffer *buffer;
213 struct trace_array_cpu __percpu *data;
214 u64 time_start;
215 int cpu;
216 };
217
218 #define TRACE_FLAGS_MAX_SIZE 32
219
220 struct trace_options {
221 struct tracer *tracer;
222 struct trace_option_dentry *topts;
223 };
224
225 struct trace_pid_list *trace_pid_list_alloc(void);
226 void trace_pid_list_free(struct trace_pid_list *pid_list);
227 bool trace_pid_list_is_set(struct trace_pid_list *pid_list, unsigned int pid);
228 int trace_pid_list_set(struct trace_pid_list *pid_list, unsigned int pid);
229 int trace_pid_list_clear(struct trace_pid_list *pid_list, unsigned int pid);
230 int trace_pid_list_first(struct trace_pid_list *pid_list, unsigned int *pid);
231 int trace_pid_list_next(struct trace_pid_list *pid_list, unsigned int pid,
232 unsigned int *next);
233
234 enum {
235 TRACE_PIDS = BIT(0),
236 TRACE_NO_PIDS = BIT(1),
237 };
238
pid_type_enabled(int type,struct trace_pid_list * pid_list,struct trace_pid_list * no_pid_list)239 static inline bool pid_type_enabled(int type, struct trace_pid_list *pid_list,
240 struct trace_pid_list *no_pid_list)
241 {
242 /* Return true if the pid list in type has pids */
243 return ((type & TRACE_PIDS) && pid_list) ||
244 ((type & TRACE_NO_PIDS) && no_pid_list);
245 }
246
still_need_pid_events(int type,struct trace_pid_list * pid_list,struct trace_pid_list * no_pid_list)247 static inline bool still_need_pid_events(int type, struct trace_pid_list *pid_list,
248 struct trace_pid_list *no_pid_list)
249 {
250 /*
251 * Turning off what is in @type, return true if the "other"
252 * pid list, still has pids in it.
253 */
254 return (!(type & TRACE_PIDS) && pid_list) ||
255 (!(type & TRACE_NO_PIDS) && no_pid_list);
256 }
257
258 typedef bool (*cond_update_fn_t)(struct trace_array *tr, void *cond_data);
259
260 /**
261 * struct cond_snapshot - conditional snapshot data and callback
262 *
263 * The cond_snapshot structure encapsulates a callback function and
264 * data associated with the snapshot for a given tracing instance.
265 *
266 * When a snapshot is taken conditionally, by invoking
267 * tracing_snapshot_cond(tr, cond_data), the cond_data passed in is
268 * passed in turn to the cond_snapshot.update() function. That data
269 * can be compared by the update() implementation with the cond_data
270 * contained within the struct cond_snapshot instance associated with
271 * the trace_array. Because the tr->max_lock is held throughout the
272 * update() call, the update() function can directly retrieve the
273 * cond_snapshot and cond_data associated with the per-instance
274 * snapshot associated with the trace_array.
275 *
276 * The cond_snapshot.update() implementation can save data to be
277 * associated with the snapshot if it decides to, and returns 'true'
278 * in that case, or it returns 'false' if the conditional snapshot
279 * shouldn't be taken.
280 *
281 * The cond_snapshot instance is created and associated with the
282 * user-defined cond_data by tracing_cond_snapshot_enable().
283 * Likewise, the cond_snapshot instance is destroyed and is no longer
284 * associated with the trace instance by
285 * tracing_cond_snapshot_disable().
286 *
287 * The method below is required.
288 *
289 * @update: When a conditional snapshot is invoked, the update()
290 * callback function is invoked with the tr->max_lock held. The
291 * update() implementation signals whether or not to actually
292 * take the snapshot, by returning 'true' if so, 'false' if no
293 * snapshot should be taken. Because the max_lock is held for
294 * the duration of update(), the implementation is safe to
295 * directly retrieved and save any implementation data it needs
296 * to in association with the snapshot.
297 */
298 struct cond_snapshot {
299 void *cond_data;
300 cond_update_fn_t update;
301 };
302
303 /*
304 * struct trace_func_repeats - used to keep track of the consecutive
305 * (on the same CPU) calls of a single function.
306 */
307 struct trace_func_repeats {
308 unsigned long ip;
309 unsigned long parent_ip;
310 unsigned long count;
311 u64 ts_last_call;
312 };
313
314 /*
315 * The trace array - an array of per-CPU trace arrays. This is the
316 * highest level data structure that individual tracers deal with.
317 * They have on/off state as well:
318 */
319 struct trace_array {
320 struct list_head list;
321 char *name;
322 struct array_buffer array_buffer;
323 #ifdef CONFIG_TRACER_MAX_TRACE
324 /*
325 * The max_buffer is used to snapshot the trace when a maximum
326 * latency is reached, or when the user initiates a snapshot.
327 * Some tracers will use this to store a maximum trace while
328 * it continues examining live traces.
329 *
330 * The buffers for the max_buffer are set up the same as the array_buffer
331 * When a snapshot is taken, the buffer of the max_buffer is swapped
332 * with the buffer of the array_buffer and the buffers are reset for
333 * the array_buffer so the tracing can continue.
334 */
335 struct array_buffer max_buffer;
336 bool allocated_snapshot;
337 spinlock_t snapshot_trigger_lock;
338 unsigned int snapshot;
339 unsigned long max_latency;
340 #ifdef CONFIG_FSNOTIFY
341 struct dentry *d_max_latency;
342 struct work_struct fsnotify_work;
343 struct irq_work fsnotify_irqwork;
344 #endif
345 #endif
346 struct trace_pid_list __rcu *filtered_pids;
347 struct trace_pid_list __rcu *filtered_no_pids;
348 /*
349 * max_lock is used to protect the swapping of buffers
350 * when taking a max snapshot. The buffers themselves are
351 * protected by per_cpu spinlocks. But the action of the swap
352 * needs its own lock.
353 *
354 * This is defined as a arch_spinlock_t in order to help
355 * with performance when lockdep debugging is enabled.
356 *
357 * It is also used in other places outside the update_max_tr
358 * so it needs to be defined outside of the
359 * CONFIG_TRACER_MAX_TRACE.
360 */
361 arch_spinlock_t max_lock;
362 int buffer_disabled;
363 #ifdef CONFIG_FTRACE_SYSCALLS
364 int sys_refcount_enter;
365 int sys_refcount_exit;
366 struct trace_event_file __rcu *enter_syscall_files[NR_syscalls];
367 struct trace_event_file __rcu *exit_syscall_files[NR_syscalls];
368 #endif
369 int stop_count;
370 int clock_id;
371 int nr_topts;
372 bool clear_trace;
373 int buffer_percent;
374 unsigned int n_err_log_entries;
375 struct tracer *current_trace;
376 unsigned int trace_flags;
377 unsigned char trace_flags_index[TRACE_FLAGS_MAX_SIZE];
378 unsigned int flags;
379 raw_spinlock_t start_lock;
380 const char *system_names;
381 struct list_head err_log;
382 struct dentry *dir;
383 struct dentry *options;
384 struct dentry *percpu_dir;
385 struct eventfs_inode *event_dir;
386 struct trace_options *topts;
387 struct list_head systems;
388 struct list_head events;
389 struct trace_event_file *trace_marker_file;
390 cpumask_var_t tracing_cpumask; /* only trace on set CPUs */
391 /* one per_cpu trace_pipe can be opened by only one user */
392 cpumask_var_t pipe_cpumask;
393 int ref;
394 int trace_ref;
395 #ifdef CONFIG_FUNCTION_TRACER
396 struct ftrace_ops *ops;
397 struct trace_pid_list __rcu *function_pids;
398 struct trace_pid_list __rcu *function_no_pids;
399 #ifdef CONFIG_DYNAMIC_FTRACE
400 /* All of these are protected by the ftrace_lock */
401 struct list_head func_probes;
402 struct list_head mod_trace;
403 struct list_head mod_notrace;
404 #endif
405 /* function tracing enabled */
406 int function_enabled;
407 #endif
408 int no_filter_buffering_ref;
409 struct list_head hist_vars;
410 #ifdef CONFIG_TRACER_SNAPSHOT
411 struct cond_snapshot *cond_snapshot;
412 #endif
413 struct trace_func_repeats __percpu *last_func_repeats;
414 /*
415 * On boot up, the ring buffer is set to the minimum size, so that
416 * we do not waste memory on systems that are not using tracing.
417 */
418 bool ring_buffer_expanded;
419 };
420
421 enum {
422 TRACE_ARRAY_FL_GLOBAL = (1 << 0)
423 };
424
425 extern struct list_head ftrace_trace_arrays;
426
427 extern struct mutex trace_types_lock;
428
429 extern int trace_array_get(struct trace_array *tr);
430 extern int tracing_check_open_get_tr(struct trace_array *tr);
431 extern struct trace_array *trace_array_find(const char *instance);
432 extern struct trace_array *trace_array_find_get(const char *instance);
433
434 extern u64 tracing_event_time_stamp(struct trace_buffer *buffer, struct ring_buffer_event *rbe);
435 extern int tracing_set_filter_buffering(struct trace_array *tr, bool set);
436 extern int tracing_set_clock(struct trace_array *tr, const char *clockstr);
437
438 extern bool trace_clock_in_ns(struct trace_array *tr);
439
440 /*
441 * The global tracer (top) should be the first trace array added,
442 * but we check the flag anyway.
443 */
top_trace_array(void)444 static inline struct trace_array *top_trace_array(void)
445 {
446 struct trace_array *tr;
447
448 if (list_empty(&ftrace_trace_arrays))
449 return NULL;
450
451 tr = list_entry(ftrace_trace_arrays.prev,
452 typeof(*tr), list);
453 WARN_ON(!(tr->flags & TRACE_ARRAY_FL_GLOBAL));
454 return tr;
455 }
456
457 #define FTRACE_CMP_TYPE(var, type) \
458 __builtin_types_compatible_p(typeof(var), type *)
459
460 #undef IF_ASSIGN
461 #define IF_ASSIGN(var, entry, etype, id) \
462 if (FTRACE_CMP_TYPE(var, etype)) { \
463 var = (typeof(var))(entry); \
464 WARN_ON(id != 0 && (entry)->type != id); \
465 break; \
466 }
467
468 /* Will cause compile errors if type is not found. */
469 extern void __ftrace_bad_type(void);
470
471 /*
472 * The trace_assign_type is a verifier that the entry type is
473 * the same as the type being assigned. To add new types simply
474 * add a line with the following format:
475 *
476 * IF_ASSIGN(var, ent, type, id);
477 *
478 * Where "type" is the trace type that includes the trace_entry
479 * as the "ent" item. And "id" is the trace identifier that is
480 * used in the trace_type enum.
481 *
482 * If the type can have more than one id, then use zero.
483 */
484 #define trace_assign_type(var, ent) \
485 do { \
486 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
487 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
488 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
489 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
490 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
491 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
492 IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS); \
493 IF_ASSIGN(var, ent, struct hwlat_entry, TRACE_HWLAT); \
494 IF_ASSIGN(var, ent, struct osnoise_entry, TRACE_OSNOISE);\
495 IF_ASSIGN(var, ent, struct timerlat_entry, TRACE_TIMERLAT);\
496 IF_ASSIGN(var, ent, struct raw_data_entry, TRACE_RAW_DATA);\
497 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
498 TRACE_MMIO_RW); \
499 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
500 TRACE_MMIO_MAP); \
501 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
502 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
503 TRACE_GRAPH_ENT); \
504 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
505 TRACE_GRAPH_RET); \
506 IF_ASSIGN(var, ent, struct func_repeats_entry, \
507 TRACE_FUNC_REPEATS); \
508 __ftrace_bad_type(); \
509 } while (0)
510
511 /*
512 * An option specific to a tracer. This is a boolean value.
513 * The bit is the bit index that sets its value on the
514 * flags value in struct tracer_flags.
515 */
516 struct tracer_opt {
517 const char *name; /* Will appear on the trace_options file */
518 u32 bit; /* Mask assigned in val field in tracer_flags */
519 };
520
521 /*
522 * The set of specific options for a tracer. Your tracer
523 * have to set the initial value of the flags val.
524 */
525 struct tracer_flags {
526 u32 val;
527 struct tracer_opt *opts;
528 struct tracer *trace;
529 };
530
531 /* Makes more easy to define a tracer opt */
532 #define TRACER_OPT(s, b) .name = #s, .bit = b
533
534
535 struct trace_option_dentry {
536 struct tracer_opt *opt;
537 struct tracer_flags *flags;
538 struct trace_array *tr;
539 struct dentry *entry;
540 };
541
542 /**
543 * struct tracer - a specific tracer and its callbacks to interact with tracefs
544 * @name: the name chosen to select it on the available_tracers file
545 * @init: called when one switches to this tracer (echo name > current_tracer)
546 * @reset: called when one switches to another tracer
547 * @start: called when tracing is unpaused (echo 1 > tracing_on)
548 * @stop: called when tracing is paused (echo 0 > tracing_on)
549 * @update_thresh: called when tracing_thresh is updated
550 * @open: called when the trace file is opened
551 * @pipe_open: called when the trace_pipe file is opened
552 * @close: called when the trace file is released
553 * @pipe_close: called when the trace_pipe file is released
554 * @read: override the default read callback on trace_pipe
555 * @splice_read: override the default splice_read callback on trace_pipe
556 * @selftest: selftest to run on boot (see trace_selftest.c)
557 * @print_headers: override the first lines that describe your columns
558 * @print_line: callback that prints a trace
559 * @set_flag: signals one of your private flags changed (trace_options file)
560 * @flags: your private flags
561 */
562 struct tracer {
563 const char *name;
564 int (*init)(struct trace_array *tr);
565 void (*reset)(struct trace_array *tr);
566 void (*start)(struct trace_array *tr);
567 void (*stop)(struct trace_array *tr);
568 int (*update_thresh)(struct trace_array *tr);
569 void (*open)(struct trace_iterator *iter);
570 void (*pipe_open)(struct trace_iterator *iter);
571 void (*close)(struct trace_iterator *iter);
572 void (*pipe_close)(struct trace_iterator *iter);
573 ssize_t (*read)(struct trace_iterator *iter,
574 struct file *filp, char __user *ubuf,
575 size_t cnt, loff_t *ppos);
576 ssize_t (*splice_read)(struct trace_iterator *iter,
577 struct file *filp,
578 loff_t *ppos,
579 struct pipe_inode_info *pipe,
580 size_t len,
581 unsigned int flags);
582 #ifdef CONFIG_FTRACE_STARTUP_TEST
583 int (*selftest)(struct tracer *trace,
584 struct trace_array *tr);
585 #endif
586 void (*print_header)(struct seq_file *m);
587 enum print_line_t (*print_line)(struct trace_iterator *iter);
588 /* If you handled the flag setting, return 0 */
589 int (*set_flag)(struct trace_array *tr,
590 u32 old_flags, u32 bit, int set);
591 /* Return 0 if OK with change, else return non-zero */
592 int (*flag_changed)(struct trace_array *tr,
593 u32 mask, int set);
594 struct tracer *next;
595 struct tracer_flags *flags;
596 int enabled;
597 bool print_max;
598 bool allow_instances;
599 #ifdef CONFIG_TRACER_MAX_TRACE
600 bool use_max_tr;
601 #endif
602 /* True if tracer cannot be enabled in kernel param */
603 bool noboot;
604 };
605
606 static inline struct ring_buffer_iter *
trace_buffer_iter(struct trace_iterator * iter,int cpu)607 trace_buffer_iter(struct trace_iterator *iter, int cpu)
608 {
609 return iter->buffer_iter ? iter->buffer_iter[cpu] : NULL;
610 }
611
612 int tracer_init(struct tracer *t, struct trace_array *tr);
613 int tracing_is_enabled(void);
614 void tracing_reset_online_cpus(struct array_buffer *buf);
615 void tracing_reset_all_online_cpus(void);
616 void tracing_reset_all_online_cpus_unlocked(void);
617 int tracing_open_generic(struct inode *inode, struct file *filp);
618 int tracing_open_generic_tr(struct inode *inode, struct file *filp);
619 int tracing_release_generic_tr(struct inode *inode, struct file *file);
620 int tracing_open_file_tr(struct inode *inode, struct file *filp);
621 int tracing_release_file_tr(struct inode *inode, struct file *filp);
622 int tracing_single_release_file_tr(struct inode *inode, struct file *filp);
623 bool tracing_is_disabled(void);
624 bool tracer_tracing_is_on(struct trace_array *tr);
625 void tracer_tracing_on(struct trace_array *tr);
626 void tracer_tracing_off(struct trace_array *tr);
627 struct dentry *trace_create_file(const char *name,
628 umode_t mode,
629 struct dentry *parent,
630 void *data,
631 const struct file_operations *fops);
632
633 int tracing_init_dentry(void);
634
635 struct ring_buffer_event;
636
637 struct ring_buffer_event *
638 trace_buffer_lock_reserve(struct trace_buffer *buffer,
639 int type,
640 unsigned long len,
641 unsigned int trace_ctx);
642
643 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
644 struct trace_array_cpu *data);
645
646 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
647 int *ent_cpu, u64 *ent_ts);
648
649 void trace_buffer_unlock_commit_nostack(struct trace_buffer *buffer,
650 struct ring_buffer_event *event);
651
652 bool trace_is_tracepoint_string(const char *str);
653 const char *trace_event_format(struct trace_iterator *iter, const char *fmt);
654 void trace_check_vprintf(struct trace_iterator *iter, const char *fmt,
655 va_list ap) __printf(2, 0);
656 char *trace_iter_expand_format(struct trace_iterator *iter);
657
658 int trace_empty(struct trace_iterator *iter);
659
660 void *trace_find_next_entry_inc(struct trace_iterator *iter);
661
662 void trace_init_global_iter(struct trace_iterator *iter);
663
664 void tracing_iter_reset(struct trace_iterator *iter, int cpu);
665
666 unsigned long trace_total_entries_cpu(struct trace_array *tr, int cpu);
667 unsigned long trace_total_entries(struct trace_array *tr);
668
669 void trace_function(struct trace_array *tr,
670 unsigned long ip,
671 unsigned long parent_ip,
672 unsigned int trace_ctx);
673 void trace_graph_function(struct trace_array *tr,
674 unsigned long ip,
675 unsigned long parent_ip,
676 unsigned int trace_ctx);
677 void trace_latency_header(struct seq_file *m);
678 void trace_default_header(struct seq_file *m);
679 void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
680
681 void trace_graph_return(struct ftrace_graph_ret *trace);
682 int trace_graph_entry(struct ftrace_graph_ent *trace);
683 void set_graph_array(struct trace_array *tr);
684
685 void tracing_start_cmdline_record(void);
686 void tracing_stop_cmdline_record(void);
687 void tracing_start_tgid_record(void);
688 void tracing_stop_tgid_record(void);
689
690 int register_tracer(struct tracer *type);
691 int is_tracing_stopped(void);
692
693 loff_t tracing_lseek(struct file *file, loff_t offset, int whence);
694
695 extern cpumask_var_t __read_mostly tracing_buffer_mask;
696
697 #define for_each_tracing_cpu(cpu) \
698 for_each_cpu(cpu, tracing_buffer_mask)
699
700 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
701
702 extern unsigned long tracing_thresh;
703
704 /* PID filtering */
705
706 extern int pid_max;
707
708 bool trace_find_filtered_pid(struct trace_pid_list *filtered_pids,
709 pid_t search_pid);
710 bool trace_ignore_this_task(struct trace_pid_list *filtered_pids,
711 struct trace_pid_list *filtered_no_pids,
712 struct task_struct *task);
713 void trace_filter_add_remove_task(struct trace_pid_list *pid_list,
714 struct task_struct *self,
715 struct task_struct *task);
716 void *trace_pid_next(struct trace_pid_list *pid_list, void *v, loff_t *pos);
717 void *trace_pid_start(struct trace_pid_list *pid_list, loff_t *pos);
718 int trace_pid_show(struct seq_file *m, void *v);
719 int trace_pid_write(struct trace_pid_list *filtered_pids,
720 struct trace_pid_list **new_pid_list,
721 const char __user *ubuf, size_t cnt);
722
723 #ifdef CONFIG_TRACER_MAX_TRACE
724 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu,
725 void *cond_data);
726 void update_max_tr_single(struct trace_array *tr,
727 struct task_struct *tsk, int cpu);
728
729 #ifdef CONFIG_FSNOTIFY
730 #define LATENCY_FS_NOTIFY
731 #endif
732 #endif /* CONFIG_TRACER_MAX_TRACE */
733
734 #ifdef LATENCY_FS_NOTIFY
735 void latency_fsnotify(struct trace_array *tr);
736 #else
latency_fsnotify(struct trace_array * tr)737 static inline void latency_fsnotify(struct trace_array *tr) { }
738 #endif
739
740 #ifdef CONFIG_STACKTRACE
741 void __trace_stack(struct trace_array *tr, unsigned int trace_ctx, int skip);
742 #else
__trace_stack(struct trace_array * tr,unsigned int trace_ctx,int skip)743 static inline void __trace_stack(struct trace_array *tr, unsigned int trace_ctx,
744 int skip)
745 {
746 }
747 #endif /* CONFIG_STACKTRACE */
748
749 void trace_last_func_repeats(struct trace_array *tr,
750 struct trace_func_repeats *last_info,
751 unsigned int trace_ctx);
752
753 extern u64 ftrace_now(int cpu);
754
755 extern void trace_find_cmdline(int pid, char comm[]);
756 extern int trace_find_tgid(int pid);
757 extern void trace_event_follow_fork(struct trace_array *tr, bool enable);
758
759 #ifdef CONFIG_DYNAMIC_FTRACE
760 extern unsigned long ftrace_update_tot_cnt;
761 extern unsigned long ftrace_number_of_pages;
762 extern unsigned long ftrace_number_of_groups;
763 void ftrace_init_trace_array(struct trace_array *tr);
764 #else
ftrace_init_trace_array(struct trace_array * tr)765 static inline void ftrace_init_trace_array(struct trace_array *tr) { }
766 #endif
767 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
768 extern int DYN_FTRACE_TEST_NAME(void);
769 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
770 extern int DYN_FTRACE_TEST_NAME2(void);
771
772 extern void trace_set_ring_buffer_expanded(struct trace_array *tr);
773 extern bool tracing_selftest_disabled;
774
775 #ifdef CONFIG_FTRACE_STARTUP_TEST
776 extern void __init disable_tracing_selftest(const char *reason);
777
778 extern int trace_selftest_startup_function(struct tracer *trace,
779 struct trace_array *tr);
780 extern int trace_selftest_startup_function_graph(struct tracer *trace,
781 struct trace_array *tr);
782 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
783 struct trace_array *tr);
784 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
785 struct trace_array *tr);
786 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
787 struct trace_array *tr);
788 extern int trace_selftest_startup_wakeup(struct tracer *trace,
789 struct trace_array *tr);
790 extern int trace_selftest_startup_nop(struct tracer *trace,
791 struct trace_array *tr);
792 extern int trace_selftest_startup_branch(struct tracer *trace,
793 struct trace_array *tr);
794 /*
795 * Tracer data references selftest functions that only occur
796 * on boot up. These can be __init functions. Thus, when selftests
797 * are enabled, then the tracers need to reference __init functions.
798 */
799 #define __tracer_data __refdata
800 #else
disable_tracing_selftest(const char * reason)801 static inline void __init disable_tracing_selftest(const char *reason)
802 {
803 }
804 /* Tracers are seldom changed. Optimize when selftests are disabled. */
805 #define __tracer_data __read_mostly
806 #endif /* CONFIG_FTRACE_STARTUP_TEST */
807
808 extern void *head_page(struct trace_array_cpu *data);
809 extern unsigned long long ns2usecs(u64 nsec);
810 extern int
811 trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
812 extern int
813 trace_vprintk(unsigned long ip, const char *fmt, va_list args);
814 extern int
815 trace_array_vprintk(struct trace_array *tr,
816 unsigned long ip, const char *fmt, va_list args);
817 int trace_array_printk_buf(struct trace_buffer *buffer,
818 unsigned long ip, const char *fmt, ...);
819 void trace_printk_seq(struct trace_seq *s);
820 enum print_line_t print_trace_line(struct trace_iterator *iter);
821
822 extern char trace_find_mark(unsigned long long duration);
823
824 struct ftrace_hash;
825
826 struct ftrace_mod_load {
827 struct list_head list;
828 char *func;
829 char *module;
830 int enable;
831 };
832
833 enum {
834 FTRACE_HASH_FL_MOD = (1 << 0),
835 };
836
837 struct ftrace_hash {
838 unsigned long size_bits;
839 struct hlist_head *buckets;
840 unsigned long count;
841 unsigned long flags;
842 struct rcu_head rcu;
843 };
844
845 struct ftrace_func_entry *
846 ftrace_lookup_ip(struct ftrace_hash *hash, unsigned long ip);
847
ftrace_hash_empty(struct ftrace_hash * hash)848 static __always_inline bool ftrace_hash_empty(struct ftrace_hash *hash)
849 {
850 return !hash || !(hash->count || (hash->flags & FTRACE_HASH_FL_MOD));
851 }
852
853 /* Standard output formatting function used for function return traces */
854 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
855
856 /* Flag options */
857 #define TRACE_GRAPH_PRINT_OVERRUN 0x1
858 #define TRACE_GRAPH_PRINT_CPU 0x2
859 #define TRACE_GRAPH_PRINT_OVERHEAD 0x4
860 #define TRACE_GRAPH_PRINT_PROC 0x8
861 #define TRACE_GRAPH_PRINT_DURATION 0x10
862 #define TRACE_GRAPH_PRINT_ABS_TIME 0x20
863 #define TRACE_GRAPH_PRINT_REL_TIME 0x40
864 #define TRACE_GRAPH_PRINT_IRQS 0x80
865 #define TRACE_GRAPH_PRINT_TAIL 0x100
866 #define TRACE_GRAPH_SLEEP_TIME 0x200
867 #define TRACE_GRAPH_GRAPH_TIME 0x400
868 #define TRACE_GRAPH_PRINT_RETVAL 0x800
869 #define TRACE_GRAPH_PRINT_RETVAL_HEX 0x1000
870 #define TRACE_GRAPH_PRINT_FILL_SHIFT 28
871 #define TRACE_GRAPH_PRINT_FILL_MASK (0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT)
872
873 extern void ftrace_graph_sleep_time_control(bool enable);
874
875 #ifdef CONFIG_FUNCTION_PROFILER
876 extern void ftrace_graph_graph_time_control(bool enable);
877 #else
ftrace_graph_graph_time_control(bool enable)878 static inline void ftrace_graph_graph_time_control(bool enable) { }
879 #endif
880
881 extern enum print_line_t
882 print_graph_function_flags(struct trace_iterator *iter, u32 flags);
883 extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
884 extern void
885 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
886 extern void graph_trace_open(struct trace_iterator *iter);
887 extern void graph_trace_close(struct trace_iterator *iter);
888 extern int __trace_graph_entry(struct trace_array *tr,
889 struct ftrace_graph_ent *trace,
890 unsigned int trace_ctx);
891 extern void __trace_graph_return(struct trace_array *tr,
892 struct ftrace_graph_ret *trace,
893 unsigned int trace_ctx);
894
895 #ifdef CONFIG_DYNAMIC_FTRACE
896 extern struct ftrace_hash __rcu *ftrace_graph_hash;
897 extern struct ftrace_hash __rcu *ftrace_graph_notrace_hash;
898
ftrace_graph_addr(struct ftrace_graph_ent * trace)899 static inline int ftrace_graph_addr(struct ftrace_graph_ent *trace)
900 {
901 unsigned long addr = trace->func;
902 int ret = 0;
903 struct ftrace_hash *hash;
904
905 preempt_disable_notrace();
906
907 /*
908 * Have to open code "rcu_dereference_sched()" because the
909 * function graph tracer can be called when RCU is not
910 * "watching".
911 * Protected with schedule_on_each_cpu(ftrace_sync)
912 */
913 hash = rcu_dereference_protected(ftrace_graph_hash, !preemptible());
914
915 if (ftrace_hash_empty(hash)) {
916 ret = 1;
917 goto out;
918 }
919
920 if (ftrace_lookup_ip(hash, addr)) {
921
922 /*
923 * This needs to be cleared on the return functions
924 * when the depth is zero.
925 */
926 trace_recursion_set(TRACE_GRAPH_BIT);
927 trace_recursion_set_depth(trace->depth);
928
929 /*
930 * If no irqs are to be traced, but a set_graph_function
931 * is set, and called by an interrupt handler, we still
932 * want to trace it.
933 */
934 if (in_hardirq())
935 trace_recursion_set(TRACE_IRQ_BIT);
936 else
937 trace_recursion_clear(TRACE_IRQ_BIT);
938 ret = 1;
939 }
940
941 out:
942 preempt_enable_notrace();
943 return ret;
944 }
945
ftrace_graph_addr_finish(struct ftrace_graph_ret * trace)946 static inline void ftrace_graph_addr_finish(struct ftrace_graph_ret *trace)
947 {
948 if (trace_recursion_test(TRACE_GRAPH_BIT) &&
949 trace->depth == trace_recursion_depth())
950 trace_recursion_clear(TRACE_GRAPH_BIT);
951 }
952
ftrace_graph_notrace_addr(unsigned long addr)953 static inline int ftrace_graph_notrace_addr(unsigned long addr)
954 {
955 int ret = 0;
956 struct ftrace_hash *notrace_hash;
957
958 preempt_disable_notrace();
959
960 /*
961 * Have to open code "rcu_dereference_sched()" because the
962 * function graph tracer can be called when RCU is not
963 * "watching".
964 * Protected with schedule_on_each_cpu(ftrace_sync)
965 */
966 notrace_hash = rcu_dereference_protected(ftrace_graph_notrace_hash,
967 !preemptible());
968
969 if (ftrace_lookup_ip(notrace_hash, addr))
970 ret = 1;
971
972 preempt_enable_notrace();
973 return ret;
974 }
975 #else
ftrace_graph_addr(struct ftrace_graph_ent * trace)976 static inline int ftrace_graph_addr(struct ftrace_graph_ent *trace)
977 {
978 return 1;
979 }
980
ftrace_graph_notrace_addr(unsigned long addr)981 static inline int ftrace_graph_notrace_addr(unsigned long addr)
982 {
983 return 0;
984 }
ftrace_graph_addr_finish(struct ftrace_graph_ret * trace)985 static inline void ftrace_graph_addr_finish(struct ftrace_graph_ret *trace)
986 { }
987 #endif /* CONFIG_DYNAMIC_FTRACE */
988
989 extern unsigned int fgraph_max_depth;
990
ftrace_graph_ignore_func(struct ftrace_graph_ent * trace)991 static inline bool ftrace_graph_ignore_func(struct ftrace_graph_ent *trace)
992 {
993 /* trace it when it is-nested-in or is a function enabled. */
994 return !(trace_recursion_test(TRACE_GRAPH_BIT) ||
995 ftrace_graph_addr(trace)) ||
996 (trace->depth < 0) ||
997 (fgraph_max_depth && trace->depth >= fgraph_max_depth);
998 }
999
1000 #else /* CONFIG_FUNCTION_GRAPH_TRACER */
1001 static inline enum print_line_t
print_graph_function_flags(struct trace_iterator * iter,u32 flags)1002 print_graph_function_flags(struct trace_iterator *iter, u32 flags)
1003 {
1004 return TRACE_TYPE_UNHANDLED;
1005 }
1006 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
1007
1008 extern struct list_head ftrace_pids;
1009
1010 #ifdef CONFIG_FUNCTION_TRACER
1011
1012 #define FTRACE_PID_IGNORE -1
1013 #define FTRACE_PID_TRACE -2
1014
1015 struct ftrace_func_command {
1016 struct list_head list;
1017 char *name;
1018 int (*func)(struct trace_array *tr,
1019 struct ftrace_hash *hash,
1020 char *func, char *cmd,
1021 char *params, int enable);
1022 };
1023 extern bool ftrace_filter_param __initdata;
ftrace_trace_task(struct trace_array * tr)1024 static inline int ftrace_trace_task(struct trace_array *tr)
1025 {
1026 return this_cpu_read(tr->array_buffer.data->ftrace_ignore_pid) !=
1027 FTRACE_PID_IGNORE;
1028 }
1029 extern int ftrace_is_dead(void);
1030 int ftrace_create_function_files(struct trace_array *tr,
1031 struct dentry *parent);
1032 void ftrace_destroy_function_files(struct trace_array *tr);
1033 int ftrace_allocate_ftrace_ops(struct trace_array *tr);
1034 void ftrace_free_ftrace_ops(struct trace_array *tr);
1035 void ftrace_init_global_array_ops(struct trace_array *tr);
1036 void ftrace_init_array_ops(struct trace_array *tr, ftrace_func_t func);
1037 void ftrace_reset_array_ops(struct trace_array *tr);
1038 void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d_tracer);
1039 void ftrace_init_tracefs_toplevel(struct trace_array *tr,
1040 struct dentry *d_tracer);
1041 void ftrace_clear_pids(struct trace_array *tr);
1042 int init_function_trace(void);
1043 void ftrace_pid_follow_fork(struct trace_array *tr, bool enable);
1044 #else
ftrace_trace_task(struct trace_array * tr)1045 static inline int ftrace_trace_task(struct trace_array *tr)
1046 {
1047 return 1;
1048 }
ftrace_is_dead(void)1049 static inline int ftrace_is_dead(void) { return 0; }
1050 static inline int
ftrace_create_function_files(struct trace_array * tr,struct dentry * parent)1051 ftrace_create_function_files(struct trace_array *tr,
1052 struct dentry *parent)
1053 {
1054 return 0;
1055 }
ftrace_allocate_ftrace_ops(struct trace_array * tr)1056 static inline int ftrace_allocate_ftrace_ops(struct trace_array *tr)
1057 {
1058 return 0;
1059 }
ftrace_free_ftrace_ops(struct trace_array * tr)1060 static inline void ftrace_free_ftrace_ops(struct trace_array *tr) { }
ftrace_destroy_function_files(struct trace_array * tr)1061 static inline void ftrace_destroy_function_files(struct trace_array *tr) { }
1062 static inline __init void
ftrace_init_global_array_ops(struct trace_array * tr)1063 ftrace_init_global_array_ops(struct trace_array *tr) { }
ftrace_reset_array_ops(struct trace_array * tr)1064 static inline void ftrace_reset_array_ops(struct trace_array *tr) { }
ftrace_init_tracefs(struct trace_array * tr,struct dentry * d)1065 static inline void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d) { }
ftrace_init_tracefs_toplevel(struct trace_array * tr,struct dentry * d)1066 static inline void ftrace_init_tracefs_toplevel(struct trace_array *tr, struct dentry *d) { }
ftrace_clear_pids(struct trace_array * tr)1067 static inline void ftrace_clear_pids(struct trace_array *tr) { }
init_function_trace(void)1068 static inline int init_function_trace(void) { return 0; }
ftrace_pid_follow_fork(struct trace_array * tr,bool enable)1069 static inline void ftrace_pid_follow_fork(struct trace_array *tr, bool enable) { }
1070 /* ftace_func_t type is not defined, use macro instead of static inline */
1071 #define ftrace_init_array_ops(tr, func) do { } while (0)
1072 #endif /* CONFIG_FUNCTION_TRACER */
1073
1074 #if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE)
1075
1076 struct ftrace_probe_ops {
1077 void (*func)(unsigned long ip,
1078 unsigned long parent_ip,
1079 struct trace_array *tr,
1080 struct ftrace_probe_ops *ops,
1081 void *data);
1082 int (*init)(struct ftrace_probe_ops *ops,
1083 struct trace_array *tr,
1084 unsigned long ip, void *init_data,
1085 void **data);
1086 void (*free)(struct ftrace_probe_ops *ops,
1087 struct trace_array *tr,
1088 unsigned long ip, void *data);
1089 int (*print)(struct seq_file *m,
1090 unsigned long ip,
1091 struct ftrace_probe_ops *ops,
1092 void *data);
1093 };
1094
1095 struct ftrace_func_mapper;
1096 typedef int (*ftrace_mapper_func)(void *data);
1097
1098 struct ftrace_func_mapper *allocate_ftrace_func_mapper(void);
1099 void **ftrace_func_mapper_find_ip(struct ftrace_func_mapper *mapper,
1100 unsigned long ip);
1101 int ftrace_func_mapper_add_ip(struct ftrace_func_mapper *mapper,
1102 unsigned long ip, void *data);
1103 void *ftrace_func_mapper_remove_ip(struct ftrace_func_mapper *mapper,
1104 unsigned long ip);
1105 void free_ftrace_func_mapper(struct ftrace_func_mapper *mapper,
1106 ftrace_mapper_func free_func);
1107
1108 extern int
1109 register_ftrace_function_probe(char *glob, struct trace_array *tr,
1110 struct ftrace_probe_ops *ops, void *data);
1111 extern int
1112 unregister_ftrace_function_probe_func(char *glob, struct trace_array *tr,
1113 struct ftrace_probe_ops *ops);
1114 extern void clear_ftrace_function_probes(struct trace_array *tr);
1115
1116 int register_ftrace_command(struct ftrace_func_command *cmd);
1117 int unregister_ftrace_command(struct ftrace_func_command *cmd);
1118
1119 void ftrace_create_filter_files(struct ftrace_ops *ops,
1120 struct dentry *parent);
1121 void ftrace_destroy_filter_files(struct ftrace_ops *ops);
1122
1123 extern int ftrace_set_filter(struct ftrace_ops *ops, unsigned char *buf,
1124 int len, int reset);
1125 extern int ftrace_set_notrace(struct ftrace_ops *ops, unsigned char *buf,
1126 int len, int reset);
1127 #else
1128 struct ftrace_func_command;
1129
register_ftrace_command(struct ftrace_func_command * cmd)1130 static inline __init int register_ftrace_command(struct ftrace_func_command *cmd)
1131 {
1132 return -EINVAL;
1133 }
unregister_ftrace_command(char * cmd_name)1134 static inline __init int unregister_ftrace_command(char *cmd_name)
1135 {
1136 return -EINVAL;
1137 }
clear_ftrace_function_probes(struct trace_array * tr)1138 static inline void clear_ftrace_function_probes(struct trace_array *tr)
1139 {
1140 }
1141
1142 /*
1143 * The ops parameter passed in is usually undefined.
1144 * This must be a macro.
1145 */
1146 #define ftrace_create_filter_files(ops, parent) do { } while (0)
1147 #define ftrace_destroy_filter_files(ops) do { } while (0)
1148 #endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */
1149
1150 bool ftrace_event_is_function(struct trace_event_call *call);
1151
1152 /*
1153 * struct trace_parser - servers for reading the user input separated by spaces
1154 * @cont: set if the input is not complete - no final space char was found
1155 * @buffer: holds the parsed user input
1156 * @idx: user input length
1157 * @size: buffer size
1158 */
1159 struct trace_parser {
1160 bool cont;
1161 char *buffer;
1162 unsigned idx;
1163 unsigned size;
1164 };
1165
trace_parser_loaded(struct trace_parser * parser)1166 static inline bool trace_parser_loaded(struct trace_parser *parser)
1167 {
1168 return (parser->idx != 0);
1169 }
1170
trace_parser_cont(struct trace_parser * parser)1171 static inline bool trace_parser_cont(struct trace_parser *parser)
1172 {
1173 return parser->cont;
1174 }
1175
trace_parser_clear(struct trace_parser * parser)1176 static inline void trace_parser_clear(struct trace_parser *parser)
1177 {
1178 parser->cont = false;
1179 parser->idx = 0;
1180 }
1181
1182 extern int trace_parser_get_init(struct trace_parser *parser, int size);
1183 extern void trace_parser_put(struct trace_parser *parser);
1184 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
1185 size_t cnt, loff_t *ppos);
1186
1187 /*
1188 * Only create function graph options if function graph is configured.
1189 */
1190 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
1191 # define FGRAPH_FLAGS \
1192 C(DISPLAY_GRAPH, "display-graph"),
1193 #else
1194 # define FGRAPH_FLAGS
1195 #endif
1196
1197 #ifdef CONFIG_BRANCH_TRACER
1198 # define BRANCH_FLAGS \
1199 C(BRANCH, "branch"),
1200 #else
1201 # define BRANCH_FLAGS
1202 #endif
1203
1204 #ifdef CONFIG_FUNCTION_TRACER
1205 # define FUNCTION_FLAGS \
1206 C(FUNCTION, "function-trace"), \
1207 C(FUNC_FORK, "function-fork"),
1208 # define FUNCTION_DEFAULT_FLAGS TRACE_ITER_FUNCTION
1209 #else
1210 # define FUNCTION_FLAGS
1211 # define FUNCTION_DEFAULT_FLAGS 0UL
1212 # define TRACE_ITER_FUNC_FORK 0UL
1213 #endif
1214
1215 #ifdef CONFIG_STACKTRACE
1216 # define STACK_FLAGS \
1217 C(STACKTRACE, "stacktrace"),
1218 #else
1219 # define STACK_FLAGS
1220 #endif
1221
1222 /*
1223 * trace_iterator_flags is an enumeration that defines bit
1224 * positions into trace_flags that controls the output.
1225 *
1226 * NOTE: These bits must match the trace_options array in
1227 * trace.c (this macro guarantees it).
1228 */
1229 #define TRACE_FLAGS \
1230 C(PRINT_PARENT, "print-parent"), \
1231 C(SYM_OFFSET, "sym-offset"), \
1232 C(SYM_ADDR, "sym-addr"), \
1233 C(VERBOSE, "verbose"), \
1234 C(RAW, "raw"), \
1235 C(HEX, "hex"), \
1236 C(BIN, "bin"), \
1237 C(BLOCK, "block"), \
1238 C(FIELDS, "fields"), \
1239 C(PRINTK, "trace_printk"), \
1240 C(ANNOTATE, "annotate"), \
1241 C(USERSTACKTRACE, "userstacktrace"), \
1242 C(SYM_USEROBJ, "sym-userobj"), \
1243 C(PRINTK_MSGONLY, "printk-msg-only"), \
1244 C(CONTEXT_INFO, "context-info"), /* Print pid/cpu/time */ \
1245 C(LATENCY_FMT, "latency-format"), \
1246 C(RECORD_CMD, "record-cmd"), \
1247 C(RECORD_TGID, "record-tgid"), \
1248 C(OVERWRITE, "overwrite"), \
1249 C(STOP_ON_FREE, "disable_on_free"), \
1250 C(IRQ_INFO, "irq-info"), \
1251 C(MARKERS, "markers"), \
1252 C(EVENT_FORK, "event-fork"), \
1253 C(PAUSE_ON_TRACE, "pause-on-trace"), \
1254 C(HASH_PTR, "hash-ptr"), /* Print hashed pointer */ \
1255 FUNCTION_FLAGS \
1256 FGRAPH_FLAGS \
1257 STACK_FLAGS \
1258 BRANCH_FLAGS
1259
1260 /*
1261 * By defining C, we can make TRACE_FLAGS a list of bit names
1262 * that will define the bits for the flag masks.
1263 */
1264 #undef C
1265 #define C(a, b) TRACE_ITER_##a##_BIT
1266
1267 enum trace_iterator_bits {
1268 TRACE_FLAGS
1269 /* Make sure we don't go more than we have bits for */
1270 TRACE_ITER_LAST_BIT
1271 };
1272
1273 /*
1274 * By redefining C, we can make TRACE_FLAGS a list of masks that
1275 * use the bits as defined above.
1276 */
1277 #undef C
1278 #define C(a, b) TRACE_ITER_##a = (1 << TRACE_ITER_##a##_BIT)
1279
1280 enum trace_iterator_flags { TRACE_FLAGS };
1281
1282 /*
1283 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
1284 * control the output of kernel symbols.
1285 */
1286 #define TRACE_ITER_SYM_MASK \
1287 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
1288
1289 extern struct tracer nop_trace;
1290
1291 #ifdef CONFIG_BRANCH_TRACER
1292 extern int enable_branch_tracing(struct trace_array *tr);
1293 extern void disable_branch_tracing(void);
trace_branch_enable(struct trace_array * tr)1294 static inline int trace_branch_enable(struct trace_array *tr)
1295 {
1296 if (tr->trace_flags & TRACE_ITER_BRANCH)
1297 return enable_branch_tracing(tr);
1298 return 0;
1299 }
trace_branch_disable(void)1300 static inline void trace_branch_disable(void)
1301 {
1302 /* due to races, always disable */
1303 disable_branch_tracing();
1304 }
1305 #else
trace_branch_enable(struct trace_array * tr)1306 static inline int trace_branch_enable(struct trace_array *tr)
1307 {
1308 return 0;
1309 }
trace_branch_disable(void)1310 static inline void trace_branch_disable(void)
1311 {
1312 }
1313 #endif /* CONFIG_BRANCH_TRACER */
1314
1315 /* set ring buffers to default size if not already done so */
1316 int tracing_update_buffers(struct trace_array *tr);
1317
1318 union trace_synth_field {
1319 u8 as_u8;
1320 u16 as_u16;
1321 u32 as_u32;
1322 u64 as_u64;
1323 struct trace_dynamic_info as_dynamic;
1324 };
1325
1326 struct ftrace_event_field {
1327 struct list_head link;
1328 const char *name;
1329 const char *type;
1330 int filter_type;
1331 int offset;
1332 int size;
1333 int is_signed;
1334 int len;
1335 };
1336
1337 struct prog_entry;
1338
1339 struct event_filter {
1340 struct prog_entry __rcu *prog;
1341 char *filter_string;
1342 };
1343
1344 struct event_subsystem {
1345 struct list_head list;
1346 const char *name;
1347 struct event_filter *filter;
1348 int ref_count;
1349 };
1350
1351 struct trace_subsystem_dir {
1352 struct list_head list;
1353 struct event_subsystem *subsystem;
1354 struct trace_array *tr;
1355 struct eventfs_inode *ei;
1356 int ref_count;
1357 int nr_events;
1358 };
1359
1360 extern int call_filter_check_discard(struct trace_event_call *call, void *rec,
1361 struct trace_buffer *buffer,
1362 struct ring_buffer_event *event);
1363
1364 void trace_buffer_unlock_commit_regs(struct trace_array *tr,
1365 struct trace_buffer *buffer,
1366 struct ring_buffer_event *event,
1367 unsigned int trcace_ctx,
1368 struct pt_regs *regs);
1369
trace_buffer_unlock_commit(struct trace_array * tr,struct trace_buffer * buffer,struct ring_buffer_event * event,unsigned int trace_ctx)1370 static inline void trace_buffer_unlock_commit(struct trace_array *tr,
1371 struct trace_buffer *buffer,
1372 struct ring_buffer_event *event,
1373 unsigned int trace_ctx)
1374 {
1375 trace_buffer_unlock_commit_regs(tr, buffer, event, trace_ctx, NULL);
1376 }
1377
1378 DECLARE_PER_CPU(bool, trace_taskinfo_save);
1379 int trace_save_cmdline(struct task_struct *tsk);
1380 int trace_create_savedcmd(void);
1381 int trace_alloc_tgid_map(void);
1382 void trace_free_saved_cmdlines_buffer(void);
1383
1384 extern const struct file_operations tracing_saved_cmdlines_fops;
1385 extern const struct file_operations tracing_saved_tgids_fops;
1386 extern const struct file_operations tracing_saved_cmdlines_size_fops;
1387
1388 DECLARE_PER_CPU(struct ring_buffer_event *, trace_buffered_event);
1389 DECLARE_PER_CPU(int, trace_buffered_event_cnt);
1390 void trace_buffered_event_disable(void);
1391 void trace_buffered_event_enable(void);
1392
1393 void early_enable_events(struct trace_array *tr, char *buf, bool disable_first);
1394
1395 static inline void
__trace_event_discard_commit(struct trace_buffer * buffer,struct ring_buffer_event * event)1396 __trace_event_discard_commit(struct trace_buffer *buffer,
1397 struct ring_buffer_event *event)
1398 {
1399 if (this_cpu_read(trace_buffered_event) == event) {
1400 /* Simply release the temp buffer and enable preemption */
1401 this_cpu_dec(trace_buffered_event_cnt);
1402 preempt_enable_notrace();
1403 return;
1404 }
1405 /* ring_buffer_discard_commit() enables preemption */
1406 ring_buffer_discard_commit(buffer, event);
1407 }
1408
1409 /*
1410 * Helper function for event_trigger_unlock_commit{_regs}().
1411 * If there are event triggers attached to this event that requires
1412 * filtering against its fields, then they will be called as the
1413 * entry already holds the field information of the current event.
1414 *
1415 * It also checks if the event should be discarded or not.
1416 * It is to be discarded if the event is soft disabled and the
1417 * event was only recorded to process triggers, or if the event
1418 * filter is active and this event did not match the filters.
1419 *
1420 * Returns true if the event is discarded, false otherwise.
1421 */
1422 static inline bool
__event_trigger_test_discard(struct trace_event_file * file,struct trace_buffer * buffer,struct ring_buffer_event * event,void * entry,enum event_trigger_type * tt)1423 __event_trigger_test_discard(struct trace_event_file *file,
1424 struct trace_buffer *buffer,
1425 struct ring_buffer_event *event,
1426 void *entry,
1427 enum event_trigger_type *tt)
1428 {
1429 unsigned long eflags = file->flags;
1430
1431 if (eflags & EVENT_FILE_FL_TRIGGER_COND)
1432 *tt = event_triggers_call(file, buffer, entry, event);
1433
1434 if (likely(!(file->flags & (EVENT_FILE_FL_SOFT_DISABLED |
1435 EVENT_FILE_FL_FILTERED |
1436 EVENT_FILE_FL_PID_FILTER))))
1437 return false;
1438
1439 if (file->flags & EVENT_FILE_FL_SOFT_DISABLED)
1440 goto discard;
1441
1442 if (file->flags & EVENT_FILE_FL_FILTERED &&
1443 !filter_match_preds(file->filter, entry))
1444 goto discard;
1445
1446 if ((file->flags & EVENT_FILE_FL_PID_FILTER) &&
1447 trace_event_ignore_this_pid(file))
1448 goto discard;
1449
1450 return false;
1451 discard:
1452 __trace_event_discard_commit(buffer, event);
1453 return true;
1454 }
1455
1456 /**
1457 * event_trigger_unlock_commit - handle triggers and finish event commit
1458 * @file: The file pointer associated with the event
1459 * @buffer: The ring buffer that the event is being written to
1460 * @event: The event meta data in the ring buffer
1461 * @entry: The event itself
1462 * @trace_ctx: The tracing context flags.
1463 *
1464 * This is a helper function to handle triggers that require data
1465 * from the event itself. It also tests the event against filters and
1466 * if the event is soft disabled and should be discarded.
1467 */
1468 static inline void
event_trigger_unlock_commit(struct trace_event_file * file,struct trace_buffer * buffer,struct ring_buffer_event * event,void * entry,unsigned int trace_ctx)1469 event_trigger_unlock_commit(struct trace_event_file *file,
1470 struct trace_buffer *buffer,
1471 struct ring_buffer_event *event,
1472 void *entry, unsigned int trace_ctx)
1473 {
1474 enum event_trigger_type tt = ETT_NONE;
1475
1476 if (!__event_trigger_test_discard(file, buffer, event, entry, &tt))
1477 trace_buffer_unlock_commit(file->tr, buffer, event, trace_ctx);
1478
1479 if (tt)
1480 event_triggers_post_call(file, tt);
1481 }
1482
1483 #define FILTER_PRED_INVALID ((unsigned short)-1)
1484 #define FILTER_PRED_IS_RIGHT (1 << 15)
1485 #define FILTER_PRED_FOLD (1 << 15)
1486
1487 /*
1488 * The max preds is the size of unsigned short with
1489 * two flags at the MSBs. One bit is used for both the IS_RIGHT
1490 * and FOLD flags. The other is reserved.
1491 *
1492 * 2^14 preds is way more than enough.
1493 */
1494 #define MAX_FILTER_PRED 16384
1495
1496 struct filter_pred;
1497 struct regex;
1498
1499 typedef int (*regex_match_func)(char *str, struct regex *r, int len);
1500
1501 enum regex_type {
1502 MATCH_FULL = 0,
1503 MATCH_FRONT_ONLY,
1504 MATCH_MIDDLE_ONLY,
1505 MATCH_END_ONLY,
1506 MATCH_GLOB,
1507 MATCH_INDEX,
1508 };
1509
1510 struct regex {
1511 char pattern[MAX_FILTER_STR_VAL];
1512 int len;
1513 int field_len;
1514 regex_match_func match;
1515 };
1516
is_string_field(struct ftrace_event_field * field)1517 static inline bool is_string_field(struct ftrace_event_field *field)
1518 {
1519 return field->filter_type == FILTER_DYN_STRING ||
1520 field->filter_type == FILTER_RDYN_STRING ||
1521 field->filter_type == FILTER_STATIC_STRING ||
1522 field->filter_type == FILTER_PTR_STRING ||
1523 field->filter_type == FILTER_COMM;
1524 }
1525
is_function_field(struct ftrace_event_field * field)1526 static inline bool is_function_field(struct ftrace_event_field *field)
1527 {
1528 return field->filter_type == FILTER_TRACE_FN;
1529 }
1530
1531 extern enum regex_type
1532 filter_parse_regex(char *buff, int len, char **search, int *not);
1533 extern void print_event_filter(struct trace_event_file *file,
1534 struct trace_seq *s);
1535 extern int apply_event_filter(struct trace_event_file *file,
1536 char *filter_string);
1537 extern int apply_subsystem_event_filter(struct trace_subsystem_dir *dir,
1538 char *filter_string);
1539 extern void print_subsystem_event_filter(struct event_subsystem *system,
1540 struct trace_seq *s);
1541 extern int filter_assign_type(const char *type);
1542 extern int create_event_filter(struct trace_array *tr,
1543 struct trace_event_call *call,
1544 char *filter_str, bool set_str,
1545 struct event_filter **filterp);
1546 extern void free_event_filter(struct event_filter *filter);
1547
1548 struct ftrace_event_field *
1549 trace_find_event_field(struct trace_event_call *call, char *name);
1550
1551 extern void trace_event_enable_cmd_record(bool enable);
1552 extern void trace_event_enable_tgid_record(bool enable);
1553
1554 extern int event_trace_init(void);
1555 extern int init_events(void);
1556 extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr);
1557 extern int event_trace_del_tracer(struct trace_array *tr);
1558 extern void __trace_early_add_events(struct trace_array *tr);
1559
1560 extern struct trace_event_file *__find_event_file(struct trace_array *tr,
1561 const char *system,
1562 const char *event);
1563 extern struct trace_event_file *find_event_file(struct trace_array *tr,
1564 const char *system,
1565 const char *event);
1566
event_file_data(struct file * filp)1567 static inline void *event_file_data(struct file *filp)
1568 {
1569 return READ_ONCE(file_inode(filp)->i_private);
1570 }
1571
1572 extern struct mutex event_mutex;
1573 extern struct list_head ftrace_events;
1574
1575 extern const struct file_operations event_trigger_fops;
1576 extern const struct file_operations event_hist_fops;
1577 extern const struct file_operations event_hist_debug_fops;
1578 extern const struct file_operations event_inject_fops;
1579
1580 #ifdef CONFIG_HIST_TRIGGERS
1581 extern int register_trigger_hist_cmd(void);
1582 extern int register_trigger_hist_enable_disable_cmds(void);
1583 #else
register_trigger_hist_cmd(void)1584 static inline int register_trigger_hist_cmd(void) { return 0; }
register_trigger_hist_enable_disable_cmds(void)1585 static inline int register_trigger_hist_enable_disable_cmds(void) { return 0; }
1586 #endif
1587
1588 extern int register_trigger_cmds(void);
1589 extern void clear_event_triggers(struct trace_array *tr);
1590
1591 enum {
1592 EVENT_TRIGGER_FL_PROBE = BIT(0),
1593 };
1594
1595 struct event_trigger_data {
1596 unsigned long count;
1597 int ref;
1598 int flags;
1599 struct event_trigger_ops *ops;
1600 struct event_command *cmd_ops;
1601 struct event_filter __rcu *filter;
1602 char *filter_str;
1603 void *private_data;
1604 bool paused;
1605 bool paused_tmp;
1606 struct list_head list;
1607 char *name;
1608 struct list_head named_list;
1609 struct event_trigger_data *named_data;
1610 };
1611
1612 /* Avoid typos */
1613 #define ENABLE_EVENT_STR "enable_event"
1614 #define DISABLE_EVENT_STR "disable_event"
1615 #define ENABLE_HIST_STR "enable_hist"
1616 #define DISABLE_HIST_STR "disable_hist"
1617
1618 struct enable_trigger_data {
1619 struct trace_event_file *file;
1620 bool enable;
1621 bool hist;
1622 };
1623
1624 extern int event_enable_trigger_print(struct seq_file *m,
1625 struct event_trigger_data *data);
1626 extern void event_enable_trigger_free(struct event_trigger_data *data);
1627 extern int event_enable_trigger_parse(struct event_command *cmd_ops,
1628 struct trace_event_file *file,
1629 char *glob, char *cmd,
1630 char *param_and_filter);
1631 extern int event_enable_register_trigger(char *glob,
1632 struct event_trigger_data *data,
1633 struct trace_event_file *file);
1634 extern void event_enable_unregister_trigger(char *glob,
1635 struct event_trigger_data *test,
1636 struct trace_event_file *file);
1637 extern void trigger_data_free(struct event_trigger_data *data);
1638 extern int event_trigger_init(struct event_trigger_data *data);
1639 extern int trace_event_trigger_enable_disable(struct trace_event_file *file,
1640 int trigger_enable);
1641 extern void update_cond_flag(struct trace_event_file *file);
1642 extern int set_trigger_filter(char *filter_str,
1643 struct event_trigger_data *trigger_data,
1644 struct trace_event_file *file);
1645 extern struct event_trigger_data *find_named_trigger(const char *name);
1646 extern bool is_named_trigger(struct event_trigger_data *test);
1647 extern int save_named_trigger(const char *name,
1648 struct event_trigger_data *data);
1649 extern void del_named_trigger(struct event_trigger_data *data);
1650 extern void pause_named_trigger(struct event_trigger_data *data);
1651 extern void unpause_named_trigger(struct event_trigger_data *data);
1652 extern void set_named_trigger_data(struct event_trigger_data *data,
1653 struct event_trigger_data *named_data);
1654 extern struct event_trigger_data *
1655 get_named_trigger_data(struct event_trigger_data *data);
1656 extern int register_event_command(struct event_command *cmd);
1657 extern int unregister_event_command(struct event_command *cmd);
1658 extern int register_trigger_hist_enable_disable_cmds(void);
1659 extern bool event_trigger_check_remove(const char *glob);
1660 extern bool event_trigger_empty_param(const char *param);
1661 extern int event_trigger_separate_filter(char *param_and_filter, char **param,
1662 char **filter, bool param_required);
1663 extern struct event_trigger_data *
1664 event_trigger_alloc(struct event_command *cmd_ops,
1665 char *cmd,
1666 char *param,
1667 void *private_data);
1668 extern int event_trigger_parse_num(char *trigger,
1669 struct event_trigger_data *trigger_data);
1670 extern int event_trigger_set_filter(struct event_command *cmd_ops,
1671 struct trace_event_file *file,
1672 char *param,
1673 struct event_trigger_data *trigger_data);
1674 extern void event_trigger_reset_filter(struct event_command *cmd_ops,
1675 struct event_trigger_data *trigger_data);
1676 extern int event_trigger_register(struct event_command *cmd_ops,
1677 struct trace_event_file *file,
1678 char *glob,
1679 struct event_trigger_data *trigger_data);
1680 extern void event_trigger_unregister(struct event_command *cmd_ops,
1681 struct trace_event_file *file,
1682 char *glob,
1683 struct event_trigger_data *trigger_data);
1684
1685 extern void event_file_get(struct trace_event_file *file);
1686 extern void event_file_put(struct trace_event_file *file);
1687
1688 /**
1689 * struct event_trigger_ops - callbacks for trace event triggers
1690 *
1691 * The methods in this structure provide per-event trigger hooks for
1692 * various trigger operations.
1693 *
1694 * The @init and @free methods are used during trigger setup and
1695 * teardown, typically called from an event_command's @parse()
1696 * function implementation.
1697 *
1698 * The @print method is used to print the trigger spec.
1699 *
1700 * The @trigger method is the function that actually implements the
1701 * trigger and is called in the context of the triggering event
1702 * whenever that event occurs.
1703 *
1704 * All the methods below, except for @init() and @free(), must be
1705 * implemented.
1706 *
1707 * @trigger: The trigger 'probe' function called when the triggering
1708 * event occurs. The data passed into this callback is the data
1709 * that was supplied to the event_command @reg() function that
1710 * registered the trigger (see struct event_command) along with
1711 * the trace record, rec.
1712 *
1713 * @init: An optional initialization function called for the trigger
1714 * when the trigger is registered (via the event_command reg()
1715 * function). This can be used to perform per-trigger
1716 * initialization such as incrementing a per-trigger reference
1717 * count, for instance. This is usually implemented by the
1718 * generic utility function @event_trigger_init() (see
1719 * trace_event_triggers.c).
1720 *
1721 * @free: An optional de-initialization function called for the
1722 * trigger when the trigger is unregistered (via the
1723 * event_command @reg() function). This can be used to perform
1724 * per-trigger de-initialization such as decrementing a
1725 * per-trigger reference count and freeing corresponding trigger
1726 * data, for instance. This is usually implemented by the
1727 * generic utility function @event_trigger_free() (see
1728 * trace_event_triggers.c).
1729 *
1730 * @print: The callback function invoked to have the trigger print
1731 * itself. This is usually implemented by a wrapper function
1732 * that calls the generic utility function @event_trigger_print()
1733 * (see trace_event_triggers.c).
1734 */
1735 struct event_trigger_ops {
1736 void (*trigger)(struct event_trigger_data *data,
1737 struct trace_buffer *buffer,
1738 void *rec,
1739 struct ring_buffer_event *rbe);
1740 int (*init)(struct event_trigger_data *data);
1741 void (*free)(struct event_trigger_data *data);
1742 int (*print)(struct seq_file *m,
1743 struct event_trigger_data *data);
1744 };
1745
1746 /**
1747 * struct event_command - callbacks and data members for event commands
1748 *
1749 * Event commands are invoked by users by writing the command name
1750 * into the 'trigger' file associated with a trace event. The
1751 * parameters associated with a specific invocation of an event
1752 * command are used to create an event trigger instance, which is
1753 * added to the list of trigger instances associated with that trace
1754 * event. When the event is hit, the set of triggers associated with
1755 * that event is invoked.
1756 *
1757 * The data members in this structure provide per-event command data
1758 * for various event commands.
1759 *
1760 * All the data members below, except for @post_trigger, must be set
1761 * for each event command.
1762 *
1763 * @name: The unique name that identifies the event command. This is
1764 * the name used when setting triggers via trigger files.
1765 *
1766 * @trigger_type: A unique id that identifies the event command
1767 * 'type'. This value has two purposes, the first to ensure that
1768 * only one trigger of the same type can be set at a given time
1769 * for a particular event e.g. it doesn't make sense to have both
1770 * a traceon and traceoff trigger attached to a single event at
1771 * the same time, so traceon and traceoff have the same type
1772 * though they have different names. The @trigger_type value is
1773 * also used as a bit value for deferring the actual trigger
1774 * action until after the current event is finished. Some
1775 * commands need to do this if they themselves log to the trace
1776 * buffer (see the @post_trigger() member below). @trigger_type
1777 * values are defined by adding new values to the trigger_type
1778 * enum in include/linux/trace_events.h.
1779 *
1780 * @flags: See the enum event_command_flags below.
1781 *
1782 * All the methods below, except for @set_filter() and @unreg_all(),
1783 * must be implemented.
1784 *
1785 * @parse: The callback function responsible for parsing and
1786 * registering the trigger written to the 'trigger' file by the
1787 * user. It allocates the trigger instance and registers it with
1788 * the appropriate trace event. It makes use of the other
1789 * event_command callback functions to orchestrate this, and is
1790 * usually implemented by the generic utility function
1791 * @event_trigger_callback() (see trace_event_triggers.c).
1792 *
1793 * @reg: Adds the trigger to the list of triggers associated with the
1794 * event, and enables the event trigger itself, after
1795 * initializing it (via the event_trigger_ops @init() function).
1796 * This is also where commands can use the @trigger_type value to
1797 * make the decision as to whether or not multiple instances of
1798 * the trigger should be allowed. This is usually implemented by
1799 * the generic utility function @register_trigger() (see
1800 * trace_event_triggers.c).
1801 *
1802 * @unreg: Removes the trigger from the list of triggers associated
1803 * with the event, and disables the event trigger itself, after
1804 * initializing it (via the event_trigger_ops @free() function).
1805 * This is usually implemented by the generic utility function
1806 * @unregister_trigger() (see trace_event_triggers.c).
1807 *
1808 * @unreg_all: An optional function called to remove all the triggers
1809 * from the list of triggers associated with the event. Called
1810 * when a trigger file is opened in truncate mode.
1811 *
1812 * @set_filter: An optional function called to parse and set a filter
1813 * for the trigger. If no @set_filter() method is set for the
1814 * event command, filters set by the user for the command will be
1815 * ignored. This is usually implemented by the generic utility
1816 * function @set_trigger_filter() (see trace_event_triggers.c).
1817 *
1818 * @get_trigger_ops: The callback function invoked to retrieve the
1819 * event_trigger_ops implementation associated with the command.
1820 * This callback function allows a single event_command to
1821 * support multiple trigger implementations via different sets of
1822 * event_trigger_ops, depending on the value of the @param
1823 * string.
1824 */
1825 struct event_command {
1826 struct list_head list;
1827 char *name;
1828 enum event_trigger_type trigger_type;
1829 int flags;
1830 int (*parse)(struct event_command *cmd_ops,
1831 struct trace_event_file *file,
1832 char *glob, char *cmd,
1833 char *param_and_filter);
1834 int (*reg)(char *glob,
1835 struct event_trigger_data *data,
1836 struct trace_event_file *file);
1837 void (*unreg)(char *glob,
1838 struct event_trigger_data *data,
1839 struct trace_event_file *file);
1840 void (*unreg_all)(struct trace_event_file *file);
1841 int (*set_filter)(char *filter_str,
1842 struct event_trigger_data *data,
1843 struct trace_event_file *file);
1844 struct event_trigger_ops *(*get_trigger_ops)(char *cmd, char *param);
1845 };
1846
1847 /**
1848 * enum event_command_flags - flags for struct event_command
1849 *
1850 * @POST_TRIGGER: A flag that says whether or not this command needs
1851 * to have its action delayed until after the current event has
1852 * been closed. Some triggers need to avoid being invoked while
1853 * an event is currently in the process of being logged, since
1854 * the trigger may itself log data into the trace buffer. Thus
1855 * we make sure the current event is committed before invoking
1856 * those triggers. To do that, the trigger invocation is split
1857 * in two - the first part checks the filter using the current
1858 * trace record; if a command has the @post_trigger flag set, it
1859 * sets a bit for itself in the return value, otherwise it
1860 * directly invokes the trigger. Once all commands have been
1861 * either invoked or set their return flag, the current record is
1862 * either committed or discarded. At that point, if any commands
1863 * have deferred their triggers, those commands are finally
1864 * invoked following the close of the current event. In other
1865 * words, if the event_trigger_ops @func() probe implementation
1866 * itself logs to the trace buffer, this flag should be set,
1867 * otherwise it can be left unspecified.
1868 *
1869 * @NEEDS_REC: A flag that says whether or not this command needs
1870 * access to the trace record in order to perform its function,
1871 * regardless of whether or not it has a filter associated with
1872 * it (filters make a trigger require access to the trace record
1873 * but are not always present).
1874 */
1875 enum event_command_flags {
1876 EVENT_CMD_FL_POST_TRIGGER = 1,
1877 EVENT_CMD_FL_NEEDS_REC = 2,
1878 };
1879
event_command_post_trigger(struct event_command * cmd_ops)1880 static inline bool event_command_post_trigger(struct event_command *cmd_ops)
1881 {
1882 return cmd_ops->flags & EVENT_CMD_FL_POST_TRIGGER;
1883 }
1884
event_command_needs_rec(struct event_command * cmd_ops)1885 static inline bool event_command_needs_rec(struct event_command *cmd_ops)
1886 {
1887 return cmd_ops->flags & EVENT_CMD_FL_NEEDS_REC;
1888 }
1889
1890 extern int trace_event_enable_disable(struct trace_event_file *file,
1891 int enable, int soft_disable);
1892 extern int tracing_alloc_snapshot(void);
1893 extern void tracing_snapshot_cond(struct trace_array *tr, void *cond_data);
1894 extern int tracing_snapshot_cond_enable(struct trace_array *tr, void *cond_data, cond_update_fn_t update);
1895
1896 extern int tracing_snapshot_cond_disable(struct trace_array *tr);
1897 extern void *tracing_cond_snapshot_data(struct trace_array *tr);
1898
1899 extern const char *__start___trace_bprintk_fmt[];
1900 extern const char *__stop___trace_bprintk_fmt[];
1901
1902 extern const char *__start___tracepoint_str[];
1903 extern const char *__stop___tracepoint_str[];
1904
1905 void trace_printk_control(bool enabled);
1906 void trace_printk_start_comm(void);
1907 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set);
1908 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled);
1909
1910 /* Used from boot time tracer */
1911 extern int trace_set_options(struct trace_array *tr, char *option);
1912 extern int tracing_set_tracer(struct trace_array *tr, const char *buf);
1913 extern ssize_t tracing_resize_ring_buffer(struct trace_array *tr,
1914 unsigned long size, int cpu_id);
1915 extern int tracing_set_cpumask(struct trace_array *tr,
1916 cpumask_var_t tracing_cpumask_new);
1917
1918
1919 #define MAX_EVENT_NAME_LEN 64
1920
1921 extern ssize_t trace_parse_run_command(struct file *file,
1922 const char __user *buffer, size_t count, loff_t *ppos,
1923 int (*createfn)(const char *));
1924
1925 extern unsigned int err_pos(char *cmd, const char *str);
1926 extern void tracing_log_err(struct trace_array *tr,
1927 const char *loc, const char *cmd,
1928 const char **errs, u8 type, u16 pos);
1929
1930 /*
1931 * Normal trace_printk() and friends allocates special buffers
1932 * to do the manipulation, as well as saves the print formats
1933 * into sections to display. But the trace infrastructure wants
1934 * to use these without the added overhead at the price of being
1935 * a bit slower (used mainly for warnings, where we don't care
1936 * about performance). The internal_trace_puts() is for such
1937 * a purpose.
1938 */
1939 #define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
1940
1941 #undef FTRACE_ENTRY
1942 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print) \
1943 extern struct trace_event_call \
1944 __aligned(4) event_##call;
1945 #undef FTRACE_ENTRY_DUP
1946 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print) \
1947 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
1948 #undef FTRACE_ENTRY_PACKED
1949 #define FTRACE_ENTRY_PACKED(call, struct_name, id, tstruct, print) \
1950 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print))
1951
1952 #include "trace_entries.h"
1953
1954 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
1955 int perf_ftrace_event_register(struct trace_event_call *call,
1956 enum trace_reg type, void *data);
1957 #else
1958 #define perf_ftrace_event_register NULL
1959 #endif
1960
1961 #ifdef CONFIG_FTRACE_SYSCALLS
1962 void init_ftrace_syscalls(void);
1963 const char *get_syscall_name(int syscall);
1964 #else
init_ftrace_syscalls(void)1965 static inline void init_ftrace_syscalls(void) { }
get_syscall_name(int syscall)1966 static inline const char *get_syscall_name(int syscall)
1967 {
1968 return NULL;
1969 }
1970 #endif
1971
1972 #ifdef CONFIG_EVENT_TRACING
1973 void trace_event_init(void);
1974 void trace_event_eval_update(struct trace_eval_map **map, int len);
1975 /* Used from boot time tracer */
1976 extern int ftrace_set_clr_event(struct trace_array *tr, char *buf, int set);
1977 extern int trigger_process_regex(struct trace_event_file *file, char *buff);
1978 #else
trace_event_init(void)1979 static inline void __init trace_event_init(void) { }
trace_event_eval_update(struct trace_eval_map ** map,int len)1980 static inline void trace_event_eval_update(struct trace_eval_map **map, int len) { }
1981 #endif
1982
1983 #ifdef CONFIG_TRACER_SNAPSHOT
1984 void tracing_snapshot_instance(struct trace_array *tr);
1985 int tracing_alloc_snapshot_instance(struct trace_array *tr);
1986 int tracing_arm_snapshot(struct trace_array *tr);
1987 void tracing_disarm_snapshot(struct trace_array *tr);
1988 #else
tracing_snapshot_instance(struct trace_array * tr)1989 static inline void tracing_snapshot_instance(struct trace_array *tr) { }
tracing_alloc_snapshot_instance(struct trace_array * tr)1990 static inline int tracing_alloc_snapshot_instance(struct trace_array *tr)
1991 {
1992 return 0;
1993 }
tracing_arm_snapshot(struct trace_array * tr)1994 static inline int tracing_arm_snapshot(struct trace_array *tr) { return 0; }
tracing_disarm_snapshot(struct trace_array * tr)1995 static inline void tracing_disarm_snapshot(struct trace_array *tr) { }
1996 #endif
1997
1998 #ifdef CONFIG_PREEMPT_TRACER
1999 void tracer_preempt_on(unsigned long a0, unsigned long a1);
2000 void tracer_preempt_off(unsigned long a0, unsigned long a1);
2001 #else
tracer_preempt_on(unsigned long a0,unsigned long a1)2002 static inline void tracer_preempt_on(unsigned long a0, unsigned long a1) { }
tracer_preempt_off(unsigned long a0,unsigned long a1)2003 static inline void tracer_preempt_off(unsigned long a0, unsigned long a1) { }
2004 #endif
2005 #ifdef CONFIG_IRQSOFF_TRACER
2006 void tracer_hardirqs_on(unsigned long a0, unsigned long a1);
2007 void tracer_hardirqs_off(unsigned long a0, unsigned long a1);
2008 #else
tracer_hardirqs_on(unsigned long a0,unsigned long a1)2009 static inline void tracer_hardirqs_on(unsigned long a0, unsigned long a1) { }
tracer_hardirqs_off(unsigned long a0,unsigned long a1)2010 static inline void tracer_hardirqs_off(unsigned long a0, unsigned long a1) { }
2011 #endif
2012
2013 /*
2014 * Reset the state of the trace_iterator so that it can read consumed data.
2015 * Normally, the trace_iterator is used for reading the data when it is not
2016 * consumed, and must retain state.
2017 */
trace_iterator_reset(struct trace_iterator * iter)2018 static __always_inline void trace_iterator_reset(struct trace_iterator *iter)
2019 {
2020 memset_startat(iter, 0, seq);
2021 iter->pos = -1;
2022 }
2023
2024 /* Check the name is good for event/group/fields */
__is_good_name(const char * name,bool hash_ok)2025 static inline bool __is_good_name(const char *name, bool hash_ok)
2026 {
2027 if (!isalpha(*name) && *name != '_' && (!hash_ok || *name != '-'))
2028 return false;
2029 while (*++name != '\0') {
2030 if (!isalpha(*name) && !isdigit(*name) && *name != '_' &&
2031 (!hash_ok || *name != '-'))
2032 return false;
2033 }
2034 return true;
2035 }
2036
2037 /* Check the name is good for event/group/fields */
is_good_name(const char * name)2038 static inline bool is_good_name(const char *name)
2039 {
2040 return __is_good_name(name, false);
2041 }
2042
2043 /* Check the name is good for system */
is_good_system_name(const char * name)2044 static inline bool is_good_system_name(const char *name)
2045 {
2046 return __is_good_name(name, true);
2047 }
2048
2049 /* Convert certain expected symbols into '_' when generating event names */
sanitize_event_name(char * name)2050 static inline void sanitize_event_name(char *name)
2051 {
2052 while (*name++ != '\0')
2053 if (*name == ':' || *name == '.')
2054 *name = '_';
2055 }
2056
2057 /*
2058 * This is a generic way to read and write a u64 value from a file in tracefs.
2059 *
2060 * The value is stored on the variable pointed by *val. The value needs
2061 * to be at least *min and at most *max. The write is protected by an
2062 * existing *lock.
2063 */
2064 struct trace_min_max_param {
2065 struct mutex *lock;
2066 u64 *val;
2067 u64 *min;
2068 u64 *max;
2069 };
2070
2071 #define U64_STR_SIZE 24 /* 20 digits max */
2072
2073 extern const struct file_operations trace_min_max_fops;
2074
2075 #ifdef CONFIG_RV
2076 extern int rv_init_interface(void);
2077 #else
rv_init_interface(void)2078 static inline int rv_init_interface(void)
2079 {
2080 return 0;
2081 }
2082 #endif
2083
2084 #endif /* _LINUX_KERNEL_TRACE_H */
2085