1 /**************************************************************************
3 * Copyright 2008 VMware, Inc.
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 VMWARE 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 <jfonseca@vmware.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 pipe_static_mutex(call_mutex
);
63 static long unsigned call_no
= 0;
64 static boolean dumping
= FALSE
;
68 trace_dump_write(const char *buf
, size_t size
)
71 fwrite(buf
, size
, 1, stream
);
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_flush(void)
227 trace_dump_trace_close(void)
230 trace_dump_writes("</trace>\n");
233 close_stream
= FALSE
;
242 trace_dump_call_time(int64_t time
)
245 trace_dump_indent(2);
246 trace_dump_tag_begin("time");
247 trace_dump_int(time
);
248 trace_dump_tag_end("time");
249 trace_dump_newline();
255 trace_dump_trace_begin(void)
257 const char *filename
;
259 filename
= debug_get_option("GALLIUM_TRACE", NULL
);
265 if (strcmp(filename
, "stderr") == 0) {
266 close_stream
= FALSE
;
269 else if (strcmp(filename
, "stdout") == 0) {
270 close_stream
= FALSE
;
275 stream
= fopen(filename
, "wt");
280 trace_dump_writes("<?xml version='1.0' encoding='UTF-8'?>\n");
281 trace_dump_writes("<?xml-stylesheet type='text/xsl' href='trace.xsl'?>\n");
282 trace_dump_writes("<trace version='0.1'>\n");
284 /* Many applications don't exit cleanly, others may create and destroy a
285 * screen multiple times, so we only write </trace> tag and close at exit
288 atexit(trace_dump_trace_close
);
294 boolean
trace_dump_trace_enabled(void)
296 return stream
? TRUE
: FALSE
;
303 void trace_dump_call_lock(void)
305 pipe_mutex_lock(call_mutex
);
308 void trace_dump_call_unlock(void)
310 pipe_mutex_unlock(call_mutex
);
317 void trace_dumping_start_locked(void)
322 void trace_dumping_stop_locked(void)
327 boolean
trace_dumping_enabled_locked(void)
332 void trace_dumping_start(void)
334 pipe_mutex_lock(call_mutex
);
335 trace_dumping_start_locked();
336 pipe_mutex_unlock(call_mutex
);
339 void trace_dumping_stop(void)
341 pipe_mutex_lock(call_mutex
);
342 trace_dumping_stop_locked();
343 pipe_mutex_unlock(call_mutex
);
346 boolean
trace_dumping_enabled(void)
349 pipe_mutex_lock(call_mutex
);
350 ret
= trace_dumping_enabled_locked();
351 pipe_mutex_unlock(call_mutex
);
359 static int64_t call_start_time
= 0;
361 void trace_dump_call_begin_locked(const char *klass
, const char *method
)
367 trace_dump_indent(1);
368 trace_dump_writes("<call no=\'");
369 trace_dump_writef("%lu", call_no
);
370 trace_dump_writes("\' class=\'");
371 trace_dump_escape(klass
);
372 trace_dump_writes("\' method=\'");
373 trace_dump_escape(method
);
374 trace_dump_writes("\'>");
375 trace_dump_newline();
377 call_start_time
= os_time_get();
380 void trace_dump_call_end_locked(void)
382 int64_t call_end_time
;
387 call_end_time
= os_time_get();
389 trace_dump_call_time(call_end_time
- call_start_time
);
390 trace_dump_indent(1);
391 trace_dump_tag_end("call");
392 trace_dump_newline();
396 void trace_dump_call_begin(const char *klass
, const char *method
)
398 pipe_mutex_lock(call_mutex
);
399 trace_dump_call_begin_locked(klass
, method
);
402 void trace_dump_call_end(void)
404 trace_dump_call_end_locked();
405 pipe_mutex_unlock(call_mutex
);
408 void trace_dump_arg_begin(const char *name
)
413 trace_dump_indent(2);
414 trace_dump_tag_begin1("arg", "name", name
);
417 void trace_dump_arg_end(void)
422 trace_dump_tag_end("arg");
423 trace_dump_newline();
426 void trace_dump_ret_begin(void)
431 trace_dump_indent(2);
432 trace_dump_tag_begin("ret");
435 void trace_dump_ret_end(void)
440 trace_dump_tag_end("ret");
441 trace_dump_newline();
444 void trace_dump_bool(int value
)
449 trace_dump_writef("<bool>%c</bool>", value
? '1' : '0');
452 void trace_dump_int(long long int value
)
457 trace_dump_writef("<int>%lli</int>", value
);
460 void trace_dump_uint(long long unsigned value
)
465 trace_dump_writef("<uint>%llu</uint>", value
);
468 void trace_dump_float(double value
)
473 trace_dump_writef("<float>%g</float>", value
);
476 void trace_dump_bytes(const void *data
,
479 static const char hex_table
[16] = "0123456789ABCDEF";
480 const uint8_t *p
= data
;
486 trace_dump_writes("<bytes>");
487 for(i
= 0; i
< size
; ++i
) {
490 hex
[0] = hex_table
[byte
>> 4];
491 hex
[1] = hex_table
[byte
& 0xf];
492 trace_dump_write(hex
, 2);
494 trace_dump_writes("</bytes>");
497 void trace_dump_box_bytes(const void *data
,
498 struct pipe_resource
*resource
,
499 const struct pipe_box
*box
,
501 unsigned slice_stride
)
506 * Only dump buffer transfers to avoid huge files.
507 * TODO: Make this run-time configurable
509 if (resource
->target
!= PIPE_BUFFER
) {
512 enum pipe_format format
= resource
->format
;
514 size
= box
->depth
* slice_stride
;
516 size
= util_format_get_nblocksy(format
, box
->height
) * stride
;
518 size
= util_format_get_nblocksx(format
, box
->width
) * util_format_get_blocksize(format
);
522 trace_dump_bytes(data
, size
);
525 void trace_dump_string(const char *str
)
530 trace_dump_writes("<string>");
531 trace_dump_escape(str
);
532 trace_dump_writes("</string>");
535 void trace_dump_enum(const char *value
)
540 trace_dump_writes("<enum>");
541 trace_dump_escape(value
);
542 trace_dump_writes("</enum>");
545 void trace_dump_array_begin(void)
550 trace_dump_writes("<array>");
553 void trace_dump_array_end(void)
558 trace_dump_writes("</array>");
561 void trace_dump_elem_begin(void)
566 trace_dump_writes("<elem>");
569 void trace_dump_elem_end(void)
574 trace_dump_writes("</elem>");
577 void trace_dump_struct_begin(const char *name
)
582 trace_dump_writef("<struct name='%s'>", name
);
585 void trace_dump_struct_end(void)
590 trace_dump_writes("</struct>");
593 void trace_dump_member_begin(const char *name
)
598 trace_dump_writef("<member name='%s'>", name
);
601 void trace_dump_member_end(void)
606 trace_dump_writes("</member>");
609 void trace_dump_null(void)
614 trace_dump_writes("<null/>");
617 void trace_dump_ptr(const void *value
)
623 trace_dump_writef("<ptr>0x%08lx</ptr>", (unsigned long)(uintptr_t)value
);
629 void trace_dump_resource_ptr(struct pipe_resource
*_resource
)
635 struct trace_resource
*tr_resource
= trace_resource(_resource
);
636 trace_dump_ptr(tr_resource
->resource
);
642 void trace_dump_surface_ptr(struct pipe_surface
*_surface
)
648 struct trace_surface
*tr_surf
= trace_surface(_surface
);
649 trace_dump_ptr(tr_surf
->surface
);
655 void trace_dump_transfer_ptr(struct pipe_transfer
*_transfer
)
661 struct trace_transfer
*tr_tran
= trace_transfer(_transfer
);
662 trace_dump_ptr(tr_tran
->transfer
);