Stefano Garzarella | d0fb965 | 2021-05-17 17:16:58 +0200 | [diff] [blame] | 1 | # See docs/devel/tracing.rst for syntax documentation. |
Stefan Hajnoczi | 94a420b | 2010-05-22 17:52:39 +0100 | [diff] [blame] | 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 | # |
Stefan Hajnoczi | 1e2cf2b | 2010-05-24 11:32:09 +0100 | [diff] [blame] | 15 | # [disable] <name>(<type1> <arg1>[, <type2> <arg2>] ...) "<format-string>" |
Stefan Hajnoczi | 94a420b | 2010-05-22 17:52:39 +0100 | [diff] [blame] | 16 | # |
Frediano Ziglio | a74cd8c | 2011-08-31 09:25:35 +0200 | [diff] [blame] | 17 | # Example: g_malloc(size_t size) "size %zu" |
Stefan Hajnoczi | 94a420b | 2010-05-22 17:52:39 +0100 | [diff] [blame] | 18 | # |
Stefan Hajnoczi | 1e2cf2b | 2010-05-24 11:32:09 +0100 | [diff] [blame] | 19 | # The "disable" keyword will build without the trace event. |
Stefan Hajnoczi | 1e2cf2b | 2010-05-24 11:32:09 +0100 | [diff] [blame] | 20 | # |
Stefan Hajnoczi | 94a420b | 2010-05-22 17:52:39 +0100 | [diff] [blame] | 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. |
Stefan Hajnoczi | cd245a1 | 2010-05-22 18:09:25 +0100 | [diff] [blame] | 27 | |
Richard Henderson | ad1a706 | 2021-07-01 08:10:53 -0700 | [diff] [blame] | 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" |
| 32 | |
Kevin Wolf | c57c465 | 2011-11-24 06:15:28 -0500 | [diff] [blame] | 33 | # dma-helpers.c |
Paolo Bonzini | cbe0ed6 | 2016-05-23 14:54:05 +0200 | [diff] [blame] | 34 | dma_blk_io(void *dbs, void *bs, int64_t offset, bool to_dev) "dbs=%p bs=%p offset=%" PRId64 " to_dev=%d" |
Kevin Wolf | c57c465 | 2011-11-24 06:15:28 -0500 | [diff] [blame] | 35 | dma_aio_cancel(void *dbs) "dbs=%p" |
| 36 | dma_complete(void *dbs, int ret, void *cb) "dbs=%p ret=%d cb=%p" |
Markus Armbruster | 4be7463 | 2014-10-07 13:59:18 +0200 | [diff] [blame] | 37 | dma_blk_cb(void *dbs, int ret) "dbs=%p ret=%d" |
Kevin Wolf | c57c465 | 2011-11-24 06:15:28 -0500 | [diff] [blame] | 38 | dma_map_wait(void *dbs) "dbs=%p" |
Alon Levy | cdbc19d | 2012-03-11 18:11:26 +0200 | [diff] [blame] | 39 | |
Kevin Wolf | a50c2ab | 2018-04-13 17:19:31 +0200 | [diff] [blame] | 40 | # job.c |
| 41 | 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)" |
| 42 | job_apply_verb(void *job, const char *state, const char *verb, const char *legal) "job %p in state %s; applying verb %s (%s)" |
John Snow | 404ff28 | 2018-08-29 21:57:33 -0400 | [diff] [blame] | 43 | job_completed(void *job, int ret) "job %p ret %d" |
Kevin Wolf | a50c2ab | 2018-04-13 17:19:31 +0200 | [diff] [blame] | 44 | |
Kevin Wolf | 1a90bc8 | 2018-05-03 19:01:14 +0200 | [diff] [blame] | 45 | # job-qmp.c |
| 46 | qmp_job_cancel(void *job) "job %p" |
| 47 | qmp_job_pause(void *job) "job %p" |
| 48 | qmp_job_resume(void *job) "job %p" |
| 49 | qmp_job_complete(void *job) "job %p" |
| 50 | qmp_job_finalize(void *job) "job %p" |
| 51 | qmp_job_dismiss(void *job) "job %p" |