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