ReactOS  0.4.14-dev-866-g5b3e84f
xmlmemory.h
Go to the documentation of this file.
1 /*
2  * Summary: interface for the memory allocator
3  * Description: provides interfaces for the memory allocator,
4  * including debugging capabilities.
5  *
6  * Copy: See Copyright for the status of this software.
7  *
8  * Author: Daniel Veillard
9  */
10 
11 
12 #ifndef __DEBUG_MEMORY_ALLOC__
13 #define __DEBUG_MEMORY_ALLOC__
14 
15 #include <stdio.h>
16 #include <libxml/xmlversion.h>
17 
26 /* #define DEBUG_MEMORY_FREED */
27 /* #define DEBUG_MEMORY_LOCATION */
28 
29 #ifdef DEBUG
30 #ifndef DEBUG_MEMORY
31 #define DEBUG_MEMORY
32 #endif
33 #endif
34 
41 #ifdef DEBUG_MEMORY_LOCATION
42 #endif
43 
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47 
48 /*
49  * The XML memory wrapper support 4 basic overloadable functions.
50  */
57 typedef void (XMLCALL *xmlFreeFunc)(void *mem);
66 typedef void *(LIBXML_ATTR_ALLOC_SIZE(1) XMLCALL *xmlMallocFunc)(size_t size);
67 
77 typedef void *(XMLCALL *xmlReallocFunc)(void *mem, size_t size);
78 
87 typedef char *(XMLCALL *xmlStrdupFunc)(const char *str);
88 
89 /*
90  * The 4 interfaces used for all memory handling within libxml.
91 LIBXML_DLL_IMPORT xmlFreeFunc xmlFree;
92 LIBXML_DLL_IMPORT xmlMallocFunc xmlMalloc;
93 LIBXML_DLL_IMPORT xmlMallocFunc xmlMallocAtomic;
94 LIBXML_DLL_IMPORT xmlReallocFunc xmlRealloc;
95 LIBXML_DLL_IMPORT xmlStrdupFunc xmlMemStrdup;
96  */
97 
98 /*
99  * The way to overload the existing functions.
100  * The xmlGc function have an extra entry for atomic block
101  * allocations useful for garbage collected memory allocators
102  */
103 XMLPUBFUN int XMLCALL
104  xmlMemSetup (xmlFreeFunc freeFunc,
105  xmlMallocFunc mallocFunc,
106  xmlReallocFunc reallocFunc,
107  xmlStrdupFunc strdupFunc);
108 XMLPUBFUN int XMLCALL
109  xmlMemGet (xmlFreeFunc *freeFunc,
110  xmlMallocFunc *mallocFunc,
111  xmlReallocFunc *reallocFunc,
112  xmlStrdupFunc *strdupFunc);
113 XMLPUBFUN int XMLCALL
114  xmlGcMemSetup (xmlFreeFunc freeFunc,
115  xmlMallocFunc mallocFunc,
116  xmlMallocFunc mallocAtomicFunc,
117  xmlReallocFunc reallocFunc,
118  xmlStrdupFunc strdupFunc);
119 XMLPUBFUN int XMLCALL
120  xmlGcMemGet (xmlFreeFunc *freeFunc,
121  xmlMallocFunc *mallocFunc,
122  xmlMallocFunc *mallocAtomicFunc,
123  xmlReallocFunc *reallocFunc,
124  xmlStrdupFunc *strdupFunc);
125 
126 /*
127  * Initialization of the memory layer.
128  */
129 XMLPUBFUN int XMLCALL
130  xmlInitMemory (void);
131 
132 /*
133  * Cleanup of the memory layer.
134  */
135 XMLPUBFUN void XMLCALL
136  xmlCleanupMemory (void);
137 /*
138  * These are specific to the XML debug memory wrapper.
139  */
140 XMLPUBFUN int XMLCALL
141  xmlMemUsed (void);
142 XMLPUBFUN int XMLCALL
143  xmlMemBlocks (void);
144 XMLPUBFUN void XMLCALL
145  xmlMemDisplay (FILE *fp);
146 XMLPUBFUN void XMLCALL
147  xmlMemDisplayLast(FILE *fp, long nbBytes);
148 XMLPUBFUN void XMLCALL
149  xmlMemShow (FILE *fp, int nr);
150 XMLPUBFUN void XMLCALL
151  xmlMemoryDump (void);
152 XMLPUBFUN void * XMLCALL
153  xmlMemMalloc (size_t size) LIBXML_ATTR_ALLOC_SIZE(1);
154 XMLPUBFUN void * XMLCALL
155  xmlMemRealloc (void *ptr,size_t size);
156 XMLPUBFUN void XMLCALL
157  xmlMemFree (void *ptr);
158 XMLPUBFUN char * XMLCALL
159  xmlMemoryStrdup (const char *str);
160 XMLPUBFUN void * XMLCALL
161  xmlMallocLoc (size_t size, const char *file, int line) LIBXML_ATTR_ALLOC_SIZE(1);
162 XMLPUBFUN void * XMLCALL
163  xmlReallocLoc (void *ptr, size_t size, const char *file, int line);
164 XMLPUBFUN void * XMLCALL
165  xmlMallocAtomicLoc (size_t size, const char *file, int line) LIBXML_ATTR_ALLOC_SIZE(1);
166 XMLPUBFUN char * XMLCALL
167  xmlMemStrdupLoc (const char *str, const char *file, int line);
168 
169 
170 #ifdef DEBUG_MEMORY_LOCATION
171 
179 #define xmlMalloc(size) xmlMallocLoc((size), __FILE__, __LINE__)
180 
189 #define xmlMallocAtomic(size) xmlMallocAtomicLoc((size), __FILE__, __LINE__)
190 
199 #define xmlRealloc(ptr, size) xmlReallocLoc((ptr), (size), __FILE__, __LINE__)
200 
208 #define xmlMemStrdup(str) xmlMemStrdupLoc((str), __FILE__, __LINE__)
209 
210 #endif /* DEBUG_MEMORY_LOCATION */
211 
212 #ifdef __cplusplus
213 }
214 #endif /* __cplusplus */
215 
216 #ifndef __XML_GLOBALS_H
217 #ifndef __XML_THREADS_H__
218 #include <libxml/threads.h>
219 #include <libxml/globals.h>
220 #endif
221 #endif
222 
223 #endif /* __DEBUG_MEMORY_ALLOC__ */
224 
xmlGcMemSetup
XMLPUBFUN int XMLCALL xmlGcMemSetup(xmlFreeFunc freeFunc, xmlMallocFunc mallocFunc, xmlMallocFunc mallocAtomicFunc, xmlReallocFunc reallocFunc, xmlStrdupFunc strdupFunc)
Definition: xmlmemory.c:1107
void
struct png_info_def **typedef void(__cdecl typeof(png_destroy_read_struct))(struct png_struct_def **
Definition: typeof.h:49
nr
ULONG nr
Definition: thread.c:7
xmlFreeFunc
void(XMLCALL * xmlFreeFunc)(void *mem)
Definition: xmlmemory.h:57
xmlMemShow
XMLPUBFUN void XMLCALL xmlMemShow(FILE *fp, int nr)
Definition: xmlmemory.c:886
xmlMemGet
XMLPUBFUN int XMLCALL xmlMemGet(xmlFreeFunc *freeFunc, xmlMallocFunc *mallocFunc, xmlReallocFunc *reallocFunc, xmlStrdupFunc *strdupFunc)
Definition: xmlmemory.c:1079
xmlMemBlocks
XMLPUBFUN int XMLCALL xmlMemBlocks(void)
Definition: xmlmemory.c:603
xmlMemUsed
XMLPUBFUN int XMLCALL xmlMemUsed(void)
Definition: xmlmemory.c:585
xmlMallocLoc
XMLPUBFUN void *XMLCALL xmlMallocLoc(size_t size, const char *file, int line) LIBXML_ATTR_ALLOC_SIZE(1)
Definition: xmlmemory.c:162
XMLPUBFUN
#define XMLPUBFUN
Definition: xmlexports.h:30
xmlReallocFunc
void *(XMLCALL * xmlReallocFunc)(void *mem, size_t size)
Definition: xmlmemory.h:77
xmlMemMalloc
XMLPUBFUN void *XMLCALL xmlMemMalloc(size_t size) LIBXML_ATTR_ALLOC_SIZE(1)
Definition: xmlmemory.c:311
ptr
static PVOID ptr
Definition: dispmode.c:27
xmlStrdupFunc
char *(XMLCALL * xmlStrdupFunc)(const char *str)
Definition: xmlmemory.h:87
str
const WCHAR * str
Definition: rpc_transport.c:2454
xmlInitMemory
XMLPUBFUN int XMLCALL xmlInitMemory(void)
Definition: xmlmemory.c:964
line
Definition: parser.c:48
xmlMallocAtomicLoc
XMLPUBFUN void *XMLCALL xmlMallocAtomicLoc(size_t size, const char *file, int line) LIBXML_ATTR_ALLOC_SIZE(1)
Definition: xmlmemory.c:238
xmlMemFree
XMLPUBFUN void XMLCALL xmlMemFree(void *ptr)
Definition: xmlmemory.c:431
size
GLsizeiptr size
Definition: glext.h:5919
xmlCleanupMemory
XMLPUBFUN void XMLCALL xmlCleanupMemory(void)
Definition: xmlmemory.c:1008
xmlReallocLoc
XMLPUBFUN void *XMLCALL xmlReallocLoc(void *ptr, size_t size, const char *file, int line)
Definition: xmlmemory.c:329
_iobuf
Definition: mbstring.h:19
LIBXML_ATTR_ALLOC_SIZE
void * LIBXML_ATTR_ALLOC_SIZE(1) XMLCALL *xmlMallocFunc)(size_t size)
Definition: xmlmemory.h:66
xmlMemoryDump
XMLPUBFUN void XMLCALL xmlMemoryDump(void)
Definition: xmlmemory.c:931
xmlMemRealloc
XMLPUBFUN void *XMLCALL xmlMemRealloc(void *ptr, size_t size)
Definition: xmlmemory.c:420
xmlMemoryStrdup
XMLPUBFUN char *XMLCALL xmlMemoryStrdup(const char *str)
Definition: xmlmemory.c:572
xmlGcMemGet
XMLPUBFUN int XMLCALL xmlGcMemGet(xmlFreeFunc *freeFunc, xmlMallocFunc *mallocFunc, xmlMallocFunc *mallocAtomicFunc, xmlReallocFunc *reallocFunc, xmlStrdupFunc *strdupFunc)
Definition: xmlmemory.c:1151
xmlMemStrdupLoc
XMLPUBFUN char *XMLCALL xmlMemStrdupLoc(const char *str, const char *file, int line)
Definition: xmlmemory.c:507
XMLCALL
#define XMLCALL
Definition: expat_external.h:52
mem
Definition: mem.c:156
xmlMemDisplay
XMLPUBFUN void XMLCALL xmlMemDisplay(FILE *fp)
Definition: xmlmemory.c:756
xmlMemSetup
XMLPUBFUN int XMLCALL xmlMemSetup(xmlFreeFunc freeFunc, xmlMallocFunc mallocFunc, xmlReallocFunc reallocFunc, xmlStrdupFunc strdupFunc)
Definition: xmlmemory.c:1041
const
#define const
Definition: zconf.h:230
file
Definition: fci.c:126
xmlMemDisplayLast
XMLPUBFUN void XMLCALL xmlMemDisplayLast(FILE *fp, long nbBytes)
Definition: xmlmemory.c:685