AuroraSupport/AuroraRuntime
2
1
Fork 0
Code Issues 27 Pull Requests Releases Wiki Activity

[*] Updated/added FutexBarrier comments and updated AuThreadings README

Browse Source
This commit is contained in:
Reece Wilson 2024-05-27 14:05:22 +01:00
parent e4fa5d549e
commit 30b0fce882
2 changed files with 31 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Include/Aurora/Threading/README.md
View File

@ -4,11 +4,20 @@
# Features
* Thread synchronization primitives: condition ex, condition mutex, condition variable, critical section, event, mutex, rwlock, semaphore, and spinlock
* All primitives include a trylock and a nanosecond-resolution timed lock methods
* SleepNs function supporting higher resolution sleep available than in most APIs (^1)
* Enchanced Win32 support with increased yield resolution and optimization around internal XP, internal Win8, and UWP APIs
* All lock-like primitives can be used with a AuFlexibleConditionVariable (noting AuConditionVariable binds to a single AuCondMutex)
* WakeOnAddress support on every operating system regardless of kernel support
* WakeOnAddress with various wake operations (eNotEqual, eEqual, eLessThanCompare, eGreaterThanCompare, eLessThanOrEqualsCompare, eGreaterThanOrEqualsCompare) of any size under 32 bytes
* Reference futex primitives: AuInitOnce, AuInitOnceSmall, AuFutexBarrier, AuFutexCond, AuFutexMutex, AuFutexSemaphore, FutexWaitable\*NoVTbl\*\*Movable\*Smallest (AuFutexMutexSmallest)
* No primitive will ever waste time syscalling or otherwise waking if not required
* Single core (thread check), Intel SMT (rdtsc), AARCH64 (rdtsc emu via CNTVCT_EL0), Intel Alderlake (umonitor/tpause), and AMD 2016+ (monitorx) optimized/aware spinning optimizations with in-process and CPU heuristics
* ...known good performance and low kernel stated CPU usage% on Windows 7, Windows 11, and Linux spanning a diverse range of processors.
* Timeline semaphores / completion barriers are supported via AuFutexSemaphore::LockUntilAtleastAbsNS/AcquireUntilAtleastAbsNS
* RWLock supports read-to-write upgrades when the decision to esclate is made based upon a shared resource, plus CheckSelfThreadIsWriter check
* RWLocks are read criticial section based and all writer threads are allowed to enter read critical sections. In addition, AuRWRenterableLock allows for write reentrancy.
* Enchanced Win32 support with increased yield resolution and optimization around internal XP, internal Win8, and UWP APIs
* SleepNs function supporting higher resolution sleep available than in most APIs (^1)
* Thread Object per native OS thread
* Thread spawning with TLS handles and shutdown routines dispatched under pseudo fibers
* Thread spawning with TLS handles and shutdown routines ~~dispatched under pseudo fibers. TODO: reimpl thread 'features' and NT-like APCs ~~
* Update thread affinity, throttle, name, and related attributes
* Lock Util: AU_LOCK_GUARD(pointer/reference/shared ptr)
* Lock Util: AU_TRY_LOCK_GUARD[...](pointer/reference/shared ptr)

18
Include/Aurora/Threading/Waitables/FutexBarrier.hpp
View File

@ -21,12 +21,18 @@ namespace Aurora::Threading::Waitables
AU_NO_COPY_NO_MOVE(FutexBarrier);
/**
* @brief alert: one thread ready or task complete, wait until the work group is ready
*/
inline bool Enter()
{
bool bTimeout {};
return this->Park(bTimeout, true, 0);
}
/**
* @brief alert: one thread ready or task complete, wait until the work group is ready with an optional timeout
*/
inline AuPair<bool /* bSuccess */, bool /* bTimeOut */>
EnterTimed(AuUInt64 uTimeoutAbsNS)
{
@ -35,6 +41,9 @@ namespace Aurora::Threading::Waitables
return AuMakePair(bSuccess, bTimeout);
}
/**
* @brief alert: one thread ready or task complete, wait until the work group is ready with an optional timeout, call callOnce on a single thread
*/
inline AuPair<bool /* bSuccess */, bool /* bTimeOut */>
EnterTimedEx(AuUInt64 uTimeoutAbsNS,
AuVoidFunc callOnce)
@ -47,16 +56,25 @@ namespace Aurora::Threading::Waitables
return AuMakePair(bSuccess, bTimeout);
}
/**
* @brief alert: one thread ready or task complete
*/
inline bool TryEnter()
{
return this->TryEnterNoSpin();
}
/**
* @brief Has barrier met FutexBarrier(uExpectThreads) ?
*/
inline bool TryWait()
{
return this->TryChkNoSpin();
}
/**
* @brief Wait until the barrier has met FutexBarrier(uExpectThreads)
*/
inline bool Wait(AuUInt64 uTimeoutAbsNS = 0)
{
bool bTimeout {};