5 |
|
*/ |
6 |
|
|
7 |
|
package jsr166y; |
8 |
< |
import java.io.Serializable; |
9 |
< |
import java.util.*; |
8 |
> |
|
9 |
|
import java.util.concurrent.*; |
10 |
< |
import java.util.concurrent.atomic.*; |
10 |
> |
import java.io.Serializable; |
11 |
> |
import java.util.Collection; |
12 |
> |
import java.util.Collections; |
13 |
> |
import java.util.List; |
14 |
> |
import java.util.RandomAccess; |
15 |
> |
import java.util.Map; |
16 |
> |
import java.util.WeakHashMap; |
17 |
|
|
18 |
|
/** |
19 |
< |
* Abstract base class for tasks that run within a {@link |
20 |
< |
* ForkJoinPool}. A ForkJoinTask is a thread-like entity that is much |
19 |
> |
* Abstract base class for tasks that run within a {@link ForkJoinPool}. |
20 |
> |
* A {@code ForkJoinTask} is a thread-like entity that is much |
21 |
|
* lighter weight than a normal thread. Huge numbers of tasks and |
22 |
|
* subtasks may be hosted by a small number of actual threads in a |
23 |
|
* ForkJoinPool, at the price of some usage limitations. |
24 |
|
* |
25 |
< |
* <p> A "main" ForkJoinTask begins execution when submitted to a |
26 |
< |
* {@link ForkJoinPool}. Once started, it will usually in turn start |
27 |
< |
* other subtasks. As indicated by the name of this class, many |
28 |
< |
* programs using ForkJoinTasks employ only methods {@code fork} |
29 |
< |
* and {@code join}, or derivatives such as |
30 |
< |
* {@code invokeAll}. However, this class also provides a number |
31 |
< |
* of other methods that can come into play in advanced usages, as |
32 |
< |
* well as extension mechanics that allow support of new forms of |
33 |
< |
* fork/join processing. |
25 |
> |
* <p>A "main" {@code ForkJoinTask} begins execution when submitted |
26 |
> |
* to a {@link ForkJoinPool}. Once started, it will usually in turn |
27 |
> |
* start other subtasks. As indicated by the name of this class, |
28 |
> |
* many programs using {@code ForkJoinTask} employ only methods |
29 |
> |
* {@link #fork} and {@link #join}, or derivatives such as {@link |
30 |
> |
* #invokeAll(ForkJoinTask...) invokeAll}. However, this class also |
31 |
> |
* provides a number of other methods that can come into play in |
32 |
> |
* advanced usages, as well as extension mechanics that allow |
33 |
> |
* support of new forms of fork/join processing. |
34 |
|
* |
35 |
< |
* <p>A ForkJoinTask is a lightweight form of {@link Future}. The |
36 |
< |
* efficiency of ForkJoinTasks stems from a set of restrictions (that |
37 |
< |
* are only partially statically enforceable) reflecting their |
38 |
< |
* intended use as computational tasks calculating pure functions or |
39 |
< |
* operating on purely isolated objects. The primary coordination |
40 |
< |
* mechanisms are {@link #fork}, that arranges asynchronous execution, |
41 |
< |
* and {@link #join}, that doesn't proceed until the task's result has |
42 |
< |
* been computed. Computations should avoid {@code synchronized} |
43 |
< |
* methods or blocks, and should minimize other blocking |
44 |
< |
* synchronization apart from joining other tasks or using |
45 |
< |
* synchronizers such as Phasers that are advertised to cooperate with |
46 |
< |
* fork/join scheduling. Tasks should also not perform blocking IO, |
47 |
< |
* and should ideally access variables that are completely independent |
48 |
< |
* of those accessed by other running tasks. Minor breaches of these |
49 |
< |
* restrictions, for example using shared output streams, may be |
50 |
< |
* tolerable in practice, but frequent use may result in poor |
51 |
< |
* performance, and the potential to indefinitely stall if the number |
52 |
< |
* of threads not waiting for IO or other external synchronization |
53 |
< |
* becomes exhausted. This usage restriction is in part enforced by |
54 |
< |
* not permitting checked exceptions such as {@code IOExceptions} |
55 |
< |
* to be thrown. However, computations may still encounter unchecked |
56 |
< |
* exceptions, that are rethrown to callers attempting join |
57 |
< |
* them. These exceptions may additionally include |
58 |
< |
* RejectedExecutionExceptions stemming from internal resource |
59 |
< |
* exhaustion such as failure to allocate internal task queues. |
35 |
> |
* <p>A {@code ForkJoinTask} is a lightweight form of {@link Future}. |
36 |
> |
* The efficiency of {@code ForkJoinTask}s stems from a set of |
37 |
> |
* restrictions (that are only partially statically enforceable) |
38 |
> |
* reflecting their intended use as computational tasks calculating |
39 |
> |
* pure functions or operating on purely isolated objects. The |
40 |
> |
* primary coordination mechanisms are {@link #fork}, that arranges |
41 |
> |
* asynchronous execution, and {@link #join}, that doesn't proceed |
42 |
> |
* until the task's result has been computed. Computations should |
43 |
> |
* avoid {@code synchronized} methods or blocks, and should minimize |
44 |
> |
* other blocking synchronization apart from joining other tasks or |
45 |
> |
* using synchronizers such as Phasers that are advertised to |
46 |
> |
* cooperate with fork/join scheduling. Tasks should also not perform |
47 |
> |
* blocking IO, and should ideally access variables that are |
48 |
> |
* completely independent of those accessed by other running |
49 |
> |
* tasks. Minor breaches of these restrictions, for example using |
50 |
> |
* shared output streams, may be tolerable in practice, but frequent |
51 |
> |
* use may result in poor performance, and the potential to |
52 |
> |
* indefinitely stall if the number of threads not waiting for IO or |
53 |
> |
* other external synchronization becomes exhausted. This usage |
54 |
> |
* restriction is in part enforced by not permitting checked |
55 |
> |
* exceptions such as {@code IOExceptions} to be thrown. However, |
56 |
> |
* computations may still encounter unchecked exceptions, that are |
57 |
> |
* rethrown to callers attempting to join them. These exceptions may |
58 |
> |
* additionally include {@link RejectedExecutionException} stemming |
59 |
> |
* from internal resource exhaustion, such as failure to allocate |
60 |
> |
* internal task queues. |
61 |
|
* |
62 |
|
* <p>The primary method for awaiting completion and extracting |
63 |
|
* results of a task is {@link #join}, but there are several variants: |
64 |
|
* The {@link Future#get} methods support interruptible and/or timed |
65 |
|
* waits for completion and report results using {@code Future} |
66 |
< |
* conventions. Method {@link #helpJoin} enables callers to actively |
67 |
< |
* execute other tasks while awaiting joins, which is sometimes more |
68 |
< |
* efficient but only applies when all subtasks are known to be |
69 |
< |
* strictly tree-structured. Method {@link #invoke} is semantically |
64 |
< |
* equivalent to {@code fork(); join()} but always attempts to |
65 |
< |
* begin execution in the current thread. The "<em>quiet</em>" forms |
66 |
< |
* of these methods do not extract results or report exceptions. These |
66 |
> |
* conventions. Method {@link #invoke} is semantically |
67 |
> |
* equivalent to {@code fork(); join()} but always attempts to begin |
68 |
> |
* execution in the current thread. The "<em>quiet</em>" forms of |
69 |
> |
* these methods do not extract results or report exceptions. These |
70 |
|
* may be useful when a set of tasks are being executed, and you need |
71 |
|
* to delay processing of results or exceptions until all complete. |
72 |
|
* Method {@code invokeAll} (available in multiple versions) |
73 |
|
* performs the most common form of parallel invocation: forking a set |
74 |
|
* of tasks and joining them all. |
75 |
|
* |
76 |
< |
* <p> The ForkJoinTask class is not usually directly subclassed. |
76 |
> |
* <p>The execution status of tasks may be queried at several levels |
77 |
> |
* of detail: {@link #isDone} is true if a task completed in any way |
78 |
> |
* (including the case where a task was cancelled without executing); |
79 |
> |
* {@link #isCompletedNormally} is true if a task completed without |
80 |
> |
* cancellation or encountering an exception; {@link #isCancelled} is |
81 |
> |
* true if the task was cancelled (in which case {@link #getException} |
82 |
> |
* returns a {@link java.util.concurrent.CancellationException}); and |
83 |
> |
* {@link #isCompletedAbnormally} is true if a task was either |
84 |
> |
* cancelled or encountered an exception, in which case {@link |
85 |
> |
* #getException} will return either the encountered exception or |
86 |
> |
* {@link java.util.concurrent.CancellationException}. |
87 |
> |
* |
88 |
> |
* <p>The ForkJoinTask class is not usually directly subclassed. |
89 |
|
* Instead, you subclass one of the abstract classes that support a |
90 |
< |
* particular style of fork/join processing. Normally, a concrete |
90 |
> |
* particular style of fork/join processing, typically {@link |
91 |
> |
* RecursiveAction} for computations that do not return results, or |
92 |
> |
* {@link RecursiveTask} for those that do. Normally, a concrete |
93 |
|
* ForkJoinTask subclass declares fields comprising its parameters, |
94 |
|
* established in a constructor, and then defines a {@code compute} |
95 |
|
* method that somehow uses the control methods supplied by this base |
96 |
|
* class. While these methods have {@code public} access (to allow |
97 |
< |
* instances of different task subclasses to call each others |
97 |
> |
* instances of different task subclasses to call each other's |
98 |
|
* methods), some of them may only be called from within other |
99 |
|
* ForkJoinTasks (as may be determined using method {@link |
100 |
|
* #inForkJoinPool}). Attempts to invoke them in other contexts |
101 |
|
* result in exceptions or errors, possibly including |
102 |
< |
* ClassCastException. |
102 |
> |
* {@code ClassCastException}. |
103 |
|
* |
104 |
< |
* <p>Most base support methods are {@code final} because their |
105 |
< |
* implementations are intrinsically tied to the underlying |
106 |
< |
* lightweight task scheduling framework, and so cannot be overridden. |
107 |
< |
* Developers creating new basic styles of fork/join processing should |
108 |
< |
* minimally implement {@code protected} methods |
109 |
< |
* {@code exec}, {@code setRawResult}, and |
110 |
< |
* {@code getRawResult}, while also introducing an abstract |
111 |
< |
* computational method that can be implemented in its subclasses, |
112 |
< |
* possibly relying on other {@code protected} methods provided |
96 |
< |
* by this class. |
104 |
> |
* <p>Most base support methods are {@code final}, to prevent |
105 |
> |
* overriding of implementations that are intrinsically tied to the |
106 |
> |
* underlying lightweight task scheduling framework. Developers |
107 |
> |
* creating new basic styles of fork/join processing should minimally |
108 |
> |
* implement {@code protected} methods {@link #exec}, {@link |
109 |
> |
* #setRawResult}, and {@link #getRawResult}, while also introducing |
110 |
> |
* an abstract computational method that can be implemented in its |
111 |
> |
* subclasses, possibly relying on other {@code protected} methods |
112 |
> |
* provided by this class. |
113 |
|
* |
114 |
|
* <p>ForkJoinTasks should perform relatively small amounts of |
115 |
< |
* computations, otherwise splitting into smaller tasks. As a very |
116 |
< |
* rough rule of thumb, a task should perform more than 100 and less |
117 |
< |
* than 10000 basic computational steps. If tasks are too big, then |
118 |
< |
* parallelism cannot improve throughput. If too small, then memory |
119 |
< |
* and internal task maintenance overhead may overwhelm processing. |
115 |
> |
* computation. Large tasks should be split into smaller subtasks, |
116 |
> |
* usually via recursive decomposition. As a very rough rule of thumb, |
117 |
> |
* a task should perform more than 100 and less than 10000 basic |
118 |
> |
* computational steps. If tasks are too big, then parallelism cannot |
119 |
> |
* improve throughput. If too small, then memory and internal task |
120 |
> |
* maintenance overhead may overwhelm processing. |
121 |
> |
* |
122 |
> |
* <p>This class provides {@code adapt} methods for {@link Runnable} |
123 |
> |
* and {@link Callable}, that may be of use when mixing execution of |
124 |
> |
* {@code ForkJoinTasks} with other kinds of tasks. When all tasks are |
125 |
> |
* of this form, consider using a pool constructed in <em>asyncMode</em>. |
126 |
|
* |
127 |
< |
* <p>ForkJoinTasks are {@code Serializable}, which enables them |
128 |
< |
* to be used in extensions such as remote execution frameworks. It is |
129 |
< |
* in general sensible to serialize tasks only before or after, but |
130 |
< |
* not during execution. Serialization is not relied on during |
109 |
< |
* execution itself. |
127 |
> |
* <p>ForkJoinTasks are {@code Serializable}, which enables them to be |
128 |
> |
* used in extensions such as remote execution frameworks. It is |
129 |
> |
* sensible to serialize tasks only before or after, but not during, |
130 |
> |
* execution. Serialization is not relied on during execution itself. |
131 |
|
* |
132 |
|
* @since 1.7 |
133 |
|
* @author Doug Lea |
134 |
|
*/ |
135 |
|
public abstract class ForkJoinTask<V> implements Future<V>, Serializable { |
136 |
|
|
137 |
< |
/** |
138 |
< |
* Run control status bits packed into a single int to minimize |
139 |
< |
* footprint and to ensure atomicity (via CAS). Status is |
140 |
< |
* initially zero, and takes on nonnegative values until |
141 |
< |
* completed, upon which status holds COMPLETED. CANCELLED, or |
142 |
< |
* EXCEPTIONAL, which use the top 3 bits. Tasks undergoing |
143 |
< |
* blocking waits by other threads have SIGNAL_MASK bits set -- |
144 |
< |
* bit 15 for external (nonFJ) waits, and the rest a count of |
145 |
< |
* waiting FJ threads. (This representation relies on |
146 |
< |
* ForkJoinPool max thread limits). Completion of a stolen task |
147 |
< |
* with SIGNAL_MASK bits set awakens waiter via notifyAll. Even |
148 |
< |
* though suboptimal for some purposes, we use basic builtin |
149 |
< |
* wait/notify to take advantage of "monitor inflation" in JVMs |
150 |
< |
* that we would otherwise need to emulate to avoid adding further |
151 |
< |
* per-task bookkeeping overhead. Note that bits 16-28 are |
152 |
< |
* currently unused. Also value 0x80000000 is available as spare |
153 |
< |
* completion value. |
137 |
> |
/* |
138 |
> |
* See the internal documentation of class ForkJoinPool for a |
139 |
> |
* general implementation overview. ForkJoinTasks are mainly |
140 |
> |
* responsible for maintaining their "status" field amidst relays |
141 |
> |
* to methods in ForkJoinWorkerThread and ForkJoinPool. The |
142 |
> |
* methods of this class are more-or-less layered into (1) basic |
143 |
> |
* status maintenance (2) execution and awaiting completion (3) |
144 |
> |
* user-level methods that additionally report results. This is |
145 |
> |
* sometimes hard to see because this file orders exported methods |
146 |
> |
* in a way that flows well in javadocs. In particular, most |
147 |
> |
* join mechanics are in method quietlyJoin, below. |
148 |
> |
*/ |
149 |
> |
|
150 |
> |
/* |
151 |
> |
* The status field holds run control status bits packed into a |
152 |
> |
* single int to minimize footprint and to ensure atomicity (via |
153 |
> |
* CAS). Status is initially zero, and takes on nonnegative |
154 |
> |
* values until completed, upon which status holds value |
155 |
> |
* NORMAL, CANCELLED, or EXCEPTIONAL. Tasks undergoing blocking |
156 |
> |
* waits by other threads have the SIGNAL bit set. Completion of |
157 |
> |
* a stolen task with SIGNAL set awakens any waiters via |
158 |
> |
* notifyAll. Even though suboptimal for some purposes, we use |
159 |
> |
* basic builtin wait/notify to take advantage of "monitor |
160 |
> |
* inflation" in JVMs that we would otherwise need to emulate to |
161 |
> |
* avoid adding further per-task bookkeeping overhead. We want |
162 |
> |
* these monitors to be "fat", i.e., not use biasing or thin-lock |
163 |
> |
* techniques, so use some odd coding idioms that tend to avoid |
164 |
> |
* them. |
165 |
|
*/ |
166 |
+ |
|
167 |
+ |
/** The run status of this task */ |
168 |
|
volatile int status; // accessed directly by pool and workers |
169 |
|
|
170 |
< |
static final int COMPLETION_MASK = 0xe0000000; |
171 |
< |
static final int NORMAL = 0xe0000000; // == mask |
172 |
< |
static final int CANCELLED = 0xc0000000; |
173 |
< |
static final int EXCEPTIONAL = 0xa0000000; |
140 |
< |
static final int SIGNAL_MASK = 0x0000ffff; |
141 |
< |
static final int INTERNAL_SIGNAL_MASK = 0x00007fff; |
142 |
< |
static final int EXTERNAL_SIGNAL = 0x00008000; // top bit of low word |
170 |
> |
private static final int NORMAL = -1; |
171 |
> |
private static final int CANCELLED = -2; |
172 |
> |
private static final int EXCEPTIONAL = -3; |
173 |
> |
private static final int SIGNAL = 1; |
174 |
|
|
175 |
|
/** |
176 |
|
* Table of exceptions thrown by tasks, to enable reporting by |
184 |
|
Collections.synchronizedMap |
185 |
|
(new WeakHashMap<ForkJoinTask<?>, Throwable>()); |
186 |
|
|
187 |
< |
// within-package utilities |
157 |
< |
|
158 |
< |
/** |
159 |
< |
* Gets current worker thread, or null if not a worker thread. |
160 |
< |
*/ |
161 |
< |
static ForkJoinWorkerThread getWorker() { |
162 |
< |
Thread t = Thread.currentThread(); |
163 |
< |
return ((t instanceof ForkJoinWorkerThread) ? |
164 |
< |
(ForkJoinWorkerThread) t : null); |
165 |
< |
} |
166 |
< |
|
167 |
< |
final boolean casStatus(int cmp, int val) { |
168 |
< |
return UNSAFE.compareAndSwapInt(this, statusOffset, cmp, val); |
169 |
< |
} |
187 |
> |
// Maintaining completion status |
188 |
|
|
189 |
|
/** |
190 |
< |
* Workaround for not being able to rethrow unchecked exceptions. |
191 |
< |
*/ |
174 |
< |
static void rethrowException(Throwable ex) { |
175 |
< |
if (ex != null) |
176 |
< |
UNSAFE.throwException(ex); |
177 |
< |
} |
178 |
< |
|
179 |
< |
// Setting completion status |
180 |
< |
|
181 |
< |
/** |
182 |
< |
* Marks completion and wakes up threads waiting to join this task. |
190 |
> |
* Marks completion and wakes up threads waiting to join this task, |
191 |
> |
* also clearing signal request bits. |
192 |
|
* |
193 |
|
* @param completion one of NORMAL, CANCELLED, EXCEPTIONAL |
194 |
|
*/ |
195 |
< |
final void setCompletion(int completion) { |
196 |
< |
ForkJoinPool pool = getPool(); |
197 |
< |
if (pool != null) { |
198 |
< |
int s; // Clear signal bits while setting completion status |
199 |
< |
do {} while ((s = status) >= 0 && !casStatus(s, completion)); |
200 |
< |
|
201 |
< |
if ((s & SIGNAL_MASK) != 0) { |
193 |
< |
if ((s &= INTERNAL_SIGNAL_MASK) != 0) |
194 |
< |
pool.updateRunningCount(s); |
195 |
< |
synchronized (this) { notifyAll(); } |
195 |
> |
private void setCompletion(int completion) { |
196 |
> |
int s; |
197 |
> |
while ((s = status) >= 0) { |
198 |
> |
if (UNSAFE.compareAndSwapInt(this, statusOffset, s, completion)) { |
199 |
> |
if (s != 0) |
200 |
> |
synchronized (this) { notifyAll(); } |
201 |
> |
break; |
202 |
|
} |
203 |
|
} |
198 |
– |
else |
199 |
– |
externallySetCompletion(completion); |
200 |
– |
} |
201 |
– |
|
202 |
– |
/** |
203 |
– |
* Version of setCompletion for non-FJ threads. Leaves signal |
204 |
– |
* bits for unblocked threads to adjust, and always notifies. |
205 |
– |
*/ |
206 |
– |
private void externallySetCompletion(int completion) { |
207 |
– |
int s; |
208 |
– |
do {} while ((s = status) >= 0 && |
209 |
– |
!casStatus(s, (s & SIGNAL_MASK) | completion)); |
210 |
– |
synchronized (this) { notifyAll(); } |
204 |
|
} |
205 |
|
|
206 |
|
/** |
207 |
< |
* Sets status to indicate normal completion. |
208 |
< |
*/ |
209 |
< |
final void setNormalCompletion() { |
217 |
< |
// Try typical fast case -- single CAS, no signal, not already done. |
218 |
< |
// Manually expand casStatus to improve chances of inlining it |
219 |
< |
if (!UNSAFE.compareAndSwapInt(this, statusOffset, 0, NORMAL)) |
220 |
< |
setCompletion(NORMAL); |
221 |
< |
} |
222 |
< |
|
223 |
< |
// internal waiting and notification |
224 |
< |
|
225 |
< |
/** |
226 |
< |
* Performs the actual monitor wait for awaitDone. |
207 |
> |
* Records exception and sets exceptional completion. |
208 |
> |
* |
209 |
> |
* @return status on exit |
210 |
|
*/ |
211 |
< |
private void doAwaitDone() { |
212 |
< |
// Minimize lock bias and in/de-flation effects by maximizing |
213 |
< |
// chances of waiting inside sync |
231 |
< |
try { |
232 |
< |
while (status >= 0) |
233 |
< |
synchronized (this) { if (status >= 0) wait(); } |
234 |
< |
} catch (InterruptedException ie) { |
235 |
< |
onInterruptedWait(); |
236 |
< |
} |
211 |
> |
private void setExceptionalCompletion(Throwable rex) { |
212 |
> |
exceptionMap.put(this, rex); |
213 |
> |
setCompletion(EXCEPTIONAL); |
214 |
|
} |
215 |
|
|
216 |
|
/** |
217 |
< |
* Performs the actual timed monitor wait for awaitDone. |
217 |
> |
* Blocks a worker thread until completion. Called only by |
218 |
> |
* pool. Currently unused -- pool-based waits use timeout |
219 |
> |
* version below. |
220 |
|
*/ |
221 |
< |
private void doAwaitDone(long startTime, long nanos) { |
222 |
< |
synchronized (this) { |
221 |
> |
final void internalAwaitDone() { |
222 |
> |
int s; // the odd construction reduces lock bias effects |
223 |
> |
while ((s = status) >= 0) { |
224 |
|
try { |
225 |
< |
while (status >= 0) { |
226 |
< |
long nt = nanos - System.nanoTime() - startTime; |
227 |
< |
if (nt <= 0) |
248 |
< |
break; |
249 |
< |
wait(nt / 1000000, (int) (nt % 1000000)); |
225 |
> |
synchronized (this) { |
226 |
> |
if (UNSAFE.compareAndSwapInt(this, statusOffset, s,SIGNAL)) |
227 |
> |
wait(); |
228 |
|
} |
229 |
|
} catch (InterruptedException ie) { |
230 |
< |
onInterruptedWait(); |
230 |
> |
cancelIfTerminating(); |
231 |
|
} |
232 |
|
} |
233 |
|
} |
234 |
|
|
257 |
– |
// Awaiting completion |
258 |
– |
|
235 |
|
/** |
236 |
< |
* Sets status to indicate there is joiner, then waits for join, |
237 |
< |
* surrounded with pool notifications. |
236 |
> |
* Blocks a worker thread until completed or timed out. Called |
237 |
> |
* only by pool. |
238 |
|
* |
239 |
< |
* @return status upon exit |
239 |
> |
* @return status on exit |
240 |
|
*/ |
241 |
< |
private int awaitDone(ForkJoinWorkerThread w, |
266 |
< |
boolean maintainParallelism) { |
267 |
< |
ForkJoinPool pool = (w == null) ? null : w.pool; |
241 |
> |
final int internalAwaitDone(long millis) { |
242 |
|
int s; |
243 |
< |
while ((s = status) >= 0) { |
244 |
< |
if (casStatus(s, (pool == null) ? s|EXTERNAL_SIGNAL : s+1)) { |
245 |
< |
if (pool == null || !pool.preJoin(this, maintainParallelism)) |
246 |
< |
doAwaitDone(); |
247 |
< |
if (((s = status) & INTERNAL_SIGNAL_MASK) != 0) |
274 |
< |
adjustPoolCountsOnUnblock(pool); |
275 |
< |
break; |
276 |
< |
} |
277 |
< |
} |
278 |
< |
return s; |
279 |
< |
} |
280 |
< |
|
281 |
< |
/** |
282 |
< |
* Timed version of awaitDone |
283 |
< |
* |
284 |
< |
* @return status upon exit |
285 |
< |
*/ |
286 |
< |
private int awaitDone(ForkJoinWorkerThread w, long nanos) { |
287 |
< |
ForkJoinPool pool = (w == null) ? null : w.pool; |
288 |
< |
int s; |
289 |
< |
while ((s = status) >= 0) { |
290 |
< |
if (casStatus(s, (pool == null) ? s|EXTERNAL_SIGNAL : s+1)) { |
291 |
< |
long startTime = System.nanoTime(); |
292 |
< |
if (pool == null || !pool.preJoin(this, false)) |
293 |
< |
doAwaitDone(startTime, nanos); |
294 |
< |
if ((s = status) >= 0) { |
295 |
< |
adjustPoolCountsOnCancelledWait(pool); |
296 |
< |
s = status; |
243 |
> |
if ((s = status) >= 0) { |
244 |
> |
try { |
245 |
> |
synchronized (this) { |
246 |
> |
if (UNSAFE.compareAndSwapInt(this, statusOffset, s,SIGNAL)) |
247 |
> |
wait(millis, 0); |
248 |
|
} |
249 |
< |
if (s < 0 && (s & INTERNAL_SIGNAL_MASK) != 0) |
250 |
< |
adjustPoolCountsOnUnblock(pool); |
300 |
< |
break; |
249 |
> |
} catch (InterruptedException ie) { |
250 |
> |
cancelIfTerminating(); |
251 |
|
} |
252 |
+ |
s = status; |
253 |
|
} |
254 |
|
return s; |
255 |
|
} |
256 |
|
|
257 |
|
/** |
258 |
< |
* Notifies pool that thread is unblocked. Called by signalled |
308 |
< |
* threads when woken by non-FJ threads (which is atypical). |
258 |
> |
* Blocks a non-worker-thread until completion. |
259 |
|
*/ |
260 |
< |
private void adjustPoolCountsOnUnblock(ForkJoinPool pool) { |
260 |
> |
private void externalAwaitDone() { |
261 |
|
int s; |
262 |
< |
do {} while ((s = status) < 0 && !casStatus(s, s & COMPLETION_MASK)); |
263 |
< |
if (pool != null && (s &= INTERNAL_SIGNAL_MASK) != 0) |
264 |
< |
pool.updateRunningCount(s); |
265 |
< |
} |
266 |
< |
|
267 |
< |
/** |
268 |
< |
* Notifies pool to adjust counts on cancelled or timed out wait. |
269 |
< |
*/ |
270 |
< |
private void adjustPoolCountsOnCancelledWait(ForkJoinPool pool) { |
271 |
< |
if (pool != null) { |
272 |
< |
int s; |
273 |
< |
while ((s = status) >= 0 && (s & INTERNAL_SIGNAL_MASK) != 0) { |
274 |
< |
if (casStatus(s, s - 1)) { |
325 |
< |
pool.updateRunningCount(1); |
262 |
> |
while ((s = status) >= 0) { |
263 |
> |
synchronized (this) { |
264 |
> |
if (UNSAFE.compareAndSwapInt(this, statusOffset, s, SIGNAL)){ |
265 |
> |
boolean interrupted = false; |
266 |
> |
while (status >= 0) { |
267 |
> |
try { |
268 |
> |
wait(); |
269 |
> |
} catch (InterruptedException ie) { |
270 |
> |
interrupted = true; |
271 |
> |
} |
272 |
> |
} |
273 |
> |
if (interrupted) |
274 |
> |
Thread.currentThread().interrupt(); |
275 |
|
break; |
276 |
|
} |
277 |
|
} |
279 |
|
} |
280 |
|
|
281 |
|
/** |
282 |
< |
* Handles interruptions during waits. |
283 |
< |
*/ |
284 |
< |
private void onInterruptedWait() { |
336 |
< |
ForkJoinWorkerThread w = getWorker(); |
337 |
< |
if (w == null) |
338 |
< |
Thread.currentThread().interrupt(); // re-interrupt |
339 |
< |
else if (w.isTerminating()) |
340 |
< |
cancelIgnoringExceptions(); |
341 |
< |
// else if FJworker, ignore interrupt |
342 |
< |
} |
343 |
< |
|
344 |
< |
// Recording and reporting exceptions |
345 |
< |
|
346 |
< |
private void setDoneExceptionally(Throwable rex) { |
347 |
< |
exceptionMap.put(this, rex); |
348 |
< |
setCompletion(EXCEPTIONAL); |
349 |
< |
} |
350 |
< |
|
351 |
< |
/** |
352 |
< |
* Throws the exception associated with status s. |
353 |
< |
* |
354 |
< |
* @throws the exception |
355 |
< |
*/ |
356 |
< |
private void reportException(int s) { |
357 |
< |
if ((s &= COMPLETION_MASK) < NORMAL) { |
358 |
< |
if (s == CANCELLED) |
359 |
< |
throw new CancellationException(); |
360 |
< |
else |
361 |
< |
rethrowException(exceptionMap.get(this)); |
362 |
< |
} |
363 |
< |
} |
364 |
< |
|
365 |
< |
/** |
366 |
< |
* Returns result or throws exception using j.u.c.Future conventions. |
367 |
< |
* Only call when {@code isDone} known to be true. |
368 |
< |
*/ |
369 |
< |
private V reportFutureResult() |
370 |
< |
throws ExecutionException, InterruptedException { |
371 |
< |
int s = status & COMPLETION_MASK; |
372 |
< |
if (s < NORMAL) { |
373 |
< |
Throwable ex; |
374 |
< |
if (s == CANCELLED) |
375 |
< |
throw new CancellationException(); |
376 |
< |
if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null) |
377 |
< |
throw new ExecutionException(ex); |
378 |
< |
if (Thread.interrupted()) |
379 |
< |
throw new InterruptedException(); |
380 |
< |
} |
381 |
< |
return getRawResult(); |
382 |
< |
} |
383 |
< |
|
384 |
< |
/** |
385 |
< |
* Returns result or throws exception using j.u.c.Future conventions |
386 |
< |
* with timeouts. |
387 |
< |
*/ |
388 |
< |
private V reportTimedFutureResult() |
389 |
< |
throws InterruptedException, ExecutionException, TimeoutException { |
390 |
< |
Throwable ex; |
391 |
< |
int s = status & COMPLETION_MASK; |
392 |
< |
if (s == NORMAL) |
393 |
< |
return getRawResult(); |
394 |
< |
if (s == CANCELLED) |
395 |
< |
throw new CancellationException(); |
396 |
< |
if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null) |
397 |
< |
throw new ExecutionException(ex); |
398 |
< |
if (Thread.interrupted()) |
399 |
< |
throw new InterruptedException(); |
400 |
< |
throw new TimeoutException(); |
401 |
< |
} |
402 |
< |
|
403 |
< |
// internal execution methods |
404 |
< |
|
405 |
< |
/** |
406 |
< |
* Calls exec, recording completion, and rethrowing exception if |
407 |
< |
* encountered. Caller should normally check status before calling. |
408 |
< |
* |
409 |
< |
* @return true if completed normally |
410 |
< |
*/ |
411 |
< |
private boolean tryExec() { |
412 |
< |
try { // try block must contain only call to exec |
413 |
< |
if (!exec()) |
414 |
< |
return false; |
415 |
< |
} catch (Throwable rex) { |
416 |
< |
setDoneExceptionally(rex); |
417 |
< |
rethrowException(rex); |
418 |
< |
return false; // not reached |
419 |
< |
} |
420 |
< |
setNormalCompletion(); |
421 |
< |
return true; |
422 |
< |
} |
423 |
< |
|
424 |
< |
/** |
425 |
< |
* Main execution method used by worker threads. Invokes |
426 |
< |
* base computation unless already complete. |
282 |
> |
* Unless done, calls exec and records status if completed, but |
283 |
> |
* doesn't wait for completion otherwise. Primary execution method |
284 |
> |
* for ForkJoinWorkerThread. |
285 |
|
*/ |
286 |
|
final void quietlyExec() { |
429 |
– |
if (status >= 0) { |
430 |
– |
try { |
431 |
– |
if (!exec()) |
432 |
– |
return; |
433 |
– |
} catch (Throwable rex) { |
434 |
– |
setDoneExceptionally(rex); |
435 |
– |
return; |
436 |
– |
} |
437 |
– |
setNormalCompletion(); |
438 |
– |
} |
439 |
– |
} |
440 |
– |
|
441 |
– |
/** |
442 |
– |
* Calls exec(), recording but not rethrowing exception. |
443 |
– |
* Caller should normally check status before calling. |
444 |
– |
* |
445 |
– |
* @return true if completed normally |
446 |
– |
*/ |
447 |
– |
private boolean tryQuietlyInvoke() { |
287 |
|
try { |
288 |
< |
if (!exec()) |
289 |
< |
return false; |
288 |
> |
if (status < 0 || !exec()) |
289 |
> |
return; |
290 |
|
} catch (Throwable rex) { |
291 |
< |
setDoneExceptionally(rex); |
292 |
< |
return false; |
454 |
< |
} |
455 |
< |
setNormalCompletion(); |
456 |
< |
return true; |
457 |
< |
} |
458 |
< |
|
459 |
< |
/** |
460 |
< |
* Cancels, ignoring any exceptions it throws. |
461 |
< |
*/ |
462 |
< |
final void cancelIgnoringExceptions() { |
463 |
< |
try { |
464 |
< |
cancel(false); |
465 |
< |
} catch (Throwable ignore) { |
291 |
> |
setExceptionalCompletion(rex); |
292 |
> |
return; |
293 |
|
} |
294 |
< |
} |
468 |
< |
|
469 |
< |
/** |
470 |
< |
* Main implementation of helpJoin |
471 |
< |
*/ |
472 |
< |
private int busyJoin(ForkJoinWorkerThread w) { |
473 |
< |
int s; |
474 |
< |
ForkJoinTask<?> t; |
475 |
< |
while ((s = status) >= 0 && (t = w.scanWhileJoining(this)) != null) |
476 |
< |
t.quietlyExec(); |
477 |
< |
return (s >= 0) ? awaitDone(w, false) : s; // block if no work |
294 |
> |
setCompletion(NORMAL); // must be outside try block |
295 |
|
} |
296 |
|
|
297 |
|
// public methods |
299 |
|
/** |
300 |
|
* Arranges to asynchronously execute this task. While it is not |
301 |
|
* necessarily enforced, it is a usage error to fork a task more |
302 |
< |
* than once unless it has completed and been reinitialized. This |
303 |
< |
* method may be invoked only from within ForkJoinTask |
304 |
< |
* computations (as may be determined using method {@link |
305 |
< |
* #inForkJoinPool}). Attempts to invoke in other contexts result |
306 |
< |
* in exceptions or errors, possibly including ClassCastException. |
302 |
> |
* than once unless it has completed and been reinitialized. |
303 |
> |
* Subsequent modifications to the state of this task or any data |
304 |
> |
* it operates on are not necessarily consistently observable by |
305 |
> |
* any thread other than the one executing it unless preceded by a |
306 |
> |
* call to {@link #join} or related methods, or a call to {@link |
307 |
> |
* #isDone} returning {@code true}. |
308 |
> |
* |
309 |
> |
* <p>This method may be invoked only from within {@code |
310 |
> |
* ForkJoinTask} computations (as may be determined using method |
311 |
> |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
312 |
> |
* result in exceptions or errors, possibly including {@code |
313 |
> |
* ClassCastException}. |
314 |
> |
* |
315 |
> |
* @return {@code this}, to simplify usage |
316 |
|
*/ |
317 |
< |
public final void fork() { |
317 |
> |
public final ForkJoinTask<V> fork() { |
318 |
|
((ForkJoinWorkerThread) Thread.currentThread()) |
319 |
|
.pushTask(this); |
320 |
+ |
return this; |
321 |
|
} |
322 |
|
|
323 |
|
/** |
324 |
< |
* Returns the result of the computation when it is ready. |
325 |
< |
* This method differs from {@code get} in that abnormal |
326 |
< |
* completion results in RuntimeExceptions or Errors, not |
327 |
< |
* ExecutionExceptions. |
324 |
> |
* Returns the result of the computation when it {@link #isDone is done}. |
325 |
> |
* This method differs from {@link #get()} in that |
326 |
> |
* abnormal completion results in {@code RuntimeException} or |
327 |
> |
* {@code Error}, not {@code ExecutionException}. |
328 |
|
* |
329 |
|
* @return the computed result |
330 |
|
*/ |
331 |
|
public final V join() { |
332 |
< |
ForkJoinWorkerThread w = getWorker(); |
333 |
< |
if (w == null || status < 0 || !w.unpushTask(this) || !tryExec()) |
334 |
< |
reportException(awaitDone(w, true)); |
332 |
> |
quietlyJoin(); |
333 |
> |
Throwable ex; |
334 |
> |
if (status < NORMAL && (ex = getException()) != null) |
335 |
> |
UNSAFE.throwException(ex); |
336 |
|
return getRawResult(); |
337 |
|
} |
338 |
|
|
339 |
|
/** |
340 |
|
* Commences performing this task, awaits its completion if |
341 |
< |
* necessary, and return its result. |
341 |
> |
* necessary, and returns its result, or throws an (unchecked) |
342 |
> |
* {@code RuntimeException} or {@code Error} if the underlying |
343 |
> |
* computation did so. |
344 |
|
* |
515 |
– |
* @throws Throwable (a RuntimeException, Error, or unchecked |
516 |
– |
* exception) if the underlying computation did so |
345 |
|
* @return the computed result |
346 |
|
*/ |
347 |
|
public final V invoke() { |
348 |
< |
if (status >= 0 && tryExec()) |
349 |
< |
return getRawResult(); |
350 |
< |
else |
351 |
< |
return join(); |
348 |
> |
quietlyInvoke(); |
349 |
> |
Throwable ex; |
350 |
> |
if (status < NORMAL && (ex = getException()) != null) |
351 |
> |
UNSAFE.throwException(ex); |
352 |
> |
return getRawResult(); |
353 |
|
} |
354 |
|
|
355 |
|
/** |
356 |
< |
* Forks both tasks, returning when {@code isDone} holds for |
357 |
< |
* both of them or an exception is encountered. This method may be |
358 |
< |
* invoked only from within ForkJoinTask computations (as may be |
359 |
< |
* determined using method {@link #inForkJoinPool}). Attempts to |
360 |
< |
* invoke in other contexts result in exceptions or errors, |
361 |
< |
* possibly including ClassCastException. |
362 |
< |
* |
363 |
< |
* @param t1 one task |
364 |
< |
* @param t2 the other task |
365 |
< |
* @throws NullPointerException if t1 or t2 are null |
366 |
< |
* @throws RuntimeException or Error if either task did so |
356 |
> |
* Forks the given tasks, returning when {@code isDone} holds for |
357 |
> |
* each task or an (unchecked) exception is encountered, in which |
358 |
> |
* case the exception is rethrown. If more than one task |
359 |
> |
* encounters an exception, then this method throws any one of |
360 |
> |
* these exceptions. If any task encounters an exception, the |
361 |
> |
* other may be cancelled. However, the execution status of |
362 |
> |
* individual tasks is not guaranteed upon exceptional return. The |
363 |
> |
* status of each task may be obtained using {@link |
364 |
> |
* #getException()} and related methods to check if they have been |
365 |
> |
* cancelled, completed normally or exceptionally, or left |
366 |
> |
* unprocessed. |
367 |
> |
* |
368 |
> |
* <p>This method may be invoked only from within {@code |
369 |
> |
* ForkJoinTask} computations (as may be determined using method |
370 |
> |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
371 |
> |
* result in exceptions or errors, possibly including {@code |
372 |
> |
* ClassCastException}. |
373 |
> |
* |
374 |
> |
* @param t1 the first task |
375 |
> |
* @param t2 the second task |
376 |
> |
* @throws NullPointerException if any task is null |
377 |
|
*/ |
378 |
< |
public static void invokeAll(ForkJoinTask<?>t1, ForkJoinTask<?> t2) { |
378 |
> |
public static void invokeAll(ForkJoinTask<?> t1, ForkJoinTask<?> t2) { |
379 |
|
t2.fork(); |
380 |
|
t1.invoke(); |
381 |
|
t2.join(); |
382 |
|
} |
383 |
|
|
384 |
|
/** |
385 |
< |
* Forks the given tasks, returning when {@code isDone} holds |
386 |
< |
* for all of them. If any task encounters an exception, others |
387 |
< |
* may be cancelled. This method may be invoked only from within |
388 |
< |
* ForkJoinTask computations (as may be determined using method |
389 |
< |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
390 |
< |
* result in exceptions or errors, possibly including |
391 |
< |
* ClassCastException. |
385 |
> |
* Forks the given tasks, returning when {@code isDone} holds for |
386 |
> |
* each task or an (unchecked) exception is encountered, in which |
387 |
> |
* case the exception is rethrown. If more than one task |
388 |
> |
* encounters an exception, then this method throws any one of |
389 |
> |
* these exceptions. If any task encounters an exception, others |
390 |
> |
* may be cancelled. However, the execution status of individual |
391 |
> |
* tasks is not guaranteed upon exceptional return. The status of |
392 |
> |
* each task may be obtained using {@link #getException()} and |
393 |
> |
* related methods to check if they have been cancelled, completed |
394 |
> |
* normally or exceptionally, or left unprocessed. |
395 |
> |
* |
396 |
> |
* <p>This method may be invoked only from within {@code |
397 |
> |
* ForkJoinTask} computations (as may be determined using method |
398 |
> |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
399 |
> |
* result in exceptions or errors, possibly including {@code |
400 |
> |
* ClassCastException}. |
401 |
|
* |
402 |
< |
* @param tasks the array of tasks |
403 |
< |
* @throws NullPointerException if tasks or any element are null |
556 |
< |
* @throws RuntimeException or Error if any task did so |
402 |
> |
* @param tasks the tasks |
403 |
> |
* @throws NullPointerException if any task is null |
404 |
|
*/ |
405 |
|
public static void invokeAll(ForkJoinTask<?>... tasks) { |
406 |
|
Throwable ex = null; |
415 |
|
t.fork(); |
416 |
|
else { |
417 |
|
t.quietlyInvoke(); |
418 |
< |
if (ex == null) |
418 |
> |
if (ex == null && t.status < NORMAL) |
419 |
|
ex = t.getException(); |
420 |
|
} |
421 |
|
} |
426 |
|
t.cancel(false); |
427 |
|
else { |
428 |
|
t.quietlyJoin(); |
429 |
< |
if (ex == null) |
429 |
> |
if (ex == null && t.status < NORMAL) |
430 |
|
ex = t.getException(); |
431 |
|
} |
432 |
|
} |
433 |
|
} |
434 |
|
if (ex != null) |
435 |
< |
rethrowException(ex); |
435 |
> |
UNSAFE.throwException(ex); |
436 |
|
} |
437 |
|
|
438 |
|
/** |
439 |
< |
* Forks all tasks in the collection, returning when |
440 |
< |
* {@code isDone} holds for all of them. If any task |
441 |
< |
* encounters an exception, others may be cancelled. This method |
442 |
< |
* may be invoked only from within ForkJoinTask computations (as |
443 |
< |
* may be determined using method {@link |
444 |
< |
* #inForkJoinPool}). Attempts to invoke in other contexts result |
445 |
< |
* in exceptions or errors, possibly including ClassCastException. |
439 |
> |
* Forks all tasks in the specified collection, returning when |
440 |
> |
* {@code isDone} holds for each task or an (unchecked) exception |
441 |
> |
* is encountered, in which case the exception is rethrown. If |
442 |
> |
* more than one task encounters an exception, then this method |
443 |
> |
* throws any one of these exceptions. If any task encounters an |
444 |
> |
* exception, others may be cancelled. However, the execution |
445 |
> |
* status of individual tasks is not guaranteed upon exceptional |
446 |
> |
* return. The status of each task may be obtained using {@link |
447 |
> |
* #getException()} and related methods to check if they have been |
448 |
> |
* cancelled, completed normally or exceptionally, or left |
449 |
> |
* unprocessed. |
450 |
> |
* |
451 |
> |
* <p>This method may be invoked only from within {@code |
452 |
> |
* ForkJoinTask} computations (as may be determined using method |
453 |
> |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
454 |
> |
* result in exceptions or errors, possibly including {@code |
455 |
> |
* ClassCastException}. |
456 |
|
* |
457 |
|
* @param tasks the collection of tasks |
458 |
+ |
* @return the tasks argument, to simplify usage |
459 |
|
* @throws NullPointerException if tasks or any element are null |
602 |
– |
* @throws RuntimeException or Error if any task did so |
460 |
|
*/ |
461 |
< |
public static void invokeAll(Collection<? extends ForkJoinTask<?>> tasks) { |
462 |
< |
if (!(tasks instanceof List<?>)) { |
461 |
> |
public static <T extends ForkJoinTask<?>> Collection<T> invokeAll(Collection<T> tasks) { |
462 |
> |
if (!(tasks instanceof RandomAccess) || !(tasks instanceof List<?>)) { |
463 |
|
invokeAll(tasks.toArray(new ForkJoinTask<?>[tasks.size()])); |
464 |
< |
return; |
464 |
> |
return tasks; |
465 |
|
} |
466 |
|
@SuppressWarnings("unchecked") |
467 |
|
List<? extends ForkJoinTask<?>> ts = |
478 |
|
t.fork(); |
479 |
|
else { |
480 |
|
t.quietlyInvoke(); |
481 |
< |
if (ex == null) |
481 |
> |
if (ex == null && t.status < NORMAL) |
482 |
|
ex = t.getException(); |
483 |
|
} |
484 |
|
} |
489 |
|
t.cancel(false); |
490 |
|
else { |
491 |
|
t.quietlyJoin(); |
492 |
< |
if (ex == null) |
492 |
> |
if (ex == null && t.status < NORMAL) |
493 |
|
ex = t.getException(); |
494 |
|
} |
495 |
|
} |
496 |
|
} |
497 |
|
if (ex != null) |
498 |
< |
rethrowException(ex); |
499 |
< |
} |
643 |
< |
|
644 |
< |
/** |
645 |
< |
* Returns true if the computation performed by this task has |
646 |
< |
* completed (or has been cancelled). |
647 |
< |
* |
648 |
< |
* @return true if this computation has completed |
649 |
< |
*/ |
650 |
< |
public final boolean isDone() { |
651 |
< |
return status < 0; |
652 |
< |
} |
653 |
< |
|
654 |
< |
/** |
655 |
< |
* Returns true if this task was cancelled. |
656 |
< |
* |
657 |
< |
* @return true if this task was cancelled |
658 |
< |
*/ |
659 |
< |
public final boolean isCancelled() { |
660 |
< |
return (status & COMPLETION_MASK) == CANCELLED; |
498 |
> |
UNSAFE.throwException(ex); |
499 |
> |
return tasks; |
500 |
|
} |
501 |
|
|
502 |
|
/** |
503 |
< |
* Asserts that the results of this task's computation will not be |
504 |
< |
* used. If a cancellation occurs before attempting to execute this |
505 |
< |
* task, then execution will be suppressed, {@code isCancelled} |
506 |
< |
* will report true, and {@code join} will result in a |
507 |
< |
* {@code CancellationException} being thrown. Otherwise, when |
508 |
< |
* cancellation races with completion, there are no guarantees |
509 |
< |
* about whether {@code isCancelled} will report true, whether |
671 |
< |
* {@code join} will return normally or via an exception, or |
672 |
< |
* whether these behaviors will remain consistent upon repeated |
673 |
< |
* invocation. |
503 |
> |
* Attempts to cancel execution of this task. This attempt will |
504 |
> |
* fail if the task has already completed, has already been |
505 |
> |
* cancelled, or could not be cancelled for some other reason. If |
506 |
> |
* successful, and this task has not started when cancel is |
507 |
> |
* called, execution of this task is suppressed, {@link |
508 |
> |
* #isCancelled} will report true, and {@link #join} will result |
509 |
> |
* in a {@code CancellationException} being thrown. |
510 |
|
* |
511 |
|
* <p>This method may be overridden in subclasses, but if so, must |
512 |
|
* still ensure that these minimal properties hold. In particular, |
513 |
< |
* the cancel method itself must not throw exceptions. |
513 |
> |
* the {@code cancel} method itself must not throw exceptions. |
514 |
|
* |
515 |
< |
* <p> This method is designed to be invoked by <em>other</em> |
515 |
> |
* <p>This method is designed to be invoked by <em>other</em> |
516 |
|
* tasks. To terminate the current task, you can just return or |
517 |
|
* throw an unchecked exception from its computation method, or |
518 |
< |
* invoke {@code completeExceptionally}. |
518 |
> |
* invoke {@link #completeExceptionally}. |
519 |
|
* |
520 |
|
* @param mayInterruptIfRunning this value is ignored in the |
521 |
< |
* default implementation because tasks are not in general |
521 |
> |
* default implementation because tasks are not |
522 |
|
* cancelled via interruption |
523 |
|
* |
524 |
< |
* @return true if this task is now cancelled |
524 |
> |
* @return {@code true} if this task is now cancelled |
525 |
|
*/ |
526 |
|
public boolean cancel(boolean mayInterruptIfRunning) { |
527 |
|
setCompletion(CANCELLED); |
528 |
< |
return (status & COMPLETION_MASK) == CANCELLED; |
528 |
> |
return status == CANCELLED; |
529 |
> |
} |
530 |
> |
|
531 |
> |
/** |
532 |
> |
* Cancels, ignoring any exceptions thrown by cancel. Used during |
533 |
> |
* worker and pool shutdown. Cancel is spec'ed not to throw any |
534 |
> |
* exceptions, but if it does anyway, we have no recourse during |
535 |
> |
* shutdown, so guard against this case. |
536 |
> |
*/ |
537 |
> |
final void cancelIgnoringExceptions() { |
538 |
> |
try { |
539 |
> |
cancel(false); |
540 |
> |
} catch (Throwable ignore) { |
541 |
> |
} |
542 |
|
} |
543 |
|
|
544 |
|
/** |
545 |
< |
* Returns true if this task threw an exception or was cancelled. |
545 |
> |
* Cancels if current thread is a terminating worker thread, |
546 |
> |
* ignoring any exceptions thrown by cancel. |
547 |
> |
*/ |
548 |
> |
final void cancelIfTerminating() { |
549 |
> |
Thread t = Thread.currentThread(); |
550 |
> |
if ((t instanceof ForkJoinWorkerThread) && |
551 |
> |
((ForkJoinWorkerThread) t).isTerminating()) { |
552 |
> |
try { |
553 |
> |
cancel(false); |
554 |
> |
} catch (Throwable ignore) { |
555 |
> |
} |
556 |
> |
} |
557 |
> |
} |
558 |
> |
|
559 |
> |
public final boolean isDone() { |
560 |
> |
return status < 0; |
561 |
> |
} |
562 |
> |
|
563 |
> |
public final boolean isCancelled() { |
564 |
> |
return status == CANCELLED; |
565 |
> |
} |
566 |
> |
|
567 |
> |
/** |
568 |
> |
* Returns {@code true} if this task threw an exception or was cancelled. |
569 |
|
* |
570 |
< |
* @return true if this task threw an exception or was cancelled |
570 |
> |
* @return {@code true} if this task threw an exception or was cancelled |
571 |
|
*/ |
572 |
|
public final boolean isCompletedAbnormally() { |
573 |
< |
return (status & COMPLETION_MASK) < NORMAL; |
573 |
> |
return status < NORMAL; |
574 |
> |
} |
575 |
> |
|
576 |
> |
/** |
577 |
> |
* Returns {@code true} if this task completed without throwing an |
578 |
> |
* exception and was not cancelled. |
579 |
> |
* |
580 |
> |
* @return {@code true} if this task completed without throwing an |
581 |
> |
* exception and was not cancelled |
582 |
> |
*/ |
583 |
> |
public final boolean isCompletedNormally() { |
584 |
> |
return status == NORMAL; |
585 |
|
} |
586 |
|
|
587 |
|
/** |
588 |
|
* Returns the exception thrown by the base computation, or a |
589 |
< |
* CancellationException if cancelled, or null if none or if the |
590 |
< |
* method has not yet completed. |
589 |
> |
* {@code CancellationException} if cancelled, or {@code null} if |
590 |
> |
* none or if the method has not yet completed. |
591 |
|
* |
592 |
< |
* @return the exception, or null if none |
592 |
> |
* @return the exception, or {@code null} if none |
593 |
|
*/ |
594 |
|
public final Throwable getException() { |
595 |
< |
int s = status & COMPLETION_MASK; |
596 |
< |
if (s >= NORMAL) |
597 |
< |
return null; |
598 |
< |
if (s == CANCELLED) |
716 |
< |
return new CancellationException(); |
717 |
< |
return exceptionMap.get(this); |
595 |
> |
int s = status; |
596 |
> |
return ((s >= NORMAL) ? null : |
597 |
> |
(s == CANCELLED) ? new CancellationException() : |
598 |
> |
exceptionMap.get(this)); |
599 |
|
} |
600 |
|
|
601 |
|
/** |
604 |
|
* {@code join} and related operations. This method may be used |
605 |
|
* to induce exceptions in asynchronous tasks, or to force |
606 |
|
* completion of tasks that would not otherwise complete. Its use |
607 |
< |
* in other situations is likely to be wrong. This method is |
607 |
> |
* in other situations is discouraged. This method is |
608 |
|
* overridable, but overridden versions must invoke {@code super} |
609 |
|
* implementation to maintain guarantees. |
610 |
|
* |
611 |
< |
* @param ex the exception to throw. If this exception is |
612 |
< |
* not a RuntimeException or Error, the actual exception thrown |
613 |
< |
* will be a RuntimeException with cause ex. |
611 |
> |
* @param ex the exception to throw. If this exception is not a |
612 |
> |
* {@code RuntimeException} or {@code Error}, the actual exception |
613 |
> |
* thrown will be a {@code RuntimeException} with cause {@code ex}. |
614 |
|
*/ |
615 |
|
public void completeExceptionally(Throwable ex) { |
616 |
< |
setDoneExceptionally((ex instanceof RuntimeException) || |
617 |
< |
(ex instanceof Error) ? ex : |
618 |
< |
new RuntimeException(ex)); |
616 |
> |
setExceptionalCompletion((ex instanceof RuntimeException) || |
617 |
> |
(ex instanceof Error) ? ex : |
618 |
> |
new RuntimeException(ex)); |
619 |
|
} |
620 |
|
|
621 |
|
/** |
622 |
|
* Completes this task, and if not already aborted or cancelled, |
623 |
< |
* returning a {@code null} result upon {@code join} and related |
624 |
< |
* operations. This method may be used to provide results for |
625 |
< |
* asynchronous tasks, or to provide alternative handling for |
626 |
< |
* tasks that would not otherwise complete normally. Its use in |
627 |
< |
* other situations is likely to be wrong. This method is |
628 |
< |
* overridable, but overridden versions must invoke {@code super} |
629 |
< |
* implementation to maintain guarantees. |
623 |
> |
* returning the given value as the result of subsequent |
624 |
> |
* invocations of {@code join} and related operations. This method |
625 |
> |
* may be used to provide results for asynchronous tasks, or to |
626 |
> |
* provide alternative handling for tasks that would not otherwise |
627 |
> |
* complete normally. Its use in other situations is |
628 |
> |
* discouraged. This method is overridable, but overridden |
629 |
> |
* versions must invoke {@code super} implementation to maintain |
630 |
> |
* guarantees. |
631 |
|
* |
632 |
|
* @param value the result value for this task |
633 |
|
*/ |
635 |
|
try { |
636 |
|
setRawResult(value); |
637 |
|
} catch (Throwable rex) { |
638 |
< |
setDoneExceptionally(rex); |
638 |
> |
setExceptionalCompletion(rex); |
639 |
|
return; |
640 |
|
} |
641 |
< |
setNormalCompletion(); |
760 |
< |
} |
761 |
< |
|
762 |
< |
public final V get() throws InterruptedException, ExecutionException { |
763 |
< |
ForkJoinWorkerThread w = getWorker(); |
764 |
< |
if (w == null || status < 0 || !w.unpushTask(this) || !tryQuietlyInvoke()) |
765 |
< |
awaitDone(w, true); |
766 |
< |
return reportFutureResult(); |
767 |
< |
} |
768 |
< |
|
769 |
< |
public final V get(long timeout, TimeUnit unit) |
770 |
< |
throws InterruptedException, ExecutionException, TimeoutException { |
771 |
< |
ForkJoinWorkerThread w = getWorker(); |
772 |
< |
if (w == null || status < 0 || !w.unpushTask(this) || !tryQuietlyInvoke()) |
773 |
< |
awaitDone(w, unit.toNanos(timeout)); |
774 |
< |
return reportTimedFutureResult(); |
641 |
> |
setCompletion(NORMAL); |
642 |
|
} |
643 |
|
|
644 |
|
/** |
645 |
< |
* Possibly executes other tasks until this task is ready, then |
646 |
< |
* returns the result of the computation. This method may be more |
780 |
< |
* efficient than {@code join}, but is only applicable when |
781 |
< |
* there are no potential dependencies between continuation of the |
782 |
< |
* current task and that of any other task that might be executed |
783 |
< |
* while helping. (This usually holds for pure divide-and-conquer |
784 |
< |
* tasks). This method may be invoked only from within |
785 |
< |
* ForkJoinTask computations (as may be determined using method |
786 |
< |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
787 |
< |
* result in exceptions or errors, possibly including |
788 |
< |
* ClassCastException. |
645 |
> |
* Waits if necessary for the computation to complete, and then |
646 |
> |
* retrieves its result. |
647 |
|
* |
648 |
|
* @return the computed result |
649 |
+ |
* @throws CancellationException if the computation was cancelled |
650 |
+ |
* @throws ExecutionException if the computation threw an |
651 |
+ |
* exception |
652 |
+ |
* @throws InterruptedException if the current thread is not a |
653 |
+ |
* member of a ForkJoinPool and was interrupted while waiting |
654 |
|
*/ |
655 |
< |
public final V helpJoin() { |
656 |
< |
ForkJoinWorkerThread w = (ForkJoinWorkerThread) Thread.currentThread(); |
657 |
< |
if (status < 0 || !w.unpushTask(this) || !tryExec()) |
658 |
< |
reportException(busyJoin(w)); |
655 |
> |
public final V get() throws InterruptedException, ExecutionException { |
656 |
> |
int s; |
657 |
> |
if (Thread.currentThread() instanceof ForkJoinWorkerThread) { |
658 |
> |
quietlyJoin(); |
659 |
> |
s = status; |
660 |
> |
} |
661 |
> |
else { |
662 |
> |
while ((s = status) >= 0) { |
663 |
> |
synchronized (this) { // interruptible form of awaitDone |
664 |
> |
if (UNSAFE.compareAndSwapInt(this, statusOffset, |
665 |
> |
s, SIGNAL)) { |
666 |
> |
while (status >= 0) |
667 |
> |
wait(); |
668 |
> |
} |
669 |
> |
} |
670 |
> |
} |
671 |
> |
} |
672 |
> |
if (s < NORMAL) { |
673 |
> |
Throwable ex; |
674 |
> |
if (s == CANCELLED) |
675 |
> |
throw new CancellationException(); |
676 |
> |
if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null) |
677 |
> |
throw new ExecutionException(ex); |
678 |
> |
} |
679 |
|
return getRawResult(); |
680 |
|
} |
681 |
|
|
682 |
|
/** |
683 |
< |
* Possibly executes other tasks until this task is ready. This |
684 |
< |
* method may be invoked only from within ForkJoinTask |
685 |
< |
* computations (as may be determined using method {@link |
686 |
< |
* #inForkJoinPool}). Attempts to invoke in other contexts result |
687 |
< |
* in exceptions or errors, possibly including ClassCastException. |
683 |
> |
* Waits if necessary for at most the given time for the computation |
684 |
> |
* to complete, and then retrieves its result, if available. |
685 |
> |
* |
686 |
> |
* @param timeout the maximum time to wait |
687 |
> |
* @param unit the time unit of the timeout argument |
688 |
> |
* @return the computed result |
689 |
> |
* @throws CancellationException if the computation was cancelled |
690 |
> |
* @throws ExecutionException if the computation threw an |
691 |
> |
* exception |
692 |
> |
* @throws InterruptedException if the current thread is not a |
693 |
> |
* member of a ForkJoinPool and was interrupted while waiting |
694 |
> |
* @throws TimeoutException if the wait timed out |
695 |
|
*/ |
696 |
< |
public final void quietlyHelpJoin() { |
697 |
< |
if (status >= 0) { |
698 |
< |
ForkJoinWorkerThread w = |
699 |
< |
(ForkJoinWorkerThread) Thread.currentThread(); |
700 |
< |
if (!w.unpushTask(this) || !tryQuietlyInvoke()) |
701 |
< |
busyJoin(w); |
696 |
> |
public final V get(long timeout, TimeUnit unit) |
697 |
> |
throws InterruptedException, ExecutionException, TimeoutException { |
698 |
> |
Thread t = Thread.currentThread(); |
699 |
> |
ForkJoinPool pool; |
700 |
> |
if (t instanceof ForkJoinWorkerThread) { |
701 |
> |
ForkJoinWorkerThread w = (ForkJoinWorkerThread) t; |
702 |
> |
if (status >= 0 && w.unpushTask(this)) |
703 |
> |
quietlyExec(); |
704 |
> |
pool = w.pool; |
705 |
|
} |
706 |
+ |
else |
707 |
+ |
pool = null; |
708 |
+ |
/* |
709 |
+ |
* Timed wait loop intermixes cases for FJ (pool != null) and |
710 |
+ |
* non FJ threads. For FJ, decrement pool count but don't try |
711 |
+ |
* for replacement; increment count on completion. For non-FJ, |
712 |
+ |
* deal with interrupts. This is messy, but a little less so |
713 |
+ |
* than is splitting the FJ and nonFJ cases. |
714 |
+ |
*/ |
715 |
+ |
boolean interrupted = false; |
716 |
+ |
boolean dec = false; // true if pool count decremented |
717 |
+ |
long nanos = unit.toNanos(timeout); |
718 |
+ |
for (;;) { |
719 |
+ |
if (pool == null && Thread.interrupted()) { |
720 |
+ |
interrupted = true; |
721 |
+ |
break; |
722 |
+ |
} |
723 |
+ |
int s = status; |
724 |
+ |
if (s < 0) |
725 |
+ |
break; |
726 |
+ |
if (UNSAFE.compareAndSwapInt(this, statusOffset, s, SIGNAL)) { |
727 |
+ |
long startTime = System.nanoTime(); |
728 |
+ |
long nt; // wait time |
729 |
+ |
while (status >= 0 && |
730 |
+ |
(nt = nanos - (System.nanoTime() - startTime)) > 0) { |
731 |
+ |
if (pool != null && !dec) |
732 |
+ |
dec = pool.tryDecrementRunningCount(); |
733 |
+ |
else { |
734 |
+ |
long ms = nt / 1000000; |
735 |
+ |
int ns = (int) (nt % 1000000); |
736 |
+ |
try { |
737 |
+ |
synchronized (this) { |
738 |
+ |
if (status >= 0) |
739 |
+ |
wait(ms, ns); |
740 |
+ |
} |
741 |
+ |
} catch (InterruptedException ie) { |
742 |
+ |
if (pool != null) |
743 |
+ |
cancelIfTerminating(); |
744 |
+ |
else { |
745 |
+ |
interrupted = true; |
746 |
+ |
break; |
747 |
+ |
} |
748 |
+ |
} |
749 |
+ |
} |
750 |
+ |
} |
751 |
+ |
break; |
752 |
+ |
} |
753 |
+ |
} |
754 |
+ |
if (pool != null && dec) |
755 |
+ |
pool.incrementRunningCount(); |
756 |
+ |
if (interrupted) |
757 |
+ |
throw new InterruptedException(); |
758 |
+ |
int es = status; |
759 |
+ |
if (es != NORMAL) { |
760 |
+ |
Throwable ex; |
761 |
+ |
if (es == CANCELLED) |
762 |
+ |
throw new CancellationException(); |
763 |
+ |
if (es == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null) |
764 |
+ |
throw new ExecutionException(ex); |
765 |
+ |
throw new TimeoutException(); |
766 |
+ |
} |
767 |
+ |
return getRawResult(); |
768 |
|
} |
769 |
|
|
770 |
|
/** |
771 |
< |
* Joins this task, without returning its result or throwing an |
771 |
> |
* Joins this task, without returning its result or throwing its |
772 |
|
* exception. This method may be useful when processing |
773 |
|
* collections of tasks when some have been cancelled or otherwise |
774 |
|
* known to have aborted. |
775 |
|
*/ |
776 |
|
public final void quietlyJoin() { |
777 |
< |
if (status >= 0) { |
778 |
< |
ForkJoinWorkerThread w = getWorker(); |
779 |
< |
if (w == null || !w.unpushTask(this) || !tryQuietlyInvoke()) |
780 |
< |
awaitDone(w, true); |
777 |
> |
Thread t; |
778 |
> |
if ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) { |
779 |
> |
ForkJoinWorkerThread w = (ForkJoinWorkerThread) t; |
780 |
> |
if (status >= 0) { |
781 |
> |
if (w.unpushTask(this)) { |
782 |
> |
boolean completed; |
783 |
> |
try { |
784 |
> |
completed = exec(); |
785 |
> |
} catch (Throwable rex) { |
786 |
> |
setExceptionalCompletion(rex); |
787 |
> |
return; |
788 |
> |
} |
789 |
> |
if (completed) { |
790 |
> |
setCompletion(NORMAL); |
791 |
> |
return; |
792 |
> |
} |
793 |
> |
} |
794 |
> |
w.joinTask(this); |
795 |
> |
} |
796 |
|
} |
797 |
+ |
else |
798 |
+ |
externalAwaitDone(); |
799 |
|
} |
800 |
|
|
801 |
|
/** |
802 |
|
* Commences performing this task and awaits its completion if |
803 |
< |
* necessary, without returning its result or throwing an |
804 |
< |
* exception. This method may be useful when processing |
833 |
< |
* collections of tasks when some have been cancelled or otherwise |
834 |
< |
* known to have aborted. |
803 |
> |
* necessary, without returning its result or throwing its |
804 |
> |
* exception. |
805 |
|
*/ |
806 |
|
public final void quietlyInvoke() { |
807 |
< |
if (status >= 0 && !tryQuietlyInvoke()) |
808 |
< |
quietlyJoin(); |
807 |
> |
if (status >= 0) { |
808 |
> |
boolean completed; |
809 |
> |
try { |
810 |
> |
completed = exec(); |
811 |
> |
} catch (Throwable rex) { |
812 |
> |
setExceptionalCompletion(rex); |
813 |
> |
return; |
814 |
> |
} |
815 |
> |
if (completed) |
816 |
> |
setCompletion(NORMAL); |
817 |
> |
else |
818 |
> |
quietlyJoin(); |
819 |
> |
} |
820 |
|
} |
821 |
|
|
822 |
|
/** |
823 |
|
* Possibly executes tasks until the pool hosting the current task |
824 |
< |
* {@link ForkJoinPool#isQuiescent}. This method may be of use in |
825 |
< |
* designs in which many tasks are forked, but none are explicitly |
826 |
< |
* joined, instead executing them until all are processed. |
824 |
> |
* {@link ForkJoinPool#isQuiescent is quiescent}. This method may |
825 |
> |
* be of use in designs in which many tasks are forked, but none |
826 |
> |
* are explicitly joined, instead executing them until all are |
827 |
> |
* processed. |
828 |
> |
* |
829 |
> |
* <p>This method may be invoked only from within {@code |
830 |
> |
* ForkJoinTask} computations (as may be determined using method |
831 |
> |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
832 |
> |
* result in exceptions or errors, possibly including {@code |
833 |
> |
* ClassCastException}. |
834 |
|
*/ |
835 |
|
public static void helpQuiesce() { |
836 |
|
((ForkJoinWorkerThread) Thread.currentThread()) |
843 |
|
* this task, but only if reuse occurs when this task has either |
844 |
|
* never been forked, or has been forked, then completed and all |
845 |
|
* outstanding joins of this task have also completed. Effects |
846 |
< |
* under any other usage conditions are not guaranteed, and are |
847 |
< |
* almost surely wrong. This method may be useful when executing |
846 |
> |
* under any other usage conditions are not guaranteed. |
847 |
> |
* This method may be useful when executing |
848 |
|
* pre-constructed trees of subtasks in loops. |
849 |
|
*/ |
850 |
|
public void reinitialize() { |
851 |
< |
if ((status & COMPLETION_MASK) == EXCEPTIONAL) |
851 |
> |
if (status == EXCEPTIONAL) |
852 |
|
exceptionMap.remove(this); |
853 |
|
status = 0; |
854 |
|
} |
857 |
|
* Returns the pool hosting the current task execution, or null |
858 |
|
* if this task is executing outside of any ForkJoinPool. |
859 |
|
* |
860 |
< |
* @return the pool, or null if none |
860 |
> |
* @see #inForkJoinPool |
861 |
> |
* @return the pool, or {@code null} if none |
862 |
|
*/ |
863 |
|
public static ForkJoinPool getPool() { |
864 |
|
Thread t = Thread.currentThread(); |
883 |
|
* by the current thread, and has not commenced executing in |
884 |
|
* another thread. This method may be useful when arranging |
885 |
|
* alternative local processing of tasks that could have been, but |
886 |
< |
* were not, stolen. This method may be invoked only from within |
887 |
< |
* ForkJoinTask computations (as may be determined using method |
888 |
< |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
889 |
< |
* result in exceptions or errors, possibly including |
890 |
< |
* ClassCastException. |
886 |
> |
* were not, stolen. |
887 |
> |
* |
888 |
> |
* <p>This method may be invoked only from within {@code |
889 |
> |
* ForkJoinTask} computations (as may be determined using method |
890 |
> |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
891 |
> |
* result in exceptions or errors, possibly including {@code |
892 |
> |
* ClassCastException}. |
893 |
|
* |
894 |
< |
* @return true if unforked |
894 |
> |
* @return {@code true} if unforked |
895 |
|
*/ |
896 |
|
public boolean tryUnfork() { |
897 |
|
return ((ForkJoinWorkerThread) Thread.currentThread()) |
904 |
|
* value may be useful for heuristic decisions about whether to |
905 |
|
* fork other tasks. |
906 |
|
* |
907 |
+ |
* <p>This method may be invoked only from within {@code |
908 |
+ |
* ForkJoinTask} computations (as may be determined using method |
909 |
+ |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
910 |
+ |
* result in exceptions or errors, possibly including {@code |
911 |
+ |
* ClassCastException}. |
912 |
+ |
* |
913 |
|
* @return the number of tasks |
914 |
|
*/ |
915 |
|
public static int getQueuedTaskCount() { |
927 |
|
* tasks, and to process computations locally if this threshold is |
928 |
|
* exceeded. |
929 |
|
* |
930 |
+ |
* <p>This method may be invoked only from within {@code |
931 |
+ |
* ForkJoinTask} computations (as may be determined using method |
932 |
+ |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
933 |
+ |
* result in exceptions or errors, possibly including {@code |
934 |
+ |
* ClassCastException}. |
935 |
+ |
* |
936 |
|
* @return the surplus number of tasks, which may be negative |
937 |
|
*/ |
938 |
|
public static int getSurplusQueuedTaskCount() { |
943 |
|
// Extension methods |
944 |
|
|
945 |
|
/** |
946 |
< |
* Returns the result that would be returned by {@code join}, |
947 |
< |
* even if this task completed abnormally, or null if this task is |
948 |
< |
* not known to have been completed. This method is designed to |
949 |
< |
* aid debugging, as well as to support extensions. Its use in any |
950 |
< |
* other context is discouraged. |
946 |
> |
* Returns the result that would be returned by {@link #join}, even |
947 |
> |
* if this task completed abnormally, or {@code null} if this task |
948 |
> |
* is not known to have been completed. This method is designed |
949 |
> |
* to aid debugging, as well as to support extensions. Its use in |
950 |
> |
* any other context is discouraged. |
951 |
|
* |
952 |
< |
* @return the result, or null if not completed |
952 |
> |
* @return the result, or {@code null} if not completed |
953 |
|
*/ |
954 |
|
public abstract V getRawResult(); |
955 |
|
|
968 |
|
* called otherwise. The return value controls whether this task |
969 |
|
* is considered to be done normally. It may return false in |
970 |
|
* asynchronous actions that require explicit invocations of |
971 |
< |
* {@code complete} to become joinable. It may throw exceptions |
972 |
< |
* to indicate abnormal exit. |
971 |
> |
* {@link #complete} to become joinable. It may also throw an |
972 |
> |
* (unchecked) exception to indicate abnormal exit. |
973 |
|
* |
974 |
< |
* @return true if completed normally |
972 |
< |
* @throws Error or RuntimeException if encountered during computation |
974 |
> |
* @return {@code true} if completed normally |
975 |
|
*/ |
976 |
|
protected abstract boolean exec(); |
977 |
|
|
978 |
|
/** |
979 |
< |
* Returns, but does not unschedule or execute, the task queued by |
980 |
< |
* the current thread but not yet executed, if one is |
979 |
> |
* Returns, but does not unschedule or execute, a task queued by |
980 |
> |
* the current thread but not yet executed, if one is immediately |
981 |
|
* available. There is no guarantee that this task will actually |
982 |
< |
* be polled or executed next. This method is designed primarily |
983 |
< |
* to support extensions, and is unlikely to be useful otherwise. |
984 |
< |
* This method may be invoked only from within ForkJoinTask |
985 |
< |
* computations (as may be determined using method {@link |
986 |
< |
* #inForkJoinPool}). Attempts to invoke in other contexts result |
985 |
< |
* in exceptions or errors, possibly including ClassCastException. |
982 |
> |
* be polled or executed next. Conversely, this method may return |
983 |
> |
* null even if a task exists but cannot be accessed without |
984 |
> |
* contention with other threads. This method is designed |
985 |
> |
* primarily to support extensions, and is unlikely to be useful |
986 |
> |
* otherwise. |
987 |
|
* |
988 |
< |
* @return the next task, or null if none are available |
988 |
> |
* <p>This method may be invoked only from within {@code |
989 |
> |
* ForkJoinTask} computations (as may be determined using method |
990 |
> |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
991 |
> |
* result in exceptions or errors, possibly including {@code |
992 |
> |
* ClassCastException}. |
993 |
> |
* |
994 |
> |
* @return the next task, or {@code null} if none are available |
995 |
|
*/ |
996 |
|
protected static ForkJoinTask<?> peekNextLocalTask() { |
997 |
|
return ((ForkJoinWorkerThread) Thread.currentThread()) |
1002 |
|
* Unschedules and returns, without executing, the next task |
1003 |
|
* queued by the current thread but not yet executed. This method |
1004 |
|
* is designed primarily to support extensions, and is unlikely to |
1005 |
< |
* be useful otherwise. This method may be invoked only from |
1006 |
< |
* within ForkJoinTask computations (as may be determined using |
1007 |
< |
* method {@link #inForkJoinPool}). Attempts to invoke in other |
1008 |
< |
* contexts result in exceptions or errors, possibly including |
1009 |
< |
* ClassCastException. |
1005 |
> |
* be useful otherwise. |
1006 |
> |
* |
1007 |
> |
* <p>This method may be invoked only from within {@code |
1008 |
> |
* ForkJoinTask} computations (as may be determined using method |
1009 |
> |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
1010 |
> |
* result in exceptions or errors, possibly including {@code |
1011 |
> |
* ClassCastException}. |
1012 |
|
* |
1013 |
< |
* @return the next task, or null if none are available |
1013 |
> |
* @return the next task, or {@code null} if none are available |
1014 |
|
*/ |
1015 |
|
protected static ForkJoinTask<?> pollNextLocalTask() { |
1016 |
|
return ((ForkJoinWorkerThread) Thread.currentThread()) |
1025 |
|
* {@code null} result does not necessarily imply quiescence |
1026 |
|
* of the pool this task is operating in. This method is designed |
1027 |
|
* primarily to support extensions, and is unlikely to be useful |
1028 |
< |
* otherwise. This method may be invoked only from within |
1029 |
< |
* ForkJoinTask computations (as may be determined using method |
1030 |
< |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
1031 |
< |
* result in exceptions or errors, possibly including |
1032 |
< |
* ClassCastException. |
1028 |
> |
* otherwise. |
1029 |
> |
* |
1030 |
> |
* <p>This method may be invoked only from within {@code |
1031 |
> |
* ForkJoinTask} computations (as may be determined using method |
1032 |
> |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
1033 |
> |
* result in exceptions or errors, possibly including {@code |
1034 |
> |
* ClassCastException}. |
1035 |
|
* |
1036 |
< |
* @return a task, or null if none are available |
1036 |
> |
* @return a task, or {@code null} if none are available |
1037 |
|
*/ |
1038 |
|
protected static ForkJoinTask<?> pollTask() { |
1039 |
|
return ((ForkJoinWorkerThread) Thread.currentThread()) |
1040 |
|
.pollTask(); |
1041 |
|
} |
1042 |
|
|
1043 |
+ |
/** |
1044 |
+ |
* Adaptor for Runnables. This implements RunnableFuture |
1045 |
+ |
* to be compliant with AbstractExecutorService constraints |
1046 |
+ |
* when used in ForkJoinPool. |
1047 |
+ |
*/ |
1048 |
+ |
static final class AdaptedRunnable<T> extends ForkJoinTask<T> |
1049 |
+ |
implements RunnableFuture<T> { |
1050 |
+ |
final Runnable runnable; |
1051 |
+ |
final T resultOnCompletion; |
1052 |
+ |
T result; |
1053 |
+ |
AdaptedRunnable(Runnable runnable, T result) { |
1054 |
+ |
if (runnable == null) throw new NullPointerException(); |
1055 |
+ |
this.runnable = runnable; |
1056 |
+ |
this.resultOnCompletion = result; |
1057 |
+ |
} |
1058 |
+ |
public T getRawResult() { return result; } |
1059 |
+ |
public void setRawResult(T v) { result = v; } |
1060 |
+ |
public boolean exec() { |
1061 |
+ |
runnable.run(); |
1062 |
+ |
result = resultOnCompletion; |
1063 |
+ |
return true; |
1064 |
+ |
} |
1065 |
+ |
public void run() { invoke(); } |
1066 |
+ |
private static final long serialVersionUID = 5232453952276885070L; |
1067 |
+ |
} |
1068 |
+ |
|
1069 |
+ |
/** |
1070 |
+ |
* Adaptor for Callables |
1071 |
+ |
*/ |
1072 |
+ |
static final class AdaptedCallable<T> extends ForkJoinTask<T> |
1073 |
+ |
implements RunnableFuture<T> { |
1074 |
+ |
final Callable<? extends T> callable; |
1075 |
+ |
T result; |
1076 |
+ |
AdaptedCallable(Callable<? extends T> callable) { |
1077 |
+ |
if (callable == null) throw new NullPointerException(); |
1078 |
+ |
this.callable = callable; |
1079 |
+ |
} |
1080 |
+ |
public T getRawResult() { return result; } |
1081 |
+ |
public void setRawResult(T v) { result = v; } |
1082 |
+ |
public boolean exec() { |
1083 |
+ |
try { |
1084 |
+ |
result = callable.call(); |
1085 |
+ |
return true; |
1086 |
+ |
} catch (Error err) { |
1087 |
+ |
throw err; |
1088 |
+ |
} catch (RuntimeException rex) { |
1089 |
+ |
throw rex; |
1090 |
+ |
} catch (Exception ex) { |
1091 |
+ |
throw new RuntimeException(ex); |
1092 |
+ |
} |
1093 |
+ |
} |
1094 |
+ |
public void run() { invoke(); } |
1095 |
+ |
private static final long serialVersionUID = 2838392045355241008L; |
1096 |
+ |
} |
1097 |
+ |
|
1098 |
+ |
/** |
1099 |
+ |
* Returns a new {@code ForkJoinTask} that performs the {@code run} |
1100 |
+ |
* method of the given {@code Runnable} as its action, and returns |
1101 |
+ |
* a null result upon {@link #join}. |
1102 |
+ |
* |
1103 |
+ |
* @param runnable the runnable action |
1104 |
+ |
* @return the task |
1105 |
+ |
*/ |
1106 |
+ |
public static ForkJoinTask<?> adapt(Runnable runnable) { |
1107 |
+ |
return new AdaptedRunnable<Void>(runnable, null); |
1108 |
+ |
} |
1109 |
+ |
|
1110 |
+ |
/** |
1111 |
+ |
* Returns a new {@code ForkJoinTask} that performs the {@code run} |
1112 |
+ |
* method of the given {@code Runnable} as its action, and returns |
1113 |
+ |
* the given result upon {@link #join}. |
1114 |
+ |
* |
1115 |
+ |
* @param runnable the runnable action |
1116 |
+ |
* @param result the result upon completion |
1117 |
+ |
* @return the task |
1118 |
+ |
*/ |
1119 |
+ |
public static <T> ForkJoinTask<T> adapt(Runnable runnable, T result) { |
1120 |
+ |
return new AdaptedRunnable<T>(runnable, result); |
1121 |
+ |
} |
1122 |
+ |
|
1123 |
+ |
/** |
1124 |
+ |
* Returns a new {@code ForkJoinTask} that performs the {@code call} |
1125 |
+ |
* method of the given {@code Callable} as its action, and returns |
1126 |
+ |
* its result upon {@link #join}, translating any checked exceptions |
1127 |
+ |
* encountered into {@code RuntimeException}. |
1128 |
+ |
* |
1129 |
+ |
* @param callable the callable action |
1130 |
+ |
* @return the task |
1131 |
+ |
*/ |
1132 |
+ |
public static <T> ForkJoinTask<T> adapt(Callable<? extends T> callable) { |
1133 |
+ |
return new AdaptedCallable<T>(callable); |
1134 |
+ |
} |
1135 |
+ |
|
1136 |
|
// Serialization support |
1137 |
|
|
1138 |
|
private static final long serialVersionUID = -7721805057305804111L; |
1139 |
|
|
1140 |
|
/** |
1141 |
< |
* Save the state to a stream. |
1141 |
> |
* Saves the state to a stream (that is, serializes it). |
1142 |
|
* |
1143 |
|
* @serialData the current run status and the exception thrown |
1144 |
< |
* during execution, or null if none |
1144 |
> |
* during execution, or {@code null} if none |
1145 |
|
* @param s the stream |
1146 |
|
*/ |
1147 |
|
private void writeObject(java.io.ObjectOutputStream s) |
1151 |
|
} |
1152 |
|
|
1153 |
|
/** |
1154 |
< |
* Reconstitute the instance from a stream. |
1154 |
> |
* Reconstitutes the instance from a stream (that is, deserializes it). |
1155 |
|
* |
1156 |
|
* @param s the stream |
1157 |
|
*/ |
1158 |
|
private void readObject(java.io.ObjectInputStream s) |
1159 |
|
throws java.io.IOException, ClassNotFoundException { |
1160 |
|
s.defaultReadObject(); |
1057 |
– |
status &= ~INTERNAL_SIGNAL_MASK; // clear internal signal counts |
1058 |
– |
status |= EXTERNAL_SIGNAL; // conservatively set external signal |
1161 |
|
Object ex = s.readObject(); |
1162 |
|
if (ex != null) |
1163 |
< |
setDoneExceptionally((Throwable) ex); |
1163 |
> |
setExceptionalCompletion((Throwable) ex); |
1164 |
> |
} |
1165 |
> |
|
1166 |
> |
// Unsafe mechanics |
1167 |
> |
|
1168 |
> |
private static final sun.misc.Unsafe UNSAFE = getUnsafe(); |
1169 |
> |
private static final long statusOffset = |
1170 |
> |
objectFieldOffset("status", ForkJoinTask.class); |
1171 |
> |
|
1172 |
> |
private static long objectFieldOffset(String field, Class<?> klazz) { |
1173 |
> |
try { |
1174 |
> |
return UNSAFE.objectFieldOffset(klazz.getDeclaredField(field)); |
1175 |
> |
} catch (NoSuchFieldException e) { |
1176 |
> |
// Convert Exception to corresponding Error |
1177 |
> |
NoSuchFieldError error = new NoSuchFieldError(field); |
1178 |
> |
error.initCause(e); |
1179 |
> |
throw error; |
1180 |
> |
} |
1181 |
|
} |
1182 |
|
|
1183 |
< |
// Unsafe mechanics for jsr166y 3rd party package. |
1183 |
> |
/** |
1184 |
> |
* Returns a sun.misc.Unsafe. Suitable for use in a 3rd party package. |
1185 |
> |
* Replace with a simple call to Unsafe.getUnsafe when integrating |
1186 |
> |
* into a jdk. |
1187 |
> |
* |
1188 |
> |
* @return a sun.misc.Unsafe |
1189 |
> |
*/ |
1190 |
|
private static sun.misc.Unsafe getUnsafe() { |
1191 |
|
try { |
1192 |
|
return sun.misc.Unsafe.getUnsafe(); |
1193 |
|
} catch (SecurityException se) { |
1194 |
|
try { |
1195 |
|
return java.security.AccessController.doPrivileged |
1196 |
< |
(new java.security.PrivilegedExceptionAction<sun.misc.Unsafe>() { |
1196 |
> |
(new java.security |
1197 |
> |
.PrivilegedExceptionAction<sun.misc.Unsafe>() { |
1198 |
|
public sun.misc.Unsafe run() throws Exception { |
1199 |
< |
return getUnsafeByReflection(); |
1199 |
> |
java.lang.reflect.Field f = sun.misc |
1200 |
> |
.Unsafe.class.getDeclaredField("theUnsafe"); |
1201 |
> |
f.setAccessible(true); |
1202 |
> |
return (sun.misc.Unsafe) f.get(null); |
1203 |
|
}}); |
1204 |
|
} catch (java.security.PrivilegedActionException e) { |
1205 |
|
throw new RuntimeException("Could not initialize intrinsics", |
1207 |
|
} |
1208 |
|
} |
1209 |
|
} |
1081 |
– |
|
1082 |
– |
private static sun.misc.Unsafe getUnsafeByReflection() |
1083 |
– |
throws NoSuchFieldException, IllegalAccessException { |
1084 |
– |
java.lang.reflect.Field f = |
1085 |
– |
sun.misc.Unsafe.class.getDeclaredField("theUnsafe"); |
1086 |
– |
f.setAccessible(true); |
1087 |
– |
return (sun.misc.Unsafe) f.get(null); |
1088 |
– |
} |
1089 |
– |
|
1090 |
– |
private static long fieldOffset(String fieldName, Class<?> klazz) { |
1091 |
– |
try { |
1092 |
– |
return UNSAFE.objectFieldOffset(klazz.getDeclaredField(fieldName)); |
1093 |
– |
} catch (NoSuchFieldException e) { |
1094 |
– |
// Convert Exception to Error |
1095 |
– |
NoSuchFieldError error = new NoSuchFieldError(fieldName); |
1096 |
– |
error.initCause(e); |
1097 |
– |
throw error; |
1098 |
– |
} |
1099 |
– |
} |
1100 |
– |
|
1101 |
– |
private static final sun.misc.Unsafe UNSAFE = getUnsafe(); |
1102 |
– |
static final long statusOffset = |
1103 |
– |
fieldOffset("status", ForkJoinTask.class); |
1104 |
– |
|
1210 |
|
} |