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 <stdalign.h>
  26 #include "qtypes.h"
  27 #include "qdefs.h"
  28 #include "com_list.h"
  29
  30 // Work around incomplete C11 support in Microsoft's stddef.h
  31 // This matches the Clang 14 header. Microsoft's double and long double are the same.
  32 #if defined(_MSC_VER)
  33         typedef double max_align_t;
  34 #endif
  35
  36 extern qbool mem_bigendian;
  37
  38 // div0: heap overflow detection paranoia
  39 #define MEMPARANOIA 0
  40
  41 #define POOLNAMESIZE 128
  42 // if set this pool will be printed in memlist reports
  43 #define POOLFLAG_TEMP 1
  44
  45 typedef struct memheader_s
  46 {
  47         // address returned by Chunk_Alloc (may be significantly before this header to satisify alignment)
  48         void *baseaddress;
  49         // next and previous memheaders in chain belonging to pool
  50         struct llist_s list;
  51         // pool this memheader belongs to
  52         struct mempool_s *pool;
  53         // size of the memory after the header (excluding header and sentinel2)
  54         size_t size;
  55         // file name and line where Mem_Alloc was called
  56         const char *filename;
  57         int fileline;
  58         // should always be equal to MEMHEADER_SENTINEL_FOR_ADDRESS()
  59         unsigned int sentinel;
  60         // immediately followed by data, which is followed by another copy of mem_sentinel[]
  61 }
  62 memheader_t;
  63
  64 typedef struct mempool_s
  65 {
  66         // should always be MEMPOOL_SENTINEL
  67         unsigned int sentinel1;
  68         // chain of individual memory allocations
  69         struct llist_s chain;
  70         // POOLFLAG_*
  71         unsigned flags;
  72         // total memory allocated in this pool (inside memheaders)
  73         size_t totalsize;
  74         // total memory allocated in this pool (actual malloc total)
  75         size_t realsize;
  76         // updated each time the pool is displayed by memlist, shows change from previous time (unless pool was freed)
  77         size_t lastchecksize;
  78         // linked into global mempool list
  79         struct mempool_s *next;
  80         // parent object (used for nested memory pools)
  81         struct mempool_s *parent;
  82         // file name and line where Mem_AllocPool was called
  83         const char *filename;
  84         int fileline;
  85         // name of the pool
  86         char name[POOLNAMESIZE];
  87         // should always be MEMPOOL_SENTINEL
  88         unsigned int sentinel2;
  89 }
  90 mempool_t;
  91
  92 #define Mem_Alloc(pool,size) _Mem_Alloc(pool, NULL, size, alignof(max_align_t), __FILE__, __LINE__)
  93 #define Mem_AllocType(pool,type,size) (type *)_Mem_Alloc(pool, NULL, size, alignof(type), __FILE__, __LINE__)
  94 #define Mem_Realloc(pool,data,size) _Mem_Alloc(pool, data, size, alignof(max_align_t), __FILE__, __LINE__)
  95 #define Mem_ReallocType(pool,data,type,size) (type *)_Mem_Alloc(pool, data, size, alignof(type), __FILE__, __LINE__)
  96 #define Mem_Free(mem) _Mem_Free(mem, __FILE__, __LINE__)
  97 #define Mem_strdup(pool, s) _Mem_strdup(pool, s, __FILE__, __LINE__)
  98 #define Mem_CheckSentinels(data) _Mem_CheckSentinels(data, __FILE__, __LINE__)
  99 #if MEMPARANOIA
 100 #define Mem_CheckSentinelsGlobal()  _Mem_CheckSentinelsGlobal(__FILE__, __LINE__)
 101 #else
 102 #define Mem_CheckSentinelsGlobal() if(developer_memorydebug.integer) { _Mem_CheckSentinelsGlobal(__FILE__, __LINE__); }
 103 #endif
 104 #define Mem_AllocPool(name, flags, parent) _Mem_AllocPool(name, flags, parent, __FILE__, __LINE__)
 105 #define Mem_FreePool(pool) _Mem_FreePool(pool, __FILE__, __LINE__)
 106 #define Mem_EmptyPool(pool) _Mem_EmptyPool(pool, __FILE__, __LINE__)
 107
 108 void *_Mem_Alloc(mempool_t *pool, void *data, size_t size, size_t alignment, const char *filename, int fileline);
 109 void _Mem_Free(void *data, const char *filename, int fileline);
 110 mempool_t *_Mem_AllocPool(const char *name, unsigned flags, mempool_t *parent, const char *filename, int fileline);
 111 void _Mem_FreePool(mempool_t **pool, const char *filename, int fileline);
 112 void _Mem_EmptyPool(mempool_t *pool, const char *filename, int fileline);
 113 void _Mem_CheckSentinels(void *data, const char *filename, int fileline);
 114 void _Mem_CheckSentinelsGlobal(const char *filename, int fileline);
 115 // if pool is NULL this searches ALL pools for the allocation
 116 qbool Mem_IsAllocated(mempool_t *pool, const void *data);
 117
 118 char *_Mem_strdup(mempool_t *pool, const char *s, const char *filename, int fileline);
 119
 120 typedef struct memexpandablearray_array_s
 121 {
 122         unsigned char *data;
 123         unsigned char *allocflags;
 124         size_t numflaggedrecords;
 125 }
 126 memexpandablearray_array_t;
 127
 128 typedef struct memexpandablearray_s
 129 {
 130         mempool_t *mempool;
 131         size_t recordsize;
 132         size_t numrecordsperarray;
 133         size_t numarrays;
 134         size_t maxarrays;
 135         memexpandablearray_array_t *arrays;
 136 }
 137 memexpandablearray_t;
 138
 139 void Mem_ExpandableArray_NewArray(memexpandablearray_t *l, mempool_t *mempool, size_t recordsize, int numrecordsperarray);
 140 void Mem_ExpandableArray_FreeArray(memexpandablearray_t *l);
 141 void *Mem_ExpandableArray_AllocRecord(memexpandablearray_t *l);
 142 void Mem_ExpandableArray_FreeRecord(memexpandablearray_t *l, void *record);
 143 size_t Mem_ExpandableArray_IndexRange(const memexpandablearray_t *l) DP_FUNC_PURE;
 144 void *Mem_ExpandableArray_RecordAtIndex(const memexpandablearray_t *l, size_t index) DP_FUNC_PURE;
 145
 146 // used for temporary allocations
 147 extern mempool_t *tempmempool;
 148
 149 void Memory_Init (void);
 150 void Memory_Shutdown (void);
 151 void Memory_Init_Commands (void);
 152
 153 extern mempool_t *zonemempool;
 154 #define Z_Malloc(size) Mem_Alloc(zonemempool, size)
 155 #define Z_Realloc(data, size) Mem_Realloc(zonemempool, data, size)
 156 #define Z_strdup(s) Mem_strdup(zonemempool, s)
 157 #define Z_Free(data) Mem_Free(data)
 158
 159 extern struct cvar_s developer_memory;
 160 extern struct cvar_s developer_memorydebug;
 161 extern struct cvar_s developer_memoryreportlargerthanmb;
 162
 163 #endif
 164