ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/jsr166y/ForkJoinTask.java
(Generate patch)

Comparing jsr166/src/jsr166y/ForkJoinTask.java (file contents):
Revision 1.41 by dl, Wed Aug 5 23:37:32 2009 UTC vs.
Revision 1.56 by jsr166, Sat Sep 4 00:21:31 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines