zone.c

   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 // Z_zone.c
  21
  22 #include "quakedef.h"
  23
  24 cvar_t developer_memory = {0, "developer_memory", "0"};
  25 cvar_t developer_memorydebug = {0, "developer_memorydebug", "0"};
  26
  27 mempool_t *poolchain = NULL;
  28
  29 void *_Mem_Alloc(mempool_t *pool, int size, const char *filename, int fileline)
  30 {
  31 #if MEMCLUMPING
  32         int i, j, k, needed, endbit, largest;
  33         memclump_t *clump, **clumpchainpointer;
  34 #endif
  35         memheader_t *mem;
  36         if (size <= 0)
  37                 return NULL;
  38         if (pool == NULL)
  39                 Sys_Error("Mem_Alloc: pool == NULL (alloc at %s:%i)", filename, fileline);
  40         if (developer.integer && developer_memory.integer)
  41                 Con_Printf("Mem_Alloc: pool %s, file %s:%i, size %i bytes\n", pool->name, filename, fileline, size);
  42         if (developer.integer && developer_memorydebug.integer)
  43                 _Mem_CheckSentinelsGlobal(filename, fileline);
  44         pool->totalsize += size;
  45 #if MEMCLUMPING
  46         if (size < 4096)
  47         {
  48                 // clumping
  49                 needed = (sizeof(memheader_t) + size + sizeof(int) + (MEMUNIT - 1)) / MEMUNIT;
  50                 endbit = MEMBITS - needed;
  51                 for (clumpchainpointer = &pool->clumpchain;*clumpchainpointer;clumpchainpointer = &(*clumpchainpointer)->chain)
  52                 {
  53                         clump = *clumpchainpointer;
  54                         if (clump->sentinel1 != MEMCLUMP_SENTINEL)
  55                                 Sys_Error("Mem_Alloc: trashed clump sentinel 1 (alloc at %s:%d)", filename, fileline);
  56                         if (clump->sentinel2 != MEMCLUMP_SENTINEL)
  57                                 Sys_Error("Mem_Alloc: trashed clump sentinel 2 (alloc at %s:%d)", filename, fileline);
  58                         if (clump->largestavailable >= needed)
  59                         {
  60                                 largest = 0;
  61                                 for (i = 0;i < endbit;i++)
  62                                 {
  63                                         if (clump->bits[i >> 5] & (1 << (i & 31)))
  64                                                 continue;
  65                                         k = i + needed;
  66                                         for (j = i;i < k;i++)
  67                                                 if (clump->bits[i >> 5] & (1 << (i & 31)))
  68                                                         goto loopcontinue;
  69                                         goto choseclump;
  70         loopcontinue:;
  71                                         if (largest < j - i)
  72                                                 largest = j - i;
  73                                 }
  74                                 // since clump falsely advertised enough space (nothing wrong
  75                                 // with that), update largest count to avoid wasting time in
  76                                 // later allocations
  77                                 clump->largestavailable = largest;
  78                         }
  79                 }
  80                 pool->realsize += sizeof(memclump_t);
  81                 clump = malloc(sizeof(memclump_t));
  82                 if (clump == NULL)
  83                         Sys_Error("Mem_Alloc: out of memory (alloc at %s:%i)", filename, fileline);
  84                 memset(clump, 0, sizeof(memclump_t));
  85                 *clumpchainpointer = clump;
  86                 clump->sentinel1 = MEMCLUMP_SENTINEL;
  87                 clump->sentinel2 = MEMCLUMP_SENTINEL;
  88                 clump->chain = NULL;
  89                 clump->blocksinuse = 0;
  90                 clump->largestavailable = MEMBITS - needed;
  91                 j = 0;
  92 choseclump:
  93                 mem = (memheader_t *)((qbyte *) clump->block + j * MEMUNIT);
  94                 mem->clump = clump;
  95                 clump->blocksinuse += needed;
  96                 for (i = j + needed;j < i;j++)
  97                         clump->bits[j >> 5] |= (1 << (j & 31));
  98         }
  99         else
 100         {
 101                 // big allocations are not clumped
 102 #endif
 103                 pool->realsize += sizeof(memheader_t) + size + sizeof(int);
 104                 mem = malloc(sizeof(memheader_t) + size + sizeof(int));
 105                 if (mem == NULL)
 106                         Sys_Error("Mem_Alloc: out of memory (alloc at %s:%i)", filename, fileline);
 107 #if MEMCLUMPING
 108                 mem->clump = NULL;
 109         }
 110 #endif
 111         mem->filename = filename;
 112         mem->fileline = fileline;
 113         mem->size = size;
 114         mem->pool = pool;
 115         mem->sentinel1 = MEMHEADER_SENTINEL1;
 116         // we have to use only a single byte for this sentinel, because it may not be aligned, and some platforms can't use unaligned accesses
 117         *((qbyte *) mem + sizeof(memheader_t) + mem->size) = MEMHEADER_SENTINEL2;
 118         // append to head of list
 119         mem->next = pool->chain;
 120         mem->prev = NULL;
 121         pool->chain = mem;
 122         if (mem->next)
 123                 mem->next->prev = mem;
 124         memset((void *)((qbyte *) mem + sizeof(memheader_t)), 0, mem->size);
 125         return (void *)((qbyte *) mem + sizeof(memheader_t));
 126 }
 127
 128 void _Mem_Free(void *data, const char *filename, int fileline)
 129 {
 130 #if MEMCLUMPING
 131         int i, firstblock, endblock;
 132         memclump_t *clump, **clumpchainpointer;
 133 #endif
 134         memheader_t *mem;
 135         mempool_t *pool;
 136         if (data == NULL)
 137                 Sys_Error("Mem_Free: data == NULL (called at %s:%i)", filename, fileline);
 138
 139         mem = (memheader_t *)((qbyte *) data - sizeof(memheader_t));
 140         if (mem->sentinel1 != MEMHEADER_SENTINEL1)
 141                 Sys_Error("Mem_Free: trashed header sentinel 1 (alloc at %s:%i, free at %s:%i)", mem->filename, mem->fileline, filename, fileline);
 142         if (*((qbyte *) mem + sizeof(memheader_t) + mem->size) != MEMHEADER_SENTINEL2)
 143                 Sys_Error("Mem_Free: trashed header sentinel 2 (alloc at %s:%i, free at %s:%i)", mem->filename, mem->fileline, filename, fileline);
 144         pool = mem->pool;
 145         if (developer.integer && developer_memory.integer)
 146                 Con_Printf("Mem_Free: pool %s, alloc %s:%i, free %s:%i, size %i bytes\n", pool->name, mem->filename, mem->fileline, filename, fileline, mem->size);
 147         // unlink memheader from doubly linked list
 148         if ((mem->prev ? mem->prev->next != mem : pool->chain != mem) || (mem->next && mem->next->prev != mem))
 149                 Sys_Error("Mem_Free: not allocated or double freed (free at %s:%i)", filename, fileline);
 150         if (mem->prev)
 151                 mem->prev->next = mem->next;
 152         else
 153                 pool->chain = mem->next;
 154         if (mem->next)
 155                 mem->next->prev = mem->prev;
 156         // memheader has been unlinked, do the actual free now
 157         pool->totalsize -= mem->size;
 158 #if MEMCLUMPING
 159         if ((clump = mem->clump))
 160         {
 161                 if (clump->sentinel1 != MEMCLUMP_SENTINEL)
 162                         Sys_Error("Mem_Free: trashed clump sentinel 1 (free at %s:%i)", filename, fileline);
 163                 if (clump->sentinel2 != MEMCLUMP_SENTINEL)
 164                         Sys_Error("Mem_Free: trashed clump sentinel 2 (free at %s:%i)", filename, fileline);
 165                 firstblock = ((qbyte *) mem - (qbyte *) clump->block);
 166                 if (firstblock & (MEMUNIT - 1))
 167                         Sys_Error("Mem_Free: address not valid in clump (free at %s:%i)", filename, fileline);
 168                 firstblock /= MEMUNIT;
 169                 endblock = firstblock + ((sizeof(memheader_t) + mem->size + sizeof(int) + (MEMUNIT - 1)) / MEMUNIT);
 170                 clump->blocksinuse -= endblock - firstblock;
 171                 // could use &, but we know the bit is set
 172                 for (i = firstblock;i < endblock;i++)
 173                         clump->bits[i >> 5] -= (1 << (i & 31));
 174                 if (clump->blocksinuse <= 0)
 175                 {
 176                         // unlink from chain
 177                         for (clumpchainpointer = &pool->clumpchain;*clumpchainpointer;clumpchainpointer = &(*clumpchainpointer)->chain)
 178                         {
 179                                 if (*clumpchainpointer == clump)
 180                                 {
 181                                         *clumpchainpointer = clump->chain;
 182                                         break;
 183                                 }
 184                         }
 185                         pool->realsize -= sizeof(memclump_t);
 186                         memset(clump, 0xBF, sizeof(memclump_t));
 187                         free(clump);
 188                 }
 189                 else
 190                 {
 191                         // clump still has some allocations
 192                         // force re-check of largest available space on next alloc
 193                         clump->largestavailable = MEMBITS - clump->blocksinuse;
 194                 }
 195         }
 196         else
 197         {
 198 #endif
 199                 pool->realsize -= sizeof(memheader_t) + mem->size + sizeof(int);
 200                 memset(mem, 0xBF, sizeof(memheader_t) + mem->size + sizeof(int));
 201                 free(mem);
 202 #if MEMCLUMPING
 203         }
 204 #endif
 205 }
 206
 207 mempool_t *_Mem_AllocPool(const char *name, const char *filename, int fileline)
 208 {
 209         mempool_t *pool;
 210         pool = malloc(sizeof(mempool_t));
 211         if (pool == NULL)
 212                 Sys_Error("Mem_AllocPool: out of memory (allocpool at %s:%i)", filename, fileline);
 213         memset(pool, 0, sizeof(mempool_t));
 214         pool->sentinel1 = MEMHEADER_SENTINEL1;
 215         pool->sentinel2 = MEMHEADER_SENTINEL1;
 216         pool->filename = filename;
 217         pool->fileline = fileline;
 218         pool->chain = NULL;
 219         pool->totalsize = 0;
 220         pool->realsize = sizeof(mempool_t);
 221         strcpy(pool->name, name);
 222         pool->next = poolchain;
 223         poolchain = pool;
 224         return pool;
 225 }
 226
 227 void _Mem_FreePool(mempool_t **pool, const char *filename, int fileline)
 228 {
 229         mempool_t **chainaddress;
 230         if (*pool)
 231         {
 232                 if ((*pool)->sentinel1 != MEMHEADER_SENTINEL1)
 233                         Sys_Error("Mem_FreePool: trashed pool sentinel 1 (allocpool at %s:%i, freepool at %s:%i)", (*pool)->filename, (*pool)->fileline, filename, fileline);
 234                 if ((*pool)->sentinel2 != MEMHEADER_SENTINEL1)
 235                         Sys_Error("Mem_FreePool: trashed pool sentinel 2 (allocpool at %s:%i, freepool at %s:%i)", (*pool)->filename, (*pool)->fileline, filename, fileline);
 236                 // unlink pool from chain
 237                 for (chainaddress = &poolchain;*chainaddress && *chainaddress != *pool;chainaddress = &((*chainaddress)->next));
 238                 if (*chainaddress != *pool)
 239                         Sys_Error("Mem_FreePool: pool already free (freepool at %s:%i)", filename, fileline);
 240                 *chainaddress = (*pool)->next;
 241
 242                 // free memory owned by the pool
 243                 while ((*pool)->chain)
 244                         Mem_Free((void *)((qbyte *) (*pool)->chain + sizeof(memheader_t)));
 245
 246                 // free the pool itself
 247                 memset(*pool, 0xBF, sizeof(mempool_t));
 248                 free(*pool);
 249                 *pool = NULL;
 250         }
 251 }
 252
 253 void _Mem_EmptyPool(mempool_t *pool, const char *filename, int fileline)
 254 {
 255         if (pool == NULL)
 256                 Sys_Error("Mem_EmptyPool: pool == NULL (emptypool at %s:%i)", filename, fileline);
 257         if (pool->sentinel1 != MEMHEADER_SENTINEL1)
 258                 Sys_Error("Mem_EmptyPool: trashed pool sentinel 1 (allocpool at %s:%i, emptypool at %s:%i)", pool->filename, pool->fileline, filename, fileline);
 259         if (pool->sentinel2 != MEMHEADER_SENTINEL1)
 260                 Sys_Error("Mem_EmptyPool: trashed pool sentinel 2 (allocpool at %s:%i, emptypool at %s:%i)", pool->filename, pool->fileline, filename, fileline);
 261
 262         // free memory owned by the pool
 263         while (pool->chain)
 264                 Mem_Free((void *)((qbyte *) pool->chain + sizeof(memheader_t)));
 265 }
 266
 267 void _Mem_CheckSentinels(void *data, const char *filename, int fileline)
 268 {
 269         memheader_t *mem;
 270
 271         if (data == NULL)
 272                 Sys_Error("Mem_CheckSentinels: data == NULL (sentinel check at %s:%i)", filename, fileline);
 273
 274         mem = (memheader_t *)((qbyte *) data - sizeof(memheader_t));
 275         if (mem->sentinel1 != MEMHEADER_SENTINEL1)
 276                 Sys_Error("Mem_CheckSentinels: trashed header sentinel 1 (block allocated at %s:%i, sentinel check at %s:%i)", mem->filename, mem->fileline, filename, fileline);
 277         if (*((qbyte *) mem + sizeof(memheader_t) + mem->size) != MEMHEADER_SENTINEL2)
 278                 Sys_Error("Mem_CheckSentinels: trashed header sentinel 2 (block allocated at %s:%i, sentinel check at %s:%i)", mem->filename, mem->fileline, filename, fileline);
 279 }
 280
 281 #if MEMCLUMPING
 282 static void _Mem_CheckClumpSentinels(memclump_t *clump, const char *filename, int fileline)
 283 {
 284         // this isn't really very useful
 285         if (clump->sentinel1 != MEMCLUMP_SENTINEL)
 286                 Sys_Error("Mem_CheckClumpSentinels: trashed sentinel 1 (sentinel check at %s:%i)", filename, fileline);
 287         if (clump->sentinel2 != MEMCLUMP_SENTINEL)
 288                 Sys_Error("Mem_CheckClumpSentinels: trashed sentinel 2 (sentinel check at %s:%i)", filename, fileline);
 289 }
 290 #endif
 291
 292 void _Mem_CheckSentinelsGlobal(const char *filename, int fileline)
 293 {
 294         memheader_t *mem;
 295 #if MEMCLUMPING
 296         memclump_t *clump;
 297 #endif
 298         mempool_t *pool;
 299         for (pool = poolchain;pool;pool = pool->next)
 300         {
 301                 if (pool->sentinel1 != MEMHEADER_SENTINEL1)
 302                         Sys_Error("Mem_CheckSentinelsGlobal: trashed pool sentinel 1 (allocpool at %s:%i, sentinel check at %s:%i)", pool->filename, pool->fileline, filename, fileline);
 303                 if (pool->sentinel2 != MEMHEADER_SENTINEL1)
 304                         Sys_Error("Mem_CheckSentinelsGlobal: trashed pool sentinel 2 (allocpool at %s:%i, sentinel check at %s:%i)", pool->filename, pool->fileline, filename, fileline);
 305         }
 306         for (pool = poolchain;pool;pool = pool->next)
 307                 for (mem = pool->chain;mem;mem = mem->next)
 308                         _Mem_CheckSentinels((void *)((qbyte *) mem + sizeof(memheader_t)), filename, fileline);
 309 #if MEMCLUMPING
 310         for (pool = poolchain;pool;pool = pool->next)
 311                 for (clump = pool->clumpchain;clump;clump = clump->chain)
 312                         _Mem_CheckClumpSentinels(clump, filename, fileline);
 313 #endif
 314 }
 315
 316 // used for temporary memory allocations around the engine, not for longterm
 317 // storage, if anything in this pool stays allocated during gameplay, it is
 318 // considered a leak
 319 mempool_t *tempmempool;
 320 // only for zone
 321 mempool_t *zonemempool;
 322
 323 void Mem_PrintStats(void)
 324 {
 325         int count = 0, size = 0;
 326         mempool_t *pool;
 327         memheader_t *mem;
 328         Mem_CheckSentinelsGlobal();
 329         for (pool = poolchain;pool;pool = pool->next)
 330         {
 331                 count++;
 332                 size += pool->totalsize;
 333         }
 334         Con_Printf("%i memory pools, totalling %i bytes (%.3fMB)\n", count, size, size / 1048576.0);
 335         if (tempmempool == NULL)
 336                 Con_Printf("Error: no tempmempool allocated\n");
 337         else if (tempmempool->chain)
 338         {
 339                 Con_Printf("%i bytes (%.3fMB) of temporary memory still allocated (Leak!)\n", tempmempool->totalsize, tempmempool->totalsize / 1048576.0);
 340                 Con_Printf("listing temporary memory allocations:\n");
 341                 for (mem = tempmempool->chain;mem;mem = mem->next)
 342                         Con_Printf("%10i bytes allocated at %s:%i\n", mem->size, mem->filename, mem->fileline);
 343         }
 344 }
 345
 346 void Mem_PrintList(int listallocations)
 347 {
 348         mempool_t *pool;
 349         memheader_t *mem;
 350         Mem_CheckSentinelsGlobal();
 351         Con_Printf("memory pool list:\n"
 352                    "size    name\n");
 353         for (pool = poolchain;pool;pool = pool->next)
 354         {
 355                 if (pool->lastchecksize != 0 && pool->totalsize != pool->lastchecksize)
 356                         Con_Printf("%10ik (%10ik actual) %s (%i byte change)\n", (pool->totalsize + 1023) / 1024, (pool->realsize + 1023) / 1024, pool->name, pool->totalsize - pool->lastchecksize);
 357                 else
 358                         Con_Printf("%10ik (%10ik actual) %s\n", (pool->totalsize + 1023) / 1024, (pool->realsize + 1023) / 1024, pool->name);
 359                 pool->lastchecksize = pool->totalsize;
 360                 if (listallocations)
 361                         for (mem = pool->chain;mem;mem = mem->next)
 362                                 Con_Printf("%10i bytes allocated at %s:%i\n", mem->size, mem->filename, mem->fileline);
 363         }
 364 }
 365
 366 void MemList_f(void)
 367 {
 368         switch(Cmd_Argc())
 369         {
 370         case 1:
 371                 Mem_PrintList(false);
 372                 Mem_PrintStats();
 373                 break;
 374         case 2:
 375                 if (!strcmp(Cmd_Argv(1), "all"))
 376                 {
 377                         Mem_PrintList(true);
 378                         Mem_PrintStats();
 379                         break;
 380                 }
 381                 // drop through
 382         default:
 383                 Con_Printf("MemList_f: unrecognized options\nusage: memlist [all]\n");
 384                 break;
 385         }
 386 }
 387
 388 extern void R_TextureStats_PrintTotal(void);
 389 void MemStats_f(void)
 390 {
 391         Mem_CheckSentinelsGlobal();
 392         R_TextureStats_PrintTotal();
 393         Mem_PrintStats();
 394 }
 395
 396
 397 /*
 398 ========================
 399 Memory_Init
 400 ========================
 401 */
 402 void Memory_Init (void)
 403 {
 404         tempmempool = Mem_AllocPool("Temporary Memory");
 405         zonemempool = Mem_AllocPool("Zone");
 406 }
 407
 408 void Memory_Init_Commands (void)
 409 {
 410         Cmd_AddCommand ("memstats", MemStats_f);
 411         Cmd_AddCommand ("memlist", MemList_f);
 412         Cvar_RegisterVariable (&developer_memory);
 413         Cvar_RegisterVariable (&developer_memorydebug);
 414 }
 415