Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 1 | /* |
Daniel Veillard | be58697 | 2003-11-18 20:56:51 +0000 | [diff] [blame] | 2 | * Summary: interface for the memory allocator |
| 3 | * Description: provides interfaces for the memory allocator, |
| 4 | * including debugging capabilities. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 5 | * |
Daniel Veillard | be58697 | 2003-11-18 20:56:51 +0000 | [diff] [blame] | 6 | * Copy: See Copyright for the status of this software. |
| 7 | * |
| 8 | * Author: Daniel Veillard |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 9 | */ |
| 10 | |
| 11 | |
Daniel Veillard | 7a02cfe | 2003-09-25 12:18:34 +0000 | [diff] [blame] | 12 | #ifndef __DEBUG_MEMORY_ALLOC__ |
| 13 | #define __DEBUG_MEMORY_ALLOC__ |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 14 | |
| 15 | #include <stdio.h> |
| 16 | #include <libxml/xmlversion.h> |
| 17 | |
Daniel Veillard | f69bb4b | 2001-05-19 13:24:56 +0000 | [diff] [blame] | 18 | /** |
| 19 | * DEBUG_MEMORY: |
| 20 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 21 | * DEBUG_MEMORY replaces the allocator with a collect and debug |
| 22 | * shell to the libc allocator. |
| 23 | * DEBUG_MEMORY should only be activated when debugging |
| 24 | * libxml i.e. if libxml has been configured with --with-debug-mem too. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 25 | */ |
Daniel Veillard | 48b2f89 | 2001-02-25 16:11:03 +0000 | [diff] [blame] | 26 | /* #define DEBUG_MEMORY_FREED */ |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 27 | /* #define DEBUG_MEMORY_LOCATION */ |
| 28 | |
| 29 | #ifdef DEBUG |
| 30 | #ifndef DEBUG_MEMORY |
| 31 | #define DEBUG_MEMORY |
| 32 | #endif |
| 33 | #endif |
| 34 | |
Daniel Veillard | f69bb4b | 2001-05-19 13:24:56 +0000 | [diff] [blame] | 35 | /** |
| 36 | * DEBUG_MEMORY_LOCATION: |
| 37 | * |
Daniel Veillard | f69bb4b | 2001-05-19 13:24:56 +0000 | [diff] [blame] | 38 | * DEBUG_MEMORY_LOCATION should be activated only when debugging |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 39 | * libxml i.e. if libxml has been configured with --with-debug-mem too. |
Daniel Veillard | f69bb4b | 2001-05-19 13:24:56 +0000 | [diff] [blame] | 40 | */ |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 41 | #ifdef DEBUG_MEMORY_LOCATION |
Daniel Veillard | 48b2f89 | 2001-02-25 16:11:03 +0000 | [diff] [blame] | 42 | #endif |
| 43 | |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 44 | #ifdef __cplusplus |
| 45 | extern "C" { |
| 46 | #endif |
| 47 | |
| 48 | /* |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 49 | * The XML memory wrapper support 4 basic overloadable functions. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 50 | */ |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 51 | /** |
| 52 | * xmlFreeFunc: |
| 53 | * @mem: an already allocated block of memory |
| 54 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 55 | * Signature for a free() implementation. |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 56 | */ |
Igor Zlatkovic | 18a88ce | 2004-02-03 08:27:55 +0000 | [diff] [blame] | 57 | typedef void (XMLCALL *xmlFreeFunc)(void *mem); |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 58 | /** |
| 59 | * xmlMallocFunc: |
| 60 | * @size: the size requested in bytes |
| 61 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 62 | * Signature for a malloc() implementation. |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 63 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 64 | * Returns a pointer to the newly allocated block or NULL in case of error. |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 65 | */ |
Igor Zlatkovic | 18a88ce | 2004-02-03 08:27:55 +0000 | [diff] [blame] | 66 | typedef void *(XMLCALL *xmlMallocFunc)(size_t size); |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 67 | |
| 68 | /** |
| 69 | * xmlReallocFunc: |
| 70 | * @mem: an already allocated block of memory |
| 71 | * @size: the new size requested in bytes |
| 72 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 73 | * Signature for a realloc() implementation. |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 74 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 75 | * Returns a pointer to the newly reallocated block or NULL in case of error. |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 76 | */ |
Igor Zlatkovic | 18a88ce | 2004-02-03 08:27:55 +0000 | [diff] [blame] | 77 | typedef void *(XMLCALL *xmlReallocFunc)(void *mem, size_t size); |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 78 | |
| 79 | /** |
| 80 | * xmlStrdupFunc: |
| 81 | * @str: a zero terminated string |
| 82 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 83 | * Signature for an strdup() implementation. |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 84 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 85 | * Returns the copy of the string or NULL in case of error. |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 86 | */ |
Igor Zlatkovic | 18a88ce | 2004-02-03 08:27:55 +0000 | [diff] [blame] | 87 | typedef char *(XMLCALL *xmlStrdupFunc)(const char *str); |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 88 | |
| 89 | /* |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 90 | * The 4 interfaces used for all memory handling within libxml. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 91 | LIBXML_DLL_IMPORT extern xmlFreeFunc xmlFree; |
| 92 | LIBXML_DLL_IMPORT extern xmlMallocFunc xmlMalloc; |
Daniel Veillard | 3c908dc | 2003-04-19 00:07:51 +0000 | [diff] [blame] | 93 | LIBXML_DLL_IMPORT extern xmlMallocFunc xmlMallocAtomic; |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 94 | LIBXML_DLL_IMPORT extern xmlReallocFunc xmlRealloc; |
| 95 | LIBXML_DLL_IMPORT extern xmlStrdupFunc xmlMemStrdup; |
Daniel Veillard | 6c4ffaf | 2002-02-11 08:54:05 +0000 | [diff] [blame] | 96 | */ |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 97 | |
| 98 | /* |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 99 | * The way to overload the existing functions. |
Daniel Veillard | 3c908dc | 2003-04-19 00:07:51 +0000 | [diff] [blame] | 100 | * The xmlGc function have an extra entry for atomic block |
| 101 | * allocations useful for garbage collected memory allocators |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 102 | */ |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 103 | XMLPUBFUN int XMLCALL |
| 104 | xmlMemSetup (xmlFreeFunc freeFunc, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 105 | xmlMallocFunc mallocFunc, |
| 106 | xmlReallocFunc reallocFunc, |
| 107 | xmlStrdupFunc strdupFunc); |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 108 | XMLPUBFUN int XMLCALL |
| 109 | xmlMemGet (xmlFreeFunc *freeFunc, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 110 | xmlMallocFunc *mallocFunc, |
| 111 | xmlReallocFunc *reallocFunc, |
| 112 | xmlStrdupFunc *strdupFunc); |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 113 | XMLPUBFUN int XMLCALL |
| 114 | xmlGcMemSetup (xmlFreeFunc freeFunc, |
Daniel Veillard | 3c908dc | 2003-04-19 00:07:51 +0000 | [diff] [blame] | 115 | xmlMallocFunc mallocFunc, |
| 116 | xmlMallocFunc mallocAtomicFunc, |
| 117 | xmlReallocFunc reallocFunc, |
| 118 | xmlStrdupFunc strdupFunc); |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 119 | XMLPUBFUN int XMLCALL |
| 120 | xmlGcMemGet (xmlFreeFunc *freeFunc, |
Daniel Veillard | 3c908dc | 2003-04-19 00:07:51 +0000 | [diff] [blame] | 121 | xmlMallocFunc *mallocFunc, |
| 122 | xmlMallocFunc *mallocAtomicFunc, |
| 123 | xmlReallocFunc *reallocFunc, |
| 124 | xmlStrdupFunc *strdupFunc); |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 125 | |
| 126 | /* |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 127 | * Initialization of the memory layer. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 128 | */ |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 129 | XMLPUBFUN int XMLCALL |
| 130 | xmlInitMemory (void); |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 131 | |
William M. Brack | 72ee48d | 2003-12-30 08:30:19 +0000 | [diff] [blame] | 132 | /* |
| 133 | * Cleanup of the memory layer. |
| 134 | */ |
| 135 | XMLPUBFUN void XMLCALL |
| 136 | xmlCleanupMemory (void); |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 137 | /* |
William M. Brack | c193956 | 2003-08-05 15:52:22 +0000 | [diff] [blame] | 138 | * These are specific to the XML debug memory wrapper. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 139 | */ |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 140 | XMLPUBFUN int XMLCALL |
| 141 | xmlMemUsed (void); |
Daniel Veillard | 36e5cd5 | 2004-11-02 14:52:23 +0000 | [diff] [blame] | 142 | XMLPUBFUN int XMLCALL |
| 143 | xmlMemBlocks (void); |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 144 | XMLPUBFUN void XMLCALL |
| 145 | xmlMemDisplay (FILE *fp); |
| 146 | XMLPUBFUN void XMLCALL |
| 147 | xmlMemShow (FILE *fp, int nr); |
| 148 | XMLPUBFUN void XMLCALL |
| 149 | xmlMemoryDump (void); |
| 150 | XMLPUBFUN void * XMLCALL |
| 151 | xmlMemMalloc (size_t size); |
| 152 | XMLPUBFUN void * XMLCALL |
| 153 | xmlMemRealloc (void *ptr,size_t size); |
| 154 | XMLPUBFUN void XMLCALL |
| 155 | xmlMemFree (void *ptr); |
| 156 | XMLPUBFUN char * XMLCALL |
| 157 | xmlMemoryStrdup (const char *str); |
| 158 | XMLPUBFUN void * XMLCALL |
| 159 | xmlMallocLoc (size_t size, const char *file, int line); |
| 160 | XMLPUBFUN void * XMLCALL |
| 161 | xmlReallocLoc (void *ptr, size_t size, const char *file, int line); |
| 162 | XMLPUBFUN void * XMLCALL |
| 163 | xmlMallocAtomicLoc (size_t size, const char *file, int line); |
| 164 | XMLPUBFUN char * XMLCALL |
| 165 | xmlMemStrdupLoc (const char *str, const char *file, int line); |
William M. Brack | c193956 | 2003-08-05 15:52:22 +0000 | [diff] [blame] | 166 | |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 167 | |
| 168 | #ifdef DEBUG_MEMORY_LOCATION |
Daniel Veillard | 5e2dace | 2001-07-18 19:30:27 +0000 | [diff] [blame] | 169 | /** |
| 170 | * xmlMalloc: |
| 171 | * @size: number of bytes to allocate |
| 172 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 173 | * Wrapper for the malloc() function used in the XML library. |
Daniel Veillard | 5e2dace | 2001-07-18 19:30:27 +0000 | [diff] [blame] | 174 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 175 | * Returns the pointer to the allocated area or NULL in case of error. |
Daniel Veillard | 5e2dace | 2001-07-18 19:30:27 +0000 | [diff] [blame] | 176 | */ |
| 177 | #define xmlMalloc(size) xmlMallocLoc((size), __FILE__, __LINE__) |
| 178 | /** |
Daniel Veillard | 3c908dc | 2003-04-19 00:07:51 +0000 | [diff] [blame] | 179 | * xmlMallocAtomic: |
| 180 | * @size: number of bytes to allocate |
| 181 | * |
| 182 | * Wrapper for the malloc() function used in the XML library for allocation |
| 183 | * of block not containing pointers to other areas. |
| 184 | * |
| 185 | * Returns the pointer to the allocated area or NULL in case of error. |
| 186 | */ |
| 187 | #define xmlMallocAtomic(size) xmlMallocAtomicLoc((size), __FILE__, __LINE__) |
| 188 | /** |
Daniel Veillard | 5e2dace | 2001-07-18 19:30:27 +0000 | [diff] [blame] | 189 | * xmlRealloc: |
| 190 | * @ptr: pointer to the existing allocated area |
| 191 | * @size: number of bytes to allocate |
| 192 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 193 | * Wrapper for the realloc() function used in the XML library. |
Daniel Veillard | 5e2dace | 2001-07-18 19:30:27 +0000 | [diff] [blame] | 194 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 195 | * Returns the pointer to the allocated area or NULL in case of error. |
Daniel Veillard | 5e2dace | 2001-07-18 19:30:27 +0000 | [diff] [blame] | 196 | */ |
| 197 | #define xmlRealloc(ptr, size) xmlReallocLoc((ptr), (size), __FILE__, __LINE__) |
| 198 | /** |
| 199 | * xmlMemStrdup: |
| 200 | * @str: pointer to the existing string |
| 201 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 202 | * Wrapper for the strdup() function, xmlStrdup() is usually preferred. |
Daniel Veillard | 5e2dace | 2001-07-18 19:30:27 +0000 | [diff] [blame] | 203 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 204 | * Returns the pointer to the allocated area or NULL in case of error. |
Daniel Veillard | 5e2dace | 2001-07-18 19:30:27 +0000 | [diff] [blame] | 205 | */ |
| 206 | #define xmlMemStrdup(str) xmlMemStrdupLoc((str), __FILE__, __LINE__) |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 207 | |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 208 | #endif /* DEBUG_MEMORY_LOCATION */ |
| 209 | |
| 210 | #ifdef __cplusplus |
| 211 | } |
| 212 | #endif /* __cplusplus */ |
| 213 | |
Daniel Veillard | 6c4ffaf | 2002-02-11 08:54:05 +0000 | [diff] [blame] | 214 | #ifndef __XML_GLOBALS_H |
| 215 | #ifndef __XML_THREADS_H__ |
| 216 | #include <libxml/threads.h> |
| 217 | #include <libxml/globals.h> |
| 218 | #endif |
| 219 | #endif |
| 220 | |
Daniel Veillard | 7a02cfe | 2003-09-25 12:18:34 +0000 | [diff] [blame] | 221 | #endif /* __DEBUG_MEMORY_ALLOC__ */ |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 222 | |