xref: /qemu/trace-events (revision 33848cee)
1# Trace events for debugging and performance instrumentation
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# aio-posix.c
29run_poll_handlers_begin(void *ctx, int64_t max_ns) "ctx %p max_ns %"PRId64
30run_poll_handlers_end(void *ctx, bool progress) "ctx %p progress %d"
31poll_shrink(void *ctx, int64_t old, int64_t new) "ctx %p old %"PRId64" new %"PRId64
32poll_grow(void *ctx, int64_t old, int64_t new) "ctx %p old %"PRId64" new %"PRId64
33
34# thread-pool.c
35thread_pool_submit(void *pool, void *req, void *opaque) "pool %p req %p opaque %p"
36thread_pool_complete(void *pool, void *req, void *opaque, int ret) "pool %p req %p opaque %p ret %d"
37thread_pool_cancel(void *req, void *opaque) "req %p opaque %p"
38
39# ioport.c
40cpu_in(unsigned int addr, char size, unsigned int val) "addr %#x(%c) value %u"
41cpu_out(unsigned int addr, char size, unsigned int val) "addr %#x(%c) value %u"
42
43# balloon.c
44# Since requests are raised via monitor, not many tracepoints are needed.
45balloon_event(void *opaque, unsigned long addr) "opaque %p addr %lu"
46
47# vl.c
48vm_state_notify(int running, int reason) "running %d reason %d"
49load_file(const char *name, const char *path) "name %s location %s"
50runstate_set(int new_state) "new state %d"
51system_wakeup_request(int reason) "reason=%d"
52qemu_system_shutdown_request(void) ""
53qemu_system_powerdown_request(void) ""
54
55# spice-qemu-char.c
56spice_vmc_write(ssize_t out, int len) "spice wrottn %zd of requested %d"
57spice_vmc_read(int bytes, int len) "spice read %d of requested %d"
58spice_vmc_register_interface(void *scd) "spice vmc registered interface %p"
59spice_vmc_unregister_interface(void *scd) "spice vmc unregistered interface %p"
60spice_vmc_event(int event) "spice vmc event %d"
61
62# xen-hvm.c
63xen_ram_alloc(unsigned long ram_addr, unsigned long size) "requested: %#lx, size %#lx"
64xen_client_set_memory(uint64_t start_addr, unsigned long size, bool log_dirty) "%#"PRIx64" size %#lx, log_dirty %i"
65xen_default_ioreq_server(void) ""
66xen_ioreq_server_create(uint32_t id) "id: %u"
67xen_ioreq_server_destroy(uint32_t id) "id: %u"
68xen_ioreq_server_state(uint32_t id, bool enable) "id: %u: enable: %i"
69xen_map_mmio_range(uint32_t id, uint64_t start_addr, uint64_t end_addr) "id: %u start: %#"PRIx64" end: %#"PRIx64
70xen_unmap_mmio_range(uint32_t id, uint64_t start_addr, uint64_t end_addr) "id: %u start: %#"PRIx64" end: %#"PRIx64
71xen_map_portio_range(uint32_t id, uint64_t start_addr, uint64_t end_addr) "id: %u start: %#"PRIx64" end: %#"PRIx64
72xen_unmap_portio_range(uint32_t id, uint64_t start_addr, uint64_t end_addr) "id: %u start: %#"PRIx64" end: %#"PRIx64
73xen_map_pcidev(uint32_t id, uint8_t bus, uint8_t dev, uint8_t func) "id: %u bdf: %02x.%02x.%02x"
74xen_unmap_pcidev(uint32_t id, uint8_t bus, uint8_t dev, uint8_t func) "id: %u bdf: %02x.%02x.%02x"
75handle_ioreq(void *req, uint32_t type, uint32_t dir, uint32_t df, uint32_t data_is_ptr, uint64_t addr, uint64_t data, uint32_t count, uint32_t size) "I/O=%p type=%d dir=%d df=%d ptr=%d port=%#"PRIx64" data=%#"PRIx64" count=%d size=%d"
76handle_ioreq_read(void *req, uint32_t type, uint32_t df, uint32_t data_is_ptr, uint64_t addr, uint64_t data, uint32_t count, uint32_t size) "I/O=%p read type=%d df=%d ptr=%d port=%#"PRIx64" data=%#"PRIx64" count=%d size=%d"
77handle_ioreq_write(void *req, uint32_t type, uint32_t df, uint32_t data_is_ptr, uint64_t addr, uint64_t data, uint32_t count, uint32_t size) "I/O=%p write type=%d df=%d ptr=%d port=%#"PRIx64" data=%#"PRIx64" count=%d size=%d"
78cpu_ioreq_pio(void *req, uint32_t dir, uint32_t df, uint32_t data_is_ptr, uint64_t addr, uint64_t data, uint32_t count, uint32_t size) "I/O=%p pio dir=%d df=%d ptr=%d port=%#"PRIx64" data=%#"PRIx64" count=%d size=%d"
79cpu_ioreq_pio_read_reg(void *req, uint64_t data, uint64_t addr, uint32_t size) "I/O=%p pio read reg data=%#"PRIx64" port=%#"PRIx64" size=%d"
80cpu_ioreq_pio_write_reg(void *req, uint64_t data, uint64_t addr, uint32_t size) "I/O=%p pio write reg data=%#"PRIx64" port=%#"PRIx64" size=%d"
81cpu_ioreq_move(void *req, uint32_t dir, uint32_t df, uint32_t data_is_ptr, uint64_t addr, uint64_t data, uint32_t count, uint32_t size) "I/O=%p copy dir=%d df=%d ptr=%d port=%#"PRIx64" data=%#"PRIx64" count=%d size=%d"
82
83# xen-mapcache.c
84xen_map_cache(uint64_t phys_addr) "want %#"PRIx64
85xen_remap_bucket(uint64_t index) "index %#"PRIx64
86xen_map_cache_return(void* ptr) "%p"
87
88# monitor.c
89handle_qmp_command(void *mon, const char *cmd_name) "mon %p cmd_name \"%s\""
90monitor_protocol_event_handler(uint32_t event, void *qdict) "event=%d data=%p"
91monitor_protocol_event_emit(uint32_t event, void *data) "event=%d data=%p"
92monitor_protocol_event_queue(uint32_t event, void *qdict, uint64_t rate) "event=%d data=%p rate=%" PRId64
93monitor_protocol_event_throttle(uint32_t event, uint64_t rate) "event=%d rate=%" PRId64
94
95# dma-helpers.c
96dma_blk_io(void *dbs, void *bs, int64_t offset, bool to_dev) "dbs=%p bs=%p offset=%" PRId64 " to_dev=%d"
97dma_aio_cancel(void *dbs) "dbs=%p"
98dma_complete(void *dbs, int ret, void *cb) "dbs=%p ret=%d cb=%p"
99dma_blk_cb(void *dbs, int ret) "dbs=%p ret=%d"
100dma_map_wait(void *dbs) "dbs=%p"
101
102# kvm-all.c
103kvm_ioctl(int type, void *arg) "type 0x%x, arg %p"
104kvm_vm_ioctl(int type, void *arg) "type 0x%x, arg %p"
105kvm_vcpu_ioctl(int cpu_index, int type, void *arg) "cpu_index %d, type 0x%x, arg %p"
106kvm_run_exit(int cpu_index, uint32_t reason) "cpu_index %d, reason %d"
107kvm_device_ioctl(int fd, int type, void *arg) "dev fd %d, type 0x%x, arg %p"
108kvm_failed_reg_get(uint64_t id, const char *msg) "Warning: Unable to retrieve ONEREG %" PRIu64 " from KVM: %s"
109kvm_failed_reg_set(uint64_t id, const char *msg) "Warning: Unable to set ONEREG %" PRIu64 " to KVM: %s"
110kvm_irqchip_commit_routes(void) ""
111kvm_irqchip_add_msi_route(int virq) "Adding MSI route virq=%d"
112kvm_irqchip_update_msi_route(int virq) "Updating MSI route virq=%d"
113
114# TCG related tracing (mostly disabled by default)
115# cpu-exec.c
116disable exec_tb(void *tb, uintptr_t pc) "tb:%p pc=0x%"PRIxPTR
117disable exec_tb_nocache(void *tb, uintptr_t pc) "tb:%p pc=0x%"PRIxPTR
118disable exec_tb_exit(void *last_tb, unsigned int flags) "tb:%p flags=%x"
119
120# translate-all.c
121translate_block(void *tb, uintptr_t pc, uint8_t *tb_code) "tb:%p, pc:0x%"PRIxPTR", tb_code:%p"
122
123# memory.c
124memory_region_ops_read(int cpu_index, void *mr, uint64_t addr, uint64_t value, unsigned size) "cpu %d mr %p addr %#"PRIx64" value %#"PRIx64" size %u"
125memory_region_ops_write(int cpu_index, void *mr, uint64_t addr, uint64_t value, unsigned size) "cpu %d mr %p addr %#"PRIx64" value %#"PRIx64" size %u"
126memory_region_subpage_read(int cpu_index, void *mr, uint64_t offset, uint64_t value, unsigned size) "cpu %d mr %p offset %#"PRIx64" value %#"PRIx64" size %u"
127memory_region_subpage_write(int cpu_index, void *mr, uint64_t offset, uint64_t value, unsigned size) "cpu %d mr %p offset %#"PRIx64" value %#"PRIx64" size %u"
128memory_region_tb_read(int cpu_index, uint64_t addr, uint64_t value, unsigned size) "cpu %d addr %#"PRIx64" value %#"PRIx64" size %u"
129memory_region_tb_write(int cpu_index, uint64_t addr, uint64_t value, unsigned size) "cpu %d addr %#"PRIx64" value %#"PRIx64" size %u"
130memory_region_ram_device_read(int cpu_index, void *mr, uint64_t addr, uint64_t value, unsigned size) "cpu %d mr %p addr %#"PRIx64" value %#"PRIx64" size %u"
131memory_region_ram_device_write(int cpu_index, void *mr, uint64_t addr, uint64_t value, unsigned size) "cpu %d mr %p addr %#"PRIx64" value %#"PRIx64" size %u"
132
133### Guest events, keep at bottom
134
135
136## vCPU
137
138# Hot-plug a new virtual (guest) CPU
139#
140# Mode: user, softmmu
141# Targets: all
142vcpu guest_cpu_enter(void)
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# @vaddr: Access' virtual address.
151# @info : Access' information (see below).
152#
153# Start virtual memory access (before any potential access violation).
154#
155# Does not include memory accesses performed by devices.
156#
157# Access information can be parsed as:
158#
159# struct mem_info {
160#     uint8_t size_shift : 2; /* interpreted as "1 << size_shift" bytes */
161#     bool    sign_extend: 1; /* sign-extended */
162#     uint8_t endianness : 1; /* 0: little, 1: big */
163#     bool    store      : 1; /* wheter it's a store operation */
164# };
165#
166# Mode: user, softmmu
167# Targets: TCG(all)
168disable vcpu tcg guest_mem_before(TCGv vaddr, uint8_t info) "info=%d", "vaddr=0x%016"PRIx64" info=%d"
169
170# @num: System call number.
171# @arg*: System call argument value.
172#
173# Start executing a guest system call in syscall emulation mode.
174#
175# Mode: user
176# Targets: TCG(all)
177disable 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
178
179# @num: System call number.
180# @ret: System call result value.
181#
182# Finish executing a guest system call in syscall emulation mode.
183#
184# Mode: user
185# Targets: TCG(all)
186disable vcpu guest_user_syscall_ret(uint64_t num, uint64_t ret) "num=0x%016"PRIx64" ret=0x%016"PRIx64
187