| 21 |
|
|
| 22 |
|
/** |
| 23 |
|
* An {@link ExecutorService} for running {@link ForkJoinTask}s. |
| 24 |
< |
* A ForkJoinPool provides the entry point for submissions from |
| 25 |
< |
* non-ForkJoinTasks, as well as management and monitoring operations. |
| 26 |
< |
* Normally a single ForkJoinPool is used for a large number of |
| 27 |
< |
* submitted tasks. Otherwise, use would not usually outweigh the |
| 28 |
< |
* construction and bookkeeping overhead of creating a large set of |
| 29 |
< |
* threads. |
| 24 |
> |
* A {@code ForkJoinPool} provides the entry point for submissions |
| 25 |
> |
* from non-{@code ForkJoinTask}s, as well as management and |
| 26 |
> |
* monitoring operations. Normally a single {@code ForkJoinPool} is |
| 27 |
> |
* used for a large number of submitted tasks. Otherwise, use would |
| 28 |
> |
* not usually outweigh the construction and bookkeeping overhead of |
| 29 |
> |
* creating a large set of threads. |
| 30 |
|
* |
| 31 |
< |
* <p>ForkJoinPools differ from other kinds of Executors mainly in |
| 32 |
< |
* that they provide <em>work-stealing</em>: all threads in the pool |
| 33 |
< |
* attempt to find and execute subtasks created by other active tasks |
| 34 |
< |
* (eventually blocking if none exist). This makes them efficient when |
| 35 |
< |
* most tasks spawn other subtasks (as do most ForkJoinTasks), as well |
| 36 |
< |
* as the mixed execution of some plain Runnable- or Callable- based |
| 37 |
< |
* activities along with ForkJoinTasks. When setting {@linkplain |
| 38 |
< |
* #setAsyncMode async mode}, a ForkJoinPool may also be appropriate |
| 39 |
< |
* for use with fine-grained tasks that are never joined. Otherwise, |
| 40 |
< |
* other ExecutorService implementations are typically more |
| 31 |
> |
* <p>{@code ForkJoinPool}s differ from other kinds of {@link |
| 32 |
> |
* Executor}s mainly in that they provide <em>work-stealing</em>: all |
| 33 |
> |
* threads in the pool attempt to find and execute subtasks created by |
| 34 |
> |
* other active tasks (eventually blocking if none exist). This makes |
| 35 |
> |
* them efficient when most tasks spawn other subtasks (as do most |
| 36 |
> |
* {@code ForkJoinTask}s), as well as the mixed execution of some |
| 37 |
> |
* plain {@code Runnable}- or {@code Callable}- based activities along |
| 38 |
> |
* with {@code ForkJoinTask}s. When setting {@linkplain #setAsyncMode |
| 39 |
> |
* async mode}, a {@code ForkJoinPool} may also be appropriate for use |
| 40 |
> |
* with fine-grained tasks that are never joined. Otherwise, other |
| 41 |
> |
* {@code ExecutorService} implementations are typically more |
| 42 |
|
* appropriate choices. |
| 43 |
|
* |
| 44 |
< |
* <p>A ForkJoinPool may be constructed with a given parallelism level |
| 45 |
< |
* (target pool size), which it attempts to maintain by dynamically |
| 46 |
< |
* adding, suspending, or resuming threads, even if some tasks are |
| 47 |
< |
* waiting to join others. However, no such adjustments are performed |
| 48 |
< |
* in the face of blocked IO or other unmanaged synchronization. The |
| 49 |
< |
* nested {@link ManagedBlocker} interface enables extension of |
| 50 |
< |
* the kinds of synchronization accommodated. The target parallelism |
| 51 |
< |
* level may also be changed dynamically ({@link #setParallelism}) |
| 52 |
< |
* and thread construction can be limited using methods |
| 53 |
< |
* {@link #setMaximumPoolSize} and/or |
| 54 |
< |
* {@link #setMaintainsParallelism}. |
| 44 |
> |
* <p>A {@code ForkJoinPool} may be constructed with a given |
| 45 |
> |
* parallelism level (target pool size), which it attempts to maintain |
| 46 |
> |
* by dynamically adding, suspending, or resuming threads, even if |
| 47 |
> |
* some tasks are waiting to join others. However, no such adjustments |
| 48 |
> |
* are performed in the face of blocked IO or other unmanaged |
| 49 |
> |
* synchronization. The nested {@link ManagedBlocker} interface |
| 50 |
> |
* enables extension of the kinds of synchronization accommodated. |
| 51 |
> |
* The target parallelism level may also be changed dynamically |
| 52 |
> |
* ({@link #setParallelism}) and thread construction can be limited |
| 53 |
> |
* using methods {@link #setMaximumPoolSize} and/or {@link |
| 54 |
> |
* #setMaintainsParallelism}. |
| 55 |
|
* |
| 56 |
|
* <p>In addition to execution and lifecycle control methods, this |
| 57 |
|
* class provides status check methods (for example |
| 63 |
|
* <p><b>Implementation notes</b>: This implementation restricts the |
| 64 |
|
* maximum number of running threads to 32767. Attempts to create |
| 65 |
|
* pools with greater than the maximum result in |
| 66 |
< |
* IllegalArgumentExceptions. |
| 66 |
> |
* {@code IllegalArgumentException}. |
| 67 |
|
* |
| 68 |
|
* @since 1.7 |
| 69 |
|
* @author Doug Lea |
| 82 |
|
private static final int MAX_THREADS = 0x7FFF; |
| 83 |
|
|
| 84 |
|
/** |
| 85 |
< |
* Factory for creating new ForkJoinWorkerThreads. A |
| 86 |
< |
* ForkJoinWorkerThreadFactory must be defined and used for |
| 87 |
< |
* ForkJoinWorkerThread subclasses that extend base functionality |
| 88 |
< |
* or initialize threads with different contexts. |
| 85 |
> |
* Factory for creating new {@link ForkJoinWorkerThread}s. |
| 86 |
> |
* A {@code ForkJoinWorkerThreadFactory} must be defined and used |
| 87 |
> |
* for {@code ForkJoinWorkerThread} subclasses that extend base |
| 88 |
> |
* functionality or initialize threads with different contexts. |
| 89 |
|
*/ |
| 90 |
|
public static interface ForkJoinWorkerThreadFactory { |
| 91 |
|
/** |
| 343 |
|
// Constructors |
| 344 |
|
|
| 345 |
|
/** |
| 346 |
< |
* Creates a ForkJoinPool with a pool size equal to the number of |
| 347 |
< |
* processors available on the system, using the default |
| 348 |
< |
* ForkJoinWorkerThreadFactory. |
| 346 |
> |
* Creates a {@code ForkJoinPool} with a pool size equal to the |
| 347 |
> |
* number of processors available on the system, using the |
| 348 |
> |
* {@linkplain #defaultForkJoinWorkerThreadFactory default thread factory}. |
| 349 |
|
* |
| 350 |
|
* @throws SecurityException if a security manager exists and |
| 351 |
|
* the caller is not permitted to modify threads |
| 358 |
|
} |
| 359 |
|
|
| 360 |
|
/** |
| 361 |
< |
* Creates a ForkJoinPool with the indicated parallelism level |
| 362 |
< |
* threads and using the default ForkJoinWorkerThreadFactory. |
| 361 |
> |
* Creates a {@code ForkJoinPool} with the indicated parallelism level |
| 362 |
> |
* threads and using the |
| 363 |
> |
* {@linkplain #defaultForkJoinWorkerThreadFactory default thread factory}. |
| 364 |
|
* |
| 365 |
|
* @param parallelism the number of worker threads |
| 366 |
|
* @throws IllegalArgumentException if parallelism less than or |
| 375 |
|
} |
| 376 |
|
|
| 377 |
|
/** |
| 378 |
< |
* Creates a ForkJoinPool with parallelism equal to the number of |
| 379 |
< |
* processors available on the system and using the given |
| 380 |
< |
* ForkJoinWorkerThreadFactory. |
| 378 |
> |
* Creates a {@code ForkJoinPool} with parallelism equal to the |
| 379 |
> |
* number of processors available on the system and using the |
| 380 |
> |
* given thread factory. |
| 381 |
|
* |
| 382 |
|
* @param factory the factory for creating new threads |
| 383 |
|
* @throws NullPointerException if factory is null |
| 391 |
|
} |
| 392 |
|
|
| 393 |
|
/** |
| 394 |
< |
* Creates a ForkJoinPool with the given parallelism and factory. |
| 394 |
> |
* Creates a {@code ForkJoinPool} with the given parallelism and |
| 395 |
> |
* thread factory. |
| 396 |
|
* |
| 397 |
|
* @param parallelism the targeted number of worker threads |
| 398 |
|
* @param factory the factory for creating new threads |
| 426 |
|
* Creates a new worker thread using factory. |
| 427 |
|
* |
| 428 |
|
* @param index the index to assign worker |
| 429 |
< |
* @return new worker, or null of factory failed |
| 429 |
> |
* @return new worker, or null if factory failed |
| 430 |
|
*/ |
| 431 |
|
private ForkJoinWorkerThread createWorker(int index) { |
| 432 |
|
Thread.UncaughtExceptionHandler h = ueh; |
| 581 |
|
* @throws NullPointerException if task is null |
| 582 |
|
* @throws RejectedExecutionException if pool is shut down |
| 583 |
|
*/ |
| 584 |
< |
public <T> void execute(ForkJoinTask<T> task) { |
| 584 |
> |
public void execute(ForkJoinTask<?> task) { |
| 585 |
|
doSubmit(task); |
| 586 |
|
} |
| 587 |
|
|
| 592 |
|
if (task instanceof ForkJoinTask<?>) // avoid re-wrap |
| 593 |
|
job = (ForkJoinTask<?>) task; |
| 594 |
|
else |
| 595 |
< |
job = new AdaptedRunnable<Void>(task, null); |
| 595 |
> |
job = ForkJoinTask.adapt(task, null); |
| 596 |
|
doSubmit(job); |
| 597 |
|
} |
| 598 |
|
|
| 599 |
|
public <T> ForkJoinTask<T> submit(Callable<T> task) { |
| 600 |
< |
ForkJoinTask<T> job = new AdaptedCallable<T>(task); |
| 600 |
> |
ForkJoinTask<T> job = ForkJoinTask.adapt(task); |
| 601 |
|
doSubmit(job); |
| 602 |
|
return job; |
| 603 |
|
} |
| 604 |
|
|
| 605 |
|
public <T> ForkJoinTask<T> submit(Runnable task, T result) { |
| 606 |
< |
ForkJoinTask<T> job = new AdaptedRunnable<T>(task, result); |
| 606 |
> |
ForkJoinTask<T> job = ForkJoinTask.adapt(task, result); |
| 607 |
|
doSubmit(job); |
| 608 |
|
return job; |
| 609 |
|
} |
| 613 |
|
if (task instanceof ForkJoinTask<?>) // avoid re-wrap |
| 614 |
|
job = (ForkJoinTask<?>) task; |
| 615 |
|
else |
| 616 |
< |
job = new AdaptedRunnable<Void>(task, null); |
| 616 |
> |
job = ForkJoinTask.adapt(task, null); |
| 617 |
|
doSubmit(job); |
| 618 |
|
return job; |
| 619 |
|
} |
| 632 |
|
return task; |
| 633 |
|
} |
| 634 |
|
|
| 632 |
– |
/** |
| 633 |
– |
* Adaptor for Runnables. This implements RunnableFuture |
| 634 |
– |
* to be compliant with AbstractExecutorService constraints. |
| 635 |
– |
*/ |
| 636 |
– |
static final class AdaptedRunnable<T> extends ForkJoinTask<T> |
| 637 |
– |
implements RunnableFuture<T> { |
| 638 |
– |
final Runnable runnable; |
| 639 |
– |
final T resultOnCompletion; |
| 640 |
– |
T result; |
| 641 |
– |
AdaptedRunnable(Runnable runnable, T result) { |
| 642 |
– |
if (runnable == null) throw new NullPointerException(); |
| 643 |
– |
this.runnable = runnable; |
| 644 |
– |
this.resultOnCompletion = result; |
| 645 |
– |
} |
| 646 |
– |
public T getRawResult() { return result; } |
| 647 |
– |
public void setRawResult(T v) { result = v; } |
| 648 |
– |
public boolean exec() { |
| 649 |
– |
runnable.run(); |
| 650 |
– |
result = resultOnCompletion; |
| 651 |
– |
return true; |
| 652 |
– |
} |
| 653 |
– |
public void run() { invoke(); } |
| 654 |
– |
private static final long serialVersionUID = 5232453952276885070L; |
| 655 |
– |
} |
| 656 |
– |
|
| 657 |
– |
/** |
| 658 |
– |
* Adaptor for Callables |
| 659 |
– |
*/ |
| 660 |
– |
static final class AdaptedCallable<T> extends ForkJoinTask<T> |
| 661 |
– |
implements RunnableFuture<T> { |
| 662 |
– |
final Callable<T> callable; |
| 663 |
– |
T result; |
| 664 |
– |
AdaptedCallable(Callable<T> callable) { |
| 665 |
– |
if (callable == null) throw new NullPointerException(); |
| 666 |
– |
this.callable = callable; |
| 667 |
– |
} |
| 668 |
– |
public T getRawResult() { return result; } |
| 669 |
– |
public void setRawResult(T v) { result = v; } |
| 670 |
– |
public boolean exec() { |
| 671 |
– |
try { |
| 672 |
– |
result = callable.call(); |
| 673 |
– |
return true; |
| 674 |
– |
} catch (Error err) { |
| 675 |
– |
throw err; |
| 676 |
– |
} catch (RuntimeException rex) { |
| 677 |
– |
throw rex; |
| 678 |
– |
} catch (Exception ex) { |
| 679 |
– |
throw new RuntimeException(ex); |
| 680 |
– |
} |
| 681 |
– |
} |
| 682 |
– |
public void run() { invoke(); } |
| 683 |
– |
private static final long serialVersionUID = 2838392045355241008L; |
| 684 |
– |
} |
| 635 |
|
|
| 636 |
|
public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks) { |
| 637 |
|
ArrayList<ForkJoinTask<T>> forkJoinTasks = |
| 638 |
|
new ArrayList<ForkJoinTask<T>>(tasks.size()); |
| 639 |
|
for (Callable<T> task : tasks) |
| 640 |
< |
forkJoinTasks.add(new AdaptedCallable<T>(task)); |
| 640 |
> |
forkJoinTasks.add(ForkJoinTask.adapt(task)); |
| 641 |
|
invoke(new InvokeAll<T>(forkJoinTasks)); |
| 642 |
|
|
| 643 |
|
@SuppressWarnings({"unchecked", "rawtypes"}) |
| 790 |
|
* Setting this value has no effect on current pool size. It |
| 791 |
|
* controls construction of new threads. |
| 792 |
|
* |
| 793 |
< |
* @throws IllegalArgumentException if negative or greater then |
| 793 |
> |
* @throws IllegalArgumentException if negative or greater than |
| 794 |
|
* internal implementation limit |
| 795 |
|
*/ |
| 796 |
|
public void setMaximumPoolSize(int newMax) { |
| 958 |
|
} |
| 959 |
|
|
| 960 |
|
/** |
| 961 |
< |
* Returns an estimate of the number tasks submitted to this pool |
| 962 |
< |
* that have not yet begun executing. This method takes time |
| 961 |
> |
* Returns an estimate of the number of tasks submitted to this |
| 962 |
> |
* pool that have not yet begun executing. This method takes time |
| 963 |
|
* proportional to the number of submissions. |
| 964 |
|
* |
| 965 |
|
* @return the number of queued submissions |
| 993 |
|
* Removes all available unexecuted submitted and forked tasks |
| 994 |
|
* from scheduling queues and adds them to the given collection, |
| 995 |
|
* without altering their execution status. These may include |
| 996 |
< |
* artificially generated or wrapped tasks. This method is designed |
| 997 |
< |
* to be invoked only when the pool is known to be |
| 996 |
> |
* artificially generated or wrapped tasks. This method is |
| 997 |
> |
* designed to be invoked only when the pool is known to be |
| 998 |
|
* quiescent. Invocations at other times may not remove all |
| 999 |
|
* tasks. A failure encountered while attempting to add elements |
| 1000 |
|
* to collection {@code c} may result in elements being in |
| 1006 |
|
* @param c the collection to transfer elements into |
| 1007 |
|
* @return the number of elements transferred |
| 1008 |
|
*/ |
| 1009 |
< |
protected int drainTasksTo(Collection<ForkJoinTask<?>> c) { |
| 1009 |
> |
protected int drainTasksTo(Collection<? super ForkJoinTask<?>> c) { |
| 1010 |
|
int n = submissionQueue.drainTo(c); |
| 1011 |
|
ForkJoinWorkerThread[] ws = workers; |
| 1012 |
|
if (ws != null) { |
| 1072 |
|
public void shutdown() { |
| 1073 |
|
checkPermission(); |
| 1074 |
|
transitionRunStateTo(SHUTDOWN); |
| 1075 |
< |
if (canTerminateOnShutdown(runControl)) |
| 1075 |
> |
if (canTerminateOnShutdown(runControl)) { |
| 1076 |
> |
if (workers == null) { // shutting down before workers created |
| 1077 |
> |
final ReentrantLock lock = this.workerLock; |
| 1078 |
> |
lock.lock(); |
| 1079 |
> |
try { |
| 1080 |
> |
if (workers == null) { |
| 1081 |
> |
terminate(); |
| 1082 |
> |
transitionRunStateTo(TERMINATED); |
| 1083 |
> |
termination.signalAll(); |
| 1084 |
> |
} |
| 1085 |
> |
} finally { |
| 1086 |
> |
lock.unlock(); |
| 1087 |
> |
} |
| 1088 |
> |
} |
| 1089 |
|
terminateOnShutdown(); |
| 1090 |
+ |
} |
| 1091 |
|
} |
| 1092 |
|
|
| 1093 |
|
/** |
| 1738 |
|
|
| 1739 |
|
/** |
| 1740 |
|
* Interface for extending managed parallelism for tasks running |
| 1741 |
< |
* in ForkJoinPools. A ManagedBlocker provides two methods. |
| 1741 |
> |
* in {@link ForkJoinPool}s. |
| 1742 |
> |
* |
| 1743 |
> |
* <p>A {@code ManagedBlocker} provides two methods. |
| 1744 |
|
* Method {@code isReleasable} must return {@code true} if |
| 1745 |
|
* blocking is not necessary. Method {@code block} blocks the |
| 1746 |
|
* current thread if necessary (perhaps internally invoking |
| 1747 |
< |
* {@code isReleasable} before actually blocking.). |
| 1747 |
> |
* {@code isReleasable} before actually blocking). |
| 1748 |
|
* |
| 1749 |
|
* <p>For example, here is a ManagedBlocker based on a |
| 1750 |
|
* ReentrantLock: |
| 1783 |
|
|
| 1784 |
|
/** |
| 1785 |
|
* Blocks in accord with the given blocker. If the current thread |
| 1786 |
< |
* is a ForkJoinWorkerThread, this method possibly arranges for a |
| 1787 |
< |
* spare thread to be activated if necessary to ensure parallelism |
| 1788 |
< |
* while the current thread is blocked. If |
| 1789 |
< |
* {@code maintainParallelism} is {@code true} and the pool supports |
| 1790 |
< |
* it ({@link #getMaintainsParallelism}), this method attempts to |
| 1791 |
< |
* maintain the pool's nominal parallelism. Otherwise it activates |
| 1792 |
< |
* a thread only if necessary to avoid complete starvation. This |
| 1793 |
< |
* option may be preferable when blockages use timeouts, or are |
| 1794 |
< |
* almost always brief. |
| 1786 |
> |
* is a {@link ForkJoinWorkerThread}, this method possibly |
| 1787 |
> |
* arranges for a spare thread to be activated if necessary to |
| 1788 |
> |
* ensure parallelism while the current thread is blocked. |
| 1789 |
> |
* |
| 1790 |
> |
* <p>If {@code maintainParallelism} is {@code true} and the pool |
| 1791 |
> |
* supports it ({@link #getMaintainsParallelism}), this method |
| 1792 |
> |
* attempts to maintain the pool's nominal parallelism. Otherwise |
| 1793 |
> |
* it activates a thread only if necessary to avoid complete |
| 1794 |
> |
* starvation. This option may be preferable when blockages use |
| 1795 |
> |
* timeouts, or are almost always brief. |
| 1796 |
|
* |
| 1797 |
< |
* <p> If the caller is not a ForkJoinTask, this method is behaviorally |
| 1798 |
< |
* equivalent to |
| 1797 |
> |
* <p>If the caller is not a {@link ForkJoinTask}, this method is |
| 1798 |
> |
* behaviorally equivalent to |
| 1799 |
|
* <pre> {@code |
| 1800 |
|
* while (!blocker.isReleasable()) |
| 1801 |
|
* if (blocker.block()) |
| 1802 |
|
* return; |
| 1803 |
|
* }</pre> |
| 1804 |
< |
* If the caller is a ForkJoinTask, then the pool may first |
| 1805 |
< |
* be expanded to ensure parallelism, and later adjusted. |
| 1804 |
> |
* |
| 1805 |
> |
* If the caller is a {@code ForkJoinTask}, then the pool may |
| 1806 |
> |
* first be expanded to ensure parallelism, and later adjusted. |
| 1807 |
|
* |
| 1808 |
|
* @param blocker the blocker |
| 1809 |
|
* @param maintainParallelism if {@code true} and supported by |
| 1835 |
|
do {} while (!blocker.isReleasable() && !blocker.block()); |
| 1836 |
|
} |
| 1837 |
|
|
| 1838 |
< |
// AbstractExecutorService overrides |
| 1838 |
> |
// AbstractExecutorService overrides. These rely on undocumented |
| 1839 |
> |
// fact that ForkJoinTask.adapt returns ForkJoinTasks that also |
| 1840 |
> |
// implement RunnableFuture. |
| 1841 |
|
|
| 1842 |
|
protected <T> RunnableFuture<T> newTaskFor(Runnable runnable, T value) { |
| 1843 |
< |
return new AdaptedRunnable<T>(runnable, value); |
| 1843 |
> |
return (RunnableFuture<T>) ForkJoinTask.adapt(runnable, value); |
| 1844 |
|
} |
| 1845 |
|
|
| 1846 |
|
protected <T> RunnableFuture<T> newTaskFor(Callable<T> callable) { |
| 1847 |
< |
return new AdaptedCallable<T>(callable); |
| 1847 |
> |
return (RunnableFuture<T>) ForkJoinTask.adapt(callable); |
| 1848 |
|
} |
| 1849 |
|
|
| 1850 |
|
// Unsafe mechanics |
