trace-events - qemu - Git at Google

 # Trace events for debugging and performance instrumentation
 #
 # This file is processed by the tracetool script during the build.
 #
 # To add a new trace event:
 #
 # 1. Choose a name for the trace event.  Declare its arguments and format
 #    string.
 #
 # 2. Call the trace event from code using trace_##name, e.g. multiwrite_cb() ->
 #    trace_multiwrite_cb().  The source file must #include "trace.h".
 #
 # Format of a trace event:
 #
 # [disable] <name>(<type1> <arg1>[, <type2> <arg2>] ...) "<format-string>"
 #
 # Example: g_malloc(size_t size) "size %zu"
 #
 # The "disable" keyword will build without the trace event.
 #
 # The <name> must be a valid as a C function name.
 #
 # Types should be standard C types.  Use void * for pointers because the trace
 # system may not have the necessary headers included.
 #
 # The <format-string> should be a sprintf()-compatible format string.

 # ioport.c
 cpu_in(unsigned int addr, char size, unsigned int val) "addr 0x%x(%c) value %u"
 cpu_out(unsigned int addr, char size, unsigned int val) "addr 0x%x(%c) value %u"

 # balloon.c
 # Since requests are raised via monitor, not many tracepoints are needed.
 balloon_event(void *opaque, unsigned long addr) "opaque %p addr %lu"

 # vl.c
 vm_state_notify(int running, int reason) "running %d reason %d"
 load_file(const char *name, const char *path) "name %s location %s"
 runstate_set(int new_state) "new state %d"
 system_wakeup_request(int reason) "reason=%d"
 qemu_system_shutdown_request(int reason) "reason=%d"
 qemu_system_powerdown_request(void) ""

 # monitor.c
 monitor_protocol_event_handler(uint32_t event, void *qdict) "event=%d data=%p"
 monitor_protocol_event_emit(uint32_t event, void *data) "event=%d data=%p"
 monitor_protocol_event_queue(uint32_t event, void *qdict, uint64_t rate) "event=%d data=%p rate=%" PRId64
 handle_hmp_command(void *mon, const char *cmdline) "mon %p cmdline: %s"
 handle_qmp_command(void *mon, const char *req) "mon %p req: %s"
 monitor_suspend(void *ptr, int cnt) "mon %p: %d"
 monitor_qmp_cmd_in_band(const char *id) "%s"
 monitor_qmp_cmd_out_of_band(const char *id) "%s"

 # dma-helpers.c
 dma_blk_io(void *dbs, void *bs, int64_t offset, bool to_dev) "dbs=%p bs=%p offset=%" PRId64 " to_dev=%d"
 dma_aio_cancel(void *dbs) "dbs=%p"
 dma_complete(void *dbs, int ret, void *cb) "dbs=%p ret=%d cb=%p"
 dma_blk_cb(void *dbs, int ret) "dbs=%p ret=%d"
 dma_map_wait(void *dbs) "dbs=%p"

 # exec.c
 find_ram_offset(uint64_t size, uint64_t offset) "size: 0x%" PRIx64 " @ 0x%" PRIx64
 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
 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"

 # memory.c
 memory_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"
 memory_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"
 memory_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"
 memory_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"
 memory_region_tb_read(int cpu_index, uint64_t addr, uint64_t value, unsigned size) "cpu %d addr 0x%"PRIx64" value 0x%"PRIx64" size %u"
 memory_region_tb_write(int cpu_index, uint64_t addr, uint64_t value, unsigned size) "cpu %d addr 0x%"PRIx64" value 0x%"PRIx64" size %u"
 memory_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"
 memory_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"
 flatview_new(void *view, void *root) "%p (root %p)"
 flatview_destroy(void *view, void *root) "%p (root %p)"
 flatview_destroy_rcu(void *view, void *root) "%p (root %p)"

 # gdbstub.c
 gdbstub_op_start(const char *device) "Starting gdbstub using device %s"
 gdbstub_op_exiting(uint8_t code) "notifying exit with code=0x%02x"
 gdbstub_op_continue(void) "Continuing all CPUs"
 gdbstub_op_continue_cpu(int cpu_index) "Continuing CPU %d"
 gdbstub_op_stepping(int cpu_index) "Stepping CPU %d"
 gdbstub_op_extra_info(const char *info) "Thread extra info: %s"
 gdbstub_hit_watchpoint(const char *type, int cpu_gdb_index, uint64_t vaddr) "Watchpoint hit, type=\"%s\" cpu=%d, vaddr=0x%" PRIx64 ""
 gdbstub_hit_internal_error(void) "RUN_STATE_INTERNAL_ERROR"
 gdbstub_hit_break(void) "RUN_STATE_DEBUG"
 gdbstub_hit_paused(void) "RUN_STATE_PAUSED"
 gdbstub_hit_shutdown(void) "RUN_STATE_SHUTDOWN"
 gdbstub_hit_io_error(void) "RUN_STATE_IO_ERROR"
 gdbstub_hit_watchdog(void) "RUN_STATE_WATCHDOG"
 gdbstub_hit_unknown(int state) "Unknown run state=0x%x"
 gdbstub_io_reply(const char *message) "Sent: %s"
 gdbstub_io_binaryreply(size_t ofs, const char *line) "0x%04zx: %s"
 gdbstub_io_command(const char *command) "Received: %s"
 gdbstub_io_got_ack(void) "Got ACK"
 gdbstub_io_got_unexpected(uint8_t ch) "Got 0x%02x when expecting ACK/NACK"
 gdbstub_err_got_nack(void) "Got NACK, retransmitting"
 gdbstub_err_garbage(uint8_t ch) "received garbage between packets: 0x%02x"
 gdbstub_err_overrun(void) "command buffer overrun, dropping command"
 gdbstub_err_invalid_repeat(uint8_t ch) "got invalid RLE count: 0x%02x"
 gdbstub_err_invalid_rle(void) "got invalid RLE sequence"
 gdbstub_err_checksum_invalid(uint8_t ch) "got invalid command checksum digit: 0x%02x"
 gdbstub_err_checksum_incorrect(uint8_t expected, uint8_t got) "got command packet with incorrect checksum, expected=0x%02x, received=0x%02x"

 # job.c
 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)"
 job_apply_verb(void *job, const char *state, const char *verb, const char *legal) "job %p in state %s; applying verb %s (%s)"

 ### Guest events, keep at bottom


 ## vCPU

 # Hot-plug a new virtual (guest) CPU
 #
 # Mode: user, softmmu
 # Targets: all
 vcpu guest_cpu_enter(void)

 # Hot-unplug a virtual (guest) CPU
 #
 # Mode: user, softmmu
 # Targets: all
 vcpu guest_cpu_exit(void)

 # Reset the state of a virtual (guest) CPU
 #
 # Mode: user, softmmu
 # Targets: all
 vcpu guest_cpu_reset(void)

 # @vaddr: Access' virtual address.
 # @info : Access' information (see below).
 #
 # Start virtual memory access (before any potential access violation).
 #
 # Does not include memory accesses performed by devices.
 #
 # Access information can be parsed as:
 #
 # struct mem_info {
 #     uint8_t size_shift : 2; /* interpreted as "1 << size_shift" bytes */
 #     bool    sign_extend: 1; /* sign-extended */
 #     uint8_t endianness : 1; /* 0: little, 1: big */
 #     bool    store      : 1; /* wheter it's a store operation */
 # };
 #
 # Mode: user, softmmu
 # Targets: TCG(all)
 vcpu tcg guest_mem_before(TCGv vaddr, uint8_t info) "info=%d", "vaddr=0x%016"PRIx64" info=%d"

 # @num: System call number.
 # @arg*: System call argument value.
 #
 # Start executing a guest system call in syscall emulation mode.
 #
 # Mode: user
 # Targets: TCG(all)
 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

 # @num: System call number.
 # @ret: System call result value.
 #
 # Finish executing a guest system call in syscall emulation mode.
 #
 # Mode: user
 # Targets: TCG(all)
 vcpu guest_user_syscall_ret(uint64_t num, uint64_t ret) "num=0x%016"PRIx64" ret=0x%016"PRIx64
	# Trace events for debugging and performance instrumentation
	#
	# This file is processed by the tracetool script during the build.
	#
	# To add a new trace event:
	#
	# 1. Choose a name for the trace event. Declare its arguments and format
	# string.
	#
	# 2. Call the trace event from code using trace_##name, e.g. multiwrite_cb() ->
	# trace_multiwrite_cb(). The source file must #include "trace.h".
	#
	# Format of a trace event:
	#
	# [disable] <name>(<type1> <arg1>[, <type2> <arg2>] ...) "<format-string>"
	#
	# Example: g_malloc(size_t size) "size %zu"
	#
	# The "disable" keyword will build without the trace event.
	#
	# The <name> must be a valid as a C function name.
	#
	# Types should be standard C types. Use void * for pointers because the trace
	# system may not have the necessary headers included.
	#
	# The <format-string> should be a sprintf()-compatible format string.

	# ioport.c
	cpu_in(unsigned int addr, char size, unsigned int val) "addr 0x%x(%c) value %u"
	cpu_out(unsigned int addr, char size, unsigned int val) "addr 0x%x(%c) value %u"

	# balloon.c
	# Since requests are raised via monitor, not many tracepoints are needed.
	balloon_event(void *opaque, unsigned long addr) "opaque %p addr %lu"

	# vl.c
	vm_state_notify(int running, int reason) "running %d reason %d"
	load_file(const char name, const char path) "name %s location %s"
	runstate_set(int new_state) "new state %d"
	system_wakeup_request(int reason) "reason=%d"
	qemu_system_shutdown_request(int reason) "reason=%d"
	qemu_system_powerdown_request(void) ""

	# monitor.c
	monitor_protocol_event_handler(uint32_t event, void *qdict) "event=%d data=%p"
	monitor_protocol_event_emit(uint32_t event, void *data) "event=%d data=%p"
	monitor_protocol_event_queue(uint32_t event, void *qdict, uint64_t rate) "event=%d data=%p rate=%" PRId64
	handle_hmp_command(void mon, const char cmdline) "mon %p cmdline: %s"
	handle_qmp_command(void mon, const char req) "mon %p req: %s"
	monitor_suspend(void *ptr, int cnt) "mon %p: %d"
	monitor_qmp_cmd_in_band(const char *id) "%s"
	monitor_qmp_cmd_out_of_band(const char *id) "%s"

	# dma-helpers.c
	dma_blk_io(void dbs, void bs, int64_t offset, bool to_dev) "dbs=%p bs=%p offset=%" PRId64 " to_dev=%d"
	dma_aio_cancel(void *dbs) "dbs=%p"
	dma_complete(void dbs, int ret, void cb) "dbs=%p ret=%d cb=%p"
	dma_blk_cb(void *dbs, int ret) "dbs=%p ret=%d"
	dma_map_wait(void *dbs) "dbs=%p"

	# exec.c
	find_ram_offset(uint64_t size, uint64_t offset) "size: 0x%" PRIx64 " @ 0x%" PRIx64
	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
	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"

	# memory.c
	memory_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"
	memory_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"
	memory_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"
	memory_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"
	memory_region_tb_read(int cpu_index, uint64_t addr, uint64_t value, unsigned size) "cpu %d addr 0x%"PRIx64" value 0x%"PRIx64" size %u"
	memory_region_tb_write(int cpu_index, uint64_t addr, uint64_t value, unsigned size) "cpu %d addr 0x%"PRIx64" value 0x%"PRIx64" size %u"
	memory_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"
	memory_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"
	flatview_new(void view, void root) "%p (root %p)"
	flatview_destroy(void view, void root) "%p (root %p)"
	flatview_destroy_rcu(void view, void root) "%p (root %p)"

	# gdbstub.c
	gdbstub_op_start(const char *device) "Starting gdbstub using device %s"
	gdbstub_op_exiting(uint8_t code) "notifying exit with code=0x%02x"
	gdbstub_op_continue(void) "Continuing all CPUs"
	gdbstub_op_continue_cpu(int cpu_index) "Continuing CPU %d"
	gdbstub_op_stepping(int cpu_index) "Stepping CPU %d"
	gdbstub_op_extra_info(const char *info) "Thread extra info: %s"
	gdbstub_hit_watchpoint(const char *type, int cpu_gdb_index, uint64_t vaddr) "Watchpoint hit, type=\"%s\" cpu=%d, vaddr=0x%" PRIx64 ""
	gdbstub_hit_internal_error(void) "RUN_STATE_INTERNAL_ERROR"
	gdbstub_hit_break(void) "RUN_STATE_DEBUG"
	gdbstub_hit_paused(void) "RUN_STATE_PAUSED"
	gdbstub_hit_shutdown(void) "RUN_STATE_SHUTDOWN"
	gdbstub_hit_io_error(void) "RUN_STATE_IO_ERROR"
	gdbstub_hit_watchdog(void) "RUN_STATE_WATCHDOG"
	gdbstub_hit_unknown(int state) "Unknown run state=0x%x"
	gdbstub_io_reply(const char *message) "Sent: %s"
	gdbstub_io_binaryreply(size_t ofs, const char *line) "0x%04zx: %s"
	gdbstub_io_command(const char *command) "Received: %s"
	gdbstub_io_got_ack(void) "Got ACK"
	gdbstub_io_got_unexpected(uint8_t ch) "Got 0x%02x when expecting ACK/NACK"
	gdbstub_err_got_nack(void) "Got NACK, retransmitting"
	gdbstub_err_garbage(uint8_t ch) "received garbage between packets: 0x%02x"
	gdbstub_err_overrun(void) "command buffer overrun, dropping command"
	gdbstub_err_invalid_repeat(uint8_t ch) "got invalid RLE count: 0x%02x"
	gdbstub_err_invalid_rle(void) "got invalid RLE sequence"
	gdbstub_err_checksum_invalid(uint8_t ch) "got invalid command checksum digit: 0x%02x"
	gdbstub_err_checksum_incorrect(uint8_t expected, uint8_t got) "got command packet with incorrect checksum, expected=0x%02x, received=0x%02x"

	# job.c
	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)"
	job_apply_verb(void job, const char state, const char verb, const char legal) "job %p in state %s; applying verb %s (%s)"

	### Guest events, keep at bottom


	## vCPU

	# Hot-plug a new virtual (guest) CPU
	#
	# Mode: user, softmmu
	# Targets: all
	vcpu guest_cpu_enter(void)

	# Hot-unplug a virtual (guest) CPU
	#
	# Mode: user, softmmu
	# Targets: all
	vcpu guest_cpu_exit(void)

	# Reset the state of a virtual (guest) CPU
	#
	# Mode: user, softmmu
	# Targets: all
	vcpu guest_cpu_reset(void)

	# @vaddr: Access' virtual address.
	# @info : Access' information (see below).
	#
	# Start virtual memory access (before any potential access violation).
	#
	# Does not include memory accesses performed by devices.
	#
	# Access information can be parsed as:
	#
	# struct mem_info {
	# uint8_t size_shift : 2; /* interpreted as "1 << size_shift" bytes */
	# bool sign_extend: 1; /* sign-extended */
	# uint8_t endianness : 1; /* 0: little, 1: big */
	# bool store : 1; /* wheter it's a store operation */
	# };
	#
	# Mode: user, softmmu
	# Targets: TCG(all)
	vcpu tcg guest_mem_before(TCGv vaddr, uint8_t info) "info=%d", "vaddr=0x%016"PRIx64" info=%d"

	# @num: System call number.
	# @arg*: System call argument value.
	#
	# Start executing a guest system call in syscall emulation mode.
	#
	# Mode: user
	# Targets: TCG(all)
	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

	# @num: System call number.
	# @ret: System call result value.
	#
	# Finish executing a guest system call in syscall emulation mode.
	#
	# Mode: user
	# Targets: TCG(all)
	vcpu guest_user_syscall_ret(uint64_t num, uint64_t ret) "num=0x%016"PRIx64" ret=0x%016"PRIx64