2 * Stage 1 of the trace events.
4 * Override the macros in <trace/trace_events.h> to include the following:
6 * struct trace_event_raw_<call> {
7 * struct trace_entry ent;
9 * <type2> <item2>[<len>];
13 * The <type> <item> is created by the __field(type, item) macro or
14 * the __array(type2, item2, len) macro.
15 * We simply do "type item;", and that will create the fields
19 #include <linux/trace_events.h>
21 #ifndef TRACE_SYSTEM_VAR
22 #define TRACE_SYSTEM_VAR TRACE_SYSTEM
25 #define __app__(x, y) str__##x##y
26 #define __app(x, y) __app__(x, y)
28 #define TRACE_SYSTEM_STRING __app(TRACE_SYSTEM_VAR,__trace_system_name)
30 #define TRACE_MAKE_SYSTEM_STR() \
31 static const char TRACE_SYSTEM_STRING[] = \
32 __stringify(TRACE_SYSTEM)
34 TRACE_MAKE_SYSTEM_STR();
36 #undef TRACE_DEFINE_ENUM
37 #define TRACE_DEFINE_ENUM(a) \
38 static struct trace_enum_map __used __initdata \
39 __##TRACE_SYSTEM##_##a = \
41 .system = TRACE_SYSTEM_STRING, \
45 static struct trace_enum_map __used \
46 __attribute__((section("_ftrace_enum_map"))) \
47 *TRACE_SYSTEM##_##a = &__##TRACE_SYSTEM##_##a
50 * DECLARE_EVENT_CLASS can be used to add a generic function
51 * handlers for events. That is, if all events have the same
52 * parameters and just have distinct trace points.
53 * Each tracepoint can be defined with DEFINE_EVENT and that
54 * will map the DECLARE_EVENT_CLASS to the tracepoint.
56 * TRACE_EVENT is a one to one mapping between tracepoint and template.
59 #define TRACE_EVENT(name, proto, args, tstruct, assign, print) \
60 DECLARE_EVENT_CLASS(name, \
66 DEFINE_EVENT(name, name, PARAMS(proto), PARAMS(args));
70 #define __field(type, item) type item;
73 #define __field_ext(type, item, filter_type) type item;
76 #define __field_struct(type, item) type item;
78 #undef __field_struct_ext
79 #define __field_struct_ext(type, item, filter_type) type item;
82 #define __array(type, item, len) type item[len];
84 #undef __dynamic_array
85 #define __dynamic_array(type, item, len) u32 __data_loc_##item;
88 #define __string(item, src) __dynamic_array(char, item, -1)
91 #define __bitmask(item, nr_bits) __dynamic_array(char, item, -1)
93 #undef TP_STRUCT__entry
94 #define TP_STRUCT__entry(args...) args
96 #undef DECLARE_EVENT_CLASS
97 #define DECLARE_EVENT_CLASS(name, proto, args, tstruct, assign, print) \
98 struct trace_event_raw_##name { \
99 struct trace_entry ent; \
104 static struct trace_event_class event_class_##name;
107 #define DEFINE_EVENT(template, name, proto, args) \
108 static struct trace_event_call __used \
109 __attribute__((__aligned__(4))) event_##name
111 #undef DEFINE_EVENT_FN
112 #define DEFINE_EVENT_FN(template, name, proto, args, reg, unreg) \
113 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
115 #undef DEFINE_EVENT_PRINT
116 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
117 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
119 /* Callbacks are meaningless to ftrace. */
120 #undef TRACE_EVENT_FN
121 #define TRACE_EVENT_FN(name, proto, args, tstruct, \
122 assign, print, reg, unreg) \
123 TRACE_EVENT(name, PARAMS(proto), PARAMS(args), \
124 PARAMS(tstruct), PARAMS(assign), PARAMS(print)) \
126 #undef TRACE_EVENT_FLAGS
127 #define TRACE_EVENT_FLAGS(name, value) \
128 __TRACE_EVENT_FLAGS(name, value)
130 #undef TRACE_EVENT_PERF_PERM
131 #define TRACE_EVENT_PERF_PERM(name, expr...) \
132 __TRACE_EVENT_PERF_PERM(name, expr)
134 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
137 * Stage 2 of the trace events.
139 * Include the following:
141 * struct trace_event_data_offsets_<call> {
147 * The __dynamic_array() macro will create each u32 <item>, this is
148 * to keep the offset of each array from the beginning of the event.
149 * The size of an array is also encoded, in the higher 16 bits of <item>.
152 #undef TRACE_DEFINE_ENUM
153 #define TRACE_DEFINE_ENUM(a)
156 #define __field(type, item)
159 #define __field_ext(type, item, filter_type)
161 #undef __field_struct
162 #define __field_struct(type, item)
164 #undef __field_struct_ext
165 #define __field_struct_ext(type, item, filter_type)
168 #define __array(type, item, len)
170 #undef __dynamic_array
171 #define __dynamic_array(type, item, len) u32 item;
174 #define __string(item, src) __dynamic_array(char, item, -1)
177 #define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, -1)
179 #undef DECLARE_EVENT_CLASS
180 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
181 struct trace_event_data_offsets_##call { \
186 #define DEFINE_EVENT(template, name, proto, args)
188 #undef DEFINE_EVENT_PRINT
189 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
190 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
192 #undef TRACE_EVENT_FLAGS
193 #define TRACE_EVENT_FLAGS(event, flag)
195 #undef TRACE_EVENT_PERF_PERM
196 #define TRACE_EVENT_PERF_PERM(event, expr...)
198 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
201 * Stage 3 of the trace events.
203 * Override the macros in <trace/trace_events.h> to include the following:
206 * trace_raw_output_<call>(struct trace_iterator *iter, int flags)
208 * struct trace_seq *s = &iter->seq;
209 * struct trace_event_raw_<call> *field; <-- defined in stage 1
210 * struct trace_entry *entry;
211 * struct trace_seq *p = &iter->tmp_seq;
216 * if (entry->type != event_<call>->event.type) {
218 * return TRACE_TYPE_UNHANDLED;
221 * field = (typeof(field))entry;
224 * ret = trace_seq_printf(s, "%s: ", <call>);
226 * ret = trace_seq_printf(s, <TP_printk> "\n");
228 * return TRACE_TYPE_PARTIAL_LINE;
230 * return TRACE_TYPE_HANDLED;
233 * This is the method used to print the raw event to the trace
234 * output format. Note, this is not needed if the data is read
239 #define __entry field
242 #define TP_printk(fmt, args...) fmt "\n", args
244 #undef __get_dynamic_array
245 #define __get_dynamic_array(field) \
246 ((void *)__entry + (__entry->__data_loc_##field & 0xffff))
248 #undef __get_dynamic_array_len
249 #define __get_dynamic_array_len(field) \
250 ((__entry->__data_loc_##field >> 16) & 0xffff)
253 #define __get_str(field) (char *)__get_dynamic_array(field)
256 #define __get_bitmask(field) \
258 void *__bitmask = __get_dynamic_array(field); \
259 unsigned int __bitmask_size; \
260 __bitmask_size = __get_dynamic_array_len(field); \
261 trace_print_bitmask_seq(p, __bitmask, __bitmask_size); \
265 #define __print_flags(flag, delim, flag_array...) \
267 static const struct trace_print_flags __flags[] = \
268 { flag_array, { -1, NULL }}; \
269 trace_print_flags_seq(p, delim, flag, __flags); \
272 #undef __print_symbolic
273 #define __print_symbolic(value, symbol_array...) \
275 static const struct trace_print_flags symbols[] = \
276 { symbol_array, { -1, NULL }}; \
277 trace_print_symbols_seq(p, value, symbols); \
280 #undef __print_symbolic_u64
281 #if BITS_PER_LONG == 32
282 #define __print_symbolic_u64(value, symbol_array...) \
284 static const struct trace_print_flags_u64 symbols[] = \
285 { symbol_array, { -1, NULL } }; \
286 trace_print_symbols_seq_u64(p, value, symbols); \
289 #define __print_symbolic_u64(value, symbol_array...) \
290 __print_symbolic(value, symbol_array)
294 #define __print_hex(buf, buf_len) trace_print_hex_seq(p, buf, buf_len)
297 #define __print_array(array, count, el_size) \
299 BUILD_BUG_ON(el_size != 1 && el_size != 2 && \
300 el_size != 4 && el_size != 8); \
301 trace_print_array_seq(p, array, count, el_size); \
304 #undef DECLARE_EVENT_CLASS
305 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
306 static notrace enum print_line_t \
307 trace_raw_output_##call(struct trace_iterator *iter, int flags, \
308 struct trace_event *trace_event) \
310 struct trace_seq *s = &iter->seq; \
311 struct trace_seq __maybe_unused *p = &iter->tmp_seq; \
312 struct trace_event_raw_##call *field; \
315 field = (typeof(field))iter->ent; \
317 ret = trace_raw_output_prep(iter, trace_event); \
318 if (ret != TRACE_TYPE_HANDLED) \
321 trace_seq_printf(s, print); \
323 return trace_handle_return(s); \
325 static struct trace_event_functions trace_event_type_funcs_##call = { \
326 .trace = trace_raw_output_##call, \
329 #undef DEFINE_EVENT_PRINT
330 #define DEFINE_EVENT_PRINT(template, call, proto, args, print) \
331 static notrace enum print_line_t \
332 trace_raw_output_##call(struct trace_iterator *iter, int flags, \
333 struct trace_event *event) \
335 struct trace_event_raw_##template *field; \
336 struct trace_entry *entry; \
337 struct trace_seq *p = &iter->tmp_seq; \
341 if (entry->type != event_##call.event.type) { \
343 return TRACE_TYPE_UNHANDLED; \
346 field = (typeof(field))entry; \
349 return trace_output_call(iter, #call, print); \
351 static struct trace_event_functions trace_event_type_funcs_##call = { \
352 .trace = trace_raw_output_##call, \
355 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
358 #define __field_ext(type, item, filter_type) \
359 ret = trace_define_field(event_call, #type, #item, \
360 offsetof(typeof(field), item), \
361 sizeof(field.item), \
362 is_signed_type(type), filter_type); \
366 #undef __field_struct_ext
367 #define __field_struct_ext(type, item, filter_type) \
368 ret = trace_define_field(event_call, #type, #item, \
369 offsetof(typeof(field), item), \
370 sizeof(field.item), \
376 #define __field(type, item) __field_ext(type, item, FILTER_OTHER)
378 #undef __field_struct
379 #define __field_struct(type, item) __field_struct_ext(type, item, FILTER_OTHER)
382 #define __array(type, item, len) \
384 char *type_str = #type"["__stringify(len)"]"; \
385 BUILD_BUG_ON(len > MAX_FILTER_STR_VAL); \
386 ret = trace_define_field(event_call, type_str, #item, \
387 offsetof(typeof(field), item), \
388 sizeof(field.item), \
389 is_signed_type(type), FILTER_OTHER); \
394 #undef __dynamic_array
395 #define __dynamic_array(type, item, len) \
396 ret = trace_define_field(event_call, "__data_loc " #type "[]", #item, \
397 offsetof(typeof(field), __data_loc_##item), \
398 sizeof(field.__data_loc_##item), \
399 is_signed_type(type), FILTER_OTHER);
402 #define __string(item, src) __dynamic_array(char, item, -1)
405 #define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, -1)
407 #undef DECLARE_EVENT_CLASS
408 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print) \
409 static int notrace __init \
410 trace_event_define_fields_##call(struct trace_event_call *event_call) \
412 struct trace_event_raw_##call field; \
421 #define DEFINE_EVENT(template, name, proto, args)
423 #undef DEFINE_EVENT_PRINT
424 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
425 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
427 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
430 * remember the offset of each array from the beginning of the event.
434 #define __entry entry
437 #define __field(type, item)
440 #define __field_ext(type, item, filter_type)
442 #undef __field_struct
443 #define __field_struct(type, item)
445 #undef __field_struct_ext
446 #define __field_struct_ext(type, item, filter_type)
449 #define __array(type, item, len)
451 #undef __dynamic_array
452 #define __dynamic_array(type, item, len) \
453 __item_length = (len) * sizeof(type); \
454 __data_offsets->item = __data_size + \
455 offsetof(typeof(*entry), __data); \
456 __data_offsets->item |= __item_length << 16; \
457 __data_size += __item_length;
460 #define __string(item, src) __dynamic_array(char, item, \
461 strlen((src) ? (const char *)(src) : "(null)") + 1)
464 * __bitmask_size_in_bytes_raw is the number of bytes needed to hold
465 * num_possible_cpus().
467 #define __bitmask_size_in_bytes_raw(nr_bits) \
468 (((nr_bits) + 7) / 8)
470 #define __bitmask_size_in_longs(nr_bits) \
471 ((__bitmask_size_in_bytes_raw(nr_bits) + \
472 ((BITS_PER_LONG / 8) - 1)) / (BITS_PER_LONG / 8))
475 * __bitmask_size_in_bytes is the number of bytes needed to hold
476 * num_possible_cpus() padded out to the nearest long. This is what
477 * is saved in the buffer, just to be consistent.
479 #define __bitmask_size_in_bytes(nr_bits) \
480 (__bitmask_size_in_longs(nr_bits) * (BITS_PER_LONG / 8))
483 #define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, \
484 __bitmask_size_in_longs(nr_bits))
486 #undef DECLARE_EVENT_CLASS
487 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print) \
488 static inline notrace int trace_event_get_offsets_##call( \
489 struct trace_event_data_offsets_##call *__data_offsets, proto) \
491 int __data_size = 0; \
492 int __maybe_unused __item_length; \
493 struct trace_event_raw_##call __maybe_unused *entry; \
497 return __data_size; \
501 #define DEFINE_EVENT(template, name, proto, args)
503 #undef DEFINE_EVENT_PRINT
504 #define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
505 DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
507 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)