2014-06-30 19:39:45 +04:00
|
|
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
|
|
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
|
2012-05-21 15:12:37 +04:00
|
|
|
/* 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/. */
|
2003-01-18 04:27:53 +03:00
|
|
|
|
2006-05-10 21:30:15 +04:00
|
|
|
#ifndef nsThreadPool_h__
|
|
|
|
#define nsThreadPool_h__
|
2003-01-18 04:27:53 +03:00
|
|
|
|
2006-05-10 21:30:15 +04:00
|
|
|
#include "nsIThreadPool.h"
|
|
|
|
#include "nsIThread.h"
|
|
|
|
#include "nsIRunnable.h"
|
|
|
|
#include "nsCOMArray.h"
|
2008-08-12 04:01:47 +04:00
|
|
|
#include "nsCOMPtr.h"
|
2012-06-12 21:06:20 +04:00
|
|
|
#include "nsThreadUtils.h"
|
2012-06-06 03:51:58 +04:00
|
|
|
#include "mozilla/Attributes.h"
|
2015-07-10 06:21:46 +03:00
|
|
|
#include "mozilla/AlreadyAddRefed.h"
|
Bug 1382922 - Refactor event queue to allow multiple implementations (r=erahm)
This patch refactors the nsThread event queue to clean it up and to make it easier to restructure. The fundamental concepts are as follows:
Each nsThread will have a pointer to a refcounted SynchronizedEventQueue. A SynchronizedEQ takes care of doing the locking and condition variable work when posting and popping events. For the actual storage of events, it delegates to an AbstractEventQueue data structure. It keeps a UniquePtr to the AbstractEventQueue that it uses for storage.
Both SynchronizedEQ and AbstractEventQueue are abstract classes. There is only one concrete implementation of SynchronizedEQ in this patch, which is called ThreadEventQueue. ThreadEventQueue uses locks and condition variables to post and pop events the same way nsThread does. It also encapsulates the functionality that DOM workers need to implement their special event loops (PushEventQueue and PopEventQueue). In later Quantum DOM work, I plan to have another SynchronizedEQ implementation for the main thread, called SchedulerEventQueue. It will have special code for the cooperatively scheduling threads in Quantum DOM.
There are two concrete implementations of AbstractEventQueue in this patch: EventQueue and PrioritizedEventQueue. EventQueue replaces the old nsEventQueue. The other AbstractEventQueue implementation is PrioritizedEventQueue, which uses multiple queues for different event priorities.
The final major piece here is ThreadEventTarget, which splits some of the code for posting events out of nsThread. Eventually, my plan is for multiple cooperatively scheduled nsThreads to be able to share a ThreadEventTarget. In this patch, though, each nsThread has its own ThreadEventTarget. The class's purpose is just to collect some related code together.
One final note: I tried to avoid virtual dispatch overhead as much as possible. Calls to SynchronizedEQ methods do use virtual dispatch, since I plan to use different implementations for different threads with Quantum DOM. But all the calls to EventQueue methods should be non-virtual. Although the methods are declared virtual, all the classes used are final and the concrete classes involved should all be known through templatization.
MozReview-Commit-ID: 9Evtr9oIJvx
2017-06-21 05:42:13 +03:00
|
|
|
#include "mozilla/EventQueue.h"
|
2015-09-21 11:34:51 +03:00
|
|
|
#include "mozilla/Mutex.h"
|
2015-09-03 22:38:28 +03:00
|
|
|
#include "mozilla/Monitor.h"
|
2003-01-18 04:27:53 +03:00
|
|
|
|
2015-03-21 19:28:04 +03:00
|
|
|
class nsThreadPool final : public nsIThreadPool, public nsIRunnable {
|
2006-05-10 21:30:15 +04:00
|
|
|
public:
|
2013-07-19 06:31:26 +04:00
|
|
|
NS_DECL_THREADSAFE_ISUPPORTS
|
2017-05-20 06:58:07 +03:00
|
|
|
NS_DECL_NSIEVENTTARGET_FULL
|
2006-05-10 21:30:15 +04:00
|
|
|
NS_DECL_NSITHREADPOOL
|
2013-10-25 08:40:39 +04:00
|
|
|
NS_DECL_NSIRUNNABLE
|
2003-01-18 04:27:53 +03:00
|
|
|
|
2006-05-10 21:30:15 +04:00
|
|
|
nsThreadPool();
|
2003-01-18 04:27:53 +03:00
|
|
|
|
2006-05-10 21:30:15 +04:00
|
|
|
private:
|
|
|
|
~nsThreadPool();
|
|
|
|
|
2014-05-27 11:15:35 +04:00
|
|
|
void ShutdownThread(nsIThread* aThread);
|
|
|
|
nsresult PutEvent(nsIRunnable* aEvent);
|
2016-06-01 03:04:54 +03:00
|
|
|
nsresult PutEvent(already_AddRefed<nsIRunnable> aEvent, uint32_t aFlags);
|
2006-05-10 21:30:15 +04:00
|
|
|
|
2013-10-25 08:40:39 +04:00
|
|
|
nsCOMArray<nsIThread> mThreads;
|
2015-09-21 11:34:51 +03:00
|
|
|
mozilla::Mutex mMutex;
|
2016-11-08 15:05:45 +03:00
|
|
|
mozilla::CondVar mEventsAvailable;
|
Bug 1382922 - Refactor event queue to allow multiple implementations (r=erahm)
This patch refactors the nsThread event queue to clean it up and to make it easier to restructure. The fundamental concepts are as follows:
Each nsThread will have a pointer to a refcounted SynchronizedEventQueue. A SynchronizedEQ takes care of doing the locking and condition variable work when posting and popping events. For the actual storage of events, it delegates to an AbstractEventQueue data structure. It keeps a UniquePtr to the AbstractEventQueue that it uses for storage.
Both SynchronizedEQ and AbstractEventQueue are abstract classes. There is only one concrete implementation of SynchronizedEQ in this patch, which is called ThreadEventQueue. ThreadEventQueue uses locks and condition variables to post and pop events the same way nsThread does. It also encapsulates the functionality that DOM workers need to implement their special event loops (PushEventQueue and PopEventQueue). In later Quantum DOM work, I plan to have another SynchronizedEQ implementation for the main thread, called SchedulerEventQueue. It will have special code for the cooperatively scheduling threads in Quantum DOM.
There are two concrete implementations of AbstractEventQueue in this patch: EventQueue and PrioritizedEventQueue. EventQueue replaces the old nsEventQueue. The other AbstractEventQueue implementation is PrioritizedEventQueue, which uses multiple queues for different event priorities.
The final major piece here is ThreadEventTarget, which splits some of the code for posting events out of nsThread. Eventually, my plan is for multiple cooperatively scheduled nsThreads to be able to share a ThreadEventTarget. In this patch, though, each nsThread has its own ThreadEventTarget. The class's purpose is just to collect some related code together.
One final note: I tried to avoid virtual dispatch overhead as much as possible. Calls to SynchronizedEQ methods do use virtual dispatch, since I plan to use different implementations for different threads with Quantum DOM. But all the calls to EventQueue methods should be non-virtual. Although the methods are declared virtual, all the classes used are final and the concrete classes involved should all be known through templatization.
MozReview-Commit-ID: 9Evtr9oIJvx
2017-06-21 05:42:13 +03:00
|
|
|
mozilla::EventQueue mEvents;
|
2012-08-22 19:56:38 +04:00
|
|
|
uint32_t mThreadLimit;
|
|
|
|
uint32_t mIdleThreadLimit;
|
|
|
|
uint32_t mIdleThreadTimeout;
|
|
|
|
uint32_t mIdleCount;
|
2014-02-18 02:53:53 +04:00
|
|
|
uint32_t mStackSize;
|
2008-08-12 04:01:47 +04:00
|
|
|
nsCOMPtr<nsIThreadPoolListener> mListener;
|
2011-09-29 10:19:26 +04:00
|
|
|
bool mShutdown;
|
2019-03-19 17:35:12 +03:00
|
|
|
bool mRegressiveMaxIdleTime;
|
2012-06-12 21:06:20 +04:00
|
|
|
nsCString mName;
|
|
|
|
nsThreadPoolNaming mThreadNaming;
|
2006-05-10 21:30:15 +04:00
|
|
|
};
|
|
|
|
|
|
|
|
#define NS_THREADPOOL_CID \
|
|
|
|
{ /* 547ec2a8-315e-4ec4-888e-6e4264fe90eb */ \
|
|
|
|
0x547ec2a8, 0x315e, 0x4ec4, { \
|
|
|
|
0x88, 0x8e, 0x6e, 0x42, 0x64, 0xfe, 0x90, 0xeb \
|
|
|
|
} \
|
2003-01-18 04:27:53 +03:00
|
|
|
}
|
|
|
|
|
2006-05-10 21:30:15 +04:00
|
|
|
#endif // nsThreadPool_h__
|