ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/main/java/util/concurrent/ForkJoinPool.java
Revision: 1.66
Committed: Wed Jun 8 01:02:56 2011 UTC (12 years, 11 months ago) by jsr166
Branch: MAIN
Changes since 1.65: +3 -3 lines
Log Message:
Add some periods.

File Contents

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