blob: 0f915c264c19183256ace1d9482a2fb274e8710e [file] [log] [blame]
Tom Zanussibac5fb92013-10-24 08:59:29 -05001
Steven Rostedtbc0c38d2008-05-12 21:20:42 +02002#ifndef _LINUX_KERNEL_TRACE_H
3#define _LINUX_KERNEL_TRACE_H
4
5#include <linux/fs.h>
Arun Sharma600634972011-07-26 16:09:06 -07006#include <linux/atomic.h>
Steven Rostedtbc0c38d2008-05-12 21:20:42 +02007#include <linux/sched.h>
8#include <linux/clocksource.h>
Steven Rostedt3928a8a2008-09-29 23:02:41 -04009#include <linux/ring_buffer.h>
Pekka Paalanenbd8ac682008-05-12 21:20:57 +020010#include <linux/mmiotrace.h>
Steven Rostedt4e5292e2009-09-12 19:26:21 -040011#include <linux/tracepoint.h>
Frédéric Weisbeckerd13744c2008-09-23 11:32:08 +010012#include <linux/ftrace.h>
Frederic Weisbecker24f1e32c2009-09-09 19:22:48 +020013#include <linux/hw_breakpoint.h>
Steven Rostedt95045042009-04-11 12:59:57 -040014#include <linux/trace_seq.h>
Steven Rostedt (Red Hat)af658dc2015-04-29 14:36:05 -040015#include <linux/trace_events.h>
Gideon Israel Dsouza52f5684c2014-04-07 15:39:20 -070016#include <linux/compiler.h>
Steven Rostedt (Red Hat)19a7fe22014-11-12 10:29:54 -050017#include <linux/trace_seq.h>
Masami Hiramatsu60f1d5e2016-10-05 20:58:15 +090018#include <linux/glob.h>
Steven Rostedt95045042009-04-11 12:59:57 -040019
Steven Rostedt12ab74e2012-08-08 14:48:20 -040020#ifdef CONFIG_FTRACE_SYSCALLS
21#include <asm/unistd.h> /* For NR_SYSCALLS */
22#include <asm/syscall.h> /* some archs define it here */
23#endif
24
Thomas Gleixner72829bc2008-05-23 21:37:28 +020025enum trace_type {
26 __TRACE_FIRST_TYPE = 0,
27
28 TRACE_FN,
29 TRACE_CTX,
30 TRACE_WAKE,
31 TRACE_STACK,
Steven Rostedtdd0e5452008-08-01 12:26:41 -040032 TRACE_PRINT,
Frederic Weisbecker48ead022009-03-12 18:24:49 +010033 TRACE_BPRINT,
Pekka Paalanenbd8ac682008-05-12 21:20:57 +020034 TRACE_MMIO_RW,
35 TRACE_MMIO_MAP,
Steven Rostedt9f029e82008-11-12 15:24:24 -050036 TRACE_BRANCH,
Frederic Weisbecker287b6e62008-11-26 00:57:25 +010037 TRACE_GRAPH_RET,
38 TRACE_GRAPH_ENT,
Török Edwin02b67512008-11-22 13:28:47 +020039 TRACE_USER_STACK,
Arnaldo Carvalho de Meloc71a8962009-01-23 12:06:27 -020040 TRACE_BLK,
Steven Rostedt (Red Hat)09ae7232013-03-08 21:02:34 -050041 TRACE_BPUTS,
Steven Rostedt (Red Hat)e7c15cd2016-06-23 12:45:36 -040042 TRACE_HWLAT,
Steven Rostedtfa32e852016-07-06 15:25:08 -040043 TRACE_RAW_DATA,
Thomas Gleixner72829bc2008-05-23 21:37:28 +020044
Steven Rostedtf0868d12008-12-23 23:24:12 -050045 __TRACE_LAST_TYPE,
Thomas Gleixner72829bc2008-05-23 21:37:28 +020046};
47
Frederic Weisbecker36994e52008-12-29 13:42:23 -080048
Steven Rostedt0a1c49d2009-09-12 19:17:15 -040049#undef __field
50#define __field(type, item) type item;
Frederic Weisbecker36994e52008-12-29 13:42:23 -080051
Steven Rostedtd7315092009-09-12 19:22:23 -040052#undef __field_struct
53#define __field_struct(type, item) __field(type, item)
54
55#undef __field_desc
56#define __field_desc(type, container, item)
57
Steven Rostedt0a1c49d2009-09-12 19:17:15 -040058#undef __array
59#define __array(type, item, size) type item[size];
60
Steven Rostedtd7315092009-09-12 19:22:23 -040061#undef __array_desc
62#define __array_desc(type, container, item, size)
63
Steven Rostedt0a1c49d2009-09-12 19:17:15 -040064#undef __dynamic_array
65#define __dynamic_array(type, item) type item[];
66
67#undef F_STRUCT
68#define F_STRUCT(args...) args
69
70#undef FTRACE_ENTRY
Jiri Olsa02aa3162012-02-15 15:51:53 +010071#define FTRACE_ENTRY(name, struct_name, id, tstruct, print, filter) \
72 struct struct_name { \
73 struct trace_entry ent; \
74 tstruct \
Steven Rostedt0a1c49d2009-09-12 19:17:15 -040075 }
76
Steven Rostedt0a1c49d2009-09-12 19:17:15 -040077#undef FTRACE_ENTRY_DUP
Jiri Olsa02aa3162012-02-15 15:51:53 +010078#define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk, filter)
Steven Rostedt0a1c49d2009-09-12 19:17:15 -040079
Jiri Olsae59a0bf2012-02-15 15:51:51 +010080#undef FTRACE_ENTRY_REG
Jiri Olsa02aa3162012-02-15 15:51:53 +010081#define FTRACE_ENTRY_REG(name, struct_name, id, tstruct, print, \
82 filter, regfn) \
83 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print), \
84 filter)
Jiri Olsae59a0bf2012-02-15 15:51:51 +010085
Namhyung Kima4a551b2016-06-29 19:56:48 +090086#undef FTRACE_ENTRY_PACKED
87#define FTRACE_ENTRY_PACKED(name, struct_name, id, tstruct, print, \
88 filter) \
89 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print), \
90 filter) __packed
91
Steven Rostedt0a1c49d2009-09-12 19:17:15 -040092#include "trace_entries.h"
93
94/*
95 * syscalls are special, and need special handling, this is why
96 * they are not included in trace_entries.h
97 */
Frederic Weisbeckerbed1ffc2009-03-13 15:42:11 +010098struct syscall_trace_enter {
99 struct trace_entry ent;
100 int nr;
101 unsigned long args[];
102};
103
104struct syscall_trace_exit {
105 struct trace_entry ent;
106 int nr;
Tom Zanussi99df5a62009-11-25 01:14:59 -0600107 long ret;
Frederic Weisbeckerbed1ffc2009-03-13 15:42:11 +0100108};
109
Masami Hiramatsu93ccae72010-04-12 13:17:08 -0400110struct kprobe_trace_entry_head {
Masami Hiramatsu413d37d2009-08-13 16:35:11 -0400111 struct trace_entry ent;
112 unsigned long ip;
Masami Hiramatsu413d37d2009-08-13 16:35:11 -0400113};
114
Masami Hiramatsu93ccae72010-04-12 13:17:08 -0400115struct kretprobe_trace_entry_head {
Masami Hiramatsu413d37d2009-08-13 16:35:11 -0400116 struct trace_entry ent;
117 unsigned long func;
118 unsigned long ret_ip;
Masami Hiramatsu413d37d2009-08-13 16:35:11 -0400119};
120
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400121/*
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300122 * trace_flag_type is an enumeration that holds different
123 * states when a trace occurs. These are:
Steven Rostedt92444892008-10-24 09:42:59 -0400124 * IRQS_OFF - interrupts were disabled
Ingo Molnar9de36822009-03-06 17:52:03 +0100125 * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
Li Zefanbd9cfca2009-09-10 09:34:19 +0800126 * NEED_RESCHED - reschedule is requested
Steven Rostedt92444892008-10-24 09:42:59 -0400127 * HARDIRQ - inside an interrupt handler
128 * SOFTIRQ - inside a softirq handler
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300129 */
130enum trace_flag_type {
131 TRACE_FLAG_IRQS_OFF = 0x01,
Steven Rostedt92444892008-10-24 09:42:59 -0400132 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
133 TRACE_FLAG_NEED_RESCHED = 0x04,
134 TRACE_FLAG_HARDIRQ = 0x08,
135 TRACE_FLAG_SOFTIRQ = 0x10,
Peter Zijlstrae5137b52013-10-04 17:28:26 +0200136 TRACE_FLAG_PREEMPT_RESCHED = 0x20,
Peter Zijlstra7e6867b2016-03-18 16:28:04 +0100137 TRACE_FLAG_NMI = 0x40,
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300138};
139
Pekka Paalanen5bf9a1e2008-09-16 22:06:42 +0300140#define TRACE_BUF_SIZE 1024
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200141
Steven Rostedt2b6080f2012-05-11 13:29:49 -0400142struct trace_array;
143
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200144/*
145 * The CPU trace array - it consists of thousands of trace entries
146 * plus some other descriptor data: (for example which task started
147 * the trace, etc.)
148 */
149struct trace_array_cpu {
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200150 atomic_t disabled;
Steven Rostedt2cadf912008-12-01 22:20:19 -0500151 void *buffer_page; /* ring buffer spare */
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200152
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -0800153 unsigned long entries;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200154 unsigned long saved_latency;
155 unsigned long critical_start;
156 unsigned long critical_end;
157 unsigned long critical_sequence;
158 unsigned long nice;
159 unsigned long policy;
160 unsigned long rt_priority;
Steven Rostedt2f26ebd2009-09-01 11:06:29 -0400161 unsigned long skipped_entries;
Thomas Gleixnera5a1d1c2016-12-21 20:32:01 +0100162 u64 preempt_timestamp;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200163 pid_t pid;
Eric W. Biedermand20b92a2012-03-13 16:02:19 -0700164 kuid_t uid;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200165 char comm[TASK_COMM_LEN];
Steven Rostedt (Red Hat)3fdaf802015-09-25 12:58:44 -0400166
167 bool ignore_pid;
Steven Rostedt (Red Hat)345ddcc2016-04-22 18:11:33 -0400168#ifdef CONFIG_FUNCTION_TRACER
169 bool ftrace_ignore_pid;
170#endif
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200171};
172
Steven Rostedt2b6080f2012-05-11 13:29:49 -0400173struct tracer;
Steven Rostedt (Red Hat)37aea982015-09-30 14:27:31 -0400174struct trace_option_dentry;
Steven Rostedt2b6080f2012-05-11 13:29:49 -0400175
Steven Rostedt (Red Hat)12883ef2013-03-05 09:24:35 -0500176struct trace_buffer {
177 struct trace_array *tr;
178 struct ring_buffer *buffer;
179 struct trace_array_cpu __percpu *data;
Thomas Gleixnera5a1d1c2016-12-21 20:32:01 +0100180 u64 time_start;
Steven Rostedt (Red Hat)12883ef2013-03-05 09:24:35 -0500181 int cpu;
182};
183
Steven Rostedt (Red Hat)9a38a882015-09-30 11:11:15 -0400184#define TRACE_FLAGS_MAX_SIZE 32
185
Steven Rostedt (Red Hat)37aea982015-09-30 14:27:31 -0400186struct trace_options {
187 struct tracer *tracer;
188 struct trace_option_dentry *topts;
189};
190
Steven Rostedt (Red Hat)49090102015-09-24 11:33:26 -0400191struct trace_pid_list {
Steven Rostedtf4d34a82016-04-13 16:27:49 -0400192 int pid_max;
193 unsigned long *pids;
Steven Rostedt (Red Hat)49090102015-09-24 11:33:26 -0400194};
195
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200196/*
197 * The trace array - an array of per-CPU trace arrays. This is the
198 * highest level data structure that individual tracers deal with.
199 * They have on/off state as well:
200 */
201struct trace_array {
Steven Rostedtae63b31e2012-05-03 23:09:03 -0400202 struct list_head list;
Steven Rostedt277ba042012-08-03 16:10:49 -0400203 char *name;
Steven Rostedt (Red Hat)12883ef2013-03-05 09:24:35 -0500204 struct trace_buffer trace_buffer;
205#ifdef CONFIG_TRACER_MAX_TRACE
206 /*
207 * The max_buffer is used to snapshot the trace when a maximum
208 * latency is reached, or when the user initiates a snapshot.
209 * Some tracers will use this to store a maximum trace while
210 * it continues examining live traces.
211 *
212 * The buffers for the max_buffer are set up the same as the trace_buffer
213 * When a snapshot is taken, the buffer of the max_buffer is swapped
214 * with the buffer of the trace_buffer and the buffers are reset for
215 * the trace_buffer so the tracing can continue.
216 */
217 struct trace_buffer max_buffer;
Steven Rostedt (Red Hat)45ad21c2013-03-05 18:25:02 -0500218 bool allocated_snapshot;
Steven Rostedt (Red Hat)f971cc92016-09-07 12:45:09 -0400219#endif
220#if defined(CONFIG_TRACER_MAX_TRACE) || defined(CONFIG_HWLAT_TRACER)
Steven Rostedt (Red Hat)6d9b3fa2014-01-14 11:28:38 -0500221 unsigned long max_latency;
Steven Rostedt (Red Hat)12883ef2013-03-05 09:24:35 -0500222#endif
Steven Rostedt (Red Hat)49090102015-09-24 11:33:26 -0400223 struct trace_pid_list __rcu *filtered_pids;
Steven Rostedt (Red Hat)0b9b12c2014-01-14 10:04:59 -0500224 /*
225 * max_lock is used to protect the swapping of buffers
226 * when taking a max snapshot. The buffers themselves are
227 * protected by per_cpu spinlocks. But the action of the swap
228 * needs its own lock.
229 *
230 * This is defined as a arch_spinlock_t in order to help
231 * with performance when lockdep debugging is enabled.
232 *
233 * It is also used in other places outside the update_max_tr
234 * so it needs to be defined outside of the
235 * CONFIG_TRACER_MAX_TRACE.
236 */
237 arch_spinlock_t max_lock;
Steven Rostedt499e5472012-02-22 15:50:28 -0500238 int buffer_disabled;
Steven Rostedt12ab74e2012-08-08 14:48:20 -0400239#ifdef CONFIG_FTRACE_SYSCALLS
240 int sys_refcount_enter;
241 int sys_refcount_exit;
Steven Rostedt (Red Hat)7f1d2f82015-05-05 10:09:53 -0400242 struct trace_event_file __rcu *enter_syscall_files[NR_syscalls];
243 struct trace_event_file __rcu *exit_syscall_files[NR_syscalls];
Steven Rostedt12ab74e2012-08-08 14:48:20 -0400244#endif
Steven Rostedt2b6080f2012-05-11 13:29:49 -0400245 int stop_count;
246 int clock_id;
Steven Rostedt (Red Hat)37aea982015-09-30 14:27:31 -0400247 int nr_topts;
Steven Rostedt2b6080f2012-05-11 13:29:49 -0400248 struct tracer *current_trace;
Steven Rostedt (Red Hat)983f9382015-09-30 09:42:05 -0400249 unsigned int trace_flags;
Steven Rostedt (Red Hat)9a38a882015-09-30 11:11:15 -0400250 unsigned char trace_flags_index[TRACE_FLAGS_MAX_SIZE];
Steven Rostedtae63b31e2012-05-03 23:09:03 -0400251 unsigned int flags;
Steven Rostedt2b6080f2012-05-11 13:29:49 -0400252 raw_spinlock_t start_lock;
Steven Rostedtae63b31e2012-05-03 23:09:03 -0400253 struct dentry *dir;
Steven Rostedt2b6080f2012-05-11 13:29:49 -0400254 struct dentry *options;
255 struct dentry *percpu_dir;
Steven Rostedtae63b31e2012-05-03 23:09:03 -0400256 struct dentry *event_dir;
Steven Rostedt (Red Hat)37aea982015-09-30 14:27:31 -0400257 struct trace_options *topts;
Steven Rostedtae63b31e2012-05-03 23:09:03 -0400258 struct list_head systems;
259 struct list_head events;
Alexander Z Lamccfe9e42013-08-08 09:47:45 -0700260 cpumask_var_t tracing_cpumask; /* only trace on set CPUs */
Steven Rostedt (Red Hat)a695cb52013-03-06 15:27:24 -0500261 int ref;
Steven Rostedt (Red Hat)f20a5802013-11-07 20:08:58 -0500262#ifdef CONFIG_FUNCTION_TRACER
263 struct ftrace_ops *ops;
Steven Rostedt (Red Hat)345ddcc2016-04-22 18:11:33 -0400264 struct trace_pid_list __rcu *function_pids;
Steven Rostedt (Red Hat)f20a5802013-11-07 20:08:58 -0500265 /* function tracing enabled */
266 int function_enabled;
267#endif
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200268};
269
Steven Rostedtae63b31e2012-05-03 23:09:03 -0400270enum {
271 TRACE_ARRAY_FL_GLOBAL = (1 << 0)
272};
273
274extern struct list_head ftrace_trace_arrays;
275
Alexander Z Lama8227412013-07-01 19:37:54 -0700276extern struct mutex trace_types_lock;
277
Steven Rostedt (Red Hat)8e2e2fa2013-07-02 15:30:53 -0400278extern int trace_array_get(struct trace_array *tr);
279extern void trace_array_put(struct trace_array *tr);
280
Steven Rostedtae63b31e2012-05-03 23:09:03 -0400281/*
282 * The global tracer (top) should be the first trace array added,
283 * but we check the flag anyway.
284 */
285static inline struct trace_array *top_trace_array(void)
286{
287 struct trace_array *tr;
288
Steven Rostedt (Red Hat)da9c3412014-06-10 13:53:50 -0400289 if (list_empty(&ftrace_trace_arrays))
Yoshihiro YUNOMAEdc81e5e2014-06-06 07:35:17 +0900290 return NULL;
291
Steven Rostedtae63b31e2012-05-03 23:09:03 -0400292 tr = list_entry(ftrace_trace_arrays.prev,
293 typeof(*tr), list);
294 WARN_ON(!(tr->flags & TRACE_ARRAY_FL_GLOBAL));
295 return tr;
296}
297
Steven Rostedt7104f302008-10-01 10:52:51 -0400298#define FTRACE_CMP_TYPE(var, type) \
299 __builtin_types_compatible_p(typeof(var), type *)
300
301#undef IF_ASSIGN
302#define IF_ASSIGN(var, entry, etype, id) \
303 if (FTRACE_CMP_TYPE(var, etype)) { \
304 var = (typeof(var))(entry); \
305 WARN_ON(id && (entry)->type != id); \
306 break; \
307 }
308
309/* Will cause compile errors if type is not found. */
310extern void __ftrace_bad_type(void);
311
312/*
313 * The trace_assign_type is a verifier that the entry type is
314 * the same as the type being assigned. To add new types simply
315 * add a line with the following format:
316 *
317 * IF_ASSIGN(var, ent, type, id);
318 *
319 * Where "type" is the trace type that includes the trace_entry
320 * as the "ent" item. And "id" is the trace identifier that is
321 * used in the trace_type enum.
322 *
323 * If the type can have more than one id, then use zero.
324 */
325#define trace_assign_type(var, ent) \
326 do { \
327 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
328 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
Steven Rostedt7104f302008-10-01 10:52:51 -0400329 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
Török Edwin02b67512008-11-22 13:28:47 +0200330 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
Steven Rostedt7104f302008-10-01 10:52:51 -0400331 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100332 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
Steven Rostedt (Red Hat)09ae7232013-03-08 21:02:34 -0500333 IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS); \
Steven Rostedt (Red Hat)e7c15cd2016-06-23 12:45:36 -0400334 IF_ASSIGN(var, ent, struct hwlat_entry, TRACE_HWLAT); \
Steven Rostedtfa32e852016-07-06 15:25:08 -0400335 IF_ASSIGN(var, ent, struct raw_data_entry, TRACE_RAW_DATA);\
Steven Rostedt7104f302008-10-01 10:52:51 -0400336 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
337 TRACE_MMIO_RW); \
338 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
339 TRACE_MMIO_MAP); \
Steven Rostedt9f029e82008-11-12 15:24:24 -0500340 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
Frederic Weisbecker287b6e62008-11-26 00:57:25 +0100341 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
342 TRACE_GRAPH_ENT); \
343 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
344 TRACE_GRAPH_RET); \
Steven Rostedt7104f302008-10-01 10:52:51 -0400345 __ftrace_bad_type(); \
346 } while (0)
Frederic Weisbecker2c4f0352008-09-29 20:18:34 +0200347
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100348/*
349 * An option specific to a tracer. This is a boolean value.
350 * The bit is the bit index that sets its value on the
351 * flags value in struct tracer_flags.
352 */
353struct tracer_opt {
Ingo Molnar9de36822009-03-06 17:52:03 +0100354 const char *name; /* Will appear on the trace_options file */
355 u32 bit; /* Mask assigned in val field in tracer_flags */
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100356};
357
358/*
359 * The set of specific options for a tracer. Your tracer
360 * have to set the initial value of the flags val.
361 */
362struct tracer_flags {
363 u32 val;
Ingo Molnar9de36822009-03-06 17:52:03 +0100364 struct tracer_opt *opts;
Chunyu Hud39cdd22016-03-08 21:37:01 +0800365 struct tracer *trace;
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100366};
367
368/* Makes more easy to define a tracer opt */
369#define TRACER_OPT(s, b) .name = #s, .bit = b
370
Frederic Weisbecker034939b2009-01-08 10:03:56 -0800371
Steven Rostedt (Red Hat)41d9c0b2015-09-29 17:31:55 -0400372struct trace_option_dentry {
373 struct tracer_opt *opt;
374 struct tracer_flags *flags;
375 struct trace_array *tr;
376 struct dentry *entry;
377};
378
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100379/**
Steven Rostedt (Red Hat)8434dc92015-01-20 12:13:40 -0500380 * struct tracer - a specific tracer and its callbacks to interact with tracefs
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100381 * @name: the name chosen to select it on the available_tracers file
382 * @init: called when one switches to this tracer (echo name > current_tracer)
383 * @reset: called when one switches to another tracer
Chuyu Hu05a724b2015-12-22 09:44:33 -0500384 * @start: called when tracing is unpaused (echo 1 > tracing_on)
385 * @stop: called when tracing is paused (echo 0 > tracing_on)
Stanislav Fomichev6508fa72014-07-18 15:17:27 +0400386 * @update_thresh: called when tracing_thresh is updated
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100387 * @open: called when the trace file is opened
388 * @pipe_open: called when the trace_pipe file is opened
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100389 * @close: called when the trace file is released
Steven Rostedtc521efd2009-12-07 09:06:24 -0500390 * @pipe_close: called when the trace_pipe file is released
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100391 * @read: override the default read callback on trace_pipe
392 * @splice_read: override the default splice_read callback on trace_pipe
393 * @selftest: selftest to run on boot (see trace_selftest.c)
394 * @print_headers: override the first lines that describe your columns
395 * @print_line: callback that prints a trace
396 * @set_flag: signals one of your private flags changed (trace_options file)
397 * @flags: your private flags
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200398 */
399struct tracer {
400 const char *name;
Frederic Weisbecker1c800252008-11-16 05:57:26 +0100401 int (*init)(struct trace_array *tr);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200402 void (*reset)(struct trace_array *tr);
Steven Rostedt90369902008-11-05 16:05:44 -0500403 void (*start)(struct trace_array *tr);
404 void (*stop)(struct trace_array *tr);
Stanislav Fomichev6508fa72014-07-18 15:17:27 +0400405 int (*update_thresh)(struct trace_array *tr);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200406 void (*open)(struct trace_iterator *iter);
Steven Rostedt107bad82008-05-12 21:21:01 +0200407 void (*pipe_open)(struct trace_iterator *iter);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200408 void (*close)(struct trace_iterator *iter);
Steven Rostedtc521efd2009-12-07 09:06:24 -0500409 void (*pipe_close)(struct trace_iterator *iter);
Steven Rostedt107bad82008-05-12 21:21:01 +0200410 ssize_t (*read)(struct trace_iterator *iter,
411 struct file *filp, char __user *ubuf,
412 size_t cnt, loff_t *ppos);
Eduard - Gabriel Munteanu3c568192009-02-09 08:15:56 +0200413 ssize_t (*splice_read)(struct trace_iterator *iter,
414 struct file *filp,
415 loff_t *ppos,
416 struct pipe_inode_info *pipe,
417 size_t len,
418 unsigned int flags);
Steven Rostedt60a11772008-05-12 21:20:44 +0200419#ifdef CONFIG_FTRACE_STARTUP_TEST
420 int (*selftest)(struct tracer *trace,
421 struct trace_array *tr);
422#endif
Markus Metzger8bba1bf2008-11-25 09:12:31 +0100423 void (*print_header)(struct seq_file *m);
Frederic Weisbecker2c4f0352008-09-29 20:18:34 +0200424 enum print_line_t (*print_line)(struct trace_iterator *iter);
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100425 /* If you handled the flag setting, return 0 */
Steven Rostedt (Red Hat)8c1a49a2014-01-10 11:13:54 -0500426 int (*set_flag)(struct trace_array *tr,
427 u32 old_flags, u32 bit, int set);
Steven Rostedt (Red Hat)613f04a2013-03-14 15:03:53 -0400428 /* Return 0 if OK with change, else return non-zero */
Steven Rostedt (Red Hat)bf6065b2014-01-10 17:51:01 -0500429 int (*flag_changed)(struct trace_array *tr,
Steven Rostedt (Red Hat)613f04a2013-03-14 15:03:53 -0400430 u32 mask, int set);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200431 struct tracer *next;
Ingo Molnar9de36822009-03-06 17:52:03 +0100432 struct tracer_flags *flags;
Steven Rostedt (Red Hat)50512ab2014-01-14 08:52:35 -0500433 int enabled;
Steven Rostedt (Red Hat)cf6ab6d2014-12-15 20:13:31 -0500434 int ref;
Hiraku Toyookaf43c7382012-10-02 17:27:10 +0900435 bool print_max;
Steven Rostedt (Red Hat)607e2ea2013-11-06 22:42:48 -0500436 bool allow_instances;
Steven Rostedt (Red Hat)12883ef2013-03-05 09:24:35 -0500437#ifdef CONFIG_TRACER_MAX_TRACE
Hiraku Toyookaf43c7382012-10-02 17:27:10 +0900438 bool use_max_tr;
Steven Rostedt (Red Hat)12883ef2013-03-05 09:24:35 -0500439#endif
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200440};
441
Steven Rostedtf9520752009-03-02 14:04:40 -0500442
Steven Rostedte4a3f542011-06-14 19:02:29 -0400443/* Only current can touch trace_recursion */
Steven Rostedte4a3f542011-06-14 19:02:29 -0400444
Steven Rostedtedc15ca2012-11-02 17:47:21 -0400445/*
446 * For function tracing recursion:
447 * The order of these bits are important.
448 *
449 * When function tracing occurs, the following steps are made:
450 * If arch does not support a ftrace feature:
451 * call internal function (uses INTERNAL bits) which calls...
452 * If callback is registered to the "global" list, the list
453 * function is called and recursion checks the GLOBAL bits.
454 * then this function calls...
455 * The function callback, which can use the FTRACE bits to
456 * check for recursion.
457 *
458 * Now if the arch does not suppport a feature, and it calls
459 * the global list function which calls the ftrace callback
460 * all three of these steps will do a recursion protection.
461 * There's no reason to do one if the previous caller already
462 * did. The recursion that we are protecting against will
463 * go through the same steps again.
464 *
465 * To prevent the multiple recursion checks, if a recursion
466 * bit is set that is higher than the MAX bit of the current
467 * check, then we know that the check was made by the previous
468 * caller, and we can skip the current check.
469 */
Steven Rostedte46cbf72012-11-02 17:32:25 -0400470enum {
Steven Rostedt567cd4d2012-11-02 18:33:05 -0400471 TRACE_BUFFER_BIT,
472 TRACE_BUFFER_NMI_BIT,
473 TRACE_BUFFER_IRQ_BIT,
474 TRACE_BUFFER_SIRQ_BIT,
475
476 /* Start of function recursion bits */
477 TRACE_FTRACE_BIT,
Steven Rostedtedc15ca2012-11-02 17:47:21 -0400478 TRACE_FTRACE_NMI_BIT,
479 TRACE_FTRACE_IRQ_BIT,
480 TRACE_FTRACE_SIRQ_BIT,
Steven Rostedte46cbf72012-11-02 17:32:25 -0400481
Steven Rostedt (Red Hat)4104d322014-01-10 17:01:58 -0500482 /* INTERNAL_BITs must be greater than FTRACE_BITs */
Steven Rostedtedc15ca2012-11-02 17:47:21 -0400483 TRACE_INTERNAL_BIT,
484 TRACE_INTERNAL_NMI_BIT,
485 TRACE_INTERNAL_IRQ_BIT,
486 TRACE_INTERNAL_SIRQ_BIT,
487
Steven Rostedt (Red Hat)6224beb2015-07-07 15:05:03 -0400488 TRACE_BRANCH_BIT,
Steven Rostedte4a3f542011-06-14 19:02:29 -0400489/*
490 * Abuse of the trace_recursion.
491 * As we need a way to maintain state if we are tracing the function
492 * graph in irq because we want to trace a particular function that
493 * was called in irq context but we have irq tracing off. Since this
494 * can only be modified by current, we can reuse trace_recursion.
495 */
Steven Rostedte46cbf72012-11-02 17:32:25 -0400496 TRACE_IRQ_BIT,
497};
Steven Rostedte4a3f542011-06-14 19:02:29 -0400498
Steven Rostedte46cbf72012-11-02 17:32:25 -0400499#define trace_recursion_set(bit) do { (current)->trace_recursion |= (1<<(bit)); } while (0)
500#define trace_recursion_clear(bit) do { (current)->trace_recursion &= ~(1<<(bit)); } while (0)
501#define trace_recursion_test(bit) ((current)->trace_recursion & (1<<(bit)))
Steven Rostedte4a3f542011-06-14 19:02:29 -0400502
Steven Rostedtedc15ca2012-11-02 17:47:21 -0400503#define TRACE_CONTEXT_BITS 4
504
505#define TRACE_FTRACE_START TRACE_FTRACE_BIT
506#define TRACE_FTRACE_MAX ((1 << (TRACE_FTRACE_START + TRACE_CONTEXT_BITS)) - 1)
507
Steven Rostedtedc15ca2012-11-02 17:47:21 -0400508#define TRACE_LIST_START TRACE_INTERNAL_BIT
509#define TRACE_LIST_MAX ((1 << (TRACE_LIST_START + TRACE_CONTEXT_BITS)) - 1)
510
511#define TRACE_CONTEXT_MASK TRACE_LIST_MAX
512
513static __always_inline int trace_get_context_bit(void)
514{
515 int bit;
516
517 if (in_interrupt()) {
518 if (in_nmi())
519 bit = 0;
520
521 else if (in_irq())
522 bit = 1;
523 else
524 bit = 2;
525 } else
526 bit = 3;
527
528 return bit;
529}
530
531static __always_inline int trace_test_and_set_recursion(int start, int max)
532{
533 unsigned int val = current->trace_recursion;
534 int bit;
535
536 /* A previous recursion check was made */
537 if ((val & TRACE_CONTEXT_MASK) > max)
538 return 0;
539
540 bit = trace_get_context_bit() + start;
541 if (unlikely(val & (1 << bit)))
542 return -1;
543
544 val |= 1 << bit;
545 current->trace_recursion = val;
546 barrier();
547
548 return bit;
549}
550
551static __always_inline void trace_clear_recursion(int bit)
552{
553 unsigned int val = current->trace_recursion;
554
555 if (!bit)
556 return;
557
558 bit = 1 << bit;
559 val &= ~bit;
560
561 barrier();
562 current->trace_recursion = val;
563}
564
Steven Rostedt6d158a82012-06-27 20:46:14 -0400565static inline struct ring_buffer_iter *
566trace_buffer_iter(struct trace_iterator *iter, int cpu)
567{
568 if (iter->buffer_iter && iter->buffer_iter[cpu])
569 return iter->buffer_iter[cpu];
570 return NULL;
571}
572
Arnaldo Carvalho de Melob6f11df2009-02-05 18:02:00 -0200573int tracer_init(struct tracer *t, struct trace_array *tr);
Steven Rostedt90369902008-11-05 16:05:44 -0500574int tracing_is_enabled(void);
Steven Rostedt (Red Hat)12883ef2013-03-05 09:24:35 -0500575void tracing_reset(struct trace_buffer *buf, int cpu);
576void tracing_reset_online_cpus(struct trace_buffer *buf);
Steven Rostedt9456f0f2009-05-06 21:54:09 -0400577void tracing_reset_current(int cpu);
Steven Rostedt (Red Hat)873c6422013-03-04 23:26:06 -0500578void tracing_reset_all_online_cpus(void);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200579int tracing_open_generic(struct inode *inode, struct file *filp);
Geyslan G. Bem2e864212013-10-18 21:15:54 -0300580bool tracing_is_disabled(void);
Steven Rostedt (Red Hat)e7c15cd2016-06-23 12:45:36 -0400581int tracer_tracing_is_on(struct trace_array *tr);
Frederic Weisbecker5452af62009-03-27 00:25:38 +0100582struct dentry *trace_create_file(const char *name,
Al Virof4ae40a2011-07-24 04:33:43 -0400583 umode_t mode,
Frederic Weisbecker5452af62009-03-27 00:25:38 +0100584 struct dentry *parent,
585 void *data,
586 const struct file_operations *fops);
587
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200588struct dentry *tracing_init_dentry(void);
Ingo Molnard618b3e2008-05-12 21:20:49 +0200589
Arnaldo Carvalho de Melo51a763d2009-02-05 16:14:13 -0200590struct ring_buffer_event;
591
Steven Rostedte77405a2009-09-02 14:17:06 -0400592struct ring_buffer_event *
593trace_buffer_lock_reserve(struct ring_buffer *buffer,
594 int type,
595 unsigned long len,
596 unsigned long flags,
597 int pc);
Arnaldo Carvalho de Melo51a763d2009-02-05 16:14:13 -0200598
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300599struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
600 struct trace_array_cpu *data);
Frederic Weisbeckerc4a8e8b2009-02-02 20:29:21 -0200601
602struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
603 int *ent_cpu, u64 *ent_ts);
604
Steven Rostedt (Red Hat)52ffabe32016-11-23 20:28:38 -0500605void trace_buffer_unlock_commit_nostack(struct ring_buffer *buffer,
606 struct ring_buffer_event *event);
Steven Rostedt7ffbd482012-10-11 12:14:25 -0400607
Jason Wessel955b61e2010-08-05 09:22:23 -0500608int trace_empty(struct trace_iterator *iter);
609
610void *trace_find_next_entry_inc(struct trace_iterator *iter);
611
612void trace_init_global_iter(struct trace_iterator *iter);
613
614void tracing_iter_reset(struct trace_iterator *iter, int cpu);
615
Steven Rostedt6fb44b72008-05-12 21:20:49 +0200616void trace_function(struct trace_array *tr,
Steven Rostedt6fb44b72008-05-12 21:20:49 +0200617 unsigned long ip,
618 unsigned long parent_ip,
Steven Rostedt38697052008-10-01 13:14:09 -0400619 unsigned long flags, int pc);
Jiri Olsa0a772622010-09-23 14:00:52 +0200620void trace_graph_function(struct trace_array *tr,
621 unsigned long ip,
622 unsigned long parent_ip,
623 unsigned long flags, int pc);
Jiri Olsa7e9a49e2011-11-07 16:08:49 +0100624void trace_latency_header(struct seq_file *m);
Jiri Olsa62b915f2010-04-02 19:01:22 +0200625void trace_default_header(struct seq_file *m);
626void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
627int trace_empty(struct trace_iterator *iter);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200628
Frederic Weisbecker287b6e62008-11-26 00:57:25 +0100629void trace_graph_return(struct ftrace_graph_ret *trace);
Steven Rostedte49dc192008-12-02 23:50:05 -0500630int trace_graph_entry(struct ftrace_graph_ent *trace);
Frederic Weisbecker1a0799a2009-07-29 18:59:58 +0200631void set_graph_array(struct trace_array *tr);
Markus Metzger1e9b51c2008-11-25 09:24:15 +0100632
Steven Rostedt41bc8142008-05-22 11:49:22 -0400633void tracing_start_cmdline_record(void);
634void tracing_stop_cmdline_record(void);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200635int register_tracer(struct tracer *type);
Carsten Emdeb5130b12009-09-13 01:43:07 +0200636int is_tracing_stopped(void);
Jason Wessel955b61e2010-08-05 09:22:23 -0500637
Steven Rostedt (Red Hat)098c8792013-12-21 17:39:40 -0500638loff_t tracing_lseek(struct file *file, loff_t offset, int whence);
639
Jason Wessel955b61e2010-08-05 09:22:23 -0500640extern cpumask_var_t __read_mostly tracing_buffer_mask;
641
642#define for_each_tracing_cpu(cpu) \
643 for_each_cpu(cpu, tracing_buffer_mask)
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200644
645extern unsigned long nsecs_to_usecs(unsigned long nsecs);
646
Tim Bird0e950172010-02-25 15:36:43 -0800647extern unsigned long tracing_thresh;
648
Steven Rostedt4e267db2016-04-14 07:38:13 -0400649/* PID filtering */
Steven Rostedt (Red Hat)76c813e2016-04-21 11:35:30 -0400650
651extern int pid_max;
652
Steven Rostedt4e267db2016-04-14 07:38:13 -0400653bool trace_find_filtered_pid(struct trace_pid_list *filtered_pids,
654 pid_t search_pid);
655bool trace_ignore_this_task(struct trace_pid_list *filtered_pids,
656 struct task_struct *task);
657void trace_filter_add_remove_task(struct trace_pid_list *pid_list,
658 struct task_struct *self,
659 struct task_struct *task);
Steven Rostedt (Red Hat)5cc89762016-04-20 15:19:54 -0400660void *trace_pid_next(struct trace_pid_list *pid_list, void *v, loff_t *pos);
661void *trace_pid_start(struct trace_pid_list *pid_list, loff_t *pos);
662int trace_pid_show(struct seq_file *m, void *v);
Steven Rostedt (Red Hat)76c813e2016-04-21 11:35:30 -0400663void trace_free_pid_list(struct trace_pid_list *pid_list);
664int trace_pid_write(struct trace_pid_list *filtered_pids,
665 struct trace_pid_list **new_pid_list,
666 const char __user *ubuf, size_t cnt);
Steven Rostedt4e267db2016-04-14 07:38:13 -0400667
Steven Rostedt5d4a9db2009-08-27 16:52:21 -0400668#ifdef CONFIG_TRACER_MAX_TRACE
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200669void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
670void update_max_tr_single(struct trace_array *tr,
671 struct task_struct *tsk, int cpu);
Steven Rostedt5d4a9db2009-08-27 16:52:21 -0400672#endif /* CONFIG_TRACER_MAX_TRACE */
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200673
Frederic Weisbeckerc0a0d0d2009-07-29 17:51:13 +0200674#ifdef CONFIG_STACKTRACE
Steven Rostedte77405a2009-09-02 14:17:06 -0400675void ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags,
Frederic Weisbeckerc0a0d0d2009-07-29 17:51:13 +0200676 int pc);
677
678void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
679 int pc);
680#else
Li Zefane1f79922010-05-10 11:23:00 +0800681static inline void ftrace_trace_userstack(struct ring_buffer *buffer,
Frederic Weisbeckerc0a0d0d2009-07-29 17:51:13 +0200682 unsigned long flags, int pc)
683{
684}
685
686static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
687 int skip, int pc)
688{
689}
690#endif /* CONFIG_STACKTRACE */
Steven Rostedt53614992009-01-15 19:12:40 -0500691
Thomas Gleixnera5a1d1c2016-12-21 20:32:01 +0100692extern u64 ftrace_now(int cpu);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200693
Steven Rostedt4ca530852009-03-16 19:20:15 -0400694extern void trace_find_cmdline(int pid, char comm[]);
Steven Rostedtc37775d2016-04-13 16:59:18 -0400695extern void trace_event_follow_fork(struct trace_array *tr, bool enable);
Ingo Molnarf7d48cb2008-12-29 13:02:17 +0100696
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200697#ifdef CONFIG_DYNAMIC_FTRACE
698extern unsigned long ftrace_update_tot_cnt;
Steven Rostedtad977722012-07-20 13:45:59 -0400699#endif
Steven Rostedtd05cdb22008-05-12 21:20:54 +0200700#define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
701extern int DYN_FTRACE_TEST_NAME(void);
Steven Rostedt95950c22011-05-06 00:08:51 -0400702#define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
703extern int DYN_FTRACE_TEST_NAME2(void);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200704
Steven Rostedt (Red Hat)55034cd2013-03-07 22:48:09 -0500705extern bool ring_buffer_expanded;
Li Zefan020e5f82009-07-01 10:47:05 +0800706extern bool tracing_selftest_disabled;
707
Steven Rostedt60a11772008-05-12 21:20:44 +0200708#ifdef CONFIG_FTRACE_STARTUP_TEST
Steven Rostedt60a11772008-05-12 21:20:44 +0200709extern int trace_selftest_startup_function(struct tracer *trace,
710 struct trace_array *tr);
Frederic Weisbecker7447dce2009-02-07 21:33:57 +0100711extern int trace_selftest_startup_function_graph(struct tracer *trace,
712 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200713extern int trace_selftest_startup_irqsoff(struct tracer *trace,
714 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200715extern int trace_selftest_startup_preemptoff(struct tracer *trace,
716 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200717extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
718 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200719extern int trace_selftest_startup_wakeup(struct tracer *trace,
720 struct trace_array *tr);
Steven Noonanfb1b6d82008-09-19 03:06:43 -0700721extern int trace_selftest_startup_nop(struct tracer *trace,
722 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200723extern int trace_selftest_startup_sched_switch(struct tracer *trace,
724 struct trace_array *tr);
Steven Rostedt80e5ea42008-11-12 15:24:24 -0500725extern int trace_selftest_startup_branch(struct tracer *trace,
726 struct trace_array *tr);
Steven Rostedt (Red Hat)8f768992013-07-18 14:41:51 -0400727/*
728 * Tracer data references selftest functions that only occur
729 * on boot up. These can be __init functions. Thus, when selftests
730 * are enabled, then the tracers need to reference __init functions.
731 */
732#define __tracer_data __refdata
733#else
734/* Tracers are seldom changed. Optimize when selftests are disabled. */
735#define __tracer_data __read_mostly
Steven Rostedt60a11772008-05-12 21:20:44 +0200736#endif /* CONFIG_FTRACE_STARTUP_TEST */
737
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200738extern void *head_page(struct trace_array_cpu *data);
Thomas Gleixnera5a1d1c2016-12-21 20:32:01 +0100739extern unsigned long long ns2usecs(u64 nsec);
Frederic Weisbecker1fd8f2a2008-12-03 23:45:11 +0100740extern int
Steven Rostedt40ce74f2009-03-19 14:03:53 -0400741trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100742extern int
Steven Rostedt40ce74f2009-03-19 14:03:53 -0400743trace_vprintk(unsigned long ip, const char *fmt, va_list args);
Steven Rostedt659372d2009-09-03 19:11:07 -0400744extern int
745trace_array_vprintk(struct trace_array *tr,
746 unsigned long ip, const char *fmt, va_list args);
747int trace_array_printk(struct trace_array *tr,
748 unsigned long ip, const char *fmt, ...);
Steven Rostedt (Red Hat)12883ef2013-03-05 09:24:35 -0500749int trace_array_printk_buf(struct ring_buffer *buffer,
750 unsigned long ip, const char *fmt, ...);
Jason Wessel955b61e2010-08-05 09:22:23 -0500751void trace_printk_seq(struct trace_seq *s);
752enum print_line_t print_trace_line(struct trace_iterator *iter);
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200753
Byungchul Park8e1e1df2014-11-24 09:34:19 +0900754extern char trace_find_mark(unsigned long long duration);
755
Namhyung Kim4046bf02017-01-20 11:44:46 +0900756struct ftrace_hash {
757 unsigned long size_bits;
758 struct hlist_head *buckets;
759 unsigned long count;
760 struct rcu_head rcu;
761};
762
763struct ftrace_func_entry *
764ftrace_lookup_ip(struct ftrace_hash *hash, unsigned long ip);
765
Arnd Bergmanneb583cd42017-01-23 13:24:45 +0100766static __always_inline bool ftrace_hash_empty(struct ftrace_hash *hash)
Namhyung Kim4046bf02017-01-20 11:44:46 +0900767{
768 return !hash || !hash->count;
769}
770
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100771/* Standard output formatting function used for function return traces */
Frederic Weisbeckerfb526072008-11-25 21:07:04 +0100772#ifdef CONFIG_FUNCTION_GRAPH_TRACER
Jiri Olsa62b915f2010-04-02 19:01:22 +0200773
774/* Flag options */
775#define TRACE_GRAPH_PRINT_OVERRUN 0x1
776#define TRACE_GRAPH_PRINT_CPU 0x2
777#define TRACE_GRAPH_PRINT_OVERHEAD 0x4
778#define TRACE_GRAPH_PRINT_PROC 0x8
779#define TRACE_GRAPH_PRINT_DURATION 0x10
780#define TRACE_GRAPH_PRINT_ABS_TIME 0x20
Robert Elliottccdb5942014-05-20 17:10:36 -0500781#define TRACE_GRAPH_PRINT_IRQS 0x40
Robert Elliott607e3a22014-05-20 17:10:51 -0500782#define TRACE_GRAPH_PRINT_TAIL 0x80
Steven Rostedt (Red Hat)55577202015-09-29 19:06:50 -0400783#define TRACE_GRAPH_SLEEP_TIME 0x100
784#define TRACE_GRAPH_GRAPH_TIME 0x200
Steven Rostedt (Red Hat)6fc84ea2013-11-06 14:50:06 -0500785#define TRACE_GRAPH_PRINT_FILL_SHIFT 28
786#define TRACE_GRAPH_PRINT_FILL_MASK (0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT)
Jiri Olsa62b915f2010-04-02 19:01:22 +0200787
Steven Rostedt (Red Hat)55577202015-09-29 19:06:50 -0400788extern void ftrace_graph_sleep_time_control(bool enable);
789extern void ftrace_graph_graph_time_control(bool enable);
790
Jiri Olsad7a8d9e2010-04-02 19:01:21 +0200791extern enum print_line_t
792print_graph_function_flags(struct trace_iterator *iter, u32 flags);
793extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
Steven Rostedt (Red Hat)9d9add32014-11-12 14:57:38 -0500794extern void
Steven Rostedt0706f1c2009-03-23 23:12:58 -0400795trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
Jiri Olsa62b915f2010-04-02 19:01:22 +0200796extern void graph_trace_open(struct trace_iterator *iter);
797extern void graph_trace_close(struct trace_iterator *iter);
798extern int __trace_graph_entry(struct trace_array *tr,
799 struct ftrace_graph_ent *trace,
800 unsigned long flags, int pc);
801extern void __trace_graph_return(struct trace_array *tr,
802 struct ftrace_graph_ret *trace,
803 unsigned long flags, int pc);
804
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500805#ifdef CONFIG_DYNAMIC_FTRACE
Namhyung Kimb9b0c8312017-01-20 11:44:47 +0900806extern struct ftrace_hash *ftrace_graph_hash;
807extern struct ftrace_hash *ftrace_graph_notrace_hash;
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500808
809static inline int ftrace_graph_addr(unsigned long addr)
810{
Namhyung Kimb9b0c8312017-01-20 11:44:47 +0900811 int ret = 0;
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500812
Namhyung Kimb9b0c8312017-01-20 11:44:47 +0900813 preempt_disable_notrace();
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500814
Namhyung Kimb9b0c8312017-01-20 11:44:47 +0900815 if (ftrace_hash_empty(ftrace_graph_hash)) {
816 ret = 1;
817 goto out;
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500818 }
819
Namhyung Kimb9b0c8312017-01-20 11:44:47 +0900820 if (ftrace_lookup_ip(ftrace_graph_hash, addr)) {
821 /*
822 * If no irqs are to be traced, but a set_graph_function
823 * is set, and called by an interrupt handler, we still
824 * want to trace it.
825 */
826 if (in_irq())
827 trace_recursion_set(TRACE_IRQ_BIT);
828 else
829 trace_recursion_clear(TRACE_IRQ_BIT);
830 ret = 1;
831 }
832
833out:
834 preempt_enable_notrace();
835 return ret;
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500836}
Namhyung Kim29ad23b2013-10-14 17:24:26 +0900837
838static inline int ftrace_graph_notrace_addr(unsigned long addr)
839{
Namhyung Kimb9b0c8312017-01-20 11:44:47 +0900840 int ret = 0;
Namhyung Kim29ad23b2013-10-14 17:24:26 +0900841
Namhyung Kimb9b0c8312017-01-20 11:44:47 +0900842 preempt_disable_notrace();
Namhyung Kim29ad23b2013-10-14 17:24:26 +0900843
Namhyung Kimb9b0c8312017-01-20 11:44:47 +0900844 if (ftrace_lookup_ip(ftrace_graph_notrace_hash, addr))
845 ret = 1;
Namhyung Kim29ad23b2013-10-14 17:24:26 +0900846
Namhyung Kimb9b0c8312017-01-20 11:44:47 +0900847 preempt_enable_notrace();
848 return ret;
Namhyung Kim29ad23b2013-10-14 17:24:26 +0900849}
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100850#else
Ingo Molnar6b253932008-12-04 09:18:28 +0100851static inline int ftrace_graph_addr(unsigned long addr)
852{
853 return 1;
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500854}
Namhyung Kim29ad23b2013-10-14 17:24:26 +0900855
856static inline int ftrace_graph_notrace_addr(unsigned long addr)
857{
858 return 0;
859}
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500860#endif /* CONFIG_DYNAMIC_FTRACE */
Steven Rostedt (Red Hat)1a414422016-12-08 19:28:28 -0500861
862extern unsigned int fgraph_max_depth;
863
864static inline bool ftrace_graph_ignore_func(struct ftrace_graph_ent *trace)
865{
866 /* trace it when it is-nested-in or is a function enabled. */
867 return !(trace->depth || ftrace_graph_addr(trace->func)) ||
868 (trace->depth < 0) ||
869 (fgraph_max_depth && trace->depth >= fgraph_max_depth);
870}
871
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500872#else /* CONFIG_FUNCTION_GRAPH_TRACER */
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100873static inline enum print_line_t
Jiri Olsad7a8d9e2010-04-02 19:01:21 +0200874print_graph_function_flags(struct trace_iterator *iter, u32 flags)
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100875{
876 return TRACE_TYPE_UNHANDLED;
877}
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500878#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100879
jolsa@redhat.com756d17e2009-10-13 16:33:52 -0400880extern struct list_head ftrace_pids;
Steven Rostedt804a6852008-12-03 15:36:59 -0500881
Paul Mundt1155de42009-06-25 14:30:12 +0900882#ifdef CONFIG_FUNCTION_TRACER
Steven Rostedt (VMware)92a68fa2017-03-31 19:21:41 -0400883struct ftrace_func_command {
884 struct list_head list;
885 char *name;
886 int (*func)(struct ftrace_hash *hash,
887 char *func, char *cmd,
888 char *params, int enable);
889};
Steven Rostedt (Red Hat)f1ed7c72013-06-27 22:18:06 -0400890extern bool ftrace_filter_param __initdata;
Steven Rostedt (Red Hat)345ddcc2016-04-22 18:11:33 -0400891static inline int ftrace_trace_task(struct trace_array *tr)
Steven Rostedt804a6852008-12-03 15:36:59 -0500892{
Steven Rostedt (Red Hat)345ddcc2016-04-22 18:11:33 -0400893 return !this_cpu_read(tr->trace_buffer.data->ftrace_ignore_pid);
Steven Rostedt804a6852008-12-03 15:36:59 -0500894}
Steven Rostedte0a413f2011-09-29 21:26:16 -0400895extern int ftrace_is_dead(void);
Steven Rostedt (Red Hat)591dffd2014-01-10 16:17:45 -0500896int ftrace_create_function_files(struct trace_array *tr,
897 struct dentry *parent);
898void ftrace_destroy_function_files(struct trace_array *tr);
Steven Rostedt (Red Hat)4104d322014-01-10 17:01:58 -0500899void ftrace_init_global_array_ops(struct trace_array *tr);
900void ftrace_init_array_ops(struct trace_array *tr, ftrace_func_t func);
901void ftrace_reset_array_ops(struct trace_array *tr);
Jiaxing Wang7eea4fc2014-04-20 23:10:43 +0800902int using_ftrace_ops_list_func(void);
Steven Rostedt (Red Hat)345ddcc2016-04-22 18:11:33 -0400903void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d_tracer);
Steven Rostedt (Red Hat)501c2372016-07-05 10:04:34 -0400904void ftrace_init_tracefs_toplevel(struct trace_array *tr,
905 struct dentry *d_tracer);
Steven Rostedt (VMware)dbeafd02017-03-03 13:48:42 -0500906int init_function_trace(void);
Namhyung Kim1e104862017-04-17 11:44:28 +0900907void ftrace_pid_follow_fork(struct trace_array *tr, bool enable);
Paul Mundt1155de42009-06-25 14:30:12 +0900908#else
Steven Rostedt (Red Hat)345ddcc2016-04-22 18:11:33 -0400909static inline int ftrace_trace_task(struct trace_array *tr)
Paul Mundt1155de42009-06-25 14:30:12 +0900910{
911 return 1;
912}
Steven Rostedte0a413f2011-09-29 21:26:16 -0400913static inline int ftrace_is_dead(void) { return 0; }
Steven Rostedt (Red Hat)591dffd2014-01-10 16:17:45 -0500914static inline int
915ftrace_create_function_files(struct trace_array *tr,
916 struct dentry *parent)
917{
918 return 0;
919}
920static inline void ftrace_destroy_function_files(struct trace_array *tr) { }
Steven Rostedt (Red Hat)4104d322014-01-10 17:01:58 -0500921static inline __init void
922ftrace_init_global_array_ops(struct trace_array *tr) { }
923static inline void ftrace_reset_array_ops(struct trace_array *tr) { }
Steven Rostedt (Red Hat)345ddcc2016-04-22 18:11:33 -0400924static inline void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d) { }
Steven Rostedt (Red Hat)501c2372016-07-05 10:04:34 -0400925static inline void ftrace_init_tracefs_toplevel(struct trace_array *tr, struct dentry *d) { }
Steven Rostedt (VMware)dbeafd02017-03-03 13:48:42 -0500926static inline int init_function_trace(void) { return 0; }
Namhyung Kim1e104862017-04-17 11:44:28 +0900927static inline void ftrace_pid_follow_fork(struct trace_array *tr, bool enable) { }
Steven Rostedt (Red Hat)4104d322014-01-10 17:01:58 -0500928/* ftace_func_t type is not defined, use macro instead of static inline */
929#define ftrace_init_array_ops(tr, func) do { } while (0)
Steven Rostedt (Red Hat)591dffd2014-01-10 16:17:45 -0500930#endif /* CONFIG_FUNCTION_TRACER */
931
932#if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE)
Steven Rostedt (VMware)ec19b852017-03-31 19:01:14 -0400933
934struct ftrace_probe_ops {
935 void (*func)(unsigned long ip,
936 unsigned long parent_ip,
Steven Rostedt (VMware)bca6c8d2017-04-03 18:18:47 -0400937 struct ftrace_probe_ops *ops,
Steven Rostedt (VMware)ec19b852017-03-31 19:01:14 -0400938 void **data);
939 int (*init)(struct ftrace_probe_ops *ops,
940 unsigned long ip, void **data);
941 void (*free)(struct ftrace_probe_ops *ops,
942 unsigned long ip, void **data);
943 int (*print)(struct seq_file *m,
944 unsigned long ip,
945 struct ftrace_probe_ops *ops,
946 void *data);
947};
948
949extern int
950register_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
951 void *data);
952extern void
953unregister_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
954 void *data);
955extern void
956unregister_ftrace_function_probe_func(char *glob, struct ftrace_probe_ops *ops);
957extern void unregister_ftrace_function_probe_all(char *glob);
958
Steven Rostedt (VMware)92a68fa2017-03-31 19:21:41 -0400959int register_ftrace_command(struct ftrace_func_command *cmd);
960int unregister_ftrace_command(struct ftrace_func_command *cmd);
961
Steven Rostedt (Red Hat)591dffd2014-01-10 16:17:45 -0500962void ftrace_create_filter_files(struct ftrace_ops *ops,
963 struct dentry *parent);
964void ftrace_destroy_filter_files(struct ftrace_ops *ops);
965#else
Steven Rostedt (VMware)92a68fa2017-03-31 19:21:41 -0400966struct ftrace_func_command;
967
968static inline __init int register_ftrace_command(struct ftrace_func_command *cmd)
969{
970 return -EINVAL;
971}
972static inline __init int unregister_ftrace_command(char *cmd_name)
973{
974 return -EINVAL;
975}
Steven Rostedt (Red Hat)591dffd2014-01-10 16:17:45 -0500976/*
977 * The ops parameter passed in is usually undefined.
978 * This must be a macro.
979 */
980#define ftrace_create_filter_files(ops, parent) do { } while (0)
981#define ftrace_destroy_filter_files(ops) do { } while (0)
982#endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */
Steven Rostedt804a6852008-12-03 15:36:59 -0500983
Yaowei Baic6650b22015-09-29 22:43:36 +0800984bool ftrace_event_is_function(struct trace_event_call *call);
Jiri Olsaced39002012-02-15 15:51:52 +0100985
Steven Rostedt4fcdae82008-05-12 21:21:00 +0200986/*
jolsa@redhat.comb63f39e2009-09-11 17:29:27 +0200987 * struct trace_parser - servers for reading the user input separated by spaces
988 * @cont: set if the input is not complete - no final space char was found
989 * @buffer: holds the parsed user input
Daniel Mack1537a362010-01-29 15:57:49 +0800990 * @idx: user input length
jolsa@redhat.comb63f39e2009-09-11 17:29:27 +0200991 * @size: buffer size
992 */
993struct trace_parser {
994 bool cont;
995 char *buffer;
996 unsigned idx;
997 unsigned size;
998};
999
1000static inline bool trace_parser_loaded(struct trace_parser *parser)
1001{
1002 return (parser->idx != 0);
1003}
1004
1005static inline bool trace_parser_cont(struct trace_parser *parser)
1006{
1007 return parser->cont;
1008}
1009
1010static inline void trace_parser_clear(struct trace_parser *parser)
1011{
1012 parser->cont = false;
1013 parser->idx = 0;
1014}
1015
1016extern int trace_parser_get_init(struct trace_parser *parser, int size);
1017extern void trace_parser_put(struct trace_parser *parser);
1018extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
1019 size_t cnt, loff_t *ppos);
1020
1021/*
Steven Rostedt (Red Hat)729358d2015-09-29 10:15:10 -04001022 * Only create function graph options if function graph is configured.
1023 */
1024#ifdef CONFIG_FUNCTION_GRAPH_TRACER
1025# define FGRAPH_FLAGS \
Steven Rostedt (Red Hat)729358d2015-09-29 10:15:10 -04001026 C(DISPLAY_GRAPH, "display-graph"),
Steven Rostedt (Red Hat)729358d2015-09-29 10:15:10 -04001027#else
1028# define FGRAPH_FLAGS
Steven Rostedt (Red Hat)729358d2015-09-29 10:15:10 -04001029#endif
1030
Steven Rostedt (Red Hat)4ee43012015-09-29 10:19:35 -04001031#ifdef CONFIG_BRANCH_TRACER
1032# define BRANCH_FLAGS \
1033 C(BRANCH, "branch"),
1034#else
1035# define BRANCH_FLAGS
1036#endif
1037
Steven Rostedt (Red Hat)8179e8a2015-09-29 10:24:56 -04001038#ifdef CONFIG_FUNCTION_TRACER
1039# define FUNCTION_FLAGS \
Namhyung Kim1e104862017-04-17 11:44:28 +09001040 C(FUNCTION, "function-trace"), \
1041 C(FUNC_FORK, "function-fork"),
Steven Rostedt (Red Hat)8179e8a2015-09-29 10:24:56 -04001042# define FUNCTION_DEFAULT_FLAGS TRACE_ITER_FUNCTION
1043#else
1044# define FUNCTION_FLAGS
1045# define FUNCTION_DEFAULT_FLAGS 0UL
Namhyung Kim1e104862017-04-17 11:44:28 +09001046# define TRACE_ITER_FUNC_FORK 0UL
Steven Rostedt (Red Hat)8179e8a2015-09-29 10:24:56 -04001047#endif
1048
Steven Rostedt (Red Hat)73dddbb2015-09-29 15:38:55 -04001049#ifdef CONFIG_STACKTRACE
1050# define STACK_FLAGS \
1051 C(STACKTRACE, "stacktrace"),
1052#else
1053# define STACK_FLAGS
1054#endif
1055
Steven Rostedt (Red Hat)729358d2015-09-29 10:15:10 -04001056/*
Steven Rostedt4fcdae82008-05-12 21:21:00 +02001057 * trace_iterator_flags is an enumeration that defines bit
1058 * positions into trace_flags that controls the output.
1059 *
1060 * NOTE: These bits must match the trace_options array in
Steven Rostedt (Red Hat)a3418a32015-09-29 09:43:30 -04001061 * trace.c (this macro guarantees it).
Steven Rostedt4fcdae82008-05-12 21:21:00 +02001062 */
Steven Rostedt (Red Hat)a3418a32015-09-29 09:43:30 -04001063#define TRACE_FLAGS \
1064 C(PRINT_PARENT, "print-parent"), \
1065 C(SYM_OFFSET, "sym-offset"), \
1066 C(SYM_ADDR, "sym-addr"), \
1067 C(VERBOSE, "verbose"), \
1068 C(RAW, "raw"), \
1069 C(HEX, "hex"), \
1070 C(BIN, "bin"), \
1071 C(BLOCK, "block"), \
Steven Rostedt (Red Hat)a3418a32015-09-29 09:43:30 -04001072 C(PRINTK, "trace_printk"), \
Steven Rostedt (Red Hat)a3418a32015-09-29 09:43:30 -04001073 C(ANNOTATE, "annotate"), \
1074 C(USERSTACKTRACE, "userstacktrace"), \
1075 C(SYM_USEROBJ, "sym-userobj"), \
1076 C(PRINTK_MSGONLY, "printk-msg-only"), \
1077 C(CONTEXT_INFO, "context-info"), /* Print pid/cpu/time */ \
1078 C(LATENCY_FMT, "latency-format"), \
Steven Rostedt (Red Hat)a3418a32015-09-29 09:43:30 -04001079 C(RECORD_CMD, "record-cmd"), \
1080 C(OVERWRITE, "overwrite"), \
1081 C(STOP_ON_FREE, "disable_on_free"), \
1082 C(IRQ_INFO, "irq-info"), \
1083 C(MARKERS, "markers"), \
Steven Rostedtc37775d2016-04-13 16:59:18 -04001084 C(EVENT_FORK, "event-fork"), \
Steven Rostedt (Red Hat)8179e8a2015-09-29 10:24:56 -04001085 FUNCTION_FLAGS \
Steven Rostedt (Red Hat)4ee43012015-09-29 10:19:35 -04001086 FGRAPH_FLAGS \
Steven Rostedt (Red Hat)73dddbb2015-09-29 15:38:55 -04001087 STACK_FLAGS \
Steven Rostedt (Red Hat)4ee43012015-09-29 10:19:35 -04001088 BRANCH_FLAGS
Steven Rostedt (Red Hat)ce3fed62015-09-29 09:22:05 -04001089
Steven Rostedt (Red Hat)a3418a32015-09-29 09:43:30 -04001090/*
1091 * By defining C, we can make TRACE_FLAGS a list of bit names
1092 * that will define the bits for the flag masks.
1093 */
1094#undef C
1095#define C(a, b) TRACE_ITER_##a##_BIT
1096
Steven Rostedt (Red Hat)b5e87c02015-09-29 18:13:33 -04001097enum trace_iterator_bits {
1098 TRACE_FLAGS
1099 /* Make sure we don't go more than we have bits for */
1100 TRACE_ITER_LAST_BIT
1101};
Steven Rostedt (Red Hat)a3418a32015-09-29 09:43:30 -04001102
1103/*
1104 * By redefining C, we can make TRACE_FLAGS a list of masks that
1105 * use the bits as defined above.
1106 */
1107#undef C
1108#define C(a, b) TRACE_ITER_##a = (1 << TRACE_ITER_##a##_BIT)
1109
1110enum trace_iterator_flags { TRACE_FLAGS };
Ingo Molnar4e655512008-05-12 21:20:52 +02001111
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +01001112/*
1113 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
1114 * control the output of kernel symbols.
1115 */
1116#define TRACE_ITER_SYM_MASK \
1117 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
1118
Frédéric Weisbecker43a15382008-09-21 20:16:30 +02001119extern struct tracer nop_trace;
1120
Steven Rostedt2ed84ee2008-11-12 15:24:24 -05001121#ifdef CONFIG_BRANCH_TRACER
Steven Rostedt9f029e82008-11-12 15:24:24 -05001122extern int enable_branch_tracing(struct trace_array *tr);
1123extern void disable_branch_tracing(void);
1124static inline int trace_branch_enable(struct trace_array *tr)
Steven Rostedt52f232c2008-11-12 00:14:40 -05001125{
Steven Rostedt (Red Hat)983f9382015-09-30 09:42:05 -04001126 if (tr->trace_flags & TRACE_ITER_BRANCH)
Steven Rostedt9f029e82008-11-12 15:24:24 -05001127 return enable_branch_tracing(tr);
Steven Rostedt52f232c2008-11-12 00:14:40 -05001128 return 0;
1129}
Steven Rostedt9f029e82008-11-12 15:24:24 -05001130static inline void trace_branch_disable(void)
Steven Rostedt52f232c2008-11-12 00:14:40 -05001131{
1132 /* due to races, always disable */
Steven Rostedt9f029e82008-11-12 15:24:24 -05001133 disable_branch_tracing();
Steven Rostedt52f232c2008-11-12 00:14:40 -05001134}
1135#else
Steven Rostedt9f029e82008-11-12 15:24:24 -05001136static inline int trace_branch_enable(struct trace_array *tr)
Steven Rostedt52f232c2008-11-12 00:14:40 -05001137{
1138 return 0;
1139}
Steven Rostedt9f029e82008-11-12 15:24:24 -05001140static inline void trace_branch_disable(void)
Steven Rostedt52f232c2008-11-12 00:14:40 -05001141{
1142}
Steven Rostedt2ed84ee2008-11-12 15:24:24 -05001143#endif /* CONFIG_BRANCH_TRACER */
Steven Rostedt52f232c2008-11-12 00:14:40 -05001144
Steven Rostedt1852fcc2009-03-11 14:33:00 -04001145/* set ring buffers to default size if not already done so */
1146int tracing_update_buffers(void);
1147
Tom Zanussicf027f62009-03-22 03:30:39 -05001148struct ftrace_event_field {
1149 struct list_head link;
Steven Rostedt92edca02013-02-27 20:41:37 -05001150 const char *name;
1151 const char *type;
Li Zefanaa38e9f2009-08-07 10:33:02 +08001152 int filter_type;
Tom Zanussicf027f62009-03-22 03:30:39 -05001153 int offset;
1154 int size;
Tom Zanussia118e4d2009-04-28 03:04:53 -05001155 int is_signed;
Tom Zanussicf027f62009-03-22 03:30:39 -05001156};
1157
Tom Zanussi30e673b2009-04-28 03:04:47 -05001158struct event_filter {
Steven Rostedtc9c53ca2011-01-27 22:42:43 -05001159 int n_preds; /* Number assigned */
1160 int a_preds; /* allocated */
Steven Rostedt74e9e582011-01-27 22:49:48 -05001161 struct filter_pred *preds;
Steven Rostedt61e9dea2011-01-27 22:54:33 -05001162 struct filter_pred *root;
Tom Zanussi8b372562009-04-28 03:04:59 -05001163 char *filter_string;
Tom Zanussi30e673b2009-04-28 03:04:47 -05001164};
1165
Tom Zanussicfb180f2009-03-22 03:31:17 -05001166struct event_subsystem {
1167 struct list_head list;
1168 const char *name;
Li Zefan1f9963c2009-07-20 10:20:53 +08001169 struct event_filter *filter;
Steven Rostedte9dbfae2011-07-05 11:36:06 -04001170 int ref_count;
Tom Zanussicfb180f2009-03-22 03:31:17 -05001171};
1172
Steven Rostedt (Red Hat)7967b3e2015-05-13 14:59:40 -04001173struct trace_subsystem_dir {
Steven Rostedtae63b31e2012-05-03 23:09:03 -04001174 struct list_head list;
1175 struct event_subsystem *subsystem;
1176 struct trace_array *tr;
1177 struct dentry *entry;
1178 int ref_count;
1179 int nr_events;
1180};
1181
Steven Rostedt (Red Hat)65da9a02016-04-27 10:13:46 -04001182extern int call_filter_check_discard(struct trace_event_call *call, void *rec,
1183 struct ring_buffer *buffer,
1184 struct ring_buffer_event *event);
Steven Rostedt (Red Hat)fa66ddb2016-04-28 12:04:13 -04001185
Steven Rostedt (Red Hat)fa66ddb2016-04-28 12:04:13 -04001186void trace_buffer_unlock_commit_regs(struct trace_array *tr,
1187 struct ring_buffer *buffer,
1188 struct ring_buffer_event *event,
1189 unsigned long flags, int pc,
1190 struct pt_regs *regs);
Steven Rostedt (Red Hat)33fddff2016-04-29 17:44:01 -04001191
1192static inline void trace_buffer_unlock_commit(struct trace_array *tr,
1193 struct ring_buffer *buffer,
1194 struct ring_buffer_event *event,
1195 unsigned long flags, int pc)
1196{
1197 trace_buffer_unlock_commit_regs(tr, buffer, event, flags, pc, NULL);
1198}
1199
Steven Rostedt (Red Hat)0fc1b092016-05-03 17:15:43 -04001200DECLARE_PER_CPU(struct ring_buffer_event *, trace_buffered_event);
1201DECLARE_PER_CPU(int, trace_buffered_event_cnt);
1202void trace_buffered_event_disable(void);
1203void trace_buffered_event_enable(void);
1204
1205static inline void
1206__trace_event_discard_commit(struct ring_buffer *buffer,
1207 struct ring_buffer_event *event)
1208{
1209 if (this_cpu_read(trace_buffered_event) == event) {
1210 /* Simply release the temp buffer */
1211 this_cpu_dec(trace_buffered_event_cnt);
1212 return;
1213 }
1214 ring_buffer_discard_commit(buffer, event);
1215}
1216
Steven Rostedt (Red Hat)dad56ee2016-04-26 21:22:22 -04001217/*
1218 * Helper function for event_trigger_unlock_commit{_regs}().
1219 * If there are event triggers attached to this event that requires
1220 * filtering against its fields, then they wil be called as the
1221 * entry already holds the field information of the current event.
1222 *
1223 * It also checks if the event should be discarded or not.
1224 * It is to be discarded if the event is soft disabled and the
1225 * event was only recorded to process triggers, or if the event
1226 * filter is active and this event did not match the filters.
1227 *
1228 * Returns true if the event is discarded, false otherwise.
1229 */
1230static inline bool
1231__event_trigger_test_discard(struct trace_event_file *file,
1232 struct ring_buffer *buffer,
1233 struct ring_buffer_event *event,
1234 void *entry,
1235 enum event_trigger_type *tt)
1236{
1237 unsigned long eflags = file->flags;
1238
1239 if (eflags & EVENT_FILE_FL_TRIGGER_COND)
1240 *tt = event_triggers_call(file, entry);
1241
Steven Rostedt (Red Hat)9cbb1502016-04-27 11:09:42 -04001242 if (test_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT, &file->flags) ||
1243 (unlikely(file->flags & EVENT_FILE_FL_FILTERED) &&
1244 !filter_match_preds(file->filter, entry))) {
Steven Rostedt (Red Hat)0fc1b092016-05-03 17:15:43 -04001245 __trace_event_discard_commit(buffer, event);
Steven Rostedt (Red Hat)9cbb1502016-04-27 11:09:42 -04001246 return true;
1247 }
Steven Rostedt (Red Hat)dad56ee2016-04-26 21:22:22 -04001248
Steven Rostedt (Red Hat)9cbb1502016-04-27 11:09:42 -04001249 return false;
Steven Rostedt (Red Hat)dad56ee2016-04-26 21:22:22 -04001250}
1251
1252/**
1253 * event_trigger_unlock_commit - handle triggers and finish event commit
1254 * @file: The file pointer assoctiated to the event
1255 * @buffer: The ring buffer that the event is being written to
1256 * @event: The event meta data in the ring buffer
1257 * @entry: The event itself
1258 * @irq_flags: The state of the interrupts at the start of the event
1259 * @pc: The state of the preempt count at the start of the event.
1260 *
1261 * This is a helper function to handle triggers that require data
1262 * from the event itself. It also tests the event against filters and
1263 * if the event is soft disabled and should be discarded.
1264 */
1265static inline void
1266event_trigger_unlock_commit(struct trace_event_file *file,
1267 struct ring_buffer *buffer,
1268 struct ring_buffer_event *event,
1269 void *entry, unsigned long irq_flags, int pc)
1270{
1271 enum event_trigger_type tt = ETT_NONE;
1272
1273 if (!__event_trigger_test_discard(file, buffer, event, entry, &tt))
1274 trace_buffer_unlock_commit(file->tr, buffer, event, irq_flags, pc);
1275
1276 if (tt)
1277 event_triggers_post_call(file, tt, entry);
1278}
1279
1280/**
1281 * event_trigger_unlock_commit_regs - handle triggers and finish event commit
1282 * @file: The file pointer assoctiated to the event
1283 * @buffer: The ring buffer that the event is being written to
1284 * @event: The event meta data in the ring buffer
1285 * @entry: The event itself
1286 * @irq_flags: The state of the interrupts at the start of the event
1287 * @pc: The state of the preempt count at the start of the event.
1288 *
1289 * This is a helper function to handle triggers that require data
1290 * from the event itself. It also tests the event against filters and
1291 * if the event is soft disabled and should be discarded.
1292 *
1293 * Same as event_trigger_unlock_commit() but calls
1294 * trace_buffer_unlock_commit_regs() instead of trace_buffer_unlock_commit().
1295 */
1296static inline void
1297event_trigger_unlock_commit_regs(struct trace_event_file *file,
1298 struct ring_buffer *buffer,
1299 struct ring_buffer_event *event,
1300 void *entry, unsigned long irq_flags, int pc,
1301 struct pt_regs *regs)
1302{
1303 enum event_trigger_type tt = ETT_NONE;
1304
1305 if (!__event_trigger_test_discard(file, buffer, event, entry, &tt))
1306 trace_buffer_unlock_commit_regs(file->tr, buffer, event,
1307 irq_flags, pc, regs);
1308
1309 if (tt)
1310 event_triggers_post_call(file, tt, entry);
1311}
1312
Steven Rostedt61e9dea2011-01-27 22:54:33 -05001313#define FILTER_PRED_INVALID ((unsigned short)-1)
1314#define FILTER_PRED_IS_RIGHT (1 << 15)
Steven Rostedt43cd4142011-01-27 23:16:51 -05001315#define FILTER_PRED_FOLD (1 << 15)
Steven Rostedt61e9dea2011-01-27 22:54:33 -05001316
Steven Rostedtbf93f9e2011-01-27 23:21:34 -05001317/*
1318 * The max preds is the size of unsigned short with
1319 * two flags at the MSBs. One bit is used for both the IS_RIGHT
1320 * and FOLD flags. The other is reserved.
1321 *
1322 * 2^14 preds is way more than enough.
1323 */
1324#define MAX_FILTER_PRED 16384
Steven Rostedt4a3d27e2011-01-27 23:19:49 -05001325
Tom Zanussi7ce7e422009-03-22 03:31:04 -05001326struct filter_pred;
Frederic Weisbecker1889d202009-09-24 21:10:44 +02001327struct regex;
Tom Zanussi7ce7e422009-03-22 03:31:04 -05001328
Steven Rostedt58d9a592011-01-27 22:37:09 -05001329typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);
Tom Zanussi7ce7e422009-03-22 03:31:04 -05001330
Frederic Weisbecker1889d202009-09-24 21:10:44 +02001331typedef int (*regex_match_func)(char *str, struct regex *r, int len);
1332
Frederic Weisbecker3f6fe062009-09-24 21:31:51 +02001333enum regex_type {
Li Zefanb0f1a592009-10-15 11:21:12 +08001334 MATCH_FULL = 0,
Frederic Weisbecker3f6fe062009-09-24 21:31:51 +02001335 MATCH_FRONT_ONLY,
1336 MATCH_MIDDLE_ONLY,
1337 MATCH_END_ONLY,
Masami Hiramatsu60f1d5e2016-10-05 20:58:15 +09001338 MATCH_GLOB,
Tom Zanussi7ce7e422009-03-22 03:31:04 -05001339};
1340
Frederic Weisbecker1889d202009-09-24 21:10:44 +02001341struct regex {
1342 char pattern[MAX_FILTER_STR_VAL];
1343 int len;
1344 int field_len;
1345 regex_match_func match;
1346};
1347
Tom Zanussicf027f62009-03-22 03:30:39 -05001348struct filter_pred {
Frederic Weisbecker1889d202009-09-24 21:10:44 +02001349 filter_pred_fn_t fn;
1350 u64 val;
1351 struct regex regex;
Jiri Olsa61aaef552011-08-11 16:25:47 +02001352 unsigned short *ops;
Jiri Olsa1d0e78e2011-08-11 16:25:54 +02001353 struct ftrace_event_field *field;
Frederic Weisbecker1889d202009-09-24 21:10:44 +02001354 int offset;
1355 int not;
1356 int op;
Steven Rostedt61e9dea2011-01-27 22:54:33 -05001357 unsigned short index;
1358 unsigned short parent;
1359 unsigned short left;
1360 unsigned short right;
Steven Rostedtc32e8272009-02-27 19:12:30 -05001361};
1362
Tom Zanussi4ef56902015-12-10 12:50:43 -06001363static inline bool is_string_field(struct ftrace_event_field *field)
1364{
1365 return field->filter_type == FILTER_DYN_STRING ||
1366 field->filter_type == FILTER_STATIC_STRING ||
Steven Rostedt (VMware)4c738412017-02-08 13:36:37 -05001367 field->filter_type == FILTER_PTR_STRING ||
1368 field->filter_type == FILTER_COMM;
Tom Zanussi4ef56902015-12-10 12:50:43 -06001369}
1370
1371static inline bool is_function_field(struct ftrace_event_field *field)
1372{
1373 return field->filter_type == FILTER_TRACE_FN;
1374}
1375
Frederic Weisbecker3f6fe062009-09-24 21:31:51 +02001376extern enum regex_type
1377filter_parse_regex(char *buff, int len, char **search, int *not);
Steven Rostedt (Red Hat)7f1d2f82015-05-05 10:09:53 -04001378extern void print_event_filter(struct trace_event_file *file,
Tom Zanussi4bda2d52009-03-24 02:14:31 -05001379 struct trace_seq *s);
Steven Rostedt (Red Hat)7f1d2f82015-05-05 10:09:53 -04001380extern int apply_event_filter(struct trace_event_file *file,
Tom Zanussi8b372562009-04-28 03:04:59 -05001381 char *filter_string);
Steven Rostedt (Red Hat)7967b3e2015-05-13 14:59:40 -04001382extern int apply_subsystem_event_filter(struct trace_subsystem_dir *dir,
Tom Zanussi8b372562009-04-28 03:04:59 -05001383 char *filter_string);
1384extern void print_subsystem_event_filter(struct event_subsystem *system,
Tom Zanussiac1adc52009-04-17 00:27:08 -05001385 struct trace_seq *s);
Li Zefanaa38e9f2009-08-07 10:33:02 +08001386extern int filter_assign_type(const char *type);
Steven Rostedt (Red Hat)2425bcb2015-05-05 11:45:27 -04001387extern int create_event_filter(struct trace_event_call *call,
Tom Zanussibac5fb92013-10-24 08:59:29 -05001388 char *filter_str, bool set_str,
1389 struct event_filter **filterp);
1390extern void free_event_filter(struct event_filter *filter);
Tom Zanussi7ce7e422009-03-22 03:31:04 -05001391
zhangwei(Jovi)b3a8c6f2013-03-11 15:13:42 +08001392struct ftrace_event_field *
Steven Rostedt (Red Hat)2425bcb2015-05-05 11:45:27 -04001393trace_find_event_field(struct trace_event_call *call, char *name);
Steven Rostedt2e33af02010-04-22 10:35:55 -04001394
Li Zefane870e9a2010-07-02 11:07:32 +08001395extern void trace_event_enable_cmd_record(bool enable);
Steven Rostedt277ba042012-08-03 16:10:49 -04001396extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr);
Steven Rostedt0c8916c2012-08-07 16:14:16 -04001397extern int event_trace_del_tracer(struct trace_array *tr);
Li Zefane870e9a2010-07-02 11:07:32 +08001398
Steven Rostedt (Red Hat)7f1d2f82015-05-05 10:09:53 -04001399extern struct trace_event_file *find_event_file(struct trace_array *tr,
1400 const char *system,
1401 const char *event);
Tom Zanussi7862ad12013-10-24 08:59:28 -05001402
Tom Zanussi85f2b082013-10-24 08:59:24 -05001403static inline void *event_file_data(struct file *filp)
1404{
1405 return ACCESS_ONCE(file_inode(filp)->i_private);
1406}
1407
Li Zefan20c89282009-05-06 10:33:45 +08001408extern struct mutex event_mutex;
Steven Rostedta59fd602009-04-10 13:52:20 -04001409extern struct list_head ftrace_events;
Peter Zijlstraac199db2009-03-19 20:26:15 +01001410
Tom Zanussi85f2b082013-10-24 08:59:24 -05001411extern const struct file_operations event_trigger_fops;
Tom Zanussi7ef224d2016-03-03 12:54:42 -06001412extern const struct file_operations event_hist_fops;
1413
1414#ifdef CONFIG_HIST_TRIGGERS
1415extern int register_trigger_hist_cmd(void);
Tom Zanussid0bad492016-03-03 12:54:55 -06001416extern int register_trigger_hist_enable_disable_cmds(void);
Tom Zanussi7ef224d2016-03-03 12:54:42 -06001417#else
1418static inline int register_trigger_hist_cmd(void) { return 0; }
Tom Zanussid0bad492016-03-03 12:54:55 -06001419static inline int register_trigger_hist_enable_disable_cmds(void) { return 0; }
Tom Zanussi7ef224d2016-03-03 12:54:42 -06001420#endif
Tom Zanussi85f2b082013-10-24 08:59:24 -05001421
1422extern int register_trigger_cmds(void);
1423extern void clear_event_triggers(struct trace_array *tr);
1424
1425struct event_trigger_data {
1426 unsigned long count;
1427 int ref;
1428 struct event_trigger_ops *ops;
1429 struct event_command *cmd_ops;
Steven Rostedt (Red Hat)d8a30f22013-12-21 21:55:17 -05001430 struct event_filter __rcu *filter;
Tom Zanussi85f2b082013-10-24 08:59:24 -05001431 char *filter_str;
1432 void *private_data;
Tom Zanussi104f2812015-12-10 12:50:47 -06001433 bool paused;
Tom Zanussidb1388b2016-03-03 12:54:58 -06001434 bool paused_tmp;
Tom Zanussi85f2b082013-10-24 08:59:24 -05001435 struct list_head list;
Tom Zanussidb1388b2016-03-03 12:54:58 -06001436 char *name;
1437 struct list_head named_list;
1438 struct event_trigger_data *named_data;
Tom Zanussi85f2b082013-10-24 08:59:24 -05001439};
1440
Tom Zanussid0bad492016-03-03 12:54:55 -06001441/* Avoid typos */
1442#define ENABLE_EVENT_STR "enable_event"
1443#define DISABLE_EVENT_STR "disable_event"
1444#define ENABLE_HIST_STR "enable_hist"
1445#define DISABLE_HIST_STR "disable_hist"
1446
1447struct enable_trigger_data {
1448 struct trace_event_file *file;
1449 bool enable;
1450 bool hist;
1451};
1452
1453extern int event_enable_trigger_print(struct seq_file *m,
1454 struct event_trigger_ops *ops,
1455 struct event_trigger_data *data);
1456extern void event_enable_trigger_free(struct event_trigger_ops *ops,
1457 struct event_trigger_data *data);
1458extern int event_enable_trigger_func(struct event_command *cmd_ops,
1459 struct trace_event_file *file,
1460 char *glob, char *cmd, char *param);
1461extern int event_enable_register_trigger(char *glob,
1462 struct event_trigger_ops *ops,
1463 struct event_trigger_data *data,
1464 struct trace_event_file *file);
1465extern void event_enable_unregister_trigger(char *glob,
1466 struct event_trigger_ops *ops,
1467 struct event_trigger_data *test,
1468 struct trace_event_file *file);
Tom Zanussiab4bf002015-12-10 12:50:44 -06001469extern void trigger_data_free(struct event_trigger_data *data);
1470extern int event_trigger_init(struct event_trigger_ops *ops,
1471 struct event_trigger_data *data);
1472extern int trace_event_trigger_enable_disable(struct trace_event_file *file,
1473 int trigger_enable);
1474extern void update_cond_flag(struct trace_event_file *file);
1475extern void unregister_trigger(char *glob, struct event_trigger_ops *ops,
1476 struct event_trigger_data *test,
1477 struct trace_event_file *file);
1478extern int set_trigger_filter(char *filter_str,
1479 struct event_trigger_data *trigger_data,
1480 struct trace_event_file *file);
Tom Zanussidb1388b2016-03-03 12:54:58 -06001481extern struct event_trigger_data *find_named_trigger(const char *name);
1482extern bool is_named_trigger(struct event_trigger_data *test);
1483extern int save_named_trigger(const char *name,
1484 struct event_trigger_data *data);
1485extern void del_named_trigger(struct event_trigger_data *data);
1486extern void pause_named_trigger(struct event_trigger_data *data);
1487extern void unpause_named_trigger(struct event_trigger_data *data);
1488extern void set_named_trigger_data(struct event_trigger_data *data,
1489 struct event_trigger_data *named_data);
Tom Zanussiab4bf002015-12-10 12:50:44 -06001490extern int register_event_command(struct event_command *cmd);
Tom Zanussid0bad492016-03-03 12:54:55 -06001491extern int unregister_event_command(struct event_command *cmd);
1492extern int register_trigger_hist_enable_disable_cmds(void);
Tom Zanussiab4bf002015-12-10 12:50:44 -06001493
Tom Zanussi85f2b082013-10-24 08:59:24 -05001494/**
1495 * struct event_trigger_ops - callbacks for trace event triggers
1496 *
1497 * The methods in this structure provide per-event trigger hooks for
1498 * various trigger operations.
1499 *
1500 * All the methods below, except for @init() and @free(), must be
1501 * implemented.
1502 *
1503 * @func: The trigger 'probe' function called when the triggering
1504 * event occurs. The data passed into this callback is the data
1505 * that was supplied to the event_command @reg() function that
Tom Zanussic4a59232015-12-10 12:50:45 -06001506 * registered the trigger (see struct event_command) along with
1507 * the trace record, rec.
Tom Zanussi85f2b082013-10-24 08:59:24 -05001508 *
1509 * @init: An optional initialization function called for the trigger
1510 * when the trigger is registered (via the event_command reg()
1511 * function). This can be used to perform per-trigger
1512 * initialization such as incrementing a per-trigger reference
1513 * count, for instance. This is usually implemented by the
1514 * generic utility function @event_trigger_init() (see
1515 * trace_event_triggers.c).
1516 *
1517 * @free: An optional de-initialization function called for the
1518 * trigger when the trigger is unregistered (via the
1519 * event_command @reg() function). This can be used to perform
1520 * per-trigger de-initialization such as decrementing a
1521 * per-trigger reference count and freeing corresponding trigger
1522 * data, for instance. This is usually implemented by the
1523 * generic utility function @event_trigger_free() (see
1524 * trace_event_triggers.c).
1525 *
1526 * @print: The callback function invoked to have the trigger print
1527 * itself. This is usually implemented by a wrapper function
1528 * that calls the generic utility function @event_trigger_print()
1529 * (see trace_event_triggers.c).
1530 */
1531struct event_trigger_ops {
Tom Zanussic4a59232015-12-10 12:50:45 -06001532 void (*func)(struct event_trigger_data *data,
1533 void *rec);
Tom Zanussi85f2b082013-10-24 08:59:24 -05001534 int (*init)(struct event_trigger_ops *ops,
1535 struct event_trigger_data *data);
1536 void (*free)(struct event_trigger_ops *ops,
1537 struct event_trigger_data *data);
1538 int (*print)(struct seq_file *m,
1539 struct event_trigger_ops *ops,
1540 struct event_trigger_data *data);
1541};
1542
1543/**
1544 * struct event_command - callbacks and data members for event commands
1545 *
1546 * Event commands are invoked by users by writing the command name
1547 * into the 'trigger' file associated with a trace event. The
1548 * parameters associated with a specific invocation of an event
1549 * command are used to create an event trigger instance, which is
1550 * added to the list of trigger instances associated with that trace
1551 * event. When the event is hit, the set of triggers associated with
1552 * that event is invoked.
1553 *
1554 * The data members in this structure provide per-event command data
1555 * for various event commands.
1556 *
1557 * All the data members below, except for @post_trigger, must be set
1558 * for each event command.
1559 *
1560 * @name: The unique name that identifies the event command. This is
1561 * the name used when setting triggers via trigger files.
1562 *
1563 * @trigger_type: A unique id that identifies the event command
1564 * 'type'. This value has two purposes, the first to ensure that
1565 * only one trigger of the same type can be set at a given time
1566 * for a particular event e.g. it doesn't make sense to have both
1567 * a traceon and traceoff trigger attached to a single event at
1568 * the same time, so traceon and traceoff have the same type
1569 * though they have different names. The @trigger_type value is
1570 * also used as a bit value for deferring the actual trigger
1571 * action until after the current event is finished. Some
1572 * commands need to do this if they themselves log to the trace
1573 * buffer (see the @post_trigger() member below). @trigger_type
1574 * values are defined by adding new values to the trigger_type
Steven Rostedt (Red Hat)af658dc2015-04-29 14:36:05 -04001575 * enum in include/linux/trace_events.h.
Tom Zanussi85f2b082013-10-24 08:59:24 -05001576 *
Steven Rostedt (Red Hat)353206f2016-02-22 15:55:09 -05001577 * @flags: See the enum event_command_flags below.
Tom Zanussia5863da2015-12-10 12:50:48 -06001578 *
Tom Zanussia88e1cf2015-12-10 12:50:49 -06001579 * All the methods below, except for @set_filter() and @unreg_all(),
1580 * must be implemented.
Tom Zanussi85f2b082013-10-24 08:59:24 -05001581 *
1582 * @func: The callback function responsible for parsing and
1583 * registering the trigger written to the 'trigger' file by the
1584 * user. It allocates the trigger instance and registers it with
1585 * the appropriate trace event. It makes use of the other
1586 * event_command callback functions to orchestrate this, and is
1587 * usually implemented by the generic utility function
1588 * @event_trigger_callback() (see trace_event_triggers.c).
1589 *
1590 * @reg: Adds the trigger to the list of triggers associated with the
1591 * event, and enables the event trigger itself, after
1592 * initializing it (via the event_trigger_ops @init() function).
1593 * This is also where commands can use the @trigger_type value to
1594 * make the decision as to whether or not multiple instances of
1595 * the trigger should be allowed. This is usually implemented by
1596 * the generic utility function @register_trigger() (see
1597 * trace_event_triggers.c).
1598 *
1599 * @unreg: Removes the trigger from the list of triggers associated
1600 * with the event, and disables the event trigger itself, after
1601 * initializing it (via the event_trigger_ops @free() function).
1602 * This is usually implemented by the generic utility function
1603 * @unregister_trigger() (see trace_event_triggers.c).
1604 *
Tom Zanussia88e1cf2015-12-10 12:50:49 -06001605 * @unreg_all: An optional function called to remove all the triggers
1606 * from the list of triggers associated with the event. Called
1607 * when a trigger file is opened in truncate mode.
1608 *
Tom Zanussi85f2b082013-10-24 08:59:24 -05001609 * @set_filter: An optional function called to parse and set a filter
1610 * for the trigger. If no @set_filter() method is set for the
1611 * event command, filters set by the user for the command will be
1612 * ignored. This is usually implemented by the generic utility
1613 * function @set_trigger_filter() (see trace_event_triggers.c).
1614 *
1615 * @get_trigger_ops: The callback function invoked to retrieve the
1616 * event_trigger_ops implementation associated with the command.
1617 */
1618struct event_command {
1619 struct list_head list;
1620 char *name;
1621 enum event_trigger_type trigger_type;
Steven Rostedt (Red Hat)353206f2016-02-22 15:55:09 -05001622 int flags;
Tom Zanussi85f2b082013-10-24 08:59:24 -05001623 int (*func)(struct event_command *cmd_ops,
Steven Rostedt (Red Hat)7f1d2f82015-05-05 10:09:53 -04001624 struct trace_event_file *file,
Tom Zanussi85f2b082013-10-24 08:59:24 -05001625 char *glob, char *cmd, char *params);
1626 int (*reg)(char *glob,
1627 struct event_trigger_ops *ops,
1628 struct event_trigger_data *data,
Steven Rostedt (Red Hat)7f1d2f82015-05-05 10:09:53 -04001629 struct trace_event_file *file);
Tom Zanussi85f2b082013-10-24 08:59:24 -05001630 void (*unreg)(char *glob,
1631 struct event_trigger_ops *ops,
1632 struct event_trigger_data *data,
Steven Rostedt (Red Hat)7f1d2f82015-05-05 10:09:53 -04001633 struct trace_event_file *file);
Tom Zanussia88e1cf2015-12-10 12:50:49 -06001634 void (*unreg_all)(struct trace_event_file *file);
Tom Zanussi85f2b082013-10-24 08:59:24 -05001635 int (*set_filter)(char *filter_str,
1636 struct event_trigger_data *data,
Steven Rostedt (Red Hat)7f1d2f82015-05-05 10:09:53 -04001637 struct trace_event_file *file);
Tom Zanussi85f2b082013-10-24 08:59:24 -05001638 struct event_trigger_ops *(*get_trigger_ops)(char *cmd, char *param);
1639};
1640
Steven Rostedt (Red Hat)353206f2016-02-22 15:55:09 -05001641/**
1642 * enum event_command_flags - flags for struct event_command
1643 *
1644 * @POST_TRIGGER: A flag that says whether or not this command needs
1645 * to have its action delayed until after the current event has
1646 * been closed. Some triggers need to avoid being invoked while
1647 * an event is currently in the process of being logged, since
1648 * the trigger may itself log data into the trace buffer. Thus
1649 * we make sure the current event is committed before invoking
1650 * those triggers. To do that, the trigger invocation is split
1651 * in two - the first part checks the filter using the current
1652 * trace record; if a command has the @post_trigger flag set, it
1653 * sets a bit for itself in the return value, otherwise it
1654 * directly invokes the trigger. Once all commands have been
1655 * either invoked or set their return flag, the current record is
1656 * either committed or discarded. At that point, if any commands
1657 * have deferred their triggers, those commands are finally
1658 * invoked following the close of the current event. In other
1659 * words, if the event_trigger_ops @func() probe implementation
1660 * itself logs to the trace buffer, this flag should be set,
1661 * otherwise it can be left unspecified.
1662 *
1663 * @NEEDS_REC: A flag that says whether or not this command needs
1664 * access to the trace record in order to perform its function,
1665 * regardless of whether or not it has a filter associated with
1666 * it (filters make a trigger require access to the trace record
1667 * but are not always present).
1668 */
1669enum event_command_flags {
1670 EVENT_CMD_FL_POST_TRIGGER = 1,
1671 EVENT_CMD_FL_NEEDS_REC = 2,
1672};
1673
1674static inline bool event_command_post_trigger(struct event_command *cmd_ops)
1675{
1676 return cmd_ops->flags & EVENT_CMD_FL_POST_TRIGGER;
1677}
1678
1679static inline bool event_command_needs_rec(struct event_command *cmd_ops)
1680{
1681 return cmd_ops->flags & EVENT_CMD_FL_NEEDS_REC;
1682}
1683
Steven Rostedt (Red Hat)7f1d2f82015-05-05 10:09:53 -04001684extern int trace_event_enable_disable(struct trace_event_file *file,
Tom Zanussi85f2b082013-10-24 08:59:24 -05001685 int enable, int soft_disable);
Tom Zanussi93e31ff2013-10-24 08:59:26 -05001686extern int tracing_alloc_snapshot(void);
Tom Zanussi85f2b082013-10-24 08:59:24 -05001687
Steven Rostedte9fb2b62009-03-12 14:19:25 -04001688extern const char *__start___trace_bprintk_fmt[];
1689extern const char *__stop___trace_bprintk_fmt[];
1690
Steven Rostedt (Red Hat)102c9322013-07-12 17:07:27 -04001691extern const char *__start___tracepoint_str[];
1692extern const char *__stop___tracepoint_str[];
1693
Steven Rostedt (Red Hat)b9f91082015-09-29 18:21:35 -04001694void trace_printk_control(bool enabled);
Steven Rostedt07d777f2011-09-22 14:01:55 -04001695void trace_printk_init_buffers(void);
Steven Rostedt81698832012-10-11 10:15:05 -04001696void trace_printk_start_comm(void);
Steven Rostedt (Red Hat)613f04a2013-03-14 15:03:53 -04001697int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set);
Steven Rostedt2b6080f2012-05-11 13:29:49 -04001698int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled);
Steven Rostedt07d777f2011-09-22 14:01:55 -04001699
Steven Rostedt (Red Hat)ca268da2013-03-09 00:40:58 -05001700/*
1701 * Normal trace_printk() and friends allocates special buffers
1702 * to do the manipulation, as well as saves the print formats
1703 * into sections to display. But the trace infrastructure wants
1704 * to use these without the added overhead at the price of being
1705 * a bit slower (used mainly for warnings, where we don't care
1706 * about performance). The internal_trace_puts() is for such
1707 * a purpose.
1708 */
1709#define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
1710
Steven Rostedt4e5292e2009-09-12 19:26:21 -04001711#undef FTRACE_ENTRY
Jiri Olsa02aa3162012-02-15 15:51:53 +01001712#define FTRACE_ENTRY(call, struct_name, id, tstruct, print, filter) \
Steven Rostedt (Red Hat)2425bcb2015-05-05 11:45:27 -04001713 extern struct trace_event_call \
Gideon Israel Dsouza52f5684c2014-04-07 15:39:20 -07001714 __aligned(4) event_##call;
Steven Rostedt4e5292e2009-09-12 19:26:21 -04001715#undef FTRACE_ENTRY_DUP
Jiri Olsa02aa3162012-02-15 15:51:53 +01001716#define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print, filter) \
1717 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1718 filter)
Namhyung Kima4a551b2016-06-29 19:56:48 +09001719#undef FTRACE_ENTRY_PACKED
1720#define FTRACE_ENTRY_PACKED(call, struct_name, id, tstruct, print, filter) \
1721 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1722 filter)
1723
Steven Rostedt4e5292e2009-09-12 19:26:21 -04001724#include "trace_entries.h"
Tom Zanussie1112b42009-03-31 00:48:49 -05001725
Mark Brown6e48b552012-04-13 09:52:59 +01001726#if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
Steven Rostedt (Red Hat)2425bcb2015-05-05 11:45:27 -04001727int perf_ftrace_event_register(struct trace_event_call *call,
Jiri Olsaced39002012-02-15 15:51:52 +01001728 enum trace_reg type, void *data);
1729#else
1730#define perf_ftrace_event_register NULL
Mark Brown6e48b552012-04-13 09:52:59 +01001731#endif
Jiri Olsaced39002012-02-15 15:51:52 +01001732
Steven Rostedt (Red Hat)5f893b22014-12-12 20:05:10 -05001733#ifdef CONFIG_FTRACE_SYSCALLS
1734void init_ftrace_syscalls(void);
Tom Zanussidbfeaa72015-12-10 12:50:46 -06001735const char *get_syscall_name(int syscall);
Steven Rostedt (Red Hat)5f893b22014-12-12 20:05:10 -05001736#else
1737static inline void init_ftrace_syscalls(void) { }
Tom Zanussidbfeaa72015-12-10 12:50:46 -06001738static inline const char *get_syscall_name(int syscall)
1739{
1740 return NULL;
1741}
Steven Rostedt (Red Hat)5f893b22014-12-12 20:05:10 -05001742#endif
1743
1744#ifdef CONFIG_EVENT_TRACING
1745void trace_event_init(void);
Steven Rostedt (Red Hat)0c564a52015-03-24 17:58:09 -04001746void trace_event_enum_update(struct trace_enum_map **map, int len);
Steven Rostedt (Red Hat)5f893b22014-12-12 20:05:10 -05001747#else
1748static inline void __init trace_event_init(void) { }
Steven Rostedt (Red Hat)cc9e4bd2015-06-25 18:19:37 -04001749static inline void trace_event_enum_update(struct trace_enum_map **map, int len) { }
Steven Rostedt (Red Hat)5f893b22014-12-12 20:05:10 -05001750#endif
1751
Steven Rostedt (Red Hat)0daa23022014-12-12 22:27:10 -05001752extern struct trace_iterator *tracepoint_print_iter;
Steven Rostedt (Red Hat)5f893b22014-12-12 20:05:10 -05001753
Steven Rostedtbc0c38d2008-05-12 21:20:42 +02001754#endif /* _LINUX_KERNEL_TRACE_H */