mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-10-06 01:46:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added support for clang thread-safety analysis

Browse Source 
The annotations have been added to SDL_mutex.h and have been made public so applications can enable this for their own code.

Clang assumes that locking and unlocking can't fail, but SDL has the concept of a NULL mutex, so the mutex functions have been changed not to report errors if a mutex hasn't been initialized. We do have mutexes that might be accessed when they are NULL, notably in the event system, so this is an important change.

This commit cleans up a bunch of rare race conditions in the joystick and game controller code so now everything should be completely protected by the joystick lock.

To test this, change the compiler to "clang -Wthread-safety -Werror=thread-safety -DSDL_THREAD_SAFETY_ANALYSIS"
This commit is contained in:
Sam Lantinga
2022-12-13 14:03:40 -08:00
parent 02493579b5
commit 5c29b58e95
41 changed files with 1618 additions and 1134 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
src/joystick/SDL_sysjoystick.h
View File

@@ -65,61 +65,65 @@ typedef struct _SDL_JoystickSensorInfo
float data[3]; /* If this needs to expand, update SDL_ControllerSensorEvent */
} SDL_JoystickSensorInfo;
#define _guarded SDL_GUARDED_BY(SDL_joystick_lock)
struct _SDL_Joystick
{
const void *magic;
const void *magic _guarded;
SDL_JoystickID instance_id; /* Device instance, monotonically increasing from 0 */
char *name; /* Joystick name - system dependent */
char *path; /* Joystick path - system dependent */
char *serial; /* Joystick serial */
SDL_JoystickGUID guid; /* Joystick guid */
Uint16 firmware_version; /* Firmware version, if available */
SDL_JoystickID instance_id _guarded; /* Device instance, monotonically increasing from 0 */
char *name _guarded; /* Joystick name - system dependent */
char *path _guarded; /* Joystick path - system dependent */
char *serial _guarded; /* Joystick serial */
SDL_JoystickGUID guid _guarded; /* Joystick guid */
Uint16 firmware_version _guarded; /* Firmware version, if available */
int naxes; /* Number of axis controls on the joystick */
SDL_JoystickAxisInfo *axes;
int naxes _guarded; /* Number of axis controls on the joystick */
SDL_JoystickAxisInfo *axes _guarded;
int nhats; /* Number of hats on the joystick */
Uint8 *hats; /* Current hat states */
int nhats _guarded; /* Number of hats on the joystick */
Uint8 *hats _guarded; /* Current hat states */
int nbuttons; /* Number of buttons on the joystick */
Uint8 *buttons; /* Current button states */
int nbuttons _guarded; /* Number of buttons on the joystick */
Uint8 *buttons _guarded; /* Current button states */
int ntouchpads; /* Number of touchpads on the joystick */
SDL_JoystickTouchpadInfo *touchpads; /* Current touchpad states */
int ntouchpads _guarded; /* Number of touchpads on the joystick */
SDL_JoystickTouchpadInfo *touchpads _guarded; /* Current touchpad states */
int nsensors; /* Number of sensors on the joystick */
int nsensors_enabled;
SDL_JoystickSensorInfo *sensors;
int nsensors _guarded; /* Number of sensors on the joystick */
int nsensors_enabled _guarded;
SDL_JoystickSensorInfo *sensors _guarded;
Uint16 low_frequency_rumble;
Uint16 high_frequency_rumble;
Uint64 rumble_expiration;
Uint64 rumble_resend;
Uint16 low_frequency_rumble _guarded;
Uint16 high_frequency_rumble _guarded;
Uint64 rumble_expiration _guarded;
Uint64 rumble_resend _guarded;
Uint16 left_trigger_rumble;
Uint16 right_trigger_rumble;
Uint64 trigger_rumble_expiration;
Uint16 left_trigger_rumble _guarded;
Uint16 right_trigger_rumble _guarded;
Uint64 trigger_rumble_expiration _guarded;
Uint8 led_red;
Uint8 led_green;
Uint8 led_blue;
Uint64 led_expiration;
Uint8 led_red _guarded;
Uint8 led_green _guarded;
Uint8 led_blue _guarded;
Uint64 led_expiration _guarded;
SDL_bool attached;
SDL_bool is_game_controller;
SDL_bool delayed_guide_button; /* SDL_TRUE if this device has the guide button event delayed */
SDL_JoystickPowerLevel epowerlevel; /* power level of this joystick, SDL_JOYSTICK_POWER_UNKNOWN if not supported */
SDL_bool attached _guarded;
SDL_bool is_game_controller _guarded;
SDL_bool delayed_guide_button _guarded; /* SDL_TRUE if this device has the guide button event delayed */
SDL_JoystickPowerLevel epowerlevel _guarded; /* power level of this joystick, SDL_JOYSTICK_POWER_UNKNOWN if not supported */
struct _SDL_JoystickDriver *driver;
struct _SDL_JoystickDriver *driver _guarded;
struct joystick_hwdata *hwdata; /* Driver dependent information */
struct joystick_hwdata *hwdata _guarded; /* Driver dependent information */
int ref_count; /* Reference count for multiple opens */
int ref_count _guarded; /* Reference count for multiple opens */
struct _SDL_Joystick *next; /* pointer to next joystick we have allocated */
struct _SDL_Joystick *next _guarded; /* pointer to next joystick we have allocated */
};
#undef _guarded
/* Device bus definitions */
#define SDL_HARDWARE_BUS_UNKNOWN 0x00
#define SDL_HARDWARE_BUS_USB 0x03