fune/xpcom/threads/nsThreadManager.h
Nika Layzell 41458369b2 Bug 1764119 - Part 1: Do final KillClearOnShutdown after XPCOM threads shutdown, r=xpcom-reviewers,kmag,jstutte
This patch moves where we perform the final KillClearOnShutdown to occur
after we've shut down non-main threads, but before the main thread stops
accepting events. This should help ensure that unsuspecting events,
including those triggered from nsIThreadShutdownTask tasks, don't run
after KillClearOnShutdown has been run on background or main threads.

This KillClearOnShutdown was moved to occur before
nsThreadManager::Shutdown() in bug 1637890, as there were examples of
KillClearOnShutdown callbacks which needed to be able to dispatch
main-thread runnables. This change should not regress that use-case, as
we are still accepting new events on the main thread after the callback.

Non-main threads were already unreliable after this call as we already
block normal dispatches by setting gXPCOMThreadsShutdown, and new
threads cannot be started for the background thread pool.

Differential Revision: https://phabricator.services.mozilla.com/D144591
2022-05-02 20:38:43 +00:00

112 lines
3.9 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 nsThreadManager_h__
#define nsThreadManager_h__
#include "nsIThreadManager.h"
#include "nsThread.h"
#include "mozilla/ShutdownPhase.h"
class nsIRunnable;
class nsIEventTarget;
class nsISerialEventTarget;
class nsIThread;
namespace mozilla {
class IdleTaskManager;
class SynchronizedEventQueue;
} // namespace mozilla
class BackgroundEventTarget;
class nsThreadManager : public nsIThreadManager {
public:
NS_DECL_ISUPPORTS
NS_DECL_NSITHREADMANAGER
static nsThreadManager& get();
nsresult Init();
// Shutdown all threads other than the main thread. This function should only
// be called on the main thread of the application process.
void ShutdownNonMainThreads();
// Finish shutting down all threads. This function must be called after
// ShutdownNonMainThreads and will take the main thread out of commission.
void ShutdownMainThread();
// Called by nsThread to inform the ThreadManager it exists. This method
// must be called when the given thread is the current thread.
void RegisterCurrentThread(nsThread& aThread);
// Called by nsThread to inform the ThreadManager it is going away. This
// method must be called when the given thread is the current thread.
void UnregisterCurrentThread(nsThread& aThread);
// Returns the current thread. Returns null if OOM or if ThreadManager isn't
// initialized. Creates the nsThread if one does not exist yet.
nsThread* GetCurrentThread();
// Returns true iff the currently running thread has an nsThread associated
// with it (ie; whether this is a thread that we can dispatch runnables to).
bool IsNSThread() const;
// CreateCurrentThread sets up an nsThread for the current thread. It uses the
// event queue and main thread flags passed in. It should only be called once
// for the current thread. After it returns, GetCurrentThread() will return
// the thread that was created. GetCurrentThread() will also create a thread
// (lazily), but it doesn't allow the queue or main-thread attributes to be
// specified.
nsThread* CreateCurrentThread(mozilla::SynchronizedEventQueue* aQueue,
nsThread::MainThreadFlag aMainThread);
nsresult DispatchToBackgroundThread(nsIRunnable* aEvent,
uint32_t aDispatchFlags);
already_AddRefed<nsISerialEventTarget> CreateBackgroundTaskQueue(
const char* aName);
~nsThreadManager();
void EnableMainThreadEventPrioritization();
void FlushInputEventPrioritization();
void SuspendInputEventPrioritization();
void ResumeInputEventPrioritization();
static bool MainThreadHasPendingHighPriorityEvents();
nsIThread* GetMainThreadWeak() { return mMainThread; }
private:
nsThreadManager();
nsresult SpinEventLoopUntilInternal(
const nsACString& aVeryGoodReasonToDoThis,
nsINestedEventLoopCondition* aCondition,
mozilla::ShutdownPhase aShutdownPhaseToCheck);
static void ReleaseThread(void* aData);
unsigned mCurThreadIndex; // thread-local-storage index
RefPtr<mozilla::IdleTaskManager> mIdleTaskManager;
RefPtr<nsThread> mMainThread;
PRThread* mMainPRThread;
mozilla::Atomic<bool, mozilla::SequentiallyConsistent> mInitialized;
// Shared event target used for background runnables.
RefPtr<BackgroundEventTarget> mBackgroundEventTarget;
};
#define NS_THREADMANAGER_CID \
{ /* 7a4204c6-e45a-4c37-8ebb-6709a22c917c */ \
0x7a4204c6, 0xe45a, 0x4c37, { \
0x8e, 0xbb, 0x67, 0x09, 0xa2, 0x2c, 0x91, 0x7c \
} \
}
#endif // nsThreadManager_h__