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