1 /**************************************************************************
3 * Copyright 2012 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 **************************************************************************/
30 * u_debug_flush.c Debug flush and map-related issues:
31 * - Flush while synchronously mapped.
32 * - Command stream reference while synchronously mapped.
33 * - Synchronous map while referenced on command stream.
35 * - Unmap while not mapped.
37 * @author Thomas Hellstrom <thellstrom@vmware.com>
41 #include "pipe/p_compiler.h"
42 #include "util/u_debug_stack.h"
43 #include "util/u_debug.h"
44 #include "util/u_memory.h"
45 #include "util/u_debug_flush.h"
46 #include "util/u_hash_table.h"
47 #include "util/list.h"
48 #include "util/u_inlines.h"
49 #include "util/u_string.h"
50 #include "os/os_thread.h"
53 struct debug_flush_buf
{
55 struct pipe_reference reference
; /* Must be the first member. */
58 boolean supports_unsync
;
60 /* Protected by mutex */
63 struct debug_stack_frame
*map_frame
;
66 struct debug_flush_item
{
67 struct debug_flush_buf
*fbuf
;
69 struct debug_stack_frame
*ref_frame
;
72 struct debug_flush_ctx
{
73 /* Contexts are used by a single thread at a time */
75 boolean catch_map_of_referenced
;
76 struct util_hash_table
*ref_hash
;
77 struct list_head head
;
80 static mtx_t list_mutex
= _MTX_INITIALIZER_NP
;
81 static struct list_head ctx_list
= {&ctx_list
, &ctx_list
};
83 static struct debug_stack_frame
*
84 debug_flush_capture_frame(int start
, int depth
)
86 struct debug_stack_frame
*frames
;
88 frames
= CALLOC(depth
, sizeof(*frames
));
92 debug_backtrace_capture(frames
, start
, depth
);
97 debug_flush_pointer_compare(void *key1
, void *key2
)
99 return (key1
== key2
) ? 0 : 1;
103 debug_flush_pointer_hash(void *key
)
105 return (unsigned) (unsigned long) key
;
108 struct debug_flush_buf
*
109 debug_flush_buf_create(boolean supports_unsync
, unsigned bt_depth
)
111 struct debug_flush_buf
*fbuf
= CALLOC_STRUCT(debug_flush_buf
);
116 fbuf
->supports_unsync
= supports_unsync
;
117 fbuf
->bt_depth
= bt_depth
;
118 pipe_reference_init(&fbuf
->reference
, 1);
119 (void) mtx_init(&fbuf
->mutex
, mtx_plain
);
123 debug_printf("Debug flush buffer creation failed.\n");
124 debug_printf("Debug flush checking for this buffer will be incomplete.\n");
129 debug_flush_buf_reference(struct debug_flush_buf
**dst
,
130 struct debug_flush_buf
*src
)
132 struct debug_flush_buf
*fbuf
= *dst
;
134 if (pipe_reference(&(*dst
)->reference
, &src
->reference
)) {
135 FREE(fbuf
->map_frame
);
144 debug_flush_item_destroy(struct debug_flush_item
*item
)
146 debug_flush_buf_reference(&item
->fbuf
, NULL
);
148 FREE(item
->ref_frame
);
153 struct debug_flush_ctx
*
154 debug_flush_ctx_create(UNUSED boolean catch_reference_of_mapped
,
157 struct debug_flush_ctx
*fctx
= CALLOC_STRUCT(debug_flush_ctx
);
162 fctx
->ref_hash
= util_hash_table_create(debug_flush_pointer_hash
,
163 debug_flush_pointer_compare
);
166 goto out_no_ref_hash
;
168 fctx
->bt_depth
= bt_depth
;
169 mtx_lock(&list_mutex
);
170 list_addtail(&fctx
->head
, &ctx_list
);
171 mtx_unlock(&list_mutex
);
178 debug_printf("Debug flush context creation failed.\n");
179 debug_printf("Debug flush checking for this context will be incomplete.\n");
184 debug_flush_alert(const char *s
, const char *op
,
185 unsigned start
, unsigned depth
,
188 const struct debug_stack_frame
*frame
)
191 frame
= debug_flush_capture_frame(start
, depth
);
194 debug_printf("%s ", s
);
196 debug_printf("%s backtrace follows:\n", op
);
197 debug_backtrace_dump(frame
, depth
);
199 debug_printf("No %s backtrace was captured.\n", op
);
202 debug_printf("**********************************\n");
204 debug_printf("*********END OF MESSAGE***********\n\n\n");
212 debug_flush_map(struct debug_flush_buf
*fbuf
, unsigned flags
)
214 boolean mapped_sync
= FALSE
;
219 mtx_lock(&fbuf
->mutex
);
221 debug_flush_alert("Recursive map detected.", "Map",
222 2, fbuf
->bt_depth
, TRUE
, TRUE
, NULL
);
223 debug_flush_alert(NULL
, "Previous map", 0, fbuf
->bt_depth
, FALSE
,
224 FALSE
, fbuf
->map_frame
);
225 } else if (!(flags
& PIPE_TRANSFER_UNSYNCHRONIZED
) ||
226 !fbuf
->supports_unsync
) {
227 fbuf
->mapped_sync
= mapped_sync
= TRUE
;
229 fbuf
->map_frame
= debug_flush_capture_frame(1, fbuf
->bt_depth
);
231 mtx_unlock(&fbuf
->mutex
);
234 struct debug_flush_ctx
*fctx
;
236 mtx_lock(&list_mutex
);
237 LIST_FOR_EACH_ENTRY(fctx
, &ctx_list
, head
) {
238 struct debug_flush_item
*item
=
239 util_hash_table_get(fctx
->ref_hash
, fbuf
);
241 if (item
&& fctx
->catch_map_of_referenced
) {
242 debug_flush_alert("Already referenced map detected.",
243 "Map", 2, fbuf
->bt_depth
, TRUE
, TRUE
, NULL
);
244 debug_flush_alert(NULL
, "Reference", 0, item
->bt_depth
,
245 FALSE
, FALSE
, item
->ref_frame
);
248 mtx_unlock(&list_mutex
);
253 debug_flush_unmap(struct debug_flush_buf
*fbuf
)
258 mtx_lock(&fbuf
->mutex
);
260 debug_flush_alert("Unmap not previously mapped detected.", "Map",
261 2, fbuf
->bt_depth
, FALSE
, TRUE
, NULL
);
263 fbuf
->mapped_sync
= FALSE
;
264 fbuf
->mapped
= FALSE
;
265 FREE(fbuf
->map_frame
);
266 fbuf
->map_frame
= NULL
;
267 mtx_unlock(&fbuf
->mutex
);
272 * Add the given buffer to the list of active buffers. Active buffers
273 * are those which are referenced by the command buffer currently being
277 debug_flush_cb_reference(struct debug_flush_ctx
*fctx
,
278 struct debug_flush_buf
*fbuf
)
280 struct debug_flush_item
*item
;
285 item
= util_hash_table_get(fctx
->ref_hash
, fbuf
);
287 mtx_lock(&fbuf
->mutex
);
288 if (fbuf
->mapped_sync
) {
289 debug_flush_alert("Reference of mapped buffer detected.", "Reference",
290 2, fctx
->bt_depth
, TRUE
, TRUE
, NULL
);
291 debug_flush_alert(NULL
, "Map", 0, fbuf
->bt_depth
, FALSE
,
292 FALSE
, fbuf
->map_frame
);
294 mtx_unlock(&fbuf
->mutex
);
297 item
= CALLOC_STRUCT(debug_flush_item
);
299 debug_flush_buf_reference(&item
->fbuf
, fbuf
);
300 item
->bt_depth
= fctx
->bt_depth
;
301 item
->ref_frame
= debug_flush_capture_frame(2, item
->bt_depth
);
302 if (util_hash_table_set(fctx
->ref_hash
, fbuf
, item
) != PIPE_OK
) {
303 debug_flush_item_destroy(item
);
313 debug_printf("Debug flush command buffer reference creation failed.\n");
314 debug_printf("Debug flush checking will be incomplete "
315 "for this command batch.\n");
318 static enum pipe_error
319 debug_flush_might_flush_cb(UNUSED
void *key
, void *value
, void *data
)
321 struct debug_flush_item
*item
=
322 (struct debug_flush_item
*) value
;
323 struct debug_flush_buf
*fbuf
= item
->fbuf
;
325 mtx_lock(&fbuf
->mutex
);
326 if (fbuf
->mapped_sync
) {
327 const char *reason
= (const char *) data
;
330 util_snprintf(message
, sizeof(message
),
331 "%s referenced mapped buffer detected.", reason
);
333 debug_flush_alert(message
, reason
, 3, item
->bt_depth
, TRUE
, TRUE
, NULL
);
334 debug_flush_alert(NULL
, "Map", 0, fbuf
->bt_depth
, TRUE
, FALSE
,
336 debug_flush_alert(NULL
, "First reference", 0, item
->bt_depth
, FALSE
,
337 FALSE
, item
->ref_frame
);
339 mtx_unlock(&fbuf
->mutex
);
345 * Called when we're about to possibly flush a command buffer.
346 * We check if any active buffers are in a mapped state. If so, print an alert.
349 debug_flush_might_flush(struct debug_flush_ctx
*fctx
)
354 util_hash_table_foreach(fctx
->ref_hash
,
355 debug_flush_might_flush_cb
,
359 static enum pipe_error
360 debug_flush_flush_cb(UNUSED
void *key
, void *value
, UNUSED
void *data
)
362 struct debug_flush_item
*item
=
363 (struct debug_flush_item
*) value
;
365 debug_flush_item_destroy(item
);
372 * Called when we flush a command buffer. Two things are done:
373 * 1. Check if any of the active buffers are currently mapped (alert if so).
374 * 2. Discard/unreference all the active buffers.
377 debug_flush_flush(struct debug_flush_ctx
*fctx
)
382 util_hash_table_foreach(fctx
->ref_hash
,
383 debug_flush_might_flush_cb
,
385 util_hash_table_foreach(fctx
->ref_hash
,
386 debug_flush_flush_cb
,
388 util_hash_table_clear(fctx
->ref_hash
);
392 debug_flush_ctx_destroy(struct debug_flush_ctx
*fctx
)
397 list_del(&fctx
->head
);
398 util_hash_table_foreach(fctx
->ref_hash
,
399 debug_flush_flush_cb
,
401 util_hash_table_clear(fctx
->ref_hash
);
402 util_hash_table_destroy(fctx
->ref_hash
);