zone.h

   1 /*
   2 Copyright (C) 1996-1997 Id Software, Inc.
   3
   4 This program is free software; you can redistribute it and/or
   5 modify it under the terms of the GNU General Public License
   6 as published by the Free Software Foundation; either version 2
   7 of the License, or (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  12
  13 See the 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
  17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  18
  19 */
  20
  21 #ifndef ZONE_H
  22 #define ZONE_H
  23
  24 #include <stddef.h>
  25 #include "qtypes.h"
  26 #include "qdefs.h"
  27 #include "com_list.h"
  28
  29 extern qbool mem_bigendian;
  30
  31 // div0: heap overflow detection paranoia
  32 #define MEMPARANOIA 0
  33
  34 #define POOLNAMESIZE 128
  35 // if set this pool will be printed in memlist reports
  36 #define POOLFLAG_TEMP 1
  37
  38 typedef struct memheader_s
  39 {
  40         // address returned by Chunk_Alloc (may be significantly before this header to satisify alignment)
  41         void *baseaddress;
  42         // next and previous memheaders in chain belonging to pool
  43         struct llist_s list;
  44         // pool this memheader belongs to
  45         struct mempool_s *pool;
  46         // size of the memory after the header (excluding header and sentinel2)
  47         size_t size;
  48         // file name and line where Mem_Alloc was called
  49         const char *filename;
  50         int fileline;
  51         // should always be equal to MEMHEADER_SENTINEL_FOR_ADDRESS()
  52         unsigned int sentinel;
  53         // immediately followed by data, which is followed by another copy of mem_sentinel[]
  54 }
  55 memheader_t;
  56
  57 typedef struct mempool_s
  58 {
  59         // should always be MEMPOOL_SENTINEL
  60         unsigned int sentinel1;
  61         // chain of individual memory allocations
  62         struct llist_s chain;
  63         // POOLFLAG_*
  64         int flags;
  65         // total memory allocated in this pool (inside memheaders)
  66         size_t totalsize;
  67         // total memory allocated in this pool (actual malloc total)
  68         size_t realsize;
  69         // updated each time the pool is displayed by memlist, shows change from previous time (unless pool was freed)
  70         size_t lastchecksize;
  71         // linked into global mempool list
  72         struct mempool_s *next;
  73         // parent object (used for nested memory pools)
  74         struct mempool_s *parent;
  75         // file name and line where Mem_AllocPool was called
  76         const char *filename;
  77         int fileline;
  78         // name of the pool
  79         char name[POOLNAMESIZE];
  80         // should always be MEMPOOL_SENTINEL
  81         unsigned int sentinel2;
  82 }
  83 mempool_t;
  84
  85 #define Mem_Alloc(pool,size) _Mem_Alloc(pool, NULL, size, 16, __FILE__, __LINE__)
  86 #define Mem_Memalign(pool,alignment,size) _Mem_Alloc(pool, NULL, size, alignment, __FILE__, __LINE__)
  87 #define Mem_Realloc(pool,data,size) _Mem_Alloc(pool, data, size, 16, __FILE__, __LINE__)
  88 #define Mem_Free(mem) _Mem_Free(mem, __FILE__, __LINE__)
  89 #define Mem_strdup(pool, s) _Mem_strdup(pool, s, __FILE__, __LINE__)
  90 #define Mem_CheckSentinels(data) _Mem_CheckSentinels(data, __FILE__, __LINE__)
  91 #if MEMPARANOIA
  92 #define Mem_CheckSentinelsGlobal()  _Mem_CheckSentinelsGlobal(__FILE__, __LINE__)
  93 #else
  94 #define Mem_CheckSentinelsGlobal() if(developer_memorydebug.integer) { _Mem_CheckSentinelsGlobal(__FILE__, __LINE__); }
  95 #endif
  96 #define Mem_AllocPool(name, flags, parent) _Mem_AllocPool(name, flags, parent, __FILE__, __LINE__)
  97 #define Mem_FreePool(pool) _Mem_FreePool(pool, __FILE__, __LINE__)
  98 #define Mem_EmptyPool(pool) _Mem_EmptyPool(pool, __FILE__, __LINE__)
  99
 100 void *_Mem_Alloc(mempool_t *pool, void *data, size_t size, size_t alignment, const char *filename, int fileline);
 101 void _Mem_Free(void *data, const char *filename, int fileline);
 102 mempool_t *_Mem_AllocPool(const char *name, int flags, mempool_t *parent, const char *filename, int fileline);
 103 void _Mem_FreePool(mempool_t **pool, const char *filename, int fileline);
 104 void _Mem_EmptyPool(mempool_t *pool, const char *filename, int fileline);
 105 void _Mem_CheckSentinels(void *data, const char *filename, int fileline);
 106 void _Mem_CheckSentinelsGlobal(const char *filename, int fileline);
 107 // if pool is NULL this searches ALL pools for the allocation
 108 qbool Mem_IsAllocated(mempool_t *pool, void *data);
 109
 110 char* _Mem_strdup (mempool_t *pool, const char* s, const char *filename, int fileline);
 111
 112 typedef struct memexpandablearray_array_s
 113 {
 114         unsigned char *data;
 115         unsigned char *allocflags;
 116         size_t numflaggedrecords;
 117 }
 118 memexpandablearray_array_t;
 119
 120 typedef struct memexpandablearray_s
 121 {
 122         mempool_t *mempool;
 123         size_t recordsize;
 124         size_t numrecordsperarray;
 125         size_t numarrays;
 126         size_t maxarrays;
 127         memexpandablearray_array_t *arrays;
 128 }
 129 memexpandablearray_t;
 130
 131 void Mem_ExpandableArray_NewArray(memexpandablearray_t *l, mempool_t *mempool, size_t recordsize, int numrecordsperarray);
 132 void Mem_ExpandableArray_FreeArray(memexpandablearray_t *l);
 133 void *Mem_ExpandableArray_AllocRecord(memexpandablearray_t *l);
 134 void Mem_ExpandableArray_FreeRecord(memexpandablearray_t *l, void *record);
 135 size_t Mem_ExpandableArray_IndexRange(const memexpandablearray_t *l) DP_FUNC_PURE;
 136 void *Mem_ExpandableArray_RecordAtIndex(const memexpandablearray_t *l, size_t index) DP_FUNC_PURE;
 137
 138 // used for temporary allocations
 139 extern mempool_t *tempmempool;
 140
 141 void Memory_Init (void);
 142 void Memory_Shutdown (void);
 143 void Memory_Init_Commands (void);
 144
 145 extern mempool_t *zonemempool;
 146 #define Z_Malloc(size) Mem_Alloc(zonemempool, size)
 147 #define Z_Realloc(data, size) Mem_Realloc(zonemempool, data, size)
 148 #define Z_strdup(s) Mem_strdup(zonemempool, s)
 149 #define Z_Free(data) Mem_Free(data)
 150
 151 extern struct cvar_s developer_memory;
 152 extern struct cvar_s developer_memorydebug;
 153 extern struct cvar_s developer_memoryreportlargerthanmb;
 154
 155 #endif
 156