Improved handling of function parameter validation

SDL supports the following use cases:
 * Normal operation with fast parameter checks (default):
    SDL_SetHint(SDL_HINT_INVALID_PARAM_CHECKS, "1");
 * Object parameters are checked for use-after-free issues:
    SDL_SetHint(SDL_HINT_INVALID_PARAM_CHECKS, "2");
 * Enable full validation, plus assert on invalid parameters:
    #define SDL_ASSERT_INVALID_PARAMS
 * Disable all parameter validation:
    #define SDL_DISABLE_INVALID_PARAMS
This commit is contained in:
Sam Lantinga
2025-09-16 18:23:06 -07:00
parent 49e15904ae
commit ee1c90a358
4 changed files with 592 additions and 353 deletions

View File

@@ -137,6 +137,32 @@ Uint32 SDL_GetNextObjectID(void)
static SDL_InitState SDL_objects_init;
static SDL_HashTable *SDL_objects;
static bool SDL_object_validation;
static void SDLCALL SDL_InvalidParamChecksChanged(void *userdata, const char *name, const char *oldValue, const char *hint)
{
bool validation_enabled = false;
#ifdef SDL_ASSERT_INVALID_PARAMS
// Full validation is enabled by default
validation_enabled = true;
#endif
if (hint) {
switch (*hint) {
case '0':
case '1':
validation_enabled = false;
break;
case '2':
validation_enabled = true;
break;
default:
break;
}
}
SDL_object_validation = validation_enabled;
}
static Uint32 SDLCALL SDL_HashObject(void *unused, const void *key)
{
@@ -159,6 +185,7 @@ void SDL_SetObjectValid(void *object, SDL_ObjectType type, bool valid)
if (!initialized) {
return;
}
SDL_AddHintCallback(SDL_HINT_INVALID_PARAM_CHECKS, SDL_InvalidParamChecksChanged, NULL);
}
if (valid) {
@@ -174,6 +201,10 @@ bool SDL_ObjectValid(void *object, SDL_ObjectType type)
return false;
}
if (!SDL_object_validation) {
return true;
}
const void *object_type;
if (!SDL_FindInHashTable(SDL_objects, object, &object_type)) {
return false;
@@ -242,6 +273,7 @@ void SDL_SetObjectsInvalid(void)
SDL_DestroyHashTable(SDL_objects);
SDL_objects = NULL;
SDL_SetInitialized(&SDL_objects_init, false);
SDL_RemoveHintCallback(SDL_HINT_INVALID_PARAM_CHECKS, SDL_InvalidParamChecksChanged, NULL);
}
}