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.21 by jsr166, Fri Jul 24 23:47:01 2009 UTC vs.
Revision 1.85 by dl, Sun Nov 21 13:55:04 2010 UTC

#	Line 5 | Line 5
5		*/
6
7		package jsr166y;
8	<	import java.util.*;
9	<	import java.util.concurrent.*;
10	<	import java.util.concurrent.locks.*;
11	<	import java.util.concurrent.atomic.*;
8	>
9	>	import java.util.ArrayList;
10	>	import java.util.Arrays;
11	>	import java.util.Collection;
12	>	import java.util.Collections;
13	>	import java.util.List;
14	>	import java.util.concurrent.AbstractExecutorService;
15	>	import java.util.concurrent.Callable;
16	>	import java.util.concurrent.ExecutorService;
17	>	import java.util.concurrent.Future;
18	>	import java.util.concurrent.RejectedExecutionException;
19	>	import java.util.concurrent.RunnableFuture;
20	>	import java.util.concurrent.TimeUnit;
21	>	import java.util.concurrent.TimeoutException;
22	>	import java.util.concurrent.atomic.AtomicInteger;
23	>	import java.util.concurrent.locks.LockSupport;
24	>	import java.util.concurrent.locks.ReentrantLock;
25
26		/**
27	<	* An {@link ExecutorService} for running {@link ForkJoinTask}s.  A
28	<	* ForkJoinPool provides the entry point for submissions from
29	<	* non-ForkJoinTasks, as well as management and monitoring operations.
30	<	* Normally a single ForkJoinPool is used for a large number of
18	<	* submitted tasks. Otherwise, use would not usually outweigh the
19	<	* construction and bookkeeping overhead of creating a large set of
20	<	* threads.
27	>	* An {@link ExecutorService} for running {@link ForkJoinTask}s.
28	>	* A {@code ForkJoinPool} provides the entry point for submissions
29	>	* from non-{@code ForkJoinTask} clients, as well as management and
30	>	* monitoring operations.
31		*
32	<	* <p>ForkJoinPools differ from other kinds of Executors mainly in
33	<	* that they provide <em>work-stealing</em>: all threads in the pool
34	<	* attempt to find and execute subtasks created by other active tasks
35	<	* (eventually blocking if none exist). This makes them efficient when
36	<	* most tasks spawn other subtasks (as do most ForkJoinTasks), as well
37	<	* as the mixed execution of some plain Runnable- or Callable- based
38	<	* activities along with ForkJoinTasks. When setting
39	<	* {@code setAsyncMode}, a ForkJoinPools may also be appropriate for
40	<	* use with fine-grained tasks that are never joined. Otherwise, other
31	<	* ExecutorService implementations are typically more appropriate
32	<	* choices.
32	>	* <p>A {@code ForkJoinPool} differs from other kinds of {@link
33	>	* ExecutorService} mainly by virtue of employing
34	>	* <em>work-stealing</em>: all threads in the pool attempt to find and
35	>	* execute subtasks created by other active tasks (eventually blocking
36	>	* waiting for work if none exist). This enables efficient processing
37	>	* when most tasks spawn other subtasks (as do most {@code
38	>	* ForkJoinTask}s). When setting <em>asyncMode</em> to true in
39	>	* constructors, {@code ForkJoinPool}s may also be appropriate for use
40	>	* with event-style tasks that are never joined.
41		*
42	<	* <p>A ForkJoinPool may be constructed with a given parallelism level
43	<	* (target pool size), which it attempts to maintain by dynamically
44	<	* adding, suspending, or resuming threads, even if some tasks are
45	<	* waiting to join others. However, no such adjustments are performed
46	<	* in the face of blocked IO or other unmanaged synchronization. The
47	<	* nested {@code ManagedBlocker} interface enables extension of
48	<	* the kinds of synchronization accommodated.  The target parallelism
49	<	* level may also be changed dynamically ({@code setParallelism})
50	<	* and thread construction can be limited using methods
43	<	* {@code setMaximumPoolSize} and/or
44	<	* {@code setMaintainsParallelism}.
42	>	* <p>A {@code ForkJoinPool} is constructed with a given target
43	>	* parallelism level; by default, equal to the number of available
44	>	* processors. The pool attempts to maintain enough active (or
45	>	* available) threads by dynamically adding, suspending, or resuming
46	>	* internal worker threads, even if some tasks are stalled waiting to
47	>	* join others. However, no such adjustments are guaranteed in the
48	>	* face of blocked IO or other unmanaged synchronization. The nested
49	>	* {@link ManagedBlocker} interface enables extension of the kinds of
50	>	* synchronization accommodated.
51		*
52		* <p>In addition to execution and lifecycle control methods, this
53		* class provides status check methods (for example
54	<	* {@code getStealCount}) that are intended to aid in developing,
54	>	* {@link #getStealCount}) that are intended to aid in developing,
55		* tuning, and monitoring fork/join applications. Also, method
56	<	* {@code toString} returns indications of pool state in a
56	>	* {@link #toString} returns indications of pool state in a
57		* convenient form for informal monitoring.
58		*
59	+	* <p> As is the case with other ExecutorServices, there are three
60	+	* main task execution methods summarized in the following
61	+	* table. These are designed to be used by clients not already engaged
62	+	* in fork/join computations in the current pool.  The main forms of
63	+	* these methods accept instances of {@code ForkJoinTask}, but
64	+	* overloaded forms also allow mixed execution of plain {@code
65	+	* Runnable}- or {@code Callable}- based activities as well.  However,
66	+	* tasks that are already executing in a pool should normally
67	+	* <em>NOT</em> use these pool execution methods, but instead use the
68	+	* within-computation forms listed in the table.
69	+	*
70	+	* <table BORDER CELLPADDING=3 CELLSPACING=1>
71	+	*  <tr>
72	+	*    <td></td>
73	+	*    <td ALIGN=CENTER> <b>Call from non-fork/join clients</b></td>
74	+	*    <td ALIGN=CENTER> <b>Call from within fork/join computations</b></td>
75	+	*  </tr>
76	+	*  <tr>
77	+	*    <td> <b>Arrange async execution</td>
78	+	*    <td> {@link #execute(ForkJoinTask)}</td>
79	+	*    <td> {@link ForkJoinTask#fork}</td>
80	+	*  </tr>
81	+	*  <tr>
82	+	*    <td> <b>Await and obtain result</td>
83	+	*    <td> {@link #invoke(ForkJoinTask)}</td>
84	+	*    <td> {@link ForkJoinTask#invoke}</td>
85	+	*  </tr>
86	+	*  <tr>
87	+	*    <td> <b>Arrange exec and obtain Future</td>
88	+	*    <td> {@link #submit(ForkJoinTask)}</td>
89	+	*    <td> {@link ForkJoinTask#fork} (ForkJoinTasks <em>are</em> Futures)</td>
90	+	*  </tr>
91	+	* </table>
92	+	*
93	+	* <p><b>Sample Usage.</b> Normally a single {@code ForkJoinPool} is
94	+	* used for all parallel task execution in a program or subsystem.
95	+	* Otherwise, use would not usually outweigh the construction and
96	+	* bookkeeping overhead of creating a large set of threads. For
97	+	* example, a common pool could be used for the {@code SortTasks}
98	+	* illustrated in {@link RecursiveAction}. Because {@code
99	+	* ForkJoinPool} uses threads in {@linkplain java.lang.Thread#isDaemon
100	+	* daemon} mode, there is typically no need to explicitly {@link
101	+	* #shutdown} such a pool upon program exit.
102	+	*
103	+	* <pre>
104	+	* static final ForkJoinPool mainPool = new ForkJoinPool();
105	+	* ...
106	+	* public void sort(long[] array) {
107	+	*   mainPool.invoke(new SortTask(array, 0, array.length));
108	+	* }
109	+	* </pre>
110	+	*
111		* <p><b>Implementation notes</b>: This implementation restricts the
112		* maximum number of running threads to 32767. Attempts to create
113	<	* pools with greater than the maximum result in
114	<	* IllegalArgumentExceptions.
113	>	* pools with greater than the maximum number result in
114	>	* {@code IllegalArgumentException}.
115	>	*
116	>	* <p>This implementation rejects submitted tasks (that is, by throwing
117	>	* {@link RejectedExecutionException}) only when the pool is shut down
118	>	* or internal resources have been exhausted.
119		*
120		* @since 1.7
121		* @author Doug Lea
#	Line 61 | Line 123 | import java.util.concurrent.atomic.*;
123		public class ForkJoinPool extends AbstractExecutorService {
124
125		/*
126	<	* See the extended comments interspersed below for design,
127	<	* rationale, and walkthroughs.
128	<	*/
129	<
130	<	/** Mask for packing and unpacking shorts */
131	<	private static final int  shortMask = 0xffff;
132	<
133	<	/** Max pool size -- must be a power of two minus 1 */
134	<	private static final int MAX_THREADS =  0x7FFF;
135	<
136	<	/**
137	<	* Factory for creating new ForkJoinWorkerThreads.  A
138	<	* ForkJoinWorkerThreadFactory must be defined and used for
139	<	* ForkJoinWorkerThread subclasses that extend base functionality
140	<	* or initialize threads with different contexts.
126	>	* Implementation Overview
127	>	*
128	>	* This class provides the central bookkeeping and control for a
129	>	* set of worker threads: Submissions from non-FJ threads enter
130	>	* into a submission queue. Workers take these tasks and typically
131	>	* split them into subtasks that may be stolen by other workers.
132	>	* The main work-stealing mechanics implemented in class
133	>	* ForkJoinWorkerThread give first priority to processing tasks
134	>	* from their own queues (LIFO or FIFO, depending on mode), then
135	>	* to randomized FIFO steals of tasks in other worker queues, and
136	>	* lastly to new submissions. These mechanics do not consider
137	>	* affinities, loads, cache localities, etc, so rarely provide the
138	>	* best possible performance on a given machine, but portably
139	>	* provide good throughput by averaging over these factors.
140	>	* (Further, even if we did try to use such information, we do not
141	>	* usually have a basis for exploiting it. For example, some sets
142	>	* of tasks profit from cache affinities, but others are harmed by
143	>	* cache pollution effects.)
144	>	*
145	>	* Beyond work-stealing support and essential bookkeeping, the
146	>	* main responsibility of this framework is to take actions when
147	>	* one worker is waiting to join a task stolen (or always held by)
148	>	* another.  Because we are multiplexing many tasks on to a pool
149	>	* of workers, we can't just let them block (as in Thread.join).
150	>	* We also cannot just reassign the joiner's run-time stack with
151	>	* another and replace it later, which would be a form of
152	>	* "continuation", that even if possible is not necessarily a good
153	>	* idea. Given that the creation costs of most threads on most
154	>	* systems mainly surrounds setting up runtime stacks, thread
155	>	* creation and switching is usually not much more expensive than
156	>	* stack creation and switching, and is more flexible). Instead we
157	>	* combine two tactics:
158	>	*
159	>	*   Helping: Arranging for the joiner to execute some task that it
160	>	*      would be running if the steal had not occurred.  Method
161	>	*      ForkJoinWorkerThread.helpJoinTask tracks joining->stealing
162	>	*      links to try to find such a task.
163	>	*
164	>	*   Compensating: Unless there are already enough live threads,
165	>	*      method helpMaintainParallelism() may create or
166	>	*      re-activate a spare thread to compensate for blocked
167	>	*      joiners until they unblock.
168	>	*
169	>	* It is impossible to keep exactly the target (parallelism)
170	>	* number of threads running at any given time.  Determining
171	>	* existence of conservatively safe helping targets, the
172	>	* availability of already-created spares, and the apparent need
173	>	* to create new spares are all racy and require heuristic
174	>	* guidance, so we rely on multiple retries of each.  Compensation
175	>	* occurs in slow-motion. It is triggered only upon timeouts of
176	>	* Object.wait used for joins. This reduces poor decisions that
177	>	* would otherwise be made when threads are waiting for others
178	>	* that are stalled because of unrelated activities such as
179	>	* garbage collection.
180	>	*
181	>	* The ManagedBlocker extension API can't use helping so relies
182	>	* only on compensation in method awaitBlocker.
183	>	*
184	>	* The main throughput advantages of work-stealing stem from
185	>	* decentralized control -- workers mostly steal tasks from each
186	>	* other. We do not want to negate this by creating bottlenecks
187	>	* implementing other management responsibilities. So we use a
188	>	* collection of techniques that avoid, reduce, or cope well with
189	>	* contention. These entail several instances of bit-packing into
190	>	* CASable fields to maintain only the minimally required
191	>	* atomicity. To enable such packing, we restrict maximum
192	>	* parallelism to (1<<15)-1 (enabling twice this (to accommodate
193	>	* unbalanced increments and decrements) to fit into a 16 bit
194	>	* field, which is far in excess of normal operating range.  Even
195	>	* though updates to some of these bookkeeping fields do sometimes
196	>	* contend with each other, they don't normally cache-contend with
197	>	* updates to others enough to warrant memory padding or
198	>	* isolation. So they are all held as fields of ForkJoinPool
199	>	* objects.  The main capabilities are as follows:
200	>	*
201	>	* 1. Creating and removing workers. Workers are recorded in the
202	>	* "workers" array. This is an array as opposed to some other data
203	>	* structure to support index-based random steals by workers.
204	>	* Updates to the array recording new workers and unrecording
205	>	* terminated ones are protected from each other by a lock
206	>	* (workerLock) but the array is otherwise concurrently readable,
207	>	* and accessed directly by workers. To simplify index-based
208	>	* operations, the array size is always a power of two, and all
209	>	* readers must tolerate null slots. Currently, all worker thread
210	>	* creation is on-demand, triggered by task submissions,
211	>	* replacement of terminated workers, and/or compensation for
212	>	* blocked workers. However, all other support code is set up to
213	>	* work with other policies.
214	>	*
215	>	* To ensure that we do not hold on to worker references that
216	>	* would prevent GC, ALL accesses to workers are via indices into
217	>	* the workers array (which is one source of some of the unusual
218	>	* code constructions here). In essence, the workers array serves
219	>	* as a WeakReference mechanism. Thus for example the event queue
220	>	* stores worker indices, not worker references. Access to the
221	>	* workers in associated methods (for example releaseEventWaiters)
222	>	* must both index-check and null-check the IDs. All such accesses
223	>	* ignore bad IDs by returning out early from what they are doing,
224	>	* since this can only be associated with shutdown, in which case
225	>	* it is OK to give up. On termination, we just clobber these
226	>	* data structures without trying to use them.
227	>	*
228	>	* 2. Bookkeeping for dynamically adding and removing workers. We
229	>	* aim to approximately maintain the given level of parallelism.
230	>	* When some workers are known to be blocked (on joins or via
231	>	* ManagedBlocker), we may create or resume others to take their
232	>	* place until they unblock (see below). Implementing this
233	>	* requires counts of the number of "running" threads (i.e., those
234	>	* that are neither blocked nor artificially suspended) as well as
235	>	* the total number.  These two values are packed into one field,
236	>	* "workerCounts" because we need accurate snapshots when deciding
237	>	* to create, resume or suspend.  Note however that the
238	>	* correspondence of these counts to reality is not guaranteed. In
239	>	* particular updates for unblocked threads may lag until they
240	>	* actually wake up.
241	>	*
242	>	* 3. Maintaining global run state. The run state of the pool
243	>	* consists of a runLevel (SHUTDOWN, TERMINATING, etc) similar to
244	>	* those in other Executor implementations, as well as a count of
245	>	* "active" workers -- those that are, or soon will be, or
246	>	* recently were executing tasks. The runLevel and active count
247	>	* are packed together in order to correctly trigger shutdown and
248	>	* termination. Without care, active counts can be subject to very
249	>	* high contention.  We substantially reduce this contention by
250	>	* relaxing update rules.  A worker must claim active status
251	>	* prospectively, by activating if it sees that a submitted or
252	>	* stealable task exists (it may find after activating that the
253	>	* task no longer exists). It stays active while processing this
254	>	* task (if it exists) and any other local subtasks it produces,
255	>	* until it cannot find any other tasks. It then tries
256	>	* inactivating (see method preStep), but upon update contention
257	>	* instead scans for more tasks, later retrying inactivation if it
258	>	* doesn't find any.
259	>	*
260	>	* 4. Managing idle workers waiting for tasks. We cannot let
261	>	* workers spin indefinitely scanning for tasks when none are
262	>	* available. On the other hand, we must quickly prod them into
263	>	* action when new tasks are submitted or generated.  We
264	>	* park/unpark these idle workers using an event-count scheme.
265	>	* Field eventCount is incremented upon events that may enable
266	>	* workers that previously could not find a task to now find one:
267	>	* Submission of a new task to the pool, or another worker pushing
268	>	* a task onto a previously empty queue.  (We also use this
269	>	* mechanism for configuration and termination actions that
270	>	* require wakeups of idle workers).  Each worker maintains its
271	>	* last known event count, and blocks when a scan for work did not
272	>	* find a task AND its lastEventCount matches the current
273	>	* eventCount. Waiting idle workers are recorded in a variant of
274	>	* Treiber stack headed by field eventWaiters which, when nonzero,
275	>	* encodes the thread index and count awaited for by the worker
276	>	* thread most recently calling eventSync. This thread in turn has
277	>	* a record (field nextEventWaiter) for the next waiting worker.
278	>	* In addition to allowing simpler decisions about need for
279	>	* wakeup, the event count bits in eventWaiters serve the role of
280	>	* tags to avoid ABA errors in Treiber stacks. Upon any wakeup,
281	>	* released threads also try to release at most two others.  The
282	>	* net effect is a tree-like diffusion of signals, where released
283	>	* threads (and possibly others) help with unparks.  To further
284	>	* reduce contention effects a bit, failed CASes to increment
285	>	* field eventCount are tolerated without retries in signalWork.
286	>	* Conceptually they are merged into the same event, which is OK
287	>	* when their only purpose is to enable workers to scan for work.
288	>	*
289	>	* 5. Managing suspension of extra workers. When a worker notices
290	>	* (usually upon timeout of a wait()) that there are too few
291	>	* running threads, we may create a new thread to maintain
292	>	* parallelism level, or at least avoid starvation. Usually, extra
293	>	* threads are needed for only very short periods, yet join
294	>	* dependencies are such that we sometimes need them in
295	>	* bursts. Rather than create new threads each time this happens,
296	>	* we suspend no-longer-needed extra ones as "spares". For most
297	>	* purposes, we don't distinguish "extra" spare threads from
298	>	* normal "core" threads: On each call to preStep (the only point
299	>	* at which we can do this) a worker checks to see if there are
300	>	* now too many running workers, and if so, suspends itself.
301	>	* Method helpMaintainParallelism looks for suspended threads to
302	>	* resume before considering creating a new replacement. The
303	>	* spares themselves are encoded on another variant of a Treiber
304	>	* Stack, headed at field "spareWaiters".  Note that the use of
305	>	* spares is intrinsically racy.  One thread may become a spare at
306	>	* about the same time as another is needlessly being created. We
307	>	* counteract this and related slop in part by requiring resumed
308	>	* spares to immediately recheck (in preStep) to see whether they
309	>	* should re-suspend.
310	>	*
311	>	* 6. Killing off unneeded workers. A timeout mechanism is used to
312	>	* shed unused workers: The oldest (first) event queue waiter uses
313	>	* a timed rather than hard wait. When this wait times out without
314	>	* a normal wakeup, it tries to shutdown any one (for convenience
315	>	* the newest) other spare or event waiter via
316	>	* tryShutdownUnusedWorker. This eventually reduces the number of
317	>	* worker threads to a minimum of one after a long enough period
318	>	* without use.
319	>	*
320	>	* 7. Deciding when to create new workers. The main dynamic
321	>	* control in this class is deciding when to create extra threads
322	>	* in method helpMaintainParallelism. We would like to keep
323	>	* exactly #parallelism threads running, which is an impossible
324	>	* task. We always need to create one when the number of running
325	>	* threads would become zero and all workers are busy. Beyond
326	>	* this, we must rely on heuristics that work well in the
327	>	* presence of transient phenomena such as GC stalls, dynamic
328	>	* compilation, and wake-up lags. These transients are extremely
329	>	* common -- we are normally trying to fully saturate the CPUs on
330	>	* a machine, so almost any activity other than running tasks
331	>	* impedes accuracy. Our main defense is to allow parallelism to
332	>	* lapse for a while during joins, and use a timeout to see if,
333	>	* after the resulting settling, there is still a need for
334	>	* additional workers.  This also better copes with the fact that
335	>	* some of the methods in this class tend to never become compiled
336	>	* (but are interpreted), so some components of the entire set of
337	>	* controls might execute 100 times faster than others. And
338	>	* similarly for cases where the apparent lack of work is just due
339	>	* to GC stalls and other transient system activity.
340	>	*
341	>	* Beware that there is a lot of representation-level coupling
342	>	* among classes ForkJoinPool, ForkJoinWorkerThread, and
343	>	* ForkJoinTask.  For example, direct access to "workers" array by
344	>	* workers, and direct access to ForkJoinTask.status by both
345	>	* ForkJoinPool and ForkJoinWorkerThread.  There is little point
346	>	* trying to reduce this, since any associated future changes in
347	>	* representations will need to be accompanied by algorithmic
348	>	* changes anyway.
349	>	*
350	>	* Style notes: There are lots of inline assignments (of form
351	>	* "while ((local = field) != 0)") which are usually the simplest
352	>	* way to ensure the required read orderings (which are sometimes
353	>	* critical). Also several occurrences of the unusual "do {}
354	>	* while (!cas...)" which is the simplest way to force an update of
355	>	* a CAS'ed variable. There are also other coding oddities that
356	>	* help some methods perform reasonably even when interpreted (not
357	>	* compiled), at the expense of some messy constructions that
358	>	* reduce byte code counts.
359	>	*
360	>	* The order of declarations in this file is: (1) statics (2)
361	>	* fields (along with constants used when unpacking some of them)
362	>	* (3) internal control methods (4) callbacks and other support
363	>	* for ForkJoinTask and ForkJoinWorkerThread classes, (5) exported
364	>	* methods (plus a few little helpers).
365	>	*/
366	>
367	>	/**
368	>	* Factory for creating new {@link ForkJoinWorkerThread}s.
369	>	* A {@code ForkJoinWorkerThreadFactory} must be defined and used
370	>	* for {@code ForkJoinWorkerThread} subclasses that extend base
371	>	* functionality or initialize threads with different contexts.
372		*/
373		public static interface ForkJoinWorkerThreadFactory {
374		/**
375		* Returns a new worker thread operating in the given pool.
376		*
377		* @param pool the pool this thread works in
378	<	* @throws NullPointerException if pool is null
378	>	* @throws NullPointerException if the pool is null
379		*/
380		public ForkJoinWorkerThread newThread(ForkJoinPool pool);
381		}
#	Line 91 | Line 384 | public class ForkJoinPool extends Abstra
384		* Default ForkJoinWorkerThreadFactory implementation; creates a
385		* new ForkJoinWorkerThread.
386		*/
387	<	static class  DefaultForkJoinWorkerThreadFactory
387	>	static class DefaultForkJoinWorkerThreadFactory
388		implements ForkJoinWorkerThreadFactory {
389		public ForkJoinWorkerThread newThread(ForkJoinPool pool) {
390	<	try {
98	<	return new ForkJoinWorkerThread(pool);
99	<	} catch (OutOfMemoryError oom)  {
100	<	return null;
101	<	}
390	>	return new ForkJoinWorkerThread(pool);
391		}
392		}
393
#	Line 134 | Line 423 | public class ForkJoinPool extends Abstra
423		new AtomicInteger();
424
425		/**
426	<	* Array holding all worker threads in the pool. Initialized upon
427	<	* first use. Array size must be a power of two.  Updates and
428	<	* replacements are protected by workerLock, but it is always kept
429	<	* in a consistent enough state to be randomly accessed without
430	<	* locking by workers performing work-stealing.
426	>	* The time to block in a join (see awaitJoin) before checking if
427	>	* a new worker should be (re)started to maintain parallelism
428	>	* level. The value should be short enough to maintain global
429	>	* responsiveness and progress but long enough to avoid
430	>	* counterproductive firings during GC stalls or unrelated system
431	>	* activity, and to not bog down systems with continual re-firings
432	>	* on GCs or legitimately long waits.
433	>	*/
434	>	private static final long JOIN_TIMEOUT_MILLIS = 250L; // 4 per second
435	>
436	>	/**
437	>	* The wakeup interval (in nanoseconds) for the oldest worker
438	>	* waiting for an event to invoke tryShutdownUnusedWorker to
439	>	* shrink the number of workers.  The exact value does not matter
440	>	* too much. It must be short enough to release resources during
441	>	* sustained periods of idleness, but not so short that threads
442	>	* are continually re-created.
443	>	*/
444	>	private static final long SHRINK_RATE_NANOS =
445	>	30L * 1000L * 1000L * 1000L; // 2 per minute
446	>
447	>	/**
448	>	* Absolute bound for parallelism level. Twice this number plus
449	>	* one (i.e., 0xfff) must fit into a 16bit field to enable
450	>	* word-packing for some counts and indices.
451	>	*/
452	>	private static final int MAX_WORKERS   = 0x7fff;
453	>
454	>	/**
455	>	* Array holding all worker threads in the pool.  Array size must
456	>	* be a power of two.  Updates and replacements are protected by
457	>	* workerLock, but the array is always kept in a consistent enough
458	>	* state to be randomly accessed without locking by workers
459	>	* performing work-stealing, as well as other traversal-based
460	>	* methods in this class. All readers must tolerate that some
461	>	* array slots may be null.
462		*/
463		volatile ForkJoinWorkerThread[] workers;
464
465		/**
466	<	* Lock protecting access to workers.
466	>	* Queue for external submissions.
467		*/
468	<	private final ReentrantLock workerLock;
468	>	private final LinkedTransferQueue<ForkJoinTask<?>> submissionQueue;
469
470		/**
471	<	* Condition for awaitTermination.
471	>	* Lock protecting updates to workers array.
472		*/
473	<	private final Condition termination;
473	>	private final ReentrantLock workerLock;
474
475		/**
476	<	* The uncaught exception handler used when any worker
157	<	* abruptly terminates
476	>	* Latch released upon termination.
477		*/
478	<	private Thread.UncaughtExceptionHandler ueh;
478	>	private final Phaser termination;
479
480		/**
481		* Creation factory for worker threads.
#	Line 164 | Line 483 | public class ForkJoinPool extends Abstra
483		private final ForkJoinWorkerThreadFactory factory;
484
485		/**
167	–	* Head of stack of threads that were created to maintain
168	–	* parallelism when other threads blocked, but have since
169	–	* suspended when the parallelism level rose.
170	–	*/
171	–	private volatile WaitQueueNode spareStack;
172	–
173	–	/**
486		* Sum of per-thread steal counts, updated only when threads are
487		* idle or terminating.
488		*/
489	<	private final AtomicLong stealCount;
489	>	private volatile long stealCount;
490
491		/**
492	<	* Queue for external submissions.
492	>	* Encoded record of top of Treiber stack of threads waiting for
493	>	* events. The top 32 bits contain the count being waited for. The
494	>	* bottom 16 bits contains one plus the pool index of waiting
495	>	* worker thread. (Bits 16-31 are unused.)
496		*/
497	<	private final LinkedTransferQueue<ForkJoinTask<?>> submissionQueue;
497	>	private volatile long eventWaiters;
498	>
499	>	private static final int  EVENT_COUNT_SHIFT = 32;
500	>	private static final long WAITER_ID_MASK    = (1L << 16) - 1L;
501
502		/**
503	<	* Head of Treiber stack for barrier sync. See below for explanation.
503	>	* A counter for events that may wake up worker threads:
504	>	*   - Submission of a new task to the pool
505	>	*   - A worker pushing a task on an empty queue
506	>	*   - termination
507		*/
508	<	private volatile WaitQueueNode syncStack;
508	>	private volatile int eventCount;
509
510		/**
511	<	* The count for event barrier
511	>	* Encoded record of top of Treiber stack of spare threads waiting
512	>	* for resumption. The top 16 bits contain an arbitrary count to
513	>	* avoid ABA effects. The bottom 16bits contains one plus the pool
514	>	* index of waiting worker thread.
515		*/
516	<	private volatile long eventCount;
516	>	private volatile int spareWaiters;
517	>
518	>	private static final int SPARE_COUNT_SHIFT = 16;
519	>	private static final int SPARE_ID_MASK     = (1 << 16) - 1;
520
521		/**
522	<	* Pool number, just for assigning useful names to worker threads
522	>	* Lifecycle control. The low word contains the number of workers
523	>	* that are (probably) executing tasks. This value is atomically
524	>	* incremented before a worker gets a task to run, and decremented
525	>	* when a worker has no tasks and cannot find any.  Bits 16-18
526	>	* contain runLevel value. When all are zero, the pool is
527	>	* running. Level transitions are monotonic (running -> shutdown
528	>	* -> terminating -> terminated) so each transition adds a bit.
529	>	* These are bundled together to ensure consistent read for
530	>	* termination checks (i.e., that runLevel is at least SHUTDOWN
531	>	* and active threads is zero).
532	>	*
533	>	* Notes: Most direct CASes are dependent on these bitfield
534	>	* positions.  Also, this field is non-private to enable direct
535	>	* performance-sensitive CASes in ForkJoinWorkerThread.
536		*/
537	<	private final int poolNumber;
537	>	volatile int runState;
538	>
539	>	// Note: The order among run level values matters.
540	>	private static final int RUNLEVEL_SHIFT     = 16;
541	>	private static final int SHUTDOWN           = 1 << RUNLEVEL_SHIFT;
542	>	private static final int TERMINATING        = 1 << (RUNLEVEL_SHIFT + 1);
543	>	private static final int TERMINATED         = 1 << (RUNLEVEL_SHIFT + 2);
544	>	private static final int ACTIVE_COUNT_MASK  = (1 << RUNLEVEL_SHIFT) - 1;
545
546		/**
547	<	* The maximum allowed pool size
547	>	* Holds number of total (i.e., created and not yet terminated)
548	>	* and running (i.e., not blocked on joins or other managed sync)
549	>	* threads, packed together to ensure consistent snapshot when
550	>	* making decisions about creating and suspending spare
551	>	* threads. Updated only by CAS. Note that adding a new worker
552	>	* requires incrementing both counts, since workers start off in
553	>	* running state.
554		*/
555	<	private volatile int maxPoolSize;
555	>	private volatile int workerCounts;
556	>
557	>	private static final int TOTAL_COUNT_SHIFT  = 16;
558	>	private static final int RUNNING_COUNT_MASK = (1 << TOTAL_COUNT_SHIFT) - 1;
559	>	private static final int ONE_RUNNING        = 1;
560	>	private static final int ONE_TOTAL          = 1 << TOTAL_COUNT_SHIFT;
561
562		/**
563	<	* The desired parallelism level, updated only under workerLock.
563	>	* The target parallelism level.
564	>	* Accessed directly by ForkJoinWorkerThreads.
565		*/
566	<	private volatile int parallelism;
566	>	final int parallelism;
567
568		/**
569		* True if use local fifo, not default lifo, for local polling
570	+	* Read by, and replicated by ForkJoinWorkerThreads
571		*/
572	<	private volatile boolean locallyFifo;
572	>	final boolean locallyFifo;
573
574		/**
575	<	* Holds number of total (i.e., created and not yet terminated)
576	<	* and running (i.e., not blocked on joins or other managed sync)
217	<	* threads, packed into one int to ensure consistent snapshot when
218	<	* making decisions about creating and suspending spare
219	<	* threads. Updated only by CAS.  Note: CASes in
220	<	* updateRunningCount and preJoin assume that running active count
221	<	* is in low word, so need to be modified if this changes.
575	>	* The uncaught exception handler used when any worker abruptly
576	>	* terminates.
577		*/
578	<	private volatile int workerCounts;
224	<
225	<	private static int totalCountOf(int s)           { return s >>> 16;  }
226	<	private static int runningCountOf(int s)         { return s & shortMask; }
227	<	private static int workerCountsFor(int t, int r) { return (t << 16) + r; }
578	>	private final Thread.UncaughtExceptionHandler ueh;
579
580		/**
581	<	* Adds delta (which may be negative) to running count.  This must
231	<	* be called before (with negative arg) and after (with positive)
232	<	* any managed synchronization (i.e., mainly, joins).
233	<	*
234	<	* @param delta the number to add
581	>	* Pool number, just for assigning useful names to worker threads
582		*/
583	<	final void updateRunningCount(int delta) {
584	<	int s;
585	<	do {} while (!casWorkerCounts(s = workerCounts, s + delta));
586	<	}
583	>	private final int poolNumber;
584	>
585	>	// Utilities for CASing fields. Note that most of these
586	>	// are usually manually inlined by callers
587
588		/**
589	<	* Adds delta (which may be negative) to both total and running
243	<	* count.  This must be called upon creation and termination of
244	<	* worker threads.
245	<	*
246	<	* @param delta the number to add
589	>	* Increments running count part of workerCounts
590		*/
591	<	private void updateWorkerCount(int delta) {
592	<	int d = delta + (delta << 16); // add to both lo and hi parts
593	<	int s;
594	<	do {} while (!casWorkerCounts(s = workerCounts, s + d));
591	>	final void incrementRunningCount() {
592	>	int c;
593	>	do {} while (!UNSAFE.compareAndSwapInt(this, workerCountsOffset,
594	>	c = workerCounts,
595	>	c + ONE_RUNNING));
596		}
597
598		/**
599	<	* Lifecycle control. High word contains runState, low word
256	<	* contains the number of workers that are (probably) executing
257	<	* tasks. This value is atomically incremented before a worker
258	<	* gets a task to run, and decremented when worker has no tasks
259	<	* and cannot find any. These two fields are bundled together to
260	<	* support correct termination triggering.  Note: activeCount
261	<	* CAS'es cheat by assuming active count is in low word, so need
262	<	* to be modified if this changes
599	>	* Tries to increment running count part of workerCounts
600		*/
601	<	private volatile int runControl;
602	<
603	<	// RunState values. Order among values matters
604	<	private static final int RUNNING     = 0;
605	<	private static final int SHUTDOWN    = 1;
606	<	private static final int TERMINATING = 2;
270	<	private static final int TERMINATED  = 3;
271	<
272	<	private static int runStateOf(int c)             { return c >>> 16; }
273	<	private static int activeCountOf(int c)          { return c & shortMask; }
274	<	private static int runControlFor(int r, int a)   { return (r << 16) + a; }
601	>	final boolean tryIncrementRunningCount() {
602	>	int c;
603	>	return UNSAFE.compareAndSwapInt(this, workerCountsOffset,
604	>	c = workerCounts,
605	>	c + ONE_RUNNING);
606	>	}
607
608		/**
609	<	* Tries incrementing active count; fails on contention.
278	<	* Called by workers before/during executing tasks.
279	<	*
280	<	* @return true on success
609	>	* Tries to decrement running count unless already zero
610		*/
611	<	final boolean tryIncrementActiveCount() {
612	<	int c = runControl;
613	<	return casRunControl(c, c+1);
611	>	final boolean tryDecrementRunningCount() {
612	>	int wc = workerCounts;
613	>	if ((wc & RUNNING_COUNT_MASK) == 0)
614	>	return false;
615	>	return UNSAFE.compareAndSwapInt(this, workerCountsOffset,
616	>	wc, wc - ONE_RUNNING);
617		}
618
619		/**
620	<	* Tries decrementing active count; fails on contention.
621	<	* Possibly triggers termination on success.
290	<	* Called by workers when they can't find tasks.
620	>	* Forces decrement of encoded workerCounts, awaiting nonzero if
621	>	* (rarely) necessary when other count updates lag.
622		*
623	<	* @return true on success
623	>	* @param dr -- either zero or ONE_RUNNING
624	>	* @param dt -- either zero or ONE_TOTAL
625		*/
626	<	final boolean tryDecrementActiveCount() {
627	<	int c = runControl;
628	<	int nextc = c - 1;
629	<	if (!casRunControl(c, nextc))
630	<	return false;
631	<	if (canTerminateOnShutdown(nextc))
632	<	terminateOnShutdown();
633	<	return true;
626	>	private void decrementWorkerCounts(int dr, int dt) {
627	>	for (;;) {
628	>	int wc = workerCounts;
629	>	if ((wc & RUNNING_COUNT_MASK)  - dr < 0 ||
630	>	(wc >>> TOTAL_COUNT_SHIFT) - dt < 0) {
631	>	if ((runState & TERMINATED) != 0)
632	>	return; // lagging termination on a backout
633	>	Thread.yield();
634	>	}
635	>	if (UNSAFE.compareAndSwapInt(this, workerCountsOffset,
636	>	wc, wc - (dr + dt)))
637	>	return;
638	>	}
639		}
640
641		/**
642	<	* Returns true if argument represents zero active count and
643	<	* nonzero runstate, which is the triggering condition for
307	<	* terminating on shutdown.
642	>	* Tries decrementing active count; fails on contention.
643	>	* Called when workers cannot find tasks to run.
644		*/
645	<	private static boolean canTerminateOnShutdown(int c) {
646	<	// i.e. least bit is nonzero runState bit
647	<	return ((c & -c) >>> 16) != 0;
645	>	final boolean tryDecrementActiveCount() {
646	>	int c;
647	>	return UNSAFE.compareAndSwapInt(this, runStateOffset,
648	>	c = runState, c - 1);
649		}
650
651		/**
652	<	* Transition run state to at least the given state. Return true
653	<	* if not already at least given state.
652	>	* Advances to at least the given level. Returns true if not
653	>	* already in at least the given level.
654		*/
655	<	private boolean transitionRunStateTo(int state) {
655	>	private boolean advanceRunLevel(int level) {
656		for (;;) {
657	<	int c = runControl;
658	<	if (runStateOf(c) >= state)
657	>	int s = runState;
658	>	if ((s & level) != 0)
659		return false;
660	<	if (casRunControl(c, runControlFor(state, activeCountOf(c))))
660	>	if (UNSAFE.compareAndSwapInt(this, runStateOffset, s, s | level))
661		return true;
662		}
663		}
664
665	+	// workers array maintenance
666	+
667		/**
668	<	* Controls whether to add spares to maintain parallelism
668	>	* Records and returns a workers array index for new worker.
669		*/
670	<	private volatile boolean maintainsParallelism;
670	>	private int recordWorker(ForkJoinWorkerThread w) {
671	>	// Try using slot totalCount-1. If not available, scan and/or resize
672	>	int k = (workerCounts >>> TOTAL_COUNT_SHIFT) - 1;
673	>	final ReentrantLock lock = this.workerLock;
674	>	lock.lock();
675	>	try {
676	>	ForkJoinWorkerThread[] ws = workers;
677	>	int n = ws.length;
678	>	if (k < 0 || k >= n || ws[k] != null) {
679	>	for (k = 0; k < n && ws[k] != null; ++k)
680	>	;
681	>	if (k == n)
682	>	ws = workers = Arrays.copyOf(ws, n << 1);
683	>	}
684	>	ws[k] = w;
685	>	int c = eventCount; // advance event count to ensure visibility
686	>	UNSAFE.compareAndSwapInt(this, eventCountOffset, c, c+1);
687	>	} finally {
688	>	lock.unlock();
689	>	}
690	>	return k;
691	>	}
692
693	<	// Constructors
693	>	/**
694	>	* Nulls out record of worker in workers array.
695	>	*/
696	>	private void forgetWorker(ForkJoinWorkerThread w) {
697	>	int idx = w.poolIndex;
698	>	// Locking helps method recordWorker avoid unnecessary expansion
699	>	final ReentrantLock lock = this.workerLock;
700	>	lock.lock();
701	>	try {
702	>	ForkJoinWorkerThread[] ws = workers;
703	>	if (idx >= 0 && idx < ws.length && ws[idx] == w) // verify
704	>	ws[idx] = null;
705	>	} finally {
706	>	lock.unlock();
707	>	}
708	>	}
709
710		/**
711	<	* Creates a ForkJoinPool with a pool size equal to the number of
712	<	* processors available on the system, using the default
713	<	* ForkJoinWorkerThreadFactory.
711	>	* Final callback from terminating worker.  Removes record of
712	>	* worker from array, and adjusts counts. If pool is shutting
713	>	* down, tries to complete termination.
714		*
715	<	* @throws SecurityException if a security manager exists and
341	<	*         the caller is not permitted to modify threads
342	<	*         because it does not hold {@link
343	<	*         java.lang.RuntimePermission}{@code ("modifyThread")}
715	>	* @param w the worker
716		*/
717	<	public ForkJoinPool() {
718	<	this(Runtime.getRuntime().availableProcessors(),
719	<	defaultForkJoinWorkerThreadFactory);
717	>	final void workerTerminated(ForkJoinWorkerThread w) {
718	>	forgetWorker(w);
719	>	decrementWorkerCounts(w.isTrimmed() ? 0 : ONE_RUNNING, ONE_TOTAL);
720	>	while (w.stealCount != 0) // collect final count
721	>	tryAccumulateStealCount(w);
722	>	tryTerminate(false);
723		}
724
725	+	// Waiting for and signalling events
726	+
727		/**
728	<	* Creates a ForkJoinPool with the indicated parallelism level
729	<	* threads and using the default ForkJoinWorkerThreadFactory.
730	<	*
731	<	* @param parallelism the number of worker threads
355	<	* @throws IllegalArgumentException if parallelism less than or
356	<	* equal to zero
357	<	* @throws SecurityException if a security manager exists and
358	<	*         the caller is not permitted to modify threads
359	<	*         because it does not hold {@link
360	<	*         java.lang.RuntimePermission}{@code ("modifyThread")}
728	>	* Releases workers blocked on a count not equal to current count.
729	>	* Normally called after precheck that eventWaiters isn't zero to
730	>	* avoid wasted array checks. Gives up upon a change in count or
731	>	* upon releasing two workers, letting others take over.
732		*/
733	<	public ForkJoinPool(int parallelism) {
734	<	this(parallelism, defaultForkJoinWorkerThreadFactory);
733	>	private void releaseEventWaiters() {
734	>	ForkJoinWorkerThread[] ws = workers;
735	>	int n = ws.length;
736	>	long h = eventWaiters;
737	>	int ec = eventCount;
738	>	boolean releasedOne = false;
739	>	ForkJoinWorkerThread w; int id;
740	>	while ((id = ((int)(h & WAITER_ID_MASK)) - 1) >= 0 &&
741	>	(int)(h >>> EVENT_COUNT_SHIFT) != ec &&
742	>	id < n && (w = ws[id]) != null) {
743	>	if (UNSAFE.compareAndSwapLong(this, eventWaitersOffset,
744	>	h,  w.nextWaiter)) {
745	>	LockSupport.unpark(w);
746	>	if (releasedOne) // exit on second release
747	>	break;
748	>	releasedOne = true;
749	>	}
750	>	if (eventCount != ec)
751	>	break;
752	>	h = eventWaiters;
753	>	}
754		}
755
756		/**
757	<	* Creates a ForkJoinPool with parallelism equal to the number of
758	<	* processors available on the system and using the given
369	<	* ForkJoinWorkerThreadFactory.
370	<	*
371	<	* @param factory the factory for creating new threads
372	<	* @throws NullPointerException if factory is null
373	<	* @throws SecurityException if a security manager exists and
374	<	*         the caller is not permitted to modify threads
375	<	*         because it does not hold {@link
376	<	*         java.lang.RuntimePermission}{@code ("modifyThread")}
757	>	* Tries to advance eventCount and releases waiters. Called only
758	>	* from workers.
759		*/
760	<	public ForkJoinPool(ForkJoinWorkerThreadFactory factory) {
761	<	this(Runtime.getRuntime().availableProcessors(), factory);
760	>	final void signalWork() {
761	>	int c; // try to increment event count -- CAS failure OK
762	>	UNSAFE.compareAndSwapInt(this, eventCountOffset, c = eventCount, c+1);
763	>	if (eventWaiters != 0L)
764	>	releaseEventWaiters();
765		}
766
767		/**
768	<	* Creates a ForkJoinPool with the given parallelism and factory.
768	>	* Adds the given worker to event queue and blocks until
769	>	* terminating or event count advances from the given value
770		*
771	<	* @param parallelism the targeted number of worker threads
772	<	* @param factory the factory for creating new threads
387	<	* @throws IllegalArgumentException if parallelism less than or
388	<	* equal to zero, or greater than implementation limit
389	<	* @throws NullPointerException if factory is null
390	<	* @throws SecurityException if a security manager exists and
391	<	*         the caller is not permitted to modify threads
392	<	*         because it does not hold {@link
393	<	*         java.lang.RuntimePermission}{@code ("modifyThread")}
771	>	* @param w the calling worker thread
772	>	* @param ec the count
773		*/
774	<	public ForkJoinPool(int parallelism, ForkJoinWorkerThreadFactory factory) {
775	<	if (parallelism <= 0 || parallelism > MAX_THREADS)
776	<	throw new IllegalArgumentException();
777	<	if (factory == null)
778	<	throw new NullPointerException();
779	<	checkPermission();
780	<	this.factory = factory;
781	<	this.parallelism = parallelism;
782	<	this.maxPoolSize = MAX_THREADS;
783	<	this.maintainsParallelism = true;
784	<	this.poolNumber = poolNumberGenerator.incrementAndGet();
785	<	this.workerLock = new ReentrantLock();
786	<	this.termination = workerLock.newCondition();
408	<	this.stealCount = new AtomicLong();
409	<	this.submissionQueue = new LinkedTransferQueue<ForkJoinTask<?>>();
410	<	// worker array and workers are lazily constructed
774	>	private void eventSync(ForkJoinWorkerThread w, int ec) {
775	>	long nh = (((long)ec) << EVENT_COUNT_SHIFT) | ((long)(w.poolIndex+1));
776	>	long h;
777	>	while ((runState < SHUTDOWN || !tryTerminate(false)) &&
778	>	(((int)((h = eventWaiters) & WAITER_ID_MASK)) == 0 ||
779	>	(int)(h >>> EVENT_COUNT_SHIFT) == ec) &&
780	>	eventCount == ec) {
781	>	if (UNSAFE.compareAndSwapLong(this, eventWaitersOffset,
782	>	w.nextWaiter = h, nh)) {
783	>	awaitEvent(w, ec);
784	>	break;
785	>	}
786	>	}
787		}
788
789		/**
790	<	* Creates a new worker thread using factory.
790	>	* Blocks the given worker (that has already been entered as an
791	>	* event waiter) until terminating or event count advances from
792	>	* the given value. The oldest (first) waiter uses a timed wait to
793	>	* occasionally one-by-one shrink the number of workers (to a
794	>	* minimum of one) if the pool has not been used for extended
795	>	* periods.
796		*
797	<	* @param index the index to assign worker
798	<	* @return new worker, or null of factory failed
797	>	* @param w the calling worker thread
798	>	* @param ec the count
799		*/
800	<	private ForkJoinWorkerThread createWorker(int index) {
801	<	Thread.UncaughtExceptionHandler h = ueh;
802	<	ForkJoinWorkerThread w = factory.newThread(this);
803	<	if (w != null) {
804	<	w.poolIndex = index;
805	<	w.setDaemon(true);
806	<	w.setAsyncMode(locallyFifo);
807	<	w.setName("ForkJoinPool-" + poolNumber + "-worker-" + index);
808	<	if (h != null)
809	<	w.setUncaughtExceptionHandler(h);
800	>	private void awaitEvent(ForkJoinWorkerThread w, int ec) {
801	>	while (eventCount == ec) {
802	>	if (tryAccumulateStealCount(w)) { // transfer while idle
803	>	boolean untimed = (w.nextWaiter != 0L ||
804	>	(workerCounts & RUNNING_COUNT_MASK) <= 1);
805	>	long startTime = untimed ? 0 : System.nanoTime();
806	>	Thread.interrupted();         // clear/ignore interrupt
807	>	if (w.isTerminating() || eventCount != ec)
808	>	break;                    // recheck after clear
809	>	if (untimed)
810	>	LockSupport.park(w);
811	>	else {
812	>	LockSupport.parkNanos(w, SHRINK_RATE_NANOS);
813	>	if (eventCount != ec || w.isTerminating())
814	>	break;
815	>	if (System.nanoTime() - startTime >= SHRINK_RATE_NANOS)
816	>	tryShutdownUnusedWorker(ec);
817	>	}
818	>	}
819		}
430	–	return w;
820		}
821
822	+	// Maintaining parallelism
823	+
824		/**
825	<	* Returns a good size for worker array given pool size.
435	<	* Currently requires size to be a power of two.
825	>	* Pushes worker onto the spare stack.
826		*/
827	<	private static int arraySizeFor(int poolSize) {
828	<	return (poolSize <= 1) ? 1 :
829	<	(1 << (32 - Integer.numberOfLeadingZeros(poolSize-1)));
827	>	final void pushSpare(ForkJoinWorkerThread w) {
828	>	int ns = (++w.spareCount << SPARE_COUNT_SHIFT) | (w.poolIndex + 1);
829	>	do {} while (!UNSAFE.compareAndSwapInt(this, spareWaitersOffset,
830	>	w.nextSpare = spareWaiters,ns));
831		}
832
833		/**
834	<	* Creates or resizes array if necessary to hold newLength.
835	<	* Call only under exclusion.
445	<	*
446	<	* @return the array
834	>	* Tries (once) to resume a spare if the number of running
835	>	* threads is less than target.
836		*/
837	<	private ForkJoinWorkerThread[] ensureWorkerArrayCapacity(int newLength) {
837	>	private void tryResumeSpare() {
838	>	int sw, id;
839		ForkJoinWorkerThread[] ws = workers;
840	<	if (ws == null)
841	<	return workers = new ForkJoinWorkerThread[arraySizeFor(newLength)];
842	<	else if (newLength > ws.length)
843	<	return workers = Arrays.copyOf(ws, arraySizeFor(newLength));
844	<	else
845	<	return ws;
840	>	int n = ws.length;
841	>	ForkJoinWorkerThread w;
842	>	if ((sw = spareWaiters) != 0 &&
843	>	(id = (sw & SPARE_ID_MASK) - 1) >= 0 &&
844	>	id < n && (w = ws[id]) != null &&
845	>	(runState >= TERMINATING ||
846	>	(workerCounts & RUNNING_COUNT_MASK) < parallelism) &&
847	>	spareWaiters == sw &&
848	>	UNSAFE.compareAndSwapInt(this, spareWaitersOffset,
849	>	sw, w.nextSpare)) {
850	>	int c; // increment running count before resume
851	>	do {} while (!UNSAFE.compareAndSwapInt
852	>	(this, workerCountsOffset,
853	>	c = workerCounts, c + ONE_RUNNING));
854	>	if (w.tryUnsuspend())
855	>	LockSupport.unpark(w);
856	>	else   // back out if w was shutdown
857	>	decrementWorkerCounts(ONE_RUNNING, 0);
858	>	}
859		}
860
861		/**
862	<	* Tries to shrink workers into smaller array after one or more terminate.
862	>	* Tries to increase the number of running workers if below target
863	>	* parallelism: If a spare exists tries to resume it via
864	>	* tryResumeSpare.  Otherwise, if not enough total workers or all
865	>	* existing workers are busy, adds a new worker. In all cases also
866	>	* helps wake up releasable workers waiting for work.
867	>	*/
868	>	private void helpMaintainParallelism() {
869	>	int pc = parallelism;
870	>	int wc, rs, tc;
871	>	while (((wc = workerCounts) & RUNNING_COUNT_MASK) < pc &&
872	>	(rs = runState) < TERMINATING) {
873	>	if (spareWaiters != 0)
874	>	tryResumeSpare();
875	>	else if ((tc = wc >>> TOTAL_COUNT_SHIFT) >= MAX_WORKERS ||
876	>	(tc >= pc && (rs & ACTIVE_COUNT_MASK) != tc))
877	>	break;   // enough total
878	>	else if (runState == rs && workerCounts == wc &&
879	>	UNSAFE.compareAndSwapInt(this, workerCountsOffset, wc,
880	>	wc + (ONE_RUNNING|ONE_TOTAL))) {
881	>	ForkJoinWorkerThread w = null;
882	>	Throwable fail = null;
883	>	try {
884	>	w = factory.newThread(this);
885	>	} catch (Throwable ex) {
886	>	fail = ex;
887	>	}
888	>	if (w == null) { // null or exceptional factory return
889	>	decrementWorkerCounts(ONE_RUNNING, ONE_TOTAL);
890	>	tryTerminate(false); // handle failure during shutdown
891	>	// If originating from an external caller,
892	>	// propagate exception, else ignore
893	>	if (fail != null && runState < TERMINATING &&
894	>	!(Thread.currentThread() instanceof
895	>	ForkJoinWorkerThread))
896	>	UNSAFE.throwException(fail);
897	>	break;
898	>	}
899	>	w.start(recordWorker(w), ueh);
900	>	if ((workerCounts >>> TOTAL_COUNT_SHIFT) >= pc)
901	>	break; // add at most one unless total below target
902	>	}
903	>	}
904	>	if (eventWaiters != 0L)
905	>	releaseEventWaiters();
906	>	}
907	>
908	>	/**
909	>	* Callback from the oldest waiter in awaitEvent waking up after a
910	>	* period of non-use. If all workers are idle, tries (once) to
911	>	* shutdown an event waiter or a spare, if one exists. Note that
912	>	* we don't need CAS or locks here because the method is called
913	>	* only from one thread occasionally waking (and even misfires are
914	>	* OK). Note that until the shutdown worker fully terminates,
915	>	* workerCounts will overestimate total count, which is tolerable.
916	>	*
917	>	* @param ec the event count waited on by caller (to abort
918	>	* attempt if count has since changed).
919		*/
920	<	private void tryShrinkWorkerArray() {
921	<	ForkJoinWorkerThread[] ws = workers;
922	<	if (ws != null) {
923	<	int len = ws.length;
924	<	int last = len - 1;
925	<	while (last >= 0 && ws[last] == null)
926	<	--last;
927	<	int newLength = arraySizeFor(last+1);
928	<	if (newLength < len)
929	<	workers = Arrays.copyOf(ws, newLength);
920	>	private void tryShutdownUnusedWorker(int ec) {
921	>	if (runState == 0 && eventCount == ec) { // only trigger if all idle
922	>	ForkJoinWorkerThread[] ws = workers;
923	>	int n = ws.length;
924	>	ForkJoinWorkerThread w = null;
925	>	boolean shutdown = false;
926	>	int sw;
927	>	long h;
928	>	if ((sw = spareWaiters) != 0) { // prefer killing spares
929	>	int id = (sw & SPARE_ID_MASK) - 1;
930	>	if (id >= 0 && id < n && (w = ws[id]) != null &&
931	>	UNSAFE.compareAndSwapInt(this, spareWaitersOffset,
932	>	sw, w.nextSpare))
933	>	shutdown = true;
934	>	}
935	>	else if ((h = eventWaiters) != 0L) {
936	>	long nh;
937	>	int id = ((int)(h & WAITER_ID_MASK)) - 1;
938	>	if (id >= 0 && id < n && (w = ws[id]) != null &&
939	>	(nh = w.nextWaiter) != 0L && // keep at least one worker
940	>	UNSAFE.compareAndSwapLong(this, eventWaitersOffset, h, nh))
941	>	shutdown = true;
942	>	}
943	>	if (w != null && shutdown) {
944	>	w.shutdown();
945	>	LockSupport.unpark(w);
946	>	}
947	>	}
948	>	releaseEventWaiters(); // in case of interference
949	>	}
950	>
951	>	/**
952	>	* Callback from workers invoked upon each top-level action (i.e.,
953	>	* stealing a task or taking a submission and running it).
954	>	* Performs one or more of the following:
955	>	*
956	>	* 1. If the worker is active and either did not run a task
957	>	*    or there are too many workers, try to set its active status
958	>	*    to inactive and update activeCount. On contention, we may
959	>	*    try again in this or a subsequent call.
960	>	*
961	>	* 2. If not enough total workers, help create some.
962	>	*
963	>	* 3. If there are too many running workers, suspend this worker
964	>	*    (first forcing inactive if necessary).  If it is not needed,
965	>	*    it may be shutdown while suspended (via
966	>	*    tryShutdownUnusedWorker).  Otherwise, upon resume it
967	>	*    rechecks running thread count and need for event sync.
968	>	*
969	>	* 4. If worker did not run a task, await the next task event via
970	>	*    eventSync if necessary (first forcing inactivation), upon
971	>	*    which the worker may be shutdown via
972	>	*    tryShutdownUnusedWorker.  Otherwise, help release any
973	>	*    existing event waiters that are now releasable,
974	>	*
975	>	* @param w the worker
976	>	* @param ran true if worker ran a task since last call to this method
977	>	*/
978	>	final void preStep(ForkJoinWorkerThread w, boolean ran) {
979	>	int wec = w.lastEventCount;
980	>	boolean active = w.active;
981	>	boolean inactivate = false;
982	>	int pc = parallelism;
983	>	while (w.runState == 0) {
984	>	int rs = runState;
985	>	if (rs >= TERMINATING) {           // propagate shutdown
986	>	w.shutdown();
987	>	break;
988	>	}
989	>	if ((inactivate || (active && (rs & ACTIVE_COUNT_MASK) >= pc)) &&
990	>	UNSAFE.compareAndSwapInt(this, runStateOffset, rs, --rs)) {
991	>	inactivate = active = w.active = false;
992	>	if (rs == SHUTDOWN) {          // all inactive and shut down
993	>	tryTerminate(false);
994	>	continue;
995	>	}
996	>	}
997	>	int wc = workerCounts;             // try to suspend as spare
998	>	if ((wc & RUNNING_COUNT_MASK) > pc) {
999	>	if (!(inactivate |= active) && // must inactivate to suspend
1000	>	workerCounts == wc &&
1001	>	UNSAFE.compareAndSwapInt(this, workerCountsOffset,
1002	>	wc, wc - ONE_RUNNING))
1003	>	w.suspendAsSpare();
1004	>	}
1005	>	else if ((wc >>> TOTAL_COUNT_SHIFT) < pc)
1006	>	helpMaintainParallelism();     // not enough workers
1007	>	else if (ran)
1008	>	break;
1009	>	else {
1010	>	long h = eventWaiters;
1011	>	int ec = eventCount;
1012	>	if (h != 0L && (int)(h >>> EVENT_COUNT_SHIFT) != ec)
1013	>	releaseEventWaiters();     // release others before waiting
1014	>	else if (ec != wec) {
1015	>	w.lastEventCount = ec;     // no need to wait
1016	>	break;
1017	>	}
1018	>	else if (!(inactivate |= active))
1019	>	eventSync(w, wec);         // must inactivate before sync
1020	>	}
1021		}
1022		}
1023
1024		/**
1025	<	* Initializes workers if necessary.
1025	>	* Helps and/or blocks awaiting join of the given task.
1026	>	* See above for explanation.
1027	>	*
1028	>	* @param joinMe the task to join
1029	>	* @param worker the current worker thread
1030	>	* @param timed true if wait should time out
1031	>	* @param nanos timeout value if timed
1032		*/
1033	<	final void ensureWorkerInitialization() {
1034	<	ForkJoinWorkerThread[] ws = workers;
1035	<	if (ws == null) {
1036	<	final ReentrantLock lock = this.workerLock;
1037	<	lock.lock();
1038	<	try {
1039	<	ws = workers;
1040	<	if (ws == null) {
1041	<	int ps = parallelism;
1042	<	ws = ensureWorkerArrayCapacity(ps);
1043	<	for (int i = 0; i < ps; ++i) {
1044	<	ForkJoinWorkerThread w = createWorker(i);
1045	<	if (w != null) {
1046	<	ws[i] = w;
1047	<	w.start();
1048	<	updateWorkerCount(1);
1033	>	final void awaitJoin(ForkJoinTask<?> joinMe, ForkJoinWorkerThread worker,
1034	>	boolean timed, long nanos) {
1035	>	long startTime = timed? System.nanoTime() : 0L;
1036	>	int retries = 2 + (parallelism >> 2); // #helpJoins before blocking
1037	>	boolean running = true;               // false when count decremented
1038	>	while (joinMe.status >= 0) {
1039	>	if (runState >= TERMINATING) {
1040	>	joinMe.cancelIgnoringExceptions();
1041	>	break;
1042	>	}
1043	>	running = worker.helpJoinTask(joinMe, running);
1044	>	if (joinMe.status < 0)
1045	>	break;
1046	>	if (retries > 0) {
1047	>	--retries;
1048	>	continue;
1049	>	}
1050	>	int wc = workerCounts;
1051	>	if ((wc & RUNNING_COUNT_MASK) != 0) {
1052	>	if (running) {
1053	>	if (!UNSAFE.compareAndSwapInt(this, workerCountsOffset,
1054	>	wc, wc - ONE_RUNNING))
1055	>	continue;
1056	>	running = false;
1057	>	}
1058	>	long h = eventWaiters;
1059	>	if (h != 0L && (int)(h >>> EVENT_COUNT_SHIFT) != eventCount)
1060	>	releaseEventWaiters();
1061	>	if (joinMe.status < 0)
1062	>	break;
1063	>	if ((workerCounts & RUNNING_COUNT_MASK) != 0) {
1064	>	long ms; int ns;
1065	>	if (!timed) {
1066	>	ms = JOIN_TIMEOUT_MILLIS;
1067	>	ns = 0;
1068	>	}
1069	>	else { // at most JOIN_TIMEOUT_MILLIS per wait
1070	>	long nt = nanos - (System.nanoTime() - startTime);
1071	>	if (nt <= 0L)
1072	>	break;
1073	>	ms = nt / 1000000;
1074	>	if (ms > JOIN_TIMEOUT_MILLIS) {
1075	>	ms = JOIN_TIMEOUT_MILLIS;
1076	>	ns = 0;
1077		}
1078	+	else
1079	+	ns = (int) (nt % 1000000);
1080		}
1081	+	if (joinMe.internalAwaitDone(ms, ns) < 0)
1082	+	break;
1083		}
496	–	} finally {
497	–	lock.unlock();
1084		}
1085	+	helpMaintainParallelism();
1086	+	}
1087	+	if (!running) {
1088	+	int c;
1089	+	do {} while (!UNSAFE.compareAndSwapInt
1090	+	(this, workerCountsOffset,
1091	+	c = workerCounts, c + ONE_RUNNING));
1092		}
1093		}
1094
1095		/**
1096	<	* Worker creation and startup for threads added via setParallelism.
1096	>	* Same idea as awaitJoin, but no helping, retries, or timeouts.
1097		*/
1098	<	private void createAndStartAddedWorkers() {
1099	<	resumeAllSpares();  // Allow spares to convert to nonspare
1100	<	int ps = parallelism;
1101	<	ForkJoinWorkerThread[] ws = ensureWorkerArrayCapacity(ps);
1102	<	int len = ws.length;
1103	<	// Sweep through slots, to keep lowest indices most populated
1104	<	int k = 0;
1105	<	while (k < len) {
1106	<	if (ws[k] != null) {
1107	<	++k;
1108	<	continue;
1109	<	}
1110	<	int s = workerCounts;
1111	<	int tc = totalCountOf(s);
1112	<	int rc = runningCountOf(s);
1113	<	if (rc >= ps || tc >= ps)
1098	>	final void awaitBlocker(ManagedBlocker blocker)
1099	>	throws InterruptedException {
1100	>	while (!blocker.isReleasable()) {
1101	>	int wc = workerCounts;
1102	>	if ((wc & RUNNING_COUNT_MASK) == 0)
1103	>	helpMaintainParallelism();
1104	>	else if (UNSAFE.compareAndSwapInt(this, workerCountsOffset,
1105	>	wc, wc - ONE_RUNNING)) {
1106	>	try {
1107	>	while (!blocker.isReleasable()) {
1108	>	long h = eventWaiters;
1109	>	if (h != 0L &&
1110	>	(int)(h >>> EVENT_COUNT_SHIFT) != eventCount)
1111	>	releaseEventWaiters();
1112	>	else if ((workerCounts & RUNNING_COUNT_MASK) == 0 &&
1113	>	runState < TERMINATING)
1114	>	helpMaintainParallelism();
1115	>	else if (blocker.block())
1116	>	break;
1117	>	}
1118	>	} finally {
1119	>	int c;
1120	>	do {} while (!UNSAFE.compareAndSwapInt
1121	>	(this, workerCountsOffset,
1122	>	c = workerCounts, c + ONE_RUNNING));
1123	>	}
1124		break;
1125	<	if (casWorkerCounts (s, workerCountsFor(tc+1, rc+1))) {
1126	<	ForkJoinWorkerThread w = createWorker(k);
1125	>	}
1126	>	}
1127	>	}
1128	>
1129	>	/**
1130	>	* Possibly initiates and/or completes termination.
1131	>	*
1132	>	* @param now if true, unconditionally terminate, else only
1133	>	* if shutdown and empty queue and no active workers
1134	>	* @return true if now terminating or terminated
1135	>	*/
1136	>	private boolean tryTerminate(boolean now) {
1137	>	if (now)
1138	>	advanceRunLevel(SHUTDOWN); // ensure at least SHUTDOWN
1139	>	else if (runState < SHUTDOWN ||
1140	>	!submissionQueue.isEmpty() ||
1141	>	(runState & ACTIVE_COUNT_MASK) != 0)
1142	>	return false;
1143	>
1144	>	if (advanceRunLevel(TERMINATING))
1145	>	startTerminating();
1146	>
1147	>	// Finish now if all threads terminated; else in some subsequent call
1148	>	if ((workerCounts >>> TOTAL_COUNT_SHIFT) == 0) {
1149	>	advanceRunLevel(TERMINATED);
1150	>	termination.forceTermination();
1151	>	}
1152	>	return true;
1153	>	}
1154	>
1155	>	/**
1156	>	* Actions on transition to TERMINATING
1157	>	*
1158	>	* Runs up to four passes through workers: (0) shutting down each
1159	>	* (without waking up if parked) to quickly spread notifications
1160	>	* without unnecessary bouncing around event queues etc (1) wake
1161	>	* up and help cancel tasks (2) interrupt (3) mop up races with
1162	>	* interrupted workers
1163	>	*/
1164	>	private void startTerminating() {
1165	>	cancelSubmissions();
1166	>	for (int passes = 0; passes < 4 && workerCounts != 0; ++passes) {
1167	>	int c; // advance event count
1168	>	UNSAFE.compareAndSwapInt(this, eventCountOffset,
1169	>	c = eventCount, c+1);
1170	>	eventWaiters = 0L; // clobber lists
1171	>	spareWaiters = 0;
1172	>	for (ForkJoinWorkerThread w : workers) {
1173		if (w != null) {
1174	<	ws[k++] = w;
1175	<	w.start();
1176	<	}
1177	<	else {
1178	<	updateWorkerCount(-1); // back out on failed creation
1179	<	break;
1174	>	w.shutdown();
1175	>	if (passes > 0 && !w.isTerminated()) {
1176	>	w.cancelTasks();
1177	>	LockSupport.unpark(w);
1178	>	if (passes > 1 && !w.isInterrupted()) {
1179	>	try {
1180	>	w.interrupt();
1181	>	} catch (SecurityException ignore) {
1182	>	}
1183	>	}
1184	>	}
1185		}
1186		}
1187		}
1188		}
1189
1190	+	/**
1191	+	* Clears out and cancels submissions, ignoring exceptions.
1192	+	*/
1193	+	private void cancelSubmissions() {
1194	+	ForkJoinTask<?> task;
1195	+	while ((task = submissionQueue.poll()) != null) {
1196	+	try {
1197	+	task.cancel(false);
1198	+	} catch (Throwable ignore) {
1199	+	}
1200	+	}
1201	+	}
1202	+
1203	+	// misc support for ForkJoinWorkerThread
1204	+
1205	+	/**
1206	+	* Returns pool number.
1207	+	*/
1208	+	final int getPoolNumber() {
1209	+	return poolNumber;
1210	+	}
1211	+
1212	+	/**
1213	+	* Tries to accumulate steal count from a worker, clearing
1214	+	* the worker's value if successful.
1215	+	*
1216	+	* @return true if worker steal count now zero
1217	+	*/
1218	+	final boolean tryAccumulateStealCount(ForkJoinWorkerThread w) {
1219	+	int sc = w.stealCount;
1220	+	long c = stealCount;
1221	+	// CAS even if zero, for fence effects
1222	+	if (UNSAFE.compareAndSwapLong(this, stealCountOffset, c, c + sc)) {
1223	+	if (sc != 0)
1224	+	w.stealCount = 0;
1225	+	return true;
1226	+	}
1227	+	return sc == 0;
1228	+	}
1229	+
1230	+	/**
1231	+	* Returns the approximate (non-atomic) number of idle threads per
1232	+	* active thread.
1233	+	*/
1234	+	final int idlePerActive() {
1235	+	int pc = parallelism; // use parallelism, not rc
1236	+	int ac = runState;    // no mask -- artificially boosts during shutdown
1237	+	// Use exact results for small values, saturate past 4
1238	+	return ((pc <= ac) ? 0 :
1239	+	(pc >>> 1 <= ac) ? 1 :
1240	+	(pc >>> 2 <= ac) ? 3 :
1241	+	pc >>> 3);
1242	+	}
1243	+
1244	+	// Public and protected methods
1245	+
1246	+	// Constructors
1247	+
1248	+	/**
1249	+	* Creates a {@code ForkJoinPool} with parallelism equal to {@link
1250	+	* java.lang.Runtime#availableProcessors}, using the {@linkplain
1251	+	* #defaultForkJoinWorkerThreadFactory default thread factory},
1252	+	* no UncaughtExceptionHandler, and non-async LIFO processing mode.
1253	+	*
1254	+	* @throws SecurityException if a security manager exists and
1255	+	*         the caller is not permitted to modify threads
1256	+	*         because it does not hold {@link
1257	+	*         java.lang.RuntimePermission}{@code ("modifyThread")}
1258	+	*/
1259	+	public ForkJoinPool() {
1260	+	this(Runtime.getRuntime().availableProcessors(),
1261	+	defaultForkJoinWorkerThreadFactory, null, false);
1262	+	}
1263	+
1264	+	/**
1265	+	* Creates a {@code ForkJoinPool} with the indicated parallelism
1266	+	* level, the {@linkplain
1267	+	* #defaultForkJoinWorkerThreadFactory default thread factory},
1268	+	* no UncaughtExceptionHandler, and non-async LIFO processing mode.
1269	+	*
1270	+	* @param parallelism the parallelism level
1271	+	* @throws IllegalArgumentException if parallelism less than or
1272	+	*         equal to zero, or greater than implementation limit
1273	+	* @throws SecurityException if a security manager exists and
1274	+	*         the caller is not permitted to modify threads
1275	+	*         because it does not hold {@link
1276	+	*         java.lang.RuntimePermission}{@code ("modifyThread")}
1277	+	*/
1278	+	public ForkJoinPool(int parallelism) {
1279	+	this(parallelism, defaultForkJoinWorkerThreadFactory, null, false);
1280	+	}
1281	+
1282	+	/**
1283	+	* Creates a {@code ForkJoinPool} with the given parameters.
1284	+	*
1285	+	* @param parallelism the parallelism level. For default value,
1286	+	* use {@link java.lang.Runtime#availableProcessors}.
1287	+	* @param factory the factory for creating new threads. For default value,
1288	+	* use {@link #defaultForkJoinWorkerThreadFactory}.
1289	+	* @param handler the handler for internal worker threads that
1290	+	* terminate due to unrecoverable errors encountered while executing
1291	+	* tasks. For default value, use {@code null}.
1292	+	* @param asyncMode if true,
1293	+	* establishes local first-in-first-out scheduling mode for forked
1294	+	* tasks that are never joined. This mode may be more appropriate
1295	+	* than default locally stack-based mode in applications in which
1296	+	* worker threads only process event-style asynchronous tasks.
1297	+	* For default value, use {@code false}.
1298	+	* @throws IllegalArgumentException if parallelism less than or
1299	+	*         equal to zero, or greater than implementation limit
1300	+	* @throws NullPointerException if the factory is null
1301	+	* @throws SecurityException if a security manager exists and
1302	+	*         the caller is not permitted to modify threads
1303	+	*         because it does not hold {@link
1304	+	*         java.lang.RuntimePermission}{@code ("modifyThread")}
1305	+	*/
1306	+	public ForkJoinPool(int parallelism,
1307	+	ForkJoinWorkerThreadFactory factory,
1308	+	Thread.UncaughtExceptionHandler handler,
1309	+	boolean asyncMode) {
1310	+	checkPermission();
1311	+	if (factory == null)
1312	+	throw new NullPointerException();
1313	+	if (parallelism <= 0 || parallelism > MAX_WORKERS)
1314	+	throw new IllegalArgumentException();
1315	+	this.parallelism = parallelism;
1316	+	this.factory = factory;
1317	+	this.ueh = handler;
1318	+	this.locallyFifo = asyncMode;
1319	+	int arraySize = initialArraySizeFor(parallelism);
1320	+	this.workers = new ForkJoinWorkerThread[arraySize];
1321	+	this.submissionQueue = new LinkedTransferQueue<ForkJoinTask<?>>();
1322	+	this.workerLock = new ReentrantLock();
1323	+	this.termination = new Phaser(1);
1324	+	this.poolNumber = poolNumberGenerator.incrementAndGet();
1325	+	}
1326	+
1327	+	/**
1328	+	* Returns initial power of two size for workers array.
1329	+	* @param pc the initial parallelism level
1330	+	*/
1331	+	private static int initialArraySizeFor(int pc) {
1332	+	// If possible, initially allocate enough space for one spare
1333	+	int size = pc < MAX_WORKERS ? pc + 1 : MAX_WORKERS;
1334	+	// See Hackers Delight, sec 3.2. We know MAX_WORKERS < (1 >>> 16)
1335	+	size |= size >>> 1;
1336	+	size |= size >>> 2;
1337	+	size |= size >>> 4;
1338	+	size |= size >>> 8;
1339	+	return size + 1;
1340	+	}
1341	+
1342		// Execution methods
1343
1344		/**
1345	<	* Common code for execute, invoke and submit
1345	>	* Submits task and creates, starts, or resumes some workers if necessary
1346		*/
1347		private <T> void doSubmit(ForkJoinTask<T> task) {
542	–	if (isShutdown())
543	–	throw new RejectedExecutionException();
544	–	if (workers == null)
545	–	ensureWorkerInitialization();
1348		submissionQueue.offer(task);
1349	<	signalIdleWorkers();
1349	>	int c; // try to increment event count -- CAS failure OK
1350	>	UNSAFE.compareAndSwapInt(this, eventCountOffset, c = eventCount, c+1);
1351	>	helpMaintainParallelism();
1352		}
1353
1354		/**
#	Line 552 | Line 1356 | public class ForkJoinPool extends Abstra
1356		*
1357		* @param task the task
1358		* @return the task's result
1359	<	* @throws NullPointerException if task is null
1360	<	* @throws RejectedExecutionException if pool is shut down
1359	>	* @throws NullPointerException if the task is null
1360	>	* @throws RejectedExecutionException if the task cannot be
1361	>	*         scheduled for execution
1362		*/
1363		public <T> T invoke(ForkJoinTask<T> task) {
1364	<	doSubmit(task);
1365	<	return task.join();
1364	>	if (task == null)
1365	>	throw new NullPointerException();
1366	>	if (runState >= SHUTDOWN)
1367	>	throw new RejectedExecutionException();
1368	>	Thread t = Thread.currentThread();
1369	>	if ((t instanceof ForkJoinWorkerThread) &&
1370	>	((ForkJoinWorkerThread)t).pool == this)
1371	>	return task.invoke();  // bypass submit if in same pool
1372	>	else {
1373	>	doSubmit(task);
1374	>	return task.join();
1375	>	}
1376	>	}
1377	>
1378	>	/**
1379	>	* Unless terminating, forks task if within an ongoing FJ
1380	>	* computation in the current pool, else submits as external task.
1381	>	*/
1382	>	private <T> void forkOrSubmit(ForkJoinTask<T> task) {
1383	>	if (runState >= SHUTDOWN)
1384	>	throw new RejectedExecutionException();
1385	>	Thread t = Thread.currentThread();
1386	>	if ((t instanceof ForkJoinWorkerThread) &&
1387	>	((ForkJoinWorkerThread)t).pool == this)
1388	>	task.fork();
1389	>	else
1390	>	doSubmit(task);
1391		}
1392
1393		/**
1394		* Arranges for (asynchronous) execution of the given task.
1395		*
1396		* @param task the task
1397	<	* @throws NullPointerException if task is null
1398	<	* @throws RejectedExecutionException if pool is shut down
1397	>	* @throws NullPointerException if the task is null
1398	>	* @throws RejectedExecutionException if the task cannot be
1399	>	*         scheduled for execution
1400		*/
1401	<	public <T> void execute(ForkJoinTask<T> task) {
1402	<	doSubmit(task);
1401	>	public void execute(ForkJoinTask<?> task) {
1402	>	if (task == null)
1403	>	throw new NullPointerException();
1404	>	forkOrSubmit(task);
1405		}
1406
1407		// AbstractExecutorService methods
1408
1409	+	/**
1410	+	* @throws NullPointerException if the task is null
1411	+	* @throws RejectedExecutionException if the task cannot be
1412	+	*         scheduled for execution
1413	+	*/
1414		public void execute(Runnable task) {
1415	<	doSubmit(new AdaptedRunnable<Void>(task, null));
1415	>	if (task == null)
1416	>	throw new NullPointerException();
1417	>	ForkJoinTask<?> job;
1418	>	if (task instanceof ForkJoinTask<?>) // avoid re-wrap
1419	>	job = (ForkJoinTask<?>) task;
1420	>	else
1421	>	job = ForkJoinTask.adapt(task, null);
1422	>	forkOrSubmit(job);
1423		}
1424
1425	<	public <T> ForkJoinTask<T> submit(Callable<T> task) {
1426	<	ForkJoinTask<T> job = new AdaptedCallable<T>(task);
1427	<	doSubmit(job);
1428	<	return job;
1425	>	/**
1426	>	* Submits a ForkJoinTask for execution.
1427	>	*
1428	>	* @param task the task to submit
1429	>	* @return the task
1430	>	* @throws NullPointerException if the task is null
1431	>	* @throws RejectedExecutionException if the task cannot be
1432	>	*         scheduled for execution
1433	>	*/
1434	>	public <T> ForkJoinTask<T> submit(ForkJoinTask<T> task) {
1435	>	if (task == null)
1436	>	throw new NullPointerException();
1437	>	forkOrSubmit(task);
1438	>	return task;
1439		}
1440
1441	<	public <T> ForkJoinTask<T> submit(Runnable task, T result) {
1442	<	ForkJoinTask<T> job = new AdaptedRunnable<T>(task, result);
1443	<	doSubmit(job);
1441	>	/**
1442	>	* @throws NullPointerException if the task is null
1443	>	* @throws RejectedExecutionException if the task cannot be
1444	>	*         scheduled for execution
1445	>	*/
1446	>	public <T> ForkJoinTask<T> submit(Callable<T> task) {
1447	>	if (task == null)
1448	>	throw new NullPointerException();
1449	>	ForkJoinTask<T> job = ForkJoinTask.adapt(task);
1450	>	forkOrSubmit(job);
1451		return job;
1452		}
1453
1454	<	public ForkJoinTask<?> submit(Runnable task) {
1455	<	ForkJoinTask<Void> job = new AdaptedRunnable<Void>(task, null);
1456	<	doSubmit(job);
1454	>	/**
1455	>	* @throws NullPointerException if the task is null
1456	>	* @throws RejectedExecutionException if the task cannot be
1457	>	*         scheduled for execution
1458	>	*/
1459	>	public <T> ForkJoinTask<T> submit(Runnable task, T result) {
1460	>	if (task == null)
1461	>	throw new NullPointerException();
1462	>	ForkJoinTask<T> job = ForkJoinTask.adapt(task, result);
1463	>	forkOrSubmit(job);
1464		return job;
1465		}
1466
1467		/**
1468	<	* Adaptor for Runnables. This implements RunnableFuture
1469	<	* to be compliant with AbstractExecutorService constraints.
1468	>	* @throws NullPointerException if the task is null
1469	>	* @throws RejectedExecutionException if the task cannot be
1470	>	*         scheduled for execution
1471		*/
1472	<	static final class AdaptedRunnable<T> extends ForkJoinTask<T>
1473	<	implements RunnableFuture<T> {
1474	<	final Runnable runnable;
1475	<	final T resultOnCompletion;
1476	<	T result;
1477	<	AdaptedRunnable(Runnable runnable, T result) {
1478	<	if (runnable == null) throw new NullPointerException();
1479	<	this.runnable = runnable;
1480	<	this.resultOnCompletion = result;
1481	<	}
612	<	public T getRawResult() { return result; }
613	<	public void setRawResult(T v) { result = v; }
614	<	public boolean exec() {
615	<	runnable.run();
616	<	result = resultOnCompletion;
617	<	return true;
618	<	}
619	<	public void run() { invoke(); }
620	<	private static final long serialVersionUID = 5232453952276885070L;
1472	>	public ForkJoinTask<?> submit(Runnable task) {
1473	>	if (task == null)
1474	>	throw new NullPointerException();
1475	>	ForkJoinTask<?> job;
1476	>	if (task instanceof ForkJoinTask<?>) // avoid re-wrap
1477	>	job = (ForkJoinTask<?>) task;
1478	>	else
1479	>	job = ForkJoinTask.adapt(task, null);
1480	>	forkOrSubmit(job);
1481	>	return job;
1482		}
1483
1484		/**
1485	<	* Adaptor for Callables
1485	>	* @throws NullPointerException       {@inheritDoc}
1486	>	* @throws RejectedExecutionException {@inheritDoc}
1487		*/
626	–	static final class AdaptedCallable<T> extends ForkJoinTask<T>
627	–	implements RunnableFuture<T> {
628	–	final Callable<T> callable;
629	–	T result;
630	–	AdaptedCallable(Callable<T> callable) {
631	–	if (callable == null) throw new NullPointerException();
632	–	this.callable = callable;
633	–	}
634	–	public T getRawResult() { return result; }
635	–	public void setRawResult(T v) { result = v; }
636	–	public boolean exec() {
637	–	try {
638	–	result = callable.call();
639	–	return true;
640	–	} catch (Error err) {
641	–	throw err;
642	–	} catch (RuntimeException rex) {
643	–	throw rex;
644	–	} catch (Exception ex) {
645	–	throw new RuntimeException(ex);
646	–	}
647	–	}
648	–	public void run() { invoke(); }
649	–	private static final long serialVersionUID = 2838392045355241008L;
650	–	}
651	–
1488		public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks) {
1489		ArrayList<ForkJoinTask<T>> forkJoinTasks =
1490		new ArrayList<ForkJoinTask<T>>(tasks.size());
1491		for (Callable<T> task : tasks)
1492	<	forkJoinTasks.add(new AdaptedCallable<T>(task));
1492	>	forkJoinTasks.add(ForkJoinTask.adapt(task));
1493		invoke(new InvokeAll<T>(forkJoinTasks));
1494
1495		@SuppressWarnings({"unchecked", "rawtypes"})
1496	<	List<Future<T>> futures = (List<Future<T>>) (List) forkJoinTasks;
1496	>	List<Future<T>> futures = (List<Future<T>>) (List) forkJoinTasks;
1497		return futures;
1498		}
1499
#	Line 671 | Line 1507 | public class ForkJoinPool extends Abstra
1507		private static final long serialVersionUID = -7914297376763021607L;
1508		}
1509
674	–	// Configuration and status settings and queries
675	–
1510		/**
1511		* Returns the factory used for constructing new workers.
1512		*
#	Line 686 | Line 1520 | public class ForkJoinPool extends Abstra
1520		* Returns the handler for internal worker threads that terminate
1521		* due to unrecoverable errors encountered while executing tasks.
1522		*
1523	<	* @return the handler, or null if none
1523	>	* @return the handler, or {@code null} if none
1524		*/
1525		public Thread.UncaughtExceptionHandler getUncaughtExceptionHandler() {
1526	<	Thread.UncaughtExceptionHandler h;
693	<	final ReentrantLock lock = this.workerLock;
694	<	lock.lock();
695	<	try {
696	<	h = ueh;
697	<	} finally {
698	<	lock.unlock();
699	<	}
700	<	return h;
1526	>	return ueh;
1527		}
1528
1529		/**
1530	<	* Sets the handler for internal worker threads that terminate due
705	<	* to unrecoverable errors encountered while executing tasks.
706	<	* Unless set, the current default or ThreadGroup handler is used
707	<	* as handler.
1530	>	* Returns the targeted parallelism level of this pool.
1531		*
1532	<	* @param h the new handler
710	<	* @return the old handler, or null if none
711	<	* @throws SecurityException if a security manager exists and
712	<	*         the caller is not permitted to modify threads
713	<	*         because it does not hold {@link
714	<	*         java.lang.RuntimePermission}{@code ("modifyThread")}
715	<	*/
716	<	public Thread.UncaughtExceptionHandler
717	<	setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler h) {
718	<	checkPermission();
719	<	Thread.UncaughtExceptionHandler old = null;
720	<	final ReentrantLock lock = this.workerLock;
721	<	lock.lock();
722	<	try {
723	<	old = ueh;
724	<	ueh = h;
725	<	ForkJoinWorkerThread[] ws = workers;
726	<	if (ws != null) {
727	<	for (int i = 0; i < ws.length; ++i) {
728	<	ForkJoinWorkerThread w = ws[i];
729	<	if (w != null)
730	<	w.setUncaughtExceptionHandler(h);
731	<	}
732	<	}
733	<	} finally {
734	<	lock.unlock();
735	<	}
736	<	return old;
737	<	}
738	<
739	<
740	<	/**
741	<	* Sets the target parallelism level of this pool.
742	<	*
743	<	* @param parallelism the target parallelism
744	<	* @throws IllegalArgumentException if parallelism less than or
745	<	* equal to zero or greater than maximum size bounds
746	<	* @throws SecurityException if a security manager exists and
747	<	*         the caller is not permitted to modify threads
748	<	*         because it does not hold {@link
749	<	*         java.lang.RuntimePermission}{@code ("modifyThread")}
750	<	*/
751	<	public void setParallelism(int parallelism) {
752	<	checkPermission();
753	<	if (parallelism <= 0 || parallelism > maxPoolSize)
754	<	throw new IllegalArgumentException();
755	<	final ReentrantLock lock = this.workerLock;
756	<	lock.lock();
757	<	try {
758	<	if (!isTerminating()) {
759	<	int p = this.parallelism;
760	<	this.parallelism = parallelism;
761	<	if (parallelism > p)
762	<	createAndStartAddedWorkers();
763	<	else
764	<	trimSpares();
765	<	}
766	<	} finally {
767	<	lock.unlock();
768	<	}
769	<	signalIdleWorkers();
770	<	}
771	<
772	<	/**
773	<	* Returns the targeted number of worker threads in this pool.
774	<	*
775	<	* @return the targeted number of worker threads in this pool
1532	>	* @return the targeted parallelism level of this pool
1533		*/
1534		public int getParallelism() {
1535		return parallelism;
#	Line 780 | Line 1537 | public class ForkJoinPool extends Abstra
1537
1538		/**
1539		* Returns the number of worker threads that have started but not
1540	<	* yet terminated.  This result returned by this method may differ
1541	<	* from {@code getParallelism} when threads are created to
1540	>	* yet terminated.  The result returned by this method may differ
1541	>	* from {@link #getParallelism} when threads are created to
1542		* maintain parallelism when others are cooperatively blocked.
1543		*
1544		* @return the number of worker threads
1545		*/
1546		public int getPoolSize() {
1547	<	return totalCountOf(workerCounts);
791	<	}
792	<
793	<	/**
794	<	* Returns the maximum number of threads allowed to exist in the
795	<	* pool, even if there are insufficient unblocked running threads.
796	<	*
797	<	* @return the maximum
798	<	*/
799	<	public int getMaximumPoolSize() {
800	<	return maxPoolSize;
801	<	}
802	<
803	<	/**
804	<	* Sets the maximum number of threads allowed to exist in the
805	<	* pool, even if there are insufficient unblocked running threads.
806	<	* Setting this value has no effect on current pool size. It
807	<	* controls construction of new threads.
808	<	*
809	<	* @throws IllegalArgumentException if negative or greater then
810	<	* internal implementation limit
811	<	*/
812	<	public void setMaximumPoolSize(int newMax) {
813	<	if (newMax < 0 || newMax > MAX_THREADS)
814	<	throw new IllegalArgumentException();
815	<	maxPoolSize = newMax;
816	<	}
817	<
818	<
819	<	/**
820	<	* Returns true if this pool dynamically maintains its target
821	<	* parallelism level. If false, new threads are added only to
822	<	* avoid possible starvation.
823	<	* This setting is by default true.
824	<	*
825	<	* @return true if maintains parallelism
826	<	*/
827	<	public boolean getMaintainsParallelism() {
828	<	return maintainsParallelism;
1547	>	return workerCounts >>> TOTAL_COUNT_SHIFT;
1548		}
1549
1550		/**
1551	<	* Sets whether this pool dynamically maintains its target
833	<	* parallelism level. If false, new threads are added only to
834	<	* avoid possible starvation.
835	<	*
836	<	* @param enable true to maintains parallelism
837	<	*/
838	<	public void setMaintainsParallelism(boolean enable) {
839	<	maintainsParallelism = enable;
840	<	}
841	<
842	<	/**
843	<	* Establishes local first-in-first-out scheduling mode for forked
844	<	* tasks that are never joined. This mode may be more appropriate
845	<	* than default locally stack-based mode in applications in which
846	<	* worker threads only process asynchronous tasks.  This method is
847	<	* designed to be invoked only when pool is quiescent, and
848	<	* typically only before any tasks are submitted. The effects of
849	<	* invocations at other times may be unpredictable.
850	<	*
851	<	* @param async if true, use locally FIFO scheduling
852	<	* @return the previous mode
853	<	*/
854	<	public boolean setAsyncMode(boolean async) {
855	<	boolean oldMode = locallyFifo;
856	<	locallyFifo = async;
857	<	ForkJoinWorkerThread[] ws = workers;
858	<	if (ws != null) {
859	<	for (int i = 0; i < ws.length; ++i) {
860	<	ForkJoinWorkerThread t = ws[i];
861	<	if (t != null)
862	<	t.setAsyncMode(async);
863	<	}
864	<	}
865	<	return oldMode;
866	<	}
867	<
868	<	/**
869	<	* Returns true if this pool uses local first-in-first-out
1551	>	* Returns {@code true} if this pool uses local first-in-first-out
1552		* scheduling mode for forked tasks that are never joined.
1553		*
1554	<	* @return true if this pool uses async mode
1554	>	* @return {@code true} if this pool uses async mode
1555		*/
1556		public boolean getAsyncMode() {
1557		return locallyFifo;
#	Line 878 | Line 1560 | public class ForkJoinPool extends Abstra
1560		/**
1561		* Returns an estimate of the number of worker threads that are
1562		* not blocked waiting to join tasks or for other managed
1563	<	* synchronization.
1563	>	* synchronization. This method may overestimate the
1564	>	* number of running threads.
1565		*
1566		* @return the number of worker threads
1567		*/
1568		public int getRunningThreadCount() {
1569	<	return runningCountOf(workerCounts);
1569	>	return workerCounts & RUNNING_COUNT_MASK;
1570		}
1571
1572		/**
#	Line 894 | Line 1577 | public class ForkJoinPool extends Abstra
1577		* @return the number of active threads
1578		*/
1579		public int getActiveThreadCount() {
1580	<	return activeCountOf(runControl);
898	<	}
899	<
900	<	/**
901	<	* Returns an estimate of the number of threads that are currently
902	<	* idle waiting for tasks. This method may underestimate the
903	<	* number of idle threads.
904	<	*
905	<	* @return the number of idle threads
906	<	*/
907	<	final int getIdleThreadCount() {
908	<	int c = runningCountOf(workerCounts) - activeCountOf(runControl);
909	<	return (c <= 0) ? 0 : c;
1580	>	return runState & ACTIVE_COUNT_MASK;
1581		}
1582
1583		/**
1584	<	* Returns true if all worker threads are currently idle. An idle
1585	<	* worker is one that cannot obtain a task to execute because none
1586	<	* are available to steal from other threads, and there are no
1587	<	* pending submissions to the pool. This method is conservative;
1588	<	* it might not return true immediately upon idleness of all
1589	<	* threads, but will eventually become true if threads remain
1590	<	* inactive.
1584	>	* Returns {@code true} if all worker threads are currently idle.
1585	>	* An idle worker is one that cannot obtain a task to execute
1586	>	* because none are available to steal from other threads, and
1587	>	* there are no pending submissions to the pool. This method is
1588	>	* conservative; it might not return {@code true} immediately upon
1589	>	* idleness of all threads, but will eventually become true if
1590	>	* threads remain inactive.
1591		*
1592	<	* @return true if all threads are currently idle
1592	>	* @return {@code true} if all threads are currently idle
1593		*/
1594		public boolean isQuiescent() {
1595	<	return activeCountOf(runControl) == 0;
1595	>	return (runState & ACTIVE_COUNT_MASK) == 0;
1596		}
1597
1598		/**
#	Line 936 | Line 1607 | public class ForkJoinPool extends Abstra
1607		* @return the number of steals
1608		*/
1609		public long getStealCount() {
1610	<	return stealCount.get();
940	<	}
941	<
942	<	/**
943	<	* Accumulates steal count from a worker.
944	<	* Call only when worker known to be idle.
945	<	*/
946	<	private void updateStealCount(ForkJoinWorkerThread w) {
947	<	int sc = w.getAndClearStealCount();
948	<	if (sc != 0)
949	<	stealCount.addAndGet(sc);
1610	>	return stealCount;
1611		}
1612
1613		/**
#	Line 961 | Line 1622 | public class ForkJoinPool extends Abstra
1622		*/
1623		public long getQueuedTaskCount() {
1624		long count = 0;
1625	<	ForkJoinWorkerThread[] ws = workers;
1626	<	if (ws != null) {
1627	<	for (int i = 0; i < ws.length; ++i) {
967	<	ForkJoinWorkerThread t = ws[i];
968	<	if (t != null)
969	<	count += t.getQueueSize();
970	<	}
971	<	}
1625	>	for (ForkJoinWorkerThread w : workers)
1626	>	if (w != null)
1627	>	count += w.getQueueSize();
1628		return count;
1629		}
1630
1631		/**
1632	<	* Returns an estimate of the number tasks submitted to this pool
1633	<	* that have not yet begun executing. This method takes time
1632	>	* Returns an estimate of the number of tasks submitted to this
1633	>	* pool that have not yet begun executing.  This method takes time
1634		* proportional to the number of submissions.
1635		*
1636		* @return the number of queued submissions
#	Line 984 | Line 1640 | public class ForkJoinPool extends Abstra
1640		}
1641
1642		/**
1643	<	* Returns true if there are any tasks submitted to this pool
1644	<	* that have not yet begun executing.
1643	>	* Returns {@code true} if there are any tasks submitted to this
1644	>	* pool that have not yet begun executing.
1645		*
1646		* @return {@code true} if there are any queued submissions
1647		*/
#	Line 998 | Line 1654 | public class ForkJoinPool extends Abstra
1654		* available.  This method may be useful in extensions to this
1655		* class that re-assign work in systems with multiple pools.
1656		*
1657	<	* @return the next submission, or null if none
1657	>	* @return the next submission, or {@code null} if none
1658		*/
1659		protected ForkJoinTask<?> pollSubmission() {
1660		return submissionQueue.poll();
#	Line 1008 | Line 1664 | public class ForkJoinPool extends Abstra
1664		* Removes all available unexecuted submitted and forked tasks
1665		* from scheduling queues and adds them to the given collection,
1666		* without altering their execution status. These may include
1667	<	* artificially generated or wrapped tasks. This method is designed
1668	<	* to be invoked only when the pool is known to be
1667	>	* artificially generated or wrapped tasks. This method is
1668	>	* designed to be invoked only when the pool is known to be
1669		* quiescent. Invocations at other times may not remove all
1670		* tasks. A failure encountered while attempting to add elements
1671		* to collection {@code c} may result in elements being in
#	Line 1021 | Line 1677 | public class ForkJoinPool extends Abstra
1677		* @param c the collection to transfer elements into
1678		* @return the number of elements transferred
1679		*/
1680	<	protected int drainTasksTo(Collection<ForkJoinTask<?>> c) {
1681	<	int n = submissionQueue.drainTo(c);
1682	<	ForkJoinWorkerThread[] ws = workers;
1683	<	if (ws != null) {
1684	<	for (int i = 0; i < ws.length; ++i) {
1685	<	ForkJoinWorkerThread w = ws[i];
1030	<	if (w != null)
1031	<	n += w.drainTasksTo(c);
1032	<	}
1033	<	}
1034	<	return n;
1680	>	protected int drainTasksTo(Collection<? super ForkJoinTask<?>> c) {
1681	>	int count = submissionQueue.drainTo(c);
1682	>	for (ForkJoinWorkerThread w : workers)
1683	>	if (w != null)
1684	>	count += w.drainTasksTo(c);
1685	>	return count;
1686		}
1687
1688		/**
#	Line 1042 | Line 1693 | public class ForkJoinPool extends Abstra
1693		* @return a string identifying this pool, as well as its state
1694		*/
1695		public String toString() {
1045	–	int ps = parallelism;
1046	–	int wc = workerCounts;
1047	–	int rc = runControl;
1696		long st = getStealCount();
1697		long qt = getQueuedTaskCount();
1698		long qs = getQueuedSubmissionCount();
1699	+	int wc = workerCounts;
1700	+	int tc = wc >>> TOTAL_COUNT_SHIFT;
1701	+	int rc = wc & RUNNING_COUNT_MASK;
1702	+	int pc = parallelism;
1703	+	int rs = runState;
1704	+	int ac = rs & ACTIVE_COUNT_MASK;
1705		return super.toString() +
1706	<	"[" + runStateToString(runStateOf(rc)) +
1707	<	", parallelism = " + ps +
1708	<	", size = " + totalCountOf(wc) +
1709	<	", active = " + activeCountOf(rc) +
1710	<	", running = " + runningCountOf(wc) +
1706	>	"[" + runLevelToString(rs) +
1707	>	", parallelism = " + pc +
1708	>	", size = " + tc +
1709	>	", active = " + ac +
1710	>	", running = " + rc +
1711		", steals = " + st +
1712		", tasks = " + qt +
1713		", submissions = " + qs +
1714		"]";
1715		}
1716
1717	<	private static String runStateToString(int rs) {
1718	<	switch(rs) {
1719	<	case RUNNING: return "Running";
1720	<	case SHUTDOWN: return "Shutting down";
1721	<	case TERMINATING: return "Terminating";
1068	<	case TERMINATED: return "Terminated";
1069	<	default: throw new Error("Unknown run state");
1070	<	}
1717	>	private static String runLevelToString(int s) {
1718	>	return ((s & TERMINATED) != 0 ? "Terminated" :
1719	>	((s & TERMINATING) != 0 ? "Terminating" :
1720	>	((s & SHUTDOWN) != 0 ? "Shutting down" :
1721	>	"Running")));
1722		}
1723
1073	–	// lifecycle control
1074	–
1724		/**
1725		* Initiates an orderly shutdown in which previously submitted
1726		* tasks are executed, but no new tasks will be accepted.
#	Line 1086 | Line 1735 | public class ForkJoinPool extends Abstra
1735		*/
1736		public void shutdown() {
1737		checkPermission();
1738	<	transitionRunStateTo(SHUTDOWN);
1739	<	if (canTerminateOnShutdown(runControl))
1091	<	terminateOnShutdown();
1738	>	advanceRunLevel(SHUTDOWN);
1739	>	tryTerminate(false);
1740		}
1741
1742		/**
1743	<	* Attempts to stop all actively executing tasks, and cancels all
1744	<	* waiting tasks.  Tasks that are in the process of being
1745	<	* submitted or executed concurrently during the course of this
1746	<	* method may or may not be rejected. Unlike some other executors,
1747	<	* this method cancels rather than collects non-executed tasks
1748	<	* upon termination, so always returns an empty list. However, you
1749	<	* can use method {@code drainTasksTo} before invoking this
1750	<	* method to transfer unexecuted tasks to another collection.
1743	>	* Attempts to cancel and/or stop all tasks, and reject all
1744	>	* subsequently submitted tasks.  Tasks that are in the process of
1745	>	* being submitted or executed concurrently during the course of
1746	>	* this method may or may not be rejected. This method cancels
1747	>	* both existing and unexecuted tasks, in order to permit
1748	>	* termination in the presence of task dependencies. So the method
1749	>	* always returns an empty list (unlike the case for some other
1750	>	* Executors).
1751		*
1752		* @return an empty list
1753		* @throws SecurityException if a security manager exists and
#	Line 1109 | Line 1757 | public class ForkJoinPool extends Abstra
1757		*/
1758		public List<Runnable> shutdownNow() {
1759		checkPermission();
1760	<	terminate();
1760	>	tryTerminate(true);
1761		return Collections.emptyList();
1762		}
1763
#	Line 1119 | Line 1767 | public class ForkJoinPool extends Abstra
1767		* @return {@code true} if all tasks have completed following shut down
1768		*/
1769		public boolean isTerminated() {
1770	<	return runStateOf(runControl) == TERMINATED;
1770	>	return runState >= TERMINATED;
1771		}
1772
1773		/**
1774		* Returns {@code true} if the process of termination has
1775	<	* commenced but possibly not yet completed.
1775	>	* commenced but not yet completed.  This method may be useful for
1776	>	* debugging. A return of {@code true} reported a sufficient
1777	>	* period after shutdown may indicate that submitted tasks have
1778	>	* ignored or suppressed interruption, causing this executor not
1779	>	* to properly terminate.
1780		*
1781	<	* @return {@code true} if terminating
1781	>	* @return {@code true} if terminating but not yet terminated
1782		*/
1783		public boolean isTerminating() {
1784	<	return runStateOf(runControl) >= TERMINATING;
1784	>	return (runState & (TERMINATING|TERMINATED)) == TERMINATING;
1785	>	}
1786	>
1787	>	/**
1788	>	* Returns true if terminating or terminated. Used by ForkJoinWorkerThread.
1789	>	*/
1790	>	final boolean isAtLeastTerminating() {
1791	>	return runState >= TERMINATING;
1792		}
1793
1794		/**
#	Line 1138 | Line 1797 | public class ForkJoinPool extends Abstra
1797		* @return {@code true} if this pool has been shut down
1798		*/
1799		public boolean isShutdown() {
1800	<	return runStateOf(runControl) >= SHUTDOWN;
1800	>	return runState >= SHUTDOWN;
1801		}
1802
1803		/**
#	Line 1154 | Line 1813 | public class ForkJoinPool extends Abstra
1813		*/
1814		public boolean awaitTermination(long timeout, TimeUnit unit)
1815		throws InterruptedException {
1157	–	long nanos = unit.toNanos(timeout);
1158	–	final ReentrantLock lock = this.workerLock;
1159	–	lock.lock();
1816		try {
1817	<	for (;;) {
1818	<	if (isTerminated())
1163	<	return true;
1164	<	if (nanos <= 0)
1165	<	return false;
1166	<	nanos = termination.awaitNanos(nanos);
1167	<	}
1168	<	} finally {
1169	<	lock.unlock();
1170	<	}
1171	<	}
1172	<
1173	<	// Shutdown and termination support
1174	<
1175	<	/**
1176	<	* Callback from terminating worker. Nulls out the corresponding
1177	<	* workers slot, and if terminating, tries to terminate; else
1178	<	* tries to shrink workers array.
1179	<	*
1180	<	* @param w the worker
1181	<	*/
1182	<	final void workerTerminated(ForkJoinWorkerThread w) {
1183	<	updateStealCount(w);
1184	<	updateWorkerCount(-1);
1185	<	final ReentrantLock lock = this.workerLock;
1186	<	lock.lock();
1187	<	try {
1188	<	ForkJoinWorkerThread[] ws = workers;
1189	<	if (ws != null) {
1190	<	int idx = w.poolIndex;
1191	<	if (idx >= 0 && idx < ws.length && ws[idx] == w)
1192	<	ws[idx] = null;
1193	<	if (totalCountOf(workerCounts) == 0) {
1194	<	terminate(); // no-op if already terminating
1195	<	transitionRunStateTo(TERMINATED);
1196	<	termination.signalAll();
1197	<	}
1198	<	else if (!isTerminating()) {
1199	<	tryShrinkWorkerArray();
1200	<	tryResumeSpare(true); // allow replacement
1201	<	}
1202	<	}
1203	<	} finally {
1204	<	lock.unlock();
1205	<	}
1206	<	signalIdleWorkers();
1207	<	}
1208	<
1209	<	/**
1210	<	* Initiates termination.
1211	<	*/
1212	<	private void terminate() {
1213	<	if (transitionRunStateTo(TERMINATING)) {
1214	<	stopAllWorkers();
1215	<	resumeAllSpares();
1216	<	signalIdleWorkers();
1217	<	cancelQueuedSubmissions();
1218	<	cancelQueuedWorkerTasks();
1219	<	interruptUnterminatedWorkers();
1220	<	signalIdleWorkers(); // resignal after interrupt
1221	<	}
1222	<	}
1223	<
1224	<	/**
1225	<	* Possibly terminates when on shutdown state.
1226	<	*/
1227	<	private void terminateOnShutdown() {
1228	<	if (!hasQueuedSubmissions() && canTerminateOnShutdown(runControl))
1229	<	terminate();
1230	<	}
1231	<
1232	<	/**
1233	<	* Clears out and cancels submissions.
1234	<	*/
1235	<	private void cancelQueuedSubmissions() {
1236	<	ForkJoinTask<?> task;
1237	<	while ((task = pollSubmission()) != null)
1238	<	task.cancel(false);
1239	<	}
1240	<
1241	<	/**
1242	<	* Cleans out worker queues.
1243	<	*/
1244	<	private void cancelQueuedWorkerTasks() {
1245	<	final ReentrantLock lock = this.workerLock;
1246	<	lock.lock();
1247	<	try {
1248	<	ForkJoinWorkerThread[] ws = workers;
1249	<	if (ws != null) {
1250	<	for (int i = 0; i < ws.length; ++i) {
1251	<	ForkJoinWorkerThread t = ws[i];
1252	<	if (t != null)
1253	<	t.cancelTasks();
1254	<	}
1255	<	}
1256	<	} finally {
1257	<	lock.unlock();
1258	<	}
1259	<	}
1260	<
1261	<	/**
1262	<	* Sets each worker's status to terminating. Requires lock to avoid
1263	<	* conflicts with add/remove.
1264	<	*/
1265	<	private void stopAllWorkers() {
1266	<	final ReentrantLock lock = this.workerLock;
1267	<	lock.lock();
1268	<	try {
1269	<	ForkJoinWorkerThread[] ws = workers;
1270	<	if (ws != null) {
1271	<	for (int i = 0; i < ws.length; ++i) {
1272	<	ForkJoinWorkerThread t = ws[i];
1273	<	if (t != null)
1274	<	t.shutdownNow();
1275	<	}
1276	<	}
1277	<	} finally {
1278	<	lock.unlock();
1279	<	}
1280	<	}
1281	<
1282	<	/**
1283	<	* Interrupts all unterminated workers.  This is not required for
1284	<	* sake of internal control, but may help unstick user code during
1285	<	* shutdown.
1286	<	*/
1287	<	private void interruptUnterminatedWorkers() {
1288	<	final ReentrantLock lock = this.workerLock;
1289	<	lock.lock();
1290	<	try {
1291	<	ForkJoinWorkerThread[] ws = workers;
1292	<	if (ws != null) {
1293	<	for (int i = 0; i < ws.length; ++i) {
1294	<	ForkJoinWorkerThread t = ws[i];
1295	<	if (t != null && !t.isTerminated()) {
1296	<	try {
1297	<	t.interrupt();
1298	<	} catch (SecurityException ignore) {
1299	<	}
1300	<	}
1301	<	}
1302	<	}
1303	<	} finally {
1304	<	lock.unlock();
1305	<	}
1306	<	}
1307	<
1308	<
1309	<	/*
1310	<	* Nodes for event barrier to manage idle threads.  Queue nodes
1311	<	* are basic Treiber stack nodes, also used for spare stack.
1312	<	*
1313	<	* The event barrier has an event count and a wait queue (actually
1314	<	* a Treiber stack).  Workers are enabled to look for work when
1315	<	* the eventCount is incremented. If they fail to find work, they
1316	<	* may wait for next count. Upon release, threads help others wake
1317	<	* up.
1318	<	*
1319	<	* Synchronization events occur only in enough contexts to
1320	<	* maintain overall liveness:
1321	<	*
1322	<	*   - Submission of a new task to the pool
1323	<	*   - Resizes or other changes to the workers array
1324	<	*   - pool termination
1325	<	*   - A worker pushing a task on an empty queue
1326	<	*
1327	<	* The case of pushing a task occurs often enough, and is heavy
1328	<	* enough compared to simple stack pushes, to require special
1329	<	* handling: Method signalWork returns without advancing count if
1330	<	* the queue appears to be empty.  This would ordinarily result in
1331	<	* races causing some queued waiters not to be woken up. To avoid
1332	<	* this, the first worker enqueued in method sync (see
1333	<	* syncIsReleasable) rescans for tasks after being enqueued, and
1334	<	* helps signal if any are found. This works well because the
1335	<	* worker has nothing better to do, and so might as well help
1336	<	* alleviate the overhead and contention on the threads actually
1337	<	* doing work.  Also, since event counts increments on task
1338	<	* availability exist to maintain liveness (rather than to force
1339	<	* refreshes etc), it is OK for callers to exit early if
1340	<	* contending with another signaller.
1341	<	*/
1342	<	static final class WaitQueueNode {
1343	<	WaitQueueNode next; // only written before enqueued
1344	<	volatile ForkJoinWorkerThread thread; // nulled to cancel wait
1345	<	final long count; // unused for spare stack
1346	<
1347	<	WaitQueueNode(long c, ForkJoinWorkerThread w) {
1348	<	count = c;
1349	<	thread = w;
1350	<	}
1351	<
1352	<	/**
1353	<	* Wakes up waiter, returning false if known to already
1354	<	*/
1355	<	boolean signal() {
1356	<	ForkJoinWorkerThread t = thread;
1357	<	if (t == null)
1358	<	return false;
1359	<	thread = null;
1360	<	LockSupport.unpark(t);
1361	<	return true;
1362	<	}
1363	<
1364	<	/**
1365	<	* Awaits release on sync.
1366	<	*/
1367	<	void awaitSyncRelease(ForkJoinPool p) {
1368	<	while (thread != null && !p.syncIsReleasable(this))
1369	<	LockSupport.park(this);
1370	<	}
1371	<
1372	<	/**
1373	<	* Awaits resumption as spare.
1374	<	*/
1375	<	void awaitSpareRelease() {
1376	<	while (thread != null) {
1377	<	if (!Thread.interrupted())
1378	<	LockSupport.park(this);
1379	<	}
1380	<	}
1381	<	}
1382	<
1383	<	/**
1384	<	* Ensures that no thread is waiting for count to advance from the
1385	<	* current value of eventCount read on entry to this method, by
1386	<	* releasing waiting threads if necessary.
1387	<	*
1388	<	* @return the count
1389	<	*/
1390	<	final long ensureSync() {
1391	<	long c = eventCount;
1392	<	WaitQueueNode q;
1393	<	while ((q = syncStack) != null && q.count < c) {
1394	<	if (casBarrierStack(q, null)) {
1395	<	do {
1396	<	q.signal();
1397	<	} while ((q = q.next) != null);
1398	<	break;
1399	<	}
1400	<	}
1401	<	return c;
1402	<	}
1403	<
1404	<	/**
1405	<	* Increments event count and releases waiting threads.
1406	<	*/
1407	<	private void signalIdleWorkers() {
1408	<	long c;
1409	<	do {} while (!casEventCount(c = eventCount, c+1));
1410	<	ensureSync();
1411	<	}
1412	<
1413	<	/**
1414	<	* Signals threads waiting to poll a task. Because method sync
1415	<	* rechecks availability, it is OK to only proceed if queue
1416	<	* appears to be non-empty, and OK to skip under contention to
1417	<	* increment count (since some other thread succeeded).
1418	<	*/
1419	<	final void signalWork() {
1420	<	long c;
1421	<	WaitQueueNode q;
1422	<	if (syncStack != null &&
1423	<	casEventCount(c = eventCount, c+1) &&
1424	<	(((q = syncStack) != null && q.count <= c) &&
1425	<	(!casBarrierStack(q, q.next) || !q.signal())))
1426	<	ensureSync();
1427	<	}
1428	<
1429	<	/**
1430	<	* Waits until event count advances from last value held by
1431	<	* caller, or if excess threads, caller is resumed as spare, or
1432	<	* caller or pool is terminating. Updates caller's event on exit.
1433	<	*
1434	<	* @param w the calling worker thread
1435	<	*/
1436	<	final void sync(ForkJoinWorkerThread w) {
1437	<	updateStealCount(w); // Transfer w's count while it is idle
1438	<
1439	<	while (!w.isShutdown() && !isTerminating() && !suspendIfSpare(w)) {
1440	<	long prev = w.lastEventCount;
1441	<	WaitQueueNode node = null;
1442	<	WaitQueueNode h;
1443	<	while (eventCount == prev &&
1444	<	((h = syncStack) == null || h.count == prev)) {
1445	<	if (node == null)
1446	<	node = new WaitQueueNode(prev, w);
1447	<	if (casBarrierStack(node.next = h, node)) {
1448	<	node.awaitSyncRelease(this);
1449	<	break;
1450	<	}
1451	<	}
1452	<	long ec = ensureSync();
1453	<	if (ec != prev) {
1454	<	w.lastEventCount = ec;
1455	<	break;
1456	<	}
1457	<	}
1458	<	}
1459	<
1460	<	/**
1461	<	* Returns true if worker waiting on sync can proceed:
1462	<	*  - on signal (thread == null)
1463	<	*  - on event count advance (winning race to notify vs signaller)
1464	<	*  - on interrupt
1465	<	*  - if the first queued node, we find work available
1466	<	* If node was not signalled and event count not advanced on exit,
1467	<	* then we also help advance event count.
1468	<	*
1469	<	* @return true if node can be released
1470	<	*/
1471	<	final boolean syncIsReleasable(WaitQueueNode node) {
1472	<	long prev = node.count;
1473	<	if (!Thread.interrupted() && node.thread != null &&
1474	<	(node.next != null ||
1475	<	!ForkJoinWorkerThread.hasQueuedTasks(workers)) &&
1476	<	eventCount == prev)
1817	>	termination.awaitAdvanceInterruptibly(0, timeout, unit);
1818	>	} catch (TimeoutException ex) {
1819		return false;
1478	–	if (node.thread != null) {
1479	–	node.thread = null;
1480	–	long ec = eventCount;
1481	–	if (prev <= ec) // help signal
1482	–	casEventCount(ec, ec+1);
1820		}
1821		return true;
1822		}
1823
1824		/**
1488	–	* Returns true if a new sync event occurred since last call to
1489	–	* sync or this method, if so, updating caller's count.
1490	–	*/
1491	–	final boolean hasNewSyncEvent(ForkJoinWorkerThread w) {
1492	–	long lc = w.lastEventCount;
1493	–	long ec = ensureSync();
1494	–	if (ec == lc)
1495	–	return false;
1496	–	w.lastEventCount = ec;
1497	–	return true;
1498	–	}
1499	–
1500	–	//  Parallelism maintenance
1501	–
1502	–	/**
1503	–	* Decrements running count; if too low, adds spare.
1504	–	*
1505	–	* Conceptually, all we need to do here is add or resume a
1506	–	* spare thread when one is about to block (and remove or
1507	–	* suspend it later when unblocked -- see suspendIfSpare).
1508	–	* However, implementing this idea requires coping with
1509	–	* several problems: we have imperfect information about the
1510	–	* states of threads. Some count updates can and usually do
1511	–	* lag run state changes, despite arrangements to keep them
1512	–	* accurate (for example, when possible, updating counts
1513	–	* before signalling or resuming), especially when running on
1514	–	* dynamic JVMs that don't optimize the infrequent paths that
1515	–	* update counts. Generating too many threads can make these
1516	–	* problems become worse, because excess threads are more
1517	–	* likely to be context-switched with others, slowing them all
1518	–	* down, especially if there is no work available, so all are
1519	–	* busy scanning or idling.  Also, excess spare threads can
1520	–	* only be suspended or removed when they are idle, not
1521	–	* immediately when they aren't needed. So adding threads will
1522	–	* raise parallelism level for longer than necessary.  Also,
1523	–	* FJ applications often encounter highly transient peaks when
1524	–	* many threads are blocked joining, but for less time than it
1525	–	* takes to create or resume spares.
1526	–	*
1527	–	* @param joinMe if non-null, return early if done
1528	–	* @param maintainParallelism if true, try to stay within
1529	–	* target counts, else create only to avoid starvation
1530	–	* @return true if joinMe known to be done
1531	–	*/
1532	–	final boolean preJoin(ForkJoinTask<?> joinMe,
1533	–	boolean maintainParallelism) {
1534	–	maintainParallelism &= maintainsParallelism; // overrride
1535	–	boolean dec = false;  // true when running count decremented
1536	–	while (spareStack == null || !tryResumeSpare(dec)) {
1537	–	int counts = workerCounts;
1538	–	if (dec || (dec = casWorkerCounts(counts, --counts))) {
1539	–	// CAS cheat
1540	–	if (!needSpare(counts, maintainParallelism))
1541	–	break;
1542	–	if (joinMe.status < 0)
1543	–	return true;
1544	–	if (tryAddSpare(counts))
1545	–	break;
1546	–	}
1547	–	}
1548	–	return false;
1549	–	}
1550	–
1551	–	/**
1552	–	* Same idea as preJoin
1553	–	*/
1554	–	final boolean preBlock(ManagedBlocker blocker,
1555	–	boolean maintainParallelism) {
1556	–	maintainParallelism &= maintainsParallelism;
1557	–	boolean dec = false;
1558	–	while (spareStack == null || !tryResumeSpare(dec)) {
1559	–	int counts = workerCounts;
1560	–	if (dec || (dec = casWorkerCounts(counts, --counts))) {
1561	–	if (!needSpare(counts, maintainParallelism))
1562	–	break;
1563	–	if (blocker.isReleasable())
1564	–	return true;
1565	–	if (tryAddSpare(counts))
1566	–	break;
1567	–	}
1568	–	}
1569	–	return false;
1570	–	}
1571	–
1572	–	/**
1573	–	* Returns true if a spare thread appears to be needed.  If
1574	–	* maintaining parallelism, returns true when the deficit in
1575	–	* running threads is more than the surplus of total threads, and
1576	–	* there is apparently some work to do.  This self-limiting rule
1577	–	* means that the more threads that have already been added, the
1578	–	* less parallelism we will tolerate before adding another.
1579	–	*
1580	–	* @param counts current worker counts
1581	–	* @param maintainParallelism try to maintain parallelism
1582	–	*/
1583	–	private boolean needSpare(int counts, boolean maintainParallelism) {
1584	–	int ps = parallelism;
1585	–	int rc = runningCountOf(counts);
1586	–	int tc = totalCountOf(counts);
1587	–	int runningDeficit = ps - rc;
1588	–	int totalSurplus = tc - ps;
1589	–	return (tc < maxPoolSize &&
1590	–	(rc == 0 || totalSurplus < 0 ||
1591	–	(maintainParallelism &&
1592	–	runningDeficit > totalSurplus &&
1593	–	ForkJoinWorkerThread.hasQueuedTasks(workers))));
1594	–	}
1595	–
1596	–	/**
1597	–	* Adds a spare worker if lock available and no more than the
1598	–	* expected numbers of threads exist.
1599	–	*
1600	–	* @return true if successful
1601	–	*/
1602	–	private boolean tryAddSpare(int expectedCounts) {
1603	–	final ReentrantLock lock = this.workerLock;
1604	–	int expectedRunning = runningCountOf(expectedCounts);
1605	–	int expectedTotal = totalCountOf(expectedCounts);
1606	–	boolean success = false;
1607	–	boolean locked = false;
1608	–	// confirm counts while locking; CAS after obtaining lock
1609	–	try {
1610	–	for (;;) {
1611	–	int s = workerCounts;
1612	–	int tc = totalCountOf(s);
1613	–	int rc = runningCountOf(s);
1614	–	if (rc > expectedRunning || tc > expectedTotal)
1615	–	break;
1616	–	if (!locked && !(locked = lock.tryLock()))
1617	–	break;
1618	–	if (casWorkerCounts(s, workerCountsFor(tc+1, rc+1))) {
1619	–	createAndStartSpare(tc);
1620	–	success = true;
1621	–	break;
1622	–	}
1623	–	}
1624	–	} finally {
1625	–	if (locked)
1626	–	lock.unlock();
1627	–	}
1628	–	return success;
1629	–	}
1630	–
1631	–	/**
1632	–	* Adds the kth spare worker. On entry, pool counts are already
1633	–	* adjusted to reflect addition.
1634	–	*/
1635	–	private void createAndStartSpare(int k) {
1636	–	ForkJoinWorkerThread w = null;
1637	–	ForkJoinWorkerThread[] ws = ensureWorkerArrayCapacity(k + 1);
1638	–	int len = ws.length;
1639	–	// Probably, we can place at slot k. If not, find empty slot
1640	–	if (k < len && ws[k] != null) {
1641	–	for (k = 0; k < len && ws[k] != null; ++k)
1642	–	;
1643	–	}
1644	–	if (k < len && !isTerminating() && (w = createWorker(k)) != null) {
1645	–	ws[k] = w;
1646	–	w.start();
1647	–	}
1648	–	else
1649	–	updateWorkerCount(-1); // adjust on failure
1650	–	signalIdleWorkers();
1651	–	}
1652	–
1653	–	/**
1654	–	* Suspends calling thread w if there are excess threads.  Called
1655	–	* only from sync.  Spares are enqueued in a Treiber stack using
1656	–	* the same WaitQueueNodes as barriers.  They are resumed mainly
1657	–	* in preJoin, but are also woken on pool events that require all
1658	–	* threads to check run state.
1659	–	*
1660	–	* @param w the caller
1661	–	*/
1662	–	private boolean suspendIfSpare(ForkJoinWorkerThread w) {
1663	–	WaitQueueNode node = null;
1664	–	int s;
1665	–	while (parallelism < runningCountOf(s = workerCounts)) {
1666	–	if (node == null)
1667	–	node = new WaitQueueNode(0, w);
1668	–	if (casWorkerCounts(s, s-1)) { // representation-dependent
1669	–	// push onto stack
1670	–	do {} while (!casSpareStack(node.next = spareStack, node));
1671	–	// block until released by resumeSpare
1672	–	node.awaitSpareRelease();
1673	–	return true;
1674	–	}
1675	–	}
1676	–	return false;
1677	–	}
1678	–
1679	–	/**
1680	–	* Tries to pop and resume a spare thread.
1681	–	*
1682	–	* @param updateCount if true, increment running count on success
1683	–	* @return true if successful
1684	–	*/
1685	–	private boolean tryResumeSpare(boolean updateCount) {
1686	–	WaitQueueNode q;
1687	–	while ((q = spareStack) != null) {
1688	–	if (casSpareStack(q, q.next)) {
1689	–	if (updateCount)
1690	–	updateRunningCount(1);
1691	–	q.signal();
1692	–	return true;
1693	–	}
1694	–	}
1695	–	return false;
1696	–	}
1697	–
1698	–	/**
1699	–	* Pops and resumes all spare threads. Same idea as ensureSync.
1700	–	*
1701	–	* @return true if any spares released
1702	–	*/
1703	–	private boolean resumeAllSpares() {
1704	–	WaitQueueNode q;
1705	–	while ( (q = spareStack) != null) {
1706	–	if (casSpareStack(q, null)) {
1707	–	do {
1708	–	updateRunningCount(1);
1709	–	q.signal();
1710	–	} while ((q = q.next) != null);
1711	–	return true;
1712	–	}
1713	–	}
1714	–	return false;
1715	–	}
1716	–
1717	–	/**
1718	–	* Pops and shuts down excessive spare threads. Call only while
1719	–	* holding lock. This is not guaranteed to eliminate all excess
1720	–	* threads, only those suspended as spares, which are the ones
1721	–	* unlikely to be needed in the future.
1722	–	*/
1723	–	private void trimSpares() {
1724	–	int surplus = totalCountOf(workerCounts) - parallelism;
1725	–	WaitQueueNode q;
1726	–	while (surplus > 0 && (q = spareStack) != null) {
1727	–	if (casSpareStack(q, null)) {
1728	–	do {
1729	–	updateRunningCount(1);
1730	–	ForkJoinWorkerThread w = q.thread;
1731	–	if (w != null && surplus > 0 &&
1732	–	runningCountOf(workerCounts) > 0 && w.shutdown())
1733	–	--surplus;
1734	–	q.signal();
1735	–	} while ((q = q.next) != null);
1736	–	}
1737	–	}
1738	–	}
1739	–
1740	–	/**
1825		* Interface for extending managed parallelism for tasks running
1826	<	* in ForkJoinPools. A ManagedBlocker provides two methods.
1827	<	* Method {@code isReleasable} must return true if blocking is not
1828	<	* necessary. Method {@code block} blocks the current thread if
1829	<	* necessary (perhaps internally invoking {@code isReleasable}
1830	<	* before actually blocking.).
1826	>	* in {@link ForkJoinPool}s.
1827	>	*
1828	>	* <p>A {@code ManagedBlocker} provides two methods.  Method
1829	>	* {@code isReleasable} must return {@code true} if blocking is
1830	>	* not necessary. Method {@code block} blocks the current thread
1831	>	* if necessary (perhaps internally invoking {@code isReleasable}
1832	>	* before actually blocking). The unusual methods in this API
1833	>	* accommodate synchronizers that may, but don't usually, block
1834	>	* for long periods. Similarly, they allow more efficient internal
1835	>	* handling of cases in which additional workers may be, but
1836	>	* usually are not, needed to ensure sufficient parallelism.
1837	>	* Toward this end, implementations of method {@code isReleasable}
1838	>	* must be amenable to repeated invocation.
1839		*
1840		* <p>For example, here is a ManagedBlocker based on a
1841		* ReentrantLock:
#	Line 1761 | Line 1853 | public class ForkJoinPool extends Abstra
1853		*     return hasLock || (hasLock = lock.tryLock());
1854		*   }
1855		* }}</pre>
1856	+	*
1857	+	* <p>Here is a class that possibly blocks waiting for an
1858	+	* item on a given queue:
1859	+	*  <pre> {@code
1860	+	* class QueueTaker<E> implements ManagedBlocker {
1861	+	*   final BlockingQueue<E> queue;
1862	+	*   volatile E item = null;
1863	+	*   QueueTaker(BlockingQueue<E> q) { this.queue = q; }
1864	+	*   public boolean block() throws InterruptedException {
1865	+	*     if (item == null)
1866	+	*       item = queue.take();
1867	+	*     return true;
1868	+	*   }
1869	+	*   public boolean isReleasable() {
1870	+	*     return item != null || (item = queue.poll()) != null;
1871	+	*   }
1872	+	*   public E getItem() { // call after pool.managedBlock completes
1873	+	*     return item;
1874	+	*   }
1875	+	* }}</pre>
1876		*/
1877		public static interface ManagedBlocker {
1878		/**
1879		* Possibly blocks the current thread, for example waiting for
1880		* a lock or condition.
1881		*
1882	<	* @return true if no additional blocking is necessary (i.e.,
1883	<	* if isReleasable would return true)
1882	>	* @return {@code true} if no additional blocking is necessary
1883	>	* (i.e., if isReleasable would return true)
1884		* @throws InterruptedException if interrupted while waiting
1885		* (the method is not required to do so, but is allowed to)
1886		*/
1887		boolean block() throws InterruptedException;
1888
1889		/**
1890	<	* Returns true if blocking is unnecessary.
1890	>	* Returns {@code true} if blocking is unnecessary.
1891		*/
1892		boolean isReleasable();
1893		}
1894
1895		/**
1896		* Blocks in accord with the given blocker.  If the current thread
1897	<	* is a ForkJoinWorkerThread, this method possibly arranges for a
1898	<	* spare thread to be activated if necessary to ensure parallelism
1899	<	* while the current thread is blocked.  If
1788	<	* {@code maintainParallelism} is true and the pool supports
1789	<	* it ({@link #getMaintainsParallelism}), this method attempts to
1790	<	* maintain the pool's nominal parallelism. Otherwise it activates
1791	<	* a thread only if necessary to avoid complete starvation. This
1792	<	* option may be preferable when blockages use timeouts, or are
1793	<	* almost always brief.
1897	>	* is a {@link ForkJoinWorkerThread}, this method possibly
1898	>	* arranges for a spare thread to be activated if necessary to
1899	>	* ensure sufficient parallelism while the current thread is blocked.
1900		*
1901	<	* <p> If the caller is not a ForkJoinTask, this method is behaviorally
1902	<	* equivalent to
1901	>	* <p>If the caller is not a {@link ForkJoinTask}, this method is
1902	>	* behaviorally equivalent to
1903		*  <pre> {@code
1904		* while (!blocker.isReleasable())
1905		*   if (blocker.block())
1906		*     return;
1907		* }</pre>
1908	<	* If the caller is a ForkJoinTask, then the pool may first
1909	<	* be expanded to ensure parallelism, and later adjusted.
1908	>	*
1909	>	* If the caller is a {@code ForkJoinTask}, then the pool may
1910	>	* first be expanded to ensure parallelism, and later adjusted.
1911		*
1912		* @param blocker the blocker
1806	–	* @param maintainParallelism if true and supported by this pool,
1807	–	* attempt to maintain the pool's nominal parallelism; otherwise
1808	–	* activate a thread only if necessary to avoid complete
1809	–	* starvation.
1913		* @throws InterruptedException if blocker.block did so
1914		*/
1915	<	public static void managedBlock(ManagedBlocker blocker,
1813	<	boolean maintainParallelism)
1915	>	public static void managedBlock(ManagedBlocker blocker)
1916		throws InterruptedException {
1917		Thread t = Thread.currentThread();
1918	<	ForkJoinPool pool = ((t instanceof ForkJoinWorkerThread) ?
1919	<	((ForkJoinWorkerThread) t).pool : null);
1920	<	if (!blocker.isReleasable()) {
1921	<	try {
1922	<	if (pool == null ||
1923	<	!pool.preBlock(blocker, maintainParallelism))
1822	<	awaitBlocker(blocker);
1823	<	} finally {
1824	<	if (pool != null)
1825	<	pool.updateRunningCount(1);
1826	<	}
1918	>	if (t instanceof ForkJoinWorkerThread) {
1919	>	ForkJoinWorkerThread w = (ForkJoinWorkerThread) t;
1920	>	w.pool.awaitBlocker(blocker);
1921	>	}
1922	>	else {
1923	>	do {} while (!blocker.isReleasable() && !blocker.block());
1924		}
1925		}
1926
1927	<	private static void awaitBlocker(ManagedBlocker blocker)
1928	<	throws InterruptedException {
1929	<	do {} while (!blocker.isReleasable() && !blocker.block());
1833	<	}
1834	<
1835	<	// AbstractExecutorService overrides
1927	>	// AbstractExecutorService overrides.  These rely on undocumented
1928	>	// fact that ForkJoinTask.adapt returns ForkJoinTasks that also
1929	>	// implement RunnableFuture.
1930
1931		protected <T> RunnableFuture<T> newTaskFor(Runnable runnable, T value) {
1932	<	return new AdaptedRunnable<T>(runnable, value);
1932	>	return (RunnableFuture<T>) ForkJoinTask.adapt(runnable, value);
1933		}
1934
1935		protected <T> RunnableFuture<T> newTaskFor(Callable<T> callable) {
1936	<	return new AdaptedCallable<T>(callable);
1936	>	return (RunnableFuture<T>) ForkJoinTask.adapt(callable);
1937		}
1938
1939	+	// Unsafe mechanics
1940	+
1941	+	private static final sun.misc.Unsafe UNSAFE = getUnsafe();
1942	+	private static final long workerCountsOffset =
1943	+	objectFieldOffset("workerCounts", ForkJoinPool.class);
1944	+	private static final long runStateOffset =
1945	+	objectFieldOffset("runState", ForkJoinPool.class);
1946	+	private static final long eventCountOffset =
1947	+	objectFieldOffset("eventCount", ForkJoinPool.class);
1948	+	private static final long eventWaitersOffset =
1949	+	objectFieldOffset("eventWaiters", ForkJoinPool.class);
1950	+	private static final long stealCountOffset =
1951	+	objectFieldOffset("stealCount", ForkJoinPool.class);
1952	+	private static final long spareWaitersOffset =
1953	+	objectFieldOffset("spareWaiters", ForkJoinPool.class);
1954	+
1955	+	private static long objectFieldOffset(String field, Class<?> klazz) {
1956	+	try {
1957	+	return UNSAFE.objectFieldOffset(klazz.getDeclaredField(field));
1958	+	} catch (NoSuchFieldException e) {
1959	+	// Convert Exception to corresponding Error
1960	+	NoSuchFieldError error = new NoSuchFieldError(field);
1961	+	error.initCause(e);
1962	+	throw error;
1963	+	}
1964	+	}
1965
1966	<	// Unsafe mechanics for jsr166y 3rd party package.
1966	>	/**
1967	>	* Returns a sun.misc.Unsafe.  Suitable for use in a 3rd party package.
1968	>	* Replace with a simple call to Unsafe.getUnsafe when integrating
1969	>	* into a jdk.
1970	>	*
1971	>	* @return a sun.misc.Unsafe
1972	>	*/
1973		private static sun.misc.Unsafe getUnsafe() {
1974		try {
1975		return sun.misc.Unsafe.getUnsafe();
1976		} catch (SecurityException se) {
1977		try {
1978		return java.security.AccessController.doPrivileged
1979	<	(new java.security.PrivilegedExceptionAction<sun.misc.Unsafe>() {
1979	>	(new java.security
1980	>	.PrivilegedExceptionAction<sun.misc.Unsafe>() {
1981		public sun.misc.Unsafe run() throws Exception {
1982	<	return getUnsafeByReflection();
1982	>	java.lang.reflect.Field f = sun.misc
1983	>	.Unsafe.class.getDeclaredField("theUnsafe");
1984	>	f.setAccessible(true);
1985	>	return (sun.misc.Unsafe) f.get(null);
1986		}});
1987		} catch (java.security.PrivilegedActionException e) {
1988		throw new RuntimeException("Could not initialize intrinsics",
#	Line 1860 | Line 1990 | public class ForkJoinPool extends Abstra
1990		}
1991		}
1992		}
1863	–
1864	–	private static sun.misc.Unsafe getUnsafeByReflection()
1865	–	throws NoSuchFieldException, IllegalAccessException {
1866	–	java.lang.reflect.Field f =
1867	–	sun.misc.Unsafe.class.getDeclaredField("theUnsafe");
1868	–	f.setAccessible(true);
1869	–	return (sun.misc.Unsafe) f.get(null);
1870	–	}
1871	–
1872	–	private static long fieldOffset(String fieldName, Class<?> klazz) {
1873	–	try {
1874	–	return UNSAFE.objectFieldOffset(klazz.getDeclaredField(fieldName));
1875	–	} catch (NoSuchFieldException e) {
1876	–	// Convert Exception to Error
1877	–	NoSuchFieldError error = new NoSuchFieldError(fieldName);
1878	–	error.initCause(e);
1879	–	throw error;
1880	–	}
1881	–	}
1882	–
1883	–	private static final sun.misc.Unsafe UNSAFE = getUnsafe();
1884	–	static final long eventCountOffset =
1885	–	fieldOffset("eventCount", ForkJoinPool.class);
1886	–	static final long workerCountsOffset =
1887	–	fieldOffset("workerCounts", ForkJoinPool.class);
1888	–	static final long runControlOffset =
1889	–	fieldOffset("runControl", ForkJoinPool.class);
1890	–	static final long syncStackOffset =
1891	–	fieldOffset("syncStack",ForkJoinPool.class);
1892	–	static final long spareStackOffset =
1893	–	fieldOffset("spareStack", ForkJoinPool.class);
1894	–
1895	–	private boolean casEventCount(long cmp, long val) {
1896	–	return UNSAFE.compareAndSwapLong(this, eventCountOffset, cmp, val);
1897	–	}
1898	–	private boolean casWorkerCounts(int cmp, int val) {
1899	–	return UNSAFE.compareAndSwapInt(this, workerCountsOffset, cmp, val);
1900	–	}
1901	–	private boolean casRunControl(int cmp, int val) {
1902	–	return UNSAFE.compareAndSwapInt(this, runControlOffset, cmp, val);
1903	–	}
1904	–	private boolean casSpareStack(WaitQueueNode cmp, WaitQueueNode val) {
1905	–	return UNSAFE.compareAndSwapObject(this, spareStackOffset, cmp, val);
1906	–	}
1907	–	private boolean casBarrierStack(WaitQueueNode cmp, WaitQueueNode val) {
1908	–	return UNSAFE.compareAndSwapObject(this, syncStackOffset, cmp, val);
1909	–	}
1993		}

Diff Legend

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