mirrors/monado
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/monado/monado.git synced 2025-01-01 04:36:07 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

a/os: Add more docs for correct use of condition variables

Browse source
This commit is contained in:
Ryan Pavlik 2022-05-20 14:37:50 -05:00 committed by Jakob Bornecrantz
parent c7580c5242
commit 907edf10a3
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
src/xrt/auxiliary/os/os_threading.h
View file

@ -169,6 +169,16 @@ os_cond_signal(struct os_cond *oc)
/*!
* Wait.
*
* Be sure to call this in a loop, testing some other condition that you
* are actually waiting for, as condition variable waits are subject to
* spurious wakeups.
*
* Must be called with the mutex @p om locked.
*
* Once the wait begins, the mutex @p om is unlocked, to allow another
* thread access to change the thing you're monitoring. By the time this
* returns, you once again own the lock.
*
* @public @memberof os_cond
*/
static inline void
@ -590,8 +600,16 @@ os_thread_helper_is_running_locked(struct os_thread_helper *oth)
/*!
* Wait for a signal.
*
* Be sure to call this in a loop, testing some other condition that you
* are actually waiting for, as this is backed by a condition variable
* wait and is thus subject to spurious wakeups.
*
* Must be called with the helper locked.
*
* As this wraps a cond-var wait, once the wait begins, the helper is
* unlocked, to allow another thread access to change the thing you're
* monitoring. By the time this returns, you once again own the lock.
*
* @public @memberof os_thread_helper
*/
static inline void