blob: d2f2bbc59862c72e851ccb8b3850eeae355e7275 [file] [log] [blame]
Stefan Hajnoczi94a420b2010-05-22 17:52:39 +01001# Trace events for debugging and performance instrumentation
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 Hajnoczi1e2cf2b2010-05-24 11:32:09 +010015# [disable] <name>(<type1> <arg1>[, <type2> <arg2>] ...) "<format-string>"
Stefan Hajnoczi94a420b2010-05-22 17:52:39 +010016#
17# Example: qemu_malloc(size_t size) "size %zu"
18#
Stefan Hajnoczi1e2cf2b2010-05-24 11:32:09 +010019# The "disable" keyword will build without the trace event.
20# In case of 'simple' trace backend, it will allow the trace event to be
21# compiled, but this would be turned off by default. It can be toggled on via
22# the monitor.
23#
Stefan Hajnoczi94a420b2010-05-22 17:52:39 +010024# The <name> must be a valid as a C function name.
25#
26# Types should be standard C types. Use void * for pointers because the trace
27# system may not have the necessary headers included.
28#
29# The <format-string> should be a sprintf()-compatible format string.
Stefan Hajnoczicd245a12010-05-22 18:09:25 +010030
31# qemu-malloc.c
32disable qemu_malloc(size_t size, void *ptr) "size %zu ptr %p"
33disable qemu_realloc(void *ptr, size_t size, void *newptr) "ptr %p size %zu newptr %p"
34disable qemu_free(void *ptr) "ptr %p"
35
36# osdep.c
37disable qemu_memalign(size_t alignment, size_t size, void *ptr) "alignment %zu size %zu ptr %p"
38disable qemu_valloc(size_t size, void *ptr) "size %zu ptr %p"
39disable qemu_vfree(void *ptr) "ptr %p"