ViewVC Help

View File | Revision Log | Show Annotations | Download File | Root Listing

root/jsr166/jsr166/src/jsr166y/ForkJoinPool.java

Comparing jsr166/src/jsr166y/ForkJoinPool.java (file contents):
Revision 1.53 by dl, Mon Apr 5 15:52:26 2010 UTC vs.
Revision 1.98 by dl, Mon Mar 21 23:29:03 2011 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.*;
10	–
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.Random;
15	+	import java.util.concurrent.AbstractExecutorService;
16	+	import java.util.concurrent.Callable;
17	+	import java.util.concurrent.ExecutorService;
18	+	import java.util.concurrent.Future;
19	+	import java.util.concurrent.RejectedExecutionException;
20	+	import java.util.concurrent.RunnableFuture;
21	+	import java.util.concurrent.TimeUnit;
22	+	import java.util.concurrent.TimeoutException;
23	+	import java.util.concurrent.atomic.AtomicInteger;
24		import java.util.concurrent.locks.LockSupport;
25		import java.util.concurrent.locks.ReentrantLock;
26	<	import java.util.concurrent.atomic.AtomicInteger;
19	<	import java.util.concurrent.CountDownLatch;
26	>	import java.util.concurrent.locks.Condition;
27
28		/**
29		* An {@link ExecutorService} for running {@link ForkJoinTask}s.
30		* A {@code ForkJoinPool} provides the entry point for submissions
31	<	* from non-{@code ForkJoinTask}s, as well as management and
31	>	* from non-{@code ForkJoinTask} clients, as well as management and
32		* monitoring operations.
33		*
34		* <p>A {@code ForkJoinPool} differs from other kinds of {@link
#	Line 30 | Line 37 | import java.util.concurrent.CountDownLat
37		* execute subtasks created by other active tasks (eventually blocking
38		* waiting for work if none exist). This enables efficient processing
39		* when most tasks spawn other subtasks (as do most {@code
40	<	* ForkJoinTask}s). A {@code ForkJoinPool} may also be used for mixed
41	<	* execution of some plain {@code Runnable}- or {@code Callable}-
42	<	* based activities along with {@code ForkJoinTask}s. When setting
36	<	* {@linkplain #setAsyncMode async mode}, a {@code ForkJoinPool} may
37	<	* also be appropriate for use with fine-grained tasks of any form
38	<	* that are never joined. Otherwise, other {@code ExecutorService}
39	<	* implementations are typically more appropriate choices.
40	>	* ForkJoinTask}s). When setting <em>asyncMode</em> to true in
41	>	* constructors, {@code ForkJoinPool}s may also be appropriate for use
42	>	* with event-style tasks that are never joined.
43		*
44		* <p>A {@code ForkJoinPool} is constructed with a given target
45		* parallelism level; by default, equal to the number of available
46	<	* processors. Unless configured otherwise via {@link
47	<	* #setMaintainsParallelism}, the pool attempts to maintain this
48	<	* number of active (or available) threads by dynamically adding,
49	<	* suspending, or resuming internal worker threads, even if some tasks
50	<	* are stalled waiting to join others. However, no such adjustments
51	<	* are performed in the face of blocked IO or other unmanaged
52	<	* synchronization. The nested {@link ManagedBlocker} interface
50	<	* enables extension of the kinds of synchronization accommodated.
51	<	* The target parallelism level may also be changed dynamically
52	<	* ({@link #setParallelism}). The total number of threads may be
53	<	* limited using method {@link #setMaximumPoolSize}, in which case it
54	<	* may become possible for the activities of a pool to stall due to
55	<	* the lack of available threads to process new tasks. When the pool
56	<	* is executing tasks, these and other configuration setting methods
57	<	* may only gradually affect actual pool sizes. It is normally best
58	<	* practice to invoke these methods only when the pool is known to be
59	<	* quiescent.
46	>	* processors. The pool attempts to maintain enough active (or
47	>	* available) threads by dynamically adding, suspending, or resuming
48	>	* internal worker threads, even if some tasks are stalled waiting to
49	>	* join others. However, no such adjustments are guaranteed in the
50	>	* face of blocked IO or other unmanaged synchronization. The nested
51	>	* {@link ManagedBlocker} interface enables extension of the kinds of
52	>	* synchronization accommodated.
53		*
54		* <p>In addition to execution and lifecycle control methods, this
55		* class provides status check methods (for example
#	Line 65 | Line 58 | import java.util.concurrent.CountDownLat
58		* {@link #toString} returns indications of pool state in a
59		* convenient form for informal monitoring.
60		*
61	+	* <p> As is the case with other ExecutorServices, there are three
62	+	* main task execution methods summarized in the following
63	+	* table. These are designed to be used by clients not already engaged
64	+	* in fork/join computations in the current pool.  The main forms of
65	+	* these methods accept instances of {@code ForkJoinTask}, but
66	+	* overloaded forms also allow mixed execution of plain {@code
67	+	* Runnable}- or {@code Callable}- based activities as well.  However,
68	+	* tasks that are already executing in a pool should normally
69	+	* <em>NOT</em> use these pool execution methods, but instead use the
70	+	* within-computation forms listed in the table.
71	+	*
72	+	* <table BORDER CELLPADDING=3 CELLSPACING=1>
73	+	*  <tr>
74	+	*    <td></td>
75	+	*    <td ALIGN=CENTER> <b>Call from non-fork/join clients</b></td>
76	+	*    <td ALIGN=CENTER> <b>Call from within fork/join computations</b></td>
77	+	*  </tr>
78	+	*  <tr>
79	+	*    <td> <b>Arrange async execution</td>
80	+	*    <td> {@link #execute(ForkJoinTask)}</td>
81	+	*    <td> {@link ForkJoinTask#fork}</td>
82	+	*  </tr>
83	+	*  <tr>
84	+	*    <td> <b>Await and obtain result</td>
85	+	*    <td> {@link #invoke(ForkJoinTask)}</td>
86	+	*    <td> {@link ForkJoinTask#invoke}</td>
87	+	*  </tr>
88	+	*  <tr>
89	+	*    <td> <b>Arrange exec and obtain Future</td>
90	+	*    <td> {@link #submit(ForkJoinTask)}</td>
91	+	*    <td> {@link ForkJoinTask#fork} (ForkJoinTasks <em>are</em> Futures)</td>
92	+	*  </tr>
93	+	* </table>
94	+	*
95		* <p><b>Sample Usage.</b> Normally a single {@code ForkJoinPool} is
96		* used for all parallel task execution in a program or subsystem.
97		* Otherwise, use would not usually outweigh the construction and
#	Line 89 | Line 116 | import java.util.concurrent.CountDownLat
116		* {@code IllegalArgumentException}.
117		*
118		* <p>This implementation rejects submitted tasks (that is, by throwing
119	<	* {@link RejectedExecutionException}) only when the pool is shut down.
119	>	* {@link RejectedExecutionException}) only when the pool is shut down
120	>	* or internal resources have been exhausted.
121		*
122		* @since 1.7
123		* @author Doug Lea
#	Line 103 | Line 131 | public class ForkJoinPool extends Abstra
131		* set of worker threads: Submissions from non-FJ threads enter
132		* into a submission queue. Workers take these tasks and typically
133		* split them into subtasks that may be stolen by other workers.
134	<	* The main work-stealing mechanics implemented in class
135	<	* ForkJoinWorkerThread give first priority to processing tasks
136	<	* from their own queues (LIFO or FIFO, depending on mode), then
137	<	* to randomized FIFO steals of tasks in other worker queues, and
110	<	* lastly to new submissions. These mechanics do not consider
111	<	* affinities, loads, cache localities, etc, so rarely provide the
112	<	* best possible performance on a given machine, but portably
113	<	* provide good throughput by averaging over these factors.
114	<	* (Further, even if we did try to use such information, we do not
115	<	* usually have a basis for exploiting it. For example, some sets
116	<	* of tasks profit from cache affinities, but others are harmed by
117	<	* cache pollution effects.)
134	>	* Preference rules give first priority to processing tasks from
135	>	* their own queues (LIFO or FIFO, depending on mode), then to
136	>	* randomized FIFO steals of tasks in other worker queues, and
137	>	* lastly to new submissions.
138		*
139		* The main throughput advantages of work-stealing stem from
140	<	* decentralized control -- workers mostly steal tasks from each
141	<	* other. We do not want to negate this by creating bottlenecks
142	<	* implementing the management responsibilities of this class. So
143	<	* we use a collection of techniques that avoid, reduce, or cope
144	<	* well with contention. These entail several instances of
145	<	* bit-packing into CASable fields to maintain only the minimally
146	<	* required atomicity. To enable such packing, we restrict maximum
147	<	* parallelism to (1<<15)-1 (enabling twice this to fit into a 16
148	<	* bit field), which is far in excess of normal operating range.
149	<	* Even though updates to some of these bookkeeping fields do
150	<	* sometimes contend with each other, they don't normally
151	<	* cache-contend with updates to others enough to warrant memory
152	<	* padding or isolation. So they are all held as fields of
153	<	* ForkJoinPool objects.  The main capabilities are as follows:
154	<	*
155	<	* 1. Creating and removing workers. Workers are recorded in the
156	<	* "workers" array. This is an array as opposed to some other data
140	>	* decentralized control -- workers mostly take tasks from
141	>	* themselves or each other. We cannot negate this in the
142	>	* implementation of other management responsibilities. The main
143	>	* tactic for avoiding bottlenecks is packing nearly all
144	>	* essentially atomic control state into a single 64bit volatile
145	>	* variable ("ctl"). This variable is read on the order of 10-100
146	>	* times as often as it is modified (always via CAS). (There is
147	>	* some additional control state, for example variable "shutdown"
148	>	* for which we can cope with uncoordinated updates.)  This
149	>	* streamlines synchronization and control at the expense of messy
150	>	* constructions needed to repack status bits upon updates.
151	>	* Updates tend not to contend with each other except during
152	>	* bursts while submitted tasks begin or end.  In some cases when
153	>	* they do contend, threads can instead do something else
154	>	* (usually, scan for tasks) until contention subsides.
155	>	*
156	>	* To enable packing, we restrict maximum parallelism to (1<<15)-1
157	>	* (which is far in excess of normal operating range) to allow
158	>	* ids, counts, and their negations (used for thresholding) to fit
159	>	* into 16bit fields.
160	>	*
161	>	* Recording Workers.  Workers are recorded in the "workers" array
162	>	* that is created upon pool construction and expanded if (rarely)
163	>	* necessary.  This is an array as opposed to some other data
164		* structure to support index-based random steals by workers.
165		* Updates to the array recording new workers and unrecording
166	<	* terminated ones are protected from each other by a lock
167	<	* (workerLock) but the array is otherwise concurrently readable,
166	>	* terminated ones are protected from each other by a seqLock
167	>	* (scanGuard) but the array is otherwise concurrently readable,
168		* and accessed directly by workers. To simplify index-based
169		* operations, the array size is always a power of two, and all
170	<	* readers must tolerate null slots. Currently, all but the first
171	<	* worker thread creation is on-demand, triggered by task
172	<	* submissions, replacement of terminated workers, and/or
173	<	* compensation for blocked workers. However, all other support
174	<	* code is set up to work with other policies.
175	<	*
176	<	* 2. Bookkeeping for dynamically adding and removing workers. We
177	<	* maintain a given level of parallelism (or, if
178	<	* maintainsParallelism is false, at least avoid starvation). When
179	<	* some workers are known to be blocked (on joins or via
180	<	* ManagedBlocker), we may create or resume others to take their
181	<	* place until they unblock (see below). Implementing this
182	<	* requires counts of the number of "running" threads (i.e., those
183	<	* that are neither blocked nor artifically suspended) as well as
184	<	* the total number.  These two values are packed into one field,
185	<	* "workerCounts" because we need accurate snapshots when deciding
186	<	* to create, resume or suspend.  To support these decisions,
187	<	* updates must be prospective (not retrospective).  For example,
188	<	* the running count is decremented before blocking by a thread
189	<	* about to block, but incremented by the thread about to unblock
190	<	* it. (In a few cases, these prospective updates may need to be
191	<	* rolled back, for example when deciding to create a new worker
192	<	* but the thread factory fails or returns null. In these cases,
193	<	* we are no worse off wrt other decisions than we would be
194	<	* otherwise.)  Updates to the workerCounts field sometimes
195	<	* transiently encounter a fair amount of contention when join
196	<	* dependencies are such that many threads block or unblock at
197	<	* about the same time. We alleviate this by sometimes bundling
198	<	* updates (for example blocking one thread on join and resuming a
199	<	* spare cancel each other out), and in most other cases
200	<	* performing an alternative action (like releasing waiters and
201	<	* finding spares; see below) as a more productive form of
202	<	* backoff.
203	<	*
204	<	* 3. Maintaining global run state. The run state of the pool
205	<	* consists of a runLevel (SHUTDOWN, TERMINATING, etc) similar to
206	<	* those in other Executor implementations, as well as a count of
207	<	* "active" workers -- those that are, or soon will be, or
208	<	* recently were executing tasks. The runLevel and active count
209	<	* are packed together in order to correctly trigger shutdown and
210	<	* termination. Without care, active counts can be subject to very
211	<	* high contention.  We substantially reduce this contention by
212	<	* relaxing update rules.  A worker must claim active status
213	<	* prospectively, by activating if it sees that a submitted or
214	<	* stealable task exists (it may find after activating that the
215	<	* task no longer exists). It stays active while processing this
216	<	* task (if it exists) and any other local subtasks it produces,
217	<	* until it cannot find any other tasks. It then tries
218	<	* inactivating (see method preStep), but upon update contention
219	<	* instead scans for more tasks, later retrying inactivation if it
220	<	* doesn't find any.
221	<	*
222	<	* 4. Managing idle workers waiting for tasks. We cannot let
223	<	* workers spin indefinitely scanning for tasks when none are
224	<	* available. On the other hand, we must quickly prod them into
225	<	* action when new tasks are submitted or generated.  We
226	<	* park/unpark these idle workers using an event-count scheme.
227	<	* Field eventCount is incremented upon events that may enable
228	<	* workers that previously could not find a task to now find one:
229	<	* Submission of a new task to the pool, or another worker pushing
230	<	* a task onto a previously empty queue.  (We also use this
231	<	* mechanism for termination and reconfiguration actions that
232	<	* require wakeups of idle workers).  Each worker maintains its
233	<	* last known event count, and blocks when a scan for work did not
234	<	* find a task AND its lastEventCount matches the current
235	<	* eventCount. Waiting idle workers are recorded in a variant of
236	<	* Treiber stack headed by field eventWaiters which, when nonzero,
237	<	* encodes the thread index and count awaited for by the worker
238	<	* thread most recently calling eventSync. This thread in turn has
239	<	* a record (field nextEventWaiter) for the next waiting worker.
240	<	* In addition to allowing simpler decisions about need for
241	<	* wakeup, the event count bits in eventWaiters serve the role of
242	<	* tags to avoid ABA errors in Treiber stacks.  To reduce delays
243	<	* in task diffusion, workers not otherwise occupied may invoke
244	<	* method releaseWaiters, that removes and signals (unparks)
245	<	* workers not waiting on current count. To minimize task
246	<	* production stalls associate with signalling, any worker pushing
247	<	* a task on an empty queue invokes the weaker method signalWork,
248	<	* that only releases idle workers until it detects interference
249	<	* by other threads trying to release, and lets them take
250	<	* over. The net effect is a tree-like diffusion of signals, where
251	<	* released threads and possibly others) help with unparks.  To
252	<	* further reduce contention effects a bit, failed CASes to
253	<	* increment field eventCount are tolerated without retries.
254	<	* Conceptually they are merged into the same event, which is OK
255	<	* when their only purpose is to enable workers to scan for work.
256	<	*
257	<	* 5. Managing suspension of extra workers. When a worker is about
258	<	* to block waiting for a join (or via ManagedBlockers), we may
259	<	* create a new thread to maintain parallelism level, or at least
260	<	* avoid starvation (see below). Usually, extra threads are needed
261	<	* for only very short periods, yet join dependencies are such
262	<	* that we sometimes need them in bursts. Rather than create new
263	<	* threads each time this happens, we suspend no-longer-needed
264	<	* extra ones as "spares". For most purposes, we don't distinguish
265	<	* "extra" spare threads from normal "core" threads: On each call
266	<	* to preStep (the only point at which we can do this) a worker
267	<	* checks to see if there are now too many running workers, and if
268	<	* so, suspends itself.  Methods preJoin and doBlock look for
269	<	* suspended threads to resume before considering creating a new
270	<	* replacement. We don't need a special data structure to maintain
271	<	* spares; simply scanning the workers array looking for
272	<	* worker.isSuspended() is fine because the calling thread is
273	<	* otherwise not doing anything useful anyway; we are at least as
274	<	* happy if after locating a spare, the caller doesn't actually
275	<	* block because the join is ready before we try to adjust and
276	<	* compensate.  Note that this is intrinsically racy.  One thread
277	<	* may become a spare at about the same time as another is
278	<	* needlessly being created. We counteract this and related slop
279	<	* in part by requiring resumed spares to immediately recheck (in
280	<	* preStep) to see whether they they should re-suspend. The only
281	<	* effective difference between "extra" and "core" threads is that
282	<	* we allow the "extra" ones to time out and die if they are not
283	<	* resumed within a keep-alive interval of a few seconds. This is
284	<	* implemented mainly within ForkJoinWorkerThread, but requires
285	<	* some coordination (isTrimmed() -- meaning killed while
286	<	* suspended) to correctly maintain pool counts.
287	<	*
288	<	* 6. Deciding when to create new workers. The main dynamic
289	<	* control in this class is deciding when to create extra threads,
290	<	* in methods preJoin and doBlock. We always need to create one
291	<	* when the number of running threads becomes zero. But because
292	<	* blocked joins are typically dependent, we don't necessarily
293	<	* need or want one-to-one replacement. Using a one-to-one
294	<	* compensation rule often leads to enough useless overhead
295	<	* creating, suspending, resuming, and/or killing threads to
296	<	* signficantly degrade throughput.  We use a rule reflecting the
297	<	* idea that, the more spare threads you already have, the more
298	<	* evidence you need to create another one; where "evidence" is
299	<	* expressed as the current deficit -- target minus running
273	<	* threads. To reduce flickering and drift around target values,
274	<	* the relation is quadratic: adding a spare if (dc*dc)>=(sc*pc)
275	<	* (where dc is deficit, sc is number of spare threads and pc is
276	<	* target parallelism.)  This effectively reduces churn at the
277	<	* price of systematically undershooting target parallelism when
278	<	* many threads are blocked.  However, biasing toward undeshooting
279	<	* partially compensates for the above mechanics to suspend extra
280	<	* threads, that normally lead to overshoot because we can only
281	<	* suspend workers in-between top-level actions. It also better
282	<	* copes with the fact that some of the methods in this class tend
283	<	* to never become compiled (but are interpreted), so some
284	<	* components of the entire set of controls might execute many
285	<	* times faster than others. And similarly for cases where the
286	<	* apparent lack of work is just due to GC stalls and other
287	<	* transient system activity.
288	<	*
289	<	* 7. Maintaining other configuration parameters and monitoring
290	<	* statistics. Updates to fields controlling parallelism level,
291	<	* max size, etc can only meaningfully take effect for individual
292	<	* threads upon their next top-level actions; i.e., between
293	<	* stealing/running tasks/submission, which are separated by calls
294	<	* to preStep.  Memory ordering for these (assumed infrequent)
295	<	* reconfiguration calls is ensured by using reads and writes to
296	<	* volatile field workerCounts (that must be read in preStep anyway)
297	<	* as "fences" -- user-level reads are preceded by reads of
298	<	* workCounts, and writes are followed by no-op CAS to
299	<	* workerCounts. The values reported by other management and
300	<	* monitoring methods are either computed on demand, or are kept
301	<	* in fields that are only updated when threads are otherwise
302	<	* idle.
170	>	* readers must tolerate null slots. To avoid flailing during
171	>	* start-up, the array is presized to hold twice #parallelism
172	>	* workers (which is unlikely to need further resizing during
173	>	* execution). But to avoid dealing with so many null slots,
174	>	* variable scanGuard includes a mask for the nearest power of two
175	>	* that contains all current workers.  All worker thread creation
176	>	* is on-demand, triggered by task submissions, replacement of
177	>	* terminated workers, and/or compensation for blocked
178	>	* workers. However, all other support code is set up to work with
179	>	* other policies.  To ensure that we do not hold on to worker
180	>	* references that would prevent GC, ALL accesses to workers are
181	>	* via indices into the workers array (which is one source of some
182	>	* of the messy code constructions here). In essence, the workers
183	>	* array serves as a weak reference mechanism. Thus for example
184	>	* the wait queue field of ctl stores worker indices, not worker
185	>	* references.  Access to the workers in associated methods (for
186	>	* example signalWork) must both index-check and null-check the
187	>	* IDs. All such accesses ignore bad IDs by returning out early
188	>	* from what they are doing, since this can only be associated
189	>	* with termination, in which case it is OK to give up.
190	>	*
191	>	* All uses of the workers array, as well as queue arrays, check
192	>	* that the array is non-null (even if previously non-null). This
193	>	* allows nulling during termination, which is currently not
194	>	* necessary, but remains an option for resource-revocation-based
195	>	* shutdown schemes.
196	>	*
197	>	* Wait Queuing. Unlike HPC work-stealing frameworks, we cannot
198	>	* let workers spin indefinitely scanning for tasks when none can
199	>	* be found immediately, and we cannot start/resume workers unless
200	>	* there appear to be tasks available.  On the other hand, we must
201	>	* quickly prod them into action when new tasks are submitted or
202	>	* generated.  We park/unpark workers after placing in an event
203	>	* wait queue when they cannot find work. This "queue" is actually
204	>	* a simple Treiber stack, headed by the "id" field of ctl, plus a
205	>	* 15bit counter value to both wake up waiters (by advancing their
206	>	* count) and avoid ABA effects. Successors are held in worker
207	>	* field "nextWait".  Queuing deals with several intrinsic races,
208	>	* mainly that a task-producing thread can miss seeing (and
209	>	* signalling) another thread that gave up looking for work but
210	>	* has not yet entered the wait queue. We solve this by requiring
211	>	* a full sweep of all workers both before (in scan()) and after
212	>	* (in tryAwaitWork()) a newly waiting worker is added to the wait
213	>	* queue. During a rescan, the worker might release some other
214	>	* queued worker rather than itself, which has the same net
215	>	* effect. Because enqueued workers may actually be rescanning
216	>	* rather than waiting, we set and clear the "parked" field of
217	>	* ForkJoinWorkerThread to reduce unnecessary calls to unpark.
218	>	* (Use of the parked field requires a secondary recheck to avoid
219	>	* missed signals.)
220	>	*
221	>	* Signalling.  We create or wake up workers only when there
222	>	* appears to be at least one task they might be able to find and
223	>	* execute.  When a submission is added or another worker adds a
224	>	* task to a queue that previously had two or fewer tasks, they
225	>	* signal waiting workers (or trigger creation of new ones if
226	>	* fewer than the given parallelism level -- see signalWork).
227	>	* These primary signals are buttressed by signals during rescans
228	>	* as well as those performed when a worker steals a task and
229	>	* notices that there are more tasks too; together these cover the
230	>	* signals needed in cases when more than two tasks are pushed
231	>	* but untaken.
232	>	*
233	>	* Trimming workers. To release resources after periods of lack of
234	>	* use, a worker starting to wait when the pool is quiescent will
235	>	* time out and terminate if the pool has remained quiescent for
236	>	* SHRINK_RATE nanosecs. This will slowly propagate, eventually
237	>	* terminating all workers after long periods of non-use.
238	>	*
239	>	* Submissions. External submissions are maintained in an
240	>	* array-based queue that is structured identically to
241	>	* ForkJoinWorkerThread queues except for the use of
242	>	* submissionLock in method addSubmission. Unlike the case for
243	>	* worker queues, multiple external threads can add new
244	>	* submissions, so adding requires a lock.
245	>	*
246	>	* Compensation. Beyond work-stealing support and lifecycle
247	>	* control, the main responsibility of this framework is to take
248	>	* actions when one worker is waiting to join a task stolen (or
249	>	* always held by) another.  Because we are multiplexing many
250	>	* tasks on to a pool of workers, we can't just let them block (as
251	>	* in Thread.join).  We also cannot just reassign the joiner's
252	>	* run-time stack with another and replace it later, which would
253	>	* be a form of "continuation", that even if possible is not
254	>	* necessarily a good idea since we sometimes need both an
255	>	* unblocked task and its continuation to progress. Instead we
256	>	* combine two tactics:
257	>	*
258	>	*   Helping: Arranging for the joiner to execute some task that it
259	>	*      would be running if the steal had not occurred.  Method
260	>	*      ForkJoinWorkerThread.joinTask tracks joining->stealing
261	>	*      links to try to find such a task.
262	>	*
263	>	*   Compensating: Unless there are already enough live threads,
264	>	*      method tryPreBlock() may create or re-activate a spare
265	>	*      thread to compensate for blocked joiners until they
266	>	*      unblock.
267	>	*
268	>	* The ManagedBlocker extension API can't use helping so relies
269	>	* only on compensation in method awaitBlocker.
270	>	*
271	>	* It is impossible to keep exactly the target parallelism number
272	>	* of threads running at any given time.  Determining the
273	>	* existence of conservatively safe helping targets, the
274	>	* availability of already-created spares, and the apparent need
275	>	* to create new spares are all racy and require heuristic
276	>	* guidance, so we rely on multiple retries of each.  Currently,
277	>	* in keeping with on-demand signalling policy, we compensate only
278	>	* if blocking would leave less than one active (non-waiting,
279	>	* non-blocked) worker. Additionally, to avoid some false alarms
280	>	* due to GC, lagging counters, system activity, etc, compensated
281	>	* blocking for joins is only attempted after rechecks stabilize
282	>	* (retries are interspersed with Thread.yield, for good
283	>	* citizenship).  The variable blockedCount, incremented before
284	>	* blocking and decremented after, is sometimes needed to
285	>	* distinguish cases of waiting for work vs blocking on joins or
286	>	* other managed sync. Both cases are equivalent for most pool
287	>	* control, so we can update non-atomically. (Additionally,
288	>	* contention on blockedCount alleviates some contention on ctl).
289	>	*
290	>	* Shutdown and Termination. A call to shutdownNow atomically sets
291	>	* the ctl stop bit and then (non-atomically) sets each workers
292	>	* "terminate" status, cancels all unprocessed tasks, and wakes up
293	>	* all waiting workers.  Detecting whether termination should
294	>	* commence after a non-abrupt shutdown() call requires more work
295	>	* and bookkeeping. We need consensus about quiesence (i.e., that
296	>	* there is no more work) which is reflected in active counts so
297	>	* long as there are no current blockers, as well as possible
298	>	* re-evaluations during independent changes in blocking or
299	>	* quiescing workers.
300		*
301	<	* Beware that there is a lot of representation-level coupling
301	>	* Style notes: There is a lot of representation-level coupling
302		* among classes ForkJoinPool, ForkJoinWorkerThread, and
303	<	* ForkJoinTask.  For example, direct access to "workers" array by
303	>	* ForkJoinTask.  Most fields of ForkJoinWorkerThread maintain
304	>	* data structures managed by ForkJoinPool, so are directly
305	>	* accessed.  Conversely we allow access to "workers" array by
306		* workers, and direct access to ForkJoinTask.status by both
307		* ForkJoinPool and ForkJoinWorkerThread.  There is little point
308		* trying to reduce this, since any associated future changes in
309		* representations will need to be accompanied by algorithmic
310	<	* changes anyway.
311	<	*
312	<	* Style notes: There are lots of inline assignments (of form
313	<	* "while ((local = field) != 0)") which are usually the simplest
314	<	* way to ensure read orderings. Also several occurrences of the
315	<	* unusual "do {} while(!cas...)" which is the simplest way to
316	<	* force an update of a CAS'ed variable. There are also a few
317	<	* other coding oddities that help some methods perform reasonably
318	<	* even when interpreted (not compiled).
319	<	*
320	<	* The order of declarations in this file is: (1) statics (2)
321	<	* fields (along with constants used when unpacking some of them)
322	<	* (3) internal control methods (4) callbacks and other support
323	<	* for ForkJoinTask and ForkJoinWorkerThread classes, (5) exported
324	<	* methods (plus a few little helpers).
310	>	* changes anyway. All together, these low-level implementation
311	>	* choices produce as much as a factor of 4 performance
312	>	* improvement compared to naive implementations, and enable the
313	>	* processing of billions of tasks per second, at the expense of
314	>	* some ugliness.
315	>	*
316	>	* Methods signalWork() and scan() are the main bottlenecks so are
317	>	* especially heavily micro-optimized/mangled.  There are lots of
318	>	* inline assignments (of form "while ((local = field) != 0)")
319	>	* which are usually the simplest way to ensure the required read
320	>	* orderings (which are sometimes critical). This leads to a
321	>	* "C"-like style of listing declarations of these locals at the
322	>	* heads of methods or blocks.  There are several occurrences of
323	>	* the unusual "do {} while (!cas...)"  which is the simplest way
324	>	* to force an update of a CAS'ed variable. There are also other
325	>	* coding oddities that help some methods perform reasonably even
326	>	* when interpreted (not compiled).
327	>	*
328	>	* The order of declarations in this file is: (1) declarations of
329	>	* statics (2) fields (along with constants used when unpacking
330	>	* some of them), listed in an order that tends to reduce
331	>	* contention among them a bit under most JVMs.  (3) internal
332	>	* control methods (4) callbacks and other support for
333	>	* ForkJoinTask and ForkJoinWorkerThread classes, (5) exported
334	>	* methods (plus a few little helpers). (6) static block
335	>	* initializing all statics in a minimally dependent order.
336		*/
337
338		/**
#	Line 345 | Line 355 | public class ForkJoinPool extends Abstra
355		* Default ForkJoinWorkerThreadFactory implementation; creates a
356		* new ForkJoinWorkerThread.
357		*/
358	<	static class  DefaultForkJoinWorkerThreadFactory
358	>	static class DefaultForkJoinWorkerThreadFactory
359		implements ForkJoinWorkerThreadFactory {
360		public ForkJoinWorkerThread newThread(ForkJoinPool pool) {
361		return new ForkJoinWorkerThread(pool);
#	Line 357 | Line 367 | public class ForkJoinPool extends Abstra
367		* overridden in ForkJoinPool constructors.
368		*/
369		public static final ForkJoinWorkerThreadFactory
370	<	defaultForkJoinWorkerThreadFactory =
361	<	new DefaultForkJoinWorkerThreadFactory();
370	>	defaultForkJoinWorkerThreadFactory;
371
372		/**
373		* Permission required for callers of methods that may start or
374		* kill threads.
375		*/
376	<	private static final RuntimePermission modifyThreadPermission =
368	<	new RuntimePermission("modifyThread");
376	>	private static final RuntimePermission modifyThreadPermission;
377
378		/**
379		* If there is a security manager, makes sure caller has
#	Line 380 | Line 388 | public class ForkJoinPool extends Abstra
388		/**
389		* Generator for assigning sequence numbers as pool names.
390		*/
391	<	private static final AtomicInteger poolNumberGenerator =
392	<	new AtomicInteger();
391	>	private static final AtomicInteger poolNumberGenerator;
392	>
393	>	/**
394	>	* Generator for initial random seeds for worker victim
395	>	* selection. This is used only to create initial seeds. Random
396	>	* steals use a cheaper xorshift generator per steal attempt. We
397	>	* don't expect much contention on seedGenerator, so just use a
398	>	* plain Random.
399	>	*/
400	>	static final Random workerSeedGenerator;
401
402		/**
403	<	* Absolute bound for parallelism level. Twice this number must
404	<	* fit into a 16bit field to enable word-packing for some counts.
403	>	* Array holding all worker threads in the pool.  Initialized upon
404	>	* construction. Array size must be a power of two.  Updates and
405	>	* replacements are protected by scanGuard, but the array is
406	>	* always kept in a consistent enough state to be randomly
407	>	* accessed without locking by workers performing work-stealing,
408	>	* as well as other traversal-based methods in this class, so long
409	>	* as reads memory-acquire by first reading ctl. All readers must
410	>	* tolerate that some array slots may be null.
411		*/
412	<	private static final int MAX_THREADS = 0x7fff;
412	>	ForkJoinWorkerThread[] workers;
413
414		/**
415	<	* Array holding all worker threads in the pool.  Array size must
416	<	* be a power of two.  Updates and replacements are protected by
417	<	* workerLock, but the array is always kept in a consistent enough
396	<	* state to be randomly accessed without locking by workers
397	<	* performing work-stealing, as well as other traversal-based
398	<	* methods in this class. All readers must tolerate that some
399	<	* array slots may be null.
415	>	* Initial size for submission queue array. Must be a power of
416	>	* two.  In many applications, these always stay small so we use a
417	>	* small initial cap.
418		*/
419	<	volatile ForkJoinWorkerThread[] workers;
419	>	private static final int INITIAL_QUEUE_CAPACITY = 8;
420
421		/**
422	<	* Queue for external submissions.
422	>	* Maximum size for submission queue array. Must be a power of two
423	>	* less than or equal to 1 << (31 - width of array entry) to
424	>	* ensure lack of index wraparound, but is capped at a lower
425	>	* value to help users trap runaway computations.
426		*/
427	<	private final LinkedTransferQueue<ForkJoinTask<?>> submissionQueue;
427	>	private static final int MAXIMUM_QUEUE_CAPACITY = 1 << 24; // 16M
428
429		/**
430	<	* Lock protecting updates to workers array.
430	>	* Array serving as submission queue. Initialized upon construction.
431		*/
432	<	private final ReentrantLock workerLock;
432	>	private ForkJoinTask<?>[] submissionQueue;
433
434		/**
435	<	* Latch released upon termination.
435	>	* Lock protecting submissions array for addSubmission
436		*/
437	<	private final CountDownLatch terminationLatch;
437	>	private final ReentrantLock submissionLock;
438	>
439	>	/**
440	>	* Condition for awaitTermination, using submissionLock for
441	>	* convenience.
442	>	*/
443	>	private final Condition termination;
444
445		/**
446		* Creation factory for worker threads.
#	Line 421 | Line 448 | public class ForkJoinPool extends Abstra
448		private final ForkJoinWorkerThreadFactory factory;
449
450		/**
451	+	* The uncaught exception handler used when any worker abruptly
452	+	* terminates.
453	+	*/
454	+	final Thread.UncaughtExceptionHandler ueh;
455	+
456	+	/**
457	+	* Prefix for assigning names to worker threads
458	+	*/
459	+	private final String workerNamePrefix;
460	+
461	+	/**
462		* Sum of per-thread steal counts, updated only when threads are
463		* idle or terminating.
464		*/
465		private volatile long stealCount;
466
467		/**
468	<	* Encoded record of top of treiber stack of threads waiting for
469	<	* events. The top 32 bits contain the count being waited for. The
470	<	* bottom word contains one plus the pool index of waiting worker
471	<	* thread.
472	<	*/
473	<	private volatile long eventWaiters;
474	<
475	<	private static final int  EVENT_COUNT_SHIFT = 32;
476	<	private static final long WAITER_INDEX_MASK = (1L << EVENT_COUNT_SHIFT)-1L;
477	<
478	<	/**
479	<	* A counter for events that may wake up worker threads:
480	<	*   - Submission of a new task to the pool
481	<	*   - A worker pushing a task on an empty queue
482	<	*   - termination and reconfiguration
483	<	*/
484	<	private volatile int eventCount;
485	<
486	<	/**
487	<	* Lifecycle control. The low word contains the number of workers
488	<	* that are (probably) executing tasks. This value is atomically
489	<	* incremented before a worker gets a task to run, and decremented
490	<	* when worker has no tasks and cannot find any.  Bits 16-18
491	<	* contain runLevel value. When all are zero, the pool is
492	<	* running. Level transitions are monotonic (running -> shutdown
493	<	* -> terminating -> terminated) so each transition adds a bit.
494	<	* These are bundled together to ensure consistent read for
495	<	* termination checks (i.e., that runLevel is at least SHUTDOWN
496	<	* and active threads is zero).
497	<	*/
498	<	private volatile int runState;
499	<
500	<	// Note: The order among run level values matters.
501	<	private static final int RUNLEVEL_SHIFT     = 16;
502	<	private static final int SHUTDOWN           = 1 << RUNLEVEL_SHIFT;
503	<	private static final int TERMINATING        = 1 << (RUNLEVEL_SHIFT + 1);
504	<	private static final int TERMINATED         = 1 << (RUNLEVEL_SHIFT + 2);
505	<	private static final int ACTIVE_COUNT_MASK  = (1 << RUNLEVEL_SHIFT) - 1;
506	<	private static final int ONE_ACTIVE         = 1; // active update delta
507	<
508	<	/**
509	<	* Holds number of total (i.e., created and not yet terminated)
510	<	* and running (i.e., not blocked on joins or other managed sync)
511	<	* threads, packed together to ensure consistent snapshot when
512	<	* making decisions about creating and suspending spare
513	<	* threads. Updated only by CAS. Note that adding a new worker
514	<	* requires incrementing both counts, since workers start off in
515	<	* running state.  This field is also used for memory-fencing
516	<	* configuration parameters.
517	<	*/
518	<	private volatile int workerCounts;
519	<
520	<	private static final int TOTAL_COUNT_SHIFT  = 16;
521	<	private static final int RUNNING_COUNT_MASK = (1 << TOTAL_COUNT_SHIFT) - 1;
484	<	private static final int ONE_RUNNING        = 1;
485	<	private static final int ONE_TOTAL          = 1 << TOTAL_COUNT_SHIFT;
468	>	* Main pool control -- a long packed with:
469	>	* AC: Number of active running workers minus target parallelism (16 bits)
470	>	* TC: Number of total workers minus target parallelism (16bits)
471	>	* ST: true if pool is terminating (1 bit)
472	>	* EC: the wait count of top waiting thread (15 bits)
473	>	* ID: ~poolIndex of top of Treiber stack of waiting threads (16 bits)
474	>	*
475	>	* When convenient, we can extract the upper 32 bits of counts and
476	>	* the lower 32 bits of queue state, u = (int)(ctl >>> 32) and e =
477	>	* (int)ctl.  The ec field is never accessed alone, but always
478	>	* together with id and st. The offsets of counts by the target
479	>	* parallelism and the positionings of fields makes it possible to
480	>	* perform the most common checks via sign tests of fields: When
481	>	* ac is negative, there are not enough active workers, when tc is
482	>	* negative, there are not enough total workers, when id is
483	>	* negative, there is at least one waiting worker, and when e is
484	>	* negative, the pool is terminating.  To deal with these possibly
485	>	* negative fields, we use casts in and out of "short" and/or
486	>	* signed shifts to maintain signedness.
487	>	*/
488	>	volatile long ctl;
489	>
490	>	// bit positions/shifts for fields
491	>	private static final int  AC_SHIFT   = 48;
492	>	private static final int  TC_SHIFT   = 32;
493	>	private static final int  ST_SHIFT   = 31;
494	>	private static final int  EC_SHIFT   = 16;
495	>
496	>	// bounds
497	>	private static final int  MAX_ID     = 0x7fff;  // max poolIndex
498	>	private static final int  SMASK      = 0xffff;  // mask short bits
499	>	private static final int  SHORT_SIGN = 1 << 15;
500	>	private static final int  INT_SIGN   = 1 << 31;
501	>
502	>	// masks
503	>	private static final long STOP_BIT   = 0x0001L << ST_SHIFT;
504	>	private static final long AC_MASK    = ((long)SMASK) << AC_SHIFT;
505	>	private static final long TC_MASK    = ((long)SMASK) << TC_SHIFT;
506	>
507	>	// units for incrementing and decrementing
508	>	private static final long TC_UNIT    = 1L << TC_SHIFT;
509	>	private static final long AC_UNIT    = 1L << AC_SHIFT;
510	>
511	>	// masks and units for dealing with u = (int)(ctl >>> 32)
512	>	private static final int  UAC_SHIFT  = AC_SHIFT - 32;
513	>	private static final int  UTC_SHIFT  = TC_SHIFT - 32;
514	>	private static final int  UAC_MASK   = SMASK << UAC_SHIFT;
515	>	private static final int  UTC_MASK   = SMASK << UTC_SHIFT;
516	>	private static final int  UAC_UNIT   = 1 << UAC_SHIFT;
517	>	private static final int  UTC_UNIT   = 1 << UTC_SHIFT;
518	>
519	>	// masks and units for dealing with e = (int)ctl
520	>	private static final int  E_MASK     = 0x7fffffff; // no STOP_BIT
521	>	private static final int  EC_UNIT    = 1 << EC_SHIFT;
522
523	<	/*
524	<	* Fields parallelism. maxPoolSize, locallyFifo,
489	<	* maintainsParallelism, and ueh are non-volatile, but external
490	<	* reads/writes use workerCount fences to ensure visability.
523	>	/**
524	>	* The target parallelism level.
525		*/
526	+	final int parallelism;
527
528		/**
529	<	* The target parallelism level.
529	>	* Index (mod submission queue length) of next element to take
530	>	* from submission queue. Usage is identical to that for
531	>	* per-worker queues -- see ForkJoinWorkerThread internal
532	>	* documentation.
533		*/
534	<	private int parallelism;
534	>	volatile int queueBase;
535
536		/**
537	<	* The maximum allowed pool size.
537	>	* Index (mod submission queue length) of next element to add
538	>	* in submission queue. Usage is identical to that for
539	>	* per-worker queues -- see ForkJoinWorkerThread internal
540	>	* documentation.
541		*/
542	<	private int maxPoolSize;
542	>	int queueTop;
543
544		/**
545	<	* True if use local fifo, not default lifo, for local polling
505	<	* Replicated by ForkJoinWorkerThreads
545	>	* True when shutdown() has been called.
546		*/
547	<	private boolean locallyFifo;
547	>	volatile boolean shutdown;
548
549		/**
550	<	* Controls whether to add spares to maintain parallelism
550	>	* True if use local fifo, not default lifo, for local polling
551	>	* Read by, and replicated by ForkJoinWorkerThreads
552		*/
553	<	private boolean maintainsParallelism;
553	>	final boolean locallyFifo;
554
555		/**
556	<	* The uncaught exception handler used when any worker
557	<	* abruptly terminates
556	>	* The number of threads in ForkJoinWorkerThreads.helpQuiescePool.
557	>	* When non-zero, suppresses automatic shutdown when active
558	>	* counts become zero.
559		*/
560	<	private Thread.UncaughtExceptionHandler ueh;
560	>	volatile int quiescerCount;
561
562		/**
563	<	* Pool number, just for assigning useful names to worker threads
563	>	* The number of threads blocked in join.
564		*/
565	<	private final int poolNumber;
565	>	volatile int blockedCount;
566
567	<	// utilities for updating fields
567	>	/**
568	>	* Counter for worker Thread names (unrelated to their poolIndex)
569	>	*/
570	>	private volatile int nextWorkerNumber;
571
572		/**
573	<	* Adds delta to running count.  Used mainly by ForkJoinTask.
529	<	*
530	<	* @param delta the number to add
573	>	* The index for the next created worker. Accessed under scanGuard.
574		*/
575	<	final void updateRunningCount(int delta) {
533	<	int wc;
534	<	do {} while (!UNSAFE.compareAndSwapInt(this, workerCountsOffset,
535	<	wc = workerCounts,
536	<	wc + delta));
537	<	}
575	>	private int nextWorkerIndex;
576
577		/**
578	<	* Write fence for user modifications of pool parameters
579	<	* (parallelism. etc).  Note that it doesn't matter if CAS fails.
578	>	* SeqLock and index masking for updates to workers array.  Locked
579	>	* when SG_UNIT is set. Unlocking clears bit by adding
580	>	* SG_UNIT. Staleness of read-only operations can be checked by
581	>	* comparing scanGuard to value before the reads. The low 16 bits
582	>	* (i.e, anding with SMASK) hold (the smallest power of two
583	>	* covering all worker indices, minus one, and is used to avoid
584	>	* dealing with large numbers of null slots when the workers array
585	>	* is overallocated.
586		*/
587	<	private void workerCountWriteFence() {
588	<	int wc;
589	<	UNSAFE.compareAndSwapInt(this, workerCountsOffset,
546	<	wc = workerCounts, wc);
547	<	}
587	>	volatile int scanGuard;
588	>
589	>	private static final int SG_UNIT = 1 << 16;
590
591		/**
592	<	* Read fence for external reads of pool parameters
593	<	* (parallelism. maxPoolSize, etc).
592	>	* The wakeup interval (in nanoseconds) for a worker waiting for a
593	>	* task when the pool is quiescent to instead try to shrink the
594	>	* number of workers.  The exact value does not matter too
595	>	* much. It must be short enough to release resources during
596	>	* sustained periods of idleness, but not so short that threads
597	>	* are continually re-created.
598		*/
599	<	private void workerCountReadFence() {
600	<	int ignore = workerCounts;
555	<	}
599	>	private static final long SHRINK_RATE =
600	>	4L * 1000L * 1000L * 1000L; // 4 seconds
601
602		/**
603	<	* Tries incrementing active count; fails on contention.
604	<	* Called by workers before executing tasks.
603	>	* Top-level loop for worker threads: On each step: if the
604	>	* previous step swept through all queues and found no tasks, or
605	>	* there are excess threads, then possibly blocks. Otherwise,
606	>	* scans for and, if found, executes a task. Returns when pool
607	>	* and/or worker terminate.
608		*
609	<	* @return true on success
609	>	* @param w the worker
610		*/
611	<	final boolean tryIncrementActiveCount() {
612	<	int c;
613	<	return UNSAFE.compareAndSwapInt(this, runStateOffset,
614	<	c = runState, c + ONE_ACTIVE);
611	>	final void work(ForkJoinWorkerThread w) {
612	>	boolean swept = false;                // true on empty scans
613	>	long c;
614	>	while (!w.terminate && (int)(c = ctl) >= 0) {
615	>	int a;                            // active count
616	>	if (!swept && (a = (int)(c >> AC_SHIFT)) <= 0)
617	>	swept = scan(w, a);
618	>	else if (tryAwaitWork(w, c))
619	>	swept = false;
620	>	}
621		}
622
623	+	// Signalling
624	+
625		/**
626	<	* Tries decrementing active count; fails on contention.
571	<	* Called when workers cannot find tasks to run.
626	>	* Wakes up or creates a worker.
627		*/
628	<	final boolean tryDecrementActiveCount() {
629	<	int c;
630	<	return UNSAFE.compareAndSwapInt(this, runStateOffset,
631	<	c = runState, c - ONE_ACTIVE);
628	>	final void signalWork() {
629	>	/*
630	>	* The while condition is true if: (there is are too few total
631	>	* workers OR there is at least one waiter) AND (there are too
632	>	* few active workers OR the pool is terminating).  The value
633	>	* of e distinguishes the remaining cases: zero (no waiters)
634	>	* for create, negative if terminating (in which case do
635	>	* nothing), else release a waiter. The secondary checks for
636	>	* release (non-null array etc) can fail if the pool begins
637	>	* terminating after the test, and don't impose any added cost
638	>	* because JVMs must perform null and bounds checks anyway.
639	>	*/
640	>	long c; int e, u;
641	>	while ((((e = (int)(c = ctl)) | (u = (int)(c >>> 32))) &
642	>	(INT_SIGN|SHORT_SIGN)) == (INT_SIGN|SHORT_SIGN) && e >= 0) {
643	>	if (e > 0) {                         // release a waiting worker
644	>	int i; ForkJoinWorkerThread w; ForkJoinWorkerThread[] ws;
645	>	if ((ws = workers) == null ||
646	>	(i = ~e & SMASK) >= ws.length ||
647	>	(w = ws[i]) == null)
648	>	break;
649	>	long nc = (((long)(w.nextWait & E_MASK)) |
650	>	((long)(u + UAC_UNIT) << 32));
651	>	if (w.eventCount == e &&
652	>	UNSAFE.compareAndSwapLong(this, ctlOffset, c, nc)) {
653	>	w.eventCount = (e + EC_UNIT) & E_MASK;
654	>	if (w.parked)
655	>	UNSAFE.unpark(w);
656	>	break;
657	>	}
658	>	}
659	>	else if (UNSAFE.compareAndSwapLong
660	>	(this, ctlOffset, c,
661	>	(long)(((u + UTC_UNIT) & UTC_MASK) |
662	>	((u + UAC_UNIT) & UAC_MASK)) << 32)) {
663	>	addWorker();
664	>	break;
665	>	}
666	>	}
667		}
668
669		/**
670	<	* Advances to at least the given level. Returns true if not
671	<	* already in at least the given level.
670	>	* Variant of signalWork to help release waiters on rescans.
671	>	* Tries once to release a waiter if active count < 0.
672	>	*
673	>	* @return false if failed due to contention, else true
674		*/
675	<	private boolean advanceRunLevel(int level) {
676	<	for (;;) {
677	<	int s = runState;
678	<	if ((s & level) != 0)
675	>	private boolean tryReleaseWaiter() {
676	>	long c; int e, i; ForkJoinWorkerThread w; ForkJoinWorkerThread[] ws;
677	>	if ((e = (int)(c = ctl)) > 0 &&
678	>	(int)(c >> AC_SHIFT) < 0 &&
679	>	(ws = workers) != null &&
680	>	(i = ~e & SMASK) < ws.length &&
681	>	(w = ws[i]) != null) {
682	>	long nc = ((long)(w.nextWait & E_MASK) |
683	>	((c + AC_UNIT) & (AC_MASK|TC_MASK)));
684	>	if (w.eventCount != e ||
685	>	!UNSAFE.compareAndSwapLong(this, ctlOffset, c, nc))
686		return false;
687	<	if (UNSAFE.compareAndSwapInt(this, runStateOffset, s, s | level))
688	<	return true;
687	>	w.eventCount = (e + EC_UNIT) & E_MASK;
688	>	if (w.parked)
689	>	UNSAFE.unpark(w);
690		}
691	+	return true;
692		}
693
694	<	// workers array maintenance
694	>	// Scanning for tasks
695
696		/**
697	<	* Records and returns a workers array index for new worker.
697	>	* Scans for and, if found, executes one task. Scans start at a
698	>	* random index of workers array, and randomly select the first
699	>	* (2*#workers)-1 probes, and then, if all empty, resort to 2
700	>	* circular sweeps, which is necessary to check quiescence. and
701	>	* taking a submission only if no stealable tasks were found.  The
702	>	* steal code inside the loop is a specialized form of
703	>	* ForkJoinWorkerThread.deqTask, followed bookkeeping to support
704	>	* helpJoinTask and signal propagation. The code for submission
705	>	* queues is almost identical. On each steal, the worker completes
706	>	* not only the task, but also all local tasks that this task may
707	>	* have generated. On detecting staleness or contention when
708	>	* trying to take a task, this method returns without finishing
709	>	* sweep, which allows global state rechecks before retry.
710	>	*
711	>	* @param w the worker
712	>	* @param a the number of active workers
713	>	* @return true if swept all queues without finding a task
714		*/
715	<	private int recordWorker(ForkJoinWorkerThread w) {
716	<	// Try using slot totalCount-1. If not available, scan and/or resize
717	<	int k = (workerCounts >>> TOTAL_COUNT_SHIFT) - 1;
718	<	final ReentrantLock lock = this.workerLock;
719	<	lock.lock();
720	<	try {
721	<	ForkJoinWorkerThread[] ws = workers;
722	<	int len = ws.length;
723	<	if (k < 0 || k >= len || ws[k] != null) {
724	<	for (k = 0; k < len && ws[k] != null; ++k)
725	<	;
726	<	if (k == len)
727	<	ws = Arrays.copyOf(ws, len << 1);
715	>	private boolean scan(ForkJoinWorkerThread w, int a) {
716	>	int g = scanGuard; // mask 0 avoids useless scans if only one active
717	>	int m = (parallelism == 1 - a && blockedCount == 0) ? 0 : g & SMASK;
718	>	ForkJoinWorkerThread[] ws = workers;
719	>	if (ws == null || ws.length <= m)         // staleness check
720	>	return false;
721	>	for (int r = w.seed, k = r, j = -(m + m); j <= m + m; ++j) {
722	>	ForkJoinTask<?> t; ForkJoinTask<?>[] q; int b, i;
723	>	ForkJoinWorkerThread v = ws[k & m];
724	>	if (v != null && (b = v.queueBase) != v.queueTop &&
725	>	(q = v.queue) != null && (i = (q.length - 1) & b) >= 0) {
726	>	long u = (i << ASHIFT) + ABASE;
727	>	if ((t = q[i]) != null && v.queueBase == b &&
728	>	UNSAFE.compareAndSwapObject(q, u, t, null)) {
729	>	int d = (v.queueBase = b + 1) - v.queueTop;
730	>	v.stealHint = w.poolIndex;
731	>	if (d != 0)
732	>	signalWork();             // propagate if nonempty
733	>	w.execTask(t);
734	>	}
735	>	r ^= r << 13; r ^= r >>> 17; w.seed = r ^ (r << 5);
736	>	return false;                     // store next seed
737		}
738	<	ws[k] = w;
739	<	workers = ws; // volatile array write ensures slot visibility
740	<	} finally {
741	<	lock.unlock();
738	>	else if (j < 0) {                     // xorshift
739	>	r ^= r << 13; r ^= r >>> 17; k = r ^= r << 5;
740	>	}
741	>	else
742	>	++k;
743	>	}
744	>	if (scanGuard != g)                       // staleness check
745	>	return false;
746	>	else {                                    // try to take submission
747	>	ForkJoinTask<?> t; ForkJoinTask<?>[] q; int b, i;
748	>	if ((b = queueBase) != queueTop &&
749	>	(q = submissionQueue) != null &&
750	>	(i = (q.length - 1) & b) >= 0) {
751	>	long u = (i << ASHIFT) + ABASE;
752	>	if ((t = q[i]) != null && queueBase == b &&
753	>	UNSAFE.compareAndSwapObject(q, u, t, null)) {
754	>	queueBase = b + 1;
755	>	w.execTask(t);
756	>	}
757	>	return false;
758	>	}
759	>	return true;                         // all queues empty
760		}
617	–	return k;
761		}
762
763		/**
764	<	* Nulls out record of worker in workers array
765	<	*/
766	<	private void forgetWorker(ForkJoinWorkerThread w) {
767	<	int idx = w.poolIndex;
768	<	// Locking helps method recordWorker avoid unecessary expansion
769	<	final ReentrantLock lock = this.workerLock;
770	<	lock.lock();
771	<	try {
772	<	ForkJoinWorkerThread[] ws = workers;
773	<	if (idx >= 0 && idx < ws.length && ws[idx] == w) // verify
774	<	ws[idx] = null;
775	<	} finally {
776	<	lock.unlock();
764	>	* Tries to enqueue worker w in wait queue and await change in
765	>	* worker's eventCount.  If the pool is quiescent, possibly
766	>	* terminates worker upon exit.  Otherwise, before blocking,
767	>	* rescans queues to avoid missed signals.  Upon finding work,
768	>	* releases at least one worker (which may be the current
769	>	* worker). Rescans restart upon detected staleness or failure to
770	>	* release due to contention. Note the unusual conventions about
771	>	* Thread.interrupt here and elsewhere: Because interrupts are
772	>	* used solely to alert threads to check termination, which is
773	>	* checked here anyway, we clear status (using Thread.interrupted)
774	>	* before any call to park, so that park does not immediately
775	>	* return due to status being set via some other unrelated call to
776	>	* interrupt in user code.
777	>	*
778	>	* @param w the calling worker
779	>	* @param c the ctl value on entry
780	>	* @return true if waited or another thread was released upon enq
781	>	*/
782	>	private boolean tryAwaitWork(ForkJoinWorkerThread w, long c) {
783	>	int v = w.eventCount;
784	>	w.nextWait = (int)c;                      // w's successor record
785	>	long nc = (long)(v & E_MASK) | ((c - AC_UNIT) & (AC_MASK|TC_MASK));
786	>	if (ctl != c || !UNSAFE.compareAndSwapLong(this, ctlOffset, c, nc)) {
787	>	long d = ctl; // return true if lost to a deq, to force scan
788	>	return (int)d != (int)c && ((d - c) & AC_MASK) >= 0L;
789	>	}
790	>	for (int sc = w.stealCount; sc != 0;) {   // accumulate stealCount
791	>	long s = stealCount;
792	>	if (UNSAFE.compareAndSwapLong(this, stealCountOffset, s, s + sc))
793	>	sc = w.stealCount = 0;
794	>	else if (w.eventCount != v)
795	>	return true;                      // update next time
796	>	}
797	>	if (parallelism + (int)(nc >> AC_SHIFT) == 0 &&
798	>	blockedCount == 0 && quiescerCount == 0)
799	>	idleAwaitWork(w, nc, c, v);           // quiescent
800	>	for (boolean rescanned = false;;) {
801	>	if (w.eventCount != v)
802	>	return true;
803	>	if (!rescanned) {
804	>	int g = scanGuard, m = g & SMASK;
805	>	ForkJoinWorkerThread[] ws = workers;
806	>	if (ws != null && m < ws.length) {
807	>	rescanned = true;
808	>	for (int i = 0; i <= m; ++i) {
809	>	ForkJoinWorkerThread u = ws[i];
810	>	if (u != null) {
811	>	if (u.queueBase != u.queueTop &&
812	>	!tryReleaseWaiter())
813	>	rescanned = false; // contended
814	>	if (w.eventCount != v)
815	>	return true;
816	>	}
817	>	}
818	>	}
819	>	if (scanGuard != g ||              // stale
820	>	(queueBase != queueTop && !tryReleaseWaiter()))
821	>	rescanned = false;
822	>	if (!rescanned)
823	>	Thread.yield();                // reduce contention
824	>	else
825	>	Thread.interrupted();          // clear before park
826	>	}
827	>	else {
828	>	w.parked = true;                   // must recheck
829	>	if (w.eventCount != v) {
830	>	w.parked = false;
831	>	return true;
832	>	}
833	>	LockSupport.park(this);
834	>	rescanned = w.parked = false;
835	>	}
836		}
837		}
838
839	<	// adding and removing workers
839	>	/**
840	>	* If inactivating worker w has caused pool to become
841	>	* quiescent, check for pool termination, and wait for event
842	>	* for up to SHRINK_RATE nanosecs (rescans are unnecessary in
843	>	* this case because quiescence reflects consensus about lack
844	>	* of work). On timeout, if ctl has not changed, terminate the
845	>	* worker. Upon its termination (see deregisterWorker), it may
846	>	* wake up another worker to possibly repeat this process.
847	>	*
848	>	* @param w the calling worker
849	>	* @param currentCtl the ctl value after enqueuing w
850	>	* @param prevCtl the ctl value if w terminated
851	>	* @param v the eventCount w awaits change
852	>	*/
853	>	private void idleAwaitWork(ForkJoinWorkerThread w, long currentCtl,
854	>	long prevCtl, int v) {
855	>	if (w.eventCount == v) {
856	>	if (shutdown)
857	>	tryTerminate(false);
858	>	ForkJoinTask.helpExpungeStaleExceptions(); // help clean weak refs
859	>	while (ctl == currentCtl) {
860	>	long startTime = System.nanoTime();
861	>	w.parked = true;
862	>	if (w.eventCount == v)             // must recheck
863	>	LockSupport.parkNanos(this, SHRINK_RATE);
864	>	w.parked = false;
865	>	if (w.eventCount != v)
866	>	break;
867	>	else if (System.nanoTime() - startTime < SHRINK_RATE)
868	>	Thread.interrupted();          // spurious wakeup
869	>	else if (UNSAFE.compareAndSwapLong(this, ctlOffset,
870	>	currentCtl, prevCtl)) {
871	>	w.terminate = true;            // restore previous
872	>	w.eventCount = ((int)currentCtl + EC_UNIT) & E_MASK;
873	>	break;
874	>	}
875	>	}
876	>	}
877	>	}
878	>
879	>	// Submissions
880
881		/**
882	<	* Tries to create and add new worker. Assumes that worker counts
883	<	* are already updated to accommodate the worker, so adjusts on
642	<	* failure.
882	>	* Enqueues the given task in the submissionQueue.  Same idea as
883	>	* ForkJoinWorkerThread.pushTask except for use of submissionLock.
884		*
885	<	* @return new worker or null if creation failed
885	>	* @param t the task
886		*/
887	<	private ForkJoinWorkerThread addWorker() {
888	<	ForkJoinWorkerThread w = null;
887	>	private void addSubmission(ForkJoinTask<?> t) {
888	>	final ReentrantLock lock = this.submissionLock;
889	>	lock.lock();
890		try {
891	<	w = factory.newThread(this);
892	<	} finally { // Adjust on either null or exceptional factory return
893	<	if (w == null) {
894	<	onWorkerCreationFailure();
895	<	return null;
891	>	ForkJoinTask<?>[] q; int s, m;
892	>	if ((q = submissionQueue) != null) {    // ignore if queue removed
893	>	long u = (((s = queueTop) & (m = q.length-1)) << ASHIFT)+ABASE;
894	>	UNSAFE.putOrderedObject(q, u, t);
895	>	queueTop = s + 1;
896	>	if (s - queueBase == m)
897	>	growSubmissionQueue();
898		}
899	+	} finally {
900	+	lock.unlock();
901		}
902	<	w.start(recordWorker(w), locallyFifo, ueh);
657	<	return w;
902	>	signalWork();
903		}
904
905	<	/**
661	<	* Adjusts counts upon failure to create worker
662	<	*/
663	<	private void onWorkerCreationFailure() {
664	<	int c;
665	<	do {} while (!UNSAFE.compareAndSwapInt(this, workerCountsOffset,
666	<	c = workerCounts,
667	<	c - (ONE_RUNNING|ONE_TOTAL)));
668	<	tryTerminate(false); // in case of failure during shutdown
669	<	}
905	>	//  (pollSubmission is defined below with exported methods)
906
907		/**
908	<	* Create enough total workers to establish target parallelism,
909	<	* giving up if terminating or addWorker fails
910	<	*/
911	<	private void ensureEnoughTotalWorkers() {
912	<	int wc;
913	<	while (runState < TERMINATING &&
914	<	((wc = workerCounts) >>> TOTAL_COUNT_SHIFT) < parallelism) {
915	<	if ((UNSAFE.compareAndSwapInt(this, workerCountsOffset,
916	<	wc, wc + (ONE_RUNNING|ONE_TOTAL)) &&
917	<	addWorker() == null))
918	<	break;
908	>	* Creates or doubles submissionQueue array.
909	>	* Basically identical to ForkJoinWorkerThread version.
910	>	*/
911	>	private void growSubmissionQueue() {
912	>	ForkJoinTask<?>[] oldQ = submissionQueue;
913	>	int size = oldQ != null ? oldQ.length << 1 : INITIAL_QUEUE_CAPACITY;
914	>	if (size > MAXIMUM_QUEUE_CAPACITY)
915	>	throw new RejectedExecutionException("Queue capacity exceeded");
916	>	if (size < INITIAL_QUEUE_CAPACITY)
917	>	size = INITIAL_QUEUE_CAPACITY;
918	>	ForkJoinTask<?>[] q = submissionQueue = new ForkJoinTask<?>[size];
919	>	int mask = size - 1;
920	>	int top = queueTop;
921	>	int oldMask;
922	>	if (oldQ != null && (oldMask = oldQ.length - 1) >= 0) {
923	>	for (int b = queueBase; b != top; ++b) {
924	>	long u = ((b & oldMask) << ASHIFT) + ABASE;
925	>	Object x = UNSAFE.getObjectVolatile(oldQ, u);
926	>	if (x != null && UNSAFE.compareAndSwapObject(oldQ, u, x, null))
927	>	UNSAFE.putObjectVolatile
928	>	(q, ((b & mask) << ASHIFT) + ABASE, x);
929	>	}
930		}
931		}
932
933	+	// Blocking support
934	+
935		/**
936	<	* Final callback from terminating worker.  Removes record of
937	<	* worker from array, and adjusts counts. If pool is shutting
938	<	* down, tries to complete terminatation, else possibly replaces
939	<	* the worker.
936	>	* Tries to increment blockedCount, decrement active count
937	>	* (sometimes implicitly) and possibly release or create a
938	>	* compensating worker in preparation for blocking. Fails
939	>	* on contention or termination.
940		*
941	<	* @param w the worker
941	>	* @return true if the caller can block, else should recheck and retry
942		*/
943	<	final void workerTerminated(ForkJoinWorkerThread w) {
944	<	if (w.active) { // force inactive
945	<	w.active = false;
946	<	do {} while (!tryDecrementActiveCount());
943	>	private boolean tryPreBlock() {
944	>	int b = blockedCount;
945	>	if (UNSAFE.compareAndSwapInt(this, blockedCountOffset, b, b + 1)) {
946	>	int pc = parallelism;
947	>	do {
948	>	ForkJoinWorkerThread[] ws; ForkJoinWorkerThread w;
949	>	int e, ac, tc, rc, i;
950	>	long c = ctl;
951	>	int u = (int)(c >>> 32);
952	>	if ((e = (int)c) < 0) {
953	>	// skip -- terminating
954	>	}
955	>	else if ((ac = (u >> UAC_SHIFT)) <= 0 && e != 0 &&
956	>	(ws = workers) != null &&
957	>	(i = ~e & SMASK) < ws.length &&
958	>	(w = ws[i]) != null) {
959	>	long nc = ((long)(w.nextWait & E_MASK) |
960	>	(c & (AC_MASK|TC_MASK)));
961	>	if (w.eventCount == e &&
962	>	UNSAFE.compareAndSwapLong(this, ctlOffset, c, nc)) {
963	>	w.eventCount = (e + EC_UNIT) & E_MASK;
964	>	if (w.parked)
965	>	UNSAFE.unpark(w);
966	>	return true;             // release an idle worker
967	>	}
968	>	}
969	>	else if ((tc = (short)(u >>> UTC_SHIFT)) >= 0 && ac + pc > 1) {
970	>	long nc = ((c - AC_UNIT) & AC_MASK) | (c & ~AC_MASK);
971	>	if (UNSAFE.compareAndSwapLong(this, ctlOffset, c, nc))
972	>	return true;             // no compensation needed
973	>	}
974	>	else if (tc + pc < MAX_ID) {
975	>	long nc = ((c + TC_UNIT) & TC_MASK) | (c & ~TC_MASK);
976	>	if (UNSAFE.compareAndSwapLong(this, ctlOffset, c, nc)) {
977	>	addWorker();
978	>	return true;            // create a replacement
979	>	}
980	>	}
981	>	// try to back out on any failure and let caller retry
982	>	} while (!UNSAFE.compareAndSwapInt(this, blockedCountOffset,
983	>	b = blockedCount, b - 1));
984		}
985	<	forgetWorker(w);
700	<
701	<	// decrement total count, and if was running, running count
702	<	int unit = w.isTrimmed()? ONE_TOTAL : (ONE_RUNNING|ONE_TOTAL);
703	<	int wc;
704	<	do {} while (!UNSAFE.compareAndSwapInt(this, workerCountsOffset,
705	<	wc = workerCounts, wc - unit));
706	<
707	<	accumulateStealCount(w); // collect final count
708	<	if (!tryTerminate(false))
709	<	ensureEnoughTotalWorkers();
985	>	return false;
986		}
987
712	–	// Waiting for and signalling events
713	–
988		/**
989	<	* Ensures eventCount on exit is different (mod 2^32) than on
716	<	* entry.  CAS failures are OK -- any change in count suffices.
989	>	* Decrements blockedCount and increments active count
990		*/
991	<	private void advanceEventCount() {
992	<	int c;
993	<	UNSAFE.compareAndSwapInt(this, eventCountOffset, c = eventCount, c+1);
991	>	private void postBlock() {
992	>	long c;
993	>	do {} while (!UNSAFE.compareAndSwapLong(this, ctlOffset,  // no mask
994	>	c = ctl, c + AC_UNIT));
995	>	int b;
996	>	do {} while(!UNSAFE.compareAndSwapInt(this, blockedCountOffset,
997	>	b = blockedCount, b - 1));
998		}
999
1000		/**
1001	<	* Releases workers blocked on a count not equal to current count.
1001	>	* Possibly blocks waiting for the given task to complete, or
1002	>	* cancels the task if terminating.  Fails to wait if contended.
1003	>	*
1004	>	* @param joinMe the task
1005		*/
1006	<	final void releaseWaiters() {
1007	<	long top;
1008	<	int id;
1009	<	while ((id = (int)((top = eventWaiters) & WAITER_INDEX_MASK)) > 0 &&
1010	<	(int)(top >>> EVENT_COUNT_SHIFT) != eventCount) {
1011	<	ForkJoinWorkerThread[] ws = workers;
1012	<	ForkJoinWorkerThread w;
1013	<	if (ws.length >= id && (w = ws[id - 1]) != null &&
1014	<	UNSAFE.compareAndSwapLong(this, eventWaitersOffset,
1015	<	top, w.nextWaiter))
736	<	LockSupport.unpark(w);
1006	>	final void tryAwaitJoin(ForkJoinTask<?> joinMe) {
1007	>	int s;
1008	>	Thread.interrupted(); // clear interrupts before checking termination
1009	>	if (joinMe.status >= 0) {
1010	>	if (tryPreBlock()) {
1011	>	joinMe.tryAwaitDone(0L);
1012	>	postBlock();
1013	>	}
1014	>	else if ((ctl & STOP_BIT) != 0L)
1015	>	joinMe.cancelIgnoringExceptions();
1016		}
1017		}
1018
1019		/**
1020	<	* Advances eventCount and releases waiters until interference by
1021	<	* other releasing threads is detected.
1020	>	* Possibly blocks the given worker waiting for joinMe to
1021	>	* complete or timeout
1022	>	*
1023	>	* @param joinMe the task
1024	>	* @param millis the wait time for underlying Object.wait
1025		*/
1026	<	final void signalWork() {
1027	<	int ec;
1028	<	UNSAFE.compareAndSwapInt(this, eventCountOffset, ec=eventCount, ec+1);
1029	<	outer:for (;;) {
1030	<	long top = eventWaiters;
1031	<	ec = eventCount;
1032	<	for (;;) {
1033	<	ForkJoinWorkerThread[] ws; ForkJoinWorkerThread w;
1034	<	int id = (int)(top & WAITER_INDEX_MASK);
1035	<	if (id <= 0 || (int)(top >>> EVENT_COUNT_SHIFT) == ec)
1036	<	return;
1037	<	if ((ws = workers).length < id || (w = ws[id - 1]) == null ||
1038	<	!UNSAFE.compareAndSwapLong(this, eventWaitersOffset,
1039	<	top, top = w.nextWaiter))
1040	<	continue outer;      // possibly stale; reread
1041	<	LockSupport.unpark(w);
1042	<	if (top != eventWaiters) // let someone else take over
1043	<	return;
1026	>	final void timedAwaitJoin(ForkJoinTask<?> joinMe, long nanos) {
1027	>	while (joinMe.status >= 0) {
1028	>	Thread.interrupted();
1029	>	if ((ctl & STOP_BIT) != 0L) {
1030	>	joinMe.cancelIgnoringExceptions();
1031	>	break;
1032	>	}
1033	>	if (tryPreBlock()) {
1034	>	long last = System.nanoTime();
1035	>	while (joinMe.status >= 0) {
1036	>	long millis = TimeUnit.NANOSECONDS.toMillis(nanos);
1037	>	if (millis <= 0)
1038	>	break;
1039	>	joinMe.tryAwaitDone(millis);
1040	>	if (joinMe.status < 0)
1041	>	break;
1042	>	if ((ctl & STOP_BIT) != 0L) {
1043	>	joinMe.cancelIgnoringExceptions();
1044	>	break;
1045	>	}
1046	>	long now = System.nanoTime();
1047	>	nanos -= now - last;
1048	>	last = now;
1049	>	}
1050	>	postBlock();
1051	>	break;
1052		}
1053		}
1054		}
1055
1056		/**
1057	<	* If worker is inactive, blocks until terminating or event count
1058	<	* advances from last value held by worker; in any case helps
1059	<	* release others.
1060	<	*
1061	<	* @param w the calling worker thread
1062	<	*/
1063	<	private void eventSync(ForkJoinWorkerThread w) {
1064	<	if (!w.active) {
1065	<	int prev = w.lastEventCount;
1066	<	long nextTop = (((long)prev << EVENT_COUNT_SHIFT) |
777	<	((long)(w.poolIndex + 1)));
778	<	long top;
779	<	while ((runState < SHUTDOWN || !tryTerminate(false)) &&
780	<	(((int)(top = eventWaiters) & WAITER_INDEX_MASK) == 0 ||
781	<	(int)(top >>> EVENT_COUNT_SHIFT) == prev) &&
782	<	eventCount == prev) {
783	<	if (UNSAFE.compareAndSwapLong(this, eventWaitersOffset,
784	<	w.nextWaiter = top, nextTop)) {
785	<	accumulateStealCount(w); // transfer steals while idle
786	<	Thread.interrupted();    // clear/ignore interrupt
787	<	while (eventCount == prev)
788	<	w.doPark();
789	<	break;
1057	>	* If necessary, compensates for blocker, and blocks
1058	>	*/
1059	>	private void awaitBlocker(ManagedBlocker blocker)
1060	>	throws InterruptedException {
1061	>	while (!blocker.isReleasable()) {
1062	>	if (tryPreBlock()) {
1063	>	try {
1064	>	do {} while (!blocker.isReleasable() && !blocker.block());
1065	>	} finally {
1066	>	postBlock();
1067		}
1068	+	break;
1069		}
792	–	w.lastEventCount = eventCount;
1070		}
794	–	releaseWaiters();
1071		}
1072
1073	+	// Creating, registering and deregistring workers
1074	+
1075		/**
1076	<	* Callback from workers invoked upon each top-level action (i.e.,
1077	<	* stealing a task or taking a submission and running
800	<	* it). Performs one or both of the following:
801	<	*
802	<	* * If the worker cannot find work, updates its active status to
803	<	* inactive and updates activeCount unless there is contention, in
804	<	* which case it may try again (either in this or a subsequent
805	<	* call).  Additionally, awaits the next task event and/or helps
806	<	* wake up other releasable waiters.
807	<	*
808	<	* * If there are too many running threads, suspends this worker
809	<	* (first forcing inactivation if necessary).  If it is not
810	<	* resumed before a keepAlive elapses, the worker may be "trimmed"
811	<	* -- killed while suspended within suspendAsSpare. Otherwise,
812	<	* upon resume it rechecks to make sure that it is still needed.
813	<	*
814	<	* @param w the worker
815	<	* @param worked false if the worker scanned for work but didn't
816	<	* find any (in which case it may block waiting for work).
1076	>	* Tries to create and start a worker; minimally rolls back counts
1077	>	* on failure.
1078		*/
1079	<	final void preStep(ForkJoinWorkerThread w, boolean worked) {
1080	<	boolean active = w.active;
1081	<	boolean inactivate = !worked & active;
1082	<	for (;;) {
1083	<	if (inactivate) {
1084	<	int c = runState;
1085	<	if (UNSAFE.compareAndSwapInt(this, runStateOffset,
1086	<	c, c - ONE_ACTIVE))
1087	<	inactivate = active = w.active = false;
1088	<	}
1089	<	int wc = workerCounts;
1090	<	if ((wc & RUNNING_COUNT_MASK) <= parallelism) {
1091	<	if (!worked)
1092	<	eventSync(w);
1093	<	return;
1094	<	}
1095	<	if (!(inactivate |= active) &&  // must inactivate to suspend
1096	<	UNSAFE.compareAndSwapInt(this, workerCountsOffset,
1097	<	wc, wc - ONE_RUNNING) &&
837	<	!w.suspendAsSpare())        // false if trimmed
838	<	return;
1079	>	private void addWorker() {
1080	>	Throwable ex = null;
1081	>	ForkJoinWorkerThread t = null;
1082	>	try {
1083	>	t = factory.newThread(this);
1084	>	} catch (Throwable e) {
1085	>	ex = e;
1086	>	}
1087	>	if (t == null) {  // null or exceptional factory return
1088	>	long c;       // adjust counts
1089	>	do {} while (!UNSAFE.compareAndSwapLong
1090	>	(this, ctlOffset, c = ctl,
1091	>	(((c - AC_UNIT) & AC_MASK) |
1092	>	((c - TC_UNIT) & TC_MASK) |
1093	>	(c & ~(AC_MASK|TC_MASK)))));
1094	>	// Propagate exception if originating from an external caller
1095	>	if (!tryTerminate(false) && ex != null &&
1096	>	!(Thread.currentThread() instanceof ForkJoinWorkerThread))
1097	>	UNSAFE.throwException(ex);
1098		}
1099	+	else
1100	+	t.start();
1101		}
1102
1103		/**
1104	<	* Adjusts counts and creates or resumes compensating threads for
1105	<	* a worker about to block on task joinMe, returning early if
1106	<	* joinMe becomes ready. First tries resuming an existing spare
1107	<	* (which usually also avoids any count adjustment), but must then
1108	<	* decrement running count to determine whether a new thread is
1109	<	* needed. See above for fuller explanation.
1110	<	*/
1111	<	final void preJoin(ForkJoinTask<?> joinMe) {
851	<	boolean dec = false;       // true when running count decremented
852	<	for (;;) {
853	<	releaseWaiters();      // help other threads progress
854	<
855	<	if (joinMe.status < 0) // surround spare search with done checks
856	<	return;
857	<	ForkJoinWorkerThread spare = null;
858	<	for (ForkJoinWorkerThread w : workers) {
859	<	if (w != null && w.isSuspended()) {
860	<	spare = w;
861	<	break;
862	<	}
863	<	}
864	<	if (joinMe.status < 0)
865	<	return;
866	<
867	<	if (spare != null && spare.tryUnsuspend()) {
868	<	if (dec || joinMe.requestSignal() < 0) {
869	<	int c;
870	<	do {} while (!UNSAFE.compareAndSwapInt(this,
871	<	workerCountsOffset,
872	<	c = workerCounts,
873	<	c + ONE_RUNNING));
874	<	} // else no net count change
875	<	LockSupport.unpark(spare);
876	<	return;
877	<	}
878	<
879	<	int wc = workerCounts; // decrement running count
880	<	if (!dec && (wc & RUNNING_COUNT_MASK) != 0 &&
881	<	(dec = UNSAFE.compareAndSwapInt(this, workerCountsOffset,
882	<	wc, wc -= ONE_RUNNING)) &&
883	<	joinMe.requestSignal() < 0) { // cannot block
884	<	int c;                        // back out
885	<	do {} while (!UNSAFE.compareAndSwapInt(this,
886	<	workerCountsOffset,
887	<	c = workerCounts,
888	<	c + ONE_RUNNING));
889	<	return;
890	<	}
891	<
892	<	if (dec) {
893	<	int tc = wc >>> TOTAL_COUNT_SHIFT;
894	<	int pc = parallelism;
895	<	int dc = pc - (wc & RUNNING_COUNT_MASK); // deficit count
896	<	if ((dc < pc && (dc <= 0 || (dc * dc < (tc - pc) * pc) ||
897	<	!maintainsParallelism)) ||
898	<	tc >= maxPoolSize) // cannot add
899	<	return;
900	<	if (spare == null &&
901	<	UNSAFE.compareAndSwapInt(this, workerCountsOffset, wc,
902	<	wc + (ONE_RUNNING|ONE_TOTAL))) {
903	<	addWorker();
904	<	return;
905	<	}
906	<	}
1104	>	* Callback from ForkJoinWorkerThread constructor to assign a
1105	>	* public name
1106	>	*/
1107	>	final String nextWorkerName() {
1108	>	for (int n;;) {
1109	>	if (UNSAFE.compareAndSwapInt(this, nextWorkerNumberOffset,
1110	>	n = nextWorkerNumber, ++n))
1111	>	return workerNamePrefix + n;
1112		}
1113		}
1114
1115		/**
1116	<	* Same idea as preJoin but with too many differing details to
1117	<	* integrate: There are no task-based signal counts, and only one
1118	<	* way to do the actual blocking. So for simplicity it is directly
1119	<	* incorporated into this method.
1116	>	* Callback from ForkJoinWorkerThread constructor to
1117	>	* determine its poolIndex and record in workers array.
1118	>	*
1119	>	* @param w the worker
1120	>	* @return the worker's pool index
1121		*/
1122	<	final void doBlock(ManagedBlocker blocker, boolean maintainPar)
1123	<	throws InterruptedException {
1124	<	maintainPar &= maintainsParallelism; // override
1125	<	boolean dec = false;
1126	<	boolean done = false;
1127	<	for (;;) {
1128	<	releaseWaiters();
1129	<	if (done = blocker.isReleasable())
1130	<	break;
1131	<	ForkJoinWorkerThread spare = null;
1132	<	for (ForkJoinWorkerThread w : workers) {
1133	<	if (w != null && w.isSuspended()) {
1134	<	spare = w;
1135	<	break;
1122	>	final int registerWorker(ForkJoinWorkerThread w) {
1123	>	/*
1124	>	* In the typical case, a new worker acquires the lock, uses
1125	>	* next available index and returns quickly.  Since we should
1126	>	* not block callers (ultimately from signalWork or
1127	>	* tryPreBlock) waiting for the lock needed to do this, we
1128	>	* instead help release other workers while waiting for the
1129	>	* lock.
1130	>	*/
1131	>	for (int g;;) {
1132	>	ForkJoinWorkerThread[] ws;
1133	>	if (((g = scanGuard) & SG_UNIT) == 0 &&
1134	>	UNSAFE.compareAndSwapInt(this, scanGuardOffset,
1135	>	g, g | SG_UNIT)) {
1136	>	int k = nextWorkerIndex;
1137	>	try {
1138	>	if ((ws = workers) != null) { // ignore on shutdown
1139	>	int n = ws.length;
1140	>	if (k < 0 || k >= n || ws[k] != null) {
1141	>	for (k = 0; k < n && ws[k] != null; ++k)
1142	>	;
1143	>	if (k == n)
1144	>	ws = workers = Arrays.copyOf(ws, n << 1);
1145	>	}
1146	>	ws[k] = w;
1147	>	nextWorkerIndex = k + 1;
1148	>	int m = g & SMASK;
1149	>	g = k > m? ((m << 1) + 1) & SMASK : g + (SG_UNIT<<1);
1150	>	}
1151	>	} finally {
1152	>	scanGuard = g;
1153		}
1154	+	return k;
1155		}
1156	<	if (done = blocker.isReleasable())
1157	<	break;
1158	<	if (spare != null && spare.tryUnsuspend()) {
1159	<	if (dec) {
1160	<	int c;
1161	<	do {} while (!UNSAFE.compareAndSwapInt(this,
938	<	workerCountsOffset,
939	<	c = workerCounts,
940	<	c + ONE_RUNNING));
941	<	}
942	<	LockSupport.unpark(spare);
943	<	break;
944	<	}
945	<	int wc = workerCounts;
946	<	if (!dec && (wc & RUNNING_COUNT_MASK) != 0)
947	<	dec = UNSAFE.compareAndSwapInt(this, workerCountsOffset,
948	<	wc, wc -= ONE_RUNNING);
949	<	if (dec) {
950	<	int tc = wc >>> TOTAL_COUNT_SHIFT;
951	<	int pc = parallelism;
952	<	int dc = pc - (wc & RUNNING_COUNT_MASK);
953	<	if ((dc < pc && (dc <= 0 || (dc * dc < (tc - pc) * pc) ||
954	<	!maintainPar)) ||
955	<	tc >= maxPoolSize)
956	<	break;
957	<	if (spare == null &&
958	<	UNSAFE.compareAndSwapInt(this, workerCountsOffset, wc,
959	<	wc + (ONE_RUNNING|ONE_TOTAL))){
960	<	addWorker();
961	<	break;
1156	>	else if ((ws = workers) != null) { // help release others
1157	>	for (ForkJoinWorkerThread u : ws) {
1158	>	if (u != null && u.queueBase != u.queueTop) {
1159	>	if (tryReleaseWaiter())
1160	>	break;
1161	>	}
1162		}
1163		}
1164		}
1165	+	}
1166
1167	<	try {
1168	<	if (!done)
1169	<	do {} while (!blocker.isReleasable() && !blocker.block());
1170	<	} finally {
1171	<	if (dec) {
1172	<	int c;
1173	<	do {} while (!UNSAFE.compareAndSwapInt(this,
1174	<	workerCountsOffset,
1175	<	c = workerCounts,
1176	<	c + ONE_RUNNING));
1167	>	/**
1168	>	* Final callback from terminating worker.  Removes record of
1169	>	* worker from array, and adjusts counts. If pool is shutting
1170	>	* down, tries to complete termination.
1171	>	*
1172	>	* @param w the worker
1173	>	*/
1174	>	final void deregisterWorker(ForkJoinWorkerThread w, Throwable ex) {
1175	>	int idx = w.poolIndex;
1176	>	int sc = w.stealCount;
1177	>	int steps = 0;
1178	>	// Remove from array, adjust worker counts and collect steal count.
1179	>	// We can intermix failed removes or adjusts with steal updates
1180	>	do {
1181	>	long s, c;
1182	>	int g;
1183	>	if (steps == 0 && ((g = scanGuard) & SG_UNIT) == 0 &&
1184	>	UNSAFE.compareAndSwapInt(this, scanGuardOffset,
1185	>	g, g |= SG_UNIT)) {
1186	>	ForkJoinWorkerThread[] ws = workers;
1187	>	if (ws != null && idx >= 0 &&
1188	>	idx < ws.length && ws[idx] == w)
1189	>	ws[idx] = null;    // verify
1190	>	nextWorkerIndex = idx;
1191	>	scanGuard = g + SG_UNIT;
1192	>	steps = 1;
1193		}
1194	+	if (steps == 1 &&
1195	+	UNSAFE.compareAndSwapLong(this, ctlOffset, c = ctl,
1196	+	(((c - AC_UNIT) & AC_MASK) |
1197	+	((c - TC_UNIT) & TC_MASK) |
1198	+	(c & ~(AC_MASK|TC_MASK)))))
1199	+	steps = 2;
1200	+	if (sc != 0 &&
1201	+	UNSAFE.compareAndSwapLong(this, stealCountOffset,
1202	+	s = stealCount, s + sc))
1203	+	sc = 0;
1204	+	} while (steps != 2 || sc != 0);
1205	+	if (!tryTerminate(false)) {
1206	+	if (ex != null)   // possibly replace if died abnormally
1207	+	signalWork();
1208	+	else
1209	+	tryReleaseWaiter();
1210		}
1211		}
1212
1213	+	// Shutdown and termination
1214	+
1215		/**
1216		* Possibly initiates and/or completes termination.
1217		*
#	Line 985 | Line 1220 | public class ForkJoinPool extends Abstra
1220		* @return true if now terminating or terminated
1221		*/
1222		private boolean tryTerminate(boolean now) {
1223	<	if (now)
1224	<	advanceRunLevel(SHUTDOWN); // ensure at least SHUTDOWN
1225	<	else if (runState < SHUTDOWN ||
1226	<	!submissionQueue.isEmpty() ||
1227	<	(runState & ACTIVE_COUNT_MASK) != 0)
1228	<	return false;
1229	<
1230	<	if (advanceRunLevel(TERMINATING))
1231	<	startTerminating();
1232	<
1233	<	// Finish now if all threads terminated; else in some subsequent call
1234	<	if ((workerCounts >>> TOTAL_COUNT_SHIFT) == 0) {
1235	<	advanceRunLevel(TERMINATED);
1236	<	terminationLatch.countDown();
1223	>	long c;
1224	>	while (((c = ctl) & STOP_BIT) == 0) {
1225	>	if (!now) {
1226	>	if ((int)(c >> AC_SHIFT) != -parallelism)
1227	>	return false;
1228	>	if (!shutdown || blockedCount != 0 || quiescerCount != 0 ||
1229	>	queueBase != queueTop) {
1230	>	if (ctl == c) // staleness check
1231	>	return false;
1232	>	continue;
1233	>	}
1234	>	}
1235	>	if (UNSAFE.compareAndSwapLong(this, ctlOffset, c, c | STOP_BIT))
1236	>	startTerminating();
1237	>	}
1238	>	if ((short)(c >>> TC_SHIFT) == -parallelism) { // signal when 0 workers
1239	>	final ReentrantLock lock = this.submissionLock;
1240	>	lock.lock();
1241	>	try {
1242	>	termination.signalAll();
1243	>	} finally {
1244	>	lock.unlock();
1245	>	}
1246		}
1247		return true;
1248		}
1249
1250		/**
1251	<	* Actions on transition to TERMINATING
1251	>	* Runs up to three passes through workers: (0) Setting
1252	>	* termination status for each worker, followed by wakeups up to
1253	>	* queued workers; (1) helping cancel tasks; (2) interrupting
1254	>	* lagging threads (likely in external tasks, but possibly also
1255	>	* blocked in joins).  Each pass repeats previous steps because of
1256	>	* potential lagging thread creation.
1257		*/
1258		private void startTerminating() {
1259	<	// Clear out and cancel submissions, ignoring exceptions
1260	<	ForkJoinTask<?> task;
1261	<	while ((task = submissionQueue.poll()) != null) {
1262	<	try {
1263	<	task.cancel(false);
1264	<	} catch (Throwable ignore) {
1259	>	cancelSubmissions();
1260	>	for (int pass = 0; pass < 3; ++pass) {
1261	>	ForkJoinWorkerThread[] ws = workers;
1262	>	if (ws != null) {
1263	>	for (ForkJoinWorkerThread w : ws) {
1264	>	if (w != null) {
1265	>	w.terminate = true;
1266	>	if (pass > 0) {
1267	>	w.cancelTasks();
1268	>	if (pass > 1 && !w.isInterrupted()) {
1269	>	try {
1270	>	w.interrupt();
1271	>	} catch (SecurityException ignore) {
1272	>	}
1273	>	}
1274	>	}
1275	>	}
1276	>	}
1277	>	terminateWaiters();
1278		}
1279		}
1280	<	// Propagate run level
1281	<	for (ForkJoinWorkerThread w : workers) {
1282	<	if (w != null)
1283	<	w.shutdown();    // also resumes suspended workers
1284	<	}
1285	<	// Ensure no straggling local tasks
1286	<	for (ForkJoinWorkerThread w : workers) {
1287	<	if (w != null)
1288	<	w.cancelTasks();
1027	<	}
1028	<	// Wake up idle workers
1029	<	advanceEventCount();
1030	<	releaseWaiters();
1031	<	// Unstick pending joins
1032	<	for (ForkJoinWorkerThread w : workers) {
1033	<	if (w != null && !w.isTerminated()) {
1280	>	}
1281	>
1282	>	/**
1283	>	* Polls and cancels all submissions. Called only during termination.
1284	>	*/
1285	>	private void cancelSubmissions() {
1286	>	while (queueBase != queueTop) {
1287	>	ForkJoinTask<?> task = pollSubmission();
1288	>	if (task != null) {
1289		try {
1290	<	w.interrupt();
1291	<	} catch (SecurityException ignore) {
1290	>	task.cancel(false);
1291	>	} catch (Throwable ignore) {
1292		}
1293		}
1294		}
1295		}
1296
1042	–	// misc support for ForkJoinWorkerThread
1043	–
1297		/**
1298	<	* Returns pool number
1298	>	* Tries to set the termination status of waiting workers, and
1299	>	* then wakes them up (after which they will terminate).
1300		*/
1301	<	final int getPoolNumber() {
1302	<	return poolNumber;
1301	>	private void terminateWaiters() {
1302	>	ForkJoinWorkerThread[] ws = workers;
1303	>	if (ws != null) {
1304	>	ForkJoinWorkerThread w; long c; int i, e;
1305	>	int n = ws.length;
1306	>	while ((i = ~(e = (int)(c = ctl)) & SMASK) < n &&
1307	>	(w = ws[i]) != null && w.eventCount == (e & E_MASK)) {
1308	>	if (UNSAFE.compareAndSwapLong(this, ctlOffset, c,
1309	>	(long)(w.nextWait & E_MASK) |
1310	>	((c + AC_UNIT) & AC_MASK) |
1311	>	(c & (TC_MASK|STOP_BIT)))) {
1312	>	w.terminate = true;
1313	>	w.eventCount = e + EC_UNIT;
1314	>	if (w.parked)
1315	>	UNSAFE.unpark(w);
1316	>	}
1317	>	}
1318	>	}
1319		}
1320
1321	+	// misc ForkJoinWorkerThread support
1322	+
1323		/**
1324	<	* Accumulates steal count from a worker, clearing
1325	<	* the worker's value
1324	>	* Increment or decrement quiescerCount. Needed only to prevent
1325	>	* triggering shutdown if a worker is transiently inactive while
1326	>	* checking quiescence.
1327	>	*
1328	>	* @param delta 1 for increment, -1 for decrement
1329		*/
1330	<	final void accumulateStealCount(ForkJoinWorkerThread w) {
1331	<	int sc = w.stealCount;
1332	<	if (sc != 0) {
1333	<	long c;
1059	<	w.stealCount = 0;
1060	<	do {} while (!UNSAFE.compareAndSwapLong(this, stealCountOffset,
1061	<	c = stealCount, c + sc));
1062	<	}
1330	>	final void addQuiescerCount(int delta) {
1331	>	int c;
1332	>	do {} while(!UNSAFE.compareAndSwapInt(this, quiescerCountOffset,
1333	>	c = quiescerCount, c + delta));
1334		}
1335
1336		/**
1337	<	* Returns the approximate (non-atomic) number of idle threads per
1338	<	* active thread.
1337	>	* Directly increment or decrement active count without
1338	>	* queuing. This method is used to transiently assert inactivation
1339	>	* while checking quiescence.
1340	>	*
1341	>	* @param delta 1 for increment, -1 for decrement
1342		*/
1343	<	final int idlePerActive() {
1344	<	int ac = runState;    // no mask -- artifically boosts during shutdown
1345	<	int pc = parallelism; // use targeted parallelism, not rc
1346	<	// Use exact results for small values, saturate past 4
1347	<	return pc <= ac? 0 : pc >>> 1 <= ac? 1 : pc >>> 2 <= ac? 3 : pc >>> 3;
1343	>	final void addActiveCount(int delta) {
1344	>	long d = delta < 0 ? -AC_UNIT : AC_UNIT;
1345	>	long c;
1346	>	do {} while (!UNSAFE.compareAndSwapLong(this, ctlOffset, c = ctl,
1347	>	((c + d) & AC_MASK) |
1348	>	(c & ~AC_MASK)));
1349		}
1350
1351		/**
1352	<	* Returns the approximate (non-atomic) difference between running
1353	<	* and active counts.
1352	>	* Returns the approximate (non-atomic) number of idle threads per
1353	>	* active thread.
1354		*/
1355	<	final int inactiveCount() {
1356	<	return (workerCounts & RUNNING_COUNT_MASK) -
1357	<	(runState & ACTIVE_COUNT_MASK);
1355	>	final int idlePerActive() {
1356	>	// Approximate at powers of two for small values, saturate past 4
1357	>	int p = parallelism;
1358	>	int a = p + (int)(ctl >> AC_SHIFT);
1359	>	return (a > (p >>>= 1) ? 0 :
1360	>	a > (p >>>= 1) ? 1 :
1361	>	a > (p >>>= 1) ? 2 :
1362	>	a > (p >>>= 1) ? 4 :
1363	>	8);
1364		}
1365
1366	<	// Public and protected methods
1366	>	// Exported methods
1367
1368		// Constructors
1369
1370		/**
1371		* Creates a {@code ForkJoinPool} with parallelism equal to {@link
1372	<	* java.lang.Runtime#availableProcessors}, and using the {@linkplain
1373	<	* #defaultForkJoinWorkerThreadFactory default thread factory}.
1372	>	* java.lang.Runtime#availableProcessors}, using the {@linkplain
1373	>	* #defaultForkJoinWorkerThreadFactory default thread factory},
1374	>	* no UncaughtExceptionHandler, and non-async LIFO processing mode.
1375		*
1376		* @throws SecurityException if a security manager exists and
1377		*         the caller is not permitted to modify threads
#	Line 1098 | Line 1380 | public class ForkJoinPool extends Abstra
1380		*/
1381		public ForkJoinPool() {
1382		this(Runtime.getRuntime().availableProcessors(),
1383	<	defaultForkJoinWorkerThreadFactory);
1383	>	defaultForkJoinWorkerThreadFactory, null, false);
1384		}
1385
1386		/**
1387		* Creates a {@code ForkJoinPool} with the indicated parallelism
1388	<	* level and using the {@linkplain
1389	<	* #defaultForkJoinWorkerThreadFactory default thread factory}.
1388	>	* level, the {@linkplain
1389	>	* #defaultForkJoinWorkerThreadFactory default thread factory},
1390	>	* no UncaughtExceptionHandler, and non-async LIFO processing mode.
1391		*
1392		* @param parallelism the parallelism level
1393		* @throws IllegalArgumentException if parallelism less than or
#	Line 1115 | Line 1398 | public class ForkJoinPool extends Abstra
1398		*         java.lang.RuntimePermission}{@code ("modifyThread")}
1399		*/
1400		public ForkJoinPool(int parallelism) {
1401	<	this(parallelism, defaultForkJoinWorkerThreadFactory);
1401	>	this(parallelism, defaultForkJoinWorkerThreadFactory, null, false);
1402		}
1403
1404		/**
1405	<	* Creates a {@code ForkJoinPool} with parallelism equal to {@link
1123	<	* java.lang.Runtime#availableProcessors}, and using the given
1124	<	* thread factory.
1405	>	* Creates a {@code ForkJoinPool} with the given parameters.
1406		*
1407	<	* @param factory the factory for creating new threads
1408	<	* @throws NullPointerException if the factory is null
1409	<	* @throws SecurityException if a security manager exists and
1410	<	*         the caller is not permitted to modify threads
1411	<	*         because it does not hold {@link
1412	<	*         java.lang.RuntimePermission}{@code ("modifyThread")}
1413	<	*/
1414	<	public ForkJoinPool(ForkJoinWorkerThreadFactory factory) {
1415	<	this(Runtime.getRuntime().availableProcessors(), factory);
1416	<	}
1417	<
1418	<	/**
1419	<	* Creates a {@code ForkJoinPool} with the given parallelism and
1139	<	* thread factory.
1140	<	*
1141	<	* @param parallelism the parallelism level
1142	<	* @param factory the factory for creating new threads
1407	>	* @param parallelism the parallelism level. For default value,
1408	>	* use {@link java.lang.Runtime#availableProcessors}.
1409	>	* @param factory the factory for creating new threads. For default value,
1410	>	* use {@link #defaultForkJoinWorkerThreadFactory}.
1411	>	* @param handler the handler for internal worker threads that
1412	>	* terminate due to unrecoverable errors encountered while executing
1413	>	* tasks. For default value, use {@code null}.
1414	>	* @param asyncMode if true,
1415	>	* establishes local first-in-first-out scheduling mode for forked
1416	>	* tasks that are never joined. This mode may be more appropriate
1417	>	* than default locally stack-based mode in applications in which
1418	>	* worker threads only process event-style asynchronous tasks.
1419	>	* For default value, use {@code false}.
1420		* @throws IllegalArgumentException if parallelism less than or
1421		*         equal to zero, or greater than implementation limit
1422		* @throws NullPointerException if the factory is null
#	Line 1148 | Line 1425 | public class ForkJoinPool extends Abstra
1425		*         because it does not hold {@link
1426		*         java.lang.RuntimePermission}{@code ("modifyThread")}
1427		*/
1428	<	public ForkJoinPool(int parallelism, ForkJoinWorkerThreadFactory factory) {
1428	>	public ForkJoinPool(int parallelism,
1429	>	ForkJoinWorkerThreadFactory factory,
1430	>	Thread.UncaughtExceptionHandler handler,
1431	>	boolean asyncMode) {
1432		checkPermission();
1433		if (factory == null)
1434		throw new NullPointerException();
1435	<	if (parallelism <= 0 || parallelism > MAX_THREADS)
1435	>	if (parallelism <= 0 || parallelism > MAX_ID)
1436		throw new IllegalArgumentException();
1157	–	this.poolNumber = poolNumberGenerator.incrementAndGet();
1158	–	int arraySize = initialArraySizeFor(parallelism);
1437		this.parallelism = parallelism;
1438		this.factory = factory;
1439	<	this.maxPoolSize = MAX_THREADS;
1440	<	this.maintainsParallelism = true;
1441	<	this.workers = new ForkJoinWorkerThread[arraySize];
1442	<	this.submissionQueue = new LinkedTransferQueue<ForkJoinTask<?>>();
1443	<	this.workerLock = new ReentrantLock();
1444	<	this.terminationLatch = new CountDownLatch(1);
1445	<	// Start first worker; remaining workers added upon first submission
1446	<	workerCounts = ONE_RUNNING | ONE_TOTAL;
1447	<	addWorker();
1448	<	}
1449	<
1450	<	/**
1451	<	* Returns initial power of two size for workers array.
1452	<	* @param pc the initial parallelism level
1453	<	*/
1454	<	private static int initialArraySizeFor(int pc) {
1455	<	// See Hackers Delight, sec 3.2. We know MAX_THREADS < (1 >>> 16)
1456	<	int size = pc < MAX_THREADS ? pc + 1 : MAX_THREADS;
1457	<	size |= size >>> 1;
1180	<	size |= size >>> 2;
1181	<	size |= size >>> 4;
1182	<	size |= size >>> 8;
1183	<	return size + 1;
1439	>	this.ueh = handler;
1440	>	this.locallyFifo = asyncMode;
1441	>	long np = (long)(-parallelism); // offset ctl counts
1442	>	this.ctl = ((np << AC_SHIFT) & AC_MASK) | ((np << TC_SHIFT) & TC_MASK);
1443	>	this.submissionQueue = new ForkJoinTask<?>[INITIAL_QUEUE_CAPACITY];
1444	>	// initialize workers array with room for 2*parallelism if possible
1445	>	int n = parallelism << 1;
1446	>	if (n >= MAX_ID)
1447	>	n = MAX_ID;
1448	>	else { // See Hackers Delight, sec 3.2, where n < (1 << 16)
1449	>	n |= n >>> 1; n |= n >>> 2; n |= n >>> 4; n |= n >>> 8;
1450	>	}
1451	>	workers = new ForkJoinWorkerThread[n + 1];
1452	>	this.submissionLock = new ReentrantLock();
1453	>	this.termination = submissionLock.newCondition();
1454	>	StringBuilder sb = new StringBuilder("ForkJoinPool-");
1455	>	sb.append(poolNumberGenerator.incrementAndGet());
1456	>	sb.append("-worker-");
1457	>	this.workerNamePrefix = sb.toString();
1458		}
1459
1460		// Execution methods
1461
1462		/**
1189	–	* Common code for execute, invoke and submit
1190	–	*/
1191	–	private <T> void doSubmit(ForkJoinTask<T> task) {
1192	–	if (task == null)
1193	–	throw new NullPointerException();
1194	–	if (runState >= SHUTDOWN)
1195	–	throw new RejectedExecutionException();
1196	–	submissionQueue.offer(task);
1197	–	advanceEventCount();
1198	–	releaseWaiters();
1199	–	if ((workerCounts >>> TOTAL_COUNT_SHIFT) < parallelism)
1200	–	ensureEnoughTotalWorkers();
1201	–	}
1202	–
1203	–	/**
1463		* Performs the given task, returning its result upon completion.
1464	+	* If the computation encounters an unchecked Exception or Error,
1465	+	* it is rethrown as the outcome of this invocation.  Rethrown
1466	+	* exceptions behave in the same way as regular exceptions, but,
1467	+	* when possible, contain stack traces (as displayed for example
1468	+	* using {@code ex.printStackTrace()}) of both the current thread
1469	+	* as well as the thread actually encountering the exception;
1470	+	* minimally only the latter.
1471		*
1472		* @param task the task
1473		* @return the task's result
#	Line 1210 | Line 1476 | public class ForkJoinPool extends Abstra
1476		*         scheduled for execution
1477		*/
1478		public <T> T invoke(ForkJoinTask<T> task) {
1479	<	doSubmit(task);
1480	<	return task.join();
1479	>	Thread t = Thread.currentThread();
1480	>	if (task == null)
1481	>	throw new NullPointerException();
1482	>	if (shutdown)
1483	>	throw new RejectedExecutionException();
1484	>	if ((t instanceof ForkJoinWorkerThread) &&
1485	>	((ForkJoinWorkerThread)t).pool == this)
1486	>	return task.invoke();  // bypass submit if in same pool
1487	>	else {
1488	>	addSubmission(task);
1489	>	return task.join();
1490	>	}
1491	>	}
1492	>
1493	>	/**
1494	>	* Unless terminating, forks task if within an ongoing FJ
1495	>	* computation in the current pool, else submits as external task.
1496	>	*/
1497	>	private <T> void forkOrSubmit(ForkJoinTask<T> task) {
1498	>	ForkJoinWorkerThread w;
1499	>	Thread t = Thread.currentThread();
1500	>	if (shutdown)
1501	>	throw new RejectedExecutionException();
1502	>	if ((t instanceof ForkJoinWorkerThread) &&
1503	>	(w = (ForkJoinWorkerThread)t).pool == this)
1504	>	w.pushTask(task);
1505	>	else
1506	>	addSubmission(task);
1507		}
1508
1509		/**
#	Line 1223 | Line 1515 | public class ForkJoinPool extends Abstra
1515		*         scheduled for execution
1516		*/
1517		public void execute(ForkJoinTask<?> task) {
1518	<	doSubmit(task);
1518	>	if (task == null)
1519	>	throw new NullPointerException();
1520	>	forkOrSubmit(task);
1521		}
1522
1523		// AbstractExecutorService methods
#	Line 1234 | Line 1528 | public class ForkJoinPool extends Abstra
1528		*         scheduled for execution
1529		*/
1530		public void execute(Runnable task) {
1531	+	if (task == null)
1532	+	throw new NullPointerException();
1533		ForkJoinTask<?> job;
1534		if (task instanceof ForkJoinTask<?>) // avoid re-wrap
1535		job = (ForkJoinTask<?>) task;
1536		else
1537		job = ForkJoinTask.adapt(task, null);
1538	<	doSubmit(job);
1538	>	forkOrSubmit(job);
1539	>	}
1540	>
1541	>	/**
1542	>	* Submits a ForkJoinTask for execution.
1543	>	*
1544	>	* @param task the task to submit
1545	>	* @return the task
1546	>	* @throws NullPointerException if the task is null
1547	>	* @throws RejectedExecutionException if the task cannot be
1548	>	*         scheduled for execution
1549	>	*/
1550	>	public <T> ForkJoinTask<T> submit(ForkJoinTask<T> task) {
1551	>	if (task == null)
1552	>	throw new NullPointerException();
1553	>	forkOrSubmit(task);
1554	>	return task;
1555		}
1556
1557		/**
#	Line 1248 | Line 1560 | public class ForkJoinPool extends Abstra
1560		*         scheduled for execution
1561		*/
1562		public <T> ForkJoinTask<T> submit(Callable<T> task) {
1563	+	if (task == null)
1564	+	throw new NullPointerException();
1565		ForkJoinTask<T> job = ForkJoinTask.adapt(task);
1566	<	doSubmit(job);
1566	>	forkOrSubmit(job);
1567		return job;
1568		}
1569
#	Line 1259 | Line 1573 | public class ForkJoinPool extends Abstra
1573		*         scheduled for execution
1574		*/
1575		public <T> ForkJoinTask<T> submit(Runnable task, T result) {
1576	+	if (task == null)
1577	+	throw new NullPointerException();
1578		ForkJoinTask<T> job = ForkJoinTask.adapt(task, result);
1579	<	doSubmit(job);
1579	>	forkOrSubmit(job);
1580		return job;
1581		}
1582
#	Line 1270 | Line 1586 | public class ForkJoinPool extends Abstra
1586		*         scheduled for execution
1587		*/
1588		public ForkJoinTask<?> submit(Runnable task) {
1589	+	if (task == null)
1590	+	throw new NullPointerException();
1591		ForkJoinTask<?> job;
1592		if (task instanceof ForkJoinTask<?>) // avoid re-wrap
1593		job = (ForkJoinTask<?>) task;
1594		else
1595		job = ForkJoinTask.adapt(task, null);
1596	<	doSubmit(job);
1596	>	forkOrSubmit(job);
1597		return job;
1598		}
1599
1600		/**
1283	–	* Submits a ForkJoinTask for execution.
1284	–	*
1285	–	* @param task the task to submit
1286	–	* @return the task
1287	–	* @throws NullPointerException if the task is null
1288	–	* @throws RejectedExecutionException if the task cannot be
1289	–	*         scheduled for execution
1290	–	*/
1291	–	public <T> ForkJoinTask<T> submit(ForkJoinTask<T> task) {
1292	–	doSubmit(task);
1293	–	return task;
1294	–	}
1295	–
1296	–	/**
1601		* @throws NullPointerException       {@inheritDoc}
1602		* @throws RejectedExecutionException {@inheritDoc}
1603		*/
#	Line 1305 | Line 1609 | public class ForkJoinPool extends Abstra
1609		invoke(new InvokeAll<T>(forkJoinTasks));
1610
1611		@SuppressWarnings({"unchecked", "rawtypes"})
1612	<	List<Future<T>> futures = (List<Future<T>>) (List) forkJoinTasks;
1612	>	List<Future<T>> futures = (List<Future<T>>) (List) forkJoinTasks;
1613		return futures;
1614		}
1615
#	Line 1335 | Line 1639 | public class ForkJoinPool extends Abstra
1639		* @return the handler, or {@code null} if none
1640		*/
1641		public Thread.UncaughtExceptionHandler getUncaughtExceptionHandler() {
1338	–	workerCountReadFence();
1642		return ueh;
1643		}
1644
1645		/**
1343	–	* Sets the handler for internal worker threads that terminate due
1344	–	* to unrecoverable errors encountered while executing tasks.
1345	–	* Unless set, the current default or ThreadGroup handler is used
1346	–	* as handler.
1347	–	*
1348	–	* @param h the new handler
1349	–	* @return the old handler, or {@code null} if none
1350	–	* @throws SecurityException if a security manager exists and
1351	–	*         the caller is not permitted to modify threads
1352	–	*         because it does not hold {@link
1353	–	*         java.lang.RuntimePermission}{@code ("modifyThread")}
1354	–	*/
1355	–	public Thread.UncaughtExceptionHandler
1356	–	setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler h) {
1357	–	checkPermission();
1358	–	workerCountReadFence();
1359	–	Thread.UncaughtExceptionHandler old = ueh;
1360	–	if (h != old) {
1361	–	ueh = h;
1362	–	workerCountWriteFence();
1363	–	for (ForkJoinWorkerThread w : workers) {
1364	–	if (w != null)
1365	–	w.setUncaughtExceptionHandler(h);
1366	–	}
1367	–	}
1368	–	return old;
1369	–	}
1370	–
1371	–	/**
1372	–	* Sets the target parallelism level of this pool.
1373	–	*
1374	–	* @param parallelism the target parallelism
1375	–	* @throws IllegalArgumentException if parallelism less than or
1376	–	* equal to zero or greater than maximum size bounds
1377	–	* @throws SecurityException if a security manager exists and
1378	–	*         the caller is not permitted to modify threads
1379	–	*         because it does not hold {@link
1380	–	*         java.lang.RuntimePermission}{@code ("modifyThread")}
1381	–	*/
1382	–	public void setParallelism(int parallelism) {
1383	–	checkPermission();
1384	–	if (parallelism <= 0 || parallelism > maxPoolSize)
1385	–	throw new IllegalArgumentException();
1386	–	workerCountReadFence();
1387	–	int pc = this.parallelism;
1388	–	if (pc != parallelism) {
1389	–	this.parallelism = parallelism;
1390	–	workerCountWriteFence();
1391	–	// Release spares. If too many, some will die after re-suspend
1392	–	for (ForkJoinWorkerThread w : workers) {
1393	–	if (w != null && w.tryUnsuspend()) {
1394	–	updateRunningCount(1);
1395	–	LockSupport.unpark(w);
1396	–	}
1397	–	}
1398	–	ensureEnoughTotalWorkers();
1399	–	advanceEventCount();
1400	–	releaseWaiters(); // force config recheck by existing workers
1401	–	}
1402	–	}
1403	–
1404	–	/**
1646		* Returns the targeted parallelism level of this pool.
1647		*
1648		* @return the targeted parallelism level of this pool
1649		*/
1650		public int getParallelism() {
1410	–	//        workerCountReadFence(); // inlined below
1411	–	int ignore = workerCounts;
1651		return parallelism;
1652		}
1653
1654		/**
1655		* Returns the number of worker threads that have started but not
1656	<	* yet terminated.  This result returned by this method may differ
1656	>	* yet terminated.  The result returned by this method may differ
1657		* from {@link #getParallelism} when threads are created to
1658		* maintain parallelism when others are cooperatively blocked.
1659		*
1660		* @return the number of worker threads
1661		*/
1662		public int getPoolSize() {
1663	<	return workerCounts >>> TOTAL_COUNT_SHIFT;
1425	<	}
1426	<
1427	<	/**
1428	<	* Returns the maximum number of threads allowed to exist in the
1429	<	* pool. Unless set using {@link #setMaximumPoolSize}, the
1430	<	* maximum is an implementation-defined value designed only to
1431	<	* prevent runaway growth.
1432	<	*
1433	<	* @return the maximum
1434	<	*/
1435	<	public int getMaximumPoolSize() {
1436	<	workerCountReadFence();
1437	<	return maxPoolSize;
1438	<	}
1439	<
1440	<	/**
1441	<	* Sets the maximum number of threads allowed to exist in the
1442	<	* pool. The given value should normally be greater than or equal
1443	<	* to the {@link #getParallelism parallelism} level. Setting this
1444	<	* value has no effect on current pool size. It controls
1445	<	* construction of new threads.
1446	<	*
1447	<	* @throws IllegalArgumentException if negative or greater than
1448	<	* internal implementation limit
1449	<	*/
1450	<	public void setMaximumPoolSize(int newMax) {
1451	<	if (newMax < 0 || newMax > MAX_THREADS)
1452	<	throw new IllegalArgumentException();
1453	<	maxPoolSize = newMax;
1454	<	workerCountWriteFence();
1455	<	}
1456	<
1457	<	/**
1458	<	* Returns {@code true} if this pool dynamically maintains its
1459	<	* target parallelism level. If false, new threads are added only
1460	<	* to avoid possible starvation.  This setting is by default true.
1461	<	*
1462	<	* @return {@code true} if maintains parallelism
1463	<	*/
1464	<	public boolean getMaintainsParallelism() {
1465	<	workerCountReadFence();
1466	<	return maintainsParallelism;
1467	<	}
1468	<
1469	<	/**
1470	<	* Sets whether this pool dynamically maintains its target
1471	<	* parallelism level. If false, new threads are added only to
1472	<	* avoid possible starvation.
1473	<	*
1474	<	* @param enable {@code true} to maintain parallelism
1475	<	*/
1476	<	public void setMaintainsParallelism(boolean enable) {
1477	<	maintainsParallelism = enable;
1478	<	workerCountWriteFence();
1479	<	}
1480	<
1481	<	/**
1482	<	* Establishes local first-in-first-out scheduling mode for forked
1483	<	* tasks that are never joined. This mode may be more appropriate
1484	<	* than default locally stack-based mode in applications in which
1485	<	* worker threads only process asynchronous tasks.  This method is
1486	<	* designed to be invoked only when the pool is quiescent, and
1487	<	* typically only before any tasks are submitted. The effects of
1488	<	* invocations at other times may be unpredictable.
1489	<	*
1490	<	* @param async if {@code true}, use locally FIFO scheduling
1491	<	* @return the previous mode
1492	<	* @see #getAsyncMode
1493	<	*/
1494	<	public boolean setAsyncMode(boolean async) {
1495	<	workerCountReadFence();
1496	<	boolean oldMode = locallyFifo;
1497	<	if (oldMode != async) {
1498	<	locallyFifo = async;
1499	<	workerCountWriteFence();
1500	<	for (ForkJoinWorkerThread w : workers) {
1501	<	if (w != null)
1502	<	w.setAsyncMode(async);
1503	<	}
1504	<	}
1505	<	return oldMode;
1663	>	return parallelism + (short)(ctl >>> TC_SHIFT);
1664		}
1665
1666		/**
#	Line 1510 | Line 1668 | public class ForkJoinPool extends Abstra
1668		* scheduling mode for forked tasks that are never joined.
1669		*
1670		* @return {@code true} if this pool uses async mode
1513	–	* @see #setAsyncMode
1671		*/
1672		public boolean getAsyncMode() {
1516	–	workerCountReadFence();
1673		return locallyFifo;
1674		}
1675
#	Line 1526 | Line 1682 | public class ForkJoinPool extends Abstra
1682		* @return the number of worker threads
1683		*/
1684		public int getRunningThreadCount() {
1685	<	return workerCounts & RUNNING_COUNT_MASK;
1685	>	int r = parallelism + (int)(ctl >> AC_SHIFT);
1686	>	return r <= 0? 0 : r; // suppress momentarily negative values
1687		}
1688
1689		/**
#	Line 1537 | Line 1694 | public class ForkJoinPool extends Abstra
1694		* @return the number of active threads
1695		*/
1696		public int getActiveThreadCount() {
1697	<	return runState & ACTIVE_COUNT_MASK;
1697	>	int r = parallelism + (int)(ctl >> AC_SHIFT) + blockedCount;
1698	>	return r <= 0? 0 : r; // suppress momentarily negative values
1699		}
1700
1701		/**
#	Line 1552 | Line 1710 | public class ForkJoinPool extends Abstra
1710		* @return {@code true} if all threads are currently idle
1711		*/
1712		public boolean isQuiescent() {
1713	<	return (runState & ACTIVE_COUNT_MASK) == 0;
1713	>	return parallelism + (int)(ctl >> AC_SHIFT) + blockedCount == 0;
1714		}
1715
1716		/**
#	Line 1582 | Line 1740 | public class ForkJoinPool extends Abstra
1740		*/
1741		public long getQueuedTaskCount() {
1742		long count = 0;
1743	<	for (ForkJoinWorkerThread w : workers) {
1744	<	if (w != null)
1745	<	count += w.getQueueSize();
1743	>	ForkJoinWorkerThread[] ws;
1744	>	if ((short)(ctl >>> TC_SHIFT) > -parallelism &&
1745	>	(ws = workers) != null) {
1746	>	for (ForkJoinWorkerThread w : ws)
1747	>	if (w != null)
1748	>	count -= w.queueBase - w.queueTop; // must read base first
1749		}
1750		return count;
1751		}
1752
1753		/**
1754		* Returns an estimate of the number of tasks submitted to this
1755	<	* pool that have not yet begun executing.  This method takes time
1756	<	* proportional to the number of submissions.
1755	>	* pool that have not yet begun executing.  This method may take
1756	>	* time proportional to the number of submissions.
1757		*
1758		* @return the number of queued submissions
1759		*/
1760		public int getQueuedSubmissionCount() {
1761	<	return submissionQueue.size();
1761	>	return -queueBase + queueTop;
1762		}
1763
1764		/**
#	Line 1607 | Line 1768 | public class ForkJoinPool extends Abstra
1768		* @return {@code true} if there are any queued submissions
1769		*/
1770		public boolean hasQueuedSubmissions() {
1771	<	return !submissionQueue.isEmpty();
1771	>	return queueBase != queueTop;
1772		}
1773
1774		/**
#	Line 1618 | Line 1779 | public class ForkJoinPool extends Abstra
1779		* @return the next submission, or {@code null} if none
1780		*/
1781		protected ForkJoinTask<?> pollSubmission() {
1782	<	return submissionQueue.poll();
1782	>	ForkJoinTask<?> t; ForkJoinTask<?>[] q; int b, i;
1783	>	while ((b = queueBase) != queueTop &&
1784	>	(q = submissionQueue) != null &&
1785	>	(i = (q.length - 1) & b) >= 0) {
1786	>	long u = (i << ASHIFT) + ABASE;
1787	>	if ((t = q[i]) != null &&
1788	>	queueBase == b &&
1789	>	UNSAFE.compareAndSwapObject(q, u, t, null)) {
1790	>	queueBase = b + 1;
1791	>	return t;
1792	>	}
1793	>	}
1794	>	return null;
1795		}
1796
1797		/**
#	Line 1639 | Line 1812 | public class ForkJoinPool extends Abstra
1812		* @return the number of elements transferred
1813		*/
1814		protected int drainTasksTo(Collection<? super ForkJoinTask<?>> c) {
1815	<	int n = submissionQueue.drainTo(c);
1816	<	for (ForkJoinWorkerThread w : workers) {
1817	<	if (w != null)
1818	<	n += w.drainTasksTo(c);
1815	>	int count = 0;
1816	>	while (queueBase != queueTop) {
1817	>	ForkJoinTask<?> t = pollSubmission();
1818	>	if (t != null) {
1819	>	c.add(t);
1820	>	++count;
1821	>	}
1822	>	}
1823	>	ForkJoinWorkerThread[] ws;
1824	>	if ((short)(ctl >>> TC_SHIFT) > -parallelism &&
1825	>	(ws = workers) != null) {
1826	>	for (ForkJoinWorkerThread w : ws)
1827	>	if (w != null)
1828	>	count += w.drainTasksTo(c);
1829		}
1830	<	return n;
1830	>	return count;
1831		}
1832
1833		/**
#	Line 1658 | Line 1841 | public class ForkJoinPool extends Abstra
1841		long st = getStealCount();
1842		long qt = getQueuedTaskCount();
1843		long qs = getQueuedSubmissionCount();
1661	–	int wc = workerCounts;
1662	–	int tc = wc >>> TOTAL_COUNT_SHIFT;
1663	–	int rc = wc & RUNNING_COUNT_MASK;
1844		int pc = parallelism;
1845	<	int rs = runState;
1846	<	int ac = rs & ACTIVE_COUNT_MASK;
1845	>	long c = ctl;
1846	>	int tc = pc + (short)(c >>> TC_SHIFT);
1847	>	int rc = pc + (int)(c >> AC_SHIFT);
1848	>	if (rc < 0) // ignore transient negative
1849	>	rc = 0;
1850	>	int ac = rc + blockedCount;
1851	>	String level;
1852	>	if ((c & STOP_BIT) != 0)
1853	>	level = (tc == 0)? "Terminated" : "Terminating";
1854	>	else
1855	>	level = shutdown? "Shutting down" : "Running";
1856		return super.toString() +
1857	<	"[" + runLevelToString(rs) +
1857	>	"[" + level +
1858		", parallelism = " + pc +
1859		", size = " + tc +
1860		", active = " + ac +
#	Line 1676 | Line 1865 | public class ForkJoinPool extends Abstra
1865		"]";
1866		}
1867
1679	–	private static String runLevelToString(int s) {
1680	–	return ((s & TERMINATED) != 0 ? "Terminated" :
1681	–	((s & TERMINATING) != 0 ? "Terminating" :
1682	–	((s & SHUTDOWN) != 0 ? "Shutting down" :
1683	–	"Running")));
1684	–	}
1685	–
1868		/**
1869		* Initiates an orderly shutdown in which previously submitted
1870		* tasks are executed, but no new tasks will be accepted.
#	Line 1697 | Line 1879 | public class ForkJoinPool extends Abstra
1879		*/
1880		public void shutdown() {
1881		checkPermission();
1882	<	advanceRunLevel(SHUTDOWN);
1882	>	shutdown = true;
1883		tryTerminate(false);
1884		}
1885
#	Line 1719 | Line 1901 | public class ForkJoinPool extends Abstra
1901		*/
1902		public List<Runnable> shutdownNow() {
1903		checkPermission();
1904	+	shutdown = true;
1905		tryTerminate(true);
1906		return Collections.emptyList();
1907		}
#	Line 1729 | Line 1912 | public class ForkJoinPool extends Abstra
1912		* @return {@code true} if all tasks have completed following shut down
1913		*/
1914		public boolean isTerminated() {
1915	<	return runState >= TERMINATED;
1915	>	long c = ctl;
1916	>	return ((c & STOP_BIT) != 0L &&
1917	>	(short)(c >>> TC_SHIFT) == -parallelism);
1918		}
1919
1920		/**
#	Line 1737 | Line 1922 | public class ForkJoinPool extends Abstra
1922		* commenced but not yet completed.  This method may be useful for
1923		* debugging. A return of {@code true} reported a sufficient
1924		* period after shutdown may indicate that submitted tasks have
1925	<	* ignored or suppressed interruption, causing this executor not
1926	<	* to properly terminate.
1925	>	* ignored or suppressed interruption, or are waiting for IO,
1926	>	* causing this executor not to properly terminate. (See the
1927	>	* advisory notes for class {@link ForkJoinTask} stating that
1928	>	* tasks should not normally entail blocking operations.  But if
1929	>	* they do, they must abort them on interrupt.)
1930		*
1931		* @return {@code true} if terminating but not yet terminated
1932		*/
1933		public boolean isTerminating() {
1934	<	return (runState & (TERMINATING|TERMINATED)) == TERMINATING;
1934	>	long c = ctl;
1935	>	return ((c & STOP_BIT) != 0L &&
1936	>	(short)(c >>> TC_SHIFT) != -parallelism);
1937	>	}
1938	>
1939	>	/**
1940	>	* Returns true if terminating or terminated. Used by ForkJoinWorkerThread.
1941	>	*/
1942	>	final boolean isAtLeastTerminating() {
1943	>	return (ctl & STOP_BIT) != 0L;
1944		}
1945
1946		/**
#	Line 1752 | Line 1949 | public class ForkJoinPool extends Abstra
1949		* @return {@code true} if this pool has been shut down
1950		*/
1951		public boolean isShutdown() {
1952	<	return runState >= SHUTDOWN;
1952	>	return shutdown;
1953		}
1954
1955		/**
#	Line 1768 | Line 1965 | public class ForkJoinPool extends Abstra
1965		*/
1966		public boolean awaitTermination(long timeout, TimeUnit unit)
1967		throws InterruptedException {
1968	<	return terminationLatch.await(timeout, unit);
1968	>	long nanos = unit.toNanos(timeout);
1969	>	final ReentrantLock lock = this.submissionLock;
1970	>	lock.lock();
1971	>	try {
1972	>	for (;;) {
1973	>	if (isTerminated())
1974	>	return true;
1975	>	if (nanos <= 0)
1976	>	return false;
1977	>	nanos = termination.awaitNanos(nanos);
1978	>	}
1979	>	} finally {
1980	>	lock.unlock();
1981	>	}
1982		}
1983
1984		/**
1985		* Interface for extending managed parallelism for tasks running
1986		* in {@link ForkJoinPool}s.
1987		*
1988	<	* <p>A {@code ManagedBlocker} provides two methods.
1989	<	* Method {@code isReleasable} must return {@code true} if
1990	<	* blocking is not necessary. Method {@code block} blocks the
1991	<	* current thread if necessary (perhaps internally invoking
1992	<	* {@code isReleasable} before actually blocking).
1988	>	* <p>A {@code ManagedBlocker} provides two methods.  Method
1989	>	* {@code isReleasable} must return {@code true} if blocking is
1990	>	* not necessary. Method {@code block} blocks the current thread
1991	>	* if necessary (perhaps internally invoking {@code isReleasable}
1992	>	* before actually blocking). These actions are performed by any
1993	>	* thread invoking {@link ForkJoinPool#managedBlock}.  The
1994	>	* unusual methods in this API accommodate synchronizers that may,
1995	>	* but don't usually, block for long periods. Similarly, they
1996	>	* allow more efficient internal handling of cases in which
1997	>	* additional workers may be, but usually are not, needed to
1998	>	* ensure sufficient parallelism.  Toward this end,
1999	>	* implementations of method {@code isReleasable} must be amenable
2000	>	* to repeated invocation.
2001		*
2002		* <p>For example, here is a ManagedBlocker based on a
2003		* ReentrantLock:
#	Line 1797 | Line 2015 | public class ForkJoinPool extends Abstra
2015		*     return hasLock || (hasLock = lock.tryLock());
2016		*   }
2017		* }}</pre>
2018	+	*
2019	+	* <p>Here is a class that possibly blocks waiting for an
2020	+	* item on a given queue:
2021	+	*  <pre> {@code
2022	+	* class QueueTaker<E> implements ManagedBlocker {
2023	+	*   final BlockingQueue<E> queue;
2024	+	*   volatile E item = null;
2025	+	*   QueueTaker(BlockingQueue<E> q) { this.queue = q; }
2026	+	*   public boolean block() throws InterruptedException {
2027	+	*     if (item == null)
2028	+	*       item = queue.take();
2029	+	*     return true;
2030	+	*   }
2031	+	*   public boolean isReleasable() {
2032	+	*     return item != null || (item = queue.poll()) != null;
2033	+	*   }
2034	+	*   public E getItem() { // call after pool.managedBlock completes
2035	+	*     return item;
2036	+	*   }
2037	+	* }}</pre>
2038		*/
2039		public static interface ManagedBlocker {
2040		/**
#	Line 1820 | Line 2058 | public class ForkJoinPool extends Abstra
2058		* Blocks in accord with the given blocker.  If the current thread
2059		* is a {@link ForkJoinWorkerThread}, this method possibly
2060		* arranges for a spare thread to be activated if necessary to
2061	<	* ensure parallelism while the current thread is blocked.
1824	<	*
1825	<	* <p>If {@code maintainParallelism} is {@code true} and the pool
1826	<	* supports it ({@link #getMaintainsParallelism}), this method
1827	<	* attempts to maintain the pool's nominal parallelism. Otherwise
1828	<	* it activates a thread only if necessary to avoid complete
1829	<	* starvation. This option may be preferable when blockages use
1830	<	* timeouts, or are almost always brief.
2061	>	* ensure sufficient parallelism while the current thread is blocked.
2062		*
2063		* <p>If the caller is not a {@link ForkJoinTask}, this method is
2064		* behaviorally equivalent to
#	Line 1841 | Line 2072 | public class ForkJoinPool extends Abstra
2072		* first be expanded to ensure parallelism, and later adjusted.
2073		*
2074		* @param blocker the blocker
1844	–	* @param maintainParallelism if {@code true} and supported by
1845	–	* this pool, attempt to maintain the pool's nominal parallelism;
1846	–	* otherwise activate a thread only if necessary to avoid
1847	–	* complete starvation.
2075		* @throws InterruptedException if blocker.block did so
2076		*/
2077	<	public static void managedBlock(ManagedBlocker blocker,
1851	<	boolean maintainParallelism)
2077	>	public static void managedBlock(ManagedBlocker blocker)
2078		throws InterruptedException {
2079		Thread t = Thread.currentThread();
2080	<	if (t instanceof ForkJoinWorkerThread)
2081	<	((ForkJoinWorkerThread) t).pool.
2082	<	doBlock(blocker, maintainParallelism);
2083	<	else
2084	<	awaitBlocker(blocker);
2085	<	}
2086	<
1861	<	/**
1862	<	* Performs Non-FJ blocking
1863	<	*/
1864	<	private static void awaitBlocker(ManagedBlocker blocker)
1865	<	throws InterruptedException {
1866	<	do {} while (!blocker.isReleasable() && !blocker.block());
2080	>	if (t instanceof ForkJoinWorkerThread) {
2081	>	ForkJoinWorkerThread w = (ForkJoinWorkerThread) t;
2082	>	w.pool.awaitBlocker(blocker);
2083	>	}
2084	>	else {
2085	>	do {} while (!blocker.isReleasable() && !blocker.block());
2086	>	}
2087		}
2088
2089		// AbstractExecutorService overrides.  These rely on undocumented
#	Line 1879 | Line 2099 | public class ForkJoinPool extends Abstra
2099		}
2100
2101		// Unsafe mechanics
2102	<
2103	<	private static final sun.misc.Unsafe UNSAFE = getUnsafe();
2104	<	private static final long workerCountsOffset =
2105	<	objectFieldOffset("workerCounts", ForkJoinPool.class);
2106	<	private static final long runStateOffset =
2107	<	objectFieldOffset("runState", ForkJoinPool.class);
2108	<	private static final long eventCountOffset =
2109	<	objectFieldOffset("eventCount", ForkJoinPool.class);
2110	<	private static final long eventWaitersOffset =
2111	<	objectFieldOffset("eventWaiters",ForkJoinPool.class);
2112	<	private static final long stealCountOffset =
2113	<	objectFieldOffset("stealCount",ForkJoinPool.class);
2114	<
2115	<
2116	<	private static long objectFieldOffset(String field, Class<?> klazz) {
2102	>	private static final sun.misc.Unsafe UNSAFE;
2103	>	private static final long ctlOffset;
2104	>	private static final long stealCountOffset;
2105	>	private static final long blockedCountOffset;
2106	>	private static final long quiescerCountOffset;
2107	>	private static final long scanGuardOffset;
2108	>	private static final long nextWorkerNumberOffset;
2109	>	private static final long ABASE;
2110	>	private static final int ASHIFT;
2111	>
2112	>	static {
2113	>	poolNumberGenerator = new AtomicInteger();
2114	>	workerSeedGenerator = new Random();
2115	>	modifyThreadPermission = new RuntimePermission("modifyThread");
2116	>	defaultForkJoinWorkerThreadFactory =
2117	>	new DefaultForkJoinWorkerThreadFactory();
2118	>	int s;
2119		try {
2120	<	return UNSAFE.objectFieldOffset(klazz.getDeclaredField(field));
2121	<	} catch (NoSuchFieldException e) {
2122	<	// Convert Exception to corresponding Error
2123	<	NoSuchFieldError error = new NoSuchFieldError(field);
2124	<	error.initCause(e);
2125	<	throw error;
2126	<	}
2120	>	UNSAFE = getUnsafe();
2121	>	Class k = ForkJoinPool.class;
2122	>	ctlOffset = UNSAFE.objectFieldOffset
2123	>	(k.getDeclaredField("ctl"));
2124	>	stealCountOffset = UNSAFE.objectFieldOffset
2125	>	(k.getDeclaredField("stealCount"));
2126	>	blockedCountOffset = UNSAFE.objectFieldOffset
2127	>	(k.getDeclaredField("blockedCount"));
2128	>	quiescerCountOffset = UNSAFE.objectFieldOffset
2129	>	(k.getDeclaredField("quiescerCount"));
2130	>	scanGuardOffset = UNSAFE.objectFieldOffset
2131	>	(k.getDeclaredField("scanGuard"));
2132	>	nextWorkerNumberOffset = UNSAFE.objectFieldOffset
2133	>	(k.getDeclaredField("nextWorkerNumber"));
2134	>	Class a = ForkJoinTask[].class;
2135	>	ABASE = UNSAFE.arrayBaseOffset(a);
2136	>	s = UNSAFE.arrayIndexScale(a);
2137	>	} catch (Exception e) {
2138	>	throw new Error(e);
2139	>	}
2140	>	if ((s & (s-1)) != 0)
2141	>	throw new Error("data type scale not a power of two");
2142	>	ASHIFT = 31 - Integer.numberOfLeadingZeros(s);
2143		}
2144
2145		/**

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines