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