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