synched with trunk at revision 36569
[blender.git] / intern / guardedalloc / MEM_guardedalloc.h
1 /*
2  * $Id$
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): none yet.
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file MEM_guardedalloc.h
30  *  \ingroup MEM
31  *
32  *  \author Copyright (C) 2001 NaN Technologies B.V.
33  *  \brief Read \ref MEMPage
34  */
35
36 /** 
37  * \page MEMPage Guarded memory(de)allocation
38  *
39  * \section aboutmem c-style guarded memory allocation
40  *
41  * \subsection memabout About the MEM module
42  *
43  * MEM provides guarded malloc/calloc calls. All memory is enclosed by
44  * pads, to detect out-of-bound writes. All blocks are placed in a
45  * linked list, so they remain reachable at all times. There is no
46  * back-up in case the linked-list related data is lost.
47  *
48  * \subsection memissues Known issues with MEM
49  *
50  * There are currently no known issues with MEM. Note that there is a
51  * second intern/ module with MEM_ prefix, for use in c++.
52  * 
53  * \subsection memdependencies Dependencies
54  * - stdlib
55  * - stdio
56  * 
57  * \subsection memdocs API Documentation
58  * See \ref MEM_guardedalloc.h
59  */
60
61 #ifndef MEM_MALLOCN_H
62 #define MEM_MALLOCN_H
63
64 #include <stdio.h> /* needed for FILE* */
65 #include "MEM_sys_types.h" /* needed for uintptr_t */
66
67 #ifndef WARN_UNUSED
68 #  ifdef __GNUC__
69 #    define WARN_UNUSED  __attribute__((warn_unused_result))
70 #  else
71 #    define WARN_UNUSED
72 #  endif
73 #endif
74
75 #ifdef __cplusplus
76 extern "C" {
77 #endif
78
79         /** Returns the length of the allocated memory segment pointed at
80          * by vmemh. If the pointer was not previously allocated by this
81          * module, the result is undefined.*/
82         size_t MEM_allocN_len(void *vmemh) WARN_UNUSED;
83
84         /**
85          * Release memory previously allocatred by this module. 
86          */
87         short MEM_freeN(void *vmemh);
88
89
90         /**
91          * Return zero if memory is not in allocated list
92          */
93         short MEM_testN(void *vmemh);
94
95         /**
96          * Duplicates a block of memory, and returns a pointer to the
97          * newly allocated block.  */
98         void *MEM_dupallocN(void *vmemh) WARN_UNUSED;
99
100         /**
101           * Reallocates a block of memory, and returns pointer to the newly
102           * allocated block, the old one is freed. this is not as optimized
103           * as a system realloc but just makes a new allocation and copies
104           * over from existing memory. */
105         void *MEM_reallocN(void *vmemh, size_t len) WARN_UNUSED;
106
107         /**
108          * Allocate a block of memory of size len, with tag name str. The
109          * memory is cleared. The name must be static, because only a
110          * pointer to it is stored ! */
111         void *MEM_callocN(size_t len, const char * str) WARN_UNUSED;
112         
113         /** Allocate a block of memory of size len, with tag name str. The
114                 * name must be a static, because only a pointer to it is stored !
115                 * */
116         void *MEM_mallocN(size_t len, const char * str) WARN_UNUSED;
117         
118         /** Same as callocN, clears memory and uses mmap (disk cached) if supported.
119                 Can be free'd with MEM_freeN as usual.
120                 * */
121         void *MEM_mapallocN(size_t len, const char * str) WARN_UNUSED;
122
123         /** Print a list of the names and sizes of all allocated memory
124          * blocks. as a python dict for easy investigation */ 
125         void MEM_printmemlist_pydict(void);
126
127         /** Print a list of the names and sizes of all allocated memory
128          * blocks. */ 
129         void MEM_printmemlist(void);
130
131         /** calls the function on all allocated memory blocks. */
132         void MEM_callbackmemlist(void (*func)(void*));
133
134         /** Print statistics about memory usage */
135         void MEM_printmemlist_stats(void);
136         
137         /** Set the callback function for error output. */
138         void MEM_set_error_callback(void (*func)(const char *));
139
140         /**
141          * Are the start/end block markers still correct ?
142          *
143          * @retval 0 for correct memory, 1 for corrupted memory. */
144         int MEM_check_memory_integrity(void);
145
146         /** Set thread locking functions for safe memory allocation from multiple
147             threads, pass NULL pointers to disable thread locking again. */
148         void MEM_set_lock_callback(void (*lock)(void), void (*unlock)(void));
149         
150         /** Attempt to enforce OSX (or other OS's) to have malloc and stack nonzero */
151         void MEM_set_memory_debug(void);
152
153         /** Memory usage stats
154          * - MEM_get_memory_in_use is all memory
155          * - MEM_get_mapped_memory_in_use is a subset of all memory */
156         uintptr_t MEM_get_memory_in_use(void);
157         /** Get mapped memory usage. */
158         uintptr_t MEM_get_mapped_memory_in_use(void);
159         /** Get amount of memory blocks in use. */
160         int MEM_get_memory_blocks_in_use(void);
161
162         /** Reset the peak memory statistic to zero. */
163         void MEM_reset_peak_memory(void);
164
165         /** Get the peak memory usage in bytes, including mmap allocations. */
166         uintptr_t MEM_get_peak_memory(void) WARN_UNUSED;
167
168 #ifndef NDEBUG
169 const char *MEM_name_ptr(void *vmemh);
170 #endif
171         
172 #ifdef __cplusplus
173 }
174 #endif
175
176 #endif
177