improved error reporting on memory functions
[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 #define POOLNAMESIZE 128
24 // give malloc padding so we can't waste most of a page at the end
25 #define MEMCLUMPSIZE (65536 - 1536)
26 // smallest unit we care about is this many bytes
27 #define MEMUNIT 8
28 #define MEMBITS (MEMCLUMPSIZE / MEMUNIT)
29 #define MEMBITINTS (MEMBITS / 32)
30
31 #define MEMHEADER_SENTINEL 0xABADCAFE
32 #define MEMCLUMP_SENTINEL 0xDEADF00D
33
34 typedef struct memheader_s
35 {
36         // next memheader in chain belonging to pool
37         struct memheader_s *chain;
38         // pool this memheader belongs to
39         struct mempool_s *pool;
40         // clump this memheader lives in, NULL if not in a clump
41         struct memclump_s *clump;
42         // size of the memory after the header (excluding header and sentinel2)
43         int size;
44         // file name and line where Mem_Alloc was called
45         char *filename;
46         int fileline;
47         // should always be MEMHEADER_SENTINEL
48         int sentinel1;
49         // immediately followed by data, which is followed by another MEMHEADER_SENTINEL
50 }
51 memheader_t;
52
53 typedef struct memclump_s
54 {
55         // contents of the clump
56         byte block[MEMCLUMPSIZE];
57         // should always be MEMCLUMP_SENTINEL
58         int sentinel1;
59         // if a bit is on, it means that the MEMUNIT bytes it represents are
60         // allocated, otherwise free
61         int bits[MEMBITINTS];
62         // should always be MEMCLUMP_SENTINEL
63         int sentinel2;
64         // if this drops to 0, the clump is freed
65         int blocksinuse;
66         // largest block of memory available (this is reset to an optimistic
67         // number when anything is freed, and updated when alloc fails the clump)
68         int largestavailable;
69         // next clump in the chain
70         struct memclump_s *chain;
71 }
72 memclump_t;
73
74 typedef struct mempool_s
75 {
76         // chain of individual memory allocations
77         struct memheader_s *chain;
78         // chain of clumps (if any)
79         struct memclump_s *clumpchain;
80         // total memory allocated in this pool (inside memheaders)
81         int totalsize;
82         // total memory allocated in this pool (actual malloc total)
83         int realsize;
84         // updated each time the pool is displayed by memlist, shows change from previous time (unless pool was freed)
85         int lastchecksize;
86         // name of the pool
87         char name[POOLNAMESIZE];
88         // linked into global mempool list
89         struct mempool_s *next;
90 }
91 mempool_t;
92
93 #define Mem_Alloc(pool,size) _Mem_Alloc(pool, size, __FILE__, __LINE__)
94 #define Mem_Free(mem) _Mem_Free(mem, __FILE__, __LINE__)
95 #define Mem_CheckSentinels(data) _Mem_CheckSentinels(data, __FILE__, __LINE__)
96 #define Mem_CheckSentinelsGlobal() _Mem_CheckSentinelsGlobal(__FILE__, __LINE__)
97 #define Mem_AllocPool(name) _Mem_AllocPool(name, __FILE__, __LINE__)
98 #define Mem_FreePool(pool) _Mem_FreePool(pool, __FILE__, __LINE__)
99 #define Mem_EmptyPool(pool) _Mem_EmptyPool(pool, __FILE__, __LINE__)
100
101 void *_Mem_Alloc(mempool_t *pool, int size, char *filename, int fileline);
102 void _Mem_Free(void *data, char *filename, int fileline);
103 mempool_t *_Mem_AllocPool(char *name, char *filename, int fileline);
104 void _Mem_FreePool(mempool_t **pool, char *filename, int fileline);
105 void _Mem_EmptyPool(mempool_t *pool, char *filename, int fileline);
106 void _Mem_CheckSentinels(void *data, char *filename, int fileline);
107 void _Mem_CheckSentinelsGlobal(char *filename, int fileline);
108
109 // used for temporary allocations
110 mempool_t *tempmempool;
111
112 void Memory_Init (void);
113 void Memory_Init_Commands (void);
114
115 extern mempool_t *zonemempool;
116 #define Z_Malloc(size) Mem_Alloc(zonemempool,size)
117 #define Z_Free(data) Mem_Free(data)
118 #endif