mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-09-29 22:48:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

hashtable: Redesign the hashtable API.

Browse Source 
This was intended to make the API public, so SDL_hashtable.h got an extreme
documentation makeover, but for now this remains a private header.

This makes several significant interface changes to SDL_HashTable, and
improves code that makes use of it in various ways.

- The ability to make "stackable" tables is removed. Apparently this still
  worked with the current implementation, but I could see a future
  implementation struggle mightily to support this. It'll be better for
  something external to build on top of the table if it needs it, inserting a
  linked list of stacked items as the hash values and managing them separately.
  There was only one place in SDL using this, unnecessarily, and that has also
  been cleaned up to not need it.
- You no longer specify "buckets" when creating a table, but rather an
  estimated number of items the table is meant to hold. The bucket count was
  crucial to our classic hashtable implementation, but meant less once we
  moved to an Open Addressing implementation anyhow, since the bucket count
  isn't static (and they aren't really "buckets" anymore either). Now you
  can just report how many items you think the hash will hold and SDL will
  allocate a reasonable default for you...or 0 to not guess, and SDL will
  start small and grow as necessary, which is often the correct thing to do.
- There's no more SDL_IterateHashTableKey because there's no more "stackable"
  hash tables.
- SDL_IterateHashTable() now uses a callback, which matches other parts of SDL,
  and also lets us hold the read-lock for the entire iteration and get rid of
  the goofy iterator state variable.
- SDL_InsertIntoHashTable() now lets you specify whether to replace existing
  keys or fail if the key already exists.
- Callbacks now use SDL conventions (userdata as the first param).
- Other naming convention fixes.

I discovered we use a lot of hash tables in SDL3 internally. :) So the bulk
of this work is fixing up that code to use the new interfaces, and simplifying
things (like checking for an item to remove it if it already exists before
inserting a replacement...just do the insert atomically, it'll do all that
for you!).
This commit is contained in:
Ryan C. Gordon
2025-02-13 16:13:43 -05:00
parent 4a9b579195
commit 84a236c92e
13 changed files with 1344 additions and 866 deletions
Download Patch File Download Diff File Expand all files Collapse all files

125
src/SDL_utils.c
View File

@@ -135,12 +135,12 @@ Uint32 SDL_GetNextObjectID(void)
static SDL_InitState SDL_objects_init;
static SDL_HashTable *SDL_objects;
static Uint32 SDL_HashObject(const void *key, void *unused)
static Uint32 SDLCALL SDL_HashObject(void *unused, const void *key)
{
return (Uint32)(uintptr_t)key;
}
static bool SDL_KeyMatchObject(const void *a, const void *b, void *unused)
static bool SDL_KeyMatchObject(void *unused, const void *a, const void *b)
{
return (a == b);
}
@@ -149,16 +149,17 @@ void SDL_SetObjectValid(void *object, SDL_ObjectType type, bool valid)
{
SDL_assert(object != NULL);
if (valid && SDL_ShouldInit(&SDL_objects_init)) {
SDL_objects = SDL_CreateHashTable(NULL, 32, SDL_HashObject, SDL_KeyMatchObject, NULL, true, false);
if (!SDL_objects) {
SDL_SetInitialized(&SDL_objects_init, false);
if (SDL_ShouldInit(&SDL_objects_init)) {
SDL_objects = SDL_CreateHashTable(0, true, SDL_HashObject, SDL_KeyMatchObject, NULL, NULL);
const bool initialized = (SDL_objects != NULL);
SDL_SetInitialized(&SDL_objects_init, initialized);
if (!initialized) {
return;
}
SDL_SetInitialized(&SDL_objects_init, true);
}
if (valid) {
SDL_InsertIntoHashTable(SDL_objects, object, (void *)(uintptr_t)type);
SDL_InsertIntoHashTable(SDL_objects, object, (void *)(uintptr_t)type, true);
} else {
SDL_RemoveFromHashTable(SDL_objects, object);
}
@@ -178,75 +179,65 @@ bool SDL_ObjectValid(void *object, SDL_ObjectType type)
return (((SDL_ObjectType)(uintptr_t)object_type) == type);
}
typedef struct GetOneObjectData
{
const SDL_ObjectType type;
void **objects;
const int count;
int num_objects;
} GetOneObjectData;
static bool SDLCALL GetOneObject(void *userdata, const SDL_HashTable *table, const void *object, const void *object_type)
{
GetOneObjectData *data = (GetOneObjectData *) userdata;
if ((SDL_ObjectType)(uintptr_t)object_type == data->type) {
if (data->num_objects < data->count) {
data->objects[data->num_objects] = (void *)object;
}
++data->num_objects;
}
return true; // keep iterating.
}
int SDL_GetObjects(SDL_ObjectType type, void **objects, int count)
{
const void *object, *object_type;
void *iter = NULL;
int num_objects = 0;
while (SDL_IterateHashTable(SDL_objects, &object, &object_type, &iter)) {
if ((SDL_ObjectType)(uintptr_t)object_type == type) {
if (num_objects < count) {
objects[num_objects] = (void *)object;
}
++num_objects;
}
GetOneObjectData data = { type, objects, count, 0 };
SDL_IterateHashTable(SDL_objects, GetOneObject, &data);
return data.num_objects;
}
static bool SDLCALL LogOneLeakedObject(void *userdata, const SDL_HashTable *table, const void *object, const void *object_type)
{
const char *type = "unknown object";
switch ((SDL_ObjectType)(uintptr_t)object_type) {
#define SDLOBJTYPECASE(typ, name) case SDL_OBJECT_TYPE_##typ: type = name; break
SDLOBJTYPECASE(WINDOW, "SDL_Window");
SDLOBJTYPECASE(RENDERER, "SDL_Renderer");
SDLOBJTYPECASE(TEXTURE, "SDL_Texture");
SDLOBJTYPECASE(JOYSTICK, "SDL_Joystick");
SDLOBJTYPECASE(GAMEPAD, "SDL_Gamepad");
SDLOBJTYPECASE(HAPTIC, "SDL_Haptic");
SDLOBJTYPECASE(SENSOR, "SDL_Sensor");
SDLOBJTYPECASE(HIDAPI_DEVICE, "hidapi device");
SDLOBJTYPECASE(HIDAPI_JOYSTICK, "hidapi joystick");
SDLOBJTYPECASE(THREAD, "thread");
SDLOBJTYPECASE(TRAY, "SDL_Tray");
#undef SDLOBJTYPECASE
default: break;
}
return num_objects;
SDL_Log("Leaked %s (%p)", type, object);
return true; // keep iterating.
}
void SDL_SetObjectsInvalid(void)
{
if (SDL_ShouldQuit(&SDL_objects_init)) {
// Log any leaked objects
const void *object, *object_type;
void *iter = NULL;
while (SDL_IterateHashTable(SDL_objects, &object, &object_type, &iter)) {
const char *type;
switch ((SDL_ObjectType)(uintptr_t)object_type) {
case SDL_OBJECT_TYPE_WINDOW:
type = "SDL_Window";
break;
case SDL_OBJECT_TYPE_RENDERER:
type = "SDL_Renderer";
break;
case SDL_OBJECT_TYPE_TEXTURE:
type = "SDL_Texture";
break;
case SDL_OBJECT_TYPE_JOYSTICK:
type = "SDL_Joystick";
break;
case SDL_OBJECT_TYPE_GAMEPAD:
type = "SDL_Gamepad";
break;
case SDL_OBJECT_TYPE_HAPTIC:
type = "SDL_Haptic";
break;
case SDL_OBJECT_TYPE_SENSOR:
type = "SDL_Sensor";
break;
case SDL_OBJECT_TYPE_HIDAPI_DEVICE:
type = "hidapi device";
break;
case SDL_OBJECT_TYPE_HIDAPI_JOYSTICK:
type = "hidapi joystick";
break;
case SDL_OBJECT_TYPE_THREAD:
type = "thread";
break;
case SDL_OBJECT_TYPE_TRAY:
type = "SDL_Tray";
break;
default:
type = "unknown object";
break;
}
SDL_Log("Leaked %s (%p)", type, object);
}
SDL_IterateHashTable(SDL_objects, LogOneLeakedObject, NULL);
SDL_assert(SDL_HashTableEmpty(SDL_objects));
SDL_DestroyHashTable(SDL_objects);
SDL_objects = NULL;
SDL_SetInitialized(&SDL_objects_init, false);
}
}
@@ -384,7 +375,7 @@ const char *SDL_GetPersistentString(const char *string)
SDL_HashTable *strings = (SDL_HashTable *)SDL_GetTLS(&SDL_string_storage);
if (!strings) {
strings = SDL_CreateHashTable(NULL, 32, SDL_HashString, SDL_KeyMatchString, SDL_NukeFreeValue, false, false);
strings = SDL_CreateHashTable(0, false, SDL_HashString, SDL_KeyMatchString, SDL_DestroyHashValue, NULL);
if (!strings) {
return NULL;
}
@@ -400,7 +391,7 @@ const char *SDL_GetPersistentString(const char *string)
}
// If the hash table insert fails, at least we can return the string we allocated
SDL_InsertIntoHashTable(strings, new_string, new_string);
SDL_InsertIntoHashTable(strings, new_string, new_string, false);
result = new_string;
}
return result;