1 /**************************************************************************
2 *
3 * Copyright 2010 Luca Barbieri
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining
6 * a copy of this software and associated documentation files (the
7 * "Software"), to deal in the Software without restriction, including
8 * without limitation the rights to use, copy, modify, merge, publish,
9 * distribute, sublicense, and/or sell copies of the Software, and to
10 * permit persons to whom the Software is furnished to do so, subject to
11 * the following conditions:
12 *
13 * The above copyright notice and this permission notice (including the
14 * next paragraph) shall be included in all copies or substantial
15 * portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
20 * IN NO EVENT SHALL THE COPYRIGHT OWNER(S) AND/OR ITS SUPPLIERS BE
21 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
22 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
23 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24 *
25 **************************************************************************/
26
27 #if defined(DEBUG)
28
29 /**
30 * If the GALLIUM_REFCNT_LOG env var is defined as a filename, gallium
31 * reference counting will be logged to the file.
32 *
33 * See http://www-archive.mozilla.org/performance/refcnt-balancer.html
34 * for what to do with the output on Linux, use tools/addr2line.sh to
35 * postprocess it before anything else.
36 */
37
38 #include <stdio.h>
39
40 #include "util/u_debug.h"
41 #include "util/u_debug_refcnt.h"
42 #include "util/u_debug_stack.h"
43 #include "util/u_debug_symbol.h"
44 #include "util/u_string.h"
45 #include "util/u_hash_table.h"
46 #include "os/os_thread.h"
47 #include "pipe/p_config.h"
48
49 int debug_refcnt_state;
50
51 static FILE *stream;
52
53 /* TODO: maybe move this serial machinery to a stand-alone module and
54 * expose it?
55 */
56 #ifdef PIPE_OS_WINDOWS
57 static mtx_t serials_mutex;
58 #else
59 static mtx_t serials_mutex = _MTX_INITIALIZER_NP;
60 #endif
61
62 static struct hash_table *serials_hash;
63 static unsigned serials_last;
64
65
66 /**
67 * Return a small integer serial number for the given pointer.
68 */
69 static boolean
debug_serial(void * p,unsigned * pserial)70 debug_serial(void *p, unsigned *pserial)
71 {
72 unsigned serial;
73 boolean found = TRUE;
74 #ifdef PIPE_OS_WINDOWS
75 static boolean first = TRUE;
76
77 if (first) {
78 (void) mtx_init(&serials_mutex, mtx_plain);
79 first = FALSE;
80 }
81 #endif
82
83 mtx_lock(&serials_mutex);
84 if (!serials_hash)
85 serials_hash = util_hash_table_create_ptr_keys();
86
87 serial = (unsigned) (uintptr_t) util_hash_table_get(serials_hash, p);
88 if (!serial) {
89 /* time to stop logging... (you'll have a 100 GB logfile at least at
90 * this point) TODO: avoid this
91 */
92 serial = ++serials_last;
93 if (!serial) {
94 debug_error("More than 2^32 objects detected, aborting.\n");
95 os_abort();
96 }
97
98 _mesa_hash_table_insert(serials_hash, p, (void *) (uintptr_t) serial);
99 found = FALSE;
100 }
101 mtx_unlock(&serials_mutex);
102
103 *pserial = serial;
104
105 return found;
106 }
107
108
109 /**
110 * Free the serial number for the given pointer.
111 */
112 static void
debug_serial_delete(void * p)113 debug_serial_delete(void *p)
114 {
115 mtx_lock(&serials_mutex);
116 _mesa_hash_table_remove_key(serials_hash, p);
117 mtx_unlock(&serials_mutex);
118 }
119
120
121 #if defined(PIPE_OS_WINDOWS)
122 #define STACK_LEN 60
123 #else
124 #define STACK_LEN 64
125 #endif
126
127 /**
128 * Log a reference count change to the log file (if enabled).
129 * This is called via the pipe_reference() and debug_reference() functions,
130 * basically whenever a reference count is initialized or changed.
131 *
132 * \param p the refcount being changed (the value is not changed here)
133 * \param get_desc a function which will be called to print an object's
134 * name/pointer into a string buffer during logging
135 * \param change the reference count change which must be +/-1 or 0 when
136 * creating the object and initializing the refcount.
137 */
138 void
debug_reference_slowpath(const struct pipe_reference * p,debug_reference_descriptor get_desc,int change)139 debug_reference_slowpath(const struct pipe_reference *p,
140 debug_reference_descriptor get_desc, int change)
141 {
142 assert(change >= -1);
143 assert(change <= 1);
144
145 if (debug_refcnt_state < 0)
146 return;
147
148 if (!debug_refcnt_state) {
149 const char *filename = debug_get_option("GALLIUM_REFCNT_LOG", NULL);
150 if (filename && filename[0])
151 stream = fopen(filename, "wt");
152
153 if (stream)
154 debug_refcnt_state = 1;
155 else
156 debug_refcnt_state = -1;
157 }
158
159 if (debug_refcnt_state > 0) {
160 struct debug_stack_frame frames[STACK_LEN];
161 char buf[1024];
162 unsigned i;
163 unsigned refcnt = p->count;
164 unsigned serial;
165 boolean existing = debug_serial((void *) p, &serial);
166
167 debug_backtrace_capture(frames, 1, STACK_LEN);
168
169 get_desc(buf, p);
170
171 if (!existing) {
172 fprintf(stream, "<%s> %p %u Create\n", buf, (void *) p, serial);
173 debug_backtrace_print(stream, frames, STACK_LEN);
174
175 /* this is here to provide a gradual change even if we don't see
176 * the initialization
177 */
178 for (i = 1; i <= refcnt - change; ++i) {
179 fprintf(stream, "<%s> %p %u AddRef %u\n", buf, (void *) p,
180 serial, i);
181 debug_backtrace_print(stream, frames, STACK_LEN);
182 }
183 }
184
185 if (change) {
186 fprintf(stream, "<%s> %p %u %s %u\n", buf, (void *) p, serial,
187 change > 0 ? "AddRef" : "Release", refcnt);
188 debug_backtrace_print(stream, frames, STACK_LEN);
189 }
190
191 if (!refcnt) {
192 debug_serial_delete((void *) p);
193 fprintf(stream, "<%s> %p %u Destroy\n", buf, (void *) p, serial);
194 debug_backtrace_print(stream, frames, STACK_LEN);
195 }
196
197 fflush(stream);
198 }
199 }
200
201 #endif /* DEBUG */
202