64 |
|
* results of a task is {@link #join}, but there are several variants: |
65 |
|
* The {@link Future#get} methods support interruptible and/or timed |
66 |
|
* waits for completion and report results using {@code Future} |
67 |
< |
* conventions. Method {@link #helpJoin} enables callers to actively |
68 |
< |
* execute other tasks while awaiting joins, which is sometimes more |
69 |
< |
* efficient but only applies when all subtasks are known to be |
70 |
< |
* strictly tree-structured. Method {@link #invoke} is semantically |
67 |
> |
* conventions. Method {@link #invoke} is semantically |
68 |
|
* equivalent to {@code fork(); join()} but always attempts to begin |
69 |
|
* execution in the current thread. The "<em>quiet</em>" forms of |
70 |
|
* these methods do not extract results or report exceptions. These |
122 |
|
* |
123 |
|
* <p>This class provides {@code adapt} methods for {@link Runnable} |
124 |
|
* and {@link Callable}, that may be of use when mixing execution of |
125 |
< |
* {@code ForkJoinTasks} with other kinds of tasks. When all tasks |
126 |
< |
* are of this form, consider using a pool in |
130 |
< |
* {@linkplain ForkJoinPool#setAsyncMode async mode}. |
125 |
> |
* {@code ForkJoinTasks} with other kinds of tasks. When all tasks are |
126 |
> |
* of this form, consider using a pool constructed in <em>asyncMode</em>. |
127 |
|
* |
128 |
|
* <p>ForkJoinTasks are {@code Serializable}, which enables them to be |
129 |
|
* used in extensions such as remote execution frameworks. It is |
147 |
|
* in a way that flows well in javadocs. |
148 |
|
*/ |
149 |
|
|
150 |
< |
/** |
151 |
< |
* Run control status bits packed into a single int to minimize |
152 |
< |
* footprint and to ensure atomicity (via CAS). Status is |
153 |
< |
* initially zero, and takes on nonnegative values until |
154 |
< |
* completed, upon which status holds COMPLETED. CANCELLED, or |
155 |
< |
* EXCEPTIONAL, which use the top 3 bits. Tasks undergoing |
156 |
< |
* blocking waits by other threads have SIGNAL_MASK bits set -- |
157 |
< |
* bit 15 for external (nonFJ) waits, and the rest a count of |
158 |
< |
* waiting FJ threads. (This representation relies on |
159 |
< |
* ForkJoinPool max thread limits). Signal counts are not directly |
160 |
< |
* incremented by ForkJoinTask methods, but instead via a call to |
161 |
< |
* requestSignal within ForkJoinPool.preJoin, once their need is |
162 |
< |
* established. |
163 |
< |
* |
164 |
< |
* Completion of a stolen task with SIGNAL_MASK bits set awakens |
169 |
< |
* any waiters via notifyAll. Even though suboptimal for some |
170 |
< |
* purposes, we use basic builtin wait/notify to take advantage of |
171 |
< |
* "monitor inflation" in JVMs that we would otherwise need to |
172 |
< |
* emulate to avoid adding further per-task bookkeeping overhead. |
173 |
< |
* We want these monitors to be "fat", i.e., not use biasing or |
174 |
< |
* thin-lock techniques, so use some odd coding idioms that tend |
175 |
< |
* to avoid them. |
176 |
< |
* |
177 |
< |
* Note that bits 16-28 are currently unused. Also value |
178 |
< |
* 0x80000000 is available as spare completion value. |
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 |
> |
* COMPLETED. 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 |
+ |
/** Run status of this task */ |
168 |
|
volatile int status; // accessed directly by pool and workers |
169 |
|
|
170 |
< |
private static final int COMPLETION_MASK = 0xe0000000; |
171 |
< |
private static final int NORMAL = 0xe0000000; // == mask |
172 |
< |
private static final int CANCELLED = 0xc0000000; |
173 |
< |
private static final int EXCEPTIONAL = 0xa0000000; |
186 |
< |
private static final int SIGNAL_MASK = 0x0000ffff; |
187 |
< |
private static final int INTERNAL_SIGNAL_MASK = 0x00007fff; |
188 |
< |
private static final int EXTERNAL_SIGNAL = 0x00008000; |
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 |
191 |
|
* also clearing signal request bits. |
192 |
|
* |
193 |
|
* @param completion one of NORMAL, CANCELLED, EXCEPTIONAL |
194 |
+ |
* @return status on exit |
195 |
|
*/ |
196 |
< |
private void setCompletion(int completion) { |
196 |
> |
private int setCompletion(int completion) { |
197 |
|
int s; |
198 |
|
while ((s = status) >= 0) { |
199 |
|
if (UNSAFE.compareAndSwapInt(this, statusOffset, s, completion)) { |
200 |
< |
if ((s & SIGNAL_MASK) != 0) { |
215 |
< |
Thread t = Thread.currentThread(); |
216 |
< |
if (t instanceof ForkJoinWorkerThread) |
217 |
< |
((ForkJoinWorkerThread) t).pool.updateRunningCount |
218 |
< |
(s & INTERNAL_SIGNAL_MASK); |
200 |
> |
if (s != 0) |
201 |
|
synchronized (this) { notifyAll(); } |
202 |
< |
} |
221 |
< |
return; |
202 |
> |
return completion; |
203 |
|
} |
204 |
|
} |
205 |
+ |
return s; |
206 |
|
} |
207 |
|
|
208 |
|
/** |
209 |
|
* Record exception and set exceptional completion |
210 |
+ |
* @return status on exit |
211 |
|
*/ |
212 |
< |
private void setDoneExceptionally(Throwable rex) { |
212 |
> |
private int setExceptionalCompletion(Throwable rex) { |
213 |
|
exceptionMap.put(this, rex); |
214 |
< |
setCompletion(EXCEPTIONAL); |
232 |
< |
} |
233 |
< |
|
234 |
< |
/** |
235 |
< |
* Main internal execution method: Unless done, calls exec and |
236 |
< |
* records completion. |
237 |
< |
* |
238 |
< |
* @return true if ran and completed normally |
239 |
< |
*/ |
240 |
< |
final boolean tryExec() { |
241 |
< |
try { |
242 |
< |
if (status < 0 || !exec()) |
243 |
< |
return false; |
244 |
< |
} catch (Throwable rex) { |
245 |
< |
setDoneExceptionally(rex); |
246 |
< |
return false; |
247 |
< |
} |
248 |
< |
setCompletion(NORMAL); // must be outside try block |
249 |
< |
return true; |
214 |
> |
return setCompletion(EXCEPTIONAL); |
215 |
|
} |
216 |
|
|
217 |
|
/** |
218 |
< |
* Increments internal signal count (thus requesting signal upon |
254 |
< |
* completion) unless already done. Call only once per join. |
255 |
< |
* Used by ForkJoinPool.preJoin. |
256 |
< |
* |
257 |
< |
* @return status |
218 |
> |
* Blocks a worker thread until completion. Called only by pool. |
219 |
|
*/ |
220 |
< |
final int requestSignal() { |
221 |
< |
int s; |
222 |
< |
do {} while ((s = status) >= 0 && |
223 |
< |
!UNSAFE.compareAndSwapInt(this, statusOffset, s, s + 1)); |
224 |
< |
return s; |
225 |
< |
} |
226 |
< |
|
266 |
< |
/** |
267 |
< |
* Sets external signal request unless already done. |
268 |
< |
* |
269 |
< |
* @return status |
270 |
< |
*/ |
271 |
< |
private int requestExternalSignal() { |
272 |
< |
int s; |
273 |
< |
do {} while ((s = status) >= 0 && |
274 |
< |
!UNSAFE.compareAndSwapInt(this, statusOffset, |
275 |
< |
s, s | EXTERNAL_SIGNAL)); |
276 |
< |
return s; |
277 |
< |
} |
278 |
< |
|
279 |
< |
/* |
280 |
< |
* Awaiting completion. The four versions, internal vs external X |
281 |
< |
* untimed vs timed, have the same overall structure but differ |
282 |
< |
* from each other enough to defy simple integration. |
283 |
< |
*/ |
284 |
< |
|
285 |
< |
/** |
286 |
< |
* Blocks a worker until this task is done, also maintaining pool |
287 |
< |
* and signal counts |
288 |
< |
*/ |
289 |
< |
private void awaitDone(ForkJoinWorkerThread w) { |
290 |
< |
if (status >= 0) { |
291 |
< |
w.pool.preJoin(this); |
292 |
< |
while (status >= 0) { |
293 |
< |
try { // minimize lock scope |
294 |
< |
synchronized(this) { |
295 |
< |
if (status >= 0) |
296 |
< |
wait(); |
297 |
< |
else { // help release; also helps avoid lock-biasing |
298 |
< |
notifyAll(); |
299 |
< |
break; |
300 |
< |
} |
301 |
< |
} |
302 |
< |
} catch (InterruptedException ie) { |
303 |
< |
cancelIfTerminating(); |
220 |
> |
final void internalAwaitDone() { |
221 |
> |
int s; // the odd construction reduces lock bias effects |
222 |
> |
while ((s = status) >= 0) { |
223 |
> |
try { |
224 |
> |
synchronized(this) { |
225 |
> |
if (UNSAFE.compareAndSwapInt(this, statusOffset, s,SIGNAL)) |
226 |
> |
wait(); |
227 |
|
} |
228 |
+ |
} catch (InterruptedException ie) { |
229 |
+ |
cancelIfTerminating(); |
230 |
|
} |
231 |
|
} |
232 |
|
} |
233 |
|
|
234 |
|
/** |
235 |
< |
* Blocks a non-ForkJoin thread until this task is done. |
235 |
> |
* Blocks a non-worker-thread until completion. |
236 |
> |
* @return status on exit |
237 |
|
*/ |
238 |
< |
private void externalAwaitDone() { |
239 |
< |
if (requestExternalSignal() >= 0) { |
240 |
< |
boolean interrupted = false; |
241 |
< |
while (status >= 0) { |
242 |
< |
try { |
243 |
< |
synchronized(this) { |
244 |
< |
if (status >= 0) |
245 |
< |
wait(); |
246 |
< |
else { |
247 |
< |
notifyAll(); |
248 |
< |
break; |
238 |
> |
private int externalAwaitDone() { |
239 |
> |
int s; |
240 |
> |
while ((s = status) >= 0) { |
241 |
> |
synchronized(this) { |
242 |
> |
if (UNSAFE.compareAndSwapInt(this, statusOffset, s, SIGNAL)){ |
243 |
> |
boolean interrupted = false; |
244 |
> |
while ((s = status) >= 0) { |
245 |
> |
try { |
246 |
> |
wait(); |
247 |
> |
} catch (InterruptedException ie) { |
248 |
> |
interrupted = true; |
249 |
|
} |
250 |
|
} |
251 |
< |
} catch (InterruptedException ie) { |
252 |
< |
interrupted = true; |
251 |
> |
if (interrupted) |
252 |
> |
Thread.currentThread().interrupt(); |
253 |
> |
break; |
254 |
|
} |
255 |
|
} |
329 |
– |
if (interrupted) |
330 |
– |
Thread.currentThread().interrupt(); |
256 |
|
} |
257 |
+ |
return s; |
258 |
|
} |
259 |
|
|
260 |
|
/** |
261 |
< |
* Blocks a worker until this task is done or timeout elapses |
261 |
> |
* Unless done, calls exec and records status if completed, but |
262 |
> |
* doesn't wait for completion otherwise. Primary execution method |
263 |
> |
* for ForkJoinWorkerThread. |
264 |
|
*/ |
265 |
< |
private void timedAwaitDone(ForkJoinWorkerThread w, long nanos) { |
266 |
< |
if (status >= 0) { |
267 |
< |
long startTime = System.nanoTime(); |
268 |
< |
ForkJoinPool pool = w.pool; |
269 |
< |
pool.preJoin(this); |
270 |
< |
while (status >= 0) { |
271 |
< |
long nt = nanos - (System.nanoTime() - startTime); |
344 |
< |
if (nt > 0) { |
345 |
< |
long ms = nt / 1000000; |
346 |
< |
int ns = (int) (nt % 1000000); |
347 |
< |
try { |
348 |
< |
synchronized(this) { if (status >= 0) wait(ms, ns); } |
349 |
< |
} catch (InterruptedException ie) { |
350 |
< |
cancelIfTerminating(); |
351 |
< |
} |
352 |
< |
} |
353 |
< |
else { |
354 |
< |
int s; // adjust running count on timeout |
355 |
< |
while ((s = status) >= 0 && |
356 |
< |
(s & INTERNAL_SIGNAL_MASK) != 0) { |
357 |
< |
if (UNSAFE.compareAndSwapInt(this, statusOffset, |
358 |
< |
s, s - 1)) { |
359 |
< |
pool.updateRunningCount(1); |
360 |
< |
break; |
361 |
< |
} |
362 |
< |
} |
363 |
< |
break; |
364 |
< |
} |
365 |
< |
} |
265 |
> |
final void tryExec() { |
266 |
> |
try { |
267 |
> |
if (status < 0 || !exec()) |
268 |
> |
return; |
269 |
> |
} catch (Throwable rex) { |
270 |
> |
setExceptionalCompletion(rex); |
271 |
> |
return; |
272 |
|
} |
273 |
+ |
setCompletion(NORMAL); // must be outside try block |
274 |
|
} |
275 |
|
|
276 |
|
/** |
277 |
< |
* Blocks a non-ForkJoin thread until this task is done or timeout elapses |
278 |
< |
*/ |
279 |
< |
private void externalTimedAwaitDone(long nanos) { |
280 |
< |
if (requestExternalSignal() >= 0) { |
281 |
< |
long startTime = System.nanoTime(); |
282 |
< |
boolean interrupted = false; |
283 |
< |
while (status >= 0) { |
284 |
< |
long nt = nanos - (System.nanoTime() - startTime); |
285 |
< |
if (nt <= 0) |
286 |
< |
break; |
287 |
< |
long ms = nt / 1000000; |
288 |
< |
int ns = (int) (nt % 1000000); |
277 |
> |
* If not done and this task is next in worker queue, runs it, |
278 |
> |
* else waits for it. |
279 |
> |
* @return status on exit |
280 |
> |
*/ |
281 |
> |
private int doJoin() { |
282 |
> |
int stat; |
283 |
> |
Thread t; |
284 |
> |
ForkJoinWorkerThread w; |
285 |
> |
if ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) { |
286 |
> |
if ((stat = status) < 0) |
287 |
> |
return stat; |
288 |
> |
if ((w = (ForkJoinWorkerThread) t).unpushTask(this)) { |
289 |
> |
boolean completed; |
290 |
|
try { |
291 |
< |
synchronized(this) { if (status >= 0) wait(ms, ns); } |
292 |
< |
} catch (InterruptedException ie) { |
293 |
< |
interrupted = true; |
291 |
> |
completed = exec(); |
292 |
> |
} catch (Throwable rex) { |
293 |
> |
return setExceptionalCompletion(rex); |
294 |
|
} |
295 |
+ |
if (completed) |
296 |
+ |
return setCompletion(NORMAL); |
297 |
|
} |
298 |
< |
if (interrupted) |
389 |
< |
Thread.currentThread().interrupt(); |
298 |
> |
return w.joinTask(this); |
299 |
|
} |
300 |
+ |
return externalAwaitDone(); |
301 |
|
} |
302 |
|
|
393 |
– |
// reporting results |
394 |
– |
|
303 |
|
/** |
304 |
< |
* Returns result or throws the exception associated with status. |
305 |
< |
* Uses Unsafe as a workaround for javac not allowing rethrow of |
306 |
< |
* unchecked exceptions. |
304 |
> |
* Unless done, calls exec and records status if completed, or |
305 |
> |
* waits for completion otherwise. |
306 |
> |
* @return status on exit |
307 |
|
*/ |
308 |
< |
private V reportResult() { |
309 |
< |
if ((status & COMPLETION_MASK) < NORMAL) { |
310 |
< |
Throwable ex = getException(); |
311 |
< |
if (ex != null) |
312 |
< |
UNSAFE.throwException(ex); |
313 |
< |
} |
314 |
< |
return getRawResult(); |
315 |
< |
} |
316 |
< |
|
317 |
< |
/** |
410 |
< |
* Returns result or throws exception using j.u.c.Future conventions. |
411 |
< |
* Only call when {@code isDone} known to be true or thread known |
412 |
< |
* to be interrupted. |
413 |
< |
*/ |
414 |
< |
private V reportFutureResult() |
415 |
< |
throws InterruptedException, ExecutionException { |
416 |
< |
if (Thread.interrupted()) |
417 |
< |
throw new InterruptedException(); |
418 |
< |
int s = status & COMPLETION_MASK; |
419 |
< |
if (s < NORMAL) { |
420 |
< |
Throwable ex; |
421 |
< |
if (s == CANCELLED) |
422 |
< |
throw new CancellationException(); |
423 |
< |
if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null) |
424 |
< |
throw new ExecutionException(ex); |
308 |
> |
private int doInvoke() { |
309 |
> |
int stat; |
310 |
> |
if ((stat = status) >= 0) { |
311 |
> |
boolean completed; |
312 |
> |
try { |
313 |
> |
completed = exec(); |
314 |
> |
} catch (Throwable rex) { |
315 |
> |
return setExceptionalCompletion(rex); |
316 |
> |
} |
317 |
> |
stat = completed ? setCompletion(NORMAL) : doJoin(); |
318 |
|
} |
319 |
< |
return getRawResult(); |
319 |
> |
return stat; |
320 |
|
} |
321 |
|
|
322 |
|
/** |
323 |
< |
* Returns result or throws exception using j.u.c.Future conventions |
324 |
< |
* with timeouts. |
323 |
> |
* Returns result or throws exception associated with given status. |
324 |
> |
* @param s the status |
325 |
|
*/ |
326 |
< |
private V reportTimedFutureResult() |
434 |
< |
throws InterruptedException, ExecutionException, TimeoutException { |
435 |
< |
if (Thread.interrupted()) |
436 |
< |
throw new InterruptedException(); |
326 |
> |
private V reportResult(int s) { |
327 |
|
Throwable ex; |
328 |
< |
int s = status & COMPLETION_MASK; |
329 |
< |
if (s == NORMAL) |
330 |
< |
return getRawResult(); |
441 |
< |
else if (s == CANCELLED) |
442 |
< |
throw new CancellationException(); |
443 |
< |
else if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null) |
444 |
< |
throw new ExecutionException(ex); |
445 |
< |
else |
446 |
< |
throw new TimeoutException(); |
328 |
> |
if (s < NORMAL && (ex = getException()) != null) |
329 |
> |
UNSAFE.throwException(ex); |
330 |
> |
return getRawResult(); |
331 |
|
} |
332 |
|
|
333 |
|
// public methods |
365 |
|
* @return the computed result |
366 |
|
*/ |
367 |
|
public final V join() { |
368 |
< |
quietlyJoin(); |
485 |
< |
return reportResult(); |
368 |
> |
return reportResult(doJoin()); |
369 |
|
} |
370 |
|
|
371 |
|
/** |
376 |
|
* @return the computed result |
377 |
|
*/ |
378 |
|
public final V invoke() { |
379 |
< |
if (!tryExec()) |
497 |
< |
quietlyJoin(); |
498 |
< |
return reportResult(); |
379 |
> |
return reportResult(doInvoke()); |
380 |
|
} |
381 |
|
|
382 |
|
/** |
434 |
|
} |
435 |
|
else if (i != 0) |
436 |
|
t.fork(); |
437 |
< |
else { |
438 |
< |
t.quietlyInvoke(); |
558 |
< |
if (ex == null) |
559 |
< |
ex = t.getException(); |
560 |
< |
} |
437 |
> |
else if (t.doInvoke() < NORMAL && ex == null) |
438 |
> |
ex = t.getException(); |
439 |
|
} |
440 |
|
for (int i = 1; i <= last; ++i) { |
441 |
|
ForkJoinTask<?> t = tasks[i]; |
442 |
|
if (t != null) { |
443 |
|
if (ex != null) |
444 |
|
t.cancel(false); |
445 |
< |
else { |
446 |
< |
t.quietlyJoin(); |
569 |
< |
if (ex == null) |
570 |
< |
ex = t.getException(); |
571 |
< |
} |
445 |
> |
else if (t.doJoin() < NORMAL && ex == null) |
446 |
> |
ex = t.getException(); |
447 |
|
} |
448 |
|
} |
449 |
|
if (ex != null) |
490 |
|
} |
491 |
|
else if (i != 0) |
492 |
|
t.fork(); |
493 |
< |
else { |
494 |
< |
t.quietlyInvoke(); |
620 |
< |
if (ex == null) |
621 |
< |
ex = t.getException(); |
622 |
< |
} |
493 |
> |
else if (t.doInvoke() < NORMAL && ex == null) |
494 |
> |
ex = t.getException(); |
495 |
|
} |
496 |
|
for (int i = 1; i <= last; ++i) { |
497 |
|
ForkJoinTask<?> t = ts.get(i); |
498 |
|
if (t != null) { |
499 |
|
if (ex != null) |
500 |
|
t.cancel(false); |
501 |
< |
else { |
502 |
< |
t.quietlyJoin(); |
631 |
< |
if (ex == null) |
632 |
< |
ex = t.getException(); |
633 |
< |
} |
501 |
> |
else if (t.doJoin() < NORMAL && ex == null) |
502 |
> |
ex = t.getException(); |
503 |
|
} |
504 |
|
} |
505 |
|
if (ex != null) |
532 |
|
* @return {@code true} if this task is now cancelled |
533 |
|
*/ |
534 |
|
public boolean cancel(boolean mayInterruptIfRunning) { |
535 |
< |
setCompletion(CANCELLED); |
667 |
< |
return (status & COMPLETION_MASK) == CANCELLED; |
535 |
> |
return setCompletion(CANCELLED) == CANCELLED; |
536 |
|
} |
537 |
|
|
538 |
|
/** |
539 |
< |
* Cancels, ignoring any exceptions it throws. Used during worker |
540 |
< |
* and pool shutdown. |
539 |
> |
* Cancels, ignoring any exceptions thrown by cancel. Used during |
540 |
> |
* worker and pool shutdown. Cancel is spec'ed not to throw any |
541 |
> |
* exceptions, but if it does anyway, we have no recourse during |
542 |
> |
* shutdown, so guard against this case. |
543 |
|
*/ |
544 |
|
final void cancelIgnoringExceptions() { |
545 |
|
try { |
551 |
|
/** |
552 |
|
* Cancels ignoring exceptions if worker is terminating |
553 |
|
*/ |
554 |
< |
private void cancelIfTerminating() { |
554 |
> |
final void cancelIfTerminating() { |
555 |
|
Thread t = Thread.currentThread(); |
556 |
|
if ((t instanceof ForkJoinWorkerThread) && |
557 |
< |
((ForkJoinWorkerThread) t).isTerminating()) { |
557 |
> |
((ForkJoinWorkerThread) t).isTerminating()) { |
558 |
|
try { |
559 |
|
cancel(false); |
560 |
|
} catch (Throwable ignore) { |
567 |
|
} |
568 |
|
|
569 |
|
public final boolean isCancelled() { |
570 |
< |
return (status & COMPLETION_MASK) == CANCELLED; |
570 |
> |
return status == CANCELLED; |
571 |
|
} |
572 |
|
|
573 |
|
/** |
576 |
|
* @return {@code true} if this task threw an exception or was cancelled |
577 |
|
*/ |
578 |
|
public final boolean isCompletedAbnormally() { |
579 |
< |
return (status & COMPLETION_MASK) < NORMAL; |
579 |
> |
return status < NORMAL; |
580 |
|
} |
581 |
|
|
582 |
|
/** |
587 |
|
* exception and was not cancelled |
588 |
|
*/ |
589 |
|
public final boolean isCompletedNormally() { |
590 |
< |
return (status & COMPLETION_MASK) == NORMAL; |
590 |
> |
return status == NORMAL; |
591 |
|
} |
592 |
|
|
593 |
|
/** |
598 |
|
* @return the exception, or {@code null} if none |
599 |
|
*/ |
600 |
|
public final Throwable getException() { |
601 |
< |
int s = status & COMPLETION_MASK; |
601 |
> |
int s = status; |
602 |
|
return ((s >= NORMAL) ? null : |
603 |
|
(s == CANCELLED) ? new CancellationException() : |
604 |
|
exceptionMap.get(this)); |
619 |
|
* thrown will be a {@code RuntimeException} with cause {@code ex}. |
620 |
|
*/ |
621 |
|
public void completeExceptionally(Throwable ex) { |
622 |
< |
setDoneExceptionally((ex instanceof RuntimeException) || |
623 |
< |
(ex instanceof Error) ? ex : |
624 |
< |
new RuntimeException(ex)); |
622 |
> |
setExceptionalCompletion((ex instanceof RuntimeException) || |
623 |
> |
(ex instanceof Error) ? ex : |
624 |
> |
new RuntimeException(ex)); |
625 |
|
} |
626 |
|
|
627 |
|
/** |
640 |
|
try { |
641 |
|
setRawResult(value); |
642 |
|
} catch (Throwable rex) { |
643 |
< |
setDoneExceptionally(rex); |
643 |
> |
setExceptionalCompletion(rex); |
644 |
|
return; |
645 |
|
} |
646 |
|
setCompletion(NORMAL); |
647 |
|
} |
648 |
|
|
649 |
|
public final V get() throws InterruptedException, ExecutionException { |
650 |
< |
quietlyJoin(); |
651 |
< |
return reportFutureResult(); |
650 |
> |
int s = doJoin(); |
651 |
> |
if (Thread.interrupted()) |
652 |
> |
throw new InterruptedException(); |
653 |
> |
if (s < NORMAL) { |
654 |
> |
Throwable ex; |
655 |
> |
if (s == CANCELLED) |
656 |
> |
throw new CancellationException(); |
657 |
> |
if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null) |
658 |
> |
throw new ExecutionException(ex); |
659 |
> |
} |
660 |
> |
return getRawResult(); |
661 |
|
} |
662 |
< |
|
662 |
> |
|
663 |
|
public final V get(long timeout, TimeUnit unit) |
664 |
|
throws InterruptedException, ExecutionException, TimeoutException { |
786 |
– |
long nanos = unit.toNanos(timeout); |
665 |
|
Thread t = Thread.currentThread(); |
666 |
+ |
ForkJoinPool pool; |
667 |
|
if (t instanceof ForkJoinWorkerThread) { |
668 |
|
ForkJoinWorkerThread w = (ForkJoinWorkerThread) t; |
669 |
< |
if (!w.unpushTask(this) || !tryExec()) |
670 |
< |
timedAwaitDone(w, nanos); |
669 |
> |
if (status >= 0 && w.unpushTask(this)) |
670 |
> |
tryExec(); |
671 |
> |
pool = w.pool; |
672 |
|
} |
673 |
|
else |
674 |
< |
externalTimedAwaitDone(nanos); |
675 |
< |
return reportTimedFutureResult(); |
676 |
< |
} |
677 |
< |
|
678 |
< |
/** |
679 |
< |
* Possibly executes other tasks until this task {@link #isDone is |
680 |
< |
* done}, then returns the result of the computation. This method |
681 |
< |
* may be more efficient than {@code join}, but is only applicable |
682 |
< |
* when there are no potential dependencies between continuation |
683 |
< |
* of the current task and that of any other task that might be |
684 |
< |
* executed while helping. (This usually holds for pure |
685 |
< |
* divide-and-conquer tasks). |
686 |
< |
* |
687 |
< |
* <p>This method may be invoked only from within {@code |
688 |
< |
* ForkJoinTask} computations (as may be determined using method |
689 |
< |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
690 |
< |
* result in exceptions or errors, possibly including {@code |
691 |
< |
* ClassCastException}. |
692 |
< |
* |
693 |
< |
* @return the computed result |
694 |
< |
*/ |
695 |
< |
public final V helpJoin() { |
696 |
< |
quietlyHelpJoin(); |
697 |
< |
return reportResult(); |
698 |
< |
} |
699 |
< |
|
700 |
< |
/** |
701 |
< |
* Possibly executes other tasks until this task {@link #isDone is |
702 |
< |
* done}. This method may be useful when processing collections |
703 |
< |
* of tasks when some have been cancelled or otherwise known to |
704 |
< |
* have aborted. |
705 |
< |
* |
706 |
< |
* <p>This method may be invoked only from within {@code |
707 |
< |
* ForkJoinTask} computations (as may be determined using method |
708 |
< |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
709 |
< |
* result in exceptions or errors, possibly including {@code |
710 |
< |
* ClassCastException}. |
711 |
< |
*/ |
712 |
< |
public final void quietlyHelpJoin() { |
713 |
< |
ForkJoinWorkerThread w = (ForkJoinWorkerThread) Thread.currentThread(); |
714 |
< |
if (!w.unpushTask(this) || !tryExec()) { |
715 |
< |
while (status >= 0) { |
716 |
< |
ForkJoinTask<?> t = w.scanWhileJoining(this); |
837 |
< |
if (t == null) { |
838 |
< |
if (status >= 0) |
839 |
< |
awaitDone(w); |
840 |
< |
break; |
674 |
> |
pool = null; |
675 |
> |
/* |
676 |
> |
* Timed wait loop intermixes cases for FJ (pool != null) and |
677 |
> |
* non FJ threads. For FJ, decrement pool count but don't try |
678 |
> |
* for replacement; increment count on completion. For non-FJ, |
679 |
> |
* deal with interrupts. This is messy, but a little less so |
680 |
> |
* than is splitting the FJ and nonFJ cases. |
681 |
> |
*/ |
682 |
> |
boolean interrupted = false; |
683 |
> |
boolean dec = false; // true if pool count decremented |
684 |
> |
for (;;) { |
685 |
> |
if (Thread.interrupted() && pool == null) { |
686 |
> |
interrupted = true; |
687 |
> |
break; |
688 |
> |
} |
689 |
> |
int s = status; |
690 |
> |
if (s < 0) |
691 |
> |
break; |
692 |
> |
if (UNSAFE.compareAndSwapInt(this, statusOffset, s, SIGNAL)) { |
693 |
> |
long startTime = System.nanoTime(); |
694 |
> |
long nanos = unit.toNanos(timeout); |
695 |
> |
long nt; // wait time |
696 |
> |
while (status >= 0 && |
697 |
> |
(nt = nanos - (System.nanoTime() - startTime)) > 0) { |
698 |
> |
if (pool != null && !dec) |
699 |
> |
dec = pool.tryDecrementRunningCount(); |
700 |
> |
else { |
701 |
> |
long ms = nt / 1000000; |
702 |
> |
int ns = (int) (nt % 1000000); |
703 |
> |
try { |
704 |
> |
synchronized(this) { |
705 |
> |
if (status >= 0) |
706 |
> |
wait(ms, ns); |
707 |
> |
} |
708 |
> |
} catch (InterruptedException ie) { |
709 |
> |
if (pool != null) |
710 |
> |
cancelIfTerminating(); |
711 |
> |
else { |
712 |
> |
interrupted = true; |
713 |
> |
break; |
714 |
> |
} |
715 |
> |
} |
716 |
> |
} |
717 |
|
} |
718 |
< |
t.tryExec(); |
718 |
> |
break; |
719 |
|
} |
720 |
|
} |
721 |
+ |
if (pool != null && dec) |
722 |
+ |
pool.incrementRunningCount(); |
723 |
+ |
if (interrupted) |
724 |
+ |
throw new InterruptedException(); |
725 |
+ |
int es = status; |
726 |
+ |
if (es != NORMAL) { |
727 |
+ |
Throwable ex; |
728 |
+ |
if (es == CANCELLED) |
729 |
+ |
throw new CancellationException(); |
730 |
+ |
if (es == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null) |
731 |
+ |
throw new ExecutionException(ex); |
732 |
+ |
throw new TimeoutException(); |
733 |
+ |
} |
734 |
+ |
return getRawResult(); |
735 |
|
} |
736 |
|
|
737 |
|
/** |
741 |
|
* known to have aborted. |
742 |
|
*/ |
743 |
|
public final void quietlyJoin() { |
744 |
< |
Thread t = Thread.currentThread(); |
855 |
< |
if (t instanceof ForkJoinWorkerThread) { |
856 |
< |
ForkJoinWorkerThread w = (ForkJoinWorkerThread) t; |
857 |
< |
if (!w.unpushTask(this) || !tryExec()) |
858 |
< |
awaitDone(w); |
859 |
< |
} |
860 |
< |
else |
861 |
< |
externalAwaitDone(); |
744 |
> |
doJoin(); |
745 |
|
} |
746 |
|
|
747 |
|
/** |
752 |
|
* known to have aborted. |
753 |
|
*/ |
754 |
|
public final void quietlyInvoke() { |
755 |
< |
if (!tryExec()) |
873 |
< |
quietlyJoin(); |
755 |
> |
doInvoke(); |
756 |
|
} |
757 |
|
|
758 |
|
/** |
784 |
|
* pre-constructed trees of subtasks in loops. |
785 |
|
*/ |
786 |
|
public void reinitialize() { |
787 |
< |
if ((status & COMPLETION_MASK) == EXCEPTIONAL) |
787 |
> |
if (status == EXCEPTIONAL) |
788 |
|
exceptionMap.remove(this); |
789 |
|
status = 0; |
790 |
|
} |
1094 |
|
private void readObject(java.io.ObjectInputStream s) |
1095 |
|
throws java.io.IOException, ClassNotFoundException { |
1096 |
|
s.defaultReadObject(); |
1215 |
– |
status &= ~INTERNAL_SIGNAL_MASK; // clear internal signal counts |
1216 |
– |
status |= EXTERNAL_SIGNAL; // conservatively set external signal |
1097 |
|
Object ex = s.readObject(); |
1098 |
|
if (ex != null) |
1099 |
< |
setDoneExceptionally((Throwable) ex); |
1099 |
> |
setExceptionalCompletion((Throwable) ex); |
1100 |
|
} |
1101 |
|
|
1102 |
|
// Unsafe mechanics |