8f3e936cbbf5b53f990c12d547302ec7968425c7
[mesa.git] / src / util / os_memory_debug.h
1 /**************************************************************************
2 *
3 * Copyright 2008-2010 VMware, Inc.
4 * All Rights Reserved.
5 *
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:
13 *
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
16 * of the Software.
17 *
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.
25 *
26 **************************************************************************/
27
28
29 /*
30 * Debugging wrappers for OS memory management abstractions.
31 */
32
33
34 #ifndef _OS_MEMORY_H_
35 #error "Must not be included directly. Include os_memory.h instead"
36 #endif
37
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43
44 void *
45 debug_malloc(const char *file, unsigned line, const char *function,
46 size_t size);
47
48 void *
49 debug_calloc(const char *file, unsigned line, const char *function,
50 size_t count, size_t size );
51
52 void
53 debug_free(const char *file, unsigned line, const char *function,
54 void *ptr);
55
56 void *
57 debug_realloc(const char *file, unsigned line, const char *function,
58 void *old_ptr, size_t old_size, size_t new_size );
59
60 void
61 debug_memory_tag(void *ptr, unsigned tag);
62
63 void
64 debug_memory_check_block(void *ptr);
65
66 void
67 debug_memory_check(void);
68
69
70 #ifdef __cplusplus
71 }
72 #endif
73
74
75 #ifndef DEBUG_MEMORY_IMPLEMENTATION
76
77 #define os_malloc( _size ) \
78 debug_malloc( __FILE__, __LINE__, __FUNCTION__, _size )
79 #define os_calloc( _count, _size ) \
80 debug_calloc(__FILE__, __LINE__, __FUNCTION__, _count, _size )
81 #define os_free( _ptr ) \
82 debug_free( __FILE__, __LINE__, __FUNCTION__, _ptr )
83 #define os_realloc( _ptr, _old_size, _new_size ) \
84 debug_realloc( __FILE__, __LINE__, __FUNCTION__, _ptr, _old_size, _new_size )
85
86 /* TODO: wrap os_malloc_aligned() and os_free_aligned() too */
87 #include "os_memory_aligned.h"
88
89 #endif /* !DEBUG_MEMORY_IMPLEMENTATION */