ftrace.h 22.7 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 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
235
236
237
238
239
240
241

#undef DEFINE_EVENT
#define DEFINE_EVENT(template, name, proto, args)			\
static enum print_line_t						\
ftrace_raw_output_##name(struct trace_iterator *iter, int flags)	\
{									\
	return ftrace_raw_output_id_##template(event_##name.id,		\
					       #name, iter, flags);	\
}

242
243
244
245
246
247
248
249
250
#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, call, proto, args, print)		\
static enum print_line_t						\
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								\
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
359
360
361
362
363
364
365
366
367
368
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;						\
}

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
static int ftrace_profile_enable_##name(struct ftrace_event_call *unused)\
406
{									\
407
	return register_trace_##name(ftrace_profile_##name);		\
408
409
}									\
									\
410
static void ftrace_profile_disable_##name(struct ftrace_event_call *unused)\
411
{									\
412
	unregister_trace_##name(ftrace_profile_##name);			\
413
414
}

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

419
420
421
422
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

#endif

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

Peter Zijlstra's avatar
Peter Zijlstra committed
505
506
507
508
509
510
511
512
513
514
#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

515
516
#undef __entry
#define __entry entry
517

518
519
520
521
522
523
#undef __field
#define __field(type, item)

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

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

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

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

535
536
537
538
539
540
#undef TP_fast_assign
#define TP_fast_assign(args...) args

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

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

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

#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
606
607
608
609
610
611
612
613
614
615
616
#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)

617
#undef DECLARE_EVENT_CLASS
Lai Jiangshan's avatar
Lai Jiangshan committed
618
619
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
static const char print_fmt_##call[] = print;
620
621
622

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

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

657
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
Peter Zijlstra's avatar
Peter Zijlstra committed
658

659
660
661
662
663
664
665
666
667
668
/*
 * 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>;
669
 *	extern void perf_tp_event(int, u64, u64, void *, int);
670
 *	struct ftrace_raw_##call *entry;
671
 *	struct perf_trace_buf *trace_buf;
672
673
 *	u64 __addr = 0, __count = 1;
 *	unsigned long irq_flags;
674
 *	struct trace_entry *ent;
675
676
 *	int __entry_size;
 *	int __data_size;
677
 *	int __cpu
678
679
680
681
682
 *	int pc;
 *
 *	pc = preempt_count();
 *
 *	__data_size = ftrace_get_offsets_<call>(&__data_offsets, args);
683
684
685
686
687
688
 *
 *	// 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);
689
 *
690
691
692
693
694
695
 *	// Protect the non nmi buffer
 *	// This also protects the rcu read side
 *	local_irq_save(irq_flags);
 *	__cpu = smp_processor_id();
 *
 *	if (in_nmi())
696
 *		trace_buf = rcu_dereference(perf_trace_buf_nmi);
697
 *	else
698
 *		trace_buf = rcu_dereference(perf_trace_buf);
699
 *
700
 *	if (!trace_buf)
701
 *		goto end;
702
 *
703
704
705
706
707
708
709
710
711
712
713
714
 *	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();
715
 *
716
717
718
719
720
721
 *	//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;
722
 *
723
 *	<tstruct> <- do some jobs with dynamic arrays
724
 *
725
 *	<assign>  <- affect our values
726
 *
727
 *	perf_tp_event(event_call->id, __addr, __count, entry,
728
 *		     __entry_size);  <- submit them to perf counter
729
730
731
732
733
734
 *
 * }
 */

#ifdef CONFIG_EVENT_PROFILE

Lai Jiangshan's avatar
Lai Jiangshan committed
735
736
737
738
739
740
741
742
743
744
#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)

745
746
747
748
749
750
#undef __perf_addr
#define __perf_addr(a) __addr = (a)

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

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

821
822
823
824
825
826
827
828
829
#undef DEFINE_EVENT
#define DEFINE_EVENT(template, call, proto, args)		\
static void ftrace_profile_##call(proto)			\
{								\
	struct ftrace_event_call *event_call = &event_##call;	\
								\
	ftrace_profile_templ_##template(event_call, args);	\
}

830
831
832
833
#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))

834
835
836
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
#endif /* CONFIG_EVENT_PROFILE */

Peter Zijlstra's avatar
Peter Zijlstra committed
837
838
#undef _TRACE_PROFILE_INIT