ec8f8cd62e1286665ccc2a7ca2fc92304b662b21
1 /**************************************************************************
3 * Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21 * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 **************************************************************************/
31 * Trace dumping functions.
33 * For now we just use standard XML for dumping the trace calls, as this is
34 * simple to write, parse, and visually inspect, but the actual representation
35 * is abstracted out of this file, so that we can switch to a binary
36 * representation if/when it becomes justified.
38 * @author Jose Fonseca <jrfonseca@tungstengraphics.com>
41 #include "pipe/p_config.h"
43 #if defined(PIPE_OS_LINUX) || defined(PIPE_OS_BSD)
47 #include "pipe/p_compiler.h"
48 #include "util/u_debug.h"
49 #include "util/u_memory.h"
50 #include "util/u_string.h"
51 #include "util/u_stream.h"
56 static struct util_stream
*stream
= NULL
;
57 static unsigned refcount
= 0;
61 trace_dump_write(const char *buf
, size_t size
)
64 util_stream_write(stream
, buf
, size
);
69 trace_dump_writes(const char *s
)
71 trace_dump_write(s
, strlen(s
));
76 trace_dump_writef(const char *format
, ...)
78 static char buf
[1024];
82 len
= util_vsnprintf(buf
, sizeof(buf
), format
, ap
);
84 trace_dump_write(buf
, len
);
89 trace_dump_escape(const char *str
)
91 const unsigned char *p
= (const unsigned char *)str
;
93 while((c
= *p
++) != 0) {
95 trace_dump_writes("<");
97 trace_dump_writes(">");
99 trace_dump_writes("&");
101 trace_dump_writes("'");
103 trace_dump_writes(""");
104 else if(c
>= 0x20 && c
<= 0x7e)
105 trace_dump_writef("%c", c
);
107 trace_dump_writef("&#%u;", c
);
113 trace_dump_indent(unsigned level
)
116 for(i
= 0; i
< level
; ++i
)
117 trace_dump_writes("\t");
122 trace_dump_newline(void)
124 trace_dump_writes("\n");
129 trace_dump_tag(const char *name
)
131 trace_dump_writes("<");
132 trace_dump_writes(name
);
133 trace_dump_writes("/>");
138 trace_dump_tag_begin(const char *name
)
140 trace_dump_writes("<");
141 trace_dump_writes(name
);
142 trace_dump_writes(">");
146 trace_dump_tag_begin1(const char *name
,
147 const char *attr1
, const char *value1
)
149 trace_dump_writes("<");
150 trace_dump_writes(name
);
151 trace_dump_writes(" ");
152 trace_dump_writes(attr1
);
153 trace_dump_writes("='");
154 trace_dump_escape(value1
);
155 trace_dump_writes("'>");
160 trace_dump_tag_begin2(const char *name
,
161 const char *attr1
, const char *value1
,
162 const char *attr2
, const char *value2
)
164 trace_dump_writes("<");
165 trace_dump_writes(name
);
166 trace_dump_writes(" ");
167 trace_dump_writes(attr1
);
168 trace_dump_writes("=\'");
169 trace_dump_escape(value1
);
170 trace_dump_writes("\' ");
171 trace_dump_writes(attr2
);
172 trace_dump_writes("=\'");
173 trace_dump_escape(value2
);
174 trace_dump_writes("\'>");
179 trace_dump_tag_begin3(const char *name
,
180 const char *attr1
, const char *value1
,
181 const char *attr2
, const char *value2
,
182 const char *attr3
, const char *value3
)
184 trace_dump_writes("<");
185 trace_dump_writes(name
);
186 trace_dump_writes(" ");
187 trace_dump_writes(attr1
);
188 trace_dump_writes("=\'");
189 trace_dump_escape(value1
);
190 trace_dump_writes("\' ");
191 trace_dump_writes(attr2
);
192 trace_dump_writes("=\'");
193 trace_dump_escape(value2
);
194 trace_dump_writes("\' ");
195 trace_dump_writes(attr3
);
196 trace_dump_writes("=\'");
197 trace_dump_escape(value3
);
198 trace_dump_writes("\'>");
203 trace_dump_tag_end(const char *name
)
205 trace_dump_writes("</");
206 trace_dump_writes(name
);
207 trace_dump_writes(">");
211 trace_dump_trace_close(void)
214 trace_dump_writes("</trace>\n");
215 util_stream_close(stream
);
221 boolean
trace_dump_trace_begin()
223 const char *filename
;
225 filename
= debug_get_option("GALLIUM_TRACE", NULL
);
231 stream
= util_stream_create(filename
, 0);
235 trace_dump_writes("<?xml version='1.0' encoding='UTF-8'?>\n");
236 trace_dump_writes("<?xml-stylesheet type='text/xsl' href='trace.xsl'?>\n");
237 trace_dump_writes("<trace version='0.1'>\n");
239 #if defined(PIPE_OS_LINUX) || defined(PIPE_OS_BSD)
240 /* Linux applications rarely cleanup GL / Gallium resources so catch
241 * application exit here */
242 atexit(trace_dump_trace_close
);
251 boolean
trace_dump_enabled(void)
253 return stream
? TRUE
: FALSE
;
256 void trace_dump_trace_end(void)
260 trace_dump_trace_close();
263 void trace_dump_call_begin(const char *klass
, const char *method
)
265 trace_dump_indent(1);
266 trace_dump_tag_begin2("call", "class", klass
, "method", method
);
267 trace_dump_newline();
270 void trace_dump_call_end(void)
272 trace_dump_indent(1);
273 trace_dump_tag_end("call");
274 trace_dump_newline();
275 util_stream_flush(stream
);
278 void trace_dump_arg_begin(const char *name
)
280 trace_dump_indent(2);
281 trace_dump_tag_begin1("arg", "name", name
);
284 void trace_dump_arg_end(void)
286 trace_dump_tag_end("arg");
287 trace_dump_newline();
290 void trace_dump_ret_begin(void)
292 trace_dump_indent(2);
293 trace_dump_tag_begin("ret");
296 void trace_dump_ret_end(void)
298 trace_dump_tag_end("ret");
299 trace_dump_newline();
302 void trace_dump_bool(int value
)
304 trace_dump_writef("<bool>%c</bool>", value
? '1' : '0');
307 void trace_dump_int(long long int value
)
309 trace_dump_writef("<int>%lli</int>", value
);
312 void trace_dump_uint(long long unsigned value
)
314 trace_dump_writef("<uint>%llu</uint>", value
);
317 void trace_dump_float(double value
)
319 trace_dump_writef("<float>%g</float>", value
);
322 void trace_dump_bytes(const void *data
,
325 static const char hex_table
[16] = "0123456789ABCDEF";
326 const uint8_t *p
= data
;
328 trace_dump_writes("<bytes>");
329 for(i
= 0; i
< size
; ++i
) {
332 hex
[0] = hex_table
[byte
>> 4];
333 hex
[1] = hex_table
[byte
& 0xf];
334 trace_dump_write(hex
, 2);
336 trace_dump_writes("</bytes>");
339 void trace_dump_string(const char *str
)
341 trace_dump_writes("<string>");
342 trace_dump_escape(str
);
343 trace_dump_writes("</string>");
346 void trace_dump_enum(const char *value
)
348 trace_dump_writes("<enum>");
349 trace_dump_escape(value
);
350 trace_dump_writes("</enum>");
353 void trace_dump_array_begin(void)
355 trace_dump_writes("<array>");
358 void trace_dump_array_end(void)
360 trace_dump_writes("</array>");
363 void trace_dump_elem_begin(void)
365 trace_dump_writes("<elem>");
368 void trace_dump_elem_end(void)
370 trace_dump_writes("</elem>");
373 void trace_dump_struct_begin(const char *name
)
375 trace_dump_writef("<struct name='%s'>", name
);
378 void trace_dump_struct_end(void)
380 trace_dump_writes("</struct>");
383 void trace_dump_member_begin(const char *name
)
385 trace_dump_writef("<member name='%s'>", name
);
388 void trace_dump_member_end(void)
390 trace_dump_writes("</member>");
393 void trace_dump_null(void)
395 trace_dump_writes("<null/>");
398 void trace_dump_ptr(const void *value
)
401 trace_dump_writef("<ptr>0x%08lx</ptr>", (unsigned long)(uintptr_t)value
);