Chris@50: // Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors
Chris@50: // Licensed under the MIT License:
Chris@50: //
Chris@50: // Permission is hereby granted, free of charge, to any person obtaining a copy
Chris@50: // of this software and associated documentation files (the "Software"), to deal
Chris@50: // in the Software without restriction, including without limitation the rights
Chris@50: // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
Chris@50: // copies of the Software, and to permit persons to whom the Software is
Chris@50: // furnished to do so, subject to the following conditions:
Chris@50: //
Chris@50: // The above copyright notice and this permission notice shall be included in
Chris@50: // all copies or substantial portions of the Software.
Chris@50: //
Chris@50: // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
Chris@50: // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Chris@50: // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
Chris@50: // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
Chris@50: // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Chris@50: // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
Chris@50: // THE SOFTWARE.
Chris@50: 
Chris@50: #ifndef KJ_MUTEX_H_
Chris@50: #define KJ_MUTEX_H_
Chris@50: 
Chris@50: #if defined(__GNUC__) && !KJ_HEADER_WARNINGS
Chris@50: #pragma GCC system_header
Chris@50: #endif
Chris@50: 
Chris@50: #include "memory.h"
Chris@50: #include <inttypes.h>
Chris@50: 
Chris@50: #if __linux__ && !defined(KJ_USE_FUTEX)
Chris@50: #define KJ_USE_FUTEX 1
Chris@50: #endif
Chris@50: 
Chris@50: #if !KJ_USE_FUTEX && !_WIN32
Chris@50: // On Linux we use futex.  On other platforms we wrap pthreads.
Chris@50: // TODO(someday):  Write efficient low-level locking primitives for other platforms.
Chris@50: #include <pthread.h>
Chris@50: #endif
Chris@50: 
Chris@50: namespace kj {
Chris@50: 
Chris@50: // =======================================================================================
Chris@50: // Private details -- public interfaces follow below.
Chris@50: 
Chris@50: namespace _ {  // private
Chris@50: 
Chris@50: class Mutex {
Chris@50:   // Internal implementation details.  See `MutexGuarded<T>`.
Chris@50: 
Chris@50: public:
Chris@50:   Mutex();
Chris@50:   ~Mutex();
Chris@50:   KJ_DISALLOW_COPY(Mutex);
Chris@50: 
Chris@50:   enum Exclusivity {
Chris@50:     EXCLUSIVE,
Chris@50:     SHARED
Chris@50:   };
Chris@50: 
Chris@50:   void lock(Exclusivity exclusivity);
Chris@50:   void unlock(Exclusivity exclusivity);
Chris@50: 
Chris@50:   void assertLockedByCaller(Exclusivity exclusivity);
Chris@50:   // In debug mode, assert that the mutex is locked by the calling thread, or if that is
Chris@50:   // non-trivial, assert that the mutex is locked (which should be good enough to catch problems
Chris@50:   // in unit tests).  In non-debug builds, do nothing.
Chris@50: 
Chris@50: private:
Chris@50: #if KJ_USE_FUTEX
Chris@50:   uint futex;
Chris@50:   // bit 31 (msb) = set if exclusive lock held
Chris@50:   // bit 30 (msb) = set if threads are waiting for exclusive lock
Chris@50:   // bits 0-29 = count of readers; If an exclusive lock is held, this is the count of threads
Chris@50:   //   waiting for a read lock, otherwise it is the count of threads that currently hold a read
Chris@50:   //   lock.
Chris@50: 
Chris@50:   static constexpr uint EXCLUSIVE_HELD = 1u << 31;
Chris@50:   static constexpr uint EXCLUSIVE_REQUESTED = 1u << 30;
Chris@50:   static constexpr uint SHARED_COUNT_MASK = EXCLUSIVE_REQUESTED - 1;
Chris@50: 
Chris@50: #elif _WIN32
Chris@50:   uintptr_t srwLock;  // Actually an SRWLOCK, but don't want to #include <windows.h> in header.
Chris@50: 
Chris@50: #else
Chris@50:   mutable pthread_rwlock_t mutex;
Chris@50: #endif
Chris@50: };
Chris@50: 
Chris@50: class Once {
Chris@50:   // Internal implementation details.  See `Lazy<T>`.
Chris@50: 
Chris@50: public:
Chris@50: #if KJ_USE_FUTEX
Chris@50:   inline Once(bool startInitialized = false)
Chris@50:       : futex(startInitialized ? INITIALIZED : UNINITIALIZED) {}
Chris@50: #else
Chris@50:   Once(bool startInitialized = false);
Chris@50:   ~Once();
Chris@50: #endif
Chris@50:   KJ_DISALLOW_COPY(Once);
Chris@50: 
Chris@50:   class Initializer {
Chris@50:   public:
Chris@50:     virtual void run() = 0;
Chris@50:   };
Chris@50: 
Chris@50:   void runOnce(Initializer& init);
Chris@50: 
Chris@50: #if _WIN32  // TODO(perf): Can we make this inline on win32 somehow?
Chris@50:   bool isInitialized() noexcept;
Chris@50: 
Chris@50: #else
Chris@50:   inline bool isInitialized() noexcept {
Chris@50:     // Fast path check to see if runOnce() would simply return immediately.
Chris@50: #if KJ_USE_FUTEX
Chris@50:     return __atomic_load_n(&futex, __ATOMIC_ACQUIRE) == INITIALIZED;
Chris@50: #else
Chris@50:     return __atomic_load_n(&state, __ATOMIC_ACQUIRE) == INITIALIZED;
Chris@50: #endif
Chris@50:   }
Chris@50: #endif
Chris@50: 
Chris@50:   void reset();
Chris@50:   // Returns the state from initialized to uninitialized.  It is an error to call this when
Chris@50:   // not already initialized, or when runOnce() or isInitialized() might be called concurrently in
Chris@50:   // another thread.
Chris@50: 
Chris@50: private:
Chris@50: #if KJ_USE_FUTEX
Chris@50:   uint futex;
Chris@50: 
Chris@50:   enum State {
Chris@50:     UNINITIALIZED,
Chris@50:     INITIALIZING,
Chris@50:     INITIALIZING_WITH_WAITERS,
Chris@50:     INITIALIZED
Chris@50:   };
Chris@50: 
Chris@50: #elif _WIN32
Chris@50:   uintptr_t initOnce;  // Actually an INIT_ONCE, but don't want to #include <windows.h> in header.
Chris@50: 
Chris@50: #else
Chris@50:   enum State {
Chris@50:     UNINITIALIZED,
Chris@50:     INITIALIZED
Chris@50:   };
Chris@50:   State state;
Chris@50:   pthread_mutex_t mutex;
Chris@50: #endif
Chris@50: };
Chris@50: 
Chris@50: }  // namespace _ (private)
Chris@50: 
Chris@50: // =======================================================================================
Chris@50: // Public interface
Chris@50: 
Chris@50: template <typename T>
Chris@50: class Locked {
Chris@50:   // Return type for `MutexGuarded<T>::lock()`.  `Locked<T>` provides access to the guarded object
Chris@50:   // and unlocks the mutex when it goes out of scope.
Chris@50: 
Chris@50: public:
Chris@50:   KJ_DISALLOW_COPY(Locked);
Chris@50:   inline Locked(): mutex(nullptr), ptr(nullptr) {}
Chris@50:   inline Locked(Locked&& other): mutex(other.mutex), ptr(other.ptr) {
Chris@50:     other.mutex = nullptr;
Chris@50:     other.ptr = nullptr;
Chris@50:   }
Chris@50:   inline ~Locked() {
Chris@50:     if (mutex != nullptr) mutex->unlock(isConst<T>() ? _::Mutex::SHARED : _::Mutex::EXCLUSIVE);
Chris@50:   }
Chris@50: 
Chris@50:   inline Locked& operator=(Locked&& other) {
Chris@50:     if (mutex != nullptr) mutex->unlock(isConst<T>() ? _::Mutex::SHARED : _::Mutex::EXCLUSIVE);
Chris@50:     mutex = other.mutex;
Chris@50:     ptr = other.ptr;
Chris@50:     other.mutex = nullptr;
Chris@50:     other.ptr = nullptr;
Chris@50:     return *this;
Chris@50:   }
Chris@50: 
Chris@50:   inline void release() {
Chris@50:     if (mutex != nullptr) mutex->unlock(isConst<T>() ? _::Mutex::SHARED : _::Mutex::EXCLUSIVE);
Chris@50:     mutex = nullptr;
Chris@50:     ptr = nullptr;
Chris@50:   }
Chris@50: 
Chris@50:   inline T* operator->() { return ptr; }
Chris@50:   inline const T* operator->() const { return ptr; }
Chris@50:   inline T& operator*() { return *ptr; }
Chris@50:   inline const T& operator*() const { return *ptr; }
Chris@50:   inline T* get() { return ptr; }
Chris@50:   inline const T* get() const { return ptr; }
Chris@50:   inline operator T*() { return ptr; }
Chris@50:   inline operator const T*() const { return ptr; }
Chris@50: 
Chris@50: private:
Chris@50:   _::Mutex* mutex;
Chris@50:   T* ptr;
Chris@50: 
Chris@50:   inline Locked(_::Mutex& mutex, T& value): mutex(&mutex), ptr(&value) {}
Chris@50: 
Chris@50:   template <typename U>
Chris@50:   friend class MutexGuarded;
Chris@50: };
Chris@50: 
Chris@50: template <typename T>
Chris@50: class MutexGuarded {
Chris@50:   // An object of type T, guarded by a mutex.  In order to access the object, you must lock it.
Chris@50:   //
Chris@50:   // Write locks are not "recursive" -- trying to lock again in a thread that already holds a lock
Chris@50:   // will deadlock.  Recursive write locks are usually a sign of bad design.
Chris@50:   //
Chris@50:   // Unfortunately, **READ LOCKS ARE NOT RECURSIVE** either.  Common sense says they should be.
Chris@50:   // But on many operating systems (BSD, OSX), recursively read-locking a pthread_rwlock is
Chris@50:   // actually unsafe.  The problem is that writers are "prioritized" over readers, so a read lock
Chris@50:   // request will block if any write lock requests are outstanding.  So, if thread A takes a read
Chris@50:   // lock, thread B requests a write lock (and starts waiting), and then thread A tries to take
Chris@50:   // another read lock recursively, the result is deadlock.
Chris@50: 
Chris@50: public:
Chris@50:   template <typename... Params>
Chris@50:   explicit MutexGuarded(Params&&... params);
Chris@50:   // Initialize the mutex-guarded object by passing the given parameters to its constructor.
Chris@50: 
Chris@50:   Locked<T> lockExclusive() const;
Chris@50:   // Exclusively locks the object and returns it.  The returned `Locked<T>` can be passed by
Chris@50:   // move, similar to `Own<T>`.
Chris@50:   //
Chris@50:   // This method is declared `const` in accordance with KJ style rules which say that constness
Chris@50:   // should be used to indicate thread-safety.  It is safe to share a const pointer between threads,
Chris@50:   // but it is not safe to share a mutable pointer.  Since the whole point of MutexGuarded is to
Chris@50:   // be shared between threads, its methods should be const, even though locking it produces a
Chris@50:   // non-const pointer to the contained object.
Chris@50: 
Chris@50:   Locked<const T> lockShared() const;
Chris@50:   // Lock the value for shared access.  Multiple shared locks can be taken concurrently, but cannot
Chris@50:   // be held at the same time as a non-shared lock.
Chris@50: 
Chris@50:   inline const T& getWithoutLock() const { return value; }
Chris@50:   inline T& getWithoutLock() { return value; }
Chris@50:   // Escape hatch for cases where some external factor guarantees that it's safe to get the
Chris@50:   // value.  You should treat these like const_cast -- be highly suspicious of any use.
Chris@50: 
Chris@50:   inline const T& getAlreadyLockedShared() const;
Chris@50:   inline T& getAlreadyLockedShared();
Chris@50:   inline T& getAlreadyLockedExclusive() const;
Chris@50:   // Like `getWithoutLock()`, but asserts that the lock is already held by the calling thread.
Chris@50: 
Chris@50: private:
Chris@50:   mutable _::Mutex mutex;
Chris@50:   mutable T value;
Chris@50: };
Chris@50: 
Chris@50: template <typename T>
Chris@50: class MutexGuarded<const T> {
Chris@50:   // MutexGuarded cannot guard a const type.  This would be pointless anyway, and would complicate
Chris@50:   // the implementation of Locked<T>, which uses constness to decide what kind of lock it holds.
Chris@50:   static_assert(sizeof(T) < 0, "MutexGuarded's type cannot be const.");
Chris@50: };
Chris@50: 
Chris@50: template <typename T>
Chris@50: class Lazy {
Chris@50:   // A lazily-initialized value.
Chris@50: 
Chris@50: public:
Chris@50:   template <typename Func>
Chris@50:   T& get(Func&& init);
Chris@50:   template <typename Func>
Chris@50:   const T& get(Func&& init) const;
Chris@50:   // The first thread to call get() will invoke the given init function to construct the value.
Chris@50:   // Other threads will block until construction completes, then return the same value.
Chris@50:   //
Chris@50:   // `init` is a functor(typically a lambda) which takes `SpaceFor<T>&` as its parameter and returns
Chris@50:   // `Own<T>`.  If `init` throws an exception, the exception is propagated out of that thread's
Chris@50:   // call to `get()`, and subsequent calls behave as if `get()` hadn't been called at all yet --
Chris@50:   // in other words, subsequent calls retry initialization until it succeeds.
Chris@50: 
Chris@50: private:
Chris@50:   mutable _::Once once;
Chris@50:   mutable SpaceFor<T> space;
Chris@50:   mutable Own<T> value;
Chris@50: 
Chris@50:   template <typename Func>
Chris@50:   class InitImpl;
Chris@50: };
Chris@50: 
Chris@50: // =======================================================================================
Chris@50: // Inline implementation details
Chris@50: 
Chris@50: template <typename T>
Chris@50: template <typename... Params>
Chris@50: inline MutexGuarded<T>::MutexGuarded(Params&&... params)
Chris@50:     : value(kj::fwd<Params>(params)...) {}
Chris@50: 
Chris@50: template <typename T>
Chris@50: inline Locked<T> MutexGuarded<T>::lockExclusive() const {
Chris@50:   mutex.lock(_::Mutex::EXCLUSIVE);
Chris@50:   return Locked<T>(mutex, value);
Chris@50: }
Chris@50: 
Chris@50: template <typename T>
Chris@50: inline Locked<const T> MutexGuarded<T>::lockShared() const {
Chris@50:   mutex.lock(_::Mutex::SHARED);
Chris@50:   return Locked<const T>(mutex, value);
Chris@50: }
Chris@50: 
Chris@50: template <typename T>
Chris@50: inline const T& MutexGuarded<T>::getAlreadyLockedShared() const {
Chris@50: #ifdef KJ_DEBUG
Chris@50:   mutex.assertLockedByCaller(_::Mutex::SHARED);
Chris@50: #endif
Chris@50:   return value;
Chris@50: }
Chris@50: template <typename T>
Chris@50: inline T& MutexGuarded<T>::getAlreadyLockedShared() {
Chris@50: #ifdef KJ_DEBUG
Chris@50:   mutex.assertLockedByCaller(_::Mutex::SHARED);
Chris@50: #endif
Chris@50:   return value;
Chris@50: }
Chris@50: template <typename T>
Chris@50: inline T& MutexGuarded<T>::getAlreadyLockedExclusive() const {
Chris@50: #ifdef KJ_DEBUG
Chris@50:   mutex.assertLockedByCaller(_::Mutex::EXCLUSIVE);
Chris@50: #endif
Chris@50:   return const_cast<T&>(value);
Chris@50: }
Chris@50: 
Chris@50: template <typename T>
Chris@50: template <typename Func>
Chris@50: class Lazy<T>::InitImpl: public _::Once::Initializer {
Chris@50: public:
Chris@50:   inline InitImpl(const Lazy<T>& lazy, Func&& func): lazy(lazy), func(kj::fwd<Func>(func)) {}
Chris@50: 
Chris@50:   void run() override {
Chris@50:     lazy.value = func(lazy.space);
Chris@50:   }
Chris@50: 
Chris@50: private:
Chris@50:   const Lazy<T>& lazy;
Chris@50:   Func func;
Chris@50: };
Chris@50: 
Chris@50: template <typename T>
Chris@50: template <typename Func>
Chris@50: inline T& Lazy<T>::get(Func&& init) {
Chris@50:   if (!once.isInitialized()) {
Chris@50:     InitImpl<Func> initImpl(*this, kj::fwd<Func>(init));
Chris@50:     once.runOnce(initImpl);
Chris@50:   }
Chris@50:   return *value;
Chris@50: }
Chris@50: 
Chris@50: template <typename T>
Chris@50: template <typename Func>
Chris@50: inline const T& Lazy<T>::get(Func&& init) const {
Chris@50:   if (!once.isInitialized()) {
Chris@50:     InitImpl<Func> initImpl(*this, kj::fwd<Func>(init));
Chris@50:     once.runOnce(initImpl);
Chris@50:   }
Chris@50:   return *value;
Chris@50: }
Chris@50: 
Chris@50: }  // namespace kj
Chris@50: 
Chris@50: #endif  // KJ_MUTEX_H_