cannam@147: // Copyright (c) 2014, Jason Choy <jjwchoy@gmail.com>
cannam@147: // Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors
cannam@147: // Licensed under the MIT License:
cannam@147: //
cannam@147: // Permission is hereby granted, free of charge, to any person obtaining a copy
cannam@147: // of this software and associated documentation files (the "Software"), to deal
cannam@147: // in the Software without restriction, including without limitation the rights
cannam@147: // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
cannam@147: // copies of the Software, and to permit persons to whom the Software is
cannam@147: // furnished to do so, subject to the following conditions:
cannam@147: //
cannam@147: // The above copyright notice and this permission notice shall be included in
cannam@147: // all copies or substantial portions of the Software.
cannam@147: //
cannam@147: // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
cannam@147: // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
cannam@147: // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
cannam@147: // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
cannam@147: // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
cannam@147: // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
cannam@147: // THE SOFTWARE.
cannam@147: 
cannam@147: #ifndef KJ_THREADLOCAL_H_
cannam@147: #define KJ_THREADLOCAL_H_
cannam@147: 
cannam@147: #if defined(__GNUC__) && !KJ_HEADER_WARNINGS
cannam@147: #pragma GCC system_header
cannam@147: #endif
cannam@147: // This file declares a macro `KJ_THREADLOCAL_PTR` for declaring thread-local pointer-typed
cannam@147: // variables.  Use like:
cannam@147: //     KJ_THREADLOCAL_PTR(MyType) foo = nullptr;
cannam@147: // This is equivalent to:
cannam@147: //     thread_local MyType* foo = nullptr;
cannam@147: // This can only be used at the global scope.
cannam@147: //
cannam@147: // AVOID USING THIS.  Use of thread-locals is discouraged because they often have many of the same
cannam@147: // properties as singletons: http://www.object-oriented-security.org/lets-argue/singletons
cannam@147: //
cannam@147: // Also, thread-locals tend to be hostile to event-driven code, which can be particularly
cannam@147: // surprising when using fibers (all fibers in the same thread will share the same threadlocals,
cannam@147: // even though they do not share a stack).
cannam@147: //
cannam@147: // That said, thread-locals are sometimes needed for runtime logistics in the KJ framework.  For
cannam@147: // example, the current exception callback and current EventLoop are stored as thread-local
cannam@147: // pointers.  Since KJ only ever needs to store pointers, not values, we avoid the question of
cannam@147: // whether these values' destructors need to be run, and we avoid the need for heap allocation.
cannam@147: 
cannam@147: #include "common.h"
cannam@147: 
cannam@147: #if !defined(KJ_USE_PTHREAD_THREADLOCAL) && defined(__APPLE__)
cannam@147: #include "TargetConditionals.h"
cannam@147: #if TARGET_OS_IPHONE
cannam@147: // iOS apparently does not support __thread (nor C++11 thread_local).
cannam@147: #define KJ_USE_PTHREAD_TLS 1
cannam@147: #endif
cannam@147: #endif
cannam@147: 
cannam@147: #if KJ_USE_PTHREAD_TLS
cannam@147: #include <pthread.h>
cannam@147: #endif
cannam@147: 
cannam@147: namespace kj {
cannam@147: 
cannam@147: #if KJ_USE_PTHREAD_TLS
cannam@147: // If __thread is unavailable, we'll fall back to pthreads.
cannam@147: 
cannam@147: #define KJ_THREADLOCAL_PTR(type) \
cannam@147:   namespace { struct KJ_UNIQUE_NAME(_kj_TlpTag); } \
cannam@147:   static ::kj::_::ThreadLocalPtr< type, KJ_UNIQUE_NAME(_kj_TlpTag)>
cannam@147: // Hack:  In order to ensure each thread-local results in a unique template instance, we declare
cannam@147: //   a one-off dummy type to use as the second type parameter.
cannam@147: 
cannam@147: namespace _ {  // private
cannam@147: 
cannam@147: template <typename T, typename>
cannam@147: class ThreadLocalPtr {
cannam@147:   // Hacky type to emulate __thread T*.  We need a separate instance of the ThreadLocalPtr template
cannam@147:   // for every thread-local variable, because we don't want to require a global constructor, and in
cannam@147:   // order to initialize the TLS on first use we need to use a local static variable (in getKey()).
cannam@147:   // Each template instance will get a separate such local static variable, fulfilling our need.
cannam@147: 
cannam@147: public:
cannam@147:   ThreadLocalPtr() = default;
cannam@147:   constexpr ThreadLocalPtr(decltype(nullptr)) {}
cannam@147:   // Allow initialization to nullptr without a global constructor.
cannam@147: 
cannam@147:   inline ThreadLocalPtr& operator=(T* val) {
cannam@147:     pthread_setspecific(getKey(), val);
cannam@147:     return *this;
cannam@147:   }
cannam@147: 
cannam@147:   inline operator T*() const {
cannam@147:     return get();
cannam@147:   }
cannam@147: 
cannam@147:   inline T& operator*() const {
cannam@147:     return *get();
cannam@147:   }
cannam@147: 
cannam@147:   inline T* operator->() const {
cannam@147:     return get();
cannam@147:   }
cannam@147: 
cannam@147: private:
cannam@147:   inline T* get() const {
cannam@147:     return reinterpret_cast<T*>(pthread_getspecific(getKey()));
cannam@147:   }
cannam@147: 
cannam@147:   inline static pthread_key_t getKey() {
cannam@147:     static pthread_key_t key = createKey();
cannam@147:     return key;
cannam@147:   }
cannam@147: 
cannam@147:   static pthread_key_t createKey() {
cannam@147:     pthread_key_t key;
cannam@147:     pthread_key_create(&key, 0);
cannam@147:     return key;
cannam@147:   }
cannam@147: };
cannam@147: 
cannam@147: }  // namespace _ (private)
cannam@147: 
cannam@147: #elif __GNUC__
cannam@147: 
cannam@147: #define KJ_THREADLOCAL_PTR(type) static __thread type*
cannam@147: // GCC's __thread is lighter-weight than thread_local and is good enough for our purposes.
cannam@147: 
cannam@147: #else
cannam@147: 
cannam@147: #define KJ_THREADLOCAL_PTR(type) static thread_local type*
cannam@147: 
cannam@147: #endif // KJ_USE_PTHREAD_TLS
cannam@147: 
cannam@147: }  // namespace kj
cannam@147: 
cannam@147: #endif  // KJ_THREADLOCAL_H_