quakeforge/libs/util/zone.c

1132 lines
26 KiB
C
Raw Normal View History

/*
zone.c
(description)
Copyright (C) 1996-1997 Id Software, Inc.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to:
Free Software Foundation, Inc.
59 Temple Place - Suite 330
Boston, MA 02111-1307, USA
*/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
#ifdef HAVE_STRING_H
# include <string.h>
#endif
#ifdef HAVE_STRINGS_H
# include <strings.h>
#endif
#include <stdarg.h>
#include <stdlib.h>
#include "QF/cmd.h"
#include "QF/cvar.h"
#include "QF/mathlib.h"
#include "QF/qargs.h"
#include "QF/sys.h"
#include "QF/va.h"
#include "QF/zone.h"
#include "compat.h"
static void Cache_FreeLow (int new_low_hunk);
static void Cache_Profile (void);
static qboolean Cache_FreeLRU (void);
#define ZONEID 0x1d4a11
#define HUNK_SENTINAL 0x1df001ed
#define MINFRAGMENT 64
#define HUNK_ALIGN 64
/*
2001-08-28 04:24:40 +00:00
ZONE MEMORY ALLOCATION
There is never any space between memblocks, and there will never be two
contiguous free memblocks.
The rover can be left pointing at a non-empty block
The zone calls are pretty much used only for small strings and structures,
all big things are allocated on the hunk.
*/
2001-08-28 04:24:40 +00:00
typedef struct memblock_s
{
int block_size; // including the header and possibly tiny fragments
2001-08-28 04:24:40 +00:00
int tag; // a tag of 0 is a free block
struct memblock_s *next, *prev;
int size; // requested size
int id; // should be ZONEID
//int id2; // pad to 64 bit boundary
2001-08-28 04:24:40 +00:00
} memblock_t;
struct memzone_s
2001-08-28 04:24:40 +00:00
{
int size; // total bytes malloced, including header
int used; // ammount used, including header
int offset;
int ele_size;
void (*error) (void *, const char *);
void *data;
2001-08-28 04:24:40 +00:00
memblock_t blocklist; // start / end cap for linked list
memblock_t *rover;
};
2001-08-28 04:24:40 +00:00
2001-08-28 23:58:22 +00:00
2011-03-20 06:50:09 +00:00
static int
z_block_size (memblock_t *block)
{
return block->block_size - sizeof (memblock_t) - 4;
2011-03-20 06:50:09 +00:00
}
static int
z_offset (memzone_t *zone, memblock_t *block)
{
int offset = ((byte *) (block + 1) - (byte *) zone);
2011-03-20 06:50:09 +00:00
return offset / zone->ele_size + zone->offset;
}
VISIBLE void
Z_ClearZone (memzone_t *zone, int size, int zone_offset, int ele_size)
2001-08-28 04:24:40 +00:00
{
memblock_t *block;
2001-08-28 04:24:40 +00:00
// set the entire zone to one free block
block = (memblock_t *) (zone + 1);
zone->blocklist.next = block;
zone->blocklist.prev = block;
2001-08-28 04:24:40 +00:00
zone->blocklist.tag = 1; // in use block
zone->blocklist.id = 0;
zone->blocklist.block_size = 0;
zone->blocklist.size = 0;
zone->offset = zone_offset;
zone->ele_size = ele_size;
2001-08-28 04:24:40 +00:00
zone->rover = block;
zone->size = size;
zone->used = sizeof (memzone_t);
zone->error = 0;
zone->data = 0;
2001-08-28 04:24:40 +00:00
block->prev = block->next = &zone->blocklist;
block->tag = 0; // free block
block->id = ZONEID;
//block->id2 = ZONEID;
block->block_size = size - sizeof (memzone_t);
block->size = 0;
2001-08-28 04:24:40 +00:00
}
VISIBLE void
2001-08-28 23:58:22 +00:00
Z_Free (memzone_t *zone, void *ptr)
2001-08-28 04:24:40 +00:00
{
memblock_t *block, *other;
if (!ptr) {
if (zone->error)
zone->error (zone->data, "Z_Free: NULL pointer");
2001-08-28 04:24:40 +00:00
Sys_Error ("Z_Free: NULL pointer");
}
2001-08-28 04:24:40 +00:00
2002-08-25 04:47:57 +00:00
block = (memblock_t *) ((byte *) ptr - sizeof (memblock_t));
2011-03-20 06:50:09 +00:00
if (((byte *) block < (byte *) zone)
|| (((byte *) block) >= (byte *) zone + zone->size)) {
const char *msg;
msg = nva ("Z_Free: freed a pointer outside of the zone: %x",
2011-03-20 06:50:09 +00:00
z_offset (zone, block));
if (zone->error)
zone->error (zone->data, msg);
Sys_Error ("%s", msg);
}
if (block->id != ZONEID/* || block->id2 != ZONEID*/) {
const char *msg;
msg = nva ("bad pointer %x", z_offset (zone, block));
Sys_Printf ("%s\n", msg);
2011-03-20 06:50:09 +00:00
Z_Print (zone);
fflush (stdout);
if (zone->error)
zone->error (zone->data, msg);
2001-08-28 04:24:40 +00:00
Sys_Error ("Z_Free: freed a pointer without ZONEID");
2011-03-20 06:50:09 +00:00
}
if (block->tag == 0) {
if (zone->error)
zone->error (zone->data, "Z_Free: freed a freed pointer");
2001-08-28 04:24:40 +00:00
Sys_Error ("Z_Free: freed a freed pointer");
}
2001-08-28 04:24:40 +00:00
block->tag = 0; // mark as free
block->size = 0;
zone->used -= block->block_size;
2001-08-28 04:24:40 +00:00
other = block->prev;
if (!other->tag) {
// merge with previous free block
other->block_size += block->block_size;
2001-08-28 04:24:40 +00:00
other->next = block->next;
other->next->prev = other;
if (block == zone->rover)
zone->rover = other;
2001-08-28 04:24:40 +00:00
block = other;
}
2001-08-28 04:24:40 +00:00
other = block->next;
if (!other->tag) {
// merge the next free block onto the end
block->block_size += other->block_size;
2001-08-28 04:24:40 +00:00
block->next = other->next;
block->next->prev = block;
if (other == zone->rover)
zone->rover = block;
2001-08-28 04:24:40 +00:00
}
}
VISIBLE void *
2002-08-25 04:47:57 +00:00
Z_Malloc (memzone_t *zone, int size)
2001-08-28 04:24:40 +00:00
{
void *buf;
if (!developer || developer->int_val & SYS_dev)
Z_CheckHeap (zone); // DEBUG
buf = Z_TagMalloc (zone, size, 1);
if (!buf) {
const char *msg;
msg = nva ("Z_Malloc: failed on allocation of %i bytes",size);
if (zone->error)
zone->error (zone->data, msg);
Sys_Error ("%s", msg);
}
2001-08-28 04:24:40 +00:00
memset (buf, 0, size);
return buf;
}
2002-08-25 04:47:57 +00:00
void *
Z_TagMalloc (memzone_t *zone, int size, int tag)
2001-08-28 04:24:40 +00:00
{
int extra;
int requested_size = size;
memblock_t *start, *rover, *new, *base;
2001-08-28 04:24:40 +00:00
if (!tag) {
if (zone->error)
zone->error (zone->data, "Z_TagMalloc: tried to use a 0 tag");
2001-08-28 04:24:40 +00:00
Sys_Error ("Z_TagMalloc: tried to use a 0 tag");
}
2001-08-28 04:24:40 +00:00
// scan through the block list looking for the first free block
// of sufficient size
2002-08-25 04:47:57 +00:00
size += sizeof (memblock_t); // account for size of block header
size += 4; // space for memory trash tester
size = (size + 7) & ~7; // align to 8-byte boundary
base = rover = zone->rover;
2001-08-28 04:24:40 +00:00
start = base->prev;
do {
2002-08-25 04:47:57 +00:00
if (rover == start) // scaned all the way around the list
2001-08-28 04:24:40 +00:00
return NULL;
if (rover->tag)
base = rover = rover->next;
else
rover = rover->next;
} while (base->tag || base->block_size < size);
2001-08-28 04:24:40 +00:00
// found a block big enough
extra = base->block_size - size;
if (extra > MINFRAGMENT) {
// there will be a free fragment after the allocated block
2002-08-25 04:47:57 +00:00
new = (memblock_t *) ((byte *) base + size);
new->block_size = extra;
2001-08-28 04:24:40 +00:00
new->tag = 0; // free block
new->prev = base;
new->id = ZONEID;
//new->id2 = ZONEID;
2001-08-28 04:24:40 +00:00
new->next = base->next;
new->next->prev = new;
base->next = new;
base->block_size = size;
2001-08-28 04:24:40 +00:00
}
2001-08-28 04:24:40 +00:00
base->tag = tag; // no longer a free block
base->size = requested_size;
zone->rover = base->next; // next allocation will start looking here
2001-08-28 04:24:40 +00:00
base->id = ZONEID;
//base->id2 = ZONEID;
2001-08-28 04:24:40 +00:00
zone->used += base->block_size;
2001-08-28 04:24:40 +00:00
// marker for memory trash testing
*(int *) ((byte *) base + base->block_size - 4) = ZONEID;
2001-08-28 04:24:40 +00:00
return (void *) (base + 1);
2001-08-28 04:24:40 +00:00
}
VISIBLE void *
Z_Realloc (memzone_t *zone, void *ptr, int size)
{
int old_size;
2002-08-25 04:47:57 +00:00
memblock_t *block;
void *old_ptr;
if (!ptr)
return Z_Malloc (zone, size);
2002-08-25 04:47:57 +00:00
block = (memblock_t *) ((byte *) ptr - sizeof (memblock_t));
if (block->id != ZONEID/* || block->id2 != ZONEID*/) {
if (zone->error)
zone->error (zone->data,
"Z_Realloc: realloced a pointer without ZONEID");
Sys_Error ("Z_Realloc: realloced a pointer without ZONEID");
}
if (block->tag == 0) {
if (zone->error)
zone->error (zone->data, "Z_Realloc: realloced a freed pointer");
Sys_Error ("Z_Realloc: realloced a freed pointer");
}
old_size = block->block_size;
old_size -= sizeof (memblock_t); // account for size of block header
old_size -= 4; // space for memory trash tester
old_ptr = ptr;
Z_Free (zone, ptr);
ptr = Z_TagMalloc (zone, size, 1);
if (!ptr) {
const char *msg;
msg = nva ("Z_Realloc: failed on allocation of %i bytes", size);
if (zone->error)
zone->error (zone->data, msg);
Sys_Error ("%s", msg);
}
if (ptr != old_ptr)
memmove (ptr, old_ptr, min (old_size, size));
if (old_size < size)
memset ((byte *)ptr + old_size, 0, size - old_size);
return ptr;
}
void
2001-08-28 23:58:22 +00:00
Z_Print (memzone_t *zone)
2001-08-28 04:24:40 +00:00
{
memblock_t *block;
Sys_Printf ("zone size: %i location: %p used: %i\n",
zone->size, zone, zone->used);
for (block = zone->blocklist.next ; ; block = block->next) {
Sys_Printf ("block:%p size:%7i tag:%5x ofs:%x\n",
block, z_block_size (block),
block->tag, z_offset (zone, block));
2001-08-28 04:24:40 +00:00
if (block->next == &zone->blocklist)
break; // all blocks have been hit
if (block->id != ZONEID/* || block->id2 != ZONEID*/)
Sys_Printf ("ERROR: block ids incorrect\n");
if ((byte *) block + block->block_size != (byte *) block->next)
Sys_Printf ("ERROR: block size does not touch the next block\n");
if (block->next->prev != block)
Sys_Printf ("ERROR: next block doesn't have proper back link\n");
2001-08-28 04:24:40 +00:00
if (!block->tag && !block->next->tag)
Sys_Printf ("ERROR: two consecutive free blocks\n");
if (block->tag
&& (*(int *) ((byte *) block + block->block_size - 4) != ZONEID))
Sys_Printf ("ERROR: memory trashed in block\n");
fflush (stdout);
2001-08-28 04:24:40 +00:00
}
}
2001-08-28 23:58:22 +00:00
void
Z_CheckHeap (memzone_t *zone)
2001-08-28 04:24:40 +00:00
{
memblock_t *block;
for (block = zone->blocklist.next ; ; block = block->next) {
if (block->next == &zone->blocklist)
break; // all blocks have been hit
if ((byte *) block + block->block_size != (byte *) block->next)
2001-08-28 23:58:22 +00:00
Sys_Error ("Z_CheckHeap: block size does not touch the next "
"block\n");
if (block->next->prev != block)
2001-08-28 23:58:22 +00:00
Sys_Error ("Z_CheckHeap: next block doesn't have proper back "
"link\n");
2001-08-28 04:24:40 +00:00
if (!block->tag && !block->next->tag)
Sys_Error ("Z_CheckHeap: two consecutive free blocks\n");
}
}
VISIBLE void
Z_SetError (memzone_t *zone, void (*err) (void *, const char *), void *data)
{
zone->error = err;
zone->data = data;
}
void
Z_CheckPointer (const memzone_t *zone, const void *ptr, int size)
{
const memblock_t *block;
const char *block_mem;
const char *check = (char *) ptr;
for (block = zone->blocklist.next ; ; block = block->next) {
if (block->next == &zone->blocklist)
break; // all blocks have been hit
if (check < (const char *) block
|| check >= (const char *) block + block->block_size)
continue;
// a block that overlaps with the memory region has been found
if (!block->tag)
zone->error (zone->data, "invalid access to unallocated memory");
block_mem = (char *) &block[1];
if (check < block_mem || check + size > block_mem + block->size)
zone->error (zone->data, "invalid access to allocated memory");
return; // access ok
}
}
//============================================================================
typedef struct {
int sentinal;
2002-08-25 04:47:57 +00:00
int size; // including sizeof(hunk_t), -1 = not allocated
char name[8];
char fill[48]; // pad out to 64 bytes
} hunk_t;
byte *hunk_base;
int hunk_size;
int hunk_low_used;
int hunk_high_used;
2001-08-28 23:58:22 +00:00
int hunk_tempmark;
qboolean hunk_tempactive;
/*
Hunk_Check
Run consistancy and sentinal trahing checks
*/
VISIBLE void
Hunk_Check (void)
{
hunk_t *h;
for (h = (hunk_t *) hunk_base; (byte *) h != hunk_base + hunk_low_used;) {
if (h->sentinal != HUNK_SENTINAL)
Sys_Error ("Hunk_Check: trashed sentinal");
if (h->size < (int) sizeof (hunk_t)
|| h->size + (byte *) h - hunk_base > hunk_size)
Sys_Error ("Hunk_Check: bad size");
h = (hunk_t *) ((byte *) h + h->size);
}
}
/*
Hunk_Print
If "all" is specified, every single allocation is printed.
Otherwise, allocations with the same name will be totaled up before
printing.
*/
VISIBLE void
Hunk_Print (qboolean all)
{
2001-08-28 23:58:22 +00:00
hunk_t *h, *next, *endlow, *starthigh, *endhigh;
int count, sum, totalblocks;
count = 0;
sum = 0;
totalblocks = 0;
h = (hunk_t *) hunk_base;
endlow = (hunk_t *) (hunk_base + hunk_low_used);
starthigh = (hunk_t *) (hunk_base + hunk_size - hunk_high_used);
endhigh = (hunk_t *) (hunk_base + hunk_size);
Sys_Printf (" :%8i total hunk size\n", hunk_size);
Sys_Printf ("-------------------------\n");
while (1) {
// skip to the high hunk if done with low hunk
if (h == endlow) {
Sys_Printf ("-------------------------\n");
Sys_Printf (" :%8i REMAINING\n",
hunk_size - hunk_low_used - hunk_high_used);
Sys_Printf ("-------------------------\n");
h = starthigh;
}
// if totally done, break
if (h == endhigh)
break;
// run consistancy checks
if (h->sentinal != HUNK_SENTINAL)
Sys_Error ("Hunk_Check: trahsed sentinal");
if (h->size < (int) sizeof (hunk_t)
|| h->size + (byte *) h - hunk_base > hunk_size)
Sys_Error ("Hunk_Check: bad size");
next = (hunk_t *) ((byte *) h + h->size);
count++;
totalblocks++;
sum += h->size;
// print the single block
if (all)
Sys_Printf ("%8p :%8i %8.8s\n", h, h->size, h->name);
// print the total
if (next == endlow || next == endhigh ||
strncmp (h->name, next->name, 8)) {
if (!all)
Sys_Printf (" :%8i %8.8s (TOTAL)\n", sum, h->name);
count = 0;
sum = 0;
}
h = next;
}
Sys_Printf ("-------------------------\n");
Sys_Printf ("%8i total blocks\n", totalblocks);
}
static void
Hunk_FreeToHighMark (int mark)
{
if (hunk_tempactive) {
hunk_tempactive = false;
Hunk_FreeToHighMark (hunk_tempmark);
}
if (mark < 0 || mark > hunk_high_used)
Sys_Error ("Hunk_FreeToHighMark: bad mark %i", mark);
memset (hunk_base + hunk_size - hunk_high_used, 0, hunk_high_used - mark);
hunk_high_used = mark;
}
static int
Hunk_HighMark (void)
{
if (hunk_tempactive) {
hunk_tempactive = false;
Hunk_FreeToHighMark (hunk_tempmark);
}
return hunk_high_used;
}
VISIBLE void *
2001-07-15 07:04:17 +00:00
Hunk_AllocName (int size, const char *name)
{
hunk_t *h;
#ifdef PARANOID
Hunk_Check ();
#endif
if (size < 0)
Sys_Error ("Hunk_Alloc: bad size: %i", size);
size = sizeof (hunk_t) + ((size + HUNK_ALIGN - 1) & ~(HUNK_ALIGN - 1));
if (hunk_size - hunk_low_used - hunk_high_used < size) {
Hunk_HighMark();
Cache_FreeLRU ();
}
if (hunk_size - hunk_low_used - hunk_high_used < size) {
int mem = hunk_size / (1024 * 1024);
mem += 8;
mem &= ~7;
Cache_Profile ();
Sys_Error
("Not enough RAM allocated. Try starting using \"-mem %d\" on "
"the %s command line. (%d - %d - %d < %d)", mem,
PACKAGE_NAME, hunk_size, hunk_low_used, hunk_high_used, size);
}
h = (hunk_t *) (hunk_base + hunk_low_used);
hunk_low_used += size;
Cache_FreeLow (hunk_low_used);
memset (h, 0, size);
h->size = size;
h->sentinal = HUNK_SENTINAL;
memcpy (h->name, name, 8);
h->name[7] = 0;
return (void *) (h + 1);
}
VISIBLE void *
Hunk_Alloc (int size)
{
return Hunk_AllocName (size, "unknown");
}
VISIBLE int
Hunk_LowMark (void)
{
return hunk_low_used;
}
VISIBLE void
Hunk_FreeToLowMark (int mark)
{
if (mark < 0 || mark > hunk_low_used)
Sys_Error ("Hunk_FreeToLowMark: bad mark %i", mark);
memset (hunk_base + mark, 0, hunk_low_used - mark);
hunk_low_used = mark;
}
static void *
Hunk_HighAlloc (int size)
{
hunk_t *h;
if (size < 0)
Sys_Error ("Hunk_HighAlloc: bad size: %i", size);
if (hunk_tempactive) {
Hunk_FreeToHighMark (hunk_tempmark);
hunk_tempactive = false;
}
#ifdef PARANOID
Hunk_Check ();
#endif
size = sizeof (hunk_t) + ((size + HUNK_ALIGN - 1) & ~(HUNK_ALIGN - 1));
if (hunk_size - hunk_low_used - hunk_high_used < size) {
Sys_Printf ("Hunk_HighAlloc: failed on %i bytes\n", size);
return NULL;
}
hunk_high_used += size;
h = (void *) (hunk_base + hunk_size - hunk_high_used);
h->sentinal = HUNK_SENTINAL;
h->size = size;
h->name[0] = 0;
return h + 1;
}
/*
Hunk_TempAlloc
Return space from the top of the hunk
*/
VISIBLE void *
Hunk_TempAlloc (int size)
{
void *buf;
size = (size + HUNK_ALIGN - 1) & ~(HUNK_ALIGN - 1);
if (hunk_tempactive) {
2003-04-17 00:01:48 +00:00
if (hunk_high_used - hunk_tempmark >= size + (int) sizeof (hunk_t)) {
return (hunk_t *) (hunk_base + hunk_size - hunk_high_used) + 1;
}
Hunk_FreeToHighMark (hunk_tempmark);
hunk_tempactive = false;
}
hunk_tempmark = Hunk_HighMark ();
buf = Hunk_HighAlloc (size);
hunk_tempactive = true;
return buf;
}
2001-08-28 23:58:22 +00:00
/* CACHE MEMORY */
typedef struct cache_system_s cache_system_t;
struct cache_system_s {
cache_system_t *prev, *next;
cache_system_t *lru_prev, *lru_next; // for LRU flushing
char name[16];
size_t size; // including this header
int readlock;
cache_user_t *user;
};
static cache_system_t cache_head;
static cache_system_t *Cache_TryAlloc (size_t size, qboolean nobottom);
#if 0
static void
check_cache (void)
{
cache_system_t *cs;
int used = hunk_tempactive ? hunk_tempmark : hunk_high_used;
for (cs = cache_head.prev; cs != &cache_head; cs = cs->prev)
if (cs->prev != &cache_head) {
if ((byte *) cs + cs->size != (byte *) cs->prev)
Sys_Error ("inconsistent cache %p %p %d %d", cs, cs->prev,
(int)cs->size,
(int) ((char *)cs->prev - (char *)cs));
if (hunk_size - ((byte*)cs - hunk_base) > used)
Sys_Error ("cache block out of high hunk");
}
if (cache_head.prev != &cache_head &&
hunk_size - ((byte*) cache_head.prev - hunk_base) != used)
Sys_Error ("cache bottom not at bottom of high hunk");
}
#endif
static void
Cache_Move (cache_system_t * c)
{
cache_system_t *new;
// we are clearing up space at the bottom, so allocate it late
new = Cache_TryAlloc (c->size, true);
if (new) {
Sys_MaskPrintf (SYS_dev, "cache_move ok\n");
memcpy (new + 1, c + 1, c->size - sizeof (cache_system_t));
new->user = c->user;
memcpy (new->name, c->name, sizeof (new->name));
Cache_Free (c->user);
new->user->data = (void *) (new + 1);
} else {
Sys_MaskPrintf (SYS_dev, "cache_move failed\n");
Cache_Free (c->user); // tough luck...
}
}
/*
Cache_FreeLow
Throw things out until the hunk can be expanded to the given point
*/
static void
Cache_FreeLow (int new_low_hunk)
{
cache_system_t *c;
while (1) {
c = cache_head.prev;
if (c == &cache_head)
return; // nothing in cache at all
if ((byte *) c >= hunk_base + new_low_hunk)
return; // there is space to grow the hunk
Sys_Error ("FIXME: Cache_FreeLow: not enough memory");
Cache_Move (c); // reclaim the space
}
}
static inline void
Cache_UnlinkLRU (cache_system_t * cs)
{
if (!cs->lru_next || !cs->lru_prev)
Sys_Error ("Cache_UnlinkLRU: NULL link: %.16s %p %p",
cs->name, cs->lru_next, cs->lru_prev);
cs->lru_next->lru_prev = cs->lru_prev;
cs->lru_prev->lru_next = cs->lru_next;
cs->lru_prev = cs->lru_next = NULL;
}
static void
Cache_MakeLRU (cache_system_t * cs)
{
if (cs->lru_next || cs->lru_prev)
Sys_Error ("Cache_MakeLRU: active link: %.16s %p %p",
cs->name, cs->lru_next, cs->lru_prev);
cache_head.lru_next->lru_prev = cs;
cs->lru_next = cache_head.lru_next;
cs->lru_prev = &cache_head;
cache_head.lru_next = cs;
}
static qboolean
Cache_FreeLRU (void)
{
cache_system_t *cs;
2002-08-25 04:47:57 +00:00
//check_cache ();
for (cs = cache_head.lru_prev;
cs != &cache_head && cs->readlock; cs = cs->lru_prev)
;
if (cs == &cache_head)
return 0;
Cache_Free (cs->user);
return 1;
}
static void
link_cache_system (cache_system_t *new, cache_system_t *cs)
{
new->next = cs;
new->prev = cs->prev;
cs->prev->next = new;
cs->prev = new;
}
/*
Cache_TryAlloc
Looks for a free block of memory between the high and low hunk marks
Size should already include the header and padding
*/
static cache_system_t *
Cache_TryAlloc (size_t size, qboolean nobottom)
{
cache_system_t *cs, *new;
//check_cache ();
// is the cache completely empty?
if (!nobottom && cache_head.prev == &cache_head) {
new = (cache_system_t *) Hunk_HighAlloc (size);
if (!new)
return 0;
memset (new, 0, size);
new->size = size;
cache_head.prev = cache_head.next = new;
new->prev = new->next = &cache_head;
Cache_MakeLRU (new);
//check_cache ();
return new;
}
// search for space in existing cache
for (cs = cache_head.next; cs != &cache_head; cs = cs->next) {
if (cs->user)
continue; // block isn't free
if (cs->size >= size) {
// found a big enough free block. If possible, carve it up for
// later reuse, using the upper portion of the block for the
// newly allocated block.
new = cs;
if (size - cs->size >= sizeof (cache_system_t)) {
new = (cache_system_t *) ((char *) cs + cs->size - size);
memset (new, 0, size);
new->size = size;
cs->size -= size;
link_cache_system (new, cs);
//check_cache ();
}
Cache_MakeLRU (new);
return new;
}
}
if (nobottom)
return 0;
// didn't find a free block, so make a new one.
new = Hunk_HighAlloc (size);
if (new) {
memset (new, 0, size);
new->size = size;
link_cache_system (new, &cache_head);
Cache_MakeLRU (new);
//check_cache ();
return new;
}
return 0; // couldn't allocate
}
static void
Cache_Profile (void)
{
cache_system_t *cs;
unsigned int i;
unsigned int items[31] = {0}, sizes[31] = {0};
int count = 0, total = 0;
cs = cache_head.next;
while (cs != &cache_head) {
for (i = 0; (cs->size >> (i + 1)) && i < 30; i++)
;
items[i]++;
sizes[i] += cs->size;
total += cs->size;
count++;
cs = cs->next;
}
Sys_Printf ("Cache Profile:\n");
Sys_Printf ("%8s %8s %8s %8s %8s\n",
"count", "min", "max", "average", "percent");
for (i = 0; i < 31; i++) {
if (!items[i])
continue;
Sys_Printf ("%8d %8d %8d %8d %7d%%\n",
items[i], 1 << i, (1 << (i + 1)) - 1,
sizes[i] / items[i],
(sizes[i] * 100) / total);
}
Sys_Printf ("Total allocations: %d in %d allocations, average of"
" %d per allocation\n", total, count,
count ? total / count : -1);
}
static void
Cache_Print (void)
{
cache_system_t *cd;
for (cd = cache_head.next; cd != &cache_head; cd = cd->next) {
Sys_Printf ("%8d : %.16s\n", (int) cd->size, cd->name);
}
}
static void
Cache_Init (void)
{
cache_head.next = cache_head.prev = &cache_head;
cache_head.lru_next = cache_head.lru_prev = &cache_head;
cache_head.user = (cache_user_t *) 1; // make it look allocated
cache_head.readlock = 1; // don't try to free or move it
2002-08-25 04:47:57 +00:00
Cmd_AddCommand ("cache_flush", Cache_Flush, "Clears the current game "
"cache");
2001-08-28 23:58:22 +00:00
Cmd_AddCommand ("cache_profile", Cache_Profile, "Prints a profile of "
"the current cache");
2002-08-25 04:47:57 +00:00
Cmd_AddCommand ("cache_print", Cache_Print, "Prints out items in the "
"cache");
}
/*
Cache_Flush
Throw everything out, so new data will be demand cached
*/
void
Cache_Flush (void)
{
// cache_head.prev is guaranteed to not be free because it's the bottom
// one and Cache_Free actually properly releases it
while (cache_head.prev != &cache_head) {
if (!cache_head.prev->user->data)
Sys_Error ("Cache_Flush: user/system out of sync for "
"'%.16s' with %d size",
cache_head.prev->name, (int) cache_head.prev->size);
Cache_Free (cache_head.prev->user); // reclaim the space
}
}
VISIBLE void *
Cache_Check (cache_user_t *c)
{
cache_system_t *cs;
if (!c->data)
return NULL;
cs = ((cache_system_t *) c->data) - 1;
// move to head of LRU
Cache_UnlinkLRU (cs);
Cache_MakeLRU (cs);
return c->data;
}
/*
Cache_Free
Frees the memory and removes it from the LRU list
*/
VISIBLE void
Cache_Free (cache_user_t *c)
{
cache_system_t *cs;
if (!c->data)
Sys_Error ("Cache_Free: not allocated");
cs = ((cache_system_t *) c->data) - 1;
if (cs->readlock)
Sys_Error ("Cache_Free: attempt to free locked block");
Sys_MaskPrintf (SYS_dev, "Cache_Free: freeing '%.16s' %p\n", cs->name, cs);
Cache_UnlinkLRU (cs);
//check_cache ();
cs->user = 0;
if (!cs->prev->user) {
cs->size += cs->prev->size;
cs->prev->prev->next = cs;
cs->prev = cs->prev->prev;
}
if (!cs->next->user) {
cs = cs->next;
cs->size += cs->prev->size;
cs->prev->prev->next = cs;
cs->prev = cs->prev->prev;
}
if (cs->next == &cache_head) {
cs->next->prev = cs->prev;
cs->prev->next = cs->next;
if (cs->prev != &cache_head)
Hunk_FreeToHighMark (hunk_size - ((byte*)cs->prev - hunk_base));
else
Hunk_FreeToHighMark (0);
}
//check_cache ();
c->data = NULL;
}
VISIBLE void *
2001-07-15 07:04:17 +00:00
Cache_Alloc (cache_user_t *c, int size, const char *name)
{
cache_system_t *cs;
if (c->data)
Sys_Error ("Cache_Alloc: already allocated");
if (size <= 0)
Sys_Error ("Cache_Alloc: size %i", size);
size = (size + sizeof (cache_system_t) + HUNK_ALIGN - 1) & ~(HUNK_ALIGN-1);
// find memory for it
while (1) {
cs = Cache_TryAlloc (size, false);
if (cs) {
strncpy (cs->name, name, sizeof (cs->name) - 1);
c->data = (void *) (cs + 1);
cs->user = c;
break;
}
// free the least recently used cachedat
if (!Cache_FreeLRU())
Sys_Error ("Cache_Alloc: out of memory");
}
return Cache_Check (c);
}
VISIBLE void
Cache_Report (void)
{
Sys_MaskPrintf (SYS_dev, "%4.1f megabyte data cache\n",
(hunk_size - hunk_high_used -
hunk_low_used) / (float) (1024 * 1024));
}
VISIBLE void
Cache_Add (cache_user_t *c, void *object, cache_loader_t loader)
{
if (c->data || c->object || c->loader)
Sys_Error ("Cache_Add: cache item already exists!");
c->object = object;
c->loader = loader;
// c->loader (c, Cache_Alloc); // for debugging
}
VISIBLE void
Cache_Remove (cache_user_t *c)
{
if (!c->object || !c->loader)
Sys_Error ("Cache_Remove: already removed!");
if (Cache_Check (c))
Cache_Free (c);
c->object = 0;
c->loader = 0;
}
VISIBLE void *
Cache_TryGet (cache_user_t *c)
{
void *mem;
2002-08-25 04:47:57 +00:00
mem = Cache_Check (c);
if (!mem) {
c->loader (c->object, Cache_Alloc);
mem = Cache_Check (c);
}
if (mem)
(((cache_system_t *)c->data) - 1)->readlock++;
return mem;
}
VISIBLE void *
Cache_Get (cache_user_t *c)
{
void *mem = Cache_TryGet (c);
2002-08-25 04:47:57 +00:00
if (!mem)
Sys_Error ("Cache_Get: couldn't get cache!");
return mem;
}
VISIBLE void
Cache_Release (cache_user_t *c)
{
int *readlock;
2002-08-25 04:47:57 +00:00
readlock = &(((cache_system_t *)c->data) - 1)->readlock;
if (!*readlock)
Sys_Error ("Cache_Release: already released!");
(*readlock)--;
// if (!*readlock)
// Cache_Free (c); // for debugging
}
2007-03-23 14:22:59 +00:00
VISIBLE int
2007-03-23 12:36:55 +00:00
Cache_ReadLock (cache_user_t *c)
{
return (((cache_system_t *)c->data) - 1)->readlock;
}
//============================================================================
VISIBLE void
Memory_Init (void *buf, int size)
{
hunk_base = buf;
hunk_size = size;
hunk_low_used = 0;
hunk_high_used = 0;
Cache_Init ();
}