Memory allocator: Clarify consistency check function
[blender-staging.git] / intern / guardedalloc / MEM_guardedalloc.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Brecht Van Lommel
24  *                 Campbell Barton
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /**
30  * \file MEM_guardedalloc.h
31  * \ingroup MEM
32  *
33  * \author Copyright (C) 2001 NaN Technologies B.V.
34  * \brief Read \ref MEMPage
35  *
36  * \page MEMPage Guarded memory(de)allocation
37  *
38  * \section aboutmem c-style guarded memory allocation
39  *
40  * \subsection memabout About the MEM module
41  *
42  * MEM provides guarded malloc/calloc calls. All memory is enclosed by
43  * pads, to detect out-of-bound writes. All blocks are placed in a
44  * linked list, so they remain reachable at all times. There is no
45  * back-up in case the linked-list related data is lost.
46  *
47  * \subsection memissues Known issues with MEM
48  *
49  * There are currently no known issues with MEM. Note that there is a
50  * second intern/ module with MEM_ prefix, for use in c++.
51  * 
52  * \subsection memdependencies Dependencies
53  * - stdlib
54  * - stdio
55  * 
56  * \subsection memdocs API Documentation
57  * See \ref MEM_guardedalloc.h
58  */
59
60 #ifndef __MEM_GUARDEDALLOC_H__
61 #define __MEM_GUARDEDALLOC_H__
62
63 #include <stdio.h>          /* needed for FILE* */
64
65 /* needed for uintptr_t and attributes, exception, dont use BLI anywhere else in MEM_* */
66 #include "../../source/blender/blenlib/BLI_sys_types.h"
67 #include "../../source/blender/blenlib/BLI_compiler_attrs.h"
68
69 #ifdef __cplusplus
70 extern "C" {
71 #endif
72
73         /** Returns the length of the allocated memory segment pointed at
74          * by vmemh. If the pointer was not previously allocated by this
75          * module, the result is undefined.*/
76         extern size_t (*MEM_allocN_len)(const void *vmemh) ATTR_WARN_UNUSED_RESULT;
77
78         /**
79          * Release memory previously allocated by this module.
80          */
81         extern void (*MEM_freeN)(void *vmemh);
82
83 #if 0  /* UNUSED */
84         /**
85          * Return zero if memory is not in allocated list
86          */
87         extern short (*MEM_testN)(void *vmemh);
88 #endif
89
90         /**
91          * Duplicates a block of memory, and returns a pointer to the
92          * newly allocated block.  */
93         extern void *(*MEM_dupallocN)(const void *vmemh) /* ATTR_MALLOC */ ATTR_WARN_UNUSED_RESULT;
94
95         /**
96          * Reallocates a block of memory, and returns pointer to the newly
97          * allocated block, the old one is freed. this is not as optimized
98          * as a system realloc but just makes a new allocation and copies
99          * over from existing memory. */
100         extern void *(*MEM_reallocN_id)(void *vmemh, size_t len, const char *str) /* ATTR_MALLOC */ ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(2);
101
102         /**
103          * A variant of realloc which zeros new bytes
104          */
105         extern void *(*MEM_recallocN_id)(void *vmemh, size_t len, const char *str) /* ATTR_MALLOC */ ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(2);
106
107 #define MEM_reallocN(vmemh, len) MEM_reallocN_id(vmemh, len, __func__)
108 #define MEM_recallocN(vmemh, len) MEM_recallocN_id(vmemh, len, __func__)
109
110         /**
111          * Allocate a block of memory of size len, with tag name str. The
112          * memory is cleared. The name must be static, because only a
113          * pointer to it is stored ! */
114         extern void *(*MEM_callocN)(size_t len, const char *str) /* ATTR_MALLOC */ ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2);
115
116         /**
117          * Allocate a block of memory of size (len * size), with tag name
118          * str, aborting in case of integer overflows to prevent vulnerabilities.
119          * The memory is cleared. The name must be static, because only a
120          * pointer to it is stored ! */
121         extern void *(*MEM_calloc_arrayN)(size_t len, size_t size, const char *str) /* ATTR_MALLOC */ ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1,2) ATTR_NONNULL(3);
122
123         /**
124          * Allocate a block of memory of size len, with tag name str. The
125          * name must be a static, because only a pointer to it is stored !
126          * */
127         extern void *(*MEM_mallocN)(size_t len, const char *str) /* ATTR_MALLOC */ ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2);
128
129         /**
130          * Allocate a block of memory of size (len * size), with tag name str,
131          * aborting in case of integer overflow to prevent vulnerabilities. The
132          * name must be a static, because only a pointer to it is stored !
133          * */
134         extern void *(*MEM_malloc_arrayN)(size_t len, size_t size, const char *str) /* ATTR_MALLOC */ ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1,2) ATTR_NONNULL(3);
135
136         /**
137          * Allocate an aligned block of memory of size len, with tag name str. The
138          * name must be a static, because only a pointer to it is stored !
139          * */
140         extern void *(*MEM_mallocN_aligned)(size_t len, size_t alignment, const char *str) /* ATTR_MALLOC */ ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(3);
141
142         /**
143          * Same as callocN, clears memory and uses mmap (disk cached) if supported.
144          * Can be free'd with MEM_freeN as usual.
145          * */
146         extern void *(*MEM_mapallocN)(size_t len, const char *str) /* ATTR_MALLOC */ ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2);
147
148         /** Print a list of the names and sizes of all allocated memory
149          * blocks. as a python dict for easy investigation */ 
150         extern void (*MEM_printmemlist_pydict)(void);
151
152         /** Print a list of the names and sizes of all allocated memory
153          * blocks. */ 
154         extern void (*MEM_printmemlist)(void);
155
156         /** calls the function on all allocated memory blocks. */
157         extern void (*MEM_callbackmemlist)(void (*func)(void *));
158
159         /** Print statistics about memory usage */
160         extern void (*MEM_printmemlist_stats)(void);
161         
162         /** Set the callback function for error output. */
163         extern void (*MEM_set_error_callback)(void (*func)(const char *));
164
165         /**
166          * Are the start/end block markers still correct ?
167          *
168          * @retval true for correct memory, false for corrupted memory. */
169         extern bool (*MEM_consistency_check)(void);
170
171         /** Set thread locking functions for safe memory allocation from multiple
172          * threads, pass NULL pointers to disable thread locking again. */
173         extern void (*MEM_set_lock_callback)(void (*lock)(void), void (*unlock)(void));
174         
175         /** Attempt to enforce OSX (or other OS's) to have malloc and stack nonzero */
176         extern void (*MEM_set_memory_debug)(void);
177
178         /**
179          * Memory usage stats
180          * - MEM_get_memory_in_use is all memory
181          * - MEM_get_mapped_memory_in_use is a subset of all memory */
182         extern size_t (*MEM_get_memory_in_use)(void);
183         /** Get mapped memory usage. */
184         extern size_t (*MEM_get_mapped_memory_in_use)(void);
185         /** Get amount of memory blocks in use. */
186         extern unsigned int (*MEM_get_memory_blocks_in_use)(void);
187
188         /** Reset the peak memory statistic to zero. */
189         extern void (*MEM_reset_peak_memory)(void);
190
191         /** Get the peak memory usage in bytes, including mmap allocations. */
192         extern size_t (*MEM_get_peak_memory)(void) ATTR_WARN_UNUSED_RESULT;
193
194 #ifdef __GNUC__
195 #define MEM_SAFE_FREE(v) do { \
196         typeof(&(v)) _v = &(v); \
197         if (*_v) { \
198                 MEM_freeN(*_v); \
199                 *_v = NULL; \
200         } \
201 } while (0)
202 #else
203 #define MEM_SAFE_FREE(v) do { \
204         void ** _v = (void **)&(v); \
205         if (*_v) { \
206                 MEM_freeN(*_v); \
207                 *_v = NULL; \
208         } \
209 } while (0)
210 #endif
211
212 /* overhead for lockfree allocator (use to avoid slop-space) */
213 #define MEM_SIZE_OVERHEAD sizeof(size_t)
214 #define MEM_SIZE_OPTIMAL(size) ((size) - MEM_SIZE_OVERHEAD)
215
216 #ifndef NDEBUG
217 extern const char *(*MEM_name_ptr)(void *vmemh);
218 #endif
219
220 /* Switch allocator to slower but fully guarded mode. */
221 void MEM_use_guarded_allocator(void);
222
223 #ifdef __cplusplus
224 /* alloc funcs for C++ only */
225 #define MEM_CXX_CLASS_ALLOC_FUNCS(_id)                                        \
226 public:                                                                       \
227         void *operator new(size_t num_bytes) {                                    \
228                 return MEM_mallocN(num_bytes, _id);                                   \
229         }                                                                         \
230         void operator delete(void *mem) {                                         \
231                 if (mem)                                                              \
232                         MEM_freeN(mem);                                                   \
233         }                                                                         \
234         void *operator new[](size_t num_bytes) {                                  \
235                 return MEM_mallocN(num_bytes, _id "[]");                              \
236         }                                                                         \
237         void operator delete[](void *mem) {                                       \
238                 if (mem)                                                              \
239                         MEM_freeN(mem);                                                   \
240         }                                                                         \
241
242 #if defined __GNUC__
243 #  define OBJECT_GUARDED_NEW(type, args ...) \
244         new(MEM_mallocN(sizeof(type), __func__)) type(args)
245 #else
246 #  define OBJECT_GUARDED_NEW(type, ...) \
247         new(MEM_mallocN(sizeof(type), __FUNCTION__)) type(__VA_ARGS__)
248 #endif
249 #define OBJECT_GUARDED_DELETE(what, type) \
250         { if(what) { \
251                         ((type*)(what))->~type(); \
252                         MEM_freeN(what); \
253         } } (void)0
254 #endif  /* __cplusplus */
255
256 #ifdef __cplusplus
257 }
258 #endif  /* __cplusplus */
259
260 #endif  /* __MEM_GUARDEDALLOC_H__ */