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 **************************************************************************/
30 * Trace data dumping primitives.
37 #include "pipe/p_compiler.h"
48 void trace_dump_init(void);
51 * Low level dumping controls.
53 * Opening the trace file and checking if that is opened.
55 boolean trace_dump_trace_begin(void);
56 boolean trace_dump_trace_enabled(void);
57 void trace_dump_trace_end(void);
60 * Lock and unlock the call mutex.
62 * It used by the none locked version of dumping control
63 * and begin/end call dump functions.
65 * Begin takes the lock while end unlocks it. Use the _locked
66 * version to avoid locking/unlocking it.
68 void trace_dump_call_lock(void);
69 void trace_dump_call_unlock(void);
72 * High level dumping control.
74 void trace_dumping_start_locked(void);
75 void trace_dumping_stop_locked(void);
76 boolean trace_dumping_enabled_locked(void);
77 void trace_dumping_start(void);
78 void trace_dumping_stop(void);
79 boolean trace_dumping_enabled(void);
81 void trace_dump_call_begin_locked(const char *klass, const char *method);
82 void trace_dump_call_end_locked(void);
83 void trace_dump_call_begin(const char *klass, const char *method);
84 void trace_dump_call_end(void);
86 void trace_dump_arg_begin(const char *name);
87 void trace_dump_arg_end(void);
88 void trace_dump_ret_begin(void);
89 void trace_dump_ret_end(void);
90 void trace_dump_bool(int value);
91 void trace_dump_int(long long int value);
92 void trace_dump_uint(long long unsigned value);
93 void trace_dump_float(double value);
94 void trace_dump_bytes(const void *data, size_t size);
95 void trace_dump_box_bytes(const void *data,
97 const struct pipe_box *box,
99 unsigned slice_stride);
100 void trace_dump_string(const char *str);
101 void trace_dump_enum(const char *value);
102 void trace_dump_array_begin(void);
103 void trace_dump_array_end(void);
104 void trace_dump_elem_begin(void);
105 void trace_dump_elem_end(void);
106 void trace_dump_struct_begin(const char *name);
107 void trace_dump_struct_end(void);
108 void trace_dump_member_begin(const char *name);
109 void trace_dump_member_end(void);
110 void trace_dump_null(void);
111 void trace_dump_ptr(const void *value);
112 /* will turn a wrapped object into the real one and dump ptr */
113 void trace_dump_resource_ptr(struct pipe_resource *_texture);
114 void trace_dump_surface_ptr(struct pipe_surface *_surface);
115 void trace_dump_transfer_ptr(struct pipe_transfer *_transfer);
118 * Code saving macros.
121 #define trace_dump_arg(_type, _arg) \
123 trace_dump_arg_begin(#_arg); \
124 trace_dump_##_type(_arg); \
125 trace_dump_arg_end(); \
128 #define trace_dump_ret(_type, _arg) \
130 trace_dump_ret_begin(); \
131 trace_dump_##_type(_arg); \
132 trace_dump_ret_end(); \
135 #define trace_dump_array(_type, _obj, _size) \
138 trace_dump_array_begin(); \
139 for(idx = 0; idx < (_size); ++idx) { \
140 trace_dump_elem_begin(); \
141 trace_dump_##_type((_obj)[idx]); \
142 trace_dump_elem_end(); \
144 trace_dump_array_end(); \
147 #define trace_dump_struct_array(_type, _obj, _size) \
150 trace_dump_array_begin(); \
151 for(idx = 0; idx < (_size); ++idx) { \
152 trace_dump_elem_begin(); \
153 trace_dump_##_type(&(_obj)[idx]); \
154 trace_dump_elem_end(); \
156 trace_dump_array_end(); \
159 #define trace_dump_member(_type, _obj, _member) \
161 trace_dump_member_begin(#_member); \
162 trace_dump_##_type((_obj)->_member); \
163 trace_dump_member_end(); \
166 #define trace_dump_arg_array(_type, _arg, _size) \
168 trace_dump_arg_begin(#_arg); \
169 trace_dump_array(_type, _arg, _size); \
170 trace_dump_arg_end(); \
173 #define trace_dump_member_array(_type, _obj, _member) \
175 trace_dump_member_begin(#_member); \
176 trace_dump_array(_type, (_obj)->_member, sizeof((_obj)->_member)/sizeof((_obj)->_member[0])); \
177 trace_dump_member_end(); \
181 #endif /* TR_DUMP_H */