xref: /openbmc/qemu/trace-events (revision 4fe6d78b) 
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# 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) "running %d reason %d"
38load_file(const char *name, const char *path) "name %s location %s"
39runstate_set(int new_state) "new state %d"
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"
50
51# dma-helpers.c
52dma_blk_io(void *dbs, void *bs, int64_t offset, bool to_dev) "dbs=%p bs=%p offset=%" PRId64 " to_dev=%d"
53dma_aio_cancel(void *dbs) "dbs=%p"
54dma_complete(void *dbs, int ret, void *cb) "dbs=%p ret=%d cb=%p"
55dma_blk_cb(void *dbs, int ret) "dbs=%p ret=%d"
56dma_map_wait(void *dbs) "dbs=%p"
57
58#  # exec.c
59find_ram_offset(uint64_t size, uint64_t offset) "size: 0x%" PRIx64 " @ 0x%" PRIx64
60find_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
61
62# memory.c
63memory_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"
64memory_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"
65memory_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"
66memory_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"
67memory_region_tb_read(int cpu_index, uint64_t addr, uint64_t value, unsigned size) "cpu %d addr 0x%"PRIx64" value 0x%"PRIx64" size %u"
68memory_region_tb_write(int cpu_index, uint64_t addr, uint64_t value, unsigned size) "cpu %d addr 0x%"PRIx64" value 0x%"PRIx64" size %u"
69memory_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"
70memory_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"
71flatview_new(FlatView *view, MemoryRegion *root) "%p (root %p)"
72flatview_destroy(FlatView *view, MemoryRegion *root) "%p (root %p)"
73flatview_destroy_rcu(FlatView *view, MemoryRegion *root) "%p (root %p)"
74
75# gdbstub.c
76gdbstub_op_start(char const *device) "Starting gdbstub using device %s"
77gdbstub_op_exiting(uint8_t code) "notifying exit with code=0x%02x"
78gdbstub_op_continue(void) "Continuing all CPUs"
79gdbstub_op_continue_cpu(int cpu_index) "Continuing CPU %d"
80gdbstub_op_stepping(int cpu_index) "Stepping CPU %d"
81gdbstub_op_extra_info(char const *info) "Thread extra info: %s"
82gdbstub_hit_watchpoint(char const *type, int cpu_gdb_index, uint64_t vaddr) "Watchpoint hit, type=\"%s\" cpu=%d, vaddr=0x%" PRIx64 ""
83gdbstub_hit_internal_error(void) "RUN_STATE_INTERNAL_ERROR"
84gdbstub_hit_break(void) "RUN_STATE_DEBUG"
85gdbstub_hit_paused(void) "RUN_STATE_PAUSED"
86gdbstub_hit_shutdown(void) "RUN_STATE_SHUTDOWN"
87gdbstub_hit_io_error(void) "RUN_STATE_IO_ERROR"
88gdbstub_hit_watchdog(void) "RUN_STATE_WATCHDOG"
89gdbstub_hit_unknown(int state) "Unknown run state=0x%x"
90gdbstub_io_reply(char const *message) "Sent: %s"
91gdbstub_io_binaryreply(size_t ofs, char const *line) "0x%04zx: %s"
92gdbstub_io_command(char const *command) "Received: %s"
93gdbstub_io_got_ack(void) "Got ACK"
94gdbstub_io_got_unexpected(uint8_t ch) "Got 0x%02x when expecting ACK/NACK"
95gdbstub_err_got_nack(void) "Got NACK, retransmitting"
96gdbstub_err_garbage(uint8_t ch) "received garbage between packets: 0x%02x"
97gdbstub_err_overrun(void) "command buffer overrun, dropping command"
98gdbstub_err_invalid_repeat(uint8_t ch) "got invalid RLE count: 0x%02x"
99gdbstub_err_invalid_rle(void) "got invalid RLE sequence"
100gdbstub_err_checksum_invalid(uint8_t ch) "got invalid command checksum digit: 0x%02x"
101gdbstub_err_checksum_incorrect(uint8_t expected, uint8_t got) "got command packet with incorrect checksum, expected=0x%02x, received=0x%02x"
102
103### Guest events, keep at bottom
104
105
106## vCPU
107
108# Hot-plug a new virtual (guest) CPU
109#
110# Mode: user, softmmu
111# Targets: all
112vcpu guest_cpu_enter(void)
113
114# Hot-unplug a virtual (guest) CPU
115#
116# Mode: user, softmmu
117# Targets: all
118vcpu guest_cpu_exit(void)
119
120# Reset the state of a virtual (guest) CPU
121#
122# Mode: user, softmmu
123# Targets: all
124vcpu guest_cpu_reset(void)
125
126# @vaddr: Access' virtual address.
127# @info : Access' information (see below).
128#
129# Start virtual memory access (before any potential access violation).
130#
131# Does not include memory accesses performed by devices.
132#
133# Access information can be parsed as:
134#
135# struct mem_info {
136#     uint8_t size_shift : 2; /* interpreted as "1 << size_shift" bytes */
137#     bool    sign_extend: 1; /* sign-extended */
138#     uint8_t endianness : 1; /* 0: little, 1: big */
139#     bool    store      : 1; /* wheter it's a store operation */
140# };
141#
142# Mode: user, softmmu
143# Targets: TCG(all)
144vcpu tcg guest_mem_before(TCGv vaddr, uint8_t info) "info=%d", "vaddr=0x%016"PRIx64" info=%d"
145
146# @num: System call number.
147# @arg*: System call argument value.
148#
149# Start executing a guest system call in syscall emulation mode.
150#
151# Mode: user
152# Targets: TCG(all)
153vcpu 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
154
155# @num: System call number.
156# @ret: System call result value.
157#
158# Finish executing a guest system call in syscall emulation mode.
159#
160# Mode: user
161# Targets: TCG(all)
162vcpu guest_user_syscall_ret(uint64_t num, uint64_t ret) "num=0x%016"PRIx64" ret=0x%016"PRIx64
163