trace-events

   1 # See docs/devel/tracing.rst 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 # 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
  33 # dma-helpers.c
  34 dma_blk_io(void *dbs, void *bs, int64_t offset, bool to_dev) "dbs=%p bs=%p offset=%" PRId64 " to_dev=%d"
  35 dma_aio_cancel(void *dbs) "dbs=%p"
  36 dma_complete(void *dbs, int ret, void *cb) "dbs=%p ret=%d cb=%p"
  37 dma_blk_cb(void *dbs, int ret) "dbs=%p ret=%d"
  38 dma_map_wait(void *dbs) "dbs=%p"
  39
  40 # exec.c
  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
  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"
  44
  45 # accel/tcg/cputlb.c
  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
  48
  49 # gdbstub.c
  50 gdbstub_op_start(const char *device) "Starting gdbstub using device %s"
  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"
  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 ""
  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"
  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"
  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
  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)"
  80 job_completed(void *job, int ret) "job %p ret %d"
  81
  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
  91 ### Guest events, keep at bottom
  92
  93
  94 ## vCPU
  95
  96 # trace/control-target.c
  97
  98 # Hot-plug a new virtual (guest) CPU
  99 #
 100 # Mode: user, softmmu
 101 # Targets: all
 102 vcpu guest_cpu_enter(void)
 103
 104 # trace/control.c
 105
 106 # Hot-unplug a virtual (guest) CPU
 107 #
 108 # Mode: user, softmmu
 109 # Targets: all
 110 vcpu guest_cpu_exit(void)
 111
 112 # hw/core/cpu.c
 113
 114 # Reset the state of a virtual (guest) CPU
 115 #
 116 # Mode: user, softmmu
 117 # Targets: all
 118 vcpu guest_cpu_reset(void)
 119
 120 # tcg/tcg-op.c
 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 : 4; /* 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; /* whether it is a store operation */
 136 #             pad        : 1;
 137 #     uint8_t mmuidx     : 4; /* mmuidx (softmmu only)  */
 138 # };
 139 #
 140 # Mode: user, softmmu
 141 # Targets: TCG(all)
 142 vcpu tcg guest_mem_before(TCGv vaddr, uint16_t info) "info=%d", "vaddr=0x%016"PRIx64" info=%d"
 143
 144 # include/user/syscall-trace.h
 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)
 153 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
 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)
 162 vcpu guest_user_syscall_ret(uint64_t num, uint64_t ret) "num=0x%016"PRIx64" ret=0x%016"PRIx64