Added a brie instruction how to build simple memtest
[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, exception, dont use BLI anywhere else in MEM_* */
66 #include "../../source/blender/blenlib/BLI_sys_types.h"
67
68 /* some GNU attributes are only available from GCC 4.3 */
69 #define MEM_GNU_ATTRIBUTES (defined(__GNUC__) && ((__GNUC__ * 100 + __GNUC_MINOR__) >= 403))
70
71 #ifdef __cplusplus
72 extern "C" {
73 #endif
74
75         /** Returns the length of the allocated memory segment pointed at
76          * by vmemh. If the pointer was not previously allocated by this
77          * module, the result is undefined.*/
78         size_t MEM_allocN_len(const void *vmemh)
79 #if MEM_GNU_ATTRIBUTES
80         __attribute__((warn_unused_result))
81 #endif
82         ;
83
84         /**
85          * Release memory previously allocatred by this module. 
86          */
87         void MEM_freeN(void *vmemh);
88
89 #if 0  /* UNUSED */
90         /**
91          * Return zero if memory is not in allocated list
92          */
93         short MEM_testN(void *vmemh);
94 #endif
95
96         /**
97          * Duplicates a block of memory, and returns a pointer to the
98          * newly allocated block.  */
99         void *MEM_dupallocN(const void *vmemh)
100 #if MEM_GNU_ATTRIBUTES
101         __attribute__((malloc))
102         __attribute__((warn_unused_result))
103 #endif
104         ;
105
106         /**
107          * Reallocates a block of memory, and returns pointer to the newly
108          * allocated block, the old one is freed. this is not as optimized
109          * as a system realloc but just makes a new allocation and copies
110          * over from existing memory. */
111         void *MEM_reallocN_id(void *vmemh, size_t len, const char *str)
112 #if MEM_GNU_ATTRIBUTES
113         __attribute__((malloc))
114         __attribute__((warn_unused_result))
115         __attribute__((alloc_size(2)))
116 #endif
117         ;
118
119         /**
120          * A variant of realloc which zeros new bytes
121          */
122         void *MEM_recallocN_id(void *vmemh, size_t len, const char *str)
123 #if MEM_GNU_ATTRIBUTES
124         __attribute__((malloc))
125         __attribute__((warn_unused_result))
126         __attribute__((alloc_size(2)))
127 #endif
128         ;
129
130 #define MEM_reallocN(vmemh, len) MEM_reallocN_id(vmemh, len, __func__)
131 #define MEM_recallocN(vmemh, len) MEM_recallocN_id(vmemh, len, __func__)
132
133         /**
134          * Allocate a block of memory of size len, with tag name str. The
135          * memory is cleared. The name must be static, because only a
136          * pointer to it is stored ! */
137         void *MEM_callocN(size_t len, const char *str)
138 #if MEM_GNU_ATTRIBUTES
139         __attribute__((malloc))
140         __attribute__((warn_unused_result))
141         __attribute__((nonnull(2)))
142         __attribute__((alloc_size(1)))
143 #endif
144         ;
145
146         /**
147          * Allocate a block of memory of size len, with tag name str. The
148          * name must be a static, because only a pointer to it is stored !
149          * */
150         void *MEM_mallocN(size_t len, const char *str)
151 #if MEM_GNU_ATTRIBUTES
152         __attribute__((malloc))
153         __attribute__((warn_unused_result))
154         __attribute__((nonnull(2)))
155         __attribute__((alloc_size(1)))
156 #endif
157         ;
158
159         /**
160          * Same as callocN, clears memory and uses mmap (disk cached) if supported.
161          * Can be free'd with MEM_freeN as usual.
162          * */
163         void *MEM_mapallocN(size_t len, const char *str)
164 #if MEM_GNU_ATTRIBUTES
165         __attribute__((malloc))
166         __attribute__((warn_unused_result))
167         __attribute__((nonnull(2)))
168         __attribute__((alloc_size(1)))
169 #endif
170         ;
171
172         /** Print a list of the names and sizes of all allocated memory
173          * blocks. as a python dict for easy investigation */ 
174         void MEM_printmemlist_pydict(void);
175
176         /** Print a list of the names and sizes of all allocated memory
177          * blocks. */ 
178         void MEM_printmemlist(void);
179
180         /** calls the function on all allocated memory blocks. */
181         void MEM_callbackmemlist(void (*func)(void *));
182
183         /** Print statistics about memory usage */
184         void MEM_printmemlist_stats(void);
185         
186         /** Set the callback function for error output. */
187         void MEM_set_error_callback(void (*func)(const char *));
188
189         /**
190          * Are the start/end block markers still correct ?
191          *
192          * @retval 0 for correct memory, 1 for corrupted memory. */
193         bool MEM_check_memory_integrity(void);
194
195         /** Set thread locking functions for safe memory allocation from multiple
196          * threads, pass NULL pointers to disable thread locking again. */
197         void MEM_set_lock_callback(void (*lock)(void), void (*unlock)(void));
198         
199         /** Attempt to enforce OSX (or other OS's) to have malloc and stack nonzero */
200         void MEM_set_memory_debug(void);
201
202         /**
203          * Memory usage stats
204          * - MEM_get_memory_in_use is all memory
205          * - MEM_get_mapped_memory_in_use is a subset of all memory */
206         uintptr_t MEM_get_memory_in_use(void);
207         /** Get mapped memory usage. */
208         uintptr_t MEM_get_mapped_memory_in_use(void);
209         /** Get amount of memory blocks in use. */
210         unsigned int MEM_get_memory_blocks_in_use(void);
211
212         /** Reset the peak memory statistic to zero. */
213         void MEM_reset_peak_memory(void);
214
215         /** Get the peak memory usage in bytes, including mmap allocations. */
216         size_t MEM_get_peak_memory(void)
217 #if MEM_GNU_ATTRIBUTES
218         __attribute__((warn_unused_result))
219 #endif
220         ;
221
222 #define MEM_SAFE_FREE(v) if (v) { MEM_freeN(v); v = NULL; } (void)0
223
224 #ifndef NDEBUG
225 const char *MEM_name_ptr(void *vmemh);
226 #endif
227
228 #ifdef __cplusplus
229 /* alloc funcs for C++ only */
230 #define MEM_CXX_CLASS_ALLOC_FUNCS(_id)                                        \
231 public:                                                                       \
232         void *operator new(size_t num_bytes) {                                    \
233                 return MEM_mallocN(num_bytes, _id);                                   \
234         }                                                                         \
235         void operator delete(void *mem) {                                         \
236                 if (mem)                                                              \
237                         MEM_freeN(mem);                                                   \
238         }                                                                         \
239         void *operator new[](size_t num_bytes) {                                  \
240                 return MEM_mallocN(num_bytes, _id "[]");                              \
241         }                                                                         \
242         void operator delete[](void *mem) {                                       \
243                 if (mem)                                                              \
244                         MEM_freeN(mem);                                                   \
245         }                                                                         \
246
247 #endif  /* __cplusplus */
248
249 #ifdef __cplusplus
250 }
251 #endif  /* __cplusplus */
252
253 #endif  /* __MEM_GUARDEDALLOC_H__ */