ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/jsr166y/ForkJoinPool.java
(Generate patch)

Comparing jsr166/src/jsr166y/ForkJoinPool.java (file contents):
Revision 1.75 by jsr166, Tue Sep 7 06:42:39 2010 UTC vs.
Revision 1.154 by dl, Sat Dec 8 14:08:51 2012 UTC

# Line 1 | Line 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 < * http://creativecommons.org/licenses/publicdomain
4 > * http://creativecommons.org/publicdomain/zero/1.0/
5   */
6  
7   package jsr166y;
8  
9 import java.util.concurrent.*;
9   import java.util.ArrayList;
10   import java.util.Arrays;
11   import java.util.Collection;
12   import java.util.Collections;
13   import java.util.List;
14 < import java.util.concurrent.locks.LockSupport;
15 < import java.util.concurrent.locks.ReentrantLock;
16 < import java.util.concurrent.atomic.AtomicInteger;
17 < import java.util.concurrent.CountDownLatch;
14 > import java.util.concurrent.AbstractExecutorService;
15 > import java.util.concurrent.Callable;
16 > import java.util.concurrent.ExecutorService;
17 > import java.util.concurrent.Future;
18 > import java.util.concurrent.RejectedExecutionException;
19 > import java.util.concurrent.RunnableFuture;
20 > import java.util.concurrent.TimeUnit;
21  
22   /**
23   * An {@link ExecutorService} for running {@link ForkJoinTask}s.
# Line 26 | Line 28 | import java.util.concurrent.CountDownLat
28   * <p>A {@code ForkJoinPool} differs from other kinds of {@link
29   * ExecutorService} mainly by virtue of employing
30   * <em>work-stealing</em>: all threads in the pool attempt to find and
31 < * execute subtasks created by other active tasks (eventually blocking
32 < * waiting for work if none exist). This enables efficient processing
33 < * when most tasks spawn other subtasks (as do most {@code
34 < * ForkJoinTask}s). When setting <em>asyncMode</em> to true in
35 < * constructors, {@code ForkJoinPool}s may also be appropriate for use
36 < * with event-style tasks that are never joined.
31 > * execute tasks submitted to the pool and/or created by other active
32 > * tasks (eventually blocking waiting for work if none exist). This
33 > * enables efficient processing when most tasks spawn other subtasks
34 > * (as do most {@code ForkJoinTask}s), as well as when many small
35 > * tasks are submitted to the pool from external clients.  Especially
36 > * when setting <em>asyncMode</em> to true in constructors, {@code
37 > * ForkJoinPool}s may also be appropriate for use with event-style
38 > * tasks that are never joined.
39   *
40 < * <p>A {@code ForkJoinPool} is constructed with a given target
41 < * parallelism level; by default, equal to the number of available
42 < * processors. The pool attempts to maintain enough active (or
43 < * available) threads by dynamically adding, suspending, or resuming
44 < * internal worker threads, even if some tasks are stalled waiting to
45 < * join others. However, no such adjustments are guaranteed in the
46 < * face of blocked IO or other unmanaged synchronization. The nested
47 < * {@link ManagedBlocker} interface enables extension of the kinds of
40 > * <p>A static {@link #commonPool()} is available and appropriate for
41 > * most applications. The common pool is used by any ForkJoinTask that
42 > * is not explicitly submitted to a specified pool. Using the common
43 > * pool normally reduces resource usage (its threads are slowly
44 > * reclaimed during periods of non-use, and reinstated upon subsequent
45 > * use).
46 > *
47 > * <p>For applications that require separate or custom pools, a {@code
48 > * ForkJoinPool} may be constructed with a given target parallelism
49 > * level; by default, equal to the number of available processors. The
50 > * pool attempts to maintain enough active (or available) threads by
51 > * dynamically adding, suspending, or resuming internal worker
52 > * threads, even if some tasks are stalled waiting to join
53 > * others. However, no such adjustments are guaranteed in the face of
54 > * blocked I/O or other unmanaged synchronization. The nested {@link
55 > * ManagedBlocker} interface enables extension of the kinds of
56   * synchronization accommodated.
57   *
58   * <p>In addition to execution and lifecycle control methods, this
# Line 50 | Line 62 | import java.util.concurrent.CountDownLat
62   * {@link #toString} returns indications of pool state in a
63   * convenient form for informal monitoring.
64   *
65 < * <p> As is the case with other ExecutorServices, there are three
66 < * main task execution methods summarized in the following
67 < * table. These are designed to be used by clients not already engaged
68 < * in fork/join computations in the current pool.  The main forms of
69 < * these methods accept instances of {@code ForkJoinTask}, but
70 < * overloaded forms also allow mixed execution of plain {@code
65 > * <p>As is the case with other ExecutorServices, there are three
66 > * main task execution methods summarized in the following table.
67 > * These are designed to be used primarily by clients not already
68 > * engaged in fork/join computations in the current pool.  The main
69 > * forms of these methods accept instances of {@code ForkJoinTask},
70 > * but overloaded forms also allow mixed execution of plain {@code
71   * Runnable}- or {@code Callable}- based activities as well.  However,
72 < * tasks that are already executing in a pool should normally
73 < * <em>NOT</em> use these pool execution methods, but instead use the
74 < * within-computation forms listed in the table.
72 > * tasks that are already executing in a pool should normally instead
73 > * use the within-computation forms listed in the table unless using
74 > * async event-style tasks that are not usually joined, in which case
75 > * there is little difference among choice of methods.
76   *
77   * <table BORDER CELLPADDING=3 CELLSPACING=1>
78   *  <tr>
# Line 84 | Line 97 | import java.util.concurrent.CountDownLat
97   *  </tr>
98   * </table>
99   *
100 < * <p><b>Sample Usage.</b> Normally a single {@code ForkJoinPool} is
101 < * used for all parallel task execution in a program or subsystem.
102 < * Otherwise, use would not usually outweigh the construction and
103 < * bookkeeping overhead of creating a large set of threads. For
104 < * example, a common pool could be used for the {@code SortTasks}
105 < * illustrated in {@link RecursiveAction}. Because {@code
106 < * ForkJoinPool} uses threads in {@linkplain java.lang.Thread#isDaemon
107 < * daemon} mode, there is typically no need to explicitly {@link
108 < * #shutdown} such a pool upon program exit.
109 < *
97 < * <pre>
98 < * static final ForkJoinPool mainPool = new ForkJoinPool();
99 < * ...
100 < * public void sort(long[] array) {
101 < *   mainPool.invoke(new SortTask(array, 0, array.length));
102 < * }
103 < * </pre>
100 > * <p>The common pool is by default constructed with default
101 > * parameters, but these may be controlled by setting three {@link
102 > * System#getProperty system properties} with prefix {@code
103 > * java.util.concurrent.ForkJoinPool.common}: {@code parallelism} --
104 > * an integer greater than zero, {@code threadFactory} -- the class
105 > * name of a {@link ForkJoinWorkerThreadFactory}, and {@code
106 > * exceptionHandler} -- the class name of a {@link
107 > * java.lang.Thread.UncaughtExceptionHandler
108 > * Thread.UncaughtExceptionHandler}. Upon any error in establishing
109 > * these settings, default parameters are used.
110   *
111   * <p><b>Implementation notes</b>: This implementation restricts the
112   * maximum number of running threads to 32767. Attempts to create
# Line 119 | Line 125 | public class ForkJoinPool extends Abstra
125      /*
126       * Implementation Overview
127       *
128 <     * This class provides the central bookkeeping and control for a
129 <     * set of worker threads: Submissions from non-FJ threads enter
130 <     * into a submission queue. Workers take these tasks and typically
131 <     * split them into subtasks that may be stolen by other workers.
132 <     * The main work-stealing mechanics implemented in class
133 <     * ForkJoinWorkerThread give first priority to processing tasks
134 <     * from their own queues (LIFO or FIFO, depending on mode), then
135 <     * to randomized FIFO steals of tasks in other worker queues, and
136 <     * lastly to new submissions. These mechanics do not consider
137 <     * affinities, loads, cache localities, etc, so rarely provide the
138 <     * best possible performance on a given machine, but portably
139 <     * provide good throughput by averaging over these factors.
140 <     * (Further, even if we did try to use such information, we do not
141 <     * usually have a basis for exploiting it. For example, some sets
142 <     * of tasks profit from cache affinities, but others are harmed by
143 <     * cache pollution effects.)
144 <     *
145 <     * Beyond work-stealing support and essential bookkeeping, the
146 <     * main responsibility of this framework is to take actions when
147 <     * one worker is waiting to join a task stolen (or always held by)
148 <     * another.  Because we are multiplexing many tasks on to a pool
149 <     * of workers, we can't just let them block (as in Thread.join).
150 <     * We also cannot just reassign the joiner's run-time stack with
151 <     * another and replace it later, which would be a form of
152 <     * "continuation", that even if possible is not necessarily a good
153 <     * idea. Given that the creation costs of most threads on most
154 <     * systems mainly surrounds setting up runtime stacks, thread
155 <     * creation and switching is usually not much more expensive than
156 <     * stack creation and switching, and is more flexible). Instead we
157 <     * combine two tactics:
128 >     * This class and its nested classes provide the main
129 >     * functionality and control for a set of worker threads:
130 >     * Submissions from non-FJ threads enter into submission queues.
131 >     * Workers take these tasks and typically split them into subtasks
132 >     * that may be stolen by other workers.  Preference rules give
133 >     * first priority to processing tasks from their own queues (LIFO
134 >     * or FIFO, depending on mode), then to randomized FIFO steals of
135 >     * tasks in other queues.
136 >     *
137 >     * WorkQueues
138 >     * ==========
139 >     *
140 >     * Most operations occur within work-stealing queues (in nested
141 >     * class WorkQueue).  These are special forms of Deques that
142 >     * support only three of the four possible end-operations -- push,
143 >     * pop, and poll (aka steal), under the further constraints that
144 >     * push and pop are called only from the owning thread (or, as
145 >     * extended here, under a lock), while poll may be called from
146 >     * other threads.  (If you are unfamiliar with them, you probably
147 >     * want to read Herlihy and Shavit's book "The Art of
148 >     * Multiprocessor programming", chapter 16 describing these in
149 >     * more detail before proceeding.)  The main work-stealing queue
150 >     * design is roughly similar to those in the papers "Dynamic
151 >     * Circular Work-Stealing Deque" by Chase and Lev, SPAA 2005
152 >     * (http://research.sun.com/scalable/pubs/index.html) and
153 >     * "Idempotent work stealing" by Michael, Saraswat, and Vechev,
154 >     * PPoPP 2009 (http://portal.acm.org/citation.cfm?id=1504186).
155 >     * The main differences ultimately stem from GC requirements that
156 >     * we null out taken slots as soon as we can, to maintain as small
157 >     * a footprint as possible even in programs generating huge
158 >     * numbers of tasks. To accomplish this, we shift the CAS
159 >     * arbitrating pop vs poll (steal) from being on the indices
160 >     * ("base" and "top") to the slots themselves.  So, both a
161 >     * successful pop and poll mainly entail a CAS of a slot from
162 >     * non-null to null.  Because we rely on CASes of references, we
163 >     * do not need tag bits on base or top.  They are simple ints as
164 >     * used in any circular array-based queue (see for example
165 >     * ArrayDeque).  Updates to the indices must still be ordered in a
166 >     * way that guarantees that top == base means the queue is empty,
167 >     * but otherwise may err on the side of possibly making the queue
168 >     * appear nonempty when a push, pop, or poll have not fully
169 >     * committed. Note that this means that the poll operation,
170 >     * considered individually, is not wait-free. One thief cannot
171 >     * successfully continue until another in-progress one (or, if
172 >     * previously empty, a push) completes.  However, in the
173 >     * aggregate, we ensure at least probabilistic non-blockingness.
174 >     * If an attempted steal fails, a thief always chooses a different
175 >     * random victim target to try next. So, in order for one thief to
176 >     * progress, it suffices for any in-progress poll or new push on
177 >     * any empty queue to complete. (This is why we normally use
178 >     * method pollAt and its variants that try once at the apparent
179 >     * base index, else consider alternative actions, rather than
180 >     * method poll.)
181 >     *
182 >     * This approach also enables support of a user mode in which local
183 >     * task processing is in FIFO, not LIFO order, simply by using
184 >     * poll rather than pop.  This can be useful in message-passing
185 >     * frameworks in which tasks are never joined.  However neither
186 >     * mode considers affinities, loads, cache localities, etc, so
187 >     * rarely provide the best possible performance on a given
188 >     * machine, but portably provide good throughput by averaging over
189 >     * these factors.  (Further, even if we did try to use such
190 >     * information, we do not usually have a basis for exploiting it.
191 >     * For example, some sets of tasks profit from cache affinities,
192 >     * but others are harmed by cache pollution effects.)
193 >     *
194 >     * WorkQueues are also used in a similar way for tasks submitted
195 >     * to the pool. We cannot mix these tasks in the same queues used
196 >     * for work-stealing (this would contaminate lifo/fifo
197 >     * processing). Instead, we randomly associate submission queues
198 >     * with submitting threads, using a form of hashing.  The
199 >     * ThreadLocal Submitter class contains a value initially used as
200 >     * a hash code for choosing existing queues, but may be randomly
201 >     * repositioned upon contention with other submitters.  In
202 >     * essence, submitters act like workers except that they are
203 >     * restricted to executing local tasks that they submitted (or in
204 >     * the case of CountedCompleters, others with the same root task).
205 >     * However, because most shared/external queue operations are more
206 >     * expensive than internal, and because, at steady state, external
207 >     * submitters will compete for CPU with workers, ForkJoinTask.join
208 >     * and related methods disable them from repeatedly helping to
209 >     * process tasks if all workers are active.  Insertion of tasks in
210 >     * shared mode requires a lock (mainly to protect in the case of
211 >     * resizing) but we use only a simple spinlock (using bits in
212 >     * field qlock), because submitters encountering a busy queue move
213 >     * on to try or create other queues -- they block only when
214 >     * creating and registering new queues.
215 >     *
216 >     * Management
217 >     * ==========
218 >     *
219 >     * The main throughput advantages of work-stealing stem from
220 >     * decentralized control -- workers mostly take tasks from
221 >     * themselves or each other. We cannot negate this in the
222 >     * implementation of other management responsibilities. The main
223 >     * tactic for avoiding bottlenecks is packing nearly all
224 >     * essentially atomic control state into two volatile variables
225 >     * that are by far most often read (not written) as status and
226 >     * consistency checks.
227 >     *
228 >     * Field "ctl" contains 64 bits holding all the information needed
229 >     * to atomically decide to add, inactivate, enqueue (on an event
230 >     * queue), dequeue, and/or re-activate workers.  To enable this
231 >     * packing, we restrict maximum parallelism to (1<<15)-1 (which is
232 >     * far in excess of normal operating range) to allow ids, counts,
233 >     * and their negations (used for thresholding) to fit into 16bit
234 >     * fields.
235 >     *
236 >     * Field "plock" is a form of sequence lock with a saturating
237 >     * shutdown bit (similarly for per-queue "qlocks"), mainly
238 >     * protecting updates to the workQueues array, as well as to
239 >     * enable shutdown.  When used as a lock, it is normally only very
240 >     * briefly held, so is nearly always available after at most a
241 >     * brief spin, but we use a monitor-based backup strategy to
242 >     * block when needed.
243 >     *
244 >     * Recording WorkQueues.  WorkQueues are recorded in the
245 >     * "workQueues" array that is created upon first use and expanded
246 >     * if necessary.  Updates to the array while recording new workers
247 >     * and unrecording terminated ones are protected from each other
248 >     * by a lock but the array is otherwise concurrently readable, and
249 >     * accessed directly.  To simplify index-based operations, the
250 >     * array size is always a power of two, and all readers must
251 >     * tolerate null slots. Worker queues are at odd indices. Shared
252 >     * (submission) queues are at even indices, up to a maximum of 64
253 >     * slots, to limit growth even if array needs to expand to add
254 >     * more workers. Grouping them together in this way simplifies and
255 >     * speeds up task scanning.
256 >     *
257 >     * All worker thread creation is on-demand, triggered by task
258 >     * submissions, replacement of terminated workers, and/or
259 >     * compensation for blocked workers. However, all other support
260 >     * code is set up to work with other policies.  To ensure that we
261 >     * do not hold on to worker references that would prevent GC, ALL
262 >     * accesses to workQueues are via indices into the workQueues
263 >     * array (which is one source of some of the messy code
264 >     * constructions here). In essence, the workQueues array serves as
265 >     * a weak reference mechanism. Thus for example the wait queue
266 >     * field of ctl stores indices, not references.  Access to the
267 >     * workQueues in associated methods (for example signalWork) must
268 >     * both index-check and null-check the IDs. All such accesses
269 >     * ignore bad IDs by returning out early from what they are doing,
270 >     * since this can only be associated with termination, in which
271 >     * case it is OK to give up.  All uses of the workQueues array
272 >     * also check that it is non-null (even if previously
273 >     * non-null). This allows nulling during termination, which is
274 >     * currently not necessary, but remains an option for
275 >     * resource-revocation-based shutdown schemes. It also helps
276 >     * reduce JIT issuance of uncommon-trap code, which tends to
277 >     * unnecessarily complicate control flow in some methods.
278 >     *
279 >     * Event Queuing. Unlike HPC work-stealing frameworks, we cannot
280 >     * let workers spin indefinitely scanning for tasks when none can
281 >     * be found immediately, and we cannot start/resume workers unless
282 >     * there appear to be tasks available.  On the other hand, we must
283 >     * quickly prod them into action when new tasks are submitted or
284 >     * generated. In many usages, ramp-up time to activate workers is
285 >     * the main limiting factor in overall performance (this is
286 >     * compounded at program start-up by JIT compilation and
287 >     * allocation). So we try to streamline this as much as possible.
288 >     * We park/unpark workers after placing in an event wait queue
289 >     * when they cannot find work. This "queue" is actually a simple
290 >     * Treiber stack, headed by the "id" field of ctl, plus a 15bit
291 >     * counter value (that reflects the number of times a worker has
292 >     * been inactivated) to avoid ABA effects (we need only as many
293 >     * version numbers as worker threads). Successors are held in
294 >     * field WorkQueue.nextWait.  Queuing deals with several intrinsic
295 >     * races, mainly that a task-producing thread can miss seeing (and
296 >     * signalling) another thread that gave up looking for work but
297 >     * has not yet entered the wait queue. We solve this by requiring
298 >     * a full sweep of all workers (via repeated calls to method
299 >     * scan()) both before and after a newly waiting worker is added
300 >     * to the wait queue. During a rescan, the worker might release
301 >     * some other queued worker rather than itself, which has the same
302 >     * net effect. Because enqueued workers may actually be rescanning
303 >     * rather than waiting, we set and clear the "parker" field of
304 >     * WorkQueues to reduce unnecessary calls to unpark.  (This
305 >     * requires a secondary recheck to avoid missed signals.)  Note
306 >     * the unusual conventions about Thread.interrupts surrounding
307 >     * parking and other blocking: Because interrupts are used solely
308 >     * to alert threads to check termination, which is checked anyway
309 >     * upon blocking, we clear status (using Thread.interrupted)
310 >     * before any call to park, so that park does not immediately
311 >     * return due to status being set via some other unrelated call to
312 >     * interrupt in user code.
313 >     *
314 >     * Signalling.  We create or wake up workers only when there
315 >     * appears to be at least one task they might be able to find and
316 >     * execute. However, many other threads may notice the same task
317 >     * and each signal to wake up a thread that might take it. So in
318 >     * general, pools will be over-signalled.  When a submission is
319 >     * added or another worker adds a task to a queue that has fewer
320 >     * than two tasks, they signal waiting workers (or trigger
321 >     * creation of new ones if fewer than the given parallelism level
322 >     * -- signalWork), and may leave a hint to the unparked worker to
323 >     * help signal others upon wakeup).  These primary signals are
324 >     * buttressed by others (see method helpSignal) whenever other
325 >     * threads scan for work or do not have a task to process.  On
326 >     * most platforms, signalling (unpark) overhead time is noticeably
327 >     * long, and the time between signalling a thread and it actually
328 >     * making progress can be very noticeably long, so it is worth
329 >     * offloading these delays from critical paths as much as
330 >     * possible.
331 >     *
332 >     * Trimming workers. To release resources after periods of lack of
333 >     * use, a worker starting to wait when the pool is quiescent will
334 >     * time out and terminate if the pool has remained quiescent for a
335 >     * given period -- a short period if there are more threads than
336 >     * parallelism, longer as the number of threads decreases. This
337 >     * will slowly propagate, eventually terminating all workers after
338 >     * periods of non-use.
339 >     *
340 >     * Shutdown and Termination. A call to shutdownNow atomically sets
341 >     * a plock bit and then (non-atomically) sets each worker's
342 >     * qlock status, cancels all unprocessed tasks, and wakes up
343 >     * all waiting workers.  Detecting whether termination should
344 >     * commence after a non-abrupt shutdown() call requires more work
345 >     * and bookkeeping. We need consensus about quiescence (i.e., that
346 >     * there is no more work). The active count provides a primary
347 >     * indication but non-abrupt shutdown still requires a rechecking
348 >     * scan for any workers that are inactive but not queued.
349 >     *
350 >     * Joining Tasks
351 >     * =============
352 >     *
353 >     * Any of several actions may be taken when one worker is waiting
354 >     * to join a task stolen (or always held) by another.  Because we
355 >     * are multiplexing many tasks on to a pool of workers, we can't
356 >     * just let them block (as in Thread.join).  We also cannot just
357 >     * reassign the joiner's run-time stack with another and replace
358 >     * it later, which would be a form of "continuation", that even if
359 >     * possible is not necessarily a good idea since we sometimes need
360 >     * both an unblocked task and its continuation to progress.
361 >     * Instead we combine two tactics:
362       *
363       *   Helping: Arranging for the joiner to execute some task that it
364 <     *      would be running if the steal had not occurred.  Method
155 <     *      ForkJoinWorkerThread.helpJoinTask tracks joining->stealing
156 <     *      links to try to find such a task.
364 >     *      would be running if the steal had not occurred.
365       *
366       *   Compensating: Unless there are already enough live threads,
367 <     *      method helpMaintainParallelism() may create or
368 <     *      re-activate a spare thread to compensate for blocked
161 <     *      joiners until they unblock.
367 >     *      method tryCompensate() may create or re-activate a spare
368 >     *      thread to compensate for blocked joiners until they unblock.
369       *
370 <     * It is impossible to keep exactly the target (parallelism)
371 <     * number of threads running at any given time.  Determining
372 <     * existence of conservatively safe helping targets, the
373 <     * availability of already-created spares, and the apparent need
374 <     * to create new spares are all racy and require heuristic
375 <     * guidance, so we rely on multiple retries of each.  Compensation
376 <     * occurs in slow-motion. It is triggered only upon timeouts of
170 <     * Object.wait used for joins. This reduces poor decisions that
171 <     * would otherwise be made when threads are waiting for others
172 <     * that are stalled because of unrelated activities such as
173 <     * garbage collection.
370 >     * A third form (implemented in tryRemoveAndExec) amounts to
371 >     * helping a hypothetical compensator: If we can readily tell that
372 >     * a possible action of a compensator is to steal and execute the
373 >     * task being joined, the joining thread can do so directly,
374 >     * without the need for a compensation thread (although at the
375 >     * expense of larger run-time stacks, but the tradeoff is
376 >     * typically worthwhile).
377       *
378       * The ManagedBlocker extension API can't use helping so relies
379       * only on compensation in method awaitBlocker.
380       *
381 <     * The main throughput advantages of work-stealing stem from
382 <     * decentralized control -- workers mostly steal tasks from each
383 <     * other. We do not want to negate this by creating bottlenecks
384 <     * implementing other management responsibilities. So we use a
385 <     * collection of techniques that avoid, reduce, or cope well with
386 <     * contention. These entail several instances of bit-packing into
387 <     * CASable fields to maintain only the minimally required
388 <     * atomicity. To enable such packing, we restrict maximum
389 <     * parallelism to (1<<15)-1 (enabling twice this (to accommodate
390 <     * unbalanced increments and decrements) to fit into a 16 bit
391 <     * field, which is far in excess of normal operating range.  Even
392 <     * though updates to some of these bookkeeping fields do sometimes
393 <     * contend with each other, they don't normally cache-contend with
394 <     * updates to others enough to warrant memory padding or
395 <     * isolation. So they are all held as fields of ForkJoinPool
396 <     * objects.  The main capabilities are as follows:
397 <     *
398 <     * 1. Creating and removing workers. Workers are recorded in the
399 <     * "workers" array. This is an array as opposed to some other data
400 <     * structure to support index-based random steals by workers.
401 <     * Updates to the array recording new workers and unrecording
402 <     * terminated ones are protected from each other by a lock
403 <     * (workerLock) but the array is otherwise concurrently readable,
404 <     * and accessed directly by workers. To simplify index-based
405 <     * operations, the array size is always a power of two, and all
406 <     * readers must tolerate null slots. Currently, all worker thread
407 <     * creation is on-demand, triggered by task submissions,
408 <     * replacement of terminated workers, and/or compensation for
409 <     * blocked workers. However, all other support code is set up to
410 <     * work with other policies.
411 <     *
412 <     * To ensure that we do not hold on to worker references that
413 <     * would prevent GC, ALL accesses to workers are via indices into
414 <     * the workers array (which is one source of some of the unusual
415 <     * code constructions here). In essence, the workers array serves
416 <     * as a WeakReference mechanism. Thus for example the event queue
417 <     * stores worker indices, not worker references. Access to the
418 <     * workers in associated methods (for example releaseEventWaiters)
419 <     * must both index-check and null-check the IDs. All such accesses
420 <     * ignore bad IDs by returning out early from what they are doing,
421 <     * since this can only be associated with shutdown, in which case
422 <     * it is OK to give up. On termination, we just clobber these
423 <     * data structures without trying to use them.
424 <     *
425 <     * 2. Bookkeeping for dynamically adding and removing workers. We
426 <     * aim to approximately maintain the given level of parallelism.
427 <     * When some workers are known to be blocked (on joins or via
428 <     * ManagedBlocker), we may create or resume others to take their
429 <     * place until they unblock (see below). Implementing this
430 <     * requires counts of the number of "running" threads (i.e., those
431 <     * that are neither blocked nor artificially suspended) as well as
432 <     * the total number.  These two values are packed into one field,
433 <     * "workerCounts" because we need accurate snapshots when deciding
434 <     * to create, resume or suspend.  Note however that the
435 <     * correspondence of these counts to reality is not guaranteed. In
436 <     * particular updates for unblocked threads may lag until they
437 <     * actually wake up.
438 <     *
439 <     * 3. Maintaining global run state. The run state of the pool
440 <     * consists of a runLevel (SHUTDOWN, TERMINATING, etc) similar to
441 <     * those in other Executor implementations, as well as a count of
442 <     * "active" workers -- those that are, or soon will be, or
443 <     * recently were executing tasks. The runLevel and active count
444 <     * are packed together in order to correctly trigger shutdown and
445 <     * termination. Without care, active counts can be subject to very
446 <     * high contention.  We substantially reduce this contention by
447 <     * relaxing update rules.  A worker must claim active status
448 <     * prospectively, by activating if it sees that a submitted or
449 <     * stealable task exists (it may find after activating that the
450 <     * task no longer exists). It stays active while processing this
451 <     * task (if it exists) and any other local subtasks it produces,
452 <     * until it cannot find any other tasks. It then tries
453 <     * inactivating (see method preStep), but upon update contention
454 <     * instead scans for more tasks, later retrying inactivation if it
455 <     * doesn't find any.
456 <     *
457 <     * 4. Managing idle workers waiting for tasks. We cannot let
458 <     * workers spin indefinitely scanning for tasks when none are
459 <     * available. On the other hand, we must quickly prod them into
460 <     * action when new tasks are submitted or generated.  We
461 <     * park/unpark these idle workers using an event-count scheme.
462 <     * Field eventCount is incremented upon events that may enable
463 <     * workers that previously could not find a task to now find one:
464 <     * Submission of a new task to the pool, or another worker pushing
465 <     * a task onto a previously empty queue.  (We also use this
466 <     * mechanism for configuration and termination actions that
264 <     * require wakeups of idle workers).  Each worker maintains its
265 <     * last known event count, and blocks when a scan for work did not
266 <     * find a task AND its lastEventCount matches the current
267 <     * eventCount. Waiting idle workers are recorded in a variant of
268 <     * Treiber stack headed by field eventWaiters which, when nonzero,
269 <     * encodes the thread index and count awaited for by the worker
270 <     * thread most recently calling eventSync. This thread in turn has
271 <     * a record (field nextEventWaiter) for the next waiting worker.
272 <     * In addition to allowing simpler decisions about need for
273 <     * wakeup, the event count bits in eventWaiters serve the role of
274 <     * tags to avoid ABA errors in Treiber stacks. Upon any wakeup,
275 <     * released threads also try to release at most two others.  The
276 <     * net effect is a tree-like diffusion of signals, where released
277 <     * threads (and possibly others) help with unparks.  To further
278 <     * reduce contention effects a bit, failed CASes to increment
279 <     * field eventCount are tolerated without retries in signalWork.
280 <     * Conceptually they are merged into the same event, which is OK
281 <     * when their only purpose is to enable workers to scan for work.
282 <     *
283 <     * 5. Managing suspension of extra workers. When a worker notices
284 <     * (usually upon timeout of a wait()) that there are too few
285 <     * running threads, we may create a new thread to maintain
286 <     * parallelism level, or at least avoid starvation. Usually, extra
287 <     * threads are needed for only very short periods, yet join
288 <     * dependencies are such that we sometimes need them in
289 <     * bursts. Rather than create new threads each time this happens,
290 <     * we suspend no-longer-needed extra ones as "spares". For most
291 <     * purposes, we don't distinguish "extra" spare threads from
292 <     * normal "core" threads: On each call to preStep (the only point
293 <     * at which we can do this) a worker checks to see if there are
294 <     * now too many running workers, and if so, suspends itself.
295 <     * Method helpMaintainParallelism looks for suspended threads to
296 <     * resume before considering creating a new replacement. The
297 <     * spares themselves are encoded on another variant of a Treiber
298 <     * Stack, headed at field "spareWaiters".  Note that the use of
299 <     * spares is intrinsically racy.  One thread may become a spare at
300 <     * about the same time as another is needlessly being created. We
301 <     * counteract this and related slop in part by requiring resumed
302 <     * spares to immediately recheck (in preStep) to see whether they
303 <     * should re-suspend.
304 <     *
305 <     * 6. Killing off unneeded workers. A timeout mechanism is used to
306 <     * shed unused workers: The oldest (first) event queue waiter uses
307 <     * a timed rather than hard wait. When this wait times out without
308 <     * a normal wakeup, it tries to shutdown any one (for convenience
309 <     * the newest) other spare or event waiter via
310 <     * tryShutdownUnusedWorker. This eventually reduces the number of
311 <     * worker threads to a minimum of one after a long enough period
312 <     * without use.
313 <     *
314 <     * 7. Deciding when to create new workers. The main dynamic
315 <     * control in this class is deciding when to create extra threads
316 <     * in method helpMaintainParallelism. We would like to keep
317 <     * exactly #parallelism threads running, which is an impossible
318 <     * task. We always need to create one when the number of running
319 <     * threads would become zero and all workers are busy. Beyond
320 <     * this, we must rely on heuristics that work well in the
321 <     * presence of transient phenomena such as GC stalls, dynamic
322 <     * compilation, and wake-up lags. These transients are extremely
323 <     * common -- we are normally trying to fully saturate the CPUs on
324 <     * a machine, so almost any activity other than running tasks
325 <     * impedes accuracy. Our main defense is to allow parallelism to
326 <     * lapse for a while during joins, and use a timeout to see if,
327 <     * after the resulting settling, there is still a need for
328 <     * additional workers.  This also better copes with the fact that
329 <     * some of the methods in this class tend to never become compiled
330 <     * (but are interpreted), so some components of the entire set of
331 <     * controls might execute 100 times faster than others. And
332 <     * similarly for cases where the apparent lack of work is just due
333 <     * to GC stalls and other transient system activity.
334 <     *
335 <     * Beware that there is a lot of representation-level coupling
336 <     * among classes ForkJoinPool, ForkJoinWorkerThread, and
337 <     * ForkJoinTask.  For example, direct access to "workers" array by
338 <     * workers, and direct access to ForkJoinTask.status by both
339 <     * ForkJoinPool and ForkJoinWorkerThread.  There is little point
381 >     * The algorithm in tryHelpStealer entails a form of "linear"
382 >     * helping: Each worker records (in field currentSteal) the most
383 >     * recent task it stole from some other worker. Plus, it records
384 >     * (in field currentJoin) the task it is currently actively
385 >     * joining. Method tryHelpStealer uses these markers to try to
386 >     * find a worker to help (i.e., steal back a task from and execute
387 >     * it) that could hasten completion of the actively joined task.
388 >     * In essence, the joiner executes a task that would be on its own
389 >     * local deque had the to-be-joined task not been stolen. This may
390 >     * be seen as a conservative variant of the approach in Wagner &
391 >     * Calder "Leapfrogging: a portable technique for implementing
392 >     * efficient futures" SIGPLAN Notices, 1993
393 >     * (http://portal.acm.org/citation.cfm?id=155354). It differs in
394 >     * that: (1) We only maintain dependency links across workers upon
395 >     * steals, rather than use per-task bookkeeping.  This sometimes
396 >     * requires a linear scan of workQueues array to locate stealers,
397 >     * but often doesn't because stealers leave hints (that may become
398 >     * stale/wrong) of where to locate them.  It is only a hint
399 >     * because a worker might have had multiple steals and the hint
400 >     * records only one of them (usually the most current).  Hinting
401 >     * isolates cost to when it is needed, rather than adding to
402 >     * per-task overhead.  (2) It is "shallow", ignoring nesting and
403 >     * potentially cyclic mutual steals.  (3) It is intentionally
404 >     * racy: field currentJoin is updated only while actively joining,
405 >     * which means that we miss links in the chain during long-lived
406 >     * tasks, GC stalls etc (which is OK since blocking in such cases
407 >     * is usually a good idea).  (4) We bound the number of attempts
408 >     * to find work (see MAX_HELP) and fall back to suspending the
409 >     * worker and if necessary replacing it with another.
410 >     *
411 >     * Helping actions for CountedCompleters are much simpler: Method
412 >     * helpComplete can take and execute any task with the same root
413 >     * as the task being waited on. However, this still entails some
414 >     * traversal of completer chains, so is less efficient than using
415 >     * CountedCompleters without explicit joins.
416 >     *
417 >     * It is impossible to keep exactly the target parallelism number
418 >     * of threads running at any given time.  Determining the
419 >     * existence of conservatively safe helping targets, the
420 >     * availability of already-created spares, and the apparent need
421 >     * to create new spares are all racy, so we rely on multiple
422 >     * retries of each.  Compensation in the apparent absence of
423 >     * helping opportunities is challenging to control on JVMs, where
424 >     * GC and other activities can stall progress of tasks that in
425 >     * turn stall out many other dependent tasks, without us being
426 >     * able to determine whether they will ever require compensation.
427 >     * Even though work-stealing otherwise encounters little
428 >     * degradation in the presence of more threads than cores,
429 >     * aggressively adding new threads in such cases entails risk of
430 >     * unwanted positive feedback control loops in which more threads
431 >     * cause more dependent stalls (as well as delayed progress of
432 >     * unblocked threads to the point that we know they are available)
433 >     * leading to more situations requiring more threads, and so
434 >     * on. This aspect of control can be seen as an (analytically
435 >     * intractable) game with an opponent that may choose the worst
436 >     * (for us) active thread to stall at any time.  We take several
437 >     * precautions to bound losses (and thus bound gains), mainly in
438 >     * methods tryCompensate and awaitJoin.
439 >     *
440 >     * Common Pool
441 >     * ===========
442 >     *
443 >     * The static commonPool always exists after static
444 >     * initialization.  Since it (or any other created pool) need
445 >     * never be used, we minimize initial construction overhead and
446 >     * footprint to the setup of about a dozen fields, with no nested
447 >     * allocation. Most bootstrapping occurs within method
448 >     * fullExternalPush during the first submission to the pool.
449 >     *
450 >     * When external threads submit to the common pool, they can
451 >     * perform some subtask processing (see externalHelpJoin and
452 >     * related methods).  We do not need to record whether these
453 >     * submissions are to the common pool -- if not, externalHelpJoin
454 >     * returns quickly (at the most helping to signal some common pool
455 >     * workers). These submitters would otherwise be blocked waiting
456 >     * for completion, so the extra effort (with liberally sprinkled
457 >     * task status checks) in inapplicable cases amounts to an odd
458 >     * form of limited spin-wait before blocking in ForkJoinTask.join.
459 >     *
460 >     * Style notes
461 >     * ===========
462 >     *
463 >     * There is a lot of representation-level coupling among classes
464 >     * ForkJoinPool, ForkJoinWorkerThread, and ForkJoinTask.  The
465 >     * fields of WorkQueue maintain data structures managed by
466 >     * ForkJoinPool, so are directly accessed.  There is little point
467       * trying to reduce this, since any associated future changes in
468       * representations will need to be accompanied by algorithmic
469 <     * changes anyway.
470 <     *
471 <     * Style notes: There are lots of inline assignments (of form
472 <     * "while ((local = field) != 0)") which are usually the simplest
473 <     * way to ensure the required read orderings (which are sometimes
474 <     * critical). Also several occurrences of the unusual "do {}
475 <     * while (!cas...)" which is the simplest way to force an update of
476 <     * a CAS'ed variable. There are also other coding oddities that
477 <     * help some methods perform reasonably even when interpreted (not
478 <     * compiled), at the expense of some messy constructions that
479 <     * reduce byte code counts.
480 <     *
481 <     * The order of declarations in this file is: (1) statics (2)
482 <     * fields (along with constants used when unpacking some of them)
483 <     * (3) internal control methods (4) callbacks and other support
484 <     * for ForkJoinTask and ForkJoinWorkerThread classes, (5) exported
485 <     * methods (plus a few little helpers).
469 >     * changes anyway. Several methods intrinsically sprawl because
470 >     * they must accumulate sets of consistent reads of volatiles held
471 >     * in local variables.  Methods signalWork() and scan() are the
472 >     * main bottlenecks, so are especially heavily
473 >     * micro-optimized/mangled.  There are lots of inline assignments
474 >     * (of form "while ((local = field) != 0)") which are usually the
475 >     * simplest way to ensure the required read orderings (which are
476 >     * sometimes critical). This leads to a "C"-like style of listing
477 >     * declarations of these locals at the heads of methods or blocks.
478 >     * There are several occurrences of the unusual "do {} while
479 >     * (!cas...)"  which is the simplest way to force an update of a
480 >     * CAS'ed variable. There are also other coding oddities (including
481 >     * several unnecessary-looking hoisted null checks) that help
482 >     * some methods perform reasonably even when interpreted (not
483 >     * compiled).
484 >     *
485 >     * The order of declarations in this file is:
486 >     * (1) Static utility functions
487 >     * (2) Nested (static) classes
488 >     * (3) Static fields
489 >     * (4) Fields, along with constants used when unpacking some of them
490 >     * (5) Internal control methods
491 >     * (6) Callbacks and other support for ForkJoinTask methods
492 >     * (7) Exported methods
493 >     * (8) Static block initializing statics in minimally dependent order
494 >     */
495 >
496 >    // Static utilities
497 >
498 >    /**
499 >     * If there is a security manager, makes sure caller has
500 >     * permission to modify threads.
501       */
502 +    private static void checkPermission() {
503 +        SecurityManager security = System.getSecurityManager();
504 +        if (security != null)
505 +            security.checkPermission(modifyThreadPermission);
506 +    }
507 +
508 +    // Nested classes
509  
510      /**
511       * Factory for creating new {@link ForkJoinWorkerThread}s.
# Line 378 | Line 527 | public class ForkJoinPool extends Abstra
527       * Default ForkJoinWorkerThreadFactory implementation; creates a
528       * new ForkJoinWorkerThread.
529       */
530 <    static class DefaultForkJoinWorkerThreadFactory
530 >    static final class DefaultForkJoinWorkerThreadFactory
531          implements ForkJoinWorkerThreadFactory {
532 <        public ForkJoinWorkerThread newThread(ForkJoinPool pool) {
532 >        public final ForkJoinWorkerThread newThread(ForkJoinPool pool) {
533              return new ForkJoinWorkerThread(pool);
534          }
535      }
536  
537      /**
538 <     * Creates a new ForkJoinWorkerThread. This factory is used unless
539 <     * overridden in ForkJoinPool constructors.
538 >     * Per-thread records for threads that submit to pools. Currently
539 >     * holds only pseudo-random seed / index that is used to choose
540 >     * submission queues in method externalPush. In the future, this may
541 >     * also incorporate a means to implement different task rejection
542 >     * and resubmission policies.
543 >     *
544 >     * Seeds for submitters and workers/workQueues work in basically
545 >     * the same way but are initialized and updated using slightly
546 >     * different mechanics. Both are initialized using the same
547 >     * approach as in class ThreadLocal, where successive values are
548 >     * unlikely to collide with previous values. Seeds are then
549 >     * randomly modified upon collisions using xorshifts, which
550 >     * requires a non-zero seed.
551 >     */
552 >    static final class Submitter {
553 >        int seed;
554 >        Submitter(int s) { seed = s; }
555 >    }
556 >
557 >    /**
558 >     * Class for artificial tasks that are used to replace the target
559 >     * of local joins if they are removed from an interior queue slot
560 >     * in WorkQueue.tryRemoveAndExec. We don't need the proxy to
561 >     * actually do anything beyond having a unique identity.
562 >     */
563 >    static final class EmptyTask extends ForkJoinTask<Void> {
564 >        private static final long serialVersionUID = -7721805057305804111L;
565 >        EmptyTask() { status = ForkJoinTask.NORMAL; } // force done
566 >        public final Void getRawResult() { return null; }
567 >        public final void setRawResult(Void x) {}
568 >        public final boolean exec() { return true; }
569 >    }
570 >
571 >    /**
572 >     * Queues supporting work-stealing as well as external task
573 >     * submission. See above for main rationale and algorithms.
574 >     * Implementation relies heavily on "Unsafe" intrinsics
575 >     * and selective use of "volatile":
576 >     *
577 >     * Field "base" is the index (mod array.length) of the least valid
578 >     * queue slot, which is always the next position to steal (poll)
579 >     * from if nonempty. Reads and writes require volatile orderings
580 >     * but not CAS, because updates are only performed after slot
581 >     * CASes.
582 >     *
583 >     * Field "top" is the index (mod array.length) of the next queue
584 >     * slot to push to or pop from. It is written only by owner thread
585 >     * for push, or under lock for external/shared push, and accessed
586 >     * by other threads only after reading (volatile) base.  Both top
587 >     * and base are allowed to wrap around on overflow, but (top -
588 >     * base) (or more commonly -(base - top) to force volatile read of
589 >     * base before top) still estimates size. The lock ("qlock") is
590 >     * forced to -1 on termination, causing all further lock attempts
591 >     * to fail. (Note: we don't need CAS for termination state because
592 >     * upon pool shutdown, all shared-queues will stop being used
593 >     * anyway.)  Nearly all lock bodies are set up so that exceptions
594 >     * within lock bodies are "impossible" (modulo JVM errors that
595 >     * would cause failure anyway.)
596 >     *
597 >     * The array slots are read and written using the emulation of
598 >     * volatiles/atomics provided by Unsafe. Insertions must in
599 >     * general use putOrderedObject as a form of releasing store to
600 >     * ensure that all writes to the task object are ordered before
601 >     * its publication in the queue.  All removals entail a CAS to
602 >     * null.  The array is always a power of two. To ensure safety of
603 >     * Unsafe array operations, all accesses perform explicit null
604 >     * checks and implicit bounds checks via power-of-two masking.
605 >     *
606 >     * In addition to basic queuing support, this class contains
607 >     * fields described elsewhere to control execution. It turns out
608 >     * to work better memory-layout-wise to include them in this class
609 >     * rather than a separate class.
610 >     *
611 >     * Performance on most platforms is very sensitive to placement of
612 >     * instances of both WorkQueues and their arrays -- we absolutely
613 >     * do not want multiple WorkQueue instances or multiple queue
614 >     * arrays sharing cache lines. (It would be best for queue objects
615 >     * and their arrays to share, but there is nothing available to
616 >     * help arrange that).  Unfortunately, because they are recorded
617 >     * in a common array, WorkQueue instances are often moved to be
618 >     * adjacent by garbage collectors. To reduce impact, we use field
619 >     * padding that works OK on common platforms; this effectively
620 >     * trades off slightly slower average field access for the sake of
621 >     * avoiding really bad worst-case access. (Until better JVM
622 >     * support is in place, this padding is dependent on transient
623 >     * properties of JVM field layout rules.) We also take care in
624 >     * allocating, sizing and resizing the array. Non-shared queue
625 >     * arrays are initialized by workers before use. Others are
626 >     * allocated on first use.
627       */
628 <    public static final ForkJoinWorkerThreadFactory
629 <        defaultForkJoinWorkerThreadFactory =
630 <        new DefaultForkJoinWorkerThreadFactory();
628 >    static final class WorkQueue {
629 >        /**
630 >         * Capacity of work-stealing queue array upon initialization.
631 >         * Must be a power of two; at least 4, but should be larger to
632 >         * reduce or eliminate cacheline sharing among queues.
633 >         * Currently, it is much larger, as a partial workaround for
634 >         * the fact that JVMs often place arrays in locations that
635 >         * share GC bookkeeping (especially cardmarks) such that
636 >         * per-write accesses encounter serious memory contention.
637 >         */
638 >        static final int INITIAL_QUEUE_CAPACITY = 1 << 13;
639  
640 <    /**
641 <     * Permission required for callers of methods that may start or
642 <     * kill threads.
643 <     */
644 <    private static final RuntimePermission modifyThreadPermission =
645 <        new RuntimePermission("modifyThread");
640 >        /**
641 >         * Maximum size for queue arrays. Must be a power of two less
642 >         * than or equal to 1 << (31 - width of array entry) to ensure
643 >         * lack of wraparound of index calculations, but defined to a
644 >         * value a bit less than this to help users trap runaway
645 >         * programs before saturating systems.
646 >         */
647 >        static final int MAXIMUM_QUEUE_CAPACITY = 1 << 26; // 64M
648  
649 <    /**
650 <     * If there is a security manager, makes sure caller has
651 <     * permission to modify threads.
652 <     */
653 <    private static void checkPermission() {
654 <        SecurityManager security = System.getSecurityManager();
655 <        if (security != null)
656 <            security.checkPermission(modifyThreadPermission);
649 >        // Heuristic padding to ameliorate unfortunate memory placements
650 >        volatile long pad00, pad01, pad02, pad03, pad04, pad05, pad06;
651 >
652 >        int seed;                  // for random scanning; initialize nonzero
653 >        volatile int eventCount;   // encoded inactivation count; < 0 if inactive
654 >        int nextWait;              // encoded record of next event waiter
655 >        int hint;                  // steal or signal hint (index)
656 >        int poolIndex;             // index of this queue in pool (or 0)
657 >        final int mode;            // 0: lifo, > 0: fifo, < 0: shared
658 >        int nsteals;               // number of steals
659 >        volatile int qlock;        // 1: locked, -1: terminate; else 0
660 >        volatile int base;         // index of next slot for poll
661 >        int top;                   // index of next slot for push
662 >        ForkJoinTask<?>[] array;   // the elements (initially unallocated)
663 >        final ForkJoinPool pool;   // the containing pool (may be null)
664 >        final ForkJoinWorkerThread owner; // owning thread or null if shared
665 >        volatile Thread parker;    // == owner during call to park; else null
666 >        volatile ForkJoinTask<?> currentJoin;  // task being joined in awaitJoin
667 >        ForkJoinTask<?> currentSteal; // current non-local task being executed
668 >
669 >        volatile Object pad10, pad11, pad12, pad13, pad14, pad15, pad16, pad17;
670 >        volatile Object pad18, pad19, pad1a, pad1b, pad1c, pad1d;
671 >
672 >        WorkQueue(ForkJoinPool pool, ForkJoinWorkerThread owner, int mode,
673 >                  int seed) {
674 >            this.pool = pool;
675 >            this.owner = owner;
676 >            this.mode = mode;
677 >            this.seed = seed;
678 >            // Place indices in the center of array (that is not yet allocated)
679 >            base = top = INITIAL_QUEUE_CAPACITY >>> 1;
680 >        }
681 >
682 >        /**
683 >         * Returns the approximate number of tasks in the queue.
684 >         */
685 >        final int queueSize() {
686 >            int n = base - top;       // non-owner callers must read base first
687 >            return (n >= 0) ? 0 : -n; // ignore transient negative
688 >        }
689 >
690 >       /**
691 >         * Provides a more accurate estimate of whether this queue has
692 >         * any tasks than does queueSize, by checking whether a
693 >         * near-empty queue has at least one unclaimed task.
694 >         */
695 >        final boolean isEmpty() {
696 >            ForkJoinTask<?>[] a; int m, s;
697 >            int n = base - (s = top);
698 >            return (n >= 0 ||
699 >                    (n == -1 &&
700 >                     ((a = array) == null ||
701 >                      (m = a.length - 1) < 0 ||
702 >                      U.getObject
703 >                      (a, (long)((m & (s - 1)) << ASHIFT) + ABASE) == null)));
704 >        }
705 >
706 >        /**
707 >         * Pushes a task. Call only by owner in unshared queues.  (The
708 >         * shared-queue version is embedded in method externalPush.)
709 >         *
710 >         * @param task the task. Caller must ensure non-null.
711 >         * @throw RejectedExecutionException if array cannot be resized
712 >         */
713 >        final void push(ForkJoinTask<?> task) {
714 >            ForkJoinTask<?>[] a; ForkJoinPool p;
715 >            int s = top, m, n;
716 >            if ((a = array) != null) {    // ignore if queue removed
717 >                int j = (((m = a.length - 1) & s) << ASHIFT) + ABASE;
718 >                U.putOrderedObject(a, j, task);
719 >                if ((n = (top = s + 1) - base) <= 2) {
720 >                    if ((p = pool) != null)
721 >                        p.signalWork(this);
722 >                }
723 >                else if (n >= m)
724 >                    growArray();
725 >            }
726 >        }
727 >
728 >       /**
729 >         * Initializes or doubles the capacity of array. Call either
730 >         * by owner or with lock held -- it is OK for base, but not
731 >         * top, to move while resizings are in progress.
732 >         */
733 >        final ForkJoinTask<?>[] growArray() {
734 >            ForkJoinTask<?>[] oldA = array;
735 >            int size = oldA != null ? oldA.length << 1 : INITIAL_QUEUE_CAPACITY;
736 >            if (size > MAXIMUM_QUEUE_CAPACITY)
737 >                throw new RejectedExecutionException("Queue capacity exceeded");
738 >            int oldMask, t, b;
739 >            ForkJoinTask<?>[] a = array = new ForkJoinTask<?>[size];
740 >            if (oldA != null && (oldMask = oldA.length - 1) >= 0 &&
741 >                (t = top) - (b = base) > 0) {
742 >                int mask = size - 1;
743 >                do {
744 >                    ForkJoinTask<?> x;
745 >                    int oldj = ((b & oldMask) << ASHIFT) + ABASE;
746 >                    int j    = ((b &    mask) << ASHIFT) + ABASE;
747 >                    x = (ForkJoinTask<?>)U.getObjectVolatile(oldA, oldj);
748 >                    if (x != null &&
749 >                        U.compareAndSwapObject(oldA, oldj, x, null))
750 >                        U.putObjectVolatile(a, j, x);
751 >                } while (++b != t);
752 >            }
753 >            return a;
754 >        }
755 >
756 >        /**
757 >         * Takes next task, if one exists, in LIFO order.  Call only
758 >         * by owner in unshared queues.
759 >         */
760 >        final ForkJoinTask<?> pop() {
761 >            ForkJoinTask<?>[] a; ForkJoinTask<?> t; int m;
762 >            if ((a = array) != null && (m = a.length - 1) >= 0) {
763 >                for (int s; (s = top - 1) - base >= 0;) {
764 >                    long j = ((m & s) << ASHIFT) + ABASE;
765 >                    if ((t = (ForkJoinTask<?>)U.getObject(a, j)) == null)
766 >                        break;
767 >                    if (U.compareAndSwapObject(a, j, t, null)) {
768 >                        top = s;
769 >                        return t;
770 >                    }
771 >                }
772 >            }
773 >            return null;
774 >        }
775 >
776 >        /**
777 >         * Takes a task in FIFO order if b is base of queue and a task
778 >         * can be claimed without contention. Specialized versions
779 >         * appear in ForkJoinPool methods scan and tryHelpStealer.
780 >         */
781 >        final ForkJoinTask<?> pollAt(int b) {
782 >            ForkJoinTask<?> t; ForkJoinTask<?>[] a;
783 >            if ((a = array) != null) {
784 >                int j = (((a.length - 1) & b) << ASHIFT) + ABASE;
785 >                if ((t = (ForkJoinTask<?>)U.getObjectVolatile(a, j)) != null &&
786 >                    base == b &&
787 >                    U.compareAndSwapObject(a, j, t, null)) {
788 >                    base = b + 1;
789 >                    return t;
790 >                }
791 >            }
792 >            return null;
793 >        }
794 >
795 >        /**
796 >         * Takes next task, if one exists, in FIFO order.
797 >         */
798 >        final ForkJoinTask<?> poll() {
799 >            ForkJoinTask<?>[] a; int b; ForkJoinTask<?> t;
800 >            while ((b = base) - top < 0 && (a = array) != null) {
801 >                int j = (((a.length - 1) & b) << ASHIFT) + ABASE;
802 >                t = (ForkJoinTask<?>)U.getObjectVolatile(a, j);
803 >                if (t != null) {
804 >                    if (base == b &&
805 >                        U.compareAndSwapObject(a, j, t, null)) {
806 >                        base = b + 1;
807 >                        return t;
808 >                    }
809 >                }
810 >                else if (base == b) {
811 >                    if (b + 1 == top)
812 >                        break;
813 >                    Thread.yield(); // wait for lagging update (very rare)
814 >                }
815 >            }
816 >            return null;
817 >        }
818 >
819 >        /**
820 >         * Takes next task, if one exists, in order specified by mode.
821 >         */
822 >        final ForkJoinTask<?> nextLocalTask() {
823 >            return mode == 0 ? pop() : poll();
824 >        }
825 >
826 >        /**
827 >         * Returns next task, if one exists, in order specified by mode.
828 >         */
829 >        final ForkJoinTask<?> peek() {
830 >            ForkJoinTask<?>[] a = array; int m;
831 >            if (a == null || (m = a.length - 1) < 0)
832 >                return null;
833 >            int i = mode == 0 ? top - 1 : base;
834 >            int j = ((i & m) << ASHIFT) + ABASE;
835 >            return (ForkJoinTask<?>)U.getObjectVolatile(a, j);
836 >        }
837 >
838 >        /**
839 >         * Pops the given task only if it is at the current top.
840 >         * (A shared version is available only via FJP.tryExternalUnpush)
841 >         */
842 >        final boolean tryUnpush(ForkJoinTask<?> t) {
843 >            ForkJoinTask<?>[] a; int s;
844 >            if ((a = array) != null && (s = top) != base &&
845 >                U.compareAndSwapObject
846 >                (a, (((a.length - 1) & --s) << ASHIFT) + ABASE, t, null)) {
847 >                top = s;
848 >                return true;
849 >            }
850 >            return false;
851 >        }
852 >
853 >        /**
854 >         * Removes and cancels all known tasks, ignoring any exceptions.
855 >         */
856 >        final void cancelAll() {
857 >            ForkJoinTask.cancelIgnoringExceptions(currentJoin);
858 >            ForkJoinTask.cancelIgnoringExceptions(currentSteal);
859 >            for (ForkJoinTask<?> t; (t = poll()) != null; )
860 >                ForkJoinTask.cancelIgnoringExceptions(t);
861 >        }
862 >
863 >        /**
864 >         * Computes next value for random probes.  Scans don't require
865 >         * a very high quality generator, but also not a crummy one.
866 >         * Marsaglia xor-shift is cheap and works well enough.  Note:
867 >         * This is manually inlined in its usages in ForkJoinPool to
868 >         * avoid writes inside busy scan loops.
869 >         */
870 >        final int nextSeed() {
871 >            int r = seed;
872 >            r ^= r << 13;
873 >            r ^= r >>> 17;
874 >            return seed = r ^= r << 5;
875 >        }
876 >
877 >        // Specialized execution methods
878 >
879 >        /**
880 >         * Pops and runs tasks until empty.
881 >         */
882 >        private void popAndExecAll() {
883 >            // A bit faster than repeated pop calls
884 >            ForkJoinTask<?>[] a; int m, s; long j; ForkJoinTask<?> t;
885 >            while ((a = array) != null && (m = a.length - 1) >= 0 &&
886 >                   (s = top - 1) - base >= 0 &&
887 >                   (t = ((ForkJoinTask<?>)
888 >                         U.getObject(a, j = ((m & s) << ASHIFT) + ABASE)))
889 >                   != null) {
890 >                if (U.compareAndSwapObject(a, j, t, null)) {
891 >                    top = s;
892 >                    t.doExec();
893 >                }
894 >            }
895 >        }
896 >
897 >        /**
898 >         * Polls and runs tasks until empty.
899 >         */
900 >        private void pollAndExecAll() {
901 >            for (ForkJoinTask<?> t; (t = poll()) != null;)
902 >                t.doExec();
903 >        }
904 >
905 >        /**
906 >         * If present, removes from queue and executes the given task,
907 >         * or any other cancelled task. Returns (true) on any CAS
908 >         * or consistency check failure so caller can retry.
909 >         *
910 >         * @return false if no progress can be made, else true;
911 >         */
912 >        final boolean tryRemoveAndExec(ForkJoinTask<?> task) {
913 >            boolean stat = true, removed = false, empty = true;
914 >            ForkJoinTask<?>[] a; int m, s, b, n;
915 >            if ((a = array) != null && (m = a.length - 1) >= 0 &&
916 >                (n = (s = top) - (b = base)) > 0) {
917 >                for (ForkJoinTask<?> t;;) {           // traverse from s to b
918 >                    int j = ((--s & m) << ASHIFT) + ABASE;
919 >                    t = (ForkJoinTask<?>)U.getObjectVolatile(a, j);
920 >                    if (t == null)                    // inconsistent length
921 >                        break;
922 >                    else if (t == task) {
923 >                        if (s + 1 == top) {           // pop
924 >                            if (!U.compareAndSwapObject(a, j, task, null))
925 >                                break;
926 >                            top = s;
927 >                            removed = true;
928 >                        }
929 >                        else if (base == b)           // replace with proxy
930 >                            removed = U.compareAndSwapObject(a, j, task,
931 >                                                             new EmptyTask());
932 >                        break;
933 >                    }
934 >                    else if (t.status >= 0)
935 >                        empty = false;
936 >                    else if (s + 1 == top) {          // pop and throw away
937 >                        if (U.compareAndSwapObject(a, j, t, null))
938 >                            top = s;
939 >                        break;
940 >                    }
941 >                    if (--n == 0) {
942 >                        if (!empty && base == b)
943 >                            stat = false;
944 >                        break;
945 >                    }
946 >                }
947 >            }
948 >            if (removed)
949 >                task.doExec();
950 >            return stat;
951 >        }
952 >
953 >        /**
954 >         * Polls for and executes the given task or any other task in
955 >         * its CountedCompleter computation
956 >         */
957 >        final boolean pollAndExecCC(ForkJoinTask<?> root) {
958 >            ForkJoinTask<?>[] a; int b; Object o;
959 >            outer: while ((b = base) - top < 0 && (a = array) != null) {
960 >                long j = (((a.length - 1) & b) << ASHIFT) + ABASE;
961 >                if ((o = U.getObject(a, j)) == null ||
962 >                    !(o instanceof CountedCompleter))
963 >                    break;
964 >                for (CountedCompleter<?> t = (CountedCompleter<?>)o, r = t;;) {
965 >                    if (r == root) {
966 >                        if (base == b &&
967 >                            U.compareAndSwapObject(a, j, t, null)) {
968 >                            base = b + 1;
969 >                            t.doExec();
970 >                            return true;
971 >                        }
972 >                        else
973 >                            break; // restart
974 >                    }
975 >                    if ((r = r.completer) == null)
976 >                        break outer; // not part of root computation
977 >                }
978 >            }
979 >            return false;
980 >        }
981 >
982 >        /**
983 >         * Executes a top-level task and any local tasks remaining
984 >         * after execution.
985 >         */
986 >        final void runTask(ForkJoinTask<?> t) {
987 >            if (t != null) {
988 >                (currentSteal = t).doExec();
989 >                currentSteal = null;
990 >                if (base - top < 0) {       // process remaining local tasks
991 >                    if (mode == 0)
992 >                        popAndExecAll();
993 >                    else
994 >                        pollAndExecAll();
995 >                }
996 >                ++nsteals;
997 >                hint = -1;
998 >            }
999 >        }
1000 >
1001 >        /**
1002 >         * Executes a non-top-level (stolen) task.
1003 >         */
1004 >        final void runSubtask(ForkJoinTask<?> t) {
1005 >            if (t != null) {
1006 >                ForkJoinTask<?> ps = currentSteal;
1007 >                (currentSteal = t).doExec();
1008 >                currentSteal = ps;
1009 >            }
1010 >        }
1011 >
1012 >        /**
1013 >         * Returns true if owned and not known to be blocked.
1014 >         */
1015 >        final boolean isApparentlyUnblocked() {
1016 >            Thread wt; Thread.State s;
1017 >            return (eventCount >= 0 &&
1018 >                    (wt = owner) != null &&
1019 >                    (s = wt.getState()) != Thread.State.BLOCKED &&
1020 >                    s != Thread.State.WAITING &&
1021 >                    s != Thread.State.TIMED_WAITING);
1022 >        }
1023 >
1024 >        /**
1025 >         * If this owned and is not already interrupted, try to
1026 >         * interrupt and/or unpark, ignoring exceptions.
1027 >         */
1028 >        final void interruptOwner() {
1029 >            Thread wt, p;
1030 >            if ((wt = owner) != null && !wt.isInterrupted()) {
1031 >                try {
1032 >                    wt.interrupt();
1033 >                } catch (SecurityException ignore) {
1034 >                }
1035 >            }
1036 >            if ((p = parker) != null)
1037 >                U.unpark(p);
1038 >        }
1039 >
1040 >        // Unsafe mechanics
1041 >        private static final sun.misc.Unsafe U;
1042 >        private static final long QLOCK;
1043 >        private static final int ABASE;
1044 >        private static final int ASHIFT;
1045 >        static {
1046 >            int s;
1047 >            try {
1048 >                U = getUnsafe();
1049 >                Class<?> k = WorkQueue.class;
1050 >                Class<?> ak = ForkJoinTask[].class;
1051 >                QLOCK = U.objectFieldOffset
1052 >                    (k.getDeclaredField("qlock"));
1053 >                ABASE = U.arrayBaseOffset(ak);
1054 >                s = U.arrayIndexScale(ak);
1055 >            } catch (Exception e) {
1056 >                throw new Error(e);
1057 >            }
1058 >            if ((s & (s-1)) != 0)
1059 >                throw new Error("data type scale not a power of two");
1060 >            ASHIFT = 31 - Integer.numberOfLeadingZeros(s);
1061 >        }
1062      }
1063  
1064 <    /**
414 <     * Generator for assigning sequence numbers as pool names.
415 <     */
416 <    private static final AtomicInteger poolNumberGenerator =
417 <        new AtomicInteger();
1064 >    // static fields (initialized in static initializer below)
1065  
1066      /**
1067 <     * The time to block in a join (see awaitJoin) before checking if
1068 <     * a new worker should be (re)started to maintain parallelism
422 <     * level. The value should be short enough to maintain global
423 <     * responsiveness and progress but long enough to avoid
424 <     * counterproductive firings during GC stalls or unrelated system
425 <     * activity, and to not bog down systems with continual re-firings
426 <     * on GCs or legitimately long waits.
1067 >     * Creates a new ForkJoinWorkerThread. This factory is used unless
1068 >     * overridden in ForkJoinPool constructors.
1069       */
1070 <    private static final long JOIN_TIMEOUT_MILLIS = 250L; // 4 per second
1070 >    public static final ForkJoinWorkerThreadFactory
1071 >        defaultForkJoinWorkerThreadFactory;
1072  
1073      /**
1074 <     * The wakeup interval (in nanoseconds) for the oldest worker
1075 <     * waiting for an event invokes tryShutdownUnusedWorker to shrink
1076 <     * the number of workers.  The exact value does not matter too
1077 <     * much, but should be long enough to slowly release resources
1078 <     * during long periods without use without disrupting normal use.
1074 >     * Per-thread submission bookkeeping. Shared across all pools
1075 >     * to reduce ThreadLocal pollution and because random motion
1076 >     * to avoid contention in one pool is likely to hold for others.
1077 >     * Lazily initialized on first submission (but null-checked
1078 >     * in other contexts to avoid unnecessary initialization).
1079       */
1080 <    private static final long SHRINK_RATE_NANOS =
438 <        30L * 1000L * 1000L * 1000L; // 2 per minute
1080 >    static final ThreadLocal<Submitter> submitters;
1081  
1082      /**
1083 <     * Absolute bound for parallelism level. Twice this number plus
1084 <     * one (i.e., 0xfff) must fit into a 16bit field to enable
443 <     * word-packing for some counts and indices.
1083 >     * Permission required for callers of methods that may start or
1084 >     * kill threads.
1085       */
1086 <    private static final int MAX_WORKERS   = 0x7fff;
1086 >    private static final RuntimePermission modifyThreadPermission;
1087  
1088      /**
1089 <     * Array holding all worker threads in the pool.  Array size must
1090 <     * be a power of two.  Updates and replacements are protected by
1091 <     * workerLock, but the array is always kept in a consistent enough
1092 <     * state to be randomly accessed without locking by workers
452 <     * performing work-stealing, as well as other traversal-based
453 <     * methods in this class. All readers must tolerate that some
454 <     * array slots may be null.
1089 >     * Common (static) pool. Non-null for public use unless a static
1090 >     * construction exception, but internal usages null-check on use
1091 >     * to paranoically avoid potential initialization circularities
1092 >     * as well as to simplify generated code.
1093       */
1094 <    volatile ForkJoinWorkerThread[] workers;
1094 >    static final ForkJoinPool commonPool;
1095  
1096      /**
1097 <     * Queue for external submissions.
1097 >     * Common pool parallelism. Must equal commonPool.parallelism.
1098       */
1099 <    private final LinkedTransferQueue<ForkJoinTask<?>> submissionQueue;
1099 >    static final int commonPoolParallelism;
1100  
1101      /**
1102 <     * Lock protecting updates to workers array.
1102 >     * Sequence number for creating workerNamePrefix.
1103       */
1104 <    private final ReentrantLock workerLock;
1104 >    private static int poolNumberSequence;
1105  
1106      /**
1107 <     * Latch released upon termination.
1107 >     * Return the next sequence number. We don't expect this to
1108 >     * ever contend so use simple builtin sync.
1109       */
1110 <    private final Phaser termination;
1110 >    private static final synchronized int nextPoolId() {
1111 >        return ++poolNumberSequence;
1112 >    }
1113 >
1114 >    // static constants
1115  
1116      /**
1117 <     * Creation factory for worker threads.
1117 >     * Initial timeout value (in nanoseconds) for the thread
1118 >     * triggering quiescence to park waiting for new work. On timeout,
1119 >     * the thread will instead try to shrink the number of
1120 >     * workers. The value should be large enough to avoid overly
1121 >     * aggressive shrinkage during most transient stalls (long GCs
1122 >     * etc).
1123       */
1124 <    private final ForkJoinWorkerThreadFactory factory;
1124 >    private static final long IDLE_TIMEOUT      = 2000L * 1000L * 1000L; // 2sec
1125  
1126      /**
1127 <     * Sum of per-thread steal counts, updated only when threads are
480 <     * idle or terminating.
1127 >     * Timeout value when there are more threads than parallelism level
1128       */
1129 <    private volatile long stealCount;
1129 >    private static final long FAST_IDLE_TIMEOUT =  200L * 1000L * 1000L;
1130  
1131      /**
1132 <     * Encoded record of top of Treiber stack of threads waiting for
486 <     * events. The top 32 bits contain the count being waited for. The
487 <     * bottom 16 bits contains one plus the pool index of waiting
488 <     * worker thread. (Bits 16-31 are unused.)
1132 >     * Tolerance for idle timeouts, to cope with timer undershoots
1133       */
1134 <    private volatile long eventWaiters;
491 <
492 <    private static final int  EVENT_COUNT_SHIFT = 32;
493 <    private static final long WAITER_ID_MASK    = (1L << 16) - 1L;
1134 >    private static final long TIMEOUT_SLOP = 2000000L; // 20ms
1135  
1136      /**
1137 <     * A counter for events that may wake up worker threads:
1138 <     *   - Submission of a new task to the pool
1139 <     *   - A worker pushing a task on an empty queue
1140 <     *   - termination
1137 >     * The maximum stolen->joining link depth allowed in method
1138 >     * tryHelpStealer.  Must be a power of two.  Depths for legitimate
1139 >     * chains are unbounded, but we use a fixed constant to avoid
1140 >     * (otherwise unchecked) cycles and to bound staleness of
1141 >     * traversal parameters at the expense of sometimes blocking when
1142 >     * we could be helping.
1143       */
1144 <    private volatile int eventCount;
1144 >    private static final int MAX_HELP = 64;
1145  
1146      /**
1147 <     * Encoded record of top of Treiber stack of spare threads waiting
1148 <     * for resumption. The top 16 bits contain an arbitrary count to
506 <     * avoid ABA effects. The bottom 16bits contains one plus the pool
507 <     * index of waiting worker thread.
1147 >     * Increment for seed generators. See class ThreadLocal for
1148 >     * explanation.
1149       */
1150 <    private volatile int spareWaiters;
510 <
511 <    private static final int SPARE_COUNT_SHIFT = 16;
512 <    private static final int SPARE_ID_MASK     = (1 << 16) - 1;
1150 >    private static final int SEED_INCREMENT = 0x61c88647;
1151  
1152      /**
1153 <     * Lifecycle control. The low word contains the number of workers
1154 <     * that are (probably) executing tasks. This value is atomically
1155 <     * incremented before a worker gets a task to run, and decremented
1156 <     * when worker has no tasks and cannot find any.  Bits 16-18
1157 <     * contain runLevel value. When all are zero, the pool is
1158 <     * running. Level transitions are monotonic (running -> shutdown
1159 <     * -> terminating -> terminated) so each transition adds a bit.
1160 <     * These are bundled together to ensure consistent read for
1161 <     * termination checks (i.e., that runLevel is at least SHUTDOWN
1162 <     * and active threads is zero).
1153 >     * Bits and masks for control variables
1154 >     *
1155 >     * Field ctl is a long packed with:
1156 >     * AC: Number of active running workers minus target parallelism (16 bits)
1157 >     * TC: Number of total workers minus target parallelism (16 bits)
1158 >     * ST: true if pool is terminating (1 bit)
1159 >     * EC: the wait count of top waiting thread (15 bits)
1160 >     * ID: poolIndex of top of Treiber stack of waiters (16 bits)
1161 >     *
1162 >     * When convenient, we can extract the upper 32 bits of counts and
1163 >     * the lower 32 bits of queue state, u = (int)(ctl >>> 32) and e =
1164 >     * (int)ctl.  The ec field is never accessed alone, but always
1165 >     * together with id and st. The offsets of counts by the target
1166 >     * parallelism and the positionings of fields makes it possible to
1167 >     * perform the most common checks via sign tests of fields: When
1168 >     * ac is negative, there are not enough active workers, when tc is
1169 >     * negative, there are not enough total workers, and when e is
1170 >     * negative, the pool is terminating.  To deal with these possibly
1171 >     * negative fields, we use casts in and out of "short" and/or
1172 >     * signed shifts to maintain signedness.
1173 >     *
1174 >     * When a thread is queued (inactivated), its eventCount field is
1175 >     * set negative, which is the only way to tell if a worker is
1176 >     * prevented from executing tasks, even though it must continue to
1177 >     * scan for them to avoid queuing races. Note however that
1178 >     * eventCount updates lag releases so usage requires care.
1179 >     *
1180 >     * Field plock is an int packed with:
1181 >     * SHUTDOWN: true if shutdown is enabled (1 bit)
1182 >     * SEQ:  a sequence lock, with PL_LOCK bit set if locked (30 bits)
1183 >     * SIGNAL: set when threads may be waiting on the lock (1 bit)
1184       *
1185 <     * Notes: Most direct CASes are dependent on these bitfield
1186 <     * positions.  Also, this field is non-private to enable direct
1187 <     * performance-sensitive CASes in ForkJoinWorkerThread.
1185 >     * The sequence number enables simple consistency checks:
1186 >     * Staleness of read-only operations on the workQueues array can
1187 >     * be checked by comparing plock before vs after the reads.
1188       */
530    volatile int runState;
1189  
1190 <    // Note: The order among run level values matters.
1191 <    private static final int RUNLEVEL_SHIFT     = 16;
1192 <    private static final int SHUTDOWN           = 1 << RUNLEVEL_SHIFT;
1193 <    private static final int TERMINATING        = 1 << (RUNLEVEL_SHIFT + 1);
1194 <    private static final int TERMINATED         = 1 << (RUNLEVEL_SHIFT + 2);
537 <    private static final int ACTIVE_COUNT_MASK  = (1 << RUNLEVEL_SHIFT) - 1;
1190 >    // bit positions/shifts for fields
1191 >    private static final int  AC_SHIFT   = 48;
1192 >    private static final int  TC_SHIFT   = 32;
1193 >    private static final int  ST_SHIFT   = 31;
1194 >    private static final int  EC_SHIFT   = 16;
1195  
1196 <    /**
1197 <     * Holds number of total (i.e., created and not yet terminated)
1198 <     * and running (i.e., not blocked on joins or other managed sync)
1199 <     * threads, packed together to ensure consistent snapshot when
1200 <     * making decisions about creating and suspending spare
1201 <     * threads. Updated only by CAS. Note that adding a new worker
1202 <     * requires incrementing both counts, since workers start off in
546 <     * running state.
547 <     */
548 <    private volatile int workerCounts;
1196 >    // bounds
1197 >    private static final int  SMASK      = 0xffff;  // short bits
1198 >    private static final int  MAX_CAP    = 0x7fff;  // max #workers - 1
1199 >    private static final int  EVENMASK   = 0xfffe;  // even short bits
1200 >    private static final int  SQMASK     = 0x007e;  // max 64 (even) slots
1201 >    private static final int  SHORT_SIGN = 1 << 15;
1202 >    private static final int  INT_SIGN   = 1 << 31;
1203  
1204 <    private static final int TOTAL_COUNT_SHIFT  = 16;
1205 <    private static final int RUNNING_COUNT_MASK = (1 << TOTAL_COUNT_SHIFT) - 1;
1206 <    private static final int ONE_RUNNING        = 1;
1207 <    private static final int ONE_TOTAL          = 1 << TOTAL_COUNT_SHIFT;
1204 >    // masks
1205 >    private static final long STOP_BIT   = 0x0001L << ST_SHIFT;
1206 >    private static final long AC_MASK    = ((long)SMASK) << AC_SHIFT;
1207 >    private static final long TC_MASK    = ((long)SMASK) << TC_SHIFT;
1208  
1209 <    /**
1210 <     * The target parallelism level.
1211 <     * Accessed directly by ForkJoinWorkerThreads.
558 <     */
559 <    final int parallelism;
1209 >    // units for incrementing and decrementing
1210 >    private static final long TC_UNIT    = 1L << TC_SHIFT;
1211 >    private static final long AC_UNIT    = 1L << AC_SHIFT;
1212  
1213 <    /**
1214 <     * True if use local fifo, not default lifo, for local polling
1215 <     * Read by, and replicated by ForkJoinWorkerThreads
1216 <     */
1217 <    final boolean locallyFifo;
1213 >    // masks and units for dealing with u = (int)(ctl >>> 32)
1214 >    private static final int  UAC_SHIFT  = AC_SHIFT - 32;
1215 >    private static final int  UTC_SHIFT  = TC_SHIFT - 32;
1216 >    private static final int  UAC_MASK   = SMASK << UAC_SHIFT;
1217 >    private static final int  UTC_MASK   = SMASK << UTC_SHIFT;
1218 >    private static final int  UAC_UNIT   = 1 << UAC_SHIFT;
1219 >    private static final int  UTC_UNIT   = 1 << UTC_SHIFT;
1220  
1221 <    /**
1222 <     * The uncaught exception handler used when any worker abruptly
1223 <     * terminates.
570 <     */
571 <    private final Thread.UncaughtExceptionHandler ueh;
1221 >    // masks and units for dealing with e = (int)ctl
1222 >    private static final int E_MASK      = 0x7fffffff; // no STOP_BIT
1223 >    private static final int E_SEQ       = 1 << EC_SHIFT;
1224  
1225 <    /**
1226 <     * Pool number, just for assigning useful names to worker threads
1227 <     */
1228 <    private final int poolNumber;
1225 >    // plock bits
1226 >    private static final int SHUTDOWN    = 1 << 31;
1227 >    private static final int PL_LOCK     = 2;
1228 >    private static final int PL_SIGNAL   = 1;
1229 >    private static final int PL_SPINS    = 1 << 8;
1230  
1231 <    // Utilities for CASing fields. Note that most of these
1232 <    // are usually manually inlined by callers
1231 >    // access mode for WorkQueue
1232 >    static final int LIFO_QUEUE          =  0;
1233 >    static final int FIFO_QUEUE          =  1;
1234 >    static final int SHARED_QUEUE        = -1;
1235  
1236 <    /**
1237 <     * Increments running count part of workerCounts
1238 <     */
584 <    final void incrementRunningCount() {
585 <        int c;
586 <        do {} while (!UNSAFE.compareAndSwapInt(this, workerCountsOffset,
587 <                                               c = workerCounts,
588 <                                               c + ONE_RUNNING));
589 <    }
1236 >    // bounds for #steps in scan loop -- must be power 2 minus 1
1237 >    private static final int MIN_SCAN    = 0x1ff;   // cover estimation slop
1238 >    private static final int MAX_SCAN    = 0x1ffff; // 4 * max workers
1239  
1240 <    /**
592 <     * Tries to decrement running count unless already zero
593 <     */
594 <    final boolean tryDecrementRunningCount() {
595 <        int wc = workerCounts;
596 <        if ((wc & RUNNING_COUNT_MASK) == 0)
597 <            return false;
598 <        return UNSAFE.compareAndSwapInt(this, workerCountsOffset,
599 <                                        wc, wc - ONE_RUNNING);
600 <    }
1240 >    // Instance fields
1241  
1242 <    /**
1243 <     * Forces decrement of encoded workerCounts, awaiting nonzero if
1244 <     * (rarely) necessary when other count updates lag.
1245 <     *
1246 <     * @param dr -- either zero or ONE_RUNNING
1247 <     * @param dt == either zero or ONE_TOTAL
1242 >    /*
1243 >     * Field layout of this class tends to matter more than one would
1244 >     * like. Runtime layout order is only loosely related to
1245 >     * declaration order and may differ across JVMs, but the following
1246 >     * empirically works OK on current JVMs.
1247 >     */
1248 >
1249 >    // Heuristic padding to ameliorate unfortunate memory placements
1250 >    volatile long pad00, pad01, pad02, pad03, pad04, pad05, pad06;
1251 >
1252 >    volatile long stealCount;                  // collects worker counts
1253 >    volatile long ctl;                         // main pool control
1254 >    volatile int plock;                        // shutdown status and seqLock
1255 >    volatile int indexSeed;                    // worker/submitter index seed
1256 >    final int config;                          // mode and parallelism level
1257 >    WorkQueue[] workQueues;                    // main registry
1258 >    final ForkJoinWorkerThreadFactory factory;
1259 >    final Thread.UncaughtExceptionHandler ueh; // per-worker UEH
1260 >    final String workerNamePrefix;             // to create worker name string
1261 >
1262 >    volatile Object pad10, pad11, pad12, pad13, pad14, pad15, pad16, pad17;
1263 >    volatile Object pad18, pad19, pad1a, pad1b;
1264 >
1265 >    /*
1266 >     * Acquires the plock lock to protect worker array and related
1267 >     * updates. This method is called only if an initial CAS on plock
1268 >     * fails. This acts as a spinLock for normal cases, but falls back
1269 >     * to builtin monitor to block when (rarely) needed. This would be
1270 >     * a terrible idea for a highly contended lock, but works fine as
1271 >     * a more conservative alternative to a pure spinlock.  See
1272 >     * internal ConcurrentHashMap documentation for further
1273 >     * explanation of nearly the same construction.
1274       */
1275 <    private void decrementWorkerCounts(int dr, int dt) {
1275 >    private int acquirePlock() {
1276 >        int spins = PL_SPINS, r = 0, ps, nps;
1277          for (;;) {
1278 <            int wc = workerCounts;
1279 <            if ((wc & RUNNING_COUNT_MASK)  - dr < 0 ||
1280 <                (wc >>> TOTAL_COUNT_SHIFT) - dt < 0) {
1281 <                if ((runState & TERMINATED) != 0)
1282 <                    return; // lagging termination on a backout
1283 <                Thread.yield();
1278 >            if (((ps = plock) & PL_LOCK) == 0 &&
1279 >                U.compareAndSwapInt(this, PLOCK, ps, nps = ps + PL_LOCK))
1280 >                return nps;
1281 >            else if (r == 0) { // randomize spins if possible
1282 >                Thread t = Thread.currentThread(); WorkQueue w; Submitter z;
1283 >                if ((t instanceof ForkJoinWorkerThread) &&
1284 >                    (w = ((ForkJoinWorkerThread)t).workQueue) != null)
1285 >                    r = w.seed;
1286 >                else if ((z = submitters.get()) != null)
1287 >                    r = z.seed;
1288 >                else
1289 >                    r = 1;
1290 >            }
1291 >            else if (spins >= 0) {
1292 >                r ^= r << 1; r ^= r >>> 3; r ^= r << 10; // xorshift
1293 >                if (r >= 0)
1294 >                    --spins;
1295 >            }
1296 >            else if (U.compareAndSwapInt(this, PLOCK, ps, ps | PL_SIGNAL)) {
1297 >                synchronized (this) {
1298 >                    if ((plock & PL_SIGNAL) != 0) {
1299 >                        try {
1300 >                            wait();
1301 >                        } catch (InterruptedException ie) {
1302 >                            try {
1303 >                                Thread.currentThread().interrupt();
1304 >                            } catch (SecurityException ignore) {
1305 >                            }
1306 >                        }
1307 >                    }
1308 >                    else
1309 >                        notifyAll();
1310 >                }
1311              }
618            if (UNSAFE.compareAndSwapInt(this, workerCountsOffset,
619                                         wc, wc - (dr + dt)))
620                return;
1312          }
1313      }
1314  
1315      /**
1316 <     * Tries decrementing active count; fails on contention.
1317 <     * Called when workers cannot find tasks to run.
1316 >     * Unlocks and signals any thread waiting for plock. Called only
1317 >     * when CAS of seq value for unlock fails.
1318       */
1319 <    final boolean tryDecrementActiveCount() {
1320 <        int c;
1321 <        return UNSAFE.compareAndSwapInt(this, runStateOffset,
631 <                                        c = runState, c - 1);
1319 >    private void releasePlock(int ps) {
1320 >        plock = ps;
1321 >        synchronized (this) { notifyAll(); }
1322      }
1323  
1324      /**
1325 <     * Advances to at least the given level. Returns true if not
1326 <     * already in at least the given level.
1327 <     */
1328 <    private boolean advanceRunLevel(int level) {
1329 <        for (;;) {
1330 <            int s = runState;
1331 <            if ((s & level) != 0)
1332 <                return false;
1333 <            if (UNSAFE.compareAndSwapInt(this, runStateOffset, s, s | level))
1334 <                return true;
1325 >     * Performs secondary initialization, called when plock is zero.
1326 >     * Creates workQueue array and sets plock to a valid value.  The
1327 >     * lock body must be exception-free (so no try/finally) so we
1328 >     * optimistically allocate new array outside the lock and throw
1329 >     * away if (very rarely) not needed. (A similar tactic is used in
1330 >     * fullExternalPush.)  Because the plock seq value can eventually
1331 >     * wrap around zero, this method harmlessly fails to reinitialize
1332 >     * if workQueues exists, while still advancing plock.
1333 >     *
1334 >     * Additionally tries to create the first worker.
1335 >     */
1336 >    private void initWorkers() {
1337 >        WorkQueue[] ws, nws; int ps;
1338 >        int p = config & SMASK;        // find power of two table size
1339 >        int n = (p > 1) ? p - 1 : 1;   // ensure at least 2 slots
1340 >        n |= n >>> 1; n |= n >>> 2; n |= n >>> 4; n |= n >>> 8; n |= n >>> 16;
1341 >        n = (n + 1) << 1;
1342 >        if ((ws = workQueues) == null || ws.length == 0)
1343 >            nws = new WorkQueue[n];
1344 >        else
1345 >            nws = null;
1346 >        if (((ps = plock) & PL_LOCK) != 0 ||
1347 >            !U.compareAndSwapInt(this, PLOCK, ps, ps += PL_LOCK))
1348 >            ps = acquirePlock();
1349 >        if (((ws = workQueues) == null || ws.length == 0) && nws != null)
1350 >            workQueues = nws;
1351 >        int nps = (ps & SHUTDOWN) | ((ps + PL_LOCK) & ~SHUTDOWN);
1352 >        if (!U.compareAndSwapInt(this, PLOCK, ps, nps))
1353 >            releasePlock(nps);
1354 >        tryAddWorker();
1355 >    }
1356 >
1357 >    /**
1358 >     * Tries to create and start one worker if fewer than target
1359 >     * parallelism level exist. Adjusts counts etc on failure.
1360 >     */
1361 >    private void tryAddWorker() {
1362 >        long c; int u;
1363 >        while ((u = (int)((c = ctl) >>> 32)) < 0 &&
1364 >               (u & SHORT_SIGN) != 0 && (int)c == 0) {
1365 >            long nc = (long)(((u + UTC_UNIT) & UTC_MASK) |
1366 >                             ((u + UAC_UNIT) & UAC_MASK)) << 32;
1367 >            if (U.compareAndSwapLong(this, CTL, c, nc)) {
1368 >                ForkJoinWorkerThreadFactory fac;
1369 >                Throwable ex = null;
1370 >                ForkJoinWorkerThread wt = null;
1371 >                try {
1372 >                    if ((fac = factory) != null &&
1373 >                        (wt = fac.newThread(this)) != null) {
1374 >                        wt.start();
1375 >                        break;
1376 >                    }
1377 >                } catch (Throwable e) {
1378 >                    ex = e;
1379 >                }
1380 >                deregisterWorker(wt, ex);
1381 >                break;
1382 >            }
1383          }
1384      }
1385  
1386 <    // workers array maintenance
1386 >    //  Registering and deregistering workers
1387  
1388      /**
1389 <     * Records and returns a workers array index for new worker.
1390 <     */
1391 <    private int recordWorker(ForkJoinWorkerThread w) {
1392 <        // Try using slot totalCount-1. If not available, scan and/or resize
1393 <        int k = (workerCounts >>> TOTAL_COUNT_SHIFT) - 1;
1394 <        final ReentrantLock lock = this.workerLock;
1395 <        lock.lock();
1389 >     * Callback from ForkJoinWorkerThread to establish and record its
1390 >     * WorkQueue. To avoid scanning bias due to packing entries in
1391 >     * front of the workQueues array, we treat the array as a simple
1392 >     * power-of-two hash table using per-thread seed as hash,
1393 >     * expanding as needed.
1394 >     *
1395 >     * @param wt the worker thread
1396 >     * @return the worker's queue
1397 >     */
1398 >    final WorkQueue registerWorker(ForkJoinWorkerThread wt) {
1399 >        Thread.UncaughtExceptionHandler handler; WorkQueue[] ws; int s, ps;
1400 >        wt.setDaemon(true);
1401 >        if ((handler = ueh) != null)
1402 >            wt.setUncaughtExceptionHandler(handler);
1403 >        do {} while (!U.compareAndSwapInt(this, INDEXSEED, s = indexSeed,
1404 >                                          s += SEED_INCREMENT) ||
1405 >                     s == 0); // skip 0
1406 >        WorkQueue w = new WorkQueue(this, wt, config >>> 16, s);
1407 >        if (((ps = plock) & PL_LOCK) != 0 ||
1408 >            !U.compareAndSwapInt(this, PLOCK, ps, ps += PL_LOCK))
1409 >            ps = acquirePlock();
1410 >        int nps = (ps & SHUTDOWN) | ((ps + PL_LOCK) & ~SHUTDOWN);
1411          try {
1412 <            ForkJoinWorkerThread[] ws = workers;
1413 <            int n = ws.length;
1414 <            if (k < 0 || k >= n || ws[k] != null) {
1415 <                for (k = 0; k < n && ws[k] != null; ++k)
1416 <                    ;
1417 <                if (k == n)
1418 <                    ws = Arrays.copyOf(ws, n << 1);
1412 >            if ((ws = workQueues) != null) {    // skip if shutting down
1413 >                int n = ws.length, m = n - 1;
1414 >                int r = (s << 1) | 1;           // use odd-numbered indices
1415 >                if (ws[r &= m] != null) {       // collision
1416 >                    int probes = 0;             // step by approx half size
1417 >                    int step = (n <= 4) ? 2 : ((n >>> 1) & EVENMASK) + 2;
1418 >                    while (ws[r = (r + step) & m] != null) {
1419 >                        if (++probes >= n) {
1420 >                            workQueues = ws = Arrays.copyOf(ws, n <<= 1);
1421 >                            m = n - 1;
1422 >                            probes = 0;
1423 >                        }
1424 >                    }
1425 >                }
1426 >                w.eventCount = w.poolIndex = r; // volatile write orders
1427 >                ws[r] = w;
1428              }
667            ws[k] = w;
668            workers = ws; // volatile array write ensures slot visibility
1429          } finally {
1430 <            lock.unlock();
1430 >            if (!U.compareAndSwapInt(this, PLOCK, ps, nps))
1431 >                releasePlock(nps);
1432          }
1433 <        return k;
1433 >        wt.setName(workerNamePrefix.concat(Integer.toString(w.poolIndex)));
1434 >        return w;
1435      }
1436  
1437      /**
1438 <     * Nulls out record of worker in workers array.
1439 <     */
1440 <    private void forgetWorker(ForkJoinWorkerThread w) {
1441 <        int idx = w.poolIndex;
1442 <        // Locking helps method recordWorker avoid unnecessary expansion
1443 <        final ReentrantLock lock = this.workerLock;
1444 <        lock.lock();
1445 <        try {
1446 <            ForkJoinWorkerThread[] ws = workers;
1447 <            if (idx >= 0 && idx < ws.length && ws[idx] == w) // verify
1448 <                ws[idx] = null;
1449 <        } finally {
1450 <            lock.unlock();
1438 >     * Final callback from terminating worker, as well as upon failure
1439 >     * to construct or start a worker.  Removes record of worker from
1440 >     * array, and adjusts counts. If pool is shutting down, tries to
1441 >     * complete termination.
1442 >     *
1443 >     * @param wt the worker thread or null if construction failed
1444 >     * @param ex the exception causing failure, or null if none
1445 >     */
1446 >    final void deregisterWorker(ForkJoinWorkerThread wt, Throwable ex) {
1447 >        WorkQueue w = null;
1448 >        if (wt != null && (w = wt.workQueue) != null) {
1449 >            int ps;
1450 >            w.qlock = -1;                // ensure set
1451 >            long ns = w.nsteals, sc;     // collect steal count
1452 >            do {} while (!U.compareAndSwapLong(this, STEALCOUNT,
1453 >                                               sc = stealCount, sc + ns));
1454 >            if (((ps = plock) & PL_LOCK) != 0 ||
1455 >                !U.compareAndSwapInt(this, PLOCK, ps, ps += PL_LOCK))
1456 >                ps = acquirePlock();
1457 >            int nps = (ps & SHUTDOWN) | ((ps + PL_LOCK) & ~SHUTDOWN);
1458 >            try {
1459 >                int idx = w.poolIndex;
1460 >                WorkQueue[] ws = workQueues;
1461 >                if (ws != null && idx >= 0 && idx < ws.length && ws[idx] == w)
1462 >                    ws[idx] = null;
1463 >            } finally {
1464 >                if (!U.compareAndSwapInt(this, PLOCK, ps, nps))
1465 >                    releasePlock(nps);
1466 >            }
1467 >        }
1468 >
1469 >        long c;                             // adjust ctl counts
1470 >        do {} while (!U.compareAndSwapLong
1471 >                     (this, CTL, c = ctl, (((c - AC_UNIT) & AC_MASK) |
1472 >                                           ((c - TC_UNIT) & TC_MASK) |
1473 >                                           (c & ~(AC_MASK|TC_MASK)))));
1474 >
1475 >        if (!tryTerminate(false, false) && w != null && w.array != null) {
1476 >            w.cancelAll();                  // cancel remaining tasks
1477 >            int e, u, i, n; WorkQueue[] ws; WorkQueue v; Thread p;
1478 >            while ((u = (int)((c = ctl) >>> 32)) < 0) {
1479 >                if ((e = (int)c) > 0) {     // activate or create replacement
1480 >                    if ((ws = workQueues) != null &&
1481 >                        ws.length > (i = e & SMASK) &&
1482 >                        (v = ws[i]) != null && v.eventCount == (e | INT_SIGN)) {
1483 >                        long nc = (((long)(v.nextWait & E_MASK)) |
1484 >                                   ((long)(u + UAC_UNIT) << 32));
1485 >                        if (U.compareAndSwapLong(this, CTL, c, nc)) {
1486 >                            v.eventCount = (e + E_SEQ) & E_MASK;
1487 >                            if ((p = v.parker) != null)
1488 >                                U.unpark(p);
1489 >                            break;
1490 >                        }
1491 >                    }
1492 >                    else
1493 >                        break;
1494 >                }
1495 >                else {
1496 >                    if ((short)u < 0)
1497 >                        tryAddWorker();
1498 >                    break;
1499 >                }
1500 >            }
1501 >        }
1502 >        if (ex == null)                     // help clean refs on way out
1503 >            ForkJoinTask.helpExpungeStaleExceptions();
1504 >        else                                // rethrow
1505 >            ForkJoinTask.rethrow(ex);
1506 >    }
1507 >
1508 >    // Submissions
1509 >
1510 >    /**
1511 >     * Unless shutting down, adds the given task to a submission queue
1512 >     * at submitter's current queue index (modulo submission
1513 >     * range). Only the most common path is directly handled in this
1514 >     * method. All others are relayed to fullExternalPush.
1515 >     *
1516 >     * @param task the task. Caller must ensure non-null.
1517 >     */
1518 >    final void externalPush(ForkJoinTask<?> task) {
1519 >        WorkQueue[] ws; WorkQueue q; Submitter z; int m; ForkJoinTask<?>[] a;
1520 >        if ((z = submitters.get()) != null && plock > 0 &&
1521 >            (ws = workQueues) != null && (m = (ws.length - 1)) >= 0 &&
1522 >            (q = ws[m & z.seed & SQMASK]) != null &&
1523 >            U.compareAndSwapInt(q, QLOCK, 0, 1)) { // lock
1524 >            int b = q.base, s = q.top, n, an;
1525 >            if ((a = q.array) != null && (an = a.length) > (n = s + 1 - b)) {
1526 >                int j = (((an - 1) & s) << ASHIFT) + ABASE;
1527 >                U.putOrderedObject(a, j, task);
1528 >                q.top = s + 1;                     // push on to deque
1529 >                q.qlock = 0;
1530 >                if (n <= 2)
1531 >                    signalWork(q);
1532 >                return;
1533 >            }
1534 >            q.qlock = 0;
1535          }
1536 +        fullExternalPush(task);
1537      }
1538  
1539      /**
1540 <     * Final callback from terminating worker.  Removes record of
1541 <     * worker from array, and adjusts counts. If pool is shutting
1542 <     * down, tries to complete termination.
1543 <     *
1544 <     * @param w the worker
1545 <     */
1546 <    final void workerTerminated(ForkJoinWorkerThread w) {
1547 <        forgetWorker(w);
1548 <        decrementWorkerCounts(w.isTrimmed()? 0 : ONE_RUNNING, ONE_TOTAL);
1549 <        while (w.stealCount != 0) // collect final count
1550 <            tryAccumulateStealCount(w);
1551 <        tryTerminate(false);
1540 >     * Full version of externalPush. This method is called, among
1541 >     * other times, upon the first submission of the first task to the
1542 >     * pool, so must perform secondary initialization (via
1543 >     * initWorkers). It also detects first submission by an external
1544 >     * thread by looking up its ThreadLocal, and creates a new shared
1545 >     * queue if the one at index if empty or contended. The plock lock
1546 >     * body must be exception-free (so no try/finally) so we
1547 >     * optimistically allocate new queues outside the lock and throw
1548 >     * them away if (very rarely) not needed.
1549 >     */
1550 >    private void fullExternalPush(ForkJoinTask<?> task) {
1551 >        int r = 0; // random index seed
1552 >        for (Submitter z = submitters.get();;) {
1553 >            WorkQueue[] ws; WorkQueue q; int ps, m, k;
1554 >            if (z == null) {
1555 >                if (U.compareAndSwapInt(this, INDEXSEED, r = indexSeed,
1556 >                                        r += SEED_INCREMENT) && r != 0)
1557 >                    submitters.set(z = new Submitter(r));
1558 >            }
1559 >            else if (r == 0) {               // move to a different index
1560 >                r = z.seed;
1561 >                r ^= r << 13;                // same xorshift as WorkQueues
1562 >                r ^= r >>> 17;
1563 >                z.seed = r ^ (r << 5);
1564 >            }
1565 >            else if ((ps = plock) < 0)
1566 >                throw new RejectedExecutionException();
1567 >            else if (ps == 0 || (ws = workQueues) == null ||
1568 >                     (m = ws.length - 1) < 0)
1569 >                initWorkers();
1570 >            else if ((q = ws[k = r & m & SQMASK]) != null) {
1571 >                if (q.qlock == 0 && U.compareAndSwapInt(q, QLOCK, 0, 1)) {
1572 >                    ForkJoinTask<?>[] a = q.array;
1573 >                    int s = q.top;
1574 >                    boolean submitted = false;
1575 >                    try {                      // locked version of push
1576 >                        if ((a != null && a.length > s + 1 - q.base) ||
1577 >                            (a = q.growArray()) != null) {   // must presize
1578 >                            int j = (((a.length - 1) & s) << ASHIFT) + ABASE;
1579 >                            U.putOrderedObject(a, j, task);
1580 >                            q.top = s + 1;
1581 >                            submitted = true;
1582 >                        }
1583 >                    } finally {
1584 >                        q.qlock = 0;  // unlock
1585 >                    }
1586 >                    if (submitted) {
1587 >                        signalWork(q);
1588 >                        return;
1589 >                    }
1590 >                }
1591 >                r = 0; // move on failure
1592 >            }
1593 >            else if (((ps = plock) & PL_LOCK) == 0) { // create new queue
1594 >                q = new WorkQueue(this, null, SHARED_QUEUE, r);
1595 >                if (((ps = plock) & PL_LOCK) != 0 ||
1596 >                    !U.compareAndSwapInt(this, PLOCK, ps, ps += PL_LOCK))
1597 >                    ps = acquirePlock();
1598 >                if ((ws = workQueues) != null && k < ws.length && ws[k] == null)
1599 >                    ws[k] = q;
1600 >                int nps = (ps & SHUTDOWN) | ((ps + PL_LOCK) & ~SHUTDOWN);
1601 >                if (!U.compareAndSwapInt(this, PLOCK, ps, nps))
1602 >                    releasePlock(nps);
1603 >            }
1604 >            else
1605 >                r = 0; // try elsewhere while lock held
1606 >        }
1607      }
1608  
1609 <    // Waiting for and signalling events
1609 >    // Maintaining ctl counts
1610 >
1611 >    /**
1612 >     * Increments active count; mainly called upon return from blocking.
1613 >     */
1614 >    final void incrementActiveCount() {
1615 >        long c;
1616 >        do {} while (!U.compareAndSwapLong(this, CTL, c = ctl, c + AC_UNIT));
1617 >    }
1618  
1619      /**
1620 <     * Releases workers blocked on a count not equal to current count.
1621 <     * Normally called after precheck that eventWaiters isn't zero to
1622 <     * avoid wasted array checks. Gives up upon a change in count or
713 <     * upon releasing two workers, letting others take over.
1620 >     * Tries to create or activate a worker if too few are active.
1621 >     *
1622 >     * @param q the (non-null) queue holding tasks to be signalled
1623       */
1624 <    private void releaseEventWaiters() {
1625 <        ForkJoinWorkerThread[] ws = workers;
1626 <        int n = ws.length;
1627 <        long h = eventWaiters;
1628 <        int ec = eventCount;
1629 <        boolean releasedOne = false;
1630 <        ForkJoinWorkerThread w; int id;
1631 <        while ((id = ((int)(h & WAITER_ID_MASK)) - 1) >= 0 &&
1632 <               (int)(h >>> EVENT_COUNT_SHIFT) != ec &&
1633 <               id < n && (w = ws[id]) != null) {
1634 <            if (UNSAFE.compareAndSwapLong(this, eventWaitersOffset,
1635 <                                          h,  w.nextWaiter)) {
1636 <                LockSupport.unpark(w);
1637 <                if (releasedOne) // exit on second release
1624 >    final void signalWork(WorkQueue q) {
1625 >        int hint = q.poolIndex;
1626 >        long c; int e, u, i, n; WorkQueue[] ws; WorkQueue w; Thread p;
1627 >        while ((u = (int)((c = ctl) >>> 32)) < 0) {
1628 >            if ((e = (int)c) > 0) {
1629 >                if ((ws = workQueues) != null && ws.length > (i = e & SMASK) &&
1630 >                    (w = ws[i]) != null && w.eventCount == (e | INT_SIGN)) {
1631 >                    long nc = (((long)(w.nextWait & E_MASK)) |
1632 >                               ((long)(u + UAC_UNIT) << 32));
1633 >                    if (U.compareAndSwapLong(this, CTL, c, nc)) {
1634 >                        w.hint = hint;
1635 >                        w.eventCount = (e + E_SEQ) & E_MASK;
1636 >                        if ((p = w.parker) != null)
1637 >                            U.unpark(p);
1638 >                        break;
1639 >                    }
1640 >                    if (q.top - q.base <= 0)
1641 >                        break;
1642 >                }
1643 >                else
1644                      break;
730                releasedOne = true;
1645              }
1646 <            if (eventCount != ec)
1646 >            else {
1647 >                if ((short)u < 0)
1648 >                    tryAddWorker();
1649                  break;
1650 <            h = eventWaiters;
1650 >            }
1651          }
1652      }
1653  
1654 +    // Scanning for tasks
1655 +
1656      /**
1657 <     * Tries to advance eventCount and releases waiters. Called only
740 <     * from workers.
1657 >     * Top-level runloop for workers, called by ForkJoinWorkerThread.run.
1658       */
1659 <    final void signalWork() {
1660 <        int c; // try to increment event count -- CAS failure OK
1661 <        UNSAFE.compareAndSwapInt(this, eventCountOffset, c = eventCount, c+1);
1662 <        if (eventWaiters != 0L)
1663 <            releaseEventWaiters();
1659 >    final void runWorker(WorkQueue w) {
1660 >        w.growArray(); // allocate queue
1661 >        do { w.runTask(scan(w)); } while (w.qlock >= 0);
1662 >    }
1663 >
1664 >    /**
1665 >     * Scans for and, if found, returns one task, else possibly
1666 >     * inactivates the worker. This method operates on single reads of
1667 >     * volatile state and is designed to be re-invoked continuously,
1668 >     * in part because it returns upon detecting inconsistencies,
1669 >     * contention, or state changes that indicate possible success on
1670 >     * re-invocation.
1671 >     *
1672 >     * The scan searches for tasks across queues (starting at a random
1673 >     * index, and relying on registerWorker to irregularly scatter
1674 >     * them within array to avoid bias), checking each at least twice.
1675 >     * The scan terminates upon either finding a non-empty queue, or
1676 >     * completing the sweep. If the worker is not inactivated, it
1677 >     * takes and returns a task from this queue. Otherwise, if not
1678 >     * activated, it signals workers (that may include itself) and
1679 >     * returns so caller can retry. Also returns for true if the
1680 >     * worker array may have changed during an empty scan.  On failure
1681 >     * to find a task, we take one of the following actions, after
1682 >     * which the caller will retry calling this method unless
1683 >     * terminated.
1684 >     *
1685 >     * * If pool is terminating, terminate the worker.
1686 >     *
1687 >     * * If not already enqueued, try to inactivate and enqueue the
1688 >     * worker on wait queue. Or, if inactivating has caused the pool
1689 >     * to be quiescent, relay to idleAwaitWork to check for
1690 >     * termination and possibly shrink pool.
1691 >     *
1692 >     * * If already enqueued and none of the above apply, possibly
1693 >     * (with 1/2 probability) park awaiting signal, else lingering to
1694 >     * help scan and signal.
1695 >     *
1696 >     * @param w the worker (via its WorkQueue)
1697 >     * @return a task or null if none found
1698 >     */
1699 >    private final ForkJoinTask<?> scan(WorkQueue w) {
1700 >        WorkQueue[] ws; int m;
1701 >        int ps = plock;                          // read plock before ws
1702 >        if (w != null && (ws = workQueues) != null && (m = ws.length - 1) >= 0) {
1703 >            int ec = w.eventCount;               // ec is negative if inactive
1704 >            int r = w.seed; r ^= r << 13; r ^= r >>> 17; w.seed = r ^= r << 5;
1705 >            int j = ((m + m + 1) | MIN_SCAN) & MAX_SCAN;
1706 >            do {
1707 >                WorkQueue q; ForkJoinTask<?>[] a; int b;
1708 >                if ((q = ws[(r + j) & m]) != null && (b = q.base) - q.top < 0 &&
1709 >                    (a = q.array) != null) {     // probably nonempty
1710 >                    int i = (((a.length - 1) & b) << ASHIFT) + ABASE;
1711 >                    ForkJoinTask<?> t = (ForkJoinTask<?>)
1712 >                        U.getObjectVolatile(a, i);
1713 >                    if (q.base == b && ec >= 0 && t != null &&
1714 >                        U.compareAndSwapObject(a, i, t, null)) {
1715 >                        if ((q.base = b + 1) - q.top < 0)
1716 >                            signalWork(q);
1717 >                        return t;                // taken
1718 >                    }
1719 >                    else if ((ec < 0 || j < m) && (int)(ctl >> AC_SHIFT) <= 0) {
1720 >                        w.hint = (r + j) & m;    // help signal below
1721 >                        break;                   // cannot take
1722 >                    }
1723 >                }
1724 >            } while (--j >= 0);
1725 >
1726 >            long c, sc; int e, ns, h;
1727 >            if ((h = w.hint) < 0) {
1728 >                if ((ns = w.nsteals) != 0) {
1729 >                    if (U.compareAndSwapLong(this, STEALCOUNT,
1730 >                                             sc = stealCount, sc + ns))
1731 >                        w.nsteals = 0;           // collect steals
1732 >                }
1733 >                else if (plock != ps)            // consistency check
1734 >                    ;                            // skip
1735 >                else if ((e = (int)(c = ctl)) < 0)
1736 >                    w.qlock = -1;                // pool is terminating
1737 >                else if (ec >= 0) {              // try to enqueue/inactivate
1738 >                    long nc = ((long)ec | ((c - AC_UNIT) & (AC_MASK|TC_MASK)));
1739 >                    w.nextWait = e;              // link and mark inactive
1740 >                    w.eventCount = ec | INT_SIGN;
1741 >                    if (ctl != c || !U.compareAndSwapLong(this, CTL, c, nc))
1742 >                        w.eventCount = ec;       // unmark on CAS failure
1743 >                    else if ((int)(c >> AC_SHIFT) == 1 - (config & SMASK))
1744 >                        idleAwaitWork(w, nc, c);
1745 >                }
1746 >                else if (w.eventCount < 0) {     // block
1747 >                    Thread wt = Thread.currentThread();
1748 >                    Thread.interrupted();        // clear status
1749 >                    U.putObject(wt, PARKBLOCKER, this);
1750 >                    w.parker = wt;               // emulate LockSupport.park
1751 >                    if (w.eventCount < 0)        // recheck
1752 >                        U.park(false, 0L);
1753 >                    w.parker = null;
1754 >                    U.putObject(wt, PARKBLOCKER, null);
1755 >                }
1756 >            }
1757 >            if (h >= 0 || w.hint >= 0)           // signal others before retry
1758 >                helpSignalHint(w);
1759 >        }
1760 >        return null;
1761      }
1762  
1763      /**
1764 <     * Adds the given worker to event queue and blocks until
1765 <     * terminating or event count advances from the given value
1766 <     *
1767 <     * @param w the calling worker thread
1768 <     * @param ec the count
1769 <     */
1770 <    private void eventSync(ForkJoinWorkerThread w, int ec) {
1771 <        long nh = (((long)ec) << EVENT_COUNT_SHIFT) | ((long)(w.poolIndex+1));
1772 <        long h;
1773 <        while ((runState < SHUTDOWN || !tryTerminate(false)) &&
1774 <               (((int)((h = eventWaiters) & WAITER_ID_MASK)) == 0 ||
1775 <                (int)(h >>> EVENT_COUNT_SHIFT) == ec) &&
1776 <               eventCount == ec) {
1777 <            if (UNSAFE.compareAndSwapLong(this, eventWaitersOffset,
1778 <                                          w.nextWaiter = h, nh)) {
1779 <                awaitEvent(w, ec);
1780 <                break;
1764 >     * If inactivating worker w has caused the pool to become
1765 >     * quiescent, checks for pool termination, and, so long as this is
1766 >     * not the only worker, waits for event for up to a given
1767 >     * duration.  On timeout, if ctl has not changed, terminates the
1768 >     * worker, which will in turn wake up another worker to possibly
1769 >     * repeat this process.
1770 >     *
1771 >     * @param w the calling worker
1772 >     * @param currentCtl the ctl value triggering possible quiescence
1773 >     * @param prevCtl the ctl value to restore if thread is terminated
1774 >     */
1775 >    private void idleAwaitWork(WorkQueue w, long currentCtl, long prevCtl) {
1776 >        if (w != null && w.eventCount < 0 &&
1777 >            !tryTerminate(false, false) && (int)prevCtl != 0) {
1778 >            int dc = -(short)(currentCtl >>> TC_SHIFT);
1779 >            long parkTime = dc < 0 ? FAST_IDLE_TIMEOUT: (dc + 1) * IDLE_TIMEOUT;
1780 >            long deadline = System.nanoTime() + parkTime - TIMEOUT_SLOP;
1781 >            Thread wt = Thread.currentThread();
1782 >            while (ctl == currentCtl) {
1783 >                Thread.interrupted();  // timed variant of version in scan()
1784 >                U.putObject(wt, PARKBLOCKER, this);
1785 >                w.parker = wt;
1786 >                if (ctl == currentCtl)
1787 >                    U.park(false, parkTime);
1788 >                w.parker = null;
1789 >                U.putObject(wt, PARKBLOCKER, null);
1790 >                if (ctl != currentCtl)
1791 >                    break;
1792 >                if (deadline - System.nanoTime() <= 0L &&
1793 >                    U.compareAndSwapLong(this, CTL, currentCtl, prevCtl)) {
1794 >                    w.eventCount = (w.eventCount + E_SEQ) | E_MASK;
1795 >                    w.qlock = -1;   // shrink
1796 >                    break;
1797 >                }
1798              }
1799          }
1800      }
1801  
1802      /**
1803 <     * Blocks the given worker (that has already been entered as an
1804 <     * event waiter) until terminating or event count advances from
1805 <     * the given value. The oldest (first) waiter uses a timed wait to
1806 <     * occasionally one-by-one shrink the number of workers (to a
1807 <     * minimum of one) if the pool has not been used for extended
1808 <     * periods.
1809 <     *
1810 <     * @param w the calling worker thread
1811 <     * @param ec the count
1812 <     */
1813 <    private void awaitEvent(ForkJoinWorkerThread w, int ec) {
1814 <        while (eventCount == ec) {
1815 <            if (tryAccumulateStealCount(w)) { // transfer while idle
1816 <                boolean untimed = (w.nextWaiter != 0L ||
1817 <                                   (workerCounts & RUNNING_COUNT_MASK) <= 1);
1818 <                long startTime = untimed? 0 : System.nanoTime();
1819 <                Thread.interrupted();         // clear/ignore interrupt
1820 <                if (eventCount != ec || w.runState != 0 ||
1821 <                    runState >= TERMINATING)  // recheck after clear
791 <                    break;
792 <                if (untimed)
793 <                    LockSupport.park(w);
794 <                else {
795 <                    LockSupport.parkNanos(w, SHRINK_RATE_NANOS);
796 <                    if (eventCount != ec || w.runState != 0 ||
797 <                        runState >= TERMINATING)
1803 >     * Scans through queues looking for work while joining a task; if
1804 >     * any present, signals. May return early if more signalling is
1805 >     * detectably unneeded.
1806 >     *
1807 >     * @param task return early if done
1808 >     * @param origin an index to start scan
1809 >     */
1810 >    private void helpSignal(ForkJoinTask<?> task, int origin) {
1811 >        WorkQueue[] ws; WorkQueue w; Thread p; long c; int m, u, e, i, s;
1812 >        if (task != null && task.status >= 0 &&
1813 >            (u = (int)(ctl >>> 32)) < 0 && (u >> UAC_SHIFT) < 0 &&
1814 >            (ws = workQueues) != null && (m = ws.length - 1) >= 0) {
1815 >            outer: for (int k = origin, j = m; j >= 0; --j) {
1816 >                WorkQueue q = ws[k++ & m];
1817 >                for (int n = m;;) { // limit to at most m signals
1818 >                    if (task.status < 0)
1819 >                        break outer;
1820 >                    if (q == null ||
1821 >                        ((s = -q.base + q.top) <= n && (n = s) <= 0))
1822                          break;
1823 <                    if (System.nanoTime() - startTime >= SHRINK_RATE_NANOS)
1824 <                        tryShutdownUnusedWorker(ec);
1823 >                    if ((u = (int)((c = ctl) >>> 32)) >= 0 ||
1824 >                        (e = (int)c) <= 0 || m < (i = e & SMASK) ||
1825 >                        (w = ws[i]) == null)
1826 >                        break outer;
1827 >                    long nc = (((long)(w.nextWait & E_MASK)) |
1828 >                               ((long)(u + UAC_UNIT) << 32));
1829 >                    if (w.eventCount == (e | INT_SIGN) &&
1830 >                        U.compareAndSwapLong(this, CTL, c, nc)) {
1831 >                        w.eventCount = (e + E_SEQ) & E_MASK;
1832 >                        if ((p = w.parker) != null)
1833 >                            U.unpark(p);
1834 >                        if (--n <= 0)
1835 >                            break;
1836 >                    }
1837                  }
1838              }
1839          }
1840      }
1841  
806    // Maintaining parallelism
807
1842      /**
1843 <     * Pushes worker onto the spare stack.
1843 >     * Signals other workers if tasks are present in hinted queue.
1844 >     *
1845 >     * @param caller the worker with the hint
1846       */
1847 <    final void pushSpare(ForkJoinWorkerThread w) {
1848 <        int ns = (++w.spareCount << SPARE_COUNT_SHIFT) | (w.poolIndex + 1);
1849 <        do {} while (!UNSAFE.compareAndSwapInt(this, spareWaitersOffset,
1850 <                                               w.nextSpare = spareWaiters,ns));
1847 >    private void helpSignalHint(WorkQueue caller) {
1848 >        WorkQueue[] ws; WorkQueue q, w; Thread p; long c; int h, m, u, e, i, s;
1849 >        if (caller != null && (h = caller.hint) >= 0 &&
1850 >            (u = (int)(ctl >>> 32)) < 0 && (u >> UAC_SHIFT) < 0 &&
1851 >            (ws = workQueues) != null && (m = ws.length - 1) >= 0 &&
1852 >            (q = ws[h & m]) != null) {
1853 >            caller.hint = -1;
1854 >            for (int n = 2;;) { // limit to at most 2 signals
1855 >                int idleCount = (caller.eventCount < 0)? 0 : -1;
1856 >                if (((s = idleCount - q.base + q.top) <= n && (n = s) <= 0) ||
1857 >                    (u = (int)((c = ctl) >>> 32)) >= 0 ||
1858 >                    (e = (int)c) <= 0 || m < (i = e & SMASK) ||
1859 >                    (w = ws[i]) == null)
1860 >                    break;
1861 >                long nc = (((long)(w.nextWait & E_MASK)) |
1862 >                           ((long)(u + UAC_UNIT) << 32));
1863 >                if (w.eventCount == (e | INT_SIGN) &&
1864 >                    U.compareAndSwapLong(this, CTL, c, nc)) {
1865 >                    w.hint = h;
1866 >                    w.eventCount = (e + E_SEQ) & E_MASK;
1867 >                    if ((p = w.parker) != null)
1868 >                        U.unpark(p);
1869 >                    if (--n <= 0)
1870 >                        break;
1871 >                }
1872 >            }
1873 >        }
1874      }
1875  
1876      /**
1877 <     * Tries (once) to resume a spare if the number of running
1878 <     * threads is less than target.
1879 <     */
1880 <    private void tryResumeSpare() {
1881 <        int sw, id;
1882 <        ForkJoinWorkerThread[] ws = workers;
1883 <        int n = ws.length;
1884 <        ForkJoinWorkerThread w;
1885 <        if ((sw = spareWaiters) != 0 &&
1886 <            (id = (sw & SPARE_ID_MASK) - 1) >= 0 &&
1887 <            id < n && (w = ws[id]) != null &&
1888 <            (workerCounts & RUNNING_COUNT_MASK) < parallelism &&
1889 <            spareWaiters == sw &&
1890 <            UNSAFE.compareAndSwapInt(this, spareWaitersOffset,
1891 <                                     sw, w.nextSpare)) {
1892 <            int c; // increment running count before resume
1893 <            do {} while (!UNSAFE.compareAndSwapInt
1894 <                         (this, workerCountsOffset,
1895 <                          c = workerCounts, c + ONE_RUNNING));
1896 <            if (w.tryUnsuspend())
1897 <                LockSupport.unpark(w);
1898 <            else   // back out if w was shutdown
1899 <                decrementWorkerCounts(ONE_RUNNING, 0);
1877 >     * Tries to locate and execute tasks for a stealer of the given
1878 >     * task, or in turn one of its stealers, Traces currentSteal ->
1879 >     * currentJoin links looking for a thread working on a descendant
1880 >     * of the given task and with a non-empty queue to steal back and
1881 >     * execute tasks from. The first call to this method upon a
1882 >     * waiting join will often entail scanning/search, (which is OK
1883 >     * because the joiner has nothing better to do), but this method
1884 >     * leaves hints in workers to speed up subsequent calls. The
1885 >     * implementation is very branchy to cope with potential
1886 >     * inconsistencies or loops encountering chains that are stale,
1887 >     * unknown, or so long that they are likely cyclic.
1888 >     *
1889 >     * @param joiner the joining worker
1890 >     * @param task the task to join
1891 >     * @return 0 if no progress can be made, negative if task
1892 >     * known complete, else positive
1893 >     */
1894 >    private int tryHelpStealer(WorkQueue joiner, ForkJoinTask<?> task) {
1895 >        int stat = 0, steps = 0;                    // bound to avoid cycles
1896 >        if (joiner != null && task != null) {       // hoist null checks
1897 >            restart: for (;;) {
1898 >                ForkJoinTask<?> subtask = task;     // current target
1899 >                for (WorkQueue j = joiner, v;;) {   // v is stealer of subtask
1900 >                    WorkQueue[] ws; int m, s, h;
1901 >                    if ((s = task.status) < 0) {
1902 >                        stat = s;
1903 >                        break restart;
1904 >                    }
1905 >                    if ((ws = workQueues) == null || (m = ws.length - 1) <= 0)
1906 >                        break restart;              // shutting down
1907 >                    if ((v = ws[h = (j.hint | 1) & m]) == null ||
1908 >                        v.currentSteal != subtask) {
1909 >                        for (int origin = h;;) {    // find stealer
1910 >                            if (((h = (h + 2) & m) & 15) == 1 &&
1911 >                                (subtask.status < 0 || j.currentJoin != subtask))
1912 >                                continue restart;   // occasional staleness check
1913 >                            if ((v = ws[h]) != null &&
1914 >                                v.currentSteal == subtask) {
1915 >                                j.hint = h;        // save hint
1916 >                                break;
1917 >                            }
1918 >                            if (h == origin)
1919 >                                break restart;      // cannot find stealer
1920 >                        }
1921 >                    }
1922 >                    for (;;) { // help stealer or descend to its stealer
1923 >                        ForkJoinTask[] a;  int b;
1924 >                        if (subtask.status < 0)     // surround probes with
1925 >                            continue restart;       //   consistency checks
1926 >                        if ((b = v.base) - v.top < 0 && (a = v.array) != null) {
1927 >                            int i = (((a.length - 1) & b) << ASHIFT) + ABASE;
1928 >                            ForkJoinTask<?> t =
1929 >                                (ForkJoinTask<?>)U.getObjectVolatile(a, i);
1930 >                            if (subtask.status < 0 || j.currentJoin != subtask ||
1931 >                                v.currentSteal != subtask)
1932 >                                continue restart;   // stale
1933 >                            stat = 1;               // apparent progress
1934 >                            if (t != null && v.base == b &&
1935 >                                U.compareAndSwapObject(a, i, t, null)) {
1936 >                                v.base = b + 1;     // help stealer
1937 >                                joiner.runSubtask(t);
1938 >                            }
1939 >                            else if (v.base == b && ++steps == MAX_HELP)
1940 >                                break restart;      // v apparently stalled
1941 >                        }
1942 >                        else {                      // empty -- try to descend
1943 >                            ForkJoinTask<?> next = v.currentJoin;
1944 >                            if (subtask.status < 0 || j.currentJoin != subtask ||
1945 >                                v.currentSteal != subtask)
1946 >                                continue restart;   // stale
1947 >                            else if (next == null || ++steps == MAX_HELP)
1948 >                                break restart;      // dead-end or maybe cyclic
1949 >                            else {
1950 >                                subtask = next;
1951 >                                j = v;
1952 >                                break;
1953 >                            }
1954 >                        }
1955 >                    }
1956 >                }
1957 >            }
1958          }
1959 +        return stat;
1960      }
1961  
1962      /**
1963 <     * Tries to increase the number of running workers if below target
1964 <     * parallelism: If a spare exists tries to resume it via
1965 <     * tryResumeSpare.  Otherwise, if not enough total workers or all
1966 <     * existing workers are busy, adds a new worker. In all cases also
1967 <     * helps wake up releasable workers waiting for work.
1963 >     * Analog of tryHelpStealer for CountedCompleters. Tries to steal
1964 >     * and run tasks within the target's computation.
1965 >     *
1966 >     * @param task the task to join
1967 >     * @param mode if shared, exit upon completing any task
1968 >     * if all workers are active
1969 >     *
1970       */
1971 <    private void helpMaintainParallelism() {
1972 <        int pc = parallelism;
1973 <        int wc, rs, tc;
1974 <        while (((wc = workerCounts) & RUNNING_COUNT_MASK) < pc &&
1975 <               (rs = runState) < TERMINATING) {
1976 <            if (spareWaiters != 0)
1977 <                tryResumeSpare();
1978 <            else if ((tc = wc >>> TOTAL_COUNT_SHIFT) >= MAX_WORKERS ||
1979 <                     (tc >= pc && (rs & ACTIVE_COUNT_MASK) != tc))
1980 <                break;   // enough total
1981 <            else if (runState == rs && workerCounts == wc &&
1982 <                     UNSAFE.compareAndSwapInt(this, workerCountsOffset, wc,
863 <                                              wc + (ONE_RUNNING|ONE_TOTAL))) {
864 <                ForkJoinWorkerThread w = null;
865 <                try {
866 <                    w = factory.newThread(this);
867 <                } finally { // adjust on null or exceptional factory return
868 <                    if (w == null) {
869 <                        decrementWorkerCounts(ONE_RUNNING, ONE_TOTAL);
870 <                        tryTerminate(false); // handle failure during shutdown
871 <                    }
1971 >    private int helpComplete(ForkJoinTask<?> task, int mode) {
1972 >        WorkQueue[] ws; WorkQueue q; int m, n, s, u;
1973 >        if (task != null && (ws = workQueues) != null &&
1974 >            (m = ws.length - 1) >= 0) {
1975 >            for (int j = 1, origin = j;;) {
1976 >                if ((s = task.status) < 0)
1977 >                    return s;
1978 >                if ((q = ws[j & m]) != null && q.pollAndExecCC(task)) {
1979 >                    origin = j;
1980 >                    if (mode == SHARED_QUEUE &&
1981 >                        ((u = (int)(ctl >>> 32)) >= 0 || (u >> UAC_SHIFT) >= 0))
1982 >                        break;
1983                  }
1984 <                if (w == null)
874 <                    break;
875 <                w.start(recordWorker(w), ueh);
876 <                if ((workerCounts >>> TOTAL_COUNT_SHIFT) >= pc) {
877 <                    int c; // advance event count
878 <                    UNSAFE.compareAndSwapInt(this, eventCountOffset,
879 <                                             c = eventCount, c+1);
880 <                    break; // add at most one unless total below target
881 <                }
882 <            }
883 <        }
884 <        if (eventWaiters != 0L)
885 <            releaseEventWaiters();
886 <    }
887 <
888 <    /**
889 <     * Callback from the oldest waiter in awaitEvent waking up after a
890 <     * period of non-use. If all workers are idle, tries (once) to
891 <     * shutdown an event waiter or a spare, if one exists. Note that
892 <     * we don't need CAS or locks here because the method is called
893 <     * only from one thread occasionally waking (and even misfires are
894 <     * OK). Note that until the shutdown worker fully terminates,
895 <     * workerCounts will overestimate total count, which is tolerable.
896 <     *
897 <     * @param ec the event count waited on by caller (to abort
898 <     * attempt if count has since changed).
899 <     */
900 <    private void tryShutdownUnusedWorker(int ec) {
901 <        if (runState == 0 && eventCount == ec) { // only trigger if all idle
902 <            ForkJoinWorkerThread[] ws = workers;
903 <            int n = ws.length;
904 <            ForkJoinWorkerThread w = null;
905 <            boolean shutdown = false;
906 <            int sw;
907 <            long h;
908 <            if ((sw = spareWaiters) != 0) { // prefer killing spares
909 <                int id = (sw & SPARE_ID_MASK) - 1;
910 <                if (id >= 0 && id < n && (w = ws[id]) != null &&
911 <                    UNSAFE.compareAndSwapInt(this, spareWaitersOffset,
912 <                                             sw, w.nextSpare))
913 <                    shutdown = true;
914 <            }
915 <            else if ((h = eventWaiters) != 0L) {
916 <                long nh;
917 <                int id = ((int)(h & WAITER_ID_MASK)) - 1;
918 <                if (id >= 0 && id < n && (w = ws[id]) != null &&
919 <                    (nh = w.nextWaiter) != 0L && // keep at least one worker
920 <                    UNSAFE.compareAndSwapLong(this, eventWaitersOffset, h, nh))
921 <                    shutdown = true;
922 <            }
923 <            if (w != null && shutdown) {
924 <                w.shutdown();
925 <                LockSupport.unpark(w);
926 <            }
927 <        }
928 <        releaseEventWaiters(); // in case of interference
929 <    }
930 <
931 <    /**
932 <     * Callback from workers invoked upon each top-level action (i.e.,
933 <     * stealing a task or taking a submission and running it).
934 <     * Performs one or more of the following:
935 <     *
936 <     * 1. If the worker is active and either did not run a task
937 <     *    or there are too many workers, try to set its active status
938 <     *    to inactive and update activeCount. On contention, we may
939 <     *    try again in this or a subsequent call.
940 <     *
941 <     * 2. If not enough total workers, help create some.
942 <     *
943 <     * 3. If there are too many running workers, suspend this worker
944 <     *    (first forcing inactive if necessary).  If it is not needed,
945 <     *    it may be shutdown while suspended (via
946 <     *    tryShutdownUnusedWorker).  Otherwise, upon resume it
947 <     *    rechecks running thread count and need for event sync.
948 <     *
949 <     * 4. If worker did not run a task, await the next task event via
950 <     *    eventSync if necessary (first forcing inactivation), upon
951 <     *    which the worker may be shutdown via
952 <     *    tryShutdownUnusedWorker.  Otherwise, help release any
953 <     *    existing event waiters that are now releasable,
954 <     *
955 <     * @param w the worker
956 <     * @param ran true if worker ran a task since last call to this method
957 <     */
958 <    final void preStep(ForkJoinWorkerThread w, boolean ran) {
959 <        int wec = w.lastEventCount;
960 <        boolean active = w.active;
961 <        boolean inactivate = false;
962 <        int pc = parallelism;
963 <        int rs;
964 <        while (w.runState == 0 && (rs = runState) < TERMINATING) {
965 <            if ((inactivate || (active && (rs & ACTIVE_COUNT_MASK) >= pc)) &&
966 <                UNSAFE.compareAndSwapInt(this, runStateOffset, rs, rs - 1))
967 <                inactivate = active = w.active = false;
968 <            int wc = workerCounts;
969 <            if ((wc & RUNNING_COUNT_MASK) > pc) {
970 <                if (!(inactivate |= active) && // must inactivate to suspend
971 <                    workerCounts == wc &&      // try to suspend as spare
972 <                    UNSAFE.compareAndSwapInt(this, workerCountsOffset,
973 <                                             wc, wc - ONE_RUNNING))
974 <                    w.suspendAsSpare();
975 <            }
976 <            else if ((wc >>> TOTAL_COUNT_SHIFT) < pc)
977 <                helpMaintainParallelism();     // not enough workers
978 <            else if (!ran) {
979 <                long h = eventWaiters;
980 <                int ec = eventCount;
981 <                if (h != 0L && (int)(h >>> EVENT_COUNT_SHIFT) != ec)
982 <                    releaseEventWaiters();     // release others before waiting
983 <                else if (ec != wec) {
984 <                    w.lastEventCount = ec;     // no need to wait
1984 >                else if ((j = (j + 2) & m) == origin)
1985                      break;
986                }
987                else if (!(inactivate |= active))
988                    eventSync(w, wec);         // must inactivate before sync
1986              }
990            else
991                break;
1987          }
1988 +        return 0;
1989      }
1990  
1991      /**
1992 <     * Helps and/or blocks awaiting join of the given task.
1993 <     * See above for explanation.
1994 <     *
1995 <     * @param joinMe the task to join
1996 <     * @param worker the current worker thread
1997 <     */
1998 <    final void awaitJoin(ForkJoinTask<?> joinMe, ForkJoinWorkerThread worker) {
1999 <        int retries = 2 + (parallelism >> 2); // #helpJoins before blocking
2000 <        while (joinMe.status >= 0) {
2001 <            int wc;
2002 <            worker.helpJoinTask(joinMe);
2003 <            if (joinMe.status < 0)
2004 <                break;
2005 <            else if (retries > 0)
2006 <                --retries;
2007 <            else if (((wc = workerCounts) & RUNNING_COUNT_MASK) != 0 &&
2008 <                     UNSAFE.compareAndSwapInt(this, workerCountsOffset,
2009 <                                              wc, wc - ONE_RUNNING)) {
2010 <                int stat, c; long h;
2011 <                while ((stat = joinMe.status) >= 0 &&
2012 <                       (h = eventWaiters) != 0L && // help release others
2013 <                       (int)(h >>> EVENT_COUNT_SHIFT) != eventCount)
2014 <                    releaseEventWaiters();
2015 <                if (stat >= 0 &&
2016 <                    ((workerCounts & RUNNING_COUNT_MASK) == 0 ||
2017 <                     (stat =
2018 <                      joinMe.internalAwaitDone(JOIN_TIMEOUT_MILLIS)) >= 0))
2019 <                    helpMaintainParallelism(); // timeout or no running workers
2020 <                do {} while (!UNSAFE.compareAndSwapInt
2021 <                             (this, workerCountsOffset,
2022 <                              c = workerCounts, c + ONE_RUNNING));
2023 <                if (stat < 0)
2024 <                    break;   // else restart
1992 >     * Tries to decrement active count (sometimes implicitly) and
1993 >     * possibly release or create a compensating worker in preparation
1994 >     * for blocking. Fails on contention or termination. Otherwise,
1995 >     * adds a new thread if no idle workers are available and pool
1996 >     * may become starved.
1997 >     */
1998 >    final boolean tryCompensate() {
1999 >        int pc = config & SMASK, e, i, tc; long c;
2000 >        WorkQueue[] ws; WorkQueue w; Thread p;
2001 >        if ((ws = workQueues) != null && (e = (int)(c = ctl)) >= 0) {
2002 >            if (e != 0 && (i = e & SMASK) < ws.length &&
2003 >                (w = ws[i]) != null && w.eventCount == (e | INT_SIGN)) {
2004 >                long nc = ((long)(w.nextWait & E_MASK) |
2005 >                           (c & (AC_MASK|TC_MASK)));
2006 >                if (U.compareAndSwapLong(this, CTL, c, nc)) {
2007 >                    w.eventCount = (e + E_SEQ) & E_MASK;
2008 >                    if ((p = w.parker) != null)
2009 >                        U.unpark(p);
2010 >                    return true;   // replace with idle worker
2011 >                }
2012 >            }
2013 >            else if ((tc = (short)(c >>> TC_SHIFT)) >= 0 &&
2014 >                     (int)(c >> AC_SHIFT) + pc > 1) {
2015 >                long nc = ((c - AC_UNIT) & AC_MASK) | (c & ~AC_MASK);
2016 >                if (U.compareAndSwapLong(this, CTL, c, nc))
2017 >                    return true;   // no compensation
2018 >            }
2019 >            else if (tc + pc < MAX_CAP) {
2020 >                long nc = ((c + TC_UNIT) & TC_MASK) | (c & ~TC_MASK);
2021 >                if (U.compareAndSwapLong(this, CTL, c, nc)) {
2022 >                    ForkJoinWorkerThreadFactory fac;
2023 >                    Throwable ex = null;
2024 >                    ForkJoinWorkerThread wt = null;
2025 >                    try {
2026 >                        if ((fac = factory) != null &&
2027 >                            (wt = fac.newThread(this)) != null) {
2028 >                            wt.start();
2029 >                            return true;
2030 >                        }
2031 >                    } catch (Throwable rex) {
2032 >                        ex = rex;
2033 >                    }
2034 >                    deregisterWorker(wt, ex); // clean up and return false
2035 >                }
2036              }
2037          }
2038 +        return false;
2039      }
2040  
2041      /**
2042 <     * Same idea as awaitJoin, but no helping, retries, or timeouts.
2042 >     * Helps and/or blocks until the given task is done.
2043 >     *
2044 >     * @param joiner the joining worker
2045 >     * @param task the task
2046 >     * @return task status on exit
2047       */
2048 <    final void awaitBlocker(ManagedBlocker blocker)
2049 <        throws InterruptedException {
2050 <        while (!blocker.isReleasable()) {
2051 <            int wc = workerCounts;
2052 <            if ((wc & RUNNING_COUNT_MASK) != 0 &&
2053 <                UNSAFE.compareAndSwapInt(this, workerCountsOffset,
2054 <                                         wc, wc - ONE_RUNNING)) {
2055 <                try {
2056 <                    while (!blocker.isReleasable()) {
2057 <                        long h = eventWaiters;
2058 <                        if (h != 0L &&
2059 <                            (int)(h >>> EVENT_COUNT_SHIFT) != eventCount)
2060 <                            releaseEventWaiters();
2061 <                        else if ((workerCounts & RUNNING_COUNT_MASK) == 0 &&
2062 <                                 runState < TERMINATING)
2063 <                            helpMaintainParallelism();
2064 <                        else if (blocker.block())
2065 <                            break;
2048 >    final int awaitJoin(WorkQueue joiner, ForkJoinTask<?> task) {
2049 >        int s = 0;
2050 >        if (joiner != null && task != null && (s = task.status) >= 0) {
2051 >            ForkJoinTask<?> prevJoin = joiner.currentJoin;
2052 >            joiner.currentJoin = task;
2053 >            do {} while ((s = task.status) >= 0 && !joiner.isEmpty() &&
2054 >                         joiner.tryRemoveAndExec(task)); // process local tasks
2055 >            if (s >= 0 && (s = task.status) >= 0) {
2056 >                helpSignal(task, joiner.poolIndex);
2057 >                if ((s = task.status) >= 0 &&
2058 >                    (task instanceof CountedCompleter))
2059 >                    s = helpComplete(task, LIFO_QUEUE);
2060 >            }
2061 >            while (s >= 0 && (s = task.status) >= 0) {
2062 >                if ((!joiner.isEmpty() ||           // try helping
2063 >                     (s = tryHelpStealer(joiner, task)) == 0) &&
2064 >                    (s = task.status) >= 0) {
2065 >                    helpSignal(task, joiner.poolIndex);
2066 >                    if ((s = task.status) >= 0 && tryCompensate()) {
2067 >                        if (task.trySetSignal() && (s = task.status) >= 0) {
2068 >                            synchronized (task) {
2069 >                                if (task.status >= 0) {
2070 >                                    try {                // see ForkJoinTask
2071 >                                        task.wait();     //  for explanation
2072 >                                    } catch (InterruptedException ie) {
2073 >                                    }
2074 >                                }
2075 >                                else
2076 >                                    task.notifyAll();
2077 >                            }
2078 >                        }
2079 >                        long c;                          // re-activate
2080 >                        do {} while (!U.compareAndSwapLong
2081 >                                     (this, CTL, c = ctl, c + AC_UNIT));
2082                      }
1055                } finally {
1056                    int c;
1057                    do {} while (!UNSAFE.compareAndSwapInt
1058                                 (this, workerCountsOffset,
1059                                  c = workerCounts, c + ONE_RUNNING));
2083                  }
1061                break;
2084              }
2085 +            joiner.currentJoin = prevJoin;
2086          }
2087 +        return s;
2088      }
2089  
2090      /**
2091 <     * Possibly initiates and/or completes termination.
2091 >     * Stripped-down variant of awaitJoin used by timed joins. Tries
2092 >     * to help join only while there is continuous progress. (Caller
2093 >     * will then enter a timed wait.)
2094       *
2095 <     * @param now if true, unconditionally terminate, else only
2096 <     * if shutdown and empty queue and no active workers
1071 <     * @return true if now terminating or terminated
2095 >     * @param joiner the joining worker
2096 >     * @param task the task
2097       */
2098 <    private boolean tryTerminate(boolean now) {
2099 <        if (now)
2100 <            advanceRunLevel(SHUTDOWN); // ensure at least SHUTDOWN
2101 <        else if (runState < SHUTDOWN ||
2102 <                 !submissionQueue.isEmpty() ||
2103 <                 (runState & ACTIVE_COUNT_MASK) != 0)
2104 <            return false;
2098 >    final void helpJoinOnce(WorkQueue joiner, ForkJoinTask<?> task) {
2099 >        int s;
2100 >        if (joiner != null && task != null && (s = task.status) >= 0) {
2101 >            ForkJoinTask<?> prevJoin = joiner.currentJoin;
2102 >            joiner.currentJoin = task;
2103 >            do {} while ((s = task.status) >= 0 && !joiner.isEmpty() &&
2104 >                         joiner.tryRemoveAndExec(task));
2105 >            if (s >= 0 && (s = task.status) >= 0) {
2106 >                helpSignal(task, joiner.poolIndex);
2107 >                if ((s = task.status) >= 0 &&
2108 >                    (task instanceof CountedCompleter))
2109 >                    s = helpComplete(task, LIFO_QUEUE);
2110 >            }
2111 >            if (s >= 0 && joiner.isEmpty()) {
2112 >                do {} while (task.status >= 0 &&
2113 >                             tryHelpStealer(joiner, task) > 0);
2114 >            }
2115 >            joiner.currentJoin = prevJoin;
2116 >        }
2117 >    }
2118  
2119 <        if (advanceRunLevel(TERMINATING))
2120 <            startTerminating();
2119 >    /**
2120 >     * Returns a (probably) non-empty steal queue, if one is found
2121 >     * during a random, then cyclic scan, else null.  This method must
2122 >     * be retried by caller if, by the time it tries to use the queue,
2123 >     * it is empty.
2124 >     * @param r a (random) seed for scanning
2125 >     */
2126 >    private WorkQueue findNonEmptyStealQueue(int r) {
2127 >        for (WorkQueue[] ws;;) {
2128 >            int ps = plock, m, n;
2129 >            if ((ws = workQueues) == null || (m = ws.length - 1) < 1)
2130 >                return null;
2131 >            for (int j = (m + 1) << 2; ;) {
2132 >                WorkQueue q = ws[(((r + j) << 1) | 1) & m];
2133 >                if (q != null && (n = q.base - q.top) < 0) {
2134 >                    if (n < -1)
2135 >                        signalWork(q);
2136 >                    return q;
2137 >                }
2138 >                else if (--j < 0) {
2139 >                    if (plock == ps)
2140 >                        return null;
2141 >                    break;
2142 >                }
2143 >            }
2144 >        }
2145 >    }
2146  
2147 <        // Finish now if all threads terminated; else in some subsequent call
2148 <        if ((workerCounts >>> TOTAL_COUNT_SHIFT) == 0) {
2149 <            advanceRunLevel(TERMINATED);
2150 <            termination.arrive();
2151 <        }
2152 <        return true;
2147 >    /**
2148 >     * Runs tasks until {@code isQuiescent()}. We piggyback on
2149 >     * active count ctl maintenance, but rather than blocking
2150 >     * when tasks cannot be found, we rescan until all others cannot
2151 >     * find tasks either.
2152 >     */
2153 >    final void helpQuiescePool(WorkQueue w) {
2154 >        for (boolean active = true;;) {
2155 >            ForkJoinTask<?> localTask; // exhaust local queue
2156 >            while ((localTask = w.nextLocalTask()) != null)
2157 >                localTask.doExec();
2158 >            // Similar to loop in scan(), but ignoring submissions
2159 >            WorkQueue q = findNonEmptyStealQueue(w.nextSeed());
2160 >            if (q != null) {
2161 >                ForkJoinTask<?> t; int b;
2162 >                if (!active) {      // re-establish active count
2163 >                    long c;
2164 >                    active = true;
2165 >                    do {} while (!U.compareAndSwapLong
2166 >                                 (this, CTL, c = ctl, c + AC_UNIT));
2167 >                }
2168 >                if ((b = q.base) - q.top < 0 && (t = q.pollAt(b)) != null)
2169 >                    w.runSubtask(t);
2170 >            }
2171 >            else {
2172 >                long c;
2173 >                if (active) {       // decrement active count without queuing
2174 >                    active = false;
2175 >                    do {} while (!U.compareAndSwapLong
2176 >                                 (this, CTL, c = ctl, c -= AC_UNIT));
2177 >                }
2178 >                else
2179 >                    c = ctl;        // re-increment on exit
2180 >                if ((int)(c >> AC_SHIFT) + (config & SMASK) == 0) {
2181 >                    do {} while (!U.compareAndSwapLong
2182 >                                 (this, CTL, c = ctl, c + AC_UNIT));
2183 >                    break;
2184 >                }
2185 >            }
2186 >        }
2187      }
2188  
2189      /**
2190 <     * Actions on transition to TERMINATING
2191 <     *
2192 <     * Runs up to four passes through workers: (0) shutting down each
2193 <     * (without waking up if parked) to quickly spread notifications
2194 <     * without unnecessary bouncing around event queues etc (1) wake
2195 <     * up and help cancel tasks (2) interrupt (3) mop up races with
2196 <     * interrupted workers
2197 <     */
2198 <    private void startTerminating() {
2199 <        cancelSubmissions();
2200 <        for (int passes = 0; passes < 4 && workerCounts != 0; ++passes) {
2201 <            int c; // advance event count
2202 <            UNSAFE.compareAndSwapInt(this, eventCountOffset,
2203 <                                     c = eventCount, c+1);
2204 <            eventWaiters = 0L; // clobber lists
2205 <            spareWaiters = 0;
2206 <            for (ForkJoinWorkerThread w : workers) {
2207 <                if (w != null) {
2208 <                    w.shutdown();
2209 <                    if (passes > 0 && !w.isTerminated()) {
2210 <                        w.cancelTasks();
2211 <                        LockSupport.unpark(w);
2212 <                        if (passes > 1) {
2213 <                            try {
2214 <                                w.interrupt();
2215 <                            } catch (SecurityException ignore) {
2190 >     * Gets and removes a local or stolen task for the given worker.
2191 >     *
2192 >     * @return a task, if available
2193 >     */
2194 >    final ForkJoinTask<?> nextTaskFor(WorkQueue w) {
2195 >        for (ForkJoinTask<?> t;;) {
2196 >            WorkQueue q; int b;
2197 >            if ((t = w.nextLocalTask()) != null)
2198 >                return t;
2199 >            if ((q = findNonEmptyStealQueue(w.nextSeed())) == null)
2200 >                return null;
2201 >            if ((b = q.base) - q.top < 0 && (t = q.pollAt(b)) != null)
2202 >                return t;
2203 >        }
2204 >    }
2205 >
2206 >    /**
2207 >     * Returns a cheap heuristic guide for task partitioning when
2208 >     * programmers, frameworks, tools, or languages have little or no
2209 >     * idea about task granularity.  In essence by offering this
2210 >     * method, we ask users only about tradeoffs in overhead vs
2211 >     * expected throughput and its variance, rather than how finely to
2212 >     * partition tasks.
2213 >     *
2214 >     * In a steady state strict (tree-structured) computation, each
2215 >     * thread makes available for stealing enough tasks for other
2216 >     * threads to remain active. Inductively, if all threads play by
2217 >     * the same rules, each thread should make available only a
2218 >     * constant number of tasks.
2219 >     *
2220 >     * The minimum useful constant is just 1. But using a value of 1
2221 >     * would require immediate replenishment upon each steal to
2222 >     * maintain enough tasks, which is infeasible.  Further,
2223 >     * partitionings/granularities of offered tasks should minimize
2224 >     * steal rates, which in general means that threads nearer the top
2225 >     * of computation tree should generate more than those nearer the
2226 >     * bottom. In perfect steady state, each thread is at
2227 >     * approximately the same level of computation tree. However,
2228 >     * producing extra tasks amortizes the uncertainty of progress and
2229 >     * diffusion assumptions.
2230 >     *
2231 >     * So, users will want to use values larger, but not much larger
2232 >     * than 1 to both smooth over transient shortages and hedge
2233 >     * against uneven progress; as traded off against the cost of
2234 >     * extra task overhead. We leave the user to pick a threshold
2235 >     * value to compare with the results of this call to guide
2236 >     * decisions, but recommend values such as 3.
2237 >     *
2238 >     * When all threads are active, it is on average OK to estimate
2239 >     * surplus strictly locally. In steady-state, if one thread is
2240 >     * maintaining say 2 surplus tasks, then so are others. So we can
2241 >     * just use estimated queue length.  However, this strategy alone
2242 >     * leads to serious mis-estimates in some non-steady-state
2243 >     * conditions (ramp-up, ramp-down, other stalls). We can detect
2244 >     * many of these by further considering the number of "idle"
2245 >     * threads, that are known to have zero queued tasks, so
2246 >     * compensate by a factor of (#idle/#active) threads.
2247 >     *
2248 >     * Note: The approximation of #busy workers as #active workers is
2249 >     * not very good under current signalling scheme, and should be
2250 >     * improved.
2251 >     */
2252 >    static int getSurplusQueuedTaskCount() {
2253 >        Thread t; ForkJoinWorkerThread wt; ForkJoinPool pool; WorkQueue q;
2254 >        if (((t = Thread.currentThread()) instanceof ForkJoinWorkerThread)) {
2255 >            int p = (pool = (wt = (ForkJoinWorkerThread)t).pool).config & SMASK;
2256 >            int n = (q = wt.workQueue).top - q.base;
2257 >            int a = (int)(pool.ctl >> AC_SHIFT) + p;
2258 >            return n - (a > (p >>>= 1) ? 0 :
2259 >                        a > (p >>>= 1) ? 1 :
2260 >                        a > (p >>>= 1) ? 2 :
2261 >                        a > (p >>>= 1) ? 4 :
2262 >                        8);
2263 >        }
2264 >        return 0;
2265 >    }
2266 >
2267 >    //  Termination
2268 >
2269 >    /**
2270 >     * Possibly initiates and/or completes termination.  The caller
2271 >     * triggering termination runs three passes through workQueues:
2272 >     * (0) Setting termination status, followed by wakeups of queued
2273 >     * workers; (1) cancelling all tasks; (2) interrupting lagging
2274 >     * threads (likely in external tasks, but possibly also blocked in
2275 >     * joins).  Each pass repeats previous steps because of potential
2276 >     * lagging thread creation.
2277 >     *
2278 >     * @param now if true, unconditionally terminate, else only
2279 >     * if no work and no active workers
2280 >     * @param enable if true, enable shutdown when next possible
2281 >     * @return true if now terminating or terminated
2282 >     */
2283 >    private boolean tryTerminate(boolean now, boolean enable) {
2284 >        if (this == commonPool)                     // cannot shut down
2285 >            return false;
2286 >        for (long c;;) {
2287 >            if (((c = ctl) & STOP_BIT) != 0) {      // already terminating
2288 >                if ((short)(c >>> TC_SHIFT) == -(config & SMASK)) {
2289 >                    synchronized (this) {
2290 >                        notifyAll();                // signal when 0 workers
2291 >                    }
2292 >                }
2293 >                return true;
2294 >            }
2295 >            if (plock >= 0) {                       // not yet enabled
2296 >                int ps;
2297 >                if (!enable)
2298 >                    return false;
2299 >                if (((ps = plock) & PL_LOCK) != 0 ||
2300 >                    !U.compareAndSwapInt(this, PLOCK, ps, ps += PL_LOCK))
2301 >                    ps = acquirePlock();
2302 >                int nps = SHUTDOWN;
2303 >                if (!U.compareAndSwapInt(this, PLOCK, ps, nps))
2304 >                    releasePlock(nps);
2305 >            }
2306 >            if (!now) {                             // check if idle & no tasks
2307 >                if ((int)(c >> AC_SHIFT) != -(config & SMASK) ||
2308 >                    hasQueuedSubmissions())
2309 >                    return false;
2310 >                // Check for unqueued inactive workers. One pass suffices.
2311 >                WorkQueue[] ws = workQueues; WorkQueue w;
2312 >                if (ws != null) {
2313 >                    for (int i = 1; i < ws.length; i += 2) {
2314 >                        if ((w = ws[i]) != null && w.eventCount >= 0)
2315 >                            return false;
2316 >                    }
2317 >                }
2318 >            }
2319 >            if (U.compareAndSwapLong(this, CTL, c, c | STOP_BIT)) {
2320 >                for (int pass = 0; pass < 3; ++pass) {
2321 >                    WorkQueue[] ws = workQueues;
2322 >                    if (ws != null) {
2323 >                        WorkQueue w;
2324 >                        int n = ws.length;
2325 >                        for (int i = 0; i < n; ++i) {
2326 >                            if ((w = ws[i]) != null) {
2327 >                                w.qlock = -1;
2328 >                                if (pass > 0) {
2329 >                                    w.cancelAll();
2330 >                                    if (pass > 1)
2331 >                                        w.interruptOwner();
2332 >                                }
2333 >                            }
2334 >                        }
2335 >                        // Wake up workers parked on event queue
2336 >                        int i, e; long cc; Thread p;
2337 >                        while ((e = (int)(cc = ctl) & E_MASK) != 0 &&
2338 >                               (i = e & SMASK) < n &&
2339 >                               (w = ws[i]) != null) {
2340 >                            long nc = ((long)(w.nextWait & E_MASK) |
2341 >                                       ((cc + AC_UNIT) & AC_MASK) |
2342 >                                       (cc & (TC_MASK|STOP_BIT)));
2343 >                            if (w.eventCount == (e | INT_SIGN) &&
2344 >                                U.compareAndSwapLong(this, CTL, cc, nc)) {
2345 >                                w.eventCount = (e + E_SEQ) & E_MASK;
2346 >                                w.qlock = -1;
2347 >                                if ((p = w.parker) != null)
2348 >                                    U.unpark(p);
2349                              }
2350                          }
2351                      }
# Line 1124 | Line 2354 | public class ForkJoinPool extends Abstra
2354          }
2355      }
2356  
2357 +    // external operations on common pool
2358 +
2359      /**
2360 <     * Clears out and cancels submissions, ignoring exceptions.
2360 >     * Returns common pool queue for a thread that has submitted at
2361 >     * least one task.
2362       */
2363 <    private void cancelSubmissions() {
2364 <        ForkJoinTask<?> task;
2365 <        while ((task = submissionQueue.poll()) != null) {
2366 <            try {
2367 <                task.cancel(false);
2368 <            } catch (Throwable ignore) {
2363 >    static WorkQueue commonSubmitterQueue() {
2364 >        ForkJoinPool p; WorkQueue[] ws; int m; Submitter z;
2365 >        return ((z = submitters.get()) != null &&
2366 >                (p = commonPool) != null &&
2367 >                (ws = p.workQueues) != null &&
2368 >                (m = ws.length - 1) >= 0) ?
2369 >            ws[m & z.seed & SQMASK] : null;
2370 >    }
2371 >
2372 >    /**
2373 >     * Tries to pop the given task from submitter's queue in common pool.
2374 >     */
2375 >    static boolean tryExternalUnpush(ForkJoinTask<?> t) {
2376 >        ForkJoinPool p; WorkQueue[] ws; WorkQueue q; Submitter z;
2377 >        ForkJoinTask<?>[] a;  int m, s;
2378 >        if (t != null &&
2379 >            (z = submitters.get()) != null &&
2380 >            (p = commonPool) != null &&
2381 >            (ws = p.workQueues) != null &&
2382 >            (m = ws.length - 1) >= 0 &&
2383 >            (q = ws[m & z.seed & SQMASK]) != null &&
2384 >            (s = q.top) != q.base &&
2385 >            (a = q.array) != null) {
2386 >            long j = (((a.length - 1) & (s - 1)) << ASHIFT) + ABASE;
2387 >            if (U.getObject(a, j) == t &&
2388 >                U.compareAndSwapInt(q, QLOCK, 0, 1)) {
2389 >                if (q.array == a && q.top == s && // recheck
2390 >                    U.compareAndSwapObject(a, j, t, null)) {
2391 >                    q.top = s - 1;
2392 >                    q.qlock = 0;
2393 >                    return true;
2394 >                }
2395 >                q.qlock = 0;
2396              }
2397          }
2398 +        return false;
2399      }
2400  
1140    // misc support for ForkJoinWorkerThread
1141
2401      /**
2402 <     * Returns pool number.
2403 <     */
2404 <    final int getPoolNumber() {
2405 <        return poolNumber;
2402 >     * Tries to pop and run local tasks within the same computation
2403 >     * as the given root. On failure, tries to help complete from
2404 >     * other queues via helpComplete.
2405 >     */
2406 >    private void externalHelpComplete(WorkQueue q, ForkJoinTask<?> root) {
2407 >        ForkJoinTask<?>[] a; int m;
2408 >        if (q != null && (a = q.array) != null && (m = (a.length - 1)) >= 0 &&
2409 >            root != null && root.status >= 0) {
2410 >            for (;;) {
2411 >                int s, u; Object o; CountedCompleter<?> task = null;
2412 >                if ((s = q.top) - q.base > 0) {
2413 >                    long j = ((m & (s - 1)) << ASHIFT) + ABASE;
2414 >                    if ((o = U.getObject(a, j)) != null &&
2415 >                        (o instanceof CountedCompleter)) {
2416 >                        CountedCompleter<?> t = (CountedCompleter<?>)o, r = t;
2417 >                        do {
2418 >                            if (r == root) {
2419 >                                if (U.compareAndSwapInt(q, QLOCK, 0, 1)) {
2420 >                                    if (q.array == a && q.top == s &&
2421 >                                        U.compareAndSwapObject(a, j, t, null)) {
2422 >                                        q.top = s - 1;
2423 >                                        task = t;
2424 >                                    }
2425 >                                    q.qlock = 0;
2426 >                                }
2427 >                                break;
2428 >                            }
2429 >                        } while ((r = r.completer) != null);
2430 >                    }
2431 >                }
2432 >                if (task != null)
2433 >                    task.doExec();
2434 >                if (root.status < 0 ||
2435 >                    (u = (int)(ctl >>> 32)) >= 0 || (u >> UAC_SHIFT) >= 0)
2436 >                    break;
2437 >                if (task == null) {
2438 >                    helpSignal(root, q.poolIndex);
2439 >                    if (root.status >= 0)
2440 >                        helpComplete(root, SHARED_QUEUE);
2441 >                    break;
2442 >                }
2443 >            }
2444 >        }
2445      }
2446  
2447      /**
2448 <     * Tries to accumulate steal count from a worker, clearing
2449 <     * the worker's value if successful.
1152 <     *
1153 <     * @return true if worker steal count now zero
2448 >     * Tries to help execute or signal availability of the given task
2449 >     * from submitter's queue in common pool.
2450       */
2451 <    final boolean tryAccumulateStealCount(ForkJoinWorkerThread w) {
2452 <        int sc = w.stealCount;
2453 <        long c = stealCount;
2454 <        // CAS even if zero, for fence effects
2455 <        if (UNSAFE.compareAndSwapLong(this, stealCountOffset, c, c + sc)) {
2456 <            if (sc != 0)
2457 <                w.stealCount = 0;
2458 <            return true;
2451 >    static void externalHelpJoin(ForkJoinTask<?> t) {
2452 >        // Some hard-to-avoid overlap with tryExternalUnpush
2453 >        ForkJoinPool p; WorkQueue[] ws; WorkQueue q, w; Submitter z;
2454 >        ForkJoinTask<?>[] a;  int m, s, n;
2455 >        if (t != null &&
2456 >            (z = submitters.get()) != null &&
2457 >            (p = commonPool) != null &&
2458 >            (ws = p.workQueues) != null &&
2459 >            (m = ws.length - 1) >= 0 &&
2460 >            (q = ws[m & z.seed & SQMASK]) != null &&
2461 >            (a = q.array) != null) {
2462 >            int am = a.length - 1;
2463 >            if ((s = q.top) != q.base) {
2464 >                long j = ((am & (s - 1)) << ASHIFT) + ABASE;
2465 >                if (U.getObject(a, j) == t &&
2466 >                    U.compareAndSwapInt(q, QLOCK, 0, 1)) {
2467 >                    if (q.array == a && q.top == s &&
2468 >                        U.compareAndSwapObject(a, j, t, null)) {
2469 >                        q.top = s - 1;
2470 >                        q.qlock = 0;
2471 >                        t.doExec();
2472 >                    }
2473 >                    else
2474 >                        q.qlock = 0;
2475 >                }
2476 >            }
2477 >            if (t.status >= 0) {
2478 >                if (t instanceof CountedCompleter)
2479 >                    p.externalHelpComplete(q, t);
2480 >                else
2481 >                    p.helpSignal(t, q.poolIndex);
2482 >            }
2483          }
1164        return sc == 0;
2484      }
2485  
2486      /**
2487 <     * Returns the approximate (non-atomic) number of idle threads per
1169 <     * active thread.
2487 >     * Restricted version of helpQuiescePool for external callers
2488       */
2489 <    final int idlePerActive() {
2490 <        int pc = parallelism; // use parallelism, not rc
2491 <        int ac = runState;    // no mask -- artificially boosts during shutdown
2492 <        // Use exact results for small values, saturate past 4
2493 <        return ((pc <= ac) ? 0 :
2494 <                (pc >>> 1 <= ac) ? 1 :
2495 <                (pc >>> 2 <= ac) ? 3 :
1178 <                pc >>> 3);
2489 >    static void externalHelpQuiescePool() {
2490 >        ForkJoinPool p; ForkJoinTask<?> t; WorkQueue q; int b;
2491 >        if ((p = commonPool) != null &&
2492 >            (q = p.findNonEmptyStealQueue(1)) != null &&
2493 >            (b = q.base) - q.top < 0 &&
2494 >            (t = q.pollAt(b)) != null)
2495 >            t.doExec();
2496      }
2497  
2498 <    // Public and protected methods
2498 >    // Exported methods
2499  
2500      // Constructors
2501  
# Line 1247 | Line 2564 | public class ForkJoinPool extends Abstra
2564          checkPermission();
2565          if (factory == null)
2566              throw new NullPointerException();
2567 <        if (parallelism <= 0 || parallelism > MAX_WORKERS)
2567 >        if (parallelism <= 0 || parallelism > MAX_CAP)
2568              throw new IllegalArgumentException();
1252        this.parallelism = parallelism;
2569          this.factory = factory;
2570          this.ueh = handler;
2571 <        this.locallyFifo = asyncMode;
2572 <        int arraySize = initialArraySizeFor(parallelism);
2573 <        this.workers = new ForkJoinWorkerThread[arraySize];
2574 <        this.submissionQueue = new LinkedTransferQueue<ForkJoinTask<?>>();
2575 <        this.workerLock = new ReentrantLock();
2576 <        this.termination = new Phaser(1);
2577 <        this.poolNumber = poolNumberGenerator.incrementAndGet();
2571 >        this.config = parallelism | (asyncMode ? (FIFO_QUEUE << 16) : 0);
2572 >        long np = (long)(-parallelism); // offset ctl counts
2573 >        this.ctl = ((np << AC_SHIFT) & AC_MASK) | ((np << TC_SHIFT) & TC_MASK);
2574 >        int pn = nextPoolId();
2575 >        StringBuilder sb = new StringBuilder("ForkJoinPool-");
2576 >        sb.append(Integer.toString(pn));
2577 >        sb.append("-worker-");
2578 >        this.workerNamePrefix = sb.toString();
2579      }
2580  
2581      /**
2582 <     * Returns initial power of two size for workers array.
2583 <     * @param pc the initial parallelism level
2584 <     */
2585 <    private static int initialArraySizeFor(int pc) {
2586 <        // If possible, initially allocate enough space for one spare
2587 <        int size = pc < MAX_WORKERS ? pc + 1 : MAX_WORKERS;
2588 <        // See Hackers Delight, sec 3.2. We know MAX_WORKERS < (1 >>> 16)
2589 <        size |= size >>> 1;
2590 <        size |= size >>> 2;
2591 <        size |= size >>> 4;
2592 <        size |= size >>> 8;
1276 <        return size + 1;
2582 >     * Constructor for common pool, suitable only for static initialization.
2583 >     * Basically the same as above, but uses smallest possible initial footprint.
2584 >     */
2585 >    ForkJoinPool(int parallelism, long ctl,
2586 >                 ForkJoinWorkerThreadFactory factory,
2587 >                 Thread.UncaughtExceptionHandler handler) {
2588 >        this.config = parallelism;
2589 >        this.ctl = ctl;
2590 >        this.factory = factory;
2591 >        this.ueh = handler;
2592 >        this.workerNamePrefix = "ForkJoinPool.commonPool-worker-";
2593      }
2594  
1279    // Execution methods
1280
2595      /**
2596 <     * Common code for execute, invoke and submit
2596 >     * Returns the common pool instance.
2597 >     *
2598 >     * @return the common pool instance
2599       */
2600 <    private <T> void doSubmit(ForkJoinTask<T> task) {
2601 <        if (task == null)
2602 <            throw new NullPointerException();
1287 <        if (runState >= SHUTDOWN)
1288 <            throw new RejectedExecutionException();
1289 <        submissionQueue.offer(task);
1290 <        int c; // try to increment event count -- CAS failure OK
1291 <        UNSAFE.compareAndSwapInt(this, eventCountOffset, c = eventCount, c+1);
1292 <        helpMaintainParallelism(); // create, start, or resume some workers
2600 >    public static ForkJoinPool commonPool() {
2601 >        // assert commonPool != null : "static init error";
2602 >        return commonPool;
2603      }
2604  
2605 +    // Execution methods
2606 +
2607      /**
2608       * Performs the given task, returning its result upon completion.
2609 +     * If the computation encounters an unchecked Exception or Error,
2610 +     * it is rethrown as the outcome of this invocation.  Rethrown
2611 +     * exceptions behave in the same way as regular exceptions, but,
2612 +     * when possible, contain stack traces (as displayed for example
2613 +     * using {@code ex.printStackTrace()}) of both the current thread
2614 +     * as well as the thread actually encountering the exception;
2615 +     * minimally only the latter.
2616       *
2617       * @param task the task
2618       * @return the task's result
# Line 1302 | Line 2621 | public class ForkJoinPool extends Abstra
2621       *         scheduled for execution
2622       */
2623      public <T> T invoke(ForkJoinTask<T> task) {
2624 <        doSubmit(task);
2624 >        if (task == null)
2625 >            throw new NullPointerException();
2626 >        externalPush(task);
2627          return task.join();
2628      }
2629  
# Line 1315 | Line 2636 | public class ForkJoinPool extends Abstra
2636       *         scheduled for execution
2637       */
2638      public void execute(ForkJoinTask<?> task) {
2639 <        doSubmit(task);
2639 >        if (task == null)
2640 >            throw new NullPointerException();
2641 >        externalPush(task);
2642      }
2643  
2644      // AbstractExecutorService methods
# Line 1326 | Line 2649 | public class ForkJoinPool extends Abstra
2649       *         scheduled for execution
2650       */
2651      public void execute(Runnable task) {
2652 +        if (task == null)
2653 +            throw new NullPointerException();
2654          ForkJoinTask<?> job;
2655          if (task instanceof ForkJoinTask<?>) // avoid re-wrap
2656              job = (ForkJoinTask<?>) task;
2657          else
2658 <            job = ForkJoinTask.adapt(task, null);
2659 <        doSubmit(job);
2658 >            job = new ForkJoinTask.AdaptedRunnableAction(task);
2659 >        externalPush(job);
2660      }
2661  
2662      /**
# Line 1344 | Line 2669 | public class ForkJoinPool extends Abstra
2669       *         scheduled for execution
2670       */
2671      public <T> ForkJoinTask<T> submit(ForkJoinTask<T> task) {
2672 <        doSubmit(task);
2672 >        if (task == null)
2673 >            throw new NullPointerException();
2674 >        externalPush(task);
2675          return task;
2676      }
2677  
# Line 1354 | Line 2681 | public class ForkJoinPool extends Abstra
2681       *         scheduled for execution
2682       */
2683      public <T> ForkJoinTask<T> submit(Callable<T> task) {
2684 <        ForkJoinTask<T> job = ForkJoinTask.adapt(task);
2685 <        doSubmit(job);
2684 >        ForkJoinTask<T> job = new ForkJoinTask.AdaptedCallable<T>(task);
2685 >        externalPush(job);
2686          return job;
2687      }
2688  
# Line 1365 | Line 2692 | public class ForkJoinPool extends Abstra
2692       *         scheduled for execution
2693       */
2694      public <T> ForkJoinTask<T> submit(Runnable task, T result) {
2695 <        ForkJoinTask<T> job = ForkJoinTask.adapt(task, result);
2696 <        doSubmit(job);
2695 >        ForkJoinTask<T> job = new ForkJoinTask.AdaptedRunnable<T>(task, result);
2696 >        externalPush(job);
2697          return job;
2698      }
2699  
# Line 1376 | Line 2703 | public class ForkJoinPool extends Abstra
2703       *         scheduled for execution
2704       */
2705      public ForkJoinTask<?> submit(Runnable task) {
2706 +        if (task == null)
2707 +            throw new NullPointerException();
2708          ForkJoinTask<?> job;
2709          if (task instanceof ForkJoinTask<?>) // avoid re-wrap
2710              job = (ForkJoinTask<?>) task;
2711          else
2712 <            job = ForkJoinTask.adapt(task, null);
2713 <        doSubmit(job);
2712 >            job = new ForkJoinTask.AdaptedRunnableAction(task);
2713 >        externalPush(job);
2714          return job;
2715      }
2716  
# Line 1390 | Line 2719 | public class ForkJoinPool extends Abstra
2719       * @throws RejectedExecutionException {@inheritDoc}
2720       */
2721      public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks) {
2722 <        ArrayList<ForkJoinTask<T>> forkJoinTasks =
2723 <            new ArrayList<ForkJoinTask<T>>(tasks.size());
2724 <        for (Callable<T> task : tasks)
2725 <            forkJoinTasks.add(ForkJoinTask.adapt(task));
2726 <        invoke(new InvokeAll<T>(forkJoinTasks));
2727 <
2722 >        // In previous versions of this class, this method constructed
2723 >        // a task to run ForkJoinTask.invokeAll, but now external
2724 >        // invocation of multiple tasks is at least as efficient.
2725 >        List<ForkJoinTask<T>> fs = new ArrayList<ForkJoinTask<T>>(tasks.size());
2726 >        // Workaround needed because method wasn't declared with
2727 >        // wildcards in return type but should have been.
2728          @SuppressWarnings({"unchecked", "rawtypes"})
2729 <            List<Future<T>> futures = (List<Future<T>>) (List) forkJoinTasks;
1401 <        return futures;
1402 <    }
2729 >            List<Future<T>> futures = (List<Future<T>>) (List) fs;
2730  
2731 <    static final class InvokeAll<T> extends RecursiveAction {
2732 <        final ArrayList<ForkJoinTask<T>> tasks;
2733 <        InvokeAll(ArrayList<ForkJoinTask<T>> tasks) { this.tasks = tasks; }
2734 <        public void compute() {
2735 <            try { invokeAll(tasks); }
2736 <            catch (Exception ignore) {}
2731 >        boolean done = false;
2732 >        try {
2733 >            for (Callable<T> t : tasks) {
2734 >                ForkJoinTask<T> f = new ForkJoinTask.AdaptedCallable<T>(t);
2735 >                externalPush(f);
2736 >                fs.add(f);
2737 >            }
2738 >            for (ForkJoinTask<T> f : fs)
2739 >                f.quietlyJoin();
2740 >            done = true;
2741 >            return futures;
2742 >        } finally {
2743 >            if (!done)
2744 >                for (ForkJoinTask<T> f : fs)
2745 >                    f.cancel(false);
2746          }
1411        private static final long serialVersionUID = -7914297376763021607L;
2747      }
2748  
2749      /**
# Line 1436 | Line 2771 | public class ForkJoinPool extends Abstra
2771       * @return the targeted parallelism level of this pool
2772       */
2773      public int getParallelism() {
2774 <        return parallelism;
2774 >        return config & SMASK;
2775 >    }
2776 >
2777 >    /**
2778 >     * Returns the targeted parallelism level of the common pool.
2779 >     *
2780 >     * @return the targeted parallelism level of the common pool
2781 >     */
2782 >    public static int getCommonPoolParallelism() {
2783 >        return commonPoolParallelism;
2784      }
2785  
2786      /**
2787       * Returns the number of worker threads that have started but not
2788 <     * yet terminated.  This result returned by this method may differ
2788 >     * yet terminated.  The result returned by this method may differ
2789       * from {@link #getParallelism} when threads are created to
2790       * maintain parallelism when others are cooperatively blocked.
2791       *
2792       * @return the number of worker threads
2793       */
2794      public int getPoolSize() {
2795 <        return workerCounts >>> TOTAL_COUNT_SHIFT;
2795 >        return (config & SMASK) + (short)(ctl >>> TC_SHIFT);
2796      }
2797  
2798      /**
# Line 1458 | Line 2802 | public class ForkJoinPool extends Abstra
2802       * @return {@code true} if this pool uses async mode
2803       */
2804      public boolean getAsyncMode() {
2805 <        return locallyFifo;
2805 >        return (config >>> 16) == FIFO_QUEUE;
2806      }
2807  
2808      /**
# Line 1470 | Line 2814 | public class ForkJoinPool extends Abstra
2814       * @return the number of worker threads
2815       */
2816      public int getRunningThreadCount() {
2817 <        return workerCounts & RUNNING_COUNT_MASK;
2817 >        int rc = 0;
2818 >        WorkQueue[] ws; WorkQueue w;
2819 >        if ((ws = workQueues) != null) {
2820 >            for (int i = 1; i < ws.length; i += 2) {
2821 >                if ((w = ws[i]) != null && w.isApparentlyUnblocked())
2822 >                    ++rc;
2823 >            }
2824 >        }
2825 >        return rc;
2826      }
2827  
2828      /**
# Line 1481 | Line 2833 | public class ForkJoinPool extends Abstra
2833       * @return the number of active threads
2834       */
2835      public int getActiveThreadCount() {
2836 <        return runState & ACTIVE_COUNT_MASK;
2836 >        int r = (config & SMASK) + (int)(ctl >> AC_SHIFT);
2837 >        return (r <= 0) ? 0 : r; // suppress momentarily negative values
2838      }
2839  
2840      /**
# Line 1496 | Line 2849 | public class ForkJoinPool extends Abstra
2849       * @return {@code true} if all threads are currently idle
2850       */
2851      public boolean isQuiescent() {
2852 <        return (runState & ACTIVE_COUNT_MASK) == 0;
2852 >        return (int)(ctl >> AC_SHIFT) + (config & SMASK) == 0;
2853      }
2854  
2855      /**
# Line 1511 | Line 2864 | public class ForkJoinPool extends Abstra
2864       * @return the number of steals
2865       */
2866      public long getStealCount() {
2867 <        return stealCount;
2867 >        long count = stealCount;
2868 >        WorkQueue[] ws; WorkQueue w;
2869 >        if ((ws = workQueues) != null) {
2870 >            for (int i = 1; i < ws.length; i += 2) {
2871 >                if ((w = ws[i]) != null)
2872 >                    count += w.nsteals;
2873 >            }
2874 >        }
2875 >        return count;
2876      }
2877  
2878      /**
# Line 1526 | Line 2887 | public class ForkJoinPool extends Abstra
2887       */
2888      public long getQueuedTaskCount() {
2889          long count = 0;
2890 <        for (ForkJoinWorkerThread w : workers)
2891 <            if (w != null)
2892 <                count += w.getQueueSize();
2890 >        WorkQueue[] ws; WorkQueue w;
2891 >        if ((ws = workQueues) != null) {
2892 >            for (int i = 1; i < ws.length; i += 2) {
2893 >                if ((w = ws[i]) != null)
2894 >                    count += w.queueSize();
2895 >            }
2896 >        }
2897          return count;
2898      }
2899  
2900      /**
2901       * Returns an estimate of the number of tasks submitted to this
2902 <     * pool that have not yet begun executing.  This method takes time
2903 <     * proportional to the number of submissions.
2902 >     * pool that have not yet begun executing.  This method may take
2903 >     * time proportional to the number of submissions.
2904       *
2905       * @return the number of queued submissions
2906       */
2907      public int getQueuedSubmissionCount() {
2908 <        return submissionQueue.size();
2908 >        int count = 0;
2909 >        WorkQueue[] ws; WorkQueue w;
2910 >        if ((ws = workQueues) != null) {
2911 >            for (int i = 0; i < ws.length; i += 2) {
2912 >                if ((w = ws[i]) != null)
2913 >                    count += w.queueSize();
2914 >            }
2915 >        }
2916 >        return count;
2917      }
2918  
2919      /**
# Line 1550 | Line 2923 | public class ForkJoinPool extends Abstra
2923       * @return {@code true} if there are any queued submissions
2924       */
2925      public boolean hasQueuedSubmissions() {
2926 <        return !submissionQueue.isEmpty();
2926 >        WorkQueue[] ws; WorkQueue w;
2927 >        if ((ws = workQueues) != null) {
2928 >            for (int i = 0; i < ws.length; i += 2) {
2929 >                if ((w = ws[i]) != null && !w.isEmpty())
2930 >                    return true;
2931 >            }
2932 >        }
2933 >        return false;
2934      }
2935  
2936      /**
# Line 1561 | Line 2941 | public class ForkJoinPool extends Abstra
2941       * @return the next submission, or {@code null} if none
2942       */
2943      protected ForkJoinTask<?> pollSubmission() {
2944 <        return submissionQueue.poll();
2944 >        WorkQueue[] ws; WorkQueue w; ForkJoinTask<?> t;
2945 >        if ((ws = workQueues) != null) {
2946 >            for (int i = 0; i < ws.length; i += 2) {
2947 >                if ((w = ws[i]) != null && (t = w.poll()) != null)
2948 >                    return t;
2949 >            }
2950 >        }
2951 >        return null;
2952      }
2953  
2954      /**
# Line 1582 | Line 2969 | public class ForkJoinPool extends Abstra
2969       * @return the number of elements transferred
2970       */
2971      protected int drainTasksTo(Collection<? super ForkJoinTask<?>> c) {
2972 <        int count = submissionQueue.drainTo(c);
2973 <        for (ForkJoinWorkerThread w : workers)
2974 <            if (w != null)
2975 <                count += w.drainTasksTo(c);
2972 >        int count = 0;
2973 >        WorkQueue[] ws; WorkQueue w; ForkJoinTask<?> t;
2974 >        if ((ws = workQueues) != null) {
2975 >            for (int i = 0; i < ws.length; ++i) {
2976 >                if ((w = ws[i]) != null) {
2977 >                    while ((t = w.poll()) != null) {
2978 >                        c.add(t);
2979 >                        ++count;
2980 >                    }
2981 >                }
2982 >            }
2983 >        }
2984          return count;
2985      }
2986  
# Line 1597 | Line 2992 | public class ForkJoinPool extends Abstra
2992       * @return a string identifying this pool, as well as its state
2993       */
2994      public String toString() {
2995 <        long st = getStealCount();
2996 <        long qt = getQueuedTaskCount();
2997 <        long qs = getQueuedSubmissionCount();
2998 <        int wc = workerCounts;
2999 <        int tc = wc >>> TOTAL_COUNT_SHIFT;
3000 <        int rc = wc & RUNNING_COUNT_MASK;
3001 <        int pc = parallelism;
3002 <        int rs = runState;
3003 <        int ac = rs & ACTIVE_COUNT_MASK;
2995 >        // Use a single pass through workQueues to collect counts
2996 >        long qt = 0L, qs = 0L; int rc = 0;
2997 >        long st = stealCount;
2998 >        long c = ctl;
2999 >        WorkQueue[] ws; WorkQueue w;
3000 >        if ((ws = workQueues) != null) {
3001 >            for (int i = 0; i < ws.length; ++i) {
3002 >                if ((w = ws[i]) != null) {
3003 >                    int size = w.queueSize();
3004 >                    if ((i & 1) == 0)
3005 >                        qs += size;
3006 >                    else {
3007 >                        qt += size;
3008 >                        st += w.nsteals;
3009 >                        if (w.isApparentlyUnblocked())
3010 >                            ++rc;
3011 >                    }
3012 >                }
3013 >            }
3014 >        }
3015 >        int pc = (config & SMASK);
3016 >        int tc = pc + (short)(c >>> TC_SHIFT);
3017 >        int ac = pc + (int)(c >> AC_SHIFT);
3018 >        if (ac < 0) // ignore transient negative
3019 >            ac = 0;
3020 >        String level;
3021 >        if ((c & STOP_BIT) != 0)
3022 >            level = (tc == 0) ? "Terminated" : "Terminating";
3023 >        else
3024 >            level = plock < 0 ? "Shutting down" : "Running";
3025          return super.toString() +
3026 <            "[" + runLevelToString(rs) +
3026 >            "[" + level +
3027              ", parallelism = " + pc +
3028              ", size = " + tc +
3029              ", active = " + ac +
# Line 1618 | Line 3034 | public class ForkJoinPool extends Abstra
3034              "]";
3035      }
3036  
1621    private static String runLevelToString(int s) {
1622        return ((s & TERMINATED) != 0 ? "Terminated" :
1623                ((s & TERMINATING) != 0 ? "Terminating" :
1624                 ((s & SHUTDOWN) != 0 ? "Shutting down" :
1625                  "Running")));
1626    }
1627
3037      /**
3038 <     * Initiates an orderly shutdown in which previously submitted
3039 <     * tasks are executed, but no new tasks will be accepted.
3040 <     * Invocation has no additional effect if already shut down.
3041 <     * Tasks that are in the process of being submitted concurrently
3042 <     * during the course of this method may or may not be rejected.
3038 >     * Possibly initiates an orderly shutdown in which previously
3039 >     * submitted tasks are executed, but no new tasks will be
3040 >     * accepted. Invocation has no effect on execution state if this
3041 >     * is the {@link #commonPool}, and no additional effect if
3042 >     * already shut down.  Tasks that are in the process of being
3043 >     * submitted concurrently during the course of this method may or
3044 >     * may not be rejected.
3045       *
3046       * @throws SecurityException if a security manager exists and
3047       *         the caller is not permitted to modify threads
# Line 1639 | Line 3050 | public class ForkJoinPool extends Abstra
3050       */
3051      public void shutdown() {
3052          checkPermission();
3053 <        advanceRunLevel(SHUTDOWN);
1643 <        tryTerminate(false);
3053 >        tryTerminate(false, true);
3054      }
3055  
3056      /**
3057 <     * Attempts to cancel and/or stop all tasks, and reject all
3058 <     * subsequently submitted tasks.  Tasks that are in the process of
3059 <     * being submitted or executed concurrently during the course of
3060 <     * this method may or may not be rejected. This method cancels
3061 <     * both existing and unexecuted tasks, in order to permit
3062 <     * termination in the presence of task dependencies. So the method
3063 <     * always returns an empty list (unlike the case for some other
3064 <     * Executors).
3057 >     * Possibly attempts to cancel and/or stop all tasks, and reject
3058 >     * all subsequently submitted tasks.  Invocation has no effect on
3059 >     * execution state if this is the {@link #commonPool}, and no
3060 >     * additional effect if already shut down. Otherwise, tasks that
3061 >     * are in the process of being submitted or executed concurrently
3062 >     * during the course of this method may or may not be
3063 >     * rejected. This method cancels both existing and unexecuted
3064 >     * tasks, in order to permit termination in the presence of task
3065 >     * dependencies. So the method always returns an empty list
3066 >     * (unlike the case for some other Executors).
3067       *
3068       * @return an empty list
3069       * @throws SecurityException if a security manager exists and
# Line 1661 | Line 3073 | public class ForkJoinPool extends Abstra
3073       */
3074      public List<Runnable> shutdownNow() {
3075          checkPermission();
3076 <        tryTerminate(true);
3076 >        tryTerminate(true, true);
3077          return Collections.emptyList();
3078      }
3079  
# Line 1671 | Line 3083 | public class ForkJoinPool extends Abstra
3083       * @return {@code true} if all tasks have completed following shut down
3084       */
3085      public boolean isTerminated() {
3086 <        return runState >= TERMINATED;
3086 >        long c = ctl;
3087 >        return ((c & STOP_BIT) != 0L &&
3088 >                (short)(c >>> TC_SHIFT) == -(config & SMASK));
3089      }
3090  
3091      /**
# Line 1679 | Line 3093 | public class ForkJoinPool extends Abstra
3093       * commenced but not yet completed.  This method may be useful for
3094       * debugging. A return of {@code true} reported a sufficient
3095       * period after shutdown may indicate that submitted tasks have
3096 <     * ignored or suppressed interruption, causing this executor not
3097 <     * to properly terminate.
3096 >     * ignored or suppressed interruption, or are waiting for I/O,
3097 >     * causing this executor not to properly terminate. (See the
3098 >     * advisory notes for class {@link ForkJoinTask} stating that
3099 >     * tasks should not normally entail blocking operations.  But if
3100 >     * they do, they must abort them on interrupt.)
3101       *
3102       * @return {@code true} if terminating but not yet terminated
3103       */
3104      public boolean isTerminating() {
3105 <        return (runState & (TERMINATING|TERMINATED)) == TERMINATING;
3105 >        long c = ctl;
3106 >        return ((c & STOP_BIT) != 0L &&
3107 >                (short)(c >>> TC_SHIFT) != -(config & SMASK));
3108      }
3109  
3110      /**
# Line 1694 | Line 3113 | public class ForkJoinPool extends Abstra
3113       * @return {@code true} if this pool has been shut down
3114       */
3115      public boolean isShutdown() {
3116 <        return runState >= SHUTDOWN;
3116 >        return plock < 0;
3117      }
3118  
3119      /**
3120 <     * Blocks until all tasks have completed execution after a shutdown
3121 <     * request, or the timeout occurs, or the current thread is
3122 <     * interrupted, whichever happens first.
3120 >     * Blocks until all tasks have completed execution after a
3121 >     * shutdown request, or the timeout occurs, or the current thread
3122 >     * is interrupted, whichever happens first. Note that the {@link
3123 >     * #commonPool()} never terminates until program shutdown so
3124 >     * this method will always time out.
3125       *
3126       * @param timeout the maximum time to wait
3127       * @param unit the time unit of the timeout argument
# Line 1710 | Line 3131 | public class ForkJoinPool extends Abstra
3131       */
3132      public boolean awaitTermination(long timeout, TimeUnit unit)
3133          throws InterruptedException {
3134 <        try {
3135 <            return termination.awaitAdvanceInterruptibly(0, timeout, unit) > 0;
3136 <        } catch (TimeoutException ex) {
3137 <            return false;
3134 >        long nanos = unit.toNanos(timeout);
3135 >        if (isTerminated())
3136 >            return true;
3137 >        long startTime = System.nanoTime();
3138 >        boolean terminated = false;
3139 >        synchronized (this) {
3140 >            for (long waitTime = nanos, millis = 0L;;) {
3141 >                if (terminated = isTerminated() ||
3142 >                    waitTime <= 0L ||
3143 >                    (millis = unit.toMillis(waitTime)) <= 0L)
3144 >                    break;
3145 >                wait(millis);
3146 >                waitTime = nanos - (System.nanoTime() - startTime);
3147 >            }
3148          }
3149 +        return terminated;
3150      }
3151  
3152      /**
# Line 1725 | Line 3157 | public class ForkJoinPool extends Abstra
3157       * {@code isReleasable} must return {@code true} if blocking is
3158       * not necessary. Method {@code block} blocks the current thread
3159       * if necessary (perhaps internally invoking {@code isReleasable}
3160 <     * before actually blocking). The unusual methods in this API
3161 <     * accommodate synchronizers that may, but don't usually, block
3162 <     * for long periods. Similarly, they allow more efficient internal
3163 <     * handling of cases in which additional workers may be, but
3164 <     * usually are not, needed to ensure sufficient parallelism.
3165 <     * Toward this end, implementations of method {@code isReleasable}
3166 <     * must be amenable to repeated invocation.
3160 >     * before actually blocking). These actions are performed by any
3161 >     * thread invoking {@link ForkJoinPool#managedBlock}.  The
3162 >     * unusual methods in this API accommodate synchronizers that may,
3163 >     * but don't usually, block for long periods. Similarly, they
3164 >     * allow more efficient internal handling of cases in which
3165 >     * additional workers may be, but usually are not, needed to
3166 >     * ensure sufficient parallelism.  Toward this end,
3167 >     * implementations of method {@code isReleasable} must be amenable
3168 >     * to repeated invocation.
3169       *
3170       * <p>For example, here is a ManagedBlocker based on a
3171       * ReentrantLock:
# Line 1812 | Line 3246 | public class ForkJoinPool extends Abstra
3246          throws InterruptedException {
3247          Thread t = Thread.currentThread();
3248          if (t instanceof ForkJoinWorkerThread) {
3249 <            ForkJoinWorkerThread w = (ForkJoinWorkerThread) t;
3250 <            w.pool.awaitBlocker(blocker);
3249 >            ForkJoinPool p = ((ForkJoinWorkerThread)t).pool;
3250 >            while (!blocker.isReleasable()) { // variant of helpSignal
3251 >                WorkQueue[] ws; WorkQueue q; int m, u;
3252 >                if ((ws = p.workQueues) != null && (m = ws.length - 1) >= 0) {
3253 >                    for (int i = 0; i <= m; ++i) {
3254 >                        if (blocker.isReleasable())
3255 >                            return;
3256 >                        if ((q = ws[i]) != null && q.base - q.top < 0) {
3257 >                            p.signalWork(q);
3258 >                            if ((u = (int)(p.ctl >>> 32)) >= 0 ||
3259 >                                (u >> UAC_SHIFT) >= 0)
3260 >                                break;
3261 >                        }
3262 >                    }
3263 >                }
3264 >                if (p.tryCompensate()) {
3265 >                    try {
3266 >                        do {} while (!blocker.isReleasable() &&
3267 >                                     !blocker.block());
3268 >                    } finally {
3269 >                        p.incrementActiveCount();
3270 >                    }
3271 >                    break;
3272 >                }
3273 >            }
3274          }
3275          else {
3276 <            do {} while (!blocker.isReleasable() && !blocker.block());
3276 >            do {} while (!blocker.isReleasable() &&
3277 >                         !blocker.block());
3278          }
3279      }
3280  
# Line 1825 | Line 3283 | public class ForkJoinPool extends Abstra
3283      // implement RunnableFuture.
3284  
3285      protected <T> RunnableFuture<T> newTaskFor(Runnable runnable, T value) {
3286 <        return (RunnableFuture<T>) ForkJoinTask.adapt(runnable, value);
3286 >        return new ForkJoinTask.AdaptedRunnable<T>(runnable, value);
3287      }
3288  
3289      protected <T> RunnableFuture<T> newTaskFor(Callable<T> callable) {
3290 <        return (RunnableFuture<T>) ForkJoinTask.adapt(callable);
3290 >        return new ForkJoinTask.AdaptedCallable<T>(callable);
3291      }
3292  
3293      // Unsafe mechanics
3294 +    private static final sun.misc.Unsafe U;
3295 +    private static final long CTL;
3296 +    private static final long PARKBLOCKER;
3297 +    private static final int ABASE;
3298 +    private static final int ASHIFT;
3299 +    private static final long STEALCOUNT;
3300 +    private static final long PLOCK;
3301 +    private static final long INDEXSEED;
3302 +    private static final long QLOCK;
3303  
3304 <    private static final sun.misc.Unsafe UNSAFE = getUnsafe();
3305 <    private static final long workerCountsOffset =
1839 <        objectFieldOffset("workerCounts", ForkJoinPool.class);
1840 <    private static final long runStateOffset =
1841 <        objectFieldOffset("runState", ForkJoinPool.class);
1842 <    private static final long eventCountOffset =
1843 <        objectFieldOffset("eventCount", ForkJoinPool.class);
1844 <    private static final long eventWaitersOffset =
1845 <        objectFieldOffset("eventWaiters", ForkJoinPool.class);
1846 <    private static final long stealCountOffset =
1847 <        objectFieldOffset("stealCount", ForkJoinPool.class);
1848 <    private static final long spareWaitersOffset =
1849 <        objectFieldOffset("spareWaiters", ForkJoinPool.class);
1850 <
1851 <    private static long objectFieldOffset(String field, Class<?> klazz) {
3304 >    static {
3305 >        int s; // initialize field offsets for CAS etc
3306          try {
3307 <            return UNSAFE.objectFieldOffset(klazz.getDeclaredField(field));
3308 <        } catch (NoSuchFieldException e) {
3309 <            // Convert Exception to corresponding Error
3310 <            NoSuchFieldError error = new NoSuchFieldError(field);
3311 <            error.initCause(e);
3312 <            throw error;
3313 <        }
3307 >            U = getUnsafe();
3308 >            Class<?> k = ForkJoinPool.class;
3309 >            CTL = U.objectFieldOffset
3310 >                (k.getDeclaredField("ctl"));
3311 >            STEALCOUNT = U.objectFieldOffset
3312 >                (k.getDeclaredField("stealCount"));
3313 >            PLOCK = U.objectFieldOffset
3314 >                (k.getDeclaredField("plock"));
3315 >            INDEXSEED = U.objectFieldOffset
3316 >                (k.getDeclaredField("indexSeed"));
3317 >            Class<?> tk = Thread.class;
3318 >            PARKBLOCKER = U.objectFieldOffset
3319 >                (tk.getDeclaredField("parkBlocker"));
3320 >            Class<?> wk = WorkQueue.class;
3321 >            QLOCK = U.objectFieldOffset
3322 >                (wk.getDeclaredField("qlock"));
3323 >            Class<?> ak = ForkJoinTask[].class;
3324 >            ABASE = U.arrayBaseOffset(ak);
3325 >            s = U.arrayIndexScale(ak);
3326 >            ASHIFT = 31 - Integer.numberOfLeadingZeros(s);
3327 >        } catch (Exception e) {
3328 >            throw new Error(e);
3329 >        }
3330 >        if ((s & (s-1)) != 0)
3331 >            throw new Error("data type scale not a power of two");
3332 >
3333 >        submitters = new ThreadLocal<Submitter>();
3334 >        ForkJoinWorkerThreadFactory fac = defaultForkJoinWorkerThreadFactory =
3335 >            new DefaultForkJoinWorkerThreadFactory();
3336 >        modifyThreadPermission = new RuntimePermission("modifyThread");
3337 >
3338 >        /*
3339 >         * Establish common pool parameters.  For extra caution,
3340 >         * computations to set up common pool state are here; the
3341 >         * constructor just assigns these values to fields.
3342 >         */
3343 >
3344 >        int par = 0;
3345 >        Thread.UncaughtExceptionHandler handler = null;
3346 >        try {  // TBD: limit or report ignored exceptions?
3347 >            String pp = System.getProperty
3348 >                ("java.util.concurrent.ForkJoinPool.common.parallelism");
3349 >            String hp = System.getProperty
3350 >                ("java.util.concurrent.ForkJoinPool.common.exceptionHandler");
3351 >            String fp = System.getProperty
3352 >                ("java.util.concurrent.ForkJoinPool.common.threadFactory");
3353 >            if (fp != null)
3354 >                fac = ((ForkJoinWorkerThreadFactory)ClassLoader.
3355 >                       getSystemClassLoader().loadClass(fp).newInstance());
3356 >            if (hp != null)
3357 >                handler = ((Thread.UncaughtExceptionHandler)ClassLoader.
3358 >                           getSystemClassLoader().loadClass(hp).newInstance());
3359 >            if (pp != null)
3360 >                par = Integer.parseInt(pp);
3361 >        } catch (Exception ignore) {
3362 >        }
3363 >
3364 >        if (par <= 0)
3365 >            par = Runtime.getRuntime().availableProcessors();
3366 >        if (par > MAX_CAP)
3367 >            par = MAX_CAP;
3368 >        commonPoolParallelism = par;
3369 >        long np = (long)(-par); // precompute initial ctl value
3370 >        long ct = ((np << AC_SHIFT) & AC_MASK) | ((np << TC_SHIFT) & TC_MASK);
3371 >
3372 >        commonPool = new ForkJoinPool(par, ct, fac, handler);
3373      }
3374  
3375      /**
# Line 1886 | Line 3399 | public class ForkJoinPool extends Abstra
3399              }
3400          }
3401      }
3402 +
3403   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines