1 // SPDX-License-Identifier: GPL-2.0
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.
7 * The macro used to create a ftrace data structure is:
9 * FTRACE_ENTRY( name, struct_name, id, structure, print )
11 * @name: the name used the event name, as well as the name of
12 * the directory that holds the format file.
14 * @struct_name: the name of the structure that is created.
16 * @id: The event identifier that is used to detect what event
17 * this is from the ring buffer.
19 * @structure: the structure layout
21 * - __field( type, item )
22 * This is equivalent to declaring
25 * - __array( type, item, size )
26 * This is equivalent to declaring
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 * internal structures are just tracing helpers, this is not
38 * When an internal structure is used, it should use:
40 * __field_struct( type, item )
42 * instead of __field. This will prevent it from being shown in
43 * the output file. The fields in the structure should use.
45 * __field_desc( type, container, item )
46 * __array_desc( type, container, item, len )
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.
53 * @print: the print format shown to users in the format file.
57 * Function trace entry - function address and parent function address:
59 FTRACE_ENTRY_REG(function
, ftrace_entry
,
64 __field_fn( unsigned long, ip
)
65 __field_fn( unsigned long, parent_ip
)
68 F_printk(" %ps <-- %ps",
69 (void *)__entry
->ip
, (void *)__entry
->parent_ip
),
71 perf_ftrace_event_register
74 /* Function call entry */
75 FTRACE_ENTRY_PACKED(funcgraph_entry
, ftrace_graph_ent_entry
,
80 __field_struct( struct ftrace_graph_ent
, graph_ent
)
81 __field_packed( unsigned long, graph_ent
, func
)
82 __field_packed( int, graph_ent
, depth
)
85 F_printk("--> %ps (%d)", (void *)__entry
->func
, __entry
->depth
)
88 #ifdef CONFIG_FUNCTION_GRAPH_RETADDR
90 /* Function call entry with a return address */
91 FTRACE_ENTRY_PACKED(fgraph_retaddr_entry
, fgraph_retaddr_ent_entry
,
93 TRACE_GRAPH_RETADDR_ENT
,
96 __field_struct( struct fgraph_retaddr_ent
, graph_ent
)
97 __field_packed( unsigned long, graph_ent
, func
)
98 __field_packed( int, graph_ent
, depth
)
99 __field_packed( unsigned long, graph_ent
, retaddr
)
102 F_printk("--> %ps (%d) <- %ps", (void *)__entry
->func
, __entry
->depth
,
103 (void *)__entry
->retaddr
)
108 #ifndef fgraph_retaddr_ent_entry
109 #define fgraph_retaddr_ent_entry ftrace_graph_ent_entry
114 #ifdef CONFIG_FUNCTION_GRAPH_RETVAL
116 /* Function return entry */
117 FTRACE_ENTRY_PACKED(funcgraph_exit
, ftrace_graph_ret_entry
,
122 __field_struct( struct ftrace_graph_ret
, ret
)
123 __field_packed( unsigned long, ret
, func
)
124 __field_packed( unsigned long, ret
, retval
)
125 __field_packed( int, ret
, depth
)
126 __field_packed( unsigned int, ret
, overrun
)
127 __field_packed( unsigned long long, ret
, calltime
)
128 __field_packed( unsigned long long, ret
, rettime
)
131 F_printk("<-- %ps (%d) (start: %llx end: %llx) over: %d retval: %lx",
132 (void *)__entry
->func
, __entry
->depth
,
133 __entry
->calltime
, __entry
->rettime
,
134 __entry
->depth
, __entry
->retval
)
139 /* Function return entry */
140 FTRACE_ENTRY_PACKED(funcgraph_exit
, ftrace_graph_ret_entry
,
145 __field_struct( struct ftrace_graph_ret
, ret
)
146 __field_packed( unsigned long, ret
, func
)
147 __field_packed( int, ret
, depth
)
148 __field_packed( unsigned int, ret
, overrun
)
149 __field_packed( unsigned long long, ret
, calltime
)
150 __field_packed( unsigned long long, ret
, rettime
)
153 F_printk("<-- %ps (%d) (start: %llx end: %llx) over: %d",
154 (void *)__entry
->func
, __entry
->depth
,
155 __entry
->calltime
, __entry
->rettime
,
162 * Context switch trace entry - which task (and prio) we switched from/to:
164 * This is used for both wakeup and context switches. We only want
165 * to create one structure, but we need two outputs for it.
167 #define FTRACE_CTX_FIELDS \
168 __field( unsigned int, prev_pid ) \
169 __field( unsigned int, next_pid ) \
170 __field( unsigned int, next_cpu ) \
171 __field( unsigned char, prev_prio ) \
172 __field( unsigned char, prev_state ) \
173 __field( unsigned char, next_prio ) \
174 __field( unsigned char, next_state )
176 FTRACE_ENTRY(context_switch
, ctx_switch_entry
,
184 F_printk("%u:%u:%u ==> %u:%u:%u [%03u]",
185 __entry
->prev_pid
, __entry
->prev_prio
, __entry
->prev_state
,
186 __entry
->next_pid
, __entry
->next_prio
, __entry
->next_state
,
191 * FTRACE_ENTRY_DUP only creates the format file, it will not
192 * create another structure.
194 FTRACE_ENTRY_DUP(wakeup
, ctx_switch_entry
,
202 F_printk("%u:%u:%u ==+ %u:%u:%u [%03u]",
203 __entry
->prev_pid
, __entry
->prev_prio
, __entry
->prev_state
,
204 __entry
->next_pid
, __entry
->next_prio
, __entry
->next_state
,
212 #define FTRACE_STACK_ENTRIES 8
214 FTRACE_ENTRY(kernel_stack
, stack_entry
,
220 __stack_array( unsigned long, caller
, FTRACE_STACK_ENTRIES
, size
)
223 F_printk("\t=> %ps\n\t=> %ps\n\t=> %ps\n"
224 "\t=> %ps\n\t=> %ps\n\t=> %ps\n"
225 "\t=> %ps\n\t=> %ps\n",
226 (void *)__entry
->caller
[0], (void *)__entry
->caller
[1],
227 (void *)__entry
->caller
[2], (void *)__entry
->caller
[3],
228 (void *)__entry
->caller
[4], (void *)__entry
->caller
[5],
229 (void *)__entry
->caller
[6], (void *)__entry
->caller
[7])
232 FTRACE_ENTRY(user_stack
, userstack_entry
,
237 __field( unsigned int, tgid
)
238 __array( unsigned long, caller
, FTRACE_STACK_ENTRIES
)
241 F_printk("\t=> %ps\n\t=> %ps\n\t=> %ps\n"
242 "\t=> %ps\n\t=> %ps\n\t=> %ps\n"
243 "\t=> %ps\n\t=> %ps\n",
244 (void *)__entry
->caller
[0], (void *)__entry
->caller
[1],
245 (void *)__entry
->caller
[2], (void *)__entry
->caller
[3],
246 (void *)__entry
->caller
[4], (void *)__entry
->caller
[5],
247 (void *)__entry
->caller
[6], (void *)__entry
->caller
[7])
251 * trace_printk entry:
253 FTRACE_ENTRY(bprint
, bprint_entry
,
258 __field( unsigned long, ip
)
259 __field( const char *, fmt
)
260 __dynamic_array( u32
, buf
)
264 (void *)__entry
->ip
, __entry
->fmt
)
267 FTRACE_ENTRY_REG(print
, print_entry
,
272 __field( unsigned long, ip
)
273 __dynamic_array( char, buf
)
277 (void *)__entry
->ip
, __entry
->buf
),
279 ftrace_event_register
282 FTRACE_ENTRY(raw_data
, raw_data_entry
,
287 __field( unsigned int, id
)
288 __dynamic_array( char, buf
)
291 F_printk("id:%04x %08x",
292 __entry
->id
, (int)__entry
->buf
[0])
295 FTRACE_ENTRY(bputs
, bputs_entry
,
300 __field( unsigned long, ip
)
301 __field( const char *, str
)
305 (void *)__entry
->ip
, __entry
->str
)
308 FTRACE_ENTRY(mmiotrace_rw
, trace_mmiotrace_rw
,
313 __field_struct( struct mmiotrace_rw
, rw
)
314 __field_desc( resource_size_t
, rw
, phys
)
315 __field_desc( unsigned long, rw
, value
)
316 __field_desc( unsigned long, rw
, pc
)
317 __field_desc( int, rw
, map_id
)
318 __field_desc( unsigned char, rw
, opcode
)
319 __field_desc( unsigned char, rw
, width
)
322 F_printk("%lx %lx %lx %d %x %x",
323 (unsigned long)__entry
->phys
, __entry
->value
, __entry
->pc
,
324 __entry
->map_id
, __entry
->opcode
, __entry
->width
)
327 FTRACE_ENTRY(mmiotrace_map
, trace_mmiotrace_map
,
332 __field_struct( struct mmiotrace_map
, map
)
333 __field_desc( resource_size_t
, map
, phys
)
334 __field_desc( unsigned long, map
, virt
)
335 __field_desc( unsigned long, map
, len
)
336 __field_desc( int, map
, map_id
)
337 __field_desc( unsigned char, map
, opcode
)
340 F_printk("%lx %lx %lx %d %x",
341 (unsigned long)__entry
->phys
, __entry
->virt
, __entry
->len
,
342 __entry
->map_id
, __entry
->opcode
)
346 #define TRACE_FUNC_SIZE 30
347 #define TRACE_FILE_SIZE 20
349 FTRACE_ENTRY(branch
, trace_branch
,
354 __field( unsigned int, line
)
355 __array( char, func
, TRACE_FUNC_SIZE
+1 )
356 __array( char, file
, TRACE_FILE_SIZE
+1 )
357 __field( char, correct
)
358 __field( char, constant
)
361 F_printk("%u:%s:%s (%u)%s",
363 __entry
->func
, __entry
->file
, __entry
->correct
,
364 __entry
->constant
? " CONSTANT" : "")
368 FTRACE_ENTRY(hwlat
, hwlat_entry
,
373 __field( u64
, duration
)
374 __field( u64
, outer_duration
)
375 __field( u64
, nmi_total_ts
)
376 __field_struct( struct timespec64
, timestamp
)
377 __field_desc( s64
, timestamp
, tv_sec
)
378 __field_desc( long, timestamp
, tv_nsec
)
379 __field( unsigned int, nmi_count
)
380 __field( unsigned int, seqnum
)
381 __field( unsigned int, count
)
384 F_printk("cnt:%u\tts:%010llu.%010lu\tinner:%llu\touter:%llu\tcount:%d\tnmi-ts:%llu\tnmi-count:%u\n",
389 __entry
->outer_duration
,
391 __entry
->nmi_total_ts
,
395 #define FUNC_REPEATS_GET_DELTA_TS(entry) \
396 (((u64)(entry)->top_delta_ts << 32) | (entry)->bottom_delta_ts) \
398 FTRACE_ENTRY(func_repeats, func_repeats_entry,
403 __field( unsigned long, ip
)
404 __field( unsigned long, parent_ip
)
405 __field( u16
, count
)
406 __field( u16
, top_delta_ts
)
407 __field( u32
, bottom_delta_ts
)
410 F_printk(" %ps <-%ps\t(repeats:%u delta: -%llu)",
412 (void *)__entry
->parent_ip
,
414 FUNC_REPEATS_GET_DELTA_TS(__entry
))
417 FTRACE_ENTRY(osnoise
, osnoise_entry
,
422 __field( u64
, noise
)
423 __field( u64
, runtime
)
424 __field( u64
, max_sample
)
425 __field( unsigned int, hw_count
)
426 __field( unsigned int, nmi_count
)
427 __field( unsigned int, irq_count
)
428 __field( unsigned int, softirq_count
)
429 __field( unsigned int, thread_count
)
432 F_printk("noise:%llu\tmax_sample:%llu\thw:%u\tnmi:%u\tirq:%u\tsoftirq:%u\tthread:%u\n",
438 __entry
->softirq_count
,
439 __entry
->thread_count
)
442 FTRACE_ENTRY(timerlat
, timerlat_entry
,
447 __field( unsigned int, seqnum
)
448 __field( int, context
)
449 __field( u64
, timer_latency
)
452 F_printk("seq:%u\tcontext:%d\ttimer_latency:%llu\n",
455 __entry
->timer_latency
)