ftrace.h 16.3 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
/*
 * Stage 1 of the trace events.
 *
 * Override the macros in <trace/trace_events.h> to include the following:
 *
 * struct ftrace_raw_<call> {
 *	struct trace_entry		ent;
 *	<type>				<item>;
 *	<type2>				<item2>[<len>];
 *	[...]
 * };
 *
 * The <type> <item> is created by the __field(type, item) macro or
 * the __array(type2, item2, len) macro.
 * We simply do "type item;", and that will create the fields
 * in the structure.
 */

#include <linux/ftrace_event.h>

21
22
23
#undef __field
#define __field(type, item)		type	item;

24
25
26
#undef __array
#define __array(type, item, len)	type	item[len];

27
28
#undef __dynamic_array
#define __dynamic_array(type, item, len) unsigned short __data_loc_##item;
29

30
#undef __string
31
#define __string(item, src) __dynamic_array(char, item, -1)
32

33
34
35
36
37
38
39
40
#undef TP_STRUCT__entry
#define TP_STRUCT__entry(args...) args

#undef TRACE_EVENT
#define TRACE_EVENT(name, proto, args, tstruct, assign, print)	\
	struct ftrace_raw_##name {				\
		struct trace_entry	ent;			\
		tstruct						\
41
		char			__data[0];		\
42
43
44
45
46
	};							\
	static struct ftrace_event_call event_##name

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

47

48
49
50
/*
 * Stage 2 of the trace events.
 *
51
52
 * Include the following:
 *
53
54
55
 * struct ftrace_data_offsets_<call> {
 *	int				<item1>;
 *	int				<item2>;
56
57
58
 *	[...]
 * };
 *
59
60
 * The __dynamic_array() macro will create each int <item>, this is
 * to keep the offset of each array from the beginning of the event.
61
62
 */

63
64
65
#undef __field
#define __field(type, item);

66
67
68
#undef __array
#define __array(type, item, len)

69
70
#undef __dynamic_array
#define __dynamic_array(type, item, len)	int item;
71
72

#undef __string
73
#define __string(item, src) __dynamic_array(char, item, -1)
74
75
76

#undef TRACE_EVENT
#define TRACE_EVENT(call, proto, args, tstruct, assign, print)		\
77
	struct ftrace_data_offsets_##call {				\
78
79
80
81
82
		tstruct;						\
	};

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/*
 * Setup the showing format of trace point.
 *
 * int
 * ftrace_format_##call(struct trace_seq *s)
 * {
 *	struct ftrace_raw_##call field;
 *	int ret;
 *
 *	ret = trace_seq_printf(s, #type " " #item ";"
 *			       " offset:%u; size:%u;\n",
 *			       offsetof(struct ftrace_raw_##call, item),
 *			       sizeof(field.type));
 *
 * }
 */

#undef TP_STRUCT__entry
#define TP_STRUCT__entry(args...) args

#undef __field
#define __field(type, item)					\
	ret = trace_seq_printf(s, "\tfield:" #type " " #item ";\t"	\
			       "offset:%u;\tsize:%u;\n",		\
			       (unsigned int)offsetof(typeof(field), item), \
			       (unsigned int)sizeof(field.item));	\
	if (!ret)							\
		return 0;

#undef __array
#define __array(type, item, len)						\
	ret = trace_seq_printf(s, "\tfield:" #type " " #item "[" #len "];\t"	\
			       "offset:%u;\tsize:%u;\n",		\
			       (unsigned int)offsetof(typeof(field), item), \
			       (unsigned int)sizeof(field.item));	\
	if (!ret)							\
		return 0;

#undef __dynamic_array
#define __dynamic_array(type, item, len)				       \
	ret = trace_seq_printf(s, "\tfield:__data_loc " #item ";\t"	       \
			       "offset:%u;\tsize:%u;\n",		       \
			       (unsigned int)offsetof(typeof(field),	       \
					__data_loc_##item),		       \
			       (unsigned int)sizeof(field.__data_loc_##item)); \
	if (!ret)							       \
		return 0;

#undef __string
#define __string(item, src) __dynamic_array(char, item, -1)

#undef __entry
#define __entry REC

#undef __print_symbolic
#undef __get_dynamic_array
#undef __get_str

#undef TP_printk
#define TP_printk(fmt, args...) "%s, %s\n", #fmt, __stringify(args)

#undef TP_fast_assign
#define TP_fast_assign(args...) args

147
148
149
#undef TP_perf_assign
#define TP_perf_assign(args...)

150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
#undef TRACE_EVENT
#define TRACE_EVENT(call, proto, args, tstruct, func, print)		\
static int								\
ftrace_format_##call(struct trace_seq *s)				\
{									\
	struct ftrace_raw_##call field __attribute__((unused));		\
	int ret = 0;							\
									\
	tstruct;							\
									\
	trace_seq_printf(s, "\nprint fmt: " print);			\
									\
	return ret;							\
}

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

167
168
169
/*
 * Stage 3 of the trace events.
 *
170
171
172
173
174
175
176
177
 * Override the macros in <trace/trace_events.h> to include the following:
 *
 * enum print_line_t
 * ftrace_raw_output_<call>(struct trace_iterator *iter, int flags)
 * {
 *	struct trace_seq *s = &iter->seq;
 *	struct ftrace_raw_<call> *field; <-- defined in stage 1
 *	struct trace_entry *entry;
178
 *	struct trace_seq *p;
179
180
181
182
183
184
185
186
187
188
189
 *	int ret;
 *
 *	entry = iter->ent;
 *
 *	if (entry->type != event_<call>.id) {
 *		WARN_ON_ONCE(1);
 *		return TRACE_TYPE_UNHANDLED;
 *	}
 *
 *	field = (typeof(field))entry;
 *
190
 *	p = get_cpu_var(ftrace_event_seq);
191
 *	trace_seq_init(p);
192
 *	ret = trace_seq_printf(s, <TP_printk> "\n");
193
 *	put_cpu();
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 *	if (!ret)
 *		return TRACE_TYPE_PARTIAL_LINE;
 *
 *	return TRACE_TYPE_HANDLED;
 * }
 *
 * This is the method used to print the raw event to the trace
 * output format. Note, this is not needed if the data is read
 * in binary.
 */

#undef __entry
#define __entry field

#undef TP_printk
#define TP_printk(fmt, args...) fmt "\n", args

211
212
213
214
#undef __get_dynamic_array
#define __get_dynamic_array(field)	\
		((void *)__entry + __entry->__data_loc_##field)

215
#undef __get_str
216
#define __get_str(field) (char *)__get_dynamic_array(field)
217

218
219
220
221
222
223
224
225
#undef __print_flags
#define __print_flags(flag, delim, flag_array...)			\
	({								\
		static const struct trace_print_flags flags[] =		\
			{ flag_array, { -1, NULL }};			\
		ftrace_print_flags_seq(p, delim, flag, flags);		\
	})

226
227
228
229
230
231
232
233
#undef __print_symbolic
#define __print_symbolic(value, symbol_array...)			\
	({								\
		static const struct trace_print_flags symbols[] =	\
			{ symbol_array, { -1, NULL }};			\
		ftrace_print_symbols_seq(p, value, symbols);		\
	})

234
235
236
237
238
239
240
241
#undef TRACE_EVENT
#define TRACE_EVENT(call, proto, args, tstruct, assign, print)		\
enum print_line_t							\
ftrace_raw_output_##call(struct trace_iterator *iter, int flags)	\
{									\
	struct trace_seq *s = &iter->seq;				\
	struct ftrace_raw_##call *field;				\
	struct trace_entry *entry;					\
242
	struct trace_seq *p;						\
243
244
245
246
247
248
249
250
251
252
253
	int ret;							\
									\
	entry = iter->ent;						\
									\
	if (entry->type != event_##call.id) {				\
		WARN_ON_ONCE(1);					\
		return TRACE_TYPE_UNHANDLED;				\
	}								\
									\
	field = (typeof(field))entry;					\
									\
254
	p = &get_cpu_var(ftrace_event_seq);				\
255
	trace_seq_init(p);						\
256
	ret = trace_seq_printf(s, #call ": " print);			\
257
	put_cpu();							\
258
259
260
261
262
263
264
265
266
267
268
269
	if (!ret)							\
		return TRACE_TYPE_PARTIAL_LINE;				\
									\
	return TRACE_TYPE_HANDLED;					\
}
	
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

#undef __field
#define __field(type, item)						\
	ret = trace_define_field(event_call, #type, #item,		\
				 offsetof(typeof(field), item),		\
270
				 sizeof(field.item), is_signed_type(type));	\
271
272
273
274
275
276
277
278
	if (ret)							\
		return ret;

#undef __array
#define __array(type, item, len)					\
	BUILD_BUG_ON(len > MAX_FILTER_STR_VAL);				\
	ret = trace_define_field(event_call, #type "[" #len "]", #item,	\
				 offsetof(typeof(field), item),		\
279
				 sizeof(field.item), 0);		\
280
281
282
	if (ret)							\
		return ret;

283
284
285
286
287
288
#undef __dynamic_array
#define __dynamic_array(type, item, len)				       \
	ret = trace_define_field(event_call, "__data_loc" "[" #type "]", #item,\
				offsetof(typeof(field), __data_loc_##item),    \
				 sizeof(field.__data_loc_##item), 0);

289
#undef __string
290
#define __string(item, src) __dynamic_array(char, item, -1)
291

292
293
294
295
296
297
298
299
300
#undef TRACE_EVENT
#define TRACE_EVENT(call, proto, args, tstruct, func, print)		\
int									\
ftrace_define_fields_##call(void)					\
{									\
	struct ftrace_raw_##call field;					\
	struct ftrace_event_call *event_call = &event_##call;		\
	int ret;							\
									\
301
302
303
304
305
	__common_field(int, type, 1);					\
	__common_field(unsigned char, flags, 0);			\
	__common_field(unsigned char, preempt_count, 0);		\
	__common_field(int, pid, 1);					\
	__common_field(int, tgid, 1);					\
306
307
308
309
310
311
312
313
									\
	tstruct;							\
									\
	return ret;							\
}

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
/*
 * remember the offset of each array from the beginning of the event.
 */

#undef __entry
#define __entry entry

#undef __field
#define __field(type, item)

#undef __array
#define __array(type, item, len)

#undef __dynamic_array
#define __dynamic_array(type, item, len)				\
	__data_offsets->item = __data_size +				\
			       offsetof(typeof(*entry), __data);	\
	__data_size += (len) * sizeof(type);

#undef __string
#define __string(item, src) __dynamic_array(char, item, strlen(src) + 1)       \

#undef TRACE_EVENT
#define TRACE_EVENT(call, proto, args, tstruct, assign, print)		\
static inline int ftrace_get_offsets_##call(				\
	struct ftrace_data_offsets_##call *__data_offsets, proto)       \
{									\
	int __data_size = 0;						\
	struct ftrace_raw_##call __maybe_unused *entry;			\
									\
	tstruct;							\
									\
	return __data_size;						\
}

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
#ifdef CONFIG_EVENT_PROFILE

/*
 * Generate the functions needed for tracepoint perf_counter support.
 *
 * static void ftrace_profile_<call>(proto)
 * {
 * 	extern void perf_tpcounter_event(int, u64, u64);
 * 	u64 __addr = 0, __count = 1;
 *
 * 	<assign>   <-- here we expand the TP_perf_assign() macro
 *
 * 	perf_tpcounter_event(event_<call>.id, __addr, __count);
 * }
 *
 * static int ftrace_profile_enable_<call>(struct ftrace_event_call *event_call)
 * {
 * 	int ret = 0;
 *
 * 	if (!atomic_inc_return(&event_call->profile_count))
 * 		ret = register_trace_<call>(ftrace_profile_<call>);
 *
 * 	return ret;
 * }
 *
 * static void ftrace_profile_disable_<call>(struct ftrace_event_call *event_call)
 * {
 * 	if (atomic_add_negative(-1, &event->call->profile_count))
 * 		unregister_trace_<call>(ftrace_profile_<call>);
 * }
 *
 */

#undef TP_fast_assign
#define TP_fast_assign(args...)

#undef TP_perf_assign
#define TP_perf_assign(args...) args

#undef __perf_addr
#define __perf_addr(a) __addr = (a)

#undef __perf_count
#define __perf_count(c) __count = (c)

#undef TRACE_EVENT
#define TRACE_EVENT(call, proto, args, tstruct, assign, print)		\
									\
static void ftrace_profile_##call(proto)				\
{									\
	extern void perf_tpcounter_event(int, u64, u64);		\
	u64 __addr = 0, __count = 1;					\
	{ assign; }							\
	perf_tpcounter_event(event_##call.id, __addr, __count);		\
}									\
									\
static int ftrace_profile_enable_##call(struct ftrace_event_call *event_call) \
{									\
	int ret = 0;							\
									\
	if (!atomic_inc_return(&event_call->profile_count))		\
		ret = register_trace_##call(ftrace_profile_##call);	\
									\
	return ret;							\
}									\
									\
static void ftrace_profile_disable_##call(struct ftrace_event_call *event_call)\
{									\
	if (atomic_add_negative(-1, &event_call->profile_count))	\
		unregister_trace_##call(ftrace_profile_##call);		\
}

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

#undef TP_fast_assign
#define TP_fast_assign(args...) args

#undef TP_perf_assign
#define TP_perf_assign(args...)

#endif

433
/*
434
 * Stage 4 of the trace events.
435
 *
436
 * Override the macros in <trace/trace_events.h> to include the following:
437
438
439
 *
 * static void ftrace_event_<call>(proto)
 * {
440
 *	event_trace_printk(_RET_IP_, "<call>: " <fmt>);
441
442
443
444
 * }
 *
 * static int ftrace_reg_event_<call>(void)
 * {
445
 *	int ret;
446
 *
447
448
449
450
451
 *	ret = register_trace_<call>(ftrace_event_<call>);
 *	if (!ret)
 *		pr_info("event trace: Could not activate trace point "
 *			"probe to  <call>");
 *	return ret;
452
453
454
455
 * }
 *
 * static void ftrace_unreg_event_<call>(void)
 * {
456
 *	unregister_trace_<call>(ftrace_event_<call>);
457
458
459
 * }
 *
 *
460
 * For those macros defined with TRACE_EVENT:
461
462
463
464
465
 *
 * static struct ftrace_event_call event_<call>;
 *
 * static void ftrace_raw_event_<call>(proto)
 * {
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
 *	struct ring_buffer_event *event;
 *	struct ftrace_raw_<call> *entry; <-- defined in stage 1
 *	unsigned long irq_flags;
 *	int pc;
 *
 *	local_save_flags(irq_flags);
 *	pc = preempt_count();
 *
 *	event = trace_current_buffer_lock_reserve(event_<call>.id,
 *				  sizeof(struct ftrace_raw_<call>),
 *				  irq_flags, pc);
 *	if (!event)
 *		return;
 *	entry	= ring_buffer_event_data(event);
 *
 *	<assign>;  <-- Here we assign the entries by the __field and
482
 *			__array macros.
483
 *
484
 *	trace_current_buffer_unlock_commit(event, irq_flags, pc);
485
486
487
488
 * }
 *
 * static int ftrace_raw_reg_event_<call>(void)
 * {
489
 *	int ret;
490
 *
491
492
493
494
495
 *	ret = register_trace_<call>(ftrace_raw_event_<call>);
 *	if (!ret)
 *		pr_info("event trace: Could not activate trace point "
 *			"probe to <call>");
 *	return ret;
496
497
498
499
 * }
 *
 * static void ftrace_unreg_event_<call>(void)
 * {
500
 *	unregister_trace_<call>(ftrace_raw_event_<call>);
501
502
503
 * }
 *
 * static struct trace_event ftrace_event_type_<call> = {
504
 *	.trace			= ftrace_raw_output_<call>, <-- stage 2
505
506
507
508
 * };
 *
 * static int ftrace_raw_init_event_<call>(void)
 * {
509
 *	int id;
510
 *
511
512
513
514
515
 *	id = register_ftrace_event(&ftrace_event_type_<call>);
 *	if (!id)
 *		return -ENODEV;
 *	event_<call>.id = id;
 *	return 0;
516
517
518
519
520
 * }
 *
 * static struct ftrace_event_call __used
 * __attribute__((__aligned__(4)))
 * __attribute__((section("_ftrace_events"))) event_<call> = {
521
 *	.name			= "<call>",
522
 *	.system			= "<system>",
523
524
525
 *	.raw_init		= ftrace_raw_init_event_<call>,
 *	.regfunc		= ftrace_reg_event_<call>,
 *	.unregfunc		= ftrace_unreg_event_<call>,
526
 *	.show_format		= ftrace_format_<call>,
527
528
529
530
 * }
 *
 */

531
532
#undef TP_FMT
#define TP_FMT(fmt, args...)	fmt "\n", ##args
533

Peter Zijlstra's avatar
Peter Zijlstra committed
534
535
536
537
538
539
540
541
542
543
544
#ifdef CONFIG_EVENT_PROFILE

#define _TRACE_PROFILE_INIT(call)					\
	.profile_count = ATOMIC_INIT(-1),				\
	.profile_enable = ftrace_profile_enable_##call,			\
	.profile_disable = ftrace_profile_disable_##call,

#else
#define _TRACE_PROFILE_INIT(call)
#endif

545
546
#undef __entry
#define __entry entry
547

548
549
550
551
552
553
#undef __field
#define __field(type, item)

#undef __array
#define __array(type, item, len)

554
555
556
557
#undef __dynamic_array
#define __dynamic_array(type, item, len)				\
	__entry->__data_loc_##item = __data_offsets.item;

558
#undef __string
559
#define __string(item, src) __dynamic_array(char, item, -1)       	\
560
561
562
563
564

#undef __assign_str
#define __assign_str(dst, src)						\
	strcpy(__get_str(dst), src);

565
#undef TRACE_EVENT
566
#define TRACE_EVENT(call, proto, args, tstruct, assign, print)		\
567
568
569
570
571
									\
static struct ftrace_event_call event_##call;				\
									\
static void ftrace_raw_event_##call(proto)				\
{									\
572
	struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
573
	struct ftrace_event_call *event_call = &event_##call;		\
574
575
576
	struct ring_buffer_event *event;				\
	struct ftrace_raw_##call *entry;				\
	unsigned long irq_flags;					\
577
	int __data_size;						\
578
579
580
581
582
	int pc;								\
									\
	local_save_flags(irq_flags);					\
	pc = preempt_count();						\
									\
583
	__data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
584
									\
585
	event = trace_current_buffer_lock_reserve(event_##call.id,	\
586
				 sizeof(*entry) + __data_size,		\
587
				 irq_flags, pc);			\
588
589
590
591
	if (!event)							\
		return;							\
	entry	= ring_buffer_event_data(event);			\
									\
592
593
594
									\
	tstruct								\
									\
595
	{ assign; }							\
596
									\
597
	if (!filter_current_check_discard(event_call, entry, event))	\
598
		trace_nowake_buffer_unlock_commit(event, irq_flags, pc); \
599
600
601
602
603
604
605
}									\
									\
static int ftrace_raw_reg_event_##call(void)				\
{									\
	int ret;							\
									\
	ret = register_trace_##call(ftrace_raw_event_##call);		\
606
	if (ret)							\
607
		pr_info("event trace: Could not activate trace point "	\
608
			"probe to " #call "\n");			\
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
	return ret;							\
}									\
									\
static void ftrace_raw_unreg_event_##call(void)				\
{									\
	unregister_trace_##call(ftrace_raw_event_##call);		\
}									\
									\
static struct trace_event ftrace_event_type_##call = {			\
	.trace			= ftrace_raw_output_##call,		\
};									\
									\
static int ftrace_raw_init_event_##call(void)				\
{									\
	int id;								\
									\
	id = register_ftrace_event(&ftrace_event_type_##call);		\
	if (!id)							\
		return -ENODEV;						\
	event_##call.id = id;						\
629
	INIT_LIST_HEAD(&event_##call.fields);				\
630
	init_preds(&event_##call);					\
631
632
633
634
635
636
	return 0;							\
}									\
									\
static struct ftrace_event_call __used					\
__attribute__((__aligned__(4)))						\
__attribute__((section("_ftrace_events"))) event_##call = {		\
637
	.name			= #call,				\
638
	.system			= __stringify(TRACE_SYSTEM),		\
639
	.event			= &ftrace_event_type_##call,		\
640
	.raw_init		= ftrace_raw_init_event_##call,		\
641
642
	.regfunc		= ftrace_raw_reg_event_##call,		\
	.unregfunc		= ftrace_raw_unreg_event_##call,	\
643
	.show_format		= ftrace_format_##call,			\
644
	.define_fields		= ftrace_define_fields_##call,		\
Peter Zijlstra's avatar
Peter Zijlstra committed
645
	_TRACE_PROFILE_INIT(call)					\
646
}
Peter Zijlstra's avatar
Peter Zijlstra committed
647

648
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
Peter Zijlstra's avatar
Peter Zijlstra committed
649
650
651

#undef _TRACE_PROFILE_INIT