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.5 by jsr166, Thu Mar 19 05:10:42 2009 UTC vs.
Revision 1.17 by jsr166, Thu Jul 23 23:07:57 2009 UTC

# Line 27 | Line 27 | import java.lang.reflect.*;
27   * (eventually blocking if none exist). This makes them efficient when
28   * most tasks spawn other subtasks (as do most ForkJoinTasks), as well
29   * as the mixed execution of some plain Runnable- or Callable- based
30 < * activities along with ForkJoinTasks. Otherwise, other
30 > * activities along with ForkJoinTasks. When setting
31 > * {@code setAsyncMode}, a ForkJoinPools may also be appropriate for
32 > * use with fine-grained tasks that are never joined. Otherwise, other
33   * ExecutorService implementations are typically more appropriate
34   * choices.
35   *
# Line 36 | Line 38 | import java.lang.reflect.*;
38   * adding, suspending, or resuming threads, even if some tasks are
39   * waiting to join others. However, no such adjustments are performed
40   * in the face of blocked IO or other unmanaged synchronization. The
41 < * nested <code>ManagedBlocker</code> interface enables extension of
41 > * nested {@code ManagedBlocker} interface enables extension of
42   * the kinds of synchronization accommodated.  The target parallelism
43 < * level may also be changed dynamically (<code>setParallelism</code>)
44 < * and dynamically thread construction can be limited using methods
45 < * <code>setMaximumPoolSize</code> and/or
46 < * <code>setMaintainsParallelism</code>.
43 > * level may also be changed dynamically ({@code setParallelism})
44 > * and thread construction can be limited using methods
45 > * {@code setMaximumPoolSize} and/or
46 > * {@code setMaintainsParallelism}.
47   *
48   * <p>In addition to execution and lifecycle control methods, this
49   * class provides status check methods (for example
50 < * <code>getStealCount</code>) that are intended to aid in developing,
50 > * {@code getStealCount}) that are intended to aid in developing,
51   * tuning, and monitoring fork/join applications. Also, method
52 < * <code>toString</code> returns indications of pool state in a
52 > * {@code toString} returns indications of pool state in a
53   * convenient form for informal monitoring.
54   *
55   * <p><b>Implementation notes</b>: This implementation restricts the
56   * maximum number of running threads to 32767. Attempts to create
57   * pools with greater than the maximum result in
58   * IllegalArgumentExceptions.
59 + *
60 + * @since 1.7
61 + * @author Doug Lea
62   */
63   public class ForkJoinPool extends AbstractExecutorService {
64  
# Line 79 | Line 84 | public class ForkJoinPool extends Abstra
84           * Returns a new worker thread operating in the given pool.
85           *
86           * @param pool the pool this thread works in
87 <         * @throws NullPointerException if pool is null;
87 >         * @throws NullPointerException if pool is null
88           */
89          public ForkJoinWorkerThread newThread(ForkJoinPool pool);
90      }
91  
92      /**
93 <     * Default ForkJoinWorkerThreadFactory implementation, creates a
93 >     * Default ForkJoinWorkerThreadFactory implementation; creates a
94       * new ForkJoinWorkerThread.
95       */
96      static class  DefaultForkJoinWorkerThreadFactory
# Line 131 | Line 136 | public class ForkJoinPool extends Abstra
136          new AtomicInteger();
137  
138      /**
139 <     * Array holding all worker threads in the pool. Array size must
140 <     * be a power of two.  Updates and replacements are protected by
141 <     * workerLock, but it is always kept in a consistent enough state
142 <     * to be randomly accessed without locking by workers performing
143 <     * work-stealing.
139 >     * Array holding all worker threads in the pool. Initialized upon
140 >     * first use. Array size must be a power of two.  Updates and
141 >     * replacements are protected by workerLock, but it is always kept
142 >     * in a consistent enough state to be randomly accessed without
143 >     * locking by workers performing work-stealing.
144       */
145      volatile ForkJoinWorkerThread[] workers;
146  
# Line 151 | Line 156 | public class ForkJoinPool extends Abstra
156  
157      /**
158       * The uncaught exception handler used when any worker
159 <     * abrupty terminates
159 >     * abruptly terminates
160       */
161      private Thread.UncaughtExceptionHandler ueh;
162  
# Line 179 | Line 184 | public class ForkJoinPool extends Abstra
184      private final LinkedTransferQueue<ForkJoinTask<?>> submissionQueue;
185  
186      /**
187 <     * Head of Treiber stack for barrier sync. See below for explanation
187 >     * Head of Treiber stack for barrier sync. See below for explanation.
188       */
189      private volatile WaitQueueNode syncStack;
190  
# Line 204 | Line 209 | public class ForkJoinPool extends Abstra
209      private volatile int parallelism;
210  
211      /**
212 +     * True if use local fifo, not default lifo, for local polling
213 +     */
214 +    private volatile boolean locallyFifo;
215 +
216 +    /**
217       * Holds number of total (i.e., created and not yet terminated)
218       * and running (i.e., not blocked on joins or other managed sync)
219       * threads, packed into one int to ensure consistent snapshot when
220       * making decisions about creating and suspending spare
221       * threads. Updated only by CAS.  Note: CASes in
222 <     * updateRunningCount and preJoin running active count is in low
223 <     * word, so need to be modified if this changes
222 >     * updateRunningCount and preJoin assume that running active count
223 >     * is in low word, so need to be modified if this changes.
224       */
225      private volatile int workerCounts;
226  
# Line 219 | Line 229 | public class ForkJoinPool extends Abstra
229      private static int workerCountsFor(int t, int r) { return (t << 16) + r; }
230  
231      /**
232 <     * Add delta (which may be negative) to running count.  This must
232 >     * Adds delta (which may be negative) to running count.  This must
233       * be called before (with negative arg) and after (with positive)
234 <     * any managed synchronization (i.e., mainly, joins)
234 >     * any managed synchronization (i.e., mainly, joins).
235 >     *
236       * @param delta the number to add
237       */
238      final void updateRunningCount(int delta) {
239          int s;
240 <        do;while (!casWorkerCounts(s = workerCounts, s + delta));
240 >        do {} while (!casWorkerCounts(s = workerCounts, s + delta));
241      }
242  
243      /**
244 <     * Add delta (which may be negative) to both total and running
244 >     * Adds delta (which may be negative) to both total and running
245       * count.  This must be called upon creation and termination of
246       * worker threads.
247 +     *
248       * @param delta the number to add
249       */
250      private void updateWorkerCount(int delta) {
251          int d = delta + (delta << 16); // add to both lo and hi parts
252          int s;
253 <        do;while (!casWorkerCounts(s = workerCounts, s + d));
253 >        do {} while (!casWorkerCounts(s = workerCounts, s + d));
254      }
255  
256      /**
# Line 264 | Line 276 | public class ForkJoinPool extends Abstra
276      private static int runControlFor(int r, int a)   { return (r << 16) + a; }
277  
278      /**
279 <     * Try incrementing active count; fail on contention. Called by
280 <     * workers before/during executing tasks.
281 <     * @return true on success;
279 >     * Tries incrementing active count; fails on contention.
280 >     * Called by workers before/during executing tasks.
281 >     *
282 >     * @return true on success
283       */
284      final boolean tryIncrementActiveCount() {
285          int c = runControl;
# Line 274 | Line 287 | public class ForkJoinPool extends Abstra
287      }
288  
289      /**
290 <     * Try decrementing active count; fail on contention.
291 <     * Possibly trigger termination on success
290 >     * Tries decrementing active count; fails on contention.
291 >     * Possibly triggers termination on success.
292       * Called by workers when they can't find tasks.
293 +     *
294       * @return true on success
295       */
296      final boolean tryDecrementActiveCount() {
# Line 290 | Line 304 | public class ForkJoinPool extends Abstra
304      }
305  
306      /**
307 <     * Return true if argument represents zero active count and
307 >     * Returns true if argument represents zero active count and
308       * nonzero runstate, which is the triggering condition for
309       * terminating on shutdown.
310       */
311      private static boolean canTerminateOnShutdown(int c) {
312 <        return ((c & -c) >>> 16) != 0; // i.e. least bit is nonzero runState bit
312 >        // i.e. least bit is nonzero runState bit
313 >        return ((c & -c) >>> 16) != 0;
314      }
315  
316      /**
# Line 321 | Line 336 | public class ForkJoinPool extends Abstra
336  
337      /**
338       * Creates a ForkJoinPool with a pool size equal to the number of
339 <     * processors available on the system and using the default
340 <     * ForkJoinWorkerThreadFactory,
339 >     * processors available on the system, using the default
340 >     * ForkJoinWorkerThreadFactory.
341 >     *
342       * @throws SecurityException if a security manager exists and
343       *         the caller is not permitted to modify threads
344       *         because it does not hold {@link
345 <     *         java.lang.RuntimePermission}<code>("modifyThread")</code>,
345 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
346       */
347      public ForkJoinPool() {
348          this(Runtime.getRuntime().availableProcessors(),
# Line 334 | Line 350 | public class ForkJoinPool extends Abstra
350      }
351  
352      /**
353 <     * Creates a ForkJoinPool with the indicated parellelism level
354 <     * threads, and using the default ForkJoinWorkerThreadFactory,
353 >     * Creates a ForkJoinPool with the indicated parallelism level
354 >     * threads and using the default ForkJoinWorkerThreadFactory.
355 >     *
356       * @param parallelism the number of worker threads
357       * @throws IllegalArgumentException if parallelism less than or
358       * equal to zero
359       * @throws SecurityException if a security manager exists and
360       *         the caller is not permitted to modify threads
361       *         because it does not hold {@link
362 <     *         java.lang.RuntimePermission}<code>("modifyThread")</code>,
362 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
363       */
364      public ForkJoinPool(int parallelism) {
365          this(parallelism, defaultForkJoinWorkerThreadFactory);
# Line 351 | Line 368 | public class ForkJoinPool extends Abstra
368      /**
369       * Creates a ForkJoinPool with parallelism equal to the number of
370       * processors available on the system and using the given
371 <     * ForkJoinWorkerThreadFactory,
371 >     * ForkJoinWorkerThreadFactory.
372 >     *
373       * @param factory the factory for creating new threads
374       * @throws NullPointerException if factory is null
375       * @throws SecurityException if a security manager exists and
376       *         the caller is not permitted to modify threads
377       *         because it does not hold {@link
378 <     *         java.lang.RuntimePermission}<code>("modifyThread")</code>,
378 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
379       */
380      public ForkJoinPool(ForkJoinWorkerThreadFactory factory) {
381          this(Runtime.getRuntime().availableProcessors(), factory);
# Line 369 | Line 387 | public class ForkJoinPool extends Abstra
387       * @param parallelism the targeted number of worker threads
388       * @param factory the factory for creating new threads
389       * @throws IllegalArgumentException if parallelism less than or
390 <     * equal to zero, or greater than implementation limit.
390 >     * equal to zero, or greater than implementation limit
391       * @throws NullPointerException if factory is null
392       * @throws SecurityException if a security manager exists and
393       *         the caller is not permitted to modify threads
394       *         because it does not hold {@link
395 <     *         java.lang.RuntimePermission}<code>("modifyThread")</code>,
395 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
396       */
397      public ForkJoinPool(int parallelism, ForkJoinWorkerThreadFactory factory) {
398          if (parallelism <= 0 || parallelism > MAX_THREADS)
# Line 391 | Line 409 | public class ForkJoinPool extends Abstra
409          this.termination = workerLock.newCondition();
410          this.stealCount = new AtomicLong();
411          this.submissionQueue = new LinkedTransferQueue<ForkJoinTask<?>>();
412 <        createAndStartInitialWorkers(parallelism);
412 >        // worker array and workers are lazily constructed
413      }
414  
415      /**
416 <     * Create new worker using factory.
416 >     * Creates a new worker thread using factory.
417 >     *
418       * @param index the index to assign worker
419       * @return new worker, or null of factory failed
420       */
# Line 405 | Line 424 | public class ForkJoinPool extends Abstra
424          if (w != null) {
425              w.poolIndex = index;
426              w.setDaemon(true);
427 +            w.setAsyncMode(locallyFifo);
428              w.setName("ForkJoinPool-" + poolNumber + "-worker-" + index);
429              if (h != null)
430                  w.setUncaughtExceptionHandler(h);
# Line 413 | Line 433 | public class ForkJoinPool extends Abstra
433      }
434  
435      /**
436 <     * Return a good size for worker array given pool size.
436 >     * Returns a good size for worker array given pool size.
437       * Currently requires size to be a power of two.
438       */
439 <    private static int arraySizeFor(int ps) {
440 <        return ps <= 1? 1 : (1 << (32 - Integer.numberOfLeadingZeros(ps-1)));
439 >    private static int arraySizeFor(int poolSize) {
440 >        return (poolSize <= 1) ? 1 :
441 >            (1 << (32 - Integer.numberOfLeadingZeros(poolSize-1)));
442      }
443  
444      /**
445 <     * Create or resize array if necessary to hold newLength
445 >     * Creates or resizes array if necessary to hold newLength.
446 >     * Call only under exclusion.
447 >     *
448       * @return the array
449       */
450      private ForkJoinWorkerThread[] ensureWorkerArrayCapacity(int newLength) {
# Line 435 | Line 458 | public class ForkJoinPool extends Abstra
458      }
459  
460      /**
461 <     * Try to shrink workers into smaller array after one or more terminate
461 >     * Tries to shrink workers into smaller array after one or more terminate.
462       */
463      private void tryShrinkWorkerArray() {
464          ForkJoinWorkerThread[] ws = workers;
465 <        int len = ws.length;
466 <        int last = len - 1;
467 <        while (last >= 0 && ws[last] == null)
468 <            --last;
469 <        int newLength = arraySizeFor(last+1);
470 <        if (newLength < len)
471 <            workers = Arrays.copyOf(ws, newLength);
465 >        if (ws != null) {
466 >            int len = ws.length;
467 >            int last = len - 1;
468 >            while (last >= 0 && ws[last] == null)
469 >                --last;
470 >            int newLength = arraySizeFor(last+1);
471 >            if (newLength < len)
472 >                workers = Arrays.copyOf(ws, newLength);
473 >        }
474      }
475  
476      /**
477 <     * Initial worker array and worker creation and startup. (This
453 <     * must be done under lock to avoid interference by some of the
454 <     * newly started threads while creating others.)
477 >     * Initializes workers if necessary.
478       */
479 <    private void createAndStartInitialWorkers(int ps) {
480 <        final ReentrantLock lock = this.workerLock;
481 <        lock.lock();
482 <        try {
483 <            ForkJoinWorkerThread[] ws = ensureWorkerArrayCapacity(ps);
484 <            for (int i = 0; i < ps; ++i) {
485 <                ForkJoinWorkerThread w = createWorker(i);
486 <                if (w != null) {
487 <                    ws[i] = w;
488 <                    w.start();
489 <                    updateWorkerCount(1);
479 >    final void ensureWorkerInitialization() {
480 >        ForkJoinWorkerThread[] ws = workers;
481 >        if (ws == null) {
482 >            final ReentrantLock lock = this.workerLock;
483 >            lock.lock();
484 >            try {
485 >                ws = workers;
486 >                if (ws == null) {
487 >                    int ps = parallelism;
488 >                    ws = ensureWorkerArrayCapacity(ps);
489 >                    for (int i = 0; i < ps; ++i) {
490 >                        ForkJoinWorkerThread w = createWorker(i);
491 >                        if (w != null) {
492 >                            ws[i] = w;
493 >                            w.start();
494 >                            updateWorkerCount(1);
495 >                        }
496 >                    }
497                  }
498 +            } finally {
499 +                lock.unlock();
500              }
469        } finally {
470            lock.unlock();
501          }
502      }
503  
# Line 513 | Line 543 | public class ForkJoinPool extends Abstra
543      private <T> void doSubmit(ForkJoinTask<T> task) {
544          if (isShutdown())
545              throw new RejectedExecutionException();
546 +        if (workers == null)
547 +            ensureWorkerInitialization();
548          submissionQueue.offer(task);
549          signalIdleWorkers();
550      }
551  
552      /**
553 <     * Performs the given task; returning its result upon completion
553 >     * Performs the given task, returning its result upon completion.
554 >     *
555       * @param task the task
556       * @return the task's result
557       * @throws NullPointerException if task is null
# Line 531 | Line 564 | public class ForkJoinPool extends Abstra
564  
565      /**
566       * Arranges for (asynchronous) execution of the given task.
567 +     *
568       * @param task the task
569       * @throws NullPointerException if task is null
570       * @throws RejectedExecutionException if pool is shut down
# Line 565 | Line 599 | public class ForkJoinPool extends Abstra
599  
600      /**
601       * Adaptor for Runnables. This implements RunnableFuture
602 <     * to be compliant with AbstractExecutorService constraints
602 >     * to be compliant with AbstractExecutorService constraints.
603       */
604      static final class AdaptedRunnable<T> extends ForkJoinTask<T>
605          implements RunnableFuture<T> {
# Line 621 | Line 655 | public class ForkJoinPool extends Abstra
655          for (Callable<T> c : tasks)
656              ts.add(new AdaptedCallable<T>(c));
657          invoke(new InvokeAll<T>(ts));
658 <        return (List<Future<T>>)(List)ts;
658 >        return (List<Future<T>>) (List) ts;
659      }
660  
661      static final class InvokeAll<T> extends RecursiveAction {
662          final ArrayList<ForkJoinTask<T>> tasks;
663          InvokeAll(ArrayList<ForkJoinTask<T>> tasks) { this.tasks = tasks; }
664          public void compute() {
665 <            try { invokeAll(tasks); } catch(Exception ignore) {}
665 >            try { invokeAll(tasks); }
666 >            catch (Exception ignore) {}
667          }
668      }
669  
670      // Configuration and status settings and queries
671  
672      /**
673 <     * Returns the factory used for constructing new workers
673 >     * Returns the factory used for constructing new workers.
674       *
675       * @return the factory used for constructing new workers
676       */
# Line 646 | Line 681 | public class ForkJoinPool extends Abstra
681      /**
682       * Returns the handler for internal worker threads that terminate
683       * due to unrecoverable errors encountered while executing tasks.
684 +     *
685       * @return the handler, or null if none
686       */
687      public Thread.UncaughtExceptionHandler getUncaughtExceptionHandler() {
# Line 671 | Line 707 | public class ForkJoinPool extends Abstra
707       * @throws SecurityException if a security manager exists and
708       *         the caller is not permitted to modify threads
709       *         because it does not hold {@link
710 <     *         java.lang.RuntimePermission}<code>("modifyThread")</code>,
710 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
711       */
712      public Thread.UncaughtExceptionHandler
713          setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler h) {
# Line 683 | Line 719 | public class ForkJoinPool extends Abstra
719              old = ueh;
720              ueh = h;
721              ForkJoinWorkerThread[] ws = workers;
722 <            for (int i = 0; i < ws.length; ++i) {
723 <                ForkJoinWorkerThread w = ws[i];
724 <                if (w != null)
725 <                    w.setUncaughtExceptionHandler(h);
722 >            if (ws != null) {
723 >                for (int i = 0; i < ws.length; ++i) {
724 >                    ForkJoinWorkerThread w = ws[i];
725 >                    if (w != null)
726 >                        w.setUncaughtExceptionHandler(h);
727 >                }
728              }
729          } finally {
730              lock.unlock();
# Line 696 | Line 734 | public class ForkJoinPool extends Abstra
734  
735  
736      /**
737 <     * Sets the target paralleism level of this pool.
737 >     * Sets the target parallelism level of this pool.
738 >     *
739       * @param parallelism the target parallelism
740       * @throws IllegalArgumentException if parallelism less than or
741 <     * equal to zero or greater than maximum size bounds.
741 >     * equal to zero or greater than maximum size bounds
742       * @throws SecurityException if a security manager exists and
743       *         the caller is not permitted to modify threads
744       *         because it does not hold {@link
745 <     *         java.lang.RuntimePermission}<code>("modifyThread")</code>,
745 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
746       */
747      public void setParallelism(int parallelism) {
748          checkPermission();
# Line 738 | Line 777 | public class ForkJoinPool extends Abstra
777      /**
778       * Returns the number of worker threads that have started but not
779       * yet terminated.  This result returned by this method may differ
780 <     * from <code>getParallelism</code> when threads are created to
780 >     * from {@code getParallelism} when threads are created to
781       * maintain parallelism when others are cooperatively blocked.
782       *
783       * @return the number of worker threads
# Line 750 | Line 789 | public class ForkJoinPool extends Abstra
789      /**
790       * Returns the maximum number of threads allowed to exist in the
791       * pool, even if there are insufficient unblocked running threads.
792 +     *
793       * @return the maximum
794       */
795      public int getMaximumPoolSize() {
# Line 761 | Line 801 | public class ForkJoinPool extends Abstra
801       * pool, even if there are insufficient unblocked running threads.
802       * Setting this value has no effect on current pool size. It
803       * controls construction of new threads.
804 +     *
805       * @throws IllegalArgumentException if negative or greater then
806 <     * internal implementation limit.
806 >     * internal implementation limit
807       */
808      public void setMaximumPoolSize(int newMax) {
809          if (newMax < 0 || newMax > MAX_THREADS)
# Line 775 | Line 816 | public class ForkJoinPool extends Abstra
816       * Returns true if this pool dynamically maintains its target
817       * parallelism level. If false, new threads are added only to
818       * avoid possible starvation.
819 <     * This setting is by default true;
819 >     * This setting is by default true.
820 >     *
821       * @return true if maintains parallelism
822       */
823      public boolean getMaintainsParallelism() {
# Line 786 | Line 828 | public class ForkJoinPool extends Abstra
828       * Sets whether this pool dynamically maintains its target
829       * parallelism level. If false, new threads are added only to
830       * avoid possible starvation.
831 +     *
832       * @param enable true to maintains parallelism
833       */
834      public void setMaintainsParallelism(boolean enable) {
# Line 793 | Line 836 | public class ForkJoinPool extends Abstra
836      }
837  
838      /**
839 +     * Establishes local first-in-first-out scheduling mode for forked
840 +     * tasks that are never joined. This mode may be more appropriate
841 +     * than default locally stack-based mode in applications in which
842 +     * worker threads only process asynchronous tasks.  This method is
843 +     * designed to be invoked only when pool is quiescent, and
844 +     * typically only before any tasks are submitted. The effects of
845 +     * invocations at other times may be unpredictable.
846 +     *
847 +     * @param async if true, use locally FIFO scheduling
848 +     * @return the previous mode
849 +     */
850 +    public boolean setAsyncMode(boolean async) {
851 +        boolean oldMode = locallyFifo;
852 +        locallyFifo = async;
853 +        ForkJoinWorkerThread[] ws = workers;
854 +        if (ws != null) {
855 +            for (int i = 0; i < ws.length; ++i) {
856 +                ForkJoinWorkerThread t = ws[i];
857 +                if (t != null)
858 +                    t.setAsyncMode(async);
859 +            }
860 +        }
861 +        return oldMode;
862 +    }
863 +
864 +    /**
865 +     * Returns true if this pool uses local first-in-first-out
866 +     * scheduling mode for forked tasks that are never joined.
867 +     *
868 +     * @return true if this pool uses async mode
869 +     */
870 +    public boolean getAsyncMode() {
871 +        return locallyFifo;
872 +    }
873 +
874 +    /**
875       * Returns an estimate of the number of worker threads that are
876       * not blocked waiting to join tasks or for other managed
877       * synchronization.
# Line 807 | Line 886 | public class ForkJoinPool extends Abstra
886       * Returns an estimate of the number of threads that are currently
887       * stealing or executing tasks. This method may overestimate the
888       * number of active threads.
889 <     * @return the number of active threads.
889 >     *
890 >     * @return the number of active threads
891       */
892      public int getActiveThreadCount() {
893          return activeCountOf(runControl);
# Line 817 | Line 897 | public class ForkJoinPool extends Abstra
897       * Returns an estimate of the number of threads that are currently
898       * idle waiting for tasks. This method may underestimate the
899       * number of idle threads.
900 <     * @return the number of idle threads.
900 >     *
901 >     * @return the number of idle threads
902       */
903      final int getIdleThreadCount() {
904          int c = runningCountOf(workerCounts) - activeCountOf(runControl);
905 <        return (c <= 0)? 0 : c;
905 >        return (c <= 0) ? 0 : c;
906      }
907  
908      /**
909       * Returns true if all worker threads are currently idle. An idle
910       * worker is one that cannot obtain a task to execute because none
911       * are available to steal from other threads, and there are no
912 <     * pending submissions to the pool. This method is conservative:
913 <     * It might not return true immediately upon idleness of all
912 >     * pending submissions to the pool. This method is conservative;
913 >     * it might not return true immediately upon idleness of all
914       * threads, but will eventually become true if threads remain
915       * inactive.
916 +     *
917       * @return true if all threads are currently idle
918       */
919      public boolean isQuiescent() {
# Line 843 | Line 925 | public class ForkJoinPool extends Abstra
925       * one thread's work queue by another. The reported value
926       * underestimates the actual total number of steals when the pool
927       * is not quiescent. This value may be useful for monitoring and
928 <     * tuning fork/join programs: In general, steal counts should be
928 >     * tuning fork/join programs: in general, steal counts should be
929       * high enough to keep threads busy, but low enough to avoid
930       * overhead and contention across threads.
931 <     * @return the number of steals.
931 >     *
932 >     * @return the number of steals
933       */
934      public long getStealCount() {
935          return stealCount.get();
936      }
937  
938      /**
939 <     * Accumulate steal count from a worker. Call only
940 <     * when worker known to be idle.
939 >     * Accumulates steal count from a worker.
940 >     * Call only when worker known to be idle.
941       */
942      private void updateStealCount(ForkJoinWorkerThread w) {
943          int sc = w.getAndClearStealCount();
# Line 869 | Line 952 | public class ForkJoinPool extends Abstra
952       * an approximation, obtained by iterating across all threads in
953       * the pool. This method may be useful for tuning task
954       * granularities.
955 <     * @return the number of queued tasks.
955 >     *
956 >     * @return the number of queued tasks
957       */
958      public long getQueuedTaskCount() {
959          long count = 0;
960          ForkJoinWorkerThread[] ws = workers;
961 <        for (int i = 0; i < ws.length; ++i) {
962 <            ForkJoinWorkerThread t = ws[i];
963 <            if (t != null)
964 <                count += t.getQueueSize();
961 >        if (ws != null) {
962 >            for (int i = 0; i < ws.length; ++i) {
963 >                ForkJoinWorkerThread t = ws[i];
964 >                if (t != null)
965 >                    count += t.getQueueSize();
966 >            }
967          }
968          return count;
969      }
# Line 886 | Line 972 | public class ForkJoinPool extends Abstra
972       * Returns an estimate of the number tasks submitted to this pool
973       * that have not yet begun executing. This method takes time
974       * proportional to the number of submissions.
975 <     * @return the number of queued submissions.
975 >     *
976 >     * @return the number of queued submissions
977       */
978      public int getQueuedSubmissionCount() {
979          return submissionQueue.size();
# Line 895 | Line 982 | public class ForkJoinPool extends Abstra
982      /**
983       * Returns true if there are any tasks submitted to this pool
984       * that have not yet begun executing.
985 <     * @return <code>true</code> if there are any queued submissions.
985 >     *
986 >     * @return {@code true} if there are any queued submissions
987       */
988      public boolean hasQueuedSubmissions() {
989          return !submissionQueue.isEmpty();
# Line 905 | Line 993 | public class ForkJoinPool extends Abstra
993       * Removes and returns the next unexecuted submission if one is
994       * available.  This method may be useful in extensions to this
995       * class that re-assign work in systems with multiple pools.
996 +     *
997       * @return the next submission, or null if none
998       */
999      protected ForkJoinTask<?> pollSubmission() {
# Line 912 | Line 1001 | public class ForkJoinPool extends Abstra
1001      }
1002  
1003      /**
1004 +     * Removes all available unexecuted submitted and forked tasks
1005 +     * from scheduling queues and adds them to the given collection,
1006 +     * without altering their execution status. These may include
1007 +     * artificially generated or wrapped tasks. This method is designed
1008 +     * to be invoked only when the pool is known to be
1009 +     * quiescent. Invocations at other times may not remove all
1010 +     * tasks. A failure encountered while attempting to add elements
1011 +     * to collection {@code c} may result in elements being in
1012 +     * neither, either or both collections when the associated
1013 +     * exception is thrown.  The behavior of this operation is
1014 +     * undefined if the specified collection is modified while the
1015 +     * operation is in progress.
1016 +     *
1017 +     * @param c the collection to transfer elements into
1018 +     * @return the number of elements transferred
1019 +     */
1020 +    protected int drainTasksTo(Collection<ForkJoinTask<?>> c) {
1021 +        int n = submissionQueue.drainTo(c);
1022 +        ForkJoinWorkerThread[] ws = workers;
1023 +        if (ws != null) {
1024 +            for (int i = 0; i < ws.length; ++i) {
1025 +                ForkJoinWorkerThread w = ws[i];
1026 +                if (w != null)
1027 +                    n += w.drainTasksTo(c);
1028 +            }
1029 +        }
1030 +        return n;
1031 +    }
1032 +
1033 +    /**
1034       * Returns a string identifying this pool, as well as its state,
1035       * including indications of run state, parallelism level, and
1036       * worker and task counts.
# Line 955 | Line 1074 | public class ForkJoinPool extends Abstra
1074       * Invocation has no additional effect if already shut down.
1075       * Tasks that are in the process of being submitted concurrently
1076       * during the course of this method may or may not be rejected.
1077 +     *
1078       * @throws SecurityException if a security manager exists and
1079       *         the caller is not permitted to modify threads
1080       *         because it does not hold {@link
1081 <     *         java.lang.RuntimePermission}<code>("modifyThread")</code>,
1081 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
1082       */
1083      public void shutdown() {
1084          checkPermission();
# Line 972 | 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 {@code 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}<code>("modifyThread")</code>,
1104 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
1105       */
1106      public List<Runnable> shutdownNow() {
1107          checkPermission();
# Line 987 | Line 1110 | public class ForkJoinPool extends Abstra
1110      }
1111  
1112      /**
1113 <     * Returns <code>true</code> if all tasks have completed following shut down.
1113 >     * Returns {@code true} if all tasks have completed following shut down.
1114       *
1115 <     * @return <code>true</code> 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 <code>true</code> 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 <code>true</code> if terminating
1125 >     * @return {@code true} if terminating
1126       */
1127      public boolean isTerminating() {
1128          return runStateOf(runControl) >= TERMINATING;
1129      }
1130  
1131      /**
1132 <     * Returns <code>true</code> if this pool has been shut down.
1132 >     * Returns {@code true} if this pool has been shut down.
1133       *
1134 <     * @return <code>true</code> 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 1021 | 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 <code>true</code> if this executor terminated and
1148 <     *         <code>false</code> 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 1046 | 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 1058 | 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();
# Line 1077 | Line 1203 | public class ForkJoinPool extends Abstra
1203      }
1204  
1205      /**
1206 <     * Initiate termination.
1206 >     * Initiates termination.
1207       */
1208      private void terminate() {
1209          if (transitionRunStateTo(TERMINATING)) {
# Line 1092 | Line 1218 | public class ForkJoinPool extends Abstra
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 1100 | 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 1109 | 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 1127 | 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 1146 | 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 1155 | 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 1214 | Line 1346 | public class ForkJoinPool extends Abstra
1346          }
1347  
1348          /**
1349 <         * Wake up waiter, returning false if known to already
1349 >         * Wakes up waiter, returning false if known to already
1350           */
1351          boolean signal() {
1352              ForkJoinWorkerThread t = thread;
# Line 1226 | Line 1358 | public class ForkJoinPool extends Abstra
1358          }
1359  
1360          /**
1361 <         * Await release on sync
1361 >         * Awaits release on sync.
1362           */
1363          void awaitSyncRelease(ForkJoinPool p) {
1364              while (thread != null && !p.syncIsReleasable(this))
# Line 1234 | Line 1366 | public class ForkJoinPool extends Abstra
1366          }
1367  
1368          /**
1369 <         * Await resumption as spare
1369 >         * Awaits resumption as spare.
1370           */
1371          void awaitSpareRelease() {
1372              while (thread != null) {
# Line 1248 | Line 1380 | public class ForkJoinPool extends Abstra
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      final long ensureSync() {
# Line 1269 | Line 1402 | public class ForkJoinPool extends Abstra
1402       */
1403      private void signalIdleWorkers() {
1404          long c;
1405 <        do;while (!casEventCount(c = eventCount, c+1));
1405 >        do {} while (!casEventCount(c = eventCount, c+1));
1406          ensureSync();
1407      }
1408  
1409      /**
1410 <     * Signal threads waiting to poll a task. Because method sync
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).
# Line 1293 | Line 1426 | public class ForkJoinPool extends Abstra
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
1431       */
1432      final void sync(ForkJoinWorkerThread w) {
# Line 1323 | Line 1457 | public class ForkJoinPool extends Abstra
1457       * Returns 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
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 true if node can be released
1466       */
1467      final boolean syncIsReleasable(WaitQueueNode node) {
# Line 1361 | Line 1496 | public class ForkJoinPool extends Abstra
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 1381 | 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 1390 | 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 1410 | 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 1434 | Line 1572 | public class ForkJoinPool extends Abstra
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 1451 | Line 1590 | public class ForkJoinPool extends Abstra
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 1485 | 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 1507 | Line 1647 | public class ForkJoinPool extends Abstra
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 1522 | Line 1663 | public class ForkJoinPool extends Abstra
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));
1666 >                do {} while (!casSpareStack(node.next = spareStack, node));
1667                  // block until released by resumeSpare
1668                  node.awaitSpareRelease();
1669                  return true;
# Line 1532 | 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 1550 | Line 1692 | public class ForkJoinPool extends Abstra
1692      }
1693  
1694      /**
1695 <     * Pop and resume all spare threads. Same idea as ensureSync.
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 1568 | 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 1593 | Line 1736 | public class ForkJoinPool extends Abstra
1736      /**
1737       * Interface for extending managed parallelism for tasks running
1738       * in ForkJoinPools. A ManagedBlocker provides two methods.
1739 <     * Method <code>isReleasable</code> must return true if blocking is not
1740 <     * necessary. Method <code>block</code> blocks the current thread
1741 <     * if necessary (perhaps internally invoking isReleasable before
1742 <     * actually blocking.).
1739 >     * Method {@code isReleasable} must return true if blocking is not
1740 >     * necessary. Method {@code block} blocks the current thread if
1741 >     * necessary (perhaps internally invoking {@code isReleasable}
1742 >     * 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());
1614 <     *     }
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 +         *
1766           * @return true if no additional blocking is necessary (i.e.,
1767 <         * if isReleasable would return true).
1767 >         * 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  
# Line 1637 | 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 <     * <code>maintainParallelism</code> is true and the pool supports
1784 >     * {@code maintainParallelism} is true and the pool supports
1785       * it ({@link #getMaintainsParallelism}), this method attempts to
1786 <     * maintain the pool's nominal parallelism. Otherwise if activates
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       *
# Line 1659 | Line 1803 | public class ForkJoinPool extends Abstra
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.
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 1681 | 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
# Line 1721 | Line 1865 | public class ForkJoinPool extends Abstra
1865  
1866      private static long fieldOffset(String fieldName)
1867              throws NoSuchFieldException {
1868 <        return _unsafe.objectFieldOffset
1868 >        return UNSAFE.objectFieldOffset
1869              (ForkJoinPool.class.getDeclaredField(fieldName));
1870      }
1871  
1872 <    static final Unsafe _unsafe;
1872 >    static final Unsafe UNSAFE;
1873      static final long eventCountOffset;
1874      static final long workerCountsOffset;
1875      static final long runControlOffset;
# Line 1734 | Line 1878 | public class ForkJoinPool extends Abstra
1878  
1879      static {
1880          try {
1881 <            _unsafe = getUnsafe();
1881 >            UNSAFE = getUnsafe();
1882              eventCountOffset = fieldOffset("eventCount");
1883              workerCountsOffset = fieldOffset("workerCounts");
1884              runControlOffset = fieldOffset("runControl");
# Line 1746 | Line 1890 | public class ForkJoinPool extends Abstra
1890      }
1891  
1892      private boolean casEventCount(long cmp, long val) {
1893 <        return _unsafe.compareAndSwapLong(this, eventCountOffset, cmp, val);
1893 >        return UNSAFE.compareAndSwapLong(this, eventCountOffset, cmp, val);
1894      }
1895      private boolean casWorkerCounts(int cmp, int val) {
1896 <        return _unsafe.compareAndSwapInt(this, workerCountsOffset, cmp, val);
1896 >        return UNSAFE.compareAndSwapInt(this, workerCountsOffset, cmp, val);
1897      }
1898      private boolean casRunControl(int cmp, int val) {
1899 <        return _unsafe.compareAndSwapInt(this, runControlOffset, cmp, val);
1899 >        return UNSAFE.compareAndSwapInt(this, runControlOffset, cmp, val);
1900      }
1901      private boolean casSpareStack(WaitQueueNode cmp, WaitQueueNode val) {
1902 <        return _unsafe.compareAndSwapObject(this, spareStackOffset, cmp, val);
1902 >        return UNSAFE.compareAndSwapObject(this, spareStackOffset, cmp, val);
1903      }
1904      private boolean casBarrierStack(WaitQueueNode cmp, WaitQueueNode val) {
1905 <        return _unsafe.compareAndSwapObject(this, syncStackOffset, cmp, val);
1905 >        return UNSAFE.compareAndSwapObject(this, syncStackOffset, cmp, val);
1906      }
1907   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines