blob: 8c9b7a1c4138b87a79833bc400370a13e94cf270 [file] [log] [blame]
Steven Rostedt97f20252009-04-13 11:20:49 -04001#ifndef _LINUX_FTRACE_EVENT_H
2#define _LINUX_FTRACE_EVENT_H
3
Steven Rostedt97f20252009-04-13 11:20:49 -04004#include <linux/ring_buffer.h>
Steven Rostedt16bb8eb2009-09-12 19:04:54 -04005#include <linux/trace_seq.h>
Steven Rostedtbe74b732009-05-26 20:25:22 +02006#include <linux/percpu.h>
Frederic Weisbecker20ab44252009-09-18 06:10:28 +02007#include <linux/hardirq.h>
Xiao Guangrong430ad5a2010-01-28 09:32:29 +08008#include <linux/perf_event.h>
Steven Rostedt97f20252009-04-13 11:20:49 -04009
10struct trace_array;
Steven Rostedt (Red Hat)12883ef2013-03-05 09:24:35 -050011struct trace_buffer;
Steven Rostedt97f20252009-04-13 11:20:49 -040012struct tracer;
Steven Rostedt6d723732009-04-10 14:53:50 -040013struct dentry;
Steven Rostedt97f20252009-04-13 11:20:49 -040014
Steven Rostedtbe74b732009-05-26 20:25:22 +020015struct trace_print_flags {
16 unsigned long mask;
17 const char *name;
18};
19
liubo2fc1b6f2011-04-19 09:35:28 +080020struct trace_print_flags_u64 {
21 unsigned long long mask;
22 const char *name;
23};
24
Steven Rostedtbe74b732009-05-26 20:25:22 +020025const char *ftrace_print_flags_seq(struct trace_seq *p, const char *delim,
26 unsigned long flags,
27 const struct trace_print_flags *flag_array);
28
Steven Rostedt0f4fc292009-05-20 19:21:47 -040029const char *ftrace_print_symbols_seq(struct trace_seq *p, unsigned long val,
30 const struct trace_print_flags *symbol_array);
31
liubo2fc1b6f2011-04-19 09:35:28 +080032#if BITS_PER_LONG == 32
33const char *ftrace_print_symbols_seq_u64(struct trace_seq *p,
34 unsigned long long val,
35 const struct trace_print_flags_u64
36 *symbol_array);
37#endif
38
Kei Tokunaga5a2e3992010-04-01 20:40:58 +090039const char *ftrace_print_hex_seq(struct trace_seq *p,
40 const unsigned char *buf, int len);
41
Li Zefanf71130d2013-02-21 10:32:38 +080042struct trace_iterator;
43struct trace_event;
44
45int ftrace_raw_output_prep(struct trace_iterator *iter,
46 struct trace_event *event);
47
Steven Rostedt97f20252009-04-13 11:20:49 -040048/*
49 * The trace entry - the most basic unit of tracing. This is what
50 * is printed in the end as a single line in the trace output, such as:
51 *
52 * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
53 */
54struct trace_entry {
Steven Rostedt89ec0de2009-03-26 11:03:29 -040055 unsigned short type;
Steven Rostedt97f20252009-04-13 11:20:49 -040056 unsigned char flags;
57 unsigned char preempt_count;
58 int pid;
Steven Rostedt97f20252009-04-13 11:20:49 -040059};
60
Steven Rostedt89ec0de2009-03-26 11:03:29 -040061#define FTRACE_MAX_EVENT \
62 ((1 << (sizeof(((struct trace_entry *)0)->type) * 8)) - 1)
63
Steven Rostedt97f20252009-04-13 11:20:49 -040064/*
65 * Trace iterator - used by printout routines who present trace
66 * results to users and which routines might sleep, etc:
67 */
68struct trace_iterator {
69 struct trace_array *tr;
70 struct tracer *trace;
Steven Rostedt (Red Hat)12883ef2013-03-05 09:24:35 -050071 struct trace_buffer *trace_buffer;
Steven Rostedt97f20252009-04-13 11:20:49 -040072 void *private;
73 int cpu_file;
74 struct mutex mutex;
Steven Rostedt6d158a82012-06-27 20:46:14 -040075 struct ring_buffer_iter **buffer_iter;
Steven Rostedt112f38a72009-06-01 15:16:05 -040076 unsigned long iter_flags;
Steven Rostedt97f20252009-04-13 11:20:49 -040077
Lai Jiangshanbc289ae2010-06-03 18:26:24 +080078 /* trace_seq for __print_flags() and __print_symbolic() etc. */
79 struct trace_seq tmp_seq;
80
Andrew Vagined5467d2013-08-02 21:16:43 +040081 cpumask_var_t started;
82
83 /* it's true when current open file is snapshot */
84 bool snapshot;
85
Steven Rostedt97f20252009-04-13 11:20:49 -040086 /* The below is zeroed out in pipe_read */
87 struct trace_seq seq;
88 struct trace_entry *ent;
Steven Rostedtbc21b472010-03-31 19:49:26 -040089 unsigned long lost_events;
Steven Rostedta63ce5b2009-12-07 09:11:39 -050090 int leftover;
Steven Rostedt4a9bd3f2011-07-14 16:36:53 -040091 int ent_size;
Steven Rostedt97f20252009-04-13 11:20:49 -040092 int cpu;
93 u64 ts;
94
Steven Rostedt97f20252009-04-13 11:20:49 -040095 loff_t pos;
96 long idx;
97
Andrew Vagined5467d2013-08-02 21:16:43 +040098 /* All new field here will be zeroed out in pipe_read */
Steven Rostedt97f20252009-04-13 11:20:49 -040099};
100
David Sharp8be07092012-11-13 12:18:22 -0800101enum trace_iter_flags {
102 TRACE_FILE_LAT_FMT = 1,
103 TRACE_FILE_ANNOTATE = 2,
104 TRACE_FILE_TIME_IN_NS = 4,
105};
106
Steven Rostedt97f20252009-04-13 11:20:49 -0400107
108typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter,
Steven Rostedta9a57762010-04-22 18:46:14 -0400109 int flags, struct trace_event *event);
110
111struct trace_event_functions {
Steven Rostedt97f20252009-04-13 11:20:49 -0400112 trace_print_func trace;
113 trace_print_func raw;
114 trace_print_func hex;
115 trace_print_func binary;
116};
117
Steven Rostedta9a57762010-04-22 18:46:14 -0400118struct trace_event {
119 struct hlist_node node;
120 struct list_head list;
121 int type;
122 struct trace_event_functions *funcs;
123};
124
Steven Rostedt97f20252009-04-13 11:20:49 -0400125extern int register_ftrace_event(struct trace_event *event);
126extern int unregister_ftrace_event(struct trace_event *event);
127
128/* Return values for print_line callback */
129enum print_line_t {
130 TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
131 TRACE_TYPE_HANDLED = 1,
132 TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */
133 TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */
134};
135
Frederic Weisbeckerf413cdb2009-08-07 01:25:54 +0200136void tracing_generic_entry_update(struct trace_entry *entry,
137 unsigned long flags,
138 int pc);
Steven Rostedtccb469a2012-08-02 10:32:10 -0400139struct ftrace_event_file;
140
141struct ring_buffer_event *
142trace_event_buffer_lock_reserve(struct ring_buffer **current_buffer,
143 struct ftrace_event_file *ftrace_file,
144 int type, unsigned long len,
145 unsigned long flags, int pc);
Steven Rostedt97f20252009-04-13 11:20:49 -0400146struct ring_buffer_event *
Steven Rostedte77405a2009-09-02 14:17:06 -0400147trace_current_buffer_lock_reserve(struct ring_buffer **current_buffer,
148 int type, unsigned long len,
Steven Rostedt97f20252009-04-13 11:20:49 -0400149 unsigned long flags, int pc);
Steven Rostedte77405a2009-09-02 14:17:06 -0400150void trace_current_buffer_unlock_commit(struct ring_buffer *buffer,
151 struct ring_buffer_event *event,
Steven Rostedt97f20252009-04-13 11:20:49 -0400152 unsigned long flags, int pc);
Steven Rostedt0d5c6e12012-11-01 20:54:21 -0400153void trace_buffer_unlock_commit(struct ring_buffer *buffer,
154 struct ring_buffer_event *event,
155 unsigned long flags, int pc);
156void trace_buffer_unlock_commit_regs(struct ring_buffer *buffer,
157 struct ring_buffer_event *event,
158 unsigned long flags, int pc,
159 struct pt_regs *regs);
Steven Rostedte77405a2009-09-02 14:17:06 -0400160void trace_current_buffer_discard_commit(struct ring_buffer *buffer,
161 struct ring_buffer_event *event);
Steven Rostedt97f20252009-04-13 11:20:49 -0400162
163void tracing_record_cmdline(struct task_struct *tsk);
164
Li Zefan1f9963c2009-07-20 10:20:53 +0800165struct event_filter;
166
Steven Rostedt22392912010-04-21 12:27:06 -0400167enum trace_reg {
168 TRACE_REG_REGISTER,
169 TRACE_REG_UNREGISTER,
Jiri Olsa37d73992012-03-14 00:03:02 +0100170#ifdef CONFIG_PERF_EVENTS
Steven Rostedt22392912010-04-21 12:27:06 -0400171 TRACE_REG_PERF_REGISTER,
172 TRACE_REG_PERF_UNREGISTER,
Jiri Olsaceec0b62012-02-15 15:51:49 +0100173 TRACE_REG_PERF_OPEN,
174 TRACE_REG_PERF_CLOSE,
Jiri Olsa489c75c2012-02-15 15:51:50 +0100175 TRACE_REG_PERF_ADD,
176 TRACE_REG_PERF_DEL,
Jiri Olsa37d73992012-03-14 00:03:02 +0100177#endif
Steven Rostedt22392912010-04-21 12:27:06 -0400178};
179
180struct ftrace_event_call;
181
Steven Rostedt8f082012010-04-20 10:47:33 -0400182struct ftrace_event_class {
183 char *system;
Steven Rostedt22392912010-04-21 12:27:06 -0400184 void *probe;
185#ifdef CONFIG_PERF_EVENTS
186 void *perf_probe;
187#endif
188 int (*reg)(struct ftrace_event_call *event,
Jiri Olsaceec0b62012-02-15 15:51:49 +0100189 enum trace_reg type, void *data);
Steven Rostedt2e33af02010-04-22 10:35:55 -0400190 int (*define_fields)(struct ftrace_event_call *);
191 struct list_head *(*get_fields)(struct ftrace_event_call *);
192 struct list_head fields;
Steven Rostedt0405ab82010-04-22 11:46:44 -0400193 int (*raw_init)(struct ftrace_event_call *);
Steven Rostedt8f082012010-04-20 10:47:33 -0400194};
195
Steven Rostedta1d0ce82010-06-08 11:22:06 -0400196extern int ftrace_event_reg(struct ftrace_event_call *event,
Jiri Olsaceec0b62012-02-15 15:51:49 +0100197 enum trace_reg type, void *data);
Steven Rostedta1d0ce82010-06-08 11:22:06 -0400198
Steven Rostedt553552c2010-04-23 11:12:36 -0400199enum {
Steven Rostedt553552c2010-04-23 11:12:36 -0400200 TRACE_EVENT_FL_FILTERED_BIT,
Frederic Weisbecker61c32652010-11-18 01:39:17 +0100201 TRACE_EVENT_FL_CAP_ANY_BIT,
Li Zefan27b14b52011-11-01 09:09:35 +0800202 TRACE_EVENT_FL_NO_SET_FILTER_BIT,
Steven Rostedt9b637762012-05-10 15:55:43 -0400203 TRACE_EVENT_FL_IGNORE_ENABLE_BIT,
Steven Rostedt (Red Hat)575380d2013-03-04 23:05:12 -0500204 TRACE_EVENT_FL_WAS_ENABLED_BIT,
Tom Zanussif306cc82013-10-24 08:34:17 -0500205 TRACE_EVENT_FL_USE_CALL_FILTER_BIT,
Steven Rostedt553552c2010-04-23 11:12:36 -0400206};
207
Steven Rostedtae63b312012-05-03 23:09:03 -0400208/*
209 * Event flags:
210 * FILTERED - The event has a filter attached
211 * CAP_ANY - Any user can enable for perf
212 * NO_SET_FILTER - Set when filter has error and is to be ignored
Steven Rostedt (Red Hat)2a30c112013-03-04 22:27:04 -0500213 * IGNORE_ENABLE - For ftrace internal events, do not enable with debugfs file
Steven Rostedt (Red Hat)575380d2013-03-04 23:05:12 -0500214 * WAS_ENABLED - Set and stays set when an event was ever enabled
215 * (used for module unloading, if a module event is enabled,
216 * it is best to clear the buffers that used it).
Tom Zanussif306cc82013-10-24 08:34:17 -0500217 * USE_CALL_FILTER - For ftrace internal events, don't use file filter
Steven Rostedtae63b312012-05-03 23:09:03 -0400218 */
Steven Rostedt553552c2010-04-23 11:12:36 -0400219enum {
Li Zefane870e9a2010-07-02 11:07:32 +0800220 TRACE_EVENT_FL_FILTERED = (1 << TRACE_EVENT_FL_FILTERED_BIT),
Frederic Weisbecker61c32652010-11-18 01:39:17 +0100221 TRACE_EVENT_FL_CAP_ANY = (1 << TRACE_EVENT_FL_CAP_ANY_BIT),
Li Zefan27b14b52011-11-01 09:09:35 +0800222 TRACE_EVENT_FL_NO_SET_FILTER = (1 << TRACE_EVENT_FL_NO_SET_FILTER_BIT),
Steven Rostedt9b637762012-05-10 15:55:43 -0400223 TRACE_EVENT_FL_IGNORE_ENABLE = (1 << TRACE_EVENT_FL_IGNORE_ENABLE_BIT),
Steven Rostedt (Red Hat)575380d2013-03-04 23:05:12 -0500224 TRACE_EVENT_FL_WAS_ENABLED = (1 << TRACE_EVENT_FL_WAS_ENABLED_BIT),
Tom Zanussif306cc82013-10-24 08:34:17 -0500225 TRACE_EVENT_FL_USE_CALL_FILTER = (1 << TRACE_EVENT_FL_USE_CALL_FILTER_BIT),
Steven Rostedt553552c2010-04-23 11:12:36 -0400226};
227
Steven Rostedt97f20252009-04-13 11:20:49 -0400228struct ftrace_event_call {
Steven Rostedta59fd602009-04-10 13:52:20 -0400229 struct list_head list;
Steven Rostedt8f082012010-04-20 10:47:33 -0400230 struct ftrace_event_class *class;
Steven Rostedt97f20252009-04-13 11:20:49 -0400231 char *name;
Steven Rostedt80decc72010-04-23 10:00:22 -0400232 struct trace_event event;
Lai Jiangshan509e7602009-12-15 15:39:42 +0800233 const char *print_fmt;
Li Zefan1f9963c2009-07-20 10:20:53 +0800234 struct event_filter *filter;
Steven Rostedtae63b312012-05-03 23:09:03 -0400235 struct list_head *files;
Steven Rostedt6d723732009-04-10 14:53:50 -0400236 void *mod;
Jason Baron69fd4f02009-08-10 16:52:44 -0400237 void *data;
Steven Rostedt (Red Hat)57d01ad2013-03-12 12:38:06 -0400238 /*
239 * bit 0: filter_active
240 * bit 1: allow trace by non root (cap any)
241 * bit 2: failed to apply filter
242 * bit 3: ftrace internal event (do not enable)
243 * bit 4: Event was enabled by module
Tom Zanussif306cc82013-10-24 08:34:17 -0500244 * bit 5: use call filter rather than file filter
Steven Rostedt (Red Hat)57d01ad2013-03-12 12:38:06 -0400245 */
Steven Rostedtae63b312012-05-03 23:09:03 -0400246 int flags; /* static flags of different events */
247
248#ifdef CONFIG_PERF_EVENTS
249 int perf_refcount;
250 struct hlist_head __percpu *perf_events;
Peter Zijlstrad5b5f392013-11-14 16:23:04 +0100251
252 int (*perf_perm)(struct ftrace_event_call *,
253 struct perf_event *);
Steven Rostedtae63b312012-05-03 23:09:03 -0400254#endif
255};
256
257struct trace_array;
258struct ftrace_subsystem_dir;
259
260enum {
261 FTRACE_EVENT_FL_ENABLED_BIT,
262 FTRACE_EVENT_FL_RECORDED_CMD_BIT,
Tom Zanussif306cc82013-10-24 08:34:17 -0500263 FTRACE_EVENT_FL_FILTERED_BIT,
264 FTRACE_EVENT_FL_NO_SET_FILTER_BIT,
Steven Rostedt (Red Hat)417944c2013-03-12 13:26:18 -0400265 FTRACE_EVENT_FL_SOFT_MODE_BIT,
266 FTRACE_EVENT_FL_SOFT_DISABLED_BIT,
Steven Rostedtae63b312012-05-03 23:09:03 -0400267};
268
269/*
270 * Ftrace event file flags:
Steven Rostedt (Red Hat)57d01ad2013-03-12 12:38:06 -0400271 * ENABLED - The event is enabled
Steven Rostedtae63b312012-05-03 23:09:03 -0400272 * RECORDED_CMD - The comms should be recorded at sched_switch
Tom Zanussif306cc82013-10-24 08:34:17 -0500273 * FILTERED - The event has a filter attached
274 * NO_SET_FILTER - Set when filter has error and is to be ignored
Steven Rostedt (Red Hat)417944c2013-03-12 13:26:18 -0400275 * SOFT_MODE - The event is enabled/disabled by SOFT_DISABLED
276 * SOFT_DISABLED - When set, do not trace the event (even though its
277 * tracepoint may be enabled)
Steven Rostedtae63b312012-05-03 23:09:03 -0400278 */
279enum {
280 FTRACE_EVENT_FL_ENABLED = (1 << FTRACE_EVENT_FL_ENABLED_BIT),
281 FTRACE_EVENT_FL_RECORDED_CMD = (1 << FTRACE_EVENT_FL_RECORDED_CMD_BIT),
Tom Zanussif306cc82013-10-24 08:34:17 -0500282 FTRACE_EVENT_FL_FILTERED = (1 << FTRACE_EVENT_FL_FILTERED_BIT),
283 FTRACE_EVENT_FL_NO_SET_FILTER = (1 << FTRACE_EVENT_FL_NO_SET_FILTER_BIT),
Steven Rostedt (Red Hat)417944c2013-03-12 13:26:18 -0400284 FTRACE_EVENT_FL_SOFT_MODE = (1 << FTRACE_EVENT_FL_SOFT_MODE_BIT),
285 FTRACE_EVENT_FL_SOFT_DISABLED = (1 << FTRACE_EVENT_FL_SOFT_DISABLED_BIT),
Steven Rostedtae63b312012-05-03 23:09:03 -0400286};
287
288struct ftrace_event_file {
289 struct list_head list;
290 struct ftrace_event_call *event_call;
Tom Zanussif306cc82013-10-24 08:34:17 -0500291 struct event_filter *filter;
Steven Rostedtae63b312012-05-03 23:09:03 -0400292 struct dentry *dir;
293 struct trace_array *tr;
294 struct ftrace_subsystem_dir *system;
Steven Rostedt97f20252009-04-13 11:20:49 -0400295
Steven Rostedt553552c2010-04-23 11:12:36 -0400296 /*
297 * 32 bit flags:
Steven Rostedt (Red Hat)57d01ad2013-03-12 12:38:06 -0400298 * bit 0: enabled
299 * bit 1: enabled cmd record
Steven Rostedt (Red Hat)417944c2013-03-12 13:26:18 -0400300 * bit 2: enable/disable with the soft disable bit
301 * bit 3: soft disabled
Steven Rostedt553552c2010-04-23 11:12:36 -0400302 *
Steven Rostedt (Red Hat)417944c2013-03-12 13:26:18 -0400303 * Note: The bits must be set atomically to prevent races
304 * from other writers. Reads of flags do not need to be in
305 * sync as they occur in critical sections. But the way flags
Steven Rostedtae63b312012-05-03 23:09:03 -0400306 * is currently used, these changes do not affect the code
Steven Rostedt1eaa4782010-05-14 10:19:13 -0400307 * except that when a change is made, it may have a slight
308 * delay in propagating the changes to other CPUs due to
Steven Rostedt (Red Hat)417944c2013-03-12 13:26:18 -0400309 * caching and such. Which is mostly OK ;-)
Steven Rostedt553552c2010-04-23 11:12:36 -0400310 */
Steven Rostedt (Red Hat)417944c2013-03-12 13:26:18 -0400311 unsigned long flags;
Masami Hiramatsu1cf4c072013-05-09 14:44:29 +0900312 atomic_t sm_ref; /* soft-mode reference counter */
Steven Rostedt97f20252009-04-13 11:20:49 -0400313};
314
Frederic Weisbecker53cf810b2010-11-18 02:11:42 +0100315#define __TRACE_EVENT_FLAGS(name, value) \
316 static int __init trace_init_flags_##name(void) \
317 { \
318 event_##name.flags = value; \
319 return 0; \
320 } \
321 early_initcall(trace_init_flags_##name);
322
Peter Zijlstrad5b5f392013-11-14 16:23:04 +0100323#define __TRACE_EVENT_PERF_PERM(name, expr...) \
324 static int perf_perm_##name(struct ftrace_event_call *tp_event, \
325 struct perf_event *p_event) \
326 { \
327 return ({ expr; }); \
328 } \
329 static int __init trace_init_perf_perm_##name(void) \
330 { \
331 event_##name.perf_perm = &perf_perm_##name; \
332 return 0; \
333 } \
334 early_initcall(trace_init_perf_perm_##name);
335
Frederic Weisbecker97d5a222010-03-05 05:35:37 +0100336#define PERF_MAX_TRACE_SIZE 2048
Frederic Weisbecker20ab44252009-09-18 06:10:28 +0200337
Steven Rostedt16bb8eb2009-09-12 19:04:54 -0400338#define MAX_FILTER_STR_VAL 256 /* Should handle KSYM_SYMBOL_LEN */
Steven Rostedt97f20252009-04-13 11:20:49 -0400339
Tom Zanussif306cc82013-10-24 08:34:17 -0500340extern void destroy_preds(struct ftrace_event_file *file);
341extern void destroy_call_preds(struct ftrace_event_call *call);
Li Zefan6fb29152009-10-15 11:21:42 +0800342extern int filter_match_preds(struct event_filter *filter, void *rec);
Tom Zanussif306cc82013-10-24 08:34:17 -0500343
344extern int filter_check_discard(struct ftrace_event_file *file, void *rec,
345 struct ring_buffer *buffer,
346 struct ring_buffer_event *event);
347extern int call_filter_check_discard(struct ftrace_event_call *call, void *rec,
348 struct ring_buffer *buffer,
349 struct ring_buffer_event *event);
Steven Rostedt97f20252009-04-13 11:20:49 -0400350
Li Zefan43b51ea2009-08-07 10:33:22 +0800351enum {
352 FILTER_OTHER = 0,
353 FILTER_STATIC_STRING,
354 FILTER_DYN_STRING,
Li Zefan87a342f2009-08-07 10:33:43 +0800355 FILTER_PTR_STRING,
Jiri Olsa02aa3162012-02-15 15:51:53 +0100356 FILTER_TRACE_FN,
Li Zefan43b51ea2009-08-07 10:33:22 +0800357};
358
Steven Rostedt04295782010-11-12 22:32:11 -0500359#define EVENT_STORAGE_SIZE 128
360extern struct mutex event_storage_mutex;
361extern char event_storage[EVENT_STORAGE_SIZE];
362
Li Zefan87d9b4e2009-12-08 11:14:20 +0800363extern int trace_event_raw_init(struct ftrace_event_call *call);
Frederic Weisbeckeraeaeae12009-08-27 05:09:51 +0200364extern int trace_define_field(struct ftrace_event_call *call, const char *type,
365 const char *name, int offset, int size,
366 int is_signed, int filter_type);
Masami Hiramatsubd1a5c82009-08-13 16:34:53 -0400367extern int trace_add_event_call(struct ftrace_event_call *call);
Oleg Nesterov2816c552013-07-29 19:50:33 +0200368extern int trace_remove_event_call(struct ftrace_event_call *call);
Steven Rostedt97f20252009-04-13 11:20:49 -0400369
Steven Rostedt (Red Hat)d2802d02013-04-19 17:10:27 -0400370#define is_signed_type(type) (((type)(-1)) < (type)1)
Steven Rostedt97f20252009-04-13 11:20:49 -0400371
Steven Rostedt4671c792009-05-08 16:27:41 -0400372int trace_set_clr_event(const char *system, const char *event, int set);
373
Steven Rostedt97f20252009-04-13 11:20:49 -0400374/*
375 * The double __builtin_constant_p is because gcc will give us an error
376 * if we try to allocate the static variable to fmt if it is not a
377 * constant. Even with the outer if statement optimizing out.
378 */
379#define event_trace_printk(ip, fmt, args...) \
380do { \
381 __trace_printk_check_format(fmt, ##args); \
382 tracing_record_cmdline(current); \
383 if (__builtin_constant_p(fmt)) { \
384 static const char *trace_printk_fmt \
385 __attribute__((section("__trace_printk_fmt"))) = \
386 __builtin_constant_p(fmt) ? fmt : NULL; \
387 \
388 __trace_bprintk(ip, trace_printk_fmt, ##args); \
389 } else \
390 __trace_printk(ip, fmt, ##args); \
391} while (0)
392
Steven Rostedt (Red Hat)102c9322013-07-12 17:07:27 -0400393/**
394 * tracepoint_string - register constant persistent string to trace system
395 * @str - a constant persistent string that will be referenced in tracepoints
396 *
397 * If constant strings are being used in tracepoints, it is faster and
398 * more efficient to just save the pointer to the string and reference
399 * that with a printf "%s" instead of saving the string in the ring buffer
400 * and wasting space and time.
401 *
402 * The problem with the above approach is that userspace tools that read
403 * the binary output of the trace buffers do not have access to the string.
404 * Instead they just show the address of the string which is not very
405 * useful to users.
406 *
407 * With tracepoint_string(), the string will be registered to the tracing
408 * system and exported to userspace via the debugfs/tracing/printk_formats
409 * file that maps the string address to the string text. This way userspace
410 * tools that read the binary buffers have a way to map the pointers to
411 * the ASCII strings they represent.
412 *
413 * The @str used must be a constant string and persistent as it would not
414 * make sense to show a string that no longer exists. But it is still fine
415 * to be used with modules, because when modules are unloaded, if they
416 * had tracepoints, the ring buffers are cleared too. As long as the string
417 * does not change during the life of the module, it is fine to use
418 * tracepoint_string() within a module.
419 */
420#define tracepoint_string(str) \
421 ({ \
422 static const char *___tp_str __tracepoint_string = str; \
423 ___tp_str; \
424 })
425#define __tracepoint_string __attribute__((section("__tracepoint_str")))
426
Li Zefan07b139c2009-12-21 14:27:35 +0800427#ifdef CONFIG_PERF_EVENTS
Li Zefan6fb29152009-10-15 11:21:42 +0800428struct perf_event;
Frederic Weisbeckerc5306652010-03-03 07:16:16 +0100429
430DECLARE_PER_CPU(struct pt_regs, perf_trace_regs);
431
Peter Zijlstra1c024eca2010-05-19 14:02:22 +0200432extern int perf_trace_init(struct perf_event *event);
433extern void perf_trace_destroy(struct perf_event *event);
Peter Zijlstraa4eaf7f2010-06-16 14:37:10 +0200434extern int perf_trace_add(struct perf_event *event, int flags);
435extern void perf_trace_del(struct perf_event *event, int flags);
Peter Zijlstra1c024eca2010-05-19 14:02:22 +0200436extern int ftrace_profile_set_filter(struct perf_event *event, int event_id,
Li Zefan6fb29152009-10-15 11:21:42 +0800437 char *filter_str);
438extern void ftrace_profile_free_filter(struct perf_event *event);
Peter Zijlstrab7e2ece2010-05-19 10:52:27 +0200439extern void *perf_trace_buf_prepare(int size, unsigned short type,
440 struct pt_regs *regs, int *rctxp);
Xiao Guangrong430ad5a2010-01-28 09:32:29 +0800441
442static inline void
Frederic Weisbecker97d5a222010-03-05 05:35:37 +0100443perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr,
Andrew Vagine6dab5f2012-07-11 18:14:58 +0400444 u64 count, struct pt_regs *regs, void *head,
445 struct task_struct *task)
Xiao Guangrong430ad5a2010-01-28 09:32:29 +0800446{
Andrew Vagine6dab5f2012-07-11 18:14:58 +0400447 perf_tp_event(addr, count, raw_data, size, regs, head, rctx, task);
Xiao Guangrong430ad5a2010-01-28 09:32:29 +0800448}
Li Zefan6fb29152009-10-15 11:21:42 +0800449#endif
450
Steven Rostedt97f20252009-04-13 11:20:49 -0400451#endif /* _LINUX_FTRACE_EVENT_H */