diff --git a/libcxxabi/src/cxa_guard_impl.h b/libcxxabi/src/cxa_guard_impl.h --- a/libcxxabi/src/cxa_guard_impl.h +++ b/libcxxabi/src/cxa_guard_impl.h @@ -176,18 +176,11 @@ GuardObject(GuardObject const&) = delete; GuardObject& operator=(GuardObject const&) = delete; - explicit GuardObject(uint32_t* g) - : base_address(g), guard_byte_address(reinterpret_cast(g)), - init_byte_address(reinterpret_cast(g) + 1), thread_id_address(nullptr) {} - - explicit GuardObject(uint64_t* g) - : base_address(g), guard_byte_address(reinterpret_cast(g)), - init_byte_address(reinterpret_cast(g) + 1), thread_id_address(reinterpret_cast(g) + 1) {} + explicit GuardObject(uint8_t* const guard_byte_address) : guard_byte(guard_byte_address) {} public: /// Implements __cxa_guard_acquire AcquireResult cxa_guard_acquire() { - AtomicInt guard_byte(guard_byte_address); if (guard_byte.load(std::_AO_Acquire) != UNSET) return INIT_IS_DONE; return derived()->acquire_init_byte(); @@ -195,7 +188,6 @@ /// Implements __cxa_guard_release void cxa_guard_release() { - AtomicInt guard_byte(guard_byte_address); // Store complete first, so that when release wakes other folks, they see // it as having been completed. guard_byte.store(COMPLETE_BIT, std::_AO_Release); @@ -205,18 +197,9 @@ /// Implements __cxa_guard_abort void cxa_guard_abort() { derived()->abort_init_byte(); } -public: - /// base_address - the address of the original guard object. - void* const base_address; - /// The address of the guard byte at offset 0. - uint8_t* const guard_byte_address; - /// The address of the byte used by the implementation during initialization. - uint8_t* const init_byte_address; - /// An optional address storing an identifier for the thread performing initialization. - /// It's used to detect recursive initialization. - uint32_t* const thread_id_address; - private: + AtomicInt guard_byte; + Derived* derived() { return static_cast(this); } }; @@ -224,9 +207,18 @@ // Single Threaded Implementation //===----------------------------------------------------------------------===// -struct InitByteNoThreads : GuardObject { - using GuardObject::GuardObject; +/// InitByteNoThreads - Doesn't use any inter-thread synchronization when +/// managing reads and writes to the init byte. +struct InitByteNoThreads { + InitByteNoThreads() = delete; + InitByteNoThreads(InitByteNoThreads const&) = delete; + InitByteNoThreads& operator=(InitByteNoThreads const&) = delete; + + explicit InitByteNoThreads(uint8_t* _init_byte_address) : init_byte_address(_init_byte_address) {} + /// The init_byte portion of cxa_guard_acquire. + /// Note: On completion, we haven't 'acquired' ownership of anything mutex + /// related. The name is simply referring to __cxa_guard_acquire. AcquireResult acquire_init_byte() { if (*init_byte_address == COMPLETE_BIT) return INIT_IS_DONE; @@ -236,8 +228,16 @@ return INIT_IS_PENDING; } + /// The init_byte portion of cxa_guard_release. + /// Note: On completion, we haven't 'released' ownership of anything mutex + /// related. The name is simply referring to __cxa_guard_release. void release_init_byte() { *init_byte_address = COMPLETE_BIT; } + /// The init_byte portion of cxa_guard_abort. void abort_init_byte() { *init_byte_address = UNSET; } + +private: + /// The address of the byte used during initialization. + uint8_t* const init_byte_address; }; //===----------------------------------------------------------------------===// @@ -277,17 +277,20 @@ struct LibcppCondVar {}; #endif // !defined(_LIBCXXABI_HAS_NO_THREADS) +/// InitByteGlobalMutex - Uses a global mutex and condition variable (common to +/// all static local variables) to manage reads and writes to the init byte. template -struct InitByteGlobalMutex : GuardObject> { - - using BaseT = typename InitByteGlobalMutex::GuardObject; - using BaseT::BaseT; +struct InitByteGlobalMutex { - explicit InitByteGlobalMutex(uint32_t* g) : BaseT(g), has_thread_id_support(false) {} - explicit InitByteGlobalMutex(uint64_t* g) : BaseT(g), has_thread_id_support(GetThreadID != nullptr) {} + explicit InitByteGlobalMutex(uint8_t* _init_byte_address, uint32_t* _thread_id_address) + : init_byte_address(_init_byte_address), thread_id_address(_thread_id_address), + has_thread_id_support(_thread_id_address != nullptr && GetThreadID != nullptr) {} public: + /// The init_byte portion of cxa_guard_acquire. + /// Note: On completion, we haven't 'acquired' ownership of anything mutex + /// related. The name is simply referring to __cxa_guard_acquire. AcquireResult acquire_init_byte() { LockGuard g("__cxa_guard_acquire"); // Check for possible recursive initialization. @@ -312,6 +315,9 @@ return INIT_IS_PENDING; } + /// The init_byte portion of cxa_guard_release. + /// Note: On completion, we haven't 'released' ownership of anything mutex + /// related. The name is simply referring to __cxa_guard_release. void release_init_byte() { bool has_waiting; { @@ -326,6 +332,7 @@ } } + /// The init_byte portion of cxa_guard_abort. void abort_init_byte() { bool has_waiting; { @@ -343,8 +350,12 @@ } private: - using BaseT::init_byte_address; - using BaseT::thread_id_address; + /// The address of the byte used during initialization. + uint8_t* const init_byte_address; + /// An optional address storing an identifier for the thread performing initialization. + /// It's used to detect recursive initialization. + uint32_t* const thread_id_address; + const bool has_thread_id_support; LazyValue current_thread_id; @@ -391,26 +402,21 @@ constexpr bool PlatformSupportsFutex() { return +PlatformFutexWait != nullptr; } -/// InitByteFutex - Manages initialization using atomics and the futex syscall -/// for waiting and waking. +/// InitByteFutex - Uses a futex to manage reads and writes to the init byte. template -struct InitByteFutex : GuardObject> { - using BaseT = typename InitByteFutex::GuardObject; +struct InitByteFutex { - /// ARM Constructor - explicit InitByteFutex(uint32_t* g) - : BaseT(g), init_byte(this->init_byte_address), - has_thread_id_support(this->thread_id_address && GetThreadIDArg != nullptr), - thread_id(this->thread_id_address) {} - - /// Itanium Constructor - explicit InitByteFutex(uint64_t* g) - : BaseT(g), init_byte(this->init_byte_address), - has_thread_id_support(this->thread_id_address && GetThreadIDArg != nullptr), - thread_id(this->thread_id_address) {} + explicit InitByteFutex(uint8_t* _init_byte_address, uint32_t* _thread_id_address) + : init_byte(_init_byte_address), + has_thread_id_support(_thread_id_address != nullptr && GetThreadIDArg != nullptr), + thread_id(_thread_id_address), base_address(reinterpret_cast( + /*_init_byte_address & ~0x3*/ _init_byte_address - 1)) {} public: + /// The init_byte portion of cxa_guard_acquire. + /// Note: On completion, we haven't 'acquired' ownership of anything mutex + /// related. The name is simply referring to __cxa_guard_acquire. AcquireResult acquire_init_byte() { while (true) { uint8_t last_val = UNSET; @@ -453,12 +459,16 @@ } } + /// The init_byte portion of cxa_guard_release. + /// Note: On completion, we haven't 'released' ownership of anything mutex + /// related. The name is simply referring to __cxa_guard_release. void release_init_byte() { uint8_t old = init_byte.exchange(COMPLETE_BIT, std::_AO_Acq_Rel); if (old & WAITING_BIT) wake_all(); } + /// The init_byte portion of cxa_guard_abort. void abort_init_byte() { if (has_thread_id_support) thread_id.store(0, std::_AO_Relaxed); @@ -470,12 +480,11 @@ private: /// Use the futex to wait on the current guard variable. Futex expects a - /// 32-bit 4-byte aligned address as the first argument, so we have to use use - /// the base address of the guard variable (not the init byte). - void wait_on_initialization() { - Wait(static_cast(this->base_address), expected_value_for_futex(PENDING_BIT | WAITING_BIT)); - } - void wake_all() { Wake(static_cast(this->base_address)); } + /// 32-bit 4-byte aligned address as the first argument, so we use the 4-byte + /// aligned address that encompasses the init byte (i.e. the address of the + /// raw guard object that was passed to __cxa_guard_acquire/release/abort). + void wait_on_initialization() { Wait(base_address, expected_value_for_futex(PENDING_BIT | WAITING_BIT)); } + void wake_all() { Wake(base_address); } private: AtomicInt init_byte; @@ -485,6 +494,10 @@ AtomicInt thread_id; LazyValue current_thread_id; + /// the 4-byte-aligned address that encompasses the init byte (i.e. the + /// address of the raw guard object). + int* const base_address; + /// Create the expected integer value for futex `wait(int* addr, int expected)`. /// We pass the base address as the first argument, So this function creates /// an zero-initialized integer with `b` copied at the correct offset. @@ -497,6 +510,64 @@ static_assert(Wait != nullptr && Wake != nullptr, ""); }; +//===----------------------------------------------------------------------===// +// Guards +//===----------------------------------------------------------------------===// + +/// NoThreadsGuard - Manages initialization without performing any inter-thread +/// synchronization. +struct NoThreadsGuard : GuardObject, InitByteNoThreads { + using BaseT = typename NoThreadsGuard::GuardObject; + using InitByteT = typename NoThreadsGuard::InitByteNoThreads; + + explicit NoThreadsGuard(uint32_t* raw_guard_object) + : BaseT(reinterpret_cast(raw_guard_object)), + InitByteT(reinterpret_cast(raw_guard_object) + 1) {} + + explicit NoThreadsGuard(uint64_t* raw_guard_object) + : BaseT(reinterpret_cast(raw_guard_object)), + InitByteT(reinterpret_cast(raw_guard_object) + 1) {} +}; + +/// GlobalMutexGuard - Manages initialization using a global mutex and +/// condition variable. +template +struct GlobalMutexGuard : GuardObject>, + InitByteGlobalMutex { + + using BaseT = typename GlobalMutexGuard::GuardObject; + using InitByteT = typename GlobalMutexGuard::InitByteGlobalMutex; + + explicit GlobalMutexGuard(uint32_t* raw_guard_object) + : BaseT(reinterpret_cast(raw_guard_object)), + InitByteT(reinterpret_cast(raw_guard_object) + 1, nullptr) {} + explicit GlobalMutexGuard(uint64_t* raw_guard_object) + : BaseT(reinterpret_cast(raw_guard_object)), + InitByteT(reinterpret_cast(raw_guard_object) + 1, reinterpret_cast(raw_guard_object) + 1) { + } +}; + +/// FutexGuard - Manages initialization using atomics and the futex syscall for +/// waiting and waking. +template +struct FutexGuard : GuardObject>, InitByteFutex { + using BaseT = typename FutexGuard::GuardObject; + using InitByteT = typename FutexGuard::InitByteFutex; + + /// ARM Constructor + explicit FutexGuard(uint32_t* raw_guard_object) + : BaseT(reinterpret_cast(raw_guard_object)), + InitByteT(reinterpret_cast(raw_guard_object) + 1, nullptr) {} + + /// Itanium Constructor + explicit FutexGuard(uint64_t* raw_guard_object) + : BaseT(reinterpret_cast(raw_guard_object)), + InitByteT(reinterpret_cast(raw_guard_object) + 1, reinterpret_cast(raw_guard_object) + 1) { + } +}; + //===----------------------------------------------------------------------===// // //===----------------------------------------------------------------------===// @@ -515,18 +586,18 @@ template <> struct SelectImplementation { - using type = InitByteNoThreads; + using type = NoThreadsGuard; }; template <> struct SelectImplementation { - using type = InitByteGlobalMutex::instance, - GlobalStatic::instance, PlatformThreadID>; + using type = GlobalMutexGuard::instance, + GlobalStatic::instance, PlatformThreadID>; }; template <> struct SelectImplementation { - using type = InitByteFutex; + using type = FutexGuard; }; // TODO(EricWF): We should prefer the futex implementation when available. But diff --git a/libcxxabi/test/guard_test_basic.pass.cpp b/libcxxabi/test/guard_test_basic.pass.cpp --- a/libcxxabi/test/guard_test_basic.pass.cpp +++ b/libcxxabi/test/guard_test_basic.pass.cpp @@ -119,17 +119,13 @@ { #if defined(_LIBCXXABI_HAS_NO_THREADS) static_assert(CurrentImplementation == Implementation::NoThreads, ""); - static_assert( - std::is_same::value, ""); + static_assert(std::is_same::value, ""); #else static_assert(CurrentImplementation == Implementation::GlobalMutex, ""); - static_assert( - std::is_same< - SelectedImplementation, - InitByteGlobalMutex::instance, - GlobalStatic::instance>>::value, - ""); + static_assert(std::is_same::instance, + GlobalStatic::instance>>::value, + ""); #endif } { @@ -142,19 +138,16 @@ } } { - Tests::test(); - Tests::test(); + Tests::test(); + Tests::test(); } { - using MutexImpl = - InitByteGlobalMutex; + using MutexImpl = GlobalMutexGuard; Tests::test(); Tests::test(); } { - using FutexImpl = - InitByteFutex<&NopFutexWait, &NopFutexWake, &MockGetThreadID>; + using FutexImpl = FutexGuard<&NopFutexWait, &NopFutexWake, &MockGetThreadID>; Tests::test(); Tests::test(); }