ftrace.h 22.8 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
 * DECLARE_EVENT_CLASS can be used to add a generic function
23
24
25
 * handlers for events. That is, if all events have the same
 * parameters and just have distinct trace points.
 * Each tracepoint can be defined with DEFINE_EVENT and that
26
 * will map the DECLARE_EVENT_CLASS to the tracepoint.
27
28
29
30
31
 *
 * TRACE_EVENT is a one to one mapping between tracepoint and template.
 */
#undef TRACE_EVENT
#define TRACE_EVENT(name, proto, args, tstruct, assign, print) \
32
	DECLARE_EVENT_CLASS(name,			       \
33
34
35
36
37
38
39
40
			     PARAMS(proto),		       \
			     PARAMS(args),		       \
			     PARAMS(tstruct),		       \
			     PARAMS(assign),		       \
			     PARAMS(print));		       \
	DEFINE_EVENT(name, name, PARAMS(proto), PARAMS(args));


41
42
43
#undef __field
#define __field(type, item)		type	item;

44
45
46
#undef __field_ext
#define __field_ext(type, item, filter_type)	type	item;

47
48
49
#undef __array
#define __array(type, item, len)	type	item[len];

50
#undef __dynamic_array
51
#define __dynamic_array(type, item, len) u32 __data_loc_##item;
52

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

56
57
58
#undef TP_STRUCT__entry
#define TP_STRUCT__entry(args...) args

59
60
#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(name, proto, args, tstruct, assign, print)	\
61
62
63
64
65
66
67
	struct ftrace_raw_##name {					\
		struct trace_entry	ent;				\
		tstruct							\
		char			__data[0];			\
	};
#undef DEFINE_EVENT
#define DEFINE_EVENT(template, name, proto, args)	\
68
69
	static struct ftrace_event_call event_##name

70
71
72
73
#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))

74
75
76
#undef __cpparg
#define __cpparg(arg...) arg

77
78
/* Callbacks are meaningless to ftrace. */
#undef TRACE_EVENT_FN
79
80
81
82
#define TRACE_EVENT_FN(name, proto, args, tstruct,			\
		assign, print, reg, unreg)				\
	TRACE_EVENT(name, __cpparg(proto), __cpparg(args),		\
		__cpparg(tstruct), __cpparg(assign), __cpparg(print))	\
83

84
85
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

86

87
88
89
/*
 * Stage 2 of the trace events.
 *
90
91
 * Include the following:
 *
92
 * struct ftrace_data_offsets_<call> {
93
94
 *	u32				<item1>;
 *	u32				<item2>;
95
96
97
 *	[...]
 * };
 *
98
 * The __dynamic_array() macro will create each u32 <item>, this is
99
 * to keep the offset of each array from the beginning of the event.
100
 * The size of an array is also encoded, in the higher 16 bits of <item>.
101
102
 */

103
#undef __field
104
105
106
107
#define __field(type, item)

#undef __field_ext
#define __field_ext(type, item, filter_type)
108

109
110
111
#undef __array
#define __array(type, item, len)

112
#undef __dynamic_array
113
#define __dynamic_array(type, item, len)	u32 item;
114
115

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

118
119
#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
120
	struct ftrace_data_offsets_##call {				\
121
122
123
		tstruct;						\
	};

124
125
126
#undef DEFINE_EVENT
#define DEFINE_EVENT(template, name, proto, args)

127
128
129
130
#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))

131
132
133
134
135
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

/*
 * Stage 3 of the trace events.
 *
136
137
138
139
140
141
142
143
 * 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;
144
 *	struct trace_seq *p;
145
146
147
148
149
150
151
152
153
154
155
 *	int ret;
 *
 *	entry = iter->ent;
 *
 *	if (entry->type != event_<call>.id) {
 *		WARN_ON_ONCE(1);
 *		return TRACE_TYPE_UNHANDLED;
 *	}
 *
 *	field = (typeof(field))entry;
 *
156
 *	p = get_cpu_var(ftrace_event_seq);
157
 *	trace_seq_init(p);
158
 *	ret = trace_seq_printf(s, <TP_printk> "\n");
159
 *	put_cpu();
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 *	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

177
178
#undef __get_dynamic_array
#define __get_dynamic_array(field)	\
179
		((void *)__entry + (__entry->__data_loc_##field & 0xffff))
180

181
#undef __get_str
182
#define __get_str(field) (char *)__get_dynamic_array(field)
183

184
185
186
#undef __print_flags
#define __print_flags(flag, delim, flag_array...)			\
	({								\
187
		static const struct trace_print_flags __flags[] =	\
188
			{ flag_array, { -1, NULL }};			\
189
		ftrace_print_flags_seq(p, delim, flag, __flags);	\
190
191
	})

192
193
194
195
196
197
198
199
#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);		\
	})

200
201
#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
202
static notrace enum print_line_t					\
203
204
ftrace_raw_output_id_##call(int event_id, const char *name,		\
			    struct trace_iterator *iter, int flags)	\
205
206
207
208
{									\
	struct trace_seq *s = &iter->seq;				\
	struct ftrace_raw_##call *field;				\
	struct trace_entry *entry;					\
209
	struct trace_seq *p;						\
210
211
212
213
	int ret;							\
									\
	entry = iter->ent;						\
									\
214
	if (entry->type != event_id) {					\
215
216
217
218
219
220
		WARN_ON_ONCE(1);					\
		return TRACE_TYPE_UNHANDLED;				\
	}								\
									\
	field = (typeof(field))entry;					\
									\
221
	p = &get_cpu_var(ftrace_event_seq);				\
222
	trace_seq_init(p);						\
223
224
225
	ret = trace_seq_printf(s, "%s: ", name);			\
	if (ret)							\
		ret = trace_seq_printf(s, print);			\
226
	put_cpu();							\
227
228
229
230
231
	if (!ret)							\
		return TRACE_TYPE_PARTIAL_LINE;				\
									\
	return TRACE_TYPE_HANDLED;					\
}
232
233
234

#undef DEFINE_EVENT
#define DEFINE_EVENT(template, name, proto, args)			\
235
static notrace enum print_line_t					\
236
237
238
239
240
241
ftrace_raw_output_##name(struct trace_iterator *iter, int flags)	\
{									\
	return ftrace_raw_output_id_##template(event_##name.id,		\
					       #name, iter, flags);	\
}

242
243
#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, call, proto, args, print)		\
244
static notrace enum print_line_t					\
245
246
247
248
249
250
ftrace_raw_output_##call(struct trace_iterator *iter, int flags)	\
{									\
	struct trace_seq *s = &iter->seq;				\
	struct ftrace_raw_##template *field;				\
	struct trace_entry *entry;					\
	struct trace_seq *p;						\
251
252
253
254
255
256
257
258
259
260
261
	int ret;							\
									\
	entry = iter->ent;						\
									\
	if (entry->type != event_##call.id) {				\
		WARN_ON_ONCE(1);					\
		return TRACE_TYPE_UNHANDLED;				\
	}								\
									\
	field = (typeof(field))entry;					\
									\
262
	p = &get_cpu_var(ftrace_event_seq);				\
263
	trace_seq_init(p);						\
264
265
266
	ret = trace_seq_printf(s, "%s: ", #call);			\
	if (ret)							\
		ret = trace_seq_printf(s, print);			\
267
	put_cpu();							\
268
269
270
271
272
	if (!ret)							\
		return TRACE_TYPE_PARTIAL_LINE;				\
									\
	return TRACE_TYPE_HANDLED;					\
}
273

274
275
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

276
277
#undef __field_ext
#define __field_ext(type, item, filter_type)				\
278
279
	ret = trace_define_field(event_call, #type, #item,		\
				 offsetof(typeof(field), item),		\
280
281
				 sizeof(field.item),			\
				 is_signed_type(type), filter_type);	\
282
283
284
	if (ret)							\
		return ret;

285
286
287
#undef __field
#define __field(type, item)	__field_ext(type, item, FILTER_OTHER)

288
289
290
291
292
#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),		\
293
294
				 sizeof(field.item),			\
				 is_signed_type(type), FILTER_OTHER);	\
295
296
297
	if (ret)							\
		return ret;

298
299
#undef __dynamic_array
#define __dynamic_array(type, item, len)				       \
300
	ret = trace_define_field(event_call, "__data_loc " #type "[]", #item,  \
301
				 offsetof(typeof(field), __data_loc_##item),   \
302
303
				 sizeof(field.__data_loc_##item),	       \
				 is_signed_type(type), FILTER_OTHER);
304

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

308
309
#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print)	\
310
static int notrace							\
311
ftrace_define_fields_##call(struct ftrace_event_call *event_call)	\
312
313
314
315
316
317
318
319
320
{									\
	struct ftrace_raw_##call field;					\
	int ret;							\
									\
	tstruct;							\
									\
	return ret;							\
}

321
322
323
#undef DEFINE_EVENT
#define DEFINE_EVENT(template, name, proto, args)

324
325
326
327
#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))

328
329
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

330
331
332
333
334
335
336
337
338
339
/*
 * remember the offset of each array from the beginning of the event.
 */

#undef __entry
#define __entry entry

#undef __field
#define __field(type, item)

340
341
342
#undef __field_ext
#define __field_ext(type, item, filter_type)

343
344
345
346
347
348
349
#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);	\
350
	__data_offsets->item |= (len * sizeof(type)) << 16;		\
351
352
353
	__data_size += (len) * sizeof(type);

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

356
357
#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
358
static inline notrace int ftrace_get_offsets_##call(			\
359
360
361
362
363
364
365
366
367
368
	struct ftrace_data_offsets_##call *__data_offsets, proto)       \
{									\
	int __data_size = 0;						\
	struct ftrace_raw_##call __maybe_unused *entry;			\
									\
	tstruct;							\
									\
	return __data_size;						\
}

369
370
371
#undef DEFINE_EVENT
#define DEFINE_EVENT(template, name, proto, args)

372
373
374
375
#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))

376
377
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

378
379
380
#ifdef CONFIG_EVENT_PROFILE

/*
381
 * Generate the functions needed for tracepoint perf_event support.
382
 *
383
 * NOTE: The insertion profile callback (ftrace_profile_<call>) is defined later
384
 *
385
 * static int ftrace_profile_enable_<call>(void)
386
 * {
387
 * 	return register_trace_<call>(ftrace_profile_<call>);
388
389
 * }
 *
390
 * static void ftrace_profile_disable_<call>(void)
391
 * {
392
 * 	unregister_trace_<call>(ftrace_profile_<call>);
393
394
395
396
 * }
 *
 */

397
398
#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)
399
400
401

#undef DEFINE_EVENT
#define DEFINE_EVENT(template, name, proto, args)			\
402
									\
403
static void ftrace_profile_##name(proto);				\
404
									\
405
406
static notrace int							\
ftrace_profile_enable_##name(struct ftrace_event_call *unused)		\
407
{									\
408
	return register_trace_##name(ftrace_profile_##name);		\
409
410
}									\
									\
411
412
static notrace void							\
ftrace_profile_disable_##name(struct ftrace_event_call *unused)		\
413
{									\
414
	unregister_trace_##name(ftrace_profile_##name);			\
415
416
}

417
418
419
420
#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))

421
422
423
424
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

#endif

425
/*
426
 * Stage 4 of the trace events.
427
 *
428
 * Override the macros in <trace/trace_events.h> to include the following:
429
430
431
 *
 * static void ftrace_event_<call>(proto)
 * {
432
 *	event_trace_printk(_RET_IP_, "<call>: " <fmt>);
433
434
 * }
 *
435
 * static int ftrace_reg_event_<call>(struct ftrace_event_call *unused)
436
 * {
437
 *	return register_trace_<call>(ftrace_event_<call>);
438
439
 * }
 *
440
 * static void ftrace_unreg_event_<call>(struct ftrace_event_call *unused)
441
 * {
442
 *	unregister_trace_<call>(ftrace_event_<call>);
443
444
445
 * }
 *
 *
446
 * For those macros defined with TRACE_EVENT:
447
448
449
450
451
 *
 * static struct ftrace_event_call event_<call>;
 *
 * static void ftrace_raw_event_<call>(proto)
 * {
452
453
 *	struct ring_buffer_event *event;
 *	struct ftrace_raw_<call> *entry; <-- defined in stage 1
454
 *	struct ring_buffer *buffer;
455
456
457
458
459
460
 *	unsigned long irq_flags;
 *	int pc;
 *
 *	local_save_flags(irq_flags);
 *	pc = preempt_count();
 *
461
462
 *	event = trace_current_buffer_lock_reserve(&buffer,
 *				  event_<call>.id,
463
464
465
466
467
468
469
 *				  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
470
 *			__array macros.
471
 *
472
 *	trace_current_buffer_unlock_commit(buffer, event, irq_flags, pc);
473
474
 * }
 *
475
 * static int ftrace_raw_reg_event_<call>(struct ftrace_event_call *unused)
476
 * {
477
 *	int ret;
478
 *
479
480
481
482
483
 *	ret = register_trace_<call>(ftrace_raw_event_<call>);
 *	if (!ret)
 *		pr_info("event trace: Could not activate trace point "
 *			"probe to <call>");
 *	return ret;
484
485
 * }
 *
486
 * static void ftrace_unreg_event_<call>(struct ftrace_event_call *unused)
487
 * {
488
 *	unregister_trace_<call>(ftrace_raw_event_<call>);
489
490
491
 * }
 *
 * static struct trace_event ftrace_event_type_<call> = {
492
 *	.trace			= ftrace_raw_output_<call>, <-- stage 2
493
494
495
496
497
 * };
 *
 * static struct ftrace_event_call __used
 * __attribute__((__aligned__(4)))
 * __attribute__((section("_ftrace_events"))) event_<call> = {
498
 *	.name			= "<call>",
499
 *	.system			= "<system>",
500
 *	.raw_init		= trace_event_raw_init,
501
502
 *	.regfunc		= ftrace_reg_event_<call>,
 *	.unregfunc		= ftrace_unreg_event_<call>,
503
504
505
506
 * }
 *
 */

Peter Zijlstra's avatar
Peter Zijlstra committed
507
508
509
510
511
512
513
514
515
516
#ifdef CONFIG_EVENT_PROFILE

#define _TRACE_PROFILE_INIT(call)					\
	.profile_enable = ftrace_profile_enable_##call,			\
	.profile_disable = ftrace_profile_disable_##call,

#else
#define _TRACE_PROFILE_INIT(call)
#endif

517
518
#undef __entry
#define __entry entry
519

520
521
522
523
524
525
#undef __field
#define __field(type, item)

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

526
527
528
529
#undef __dynamic_array
#define __dynamic_array(type, item, len)				\
	__entry->__data_loc_##item = __data_offsets.item;

530
#undef __string
531
#define __string(item, src) __dynamic_array(char, item, -1)       	\
532
533
534
535
536

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

537
538
539
540
541
542
#undef TP_fast_assign
#define TP_fast_assign(args...) args

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

543
544
#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
545
									\
546
547
static notrace void							\
ftrace_raw_event_id_##call(struct ftrace_event_call *event_call,	\
548
				       proto)				\
549
{									\
550
	struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
551
552
	struct ring_buffer_event *event;				\
	struct ftrace_raw_##call *entry;				\
553
	struct ring_buffer *buffer;					\
554
	unsigned long irq_flags;					\
555
	int __data_size;						\
556
557
558
559
560
	int pc;								\
									\
	local_save_flags(irq_flags);					\
	pc = preempt_count();						\
									\
561
	__data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
562
									\
563
	event = trace_current_buffer_lock_reserve(&buffer,		\
564
				 event_call->id,			\
565
				 sizeof(*entry) + __data_size,		\
566
				 irq_flags, pc);			\
567
568
569
570
	if (!event)							\
		return;							\
	entry	= ring_buffer_event_data(event);			\
									\
571
572
573
									\
	tstruct								\
									\
574
	{ assign; }							\
575
									\
576
577
578
	if (!filter_current_check_discard(buffer, event_call, entry, event)) \
		trace_nowake_buffer_unlock_commit(buffer,		\
						  event, irq_flags, pc); \
579
580
581
582
583
}

#undef DEFINE_EVENT
#define DEFINE_EVENT(template, call, proto, args)			\
									\
584
static notrace void ftrace_raw_event_##call(proto)			\
585
586
{									\
	ftrace_raw_event_id_##template(&event_##call, args);		\
587
588
}									\
									\
589
590
static notrace int							\
ftrace_raw_reg_event_##call(struct ftrace_event_call *unused)		\
591
{									\
592
	return register_trace_##call(ftrace_raw_event_##call);		\
593
594
}									\
									\
595
596
static notrace void							\
ftrace_raw_unreg_event_##call(struct ftrace_event_call *unused)		\
597
598
599
600
601
602
{									\
	unregister_trace_##call(ftrace_raw_event_##call);		\
}									\
									\
static struct trace_event ftrace_event_type_##call = {			\
	.trace			= ftrace_raw_output_##call,		\
603
};
604
605
606
607
608
609
610

#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

Lai Jiangshan's avatar
Lai Jiangshan committed
611
612
613
614
615
616
617
618
619
620
621
#undef __entry
#define __entry REC

#undef __print_flags
#undef __print_symbolic
#undef __get_dynamic_array
#undef __get_str

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

622
#undef DECLARE_EVENT_CLASS
Lai Jiangshan's avatar
Lai Jiangshan committed
623
624
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
static const char print_fmt_##call[] = print;
625
626
627

#undef DEFINE_EVENT
#define DEFINE_EVENT(template, call, proto, args)			\
628
629
630
631
									\
static struct ftrace_event_call __used					\
__attribute__((__aligned__(4)))						\
__attribute__((section("_ftrace_events"))) event_##call = {		\
632
	.name			= #call,				\
633
	.system			= __stringify(TRACE_SYSTEM),		\
634
	.event			= &ftrace_event_type_##call,		\
635
	.raw_init		= trace_event_raw_init,			\
636
637
	.regfunc		= ftrace_raw_reg_event_##call,		\
	.unregfunc		= ftrace_raw_unreg_event_##call,	\
Lai Jiangshan's avatar
Lai Jiangshan committed
638
	.print_fmt		= print_fmt_##template,			\
639
	.define_fields		= ftrace_define_fields_##template,	\
Peter Zijlstra's avatar
Peter Zijlstra committed
640
	_TRACE_PROFILE_INIT(call)					\
641
}
Peter Zijlstra's avatar
Peter Zijlstra committed
642

643
644
#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, call, proto, args, print)		\
645
									\
Lai Jiangshan's avatar
Lai Jiangshan committed
646
647
static const char print_fmt_##call[] = print;				\
									\
648
649
650
static struct ftrace_event_call __used					\
__attribute__((__aligned__(4)))						\
__attribute__((section("_ftrace_events"))) event_##call = {		\
651
	.name			= #call,				\
652
	.system			= __stringify(TRACE_SYSTEM),		\
653
	.event			= &ftrace_event_type_##call,		\
654
	.raw_init		= trace_event_raw_init,			\
655
656
	.regfunc		= ftrace_raw_reg_event_##call,		\
	.unregfunc		= ftrace_raw_unreg_event_##call,	\
Lai Jiangshan's avatar
Lai Jiangshan committed
657
	.print_fmt		= print_fmt_##call,			\
658
	.define_fields		= ftrace_define_fields_##template,	\
Peter Zijlstra's avatar
Peter Zijlstra committed
659
	_TRACE_PROFILE_INIT(call)					\
660
}
Peter Zijlstra's avatar
Peter Zijlstra committed
661

662
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
Peter Zijlstra's avatar
Peter Zijlstra committed
663

664
665
666
667
668
669
670
671
672
673
/*
 * Define the insertion callback to profile events
 *
 * The job is very similar to ftrace_raw_event_<call> except that we don't
 * insert in the ring buffer but in a perf counter.
 *
 * static void ftrace_profile_<call>(proto)
 * {
 *	struct ftrace_data_offsets_<call> __maybe_unused __data_offsets;
 *	struct ftrace_event_call *event_call = &event_<call>;
674
 *	extern void perf_tp_event(int, u64, u64, void *, int);
675
 *	struct ftrace_raw_##call *entry;
676
 *	struct perf_trace_buf *trace_buf;
677
678
 *	u64 __addr = 0, __count = 1;
 *	unsigned long irq_flags;
679
 *	struct trace_entry *ent;
680
681
 *	int __entry_size;
 *	int __data_size;
682
 *	int __cpu
683
684
685
686
687
 *	int pc;
 *
 *	pc = preempt_count();
 *
 *	__data_size = ftrace_get_offsets_<call>(&__data_offsets, args);
688
689
690
691
692
693
 *
 *	// Below we want to get the aligned size by taking into account
 *	// the u32 field that will later store the buffer size
 *	__entry_size = ALIGN(__data_size + sizeof(*entry) + sizeof(u32),
 *			     sizeof(u64));
 *	__entry_size -= sizeof(u32);
694
 *
695
696
697
698
699
700
 *	// Protect the non nmi buffer
 *	// This also protects the rcu read side
 *	local_irq_save(irq_flags);
 *	__cpu = smp_processor_id();
 *
 *	if (in_nmi())
701
 *		trace_buf = rcu_dereference(perf_trace_buf_nmi);
702
 *	else
703
 *		trace_buf = rcu_dereference(perf_trace_buf);
704
 *
705
 *	if (!trace_buf)
706
 *		goto end;
707
 *
708
709
710
711
712
713
714
715
716
717
718
719
 *	trace_buf = per_cpu_ptr(trace_buf, __cpu);
 *
 * 	// Avoid recursion from perf that could mess up the buffer
 * 	if (trace_buf->recursion++)
 *		goto end_recursion;
 *
 * 	raw_data = trace_buf->buf;
 *
 *	// Make recursion update visible before entering perf_tp_event
 *	// so that we protect from perf recursions.
 *
 *	barrier();
720
 *
721
722
723
724
725
726
 *	//zero dead bytes from alignment to avoid stack leak to userspace:
 *	*(u64 *)(&raw_data[__entry_size - sizeof(u64)]) = 0ULL;
 *	entry = (struct ftrace_raw_<call> *)raw_data;
 *	ent = &entry->ent;
 *	tracing_generic_entry_update(ent, irq_flags, pc);
 *	ent->type = event_call->id;
727
 *
728
 *	<tstruct> <- do some jobs with dynamic arrays
729
 *
730
 *	<assign>  <- affect our values
731
 *
732
 *	perf_tp_event(event_call->id, __addr, __count, entry,
733
 *		     __entry_size);  <- submit them to perf counter
734
735
736
737
738
739
 *
 * }
 */

#ifdef CONFIG_EVENT_PROFILE

Lai Jiangshan's avatar
Lai Jiangshan committed
740
741
742
743
744
745
746
747
748
749
#undef __entry
#define __entry entry

#undef __get_dynamic_array
#define __get_dynamic_array(field)	\
		((void *)__entry + (__entry->__data_loc_##field & 0xffff))

#undef __get_str
#define __get_str(field) (char *)__get_dynamic_array(field)

750
751
752
753
754
755
#undef __perf_addr
#define __perf_addr(a) __addr = (a)

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

756
757
#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
758
static notrace void							\
759
760
ftrace_profile_templ_##call(struct ftrace_event_call *event_call,	\
			    proto)					\
761
762
{									\
	struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
763
764
	extern int perf_swevent_get_recursion_context(void);		\
	extern void perf_swevent_put_recursion_context(int rctx);	\
765
	extern void perf_tp_event(int, u64, u64, void *, int);		\
766
767
768
	struct ftrace_raw_##call *entry;				\
	u64 __addr = 0, __count = 1;					\
	unsigned long irq_flags;					\
769
	struct trace_entry *ent;					\
770
771
	int __entry_size;						\
	int __data_size;						\
772
	char *trace_buf;						\
773
774
	char *raw_data;							\
	int __cpu;							\
775
	int rctx;							\
776
777
778
779
780
	int pc;								\
									\
	pc = preempt_count();						\
									\
	__data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
781
782
	__entry_size = ALIGN(__data_size + sizeof(*entry) + sizeof(u32),\
			     sizeof(u64));				\
783
	__entry_size -= sizeof(u32);					\
784
									\
785
786
787
788
789
	if (WARN_ONCE(__entry_size > FTRACE_MAX_PROFILE_SIZE,		\
		      "profile buffer not large enough"))		\
		return;							\
									\
	local_irq_save(irq_flags);					\
790
									\
791
792
793
	rctx = perf_swevent_get_recursion_context();			\
	if (rctx < 0)							\
		goto end_recursion;					\
794
									\
795
	__cpu = smp_processor_id();					\
796
									\
797
	if (in_nmi())							\
798
		trace_buf = rcu_dereference(perf_trace_buf_nmi);	\
799
	else								\
800
		trace_buf = rcu_dereference(perf_trace_buf);		\
801
									\
802
	if (!trace_buf)							\
803
		goto end;						\
804
									\
805
	raw_data = per_cpu_ptr(trace_buf, __cpu);			\
806
									\
807
808
809
810
811
812
813
814
815
816
	*(u64 *)(&raw_data[__entry_size - sizeof(u64)]) = 0ULL;		\
	entry = (struct ftrace_raw_##call *)raw_data;			\
	ent = &entry->ent;						\
	tracing_generic_entry_update(ent, irq_flags, pc);		\
	ent->type = event_call->id;					\
									\
	tstruct								\
									\
	{ assign; }							\
									\
817
	perf_tp_event(event_call->id, __addr, __count, entry,		\
818
			     __entry_size);				\
819
820
									\
end:									\
821
822
	perf_swevent_put_recursion_context(rctx);			\
end_recursion:								\
823
	local_irq_restore(irq_flags);					\
824
825
}

826
827
#undef DEFINE_EVENT
#define DEFINE_EVENT(template, call, proto, args)		\
828
static notrace void ftrace_profile_##call(proto)		\
829
830
831
832
833
834
{								\
	struct ftrace_event_call *event_call = &event_##call;	\
								\
	ftrace_profile_templ_##template(event_call, args);	\
}

835
836
837
838
#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))

839
840
841
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
#endif /* CONFIG_EVENT_PROFILE */

Peter Zijlstra's avatar
Peter Zijlstra committed
842
843
#undef _TRACE_PROFILE_INIT