ftrace: Constify ftrace_text_reserved
[linux-2.6-block.git] / include / linux / ftrace_event.h
CommitLineData
bac5fb97 1
97f20251
SR
2#ifndef _LINUX_FTRACE_EVENT_H
3#define _LINUX_FTRACE_EVENT_H
4
97f20251 5#include <linux/ring_buffer.h>
16bb8eb1 6#include <linux/trace_seq.h>
be74b73a 7#include <linux/percpu.h>
20ab4425 8#include <linux/hardirq.h>
430ad5a6 9#include <linux/perf_event.h>
97f20251
SR
10
11struct trace_array;
12883efb 12struct trace_buffer;
97f20251 13struct tracer;
6d723736 14struct dentry;
97f20251 15
be74b73a
SR
16struct trace_print_flags {
17 unsigned long mask;
18 const char *name;
19};
20
2fc1b6f0 21struct trace_print_flags_u64 {
22 unsigned long long mask;
23 const char *name;
24};
25
be74b73a
SR
26const char *ftrace_print_flags_seq(struct trace_seq *p, const char *delim,
27 unsigned long flags,
28 const struct trace_print_flags *flag_array);
29
0f4fc29d
SR
30const char *ftrace_print_symbols_seq(struct trace_seq *p, unsigned long val,
31 const struct trace_print_flags *symbol_array);
32
2fc1b6f0 33#if BITS_PER_LONG == 32
34const char *ftrace_print_symbols_seq_u64(struct trace_seq *p,
35 unsigned long long val,
36 const struct trace_print_flags_u64
37 *symbol_array);
38#endif
39
5a2e3995
KT
40const char *ftrace_print_hex_seq(struct trace_seq *p,
41 const unsigned char *buf, int len);
42
f71130de
LZ
43struct trace_iterator;
44struct trace_event;
45
46int ftrace_raw_output_prep(struct trace_iterator *iter,
47 struct trace_event *event);
48
97f20251
SR
49/*
50 * The trace entry - the most basic unit of tracing. This is what
51 * is printed in the end as a single line in the trace output, such as:
52 *
53 * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
54 */
55struct trace_entry {
89ec0dee 56 unsigned short type;
97f20251
SR
57 unsigned char flags;
58 unsigned char preempt_count;
59 int pid;
97f20251
SR
60};
61
89ec0dee
SR
62#define FTRACE_MAX_EVENT \
63 ((1 << (sizeof(((struct trace_entry *)0)->type) * 8)) - 1)
64
97f20251
SR
65/*
66 * Trace iterator - used by printout routines who present trace
67 * results to users and which routines might sleep, etc:
68 */
69struct trace_iterator {
70 struct trace_array *tr;
71 struct tracer *trace;
12883efb 72 struct trace_buffer *trace_buffer;
97f20251
SR
73 void *private;
74 int cpu_file;
75 struct mutex mutex;
6d158a81 76 struct ring_buffer_iter **buffer_iter;
112f38a7 77 unsigned long iter_flags;
97f20251 78
bc289ae9
LJ
79 /* trace_seq for __print_flags() and __print_symbolic() etc. */
80 struct trace_seq tmp_seq;
81
ed5467da
AV
82 cpumask_var_t started;
83
84 /* it's true when current open file is snapshot */
85 bool snapshot;
86
97f20251
SR
87 /* The below is zeroed out in pipe_read */
88 struct trace_seq seq;
89 struct trace_entry *ent;
bc21b478 90 unsigned long lost_events;
a63ce5b3 91 int leftover;
4a9bd3f1 92 int ent_size;
97f20251
SR
93 int cpu;
94 u64 ts;
95
97f20251
SR
96 loff_t pos;
97 long idx;
98
ed5467da 99 /* All new field here will be zeroed out in pipe_read */
97f20251
SR
100};
101
8be0709f
DS
102enum trace_iter_flags {
103 TRACE_FILE_LAT_FMT = 1,
104 TRACE_FILE_ANNOTATE = 2,
105 TRACE_FILE_TIME_IN_NS = 4,
106};
107
97f20251
SR
108
109typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter,
a9a57763
SR
110 int flags, struct trace_event *event);
111
112struct trace_event_functions {
97f20251
SR
113 trace_print_func trace;
114 trace_print_func raw;
115 trace_print_func hex;
116 trace_print_func binary;
117};
118
a9a57763
SR
119struct trace_event {
120 struct hlist_node node;
121 struct list_head list;
122 int type;
123 struct trace_event_functions *funcs;
124};
125
97f20251
SR
126extern int register_ftrace_event(struct trace_event *event);
127extern int unregister_ftrace_event(struct trace_event *event);
128
129/* Return values for print_line callback */
130enum print_line_t {
131 TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
132 TRACE_TYPE_HANDLED = 1,
133 TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */
134 TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */
135};
136
f413cdb8
FW
137void tracing_generic_entry_update(struct trace_entry *entry,
138 unsigned long flags,
139 int pc);
ccb469a1
SR
140struct ftrace_event_file;
141
142struct ring_buffer_event *
143trace_event_buffer_lock_reserve(struct ring_buffer **current_buffer,
144 struct ftrace_event_file *ftrace_file,
145 int type, unsigned long len,
146 unsigned long flags, int pc);
97f20251 147struct ring_buffer_event *
e77405ad
SR
148trace_current_buffer_lock_reserve(struct ring_buffer **current_buffer,
149 int type, unsigned long len,
97f20251 150 unsigned long flags, int pc);
e77405ad
SR
151void trace_current_buffer_unlock_commit(struct ring_buffer *buffer,
152 struct ring_buffer_event *event,
97f20251 153 unsigned long flags, int pc);
0d5c6e1c
SR
154void trace_buffer_unlock_commit(struct ring_buffer *buffer,
155 struct ring_buffer_event *event,
156 unsigned long flags, int pc);
157void trace_buffer_unlock_commit_regs(struct ring_buffer *buffer,
158 struct ring_buffer_event *event,
159 unsigned long flags, int pc,
160 struct pt_regs *regs);
e77405ad
SR
161void trace_current_buffer_discard_commit(struct ring_buffer *buffer,
162 struct ring_buffer_event *event);
97f20251
SR
163
164void tracing_record_cmdline(struct task_struct *tsk);
165
1d6bae96
SR
166int ftrace_output_call(struct trace_iterator *iter, char *name, char *fmt, ...);
167
1f9963cb
LZ
168struct event_filter;
169
2239291a
SR
170enum trace_reg {
171 TRACE_REG_REGISTER,
172 TRACE_REG_UNREGISTER,
37d73998 173#ifdef CONFIG_PERF_EVENTS
2239291a
SR
174 TRACE_REG_PERF_REGISTER,
175 TRACE_REG_PERF_UNREGISTER,
ceec0b6f
JO
176 TRACE_REG_PERF_OPEN,
177 TRACE_REG_PERF_CLOSE,
489c75c3
JO
178 TRACE_REG_PERF_ADD,
179 TRACE_REG_PERF_DEL,
37d73998 180#endif
2239291a
SR
181};
182
183struct ftrace_event_call;
184
8f082018
SR
185struct ftrace_event_class {
186 char *system;
2239291a
SR
187 void *probe;
188#ifdef CONFIG_PERF_EVENTS
189 void *perf_probe;
190#endif
191 int (*reg)(struct ftrace_event_call *event,
ceec0b6f 192 enum trace_reg type, void *data);
2e33af02
SR
193 int (*define_fields)(struct ftrace_event_call *);
194 struct list_head *(*get_fields)(struct ftrace_event_call *);
195 struct list_head fields;
0405ab80 196 int (*raw_init)(struct ftrace_event_call *);
8f082018
SR
197};
198
a1d0ce82 199extern int ftrace_event_reg(struct ftrace_event_call *event,
ceec0b6f 200 enum trace_reg type, void *data);
a1d0ce82 201
1d6bae96
SR
202int ftrace_output_event(struct trace_iterator *iter, struct ftrace_event_call *event,
203 char *fmt, ...);
204
35bb4399
SR
205int ftrace_event_define_field(struct ftrace_event_call *call,
206 char *type, int len, char *item, int offset,
207 int field_size, int sign, int filter);
208
3fd40d1e
SR
209struct ftrace_event_buffer {
210 struct ring_buffer *buffer;
211 struct ring_buffer_event *event;
212 struct ftrace_event_file *ftrace_file;
213 void *entry;
214 unsigned long flags;
215 int pc;
216};
217
218void *ftrace_event_buffer_reserve(struct ftrace_event_buffer *fbuffer,
219 struct ftrace_event_file *ftrace_file,
220 unsigned long len);
221
222void ftrace_event_buffer_commit(struct ftrace_event_buffer *fbuffer);
223
553552ce 224enum {
553552ce 225 TRACE_EVENT_FL_FILTERED_BIT,
61c32659 226 TRACE_EVENT_FL_CAP_ANY_BIT,
27b14b56 227 TRACE_EVENT_FL_NO_SET_FILTER_BIT,
9b63776f 228 TRACE_EVENT_FL_IGNORE_ENABLE_BIT,
575380da 229 TRACE_EVENT_FL_WAS_ENABLED_BIT,
f306cc82 230 TRACE_EVENT_FL_USE_CALL_FILTER_BIT,
553552ce
SR
231};
232
ae63b31e
SR
233/*
234 * Event flags:
235 * FILTERED - The event has a filter attached
236 * CAP_ANY - Any user can enable for perf
237 * NO_SET_FILTER - Set when filter has error and is to be ignored
2a30c11f 238 * IGNORE_ENABLE - For ftrace internal events, do not enable with debugfs file
575380da
SRRH
239 * WAS_ENABLED - Set and stays set when an event was ever enabled
240 * (used for module unloading, if a module event is enabled,
241 * it is best to clear the buffers that used it).
f306cc82 242 * USE_CALL_FILTER - For ftrace internal events, don't use file filter
ae63b31e 243 */
553552ce 244enum {
e870e9a1 245 TRACE_EVENT_FL_FILTERED = (1 << TRACE_EVENT_FL_FILTERED_BIT),
61c32659 246 TRACE_EVENT_FL_CAP_ANY = (1 << TRACE_EVENT_FL_CAP_ANY_BIT),
27b14b56 247 TRACE_EVENT_FL_NO_SET_FILTER = (1 << TRACE_EVENT_FL_NO_SET_FILTER_BIT),
9b63776f 248 TRACE_EVENT_FL_IGNORE_ENABLE = (1 << TRACE_EVENT_FL_IGNORE_ENABLE_BIT),
575380da 249 TRACE_EVENT_FL_WAS_ENABLED = (1 << TRACE_EVENT_FL_WAS_ENABLED_BIT),
f306cc82 250 TRACE_EVENT_FL_USE_CALL_FILTER = (1 << TRACE_EVENT_FL_USE_CALL_FILTER_BIT),
553552ce
SR
251};
252
97f20251 253struct ftrace_event_call {
a59fd602 254 struct list_head list;
8f082018 255 struct ftrace_event_class *class;
97f20251 256 char *name;
80decc70 257 struct trace_event event;
509e760c 258 const char *print_fmt;
1f9963cb 259 struct event_filter *filter;
ae63b31e 260 struct list_head *files;
6d723736 261 void *mod;
69fd4f0e 262 void *data;
57d01ad0
SRRH
263 /*
264 * bit 0: filter_active
265 * bit 1: allow trace by non root (cap any)
266 * bit 2: failed to apply filter
267 * bit 3: ftrace internal event (do not enable)
268 * bit 4: Event was enabled by module
f306cc82 269 * bit 5: use call filter rather than file filter
57d01ad0 270 */
ae63b31e
SR
271 int flags; /* static flags of different events */
272
273#ifdef CONFIG_PERF_EVENTS
274 int perf_refcount;
275 struct hlist_head __percpu *perf_events;
d5b5f391
PZ
276
277 int (*perf_perm)(struct ftrace_event_call *,
278 struct perf_event *);
ae63b31e
SR
279#endif
280};
281
282struct trace_array;
283struct ftrace_subsystem_dir;
284
285enum {
286 FTRACE_EVENT_FL_ENABLED_BIT,
287 FTRACE_EVENT_FL_RECORDED_CMD_BIT,
f306cc82
TZ
288 FTRACE_EVENT_FL_FILTERED_BIT,
289 FTRACE_EVENT_FL_NO_SET_FILTER_BIT,
417944c4
SRRH
290 FTRACE_EVENT_FL_SOFT_MODE_BIT,
291 FTRACE_EVENT_FL_SOFT_DISABLED_BIT,
85f2b082 292 FTRACE_EVENT_FL_TRIGGER_MODE_BIT,
bac5fb97 293 FTRACE_EVENT_FL_TRIGGER_COND_BIT,
ae63b31e
SR
294};
295
296/*
297 * Ftrace event file flags:
57d01ad0 298 * ENABLED - The event is enabled
ae63b31e 299 * RECORDED_CMD - The comms should be recorded at sched_switch
f306cc82
TZ
300 * FILTERED - The event has a filter attached
301 * NO_SET_FILTER - Set when filter has error and is to be ignored
417944c4
SRRH
302 * SOFT_MODE - The event is enabled/disabled by SOFT_DISABLED
303 * SOFT_DISABLED - When set, do not trace the event (even though its
304 * tracepoint may be enabled)
85f2b082 305 * TRIGGER_MODE - When set, invoke the triggers associated with the event
bac5fb97 306 * TRIGGER_COND - When set, one or more triggers has an associated filter
ae63b31e
SR
307 */
308enum {
309 FTRACE_EVENT_FL_ENABLED = (1 << FTRACE_EVENT_FL_ENABLED_BIT),
310 FTRACE_EVENT_FL_RECORDED_CMD = (1 << FTRACE_EVENT_FL_RECORDED_CMD_BIT),
f306cc82
TZ
311 FTRACE_EVENT_FL_FILTERED = (1 << FTRACE_EVENT_FL_FILTERED_BIT),
312 FTRACE_EVENT_FL_NO_SET_FILTER = (1 << FTRACE_EVENT_FL_NO_SET_FILTER_BIT),
417944c4
SRRH
313 FTRACE_EVENT_FL_SOFT_MODE = (1 << FTRACE_EVENT_FL_SOFT_MODE_BIT),
314 FTRACE_EVENT_FL_SOFT_DISABLED = (1 << FTRACE_EVENT_FL_SOFT_DISABLED_BIT),
85f2b082 315 FTRACE_EVENT_FL_TRIGGER_MODE = (1 << FTRACE_EVENT_FL_TRIGGER_MODE_BIT),
bac5fb97 316 FTRACE_EVENT_FL_TRIGGER_COND = (1 << FTRACE_EVENT_FL_TRIGGER_COND_BIT),
ae63b31e
SR
317};
318
319struct ftrace_event_file {
320 struct list_head list;
321 struct ftrace_event_call *event_call;
f306cc82 322 struct event_filter *filter;
ae63b31e
SR
323 struct dentry *dir;
324 struct trace_array *tr;
325 struct ftrace_subsystem_dir *system;
85f2b082 326 struct list_head triggers;
97f20251 327
553552ce
SR
328 /*
329 * 32 bit flags:
57d01ad0
SRRH
330 * bit 0: enabled
331 * bit 1: enabled cmd record
417944c4
SRRH
332 * bit 2: enable/disable with the soft disable bit
333 * bit 3: soft disabled
85f2b082 334 * bit 4: trigger enabled
553552ce 335 *
417944c4
SRRH
336 * Note: The bits must be set atomically to prevent races
337 * from other writers. Reads of flags do not need to be in
338 * sync as they occur in critical sections. But the way flags
ae63b31e 339 * is currently used, these changes do not affect the code
1eaa4787
SR
340 * except that when a change is made, it may have a slight
341 * delay in propagating the changes to other CPUs due to
417944c4 342 * caching and such. Which is mostly OK ;-)
553552ce 343 */
417944c4 344 unsigned long flags;
1cf4c073 345 atomic_t sm_ref; /* soft-mode reference counter */
85f2b082 346 atomic_t tm_ref; /* trigger-mode reference counter */
97f20251
SR
347};
348
53cf810b
FW
349#define __TRACE_EVENT_FLAGS(name, value) \
350 static int __init trace_init_flags_##name(void) \
351 { \
352 event_##name.flags = value; \
353 return 0; \
354 } \
355 early_initcall(trace_init_flags_##name);
356
d5b5f391
PZ
357#define __TRACE_EVENT_PERF_PERM(name, expr...) \
358 static int perf_perm_##name(struct ftrace_event_call *tp_event, \
359 struct perf_event *p_event) \
360 { \
361 return ({ expr; }); \
362 } \
363 static int __init trace_init_perf_perm_##name(void) \
364 { \
365 event_##name.perf_perm = &perf_perm_##name; \
366 return 0; \
367 } \
368 early_initcall(trace_init_perf_perm_##name);
369
97d5a220 370#define PERF_MAX_TRACE_SIZE 2048
20ab4425 371
16bb8eb1 372#define MAX_FILTER_STR_VAL 256 /* Should handle KSYM_SYMBOL_LEN */
97f20251 373
85f2b082
TZ
374enum event_trigger_type {
375 ETT_NONE = (0),
2a2df321 376 ETT_TRACE_ONOFF = (1 << 0),
93e31ffb 377 ETT_SNAPSHOT = (1 << 1),
f21ecbb3 378 ETT_STACKTRACE = (1 << 2),
7862ad18 379 ETT_EVENT_ENABLE = (1 << 3),
85f2b082
TZ
380};
381
f306cc82
TZ
382extern void destroy_preds(struct ftrace_event_file *file);
383extern void destroy_call_preds(struct ftrace_event_call *call);
6fb2915d 384extern int filter_match_preds(struct event_filter *filter, void *rec);
f306cc82
TZ
385
386extern int filter_check_discard(struct ftrace_event_file *file, void *rec,
387 struct ring_buffer *buffer,
388 struct ring_buffer_event *event);
389extern int call_filter_check_discard(struct ftrace_event_call *call, void *rec,
390 struct ring_buffer *buffer,
391 struct ring_buffer_event *event);
bac5fb97
TZ
392extern enum event_trigger_type event_triggers_call(struct ftrace_event_file *file,
393 void *rec);
394extern void event_triggers_post_call(struct ftrace_event_file *file,
395 enum event_trigger_type tt);
97f20251 396
13a1e4ae
SRRH
397/**
398 * ftrace_trigger_soft_disabled - do triggers and test if soft disabled
399 * @file: The file pointer of the event to test
400 *
401 * If any triggers without filters are attached to this event, they
402 * will be called here. If the event is soft disabled and has no
403 * triggers that require testing the fields, it will return true,
404 * otherwise false.
405 */
406static inline bool
407ftrace_trigger_soft_disabled(struct ftrace_event_file *file)
408{
409 unsigned long eflags = file->flags;
410
411 if (!(eflags & FTRACE_EVENT_FL_TRIGGER_COND)) {
412 if (eflags & FTRACE_EVENT_FL_TRIGGER_MODE)
413 event_triggers_call(file, NULL);
414 if (eflags & FTRACE_EVENT_FL_SOFT_DISABLED)
415 return true;
416 }
417 return false;
418}
419
420/*
421 * Helper function for event_trigger_unlock_commit{_regs}().
422 * If there are event triggers attached to this event that requires
423 * filtering against its fields, then they wil be called as the
424 * entry already holds the field information of the current event.
425 *
426 * It also checks if the event should be discarded or not.
427 * It is to be discarded if the event is soft disabled and the
428 * event was only recorded to process triggers, or if the event
429 * filter is active and this event did not match the filters.
430 *
431 * Returns true if the event is discarded, false otherwise.
432 */
433static inline bool
434__event_trigger_test_discard(struct ftrace_event_file *file,
435 struct ring_buffer *buffer,
436 struct ring_buffer_event *event,
437 void *entry,
438 enum event_trigger_type *tt)
439{
440 unsigned long eflags = file->flags;
441
442 if (eflags & FTRACE_EVENT_FL_TRIGGER_COND)
443 *tt = event_triggers_call(file, entry);
444
445 if (test_bit(FTRACE_EVENT_FL_SOFT_DISABLED_BIT, &file->flags))
446 ring_buffer_discard_commit(buffer, event);
447 else if (!filter_check_discard(file, entry, buffer, event))
448 return false;
449
450 return true;
451}
452
453/**
454 * event_trigger_unlock_commit - handle triggers and finish event commit
455 * @file: The file pointer assoctiated to the event
456 * @buffer: The ring buffer that the event is being written to
457 * @event: The event meta data in the ring buffer
458 * @entry: The event itself
459 * @irq_flags: The state of the interrupts at the start of the event
460 * @pc: The state of the preempt count at the start of the event.
461 *
462 * This is a helper function to handle triggers that require data
463 * from the event itself. It also tests the event against filters and
464 * if the event is soft disabled and should be discarded.
465 */
466static inline void
467event_trigger_unlock_commit(struct ftrace_event_file *file,
468 struct ring_buffer *buffer,
469 struct ring_buffer_event *event,
470 void *entry, unsigned long irq_flags, int pc)
471{
472 enum event_trigger_type tt = ETT_NONE;
473
474 if (!__event_trigger_test_discard(file, buffer, event, entry, &tt))
475 trace_buffer_unlock_commit(buffer, event, irq_flags, pc);
476
477 if (tt)
478 event_triggers_post_call(file, tt);
479}
480
481/**
482 * event_trigger_unlock_commit_regs - handle triggers and finish event commit
483 * @file: The file pointer assoctiated to the event
484 * @buffer: The ring buffer that the event is being written to
485 * @event: The event meta data in the ring buffer
486 * @entry: The event itself
487 * @irq_flags: The state of the interrupts at the start of the event
488 * @pc: The state of the preempt count at the start of the event.
489 *
490 * This is a helper function to handle triggers that require data
491 * from the event itself. It also tests the event against filters and
492 * if the event is soft disabled and should be discarded.
493 *
494 * Same as event_trigger_unlock_commit() but calls
495 * trace_buffer_unlock_commit_regs() instead of trace_buffer_unlock_commit().
496 */
497static inline void
498event_trigger_unlock_commit_regs(struct ftrace_event_file *file,
499 struct ring_buffer *buffer,
500 struct ring_buffer_event *event,
501 void *entry, unsigned long irq_flags, int pc,
502 struct pt_regs *regs)
503{
504 enum event_trigger_type tt = ETT_NONE;
505
506 if (!__event_trigger_test_discard(file, buffer, event, entry, &tt))
507 trace_buffer_unlock_commit_regs(buffer, event,
508 irq_flags, pc, regs);
509
510 if (tt)
511 event_triggers_post_call(file, tt);
512}
513
43b51ead
LZ
514enum {
515 FILTER_OTHER = 0,
516 FILTER_STATIC_STRING,
517 FILTER_DYN_STRING,
87a342f5 518 FILTER_PTR_STRING,
02aa3162 519 FILTER_TRACE_FN,
43b51ead
LZ
520};
521
87d9b4e1 522extern int trace_event_raw_init(struct ftrace_event_call *call);
aeaeae11
FW
523extern int trace_define_field(struct ftrace_event_call *call, const char *type,
524 const char *name, int offset, int size,
525 int is_signed, int filter_type);
bd1a5c84 526extern int trace_add_event_call(struct ftrace_event_call *call);
2816c551 527extern int trace_remove_event_call(struct ftrace_event_call *call);
97f20251 528
d2802d07 529#define is_signed_type(type) (((type)(-1)) < (type)1)
97f20251 530
4671c794
SR
531int trace_set_clr_event(const char *system, const char *event, int set);
532
97f20251
SR
533/*
534 * The double __builtin_constant_p is because gcc will give us an error
535 * if we try to allocate the static variable to fmt if it is not a
536 * constant. Even with the outer if statement optimizing out.
537 */
538#define event_trace_printk(ip, fmt, args...) \
539do { \
540 __trace_printk_check_format(fmt, ##args); \
541 tracing_record_cmdline(current); \
542 if (__builtin_constant_p(fmt)) { \
543 static const char *trace_printk_fmt \
544 __attribute__((section("__trace_printk_fmt"))) = \
545 __builtin_constant_p(fmt) ? fmt : NULL; \
546 \
547 __trace_bprintk(ip, trace_printk_fmt, ##args); \
548 } else \
549 __trace_printk(ip, fmt, ##args); \
550} while (0)
551
102c9323
SRRH
552/**
553 * tracepoint_string - register constant persistent string to trace system
554 * @str - a constant persistent string that will be referenced in tracepoints
555 *
556 * If constant strings are being used in tracepoints, it is faster and
557 * more efficient to just save the pointer to the string and reference
558 * that with a printf "%s" instead of saving the string in the ring buffer
559 * and wasting space and time.
560 *
561 * The problem with the above approach is that userspace tools that read
562 * the binary output of the trace buffers do not have access to the string.
563 * Instead they just show the address of the string which is not very
564 * useful to users.
565 *
566 * With tracepoint_string(), the string will be registered to the tracing
567 * system and exported to userspace via the debugfs/tracing/printk_formats
568 * file that maps the string address to the string text. This way userspace
569 * tools that read the binary buffers have a way to map the pointers to
570 * the ASCII strings they represent.
571 *
572 * The @str used must be a constant string and persistent as it would not
573 * make sense to show a string that no longer exists. But it is still fine
574 * to be used with modules, because when modules are unloaded, if they
575 * had tracepoints, the ring buffers are cleared too. As long as the string
576 * does not change during the life of the module, it is fine to use
577 * tracepoint_string() within a module.
578 */
579#define tracepoint_string(str) \
580 ({ \
581 static const char *___tp_str __tracepoint_string = str; \
582 ___tp_str; \
583 })
584#define __tracepoint_string __attribute__((section("__tracepoint_str")))
585
07b139c8 586#ifdef CONFIG_PERF_EVENTS
6fb2915d 587struct perf_event;
c530665c
FW
588
589DECLARE_PER_CPU(struct pt_regs, perf_trace_regs);
590
1c024eca
PZ
591extern int perf_trace_init(struct perf_event *event);
592extern void perf_trace_destroy(struct perf_event *event);
a4eaf7f1
PZ
593extern int perf_trace_add(struct perf_event *event, int flags);
594extern void perf_trace_del(struct perf_event *event, int flags);
1c024eca 595extern int ftrace_profile_set_filter(struct perf_event *event, int event_id,
6fb2915d
LZ
596 char *filter_str);
597extern void ftrace_profile_free_filter(struct perf_event *event);
b7e2ecef
PZ
598extern void *perf_trace_buf_prepare(int size, unsigned short type,
599 struct pt_regs *regs, int *rctxp);
430ad5a6
XG
600
601static inline void
97d5a220 602perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr,
e6dab5ff
AV
603 u64 count, struct pt_regs *regs, void *head,
604 struct task_struct *task)
430ad5a6 605{
e6dab5ff 606 perf_tp_event(addr, count, raw_data, size, regs, head, rctx, task);
430ad5a6 607}
6fb2915d
LZ
608#endif
609
97f20251 610#endif /* _LINUX_FTRACE_EVENT_H */