[linux.git] / kernel / trace / trace_entries.h

/*
 * This file defines the trace event structures that go into the ring
 * buffer directly. They are created via macros so that changes for them
 * appear in the format file. Using macros will automate this process.
 *
 * The macro used to create a ftrace data structure is:
 *
 * FTRACE_ENTRY( name, struct_name, id, structure, print )
 *
 * @name: the name used the event name, as well as the name of
 *   the directory that holds the format file.
 *
 * @struct_name: the name of the structure that is created.
 *
 * @id: The event identifier that is used to detect what event
 *    this is from the ring buffer.
 *
 * @structure: the structure layout
 *
 *  - __field(	type,	item	)
 *	  This is equivalent to declaring
 *		type	item;
 *	  in the structure.
 *  - __array(	type,	item,	size	)
 *	  This is equivalent to declaring
 *		type	item[size];
 *	  in the structure.
 *
 *   * for structures within structures, the format of the internal
 *	structure is laid out. This allows the internal structure
 *	to be deciphered for the format file. Although these macros
 *	may become out of sync with the internal structure, they
 *	will create a compile error if it happens. Since the
 *	internel structures are just tracing helpers, this is not
 *	an issue.
 *
 *	When an internal structure is used, it should use:
 *
 *	__field_struct(	type,	item	)
 *
 *	instead of __field. This will prevent it from being shown in
 *	the output file. The fields in the structure should use.
 *
 *	__field_desc(	type,	container,	item		)
 *	__array_desc(	type,	container,	item,	len	)
 *
 *	type, item and len are the same as __field and __array, but
 *	container is added. This is the name of the item in
 *	__field_struct that this is describing.
 *
 *
 * @print: the print format shown to users in the format file.
 */

/*
 * Function trace entry - function address and parent function address:
 */
FTRACE_ENTRY_REG(function, ftrace_entry,

	TRACE_FN,

	F_STRUCT(
		__field(	unsigned long,	ip		)
		__field(	unsigned long,	parent_ip	)
	),

	F_printk(" %lx <-- %lx", __entry->ip, __entry->parent_ip),

	FILTER_TRACE_FN,

	perf_ftrace_event_register
);

/* Function call entry */
FTRACE_ENTRY(funcgraph_entry, ftrace_graph_ent_entry,

	TRACE_GRAPH_ENT,

	F_STRUCT(
		__field_struct(	struct ftrace_graph_ent,	graph_ent	)
		__field_desc(	unsigned long,	graph_ent,	func		)
		__field_desc(	int,		graph_ent,	depth		)
	),

	F_printk("--> %lx (%d)", __entry->func, __entry->depth),

	FILTER_OTHER
);

/* Function return entry */
FTRACE_ENTRY(funcgraph_exit, ftrace_graph_ret_entry,

	TRACE_GRAPH_RET,

	F_STRUCT(
		__field_struct(	struct ftrace_graph_ret,	ret	)
		__field_desc(	unsigned long,	ret,		func	)
		__field_desc(	unsigned long long, ret,	calltime)
		__field_desc(	unsigned long long, ret,	rettime	)
		__field_desc(	unsigned long,	ret,		overrun	)
		__field_desc(	int,		ret,		depth	)
	),

	F_printk("<-- %lx (%d) (start: %llx  end: %llx) over: %d",
		 __entry->func, __entry->depth,
		 __entry->calltime, __entry->rettime,
		 __entry->depth),

	FILTER_OTHER
);

/*
 * Context switch trace entry - which task (and prio) we switched from/to:
 *
 * This is used for both wakeup and context switches. We only want
 * to create one structure, but we need two outputs for it.
 */
#define FTRACE_CTX_FIELDS					\
	__field(	unsigned int,	prev_pid	)	\
	__field(	unsigned int,	next_pid	)	\
	__field(	unsigned int,	next_cpu	)       \
	__field(	unsigned char,	prev_prio	)	\
	__field(	unsigned char,	prev_state	)	\
	__field(	unsigned char,	next_prio	)	\
	__field(	unsigned char,	next_state	)

FTRACE_ENTRY(context_switch, ctx_switch_entry,

	TRACE_CTX,

	F_STRUCT(
		FTRACE_CTX_FIELDS
	),

	F_printk("%u:%u:%u  ==> %u:%u:%u [%03u]",
		 __entry->prev_pid, __entry->prev_prio, __entry->prev_state,
		 __entry->next_pid, __entry->next_prio, __entry->next_state,
		 __entry->next_cpu),

	FILTER_OTHER
);

/*
 * FTRACE_ENTRY_DUP only creates the format file, it will not
 *  create another structure.
 */
FTRACE_ENTRY_DUP(wakeup, ctx_switch_entry,

	TRACE_WAKE,

	F_STRUCT(
		FTRACE_CTX_FIELDS
	),

	F_printk("%u:%u:%u  ==+ %u:%u:%u [%03u]",
		 __entry->prev_pid, __entry->prev_prio, __entry->prev_state,
		 __entry->next_pid, __entry->next_prio, __entry->next_state,
		 __entry->next_cpu),

	FILTER_OTHER
);

/*
 * Stack-trace entry:
 */

#define FTRACE_STACK_ENTRIES	8

#ifndef CONFIG_64BIT
# define IP_FMT "%08lx"
#else
# define IP_FMT "%016lx"
#endif

FTRACE_ENTRY(kernel_stack, stack_entry,

	TRACE_STACK,

	F_STRUCT(
		__field(	int,		size	)
		__dynamic_array(unsigned long,	caller	)
	),

	F_printk("\t=> (" IP_FMT ")\n\t=> (" IP_FMT ")\n\t=> (" IP_FMT ")\n"
		 "\t=> (" IP_FMT ")\n\t=> (" IP_FMT ")\n\t=> (" IP_FMT ")\n"
		 "\t=> (" IP_FMT ")\n\t=> (" IP_FMT ")\n",
		 __entry->caller[0], __entry->caller[1], __entry->caller[2],
		 __entry->caller[3], __entry->caller[4], __entry->caller[5],
		 __entry->caller[6], __entry->caller[7]),

	FILTER_OTHER
);

FTRACE_ENTRY(user_stack, userstack_entry,

	TRACE_USER_STACK,

	F_STRUCT(
		__field(	unsigned int,	tgid	)
		__array(	unsigned long,	caller, FTRACE_STACK_ENTRIES	)
	),

	F_printk("\t=> (" IP_FMT ")\n\t=> (" IP_FMT ")\n\t=> (" IP_FMT ")\n"
		 "\t=> (" IP_FMT ")\n\t=> (" IP_FMT ")\n\t=> (" IP_FMT ")\n"
		 "\t=> (" IP_FMT ")\n\t=> (" IP_FMT ")\n",
		 __entry->caller[0], __entry->caller[1], __entry->caller[2],
		 __entry->caller[3], __entry->caller[4], __entry->caller[5],
		 __entry->caller[6], __entry->caller[7]),

	FILTER_OTHER
);

/*
 * trace_printk entry:
 */
FTRACE_ENTRY(bprint, bprint_entry,

	TRACE_BPRINT,

	F_STRUCT(
		__field(	unsigned long,	ip	)
		__field(	const char *,	fmt	)
		__dynamic_array(	u32,	buf	)
	),

	F_printk("%ps: %s",
		 (void *)__entry->ip, __entry->fmt),

	FILTER_OTHER
);

FTRACE_ENTRY(print, print_entry,

	TRACE_PRINT,

	F_STRUCT(
		__field(	unsigned long,	ip	)
		__dynamic_array(	char,	buf	)
	),

	F_printk("%ps: %s",
		 (void *)__entry->ip, __entry->buf),

	FILTER_OTHER
);

FTRACE_ENTRY(bputs, bputs_entry,

	TRACE_BPUTS,

	F_STRUCT(
		__field(	unsigned long,	ip	)
		__field(	const char *,	str	)
	),

	F_printk("%ps: %s",
		 (void *)__entry->ip, __entry->str),

	FILTER_OTHER
);

FTRACE_ENTRY(mmiotrace_rw, trace_mmiotrace_rw,

	TRACE_MMIO_RW,

	F_STRUCT(
		__field_struct(	struct mmiotrace_rw,	rw	)
		__field_desc(	resource_size_t, rw,	phys	)
		__field_desc(	unsigned long,	rw,	value	)
		__field_desc(	unsigned long,	rw,	pc	)
		__field_desc(	int, 		rw,	map_id	)
		__field_desc(	unsigned char,	rw,	opcode	)
		__field_desc(	unsigned char,	rw,	width	)
	),

	F_printk("%lx %lx %lx %d %x %x",
		 (unsigned long)__entry->phys, __entry->value, __entry->pc,
		 __entry->map_id, __entry->opcode, __entry->width),

	FILTER_OTHER
);

FTRACE_ENTRY(mmiotrace_map, trace_mmiotrace_map,

	TRACE_MMIO_MAP,

	F_STRUCT(
		__field_struct(	struct mmiotrace_map,	map	)
		__field_desc(	resource_size_t, map,	phys	)
		__field_desc(	unsigned long,	map,	virt	)
		__field_desc(	unsigned long,	map,	len	)
		__field_desc(	int, 		map,	map_id	)
		__field_desc(	unsigned char,	map,	opcode	)
	),

	F_printk("%lx %lx %lx %d %x",
		 (unsigned long)__entry->phys, __entry->virt, __entry->len,
		 __entry->map_id, __entry->opcode),

	FILTER_OTHER
);


#define TRACE_FUNC_SIZE 30
#define TRACE_FILE_SIZE 20

FTRACE_ENTRY(branch, trace_branch,

	TRACE_BRANCH,

	F_STRUCT(
		__field(	unsigned int,	line				)
		__array(	char,		func,	TRACE_FUNC_SIZE+1	)
		__array(	char,		file,	TRACE_FILE_SIZE+1	)
		__field(	char,		correct				)
	),

	F_printk("%u:%s:%s (%u)",
		 __entry->line,
		 __entry->func, __entry->file, __entry->correct),

	FILTER_OTHER
);
Commit	Line	Data
0a1c49db SR	1	/*
	2	* This file defines the trace event structures that go into the ring
	3	* buffer directly. They are created via macros so that changes for them
	4	* appear in the format file. Using macros will automate this process.
	5	*
	6	* The macro used to create a ftrace data structure is:
	7	*
	8	* FTRACE_ENTRY( name, struct_name, id, structure, print )
	9	*
	10	* @name: the name used the event name, as well as the name of
	11	* the directory that holds the format file.
	12	*
	13	* @struct_name: the name of the structure that is created.
	14	*
	15	* @id: The event identifier that is used to detect what event
	16	* this is from the ring buffer.
	17	*
	18	* @structure: the structure layout
	19	*
	20	* - __field( type, item )
	21	* This is equivalent to declaring
	22	* type item;
	23	* in the structure.
	24	* - __array( type, item, size )
	25	* This is equivalent to declaring
	26	* type item[size];
	27	* in the structure.
	28	*
d7315094	29	* * for structures within structures, the format of the internal
25985edc	30	* structure is laid out. This allows the internal structure
d7315094 SR	31	* to be deciphered for the format file. Although these macros
	32	* may become out of sync with the internal structure, they
	33	* will create a compile error if it happens. Since the
	34	* internel structures are just tracing helpers, this is not
	35	* an issue.
	36	*
	37	* When an internal structure is used, it should use:
	38	*
	39	* __field_struct( type, item )
	40	*
	41	* instead of __field. This will prevent it from being shown in
	42	* the output file. The fields in the structure should use.
	43	*
	44	* __field_desc( type, container, item )
	45	* __array_desc( type, container, item, len )
	46	*
	47	* type, item and len are the same as __field and __array, but
	48	* container is added. This is the name of the item in
	49	* __field_struct that this is describing.
	50	*
	51	*
0a1c49db SR	52	* @print: the print format shown to users in the format file.
	53	*/
	54
	55	/*
b595076a	56	* Function trace entry - function address and parent function address:
0a1c49db	57	*/
ced39002	58	FTRACE_ENTRY_REG(function, ftrace_entry,
0a1c49db SR	59
	60	TRACE_FN,
	61
	62	F_STRUCT(
	63	__field( unsigned long, ip )
	64	__field( unsigned long, parent_ip )
	65	),
	66
ced39002 JO	67	F_printk(" %lx <-- %lx", __entry->ip, __entry->parent_ip),
ced39002 JO	68
02aa3162 JO	69	FILTER_TRACE_FN,
02aa3162 JO	70
ced39002	71	perf_ftrace_event_register
0a1c49db SR	72	);
	73
	74	/* Function call entry */
	75	FTRACE_ENTRY(funcgraph_entry, ftrace_graph_ent_entry,
	76
	77	TRACE_GRAPH_ENT,
	78
	79	F_STRUCT(
d7315094 SR	80	__field_struct( struct ftrace_graph_ent, graph_ent )
	81	__field_desc( unsigned long, graph_ent, func )
	82	__field_desc( int, graph_ent, depth )
0a1c49db SR	83	),
0a1c49db SR	84
02aa3162 JO	85	F_printk("--> %lx (%d)", __entry->func, __entry->depth),
	86
	87	FILTER_OTHER
0a1c49db SR	88	);
	89
	90	/* Function return entry */
	91	FTRACE_ENTRY(funcgraph_exit, ftrace_graph_ret_entry,
	92
	93	TRACE_GRAPH_RET,
	94
	95	F_STRUCT(
d7315094 SR	96	__field_struct( struct ftrace_graph_ret, ret )
	97	__field_desc( unsigned long, ret, func )
	98	__field_desc( unsigned long long, ret, calltime)
	99	__field_desc( unsigned long long, ret, rettime )
	100	__field_desc( unsigned long, ret, overrun )
	101	__field_desc( int, ret, depth )
0a1c49db SR	102	),
	103
	104	F_printk("<-- %lx (%d) (start: %llx end: %llx) over: %d",
	105	__entry->func, __entry->depth,
c16de8fd	106	__entry->calltime, __entry->rettime,
02aa3162 JO	107	__entry->depth),
	108
	109	FILTER_OTHER
0a1c49db SR	110	);
	111
	112	/*
	113	* Context switch trace entry - which task (and prio) we switched from/to:
	114	*
	115	* This is used for both wakeup and context switches. We only want
	116	* to create one structure, but we need two outputs for it.
	117	*/
	118	#define FTRACE_CTX_FIELDS \
	119	__field( unsigned int, prev_pid ) \
140e4f2d DS	120	__field( unsigned int, next_pid ) \
140e4f2d DS	121	__field( unsigned int, next_cpu ) \
0a1c49db SR	122	__field( unsigned char, prev_prio ) \
0a1c49db SR	123	__field( unsigned char, prev_state ) \
0a1c49db	124	__field( unsigned char, next_prio ) \
140e4f2d	125	__field( unsigned char, next_state )
0a1c49db	126
0a1c49db SR	127	FTRACE_ENTRY(context_switch, ctx_switch_entry,
	128
	129	TRACE_CTX,
	130
	131	F_STRUCT(
	132	FTRACE_CTX_FIELDS
	133	),
	134
c16de8fd	135	F_printk("%u:%u:%u ==> %u:%u:%u [%03u]",
0a1c49db SR	136	__entry->prev_pid, __entry->prev_prio, __entry->prev_state,
0a1c49db SR	137	__entry->next_pid, __entry->next_prio, __entry->next_state,
02aa3162 JO	138	__entry->next_cpu),
	139
	140	FILTER_OTHER
0a1c49db SR	141	);
	142
	143	/*
	144	* FTRACE_ENTRY_DUP only creates the format file, it will not
	145	* create another structure.
	146	*/
	147	FTRACE_ENTRY_DUP(wakeup, ctx_switch_entry,
	148
	149	TRACE_WAKE,
	150
	151	F_STRUCT(
	152	FTRACE_CTX_FIELDS
	153	),
	154
	155	F_printk("%u:%u:%u ==+ %u:%u:%u [%03u]",
	156	__entry->prev_pid, __entry->prev_prio, __entry->prev_state,
	157	__entry->next_pid, __entry->next_prio, __entry->next_state,
02aa3162 JO	158	__entry->next_cpu),
	159
	160	FILTER_OTHER
0a1c49db SR	161	);
0a1c49db SR	162
0a1c49db SR	163	/*
	164	* Stack-trace entry:
	165	*/
	166
	167	#define FTRACE_STACK_ENTRIES 8
	168
01de982a WM	169	#ifndef CONFIG_64BIT
	170	# define IP_FMT "%08lx"
	171	#else
	172	# define IP_FMT "%016lx"
	173	#endif
	174
0a1c49db SR	175	FTRACE_ENTRY(kernel_stack, stack_entry,
	176
	177	TRACE_STACK,
	178
	179	F_STRUCT(
4a9bd3f1 SR	180	__field( int, size )
4a9bd3f1 SR	181	__dynamic_array(unsigned long, caller )
0a1c49db SR	182	),
0a1c49db SR	183
01de982a WM	184	F_printk("\t=> (" IP_FMT ")\n\t=> (" IP_FMT ")\n\t=> (" IP_FMT ")\n"
	185	"\t=> (" IP_FMT ")\n\t=> (" IP_FMT ")\n\t=> (" IP_FMT ")\n"
	186	"\t=> (" IP_FMT ")\n\t=> (" IP_FMT ")\n",
0a1c49db SR	187	__entry->caller[0], __entry->caller[1], __entry->caller[2],
0a1c49db SR	188	__entry->caller[3], __entry->caller[4], __entry->caller[5],
02aa3162 JO	189	__entry->caller[6], __entry->caller[7]),
	190
	191	FILTER_OTHER
0a1c49db SR	192	);
	193
	194	FTRACE_ENTRY(user_stack, userstack_entry,
	195
	196	TRACE_USER_STACK,
	197
	198	F_STRUCT(
	199	__field( unsigned int, tgid )
	200	__array( unsigned long, caller, FTRACE_STACK_ENTRIES )
	201	),
	202
01de982a WM	203	F_printk("\t=> (" IP_FMT ")\n\t=> (" IP_FMT ")\n\t=> (" IP_FMT ")\n"
	204	"\t=> (" IP_FMT ")\n\t=> (" IP_FMT ")\n\t=> (" IP_FMT ")\n"
	205	"\t=> (" IP_FMT ")\n\t=> (" IP_FMT ")\n",
0a1c49db SR	206	__entry->caller[0], __entry->caller[1], __entry->caller[2],
0a1c49db SR	207	__entry->caller[3], __entry->caller[4], __entry->caller[5],
02aa3162 JO	208	__entry->caller[6], __entry->caller[7]),
	209
	210	FILTER_OTHER
0a1c49db SR	211	);
	212
	213	/*
	214	* trace_printk entry:
	215	*/
	216	FTRACE_ENTRY(bprint, bprint_entry,
	217
	218	TRACE_BPRINT,
	219
	220	F_STRUCT(
	221	__field( unsigned long, ip )
	222	__field( const char *, fmt )
	223	__dynamic_array( u32, buf )
	224	),
	225
bbedb179	226	F_printk("%ps: %s",
09ae7234	227	(void *)__entry->ip, __entry->fmt),
02aa3162 JO	228
02aa3162 JO	229	FILTER_OTHER
0a1c49db SR	230	);
	231
	232	FTRACE_ENTRY(print, print_entry,
	233
	234	TRACE_PRINT,
	235
	236	F_STRUCT(
	237	__field( unsigned long, ip )
	238	__dynamic_array( char, buf )
	239	),
	240
bbedb179	241	F_printk("%ps: %s",
09ae7234 SRRH	242	(void *)__entry->ip, __entry->buf),
	243
	244	FILTER_OTHER
	245	);
	246
	247	FTRACE_ENTRY(bputs, bputs_entry,
	248
	249	TRACE_BPUTS,
	250
	251	F_STRUCT(
	252	__field( unsigned long, ip )
	253	__field( const char *, str )
	254	),
	255
bbedb179	256	F_printk("%ps: %s",
09ae7234	257	(void *)__entry->ip, __entry->str),
02aa3162 JO	258
02aa3162 JO	259	FILTER_OTHER
0a1c49db SR	260	);
	261
	262	FTRACE_ENTRY(mmiotrace_rw, trace_mmiotrace_rw,
	263
	264	TRACE_MMIO_RW,
	265
	266	F_STRUCT(
d7315094 SR	267	__field_struct( struct mmiotrace_rw, rw )
	268	__field_desc( resource_size_t, rw, phys )
	269	__field_desc( unsigned long, rw, value )
	270	__field_desc( unsigned long, rw, pc )
	271	__field_desc( int, rw, map_id )
	272	__field_desc( unsigned char, rw, opcode )
	273	__field_desc( unsigned char, rw, width )
0a1c49db SR	274	),
0a1c49db SR	275
c16de8fd LZ	276	F_printk("%lx %lx %lx %d %x %x",
c16de8fd LZ	277	(unsigned long)__entry->phys, __entry->value, __entry->pc,
02aa3162 JO	278	__entry->map_id, __entry->opcode, __entry->width),
	279
	280	FILTER_OTHER
0a1c49db SR	281	);
	282
	283	FTRACE_ENTRY(mmiotrace_map, trace_mmiotrace_map,
	284
	285	TRACE_MMIO_MAP,
	286
	287	F_STRUCT(
d7315094 SR	288	__field_struct( struct mmiotrace_map, map )
	289	__field_desc( resource_size_t, map, phys )
	290	__field_desc( unsigned long, map, virt )
	291	__field_desc( unsigned long, map, len )
	292	__field_desc( int, map, map_id )
	293	__field_desc( unsigned char, map, opcode )
0a1c49db SR	294	),
0a1c49db SR	295
c16de8fd LZ	296	F_printk("%lx %lx %lx %d %x",
c16de8fd LZ	297	(unsigned long)__entry->phys, __entry->virt, __entry->len,
02aa3162 JO	298	__entry->map_id, __entry->opcode),
	299
	300	FILTER_OTHER
0a1c49db SR	301	);
0a1c49db SR	302
0a1c49db SR	303
	304	#define TRACE_FUNC_SIZE 30
	305	#define TRACE_FILE_SIZE 20
	306
	307	FTRACE_ENTRY(branch, trace_branch,
	308
	309	TRACE_BRANCH,
	310
	311	F_STRUCT(
	312	__field( unsigned int, line )
	313	__array( char, func, TRACE_FUNC_SIZE+1 )
	314	__array( char, file, TRACE_FILE_SIZE+1 )
	315	__field( char, correct )
	316	),
	317
	318	F_printk("%u:%s:%s (%u)",
	319	__entry->line,
02aa3162 JO	320	__entry->func, __entry->file, __entry->correct),
	321
	322	FILTER_OTHER
0a1c49db SR	323	);
0a1c49db SR	324