-util: Retire legacy object pool, removing vestigial references.

Thanks to AJR, Ivan Vangelista and Aaron Giles for helping make this
possible.

Also fixed debug build of imgtool.
This commit is contained in:
Vas Crabb 2021-06-24 23:12:27 +10:00
parent 3a0f72424c
commit 50da25ae5b
7 changed files with 4 additions and 755 deletions

View File

@ -91,8 +91,6 @@ project "utils"
MAME_DIR .. "src/lib/util/plaparse.h",
MAME_DIR .. "src/lib/util/png.cpp",
MAME_DIR .. "src/lib/util/png.h",
MAME_DIR .. "src/lib/util/pool.cpp",
MAME_DIR .. "src/lib/util/pool.h",
MAME_DIR .. "src/lib/util/server_http.hpp",
MAME_DIR .. "src/lib/util/server_https.hpp",
MAME_DIR .. "src/lib/util/server_ws.hpp",

View File

@ -15,7 +15,6 @@
#include "emuopts.h"
#include "hash.h"
#include "pool.h"
#include <pugixml.hpp>

View File

@ -14,11 +14,11 @@
* Edited and translated to English by Kenji RIKITAKE
*/
#include <cstring>
#include <cassert>
#include "pool.h"
#include "flopimg.h"
#include <cassert>
#include <cstring>
#define BUFSZ 512 // new input buffer
/* LZSS Parameters */
@ -107,10 +107,6 @@ struct floppy_image_legacy
void *loaded_track_data;
uint8_t loaded_track_status;
uint8_t flags;
/* tagging system */
object_pool *tags;
void *tag_data;
};

View File

@ -9,7 +9,6 @@
**********************************************************************/
#include "thom_cas.h"
#include "pool.h"
#include <cassert>
#include <cmath>

View File

@ -1,624 +0,0 @@
// license:BSD-3-Clause
// copyright-holders:Aaron Giles
/***************************************************************************
pool.c
Resource pool code
***************************************************************************/
#include "pool.h"
#include "coreutil.h"
#include "osdcomm.h"
#include <cstdarg>
#include <cstdlib>
#include <iterator>
/***************************************************************************
CONSTANTS
***************************************************************************/
#define OBJECT_ENTRY_BLOCK 256
#define POOL_HASH_SIZE 3797
/***************************************************************************
TYPE DEFINITIONS
***************************************************************************/
/* an object type entry */
struct objtype_entry
{
objtype_entry * next;
uint32_t type;
const char * friendly;
void (*destructor)(void *, size_t);
};
/* an entry in a pool */
struct object_entry
{
object_entry * next;
object_entry * globalnext;
object_entry * globalprev;
objtype_entry * type;
void * object;
size_t size;
const char * file;
int line;
};
/* a block of entry items */
struct object_entry_block
{
object_entry_block *next;
object_entry entry[OBJECT_ENTRY_BLOCK];
};
/* the object pool itself */
struct object_pool
{
object_entry * hashtable[POOL_HASH_SIZE];
object_entry * globallist;
object_entry * freelist;
object_entry_block *blocklist;
objtype_entry * typelist;
void (*fail)(const char *message);
};
/* an iterator over objects in a pool */
struct object_pool_iterator
{
object_pool * pool;
object_type type;
object_entry * last;
};
/***************************************************************************
FUNCTION PROTOTYPES
***************************************************************************/
static void memory_destruct(void *object, size_t size);
static void report_failure(object_pool *pool, const char *format, ...) ATTR_PRINTF(2,3);
/***************************************************************************
INLINE FUNCTIONS
***************************************************************************/
/*-------------------------------------------------
hash_object - compute the hash for a given
object
-------------------------------------------------*/
static inline int hash_object(void *object)
{
return ((size_t)object >> 4) % POOL_HASH_SIZE;
}
/*-------------------------------------------------
get_object_type - return the type entry for
a given object type
-------------------------------------------------*/
static inline objtype_entry *get_object_type(object_pool *pool, object_type type)
{
objtype_entry *entry;
for (entry = pool->typelist; entry != nullptr; entry = entry->next)
if (entry->type == type)
return entry;
return nullptr;
}
/***************************************************************************
RESOURCE POOL MANAGEMENT
***************************************************************************/
/*-------------------------------------------------
pool_alloc - allocates a new memory pool
-------------------------------------------------*/
object_pool *pool_alloc_lib(void (*fail)(const char *message))
{
object_pool *pool;
/* allocate memory for the pool itself */
pool = (object_pool *)malloc(sizeof(*pool));
if (pool == nullptr)
return nullptr;
memset(pool, 0, sizeof(*pool));
/* set the failure handler */
pool->fail = fail;
/* register the built-in types */
pool_type_register(pool, OBJTYPE_MEMORY, "Memory", memory_destruct);
return pool;
}
/*-------------------------------------------------
pool_type_register - register a new pool
type
-------------------------------------------------*/
void pool_type_register(object_pool *pool, object_type type, const char *friendly, void (*destructor)(void *, size_t))
{
objtype_entry *newtype = get_object_type(pool, type);
/* if the type doesn't already exist... */
if (newtype == nullptr)
{
/* allocate a new entry */
newtype = (objtype_entry *)malloc(sizeof(*newtype));
if (newtype == nullptr)
{
report_failure(pool, "Error adding new type %s\n", friendly);
return;
}
memset(newtype, 0, sizeof(*newtype));
/* link us in */
newtype->next = pool->typelist;
pool->typelist = newtype;
}
/* fill in the type information */
newtype->type = type;
newtype->friendly = friendly;
newtype->destructor = destructor;
}
/*-------------------------------------------------
pool_clear - frees all contained memory blocks
in a pool
-------------------------------------------------*/
void pool_clear(object_pool *pool)
{
object_entry *entry, *next;
/* iterate over all entries in the global list and free them */
for (entry = pool->globallist; entry != nullptr; entry = next)
{
/* remember the next entry */
next = entry->globalnext;
/* call the destructor */
(*entry->type->destructor)(entry->object, entry->size);
/* add ourself to the free list */
entry->next = pool->freelist;
entry->globalnext = entry->globalprev = nullptr;
pool->freelist = entry;
}
/* zap the hashtable */
memset(pool->hashtable, 0, sizeof(pool->hashtable));
}
/*-------------------------------------------------
pool_free_lib - frees a memory pool and all
contained memory blocks
-------------------------------------------------*/
void pool_free_lib(object_pool *pool)
{
object_entry_block *block, *nextblock;
objtype_entry *type, *nexttype;
/* clear the pool */
pool_clear(pool);
/* free all entry blocks */
for (block = pool->blocklist; block != nullptr; block = nextblock)
{
nextblock = block->next;
free(block);
}
/* free all types */
for (type = pool->typelist; type != nullptr; type = nexttype)
{
nexttype = type->next;
free(type);
}
/* free the pool itself */
free(pool);
}
/***************************************************************************
OBJECT MANAGEMENT
***************************************************************************/
/*-------------------------------------------------
pool_object_add_file_line - add an object to
the resource pool
-------------------------------------------------*/
void *pool_object_add_file_line(object_pool *pool, object_type _type, void *object, size_t size, const char *file, int line)
{
objtype_entry *type = get_object_type(pool, _type);
int hashnum = hash_object(object);
object_entry *entry;
/* if we have an invalid type, fail */
if (type == nullptr)
{
report_failure(pool, "pool_object_add (via %s:%d): Attempted to add object of unknown type with size %d", file, line, (int)size);
return object;
}
/* if we get a nullptr object, fail */
if (object == nullptr)
{
report_failure(pool, "pool_object_add (via %s:%d): Attempted to add a nullptr object of size %d", file, line, (int)size);
return object;
}
/* allocate a new entry */
if (pool->freelist == nullptr)
{
object_entry_block *block;
int entrynum;
/* if we need a new block, allocate that now */
block = (object_entry_block *)malloc(sizeof(*block));
if (block == nullptr)
return nullptr;
memset(block, 0, sizeof(*block));
/* hook us into the blocklist */
block->next = pool->blocklist;
pool->blocklist = block;
/* add all entries to the free list */
for (entrynum = 0; entrynum < std::size(block->entry); entrynum++)
{
block->entry[entrynum].next = pool->freelist;
pool->freelist = &block->entry[entrynum];
}
}
/* remove the head of the freelist */
entry = pool->freelist;
pool->freelist = entry->next;
/* fill in the entry */
entry->type = type;
entry->object = object;
entry->size = size;
entry->file = file;
entry->line = line;
/* hook us into the global list */
if (pool->globallist != nullptr)
pool->globallist->globalprev = entry;
entry->globalprev = nullptr;
entry->globalnext = pool->globallist;
pool->globallist = entry;
/* hook up to the appropriate hash table */
entry->next = pool->hashtable[hashnum];
pool->hashtable[hashnum] = entry;
return object;
}
/*-------------------------------------------------
pool_object_remove - remove an entry from a
pool, optionally calling its destructor
-------------------------------------------------*/
void *pool_object_remove(object_pool *pool, void *object, int destruct)
{
int hashnum = hash_object(object);
object_entry **entryptr;
/* find the object in question and remove it */
for (entryptr = &pool->hashtable[hashnum]; *entryptr != nullptr; entryptr = &(*entryptr)->next)
if ((*entryptr)->object == object)
{
object_entry *entry = *entryptr;
/* call the destructor */
if (destruct)
(*entry->type->destructor)(entry->object, entry->size);
/* remove us from the global list */
if (entry->globalprev != nullptr)
entry->globalprev->globalnext = entry->globalnext;
if (entry->globalnext != nullptr)
entry->globalnext->globalprev = entry->globalprev;
if (pool->globallist == entry)
pool->globallist = entry->globalnext;
/* remove us from the list */
*entryptr = entry->next;
/* add us to the free list */
entry->next = pool->freelist;
pool->freelist = entry;
break;
}
return nullptr;
}
/*-------------------------------------------------
pool_object_exists - return true if an
object exists in the pool
-------------------------------------------------*/
bool pool_object_exists(object_pool *pool, object_type type, void *object)
{
int hashnum = hash_object(object);
object_entry *entry;
/* find the object in question */
for (entry = pool->hashtable[hashnum]; entry != nullptr; entry = entry->next)
if (entry->object == object && (type == OBJTYPE_WILDCARD || entry->type->type == type))
return true;
return false;
}
/***************************************************************************
OBJECT ITERATORS
***************************************************************************/
/*-------------------------------------------------
pool_iterate_begin - begin iterating over
objects in an object pool
-------------------------------------------------*/
object_pool_iterator *pool_iterate_begin(object_pool *pool, object_type type)
{
object_pool_iterator *iter;
/* allocate the iterator */
iter = (object_pool_iterator *)malloc(sizeof(*iter));
if (iter == nullptr)
return nullptr;
memset(iter, 0, sizeof(*iter));
/* fill it in */
iter->pool = pool;
iter->type = type;
iter->last = nullptr;
return iter;
}
/*-------------------------------------------------
pool_iterate_next - get the next object in the
object pool
-------------------------------------------------*/
bool pool_iterate_next(object_pool_iterator *iter, void **objectptr, size_t *sizeptr, object_type *typeptr)
{
/* if no previous entry, find the first */
if (iter->last == nullptr)
iter->last = iter->pool->globallist;
else
iter->last = iter->last->globalnext;
/* stop when we get one */
if (iter->last != nullptr)
{
if (objectptr != nullptr)
*objectptr = iter->last;
if (sizeptr != nullptr)
*sizeptr = iter->last->size;
if (typeptr != nullptr)
*typeptr = iter->last->type->type;
return true;
}
/* nothing left */
return false;
}
/*-------------------------------------------------
pool_iterate_end - finish iterating over
objects in an object pool
-------------------------------------------------*/
void pool_iterate_end(object_pool_iterator *iter)
{
free(iter);
}
/***************************************************************************
MEMORY HELPERS
***************************************************************************/
/*-------------------------------------------------
pool_malloc_file_line - allocates memory in a
memory pool
-------------------------------------------------*/
void *pool_malloc_file_line(object_pool *pool, size_t size, const char *file, int line)
{
void *ptr = malloc(size);
return pool_object_add_file_line(pool, OBJTYPE_MEMORY, ptr, size, file, line);
}
/*-------------------------------------------------
pool_realloc_file_line - reallocs memory in a
memory pool
-------------------------------------------------*/
void *pool_realloc_file_line(object_pool *pool, void *ptr, size_t size, const char *file, int line)
{
if (ptr != nullptr)
pool_object_remove(pool, ptr, false);
ptr = realloc(ptr, size);
if (size != 0)
pool_object_add_file_line(pool, OBJTYPE_MEMORY, ptr, size, file, line);
return ptr;
}
/*-------------------------------------------------
pool_strdup_file_line - strdup in a memory
pool
-------------------------------------------------*/
char *pool_strdup_file_line(object_pool *pool, const char *str, const char *file, int line)
{
char *ptr = (char *)pool_malloc_file_line(pool, strlen(str) + 1, file, line);
if (ptr != nullptr)
strcpy(ptr, str);
return ptr;
}
/***************************************************************************
GENERIC DESTRUCTORS
***************************************************************************/
/*-------------------------------------------------
memory_destruct - generic destructor
that just does a free() on the object
-------------------------------------------------*/
static void memory_destruct(void *object, size_t size)
{
free(object);
}
/***************************************************************************
INTERNAL FUNCTIONS
***************************************************************************/
/*-------------------------------------------------
report_failure - report a failure to the
failure callback
-------------------------------------------------*/
static void report_failure(object_pool *pool, const char *format, ...)
{
/* only do the work if we have a callback */
if (pool->fail != nullptr)
{
char message[1024];
va_list argptr;
/* generate the final message text */
va_start(argptr, format);
vsprintf(message, format, argptr);
va_end(argptr);
/* call the callback with the message */
(*pool->fail)(message);
}
}
/***************************************************************************
TESTING FUNCTIONS
***************************************************************************/
static bool has_memory_error;
/*-------------------------------------------------
memory_error - report a memory error
-------------------------------------------------*/
static void memory_error(const char *message)
{
printf("memory test failure: %s\n", message);
has_memory_error = true;
}
/*-------------------------------------------------
test_memory_pools - unit tests for memory
pool behavior
-------------------------------------------------*/
/**
* @fn int test_memory_pools(void)
*
* @brief Tests memory pools.
*
* @return An int.
*/
bool test_memory_pools()
{
object_pool *pool;
void *ptrs[16];
int i;
has_memory_error = false;
pool = pool_alloc_lib(memory_error);
memset(ptrs, 0, sizeof(ptrs));
ptrs[0] = pool_malloc_lib(pool, 50);
ptrs[1] = pool_malloc_lib(pool, 100);
ptrs[0] = pool_realloc_lib(pool, ptrs[0], 150);
ptrs[1] = pool_realloc_lib(pool, ptrs[1], 200);
ptrs[2] = pool_malloc_lib(pool, 250);
ptrs[3] = pool_malloc_lib(pool, 300);
ptrs[0] = pool_realloc_lib(pool, ptrs[0], 350);
ptrs[1] = pool_realloc_lib(pool, ptrs[1], 400);
ptrs[2] = pool_realloc_lib(pool, ptrs[2], 450);
ptrs[3] = pool_realloc_lib(pool, ptrs[3], 500);
ptrs[0] = pool_realloc_lib(pool, ptrs[0], 0);
ptrs[1] = pool_realloc_lib(pool, ptrs[1], 0);
ptrs[2] = pool_realloc_lib(pool, ptrs[2], 550);
ptrs[3] = pool_realloc_lib(pool, ptrs[3], 600);
/* some heavier stress tests */
for (i = 0; i < 512; i++)
{
ptrs[i % std::size(ptrs)] = pool_realloc_lib(pool,
ptrs[i % std::size(ptrs)], rand() % 1000);
}
pool_free_lib(pool);
return has_memory_error;
}

View File

@ -1,119 +0,0 @@
// license:BSD-3-Clause
// copyright-holders:Aaron Giles
/***************************************************************************
pool.h
Abstract object pool management
***************************************************************************/
#ifndef MAME_UTIL_POOL_H
#define MAME_UTIL_POOL_H
#pragma once
#include <cstddef>
#include <cstdint>
/***************************************************************************
MACROS
***************************************************************************/
/* helper macros for memory pools that pass file/line number */
#define pool_malloc_lib(pool, size) pool_malloc_file_line((pool), (size), __FILE__, __LINE__)
#define pool_realloc_lib(pool, ptr, size) pool_realloc_file_line((pool), (ptr), (size), __FILE__, __LINE__)
#define pool_strdup_lib(pool, size) pool_strdup_file_line((pool), (size), __FILE__, __LINE__)
/* macro to define a 4-character type for a pool */
#define OBJECT_TYPE(a,b,c,d) (((a) << 24) | ((b) << 16) | ((c) << 8) | (d))
/* built-in pool types */
#define OBJTYPE_WILDCARD (0)
#define OBJTYPE_MEMORY OBJECT_TYPE('m','e','m','o')
/***************************************************************************
TYPE DEFINITIONS
***************************************************************************/
/* pool types are UINT32s */
typedef uint32_t object_type;
/* opaque type representing a pool of objects */
struct object_pool;
/* opaque type representing an iterator over pool objects */
struct object_pool_iterator;
/***************************************************************************
PROTOTYPES
***************************************************************************/
/* ----- object pool management ----- */
/* allocate a new object pool */
object_pool *pool_alloc_lib(void (*fail)(const char *message));
/* register a new object type; returns true if the type already existed and was overridden */
void pool_type_register(object_pool *pool, object_type type, const char *friendly, void (*destructor)(void *, size_t));
/* free all allocated objects in a pool */
void pool_clear(object_pool *pool);
/* free an object pool, including all allocated objects */
void pool_free_lib(object_pool *pool);
/* ----- object management ----- */
/* add an object to the pool, along with its filename/line number */
void *pool_object_add_file_line(object_pool *pool, object_type type, void *object, size_t size, const char *file, int line);
/* remove an object from the pool (optionally calling destructor) */
void *pool_object_remove(object_pool *pool, void *object, int destruct);
/* does an object exist in the pool? */
bool pool_object_exists(object_pool *pool, object_type type, void *object);
/* ----- object iterators ----- */
/* begin iterating over objects in an object pool */
object_pool_iterator *pool_iterate_begin(object_pool *pool, object_type type);
/* get the next object in the object pool */
bool pool_iterate_next(object_pool_iterator *iter, void **objectptr, size_t *sizeptr, object_type *typeptr);
/* finish iterating over objects in an object pool */
void pool_iterate_end(object_pool_iterator *iter);
/* ----- memory helpers ----- */
/* malloc memory and register it with the given pool */
void *pool_malloc_file_line(object_pool *pool, size_t size, const char *file, int line);
/* realloc memory and register it with the given pool */
void *pool_realloc_file_line(object_pool *pool, void *ptr, size_t size, const char *file, int line);
/* strdup memory and register it with the given pool */
char *pool_strdup_file_line(object_pool *pool, const char *str, const char *file, int line);
/* ----- miscellaneous ----- */
/* internal unit tests */
bool test_memory_pools(void);
#endif // MAME_UTIL_POOL_H

View File

@ -139,7 +139,7 @@ static imgtoolerr_t markerrorsource(imgtoolerr_t err)
static void internal_error(const imgtool_module *module, const char *message)
{
#ifdef MAME_DEBUG
printf("%s: %s\n", module->name, message);
printf("%s: %s\n", module->name.c_str(), message);
#endif
}