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.18 by jsr166, Thu Jul 23 23:23:41 2009 UTC vs.
Revision 1.32 by jsr166, Thu Jul 30 22:05:19 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 < * {@code setAsyncMode}, 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} 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})
50 > * level may also be changed dynamically ({@link #setParallelism})
51   * and thread construction can be limited using methods
52 < * {@code setMaximumPoolSize} and/or
53 < * {@code setMaintainsParallelism}.
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}) 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} 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
# Line 304 | Line 311 | public class ForkJoinPool extends Abstra
311      }
312  
313      /**
314 <     * Returns 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) {
# Line 541 | 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 576 | 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 592 | 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.
635       */
# Line 652 | Line 684 | public class ForkJoinPool extends Abstra
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 {
# Line 685 | Line 720 | public class ForkJoinPool extends Abstra
720       * Returns the handler for internal worker threads that terminate
721       * due to unrecoverable errors encountered while executing tasks.
722       *
723 <     * @return the handler, or null if none
723 >     * @return the handler, or {@code null} if none
724       */
725      public Thread.UncaughtExceptionHandler getUncaughtExceptionHandler() {
726          Thread.UncaughtExceptionHandler h;
# Line 706 | 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
# Line 780 | 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} 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 816 | 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.
822 <     * This setting is by default true.
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 true if maintains parallelism
858 >     * @return {@code true} if maintains parallelism
859       */
860      public boolean getMaintainsParallelism() {
861          return maintainsParallelism;
# Line 832 | Line 866 | public class ForkJoinPool extends Abstra
866       * parallelism level. If false, new threads are added only to
867       * avoid possible starvation.
868       *
869 <     * @param enable true to maintains parallelism
869 >     * @param enable {@code true} to maintain parallelism
870       */
871      public void setMaintainsParallelism(boolean enable) {
872          maintainsParallelism = enable;
# Line 843 | 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 other times may be unpredictable.
883       *
884 <     * @param async if true, use locally FIFO scheduling
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 865 | Line 900 | public class ForkJoinPool extends Abstra
900      }
901  
902      /**
903 <     * Returns true if this pool uses local first-in-first-out
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 909 | Line 945 | public class ForkJoinPool extends Abstra
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.
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 true if all threads are currently idle
956 >     * @return {@code true} if all threads are currently idle
957       */
958      public boolean isQuiescent() {
959          return activeCountOf(runControl) == 0;
# Line 983 | Line 1019 | public class ForkJoinPool extends Abstra
1019      }
1020  
1021      /**
1022 <     * Returns true if there are any tasks submitted to this pool
1023 <     * that have not yet begun executing.
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       */
# Line 997 | Line 1033 | public class ForkJoinPool extends Abstra
1033       * available.  This method may be useful in extensions to this
1034       * class that re-assign work in systems with multiple pools.
1035       *
1036 <     * @return the next submission, or null if none
1036 >     * @return the next submission, or {@code null} if none
1037       */
1038      protected ForkJoinTask<?> pollSubmission() {
1039          return submissionQueue.poll();
# Line 1020 | Line 1056 | public class ForkJoinPool extends Abstra
1056       * @param c the collection to transfer elements into
1057       * @return the number of elements transferred
1058       */
1059 <    protected int drainTasksTo(Collection<ForkJoinTask<?>> c) {
1059 >    protected int drainTasksTo(Collection<? super ForkJoinTask<?>> c) {
1060          int n = submissionQueue.drainTo(c);
1061          ForkJoinWorkerThread[] ws = workers;
1062          if (ws != null) {
# Line 1086 | Line 1122 | public class ForkJoinPool extends Abstra
1122      public void shutdown() {
1123          checkPermission();
1124          transitionRunStateTo(SHUTDOWN);
1125 <        if (canTerminateOnShutdown(runControl))
1125 >        if (canTerminateOnShutdown(runControl)) {
1126 >            if (workers == null) { // shutting down before workers created
1127 >                final ReentrantLock lock = this.workerLock;
1128 >                lock.lock();
1129 >                try {
1130 >                    if (workers == null) {
1131 >                        terminate();
1132 >                        transitionRunStateTo(TERMINATED);
1133 >                        termination.signalAll();
1134 >                    }
1135 >                } finally {
1136 >                    lock.unlock();
1137 >                }
1138 >            }
1139              terminateOnShutdown();
1140 +        }
1141      }
1142  
1143      /**
# Line 1097 | Line 1147 | public class ForkJoinPool extends Abstra
1147       * method may or may not be rejected. Unlike some other executors,
1148       * this method cancels rather than collects non-executed tasks
1149       * upon termination, so always returns an empty list. However, you
1150 <     * can use method {@code drainTasksTo} before invoking this
1150 >     * can use method {@link #drainTasksTo} before invoking this
1151       * method to transfer unexecuted tasks to another collection.
1152       *
1153       * @return an empty list
# Line 1457 | Line 1507 | public class ForkJoinPool extends Abstra
1507      }
1508  
1509      /**
1510 <     * Returns true if worker waiting on sync can proceed:
1510 >     * Returns {@code true} if worker waiting on sync can proceed:
1511       *  - on signal (thread == null)
1512       *  - on event count advance (winning race to notify vs signaller)
1513       *  - on interrupt
# Line 1465 | Line 1515 | public class ForkJoinPool extends Abstra
1515       * If node was not signalled and event count not advanced on exit,
1516       * then we also help advance event count.
1517       *
1518 <     * @return true if node can be released
1518 >     * @return {@code true} if node can be released
1519       */
1520      final boolean syncIsReleasable(WaitQueueNode node) {
1521          long prev = node.count;
# Line 1484 | Line 1534 | public class ForkJoinPool extends Abstra
1534      }
1535  
1536      /**
1537 <     * Returns true if a new sync event occurred since last call to
1538 <     * sync or this method, if so, updating caller's count.
1537 >     * Returns {@code true} if a new sync event occurred since last
1538 >     * call to sync or this method, if so, updating caller's count.
1539       */
1540      final boolean hasNewSyncEvent(ForkJoinWorkerThread w) {
1541          long lc = w.lastEventCount;
# Line 1569 | Line 1619 | public class ForkJoinPool extends Abstra
1619      }
1620  
1621      /**
1622 <     * Returns true if a spare thread appears to be needed.  If
1623 <     * maintaining parallelism, returns true when the deficit in
1622 >     * Returns {@code true} if a spare thread appears to be needed.
1623 >     * If maintaining parallelism, returns true when the deficit in
1624       * running threads is more than the surplus of total threads, and
1625       * there is apparently some work to do.  This self-limiting rule
1626       * means that the more threads that have already been added, the
# Line 1739 | Line 1789 | public class ForkJoinPool extends Abstra
1789      /**
1790       * Interface for extending managed parallelism for tasks running
1791       * in ForkJoinPools. A ManagedBlocker provides two methods.
1792 <     * Method {@code isReleasable} must return true if blocking is not
1793 <     * necessary. Method {@code block} blocks the current thread if
1794 <     * necessary (perhaps internally invoking {@code isReleasable}
1795 <     * before actually blocking.).
1792 >     * Method {@code isReleasable} must return {@code true} if
1793 >     * blocking is not necessary. Method {@code block} blocks the
1794 >     * current thread if necessary (perhaps internally invoking
1795 >     * {@code isReleasable} before actually blocking.).
1796       *
1797       * <p>For example, here is a ManagedBlocker based on a
1798       * ReentrantLock:
# Line 1766 | Line 1816 | public class ForkJoinPool extends Abstra
1816           * Possibly blocks the current thread, for example waiting for
1817           * a lock or condition.
1818           *
1819 <         * @return true if no additional blocking is necessary (i.e.,
1820 <         * if isReleasable would return true)
1819 >         * @return {@code true} if no additional blocking is necessary
1820 >         * (i.e., if isReleasable would return true)
1821           * @throws InterruptedException if interrupted while waiting
1822           * (the method is not required to do so, but is allowed to)
1823           */
1824          boolean block() throws InterruptedException;
1825  
1826          /**
1827 <         * Returns true if blocking is unnecessary.
1827 >         * Returns {@code true} if blocking is unnecessary.
1828           */
1829          boolean isReleasable();
1830      }
# Line 1784 | Line 1834 | public class ForkJoinPool extends Abstra
1834       * is a ForkJoinWorkerThread, this method possibly arranges for a
1835       * spare thread to be activated if necessary to ensure parallelism
1836       * while the current thread is blocked.  If
1837 <     * {@code maintainParallelism} is true and the pool supports
1837 >     * {@code maintainParallelism} is {@code true} and the pool supports
1838       * it ({@link #getMaintainsParallelism}), this method attempts to
1839       * maintain the pool's nominal parallelism. Otherwise it activates
1840       * a thread only if necessary to avoid complete starvation. This
# Line 1802 | Line 1852 | public class ForkJoinPool extends Abstra
1852       * be expanded to ensure parallelism, and later adjusted.
1853       *
1854       * @param blocker the blocker
1855 <     * @param maintainParallelism if true and supported by this pool,
1856 <     * attempt to maintain the pool's nominal parallelism; otherwise
1857 <     * activate a thread only if necessary to avoid complete
1858 <     * starvation.
1855 >     * @param maintainParallelism if {@code true} and supported by
1856 >     * this pool, attempt to maintain the pool's nominal parallelism;
1857 >     * otherwise activate a thread only if necessary to avoid
1858 >     * complete starvation.
1859       * @throws InterruptedException if blocker.block did so
1860       */
1861      public static void managedBlock(ManagedBlocker blocker,
# Line 1834 | Line 1884 | public class ForkJoinPool extends Abstra
1884      // AbstractExecutorService overrides
1885  
1886      protected <T> RunnableFuture<T> newTaskFor(Runnable runnable, T value) {
1887 <        return new AdaptedRunnable(runnable, value);
1887 >        return new AdaptedRunnable<T>(runnable, value);
1888      }
1889  
1890      protected <T> RunnableFuture<T> newTaskFor(Callable<T> callable) {
1891 <        return new AdaptedCallable(callable);
1891 >        return new AdaptedCallable<T>(callable);
1892      }
1893  
1894 +    // Unsafe mechanics
1895  
1896 <    // Temporary Unsafe mechanics for preliminary release
1897 <    private static Unsafe getUnsafe() throws Throwable {
1898 <        try {
1899 <            return Unsafe.getUnsafe();
1900 <        } catch (SecurityException se) {
1901 <            try {
1902 <                return java.security.AccessController.doPrivileged
1903 <                    (new java.security.PrivilegedExceptionAction<Unsafe>() {
1904 <                        public Unsafe run() throws Exception {
1905 <                            return getUnsafePrivileged();
1906 <                        }});
1856 <            } catch (java.security.PrivilegedActionException e) {
1857 <                throw e.getCause();
1858 <            }
1859 <        }
1860 <    }
1861 <
1862 <    private static Unsafe getUnsafePrivileged()
1863 <            throws NoSuchFieldException, IllegalAccessException {
1864 <        Field f = Unsafe.class.getDeclaredField("theUnsafe");
1865 <        f.setAccessible(true);
1866 <        return (Unsafe) f.get(null);
1867 <    }
1868 <
1869 <    private static long fieldOffset(String fieldName)
1870 <            throws NoSuchFieldException {
1871 <        return UNSAFE.objectFieldOffset
1872 <            (ForkJoinPool.class.getDeclaredField(fieldName));
1873 <    }
1874 <
1875 <    static final Unsafe UNSAFE;
1876 <    static final long eventCountOffset;
1877 <    static final long workerCountsOffset;
1878 <    static final long runControlOffset;
1879 <    static final long syncStackOffset;
1880 <    static final long spareStackOffset;
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 <        }
1893 <    }
1896 >    private static final sun.misc.Unsafe UNSAFE = getUnsafe();
1897 >    private static final long eventCountOffset =
1898 >        objectFieldOffset("eventCount", ForkJoinPool.class);
1899 >    private static final long workerCountsOffset =
1900 >        objectFieldOffset("workerCounts", ForkJoinPool.class);
1901 >    private static final long runControlOffset =
1902 >        objectFieldOffset("runControl", ForkJoinPool.class);
1903 >    private static final long syncStackOffset =
1904 >        objectFieldOffset("syncStack",ForkJoinPool.class);
1905 >    private static final long spareStackOffset =
1906 >        objectFieldOffset("spareStack", ForkJoinPool.class);
1907  
1908      private boolean casEventCount(long cmp, long val) {
1909          return UNSAFE.compareAndSwapLong(this, eventCountOffset, cmp, val);
# Line 1907 | Line 1920 | public class ForkJoinPool extends Abstra
1920      private boolean casBarrierStack(WaitQueueNode cmp, WaitQueueNode val) {
1921          return UNSAFE.compareAndSwapObject(this, syncStackOffset, cmp, val);
1922      }
1923 +
1924 +    private static long objectFieldOffset(String field, Class<?> klazz) {
1925 +        try {
1926 +            return UNSAFE.objectFieldOffset(klazz.getDeclaredField(field));
1927 +        } catch (NoSuchFieldException e) {
1928 +            // Convert Exception to corresponding Error
1929 +            NoSuchFieldError error = new NoSuchFieldError(field);
1930 +            error.initCause(e);
1931 +            throw error;
1932 +        }
1933 +    }
1934 +
1935 +    /**
1936 +     * Returns a sun.misc.Unsafe.  Suitable for use in a 3rd party package.
1937 +     * Replace with a simple call to Unsafe.getUnsafe when integrating
1938 +     * into a jdk.
1939 +     *
1940 +     * @return a sun.misc.Unsafe
1941 +     */
1942 +    private static sun.misc.Unsafe getUnsafe() {
1943 +        try {
1944 +            return sun.misc.Unsafe.getUnsafe();
1945 +        } catch (SecurityException se) {
1946 +            try {
1947 +                return java.security.AccessController.doPrivileged
1948 +                    (new java.security
1949 +                     .PrivilegedExceptionAction<sun.misc.Unsafe>() {
1950 +                        public sun.misc.Unsafe run() throws Exception {
1951 +                            java.lang.reflect.Field f = sun.misc
1952 +                                .Unsafe.class.getDeclaredField("theUnsafe");
1953 +                            f.setAccessible(true);
1954 +                            return (sun.misc.Unsafe) f.get(null);
1955 +                        }});
1956 +            } catch (java.security.PrivilegedActionException e) {
1957 +                throw new RuntimeException("Could not initialize intrinsics",
1958 +                                           e.getCause());
1959 +            }
1960 +        }
1961 +    }
1962   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines