ftrace.h 13.5 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
/*
 * 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>

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

#undef __field
#define __field(type, item)		type	item;

27
#undef __string
28
#define __string(item, src)		unsigned short	__str_loc_##item;
29

30
31
32
33
34
35
36
37
#undef TP_STRUCT__entry
#define TP_STRUCT__entry(args...) args

#undef TRACE_EVENT
#define TRACE_EVENT(name, proto, args, tstruct, assign, print)	\
	struct ftrace_raw_##name {				\
		struct trace_entry	ent;			\
		tstruct						\
38
		char			__str_data[0];		\
39
40
41
42
43
	};							\
	static struct ftrace_event_call event_##name

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

44

45
46
47
/*
 * Stage 2 of the trace events.
 *
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 * Include the following:
 *
 * struct ftrace_str_offsets_<call> {
 *	int				<str1>;
 *	int				<str2>;
 *	[...]
 * };
 *
 * The __string() macro will create each int <str>, this is to
 * keep the offset of each string from the beggining of the event
 * once we perform the strlen() of the src strings.
 *
 */

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

#undef __field
#define __field(type, item);

#undef __string
#define __string(item, src)	int item;

#undef TRACE_EVENT
#define TRACE_EVENT(call, proto, args, tstruct, assign, print)		\
	struct ftrace_str_offsets_##call {				\
		tstruct;						\
	};

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

/*
 * Stage 3 of the trace events.
 *
82
83
84
85
86
87
88
89
 * 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;
90
 *	struct trace_seq *p;
91
92
93
94
95
96
97
98
99
100
101
 *	int ret;
 *
 *	entry = iter->ent;
 *
 *	if (entry->type != event_<call>.id) {
 *		WARN_ON_ONCE(1);
 *		return TRACE_TYPE_UNHANDLED;
 *	}
 *
 *	field = (typeof(field))entry;
 *
102
 *	p = get_cpu_var(ftrace_event_seq);
103
 *	ret = trace_seq_printf(s, <TP_printk> "\n");
104
 *	put_cpu();
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 *	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

122
#undef __get_str
123
#define __get_str(field)	((char *)__entry + __entry->__str_loc_##field)
124

125
126
127
128
129
130
131
132
#undef __print_flags
#define __print_flags(flag, delim, flag_array...)			\
	({								\
		static const struct trace_print_flags flags[] =		\
			{ flag_array, { -1, NULL }};			\
		ftrace_print_flags_seq(p, delim, flag, flags);		\
	})

133
134
135
136
137
138
139
140
#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);		\
	})

141
142
143
144
145
146
147
148
#undef TRACE_EVENT
#define TRACE_EVENT(call, proto, args, tstruct, assign, print)		\
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;				\
	struct trace_entry *entry;					\
149
	struct trace_seq *p;						\
150
151
152
153
154
155
156
157
158
159
160
	int ret;							\
									\
	entry = iter->ent;						\
									\
	if (entry->type != event_##call.id) {				\
		WARN_ON_ONCE(1);					\
		return TRACE_TYPE_UNHANDLED;				\
	}								\
									\
	field = (typeof(field))entry;					\
									\
161
	p = &get_cpu_var(ftrace_event_seq);				\
162
	ret = trace_seq_printf(s, #call ": " print);			\
163
	put_cpu();							\
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
	if (!ret)							\
		return TRACE_TYPE_PARTIAL_LINE;				\
									\
	return TRACE_TYPE_HANDLED;					\
}
	
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

/*
 * Setup the showing format of trace point.
 *
 * int
 * ftrace_format_##call(struct trace_seq *s)
 * {
 *	struct ftrace_raw_##call field;
 *	int ret;
 *
 *	ret = trace_seq_printf(s, #type " " #item ";"
 *			       " offset:%u; size:%u;\n",
 *			       offsetof(struct ftrace_raw_##call, item),
 *			       sizeof(field.type));
 *
 * }
 */

#undef TP_STRUCT__entry
#define TP_STRUCT__entry(args...) args

#undef __field
#define __field(type, item)					\
	ret = trace_seq_printf(s, "\tfield:" #type " " #item ";\t"	\
			       "offset:%u;\tsize:%u;\n",		\
			       (unsigned int)offsetof(typeof(field), item), \
			       (unsigned int)sizeof(field.item));	\
	if (!ret)							\
		return 0;

#undef __array
#define __array(type, item, len)						\
	ret = trace_seq_printf(s, "\tfield:" #type " " #item "[" #len "];\t"	\
			       "offset:%u;\tsize:%u;\n",		\
			       (unsigned int)offsetof(typeof(field), item), \
			       (unsigned int)sizeof(field.item));	\
	if (!ret)							\
		return 0;

210
211
#undef __string
#define __string(item, src)						       \
212
213
	ret = trace_seq_printf(s, "\tfield:__str_loc " #item ";\t"	       \
			       "offset:%u;\tsize:%u;\n",		       \
214
215
216
217
218
219
			       (unsigned int)offsetof(typeof(field),	       \
					__str_loc_##item),		       \
			       (unsigned int)sizeof(field.__str_loc_##item));  \
	if (!ret)							       \
		return 0;

220
221
222
223
224
225
226
227
228
229
230
231
232
233
#undef __entry
#define __entry REC

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

#undef TP_fast_assign
#define TP_fast_assign(args...) args

#undef TRACE_EVENT
#define TRACE_EVENT(call, proto, args, tstruct, func, print)		\
static int								\
ftrace_format_##call(struct trace_seq *s)				\
{									\
234
235
	struct ftrace_raw_##call field __attribute__((unused));		\
	int ret = 0;							\
236
237
238
239
240
241
242
243
244
245
246
247
248
249
									\
	tstruct;							\
									\
	trace_seq_printf(s, "\nprint fmt: " print);			\
									\
	return ret;							\
}

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

#undef __field
#define __field(type, item)						\
	ret = trace_define_field(event_call, #type, #item,		\
				 offsetof(typeof(field), item),		\
250
				 sizeof(field.item), is_signed_type(type));	\
251
252
253
254
255
256
257
258
	if (ret)							\
		return ret;

#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),		\
259
				 sizeof(field.item), 0);		\
260
261
262
	if (ret)							\
		return ret;

263
264
265
266
#undef __string
#define __string(item, src)						       \
	ret = trace_define_field(event_call, "__str_loc", #item,	       \
				offsetof(typeof(field), __str_loc_##item),     \
267
				 sizeof(field.__str_loc_##item), 0);
268

269
270
271
272
273
274
275
276
277
#undef TRACE_EVENT
#define TRACE_EVENT(call, proto, args, tstruct, func, print)		\
int									\
ftrace_define_fields_##call(void)					\
{									\
	struct ftrace_raw_##call field;					\
	struct ftrace_event_call *event_call = &event_##call;		\
	int ret;							\
									\
278
279
280
281
282
	__common_field(int, type, 1);					\
	__common_field(unsigned char, flags, 0);			\
	__common_field(unsigned char, preempt_count, 0);		\
	__common_field(int, pid, 1);					\
	__common_field(int, tgid, 1);					\
283
284
285
286
287
288
289
290
									\
	tstruct;							\
									\
	return ret;							\
}

#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)

291
/*
292
 * Stage 4 of the trace events.
293
 *
294
 * Override the macros in <trace/trace_events.h> to include the following:
295
296
297
 *
 * static void ftrace_event_<call>(proto)
 * {
298
 *	event_trace_printk(_RET_IP_, "<call>: " <fmt>);
299
300
301
302
 * }
 *
 * static int ftrace_reg_event_<call>(void)
 * {
303
 *	int ret;
304
 *
305
306
307
308
309
 *	ret = register_trace_<call>(ftrace_event_<call>);
 *	if (!ret)
 *		pr_info("event trace: Could not activate trace point "
 *			"probe to  <call>");
 *	return ret;
310
311
312
313
 * }
 *
 * static void ftrace_unreg_event_<call>(void)
 * {
314
 *	unregister_trace_<call>(ftrace_event_<call>);
315
316
317
 * }
 *
 *
318
 * For those macros defined with TRACE_EVENT:
319
320
321
322
323
 *
 * static struct ftrace_event_call event_<call>;
 *
 * static void ftrace_raw_event_<call>(proto)
 * {
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 *	struct ring_buffer_event *event;
 *	struct ftrace_raw_<call> *entry; <-- defined in stage 1
 *	unsigned long irq_flags;
 *	int pc;
 *
 *	local_save_flags(irq_flags);
 *	pc = preempt_count();
 *
 *	event = trace_current_buffer_lock_reserve(event_<call>.id,
 *				  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
340
 *			__array macros.
341
 *
342
 *	trace_current_buffer_unlock_commit(event, irq_flags, pc);
343
344
345
346
 * }
 *
 * static int ftrace_raw_reg_event_<call>(void)
 * {
347
 *	int ret;
348
 *
349
350
351
352
353
 *	ret = register_trace_<call>(ftrace_raw_event_<call>);
 *	if (!ret)
 *		pr_info("event trace: Could not activate trace point "
 *			"probe to <call>");
 *	return ret;
354
355
356
357
 * }
 *
 * static void ftrace_unreg_event_<call>(void)
 * {
358
 *	unregister_trace_<call>(ftrace_raw_event_<call>);
359
360
361
 * }
 *
 * static struct trace_event ftrace_event_type_<call> = {
362
 *	.trace			= ftrace_raw_output_<call>, <-- stage 2
363
364
365
366
 * };
 *
 * static int ftrace_raw_init_event_<call>(void)
 * {
367
 *	int id;
368
 *
369
370
371
372
373
 *	id = register_ftrace_event(&ftrace_event_type_<call>);
 *	if (!id)
 *		return -ENODEV;
 *	event_<call>.id = id;
 *	return 0;
374
375
376
377
378
 * }
 *
 * static struct ftrace_event_call __used
 * __attribute__((__aligned__(4)))
 * __attribute__((section("_ftrace_events"))) event_<call> = {
379
 *	.name			= "<call>",
380
 *	.system			= "<system>",
381
382
383
 *	.raw_init		= ftrace_raw_init_event_<call>,
 *	.regfunc		= ftrace_reg_event_<call>,
 *	.unregfunc		= ftrace_unreg_event_<call>,
384
 *	.show_format		= ftrace_format_<call>,
385
386
387
388
 * }
 *
 */

389
390
#undef TP_FMT
#define TP_FMT(fmt, args...)	fmt "\n", ##args
391

Peter Zijlstra's avatar
Peter Zijlstra committed
392
393
394
395
396
397
398
399
#ifdef CONFIG_EVENT_PROFILE
#define _TRACE_PROFILE(call, proto, args)				\
static void ftrace_profile_##call(proto)				\
{									\
	extern void perf_tpcounter_event(int);				\
	perf_tpcounter_event(event_##call.id);				\
}									\
									\
400
static int ftrace_profile_enable_##call(struct ftrace_event_call *event_call) \
Peter Zijlstra's avatar
Peter Zijlstra committed
401
402
403
{									\
	int ret = 0;							\
									\
404
	if (!atomic_inc_return(&event_call->profile_count))		\
Peter Zijlstra's avatar
Peter Zijlstra committed
405
406
407
408
409
		ret = register_trace_##call(ftrace_profile_##call);	\
									\
	return ret;							\
}									\
									\
410
static void ftrace_profile_disable_##call(struct ftrace_event_call *event_call)\
Peter Zijlstra's avatar
Peter Zijlstra committed
411
{									\
412
	if (atomic_add_negative(-1, &event_call->profile_count))	\
Peter Zijlstra's avatar
Peter Zijlstra committed
413
414
415
416
417
418
419
420
421
422
423
424
425
		unregister_trace_##call(ftrace_profile_##call);		\
}

#define _TRACE_PROFILE_INIT(call)					\
	.profile_count = ATOMIC_INIT(-1),				\
	.profile_enable = ftrace_profile_enable_##call,			\
	.profile_disable = ftrace_profile_disable_##call,

#else
#define _TRACE_PROFILE(call, proto, args)
#define _TRACE_PROFILE_INIT(call)
#endif

426
427
#undef __entry
#define __entry entry
428

429
430
431
432
433
434
435
#undef __field
#define __field(type, item)

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

#undef __string
436
437
438
#define __string(item, src)						\
	__str_offsets.item = __str_size +				\
			     offsetof(typeof(*entry), __str_data);	\
439
440
441
442
443
444
445
	__str_size += strlen(src) + 1;

#undef __assign_str
#define __assign_str(dst, src)						\
	__entry->__str_loc_##dst = __str_offsets.dst;			\
	strcpy(__get_str(dst), src);

446
#undef TRACE_EVENT
447
#define TRACE_EVENT(call, proto, args, tstruct, assign, print)		\
Peter Zijlstra's avatar
Peter Zijlstra committed
448
_TRACE_PROFILE(call, PARAMS(proto), PARAMS(args))			\
449
450
451
452
453
									\
static struct ftrace_event_call event_##call;				\
									\
static void ftrace_raw_event_##call(proto)				\
{									\
454
455
	struct ftrace_str_offsets_##call __maybe_unused __str_offsets;	\
	struct ftrace_event_call *event_call = &event_##call;		\
456
457
458
	struct ring_buffer_event *event;				\
	struct ftrace_raw_##call *entry;				\
	unsigned long irq_flags;					\
459
	int __str_size = 0;						\
460
461
462
463
464
	int pc;								\
									\
	local_save_flags(irq_flags);					\
	pc = preempt_count();						\
									\
465
466
	tstruct;							\
									\
467
	event = trace_current_buffer_lock_reserve(event_##call.id,	\
468
469
				 sizeof(struct ftrace_raw_##call) + __str_size,\
				 irq_flags, pc);			\
470
471
472
473
	if (!event)							\
		return;							\
	entry	= ring_buffer_event_data(event);			\
									\
474
	{ assign; }							\
475
									\
476
	if (!filter_current_check_discard(event_call, entry, event))	\
477
		trace_nowake_buffer_unlock_commit(event, irq_flags, pc); \
478
479
480
481
482
483
484
}									\
									\
static int ftrace_raw_reg_event_##call(void)				\
{									\
	int ret;							\
									\
	ret = register_trace_##call(ftrace_raw_event_##call);		\
485
	if (ret)							\
486
		pr_info("event trace: Could not activate trace point "	\
487
			"probe to " #call "\n");			\
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
	return ret;							\
}									\
									\
static void ftrace_raw_unreg_event_##call(void)				\
{									\
	unregister_trace_##call(ftrace_raw_event_##call);		\
}									\
									\
static struct trace_event ftrace_event_type_##call = {			\
	.trace			= ftrace_raw_output_##call,		\
};									\
									\
static int ftrace_raw_init_event_##call(void)				\
{									\
	int id;								\
									\
	id = register_ftrace_event(&ftrace_event_type_##call);		\
	if (!id)							\
		return -ENODEV;						\
	event_##call.id = id;						\
508
	INIT_LIST_HEAD(&event_##call.fields);				\
509
	init_preds(&event_##call);					\
510
511
512
513
514
515
	return 0;							\
}									\
									\
static struct ftrace_event_call __used					\
__attribute__((__aligned__(4)))						\
__attribute__((section("_ftrace_events"))) event_##call = {		\
516
	.name			= #call,				\
517
	.system			= __stringify(TRACE_SYSTEM),		\
518
	.event			= &ftrace_event_type_##call,		\
519
	.raw_init		= ftrace_raw_init_event_##call,		\
520
521
	.regfunc		= ftrace_raw_reg_event_##call,		\
	.unregfunc		= ftrace_raw_unreg_event_##call,	\
522
	.show_format		= ftrace_format_##call,			\
523
	.define_fields		= ftrace_define_fields_##call,		\
Peter Zijlstra's avatar
Peter Zijlstra committed
524
	_TRACE_PROFILE_INIT(call)					\
525
}
Peter Zijlstra's avatar
Peter Zijlstra committed
526

527
#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
Peter Zijlstra's avatar
Peter Zijlstra committed
528
529
530
531

#undef _TRACE_PROFILE
#undef _TRACE_PROFILE_INIT