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.2 by dl, Wed Jan 7 16:07:37 2009 UTC vs.
Revision 1.14 by jsr166, Thu Jul 23 23:07:57 2009 UTC

#	Line 18 | Line 18 | import java.lang.reflect.*;
18		* lighter weight than a normal thread.  Huge numbers of tasks and
19		* subtasks may be hosted by a small number of actual threads in a
20		* ForkJoinPool, at the price of some usage limitations.
21	<	*
21	>	*
22		* <p> A "main" ForkJoinTask begins execution when submitted to a
23		* {@link ForkJoinPool}. Once started, it will usually in turn start
24		* other subtasks.  As indicated by the name of this class, many
25	<	* programs using ForkJoinTasks employ only methods <code>fork</code>
26	<	* and <code>join</code>, or derivatives such as
27	<	* <code>invokeAll</code>.  However, this class also provides a number
25	>	* programs using ForkJoinTasks employ only methods {@code fork}
26	>	* and {@code join}, or derivatives such as
27	>	* {@code invokeAll}.  However, this class also provides a number
28		* of other methods that can come into play in advanced usages, as
29		* well as extension mechanics that allow support of new forms of
30		* fork/join processing.
31	<	*
31	>	*
32		* <p>A ForkJoinTask is a lightweight form of {@link Future}.  The
33		* efficiency of ForkJoinTasks stems from a set of restrictions (that
34		* are only partially statically enforceable) reflecting their
#	Line 36 | Line 36 | import java.lang.reflect.*;
36		* operating on purely isolated objects.  The primary coordination
37		* mechanisms are {@link #fork}, that arranges asynchronous execution,
38		* and {@link #join}, that doesn't proceed until the task's result has
39	<	* been computed.  Computations should avoid <code>synchronized</code>
39	>	* been computed.  Computations should avoid {@code synchronized}
40		* methods or blocks, and should minimize other blocking
41		* synchronization apart from joining other tasks or using
42		* synchronizers such as Phasers that are advertised to cooperate with
#	Line 48 | Line 48 | import java.lang.reflect.*;
48		* performance, and the potential to indefinitely stall if the number
49		* of threads not waiting for IO or other external synchronization
50		* becomes exhausted. This usage restriction is in part enforced by
51	<	* not permitting checked exceptions such as <code>IOExceptions</code>
51	>	* not permitting checked exceptions such as {@code IOExceptions}
52		* to be thrown. However, computations may still encounter unchecked
53		* exceptions, that are rethrown to callers attempting join
54		* them. These exceptions may additionally include
#	Line 58 | Line 58 | import java.lang.reflect.*;
58		* <p>The primary method for awaiting completion and extracting
59		* results of a task is {@link #join}, but there are several variants:
60		* The {@link Future#get} methods support interruptible and/or timed
61	<	* waits for completion and report results using <code>Future</code>
61	>	* waits for completion and report results using {@code Future}
62		* conventions. Method {@link #helpJoin} enables callers to actively
63		* execute other tasks while awaiting joins, which is sometimes more
64		* efficient but only applies when all subtasks are known to be
65		* strictly tree-structured. Method {@link #invoke} is semantically
66	<	* equivalent to <code>fork(); join()</code> but always attempts to
66	>	* equivalent to {@code fork(); join()} but always attempts to
67		* begin execution in the current thread. The "<em>quiet</em>" forms
68		* of these methods do not extract results or report exceptions. These
69		* may be useful when a set of tasks are being executed, and you need
70		* to delay processing of results or exceptions until all complete.
71	<	* Method <code>invokeAll</code> (available in multiple versions)
71	>	* Method {@code invokeAll} (available in multiple versions)
72		* performs the most common form of parallel invocation: forking a set
73		* of tasks and joining them all.
74		*
#	Line 76 | Line 76 | import java.lang.reflect.*;
76		* Instead, you subclass one of the abstract classes that support a
77		* particular style of fork/join processing.  Normally, a concrete
78		* ForkJoinTask subclass declares fields comprising its parameters,
79	<	* established in a constructor, and then defines a <code>compute</code>
79	>	* established in a constructor, and then defines a {@code compute}
80		* method that somehow uses the control methods supplied by this base
81	<	* class. While these methods have <code>public</code> access (to allow
81	>	* class. While these methods have {@code public} access (to allow
82		* instances of different task subclasses to call each others
83		* methods), some of them may only be called from within other
84	<	* ForkJoinTasks. Attempts to invoke them in other contexts result in
85	<	* exceptions or errors including ClassCastException.
84	>	* ForkJoinTasks (as may be determined using method {@link
85	>	* #inForkJoinPool}).  Attempts to invoke them in other contexts
86	>	* result in exceptions or errors, possibly including
87	>	* ClassCastException.
88		*
89	<	* <p>Most base support methods are <code>final</code> because their
89	>	* <p>Most base support methods are {@code final} because their
90		* implementations are intrinsically tied to the underlying
91		* lightweight task scheduling framework, and so cannot be overridden.
92		* Developers creating new basic styles of fork/join processing should
93	<	* minimally implement <code>protected</code> methods
94	<	* <code>exec</code>, <code>setRawResult</code>, and
95	<	* <code>getRawResult</code>, while also introducing an abstract
93	>	* minimally implement {@code protected} methods
94	>	* {@code exec}, {@code setRawResult}, and
95	>	* {@code getRawResult}, while also introducing an abstract
96		* computational method that can be implemented in its subclasses,
97	<	* possibly relying on other <code>protected</code> methods provided
97	>	* possibly relying on other {@code protected} methods provided
98		* by this class.
99		*
100		* <p>ForkJoinTasks should perform relatively small amounts of
101	<	* computations, othewise splitting into smaller tasks. As a very
101	>	* computations, otherwise splitting into smaller tasks. As a very
102		* rough rule of thumb, a task should perform more than 100 and less
103		* than 10000 basic computational steps. If tasks are too big, then
104	<	* parellelism cannot improve throughput. If too small, then memory
104	>	* parallelism cannot improve throughput. If too small, then memory
105		* and internal task maintenance overhead may overwhelm processing.
106		*
107	<	* <p>ForkJoinTasks are <code>Serializable</code>, which enables them
107	>	* <p>ForkJoinTasks are {@code Serializable}, which enables them
108		* to be used in extensions such as remote execution frameworks. It is
109		* in general sensible to serialize tasks only before or after, but
110		* not during execution. Serialization is not relied on during
111		* execution itself.
112	+	*
113	+	* @since 1.7
114	+	* @author Doug Lea
115		*/
116		public abstract class ForkJoinTask<V> implements Future<V>, Serializable {
117
#	Line 128 | Line 133 | public abstract class ForkJoinTask<V> im
133		* currently unused. Also value 0x80000000 is available as spare
134		* completion value.
135		*/
136	<	volatile int status; // accessed directy by pool and workers
136	>	volatile int status; // accessed directly by pool and workers
137
138		static final int COMPLETION_MASK      = 0xe0000000;
139		static final int NORMAL               = 0xe0000000; // == mask
#	Line 141 | Line 146 | public abstract class ForkJoinTask<V> im
146		/**
147		* Table of exceptions thrown by tasks, to enable reporting by
148		* callers. Because exceptions are rare, we don't directly keep
149	<	* them with task objects, but instead us a weak ref table.  Note
149	>	* them with task objects, but instead use a weak ref table.  Note
150		* that cancellation exceptions don't appear in the table, but are
151		* instead recorded as status values.
152	<	* Todo: Use ConcurrentReferenceHashMap
152	>	* TODO: Use ConcurrentReferenceHashMap
153		*/
154		static final Map<ForkJoinTask<?>, Throwable> exceptionMap =
155		Collections.synchronizedMap
#	Line 153 | Line 158 | public abstract class ForkJoinTask<V> im
158		// within-package utilities
159
160		/**
161	<	* Get current worker thread, or null if not a worker thread
161	>	* Gets current worker thread, or null if not a worker thread.
162		*/
163		static ForkJoinWorkerThread getWorker() {
164		Thread t = Thread.currentThread();
165	<	return ((t instanceof ForkJoinWorkerThread)?
166	<	(ForkJoinWorkerThread)t : null);
165	>	return ((t instanceof ForkJoinWorkerThread) ?
166	>	(ForkJoinWorkerThread) t : null);
167		}
168
169		final boolean casStatus(int cmp, int val) {
170	<	return _unsafe.compareAndSwapInt(this, statusOffset, cmp, val);
170	>	return UNSAFE.compareAndSwapInt(this, statusOffset, cmp, val);
171		}
172
173		/**
#	Line 170 | Line 175 | public abstract class ForkJoinTask<V> im
175		*/
176		static void rethrowException(Throwable ex) {
177		if (ex != null)
178	<	_unsafe.throwException(ex);
178	>	UNSAFE.throwException(ex);
179		}
180
181		// Setting completion status
182
183		/**
184	<	* Mark completion and wake up threads waiting to join this task.
184	>	* Marks completion and wakes up threads waiting to join this task.
185	>	*
186		* @param completion one of NORMAL, CANCELLED, EXCEPTIONAL
187		*/
188		final void setCompletion(int completion) {
189		ForkJoinPool pool = getPool();
190		if (pool != null) {
191		int s; // Clear signal bits while setting completion status
192	<	do;while ((s = status) >= 0 && !casStatus(s, completion));
192	>	do {} while ((s = status) >= 0 && !casStatus(s, completion));
193
194		if ((s & SIGNAL_MASK) != 0) {
195		if ((s &= INTERNAL_SIGNAL_MASK) != 0)
196		pool.updateRunningCount(s);
197	<	synchronized(this) { notifyAll(); }
197	>	synchronized (this) { notifyAll(); }
198		}
199		}
200		else
#	Line 201 | Line 207 | public abstract class ForkJoinTask<V> im
207		*/
208		private void externallySetCompletion(int completion) {
209		int s;
210	<	do;while ((s = status) >= 0 &&
211	<	!casStatus(s, (s & SIGNAL_MASK) | completion));
212	<	synchronized(this) { notifyAll(); }
210	>	do {} while ((s = status) >= 0 &&
211	>	!casStatus(s, (s & SIGNAL_MASK) | completion));
212	>	synchronized (this) { notifyAll(); }
213		}
214
215		/**
216	<	* Sets status to indicate normal completion
216	>	* Sets status to indicate normal completion.
217		*/
218		final void setNormalCompletion() {
219		// Try typical fast case -- single CAS, no signal, not already done.
220		// Manually expand casStatus to improve chances of inlining it
221	<	if (!_unsafe.compareAndSwapInt(this, statusOffset, 0, NORMAL))
221	>	if (!UNSAFE.compareAndSwapInt(this, statusOffset, 0, NORMAL))
222		setCompletion(NORMAL);
223		}
224
225		// internal waiting and notification
226
227		/**
228	<	* Performs the actual monitor wait for awaitDone
228	>	* Performs the actual monitor wait for awaitDone.
229		*/
230		private void doAwaitDone() {
231		// Minimize lock bias and in/de-flation effects by maximizing
232		// chances of waiting inside sync
233		try {
234		while (status >= 0)
235	<	synchronized(this) { if (status >= 0) wait(); }
235	>	synchronized (this) { if (status >= 0) wait(); }
236		} catch (InterruptedException ie) {
237		onInterruptedWait();
238		}
239		}
240
241		/**
242	<	* Performs the actual monitor wait for awaitDone
242	>	* Performs the actual timed monitor wait for awaitDone.
243		*/
244		private void doAwaitDone(long startTime, long nanos) {
245	<	synchronized(this) {
245	>	synchronized (this) {
246		try {
247		while (status >= 0) {
248		long nt = nanos - System.nanoTime() - startTime;
249		if (nt <= 0)
250		break;
251	<	wait(nt / 1000000, (int)(nt % 1000000));
251	>	wait(nt / 1000000, (int) (nt % 1000000));
252		}
253		} catch (InterruptedException ie) {
254		onInterruptedWait();
#	Line 255 | Line 261 | public abstract class ForkJoinTask<V> im
261		/**
262		* Sets status to indicate there is joiner, then waits for join,
263		* surrounded with pool notifications.
264	+	*
265		* @return status upon exit
266		*/
267	<	final int awaitDone(ForkJoinWorkerThread w, boolean maintainParallelism) {
268	<	ForkJoinPool pool = w == null? null : w.pool;
267	>	private int awaitDone(ForkJoinWorkerThread w,
268	>	boolean maintainParallelism) {
269	>	ForkJoinPool pool = (w == null) ? null : w.pool;
270		int s;
271		while ((s = status) >= 0) {
272	<	if (casStatus(s, pool == null? s|EXTERNAL_SIGNAL : s+1)) {
272	>	if (casStatus(s, (pool == null) ? s|EXTERNAL_SIGNAL : s+1)) {
273		if (pool == null || !pool.preJoin(this, maintainParallelism))
274		doAwaitDone();
275		if (((s = status) & INTERNAL_SIGNAL_MASK) != 0)
#	Line 274 | Line 282 | public abstract class ForkJoinTask<V> im
282
283		/**
284		* Timed version of awaitDone
285	+	*
286		* @return status upon exit
287		*/
288	<	final int awaitDone(ForkJoinWorkerThread w, long nanos) {
289	<	ForkJoinPool pool = w == null? null : w.pool;
288	>	private int awaitDone(ForkJoinWorkerThread w, long nanos) {
289	>	ForkJoinPool pool = (w == null) ? null : w.pool;
290		int s;
291		while ((s = status) >= 0) {
292	<	if (casStatus(s, pool == null? s|EXTERNAL_SIGNAL : s+1)) {
292	>	if (casStatus(s, (pool == null) ? s|EXTERNAL_SIGNAL : s+1)) {
293		long startTime = System.nanoTime();
294		if (pool == null || !pool.preJoin(this, false))
295		doAwaitDone(startTime, nanos);
#	Line 297 | Line 306 | public abstract class ForkJoinTask<V> im
306		}
307
308		/**
309	<	* Notify pool that thread is unblocked. Called by signalled
309	>	* Notifies pool that thread is unblocked. Called by signalled
310		* threads when woken by non-FJ threads (which is atypical).
311		*/
312		private void adjustPoolCountsOnUnblock(ForkJoinPool pool) {
313		int s;
314	<	do;while ((s = status) < 0 && !casStatus(s, s & COMPLETION_MASK));
314	>	do {} while ((s = status) < 0 && !casStatus(s, s & COMPLETION_MASK));
315		if (pool != null && (s &= INTERNAL_SIGNAL_MASK) != 0)
316		pool.updateRunningCount(s);
317		}
318
319		/**
320	<	* Notify pool to adjust counts on cancelled or timed out wait
320	>	* Notifies pool to adjust counts on cancelled or timed out wait.
321		*/
322		private void adjustPoolCountsOnCancelledWait(ForkJoinPool pool) {
323		if (pool != null) {
#	Line 323 | Line 332 | public abstract class ForkJoinTask<V> im
332		}
333
334		/**
335	<	* Handle interruptions during waits.
335	>	* Handles interruptions during waits.
336		*/
337		private void onInterruptedWait() {
338		ForkJoinWorkerThread w = getWorker();
339		if (w == null)
340		Thread.currentThread().interrupt(); // re-interrupt
341		else if (w.isTerminating())
342	<	cancelIgnoreExceptions();
342	>	cancelIgnoringExceptions();
343		// else if FJworker, ignore interrupt
344		}
345
#	Line 342 | Line 351 | public abstract class ForkJoinTask<V> im
351		}
352
353		/**
354	<	* Throws the exception associated with status s;
354	>	* Throws the exception associated with status s.
355	>	*
356		* @throws the exception
357		*/
358		private void reportException(int s) {
#	Line 355 | Line 365 | public abstract class ForkJoinTask<V> im
365		}
366
367		/**
368	<	* Returns result or throws exception using j.u.c.Future conventions
369	<	* Only call when isDone known to be true.
368	>	* Returns result or throws exception using j.u.c.Future conventions.
369	>	* Only call when {@code isDone} known to be true.
370		*/
371		private V reportFutureResult()
372		throws ExecutionException, InterruptedException {
#	Line 375 | Line 385 | public abstract class ForkJoinTask<V> im
385
386		/**
387		* Returns result or throws exception using j.u.c.Future conventions
388	<	* with timeouts
388	>	* with timeouts.
389		*/
390		private V reportTimedFutureResult()
391		throws InterruptedException, ExecutionException, TimeoutException {
#	Line 396 | Line 406 | public abstract class ForkJoinTask<V> im
406
407		/**
408		* Calls exec, recording completion, and rethrowing exception if
409	<	* encountered. Caller should normally check status before calling
409	>	* encountered. Caller should normally check status before calling.
410	>	*
411		* @return true if completed normally
412		*/
413		private boolean tryExec() {
#	Line 414 | Line 425 | public abstract class ForkJoinTask<V> im
425
426		/**
427		* Main execution method used by worker threads. Invokes
428	<	* base computation unless already complete
428	>	* base computation unless already complete.
429		*/
430		final void quietlyExec() {
431		if (status >= 0) {
432		try {
433		if (!exec())
434		return;
435	<	} catch(Throwable rex) {
435	>	} catch (Throwable rex) {
436		setDoneExceptionally(rex);
437		return;
438		}
#	Line 430 | Line 441 | public abstract class ForkJoinTask<V> im
441		}
442
443		/**
444	<	* Calls exec, recording but not rethrowing exception
445	<	* Caller should normally check status before calling
444	>	* Calls exec(), recording but not rethrowing exception.
445	>	* Caller should normally check status before calling.
446	>	*
447		* @return true if completed normally
448		*/
449		private boolean tryQuietlyInvoke() {
#	Line 447 | Line 459 | public abstract class ForkJoinTask<V> im
459		}
460
461		/**
462	<	* Cancel, ignoring any exceptions it throws
462	>	* Cancels, ignoring any exceptions it throws.
463		*/
464	<	final void cancelIgnoreExceptions() {
464	>	final void cancelIgnoringExceptions() {
465		try {
466		cancel(false);
467	<	} catch(Throwable ignore) {
467	>	} catch (Throwable ignore) {
468		}
469		}
470
471	+	/**
472	+	* Main implementation of helpJoin
473	+	*/
474	+	private int busyJoin(ForkJoinWorkerThread w) {
475	+	int s;
476	+	ForkJoinTask<?> t;
477	+	while ((s = status) >= 0 && (t = w.scanWhileJoining(this)) != null)
478	+	t.quietlyExec();
479	+	return (s >= 0) ? awaitDone(w, false) : s; // block if no work
480	+	}
481	+
482		// public methods
483
484		/**
#	Line 463 | Line 486 | public abstract class ForkJoinTask<V> im
486		* necessarily enforced, it is a usage error to fork a task more
487		* than once unless it has completed and been reinitialized.  This
488		* method may be invoked only from within ForkJoinTask
489	<	* computations. Attempts to invoke in other contexts result in
490	<	* exceptions or errors including ClassCastException.
489	>	* computations (as may be determined using method {@link
490	>	* #inForkJoinPool}). Attempts to invoke in other contexts result
491	>	* in exceptions or errors, possibly including ClassCastException.
492		*/
493		public final void fork() {
494	<	((ForkJoinWorkerThread)(Thread.currentThread())).pushTask(this);
494	>	((ForkJoinWorkerThread) Thread.currentThread())
495	>	.pushTask(this);
496		}
497
498		/**
499		* Returns the result of the computation when it is ready.
500	<	* This method differs from <code>get</code> in that abnormal
500	>	* This method differs from {@code get} in that abnormal
501		* completion results in RuntimeExceptions or Errors, not
502		* ExecutionExceptions.
503		*
#	Line 485 | Line 510 | public abstract class ForkJoinTask<V> im
510		return getRawResult();
511		}
512
488	–	public final V get() throws InterruptedException, ExecutionException {
489	–	ForkJoinWorkerThread w = getWorker();
490	–	if (w == null || status < 0 || !w.unpushTask(this) || !tryQuietlyInvoke())
491	–	awaitDone(w, true);
492	–	return reportFutureResult();
493	–	}
494	–
495	–	public final V get(long timeout, TimeUnit unit)
496	–	throws InterruptedException, ExecutionException, TimeoutException {
497	–	ForkJoinWorkerThread w = getWorker();
498	–	if (w == null || status < 0 || !w.unpushTask(this) || !tryQuietlyInvoke())
499	–	awaitDone(w, unit.toNanos(timeout));
500	–	return reportTimedFutureResult();
501	–	}
502	–
513		/**
514		* Commences performing this task, awaits its completion if
515		* necessary, and return its result.
516	+	*
517		* @throws Throwable (a RuntimeException, Error, or unchecked
518	<	* exception) if the underlying computation did so.
518	>	* exception) if the underlying computation did so
519		* @return the computed result
520		*/
521		public final V invoke() {
#	Line 515 | Line 526 | public abstract class ForkJoinTask<V> im
526		}
527
528		/**
529	<	* Forks both tasks, returning when <code>isDone</code> holds for
529	>	* Forks both tasks, returning when {@code isDone} holds for
530		* both of them or an exception is encountered. This method may be
531	<	* invoked only from within ForkJoinTask computations. Attempts to
532	<	* invoke in other contexts result in exceptions or errors
533	<	* including ClassCastException.
531	>	* invoked only from within ForkJoinTask computations (as may be
532	>	* determined using method {@link #inForkJoinPool}). Attempts to
533	>	* invoke in other contexts result in exceptions or errors,
534	>	* possibly including ClassCastException.
535	>	*
536		* @param t1 one task
537		* @param t2 the other task
538		* @throws NullPointerException if t1 or t2 are null
539	<	* @throws RuntimeException or Error if either task did so.
539	>	* @throws RuntimeException or Error if either task did so
540		*/
541		public static void invokeAll(ForkJoinTask<?>t1, ForkJoinTask<?> t2) {
542		t2.fork();
#	Line 532 | Line 545 | public abstract class ForkJoinTask<V> im
545		}
546
547		/**
548	<	* Forks the given tasks, returning when <code>isDone</code> holds
548	>	* Forks the given tasks, returning when {@code isDone} holds
549		* for all of them. If any task encounters an exception, others
550		* may be cancelled.  This method may be invoked only from within
551	<	* ForkJoinTask computations. Attempts to invoke in other contexts
552	<	* result in exceptions or errors including ClassCastException.
551	>	* ForkJoinTask computations (as may be determined using method
552	>	* {@link #inForkJoinPool}). Attempts to invoke in other contexts
553	>	* result in exceptions or errors, possibly including
554	>	* ClassCastException.
555	>	*
556		* @param tasks the array of tasks
557	<	* @throws NullPointerException if tasks or any element are null.
558	<	* @throws RuntimeException or Error if any task did so.
557	>	* @throws NullPointerException if tasks or any element are null
558	>	* @throws RuntimeException or Error if any task did so
559		*/
560		public static void invokeAll(ForkJoinTask<?>... tasks) {
561		Throwable ex = null;
#	Line 576 | Line 592 | public abstract class ForkJoinTask<V> im
592
593		/**
594		* Forks all tasks in the collection, returning when
595	<	* <code>isDone</code> holds for all of them. If any task
595	>	* {@code isDone} holds for all of them. If any task
596		* encounters an exception, others may be cancelled.  This method
597	<	* may be invoked only from within ForkJoinTask
598	<	* computations. Attempts to invoke in other contexts resul!t in
599	<	* exceptions or errors including ClassCastException.
597	>	* may be invoked only from within ForkJoinTask computations (as
598	>	* may be determined using method {@link
599	>	* #inForkJoinPool}). Attempts to invoke in other contexts result
600	>	* in exceptions or errors, possibly including ClassCastException.
601	>	*
602		* @param tasks the collection of tasks
603	<	* @throws NullPointerException if tasks or any element are null.
604	<	* @throws RuntimeException or Error if any task did so.
603	>	* @throws NullPointerException if tasks or any element are null
604	>	* @throws RuntimeException or Error if any task did so
605		*/
606		public static void invokeAll(Collection<? extends ForkJoinTask<?>> tasks) {
607		if (!(tasks instanceof List)) {
608	<	invokeAll(tasks.toArray(new ForkJoinTask[tasks.size()]));
608	>	invokeAll(tasks.toArray(new ForkJoinTask<?>[tasks.size()]));
609		return;
610		}
611		List<? extends ForkJoinTask<?>> ts =
612	<	(List<? extends ForkJoinTask<?>>)tasks;
612	>	(List<? extends ForkJoinTask<?>>) tasks;
613		Throwable ex = null;
614		int last = ts.size() - 1;
615		for (int i = last; i >= 0; --i) {
#	Line 627 | Line 645 | public abstract class ForkJoinTask<V> im
645		/**
646		* Returns true if the computation performed by this task has
647		* completed (or has been cancelled).
648	+	*
649		* @return true if this computation has completed
650		*/
651		public final boolean isDone() {
#	Line 635 | Line 654 | public abstract class ForkJoinTask<V> im
654
655		/**
656		* Returns true if this task was cancelled.
657	+	*
658		* @return true if this task was cancelled
659		*/
660		public final boolean isCancelled() {
#	Line 642 | Line 662 | public abstract class ForkJoinTask<V> im
662		}
663
664		/**
645	–	* Returns true if this task threw an exception or was cancelled
646	–	* @return true if this task threw an exception or was cancelled
647	–	*/
648	–	public final boolean isCompletedAbnormally() {
649	–	return (status & COMPLETION_MASK) < NORMAL;
650	–	}
651	–
652	–	/**
653	–	* Returns the exception thrown by the base computation, or a
654	–	* CancellationException if cancelled, or null if none or if the
655	–	* method has not yet completed.
656	–	* @return the exception, or null if none
657	–	*/
658	–	public final Throwable getException() {
659	–	int s = status & COMPLETION_MASK;
660	–	if (s >= NORMAL)
661	–	return null;
662	–	if (s == CANCELLED)
663	–	return new CancellationException();
664	–	return exceptionMap.get(this);
665	–	}
666	–
667	–	/**
665		* Asserts that the results of this task's computation will not be
666	<	* used. If a cancellation occurs before atempting to execute this
667	<	* task, then execution will be suppressed, <code>isCancelled</code>
668	<	* will report true, and <code>join</code> will result in a
669	<	* <code>CancellationException</code> being thrown. Otherwise, when
666	>	* used. If a cancellation occurs before attempting to execute this
667	>	* task, then execution will be suppressed, {@code isCancelled}
668	>	* will report true, and {@code join} will result in a
669	>	* {@code CancellationException} being thrown. Otherwise, when
670		* cancellation races with completion, there are no guarantees
671	<	* about whether <code>isCancelled</code> will report true, whether
672	<	* <code>join</code> will return normally or via an exception, or
671	>	* about whether {@code isCancelled} will report true, whether
672	>	* {@code join} will return normally or via an exception, or
673		* whether these behaviors will remain consistent upon repeated
674		* invocation.
675		*
#	Line 683 | Line 680 | public abstract class ForkJoinTask<V> im
680		* <p> This method is designed to be invoked by <em>other</em>
681		* tasks. To terminate the current task, you can just return or
682		* throw an unchecked exception from its computation method, or
683	<	* invoke <code>completeExceptionally</code>.
683	>	* invoke {@code completeExceptionally}.
684		*
685		* @param mayInterruptIfRunning this value is ignored in the
686		* default implementation because tasks are not in general
687	<	* cancelled via interruption.
687	>	* cancelled via interruption
688		*
689		* @return true if this task is now cancelled
690		*/
#	Line 697 | Line 694 | public abstract class ForkJoinTask<V> im
694		}
695
696		/**
697	+	* Returns true if this task threw an exception or was cancelled.
698	+	*
699	+	* @return true if this task threw an exception or was cancelled
700	+	*/
701	+	public final boolean isCompletedAbnormally() {
702	+	return (status & COMPLETION_MASK) < NORMAL;
703	+	}
704	+
705	+	/**
706	+	* Returns the exception thrown by the base computation, or a
707	+	* CancellationException if cancelled, or null if none or if the
708	+	* method has not yet completed.
709	+	*
710	+	* @return the exception, or null if none
711	+	*/
712	+	public final Throwable getException() {
713	+	int s = status & COMPLETION_MASK;
714	+	if (s >= NORMAL)
715	+	return null;
716	+	if (s == CANCELLED)
717	+	return new CancellationException();
718	+	return exceptionMap.get(this);
719	+	}
720	+
721	+	/**
722		* Completes this task abnormally, and if not already aborted or
723		* cancelled, causes it to throw the given exception upon
724	<	* <code>join</code> and related operations. This method may be used
724	>	* {@code join} and related operations. This method may be used
725		* to induce exceptions in asynchronous tasks, or to force
726		* completion of tasks that would not otherwise complete.  Its use
727		* in other situations is likely to be wrong.  This method is
728	<	* overridable, but overridden versions must invoke <code>super</code>
728	>	* overridable, but overridden versions must invoke {@code super}
729		* implementation to maintain guarantees.
730		*
731		* @param ex the exception to throw. If this exception is
#	Line 712 | Line 734 | public abstract class ForkJoinTask<V> im
734		*/
735		public void completeExceptionally(Throwable ex) {
736		setDoneExceptionally((ex instanceof RuntimeException) ||
737	<	(ex instanceof Error)? ex :
737	>	(ex instanceof Error) ? ex :
738		new RuntimeException(ex));
739		}
740
741		/**
742		* Completes this task, and if not already aborted or cancelled,
743	<	* returning a <code>null</code> result upon <code>join</code> and related
743	>	* returning a {@code null} result upon {@code join} and related
744		* operations. This method may be used to provide results for
745		* asynchronous tasks, or to provide alternative handling for
746		* tasks that would not otherwise complete normally. Its use in
747		* other situations is likely to be wrong. This method is
748	<	* overridable, but overridden versions must invoke <code>super</code>
748	>	* overridable, but overridden versions must invoke {@code super}
749		* implementation to maintain guarantees.
750		*
751	<	* @param value the result value for this task.
751	>	* @param value the result value for this task
752		*/
753		public void complete(V value) {
754		try {
755		setRawResult(value);
756	<	} catch(Throwable rex) {
756	>	} catch (Throwable rex) {
757		setDoneExceptionally(rex);
758		return;
759		}
760		setNormalCompletion();
761		}
762
763	+	public final V get() throws InterruptedException, ExecutionException {
764	+	ForkJoinWorkerThread w = getWorker();
765	+	if (w == null || status < 0 || !w.unpushTask(this) || !tryQuietlyInvoke())
766	+	awaitDone(w, true);
767	+	return reportFutureResult();
768	+	}
769	+
770	+	public final V get(long timeout, TimeUnit unit)
771	+	throws InterruptedException, ExecutionException, TimeoutException {
772	+	ForkJoinWorkerThread w = getWorker();
773	+	if (w == null || status < 0 || !w.unpushTask(this) || !tryQuietlyInvoke())
774	+	awaitDone(w, unit.toNanos(timeout));
775	+	return reportTimedFutureResult();
776	+	}
777	+
778		/**
779		* Possibly executes other tasks until this task is ready, then
780		* returns the result of the computation.  This method may be more
781	<	* efficient than <code>join</code>, but is only applicable when
782	<	* there are no potemtial dependencies between continuation of the
781	>	* efficient than {@code join}, but is only applicable when
782	>	* there are no potential dependencies between continuation of the
783		* current task and that of any other task that might be executed
784		* while helping. (This usually holds for pure divide-and-conquer
785		* tasks). This method may be invoked only from within
786	<	* ForkJoinTask computations. Attempts to invoke in other contexts
787	<	* resul!t in exceptions or errors including ClassCastException.
786	>	* ForkJoinTask computations (as may be determined using method
787	>	* {@link #inForkJoinPool}). Attempts to invoke in other contexts
788	>	* result in exceptions or errors, possibly including
789	>	* ClassCastException.
790	>	*
791		* @return the computed result
792		*/
793		public final V helpJoin() {
794	<	ForkJoinWorkerThread w = (ForkJoinWorkerThread)(Thread.currentThread());
794	>	ForkJoinWorkerThread w = (ForkJoinWorkerThread) Thread.currentThread();
795		if (status < 0 || !w.unpushTask(this) || !tryExec())
796	<	reportException(w.helpJoinTask(this));
796	>	reportException(busyJoin(w));
797		return getRawResult();
798		}
799
800		/**
801		* Possibly executes other tasks until this task is ready.  This
802		* method may be invoked only from within ForkJoinTask
803	<	* computations. Attempts to invoke in other contexts resul!t in
804	<	* exceptions or errors including ClassCastException.
803	>	* computations (as may be determined using method {@link
804	>	* #inForkJoinPool}). Attempts to invoke in other contexts result
805	>	* in exceptions or errors, possibly including ClassCastException.
806		*/
807		public final void quietlyHelpJoin() {
808		if (status >= 0) {
809		ForkJoinWorkerThread w =
810	<	(ForkJoinWorkerThread)(Thread.currentThread());
810	>	(ForkJoinWorkerThread) Thread.currentThread();
811		if (!w.unpushTask(this) || !tryQuietlyInvoke())
812	<	w.helpJoinTask(this);
812	>	busyJoin(w);
813		}
814		}
815
#	Line 799 | Line 840 | public abstract class ForkJoinTask<V> im
840		}
841
842		/**
843	+	* Possibly executes tasks until the pool hosting the current task
844	+	* {@link ForkJoinPool#isQuiescent}. This method may be of use in
845	+	* designs in which many tasks are forked, but none are explicitly
846	+	* joined, instead executing them until all are processed.
847	+	*/
848	+	public static void helpQuiesce() {
849	+	((ForkJoinWorkerThread) Thread.currentThread())
850	+	.helpQuiescePool();
851	+	}
852	+
853	+	/**
854		* Resets the internal bookkeeping state of this task, allowing a
855	<	* subsequent <code>fork</code>. This method allows repeated reuse of
855	>	* subsequent {@code fork}. This method allows repeated reuse of
856		* this task, but only if reuse occurs when this task has either
857		* never been forked, or has been forked, then completed and all
858		* outstanding joins of this task have also completed. Effects
#	Line 816 | Line 868 | public abstract class ForkJoinTask<V> im
868
869		/**
870		* Returns the pool hosting the current task execution, or null
871	<	* if this task is executing outside of any pool.
872	<	* @return the pool, or null if none.
871	>	* if this task is executing outside of any ForkJoinPool.
872	>	*
873	>	* @return the pool, or null if none
874		*/
875		public static ForkJoinPool getPool() {
876		Thread t = Thread.currentThread();
877	<	return ((t instanceof ForkJoinWorkerThread)?
878	<	((ForkJoinWorkerThread)t).pool : null);
877	>	return ((t instanceof ForkJoinWorkerThread) ?
878	>	((ForkJoinWorkerThread) t).pool : null);
879	>	}
880	>
881	>	/**
882	>	* Returns {@code true} if the current thread is executing as a
883	>	* ForkJoinPool computation.
884	>	*
885	>	* @return {@code true} if the current thread is executing as a
886	>	* ForkJoinPool computation, or false otherwise
887	>	*/
888	>	public static boolean inForkJoinPool() {
889	>	return Thread.currentThread() instanceof ForkJoinWorkerThread;
890		}
891
892		/**
#	Line 832 | Line 896 | public abstract class ForkJoinTask<V> im
896		* another thread.  This method may be useful when arranging
897		* alternative local processing of tasks that could have been, but
898		* were not, stolen. This method may be invoked only from within
899	<	* ForkJoinTask computations. Attempts to invoke in other contexts
900	<	* result in exceptions or errors including ClassCastException.
899	>	* ForkJoinTask computations (as may be determined using method
900	>	* {@link #inForkJoinPool}). Attempts to invoke in other contexts
901	>	* result in exceptions or errors, possibly including
902	>	* ClassCastException.
903	>	*
904		* @return true if unforked
905		*/
906		public boolean tryUnfork() {
907	<	return ((ForkJoinWorkerThread)(Thread.currentThread())).unpushTask(this);
908	<	}
842	<
843	<	/**
844	<	* Possibly executes tasks until the pool hosting the current task
845	<	* {@link ForkJoinPool#isQuiescent}. This method may be of use in
846	<	* designs in which many tasks are forked, but none are explicitly
847	<	* joined, instead executing them until all are processed.
848	<	*/
849	<	public static void helpQuiesce() {
850	<	((ForkJoinWorkerThread)(Thread.currentThread())).
851	<	helpQuiescePool();
907	>	return ((ForkJoinWorkerThread) Thread.currentThread())
908	>	.unpushTask(this);
909		}
910
911		/**
#	Line 856 | Line 913 | public abstract class ForkJoinTask<V> im
913		* forked by the current worker thread but not yet executed. This
914		* value may be useful for heuristic decisions about whether to
915		* fork other tasks.
916	+	*
917		* @return the number of tasks
918		*/
919		public static int getQueuedTaskCount() {
920	<	return ((ForkJoinWorkerThread)(Thread.currentThread())).
921	<	getQueueSize();
920	>	return ((ForkJoinWorkerThread) Thread.currentThread())
921	>	.getQueueSize();
922		}
923
924		/**
925	<	* Returns a estimate of how many more locally queued tasks are
925	>	* Returns an estimate of how many more locally queued tasks are
926		* held by the current worker thread than there are other worker
927		* threads that might steal them.  This value may be useful for
928		* heuristic decisions about whether to fork other tasks. In many
#	Line 872 | Line 930 | public abstract class ForkJoinTask<V> im
930		* aim to maintain a small constant surplus (for example, 3) of
931		* tasks, and to process computations locally if this threshold is
932		* exceeded.
933	+	*
934		* @return the surplus number of tasks, which may be negative
935		*/
936		public static int getSurplusQueuedTaskCount() {
937	<	return ((ForkJoinWorkerThread)(Thread.currentThread()))
937	>	return ((ForkJoinWorkerThread) Thread.currentThread())
938		.getEstimatedSurplusTaskCount();
939		}
940
941		// Extension methods
942
943		/**
944	<	* Returns the result that would be returned by <code>join</code>,
944	>	* Returns the result that would be returned by {@code join},
945		* even if this task completed abnormally, or null if this task is
946		* not known to have been completed.  This method is designed to
947		* aid debugging, as well as to support extensions. Its use in any
948		* other context is discouraged.
949		*
950	<	* @return the result, or null if not completed.
950	>	* @return the result, or null if not completed
951		*/
952		public abstract V getRawResult();
953
#	Line 907 | Line 966 | public abstract class ForkJoinTask<V> im
966		* called otherwise. The return value controls whether this task
967		* is considered to be done normally. It may return false in
968		* asynchronous actions that require explicit invocations of
969	<	* <code>complete</code> to become joinable. It may throw exceptions
969	>	* {@code complete} to become joinable. It may throw exceptions
970		* to indicate abnormal exit.
971	+	*
972		* @return true if completed normally
973		* @throws Error or RuntimeException if encountered during computation
974		*/
975		protected abstract boolean exec();
976
977		/**
978	<	* Returns, but does not unschedule or execute, the task most
979	<	* recently forked by the current thread but not yet executed, if
980	<	* one is available. There is no guarantee that this task will
981	<	* actually be polled or executed next.
982	<	* This method is designed primarily to support extensions,
983	<	* and is unlikely to be useful otherwise.
978	>	* Returns, but does not unschedule or execute, the task queued by
979	>	* the current thread but not yet executed, if one is
980	>	* available. There is no guarantee that this task will actually
981	>	* be polled or executed next.  This method is designed primarily
982	>	* to support extensions, and is unlikely to be useful otherwise.
983	>	* This method may be invoked only from within ForkJoinTask
984	>	* computations (as may be determined using method {@link
985	>	* #inForkJoinPool}). Attempts to invoke in other contexts result
986	>	* in exceptions or errors, possibly including ClassCastException.
987		*
988		* @return the next task, or null if none are available
989		*/
990		protected static ForkJoinTask<?> peekNextLocalTask() {
991	<	return ((ForkJoinWorkerThread)(Thread.currentThread())).peekTask();
991	>	return ((ForkJoinWorkerThread) Thread.currentThread())
992	>	.peekTask();
993		}
994
995		/**
996	<	* Unschedules and returns, without executing, the task most
997	<	* recently forked by the current thread but not yet executed.
998	<	* This method is designed primarily to support extensions,
999	<	* and is unlikely to be useful otherwise.
996	>	* Unschedules and returns, without executing, the next task
997	>	* queued by the current thread but not yet executed.  This method
998	>	* is designed primarily to support extensions, and is unlikely to
999	>	* be useful otherwise.  This method may be invoked only from
1000	>	* within ForkJoinTask computations (as may be determined using
1001	>	* method {@link #inForkJoinPool}). Attempts to invoke in other
1002	>	* contexts result in exceptions or errors, possibly including
1003	>	* ClassCastException.
1004		*
1005		* @return the next task, or null if none are available
1006		*/
1007		protected static ForkJoinTask<?> pollNextLocalTask() {
1008	<	return ((ForkJoinWorkerThread)(Thread.currentThread())).popTask();
1008	>	return ((ForkJoinWorkerThread) Thread.currentThread())
1009	>	.pollLocalTask();
1010		}
1011
1012		/**
1013	<	* Unschedules and returns, without executing, the task most
1014	<	* recently forked by the current thread but not yet executed, if
1015	<	* one is available, or if not available, a task that was forked
1016	<	* by some other thread, if available. Availability may be
1017	<	* transient, so a <code>null</code> result does not necessarily
1018	<	* imply quiecence of the pool this task is operating in.
1019	<	* This method is designed primarily to support extensions,
1020	<	* and is unlikely to be useful otherwise.
1021	<	*
1013	>	* Unschedules and returns, without executing, the next task
1014	>	* queued by the current thread but not yet executed, if one is
1015	>	* available, or if not available, a task that was forked by some
1016	>	* other thread, if available. Availability may be transient, so a
1017	>	* {@code null} result does not necessarily imply quiescence
1018	>	* of the pool this task is operating in.  This method is designed
1019	>	* primarily to support extensions, and is unlikely to be useful
1020	>	* otherwise.  This method may be invoked only from within
1021	>	* ForkJoinTask computations (as may be determined using method
1022	>	* {@link #inForkJoinPool}). Attempts to invoke in other contexts
1023	>	* result in exceptions or errors, possibly including
1024	>	* ClassCastException.
1025	>	*
1026		* @return a task, or null if none are available
1027		*/
1028		protected static ForkJoinTask<?> pollTask() {
1029	<	return ((ForkJoinWorkerThread)(Thread.currentThread())).
1030	<	getLocalOrStolenTask();
1029	>	return ((ForkJoinWorkerThread) Thread.currentThread())
1030	>	.pollTask();
1031		}
1032
1033		// Serialization support
#	Line 965 | Line 1038 | public abstract class ForkJoinTask<V> im
1038		* Save the state to a stream.
1039		*
1040		* @serialData the current run status and the exception thrown
1041	<	* during execution, or null if none.
1041	>	* during execution, or null if none
1042		* @param s the stream
1043		*/
1044		private void writeObject(java.io.ObjectOutputStream s)
#	Line 976 | Line 1049 | public abstract class ForkJoinTask<V> im
1049
1050		/**
1051		* Reconstitute the instance from a stream.
1052	+	*
1053		* @param s the stream
1054		*/
1055		private void readObject(java.io.ObjectInputStream s)
#	Line 985 | Line 1059 | public abstract class ForkJoinTask<V> im
1059		status |= EXTERNAL_SIGNAL; // conservatively set external signal
1060		Object ex = s.readObject();
1061		if (ex != null)
1062	<	setDoneExceptionally((Throwable)ex);
1062	>	setDoneExceptionally((Throwable) ex);
1063		}
1064
1065		// Temporary Unsafe mechanics for preliminary release
1066	+	private static Unsafe getUnsafe() throws Throwable {
1067	+	try {
1068	+	return Unsafe.getUnsafe();
1069	+	} catch (SecurityException se) {
1070	+	try {
1071	+	return java.security.AccessController.doPrivileged
1072	+	(new java.security.PrivilegedExceptionAction<Unsafe>() {
1073	+	public Unsafe run() throws Exception {
1074	+	return getUnsafePrivileged();
1075	+	}});
1076	+	} catch (java.security.PrivilegedActionException e) {
1077	+	throw e.getCause();
1078	+	}
1079	+	}
1080	+	}
1081	+
1082	+	private static Unsafe getUnsafePrivileged()
1083	+	throws NoSuchFieldException, IllegalAccessException {
1084	+	Field f = Unsafe.class.getDeclaredField("theUnsafe");
1085	+	f.setAccessible(true);
1086	+	return (Unsafe) f.get(null);
1087	+	}
1088	+
1089	+	private static long fieldOffset(String fieldName)
1090	+	throws NoSuchFieldException {
1091	+	return UNSAFE.objectFieldOffset
1092	+	(ForkJoinTask.class.getDeclaredField(fieldName));
1093	+	}
1094
1095	<	static final Unsafe _unsafe;
1095	>	static final Unsafe UNSAFE;
1096		static final long statusOffset;
1097
1098		static {
1099		try {
1100	<	if (ForkJoinTask.class.getClassLoader() != null) {
1101	<	Field f = Unsafe.class.getDeclaredField("theUnsafe");
1102	<	f.setAccessible(true);
1103	<	_unsafe = (Unsafe)f.get(null);
1104	<	}
1003	<	else
1004	<	_unsafe = Unsafe.getUnsafe();
1005	<	statusOffset = _unsafe.objectFieldOffset
1006	<	(ForkJoinTask.class.getDeclaredField("status"));
1007	<	} catch (Exception ex) { throw new Error(ex); }
1100	>	UNSAFE = getUnsafe();
1101	>	statusOffset = fieldOffset("status");
1102	>	} catch (Throwable e) {
1103	>	throw new RuntimeException("Could not initialize intrinsics", e);
1104	>	}
1105		}
1106
1107		}

Diff Legend

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