/* * Written by Doug Lea with assistance from members of JCP JSR-166 * Expert Group and released to the public domain, as explained at * http://creativecommons.org/licenses/publicdomain */ package jsr166y; import java.util.*; import java.util.concurrent.*; import java.util.concurrent.locks.*; import java.util.concurrent.atomic.*; import sun.misc.Unsafe; import java.lang.reflect.*; /** * An {@link ExecutorService} for running {@link ForkJoinTask}s. A * ForkJoinPool provides the entry point for submissions from * non-ForkJoinTasks, as well as management and monitoring operations. * Normally a single ForkJoinPool is used for a large number of * submitted tasks. Otherwise, use would not usually outweigh the * construction and bookkeeping overhead of creating a large set of * threads. * *
ForkJoinPools differ from other kinds of Executors mainly in * that they provide work-stealing: all threads in the pool * attempt to find and execute subtasks created by other active tasks * (eventually blocking if none exist). This makes them efficient when * most tasks spawn other subtasks (as do most ForkJoinTasks), as well * as the mixed execution of some plain Runnable- or Callable- based * activities along with ForkJoinTasks. When setting * setAsyncMode, a ForkJoinPools may also be appropriate for * use with fine-grained tasks that are never joined. Otherwise, other * ExecutorService implementations are typically more appropriate * choices. * *
A ForkJoinPool may be constructed with a given parallelism level
* (target pool size), which it attempts to maintain by dynamically
* adding, suspending, or resuming threads, even if some tasks are
* waiting to join others. However, no such adjustments are performed
* in the face of blocked IO or other unmanaged synchronization. The
* nested ManagedBlocker
interface enables extension of
* the kinds of synchronization accommodated. The target parallelism
* level may also be changed dynamically (setParallelism
)
* and thread construction can be limited using methods
* setMaximumPoolSize
and/or
* setMaintainsParallelism
.
*
*
In addition to execution and lifecycle control methods, this
* class provides status check methods (for example
* getStealCount
) that are intended to aid in developing,
* tuning, and monitoring fork/join applications. Also, method
* toString
returns indications of pool state in a
* convenient form for informal monitoring.
*
*
Implementation notes: This implementation restricts the
* maximum number of running threads to 32767. Attempts to create
* pools with greater than the maximum result in
* IllegalArgumentExceptions.
*/
public class ForkJoinPool extends AbstractExecutorService {
/*
* See the extended comments interspersed below for design,
* rationale, and walkthroughs.
*/
/** Mask for packing and unpacking shorts */
private static final int shortMask = 0xffff;
/** Max pool size -- must be a power of two minus 1 */
private static final int MAX_THREADS = 0x7FFF;
/**
* Factory for creating new ForkJoinWorkerThreads. A
* ForkJoinWorkerThreadFactory must be defined and used for
* ForkJoinWorkerThread subclasses that extend base functionality
* or initialize threads with different contexts.
*/
public static interface ForkJoinWorkerThreadFactory {
/**
* Returns a new worker thread operating in the given pool.
*
* @param pool the pool this thread works in
* @throws NullPointerException if pool is null;
*/
public ForkJoinWorkerThread newThread(ForkJoinPool pool);
}
/**
* Default ForkJoinWorkerThreadFactory implementation, creates a
* new ForkJoinWorkerThread.
*/
static class DefaultForkJoinWorkerThreadFactory
implements ForkJoinWorkerThreadFactory {
public ForkJoinWorkerThread newThread(ForkJoinPool pool) {
try {
return new ForkJoinWorkerThread(pool);
} catch (OutOfMemoryError oom) {
return null;
}
}
}
/**
* Creates a new ForkJoinWorkerThread. This factory is used unless
* overridden in ForkJoinPool constructors.
*/
public static final ForkJoinWorkerThreadFactory
defaultForkJoinWorkerThreadFactory =
new DefaultForkJoinWorkerThreadFactory();
/**
* Permission required for callers of methods that may start or
* kill threads.
*/
private static final RuntimePermission modifyThreadPermission =
new RuntimePermission("modifyThread");
/**
* If there is a security manager, makes sure caller has
* permission to modify threads.
*/
private static void checkPermission() {
SecurityManager security = System.getSecurityManager();
if (security != null)
security.checkPermission(modifyThreadPermission);
}
/**
* Generator for assigning sequence numbers as pool names.
*/
private static final AtomicInteger poolNumberGenerator =
new AtomicInteger();
/**
* Array holding all worker threads in the pool. Initialized upon
* first use. Array size must be a power of two. Updates and
* replacements are protected by workerLock, but it is always kept
* in a consistent enough state to be randomly accessed without
* locking by workers performing work-stealing.
*/
volatile ForkJoinWorkerThread[] workers;
/**
* Lock protecting access to workers.
*/
private final ReentrantLock workerLock;
/**
* Condition for awaitTermination.
*/
private final Condition termination;
/**
* The uncaught exception handler used when any worker
* abrupty terminates
*/
private Thread.UncaughtExceptionHandler ueh;
/**
* Creation factory for worker threads.
*/
private final ForkJoinWorkerThreadFactory factory;
/**
* Head of stack of threads that were created to maintain
* parallelism when other threads blocked, but have since
* suspended when the parallelism level rose.
*/
private volatile WaitQueueNode spareStack;
/**
* Sum of per-thread steal counts, updated only when threads are
* idle or terminating.
*/
private final AtomicLong stealCount;
/**
* Queue for external submissions.
*/
private final LinkedTransferQueue For example, here is a ManagedBlocker based on a
* ReentrantLock:
* If the caller is not a ForkJoinTask, this method is behaviorally
* equivalent to
* ("modifyThread")
,
*/
public ForkJoinPool() {
this(Runtime.getRuntime().availableProcessors(),
defaultForkJoinWorkerThreadFactory);
}
/**
* Creates a ForkJoinPool with the indicated parellelism level
* threads, and using the default ForkJoinWorkerThreadFactory,
* @param parallelism the number of worker threads
* @throws IllegalArgumentException if parallelism less than or
* equal to zero
* @throws SecurityException if a security manager exists and
* the caller is not permitted to modify threads
* because it does not hold {@link
* java.lang.RuntimePermission}("modifyThread")
,
*/
public ForkJoinPool(int parallelism) {
this(parallelism, defaultForkJoinWorkerThreadFactory);
}
/**
* Creates a ForkJoinPool with parallelism equal to the number of
* processors available on the system and using the given
* ForkJoinWorkerThreadFactory,
* @param factory the factory for creating new threads
* @throws NullPointerException if factory is null
* @throws SecurityException if a security manager exists and
* the caller is not permitted to modify threads
* because it does not hold {@link
* java.lang.RuntimePermission}("modifyThread")
,
*/
public ForkJoinPool(ForkJoinWorkerThreadFactory factory) {
this(Runtime.getRuntime().availableProcessors(), factory);
}
/**
* Creates a ForkJoinPool with the given parallelism and factory.
*
* @param parallelism the targeted number of worker threads
* @param factory the factory for creating new threads
* @throws IllegalArgumentException if parallelism less than or
* equal to zero, or greater than implementation limit.
* @throws NullPointerException if factory is null
* @throws SecurityException if a security manager exists and
* the caller is not permitted to modify threads
* because it does not hold {@link
* java.lang.RuntimePermission}("modifyThread")
,
*/
public ForkJoinPool(int parallelism, ForkJoinWorkerThreadFactory factory) {
if (parallelism <= 0 || parallelism > MAX_THREADS)
throw new IllegalArgumentException();
if (factory == null)
throw new NullPointerException();
checkPermission();
this.factory = factory;
this.parallelism = parallelism;
this.maxPoolSize = MAX_THREADS;
this.maintainsParallelism = true;
this.poolNumber = poolNumberGenerator.incrementAndGet();
this.workerLock = new ReentrantLock();
this.termination = workerLock.newCondition();
this.stealCount = new AtomicLong();
this.submissionQueue = new LinkedTransferQueue("modifyThread")
,
*/
public Thread.UncaughtExceptionHandler
setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler h) {
checkPermission();
Thread.UncaughtExceptionHandler old = null;
final ReentrantLock lock = this.workerLock;
lock.lock();
try {
old = ueh;
ueh = h;
ForkJoinWorkerThread[] ws = workers;
if (ws != null) {
for (int i = 0; i < ws.length; ++i) {
ForkJoinWorkerThread w = ws[i];
if (w != null)
w.setUncaughtExceptionHandler(h);
}
}
} finally {
lock.unlock();
}
return old;
}
/**
* Sets the target paralleism level of this pool.
* @param parallelism the target parallelism
* @throws IllegalArgumentException if parallelism less than or
* equal to zero or greater than maximum size bounds.
* @throws SecurityException if a security manager exists and
* the caller is not permitted to modify threads
* because it does not hold {@link
* java.lang.RuntimePermission}("modifyThread")
,
*/
public void setParallelism(int parallelism) {
checkPermission();
if (parallelism <= 0 || parallelism > maxPoolSize)
throw new IllegalArgumentException();
final ReentrantLock lock = this.workerLock;
lock.lock();
try {
if (!isTerminating()) {
int p = this.parallelism;
this.parallelism = parallelism;
if (parallelism > p)
createAndStartAddedWorkers();
else
trimSpares();
}
} finally {
lock.unlock();
}
signalIdleWorkers();
}
/**
* Returns the targeted number of worker threads in this pool.
*
* @return the targeted number of worker threads in this pool
*/
public int getParallelism() {
return parallelism;
}
/**
* Returns the number of worker threads that have started but not
* yet terminated. This result returned by this method may differ
* from getParallelism
when threads are created to
* maintain parallelism when others are cooperatively blocked.
*
* @return the number of worker threads
*/
public int getPoolSize() {
return totalCountOf(workerCounts);
}
/**
* Returns the maximum number of threads allowed to exist in the
* pool, even if there are insufficient unblocked running threads.
* @return the maximum
*/
public int getMaximumPoolSize() {
return maxPoolSize;
}
/**
* Sets the maximum number of threads allowed to exist in the
* pool, even if there are insufficient unblocked running threads.
* Setting this value has no effect on current pool size. It
* controls construction of new threads.
* @throws IllegalArgumentException if negative or greater then
* internal implementation limit.
*/
public void setMaximumPoolSize(int newMax) {
if (newMax < 0 || newMax > MAX_THREADS)
throw new IllegalArgumentException();
maxPoolSize = newMax;
}
/**
* Returns true if this pool dynamically maintains its target
* parallelism level. If false, new threads are added only to
* avoid possible starvation.
* This setting is by default true;
* @return true if maintains parallelism
*/
public boolean getMaintainsParallelism() {
return maintainsParallelism;
}
/**
* Sets whether this pool dynamically maintains its target
* parallelism level. If false, new threads are added only to
* avoid possible starvation.
* @param enable true to maintains parallelism
*/
public void setMaintainsParallelism(boolean enable) {
maintainsParallelism = enable;
}
/**
* Establishes local first-in-first-out scheduling mode for forked
* tasks that are never joined. This mode may be more appropriate
* than default locally stack-based mode in applications in which
* worker threads only process asynchronous tasks. This method is
* designed to be invoked only when pool is quiescent, and
* typically only before any tasks are submitted. The effects of
* invocations at ather times may be unpredictable.
*
* @param async if true, use locally FIFO scheduling
* @return the previous mode.
*/
public boolean setAsyncMode(boolean async) {
boolean oldMode = locallyFifo;
locallyFifo = async;
ForkJoinWorkerThread[] ws = workers;
if (ws != null) {
for (int i = 0; i < ws.length; ++i) {
ForkJoinWorkerThread t = ws[i];
if (t != null)
t.setAsyncMode(async);
}
}
return oldMode;
}
/**
* Returns true if this pool uses local first-in-first-out
* scheduling mode for forked tasks that are never joined.
*
* @return true if this pool uses async mode.
*/
public boolean getAsyncMode() {
return locallyFifo;
}
/**
* Returns an estimate of the number of worker threads that are
* not blocked waiting to join tasks or for other managed
* synchronization.
*
* @return the number of worker threads
*/
public int getRunningThreadCount() {
return runningCountOf(workerCounts);
}
/**
* Returns an estimate of the number of threads that are currently
* stealing or executing tasks. This method may overestimate the
* number of active threads.
* @return the number of active threads.
*/
public int getActiveThreadCount() {
return activeCountOf(runControl);
}
/**
* Returns an estimate of the number of threads that are currently
* idle waiting for tasks. This method may underestimate the
* number of idle threads.
* @return the number of idle threads.
*/
final int getIdleThreadCount() {
int c = runningCountOf(workerCounts) - activeCountOf(runControl);
return (c <= 0)? 0 : c;
}
/**
* Returns true if all worker threads are currently idle. An idle
* worker is one that cannot obtain a task to execute because none
* are available to steal from other threads, and there are no
* pending submissions to the pool. This method is conservative:
* It might not return true immediately upon idleness of all
* threads, but will eventually become true if threads remain
* inactive.
* @return true if all threads are currently idle
*/
public boolean isQuiescent() {
return activeCountOf(runControl) == 0;
}
/**
* Returns an estimate of the total number of tasks stolen from
* one thread's work queue by another. The reported value
* underestimates the actual total number of steals when the pool
* is not quiescent. This value may be useful for monitoring and
* tuning fork/join programs: In general, steal counts should be
* high enough to keep threads busy, but low enough to avoid
* overhead and contention across threads.
* @return the number of steals.
*/
public long getStealCount() {
return stealCount.get();
}
/**
* Accumulate steal count from a worker. Call only
* when worker known to be idle.
*/
private void updateStealCount(ForkJoinWorkerThread w) {
int sc = w.getAndClearStealCount();
if (sc != 0)
stealCount.addAndGet(sc);
}
/**
* Returns an estimate of the total number of tasks currently held
* in queues by worker threads (but not including tasks submitted
* to the pool that have not begun executing). This value is only
* an approximation, obtained by iterating across all threads in
* the pool. This method may be useful for tuning task
* granularities.
* @return the number of queued tasks.
*/
public long getQueuedTaskCount() {
long count = 0;
ForkJoinWorkerThread[] ws = workers;
if (ws != null) {
for (int i = 0; i < ws.length; ++i) {
ForkJoinWorkerThread t = ws[i];
if (t != null)
count += t.getQueueSize();
}
}
return count;
}
/**
* Returns an estimate of the number tasks submitted to this pool
* that have not yet begun executing. This method takes time
* proportional to the number of submissions.
* @return the number of queued submissions.
*/
public int getQueuedSubmissionCount() {
return submissionQueue.size();
}
/**
* Returns true if there are any tasks submitted to this pool
* that have not yet begun executing.
* @return true
if there are any queued submissions.
*/
public boolean hasQueuedSubmissions() {
return !submissionQueue.isEmpty();
}
/**
* Removes and returns the next unexecuted submission if one is
* available. This method may be useful in extensions to this
* class that re-assign work in systems with multiple pools.
* @return the next submission, or null if none
*/
protected ForkJoinTask> pollSubmission() {
return submissionQueue.poll();
}
/**
* Removes all available unexecuted submitted and forked tasks
* from scheduling queues and adds them to the given collection,
* without altering their execution status. These may include
* artifically generated or wrapped tasks. This method id designed
* to be invoked only when the pool is known to be
* quiescent. Invocations at other times may not remove all
* tasks. A failure encountered while attempting to add elements
* to collection c may result in elements being in
* neither, either or both collections when the associated
* exception is thrown. The behavior of this operation is
* undefined if the specified collection is modified while the
* operation is in progress.
* @param c the collection to transfer elements into
* @return the number of elements transferred
*/
protected int drainTasksTo(Collection("modifyThread")
,
*/
public void shutdown() {
checkPermission();
transitionRunStateTo(SHUTDOWN);
if (canTerminateOnShutdown(runControl))
terminateOnShutdown();
}
/**
* Attempts to stop all actively executing tasks, and cancels all
* waiting tasks. Tasks that are in the process of being
* submitted or executed concurrently during the course of this
* method may or may not be rejected. Unlike some other executors,
* this method cancels rather than collects non-executed tasks
* upon termination, so always returns an empty list. However, you
* can use method drainTasksTo
before invoking this
* method to transfer unexecuted tasks to another collection.
* @return an empty list
* @throws SecurityException if a security manager exists and
* the caller is not permitted to modify threads
* because it does not hold {@link
* java.lang.RuntimePermission}("modifyThread")
,
*/
public Listtrue
if all tasks have completed following shut down.
*
* @return true
if all tasks have completed following shut down
*/
public boolean isTerminated() {
return runStateOf(runControl) == TERMINATED;
}
/**
* Returns true
if the process of termination has
* commenced but possibly not yet completed.
*
* @return true
if terminating
*/
public boolean isTerminating() {
return runStateOf(runControl) >= TERMINATING;
}
/**
* Returns true
if this pool has been shut down.
*
* @return true
if this pool has been shut down
*/
public boolean isShutdown() {
return runStateOf(runControl) >= SHUTDOWN;
}
/**
* Blocks until all tasks have completed execution after a shutdown
* request, or the timeout occurs, or the current thread is
* interrupted, whichever happens first.
*
* @param timeout the maximum time to wait
* @param unit the time unit of the timeout argument
* @return true
if this executor terminated and
* false
if the timeout elapsed before termination
* @throws InterruptedException if interrupted while waiting
*/
public boolean awaitTermination(long timeout, TimeUnit unit)
throws InterruptedException {
long nanos = unit.toNanos(timeout);
final ReentrantLock lock = this.workerLock;
lock.lock();
try {
for (;;) {
if (isTerminated())
return true;
if (nanos <= 0)
return false;
nanos = termination.awaitNanos(nanos);
}
} finally {
lock.unlock();
}
}
// Shutdown and termination support
/**
* Callback from terminating worker. Null out the corresponding
* workers slot, and if terminating, try to terminate, else try to
* shrink workers array.
* @param w the worker
*/
final void workerTerminated(ForkJoinWorkerThread w) {
updateStealCount(w);
updateWorkerCount(-1);
final ReentrantLock lock = this.workerLock;
lock.lock();
try {
ForkJoinWorkerThread[] ws = workers;
if (ws != null) {
int idx = w.poolIndex;
if (idx >= 0 && idx < ws.length && ws[idx] == w)
ws[idx] = null;
if (totalCountOf(workerCounts) == 0) {
terminate(); // no-op if already terminating
transitionRunStateTo(TERMINATED);
termination.signalAll();
}
else if (!isTerminating()) {
tryShrinkWorkerArray();
tryResumeSpare(true); // allow replacement
}
}
} finally {
lock.unlock();
}
signalIdleWorkers();
}
/**
* Initiate termination.
*/
private void terminate() {
if (transitionRunStateTo(TERMINATING)) {
stopAllWorkers();
resumeAllSpares();
signalIdleWorkers();
cancelQueuedSubmissions();
cancelQueuedWorkerTasks();
interruptUnterminatedWorkers();
signalIdleWorkers(); // resignal after interrupt
}
}
/**
* Possibly terminate when on shutdown state
*/
private void terminateOnShutdown() {
if (!hasQueuedSubmissions() && canTerminateOnShutdown(runControl))
terminate();
}
/**
* Clear out and cancel submissions
*/
private void cancelQueuedSubmissions() {
ForkJoinTask> task;
while ((task = pollSubmission()) != null)
task.cancel(false);
}
/**
* Clean out worker queues.
*/
private void cancelQueuedWorkerTasks() {
final ReentrantLock lock = this.workerLock;
lock.lock();
try {
ForkJoinWorkerThread[] ws = workers;
if (ws != null) {
for (int i = 0; i < ws.length; ++i) {
ForkJoinWorkerThread t = ws[i];
if (t != null)
t.cancelTasks();
}
}
} finally {
lock.unlock();
}
}
/**
* Set each worker's status to terminating. Requires lock to avoid
* conflicts with add/remove
*/
private void stopAllWorkers() {
final ReentrantLock lock = this.workerLock;
lock.lock();
try {
ForkJoinWorkerThread[] ws = workers;
if (ws != null) {
for (int i = 0; i < ws.length; ++i) {
ForkJoinWorkerThread t = ws[i];
if (t != null)
t.shutdownNow();
}
}
} finally {
lock.unlock();
}
}
/**
* Interrupt all unterminated workers. This is not required for
* sake of internal control, but may help unstick user code during
* shutdown.
*/
private void interruptUnterminatedWorkers() {
final ReentrantLock lock = this.workerLock;
lock.lock();
try {
ForkJoinWorkerThread[] ws = workers;
if (ws != null) {
for (int i = 0; i < ws.length; ++i) {
ForkJoinWorkerThread t = ws[i];
if (t != null && !t.isTerminated()) {
try {
t.interrupt();
} catch (SecurityException ignore) {
}
}
}
}
} finally {
lock.unlock();
}
}
/*
* Nodes for event barrier to manage idle threads. Queue nodes
* are basic Treiber stack nodes, also used for spare stack.
*
* The event barrier has an event count and a wait queue (actually
* a Treiber stack). Workers are enabled to look for work when
* the eventCount is incremented. If they fail to find work, they
* may wait for next count. Upon release, threads help others wake
* up.
*
* Synchronization events occur only in enough contexts to
* maintain overall liveness:
*
* - Submission of a new task to the pool
* - Resizes or other changes to the workers array
* - pool termination
* - A worker pushing a task on an empty queue
*
* The case of pushing a task occurs often enough, and is heavy
* enough compared to simple stack pushes, to require special
* handling: Method signalWork returns without advancing count if
* the queue appears to be empty. This would ordinarily result in
* races causing some queued waiters not to be woken up. To avoid
* this, the first worker enqueued in method sync (see
* syncIsReleasable) rescans for tasks after being enqueued, and
* helps signal if any are found. This works well because the
* worker has nothing better to do, and so might as well help
* alleviate the overhead and contention on the threads actually
* doing work. Also, since event counts increments on task
* availability exist to maintain liveness (rather than to force
* refreshes etc), it is OK for callers to exit early if
* contending with another signaller.
*/
static final class WaitQueueNode {
WaitQueueNode next; // only written before enqueued
volatile ForkJoinWorkerThread thread; // nulled to cancel wait
final long count; // unused for spare stack
WaitQueueNode(long c, ForkJoinWorkerThread w) {
count = c;
thread = w;
}
/**
* Wake up waiter, returning false if known to already
*/
boolean signal() {
ForkJoinWorkerThread t = thread;
if (t == null)
return false;
thread = null;
LockSupport.unpark(t);
return true;
}
/**
* Await release on sync
*/
void awaitSyncRelease(ForkJoinPool p) {
while (thread != null && !p.syncIsReleasable(this))
LockSupport.park(this);
}
/**
* Await resumption as spare
*/
void awaitSpareRelease() {
while (thread != null) {
if (!Thread.interrupted())
LockSupport.park(this);
}
}
}
/**
* Ensures that no thread is waiting for count to advance from the
* current value of eventCount read on entry to this method, by
* releasing waiting threads if necessary.
* @return the count
*/
final long ensureSync() {
long c = eventCount;
WaitQueueNode q;
while ((q = syncStack) != null && q.count < c) {
if (casBarrierStack(q, null)) {
do {
q.signal();
} while ((q = q.next) != null);
break;
}
}
return c;
}
/**
* Increments event count and releases waiting threads.
*/
private void signalIdleWorkers() {
long c;
do;while (!casEventCount(c = eventCount, c+1));
ensureSync();
}
/**
* Signal threads waiting to poll a task. Because method sync
* rechecks availability, it is OK to only proceed if queue
* appears to be non-empty, and OK to skip under contention to
* increment count (since some other thread succeeded).
*/
final void signalWork() {
long c;
WaitQueueNode q;
if (syncStack != null &&
casEventCount(c = eventCount, c+1) &&
(((q = syncStack) != null && q.count <= c) &&
(!casBarrierStack(q, q.next) || !q.signal())))
ensureSync();
}
/**
* Waits until event count advances from last value held by
* caller, or if excess threads, caller is resumed as spare, or
* caller or pool is terminating. Updates caller's event on exit.
* @param w the calling worker thread
*/
final void sync(ForkJoinWorkerThread w) {
updateStealCount(w); // Transfer w's count while it is idle
while (!w.isShutdown() && !isTerminating() && !suspendIfSpare(w)) {
long prev = w.lastEventCount;
WaitQueueNode node = null;
WaitQueueNode h;
while (eventCount == prev &&
((h = syncStack) == null || h.count == prev)) {
if (node == null)
node = new WaitQueueNode(prev, w);
if (casBarrierStack(node.next = h, node)) {
node.awaitSyncRelease(this);
break;
}
}
long ec = ensureSync();
if (ec != prev) {
w.lastEventCount = ec;
break;
}
}
}
/**
* Returns true if worker waiting on sync can proceed:
* - on signal (thread == null)
* - on event count advance (winning race to notify vs signaller)
* - on Interrupt
* - if the first queued node, we find work available
* If node was not signalled and event count not advanced on exit,
* then we also help advance event count.
* @return true if node can be released
*/
final boolean syncIsReleasable(WaitQueueNode node) {
long prev = node.count;
if (!Thread.interrupted() && node.thread != null &&
(node.next != null ||
!ForkJoinWorkerThread.hasQueuedTasks(workers)) &&
eventCount == prev)
return false;
if (node.thread != null) {
node.thread = null;
long ec = eventCount;
if (prev <= ec) // help signal
casEventCount(ec, ec+1);
}
return true;
}
/**
* Returns true if a new sync event occurred since last call to
* sync or this method, if so, updating caller's count.
*/
final boolean hasNewSyncEvent(ForkJoinWorkerThread w) {
long lc = w.lastEventCount;
long ec = ensureSync();
if (ec == lc)
return false;
w.lastEventCount = ec;
return true;
}
// Parallelism maintenance
/**
* Decrement running count; if too low, add spare.
*
* Conceptually, all we need to do here is add or resume a
* spare thread when one is about to block (and remove or
* suspend it later when unblocked -- see suspendIfSpare).
* However, implementing this idea requires coping with
* several problems: We have imperfect information about the
* states of threads. Some count updates can and usually do
* lag run state changes, despite arrangements to keep them
* accurate (for example, when possible, updating counts
* before signalling or resuming), especially when running on
* dynamic JVMs that don't optimize the infrequent paths that
* update counts. Generating too many threads can make these
* problems become worse, because excess threads are more
* likely to be context-switched with others, slowing them all
* down, especially if there is no work available, so all are
* busy scanning or idling. Also, excess spare threads can
* only be suspended or removed when they are idle, not
* immediately when they aren't needed. So adding threads will
* raise parallelism level for longer than necessary. Also,
* FJ applications often enounter highly transient peaks when
* many threads are blocked joining, but for less time than it
* takes to create or resume spares.
*
* @param joinMe if non-null, return early if done
* @param maintainParallelism if true, try to stay within
* target counts, else create only to avoid starvation
* @return true if joinMe known to be done
*/
final boolean preJoin(ForkJoinTask> joinMe, boolean maintainParallelism) {
maintainParallelism &= maintainsParallelism; // overrride
boolean dec = false; // true when running count decremented
while (spareStack == null || !tryResumeSpare(dec)) {
int counts = workerCounts;
if (dec || (dec = casWorkerCounts(counts, --counts))) { // CAS cheat
if (!needSpare(counts, maintainParallelism))
break;
if (joinMe.status < 0)
return true;
if (tryAddSpare(counts))
break;
}
}
return false;
}
/**
* Same idea as preJoin
*/
final boolean preBlock(ManagedBlocker blocker, boolean maintainParallelism){
maintainParallelism &= maintainsParallelism;
boolean dec = false;
while (spareStack == null || !tryResumeSpare(dec)) {
int counts = workerCounts;
if (dec || (dec = casWorkerCounts(counts, --counts))) {
if (!needSpare(counts, maintainParallelism))
break;
if (blocker.isReleasable())
return true;
if (tryAddSpare(counts))
break;
}
}
return false;
}
/**
* Returns true if a spare thread appears to be needed. If
* maintaining parallelism, returns true when the deficit in
* running threads is more than the surplus of total threads, and
* there is apparently some work to do. This self-limiting rule
* means that the more threads that have already been added, the
* less parallelism we will tolerate before adding another.
* @param counts current worker counts
* @param maintainParallelism try to maintain parallelism
*/
private boolean needSpare(int counts, boolean maintainParallelism) {
int ps = parallelism;
int rc = runningCountOf(counts);
int tc = totalCountOf(counts);
int runningDeficit = ps - rc;
int totalSurplus = tc - ps;
return (tc < maxPoolSize &&
(rc == 0 || totalSurplus < 0 ||
(maintainParallelism &&
runningDeficit > totalSurplus &&
ForkJoinWorkerThread.hasQueuedTasks(workers))));
}
/**
* Add a spare worker if lock available and no more than the
* expected numbers of threads exist
* @return true if successful
*/
private boolean tryAddSpare(int expectedCounts) {
final ReentrantLock lock = this.workerLock;
int expectedRunning = runningCountOf(expectedCounts);
int expectedTotal = totalCountOf(expectedCounts);
boolean success = false;
boolean locked = false;
// confirm counts while locking; CAS after obtaining lock
try {
for (;;) {
int s = workerCounts;
int tc = totalCountOf(s);
int rc = runningCountOf(s);
if (rc > expectedRunning || tc > expectedTotal)
break;
if (!locked && !(locked = lock.tryLock()))
break;
if (casWorkerCounts(s, workerCountsFor(tc+1, rc+1))) {
createAndStartSpare(tc);
success = true;
break;
}
}
} finally {
if (locked)
lock.unlock();
}
return success;
}
/**
* Add the kth spare worker. On entry, pool coounts are already
* adjusted to reflect addition.
*/
private void createAndStartSpare(int k) {
ForkJoinWorkerThread w = null;
ForkJoinWorkerThread[] ws = ensureWorkerArrayCapacity(k + 1);
int len = ws.length;
// Probably, we can place at slot k. If not, find empty slot
if (k < len && ws[k] != null) {
for (k = 0; k < len && ws[k] != null; ++k)
;
}
if (k < len && !isTerminating() && (w = createWorker(k)) != null) {
ws[k] = w;
w.start();
}
else
updateWorkerCount(-1); // adjust on failure
signalIdleWorkers();
}
/**
* Suspend calling thread w if there are excess threads. Called
* only from sync. Spares are enqueued in a Treiber stack
* using the same WaitQueueNodes as barriers. They are resumed
* mainly in preJoin, but are also woken on pool events that
* require all threads to check run state.
* @param w the caller
*/
private boolean suspendIfSpare(ForkJoinWorkerThread w) {
WaitQueueNode node = null;
int s;
while (parallelism < runningCountOf(s = workerCounts)) {
if (node == null)
node = new WaitQueueNode(0, w);
if (casWorkerCounts(s, s-1)) { // representation-dependent
// push onto stack
do;while (!casSpareStack(node.next = spareStack, node));
// block until released by resumeSpare
node.awaitSpareRelease();
return true;
}
}
return false;
}
/**
* Try to pop and resume a spare thread.
* @param updateCount if true, increment running count on success
* @return true if successful
*/
private boolean tryResumeSpare(boolean updateCount) {
WaitQueueNode q;
while ((q = spareStack) != null) {
if (casSpareStack(q, q.next)) {
if (updateCount)
updateRunningCount(1);
q.signal();
return true;
}
}
return false;
}
/**
* Pop and resume all spare threads. Same idea as ensureSync.
* @return true if any spares released
*/
private boolean resumeAllSpares() {
WaitQueueNode q;
while ( (q = spareStack) != null) {
if (casSpareStack(q, null)) {
do {
updateRunningCount(1);
q.signal();
} while ((q = q.next) != null);
return true;
}
}
return false;
}
/**
* Pop and shutdown excessive spare threads. Call only while
* holding lock. This is not guaranteed to eliminate all excess
* threads, only those suspended as spares, which are the ones
* unlikely to be needed in the future.
*/
private void trimSpares() {
int surplus = totalCountOf(workerCounts) - parallelism;
WaitQueueNode q;
while (surplus > 0 && (q = spareStack) != null) {
if (casSpareStack(q, null)) {
do {
updateRunningCount(1);
ForkJoinWorkerThread w = q.thread;
if (w != null && surplus > 0 &&
runningCountOf(workerCounts) > 0 && w.shutdown())
--surplus;
q.signal();
} while ((q = q.next) != null);
}
}
}
/**
* Interface for extending managed parallelism for tasks running
* in ForkJoinPools. A ManagedBlocker provides two methods.
* Method isReleasable
must return true if blocking is not
* necessary. Method block
blocks the current thread
* if necessary (perhaps internally invoking isReleasable before
* actually blocking.).
*
* class ManagedLocker implements ManagedBlocker {
* final ReentrantLock lock;
* boolean hasLock = false;
* ManagedLocker(ReentrantLock lock) { this.lock = lock; }
* public boolean block() {
* if (!hasLock)
* lock.lock();
* return true;
* }
* public boolean isReleasable() {
* return hasLock || (hasLock = lock.tryLock());
* }
* }
*
*/
public static interface ManagedBlocker {
/**
* Possibly blocks the current thread, for example waiting for
* a lock or condition.
* @return true if no additional blocking is necessary (i.e.,
* if isReleasable would return true).
* @throws InterruptedException if interrupted while waiting
* (the method is not required to do so, but is allowe to).
*/
boolean block() throws InterruptedException;
/**
* Returns true if blocking is unnecessary.
*/
boolean isReleasable();
}
/**
* Blocks in accord with the given blocker. If the current thread
* is a ForkJoinWorkerThread, this method possibly arranges for a
* spare thread to be activated if necessary to ensure parallelism
* while the current thread is blocked. If
* maintainParallelism
is true and the pool supports
* it ({@link #getMaintainsParallelism}), this method attempts to
* maintain the pool's nominal parallelism. Otherwise if activates
* a thread only if necessary to avoid complete starvation. This
* option may be preferable when blockages use timeouts, or are
* almost always brief.
*
*
* while (!blocker.isReleasable())
* if (blocker.block())
* return;
*
* If the caller is a ForkJoinTask, then the pool may first
* be expanded to ensure parallelism, and later adjusted.
*
* @param blocker the blocker
* @param maintainParallelism if true and supported by this pool,
* attempt to maintain the pool's nominal parallelism; otherwise
* activate a thread only if necessary to avoid complete
* starvation.
* @throws InterruptedException if blocker.block did so.
*/
public static void managedBlock(ManagedBlocker blocker,
boolean maintainParallelism)
throws InterruptedException {
Thread t = Thread.currentThread();
ForkJoinPool pool = (t instanceof ForkJoinWorkerThread?
((ForkJoinWorkerThread)t).pool : null);
if (!blocker.isReleasable()) {
try {
if (pool == null ||
!pool.preBlock(blocker, maintainParallelism))
awaitBlocker(blocker);
} finally {
if (pool != null)
pool.updateRunningCount(1);
}
}
}
private static void awaitBlocker(ManagedBlocker blocker)
throws InterruptedException {
do;while (!blocker.isReleasable() && !blocker.block());
}
// AbstractExecutorService overrides
protected