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"
46 #include "pipe/p_compiler.h"
47 #include "os/os_thread.h"
48 #include "util/u_debug.h"
49 #include "util/u_memory.h"
50 #include "util/u_string.h"
51 #include "util/u_math.h"
52 #include "util/u_format.h"
55 #include "tr_screen.h"
56 #include "tr_texture.h"
59 static FILE *stream = NULL;
60 static unsigned refcount = 0;
61 pipe_static_mutex(call_mutex);
62 static long unsigned call_no = 0;
63 static boolean dumping = FALSE;
67 trace_dump_write(const char *buf, size_t size)
70 fwrite(buf, size, 1, stream);
76 trace_dump_writes(const char *s)
78 trace_dump_write(s, strlen(s));
83 trace_dump_writef(const char *format, ...)
85 static char buf[1024];
89 len = util_vsnprintf(buf, sizeof(buf), format, ap);
91 trace_dump_write(buf, len);
96 trace_dump_escape(const char *str)
98 const unsigned char *p = (const unsigned char *)str;
100 while((c = *p++) != 0) {
102 trace_dump_writes("<");
104 trace_dump_writes(">");
106 trace_dump_writes("&");
108 trace_dump_writes("'");
110 trace_dump_writes(""");
111 else if(c >= 0x20 && c <= 0x7e)
112 trace_dump_writef("%c", c);
114 trace_dump_writef("&#%u;", c);
120 trace_dump_indent(unsigned level)
123 for(i = 0; i < level; ++i)
124 trace_dump_writes("\t");
129 trace_dump_newline(void)
131 trace_dump_writes("\n");
136 trace_dump_tag(const char *name)
138 trace_dump_writes("<");
139 trace_dump_writes(name);
140 trace_dump_writes("/>");
145 trace_dump_tag_begin(const char *name)
147 trace_dump_writes("<");
148 trace_dump_writes(name);
149 trace_dump_writes(">");
153 trace_dump_tag_begin1(const char *name,
154 const char *attr1, const char *value1)
156 trace_dump_writes("<");
157 trace_dump_writes(name);
158 trace_dump_writes(" ");
159 trace_dump_writes(attr1);
160 trace_dump_writes("='");
161 trace_dump_escape(value1);
162 trace_dump_writes("'>");
167 trace_dump_tag_begin2(const char *name,
168 const char *attr1, const char *value1,
169 const char *attr2, const char *value2)
171 trace_dump_writes("<");
172 trace_dump_writes(name);
173 trace_dump_writes(" ");
174 trace_dump_writes(attr1);
175 trace_dump_writes("=\'");
176 trace_dump_escape(value1);
177 trace_dump_writes("\' ");
178 trace_dump_writes(attr2);
179 trace_dump_writes("=\'");
180 trace_dump_escape(value2);
181 trace_dump_writes("\'>");
186 trace_dump_tag_begin3(const char *name,
187 const char *attr1, const char *value1,
188 const char *attr2, const char *value2,
189 const char *attr3, const char *value3)
191 trace_dump_writes("<");
192 trace_dump_writes(name);
193 trace_dump_writes(" ");
194 trace_dump_writes(attr1);
195 trace_dump_writes("=\'");
196 trace_dump_escape(value1);
197 trace_dump_writes("\' ");
198 trace_dump_writes(attr2);
199 trace_dump_writes("=\'");
200 trace_dump_escape(value2);
201 trace_dump_writes("\' ");
202 trace_dump_writes(attr3);
203 trace_dump_writes("=\'");
204 trace_dump_escape(value3);
205 trace_dump_writes("\'>");
210 trace_dump_tag_end(const char *name)
212 trace_dump_writes("</");
213 trace_dump_writes(name);
214 trace_dump_writes(">");
218 trace_dump_trace_close(void)
221 trace_dump_writes("</trace>\n");
229 boolean trace_dump_trace_begin()
231 const char *filename;
233 filename = debug_get_option("GALLIUM_TRACE", NULL);
239 stream = fopen(filename, "wt");
243 trace_dump_writes("<?xml version='1.0' encoding='UTF-8'?>\n");
244 trace_dump_writes("<?xml-stylesheet type='text/xsl' href='trace.xsl'?>\n");
245 trace_dump_writes("<trace version='0.1'>\n");
247 #if defined(PIPE_OS_LINUX) || defined(PIPE_OS_BSD) || defined(PIPE_OS_SOLARIS) || defined(PIPE_OS_APPLE)
248 /* Linux applications rarely cleanup GL / Gallium resources so catch
249 * application exit here */
250 atexit(trace_dump_trace_close);
259 boolean trace_dump_trace_enabled(void)
261 return stream ? TRUE : FALSE;
264 void trace_dump_trace_end(void)
268 trace_dump_trace_close();
275 void trace_dump_call_lock(void)
277 pipe_mutex_lock(call_mutex);
280 void trace_dump_call_unlock(void)
282 pipe_mutex_unlock(call_mutex);
289 void trace_dumping_start_locked(void)
294 void trace_dumping_stop_locked(void)
299 boolean trace_dumping_enabled_locked(void)
304 void trace_dumping_start(void)
306 pipe_mutex_lock(call_mutex);
307 trace_dumping_start_locked();
308 pipe_mutex_unlock(call_mutex);
311 void trace_dumping_stop(void)
313 pipe_mutex_lock(call_mutex);
314 trace_dumping_stop_locked();
315 pipe_mutex_unlock(call_mutex);
318 boolean trace_dumping_enabled(void)
321 pipe_mutex_lock(call_mutex);
322 ret = trace_dumping_enabled_locked();
323 pipe_mutex_unlock(call_mutex);
331 void trace_dump_call_begin_locked(const char *klass, const char *method)
337 trace_dump_indent(1);
338 trace_dump_writes("<call no=\'");
339 trace_dump_writef("%lu", call_no);
340 trace_dump_writes("\' class=\'");
341 trace_dump_escape(klass);
342 trace_dump_writes("\' method=\'");
343 trace_dump_escape(method);
344 trace_dump_writes("\'>");
345 trace_dump_newline();
348 void trace_dump_call_end_locked(void)
353 trace_dump_indent(1);
354 trace_dump_tag_end("call");
355 trace_dump_newline();
359 void trace_dump_call_begin(const char *klass, const char *method)
361 pipe_mutex_lock(call_mutex);
362 trace_dump_call_begin_locked(klass, method);
365 void trace_dump_call_end(void)
367 trace_dump_call_end_locked();
368 pipe_mutex_unlock(call_mutex);
371 void trace_dump_arg_begin(const char *name)
376 trace_dump_indent(2);
377 trace_dump_tag_begin1("arg", "name", name);
380 void trace_dump_arg_end(void)
385 trace_dump_tag_end("arg");
386 trace_dump_newline();
389 void trace_dump_ret_begin(void)
394 trace_dump_indent(2);
395 trace_dump_tag_begin("ret");
398 void trace_dump_ret_end(void)
403 trace_dump_tag_end("ret");
404 trace_dump_newline();
407 void trace_dump_bool(int value)
412 trace_dump_writef("<bool>%c</bool>", value ? '1' : '0');
415 void trace_dump_int(long long int value)
420 trace_dump_writef("<int>%lli</int>", value);
423 void trace_dump_uint(long long unsigned value)
428 trace_dump_writef("<uint>%llu</uint>", value);
431 void trace_dump_float(double value)
436 trace_dump_writef("<float>%g</float>", value);
439 void trace_dump_bytes(const void *data,
442 static const char hex_table[16] = "0123456789ABCDEF";
443 const uint8_t *p = data;
449 trace_dump_writes("<bytes>");
450 for(i = 0; i < size; ++i) {
453 hex[0] = hex_table[byte >> 4];
454 hex[1] = hex_table[byte & 0xf];
455 trace_dump_write(hex, 2);
457 trace_dump_writes("</bytes>");
460 void trace_dump_box_bytes(const void *data,
461 enum pipe_format format,
462 const struct pipe_box *box,
464 unsigned slice_stride)
469 size = box->depth * slice_stride;
471 size = util_format_get_nblocksy(format, box->height) * stride;
473 size = util_format_get_nblocksx(format, box->width) * util_format_get_blocksize(format);
476 trace_dump_bytes(data, size);
479 void trace_dump_string(const char *str)
484 trace_dump_writes("<string>");
485 trace_dump_escape(str);
486 trace_dump_writes("</string>");
489 void trace_dump_enum(const char *value)
494 trace_dump_writes("<enum>");
495 trace_dump_escape(value);
496 trace_dump_writes("</enum>");
499 void trace_dump_array_begin(void)
504 trace_dump_writes("<array>");
507 void trace_dump_array_end(void)
512 trace_dump_writes("</array>");
515 void trace_dump_elem_begin(void)
520 trace_dump_writes("<elem>");
523 void trace_dump_elem_end(void)
528 trace_dump_writes("</elem>");
531 void trace_dump_struct_begin(const char *name)
536 trace_dump_writef("<struct name='%s'>", name);
539 void trace_dump_struct_end(void)
544 trace_dump_writes("</struct>");
547 void trace_dump_member_begin(const char *name)
552 trace_dump_writef("<member name='%s'>", name);
555 void trace_dump_member_end(void)
560 trace_dump_writes("</member>");
563 void trace_dump_null(void)
568 trace_dump_writes("<null/>");
571 void trace_dump_ptr(const void *value)
577 trace_dump_writef("<ptr>0x%08lx</ptr>", (unsigned long)(uintptr_t)value);
583 void trace_dump_resource_ptr(struct pipe_resource *_resource)
589 struct trace_resource *tr_resource = trace_resource(_resource);
590 trace_dump_ptr(tr_resource->resource);
596 void trace_dump_surface_ptr(struct pipe_surface *_surface)
602 struct trace_surface *tr_surf = trace_surface(_surface);
603 trace_dump_ptr(tr_surf->surface);
609 void trace_dump_transfer_ptr(struct pipe_transfer *_transfer)
615 struct trace_transfer *tr_tran = trace_transfer(_transfer);
616 trace_dump_ptr(tr_tran->transfer);