9e3927314d38962e9e0cb5e1ca44a746b2a226f7
[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., 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
76         /**
77          * Duplicates a block of memory, and returns a pointer to the
78          * newly allocated block.  */
79         void *MEM_dupallocN(void *vmemh);
80
81         /**
82          * Allocate a block of memory of size len, with tag name str. The
83          * memory is cleared. The name must be static, because only a
84          * pointer to it is stored ! */
85         void *MEM_callocN(unsigned int len, const char * str);
86         
87         /** Allocate a block of memory of size len, with tag name str. The
88                 * name must be a static, because only a pointer to it is stored !
89                 * */
90         void *MEM_mallocN(unsigned int len, const char * str);
91         
92         /** Same as callocN, clears memory and uses mmap (disk cached) if supported.
93                 Can be free'd with MEM_freeN as usual.
94                 * */
95         void *MEM_mapallocN(unsigned int len, const char * str);
96
97         /** Print a list of the names and sizes of all allocated memory
98          * blocks. as a python dict for easy investigation */ 
99         void MEM_printmemlist_pydict(void);
100
101         /** Print a list of the names and sizes of all allocated memory
102          * blocks. */ 
103         void MEM_printmemlist(void);
104
105         /** Print statistics about memory usage */
106         void MEM_printmemlist_stats(void);
107         
108         /** Set the callback function for error output. */
109         void MEM_set_error_callback(void (*func)(char *));
110
111         /**
112          * Are the start/end block markers still correct ?
113          *
114          * @retval 0 for correct memory, 1 for corrupted memory. */
115         int MEM_check_memory_integrity(void);
116
117         /** Set thread locking functions for safe memory allocation from multiple
118             threads, pass NULL pointers to disable thread locking again. */
119         void MEM_set_lock_callback(void (*lock)(void), void (*unlock)(void));
120         
121         /** Attempt to enforce OSX (or other OS's) to have malloc and stack nonzero */
122         void MEM_set_memory_debug(void);
123
124         /* Memory usage stats
125          * - MEM_get_memory_in_use is all memory
126          * - MEM_get_mapped_memory_in_use is a subset of all memory */
127         uintptr_t MEM_get_memory_in_use(void);
128         uintptr_t MEM_get_mapped_memory_in_use(void);
129         int MEM_get_memory_blocks_in_use(void);
130
131 #ifdef __cplusplus
132 }
133 #endif
134
135 #endif
136