ftrace.h 21.1 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
	struct ftrace_raw_##name {					\
		struct trace_entry	ent;				\
		tstruct							\
		char			__data[0];			\
65
66
67
68
	};								\
									\
	static struct ftrace_event_class event_class_##name;

69
70
#undef DEFINE_EVENT
#define DEFINE_EVENT(template, name, proto, args)	\
71
	static struct ftrace_event_call	__used		\
72
	__attribute__((__aligned__(4))) event_##name
73

74
75
76
77
#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))

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

85
86
87
88
89
90
91
92
93
#undef TRACE_EVENT_FLAGS
#define TRACE_EVENT_FLAGS(name, value)					\
	static int __init trace_init_flags_##name(void)			\
	{								\
		event_##name.flags = value;				\
		return 0;						\
	}								\
	early_initcall(trace_init_flags_##name);

94
95
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

96

97
98
99
/*
 * Stage 2 of the trace events.
 *
100
101
 * Include the following:
 *
102
 * struct ftrace_data_offsets_<call> {
103
104
 *	u32				<item1>;
 *	u32				<item2>;
105
106
107
 *	[...]
 * };
 *
108
 * The __dynamic_array() macro will create each u32 <item>, this is
109
 * to keep the offset of each array from the beginning of the event.
110
 * The size of an array is also encoded, in the higher 16 bits of <item>.
111
112
 */

113
#undef __field
114
115
116
117
#define __field(type, item)

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

119
120
121
#undef __array
#define __array(type, item, len)

122
#undef __dynamic_array
123
#define __dynamic_array(type, item, len)	u32 item;
124
125

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

128
129
#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
130
	struct ftrace_data_offsets_##call {				\
131
132
133
		tstruct;						\
	};

134
135
136
#undef DEFINE_EVENT
#define DEFINE_EVENT(template, name, proto, args)

137
138
139
140
#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))

141
142
143
#undef TRACE_EVENT_FLAGS
#define TRACE_EVENT_FLAGS(event, flag)

144
145
146
147
148
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

/*
 * Stage 3 of the trace events.
 *
149
150
151
152
153
154
155
156
 * 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;
157
 *	struct trace_seq *p = &iter->tmp_seq;
158
159
160
161
 *	int ret;
 *
 *	entry = iter->ent;
 *
162
 *	if (entry->type != event_<call>->event.type) {
163
164
165
166
167
168
 *		WARN_ON_ONCE(1);
 *		return TRACE_TYPE_UNHANDLED;
 *	}
 *
 *	field = (typeof(field))entry;
 *
169
 *	trace_seq_init(p);
Li Zefan's avatar
Li Zefan committed
170
171
172
 *	ret = trace_seq_printf(s, "%s: ", <call>);
 *	if (ret)
 *		ret = trace_seq_printf(s, <TP_printk> "\n");
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 *	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

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

194
#undef __get_str
195
#define __get_str(field) (char *)__get_dynamic_array(field)
196

197
198
199
#undef __print_flags
#define __print_flags(flag, delim, flag_array...)			\
	({								\
200
		static const struct trace_print_flags __flags[] =	\
201
			{ flag_array, { -1, NULL }};			\
202
		ftrace_print_flags_seq(p, delim, flag, __flags);	\
203
204
	})

205
206
207
208
209
210
211
212
#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);		\
	})

213
214
215
#undef __print_hex
#define __print_hex(buf, buf_len) ftrace_print_hex_seq(p, buf, buf_len)

216
217
#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
218
static notrace enum print_line_t					\
219
220
ftrace_raw_output_##call(struct trace_iterator *iter, int flags,	\
			 struct trace_event *trace_event)		\
221
{									\
222
	struct ftrace_event_call *event;				\
223
224
225
	struct trace_seq *s = &iter->seq;				\
	struct ftrace_raw_##call *field;				\
	struct trace_entry *entry;					\
226
	struct trace_seq *p = &iter->tmp_seq;				\
227
228
	int ret;							\
									\
229
230
231
	event = container_of(trace_event, struct ftrace_event_call,	\
			     event);					\
									\
232
233
	entry = iter->ent;						\
									\
234
	if (entry->type != event->event.type) {				\
235
236
237
238
239
240
		WARN_ON_ONCE(1);					\
		return TRACE_TYPE_UNHANDLED;				\
	}								\
									\
	field = (typeof(field))entry;					\
									\
241
	trace_seq_init(p);						\
242
	ret = trace_seq_printf(s, "%s: ", event->name);			\
243
244
	if (ret)							\
		ret = trace_seq_printf(s, print);			\
245
246
247
248
	if (!ret)							\
		return TRACE_TYPE_PARTIAL_LINE;				\
									\
	return TRACE_TYPE_HANDLED;					\
249
250
251
252
}									\
static struct trace_event_functions ftrace_event_type_funcs_##call = {	\
	.trace			= ftrace_raw_output_##call,		\
};
253

254
255
#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, call, proto, args, print)		\
256
static notrace enum print_line_t					\
257
258
ftrace_raw_output_##call(struct trace_iterator *iter, int flags,	\
			 struct trace_event *event)			\
259
260
261
262
{									\
	struct trace_seq *s = &iter->seq;				\
	struct ftrace_raw_##template *field;				\
	struct trace_entry *entry;					\
263
	struct trace_seq *p = &iter->tmp_seq;				\
264
265
266
267
	int ret;							\
									\
	entry = iter->ent;						\
									\
268
	if (entry->type != event_##call.event.type) {			\
269
270
271
272
273
274
		WARN_ON_ONCE(1);					\
		return TRACE_TYPE_UNHANDLED;				\
	}								\
									\
	field = (typeof(field))entry;					\
									\
275
	trace_seq_init(p);						\
276
277
278
	ret = trace_seq_printf(s, "%s: ", #call);			\
	if (ret)							\
		ret = trace_seq_printf(s, print);			\
279
280
281
282
	if (!ret)							\
		return TRACE_TYPE_PARTIAL_LINE;				\
									\
	return TRACE_TYPE_HANDLED;					\
283
284
285
286
}									\
static struct trace_event_functions ftrace_event_type_funcs_##call = {	\
	.trace			= ftrace_raw_output_##call,		\
};
287

288
289
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

290
291
#undef __field_ext
#define __field_ext(type, item, filter_type)				\
292
293
	ret = trace_define_field(event_call, #type, #item,		\
				 offsetof(typeof(field), item),		\
294
295
				 sizeof(field.item),			\
				 is_signed_type(type), filter_type);	\
296
297
298
	if (ret)							\
		return ret;

299
300
301
#undef __field
#define __field(type, item)	__field_ext(type, item, FILTER_OTHER)

302
303
304
305
306
#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),		\
307
308
				 sizeof(field.item),			\
				 is_signed_type(type), FILTER_OTHER);	\
309
310
311
	if (ret)							\
		return ret;

312
313
#undef __dynamic_array
#define __dynamic_array(type, item, len)				       \
314
	ret = trace_define_field(event_call, "__data_loc " #type "[]", #item,  \
315
				 offsetof(typeof(field), __data_loc_##item),   \
316
317
				 sizeof(field.__data_loc_##item),	       \
				 is_signed_type(type), FILTER_OTHER);
318

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

322
323
#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print)	\
324
static int notrace							\
325
ftrace_define_fields_##call(struct ftrace_event_call *event_call)	\
326
327
328
329
330
331
332
333
334
{									\
	struct ftrace_raw_##call field;					\
	int ret;							\
									\
	tstruct;							\
									\
	return ret;							\
}

335
336
337
#undef DEFINE_EVENT
#define DEFINE_EVENT(template, name, proto, args)

338
339
340
341
#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))

342
343
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

344
345
346
347
348
349
350
351
352
353
/*
 * remember the offset of each array from the beginning of the event.
 */

#undef __entry
#define __entry entry

#undef __field
#define __field(type, item)

354
355
356
#undef __field_ext
#define __field_ext(type, item, filter_type)

357
358
359
360
361
362
363
#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);	\
364
	__data_offsets->item |= (len * sizeof(type)) << 16;		\
365
366
367
	__data_size += (len) * sizeof(type);

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

370
371
#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
372
static inline notrace int ftrace_get_offsets_##call(			\
373
374
375
376
377
378
379
380
381
382
	struct ftrace_data_offsets_##call *__data_offsets, proto)       \
{									\
	int __data_size = 0;						\
	struct ftrace_raw_##call __maybe_unused *entry;			\
									\
	tstruct;							\
									\
	return __data_size;						\
}

383
384
385
#undef DEFINE_EVENT
#define DEFINE_EVENT(template, name, proto, args)

386
387
388
389
#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))

390
391
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

392
/*
393
 * Stage 4 of the trace events.
394
 *
395
 * Override the macros in <trace/trace_events.h> to include the following:
396
 *
397
 * For those macros defined with TRACE_EVENT:
398
399
400
 *
 * static struct ftrace_event_call event_<call>;
 *
401
 * static void ftrace_raw_event_<call>(void *__data, proto)
402
 * {
403
 *	struct ftrace_event_call *event_call = __data;
Li Zefan's avatar
Li Zefan committed
404
 *	struct ftrace_data_offsets_<call> __maybe_unused __data_offsets;
405
406
 *	struct ring_buffer_event *event;
 *	struct ftrace_raw_<call> *entry; <-- defined in stage 1
407
 *	struct ring_buffer *buffer;
408
 *	unsigned long irq_flags;
Li Zefan's avatar
Li Zefan committed
409
 *	int __data_size;
410
411
412
413
414
 *	int pc;
 *
 *	local_save_flags(irq_flags);
 *	pc = preempt_count();
 *
Li Zefan's avatar
Li Zefan committed
415
416
 *	__data_size = ftrace_get_offsets_<call>(&__data_offsets, args);
 *
417
 *	event = trace_current_buffer_lock_reserve(&buffer,
418
 *				  event_<call>->event.type,
Li Zefan's avatar
Li Zefan committed
419
 *				  sizeof(*entry) + __data_size,
420
421
422
423
424
 *				  irq_flags, pc);
 *	if (!event)
 *		return;
 *	entry	= ring_buffer_event_data(event);
 *
Li Zefan's avatar
Li Zefan committed
425
426
 *	{ <assign>; }  <-- Here we assign the entries by the __field and
 *			   __array macros.
427
 *
Li Zefan's avatar
Li Zefan committed
428
429
430
 *	if (!filter_current_check_discard(buffer, event_call, entry, event))
 *		trace_current_buffer_unlock_commit(buffer,
 *						   event, irq_flags, pc);
431
432
433
 * }
 *
 * static struct trace_event ftrace_event_type_<call> = {
434
 *	.trace			= ftrace_raw_output_<call>, <-- stage 2
435
436
 * };
 *
Li Zefan's avatar
Li Zefan committed
437
438
 * static const char print_fmt_<call>[] = <TP_printk>;
 *
439
440
 * static struct ftrace_event_class __used event_class_<template> = {
 *	.system			= "<system>",
441
 *	.define_fields		= ftrace_define_fields_<call>,
442
443
444
 *	.fields			= LIST_HEAD_INIT(event_class_##call.fields),
 *	.raw_init		= trace_event_raw_init,
 *	.probe			= ftrace_raw_event_##call,
445
 *	.reg			= ftrace_event_reg,
446
447
 * };
 *
448
449
450
 * static struct ftrace_event_call __used
 * __attribute__((__aligned__(4)))
 * __attribute__((section("_ftrace_events"))) event_<call> = {
451
 *	.name			= "<call>",
452
 *	.class			= event_class_<template>,
453
 *	.event			= &ftrace_event_type_<call>,
Li Zefan's avatar
Li Zefan committed
454
 *	.print_fmt		= print_fmt_<call>,
455
 * };
456
457
458
 *
 */

459
#ifdef CONFIG_PERF_EVENTS
Peter Zijlstra's avatar
Peter Zijlstra committed
460

461
462
463
464
#define _TRACE_PERF_PROTO(call, proto)					\
	static notrace void						\
	perf_trace_##call(void *__data, proto);

465
#define _TRACE_PERF_INIT(call)						\
466
	.perf_probe		= perf_trace_##call,
Peter Zijlstra's avatar
Peter Zijlstra committed
467
468

#else
469
#define _TRACE_PERF_PROTO(call, proto)
470
#define _TRACE_PERF_INIT(call)
471
#endif /* CONFIG_PERF_EVENTS */
Peter Zijlstra's avatar
Peter Zijlstra committed
472

473
474
#undef __entry
#define __entry entry
475

476
477
478
479
480
481
#undef __field
#define __field(type, item)

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

482
483
484
485
#undef __dynamic_array
#define __dynamic_array(type, item, len)				\
	__entry->__data_loc_##item = __data_offsets.item;

486
#undef __string
487
#define __string(item, src) __dynamic_array(char, item, -1)       	\
488
489
490
491
492

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

493
494
495
496
497
498
#undef TP_fast_assign
#define TP_fast_assign(args...) args

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

499
500
#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
501
									\
502
static notrace void							\
503
ftrace_raw_event_##call(void *__data, proto)				\
504
{									\
505
	struct ftrace_event_call *event_call = __data;			\
506
	struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
507
508
	struct ring_buffer_event *event;				\
	struct ftrace_raw_##call *entry;				\
509
	struct ring_buffer *buffer;					\
510
	unsigned long irq_flags;					\
511
	int __data_size;						\
512
513
514
515
516
	int pc;								\
									\
	local_save_flags(irq_flags);					\
	pc = preempt_count();						\
									\
517
	__data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
518
									\
519
	event = trace_current_buffer_lock_reserve(&buffer,		\
520
				 event_call->event.type,		\
521
				 sizeof(*entry) + __data_size,		\
522
				 irq_flags, pc);			\
523
524
525
526
	if (!event)							\
		return;							\
	entry	= ring_buffer_event_data(event);			\
									\
527
528
	tstruct								\
									\
529
	{ assign; }							\
530
									\
531
532
533
	if (!filter_current_check_discard(buffer, event_call, entry, event)) \
		trace_nowake_buffer_unlock_commit(buffer,		\
						  event, irq_flags, pc); \
534
}
535
536
537
538
539
/*
 * The ftrace_test_probe is compiled out, it is only here as a build time check
 * to make sure that if the tracepoint handling changes, the ftrace probe will
 * fail to compile unless it too is updated.
 */
540
541
542

#undef DEFINE_EVENT
#define DEFINE_EVENT(template, call, proto, args)			\
543
static inline void ftrace_test_probe_##call(void)			\
544
{									\
545
546
	check_trace_callback_type_##call(ftrace_raw_event_##template);	\
}
547
548

#undef DEFINE_EVENT_PRINT
549
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)
550
551
552

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

Lai Jiangshan's avatar
Lai Jiangshan committed
553
554
555
556
557
558
559
560
561
562
563
#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)

564
#undef DECLARE_EVENT_CLASS
Lai Jiangshan's avatar
Lai Jiangshan committed
565
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
566
_TRACE_PERF_PROTO(call, PARAMS(proto));					\
567
568
static const char print_fmt_##call[] = print;				\
static struct ftrace_event_class __used event_class_##call = {		\
569
	.system			= __stringify(TRACE_SYSTEM),		\
570
571
	.define_fields		= ftrace_define_fields_##call,		\
	.fields			= LIST_HEAD_INIT(event_class_##call.fields),\
572
	.raw_init		= trace_event_raw_init,			\
573
	.probe			= ftrace_raw_event_##call,		\
574
	.reg			= ftrace_event_reg,			\
575
	_TRACE_PERF_INIT(call)						\
576
};
577
578
579

#undef DEFINE_EVENT
#define DEFINE_EVENT(template, call, proto, args)			\
580
581
582
583
									\
static struct ftrace_event_call __used					\
__attribute__((__aligned__(4)))						\
__attribute__((section("_ftrace_events"))) event_##call = {		\
584
	.name			= #call,				\
585
	.class			= &event_class_##template,		\
586
	.event.funcs		= &ftrace_event_type_funcs_##template,	\
Lai Jiangshan's avatar
Lai Jiangshan committed
587
	.print_fmt		= print_fmt_##template,			\
588
};
Peter Zijlstra's avatar
Peter Zijlstra committed
589

590
591
#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, call, proto, args, print)		\
592
									\
Lai Jiangshan's avatar
Lai Jiangshan committed
593
594
static const char print_fmt_##call[] = print;				\
									\
595
596
597
static struct ftrace_event_call __used					\
__attribute__((__aligned__(4)))						\
__attribute__((section("_ftrace_events"))) event_##call = {		\
598
	.name			= #call,				\
599
	.class			= &event_class_##template,		\
600
	.event.funcs		= &ftrace_event_type_funcs_##call,	\
Lai Jiangshan's avatar
Lai Jiangshan committed
601
	.print_fmt		= print_fmt_##call,			\
602
}
Peter Zijlstra's avatar
Peter Zijlstra committed
603

604
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
Peter Zijlstra's avatar
Peter Zijlstra committed
605

606
/*
607
 * Define the insertion callback to perf events
608
609
610
611
 *
 * 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.
 *
612
 * static void ftrace_perf_<call>(proto)
613
614
615
 * {
 *	struct ftrace_data_offsets_<call> __maybe_unused __data_offsets;
 *	struct ftrace_event_call *event_call = &event_<call>;
616
 *	extern void perf_tp_event(int, u64, u64, void *, int);
617
 *	struct ftrace_raw_##call *entry;
618
 *	struct perf_trace_buf *trace_buf;
619
620
 *	u64 __addr = 0, __count = 1;
 *	unsigned long irq_flags;
621
 *	struct trace_entry *ent;
622
623
 *	int __entry_size;
 *	int __data_size;
624
 *	int __cpu
625
626
627
628
629
 *	int pc;
 *
 *	pc = preempt_count();
 *
 *	__data_size = ftrace_get_offsets_<call>(&__data_offsets, args);
630
631
632
633
634
635
 *
 *	// 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);
636
 *
637
638
639
640
641
642
 *	// Protect the non nmi buffer
 *	// This also protects the rcu read side
 *	local_irq_save(irq_flags);
 *	__cpu = smp_processor_id();
 *
 *	if (in_nmi())
643
 *		trace_buf = rcu_dereference_sched(perf_trace_buf_nmi);
644
 *	else
645
 *		trace_buf = rcu_dereference_sched(perf_trace_buf);
646
 *
647
 *	if (!trace_buf)
648
 *		goto end;
649
 *
650
651
652
653
654
655
656
657
658
659
660
661
 *	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();
662
 *
663
664
665
666
667
668
 *	//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;
669
 *
670
 *	<tstruct> <- do some jobs with dynamic arrays
671
 *
672
 *	<assign>  <- affect our values
673
 *
674
 *	perf_tp_event(event_call->id, __addr, __count, entry,
675
 *		     __entry_size);  <- submit them to perf counter
676
677
678
679
 *
 * }
 */

680
#ifdef CONFIG_PERF_EVENTS
681

Lai Jiangshan's avatar
Lai Jiangshan committed
682
683
684
685
686
687
688
689
690
691
#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)

692
693
694
695
696
697
#undef __perf_addr
#define __perf_addr(a) __addr = (a)

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

698
699
#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
700
static notrace void							\
701
perf_trace_##call(void *__data, proto)					\
702
{									\
703
	struct ftrace_event_call *event_call = __data;			\
704
705
	struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
	struct ftrace_raw_##call *entry;				\
706
	struct pt_regs __regs;						\
707
	u64 __addr = 0, __count = 1;					\
708
	struct hlist_head *head;					\
709
710
	int __entry_size;						\
	int __data_size;						\
711
	int rctx;							\
712
									\
713
	perf_fetch_caller_regs(&__regs);				\
714
									\
715
	__data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
716
717
	__entry_size = ALIGN(__data_size + sizeof(*entry) + sizeof(u32),\
			     sizeof(u64));				\
718
	__entry_size -= sizeof(u32);					\
719
									\
720
	if (WARN_ONCE(__entry_size > PERF_MAX_TRACE_SIZE,		\
721
722
		      "profile buffer not large enough"))		\
		return;							\
723
									\
724
	entry = (struct ftrace_raw_##call *)perf_trace_buf_prepare(	\
725
		__entry_size, event_call->event.type, &__regs, &rctx);	\
726
727
	if (!entry)							\
		return;							\
728
									\
729
730
731
732
	tstruct								\
									\
	{ assign; }							\
									\
733
	head = this_cpu_ptr(event_call->perf_events);			\
734
	perf_trace_buf_submit(entry, __entry_size, rctx, __addr,	\
735
		__count, &__regs, head);				\
736
737
}

738
739
740
741
742
/*
 * This part is compiled out, it is only here as a build time check
 * to make sure that if the tracepoint handling changes, the
 * perf probe will fail to compile unless it too is updated.
 */
743
#undef DEFINE_EVENT
744
#define DEFINE_EVENT(template, call, proto, args)			\
745
static inline void perf_test_probe_##call(void)				\
746
{									\
747
	check_trace_callback_type_##call(perf_trace_##template);	\
748
749
}

750

751
752
753
754
#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))

755
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
756
#endif /* CONFIG_PERF_EVENTS */
757

Peter Zijlstra's avatar
Peter Zijlstra committed
758
759
#undef _TRACE_PROFILE_INIT