include/hw/ptimer.h: Add documentation comments
[qemu/ar7.git] / trace-events
blobbae63fdb1db54f8000a8312d6291444ecb295fec
1 # Trace events for debugging and performance instrumentation
3 # This file is processed by the tracetool script during the build.
5 # To add a new trace event:
7 # 1. Choose a name for the trace event.  Declare its arguments and format
8 #    string.
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".
13 # Format of a trace event:
15 # [disable] <name>(<type1> <arg1>[, <type2> <arg2>] ...) "<format-string>"
17 # Example: g_malloc(size_t size) "size %zu"
19 # The "disable" keyword will build without the trace event.
21 # The <name> must be a valid as a C function name.
23 # Types should be standard C types.  Use void * for pointers because the trace
24 # system may not have the necessary headers included.
26 # The <format-string> should be a sprintf()-compatible format string.
28 # ioport.c
29 cpu_in(unsigned int addr, char size, unsigned int val) "addr %#x(%c) value %u"
30 cpu_out(unsigned int addr, char size, unsigned int val) "addr %#x(%c) value %u"
32 # balloon.c
33 # Since requests are raised via monitor, not many tracepoints are needed.
34 balloon_event(void *opaque, unsigned long addr) "opaque %p addr %lu"
36 # vl.c
37 vm_state_notify(int running, int reason) "running %d reason %d"
38 load_file(const char *name, const char *path) "name %s location %s"
39 runstate_set(int new_state) "new state %d"
40 system_wakeup_request(int reason) "reason=%d"
41 qemu_system_shutdown_request(int reason) "reason=%d"
42 qemu_system_powerdown_request(void) ""
44 # monitor.c
45 monitor_protocol_event_handler(uint32_t event, void *qdict) "event=%d data=%p"
46 monitor_protocol_event_emit(uint32_t event, void *data) "event=%d data=%p"
47 monitor_protocol_event_queue(uint32_t event, void *qdict, uint64_t rate) "event=%d data=%p rate=%" PRId64
48 handle_hmp_command(void *mon, const char *cmdline) "mon %p cmdline: %s"
49 handle_qmp_command(void *mon, const char *req) "mon %p req: %s"
51 # dma-helpers.c
52 dma_blk_io(void *dbs, void *bs, int64_t offset, bool to_dev) "dbs=%p bs=%p offset=%" PRId64 " to_dev=%d"
53 dma_aio_cancel(void *dbs) "dbs=%p"
54 dma_complete(void *dbs, int ret, void *cb) "dbs=%p ret=%d cb=%p"
55 dma_blk_cb(void *dbs, int ret) "dbs=%p ret=%d"
56 dma_map_wait(void *dbs) "dbs=%p"
58 # memory.c
59 memory_region_ops_read(int cpu_index, void *mr, uint64_t addr, uint64_t value, unsigned size) "cpu %d mr %p addr %#"PRIx64" value %#"PRIx64" size %u"
60 memory_region_ops_write(int cpu_index, void *mr, uint64_t addr, uint64_t value, unsigned size) "cpu %d mr %p addr %#"PRIx64" value %#"PRIx64" size %u"
61 memory_region_subpage_read(int cpu_index, void *mr, uint64_t offset, uint64_t value, unsigned size) "cpu %d mr %p offset %#"PRIx64" value %#"PRIx64" size %u"
62 memory_region_subpage_write(int cpu_index, void *mr, uint64_t offset, uint64_t value, unsigned size) "cpu %d mr %p offset %#"PRIx64" value %#"PRIx64" size %u"
63 memory_region_tb_read(int cpu_index, uint64_t addr, uint64_t value, unsigned size) "cpu %d addr %#"PRIx64" value %#"PRIx64" size %u"
64 memory_region_tb_write(int cpu_index, uint64_t addr, uint64_t value, unsigned size) "cpu %d addr %#"PRIx64" value %#"PRIx64" size %u"
65 memory_region_ram_device_read(int cpu_index, void *mr, uint64_t addr, uint64_t value, unsigned size) "cpu %d mr %p addr %#"PRIx64" value %#"PRIx64" size %u"
66 memory_region_ram_device_write(int cpu_index, void *mr, uint64_t addr, uint64_t value, unsigned size) "cpu %d mr %p addr %#"PRIx64" value %#"PRIx64" size %u"
68 ### Guest events, keep at bottom
71 ## vCPU
73 # Hot-plug a new virtual (guest) CPU
75 # Mode: user, softmmu
76 # Targets: all
77 vcpu guest_cpu_enter(void)
79 # Hot-unplug a virtual (guest) CPU
81 # Mode: user, softmmu
82 # Targets: all
83 vcpu guest_cpu_exit(void)
85 # Reset the state of a virtual (guest) CPU
87 # Mode: user, softmmu
88 # Targets: all
89 vcpu guest_cpu_reset(void)
91 # @vaddr: Access' virtual address.
92 # @info : Access' information (see below).
94 # Start virtual memory access (before any potential access violation).
96 # Does not include memory accesses performed by devices.
98 # Access information can be parsed as:
100 # struct mem_info {
101 #     uint8_t size_shift : 2; /* interpreted as "1 << size_shift" bytes */
102 #     bool    sign_extend: 1; /* sign-extended */
103 #     uint8_t endianness : 1; /* 0: little, 1: big */
104 #     bool    store      : 1; /* wheter it's a store operation */
105 # };
107 # Mode: user, softmmu
108 # Targets: TCG(all)
109 disable vcpu tcg guest_mem_before(TCGv vaddr, uint8_t info) "info=%d", "vaddr=0x%016"PRIx64" info=%d"
111 # @num: System call number.
112 # @arg*: System call argument value.
114 # Start executing a guest system call in syscall emulation mode.
116 # Mode: user
117 # Targets: TCG(all)
118 disable 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
120 # @num: System call number.
121 # @ret: System call result value.
123 # Finish executing a guest system call in syscall emulation mode.
125 # Mode: user
126 # Targets: TCG(all)
127 disable vcpu guest_user_syscall_ret(uint64_t num, uint64_t ret) "num=0x%016"PRIx64" ret=0x%016"PRIx64