Linux Audio

Check our new training course

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