xref: /openbmc/qemu/trace-events (revision ffe98631)
1# See docs/devel/tracing.rst for syntax documentation.
2#
3# This file is processed by the tracetool script during the build.
4#
5# To add a new trace event:
6#
7# 1. Choose a name for the trace event.  Declare its arguments and format
8#    string.
9#
10# 2. Call the trace event from code using trace_##name, e.g. multiwrite_cb() ->
11#    trace_multiwrite_cb().  The source file must #include "trace.h".
12#
13# Format of a trace event:
14#
15# [disable] <name>(<type1> <arg1>[, <type2> <arg2>] ...) "<format-string>"
16#
17# Example: g_malloc(size_t size) "size %zu"
18#
19# The "disable" keyword will build without the trace event.
20#
21# The <name> must be a valid as a C function name.
22#
23# Types should be standard C types.  Use void * for pointers because the trace
24# system may not have the necessary headers included.
25#
26# The <format-string> should be a sprintf()-compatible format string.
27
28# cpu.c
29breakpoint_insert(int cpu_index, uint64_t pc, int flags) "cpu=%d pc=0x%" PRIx64 " flags=0x%x"
30breakpoint_remove(int cpu_index, uint64_t pc, int flags) "cpu=%d pc=0x%" PRIx64 " flags=0x%x"
31breakpoint_singlestep(int cpu_index, int enabled) "cpu=%d enable=%d"
32
33# dma-helpers.c
34dma_blk_io(void *dbs, void *bs, int64_t offset, bool to_dev) "dbs=%p bs=%p offset=%" PRId64 " to_dev=%d"
35dma_aio_cancel(void *dbs) "dbs=%p"
36dma_complete(void *dbs, int ret, void *cb) "dbs=%p ret=%d cb=%p"
37dma_blk_cb(void *dbs, int ret) "dbs=%p ret=%d"
38dma_map_wait(void *dbs) "dbs=%p"
39
40# exec.c
41find_ram_offset(uint64_t size, uint64_t offset) "size: 0x%" PRIx64 " @ 0x%" PRIx64
42find_ram_offset_loop(uint64_t size, uint64_t candidate, uint64_t offset, uint64_t next, uint64_t mingap) "trying size: 0x%" PRIx64 " @ 0x%" PRIx64 ", offset: 0x%" PRIx64" next: 0x%" PRIx64 " mingap: 0x%" PRIx64
43ram_block_discard_range(const char *rbname, void *hva, size_t length, bool need_madvise, bool need_fallocate, int ret) "%s@%p + 0x%zx: madvise: %d fallocate: %d ret: %d"
44
45# job.c
46job_state_transition(void *job,  int ret, const char *legal, const char *s0, const char *s1) "job %p (ret: %d) attempting %s transition (%s-->%s)"
47job_apply_verb(void *job, const char *state, const char *verb, const char *legal) "job %p in state %s; applying verb %s (%s)"
48job_completed(void *job, int ret) "job %p ret %d"
49
50# job-qmp.c
51qmp_job_cancel(void *job) "job %p"
52qmp_job_pause(void *job) "job %p"
53qmp_job_resume(void *job) "job %p"
54qmp_job_complete(void *job) "job %p"
55qmp_job_finalize(void *job) "job %p"
56qmp_job_dismiss(void *job) "job %p"
57
58
59### Guest events, keep at bottom
60
61
62## vCPU
63
64# trace/control-target.c
65
66# Hot-plug a new virtual (guest) CPU
67#
68# Mode: user, softmmu
69# Targets: all
70vcpu guest_cpu_enter(void)
71
72# trace/control.c
73
74# Hot-unplug a virtual (guest) CPU
75#
76# Mode: user, softmmu
77# Targets: all
78vcpu guest_cpu_exit(void)
79
80# hw/core/cpu.c
81
82# Reset the state of a virtual (guest) CPU
83#
84# Mode: user, softmmu
85# Targets: all
86vcpu guest_cpu_reset(void)
87
88# include/user/syscall-trace.h
89
90# @num: System call number.
91# @arg*: System call argument value.
92#
93# Start executing a guest system call in syscall emulation mode.
94#
95# Mode: user
96# Targets: TCG(all)
97vcpu guest_user_syscall(uint64_t num, uint64_t arg1, uint64_t arg2, uint64_t arg3, uint64_t arg4, uint64_t arg5, uint64_t arg6, uint64_t arg7, uint64_t arg8) "num=0x%016"PRIx64" arg1=0x%016"PRIx64" arg2=0x%016"PRIx64" arg3=0x%016"PRIx64" arg4=0x%016"PRIx64" arg5=0x%016"PRIx64" arg6=0x%016"PRIx64" arg7=0x%016"PRIx64" arg8=0x%016"PRIx64
98
99# @num: System call number.
100# @ret: System call result value.
101#
102# Finish executing a guest system call in syscall emulation mode.
103#
104# Mode: user
105# Targets: TCG(all)
106vcpu guest_user_syscall_ret(uint64_t num, uint64_t ret) "num=0x%016"PRIx64" ret=0x%016"PRIx64
107