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.67 by dl, Sun Nov 21 14:43:27 2010 UTC vs.
Revision 1.79 by jsr166, Fri Jun 10 18:10:53 2011 UTC

# Line 1 | Line 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
4 > * http://creativecommons.org/publicdomain/zero/1.0/
5   */
6  
7   package jsr166y;
8  
9   import java.io.Serializable;
10   import java.util.Collection;
11 import java.util.Collections;
11   import java.util.List;
12   import java.util.RandomAccess;
13 < import java.util.Map;
14 < import java.util.WeakHashMap;
13 > import java.lang.ref.WeakReference;
14 > import java.lang.ref.ReferenceQueue;
15   import java.util.concurrent.Callable;
16   import java.util.concurrent.CancellationException;
17   import java.util.concurrent.ExecutionException;
19 import java.util.concurrent.Executor;
20 import java.util.concurrent.ExecutorService;
18   import java.util.concurrent.Future;
19   import java.util.concurrent.RejectedExecutionException;
20   import java.util.concurrent.RunnableFuture;
21   import java.util.concurrent.TimeUnit;
22   import java.util.concurrent.TimeoutException;
23 + import java.util.concurrent.locks.ReentrantLock;
24 + import java.lang.reflect.Constructor;
25  
26   /**
27   * Abstract base class for tasks that run within a {@link ForkJoinPool}.
# Line 66 | Line 65 | import java.util.concurrent.TimeoutExcep
65   * rethrown to callers attempting to join them. These exceptions may
66   * additionally include {@link RejectedExecutionException} stemming
67   * from internal resource exhaustion, such as failure to allocate
68 < * internal task queues.
68 > * internal task queues. Rethrown exceptions behave in the same way as
69 > * regular exceptions, but, when possible, contain stack traces (as
70 > * displayed for example using {@code ex.printStackTrace()}) of both
71 > * the thread that initiated the computation as well as the thread
72 > * actually encountering the exception; minimally only the latter.
73   *
74   * <p>The primary method for awaiting completion and extracting
75   * results of a task is {@link #join}, but there are several variants:
# Line 110 | Line 113 | import java.util.concurrent.TimeoutExcep
113   * result in exceptions or errors, possibly including
114   * {@code ClassCastException}.
115   *
116 + * <p>Method {@link #join} and its variants are appropriate for use
117 + * only when completion dependencies are acyclic; that is, the
118 + * parallel computation can be described as a directed acyclic graph
119 + * (DAG). Otherwise, executions may encounter a form of deadlock as
120 + * tasks cyclically wait for each other.  However, this framework
121 + * supports other methods and techniques (for example the use of
122 + * {@link Phaser}, {@link #helpQuiesce}, and {@link #complete}) that
123 + * may be of use in constructing custom subclasses for problems that
124 + * are not statically structured as DAGs.
125 + *
126   * <p>Most base support methods are {@code final}, to prevent
127   * overriding of implementations that are intrinsically tied to the
128   * underlying lightweight task scheduling framework.  Developers
# Line 124 | Line 137 | import java.util.concurrent.TimeoutExcep
137   * computation. Large tasks should be split into smaller subtasks,
138   * usually via recursive decomposition. As a very rough rule of thumb,
139   * a task should perform more than 100 and less than 10000 basic
140 < * computational steps. If tasks are too big, then parallelism cannot
141 < * improve throughput. If too small, then memory and internal task
142 < * maintenance overhead may overwhelm processing.
140 > * computational steps, and should avoid indefinite looping. If tasks
141 > * are too big, then parallelism cannot improve throughput. If too
142 > * small, then memory and internal task maintenance overhead may
143 > * overwhelm processing.
144   *
145   * <p>This class provides {@code adapt} methods for {@link Runnable}
146   * and {@link Callable}, that may be of use when mixing execution of
# Line 152 | Line 166 | public abstract class ForkJoinTask<V> im
166       * status maintenance (2) execution and awaiting completion (3)
167       * user-level methods that additionally report results. This is
168       * sometimes hard to see because this file orders exported methods
169 <     * in a way that flows well in javadocs. In particular, most
156 <     * join mechanics are in method quietlyJoin, below.
169 >     * in a way that flows well in javadocs.
170       */
171  
172      /*
# Line 175 | Line 188 | public abstract class ForkJoinTask<V> im
188  
189      /** The run status of this task */
190      volatile int status; // accessed directly by pool and workers
178
191      private static final int NORMAL      = -1;
192      private static final int CANCELLED   = -2;
193      private static final int EXCEPTIONAL = -3;
194      private static final int SIGNAL      =  1;
195  
196      /**
185     * Table of exceptions thrown by tasks, to enable reporting by
186     * callers. Because exceptions are rare, we don't directly keep
187     * them with task objects, but instead use a weak ref table.  Note
188     * that cancellation exceptions don't appear in the table, but are
189     * instead recorded as status values.
190     * TODO: Use ConcurrentReferenceHashMap
191     */
192    static final Map<ForkJoinTask<?>, Throwable> exceptionMap =
193        Collections.synchronizedMap
194        (new WeakHashMap<ForkJoinTask<?>, Throwable>());
195
196    // Maintaining completion status
197
198    /**
197       * Marks completion and wakes up threads waiting to join this task,
198       * also clearing signal request bits.
199       *
200       * @param completion one of NORMAL, CANCELLED, EXCEPTIONAL
201 +     * @return completion status on exit
202       */
203 <    private void setCompletion(int completion) {
204 <        int s;
205 <        while ((s = status) >= 0) {
203 >    private int setCompletion(int completion) {
204 >        for (int s;;) {
205 >            if ((s = status) < 0)
206 >                return s;
207              if (UNSAFE.compareAndSwapInt(this, statusOffset, s, completion)) {
208                  if (s != 0)
209                      synchronized (this) { notifyAll(); }
210 <                break;
210 >                return completion;
211              }
212          }
213      }
214  
215      /**
216 <     * Records exception and sets exceptional completion.
216 >     * Tries to block a worker thread until completed or timed out.
217 >     * Uses Object.wait time argument conventions.
218 >     * May fail on contention or interrupt.
219       *
220 <     * @return status on exit
220 >     * @param millis if > 0, wait time.
221       */
222 <    private void setExceptionalCompletion(Throwable rex) {
223 <        exceptionMap.put(this, rex);
224 <        setCompletion(EXCEPTIONAL);
225 <    }
226 <
227 <    /**
228 <     * Blocks a worker thread until completion. Called only by
227 <     * pool. Currently unused -- pool-based waits use timeout
228 <     * version below.
229 <     */
230 <    final void internalAwaitDone() {
231 <        int s;         // the odd construction reduces lock bias effects
232 <        while ((s = status) >= 0) {
233 <            try {
222 >    final void tryAwaitDone(long millis) {
223 >        int s;
224 >        try {
225 >            if (((s = status) > 0 ||
226 >                 (s == 0 &&
227 >                  UNSAFE.compareAndSwapInt(this, statusOffset, 0, SIGNAL))) &&
228 >                status > 0) {
229                  synchronized (this) {
230 <                    if (UNSAFE.compareAndSwapInt(this, statusOffset, s,SIGNAL))
231 <                        wait();
230 >                    if (status > 0)
231 >                        wait(millis);
232                  }
238            } catch (InterruptedException ie) {
239                cancelIfTerminating();
233              }
234 +        } catch (InterruptedException ie) {
235 +            // caller must check termination
236          }
237      }
238  
239      /**
240 <     * Blocks a worker thread until completed or timed out.  Called
241 <     * only by pool.
247 <     *
248 <     * @return status on exit
240 >     * Blocks a non-worker-thread until completion.
241 >     * @return status upon completion
242       */
243 <    final int internalAwaitDone(long millis, int nanos) {
243 >    private int externalAwaitDone() {
244          int s;
245          if ((s = status) >= 0) {
246 <            try {
247 <                synchronized (this) {
248 <                    if (UNSAFE.compareAndSwapInt(this, statusOffset, s,SIGNAL))
249 <                        wait(millis, nanos);
246 >            boolean interrupted = false;
247 >            synchronized (this) {
248 >                while ((s = status) >= 0) {
249 >                    if (s == 0)
250 >                        UNSAFE.compareAndSwapInt(this, statusOffset,
251 >                                                 0, SIGNAL);
252 >                    else {
253 >                        try {
254 >                            wait();
255 >                        } catch (InterruptedException ie) {
256 >                            interrupted = true;
257 >                        }
258 >                    }
259                  }
258            } catch (InterruptedException ie) {
259                cancelIfTerminating();
260              }
261 <            s = status;
261 >            if (interrupted)
262 >                Thread.currentThread().interrupt();
263          }
264          return s;
265      }
266  
267      /**
268 <     * Blocks a non-worker-thread until completion.
268 >     * Blocks a non-worker-thread until completion or interruption or timeout.
269       */
270 <    private void externalAwaitDone() {
270 >    private int externalInterruptibleAwaitDone(long millis)
271 >        throws InterruptedException {
272          int s;
273 <        while ((s = status) >= 0) {
273 >        if (Thread.interrupted())
274 >            throw new InterruptedException();
275 >        if ((s = status) >= 0) {
276              synchronized (this) {
277 <                if (UNSAFE.compareAndSwapInt(this, statusOffset, s, SIGNAL)) {
278 <                    boolean interrupted = false;
279 <                    while (status >= 0) {
280 <                        try {
281 <                            wait();
282 <                        } catch (InterruptedException ie) {
283 <                            interrupted = true;
284 <                        }
277 >                while ((s = status) >= 0) {
278 >                    if (s == 0)
279 >                        UNSAFE.compareAndSwapInt(this, statusOffset,
280 >                                                 0, SIGNAL);
281 >                    else {
282 >                        wait(millis);
283 >                        if (millis > 0L)
284 >                            break;
285                      }
282                    if (interrupted)
283                        Thread.currentThread().interrupt();
284                    break;
286                  }
287              }
288          }
289 +        return s;
290      }
291  
292      /**
293 <     * Unless done, calls exec and records status if completed, but
294 <     * doesn't wait for completion otherwise. Primary execution method
295 <     * for ForkJoinWorkerThread.
293 >     * Primary execution method for stolen tasks. Unless done, calls
294 >     * exec and records status if completed, but doesn't wait for
295 >     * completion otherwise.
296       */
297 <    final void quietlyExec() {
298 <        try {
299 <            if (status < 0 || !exec())
297 >    final void doExec() {
298 >        if (status >= 0) {
299 >            boolean completed;
300 >            try {
301 >                completed = exec();
302 >            } catch (Throwable rex) {
303 >                setExceptionalCompletion(rex);
304                  return;
305 +            }
306 +            if (completed)
307 +                setCompletion(NORMAL); // must be outside try block
308 +        }
309 +    }
310 +
311 +    /**
312 +     * Primary mechanics for join, get, quietlyJoin.
313 +     * @return status upon completion
314 +     */
315 +    private int doJoin() {
316 +        Thread t; ForkJoinWorkerThread w; int s; boolean completed;
317 +        if ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) {
318 +            if ((s = status) < 0)
319 +                return s;
320 +            if ((w = (ForkJoinWorkerThread)t).unpushTask(this)) {
321 +                try {
322 +                    completed = exec();
323 +                } catch (Throwable rex) {
324 +                    return setExceptionalCompletion(rex);
325 +                }
326 +                if (completed)
327 +                    return setCompletion(NORMAL);
328 +            }
329 +            return w.joinTask(this);
330 +        }
331 +        else
332 +            return externalAwaitDone();
333 +    }
334 +
335 +    /**
336 +     * Primary mechanics for invoke, quietlyInvoke.
337 +     * @return status upon completion
338 +     */
339 +    private int doInvoke() {
340 +        int s; boolean completed;
341 +        if ((s = status) < 0)
342 +            return s;
343 +        try {
344 +            completed = exec();
345          } catch (Throwable rex) {
346 <            setExceptionalCompletion(rex);
347 <            return;
346 >            return setExceptionalCompletion(rex);
347 >        }
348 >        if (completed)
349 >            return setCompletion(NORMAL);
350 >        else
351 >            return doJoin();
352 >    }
353 >
354 >    // Exception table support
355 >
356 >    /**
357 >     * Table of exceptions thrown by tasks, to enable reporting by
358 >     * callers. Because exceptions are rare, we don't directly keep
359 >     * them with task objects, but instead use a weak ref table.  Note
360 >     * that cancellation exceptions don't appear in the table, but are
361 >     * instead recorded as status values.
362 >     *
363 >     * Note: These statics are initialized below in static block.
364 >     */
365 >    private static final ExceptionNode[] exceptionTable;
366 >    private static final ReentrantLock exceptionTableLock;
367 >    private static final ReferenceQueue<Object> exceptionTableRefQueue;
368 >
369 >    /**
370 >     * Fixed capacity for exceptionTable.
371 >     */
372 >    private static final int EXCEPTION_MAP_CAPACITY = 32;
373 >
374 >    /**
375 >     * Key-value nodes for exception table.  The chained hash table
376 >     * uses identity comparisons, full locking, and weak references
377 >     * for keys. The table has a fixed capacity because it only
378 >     * maintains task exceptions long enough for joiners to access
379 >     * them, so should never become very large for sustained
380 >     * periods. However, since we do not know when the last joiner
381 >     * completes, we must use weak references and expunge them. We do
382 >     * so on each operation (hence full locking). Also, some thread in
383 >     * any ForkJoinPool will call helpExpungeStaleExceptions when its
384 >     * pool becomes isQuiescent.
385 >     */
386 >    static final class ExceptionNode extends WeakReference<ForkJoinTask<?>>{
387 >        final Throwable ex;
388 >        ExceptionNode next;
389 >        final long thrower;  // use id not ref to avoid weak cycles
390 >        ExceptionNode(ForkJoinTask<?> task, Throwable ex, ExceptionNode next) {
391 >            super(task, exceptionTableRefQueue);
392 >            this.ex = ex;
393 >            this.next = next;
394 >            this.thrower = Thread.currentThread().getId();
395 >        }
396 >    }
397 >
398 >    /**
399 >     * Records exception and sets exceptional completion.
400 >     *
401 >     * @return status on exit
402 >     */
403 >    private int setExceptionalCompletion(Throwable ex) {
404 >        int h = System.identityHashCode(this);
405 >        final ReentrantLock lock = exceptionTableLock;
406 >        lock.lock();
407 >        try {
408 >            expungeStaleExceptions();
409 >            ExceptionNode[] t = exceptionTable;
410 >            int i = h & (t.length - 1);
411 >            for (ExceptionNode e = t[i]; ; e = e.next) {
412 >                if (e == null) {
413 >                    t[i] = new ExceptionNode(this, ex, t[i]);
414 >                    break;
415 >                }
416 >                if (e.get() == this) // already present
417 >                    break;
418 >            }
419 >        } finally {
420 >            lock.unlock();
421          }
422 <        setCompletion(NORMAL); // must be outside try block
422 >        return setCompletion(EXCEPTIONAL);
423 >    }
424 >
425 >    /**
426 >     * Removes exception node and clears status
427 >     */
428 >    private void clearExceptionalCompletion() {
429 >        int h = System.identityHashCode(this);
430 >        final ReentrantLock lock = exceptionTableLock;
431 >        lock.lock();
432 >        try {
433 >            ExceptionNode[] t = exceptionTable;
434 >            int i = h & (t.length - 1);
435 >            ExceptionNode e = t[i];
436 >            ExceptionNode pred = null;
437 >            while (e != null) {
438 >                ExceptionNode next = e.next;
439 >                if (e.get() == this) {
440 >                    if (pred == null)
441 >                        t[i] = next;
442 >                    else
443 >                        pred.next = next;
444 >                    break;
445 >                }
446 >                pred = e;
447 >                e = next;
448 >            }
449 >            expungeStaleExceptions();
450 >            status = 0;
451 >        } finally {
452 >            lock.unlock();
453 >        }
454 >    }
455 >
456 >    /**
457 >     * Returns a rethrowable exception for the given task, if
458 >     * available. To provide accurate stack traces, if the exception
459 >     * was not thrown by the current thread, we try to create a new
460 >     * exception of the same type as the one thrown, but with the
461 >     * recorded exception as its cause. If there is no such
462 >     * constructor, we instead try to use a no-arg constructor,
463 >     * followed by initCause, to the same effect. If none of these
464 >     * apply, or any fail due to other exceptions, we return the
465 >     * recorded exception, which is still correct, although it may
466 >     * contain a misleading stack trace.
467 >     *
468 >     * @return the exception, or null if none
469 >     */
470 >    private Throwable getThrowableException() {
471 >        if (status != EXCEPTIONAL)
472 >            return null;
473 >        int h = System.identityHashCode(this);
474 >        ExceptionNode e;
475 >        final ReentrantLock lock = exceptionTableLock;
476 >        lock.lock();
477 >        try {
478 >            expungeStaleExceptions();
479 >            ExceptionNode[] t = exceptionTable;
480 >            e = t[h & (t.length - 1)];
481 >            while (e != null && e.get() != this)
482 >                e = e.next;
483 >        } finally {
484 >            lock.unlock();
485 >        }
486 >        Throwable ex;
487 >        if (e == null || (ex = e.ex) == null)
488 >            return null;
489 >        if (e.thrower != Thread.currentThread().getId()) {
490 >            Class<? extends Throwable> ec = ex.getClass();
491 >            try {
492 >                Constructor<?> noArgCtor = null;
493 >                Constructor<?>[] cs = ec.getConstructors();// public ctors only
494 >                for (int i = 0; i < cs.length; ++i) {
495 >                    Constructor<?> c = cs[i];
496 >                    Class<?>[] ps = c.getParameterTypes();
497 >                    if (ps.length == 0)
498 >                        noArgCtor = c;
499 >                    else if (ps.length == 1 && ps[0] == Throwable.class)
500 >                        return (Throwable)(c.newInstance(ex));
501 >                }
502 >                if (noArgCtor != null) {
503 >                    Throwable wx = (Throwable)(noArgCtor.newInstance());
504 >                    wx.initCause(ex);
505 >                    return wx;
506 >                }
507 >            } catch (Exception ignore) {
508 >            }
509 >        }
510 >        return ex;
511 >    }
512 >
513 >    /**
514 >     * Poll stale refs and remove them. Call only while holding lock.
515 >     */
516 >    private static void expungeStaleExceptions() {
517 >        for (Object x; (x = exceptionTableRefQueue.poll()) != null;) {
518 >            if (x instanceof ExceptionNode) {
519 >                ForkJoinTask<?> key = ((ExceptionNode)x).get();
520 >                ExceptionNode[] t = exceptionTable;
521 >                int i = System.identityHashCode(key) & (t.length - 1);
522 >                ExceptionNode e = t[i];
523 >                ExceptionNode pred = null;
524 >                while (e != null) {
525 >                    ExceptionNode next = e.next;
526 >                    if (e == x) {
527 >                        if (pred == null)
528 >                            t[i] = next;
529 >                        else
530 >                            pred.next = next;
531 >                        break;
532 >                    }
533 >                    pred = e;
534 >                    e = next;
535 >                }
536 >            }
537 >        }
538 >    }
539 >
540 >    /**
541 >     * If lock is available, poll stale refs and remove them.
542 >     * Called from ForkJoinPool when pools become quiescent.
543 >     */
544 >    static final void helpExpungeStaleExceptions() {
545 >        final ReentrantLock lock = exceptionTableLock;
546 >        if (lock.tryLock()) {
547 >            try {
548 >                expungeStaleExceptions();
549 >            } finally {
550 >                lock.unlock();
551 >            }
552 >        }
553 >    }
554 >
555 >    /**
556 >     * Report the result of invoke or join; called only upon
557 >     * non-normal return of internal versions.
558 >     */
559 >    private V reportResult() {
560 >        int s; Throwable ex;
561 >        if ((s = status) == CANCELLED)
562 >            throw new CancellationException();
563 >        if (s == EXCEPTIONAL && (ex = getThrowableException()) != null)
564 >            UNSAFE.throwException(ex);
565 >        return getRawResult();
566      }
567  
568      // public methods
# Line 316 | Line 578 | public abstract class ForkJoinTask<V> im
578       * #isDone} returning {@code true}.
579       *
580       * <p>This method may be invoked only from within {@code
581 <     * ForkJoinTask} computations (as may be determined using method
581 >     * ForkJoinPool} computations (as may be determined using method
582       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
583       * result in exceptions or errors, possibly including {@code
584       * ClassCastException}.
# Line 330 | Line 592 | public abstract class ForkJoinTask<V> im
592      }
593  
594      /**
595 <     * Returns the result of the computation when it {@link #isDone is done}.
596 <     * This method differs from {@link #get()} in that
595 >     * Returns the result of the computation when it {@link #isDone is
596 >     * done}.  This method differs from {@link #get()} in that
597       * abnormal completion results in {@code RuntimeException} or
598 <     * {@code Error}, not {@code ExecutionException}.
598 >     * {@code Error}, not {@code ExecutionException}, and that
599 >     * interrupts of the calling thread do <em>not</em> cause the
600 >     * method to abruptly return by throwing {@code
601 >     * InterruptedException}.
602       *
603       * @return the computed result
604       */
605      public final V join() {
606 <        quietlyJoin();
607 <        Throwable ex;
608 <        if (status < NORMAL && (ex = getException()) != null)
609 <            UNSAFE.throwException(ex);
345 <        return getRawResult();
606 >        if (doJoin() != NORMAL)
607 >            return reportResult();
608 >        else
609 >            return getRawResult();
610      }
611  
612      /**
# Line 354 | Line 618 | public abstract class ForkJoinTask<V> im
618       * @return the computed result
619       */
620      public final V invoke() {
621 <        quietlyInvoke();
622 <        Throwable ex;
623 <        if (status < NORMAL && (ex = getException()) != null)
624 <            UNSAFE.throwException(ex);
361 <        return getRawResult();
621 >        if (doInvoke() != NORMAL)
622 >            return reportResult();
623 >        else
624 >            return getRawResult();
625      }
626  
627      /**
# Line 375 | Line 638 | public abstract class ForkJoinTask<V> im
638       * unprocessed.
639       *
640       * <p>This method may be invoked only from within {@code
641 <     * ForkJoinTask} computations (as may be determined using method
641 >     * ForkJoinPool} computations (as may be determined using method
642       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
643       * result in exceptions or errors, possibly including {@code
644       * ClassCastException}.
# Line 403 | Line 666 | public abstract class ForkJoinTask<V> im
666       * normally or exceptionally, or left unprocessed.
667       *
668       * <p>This method may be invoked only from within {@code
669 <     * ForkJoinTask} computations (as may be determined using method
669 >     * ForkJoinPool} computations (as may be determined using method
670       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
671       * result in exceptions or errors, possibly including {@code
672       * ClassCastException}.
# Line 422 | Line 685 | public abstract class ForkJoinTask<V> im
685              }
686              else if (i != 0)
687                  t.fork();
688 <            else {
689 <                t.quietlyInvoke();
427 <                if (ex == null && t.status < NORMAL)
428 <                    ex = t.getException();
429 <            }
688 >            else if (t.doInvoke() < NORMAL && ex == null)
689 >                ex = t.getException();
690          }
691          for (int i = 1; i <= last; ++i) {
692              ForkJoinTask<?> t = tasks[i];
693              if (t != null) {
694                  if (ex != null)
695                      t.cancel(false);
696 <                else {
697 <                    t.quietlyJoin();
438 <                    if (ex == null && t.status < NORMAL)
439 <                        ex = t.getException();
440 <                }
696 >                else if (t.doJoin() < NORMAL && ex == null)
697 >                    ex = t.getException();
698              }
699          }
700          if (ex != null)
# Line 458 | Line 715 | public abstract class ForkJoinTask<V> im
715       * unprocessed.
716       *
717       * <p>This method may be invoked only from within {@code
718 <     * ForkJoinTask} computations (as may be determined using method
718 >     * ForkJoinPool} computations (as may be determined using method
719       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
720       * result in exceptions or errors, possibly including {@code
721       * ClassCastException}.
# Line 485 | Line 742 | public abstract class ForkJoinTask<V> im
742              }
743              else if (i != 0)
744                  t.fork();
745 <            else {
746 <                t.quietlyInvoke();
490 <                if (ex == null && t.status < NORMAL)
491 <                    ex = t.getException();
492 <            }
745 >            else if (t.doInvoke() < NORMAL && ex == null)
746 >                ex = t.getException();
747          }
748          for (int i = 1; i <= last; ++i) {
749              ForkJoinTask<?> t = ts.get(i);
750              if (t != null) {
751                  if (ex != null)
752                      t.cancel(false);
753 <                else {
754 <                    t.quietlyJoin();
501 <                    if (ex == null && t.status < NORMAL)
502 <                        ex = t.getException();
503 <                }
753 >                else if (t.doJoin() < NORMAL && ex == null)
754 >                    ex = t.getException();
755              }
756          }
757          if (ex != null)
# Line 510 | Line 761 | public abstract class ForkJoinTask<V> im
761  
762      /**
763       * Attempts to cancel execution of this task. This attempt will
764 <     * fail if the task has already completed, has already been
765 <     * cancelled, or could not be cancelled for some other reason. If
766 <     * successful, and this task has not started when cancel is
767 <     * called, execution of this task is suppressed, {@link
768 <     * #isCancelled} will report true, and {@link #join} will result
769 <     * in a {@code CancellationException} being thrown.
764 >     * fail if the task has already completed or could not be
765 >     * cancelled for some other reason. If successful, and this task
766 >     * has not started when {@code cancel} is called, execution of
767 >     * this task is suppressed. After this method returns
768 >     * successfully, unless there is an intervening call to {@link
769 >     * #reinitialize}, subsequent calls to {@link #isCancelled},
770 >     * {@link #isDone}, and {@code cancel} will return {@code true}
771 >     * and calls to {@link #join} and related methods will result in
772 >     * {@code CancellationException}.
773       *
774       * <p>This method may be overridden in subclasses, but if so, must
775 <     * still ensure that these minimal properties hold. In particular,
776 <     * the {@code cancel} method itself must not throw exceptions.
775 >     * still ensure that these properties hold. In particular, the
776 >     * {@code cancel} method itself must not throw exceptions.
777       *
778       * <p>This method is designed to be invoked by <em>other</em>
779       * tasks. To terminate the current task, you can just return or
780       * throw an unchecked exception from its computation method, or
781       * invoke {@link #completeExceptionally}.
782       *
783 <     * @param mayInterruptIfRunning this value is ignored in the
784 <     * default implementation because tasks are not
785 <     * cancelled via interruption
783 >     * @param mayInterruptIfRunning this value has no effect in the
784 >     * default implementation because interrupts are not used to
785 >     * control cancellation.
786       *
787       * @return {@code true} if this task is now cancelled
788       */
789      public boolean cancel(boolean mayInterruptIfRunning) {
790 <        setCompletion(CANCELLED);
537 <        return status == CANCELLED;
790 >        return setCompletion(CANCELLED) == CANCELLED;
791      }
792  
793      /**
# Line 550 | Line 803 | public abstract class ForkJoinTask<V> im
803          }
804      }
805  
553    /**
554     * Cancels if current thread is a terminating worker thread,
555     * ignoring any exceptions thrown by cancel.
556     */
557    final void cancelIfTerminating() {
558        Thread t = Thread.currentThread();
559        if ((t instanceof ForkJoinWorkerThread) &&
560            ((ForkJoinWorkerThread) t).isTerminating()) {
561            try {
562                cancel(false);
563            } catch (Throwable ignore) {
564            }
565        }
566    }
567
806      public final boolean isDone() {
807          return status < 0;
808      }
# Line 604 | Line 842 | public abstract class ForkJoinTask<V> im
842          int s = status;
843          return ((s >= NORMAL)    ? null :
844                  (s == CANCELLED) ? new CancellationException() :
845 <                exceptionMap.get(this));
845 >                getThrowableException());
846      }
847  
848      /**
# Line 662 | Line 900 | public abstract class ForkJoinTask<V> im
900       * member of a ForkJoinPool and was interrupted while waiting
901       */
902      public final V get() throws InterruptedException, ExecutionException {
903 <        int s;
904 <        if (Thread.currentThread() instanceof ForkJoinWorkerThread) {
905 <            quietlyJoin();
906 <            s = status;
907 <        }
908 <        else {
909 <            while ((s = status) >= 0) {
672 <                synchronized (this) { // interruptible form of awaitDone
673 <                    if (UNSAFE.compareAndSwapInt(this, statusOffset,
674 <                                                 s, SIGNAL)) {
675 <                        while (status >= 0)
676 <                            wait();
677 <                    }
678 <                }
679 <            }
680 <        }
681 <        if (s < NORMAL) {
682 <            Throwable ex;
683 <            if (s == CANCELLED)
684 <                throw new CancellationException();
685 <            if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
686 <                throw new ExecutionException(ex);
687 <        }
903 >        int s = (Thread.currentThread() instanceof ForkJoinWorkerThread) ?
904 >            doJoin() : externalInterruptibleAwaitDone(0L);
905 >        Throwable ex;
906 >        if (s == CANCELLED)
907 >            throw new CancellationException();
908 >        if (s == EXCEPTIONAL && (ex = getThrowableException()) != null)
909 >            throw new ExecutionException(ex);
910          return getRawResult();
911      }
912  
# Line 704 | Line 926 | public abstract class ForkJoinTask<V> im
926       */
927      public final V get(long timeout, TimeUnit unit)
928          throws InterruptedException, ExecutionException, TimeoutException {
929 <        long nanos = unit.toNanos(timeout);
930 <        if (status >= 0) {
931 <            Thread t = Thread.currentThread();
932 <            if (t instanceof ForkJoinWorkerThread) {
933 <                ForkJoinWorkerThread w = (ForkJoinWorkerThread) t;
934 <                boolean completed = false; // timed variant of quietlyJoin
929 >        Thread t = Thread.currentThread();
930 >        if (t instanceof ForkJoinWorkerThread) {
931 >            ForkJoinWorkerThread w = (ForkJoinWorkerThread) t;
932 >            long nanos = unit.toNanos(timeout);
933 >            if (status >= 0) {
934 >                boolean completed = false;
935                  if (w.unpushTask(this)) {
936                      try {
937                          completed = exec();
# Line 719 | Line 941 | public abstract class ForkJoinTask<V> im
941                  }
942                  if (completed)
943                      setCompletion(NORMAL);
944 <                else if (status >= 0)
945 <                    w.joinTask(this, true, nanos);
724 <            }
725 <            else if (Thread.interrupted())
726 <                throw new InterruptedException();
727 <            else {
728 <                long startTime = System.nanoTime();
729 <                int s; long nt;
730 <                while ((s = status) >= 0 &&
731 <                       (nt = nanos - (System.nanoTime() - startTime)) > 0) {
732 <                    if (UNSAFE.compareAndSwapInt(this, statusOffset, s,
733 <                                                 SIGNAL)) {
734 <                        long ms = nt / 1000000;
735 <                        int ns = (int) (nt % 1000000);
736 <                        synchronized (this) {
737 <                            if (status >= 0)
738 <                                wait(ms, ns); // exit on IE throw
739 <                        }
740 <                    }
741 <                }
944 >                else if (status >= 0 && nanos > 0)
945 >                    w.pool.timedAwaitJoin(this, nanos);
946              }
947          }
948 <        int es = status;
949 <        if (es != NORMAL) {
948 >        else {
949 >            long millis = unit.toMillis(timeout);
950 >            if (millis > 0)
951 >                externalInterruptibleAwaitDone(millis);
952 >        }
953 >        int s = status;
954 >        if (s != NORMAL) {
955              Throwable ex;
956 <            if (es == CANCELLED)
956 >            if (s == CANCELLED)
957                  throw new CancellationException();
958 <            if (es == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
958 >            if (s != EXCEPTIONAL)
959 >                throw new TimeoutException();
960 >            if ((ex = getThrowableException()) != null)
961                  throw new ExecutionException(ex);
751            throw new TimeoutException();
962          }
963          return getRawResult();
964      }
# Line 760 | Line 970 | public abstract class ForkJoinTask<V> im
970       * known to have aborted.
971       */
972      public final void quietlyJoin() {
973 <        Thread t;
764 <        if ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) {
765 <            ForkJoinWorkerThread w = (ForkJoinWorkerThread) t;
766 <            if (status >= 0) {
767 <                if (w.unpushTask(this)) {
768 <                    boolean completed;
769 <                    try {
770 <                        completed = exec();
771 <                    } catch (Throwable rex) {
772 <                        setExceptionalCompletion(rex);
773 <                        return;
774 <                    }
775 <                    if (completed) {
776 <                        setCompletion(NORMAL);
777 <                        return;
778 <                    }
779 <                }
780 <                w.joinTask(this, false, 0L);
781 <            }
782 <        }
783 <        else
784 <            externalAwaitDone();
973 >        doJoin();
974      }
975  
976      /**
# Line 790 | Line 979 | public abstract class ForkJoinTask<V> im
979       * exception.
980       */
981      public final void quietlyInvoke() {
982 <        if (status >= 0) {
794 <            boolean completed;
795 <            try {
796 <                completed = exec();
797 <            } catch (Throwable rex) {
798 <                setExceptionalCompletion(rex);
799 <                return;
800 <            }
801 <            if (completed)
802 <                setCompletion(NORMAL);
803 <            else
804 <                quietlyJoin();
805 <        }
982 >        doInvoke();
983      }
984  
985      /**
# Line 813 | Line 990 | public abstract class ForkJoinTask<V> im
990       * processed.
991       *
992       * <p>This method may be invoked only from within {@code
993 <     * ForkJoinTask} computations (as may be determined using method
993 >     * ForkJoinPool} computations (as may be determined using method
994       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
995       * result in exceptions or errors, possibly including {@code
996       * ClassCastException}.
# Line 832 | Line 1009 | public abstract class ForkJoinTask<V> im
1009       * under any other usage conditions are not guaranteed.
1010       * This method may be useful when executing
1011       * pre-constructed trees of subtasks in loops.
1012 <     *
1012 >     *
1013       * <p>Upon completion of this method, {@code isDone()} reports
1014       * {@code false}, and {@code getException()} reports {@code
1015       * null}. However, the value returned by {@code getRawResult} is
# Line 841 | Line 1018 | public abstract class ForkJoinTask<V> im
1018       */
1019      public void reinitialize() {
1020          if (status == EXCEPTIONAL)
1021 <            exceptionMap.remove(this);
1022 <        status = 0;
1021 >            clearExceptionalCompletion();
1022 >        else
1023 >            status = 0;
1024      }
1025  
1026      /**
# Line 859 | Line 1037 | public abstract class ForkJoinTask<V> im
1037      }
1038  
1039      /**
1040 <     * Returns {@code true} if the current thread is executing as a
1041 <     * ForkJoinPool computation.
1040 >     * Returns {@code true} if the current thread is a {@link
1041 >     * ForkJoinWorkerThread} executing as a ForkJoinPool computation.
1042       *
1043 <     * @return {@code true} if the current thread is executing as a
1044 <     * ForkJoinPool computation, or false otherwise
1043 >     * @return {@code true} if the current thread is a {@link
1044 >     * ForkJoinWorkerThread} executing as a ForkJoinPool computation,
1045 >     * or {@code false} otherwise
1046       */
1047      public static boolean inForkJoinPool() {
1048          return Thread.currentThread() instanceof ForkJoinWorkerThread;
# Line 878 | Line 1057 | public abstract class ForkJoinTask<V> im
1057       * were not, stolen.
1058       *
1059       * <p>This method may be invoked only from within {@code
1060 <     * ForkJoinTask} computations (as may be determined using method
1060 >     * ForkJoinPool} computations (as may be determined using method
1061       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
1062       * result in exceptions or errors, possibly including {@code
1063       * ClassCastException}.
# Line 897 | Line 1076 | public abstract class ForkJoinTask<V> im
1076       * fork other tasks.
1077       *
1078       * <p>This method may be invoked only from within {@code
1079 <     * ForkJoinTask} computations (as may be determined using method
1079 >     * ForkJoinPool} computations (as may be determined using method
1080       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
1081       * result in exceptions or errors, possibly including {@code
1082       * ClassCastException}.
# Line 920 | Line 1099 | public abstract class ForkJoinTask<V> im
1099       * exceeded.
1100       *
1101       * <p>This method may be invoked only from within {@code
1102 <     * ForkJoinTask} computations (as may be determined using method
1102 >     * ForkJoinPool} computations (as may be determined using method
1103       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
1104       * result in exceptions or errors, possibly including {@code
1105       * ClassCastException}.
# Line 978 | Line 1157 | public abstract class ForkJoinTask<V> im
1157       * otherwise.
1158       *
1159       * <p>This method may be invoked only from within {@code
1160 <     * ForkJoinTask} computations (as may be determined using method
1160 >     * ForkJoinPool} computations (as may be determined using method
1161       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
1162       * result in exceptions or errors, possibly including {@code
1163       * ClassCastException}.
# Line 997 | Line 1176 | public abstract class ForkJoinTask<V> im
1176       * be useful otherwise.
1177       *
1178       * <p>This method may be invoked only from within {@code
1179 <     * ForkJoinTask} computations (as may be determined using method
1179 >     * ForkJoinPool} computations (as may be determined using method
1180       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
1181       * result in exceptions or errors, possibly including {@code
1182       * ClassCastException}.
# Line 1020 | Line 1199 | public abstract class ForkJoinTask<V> im
1199       * otherwise.
1200       *
1201       * <p>This method may be invoked only from within {@code
1202 <     * ForkJoinTask} computations (as may be determined using method
1202 >     * ForkJoinPool} computations (as may be determined using method
1203       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
1204       * result in exceptions or errors, possibly including {@code
1205       * ClassCastException}.
# Line 1152 | Line 1331 | public abstract class ForkJoinTask<V> im
1331          s.defaultReadObject();
1332          Object ex = s.readObject();
1333          if (ex != null)
1334 <            setExceptionalCompletion((Throwable) ex);
1334 >            setExceptionalCompletion((Throwable)ex);
1335      }
1336  
1337      // Unsafe mechanics
1338 <
1339 <    private static final sun.misc.Unsafe UNSAFE = getUnsafe();
1340 <    private static final long statusOffset =
1341 <        objectFieldOffset("status", ForkJoinTask.class);
1342 <
1343 <    private static long objectFieldOffset(String field, Class<?> klazz) {
1338 >    private static final sun.misc.Unsafe UNSAFE;
1339 >    private static final long statusOffset;
1340 >    static {
1341 >        exceptionTableLock = new ReentrantLock();
1342 >        exceptionTableRefQueue = new ReferenceQueue<Object>();
1343 >        exceptionTable = new ExceptionNode[EXCEPTION_MAP_CAPACITY];
1344          try {
1345 <            return UNSAFE.objectFieldOffset(klazz.getDeclaredField(field));
1346 <        } catch (NoSuchFieldException e) {
1347 <            // Convert Exception to corresponding Error
1348 <            NoSuchFieldError error = new NoSuchFieldError(field);
1349 <            error.initCause(e);
1171 <            throw error;
1345 >            UNSAFE = getUnsafe();
1346 >            statusOffset = UNSAFE.objectFieldOffset
1347 >                (ForkJoinTask.class.getDeclaredField("status"));
1348 >        } catch (Exception e) {
1349 >            throw new Error(e);
1350          }
1351      }
1352  

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines