xmlmemory.h

/*

 * Summary: interface for the memory allocator

 * Description: provides interfaces for the memory allocator,

 *              including debugging capabilities.

 *

 * Copy: See Copyright for the status of this software.

 *

 * Author: Daniel Veillard

 */





#ifndef __DEBUG_MEMORY_ALLOC__

#define __DEBUG_MEMORY_ALLOC__



#include <stdio.h>

#include <libxml/xmlversion.h>



/* #define DEBUG_MEMORY_FREED */

/* #define DEBUG_MEMORY_LOCATION */



#ifdef DEBUG

#ifndef DEBUG_MEMORY

#define DEBUG_MEMORY

#endif

#endif



#ifdef DEBUG_MEMORY_LOCATION

#endif



#ifdef __cplusplus

extern "C" {

#endif



/*

 * The XML memory wrapper support 4 basic overloadable functions.

 */

typedef void (XMLCALL *xmlFreeFunc)(void *mem);

typedef void *(XMLCALL *xmlMallocFunc)(size_t size);



typedef void *(XMLCALL *xmlReallocFunc)(void *mem, size_t size);



typedef char *(XMLCALL *xmlStrdupFunc)(const char *str);



/*

 * The 4 interfaces used for all memory handling within libxml.

LIBXML_DLL_IMPORT extern xmlFreeFunc xmlFree;

LIBXML_DLL_IMPORT extern xmlMallocFunc xmlMalloc;

LIBXML_DLL_IMPORT extern xmlMallocFunc xmlMallocAtomic;

LIBXML_DLL_IMPORT extern xmlReallocFunc xmlRealloc;

LIBXML_DLL_IMPORT extern xmlStrdupFunc xmlMemStrdup;

 */



/*

 * The way to overload the existing functions.

 * The xmlGc function have an extra entry for atomic block

 * allocations useful for garbage collected memory allocators

 */

XMLPUBFUN int XMLCALL

        xmlMemSetup     (xmlFreeFunc freeFunc,

                         xmlMallocFunc mallocFunc,

                         xmlReallocFunc reallocFunc,

                         xmlStrdupFunc strdupFunc);

XMLPUBFUN int XMLCALL     

        xmlMemGet       (xmlFreeFunc *freeFunc,

                         xmlMallocFunc *mallocFunc,

                         xmlReallocFunc *reallocFunc,

                         xmlStrdupFunc *strdupFunc);

XMLPUBFUN int XMLCALL     

        xmlGcMemSetup   (xmlFreeFunc freeFunc,

                         xmlMallocFunc mallocFunc,

                         xmlMallocFunc mallocAtomicFunc,

                         xmlReallocFunc reallocFunc,

                         xmlStrdupFunc strdupFunc);

XMLPUBFUN int XMLCALL     

        xmlGcMemGet     (xmlFreeFunc *freeFunc,

                         xmlMallocFunc *mallocFunc,

                         xmlMallocFunc *mallocAtomicFunc,

                         xmlReallocFunc *reallocFunc,

                         xmlStrdupFunc *strdupFunc);



/*

 * Initialization of the memory layer.

 */

XMLPUBFUN int XMLCALL   

        xmlInitMemory   (void);



/* 

 * Cleanup of the memory layer.

 */

XMLPUBFUN void XMLCALL                

                xmlCleanupMemory        (void);

/*

 * These are specific to the XML debug memory wrapper.

 */

XMLPUBFUN int XMLCALL   

        xmlMemUsed      (void);

XMLPUBFUN int XMLCALL   

        xmlMemBlocks    (void);

XMLPUBFUN void XMLCALL  

        xmlMemDisplay   (FILE *fp);

XMLPUBFUN void XMLCALL  

        xmlMemShow      (FILE *fp, int nr);

XMLPUBFUN void XMLCALL  

        xmlMemoryDump   (void);

XMLPUBFUN void * XMLCALL        

        xmlMemMalloc    (size_t size);

XMLPUBFUN void * XMLCALL        

        xmlMemRealloc   (void *ptr,size_t size);

XMLPUBFUN void XMLCALL  

        xmlMemFree      (void *ptr);

XMLPUBFUN char * XMLCALL        

        xmlMemoryStrdup (const char *str);

XMLPUBFUN void * XMLCALL  

        xmlMallocLoc    (size_t size, const char *file, int line);

XMLPUBFUN void * XMLCALL        

        xmlReallocLoc   (void *ptr, size_t size, const char *file, int line);

XMLPUBFUN void * XMLCALL        

        xmlMallocAtomicLoc (size_t size, const char *file, int line);

XMLPUBFUN char * XMLCALL        

        xmlMemStrdupLoc (const char *str, const char *file, int line);





#ifdef DEBUG_MEMORY_LOCATION

#define xmlMalloc(size) xmlMallocLoc((size), __FILE__, __LINE__)

#define xmlMallocAtomic(size) xmlMallocAtomicLoc((size), __FILE__, __LINE__)

#define xmlRealloc(ptr, size) xmlReallocLoc((ptr), (size), __FILE__, __LINE__)

#define xmlMemStrdup(str) xmlMemStrdupLoc((str), __FILE__, __LINE__)



#endif /* DEBUG_MEMORY_LOCATION */



#ifdef __cplusplus

}

#endif /* __cplusplus */



#ifndef __XML_GLOBALS_H

#ifndef __XML_THREADS_H__

#include <libxml/threads.h>

#include <libxml/globals.h>

#endif

#endif



#endif  /* __DEBUG_MEMORY_ALLOC__ */

---