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