Stefano Garzarella | d0fb965 | 2021-05-17 17:16:58 +0200 | [diff] [blame] | 1 | # See docs/devel/tracing.rst for syntax documentation. |
Stefan Hajnoczi | 94a420b | 2010-05-22 17:52:39 +0100 | [diff] [blame] | 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 | # |
Stefan Hajnoczi | 1e2cf2b | 2010-05-24 11:32:09 +0100 | [diff] [blame] | 15 | # [disable] <name>(<type1> <arg1>[, <type2> <arg2>] ...) "<format-string>" |
Stefan Hajnoczi | 94a420b | 2010-05-22 17:52:39 +0100 | [diff] [blame] | 16 | # |
Frediano Ziglio | a74cd8c | 2011-08-31 09:25:35 +0200 | [diff] [blame] | 17 | # Example: g_malloc(size_t size) "size %zu" |
Stefan Hajnoczi | 94a420b | 2010-05-22 17:52:39 +0100 | [diff] [blame] | 18 | # |
Stefan Hajnoczi | 1e2cf2b | 2010-05-24 11:32:09 +0100 | [diff] [blame] | 19 | # The "disable" keyword will build without the trace event. |
Stefan Hajnoczi | 1e2cf2b | 2010-05-24 11:32:09 +0100 | [diff] [blame] | 20 | # |
Stefan Hajnoczi | 94a420b | 2010-05-22 17:52:39 +0100 | [diff] [blame] | 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. |
Stefan Hajnoczi | cd245a1 | 2010-05-22 18:09:25 +0100 | [diff] [blame] | 27 | |
Richard Henderson | ad1a706 | 2021-07-01 08:10:53 -0700 | [diff] [blame] | 28 | # cpu.c |
| 29 | breakpoint_insert(int cpu_index, uint64_t pc, int flags) "cpu=%d pc=0x%" PRIx64 " flags=0x%x" |
| 30 | breakpoint_remove(int cpu_index, uint64_t pc, int flags) "cpu=%d pc=0x%" PRIx64 " flags=0x%x" |
| 31 | breakpoint_singlestep(int cpu_index, int enabled) "cpu=%d enable=%d" |
| 32 | |
Kevin Wolf | c57c465 | 2011-11-24 06:15:28 -0500 | [diff] [blame] | 33 | # dma-helpers.c |
Paolo Bonzini | cbe0ed6 | 2016-05-23 14:54:05 +0200 | [diff] [blame] | 34 | dma_blk_io(void *dbs, void *bs, int64_t offset, bool to_dev) "dbs=%p bs=%p offset=%" PRId64 " to_dev=%d" |
Kevin Wolf | c57c465 | 2011-11-24 06:15:28 -0500 | [diff] [blame] | 35 | dma_aio_cancel(void *dbs) "dbs=%p" |
| 36 | dma_complete(void *dbs, int ret, void *cb) "dbs=%p ret=%d cb=%p" |
Markus Armbruster | 4be7463 | 2014-10-07 13:59:18 +0200 | [diff] [blame] | 37 | dma_blk_cb(void *dbs, int ret) "dbs=%p ret=%d" |
Kevin Wolf | c57c465 | 2011-11-24 06:15:28 -0500 | [diff] [blame] | 38 | dma_map_wait(void *dbs) "dbs=%p" |
Alon Levy | cdbc19d | 2012-03-11 18:11:26 +0200 | [diff] [blame] | 39 | |
Dr. David Alan Gilbert | db144f7 | 2018-03-12 17:20:56 +0000 | [diff] [blame] | 40 | # exec.c |
Dr. David Alan Gilbert | 154cc9e | 2018-01-05 17:01:37 +0000 | [diff] [blame] | 41 | find_ram_offset(uint64_t size, uint64_t offset) "size: 0x%" PRIx64 " @ 0x%" PRIx64 |
| 42 | find_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 |
Dr. David Alan Gilbert | db144f7 | 2018-03-12 17:20:56 +0000 | [diff] [blame] | 43 | ram_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" |
Markus Armbruster | b15e402 | 2020-08-06 16:13:34 +0200 | [diff] [blame] | 44 | |
| 45 | # accel/tcg/cputlb.c |
Richard Henderson | 6e050d4 | 2019-09-18 03:39:56 +0000 | [diff] [blame] | 46 | memory_notdirty_write_access(uint64_t vaddr, uint64_t ram_addr, unsigned size) "0x%" PRIx64 " ram_addr 0x%" PRIx64 " size %u" |
| 47 | memory_notdirty_set_dirty(uint64_t vaddr) "0x%" PRIx64 |
Dr. David Alan Gilbert | 154cc9e | 2018-01-05 17:01:37 +0000 | [diff] [blame] | 48 | |
Doug Gale | 5c9522b | 2017-12-02 20:30:37 -0500 | [diff] [blame] | 49 | # gdbstub.c |
Stefan Hajnoczi | 7f1d87a | 2018-02-01 16:26:25 +0000 | [diff] [blame] | 50 | gdbstub_op_start(const char *device) "Starting gdbstub using device %s" |
Doug Gale | 5c9522b | 2017-12-02 20:30:37 -0500 | [diff] [blame] | 51 | gdbstub_op_exiting(uint8_t code) "notifying exit with code=0x%02x" |
| 52 | gdbstub_op_continue(void) "Continuing all CPUs" |
| 53 | gdbstub_op_continue_cpu(int cpu_index) "Continuing CPU %d" |
| 54 | gdbstub_op_stepping(int cpu_index) "Stepping CPU %d" |
Stefan Hajnoczi | 7f1d87a | 2018-02-01 16:26:25 +0000 | [diff] [blame] | 55 | gdbstub_op_extra_info(const char *info) "Thread extra info: %s" |
| 56 | gdbstub_hit_watchpoint(const char *type, int cpu_gdb_index, uint64_t vaddr) "Watchpoint hit, type=\"%s\" cpu=%d, vaddr=0x%" PRIx64 "" |
Doug Gale | 5c9522b | 2017-12-02 20:30:37 -0500 | [diff] [blame] | 57 | gdbstub_hit_internal_error(void) "RUN_STATE_INTERNAL_ERROR" |
| 58 | gdbstub_hit_break(void) "RUN_STATE_DEBUG" |
| 59 | gdbstub_hit_paused(void) "RUN_STATE_PAUSED" |
| 60 | gdbstub_hit_shutdown(void) "RUN_STATE_SHUTDOWN" |
| 61 | gdbstub_hit_io_error(void) "RUN_STATE_IO_ERROR" |
| 62 | gdbstub_hit_watchdog(void) "RUN_STATE_WATCHDOG" |
| 63 | gdbstub_hit_unknown(int state) "Unknown run state=0x%x" |
Stefan Hajnoczi | 7f1d87a | 2018-02-01 16:26:25 +0000 | [diff] [blame] | 64 | gdbstub_io_reply(const char *message) "Sent: %s" |
| 65 | gdbstub_io_binaryreply(size_t ofs, const char *line) "0x%04zx: %s" |
| 66 | gdbstub_io_command(const char *command) "Received: %s" |
Doug Gale | 5c9522b | 2017-12-02 20:30:37 -0500 | [diff] [blame] | 67 | gdbstub_io_got_ack(void) "Got ACK" |
| 68 | gdbstub_io_got_unexpected(uint8_t ch) "Got 0x%02x when expecting ACK/NACK" |
| 69 | gdbstub_err_got_nack(void) "Got NACK, retransmitting" |
| 70 | gdbstub_err_garbage(uint8_t ch) "received garbage between packets: 0x%02x" |
| 71 | gdbstub_err_overrun(void) "command buffer overrun, dropping command" |
| 72 | gdbstub_err_invalid_repeat(uint8_t ch) "got invalid RLE count: 0x%02x" |
| 73 | gdbstub_err_invalid_rle(void) "got invalid RLE sequence" |
| 74 | gdbstub_err_checksum_invalid(uint8_t ch) "got invalid command checksum digit: 0x%02x" |
| 75 | gdbstub_err_checksum_incorrect(uint8_t expected, uint8_t got) "got command packet with incorrect checksum, expected=0x%02x, received=0x%02x" |
| 76 | |
Kevin Wolf | a50c2ab | 2018-04-13 17:19:31 +0200 | [diff] [blame] | 77 | # job.c |
| 78 | job_state_transition(void *job, int ret, const char *legal, const char *s0, const char *s1) "job %p (ret: %d) attempting %s transition (%s-->%s)" |
| 79 | job_apply_verb(void *job, const char *state, const char *verb, const char *legal) "job %p in state %s; applying verb %s (%s)" |
John Snow | 404ff28 | 2018-08-29 21:57:33 -0400 | [diff] [blame] | 80 | job_completed(void *job, int ret) "job %p ret %d" |
Kevin Wolf | a50c2ab | 2018-04-13 17:19:31 +0200 | [diff] [blame] | 81 | |
Kevin Wolf | 1a90bc8 | 2018-05-03 19:01:14 +0200 | [diff] [blame] | 82 | # job-qmp.c |
| 83 | qmp_job_cancel(void *job) "job %p" |
| 84 | qmp_job_pause(void *job) "job %p" |
| 85 | qmp_job_resume(void *job) "job %p" |
| 86 | qmp_job_complete(void *job) "job %p" |
| 87 | qmp_job_finalize(void *job) "job %p" |
| 88 | qmp_job_dismiss(void *job) "job %p" |
| 89 | |
| 90 | |
Lluís Vilanova | dcdaadb | 2016-06-09 19:31:47 +0200 | [diff] [blame] | 91 | ### Guest events, keep at bottom |
| 92 | |
Lluís Vilanova | b9d7221 | 2016-09-19 14:55:13 +0200 | [diff] [blame] | 93 | |
| 94 | ## vCPU |
| 95 | |
Markus Armbruster | dec9776 | 2019-03-14 19:09:29 +0100 | [diff] [blame] | 96 | # trace/control-target.c |
| 97 | |
Lluís Vilanova | b9d7221 | 2016-09-19 14:55:13 +0200 | [diff] [blame] | 98 | # Hot-plug a new virtual (guest) CPU |
| 99 | # |
Lluís Vilanova | f5e2b3b | 2016-10-05 14:03:29 +0200 | [diff] [blame] | 100 | # Mode: user, softmmu |
Lluís Vilanova | b9d7221 | 2016-09-19 14:55:13 +0200 | [diff] [blame] | 101 | # Targets: all |
| 102 | vcpu guest_cpu_enter(void) |
| 103 | |
Markus Armbruster | dec9776 | 2019-03-14 19:09:29 +0100 | [diff] [blame] | 104 | # trace/control.c |
| 105 | |
Lluís Vilanova | a47e871 | 2016-12-26 22:24:46 +0100 | [diff] [blame] | 106 | # Hot-unplug a virtual (guest) CPU |
| 107 | # |
| 108 | # Mode: user, softmmu |
| 109 | # Targets: all |
| 110 | vcpu guest_cpu_exit(void) |
| 111 | |
Markus Armbruster | 2e5b09f | 2019-07-09 17:20:52 +0200 | [diff] [blame] | 112 | # hw/core/cpu.c |
Markus Armbruster | dec9776 | 2019-03-14 19:09:29 +0100 | [diff] [blame] | 113 | |
Lluís Vilanova | 2cc2d08 | 2016-09-19 14:55:18 +0200 | [diff] [blame] | 114 | # Reset the state of a virtual (guest) CPU |
| 115 | # |
Lluís Vilanova | f5e2b3b | 2016-10-05 14:03:29 +0200 | [diff] [blame] | 116 | # Mode: user, softmmu |
Lluís Vilanova | 2cc2d08 | 2016-09-19 14:55:18 +0200 | [diff] [blame] | 117 | # Targets: all |
| 118 | vcpu guest_cpu_reset(void) |
| 119 | |
Markus Armbruster | b15e402 | 2020-08-06 16:13:34 +0200 | [diff] [blame] | 120 | # include/user/syscall-trace.h |
Markus Armbruster | dec9776 | 2019-03-14 19:09:29 +0100 | [diff] [blame] | 121 | |
Lluís Vilanova | 9c15e70 | 2016-06-21 15:52:04 +0200 | [diff] [blame] | 122 | # @num: System call number. |
| 123 | # @arg*: System call argument value. |
| 124 | # |
| 125 | # Start executing a guest system call in syscall emulation mode. |
| 126 | # |
Lluís Vilanova | 43e21e4 | 2016-09-22 20:40:21 +0200 | [diff] [blame] | 127 | # Mode: user |
Lluís Vilanova | 9c15e70 | 2016-06-21 15:52:04 +0200 | [diff] [blame] | 128 | # Targets: TCG(all) |
Lluís Vilanova | 5caa262 | 2017-07-04 10:54:52 +0200 | [diff] [blame] | 129 | 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 |
Lluís Vilanova | 9c15e70 | 2016-06-21 15:52:04 +0200 | [diff] [blame] | 130 | |
| 131 | # @num: System call number. |
| 132 | # @ret: System call result value. |
| 133 | # |
| 134 | # Finish executing a guest system call in syscall emulation mode. |
| 135 | # |
Lluís Vilanova | 43e21e4 | 2016-09-22 20:40:21 +0200 | [diff] [blame] | 136 | # Mode: user |
Lluís Vilanova | 9c15e70 | 2016-06-21 15:52:04 +0200 | [diff] [blame] | 137 | # Targets: TCG(all) |
Lluís Vilanova | 5caa262 | 2017-07-04 10:54:52 +0200 | [diff] [blame] | 138 | vcpu guest_user_syscall_ret(uint64_t num, uint64_t ret) "num=0x%016"PRIx64" ret=0x%016"PRIx64 |