blob: 3fff4adfd431c5093fd5b8e5f53e41d2237e234b [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 Dsouza52f56842014-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>
Steven Rostedt95045042009-04-11 12:59:57 -040018
Steven Rostedt12ab74e2012-08-08 14:48:20 -040019#ifdef CONFIG_FTRACE_SYSCALLS
20#include <asm/unistd.h> /* For NR_SYSCALLS */
21#include <asm/syscall.h> /* some archs define it here */
22#endif
23
Thomas Gleixner72829bc2008-05-23 21:37:28 +020024enum trace_type {
25 __TRACE_FIRST_TYPE = 0,
26
27 TRACE_FN,
28 TRACE_CTX,
29 TRACE_WAKE,
30 TRACE_STACK,
Steven Rostedtdd0e5452008-08-01 12:26:41 -040031 TRACE_PRINT,
Frederic Weisbecker48ead022009-03-12 18:24:49 +010032 TRACE_BPRINT,
Pekka Paalanenbd8ac682008-05-12 21:20:57 +020033 TRACE_MMIO_RW,
34 TRACE_MMIO_MAP,
Steven Rostedt9f029e82008-11-12 15:24:24 -050035 TRACE_BRANCH,
Frederic Weisbecker287b6e62008-11-26 00:57:25 +010036 TRACE_GRAPH_RET,
37 TRACE_GRAPH_ENT,
Török Edwin02b67512008-11-22 13:28:47 +020038 TRACE_USER_STACK,
Arnaldo Carvalho de Meloc71a8962009-01-23 12:06:27 -020039 TRACE_BLK,
Steven Rostedt (Red Hat)09ae7232013-03-08 21:02:34 -050040 TRACE_BPUTS,
Thomas Gleixner72829bc2008-05-23 21:37:28 +020041
Steven Rostedtf0868d12008-12-23 23:24:12 -050042 __TRACE_LAST_TYPE,
Thomas Gleixner72829bc2008-05-23 21:37:28 +020043};
44
Frederic Weisbecker36994e52008-12-29 13:42:23 -080045
Steven Rostedt0a1c49d2009-09-12 19:17:15 -040046#undef __field
47#define __field(type, item) type item;
Frederic Weisbecker36994e52008-12-29 13:42:23 -080048
Steven Rostedtd7315092009-09-12 19:22:23 -040049#undef __field_struct
50#define __field_struct(type, item) __field(type, item)
51
52#undef __field_desc
53#define __field_desc(type, container, item)
54
Steven Rostedt0a1c49d2009-09-12 19:17:15 -040055#undef __array
56#define __array(type, item, size) type item[size];
57
Steven Rostedtd7315092009-09-12 19:22:23 -040058#undef __array_desc
59#define __array_desc(type, container, item, size)
60
Steven Rostedt0a1c49d2009-09-12 19:17:15 -040061#undef __dynamic_array
62#define __dynamic_array(type, item) type item[];
63
64#undef F_STRUCT
65#define F_STRUCT(args...) args
66
67#undef FTRACE_ENTRY
Jiri Olsa02aa3162012-02-15 15:51:53 +010068#define FTRACE_ENTRY(name, struct_name, id, tstruct, print, filter) \
69 struct struct_name { \
70 struct trace_entry ent; \
71 tstruct \
Steven Rostedt0a1c49d2009-09-12 19:17:15 -040072 }
73
Steven Rostedt0a1c49d2009-09-12 19:17:15 -040074#undef FTRACE_ENTRY_DUP
Jiri Olsa02aa3162012-02-15 15:51:53 +010075#define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk, filter)
Steven Rostedt0a1c49d2009-09-12 19:17:15 -040076
Jiri Olsae59a0bf2012-02-15 15:51:51 +010077#undef FTRACE_ENTRY_REG
Jiri Olsa02aa3162012-02-15 15:51:53 +010078#define FTRACE_ENTRY_REG(name, struct_name, id, tstruct, print, \
79 filter, regfn) \
80 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print), \
81 filter)
Jiri Olsae59a0bf2012-02-15 15:51:51 +010082
Steven Rostedt0a1c49d2009-09-12 19:17:15 -040083#include "trace_entries.h"
84
85/*
86 * syscalls are special, and need special handling, this is why
87 * they are not included in trace_entries.h
88 */
Frederic Weisbeckerbed1ffc2009-03-13 15:42:11 +010089struct syscall_trace_enter {
90 struct trace_entry ent;
91 int nr;
92 unsigned long args[];
93};
94
95struct syscall_trace_exit {
96 struct trace_entry ent;
97 int nr;
Tom Zanussi99df5a62009-11-25 01:14:59 -060098 long ret;
Frederic Weisbeckerbed1ffc2009-03-13 15:42:11 +010099};
100
Masami Hiramatsu93ccae72010-04-12 13:17:08 -0400101struct kprobe_trace_entry_head {
Masami Hiramatsu413d37d2009-08-13 16:35:11 -0400102 struct trace_entry ent;
103 unsigned long ip;
Masami Hiramatsu413d37d2009-08-13 16:35:11 -0400104};
105
Masami Hiramatsu93ccae72010-04-12 13:17:08 -0400106struct kretprobe_trace_entry_head {
Masami Hiramatsu413d37d2009-08-13 16:35:11 -0400107 struct trace_entry ent;
108 unsigned long func;
109 unsigned long ret_ip;
Masami Hiramatsu413d37d2009-08-13 16:35:11 -0400110};
111
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400112/*
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300113 * trace_flag_type is an enumeration that holds different
114 * states when a trace occurs. These are:
Steven Rostedt92444892008-10-24 09:42:59 -0400115 * IRQS_OFF - interrupts were disabled
Ingo Molnar9de36822009-03-06 17:52:03 +0100116 * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
Li Zefanbd9cfca2009-09-10 09:34:19 +0800117 * NEED_RESCHED - reschedule is requested
Steven Rostedt92444892008-10-24 09:42:59 -0400118 * HARDIRQ - inside an interrupt handler
119 * SOFTIRQ - inside a softirq handler
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300120 */
121enum trace_flag_type {
122 TRACE_FLAG_IRQS_OFF = 0x01,
Steven Rostedt92444892008-10-24 09:42:59 -0400123 TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
124 TRACE_FLAG_NEED_RESCHED = 0x04,
125 TRACE_FLAG_HARDIRQ = 0x08,
126 TRACE_FLAG_SOFTIRQ = 0x10,
Peter Zijlstrae5137b52013-10-04 17:28:26 +0200127 TRACE_FLAG_PREEMPT_RESCHED = 0x20,
Peter Zijlstra7e6867b2016-03-18 16:28:04 +0100128 TRACE_FLAG_NMI = 0x40,
Pekka Paalanenfc5e27a2008-09-16 22:02:27 +0300129};
130
Pekka Paalanen5bf9a1e2008-09-16 22:06:42 +0300131#define TRACE_BUF_SIZE 1024
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200132
Steven Rostedt2b6080f2012-05-11 13:29:49 -0400133struct trace_array;
134
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200135/*
136 * The CPU trace array - it consists of thousands of trace entries
137 * plus some other descriptor data: (for example which task started
138 * the trace, etc.)
139 */
140struct trace_array_cpu {
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200141 atomic_t disabled;
Steven Rostedt2cadf912008-12-01 22:20:19 -0500142 void *buffer_page; /* ring buffer spare */
Ingo Molnar4e3c3332008-05-12 21:20:45 +0200143
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -0800144 unsigned long entries;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200145 unsigned long saved_latency;
146 unsigned long critical_start;
147 unsigned long critical_end;
148 unsigned long critical_sequence;
149 unsigned long nice;
150 unsigned long policy;
151 unsigned long rt_priority;
Steven Rostedt2f26ebd2009-09-01 11:06:29 -0400152 unsigned long skipped_entries;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200153 cycle_t preempt_timestamp;
154 pid_t pid;
Eric W. Biedermand20b92a2012-03-13 16:02:19 -0700155 kuid_t uid;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200156 char comm[TASK_COMM_LEN];
Steven Rostedt (Red Hat)3fdaf802015-09-25 12:58:44 -0400157
158 bool ignore_pid;
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200159};
160
Steven Rostedt2b6080f2012-05-11 13:29:49 -0400161struct tracer;
Steven Rostedt (Red Hat)37aea982015-09-30 14:27:31 -0400162struct trace_option_dentry;
Steven Rostedt2b6080f2012-05-11 13:29:49 -0400163
Steven Rostedt (Red Hat)12883ef2013-03-05 09:24:35 -0500164struct trace_buffer {
165 struct trace_array *tr;
166 struct ring_buffer *buffer;
167 struct trace_array_cpu __percpu *data;
168 cycle_t time_start;
169 int cpu;
170};
171
Steven Rostedt (Red Hat)9a38a882015-09-30 11:11:15 -0400172#define TRACE_FLAGS_MAX_SIZE 32
173
Steven Rostedt (Red Hat)37aea982015-09-30 14:27:31 -0400174struct trace_options {
175 struct tracer *tracer;
176 struct trace_option_dentry *topts;
177};
178
Steven Rostedt (Red Hat)49090102015-09-24 11:33:26 -0400179struct trace_pid_list {
180 unsigned int nr_pids;
181 int order;
182 pid_t *pids;
183};
184
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200185/*
186 * The trace array - an array of per-CPU trace arrays. This is the
187 * highest level data structure that individual tracers deal with.
188 * They have on/off state as well:
189 */
190struct trace_array {
Steven Rostedtae63b312012-05-03 23:09:03 -0400191 struct list_head list;
Steven Rostedt277ba042012-08-03 16:10:49 -0400192 char *name;
Steven Rostedt (Red Hat)12883ef2013-03-05 09:24:35 -0500193 struct trace_buffer trace_buffer;
194#ifdef CONFIG_TRACER_MAX_TRACE
195 /*
196 * The max_buffer is used to snapshot the trace when a maximum
197 * latency is reached, or when the user initiates a snapshot.
198 * Some tracers will use this to store a maximum trace while
199 * it continues examining live traces.
200 *
201 * The buffers for the max_buffer are set up the same as the trace_buffer
202 * When a snapshot is taken, the buffer of the max_buffer is swapped
203 * with the buffer of the trace_buffer and the buffers are reset for
204 * the trace_buffer so the tracing can continue.
205 */
206 struct trace_buffer max_buffer;
Steven Rostedt (Red Hat)45ad21c2013-03-05 18:25:02 -0500207 bool allocated_snapshot;
Steven Rostedt (Red Hat)6d9b3fa2014-01-14 11:28:38 -0500208 unsigned long max_latency;
Steven Rostedt (Red Hat)12883ef2013-03-05 09:24:35 -0500209#endif
Steven Rostedt (Red Hat)49090102015-09-24 11:33:26 -0400210 struct trace_pid_list __rcu *filtered_pids;
Steven Rostedt (Red Hat)0b9b12c2014-01-14 10:04:59 -0500211 /*
212 * max_lock is used to protect the swapping of buffers
213 * when taking a max snapshot. The buffers themselves are
214 * protected by per_cpu spinlocks. But the action of the swap
215 * needs its own lock.
216 *
217 * This is defined as a arch_spinlock_t in order to help
218 * with performance when lockdep debugging is enabled.
219 *
220 * It is also used in other places outside the update_max_tr
221 * so it needs to be defined outside of the
222 * CONFIG_TRACER_MAX_TRACE.
223 */
224 arch_spinlock_t max_lock;
Steven Rostedt499e5472012-02-22 15:50:28 -0500225 int buffer_disabled;
Steven Rostedt12ab74e2012-08-08 14:48:20 -0400226#ifdef CONFIG_FTRACE_SYSCALLS
227 int sys_refcount_enter;
228 int sys_refcount_exit;
Steven Rostedt (Red Hat)7f1d2f82015-05-05 10:09:53 -0400229 struct trace_event_file __rcu *enter_syscall_files[NR_syscalls];
230 struct trace_event_file __rcu *exit_syscall_files[NR_syscalls];
Steven Rostedt12ab74e2012-08-08 14:48:20 -0400231#endif
Steven Rostedt2b6080f2012-05-11 13:29:49 -0400232 int stop_count;
233 int clock_id;
Steven Rostedt (Red Hat)37aea982015-09-30 14:27:31 -0400234 int nr_topts;
Steven Rostedt2b6080f2012-05-11 13:29:49 -0400235 struct tracer *current_trace;
Steven Rostedt (Red Hat)983f9382015-09-30 09:42:05 -0400236 unsigned int trace_flags;
Steven Rostedt (Red Hat)9a38a882015-09-30 11:11:15 -0400237 unsigned char trace_flags_index[TRACE_FLAGS_MAX_SIZE];
Steven Rostedtae63b312012-05-03 23:09:03 -0400238 unsigned int flags;
Steven Rostedt2b6080f2012-05-11 13:29:49 -0400239 raw_spinlock_t start_lock;
Steven Rostedtae63b312012-05-03 23:09:03 -0400240 struct dentry *dir;
Steven Rostedt2b6080f2012-05-11 13:29:49 -0400241 struct dentry *options;
242 struct dentry *percpu_dir;
Steven Rostedtae63b312012-05-03 23:09:03 -0400243 struct dentry *event_dir;
Steven Rostedt (Red Hat)37aea982015-09-30 14:27:31 -0400244 struct trace_options *topts;
Steven Rostedtae63b312012-05-03 23:09:03 -0400245 struct list_head systems;
246 struct list_head events;
Alexander Z Lamccfe9e42013-08-08 09:47:45 -0700247 cpumask_var_t tracing_cpumask; /* only trace on set CPUs */
Steven Rostedt (Red Hat)a695cb52013-03-06 15:27:24 -0500248 int ref;
Steven Rostedt (Red Hat)f20a5802013-11-07 20:08:58 -0500249#ifdef CONFIG_FUNCTION_TRACER
250 struct ftrace_ops *ops;
251 /* function tracing enabled */
252 int function_enabled;
253#endif
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200254};
255
Steven Rostedtae63b312012-05-03 23:09:03 -0400256enum {
257 TRACE_ARRAY_FL_GLOBAL = (1 << 0)
258};
259
260extern struct list_head ftrace_trace_arrays;
261
Alexander Z Lama8227412013-07-01 19:37:54 -0700262extern struct mutex trace_types_lock;
263
Steven Rostedt (Red Hat)8e2e2fa2013-07-02 15:30:53 -0400264extern int trace_array_get(struct trace_array *tr);
265extern void trace_array_put(struct trace_array *tr);
266
Steven Rostedtae63b312012-05-03 23:09:03 -0400267/*
268 * The global tracer (top) should be the first trace array added,
269 * but we check the flag anyway.
270 */
271static inline struct trace_array *top_trace_array(void)
272{
273 struct trace_array *tr;
274
Steven Rostedt (Red Hat)da9c3412014-06-10 13:53:50 -0400275 if (list_empty(&ftrace_trace_arrays))
Yoshihiro YUNOMAEdc81e5e2014-06-06 07:35:17 +0900276 return NULL;
277
Steven Rostedtae63b312012-05-03 23:09:03 -0400278 tr = list_entry(ftrace_trace_arrays.prev,
279 typeof(*tr), list);
280 WARN_ON(!(tr->flags & TRACE_ARRAY_FL_GLOBAL));
281 return tr;
282}
283
Steven Rostedt7104f302008-10-01 10:52:51 -0400284#define FTRACE_CMP_TYPE(var, type) \
285 __builtin_types_compatible_p(typeof(var), type *)
286
287#undef IF_ASSIGN
288#define IF_ASSIGN(var, entry, etype, id) \
289 if (FTRACE_CMP_TYPE(var, etype)) { \
290 var = (typeof(var))(entry); \
291 WARN_ON(id && (entry)->type != id); \
292 break; \
293 }
294
295/* Will cause compile errors if type is not found. */
296extern void __ftrace_bad_type(void);
297
298/*
299 * The trace_assign_type is a verifier that the entry type is
300 * the same as the type being assigned. To add new types simply
301 * add a line with the following format:
302 *
303 * IF_ASSIGN(var, ent, type, id);
304 *
305 * Where "type" is the trace type that includes the trace_entry
306 * as the "ent" item. And "id" is the trace identifier that is
307 * used in the trace_type enum.
308 *
309 * If the type can have more than one id, then use zero.
310 */
311#define trace_assign_type(var, ent) \
312 do { \
313 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
314 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
Steven Rostedt7104f302008-10-01 10:52:51 -0400315 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
Török Edwin02b67512008-11-22 13:28:47 +0200316 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
Steven Rostedt7104f302008-10-01 10:52:51 -0400317 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100318 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
Steven Rostedt (Red Hat)09ae7232013-03-08 21:02:34 -0500319 IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS); \
Steven Rostedt7104f302008-10-01 10:52:51 -0400320 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
321 TRACE_MMIO_RW); \
322 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
323 TRACE_MMIO_MAP); \
Steven Rostedt9f029e82008-11-12 15:24:24 -0500324 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
Frederic Weisbecker287b6e62008-11-26 00:57:25 +0100325 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
326 TRACE_GRAPH_ENT); \
327 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
328 TRACE_GRAPH_RET); \
Steven Rostedt7104f302008-10-01 10:52:51 -0400329 __ftrace_bad_type(); \
330 } while (0)
Frederic Weisbecker2c4f0352008-09-29 20:18:34 +0200331
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100332/*
333 * An option specific to a tracer. This is a boolean value.
334 * The bit is the bit index that sets its value on the
335 * flags value in struct tracer_flags.
336 */
337struct tracer_opt {
Ingo Molnar9de36822009-03-06 17:52:03 +0100338 const char *name; /* Will appear on the trace_options file */
339 u32 bit; /* Mask assigned in val field in tracer_flags */
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100340};
341
342/*
343 * The set of specific options for a tracer. Your tracer
344 * have to set the initial value of the flags val.
345 */
346struct tracer_flags {
347 u32 val;
Ingo Molnar9de36822009-03-06 17:52:03 +0100348 struct tracer_opt *opts;
Chunyu Hud39cdd22016-03-08 21:37:01 +0800349 struct tracer *trace;
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100350};
351
352/* Makes more easy to define a tracer opt */
353#define TRACER_OPT(s, b) .name = #s, .bit = b
354
Frederic Weisbecker034939b2009-01-08 10:03:56 -0800355
Steven Rostedt (Red Hat)41d9c0b2015-09-29 17:31:55 -0400356struct trace_option_dentry {
357 struct tracer_opt *opt;
358 struct tracer_flags *flags;
359 struct trace_array *tr;
360 struct dentry *entry;
361};
362
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100363/**
Steven Rostedt (Red Hat)8434dc92015-01-20 12:13:40 -0500364 * struct tracer - a specific tracer and its callbacks to interact with tracefs
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100365 * @name: the name chosen to select it on the available_tracers file
366 * @init: called when one switches to this tracer (echo name > current_tracer)
367 * @reset: called when one switches to another tracer
Chuyu Hu05a724b2015-12-22 09:44:33 -0500368 * @start: called when tracing is unpaused (echo 1 > tracing_on)
369 * @stop: called when tracing is paused (echo 0 > tracing_on)
Stanislav Fomichev6508fa72014-07-18 15:17:27 +0400370 * @update_thresh: called when tracing_thresh is updated
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100371 * @open: called when the trace file is opened
372 * @pipe_open: called when the trace_pipe file is opened
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100373 * @close: called when the trace file is released
Steven Rostedtc521efd2009-12-07 09:06:24 -0500374 * @pipe_close: called when the trace_pipe file is released
Frederic Weisbecker6eaaa5d2009-02-11 02:25:00 +0100375 * @read: override the default read callback on trace_pipe
376 * @splice_read: override the default splice_read callback on trace_pipe
377 * @selftest: selftest to run on boot (see trace_selftest.c)
378 * @print_headers: override the first lines that describe your columns
379 * @print_line: callback that prints a trace
380 * @set_flag: signals one of your private flags changed (trace_options file)
381 * @flags: your private flags
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200382 */
383struct tracer {
384 const char *name;
Frederic Weisbecker1c800252008-11-16 05:57:26 +0100385 int (*init)(struct trace_array *tr);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200386 void (*reset)(struct trace_array *tr);
Steven Rostedt90369902008-11-05 16:05:44 -0500387 void (*start)(struct trace_array *tr);
388 void (*stop)(struct trace_array *tr);
Stanislav Fomichev6508fa72014-07-18 15:17:27 +0400389 int (*update_thresh)(struct trace_array *tr);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200390 void (*open)(struct trace_iterator *iter);
Steven Rostedt107bad82008-05-12 21:21:01 +0200391 void (*pipe_open)(struct trace_iterator *iter);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200392 void (*close)(struct trace_iterator *iter);
Steven Rostedtc521efd2009-12-07 09:06:24 -0500393 void (*pipe_close)(struct trace_iterator *iter);
Steven Rostedt107bad82008-05-12 21:21:01 +0200394 ssize_t (*read)(struct trace_iterator *iter,
395 struct file *filp, char __user *ubuf,
396 size_t cnt, loff_t *ppos);
Eduard - Gabriel Munteanu3c568192009-02-09 08:15:56 +0200397 ssize_t (*splice_read)(struct trace_iterator *iter,
398 struct file *filp,
399 loff_t *ppos,
400 struct pipe_inode_info *pipe,
401 size_t len,
402 unsigned int flags);
Steven Rostedt60a11772008-05-12 21:20:44 +0200403#ifdef CONFIG_FTRACE_STARTUP_TEST
404 int (*selftest)(struct tracer *trace,
405 struct trace_array *tr);
406#endif
Markus Metzger8bba1bf2008-11-25 09:12:31 +0100407 void (*print_header)(struct seq_file *m);
Frederic Weisbecker2c4f0352008-09-29 20:18:34 +0200408 enum print_line_t (*print_line)(struct trace_iterator *iter);
Frederic Weisbeckeradf9f192008-11-17 19:23:42 +0100409 /* If you handled the flag setting, return 0 */
Steven Rostedt (Red Hat)8c1a49a2014-01-10 11:13:54 -0500410 int (*set_flag)(struct trace_array *tr,
411 u32 old_flags, u32 bit, int set);
Steven Rostedt (Red Hat)613f04a2013-03-14 15:03:53 -0400412 /* Return 0 if OK with change, else return non-zero */
Steven Rostedt (Red Hat)bf6065b2014-01-10 17:51:01 -0500413 int (*flag_changed)(struct trace_array *tr,
Steven Rostedt (Red Hat)613f04a2013-03-14 15:03:53 -0400414 u32 mask, int set);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200415 struct tracer *next;
Ingo Molnar9de36822009-03-06 17:52:03 +0100416 struct tracer_flags *flags;
Steven Rostedt (Red Hat)50512ab2014-01-14 08:52:35 -0500417 int enabled;
Steven Rostedt (Red Hat)cf6ab6d2014-12-15 20:13:31 -0500418 int ref;
Hiraku Toyookaf43c7382012-10-02 17:27:10 +0900419 bool print_max;
Steven Rostedt (Red Hat)607e2ea2013-11-06 22:42:48 -0500420 bool allow_instances;
Steven Rostedt (Red Hat)12883ef2013-03-05 09:24:35 -0500421#ifdef CONFIG_TRACER_MAX_TRACE
Hiraku Toyookaf43c7382012-10-02 17:27:10 +0900422 bool use_max_tr;
Steven Rostedt (Red Hat)12883ef2013-03-05 09:24:35 -0500423#endif
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200424};
425
Steven Rostedtf9520752009-03-02 14:04:40 -0500426
Steven Rostedte4a3f542011-06-14 19:02:29 -0400427/* Only current can touch trace_recursion */
Steven Rostedte4a3f542011-06-14 19:02:29 -0400428
Steven Rostedtedc15ca2012-11-02 17:47:21 -0400429/*
430 * For function tracing recursion:
431 * The order of these bits are important.
432 *
433 * When function tracing occurs, the following steps are made:
434 * If arch does not support a ftrace feature:
435 * call internal function (uses INTERNAL bits) which calls...
436 * If callback is registered to the "global" list, the list
437 * function is called and recursion checks the GLOBAL bits.
438 * then this function calls...
439 * The function callback, which can use the FTRACE bits to
440 * check for recursion.
441 *
442 * Now if the arch does not suppport a feature, and it calls
443 * the global list function which calls the ftrace callback
444 * all three of these steps will do a recursion protection.
445 * There's no reason to do one if the previous caller already
446 * did. The recursion that we are protecting against will
447 * go through the same steps again.
448 *
449 * To prevent the multiple recursion checks, if a recursion
450 * bit is set that is higher than the MAX bit of the current
451 * check, then we know that the check was made by the previous
452 * caller, and we can skip the current check.
453 */
Steven Rostedte46cbf72012-11-02 17:32:25 -0400454enum {
Steven Rostedt567cd4d2012-11-02 18:33:05 -0400455 TRACE_BUFFER_BIT,
456 TRACE_BUFFER_NMI_BIT,
457 TRACE_BUFFER_IRQ_BIT,
458 TRACE_BUFFER_SIRQ_BIT,
459
460 /* Start of function recursion bits */
461 TRACE_FTRACE_BIT,
Steven Rostedtedc15ca2012-11-02 17:47:21 -0400462 TRACE_FTRACE_NMI_BIT,
463 TRACE_FTRACE_IRQ_BIT,
464 TRACE_FTRACE_SIRQ_BIT,
Steven Rostedte46cbf72012-11-02 17:32:25 -0400465
Steven Rostedt (Red Hat)4104d322014-01-10 17:01:58 -0500466 /* INTERNAL_BITs must be greater than FTRACE_BITs */
Steven Rostedtedc15ca2012-11-02 17:47:21 -0400467 TRACE_INTERNAL_BIT,
468 TRACE_INTERNAL_NMI_BIT,
469 TRACE_INTERNAL_IRQ_BIT,
470 TRACE_INTERNAL_SIRQ_BIT,
471
Steven Rostedt (Red Hat)6224beb2015-07-07 15:05:03 -0400472 TRACE_BRANCH_BIT,
Steven Rostedte4a3f542011-06-14 19:02:29 -0400473/*
474 * Abuse of the trace_recursion.
475 * As we need a way to maintain state if we are tracing the function
476 * graph in irq because we want to trace a particular function that
477 * was called in irq context but we have irq tracing off. Since this
478 * can only be modified by current, we can reuse trace_recursion.
479 */
Steven Rostedte46cbf72012-11-02 17:32:25 -0400480 TRACE_IRQ_BIT,
481};
Steven Rostedte4a3f542011-06-14 19:02:29 -0400482
Steven Rostedte46cbf72012-11-02 17:32:25 -0400483#define trace_recursion_set(bit) do { (current)->trace_recursion |= (1<<(bit)); } while (0)
484#define trace_recursion_clear(bit) do { (current)->trace_recursion &= ~(1<<(bit)); } while (0)
485#define trace_recursion_test(bit) ((current)->trace_recursion & (1<<(bit)))
Steven Rostedte4a3f542011-06-14 19:02:29 -0400486
Steven Rostedtedc15ca2012-11-02 17:47:21 -0400487#define TRACE_CONTEXT_BITS 4
488
489#define TRACE_FTRACE_START TRACE_FTRACE_BIT
490#define TRACE_FTRACE_MAX ((1 << (TRACE_FTRACE_START + TRACE_CONTEXT_BITS)) - 1)
491
Steven Rostedtedc15ca2012-11-02 17:47:21 -0400492#define TRACE_LIST_START TRACE_INTERNAL_BIT
493#define TRACE_LIST_MAX ((1 << (TRACE_LIST_START + TRACE_CONTEXT_BITS)) - 1)
494
495#define TRACE_CONTEXT_MASK TRACE_LIST_MAX
496
497static __always_inline int trace_get_context_bit(void)
498{
499 int bit;
500
501 if (in_interrupt()) {
502 if (in_nmi())
503 bit = 0;
504
505 else if (in_irq())
506 bit = 1;
507 else
508 bit = 2;
509 } else
510 bit = 3;
511
512 return bit;
513}
514
515static __always_inline int trace_test_and_set_recursion(int start, int max)
516{
517 unsigned int val = current->trace_recursion;
518 int bit;
519
520 /* A previous recursion check was made */
521 if ((val & TRACE_CONTEXT_MASK) > max)
522 return 0;
523
524 bit = trace_get_context_bit() + start;
525 if (unlikely(val & (1 << bit)))
526 return -1;
527
528 val |= 1 << bit;
529 current->trace_recursion = val;
530 barrier();
531
532 return bit;
533}
534
535static __always_inline void trace_clear_recursion(int bit)
536{
537 unsigned int val = current->trace_recursion;
538
539 if (!bit)
540 return;
541
542 bit = 1 << bit;
543 val &= ~bit;
544
545 barrier();
546 current->trace_recursion = val;
547}
548
Steven Rostedt6d158a82012-06-27 20:46:14 -0400549static inline struct ring_buffer_iter *
550trace_buffer_iter(struct trace_iterator *iter, int cpu)
551{
552 if (iter->buffer_iter && iter->buffer_iter[cpu])
553 return iter->buffer_iter[cpu];
554 return NULL;
555}
556
Arnaldo Carvalho de Melob6f11df2009-02-05 18:02:00 -0200557int tracer_init(struct tracer *t, struct trace_array *tr);
Steven Rostedt90369902008-11-05 16:05:44 -0500558int tracing_is_enabled(void);
Steven Rostedt (Red Hat)12883ef2013-03-05 09:24:35 -0500559void tracing_reset(struct trace_buffer *buf, int cpu);
560void tracing_reset_online_cpus(struct trace_buffer *buf);
Steven Rostedt9456f0f2009-05-06 21:54:09 -0400561void tracing_reset_current(int cpu);
Steven Rostedt (Red Hat)873c6422013-03-04 23:26:06 -0500562void tracing_reset_all_online_cpus(void);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200563int tracing_open_generic(struct inode *inode, struct file *filp);
Geyslan G. Bem2e864212013-10-18 21:15:54 -0300564bool tracing_is_disabled(void);
Frederic Weisbecker5452af62009-03-27 00:25:38 +0100565struct dentry *trace_create_file(const char *name,
Al Virof4ae40a2011-07-24 04:33:43 -0400566 umode_t mode,
Frederic Weisbecker5452af62009-03-27 00:25:38 +0100567 struct dentry *parent,
568 void *data,
569 const struct file_operations *fops);
570
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200571struct dentry *tracing_init_dentry(void);
Ingo Molnard618b3e2008-05-12 21:20:49 +0200572
Arnaldo Carvalho de Melo51a763d2009-02-05 16:14:13 -0200573struct ring_buffer_event;
574
Steven Rostedte77405a2009-09-02 14:17:06 -0400575struct ring_buffer_event *
576trace_buffer_lock_reserve(struct ring_buffer *buffer,
577 int type,
578 unsigned long len,
579 unsigned long flags,
580 int pc);
Arnaldo Carvalho de Melo51a763d2009-02-05 16:14:13 -0200581
Pekka Paalanen45dcd8b2008-09-16 21:56:41 +0300582struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
583 struct trace_array_cpu *data);
Frederic Weisbeckerc4a8e8b2009-02-02 20:29:21 -0200584
585struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
586 int *ent_cpu, u64 *ent_ts);
587
Steven Rostedt7ffbd482012-10-11 12:14:25 -0400588void __buffer_unlock_commit(struct ring_buffer *buffer,
589 struct ring_buffer_event *event);
590
Jason Wessel955b61e2010-08-05 09:22:23 -0500591int trace_empty(struct trace_iterator *iter);
592
593void *trace_find_next_entry_inc(struct trace_iterator *iter);
594
595void trace_init_global_iter(struct trace_iterator *iter);
596
597void tracing_iter_reset(struct trace_iterator *iter, int cpu);
598
Steven Rostedt6fb44b72008-05-12 21:20:49 +0200599void trace_function(struct trace_array *tr,
Steven Rostedt6fb44b72008-05-12 21:20:49 +0200600 unsigned long ip,
601 unsigned long parent_ip,
Steven Rostedt38697052008-10-01 13:14:09 -0400602 unsigned long flags, int pc);
Jiri Olsa0a772622010-09-23 14:00:52 +0200603void trace_graph_function(struct trace_array *tr,
604 unsigned long ip,
605 unsigned long parent_ip,
606 unsigned long flags, int pc);
Jiri Olsa7e9a49e2011-11-07 16:08:49 +0100607void trace_latency_header(struct seq_file *m);
Jiri Olsa62b915f2010-04-02 19:01:22 +0200608void trace_default_header(struct seq_file *m);
609void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
610int trace_empty(struct trace_iterator *iter);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200611
Frederic Weisbecker287b6e62008-11-26 00:57:25 +0100612void trace_graph_return(struct ftrace_graph_ret *trace);
Steven Rostedte49dc192008-12-02 23:50:05 -0500613int trace_graph_entry(struct ftrace_graph_ent *trace);
Frederic Weisbecker1a0799a2009-07-29 18:59:58 +0200614void set_graph_array(struct trace_array *tr);
Markus Metzger1e9b51c2008-11-25 09:24:15 +0100615
Steven Rostedt41bc8142008-05-22 11:49:22 -0400616void tracing_start_cmdline_record(void);
617void tracing_stop_cmdline_record(void);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200618int register_tracer(struct tracer *type);
Carsten Emdeb5130b12009-09-13 01:43:07 +0200619int is_tracing_stopped(void);
Jason Wessel955b61e2010-08-05 09:22:23 -0500620
Steven Rostedt (Red Hat)098c8792013-12-21 17:39:40 -0500621loff_t tracing_lseek(struct file *file, loff_t offset, int whence);
622
Jason Wessel955b61e2010-08-05 09:22:23 -0500623extern cpumask_var_t __read_mostly tracing_buffer_mask;
624
625#define for_each_tracing_cpu(cpu) \
626 for_each_cpu(cpu, tracing_buffer_mask)
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200627
628extern unsigned long nsecs_to_usecs(unsigned long nsecs);
629
Tim Bird0e950172010-02-25 15:36:43 -0800630extern unsigned long tracing_thresh;
631
Steven Rostedt5d4a9db2009-08-27 16:52:21 -0400632#ifdef CONFIG_TRACER_MAX_TRACE
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200633void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
634void update_max_tr_single(struct trace_array *tr,
635 struct task_struct *tsk, int cpu);
Steven Rostedt5d4a9db2009-08-27 16:52:21 -0400636#endif /* CONFIG_TRACER_MAX_TRACE */
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200637
Frederic Weisbeckerc0a0d0d2009-07-29 17:51:13 +0200638#ifdef CONFIG_STACKTRACE
Steven Rostedte77405a2009-09-02 14:17:06 -0400639void ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags,
Frederic Weisbeckerc0a0d0d2009-07-29 17:51:13 +0200640 int pc);
641
642void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
643 int pc);
644#else
Li Zefane1f79922010-05-10 11:23:00 +0800645static inline void ftrace_trace_userstack(struct ring_buffer *buffer,
Frederic Weisbeckerc0a0d0d2009-07-29 17:51:13 +0200646 unsigned long flags, int pc)
647{
648}
649
650static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
651 int skip, int pc)
652{
653}
654#endif /* CONFIG_STACKTRACE */
Steven Rostedt53614992009-01-15 19:12:40 -0500655
Ingo Molnare309b412008-05-12 21:20:51 +0200656extern cycle_t ftrace_now(int cpu);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200657
Steven Rostedt4ca53082009-03-16 19:20:15 -0400658extern void trace_find_cmdline(int pid, char comm[]);
Ingo Molnarf7d48cb2008-12-29 13:02:17 +0100659
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200660#ifdef CONFIG_DYNAMIC_FTRACE
661extern unsigned long ftrace_update_tot_cnt;
Steven Rostedtad977722012-07-20 13:45:59 -0400662#endif
Steven Rostedtd05cdb22008-05-12 21:20:54 +0200663#define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
664extern int DYN_FTRACE_TEST_NAME(void);
Steven Rostedt95950c22011-05-06 00:08:51 -0400665#define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
666extern int DYN_FTRACE_TEST_NAME2(void);
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200667
Steven Rostedt (Red Hat)55034cd2013-03-07 22:48:09 -0500668extern bool ring_buffer_expanded;
Li Zefan020e5f82009-07-01 10:47:05 +0800669extern bool tracing_selftest_disabled;
670
Steven Rostedt60a11772008-05-12 21:20:44 +0200671#ifdef CONFIG_FTRACE_STARTUP_TEST
Steven Rostedt60a11772008-05-12 21:20:44 +0200672extern int trace_selftest_startup_function(struct tracer *trace,
673 struct trace_array *tr);
Frederic Weisbecker7447dce2009-02-07 21:33:57 +0100674extern int trace_selftest_startup_function_graph(struct tracer *trace,
675 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200676extern int trace_selftest_startup_irqsoff(struct tracer *trace,
677 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200678extern int trace_selftest_startup_preemptoff(struct tracer *trace,
679 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200680extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
681 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200682extern int trace_selftest_startup_wakeup(struct tracer *trace,
683 struct trace_array *tr);
Steven Noonanfb1b6d82008-09-19 03:06:43 -0700684extern int trace_selftest_startup_nop(struct tracer *trace,
685 struct trace_array *tr);
Steven Rostedt60a11772008-05-12 21:20:44 +0200686extern int trace_selftest_startup_sched_switch(struct tracer *trace,
687 struct trace_array *tr);
Steven Rostedt80e5ea42008-11-12 15:24:24 -0500688extern int trace_selftest_startup_branch(struct tracer *trace,
689 struct trace_array *tr);
Steven Rostedt (Red Hat)8f768992013-07-18 14:41:51 -0400690/*
691 * Tracer data references selftest functions that only occur
692 * on boot up. These can be __init functions. Thus, when selftests
693 * are enabled, then the tracers need to reference __init functions.
694 */
695#define __tracer_data __refdata
696#else
697/* Tracers are seldom changed. Optimize when selftests are disabled. */
698#define __tracer_data __read_mostly
Steven Rostedt60a11772008-05-12 21:20:44 +0200699#endif /* CONFIG_FTRACE_STARTUP_TEST */
700
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200701extern void *head_page(struct trace_array_cpu *data);
Lai Jiangshancf8e3472009-03-30 13:48:00 +0800702extern unsigned long long ns2usecs(cycle_t nsec);
Frederic Weisbecker1fd8f2a2008-12-03 23:45:11 +0100703extern int
Steven Rostedt40ce74f2009-03-19 14:03:53 -0400704trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
Frederic Weisbecker48ead022009-03-12 18:24:49 +0100705extern int
Steven Rostedt40ce74f2009-03-19 14:03:53 -0400706trace_vprintk(unsigned long ip, const char *fmt, va_list args);
Steven Rostedt659372d2009-09-03 19:11:07 -0400707extern int
708trace_array_vprintk(struct trace_array *tr,
709 unsigned long ip, const char *fmt, va_list args);
710int trace_array_printk(struct trace_array *tr,
711 unsigned long ip, const char *fmt, ...);
Steven Rostedt (Red Hat)12883ef2013-03-05 09:24:35 -0500712int trace_array_printk_buf(struct ring_buffer *buffer,
713 unsigned long ip, const char *fmt, ...);
Jason Wessel955b61e2010-08-05 09:22:23 -0500714void trace_printk_seq(struct trace_seq *s);
715enum print_line_t print_trace_line(struct trace_iterator *iter);
Ingo Molnarc7aafc52008-05-12 21:20:45 +0200716
Byungchul Park8e1e1df2014-11-24 09:34:19 +0900717extern char trace_find_mark(unsigned long long duration);
718
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100719/* Standard output formatting function used for function return traces */
Frederic Weisbeckerfb526072008-11-25 21:07:04 +0100720#ifdef CONFIG_FUNCTION_GRAPH_TRACER
Jiri Olsa62b915f2010-04-02 19:01:22 +0200721
722/* Flag options */
723#define TRACE_GRAPH_PRINT_OVERRUN 0x1
724#define TRACE_GRAPH_PRINT_CPU 0x2
725#define TRACE_GRAPH_PRINT_OVERHEAD 0x4
726#define TRACE_GRAPH_PRINT_PROC 0x8
727#define TRACE_GRAPH_PRINT_DURATION 0x10
728#define TRACE_GRAPH_PRINT_ABS_TIME 0x20
Robert Elliottccdb5942014-05-20 17:10:36 -0500729#define TRACE_GRAPH_PRINT_IRQS 0x40
Robert Elliott607e3a22014-05-20 17:10:51 -0500730#define TRACE_GRAPH_PRINT_TAIL 0x80
Steven Rostedt (Red Hat)55577202015-09-29 19:06:50 -0400731#define TRACE_GRAPH_SLEEP_TIME 0x100
732#define TRACE_GRAPH_GRAPH_TIME 0x200
Steven Rostedt (Red Hat)6fc84ea2013-11-06 14:50:06 -0500733#define TRACE_GRAPH_PRINT_FILL_SHIFT 28
734#define TRACE_GRAPH_PRINT_FILL_MASK (0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT)
Jiri Olsa62b915f2010-04-02 19:01:22 +0200735
Steven Rostedt (Red Hat)55577202015-09-29 19:06:50 -0400736extern void ftrace_graph_sleep_time_control(bool enable);
737extern void ftrace_graph_graph_time_control(bool enable);
738
Jiri Olsad7a8d9e2010-04-02 19:01:21 +0200739extern enum print_line_t
740print_graph_function_flags(struct trace_iterator *iter, u32 flags);
741extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
Steven Rostedt (Red Hat)9d9add32014-11-12 14:57:38 -0500742extern void
Steven Rostedt0706f1c2009-03-23 23:12:58 -0400743trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
Jiri Olsa62b915f2010-04-02 19:01:22 +0200744extern void graph_trace_open(struct trace_iterator *iter);
745extern void graph_trace_close(struct trace_iterator *iter);
746extern int __trace_graph_entry(struct trace_array *tr,
747 struct ftrace_graph_ent *trace,
748 unsigned long flags, int pc);
749extern void __trace_graph_return(struct trace_array *tr,
750 struct ftrace_graph_ret *trace,
751 unsigned long flags, int pc);
752
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500753
754#ifdef CONFIG_DYNAMIC_FTRACE
755/* TODO: make this variable */
756#define FTRACE_GRAPH_MAX_FUNCS 32
757extern int ftrace_graph_count;
758extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
Namhyung Kim29ad23b2013-10-14 17:24:26 +0900759extern int ftrace_graph_notrace_count;
760extern unsigned long ftrace_graph_notrace_funcs[FTRACE_GRAPH_MAX_FUNCS];
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500761
762static inline int ftrace_graph_addr(unsigned long addr)
763{
764 int i;
765
Namhyung Kim9aa72b42013-10-14 17:24:23 +0900766 if (!ftrace_graph_count)
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500767 return 1;
768
769 for (i = 0; i < ftrace_graph_count; i++) {
Steven Rostedte4a3f542011-06-14 19:02:29 -0400770 if (addr == ftrace_graph_funcs[i]) {
771 /*
772 * If no irqs are to be traced, but a set_graph_function
773 * is set, and called by an interrupt handler, we still
774 * want to trace it.
775 */
776 if (in_irq())
777 trace_recursion_set(TRACE_IRQ_BIT);
778 else
779 trace_recursion_clear(TRACE_IRQ_BIT);
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500780 return 1;
Steven Rostedte4a3f542011-06-14 19:02:29 -0400781 }
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500782 }
783
784 return 0;
785}
Namhyung Kim29ad23b2013-10-14 17:24:26 +0900786
787static inline int ftrace_graph_notrace_addr(unsigned long addr)
788{
789 int i;
790
791 if (!ftrace_graph_notrace_count)
792 return 0;
793
794 for (i = 0; i < ftrace_graph_notrace_count; i++) {
795 if (addr == ftrace_graph_notrace_funcs[i])
796 return 1;
797 }
798
799 return 0;
800}
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100801#else
Ingo Molnar6b253932008-12-04 09:18:28 +0100802static inline int ftrace_graph_addr(unsigned long addr)
803{
804 return 1;
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500805}
Namhyung Kim29ad23b2013-10-14 17:24:26 +0900806
807static inline int ftrace_graph_notrace_addr(unsigned long addr)
808{
809 return 0;
810}
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500811#endif /* CONFIG_DYNAMIC_FTRACE */
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500812#else /* CONFIG_FUNCTION_GRAPH_TRACER */
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100813static inline enum print_line_t
Jiri Olsad7a8d9e2010-04-02 19:01:21 +0200814print_graph_function_flags(struct trace_iterator *iter, u32 flags)
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100815{
816 return TRACE_TYPE_UNHANDLED;
817}
Steven Rostedtea4e2bc2008-12-03 15:36:57 -0500818#endif /* CONFIG_FUNCTION_GRAPH_TRACER */
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100819
jolsa@redhat.com756d17e2009-10-13 16:33:52 -0400820extern struct list_head ftrace_pids;
Steven Rostedt804a6852008-12-03 15:36:59 -0500821
Paul Mundt1155de42009-06-25 14:30:12 +0900822#ifdef CONFIG_FUNCTION_TRACER
Steven Rostedt (Red Hat)f1ed7c72013-06-27 22:18:06 -0400823extern bool ftrace_filter_param __initdata;
Steven Rostedt804a6852008-12-03 15:36:59 -0500824static inline int ftrace_trace_task(struct task_struct *task)
825{
jolsa@redhat.com756d17e2009-10-13 16:33:52 -0400826 if (list_empty(&ftrace_pids))
Steven Rostedt804a6852008-12-03 15:36:59 -0500827 return 1;
828
829 return test_tsk_trace_trace(task);
830}
Steven Rostedte0a413f2011-09-29 21:26:16 -0400831extern int ftrace_is_dead(void);
Steven Rostedt (Red Hat)591dffd2014-01-10 16:17:45 -0500832int ftrace_create_function_files(struct trace_array *tr,
833 struct dentry *parent);
834void ftrace_destroy_function_files(struct trace_array *tr);
Steven Rostedt (Red Hat)4104d322014-01-10 17:01:58 -0500835void ftrace_init_global_array_ops(struct trace_array *tr);
836void ftrace_init_array_ops(struct trace_array *tr, ftrace_func_t func);
837void ftrace_reset_array_ops(struct trace_array *tr);
Jiaxing Wang7eea4fc2014-04-20 23:10:43 +0800838int using_ftrace_ops_list_func(void);
Paul Mundt1155de42009-06-25 14:30:12 +0900839#else
840static inline int ftrace_trace_task(struct task_struct *task)
841{
842 return 1;
843}
Steven Rostedte0a413f2011-09-29 21:26:16 -0400844static inline int ftrace_is_dead(void) { return 0; }
Steven Rostedt (Red Hat)591dffd2014-01-10 16:17:45 -0500845static inline int
846ftrace_create_function_files(struct trace_array *tr,
847 struct dentry *parent)
848{
849 return 0;
850}
851static inline void ftrace_destroy_function_files(struct trace_array *tr) { }
Steven Rostedt (Red Hat)4104d322014-01-10 17:01:58 -0500852static inline __init void
853ftrace_init_global_array_ops(struct trace_array *tr) { }
854static inline void ftrace_reset_array_ops(struct trace_array *tr) { }
855/* ftace_func_t type is not defined, use macro instead of static inline */
856#define ftrace_init_array_ops(tr, func) do { } while (0)
Steven Rostedt (Red Hat)591dffd2014-01-10 16:17:45 -0500857#endif /* CONFIG_FUNCTION_TRACER */
858
859#if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE)
860void ftrace_create_filter_files(struct ftrace_ops *ops,
861 struct dentry *parent);
862void ftrace_destroy_filter_files(struct ftrace_ops *ops);
863#else
864/*
865 * The ops parameter passed in is usually undefined.
866 * This must be a macro.
867 */
868#define ftrace_create_filter_files(ops, parent) do { } while (0)
869#define ftrace_destroy_filter_files(ops) do { } while (0)
870#endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */
Steven Rostedt804a6852008-12-03 15:36:59 -0500871
Yaowei Baic6650b22015-09-29 22:43:36 +0800872bool ftrace_event_is_function(struct trace_event_call *call);
Jiri Olsaced39002012-02-15 15:51:52 +0100873
Steven Rostedt4fcdae82008-05-12 21:21:00 +0200874/*
jolsa@redhat.comb63f39e2009-09-11 17:29:27 +0200875 * struct trace_parser - servers for reading the user input separated by spaces
876 * @cont: set if the input is not complete - no final space char was found
877 * @buffer: holds the parsed user input
Daniel Mack1537a362010-01-29 15:57:49 +0800878 * @idx: user input length
jolsa@redhat.comb63f39e2009-09-11 17:29:27 +0200879 * @size: buffer size
880 */
881struct trace_parser {
882 bool cont;
883 char *buffer;
884 unsigned idx;
885 unsigned size;
886};
887
888static inline bool trace_parser_loaded(struct trace_parser *parser)
889{
890 return (parser->idx != 0);
891}
892
893static inline bool trace_parser_cont(struct trace_parser *parser)
894{
895 return parser->cont;
896}
897
898static inline void trace_parser_clear(struct trace_parser *parser)
899{
900 parser->cont = false;
901 parser->idx = 0;
902}
903
904extern int trace_parser_get_init(struct trace_parser *parser, int size);
905extern void trace_parser_put(struct trace_parser *parser);
906extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
907 size_t cnt, loff_t *ppos);
908
909/*
Steven Rostedt (Red Hat)729358d2015-09-29 10:15:10 -0400910 * Only create function graph options if function graph is configured.
911 */
912#ifdef CONFIG_FUNCTION_GRAPH_TRACER
913# define FGRAPH_FLAGS \
Steven Rostedt (Red Hat)729358d2015-09-29 10:15:10 -0400914 C(DISPLAY_GRAPH, "display-graph"),
Steven Rostedt (Red Hat)729358d2015-09-29 10:15:10 -0400915#else
916# define FGRAPH_FLAGS
Steven Rostedt (Red Hat)729358d2015-09-29 10:15:10 -0400917#endif
918
Steven Rostedt (Red Hat)4ee43012015-09-29 10:19:35 -0400919#ifdef CONFIG_BRANCH_TRACER
920# define BRANCH_FLAGS \
921 C(BRANCH, "branch"),
922#else
923# define BRANCH_FLAGS
924#endif
925
Steven Rostedt (Red Hat)8179e8a2015-09-29 10:24:56 -0400926#ifdef CONFIG_FUNCTION_TRACER
927# define FUNCTION_FLAGS \
928 C(FUNCTION, "function-trace"),
929# define FUNCTION_DEFAULT_FLAGS TRACE_ITER_FUNCTION
930#else
931# define FUNCTION_FLAGS
932# define FUNCTION_DEFAULT_FLAGS 0UL
933#endif
934
Steven Rostedt (Red Hat)73dddbb2015-09-29 15:38:55 -0400935#ifdef CONFIG_STACKTRACE
936# define STACK_FLAGS \
937 C(STACKTRACE, "stacktrace"),
938#else
939# define STACK_FLAGS
940#endif
941
Steven Rostedt (Red Hat)729358d2015-09-29 10:15:10 -0400942/*
Steven Rostedt4fcdae82008-05-12 21:21:00 +0200943 * trace_iterator_flags is an enumeration that defines bit
944 * positions into trace_flags that controls the output.
945 *
946 * NOTE: These bits must match the trace_options array in
Steven Rostedt (Red Hat)a3418a32015-09-29 09:43:30 -0400947 * trace.c (this macro guarantees it).
Steven Rostedt4fcdae82008-05-12 21:21:00 +0200948 */
Steven Rostedt (Red Hat)a3418a32015-09-29 09:43:30 -0400949#define TRACE_FLAGS \
950 C(PRINT_PARENT, "print-parent"), \
951 C(SYM_OFFSET, "sym-offset"), \
952 C(SYM_ADDR, "sym-addr"), \
953 C(VERBOSE, "verbose"), \
954 C(RAW, "raw"), \
955 C(HEX, "hex"), \
956 C(BIN, "bin"), \
957 C(BLOCK, "block"), \
Steven Rostedt (Red Hat)a3418a32015-09-29 09:43:30 -0400958 C(PRINTK, "trace_printk"), \
Steven Rostedt (Red Hat)a3418a32015-09-29 09:43:30 -0400959 C(ANNOTATE, "annotate"), \
960 C(USERSTACKTRACE, "userstacktrace"), \
961 C(SYM_USEROBJ, "sym-userobj"), \
962 C(PRINTK_MSGONLY, "printk-msg-only"), \
963 C(CONTEXT_INFO, "context-info"), /* Print pid/cpu/time */ \
964 C(LATENCY_FMT, "latency-format"), \
Steven Rostedt (Red Hat)a3418a32015-09-29 09:43:30 -0400965 C(RECORD_CMD, "record-cmd"), \
966 C(OVERWRITE, "overwrite"), \
967 C(STOP_ON_FREE, "disable_on_free"), \
968 C(IRQ_INFO, "irq-info"), \
969 C(MARKERS, "markers"), \
Steven Rostedt (Red Hat)8179e8a2015-09-29 10:24:56 -0400970 FUNCTION_FLAGS \
Steven Rostedt (Red Hat)4ee43012015-09-29 10:19:35 -0400971 FGRAPH_FLAGS \
Steven Rostedt (Red Hat)73dddbb2015-09-29 15:38:55 -0400972 STACK_FLAGS \
Steven Rostedt (Red Hat)4ee43012015-09-29 10:19:35 -0400973 BRANCH_FLAGS
Steven Rostedt (Red Hat)ce3fed62015-09-29 09:22:05 -0400974
Steven Rostedt (Red Hat)a3418a32015-09-29 09:43:30 -0400975/*
976 * By defining C, we can make TRACE_FLAGS a list of bit names
977 * that will define the bits for the flag masks.
978 */
979#undef C
980#define C(a, b) TRACE_ITER_##a##_BIT
981
Steven Rostedt (Red Hat)b5e87c02015-09-29 18:13:33 -0400982enum trace_iterator_bits {
983 TRACE_FLAGS
984 /* Make sure we don't go more than we have bits for */
985 TRACE_ITER_LAST_BIT
986};
Steven Rostedt (Red Hat)a3418a32015-09-29 09:43:30 -0400987
988/*
989 * By redefining C, we can make TRACE_FLAGS a list of masks that
990 * use the bits as defined above.
991 */
992#undef C
993#define C(a, b) TRACE_ITER_##a = (1 << TRACE_ITER_##a##_BIT)
994
995enum trace_iterator_flags { TRACE_FLAGS };
Ingo Molnar4e655512008-05-12 21:20:52 +0200996
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100997/*
998 * TRACE_ITER_SYM_MASK masks the options in trace_flags that
999 * control the output of kernel symbols.
1000 */
1001#define TRACE_ITER_SYM_MASK \
1002 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
1003
Frédéric Weisbecker43a15382008-09-21 20:16:30 +02001004extern struct tracer nop_trace;
1005
Steven Rostedt2ed84ee2008-11-12 15:24:24 -05001006#ifdef CONFIG_BRANCH_TRACER
Steven Rostedt9f029e82008-11-12 15:24:24 -05001007extern int enable_branch_tracing(struct trace_array *tr);
1008extern void disable_branch_tracing(void);
1009static inline int trace_branch_enable(struct trace_array *tr)
Steven Rostedt52f232c2008-11-12 00:14:40 -05001010{
Steven Rostedt (Red Hat)983f9382015-09-30 09:42:05 -04001011 if (tr->trace_flags & TRACE_ITER_BRANCH)
Steven Rostedt9f029e82008-11-12 15:24:24 -05001012 return enable_branch_tracing(tr);
Steven Rostedt52f232c2008-11-12 00:14:40 -05001013 return 0;
1014}
Steven Rostedt9f029e82008-11-12 15:24:24 -05001015static inline void trace_branch_disable(void)
Steven Rostedt52f232c2008-11-12 00:14:40 -05001016{
1017 /* due to races, always disable */
Steven Rostedt9f029e82008-11-12 15:24:24 -05001018 disable_branch_tracing();
Steven Rostedt52f232c2008-11-12 00:14:40 -05001019}
1020#else
Steven Rostedt9f029e82008-11-12 15:24:24 -05001021static inline int trace_branch_enable(struct trace_array *tr)
Steven Rostedt52f232c2008-11-12 00:14:40 -05001022{
1023 return 0;
1024}
Steven Rostedt9f029e82008-11-12 15:24:24 -05001025static inline void trace_branch_disable(void)
Steven Rostedt52f232c2008-11-12 00:14:40 -05001026{
1027}
Steven Rostedt2ed84ee2008-11-12 15:24:24 -05001028#endif /* CONFIG_BRANCH_TRACER */
Steven Rostedt52f232c2008-11-12 00:14:40 -05001029
Steven Rostedt1852fcc2009-03-11 14:33:00 -04001030/* set ring buffers to default size if not already done so */
1031int tracing_update_buffers(void);
1032
Tom Zanussicf027f62009-03-22 03:30:39 -05001033struct ftrace_event_field {
1034 struct list_head link;
Steven Rostedt92edca02013-02-27 20:41:37 -05001035 const char *name;
1036 const char *type;
Li Zefanaa38e9f2009-08-07 10:33:02 +08001037 int filter_type;
Tom Zanussicf027f62009-03-22 03:30:39 -05001038 int offset;
1039 int size;
Tom Zanussia118e4d2009-04-28 03:04:53 -05001040 int is_signed;
Tom Zanussicf027f62009-03-22 03:30:39 -05001041};
1042
Tom Zanussi30e673b2009-04-28 03:04:47 -05001043struct event_filter {
Steven Rostedtc9c53ca2011-01-27 22:42:43 -05001044 int n_preds; /* Number assigned */
1045 int a_preds; /* allocated */
Steven Rostedt74e9e582011-01-27 22:49:48 -05001046 struct filter_pred *preds;
Steven Rostedt61e9dea2011-01-27 22:54:33 -05001047 struct filter_pred *root;
Tom Zanussi8b372562009-04-28 03:04:59 -05001048 char *filter_string;
Tom Zanussi30e673b2009-04-28 03:04:47 -05001049};
1050
Tom Zanussicfb180f2009-03-22 03:31:17 -05001051struct event_subsystem {
1052 struct list_head list;
1053 const char *name;
Li Zefan1f9963c2009-07-20 10:20:53 +08001054 struct event_filter *filter;
Steven Rostedte9dbfae2011-07-05 11:36:06 -04001055 int ref_count;
Tom Zanussicfb180f2009-03-22 03:31:17 -05001056};
1057
Steven Rostedt (Red Hat)7967b3e2015-05-13 14:59:40 -04001058struct trace_subsystem_dir {
Steven Rostedtae63b312012-05-03 23:09:03 -04001059 struct list_head list;
1060 struct event_subsystem *subsystem;
1061 struct trace_array *tr;
1062 struct dentry *entry;
1063 int ref_count;
1064 int nr_events;
1065};
1066
Steven Rostedt61e9dea2011-01-27 22:54:33 -05001067#define FILTER_PRED_INVALID ((unsigned short)-1)
1068#define FILTER_PRED_IS_RIGHT (1 << 15)
Steven Rostedt43cd4142011-01-27 23:16:51 -05001069#define FILTER_PRED_FOLD (1 << 15)
Steven Rostedt61e9dea2011-01-27 22:54:33 -05001070
Steven Rostedtbf93f9e2011-01-27 23:21:34 -05001071/*
1072 * The max preds is the size of unsigned short with
1073 * two flags at the MSBs. One bit is used for both the IS_RIGHT
1074 * and FOLD flags. The other is reserved.
1075 *
1076 * 2^14 preds is way more than enough.
1077 */
1078#define MAX_FILTER_PRED 16384
Steven Rostedt4a3d27e2011-01-27 23:19:49 -05001079
Tom Zanussi7ce7e422009-03-22 03:31:04 -05001080struct filter_pred;
Frederic Weisbecker1889d202009-09-24 21:10:44 +02001081struct regex;
Tom Zanussi7ce7e422009-03-22 03:31:04 -05001082
Steven Rostedt58d9a592011-01-27 22:37:09 -05001083typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);
Tom Zanussi7ce7e422009-03-22 03:31:04 -05001084
Frederic Weisbecker1889d202009-09-24 21:10:44 +02001085typedef int (*regex_match_func)(char *str, struct regex *r, int len);
1086
Frederic Weisbecker3f6fe062009-09-24 21:31:51 +02001087enum regex_type {
Li Zefanb0f1a592009-10-15 11:21:12 +08001088 MATCH_FULL = 0,
Frederic Weisbecker3f6fe062009-09-24 21:31:51 +02001089 MATCH_FRONT_ONLY,
1090 MATCH_MIDDLE_ONLY,
1091 MATCH_END_ONLY,
Tom Zanussi7ce7e422009-03-22 03:31:04 -05001092};
1093
Frederic Weisbecker1889d202009-09-24 21:10:44 +02001094struct regex {
1095 char pattern[MAX_FILTER_STR_VAL];
1096 int len;
1097 int field_len;
1098 regex_match_func match;
1099};
1100
Tom Zanussicf027f62009-03-22 03:30:39 -05001101struct filter_pred {
Frederic Weisbecker1889d202009-09-24 21:10:44 +02001102 filter_pred_fn_t fn;
1103 u64 val;
1104 struct regex regex;
Jiri Olsa61aaef52011-08-11 16:25:47 +02001105 unsigned short *ops;
Jiri Olsa1d0e78e2011-08-11 16:25:54 +02001106 struct ftrace_event_field *field;
Frederic Weisbecker1889d202009-09-24 21:10:44 +02001107 int offset;
1108 int not;
1109 int op;
Steven Rostedt61e9dea2011-01-27 22:54:33 -05001110 unsigned short index;
1111 unsigned short parent;
1112 unsigned short left;
1113 unsigned short right;
Steven Rostedtc32e8272009-02-27 19:12:30 -05001114};
1115
Tom Zanussi4ef56902015-12-10 12:50:43 -06001116static inline bool is_string_field(struct ftrace_event_field *field)
1117{
1118 return field->filter_type == FILTER_DYN_STRING ||
1119 field->filter_type == FILTER_STATIC_STRING ||
1120 field->filter_type == FILTER_PTR_STRING;
1121}
1122
1123static inline bool is_function_field(struct ftrace_event_field *field)
1124{
1125 return field->filter_type == FILTER_TRACE_FN;
1126}
1127
Frederic Weisbecker3f6fe062009-09-24 21:31:51 +02001128extern enum regex_type
1129filter_parse_regex(char *buff, int len, char **search, int *not);
Steven Rostedt (Red Hat)7f1d2f82015-05-05 10:09:53 -04001130extern void print_event_filter(struct trace_event_file *file,
Tom Zanussi4bda2d52009-03-24 02:14:31 -05001131 struct trace_seq *s);
Steven Rostedt (Red Hat)7f1d2f82015-05-05 10:09:53 -04001132extern int apply_event_filter(struct trace_event_file *file,
Tom Zanussi8b372562009-04-28 03:04:59 -05001133 char *filter_string);
Steven Rostedt (Red Hat)7967b3e2015-05-13 14:59:40 -04001134extern int apply_subsystem_event_filter(struct trace_subsystem_dir *dir,
Tom Zanussi8b372562009-04-28 03:04:59 -05001135 char *filter_string);
1136extern void print_subsystem_event_filter(struct event_subsystem *system,
Tom Zanussiac1adc52009-04-17 00:27:08 -05001137 struct trace_seq *s);
Li Zefanaa38e9f2009-08-07 10:33:02 +08001138extern int filter_assign_type(const char *type);
Steven Rostedt (Red Hat)2425bcb2015-05-05 11:45:27 -04001139extern int create_event_filter(struct trace_event_call *call,
Tom Zanussibac5fb92013-10-24 08:59:29 -05001140 char *filter_str, bool set_str,
1141 struct event_filter **filterp);
1142extern void free_event_filter(struct event_filter *filter);
Tom Zanussi7ce7e422009-03-22 03:31:04 -05001143
zhangwei(Jovi)b3a8c6f2013-03-11 15:13:42 +08001144struct ftrace_event_field *
Steven Rostedt (Red Hat)2425bcb2015-05-05 11:45:27 -04001145trace_find_event_field(struct trace_event_call *call, char *name);
Steven Rostedt2e33af02010-04-22 10:35:55 -04001146
Li Zefane870e9a2010-07-02 11:07:32 +08001147extern void trace_event_enable_cmd_record(bool enable);
Steven Rostedt277ba042012-08-03 16:10:49 -04001148extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr);
Steven Rostedt0c8916c2012-08-07 16:14:16 -04001149extern int event_trace_del_tracer(struct trace_array *tr);
Li Zefane870e9a2010-07-02 11:07:32 +08001150
Steven Rostedt (Red Hat)7f1d2f82015-05-05 10:09:53 -04001151extern struct trace_event_file *find_event_file(struct trace_array *tr,
1152 const char *system,
1153 const char *event);
Tom Zanussi7862ad12013-10-24 08:59:28 -05001154
Tom Zanussi85f2b082013-10-24 08:59:24 -05001155static inline void *event_file_data(struct file *filp)
1156{
1157 return ACCESS_ONCE(file_inode(filp)->i_private);
1158}
1159
Li Zefan20c89282009-05-06 10:33:45 +08001160extern struct mutex event_mutex;
Steven Rostedta59fd602009-04-10 13:52:20 -04001161extern struct list_head ftrace_events;
Peter Zijlstraac199db2009-03-19 20:26:15 +01001162
Tom Zanussi85f2b082013-10-24 08:59:24 -05001163extern const struct file_operations event_trigger_fops;
1164
1165extern int register_trigger_cmds(void);
1166extern void clear_event_triggers(struct trace_array *tr);
1167
1168struct event_trigger_data {
1169 unsigned long count;
1170 int ref;
1171 struct event_trigger_ops *ops;
1172 struct event_command *cmd_ops;
Steven Rostedt (Red Hat)d8a30f22013-12-21 21:55:17 -05001173 struct event_filter __rcu *filter;
Tom Zanussi85f2b082013-10-24 08:59:24 -05001174 char *filter_str;
1175 void *private_data;
Tom Zanussi104f2812015-12-10 12:50:47 -06001176 bool paused;
Tom Zanussi85f2b082013-10-24 08:59:24 -05001177 struct list_head list;
1178};
1179
Tom Zanussiab4bf002015-12-10 12:50:44 -06001180extern void trigger_data_free(struct event_trigger_data *data);
1181extern int event_trigger_init(struct event_trigger_ops *ops,
1182 struct event_trigger_data *data);
1183extern int trace_event_trigger_enable_disable(struct trace_event_file *file,
1184 int trigger_enable);
1185extern void update_cond_flag(struct trace_event_file *file);
1186extern void unregister_trigger(char *glob, struct event_trigger_ops *ops,
1187 struct event_trigger_data *test,
1188 struct trace_event_file *file);
1189extern int set_trigger_filter(char *filter_str,
1190 struct event_trigger_data *trigger_data,
1191 struct trace_event_file *file);
1192extern int register_event_command(struct event_command *cmd);
1193
Tom Zanussi85f2b082013-10-24 08:59:24 -05001194/**
1195 * struct event_trigger_ops - callbacks for trace event triggers
1196 *
1197 * The methods in this structure provide per-event trigger hooks for
1198 * various trigger operations.
1199 *
1200 * All the methods below, except for @init() and @free(), must be
1201 * implemented.
1202 *
1203 * @func: The trigger 'probe' function called when the triggering
1204 * event occurs. The data passed into this callback is the data
1205 * that was supplied to the event_command @reg() function that
Tom Zanussic4a59232015-12-10 12:50:45 -06001206 * registered the trigger (see struct event_command) along with
1207 * the trace record, rec.
Tom Zanussi85f2b082013-10-24 08:59:24 -05001208 *
1209 * @init: An optional initialization function called for the trigger
1210 * when the trigger is registered (via the event_command reg()
1211 * function). This can be used to perform per-trigger
1212 * initialization such as incrementing a per-trigger reference
1213 * count, for instance. This is usually implemented by the
1214 * generic utility function @event_trigger_init() (see
1215 * trace_event_triggers.c).
1216 *
1217 * @free: An optional de-initialization function called for the
1218 * trigger when the trigger is unregistered (via the
1219 * event_command @reg() function). This can be used to perform
1220 * per-trigger de-initialization such as decrementing a
1221 * per-trigger reference count and freeing corresponding trigger
1222 * data, for instance. This is usually implemented by the
1223 * generic utility function @event_trigger_free() (see
1224 * trace_event_triggers.c).
1225 *
1226 * @print: The callback function invoked to have the trigger print
1227 * itself. This is usually implemented by a wrapper function
1228 * that calls the generic utility function @event_trigger_print()
1229 * (see trace_event_triggers.c).
1230 */
1231struct event_trigger_ops {
Tom Zanussic4a59232015-12-10 12:50:45 -06001232 void (*func)(struct event_trigger_data *data,
1233 void *rec);
Tom Zanussi85f2b082013-10-24 08:59:24 -05001234 int (*init)(struct event_trigger_ops *ops,
1235 struct event_trigger_data *data);
1236 void (*free)(struct event_trigger_ops *ops,
1237 struct event_trigger_data *data);
1238 int (*print)(struct seq_file *m,
1239 struct event_trigger_ops *ops,
1240 struct event_trigger_data *data);
1241};
1242
1243/**
1244 * struct event_command - callbacks and data members for event commands
1245 *
1246 * Event commands are invoked by users by writing the command name
1247 * into the 'trigger' file associated with a trace event. The
1248 * parameters associated with a specific invocation of an event
1249 * command are used to create an event trigger instance, which is
1250 * added to the list of trigger instances associated with that trace
1251 * event. When the event is hit, the set of triggers associated with
1252 * that event is invoked.
1253 *
1254 * The data members in this structure provide per-event command data
1255 * for various event commands.
1256 *
1257 * All the data members below, except for @post_trigger, must be set
1258 * for each event command.
1259 *
1260 * @name: The unique name that identifies the event command. This is
1261 * the name used when setting triggers via trigger files.
1262 *
1263 * @trigger_type: A unique id that identifies the event command
1264 * 'type'. This value has two purposes, the first to ensure that
1265 * only one trigger of the same type can be set at a given time
1266 * for a particular event e.g. it doesn't make sense to have both
1267 * a traceon and traceoff trigger attached to a single event at
1268 * the same time, so traceon and traceoff have the same type
1269 * though they have different names. The @trigger_type value is
1270 * also used as a bit value for deferring the actual trigger
1271 * action until after the current event is finished. Some
1272 * commands need to do this if they themselves log to the trace
1273 * buffer (see the @post_trigger() member below). @trigger_type
1274 * values are defined by adding new values to the trigger_type
Steven Rostedt (Red Hat)af658dc2015-04-29 14:36:05 -04001275 * enum in include/linux/trace_events.h.
Tom Zanussi85f2b082013-10-24 08:59:24 -05001276 *
Steven Rostedt (Red Hat)353206f2016-02-22 15:55:09 -05001277 * @flags: See the enum event_command_flags below.
Tom Zanussia5863da2015-12-10 12:50:48 -06001278 *
Tom Zanussia88e1cf2015-12-10 12:50:49 -06001279 * All the methods below, except for @set_filter() and @unreg_all(),
1280 * must be implemented.
Tom Zanussi85f2b082013-10-24 08:59:24 -05001281 *
1282 * @func: The callback function responsible for parsing and
1283 * registering the trigger written to the 'trigger' file by the
1284 * user. It allocates the trigger instance and registers it with
1285 * the appropriate trace event. It makes use of the other
1286 * event_command callback functions to orchestrate this, and is
1287 * usually implemented by the generic utility function
1288 * @event_trigger_callback() (see trace_event_triggers.c).
1289 *
1290 * @reg: Adds the trigger to the list of triggers associated with the
1291 * event, and enables the event trigger itself, after
1292 * initializing it (via the event_trigger_ops @init() function).
1293 * This is also where commands can use the @trigger_type value to
1294 * make the decision as to whether or not multiple instances of
1295 * the trigger should be allowed. This is usually implemented by
1296 * the generic utility function @register_trigger() (see
1297 * trace_event_triggers.c).
1298 *
1299 * @unreg: Removes the trigger from the list of triggers associated
1300 * with the event, and disables the event trigger itself, after
1301 * initializing it (via the event_trigger_ops @free() function).
1302 * This is usually implemented by the generic utility function
1303 * @unregister_trigger() (see trace_event_triggers.c).
1304 *
Tom Zanussia88e1cf2015-12-10 12:50:49 -06001305 * @unreg_all: An optional function called to remove all the triggers
1306 * from the list of triggers associated with the event. Called
1307 * when a trigger file is opened in truncate mode.
1308 *
Tom Zanussi85f2b082013-10-24 08:59:24 -05001309 * @set_filter: An optional function called to parse and set a filter
1310 * for the trigger. If no @set_filter() method is set for the
1311 * event command, filters set by the user for the command will be
1312 * ignored. This is usually implemented by the generic utility
1313 * function @set_trigger_filter() (see trace_event_triggers.c).
1314 *
1315 * @get_trigger_ops: The callback function invoked to retrieve the
1316 * event_trigger_ops implementation associated with the command.
1317 */
1318struct event_command {
1319 struct list_head list;
1320 char *name;
1321 enum event_trigger_type trigger_type;
Steven Rostedt (Red Hat)353206f2016-02-22 15:55:09 -05001322 int flags;
Tom Zanussi85f2b082013-10-24 08:59:24 -05001323 int (*func)(struct event_command *cmd_ops,
Steven Rostedt (Red Hat)7f1d2f82015-05-05 10:09:53 -04001324 struct trace_event_file *file,
Tom Zanussi85f2b082013-10-24 08:59:24 -05001325 char *glob, char *cmd, char *params);
1326 int (*reg)(char *glob,
1327 struct event_trigger_ops *ops,
1328 struct event_trigger_data *data,
Steven Rostedt (Red Hat)7f1d2f82015-05-05 10:09:53 -04001329 struct trace_event_file *file);
Tom Zanussi85f2b082013-10-24 08:59:24 -05001330 void (*unreg)(char *glob,
1331 struct event_trigger_ops *ops,
1332 struct event_trigger_data *data,
Steven Rostedt (Red Hat)7f1d2f82015-05-05 10:09:53 -04001333 struct trace_event_file *file);
Tom Zanussia88e1cf2015-12-10 12:50:49 -06001334 void (*unreg_all)(struct trace_event_file *file);
Tom Zanussi85f2b082013-10-24 08:59:24 -05001335 int (*set_filter)(char *filter_str,
1336 struct event_trigger_data *data,
Steven Rostedt (Red Hat)7f1d2f82015-05-05 10:09:53 -04001337 struct trace_event_file *file);
Tom Zanussi85f2b082013-10-24 08:59:24 -05001338 struct event_trigger_ops *(*get_trigger_ops)(char *cmd, char *param);
1339};
1340
Steven Rostedt (Red Hat)353206f2016-02-22 15:55:09 -05001341/**
1342 * enum event_command_flags - flags for struct event_command
1343 *
1344 * @POST_TRIGGER: A flag that says whether or not this command needs
1345 * to have its action delayed until after the current event has
1346 * been closed. Some triggers need to avoid being invoked while
1347 * an event is currently in the process of being logged, since
1348 * the trigger may itself log data into the trace buffer. Thus
1349 * we make sure the current event is committed before invoking
1350 * those triggers. To do that, the trigger invocation is split
1351 * in two - the first part checks the filter using the current
1352 * trace record; if a command has the @post_trigger flag set, it
1353 * sets a bit for itself in the return value, otherwise it
1354 * directly invokes the trigger. Once all commands have been
1355 * either invoked or set their return flag, the current record is
1356 * either committed or discarded. At that point, if any commands
1357 * have deferred their triggers, those commands are finally
1358 * invoked following the close of the current event. In other
1359 * words, if the event_trigger_ops @func() probe implementation
1360 * itself logs to the trace buffer, this flag should be set,
1361 * otherwise it can be left unspecified.
1362 *
1363 * @NEEDS_REC: A flag that says whether or not this command needs
1364 * access to the trace record in order to perform its function,
1365 * regardless of whether or not it has a filter associated with
1366 * it (filters make a trigger require access to the trace record
1367 * but are not always present).
1368 */
1369enum event_command_flags {
1370 EVENT_CMD_FL_POST_TRIGGER = 1,
1371 EVENT_CMD_FL_NEEDS_REC = 2,
1372};
1373
1374static inline bool event_command_post_trigger(struct event_command *cmd_ops)
1375{
1376 return cmd_ops->flags & EVENT_CMD_FL_POST_TRIGGER;
1377}
1378
1379static inline bool event_command_needs_rec(struct event_command *cmd_ops)
1380{
1381 return cmd_ops->flags & EVENT_CMD_FL_NEEDS_REC;
1382}
1383
Steven Rostedt (Red Hat)7f1d2f82015-05-05 10:09:53 -04001384extern int trace_event_enable_disable(struct trace_event_file *file,
Tom Zanussi85f2b082013-10-24 08:59:24 -05001385 int enable, int soft_disable);
Tom Zanussi93e31ff2013-10-24 08:59:26 -05001386extern int tracing_alloc_snapshot(void);
Tom Zanussi85f2b082013-10-24 08:59:24 -05001387
Steven Rostedte9fb2b62009-03-12 14:19:25 -04001388extern const char *__start___trace_bprintk_fmt[];
1389extern const char *__stop___trace_bprintk_fmt[];
1390
Steven Rostedt (Red Hat)102c9322013-07-12 17:07:27 -04001391extern const char *__start___tracepoint_str[];
1392extern const char *__stop___tracepoint_str[];
1393
Steven Rostedt (Red Hat)b9f91082015-09-29 18:21:35 -04001394void trace_printk_control(bool enabled);
Steven Rostedt07d777f2011-09-22 14:01:55 -04001395void trace_printk_init_buffers(void);
Steven Rostedt81698832012-10-11 10:15:05 -04001396void trace_printk_start_comm(void);
Steven Rostedt (Red Hat)613f04a2013-03-14 15:03:53 -04001397int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set);
Steven Rostedt2b6080f2012-05-11 13:29:49 -04001398int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled);
Steven Rostedt07d777f2011-09-22 14:01:55 -04001399
Steven Rostedt (Red Hat)ca268da2013-03-09 00:40:58 -05001400/*
1401 * Normal trace_printk() and friends allocates special buffers
1402 * to do the manipulation, as well as saves the print formats
1403 * into sections to display. But the trace infrastructure wants
1404 * to use these without the added overhead at the price of being
1405 * a bit slower (used mainly for warnings, where we don't care
1406 * about performance). The internal_trace_puts() is for such
1407 * a purpose.
1408 */
1409#define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
1410
Steven Rostedt4e5292e2009-09-12 19:26:21 -04001411#undef FTRACE_ENTRY
Jiri Olsa02aa3162012-02-15 15:51:53 +01001412#define FTRACE_ENTRY(call, struct_name, id, tstruct, print, filter) \
Steven Rostedt (Red Hat)2425bcb2015-05-05 11:45:27 -04001413 extern struct trace_event_call \
Gideon Israel Dsouza52f56842014-04-07 15:39:20 -07001414 __aligned(4) event_##call;
Steven Rostedt4e5292e2009-09-12 19:26:21 -04001415#undef FTRACE_ENTRY_DUP
Jiri Olsa02aa3162012-02-15 15:51:53 +01001416#define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print, filter) \
1417 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
1418 filter)
Steven Rostedt4e5292e2009-09-12 19:26:21 -04001419#include "trace_entries.h"
Tom Zanussie1112b42009-03-31 00:48:49 -05001420
Mark Brown6e48b552012-04-13 09:52:59 +01001421#if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
Steven Rostedt (Red Hat)2425bcb2015-05-05 11:45:27 -04001422int perf_ftrace_event_register(struct trace_event_call *call,
Jiri Olsaced39002012-02-15 15:51:52 +01001423 enum trace_reg type, void *data);
1424#else
1425#define perf_ftrace_event_register NULL
Mark Brown6e48b552012-04-13 09:52:59 +01001426#endif
Jiri Olsaced39002012-02-15 15:51:52 +01001427
Steven Rostedt (Red Hat)5f893b22014-12-12 20:05:10 -05001428#ifdef CONFIG_FTRACE_SYSCALLS
1429void init_ftrace_syscalls(void);
Tom Zanussidbfeaa72015-12-10 12:50:46 -06001430const char *get_syscall_name(int syscall);
Steven Rostedt (Red Hat)5f893b22014-12-12 20:05:10 -05001431#else
1432static inline void init_ftrace_syscalls(void) { }
Tom Zanussidbfeaa72015-12-10 12:50:46 -06001433static inline const char *get_syscall_name(int syscall)
1434{
1435 return NULL;
1436}
Steven Rostedt (Red Hat)5f893b22014-12-12 20:05:10 -05001437#endif
1438
1439#ifdef CONFIG_EVENT_TRACING
1440void trace_event_init(void);
Steven Rostedt (Red Hat)0c564a52015-03-24 17:58:09 -04001441void trace_event_enum_update(struct trace_enum_map **map, int len);
Steven Rostedt (Red Hat)5f893b22014-12-12 20:05:10 -05001442#else
1443static inline void __init trace_event_init(void) { }
Steven Rostedt (Red Hat)cc9e4bd2015-06-25 18:19:37 -04001444static inline void trace_event_enum_update(struct trace_enum_map **map, int len) { }
Steven Rostedt (Red Hat)5f893b22014-12-12 20:05:10 -05001445#endif
1446
Steven Rostedt (Red Hat)0daa23022014-12-12 22:27:10 -05001447extern struct trace_iterator *tracepoint_print_iter;
Steven Rostedt (Red Hat)5f893b22014-12-12 20:05:10 -05001448
Steven Rostedtbc0c38d2008-05-12 21:20:42 +02001449#endif /* _LINUX_KERNEL_TRACE_H */