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