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) || defined(PIPE_OS_SOLARIS) || defined(PIPE_OS_APPLE)
47 #include "pipe/p_compiler.h"
48 #include "os/os_thread.h"
49 #include "os/os_stream.h"
50 #include "util/u_debug.h"
51 #include "util/u_memory.h"
52 #include "util/u_string.h"
55 #include "tr_screen.h"
56 #include "tr_texture.h"
57 #include "tr_buffer.h"
60 static struct os_stream *stream = NULL;
61 static unsigned refcount = 0;
62 static pipe_mutex call_mutex;
63 static long unsigned call_no = 0;
64 static boolean dumping = FALSE;
65 static boolean initialized = FALSE;
69 trace_dump_write(const char *buf, size_t size)
72 os_stream_write(stream, buf, size);
77 trace_dump_writes(const char *s)
79 trace_dump_write(s, strlen(s));
84 trace_dump_writef(const char *format, ...)
86 static char buf[1024];
90 len = util_vsnprintf(buf, sizeof(buf), format, ap);
92 trace_dump_write(buf, len);
97 trace_dump_escape(const char *str)
99 const unsigned char *p = (const unsigned char *)str;
101 while((c = *p++) != 0) {
103 trace_dump_writes("<");
105 trace_dump_writes(">");
107 trace_dump_writes("&");
109 trace_dump_writes("'");
111 trace_dump_writes(""");
112 else if(c >= 0x20 && c <= 0x7e)
113 trace_dump_writef("%c", c);
115 trace_dump_writef("&#%u;", c);
121 trace_dump_indent(unsigned level)
124 for(i = 0; i < level; ++i)
125 trace_dump_writes("\t");
130 trace_dump_newline(void)
132 trace_dump_writes("\n");
137 trace_dump_tag(const char *name)
139 trace_dump_writes("<");
140 trace_dump_writes(name);
141 trace_dump_writes("/>");
146 trace_dump_tag_begin(const char *name)
148 trace_dump_writes("<");
149 trace_dump_writes(name);
150 trace_dump_writes(">");
154 trace_dump_tag_begin1(const char *name,
155 const char *attr1, const char *value1)
157 trace_dump_writes("<");
158 trace_dump_writes(name);
159 trace_dump_writes(" ");
160 trace_dump_writes(attr1);
161 trace_dump_writes("='");
162 trace_dump_escape(value1);
163 trace_dump_writes("'>");
168 trace_dump_tag_begin2(const char *name,
169 const char *attr1, const char *value1,
170 const char *attr2, const char *value2)
172 trace_dump_writes("<");
173 trace_dump_writes(name);
174 trace_dump_writes(" ");
175 trace_dump_writes(attr1);
176 trace_dump_writes("=\'");
177 trace_dump_escape(value1);
178 trace_dump_writes("\' ");
179 trace_dump_writes(attr2);
180 trace_dump_writes("=\'");
181 trace_dump_escape(value2);
182 trace_dump_writes("\'>");
187 trace_dump_tag_begin3(const char *name,
188 const char *attr1, const char *value1,
189 const char *attr2, const char *value2,
190 const char *attr3, const char *value3)
192 trace_dump_writes("<");
193 trace_dump_writes(name);
194 trace_dump_writes(" ");
195 trace_dump_writes(attr1);
196 trace_dump_writes("=\'");
197 trace_dump_escape(value1);
198 trace_dump_writes("\' ");
199 trace_dump_writes(attr2);
200 trace_dump_writes("=\'");
201 trace_dump_escape(value2);
202 trace_dump_writes("\' ");
203 trace_dump_writes(attr3);
204 trace_dump_writes("=\'");
205 trace_dump_escape(value3);
206 trace_dump_writes("\'>");
211 trace_dump_tag_end(const char *name)
213 trace_dump_writes("</");
214 trace_dump_writes(name);
215 trace_dump_writes(">");
219 trace_dump_trace_close(void)
222 trace_dump_writes("</trace>\n");
223 os_stream_close(stream);
227 pipe_mutex_destroy(call_mutex);
231 void trace_dump_init()
236 pipe_mutex_init(call_mutex);
241 boolean trace_dump_trace_begin()
243 const char *filename;
247 filename = debug_get_option("GALLIUM_TRACE", NULL);
253 stream = os_file_stream_create(filename);
257 trace_dump_writes("<?xml version='1.0' encoding='UTF-8'?>\n");
258 trace_dump_writes("<?xml-stylesheet type='text/xsl' href='trace.xsl'?>\n");
259 trace_dump_writes("<trace version='0.1'>\n");
261 #if defined(PIPE_OS_LINUX) || defined(PIPE_OS_BSD) || defined(PIPE_OS_SOLARIS) || defined(PIPE_OS_APPLE)
262 /* Linux applications rarely cleanup GL / Gallium resources so catch
263 * application exit here */
264 atexit(trace_dump_trace_close);
273 boolean trace_dump_trace_enabled(void)
275 return stream ? TRUE : FALSE;
278 void trace_dump_trace_end(void)
282 trace_dump_trace_close();
289 void trace_dump_call_lock(void)
291 pipe_mutex_lock(call_mutex);
294 void trace_dump_call_unlock(void)
296 pipe_mutex_unlock(call_mutex);
303 void trace_dumping_start_locked(void)
308 void trace_dumping_stop_locked(void)
313 boolean trace_dumping_enabled_locked(void)
318 void trace_dumping_start(void)
320 pipe_mutex_lock(call_mutex);
321 trace_dumping_start_locked();
322 pipe_mutex_unlock(call_mutex);
325 void trace_dumping_stop(void)
327 pipe_mutex_lock(call_mutex);
328 trace_dumping_stop_locked();
329 pipe_mutex_unlock(call_mutex);
332 boolean trace_dumping_enabled(void)
335 pipe_mutex_lock(call_mutex);
336 ret = trace_dumping_enabled_locked();
337 pipe_mutex_unlock(call_mutex);
345 void trace_dump_call_begin_locked(const char *klass, const char *method)
351 trace_dump_indent(1);
352 trace_dump_writes("<call no=\'");
353 trace_dump_writef("%lu", call_no);
354 trace_dump_writes("\' class=\'");
355 trace_dump_escape(klass);
356 trace_dump_writes("\' method=\'");
357 trace_dump_escape(method);
358 trace_dump_writes("\'>");
359 trace_dump_newline();
362 void trace_dump_call_end_locked(void)
367 trace_dump_indent(1);
368 trace_dump_tag_end("call");
369 trace_dump_newline();
370 os_stream_flush(stream);
373 void trace_dump_call_begin(const char *klass, const char *method)
375 pipe_mutex_lock(call_mutex);
376 trace_dump_call_begin_locked(klass, method);
379 void trace_dump_call_end(void)
381 trace_dump_call_end_locked();
382 pipe_mutex_unlock(call_mutex);
385 void trace_dump_arg_begin(const char *name)
390 trace_dump_indent(2);
391 trace_dump_tag_begin1("arg", "name", name);
394 void trace_dump_arg_end(void)
399 trace_dump_tag_end("arg");
400 trace_dump_newline();
403 void trace_dump_ret_begin(void)
408 trace_dump_indent(2);
409 trace_dump_tag_begin("ret");
412 void trace_dump_ret_end(void)
417 trace_dump_tag_end("ret");
418 trace_dump_newline();
421 void trace_dump_bool(int value)
426 trace_dump_writef("<bool>%c</bool>", value ? '1' : '0');
429 void trace_dump_int(long long int value)
434 trace_dump_writef("<int>%lli</int>", value);
437 void trace_dump_uint(long long unsigned value)
442 trace_dump_writef("<uint>%llu</uint>", value);
445 void trace_dump_float(double value)
450 trace_dump_writef("<float>%g</float>", value);
453 void trace_dump_bytes(const void *data,
456 static const char hex_table[16] = "0123456789ABCDEF";
457 const uint8_t *p = data;
463 trace_dump_writes("<bytes>");
464 for(i = 0; i < size; ++i) {
467 hex[0] = hex_table[byte >> 4];
468 hex[1] = hex_table[byte & 0xf];
469 trace_dump_write(hex, 2);
471 trace_dump_writes("</bytes>");
474 void trace_dump_string(const char *str)
479 trace_dump_writes("<string>");
480 trace_dump_escape(str);
481 trace_dump_writes("</string>");
484 void trace_dump_enum(const char *value)
489 trace_dump_writes("<enum>");
490 trace_dump_escape(value);
491 trace_dump_writes("</enum>");
494 void trace_dump_array_begin(void)
499 trace_dump_writes("<array>");
502 void trace_dump_array_end(void)
507 trace_dump_writes("</array>");
510 void trace_dump_elem_begin(void)
515 trace_dump_writes("<elem>");
518 void trace_dump_elem_end(void)
523 trace_dump_writes("</elem>");
526 void trace_dump_struct_begin(const char *name)
531 trace_dump_writef("<struct name='%s'>", name);
534 void trace_dump_struct_end(void)
539 trace_dump_writes("</struct>");
542 void trace_dump_member_begin(const char *name)
547 trace_dump_writef("<member name='%s'>", name);
550 void trace_dump_member_end(void)
555 trace_dump_writes("</member>");
558 void trace_dump_null(void)
563 trace_dump_writes("<null/>");
566 void trace_dump_ptr(const void *value)
572 trace_dump_writef("<ptr>0x%08lx</ptr>", (unsigned long)(uintptr_t)value);
577 void trace_dump_buffer_ptr(struct pipe_buffer *_buffer)
583 struct trace_buffer *tr_buf = trace_buffer(_buffer);
584 trace_dump_ptr(tr_buf->buffer);
590 void trace_dump_texture_ptr(struct pipe_texture *_texture)
596 struct trace_texture *tr_tex = trace_texture(_texture);
597 trace_dump_ptr(tr_tex->texture);
603 void trace_dump_surface_ptr(struct pipe_surface *_surface)
609 struct trace_surface *tr_surf = trace_surface(_surface);
610 trace_dump_ptr(tr_surf->surface);
616 void trace_dump_transfer_ptr(struct pipe_transfer *_transfer)
622 struct trace_transfer *tr_tran = trace_transfer(_transfer);
623 trace_dump_ptr(tr_tran->transfer);