qapi: Fix misspelled section tags in doc comments
[qemu/armbru.git] / trace-events
blobb6b84b175e16b9741fa9416e16a1a547b802da37
1 # See docs/devel/tracing.rst for syntax documentation.
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 # 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"
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"
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"
45 # job.c
46 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)"
47 job_apply_verb(void *job, const char *state, const char *verb, const char *legal) "job %p in state %s; applying verb %s (%s)"
48 job_completed(void *job, int ret) "job %p ret %d"
50 # job-qmp.c
51 qmp_job_cancel(void *job) "job %p"
52 qmp_job_pause(void *job) "job %p"
53 qmp_job_resume(void *job) "job %p"
54 qmp_job_complete(void *job) "job %p"
55 qmp_job_finalize(void *job) "job %p"
56 qmp_job_dismiss(void *job) "job %p"
59 ### Guest events, keep at bottom
62 ## vCPU
64 # trace/control-target.c
66 # Hot-plug a new virtual (guest) CPU
68 # Mode: user, softmmu
69 # Targets: all
70 vcpu guest_cpu_enter(void)
72 # trace/control.c
74 # Hot-unplug a virtual (guest) CPU
76 # Mode: user, softmmu
77 # Targets: all
78 vcpu guest_cpu_exit(void)
80 # hw/core/cpu.c
82 # Reset the state of a virtual (guest) CPU
84 # Mode: user, softmmu
85 # Targets: all
86 vcpu guest_cpu_reset(void)
88 # include/user/syscall-trace.h
90 # @num: System call number.
91 # @arg*: System call argument value.
93 # Start executing a guest system call in syscall emulation mode.
95 # Mode: user
96 # Targets: TCG(all)
97 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
99 # @num: System call number.
100 # @ret: System call result value.
102 # Finish executing a guest system call in syscall emulation mode.
104 # Mode: user
105 # Targets: TCG(all)
106 vcpu guest_user_syscall_ret(uint64_t num, uint64_t ret) "num=0x%016"PRIx64" ret=0x%016"PRIx64