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.15 by jsr166, Wed Jul 22 20:55:22 2009 UTC vs.
Revision 1.29 by jsr166, Mon Jul 27 21:41:53 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 < * An {@link ExecutorService} for running {@link ForkJoinTask}s.  A
24 < * ForkJoinPool provides the entry point for submissions from
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
# Line 27 | Line 34 | import java.lang.reflect.*;
34   * (eventually blocking if none exist). This makes them efficient when
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
38 < * <tt>setAsyncMode</tt>, a ForkJoinPools may also be appropriate for
39 < * use with fine-grained tasks that are never joined. Otherwise, other
40 < * ExecutorService implementations are typically more appropriate
41 < * choices.
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 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 <code>ManagedBlocker</code> interface enables extension of
48 > * nested {@link ManagedBlocker} interface enables extension of
49   * the kinds of synchronization accommodated.  The target parallelism
50 < * level may also be changed dynamically (<code>setParallelism</code>)
50 > * level may also be changed dynamically ({@link #setParallelism})
51   * and thread construction can be limited using methods
52 < * <code>setMaximumPoolSize</code> and/or
53 < * <code>setMaintainsParallelism</code>.
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 < * <code>getStealCount</code>) 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 < * <code>toString</code> returns indications of pool state in a
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 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 {
71  
# Line 81 | 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      static class  DefaultForkJoinWorkerThreadFactory
# Line 153 | 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 181 | 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 syncStack;
197  
# Line 217 | Line 227 | public class ForkJoinPool extends Abstra
227       * making decisions about creating and suspending spare
228       * threads. Updated only by CAS.  Note: CASes in
229       * updateRunningCount and preJoin assume that running active count
230 <     * is in low word, so need to be modified if this changes
230 >     * is in low word, so need to be modified if this changes.
231       */
232      private volatile int workerCounts;
233  
# Line 226 | 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 271 | Line 283 | public class ForkJoinPool extends Abstra
283      private static int runControlFor(int r, int a)   { return (r << 16) + a; }
284  
285      /**
286 <     * Try incrementing active count; fail on contention. Called by
287 <     * workers before/during executing tasks.
288 <     * @return true on success;
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 boolean tryIncrementActiveCount() {
292          int c = runControl;
# Line 281 | Line 294 | public class ForkJoinPool extends Abstra
294      }
295  
296      /**
297 <     * Try decrementing active count; fail on contention.
298 <     * Possibly trigger termination on success
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 boolean tryDecrementActiveCount() {
# Line 297 | Line 311 | public class ForkJoinPool extends Abstra
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 328 | 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}<code>("modifyThread")</code>,
352 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
353       */
354      public ForkJoinPool() {
355          this(Runtime.getRuntime().availableProcessors(),
# Line 341 | 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}<code>("modifyThread")</code>,
369 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
370       */
371      public ForkJoinPool(int parallelism) {
372          this(parallelism, defaultForkJoinWorkerThreadFactory);
# Line 358 | Line 375 | public class ForkJoinPool extends Abstra
375      /**
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}<code>("modifyThread")</code>,
385 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
386       */
387      public ForkJoinPool(ForkJoinWorkerThreadFactory factory) {
388          this(Runtime.getRuntime().availableProcessors(), factory);
# Line 376 | Line 394 | public class ForkJoinPool extends Abstra
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}<code>("modifyThread")</code>,
402 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
403       */
404      public ForkJoinPool(int parallelism, ForkJoinWorkerThreadFactory factory) {
405          if (parallelism <= 0 || parallelism > MAX_THREADS)
# Line 402 | Line 420 | public class ForkJoinPool extends Abstra
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 421 | 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.
453 <     * Call only under exclusion
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 444 | 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;
# Line 460 | Line 481 | public class ForkJoinPool extends Abstra
481      }
482  
483      /**
484 <     * Initialize workers if necessary
484 >     * Initializes workers if necessary.
485       */
486      final void ensureWorkerInitialization() {
487          ForkJoinWorkerThread[] ws = workers;
# Line 527 | Line 548 | public class ForkJoinPool extends Abstra
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)
# Line 536 | Line 559 | public class ForkJoinPool extends Abstra
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 549 | 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 560 | 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 = new AdaptedRunnable<Void>(task, null);
593 >        doSubmit(job);
594      }
595  
596      public <T> ForkJoinTask<T> submit(Callable<T> task) {
# Line 576 | Line 606 | public class ForkJoinPool extends Abstra
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 = new AdaptedRunnable<Void>(task, null);
614          doSubmit(job);
615          return job;
616      }
617  
618      /**
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 +    public <T> ForkJoinTask<T> submit(ForkJoinTask<T> task) {
628 +        doSubmit(task);
629 +        return task;
630 +    }
631 +
632 +    /**
633       * Adaptor for Runnables. This implements RunnableFuture
634 <     * to be compliant with AbstractExecutorService constraints
634 >     * to be compliant with AbstractExecutorService constraints.
635       */
636      static final class AdaptedRunnable<T> extends ForkJoinTask<T>
637          implements RunnableFuture<T> {
# Line 603 | Line 651 | public class ForkJoinPool extends Abstra
651              return true;
652          }
653          public void run() { invoke(); }
654 +        private static final long serialVersionUID = 5232453952276885070L;
655      }
656  
657      /**
# Line 631 | Line 680 | public class ForkJoinPool extends Abstra
680              }
681          }
682          public void run() { invoke(); }
683 +        private static final long serialVersionUID = 2838392045355241008L;
684      }
685  
686      public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks) {
687 <        ArrayList<ForkJoinTask<T>> ts =
687 >        ArrayList<ForkJoinTask<T>> forkJoinTasks =
688              new ArrayList<ForkJoinTask<T>>(tasks.size());
689 <        for (Callable<T> c : tasks)
690 <            ts.add(new AdaptedCallable<T>(c));
691 <        invoke(new InvokeAll<T>(ts));
692 <        return (List<Future<T>>)(List)ts;
689 >        for (Callable<T> task : tasks)
690 >            forkJoinTasks.add(new AdaptedCallable<T>(task));
691 >        invoke(new InvokeAll<T>(forkJoinTasks));
692 >
693 >        @SuppressWarnings({"unchecked", "rawtypes"})
694 >        List<Future<T>> futures = (List<Future<T>>) (List) forkJoinTasks;
695 >        return futures;
696      }
697  
698      static final class InvokeAll<T> extends RecursiveAction {
699          final ArrayList<ForkJoinTask<T>> tasks;
700          InvokeAll(ArrayList<ForkJoinTask<T>> tasks) { this.tasks = tasks; }
701          public void compute() {
702 <            try { invokeAll(tasks); } catch(Exception ignore) {}
702 >            try { invokeAll(tasks); }
703 >            catch (Exception ignore) {}
704          }
705 +        private static final long serialVersionUID = -7914297376763021607L;
706      }
707  
708      // Configuration and status settings and queries
709  
710      /**
711 <     * Returns the factory used for constructing new workers
711 >     * Returns the factory used for constructing new workers.
712       *
713       * @return the factory used for constructing new workers
714       */
# Line 664 | Line 719 | public class ForkJoinPool extends Abstra
719      /**
720       * Returns the handler for internal worker threads that terminate
721       * due to unrecoverable errors encountered while executing tasks.
722 <     * @return the handler, or null if none
722 >     *
723 >     * @return the handler, or {@code null} if none
724       */
725      public Thread.UncaughtExceptionHandler getUncaughtExceptionHandler() {
726          Thread.UncaughtExceptionHandler h;
# Line 685 | Line 741 | public class ForkJoinPool extends Abstra
741       * as handler.
742       *
743       * @param h the new handler
744 <     * @return the old handler, or null if none
744 >     * @return the old handler, or {@code null} if none
745       * @throws SecurityException if a security manager exists and
746       *         the caller is not permitted to modify threads
747       *         because it does not hold {@link
748 <     *         java.lang.RuntimePermission}<code>("modifyThread")</code>,
748 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
749       */
750      public Thread.UncaughtExceptionHandler
751          setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler h) {
# Line 716 | Line 772 | public class ForkJoinPool extends Abstra
772  
773  
774      /**
775 <     * Sets the target paralleism level of this pool.
775 >     * Sets the target parallelism level of this pool.
776 >     *
777       * @param parallelism the target parallelism
778       * @throws IllegalArgumentException if parallelism less than or
779 <     * equal to zero or greater than maximum size bounds.
779 >     * equal to zero or greater than maximum size bounds
780       * @throws SecurityException if a security manager exists and
781       *         the caller is not permitted to modify threads
782       *         because it does not hold {@link
783 <     *         java.lang.RuntimePermission}<code>("modifyThread")</code>,
783 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
784       */
785      public void setParallelism(int parallelism) {
786          checkPermission();
# Line 758 | Line 815 | public class ForkJoinPool extends Abstra
815      /**
816       * Returns the number of worker threads that have started but not
817       * yet terminated.  This result returned by this method may differ
818 <     * from <code>getParallelism</code> when threads are created to
818 >     * from {@link #getParallelism} when threads are created to
819       * maintain parallelism when others are cooperatively blocked.
820       *
821       * @return the number of worker threads
# Line 770 | Line 827 | public class ForkJoinPool extends Abstra
827      /**
828       * Returns the maximum number of threads allowed to exist in the
829       * pool, even if there are insufficient unblocked running threads.
830 +     *
831       * @return the maximum
832       */
833      public int getMaximumPoolSize() {
# Line 781 | Line 839 | public class ForkJoinPool extends Abstra
839       * pool, even if there are insufficient unblocked running threads.
840       * Setting this value has no effect on current pool size. It
841       * controls construction of new threads.
842 +     *
843       * @throws IllegalArgumentException if negative or greater then
844 <     * internal implementation limit.
844 >     * internal implementation limit
845       */
846      public void setMaximumPoolSize(int newMax) {
847          if (newMax < 0 || newMax > MAX_THREADS)
# Line 792 | Line 851 | public class ForkJoinPool extends Abstra
851  
852  
853      /**
854 <     * Returns true if this pool dynamically maintains its target
855 <     * parallelism level. If false, new threads are added only to
856 <     * avoid possible starvation.
857 <     * This setting is by default true;
858 <     * @return true if maintains parallelism
854 >     * Returns {@code true} if this pool dynamically maintains its
855 >     * target parallelism level. If false, new threads are added only
856 >     * to avoid possible starvation.  This setting is by default true.
857 >     *
858 >     * @return {@code true} if maintains parallelism
859       */
860      public boolean getMaintainsParallelism() {
861          return maintainsParallelism;
# Line 806 | Line 865 | public class ForkJoinPool extends Abstra
865       * Sets whether this pool dynamically maintains its target
866       * parallelism level. If false, new threads are added only to
867       * avoid possible starvation.
868 <     * @param enable true to maintains parallelism
868 >     *
869 >     * @param enable {@code true} to maintain parallelism
870       */
871      public void setMaintainsParallelism(boolean enable) {
872          maintainsParallelism = enable;
# Line 817 | Line 877 | public class ForkJoinPool extends Abstra
877       * tasks that are never joined. This mode may be more appropriate
878       * than default locally stack-based mode in applications in which
879       * worker threads only process asynchronous tasks.  This method is
880 <     * designed to be invoked only when pool is quiescent, and
880 >     * designed to be invoked only when the pool is quiescent, and
881       * typically only before any tasks are submitted. The effects of
882 <     * invocations at ather times may be unpredictable.
882 >     * invocations at other times may be unpredictable.
883       *
884 <     * @param async if true, use locally FIFO scheduling
885 <     * @return the previous mode.
884 >     * @param async if {@code true}, use locally FIFO scheduling
885 >     * @return the previous mode
886 >     * @see #getAsyncMode
887       */
888      public boolean setAsyncMode(boolean async) {
889          boolean oldMode = locallyFifo;
# Line 839 | Line 900 | public class ForkJoinPool extends Abstra
900      }
901  
902      /**
903 <     * Returns true if this pool uses local first-in-first-out
904 <     * scheduling mode for forked tasks that are never joined.
903 >     * Returns {@code true} if this pool uses local first-in-first-out
904 >     * scheduling mode for forked tasks that are never joined.
905       *
906 <     * @return true if this pool uses async mode.
906 >     * @return {@code true} if this pool uses async mode
907 >     * @see #setAsyncMode
908       */
909      public boolean getAsyncMode() {
910          return locallyFifo;
# Line 863 | Line 925 | public class ForkJoinPool extends Abstra
925       * Returns an estimate of the number of threads that are currently
926       * stealing or executing tasks. This method may overestimate the
927       * number of active threads.
928 <     * @return the number of active threads.
928 >     *
929 >     * @return the number of active threads
930       */
931      public int getActiveThreadCount() {
932          return activeCountOf(runControl);
# Line 873 | Line 936 | public class ForkJoinPool extends Abstra
936       * Returns an estimate of the number of threads that are currently
937       * idle waiting for tasks. This method may underestimate the
938       * number of idle threads.
939 <     * @return the number of idle threads.
939 >     *
940 >     * @return the number of idle threads
941       */
942      final int getIdleThreadCount() {
943          int c = runningCountOf(workerCounts) - activeCountOf(runControl);
944 <        return (c <= 0)? 0 : c;
944 >        return (c <= 0) ? 0 : c;
945      }
946  
947      /**
948 <     * Returns true if all worker threads are currently idle. An idle
949 <     * worker is one that cannot obtain a task to execute because none
950 <     * are available to steal from other threads, and there are no
951 <     * pending submissions to the pool. This method is conservative:
952 <     * It might not return true immediately upon idleness of all
953 <     * threads, but will eventually become true if threads remain
954 <     * inactive.
955 <     * @return true if all threads are currently idle
948 >     * Returns {@code true} if all worker threads are currently idle.
949 >     * An idle worker is one that cannot obtain a task to execute
950 >     * because none are available to steal from other threads, and
951 >     * there are no pending submissions to the pool. This method is
952 >     * conservative; it might not return {@code true} immediately upon
953 >     * idleness of all threads, but will eventually become true if
954 >     * threads remain inactive.
955 >     *
956 >     * @return {@code true} if all threads are currently idle
957       */
958      public boolean isQuiescent() {
959          return activeCountOf(runControl) == 0;
# Line 899 | Line 964 | public class ForkJoinPool extends Abstra
964       * one thread's work queue by another. The reported value
965       * underestimates the actual total number of steals when the pool
966       * is not quiescent. This value may be useful for monitoring and
967 <     * tuning fork/join programs: In general, steal counts should be
967 >     * tuning fork/join programs: in general, steal counts should be
968       * high enough to keep threads busy, but low enough to avoid
969       * overhead and contention across threads.
970 <     * @return the number of steals.
970 >     *
971 >     * @return the number of steals
972       */
973      public long getStealCount() {
974          return stealCount.get();
975      }
976  
977      /**
978 <     * Accumulate steal count from a worker. Call only
979 <     * when worker known to be idle.
978 >     * Accumulates steal count from a worker.
979 >     * Call only when worker known to be idle.
980       */
981      private void updateStealCount(ForkJoinWorkerThread w) {
982          int sc = w.getAndClearStealCount();
# Line 925 | Line 991 | public class ForkJoinPool extends Abstra
991       * an approximation, obtained by iterating across all threads in
992       * the pool. This method may be useful for tuning task
993       * granularities.
994 <     * @return the number of queued tasks.
994 >     *
995 >     * @return the number of queued tasks
996       */
997      public long getQueuedTaskCount() {
998          long count = 0;
# Line 944 | Line 1011 | public class ForkJoinPool extends Abstra
1011       * Returns an estimate of the number tasks submitted to this pool
1012       * that have not yet begun executing. This method takes time
1013       * proportional to the number of submissions.
1014 <     * @return the number of queued submissions.
1014 >     *
1015 >     * @return the number of queued submissions
1016       */
1017      public int getQueuedSubmissionCount() {
1018          return submissionQueue.size();
1019      }
1020  
1021      /**
1022 <     * Returns true if there are any tasks submitted to this pool
1023 <     * that have not yet begun executing.
1024 <     * @return <code>true</code> if there are any queued submissions.
1022 >     * Returns {@code true} if there are any tasks submitted to this
1023 >     * pool that have not yet begun executing.
1024 >     *
1025 >     * @return {@code true} if there are any queued submissions
1026       */
1027      public boolean hasQueuedSubmissions() {
1028          return !submissionQueue.isEmpty();
# Line 963 | Line 1032 | public class ForkJoinPool extends Abstra
1032       * Removes and returns the next unexecuted submission if one is
1033       * available.  This method may be useful in extensions to this
1034       * class that re-assign work in systems with multiple pools.
1035 <     * @return the next submission, or null if none
1035 >     *
1036 >     * @return the next submission, or {@code null} if none
1037       */
1038      protected ForkJoinTask<?> pollSubmission() {
1039          return submissionQueue.poll();
# Line 973 | Line 1043 | public class ForkJoinPool extends Abstra
1043       * Removes all available unexecuted submitted and forked tasks
1044       * from scheduling queues and adds them to the given collection,
1045       * without altering their execution status. These may include
1046 <     * artifically generated or wrapped tasks. This method id designed
1046 >     * artificially generated or wrapped tasks. This method is designed
1047       * to be invoked only when the pool is known to be
1048       * quiescent. Invocations at other times may not remove all
1049       * tasks. A failure encountered while attempting to add elements
1050 <     * to collection <tt>c</tt> may result in elements being in
1050 >     * to collection {@code c} may result in elements being in
1051       * neither, either or both collections when the associated
1052       * exception is thrown.  The behavior of this operation is
1053       * undefined if the specified collection is modified while the
1054       * operation is in progress.
1055 +     *
1056       * @param c the collection to transfer elements into
1057       * @return the number of elements transferred
1058       */
# Line 1042 | Line 1113 | public class ForkJoinPool extends Abstra
1113       * Invocation has no additional effect if already shut down.
1114       * Tasks that are in the process of being submitted concurrently
1115       * during the course of this method may or may not be rejected.
1116 +     *
1117       * @throws SecurityException if a security manager exists and
1118       *         the caller is not permitted to modify threads
1119       *         because it does not hold {@link
1120 <     *         java.lang.RuntimePermission}<code>("modifyThread")</code>,
1120 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
1121       */
1122      public void shutdown() {
1123          checkPermission();
# Line 1061 | Line 1133 | public class ForkJoinPool extends Abstra
1133       * method may or may not be rejected. Unlike some other executors,
1134       * this method cancels rather than collects non-executed tasks
1135       * upon termination, so always returns an empty list. However, you
1136 <     * can use method <code>drainTasksTo</code> before invoking this
1136 >     * can use method {@link #drainTasksTo} before invoking this
1137       * method to transfer unexecuted tasks to another collection.
1138 +     *
1139       * @return an empty list
1140       * @throws SecurityException if a security manager exists and
1141       *         the caller is not permitted to modify threads
1142       *         because it does not hold {@link
1143 <     *         java.lang.RuntimePermission}<code>("modifyThread")</code>,
1143 >     *         java.lang.RuntimePermission}{@code ("modifyThread")}
1144       */
1145      public List<Runnable> shutdownNow() {
1146          checkPermission();
# Line 1076 | Line 1149 | public class ForkJoinPool extends Abstra
1149      }
1150  
1151      /**
1152 <     * Returns <code>true</code> if all tasks have completed following shut down.
1152 >     * Returns {@code true} if all tasks have completed following shut down.
1153       *
1154 <     * @return <code>true</code> if all tasks have completed following shut down
1154 >     * @return {@code true} if all tasks have completed following shut down
1155       */
1156      public boolean isTerminated() {
1157          return runStateOf(runControl) == TERMINATED;
1158      }
1159  
1160      /**
1161 <     * Returns <code>true</code> if the process of termination has
1161 >     * Returns {@code true} if the process of termination has
1162       * commenced but possibly not yet completed.
1163       *
1164 <     * @return <code>true</code> if terminating
1164 >     * @return {@code true} if terminating
1165       */
1166      public boolean isTerminating() {
1167          return runStateOf(runControl) >= TERMINATING;
1168      }
1169  
1170      /**
1171 <     * Returns <code>true</code> if this pool has been shut down.
1171 >     * Returns {@code true} if this pool has been shut down.
1172       *
1173 <     * @return <code>true</code> if this pool has been shut down
1173 >     * @return {@code true} if this pool has been shut down
1174       */
1175      public boolean isShutdown() {
1176          return runStateOf(runControl) >= SHUTDOWN;
# Line 1110 | Line 1183 | public class ForkJoinPool extends Abstra
1183       *
1184       * @param timeout the maximum time to wait
1185       * @param unit the time unit of the timeout argument
1186 <     * @return <code>true</code> if this executor terminated and
1187 <     *         <code>false</code> if the timeout elapsed before termination
1186 >     * @return {@code true} if this executor terminated and
1187 >     *         {@code false} if the timeout elapsed before termination
1188       * @throws InterruptedException if interrupted while waiting
1189       */
1190      public boolean awaitTermination(long timeout, TimeUnit unit)
# Line 1135 | Line 1208 | public class ForkJoinPool extends Abstra
1208      // Shutdown and termination support
1209  
1210      /**
1211 <     * Callback from terminating worker. Null out the corresponding
1212 <     * workers slot, and if terminating, try to terminate, else try to
1213 <     * shrink workers array.
1211 >     * Callback from terminating worker. Nulls out the corresponding
1212 >     * workers slot, and if terminating, tries to terminate; else
1213 >     * tries to shrink workers array.
1214 >     *
1215       * @param w the worker
1216       */
1217      final void workerTerminated(ForkJoinWorkerThread w) {
# Line 1168 | Line 1242 | public class ForkJoinPool extends Abstra
1242      }
1243  
1244      /**
1245 <     * Initiate termination.
1245 >     * Initiates termination.
1246       */
1247      private void terminate() {
1248          if (transitionRunStateTo(TERMINATING)) {
# Line 1183 | Line 1257 | public class ForkJoinPool extends Abstra
1257      }
1258  
1259      /**
1260 <     * Possibly terminate when on shutdown state
1260 >     * Possibly terminates when on shutdown state.
1261       */
1262      private void terminateOnShutdown() {
1263          if (!hasQueuedSubmissions() && canTerminateOnShutdown(runControl))
# Line 1191 | Line 1265 | public class ForkJoinPool extends Abstra
1265      }
1266  
1267      /**
1268 <     * Clear out and cancel submissions
1268 >     * Clears out and cancels submissions.
1269       */
1270      private void cancelQueuedSubmissions() {
1271          ForkJoinTask<?> task;
# Line 1200 | Line 1274 | public class ForkJoinPool extends Abstra
1274      }
1275  
1276      /**
1277 <     * Clean out worker queues.
1277 >     * Cleans out worker queues.
1278       */
1279      private void cancelQueuedWorkerTasks() {
1280          final ReentrantLock lock = this.workerLock;
# Line 1220 | Line 1294 | public class ForkJoinPool extends Abstra
1294      }
1295  
1296      /**
1297 <     * Set each worker's status to terminating. Requires lock to avoid
1298 <     * conflicts with add/remove
1297 >     * Sets each worker's status to terminating. Requires lock to avoid
1298 >     * conflicts with add/remove.
1299       */
1300      private void stopAllWorkers() {
1301          final ReentrantLock lock = this.workerLock;
# Line 1241 | Line 1315 | public class ForkJoinPool extends Abstra
1315      }
1316  
1317      /**
1318 <     * Interrupt all unterminated workers.  This is not required for
1318 >     * Interrupts all unterminated workers.  This is not required for
1319       * sake of internal control, but may help unstick user code during
1320       * shutdown.
1321       */
# Line 1311 | Line 1385 | public class ForkJoinPool extends Abstra
1385          }
1386  
1387          /**
1388 <         * Wake up waiter, returning false if known to already
1388 >         * Wakes up waiter, returning false if known to already
1389           */
1390          boolean signal() {
1391              ForkJoinWorkerThread t = thread;
# Line 1323 | Line 1397 | public class ForkJoinPool extends Abstra
1397          }
1398  
1399          /**
1400 <         * Await release on sync
1400 >         * Awaits release on sync.
1401           */
1402          void awaitSyncRelease(ForkJoinPool p) {
1403              while (thread != null && !p.syncIsReleasable(this))
# Line 1331 | Line 1405 | public class ForkJoinPool extends Abstra
1405          }
1406  
1407          /**
1408 <         * Await resumption as spare
1408 >         * Awaits resumption as spare.
1409           */
1410          void awaitSpareRelease() {
1411              while (thread != null) {
# Line 1345 | Line 1419 | public class ForkJoinPool extends Abstra
1419       * Ensures that no thread is waiting for count to advance from the
1420       * current value of eventCount read on entry to this method, by
1421       * releasing waiting threads if necessary.
1422 +     *
1423       * @return the count
1424       */
1425      final long ensureSync() {
# Line 1366 | Line 1441 | public class ForkJoinPool extends Abstra
1441       */
1442      private void signalIdleWorkers() {
1443          long c;
1444 <        do;while (!casEventCount(c = eventCount, c+1));
1444 >        do {} while (!casEventCount(c = eventCount, c+1));
1445          ensureSync();
1446      }
1447  
1448      /**
1449 <     * Signal threads waiting to poll a task. Because method sync
1449 >     * Signals threads waiting to poll a task. Because method sync
1450       * rechecks availability, it is OK to only proceed if queue
1451       * appears to be non-empty, and OK to skip under contention to
1452       * increment count (since some other thread succeeded).
# Line 1390 | Line 1465 | public class ForkJoinPool extends Abstra
1465       * Waits until event count advances from last value held by
1466       * caller, or if excess threads, caller is resumed as spare, or
1467       * caller or pool is terminating. Updates caller's event on exit.
1468 +     *
1469       * @param w the calling worker thread
1470       */
1471      final void sync(ForkJoinWorkerThread w) {
# Line 1417 | Line 1493 | public class ForkJoinPool extends Abstra
1493      }
1494  
1495      /**
1496 <     * Returns true if worker waiting on sync can proceed:
1496 >     * Returns {@code true} if worker waiting on sync can proceed:
1497       *  - on signal (thread == null)
1498       *  - on event count advance (winning race to notify vs signaller)
1499 <     *  - on Interrupt
1499 >     *  - on interrupt
1500       *  - if the first queued node, we find work available
1501       * If node was not signalled and event count not advanced on exit,
1502       * then we also help advance event count.
1503 <     * @return true if node can be released
1503 >     *
1504 >     * @return {@code true} if node can be released
1505       */
1506      final boolean syncIsReleasable(WaitQueueNode node) {
1507          long prev = node.count;
# Line 1443 | Line 1520 | public class ForkJoinPool extends Abstra
1520      }
1521  
1522      /**
1523 <     * Returns true if a new sync event occurred since last call to
1524 <     * sync or this method, if so, updating caller's count.
1523 >     * Returns {@code true} if a new sync event occurred since last
1524 >     * call to sync or this method, if so, updating caller's count.
1525       */
1526      final boolean hasNewSyncEvent(ForkJoinWorkerThread w) {
1527          long lc = w.lastEventCount;
# Line 1458 | Line 1535 | public class ForkJoinPool extends Abstra
1535      //  Parallelism maintenance
1536  
1537      /**
1538 <     * Decrement running count; if too low, add spare.
1538 >     * Decrements running count; if too low, adds spare.
1539       *
1540       * Conceptually, all we need to do here is add or resume a
1541       * spare thread when one is about to block (and remove or
1542       * suspend it later when unblocked -- see suspendIfSpare).
1543       * However, implementing this idea requires coping with
1544 <     * several problems: We have imperfect information about the
1544 >     * several problems: we have imperfect information about the
1545       * states of threads. Some count updates can and usually do
1546       * lag run state changes, despite arrangements to keep them
1547       * accurate (for example, when possible, updating counts
# Line 1478 | Line 1555 | public class ForkJoinPool extends Abstra
1555       * only be suspended or removed when they are idle, not
1556       * immediately when they aren't needed. So adding threads will
1557       * raise parallelism level for longer than necessary.  Also,
1558 <     * FJ applications often enounter highly transient peaks when
1558 >     * FJ applications often encounter highly transient peaks when
1559       * many threads are blocked joining, but for less time than it
1560       * takes to create or resume spares.
1561       *
# Line 1487 | Line 1564 | public class ForkJoinPool extends Abstra
1564       * target counts, else create only to avoid starvation
1565       * @return true if joinMe known to be done
1566       */
1567 <    final boolean preJoin(ForkJoinTask<?> joinMe, boolean maintainParallelism) {
1567 >    final boolean preJoin(ForkJoinTask<?> joinMe,
1568 >                          boolean maintainParallelism) {
1569          maintainParallelism &= maintainsParallelism; // overrride
1570          boolean dec = false;  // true when running count decremented
1571          while (spareStack == null || !tryResumeSpare(dec)) {
1572              int counts = workerCounts;
1573 <            if (dec || (dec = casWorkerCounts(counts, --counts))) { // CAS cheat
1573 >            if (dec || (dec = casWorkerCounts(counts, --counts))) {
1574 >                // CAS cheat
1575                  if (!needSpare(counts, maintainParallelism))
1576                      break;
1577                  if (joinMe.status < 0)
# Line 1526 | Line 1605 | public class ForkJoinPool extends Abstra
1605      }
1606  
1607      /**
1608 <     * Returns true if a spare thread appears to be needed.  If
1609 <     * maintaining parallelism, returns true when the deficit in
1608 >     * Returns {@code true} if a spare thread appears to be needed.
1609 >     * If maintaining parallelism, returns true when the deficit in
1610       * running threads is more than the surplus of total threads, and
1611       * there is apparently some work to do.  This self-limiting rule
1612       * means that the more threads that have already been added, the
1613       * less parallelism we will tolerate before adding another.
1614 +     *
1615       * @param counts current worker counts
1616       * @param maintainParallelism try to maintain parallelism
1617       */
# Line 1549 | Line 1629 | public class ForkJoinPool extends Abstra
1629      }
1630  
1631      /**
1632 <     * Add a spare worker if lock available and no more than the
1633 <     * expected numbers of threads exist
1632 >     * Adds a spare worker if lock available and no more than the
1633 >     * expected numbers of threads exist.
1634 >     *
1635       * @return true if successful
1636       */
1637      private boolean tryAddSpare(int expectedCounts) {
# Line 1583 | Line 1664 | public class ForkJoinPool extends Abstra
1664      }
1665  
1666      /**
1667 <     * Add the kth spare worker. On entry, pool coounts are already
1667 >     * Adds the kth spare worker. On entry, pool counts are already
1668       * adjusted to reflect addition.
1669       */
1670      private void createAndStartSpare(int k) {
# Line 1605 | Line 1686 | public class ForkJoinPool extends Abstra
1686      }
1687  
1688      /**
1689 <     * Suspend calling thread w if there are excess threads.  Called
1690 <     * only from sync.  Spares are enqueued in a Treiber stack
1691 <     * using the same WaitQueueNodes as barriers.  They are resumed
1692 <     * mainly in preJoin, but are also woken on pool events that
1693 <     * require all threads to check run state.
1689 >     * Suspends calling thread w if there are excess threads.  Called
1690 >     * only from sync.  Spares are enqueued in a Treiber stack using
1691 >     * the same WaitQueueNodes as barriers.  They are resumed mainly
1692 >     * in preJoin, but are also woken on pool events that require all
1693 >     * threads to check run state.
1694 >     *
1695       * @param w the caller
1696       */
1697      private boolean suspendIfSpare(ForkJoinWorkerThread w) {
# Line 1620 | Line 1702 | public class ForkJoinPool extends Abstra
1702                  node = new WaitQueueNode(0, w);
1703              if (casWorkerCounts(s, s-1)) { // representation-dependent
1704                  // push onto stack
1705 <                do;while (!casSpareStack(node.next = spareStack, node));
1705 >                do {} while (!casSpareStack(node.next = spareStack, node));
1706                  // block until released by resumeSpare
1707                  node.awaitSpareRelease();
1708                  return true;
# Line 1630 | Line 1712 | public class ForkJoinPool extends Abstra
1712      }
1713  
1714      /**
1715 <     * Try to pop and resume a spare thread.
1715 >     * Tries to pop and resume a spare thread.
1716 >     *
1717       * @param updateCount if true, increment running count on success
1718       * @return true if successful
1719       */
# Line 1648 | Line 1731 | public class ForkJoinPool extends Abstra
1731      }
1732  
1733      /**
1734 <     * Pop and resume all spare threads. Same idea as ensureSync.
1734 >     * Pops and resumes all spare threads. Same idea as ensureSync.
1735 >     *
1736       * @return true if any spares released
1737       */
1738      private boolean resumeAllSpares() {
# Line 1666 | Line 1750 | public class ForkJoinPool extends Abstra
1750      }
1751  
1752      /**
1753 <     * Pop and shutdown excessive spare threads. Call only while
1753 >     * Pops and shuts down excessive spare threads. Call only while
1754       * holding lock. This is not guaranteed to eliminate all excess
1755       * threads, only those suspended as spares, which are the ones
1756       * unlikely to be needed in the future.
# Line 1691 | Line 1775 | public class ForkJoinPool extends Abstra
1775      /**
1776       * Interface for extending managed parallelism for tasks running
1777       * in ForkJoinPools. A ManagedBlocker provides two methods.
1778 <     * Method <code>isReleasable</code> must return true if blocking is not
1779 <     * necessary. Method <code>block</code> blocks the current thread
1780 <     * if necessary (perhaps internally invoking isReleasable before
1781 <     * actually blocking.).
1778 >     * Method {@code isReleasable} must return {@code true} if
1779 >     * blocking is not necessary. Method {@code block} blocks the
1780 >     * current thread if necessary (perhaps internally invoking
1781 >     * {@code isReleasable} before actually blocking.).
1782 >     *
1783       * <p>For example, here is a ManagedBlocker based on a
1784       * ReentrantLock:
1785 <     * <pre>
1786 <     *   class ManagedLocker implements ManagedBlocker {
1787 <     *     final ReentrantLock lock;
1788 <     *     boolean hasLock = false;
1789 <     *     ManagedLocker(ReentrantLock lock) { this.lock = lock; }
1790 <     *     public boolean block() {
1791 <     *        if (!hasLock)
1792 <     *           lock.lock();
1793 <     *        return true;
1709 <     *     }
1710 <     *     public boolean isReleasable() {
1711 <     *        return hasLock || (hasLock = lock.tryLock());
1712 <     *     }
1785 >     *  <pre> {@code
1786 >     * class ManagedLocker implements ManagedBlocker {
1787 >     *   final ReentrantLock lock;
1788 >     *   boolean hasLock = false;
1789 >     *   ManagedLocker(ReentrantLock lock) { this.lock = lock; }
1790 >     *   public boolean block() {
1791 >     *     if (!hasLock)
1792 >     *       lock.lock();
1793 >     *     return true;
1794       *   }
1795 <     * </pre>
1795 >     *   public boolean isReleasable() {
1796 >     *     return hasLock || (hasLock = lock.tryLock());
1797 >     *   }
1798 >     * }}</pre>
1799       */
1800      public static interface ManagedBlocker {
1801          /**
1802           * Possibly blocks the current thread, for example waiting for
1803           * a lock or condition.
1804 <         * @return true if no additional blocking is necessary (i.e.,
1805 <         * if isReleasable would return true).
1804 >         *
1805 >         * @return {@code true} if no additional blocking is necessary
1806 >         * (i.e., if isReleasable would return true)
1807           * @throws InterruptedException if interrupted while waiting
1808 <         * (the method is not required to do so, but is allowe to).
1808 >         * (the method is not required to do so, but is allowed to)
1809           */
1810          boolean block() throws InterruptedException;
1811  
1812          /**
1813 <         * Returns true if blocking is unnecessary.
1813 >         * Returns {@code true} if blocking is unnecessary.
1814           */
1815          boolean isReleasable();
1816      }
# Line 1735 | Line 1820 | public class ForkJoinPool extends Abstra
1820       * is a ForkJoinWorkerThread, this method possibly arranges for a
1821       * spare thread to be activated if necessary to ensure parallelism
1822       * while the current thread is blocked.  If
1823 <     * <code>maintainParallelism</code> is true and the pool supports
1823 >     * {@code maintainParallelism} is {@code true} and the pool supports
1824       * it ({@link #getMaintainsParallelism}), this method attempts to
1825 <     * maintain the pool's nominal parallelism. Otherwise if activates
1825 >     * maintain the pool's nominal parallelism. Otherwise it activates
1826       * a thread only if necessary to avoid complete starvation. This
1827       * option may be preferable when blockages use timeouts, or are
1828       * almost always brief.
1829       *
1830       * <p> If the caller is not a ForkJoinTask, this method is behaviorally
1831       * equivalent to
1832 <     * <pre>
1833 <     *   while (!blocker.isReleasable())
1834 <     *      if (blocker.block())
1835 <     *         return;
1836 <     * </pre>
1832 >     *  <pre> {@code
1833 >     * while (!blocker.isReleasable())
1834 >     *   if (blocker.block())
1835 >     *     return;
1836 >     * }</pre>
1837       * If the caller is a ForkJoinTask, then the pool may first
1838       * be expanded to ensure parallelism, and later adjusted.
1839       *
1840       * @param blocker the blocker
1841 <     * @param maintainParallelism if true and supported by this pool,
1842 <     * attempt to maintain the pool's nominal parallelism; otherwise
1843 <     * activate a thread only if necessary to avoid complete
1844 <     * starvation.
1845 <     * @throws InterruptedException if blocker.block did so.
1841 >     * @param maintainParallelism if {@code true} and supported by
1842 >     * this pool, attempt to maintain the pool's nominal parallelism;
1843 >     * otherwise activate a thread only if necessary to avoid
1844 >     * complete starvation.
1845 >     * @throws InterruptedException if blocker.block did so
1846       */
1847      public static void managedBlock(ManagedBlocker blocker,
1848                                      boolean maintainParallelism)
1849          throws InterruptedException {
1850          Thread t = Thread.currentThread();
1851 <        ForkJoinPool pool = (t instanceof ForkJoinWorkerThread?
1852 <                             ((ForkJoinWorkerThread)t).pool : null);
1851 >        ForkJoinPool pool = ((t instanceof ForkJoinWorkerThread) ?
1852 >                             ((ForkJoinWorkerThread) t).pool : null);
1853          if (!blocker.isReleasable()) {
1854              try {
1855                  if (pool == null ||
# Line 1779 | Line 1864 | public class ForkJoinPool extends Abstra
1864  
1865      private static void awaitBlocker(ManagedBlocker blocker)
1866          throws InterruptedException {
1867 <        do;while (!blocker.isReleasable() && !blocker.block());
1867 >        do {} while (!blocker.isReleasable() && !blocker.block());
1868      }
1869  
1870      // AbstractExecutorService overrides
1871  
1872      protected <T> RunnableFuture<T> newTaskFor(Runnable runnable, T value) {
1873 <        return new AdaptedRunnable(runnable, value);
1873 >        return new AdaptedRunnable<T>(runnable, value);
1874      }
1875  
1876      protected <T> RunnableFuture<T> newTaskFor(Callable<T> callable) {
1877 <        return new AdaptedCallable(callable);
1793 <    }
1794 <
1795 <
1796 <    // Temporary Unsafe mechanics for preliminary release
1797 <    private static Unsafe getUnsafe() throws Throwable {
1798 <        try {
1799 <            return Unsafe.getUnsafe();
1800 <        } catch (SecurityException se) {
1801 <            try {
1802 <                return java.security.AccessController.doPrivileged
1803 <                    (new java.security.PrivilegedExceptionAction<Unsafe>() {
1804 <                        public Unsafe run() throws Exception {
1805 <                            return getUnsafePrivileged();
1806 <                        }});
1807 <            } catch (java.security.PrivilegedActionException e) {
1808 <                throw e.getCause();
1809 <            }
1810 <        }
1811 <    }
1812 <
1813 <    private static Unsafe getUnsafePrivileged()
1814 <            throws NoSuchFieldException, IllegalAccessException {
1815 <        Field f = Unsafe.class.getDeclaredField("theUnsafe");
1816 <        f.setAccessible(true);
1817 <        return (Unsafe) f.get(null);
1818 <    }
1819 <
1820 <    private static long fieldOffset(String fieldName)
1821 <            throws NoSuchFieldException {
1822 <        return _unsafe.objectFieldOffset
1823 <            (ForkJoinPool.class.getDeclaredField(fieldName));
1877 >        return new AdaptedCallable<T>(callable);
1878      }
1879  
1880 <    static final Unsafe _unsafe;
1827 <    static final long eventCountOffset;
1828 <    static final long workerCountsOffset;
1829 <    static final long runControlOffset;
1830 <    static final long syncStackOffset;
1831 <    static final long spareStackOffset;
1880 >    // Unsafe mechanics
1881  
1882 <    static {
1883 <        try {
1884 <            _unsafe = getUnsafe();
1885 <            eventCountOffset = fieldOffset("eventCount");
1886 <            workerCountsOffset = fieldOffset("workerCounts");
1887 <            runControlOffset = fieldOffset("runControl");
1888 <            syncStackOffset = fieldOffset("syncStack");
1889 <            spareStackOffset = fieldOffset("spareStack");
1890 <        } catch (Throwable e) {
1891 <            throw new RuntimeException("Could not initialize intrinsics", e);
1892 <        }
1844 <    }
1882 >    private static final sun.misc.Unsafe UNSAFE = getUnsafe();
1883 >    private static final long eventCountOffset =
1884 >        objectFieldOffset("eventCount", ForkJoinPool.class);
1885 >    private static final long workerCountsOffset =
1886 >        objectFieldOffset("workerCounts", ForkJoinPool.class);
1887 >    private static final long runControlOffset =
1888 >        objectFieldOffset("runControl", ForkJoinPool.class);
1889 >    private static final long syncStackOffset =
1890 >        objectFieldOffset("syncStack",ForkJoinPool.class);
1891 >    private static final long spareStackOffset =
1892 >        objectFieldOffset("spareStack", ForkJoinPool.class);
1893  
1894      private boolean casEventCount(long cmp, long val) {
1895 <        return _unsafe.compareAndSwapLong(this, eventCountOffset, cmp, val);
1895 >        return UNSAFE.compareAndSwapLong(this, eventCountOffset, cmp, val);
1896      }
1897      private boolean casWorkerCounts(int cmp, int val) {
1898 <        return _unsafe.compareAndSwapInt(this, workerCountsOffset, cmp, val);
1898 >        return UNSAFE.compareAndSwapInt(this, workerCountsOffset, cmp, val);
1899      }
1900      private boolean casRunControl(int cmp, int val) {
1901 <        return _unsafe.compareAndSwapInt(this, runControlOffset, cmp, val);
1901 >        return UNSAFE.compareAndSwapInt(this, runControlOffset, cmp, val);
1902      }
1903      private boolean casSpareStack(WaitQueueNode cmp, WaitQueueNode val) {
1904 <        return _unsafe.compareAndSwapObject(this, spareStackOffset, cmp, val);
1904 >        return UNSAFE.compareAndSwapObject(this, spareStackOffset, cmp, val);
1905      }
1906      private boolean casBarrierStack(WaitQueueNode cmp, WaitQueueNode val) {
1907 <        return _unsafe.compareAndSwapObject(this, syncStackOffset, cmp, val);
1907 >        return UNSAFE.compareAndSwapObject(this, syncStackOffset, cmp, val);
1908 >    }
1909 >
1910 >    private static long objectFieldOffset(String field, Class<?> klazz) {
1911 >        try {
1912 >            return UNSAFE.objectFieldOffset(klazz.getDeclaredField(field));
1913 >        } catch (NoSuchFieldException e) {
1914 >            // Convert Exception to corresponding Error
1915 >            NoSuchFieldError error = new NoSuchFieldError(field);
1916 >            error.initCause(e);
1917 >            throw error;
1918 >        }
1919 >    }
1920 >
1921 >    /**
1922 >     * Returns a sun.misc.Unsafe.  Suitable for use in a 3rd party package.
1923 >     * Replace with a simple call to Unsafe.getUnsafe when integrating
1924 >     * into a jdk.
1925 >     *
1926 >     * @return a sun.misc.Unsafe
1927 >     */
1928 >    private static sun.misc.Unsafe getUnsafe() {
1929 >        try {
1930 >            return sun.misc.Unsafe.getUnsafe();
1931 >        } catch (SecurityException se) {
1932 >            try {
1933 >                return java.security.AccessController.doPrivileged
1934 >                    (new java.security
1935 >                     .PrivilegedExceptionAction<sun.misc.Unsafe>() {
1936 >                        public sun.misc.Unsafe run() throws Exception {
1937 >                            java.lang.reflect.Field f = sun.misc
1938 >                                .Unsafe.class.getDeclaredField("theUnsafe");
1939 >                            f.setAccessible(true);
1940 >                            return (sun.misc.Unsafe) f.get(null);
1941 >                        }});
1942 >            } catch (java.security.PrivilegedActionException e) {
1943 >                throw new RuntimeException("Could not initialize intrinsics",
1944 >                                           e.getCause());
1945 >            }
1946 >        }
1947      }
1948   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines