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.72 by jsr166, Tue Sep 7 06:19:05 2010 UTC vs.
Revision 1.92 by dl, Tue Feb 22 10:50:51 2011 UTC

#	Line 6 | Line 6
6
7		package jsr166y;
8
9	–	import java.util.concurrent.*;
9		import java.util.ArrayList;
10		import java.util.Arrays;
11		import java.util.Collection;
12		import java.util.Collections;
13		import java.util.List;
14	+	import java.util.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;
18	<	import java.util.concurrent.CountDownLatch;
26	>	import java.util.concurrent.locks.Condition;
27
28		/**
29		* An {@link ExecutorService} for running {@link ForkJoinTask}s.
#	Line 123 | 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
138	<	* lastly to new submissions. These mechanics do not consider
139	<	* affinities, loads, cache localities, etc, so rarely provide the
140	<	* best possible performance on a given machine, but portably
141	<	* provide good throughput by averaging over these factors.
142	<	* (Further, even if we did try to use such information, we do not
143	<	* usually have a basis for exploiting it. For example, some sets
144	<	* of tasks profit from cache affinities, but others are harmed by
145	<	* cache pollution effects.)
146	<	*
147	<	* Beyond work-stealing support and essential bookkeeping, the
148	<	* main responsibility of this framework is to take actions when
149	<	* one worker is waiting to join a task stolen (or always held by)
150	<	* another.  Because we are multiplexing many tasks on to a pool
151	<	* of workers, we can't just let them block (as in Thread.join).
152	<	* We also cannot just reassign the joiner's run-time stack with
153	<	* another and replace it later, which would be a form of
154	<	* "continuation", that even if possible is not necessarily a good
155	<	* idea. Given that the creation costs of most threads on most
156	<	* systems mainly surrounds setting up runtime stacks, thread
157	<	* creation and switching is usually not much more expensive than
158	<	* stack creation and switching, and is more flexible). Instead we
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 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 tesks) 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 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. 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 are
199	>	* can be immediately found, and we cannot start/resume workers
200	>	* unless there appear to be tasks available.  On the other hand,
201	>	* we must quickly prod them into action when new tasks are
202	>	* submitted or generated.  We park/unpark workers after placing
203	>	* in an event wait queue when they cannot find work. This "queue"
204	>	* is actually a simple Treiber stack, headed by the "id" field of
205	>	* ctl, plus a 15bit counter value to both wake up waiters (by
206	>	* advancing their count) and avoid ABA effects. Successors are
207	>	* held in worker field "nextWait".  Queuing deals with several
208	>	* intrinsic races, mainly that a task-producing thread can miss
209	>	* seeing (and signalling) another thread that gave up looking for
210	>	* work but has not yet entered the wait queue. We solve this by
211	>	* requiring a full sweep of all workers both before (in scan())
212	>	* and after (in awaitWork()) a newly waiting worker is added to
213	>	* the wait queue. During a rescan, the worker might release some
214	>	* other queued worker rather than itself, which has the same net
215	>	* effect.
216	>	*
217	>	* Signalling.  We create or wake up workers only when there
218	>	* appears to be at least one task they might be able to find and
219	>	* execute.  When a submission is added or another worker adds a
220	>	* task to a queue that previously had two or fewer tasks, they
221	>	* signal waiting workers (or trigger creation of new ones if
222	>	* fewer than the given parallelism level -- see signalWork).
223	>	* These primary signals are buttressed by signals during rescans
224	>	* as well as those performed when a worker steals a task and
225	>	* notices that there are more tasks too; together these cover the
226	>	* signals needed in cases when more than two tasks are pushed
227	>	* but untaken.
228	>	*
229	>	* Trimming workers. To release resources after periods of lack of
230	>	* use, a worker starting to wait when the pool is quiescent will
231	>	* time out and terminate if the pool has remained quiescent for
232	>	* SHRINK_RATE nanosecs.
233	>	*
234	>	* Submissions. External submissions are maintained in an
235	>	* array-based queue that is structured identically to
236	>	* ForkJoinWorkerThread queues (which see) except for the use of
237	>	* submissionLock in method addSubmission. Unlike worker queues,
238	>	* multiple external threads can add new submissions.
239	>	*
240	>	* Compensation. Beyond work-stealing support and lifecycle
241	>	* control, the main responsibility of this framework is to take
242	>	* actions when one worker is waiting to join a task stolen (or
243	>	* always held by) another.  Because we are multiplexing many
244	>	* tasks on to a pool of workers, we can't just let them block (as
245	>	* in Thread.join).  We also cannot just reassign the joiner's
246	>	* run-time stack with another and replace it later, which would
247	>	* be a form of "continuation", that even if possible is not
248	>	* necessarily a good idea since we sometimes need both an
249	>	* unblocked task and its continuation to progress. Instead we
250		* combine two tactics:
251		*
252		*   Helping: Arranging for the joiner to execute some task that it
253		*      would be running if the steal had not occurred.  Method
254	<	*      ForkJoinWorkerThread.helpJoinTask tracks joining->stealing
254	>	*      ForkJoinWorkerThread.joinTask tracks joining->stealing
255		*      links to try to find such a task.
256		*
257		*   Compensating: Unless there are already enough live threads,
258	<	*      method helpMaintainParallelism() may create or
259	<	*      re-activate a spare thread to compensate for blocked
260	<	*      joiners until they unblock.
162	<	*
163	<	* It is impossible to keep exactly the target (parallelism)
164	<	* number of threads running at any given time.  Determining
165	<	* existence of conservatively safe helping targets, the
166	<	* availability of already-created spares, and the apparent need
167	<	* to create new spares are all racy and require heuristic
168	<	* guidance, so we rely on multiple retries of each.  Compensation
169	<	* occurs in slow-motion. It is triggered only upon timeouts of
170	<	* Object.wait used for joins. This reduces poor decisions that
171	<	* would otherwise be made when threads are waiting for others
172	<	* that are stalled because of unrelated activities such as
173	<	* garbage collection.
258	>	*      method tryPreBlock() may create or re-activate a spare
259	>	*      thread to compensate for blocked joiners until they
260	>	*      unblock.
261		*
262		* The ManagedBlocker extension API can't use helping so relies
263		* only on compensation in method awaitBlocker.
264		*
265	<	* The main throughput advantages of work-stealing stem from
266	<	* decentralized control -- workers mostly steal tasks from each
267	<	* other. We do not want to negate this by creating bottlenecks
268	<	* implementing other management responsibilities. So we use a
269	<	* collection of techniques that avoid, reduce, or cope well with
270	<	* contention. These entail several instances of bit-packing into
271	<	* CASable fields to maintain only the minimally required
272	<	* atomicity. To enable such packing, we restrict maximum
273	<	* parallelism to (1<<15)-1 (enabling twice this (to accommodate
274	<	* unbalanced increments and decrements) to fit into a 16 bit
275	<	* field, which is far in excess of normal operating range.  Even
276	<	* though updates to some of these bookkeeping fields do sometimes
277	<	* contend with each other, they don't normally cache-contend with
278	<	* updates to others enough to warrant memory padding or
279	<	* isolation. So they are all held as fields of ForkJoinPool
280	<	* objects.  The main capabilities are as follows:
281	<	*
282	<	* 1. Creating and removing workers. Workers are recorded in the
283	<	* "workers" array. This is an array as opposed to some other data
284	<	* structure to support index-based random steals by workers.
285	<	* Updates to the array recording new workers and unrecording
286	<	* terminated ones are protected from each other by a lock
287	<	* (workerLock) but the array is otherwise concurrently readable,
288	<	* and accessed directly by workers. To simplify index-based
289	<	* operations, the array size is always a power of two, and all
290	<	* readers must tolerate null slots. Currently, all worker thread
291	<	* creation is on-demand, triggered by task submissions,
292	<	* replacement of terminated workers, and/or compensation for
293	<	* blocked workers. However, all other support code is set up to
294	<	* work with other policies.
208	<	*
209	<	* To ensure that we do not hold on to worker references that
210	<	* would prevent GC, ALL accesses to workers are via indices into
211	<	* the workers array (which is one source of some of the unusual
212	<	* code constructions here). In essence, the workers array serves
213	<	* as a WeakReference mechanism. Thus for example the event queue
214	<	* stores worker indices, not worker references. Access to the
215	<	* workers in associated methods (for example releaseEventWaiters)
216	<	* must both index-check and null-check the IDs. All such accesses
217	<	* ignore bad IDs by returning out early from what they are doing,
218	<	* since this can only be associated with shutdown, in which case
219	<	* it is OK to give up. On termination, we just clobber these
220	<	* data structures without trying to use them.
221	<	*
222	<	* 2. Bookkeeping for dynamically adding and removing workers. We
223	<	* aim to approximately maintain the given level of parallelism.
224	<	* When some workers are known to be blocked (on joins or via
225	<	* ManagedBlocker), we may create or resume others to take their
226	<	* place until they unblock (see below). Implementing this
227	<	* requires counts of the number of "running" threads (i.e., those
228	<	* that are neither blocked nor artificially suspended) as well as
229	<	* the total number.  These two values are packed into one field,
230	<	* "workerCounts" because we need accurate snapshots when deciding
231	<	* to create, resume or suspend.  Note however that the
232	<	* correspondence of these counts to reality is not guaranteed. In
233	<	* particular updates for unblocked threads may lag until they
234	<	* actually wake up.
235	<	*
236	<	* 3. Maintaining global run state. The run state of the pool
237	<	* consists of a runLevel (SHUTDOWN, TERMINATING, etc) similar to
238	<	* those in other Executor implementations, as well as a count of
239	<	* "active" workers -- those that are, or soon will be, or
240	<	* recently were executing tasks. The runLevel and active count
241	<	* are packed together in order to correctly trigger shutdown and
242	<	* termination. Without care, active counts can be subject to very
243	<	* high contention.  We substantially reduce this contention by
244	<	* relaxing update rules.  A worker must claim active status
245	<	* prospectively, by activating if it sees that a submitted or
246	<	* stealable task exists (it may find after activating that the
247	<	* task no longer exists). It stays active while processing this
248	<	* task (if it exists) and any other local subtasks it produces,
249	<	* until it cannot find any other tasks. It then tries
250	<	* inactivating (see method preStep), but upon update contention
251	<	* instead scans for more tasks, later retrying inactivation if it
252	<	* doesn't find any.
253	<	*
254	<	* 4. Managing idle workers waiting for tasks. We cannot let
255	<	* workers spin indefinitely scanning for tasks when none are
256	<	* available. On the other hand, we must quickly prod them into
257	<	* action when new tasks are submitted or generated.  We
258	<	* park/unpark these idle workers using an event-count scheme.
259	<	* Field eventCount is incremented upon events that may enable
260	<	* workers that previously could not find a task to now find one:
261	<	* Submission of a new task to the pool, or another worker pushing
262	<	* a task onto a previously empty queue.  (We also use this
263	<	* mechanism for configuration and termination actions that
264	<	* require wakeups of idle workers).  Each worker maintains its
265	<	* last known event count, and blocks when a scan for work did not
266	<	* find a task AND its lastEventCount matches the current
267	<	* eventCount. Waiting idle workers are recorded in a variant of
268	<	* Treiber stack headed by field eventWaiters which, when nonzero,
269	<	* encodes the thread index and count awaited for by the worker
270	<	* thread most recently calling eventSync. This thread in turn has
271	<	* a record (field nextEventWaiter) for the next waiting worker.
272	<	* In addition to allowing simpler decisions about need for
273	<	* wakeup, the event count bits in eventWaiters serve the role of
274	<	* tags to avoid ABA errors in Treiber stacks. Upon any wakeup,
275	<	* released threads also try to release at most two others.  The
276	<	* net effect is a tree-like diffusion of signals, where released
277	<	* threads (and possibly others) help with unparks.  To further
278	<	* reduce contention effects a bit, failed CASes to increment
279	<	* field eventCount are tolerated without retries in signalWork.
280	<	* Conceptually they are merged into the same event, which is OK
281	<	* when their only purpose is to enable workers to scan for work.
282	<	*
283	<	* 5. Managing suspension of extra workers. When a worker notices
284	<	* (usually upon timeout of a wait()) that there are too few
285	<	* running threads, we may create a new thread to maintain
286	<	* parallelism level, or at least avoid starvation. Usually, extra
287	<	* threads are needed for only very short periods, yet join
288	<	* dependencies are such that we sometimes need them in
289	<	* bursts. Rather than create new threads each time this happens,
290	<	* we suspend no-longer-needed extra ones as "spares". For most
291	<	* purposes, we don't distinguish "extra" spare threads from
292	<	* normal "core" threads: On each call to preStep (the only point
293	<	* at which we can do this) a worker checks to see if there are
294	<	* now too many running workers, and if so, suspends itself.
295	<	* Method helpMaintainParallelism looks for suspended threads to
296	<	* resume before considering creating a new replacement. The
297	<	* spares themselves are encoded on another variant of a Treiber
298	<	* Stack, headed at field "spareWaiters".  Note that the use of
299	<	* spares is intrinsically racy.  One thread may become a spare at
300	<	* about the same time as another is needlessly being created. We
301	<	* counteract this and related slop in part by requiring resumed
302	<	* spares to immediately recheck (in preStep) to see whether they
303	<	* should re-suspend.
304	<	*
305	<	* 6. Killing off unneeded workers. A timeout mechanism is used to
306	<	* shed unused workers: The oldest (first) event queue waiter uses
307	<	* a timed rather than hard wait. When this wait times out without
308	<	* a normal wakeup, it tries to shutdown any one (for convenience
309	<	* the newest) other spare or event waiter via
310	<	* tryShutdownUnusedWorker. This eventually reduces the number of
311	<	* worker threads to a minimum of one after a long enough period
312	<	* without use.
313	<	*
314	<	* 7. Deciding when to create new workers. The main dynamic
315	<	* control in this class is deciding when to create extra threads
316	<	* in method helpMaintainParallelism. We would like to keep
317	<	* exactly #parallelism threads running, which is an impossible
318	<	* task. We always need to create one when the number of running
319	<	* threads would become zero and all workers are busy. Beyond
320	<	* this, we must rely on heuristics that work well in the
321	<	* presence of transient phenomena such as GC stalls, dynamic
322	<	* compilation, and wake-up lags. These transients are extremely
323	<	* common -- we are normally trying to fully saturate the CPUs on
324	<	* a machine, so almost any activity other than running tasks
325	<	* impedes accuracy. Our main defense is to allow parallelism to
326	<	* lapse for a while during joins, and use a timeout to see if,
327	<	* after the resulting settling, there is still a need for
328	<	* additional workers.  This also better copes with the fact that
329	<	* some of the methods in this class tend to never become compiled
330	<	* (but are interpreted), so some components of the entire set of
331	<	* controls might execute 100 times faster than others. And
332	<	* similarly for cases where the apparent lack of work is just due
333	<	* to GC stalls and other transient system activity.
265	>	* It is impossible to keep exactly the target parallelism number
266	>	* of threads running at any given time.  Determining the
267	>	* existence of conservatively safe helping targets, the
268	>	* availability of already-created spares, and the apparent need
269	>	* to create new spares are all racy and require heuristic
270	>	* guidance, so we rely on multiple retries of each.  Currently,
271	>	* in keeping with on-demand signalling policy, we compensate only
272	>	* if blocking would leave less than one active (non-waiting,
273	>	* non-blocked) worker. Additionally, to avoid some false alarms
274	>	* due to GC, lagging counters, system activity, etc, compensated
275	>	* blocking for joins is only attempted after a number of rechecks
276	>	* proportional to the current apparent deficit (where retries are
277	>	* interspersed with Thread.yield, for good citizenship).  The
278	>	* variable blockedCount, incremented before blocking and
279	>	* decremented after, is sometimes needed to distinguish cases of
280	>	* waiting for work vs blocking on joins or other managed sync,
281	>	* but both the cases are equivalent for most pool control, so we
282	>	* can update non-atomically. (Additionally, contention on
283	>	* blockedCount alleviates some contention on ctl).
284	>	*
285	>	* Shutdown and Termination. A call to shutdownNow atomically sets
286	>	* the ctl stop bit and then (non-atomically) sets each workers
287	>	* "terminate" status, cancels all unprocessed tasks, and wakes up
288	>	* all waiting workers.  Detecting whether termination should
289	>	* commence after a non-abrupt shutdown() call requires more work
290	>	* and bookkeeping. We need consensus about quiesence (i.e., that
291	>	* there is no more work) which is reflected in active counts so
292	>	* long as there are no current blockers, as well as possible
293	>	* re-evaluations during independent changes in blocking or
294	>	* quiescing workers.
295		*
296	<	* Beware that there is a lot of representation-level coupling
296	>	* Style notes: There is a lot of representation-level coupling
297		* among classes ForkJoinPool, ForkJoinWorkerThread, and
298	<	* ForkJoinTask.  For example, direct access to "workers" array by
298	>	* ForkJoinTask.  Most fields of ForkJoinWorkerThread maintain
299	>	* data structures managed by ForkJoinPool, so are directly
300	>	* accessed.  Conversely we allow access to "workers" array by
301		* workers, and direct access to ForkJoinTask.status by both
302		* ForkJoinPool and ForkJoinWorkerThread.  There is little point
303		* trying to reduce this, since any associated future changes in
304		* representations will need to be accompanied by algorithmic
305	<	* changes anyway.
306	<	*
307	<	* Style notes: There are lots of inline assignments (of form
308	<	* "while ((local = field) != 0)") which are usually the simplest
309	<	* way to ensure the required read orderings (which are sometimes
310	<	* critical). Also several occurrences of the unusual "do {}
311	<	* while (!cas...)" which is the simplest way to force an update of
312	<	* a CAS'ed variable. There are also other coding oddities that
313	<	* help some methods perform reasonably even when interpreted (not
314	<	* compiled), at the expense of some messy constructions that
315	<	* reduce byte code counts.
316	<	*
317	<	* The order of declarations in this file is: (1) statics (2)
318	<	* fields (along with constants used when unpacking some of them)
319	<	* (3) internal control methods (4) callbacks and other support
320	<	* for ForkJoinTask and ForkJoinWorkerThread classes, (5) exported
321	<	* methods (plus a few little helpers).
305	>	* changes anyway. All together, these low-level implementation
306	>	* choices produce as much as a factor of 4 performance
307	>	* improvement compared to naive implementations, and enable the
308	>	* processing of billions of tasks per second, at the expense of
309	>	* some ugliness.
310	>	*
311	>	* Methods signalWork() and scan() are the main bottlenecks so are
312	>	* especially heavily micro-optimized/mangled.  There are lots of
313	>	* inline assignments (of form "while ((local = field) != 0)")
314	>	* which are usually the simplest way to ensure the required read
315	>	* orderings (which are sometimes critical). This leads to a
316	>	* "C"-like style of listing declarations of these locals at the
317	>	* heads of methods or blocks.  There are several occurrences of
318	>	* the unusual "do {} while (!cas...)"  which is the simplest way
319	>	* to force an update of a CAS'ed variable. There are also other
320	>	* coding oddities that help some methods perform reasonably even
321	>	* when interpreted (not compiled).
322	>	*
323	>	* The order of declarations in this file is: (1) declarations of
324	>	* statics (2) fields (along with constants used when unpacking
325	>	* some of them), listed in an order that tends to reduce
326	>	* contention among them a bit under most JVMs.  (3) internal
327	>	* control methods (4) callbacks and other support for
328	>	* ForkJoinTask and ForkJoinWorkerThread classes, (5) exported
329	>	* methods (plus a few little helpers). (6) static block
330	>	* initializing all statics in a minimally dependent order.
331		*/
332
333		/**
#	Line 390 | Line 362 | public class ForkJoinPool extends Abstra
362		* overridden in ForkJoinPool constructors.
363		*/
364		public static final ForkJoinWorkerThreadFactory
365	<	defaultForkJoinWorkerThreadFactory =
394	<	new DefaultForkJoinWorkerThreadFactory();
365	>	defaultForkJoinWorkerThreadFactory;
366
367		/**
368		* Permission required for callers of methods that may start or
369		* kill threads.
370		*/
371	<	private static final RuntimePermission modifyThreadPermission =
401	<	new RuntimePermission("modifyThread");
371	>	private static final RuntimePermission modifyThreadPermission;
372
373		/**
374		* If there is a security manager, makes sure caller has
#	Line 413 | Line 383 | public class ForkJoinPool extends Abstra
383		/**
384		* Generator for assigning sequence numbers as pool names.
385		*/
386	<	private static final AtomicInteger poolNumberGenerator =
417	<	new AtomicInteger();
386	>	private static final AtomicInteger poolNumberGenerator;
387
388		/**
389	<	* The time to block in a join (see awaitJoin) before checking if
390	<	* a new worker should be (re)started to maintain parallelism
391	<	* level. The value should be short enough to maintain global
392	<	* responsiveness and progress but long enough to avoid
393	<	* counterproductive firings during GC stalls or unrelated system
425	<	* activity, and to not bog down systems with continual re-firings
426	<	* on GCs or legitimately long waits.
389	>	* Generator for initial random seeds for worker victim
390	>	* selection. This is used only to create initial seeds. Random
391	>	* steals use a cheaper xorshift generator per steal attempt. We
392	>	* don't expect much contention on seedGenerator, so just use a
393	>	* plain Random.
394		*/
395	<	private static final long JOIN_TIMEOUT_MILLIS = 250L; // 4 per second
395	>	static final Random workerSeedGenerator;
396
397		/**
398	<	* The wakeup interval (in nanoseconds) for the oldest worker
399	<	* waiting for an event invokes tryShutdownUnusedWorker to shrink
400	<	* the number of workers.  The exact value does not matter too
401	<	* much, but should be long enough to slowly release resources
402	<	* during long periods without use without disrupting normal use.
398	>	* Array holding all worker threads in the pool.  Initialized upon
399	>	* construction. Array size must be a power of two.  Updates and
400	>	* replacements are protected by scanGuard, but the array is
401	>	* always kept in a consistent enough state to be randomly
402	>	* accessed without locking by workers performing work-stealing,
403	>	* as well as other traversal-based methods in this class, so long
404	>	* as reads memory-acquire by first reading ctl. All readers must
405	>	* tolerate that some array slots may be null.
406		*/
407	<	private static final long SHRINK_RATE_NANOS =
438	<	30L * 1000L * 1000L * 1000L; // 2 per minute
407	>	ForkJoinWorkerThread[] workers;
408
409		/**
410	<	* Absolute bound for parallelism level. Twice this number plus
411	<	* one (i.e., 0xfff) must fit into a 16bit field to enable
412	<	* word-packing for some counts and indices.
410	>	* Initial size for submission queue array. Must be a power of
411	>	* two.  In many applications, these always stay small so we use a
412	>	* small initial cap.
413		*/
414	<	private static final int MAX_WORKERS   = 0x7fff;
414	>	private static final int INITIAL_QUEUE_CAPACITY = 8;
415
416		/**
417	<	* Array holding all worker threads in the pool.  Array size must
418	<	* be a power of two.  Updates and replacements are protected by
419	<	* workerLock, but the array is always kept in a consistent enough
420	<	* state to be randomly accessed without locking by workers
452	<	* performing work-stealing, as well as other traversal-based
453	<	* methods in this class. All readers must tolerate that some
454	<	* array slots may be null.
417	>	* Maximum size for submission queue array. Must be a power of two
418	>	* less than or equal to 1 << (31 - width of array entry) to
419	>	* ensure lack of index wraparound, but is capped at a lower
420	>	* value to help users trap runaway computations.
421		*/
422	<	volatile ForkJoinWorkerThread[] workers;
422	>	private static final int MAXIMUM_QUEUE_CAPACITY = 1 << 24; // 16M
423
424		/**
425	<	* Queue for external submissions.
425	>	* Array serving as submission queue. Initialized upon construction.
426		*/
427	<	private final LinkedTransferQueue<ForkJoinTask<?>> submissionQueue;
427	>	private ForkJoinTask<?>[] submissionQueue;
428
429		/**
430	<	* Lock protecting updates to workers array.
430	>	* Lock protecting submissions array for addSubmission
431		*/
432	<	private final ReentrantLock workerLock;
432	>	private final ReentrantLock submissionLock;
433
434		/**
435	<	* Latch released upon termination.
435	>	* Condition for awaitTermination, using submissionLock for
436	>	* convenience.
437		*/
438	<	private final Phaser termination;
438	>	private final Condition termination;
439
440		/**
441		* Creation factory for worker threads.
#	Line 476 | Line 443 | public class ForkJoinPool extends Abstra
443		private final ForkJoinWorkerThreadFactory factory;
444
445		/**
446	<	* Sum of per-thread steal counts, updated only when threads are
447	<	* idle or terminating.
446	>	* The uncaught exception handler used when any worker abruptly
447	>	* terminates.
448		*/
449	<	private volatile long stealCount;
449	>	final Thread.UncaughtExceptionHandler ueh;
450
451		/**
452	<	* Encoded record of top of Treiber stack of threads waiting for
486	<	* events. The top 32 bits contain the count being waited for. The
487	<	* bottom 16 bits contains one plus the pool index of waiting
488	<	* worker thread. (Bits 16-31 are unused.)
452	>	* Prefix for assigning names to worker threads
453		*/
454	<	private volatile long eventWaiters;
491	<
492	<	private static final int  EVENT_COUNT_SHIFT = 32;
493	<	private static final long WAITER_ID_MASK    = (1L << 16) - 1L;
454	>	private final String workerNamePrefix;
455
456		/**
457	<	* A counter for events that may wake up worker threads:
458	<	*   - Submission of a new task to the pool
498	<	*   - A worker pushing a task on an empty queue
499	<	*   - termination
457	>	* Sum of per-thread steal counts, updated only when threads are
458	>	* idle or terminating.
459		*/
460	<	private volatile int eventCount;
460	>	private volatile long stealCount;
461
462		/**
463	<	* Encoded record of top of Treiber stack of spare threads waiting
464	<	* for resumption. The top 16 bits contain an arbitrary count to
465	<	* avoid ABA effects. The bottom 16bits contains one plus the pool
466	<	* index of waiting worker thread.
467	<	*/
468	<	private volatile int spareWaiters;
469	<
470	<	private static final int SPARE_COUNT_SHIFT = 16;
471	<	private static final int SPARE_ID_MASK     = (1 << 16) - 1;
463	>	* Main pool control -- a long packed with:
464	>	* AC: Number of active running workers minus target parallelism (16 bits)
465	>	* TC: Number of total workers minus target parallelism (16bits)
466	>	* ST: true if pool is terminating (1 bit)
467	>	* EC: the wait count of top waiting thread (15 bits)
468	>	* ID: ~poolIndex of top of Treiber stack of waiting threads (16 bits)
469	>	*
470	>	* When convenient, we can extract the upper 32 bits of counts and
471	>	* the lower 32 bits of queue state, u = (int)(ctl >>> 32) and e =
472	>	* (int)ctl.  The ec field is never accessed alone, but always
473	>	* together with id and st. The offsets of counts by the target
474	>	* parallelism and the positionings of fields makes it possible to
475	>	* perform the most common checks via sign tests of fields: When
476	>	* ac is negative, there are not enough active workers, when tc is
477	>	* negative, there are not enough total workers, when id is
478	>	* negative, there is at least one waiting worker, and when e is
479	>	* negative, the pool is terminating.  To deal with these possibly
480	>	* negative fields, we use casts in and out of "short" and/or
481	>	* signed shifts to maintain signedness.  Note: AC_SHIFT is
482	>	* redundantly declared in ForkJoinWorkerThread in order to
483	>	* integrate a surplus-threads check.
484	>	*/
485	>	volatile long ctl;
486	>
487	>	// bit positions/shifts for fields
488	>	private static final int  AC_SHIFT   = 48;
489	>	private static final int  TC_SHIFT   = 32;
490	>	private static final int  ST_SHIFT   = 31;
491	>	private static final int  EC_SHIFT   = 16;
492	>
493	>	// bounds
494	>	private static final int  MAX_ID     = 0x7fff;  // max poolIndex
495	>	private static final int  SMASK      = 0xffff;  // mask short bits
496	>	private static final int  SHORT_SIGN = 1 << 15;
497	>	private static final int  INT_SIGN   = 1 << 31;
498	>
499	>	// masks
500	>	private static final long STOP_BIT   = 0x0001L << ST_SHIFT;
501	>	private static final long AC_MASK    = ((long)SMASK) << AC_SHIFT;
502	>	private static final long TC_MASK    = ((long)SMASK) << TC_SHIFT;
503	>
504	>	// units for incrementing and decrementing
505	>	private static final long TC_UNIT    = 1L << TC_SHIFT;
506	>	private static final long AC_UNIT    = 1L << AC_SHIFT;
507	>
508	>	// masks and units for dealing with u = (int)(ctl >>> 32)
509	>	private static final int  UAC_SHIFT  = AC_SHIFT - 32;
510	>	private static final int  UTC_SHIFT  = TC_SHIFT - 32;
511	>	private static final int  UAC_MASK   = SMASK << UAC_SHIFT;
512	>	private static final int  UTC_MASK   = SMASK << UTC_SHIFT;
513	>	private static final int  UAC_UNIT   = 1 << UAC_SHIFT;
514	>	private static final int  UTC_UNIT   = 1 << UTC_SHIFT;
515	>
516	>	// masks and units for dealing with e = (int)ctl
517	>	private static final int  E_MASK     = 0x7fffffff; // no STOP_BIT
518	>	private static final int  EC_UNIT    = 1 << EC_SHIFT;
519
520		/**
521	<	* Lifecycle control. The low word contains the number of workers
516	<	* that are (probably) executing tasks. This value is atomically
517	<	* incremented before a worker gets a task to run, and decremented
518	<	* when worker has no tasks and cannot find any.  Bits 16-18
519	<	* contain runLevel value. When all are zero, the pool is
520	<	* running. Level transitions are monotonic (running -> shutdown
521	<	* -> terminating -> terminated) so each transition adds a bit.
522	<	* These are bundled together to ensure consistent read for
523	<	* termination checks (i.e., that runLevel is at least SHUTDOWN
524	<	* and active threads is zero).
525	<	*
526	<	* Notes: Most direct CASes are dependent on these bitfield
527	<	* positions.  Also, this field is non-private to enable direct
528	<	* performance-sensitive CASes in ForkJoinWorkerThread.
521	>	* The target parallelism level.
522		*/
523	<	volatile int runState;
531	<
532	<	// Note: The order among run level values matters.
533	<	private static final int RUNLEVEL_SHIFT     = 16;
534	<	private static final int SHUTDOWN           = 1 << RUNLEVEL_SHIFT;
535	<	private static final int TERMINATING        = 1 << (RUNLEVEL_SHIFT + 1);
536	<	private static final int TERMINATED         = 1 << (RUNLEVEL_SHIFT + 2);
537	<	private static final int ACTIVE_COUNT_MASK  = (1 << RUNLEVEL_SHIFT) - 1;
523	>	final int parallelism;
524
525		/**
526	<	* Holds number of total (i.e., created and not yet terminated)
527	<	* and running (i.e., not blocked on joins or other managed sync)
542	<	* threads, packed together to ensure consistent snapshot when
543	<	* making decisions about creating and suspending spare
544	<	* threads. Updated only by CAS. Note that adding a new worker
545	<	* requires incrementing both counts, since workers start off in
546	<	* running state.
526	>	* Index (mod submission queue length) of next element to take
527	>	* from submission queue.
528		*/
529	<	private volatile int workerCounts;
529	>	volatile int queueBase;
530
531	<	private static final int TOTAL_COUNT_SHIFT  = 16;
532	<	private static final int RUNNING_COUNT_MASK = (1 << TOTAL_COUNT_SHIFT) - 1;
533	<	private static final int ONE_RUNNING        = 1;
534	<	private static final int ONE_TOTAL          = 1 << TOTAL_COUNT_SHIFT;
531	>	/**
532	>	* Index (mod submission queue length) of next element to add
533	>	* in submission queue.
534	>	*/
535	>	int queueTop;
536
537		/**
538	<	* The target parallelism level.
557	<	* Accessed directly by ForkJoinWorkerThreads.
538	>	* True when shutdown() has been called.
539		*/
540	<	final int parallelism;
540	>	volatile boolean shutdown;
541
542		/**
543		* True if use local fifo, not default lifo, for local polling
#	Line 565 | Line 546 | public class ForkJoinPool extends Abstra
546		final boolean locallyFifo;
547
548		/**
549	<	* The uncaught exception handler used when any worker abruptly
550	<	* terminates.
549	>	* The number of threads in ForkJoinWorkerThreads.helpQuiescePool.
550	>	* When non-zero, suppresses automatic shutdown when active
551	>	* counts become zero.
552		*/
553	<	private final Thread.UncaughtExceptionHandler ueh;
553	>	volatile int quiescerCount;
554
555		/**
556	<	* Pool number, just for assigning useful names to worker threads
556	>	* The number of threads blocked in join.
557		*/
558	<	private final int poolNumber;
577	<
578	<	// Utilities for CASing fields. Note that most of these
579	<	// are usually manually inlined by callers
558	>	volatile int blockedCount;
559
560		/**
561	<	* Increments running count part of workerCounts
561	>	* Counter for worker Thread names (unrelated to their poolIndex)
562		*/
563	<	final void incrementRunningCount() {
585	<	int c;
586	<	do {} while (!UNSAFE.compareAndSwapInt(this, workerCountsOffset,
587	<	c = workerCounts,
588	<	c + ONE_RUNNING));
589	<	}
563	>	private volatile int nextWorkerNumber;
564
565		/**
566	<	* Tries to decrement running count unless already zero
566	>	* The index for the next created worker. Accessed under scanGuard.
567		*/
568	<	final boolean tryDecrementRunningCount() {
595	<	int wc = workerCounts;
596	<	if ((wc & RUNNING_COUNT_MASK) == 0)
597	<	return false;
598	<	return UNSAFE.compareAndSwapInt(this, workerCountsOffset,
599	<	wc, wc - ONE_RUNNING);
600	<	}
568	>	private int nextWorkerIndex;
569
570		/**
571	<	* Forces decrement of encoded workerCounts, awaiting nonzero if
572	<	* (rarely) necessary when other count updates lag.
573	<	*
574	<	* @param dr -- either zero or ONE_RUNNING
575	<	* @param dt == either zero or ONE_TOTAL
571	>	* SeqLock and index masking for for updates to workers array.
572	>	* Locked when SG_UNIT is set. Unlocking clears bit by adding
573	>	* SG_UNIT. Staleness of read-only operations can be checked by
574	>	* comparing scanGuard to value before the reads. The low 16 bits
575	>	* (i.e, anding with SMASK) hold (the smallest power of two
576	>	* covering all worker indices, minus one, and is used to avoid
577	>	* dealing with large numbers of null slots when the workers array
578	>	* is overallocated.
579		*/
580	<	private void decrementWorkerCounts(int dr, int dt) {
581	<	for (;;) {
582	<	int wc = workerCounts;
612	<	if ((wc & RUNNING_COUNT_MASK)  - dr < 0 ||
613	<	(wc >>> TOTAL_COUNT_SHIFT) - dt < 0) {
614	<	if ((runState & TERMINATED) != 0)
615	<	return; // lagging termination on a backout
616	<	Thread.yield();
617	<	}
618	<	if (UNSAFE.compareAndSwapInt(this, workerCountsOffset,
619	<	wc, wc - (dr + dt)))
620	<	return;
621	<	}
622	<	}
580	>	volatile int scanGuard;
581	>
582	>	private static final int SG_UNIT = 1 << 16;
583
584		/**
585	<	* Tries decrementing active count; fails on contention.
586	<	* Called when workers cannot find tasks to run.
585	>	* The wakeup interval (in nanoseconds) for a worker waiting for a
586	>	* task when the pool is quiescent to instead try to shrink the
587	>	* number of workers.  The exact value does not matter too
588	>	* much. It must be short enough to release resources during
589	>	* sustained periods of idleness, but not so short that threads
590	>	* are continually re-created.
591		*/
592	<	final boolean tryDecrementActiveCount() {
593	<	int c;
630	<	return UNSAFE.compareAndSwapInt(this, runStateOffset,
631	<	c = runState, c - 1);
632	<	}
592	>	private static final long SHRINK_RATE =
593	>	4L * 1000L * 1000L * 1000L; // 4 seconds
594
595		/**
596	<	* Advances to at least the given level. Returns true if not
597	<	* already in at least the given level.
596	>	* Top-level loop for worker threads: On each step: if the
597	>	* previous step swept through all queues and found no tasks, or
598	>	* there are excess threads, then possibly blocks. Otherwise,
599	>	* scans for and, if found, executes a task. Returns when pool
600	>	* and/or worker terminate.
601	>	*
602	>	* @param w the worker
603		*/
604	<	private boolean advanceRunLevel(int level) {
605	<	for (;;) {
606	<	int s = runState;
607	<	if ((s & level) != 0)
608	<	return false;
609	<	if (UNSAFE.compareAndSwapInt(this, runStateOffset, s, s | level))
610	<	return true;
604	>	final void work(ForkJoinWorkerThread w) {
605	>	boolean swept = false;                // true on empty scans
606	>	long c;
607	>	while (!w.terminate && (int)(c = ctl) >= 0) {
608	>	int a;                            // active count
609	>	if (!swept && (a = (int)(c >> AC_SHIFT)) <= 0)
610	>	swept = scan(w, a);
611	>	else if (tryAwaitWork(w, c))
612	>	swept = false;
613		}
614		}
615
616	<	// workers array maintenance
616	>	// Signalling
617
618		/**
619	<	* Records and returns a workers array index for new worker.
619	>	* Wakes up or creates a worker.
620		*/
621	<	private int recordWorker(ForkJoinWorkerThread w) {
622	<	// Try using slot totalCount-1. If not available, scan and/or resize
623	<	int k = (workerCounts >>> TOTAL_COUNT_SHIFT) - 1;
624	<	final ReentrantLock lock = this.workerLock;
625	<	lock.lock();
626	<	try {
627	<	ForkJoinWorkerThread[] ws = workers;
628	<	int n = ws.length;
629	<	if (k < 0 || k >= n || ws[k] != null) {
630	<	for (k = 0; k < n && ws[k] != null; ++k)
631	<	;
632	<	if (k == n)
633	<	ws = Arrays.copyOf(ws, n << 1);
621	>	final void signalWork() {
622	>	/*
623	>	* The while condition is true if: (there is are too few total
624	>	* workers OR there is at least one waiter) AND (there are too
625	>	* few active workers OR the pool is terminating).  The value
626	>	* of e distinguishes the remaining cases: zero (no waiters)
627	>	* for create, negative if terminating (in which case do
628	>	* nothing), else release a waiter. The secondary checks for
629	>	* release (non-null array etc) can fail if the pool begins
630	>	* terminating after the test, and don't impose any added cost
631	>	* because JVMs must perform null and bounds checks anyway.
632	>	*/
633	>	long c; int e, u;
634	>	while ((((e = (int)(c = ctl)) | (u = (int)(c >>> 32))) &
635	>	(INT_SIGN|SHORT_SIGN)) == (INT_SIGN|SHORT_SIGN) && e >= 0) {
636	>	if (e > 0) {                         // release a waiting worker
637	>	int i; ForkJoinWorkerThread w; ForkJoinWorkerThread[] ws;
638	>	if ((ws = workers) == null ||
639	>	(i = ~e & SMASK) >= ws.length ||
640	>	(w = ws[i]) == null)
641	>	break;
642	>	long nc = (((long)(w.nextWait & E_MASK)) |
643	>	((long)(u + UAC_UNIT) << 32));
644	>	if (w.eventCount == e &&
645	>	UNSAFE.compareAndSwapLong(this, ctlOffset, c, nc)) {
646	>	w.eventCount = (e + EC_UNIT) & E_MASK;
647	>	if (w.parked)
648	>	UNSAFE.unpark(w);
649	>	break;
650	>	}
651	>	}
652	>	else if (UNSAFE.compareAndSwapLong
653	>	(this, ctlOffset, c,
654	>	(long)(((u + UTC_UNIT) & UTC_MASK) |
655	>	((u + UAC_UNIT) & UAC_MASK)) << 32)) {
656	>	addWorker();
657	>	break;
658		}
667	–	ws[k] = w;
668	–	workers = ws; // volatile array write ensures slot visibility
669	–	} finally {
670	–	lock.unlock();
659		}
672	–	return k;
660		}
661
662		/**
663	<	* Nulls out record of worker in workers array.
663	>	* Variant of signalWork to help release waiters on rescans.
664	>	* Tries once to release a waiter if active count < 0.
665	>	*
666	>	* @return false if failed due to contention, else true
667		*/
668	<	private void forgetWorker(ForkJoinWorkerThread w) {
669	<	int idx = w.poolIndex;
670	<	// Locking helps method recordWorker avoid unnecessary expansion
671	<	final ReentrantLock lock = this.workerLock;
672	<	lock.lock();
673	<	try {
674	<	ForkJoinWorkerThread[] ws = workers;
675	<	if (idx >= 0 && idx < ws.length && ws[idx] == w) // verify
676	<	ws[idx] = null;
677	<	} finally {
678	<	lock.unlock();
668	>	private boolean tryReleaseWaiter() {
669	>	long c; int e, i; ForkJoinWorkerThread w; ForkJoinWorkerThread[] ws;
670	>	if ((e = (int)(c = ctl)) > 0 &&
671	>	(int)(c >> AC_SHIFT) < 0 &&
672	>	(ws = workers) != null &&
673	>	(i = ~e & SMASK) < ws.length &&
674	>	(w = ws[i]) != null) {
675	>	long nc = ((long)(w.nextWait & E_MASK) |
676	>	((c + AC_UNIT) & (AC_MASK|TC_MASK)));
677	>	if (w.eventCount != e ||
678	>	!UNSAFE.compareAndSwapLong(this, ctlOffset, c, nc))
679	>	return false;
680	>	w.eventCount = (e + EC_UNIT) & E_MASK;
681	>	if (w.parked)
682	>	UNSAFE.unpark(w);
683		}
684	+	return true;
685		}
686
687	+	// Scanning for tasks
688	+
689		/**
690	<	* Final callback from terminating worker.  Removes record of
691	<	* worker from array, and adjusts counts. If pool is shutting
692	<	* down, tries to complete termination.
690	>	* Scans for and, if found, executes one task. Scans start at a
691	>	* random index of workers array, and randomly select the first
692	>	* (2*#workers)-1 probes, and then, if all empty, resort to 2
693	>	* circular sweeps, which is necessary to check quiescence. and
694	>	* taking a submission only if no stealable tasks were found.  The
695	>	* steal code inside the loop is a specialized form of
696	>	* ForkJoinWorkerThread.deqTask, followed bookkeeping to support
697	>	* helpJoinTask and signal propagation. The code for submission
698	>	* queues is almost identical. On each steal, the worker completes
699	>	* not only the task, but also all local tasks that this task may
700	>	* have generated. On detecting staleness or contention when
701	>	* trying to take a task, this method returns without finishing
702	>	* sweep, which allows global state rechecks before retry.
703		*
704		* @param w the worker
705	+	* @param a the number of active workers
706	+	* @return true if swept all queues without finding a task
707		*/
708	<	final void workerTerminated(ForkJoinWorkerThread w) {
709	<	forgetWorker(w);
710	<	decrementWorkerCounts(w.isTrimmed()? 0 : ONE_RUNNING, ONE_TOTAL);
702	<	while (w.stealCount != 0) // collect final count
703	<	tryAccumulateStealCount(w);
704	<	tryTerminate(false);
705	<	}
706	<
707	<	// Waiting for and signalling events
708	<
709	<	/**
710	<	* Releases workers blocked on a count not equal to current count.
711	<	* Normally called after precheck that eventWaiters isn't zero to
712	<	* avoid wasted array checks. Gives up upon a change in count or
713	<	* upon releasing two workers, letting others take over.
714	<	*/
715	<	private void releaseEventWaiters() {
708	>	private boolean scan(ForkJoinWorkerThread w, int a) {
709	>	int g = scanGuard; // mask 0 avoids useless scans if only one active
710	>	int m = parallelism == 1 - a? 0 : g & SMASK;
711		ForkJoinWorkerThread[] ws = workers;
712	<	int n = ws.length;
713	<	long h = eventWaiters;
714	<	int ec = eventCount;
715	<	boolean releasedOne = false;
716	<	ForkJoinWorkerThread w; int id;
717	<	while ((id = ((int)(h & WAITER_ID_MASK)) - 1) >= 0 &&
718	<	(int)(h >>> EVENT_COUNT_SHIFT) != ec &&
719	<	id < n && (w = ws[id]) != null) {
720	<	if (UNSAFE.compareAndSwapLong(this, eventWaitersOffset,
721	<	h,  w.nextWaiter)) {
722	<	LockSupport.unpark(w);
723	<	if (releasedOne) // exit on second release
724	<	break;
725	<	releasedOne = true;
712	>	if (ws == null || ws.length <= m)         // staleness check
713	>	return false;
714	>	for (int r = w.seed, k = r, j = -(m + m); j <= m + m; ++j) {
715	>	ForkJoinTask<?> t; ForkJoinTask<?>[] q; int b, i;
716	>	ForkJoinWorkerThread v = ws[k & m];
717	>	if (v != null && (b = v.queueBase) != v.queueTop &&
718	>	(q = v.queue) != null && (i = (q.length - 1) & b) >= 0) {
719	>	long u = (i << ASHIFT) + ABASE;
720	>	if ((t = q[i]) != null && v.queueBase == b &&
721	>	UNSAFE.compareAndSwapObject(q, u, t, null)) {
722	>	int d = (v.queueBase = b + 1) - v.queueTop;
723	>	v.stealHint = w.poolIndex;
724	>	if (d != 0)
725	>	signalWork();             // propagate if nonempty
726	>	w.execTask(t);
727	>	}
728	>	r ^= r << 13; r ^= r >>> 17; w.seed = r ^ (r << 5);
729	>	return false;                     // store next seed
730		}
731	<	if (eventCount != ec)
732	<	break;
733	<	h = eventWaiters;
731	>	else if (j < 0) {                     // xorshift
732	>	r ^= r << 13; r ^= r >>> 17; k = r ^= r << 5;
733	>	}
734	>	else
735	>	++k;
736	>	}
737	>	if (scanGuard != g)                       // staleness check
738	>	return false;
739	>	else {                                    // try to take submission
740	>	ForkJoinTask<?> t; ForkJoinTask<?>[] q; int b, i;
741	>	if ((b = queueBase) != queueTop &&
742	>	(q = submissionQueue) != null &&
743	>	(i = (q.length - 1) & b) >= 0) {
744	>	long u = (i << ASHIFT) + ABASE;
745	>	if ((t = q[i]) != null && queueBase == b &&
746	>	UNSAFE.compareAndSwapObject(q, u, t, null)) {
747	>	queueBase = b + 1;
748	>	w.execTask(t);
749	>	}
750	>	return false;
751	>	}
752	>	return true;                         // all queues empty
753		}
754		}
755
756		/**
757	<	* Tries to advance eventCount and releases waiters. Called only
758	<	* from workers.
757	>	* Tries to enqueue worker in wait queue and await change in
758	>	* worker's eventCount.  Before blocking, rescans queues to avoid
759	>	* missed signals.  If the pool is quiescent, possibly terminates
760	>	* worker upon exit.
761	>	*
762	>	* @param w the calling worker
763	>	* @param c the ctl value on entry
764	>	* @return true if waited or another thread was released upon enq
765		*/
766	<	final void signalWork() {
767	<	int c; // try to increment event count -- CAS failure OK
768	<	UNSAFE.compareAndSwapInt(this, eventCountOffset, c = eventCount, c+1);
769	<	if (eventWaiters != 0L)
770	<	releaseEventWaiters();
771	<	}
766	>	private boolean tryAwaitWork(ForkJoinWorkerThread w, long c) {
767	>	int v = w.eventCount;
768	>	w.nextWait = (int)c;                       // w's successor record
769	>	long nc = (long)(v & E_MASK) | ((c - AC_UNIT) & (AC_MASK|TC_MASK));
770	>	if (ctl != c || !UNSAFE.compareAndSwapLong(this, ctlOffset, c, nc)) {
771	>	long d = ctl; // return true if lost to a deq, to force rescan
772	>	return (int)d != (int)c && ((d - c) & AC_MASK) >= 0L;
773	>	}
774	>	if (parallelism + (int)(c >> AC_SHIFT) == 1 &&
775	>	blockedCount == 0 && quiescerCount == 0)
776	>	idleAwaitWork(w, v);               // quiescent -- maybe shrink
777
778	<	/**
779	<	* Adds the given worker to event queue and blocks until
780	<	* terminating or event count advances from the given value
781	<	*
782	<	* @param w the calling worker thread
783	<	* @param ec the count
784	<	*/
785	<	private void eventSync(ForkJoinWorkerThread w, int ec) {
786	<	long nh = (((long)ec) << EVENT_COUNT_SHIFT) | ((long)(w.poolIndex+1));
787	<	long h;
788	<	while ((runState < SHUTDOWN || !tryTerminate(false)) &&
789	<	(((int)((h = eventWaiters) & WAITER_ID_MASK)) == 0 ||
790	<	(int)(h >>> EVENT_COUNT_SHIFT) == ec) &&
791	<	eventCount == ec) {
792	<	if (UNSAFE.compareAndSwapLong(this, eventWaitersOffset,
793	<	w.nextWaiter = h, nh)) {
794	<	awaitEvent(w, ec);
795	<	break;
778	>	boolean rescanned = false;
779	>	for (int sc;;) {
780	>	if (w.eventCount != v)
781	>	return true;
782	>	if ((sc = w.stealCount) != 0) {
783	>	long s = stealCount;               // accumulate stealCount
784	>	if (UNSAFE.compareAndSwapLong(this, stealCountOffset, s, s+sc))
785	>	w.stealCount = 0;
786	>	}
787	>	else if (!rescanned) {
788	>	int g = scanGuard, m = g & SMASK;
789	>	ForkJoinWorkerThread[] ws = workers;
790	>	if (ws != null && m < ws.length) {
791	>	rescanned = true;
792	>	for (int i = 0; i <= m; ++i) {
793	>	ForkJoinWorkerThread u = ws[i];
794	>	if (u != null) {
795	>	if (u.queueBase != u.queueTop &&
796	>	!tryReleaseWaiter())
797	>	rescanned = false; // contended
798	>	if (w.eventCount != v)
799	>	return true;
800	>	}
801	>	}
802	>	}
803	>	if (scanGuard != g ||              // stale
804	>	(queueBase != queueTop && !tryReleaseWaiter()))
805	>	rescanned = false;
806	>	if (!rescanned)
807	>	Thread.yield();                // reduce contention
808	>	else
809	>	Thread.interrupted();          // clear before park
810	>	}
811	>	else {
812	>	w.parked = true;                   // must recheck
813	>	if (w.eventCount != v) {
814	>	w.parked = false;
815	>	return true;
816	>	}
817	>	LockSupport.park(this);
818	>	rescanned = w.parked = false;
819		}
820		}
821		}
822
823		/**
824	<	* Blocks the given worker (that has already been entered as an
825	<	* event waiter) until terminating or event count advances from
826	<	* the given value. The oldest (first) waiter uses a timed wait to
827	<	* occasionally one-by-one shrink the number of workers (to a
828	<	* minimum of one) if the pool has not been used for extended
829	<	* periods.
830	<	*
831	<	* @param w the calling worker thread
832	<	* @param ec the count
833	<	*/
834	<	private void awaitEvent(ForkJoinWorkerThread w, int ec) {
835	<	while (eventCount == ec) {
836	<	if (tryAccumulateStealCount(w)) { // transfer while idle
837	<	boolean untimed = (w.nextWaiter != 0L ||
838	<	(workerCounts & RUNNING_COUNT_MASK) <= 1);
839	<	long startTime = untimed? 0 : System.nanoTime();
840	<	Thread.interrupted();         // clear/ignore interrupt
841	<	if (eventCount != ec || w.runState != 0 ||
842	<	runState >= TERMINATING)  // recheck after clear
843	<	break;
844	<	if (untimed)
845	<	LockSupport.park(w);
846	<	else {
847	<	LockSupport.parkNanos(w, SHRINK_RATE_NANOS);
848	<	if (eventCount != ec || w.runState != 0 ||
849	<	runState >= TERMINATING)
850	<	break;
851	<	if (System.nanoTime() - startTime >= SHRINK_RATE_NANOS)
852	<	tryShutdownUnusedWorker(ec);
824	>	* If pool is quiescent, checks for termination, and waits for
825	>	* event signal for up to SHRINK_RATE nanosecs. On timeout, if ctl
826	>	* has not changed, terminates the worker. Upon its termination
827	>	* (see deregisterWorker), it may wake up another worker to
828	>	* possibly repeat this process.
829	>	*
830	>	* @param w the calling worker
831	>	* @param v the eventCount w must wait until changed
832	>	*/
833	>	private void idleAwaitWork(ForkJoinWorkerThread w, int v) {
834	>	ForkJoinTask.helpExpungeStaleExceptions(); // help clean weak refs
835	>	if (shutdown)
836	>	tryTerminate(false);
837	>	long c = ctl;
838	>	long nc = (((c & (AC_MASK|TC_MASK)) + AC_UNIT) |
839	>	(long)(w.nextWait & E_MASK)); // ctl value to release w
840	>	if (w.eventCount == v &&
841	>	parallelism + (int)(c >> AC_SHIFT) == 0 &&
842	>	blockedCount == 0 && quiescerCount == 0) {
843	>	long startTime = System.nanoTime();
844	>	Thread.interrupted();
845	>	if (w.eventCount == v) {
846	>	w.parked = true;
847	>	if (w.eventCount == v)
848	>	LockSupport.parkNanos(this, SHRINK_RATE);
849	>	w.parked = false;
850	>	if (w.eventCount == v && ctl == c &&
851	>	System.nanoTime() - startTime >= SHRINK_RATE &&
852	>	UNSAFE.compareAndSwapLong(this, ctlOffset, c, nc)) {
853	>	w.terminate = true;
854	>	w.eventCount = ((int)c + EC_UNIT) & E_MASK;
855		}
856		}
857		}
858		}
859
860	<	// Maintaining parallelism
860	>	// Submissions
861
862		/**
863	<	* Pushes worker onto the spare stack
863	>	* Enqueues the given task in the submissionQueue.  Same idea as
864	>	* ForkJoinWorkerThread.pushTask except for use of submissionLock.
865	>	*
866	>	* @param t the task
867		*/
868	<	final void pushSpare(ForkJoinWorkerThread w) {
869	<	int ns = (++w.spareCount << SPARE_COUNT_SHIFT) | (w.poolIndex + 1);
870	<	do {} while (!UNSAFE.compareAndSwapInt(this, spareWaitersOffset,
871	<	w.nextSpare = spareWaiters,ns));
868	>	private void addSubmission(ForkJoinTask<?> t) {
869	>	final ReentrantLock lock = this.submissionLock;
870	>	lock.lock();
871	>	try {
872	>	ForkJoinTask<?>[] q; int s, m;
873	>	if ((q = submissionQueue) != null) {    // ignore if queue removed
874	>	long u = (((s = queueTop) & (m = q.length-1)) << ASHIFT)+ABASE;
875	>	UNSAFE.putOrderedObject(q, u, t);
876	>	queueTop = s + 1;
877	>	if (s - queueBase == m)
878	>	growSubmissionQueue();
879	>	}
880	>	} finally {
881	>	lock.unlock();
882	>	}
883	>	signalWork();
884		}
885
886	+	//  (pollSubmission is defined below with exported methods)
887	+
888		/**
889	<	* Tries (once) to resume a spare if the number of running
890	<	* threads is less than target.
889	>	* Creates or doubles submissionQueue array.
890	>	* Basically identical to ForkJoinWorkerThread version
891		*/
892	<	private void tryResumeSpare() {
893	<	int sw, id;
894	<	ForkJoinWorkerThread[] ws = workers;
895	<	int n = ws.length;
896	<	ForkJoinWorkerThread w;
897	<	if ((sw = spareWaiters) != 0 &&
898	<	(id = (sw & SPARE_ID_MASK) - 1) >= 0 &&
899	<	id < n && (w = ws[id]) != null &&
900	<	(workerCounts & RUNNING_COUNT_MASK) < parallelism &&
901	<	spareWaiters == sw &&
902	<	UNSAFE.compareAndSwapInt(this, spareWaitersOffset,
903	<	sw, w.nextSpare)) {
904	<	int c; // increment running count before resume
905	<	do {} while (!UNSAFE.compareAndSwapInt
906	<	(this, workerCountsOffset,
907	<	c = workerCounts, c + ONE_RUNNING));
908	<	if (w.tryUnsuspend())
909	<	LockSupport.unpark(w);
910	<	else   // back out if w was shutdown
840	<	decrementWorkerCounts(ONE_RUNNING, 0);
892	>	private void growSubmissionQueue() {
893	>	ForkJoinTask<?>[] oldQ = submissionQueue;
894	>	int size = oldQ != null ? oldQ.length << 1 : INITIAL_QUEUE_CAPACITY;
895	>	if (size > MAXIMUM_QUEUE_CAPACITY)
896	>	throw new RejectedExecutionException("Queue capacity exceeded");
897	>	if (size < INITIAL_QUEUE_CAPACITY)
898	>	size = INITIAL_QUEUE_CAPACITY;
899	>	ForkJoinTask<?>[] q = submissionQueue = new ForkJoinTask<?>[size];
900	>	int mask = size - 1;
901	>	int top = queueTop;
902	>	int oldMask;
903	>	if (oldQ != null && (oldMask = oldQ.length - 1) >= 0) {
904	>	for (int b = queueBase; b != top; ++b) {
905	>	long u = ((b & oldMask) << ASHIFT) + ABASE;
906	>	Object x = UNSAFE.getObjectVolatile(oldQ, u);
907	>	if (x != null && UNSAFE.compareAndSwapObject(oldQ, u, x, null))
908	>	UNSAFE.putObjectVolatile
909	>	(q, ((b & mask) << ASHIFT) + ABASE, x);
910	>	}
911		}
912		}
913
914	+	// Blocking support
915	+
916		/**
917	<	* Tries to increase the number of running workers if below target
918	<	* parallelism: If a spare exists tries to resume it via
919	<	* tryResumeSpare.  Otherwise, if not enough total workers or all
920	<	* existing workers are busy, adds a new worker. In all cases also
921	<	* helps wake up releasable workers waiting for work.
922	<	*/
923	<	private void helpMaintainParallelism() {
924	<	int pc = parallelism;
925	<	int wc, rs, tc;
926	<	while (((wc = workerCounts) & RUNNING_COUNT_MASK) < pc &&
927	<	(rs = runState) < TERMINATING) {
928	<	if (spareWaiters != 0)
929	<	tryResumeSpare();
930	<	else if ((tc = wc >>> TOTAL_COUNT_SHIFT) >= MAX_WORKERS ||
931	<	(tc >= pc && (rs & ACTIVE_COUNT_MASK) != tc))
932	<	break;   // enough total
933	<	else if (runState == rs && workerCounts == wc &&
934	<	UNSAFE.compareAndSwapInt(this, workerCountsOffset, wc,
935	<	wc + (ONE_RUNNING|ONE_TOTAL))) {
936	<	ForkJoinWorkerThread w = null;
937	<	try {
938	<	w = factory.newThread(this);
939	<	} finally { // adjust on null or exceptional factory return
940	<	if (w == null) {
941	<	decrementWorkerCounts(ONE_RUNNING, ONE_TOTAL);
942	<	tryTerminate(false); // handle failure during shutdown
917	>	* Tries to increment blockedCount, decrement active count
918	>	* (sometimes implicitly) and possibly release or create a
919	>	* compensating worker in preparation for blocking. Fails
920	>	* on contention or termination.
921	>	*
922	>	* @return true if the caller can block, else should recheck and retry
923	>	*/
924	>	private boolean tryPreBlock() {
925	>	int b = blockedCount;
926	>	if (UNSAFE.compareAndSwapInt(this, blockedCountOffset, b, b + 1)) {
927	>	int pc = parallelism;
928	>	do {
929	>	ForkJoinWorkerThread[] ws; ForkJoinWorkerThread w;
930	>	int e, ac, tc, rc, i;
931	>	long c = ctl;
932	>	int u = (int)(c >>> 32);
933	>	if ((e = (int)c) < 0) {
934	>	// skip -- terminating
935	>	}
936	>	else if ((ac = (u >> UAC_SHIFT)) <= 0 && e != 0 &&
937	>	(ws = workers) != null &&
938	>	(i = ~e & SMASK) < ws.length &&
939	>	(w = ws[i]) != null) {
940	>	long nc = ((long)(w.nextWait & E_MASK) |
941	>	(c & (AC_MASK|TC_MASK)));
942	>	if (w.eventCount == e &&
943	>	UNSAFE.compareAndSwapLong(this, ctlOffset, c, nc)) {
944	>	w.eventCount = (e + EC_UNIT) & E_MASK;
945	>	if (w.parked)
946	>	UNSAFE.unpark(w);
947	>	return true;             // release an idle worker
948		}
949		}
950	<	if (w == null)
951	<	break;
952	<	w.start(recordWorker(w), ueh);
953	<	if ((workerCounts >>> TOTAL_COUNT_SHIFT) >= pc) {
877	<	int c; // advance event count
878	<	UNSAFE.compareAndSwapInt(this, eventCountOffset,
879	<	c = eventCount, c+1);
880	<	break; // add at most one unless total below target
950	>	else if ((tc = (short)(u >>> UTC_SHIFT)) >= 0 && ac + pc > 1) {
951	>	long nc = ((c - AC_UNIT) & AC_MASK) | (c & ~AC_MASK);
952	>	if (UNSAFE.compareAndSwapLong(this, ctlOffset, c, nc))
953	>	return true;             // no compensation needed
954		}
955	<	}
955	>	else if (tc + pc < MAX_ID) {
956	>	long nc = ((c + TC_UNIT) & TC_MASK) | (c & ~TC_MASK);
957	>	if (UNSAFE.compareAndSwapLong(this, ctlOffset, c, nc)) {
958	>	addWorker();
959	>	return true;            // create a replacement
960	>	}
961	>	}
962	>	// try to back out on any failure and let caller retry
963	>	} while (!UNSAFE.compareAndSwapInt(this, blockedCountOffset,
964	>	b = blockedCount, b - 1));
965		}
966	<	if (eventWaiters != 0L)
885	<	releaseEventWaiters();
966	>	return false;
967		}
968
969		/**
970	<	* Callback from the oldest waiter in awaitEvent waking up after a
890	<	* period of non-use. If all workers are idle, tries (once) to
891	<	* shutdown an event waiter or a spare, if one exists. Note that
892	<	* we don't need CAS or locks here because the method is called
893	<	* only from one thread occasionally waking (and even misfires are
894	<	* OK). Note that until the shutdown worker fully terminates,
895	<	* workerCounts will overestimate total count, which is tolerable.
896	<	*
897	<	* @param ec the event count waited on by caller (to abort
898	<	* attempt if count has since changed).
970	>	* Decrements blockedCount and increments active count
971		*/
972	<	private void tryShutdownUnusedWorker(int ec) {
973	<	if (runState == 0 && eventCount == ec) { // only trigger if all idle
974	<	ForkJoinWorkerThread[] ws = workers;
975	<	int n = ws.length;
976	<	ForkJoinWorkerThread w = null;
977	<	boolean shutdown = false;
978	<	int sw;
907	<	long h;
908	<	if ((sw = spareWaiters) != 0) { // prefer killing spares
909	<	int id = (sw & SPARE_ID_MASK) - 1;
910	<	if (id >= 0 && id < n && (w = ws[id]) != null &&
911	<	UNSAFE.compareAndSwapInt(this, spareWaitersOffset,
912	<	sw, w.nextSpare))
913	<	shutdown = true;
914	<	}
915	<	else if ((h = eventWaiters) != 0L) {
916	<	long nh;
917	<	int id = ((int)(h & WAITER_ID_MASK)) - 1;
918	<	if (id >= 0 && id < n && (w = ws[id]) != null &&
919	<	(nh = w.nextWaiter) != 0L && // keep at least one worker
920	<	UNSAFE.compareAndSwapLong(this, eventWaitersOffset, h, nh))
921	<	shutdown = true;
922	<	}
923	<	if (w != null && shutdown) {
924	<	w.shutdown();
925	<	LockSupport.unpark(w);
926	<	}
927	<	}
928	<	releaseEventWaiters(); // in case of interference
972	>	private void postBlock() {
973	>	long c;
974	>	do {} while (!UNSAFE.compareAndSwapLong(this, ctlOffset,  // no mask
975	>	c = ctl, c + AC_UNIT));
976	>	int b;
977	>	do {} while(!UNSAFE.compareAndSwapInt(this, blockedCountOffset,
978	>	b = blockedCount, b - 1));
979		}
980
981		/**
982	<	* Callback from workers invoked upon each top-level action (i.e.,
983	<	* stealing a task or taking a submission and running it).
934	<	* Performs one or more of the following:
935	<	*
936	<	* 1. If the worker is active and either did not run a task
937	<	*    or there are too many workers, try to set its active status
938	<	*    to inactive and update activeCount. On contention, we may
939	<	*    try again in this or a subsequent call.
940	<	*
941	<	* 2. If not enough total workers, help create some.
942	<	*
943	<	* 3. If there are too many running workers, suspend this worker
944	<	*    (first forcing inactive if necessary).  If it is not needed,
945	<	*    it may be shutdown while suspended (via
946	<	*    tryShutdownUnusedWorker).  Otherwise, upon resume it
947	<	*    rechecks running thread count and need for event sync.
948	<	*
949	<	* 4. If worker did not run a task, await the next task event via
950	<	*    eventSync if necessary (first forcing inactivation), upon
951	<	*    which the worker may be shutdown via
952	<	*    tryShutdownUnusedWorker.  Otherwise, help release any
953	<	*    existing event waiters that are now releasable,
982	>	* Possibly blocks waiting for the given task to complete, or
983	>	* cancels the task if terminating.  Fails to wait if contended.
984		*
985	<	* @param w the worker
956	<	* @param ran true if worker ran a task since last call to this method
985	>	* @param joinMe the task
986		*/
987	<	final void preStep(ForkJoinWorkerThread w, boolean ran) {
988	<	int wec = w.lastEventCount;
989	<	boolean active = w.active;
990	<	boolean inactivate = false;
991	<	int pc = parallelism;
992	<	int rs;
993	<	while (w.runState == 0 && (rs = runState) < TERMINATING) {
965	<	if ((inactivate || (active && (rs & ACTIVE_COUNT_MASK) >= pc)) &&
966	<	UNSAFE.compareAndSwapInt(this, runStateOffset, rs, rs - 1))
967	<	inactivate = active = w.active = false;
968	<	int wc = workerCounts;
969	<	if ((wc & RUNNING_COUNT_MASK) > pc) {
970	<	if (!(inactivate |= active) && // must inactivate to suspend
971	<	workerCounts == wc &&      // try to suspend as spare
972	<	UNSAFE.compareAndSwapInt(this, workerCountsOffset,
973	<	wc, wc - ONE_RUNNING))
974	<	w.suspendAsSpare();
975	<	}
976	<	else if ((wc >>> TOTAL_COUNT_SHIFT) < pc)
977	<	helpMaintainParallelism();     // not enough workers
978	<	else if (!ran) {
979	<	long h = eventWaiters;
980	<	int ec = eventCount;
981	<	if (h != 0L && (int)(h >>> EVENT_COUNT_SHIFT) != ec)
982	<	releaseEventWaiters();     // release others before waiting
983	<	else if (ec != wec) {
984	<	w.lastEventCount = ec;     // no need to wait
985	<	break;
986	<	}
987	<	else if (!(inactivate |= active))
988	<	eventSync(w, wec);         // must inactivate before sync
987	>	final void tryAwaitJoin(ForkJoinTask<?> joinMe) {
988	>	int s;
989	>	Thread.interrupted(); // clear interrupts before checking termination
990	>	if (joinMe.status >= 0) {
991	>	if (tryPreBlock()) {
992	>	joinMe.tryAwaitDone(0L);
993	>	postBlock();
994		}
995	<	else
996	<	break;
995	>	if ((ctl & STOP_BIT) != 0L)
996	>	joinMe.cancelIgnoringExceptions();
997		}
998		}
999
1000		/**
1001	<	* Helps and/or blocks awaiting join of the given task.
1002	<	* See above for explanation.
1001	>	* Possibly blocks the given worker waiting for joinMe to
1002	>	* complete or timeout
1003		*
1004	<	* @param joinMe the task to join
1005	<	* @param worker the current worker thread
1004	>	* @param joinMe the task
1005	>	* @param millis the wait time for underlying Object.wait
1006		*/
1007	<	final void awaitJoin(ForkJoinTask<?> joinMe, ForkJoinWorkerThread worker) {
1003	<	int retries = 2 + (parallelism >> 2); // #helpJoins before blocking
1007	>	final void timedAwaitJoin(ForkJoinTask<?> joinMe, long nanos) {
1008		while (joinMe.status >= 0) {
1009	<	int wc;
1010	<	worker.helpJoinTask(joinMe);
1011	<	if (joinMe.status < 0)
1009	>	Thread.interrupted();
1010	>	if ((ctl & STOP_BIT) != 0L) {
1011	>	joinMe.cancelIgnoringExceptions();
1012	>	break;
1013	>	}
1014	>	if (tryPreBlock()) {
1015	>	long last = System.nanoTime();
1016	>	while (joinMe.status >= 0) {
1017	>	long millis = TimeUnit.NANOSECONDS.toMillis(nanos);
1018	>	if (millis <= 0)
1019	>	break;
1020	>	joinMe.tryAwaitDone(millis);
1021	>	if (joinMe.status < 0)
1022	>	break;
1023	>	if ((ctl & STOP_BIT) != 0L) {
1024	>	joinMe.cancelIgnoringExceptions();
1025	>	break;
1026	>	}
1027	>	long now = System.nanoTime();
1028	>	nanos -= now - last;
1029	>	last = now;
1030	>	}
1031	>	postBlock();
1032		break;
1009	–	else if (retries > 0)
1010	–	--retries;
1011	–	else if (((wc = workerCounts) & RUNNING_COUNT_MASK) != 0 &&
1012	–	UNSAFE.compareAndSwapInt(this, workerCountsOffset,
1013	–	wc, wc - ONE_RUNNING)) {
1014	–	int stat, c; long h;
1015	–	while ((stat = joinMe.status) >= 0 &&
1016	–	(h = eventWaiters) != 0L && // help release others
1017	–	(int)(h >>> EVENT_COUNT_SHIFT) != eventCount)
1018	–	releaseEventWaiters();
1019	–	if (stat >= 0 &&
1020	–	((workerCounts & RUNNING_COUNT_MASK) == 0 ||
1021	–	(stat =
1022	–	joinMe.internalAwaitDone(JOIN_TIMEOUT_MILLIS)) >= 0))
1023	–	helpMaintainParallelism(); // timeout or no running workers
1024	–	do {} while (!UNSAFE.compareAndSwapInt
1025	–	(this, workerCountsOffset,
1026	–	c = workerCounts, c + ONE_RUNNING));
1027	–	if (stat < 0)
1028	–	break;   // else restart
1033		}
1034		}
1035		}
1036
1037		/**
1038	<	* Same idea as awaitJoin, but no helping, retries, or timeouts.
1038	>	* If necessary, compensates for blocker, and blocks
1039		*/
1040	<	final void awaitBlocker(ManagedBlocker blocker)
1040	>	private void awaitBlocker(ManagedBlocker blocker)
1041		throws InterruptedException {
1042		while (!blocker.isReleasable()) {
1043	<	int wc = workerCounts;
1040	<	if ((wc & RUNNING_COUNT_MASK) != 0 &&
1041	<	UNSAFE.compareAndSwapInt(this, workerCountsOffset,
1042	<	wc, wc - ONE_RUNNING)) {
1043	>	if (tryPreBlock()) {
1044		try {
1045	<	while (!blocker.isReleasable()) {
1045	<	long h = eventWaiters;
1046	<	if (h != 0L &&
1047	<	(int)(h >>> EVENT_COUNT_SHIFT) != eventCount)
1048	<	releaseEventWaiters();
1049	<	else if ((workerCounts & RUNNING_COUNT_MASK) == 0 &&
1050	<	runState < TERMINATING)
1051	<	helpMaintainParallelism();
1052	<	else if (blocker.block())
1053	<	break;
1054	<	}
1045	>	do {} while (!blocker.isReleasable() && !blocker.block());
1046		} finally {
1047	<	int c;
1057	<	do {} while (!UNSAFE.compareAndSwapInt
1058	<	(this, workerCountsOffset,
1059	<	c = workerCounts, c + ONE_RUNNING));
1047	>	postBlock();
1048		}
1049		break;
1050		}
1051		}
1052		}
1053
1054	+	// Creating, registering and deregistring workers
1055	+
1056	+	/**
1057	+	* Tries to create and start a worker; minimally rolls back counts
1058	+	* on failure.
1059	+	*/
1060	+	private void addWorker() {
1061	+	Throwable ex = null;
1062	+	ForkJoinWorkerThread t = null;
1063	+	try {
1064	+	t = factory.newThread(this);
1065	+	} catch (Throwable e) {
1066	+	ex = e;
1067	+	}
1068	+	if (t == null) {  // null or exceptional factory return
1069	+	long c;       // adjust counts
1070	+	do {} while (!UNSAFE.compareAndSwapLong
1071	+	(this, ctlOffset, c = ctl,
1072	+	(((c - AC_UNIT) & AC_MASK) |
1073	+	((c - TC_UNIT) & TC_MASK) |
1074	+	(c & ~(AC_MASK|TC_MASK)))));
1075	+	// Propagate exception if originating from an external caller
1076	+	if (!tryTerminate(false) && ex != null &&
1077	+	!(Thread.currentThread() instanceof ForkJoinWorkerThread))
1078	+	UNSAFE.throwException(ex);
1079	+	}
1080	+	else
1081	+	t.start();
1082	+	}
1083	+
1084	+	/**
1085	+	* Callback from ForkJoinWorkerThread constructor to assign a
1086	+	* public name
1087	+	*/
1088	+	final String nextWorkerName() {
1089	+	for (int n;;) {
1090	+	if (UNSAFE.compareAndSwapInt(this, nextWorkerNumberOffset,
1091	+	n = nextWorkerNumber, ++n))
1092	+	return workerNamePrefix + n;
1093	+	}
1094	+	}
1095	+
1096	+	/**
1097	+	* Callback from ForkJoinWorkerThread constructor to
1098	+	* determine its poolIndex and record in workers array.
1099	+	*
1100	+	* @param w the worker
1101	+	* @return the worker's pool index
1102	+	*/
1103	+	final int registerWorker(ForkJoinWorkerThread w) {
1104	+	/*
1105	+	* In the typical case, a new worker acquires the lock, uses
1106	+	* next available index and returns quickly.  Since we should
1107	+	* not block callers (ultimately from signalWork or
1108	+	* tryPreBlock) waiting for the lock needed to do this, we
1109	+	* instead help release other workers while waiting for the
1110	+	* lock.
1111	+	*/
1112	+	for (int g;;) {
1113	+	ForkJoinWorkerThread[] ws;
1114	+	if (((g = scanGuard) & SG_UNIT) == 0 &&
1115	+	UNSAFE.compareAndSwapInt(this, scanGuardOffset,
1116	+	g, g | SG_UNIT)) {
1117	+	int k = nextWorkerIndex;
1118	+	try {
1119	+	if ((ws = workers) != null) { // ignore on shutdown
1120	+	int n = ws.length;
1121	+	if (k < 0 || k >= n || ws[k] != null) {
1122	+	for (k = 0; k < n && ws[k] != null; ++k)
1123	+	;
1124	+	if (k == n)
1125	+	ws = workers = Arrays.copyOf(ws, n << 1);
1126	+	}
1127	+	ws[k] = w;
1128	+	nextWorkerIndex = k + 1;
1129	+	int m = g & SMASK;
1130	+	g = k >= m? ((m << 1) + 1) & SMASK : g + (SG_UNIT<<1);
1131	+	}
1132	+	} finally {
1133	+	scanGuard = g;
1134	+	}
1135	+	return k;
1136	+	}
1137	+	else if ((ws = workers) != null) { // help release others
1138	+	for (ForkJoinWorkerThread u : ws) {
1139	+	if (u != null && u.queueBase != u.queueTop) {
1140	+	if (tryReleaseWaiter())
1141	+	break;
1142	+	}
1143	+	}
1144	+	}
1145	+	}
1146	+	}
1147	+
1148	+	/**
1149	+	* Final callback from terminating worker.  Removes record of
1150	+	* worker from array, and adjusts counts. If pool is shutting
1151	+	* down, tries to complete termination.
1152	+	*
1153	+	* @param w the worker
1154	+	*/
1155	+	final void deregisterWorker(ForkJoinWorkerThread w, Throwable ex) {
1156	+	int idx = w.poolIndex;
1157	+	int sc = w.stealCount;
1158	+	int steps = 0;
1159	+	// Remove from array, adjust worker counts and collect steal count.
1160	+	// We can intermix failed removes or adjusts with steal updates
1161	+	do {
1162	+	long s, c;
1163	+	int g;
1164	+	if (steps == 0 && ((g = scanGuard) & SG_UNIT) == 0 &&
1165	+	UNSAFE.compareAndSwapInt(this, scanGuardOffset,
1166	+	g, g |= SG_UNIT)) {
1167	+	ForkJoinWorkerThread[] ws = workers;
1168	+	if (ws != null && idx >= 0 &&
1169	+	idx < ws.length && ws[idx] == w)
1170	+	ws[idx] = null;    // verify
1171	+	nextWorkerIndex = idx;
1172	+	scanGuard = g + SG_UNIT;
1173	+	steps = 1;
1174	+	}
1175	+	if (steps == 1 &&
1176	+	UNSAFE.compareAndSwapLong(this, ctlOffset, c = ctl,
1177	+	(((c - AC_UNIT) & AC_MASK) |
1178	+	((c - TC_UNIT) & TC_MASK) |
1179	+	(c & ~(AC_MASK|TC_MASK)))))
1180	+	steps = 2;
1181	+	if (sc != 0 &&
1182	+	UNSAFE.compareAndSwapLong(this, stealCountOffset,
1183	+	s = stealCount, s + sc))
1184	+	sc = 0;
1185	+	} while (steps != 2 || sc != 0);
1186	+	if (!tryTerminate(false)) {
1187	+	if (ex != null)   // possibly replace if died abnormally
1188	+	signalWork();
1189	+	else
1190	+	tryReleaseWaiter();
1191	+	}
1192	+	}
1193	+
1194	+	// Shutdown and termination
1195	+
1196		/**
1197		* Possibly initiates and/or completes termination.
1198		*
#	Line 1071 | Line 1201 | public class ForkJoinPool extends Abstra
1201		* @return true if now terminating or terminated
1202		*/
1203		private boolean tryTerminate(boolean now) {
1204	<	if (now)
1205	<	advanceRunLevel(SHUTDOWN); // ensure at least SHUTDOWN
1206	<	else if (runState < SHUTDOWN ||
1207	<	!submissionQueue.isEmpty() ||
1208	<	(runState & ACTIVE_COUNT_MASK) != 0)
1209	<	return false;
1210	<
1211	<	if (advanceRunLevel(TERMINATING))
1212	<	startTerminating();
1213	<
1214	<	// Finish now if all threads terminated; else in some subsequent call
1215	<	if ((workerCounts >>> TOTAL_COUNT_SHIFT) == 0) {
1216	<	advanceRunLevel(TERMINATED);
1217	<	termination.arrive();
1204	>	long c;
1205	>	while (((c = ctl) & STOP_BIT) == 0) {
1206	>	if (!now) {
1207	>	if ((int)(c >> AC_SHIFT) != -parallelism)
1208	>	return false;
1209	>	if (!shutdown || blockedCount != 0 || quiescerCount != 0 ||
1210	>	queueTop - queueBase > 0) {
1211	>	if (ctl == c) // staleness check
1212	>	return false;
1213	>	continue;
1214	>	}
1215	>	}
1216	>	if (UNSAFE.compareAndSwapLong(this, ctlOffset, c, c | STOP_BIT))
1217	>	startTerminating();
1218	>	}
1219	>	if ((short)(c >>> TC_SHIFT) == -parallelism) {
1220	>	submissionLock.lock();
1221	>	termination.signalAll();
1222	>	submissionLock.unlock();
1223		}
1224		return true;
1225		}
1226
1227		/**
1228	<	* Actions on transition to TERMINATING
1229	<	*
1230	<	* Runs up to four passes through workers: (0) shutting down each
1231	<	* (without waking up if parked) to quickly spread notifications
1232	<	* without unnecessary bouncing around event queues etc (1) wake
1233	<	* up and help cancel tasks (2) interrupt (3) mop up races with
1099	<	* interrupted workers
1228	>	* Runs up to three passes through workers: (0) Setting
1229	>	* termination status for each worker, followed by wakeups up
1230	>	* queued workers (1) helping cancel tasks (2) interrupting
1231	>	* lagging threads (likely in external tasks, but possibly also
1232	>	* blocked in joins).  Each pass repeats previous steps because of
1233	>	* potential lagging thread creation.
1234		*/
1235		private void startTerminating() {
1236		cancelSubmissions();
1237	<	for (int passes = 0; passes < 4 && workerCounts != 0; ++passes) {
1238	<	int c; // advance event count
1239	<	UNSAFE.compareAndSwapInt(this, eventCountOffset,
1240	<	c = eventCount, c+1);
1241	<	eventWaiters = 0L; // clobber lists
1242	<	spareWaiters = 0;
1243	<	for (ForkJoinWorkerThread w : workers) {
1244	<	if (w != null) {
1245	<	w.shutdown();
1246	<	if (passes > 0 && !w.isTerminated()) {
1247	<	w.cancelTasks();
1248	<	LockSupport.unpark(w);
1249	<	if (passes > 1) {
1116	<	try {
1117	<	w.interrupt();
1118	<	} catch (SecurityException ignore) {
1237	>	for (int pass = 0; pass < 3; ++pass) {
1238	>	ForkJoinWorkerThread[] ws = workers;
1239	>	if (ws != null) {
1240	>	for (ForkJoinWorkerThread w : ws) {
1241	>	if (w != null) {
1242	>	w.terminate = true;
1243	>	if (pass > 0) {
1244	>	w.cancelTasks();
1245	>	if (pass > 1 && !w.isInterrupted()) {
1246	>	try {
1247	>	w.interrupt();
1248	>	} catch (SecurityException ignore) {
1249	>	}
1250		}
1251		}
1252		}
1253		}
1254	+	terminateWaiters();
1255		}
1256		}
1257		}
1258
1259		/**
1260	<	* Clears out and cancels submissions, ignoring exceptions.
1260	>	* Polls and cancels all submissions. Called only during termination.
1261		*/
1262		private void cancelSubmissions() {
1263	<	ForkJoinTask<?> task;
1264	<	while ((task = submissionQueue.poll()) != null) {
1265	<	try {
1266	<	task.cancel(false);
1267	<	} catch (Throwable ignore) {
1263	>	while (queueBase != queueTop) {
1264	>	ForkJoinTask<?> task = pollSubmission();
1265	>	if (task != null) {
1266	>	try {
1267	>	task.cancel(false);
1268	>	} catch (Throwable ignore) {
1269	>	}
1270		}
1271		}
1272		}
1273
1274	<	// misc support for ForkJoinWorkerThread
1274	>	/**
1275	>	* Tries to set the termination status of waiting workers, and
1276	>	* then wake them up (after which they will terminate).
1277	>	*/
1278	>	private void terminateWaiters() {
1279	>	ForkJoinWorkerThread[] ws = workers;
1280	>	if (ws != null) {
1281	>	ForkJoinWorkerThread w; long c; int i, e;
1282	>	int n = ws.length;
1283	>	while ((i = ~(e = (int)(c = ctl)) & SMASK) < n &&
1284	>	(w = ws[i]) != null && w.eventCount == (e & E_MASK)) {
1285	>	if (UNSAFE.compareAndSwapLong(this, ctlOffset, c,
1286	>	(long)(w.nextWait & E_MASK) |
1287	>	((c + AC_UNIT) & AC_MASK) |
1288	>	(c & (TC_MASK|STOP_BIT)))) {
1289	>	w.terminate = true;
1290	>	w.eventCount = e + EC_UNIT;
1291	>	if (w.parked)
1292	>	UNSAFE.unpark(w);
1293	>	}
1294	>	}
1295	>	}
1296	>	}
1297	>
1298	>	// misc ForkJoinWorkerThread support
1299
1300		/**
1301	<	* Returns pool number.
1301	>	* Increment or decrement quiescerCount. Needed only to prevent
1302	>	* triggering shutdown if a worker is transiently inactive while
1303	>	* checking quiescence.
1304	>	*
1305	>	* @param delta 1 for increment, -1 for decrement
1306		*/
1307	<	final int getPoolNumber() {
1308	<	return poolNumber;
1307	>	final void addQuiescerCount(int delta) {
1308	>	int c;
1309	>	do {} while(!UNSAFE.compareAndSwapInt(this, quiescerCountOffset,
1310	>	c = quiescerCount, c + delta));
1311		}
1312
1313		/**
1314	<	* Tries to accumulate steal count from a worker, clearing
1315	<	* the worker's value if successful.
1314	>	* Directly increment or decrement active count without
1315	>	* queuing. This method is used to transiently assert inactivation
1316	>	* while checking quiescence.
1317		*
1318	<	* @return true if worker steal count now zero
1318	>	* @param delta 1 for increment, -1 for decrement
1319		*/
1320	<	final boolean tryAccumulateStealCount(ForkJoinWorkerThread w) {
1321	<	int sc = w.stealCount;
1322	<	long c = stealCount;
1323	<	// CAS even if zero, for fence effects
1324	<	if (UNSAFE.compareAndSwapLong(this, stealCountOffset, c, c + sc)) {
1325	<	if (sc != 0)
1161	<	w.stealCount = 0;
1162	<	return true;
1163	<	}
1164	<	return sc == 0;
1320	>	final void addActiveCount(int delta) {
1321	>	long d = delta < 0 ? -AC_UNIT : AC_UNIT;
1322	>	long c;
1323	>	do {} while (!UNSAFE.compareAndSwapLong(this, ctlOffset, c = ctl,
1324	>	((c + d) & AC_MASK) |
1325	>	(c & ~AC_MASK)));
1326		}
1327
1328		/**
#	Line 1169 | Line 1330 | public class ForkJoinPool extends Abstra
1330		* active thread.
1331		*/
1332		final int idlePerActive() {
1333	<	int pc = parallelism; // use parallelism, not rc
1334	<	int ac = runState;    // no mask -- artificially boosts during shutdown
1335	<	// Use exact results for small values, saturate past 4
1336	<	return ((pc <= ac) ? 0 :
1337	<	(pc >>> 1 <= ac) ? 1 :
1338	<	(pc >>> 2 <= ac) ? 3 :
1339	<	pc >>> 3);
1333	>	// Approximate at powers of two for small values, saturate past 4
1334	>	int p = parallelism;
1335	>	int a = p + (int)(ctl >> AC_SHIFT);
1336	>	return (a > (p >>>= 1) ? 0 :
1337	>	a > (p >>>= 1) ? 1 :
1338	>	a > (p >>>= 1) ? 2 :
1339	>	a > (p >>>= 1) ? 4 :
1340	>	8);
1341		}
1342
1343	<	// Public and protected methods
1343	>	// Exported methods
1344
1345		// Constructors
1346
#	Line 1225 | Line 1387 | public class ForkJoinPool extends Abstra
1387		* use {@link #defaultForkJoinWorkerThreadFactory}.
1388		* @param handler the handler for internal worker threads that
1389		* terminate due to unrecoverable errors encountered while executing
1390	<	* tasks. For default value, use <code>null</code>.
1390	>	* tasks. For default value, use {@code null}.
1391		* @param asyncMode if true,
1392		* establishes local first-in-first-out scheduling mode for forked
1393		* tasks that are never joined. This mode may be more appropriate
1394		* than default locally stack-based mode in applications in which
1395		* worker threads only process event-style asynchronous tasks.
1396	<	* For default value, use <code>false</code>.
1396	>	* For default value, use {@code false}.
1397		* @throws IllegalArgumentException if parallelism less than or
1398		*         equal to zero, or greater than implementation limit
1399		* @throws NullPointerException if the factory is null
#	Line 1247 | Line 1409 | public class ForkJoinPool extends Abstra
1409		checkPermission();
1410		if (factory == null)
1411		throw new NullPointerException();
1412	<	if (parallelism <= 0 || parallelism > MAX_WORKERS)
1412	>	if (parallelism <= 0 || parallelism > MAX_ID)
1413		throw new IllegalArgumentException();
1414		this.parallelism = parallelism;
1415		this.factory = factory;
1416		this.ueh = handler;
1417		this.locallyFifo = asyncMode;
1418	<	int arraySize = initialArraySizeFor(parallelism);
1419	<	this.workers = new ForkJoinWorkerThread[arraySize];
1420	<	this.submissionQueue = new LinkedTransferQueue<ForkJoinTask<?>>();
1421	<	this.workerLock = new ReentrantLock();
1422	<	this.termination = new Phaser(1);
1423	<	this.poolNumber = poolNumberGenerator.incrementAndGet();
1424	<	}
1425	<
1426	<	/**
1427	<	* Returns initial power of two size for workers array.
1428	<	* @param pc the initial parallelism level
1429	<	*/
1430	<	private static int initialArraySizeFor(int pc) {
1431	<	// If possible, initially allocate enough space for one spare
1432	<	int size = pc < MAX_WORKERS ? pc + 1 : MAX_WORKERS;
1433	<	// See Hackers Delight, sec 3.2. We know MAX_WORKERS < (1 >>> 16)
1434	<	size |= size >>> 1;
1273	<	size |= size >>> 2;
1274	<	size |= size >>> 4;
1275	<	size |= size >>> 8;
1276	<	return size + 1;
1418	>	long np = (long)(-parallelism); // offset ctl counts
1419	>	this.ctl = ((np << AC_SHIFT) & AC_MASK) | ((np << TC_SHIFT) & TC_MASK);
1420	>	this.submissionQueue = new ForkJoinTask<?>[INITIAL_QUEUE_CAPACITY];
1421	>	// initialize workers array with room for 2*parallelism if possible
1422	>	int n = parallelism << 1;
1423	>	if (n >= MAX_ID)
1424	>	n = MAX_ID;
1425	>	else { // See Hackers Delight, sec 3.2, where n < (1 << 16)
1426	>	n |= n >>> 1; n |= n >>> 2; n |= n >>> 4; n |= n >>> 8;
1427	>	}
1428	>	workers = new ForkJoinWorkerThread[n + 1];
1429	>	this.submissionLock = new ReentrantLock();
1430	>	this.termination = submissionLock.newCondition();
1431	>	StringBuilder sb = new StringBuilder("ForkJoinPool-");
1432	>	sb.append(poolNumberGenerator.incrementAndGet());
1433	>	sb.append("-worker-");
1434	>	this.workerNamePrefix = sb.toString();
1435		}
1436
1437		// Execution methods
1438
1439		/**
1282	–	* Common code for execute, invoke and submit
1283	–	*/
1284	–	private <T> void doSubmit(ForkJoinTask<T> task) {
1285	–	if (task == null)
1286	–	throw new NullPointerException();
1287	–	if (runState >= SHUTDOWN)
1288	–	throw new RejectedExecutionException();
1289	–	submissionQueue.offer(task);
1290	–	int c; // try to increment event count -- CAS failure OK
1291	–	UNSAFE.compareAndSwapInt(this, eventCountOffset, c = eventCount, c+1);
1292	–	helpMaintainParallelism(); // create, start, or resume some workers
1293	–	}
1294	–
1295	–	/**
1440		* Performs the given task, returning its result upon completion.
1441	+	* If the computation encounters an unchecked Exception or Error,
1442	+	* it is rethrown as the outcome of this invocation.  Rethrown
1443	+	* exceptions behave in the same way as regular exceptions, but,
1444	+	* when possible, contain stack traces (as displayed for example
1445	+	* using {@code ex.printStackTrace()}) of both the current thread
1446	+	* as well as the thread actually encountering the exception;
1447	+	* minimally only the latter.
1448		*
1449		* @param task the task
1450		* @return the task's result
#	Line 1302 | Line 1453 | public class ForkJoinPool extends Abstra
1453		*         scheduled for execution
1454		*/
1455		public <T> T invoke(ForkJoinTask<T> task) {
1456	<	doSubmit(task);
1457	<	return task.join();
1456	>	Thread t = Thread.currentThread();
1457	>	if (task == null)
1458	>	throw new NullPointerException();
1459	>	if (shutdown)
1460	>	throw new RejectedExecutionException();
1461	>	if ((t instanceof ForkJoinWorkerThread) &&
1462	>	((ForkJoinWorkerThread)t).pool == this)
1463	>	return task.invoke();  // bypass submit if in same pool
1464	>	else {
1465	>	addSubmission(task);
1466	>	return task.join();
1467	>	}
1468	>	}
1469	>
1470	>	/**
1471	>	* Unless terminating, forks task if within an ongoing FJ
1472	>	* computation in the current pool, else submits as external task.
1473	>	*/
1474	>	private <T> void forkOrSubmit(ForkJoinTask<T> task) {
1475	>	ForkJoinWorkerThread w;
1476	>	Thread t = Thread.currentThread();
1477	>	if (shutdown)
1478	>	throw new RejectedExecutionException();
1479	>	if ((t instanceof ForkJoinWorkerThread) &&
1480	>	(w = (ForkJoinWorkerThread)t).pool == this)
1481	>	w.pushTask(task);
1482	>	else
1483	>	addSubmission(task);
1484		}
1485
1486		/**
#	Line 1315 | Line 1492 | public class ForkJoinPool extends Abstra
1492		*         scheduled for execution
1493		*/
1494		public void execute(ForkJoinTask<?> task) {
1495	<	doSubmit(task);
1495	>	if (task == null)
1496	>	throw new NullPointerException();
1497	>	forkOrSubmit(task);
1498		}
1499
1500		// AbstractExecutorService methods
#	Line 1326 | Line 1505 | public class ForkJoinPool extends Abstra
1505		*         scheduled for execution
1506		*/
1507		public void execute(Runnable task) {
1508	+	if (task == null)
1509	+	throw new NullPointerException();
1510		ForkJoinTask<?> job;
1511		if (task instanceof ForkJoinTask<?>) // avoid re-wrap
1512		job = (ForkJoinTask<?>) task;
1513		else
1514		job = ForkJoinTask.adapt(task, null);
1515	<	doSubmit(job);
1515	>	forkOrSubmit(job);
1516		}
1517
1518		/**
#	Line 1344 | Line 1525 | public class ForkJoinPool extends Abstra
1525		*         scheduled for execution
1526		*/
1527		public <T> ForkJoinTask<T> submit(ForkJoinTask<T> task) {
1528	<	doSubmit(task);
1528	>	if (task == null)
1529	>	throw new NullPointerException();
1530	>	forkOrSubmit(task);
1531		return task;
1532		}
1533
#	Line 1354 | Line 1537 | public class ForkJoinPool extends Abstra
1537		*         scheduled for execution
1538		*/
1539		public <T> ForkJoinTask<T> submit(Callable<T> task) {
1540	+	if (task == null)
1541	+	throw new NullPointerException();
1542		ForkJoinTask<T> job = ForkJoinTask.adapt(task);
1543	<	doSubmit(job);
1543	>	forkOrSubmit(job);
1544		return job;
1545		}
1546
#	Line 1365 | Line 1550 | public class ForkJoinPool extends Abstra
1550		*         scheduled for execution
1551		*/
1552		public <T> ForkJoinTask<T> submit(Runnable task, T result) {
1553	+	if (task == null)
1554	+	throw new NullPointerException();
1555		ForkJoinTask<T> job = ForkJoinTask.adapt(task, result);
1556	<	doSubmit(job);
1556	>	forkOrSubmit(job);
1557		return job;
1558		}
1559
#	Line 1376 | Line 1563 | public class ForkJoinPool extends Abstra
1563		*         scheduled for execution
1564		*/
1565		public ForkJoinTask<?> submit(Runnable task) {
1566	+	if (task == null)
1567	+	throw new NullPointerException();
1568		ForkJoinTask<?> job;
1569		if (task instanceof ForkJoinTask<?>) // avoid re-wrap
1570		job = (ForkJoinTask<?>) task;
1571		else
1572		job = ForkJoinTask.adapt(task, null);
1573	<	doSubmit(job);
1573	>	forkOrSubmit(job);
1574		return job;
1575		}
1576
#	Line 1441 | Line 1630 | public class ForkJoinPool extends Abstra
1630
1631		/**
1632		* Returns the number of worker threads that have started but not
1633	<	* yet terminated.  This result returned by this method may differ
1633	>	* yet terminated.  The result returned by this method may differ
1634		* from {@link #getParallelism} when threads are created to
1635		* maintain parallelism when others are cooperatively blocked.
1636		*
1637		* @return the number of worker threads
1638		*/
1639		public int getPoolSize() {
1640	<	return workerCounts >>> TOTAL_COUNT_SHIFT;
1640	>	return parallelism + (short)(ctl >>> TC_SHIFT);
1641		}
1642
1643		/**
#	Line 1470 | Line 1659 | public class ForkJoinPool extends Abstra
1659		* @return the number of worker threads
1660		*/
1661		public int getRunningThreadCount() {
1662	<	return workerCounts & RUNNING_COUNT_MASK;
1662	>	int r = parallelism + (int)(ctl >> AC_SHIFT);
1663	>	return r <= 0? 0 : r; // suppress momentarily negative values
1664		}
1665
1666		/**
#	Line 1481 | Line 1671 | public class ForkJoinPool extends Abstra
1671		* @return the number of active threads
1672		*/
1673		public int getActiveThreadCount() {
1674	<	return runState & ACTIVE_COUNT_MASK;
1674	>	int r = parallelism + (int)(ctl >> AC_SHIFT) + blockedCount;
1675	>	return r <= 0? 0 : r; // suppress momentarily negative values
1676		}
1677
1678		/**
#	Line 1496 | Line 1687 | public class ForkJoinPool extends Abstra
1687		* @return {@code true} if all threads are currently idle
1688		*/
1689		public boolean isQuiescent() {
1690	<	return (runState & ACTIVE_COUNT_MASK) == 0;
1690	>	return parallelism + (int)(ctl >> AC_SHIFT) + blockedCount == 0;
1691		}
1692
1693		/**
#	Line 1526 | Line 1717 | public class ForkJoinPool extends Abstra
1717		*/
1718		public long getQueuedTaskCount() {
1719		long count = 0;
1720	<	for (ForkJoinWorkerThread w : workers)
1721	<	if (w != null)
1722	<	count += w.getQueueSize();
1720	>	ForkJoinWorkerThread[] ws;
1721	>	if ((short)(ctl >>> TC_SHIFT) > -parallelism &&
1722	>	(ws = workers) != null) {
1723	>	for (ForkJoinWorkerThread w : ws)
1724	>	if (w != null)
1725	>	count -= w.queueBase - w.queueTop; // must read base first
1726	>	}
1727		return count;
1728		}
1729
1730		/**
1731		* Returns an estimate of the number of tasks submitted to this
1732	<	* pool that have not yet begun executing.  This method takes time
1733	<	* proportional to the number of submissions.
1732	>	* pool that have not yet begun executing.  This meThod may take
1733	>	* time proportional to the number of submissions.
1734		*
1735		* @return the number of queued submissions
1736		*/
1737		public int getQueuedSubmissionCount() {
1738	<	return submissionQueue.size();
1738	>	return -queueBase + queueTop;
1739		}
1740
1741		/**
#	Line 1550 | Line 1745 | public class ForkJoinPool extends Abstra
1745		* @return {@code true} if there are any queued submissions
1746		*/
1747		public boolean hasQueuedSubmissions() {
1748	<	return !submissionQueue.isEmpty();
1748	>	return queueBase != queueTop;
1749		}
1750
1751		/**
#	Line 1561 | Line 1756 | public class ForkJoinPool extends Abstra
1756		* @return the next submission, or {@code null} if none
1757		*/
1758		protected ForkJoinTask<?> pollSubmission() {
1759	<	return submissionQueue.poll();
1759	>	ForkJoinTask<?> t; ForkJoinTask<?>[] q; int b, i;
1760	>	while ((b = queueBase) != queueTop &&
1761	>	(q = submissionQueue) != null &&
1762	>	(i = (q.length - 1) & b) >= 0) {
1763	>	long u = (i << ASHIFT) + ABASE;
1764	>	if ((t = q[i]) != null &&
1765	>	queueBase == b &&
1766	>	UNSAFE.compareAndSwapObject(q, u, t, null)) {
1767	>	queueBase = b + 1;
1768	>	return t;
1769	>	}
1770	>	}
1771	>	return null;
1772		}
1773
1774		/**
#	Line 1582 | Line 1789 | public class ForkJoinPool extends Abstra
1789		* @return the number of elements transferred
1790		*/
1791		protected int drainTasksTo(Collection<? super ForkJoinTask<?>> c) {
1792	<	int count = submissionQueue.drainTo(c);
1793	<	for (ForkJoinWorkerThread w : workers)
1794	<	if (w != null)
1795	<	count += w.drainTasksTo(c);
1792	>	int count = 0;
1793	>	while (queueBase != queueTop) {
1794	>	ForkJoinTask<?> t = pollSubmission();
1795	>	if (t != null) {
1796	>	c.add(t);
1797	>	++count;
1798	>	}
1799	>	}
1800	>	ForkJoinWorkerThread[] ws;
1801	>	if ((short)(ctl >>> TC_SHIFT) > -parallelism &&
1802	>	(ws = workers) != null) {
1803	>	for (ForkJoinWorkerThread w : ws)
1804	>	if (w != null)
1805	>	count += w.drainTasksTo(c);
1806	>	}
1807		return count;
1808		}
1809
#	Line 1600 | Line 1818 | public class ForkJoinPool extends Abstra
1818		long st = getStealCount();
1819		long qt = getQueuedTaskCount();
1820		long qs = getQueuedSubmissionCount();
1603	–	int wc = workerCounts;
1604	–	int tc = wc >>> TOTAL_COUNT_SHIFT;
1605	–	int rc = wc & RUNNING_COUNT_MASK;
1821		int pc = parallelism;
1822	<	int rs = runState;
1823	<	int ac = rs & ACTIVE_COUNT_MASK;
1822	>	long c = ctl;
1823	>	int tc = pc + (short)(c >>> TC_SHIFT);
1824	>	int rc = pc + (int)(c >> AC_SHIFT);
1825	>	if (rc < 0) // ignore transient negative
1826	>	rc = 0;
1827	>	int ac = rc + blockedCount;
1828	>	String level;
1829	>	if ((c & STOP_BIT) != 0)
1830	>	level = (tc == 0)? "Terminated" : "Terminating";
1831	>	else
1832	>	level = shutdown? "Shutting down" : "Running";
1833		return super.toString() +
1834	<	"[" + runLevelToString(rs) +
1834	>	"[" + level +
1835		", parallelism = " + pc +
1836		", size = " + tc +
1837		", active = " + ac +
#	Line 1618 | Line 1842 | public class ForkJoinPool extends Abstra
1842		"]";
1843		}
1844
1621	–	private static String runLevelToString(int s) {
1622	–	return ((s & TERMINATED) != 0 ? "Terminated" :
1623	–	((s & TERMINATING) != 0 ? "Terminating" :
1624	–	((s & SHUTDOWN) != 0 ? "Shutting down" :
1625	–	"Running")));
1626	–	}
1627	–
1845		/**
1846		* Initiates an orderly shutdown in which previously submitted
1847		* tasks are executed, but no new tasks will be accepted.
#	Line 1639 | Line 1856 | public class ForkJoinPool extends Abstra
1856		*/
1857		public void shutdown() {
1858		checkPermission();
1859	<	advanceRunLevel(SHUTDOWN);
1859	>	shutdown = true;
1860		tryTerminate(false);
1861		}
1862
#	Line 1661 | Line 1878 | public class ForkJoinPool extends Abstra
1878		*/
1879		public List<Runnable> shutdownNow() {
1880		checkPermission();
1881	+	shutdown = true;
1882		tryTerminate(true);
1883		return Collections.emptyList();
1884		}
#	Line 1671 | Line 1889 | public class ForkJoinPool extends Abstra
1889		* @return {@code true} if all tasks have completed following shut down
1890		*/
1891		public boolean isTerminated() {
1892	<	return runState >= TERMINATED;
1892	>	long c = ctl;
1893	>	return ((c & STOP_BIT) != 0L &&
1894	>	(short)(c >>> TC_SHIFT) == -parallelism);
1895		}
1896
1897		/**
#	Line 1679 | Line 1899 | public class ForkJoinPool extends Abstra
1899		* commenced but not yet completed.  This method may be useful for
1900		* debugging. A return of {@code true} reported a sufficient
1901		* period after shutdown may indicate that submitted tasks have
1902	<	* ignored or suppressed interruption, causing this executor not
1903	<	* to properly terminate.
1902	>	* ignored or suppressed interruption, or are waiting for IO,
1903	>	* causing this executor not to properly terminate. (See the
1904	>	* advisory notes for class {@link ForkJoinTask} stating that
1905	>	* tasks should not normally entail blocking operations.  But if
1906	>	* they do, they must abort them on interrupt.)
1907		*
1908		* @return {@code true} if terminating but not yet terminated
1909		*/
1910		public boolean isTerminating() {
1911	<	return (runState & (TERMINATING|TERMINATED)) == TERMINATING;
1911	>	long c = ctl;
1912	>	return ((c & STOP_BIT) != 0L &&
1913	>	(short)(c >>> TC_SHIFT) != -parallelism);
1914	>	}
1915	>
1916	>	/**
1917	>	* Returns true if terminating or terminated. Used by ForkJoinWorkerThread.
1918	>	*/
1919	>	final boolean isAtLeastTerminating() {
1920	>	return (ctl & STOP_BIT) != 0L;
1921		}
1922
1923		/**
#	Line 1694 | Line 1926 | public class ForkJoinPool extends Abstra
1926		* @return {@code true} if this pool has been shut down
1927		*/
1928		public boolean isShutdown() {
1929	<	return runState >= SHUTDOWN;
1929	>	return shutdown;
1930		}
1931
1932		/**
#	Line 1710 | Line 1942 | public class ForkJoinPool extends Abstra
1942		*/
1943		public boolean awaitTermination(long timeout, TimeUnit unit)
1944		throws InterruptedException {
1945	+	long nanos = unit.toNanos(timeout);
1946	+	final ReentrantLock lock = this.submissionLock;
1947	+	lock.lock();
1948		try {
1949	<	return termination.awaitAdvanceInterruptibly(0, timeout, unit) > 0;
1950	<	} catch (TimeoutException ex) {
1951	<	return false;
1949	>	for (;;) {
1950	>	if (isTerminated())
1951	>	return true;
1952	>	if (nanos <= 0)
1953	>	return false;
1954	>	nanos = termination.awaitNanos(nanos);
1955	>	}
1956	>	} finally {
1957	>	lock.unlock();
1958		}
1959		}
1960
#	Line 1833 | Line 2074 | public class ForkJoinPool extends Abstra
2074		}
2075
2076		// Unsafe mechanics
2077	<
2078	<	private static final sun.misc.Unsafe UNSAFE = getUnsafe();
2079	<	private static final long workerCountsOffset =
2080	<	objectFieldOffset("workerCounts", ForkJoinPool.class);
2081	<	private static final long runStateOffset =
2082	<	objectFieldOffset("runState", ForkJoinPool.class);
2083	<	private static final long eventCountOffset =
2084	<	objectFieldOffset("eventCount", ForkJoinPool.class);
2085	<	private static final long eventWaitersOffset =
2086	<	objectFieldOffset("eventWaiters",ForkJoinPool.class);
2087	<	private static final long stealCountOffset =
2088	<	objectFieldOffset("stealCount",ForkJoinPool.class);
2089	<	private static final long spareWaitersOffset =
2090	<	objectFieldOffset("spareWaiters",ForkJoinPool.class);
2091	<
2092	<	private static long objectFieldOffset(String field, Class<?> klazz) {
2077	>	private static final sun.misc.Unsafe UNSAFE;
2078	>	private static final long ctlOffset;
2079	>	private static final long stealCountOffset;
2080	>	private static final long blockedCountOffset;
2081	>	private static final long quiescerCountOffset;
2082	>	private static final long scanGuardOffset;
2083	>	private static final long nextWorkerNumberOffset;
2084	>	private static final long ABASE;
2085	>	private static final int ASHIFT;
2086	>
2087	>	static {
2088	>	poolNumberGenerator = new AtomicInteger();
2089	>	workerSeedGenerator = new Random();
2090	>	modifyThreadPermission = new RuntimePermission("modifyThread");
2091	>	defaultForkJoinWorkerThreadFactory =
2092	>	new DefaultForkJoinWorkerThreadFactory();
2093	>	int s;
2094		try {
2095	<	return UNSAFE.objectFieldOffset(klazz.getDeclaredField(field));
2096	<	} catch (NoSuchFieldException e) {
2097	<	// Convert Exception to corresponding Error
2098	<	NoSuchFieldError error = new NoSuchFieldError(field);
2099	<	error.initCause(e);
2100	<	throw error;
2101	<	}
2095	>	UNSAFE = getUnsafe();
2096	>	Class k = ForkJoinPool.class;
2097	>	ctlOffset = UNSAFE.objectFieldOffset
2098	>	(k.getDeclaredField("ctl"));
2099	>	stealCountOffset = UNSAFE.objectFieldOffset
2100	>	(k.getDeclaredField("stealCount"));
2101	>	blockedCountOffset = UNSAFE.objectFieldOffset
2102	>	(k.getDeclaredField("blockedCount"));
2103	>	quiescerCountOffset = UNSAFE.objectFieldOffset
2104	>	(k.getDeclaredField("quiescerCount"));
2105	>	scanGuardOffset = UNSAFE.objectFieldOffset
2106	>	(k.getDeclaredField("scanGuard"));
2107	>	nextWorkerNumberOffset = UNSAFE.objectFieldOffset
2108	>	(k.getDeclaredField("nextWorkerNumber"));
2109	>	Class a = ForkJoinTask[].class;
2110	>	ABASE = UNSAFE.arrayBaseOffset(a);
2111	>	s = UNSAFE.arrayIndexScale(a);
2112	>	} catch (Exception e) {
2113	>	throw new Error(e);
2114	>	}
2115	>	if ((s & (s-1)) != 0)
2116	>	throw new Error("data type scale not a power of two");
2117	>	ASHIFT = 31 - Integer.numberOfLeadingZeros(s);
2118		}
2119
2120		/**

Diff Legend

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