tracing: Remove the extra 4 bytes of padding in events
[deliverable/linux.git] / include / linux / ftrace_event.h
CommitLineData
97f20251
SR
1#ifndef _LINUX_FTRACE_EVENT_H
2#define _LINUX_FTRACE_EVENT_H
3
97f20251 4#include <linux/ring_buffer.h>
16bb8eb1 5#include <linux/trace_seq.h>
be74b73a 6#include <linux/percpu.h>
20ab4425 7#include <linux/hardirq.h>
430ad5a6 8#include <linux/perf_event.h>
97f20251
SR
9
10struct trace_array;
11struct tracer;
6d723736 12struct dentry;
97f20251 13
be74b73a
SR
14struct trace_print_flags {
15 unsigned long mask;
16 const char *name;
17};
18
2fc1b6f0 19struct trace_print_flags_u64 {
20 unsigned long long mask;
21 const char *name;
22};
23
be74b73a
SR
24const char *ftrace_print_flags_seq(struct trace_seq *p, const char *delim,
25 unsigned long flags,
26 const struct trace_print_flags *flag_array);
27
0f4fc29d
SR
28const char *ftrace_print_symbols_seq(struct trace_seq *p, unsigned long val,
29 const struct trace_print_flags *symbol_array);
30
2fc1b6f0 31#if BITS_PER_LONG == 32
32const char *ftrace_print_symbols_seq_u64(struct trace_seq *p,
33 unsigned long long val,
34 const struct trace_print_flags_u64
35 *symbol_array);
36#endif
37
5a2e3995
KT
38const char *ftrace_print_hex_seq(struct trace_seq *p,
39 const unsigned char *buf, int len);
40
97f20251
SR
41/*
42 * The trace entry - the most basic unit of tracing. This is what
43 * is printed in the end as a single line in the trace output, such as:
44 *
45 * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
46 */
47struct trace_entry {
89ec0dee 48 unsigned short type;
97f20251
SR
49 unsigned char flags;
50 unsigned char preempt_count;
51 int pid;
97f20251
SR
52};
53
89ec0dee
SR
54#define FTRACE_MAX_EVENT \
55 ((1 << (sizeof(((struct trace_entry *)0)->type) * 8)) - 1)
56
97f20251
SR
57/*
58 * Trace iterator - used by printout routines who present trace
59 * results to users and which routines might sleep, etc:
60 */
61struct trace_iterator {
62 struct trace_array *tr;
63 struct tracer *trace;
64 void *private;
65 int cpu_file;
66 struct mutex mutex;
6d158a81 67 struct ring_buffer_iter **buffer_iter;
112f38a7 68 unsigned long iter_flags;
97f20251 69
bc289ae9
LJ
70 /* trace_seq for __print_flags() and __print_symbolic() etc. */
71 struct trace_seq tmp_seq;
72
97f20251
SR
73 /* The below is zeroed out in pipe_read */
74 struct trace_seq seq;
75 struct trace_entry *ent;
bc21b478 76 unsigned long lost_events;
a63ce5b3 77 int leftover;
4a9bd3f1 78 int ent_size;
97f20251
SR
79 int cpu;
80 u64 ts;
81
97f20251
SR
82 loff_t pos;
83 long idx;
84
85 cpumask_var_t started;
86};
87
8be0709f
DS
88enum trace_iter_flags {
89 TRACE_FILE_LAT_FMT = 1,
90 TRACE_FILE_ANNOTATE = 2,
91 TRACE_FILE_TIME_IN_NS = 4,
92};
93
97f20251 94
a9a57763
SR
95struct trace_event;
96
97f20251 97typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter,
a9a57763
SR
98 int flags, struct trace_event *event);
99
100struct trace_event_functions {
97f20251
SR
101 trace_print_func trace;
102 trace_print_func raw;
103 trace_print_func hex;
104 trace_print_func binary;
105};
106
a9a57763
SR
107struct trace_event {
108 struct hlist_node node;
109 struct list_head list;
110 int type;
111 struct trace_event_functions *funcs;
112};
113
97f20251
SR
114extern int register_ftrace_event(struct trace_event *event);
115extern int unregister_ftrace_event(struct trace_event *event);
116
117/* Return values for print_line callback */
118enum print_line_t {
119 TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
120 TRACE_TYPE_HANDLED = 1,
121 TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */
122 TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */
123};
124
f413cdb8
FW
125void tracing_generic_entry_update(struct trace_entry *entry,
126 unsigned long flags,
127 int pc);
97f20251 128struct ring_buffer_event *
e77405ad
SR
129trace_current_buffer_lock_reserve(struct ring_buffer **current_buffer,
130 int type, unsigned long len,
97f20251 131 unsigned long flags, int pc);
e77405ad
SR
132void trace_current_buffer_unlock_commit(struct ring_buffer *buffer,
133 struct ring_buffer_event *event,
97f20251 134 unsigned long flags, int pc);
0d5c6e1c
SR
135void trace_buffer_unlock_commit(struct ring_buffer *buffer,
136 struct ring_buffer_event *event,
137 unsigned long flags, int pc);
138void trace_buffer_unlock_commit_regs(struct ring_buffer *buffer,
139 struct ring_buffer_event *event,
140 unsigned long flags, int pc,
141 struct pt_regs *regs);
e77405ad
SR
142void trace_current_buffer_discard_commit(struct ring_buffer *buffer,
143 struct ring_buffer_event *event);
97f20251
SR
144
145void tracing_record_cmdline(struct task_struct *tsk);
146
1f9963cb
LZ
147struct event_filter;
148
2239291a
SR
149enum trace_reg {
150 TRACE_REG_REGISTER,
151 TRACE_REG_UNREGISTER,
37d73998 152#ifdef CONFIG_PERF_EVENTS
2239291a
SR
153 TRACE_REG_PERF_REGISTER,
154 TRACE_REG_PERF_UNREGISTER,
ceec0b6f
JO
155 TRACE_REG_PERF_OPEN,
156 TRACE_REG_PERF_CLOSE,
489c75c3
JO
157 TRACE_REG_PERF_ADD,
158 TRACE_REG_PERF_DEL,
37d73998 159#endif
2239291a
SR
160};
161
162struct ftrace_event_call;
163
8f082018
SR
164struct ftrace_event_class {
165 char *system;
2239291a
SR
166 void *probe;
167#ifdef CONFIG_PERF_EVENTS
168 void *perf_probe;
169#endif
170 int (*reg)(struct ftrace_event_call *event,
ceec0b6f 171 enum trace_reg type, void *data);
2e33af02
SR
172 int (*define_fields)(struct ftrace_event_call *);
173 struct list_head *(*get_fields)(struct ftrace_event_call *);
174 struct list_head fields;
0405ab80 175 int (*raw_init)(struct ftrace_event_call *);
8f082018
SR
176};
177
a1d0ce82 178extern int ftrace_event_reg(struct ftrace_event_call *event,
ceec0b6f 179 enum trace_reg type, void *data);
a1d0ce82 180
553552ce
SR
181enum {
182 TRACE_EVENT_FL_ENABLED_BIT,
183 TRACE_EVENT_FL_FILTERED_BIT,
e870e9a1 184 TRACE_EVENT_FL_RECORDED_CMD_BIT,
61c32659 185 TRACE_EVENT_FL_CAP_ANY_BIT,
27b14b56 186 TRACE_EVENT_FL_NO_SET_FILTER_BIT,
9b63776f 187 TRACE_EVENT_FL_IGNORE_ENABLE_BIT,
553552ce
SR
188};
189
190enum {
e870e9a1
LZ
191 TRACE_EVENT_FL_ENABLED = (1 << TRACE_EVENT_FL_ENABLED_BIT),
192 TRACE_EVENT_FL_FILTERED = (1 << TRACE_EVENT_FL_FILTERED_BIT),
193 TRACE_EVENT_FL_RECORDED_CMD = (1 << TRACE_EVENT_FL_RECORDED_CMD_BIT),
61c32659 194 TRACE_EVENT_FL_CAP_ANY = (1 << TRACE_EVENT_FL_CAP_ANY_BIT),
27b14b56 195 TRACE_EVENT_FL_NO_SET_FILTER = (1 << TRACE_EVENT_FL_NO_SET_FILTER_BIT),
9b63776f 196 TRACE_EVENT_FL_IGNORE_ENABLE = (1 << TRACE_EVENT_FL_IGNORE_ENABLE_BIT),
553552ce
SR
197};
198
97f20251 199struct ftrace_event_call {
a59fd602 200 struct list_head list;
8f082018 201 struct ftrace_event_class *class;
97f20251 202 char *name;
97f20251 203 struct dentry *dir;
80decc70 204 struct trace_event event;
509e760c 205 const char *print_fmt;
1f9963cb 206 struct event_filter *filter;
6d723736 207 void *mod;
69fd4f0e 208 void *data;
97f20251 209
553552ce
SR
210 /*
211 * 32 bit flags:
212 * bit 1: enabled
213 * bit 2: filter_active
e870e9a1 214 * bit 3: enabled cmd record
5da43bed
SR
215 * bit 4: allow trace by non root (cap any)
216 * bit 5: failed to apply filter
217 * bit 6: ftrace internal event (do not enable)
553552ce 218 *
1eaa4787
SR
219 * Changes to flags must hold the event_mutex.
220 *
221 * Note: Reads of flags do not hold the event_mutex since
222 * they occur in critical sections. But the way flags
223 * is currently used, these changes do no affect the code
224 * except that when a change is made, it may have a slight
225 * delay in propagating the changes to other CPUs due to
226 * caching and such.
553552ce
SR
227 */
228 unsigned int flags;
229
ff5f149b 230#ifdef CONFIG_PERF_EVENTS
6016ee13
NK
231 int perf_refcount;
232 struct hlist_head __percpu *perf_events;
ff5f149b 233#endif
97f20251
SR
234};
235
53cf810b
FW
236#define __TRACE_EVENT_FLAGS(name, value) \
237 static int __init trace_init_flags_##name(void) \
238 { \
239 event_##name.flags = value; \
240 return 0; \
241 } \
242 early_initcall(trace_init_flags_##name);
243
97d5a220 244#define PERF_MAX_TRACE_SIZE 2048
20ab4425 245
16bb8eb1 246#define MAX_FILTER_STR_VAL 256 /* Should handle KSYM_SYMBOL_LEN */
97f20251 247
2df75e41 248extern void destroy_preds(struct ftrace_event_call *call);
6fb2915d 249extern int filter_match_preds(struct event_filter *filter, void *rec);
e77405ad
SR
250extern int filter_current_check_discard(struct ring_buffer *buffer,
251 struct ftrace_event_call *call,
97f20251
SR
252 void *rec,
253 struct ring_buffer_event *event);
254
43b51ead
LZ
255enum {
256 FILTER_OTHER = 0,
257 FILTER_STATIC_STRING,
258 FILTER_DYN_STRING,
87a342f5 259 FILTER_PTR_STRING,
02aa3162 260 FILTER_TRACE_FN,
43b51ead
LZ
261};
262
04295780
SR
263#define EVENT_STORAGE_SIZE 128
264extern struct mutex event_storage_mutex;
265extern char event_storage[EVENT_STORAGE_SIZE];
266
87d9b4e1 267extern int trace_event_raw_init(struct ftrace_event_call *call);
aeaeae11
FW
268extern int trace_define_field(struct ftrace_event_call *call, const char *type,
269 const char *name, int offset, int size,
270 int is_signed, int filter_type);
bd1a5c84
MH
271extern int trace_add_event_call(struct ftrace_event_call *call);
272extern void trace_remove_event_call(struct ftrace_event_call *call);
97f20251 273
418c59e4 274#define is_signed_type(type) (((type)(-1)) < (type)0)
97f20251 275
4671c794
SR
276int trace_set_clr_event(const char *system, const char *event, int set);
277
97f20251
SR
278/*
279 * The double __builtin_constant_p is because gcc will give us an error
280 * if we try to allocate the static variable to fmt if it is not a
281 * constant. Even with the outer if statement optimizing out.
282 */
283#define event_trace_printk(ip, fmt, args...) \
284do { \
285 __trace_printk_check_format(fmt, ##args); \
286 tracing_record_cmdline(current); \
287 if (__builtin_constant_p(fmt)) { \
288 static const char *trace_printk_fmt \
289 __attribute__((section("__trace_printk_fmt"))) = \
290 __builtin_constant_p(fmt) ? fmt : NULL; \
291 \
292 __trace_bprintk(ip, trace_printk_fmt, ##args); \
293 } else \
294 __trace_printk(ip, fmt, ##args); \
295} while (0)
296
07b139c8 297#ifdef CONFIG_PERF_EVENTS
6fb2915d 298struct perf_event;
c530665c
FW
299
300DECLARE_PER_CPU(struct pt_regs, perf_trace_regs);
301
1c024eca
PZ
302extern int perf_trace_init(struct perf_event *event);
303extern void perf_trace_destroy(struct perf_event *event);
a4eaf7f1
PZ
304extern int perf_trace_add(struct perf_event *event, int flags);
305extern void perf_trace_del(struct perf_event *event, int flags);
1c024eca 306extern int ftrace_profile_set_filter(struct perf_event *event, int event_id,
6fb2915d
LZ
307 char *filter_str);
308extern void ftrace_profile_free_filter(struct perf_event *event);
b7e2ecef
PZ
309extern void *perf_trace_buf_prepare(int size, unsigned short type,
310 struct pt_regs *regs, int *rctxp);
430ad5a6
XG
311
312static inline void
97d5a220 313perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr,
e6dab5ff
AV
314 u64 count, struct pt_regs *regs, void *head,
315 struct task_struct *task)
430ad5a6 316{
e6dab5ff 317 perf_tp_event(addr, count, raw_data, size, regs, head, rctx, task);
430ad5a6 318}
6fb2915d
LZ
319#endif
320
97f20251 321#endif /* _LINUX_FTRACE_EVENT_H */
This page took 0.237543 seconds and 5 git commands to generate.