blob: 9cb96f64c4a1edb1b978da49d3a0a59b26cda5b8 [file] [log] [blame]
Stefano Garzarellad0fb9652021-05-17 17:16:58 +02001# See docs/devel/tracing.rst for syntax documentation.
Stefan Hajnoczi94a420b2010-05-22 17:52:39 +01002#
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#
Stefan Hajnoczi1e2cf2b2010-05-24 11:32:09 +010015# [disable] <name>(<type1> <arg1>[, <type2> <arg2>] ...) "<format-string>"
Stefan Hajnoczi94a420b2010-05-22 17:52:39 +010016#
Frediano Ziglioa74cd8c2011-08-31 09:25:35 +020017# Example: g_malloc(size_t size) "size %zu"
Stefan Hajnoczi94a420b2010-05-22 17:52:39 +010018#
Stefan Hajnoczi1e2cf2b2010-05-24 11:32:09 +010019# The "disable" keyword will build without the trace event.
Stefan Hajnoczi1e2cf2b2010-05-24 11:32:09 +010020#
Stefan Hajnoczi94a420b2010-05-22 17:52:39 +010021# 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.
Stefan Hajnoczicd245a12010-05-22 18:09:25 +010027
Richard Hendersonad1a7062021-07-01 08:10:53 -070028# 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
Kevin Wolfc57c4652011-11-24 06:15:28 -050033# dma-helpers.c
Paolo Bonzinicbe0ed62016-05-23 14:54:05 +020034dma_blk_io(void *dbs, void *bs, int64_t offset, bool to_dev) "dbs=%p bs=%p offset=%" PRId64 " to_dev=%d"
Kevin Wolfc57c4652011-11-24 06:15:28 -050035dma_aio_cancel(void *dbs) "dbs=%p"
36dma_complete(void *dbs, int ret, void *cb) "dbs=%p ret=%d cb=%p"
Markus Armbruster4be74632014-10-07 13:59:18 +020037dma_blk_cb(void *dbs, int ret) "dbs=%p ret=%d"
Kevin Wolfc57c4652011-11-24 06:15:28 -050038dma_map_wait(void *dbs) "dbs=%p"
Alon Levycdbc19d2012-03-11 18:11:26 +020039
Kevin Wolfa50c2ab2018-04-13 17:19:31 +020040# job.c
41job_state_transition(void *job, int ret, const char *legal, const char *s0, const char *s1) "job %p (ret: %d) attempting %s transition (%s-->%s)"
42job_apply_verb(void *job, const char *state, const char *verb, const char *legal) "job %p in state %s; applying verb %s (%s)"
John Snow404ff282018-08-29 21:57:33 -040043job_completed(void *job, int ret) "job %p ret %d"
Kevin Wolfa50c2ab2018-04-13 17:19:31 +020044
Kevin Wolf1a90bc82018-05-03 19:01:14 +020045# job-qmp.c
46qmp_job_cancel(void *job) "job %p"
47qmp_job_pause(void *job) "job %p"
48qmp_job_resume(void *job) "job %p"
49qmp_job_complete(void *job) "job %p"
50qmp_job_finalize(void *job) "job %p"
51qmp_job_dismiss(void *job) "job %p"