gecko/xpcom/glue/MainThreadUtils.h

57 lines
1.7 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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/. */
#ifndef MainThreadUtils_h_
#define MainThreadUtils_h_
#include "nscore.h"
#include "mozilla/threads/nsThreadIDs.h"
class nsIThread;
/**
* Get a reference to the main thread.
*
* @param aResult
* The resulting nsIThread object.
*/
extern NS_COM_GLUE NS_METHOD NS_GetMainThread(nsIThread** aResult);
#ifdef MOZILLA_INTERNAL_API
// Fast access to the current thread. Do not release the returned pointer! If
// you want to use this pointer from some other thread, then you will need to
// AddRef it. Otherwise, you should only consider this pointer valid from code
// running on the current thread.
extern NS_COM_GLUE nsIThread* NS_GetCurrentThread();
#endif
#if defined(MOZILLA_INTERNAL_API) && defined(XP_WIN)
bool NS_IsMainThread();
#elif defined(MOZILLA_INTERNAL_API) && defined(NS_TLS)
// This is defined in nsThreadManager.cpp and initialized to `Main` for the
// main thread by nsThreadManager::Init.
extern NS_TLS mozilla::threads::ID gTLSThreadID;
#ifdef MOZ_ASAN
// Temporary workaround, see bug 895845
MOZ_ASAN_BLACKLIST bool NS_IsMainThread();
#else
inline bool NS_IsMainThread()
{
return gTLSThreadID == mozilla::threads::Main;
}
#endif
#else
/**
* Test to see if the current thread is the main thread.
*
* @returns true if the current thread is the main thread, and false
* otherwise.
*/
extern NS_COM_GLUE bool NS_IsMainThread();
#endif
#endif // MainThreadUtils_h_