xref: /qemu/trace-events (revision 0b8fa32f) 
1# See docs/devel/tracing.txt 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# ioport.c
29cpu_in(unsigned int addr, char size, unsigned int val) "addr 0x%x(%c) value %u"
30cpu_out(unsigned int addr, char size, unsigned int val) "addr 0x%x(%c) value %u"
31
32# balloon.c
33# Since requests are raised via monitor, not many tracepoints are needed.
34balloon_event(void *opaque, unsigned long addr) "opaque %p addr %lu"
35
36# vl.c
37vm_state_notify(int running, int reason, const char *reason_str) "running %d reason %d (%s)"
38load_file(const char *name, const char *path) "name %s location %s"
39runstate_set(int current_state, const char *current_state_str, int new_state, const char *new_state_str) "current_run_state %d (%s) new_state %d (%s)"
40system_wakeup_request(int reason) "reason=%d"
41qemu_system_shutdown_request(int reason) "reason=%d"
42qemu_system_powerdown_request(void) ""
43
44# monitor.c
45monitor_protocol_event_handler(uint32_t event, void *qdict) "event=%d data=%p"
46monitor_protocol_event_emit(uint32_t event, void *data) "event=%d data=%p"
47monitor_protocol_event_queue(uint32_t event, void *qdict, uint64_t rate) "event=%d data=%p rate=%" PRId64
48handle_hmp_command(void *mon, const char *cmdline) "mon %p cmdline: %s"
49handle_qmp_command(void *mon, const char *req) "mon %p req: %s"
50monitor_suspend(void *ptr, int cnt) "mon %p: %d"
51monitor_qmp_cmd_in_band(const char *id) "%s"
52monitor_qmp_cmd_out_of_band(const char *id) "%s"
53
54# dma-helpers.c
55dma_blk_io(void *dbs, void *bs, int64_t offset, bool to_dev) "dbs=%p bs=%p offset=%" PRId64 " to_dev=%d"
56dma_aio_cancel(void *dbs) "dbs=%p"
57dma_complete(void *dbs, int ret, void *cb) "dbs=%p ret=%d cb=%p"
58dma_blk_cb(void *dbs, int ret) "dbs=%p ret=%d"
59dma_map_wait(void *dbs) "dbs=%p"
60
61# exec.c
62find_ram_offset(uint64_t size, uint64_t offset) "size: 0x%" PRIx64 " @ 0x%" PRIx64
63find_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
64ram_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"
65
66# memory.c
67memory_region_ops_read(int cpu_index, void *mr, uint64_t addr, uint64_t value, unsigned size) "cpu %d mr %p addr 0x%"PRIx64" value 0x%"PRIx64" size %u"
68memory_region_ops_write(int cpu_index, void *mr, uint64_t addr, uint64_t value, unsigned size) "cpu %d mr %p addr 0x%"PRIx64" value 0x%"PRIx64" size %u"
69memory_region_subpage_read(int cpu_index, void *mr, uint64_t offset, uint64_t value, unsigned size) "cpu %d mr %p offset 0x%"PRIx64" value 0x%"PRIx64" size %u"
70memory_region_subpage_write(int cpu_index, void *mr, uint64_t offset, uint64_t value, unsigned size) "cpu %d mr %p offset 0x%"PRIx64" value 0x%"PRIx64" size %u"
71memory_region_tb_read(int cpu_index, uint64_t addr, uint64_t value, unsigned size) "cpu %d addr 0x%"PRIx64" value 0x%"PRIx64" size %u"
72memory_region_tb_write(int cpu_index, uint64_t addr, uint64_t value, unsigned size) "cpu %d addr 0x%"PRIx64" value 0x%"PRIx64" size %u"
73memory_region_ram_device_read(int cpu_index, void *mr, uint64_t addr, uint64_t value, unsigned size) "cpu %d mr %p addr 0x%"PRIx64" value 0x%"PRIx64" size %u"
74memory_region_ram_device_write(int cpu_index, void *mr, uint64_t addr, uint64_t value, unsigned size) "cpu %d mr %p addr 0x%"PRIx64" value 0x%"PRIx64" size %u"
75flatview_new(void *view, void *root) "%p (root %p)"
76flatview_destroy(void *view, void *root) "%p (root %p)"
77flatview_destroy_rcu(void *view, void *root) "%p (root %p)"
78
79# gdbstub.c
80gdbstub_op_start(const char *device) "Starting gdbstub using device %s"
81gdbstub_op_exiting(uint8_t code) "notifying exit with code=0x%02x"
82gdbstub_op_continue(void) "Continuing all CPUs"
83gdbstub_op_continue_cpu(int cpu_index) "Continuing CPU %d"
84gdbstub_op_stepping(int cpu_index) "Stepping CPU %d"
85gdbstub_op_extra_info(const char *info) "Thread extra info: %s"
86gdbstub_hit_watchpoint(const char *type, int cpu_gdb_index, uint64_t vaddr) "Watchpoint hit, type=\"%s\" cpu=%d, vaddr=0x%" PRIx64 ""
87gdbstub_hit_internal_error(void) "RUN_STATE_INTERNAL_ERROR"
88gdbstub_hit_break(void) "RUN_STATE_DEBUG"
89gdbstub_hit_paused(void) "RUN_STATE_PAUSED"
90gdbstub_hit_shutdown(void) "RUN_STATE_SHUTDOWN"
91gdbstub_hit_io_error(void) "RUN_STATE_IO_ERROR"
92gdbstub_hit_watchdog(void) "RUN_STATE_WATCHDOG"
93gdbstub_hit_unknown(int state) "Unknown run state=0x%x"
94gdbstub_io_reply(const char *message) "Sent: %s"
95gdbstub_io_binaryreply(size_t ofs, const char *line) "0x%04zx: %s"
96gdbstub_io_command(const char *command) "Received: %s"
97gdbstub_io_got_ack(void) "Got ACK"
98gdbstub_io_got_unexpected(uint8_t ch) "Got 0x%02x when expecting ACK/NACK"
99gdbstub_err_got_nack(void) "Got NACK, retransmitting"
100gdbstub_err_garbage(uint8_t ch) "received garbage between packets: 0x%02x"
101gdbstub_err_overrun(void) "command buffer overrun, dropping command"
102gdbstub_err_invalid_repeat(uint8_t ch) "got invalid RLE count: 0x%02x"
103gdbstub_err_invalid_rle(void) "got invalid RLE sequence"
104gdbstub_err_checksum_invalid(uint8_t ch) "got invalid command checksum digit: 0x%02x"
105gdbstub_err_checksum_incorrect(uint8_t expected, uint8_t got) "got command packet with incorrect checksum, expected=0x%02x, received=0x%02x"
106
107# job.c
108job_state_transition(void *job,  int ret, const char *legal, const char *s0, const char *s1) "job %p (ret: %d) attempting %s transition (%s-->%s)"
109job_apply_verb(void *job, const char *state, const char *verb, const char *legal) "job %p in state %s; applying verb %s (%s)"
110job_completed(void *job, int ret) "job %p ret %d"
111
112# job-qmp.c
113qmp_job_cancel(void *job) "job %p"
114qmp_job_pause(void *job) "job %p"
115qmp_job_resume(void *job) "job %p"
116qmp_job_complete(void *job) "job %p"
117qmp_job_finalize(void *job) "job %p"
118qmp_job_dismiss(void *job) "job %p"
119
120
121### Guest events, keep at bottom
122
123
124## vCPU
125
126# trace/control-target.c
127
128# Hot-plug a new virtual (guest) CPU
129#
130# Mode: user, softmmu
131# Targets: all
132vcpu guest_cpu_enter(void)
133
134# trace/control.c
135
136# Hot-unplug a virtual (guest) CPU
137#
138# Mode: user, softmmu
139# Targets: all
140vcpu guest_cpu_exit(void)
141
142# qom/cpu.c
143
144# Reset the state of a virtual (guest) CPU
145#
146# Mode: user, softmmu
147# Targets: all
148vcpu guest_cpu_reset(void)
149
150# tcg/tcg-op.c
151
152# @vaddr: Access' virtual address.
153# @info : Access' information (see below).
154#
155# Start virtual memory access (before any potential access violation).
156#
157# Does not include memory accesses performed by devices.
158#
159# Access information can be parsed as:
160#
161# struct mem_info {
162#     uint8_t size_shift : 2; /* interpreted as "1 << size_shift" bytes */
163#     bool    sign_extend: 1; /* sign-extended */
164#     uint8_t endianness : 1; /* 0: little, 1: big */
165#     bool    store      : 1; /* wheter it's a store operation */
166# };
167#
168# Mode: user, softmmu
169# Targets: TCG(all)
170vcpu tcg guest_mem_before(TCGv vaddr, uint8_t info) "info=%d", "vaddr=0x%016"PRIx64" info=%d"
171
172# linux-user/syscall.c
173# bsd-user/syscall.c
174
175# @num: System call number.
176# @arg*: System call argument value.
177#
178# Start executing a guest system call in syscall emulation mode.
179#
180# Mode: user
181# Targets: TCG(all)
182vcpu 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
183
184# @num: System call number.
185# @ret: System call result value.
186#
187# Finish executing a guest system call in syscall emulation mode.
188#
189# Mode: user
190# Targets: TCG(all)
191vcpu guest_user_syscall_ret(uint64_t num, uint64_t ret) "num=0x%016"PRIx64" ret=0x%016"PRIx64
192