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.62 by dl, Fri Sep 17 14:24:56 2010 UTC vs.
Revision 1.74 by dl, Tue Feb 22 00:39:31 2011 UTC

# Line 6 | Line 6
6  
7   package jsr166y;
8  
9 import java.util.concurrent.*;
10
9   import java.io.Serializable;
10   import java.util.Collection;
11   import java.util.Collections;
12   import java.util.List;
13   import java.util.RandomAccess;
14   import java.util.Map;
15 < import java.util.WeakHashMap;
15 > import java.lang.ref.WeakReference;
16 > import java.lang.ref.ReferenceQueue;
17 > 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 > import java.util.concurrent.locks.ReentrantLock;
28 > import java.lang.reflect.Constructor;
29  
30   /**
31   * Abstract base class for tasks that run within a {@link ForkJoinPool}.
# Line 58 | Line 69 | import java.util.WeakHashMap;
69   * rethrown to callers attempting to join them. These exceptions may
70   * additionally include {@link RejectedExecutionException} stemming
71   * from internal resource exhaustion, such as failure to allocate
72 < * internal task queues.
72 > * 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   *
78   * <p>The primary method for awaiting completion and extracting
79   * results of a task is {@link #join}, but there are several variants:
# Line 102 | Line 117 | import java.util.WeakHashMap;
117   * result in exceptions or errors, possibly including
118   * {@code ClassCastException}.
119   *
120 + * <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   * <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
# Line 116 | Line 141 | import java.util.WeakHashMap;
141   * 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 < * computational steps. If tasks are too big, then parallelism cannot
145 < * improve throughput. If too small, then memory and internal task
146 < * maintenance overhead may overwhelm processing.
144 > * 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   *
149   * <p>This class provides {@code adapt} methods for {@link Runnable}
150   * and {@link Callable}, that may be of use when mixing execution of
# Line 144 | Line 170 | public abstract class ForkJoinTask<V> im
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 <     * in a way that flows well in javadocs. In particular, most
148 <     * join mechanics are in method quietlyJoin, below.
173 >     * in a way that flows well in javadocs.
174       */
175  
176      /*
# Line 167 | Line 192 | public abstract class ForkJoinTask<V> im
192  
193      /** The run status of this task */
194      volatile int status; // accessed directly by pool and workers
170
195      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  
200      /**
177     * Table of exceptions thrown by tasks, to enable reporting by
178     * callers. Because exceptions are rare, we don't directly keep
179     * them with task objects, but instead use a weak ref table.  Note
180     * that cancellation exceptions don't appear in the table, but are
181     * instead recorded as status values.
182     * TODO: Use ConcurrentReferenceHashMap
183     */
184    static final Map<ForkJoinTask<?>, Throwable> exceptionMap =
185        Collections.synchronizedMap
186        (new WeakHashMap<ForkJoinTask<?>, Throwable>());
187
188    // Maintaining completion status
189
190    /**
201       * 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 +     * @return completion status on exit
206       */
207 <    private void setCompletion(int completion) {
208 <        int s;
209 <        while ((s = status) >= 0) {
207 >    private int setCompletion(int completion) {
208 >        for (int s;;) {
209 >            if ((s = status) < 0)
210 >                return s;
211              if (UNSAFE.compareAndSwapInt(this, statusOffset, s, completion)) {
212                  if (s != 0)
213                      synchronized (this) { notifyAll(); }
214 <                break;
214 >                return completion;
215              }
216          }
217      }
218  
219      /**
220 <     * Records exception and sets exceptional completion.
220 >     * 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       *
224 <     * @return status on exit
224 >     * @param millis if > 0, wait time.
225       */
226 <    private void setExceptionalCompletion(Throwable rex) {
227 <        exceptionMap.put(this, rex);
228 <        setCompletion(EXCEPTIONAL);
226 >    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 >                synchronized (this) {
234 >                    if (status > 0)
235 >                        wait(millis);
236 >                }
237 >            }
238 >        } catch (InterruptedException ie) {
239 >            // caller must check termination
240 >        }
241      }
242  
243      /**
244 <     * Blocks a worker thread until completion. Called only by
245 <     * pool. Currently unused -- pool-based waits use timeout
220 <     * version below.
244 >     * Blocks a non-worker-thread until completion.
245 >     * @return status upon completion
246       */
247 <    final void internalAwaitDone() {
248 <        int s;         // the odd construction reduces lock bias effects
249 <        while ((s = status) >= 0) {
250 <            try {
251 <                synchronized (this) {
252 <                    if (UNSAFE.compareAndSwapInt(this, statusOffset, s,SIGNAL))
253 <                        wait();
247 >    private int externalAwaitDone() {
248 >        int s;
249 >        if ((s = status) >= 0) {
250 >            boolean interrupted = false;
251 >            synchronized (this) {
252 >                while ((s = status) >= 0) {
253 >                    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 >                    }
263                  }
230            } catch (InterruptedException ie) {
231                cancelIfTerminating();
264              }
265 +            if (interrupted)
266 +                Thread.currentThread().interrupt();
267          }
268 +        return s;
269      }
270  
271      /**
272 <     * Blocks a worker thread until completed or timed out.  Called
238 <     * only by pool.
239 <     *
240 <     * @return status on exit
272 >     * Blocks a non-worker-thread until completion or interruption or timeout.
273       */
274 <    final int internalAwaitDone(long millis) {
274 >    private int externalInterruptibleAwaitDone(long millis)
275 >        throws InterruptedException {
276          int s;
277 +        if (Thread.interrupted())
278 +            throw new InterruptedException();
279          if ((s = status) >= 0) {
280 <            try {
281 <                synchronized (this) {
282 <                    if (UNSAFE.compareAndSwapInt(this, statusOffset, s,SIGNAL))
283 <                        wait(millis, 0);
280 >            synchronized (this) {
281 >                while ((s = status) >= 0) {
282 >                    if (s == 0)
283 >                        UNSAFE.compareAndSwapInt(this, statusOffset,
284 >                                                 0, SIGNAL);
285 >                    else
286 >                        wait(millis);
287                  }
250            } catch (InterruptedException ie) {
251                cancelIfTerminating();
288              }
253            s = status;
289          }
290          return s;
291      }
292  
293      /**
294 <     * Blocks a non-worker-thread until completion.
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 <    private void externalAwaitDone() {
299 <        int s;
300 <        while ((s = status) >= 0) {
301 <            synchronized (this) {
302 <                if (UNSAFE.compareAndSwapInt(this, statusOffset, s, SIGNAL)){
303 <                    boolean interrupted = false;
304 <                    while (status >= 0) {
305 <                        try {
306 <                            wait();
307 <                        } catch (InterruptedException ie) {
308 <                            interrupted = true;
309 <                        }
310 <                    }
311 <                    if (interrupted)
312 <                        Thread.currentThread().interrupt();
313 <                    break;
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                  }
327 +                if (completed)
328 +                    return setCompletion(NORMAL);
329              }
330 +            return w.joinTask(this);
331          }
332 +        else
333 +            return externalAwaitDone();
334      }
335  
336      /**
337 <     * Unless done, calls exec and records status if completed, but
338 <     * doesn't wait for completion otherwise. Primary execution method
285 <     * for ForkJoinWorkerThread.
337 >     * Primary mechanics for invoke, quietlyInvoke.
338 >     * @return status upon completion
339       */
340 <    final void quietlyExec() {
340 >    private int doInvoke() {
341 >        int s; boolean completed;
342 >        if ((s = status) < 0)
343 >            return s;
344          try {
345 <            if (status < 0 || !exec())
290 <                return;
345 >            completed = exec();
346          } catch (Throwable rex) {
347 <            setExceptionalCompletion(rex);
348 <            return;
347 >            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 <        setCompletion(NORMAL); // must be outside try block
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 >        }
554 >    }
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      }
568  
569      // public methods
# Line 308 | Line 579 | public abstract class ForkJoinTask<V> im
579       * #isDone} returning {@code true}.
580       *
581       * <p>This method may be invoked only from within {@code
582 <     * ForkJoinTask} computations (as may be determined using method
582 >     * ForkJoinPool} computations (as may be determined using method
583       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
584       * result in exceptions or errors, possibly including {@code
585       * ClassCastException}.
# Line 322 | Line 593 | public abstract class ForkJoinTask<V> im
593      }
594  
595      /**
596 <     * Returns the result of the computation when it {@link #isDone is done}.
597 <     * This method differs from {@link #get()} in that
596 >     * Returns the result of the computation when it {@link #isDone is
597 >     * done}.  This method differs from {@link #get()} in that
598       * abnormal completion results in {@code RuntimeException} or
599 <     * {@code Error}, not {@code ExecutionException}.
599 >     * {@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       *
604       * @return the computed result
605       */
606      public final V join() {
607 <        quietlyJoin();
608 <        Throwable ex;
609 <        if (status < NORMAL && (ex = getException()) != null)
610 <            UNSAFE.throwException(ex);
337 <        return getRawResult();
607 >        if (doJoin() != NORMAL)
608 >            return reportResult();
609 >        else
610 >            return getRawResult();
611      }
612  
613      /**
# Line 346 | Line 619 | public abstract class ForkJoinTask<V> im
619       * @return the computed result
620       */
621      public final V invoke() {
622 <        quietlyInvoke();
623 <        Throwable ex;
624 <        if (status < NORMAL && (ex = getException()) != null)
625 <            UNSAFE.throwException(ex);
353 <        return getRawResult();
622 >        if (doInvoke() != NORMAL)
623 >            return reportResult();
624 >        else
625 >            return getRawResult();
626      }
627  
628      /**
# Line 367 | Line 639 | public abstract class ForkJoinTask<V> im
639       * unprocessed.
640       *
641       * <p>This method may be invoked only from within {@code
642 <     * ForkJoinTask} computations (as may be determined using method
642 >     * ForkJoinPool} computations (as may be determined using method
643       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
644       * result in exceptions or errors, possibly including {@code
645       * ClassCastException}.
# Line 395 | Line 667 | public abstract class ForkJoinTask<V> im
667       * normally or exceptionally, or left unprocessed.
668       *
669       * <p>This method may be invoked only from within {@code
670 <     * ForkJoinTask} computations (as may be determined using method
670 >     * ForkJoinPool} computations (as may be determined using method
671       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
672       * result in exceptions or errors, possibly including {@code
673       * ClassCastException}.
# Line 414 | Line 686 | public abstract class ForkJoinTask<V> im
686              }
687              else if (i != 0)
688                  t.fork();
689 <            else {
690 <                t.quietlyInvoke();
419 <                if (ex == null && t.status < NORMAL)
420 <                    ex = t.getException();
421 <            }
689 >            else if (t.doInvoke() < NORMAL && ex == null)
690 >                ex = t.getException();
691          }
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 <                else {
698 <                    t.quietlyJoin();
430 <                    if (ex == null && t.status < NORMAL)
431 <                        ex = t.getException();
432 <                }
697 >                else if (t.doJoin() < NORMAL && ex == null)
698 >                    ex = t.getException();
699              }
700          }
701          if (ex != null)
# Line 450 | Line 716 | public abstract class ForkJoinTask<V> im
716       * unprocessed.
717       *
718       * <p>This method may be invoked only from within {@code
719 <     * ForkJoinTask} computations (as may be determined using method
719 >     * ForkJoinPool} computations (as may be determined using method
720       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
721       * result in exceptions or errors, possibly including {@code
722       * ClassCastException}.
# Line 477 | Line 743 | public abstract class ForkJoinTask<V> im
743              }
744              else if (i != 0)
745                  t.fork();
746 <            else {
747 <                t.quietlyInvoke();
482 <                if (ex == null && t.status < NORMAL)
483 <                    ex = t.getException();
484 <            }
746 >            else if (t.doInvoke() < NORMAL && ex == null)
747 >                ex = t.getException();
748          }
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 <                else {
755 <                    t.quietlyJoin();
493 <                    if (ex == null && t.status < NORMAL)
494 <                        ex = t.getException();
495 <                }
754 >                else if (t.doJoin() < NORMAL && ex == null)
755 >                    ex = t.getException();
756              }
757          }
758          if (ex != null)
# Line 502 | Line 762 | public abstract class ForkJoinTask<V> im
762  
763      /**
764       * Attempts to cancel execution of this task. This attempt will
765 <     * fail if the task has already completed, has already been
766 <     * cancelled, or could not be cancelled for some other reason. If
767 <     * successful, and this task has not started when cancel is
768 <     * called, execution of this task is suppressed, {@link
769 <     * #isCancelled} will report true, and {@link #join} will result
770 <     * in a {@code CancellationException} being thrown.
765 >     * 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       *
775       * <p>This method may be overridden in subclasses, but if so, must
776 <     * still ensure that these minimal properties hold. In particular,
777 <     * the {@code cancel} method itself must not throw exceptions.
776 >     * still ensure that these properties hold. In particular, the
777 >     * {@code cancel} method itself must not throw exceptions.
778       *
779       * <p>This method is designed to be invoked by <em>other</em>
780       * tasks. To terminate the current task, you can just return or
781       * throw an unchecked exception from its computation method, or
782       * invoke {@link #completeExceptionally}.
783       *
784 <     * @param mayInterruptIfRunning this value is ignored in the
785 <     * default implementation because tasks are not
786 <     * cancelled via interruption
784 >     * @param mayInterruptIfRunning this value has no effect in the
785 >     * default implementation because interrupts are not used to
786 >     * control cancellation.
787       *
788       * @return {@code true} if this task is now cancelled
789       */
790      public boolean cancel(boolean mayInterruptIfRunning) {
791 <        setCompletion(CANCELLED);
529 <        return status == CANCELLED;
791 >        return setCompletion(CANCELLED) == CANCELLED;
792      }
793  
794      /**
# Line 542 | Line 804 | public abstract class ForkJoinTask<V> im
804          }
805      }
806  
545    /**
546     * Cancels if current thread is a terminating worker thread,
547     * ignoring any exceptions thrown by cancel.
548     */
549    final void cancelIfTerminating() {
550        Thread t = Thread.currentThread();
551        if ((t instanceof ForkJoinWorkerThread) &&
552            ((ForkJoinWorkerThread) t).isTerminating()) {
553            try {
554                cancel(false);
555            } catch (Throwable ignore) {
556            }
557        }
558    }
559
807      public final boolean isDone() {
808          return status < 0;
809      }
# Line 596 | Line 843 | public abstract class ForkJoinTask<V> im
843          int s = status;
844          return ((s >= NORMAL)    ? null :
845                  (s == CANCELLED) ? new CancellationException() :
846 <                exceptionMap.get(this));
846 >                getThrowableException());
847      }
848  
849      /**
# Line 643 | Line 890 | public abstract class ForkJoinTask<V> im
890      }
891  
892      /**
893 <     * @throws CancellationException {@inheritDoc}
893 >     * 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       */
903      public final V get() throws InterruptedException, ExecutionException {
904 <        int s;
905 <        if (Thread.currentThread() instanceof ForkJoinWorkerThread) {
906 <            quietlyJoin();
907 <            s = status;
908 <        }
909 <        else {
910 <            while ((s = status) >= 0) {
656 <                synchronized (this) { // interruptible form of awaitDone
657 <                    if (UNSAFE.compareAndSwapInt(this, statusOffset,
658 <                                                 s, SIGNAL)) {
659 <                        while (status >= 0)
660 <                            wait();
661 <                    }
662 <                }
663 <            }
664 <        }
665 <        if (s < NORMAL) {
666 <            Throwable ex;
667 <            if (s == CANCELLED)
668 <                throw new CancellationException();
669 <            if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
670 <                throw new ExecutionException(ex);
671 <        }
904 >        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          return getRawResult();
912      }
913  
914      /**
915 <     * @throws CancellationException {@inheritDoc}
915 >     * 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       */
928      public final V get(long timeout, TimeUnit unit)
929          throws InterruptedException, ExecutionException, TimeoutException {
930          Thread t = Thread.currentThread();
681        ForkJoinPool pool;
931          if (t instanceof ForkJoinWorkerThread) {
932              ForkJoinWorkerThread w = (ForkJoinWorkerThread) t;
933 <            if (status >= 0 && w.unpushTask(this))
934 <                quietlyExec();
935 <            pool = w.pool;
936 <        }
937 <        else
938 <            pool = null;
939 <        /*
940 <         * Timed wait loop intermixes cases for FJ (pool != null) and
692 <         * non FJ threads. For FJ, decrement pool count but don't try
693 <         * for replacement; increment count on completion. For non-FJ,
694 <         * deal with interrupts. This is messy, but a little less so
695 <         * than is splitting the FJ and nonFJ cases.
696 <         */
697 <        boolean interrupted = false;
698 <        boolean dec = false; // true if pool count decremented
699 <        long nanos = unit.toNanos(timeout);
700 <        for (;;) {
701 <            if (pool == null && Thread.interrupted()) {
702 <                interrupted = true;
703 <                break;
704 <            }
705 <            int s = status;
706 <            if (s < 0)
707 <                break;
708 <            if (UNSAFE.compareAndSwapInt(this, statusOffset, s, SIGNAL)) {
709 <                long startTime = System.nanoTime();
710 <                long nt; // wait time
711 <                while (status >= 0 &&
712 <                       (nt = nanos - (System.nanoTime() - startTime)) > 0) {
713 <                    if (pool != null && !dec)
714 <                        dec = pool.tryDecrementRunningCount();
715 <                    else {
716 <                        long ms = nt / 1000000;
717 <                        int ns = (int) (nt % 1000000);
718 <                        try {
719 <                            synchronized (this) {
720 <                                if (status >= 0)
721 <                                    wait(ms, ns);
722 <                            }
723 <                        } catch (InterruptedException ie) {
724 <                            if (pool != null)
725 <                                cancelIfTerminating();
726 <                            else {
727 <                                interrupted = true;
728 <                                break;
729 <                            }
730 <                        }
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 <                break;
943 >                if (completed)
944 >                    setCompletion(NORMAL);
945 >                else if (status >= 0 && nanos > 0)
946 >                    w.pool.timedAwaitJoin(this, nanos);
947              }
948          }
949 <        if (pool != null && dec)
950 <            pool.incrementRunningCount();
951 <        if (interrupted)
952 <            throw new InterruptedException();
953 <        int es = status;
954 <        if (es != NORMAL) {
949 >        else {
950 >            long millis = unit.toMillis(timeout);
951 >            if (millis > 0)
952 >                externalInterruptibleAwaitDone(millis);
953 >        }
954 >        int s = status;
955 >        if (s != NORMAL) {
956              Throwable ex;
957 <            if (es == CANCELLED)
957 >            if (s == CANCELLED)
958                  throw new CancellationException();
959 <            if (es == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
959 >            if (s != EXCEPTIONAL)
960 >                throw new TimeoutException();
961 >            if ((ex = getThrowableException()) != null)
962                  throw new ExecutionException(ex);
747            throw new TimeoutException();
963          }
964          return getRawResult();
965      }
# Line 756 | Line 971 | public abstract class ForkJoinTask<V> im
971       * known to have aborted.
972       */
973      public final void quietlyJoin() {
974 <        Thread t;
760 <        if ((t = Thread.currentThread()) instanceof ForkJoinWorkerThread) {
761 <            ForkJoinWorkerThread w = (ForkJoinWorkerThread) t;
762 <            if (status >= 0) {
763 <                if (w.unpushTask(this)) {
764 <                    boolean completed;
765 <                    try {
766 <                        completed = exec();
767 <                    } catch (Throwable rex) {
768 <                        setExceptionalCompletion(rex);
769 <                        return;
770 <                    }
771 <                    if (completed) {
772 <                        setCompletion(NORMAL);
773 <                        return;
774 <                    }
775 <                }
776 <                w.joinTask(this);
777 <            }
778 <        }
779 <        else
780 <            externalAwaitDone();
974 >        doJoin();
975      }
976  
977      /**
# Line 786 | Line 980 | public abstract class ForkJoinTask<V> im
980       * exception.
981       */
982      public final void quietlyInvoke() {
983 <        if (status >= 0) {
790 <            boolean completed;
791 <            try {
792 <                completed = exec();
793 <            } catch (Throwable rex) {
794 <                setExceptionalCompletion(rex);
795 <                return;
796 <            }
797 <            if (completed)
798 <                setCompletion(NORMAL);
799 <            else
800 <                quietlyJoin();
801 <        }
983 >        doInvoke();
984      }
985  
986      /**
# Line 809 | Line 991 | public abstract class ForkJoinTask<V> im
991       * processed.
992       *
993       * <p>This method may be invoked only from within {@code
994 <     * ForkJoinTask} computations (as may be determined using method
994 >     * ForkJoinPool} computations (as may be determined using method
995       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
996       * result in exceptions or errors, possibly including {@code
997       * ClassCastException}.
# Line 828 | Line 1010 | public abstract class ForkJoinTask<V> im
1010       * under any other usage conditions are not guaranteed.
1011       * This method may be useful when executing
1012       * pre-constructed trees of subtasks in loops.
1013 +     *
1014 +     * <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       */
1020      public void reinitialize() {
1021          if (status == EXCEPTIONAL)
1022 <            exceptionMap.remove(this);
1023 <        status = 0;
1022 >            clearExceptionalCompletion();
1023 >        else
1024 >            status = 0;
1025      }
1026  
1027      /**
# Line 849 | Line 1038 | public abstract class ForkJoinTask<V> im
1038      }
1039  
1040      /**
1041 <     * Returns {@code true} if the current thread is executing as a
1042 <     * ForkJoinPool computation.
1041 >     * Returns {@code true} if the current thread is a {@link
1042 >     * ForkJoinWorkerThread} executing as a ForkJoinPool computation.
1043       *
1044 <     * @return {@code true} if the current thread is executing as a
1045 <     * ForkJoinPool computation, or false otherwise
1044 >     * @return {@code true} if the current thread is a {@link
1045 >     * ForkJoinWorkerThread} executing as a ForkJoinPool computation,
1046 >     * or {@code false} otherwise
1047       */
1048      public static boolean inForkJoinPool() {
1049          return Thread.currentThread() instanceof ForkJoinWorkerThread;
# Line 868 | Line 1058 | public abstract class ForkJoinTask<V> im
1058       * were not, stolen.
1059       *
1060       * <p>This method may be invoked only from within {@code
1061 <     * ForkJoinTask} computations (as may be determined using method
1061 >     * ForkJoinPool} computations (as may be determined using method
1062       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
1063       * result in exceptions or errors, possibly including {@code
1064       * ClassCastException}.
# Line 887 | Line 1077 | public abstract class ForkJoinTask<V> im
1077       * fork other tasks.
1078       *
1079       * <p>This method may be invoked only from within {@code
1080 <     * ForkJoinTask} computations (as may be determined using method
1080 >     * ForkJoinPool} computations (as may be determined using method
1081       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
1082       * result in exceptions or errors, possibly including {@code
1083       * ClassCastException}.
# Line 910 | Line 1100 | public abstract class ForkJoinTask<V> im
1100       * exceeded.
1101       *
1102       * <p>This method may be invoked only from within {@code
1103 <     * ForkJoinTask} computations (as may be determined using method
1103 >     * ForkJoinPool} computations (as may be determined using method
1104       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
1105       * result in exceptions or errors, possibly including {@code
1106       * ClassCastException}.
# Line 968 | Line 1158 | public abstract class ForkJoinTask<V> im
1158       * otherwise.
1159       *
1160       * <p>This method may be invoked only from within {@code
1161 <     * ForkJoinTask} computations (as may be determined using method
1161 >     * ForkJoinPool} computations (as may be determined using method
1162       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
1163       * result in exceptions or errors, possibly including {@code
1164       * ClassCastException}.
# Line 987 | Line 1177 | public abstract class ForkJoinTask<V> im
1177       * be useful otherwise.
1178       *
1179       * <p>This method may be invoked only from within {@code
1180 <     * ForkJoinTask} computations (as may be determined using method
1180 >     * ForkJoinPool} computations (as may be determined using method
1181       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
1182       * result in exceptions or errors, possibly including {@code
1183       * ClassCastException}.
# Line 1010 | Line 1200 | public abstract class ForkJoinTask<V> im
1200       * otherwise.
1201       *
1202       * <p>This method may be invoked only from within {@code
1203 <     * ForkJoinTask} computations (as may be determined using method
1203 >     * ForkJoinPool} computations (as may be determined using method
1204       * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
1205       * result in exceptions or errors, possibly including {@code
1206       * ClassCastException}.
# Line 1142 | Line 1332 | public abstract class ForkJoinTask<V> im
1332          s.defaultReadObject();
1333          Object ex = s.readObject();
1334          if (ex != null)
1335 <            setExceptionalCompletion((Throwable) ex);
1335 >            setExceptionalCompletion((Throwable)ex);
1336      }
1337  
1338      // Unsafe mechanics
1339 <
1340 <    private static final sun.misc.Unsafe UNSAFE = getUnsafe();
1341 <    private static final long statusOffset =
1342 <        objectFieldOffset("status", ForkJoinTask.class);
1343 <
1344 <    private static long objectFieldOffset(String field, Class<?> klazz) {
1339 >    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          try {
1346 <            return UNSAFE.objectFieldOffset(klazz.getDeclaredField(field));
1347 <        } catch (NoSuchFieldException e) {
1348 <            // Convert Exception to corresponding Error
1349 <            NoSuchFieldError error = new NoSuchFieldError(field);
1350 <            error.initCause(e);
1161 <            throw error;
1346 >            UNSAFE = getUnsafe();
1347 >            statusOffset = UNSAFE.objectFieldOffset
1348 >                (ForkJoinTask.class.getDeclaredField("status"));
1349 >        } catch (Exception e) {
1350 >            throw new Error(e);
1351          }
1352      }
1353  

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines