fix for uninitialized value in BLI_path_cwd() if PWD wasn't defined and the CWD was...
[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 /**
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 #ifndef WARN_UNUSED
63 #  ifdef __GNUC__
64 #    define WARN_UNUSED  __attribute__((warn_unused_result))
65 #  else
66 #    define WARN_UNUSED
67 #  endif
68 #endif
69
70 #ifdef __cplusplus
71 extern "C" {
72 #endif
73
74         /** Returns the length of the allocated memory segment pointed at
75          * by vmemh. If the pointer was not previously allocated by this
76          * module, the result is undefined.*/
77         size_t MEM_allocN_len(void *vmemh) WARN_UNUSED;
78
79         /**
80          * Release memory previously allocatred by this module. 
81          */
82         short MEM_freeN(void *vmemh);
83
84
85         /**
86          * Return zero if memory is not in allocated list
87          */
88         short MEM_testN(void *vmemh);
89
90         /**
91          * Duplicates a block of memory, and returns a pointer to the
92          * newly allocated block.  */
93         void *MEM_dupallocN(void *vmemh) WARN_UNUSED;
94
95         /**
96           * Reallocates a block of memory, and returns pointer to the newly
97           * allocated block, the old one is freed. this is not as optimized
98           * as a system realloc but just makes a new allocation and copies
99           * over from existing memory. */
100         void *MEM_reallocN(void *vmemh, size_t len) WARN_UNUSED;
101
102         /**
103          * Allocate a block of memory of size len, with tag name str. The
104          * memory is cleared. The name must be static, because only a
105          * pointer to it is stored ! */
106         void *MEM_callocN(size_t len, const char * str) WARN_UNUSED;
107         
108         /** Allocate a block of memory of size len, with tag name str. The
109                 * name must be a static, because only a pointer to it is stored !
110                 * */
111         void *MEM_mallocN(size_t len, const char * str) WARN_UNUSED;
112         
113         /** Same as callocN, clears memory and uses mmap (disk cached) if supported.
114                 Can be free'd with MEM_freeN as usual.
115                 * */
116         void *MEM_mapallocN(size_t len, const char * str) WARN_UNUSED;
117
118         /** Print a list of the names and sizes of all allocated memory
119          * blocks. as a python dict for easy investigation */ 
120         void MEM_printmemlist_pydict(void);
121
122         /** Print a list of the names and sizes of all allocated memory
123          * blocks. */ 
124         void MEM_printmemlist(void);
125
126         /** calls the function on all allocated memory blocks. */
127         void MEM_callbackmemlist(void (*func)(void*));
128
129         /** Print statistics about memory usage */
130         void MEM_printmemlist_stats(void);
131         
132         /** Set the callback function for error output. */
133         void MEM_set_error_callback(void (*func)(const char *));
134
135         /**
136          * Are the start/end block markers still correct ?
137          *
138          * @retval 0 for correct memory, 1 for corrupted memory. */
139         int MEM_check_memory_integrity(void);
140
141         /** Set thread locking functions for safe memory allocation from multiple
142             threads, pass NULL pointers to disable thread locking again. */
143         void MEM_set_lock_callback(void (*lock)(void), void (*unlock)(void));
144         
145         /** Attempt to enforce OSX (or other OS's) to have malloc and stack nonzero */
146         void MEM_set_memory_debug(void);
147
148         /* Memory usage stats
149          * - MEM_get_memory_in_use is all memory
150          * - MEM_get_mapped_memory_in_use is a subset of all memory */
151         uintptr_t MEM_get_memory_in_use(void);
152         uintptr_t MEM_get_mapped_memory_in_use(void);
153         int MEM_get_memory_blocks_in_use(void);
154
155         /*reset the peak memory statistic to zero*/
156         void MEM_reset_peak_memory(void);
157
158         /*get the peak memory usage in bytes, including mmap allocations*/
159         uintptr_t MEM_get_peak_memory(void) WARN_UNUSED;
160
161 #ifndef NDEBUG
162 const char *MEM_name_ptr(void *vmemh);
163 #endif
164         
165 #ifdef __cplusplus
166 }
167 #endif
168
169 #endif
170