ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/main/java/util/concurrent/ForkJoinPool.java
Revision: 1.297
Committed: Sun Nov 22 20:27:33 2015 UTC (8 years, 6 months ago) by dl
Branch: MAIN
Changes since 1.296: +7 -4 lines
Log Message:
restrengthen external pop checks

File Contents

# User Rev Content
1 jsr166 1.1 /*
2     * Written by Doug Lea with assistance from members of JCP JSR-166
3     * Expert Group and released to the public domain, as explained at
4 jsr166 1.58 * http://creativecommons.org/publicdomain/zero/1.0/
5 jsr166 1.1 */
6    
7     package java.util.concurrent;
8    
9 jsr166 1.156 import java.lang.Thread.UncaughtExceptionHandler;
10 jsr166 1.228 import java.security.AccessControlContext;
11     import java.security.Permissions;
12     import java.security.ProtectionDomain;
13 jsr166 1.1 import java.util.ArrayList;
14     import java.util.Arrays;
15     import java.util.Collection;
16     import java.util.Collections;
17     import java.util.List;
18 dl 1.262 import java.util.concurrent.locks.ReentrantLock;
19 dl 1.243 import java.util.concurrent.locks.LockSupport;
20 jsr166 1.1
21     /**
22 jsr166 1.4 * An {@link ExecutorService} for running {@link ForkJoinTask}s.
23 jsr166 1.8 * A {@code ForkJoinPool} provides the entry point for submissions
24 dl 1.18 * from non-{@code ForkJoinTask} clients, as well as management and
25 jsr166 1.11 * monitoring operations.
26 jsr166 1.1 *
27 jsr166 1.9 * <p>A {@code ForkJoinPool} differs from other kinds of {@link
28     * ExecutorService} mainly by virtue of employing
29     * <em>work-stealing</em>: all threads in the pool attempt to find and
30 dl 1.78 * execute tasks submitted to the pool and/or created by other active
31     * tasks (eventually blocking waiting for work if none exist). This
32     * enables efficient processing when most tasks spawn other subtasks
33     * (as do most {@code ForkJoinTask}s), as well as when many small
34     * tasks are submitted to the pool from external clients. Especially
35     * when setting <em>asyncMode</em> to true in constructors, {@code
36     * ForkJoinPool}s may also be appropriate for use with event-style
37     * tasks that are never joined.
38 jsr166 1.1 *
39 dl 1.112 * <p>A static {@link #commonPool()} is available and appropriate for
40 dl 1.101 * most applications. The common pool is used by any ForkJoinTask that
41     * is not explicitly submitted to a specified pool. Using the common
42     * pool normally reduces resource usage (its threads are slowly
43     * reclaimed during periods of non-use, and reinstated upon subsequent
44 dl 1.105 * use).
45 dl 1.100 *
46     * <p>For applications that require separate or custom pools, a {@code
47     * ForkJoinPool} may be constructed with a given target parallelism
48 jsr166 1.214 * level; by default, equal to the number of available processors.
49     * The pool attempts to maintain enough active (or available) threads
50     * by dynamically adding, suspending, or resuming internal worker
51 jsr166 1.187 * threads, even if some tasks are stalled waiting to join others.
52     * However, no such adjustments are guaranteed in the face of blocked
53     * I/O or other unmanaged synchronization. The nested {@link
54 dl 1.100 * ManagedBlocker} interface enables extension of the kinds of
55 dl 1.18 * synchronization accommodated.
56 jsr166 1.1 *
57     * <p>In addition to execution and lifecycle control methods, this
58     * class provides status check methods (for example
59 jsr166 1.4 * {@link #getStealCount}) that are intended to aid in developing,
60 jsr166 1.1 * tuning, and monitoring fork/join applications. Also, method
61 jsr166 1.4 * {@link #toString} returns indications of pool state in a
62 jsr166 1.1 * convenient form for informal monitoring.
63     *
64 jsr166 1.109 * <p>As is the case with other ExecutorServices, there are three
65 jsr166 1.84 * main task execution methods summarized in the following table.
66     * These are designed to be used primarily by clients not already
67     * engaged in fork/join computations in the current pool. The main
68     * forms of these methods accept instances of {@code ForkJoinTask},
69     * but overloaded forms also allow mixed execution of plain {@code
70     * Runnable}- or {@code Callable}- based activities as well. However,
71     * tasks that are already executing in a pool should normally instead
72     * use the within-computation forms listed in the table unless using
73     * async event-style tasks that are not usually joined, in which case
74     * there is little difference among choice of methods.
75 dl 1.18 *
76     * <table BORDER CELLPADDING=3 CELLSPACING=1>
77 jsr166 1.159 * <caption>Summary of task execution methods</caption>
78 dl 1.18 * <tr>
79     * <td></td>
80     * <td ALIGN=CENTER> <b>Call from non-fork/join clients</b></td>
81     * <td ALIGN=CENTER> <b>Call from within fork/join computations</b></td>
82     * </tr>
83     * <tr>
84 jsr166 1.153 * <td> <b>Arrange async execution</b></td>
85 dl 1.18 * <td> {@link #execute(ForkJoinTask)}</td>
86     * <td> {@link ForkJoinTask#fork}</td>
87     * </tr>
88     * <tr>
89 jsr166 1.153 * <td> <b>Await and obtain result</b></td>
90 dl 1.18 * <td> {@link #invoke(ForkJoinTask)}</td>
91     * <td> {@link ForkJoinTask#invoke}</td>
92     * </tr>
93     * <tr>
94 jsr166 1.153 * <td> <b>Arrange exec and obtain Future</b></td>
95 dl 1.18 * <td> {@link #submit(ForkJoinTask)}</td>
96     * <td> {@link ForkJoinTask#fork} (ForkJoinTasks <em>are</em> Futures)</td>
97     * </tr>
98     * </table>
99 dl 1.19 *
100 dl 1.105 * <p>The common pool is by default constructed with default
101 jsr166 1.155 * parameters, but these may be controlled by setting three
102 jsr166 1.162 * {@linkplain System#getProperty system properties}:
103     * <ul>
104     * <li>{@code java.util.concurrent.ForkJoinPool.common.parallelism}
105     * - the parallelism level, a non-negative integer
106     * <li>{@code java.util.concurrent.ForkJoinPool.common.threadFactory}
107     * - the class name of a {@link ForkJoinWorkerThreadFactory}
108     * <li>{@code java.util.concurrent.ForkJoinPool.common.exceptionHandler}
109     * - the class name of a {@link UncaughtExceptionHandler}
110 dl 1.208 * <li>{@code java.util.concurrent.ForkJoinPool.common.maximumSpares}
111 dl 1.223 * - the maximum number of allowed extra threads to maintain target
112 dl 1.208 * parallelism (default 256).
113 jsr166 1.162 * </ul>
114 dl 1.197 * If a {@link SecurityManager} is present and no factory is
115     * specified, then the default pool uses a factory supplying
116     * threads that have no {@link Permissions} enabled.
117 jsr166 1.165 * The system class loader is used to load these classes.
118 jsr166 1.156 * Upon any error in establishing these settings, default parameters
119 dl 1.160 * are used. It is possible to disable or limit the use of threads in
120     * the common pool by setting the parallelism property to zero, and/or
121 dl 1.193 * using a factory that may return {@code null}. However doing so may
122     * cause unjoined tasks to never be executed.
123 dl 1.105 *
124 jsr166 1.1 * <p><b>Implementation notes</b>: This implementation restricts the
125     * maximum number of running threads to 32767. Attempts to create
126 jsr166 1.11 * pools with greater than the maximum number result in
127 jsr166 1.8 * {@code IllegalArgumentException}.
128 jsr166 1.1 *
129 jsr166 1.11 * <p>This implementation rejects submitted tasks (that is, by throwing
130 dl 1.19 * {@link RejectedExecutionException}) only when the pool is shut down
131 dl 1.20 * or internal resources have been exhausted.
132 jsr166 1.11 *
133 jsr166 1.1 * @since 1.7
134     * @author Doug Lea
135     */
136 jsr166 1.171 @sun.misc.Contended
137 jsr166 1.1 public class ForkJoinPool extends AbstractExecutorService {
138    
139     /*
140 dl 1.14 * Implementation Overview
141     *
142 dl 1.78 * This class and its nested classes provide the main
143     * functionality and control for a set of worker threads:
144 jsr166 1.84 * Submissions from non-FJ threads enter into submission queues.
145     * Workers take these tasks and typically split them into subtasks
146     * that may be stolen by other workers. Preference rules give
147     * first priority to processing tasks from their own queues (LIFO
148     * or FIFO, depending on mode), then to randomized FIFO steals of
149 dl 1.200 * tasks in other queues. This framework began as vehicle for
150     * supporting tree-structured parallelism using work-stealing.
151     * Over time, its scalability advantages led to extensions and
152 dl 1.208 * changes to better support more diverse usage contexts. Because
153     * most internal methods and nested classes are interrelated,
154     * their main rationale and descriptions are presented here;
155     * individual methods and nested classes contain only brief
156     * comments about details.
157 dl 1.78 *
158 jsr166 1.84 * WorkQueues
159 dl 1.78 * ==========
160     *
161     * Most operations occur within work-stealing queues (in nested
162     * class WorkQueue). These are special forms of Deques that
163     * support only three of the four possible end-operations -- push,
164     * pop, and poll (aka steal), under the further constraints that
165     * push and pop are called only from the owning thread (or, as
166     * extended here, under a lock), while poll may be called from
167     * other threads. (If you are unfamiliar with them, you probably
168     * want to read Herlihy and Shavit's book "The Art of
169     * Multiprocessor programming", chapter 16 describing these in
170     * more detail before proceeding.) The main work-stealing queue
171     * design is roughly similar to those in the papers "Dynamic
172     * Circular Work-Stealing Deque" by Chase and Lev, SPAA 2005
173     * (http://research.sun.com/scalable/pubs/index.html) and
174     * "Idempotent work stealing" by Michael, Saraswat, and Vechev,
175     * PPoPP 2009 (http://portal.acm.org/citation.cfm?id=1504186).
176 dl 1.200 * The main differences ultimately stem from GC requirements that
177     * we null out taken slots as soon as we can, to maintain as small
178     * a footprint as possible even in programs generating huge
179     * numbers of tasks. To accomplish this, we shift the CAS
180     * arbitrating pop vs poll (steal) from being on the indices
181     * ("base" and "top") to the slots themselves.
182     *
183 dl 1.243 * Adding tasks then takes the form of a classic array push(task)
184     * in a circular buffer:
185     * q.array[q.top++ % length] = task;
186 dl 1.200 *
187     * (The actual code needs to null-check and size-check the array,
188 jsr166 1.247 * uses masking, not mod, for indexing a power-of-two-sized array,
189 dl 1.243 * properly fences accesses, and possibly signals waiting workers
190     * to start scanning -- see below.) Both a successful pop and
191     * poll mainly entail a CAS of a slot from non-null to null.
192 dl 1.200 *
193 jsr166 1.202 * The pop operation (always performed by owner) is:
194 dl 1.243 * if ((the task at top slot is not null) and
195 dl 1.200 * (CAS slot to null))
196     * decrement top and return task;
197     *
198     * And the poll operation (usually by a stealer) is
199 dl 1.243 * if ((the task at base slot is not null) and
200 dl 1.200 * (CAS slot to null))
201     * increment base and return task;
202     *
203 dl 1.243 * There are several variants of each of these; for example most
204 jsr166 1.247 * versions of poll pre-screen the CAS by rechecking that the base
205 dl 1.243 * has not changed since reading the slot, and most methods only
206     * attempt the CAS if base appears not to be equal to top.
207     *
208     * Memory ordering. See "Correct and Efficient Work-Stealing for
209     * Weak Memory Models" by Le, Pop, Cohen, and Nardelli, PPoPP 2013
210     * (http://www.di.ens.fr/~zappa/readings/ppopp13.pdf) for an
211     * analysis of memory ordering requirements in work-stealing
212     * algorithms similar to (but different than) the one used here.
213     * Extracting tasks in array slots via (fully fenced) CAS provides
214     * primary synchronization. The base and top indices imprecisely
215     * guide where to extract from. We do not always require strict
216     * orderings of array and index updates, so sometimes let them be
217     * subject to compiler and processor reorderings. However, the
218     * volatile "base" index also serves as a basis for memory
219     * ordering: Slot accesses are preceded by a read of base,
220 jsr166 1.247 * ensuring happens-before ordering with respect to stealers (so
221 dl 1.243 * the slots themselves can be read via plain array reads.) The
222     * only other memory orderings relied on are maintained in the
223     * course of signalling and activation (see below). A check that
224     * base == top indicates (momentary) emptiness, but otherwise may
225     * err on the side of possibly making the queue appear nonempty
226     * when a push, pop, or poll have not fully committed, or making
227     * it appear empty when an update of top has not yet been visibly
228     * written. (Method isEmpty() checks the case of a partially
229 dl 1.211 * completed removal of the last element.) Because of this, the
230     * poll operation, considered individually, is not wait-free. One
231     * thief cannot successfully continue until another in-progress
232 dl 1.243 * one (or, if previously empty, a push) visibly completes.
233     * However, in the aggregate, we ensure at least probabilistic
234     * non-blockingness. If an attempted steal fails, a scanning
235     * thief chooses a different random victim target to try next. So,
236     * in order for one thief to progress, it suffices for any
237 dl 1.205 * in-progress poll or new push on any empty queue to
238     * complete. (This is why we normally use method pollAt and its
239     * variants that try once at the apparent base index, else
240     * consider alternative actions, rather than method poll, which
241     * retries.)
242 dl 1.200 *
243     * This approach also enables support of a user mode in which
244     * local task processing is in FIFO, not LIFO order, simply by
245     * using poll rather than pop. This can be useful in
246     * message-passing frameworks in which tasks are never joined.
247 dl 1.78 *
248     * WorkQueues are also used in a similar way for tasks submitted
249     * to the pool. We cannot mix these tasks in the same queues used
250 dl 1.200 * by workers. Instead, we randomly associate submission queues
251 dl 1.83 * with submitting threads, using a form of hashing. The
252 dl 1.139 * ThreadLocalRandom probe value serves as a hash code for
253     * choosing existing queues, and may be randomly repositioned upon
254     * contention with other submitters. In essence, submitters act
255     * like workers except that they are restricted to executing local
256     * tasks that they submitted (or in the case of CountedCompleters,
257 dl 1.200 * others with the same root task). Insertion of tasks in shared
258 dl 1.243 * mode requires a lock but we use only a simple spinlock (using
259     * field qlock), because submitters encountering a busy queue move
260     * on to try or create other queues -- they block only when
261     * creating and registering new queues. Because it is used only as
262     * a spinlock, unlocking requires only a "releasing" store (using
263     * putOrderedInt). The qlock is also used during termination
264 jsr166 1.247 * detection, in which case it is forced to a negative
265 jsr166 1.269 * non-lockable value.
266 dl 1.78 *
267 jsr166 1.84 * Management
268 dl 1.78 * ==========
269 dl 1.52 *
270     * The main throughput advantages of work-stealing stem from
271     * decentralized control -- workers mostly take tasks from
272 dl 1.200 * themselves or each other, at rates that can exceed a billion
273     * per second. The pool itself creates, activates (enables
274     * scanning for and running tasks), deactivates, blocks, and
275     * terminates threads, all with minimal central information.
276     * There are only a few properties that we can globally track or
277     * maintain, so we pack them into a small number of variables,
278     * often maintaining atomicity without blocking or locking.
279     * Nearly all essentially atomic control state is held in two
280     * volatile variables that are by far most often read (not
281 dl 1.215 * written) as status and consistency checks. (Also, field
282     * "config" holds unchanging configuration state.)
283 dl 1.78 *
284 dl 1.200 * Field "ctl" contains 64 bits holding information needed to
285     * atomically decide to add, inactivate, enqueue (on an event
286 dl 1.78 * queue), dequeue, and/or re-activate workers. To enable this
287     * packing, we restrict maximum parallelism to (1<<15)-1 (which is
288     * far in excess of normal operating range) to allow ids, counts,
289     * and their negations (used for thresholding) to fit into 16bit
290 dl 1.215 * subfields.
291     *
292 dl 1.294 * Field "runState" holds lifetime status, atomically and
293     * monotonically setting STARTED, SHUTDOWN, STOP, and finally
294     * TERMINATED bits.
295 dl 1.262 *
296     * Field "auxState" is a ReentrantLock subclass that also
297     * opportunistically holds some other bookkeeping fields accessed
298     * only when locked. It is mainly used to lock (infrequent)
299 dl 1.294 * updates to workQueues. The auxState instance is itself lazily
300     * constructed (see tryInitialize), requiring a double-check-style
301     * bootstrapping use of field runState, and locking a private
302     * static.
303 dl 1.258 *
304     * Field "workQueues" holds references to WorkQueues. It is
305 dl 1.262 * updated (only during worker creation and termination) under the
306     * lock, but is otherwise concurrently readable, and accessed
307     * directly. We also ensure that reads of the array reference
308     * itself never become too stale (for example, re-reading before
309     * each scan). To simplify index-based operations, the array size
310     * is always a power of two, and all readers must tolerate null
311     * slots. Worker queues are at odd indices. Shared (submission)
312     * queues are at even indices, up to a maximum of 64 slots, to
313     * limit growth even if array needs to expand to add more
314     * workers. Grouping them together in this way simplifies and
315     * speeds up task scanning.
316 dl 1.86 *
317     * All worker thread creation is on-demand, triggered by task
318     * submissions, replacement of terminated workers, and/or
319 dl 1.78 * compensation for blocked workers. However, all other support
320     * code is set up to work with other policies. To ensure that we
321 jsr166 1.264 * do not hold on to worker references that would prevent GC, all
322 dl 1.78 * accesses to workQueues are via indices into the workQueues
323     * array (which is one source of some of the messy code
324     * constructions here). In essence, the workQueues array serves as
325 dl 1.200 * a weak reference mechanism. Thus for example the stack top
326     * subfield of ctl stores indices, not references.
327     *
328     * Queuing Idle Workers. Unlike HPC work-stealing frameworks, we
329     * cannot let workers spin indefinitely scanning for tasks when
330     * none can be found immediately, and we cannot start/resume
331     * workers unless there appear to be tasks available. On the
332     * other hand, we must quickly prod them into action when new
333     * tasks are submitted or generated. In many usages, ramp-up time
334     * to activate workers is the main limiting factor in overall
335     * performance, which is compounded at program start-up by JIT
336     * compilation and allocation. So we streamline this as much as
337     * possible.
338     *
339     * The "ctl" field atomically maintains active and total worker
340     * counts as well as a queue to place waiting threads so they can
341     * be located for signalling. Active counts also play the role of
342     * quiescence indicators, so are decremented when workers believe
343     * that there are no more tasks to execute. The "queue" is
344     * actually a form of Treiber stack. A stack is ideal for
345     * activating threads in most-recently used order. This improves
346     * performance and locality, outweighing the disadvantages of
347     * being prone to contention and inability to release a worker
348 dl 1.243 * unless it is topmost on stack. We block/unblock workers after
349 dl 1.200 * pushing on the idle worker stack (represented by the lower
350     * 32bit subfield of ctl) when they cannot find work. The top
351     * stack state holds the value of the "scanState" field of the
352     * worker: its index and status, plus a version counter that, in
353     * addition to the count subfields (also serving as version
354     * stamps) provide protection against Treiber stack ABA effects.
355     *
356     * Creating workers. To create a worker, we pre-increment total
357     * count (serving as a reservation), and attempt to construct a
358     * ForkJoinWorkerThread via its factory. Upon construction, the
359     * new thread invokes registerWorker, where it constructs a
360     * WorkQueue and is assigned an index in the workQueues array
361 jsr166 1.266 * (expanding the array if necessary). The thread is then started.
362     * Upon any exception across these steps, or null return from
363     * factory, deregisterWorker adjusts counts and records
364 dl 1.200 * accordingly. If a null return, the pool continues running with
365     * fewer than the target number workers. If exceptional, the
366     * exception is propagated, generally to some external caller.
367     * Worker index assignment avoids the bias in scanning that would
368     * occur if entries were sequentially packed starting at the front
369     * of the workQueues array. We treat the array as a simple
370     * power-of-two hash table, expanding as needed. The seedIndex
371     * increment ensures no collisions until a resize is needed or a
372     * worker is deregistered and replaced, and thereafter keeps
373 jsr166 1.202 * probability of collision low. We cannot use
374 dl 1.200 * ThreadLocalRandom.getProbe() for similar purposes here because
375     * the thread has not started yet, but do so for creating
376 dl 1.243 * submission queues for existing external threads (see
377     * externalPush).
378     *
379     * WorkQueue field scanState is used by both workers and the pool
380     * to manage and track whether a worker is UNSIGNALLED (possibly
381     * blocked waiting for a signal). When a worker is inactivated,
382     * its scanState field is set, and is prevented from executing
383     * tasks, even though it must scan once for them to avoid queuing
384     * races. Note that scanState updates lag queue CAS releases so
385     * usage requires care. When queued, the lower 16 bits of
386     * scanState must hold its pool index. So we place the index there
387     * upon initialization (see registerWorker) and otherwise keep it
388     * there or restore it when necessary.
389     *
390     * The ctl field also serves as the basis for memory
391     * synchronization surrounding activation. This uses a more
392     * efficient version of a Dekker-like rule that task producers and
393     * consumers sync with each other by both writing/CASing ctl (even
394 dl 1.253 * if to its current value). This would be extremely costly. So
395     * we relax it in several ways: (1) Producers only signal when
396     * their queue is empty. Other workers propagate this signal (in
397     * method scan) when they find tasks. (2) Workers only enqueue
398     * after scanning (see below) and not finding any tasks. (3)
399     * Rather than CASing ctl to its current value in the common case
400     * where no action is required, we reduce write contention by
401     * equivalently prefacing signalWork when called by an external
402     * task producer using a memory access with full-volatile
403 dl 1.256 * semantics or a "fullFence". (4) For internal task producers we
404     * rely on the fact that even if no other workers awaken, the
405     * producer itself will eventually see the task and execute it.
406 dl 1.243 *
407 jsr166 1.249 * Almost always, too many signals are issued. A task producer
408 dl 1.243 * cannot in general tell if some existing worker is in the midst
409     * of finishing one task (or already scanning) and ready to take
410     * another without being signalled. So the producer might instead
411     * activate a different worker that does not find any work, and
412     * then inactivates. This scarcely matters in steady-state
413     * computations involving all workers, but can create contention
414 jsr166 1.247 * and bookkeeping bottlenecks during ramp-up, ramp-down, and small
415 dl 1.243 * computations involving only a few workers.
416     *
417     * Scanning. Method scan() performs top-level scanning for tasks.
418     * Each scan traverses (and tries to poll from) each queue in
419     * pseudorandom permutation order by randomly selecting an origin
420     * index and a step value. (The pseudorandom generator need not
421     * have high-quality statistical properties in the long term, but
422     * just within computations; We use 64bit and 32bit Marsaglia
423     * XorShifts, which are cheap and suffice here.) Scanning also
424     * employs contention reduction: When scanning workers fail a CAS
425     * polling for work, they soon restart with a different
426     * pseudorandom scan order (thus likely retrying at different
427     * intervals). This improves throughput when many threads are
428     * trying to take tasks from few queues. Scans do not otherwise
429     * explicitly take into account core affinities, loads, cache
430     * localities, etc, However, they do exploit temporal locality
431 dl 1.253 * (which usually approximates these) by preferring to re-poll (up
432     * to POLL_LIMIT times) from the same queue after a successful
433     * poll before trying others. Restricted forms of scanning occur
434     * in methods helpComplete and findNonEmptyStealQueue, and take
435     * similar but simpler forms.
436 dl 1.200 *
437 jsr166 1.202 * Deactivation and waiting. Queuing encounters several intrinsic
438 jsr166 1.267 * races; most notably that an inactivating scanning worker can
439 dl 1.243 * miss seeing a task produced during a scan. So when a worker
440     * cannot find a task to steal, it inactivates and enqueues, and
441     * then rescans to ensure that it didn't miss one, reactivating
442     * upon seeing one with probability approximately proportional to
443     * probability of a miss. (In most cases, the worker will be
444     * signalled before self-signalling, avoiding cascades of multiple
445     * signals for the same task).
446     *
447     * Workers block (in method awaitWork) using park/unpark;
448     * advertising the need for signallers to unpark by setting their
449     * "parker" fields.
450 dl 1.52 *
451     * Trimming workers. To release resources after periods of lack of
452     * use, a worker starting to wait when the pool is quiescent will
453 dl 1.208 * time out and terminate (see awaitWork) if the pool has remained
454 jsr166 1.268 * quiescent for period given by IDLE_TIMEOUT_MS, increasing the
455     * period as the number of threads decreases, eventually removing
456     * all workers.
457 dl 1.52 *
458 dl 1.210 * Shutdown and Termination. A call to shutdownNow invokes
459     * tryTerminate to atomically set a runState bit. The calling
460     * thread, as well as every other worker thereafter terminating,
461     * helps terminate others by setting their (qlock) status,
462     * cancelling their unprocessed tasks, and waking them up, doing
463 dl 1.294 * so repeatedly until stable. Calls to non-abrupt shutdown()
464 jsr166 1.295 * preface this by checking whether termination should commence.
465     * This relies primarily on the active count bits of "ctl"
466     * maintaining consensus -- tryTerminate is called from awaitWork
467     * whenever quiescent. However, external submitters do not take
468     * part in this consensus. So, tryTerminate sweeps through queues
469     * (until stable) to ensure lack of in-flight submissions and
470     * workers about to process them before triggering the "STOP"
471     * phase of termination. (Note: there is an intrinsic conflict if
472     * helpQuiescePool is called when shutdown is enabled. Both wait
473     * for quiescence, but tryTerminate is biased to not trigger until
474     * helpQuiescePool completes.)
475 dl 1.211 *
476 jsr166 1.84 * Joining Tasks
477     * =============
478 dl 1.78 *
479     * Any of several actions may be taken when one worker is waiting
480 jsr166 1.84 * to join a task stolen (or always held) by another. Because we
481 dl 1.78 * are multiplexing many tasks on to a pool of workers, we can't
482     * just let them block (as in Thread.join). We also cannot just
483     * reassign the joiner's run-time stack with another and replace
484     * it later, which would be a form of "continuation", that even if
485 dl 1.200 * possible is not necessarily a good idea since we may need both
486     * an unblocked task and its continuation to progress. Instead we
487     * combine two tactics:
488 dl 1.19 *
489     * Helping: Arranging for the joiner to execute some task that it
490 dl 1.78 * would be running if the steal had not occurred.
491 dl 1.19 *
492     * Compensating: Unless there are already enough live threads,
493 dl 1.78 * method tryCompensate() may create or re-activate a spare
494     * thread to compensate for blocked joiners until they unblock.
495     *
496 dl 1.105 * A third form (implemented in tryRemoveAndExec) amounts to
497     * helping a hypothetical compensator: If we can readily tell that
498     * a possible action of a compensator is to steal and execute the
499     * task being joined, the joining thread can do so directly,
500     * without the need for a compensation thread (although at the
501     * expense of larger run-time stacks, but the tradeoff is
502     * typically worthwhile).
503 dl 1.52 *
504     * The ManagedBlocker extension API can't use helping so relies
505     * only on compensation in method awaitBlocker.
506 dl 1.19 *
507 dl 1.200 * The algorithm in helpStealer entails a form of "linear
508     * helping". Each worker records (in field currentSteal) the most
509     * recent task it stole from some other worker (or a submission).
510     * It also records (in field currentJoin) the task it is currently
511     * actively joining. Method helpStealer uses these markers to try
512     * to find a worker to help (i.e., steal back a task from and
513     * execute it) that could hasten completion of the actively joined
514     * task. Thus, the joiner executes a task that would be on its
515     * own local deque had the to-be-joined task not been stolen. This
516     * is a conservative variant of the approach described in Wagner &
517 dl 1.78 * Calder "Leapfrogging: a portable technique for implementing
518     * efficient futures" SIGPLAN Notices, 1993
519     * (http://portal.acm.org/citation.cfm?id=155354). It differs in
520     * that: (1) We only maintain dependency links across workers upon
521     * steals, rather than use per-task bookkeeping. This sometimes
522 dl 1.90 * requires a linear scan of workQueues array to locate stealers,
523     * but often doesn't because stealers leave hints (that may become
524 dl 1.112 * stale/wrong) of where to locate them. It is only a hint
525     * because a worker might have had multiple steals and the hint
526     * records only one of them (usually the most current). Hinting
527     * isolates cost to when it is needed, rather than adding to
528     * per-task overhead. (2) It is "shallow", ignoring nesting and
529     * potentially cyclic mutual steals. (3) It is intentionally
530 dl 1.78 * racy: field currentJoin is updated only while actively joining,
531     * which means that we miss links in the chain during long-lived
532     * tasks, GC stalls etc (which is OK since blocking in such cases
533     * is usually a good idea). (4) We bound the number of attempts
534 dl 1.200 * to find work using checksums and fall back to suspending the
535 dl 1.90 * worker and if necessary replacing it with another.
536 dl 1.78 *
537 dl 1.200 * Helping actions for CountedCompleters do not require tracking
538     * currentJoins: Method helpComplete takes and executes any task
539 jsr166 1.202 * with the same root as the task being waited on (preferring
540     * local pops to non-local polls). However, this still entails
541     * some traversal of completer chains, so is less efficient than
542     * using CountedCompleters without explicit joins.
543 dl 1.105 *
544 dl 1.200 * Compensation does not aim to keep exactly the target
545     * parallelism number of unblocked threads running at any given
546     * time. Some previous versions of this class employed immediate
547     * compensations for any blocked join. However, in practice, the
548     * vast majority of blockages are transient byproducts of GC and
549     * other JVM or OS activities that are made worse by replacement.
550     * Currently, compensation is attempted only after validating that
551     * all purportedly active threads are processing tasks by checking
552     * field WorkQueue.scanState, which eliminates most false
553     * positives. Also, compensation is bypassed (tolerating fewer
554     * threads) in the most common case in which it is rarely
555     * beneficial: when a worker with an empty queue (thus no
556     * continuation tasks) blocks on a join and there still remain
557 dl 1.208 * enough threads to ensure liveness.
558 dl 1.105 *
559 dl 1.243 * Spare threads are removed as soon as they notice that the
560     * target parallelism level has been exceeded, in method
561     * tryDropSpare. (Method scan arranges returns for rechecks upon
562 jsr166 1.247 * each probe via the "bound" parameter.)
563 dl 1.243 *
564 dl 1.211 * The compensation mechanism may be bounded. Bounds for the
565 jsr166 1.273 * commonPool (see COMMON_MAX_SPARES) better enable JVMs to cope
566 dl 1.208 * with programming errors and abuse before running out of
567     * resources to do so. In other cases, users may supply factories
568     * that limit thread construction. The effects of bounding in this
569     * pool (like all others) is imprecise. Total worker counts are
570     * decremented when threads deregister, not when they exit and
571     * resources are reclaimed by the JVM and OS. So the number of
572     * simultaneously live threads may transiently exceed bounds.
573 dl 1.205 *
574 dl 1.105 * Common Pool
575     * ===========
576     *
577 jsr166 1.175 * The static common pool always exists after static
578 dl 1.105 * initialization. Since it (or any other created pool) need
579     * never be used, we minimize initial construction overhead and
580     * footprint to the setup of about a dozen fields, with no nested
581     * allocation. Most bootstrapping occurs within method
582 dl 1.200 * externalSubmit during the first submission to the pool.
583 dl 1.105 *
584     * When external threads submit to the common pool, they can
585 dl 1.200 * perform subtask processing (see externalHelpComplete and
586     * related methods) upon joins. This caller-helps policy makes it
587     * sensible to set common pool parallelism level to one (or more)
588     * less than the total number of available cores, or even zero for
589     * pure caller-runs. We do not need to record whether external
590     * submissions are to the common pool -- if not, external help
591     * methods return quickly. These submitters would otherwise be
592     * blocked waiting for completion, so the extra effort (with
593     * liberally sprinkled task status checks) in inapplicable cases
594     * amounts to an odd form of limited spin-wait before blocking in
595     * ForkJoinTask.join.
596 dl 1.105 *
597 dl 1.197 * As a more appropriate default in managed environments, unless
598     * overridden by system properties, we use workers of subclass
599     * InnocuousForkJoinWorkerThread when there is a SecurityManager
600     * present. These workers have no permissions set, do not belong
601     * to any user-defined ThreadGroup, and erase all ThreadLocals
602 dl 1.200 * after executing any top-level task (see WorkQueue.runTask).
603     * The associated mechanics (mainly in ForkJoinWorkerThread) may
604     * be JVM-dependent and must access particular Thread class fields
605     * to achieve this effect.
606 jsr166 1.198 *
607 dl 1.105 * Style notes
608     * ===========
609     *
610 dl 1.200 * Memory ordering relies mainly on Unsafe intrinsics that carry
611     * the further responsibility of explicitly performing null- and
612     * bounds- checks otherwise carried out implicitly by JVMs. This
613     * can be awkward and ugly, but also reflects the need to control
614     * outcomes across the unusual cases that arise in very racy code
615     * with very few invariants. So these explicit checks would exist
616     * in some form anyway. All fields are read into locals before
617     * use, and null-checked if they are references. This is usually
618     * done in a "C"-like style of listing declarations at the heads
619     * of methods or blocks, and using inline assignments on first
620     * encounter. Array bounds-checks are usually performed by
621     * masking with array.length-1, which relies on the invariant that
622     * these arrays are created with positive lengths, which is itself
623     * paranoically checked. Nearly all explicit checks lead to
624     * bypass/return, not exception throws, because they may
625     * legitimately arise due to cancellation/revocation during
626     * shutdown.
627     *
628 dl 1.105 * There is a lot of representation-level coupling among classes
629     * ForkJoinPool, ForkJoinWorkerThread, and ForkJoinTask. The
630     * fields of WorkQueue maintain data structures managed by
631     * ForkJoinPool, so are directly accessed. There is little point
632     * trying to reduce this, since any associated future changes in
633     * representations will need to be accompanied by algorithmic
634     * changes anyway. Several methods intrinsically sprawl because
635 dl 1.200 * they must accumulate sets of consistent reads of fields held in
636     * local variables. There are also other coding oddities
637     * (including several unnecessary-looking hoisted null checks)
638     * that help some methods perform reasonably even when interpreted
639     * (not compiled).
640 dl 1.52 *
641 dl 1.208 * The order of declarations in this file is (with a few exceptions):
642 dl 1.86 * (1) Static utility functions
643     * (2) Nested (static) classes
644     * (3) Static fields
645     * (4) Fields, along with constants used when unpacking some of them
646     * (5) Internal control methods
647     * (6) Callbacks and other support for ForkJoinTask methods
648     * (7) Exported methods
649     * (8) Static block initializing statics in minimally dependent order
650     */
651    
652     // Static utilities
653    
654     /**
655     * If there is a security manager, makes sure caller has
656     * permission to modify threads.
657 jsr166 1.1 */
658 dl 1.86 private static void checkPermission() {
659     SecurityManager security = System.getSecurityManager();
660     if (security != null)
661     security.checkPermission(modifyThreadPermission);
662     }
663    
664     // Nested classes
665 jsr166 1.1
666     /**
667 jsr166 1.8 * Factory for creating new {@link ForkJoinWorkerThread}s.
668     * A {@code ForkJoinWorkerThreadFactory} must be defined and used
669     * for {@code ForkJoinWorkerThread} subclasses that extend base
670     * functionality or initialize threads with different contexts.
671 jsr166 1.1 */
672     public static interface ForkJoinWorkerThreadFactory {
673     /**
674     * Returns a new worker thread operating in the given pool.
675     *
676     * @param pool the pool this thread works in
677 jsr166 1.296 * @return the new worker thread, or {@code null} if the request
678     * to create a thread is rejected
679 jsr166 1.11 * @throws NullPointerException if the pool is null
680 jsr166 1.1 */
681     public ForkJoinWorkerThread newThread(ForkJoinPool pool);
682     }
683    
684     /**
685     * Default ForkJoinWorkerThreadFactory implementation; creates a
686     * new ForkJoinWorkerThread.
687     */
688 jsr166 1.278 private static final class DefaultForkJoinWorkerThreadFactory
689 jsr166 1.1 implements ForkJoinWorkerThreadFactory {
690 dl 1.112 public final ForkJoinWorkerThread newThread(ForkJoinPool pool) {
691 dl 1.14 return new ForkJoinWorkerThread(pool);
692 jsr166 1.1 }
693     }
694    
695     /**
696 dl 1.86 * Class for artificial tasks that are used to replace the target
697     * of local joins if they are removed from an interior queue slot
698     * in WorkQueue.tryRemoveAndExec. We don't need the proxy to
699     * actually do anything beyond having a unique identity.
700 jsr166 1.1 */
701 jsr166 1.278 private static final class EmptyTask extends ForkJoinTask<Void> {
702 dl 1.105 private static final long serialVersionUID = -7721805057305804111L;
703 dl 1.86 EmptyTask() { status = ForkJoinTask.NORMAL; } // force done
704     public final Void getRawResult() { return null; }
705     public final void setRawResult(Void x) {}
706     public final boolean exec() { return true; }
707 jsr166 1.1 }
708    
709 dl 1.262 /**
710     * Additional fields and lock created upon initialization.
711     */
712 jsr166 1.278 private static final class AuxState extends ReentrantLock {
713 dl 1.262 private static final long serialVersionUID = -6001602636862214147L;
714     volatile long stealCount; // cumulative steal count
715     long indexSeed; // index bits for registerWorker
716     AuxState() {}
717     }
718    
719 dl 1.200 // Constants shared across ForkJoinPool and WorkQueue
720    
721     // Bounds
722     static final int SMASK = 0xffff; // short bits == max index
723     static final int MAX_CAP = 0x7fff; // max #workers - 1
724     static final int EVENMASK = 0xfffe; // even short bits
725     static final int SQMASK = 0x007e; // max 64 (even) slots
726    
727     // Masks and units for WorkQueue.scanState and ctl sp subfield
728 dl 1.243 static final int UNSIGNALLED = 1 << 31; // must be negative
729 dl 1.211 static final int SS_SEQ = 1 << 16; // version count
730 dl 1.200
731     // Mode bits for ForkJoinPool.config and WorkQueue.config
732 dl 1.211 static final int MODE_MASK = 0xffff << 16; // top half of int
733 dl 1.243 static final int SPARE_WORKER = 1 << 17; // set if tc > 0 on creation
734     static final int UNREGISTERED = 1 << 18; // to skip some of deregister
735     static final int FIFO_QUEUE = 1 << 31; // must be negative
736     static final int LIFO_QUEUE = 0; // for clarity
737     static final int IS_OWNED = 1; // low bit 0 if shared
738 dl 1.225
739 jsr166 1.1 /**
740 dl 1.253 * The maximum number of task executions from the same queue
741     * before checking other queues, bounding unfairness and impact of
742     * infinite user task recursion. Must be a power of two minus 1.
743     */
744     static final int POLL_LIMIT = (1 << 10) - 1;
745    
746     /**
747 dl 1.78 * Queues supporting work-stealing as well as external task
748 jsr166 1.202 * submission. See above for descriptions and algorithms.
749 dl 1.78 * Performance on most platforms is very sensitive to placement of
750     * instances of both WorkQueues and their arrays -- we absolutely
751     * do not want multiple WorkQueue instances or multiple queue
752 dl 1.200 * arrays sharing cache lines. The @Contended annotation alerts
753     * JVMs to try to keep instances apart.
754 dl 1.78 */
755 jsr166 1.171 @sun.misc.Contended
756 dl 1.78 static final class WorkQueue {
757 dl 1.200
758 dl 1.78 /**
759     * Capacity of work-stealing queue array upon initialization.
760 dl 1.90 * Must be a power of two; at least 4, but should be larger to
761     * reduce or eliminate cacheline sharing among queues.
762     * Currently, it is much larger, as a partial workaround for
763     * the fact that JVMs often place arrays in locations that
764     * share GC bookkeeping (especially cardmarks) such that
765     * per-write accesses encounter serious memory contention.
766 dl 1.78 */
767 dl 1.90 static final int INITIAL_QUEUE_CAPACITY = 1 << 13;
768 dl 1.78
769     /**
770     * Maximum size for queue arrays. Must be a power of two less
771     * than or equal to 1 << (31 - width of array entry) to ensure
772     * lack of wraparound of index calculations, but defined to a
773     * value a bit less than this to help users trap runaway
774     * programs before saturating systems.
775     */
776     static final int MAXIMUM_QUEUE_CAPACITY = 1 << 26; // 64M
777    
778 dl 1.200 // Instance fields
779 dl 1.255
780 dl 1.243 volatile int scanState; // versioned, negative if inactive
781 dl 1.200 int stackPred; // pool stack (ctl) predecessor
782 dl 1.178 int nsteals; // number of steals
783 dl 1.200 int hint; // randomization and stealer index hint
784     int config; // pool index and mode
785     volatile int qlock; // 1: locked, < 0: terminate; else 0
786 dl 1.78 volatile int base; // index of next slot for poll
787     int top; // index of next slot for push
788     ForkJoinTask<?>[] array; // the elements (initially unallocated)
789 dl 1.90 final ForkJoinPool pool; // the containing pool (may be null)
790 dl 1.78 final ForkJoinWorkerThread owner; // owning thread or null if shared
791     volatile Thread parker; // == owner during call to park; else null
792 dl 1.95 volatile ForkJoinTask<?> currentJoin; // task being joined in awaitJoin
793 dl 1.255 @sun.misc.Contended("group2") // separate from other fields
794     volatile ForkJoinTask<?> currentSteal; // nonnull when running some task
795 dl 1.112
796 dl 1.200 WorkQueue(ForkJoinPool pool, ForkJoinWorkerThread owner) {
797 dl 1.90 this.pool = pool;
798 dl 1.78 this.owner = owner;
799 dl 1.115 // Place indices in the center of array (that is not yet allocated)
800 dl 1.78 base = top = INITIAL_QUEUE_CAPACITY >>> 1;
801     }
802    
803     /**
804 jsr166 1.220 * Returns an exportable index (used by ForkJoinWorkerThread).
805 dl 1.200 */
806     final int getPoolIndex() {
807     return (config & 0xffff) >>> 1; // ignore odd/even tag bit
808     }
809    
810     /**
811 dl 1.115 * Returns the approximate number of tasks in the queue.
812     */
813     final int queueSize() {
814 dl 1.243 int n = base - top; // read base first
815 dl 1.115 return (n >= 0) ? 0 : -n; // ignore transient negative
816     }
817    
818 jsr166 1.180 /**
819 dl 1.115 * Provides a more accurate estimate of whether this queue has
820     * any tasks than does queueSize, by checking whether a
821     * near-empty queue has at least one unclaimed task.
822     */
823     final boolean isEmpty() {
824 dl 1.225 ForkJoinTask<?>[] a; int n, al, s;
825 dl 1.243 return ((n = base - (s = top)) >= 0 || // possibly one task
826     (n == -1 && ((a = array) == null ||
827     (al = a.length) == 0 ||
828     a[(al - 1) & (s - 1)] == null)));
829 dl 1.115 }
830    
831     /**
832 dl 1.256 * Pushes a task. Call only by owner in unshared queues.
833 dl 1.78 *
834     * @param task the task. Caller must ensure non-null.
835 jsr166 1.146 * @throws RejectedExecutionException if array cannot be resized
836 dl 1.78 */
837 dl 1.90 final void push(ForkJoinTask<?> task) {
838 dl 1.288 U.storeFence(); // ensure safe publication
839 dl 1.292 int s = top, al, d; ForkJoinTask<?>[] a;
840 dl 1.243 if ((a = array) != null && (al = a.length) > 0) {
841     a[(al - 1) & s] = task; // relaxed writes OK
842     top = s + 1;
843     ForkJoinPool p = pool;
844 dl 1.292 if ((d = base - s) == 0 && p != null) {
845 dl 1.284 U.fullFence();
846 dl 1.253 p.signalWork();
847 dl 1.284 }
848 dl 1.253 else if (al + d == 1)
849 dl 1.243 growArray();
850 dl 1.78 }
851     }
852    
853 dl 1.178 /**
854 dl 1.112 * Initializes or doubles the capacity of array. Call either
855     * by owner or with lock held -- it is OK for base, but not
856     * top, to move while resizings are in progress.
857     */
858     final ForkJoinTask<?>[] growArray() {
859     ForkJoinTask<?>[] oldA = array;
860     int size = oldA != null ? oldA.length << 1 : INITIAL_QUEUE_CAPACITY;
861 dl 1.225 if (size < INITIAL_QUEUE_CAPACITY || size > MAXIMUM_QUEUE_CAPACITY)
862 dl 1.112 throw new RejectedExecutionException("Queue capacity exceeded");
863     int oldMask, t, b;
864     ForkJoinTask<?>[] a = array = new ForkJoinTask<?>[size];
865 dl 1.225 if (oldA != null && (oldMask = oldA.length - 1) > 0 &&
866 dl 1.112 (t = top) - (b = base) > 0) {
867     int mask = size - 1;
868 dl 1.200 do { // emulate poll from old array, push to new array
869 dl 1.256 int index = b & oldMask;
870     long offset = ((long)index << ASHIFT) + ABASE;
871 dl 1.243 ForkJoinTask<?> x = (ForkJoinTask<?>)
872     U.getObjectVolatile(oldA, offset);
873     if (x != null &&
874     U.compareAndSwapObject(oldA, offset, x, null))
875     a[b & mask] = x;
876 dl 1.112 } while (++b != t);
877 dl 1.243 U.storeFence();
878 dl 1.78 }
879 dl 1.112 return a;
880 dl 1.78 }
881    
882     /**
883 dl 1.90 * Takes next task, if one exists, in LIFO order. Call only
884 dl 1.102 * by owner in unshared queues.
885 dl 1.90 */
886     final ForkJoinTask<?> pop() {
887 dl 1.243 int b = base, s = top, al, i; ForkJoinTask<?>[] a;
888 dl 1.256 if ((a = array) != null && b != s && (al = a.length) > 0) {
889     int index = (al - 1) & --s;
890     long offset = ((long)index << ASHIFT) + ABASE;
891 dl 1.262 ForkJoinTask<?> t = (ForkJoinTask<?>)
892     U.getObject(a, offset);
893     if (t != null &&
894     U.compareAndSwapObject(a, offset, t, null)) {
895 dl 1.256 top = s;
896 dl 1.243 return t;
897 dl 1.90 }
898     }
899     return null;
900     }
901    
902     /**
903     * Takes a task in FIFO order if b is base of queue and a task
904     * can be claimed without contention. Specialized versions
905 dl 1.200 * appear in ForkJoinPool methods scan and helpStealer.
906 dl 1.78 */
907 dl 1.90 final ForkJoinTask<?> pollAt(int b) {
908 dl 1.243 ForkJoinTask<?>[] a; int al;
909     if ((a = array) != null && (al = a.length) > 0) {
910 dl 1.256 int index = (al - 1) & b;
911     long offset = ((long)index << ASHIFT) + ABASE;
912 dl 1.243 ForkJoinTask<?> t = (ForkJoinTask<?>)
913     U.getObjectVolatile(a, offset);
914     if (t != null && b++ == base &&
915     U.compareAndSwapObject(a, offset, t, null)) {
916     base = b;
917 dl 1.78 return t;
918     }
919     }
920     return null;
921     }
922    
923     /**
924 dl 1.90 * Takes next task, if one exists, in FIFO order.
925 dl 1.78 */
926 dl 1.90 final ForkJoinTask<?> poll() {
927 dl 1.243 for (;;) {
928     int b = base, s = top, d, al; ForkJoinTask<?>[] a;
929     if ((a = array) != null && (d = b - s) < 0 &&
930     (al = a.length) > 0) {
931 dl 1.256 int index = (al - 1) & b;
932     long offset = ((long)index << ASHIFT) + ABASE;
933 dl 1.243 ForkJoinTask<?> t = (ForkJoinTask<?>)
934     U.getObjectVolatile(a, offset);
935     if (b++ == base) {
936     if (t != null) {
937     if (U.compareAndSwapObject(a, offset, t, null)) {
938     base = b;
939     return t;
940     }
941 dl 1.200 }
942 dl 1.243 else if (d == -1)
943     break; // now empty
944 dl 1.78 }
945 dl 1.90 }
946 dl 1.243 else
947     break;
948 dl 1.78 }
949     return null;
950     }
951    
952     /**
953     * Takes next task, if one exists, in order specified by mode.
954     */
955     final ForkJoinTask<?> nextLocalTask() {
956 dl 1.243 return (config < 0) ? poll() : pop();
957 dl 1.78 }
958    
959     /**
960     * Returns next task, if one exists, in order specified by mode.
961     */
962     final ForkJoinTask<?> peek() {
963 dl 1.292 int al; ForkJoinTask<?>[] a;
964 dl 1.243 return ((a = array) != null && (al = a.length) > 0) ?
965 dl 1.292 a[(al - 1) & (config < 0 ? base : top - 1)] : null;
966 dl 1.78 }
967    
968     /**
969     * Pops the given task only if it is at the current top.
970 jsr166 1.251 */
971 dl 1.243 final boolean tryUnpush(ForkJoinTask<?> task) {
972 dl 1.256 int b = base, s = top, al; ForkJoinTask<?>[] a;
973     if ((a = array) != null && b != s && (al = a.length) > 0) {
974     int index = (al - 1) & --s;
975     long offset = ((long)index << ASHIFT) + ABASE;
976     if (U.compareAndSwapObject(a, offset, task, null)) {
977 dl 1.243 top = s;
978 dl 1.224 return true;
979     }
980 dl 1.78 }
981     return false;
982     }
983    
984     /**
985 dl 1.256 * Shared version of push. Fails if already locked.
986     *
987 dl 1.282 * @return status: > 0 locked, 0 possibly was empty, < 0 was nonempty
988 dl 1.256 */
989     final int sharedPush(ForkJoinTask<?> task) {
990     int stat;
991     if (U.compareAndSwapInt(this, QLOCK, 0, 1)) {
992     int b = base, s = top, al, d; ForkJoinTask<?>[] a;
993     if ((a = array) != null && (al = a.length) > 0 &&
994     al - 1 + (d = b - s) > 0) {
995     a[(al - 1) & s] = task;
996     top = s + 1; // relaxed writes OK here
997 dl 1.282 qlock = 0;
998 dl 1.284 stat = (d < 0 && b == base) ? d : 0;
999 dl 1.256 }
1000     else {
1001     growAndSharedPush(task);
1002     stat = 0;
1003     }
1004     }
1005     else
1006     stat = 1;
1007     return stat;
1008     }
1009    
1010 jsr166 1.290 /**
1011 dl 1.256 * Helper for sharedPush; called only when locked and resize
1012     * needed.
1013     */
1014     private void growAndSharedPush(ForkJoinTask<?> task) {
1015     try {
1016     growArray();
1017     int s = top, al; ForkJoinTask<?>[] a;
1018     if ((a = array) != null && (al = a.length) > 0) {
1019     a[(al - 1) & s] = task;
1020     top = s + 1;
1021     }
1022     } finally {
1023     qlock = 0;
1024     }
1025     }
1026    
1027     /**
1028 jsr166 1.279 * Shared version of pop.
1029 jsr166 1.247 */
1030 dl 1.243 final boolean trySharedUnpush(ForkJoinTask<?> task) {
1031     boolean popped = false;
1032 jsr166 1.271 int s = top - 1, al; ForkJoinTask<?>[] a;
1033 dl 1.243 if ((a = array) != null && (al = a.length) > 0) {
1034 dl 1.256 int index = (al - 1) & s;
1035     long offset = ((long)index << ASHIFT) + ABASE;
1036 jsr166 1.271 ForkJoinTask<?> t = (ForkJoinTask<?>) U.getObject(a, offset);
1037 dl 1.256 if (t == task &&
1038 dl 1.243 U.compareAndSwapInt(this, QLOCK, 0, 1)) {
1039 dl 1.297 if (top == s + 1 && array == a &&
1040     U.compareAndSwapObject(a, offset, task, null)) {
1041 dl 1.243 popped = true;
1042     top = s;
1043     }
1044     U.putOrderedInt(this, QLOCK, 0);
1045     }
1046     }
1047     return popped;
1048     }
1049    
1050     /**
1051 jsr166 1.84 * Removes and cancels all known tasks, ignoring any exceptions.
1052 dl 1.78 */
1053     final void cancelAll() {
1054 dl 1.200 ForkJoinTask<?> t;
1055     if ((t = currentJoin) != null) {
1056     currentJoin = null;
1057     ForkJoinTask.cancelIgnoringExceptions(t);
1058     }
1059     if ((t = currentSteal) != null) {
1060     currentSteal = null;
1061     ForkJoinTask.cancelIgnoringExceptions(t);
1062     }
1063     while ((t = poll()) != null)
1064 dl 1.78 ForkJoinTask.cancelIgnoringExceptions(t);
1065     }
1066    
1067 dl 1.104 // Specialized execution methods
1068 dl 1.78
1069     /**
1070 jsr166 1.254 * Pops and executes up to POLL_LIMIT tasks or until empty.
1071 dl 1.253 */
1072     final void localPopAndExec() {
1073     for (int nexec = 0;;) {
1074     int b = base, s = top, al; ForkJoinTask<?>[] a;
1075     if ((a = array) != null && b != s && (al = a.length) > 0) {
1076 dl 1.256 int index = (al - 1) & --s;
1077     long offset = ((long)index << ASHIFT) + ABASE;
1078 dl 1.253 ForkJoinTask<?> t = (ForkJoinTask<?>)
1079     U.getAndSetObject(a, offset, null);
1080     if (t != null) {
1081     top = s;
1082     (currentSteal = t).doExec();
1083     if (++nexec > POLL_LIMIT)
1084     break;
1085     }
1086     else
1087     break;
1088     }
1089     else
1090     break;
1091     }
1092     }
1093    
1094     /**
1095 jsr166 1.254 * Polls and executes up to POLL_LIMIT tasks or until empty.
1096 dl 1.253 */
1097     final void localPollAndExec() {
1098     for (int nexec = 0;;) {
1099     int b = base, s = top, al; ForkJoinTask<?>[] a;
1100     if ((a = array) != null && b != s && (al = a.length) > 0) {
1101 dl 1.256 int index = (al - 1) & b++;
1102     long offset = ((long)index << ASHIFT) + ABASE;
1103 dl 1.253 ForkJoinTask<?> t = (ForkJoinTask<?>)
1104     U.getAndSetObject(a, offset, null);
1105     if (t != null) {
1106     base = b;
1107 dl 1.255 t.doExec();
1108 dl 1.253 if (++nexec > POLL_LIMIT)
1109     break;
1110     }
1111     }
1112     else
1113     break;
1114     }
1115     }
1116    
1117     /**
1118     * Executes the given task and (some) remaining local tasks.
1119 dl 1.94 */
1120 dl 1.178 final void runTask(ForkJoinTask<?> task) {
1121 dl 1.200 if (task != null) {
1122 dl 1.243 task.doExec();
1123 dl 1.253 if (config < 0)
1124     localPollAndExec();
1125     else
1126     localPopAndExec();
1127 dl 1.243 int ns = ++nsteals;
1128 dl 1.200 ForkJoinWorkerThread thread = owner;
1129 dl 1.243 currentSteal = null;
1130     if (ns < 0) // collect on overflow
1131 dl 1.215 transferStealCount(pool);
1132 dl 1.200 if (thread != null)
1133 dl 1.197 thread.afterTopLevelExec();
1134 dl 1.178 }
1135 dl 1.94 }
1136    
1137     /**
1138 dl 1.262 * Adds steal count to pool steal count if it exists, and resets.
1139 dl 1.215 */
1140     final void transferStealCount(ForkJoinPool p) {
1141 dl 1.262 AuxState aux;
1142     if (p != null && (aux = p.auxState) != null) {
1143 jsr166 1.293 long s = nsteals;
1144 dl 1.215 nsteals = 0; // if negative, correct for overflow
1145 jsr166 1.293 if (s < 0) s = Integer.MAX_VALUE;
1146 dl 1.262 aux.lock();
1147     try {
1148 jsr166 1.293 aux.stealCount += s;
1149 dl 1.262 } finally {
1150     aux.unlock();
1151     }
1152 dl 1.215 }
1153     }
1154    
1155     /**
1156 dl 1.105 * If present, removes from queue and executes the given task,
1157 jsr166 1.213 * or any other cancelled task. Used only by awaitJoin.
1158 dl 1.94 *
1159 jsr166 1.213 * @return true if queue empty and task not known to be done
1160 dl 1.94 */
1161 dl 1.105 final boolean tryRemoveAndExec(ForkJoinTask<?> task) {
1162 dl 1.243 if (task != null && task.status >= 0) {
1163     int b, s, d, al; ForkJoinTask<?>[] a;
1164     while ((d = (b = base) - (s = top)) < 0 &&
1165     (a = array) != null && (al = a.length) > 0) {
1166     for (;;) { // traverse from s to b
1167 dl 1.256 int index = --s & (al - 1);
1168     long offset = (index << ASHIFT) + ABASE;
1169 dl 1.243 ForkJoinTask<?> t = (ForkJoinTask<?>)
1170     U.getObjectVolatile(a, offset);
1171     if (t == null)
1172     break; // restart
1173 dl 1.200 else if (t == task) {
1174     boolean removed = false;
1175     if (s + 1 == top) { // pop
1176 dl 1.243 if (U.compareAndSwapObject(a, offset, t, null)) {
1177     top = s;
1178 dl 1.200 removed = true;
1179     }
1180     }
1181     else if (base == b) // replace with proxy
1182 dl 1.258 removed = U.compareAndSwapObject(a, offset, t,
1183     new EmptyTask());
1184 dl 1.243 if (removed) {
1185     ForkJoinTask<?> ps = currentSteal;
1186     (currentSteal = task).doExec();
1187     currentSteal = ps;
1188     }
1189 dl 1.200 break;
1190 dl 1.90 }
1191 dl 1.200 else if (t.status < 0 && s + 1 == top) {
1192 dl 1.243 if (U.compareAndSwapObject(a, offset, t, null)) {
1193     top = s;
1194     }
1195 dl 1.200 break; // was cancelled
1196 dl 1.104 }
1197 dl 1.243 else if (++d == 0) {
1198     if (base != b) // rescan
1199     break;
1200 dl 1.200 return false;
1201 dl 1.243 }
1202 dl 1.104 }
1203 dl 1.200 if (task.status < 0)
1204     return false;
1205 dl 1.104 }
1206     }
1207 dl 1.200 return true;
1208 dl 1.104 }
1209    
1210     /**
1211 dl 1.200 * Pops task if in the same CC computation as the given task,
1212     * in either shared or owned mode. Used only by helpComplete.
1213 dl 1.78 */
1214 dl 1.253 final CountedCompleter<?> popCC(CountedCompleter<?> task, int mode) {
1215 dl 1.243 int b = base, s = top, al; ForkJoinTask<?>[] a;
1216     if ((a = array) != null && b != s && (al = a.length) > 0) {
1217 dl 1.256 int index = (al - 1) & (s - 1);
1218     long offset = ((long)index << ASHIFT) + ABASE;
1219     ForkJoinTask<?> o = (ForkJoinTask<?>)
1220     U.getObjectVolatile(a, offset);
1221 dl 1.243 if (o instanceof CountedCompleter) {
1222 dl 1.200 CountedCompleter<?> t = (CountedCompleter<?>)o;
1223     for (CountedCompleter<?> r = t;;) {
1224     if (r == task) {
1225 dl 1.253 if ((mode & IS_OWNED) == 0) {
1226 dl 1.297 boolean popped = false;
1227 dl 1.200 if (U.compareAndSwapInt(this, QLOCK, 0, 1)) {
1228 dl 1.297 if (top == s && array == a &&
1229 dl 1.243 U.compareAndSwapObject(a, offset,
1230 dl 1.297 t, null)) {
1231     popped = true;
1232 dl 1.243 top = s - 1;
1233 dl 1.297 }
1234 dl 1.243 U.putOrderedInt(this, QLOCK, 0);
1235     if (popped)
1236 dl 1.200 return t;
1237 dl 1.178 }
1238     }
1239 dl 1.243 else if (U.compareAndSwapObject(a, offset,
1240     t, null)) {
1241     top = s - 1;
1242 dl 1.200 return t;
1243     }
1244     break;
1245 dl 1.178 }
1246 dl 1.200 else if ((r = r.completer) == null) // try parent
1247 dl 1.178 break;
1248     }
1249 dl 1.94 }
1250 dl 1.78 }
1251 dl 1.200 return null;
1252 dl 1.78 }
1253    
1254     /**
1255 dl 1.200 * Steals and runs a task in the same CC computation as the
1256     * given task if one exists and can be taken without
1257     * contention. Otherwise returns a checksum/control value for
1258     * use by method helpComplete.
1259     *
1260     * @return 1 if successful, 2 if retryable (lost to another
1261     * stealer), -1 if non-empty but no matching task found, else
1262     * the base index, forced negative.
1263     */
1264     final int pollAndExecCC(CountedCompleter<?> task) {
1265 dl 1.243 ForkJoinTask<?>[] a;
1266     int b = base, s = top, al, h;
1267     if ((a = array) != null && b != s && (al = a.length) > 0) {
1268 dl 1.256 int index = (al - 1) & b;
1269     long offset = ((long)index << ASHIFT) + ABASE;
1270     ForkJoinTask<?> o = (ForkJoinTask<?>)
1271     U.getObjectVolatile(a, offset);
1272 dl 1.243 if (o == null)
1273     h = 2; // retryable
1274     else if (!(o instanceof CountedCompleter))
1275     h = -1; // unmatchable
1276     else {
1277     CountedCompleter<?> t = (CountedCompleter<?>)o;
1278     for (CountedCompleter<?> r = t;;) {
1279     if (r == task) {
1280     if (b++ == base &&
1281     U.compareAndSwapObject(a, offset, t, null)) {
1282     base = b;
1283     t.doExec();
1284     h = 1; // success
1285     }
1286     else
1287     h = 2; // lost CAS
1288     break;
1289     }
1290     else if ((r = r.completer) == null) {
1291     h = -1; // unmatched
1292     break;
1293 dl 1.200 }
1294 dl 1.178 }
1295     }
1296 dl 1.78 }
1297 dl 1.243 else
1298     h = b | Integer.MIN_VALUE; // to sense movement on re-poll
1299 dl 1.200 return h;
1300 dl 1.78 }
1301    
1302     /**
1303 dl 1.86 * Returns true if owned and not known to be blocked.
1304     */
1305     final boolean isApparentlyUnblocked() {
1306     Thread wt; Thread.State s;
1307 dl 1.200 return (scanState >= 0 &&
1308 dl 1.86 (wt = owner) != null &&
1309     (s = wt.getState()) != Thread.State.BLOCKED &&
1310     s != Thread.State.WAITING &&
1311     s != Thread.State.TIMED_WAITING);
1312     }
1313    
1314 dl 1.211 // Unsafe mechanics. Note that some are (and must be) the same as in FJP
1315 jsr166 1.233 private static final sun.misc.Unsafe U = sun.misc.Unsafe.getUnsafe();
1316 dl 1.105 private static final long QLOCK;
1317 jsr166 1.291 private static final int ABASE;
1318     private static final int ASHIFT;
1319 dl 1.78 static {
1320     try {
1321 dl 1.105 QLOCK = U.objectFieldOffset
1322 jsr166 1.233 (WorkQueue.class.getDeclaredField("qlock"));
1323     ABASE = U.arrayBaseOffset(ForkJoinTask[].class);
1324     int scale = U.arrayIndexScale(ForkJoinTask[].class);
1325 jsr166 1.142 if ((scale & (scale - 1)) != 0)
1326 jsr166 1.232 throw new Error("array index scale not a power of two");
1327 jsr166 1.142 ASHIFT = 31 - Integer.numberOfLeadingZeros(scale);
1328 jsr166 1.231 } catch (ReflectiveOperationException e) {
1329 dl 1.78 throw new Error(e);
1330     }
1331     }
1332     }
1333 dl 1.14
1334 dl 1.112 // static fields (initialized in static initializer below)
1335    
1336     /**
1337     * Creates a new ForkJoinWorkerThread. This factory is used unless
1338     * overridden in ForkJoinPool constructors.
1339     */
1340     public static final ForkJoinWorkerThreadFactory
1341     defaultForkJoinWorkerThreadFactory;
1342    
1343 jsr166 1.1 /**
1344 dl 1.115 * Permission required for callers of methods that may start or
1345 jsr166 1.277 * kill threads. Also used as a static lock in tryInitialize.
1346 dl 1.115 */
1347 jsr166 1.276 static final RuntimePermission modifyThreadPermission;
1348 dl 1.115
1349     /**
1350 dl 1.101 * Common (static) pool. Non-null for public use unless a static
1351 dl 1.105 * construction exception, but internal usages null-check on use
1352     * to paranoically avoid potential initialization circularities
1353     * as well as to simplify generated code.
1354 dl 1.101 */
1355 dl 1.134 static final ForkJoinPool common;
1356 dl 1.101
1357     /**
1358 dl 1.160 * Common pool parallelism. To allow simpler use and management
1359     * when common pool threads are disabled, we allow the underlying
1360 dl 1.185 * common.parallelism field to be zero, but in that case still report
1361 dl 1.160 * parallelism as 1 to reflect resulting caller-runs mechanics.
1362 dl 1.90 */
1363 jsr166 1.274 static final int COMMON_PARALLELISM;
1364 dl 1.90
1365     /**
1366 dl 1.208 * Limit on spare thread construction in tryCompensate.
1367     */
1368 jsr166 1.273 private static final int COMMON_MAX_SPARES;
1369 dl 1.208
1370     /**
1371 dl 1.105 * Sequence number for creating workerNamePrefix.
1372 dl 1.86 */
1373 dl 1.105 private static int poolNumberSequence;
1374 dl 1.86
1375 jsr166 1.1 /**
1376 jsr166 1.132 * Returns the next sequence number. We don't expect this to
1377     * ever contend, so use simple builtin sync.
1378 dl 1.83 */
1379 dl 1.105 private static final synchronized int nextPoolId() {
1380     return ++poolNumberSequence;
1381     }
1382 dl 1.86
1383 dl 1.200 // static configuration constants
1384 dl 1.86
1385     /**
1386 dl 1.243 * Initial timeout value (in milliseconds) for the thread
1387 dl 1.105 * triggering quiescence to park waiting for new work. On timeout,
1388 jsr166 1.268 * the thread will instead try to shrink the number of workers.
1389     * The value should be large enough to avoid overly aggressive
1390     * shrinkage during most transient stalls (long GCs etc).
1391 dl 1.86 */
1392 dl 1.243 private static final long IDLE_TIMEOUT_MS = 2000L; // 2sec
1393 dl 1.86
1394     /**
1395 jsr166 1.279 * Tolerance for idle timeouts, to cope with timer undershoots.
1396 dl 1.120 */
1397 dl 1.243 private static final long TIMEOUT_SLOP_MS = 20L; // 20ms
1398 dl 1.200
1399     /**
1400 jsr166 1.273 * The default value for COMMON_MAX_SPARES. Overridable using the
1401     * "java.util.concurrent.ForkJoinPool.common.maximumSpares" system
1402     * property. The default value is far in excess of normal
1403     * requirements, but also far short of MAX_CAP and typical OS
1404     * thread limits, so allows JVMs to catch misuse/abuse before
1405     * running out of resources needed to do so.
1406 dl 1.200 */
1407 dl 1.208 private static final int DEFAULT_COMMON_MAX_SPARES = 256;
1408 dl 1.120
1409     /**
1410 dl 1.90 * Increment for seed generators. See class ThreadLocal for
1411     * explanation.
1412     */
1413 dl 1.193 private static final int SEED_INCREMENT = 0x9e3779b9;
1414 dl 1.83
1415 jsr166 1.163 /*
1416 dl 1.200 * Bits and masks for field ctl, packed with 4 16 bit subfields:
1417     * AC: Number of active running workers minus target parallelism
1418     * TC: Number of total workers minus target parallelism
1419     * SS: version count and status of top waiting thread
1420     * ID: poolIndex of top of Treiber stack of waiters
1421     *
1422     * When convenient, we can extract the lower 32 stack top bits
1423     * (including version bits) as sp=(int)ctl. The offsets of counts
1424     * by the target parallelism and the positionings of fields makes
1425     * it possible to perform the most common checks via sign tests of
1426     * fields: When ac is negative, there are not enough active
1427     * workers, when tc is negative, there are not enough total
1428     * workers. When sp is non-zero, there are waiting workers. To
1429     * deal with possibly negative fields, we use casts in and out of
1430     * "short" and/or signed shifts to maintain signedness.
1431     *
1432     * Because it occupies uppermost bits, we can add one active count
1433     * using getAndAddLong of AC_UNIT, rather than CAS, when returning
1434     * from a blocked join. Other updates entail multiple subfields
1435     * and masking, requiring CAS.
1436     */
1437    
1438     // Lower and upper word masks
1439     private static final long SP_MASK = 0xffffffffL;
1440     private static final long UC_MASK = ~SP_MASK;
1441 dl 1.86
1442 dl 1.200 // Active counts
1443 dl 1.86 private static final int AC_SHIFT = 48;
1444 dl 1.200 private static final long AC_UNIT = 0x0001L << AC_SHIFT;
1445     private static final long AC_MASK = 0xffffL << AC_SHIFT;
1446    
1447     // Total counts
1448 dl 1.86 private static final int TC_SHIFT = 32;
1449 dl 1.200 private static final long TC_UNIT = 0x0001L << TC_SHIFT;
1450     private static final long TC_MASK = 0xffffL << TC_SHIFT;
1451     private static final long ADD_WORKER = 0x0001L << (TC_SHIFT + 15); // sign
1452    
1453 dl 1.205 // runState bits: SHUTDOWN must be negative, others arbitrary powers of two
1454 dl 1.243 private static final int STARTED = 1;
1455     private static final int STOP = 1 << 1;
1456     private static final int TERMINATED = 1 << 2;
1457 dl 1.205 private static final int SHUTDOWN = 1 << 31;
1458 dl 1.86
1459     // Instance fields
1460 dl 1.200 volatile long ctl; // main pool control
1461 dl 1.243 volatile int runState;
1462 dl 1.200 final int config; // parallelism, mode
1463 dl 1.262 AuxState auxState; // lock, steal counts
1464 dl 1.200 volatile WorkQueue[] workQueues; // main registry
1465 dl 1.256 final String workerNamePrefix; // to create worker name string
1466 dl 1.112 final ForkJoinWorkerThreadFactory factory;
1467 dl 1.200 final UncaughtExceptionHandler ueh; // per-worker UEH
1468 dl 1.101
1469 jsr166 1.145 /**
1470 dl 1.258 * Instantiates fields upon first submission, or upon shutdown if
1471     * no submissions. If checkTermination true, also responds to
1472     * termination by external calls submitting tasks.
1473 dl 1.105 */
1474 dl 1.258 private void tryInitialize(boolean checkTermination) {
1475 dl 1.294 if (runState == 0) { // bootstrap by locking static field
1476     int p = config & SMASK;
1477     int n = (p > 1) ? p - 1 : 1; // ensure at least 2 slots
1478     n |= n >>> 1; // create workQueues array with size a power of two
1479 jsr166 1.270 n |= n >>> 2;
1480     n |= n >>> 4;
1481     n |= n >>> 8;
1482     n |= n >>> 16;
1483     n = ((n + 1) << 1) & SMASK;
1484 dl 1.262 AuxState aux = new AuxState();
1485 dl 1.258 WorkQueue[] ws = new WorkQueue[n];
1486 jsr166 1.259 synchronized (modifyThreadPermission) { // double-check
1487 dl 1.294 if (runState == 0) {
1488 dl 1.258 workQueues = ws;
1489 dl 1.262 auxState = aux;
1490 dl 1.294 runState = STARTED;
1491 dl 1.101 }
1492     }
1493     }
1494 dl 1.258 if (checkTermination && runState < 0) {
1495 jsr166 1.244 tryTerminate(false, false); // help terminate
1496     throw new RejectedExecutionException();
1497     }
1498 dl 1.78 }
1499 jsr166 1.1
1500 dl 1.200 // Creating, registering and deregistering workers
1501    
1502 dl 1.112 /**
1503 dl 1.200 * Tries to construct and start one worker. Assumes that total
1504     * count has already been incremented as a reservation. Invokes
1505     * deregisterWorker on any failure.
1506     *
1507 dl 1.243 * @param isSpare true if this is a spare thread
1508 dl 1.200 * @return true if successful
1509 dl 1.115 */
1510 dl 1.243 private boolean createWorker(boolean isSpare) {
1511 dl 1.200 ForkJoinWorkerThreadFactory fac = factory;
1512     Throwable ex = null;
1513     ForkJoinWorkerThread wt = null;
1514 dl 1.243 WorkQueue q;
1515 dl 1.200 try {
1516     if (fac != null && (wt = fac.newThread(this)) != null) {
1517 dl 1.243 if (isSpare && (q = wt.workQueue) != null)
1518     q.config |= SPARE_WORKER;
1519 dl 1.200 wt.start();
1520     return true;
1521 dl 1.115 }
1522 dl 1.200 } catch (Throwable rex) {
1523     ex = rex;
1524 dl 1.112 }
1525 dl 1.200 deregisterWorker(wt, ex);
1526     return false;
1527 dl 1.112 }
1528    
1529 dl 1.200 /**
1530     * Tries to add one worker, incrementing ctl counts before doing
1531     * so, relying on createWorker to back out on failure.
1532     *
1533     * @param c incoming ctl value, with total count negative and no
1534     * idle workers. On CAS failure, c is refreshed and retried if
1535 jsr166 1.202 * this holds (otherwise, a new worker is not needed).
1536 dl 1.200 */
1537     private void tryAddWorker(long c) {
1538     do {
1539     long nc = ((AC_MASK & (c + AC_UNIT)) |
1540     (TC_MASK & (c + TC_UNIT)));
1541 dl 1.243 if (ctl == c && U.compareAndSwapLong(this, CTL, c, nc)) {
1542     createWorker(false);
1543     break;
1544 dl 1.200 }
1545     } while (((c = ctl) & ADD_WORKER) != 0L && (int)c == 0);
1546     }
1547 dl 1.112
1548     /**
1549 dl 1.200 * Callback from ForkJoinWorkerThread constructor to establish and
1550     * record its WorkQueue.
1551 dl 1.112 *
1552     * @param wt the worker thread
1553 dl 1.115 * @return the worker's queue
1554 dl 1.112 */
1555 dl 1.115 final WorkQueue registerWorker(ForkJoinWorkerThread wt) {
1556 dl 1.200 UncaughtExceptionHandler handler;
1557 dl 1.262 AuxState aux;
1558 dl 1.200 wt.setDaemon(true); // configure thread
1559 dl 1.115 if ((handler = ueh) != null)
1560     wt.setUncaughtExceptionHandler(handler);
1561 dl 1.200 WorkQueue w = new WorkQueue(this, wt);
1562     int i = 0; // assign a pool index
1563     int mode = config & MODE_MASK;
1564 dl 1.262 if ((aux = auxState) != null) {
1565     aux.lock();
1566     try {
1567     int s = (int)(aux.indexSeed += SEED_INCREMENT), n, m;
1568 dl 1.243 WorkQueue[] ws = workQueues;
1569     if (ws != null && (n = ws.length) > 0) {
1570     i = (m = n - 1) & ((s << 1) | 1); // odd-numbered indices
1571     if (ws[i] != null) { // collision
1572     int probes = 0; // step by approx half n
1573     int step = (n <= 4) ? 2 : ((n >>> 1) & EVENMASK) + 2;
1574     while (ws[i = (i + step) & m] != null) {
1575     if (++probes >= n) {
1576     workQueues = ws = Arrays.copyOf(ws, n <<= 1);
1577     m = n - 1;
1578     probes = 0;
1579     }
1580 dl 1.94 }
1581     }
1582 dl 1.243 w.hint = s; // use as random seed
1583     w.config = i | mode;
1584     w.scanState = i | (s & 0x7fff0000); // random seq bits
1585     ws[i] = w;
1586 dl 1.94 }
1587 dl 1.262 } finally {
1588     aux.unlock();
1589 dl 1.78 }
1590     }
1591 dl 1.200 wt.setName(workerNamePrefix.concat(Integer.toString(i >>> 1)));
1592 dl 1.115 return w;
1593 dl 1.78 }
1594 dl 1.19
1595 jsr166 1.1 /**
1596 dl 1.86 * Final callback from terminating worker, as well as upon failure
1597 dl 1.105 * to construct or start a worker. Removes record of worker from
1598     * array, and adjusts counts. If pool is shutting down, tries to
1599     * complete termination.
1600 dl 1.78 *
1601 jsr166 1.151 * @param wt the worker thread, or null if construction failed
1602 dl 1.78 * @param ex the exception causing failure, or null if none
1603 dl 1.45 */
1604 dl 1.78 final void deregisterWorker(ForkJoinWorkerThread wt, Throwable ex) {
1605     WorkQueue w = null;
1606     if (wt != null && (w = wt.workQueue) != null) {
1607 dl 1.262 AuxState aux; WorkQueue[] ws; // remove index from array
1608 dl 1.200 int idx = w.config & SMASK;
1609 dl 1.262 int ns = w.nsteals;
1610     if ((aux = auxState) != null) {
1611     aux.lock();
1612     try {
1613 dl 1.243 if ((ws = workQueues) != null && ws.length > idx &&
1614     ws[idx] == w)
1615     ws[idx] = null;
1616 dl 1.262 aux.stealCount += ns;
1617     } finally {
1618     aux.unlock();
1619 dl 1.243 }
1620     }
1621     }
1622     if (w == null || (w.config & UNREGISTERED) == 0) { // else pre-adjusted
1623     long c; // decrement counts
1624     do {} while (!U.compareAndSwapLong
1625     (this, CTL, c = ctl, ((AC_MASK & (c - AC_UNIT)) |
1626     (TC_MASK & (c - TC_UNIT)) |
1627     (SP_MASK & c))));
1628     }
1629 dl 1.200 if (w != null) {
1630 dl 1.281 w.currentSteal = null;
1631 dl 1.200 w.qlock = -1; // ensure set
1632     w.cancelAll(); // cancel remaining tasks
1633 dl 1.78 }
1634 dl 1.286 while (tryTerminate(false, false) >= 0) { // possibly replace
1635 dl 1.243 WorkQueue[] ws; int wl, sp; long c;
1636 dl 1.286 if (w == null || w.array == null ||
1637 dl 1.289 (ws = workQueues) == null || (wl = ws.length) <= 0)
1638 dl 1.209 break;
1639 dl 1.243 else if ((sp = (int)(c = ctl)) != 0) { // wake up replacement
1640     if (tryRelease(c, ws[(wl - 1) & sp], AC_UNIT))
1641 dl 1.205 break;
1642 dl 1.120 }
1643 dl 1.209 else if (ex != null && (c & ADD_WORKER) != 0L) {
1644     tryAddWorker(c); // create replacement
1645     break;
1646     }
1647     else // don't need replacement
1648     break;
1649 dl 1.78 }
1650 dl 1.200 if (ex == null) // help clean on way out
1651 dl 1.120 ForkJoinTask.helpExpungeStaleExceptions();
1652 dl 1.200 else // rethrow
1653 dl 1.104 ForkJoinTask.rethrow(ex);
1654 dl 1.78 }
1655 dl 1.52
1656 dl 1.200 // Signalling
1657 dl 1.19
1658     /**
1659 dl 1.115 * Tries to create or activate a worker if too few are active.
1660 dl 1.105 */
1661 dl 1.253 final void signalWork() {
1662 dl 1.243 for (;;) {
1663     long c; int sp, i; WorkQueue v; WorkQueue[] ws;
1664     if ((c = ctl) >= 0L) // enough workers
1665     break;
1666     else if ((sp = (int)c) == 0) { // no idle workers
1667     if ((c & ADD_WORKER) != 0L) // too few workers
1668 dl 1.200 tryAddWorker(c);
1669     break;
1670     }
1671 dl 1.243 else if ((ws = workQueues) == null)
1672     break; // unstarted/terminated
1673     else if (ws.length <= (i = sp & SMASK))
1674     break; // terminated
1675     else if ((v = ws[i]) == null)
1676     break; // terminating
1677     else {
1678     int ns = sp & ~UNSIGNALLED;
1679     int vs = v.scanState;
1680     long nc = (v.stackPred & SP_MASK) | (UC_MASK & (c + AC_UNIT));
1681     if (sp == vs && U.compareAndSwapLong(this, CTL, c, nc)) {
1682     v.scanState = ns;
1683     LockSupport.unpark(v.parker);
1684     break;
1685     }
1686 dl 1.174 }
1687 dl 1.52 }
1688 dl 1.14 }
1689    
1690 dl 1.200 /**
1691     * Signals and releases worker v if it is top of idle worker
1692     * stack. This performs a one-shot version of signalWork only if
1693     * there is (apparently) at least one idle worker.
1694     *
1695     * @param c incoming ctl value
1696     * @param v if non-null, a worker
1697     * @param inc the increment to active count (zero when compensating)
1698     * @return true if successful
1699     */
1700     private boolean tryRelease(long c, WorkQueue v, long inc) {
1701 dl 1.243 int sp = (int)c, ns = sp & ~UNSIGNALLED;
1702     if (v != null) {
1703     int vs = v.scanState;
1704     long nc = (v.stackPred & SP_MASK) | (UC_MASK & (c + inc));
1705     if (sp == vs && U.compareAndSwapLong(this, CTL, c, nc)) {
1706     v.scanState = ns;
1707     LockSupport.unpark(v.parker);
1708 dl 1.200 return true;
1709     }
1710     }
1711     return false;
1712     }
1713    
1714 dl 1.243 /**
1715     * With approx probability of a missed signal, tries (once) to
1716     * reactivate worker w (or some other worker), failing if stale or
1717     * known to be already active.
1718     *
1719     * @param w the worker
1720     * @param ws the workQueue array to use
1721     * @param r random seed
1722     */
1723     private void tryReactivate(WorkQueue w, WorkQueue[] ws, int r) {
1724 dl 1.272 long c; int sp, wl; WorkQueue v;
1725 dl 1.243 if ((sp = (int)(c = ctl)) != 0 && w != null &&
1726     ws != null && (wl = ws.length) > 0 &&
1727 dl 1.272 ((sp ^ r) & SS_SEQ) == 0 &&
1728     (v = ws[(wl - 1) & sp]) != null) {
1729 dl 1.243 long nc = (v.stackPred & SP_MASK) | (UC_MASK & (c + AC_UNIT));
1730     int ns = sp & ~UNSIGNALLED;
1731 dl 1.262 if (w.scanState < 0 &&
1732 dl 1.243 v.scanState == sp &&
1733     U.compareAndSwapLong(this, CTL, c, nc)) {
1734     v.scanState = ns;
1735     LockSupport.unpark(v.parker);
1736     }
1737     }
1738     }
1739 dl 1.90
1740 dl 1.14 /**
1741 dl 1.243 * If worker w exists and is active, enqueues and sets status to inactive.
1742     *
1743     * @param w the worker
1744     * @param ss current (non-negative) scanState
1745 dl 1.14 */
1746 dl 1.243 private void inactivate(WorkQueue w, int ss) {
1747     int ns = (ss + SS_SEQ) | UNSIGNALLED;
1748     long lc = ns & SP_MASK, nc, c;
1749     if (w != null) {
1750     w.scanState = ns;
1751     do {
1752     nc = lc | (UC_MASK & ((c = ctl) - AC_UNIT));
1753     w.stackPred = (int)c;
1754     } while (!U.compareAndSwapLong(this, CTL, c, nc));
1755 dl 1.178 }
1756 dl 1.14 }
1757    
1758     /**
1759 dl 1.243 * Possibly blocks worker w waiting for signal, or returns
1760     * negative status if the worker should terminate. May return
1761     * without status change if multiple stale unparks and/or
1762     * interrupts occur.
1763 dl 1.78 *
1764 dl 1.243 * @param w the calling worker
1765     * @return negative if w should terminate
1766 dl 1.78 */
1767 dl 1.243 private int awaitWork(WorkQueue w) {
1768     int stat = 0;
1769     if (w != null && w.scanState < 0) {
1770     long c = ctl;
1771     if ((int)(c >> AC_SHIFT) + (config & SMASK) <= 0)
1772     stat = timedAwaitWork(w, c); // possibly quiescent
1773     else if ((runState & STOP) != 0)
1774     stat = w.qlock = -1; // pool terminating
1775 dl 1.289 else if (w.scanState < 0) {
1776 dl 1.243 w.parker = Thread.currentThread();
1777 dl 1.289 if (w.scanState < 0) // recheck after write
1778 dl 1.243 LockSupport.park(this);
1779     w.parker = null;
1780 dl 1.289 if ((runState & STOP) != 0)
1781     stat = w.qlock = -1; // recheck
1782     else if (w.scanState < 0)
1783     Thread.interrupted(); // clear status
1784 dl 1.115 }
1785 dl 1.52 }
1786 dl 1.243 return stat;
1787 dl 1.14 }
1788    
1789     /**
1790 dl 1.243 * Possibly triggers shutdown and tries (once) to block worker
1791     * when pool is (or may be) quiescent. Waits up to a duration
1792     * determined by number of workers. On timeout, if ctl has not
1793 dl 1.200 * changed, terminates the worker, which will in turn wake up
1794 dl 1.178 * another worker to possibly repeat this process.
1795 dl 1.52 *
1796 dl 1.78 * @param w the calling worker
1797 dl 1.243 * @return negative if w should terminate
1798 dl 1.14 */
1799 dl 1.243 private int timedAwaitWork(WorkQueue w, long c) {
1800     int stat = 0;
1801     int scale = 1 - (short)(c >>> TC_SHIFT);
1802     long deadline = (((scale <= 0) ? 1 : scale) * IDLE_TIMEOUT_MS +
1803     System.currentTimeMillis());
1804 dl 1.289 if ((runState >= 0 || (stat = tryTerminate(false, false)) > 0) &&
1805     w != null && w.scanState < 0) {
1806 dl 1.262 int ss; AuxState aux;
1807 dl 1.289 w.parker = Thread.currentThread();
1808     if (w.scanState < 0)
1809     LockSupport.parkUntil(this, deadline);
1810     w.parker = null;
1811     if ((runState & STOP) != 0)
1812     stat = w.qlock = -1; // pool terminating
1813     else if ((ss = w.scanState) < 0 && !Thread.interrupted() &&
1814     (int)c == ss && (aux = auxState) != null && ctl == c &&
1815     deadline - System.currentTimeMillis() <= TIMEOUT_SLOP_MS) {
1816     aux.lock();
1817     try { // pre-deregister
1818     WorkQueue[] ws;
1819     int cfg = w.config, idx = cfg & SMASK;
1820     long nc = ((UC_MASK & (c - TC_UNIT)) |
1821     (SP_MASK & w.stackPred));
1822     if ((runState & STOP) == 0 &&
1823     (ws = workQueues) != null &&
1824     idx < ws.length && idx >= 0 && ws[idx] == w &&
1825     U.compareAndSwapLong(this, CTL, c, nc)) {
1826     ws[idx] = null;
1827     w.config = cfg | UNREGISTERED;
1828     stat = w.qlock = -1;
1829 dl 1.243 }
1830 dl 1.289 } finally {
1831     aux.unlock();
1832 dl 1.243 }
1833     }
1834     }
1835     return stat;
1836     }
1837    
1838     /**
1839     * If the given worker is a spare with no queued tasks, and there
1840     * are enough existing workers, drops it from ctl counts and sets
1841 jsr166 1.248 * its state to terminated.
1842 dl 1.243 *
1843     * @param w the calling worker -- must be a spare
1844     * @return true if dropped (in which case it must not process more tasks)
1845     */
1846     private boolean tryDropSpare(WorkQueue w) {
1847     if (w != null && w.isEmpty()) { // no local tasks
1848     long c; int sp, wl; WorkQueue[] ws; WorkQueue v;
1849     while ((short)((c = ctl) >> TC_SHIFT) > 0 &&
1850     ((sp = (int)c) != 0 || (int)(c >> AC_SHIFT) > 0) &&
1851     (ws = workQueues) != null && (wl = ws.length) > 0) {
1852     boolean dropped, canDrop;
1853     if (sp == 0) { // no queued workers
1854     long nc = ((AC_MASK & (c - AC_UNIT)) |
1855     (TC_MASK & (c - TC_UNIT)) | (SP_MASK & c));
1856     dropped = U.compareAndSwapLong(this, CTL, c, nc);
1857     }
1858     else if (
1859     (v = ws[(wl - 1) & sp]) == null || v.scanState != sp)
1860     dropped = false; // stale; retry
1861     else {
1862     long nc = v.stackPred & SP_MASK;
1863     if (w == v || w.scanState >= 0) {
1864     canDrop = true; // w unqueued or topmost
1865     nc |= ((AC_MASK & c) | // ensure replacement
1866     (TC_MASK & (c - TC_UNIT)));
1867     }
1868     else { // w may be queued
1869     canDrop = false; // help uncover
1870     nc |= ((AC_MASK & (c + AC_UNIT)) |
1871     (TC_MASK & c));
1872     }
1873     if (U.compareAndSwapLong(this, CTL, c, nc)) {
1874     v.scanState = sp & ~UNSIGNALLED;
1875     LockSupport.unpark(v.parker);
1876     dropped = canDrop;
1877     }
1878     else
1879     dropped = false;
1880     }
1881     if (dropped) { // pre-deregister
1882     int cfg = w.config, idx = cfg & SMASK;
1883     if (idx >= 0 && idx < ws.length && ws[idx] == w)
1884     ws[idx] = null;
1885     w.config = cfg | UNREGISTERED;
1886     w.qlock = -1;
1887     return true;
1888 dl 1.200 }
1889 dl 1.177 }
1890 dl 1.243 }
1891     return false;
1892     }
1893    
1894     /**
1895     * Top-level runloop for workers, called by ForkJoinWorkerThread.run.
1896     */
1897     final void runWorker(WorkQueue w) {
1898     w.growArray(); // allocate queue
1899 dl 1.253 int bound = (w.config & SPARE_WORKER) != 0 ? 0 : POLL_LIMIT;
1900 dl 1.243 long seed = w.hint * 0xdaba0b6eb09322e3L; // initial random seed
1901 dl 1.289 if ((runState & STOP) == 0) {
1902     for (long r = (seed == 0L) ? 1L : seed;;) { // ensure nonzero
1903     if (bound == 0 && tryDropSpare(w))
1904     break;
1905     // high bits of prev seed for step; current low bits for idx
1906     int step = (int)(r >>> 48) | 1;
1907     r ^= r >>> 12; r ^= r << 25; r ^= r >>> 27; // xorshift
1908     if (scan(w, bound, step, (int)r) < 0 && awaitWork(w) < 0)
1909     break;
1910     }
1911 dl 1.243 }
1912     }
1913    
1914     // Scanning for tasks
1915    
1916     /**
1917     * Repeatedly scans for and tries to steal and execute (via
1918     * workQueue.runTask) a queued task. Each scan traverses queues in
1919     * pseudorandom permutation. Upon finding a non-empty queue, makes
1920 dl 1.253 * at most the given bound attempts to re-poll (fewer if
1921     * contended) on the same queue before returning (impossible
1922     * scanState value) 0 to restart scan. Else returns after at least
1923     * 1 and at most 32 full scans.
1924 dl 1.243 *
1925     * @param w the worker (via its WorkQueue)
1926 dl 1.253 * @param bound repoll bound as bitmask (0 if spare)
1927 dl 1.243 * @param step (circular) index increment per iteration (must be odd)
1928     * @param r a random seed for origin index
1929     * @return negative if should await signal
1930     */
1931 dl 1.253 private int scan(WorkQueue w, int bound, int step, int r) {
1932 dl 1.243 int stat = 0, wl; WorkQueue[] ws;
1933 dl 1.250 if ((ws = workQueues) != null && w != null && (wl = ws.length) > 0) {
1934 dl 1.243 for (int m = wl - 1,
1935 dl 1.250 origin = m & r, idx = origin,
1936 dl 1.243 npolls = 0,
1937     ss = w.scanState;;) { // negative if inactive
1938 dl 1.289 WorkQueue q; ForkJoinTask<?>[] a; int b, al;
1939     if ((q = ws[idx]) != null && (b = q.base) - q.top < 0 &&
1940 dl 1.243 (a = q.array) != null && (al = a.length) > 0) {
1941 dl 1.256 int index = (al - 1) & b;
1942     long offset = ((long)index << ASHIFT) + ABASE;
1943 dl 1.243 ForkJoinTask<?> t = (ForkJoinTask<?>)
1944     U.getObjectVolatile(a, offset);
1945 dl 1.262 if (t == null)
1946     break; // empty or busy
1947     else if (b++ != q.base)
1948     break; // busy
1949 dl 1.253 else if (ss < 0) {
1950 dl 1.258 tryReactivate(w, ws, r);
1951     break; // retry upon rescan
1952 dl 1.253 }
1953     else if (!U.compareAndSwapObject(a, offset, t, null))
1954     break; // contended
1955     else {
1956     q.base = b;
1957     w.currentSteal = t;
1958 dl 1.289 if (b != q.top) // propagate signal
1959 dl 1.253 signalWork();
1960     w.runTask(t);
1961     if (++npolls > bound)
1962     break;
1963 dl 1.243 }
1964 dl 1.178 }
1965 dl 1.243 else if (npolls != 0) // rescan
1966     break;
1967 dl 1.250 else if ((idx = (idx + step) & m) == origin) {
1968     if (ss < 0) { // await signal
1969     stat = ss;
1970     break;
1971     }
1972     else if (r >= 0) {
1973 dl 1.243 inactivate(w, ss);
1974 dl 1.250 break;
1975     }
1976     else
1977     r <<= 1; // at most 31 rescans
1978 dl 1.243 }
1979 dl 1.120 }
1980     }
1981 dl 1.243 return stat;
1982 dl 1.178 }
1983    
1984 dl 1.200 // Joining tasks
1985    
1986 dl 1.178 /**
1987 dl 1.200 * Tries to steal and run tasks within the target's computation.
1988     * Uses a variant of the top-level algorithm, restricted to tasks
1989     * with the given task as ancestor: It prefers taking and running
1990     * eligible tasks popped from the worker's own queue (via
1991     * popCC). Otherwise it scans others, randomly moving on
1992     * contention or execution, deciding to give up based on a
1993 dl 1.243 * checksum (via return codes from pollAndExecCC). The maxTasks
1994 dl 1.200 * argument supports external usages; internal calls use zero,
1995     * allowing unbounded steps (external calls trap non-positive
1996     * values).
1997     *
1998     * @param w caller
1999 jsr166 1.202 * @param maxTasks if non-zero, the maximum number of other tasks to run
2000 dl 1.200 * @return task status on exit
2001     */
2002     final int helpComplete(WorkQueue w, CountedCompleter<?> task,
2003     int maxTasks) {
2004 dl 1.243 WorkQueue[] ws; int s = 0, wl;
2005     if ((ws = workQueues) != null && (wl = ws.length) > 1 &&
2006 dl 1.200 task != null && w != null) {
2007 dl 1.253 for (int m = wl - 1,
2008     mode = w.config,
2009     r = ~mode, // scanning seed
2010     origin = r & m, k = origin, // first queue to scan
2011     step = 3, // first scan step
2012     h = 1, // 1:ran, >1:contended, <0:hash
2013     oldSum = 0, checkSum = 0;;) {
2014 dl 1.243 CountedCompleter<?> p; WorkQueue q; int i;
2015 dl 1.200 if ((s = task.status) < 0)
2016     break;
2017 dl 1.253 if (h == 1 && (p = w.popCC(task, mode)) != null) {
2018 dl 1.200 p.doExec(); // run local task
2019     if (maxTasks != 0 && --maxTasks == 0)
2020     break;
2021     origin = k; // reset
2022     oldSum = checkSum = 0;
2023     }
2024 dl 1.243 else { // poll other worker queues
2025     if ((i = k | 1) < 0 || i > m || (q = ws[i]) == null)
2026 dl 1.200 h = 0;
2027     else if ((h = q.pollAndExecCC(task)) < 0)
2028     checkSum += h;
2029     if (h > 0) {
2030     if (h == 1 && maxTasks != 0 && --maxTasks == 0)
2031     break;
2032 dl 1.253 step = (r >>> 16) | 3;
2033 dl 1.200 r ^= r << 13; r ^= r >>> 17; r ^= r << 5; // xorshift
2034 dl 1.243 k = origin = r & m; // move and restart
2035 dl 1.200 oldSum = checkSum = 0;
2036     }
2037 dl 1.243 else if ((k = (k + step) & m) == origin) {
2038 dl 1.200 if (oldSum == (oldSum = checkSum))
2039     break;
2040     checkSum = 0;
2041     }
2042     }
2043 dl 1.178 }
2044     }
2045 dl 1.200 return s;
2046 dl 1.120 }
2047    
2048     /**
2049 dl 1.78 * Tries to locate and execute tasks for a stealer of the given
2050 jsr166 1.265 * task, or in turn one of its stealers. Traces currentSteal ->
2051 dl 1.78 * currentJoin links looking for a thread working on a descendant
2052     * of the given task and with a non-empty queue to steal back and
2053     * execute tasks from. The first call to this method upon a
2054     * waiting join will often entail scanning/search, (which is OK
2055     * because the joiner has nothing better to do), but this method
2056 dl 1.200 * leaves hints in workers to speed up subsequent calls.
2057 dl 1.78 *
2058 dl 1.200 * @param w caller
2059 dl 1.78 * @param task the task to join
2060     */
2061 dl 1.200 private void helpStealer(WorkQueue w, ForkJoinTask<?> task) {
2062 dl 1.243 if (task != null && w != null) {
2063     ForkJoinTask<?> ps = w.currentSteal;
2064     WorkQueue[] ws; int wl, oldSum = 0;
2065     outer: while (w.tryRemoveAndExec(task) && task.status >= 0 &&
2066     (ws = workQueues) != null && (wl = ws.length) > 0) {
2067 dl 1.200 ForkJoinTask<?> subtask;
2068 dl 1.243 int m = wl - 1, checkSum = 0; // for stability check
2069 dl 1.200 WorkQueue j = w, v; // v is subtask stealer
2070     descent: for (subtask = task; subtask.status >= 0; ) {
2071 dl 1.243 for (int h = j.hint | 1, k = 0, i;;) {
2072     if ((v = ws[i = (h + (k << 1)) & m]) != null) {
2073 dl 1.200 if (v.currentSteal == subtask) {
2074     j.hint = i;
2075 dl 1.95 break;
2076     }
2077 dl 1.200 checkSum += v.base;
2078 dl 1.78 }
2079 dl 1.243 if (++k > m) // can't find stealer
2080     break outer;
2081 dl 1.78 }
2082 dl 1.243
2083 dl 1.200 for (;;) { // help v or descend
2084 dl 1.243 ForkJoinTask<?>[] a; int b, al;
2085     if (subtask.status < 0) // too late to help
2086     break descent;
2087 dl 1.200 checkSum += (b = v.base);
2088     ForkJoinTask<?> next = v.currentJoin;
2089 dl 1.243 ForkJoinTask<?> t = null;
2090     if ((a = v.array) != null && (al = a.length) > 0) {
2091 dl 1.256 int index = (al - 1) & b;
2092     long offset = ((long)index << ASHIFT) + ABASE;
2093 dl 1.262 t = (ForkJoinTask<?>)
2094     U.getObjectVolatile(a, offset);
2095 dl 1.243 if (t != null && b++ == v.base) {
2096     if (j.currentJoin != subtask ||
2097     v.currentSteal != subtask ||
2098     subtask.status < 0)
2099     break descent; // stale
2100     if (U.compareAndSwapObject(a, offset, t, null)) {
2101     v.base = b;
2102     w.currentSteal = t;
2103     for (int top = w.top;;) {
2104     t.doExec(); // help
2105     w.currentSteal = ps;
2106     if (task.status < 0)
2107     break outer;
2108     if (w.top == top)
2109     break; // run local tasks
2110     if ((t = w.pop()) == null)
2111     break descent;
2112     w.currentSteal = t;
2113     }
2114     }
2115     }
2116     }
2117     if (t == null && b == v.base && b - v.top >= 0) {
2118     if ((subtask = next) == null) { // try to descend
2119     if (next == v.currentJoin &&
2120     oldSum == (oldSum = checkSum))
2121     break outer;
2122 dl 1.200 break descent;
2123 dl 1.243 }
2124 dl 1.200 j = v;
2125     break;
2126 dl 1.95 }
2127 dl 1.52 }
2128 dl 1.19 }
2129 dl 1.243 }
2130 dl 1.14 }
2131 dl 1.22 }
2132    
2133 dl 1.52 /**
2134 dl 1.200 * Tries to decrement active count (sometimes implicitly) and
2135     * possibly release or create a compensating worker in preparation
2136     * for blocking. Returns false (retryable by caller), on
2137 dl 1.208 * contention, detected staleness, instability, or termination.
2138 dl 1.105 *
2139 dl 1.200 * @param w caller
2140 dl 1.19 */
2141 dl 1.200 private boolean tryCompensate(WorkQueue w) {
2142 dl 1.243 boolean canBlock; int wl;
2143     long c = ctl;
2144     WorkQueue[] ws = workQueues;
2145     int pc = config & SMASK;
2146     int ac = pc + (int)(c >> AC_SHIFT);
2147     int tc = pc + (short)(c >> TC_SHIFT);
2148     if (w == null || w.qlock < 0 || pc == 0 || // terminating or disabled
2149     ws == null || (wl = ws.length) <= 0)
2150 dl 1.200 canBlock = false;
2151     else {
2152 dl 1.243 int m = wl - 1, sp;
2153     boolean busy = true; // validate ac
2154     for (int i = 0; i <= m; ++i) {
2155     int k; WorkQueue v;
2156     if ((k = (i << 1) | 1) <= m && k >= 0 && (v = ws[k]) != null &&
2157     v.scanState >= 0 && v.currentSteal == null) {
2158     busy = false;
2159     break;
2160 dl 1.178 }
2161 dl 1.52 }
2162 dl 1.243 if (!busy || ctl != c)
2163     canBlock = false; // unstable or stale
2164     else if ((sp = (int)c) != 0) // release idle worker
2165     canBlock = tryRelease(c, ws[m & sp], 0L);
2166 dl 1.200 else if (tc >= pc && ac > 1 && w.isEmpty()) {
2167     long nc = ((AC_MASK & (c - AC_UNIT)) |
2168 dl 1.243 (~AC_MASK & c)); // uncompensated
2169 dl 1.200 canBlock = U.compareAndSwapLong(this, CTL, c, nc);
2170 dl 1.105 }
2171 dl 1.208 else if (tc >= MAX_CAP ||
2172 jsr166 1.273 (this == common && tc >= pc + COMMON_MAX_SPARES))
2173 dl 1.200 throw new RejectedExecutionException(
2174     "Thread limit exceeded replacing blocked worker");
2175 dl 1.243 else { // similar to tryAddWorker
2176     boolean isSpare = (tc >= pc);
2177     long nc = (AC_MASK & c) | (TC_MASK & (c + TC_UNIT));
2178     canBlock = (U.compareAndSwapLong(this, CTL, c, nc) &&
2179     createWorker(isSpare)); // throws on exception
2180 dl 1.90 }
2181     }
2182 dl 1.200 return canBlock;
2183 dl 1.90 }
2184    
2185     /**
2186 dl 1.200 * Helps and/or blocks until the given task is done or timeout.
2187 dl 1.90 *
2188 dl 1.200 * @param w caller
2189 dl 1.90 * @param task the task
2190 dl 1.219 * @param deadline for timed waits, if nonzero
2191 dl 1.90 * @return task status on exit
2192     */
2193 dl 1.200 final int awaitJoin(WorkQueue w, ForkJoinTask<?> task, long deadline) {
2194 dl 1.105 int s = 0;
2195 dl 1.243 if (w != null) {
2196 dl 1.200 ForkJoinTask<?> prevJoin = w.currentJoin;
2197 dl 1.243 if (task != null && (s = task.status) >= 0) {
2198     w.currentJoin = task;
2199     CountedCompleter<?> cc = (task instanceof CountedCompleter) ?
2200     (CountedCompleter<?>)task : null;
2201     for (;;) {
2202     if (cc != null)
2203     helpComplete(w, cc, 0);
2204     else
2205     helpStealer(w, task);
2206     if ((s = task.status) < 0)
2207     break;
2208     long ms, ns;
2209     if (deadline == 0L)
2210     ms = 0L;
2211     else if ((ns = deadline - System.nanoTime()) <= 0L)
2212     break;
2213     else if ((ms = TimeUnit.NANOSECONDS.toMillis(ns)) <= 0L)
2214     ms = 1L;
2215     if (tryCompensate(w)) {
2216     task.internalWait(ms);
2217     U.getAndAddLong(this, CTL, AC_UNIT);
2218     }
2219     if ((s = task.status) < 0)
2220     break;
2221 dl 1.90 }
2222 dl 1.243 w.currentJoin = prevJoin;
2223 dl 1.90 }
2224     }
2225 dl 1.94 return s;
2226 dl 1.90 }
2227    
2228 dl 1.200 // Specialized scanning
2229 dl 1.90
2230     /**
2231     * Returns a (probably) non-empty steal queue, if one is found
2232 dl 1.131 * during a scan, else null. This method must be retried by
2233     * caller if, by the time it tries to use the queue, it is empty.
2234 dl 1.78 */
2235 dl 1.178 private WorkQueue findNonEmptyStealQueue() {
2236 dl 1.243 WorkQueue[] ws; int wl; // one-shot version of scan loop
2237 dl 1.211 int r = ThreadLocalRandom.nextSecondarySeed();
2238 dl 1.243 if ((ws = workQueues) != null && (wl = ws.length) > 0) {
2239     int m = wl - 1, origin = r & m;
2240     for (int k = origin, oldSum = 0, checkSum = 0;;) {
2241 dl 1.211 WorkQueue q; int b;
2242     if ((q = ws[k]) != null) {
2243     if ((b = q.base) - q.top < 0)
2244     return q;
2245     checkSum += b;
2246     }
2247     if ((k = (k + 1) & m) == origin) {
2248     if (oldSum == (oldSum = checkSum))
2249     break;
2250     checkSum = 0;
2251 dl 1.52 }
2252     }
2253 dl 1.211 }
2254 dl 1.200 return null;
2255 dl 1.22 }
2256    
2257     /**
2258 dl 1.78 * Runs tasks until {@code isQuiescent()}. We piggyback on
2259     * active count ctl maintenance, but rather than blocking
2260     * when tasks cannot be found, we rescan until all others cannot
2261     * find tasks either.
2262     */
2263     final void helpQuiescePool(WorkQueue w) {
2264 dl 1.211 ForkJoinTask<?> ps = w.currentSteal; // save context
2265 dl 1.243 int wc = w.config;
2266 dl 1.78 for (boolean active = true;;) {
2267 dl 1.243 long c; WorkQueue q; ForkJoinTask<?> t;
2268     if (wc >= 0 && (t = w.pop()) != null) { // run locals if LIFO
2269     (w.currentSteal = t).doExec();
2270     w.currentSteal = ps;
2271     }
2272     else if ((q = findNonEmptyStealQueue()) != null) {
2273 dl 1.78 if (!active) { // re-establish active count
2274     active = true;
2275 dl 1.200 U.getAndAddLong(this, CTL, AC_UNIT);
2276     }
2277 dl 1.243 if ((t = q.pollAt(q.base)) != null) {
2278     (w.currentSteal = t).doExec();
2279     w.currentSteal = ps;
2280 dl 1.215 if (++w.nsteals < 0)
2281     w.transferStealCount(this);
2282 dl 1.178 }
2283 dl 1.78 }
2284 jsr166 1.194 else if (active) { // decrement active count without queuing
2285 dl 1.200 long nc = (AC_MASK & ((c = ctl) - AC_UNIT)) | (~AC_MASK & c);
2286 dl 1.131 if (U.compareAndSwapLong(this, CTL, c, nc))
2287 dl 1.78 active = false;
2288 dl 1.22 }
2289 dl 1.200 else if ((int)((c = ctl) >> AC_SHIFT) + (config & SMASK) <= 0 &&
2290     U.compareAndSwapLong(this, CTL, c, c + AC_UNIT))
2291 dl 1.185 break;
2292 dl 1.22 }
2293     }
2294    
2295     /**
2296 jsr166 1.84 * Gets and removes a local or stolen task for the given worker.
2297 dl 1.78 *
2298     * @return a task, if available
2299 dl 1.22 */
2300 dl 1.78 final ForkJoinTask<?> nextTaskFor(WorkQueue w) {
2301     for (ForkJoinTask<?> t;;) {
2302 dl 1.243 WorkQueue q;
2303 dl 1.78 if ((t = w.nextLocalTask()) != null)
2304     return t;
2305 dl 1.178 if ((q = findNonEmptyStealQueue()) == null)
2306 dl 1.78 return null;
2307 dl 1.243 if ((t = q.pollAt(q.base)) != null)
2308 dl 1.78 return t;
2309 dl 1.52 }
2310 dl 1.14 }
2311    
2312     /**
2313 dl 1.105 * Returns a cheap heuristic guide for task partitioning when
2314     * programmers, frameworks, tools, or languages have little or no
2315 jsr166 1.222 * idea about task granularity. In essence, by offering this
2316 dl 1.105 * method, we ask users only about tradeoffs in overhead vs
2317     * expected throughput and its variance, rather than how finely to
2318     * partition tasks.
2319     *
2320     * In a steady state strict (tree-structured) computation, each
2321     * thread makes available for stealing enough tasks for other
2322     * threads to remain active. Inductively, if all threads play by
2323     * the same rules, each thread should make available only a
2324     * constant number of tasks.
2325     *
2326     * The minimum useful constant is just 1. But using a value of 1
2327     * would require immediate replenishment upon each steal to
2328     * maintain enough tasks, which is infeasible. Further,
2329     * partitionings/granularities of offered tasks should minimize
2330     * steal rates, which in general means that threads nearer the top
2331     * of computation tree should generate more than those nearer the
2332     * bottom. In perfect steady state, each thread is at
2333     * approximately the same level of computation tree. However,
2334     * producing extra tasks amortizes the uncertainty of progress and
2335     * diffusion assumptions.
2336     *
2337 jsr166 1.161 * So, users will want to use values larger (but not much larger)
2338 dl 1.105 * than 1 to both smooth over transient shortages and hedge
2339     * against uneven progress; as traded off against the cost of
2340     * extra task overhead. We leave the user to pick a threshold
2341     * value to compare with the results of this call to guide
2342     * decisions, but recommend values such as 3.
2343     *
2344     * When all threads are active, it is on average OK to estimate
2345     * surplus strictly locally. In steady-state, if one thread is
2346     * maintaining say 2 surplus tasks, then so are others. So we can
2347     * just use estimated queue length. However, this strategy alone
2348     * leads to serious mis-estimates in some non-steady-state
2349     * conditions (ramp-up, ramp-down, other stalls). We can detect
2350     * many of these by further considering the number of "idle"
2351     * threads, that are known to have zero queued tasks, so
2352     * compensate by a factor of (#idle/#active) threads.
2353     */
2354     static int getSurplusQueuedTaskCount() {
2355     Thread t; ForkJoinWorkerThread wt; ForkJoinPool pool; WorkQueue q;
2356 jsr166 1.229 if ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) {
2357 dl 1.243 int p = (pool = (wt = (ForkJoinWorkerThread)t).pool).config & SMASK;
2358 dl 1.112 int n = (q = wt.workQueue).top - q.base;
2359 dl 1.105 int a = (int)(pool.ctl >> AC_SHIFT) + p;
2360 dl 1.112 return n - (a > (p >>>= 1) ? 0 :
2361     a > (p >>>= 1) ? 1 :
2362     a > (p >>>= 1) ? 2 :
2363     a > (p >>>= 1) ? 4 :
2364     8);
2365 dl 1.105 }
2366     return 0;
2367 dl 1.100 }
2368    
2369 dl 1.86 // Termination
2370 dl 1.14
2371     /**
2372 dl 1.210 * Possibly initiates and/or completes termination.
2373 dl 1.14 *
2374     * @param now if true, unconditionally terminate, else only
2375 dl 1.78 * if no work and no active workers
2376 dl 1.243 * @param enable if true, terminate when next possible
2377 dl 1.294 * @return -1: terminating/terminated, 0: retry if internal caller, else 1
2378 jsr166 1.1 */
2379 dl 1.286 private int tryTerminate(boolean now, boolean enable) {
2380 dl 1.294 int rs; // 3 phases: try to set SHUTDOWN, then STOP, then TERMINATED
2381 dl 1.289
2382 dl 1.294 while ((rs = runState) >= 0) {
2383     if (!enable || this == common) // cannot shutdown
2384 dl 1.289 return 1;
2385 dl 1.294 else if (rs == 0)
2386     tryInitialize(false); // ensure initialized
2387     else
2388     U.compareAndSwapInt(this, RUNSTATE, rs, rs | SHUTDOWN);
2389 dl 1.289 }
2390    
2391 dl 1.294 if ((rs & STOP) == 0) { // try to initiate termination
2392 dl 1.210 if (!now) { // check quiescence
2393 dl 1.211 for (long oldSum = 0L;;) { // repeat until stable
2394 dl 1.289 WorkQueue[] ws; WorkQueue w; int b;
2395 dl 1.210 long checkSum = ctl;
2396     if ((int)(checkSum >> AC_SHIFT) + (config & SMASK) > 0)
2397 dl 1.286 return 0; // still active workers
2398 dl 1.289 if ((ws = workQueues) != null) {
2399     for (int i = 0; i < ws.length; ++i) {
2400     if ((w = ws[i]) != null) {
2401     checkSum += (b = w.base);
2402     if (w.currentSteal != null || b != w.top)
2403     return 0; // retry if internal caller
2404     }
2405 dl 1.206 }
2406 dl 1.203 }
2407 dl 1.286 if (oldSum == (oldSum = checkSum))
2408 dl 1.210 break;
2409 dl 1.203 }
2410     }
2411 dl 1.294 do {} while (!U.compareAndSwapInt(this, RUNSTATE,
2412     rs = runState, rs | STOP));
2413 dl 1.200 }
2414 dl 1.210
2415 dl 1.289 for (long oldSum = 0L;;) { // repeat until stable
2416     WorkQueue[] ws; WorkQueue w; ForkJoinWorkerThread wt;
2417 dl 1.210 long checkSum = ctl;
2418 dl 1.289 if ((ws = workQueues) != null) { // help terminate others
2419     for (int i = 0; i < ws.length; ++i) {
2420     if ((w = ws[i]) != null) {
2421     w.cancelAll(); // clear queues
2422     checkSum += w.base;
2423     if (w.qlock >= 0) {
2424     w.qlock = -1; // racy set OK
2425     if ((wt = w.owner) != null) {
2426     try { // unblock join or park
2427 dl 1.210 wt.interrupt();
2428     } catch (Throwable ignore) {
2429 dl 1.200 }
2430     }
2431     }
2432 dl 1.101 }
2433 dl 1.78 }
2434     }
2435 dl 1.289 if (oldSum == (oldSum = checkSum))
2436 dl 1.210 break;
2437 dl 1.289 }
2438    
2439     if ((short)(ctl >>> TC_SHIFT) + (config & SMASK) <= 0) {
2440 dl 1.294 runState = (STARTED | SHUTDOWN | STOP | TERMINATED); // final write
2441 dl 1.289 synchronized (this) {
2442     notifyAll(); // for awaitTermination
2443 dl 1.200 }
2444     }
2445 dl 1.289
2446 dl 1.286 return -1;
2447 dl 1.200 }
2448    
2449     // External operations
2450    
2451     /**
2452 dl 1.243 * Constructs and tries to install a new external queue,
2453     * failing if the workQueues array already has a queue at
2454 jsr166 1.245 * the given index.
2455 dl 1.243 *
2456     * @param index the index of the new queue
2457     */
2458     private void tryCreateExternalQueue(int index) {
2459 dl 1.262 AuxState aux;
2460     if ((aux = auxState) != null && index >= 0) {
2461 dl 1.243 WorkQueue q = new WorkQueue(this, null);
2462     q.config = index;
2463     q.scanState = ~UNSIGNALLED;
2464 dl 1.256 q.qlock = 1; // lock queue
2465     boolean installed = false;
2466 dl 1.262 aux.lock();
2467 dl 1.294 try { // lock pool to install
2468 dl 1.243 WorkQueue[] ws;
2469     if ((ws = workQueues) != null && index < ws.length &&
2470     ws[index] == null) {
2471 dl 1.256 ws[index] = q; // else throw away
2472     installed = true;
2473     }
2474 dl 1.262 } finally {
2475     aux.unlock();
2476 dl 1.256 }
2477     if (installed) {
2478     try {
2479     q.growArray();
2480     } finally {
2481     q.qlock = 0;
2482 dl 1.243 }
2483     }
2484     }
2485     }
2486    
2487     /**
2488     * Adds the given task to a submission queue at submitter's
2489     * current queue. Also performs secondary initialization upon the
2490     * first submission of the first task to the pool, and detects
2491 dl 1.200 * first submission by an external thread and creates a new shared
2492     * queue if the one at index if empty or contended.
2493     *
2494     * @param task the task. Caller must ensure non-null.
2495     */
2496 dl 1.243 final void externalPush(ForkJoinTask<?> task) {
2497 dl 1.256 int r; // initialize caller's probe
2498 dl 1.200 if ((r = ThreadLocalRandom.getProbe()) == 0) {
2499     ThreadLocalRandom.localInit();
2500     r = ThreadLocalRandom.getProbe();
2501     }
2502     for (;;) {
2503 dl 1.256 WorkQueue q; int wl, k, stat;
2504 dl 1.243 int rs = runState;
2505     WorkQueue[] ws = workQueues;
2506     if (rs <= 0 || ws == null || (wl = ws.length) <= 0)
2507 dl 1.258 tryInitialize(true);
2508 dl 1.243 else if ((q = ws[k = (wl - 1) & r & SQMASK]) == null)
2509     tryCreateExternalQueue(k);
2510 dl 1.294 else if ((stat = q.sharedPush(task)) < 0)
2511     break;
2512     else if (stat == 0) {
2513     signalWork();
2514 dl 1.256 break;
2515 dl 1.200 }
2516 dl 1.256 else // move if busy
2517 dl 1.200 r = ThreadLocalRandom.advanceProbe(r);
2518 dl 1.52 }
2519     }
2520 jsr166 1.283
2521 dl 1.200 /**
2522 jsr166 1.237 * Pushes a possibly-external submission.
2523 dl 1.236 */
2524 dl 1.243 private <T> ForkJoinTask<T> externalSubmit(ForkJoinTask<T> task) {
2525     Thread t; ForkJoinWorkerThread w; WorkQueue q;
2526 dl 1.236 if (task == null)
2527     throw new NullPointerException();
2528     if (((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) &&
2529 dl 1.243 (w = (ForkJoinWorkerThread)t).pool == this &&
2530     (q = w.workQueue) != null)
2531     q.push(task);
2532 jsr166 1.238 else
2533 dl 1.236 externalPush(task);
2534     return task;
2535     }
2536    
2537     /**
2538 jsr166 1.213 * Returns common pool queue for an external thread.
2539 dl 1.105 */
2540     static WorkQueue commonSubmitterQueue() {
2541 dl 1.200 ForkJoinPool p = common;
2542     int r = ThreadLocalRandom.getProbe();
2543 dl 1.243 WorkQueue[] ws; int wl;
2544 dl 1.200 return (p != null && (ws = p.workQueues) != null &&
2545 dl 1.243 (wl = ws.length) > 0) ?
2546     ws[(wl - 1) & r & SQMASK] : null;
2547 dl 1.105 }
2548    
2549     /**
2550 jsr166 1.246 * Performs tryUnpush for an external submitter.
2551 dl 1.105 */
2552 dl 1.178 final boolean tryExternalUnpush(ForkJoinTask<?> task) {
2553 dl 1.200 int r = ThreadLocalRandom.getProbe();
2554 dl 1.243 WorkQueue[] ws; WorkQueue w; int wl;
2555     return ((ws = workQueues) != null &&
2556     (wl = ws.length) > 0 &&
2557     (w = ws[(wl - 1) & r & SQMASK]) != null &&
2558     w.trySharedUnpush(task));
2559 dl 1.105 }
2560    
2561 dl 1.200 /**
2562 jsr166 1.213 * Performs helpComplete for an external submitter.
2563 dl 1.200 */
2564 dl 1.190 final int externalHelpComplete(CountedCompleter<?> task, int maxTasks) {
2565 dl 1.243 WorkQueue[] ws; int wl;
2566 dl 1.200 int r = ThreadLocalRandom.getProbe();
2567 dl 1.243 return ((ws = workQueues) != null && (wl = ws.length) > 0) ?
2568     helpComplete(ws[(wl - 1) & r & SQMASK], task, maxTasks) : 0;
2569 dl 1.105 }
2570    
2571 dl 1.52 // Exported methods
2572 jsr166 1.1
2573     // Constructors
2574    
2575     /**
2576 jsr166 1.9 * Creates a {@code ForkJoinPool} with parallelism equal to {@link
2577 dl 1.18 * java.lang.Runtime#availableProcessors}, using the {@linkplain
2578     * #defaultForkJoinWorkerThreadFactory default thread factory},
2579     * no UncaughtExceptionHandler, and non-async LIFO processing mode.
2580 jsr166 1.1 *
2581     * @throws SecurityException if a security manager exists and
2582     * the caller is not permitted to modify threads
2583     * because it does not hold {@link
2584     * java.lang.RuntimePermission}{@code ("modifyThread")}
2585     */
2586     public ForkJoinPool() {
2587 jsr166 1.148 this(Math.min(MAX_CAP, Runtime.getRuntime().availableProcessors()),
2588     defaultForkJoinWorkerThreadFactory, null, false);
2589 jsr166 1.1 }
2590    
2591     /**
2592 jsr166 1.9 * Creates a {@code ForkJoinPool} with the indicated parallelism
2593 dl 1.18 * level, the {@linkplain
2594     * #defaultForkJoinWorkerThreadFactory default thread factory},
2595     * no UncaughtExceptionHandler, and non-async LIFO processing mode.
2596 jsr166 1.1 *
2597 jsr166 1.9 * @param parallelism the parallelism level
2598 jsr166 1.1 * @throws IllegalArgumentException if parallelism less than or
2599 jsr166 1.11 * equal to zero, or greater than implementation limit
2600 jsr166 1.1 * @throws SecurityException if a security manager exists and
2601     * the caller is not permitted to modify threads
2602     * because it does not hold {@link
2603     * java.lang.RuntimePermission}{@code ("modifyThread")}
2604     */
2605     public ForkJoinPool(int parallelism) {
2606 dl 1.18 this(parallelism, defaultForkJoinWorkerThreadFactory, null, false);
2607 jsr166 1.1 }
2608    
2609     /**
2610 dl 1.18 * Creates a {@code ForkJoinPool} with the given parameters.
2611 jsr166 1.1 *
2612 dl 1.18 * @param parallelism the parallelism level. For default value,
2613     * use {@link java.lang.Runtime#availableProcessors}.
2614     * @param factory the factory for creating new threads. For default value,
2615     * use {@link #defaultForkJoinWorkerThreadFactory}.
2616 dl 1.19 * @param handler the handler for internal worker threads that
2617     * terminate due to unrecoverable errors encountered while executing
2618 jsr166 1.31 * tasks. For default value, use {@code null}.
2619 dl 1.19 * @param asyncMode if true,
2620 dl 1.18 * establishes local first-in-first-out scheduling mode for forked
2621     * tasks that are never joined. This mode may be more appropriate
2622     * than default locally stack-based mode in applications in which
2623     * worker threads only process event-style asynchronous tasks.
2624 jsr166 1.31 * For default value, use {@code false}.
2625 jsr166 1.1 * @throws IllegalArgumentException if parallelism less than or
2626 jsr166 1.11 * equal to zero, or greater than implementation limit
2627     * @throws NullPointerException if the factory is null
2628 jsr166 1.1 * @throws SecurityException if a security manager exists and
2629     * the caller is not permitted to modify threads
2630     * because it does not hold {@link
2631     * java.lang.RuntimePermission}{@code ("modifyThread")}
2632     */
2633 dl 1.19 public ForkJoinPool(int parallelism,
2634 dl 1.18 ForkJoinWorkerThreadFactory factory,
2635 jsr166 1.156 UncaughtExceptionHandler handler,
2636 dl 1.18 boolean asyncMode) {
2637 dl 1.152 this(checkParallelism(parallelism),
2638     checkFactory(factory),
2639     handler,
2640 jsr166 1.201 asyncMode ? FIFO_QUEUE : LIFO_QUEUE,
2641 dl 1.152 "ForkJoinPool-" + nextPoolId() + "-worker-");
2642 dl 1.14 checkPermission();
2643 dl 1.152 }
2644    
2645     private static int checkParallelism(int parallelism) {
2646     if (parallelism <= 0 || parallelism > MAX_CAP)
2647     throw new IllegalArgumentException();
2648     return parallelism;
2649     }
2650    
2651     private static ForkJoinWorkerThreadFactory checkFactory
2652     (ForkJoinWorkerThreadFactory factory) {
2653 dl 1.14 if (factory == null)
2654     throw new NullPointerException();
2655 dl 1.152 return factory;
2656     }
2657    
2658     /**
2659     * Creates a {@code ForkJoinPool} with the given parameters, without
2660     * any security checks or parameter validation. Invoked directly by
2661     * makeCommonPool.
2662     */
2663     private ForkJoinPool(int parallelism,
2664     ForkJoinWorkerThreadFactory factory,
2665 jsr166 1.156 UncaughtExceptionHandler handler,
2666 dl 1.185 int mode,
2667 dl 1.152 String workerNamePrefix) {
2668     this.workerNamePrefix = workerNamePrefix;
2669 jsr166 1.1 this.factory = factory;
2670 dl 1.18 this.ueh = handler;
2671 dl 1.200 this.config = (parallelism & SMASK) | mode;
2672 dl 1.52 long np = (long)(-parallelism); // offset ctl counts
2673     this.ctl = ((np << AC_SHIFT) & AC_MASK) | ((np << TC_SHIFT) & TC_MASK);
2674 dl 1.101 }
2675    
2676     /**
2677 dl 1.128 * Returns the common pool instance. This pool is statically
2678 dl 1.134 * constructed; its run state is unaffected by attempts to {@link
2679     * #shutdown} or {@link #shutdownNow}. However this pool and any
2680     * ongoing processing are automatically terminated upon program
2681     * {@link System#exit}. Any program that relies on asynchronous
2682     * task processing to complete before program termination should
2683 jsr166 1.158 * invoke {@code commonPool().}{@link #awaitQuiescence awaitQuiescence},
2684     * before exit.
2685 dl 1.100 *
2686     * @return the common pool instance
2687 jsr166 1.138 * @since 1.8
2688 dl 1.100 */
2689     public static ForkJoinPool commonPool() {
2690 dl 1.134 // assert common != null : "static init error";
2691     return common;
2692 dl 1.100 }
2693    
2694 jsr166 1.1 // Execution methods
2695    
2696     /**
2697     * Performs the given task, returning its result upon completion.
2698 dl 1.52 * If the computation encounters an unchecked Exception or Error,
2699     * it is rethrown as the outcome of this invocation. Rethrown
2700     * exceptions behave in the same way as regular exceptions, but,
2701     * when possible, contain stack traces (as displayed for example
2702     * using {@code ex.printStackTrace()}) of both the current thread
2703     * as well as the thread actually encountering the exception;
2704     * minimally only the latter.
2705 jsr166 1.1 *
2706     * @param task the task
2707 jsr166 1.191 * @param <T> the type of the task's result
2708 jsr166 1.1 * @return the task's result
2709 jsr166 1.11 * @throws NullPointerException if the task is null
2710     * @throws RejectedExecutionException if the task cannot be
2711     * scheduled for execution
2712 jsr166 1.1 */
2713     public <T> T invoke(ForkJoinTask<T> task) {
2714 dl 1.90 if (task == null)
2715     throw new NullPointerException();
2716 dl 1.243 externalSubmit(task);
2717 dl 1.78 return task.join();
2718 jsr166 1.1 }
2719    
2720     /**
2721     * Arranges for (asynchronous) execution of the given task.
2722     *
2723     * @param task the task
2724 jsr166 1.11 * @throws NullPointerException if the task is null
2725     * @throws RejectedExecutionException if the task cannot be
2726     * scheduled for execution
2727 jsr166 1.1 */
2728 jsr166 1.8 public void execute(ForkJoinTask<?> task) {
2729 dl 1.243 externalSubmit(task);
2730 jsr166 1.1 }
2731    
2732     // AbstractExecutorService methods
2733    
2734 jsr166 1.11 /**
2735     * @throws NullPointerException if the task is null
2736     * @throws RejectedExecutionException if the task cannot be
2737     * scheduled for execution
2738     */
2739 jsr166 1.1 public void execute(Runnable task) {
2740 dl 1.41 if (task == null)
2741     throw new NullPointerException();
2742 jsr166 1.2 ForkJoinTask<?> job;
2743 jsr166 1.3 if (task instanceof ForkJoinTask<?>) // avoid re-wrap
2744     job = (ForkJoinTask<?>) task;
2745 jsr166 1.2 else
2746 dl 1.152 job = new ForkJoinTask.RunnableExecuteAction(task);
2747 dl 1.243 externalSubmit(job);
2748 jsr166 1.1 }
2749    
2750 jsr166 1.11 /**
2751 dl 1.18 * Submits a ForkJoinTask for execution.
2752     *
2753     * @param task the task to submit
2754 jsr166 1.191 * @param <T> the type of the task's result
2755 dl 1.18 * @return the task
2756     * @throws NullPointerException if the task is null
2757     * @throws RejectedExecutionException if the task cannot be
2758     * scheduled for execution
2759     */
2760     public <T> ForkJoinTask<T> submit(ForkJoinTask<T> task) {
2761 dl 1.243 return externalSubmit(task);
2762 dl 1.18 }
2763    
2764     /**
2765 jsr166 1.11 * @throws NullPointerException if the task is null
2766     * @throws RejectedExecutionException if the task cannot be
2767     * scheduled for execution
2768     */
2769 jsr166 1.1 public <T> ForkJoinTask<T> submit(Callable<T> task) {
2770 dl 1.243 return externalSubmit(new ForkJoinTask.AdaptedCallable<T>(task));
2771 jsr166 1.1 }
2772    
2773 jsr166 1.11 /**
2774     * @throws NullPointerException if the task is null
2775     * @throws RejectedExecutionException if the task cannot be
2776     * scheduled for execution
2777     */
2778 jsr166 1.1 public <T> ForkJoinTask<T> submit(Runnable task, T result) {
2779 dl 1.243 return externalSubmit(new ForkJoinTask.AdaptedRunnable<T>(task, result));
2780 jsr166 1.1 }
2781    
2782 jsr166 1.11 /**
2783     * @throws NullPointerException if the task is null
2784     * @throws RejectedExecutionException if the task cannot be
2785     * scheduled for execution
2786     */
2787 jsr166 1.1 public ForkJoinTask<?> submit(Runnable task) {
2788 dl 1.41 if (task == null)
2789     throw new NullPointerException();
2790 jsr166 1.2 ForkJoinTask<?> job;
2791 jsr166 1.3 if (task instanceof ForkJoinTask<?>) // avoid re-wrap
2792     job = (ForkJoinTask<?>) task;
2793 jsr166 1.2 else
2794 dl 1.90 job = new ForkJoinTask.AdaptedRunnableAction(task);
2795 dl 1.243 return externalSubmit(job);
2796 jsr166 1.1 }
2797    
2798     /**
2799 jsr166 1.11 * @throws NullPointerException {@inheritDoc}
2800     * @throws RejectedExecutionException {@inheritDoc}
2801     */
2802 jsr166 1.1 public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks) {
2803 dl 1.86 // In previous versions of this class, this method constructed
2804     // a task to run ForkJoinTask.invokeAll, but now external
2805     // invocation of multiple tasks is at least as efficient.
2806 jsr166 1.199 ArrayList<Future<T>> futures = new ArrayList<>(tasks.size());
2807 jsr166 1.1
2808 dl 1.86 try {
2809     for (Callable<T> t : tasks) {
2810 dl 1.90 ForkJoinTask<T> f = new ForkJoinTask.AdaptedCallable<T>(t);
2811 jsr166 1.144 futures.add(f);
2812 dl 1.243 externalSubmit(f);
2813 dl 1.86 }
2814 jsr166 1.143 for (int i = 0, size = futures.size(); i < size; i++)
2815     ((ForkJoinTask<?>)futures.get(i)).quietlyJoin();
2816 dl 1.86 return futures;
2817 jsr166 1.226 } catch (Throwable t) {
2818     for (int i = 0, size = futures.size(); i < size; i++)
2819     futures.get(i).cancel(false);
2820     throw t;
2821 jsr166 1.1 }
2822     }
2823    
2824     /**
2825     * Returns the factory used for constructing new workers.
2826     *
2827     * @return the factory used for constructing new workers
2828     */
2829     public ForkJoinWorkerThreadFactory getFactory() {
2830     return factory;
2831     }
2832    
2833     /**
2834     * Returns the handler for internal worker threads that terminate
2835     * due to unrecoverable errors encountered while executing tasks.
2836     *
2837 jsr166 1.4 * @return the handler, or {@code null} if none
2838 jsr166 1.1 */
2839 jsr166 1.156 public UncaughtExceptionHandler getUncaughtExceptionHandler() {
2840 dl 1.14 return ueh;
2841 jsr166 1.1 }
2842    
2843     /**
2844 jsr166 1.9 * Returns the targeted parallelism level of this pool.
2845 jsr166 1.1 *
2846 jsr166 1.9 * @return the targeted parallelism level of this pool
2847 jsr166 1.1 */
2848     public int getParallelism() {
2849 dl 1.185 int par;
2850 dl 1.200 return ((par = config & SMASK) > 0) ? par : 1;
2851 jsr166 1.1 }
2852    
2853     /**
2854 dl 1.100 * Returns the targeted parallelism level of the common pool.
2855     *
2856     * @return the targeted parallelism level of the common pool
2857 jsr166 1.138 * @since 1.8
2858 dl 1.100 */
2859     public static int getCommonPoolParallelism() {
2860 jsr166 1.274 return COMMON_PARALLELISM;
2861 dl 1.100 }
2862    
2863     /**
2864 jsr166 1.1 * Returns the number of worker threads that have started but not
2865 jsr166 1.34 * yet terminated. The result returned by this method may differ
2866 jsr166 1.4 * from {@link #getParallelism} when threads are created to
2867 jsr166 1.1 * maintain parallelism when others are cooperatively blocked.
2868     *
2869     * @return the number of worker threads
2870     */
2871     public int getPoolSize() {
2872 dl 1.200 return (config & SMASK) + (short)(ctl >>> TC_SHIFT);
2873 jsr166 1.1 }
2874    
2875     /**
2876 jsr166 1.4 * Returns {@code true} if this pool uses local first-in-first-out
2877 jsr166 1.1 * scheduling mode for forked tasks that are never joined.
2878     *
2879 jsr166 1.4 * @return {@code true} if this pool uses async mode
2880 jsr166 1.1 */
2881     public boolean getAsyncMode() {
2882 dl 1.200 return (config & FIFO_QUEUE) != 0;
2883 jsr166 1.1 }
2884    
2885     /**
2886     * Returns an estimate of the number of worker threads that are
2887     * not blocked waiting to join tasks or for other managed
2888 dl 1.14 * synchronization. This method may overestimate the
2889     * number of running threads.
2890 jsr166 1.1 *
2891     * @return the number of worker threads
2892     */
2893     public int getRunningThreadCount() {
2894 dl 1.78 int rc = 0;
2895     WorkQueue[] ws; WorkQueue w;
2896     if ((ws = workQueues) != null) {
2897 dl 1.86 for (int i = 1; i < ws.length; i += 2) {
2898     if ((w = ws[i]) != null && w.isApparentlyUnblocked())
2899 dl 1.78 ++rc;
2900     }
2901     }
2902     return rc;
2903 jsr166 1.1 }
2904    
2905     /**
2906     * Returns an estimate of the number of threads that are currently
2907     * stealing or executing tasks. This method may overestimate the
2908     * number of active threads.
2909     *
2910     * @return the number of active threads
2911     */
2912     public int getActiveThreadCount() {
2913 dl 1.200 int r = (config & SMASK) + (int)(ctl >> AC_SHIFT);
2914 jsr166 1.63 return (r <= 0) ? 0 : r; // suppress momentarily negative values
2915 jsr166 1.1 }
2916    
2917     /**
2918 jsr166 1.4 * Returns {@code true} if all worker threads are currently idle.
2919     * An idle worker is one that cannot obtain a task to execute
2920     * because none are available to steal from other threads, and
2921     * there are no pending submissions to the pool. This method is
2922     * conservative; it might not return {@code true} immediately upon
2923     * idleness of all threads, but will eventually become true if
2924     * threads remain inactive.
2925 jsr166 1.1 *
2926 jsr166 1.4 * @return {@code true} if all threads are currently idle
2927 jsr166 1.1 */
2928     public boolean isQuiescent() {
2929 dl 1.200 return (config & SMASK) + (int)(ctl >> AC_SHIFT) <= 0;
2930 jsr166 1.1 }
2931    
2932     /**
2933     * Returns an estimate of the total number of tasks stolen from
2934     * one thread's work queue by another. The reported value
2935     * underestimates the actual total number of steals when the pool
2936     * is not quiescent. This value may be useful for monitoring and
2937     * tuning fork/join programs: in general, steal counts should be
2938     * high enough to keep threads busy, but low enough to avoid
2939     * overhead and contention across threads.
2940     *
2941     * @return the number of steals
2942     */
2943     public long getStealCount() {
2944 dl 1.262 AuxState sc = auxState;
2945     long count = (sc == null) ? 0L : sc.stealCount;
2946 dl 1.78 WorkQueue[] ws; WorkQueue w;
2947     if ((ws = workQueues) != null) {
2948 dl 1.86 for (int i = 1; i < ws.length; i += 2) {
2949 dl 1.78 if ((w = ws[i]) != null)
2950 dl 1.105 count += w.nsteals;
2951 dl 1.78 }
2952     }
2953     return count;
2954 jsr166 1.1 }
2955    
2956     /**
2957     * Returns an estimate of the total number of tasks currently held
2958     * in queues by worker threads (but not including tasks submitted
2959     * to the pool that have not begun executing). This value is only
2960     * an approximation, obtained by iterating across all threads in
2961     * the pool. This method may be useful for tuning task
2962     * granularities.
2963     *
2964     * @return the number of queued tasks
2965     */
2966     public long getQueuedTaskCount() {
2967     long count = 0;
2968 dl 1.78 WorkQueue[] ws; WorkQueue w;
2969     if ((ws = workQueues) != null) {
2970 dl 1.86 for (int i = 1; i < ws.length; i += 2) {
2971 dl 1.78 if ((w = ws[i]) != null)
2972     count += w.queueSize();
2973     }
2974 dl 1.52 }
2975 jsr166 1.1 return count;
2976     }
2977    
2978     /**
2979 jsr166 1.8 * Returns an estimate of the number of tasks submitted to this
2980 dl 1.55 * pool that have not yet begun executing. This method may take
2981 dl 1.52 * time proportional to the number of submissions.
2982 jsr166 1.1 *
2983     * @return the number of queued submissions
2984     */
2985     public int getQueuedSubmissionCount() {
2986 dl 1.78 int count = 0;
2987     WorkQueue[] ws; WorkQueue w;
2988     if ((ws = workQueues) != null) {
2989 dl 1.86 for (int i = 0; i < ws.length; i += 2) {
2990 dl 1.78 if ((w = ws[i]) != null)
2991     count += w.queueSize();
2992     }
2993     }
2994     return count;
2995 jsr166 1.1 }
2996    
2997     /**
2998 jsr166 1.4 * Returns {@code true} if there are any tasks submitted to this
2999     * pool that have not yet begun executing.
3000 jsr166 1.1 *
3001     * @return {@code true} if there are any queued submissions
3002     */
3003     public boolean hasQueuedSubmissions() {
3004 dl 1.78 WorkQueue[] ws; WorkQueue w;
3005     if ((ws = workQueues) != null) {
3006 dl 1.86 for (int i = 0; i < ws.length; i += 2) {
3007 dl 1.115 if ((w = ws[i]) != null && !w.isEmpty())
3008 dl 1.78 return true;
3009     }
3010     }
3011     return false;
3012 jsr166 1.1 }
3013    
3014     /**
3015     * Removes and returns the next unexecuted submission if one is
3016     * available. This method may be useful in extensions to this
3017     * class that re-assign work in systems with multiple pools.
3018     *
3019 jsr166 1.4 * @return the next submission, or {@code null} if none
3020 jsr166 1.1 */
3021     protected ForkJoinTask<?> pollSubmission() {
3022 dl 1.253 WorkQueue[] ws; int wl; WorkQueue w; ForkJoinTask<?> t;
3023     int r = ThreadLocalRandom.nextSecondarySeed();
3024     if ((ws = workQueues) != null && (wl = ws.length) > 0) {
3025     for (int m = wl - 1, i = 0; i < wl; ++i) {
3026     if ((w = ws[(i << 1) & m]) != null && (t = w.poll()) != null)
3027 dl 1.78 return t;
3028 dl 1.52 }
3029     }
3030     return null;
3031 jsr166 1.1 }
3032    
3033     /**
3034     * Removes all available unexecuted submitted and forked tasks
3035     * from scheduling queues and adds them to the given collection,
3036     * without altering their execution status. These may include
3037 jsr166 1.8 * artificially generated or wrapped tasks. This method is
3038     * designed to be invoked only when the pool is known to be
3039 jsr166 1.1 * quiescent. Invocations at other times may not remove all
3040     * tasks. A failure encountered while attempting to add elements
3041     * to collection {@code c} may result in elements being in
3042     * neither, either or both collections when the associated
3043     * exception is thrown. The behavior of this operation is
3044     * undefined if the specified collection is modified while the
3045     * operation is in progress.
3046     *
3047     * @param c the collection to transfer elements into
3048     * @return the number of elements transferred
3049     */
3050 jsr166 1.5 protected int drainTasksTo(Collection<? super ForkJoinTask<?>> c) {
3051 dl 1.52 int count = 0;
3052 dl 1.78 WorkQueue[] ws; WorkQueue w; ForkJoinTask<?> t;
3053     if ((ws = workQueues) != null) {
3054 dl 1.86 for (int i = 0; i < ws.length; ++i) {
3055 dl 1.78 if ((w = ws[i]) != null) {
3056     while ((t = w.poll()) != null) {
3057     c.add(t);
3058     ++count;
3059     }
3060     }
3061 dl 1.52 }
3062     }
3063 dl 1.18 return count;
3064     }
3065    
3066     /**
3067 jsr166 1.1 * Returns a string identifying this pool, as well as its state,
3068     * including indications of run state, parallelism level, and
3069     * worker and task counts.
3070     *
3071     * @return a string identifying this pool, as well as its state
3072     */
3073     public String toString() {
3074 dl 1.86 // Use a single pass through workQueues to collect counts
3075     long qt = 0L, qs = 0L; int rc = 0;
3076 dl 1.262 AuxState sc = auxState;
3077     long st = (sc == null) ? 0L : sc.stealCount;
3078 dl 1.86 long c = ctl;
3079     WorkQueue[] ws; WorkQueue w;
3080     if ((ws = workQueues) != null) {
3081     for (int i = 0; i < ws.length; ++i) {
3082     if ((w = ws[i]) != null) {
3083     int size = w.queueSize();
3084     if ((i & 1) == 0)
3085     qs += size;
3086     else {
3087     qt += size;
3088 dl 1.105 st += w.nsteals;
3089 dl 1.86 if (w.isApparentlyUnblocked())
3090     ++rc;
3091     }
3092     }
3093     }
3094     }
3095 dl 1.200 int pc = (config & SMASK);
3096 dl 1.52 int tc = pc + (short)(c >>> TC_SHIFT);
3097 dl 1.78 int ac = pc + (int)(c >> AC_SHIFT);
3098     if (ac < 0) // ignore transient negative
3099     ac = 0;
3100 dl 1.200 int rs = runState;
3101     String level = ((rs & TERMINATED) != 0 ? "Terminated" :
3102     (rs & STOP) != 0 ? "Terminating" :
3103     (rs & SHUTDOWN) != 0 ? "Shutting down" :
3104     "Running");
3105 jsr166 1.1 return super.toString() +
3106 dl 1.52 "[" + level +
3107 dl 1.14 ", parallelism = " + pc +
3108     ", size = " + tc +
3109     ", active = " + ac +
3110     ", running = " + rc +
3111 jsr166 1.1 ", steals = " + st +
3112     ", tasks = " + qt +
3113     ", submissions = " + qs +
3114     "]";
3115     }
3116    
3117     /**
3118 dl 1.100 * Possibly initiates an orderly shutdown in which previously
3119     * submitted tasks are executed, but no new tasks will be
3120     * accepted. Invocation has no effect on execution state if this
3121 jsr166 1.137 * is the {@link #commonPool()}, and no additional effect if
3122 dl 1.100 * already shut down. Tasks that are in the process of being
3123     * submitted concurrently during the course of this method may or
3124     * may not be rejected.
3125 jsr166 1.1 *
3126     * @throws SecurityException if a security manager exists and
3127     * the caller is not permitted to modify threads
3128     * because it does not hold {@link
3129     * java.lang.RuntimePermission}{@code ("modifyThread")}
3130     */
3131     public void shutdown() {
3132     checkPermission();
3133 dl 1.105 tryTerminate(false, true);
3134 jsr166 1.1 }
3135    
3136     /**
3137 dl 1.100 * Possibly attempts to cancel and/or stop all tasks, and reject
3138     * all subsequently submitted tasks. Invocation has no effect on
3139 jsr166 1.137 * execution state if this is the {@link #commonPool()}, and no
3140 dl 1.100 * additional effect if already shut down. Otherwise, tasks that
3141     * are in the process of being submitted or executed concurrently
3142     * during the course of this method may or may not be
3143     * rejected. This method cancels both existing and unexecuted
3144     * tasks, in order to permit termination in the presence of task
3145     * dependencies. So the method always returns an empty list
3146     * (unlike the case for some other Executors).
3147 jsr166 1.1 *
3148     * @return an empty list
3149     * @throws SecurityException if a security manager exists and
3150     * the caller is not permitted to modify threads
3151     * because it does not hold {@link
3152     * java.lang.RuntimePermission}{@code ("modifyThread")}
3153     */
3154     public List<Runnable> shutdownNow() {
3155     checkPermission();
3156 dl 1.105 tryTerminate(true, true);
3157 jsr166 1.1 return Collections.emptyList();
3158     }
3159    
3160     /**
3161     * Returns {@code true} if all tasks have completed following shut down.
3162     *
3163     * @return {@code true} if all tasks have completed following shut down
3164     */
3165     public boolean isTerminated() {
3166 dl 1.200 return (runState & TERMINATED) != 0;
3167 jsr166 1.1 }
3168    
3169     /**
3170     * Returns {@code true} if the process of termination has
3171 jsr166 1.9 * commenced but not yet completed. This method may be useful for
3172     * debugging. A return of {@code true} reported a sufficient
3173     * period after shutdown may indicate that submitted tasks have
3174 jsr166 1.119 * ignored or suppressed interruption, or are waiting for I/O,
3175 dl 1.49 * causing this executor not to properly terminate. (See the
3176     * advisory notes for class {@link ForkJoinTask} stating that
3177     * tasks should not normally entail blocking operations. But if
3178     * they do, they must abort them on interrupt.)
3179 jsr166 1.1 *
3180 jsr166 1.9 * @return {@code true} if terminating but not yet terminated
3181 jsr166 1.1 */
3182     public boolean isTerminating() {
3183 dl 1.200 int rs = runState;
3184     return (rs & STOP) != 0 && (rs & TERMINATED) == 0;
3185 jsr166 1.1 }
3186    
3187     /**
3188     * Returns {@code true} if this pool has been shut down.
3189     *
3190     * @return {@code true} if this pool has been shut down
3191     */
3192     public boolean isShutdown() {
3193 dl 1.200 return (runState & SHUTDOWN) != 0;
3194 jsr166 1.9 }
3195    
3196     /**
3197 dl 1.105 * Blocks until all tasks have completed execution after a
3198     * shutdown request, or the timeout occurs, or the current thread
3199 dl 1.134 * is interrupted, whichever happens first. Because the {@link
3200     * #commonPool()} never terminates until program shutdown, when
3201     * applied to the common pool, this method is equivalent to {@link
3202 jsr166 1.158 * #awaitQuiescence(long, TimeUnit)} but always returns {@code false}.
3203 jsr166 1.1 *
3204     * @param timeout the maximum time to wait
3205     * @param unit the time unit of the timeout argument
3206     * @return {@code true} if this executor terminated and
3207     * {@code false} if the timeout elapsed before termination
3208     * @throws InterruptedException if interrupted while waiting
3209     */
3210     public boolean awaitTermination(long timeout, TimeUnit unit)
3211     throws InterruptedException {
3212 dl 1.134 if (Thread.interrupted())
3213     throw new InterruptedException();
3214     if (this == common) {
3215     awaitQuiescence(timeout, unit);
3216     return false;
3217     }
3218 dl 1.52 long nanos = unit.toNanos(timeout);
3219 dl 1.101 if (isTerminated())
3220     return true;
3221 dl 1.183 if (nanos <= 0L)
3222     return false;
3223     long deadline = System.nanoTime() + nanos;
3224 jsr166 1.103 synchronized (this) {
3225 jsr166 1.184 for (;;) {
3226 dl 1.183 if (isTerminated())
3227     return true;
3228     if (nanos <= 0L)
3229     return false;
3230     long millis = TimeUnit.NANOSECONDS.toMillis(nanos);
3231     wait(millis > 0L ? millis : 1L);
3232     nanos = deadline - System.nanoTime();
3233 dl 1.52 }
3234 dl 1.18 }
3235 jsr166 1.1 }
3236    
3237     /**
3238 dl 1.134 * If called by a ForkJoinTask operating in this pool, equivalent
3239     * in effect to {@link ForkJoinTask#helpQuiesce}. Otherwise,
3240     * waits and/or attempts to assist performing tasks until this
3241     * pool {@link #isQuiescent} or the indicated timeout elapses.
3242     *
3243     * @param timeout the maximum time to wait
3244     * @param unit the time unit of the timeout argument
3245     * @return {@code true} if quiescent; {@code false} if the
3246     * timeout elapsed.
3247     */
3248     public boolean awaitQuiescence(long timeout, TimeUnit unit) {
3249     long nanos = unit.toNanos(timeout);
3250     ForkJoinWorkerThread wt;
3251     Thread thread = Thread.currentThread();
3252     if ((thread instanceof ForkJoinWorkerThread) &&
3253     (wt = (ForkJoinWorkerThread)thread).pool == this) {
3254     helpQuiescePool(wt.workQueue);
3255     return true;
3256     }
3257     long startTime = System.nanoTime();
3258     WorkQueue[] ws;
3259 dl 1.243 int r = 0, wl;
3260 dl 1.134 boolean found = true;
3261     while (!isQuiescent() && (ws = workQueues) != null &&
3262 dl 1.243 (wl = ws.length) > 0) {
3263 dl 1.134 if (!found) {
3264     if ((System.nanoTime() - startTime) > nanos)
3265     return false;
3266     Thread.yield(); // cannot block
3267     }
3268     found = false;
3269 dl 1.243 for (int m = wl - 1, j = (m + 1) << 2; j >= 0; --j) {
3270 dl 1.200 ForkJoinTask<?> t; WorkQueue q; int b, k;
3271     if ((k = r++ & m) <= m && k >= 0 && (q = ws[k]) != null &&
3272     (b = q.base) - q.top < 0) {
3273 dl 1.134 found = true;
3274 dl 1.172 if ((t = q.pollAt(b)) != null)
3275 dl 1.134 t.doExec();
3276     break;
3277     }
3278     }
3279     }
3280     return true;
3281     }
3282    
3283     /**
3284     * Waits and/or attempts to assist performing tasks indefinitely
3285 jsr166 1.141 * until the {@link #commonPool()} {@link #isQuiescent}.
3286 dl 1.134 */
3287 dl 1.136 static void quiesceCommonPool() {
3288 dl 1.134 common.awaitQuiescence(Long.MAX_VALUE, TimeUnit.NANOSECONDS);
3289     }
3290    
3291     /**
3292 jsr166 1.1 * Interface for extending managed parallelism for tasks running
3293 jsr166 1.8 * in {@link ForkJoinPool}s.
3294     *
3295 dl 1.19 * <p>A {@code ManagedBlocker} provides two methods. Method
3296 jsr166 1.218 * {@link #isReleasable} must return {@code true} if blocking is
3297     * not necessary. Method {@link #block} blocks the current thread
3298 dl 1.19 * if necessary (perhaps internally invoking {@code isReleasable}
3299 dl 1.54 * before actually blocking). These actions are performed by any
3300 jsr166 1.157 * thread invoking {@link ForkJoinPool#managedBlock(ManagedBlocker)}.
3301     * The unusual methods in this API accommodate synchronizers that
3302     * may, but don't usually, block for long periods. Similarly, they
3303 dl 1.54 * allow more efficient internal handling of cases in which
3304     * additional workers may be, but usually are not, needed to
3305     * ensure sufficient parallelism. Toward this end,
3306     * implementations of method {@code isReleasable} must be amenable
3307     * to repeated invocation.
3308 jsr166 1.1 *
3309     * <p>For example, here is a ManagedBlocker based on a
3310     * ReentrantLock:
3311 jsr166 1.239 * <pre> {@code
3312 jsr166 1.1 * class ManagedLocker implements ManagedBlocker {
3313     * final ReentrantLock lock;
3314     * boolean hasLock = false;
3315     * ManagedLocker(ReentrantLock lock) { this.lock = lock; }
3316     * public boolean block() {
3317     * if (!hasLock)
3318     * lock.lock();
3319     * return true;
3320     * }
3321     * public boolean isReleasable() {
3322     * return hasLock || (hasLock = lock.tryLock());
3323     * }
3324     * }}</pre>
3325 dl 1.19 *
3326     * <p>Here is a class that possibly blocks waiting for an
3327     * item on a given queue:
3328 jsr166 1.239 * <pre> {@code
3329 dl 1.19 * class QueueTaker<E> implements ManagedBlocker {
3330     * final BlockingQueue<E> queue;
3331     * volatile E item = null;
3332     * QueueTaker(BlockingQueue<E> q) { this.queue = q; }
3333     * public boolean block() throws InterruptedException {
3334     * if (item == null)
3335 dl 1.23 * item = queue.take();
3336 dl 1.19 * return true;
3337     * }
3338     * public boolean isReleasable() {
3339 dl 1.23 * return item != null || (item = queue.poll()) != null;
3340 dl 1.19 * }
3341     * public E getItem() { // call after pool.managedBlock completes
3342     * return item;
3343     * }
3344     * }}</pre>
3345 jsr166 1.1 */
3346     public static interface ManagedBlocker {
3347     /**
3348     * Possibly blocks the current thread, for example waiting for
3349     * a lock or condition.
3350     *
3351 jsr166 1.4 * @return {@code true} if no additional blocking is necessary
3352     * (i.e., if isReleasable would return true)
3353 jsr166 1.1 * @throws InterruptedException if interrupted while waiting
3354     * (the method is not required to do so, but is allowed to)
3355     */
3356     boolean block() throws InterruptedException;
3357    
3358     /**
3359 jsr166 1.4 * Returns {@code true} if blocking is unnecessary.
3360 jsr166 1.154 * @return {@code true} if blocking is unnecessary
3361 jsr166 1.1 */
3362     boolean isReleasable();
3363     }
3364    
3365     /**
3366 jsr166 1.217 * Runs the given possibly blocking task. When {@linkplain
3367     * ForkJoinTask#inForkJoinPool() running in a ForkJoinPool}, this
3368     * method possibly arranges for a spare thread to be activated if
3369     * necessary to ensure sufficient parallelism while the current
3370     * thread is blocked in {@link ManagedBlocker#block blocker.block()}.
3371 jsr166 1.1 *
3372 jsr166 1.217 * <p>This method repeatedly calls {@code blocker.isReleasable()} and
3373     * {@code blocker.block()} until either method returns {@code true}.
3374     * Every call to {@code blocker.block()} is preceded by a call to
3375     * {@code blocker.isReleasable()} that returned {@code false}.
3376     *
3377     * <p>If not running in a ForkJoinPool, this method is
3378 jsr166 1.8 * behaviorally equivalent to
3379 jsr166 1.239 * <pre> {@code
3380 jsr166 1.1 * while (!blocker.isReleasable())
3381     * if (blocker.block())
3382 jsr166 1.217 * break;}</pre>
3383 jsr166 1.8 *
3384 jsr166 1.217 * If running in a ForkJoinPool, the pool may first be expanded to
3385     * ensure sufficient parallelism available during the call to
3386     * {@code blocker.block()}.
3387 jsr166 1.1 *
3388 jsr166 1.217 * @param blocker the blocker task
3389     * @throws InterruptedException if {@code blocker.block()} did so
3390 jsr166 1.1 */
3391 dl 1.18 public static void managedBlock(ManagedBlocker blocker)
3392 jsr166 1.1 throws InterruptedException {
3393 dl 1.200 ForkJoinPool p;
3394     ForkJoinWorkerThread wt;
3395 jsr166 1.1 Thread t = Thread.currentThread();
3396 dl 1.200 if ((t instanceof ForkJoinWorkerThread) &&
3397     (p = (wt = (ForkJoinWorkerThread)t).pool) != null) {
3398     WorkQueue w = wt.workQueue;
3399 dl 1.172 while (!blocker.isReleasable()) {
3400 dl 1.200 if (p.tryCompensate(w)) {
3401 dl 1.105 try {
3402     do {} while (!blocker.isReleasable() &&
3403     !blocker.block());
3404     } finally {
3405 dl 1.200 U.getAndAddLong(p, CTL, AC_UNIT);
3406 dl 1.105 }
3407     break;
3408 dl 1.78 }
3409     }
3410 dl 1.18 }
3411 dl 1.105 else {
3412     do {} while (!blocker.isReleasable() &&
3413     !blocker.block());
3414     }
3415 jsr166 1.1 }
3416    
3417 jsr166 1.7 // AbstractExecutorService overrides. These rely on undocumented
3418     // fact that ForkJoinTask.adapt returns ForkJoinTasks that also
3419     // implement RunnableFuture.
3420 jsr166 1.1
3421     protected <T> RunnableFuture<T> newTaskFor(Runnable runnable, T value) {
3422 dl 1.90 return new ForkJoinTask.AdaptedRunnable<T>(runnable, value);
3423 jsr166 1.1 }
3424    
3425     protected <T> RunnableFuture<T> newTaskFor(Callable<T> callable) {
3426 dl 1.90 return new ForkJoinTask.AdaptedCallable<T>(callable);
3427 jsr166 1.1 }
3428    
3429     // Unsafe mechanics
3430 jsr166 1.233 private static final sun.misc.Unsafe U = sun.misc.Unsafe.getUnsafe();
3431 dl 1.78 private static final long CTL;
3432 dl 1.294 private static final long RUNSTATE;
3433 jsr166 1.291 private static final int ABASE;
3434     private static final int ASHIFT;
3435 dl 1.52
3436     static {
3437 jsr166 1.3 try {
3438 dl 1.78 CTL = U.objectFieldOffset
3439 jsr166 1.233 (ForkJoinPool.class.getDeclaredField("ctl"));
3440 dl 1.294 RUNSTATE = U.objectFieldOffset
3441     (ForkJoinPool.class.getDeclaredField("runState"));
3442 jsr166 1.233 ABASE = U.arrayBaseOffset(ForkJoinTask[].class);
3443     int scale = U.arrayIndexScale(ForkJoinTask[].class);
3444 jsr166 1.142 if ((scale & (scale - 1)) != 0)
3445 jsr166 1.232 throw new Error("array index scale not a power of two");
3446 jsr166 1.142 ASHIFT = 31 - Integer.numberOfLeadingZeros(scale);
3447 jsr166 1.231 } catch (ReflectiveOperationException e) {
3448 dl 1.52 throw new Error(e);
3449     }
3450 dl 1.105
3451 dl 1.243 // Reduce the risk of rare disastrous classloading in first call to
3452     // LockSupport.park: https://bugs.openjdk.java.net/browse/JDK-8074773
3453     Class<?> ensureLoaded = LockSupport.class;
3454    
3455 jsr166 1.273 int commonMaxSpares = DEFAULT_COMMON_MAX_SPARES;
3456     try {
3457     String p = System.getProperty
3458     ("java.util.concurrent.ForkJoinPool.common.maximumSpares");
3459     if (p != null)
3460     commonMaxSpares = Integer.parseInt(p);
3461     } catch (Exception ignore) {}
3462     COMMON_MAX_SPARES = commonMaxSpares;
3463    
3464 dl 1.152 defaultForkJoinWorkerThreadFactory =
3465 dl 1.112 new DefaultForkJoinWorkerThreadFactory();
3466 dl 1.115 modifyThreadPermission = new RuntimePermission("modifyThread");
3467    
3468 dl 1.152 common = java.security.AccessController.doPrivileged
3469     (new java.security.PrivilegedAction<ForkJoinPool>() {
3470     public ForkJoinPool run() { return makeCommonPool(); }});
3471 jsr166 1.275
3472 jsr166 1.274 // report 1 even if threads disabled
3473     COMMON_PARALLELISM = Math.max(common.config & SMASK, 1);
3474 dl 1.152 }
3475 dl 1.112
3476 dl 1.152 /**
3477     * Creates and returns the common pool, respecting user settings
3478     * specified via system properties.
3479     */
3480 jsr166 1.278 static ForkJoinPool makeCommonPool() {
3481 dl 1.160 int parallelism = -1;
3482 dl 1.197 ForkJoinWorkerThreadFactory factory = null;
3483 jsr166 1.156 UncaughtExceptionHandler handler = null;
3484 jsr166 1.189 try { // ignore exceptions in accessing/parsing properties
3485 dl 1.112 String pp = System.getProperty
3486     ("java.util.concurrent.ForkJoinPool.common.parallelism");
3487 dl 1.152 String fp = System.getProperty
3488     ("java.util.concurrent.ForkJoinPool.common.threadFactory");
3489 dl 1.112 String hp = System.getProperty
3490     ("java.util.concurrent.ForkJoinPool.common.exceptionHandler");
3491 dl 1.152 if (pp != null)
3492     parallelism = Integer.parseInt(pp);
3493 dl 1.112 if (fp != null)
3494 dl 1.152 factory = ((ForkJoinWorkerThreadFactory)ClassLoader.
3495     getSystemClassLoader().loadClass(fp).newInstance());
3496 dl 1.112 if (hp != null)
3497 jsr166 1.156 handler = ((UncaughtExceptionHandler)ClassLoader.
3498 dl 1.112 getSystemClassLoader().loadClass(hp).newInstance());
3499     } catch (Exception ignore) {
3500     }
3501 dl 1.197 if (factory == null) {
3502     if (System.getSecurityManager() == null)
3503     factory = defaultForkJoinWorkerThreadFactory;
3504     else // use security-managed default
3505     factory = new InnocuousForkJoinWorkerThreadFactory();
3506     }
3507 dl 1.167 if (parallelism < 0 && // default 1 less than #cores
3508 dl 1.193 (parallelism = Runtime.getRuntime().availableProcessors() - 1) <= 0)
3509     parallelism = 1;
3510 dl 1.152 if (parallelism > MAX_CAP)
3511     parallelism = MAX_CAP;
3512 dl 1.185 return new ForkJoinPool(parallelism, factory, handler, LIFO_QUEUE,
3513 dl 1.152 "ForkJoinPool.commonPool-worker-");
3514 jsr166 1.3 }
3515 dl 1.52
3516 dl 1.197 /**
3517 jsr166 1.279 * Factory for innocuous worker threads.
3518 dl 1.197 */
3519 jsr166 1.278 private static final class InnocuousForkJoinWorkerThreadFactory
3520 dl 1.197 implements ForkJoinWorkerThreadFactory {
3521    
3522     /**
3523     * An ACC to restrict permissions for the factory itself.
3524     * The constructed workers have no permissions set.
3525     */
3526     private static final AccessControlContext innocuousAcc;
3527     static {
3528     Permissions innocuousPerms = new Permissions();
3529     innocuousPerms.add(modifyThreadPermission);
3530     innocuousPerms.add(new RuntimePermission(
3531     "enableContextClassLoaderOverride"));
3532     innocuousPerms.add(new RuntimePermission(
3533     "modifyThreadGroup"));
3534     innocuousAcc = new AccessControlContext(new ProtectionDomain[] {
3535     new ProtectionDomain(null, innocuousPerms)
3536     });
3537     }
3538    
3539     public final ForkJoinWorkerThread newThread(ForkJoinPool pool) {
3540 jsr166 1.227 return java.security.AccessController.doPrivileged(
3541     new java.security.PrivilegedAction<ForkJoinWorkerThread>() {
3542 dl 1.197 public ForkJoinWorkerThread run() {
3543     return new ForkJoinWorkerThread.
3544     InnocuousForkJoinWorkerThread(pool);
3545     }}, innocuousAcc);
3546     }
3547     }
3548    
3549 jsr166 1.1 }