ok, apparently didn't commit this either. apparently includes a merge with trunk...
[blender-staging.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 /**
30  * Copyright (C) 2001 NaN Technologies B.V.
31  * Guarded memory (de)allocation
32  *
33  *
34  * @mainpage MEM - c-style guarded memory allocation
35  *
36  * @section about About the MEM module
37  *
38  * MEM provides guarded malloc/calloc calls. All memory is enclosed by
39  * pads, to detect out-of-bound writes. All blocks are placed in a
40  * linked list, so they remain reachable at all times. There is no
41  * back-up in case the linked-list related data is lost.
42  *
43  * @section issues Known issues with MEM
44  *
45  * There are currently no known issues with MEM. Note that there is a
46  * second intern/ module with MEM_ prefix, for use in c++.
47  * 
48  * @section dependencies Dependencies
49  *
50  * - stdlib
51  *
52  * - stdio
53  *
54  * */
55
56 #ifndef MEM_MALLOCN_H
57 #define MEM_MALLOCN_H
58
59 #include "stdio.h" /* needed for FILE* */
60 #include "BLO_sys_types.h" /* needed for uintptr_t */
61
62 #ifdef __cplusplus
63 extern "C" {
64 #endif
65
66         /** Returns the lenght of the allocated memory segment pointed at
67          * by vmemh. If the pointer was not previously allocated by this
68          * module, the result is undefined.*/
69         int MEM_allocN_len(void *vmemh);
70
71         /**
72          * Release memory previously allocatred by this module. 
73          */
74         short MEM_freeN(void *vmemh);
75         short WMEM_freeN(void *vmemh);
76         
77         short _MEM_freeN(void *vmemh, char *file, int line);
78         #define MEM_freeN(vmemh)        _MEM_freeN(vmemh, __FILE__, __LINE__)
79         
80
81         /**
82          * Return zero if memory is not in allocated list
83          */
84         short MEM_testN(void *vmemh);
85
86         /**
87          * Duplicates a block of memory, and returns a pointer to the
88          * newly allocated block.  */
89         void *MEM_dupallocN(void *vmemh);
90
91         /**
92          * Allocate a block of memory of size len, with tag name str. The
93          * memory is cleared. The name must be static, because only a
94          * pointer to it is stored ! */
95         void *MEM_callocN(unsigned int len, const char * str);
96         
97         /** Allocate a block of memory of size len, with tag name str. The
98                 * name must be a static, because only a pointer to it is stored !
99                 * */
100         void *MEM_mallocN(unsigned int len, const char * str);
101         
102         /** Same as callocN, clears memory and uses mmap (disk cached) if supported.
103                 Can be free'd with MEM_freeN as usual.
104                 * */
105         void *MEM_mapallocN(unsigned int len, const char * str);
106
107         /** Print a list of the names and sizes of all allocated memory
108          * blocks. as a python dict for easy investigation */ 
109         void MEM_printmemlist_pydict(void);
110
111         /** Print a list of the names and sizes of all allocated memory
112          * blocks. */ 
113         void MEM_printmemlist(void);
114
115         /** calls the function on all allocated memory blocks. */
116         void MEM_callbackmemlist(void (*func)(void*));
117
118         /** Print statistics about memory usage */
119         void MEM_printmemlist_stats(void);
120         
121         /** Set the callback function for error output. */
122         void MEM_set_error_callback(void (*func)(char *));
123
124         /**
125          * Are the start/end block markers still correct ?
126          *
127          * @retval 0 for correct memory, 1 for corrupted memory. */
128         int MEM_check_memory_integrity(void);
129
130         /** Set thread locking functions for safe memory allocation from multiple
131             threads, pass NULL pointers to disable thread locking again. */
132         void MEM_set_lock_callback(void (*lock)(void), void (*unlock)(void));
133         
134         /** Attempt to enforce OSX (or other OS's) to have malloc and stack nonzero */
135         void MEM_set_memory_debug(void);
136
137         /* Memory usage stats
138          * - MEM_get_memory_in_use is all memory
139          * - MEM_get_mapped_memory_in_use is a subset of all memory */
140         uintptr_t MEM_get_memory_in_use(void);
141         uintptr_t MEM_get_mapped_memory_in_use(void);
142         int MEM_get_memory_blocks_in_use(void);
143
144 /********* Internal structs.   They're only here for the MEM_OVERHEAD macro.*********/
145
146 /* --------------------------------------------------------------------- */
147 /* Data definition                                                       */
148 /* --------------------------------------------------------------------- */
149 /* all memory chunks are put in linked lists */
150 typedef struct localLink
151 {
152         struct localLink *next,*prev;
153 } localLink;
154
155 typedef struct localListBase 
156 {
157         void *first, *last;
158 } localListBase;
159
160         /* note: keep this struct aligned (e.g., irix/gcc) - Hos */
161 typedef struct MemHead {
162         int tag1;
163         int len;
164         struct MemHead *next,*prev;
165         const char * name;
166         const char * nextname;
167         int tag2;
168         int mmap;       /* if true, memory was mmapped */
169 } MemHead;
170
171 typedef struct MemTail {
172         int tag3, pad;
173 } MemTail;
174
175 /*memory bias to hopefully account 
176   for allocation overhead from
177   the system allocator.*/
178 #define MEM_OVERHEADBIAS        32
179
180 #define MEM_OVERHEAD    (sizeof(MemHead) + sizeof(MemTail) + MEM_OVERHEADBIAS)
181
182 #ifdef __cplusplus
183 }
184 #endif
185
186 #endif
187