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