From: Stefan Hajnoczi Date: Thu, 14 Apr 2011 17:24:50 +0000 (+0100) Subject: docs: Trace events must not expect pointer dereferencing X-Git-Tag: v0.15.0-rc0~343^2~3 X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=e6a750aab57e4dccefd6291dba4fee6b9b3bf9ee;p=qemu-xen-4.6-testing.git docs: Trace events must not expect pointer dereferencing Signed-off-by: Stefan Hajnoczi --- diff --git a/docs/tracing.txt b/docs/tracing.txt index f15069c96..905a0837d 100644 --- a/docs/tracing.txt +++ b/docs/tracing.txt @@ -69,6 +69,11 @@ Trace events should use types as follows: cannot include all user-defined struct declarations and it is therefore necessary to use void * for pointers to structs. + Pointers (including char *) cannot be dereferenced easily (or at all) in + some trace backends. If pointers are used, ensure they are meaningful by + themselves and do not assume the data they point to will be traced. Do + not pass in string arguments. + * For everything else, use primitive scalar types (char, int, long) with the appropriate signedness.