build-sys: add txt documentation rules
[qemu/ar7.git] / trace-events
blob11814864545fd04b458ce1bab059434bcd932e12
1 # Trace events for debugging and performance instrumentation
3 # This file is processed by the tracetool script during the build.
5 # To add a new trace event:
7 # 1. Choose a name for the trace event.  Declare its arguments and format
8 #    string.
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".
13 # Format of a trace event:
15 # [disable] <name>(<type1> <arg1>[, <type2> <arg2>] ...) "<format-string>"
17 # Example: g_malloc(size_t size) "size %zu"
19 # The "disable" keyword will build without the trace event.
21 # The <name> must be a valid as a C function name.
23 # Types should be standard C types.  Use void * for pointers because the trace
24 # system may not have the necessary headers included.
26 # The <format-string> should be a sprintf()-compatible format string.
28 # aio-posix.c
29 run_poll_handlers_begin(void *ctx, int64_t max_ns) "ctx %p max_ns %"PRId64
30 run_poll_handlers_end(void *ctx, bool progress) "ctx %p progress %d"
31 poll_shrink(void *ctx, int64_t old, int64_t new) "ctx %p old %"PRId64" new %"PRId64
32 poll_grow(void *ctx, int64_t old, int64_t new) "ctx %p old %"PRId64" new %"PRId64
34 # thread-pool.c
35 thread_pool_submit(void *pool, void *req, void *opaque) "pool %p req %p opaque %p"
36 thread_pool_complete(void *pool, void *req, void *opaque, int ret) "pool %p req %p opaque %p ret %d"
37 thread_pool_cancel(void *req, void *opaque) "req %p opaque %p"
39 # ioport.c
40 cpu_in(unsigned int addr, char size, unsigned int val) "addr %#x(%c) value %u"
41 cpu_out(unsigned int addr, char size, unsigned int val) "addr %#x(%c) value %u"
43 # balloon.c
44 # Since requests are raised via monitor, not many tracepoints are needed.
45 balloon_event(void *opaque, unsigned long addr) "opaque %p addr %lu"
47 # vl.c
48 vm_state_notify(int running, int reason) "running %d reason %d"
49 load_file(const char *name, const char *path) "name %s location %s"
50 runstate_set(int new_state) "new state %d"
51 system_wakeup_request(int reason) "reason=%d"
52 qemu_system_shutdown_request(void) ""
53 qemu_system_powerdown_request(void) ""
55 # spice-qemu-char.c
56 spice_vmc_write(ssize_t out, int len) "spice wrottn %zd of requested %d"
57 spice_vmc_read(int bytes, int len) "spice read %d of requested %d"
58 spice_vmc_register_interface(void *scd) "spice vmc registered interface %p"
59 spice_vmc_unregister_interface(void *scd) "spice vmc unregistered interface %p"
60 spice_vmc_event(int event) "spice vmc event %d"
62 # xen-hvm.c
63 xen_ram_alloc(unsigned long ram_addr, unsigned long size) "requested: %#lx, size %#lx"
64 xen_client_set_memory(uint64_t start_addr, unsigned long size, bool log_dirty) "%#"PRIx64" size %#lx, log_dirty %i"
65 xen_default_ioreq_server(void) ""
66 xen_ioreq_server_create(uint32_t id) "id: %u"
67 xen_ioreq_server_destroy(uint32_t id) "id: %u"
68 xen_ioreq_server_state(uint32_t id, bool enable) "id: %u: enable: %i"
69 xen_map_mmio_range(uint32_t id, uint64_t start_addr, uint64_t end_addr) "id: %u start: %#"PRIx64" end: %#"PRIx64
70 xen_unmap_mmio_range(uint32_t id, uint64_t start_addr, uint64_t end_addr) "id: %u start: %#"PRIx64" end: %#"PRIx64
71 xen_map_portio_range(uint32_t id, uint64_t start_addr, uint64_t end_addr) "id: %u start: %#"PRIx64" end: %#"PRIx64
72 xen_unmap_portio_range(uint32_t id, uint64_t start_addr, uint64_t end_addr) "id: %u start: %#"PRIx64" end: %#"PRIx64
73 xen_map_pcidev(uint32_t id, uint8_t bus, uint8_t dev, uint8_t func) "id: %u bdf: %02x.%02x.%02x"
74 xen_unmap_pcidev(uint32_t id, uint8_t bus, uint8_t dev, uint8_t func) "id: %u bdf: %02x.%02x.%02x"
75 handle_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"
76 handle_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"
77 handle_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"
78 cpu_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"
79 cpu_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"
80 cpu_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"
81 cpu_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"
83 # xen-mapcache.c
84 xen_map_cache(uint64_t phys_addr) "want %#"PRIx64
85 xen_remap_bucket(uint64_t index) "index %#"PRIx64
86 xen_map_cache_return(void* ptr) "%p"
88 # monitor.c
89 handle_qmp_command(void *mon, const char *cmd_name) "mon %p cmd_name \"%s\""
90 monitor_protocol_event_handler(uint32_t event, void *qdict) "event=%d data=%p"
91 monitor_protocol_event_emit(uint32_t event, void *data) "event=%d data=%p"
92 monitor_protocol_event_queue(uint32_t event, void *qdict, uint64_t rate) "event=%d data=%p rate=%" PRId64
93 monitor_protocol_event_throttle(uint32_t event, uint64_t rate) "event=%d rate=%" PRId64
95 # dma-helpers.c
96 dma_blk_io(void *dbs, void *bs, int64_t offset, bool to_dev) "dbs=%p bs=%p offset=%" PRId64 " to_dev=%d"
97 dma_aio_cancel(void *dbs) "dbs=%p"
98 dma_complete(void *dbs, int ret, void *cb) "dbs=%p ret=%d cb=%p"
99 dma_blk_cb(void *dbs, int ret) "dbs=%p ret=%d"
100 dma_map_wait(void *dbs) "dbs=%p"
102 # kvm-all.c
103 kvm_ioctl(int type, void *arg) "type 0x%x, arg %p"
104 kvm_vm_ioctl(int type, void *arg) "type 0x%x, arg %p"
105 kvm_vcpu_ioctl(int cpu_index, int type, void *arg) "cpu_index %d, type 0x%x, arg %p"
106 kvm_run_exit(int cpu_index, uint32_t reason) "cpu_index %d, reason %d"
107 kvm_device_ioctl(int fd, int type, void *arg) "dev fd %d, type 0x%x, arg %p"
108 kvm_failed_reg_get(uint64_t id, const char *msg) "Warning: Unable to retrieve ONEREG %" PRIu64 " from KVM: %s"
109 kvm_failed_reg_set(uint64_t id, const char *msg) "Warning: Unable to set ONEREG %" PRIu64 " to KVM: %s"
110 kvm_irqchip_commit_routes(void) ""
111 kvm_irqchip_add_msi_route(int virq) "Adding MSI route virq=%d"
112 kvm_irqchip_update_msi_route(int virq) "Updating MSI route virq=%d"
114 # TCG related tracing (mostly disabled by default)
115 # cpu-exec.c
116 disable exec_tb(void *tb, uintptr_t pc) "tb:%p pc=0x%"PRIxPTR
117 disable exec_tb_nocache(void *tb, uintptr_t pc) "tb:%p pc=0x%"PRIxPTR
118 disable exec_tb_exit(void *last_tb, unsigned int flags) "tb:%p flags=%x"
120 # translate-all.c
121 translate_block(void *tb, uintptr_t pc, uint8_t *tb_code) "tb:%p, pc:0x%"PRIxPTR", tb_code:%p"
123 # memory.c
124 memory_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"
125 memory_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"
126 memory_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"
127 memory_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"
128 memory_region_tb_read(int cpu_index, uint64_t addr, uint64_t value, unsigned size) "cpu %d addr %#"PRIx64" value %#"PRIx64" size %u"
129 memory_region_tb_write(int cpu_index, uint64_t addr, uint64_t value, unsigned size) "cpu %d addr %#"PRIx64" value %#"PRIx64" size %u"
130 memory_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"
131 memory_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"
133 ### Guest events, keep at bottom
136 ## vCPU
138 # Hot-plug a new virtual (guest) CPU
140 # Mode: user, softmmu
141 # Targets: all
142 vcpu guest_cpu_enter(void)
144 # Reset the state of a virtual (guest) CPU
146 # Mode: user, softmmu
147 # Targets: all
148 vcpu guest_cpu_reset(void)
150 # @vaddr: Access' virtual address.
151 # @info : Access' information (see below).
153 # Start virtual memory access (before any potential access violation).
155 # Does not include memory accesses performed by devices.
157 # Access information can be parsed as:
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 # };
166 # Mode: user, softmmu
167 # Targets: TCG(all)
168 disable vcpu tcg guest_mem_before(TCGv vaddr, uint8_t info) "info=%d", "vaddr=0x%016"PRIx64" info=%d"
170 # @num: System call number.
171 # @arg*: System call argument value.
173 # Start executing a guest system call in syscall emulation mode.
175 # Mode: user
176 # Targets: TCG(all)
177 disable 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
179 # @num: System call number.
180 # @ret: System call result value.
182 # Finish executing a guest system call in syscall emulation mode.
184 # Mode: user
185 # Targets: TCG(all)
186 disable vcpu guest_user_syscall_ret(uint64_t num, uint64_t ret) "num=0x%016"PRIx64" ret=0x%016"PRIx64