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

Comparing jsr166/src/jsr166y/ForkJoinPool.java (file contents):
Revision 1.1 by dl, Tue Jan 6 14:30:31 2009 UTC vs.
Revision 1.33 by dl, Fri Jul 31 16:27:08 2009 UTC

# Line 5 | Line 5
5   */
6  
7   package jsr166y;
8 < import java.util.*;
8 >
9   import java.util.concurrent.*;
10 < import java.util.concurrent.locks.*;
11 < import java.util.concurrent.atomic.*;
12 < import sun.misc.Unsafe;
13 < import java.lang.reflect.*;
10 >
11 > import java.util.ArrayList;
12 > import java.util.Arrays;
13 > import java.util.Collection;
14 > import java.util.Collections;
15 > import java.util.List;
16 > import java.util.concurrent.locks.Condition;
17 > import java.util.concurrent.locks.LockSupport;
18 > import java.util.concurrent.locks.ReentrantLock;
19 > import java.util.concurrent.atomic.AtomicInteger;
20 > import java.util.concurrent.atomic.AtomicLong;
21  
22   /**
23 < * Host for a group of ForkJoinWorkerThreads.  A ForkJoinPool provides
24 < * the entry point for tasks submitted from non-ForkJoinTasks, as well
25 < * as management and monitoring operations.  Normally a single
26 < * ForkJoinPool is used for a large number of submitted
27 < * tasks. Otherwise, use would not usually outweigh the construction
28 < * and bookkeeping overhead of creating a large set of threads.
23 > * An {@link ExecutorService} for running {@link ForkJoinTask}s.
24 > * A ForkJoinPool provides the entry point for submissions from
25 > * non-ForkJoinTasks, as well as management and monitoring operations.
26 > * Normally a single ForkJoinPool is used for a large number of
27 > * submitted tasks. Otherwise, use would not usually outweigh the
28 > * construction and bookkeeping overhead of creating a large set of
29 > * threads.
30   *
31 < * <p>ForkJoinPools differ from other kinds of Executor mainly in that
32 < * they provide <em>work-stealing</em>: all threads in the pool
31 > * <p>ForkJoinPools differ from other kinds of Executors mainly in
32 > * that they provide <em>work-stealing</em>: all threads in the pool
33   * attempt to find and execute subtasks created by other active tasks
34   * (eventually blocking if none exist). This makes them efficient when
35 < * most tasks spawn other subtasks (as do most ForkJoinTasks) but
36 < * possibly less so otherwise. It is however fine to combine execution
37 < * of some plain Runnable- or Callable- based activities with that of
38 < * ForkJoinTasks.
35 > * most tasks spawn other subtasks (as do most ForkJoinTasks), as well
36 > * as the mixed execution of some plain Runnable- or Callable- based
37 > * activities along with ForkJoinTasks. When setting {@linkplain
38 > * #setAsyncMode async mode}, a ForkJoinPool may also be appropriate
39 > * for use with fine-grained tasks that are never joined. Otherwise,
40 > * other ExecutorService implementations are typically more
41 > * appropriate choices.
42   *
43   * <p>A ForkJoinPool may be constructed with a given parallelism level
44   * (target pool size), which it attempts to maintain by dynamically
45 < * adding, suspending, or resuming threads, even if some tasks have
46 < * blocked waiting to join others. However, no such adjustments are
47 < * performed in the face of blocked IO or other unmanaged
48 < * synchronization. The nested ManagedBlocker interface enables
49 < * extension of the kinds of synchronization accommodated.
50 < *
51 < * <p>The target parallelism level may also be set dynamically. You
52 < * can limit the number of threads dynamically constructed using
53 < * method <tt>setMaximumPoolSize</tt> and/or
43 < * <tt>setMaintainParallelism</tt>.
45 > * adding, suspending, or resuming threads, even if some tasks are
46 > * waiting to join others. However, no such adjustments are performed
47 > * in the face of blocked IO or other unmanaged synchronization. The
48 > * nested {@link ManagedBlocker} interface enables extension of
49 > * the kinds of synchronization accommodated.  The target parallelism
50 > * level may also be changed dynamically ({@link #setParallelism})
51 > * and thread construction can be limited using methods
52 > * {@link #setMaximumPoolSize} and/or
53 > * {@link #setMaintainsParallelism}.
54   *
55   * <p>In addition to execution and lifecycle control methods, this
56   * class provides status check methods (for example
57 < * <tt>getStealCount</tt>) that are intended to aid in developing,
57 > * {@link #getStealCount}) that are intended to aid in developing,
58   * tuning, and monitoring fork/join applications. Also, method
59 < * <tt>toString</tt> returns indications of pool state in a convenient
60 < * form for informal monitoring.
59 > * {@link #toString} returns indications of pool state in a
60 > * convenient form for informal monitoring.
61   *
62   * <p><b>Implementation notes</b>: This implementation restricts the
63 < * maximum parallelism to 32767. Attempts to create pools with greater
64 < * than the maximum result in IllegalArgumentExceptions.
63 > * maximum number of running threads to 32767. Attempts to create
64 > * pools with greater than the maximum result in
65 > * IllegalArgumentExceptions.
66 > *
67 > * @since 1.7
68 > * @author Doug Lea
69   */
70 < public class ForkJoinPool extends AbstractExecutorService
57 <    implements ExecutorService {
70 > public class ForkJoinPool extends AbstractExecutorService {
71  
72      /*
73       * See the extended comments interspersed below for design,
# Line 78 | Line 91 | public class ForkJoinPool extends Abstra
91           * Returns a new worker thread operating in the given pool.
92           *
93           * @param pool the pool this thread works in
94 <         * @throws NullPointerException if pool is null;
94 >         * @throws NullPointerException if pool is null
95           */
96          public ForkJoinWorkerThread newThread(ForkJoinPool pool);
97      }
98  
99      /**
100 <     * Default ForkJoinWorkerThreadFactory implementation, creates a
100 >     * Default ForkJoinWorkerThreadFactory implementation; creates a
101       * new ForkJoinWorkerThread.
102       */
103 <    public static class  DefaultForkJoinWorkerThreadFactory
103 >    static class  DefaultForkJoinWorkerThreadFactory
104          implements ForkJoinWorkerThreadFactory {
105          public ForkJoinWorkerThread newThread(ForkJoinPool pool) {
106              try {
# Line 99 | Line 112 | public class ForkJoinPool extends Abstra
112      }
113  
114      /**
115 <     * The default ForkJoinWorkerThreadFactory, used unless overridden
116 <     * in ForkJoinPool constructors.
115 >     * Creates a new ForkJoinWorkerThread. This factory is used unless
116 >     * overridden in ForkJoinPool constructors.
117       */
118 <    private static final DefaultForkJoinWorkerThreadFactory
118 >    public static final ForkJoinWorkerThreadFactory
119          defaultForkJoinWorkerThreadFactory =
120          new DefaultForkJoinWorkerThreadFactory();
121  
109
122      /**
123       * Permission required for callers of methods that may start or
124       * kill threads.
# Line 131 | Line 143 | public class ForkJoinPool extends Abstra
143          new AtomicInteger();
144  
145      /**
146 <     * Array holding all worker threads in the pool. Array size must
147 <     * be a power of two.  Updates and replacements are protected by
148 <     * workerLock, but it is always kept in a consistent enough state
149 <     * to be randomly accessed without locking by workers performing
150 <     * work-stealing.
146 >     * Array holding all worker threads in the pool. Initialized upon
147 >     * first use. Array size must be a power of two.  Updates and
148 >     * replacements are protected by workerLock, but it is always kept
149 >     * in a consistent enough state to be randomly accessed without
150 >     * locking by workers performing work-stealing.
151       */
152      volatile ForkJoinWorkerThread[] workers;
153  
# Line 151 | Line 163 | public class ForkJoinPool extends Abstra
163  
164      /**
165       * The uncaught exception handler used when any worker
166 <     * abrupty terminates
166 >     * abruptly terminates
167       */
168      private Thread.UncaughtExceptionHandler ueh;
169  
# Line 179 | Line 191 | public class ForkJoinPool extends Abstra
191      private final LinkedTransferQueue<ForkJoinTask<?>> submissionQueue;
192  
193      /**
194 <     * Head of Treiber stack for barrier sync. See below for explanation
194 >     * Head of Treiber stack for barrier sync. See below for explanation.
195       */
196 <    private volatile WaitQueueNode barrierStack;
196 >    private volatile WaitQueueNode syncStack;
197  
198      /**
199       * The count for event barrier
# Line 204 | Line 216 | public class ForkJoinPool extends Abstra
216      private volatile int parallelism;
217  
218      /**
219 +     * True if use local fifo, not default lifo, for local polling
220 +     */
221 +    private volatile boolean locallyFifo;
222 +
223 +    /**
224       * Holds number of total (i.e., created and not yet terminated)
225       * and running (i.e., not blocked on joins or other managed sync)
226       * threads, packed into one int to ensure consistent snapshot when
227       * making decisions about creating and suspending spare
228       * threads. Updated only by CAS.  Note: CASes in
229 <     * updateRunningCount and preJoin running active count is in low
230 <     * word, so need to be modified if this changes
229 >     * updateRunningCount and preJoin assume that running active count
230 >     * is in low word, so need to be modified if this changes.
231       */
232      private volatile int workerCounts;
233  
# Line 219 | Line 236 | public class ForkJoinPool extends Abstra
236      private static int workerCountsFor(int t, int r) { return (t << 16) + r; }
237  
238      /**
239 <     * Add delta (which may be negative) to running count.  This must
239 >     * Adds delta (which may be negative) to running count.  This must
240       * be called before (with negative arg) and after (with positive)
241 <     * any managed synchronization (i.e., mainly, joins)
241 >     * any managed synchronization (i.e., mainly, joins).
242 >     *
243       * @param delta the number to add
244       */
245      final void updateRunningCount(int delta) {
246          int s;
247 <        do;while (!casWorkerCounts(s = workerCounts, s + delta));
247 >        do {} while (!casWorkerCounts(s = workerCounts, s + delta));
248      }
249  
250      /**
251 <     * Add delta (which may be negative) to both total and running
251 >     * Adds delta (which may be negative) to both total and running
252       * count.  This must be called upon creation and termination of
253       * worker threads.
254 +     *
255       * @param delta the number to add
256       */
257      private void updateWorkerCount(int delta) {
258          int d = delta + (delta << 16); // add to both lo and hi parts
259          int s;
260 <        do;while (!casWorkerCounts(s = workerCounts, s + d));
260 >        do {} while (!casWorkerCounts(s = workerCounts, s + d));
261      }
262  
263      /**
# Line 264 | Line 283 | public class ForkJoinPool extends Abstra
283      private static int runControlFor(int r, int a)   { return (r << 16) + a; }
284  
285      /**
286 <     * Increment active count. Called by workers before/during
287 <     * executing tasks.
286 >     * Tries incrementing active count; fails on contention.
287 >     * Called by workers before/during executing tasks.
288 >     *
289 >     * @return true on success
290       */
291 <    final void incrementActiveCount() {
292 <        int c;
293 <        do;while (!casRunControl(c = runControl, c+1));
291 >    final boolean tryIncrementActiveCount() {
292 >        int c = runControl;
293 >        return casRunControl(c, c+1);
294      }
295  
296      /**
297 <     * Decrement active count; possibly trigger termination.
297 >     * Tries decrementing active count; fails on contention.
298 >     * Possibly triggers termination on success.
299       * Called by workers when they can't find tasks.
300 +     *
301 +     * @return true on success
302       */
303 <    final void decrementActiveCount() {
304 <        int c, nextc;
305 <        do;while (!casRunControl(c = runControl, nextc = c-1));
303 >    final boolean tryDecrementActiveCount() {
304 >        int c = runControl;
305 >        int nextc = c - 1;
306 >        if (!casRunControl(c, nextc))
307 >            return false;
308          if (canTerminateOnShutdown(nextc))
309              terminateOnShutdown();
310 +        return true;
311      }
312  
313      /**
314 <     * Return true if argument represents zero active count and
315 <     * nonzero runstate, which is the triggering condition for
314 >     * Returns {@code true} if argument represents zero active count
315 >     * and nonzero runstate, which is the triggering condition for
316       * terminating on shutdown.
317       */
318      private static boolean canTerminateOnShutdown(int c) {
319 <        return ((c & -c) >>> 16) != 0; // i.e. least bit is nonzero runState bit
319 >        // i.e. least bit is nonzero runState bit
320 >        return ((c & -c) >>> 16) != 0;
321      }
322  
323      /**
# Line 315 | Line 343 | public class ForkJoinPool extends Abstra
343  
344      /**
345       * Creates a ForkJoinPool with a pool size equal to the number of
346 <     * processors available on the system and using the default
347 <     * ForkJoinWorkerThreadFactory,
346 >     * processors available on the system, using the default
347 >     * ForkJoinWorkerThreadFactory.
348 >     *
349       * @throws SecurityException if a security manager exists and
350       *         the caller is not permitted to modify threads
351       *         because it does not hold {@link
352 <     *         java.lang.RuntimePermission}<tt>("modifyThread")</tt>,
352 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
353       */
354      public ForkJoinPool() {
355          this(Runtime.getRuntime().availableProcessors(),
# Line 328 | Line 357 | public class ForkJoinPool extends Abstra
357      }
358  
359      /**
360 <     * Creates a ForkJoinPool with the indicated parellelism level
361 <     * threads, and using the default ForkJoinWorkerThreadFactory,
360 >     * Creates a ForkJoinPool with the indicated parallelism level
361 >     * threads and using the default ForkJoinWorkerThreadFactory.
362 >     *
363       * @param parallelism the number of worker threads
364       * @throws IllegalArgumentException if parallelism less than or
365       * equal to zero
366       * @throws SecurityException if a security manager exists and
367       *         the caller is not permitted to modify threads
368       *         because it does not hold {@link
369 <     *         java.lang.RuntimePermission}<tt>("modifyThread")</tt>,
369 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
370       */
371      public ForkJoinPool(int parallelism) {
372          this(parallelism, defaultForkJoinWorkerThreadFactory);
373      }
374  
375      /**
376 <     * Creates a ForkJoinPool with a pool size equal to the number of
376 >     * Creates a ForkJoinPool with parallelism equal to the number of
377       * processors available on the system and using the given
378 <     * ForkJoinWorkerThreadFactory,
378 >     * ForkJoinWorkerThreadFactory.
379 >     *
380       * @param factory the factory for creating new threads
381       * @throws NullPointerException if factory is null
382       * @throws SecurityException if a security manager exists and
383       *         the caller is not permitted to modify threads
384       *         because it does not hold {@link
385 <     *         java.lang.RuntimePermission}<tt>("modifyThread")</tt>,
385 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
386       */
387      public ForkJoinPool(ForkJoinWorkerThreadFactory factory) {
388          this(Runtime.getRuntime().availableProcessors(), factory);
389      }
390  
391      /**
392 <     * Creates a ForkJoinPool with the indicated target number of
362 <     * worker threads and the given factory.
392 >     * Creates a ForkJoinPool with the given parallelism and factory.
393       *
394       * @param parallelism the targeted number of worker threads
395       * @param factory the factory for creating new threads
396       * @throws IllegalArgumentException if parallelism less than or
397 <     * equal to zero, or greater than implementation limit.
397 >     * equal to zero, or greater than implementation limit
398       * @throws NullPointerException if factory is null
399       * @throws SecurityException if a security manager exists and
400       *         the caller is not permitted to modify threads
401       *         because it does not hold {@link
402 <     *         java.lang.RuntimePermission}<tt>("modifyThread")</tt>,
402 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
403       */
404      public ForkJoinPool(int parallelism, ForkJoinWorkerThreadFactory factory) {
405          if (parallelism <= 0 || parallelism > MAX_THREADS)
# Line 386 | Line 416 | public class ForkJoinPool extends Abstra
416          this.termination = workerLock.newCondition();
417          this.stealCount = new AtomicLong();
418          this.submissionQueue = new LinkedTransferQueue<ForkJoinTask<?>>();
419 <        createAndStartInitialWorkers(parallelism);
419 >        // worker array and workers are lazily constructed
420      }
421  
422      /**
423 <     * Create new worker using factory.
423 >     * Creates a new worker thread using factory.
424 >     *
425       * @param index the index to assign worker
426       * @return new worker, or null of factory failed
427       */
# Line 400 | Line 431 | public class ForkJoinPool extends Abstra
431          if (w != null) {
432              w.poolIndex = index;
433              w.setDaemon(true);
434 +            w.setAsyncMode(locallyFifo);
435              w.setName("ForkJoinPool-" + poolNumber + "-worker-" + index);
436              if (h != null)
437                  w.setUncaughtExceptionHandler(h);
# Line 408 | Line 440 | public class ForkJoinPool extends Abstra
440      }
441  
442      /**
443 <     * Return a good size for worker array given pool size.
443 >     * Returns a good size for worker array given pool size.
444       * Currently requires size to be a power of two.
445       */
446 <    private static int arraySizeFor(int ps) {
447 <        return ps <= 1? 1 : (1 << (32 - Integer.numberOfLeadingZeros(ps-1)));
446 >    private static int arraySizeFor(int poolSize) {
447 >        return (poolSize <= 1) ? 1 :
448 >            (1 << (32 - Integer.numberOfLeadingZeros(poolSize-1)));
449      }
450  
451      /**
452 <     * Create or resize array if necessary to hold newLength
452 >     * Creates or resizes array if necessary to hold newLength.
453 >     * Call only under exclusion.
454 >     *
455       * @return the array
456       */
457      private ForkJoinWorkerThread[] ensureWorkerArrayCapacity(int newLength) {
# Line 430 | Line 465 | public class ForkJoinPool extends Abstra
465      }
466  
467      /**
468 <     * Try to shrink workers into smaller array after one or more terminate
468 >     * Tries to shrink workers into smaller array after one or more terminate.
469       */
470      private void tryShrinkWorkerArray() {
471          ForkJoinWorkerThread[] ws = workers;
472 <        int len = ws.length;
473 <        int last = len - 1;
474 <        while (last >= 0 && ws[last] == null)
475 <            --last;
476 <        int newLength = arraySizeFor(last+1);
477 <        if (newLength < len)
478 <            workers = Arrays.copyOf(ws, newLength);
472 >        if (ws != null) {
473 >            int len = ws.length;
474 >            int last = len - 1;
475 >            while (last >= 0 && ws[last] == null)
476 >                --last;
477 >            int newLength = arraySizeFor(last+1);
478 >            if (newLength < len)
479 >                workers = Arrays.copyOf(ws, newLength);
480 >        }
481      }
482  
483      /**
484 <     * Initial worker array and worker creation and startup. (This
448 <     * must be done under lock to avoid interference by some of the
449 <     * newly started threads while creating others.)
484 >     * Initializes workers if necessary.
485       */
486 <    private void createAndStartInitialWorkers(int ps) {
487 <        final ReentrantLock lock = this.workerLock;
488 <        lock.lock();
489 <        try {
490 <            ForkJoinWorkerThread[] ws = ensureWorkerArrayCapacity(ps);
491 <            for (int i = 0; i < ps; ++i) {
492 <                ForkJoinWorkerThread w = createWorker(i);
493 <                if (w != null) {
494 <                    ws[i] = w;
495 <                    w.start();
496 <                    updateWorkerCount(1);
486 >    final void ensureWorkerInitialization() {
487 >        ForkJoinWorkerThread[] ws = workers;
488 >        if (ws == null) {
489 >            final ReentrantLock lock = this.workerLock;
490 >            lock.lock();
491 >            try {
492 >                ws = workers;
493 >                if (ws == null) {
494 >                    int ps = parallelism;
495 >                    ws = ensureWorkerArrayCapacity(ps);
496 >                    for (int i = 0; i < ps; ++i) {
497 >                        ForkJoinWorkerThread w = createWorker(i);
498 >                        if (w != null) {
499 >                            ws[i] = w;
500 >                            w.start();
501 >                            updateWorkerCount(1);
502 >                        }
503 >                    }
504                  }
505 +            } finally {
506 +                lock.unlock();
507              }
464        } finally {
465            lock.unlock();
508          }
509      }
510  
# Line 500 | Line 542 | public class ForkJoinPool extends Abstra
542          }
543      }
544  
503    /**
504     * Sets the handler for internal worker threads that terminate due
505     * to unrecoverable errors encountered while executing tasks.
506     * Unless set, the current default or ThreadGroup handler is used
507     * as handler.
508     *
509     * @param h the new handler
510     * @return the old handler, or null if none
511     * @throws SecurityException if a security manager exists and
512     *         the caller is not permitted to modify threads
513     *         because it does not hold {@link
514     *         java.lang.RuntimePermission}<tt>("modifyThread")</tt>,
515     */
516    public Thread.UncaughtExceptionHandler
517        setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler h) {
518        checkPermission();
519        Thread.UncaughtExceptionHandler old = null;
520        final ReentrantLock lock = this.workerLock;
521        lock.lock();
522        try {
523            old = ueh;
524            ueh = h;
525            ForkJoinWorkerThread[] ws = workers;
526            for (int i = 0; i < ws.length; ++i) {
527                ForkJoinWorkerThread w = ws[i];
528                if (w != null)
529                    w.setUncaughtExceptionHandler(h);
530            }
531        } finally {
532            lock.unlock();
533        }
534        return old;
535    }
536
537    /**
538     * Returns the handler for internal worker threads that terminate
539     * due to unrecoverable errors encountered while executing tasks.
540     * @return the handler, or null if none
541     */
542    public Thread.UncaughtExceptionHandler getUncaughtExceptionHandler() {
543        Thread.UncaughtExceptionHandler h;
544        final ReentrantLock lock = this.workerLock;
545        lock.lock();
546        try {
547            h = ueh;
548        } finally {
549            lock.unlock();
550        }
551        return h;
552    }
553
545      // Execution methods
546  
547      /**
548       * Common code for execute, invoke and submit
549       */
550      private <T> void doSubmit(ForkJoinTask<T> task) {
551 +        if (task == null)
552 +            throw new NullPointerException();
553          if (isShutdown())
554              throw new RejectedExecutionException();
555 +        if (workers == null)
556 +            ensureWorkerInitialization();
557          submissionQueue.offer(task);
558 <        signalIdleWorkers(true);
558 >        signalIdleWorkers();
559      }
560  
561      /**
562 <     * Performs the given task; returning its result upon completion
562 >     * Performs the given task, returning its result upon completion.
563 >     *
564       * @param task the task
565       * @return the task's result
566       * @throws NullPointerException if task is null
# Line 577 | Line 573 | public class ForkJoinPool extends Abstra
573  
574      /**
575       * Arranges for (asynchronous) execution of the given task.
576 +     *
577       * @param task the task
578       * @throws NullPointerException if task is null
579       * @throws RejectedExecutionException if pool is shut down
# Line 588 | Line 585 | public class ForkJoinPool extends Abstra
585      // AbstractExecutorService methods
586  
587      public void execute(Runnable task) {
588 <        doSubmit(new AdaptedRunnable<Void>(task, null));
588 >        ForkJoinTask<?> job;
589 >        if (task instanceof ForkJoinTask<?>) // avoid re-wrap
590 >            job = (ForkJoinTask<?>) task;
591 >        else
592 >            job = ForkJoinTask.adapt(task, null);
593 >        doSubmit(job);
594      }
595  
596      public <T> ForkJoinTask<T> submit(Callable<T> task) {
597 <        ForkJoinTask<T> job = new AdaptedCallable<T>(task);
597 >        ForkJoinTask<T> job = ForkJoinTask.adapt(task);
598          doSubmit(job);
599          return job;
600      }
601  
602      public <T> ForkJoinTask<T> submit(Runnable task, T result) {
603 <        ForkJoinTask<T> job = new AdaptedRunnable<T>(task, result);
603 >        ForkJoinTask<T> job = ForkJoinTask.adapt(task, result);
604          doSubmit(job);
605          return job;
606      }
607  
608      public ForkJoinTask<?> submit(Runnable task) {
609 <        ForkJoinTask<Void> job = new AdaptedRunnable<Void>(task, null);
609 >        ForkJoinTask<?> job;
610 >        if (task instanceof ForkJoinTask<?>) // avoid re-wrap
611 >            job = (ForkJoinTask<?>) task;
612 >        else
613 >            job = ForkJoinTask.adapt(task, null);
614          doSubmit(job);
615          return job;
616      }
617  
612    protected <T> RunnableFuture<T> newTaskFor(Runnable runnable, T value) {
613        return new AdaptedRunnable(runnable, value);
614    }
615
616    protected <T> RunnableFuture<T> newTaskFor(Callable<T> callable) {
617        return new AdaptedCallable(callable);
618    }
619
618      /**
619 <     * Adaptor for Runnables. This implements RunnableFuture
620 <     * to be compliant with AbstractExecutorService constraints
619 >     * Submits a ForkJoinTask for execution.
620 >     *
621 >     * @param task the task to submit
622 >     * @return the task
623 >     * @throws RejectedExecutionException if the task cannot be
624 >     *         scheduled for execution
625 >     * @throws NullPointerException if the task is null
626       */
627 <    static final class AdaptedRunnable<T> extends ForkJoinTask<T>
628 <        implements RunnableFuture<T> {
629 <        final Runnable runnable;
627 <        final T resultOnCompletion;
628 <        T result;
629 <        AdaptedRunnable(Runnable runnable, T result) {
630 <            if (runnable == null) throw new NullPointerException();
631 <            this.runnable = runnable;
632 <            this.resultOnCompletion = result;
633 <        }
634 <        public T getRawResult() { return result; }
635 <        public void setRawResult(T v) { result = v; }
636 <        public boolean exec() {
637 <            runnable.run();
638 <            result = resultOnCompletion;
639 <            return true;
640 <        }
641 <        public void run() { invoke(); }
627 >    public <T> ForkJoinTask<T> submit(ForkJoinTask<T> task) {
628 >        doSubmit(task);
629 >        return task;
630      }
631  
644    /**
645     * Adaptor for Callables
646     */
647    static final class AdaptedCallable<T> extends ForkJoinTask<T>
648        implements RunnableFuture<T> {
649        final Callable<T> callable;
650        T result;
651        AdaptedCallable(Callable<T> callable) {
652            if (callable == null) throw new NullPointerException();
653            this.callable = callable;
654        }
655        public T getRawResult() { return result; }
656        public void setRawResult(T v) { result = v; }
657        public boolean exec() {
658            try {
659                result = callable.call();
660                return true;
661            } catch (Error err) {
662                throw err;
663            } catch (RuntimeException rex) {
664                throw rex;
665            } catch (Exception ex) {
666                throw new RuntimeException(ex);
667            }
668        }
669        public void run() { invoke(); }
670    }
632  
633      public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks) {
634 <        ArrayList<ForkJoinTask<T>> ts =
634 >        ArrayList<ForkJoinTask<T>> forkJoinTasks =
635              new ArrayList<ForkJoinTask<T>>(tasks.size());
636 <        for (Callable<T> c : tasks)
637 <            ts.add(new AdaptedCallable<T>(c));
638 <        invoke(new InvokeAll<T>(ts));
639 <        return (List<Future<T>>)(List)ts;
636 >        for (Callable<T> task : tasks)
637 >            forkJoinTasks.add(ForkJoinTask.adapt(task));
638 >        invoke(new InvokeAll<T>(forkJoinTasks));
639 >
640 >        @SuppressWarnings({"unchecked", "rawtypes"})
641 >        List<Future<T>> futures = (List<Future<T>>) (List) forkJoinTasks;
642 >        return futures;
643      }
644  
645      static final class InvokeAll<T> extends RecursiveAction {
646          final ArrayList<ForkJoinTask<T>> tasks;
647          InvokeAll(ArrayList<ForkJoinTask<T>> tasks) { this.tasks = tasks; }
648          public void compute() {
649 <            try { invokeAll(tasks); } catch(Exception ignore) {}
649 >            try { invokeAll(tasks); }
650 >            catch (Exception ignore) {}
651          }
652 +        private static final long serialVersionUID = -7914297376763021607L;
653      }
654  
655      // Configuration and status settings and queries
656  
657      /**
658 <     * Returns the factory used for constructing new workers
658 >     * Returns the factory used for constructing new workers.
659       *
660       * @return the factory used for constructing new workers
661       */
# Line 698 | Line 664 | public class ForkJoinPool extends Abstra
664      }
665  
666      /**
667 <     * Sets the target paralleism level of this pool.
667 >     * Returns the handler for internal worker threads that terminate
668 >     * due to unrecoverable errors encountered while executing tasks.
669 >     *
670 >     * @return the handler, or {@code null} if none
671 >     */
672 >    public Thread.UncaughtExceptionHandler getUncaughtExceptionHandler() {
673 >        Thread.UncaughtExceptionHandler h;
674 >        final ReentrantLock lock = this.workerLock;
675 >        lock.lock();
676 >        try {
677 >            h = ueh;
678 >        } finally {
679 >            lock.unlock();
680 >        }
681 >        return h;
682 >    }
683 >
684 >    /**
685 >     * Sets the handler for internal worker threads that terminate due
686 >     * to unrecoverable errors encountered while executing tasks.
687 >     * Unless set, the current default or ThreadGroup handler is used
688 >     * as handler.
689 >     *
690 >     * @param h the new handler
691 >     * @return the old handler, or {@code null} if none
692 >     * @throws SecurityException if a security manager exists and
693 >     *         the caller is not permitted to modify threads
694 >     *         because it does not hold {@link
695 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
696 >     */
697 >    public Thread.UncaughtExceptionHandler
698 >        setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler h) {
699 >        checkPermission();
700 >        Thread.UncaughtExceptionHandler old = null;
701 >        final ReentrantLock lock = this.workerLock;
702 >        lock.lock();
703 >        try {
704 >            old = ueh;
705 >            ueh = h;
706 >            ForkJoinWorkerThread[] ws = workers;
707 >            if (ws != null) {
708 >                for (int i = 0; i < ws.length; ++i) {
709 >                    ForkJoinWorkerThread w = ws[i];
710 >                    if (w != null)
711 >                        w.setUncaughtExceptionHandler(h);
712 >                }
713 >            }
714 >        } finally {
715 >            lock.unlock();
716 >        }
717 >        return old;
718 >    }
719 >
720 >
721 >    /**
722 >     * Sets the target parallelism level of this pool.
723 >     *
724       * @param parallelism the target parallelism
725       * @throws IllegalArgumentException if parallelism less than or
726 <     * equal to zero or greater than maximum size bounds.
726 >     * equal to zero or greater than maximum size bounds
727       * @throws SecurityException if a security manager exists and
728       *         the caller is not permitted to modify threads
729       *         because it does not hold {@link
730 <     *         java.lang.RuntimePermission}<tt>("modifyThread")</tt>,
730 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
731       */
732      public void setParallelism(int parallelism) {
733          checkPermission();
# Line 725 | Line 747 | public class ForkJoinPool extends Abstra
747          } finally {
748              lock.unlock();
749          }
750 <        signalIdleWorkers(false);
750 >        signalIdleWorkers();
751      }
752  
753      /**
754       * Returns the targeted number of worker threads in this pool.
733     * This value does not necessarily reflect transient changes as
734     * threads are added, removed, or abruptly terminate.
755       *
756       * @return the targeted number of worker threads in this pool
757       */
# Line 742 | Line 762 | public class ForkJoinPool extends Abstra
762      /**
763       * Returns the number of worker threads that have started but not
764       * yet terminated.  This result returned by this method may differ
765 <     * from <tt>getParallelism</tt> when threads are created to
765 >     * from {@link #getParallelism} when threads are created to
766       * maintain parallelism when others are cooperatively blocked.
767       *
768       * @return the number of worker threads
# Line 754 | Line 774 | public class ForkJoinPool extends Abstra
774      /**
775       * Returns the maximum number of threads allowed to exist in the
776       * pool, even if there are insufficient unblocked running threads.
777 +     *
778       * @return the maximum
779       */
780      public int getMaximumPoolSize() {
# Line 765 | Line 786 | public class ForkJoinPool extends Abstra
786       * pool, even if there are insufficient unblocked running threads.
787       * Setting this value has no effect on current pool size. It
788       * controls construction of new threads.
789 +     *
790       * @throws IllegalArgumentException if negative or greater then
791 <     * internal implementation limit.
791 >     * internal implementation limit
792       */
793      public void setMaximumPoolSize(int newMax) {
794          if (newMax < 0 || newMax > MAX_THREADS)
# Line 776 | Line 798 | public class ForkJoinPool extends Abstra
798  
799  
800      /**
801 <     * Returns true if this pool dynamically maintains its target
802 <     * parallelism level. If false, new threads are added only to
803 <     * avoid possible starvation.
804 <     * This setting is by default true;
805 <     * @return true if maintains parallelism
801 >     * Returns {@code true} if this pool dynamically maintains its
802 >     * target parallelism level. If false, new threads are added only
803 >     * to avoid possible starvation.  This setting is by default true.
804 >     *
805 >     * @return {@code true} if maintains parallelism
806       */
807      public boolean getMaintainsParallelism() {
808          return maintainsParallelism;
# Line 790 | Line 812 | public class ForkJoinPool extends Abstra
812       * Sets whether this pool dynamically maintains its target
813       * parallelism level. If false, new threads are added only to
814       * avoid possible starvation.
815 <     * @param enable true to maintains parallelism
815 >     *
816 >     * @param enable {@code true} to maintain parallelism
817       */
818      public void setMaintainsParallelism(boolean enable) {
819          maintainsParallelism = enable;
820      }
821  
822      /**
823 <     * Returns the approximate number of worker threads that are not
824 <     * blocked waiting to join tasks or for other managed
823 >     * Establishes local first-in-first-out scheduling mode for forked
824 >     * tasks that are never joined. This mode may be more appropriate
825 >     * than default locally stack-based mode in applications in which
826 >     * worker threads only process asynchronous tasks.  This method is
827 >     * designed to be invoked only when the pool is quiescent, and
828 >     * typically only before any tasks are submitted. The effects of
829 >     * invocations at other times may be unpredictable.
830 >     *
831 >     * @param async if {@code true}, use locally FIFO scheduling
832 >     * @return the previous mode
833 >     * @see #getAsyncMode
834 >     */
835 >    public boolean setAsyncMode(boolean async) {
836 >        boolean oldMode = locallyFifo;
837 >        locallyFifo = async;
838 >        ForkJoinWorkerThread[] ws = workers;
839 >        if (ws != null) {
840 >            for (int i = 0; i < ws.length; ++i) {
841 >                ForkJoinWorkerThread t = ws[i];
842 >                if (t != null)
843 >                    t.setAsyncMode(async);
844 >            }
845 >        }
846 >        return oldMode;
847 >    }
848 >
849 >    /**
850 >     * Returns {@code true} if this pool uses local first-in-first-out
851 >     * scheduling mode for forked tasks that are never joined.
852 >     *
853 >     * @return {@code true} if this pool uses async mode
854 >     * @see #setAsyncMode
855 >     */
856 >    public boolean getAsyncMode() {
857 >        return locallyFifo;
858 >    }
859 >
860 >    /**
861 >     * Returns an estimate of the number of worker threads that are
862 >     * not blocked waiting to join tasks or for other managed
863       * synchronization.
864       *
865       * @return the number of worker threads
# Line 808 | Line 869 | public class ForkJoinPool extends Abstra
869      }
870  
871      /**
872 <     * Returns the approximate number of threads that are currently
872 >     * Returns an estimate of the number of threads that are currently
873       * stealing or executing tasks. This method may overestimate the
874       * number of active threads.
875 <     * @return the number of active threads.
875 >     *
876 >     * @return the number of active threads
877       */
878      public int getActiveThreadCount() {
879          return activeCountOf(runControl);
880      }
881  
882      /**
883 <     * Returns the approximate number of threads that are currently
883 >     * Returns an estimate of the number of threads that are currently
884       * idle waiting for tasks. This method may underestimate the
885       * number of idle threads.
886 <     * @return the number of idle threads.
886 >     *
887 >     * @return the number of idle threads
888       */
889      final int getIdleThreadCount() {
890          int c = runningCountOf(workerCounts) - activeCountOf(runControl);
891 <        return (c <= 0)? 0 : c;
891 >        return (c <= 0) ? 0 : c;
892      }
893  
894      /**
895 <     * Returns true if all worker threads are currently idle. An idle
896 <     * worker is one that cannot obtain a task to execute because none
897 <     * are available to steal from other threads, and there are no
898 <     * pending submissions to the pool. This method is conservative:
899 <     * It might not return true immediately upon idleness of all
900 <     * threads, but will eventually become true if threads remain
901 <     * inactive.
902 <     * @return true if all threads are currently idle
895 >     * Returns {@code true} if all worker threads are currently idle.
896 >     * An idle worker is one that cannot obtain a task to execute
897 >     * because none are available to steal from other threads, and
898 >     * there are no pending submissions to the pool. This method is
899 >     * conservative; it might not return {@code true} immediately upon
900 >     * idleness of all threads, but will eventually become true if
901 >     * threads remain inactive.
902 >     *
903 >     * @return {@code true} if all threads are currently idle
904       */
905      public boolean isQuiescent() {
906          return activeCountOf(runControl) == 0;
# Line 847 | Line 911 | public class ForkJoinPool extends Abstra
911       * one thread's work queue by another. The reported value
912       * underestimates the actual total number of steals when the pool
913       * is not quiescent. This value may be useful for monitoring and
914 <     * tuning fork/join programs: In general, steal counts should be
914 >     * tuning fork/join programs: in general, steal counts should be
915       * high enough to keep threads busy, but low enough to avoid
916       * overhead and contention across threads.
917 <     * @return the number of steals.
917 >     *
918 >     * @return the number of steals
919       */
920      public long getStealCount() {
921          return stealCount.get();
922      }
923  
924      /**
925 <     * Accumulate steal count from a worker. Call only
926 <     * when worker known to be idle.
925 >     * Accumulates steal count from a worker.
926 >     * Call only when worker known to be idle.
927       */
928      private void updateStealCount(ForkJoinWorkerThread w) {
929          int sc = w.getAndClearStealCount();
# Line 867 | Line 932 | public class ForkJoinPool extends Abstra
932      }
933  
934      /**
935 <     * Returns the total number of tasks currently held in queues by
936 <     * worker threads (but not including tasks submitted to the pool
937 <     * that have not begun executing). This value is only an
938 <     * approximation, obtained by iterating across all threads in the
939 <     * pool. This method may be useful for tuning task granularities.
940 <     * @return the number of queued tasks.
935 >     * Returns an estimate of the total number of tasks currently held
936 >     * in queues by worker threads (but not including tasks submitted
937 >     * to the pool that have not begun executing). This value is only
938 >     * an approximation, obtained by iterating across all threads in
939 >     * the pool. This method may be useful for tuning task
940 >     * granularities.
941 >     *
942 >     * @return the number of queued tasks
943       */
944      public long getQueuedTaskCount() {
945          long count = 0;
946          ForkJoinWorkerThread[] ws = workers;
947 <        for (int i = 0; i < ws.length; ++i) {
948 <            ForkJoinWorkerThread t = ws[i];
949 <            if (t != null)
950 <                count += t.getQueueSize();
947 >        if (ws != null) {
948 >            for (int i = 0; i < ws.length; ++i) {
949 >                ForkJoinWorkerThread t = ws[i];
950 >                if (t != null)
951 >                    count += t.getQueueSize();
952 >            }
953          }
954          return count;
955      }
956  
957      /**
958 <     * Returns the approximate number tasks submitted to this pool
958 >     * Returns an estimate of the number tasks submitted to this pool
959       * that have not yet begun executing. This method takes time
960       * proportional to the number of submissions.
961 <     * @return the number of queued submissions.
961 >     *
962 >     * @return the number of queued submissions
963       */
964      public int getQueuedSubmissionCount() {
965          return submissionQueue.size();
966      }
967  
968      /**
969 <     * Returns true if there are any tasks submitted to this pool
970 <     * that have not yet begun executing.
971 <     * @return <tt>true</tt> if there are any queued submissions.
969 >     * Returns {@code true} if there are any tasks submitted to this
970 >     * pool that have not yet begun executing.
971 >     *
972 >     * @return {@code true} if there are any queued submissions
973       */
974      public boolean hasQueuedSubmissions() {
975          return !submissionQueue.isEmpty();
# Line 908 | Line 979 | public class ForkJoinPool extends Abstra
979       * Removes and returns the next unexecuted submission if one is
980       * available.  This method may be useful in extensions to this
981       * class that re-assign work in systems with multiple pools.
982 <     * @return the next submission, or null if none
982 >     *
983 >     * @return the next submission, or {@code null} if none
984       */
985      protected ForkJoinTask<?> pollSubmission() {
986          return submissionQueue.poll();
987      }
988  
989      /**
990 +     * Removes all available unexecuted submitted and forked tasks
991 +     * from scheduling queues and adds them to the given collection,
992 +     * without altering their execution status. These may include
993 +     * artificially generated or wrapped tasks. This method is designed
994 +     * to be invoked only when the pool is known to be
995 +     * quiescent. Invocations at other times may not remove all
996 +     * tasks. A failure encountered while attempting to add elements
997 +     * to collection {@code c} may result in elements being in
998 +     * neither, either or both collections when the associated
999 +     * exception is thrown.  The behavior of this operation is
1000 +     * undefined if the specified collection is modified while the
1001 +     * operation is in progress.
1002 +     *
1003 +     * @param c the collection to transfer elements into
1004 +     * @return the number of elements transferred
1005 +     */
1006 +    protected int drainTasksTo(Collection<? super ForkJoinTask<?>> c) {
1007 +        int n = submissionQueue.drainTo(c);
1008 +        ForkJoinWorkerThread[] ws = workers;
1009 +        if (ws != null) {
1010 +            for (int i = 0; i < ws.length; ++i) {
1011 +                ForkJoinWorkerThread w = ws[i];
1012 +                if (w != null)
1013 +                    n += w.drainTasksTo(c);
1014 +            }
1015 +        }
1016 +        return n;
1017 +    }
1018 +
1019 +    /**
1020       * Returns a string identifying this pool, as well as its state,
1021       * including indications of run state, parallelism level, and
1022       * worker and task counts.
# Line 958 | Line 1060 | public class ForkJoinPool extends Abstra
1060       * Invocation has no additional effect if already shut down.
1061       * Tasks that are in the process of being submitted concurrently
1062       * during the course of this method may or may not be rejected.
1063 +     *
1064       * @throws SecurityException if a security manager exists and
1065       *         the caller is not permitted to modify threads
1066       *         because it does not hold {@link
1067 <     *         java.lang.RuntimePermission}<tt>("modifyThread")</tt>,
1067 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
1068       */
1069      public void shutdown() {
1070          checkPermission();
1071          transitionRunStateTo(SHUTDOWN);
1072 <        if (canTerminateOnShutdown(runControl))
1072 >        if (canTerminateOnShutdown(runControl)) {
1073 >            if (workers == null) { // shutting down before workers created
1074 >                final ReentrantLock lock = this.workerLock;
1075 >                lock.lock();
1076 >                try {
1077 >                    if (workers == null) {
1078 >                        terminate();
1079 >                        transitionRunStateTo(TERMINATED);
1080 >                        termination.signalAll();
1081 >                    }
1082 >                } finally {
1083 >                    lock.unlock();
1084 >                }
1085 >            }
1086              terminateOnShutdown();
1087 +        }
1088      }
1089  
1090      /**
# Line 975 | Line 1092 | public class ForkJoinPool extends Abstra
1092       * waiting tasks.  Tasks that are in the process of being
1093       * submitted or executed concurrently during the course of this
1094       * method may or may not be rejected. Unlike some other executors,
1095 <     * this method cancels rather than collects non-executed tasks,
1096 <     * so always returns an empty list.
1095 >     * this method cancels rather than collects non-executed tasks
1096 >     * upon termination, so always returns an empty list. However, you
1097 >     * can use method {@link #drainTasksTo} before invoking this
1098 >     * method to transfer unexecuted tasks to another collection.
1099 >     *
1100       * @return an empty list
1101       * @throws SecurityException if a security manager exists and
1102       *         the caller is not permitted to modify threads
1103       *         because it does not hold {@link
1104 <     *         java.lang.RuntimePermission}<tt>("modifyThread")</tt>,
1104 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
1105       */
1106      public List<Runnable> shutdownNow() {
1107          checkPermission();
# Line 990 | Line 1110 | public class ForkJoinPool extends Abstra
1110      }
1111  
1112      /**
1113 <     * Returns <tt>true</tt> if all tasks have completed following shut down.
1113 >     * Returns {@code true} if all tasks have completed following shut down.
1114       *
1115 <     * @return <tt>true</tt> if all tasks have completed following shut down
1115 >     * @return {@code true} if all tasks have completed following shut down
1116       */
1117      public boolean isTerminated() {
1118          return runStateOf(runControl) == TERMINATED;
1119      }
1120  
1121      /**
1122 <     * Returns <tt>true</tt> if the process of termination has
1122 >     * Returns {@code true} if the process of termination has
1123       * commenced but possibly not yet completed.
1124       *
1125 <     * @return <tt>true</tt> if terminating
1125 >     * @return {@code true} if terminating
1126       */
1127      public boolean isTerminating() {
1128          return runStateOf(runControl) >= TERMINATING;
1129      }
1130  
1131      /**
1132 <     * Returns <tt>true</tt> if this pool has been shut down.
1132 >     * Returns {@code true} if this pool has been shut down.
1133       *
1134 <     * @return <tt>true</tt> if this pool has been shut down
1134 >     * @return {@code true} if this pool has been shut down
1135       */
1136      public boolean isShutdown() {
1137          return runStateOf(runControl) >= SHUTDOWN;
# Line 1024 | Line 1144 | public class ForkJoinPool extends Abstra
1144       *
1145       * @param timeout the maximum time to wait
1146       * @param unit the time unit of the timeout argument
1147 <     * @return <tt>true</tt> if this executor terminated and
1148 <     *         <tt>false</tt> if the timeout elapsed before termination
1147 >     * @return {@code true} if this executor terminated and
1148 >     *         {@code false} if the timeout elapsed before termination
1149       * @throws InterruptedException if interrupted while waiting
1150       */
1151      public boolean awaitTermination(long timeout, TimeUnit unit)
# Line 1049 | Line 1169 | public class ForkJoinPool extends Abstra
1169      // Shutdown and termination support
1170  
1171      /**
1172 <     * Callback from terminating worker. Null out the corresponding
1173 <     * workers slot, and if terminating, try to terminate, else try to
1174 <     * shrink workers array.
1172 >     * Callback from terminating worker. Nulls out the corresponding
1173 >     * workers slot, and if terminating, tries to terminate; else
1174 >     * tries to shrink workers array.
1175 >     *
1176       * @param w the worker
1177       */
1178      final void workerTerminated(ForkJoinWorkerThread w) {
# Line 1061 | Line 1182 | public class ForkJoinPool extends Abstra
1182          lock.lock();
1183          try {
1184              ForkJoinWorkerThread[] ws = workers;
1185 <            int idx = w.poolIndex;
1186 <            if (idx >= 0 && idx < ws.length && ws[idx] == w)
1187 <                ws[idx] = null;
1188 <            if (totalCountOf(workerCounts) == 0) {
1189 <                terminate(); // no-op if already terminating
1190 <                transitionRunStateTo(TERMINATED);
1191 <                termination.signalAll();
1192 <            }
1193 <            else if (!isTerminating()) {
1194 <                tryShrinkWorkerArray();
1195 <                tryResumeSpare(true); // allow replacement
1185 >            if (ws != null) {
1186 >                int idx = w.poolIndex;
1187 >                if (idx >= 0 && idx < ws.length && ws[idx] == w)
1188 >                    ws[idx] = null;
1189 >                if (totalCountOf(workerCounts) == 0) {
1190 >                    terminate(); // no-op if already terminating
1191 >                    transitionRunStateTo(TERMINATED);
1192 >                    termination.signalAll();
1193 >                }
1194 >                else if (!isTerminating()) {
1195 >                    tryShrinkWorkerArray();
1196 >                    tryResumeSpare(true); // allow replacement
1197 >                }
1198              }
1199          } finally {
1200              lock.unlock();
1201          }
1202 <        signalIdleWorkers(false);
1202 >        signalIdleWorkers();
1203      }
1204  
1205      /**
1206 <     * Initiate termination.
1206 >     * Initiates termination.
1207       */
1208      private void terminate() {
1209          if (transitionRunStateTo(TERMINATING)) {
1210              stopAllWorkers();
1211              resumeAllSpares();
1212 <            signalIdleWorkers(true);
1212 >            signalIdleWorkers();
1213              cancelQueuedSubmissions();
1214              cancelQueuedWorkerTasks();
1215              interruptUnterminatedWorkers();
1216 <            signalIdleWorkers(true); // resignal after interrupt
1216 >            signalIdleWorkers(); // resignal after interrupt
1217          }
1218      }
1219  
1220      /**
1221 <     * Possibly terminate when on shutdown state
1221 >     * Possibly terminates when on shutdown state.
1222       */
1223      private void terminateOnShutdown() {
1224          if (!hasQueuedSubmissions() && canTerminateOnShutdown(runControl))
# Line 1103 | Line 1226 | public class ForkJoinPool extends Abstra
1226      }
1227  
1228      /**
1229 <     * Clear out and cancel submissions
1229 >     * Clears out and cancels submissions.
1230       */
1231      private void cancelQueuedSubmissions() {
1232          ForkJoinTask<?> task;
# Line 1112 | Line 1235 | public class ForkJoinPool extends Abstra
1235      }
1236  
1237      /**
1238 <     * Clean out worker queues.
1238 >     * Cleans out worker queues.
1239       */
1240      private void cancelQueuedWorkerTasks() {
1241          final ReentrantLock lock = this.workerLock;
1242          lock.lock();
1243          try {
1244              ForkJoinWorkerThread[] ws = workers;
1245 <            for (int i = 0; i < ws.length; ++i) {
1246 <                ForkJoinWorkerThread t = ws[i];
1247 <                if (t != null)
1248 <                    t.cancelTasks();
1245 >            if (ws != null) {
1246 >                for (int i = 0; i < ws.length; ++i) {
1247 >                    ForkJoinWorkerThread t = ws[i];
1248 >                    if (t != null)
1249 >                        t.cancelTasks();
1250 >                }
1251              }
1252          } finally {
1253              lock.unlock();
# Line 1130 | Line 1255 | public class ForkJoinPool extends Abstra
1255      }
1256  
1257      /**
1258 <     * Set each worker's status to terminating. Requires lock to avoid
1259 <     * conflicts with add/remove
1258 >     * Sets each worker's status to terminating. Requires lock to avoid
1259 >     * conflicts with add/remove.
1260       */
1261      private void stopAllWorkers() {
1262          final ReentrantLock lock = this.workerLock;
1263          lock.lock();
1264          try {
1265              ForkJoinWorkerThread[] ws = workers;
1266 <            for (int i = 0; i < ws.length; ++i) {
1267 <                ForkJoinWorkerThread t = ws[i];
1268 <                if (t != null)
1269 <                    t.shutdownNow();
1266 >            if (ws != null) {
1267 >                for (int i = 0; i < ws.length; ++i) {
1268 >                    ForkJoinWorkerThread t = ws[i];
1269 >                    if (t != null)
1270 >                        t.shutdownNow();
1271 >                }
1272              }
1273          } finally {
1274              lock.unlock();
# Line 1149 | Line 1276 | public class ForkJoinPool extends Abstra
1276      }
1277  
1278      /**
1279 <     * Interrupt all unterminated workers.  This is not required for
1279 >     * Interrupts all unterminated workers.  This is not required for
1280       * sake of internal control, but may help unstick user code during
1281       * shutdown.
1282       */
# Line 1158 | Line 1285 | public class ForkJoinPool extends Abstra
1285          lock.lock();
1286          try {
1287              ForkJoinWorkerThread[] ws = workers;
1288 <            for (int i = 0; i < ws.length; ++i) {
1289 <                ForkJoinWorkerThread t = ws[i];
1290 <                if (t != null && !t.isTerminated()) {
1291 <                    try {
1292 <                        t.interrupt();
1293 <                    } catch (SecurityException ignore) {
1288 >            if (ws != null) {
1289 >                for (int i = 0; i < ws.length; ++i) {
1290 >                    ForkJoinWorkerThread t = ws[i];
1291 >                    if (t != null && !t.isTerminated()) {
1292 >                        try {
1293 >                            t.interrupt();
1294 >                        } catch (SecurityException ignore) {
1295 >                        }
1296                      }
1297                  }
1298              }
# Line 1174 | Line 1303 | public class ForkJoinPool extends Abstra
1303  
1304  
1305      /*
1306 <     * Nodes for event barrier to manage idle threads.
1306 >     * Nodes for event barrier to manage idle threads.  Queue nodes
1307 >     * are basic Treiber stack nodes, also used for spare stack.
1308       *
1309       * The event barrier has an event count and a wait queue (actually
1310       * a Treiber stack).  Workers are enabled to look for work when
1311 <     * the eventCount is incremented. If they fail to find some,
1312 <     * they may wait for next count. Synchronization events occur only
1313 <     * in enough contexts to maintain overall liveness:
1311 >     * the eventCount is incremented. If they fail to find work, they
1312 >     * may wait for next count. Upon release, threads help others wake
1313 >     * up.
1314 >     *
1315 >     * Synchronization events occur only in enough contexts to
1316 >     * maintain overall liveness:
1317       *
1318       *   - Submission of a new task to the pool
1319 <     *   - Creation or termination of a worker
1319 >     *   - Resizes or other changes to the workers array
1320       *   - pool termination
1321       *   - A worker pushing a task on an empty queue
1322       *
1323 <     * The last case (pushing a task) occurs often enough, and is
1324 <     * heavy enough compared to simple stack pushes to require some
1325 <     * special handling: Method signalNonEmptyWorkerQueue returns
1326 <     * without advancing count if the queue appears to be empty.  This
1327 <     * would ordinarily result in races causing some queued waiters
1328 <     * not to be woken up. To avoid this, a worker in sync
1329 <     * rescans for tasks after being enqueued if it was the first to
1330 <     * enqueue, and aborts the wait if finding one, also helping to
1331 <     * signal others. This works well because the worker has nothing
1332 <     * better to do anyway, and so might as well help alleviate the
1333 <     * overhead and contention on the threads actually doing work.
1334 <     *
1335 <     * Queue nodes are basic Treiber stack nodes, also used for spare
1336 <     * stack.
1323 >     * The case of pushing a task occurs often enough, and is heavy
1324 >     * enough compared to simple stack pushes, to require special
1325 >     * handling: Method signalWork returns without advancing count if
1326 >     * the queue appears to be empty.  This would ordinarily result in
1327 >     * races causing some queued waiters not to be woken up. To avoid
1328 >     * this, the first worker enqueued in method sync (see
1329 >     * syncIsReleasable) rescans for tasks after being enqueued, and
1330 >     * helps signal if any are found. This works well because the
1331 >     * worker has nothing better to do, and so might as well help
1332 >     * alleviate the overhead and contention on the threads actually
1333 >     * doing work.  Also, since event counts increments on task
1334 >     * availability exist to maintain liveness (rather than to force
1335 >     * refreshes etc), it is OK for callers to exit early if
1336 >     * contending with another signaller.
1337       */
1338      static final class WaitQueueNode {
1339          WaitQueueNode next; // only written before enqueued
1340          volatile ForkJoinWorkerThread thread; // nulled to cancel wait
1341          final long count; // unused for spare stack
1342 <        WaitQueueNode(ForkJoinWorkerThread w, long c) {
1342 >
1343 >        WaitQueueNode(long c, ForkJoinWorkerThread w) {
1344              count = c;
1345              thread = w;
1346          }
1347 <        final boolean signal() {
1347 >
1348 >        /**
1349 >         * Wakes up waiter, returning false if known to already
1350 >         */
1351 >        boolean signal() {
1352              ForkJoinWorkerThread t = thread;
1353 +            if (t == null)
1354 +                return false;
1355              thread = null;
1356 <            if (t != null) {
1357 <                LockSupport.unpark(t);
1358 <                return true;
1356 >            LockSupport.unpark(t);
1357 >            return true;
1358 >        }
1359 >
1360 >        /**
1361 >         * Awaits release on sync.
1362 >         */
1363 >        void awaitSyncRelease(ForkJoinPool p) {
1364 >            while (thread != null && !p.syncIsReleasable(this))
1365 >                LockSupport.park(this);
1366 >        }
1367 >
1368 >        /**
1369 >         * Awaits resumption as spare.
1370 >         */
1371 >        void awaitSpareRelease() {
1372 >            while (thread != null) {
1373 >                if (!Thread.interrupted())
1374 >                    LockSupport.park(this);
1375              }
1220            return false;
1376          }
1377      }
1378  
1379      /**
1380 <     * Release at least one thread waiting for event count to advance,
1381 <     * if one exists. If initial attempt fails, release all threads.
1382 <     * @param all if false, at first try to only release one thread
1383 <     * @return current event
1380 >     * Ensures that no thread is waiting for count to advance from the
1381 >     * current value of eventCount read on entry to this method, by
1382 >     * releasing waiting threads if necessary.
1383 >     *
1384 >     * @return the count
1385       */
1386 <    private long releaseIdleWorkers(boolean all) {
1387 <        long c;
1388 <        for (;;) {
1389 <            WaitQueueNode q = barrierStack;
1390 <            c = eventCount;
1235 <            long qc;
1236 <            if (q == null || (qc = q.count) >= c)
1237 <                break;
1238 <            if (!all) {
1239 <                if (casBarrierStack(q, q.next) && q.signal())
1240 <                    break;
1241 <                all = true;
1242 <            }
1243 <            else if (casBarrierStack(q, null)) {
1386 >    final long ensureSync() {
1387 >        long c = eventCount;
1388 >        WaitQueueNode q;
1389 >        while ((q = syncStack) != null && q.count < c) {
1390 >            if (casBarrierStack(q, null)) {
1391                  do {
1392 <                 q.signal();
1392 >                    q.signal();
1393                  } while ((q = q.next) != null);
1394                  break;
1395              }
# Line 1251 | Line 1398 | public class ForkJoinPool extends Abstra
1398      }
1399  
1400      /**
1401 <     * Returns current barrier event count
1255 <     * @return current barrier event count
1256 <     */
1257 <    final long getEventCount() {
1258 <        long ec = eventCount;
1259 <        releaseIdleWorkers(true); // release to ensure accurate result
1260 <        return ec;
1261 <    }
1262 <
1263 <    /**
1264 <     * Increment event count and release at least one waiting thread,
1265 <     * if one exists (released threads will in turn wake up others).
1266 <     * @param all if true, try to wake up all
1401 >     * Increments event count and releases waiting threads.
1402       */
1403 <    final void signalIdleWorkers(boolean all) {
1403 >    private void signalIdleWorkers() {
1404          long c;
1405 <        do;while (!casEventCount(c = eventCount, c+1));
1406 <        releaseIdleWorkers(all);
1405 >        do {} while (!casEventCount(c = eventCount, c+1));
1406 >        ensureSync();
1407      }
1408  
1409      /**
1410 <     * Wake up threads waiting to steal a task. Because method
1411 <     * sync rechecks availability, it is OK to only proceed if
1412 <     * queue appears to be non-empty.
1410 >     * Signals threads waiting to poll a task. Because method sync
1411 >     * rechecks availability, it is OK to only proceed if queue
1412 >     * appears to be non-empty, and OK to skip under contention to
1413 >     * increment count (since some other thread succeeded).
1414       */
1415 <    final void signalNonEmptyWorkerQueue() {
1280 <        // If CAS fails another signaller must have succeeded
1415 >    final void signalWork() {
1416          long c;
1417 <        if (barrierStack != null && casEventCount(c = eventCount, c+1))
1418 <            releaseIdleWorkers(false);
1417 >        WaitQueueNode q;
1418 >        if (syncStack != null &&
1419 >            casEventCount(c = eventCount, c+1) &&
1420 >            (((q = syncStack) != null && q.count <= c) &&
1421 >             (!casBarrierStack(q, q.next) || !q.signal())))
1422 >            ensureSync();
1423      }
1424  
1425      /**
1426 <     * Waits until event count advances from count, or some thread is
1427 <     * waiting on a previous count, or there is stealable work
1428 <     * available. Help wake up others on release.
1426 >     * Waits until event count advances from last value held by
1427 >     * caller, or if excess threads, caller is resumed as spare, or
1428 >     * caller or pool is terminating. Updates caller's event on exit.
1429 >     *
1430       * @param w the calling worker thread
1291     * @param prev previous value returned by sync (or 0)
1292     * @return current event count
1431       */
1432 <    final long sync(ForkJoinWorkerThread w, long prev) {
1433 <        updateStealCount(w);
1432 >    final void sync(ForkJoinWorkerThread w) {
1433 >        updateStealCount(w); // Transfer w's count while it is idle
1434  
1435 <        while (!w.isShutdown() && !isTerminating() &&
1436 <               (parallelism >= runningCountOf(workerCounts) ||
1299 <                !suspendIfSpare(w))) { // prefer suspend to waiting here
1435 >        while (!w.isShutdown() && !isTerminating() && !suspendIfSpare(w)) {
1436 >            long prev = w.lastEventCount;
1437              WaitQueueNode node = null;
1438 <            boolean queued = false;
1439 <            for (;;) {
1440 <                if (!queued) {
1441 <                    if (eventCount != prev)
1442 <                        break;
1443 <                    WaitQueueNode h = barrierStack;
1444 <                    if (h != null && h.count != prev)
1308 <                        break; // release below and maybe retry
1309 <                    if (node == null)
1310 <                        node = new WaitQueueNode(w, prev);
1311 <                    queued = casBarrierStack(node.next = h, node);
1312 <                }
1313 <                else if (Thread.interrupted() ||
1314 <                         node.thread == null ||
1315 <                         (node.next == null && w.prescan()) ||
1316 <                         eventCount != prev) {
1317 <                    node.thread = null;
1318 <                    if (eventCount == prev) // help trigger
1319 <                        casEventCount(prev, prev+1);
1438 >            WaitQueueNode h;
1439 >            while (eventCount == prev &&
1440 >                   ((h = syncStack) == null || h.count == prev)) {
1441 >                if (node == null)
1442 >                    node = new WaitQueueNode(prev, w);
1443 >                if (casBarrierStack(node.next = h, node)) {
1444 >                    node.awaitSyncRelease(this);
1445                      break;
1446                  }
1322                else
1323                    LockSupport.park(this);
1447              }
1448 +            long ec = ensureSync();
1449 +            if (ec != prev) {
1450 +                w.lastEventCount = ec;
1451 +                break;
1452 +            }
1453 +        }
1454 +    }
1455 +
1456 +    /**
1457 +     * Returns {@code true} if worker waiting on sync can proceed:
1458 +     *  - on signal (thread == null)
1459 +     *  - on event count advance (winning race to notify vs signaller)
1460 +     *  - on interrupt
1461 +     *  - if the first queued node, we find work available
1462 +     * If node was not signalled and event count not advanced on exit,
1463 +     * then we also help advance event count.
1464 +     *
1465 +     * @return {@code true} if node can be released
1466 +     */
1467 +    final boolean syncIsReleasable(WaitQueueNode node) {
1468 +        long prev = node.count;
1469 +        if (!Thread.interrupted() && node.thread != null &&
1470 +            (node.next != null ||
1471 +             !ForkJoinWorkerThread.hasQueuedTasks(workers)) &&
1472 +            eventCount == prev)
1473 +            return false;
1474 +        if (node.thread != null) {
1475 +            node.thread = null;
1476              long ec = eventCount;
1477 <            if (releaseIdleWorkers(false) != prev)
1478 <                return ec;
1477 >            if (prev <= ec) // help signal
1478 >                casEventCount(ec, ec+1);
1479          }
1480 <        return prev; // return old count if aborted
1480 >        return true;
1481 >    }
1482 >
1483 >    /**
1484 >     * Returns {@code true} if a new sync event occurred since last
1485 >     * call to sync or this method, if so, updating caller's count.
1486 >     */
1487 >    final boolean hasNewSyncEvent(ForkJoinWorkerThread w) {
1488 >        long lc = w.lastEventCount;
1489 >        long ec = ensureSync();
1490 >        if (ec == lc)
1491 >            return false;
1492 >        w.lastEventCount = ec;
1493 >        return true;
1494      }
1495  
1496      //  Parallelism maintenance
1497  
1498      /**
1499 <     * Decrement running count; if too low, add spare.
1499 >     * Decrements running count; if too low, adds spare.
1500       *
1501       * Conceptually, all we need to do here is add or resume a
1502       * spare thread when one is about to block (and remove or
1503       * suspend it later when unblocked -- see suspendIfSpare).
1504       * However, implementing this idea requires coping with
1505 <     * several problems: We have imperfect information about the
1505 >     * several problems: we have imperfect information about the
1506       * states of threads. Some count updates can and usually do
1507       * lag run state changes, despite arrangements to keep them
1508       * accurate (for example, when possible, updating counts
# Line 1352 | Line 1516 | public class ForkJoinPool extends Abstra
1516       * only be suspended or removed when they are idle, not
1517       * immediately when they aren't needed. So adding threads will
1518       * raise parallelism level for longer than necessary.  Also,
1519 <     * FJ applications often enounter highly transient peaks when
1519 >     * FJ applications often encounter highly transient peaks when
1520       * many threads are blocked joining, but for less time than it
1521       * takes to create or resume spares.
1522       *
# Line 1361 | Line 1525 | public class ForkJoinPool extends Abstra
1525       * target counts, else create only to avoid starvation
1526       * @return true if joinMe known to be done
1527       */
1528 <    final boolean preJoin(ForkJoinTask<?> joinMe, boolean maintainParallelism) {
1528 >    final boolean preJoin(ForkJoinTask<?> joinMe,
1529 >                          boolean maintainParallelism) {
1530          maintainParallelism &= maintainsParallelism; // overrride
1531          boolean dec = false;  // true when running count decremented
1532          while (spareStack == null || !tryResumeSpare(dec)) {
1533              int counts = workerCounts;
1534 <            if (dec || (dec = casWorkerCounts(counts, --counts))) { // CAS cheat
1534 >            if (dec || (dec = casWorkerCounts(counts, --counts))) {
1535 >                // CAS cheat
1536                  if (!needSpare(counts, maintainParallelism))
1537                      break;
1538                  if (joinMe.status < 0)
# Line 1381 | Line 1547 | public class ForkJoinPool extends Abstra
1547      /**
1548       * Same idea as preJoin
1549       */
1550 <    final boolean preBlock(ManagedBlocker blocker, boolean maintainParallelism){
1550 >    final boolean preBlock(ManagedBlocker blocker,
1551 >                           boolean maintainParallelism) {
1552          maintainParallelism &= maintainsParallelism;
1553          boolean dec = false;
1554          while (spareStack == null || !tryResumeSpare(dec)) {
# Line 1399 | Line 1566 | public class ForkJoinPool extends Abstra
1566      }
1567  
1568      /**
1569 <     * Returns true if a spare thread appears to be needed.  If
1570 <     * maintaining parallelism, returns true when the deficit in
1569 >     * Returns {@code true} if a spare thread appears to be needed.
1570 >     * If maintaining parallelism, returns true when the deficit in
1571       * running threads is more than the surplus of total threads, and
1572       * there is apparently some work to do.  This self-limiting rule
1573       * means that the more threads that have already been added, the
1574       * less parallelism we will tolerate before adding another.
1575 +     *
1576       * @param counts current worker counts
1577       * @param maintainParallelism try to maintain parallelism
1578       */
# Line 1417 | Line 1585 | public class ForkJoinPool extends Abstra
1585          return (tc < maxPoolSize &&
1586                  (rc == 0 || totalSurplus < 0 ||
1587                   (maintainParallelism &&
1588 <                  runningDeficit > totalSurplus && mayHaveQueuedWork())));
1589 <    }
1422 <
1423 <    /**
1424 <     * Returns true if at least one worker queue appears to be
1425 <     * nonempty. This is expensive but not often called. It is not
1426 <     * critical that this be accurate, but if not, more or fewer
1427 <     * running threads than desired might be maintained.
1428 <     */
1429 <    private boolean mayHaveQueuedWork() {
1430 <        ForkJoinWorkerThread[] ws = workers;
1431 <        int len = ws.length;
1432 <        ForkJoinWorkerThread v;
1433 <        for (int i = 0; i < len; ++i) {
1434 <            if ((v = ws[i]) != null && v.getRawQueueSize() > 0) {
1435 <                releaseIdleWorkers(false); // help wake up stragglers
1436 <                return true;
1437 <            }
1438 <        }
1439 <        return false;
1588 >                  runningDeficit > totalSurplus &&
1589 >                  ForkJoinWorkerThread.hasQueuedTasks(workers))));
1590      }
1591  
1592      /**
1593 <     * Add a spare worker if lock available and no more than the
1594 <     * expected numbers of threads exist
1593 >     * Adds a spare worker if lock available and no more than the
1594 >     * expected numbers of threads exist.
1595 >     *
1596       * @return true if successful
1597       */
1598      private boolean tryAddSpare(int expectedCounts) {
# Line 1474 | Line 1625 | public class ForkJoinPool extends Abstra
1625      }
1626  
1627      /**
1628 <     * Add the kth spare worker. On entry, pool coounts are already
1628 >     * Adds the kth spare worker. On entry, pool counts are already
1629       * adjusted to reflect addition.
1630       */
1631      private void createAndStartSpare(int k) {
# Line 1486 | Line 1637 | public class ForkJoinPool extends Abstra
1637              for (k = 0; k < len && ws[k] != null; ++k)
1638                  ;
1639          }
1640 <        if (k < len && (w = createWorker(k)) != null) {
1640 >        if (k < len && !isTerminating() && (w = createWorker(k)) != null) {
1641              ws[k] = w;
1642              w.start();
1643          }
1644          else
1645              updateWorkerCount(-1); // adjust on failure
1646 <        signalIdleWorkers(false);
1646 >        signalIdleWorkers();
1647      }
1648  
1649      /**
1650 <     * Suspend calling thread w if there are excess threads.  Called
1651 <     * only from sync.  Spares are enqueued in a Treiber stack
1652 <     * using the same WaitQueueNodes as barriers.  They are resumed
1653 <     * mainly in preJoin, but are also woken on pool events that
1654 <     * require all threads to check run state.
1650 >     * Suspends calling thread w if there are excess threads.  Called
1651 >     * only from sync.  Spares are enqueued in a Treiber stack using
1652 >     * the same WaitQueueNodes as barriers.  They are resumed mainly
1653 >     * in preJoin, but are also woken on pool events that require all
1654 >     * threads to check run state.
1655 >     *
1656       * @param w the caller
1657       */
1658      private boolean suspendIfSpare(ForkJoinWorkerThread w) {
# Line 1508 | Line 1660 | public class ForkJoinPool extends Abstra
1660          int s;
1661          while (parallelism < runningCountOf(s = workerCounts)) {
1662              if (node == null)
1663 <                node = new WaitQueueNode(w, 0);
1663 >                node = new WaitQueueNode(0, w);
1664              if (casWorkerCounts(s, s-1)) { // representation-dependent
1665                  // push onto stack
1666 <                do;while (!casSpareStack(node.next = spareStack, node));
1515 <
1666 >                do {} while (!casSpareStack(node.next = spareStack, node));
1667                  // block until released by resumeSpare
1668 <                while (node.thread != null) {
1518 <                    if (!Thread.interrupted())
1519 <                        LockSupport.park(this);
1520 <                }
1521 <                w.activate(); // help warm up
1668 >                node.awaitSpareRelease();
1669                  return true;
1670              }
1671          }
# Line 1526 | Line 1673 | public class ForkJoinPool extends Abstra
1673      }
1674  
1675      /**
1676 <     * Try to pop and resume a spare thread.
1676 >     * Tries to pop and resume a spare thread.
1677 >     *
1678       * @param updateCount if true, increment running count on success
1679       * @return true if successful
1680       */
# Line 1544 | Line 1692 | public class ForkJoinPool extends Abstra
1692      }
1693  
1694      /**
1695 <     * Pop and resume all spare threads. Same idea as
1696 <     * releaseIdleWorkers.
1695 >     * Pops and resumes all spare threads. Same idea as ensureSync.
1696 >     *
1697       * @return true if any spares released
1698       */
1699      private boolean resumeAllSpares() {
# Line 1563 | Line 1711 | public class ForkJoinPool extends Abstra
1711      }
1712  
1713      /**
1714 <     * Pop and shutdown excessive spare threads. Call only while
1714 >     * Pops and shuts down excessive spare threads. Call only while
1715       * holding lock. This is not guaranteed to eliminate all excess
1716       * threads, only those suspended as spares, which are the ones
1717       * unlikely to be needed in the future.
# Line 1586 | Line 1734 | public class ForkJoinPool extends Abstra
1734      }
1735  
1736      /**
1589     * Returns approximate number of spares, just for diagnostics.
1590     */
1591    private int countSpares() {
1592        int sum = 0;
1593        for (WaitQueueNode q = spareStack; q != null; q = q.next)
1594            ++sum;
1595        return sum;
1596    }
1597
1598    /**
1737       * Interface for extending managed parallelism for tasks running
1738       * in ForkJoinPools. A ManagedBlocker provides two methods.
1739 <     * Method <tt>isReleasable</tt> must return true if blocking is not
1740 <     * necessary. Method <tt>block</tt> blocks the current thread
1741 <     * if necessary (perhaps internally invoking isReleasable before
1742 <     * actually blocking.).
1739 >     * Method {@code isReleasable} must return {@code true} if
1740 >     * blocking is not necessary. Method {@code block} blocks the
1741 >     * current thread if necessary (perhaps internally invoking
1742 >     * {@code isReleasable} before actually blocking.).
1743 >     *
1744       * <p>For example, here is a ManagedBlocker based on a
1745       * ReentrantLock:
1746 <     * <pre>
1747 <     *   class ManagedLocker implements ManagedBlocker {
1748 <     *     final ReentrantLock lock;
1749 <     *     boolean hasLock = false;
1750 <     *     ManagedLocker(ReentrantLock lock) { this.lock = lock; }
1751 <     *     public boolean block() {
1752 <     *        if (!hasLock)
1753 <     *           lock.lock();
1754 <     *        return true;
1755 <     *     }
1756 <     *     public boolean isReleasable() {
1757 <     *        return hasLock || (hasLock = lock.tryLock());
1619 <     *     }
1746 >     *  <pre> {@code
1747 >     * class ManagedLocker implements ManagedBlocker {
1748 >     *   final ReentrantLock lock;
1749 >     *   boolean hasLock = false;
1750 >     *   ManagedLocker(ReentrantLock lock) { this.lock = lock; }
1751 >     *   public boolean block() {
1752 >     *     if (!hasLock)
1753 >     *       lock.lock();
1754 >     *     return true;
1755 >     *   }
1756 >     *   public boolean isReleasable() {
1757 >     *     return hasLock || (hasLock = lock.tryLock());
1758       *   }
1759 <     * </pre>
1759 >     * }}</pre>
1760       */
1761      public static interface ManagedBlocker {
1762          /**
1763           * Possibly blocks the current thread, for example waiting for
1764           * a lock or condition.
1765 <         * @return true if no additional blocking is necessary (i.e.,
1766 <         * if isReleasable would return true).
1765 >         *
1766 >         * @return {@code true} if no additional blocking is necessary
1767 >         * (i.e., if isReleasable would return true)
1768           * @throws InterruptedException if interrupted while waiting
1769 <         * (the method is not required to do so, but is allowe to).
1769 >         * (the method is not required to do so, but is allowed to)
1770           */
1771          boolean block() throws InterruptedException;
1772  
1773          /**
1774 <         * Returns true if blocking is unnecessary.
1774 >         * Returns {@code true} if blocking is unnecessary.
1775           */
1776          boolean isReleasable();
1777      }
# Line 1642 | Line 1781 | public class ForkJoinPool extends Abstra
1781       * is a ForkJoinWorkerThread, this method possibly arranges for a
1782       * spare thread to be activated if necessary to ensure parallelism
1783       * while the current thread is blocked.  If
1784 <     * <tt>maintainParallelism</tt> is true and the pool supports it
1785 <     * (see <tt>getMaintainsParallelism</tt>), this method attempts to
1786 <     * maintain the pool's nominal parallelism. Otherwise if activates
1784 >     * {@code maintainParallelism} is {@code true} and the pool supports
1785 >     * it ({@link #getMaintainsParallelism}), this method attempts to
1786 >     * maintain the pool's nominal parallelism. Otherwise it activates
1787       * a thread only if necessary to avoid complete starvation. This
1788       * option may be preferable when blockages use timeouts, or are
1789       * almost always brief.
1790       *
1791       * <p> If the caller is not a ForkJoinTask, this method is behaviorally
1792       * equivalent to
1793 <     * <pre>
1794 <     *   while (!blocker.isReleasable())
1795 <     *      if (blocker.block())
1796 <     *         return;
1797 <     * </pre>
1793 >     *  <pre> {@code
1794 >     * while (!blocker.isReleasable())
1795 >     *   if (blocker.block())
1796 >     *     return;
1797 >     * }</pre>
1798       * If the caller is a ForkJoinTask, then the pool may first
1799       * be expanded to ensure parallelism, and later adjusted.
1800       *
1801       * @param blocker the blocker
1802 <     * @param maintainParallelism if true and supported by this pool,
1803 <     * attempt to maintain the pool's nominal parallelism; otherwise
1804 <     * activate a thread only if necessary to avoid complete
1805 <     * starvation.
1806 <     * @throws InterruptedException if blocker.block did so.
1802 >     * @param maintainParallelism if {@code true} and supported by
1803 >     * this pool, attempt to maintain the pool's nominal parallelism;
1804 >     * otherwise activate a thread only if necessary to avoid
1805 >     * complete starvation.
1806 >     * @throws InterruptedException if blocker.block did so
1807       */
1808      public static void managedBlock(ManagedBlocker blocker,
1809                                      boolean maintainParallelism)
1810          throws InterruptedException {
1811          Thread t = Thread.currentThread();
1812 <        ForkJoinPool pool = (t instanceof ForkJoinWorkerThread?
1813 <                             ((ForkJoinWorkerThread)t).pool : null);
1812 >        ForkJoinPool pool = ((t instanceof ForkJoinWorkerThread) ?
1813 >                             ((ForkJoinWorkerThread) t).pool : null);
1814          if (!blocker.isReleasable()) {
1815              try {
1816                  if (pool == null ||
# Line 1686 | Line 1825 | public class ForkJoinPool extends Abstra
1825  
1826      private static void awaitBlocker(ManagedBlocker blocker)
1827          throws InterruptedException {
1828 <        do;while (!blocker.isReleasable() && !blocker.block());
1828 >        do {} while (!blocker.isReleasable() && !blocker.block());
1829      }
1830  
1831 +    // AbstractExecutorService overrides.  These rely on undocumented
1832 +    // fact that ForkJoinTask.adapt returns ForkJoinTasks that also
1833 +    // implement RunnableFuture.
1834  
1835 <    // Temporary Unsafe mechanics for preliminary release
1836 <
1837 <    static final Unsafe _unsafe;
1696 <    static final long eventCountOffset;
1697 <    static final long workerCountsOffset;
1698 <    static final long runControlOffset;
1699 <    static final long barrierStackOffset;
1700 <    static final long spareStackOffset;
1835 >    protected <T> RunnableFuture<T> newTaskFor(Runnable runnable, T value) {
1836 >        return (RunnableFuture<T>)ForkJoinTask.adapt(runnable, value);
1837 >    }
1838  
1839 <    static {
1840 <        try {
1704 <            if (ForkJoinPool.class.getClassLoader() != null) {
1705 <                Field f = Unsafe.class.getDeclaredField("theUnsafe");
1706 <                f.setAccessible(true);
1707 <                _unsafe = (Unsafe)f.get(null);
1708 <            }
1709 <            else
1710 <                _unsafe = Unsafe.getUnsafe();
1711 <            eventCountOffset = _unsafe.objectFieldOffset
1712 <                (ForkJoinPool.class.getDeclaredField("eventCount"));
1713 <            workerCountsOffset = _unsafe.objectFieldOffset
1714 <                (ForkJoinPool.class.getDeclaredField("workerCounts"));
1715 <            runControlOffset = _unsafe.objectFieldOffset
1716 <                (ForkJoinPool.class.getDeclaredField("runControl"));
1717 <            barrierStackOffset = _unsafe.objectFieldOffset
1718 <                (ForkJoinPool.class.getDeclaredField("barrierStack"));
1719 <            spareStackOffset = _unsafe.objectFieldOffset
1720 <                (ForkJoinPool.class.getDeclaredField("spareStack"));
1721 <        } catch (Exception e) {
1722 <            throw new RuntimeException("Could not initialize intrinsics", e);
1723 <        }
1839 >    protected <T> RunnableFuture<T> newTaskFor(Callable<T> callable) {
1840 >        return (RunnableFuture<T>)ForkJoinTask.adapt(callable);
1841      }
1842  
1843 +    // Unsafe mechanics
1844 +
1845 +    private static final sun.misc.Unsafe UNSAFE = getUnsafe();
1846 +    private static final long eventCountOffset =
1847 +        objectFieldOffset("eventCount", ForkJoinPool.class);
1848 +    private static final long workerCountsOffset =
1849 +        objectFieldOffset("workerCounts", ForkJoinPool.class);
1850 +    private static final long runControlOffset =
1851 +        objectFieldOffset("runControl", ForkJoinPool.class);
1852 +    private static final long syncStackOffset =
1853 +        objectFieldOffset("syncStack",ForkJoinPool.class);
1854 +    private static final long spareStackOffset =
1855 +        objectFieldOffset("spareStack", ForkJoinPool.class);
1856 +
1857      private boolean casEventCount(long cmp, long val) {
1858 <        return _unsafe.compareAndSwapLong(this, eventCountOffset, cmp, val);
1858 >        return UNSAFE.compareAndSwapLong(this, eventCountOffset, cmp, val);
1859      }
1860      private boolean casWorkerCounts(int cmp, int val) {
1861 <        return _unsafe.compareAndSwapInt(this, workerCountsOffset, cmp, val);
1861 >        return UNSAFE.compareAndSwapInt(this, workerCountsOffset, cmp, val);
1862      }
1863      private boolean casRunControl(int cmp, int val) {
1864 <        return _unsafe.compareAndSwapInt(this, runControlOffset, cmp, val);
1864 >        return UNSAFE.compareAndSwapInt(this, runControlOffset, cmp, val);
1865      }
1866      private boolean casSpareStack(WaitQueueNode cmp, WaitQueueNode val) {
1867 <        return _unsafe.compareAndSwapObject(this, spareStackOffset, cmp, val);
1867 >        return UNSAFE.compareAndSwapObject(this, spareStackOffset, cmp, val);
1868      }
1869      private boolean casBarrierStack(WaitQueueNode cmp, WaitQueueNode val) {
1870 <        return _unsafe.compareAndSwapObject(this, barrierStackOffset, cmp, val);
1870 >        return UNSAFE.compareAndSwapObject(this, syncStackOffset, cmp, val);
1871 >    }
1872 >
1873 >    private static long objectFieldOffset(String field, Class<?> klazz) {
1874 >        try {
1875 >            return UNSAFE.objectFieldOffset(klazz.getDeclaredField(field));
1876 >        } catch (NoSuchFieldException e) {
1877 >            // Convert Exception to corresponding Error
1878 >            NoSuchFieldError error = new NoSuchFieldError(field);
1879 >            error.initCause(e);
1880 >            throw error;
1881 >        }
1882 >    }
1883 >
1884 >    /**
1885 >     * Returns a sun.misc.Unsafe.  Suitable for use in a 3rd party package.
1886 >     * Replace with a simple call to Unsafe.getUnsafe when integrating
1887 >     * into a jdk.
1888 >     *
1889 >     * @return a sun.misc.Unsafe
1890 >     */
1891 >    private static sun.misc.Unsafe getUnsafe() {
1892 >        try {
1893 >            return sun.misc.Unsafe.getUnsafe();
1894 >        } catch (SecurityException se) {
1895 >            try {
1896 >                return java.security.AccessController.doPrivileged
1897 >                    (new java.security
1898 >                     .PrivilegedExceptionAction<sun.misc.Unsafe>() {
1899 >                        public sun.misc.Unsafe run() throws Exception {
1900 >                            java.lang.reflect.Field f = sun.misc
1901 >                                .Unsafe.class.getDeclaredField("theUnsafe");
1902 >                            f.setAccessible(true);
1903 >                            return (sun.misc.Unsafe) f.get(null);
1904 >                        }});
1905 >            } catch (java.security.PrivilegedActionException e) {
1906 >                throw new RuntimeException("Could not initialize intrinsics",
1907 >                                           e.getCause());
1908 >            }
1909 >        }
1910      }
1911   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines