]> git.xonotic.org Git - xonotic/darkplaces.git/blobdiff - zone.h
zone: Add Z_ counterparts for Realloc and strdup
[xonotic/darkplaces.git] / zone.h
diff --git a/zone.h b/zone.h
index d4abe16d4ee90518991a6bb696f09574a0c72fbb..a78372267114d9a61836774fd566914b674c3d6e 100644 (file)
--- a/zone.h
+++ b/zone.h
@@ -21,121 +21,135 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 #ifndef ZONE_H
 #define ZONE_H
 
-// LordHavoc: this is pointless with a good C library
-//#define MEMCLUMPING
+#include <stddef.h>
+#include "qtypes.h"
+#include "qdefs.h"
 
-#define POOLNAMESIZE 128
-#if MEMCLUMPING
-// give malloc padding so we can't waste most of a page at the end
-#define MEMCLUMPSIZE (65536 - 1536)
-// smallest unit we care about is this many bytes
-#define MEMUNIT 8
-#define MEMBITS (MEMCLUMPSIZE / MEMUNIT)
-#define MEMBITINTS (MEMBITS / 32)
-#define MEMCLUMP_SENTINEL 0xABADCAFE
-#endif
+extern qbool mem_bigendian;
 
-#define MEMHEADER_SENTINEL1 0xDEADF00D
-#define MEMHEADER_SENTINEL2 0xDF
+// div0: heap overflow detection paranoia
+#define MEMPARANOIA 0
+
+#define POOLNAMESIZE 128
+// if set this pool will be printed in memlist reports
+#define POOLFLAG_TEMP 1
 
 typedef struct memheader_s
 {
+       // address returned by Chunk_Alloc (may be significantly before this header to satisify alignment)
+       void *baseaddress;
        // next and previous memheaders in chain belonging to pool
        struct memheader_s *next;
        struct memheader_s *prev;
        // pool this memheader belongs to
        struct mempool_s *pool;
-#if MEMCLUMPING
-       // clump this memheader lives in, NULL if not in a clump
-       struct memclump_s *clump;
-#endif
        // size of the memory after the header (excluding header and sentinel2)
-       int size;
+       size_t size;
        // file name and line where Mem_Alloc was called
        const char *filename;
        int fileline;
-       // should always be MEMHEADER_SENTINEL1
-       unsigned int sentinel1;
-       // immediately followed by data, which is followed by a MEMHEADER_SENTINEL2 byte
+       // should always be equal to MEMHEADER_SENTINEL_FOR_ADDRESS()
+       unsigned int sentinel;
+       // immediately followed by data, which is followed by another copy of mem_sentinel[]
 }
 memheader_t;
 
-#if MEMCLUMPING
-typedef struct memclump_s
-{
-       // contents of the clump
-       qbyte block[MEMCLUMPSIZE];
-       // should always be MEMCLUMP_SENTINEL
-       unsigned int sentinel1;
-       // if a bit is on, it means that the MEMUNIT bytes it represents are
-       // allocated, otherwise free
-       int bits[MEMBITINTS];
-       // should always be MEMCLUMP_SENTINEL
-       unsigned int sentinel2;
-       // if this drops to 0, the clump is freed
-       int blocksinuse;
-       // largest block of memory available (this is reset to an optimistic
-       // number when anything is freed, and updated when alloc fails the clump)
-       int largestavailable;
-       // next clump in the chain
-       struct memclump_s *chain;
-}
-memclump_t;
-#endif
-
 typedef struct mempool_s
 {
-       // should always be MEMHEADER_SENTINEL1
+       // should always be MEMPOOL_SENTINEL
        unsigned int sentinel1;
        // chain of individual memory allocations
        struct memheader_s *chain;
-#if MEMCLUMPING
-       // chain of clumps (if any)
-       struct memclump_s *clumpchain;
-#endif
+       // POOLFLAG_*
+       int flags;
        // total memory allocated in this pool (inside memheaders)
-       int totalsize;
+       size_t totalsize;
        // total memory allocated in this pool (actual malloc total)
-       int realsize;
+       size_t realsize;
        // updated each time the pool is displayed by memlist, shows change from previous time (unless pool was freed)
-       int lastchecksize;
-       // name of the pool
-       char name[POOLNAMESIZE];
+       size_t lastchecksize;
        // linked into global mempool list
        struct mempool_s *next;
+       // parent object (used for nested memory pools)
+       struct mempool_s *parent;
        // file name and line where Mem_AllocPool was called
        const char *filename;
        int fileline;
-       // should always be MEMHEADER_SENTINEL1
+       // name of the pool
+       char name[POOLNAMESIZE];
+       // should always be MEMPOOL_SENTINEL
        unsigned int sentinel2;
 }
 mempool_t;
 
-#define Mem_Alloc(pool,size) _Mem_Alloc(pool, size, __FILE__, __LINE__)
+#define Mem_Alloc(pool,size) _Mem_Alloc(pool, NULL, size, 16, __FILE__, __LINE__)
+#define Mem_Memalign(pool,alignment,size) _Mem_Alloc(pool, NULL, size, alignment, __FILE__, __LINE__)
+#define Mem_Realloc(pool,data,size) _Mem_Alloc(pool, data, size, 16, __FILE__, __LINE__)
 #define Mem_Free(mem) _Mem_Free(mem, __FILE__, __LINE__)
 #define Mem_CheckSentinels(data) _Mem_CheckSentinels(data, __FILE__, __LINE__)
-#define Mem_CheckSentinelsGlobal() _Mem_CheckSentinelsGlobal(__FILE__, __LINE__)
-#define Mem_AllocPool(name) _Mem_AllocPool(name, __FILE__, __LINE__)
+#if MEMPARANOIA
+#define Mem_CheckSentinelsGlobal()  _Mem_CheckSentinelsGlobal(__FILE__, __LINE__)
+#else
+#define Mem_CheckSentinelsGlobal() if(developer_memorydebug.integer) { _Mem_CheckSentinelsGlobal(__FILE__, __LINE__); }
+#endif
+#define Mem_AllocPool(name, flags, parent) _Mem_AllocPool(name, flags, parent, __FILE__, __LINE__)
 #define Mem_FreePool(pool) _Mem_FreePool(pool, __FILE__, __LINE__)
 #define Mem_EmptyPool(pool) _Mem_EmptyPool(pool, __FILE__, __LINE__)
 
-void *_Mem_Alloc(mempool_t *pool, int size, const char *filename, int fileline);
+void *_Mem_Alloc(mempool_t *pool, void *data, size_t size, size_t alignment, const char *filename, int fileline);
 void _Mem_Free(void *data, const char *filename, int fileline);
-mempool_t *_Mem_AllocPool(const char *name, const char *filename, int fileline);
+mempool_t *_Mem_AllocPool(const char *name, int flags, mempool_t *parent, const char *filename, int fileline);
 void _Mem_FreePool(mempool_t **pool, const char *filename, int fileline);
 void _Mem_EmptyPool(mempool_t *pool, const char *filename, int fileline);
 void _Mem_CheckSentinels(void *data, const char *filename, int fileline);
 void _Mem_CheckSentinelsGlobal(const char *filename, int fileline);
+// if pool is NULL this searches ALL pools for the allocation
+qbool Mem_IsAllocated(mempool_t *pool, void *data);
+
+char* Mem_strdup (mempool_t *pool, const char* s);
+
+typedef struct memexpandablearray_array_s
+{
+       unsigned char *data;
+       unsigned char *allocflags;
+       size_t numflaggedrecords;
+}
+memexpandablearray_array_t;
+
+typedef struct memexpandablearray_s
+{
+       mempool_t *mempool;
+       size_t recordsize;
+       size_t numrecordsperarray;
+       size_t numarrays;
+       size_t maxarrays;
+       memexpandablearray_array_t *arrays;
+}
+memexpandablearray_t;
+
+void Mem_ExpandableArray_NewArray(memexpandablearray_t *l, mempool_t *mempool, size_t recordsize, int numrecordsperarray);
+void Mem_ExpandableArray_FreeArray(memexpandablearray_t *l);
+void *Mem_ExpandableArray_AllocRecord(memexpandablearray_t *l);
+void Mem_ExpandableArray_FreeRecord(memexpandablearray_t *l, void *record);
+size_t Mem_ExpandableArray_IndexRange(const memexpandablearray_t *l) DP_FUNC_PURE;
+void *Mem_ExpandableArray_RecordAtIndex(const memexpandablearray_t *l, size_t index) DP_FUNC_PURE;
 
 // used for temporary allocations
-mempool_t *tempmempool;
+extern mempool_t *tempmempool;
 
 void Memory_Init (void);
+void Memory_Shutdown (void);
 void Memory_Init_Commands (void);
 
 extern mempool_t *zonemempool;
-#define Z_Malloc(size) Mem_Alloc(zonemempool,size)
+#define Z_Malloc(size) Mem_Alloc(zonemempool, size)
+#define Z_Realloc(data, size) Mem_Realloc(zonemempool, data, size)
+#define Z_strdup(s) Mem_strdup(zonemempool, s)
 #define Z_Free(data) Mem_Free(data)
 
+extern struct cvar_s developer_memory;
+extern struct cvar_s developer_memorydebug;
+extern struct cvar_s developer_memoryreportlargerthanmb;
+
 #endif