ftrace.h 21.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
 * 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
#undef TRACE_EVENT_FLAGS
#define TRACE_EVENT_FLAGS(name, value)					\
87
	__TRACE_EVENT_FLAGS(name, value)
88

89
90
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

91

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

108
#undef __field
109
110
111
112
#define __field(type, item)

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

114
115
116
#undef __array
#define __array(type, item, len)

117
#undef __dynamic_array
118
#define __dynamic_array(type, item, len)	u32 item;
119
120

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

123
124
#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
125
	struct ftrace_data_offsets_##call {				\
126
127
128
		tstruct;						\
	};

129
130
131
#undef DEFINE_EVENT
#define DEFINE_EVENT(template, name, proto, args)

132
133
134
135
#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))

136
137
138
#undef TRACE_EVENT_FLAGS
#define TRACE_EVENT_FLAGS(event, flag)

139
140
141
142
143
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

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

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

189
#undef __get_str
190
#define __get_str(field) (char *)__get_dynamic_array(field)
191

192
193
194
#undef __print_flags
#define __print_flags(flag, delim, flag_array...)			\
	({								\
195
		static const struct trace_print_flags __flags[] =	\
196
			{ flag_array, { -1, NULL }};			\
197
		ftrace_print_flags_seq(p, delim, flag, __flags);	\
198
199
	})

200
201
202
203
204
205
206
207
#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);		\
	})

208
209
210
#undef __print_hex
#define __print_hex(buf, buf_len) ftrace_print_hex_seq(p, buf, buf_len)

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

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

283
284
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

285
286
#undef __field_ext
#define __field_ext(type, item, filter_type)				\
287
288
	ret = trace_define_field(event_call, #type, #item,		\
				 offsetof(typeof(field), item),		\
289
290
				 sizeof(field.item),			\
				 is_signed_type(type), filter_type);	\
291
292
293
	if (ret)							\
		return ret;

294
295
296
#undef __field
#define __field(type, item)	__field_ext(type, item, FILTER_OTHER)

297
298
#undef __array
#define __array(type, item, len)					\
299
300
301
302
303
304
	do {								\
		mutex_lock(&event_storage_mutex);			\
		BUILD_BUG_ON(len > MAX_FILTER_STR_VAL);			\
		snprintf(event_storage, sizeof(event_storage),		\
			 "%s[%d]", #type, len);				\
		ret = trace_define_field(event_call, event_storage, #item, \
305
				 offsetof(typeof(field), item),		\
306
307
				 sizeof(field.item),			\
				 is_signed_type(type), FILTER_OTHER);	\
308
309
310
311
		mutex_unlock(&event_storage_mutex);			\
		if (ret)						\
			return ret;					\
	} while (0);
312

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

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

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

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

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

343
344
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

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

#undef __entry
#define __entry entry

#undef __field
#define __field(type, item)

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

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

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

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

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

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

391
392
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

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

462
#ifdef CONFIG_PERF_EVENTS
Peter Zijlstra's avatar
Peter Zijlstra committed
463

464
465
466
467
#define _TRACE_PERF_PROTO(call, proto)					\
	static notrace void						\
	perf_trace_##call(void *__data, proto);

468
#define _TRACE_PERF_INIT(call)						\
469
	.perf_probe		= perf_trace_##call,
Peter Zijlstra's avatar
Peter Zijlstra committed
470
471

#else
472
#define _TRACE_PERF_PROTO(call, proto)
473
#define _TRACE_PERF_INIT(call)
474
#endif /* CONFIG_PERF_EVENTS */
Peter Zijlstra's avatar
Peter Zijlstra committed
475

476
477
#undef __entry
#define __entry entry
478

479
480
481
482
483
484
#undef __field
#define __field(type, item)

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

485
486
487
488
#undef __dynamic_array
#define __dynamic_array(type, item, len)				\
	__entry->__data_loc_##item = __data_offsets.item;

489
#undef __string
490
#define __string(item, src) __dynamic_array(char, item, -1)       	\
491
492
493
494
495

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

496
497
498
499
500
501
#undef TP_fast_assign
#define TP_fast_assign(args...) args

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

502
503
#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
504
									\
505
static notrace void							\
506
ftrace_raw_event_##call(void *__data, proto)				\
507
{									\
508
	struct ftrace_event_call *event_call = __data;			\
509
	struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
510
511
	struct ring_buffer_event *event;				\
	struct ftrace_raw_##call *entry;				\
512
	struct ring_buffer *buffer;					\
513
	unsigned long irq_flags;					\
514
	int __data_size;						\
515
516
517
518
519
	int pc;								\
									\
	local_save_flags(irq_flags);					\
	pc = preempt_count();						\
									\
520
	__data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
521
									\
522
	event = trace_current_buffer_lock_reserve(&buffer,		\
523
				 event_call->event.type,		\
524
				 sizeof(*entry) + __data_size,		\
525
				 irq_flags, pc);			\
526
527
528
529
	if (!event)							\
		return;							\
	entry	= ring_buffer_event_data(event);			\
									\
530
531
	tstruct								\
									\
532
	{ assign; }							\
533
									\
534
535
536
	if (!filter_current_check_discard(buffer, event_call, entry, event)) \
		trace_nowake_buffer_unlock_commit(buffer,		\
						  event, irq_flags, pc); \
537
}
538
539
540
541
542
/*
 * 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.
 */
543
544
545

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

#undef DEFINE_EVENT_PRINT
552
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)
553
554
555

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

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

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

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

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

607
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
Peter Zijlstra's avatar
Peter Zijlstra committed
608

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

683
#ifdef CONFIG_PERF_EVENTS
684

Lai Jiangshan's avatar
Lai Jiangshan committed
685
686
687
688
689
690
691
692
693
694
#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)

695
696
697
698
699
700
#undef __perf_addr
#define __perf_addr(a) __addr = (a)

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

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

741
742
743
744
745
/*
 * 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.
 */
746
#undef DEFINE_EVENT
747
#define DEFINE_EVENT(template, call, proto, args)			\
748
static inline void perf_test_probe_##call(void)				\
749
{									\
750
	check_trace_callback_type_##call(perf_trace_##template);	\
751
752
}

753

754
755
756
757
#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))

758
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
759
#endif /* CONFIG_PERF_EVENTS */
760

Peter Zijlstra's avatar
Peter Zijlstra committed
761
762
#undef _TRACE_PROFILE_INIT