826ce5bc1ba46815be7082368271ba5a26b88480
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 "os/os_time.h"
49 #include "util/u_debug.h"
50 #include "util/u_memory.h"
51 #include "util/u_string.h"
52 #include "util/u_math.h"
53 #include "util/u_format.h"
56 #include "tr_screen.h"
57 #include "tr_texture.h"
60 static boolean close_stream
= FALSE
;
61 static FILE *stream
= NULL
;
62 static unsigned refcount
= 0;
63 pipe_static_mutex(call_mutex
);
64 static long unsigned call_no
= 0;
65 static boolean dumping
= FALSE
;
69 trace_dump_write(const char *buf
, size_t size
)
72 fwrite(buf
, size
, 1, stream
);
78 trace_dump_writes(const char *s
)
80 trace_dump_write(s
, strlen(s
));
85 trace_dump_writef(const char *format
, ...)
87 static char buf
[1024];
91 len
= util_vsnprintf(buf
, sizeof(buf
), format
, ap
);
93 trace_dump_write(buf
, len
);
98 trace_dump_escape(const char *str
)
100 const unsigned char *p
= (const unsigned char *)str
;
102 while((c
= *p
++) != 0) {
104 trace_dump_writes("<");
106 trace_dump_writes(">");
108 trace_dump_writes("&");
110 trace_dump_writes("'");
112 trace_dump_writes(""");
113 else if(c
>= 0x20 && c
<= 0x7e)
114 trace_dump_writef("%c", c
);
116 trace_dump_writef("&#%u;", c
);
122 trace_dump_indent(unsigned level
)
125 for(i
= 0; i
< level
; ++i
)
126 trace_dump_writes("\t");
131 trace_dump_newline(void)
133 trace_dump_writes("\n");
138 trace_dump_tag(const char *name
)
140 trace_dump_writes("<");
141 trace_dump_writes(name
);
142 trace_dump_writes("/>");
147 trace_dump_tag_begin(const char *name
)
149 trace_dump_writes("<");
150 trace_dump_writes(name
);
151 trace_dump_writes(">");
155 trace_dump_tag_begin1(const char *name
,
156 const char *attr1
, const char *value1
)
158 trace_dump_writes("<");
159 trace_dump_writes(name
);
160 trace_dump_writes(" ");
161 trace_dump_writes(attr1
);
162 trace_dump_writes("='");
163 trace_dump_escape(value1
);
164 trace_dump_writes("'>");
169 trace_dump_tag_begin2(const char *name
,
170 const char *attr1
, const char *value1
,
171 const char *attr2
, const char *value2
)
173 trace_dump_writes("<");
174 trace_dump_writes(name
);
175 trace_dump_writes(" ");
176 trace_dump_writes(attr1
);
177 trace_dump_writes("=\'");
178 trace_dump_escape(value1
);
179 trace_dump_writes("\' ");
180 trace_dump_writes(attr2
);
181 trace_dump_writes("=\'");
182 trace_dump_escape(value2
);
183 trace_dump_writes("\'>");
188 trace_dump_tag_begin3(const char *name
,
189 const char *attr1
, const char *value1
,
190 const char *attr2
, const char *value2
,
191 const char *attr3
, const char *value3
)
193 trace_dump_writes("<");
194 trace_dump_writes(name
);
195 trace_dump_writes(" ");
196 trace_dump_writes(attr1
);
197 trace_dump_writes("=\'");
198 trace_dump_escape(value1
);
199 trace_dump_writes("\' ");
200 trace_dump_writes(attr2
);
201 trace_dump_writes("=\'");
202 trace_dump_escape(value2
);
203 trace_dump_writes("\' ");
204 trace_dump_writes(attr3
);
205 trace_dump_writes("=\'");
206 trace_dump_escape(value3
);
207 trace_dump_writes("\'>");
212 trace_dump_tag_end(const char *name
)
214 trace_dump_writes("</");
215 trace_dump_writes(name
);
216 trace_dump_writes(">");
220 trace_dump_trace_flush(void)
228 trace_dump_trace_close(void)
231 trace_dump_writes("</trace>\n");
234 close_stream
= FALSE
;
244 trace_dump_call_time(int64_t time
)
247 trace_dump_indent(2);
248 trace_dump_tag_begin("time");
249 trace_dump_int(time
);
250 trace_dump_tag_end("time");
251 trace_dump_newline();
257 trace_dump_trace_begin(void)
259 const char *filename
;
261 filename
= debug_get_option("GALLIUM_TRACE", NULL
);
267 if (strcmp(filename
, "stderr") == 0) {
268 close_stream
= FALSE
;
271 else if (strcmp(filename
, "stdout") == 0) {
272 close_stream
= FALSE
;
277 stream
= fopen(filename
, "wt");
282 trace_dump_writes("<?xml version='1.0' encoding='UTF-8'?>\n");
283 trace_dump_writes("<?xml-stylesheet type='text/xsl' href='trace.xsl'?>\n");
284 trace_dump_writes("<trace version='0.1'>\n");
286 #if defined(PIPE_OS_LINUX) || defined(PIPE_OS_BSD) || defined(PIPE_OS_SOLARIS) || defined(PIPE_OS_APPLE)
287 /* Linux applications rarely cleanup GL / Gallium resources so catch
288 * application exit here */
289 atexit(trace_dump_trace_close
);
298 boolean
trace_dump_trace_enabled(void)
300 return stream
? TRUE
: FALSE
;
303 void trace_dump_trace_end(void)
307 trace_dump_trace_close();
314 void trace_dump_call_lock(void)
316 pipe_mutex_lock(call_mutex
);
319 void trace_dump_call_unlock(void)
321 pipe_mutex_unlock(call_mutex
);
328 void trace_dumping_start_locked(void)
333 void trace_dumping_stop_locked(void)
338 boolean
trace_dumping_enabled_locked(void)
343 void trace_dumping_start(void)
345 pipe_mutex_lock(call_mutex
);
346 trace_dumping_start_locked();
347 pipe_mutex_unlock(call_mutex
);
350 void trace_dumping_stop(void)
352 pipe_mutex_lock(call_mutex
);
353 trace_dumping_stop_locked();
354 pipe_mutex_unlock(call_mutex
);
357 boolean
trace_dumping_enabled(void)
360 pipe_mutex_lock(call_mutex
);
361 ret
= trace_dumping_enabled_locked();
362 pipe_mutex_unlock(call_mutex
);
370 static int64_t call_start_time
= 0;
372 void trace_dump_call_begin_locked(const char *klass
, const char *method
)
378 trace_dump_indent(1);
379 trace_dump_writes("<call no=\'");
380 trace_dump_writef("%lu", call_no
);
381 trace_dump_writes("\' class=\'");
382 trace_dump_escape(klass
);
383 trace_dump_writes("\' method=\'");
384 trace_dump_escape(method
);
385 trace_dump_writes("\'>");
386 trace_dump_newline();
388 call_start_time
= os_time_get();
391 void trace_dump_call_end_locked(void)
393 int64_t call_end_time
;
398 call_end_time
= os_time_get();
400 trace_dump_call_time(call_end_time
- call_start_time
);
401 trace_dump_indent(1);
402 trace_dump_tag_end("call");
403 trace_dump_newline();
407 void trace_dump_call_begin(const char *klass
, const char *method
)
409 pipe_mutex_lock(call_mutex
);
410 trace_dump_call_begin_locked(klass
, method
);
413 void trace_dump_call_end(void)
415 trace_dump_call_end_locked();
416 pipe_mutex_unlock(call_mutex
);
419 void trace_dump_arg_begin(const char *name
)
424 trace_dump_indent(2);
425 trace_dump_tag_begin1("arg", "name", name
);
428 void trace_dump_arg_end(void)
433 trace_dump_tag_end("arg");
434 trace_dump_newline();
437 void trace_dump_ret_begin(void)
442 trace_dump_indent(2);
443 trace_dump_tag_begin("ret");
446 void trace_dump_ret_end(void)
451 trace_dump_tag_end("ret");
452 trace_dump_newline();
455 void trace_dump_bool(int value
)
460 trace_dump_writef("<bool>%c</bool>", value
? '1' : '0');
463 void trace_dump_int(long long int value
)
468 trace_dump_writef("<int>%lli</int>", value
);
471 void trace_dump_uint(long long unsigned value
)
476 trace_dump_writef("<uint>%llu</uint>", value
);
479 void trace_dump_float(double value
)
484 trace_dump_writef("<float>%g</float>", value
);
487 void trace_dump_bytes(const void *data
,
490 static const char hex_table
[16] = "0123456789ABCDEF";
491 const uint8_t *p
= data
;
497 trace_dump_writes("<bytes>");
498 for(i
= 0; i
< size
; ++i
) {
501 hex
[0] = hex_table
[byte
>> 4];
502 hex
[1] = hex_table
[byte
& 0xf];
503 trace_dump_write(hex
, 2);
505 trace_dump_writes("</bytes>");
508 void trace_dump_box_bytes(const void *data
,
509 enum pipe_format format
,
510 const struct pipe_box
*box
,
512 unsigned slice_stride
)
517 size
= box
->depth
* slice_stride
;
519 size
= util_format_get_nblocksy(format
, box
->height
) * stride
;
521 size
= util_format_get_nblocksx(format
, box
->width
) * util_format_get_blocksize(format
);
524 trace_dump_bytes(data
, size
);
527 void trace_dump_string(const char *str
)
532 trace_dump_writes("<string>");
533 trace_dump_escape(str
);
534 trace_dump_writes("</string>");
537 void trace_dump_enum(const char *value
)
542 trace_dump_writes("<enum>");
543 trace_dump_escape(value
);
544 trace_dump_writes("</enum>");
547 void trace_dump_array_begin(void)
552 trace_dump_writes("<array>");
555 void trace_dump_array_end(void)
560 trace_dump_writes("</array>");
563 void trace_dump_elem_begin(void)
568 trace_dump_writes("<elem>");
571 void trace_dump_elem_end(void)
576 trace_dump_writes("</elem>");
579 void trace_dump_struct_begin(const char *name
)
584 trace_dump_writef("<struct name='%s'>", name
);
587 void trace_dump_struct_end(void)
592 trace_dump_writes("</struct>");
595 void trace_dump_member_begin(const char *name
)
600 trace_dump_writef("<member name='%s'>", name
);
603 void trace_dump_member_end(void)
608 trace_dump_writes("</member>");
611 void trace_dump_null(void)
616 trace_dump_writes("<null/>");
619 void trace_dump_ptr(const void *value
)
625 trace_dump_writef("<ptr>0x%08lx</ptr>", (unsigned long)(uintptr_t)value
);
631 void trace_dump_resource_ptr(struct pipe_resource
*_resource
)
637 struct trace_resource
*tr_resource
= trace_resource(_resource
);
638 trace_dump_ptr(tr_resource
->resource
);
644 void trace_dump_surface_ptr(struct pipe_surface
*_surface
)
650 struct trace_surface
*tr_surf
= trace_surface(_surface
);
651 trace_dump_ptr(tr_surf
->surface
);
657 void trace_dump_transfer_ptr(struct pipe_transfer
*_transfer
)
663 struct trace_transfer
*tr_tran
= trace_transfer(_transfer
);
664 trace_dump_ptr(tr_tran
->transfer
);