use gcc attrubutes to warn on unused return values and arguments which shouldnt be...
[blender.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): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file MEM_guardedalloc.h
29  *  \ingroup MEM
30  *
31  *  \author Copyright (C) 2001 NaN Technologies B.V.
32  *  \brief Read \ref MEMPage
33  */
34
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 #include "MEM_sys_types.h" /* needed for uintptr_t */
65
66 #ifdef __cplusplus
67 extern "C" {
68 #endif
69
70         /** Returns the length of the allocated memory segment pointed at
71          * by vmemh. If the pointer was not previously allocated by this
72          * module, the result is undefined.*/
73         size_t MEM_allocN_len(void *vmemh)
74 #ifdef __GNUC__
75         __attribute__((warn_unused_result))
76         __attribute__((nonnull))
77 #endif
78         ;
79
80         /**
81          * Release memory previously allocatred by this module. 
82          */
83         short MEM_freeN(void *vmemh)
84 #ifdef __GNUC__
85         __attribute__((nonnull))
86 #endif
87         ;
88
89         /**
90          * Return zero if memory is not in allocated list
91          */
92         short MEM_testN(void *vmemh);
93
94         /**
95          * Duplicates a block of memory, and returns a pointer to the
96          * newly allocated block.  */
97         void *MEM_dupallocN(void *vmemh)
98 #ifdef __GNUC__
99         __attribute__((warn_unused_result))
100         __attribute__((nonnull))
101 #endif
102         ;
103
104         /**
105          * Reallocates a block of memory, and returns pointer to the newly
106          * allocated block, the old one is freed. this is not as optimized
107          * as a system realloc but just makes a new allocation and copies
108          * over from existing memory. */
109         void *MEM_reallocN(void *vmemh, size_t len)
110 #ifdef __GNUC__
111         __attribute__((warn_unused_result))
112         __attribute__((nonnull))
113         __attribute__((alloc_size(2)))
114 #endif
115         ;
116
117         /**
118          * Allocate a block of memory of size len, with tag name str. The
119          * memory is cleared. The name must be static, because only a
120          * pointer to it is stored ! */
121         void *MEM_callocN(size_t len, const char * str)
122 #ifdef __GNUC__
123         __attribute__((warn_unused_result))
124         __attribute__((nonnull))
125         __attribute__((alloc_size(1)))
126 #endif
127         ;
128         
129         /** Allocate a block of memory of size len, with tag name str. The
130          * name must be a static, because only a pointer to it is stored !
131          * */
132         void *MEM_mallocN(size_t len, const char * str)
133 #ifdef __GNUC__
134         __attribute__((warn_unused_result))
135         __attribute__((nonnull))
136         __attribute__((alloc_size(1)))
137 #endif
138         ;
139         
140         /** Same as callocN, clears memory and uses mmap (disk cached) if supported.
141          * Can be free'd with MEM_freeN as usual.
142          * */
143         void *MEM_mapallocN(size_t len, const char * str)
144 #ifdef __GNUC__
145         __attribute__((warn_unused_result))
146         __attribute__((nonnull))
147         __attribute__((alloc_size(1)))
148 #endif
149         ;
150
151         /** Print a list of the names and sizes of all allocated memory
152          * blocks. as a python dict for easy investigation */ 
153         void MEM_printmemlist_pydict(void);
154
155         /** Print a list of the names and sizes of all allocated memory
156          * blocks. */ 
157         void MEM_printmemlist(void);
158
159         /** calls the function on all allocated memory blocks. */
160         void MEM_callbackmemlist(void (*func)(void*));
161
162         /** Print statistics about memory usage */
163         void MEM_printmemlist_stats(void);
164         
165         /** Set the callback function for error output. */
166         void MEM_set_error_callback(void (*func)(const char *));
167
168         /**
169          * Are the start/end block markers still correct ?
170          *
171          * @retval 0 for correct memory, 1 for corrupted memory. */
172         int MEM_check_memory_integrity(void);
173
174         /** Set thread locking functions for safe memory allocation from multiple
175          * threads, pass NULL pointers to disable thread locking again. */
176         void MEM_set_lock_callback(void (*lock)(void), void (*unlock)(void));
177         
178         /** Attempt to enforce OSX (or other OS's) to have malloc and stack nonzero */
179         void MEM_set_memory_debug(void);
180
181         /** Memory usage stats
182          * - MEM_get_memory_in_use is all memory
183          * - MEM_get_mapped_memory_in_use is a subset of all memory */
184         uintptr_t MEM_get_memory_in_use(void);
185         /** Get mapped memory usage. */
186         uintptr_t MEM_get_mapped_memory_in_use(void);
187         /** Get amount of memory blocks in use. */
188         int MEM_get_memory_blocks_in_use(void);
189
190         /** Reset the peak memory statistic to zero. */
191         void MEM_reset_peak_memory(void);
192
193         /** Get the peak memory usage in bytes, including mmap allocations. */
194         uintptr_t MEM_get_peak_memory(void)
195 #ifdef __GNUC__
196         __attribute__((warn_unused_result))
197 #endif
198         ;
199
200 #ifndef NDEBUG
201 const char *MEM_name_ptr(void *vmemh);
202 #endif
203
204 #ifdef __cplusplus
205 /* alloc funcs for C++ only */
206 #define MEM_CXX_CLASS_ALLOC_FUNCS(_id)                                        \
207 public:                                                                       \
208         void *operator new(size_t num_bytes) {                                    \
209                 return MEM_mallocN(num_bytes, _id);                                   \
210         }                                                                         \
211         void operator delete(void *mem) {                                         \
212                 if (mem)                                                              \
213                         MEM_freeN(mem);                                                   \
214         }                                                                         \
215         void *operator new[](size_t num_bytes) {                                  \
216                 return MEM_mallocN(num_bytes, _id "[]");                              \
217         }                                                                         \
218         void operator delete[](void *mem) {                                       \
219                 if (mem)                                                              \
220                         MEM_freeN(mem);                                                   \
221         }                                                                         \
222
223 #endif
224
225
226 #ifdef __cplusplus
227 }
228 #endif
229
230 #endif