xref: /openbmc/qemu/trace-events (revision d0fb9657)
1*d0fb9657SStefano Garzarella# See docs/devel/tracing.rst for syntax documentation.
294a420b1SStefan Hajnoczi#
394a420b1SStefan Hajnoczi# This file is processed by the tracetool script during the build.
494a420b1SStefan Hajnoczi#
594a420b1SStefan Hajnoczi# To add a new trace event:
694a420b1SStefan Hajnoczi#
794a420b1SStefan Hajnoczi# 1. Choose a name for the trace event.  Declare its arguments and format
894a420b1SStefan Hajnoczi#    string.
994a420b1SStefan Hajnoczi#
1094a420b1SStefan Hajnoczi# 2. Call the trace event from code using trace_##name, e.g. multiwrite_cb() ->
1194a420b1SStefan Hajnoczi#    trace_multiwrite_cb().  The source file must #include "trace.h".
1294a420b1SStefan Hajnoczi#
1394a420b1SStefan Hajnoczi# Format of a trace event:
1494a420b1SStefan Hajnoczi#
151e2cf2bcSStefan Hajnoczi# [disable] <name>(<type1> <arg1>[, <type2> <arg2>] ...) "<format-string>"
1694a420b1SStefan Hajnoczi#
17a74cd8ccSFrediano Ziglio# Example: g_malloc(size_t size) "size %zu"
1894a420b1SStefan Hajnoczi#
191e2cf2bcSStefan Hajnoczi# The "disable" keyword will build without the trace event.
201e2cf2bcSStefan Hajnoczi#
2194a420b1SStefan Hajnoczi# The <name> must be a valid as a C function name.
2294a420b1SStefan Hajnoczi#
2394a420b1SStefan Hajnoczi# Types should be standard C types.  Use void * for pointers because the trace
2494a420b1SStefan Hajnoczi# system may not have the necessary headers included.
2594a420b1SStefan Hajnoczi#
2694a420b1SStefan Hajnoczi# The <format-string> should be a sprintf()-compatible format string.
27cd245a19SStefan Hajnoczi
28c57c4658SKevin Wolf# dma-helpers.c
29cbe0ed62SPaolo Bonzinidma_blk_io(void *dbs, void *bs, int64_t offset, bool to_dev) "dbs=%p bs=%p offset=%" PRId64 " to_dev=%d"
30c57c4658SKevin Wolfdma_aio_cancel(void *dbs) "dbs=%p"
31c57c4658SKevin Wolfdma_complete(void *dbs, int ret, void *cb) "dbs=%p ret=%d cb=%p"
324be74634SMarkus Armbrusterdma_blk_cb(void *dbs, int ret) "dbs=%p ret=%d"
33c57c4658SKevin Wolfdma_map_wait(void *dbs) "dbs=%p"
34cdbc19ddSAlon Levy
35db144f70SDr. David Alan Gilbert# exec.c
36154cc9eaSDr. David Alan Gilbertfind_ram_offset(uint64_t size, uint64_t offset) "size: 0x%" PRIx64 " @ 0x%" PRIx64
37154cc9eaSDr. David Alan Gilbertfind_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
38db144f70SDr. David Alan Gilbertram_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"
39b15e402fSMarkus Armbruster
40b15e402fSMarkus Armbruster# accel/tcg/cputlb.c
416e050d41SRichard Hendersonmemory_notdirty_write_access(uint64_t vaddr, uint64_t ram_addr, unsigned size) "0x%" PRIx64 " ram_addr 0x%" PRIx64 " size %u"
426e050d41SRichard Hendersonmemory_notdirty_set_dirty(uint64_t vaddr) "0x%" PRIx64
43154cc9eaSDr. David Alan Gilbert
445c9522b3SDoug Gale# gdbstub.c
457f1d87abSStefan Hajnoczigdbstub_op_start(const char *device) "Starting gdbstub using device %s"
465c9522b3SDoug Galegdbstub_op_exiting(uint8_t code) "notifying exit with code=0x%02x"
475c9522b3SDoug Galegdbstub_op_continue(void) "Continuing all CPUs"
485c9522b3SDoug Galegdbstub_op_continue_cpu(int cpu_index) "Continuing CPU %d"
495c9522b3SDoug Galegdbstub_op_stepping(int cpu_index) "Stepping CPU %d"
507f1d87abSStefan Hajnoczigdbstub_op_extra_info(const char *info) "Thread extra info: %s"
517f1d87abSStefan Hajnoczigdbstub_hit_watchpoint(const char *type, int cpu_gdb_index, uint64_t vaddr) "Watchpoint hit, type=\"%s\" cpu=%d, vaddr=0x%" PRIx64 ""
525c9522b3SDoug Galegdbstub_hit_internal_error(void) "RUN_STATE_INTERNAL_ERROR"
535c9522b3SDoug Galegdbstub_hit_break(void) "RUN_STATE_DEBUG"
545c9522b3SDoug Galegdbstub_hit_paused(void) "RUN_STATE_PAUSED"
555c9522b3SDoug Galegdbstub_hit_shutdown(void) "RUN_STATE_SHUTDOWN"
565c9522b3SDoug Galegdbstub_hit_io_error(void) "RUN_STATE_IO_ERROR"
575c9522b3SDoug Galegdbstub_hit_watchdog(void) "RUN_STATE_WATCHDOG"
585c9522b3SDoug Galegdbstub_hit_unknown(int state) "Unknown run state=0x%x"
597f1d87abSStefan Hajnoczigdbstub_io_reply(const char *message) "Sent: %s"
607f1d87abSStefan Hajnoczigdbstub_io_binaryreply(size_t ofs, const char *line) "0x%04zx: %s"
617f1d87abSStefan Hajnoczigdbstub_io_command(const char *command) "Received: %s"
625c9522b3SDoug Galegdbstub_io_got_ack(void) "Got ACK"
635c9522b3SDoug Galegdbstub_io_got_unexpected(uint8_t ch) "Got 0x%02x when expecting ACK/NACK"
645c9522b3SDoug Galegdbstub_err_got_nack(void) "Got NACK, retransmitting"
655c9522b3SDoug Galegdbstub_err_garbage(uint8_t ch) "received garbage between packets: 0x%02x"
665c9522b3SDoug Galegdbstub_err_overrun(void) "command buffer overrun, dropping command"
675c9522b3SDoug Galegdbstub_err_invalid_repeat(uint8_t ch) "got invalid RLE count: 0x%02x"
685c9522b3SDoug Galegdbstub_err_invalid_rle(void) "got invalid RLE sequence"
695c9522b3SDoug Galegdbstub_err_checksum_invalid(uint8_t ch) "got invalid command checksum digit: 0x%02x"
705c9522b3SDoug Galegdbstub_err_checksum_incorrect(uint8_t expected, uint8_t got) "got command packet with incorrect checksum, expected=0x%02x, received=0x%02x"
715c9522b3SDoug Gale
72a50c2ab8SKevin Wolf# job.c
73a50c2ab8SKevin Wolfjob_state_transition(void *job,  int ret, const char *legal, const char *s0, const char *s1) "job %p (ret: %d) attempting %s transition (%s-->%s)"
74a50c2ab8SKevin Wolfjob_apply_verb(void *job, const char *state, const char *verb, const char *legal) "job %p in state %s; applying verb %s (%s)"
75404ff28dSJohn Snowjob_completed(void *job, int ret) "job %p ret %d"
76a50c2ab8SKevin Wolf
771a90bc81SKevin Wolf# job-qmp.c
781a90bc81SKevin Wolfqmp_job_cancel(void *job) "job %p"
791a90bc81SKevin Wolfqmp_job_pause(void *job) "job %p"
801a90bc81SKevin Wolfqmp_job_resume(void *job) "job %p"
811a90bc81SKevin Wolfqmp_job_complete(void *job) "job %p"
821a90bc81SKevin Wolfqmp_job_finalize(void *job) "job %p"
831a90bc81SKevin Wolfqmp_job_dismiss(void *job) "job %p"
841a90bc81SKevin Wolf
851a90bc81SKevin Wolf
86dcdaadb6SLluís Vilanova### Guest events, keep at bottom
87dcdaadb6SLluís Vilanova
88b9d72215SLluís Vilanova
89b9d72215SLluís Vilanova## vCPU
90b9d72215SLluís Vilanova
91dec97760SMarkus Armbruster# trace/control-target.c
92dec97760SMarkus Armbruster
93b9d72215SLluís Vilanova# Hot-plug a new virtual (guest) CPU
94b9d72215SLluís Vilanova#
95f5e2b3beSLluís Vilanova# Mode: user, softmmu
96b9d72215SLluís Vilanova# Targets: all
97b9d72215SLluís Vilanovavcpu guest_cpu_enter(void)
98b9d72215SLluís Vilanova
99dec97760SMarkus Armbruster# trace/control.c
100dec97760SMarkus Armbruster
101a47e8715SLluís Vilanova# Hot-unplug a virtual (guest) CPU
102a47e8715SLluís Vilanova#
103a47e8715SLluís Vilanova# Mode: user, softmmu
104a47e8715SLluís Vilanova# Targets: all
105a47e8715SLluís Vilanovavcpu guest_cpu_exit(void)
106a47e8715SLluís Vilanova
1072e5b09fdSMarkus Armbruster# hw/core/cpu.c
108dec97760SMarkus Armbruster
1092cc2d082SLluís Vilanova# Reset the state of a virtual (guest) CPU
1102cc2d082SLluís Vilanova#
111f5e2b3beSLluís Vilanova# Mode: user, softmmu
1122cc2d082SLluís Vilanova# Targets: all
1132cc2d082SLluís Vilanovavcpu guest_cpu_reset(void)
1142cc2d082SLluís Vilanova
115dec97760SMarkus Armbruster# tcg/tcg-op.c
116dec97760SMarkus Armbruster
117dcdaadb6SLluís Vilanova# @vaddr: Access' virtual address.
118dcdaadb6SLluís Vilanova# @info : Access' information (see below).
119dcdaadb6SLluís Vilanova#
120dcdaadb6SLluís Vilanova# Start virtual memory access (before any potential access violation).
121dcdaadb6SLluís Vilanova#
122dcdaadb6SLluís Vilanova# Does not include memory accesses performed by devices.
123dcdaadb6SLluís Vilanova#
124dcdaadb6SLluís Vilanova# Access information can be parsed as:
125dcdaadb6SLluís Vilanova#
126dcdaadb6SLluís Vilanova# struct mem_info {
127291987c3SEmilio G. Cota#     uint8_t size_shift : 4; /* interpreted as "1 << size_shift" bytes */
128dcdaadb6SLluís Vilanova#     bool    sign_extend: 1; /* sign-extended */
129dcdaadb6SLluís Vilanova#     uint8_t endianness : 1; /* 0: little, 1: big */
130504f73f7SAlex Bennée#     bool    store      : 1; /* whether it is a store operation */
131504f73f7SAlex Bennée#             pad        : 1;
132504f73f7SAlex Bennée#     uint8_t mmuidx     : 4; /* mmuidx (softmmu only)  */
133dcdaadb6SLluís Vilanova# };
134dcdaadb6SLluís Vilanova#
13543e21e49SLluís Vilanova# Mode: user, softmmu
136dcdaadb6SLluís Vilanova# Targets: TCG(all)
137504f73f7SAlex Bennéevcpu tcg guest_mem_before(TCGv vaddr, uint16_t info) "info=%d", "vaddr=0x%016"PRIx64" info=%d"
1389c15e700SLluís Vilanova
139b15e402fSMarkus Armbruster# include/user/syscall-trace.h
140dec97760SMarkus Armbruster
1419c15e700SLluís Vilanova# @num: System call number.
1429c15e700SLluís Vilanova# @arg*: System call argument value.
1439c15e700SLluís Vilanova#
1449c15e700SLluís Vilanova# Start executing a guest system call in syscall emulation mode.
1459c15e700SLluís Vilanova#
14643e21e49SLluís Vilanova# Mode: user
1479c15e700SLluís Vilanova# Targets: TCG(all)
1485caa262fSLluís Vilanovavcpu 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
1499c15e700SLluís Vilanova
1509c15e700SLluís Vilanova# @num: System call number.
1519c15e700SLluís Vilanova# @ret: System call result value.
1529c15e700SLluís Vilanova#
1539c15e700SLluís Vilanova# Finish executing a guest system call in syscall emulation mode.
1549c15e700SLluís Vilanova#
15543e21e49SLluís Vilanova# Mode: user
1569c15e700SLluís Vilanova# Targets: TCG(all)
1575caa262fSLluís Vilanovavcpu guest_user_syscall_ret(uint64_t num, uint64_t ret) "num=0x%016"PRIx64" ret=0x%016"PRIx64
158