1 |
dl |
1.1 |
/* |
2 |
|
|
* Written by Doug Lea with assistance from members of JCP JSR-166 |
3 |
|
|
* Expert Group and released to the public domain, as explained at |
4 |
|
|
* http://creativecommons.org/licenses/publicdomain |
5 |
|
|
*/ |
6 |
|
|
|
7 |
|
|
package jsr166y; |
8 |
jsr166 |
1.17 |
|
9 |
dl |
1.1 |
import java.io.Serializable; |
10 |
jsr166 |
1.17 |
import java.util.Collection; |
11 |
|
|
import java.util.Collections; |
12 |
|
|
import java.util.List; |
13 |
dl |
1.32 |
import java.util.RandomAccess; |
14 |
jsr166 |
1.17 |
import java.util.Map; |
15 |
dl |
1.74 |
import java.lang.ref.WeakReference; |
16 |
|
|
import java.lang.ref.ReferenceQueue; |
17 |
dl |
1.66 |
import java.util.concurrent.Callable; |
18 |
|
|
import java.util.concurrent.CancellationException; |
19 |
|
|
import java.util.concurrent.ExecutionException; |
20 |
|
|
import java.util.concurrent.Executor; |
21 |
|
|
import java.util.concurrent.ExecutorService; |
22 |
|
|
import java.util.concurrent.Future; |
23 |
|
|
import java.util.concurrent.RejectedExecutionException; |
24 |
|
|
import java.util.concurrent.RunnableFuture; |
25 |
|
|
import java.util.concurrent.TimeUnit; |
26 |
|
|
import java.util.concurrent.TimeoutException; |
27 |
dl |
1.74 |
import java.util.concurrent.locks.ReentrantLock; |
28 |
|
|
import java.lang.reflect.Constructor; |
29 |
dl |
1.1 |
|
30 |
|
|
/** |
31 |
jsr166 |
1.26 |
* Abstract base class for tasks that run within a {@link ForkJoinPool}. |
32 |
|
|
* A {@code ForkJoinTask} is a thread-like entity that is much |
33 |
dl |
1.2 |
* lighter weight than a normal thread. Huge numbers of tasks and |
34 |
|
|
* subtasks may be hosted by a small number of actual threads in a |
35 |
|
|
* ForkJoinPool, at the price of some usage limitations. |
36 |
dl |
1.4 |
* |
37 |
jsr166 |
1.28 |
* <p>A "main" {@code ForkJoinTask} begins execution when submitted |
38 |
|
|
* to a {@link ForkJoinPool}. Once started, it will usually in turn |
39 |
|
|
* start other subtasks. As indicated by the name of this class, |
40 |
|
|
* many programs using {@code ForkJoinTask} employ only methods |
41 |
|
|
* {@link #fork} and {@link #join}, or derivatives such as {@link |
42 |
dl |
1.62 |
* #invokeAll(ForkJoinTask...) invokeAll}. However, this class also |
43 |
|
|
* provides a number of other methods that can come into play in |
44 |
|
|
* advanced usages, as well as extension mechanics that allow |
45 |
|
|
* support of new forms of fork/join processing. |
46 |
dl |
1.4 |
* |
47 |
jsr166 |
1.28 |
* <p>A {@code ForkJoinTask} is a lightweight form of {@link Future}. |
48 |
|
|
* The efficiency of {@code ForkJoinTask}s stems from a set of |
49 |
|
|
* restrictions (that are only partially statically enforceable) |
50 |
|
|
* reflecting their intended use as computational tasks calculating |
51 |
|
|
* pure functions or operating on purely isolated objects. The |
52 |
|
|
* primary coordination mechanisms are {@link #fork}, that arranges |
53 |
|
|
* asynchronous execution, and {@link #join}, that doesn't proceed |
54 |
|
|
* until the task's result has been computed. Computations should |
55 |
|
|
* avoid {@code synchronized} methods or blocks, and should minimize |
56 |
|
|
* other blocking synchronization apart from joining other tasks or |
57 |
|
|
* using synchronizers such as Phasers that are advertised to |
58 |
|
|
* cooperate with fork/join scheduling. Tasks should also not perform |
59 |
|
|
* blocking IO, and should ideally access variables that are |
60 |
|
|
* completely independent of those accessed by other running |
61 |
|
|
* tasks. Minor breaches of these restrictions, for example using |
62 |
|
|
* shared output streams, may be tolerable in practice, but frequent |
63 |
|
|
* use may result in poor performance, and the potential to |
64 |
|
|
* indefinitely stall if the number of threads not waiting for IO or |
65 |
|
|
* other external synchronization becomes exhausted. This usage |
66 |
|
|
* restriction is in part enforced by not permitting checked |
67 |
|
|
* exceptions such as {@code IOExceptions} to be thrown. However, |
68 |
|
|
* computations may still encounter unchecked exceptions, that are |
69 |
dl |
1.32 |
* rethrown to callers attempting to join them. These exceptions may |
70 |
jsr166 |
1.44 |
* additionally include {@link RejectedExecutionException} stemming |
71 |
|
|
* from internal resource exhaustion, such as failure to allocate |
72 |
dl |
1.74 |
* internal task queues. Rethrown exceptions behave in the same way as |
73 |
|
|
* regular exceptions, but, when possible, contain stack traces (as |
74 |
|
|
* displayed for example using {@code ex.printStackTrace()}) of both |
75 |
|
|
* the thread that initiated the computation as well as the thread |
76 |
|
|
* actually encountering the exception; minimally only the latter. |
77 |
dl |
1.1 |
* |
78 |
dl |
1.2 |
* <p>The primary method for awaiting completion and extracting |
79 |
|
|
* results of a task is {@link #join}, but there are several variants: |
80 |
|
|
* The {@link Future#get} methods support interruptible and/or timed |
81 |
jsr166 |
1.8 |
* waits for completion and report results using {@code Future} |
82 |
dl |
1.49 |
* conventions. Method {@link #invoke} is semantically |
83 |
dl |
1.35 |
* equivalent to {@code fork(); join()} but always attempts to begin |
84 |
|
|
* execution in the current thread. The "<em>quiet</em>" forms of |
85 |
|
|
* these methods do not extract results or report exceptions. These |
86 |
dl |
1.2 |
* may be useful when a set of tasks are being executed, and you need |
87 |
|
|
* to delay processing of results or exceptions until all complete. |
88 |
jsr166 |
1.8 |
* Method {@code invokeAll} (available in multiple versions) |
89 |
dl |
1.2 |
* performs the most common form of parallel invocation: forking a set |
90 |
|
|
* of tasks and joining them all. |
91 |
|
|
* |
92 |
dl |
1.35 |
* <p>The execution status of tasks may be queried at several levels |
93 |
|
|
* of detail: {@link #isDone} is true if a task completed in any way |
94 |
|
|
* (including the case where a task was cancelled without executing); |
95 |
|
|
* {@link #isCompletedNormally} is true if a task completed without |
96 |
dl |
1.42 |
* cancellation or encountering an exception; {@link #isCancelled} is |
97 |
|
|
* true if the task was cancelled (in which case {@link #getException} |
98 |
|
|
* returns a {@link java.util.concurrent.CancellationException}); and |
99 |
|
|
* {@link #isCompletedAbnormally} is true if a task was either |
100 |
|
|
* cancelled or encountered an exception, in which case {@link |
101 |
|
|
* #getException} will return either the encountered exception or |
102 |
|
|
* {@link java.util.concurrent.CancellationException}. |
103 |
dl |
1.35 |
* |
104 |
jsr166 |
1.28 |
* <p>The ForkJoinTask class is not usually directly subclassed. |
105 |
dl |
1.2 |
* Instead, you subclass one of the abstract classes that support a |
106 |
dl |
1.27 |
* particular style of fork/join processing, typically {@link |
107 |
|
|
* RecursiveAction} for computations that do not return results, or |
108 |
|
|
* {@link RecursiveTask} for those that do. Normally, a concrete |
109 |
dl |
1.2 |
* ForkJoinTask subclass declares fields comprising its parameters, |
110 |
jsr166 |
1.8 |
* established in a constructor, and then defines a {@code compute} |
111 |
dl |
1.2 |
* method that somehow uses the control methods supplied by this base |
112 |
jsr166 |
1.8 |
* class. While these methods have {@code public} access (to allow |
113 |
dl |
1.32 |
* instances of different task subclasses to call each other's |
114 |
dl |
1.2 |
* methods), some of them may only be called from within other |
115 |
dl |
1.13 |
* ForkJoinTasks (as may be determined using method {@link |
116 |
|
|
* #inForkJoinPool}). Attempts to invoke them in other contexts |
117 |
jsr166 |
1.14 |
* result in exceptions or errors, possibly including |
118 |
dl |
1.57 |
* {@code ClassCastException}. |
119 |
dl |
1.1 |
* |
120 |
dl |
1.69 |
* <p>Method {@link #join} and its variants are appropriate for use |
121 |
|
|
* only when completion dependencies are acyclic; that is, the |
122 |
|
|
* parallel computation can be described as a directed acyclic graph |
123 |
|
|
* (DAG). Otherwise, executions may encounter a form of deadlock as |
124 |
|
|
* tasks cyclically wait for each other. However, this framework |
125 |
|
|
* supports other methods and techniques (for example the use of |
126 |
|
|
* {@link Phaser}, {@link #helpQuiesce}, and {@link #complete}) that |
127 |
|
|
* may be of use in constructing custom subclasses for problems that |
128 |
|
|
* are not statically structured as DAGs. |
129 |
|
|
* |
130 |
dl |
1.32 |
* <p>Most base support methods are {@code final}, to prevent |
131 |
|
|
* overriding of implementations that are intrinsically tied to the |
132 |
|
|
* underlying lightweight task scheduling framework. Developers |
133 |
|
|
* creating new basic styles of fork/join processing should minimally |
134 |
|
|
* implement {@code protected} methods {@link #exec}, {@link |
135 |
|
|
* #setRawResult}, and {@link #getRawResult}, while also introducing |
136 |
|
|
* an abstract computational method that can be implemented in its |
137 |
|
|
* subclasses, possibly relying on other {@code protected} methods |
138 |
|
|
* provided by this class. |
139 |
dl |
1.1 |
* |
140 |
|
|
* <p>ForkJoinTasks should perform relatively small amounts of |
141 |
dl |
1.32 |
* computation. Large tasks should be split into smaller subtasks, |
142 |
|
|
* usually via recursive decomposition. As a very rough rule of thumb, |
143 |
|
|
* a task should perform more than 100 and less than 10000 basic |
144 |
dl |
1.70 |
* computational steps, and should avoid indefinite looping. If tasks |
145 |
|
|
* are too big, then parallelism cannot improve throughput. If too |
146 |
|
|
* small, then memory and internal task maintenance overhead may |
147 |
|
|
* overwhelm processing. |
148 |
dl |
1.1 |
* |
149 |
jsr166 |
1.37 |
* <p>This class provides {@code adapt} methods for {@link Runnable} |
150 |
|
|
* and {@link Callable}, that may be of use when mixing execution of |
151 |
dl |
1.49 |
* {@code ForkJoinTasks} with other kinds of tasks. When all tasks are |
152 |
|
|
* of this form, consider using a pool constructed in <em>asyncMode</em>. |
153 |
dl |
1.27 |
* |
154 |
dl |
1.32 |
* <p>ForkJoinTasks are {@code Serializable}, which enables them to be |
155 |
|
|
* used in extensions such as remote execution frameworks. It is |
156 |
|
|
* sensible to serialize tasks only before or after, but not during, |
157 |
|
|
* execution. Serialization is not relied on during execution itself. |
158 |
jsr166 |
1.12 |
* |
159 |
|
|
* @since 1.7 |
160 |
|
|
* @author Doug Lea |
161 |
dl |
1.1 |
*/ |
162 |
|
|
public abstract class ForkJoinTask<V> implements Future<V>, Serializable { |
163 |
dl |
1.2 |
|
164 |
dl |
1.46 |
/* |
165 |
|
|
* See the internal documentation of class ForkJoinPool for a |
166 |
|
|
* general implementation overview. ForkJoinTasks are mainly |
167 |
|
|
* responsible for maintaining their "status" field amidst relays |
168 |
|
|
* to methods in ForkJoinWorkerThread and ForkJoinPool. The |
169 |
|
|
* methods of this class are more-or-less layered into (1) basic |
170 |
|
|
* status maintenance (2) execution and awaiting completion (3) |
171 |
|
|
* user-level methods that additionally report results. This is |
172 |
|
|
* sometimes hard to see because this file orders exported methods |
173 |
dl |
1.74 |
* in a way that flows well in javadocs. |
174 |
dl |
1.46 |
*/ |
175 |
|
|
|
176 |
dl |
1.50 |
/* |
177 |
|
|
* The status field holds run control status bits packed into a |
178 |
|
|
* single int to minimize footprint and to ensure atomicity (via |
179 |
|
|
* CAS). Status is initially zero, and takes on nonnegative |
180 |
|
|
* values until completed, upon which status holds value |
181 |
jsr166 |
1.59 |
* NORMAL, CANCELLED, or EXCEPTIONAL. Tasks undergoing blocking |
182 |
dl |
1.50 |
* waits by other threads have the SIGNAL bit set. Completion of |
183 |
|
|
* a stolen task with SIGNAL set awakens any waiters via |
184 |
|
|
* notifyAll. Even though suboptimal for some purposes, we use |
185 |
|
|
* basic builtin wait/notify to take advantage of "monitor |
186 |
|
|
* inflation" in JVMs that we would otherwise need to emulate to |
187 |
|
|
* avoid adding further per-task bookkeeping overhead. We want |
188 |
|
|
* these monitors to be "fat", i.e., not use biasing or thin-lock |
189 |
|
|
* techniques, so use some odd coding idioms that tend to avoid |
190 |
|
|
* them. |
191 |
dl |
1.1 |
*/ |
192 |
dl |
1.50 |
|
193 |
dl |
1.53 |
/** The run status of this task */ |
194 |
jsr166 |
1.9 |
volatile int status; // accessed directly by pool and workers |
195 |
dl |
1.49 |
private static final int NORMAL = -1; |
196 |
|
|
private static final int CANCELLED = -2; |
197 |
|
|
private static final int EXCEPTIONAL = -3; |
198 |
|
|
private static final int SIGNAL = 1; |
199 |
dl |
1.1 |
|
200 |
|
|
/** |
201 |
dl |
1.46 |
* Marks completion and wakes up threads waiting to join this task, |
202 |
|
|
* also clearing signal request bits. |
203 |
|
|
* |
204 |
|
|
* @param completion one of NORMAL, CANCELLED, EXCEPTIONAL |
205 |
dl |
1.74 |
* @return completion status on exit |
206 |
dl |
1.1 |
*/ |
207 |
dl |
1.74 |
private int setCompletion(int completion) { |
208 |
|
|
for (int s;;) { |
209 |
|
|
if ((s = status) < 0) |
210 |
|
|
return s; |
211 |
dl |
1.46 |
if (UNSAFE.compareAndSwapInt(this, statusOffset, s, completion)) { |
212 |
dl |
1.51 |
if (s != 0) |
213 |
dl |
1.46 |
synchronized (this) { notifyAll(); } |
214 |
dl |
1.74 |
return completion; |
215 |
dl |
1.46 |
} |
216 |
|
|
} |
217 |
dl |
1.1 |
} |
218 |
|
|
|
219 |
|
|
/** |
220 |
dl |
1.74 |
* Tries to block a worker thread until completed or timed out. |
221 |
|
|
* Uses Object.wait time argument conventions. |
222 |
|
|
* May fail on contention or interrupt. |
223 |
jsr166 |
1.60 |
* |
224 |
dl |
1.74 |
* @param millis if > 0, wait time. |
225 |
dl |
1.1 |
*/ |
226 |
dl |
1.74 |
final void tryAwaitDone(long millis) { |
227 |
|
|
int s; |
228 |
|
|
try { |
229 |
|
|
if (((s = status) > 0 || |
230 |
|
|
(s == 0 && |
231 |
|
|
UNSAFE.compareAndSwapInt(this, statusOffset, 0, SIGNAL))) && |
232 |
|
|
status > 0) { |
233 |
jsr166 |
1.61 |
synchronized (this) { |
234 |
dl |
1.72 |
if (status > 0) |
235 |
dl |
1.74 |
wait(millis); |
236 |
dl |
1.1 |
} |
237 |
|
|
} |
238 |
dl |
1.74 |
} catch (InterruptedException ie) { |
239 |
|
|
// caller must check termination |
240 |
dl |
1.1 |
} |
241 |
|
|
} |
242 |
|
|
|
243 |
|
|
/** |
244 |
dl |
1.70 |
* Blocks a non-worker-thread until completion. |
245 |
dl |
1.74 |
* @return status upon completion |
246 |
dl |
1.55 |
*/ |
247 |
dl |
1.74 |
private int externalAwaitDone() { |
248 |
|
|
int s; |
249 |
|
|
if ((s = status) >= 0) { |
250 |
dl |
1.70 |
boolean interrupted = false; |
251 |
jsr166 |
1.73 |
synchronized (this) { |
252 |
dl |
1.74 |
while ((s = status) >= 0) { |
253 |
dl |
1.72 |
if (s == 0) |
254 |
|
|
UNSAFE.compareAndSwapInt(this, statusOffset, |
255 |
|
|
0, SIGNAL); |
256 |
|
|
else { |
257 |
|
|
try { |
258 |
|
|
wait(); |
259 |
|
|
} catch (InterruptedException ie) { |
260 |
|
|
interrupted = true; |
261 |
|
|
} |
262 |
dl |
1.70 |
} |
263 |
dl |
1.55 |
} |
264 |
|
|
} |
265 |
dl |
1.70 |
if (interrupted) |
266 |
|
|
Thread.currentThread().interrupt(); |
267 |
dl |
1.55 |
} |
268 |
dl |
1.74 |
return s; |
269 |
dl |
1.55 |
} |
270 |
|
|
|
271 |
|
|
/** |
272 |
dl |
1.71 |
* Blocks a non-worker-thread until completion or interruption or timeout. |
273 |
dl |
1.1 |
*/ |
274 |
dl |
1.74 |
private int externalInterruptibleAwaitDone(long millis) |
275 |
dl |
1.70 |
throws InterruptedException { |
276 |
dl |
1.74 |
int s; |
277 |
dl |
1.70 |
if (Thread.interrupted()) |
278 |
|
|
throw new InterruptedException(); |
279 |
dl |
1.74 |
if ((s = status) >= 0) { |
280 |
jsr166 |
1.73 |
synchronized (this) { |
281 |
dl |
1.74 |
while ((s = status) >= 0) { |
282 |
dl |
1.72 |
if (s == 0) |
283 |
|
|
UNSAFE.compareAndSwapInt(this, statusOffset, |
284 |
|
|
0, SIGNAL); |
285 |
dl |
1.70 |
else |
286 |
dl |
1.74 |
wait(millis); |
287 |
|
|
} |
288 |
|
|
} |
289 |
|
|
} |
290 |
|
|
return s; |
291 |
|
|
} |
292 |
|
|
|
293 |
|
|
/** |
294 |
|
|
* Primary execution method for stolen tasks. Unless done, calls |
295 |
|
|
* exec and records status if completed, but doesn't wait for |
296 |
|
|
* completion otherwise. |
297 |
|
|
*/ |
298 |
|
|
final void doExec() { |
299 |
|
|
if (status >= 0) { |
300 |
|
|
boolean completed; |
301 |
|
|
try { |
302 |
|
|
completed = exec(); |
303 |
|
|
} catch (Throwable rex) { |
304 |
|
|
setExceptionalCompletion(rex); |
305 |
|
|
return; |
306 |
|
|
} |
307 |
|
|
if (completed) |
308 |
|
|
setCompletion(NORMAL); // must be outside try block |
309 |
|
|
} |
310 |
|
|
} |
311 |
|
|
|
312 |
|
|
/** |
313 |
|
|
* Primary mechanics for join, get, quietlyJoin. |
314 |
|
|
* @return status upon completion |
315 |
|
|
*/ |
316 |
|
|
private int doJoin() { |
317 |
|
|
Thread t; ForkJoinWorkerThread w; int s; boolean completed; |
318 |
|
|
if ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) { |
319 |
|
|
if ((s = status) < 0) |
320 |
|
|
return s; |
321 |
|
|
if ((w = (ForkJoinWorkerThread)t).unpushTask(this)) { |
322 |
|
|
try { |
323 |
|
|
completed = exec(); |
324 |
|
|
} catch (Throwable rex) { |
325 |
|
|
return setExceptionalCompletion(rex); |
326 |
dl |
1.46 |
} |
327 |
dl |
1.74 |
if (completed) |
328 |
|
|
return setCompletion(NORMAL); |
329 |
dl |
1.1 |
} |
330 |
dl |
1.74 |
return w.joinTask(this); |
331 |
dl |
1.1 |
} |
332 |
dl |
1.74 |
else |
333 |
|
|
return externalAwaitDone(); |
334 |
dl |
1.1 |
} |
335 |
|
|
|
336 |
|
|
/** |
337 |
dl |
1.74 |
* Primary mechanics for invoke, quietlyInvoke. |
338 |
|
|
* @return status upon completion |
339 |
dl |
1.1 |
*/ |
340 |
dl |
1.74 |
private int doInvoke() { |
341 |
|
|
int s; boolean completed; |
342 |
|
|
if ((s = status) < 0) |
343 |
|
|
return s; |
344 |
dl |
1.48 |
try { |
345 |
dl |
1.74 |
completed = exec(); |
346 |
dl |
1.48 |
} catch (Throwable rex) { |
347 |
dl |
1.74 |
return setExceptionalCompletion(rex); |
348 |
|
|
} |
349 |
|
|
if (completed) |
350 |
|
|
return setCompletion(NORMAL); |
351 |
|
|
else |
352 |
|
|
return doJoin(); |
353 |
|
|
} |
354 |
|
|
|
355 |
|
|
// Exception table support |
356 |
|
|
|
357 |
|
|
/** |
358 |
|
|
* Table of exceptions thrown by tasks, to enable reporting by |
359 |
|
|
* callers. Because exceptions are rare, we don't directly keep |
360 |
|
|
* them with task objects, but instead use a weak ref table. Note |
361 |
|
|
* that cancellation exceptions don't appear in the table, but are |
362 |
|
|
* instead recorded as status values. |
363 |
|
|
* |
364 |
|
|
* Note: These statics are initialized below in static block. |
365 |
|
|
*/ |
366 |
|
|
private static final ExceptionNode[] exceptionTable; |
367 |
|
|
private static final ReentrantLock exceptionTableLock; |
368 |
|
|
private static final ReferenceQueue<Object> exceptionTableRefQueue; |
369 |
|
|
|
370 |
|
|
/** |
371 |
|
|
* Fixed capacity for exceptionTable. |
372 |
|
|
*/ |
373 |
|
|
private static final int EXCEPTION_MAP_CAPACITY = 32; |
374 |
|
|
|
375 |
|
|
/** |
376 |
|
|
* Key-value nodes for exception table. The chained hash table |
377 |
|
|
* uses identity comparisons, full locking, and weak references |
378 |
|
|
* for keys. The table has a fixed capacity because it only |
379 |
|
|
* maintains task exceptions long enough for joiners to access |
380 |
|
|
* them, so should never become very large for sustained |
381 |
|
|
* periods. However, since we do not know when the last joiner |
382 |
|
|
* completes, we must use weak references and expunge them. We do |
383 |
|
|
* so on each operation (hence full locking). Also, some thread in |
384 |
|
|
* any ForkJoinPool will call helpExpunge when its pool becomes |
385 |
|
|
* isQuiescent. |
386 |
|
|
*/ |
387 |
|
|
static final class ExceptionNode extends WeakReference<ForkJoinTask<?>>{ |
388 |
|
|
final Throwable ex; |
389 |
|
|
ExceptionNode next; |
390 |
|
|
final long thrower; |
391 |
|
|
ExceptionNode(ForkJoinTask<?> task, Throwable ex, ExceptionNode next) { |
392 |
|
|
super(task, exceptionTableRefQueue); |
393 |
|
|
this.ex = ex; |
394 |
|
|
this.next = next; |
395 |
|
|
this.thrower = Thread.currentThread().getId(); |
396 |
|
|
} |
397 |
|
|
} |
398 |
|
|
|
399 |
|
|
/** |
400 |
|
|
* Records exception and sets exceptional completion. |
401 |
|
|
* |
402 |
|
|
* @return status on exit |
403 |
|
|
*/ |
404 |
|
|
private int setExceptionalCompletion(Throwable ex) { |
405 |
|
|
int h = System.identityHashCode(this); |
406 |
|
|
ReentrantLock lock = exceptionTableLock; |
407 |
|
|
lock.lock(); |
408 |
|
|
try { |
409 |
|
|
expungeStaleExceptions(); |
410 |
|
|
ExceptionNode[] t = exceptionTable; |
411 |
|
|
int i = h & (t.length - 1); |
412 |
|
|
for (ExceptionNode e = t[i]; ; e = e.next) { |
413 |
|
|
if (e == null) { |
414 |
|
|
t[i] = new ExceptionNode(this, ex, t[i]); |
415 |
|
|
break; |
416 |
|
|
} |
417 |
|
|
if (e.get() == this) // already present |
418 |
|
|
break; |
419 |
|
|
} |
420 |
|
|
} finally { |
421 |
|
|
lock.unlock(); |
422 |
|
|
} |
423 |
|
|
return setCompletion(EXCEPTIONAL); |
424 |
|
|
} |
425 |
|
|
|
426 |
|
|
/** |
427 |
|
|
* Removes exception node and clears status |
428 |
|
|
*/ |
429 |
|
|
private void clearExceptionalCompletion() { |
430 |
|
|
int h = System.identityHashCode(this); |
431 |
|
|
ReentrantLock lock = exceptionTableLock; |
432 |
|
|
lock.lock(); |
433 |
|
|
try { |
434 |
|
|
ExceptionNode[] t = exceptionTable; |
435 |
|
|
int i = h & (t.length - 1); |
436 |
|
|
ExceptionNode e = t[i]; |
437 |
|
|
ExceptionNode pred = null; |
438 |
|
|
while (e != null) { |
439 |
|
|
ExceptionNode next = e.next; |
440 |
|
|
if (e.get() == this) { |
441 |
|
|
if (pred == null) |
442 |
|
|
t[i] = next; |
443 |
|
|
else |
444 |
|
|
pred.next = next; |
445 |
|
|
break; |
446 |
|
|
} |
447 |
|
|
pred = e; |
448 |
|
|
e = next; |
449 |
|
|
} |
450 |
|
|
expungeStaleExceptions(); |
451 |
|
|
status = 0; |
452 |
|
|
} finally { |
453 |
|
|
lock.unlock(); |
454 |
|
|
} |
455 |
|
|
} |
456 |
|
|
|
457 |
|
|
/** |
458 |
|
|
* Returns a rethrowable exception for the given task, if |
459 |
|
|
* available. To provide accurate stack traces, if the exception |
460 |
|
|
* was not thrown by the current thread, we try to create a new |
461 |
|
|
* exception of the same type as the one thrown, but with the |
462 |
|
|
* recorded exception as its cause. If there is no such |
463 |
|
|
* constructor, we instead try to use a no-arg constructor, |
464 |
|
|
* followed by initCause, to the same effect. If none of these |
465 |
|
|
* apply, or any fail due to other exceptions, we return the |
466 |
|
|
* recorded exception, which is still correct, although it may |
467 |
|
|
* contain a misleading stack trace. |
468 |
|
|
* |
469 |
|
|
* @return the exception, or null if none |
470 |
|
|
*/ |
471 |
|
|
private Throwable getThrowableException() { |
472 |
|
|
if (status != EXCEPTIONAL) |
473 |
|
|
return null; |
474 |
|
|
int h = System.identityHashCode(this); |
475 |
|
|
ExceptionNode e; |
476 |
|
|
ReentrantLock lock = exceptionTableLock; |
477 |
|
|
lock.lock(); |
478 |
|
|
try { |
479 |
|
|
expungeStaleExceptions(); |
480 |
|
|
ExceptionNode[] t = exceptionTable; |
481 |
|
|
e = t[h & (t.length - 1)]; |
482 |
|
|
while (e != null && e.get() != this) |
483 |
|
|
e = e.next; |
484 |
|
|
} finally { |
485 |
|
|
lock.unlock(); |
486 |
|
|
} |
487 |
|
|
Throwable ex; |
488 |
|
|
if (e == null || (ex = e.ex) == null) |
489 |
|
|
return null; |
490 |
|
|
if (e.thrower != Thread.currentThread().getId()) { |
491 |
|
|
Class ec = ex.getClass(); |
492 |
|
|
try { |
493 |
|
|
Constructor<?> noArgCtor = null; |
494 |
|
|
Constructor<?>[] cs = ec.getConstructors();// public ctors only |
495 |
|
|
for (int i = 0; i < cs.length; ++i) { |
496 |
|
|
Constructor<?> c = cs[i]; |
497 |
|
|
Class<?>[] ps = c.getParameterTypes(); |
498 |
|
|
if (ps.length == 0) |
499 |
|
|
noArgCtor = c; |
500 |
|
|
else if (ps.length == 1 && ps[0] == Throwable.class) |
501 |
|
|
return (Throwable)(c.newInstance(ex)); |
502 |
|
|
} |
503 |
|
|
if (noArgCtor != null) { |
504 |
|
|
Throwable wx = (Throwable)(noArgCtor.newInstance()); |
505 |
|
|
wx.initCause(ex); |
506 |
|
|
return wx; |
507 |
|
|
} |
508 |
|
|
} catch (Exception ignore) { |
509 |
|
|
} |
510 |
|
|
} |
511 |
|
|
return ex; |
512 |
|
|
} |
513 |
|
|
|
514 |
|
|
/** |
515 |
|
|
* Poll stale refs and remove them. Call only while holding lock. |
516 |
|
|
*/ |
517 |
|
|
private static void expungeStaleExceptions() { |
518 |
|
|
for (Object x; (x = exceptionTableRefQueue.poll()) != null;) { |
519 |
|
|
if (x instanceof ExceptionNode) { |
520 |
|
|
ForkJoinTask<?> key = ((ExceptionNode)x).get(); |
521 |
|
|
ExceptionNode[] t = exceptionTable; |
522 |
|
|
int i = System.identityHashCode(key) & (t.length - 1); |
523 |
|
|
ExceptionNode e = t[i]; |
524 |
|
|
ExceptionNode pred = null; |
525 |
|
|
while (e != null) { |
526 |
|
|
ExceptionNode next = e.next; |
527 |
|
|
if (e == x) { |
528 |
|
|
if (pred == null) |
529 |
|
|
t[i] = next; |
530 |
|
|
else |
531 |
|
|
pred.next = next; |
532 |
|
|
break; |
533 |
|
|
} |
534 |
|
|
pred = e; |
535 |
|
|
e = next; |
536 |
|
|
} |
537 |
|
|
} |
538 |
|
|
} |
539 |
|
|
} |
540 |
|
|
|
541 |
|
|
/** |
542 |
|
|
* If lock is available, poll any stale refs and remove them. |
543 |
|
|
* Called from ForkJoinPool when pools become quiescent. |
544 |
|
|
*/ |
545 |
|
|
static final void helpExpungeStaleExceptions() { |
546 |
|
|
ReentrantLock lock = exceptionTableLock; |
547 |
|
|
if (lock.tryLock()) { |
548 |
|
|
try { |
549 |
|
|
expungeStaleExceptions(); |
550 |
|
|
} finally { |
551 |
|
|
lock.unlock(); |
552 |
|
|
} |
553 |
dl |
1.1 |
} |
554 |
dl |
1.74 |
} |
555 |
|
|
|
556 |
|
|
/** |
557 |
|
|
* Report the result of invoke or join; called only upon |
558 |
|
|
* non-normal return of internal versions. |
559 |
|
|
*/ |
560 |
|
|
private V reportResult() { |
561 |
|
|
int s; Throwable ex; |
562 |
|
|
if ((s = status) == CANCELLED) |
563 |
|
|
throw new CancellationException(); |
564 |
|
|
if (s == EXCEPTIONAL && (ex = getThrowableException()) != null) |
565 |
|
|
UNSAFE.throwException(ex); |
566 |
|
|
return getRawResult(); |
567 |
dl |
1.1 |
} |
568 |
|
|
|
569 |
|
|
// public methods |
570 |
|
|
|
571 |
|
|
/** |
572 |
|
|
* Arranges to asynchronously execute this task. While it is not |
573 |
|
|
* necessarily enforced, it is a usage error to fork a task more |
574 |
jsr166 |
1.31 |
* than once unless it has completed and been reinitialized. |
575 |
dl |
1.43 |
* Subsequent modifications to the state of this task or any data |
576 |
|
|
* it operates on are not necessarily consistently observable by |
577 |
|
|
* any thread other than the one executing it unless preceded by a |
578 |
|
|
* call to {@link #join} or related methods, or a call to {@link |
579 |
|
|
* #isDone} returning {@code true}. |
580 |
dl |
1.18 |
* |
581 |
jsr166 |
1.31 |
* <p>This method may be invoked only from within {@code |
582 |
dl |
1.70 |
* ForkJoinPool} computations (as may be determined using method |
583 |
jsr166 |
1.31 |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
584 |
|
|
* result in exceptions or errors, possibly including {@code |
585 |
|
|
* ClassCastException}. |
586 |
|
|
* |
587 |
|
|
* @return {@code this}, to simplify usage |
588 |
dl |
1.1 |
*/ |
589 |
dl |
1.18 |
public final ForkJoinTask<V> fork() { |
590 |
jsr166 |
1.14 |
((ForkJoinWorkerThread) Thread.currentThread()) |
591 |
|
|
.pushTask(this); |
592 |
dl |
1.18 |
return this; |
593 |
dl |
1.1 |
} |
594 |
|
|
|
595 |
|
|
/** |
596 |
dl |
1.69 |
* Returns the result of the computation when it {@link #isDone is |
597 |
|
|
* done}. This method differs from {@link #get()} in that |
598 |
jsr166 |
1.31 |
* abnormal completion results in {@code RuntimeException} or |
599 |
dl |
1.69 |
* {@code Error}, not {@code ExecutionException}, and that |
600 |
|
|
* interrupts of the calling thread do <em>not</em> cause the |
601 |
|
|
* method to abruptly return by throwing {@code |
602 |
|
|
* InterruptedException}. |
603 |
dl |
1.1 |
* |
604 |
|
|
* @return the computed result |
605 |
|
|
*/ |
606 |
|
|
public final V join() { |
607 |
dl |
1.74 |
if (doJoin() != NORMAL) |
608 |
|
|
return reportResult(); |
609 |
|
|
else |
610 |
|
|
return getRawResult(); |
611 |
dl |
1.1 |
} |
612 |
|
|
|
613 |
|
|
/** |
614 |
dl |
1.2 |
* Commences performing this task, awaits its completion if |
615 |
jsr166 |
1.56 |
* necessary, and returns its result, or throws an (unchecked) |
616 |
dl |
1.57 |
* {@code RuntimeException} or {@code Error} if the underlying |
617 |
|
|
* computation did so. |
618 |
jsr166 |
1.10 |
* |
619 |
dl |
1.1 |
* @return the computed result |
620 |
|
|
*/ |
621 |
|
|
public final V invoke() { |
622 |
dl |
1.74 |
if (doInvoke() != NORMAL) |
623 |
|
|
return reportResult(); |
624 |
|
|
else |
625 |
|
|
return getRawResult(); |
626 |
dl |
1.1 |
} |
627 |
|
|
|
628 |
|
|
/** |
629 |
dl |
1.34 |
* Forks the given tasks, returning when {@code isDone} holds for |
630 |
|
|
* each task or an (unchecked) exception is encountered, in which |
631 |
dl |
1.57 |
* case the exception is rethrown. If more than one task |
632 |
|
|
* encounters an exception, then this method throws any one of |
633 |
|
|
* these exceptions. If any task encounters an exception, the |
634 |
|
|
* other may be cancelled. However, the execution status of |
635 |
|
|
* individual tasks is not guaranteed upon exceptional return. The |
636 |
|
|
* status of each task may be obtained using {@link |
637 |
|
|
* #getException()} and related methods to check if they have been |
638 |
|
|
* cancelled, completed normally or exceptionally, or left |
639 |
|
|
* unprocessed. |
640 |
jsr166 |
1.31 |
* |
641 |
|
|
* <p>This method may be invoked only from within {@code |
642 |
dl |
1.69 |
* ForkJoinPool} computations (as may be determined using method |
643 |
jsr166 |
1.31 |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
644 |
|
|
* result in exceptions or errors, possibly including {@code |
645 |
|
|
* ClassCastException}. |
646 |
jsr166 |
1.10 |
* |
647 |
dl |
1.27 |
* @param t1 the first task |
648 |
|
|
* @param t2 the second task |
649 |
|
|
* @throws NullPointerException if any task is null |
650 |
dl |
1.1 |
*/ |
651 |
jsr166 |
1.31 |
public static void invokeAll(ForkJoinTask<?> t1, ForkJoinTask<?> t2) { |
652 |
dl |
1.2 |
t2.fork(); |
653 |
|
|
t1.invoke(); |
654 |
|
|
t2.join(); |
655 |
dl |
1.1 |
} |
656 |
|
|
|
657 |
|
|
/** |
658 |
dl |
1.27 |
* Forks the given tasks, returning when {@code isDone} holds for |
659 |
dl |
1.34 |
* each task or an (unchecked) exception is encountered, in which |
660 |
dl |
1.57 |
* case the exception is rethrown. If more than one task |
661 |
|
|
* encounters an exception, then this method throws any one of |
662 |
|
|
* these exceptions. If any task encounters an exception, others |
663 |
|
|
* may be cancelled. However, the execution status of individual |
664 |
|
|
* tasks is not guaranteed upon exceptional return. The status of |
665 |
|
|
* each task may be obtained using {@link #getException()} and |
666 |
|
|
* related methods to check if they have been cancelled, completed |
667 |
|
|
* normally or exceptionally, or left unprocessed. |
668 |
jsr166 |
1.31 |
* |
669 |
|
|
* <p>This method may be invoked only from within {@code |
670 |
dl |
1.69 |
* ForkJoinPool} computations (as may be determined using method |
671 |
jsr166 |
1.31 |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
672 |
|
|
* result in exceptions or errors, possibly including {@code |
673 |
|
|
* ClassCastException}. |
674 |
jsr166 |
1.14 |
* |
675 |
dl |
1.27 |
* @param tasks the tasks |
676 |
dl |
1.34 |
* @throws NullPointerException if any task is null |
677 |
dl |
1.1 |
*/ |
678 |
dl |
1.2 |
public static void invokeAll(ForkJoinTask<?>... tasks) { |
679 |
|
|
Throwable ex = null; |
680 |
|
|
int last = tasks.length - 1; |
681 |
|
|
for (int i = last; i >= 0; --i) { |
682 |
|
|
ForkJoinTask<?> t = tasks[i]; |
683 |
|
|
if (t == null) { |
684 |
|
|
if (ex == null) |
685 |
|
|
ex = new NullPointerException(); |
686 |
|
|
} |
687 |
|
|
else if (i != 0) |
688 |
|
|
t.fork(); |
689 |
dl |
1.74 |
else if (t.doInvoke() < NORMAL && ex == null) |
690 |
|
|
ex = t.getException(); |
691 |
dl |
1.2 |
} |
692 |
|
|
for (int i = 1; i <= last; ++i) { |
693 |
|
|
ForkJoinTask<?> t = tasks[i]; |
694 |
|
|
if (t != null) { |
695 |
|
|
if (ex != null) |
696 |
|
|
t.cancel(false); |
697 |
dl |
1.74 |
else if (t.doJoin() < NORMAL && ex == null) |
698 |
|
|
ex = t.getException(); |
699 |
dl |
1.2 |
} |
700 |
dl |
1.1 |
} |
701 |
dl |
1.2 |
if (ex != null) |
702 |
dl |
1.46 |
UNSAFE.throwException(ex); |
703 |
dl |
1.1 |
} |
704 |
|
|
|
705 |
|
|
/** |
706 |
dl |
1.32 |
* Forks all tasks in the specified collection, returning when |
707 |
dl |
1.34 |
* {@code isDone} holds for each task or an (unchecked) exception |
708 |
dl |
1.57 |
* is encountered, in which case the exception is rethrown. If |
709 |
|
|
* more than one task encounters an exception, then this method |
710 |
|
|
* throws any one of these exceptions. If any task encounters an |
711 |
|
|
* exception, others may be cancelled. However, the execution |
712 |
|
|
* status of individual tasks is not guaranteed upon exceptional |
713 |
|
|
* return. The status of each task may be obtained using {@link |
714 |
|
|
* #getException()} and related methods to check if they have been |
715 |
|
|
* cancelled, completed normally or exceptionally, or left |
716 |
|
|
* unprocessed. |
717 |
jsr166 |
1.31 |
* |
718 |
|
|
* <p>This method may be invoked only from within {@code |
719 |
dl |
1.69 |
* ForkJoinPool} computations (as may be determined using method |
720 |
jsr166 |
1.31 |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
721 |
|
|
* result in exceptions or errors, possibly including {@code |
722 |
|
|
* ClassCastException}. |
723 |
jsr166 |
1.10 |
* |
724 |
dl |
1.2 |
* @param tasks the collection of tasks |
725 |
dl |
1.19 |
* @return the tasks argument, to simplify usage |
726 |
jsr166 |
1.10 |
* @throws NullPointerException if tasks or any element are null |
727 |
dl |
1.1 |
*/ |
728 |
dl |
1.19 |
public static <T extends ForkJoinTask<?>> Collection<T> invokeAll(Collection<T> tasks) { |
729 |
dl |
1.32 |
if (!(tasks instanceof RandomAccess) || !(tasks instanceof List<?>)) { |
730 |
jsr166 |
1.14 |
invokeAll(tasks.toArray(new ForkJoinTask<?>[tasks.size()])); |
731 |
dl |
1.19 |
return tasks; |
732 |
dl |
1.2 |
} |
733 |
jsr166 |
1.15 |
@SuppressWarnings("unchecked") |
734 |
dl |
1.2 |
List<? extends ForkJoinTask<?>> ts = |
735 |
jsr166 |
1.14 |
(List<? extends ForkJoinTask<?>>) tasks; |
736 |
dl |
1.2 |
Throwable ex = null; |
737 |
|
|
int last = ts.size() - 1; |
738 |
|
|
for (int i = last; i >= 0; --i) { |
739 |
|
|
ForkJoinTask<?> t = ts.get(i); |
740 |
|
|
if (t == null) { |
741 |
|
|
if (ex == null) |
742 |
|
|
ex = new NullPointerException(); |
743 |
|
|
} |
744 |
|
|
else if (i != 0) |
745 |
|
|
t.fork(); |
746 |
dl |
1.74 |
else if (t.doInvoke() < NORMAL && ex == null) |
747 |
|
|
ex = t.getException(); |
748 |
dl |
1.2 |
} |
749 |
|
|
for (int i = 1; i <= last; ++i) { |
750 |
|
|
ForkJoinTask<?> t = ts.get(i); |
751 |
|
|
if (t != null) { |
752 |
|
|
if (ex != null) |
753 |
|
|
t.cancel(false); |
754 |
dl |
1.74 |
else if (t.doJoin() < NORMAL && ex == null) |
755 |
|
|
ex = t.getException(); |
756 |
dl |
1.2 |
} |
757 |
|
|
} |
758 |
|
|
if (ex != null) |
759 |
dl |
1.46 |
UNSAFE.throwException(ex); |
760 |
dl |
1.19 |
return tasks; |
761 |
dl |
1.1 |
} |
762 |
|
|
|
763 |
|
|
/** |
764 |
dl |
1.33 |
* Attempts to cancel execution of this task. This attempt will |
765 |
dl |
1.69 |
* fail if the task has already completed or could not be |
766 |
|
|
* cancelled for some other reason. If successful, and this task |
767 |
|
|
* has not started when {@code cancel} is called, execution of |
768 |
|
|
* this task is suppressed. After this method returns |
769 |
|
|
* successfully, unless there is an intervening call to {@link |
770 |
|
|
* #reinitialize}, subsequent calls to {@link #isCancelled}, |
771 |
|
|
* {@link #isDone}, and {@code cancel} will return {@code true} |
772 |
|
|
* and calls to {@link #join} and related methods will result in |
773 |
|
|
* {@code CancellationException}. |
774 |
dl |
1.1 |
* |
775 |
|
|
* <p>This method may be overridden in subclasses, but if so, must |
776 |
dl |
1.69 |
* still ensure that these properties hold. In particular, the |
777 |
|
|
* {@code cancel} method itself must not throw exceptions. |
778 |
dl |
1.1 |
* |
779 |
jsr166 |
1.28 |
* <p>This method is designed to be invoked by <em>other</em> |
780 |
dl |
1.1 |
* tasks. To terminate the current task, you can just return or |
781 |
|
|
* throw an unchecked exception from its computation method, or |
782 |
jsr166 |
1.24 |
* invoke {@link #completeExceptionally}. |
783 |
dl |
1.1 |
* |
784 |
dl |
1.69 |
* @param mayInterruptIfRunning this value has no effect in the |
785 |
|
|
* default implementation because interrupts are not used to |
786 |
|
|
* control cancellation. |
787 |
dl |
1.1 |
* |
788 |
jsr166 |
1.23 |
* @return {@code true} if this task is now cancelled |
789 |
dl |
1.1 |
*/ |
790 |
|
|
public boolean cancel(boolean mayInterruptIfRunning) { |
791 |
dl |
1.74 |
return setCompletion(CANCELLED) == CANCELLED; |
792 |
dl |
1.1 |
} |
793 |
|
|
|
794 |
dl |
1.46 |
/** |
795 |
dl |
1.52 |
* Cancels, ignoring any exceptions thrown by cancel. Used during |
796 |
|
|
* worker and pool shutdown. Cancel is spec'ed not to throw any |
797 |
|
|
* exceptions, but if it does anyway, we have no recourse during |
798 |
|
|
* shutdown, so guard against this case. |
799 |
dl |
1.46 |
*/ |
800 |
|
|
final void cancelIgnoringExceptions() { |
801 |
|
|
try { |
802 |
|
|
cancel(false); |
803 |
|
|
} catch (Throwable ignore) { |
804 |
|
|
} |
805 |
|
|
} |
806 |
|
|
|
807 |
dl |
1.34 |
public final boolean isDone() { |
808 |
|
|
return status < 0; |
809 |
|
|
} |
810 |
|
|
|
811 |
|
|
public final boolean isCancelled() { |
812 |
dl |
1.49 |
return status == CANCELLED; |
813 |
dl |
1.34 |
} |
814 |
|
|
|
815 |
|
|
/** |
816 |
jsr166 |
1.23 |
* Returns {@code true} if this task threw an exception or was cancelled. |
817 |
jsr166 |
1.10 |
* |
818 |
jsr166 |
1.23 |
* @return {@code true} if this task threw an exception or was cancelled |
819 |
dl |
1.3 |
*/ |
820 |
|
|
public final boolean isCompletedAbnormally() { |
821 |
dl |
1.49 |
return status < NORMAL; |
822 |
dl |
1.3 |
} |
823 |
|
|
|
824 |
|
|
/** |
825 |
dl |
1.34 |
* Returns {@code true} if this task completed without throwing an |
826 |
|
|
* exception and was not cancelled. |
827 |
|
|
* |
828 |
|
|
* @return {@code true} if this task completed without throwing an |
829 |
|
|
* exception and was not cancelled |
830 |
|
|
*/ |
831 |
|
|
public final boolean isCompletedNormally() { |
832 |
dl |
1.49 |
return status == NORMAL; |
833 |
dl |
1.34 |
} |
834 |
|
|
|
835 |
|
|
/** |
836 |
dl |
1.3 |
* Returns the exception thrown by the base computation, or a |
837 |
jsr166 |
1.29 |
* {@code CancellationException} if cancelled, or {@code null} if |
838 |
|
|
* none or if the method has not yet completed. |
839 |
jsr166 |
1.10 |
* |
840 |
jsr166 |
1.23 |
* @return the exception, or {@code null} if none |
841 |
dl |
1.3 |
*/ |
842 |
|
|
public final Throwable getException() { |
843 |
dl |
1.49 |
int s = status; |
844 |
jsr166 |
1.37 |
return ((s >= NORMAL) ? null : |
845 |
|
|
(s == CANCELLED) ? new CancellationException() : |
846 |
dl |
1.74 |
getThrowableException()); |
847 |
dl |
1.3 |
} |
848 |
|
|
|
849 |
|
|
/** |
850 |
dl |
1.1 |
* Completes this task abnormally, and if not already aborted or |
851 |
|
|
* cancelled, causes it to throw the given exception upon |
852 |
jsr166 |
1.8 |
* {@code join} and related operations. This method may be used |
853 |
dl |
1.1 |
* to induce exceptions in asynchronous tasks, or to force |
854 |
dl |
1.2 |
* completion of tasks that would not otherwise complete. Its use |
855 |
dl |
1.27 |
* in other situations is discouraged. This method is |
856 |
jsr166 |
1.8 |
* overridable, but overridden versions must invoke {@code super} |
857 |
dl |
1.2 |
* implementation to maintain guarantees. |
858 |
|
|
* |
859 |
jsr166 |
1.44 |
* @param ex the exception to throw. If this exception is not a |
860 |
|
|
* {@code RuntimeException} or {@code Error}, the actual exception |
861 |
|
|
* thrown will be a {@code RuntimeException} with cause {@code ex}. |
862 |
dl |
1.1 |
*/ |
863 |
|
|
public void completeExceptionally(Throwable ex) { |
864 |
dl |
1.48 |
setExceptionalCompletion((ex instanceof RuntimeException) || |
865 |
|
|
(ex instanceof Error) ? ex : |
866 |
|
|
new RuntimeException(ex)); |
867 |
dl |
1.1 |
} |
868 |
|
|
|
869 |
|
|
/** |
870 |
|
|
* Completes this task, and if not already aborted or cancelled, |
871 |
dl |
1.58 |
* returning the given value as the result of subsequent |
872 |
|
|
* invocations of {@code join} and related operations. This method |
873 |
|
|
* may be used to provide results for asynchronous tasks, or to |
874 |
|
|
* provide alternative handling for tasks that would not otherwise |
875 |
|
|
* complete normally. Its use in other situations is |
876 |
|
|
* discouraged. This method is overridable, but overridden |
877 |
|
|
* versions must invoke {@code super} implementation to maintain |
878 |
|
|
* guarantees. |
879 |
dl |
1.1 |
* |
880 |
jsr166 |
1.10 |
* @param value the result value for this task |
881 |
dl |
1.1 |
*/ |
882 |
|
|
public void complete(V value) { |
883 |
|
|
try { |
884 |
|
|
setRawResult(value); |
885 |
jsr166 |
1.14 |
} catch (Throwable rex) { |
886 |
dl |
1.48 |
setExceptionalCompletion(rex); |
887 |
dl |
1.1 |
return; |
888 |
|
|
} |
889 |
dl |
1.46 |
setCompletion(NORMAL); |
890 |
dl |
1.1 |
} |
891 |
|
|
|
892 |
dl |
1.62 |
/** |
893 |
dl |
1.63 |
* Waits if necessary for the computation to complete, and then |
894 |
|
|
* retrieves its result. |
895 |
|
|
* |
896 |
|
|
* @return the computed result |
897 |
|
|
* @throws CancellationException if the computation was cancelled |
898 |
|
|
* @throws ExecutionException if the computation threw an |
899 |
|
|
* exception |
900 |
|
|
* @throws InterruptedException if the current thread is not a |
901 |
|
|
* member of a ForkJoinPool and was interrupted while waiting |
902 |
dl |
1.62 |
*/ |
903 |
dl |
1.3 |
public final V get() throws InterruptedException, ExecutionException { |
904 |
dl |
1.74 |
int s = (Thread.currentThread() instanceof ForkJoinWorkerThread) ? |
905 |
|
|
doJoin() : externalInterruptibleAwaitDone(0L); |
906 |
|
|
Throwable ex; |
907 |
|
|
if (s == CANCELLED) |
908 |
|
|
throw new CancellationException(); |
909 |
|
|
if (s == EXCEPTIONAL && (ex = getThrowableException()) != null) |
910 |
|
|
throw new ExecutionException(ex); |
911 |
dl |
1.48 |
return getRawResult(); |
912 |
dl |
1.3 |
} |
913 |
dl |
1.47 |
|
914 |
dl |
1.62 |
/** |
915 |
dl |
1.63 |
* Waits if necessary for at most the given time for the computation |
916 |
|
|
* to complete, and then retrieves its result, if available. |
917 |
|
|
* |
918 |
|
|
* @param timeout the maximum time to wait |
919 |
|
|
* @param unit the time unit of the timeout argument |
920 |
|
|
* @return the computed result |
921 |
|
|
* @throws CancellationException if the computation was cancelled |
922 |
|
|
* @throws ExecutionException if the computation threw an |
923 |
|
|
* exception |
924 |
|
|
* @throws InterruptedException if the current thread is not a |
925 |
|
|
* member of a ForkJoinPool and was interrupted while waiting |
926 |
|
|
* @throws TimeoutException if the wait timed out |
927 |
dl |
1.62 |
*/ |
928 |
dl |
1.3 |
public final V get(long timeout, TimeUnit unit) |
929 |
|
|
throws InterruptedException, ExecutionException, TimeoutException { |
930 |
dl |
1.70 |
Thread t = Thread.currentThread(); |
931 |
dl |
1.74 |
if (t instanceof ForkJoinWorkerThread) { |
932 |
|
|
ForkJoinWorkerThread w = (ForkJoinWorkerThread) t; |
933 |
|
|
long nanos = unit.toNanos(timeout); |
934 |
|
|
if (status >= 0) { |
935 |
|
|
boolean completed = false; |
936 |
|
|
if (w.unpushTask(this)) { |
937 |
|
|
try { |
938 |
|
|
completed = exec(); |
939 |
|
|
} catch (Throwable rex) { |
940 |
|
|
setExceptionalCompletion(rex); |
941 |
|
|
} |
942 |
|
|
} |
943 |
|
|
if (completed) |
944 |
|
|
setCompletion(NORMAL); |
945 |
|
|
else if (status >= 0 && nanos > 0) |
946 |
|
|
w.pool.timedAwaitJoin(this, nanos); |
947 |
|
|
} |
948 |
|
|
} |
949 |
|
|
else { |
950 |
|
|
long millis = unit.toMillis(timeout); |
951 |
|
|
if (millis > 0) |
952 |
|
|
externalInterruptibleAwaitDone(millis); |
953 |
|
|
} |
954 |
dl |
1.70 |
int s = status; |
955 |
|
|
if (s != NORMAL) { |
956 |
dl |
1.48 |
Throwable ex; |
957 |
dl |
1.70 |
if (s == CANCELLED) |
958 |
dl |
1.48 |
throw new CancellationException(); |
959 |
dl |
1.74 |
if (s != EXCEPTIONAL) |
960 |
|
|
throw new TimeoutException(); |
961 |
|
|
if ((ex = getThrowableException()) != null) |
962 |
dl |
1.48 |
throw new ExecutionException(ex); |
963 |
|
|
} |
964 |
|
|
return getRawResult(); |
965 |
dl |
1.3 |
} |
966 |
|
|
|
967 |
dl |
1.1 |
/** |
968 |
dl |
1.53 |
* Joins this task, without returning its result or throwing its |
969 |
dl |
1.2 |
* exception. This method may be useful when processing |
970 |
|
|
* collections of tasks when some have been cancelled or otherwise |
971 |
|
|
* known to have aborted. |
972 |
|
|
*/ |
973 |
|
|
public final void quietlyJoin() { |
974 |
dl |
1.74 |
doJoin(); |
975 |
dl |
1.2 |
} |
976 |
|
|
|
977 |
|
|
/** |
978 |
|
|
* Commences performing this task and awaits its completion if |
979 |
dl |
1.53 |
* necessary, without returning its result or throwing its |
980 |
dl |
1.58 |
* exception. |
981 |
dl |
1.2 |
*/ |
982 |
|
|
public final void quietlyInvoke() { |
983 |
dl |
1.74 |
doInvoke(); |
984 |
dl |
1.2 |
} |
985 |
|
|
|
986 |
|
|
/** |
987 |
dl |
1.3 |
* Possibly executes tasks until the pool hosting the current task |
988 |
dl |
1.33 |
* {@link ForkJoinPool#isQuiescent is quiescent}. This method may |
989 |
|
|
* be of use in designs in which many tasks are forked, but none |
990 |
|
|
* are explicitly joined, instead executing them until all are |
991 |
|
|
* processed. |
992 |
jsr166 |
1.31 |
* |
993 |
|
|
* <p>This method may be invoked only from within {@code |
994 |
dl |
1.69 |
* ForkJoinPool} computations (as may be determined using method |
995 |
jsr166 |
1.31 |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
996 |
|
|
* result in exceptions or errors, possibly including {@code |
997 |
|
|
* ClassCastException}. |
998 |
dl |
1.3 |
*/ |
999 |
|
|
public static void helpQuiesce() { |
1000 |
jsr166 |
1.14 |
((ForkJoinWorkerThread) Thread.currentThread()) |
1001 |
|
|
.helpQuiescePool(); |
1002 |
dl |
1.3 |
} |
1003 |
|
|
|
1004 |
|
|
/** |
1005 |
dl |
1.1 |
* Resets the internal bookkeeping state of this task, allowing a |
1006 |
jsr166 |
1.8 |
* subsequent {@code fork}. This method allows repeated reuse of |
1007 |
dl |
1.1 |
* this task, but only if reuse occurs when this task has either |
1008 |
|
|
* never been forked, or has been forked, then completed and all |
1009 |
|
|
* outstanding joins of this task have also completed. Effects |
1010 |
dl |
1.30 |
* under any other usage conditions are not guaranteed. |
1011 |
|
|
* This method may be useful when executing |
1012 |
dl |
1.1 |
* pre-constructed trees of subtasks in loops. |
1013 |
jsr166 |
1.68 |
* |
1014 |
dl |
1.67 |
* <p>Upon completion of this method, {@code isDone()} reports |
1015 |
|
|
* {@code false}, and {@code getException()} reports {@code |
1016 |
|
|
* null}. However, the value returned by {@code getRawResult} is |
1017 |
|
|
* unaffected. To clear this value, you can invoke {@code |
1018 |
|
|
* setRawResult(null)}. |
1019 |
dl |
1.1 |
*/ |
1020 |
|
|
public void reinitialize() { |
1021 |
dl |
1.49 |
if (status == EXCEPTIONAL) |
1022 |
dl |
1.74 |
clearExceptionalCompletion(); |
1023 |
|
|
else |
1024 |
|
|
status = 0; |
1025 |
dl |
1.1 |
} |
1026 |
|
|
|
1027 |
|
|
/** |
1028 |
dl |
1.2 |
* Returns the pool hosting the current task execution, or null |
1029 |
dl |
1.13 |
* if this task is executing outside of any ForkJoinPool. |
1030 |
jsr166 |
1.10 |
* |
1031 |
dl |
1.27 |
* @see #inForkJoinPool |
1032 |
jsr166 |
1.23 |
* @return the pool, or {@code null} if none |
1033 |
dl |
1.1 |
*/ |
1034 |
dl |
1.2 |
public static ForkJoinPool getPool() { |
1035 |
|
|
Thread t = Thread.currentThread(); |
1036 |
jsr166 |
1.15 |
return (t instanceof ForkJoinWorkerThread) ? |
1037 |
|
|
((ForkJoinWorkerThread) t).pool : null; |
1038 |
dl |
1.1 |
} |
1039 |
|
|
|
1040 |
|
|
/** |
1041 |
dl |
1.71 |
* Returns {@code true} if the current thread is a {@link |
1042 |
|
|
* ForkJoinWorkerThread} executing as a ForkJoinPool computation. |
1043 |
jsr166 |
1.14 |
* |
1044 |
dl |
1.71 |
* @return {@code true} if the current thread is a {@link |
1045 |
|
|
* ForkJoinWorkerThread} executing as a ForkJoinPool computation, |
1046 |
|
|
* or {@code false} otherwise |
1047 |
dl |
1.13 |
*/ |
1048 |
|
|
public static boolean inForkJoinPool() { |
1049 |
|
|
return Thread.currentThread() instanceof ForkJoinWorkerThread; |
1050 |
|
|
} |
1051 |
|
|
|
1052 |
|
|
/** |
1053 |
dl |
1.2 |
* Tries to unschedule this task for execution. This method will |
1054 |
|
|
* typically succeed if this task is the most recently forked task |
1055 |
|
|
* by the current thread, and has not commenced executing in |
1056 |
|
|
* another thread. This method may be useful when arranging |
1057 |
|
|
* alternative local processing of tasks that could have been, but |
1058 |
jsr166 |
1.31 |
* were not, stolen. |
1059 |
|
|
* |
1060 |
|
|
* <p>This method may be invoked only from within {@code |
1061 |
dl |
1.69 |
* ForkJoinPool} computations (as may be determined using method |
1062 |
jsr166 |
1.31 |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
1063 |
|
|
* result in exceptions or errors, possibly including {@code |
1064 |
|
|
* ClassCastException}. |
1065 |
jsr166 |
1.10 |
* |
1066 |
jsr166 |
1.23 |
* @return {@code true} if unforked |
1067 |
dl |
1.1 |
*/ |
1068 |
dl |
1.2 |
public boolean tryUnfork() { |
1069 |
jsr166 |
1.14 |
return ((ForkJoinWorkerThread) Thread.currentThread()) |
1070 |
|
|
.unpushTask(this); |
1071 |
dl |
1.1 |
} |
1072 |
|
|
|
1073 |
|
|
/** |
1074 |
dl |
1.2 |
* Returns an estimate of the number of tasks that have been |
1075 |
|
|
* forked by the current worker thread but not yet executed. This |
1076 |
|
|
* value may be useful for heuristic decisions about whether to |
1077 |
jsr166 |
1.31 |
* fork other tasks. |
1078 |
|
|
* |
1079 |
|
|
* <p>This method may be invoked only from within {@code |
1080 |
dl |
1.69 |
* ForkJoinPool} computations (as may be determined using method |
1081 |
jsr166 |
1.31 |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
1082 |
|
|
* result in exceptions or errors, possibly including {@code |
1083 |
|
|
* ClassCastException}. |
1084 |
|
|
* |
1085 |
dl |
1.2 |
* @return the number of tasks |
1086 |
|
|
*/ |
1087 |
|
|
public static int getQueuedTaskCount() { |
1088 |
jsr166 |
1.14 |
return ((ForkJoinWorkerThread) Thread.currentThread()) |
1089 |
|
|
.getQueueSize(); |
1090 |
dl |
1.2 |
} |
1091 |
|
|
|
1092 |
|
|
/** |
1093 |
jsr166 |
1.10 |
* Returns an estimate of how many more locally queued tasks are |
1094 |
dl |
1.1 |
* held by the current worker thread than there are other worker |
1095 |
dl |
1.2 |
* threads that might steal them. This value may be useful for |
1096 |
|
|
* heuristic decisions about whether to fork other tasks. In many |
1097 |
|
|
* usages of ForkJoinTasks, at steady state, each worker should |
1098 |
|
|
* aim to maintain a small constant surplus (for example, 3) of |
1099 |
|
|
* tasks, and to process computations locally if this threshold is |
1100 |
jsr166 |
1.31 |
* exceeded. |
1101 |
|
|
* |
1102 |
|
|
* <p>This method may be invoked only from within {@code |
1103 |
dl |
1.69 |
* ForkJoinPool} computations (as may be determined using method |
1104 |
jsr166 |
1.31 |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
1105 |
|
|
* result in exceptions or errors, possibly including {@code |
1106 |
|
|
* ClassCastException}. |
1107 |
|
|
* |
1108 |
dl |
1.1 |
* @return the surplus number of tasks, which may be negative |
1109 |
|
|
*/ |
1110 |
dl |
1.2 |
public static int getSurplusQueuedTaskCount() { |
1111 |
jsr166 |
1.14 |
return ((ForkJoinWorkerThread) Thread.currentThread()) |
1112 |
dl |
1.1 |
.getEstimatedSurplusTaskCount(); |
1113 |
|
|
} |
1114 |
|
|
|
1115 |
dl |
1.2 |
// Extension methods |
1116 |
dl |
1.1 |
|
1117 |
|
|
/** |
1118 |
jsr166 |
1.23 |
* Returns the result that would be returned by {@link #join}, even |
1119 |
|
|
* if this task completed abnormally, or {@code null} if this task |
1120 |
|
|
* is not known to have been completed. This method is designed |
1121 |
|
|
* to aid debugging, as well as to support extensions. Its use in |
1122 |
|
|
* any other context is discouraged. |
1123 |
dl |
1.1 |
* |
1124 |
jsr166 |
1.23 |
* @return the result, or {@code null} if not completed |
1125 |
dl |
1.1 |
*/ |
1126 |
|
|
public abstract V getRawResult(); |
1127 |
|
|
|
1128 |
|
|
/** |
1129 |
|
|
* Forces the given value to be returned as a result. This method |
1130 |
|
|
* is designed to support extensions, and should not in general be |
1131 |
|
|
* called otherwise. |
1132 |
|
|
* |
1133 |
|
|
* @param value the value |
1134 |
|
|
*/ |
1135 |
|
|
protected abstract void setRawResult(V value); |
1136 |
|
|
|
1137 |
|
|
/** |
1138 |
|
|
* Immediately performs the base action of this task. This method |
1139 |
|
|
* is designed to support extensions, and should not in general be |
1140 |
|
|
* called otherwise. The return value controls whether this task |
1141 |
|
|
* is considered to be done normally. It may return false in |
1142 |
|
|
* asynchronous actions that require explicit invocations of |
1143 |
dl |
1.34 |
* {@link #complete} to become joinable. It may also throw an |
1144 |
|
|
* (unchecked) exception to indicate abnormal exit. |
1145 |
jsr166 |
1.10 |
* |
1146 |
jsr166 |
1.23 |
* @return {@code true} if completed normally |
1147 |
dl |
1.1 |
*/ |
1148 |
|
|
protected abstract boolean exec(); |
1149 |
|
|
|
1150 |
dl |
1.2 |
/** |
1151 |
dl |
1.25 |
* Returns, but does not unschedule or execute, a task queued by |
1152 |
|
|
* the current thread but not yet executed, if one is immediately |
1153 |
dl |
1.6 |
* available. There is no guarantee that this task will actually |
1154 |
dl |
1.25 |
* be polled or executed next. Conversely, this method may return |
1155 |
|
|
* null even if a task exists but cannot be accessed without |
1156 |
|
|
* contention with other threads. This method is designed |
1157 |
|
|
* primarily to support extensions, and is unlikely to be useful |
1158 |
jsr166 |
1.31 |
* otherwise. |
1159 |
|
|
* |
1160 |
|
|
* <p>This method may be invoked only from within {@code |
1161 |
dl |
1.69 |
* ForkJoinPool} computations (as may be determined using method |
1162 |
jsr166 |
1.31 |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
1163 |
|
|
* result in exceptions or errors, possibly including {@code |
1164 |
|
|
* ClassCastException}. |
1165 |
dl |
1.2 |
* |
1166 |
jsr166 |
1.23 |
* @return the next task, or {@code null} if none are available |
1167 |
dl |
1.2 |
*/ |
1168 |
|
|
protected static ForkJoinTask<?> peekNextLocalTask() { |
1169 |
jsr166 |
1.14 |
return ((ForkJoinWorkerThread) Thread.currentThread()) |
1170 |
|
|
.peekTask(); |
1171 |
dl |
1.2 |
} |
1172 |
|
|
|
1173 |
|
|
/** |
1174 |
dl |
1.6 |
* Unschedules and returns, without executing, the next task |
1175 |
|
|
* queued by the current thread but not yet executed. This method |
1176 |
|
|
* is designed primarily to support extensions, and is unlikely to |
1177 |
jsr166 |
1.31 |
* be useful otherwise. |
1178 |
|
|
* |
1179 |
|
|
* <p>This method may be invoked only from within {@code |
1180 |
dl |
1.69 |
* ForkJoinPool} computations (as may be determined using method |
1181 |
jsr166 |
1.31 |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
1182 |
|
|
* result in exceptions or errors, possibly including {@code |
1183 |
|
|
* ClassCastException}. |
1184 |
dl |
1.2 |
* |
1185 |
jsr166 |
1.23 |
* @return the next task, or {@code null} if none are available |
1186 |
dl |
1.2 |
*/ |
1187 |
|
|
protected static ForkJoinTask<?> pollNextLocalTask() { |
1188 |
jsr166 |
1.14 |
return ((ForkJoinWorkerThread) Thread.currentThread()) |
1189 |
|
|
.pollLocalTask(); |
1190 |
dl |
1.2 |
} |
1191 |
jsr166 |
1.7 |
|
1192 |
dl |
1.2 |
/** |
1193 |
dl |
1.6 |
* Unschedules and returns, without executing, the next task |
1194 |
|
|
* queued by the current thread but not yet executed, if one is |
1195 |
|
|
* available, or if not available, a task that was forked by some |
1196 |
|
|
* other thread, if available. Availability may be transient, so a |
1197 |
jsr166 |
1.9 |
* {@code null} result does not necessarily imply quiescence |
1198 |
dl |
1.6 |
* of the pool this task is operating in. This method is designed |
1199 |
|
|
* primarily to support extensions, and is unlikely to be useful |
1200 |
jsr166 |
1.31 |
* otherwise. |
1201 |
|
|
* |
1202 |
|
|
* <p>This method may be invoked only from within {@code |
1203 |
dl |
1.69 |
* ForkJoinPool} computations (as may be determined using method |
1204 |
jsr166 |
1.31 |
* {@link #inForkJoinPool}). Attempts to invoke in other contexts |
1205 |
|
|
* result in exceptions or errors, possibly including {@code |
1206 |
|
|
* ClassCastException}. |
1207 |
dl |
1.4 |
* |
1208 |
jsr166 |
1.23 |
* @return a task, or {@code null} if none are available |
1209 |
dl |
1.2 |
*/ |
1210 |
|
|
protected static ForkJoinTask<?> pollTask() { |
1211 |
jsr166 |
1.14 |
return ((ForkJoinWorkerThread) Thread.currentThread()) |
1212 |
|
|
.pollTask(); |
1213 |
dl |
1.2 |
} |
1214 |
|
|
|
1215 |
dl |
1.25 |
/** |
1216 |
|
|
* Adaptor for Runnables. This implements RunnableFuture |
1217 |
|
|
* to be compliant with AbstractExecutorService constraints |
1218 |
|
|
* when used in ForkJoinPool. |
1219 |
|
|
*/ |
1220 |
|
|
static final class AdaptedRunnable<T> extends ForkJoinTask<T> |
1221 |
|
|
implements RunnableFuture<T> { |
1222 |
|
|
final Runnable runnable; |
1223 |
|
|
final T resultOnCompletion; |
1224 |
|
|
T result; |
1225 |
|
|
AdaptedRunnable(Runnable runnable, T result) { |
1226 |
|
|
if (runnable == null) throw new NullPointerException(); |
1227 |
|
|
this.runnable = runnable; |
1228 |
|
|
this.resultOnCompletion = result; |
1229 |
|
|
} |
1230 |
|
|
public T getRawResult() { return result; } |
1231 |
|
|
public void setRawResult(T v) { result = v; } |
1232 |
|
|
public boolean exec() { |
1233 |
|
|
runnable.run(); |
1234 |
|
|
result = resultOnCompletion; |
1235 |
|
|
return true; |
1236 |
|
|
} |
1237 |
|
|
public void run() { invoke(); } |
1238 |
|
|
private static final long serialVersionUID = 5232453952276885070L; |
1239 |
|
|
} |
1240 |
|
|
|
1241 |
|
|
/** |
1242 |
|
|
* Adaptor for Callables |
1243 |
|
|
*/ |
1244 |
|
|
static final class AdaptedCallable<T> extends ForkJoinTask<T> |
1245 |
|
|
implements RunnableFuture<T> { |
1246 |
dl |
1.27 |
final Callable<? extends T> callable; |
1247 |
dl |
1.25 |
T result; |
1248 |
dl |
1.27 |
AdaptedCallable(Callable<? extends T> callable) { |
1249 |
dl |
1.25 |
if (callable == null) throw new NullPointerException(); |
1250 |
|
|
this.callable = callable; |
1251 |
|
|
} |
1252 |
|
|
public T getRawResult() { return result; } |
1253 |
|
|
public void setRawResult(T v) { result = v; } |
1254 |
|
|
public boolean exec() { |
1255 |
|
|
try { |
1256 |
|
|
result = callable.call(); |
1257 |
|
|
return true; |
1258 |
|
|
} catch (Error err) { |
1259 |
|
|
throw err; |
1260 |
|
|
} catch (RuntimeException rex) { |
1261 |
|
|
throw rex; |
1262 |
|
|
} catch (Exception ex) { |
1263 |
|
|
throw new RuntimeException(ex); |
1264 |
|
|
} |
1265 |
|
|
} |
1266 |
|
|
public void run() { invoke(); } |
1267 |
|
|
private static final long serialVersionUID = 2838392045355241008L; |
1268 |
|
|
} |
1269 |
dl |
1.18 |
|
1270 |
|
|
/** |
1271 |
jsr166 |
1.31 |
* Returns a new {@code ForkJoinTask} that performs the {@code run} |
1272 |
|
|
* method of the given {@code Runnable} as its action, and returns |
1273 |
|
|
* a null result upon {@link #join}. |
1274 |
dl |
1.18 |
* |
1275 |
|
|
* @param runnable the runnable action |
1276 |
|
|
* @return the task |
1277 |
|
|
*/ |
1278 |
dl |
1.27 |
public static ForkJoinTask<?> adapt(Runnable runnable) { |
1279 |
dl |
1.25 |
return new AdaptedRunnable<Void>(runnable, null); |
1280 |
dl |
1.18 |
} |
1281 |
|
|
|
1282 |
|
|
/** |
1283 |
jsr166 |
1.31 |
* Returns a new {@code ForkJoinTask} that performs the {@code run} |
1284 |
|
|
* method of the given {@code Runnable} as its action, and returns |
1285 |
|
|
* the given result upon {@link #join}. |
1286 |
dl |
1.18 |
* |
1287 |
|
|
* @param runnable the runnable action |
1288 |
|
|
* @param result the result upon completion |
1289 |
|
|
* @return the task |
1290 |
|
|
*/ |
1291 |
|
|
public static <T> ForkJoinTask<T> adapt(Runnable runnable, T result) { |
1292 |
dl |
1.25 |
return new AdaptedRunnable<T>(runnable, result); |
1293 |
dl |
1.18 |
} |
1294 |
|
|
|
1295 |
|
|
/** |
1296 |
jsr166 |
1.31 |
* Returns a new {@code ForkJoinTask} that performs the {@code call} |
1297 |
|
|
* method of the given {@code Callable} as its action, and returns |
1298 |
|
|
* its result upon {@link #join}, translating any checked exceptions |
1299 |
|
|
* encountered into {@code RuntimeException}. |
1300 |
dl |
1.18 |
* |
1301 |
|
|
* @param callable the callable action |
1302 |
|
|
* @return the task |
1303 |
|
|
*/ |
1304 |
dl |
1.27 |
public static <T> ForkJoinTask<T> adapt(Callable<? extends T> callable) { |
1305 |
dl |
1.25 |
return new AdaptedCallable<T>(callable); |
1306 |
dl |
1.18 |
} |
1307 |
|
|
|
1308 |
dl |
1.1 |
// Serialization support |
1309 |
|
|
|
1310 |
|
|
private static final long serialVersionUID = -7721805057305804111L; |
1311 |
|
|
|
1312 |
|
|
/** |
1313 |
jsr166 |
1.56 |
* Saves the state to a stream (that is, serializes it). |
1314 |
dl |
1.1 |
* |
1315 |
|
|
* @serialData the current run status and the exception thrown |
1316 |
jsr166 |
1.23 |
* during execution, or {@code null} if none |
1317 |
dl |
1.1 |
* @param s the stream |
1318 |
|
|
*/ |
1319 |
|
|
private void writeObject(java.io.ObjectOutputStream s) |
1320 |
|
|
throws java.io.IOException { |
1321 |
|
|
s.defaultWriteObject(); |
1322 |
|
|
s.writeObject(getException()); |
1323 |
|
|
} |
1324 |
|
|
|
1325 |
|
|
/** |
1326 |
jsr166 |
1.56 |
* Reconstitutes the instance from a stream (that is, deserializes it). |
1327 |
jsr166 |
1.10 |
* |
1328 |
dl |
1.1 |
* @param s the stream |
1329 |
|
|
*/ |
1330 |
|
|
private void readObject(java.io.ObjectInputStream s) |
1331 |
|
|
throws java.io.IOException, ClassNotFoundException { |
1332 |
|
|
s.defaultReadObject(); |
1333 |
|
|
Object ex = s.readObject(); |
1334 |
|
|
if (ex != null) |
1335 |
dl |
1.74 |
setExceptionalCompletion((Throwable)ex); |
1336 |
dl |
1.1 |
} |
1337 |
|
|
|
1338 |
jsr166 |
1.22 |
// Unsafe mechanics |
1339 |
dl |
1.74 |
private static final sun.misc.Unsafe UNSAFE; |
1340 |
|
|
private static final long statusOffset; |
1341 |
|
|
static { |
1342 |
|
|
exceptionTableLock = new ReentrantLock(); |
1343 |
|
|
exceptionTableRefQueue = new ReferenceQueue<Object>(); |
1344 |
|
|
exceptionTable = new ExceptionNode[EXCEPTION_MAP_CAPACITY]; |
1345 |
jsr166 |
1.22 |
try { |
1346 |
dl |
1.74 |
UNSAFE = getUnsafe(); |
1347 |
|
|
statusOffset = UNSAFE.objectFieldOffset |
1348 |
|
|
(ForkJoinTask.class.getDeclaredField("status")); |
1349 |
|
|
} catch (Exception e) { |
1350 |
|
|
throw new Error(e); |
1351 |
jsr166 |
1.22 |
} |
1352 |
|
|
} |
1353 |
|
|
|
1354 |
|
|
/** |
1355 |
|
|
* Returns a sun.misc.Unsafe. Suitable for use in a 3rd party package. |
1356 |
|
|
* Replace with a simple call to Unsafe.getUnsafe when integrating |
1357 |
|
|
* into a jdk. |
1358 |
|
|
* |
1359 |
|
|
* @return a sun.misc.Unsafe |
1360 |
|
|
*/ |
1361 |
jsr166 |
1.16 |
private static sun.misc.Unsafe getUnsafe() { |
1362 |
jsr166 |
1.5 |
try { |
1363 |
jsr166 |
1.16 |
return sun.misc.Unsafe.getUnsafe(); |
1364 |
jsr166 |
1.5 |
} catch (SecurityException se) { |
1365 |
|
|
try { |
1366 |
|
|
return java.security.AccessController.doPrivileged |
1367 |
jsr166 |
1.22 |
(new java.security |
1368 |
|
|
.PrivilegedExceptionAction<sun.misc.Unsafe>() { |
1369 |
jsr166 |
1.16 |
public sun.misc.Unsafe run() throws Exception { |
1370 |
jsr166 |
1.22 |
java.lang.reflect.Field f = sun.misc |
1371 |
|
|
.Unsafe.class.getDeclaredField("theUnsafe"); |
1372 |
|
|
f.setAccessible(true); |
1373 |
|
|
return (sun.misc.Unsafe) f.get(null); |
1374 |
jsr166 |
1.5 |
}}); |
1375 |
|
|
} catch (java.security.PrivilegedActionException e) { |
1376 |
jsr166 |
1.16 |
throw new RuntimeException("Could not initialize intrinsics", |
1377 |
|
|
e.getCause()); |
1378 |
jsr166 |
1.5 |
} |
1379 |
|
|
} |
1380 |
|
|
} |
1381 |
dl |
1.1 |
} |