folly/ThreadLocal.h

   1 /*
   2  * Copyright 2013 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * Improved thread local storage for non-trivial types (similar speed as
  19  * pthread_getspecific but only consumes a single pthread_key_t, and 4x faster
  20  * than boost::thread_specific_ptr).
  21  *
  22  * Also includes an accessor interface to walk all the thread local child
  23  * objects of a parent.  accessAllThreads() initializes an accessor which holds
  24  * a global lock *that blocks all creation and destruction of ThreadLocal
  25  * objects with the same Tag* and can be used as an iterable container.
  26  *
  27  * Intended use is for frequent write, infrequent read data access patterns such
  28  * as counters.
  29  *
  30  * There are two classes here - ThreadLocal and ThreadLocalPtr.  ThreadLocalPtr
  31  * has semantics similar to boost::thread_specific_ptr. ThreadLocal is a thin
  32  * wrapper around ThreadLocalPtr that manages allocation automatically.
  33  *
  34  * @author Spencer Ahrens (sahrens)
  35  */
  36
  37 #ifndef FOLLY_THREADLOCAL_H_
  38 #define FOLLY_THREADLOCAL_H_
  39
  40 #include "folly/Portability.h"
  41 #include <boost/iterator/iterator_facade.hpp>
  42 #include "folly/Likely.h"
  43 #include <type_traits>
  44
  45
  46 namespace folly {
  47 enum class TLPDestructionMode {
  48   THIS_THREAD,
  49   ALL_THREADS
  50 };
  51 }  // namespace
  52
  53 #include "folly/detail/ThreadLocalDetail.h"
  54
  55 namespace folly {
  56
  57 template<class T, class Tag> class ThreadLocalPtr;
  58
  59 template<class T, class Tag=void>
  60 class ThreadLocal {
  61  public:
  62   ThreadLocal() { }
  63
  64   T* get() const {
  65     T* ptr = tlp_.get();
  66     if (LIKELY(ptr != nullptr)) {
  67       return ptr;
  68     }
  69
  70     // separated new item creation out to speed up the fast path.
  71     return makeTlp();
  72   }
  73
  74   T* operator->() const {
  75     return get();
  76   }
  77
  78   T& operator*() const {
  79     return *get();
  80   }
  81
  82   void reset(T* newPtr = nullptr) {
  83     tlp_.reset(newPtr);
  84   }
  85
  86   typedef typename ThreadLocalPtr<T,Tag>::Accessor Accessor;
  87   Accessor accessAllThreads() const {
  88     return tlp_.accessAllThreads();
  89   }
  90
  91   // movable
  92   ThreadLocal(ThreadLocal&&) = default;
  93   ThreadLocal& operator=(ThreadLocal&&) = default;
  94
  95  private:
  96   // non-copyable
  97   ThreadLocal(const ThreadLocal&) = delete;
  98   ThreadLocal& operator=(const ThreadLocal&) = delete;
  99
 100   T* makeTlp() const {
 101     T* ptr = new T();
 102     tlp_.reset(ptr);
 103     return ptr;
 104   }
 105
 106   mutable ThreadLocalPtr<T,Tag> tlp_;
 107 };
 108
 109 /*
 110  * The idea here is that __thread is faster than pthread_getspecific, so we
 111  * keep a __thread array of pointers to objects (ThreadEntry::elements) where
 112  * each array has an index for each unique instance of the ThreadLocalPtr
 113  * object.  Each ThreadLocalPtr object has a unique id that is an index into
 114  * these arrays so we can fetch the correct object from thread local storage
 115  * very efficiently.
 116  *
 117  * In order to prevent unbounded growth of the id space and thus huge
 118  * ThreadEntry::elements, arrays, for example due to continuous creation and
 119  * destruction of ThreadLocalPtr objects, we keep a set of all active
 120  * instances.  When an instance is destroyed we remove it from the active
 121  * set and insert the id into freeIds_ for reuse.  These operations require a
 122  * global mutex, but only happen at construction and destruction time.
 123  *
 124  * We use a single global pthread_key_t per Tag to manage object destruction and
 125  * memory cleanup upon thread exit because there is a finite number of
 126  * pthread_key_t's available per machine.
 127  */
 128
 129 template<class T, class Tag=void>
 130 class ThreadLocalPtr {
 131  public:
 132   ThreadLocalPtr() : id_(threadlocal_detail::StaticMeta<Tag>::create()) { }
 133
 134   ThreadLocalPtr(ThreadLocalPtr&& other) : id_(other.id_) {
 135     other.id_ = 0;
 136   }
 137
 138   ThreadLocalPtr& operator=(ThreadLocalPtr&& other) {
 139     assert(this != &other);
 140     destroy();
 141     id_ = other.id_;
 142     other.id_ = 0;
 143     return *this;
 144   }
 145
 146   ~ThreadLocalPtr() {
 147     destroy();
 148   }
 149
 150   T* get() const {
 151     return static_cast<T*>(threadlocal_detail::StaticMeta<Tag>::get(id_).ptr);
 152   }
 153
 154   T* operator->() const {
 155     return get();
 156   }
 157
 158   T& operator*() const {
 159     return *get();
 160   }
 161
 162   void reset(T* newPtr = nullptr) {
 163     threadlocal_detail::ElementWrapper& w =
 164       threadlocal_detail::StaticMeta<Tag>::get(id_);
 165     if (w.ptr != newPtr) {
 166       w.dispose(TLPDestructionMode::THIS_THREAD);
 167       w.set(newPtr);
 168     }
 169   }
 170
 171   explicit operator bool() const {
 172     return get() != nullptr;
 173   }
 174
 175   /**
 176    * reset() with a custom deleter:
 177    * deleter(T* ptr, TLPDestructionMode mode)
 178    * "mode" is ALL_THREADS if we're destructing this ThreadLocalPtr (and thus
 179    * deleting pointers for all threads), and THIS_THREAD if we're only deleting
 180    * the member for one thread (because of thread exit or reset())
 181    */
 182   template <class Deleter>
 183   void reset(T* newPtr, Deleter deleter) {
 184     threadlocal_detail::ElementWrapper& w =
 185       threadlocal_detail::StaticMeta<Tag>::get(id_);
 186     if (w.ptr != newPtr) {
 187       w.dispose(TLPDestructionMode::THIS_THREAD);
 188       w.set(newPtr, deleter);
 189     }
 190   }
 191
 192   // Holds a global lock for iteration through all thread local child objects.
 193   // Can be used as an iterable container.
 194   // Use accessAllThreads() to obtain one.
 195   class Accessor {
 196     friend class ThreadLocalPtr<T,Tag>;
 197
 198     threadlocal_detail::StaticMeta<Tag>& meta_;
 199     boost::mutex* lock_;
 200     int id_;
 201
 202    public:
 203     class Iterator;
 204     friend class Iterator;
 205
 206     // The iterators obtained from Accessor are bidirectional iterators.
 207     class Iterator : public boost::iterator_facade<
 208           Iterator,                               // Derived
 209           T,                                      // value_type
 210           boost::bidirectional_traversal_tag> {   // traversal
 211       friend class Accessor;
 212       friend class boost::iterator_core_access;
 213       const Accessor* const accessor_;
 214       threadlocal_detail::ThreadEntry* e_;
 215
 216       void increment() {
 217         e_ = e_->next;
 218         incrementToValid();
 219       }
 220
 221       void decrement() {
 222         e_ = e_->prev;
 223         decrementToValid();
 224       }
 225
 226       T& dereference() const {
 227         return *static_cast<T*>(e_->elements[accessor_->id_].ptr);
 228       }
 229
 230       bool equal(const Iterator& other) const {
 231         return (accessor_->id_ == other.accessor_->id_ &&
 232                 e_ == other.e_);
 233       }
 234
 235       explicit Iterator(const Accessor* accessor)
 236         : accessor_(accessor),
 237           e_(&accessor_->meta_.head_) {
 238       }
 239
 240       bool valid() const {
 241         return (e_->elements &&
 242                 accessor_->id_ < e_->elementsCapacity &&
 243                 e_->elements[accessor_->id_].ptr);
 244       }
 245
 246       void incrementToValid() {
 247         for (; e_ != &accessor_->meta_.head_ && !valid(); e_ = e_->next) { }
 248       }
 249
 250       void decrementToValid() {
 251         for (; e_ != &accessor_->meta_.head_ && !valid(); e_ = e_->prev) { }
 252       }
 253     };
 254
 255     ~Accessor() {
 256       release();
 257     }
 258
 259     Iterator begin() const {
 260       return ++Iterator(this);
 261     }
 262
 263     Iterator end() const {
 264       return Iterator(this);
 265     }
 266
 267     Accessor(const Accessor&) = delete;
 268     Accessor& operator=(const Accessor&) = delete;
 269
 270     Accessor(Accessor&& other) noexcept
 271       : meta_(other.meta_),
 272         lock_(other.lock_),
 273         id_(other.id_) {
 274       other.id_ = 0;
 275       other.lock_ = nullptr;
 276     }
 277
 278     Accessor& operator=(Accessor&& other) noexcept {
 279       // Each Tag has its own unique meta, and accessors with different Tags
 280       // have different types.  So either *this is empty, or this and other
 281       // have the same tag.  But if they have the same tag, they have the same
 282       // meta (and lock), so they'd both hold the lock at the same time,
 283       // which is impossible, which leaves only one possible scenario --
 284       // *this is empty.  Assert it.
 285       assert(&meta_ == &other.meta_);
 286       assert(lock_ == nullptr);
 287       using std::swap;
 288       swap(lock_, other.lock_);
 289       swap(id_, other.id_);
 290     }
 291
 292     Accessor()
 293       : meta_(threadlocal_detail::StaticMeta<Tag>::instance()),
 294         lock_(nullptr),
 295         id_(0) {
 296     }
 297
 298    private:
 299     explicit Accessor(int id)
 300       : meta_(threadlocal_detail::StaticMeta<Tag>::instance()),
 301         lock_(&meta_.lock_) {
 302       lock_->lock();
 303       id_ = id;
 304     }
 305
 306     void release() {
 307       if (lock_) {
 308         lock_->unlock();
 309         id_ = 0;
 310         lock_ = nullptr;
 311       }
 312     }
 313   };
 314
 315   // accessor allows a client to iterate through all thread local child
 316   // elements of this ThreadLocal instance.  Holds a global lock for each <Tag>
 317   Accessor accessAllThreads() const {
 318     static_assert(!std::is_same<Tag, void>::value,
 319                   "Must use a unique Tag to use the accessAllThreads feature");
 320     return Accessor(id_);
 321   }
 322
 323  private:
 324   void destroy() {
 325     if (id_) {
 326       threadlocal_detail::StaticMeta<Tag>::destroy(id_);
 327     }
 328   }
 329
 330   // non-copyable
 331   ThreadLocalPtr(const ThreadLocalPtr&) = delete;
 332   ThreadLocalPtr& operator=(const ThreadLocalPtr&) = delete;
 333
 334   int id_;  // every instantiation has a unique id
 335 };
 336
 337 }  // namespace folly
 338
 339 #endif /* FOLLY_THREADLOCAL_H_ */