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

Comparing jsr166/src/jsr166y/ForkJoinWorkerThread.java (file contents):
Revision 1.34 by dl, Fri Jun 4 14:37:54 2010 UTC vs.
Revision 1.44 by jsr166, Wed Sep 1 20:15:43 2010 UTC

# Line 83 | Line 83 | public class ForkJoinWorkerThread extend
83       * by the ForkJoinPool).  This allows use in message-passing
84       * frameworks in which tasks are never joined.
85       *
86 <     * Efficient implementation of this approach currently relies on
87 <     * an uncomfortable amount of "Unsafe" mechanics. To maintain
86 >     * When a worker would otherwise be blocked waiting to join a
87 >     * task, it first tries a form of linear helping: Each worker
88 >     * records (in field currentSteal) the most recent task it stole
89 >     * from some other worker. Plus, it records (in field currentJoin)
90 >     * the task it is currently actively joining. Method joinTask uses
91 >     * these markers to try to find a worker to help (i.e., steal back
92 >     * a task from and execute it) that could hasten completion of the
93 >     * actively joined task. In essence, the joiner executes a task
94 >     * that would be on its own local deque had the to-be-joined task
95 >     * not been stolen. This may be seen as a conservative variant of
96 >     * the approach in Wagner & Calder "Leapfrogging: a portable
97 >     * technique for implementing efficient futures" SIGPLAN Notices,
98 >     * 1993 (http://portal.acm.org/citation.cfm?id=155354). It differs
99 >     * in that: (1) We only maintain dependency links across workers
100 >     * upon steals, rather than use per-task bookkeeping.  This may
101 >     * require a linear scan of workers array to locate stealers, but
102 >     * usually doesn't because stealers leave hints (that may become
103 >     * stale/wrong) of where to locate them. This isolates cost to
104 >     * when it is needed, rather than adding to per-task overhead.
105 >     * (2) It is "shallow", ignoring nesting and potentially cyclic
106 >     * mutual steals.  (3) It is intentionally racy: field currentJoin
107 >     * is updated only while actively joining, which means that we
108 >     * miss links in the chain during long-lived tasks, GC stalls etc
109 >     * (which is OK since blocking in such cases is usually a good
110 >     * idea).  (4) We bound the number of attempts to find work (see
111 >     * MAX_HELP_DEPTH) and fall back to suspending the worker and if
112 >     * necessary replacing it with a spare (see
113 >     * ForkJoinPool.awaitJoin).
114 >     *
115 >     * Efficient implementation of these algorithms currently relies
116 >     * on an uncomfortable amount of "Unsafe" mechanics. To maintain
117       * correct orderings, reads and writes of variable base require
118       * volatile ordering.  Variable sp does not require volatile
119       * writes but still needs store-ordering, which we accomplish by
120       * pre-incrementing sp before filling the slot with an ordered
121       * store.  (Pre-incrementing also enables backouts used in
122 <     * scanWhileJoining.)  Because they are protected by volatile base
123 <     * reads, reads of the queue array and its slots by other threads
124 <     * do not need volatile load semantics, but writes (in push)
125 <     * require store order and CASes (in pop and deq) require
126 <     * (volatile) CAS semantics.  (Michael, Saraswat, and Vechev's
127 <     * algorithm has similar properties, but without support for
128 <     * nulling slots.)  Since these combinations aren't supported
129 <     * using ordinary volatiles, the only way to accomplish these
130 <     * efficiently is to use direct Unsafe calls. (Using external
131 <     * AtomicIntegers and AtomicReferenceArrays for the indices and
132 <     * array is significantly slower because of memory locality and
133 <     * indirection effects.)
122 >     * joinTask.)  Because they are protected by volatile base reads,
123 >     * reads of the queue array and its slots by other threads do not
124 >     * need volatile load semantics, but writes (in push) require
125 >     * store order and CASes (in pop and deq) require (volatile) CAS
126 >     * semantics.  (Michael, Saraswat, and Vechev's algorithm has
127 >     * similar properties, but without support for nulling slots.)
128 >     * Since these combinations aren't supported using ordinary
129 >     * volatiles, the only way to accomplish these efficiently is to
130 >     * use direct Unsafe calls. (Using external AtomicIntegers and
131 >     * AtomicReferenceArrays for the indices and array is
132 >     * significantly slower because of memory locality and indirection
133 >     * effects.)
134       *
135       * Further, performance on most platforms is very sensitive to
136       * placement and sizing of the (resizable) queue array.  Even
# Line 126 | Line 155 | public class ForkJoinWorkerThread extend
155      private static final Random seedGenerator = new Random();
156  
157      /**
158 <     * The timeout value for suspending spares. Spare workers that
159 <     * remain unsignalled for more than this time may be trimmed
160 <     * (killed and removed from pool).  Since our goal is to avoid
161 <     * long-term thread buildup, the exact value of timeout does not
162 <     * matter too much so long as it avoids most false-alarm timeouts
134 <     * under GC stalls or momentarily high system load.
158 >     * The maximum stolen->joining link depth allowed in helpJoinTask.
159 >     * Depths for legitimate chains are unbounded, but we use a fixed
160 >     * constant to avoid (otherwise unchecked) cycles and bound
161 >     * staleness of traversal parameters at the expense of sometimes
162 >     * blocking when we could be helping.
163       */
164 <    private static final long SPARE_KEEPALIVE_NANOS =
137 <        5L * 1000L * 1000L * 1000L; // 5 secs
164 >    private static final int MAX_HELP_DEPTH = 8;
165  
166      /**
167       * Capacity of work-stealing queue array upon initialization.
# Line 178 | Line 205 | public class ForkJoinWorkerThread extend
205      private int sp;
206  
207      /**
208 +     * The index of most recent stealer, used as a hint to avoid
209 +     * traversal in method helpJoinTask. This is only a hint because a
210 +     * worker might have had multiple steals and this only holds one
211 +     * of them (usually the most current). Declared non-volatile,
212 +     * relying on other prevailing sync to keep reasonably current.
213 +     */
214 +    private int stealHint;
215 +
216 +    /**
217       * Run state of this worker. In addition to the usual run levels,
218       * tracks if this worker is suspended as a spare, and if it was
219       * killed (trimmed) while suspended. However, "active" status is
220 <     * maintained separately.
220 >     * maintained separately and modified only in conjunction with
221 >     * CASes of the pool's runState (which are currently sadly
222 >     * manually inlined for performance.)  Accessed directly by pool
223 >     * to simplify checks for normal (zero) status.
224       */
225 <    private volatile int runState;
225 >    volatile int runState;
226  
227      private static final int TERMINATING = 0x01;
228      private static final int TERMINATED  = 0x02;
# Line 191 | Line 230 | public class ForkJoinWorkerThread extend
230      private static final int TRIMMED     = 0x08; // killed while suspended
231  
232      /**
194     * Number of LockSupport.park calls to block this thread for
195     * suspension or event waits. Used for internal instrumention;
196     * currently not exported but included because volatile write upon
197     * park also provides a workaround for a JVM bug.
198     */
199    private volatile int parkCount;
200
201    /**
233       * Number of steals, transferred and reset in pool callbacks pool
234       * when idle Accessed directly by pool.
235       */
# Line 218 | Line 249 | public class ForkJoinWorkerThread extend
249  
250      /**
251       * True if use local fifo, not default lifo, for local polling.
252 <     * Shadows value from ForkJoinPool, which resets it if changed
222 <     * pool-wide.
252 >     * Shadows value from ForkJoinPool.
253       */
254 <    private boolean locallyFifo;
254 >    private final boolean locallyFifo;
255  
256      /**
257       * Index of this worker in pool array. Set once by pool before
# Line 237 | Line 267 | public class ForkJoinWorkerThread extend
267      int lastEventCount;
268  
269      /**
270 <     * Encoded index and event count of next event waiter. Used only
271 <     * by ForkJoinPool for managing event waiters.
270 >     * Encoded index and event count of next event waiter. Accessed
271 >     * only by ForkJoinPool for managing event waiters.
272       */
273      volatile long nextWaiter;
274  
275      /**
276 +     * Number of times this thread suspended as spare. Accessed only
277 +     * by pool.
278 +     */
279 +    int spareCount;
280 +
281 +    /**
282 +     * Encoded index and count of next spare waiter. Accessed only
283 +     * by ForkJoinPool for managing spares.
284 +     */
285 +    volatile int nextSpare;
286 +
287 +    /**
288 +     * The task currently being joined, set only when actively trying
289 +     * to helpStealer. Written only by current thread, but read by
290 +     * others.
291 +     */
292 +    private volatile ForkJoinTask<?> currentJoin;
293 +
294 +    /**
295 +     * The task most recently stolen from another worker (or
296 +     * submission queue).  Written only by current thread, but read by
297 +     * others.
298 +     */
299 +    private volatile ForkJoinTask<?> currentSteal;
300 +
301 +    /**
302       * Creates a ForkJoinWorkerThread operating in the given pool.
303       *
304       * @param pool the pool this thread works in
305       * @throws NullPointerException if pool is null
306       */
307      protected ForkJoinWorkerThread(ForkJoinPool pool) {
252        if (pool == null) throw new NullPointerException();
308          this.pool = pool;
309 +        this.locallyFifo = pool.locallyFifo;
310 +        setDaemon(true);
311          // To avoid exposing construction details to subclasses,
312          // remaining initialization is in start() and onStart()
313      }
# Line 258 | Line 315 | public class ForkJoinWorkerThread extend
315      /**
316       * Performs additional initialization and starts this thread
317       */
318 <    final void start(int poolIndex, boolean locallyFifo,
262 <                     UncaughtExceptionHandler ueh) {
318 >    final void start(int poolIndex, UncaughtExceptionHandler ueh) {
319          this.poolIndex = poolIndex;
264        this.locallyFifo = locallyFifo;
320          if (ueh != null)
321              setUncaughtExceptionHandler(ueh);
267        setDaemon(true);
322          start();
323      }
324  
# Line 305 | Line 359 | public class ForkJoinWorkerThread extend
359          int rs = seedGenerator.nextInt();
360          seed = rs == 0? 1 : rs; // seed must be nonzero
361  
362 <        // Allocate name string and queue array in this thread
362 >        // Allocate name string and arrays in this thread
363          String pid = Integer.toString(pool.getPoolNumber());
364          String wid = Integer.toString(poolIndex);
365          setName("ForkJoinPool-" + pid + "-worker-" + wid);
# Line 323 | Line 377 | public class ForkJoinWorkerThread extend
377       */
378      protected void onTermination(Throwable exception) {
379          try {
380 +            ForkJoinPool p = pool;
381 +            if (active) {
382 +                int a; // inline p.tryDecrementActiveCount
383 +                active = false;
384 +                do {} while (!UNSAFE.compareAndSwapInt
385 +                             (p, poolRunStateOffset, a = p.runState, a - 1));
386 +            }
387              cancelTasks();
388              setTerminated();
389 <            pool.workerTerminated(this);
389 >            p.workerTerminated(this);
390          } catch (Throwable ex) {        // Shouldn't ever happen
391              if (exception == null)      // but if so, at least rethrown
392                  exception = ex;
# Line 358 | Line 419 | public class ForkJoinWorkerThread extend
419       * Find and execute tasks and check status while running
420       */
421      private void mainLoop() {
422 <        boolean ran = false;      // true if ran task in last loop iter
362 <        boolean prevRan = false;  // true if ran on last or previous step
422 >        boolean ran = false; // true if ran a task on last step
423          ForkJoinPool p = pool;
424          for (;;) {
425 <            p.preStep(this, prevRan);
425 >            p.preStep(this, ran);
426              if (runState != 0)
427 <                return;
428 <            ForkJoinTask<?> t; // try to get and run stolen or submitted task
369 <            if ((t = scan()) != null || (t = pollSubmission()) != null) {
370 <                t.tryExec();
371 <                if (base != sp)
372 <                    runLocalTasks();
373 <                prevRan = ran = true;
374 <            }
375 <            else {
376 <                prevRan = ran;
377 <                ran = false;
378 <            }
427 >                break;
428 >            ran = tryExecSteal() || tryExecSubmission();
429          }
430      }
431  
432      /**
433 <     * Runs local tasks until queue is empty or shut down.  Call only
434 <     * while active.
433 >     * Try to steal a task and execute it
434 >     *
435 >     * @return true if ran a task
436       */
437 <    private void runLocalTasks() {
438 <        while (runState == 0) {
439 <            ForkJoinTask<?> t = locallyFifo? locallyDeqTask() : popTask();
440 <            if (t != null)
441 <                t.tryExec();
442 <            else if (base == sp)
443 <                break;
437 >    private boolean tryExecSteal() {
438 >        ForkJoinTask<?> t;
439 >        if ((t = scan()) != null) {
440 >            t.quietlyExec();
441 >            UNSAFE.putOrderedObject(this, currentStealOffset, null);
442 >            if (sp != base)
443 >                execLocalTasks();
444 >            return true;
445          }
446 +        return false;
447      }
448  
449      /**
450 <     * If a submission exists, try to activate and take it
450 >     * If a submission exists, try to activate and run it;
451       *
452 <     * @return a task, if available
452 >     * @return true if ran a task
453       */
454 <    private ForkJoinTask<?> pollSubmission() {
454 >    private boolean tryExecSubmission() {
455          ForkJoinPool p = pool;
456          while (p.hasQueuedSubmissions()) {
457 <            if (active || (active = p.tryIncrementActiveCount())) {
458 <                ForkJoinTask<?> t = p.pollSubmission();
459 <                return t != null ? t : scan(); // if missed, rescan
457 >            ForkJoinTask<?> t; int a;
458 >            if (active || // inline p.tryIncrementActiveCount
459 >                (active = UNSAFE.compareAndSwapInt(p, poolRunStateOffset,
460 >                                                   a = p.runState, a + 1))) {
461 >                if ((t = p.pollSubmission()) != null) {
462 >                    UNSAFE.putOrderedObject(this, currentStealOffset, t);
463 >                    t.quietlyExec();
464 >                    UNSAFE.putOrderedObject(this, currentStealOffset, null);
465 >                    if (sp != base)
466 >                        execLocalTasks();
467 >                    return true;
468 >                }
469              }
470          }
471 <        return null;
471 >        return false;
472 >    }
473 >
474 >    /**
475 >     * Runs local tasks until queue is empty or shut down.  Call only
476 >     * while active.
477 >     */
478 >    private void execLocalTasks() {
479 >        while (runState == 0) {
480 >            ForkJoinTask<?> t = locallyFifo ? locallyDeqTask() : popTask();
481 >            if (t != null)
482 >                t.quietlyExec();
483 >            else if (sp == base)
484 >                break;
485 >        }
486      }
487  
488      /*
# Line 466 | Line 542 | public class ForkJoinWorkerThread extend
542      /**
543       * Tries to take a task from the base of the queue, failing if
544       * empty or contended. Note: Specializations of this code appear
545 <     * in scan and scanWhileJoining.
545 >     * in locallyDeqTask and elsewhere.
546       *
547       * @return a task, or null if none or contended
548       */
# Line 474 | Line 550 | public class ForkJoinWorkerThread extend
550          ForkJoinTask<?> t;
551          ForkJoinTask<?>[] q;
552          int b, i;
553 <        if ((b = base) != sp &&
553 >        if (sp != (b = base) &&
554              (q = queue) != null && // must read q after b
555 <            (t = q[i = (q.length - 1) & b]) != null &&
555 >            (t = q[i = (q.length - 1) & b]) != null && base == b &&
556              UNSAFE.compareAndSwapObject(q, (i << qShift) + qBase, t, null)) {
557              base = b + 1;
558              return t;
# Line 496 | Line 572 | public class ForkJoinWorkerThread extend
572              ForkJoinTask<?> t;
573              int b, i;
574              while (sp != (b = base)) {
575 <                if ((t = q[i = (q.length - 1) & b]) != null &&
575 >                if ((t = q[i = (q.length - 1) & b]) != null && base == b &&
576                      UNSAFE.compareAndSwapObject(q, (i << qShift) + qBase,
577                                                  t, null)) {
578                      base = b + 1;
# Line 509 | Line 585 | public class ForkJoinWorkerThread extend
585  
586      /**
587       * Returns a popped task, or null if empty. Assumes active status.
588 <     * Called only by current thread. (Note: a specialization of this
513 <     * code appears in popWhileJoining.)
588 >     * Called only by current thread.
589       */
590 <    final ForkJoinTask<?> popTask() {
591 <        int s;
592 <        ForkJoinTask<?>[] q;
593 <        if (base != (s = sp) && (q = queue) != null) {
594 <            int i = (q.length - 1) & --s;
595 <            ForkJoinTask<?> t = q[i];
596 <            if (t != null && UNSAFE.compareAndSwapObject
597 <                (q, (i << qShift) + qBase, t, null)) {
598 <                sp = s;
599 <                return t;
590 >    private ForkJoinTask<?> popTask() {
591 >        ForkJoinTask<?>[] q = queue;
592 >        if (q != null) {
593 >            int s;
594 >            while ((s = sp) != base) {
595 >                int i = (q.length - 1) & --s;
596 >                long u = (i << qShift) + qBase; // raw offset
597 >                ForkJoinTask<?> t = q[i];
598 >                if (t == null)   // lost to stealer
599 >                    break;
600 >                if (UNSAFE.compareAndSwapObject(q, u, t, null)) {
601 >                    sp = s; // putOrderedInt may encourage more timely write
602 >                    // UNSAFE.putOrderedInt(this, spOffset, s);
603 >                    return t;
604 >                }
605              }
606          }
607          return null;
# Line 536 | Line 616 | public class ForkJoinWorkerThread extend
616       */
617      final boolean unpushTask(ForkJoinTask<?> t) {
618          int s;
619 <        ForkJoinTask<?>[] q;
620 <        if (base != (s = sp) && (q = queue) != null &&
619 >        ForkJoinTask<?>[] q = queue;
620 >        if ((s = sp) != base && q != null &&
621              UNSAFE.compareAndSwapObject
622              (q, (((q.length - 1) & --s) << qShift) + qBase, t, null)) {
623 <            sp = s;
623 >            sp = s; // putOrderedInt may encourage more timely write
624 >            // UNSAFE.putOrderedInt(this, spOffset, s);
625              return true;
626          }
627          return false;
# Line 628 | Line 709 | public class ForkJoinWorkerThread extend
709              for (;;) {
710                  ForkJoinWorkerThread v = ws[k & mask];
711                  r ^= r << 13; r ^= r >>> 17; r ^= r << 5; // inline xorshift
712 <                if (v != null && v.base != v.sp) {
713 <                    int b, i;             // inline specialized deqTask
714 <                    ForkJoinTask<?>[] q;
715 <                    ForkJoinTask<?> t;
716 <                    if ((canSteal ||      // ensure active status
717 <                         (canSteal = active = p.tryIncrementActiveCount())) &&
718 <                        (q = v.queue) != null &&
719 <                        (t = q[i = (q.length - 1) & (b = v.base)]) != null &&
720 <                        UNSAFE.compareAndSwapObject
721 <                        (q, (i << qShift) + qBase, t, null)) {
722 <                        v.base = b + 1;
723 <                        seed = r;
724 <                        ++stealCount;
725 <                        return t;
712 >                ForkJoinTask<?>[] q; ForkJoinTask<?> t; int b, a;
713 >                if (v != null && (b = v.base) != v.sp &&
714 >                    (q = v.queue) != null) {
715 >                    int i = (q.length - 1) & b;
716 >                    long u = (i << qShift) + qBase; // raw offset
717 >                    int pid = poolIndex;
718 >                    if ((t = q[i]) != null) {
719 >                        if (!canSteal &&  // inline p.tryIncrementActiveCount
720 >                            UNSAFE.compareAndSwapInt(p, poolRunStateOffset,
721 >                                                     a = p.runState, a + 1))
722 >                            canSteal = active = true;
723 >                        if (canSteal && v.base == b++ &&
724 >                            UNSAFE.compareAndSwapObject(q, u, t, null)) {
725 >                            v.base = b;
726 >                            v.stealHint = pid;
727 >                            UNSAFE.putOrderedObject(this,
728 >                                                    currentStealOffset, t);
729 >                            seed = r;
730 >                            ++stealCount;
731 >                            return t;
732 >                        }
733                      }
734                      j = -n;
735                      k = r;                // restart on contention
# Line 660 | Line 748 | public class ForkJoinWorkerThread extend
748      // Run State management
749  
750      // status check methods used mainly by ForkJoinPool
751 +    final boolean isRunning()     { return runState == 0; }
752      final boolean isTerminating() { return (runState & TERMINATING) != 0; }
753      final boolean isTerminated()  { return (runState & TERMINATED) != 0; }
754      final boolean isSuspended()   { return (runState & SUSPENDED) != 0; }
755      final boolean isTrimmed()     { return (runState & TRIMMED) != 0; }
756  
757      /**
758 <     * Sets state to TERMINATING, also resuming if suspended.
758 >     * Sets state to TERMINATING. Does NOT unpark or interrupt
759 >     * to wake up if currently blocked. Callers must do so if desired.
760       */
761      final void shutdown() {
762          for (;;) {
763              int s = runState;
764 +            if ((s & (TERMINATING|TERMINATED)) != 0)
765 +                break;
766              if ((s & SUSPENDED) != 0) { // kill and wakeup if suspended
767                  if (UNSAFE.compareAndSwapInt(this, runStateOffset, s,
768                                               (s & ~SUSPENDED) |
769 <                                             (TRIMMED|TERMINATING))) {
678 <                    LockSupport.unpark(this);
769 >                                             (TRIMMED|TERMINATING)))
770                      break;
680                }
771              }
772              else if (UNSAFE.compareAndSwapInt(this, runStateOffset, s,
773                                                s | TERMINATING))
# Line 686 | Line 776 | public class ForkJoinWorkerThread extend
776      }
777  
778      /**
779 <     * Sets state to TERMINATED. Called only by this thread.
779 >     * Sets state to TERMINATED. Called only by onTermination()
780       */
781      private void setTerminated() {
782          int s;
# Line 696 | Line 786 | public class ForkJoinWorkerThread extend
786      }
787  
788      /**
699     * Instrumented version of park. Also used by ForkJoinPool.awaitEvent
700     */
701    final void doPark() {
702        ++parkCount;
703        LockSupport.park(this);
704    }
705
706    /**
789       * If suspended, tries to set status to unsuspended.
790 <     * Caller must unpark to actually resume
790 >     * Does NOT wake up if blocked.
791       *
792       * @return true if successful
793       */
794      final boolean tryUnsuspend() {
795          int s;
796 <        return (((s = runState) & SUSPENDED) != 0 &&
797 <                UNSAFE.compareAndSwapInt(this, runStateOffset, s,
798 <                                         s & ~SUSPENDED));
796 >        while (((s = runState) & SUSPENDED) != 0) {
797 >            if (UNSAFE.compareAndSwapInt(this, runStateOffset, s,
798 >                                         s & ~SUSPENDED))
799 >                return true;
800 >        }
801 >        return false;
802      }
803  
804      /**
805 <     * Sets suspended status and blocks as spare until resumed,
806 <     * shutdown, or timed out.
722 <     *
723 <     * @return false if trimmed
805 >     * Sets suspended status and blocks as spare until resumed
806 >     * or shutdown.
807       */
808 <    final boolean suspendAsSpare() {
809 <        for (;;) {               // set suspended unless terminating
808 >    final void suspendAsSpare() {
809 >        for (;;) {                  // set suspended unless terminating
810              int s = runState;
811              if ((s & TERMINATING) != 0) { // must kill
812                  if (UNSAFE.compareAndSwapInt(this, runStateOffset, s,
813                                               s | (TRIMMED | TERMINATING)))
814 <                    return false;
814 >                    return;
815              }
816              else if (UNSAFE.compareAndSwapInt(this, runStateOffset, s,
817                                                s | SUSPENDED))
818                  break;
819          }
737        lastEventCount = 0;      // reset upon resume
820          ForkJoinPool p = pool;
821 <        p.releaseWaiters();      // help others progress
740 <        p.accumulateStealCount(this);
741 <        interrupted();           // clear/ignore interrupts
742 <        if (poolIndex < p.getParallelism()) { // untimed wait
743 <            while ((runState & SUSPENDED) != 0)
744 <                doPark();
745 <            return true;
746 <        }
747 <        return timedSuspend();   // timed wait if apparently non-core
748 <    }
749 <
750 <    /**
751 <     * Blocks as spare until resumed or timed out
752 <     * @return false if trimmed
753 <     */
754 <    private boolean timedSuspend() {
755 <        long nanos = SPARE_KEEPALIVE_NANOS;
756 <        long startTime = System.nanoTime();
821 >        p.pushSpare(this);
822          while ((runState & SUSPENDED) != 0) {
823 <            ++parkCount;
824 <            if ((nanos -= (System.nanoTime() - startTime)) > 0)
825 <                LockSupport.parkNanos(this, nanos);
826 <            else { // try to trim on timeout
827 <                int s = runState;
763 <                if (UNSAFE.compareAndSwapInt(this, runStateOffset, s,
764 <                                             (s & ~SUSPENDED) |
765 <                                             (TRIMMED|TERMINATING)))
766 <                    return false;
823 >            if (p.tryAccumulateStealCount(this)) {
824 >                interrupted();          // clear/ignore interrupts
825 >                if ((runState & SUSPENDED) == 0)
826 >                    break;
827 >                LockSupport.park(this);
828              }
829          }
769        return true;
830      }
831  
832      // Misc support methods for ForkJoinPool
# Line 776 | Line 836 | public class ForkJoinWorkerThread extend
836       * used by ForkJoinTask.
837       */
838      final int getQueueSize() {
839 <        return -base + sp;
840 <    }
781 <
782 <    /**
783 <     * Set locallyFifo mode. Called only by ForkJoinPool
784 <     */
785 <    final void setAsyncMode(boolean async) {
786 <        locallyFifo = async;
839 >        int n; // external calls must read base first
840 >        return (n = -base + sp) <= 0 ? 0 : n;
841      }
842  
843      /**
# Line 791 | Line 845 | public class ForkJoinWorkerThread extend
845       * thread.
846       */
847      final void cancelTasks() {
848 +        ForkJoinTask<?> cj = currentJoin; // try to cancel ongoing tasks
849 +        if (cj != null) {
850 +            currentJoin = null;
851 +            cj.cancelIgnoringExceptions();
852 +            try {
853 +                this.interrupt(); // awaken wait
854 +            } catch (SecurityException ignore) {
855 +            }
856 +        }
857 +        ForkJoinTask<?> cs = currentSteal;
858 +        if (cs != null) {
859 +            currentSteal = null;
860 +            cs.cancelIgnoringExceptions();
861 +        }
862          while (base != sp) {
863              ForkJoinTask<?> t = deqTask();
864              if (t != null)
# Line 818 | Line 886 | public class ForkJoinWorkerThread extend
886      // Support methods for ForkJoinTask
887  
888      /**
889 +     * Gets and removes a local task.
890 +     *
891 +     * @return a task, if available
892 +     */
893 +    final ForkJoinTask<?> pollLocalTask() {
894 +        ForkJoinPool p = pool;
895 +        while (sp != base) {
896 +            int a; // inline p.tryIncrementActiveCount
897 +            if (active ||
898 +                (active = UNSAFE.compareAndSwapInt(p, poolRunStateOffset,
899 +                                                   a = p.runState, a + 1)))
900 +                return locallyFifo ? locallyDeqTask() : popTask();
901 +        }
902 +        return null;
903 +    }
904 +
905 +    /**
906 +     * Gets and removes a local or stolen task.
907 +     *
908 +     * @return a task, if available
909 +     */
910 +    final ForkJoinTask<?> pollTask() {
911 +        ForkJoinTask<?> t = pollLocalTask();
912 +        if (t == null) {
913 +            t = scan();
914 +            // cannot retain/track/help steal
915 +            UNSAFE.putOrderedObject(this, currentStealOffset, null);
916 +        }
917 +        return t;
918 +    }
919 +
920 +    /**
921 +     * Possibly runs some tasks and/or blocks, until task is done.
922 +     *
923 +     * @param joinMe the task to join
924 +     */
925 +    final void joinTask(ForkJoinTask<?> joinMe) {
926 +        // currentJoin only written by this thread; only need ordered store
927 +        ForkJoinTask<?> prevJoin = currentJoin;
928 +        UNSAFE.putOrderedObject(this, currentJoinOffset, joinMe);
929 +        if (sp != base)
930 +            localHelpJoinTask(joinMe);
931 +        if (joinMe.status >= 0)
932 +            pool.awaitJoin(joinMe, this);
933 +        UNSAFE.putOrderedObject(this, currentJoinOffset, prevJoin);
934 +    }
935 +
936 +    /**
937 +     * Run tasks in local queue until given task is done.
938 +     *
939 +     * @param joinMe the task to join
940 +     */
941 +    private void localHelpJoinTask(ForkJoinTask<?> joinMe) {
942 +        int s;
943 +        ForkJoinTask<?>[] q;
944 +        while (joinMe.status >= 0 && (s = sp) != base && (q = queue) != null) {
945 +            int i = (q.length - 1) & --s;
946 +            long u = (i << qShift) + qBase; // raw offset
947 +            ForkJoinTask<?> t = q[i];
948 +            if (t == null)  // lost to a stealer
949 +                break;
950 +            if (UNSAFE.compareAndSwapObject(q, u, t, null)) {
951 +                /*
952 +                 * This recheck (and similarly in helpJoinTask)
953 +                 * handles cases where joinMe is independently
954 +                 * cancelled or forced even though there is other work
955 +                 * available. Back out of the pop by putting t back
956 +                 * into slot before we commit by writing sp.
957 +                 */
958 +                if (joinMe.status < 0) {
959 +                    UNSAFE.putObjectVolatile(q, u, t);
960 +                    break;
961 +                }
962 +                sp = s;
963 +                // UNSAFE.putOrderedInt(this, spOffset, s);
964 +                t.quietlyExec();
965 +            }
966 +        }
967 +    }
968 +
969 +    /**
970 +     * Unless terminating, tries to locate and help perform tasks for
971 +     * a stealer of the given task, or in turn one of its stealers.
972 +     * Traces currentSteal->currentJoin links looking for a thread
973 +     * working on a descendant of the given task and with a non-empty
974 +     * queue to steal back and execute tasks from.
975 +     *
976 +     * The implementation is very branchy to cope with potential
977 +     * inconsistencies or loops encountering chains that are stale,
978 +     * unknown, or of length greater than MAX_HELP_DEPTH links.  All
979 +     * of these cases are dealt with by just returning back to the
980 +     * caller, who is expected to retry if other join mechanisms also
981 +     * don't work out.
982 +     *
983 +     * @param joinMe the task to join
984 +     */
985 +    final void helpJoinTask(ForkJoinTask<?> joinMe) {
986 +        ForkJoinWorkerThread[] ws;
987 +        int n;
988 +        if (joinMe.status < 0)                // already done
989 +            return;
990 +        if ((runState & TERMINATING) != 0) {  // cancel if shutting down
991 +            joinMe.cancelIgnoringExceptions();
992 +            return;
993 +        }
994 +        if ((ws = pool.workers) == null || (n = ws.length) <= 1)
995 +            return;                           // need at least 2 workers
996 +
997 +        ForkJoinTask<?> task = joinMe;        // base of chain
998 +        ForkJoinWorkerThread thread = this;   // thread with stolen task
999 +        for (int d = 0; d < MAX_HELP_DEPTH; ++d) { // chain length
1000 +            // Try to find v, the stealer of task, by first using hint
1001 +            ForkJoinWorkerThread v = ws[thread.stealHint & (n - 1)];
1002 +            if (v == null || v.currentSteal != task) {
1003 +                for (int j = 0; ; ++j) {      // search array
1004 +                    if (j < n) {
1005 +                        ForkJoinTask<?> vs;
1006 +                        if ((v = ws[j]) != null &&
1007 +                            (vs = v.currentSteal) != null) {
1008 +                            if (joinMe.status < 0 || task.status < 0)
1009 +                                return;       // stale or done
1010 +                            if (vs == task) {
1011 +                                thread.stealHint = j;
1012 +                                break;        // save hint for next time
1013 +                            }
1014 +                        }
1015 +                    }
1016 +                    else
1017 +                        return;               // no stealer
1018 +                }
1019 +            }
1020 +            for (;;) { // Try to help v, using specialized form of deqTask
1021 +                if (joinMe.status < 0)
1022 +                    return;
1023 +                int b = v.base;
1024 +                ForkJoinTask<?>[] q = v.queue;
1025 +                if (b == v.sp || q == null)
1026 +                    break;
1027 +                int i = (q.length - 1) & b;
1028 +                long u = (i << qShift) + qBase;
1029 +                ForkJoinTask<?> t = q[i];
1030 +                int pid = poolIndex;
1031 +                ForkJoinTask<?> ps = currentSteal;
1032 +                if (task.status < 0)
1033 +                    return;                   // stale or done
1034 +                if (t != null && v.base == b++ &&
1035 +                    UNSAFE.compareAndSwapObject(q, u, t, null)) {
1036 +                    if (joinMe.status < 0) {
1037 +                        UNSAFE.putObjectVolatile(q, u, t);
1038 +                        return;               // back out on cancel
1039 +                    }
1040 +                    v.base = b;
1041 +                    v.stealHint = pid;
1042 +                    UNSAFE.putOrderedObject(this, currentStealOffset, t);
1043 +                    t.quietlyExec();
1044 +                    UNSAFE.putOrderedObject(this, currentStealOffset, ps);
1045 +                }
1046 +            }
1047 +            // Try to descend to find v's stealer
1048 +            ForkJoinTask<?> next = v.currentJoin;
1049 +            if (task.status < 0 || next == null || next == task ||
1050 +                joinMe.status < 0)
1051 +                return;
1052 +            task = next;
1053 +            thread = v;
1054 +        }
1055 +    }
1056 +
1057 +    /**
1058       * Returns an estimate of the number of tasks, offset by a
1059       * function of number of idle workers.
1060       *
# Line 869 | Line 1106 | public class ForkJoinWorkerThread extend
1106      }
1107  
1108      /**
872     * Gets and removes a local task.
873     *
874     * @return a task, if available
875     */
876    final ForkJoinTask<?> pollLocalTask() {
877        while (base != sp) {
878            if (active || (active = pool.tryIncrementActiveCount()))
879                return locallyFifo? locallyDeqTask() : popTask();
880        }
881        return null;
882    }
883
884    /**
885     * Gets and removes a local or stolen task.
886     *
887     * @return a task, if available
888     */
889    final ForkJoinTask<?> pollTask() {
890        ForkJoinTask<?> t;
891        return (t = pollLocalTask()) != null ? t : scan();
892    }
893
894    /**
895     * Executes or processes other tasks awaiting the given task
896     * @return task completion status
897     */
898    final int execWhileJoining(ForkJoinTask<?> joinMe) {
899        int s;
900        while ((s = joinMe.status) >= 0) {
901            ForkJoinTask<?> t = base != sp?
902                popWhileJoining(joinMe) :
903                scanWhileJoining(joinMe);
904            if (t != null)
905                t.tryExec();
906        }
907        return s;
908    }
909
910    /**
911     * Returns or stolen task, if available, unless joinMe is done
912     *
913     * This method is intrinsically nonmodular. To maintain the
914     * property that tasks are never stolen if the awaited task is
915     * ready, we must interleave mechanics of scan with status
916     * checks. We rely here on the commit points of deq that allow us
917     * to cancel a steal even after CASing slot to null, but before
918     * adjusting base index: If, after the CAS, we see that joinMe is
919     * ready, we can back out by placing the task back into the slot,
920     * without adjusting index. The loop is otherwise a variant of the
921     * one in scan().
922     *
923     */
924    private ForkJoinTask<?> scanWhileJoining(ForkJoinTask<?> joinMe) {
925        int r = seed;
926        ForkJoinPool p = pool;
927        ForkJoinWorkerThread[] ws;
928        int n;
929        outer:while ((ws = p.workers) != null && (n = ws.length) > 1) {
930            int mask = n - 1;
931            int k = r;
932            boolean contended = false; // to retry loop if deq contends
933            for (int j = -n; j <= n; ++j) {
934                if (joinMe.status < 0)
935                    break outer;
936                int b;
937                ForkJoinTask<?>[] q;
938                ForkJoinWorkerThread v = ws[k & mask];
939                r ^= r << 13; r ^= r >>> 17; r ^= r << 5; // xorshift
940                if (v != null && (b=v.base) != v.sp && (q=v.queue) != null) {
941                    int i = (q.length - 1) & b;
942                    ForkJoinTask<?> t = q[i];
943                    if (t != null && UNSAFE.compareAndSwapObject
944                        (q, (i << qShift) + qBase, t, null)) {
945                        if (joinMe.status >= 0) {
946                            v.base = b + 1;
947                            seed = r;
948                            ++stealCount;
949                            return t;
950                        }
951                        UNSAFE.putObjectVolatile(q, (i<<qShift)+qBase, t);
952                        break outer; // back out
953                    }
954                    contended = true;
955                }
956                k = j < 0 ? r : (k + ((n >>> 1) | 1));
957            }
958            if (!contended && p.tryAwaitBusyJoin(joinMe))
959                break;
960        }
961        return null;
962    }
963
964    /**
965     * Version of popTask with join checks surrounding extraction.
966     * Uses the same backout strategy as helpJoinTask. Note that
967     * we ignore locallyFifo flag for local tasks here since helping
968     * joins only make sense in LIFO mode.
969     *
970     * @return a popped task, if available, unless joinMe is done
971     */
972    private ForkJoinTask<?> popWhileJoining(ForkJoinTask<?> joinMe) {
973        int s;
974        ForkJoinTask<?>[] q;
975        while ((s = sp) != base && (q = queue) != null && joinMe.status >= 0) {
976            int i = (q.length - 1) & --s;
977            ForkJoinTask<?> t = q[i];
978            if (t != null && UNSAFE.compareAndSwapObject
979                (q, (i << qShift) + qBase, t, null)) {
980                if (joinMe.status >= 0) {
981                    sp = s;
982                    return t;
983                }
984                UNSAFE.putObjectVolatile(q, (i << qShift) + qBase, t);
985                break;  // back out
986            }
987        }
988        return null;
989    }
990
991    /**
1109       * Runs tasks until {@code pool.isQuiescent()}.
1110       */
1111      final void helpQuiescePool() {
1112 +        ForkJoinTask<?> ps = currentSteal; // to restore below
1113          for (;;) {
1114              ForkJoinTask<?> t = pollLocalTask();
1115              if (t != null || (t = scan()) != null)
1116 <                t.tryExec();
1116 >                t.quietlyExec();
1117              else {
1118                  ForkJoinPool p = pool;
1119 +                int a; // to inline CASes
1120                  if (active) {
1121 +                    if (!UNSAFE.compareAndSwapInt
1122 +                        (p, poolRunStateOffset, a = p.runState, a - 1))
1123 +                        continue;   // retry later
1124                      active = false; // inactivate
1125 <                    do {} while (!p.tryDecrementActiveCount());
1125 >                    UNSAFE.putOrderedObject(this, currentStealOffset, ps);
1126                  }
1127                  if (p.isQuiescent()) {
1128                      active = true; // re-activate
1129 <                    do {} while (!p.tryIncrementActiveCount());
1129 >                    do {} while (!UNSAFE.compareAndSwapInt
1130 >                                 (p, poolRunStateOffset, a = p.runState, a+1));
1131                      return;
1132                  }
1133              }
# Line 1014 | Line 1137 | public class ForkJoinWorkerThread extend
1137      // Unsafe mechanics
1138  
1139      private static final sun.misc.Unsafe UNSAFE = getUnsafe();
1140 +    private static final long spOffset =
1141 +        objectFieldOffset("sp", ForkJoinWorkerThread.class);
1142      private static final long runStateOffset =
1143          objectFieldOffset("runState", ForkJoinWorkerThread.class);
1144 +    private static final long currentJoinOffset =
1145 +        objectFieldOffset("currentJoin", ForkJoinWorkerThread.class);
1146 +    private static final long currentStealOffset =
1147 +        objectFieldOffset("currentSteal", ForkJoinWorkerThread.class);
1148      private static final long qBase =
1149          UNSAFE.arrayBaseOffset(ForkJoinTask[].class);
1150 +    private static final long poolRunStateOffset = // to inline CAS
1151 +        objectFieldOffset("runState", ForkJoinPool.class);
1152 +
1153      private static final int qShift;
1154  
1155      static {

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines