37c8ea54eb
Apart from just really cleaning things up and moving everything into one class regarding thread IDs (ie, is_main_thread(), comparing ID's etc), this also fixes an obscure bug where LL was casting thread ID's to U32 and then compared those to find out if it the same thread. It's theoretically possible that such fails on a 64bit OS. By generalizing the interface, I adopted the use of a thread-local cache for the current thread ID as used by LLMutex et al, so now all code benefits from that. The idea was even extended to now also be used for is_main_thread() tests and even resetting a thread ID to the ID of the current thread.
92 lines
3.6 KiB
C++
92 lines
3.6 KiB
C++
/**
|
|
* @file aithreadid.h
|
|
* @brief Declaration of AIThreadID.
|
|
*
|
|
* Copyright (c) 2012, Aleric Inglewood.
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
* There are special exceptions to the terms and conditions of the GPL as
|
|
* it is applied to this Source Code. View the full text of the exception
|
|
* in the file doc/FLOSS-exception.txt in this software distribution.
|
|
*
|
|
* CHANGELOG
|
|
* and additional copyright holders.
|
|
*
|
|
* 08/08/2012
|
|
* Initial version, written by Aleric Inglewood @ SL
|
|
*/
|
|
|
|
#ifndef AI_THREAD_ID
|
|
#define AI_THREAD_ID
|
|
|
|
#include <apr_portable.h> // apr_os_thread_t, apr_os_thread_current(), apr_os_thread_equal().
|
|
#include <iosfwd> // std::ostream.
|
|
#include "llpreprocessor.h" // LL_COMMON_API
|
|
#include "llerror.h"
|
|
|
|
#if LL_WINDOWS
|
|
#define ll_thread_local __declspec(thread)
|
|
#else
|
|
#define ll_thread_local __thread
|
|
#endif
|
|
|
|
// Lightweight wrapper around apr_os_thread_t.
|
|
// This class introduces no extra assembly code after optimization; it's only intend is to provide type-safety.
|
|
class LL_COMMON_API AIThreadID
|
|
{
|
|
private:
|
|
apr_os_thread_t mID;
|
|
static apr_os_thread_t sMainThreadID;
|
|
static apr_os_thread_t const undefinedID = (apr_os_thread_t)-1;
|
|
#ifndef LL_DARWIN
|
|
static ll_thread_local apr_os_thread_t lCurrentThread;
|
|
#endif
|
|
public:
|
|
static AIThreadID const sNone;
|
|
enum undefined_thread_t { none };
|
|
enum dout_print_t { DoutPrint };
|
|
|
|
public:
|
|
AIThreadID(void) : mID(apr_os_thread_current()) { }
|
|
explicit AIThreadID(undefined_thread_t) : mID(undefinedID) { } // Used for sNone.
|
|
AIThreadID(AIThreadID const& id) : mID(id.mID) { }
|
|
AIThreadID& operator=(AIThreadID const& id) { mID = id.mID; return *this; }
|
|
bool is_main_thread(void) const { return apr_os_thread_equal(mID, sMainThreadID); }
|
|
bool is_no_thread(void) const { return apr_os_thread_equal(mID, sNone.mID); }
|
|
friend LL_COMMON_API bool operator==(AIThreadID const& id1, AIThreadID const& id2) { return apr_os_thread_equal(id1.mID, id2.mID); }
|
|
friend LL_COMMON_API bool operator!=(AIThreadID const& id1, AIThreadID const& id2) { return !apr_os_thread_equal(id1.mID, id2.mID); }
|
|
friend LL_COMMON_API std::ostream& operator<<(std::ostream& os, AIThreadID const& id);
|
|
friend LL_COMMON_API std::ostream& operator<<(std::ostream& os, dout_print_t);
|
|
static void set_main_thread_id(void); // Called once to set sMainThreadID.
|
|
static void set_current_thread_id(void); // Called once for every thread to set lCurrentThread.
|
|
#ifdef LL_DARWIN
|
|
void reset(void) { mID = apr_os_thread_current(); }
|
|
bool equals_current_thread(void) const { return apr_os_thread_equal(mID, apr_os_thread_current()); }
|
|
static bool in_main_thread(void) { return apr_os_thread_equal(apr_os_thread_current(), sMainThreadID); }
|
|
#else
|
|
void reset(void) { mID = lCurrentThread; }
|
|
bool equals_current_thread(void) const { return apr_os_thread_equal(mID, lCurrentThread); }
|
|
static bool in_main_thread(void) { return apr_os_thread_equal(lCurrentThread, sMainThreadID); }
|
|
#endif
|
|
};
|
|
|
|
// Legacy function.
|
|
inline bool is_main_thread(void)
|
|
{
|
|
return AIThreadID::in_main_thread();
|
|
}
|
|
|
|
#endif // AI_THREAD_ID
|