gecko/mfbt/ThreadLocal.h
Ehsan Akhgari f38cefa90e Bug 753119 - Add ThreadLocal to mfbt - r=jwalden
... because nobody likes to use the NSPR TLS support.
2012-05-09 16:54:33 -04:00

129 lines
3.1 KiB
C++

/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/. */
// Cross-platform lightweight thread local data wrappers
#ifndef mozilla_TLS_h_
#define mozilla_TLS_h_
#if defined(XP_WIN)
// This file will get included in any file that wants to add a profiler mark.
// In order to not bring <windows.h> together we could include windef.h and
// winbase.h which are sufficient to get the prototypes for the Tls* functions.
// # include <windef.h>
// # include <winbase.h>
// Unfortunately, even including these headers causes us to add a bunch of ugly
// stuff to our namespace e.g #define CreateEvent CreateEventW
extern "C" {
__declspec(dllimport) void * __stdcall TlsGetValue(unsigned long);
__declspec(dllimport) int __stdcall TlsSetValue(unsigned long, void *);
__declspec(dllimport) unsigned long __stdcall TlsAlloc();
}
#else
# include <pthread.h>
# include <signal.h>
#endif
#include "mozilla/Assertions.h"
#include "mozilla/Attributes.h"
namespace mozilla {
// sig_safe_t denotes an atomic type which can be read or stored in a single
// instruction. This means that data of this type is safe to be manipulated
// from a signal handler, or other similar asynchronous execution contexts.
#if defined(XP_WIN)
typedef unsigned long sig_safe_t;
#else
typedef sig_atomic_t sig_safe_t;
#endif
/*
* Thread Local Storage helpers.
*
* Usage:
*
* Only static-storage-duration (e.g. global variables, or static class members)
* objects of this class should be instantiated. This class relies on
* zero-initialization, which is implicit for static-storage-duration objects.
* It doesn't have a custom default constructor, to avoid static initializers.
*
* API usage:
*
* // Create a TLS item
* mozilla::ThreadLocal<int> tlsKey;
* if (!tlsKey.init()) {
* // deal with the error
* }
*
* // Set the TLS value
* tlsKey.set(123);
*
* // Get the TLS value
* int value = tlsKey.get();
*/
template <typename T>
class ThreadLocal
{
#if defined(XP_WIN)
typedef unsigned long key_t;
#else
typedef pthread_key_t key_t;
#endif
public:
MOZ_WARN_UNUSED_RESULT inline bool init();
inline T* get() const;
inline bool set(const T* value);
bool initialized() const {
return inited;
}
private:
key_t key;
bool inited;
};
template <typename T>
inline bool
ThreadLocal<T>::init() {
MOZ_ASSERT(!initialized());
#ifdef XP_WIN
key = TlsAlloc();
inited = key != 0xFFFFFFFFUL; // TLS_OUT_OF_INDEXES
#else
inited = !pthread_key_create(&key, NULL);
#endif
return inited;
}
template <typename T>
inline T*
ThreadLocal<T>::get() const {
MOZ_ASSERT(initialized());
#ifdef XP_WIN
return reinterpret_cast<T*>(TlsGetValue(key));
#else
return reinterpret_cast<T*>(pthread_getspecific(key));
#endif
}
template <typename T>
inline bool
ThreadLocal<T>::set(const T* value) {
MOZ_ASSERT(initialized());
#ifdef XP_WIN
return TlsSetValue(key, const_cast<T*>(value));
#else
return !pthread_setspecific(key, value);
#endif
}
} // namespace mozilla
#endif // mozilla_TLS_h_