ftrace.h 21.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
	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);
L
Li Zefan 已提交
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 211 212 213 214 215 216 217 218 219 220
#undef __print_symbolic_u64
#if BITS_PER_LONG == 32
#define __print_symbolic_u64(value, symbol_array...)			\
	({								\
		static const struct trace_print_flags_u64 symbols[] =	\
			{ symbol_array, { -1, NULL } };			\
		ftrace_print_symbols_seq_u64(p, value, symbols);	\
	})
#else
#define __print_symbolic_u64(value, symbol_array...)			\
			__print_symbolic(value, symbol_array)
#endif

K
Kei Tokunaga 已提交
221 222 223
#undef __print_hex
#define __print_hex(buf, buf_len) ftrace_print_hex_seq(p, buf, buf_len)

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

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

296 297
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

298 299
#undef __field_ext
#define __field_ext(type, item, filter_type)				\
300 301
	ret = trace_define_field(event_call, #type, #item,		\
				 offsetof(typeof(field), item),		\
302 303
				 sizeof(field.item),			\
				 is_signed_type(type), filter_type);	\
304 305 306
	if (ret)							\
		return ret;

307 308 309
#undef __field
#define __field(type, item)	__field_ext(type, item, FILTER_OTHER)

310 311
#undef __array
#define __array(type, item, len)					\
312 313 314 315 316 317
	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, \
318
				 offsetof(typeof(field), item),		\
319 320
				 sizeof(field.item),			\
				 is_signed_type(type), FILTER_OTHER);	\
321 322 323 324
		mutex_unlock(&event_storage_mutex);			\
		if (ret)						\
			return ret;					\
	} while (0);
325

326 327
#undef __dynamic_array
#define __dynamic_array(type, item, len)				       \
328
	ret = trace_define_field(event_call, "__data_loc " #type "[]", #item,  \
329
				 offsetof(typeof(field), __data_loc_##item),   \
330 331
				 sizeof(field.__data_loc_##item),	       \
				 is_signed_type(type), FILTER_OTHER);
332

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

336 337
#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print)	\
338
static int notrace							\
339
ftrace_define_fields_##call(struct ftrace_event_call *event_call)	\
340 341 342 343 344 345 346 347 348
{									\
	struct ftrace_raw_##call field;					\
	int ret;							\
									\
	tstruct;							\
									\
	return ret;							\
}

349 350 351
#undef DEFINE_EVENT
#define DEFINE_EVENT(template, name, proto, args)

352 353 354 355
#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))

356 357
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

358 359 360 361 362 363 364 365 366 367
/*
 * remember the offset of each array from the beginning of the event.
 */

#undef __entry
#define __entry entry

#undef __field
#define __field(type, item)

368 369 370
#undef __field_ext
#define __field_ext(type, item, filter_type)

371 372 373 374 375 376 377
#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);	\
378
	__data_offsets->item |= (len * sizeof(type)) << 16;		\
379 380 381
	__data_size += (len) * sizeof(type);

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

384 385
#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
386
static inline notrace int ftrace_get_offsets_##call(			\
387 388 389 390 391 392 393 394 395 396
	struct ftrace_data_offsets_##call *__data_offsets, proto)       \
{									\
	int __data_size = 0;						\
	struct ftrace_raw_##call __maybe_unused *entry;			\
									\
	tstruct;							\
									\
	return __data_size;						\
}

397 398 399
#undef DEFINE_EVENT
#define DEFINE_EVENT(template, name, proto, args)

400 401 402 403
#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))

404 405
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

406
/*
407
 * Stage 4 of the trace events.
408
 *
409
 * Override the macros in <trace/trace_events.h> to include the following:
410
 *
411
 * For those macros defined with TRACE_EVENT:
412 413 414
 *
 * static struct ftrace_event_call event_<call>;
 *
415
 * static void ftrace_raw_event_<call>(void *__data, proto)
416
 * {
417
 *	struct ftrace_event_call *event_call = __data;
L
Li Zefan 已提交
418
 *	struct ftrace_data_offsets_<call> __maybe_unused __data_offsets;
419 420
 *	struct ring_buffer_event *event;
 *	struct ftrace_raw_<call> *entry; <-- defined in stage 1
421
 *	struct ring_buffer *buffer;
422
 *	unsigned long irq_flags;
L
Li Zefan 已提交
423
 *	int __data_size;
424 425 426 427 428
 *	int pc;
 *
 *	local_save_flags(irq_flags);
 *	pc = preempt_count();
 *
L
Li Zefan 已提交
429 430
 *	__data_size = ftrace_get_offsets_<call>(&__data_offsets, args);
 *
431
 *	event = trace_current_buffer_lock_reserve(&buffer,
432
 *				  event_<call>->event.type,
L
Li Zefan 已提交
433
 *				  sizeof(*entry) + __data_size,
434 435 436 437 438
 *				  irq_flags, pc);
 *	if (!event)
 *		return;
 *	entry	= ring_buffer_event_data(event);
 *
L
Li Zefan 已提交
439 440
 *	{ <assign>; }  <-- Here we assign the entries by the __field and
 *			   __array macros.
441
 *
L
Li Zefan 已提交
442 443 444
 *	if (!filter_current_check_discard(buffer, event_call, entry, event))
 *		trace_current_buffer_unlock_commit(buffer,
 *						   event, irq_flags, pc);
445 446 447
 * }
 *
 * static struct trace_event ftrace_event_type_<call> = {
448
 *	.trace			= ftrace_raw_output_<call>, <-- stage 2
449 450
 * };
 *
L
Li Zefan 已提交
451 452
 * static const char print_fmt_<call>[] = <TP_printk>;
 *
453 454
 * static struct ftrace_event_class __used event_class_<template> = {
 *	.system			= "<system>",
455
 *	.define_fields		= ftrace_define_fields_<call>,
456 457 458
 *	.fields			= LIST_HEAD_INIT(event_class_##call.fields),
 *	.raw_init		= trace_event_raw_init,
 *	.probe			= ftrace_raw_event_##call,
459
 *	.reg			= ftrace_event_reg,
460 461
 * };
 *
462
 * static struct ftrace_event_call event_<call> = {
463
 *	.name			= "<call>",
464
 *	.class			= event_class_<template>,
465
 *	.event			= &ftrace_event_type_<call>,
L
Li Zefan 已提交
466
 *	.print_fmt		= print_fmt_<call>,
467
 * };
468 469 470 471
 * // 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>;
472 473 474
 *
 */

475
#ifdef CONFIG_PERF_EVENTS
P
Peter Zijlstra 已提交
476

477 478 479 480
#define _TRACE_PERF_PROTO(call, proto)					\
	static notrace void						\
	perf_trace_##call(void *__data, proto);

481
#define _TRACE_PERF_INIT(call)						\
482
	.perf_probe		= perf_trace_##call,
P
Peter Zijlstra 已提交
483 484

#else
485
#define _TRACE_PERF_PROTO(call, proto)
486
#define _TRACE_PERF_INIT(call)
487
#endif /* CONFIG_PERF_EVENTS */
P
Peter Zijlstra 已提交
488

489 490
#undef __entry
#define __entry entry
491

492 493 494 495 496 497
#undef __field
#define __field(type, item)

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

498 499 500 501
#undef __dynamic_array
#define __dynamic_array(type, item, len)				\
	__entry->__data_loc_##item = __data_offsets.item;

502
#undef __string
503
#define __string(item, src) __dynamic_array(char, item, -1)       	\
504 505 506 507 508

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

509 510 511 512 513 514
#undef TP_fast_assign
#define TP_fast_assign(args...) args

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

515 516
#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
517
									\
518
static notrace void							\
519
ftrace_raw_event_##call(void *__data, proto)				\
520
{									\
521
	struct ftrace_event_call *event_call = __data;			\
522
	struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
523 524
	struct ring_buffer_event *event;				\
	struct ftrace_raw_##call *entry;				\
525
	struct ring_buffer *buffer;					\
526
	unsigned long irq_flags;					\
527
	int __data_size;						\
528 529 530 531 532
	int pc;								\
									\
	local_save_flags(irq_flags);					\
	pc = preempt_count();						\
									\
533
	__data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
534
									\
535
	event = trace_current_buffer_lock_reserve(&buffer,		\
536
				 event_call->event.type,		\
537
				 sizeof(*entry) + __data_size,		\
538
				 irq_flags, pc);			\
539 540 541 542
	if (!event)							\
		return;							\
	entry	= ring_buffer_event_data(event);			\
									\
543 544
	tstruct								\
									\
545
	{ assign; }							\
546
									\
547 548 549
	if (!filter_current_check_discard(buffer, event_call, entry, event)) \
		trace_nowake_buffer_unlock_commit(buffer,		\
						  event, irq_flags, pc); \
550
}
551 552 553 554 555
/*
 * 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.
 */
556 557 558

#undef DEFINE_EVENT
#define DEFINE_EVENT(template, call, proto, args)			\
559
static inline void ftrace_test_probe_##call(void)			\
560
{									\
561 562
	check_trace_callback_type_##call(ftrace_raw_event_##template);	\
}
563 564

#undef DEFINE_EVENT_PRINT
565
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)
566 567 568

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

L
Lai Jiangshan 已提交
569 570 571 572 573
#undef __entry
#define __entry REC

#undef __print_flags
#undef __print_symbolic
574
#undef __print_hex
L
Lai Jiangshan 已提交
575 576 577 578 579 580
#undef __get_dynamic_array
#undef __get_str

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

581
#undef DECLARE_EVENT_CLASS
L
Lai Jiangshan 已提交
582
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
583
_TRACE_PERF_PROTO(call, PARAMS(proto));					\
584 585
static const char print_fmt_##call[] = print;				\
static struct ftrace_event_class __used event_class_##call = {		\
586
	.system			= __stringify(TRACE_SYSTEM),		\
587 588
	.define_fields		= ftrace_define_fields_##call,		\
	.fields			= LIST_HEAD_INIT(event_class_##call.fields),\
589
	.raw_init		= trace_event_raw_init,			\
590
	.probe			= ftrace_raw_event_##call,		\
591
	.reg			= ftrace_event_reg,			\
592
	_TRACE_PERF_INIT(call)						\
593
};
594 595 596

#undef DEFINE_EVENT
#define DEFINE_EVENT(template, call, proto, args)			\
597
									\
598
static struct ftrace_event_call __used event_##call = {			\
599
	.name			= #call,				\
600
	.class			= &event_class_##template,		\
601
	.event.funcs		= &ftrace_event_type_funcs_##template,	\
L
Lai Jiangshan 已提交
602
	.print_fmt		= print_fmt_##template,			\
603 604 605
};									\
static struct ftrace_event_call __used					\
__attribute__((section("_ftrace_events"))) *__event_##call = &event_##call
P
Peter Zijlstra 已提交
606

607 608
#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, call, proto, args, print)		\
609
									\
L
Lai Jiangshan 已提交
610 611
static const char print_fmt_##call[] = print;				\
									\
612
static struct ftrace_event_call __used event_##call = {			\
613
	.name			= #call,				\
614
	.class			= &event_class_##template,		\
615
	.event.funcs		= &ftrace_event_type_funcs_##call,	\
L
Lai Jiangshan 已提交
616
	.print_fmt		= print_fmt_##call,			\
617 618 619
};									\
static struct ftrace_event_call __used					\
__attribute__((section("_ftrace_events"))) *__event_##call = &event_##call
P
Peter Zijlstra 已提交
620

621
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
P
Peter Zijlstra 已提交
622

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

697
#ifdef CONFIG_PERF_EVENTS
698

L
Lai Jiangshan 已提交
699 700 701 702 703 704 705 706 707 708
#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)

709 710 711 712 713 714
#undef __perf_addr
#define __perf_addr(a) __addr = (a)

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

A
Andrew Vagin 已提交
715 716 717
#undef TP_perf_assign
#define TP_perf_assign(args...) args

718 719
#undef DECLARE_EVENT_CLASS
#define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)	\
720
static notrace void							\
721
perf_trace_##call(void *__data, proto)					\
722
{									\
723
	struct ftrace_event_call *event_call = __data;			\
724 725
	struct ftrace_data_offsets_##call __maybe_unused __data_offsets;\
	struct ftrace_raw_##call *entry;				\
S
Steven Rostedt 已提交
726
	struct pt_regs __regs;						\
727
	u64 __addr = 0, __count = 1;					\
728
	struct hlist_head *head;					\
729 730
	int __entry_size;						\
	int __data_size;						\
731
	int rctx;							\
732
									\
733
	perf_fetch_caller_regs(&__regs);				\
S
Steven Rostedt 已提交
734
									\
735
	__data_size = ftrace_get_offsets_##call(&__data_offsets, args); \
736 737
	__entry_size = ALIGN(__data_size + sizeof(*entry) + sizeof(u32),\
			     sizeof(u64));				\
738
	__entry_size -= sizeof(u32);					\
739
									\
740
	if (WARN_ONCE(__entry_size > PERF_MAX_TRACE_SIZE,		\
741 742
		      "profile buffer not large enough"))		\
		return;							\
743
									\
744
	entry = (struct ftrace_raw_##call *)perf_trace_buf_prepare(	\
S
Steven Rostedt 已提交
745
		__entry_size, event_call->event.type, &__regs, &rctx);	\
746 747
	if (!entry)							\
		return;							\
748
									\
749 750 751 752
	tstruct								\
									\
	{ assign; }							\
									\
753
	head = this_cpu_ptr(event_call->perf_events);			\
754
	perf_trace_buf_submit(entry, __entry_size, rctx, __addr,	\
S
Steven Rostedt 已提交
755
		__count, &__regs, head);				\
756 757
}

758 759 760 761 762
/*
 * 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.
 */
763
#undef DEFINE_EVENT
764
#define DEFINE_EVENT(template, call, proto, args)			\
765
static inline void perf_test_probe_##call(void)				\
766
{									\
767
	check_trace_callback_type_##call(perf_trace_##template);	\
768 769
}

770

771 772 773 774
#undef DEFINE_EVENT_PRINT
#define DEFINE_EVENT_PRINT(template, name, proto, args, print)	\
	DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))

775
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
776
#endif /* CONFIG_PERF_EVENTS */
777

P
Peter Zijlstra 已提交
778 779
#undef _TRACE_PROFILE_INIT