src/mojo/public/utility/thread_local.h

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 // WARNING: Thread local storage is a bit tricky to get right.  Please make
   6 // sure that this is really the proper solution for what you're trying to
   7 // achieve.  Don't prematurely optimize, most likely you can just use a Lock.
   8 //
   9 // These classes implement a wrapper around the platform's TLS storage
  10 // mechanism.  On construction, they will allocate a TLS slot, and free the
  11 // TLS slot on destruction.  No memory management (creation or destruction) is
  12 // handled.  This means for uses of ThreadLocalPointer, you must correctly
  13 // manage the memory yourself, these classes will not destroy the pointer for
  14 // you.  There are no at-thread-exit actions taken by these classes.
  15 //
  16 // ThreadLocalPointer<Type> wraps a Type*.  It performs no creation or
  17 // destruction, so memory management must be handled elsewhere.  The first call
  18 // to Get() on a thread will return NULL.  You can update the pointer with a
  19 // call to Set().
  20 //
  21 // ThreadLocalBoolean wraps a bool.  It will default to false if it has never
  22 // been set otherwise with Set().
  23 //
  24 // Thread Safety:  An instance of ThreadLocalStorage is completely thread safe
  25 // once it has been created.  If you want to dynamically create an instance,
  26 // you must of course properly deal with safety and race conditions.  This
  27 // means a function-level static initializer is generally inappropiate.
  28 //
  29 // Example usage:
  30 //   // My class is logically attached to a single thread.  We cache a pointer
  31 //   // on the thread it was created on, so we can implement current().
  32 //   MyClass::MyClass() {
  33 //     DCHECK(Singleton<ThreadLocalPointer<MyClass> >::get()->Get() == NULL);
  34 //     Singleton<ThreadLocalPointer<MyClass> >::get()->Set(this);
  35 //   }
  36 //
  37 //   MyClass::~MyClass() {
  38 //     DCHECK(Singleton<ThreadLocalPointer<MyClass> >::get()->Get() != NULL);
  39 //     Singleton<ThreadLocalPointer<MyClass> >::get()->Set(NULL);
  40 //   }
  41 //
  42 //   // Return the current MyClass associated with the calling thread, can be
  43 //   // NULL if there isn't a MyClass associated.
  44 //   MyClass* MyClass::current() {
  45 //     return Singleton<ThreadLocalPointer<MyClass> >::get()->Get();
  46 //   }
  47
  48 #ifndef MOJO_PUBLIC_UTILITY_THREAD_LOCAL_H_
  49 #define MOJO_PUBLIC_UTILITY_THREAD_LOCAL_H_
  50
  51 #ifndef _WIN32
  52 #include <pthread.h>
  53 #endif
  54
  55 #include "mojo/public/system/macros.h"
  56
  57 namespace mojo {
  58 namespace internal {
  59
  60 // Helper functions that abstract the cross-platform APIs.  Do not use directly.
  61 struct ThreadLocalPlatform {
  62 #ifdef _WIN32
  63   typedef unsigned long SlotType;
  64 #else
  65   typedef pthread_key_t SlotType;
  66 #endif
  67
  68   static void AllocateSlot(SlotType* slot);
  69   static void FreeSlot(SlotType slot);
  70   static void* GetValueFromSlot(SlotType slot);
  71   static void SetValueInSlot(SlotType slot, void* value);
  72 };
  73
  74 }  // namespace internal
  75
  76 template <typename Type>
  77 class ThreadLocalPointer {
  78  public:
  79   ThreadLocalPointer() : slot_() {
  80     internal::ThreadLocalPlatform::AllocateSlot(&slot_);
  81   }
  82
  83   ~ThreadLocalPointer() {
  84     internal::ThreadLocalPlatform::FreeSlot(slot_);
  85   }
  86
  87   Type* Get() {
  88     return static_cast<Type*>(
  89         internal::ThreadLocalPlatform::GetValueFromSlot(slot_));
  90   }
  91
  92   void Set(Type* ptr) {
  93     internal::ThreadLocalPlatform::SetValueInSlot(
  94         slot_, const_cast<void*>(static_cast<const void*>(ptr)));
  95   }
  96
  97  private:
  98   typedef internal::ThreadLocalPlatform::SlotType SlotType;
  99
 100   SlotType slot_;
 101
 102   MOJO_DISALLOW_COPY_AND_ASSIGN(ThreadLocalPointer<Type>);
 103 };
 104
 105 class ThreadLocalBoolean {
 106  public:
 107   ThreadLocalBoolean() {}
 108   ~ThreadLocalBoolean() {}
 109
 110   bool Get() {
 111     return tlp_.Get() != NULL;
 112   }
 113
 114   void Set(bool val) {
 115     tlp_.Set(val ? this : NULL);
 116   }
 117
 118  private:
 119   ThreadLocalPointer<void> tlp_;
 120
 121   MOJO_DISALLOW_COPY_AND_ASSIGN(ThreadLocalBoolean);
 122 };
 123
 124 }  // namespace mojo
 125
 126 #endif  // MOJO_PUBLIC_UTILITY_THREAD_LOCAL_H_