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