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

source code of linux/kernel/trace/trace.h