ViewVC Help

View File | Revision Log | Show Annotations | Download File | Root Listing

root/jsr166/jsr166/src/jsr166y/ForkJoinTask.java

Comparing jsr166/src/jsr166y/ForkJoinTask.java (file contents):
Revision 1.41 by dl, Wed Aug 5 23:37:32 2009 UTC vs.
Revision 1.55 by dl, Sun Aug 29 23:34:46 2010 UTC

#	Line 56 | Line 56 | import java.util.WeakHashMap;
56		* exceptions such as {@code IOExceptions} to be thrown. However,
57		* computations may still encounter unchecked exceptions, that are
58		* rethrown to callers attempting to join them. These exceptions may
59	<	* additionally include RejectedExecutionExceptions stemming from
60	<	* internal resource exhaustion such as failure to allocate internal
61	<	* task queues.
59	>	* additionally include {@link RejectedExecutionException} stemming
60	>	* from internal resource exhaustion, such as failure to allocate
61	>	* internal task queues.
62		*
63		* <p>The primary method for awaiting completion and extracting
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
#	Line 80 | Line 77 | import java.util.WeakHashMap;
77		* <p>The execution status of tasks may be queried at several levels
78		* of detail: {@link #isDone} is true if a task completed in any way
79		* (including the case where a task was cancelled without executing);
83	–	* {@link #isCancelled} is true if completion was due to cancellation;
80		* {@link #isCompletedNormally} is true if a task completed without
81	<	* cancellation or encountering an exception; {@link
82	<	* #isCompletedExceptionally} is true if if the task encountered an
83	<	* exception (in which case {@link #getException} returns the
84	<	* exception); {@link #isCancelled} is true if the task was cancelled
85	<	* (in which case {@link #getException} returns a {@link
86	<	* java.util.concurrent.CancellationException}); and {@link
87	<	* #isCompletedAbnormally} is true if a task was either cancelled or
92	<	* encountered an exception.
81	>	* cancellation or encountering an exception; {@link #isCancelled} is
82	>	* true if the task was cancelled (in which case {@link #getException}
83	>	* returns a {@link java.util.concurrent.CancellationException}); and
84	>	* {@link #isCompletedAbnormally} is true if a task was either
85	>	* cancelled or encountered an exception, in which case {@link
86	>	* #getException} will return either the encountered exception or
87	>	* {@link java.util.concurrent.CancellationException}.
88		*
89		* <p>The ForkJoinTask class is not usually directly subclassed.
90		* Instead, you subclass one of the abstract classes that support a
#	Line 127 | Line 122 | import java.util.WeakHashMap;
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
132	<	* {@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
#	Line 141 | Line 135 | import java.util.WeakHashMap;
135		*/
136		public abstract class ForkJoinTask<V> implements Future<V>, Serializable {
137
138	<	/**
139	<	* Run control status bits packed into a single int to minimize
140	<	* footprint and to ensure atomicity (via CAS).  Status is
141	<	* initially zero, and takes on nonnegative values until
142	<	* completed, upon which status holds COMPLETED. CANCELLED, or
143	<	* EXCEPTIONAL, which use the top 3 bits.  Tasks undergoing
144	<	* blocking waits by other threads have SIGNAL_MASK bits set --
145	<	* bit 15 for external (nonFJ) waits, and the rest a count of
146	<	* waiting FJ threads.  (This representation relies on
147	<	* ForkJoinPool max thread limits). Completion of a stolen task
148	<	* with SIGNAL_MASK bits set awakens waiter via notifyAll. Even
149	<	* though suboptimal for some purposes, we use basic builtin
150	<	* wait/notify to take advantage of "monitor inflation" in JVMs
151	<	* that we would otherwise need to emulate to avoid adding further
152	<	* per-task bookkeeping overhead. Note that bits 16-28 are
153	<	* currently unused. Also value 0x80000000 is available as spare
154	<	* completion value.
138	>	/*
139	>	* See the internal documentation of class ForkJoinPool for a
140	>	* general implementation overview.  ForkJoinTasks are mainly
141	>	* responsible for maintaining their "status" field amidst relays
142	>	* to methods in ForkJoinWorkerThread and ForkJoinPool. The
143	>	* methods of this class are more-or-less layered into (1) basic
144	>	* status maintenance (2) execution and awaiting completion (3)
145	>	* user-level methods that additionally report results. This is
146	>	* sometimes hard to see because this file orders exported methods
147	>	* in a way that flows well in javadocs. In particular, most
148	>	* join mechanics are in method quietlyJoin, below.
149	>	*/
150	>
151	>	/*
152	>	* The status field holds run control status bits packed into a
153	>	* single int to minimize footprint and to ensure atomicity (via
154	>	* CAS).  Status is initially zero, and takes on nonnegative
155	>	* values until completed, upon which status holds value
156	>	* COMPLETED. CANCELLED, or EXCEPTIONAL. Tasks undergoing blocking
157	>	* waits by other threads have the SIGNAL bit set.  Completion of
158	>	* a stolen task with SIGNAL set awakens any waiters via
159	>	* notifyAll. Even though suboptimal for some purposes, we use
160	>	* basic builtin wait/notify to take advantage of "monitor
161	>	* inflation" in JVMs that we would otherwise need to emulate to
162	>	* avoid adding further per-task bookkeeping overhead.  We want
163	>	* these monitors to be "fat", i.e., not use biasing or thin-lock
164	>	* techniques, so use some odd coding idioms that tend to avoid
165	>	* them.
166		*/
167	+
168	+	/** The run status of this task */
169		volatile int status; // accessed directly by pool and workers
170
171	<	static final int COMPLETION_MASK      = 0xe0000000;
172	<	static final int NORMAL               = 0xe0000000; // == mask
173	<	static final int CANCELLED            = 0xc0000000;
174	<	static final int EXCEPTIONAL          = 0xa0000000;
168	<	static final int SIGNAL_MASK          = 0x0000ffff;
169	<	static final int INTERNAL_SIGNAL_MASK = 0x00007fff;
170	<	static final int EXTERNAL_SIGNAL      = 0x00008000; // top bit of low word
171	>	private static final int NORMAL      = -1;
172	>	private static final int CANCELLED   = -2;
173	>	private static final int EXCEPTIONAL = -3;
174	>	private static final int SIGNAL      =  1;
175
176		/**
177		* Table of exceptions thrown by tasks, to enable reporting by
#	Line 181 | Line 185 | public abstract class ForkJoinTask<V> im
185		Collections.synchronizedMap
186		(new WeakHashMap<ForkJoinTask<?>, Throwable>());
187
188	<	// within-package utilities
188	>	// Maintaining completion status
189
190		/**
191	<	* Gets current worker thread, or null if not a worker thread.
192	<	*/
189	<	static ForkJoinWorkerThread getWorker() {
190	<	Thread t = Thread.currentThread();
191	<	return ((t instanceof ForkJoinWorkerThread) ?
192	<	(ForkJoinWorkerThread) t : null);
193	<	}
194	<
195	<	final boolean casStatus(int cmp, int val) {
196	<	return UNSAFE.compareAndSwapInt(this, statusOffset, cmp, val);
197	<	}
198	<
199	<	/**
200	<	* Workaround for not being able to rethrow unchecked exceptions.
201	<	*/
202	<	static void rethrowException(Throwable ex) {
203	<	if (ex != null)
204	<	UNSAFE.throwException(ex);
205	<	}
206	<
207	<	// Setting completion status
208	<
209	<	/**
210	<	* Marks completion and wakes up threads waiting to join this task.
191	>	* Marks completion and wakes up threads waiting to join this task,
192	>	* also clearing signal request bits.
193		*
194		* @param completion one of NORMAL, CANCELLED, EXCEPTIONAL
195		*/
196	<	final void setCompletion(int completion) {
197	<	ForkJoinPool pool = getPool();
198	<	if (pool != null) {
199	<	int s; // Clear signal bits while setting completion status
200	<	do {} while ((s = status) >= 0 && !casStatus(s, completion));
201	<
202	<	if ((s & SIGNAL_MASK) != 0) {
221	<	if ((s &= INTERNAL_SIGNAL_MASK) != 0)
222	<	pool.updateRunningCount(s);
223	<	synchronized (this) { notifyAll(); }
196	>	private void setCompletion(int completion) {
197	>	int s;
198	>	while ((s = status) >= 0) {
199	>	if (UNSAFE.compareAndSwapInt(this, statusOffset, s, completion)) {
200	>	if (s != 0)
201	>	synchronized (this) { notifyAll(); }
202	>	break;
203		}
204		}
226	–	else
227	–	externallySetCompletion(completion);
228	–	}
229	–
230	–	/**
231	–	* Version of setCompletion for non-FJ threads.  Leaves signal
232	–	* bits for unblocked threads to adjust, and always notifies.
233	–	*/
234	–	private void externallySetCompletion(int completion) {
235	–	int s;
236	–	do {} while ((s = status) >= 0 &&
237	–	!casStatus(s, (s & SIGNAL_MASK) | completion));
238	–	synchronized (this) { notifyAll(); }
205		}
206
207		/**
208	<	* Sets status to indicate normal completion.
208	>	* Record exception and set exceptional completion
209	>	* @return status on exit
210		*/
211	<	final void setNormalCompletion() {
212	<	// Try typical fast case -- single CAS, no signal, not already done.
213	<	// Manually expand casStatus to improve chances of inlining it
247	<	if (!UNSAFE.compareAndSwapInt(this, statusOffset, 0, NORMAL))
248	<	setCompletion(NORMAL);
249	<	}
250	<
251	<	// internal waiting and notification
252	<
253	<	/**
254	<	* Performs the actual monitor wait for awaitDone.
255	<	*/
256	<	private void doAwaitDone() {
257	<	// Minimize lock bias and in/de-flation effects by maximizing
258	<	// chances of waiting inside sync
259	<	try {
260	<	while (status >= 0)
261	<	synchronized (this) { if (status >= 0) wait(); }
262	<	} catch (InterruptedException ie) {
263	<	onInterruptedWait();
264	<	}
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)
276	<	break;
277	<	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();
281	<	}
282	<	}
283	<	}
284	<
285	<	// Awaiting completion
286	<
287	<	/**
288	<	* Sets status to indicate there is joiner, then waits for join,
289	<	* surrounded with pool notifications.
290	<	*
291	<	* @return status upon exit
292	<	*/
293	<	private int awaitDone(ForkJoinWorkerThread w,
294	<	boolean maintainParallelism) {
295	<	ForkJoinPool pool = (w == null) ? null : w.pool;
296	<	int s;
297	<	while ((s = status) >= 0) {
298	<	if (casStatus(s, (pool == null) ? s|EXTERNAL_SIGNAL : s+1)) {
299	<	if (pool == null || !pool.preJoin(this, maintainParallelism))
300	<	doAwaitDone();
301	<	if (((s = status) & INTERNAL_SIGNAL_MASK) != 0)
302	<	adjustPoolCountsOnUnblock(pool);
303	<	break;
230	>	cancelIfTerminating();
231		}
232		}
306	–	return s;
233		}
234
235		/**
236	<	* Timed version of awaitDone
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, long nanos) {
315	<	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	<	long startTime = System.nanoTime();
246	<	if (pool == null || !pool.preJoin(this, false))
247	<	doAwaitDone(startTime, nanos);
322	<	if ((s = status) >= 0) {
323	<	adjustPoolCountsOnCancelledWait(pool);
324	<	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);
328	<	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
336	<	* 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)) {
353	<	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		}
#	Line 358 | Line 279 | public abstract class ForkJoinTask<V> im
279		}
280
281		/**
282	<	* Handles interruptions during waits.
283	<	*/
284	<	private void onInterruptedWait() {
364	<	ForkJoinWorkerThread w = getWorker();
365	<	if (w == null)
366	<	Thread.currentThread().interrupt(); // re-interrupt
367	<	else if (w.isTerminating())
368	<	cancelIgnoringExceptions();
369	<	// else if FJworker, ignore interrupt
370	<	}
371	<
372	<	// Recording and reporting exceptions
373	<
374	<	private void setDoneExceptionally(Throwable rex) {
375	<	exceptionMap.put(this, rex);
376	<	setCompletion(EXCEPTIONAL);
377	<	}
378	<
379	<	/**
380	<	* Throws the exception associated with status s.
381	<	*
382	<	* @throws the exception
383	<	*/
384	<	private void reportException(int s) {
385	<	if ((s &= COMPLETION_MASK) < NORMAL) {
386	<	if (s == CANCELLED)
387	<	throw new CancellationException();
388	<	else
389	<	rethrowException(exceptionMap.get(this));
390	<	}
391	<	}
392	<
393	<	/**
394	<	* Returns result or throws exception using j.u.c.Future conventions.
395	<	* Only call when {@code isDone} known to be true or thread known
396	<	* to be interrupted.
397	<	*/
398	<	private V reportFutureResult()
399	<	throws InterruptedException, ExecutionException {
400	<	if (Thread.interrupted())
401	<	throw new InterruptedException();
402	<	int s = status & COMPLETION_MASK;
403	<	if (s < NORMAL) {
404	<	Throwable ex;
405	<	if (s == CANCELLED)
406	<	throw new CancellationException();
407	<	if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
408	<	throw new ExecutionException(ex);
409	<	}
410	<	return getRawResult();
411	<	}
412	<
413	<	/**
414	<	* Returns result or throws exception using j.u.c.Future conventions
415	<	* with timeouts.
416	<	*/
417	<	private V reportTimedFutureResult()
418	<	throws InterruptedException, ExecutionException, TimeoutException {
419	<	if (Thread.interrupted())
420	<	throw new InterruptedException();
421	<	Throwable ex;
422	<	int s = status & COMPLETION_MASK;
423	<	if (s == NORMAL)
424	<	return getRawResult();
425	<	else if (s == CANCELLED)
426	<	throw new CancellationException();
427	<	else if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
428	<	throw new ExecutionException(ex);
429	<	else
430	<	throw new TimeoutException();
431	<	}
432	<
433	<	// internal execution methods
434	<
435	<	/**
436	<	* Calls exec, recording completion, and rethrowing exception if
437	<	* encountered. Caller should normally check status before calling.
438	<	*
439	<	* @return true if completed normally
440	<	*/
441	<	private boolean tryExec() {
442	<	try { // try block must contain only call to exec
443	<	if (!exec())
444	<	return false;
445	<	} catch (Throwable rex) {
446	<	setDoneExceptionally(rex);
447	<	rethrowException(rex);
448	<	return false; // not reached
449	<	}
450	<	setNormalCompletion();
451	<	return true;
452	<	}
453	<
454	<	/**
455	<	* Main execution method used by worker threads. Invokes
456	<	* 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() {
459	–	if (status >= 0) {
460	–	try {
461	–	if (!exec())
462	–	return;
463	–	} catch (Throwable rex) {
464	–	setDoneExceptionally(rex);
465	–	return;
466	–	}
467	–	setNormalCompletion();
468	–	}
469	–	}
470	–
471	–	/**
472	–	* Calls exec(), recording but not rethrowing exception.
473	–	* Caller should normally check status before calling.
474	–	*
475	–	* @return true if completed normally
476	–	*/
477	–	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;
484	<	}
485	<	setNormalCompletion();
486	<	return true;
487	<	}
488	<
489	<	/**
490	<	* Cancels, ignoring any exceptions it throws.
491	<	*/
492	<	final void cancelIgnoringExceptions() {
493	<	try {
494	<	cancel(false);
495	<	} catch (Throwable ignore) {
291	>	setExceptionalCompletion(rex);
292	>	return;
293		}
294	<	}
498	<
499	<	/**
500	<	* Main implementation of helpJoin
501	<	*/
502	<	private int busyJoin(ForkJoinWorkerThread w) {
503	<	int s;
504	<	ForkJoinTask<?> t;
505	<	while ((s = status) >= 0 && (t = w.scanWhileJoining(this)) != null)
506	<	t.quietlyExec();
507	<	return (s >= 0) ? awaitDone(w, false) : s; // block if no work
294	>	setCompletion(NORMAL); // must be outside try block
295		}
296
297		// public methods
#	Line 513 | Line 300 | public abstract class ForkJoinTask<V> im
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.
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
#	Line 537 | Line 329 | public abstract class ForkJoinTask<V> im
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
#	Line 551 | Line 344 | public abstract class ForkJoinTask<V> im
344		* @return the computed result
345		*/
346		public final V invoke() {
347	<	if (status >= 0 && tryExec())
348	<	return getRawResult();
349	<	else
350	<	return join();
347	>	quietlyInvoke();
348	>	Throwable ex;
349	>	if (status < NORMAL && (ex = getException()) != null)
350	>	UNSAFE.throwException(ex);
351	>	return getRawResult();
352		}
353
354		/**
#	Line 614 | Line 408 | public abstract class ForkJoinTask<V> im
408		t.fork();
409		else {
410		t.quietlyInvoke();
411	<	if (ex == null)
411	>	if (ex == null && t.status < NORMAL)
412		ex = t.getException();
413		}
414		}
#	Line 625 | Line 419 | public abstract class ForkJoinTask<V> im
419		t.cancel(false);
420		else {
421		t.quietlyJoin();
422	<	if (ex == null)
422	>	if (ex == null && t.status < NORMAL)
423		ex = t.getException();
424		}
425		}
426		}
427		if (ex != null)
428	<	rethrowException(ex);
428	>	UNSAFE.throwException(ex);
429		}
430
431		/**
#	Line 676 | Line 470 | public abstract class ForkJoinTask<V> im
470		t.fork();
471		else {
472		t.quietlyInvoke();
473	<	if (ex == null)
473	>	if (ex == null && t.status < NORMAL)
474		ex = t.getException();
475		}
476		}
#	Line 687 | Line 481 | public abstract class ForkJoinTask<V> im
481		t.cancel(false);
482		else {
483		t.quietlyJoin();
484	<	if (ex == null)
484	>	if (ex == null && t.status < NORMAL)
485		ex = t.getException();
486		}
487		}
488		}
489		if (ex != null)
490	<	rethrowException(ex);
490	>	UNSAFE.throwException(ex);
491		return tasks;
492		}
493
#	Line 723 | Line 517 | public abstract class ForkJoinTask<V> im
517		*/
518		public boolean cancel(boolean mayInterruptIfRunning) {
519		setCompletion(CANCELLED);
520	<	return (status & COMPLETION_MASK) == CANCELLED;
520	>	return status == CANCELLED;
521	>	}
522	>
523	>	/**
524	>	* Cancels, ignoring any exceptions thrown by cancel. Used during
525	>	* worker and pool shutdown. Cancel is spec'ed not to throw any
526	>	* exceptions, but if it does anyway, we have no recourse during
527	>	* shutdown, so guard against this case.
528	>	*/
529	>	final void cancelIgnoringExceptions() {
530	>	try {
531	>	cancel(false);
532	>	} catch (Throwable ignore) {
533	>	}
534	>	}
535	>
536	>	/**
537	>	* Cancels ignoring exceptions if worker is terminating
538	>	*/
539	>	final void cancelIfTerminating() {
540	>	Thread t = Thread.currentThread();
541	>	if ((t instanceof ForkJoinWorkerThread) &&
542	>	((ForkJoinWorkerThread) t).isTerminating()) {
543	>	try {
544	>	cancel(false);
545	>	} catch (Throwable ignore) {
546	>	}
547	>	}
548		}
549
550		public final boolean isDone() {
#	Line 731 | Line 552 | public abstract class ForkJoinTask<V> im
552		}
553
554		public final boolean isCancelled() {
555	<	return (status & COMPLETION_MASK) == CANCELLED;
555	>	return status == CANCELLED;
556		}
557
558		/**
#	Line 740 | Line 561 | public abstract class ForkJoinTask<V> im
561		* @return {@code true} if this task threw an exception or was cancelled
562		*/
563		public final boolean isCompletedAbnormally() {
564	<	return (status & COMPLETION_MASK) < NORMAL;
564	>	return status < NORMAL;
565		}
566
567		/**
#	Line 751 | Line 572 | public abstract class ForkJoinTask<V> im
572		* exception and was not cancelled
573		*/
574		public final boolean isCompletedNormally() {
575	<	return (status & COMPLETION_MASK) == NORMAL;
755	<	}
756	<
757	<	/**
758	<	* Returns {@code true} if this task threw an exception.
759	<	*
760	<	* @return {@code true} if this task threw an exception
761	<	*/
762	<	public final boolean isCompletedExceptionally() {
763	<	return (status & COMPLETION_MASK) == EXCEPTIONAL;
575	>	return status == NORMAL;
576		}
577
578		/**
#	Line 771 | Line 583 | public abstract class ForkJoinTask<V> im
583		* @return the exception, or {@code null} if none
584		*/
585		public final Throwable getException() {
586	<	int s = status & COMPLETION_MASK;
586	>	int s = status;
587		return ((s >= NORMAL)    ? null :
588		(s == CANCELLED) ? new CancellationException() :
589		exceptionMap.get(this));
#	Line 787 | Line 599 | public abstract class ForkJoinTask<V> im
599		* overridable, but overridden versions must invoke {@code super}
600		* implementation to maintain guarantees.
601		*
602	<	* @param ex the exception to throw. If this exception is
603	<	* not a RuntimeException or Error, the actual exception thrown
604	<	* will be a RuntimeException with cause ex.
602	>	* @param ex the exception to throw. If this exception is not a
603	>	* {@code RuntimeException} or {@code Error}, the actual exception
604	>	* thrown will be a {@code RuntimeException} with cause {@code ex}.
605		*/
606		public void completeExceptionally(Throwable ex) {
607	<	setDoneExceptionally((ex instanceof RuntimeException) ||
608	<	(ex instanceof Error) ? ex :
609	<	new RuntimeException(ex));
607	>	setExceptionalCompletion((ex instanceof RuntimeException) ||
608	>	(ex instanceof Error) ? ex :
609	>	new RuntimeException(ex));
610		}
611
612		/**
#	Line 813 | Line 625 | public abstract class ForkJoinTask<V> im
625		try {
626		setRawResult(value);
627		} catch (Throwable rex) {
628	<	setDoneExceptionally(rex);
628	>	setExceptionalCompletion(rex);
629		return;
630		}
631	<	setNormalCompletion();
631	>	setCompletion(NORMAL);
632		}
633
634		public final V get() throws InterruptedException, ExecutionException {
635	<	ForkJoinWorkerThread w = getWorker();
636	<	if (w == null || status < 0 || !w.unpushTask(this) || !tryQuietlyInvoke())
637	<	awaitDone(w, true);
638	<	return reportFutureResult();
635	>	quietlyJoin();
636	>	if (Thread.interrupted())
637	>	throw new InterruptedException();
638	>	int s = status;
639	>	if (s < NORMAL) {
640	>	Throwable ex;
641	>	if (s == CANCELLED)
642	>	throw new CancellationException();
643	>	if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
644	>	throw new ExecutionException(ex);
645	>	}
646	>	return getRawResult();
647		}
648
649		public final V get(long timeout, TimeUnit unit)
650		throws InterruptedException, ExecutionException, TimeoutException {
651	+	Thread t = Thread.currentThread();
652	+	ForkJoinPool pool;
653	+	if (t instanceof ForkJoinWorkerThread) {
654	+	ForkJoinWorkerThread w = (ForkJoinWorkerThread) t;
655	+	if (status >= 0 && w.unpushTask(this))
656	+	quietlyExec();
657	+	pool = w.pool;
658	+	}
659	+	else
660	+	pool = null;
661	+	/*
662	+	* Timed wait loop intermixes cases for FJ (pool != null) and
663	+	* non FJ threads. For FJ, decrement pool count but don't try
664	+	* for replacement; increment count on completion. For non-FJ,
665	+	* deal with interrupts. This is messy, but a little less so
666	+	* than is splitting the FJ and nonFJ cases.
667	+	*/
668	+	boolean interrupted = false;
669	+	boolean dec = false; // true if pool count decremented
670		long nanos = unit.toNanos(timeout);
671	<	ForkJoinWorkerThread w = getWorker();
672	<	if (w == null || status < 0 || !w.unpushTask(this) || !tryQuietlyInvoke())
673	<	awaitDone(w, nanos);
674	<	return reportTimedFutureResult();
675	<	}
676	<
677	<	/**
678	<	* Possibly executes other tasks until this task {@link #isDone is
679	<	* done}, then returns the result of the computation.  This method
680	<	* may be more efficient than {@code join}, but is only applicable
681	<	* when there are no potential dependencies between continuation
682	<	* of the current task and that of any other task that might be
683	<	* executed while helping. (This usually holds for pure
684	<	* divide-and-conquer tasks).
685	<	*
686	<	* <p>This method may be invoked only from within {@code
687	<	* ForkJoinTask} computations (as may be determined using method
688	<	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
689	<	* result in exceptions or errors, possibly including {@code
690	<	* ClassCastException}.
691	<	*
692	<	* @return the computed result
693	<	*/
694	<	public final V helpJoin() {
695	<	ForkJoinWorkerThread w = (ForkJoinWorkerThread) Thread.currentThread();
696	<	if (status < 0 || !w.unpushTask(this) || !tryExec())
697	<	reportException(busyJoin(w));
698	<	return getRawResult();
699	<	}
700	<
701	<	/**
702	<	* Possibly executes other tasks until this task {@link #isDone is
703	<	* done}.  This method may be useful when processing collections
704	<	* of tasks when some have been cancelled or otherwise known to
705	<	* have aborted.
706	<	*
707	<	* <p>This method may be invoked only from within {@code
708	<	* ForkJoinTask} computations (as may be determined using method
709	<	* {@link #inForkJoinPool}).  Attempts to invoke in other contexts
710	<	* result in exceptions or errors, possibly including {@code
711	<	* ClassCastException}.
712	<	*/
713	<	public final void quietlyHelpJoin() {
714	<	if (status >= 0) {
715	<	ForkJoinWorkerThread w =
716	<	(ForkJoinWorkerThread) Thread.currentThread();
717	<	if (!w.unpushTask(this) || !tryQuietlyInvoke())
718	<	busyJoin(w);
671	>	for (;;) {
672	>	if (Thread.interrupted() && pool == null) {
673	>	interrupted = true;
674	>	break;
675	>	}
676	>	int s = status;
677	>	if (s < 0)
678	>	break;
679	>	if (UNSAFE.compareAndSwapInt(this, statusOffset, s, SIGNAL)) {
680	>	long startTime = System.nanoTime();
681	>	long nt; // wait time
682	>	while (status >= 0 &&
683	>	(nt = nanos - (System.nanoTime() - startTime)) > 0) {
684	>	if (pool != null && !dec)
685	>	dec = pool.tryDecrementRunningCount();
686	>	else {
687	>	long ms = nt / 1000000;
688	>	int ns = (int) (nt % 1000000);
689	>	try {
690	>	synchronized(this) {
691	>	if (status >= 0)
692	>	wait(ms, ns);
693	>	}
694	>	} catch (InterruptedException ie) {
695	>	if (pool != null)
696	>	cancelIfTerminating();
697	>	else {
698	>	interrupted = true;
699	>	break;
700	>	}
701	>	}
702	>	}
703	>	}
704	>	break;
705	>	}
706	>	}
707	>	if (pool != null && dec)
708	>	pool.incrementRunningCount();
709	>	if (interrupted)
710	>	throw new InterruptedException();
711	>	int es = status;
712	>	if (es != NORMAL) {
713	>	Throwable ex;
714	>	if (es == CANCELLED)
715	>	throw new CancellationException();
716	>	if (es == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
717	>	throw new ExecutionException(ex);
718	>	throw new TimeoutException();
719		}
720	+	return getRawResult();
721		}
722
723		/**
724	<	* Joins this task, without returning its result or throwing an
724	>	* Joins this task, without returning its result or throwing its
725		* exception. This method may be useful when processing
726		* collections of tasks when some have been cancelled or otherwise
727		* known to have aborted.
728		*/
729		public final void quietlyJoin() {
730	<	if (status >= 0) {
731	<	ForkJoinWorkerThread w = getWorker();
732	<	if (w == null || !w.unpushTask(this) || !tryQuietlyInvoke())
733	<	awaitDone(w, true);
730	>	Thread t;
731	>	if ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) {
732	>	ForkJoinWorkerThread w = (ForkJoinWorkerThread) t;
733	>	if (status >= 0) {
734	>	if (w.unpushTask(this)) {
735	>	boolean completed;
736	>	try {
737	>	completed = exec();
738	>	} catch (Throwable rex) {
739	>	setExceptionalCompletion(rex);
740	>	return;
741	>	}
742	>	if (completed) {
743	>	setCompletion(NORMAL);
744	>	return;
745	>	}
746	>	}
747	>	w.joinTask(this);
748	>	}
749		}
750	+	else
751	+	externalAwaitDone();
752		}
753
754		/**
755		* Commences performing this task and awaits its completion if
756	<	* necessary, without returning its result or throwing an
756	>	* necessary, without returning its result or throwing its
757		* exception. This method may be useful when processing
758		* collections of tasks when some have been cancelled or otherwise
759		* known to have aborted.
760		*/
761		public final void quietlyInvoke() {
762	<	if (status >= 0 && !tryQuietlyInvoke())
763	<	quietlyJoin();
762	>	if (status >= 0) {
763	>	boolean completed;
764	>	try {
765	>	completed = exec();
766	>	} catch (Throwable rex) {
767	>	setExceptionalCompletion(rex);
768	>	return;
769	>	}
770	>	if (completed)
771	>	setCompletion(NORMAL);
772	>	else
773	>	quietlyJoin();
774	>	}
775		}
776
777		/**
#	Line 935 | Line 803 | public abstract class ForkJoinTask<V> im
803		* pre-constructed trees of subtasks in loops.
804		*/
805		public void reinitialize() {
806	<	if ((status & COMPLETION_MASK) == EXCEPTIONAL)
806	>	if (status == EXCEPTIONAL)
807		exceptionMap.remove(this);
808		status = 0;
809		}
#	Line 1225 | Line 1093 | public abstract class ForkJoinTask<V> im
1093		private static final long serialVersionUID = -7721805057305804111L;
1094
1095		/**
1096	<	* Save the state to a stream.
1096	>	* Saves the state to a stream.
1097		*
1098		* @serialData the current run status and the exception thrown
1099		* during execution, or {@code null} if none
#	Line 1238 | Line 1106 | public abstract class ForkJoinTask<V> im
1106		}
1107
1108		/**
1109	<	* Reconstitute the instance from a stream.
1109	>	* Reconstitutes the instance from a stream.
1110		*
1111		* @param s the stream
1112		*/
1113		private void readObject(java.io.ObjectInputStream s)
1114		throws java.io.IOException, ClassNotFoundException {
1115		s.defaultReadObject();
1248	–	status &= ~INTERNAL_SIGNAL_MASK; // clear internal signal counts
1249	–	status |= EXTERNAL_SIGNAL; // conservatively set external signal
1116		Object ex = s.readObject();
1117		if (ex != null)
1118	<	setDoneExceptionally((Throwable) ex);
1118	>	setExceptionalCompletion((Throwable) ex);
1119		}
1120
1121		// Unsafe mechanics

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines