xref: /openbmc/qemu/trace-events (revision 7d87775f)
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
29breakpoint_insert(int cpu_index, uint64_t pc, int flags) "cpu=%d pc=0x%" PRIx64 " flags=0x%x"
30breakpoint_remove(int cpu_index, uint64_t pc, int flags) "cpu=%d pc=0x%" PRIx64 " flags=0x%x"
31breakpoint_singlestep(int cpu_index, int enabled) "cpu=%d enable=%d"
32
33# job.c
34job_state_transition(void *job,  int ret, const char *legal, const char *s0, const char *s1) "job %p (ret: %d) attempting %s transition (%s-->%s)"
35job_apply_verb(void *job, const char *state, const char *verb, const char *legal) "job %p in state %s; applying verb %s (%s)"
36job_completed(void *job, int ret) "job %p ret %d"
37
38# job-qmp.c
39qmp_job_cancel(void *job) "job %p"
40qmp_job_pause(void *job) "job %p"
41qmp_job_resume(void *job) "job %p"
42qmp_job_complete(void *job) "job %p"
43qmp_job_finalize(void *job) "job %p"
44qmp_job_dismiss(void *job) "job %p"
45