--- jsr166/src/jsr166y/Phaser.java 2008/07/07 16:53:30 1.1 +++ jsr166/src/jsr166y/Phaser.java 2010/12/01 17:20:41 1.65 @@ -5,691 +5,1085 @@ */ package jsr166y; -import jsr166y.forkjoin.*; -import java.util.concurrent.*; -import java.util.concurrent.atomic.*; + +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; +import java.util.concurrent.atomic.AtomicReference; import java.util.concurrent.locks.LockSupport; /** - * A reusable synchronization barrier, similar in functionality to a - * {@link java.util.concurrent.CyclicBarrier}, but supporting more - * flexible usage. + * A reusable synchronization barrier, similar in functionality to + * {@link java.util.concurrent.CyclicBarrier CyclicBarrier} and + * {@link java.util.concurrent.CountDownLatch CountDownLatch} + * but supporting more flexible usage. * - * + *

Monitoring. While synchronization methods may be invoked + * only by registered parties, the current state of a phaser may be + * monitored by any caller. At any given moment there are {@link + * #getRegisteredParties} parties in total, of which {@link + * #getArrivedParties} have arrived at the current phase ({@link + * #getPhase}). When the remaining ({@link #getUnarrivedParties}) + * parties arrive, the phase advances. The values returned by these + * methods may reflect transient states and so are not in general + * useful for synchronization control. Method {@link #toString} + * returns snapshots of these state queries in a form convenient for + * informal monitoring. + * + *

Sample usages: + * + *

A {@code Phaser} may be used instead of a {@code CountDownLatch} + * to control a one-shot action serving a variable number of parties. + * The typical idiom is for the method setting this up to first + * register, then start the actions, then deregister, as in: + * + *

 {@code
+ * void runTasks(List tasks) {
+ *   final Phaser phaser = new Phaser(1); // "1" to register self
+ *   // create and start threads
+ *   for (Runnable task : tasks) {
+ *     phaser.register();
+ *     new Thread() {
+ *       public void run() {
+ *         phaser.arriveAndAwaitAdvance(); // await all creation
+ *         task.run();
+ *       }
+ *     }.start();
+ *   }
+ *
+ *   // allow threads to start and deregister self
+ *   phaser.arriveAndDeregister();
+ * }}
+ * + *

One way to cause a set of threads to repeatedly perform actions + * for a given number of iterations is to override {@code onAdvance}: + * + *

 {@code
+ * void startTasks(List tasks, final int iterations) {
+ *   final Phaser phaser = new Phaser() {
+ *     protected boolean onAdvance(int phase, int registeredParties) {
+ *       return phase >= iterations || registeredParties == 0;
+ *     }
+ *   };
+ *   phaser.register();
+ *   for (final Runnable task : tasks) {
+ *     phaser.register();
+ *     new Thread() {
+ *       public void run() {
+ *         do {
+ *           task.run();
+ *           phaser.arriveAndAwaitAdvance();
+ *         } while (!phaser.isTerminated());
+ *       }
+ *     }.start();
+ *   }
+ *   phaser.arriveAndDeregister(); // deregister self, don't wait
+ * }}
* - *

Sample usage: + * If the main task must later await termination, it + * may re-register and then execute a similar loop: + *

 {@code
+ *   // ...
+ *   phaser.register();
+ *   while (!phaser.isTerminated())
+ *     phaser.arriveAndAwaitAdvance();}
* - *

[todo: non-FJ example] + *

Related constructions may be used to await particular phase numbers + * in contexts where you are sure that the phase will never wrap around + * {@code Integer.MAX_VALUE}. For example: * - *

A Phaser may be used to support a style of programming in - * which a task waits for others to complete, without otherwise - * needing to keep track of which tasks it is waiting for. This is - * similar to the "sync" construct in Cilk and "clocks" in X10. - * Special constructions based on such barriers are available using - * the LinkedAsyncAction and CyclicAction classes, - * but they can be useful in other contexts as well. For a simple - * (but not very useful) example, here is a variant of Fibonacci: - * - *

- * class BarrierFibonacci extends RecursiveAction {
- *   int argument, result;
- *   final Phaser parentBarrier;
- *   BarrierFibonacci(int n, Phaser parentBarrier) {
- *     this.argument = n;
- *     this.parentBarrier = parentBarrier;
- *     parentBarrier.register();
+ *  
 {@code
+ * void awaitPhase(Phaser phaser, int phase) {
+ *   int p = phaser.register(); // assumes caller not already registered
+ *   while (p < phase) {
+ *     if (phaser.isTerminated())
+ *       // ... deal with unexpected termination
+ *     else
+ *       p = phaser.arriveAndAwaitAdvance();
  *   }
- *   protected void compute() {
- *     int n = argument;
- *     if (n <= 1)
- *        result = n;
- *     else {
- *        Phaser childBarrier = new Phaser(1);
- *        BarrierFibonacci f1 = new BarrierFibonacci(n - 1, childBarrier);
- *        BarrierFibonacci f2 = new BarrierFibonacci(n - 2, childBarrier);
- *        f1.fork();
- *        f2.fork();
- *        childBarrier.arriveAndAwait();
- *        result = f1.result + f2.result;
+ *   phaser.arriveAndDeregister();
+ * }}
+ * + * + *

To create a set of {@code n} tasks using a tree of phasers, you + * could use code of the following form, assuming a Task class with a + * constructor accepting a {@code Phaser} that it registers with upon + * construction. After invocation of {@code build(new Task[n], 0, n, + * new Phaser())}, these tasks could then be started, for example by + * submitting to a pool: + * + *

 {@code
+ * void build(Task[] tasks, int lo, int hi, Phaser ph) {
+ *   if (hi - lo > TASKS_PER_PHASER) {
+ *     for (int i = lo; i < hi; i += TASKS_PER_PHASER) {
+ *       int j = Math.min(i + TASKS_PER_PHASER, hi);
+ *       build(tasks, i, j, new Phaser(ph));
  *     }
- *     parentBarrier.arriveAndDeregister();
+ *   } else {
+ *     for (int i = lo; i < hi; ++i)
+ *       tasks[i] = new Task(ph);
+ *       // assumes new Task(ph) performs ph.register()
  *   }
- * }
- * 
+ * }}
+ * + * The best value of {@code TASKS_PER_PHASER} depends mainly on + * expected synchronization rates. A value as low as four may + * be appropriate for extremely small per-phase task bodies (thus + * high rates), or up to hundreds for extremely large ones. * *

Implementation notes: This implementation restricts the - * maximum number of parties to 65535. Attempts to register - * additional parties result in IllegalStateExceptions. + * maximum number of parties to 65535. Attempts to register additional + * parties result in {@code IllegalStateException}. However, you can and + * should create tiered phasers to accommodate arbitrarily large sets + * of participants. + * + * @since 1.7 + * @author Doug Lea */ public class Phaser { /* * This class implements an extension of X10 "clocks". Thanks to - * Vijay Saraswat for the idea of applying it to ForkJoinTasks, - * and to Vivek Sarkar for enhancements to extend functionality. + * Vijay Saraswat for the idea, and to Vivek Sarkar for + * enhancements to extend functionality. */ /** - * Barrier state representation. Conceptually, a barrier contains - * four values: - * - * * parties -- the number of parties to wait (16 bits) - * * unarrived -- the number of parties yet to hit barrier (16 bits) - * * phase -- the generation of the barrier (31 bits) - * * terminated -- set if barrier is terminated (1 bit) + * Primary state representation, holding four fields: * - * However, to efficiently maintain atomicity, these values are - * packed into a single AtomicLong. Termination uses the sign bit - * of 32 bit representation of phase, so phase is set to -1 on - * termination. - */ - private final AtomicLong state; - - /** - * Head of Treiber stack for waiting nonFJ threads. - */ - private final AtomicReference head = new AtomicReference(); + * * unarrived -- the number of parties yet to hit barrier (bits 0-15) + * * parties -- the number of parties to wait (bits 16-31) + * * phase -- the generation of the barrier (bits 32-62) + * * terminated -- set if barrier is terminated (bit 63 / sign) + * + * Except that a phaser with no registered parties is + * distinguished with the otherwise illegal state of having zero + * parties and one unarrived parties (encoded as EMPTY below). + * + * To efficiently maintain atomicity, these values are packed into + * a single (atomic) long. Good performance relies on keeping + * state decoding and encoding simple, and keeping race windows + * short. + * + * All state updates are performed via CAS except initial + * registration of a sub-phaser (i.e., one with a non-null + * parent). In this (relatively rare) case, we use built-in + * synchronization to lock while first registering with its + * parent. + * + * The phase of a subphaser is allowed to lag that of its + * ancestors until it is actually accessed. Method reconcileState + * is usually attempted only only when the number of unarrived + * parties appears to be zero, which indicates a potential lag in + * updating phase after the root advanced. + */ + private volatile long state; + + private static final int MAX_PARTIES = 0xffff; + private static final int MAX_PHASE = 0x7fffffff; + private static final int PARTIES_SHIFT = 16; + private static final int PHASE_SHIFT = 32; + private static final int UNARRIVED_MASK = 0xffff; // to mask ints + private static final long PARTIES_MASK = 0xffff0000L; // to mask longs + private static final long TERMINATION_BIT = 1L << 63; + + // some special values + private static final int ONE_ARRIVAL = 1; + private static final int ONE_PARTY = 1 << PARTIES_SHIFT; + private static final int EMPTY = 1; - private static final int ushortBits = 16; - private static final int ushortMask = (1 << ushortBits) - 1; - private static final int phaseMask = 0x7fffffff; + // The following unpacking methods are usually manually inlined private static int unarrivedOf(long s) { - return (int)(s & ushortMask); + int counts = (int)s; + return (counts == EMPTY)? 0 : counts & UNARRIVED_MASK; } private static int partiesOf(long s) { - return (int)(s & (ushortMask << 16)) >>> 16; + int counts = (int)s; + return (counts == EMPTY)? 0 : counts >>> PARTIES_SHIFT; } private static int phaseOf(long s) { - return (int)(s >>> 32); + return (int) (s >>> PHASE_SHIFT); } private static int arrivedOf(long s) { - return partiesOf(s) - unarrivedOf(s); + int counts = (int)s; + return (counts == EMPTY)? 0 : + (counts >>> PARTIES_SHIFT) - (counts & UNARRIVED_MASK); + } + + /** + * The parent of this phaser, or null if none + */ + private final Phaser parent; + + /** + * The root of phaser tree. Equals this if not in a tree. + */ + private final Phaser root; + + /** + * Heads of Treiber stacks for waiting threads. To eliminate + * contention when releasing some threads while adding others, we + * use two of them, alternating across even and odd phases. + * Subphasers share queues with root to speed up releases. + */ + private final AtomicReference evenQ; + private final AtomicReference oddQ; + + private AtomicReference queueFor(int phase) { + return ((phase & 1) == 0) ? evenQ : oddQ; + } + + /** + * Returns message string for bounds exceptions on arrival. + */ + private String badArrive(long s) { + return "Attempted arrival of unregistered party for " + + stateToString(s); + } + + /** + * Returns message string for bounds exceptions on registration. + */ + private String badRegister(long s) { + return "Attempt to register more than " + + MAX_PARTIES + " parties for " + stateToString(s); + } + + /** + * Main implementation for methods arrive and arriveAndDeregister. + * Manually tuned to speed up and minimize race windows for the + * common case of just decrementing unarrived field. + * + * @param deregister false for arrive, true for arriveAndDeregister + */ + private int doArrive(boolean deregister) { + int adj = deregister ? ONE_ARRIVAL|ONE_PARTY : ONE_ARRIVAL; + long s; + int phase; + while ((phase = (int)((s = state) >>> PHASE_SHIFT)) >= 0) { + int counts = (int)s; + int unarrived = counts & UNARRIVED_MASK; + if (counts == EMPTY || unarrived == 0) { + if (reconcileState() == s) + throw new IllegalStateException(badArrive(s)); + } + else if (UNSAFE.compareAndSwapLong(this, stateOffset, s, s-=adj)) { + if (unarrived == 1) { + long n = s & PARTIES_MASK; // unshifted parties field + int u = ((int)n) >>> PARTIES_SHIFT; + Phaser par = parent; + if (par != null) { + par.doArrive(u == 0); + reconcileState(); + } + else { + n |= (((long)((phase+1) & MAX_PHASE)) << PHASE_SHIFT); + if (onAdvance(phase, u)) + n |= TERMINATION_BIT; + else if (u == 0) + n |= EMPTY; // reset to unregistered + else + n |= (long)u; // reset unarr to parties + // assert state == s || isTerminated(); + UNSAFE.compareAndSwapLong(this, stateOffset, s, n); + releaseWaiters(phase); + } + } + break; + } + } + return phase; } - private static long stateFor(int phase, int parties, int unarrived) { - return (((long)phase) << 32) | ((parties << 16) | unarrived); + /** + * Implementation of register, bulkRegister + * + * @param registrations number to add to both parties and + * unarrived fields. Must be greater than zero. + */ + private int doRegister(int registrations) { + // adjustment to state + long adj = ((long)registrations << PARTIES_SHIFT) | registrations; + Phaser par = parent; + int phase; + for (;;) { + long s = state; + int counts = (int)s; + int parties = counts >>> PARTIES_SHIFT; + int unarrived = counts & UNARRIVED_MASK; + if (registrations > MAX_PARTIES - parties) + throw new IllegalStateException(badRegister(s)); + else if ((phase = (int)(s >>> PHASE_SHIFT)) < 0) + break; + else if (counts != EMPTY) { // not 1st registration + if (par == null || reconcileState() == s) { + if (unarrived == 0) // wait out advance + root.internalAwaitAdvance(phase, null); + else if (UNSAFE.compareAndSwapLong(this, stateOffset, + s, s + adj)) + break; + } + } + else if (par == null) { // 1st root registration + long next = (((long) phase) << PHASE_SHIFT) | adj; + if (UNSAFE.compareAndSwapLong(this, stateOffset, s, next)) + break; + } + else { + synchronized(this) { // 1st sub registration + if (state == s) { // recheck under lock + par.doRegister(1); + do { // force current phase + phase = (int)(root.state >>> PHASE_SHIFT); + // assert phase < 0 || (int)state == EMPTY; + } while (!UNSAFE.compareAndSwapLong + (this, stateOffset, state, + (((long) phase) << PHASE_SHIFT) | adj)); + break; + } + } + } + } + return phase; } - private static IllegalStateException badBounds(int parties, int unarrived) { - return new IllegalStateException("Attempt to set " + unarrived + - " unarrived of " + parties + " parties"); + /** + * Resolves lagged phase propagation from root if necessary. + */ + private long reconcileState() { + Phaser rt = root; + long s = state; + if (rt != this) { + int phase; + while ((phase = (int)(rt.state >>> PHASE_SHIFT)) != + (int)(s >>> PHASE_SHIFT)) { + // assert phase < 0 || unarrivedOf(s) == 0 + long t; // to reread s + long p = s & PARTIES_MASK; // unshifted parties field + long n = (((long) phase) << PHASE_SHIFT) | p; + if (phase >= 0) { + if (p == 0L) + n |= EMPTY; // reset to empty + else + n |= p >>> PARTIES_SHIFT; // set unarr to parties + } + if ((t = state) == s && + UNSAFE.compareAndSwapLong(this, stateOffset, s, s = n)) + break; + s = t; + } + } + return s; } /** - * Creates a new Phaser without any initially registered parties, - * and initial phase number 0. + * Creates a new phaser with no initially registered parties, no + * parent, and initial phase number 0. Any thread using this + * phaser will need to first register for it. */ public Phaser() { - state = new AtomicLong(stateFor(0, 0, 0)); + this(null, 0); } /** - * Creates a new Phaser with the given numbers of registered - * unarrived parties and initial phase number 0. - * @param parties the number of parties required to trip barrier. + * Creates a new phaser with the given number of registered + * unarrived parties, no parent, and initial phase number 0. + * + * @param parties the number of parties required to advance to the + * next phase * @throws IllegalArgumentException if parties less than zero - * or greater than the maximum number of parties supported. + * or greater than the maximum number of parties supported */ public Phaser(int parties) { - if (parties < 0 || parties > ushortMask) + this(null, parties); + } + + /** + * Equivalent to {@link #Phaser(Phaser, int) Phaser(parent, 0)}. + * + * @param parent the parent phaser + */ + public Phaser(Phaser parent) { + this(parent, 0); + } + + /** + * Creates a new phaser with the given parent and number of + * registered unarrived parties. Registration and deregistration + * of this child phaser with its parent are managed automatically. + * If the given parent is non-null, whenever this child phaser has + * any registered parties (as established in this constructor, + * {@link #register}, or {@link #bulkRegister}), this child phaser + * is registered with its parent. Whenever the number of + * registered parties becomes zero as the result of an invocation + * of {@link #arriveAndDeregister}, this child phaser is + * deregistered from its parent. + * + * @param parent the parent phaser + * @param parties the number of parties required to advance to the + * next phase + * @throws IllegalArgumentException if parties less than zero + * or greater than the maximum number of parties supported + */ + public Phaser(Phaser parent, int parties) { + if (parties >>> PARTIES_SHIFT != 0) throw new IllegalArgumentException("Illegal number of parties"); - state = new AtomicLong(stateFor(0, parties, parties)); + int phase = 0; + this.parent = parent; + if (parent != null) { + Phaser r = parent.root; + this.root = r; + this.evenQ = r.evenQ; + this.oddQ = r.oddQ; + if (parties != 0) + phase = parent.doRegister(1); + } + else { + this.root = this; + this.evenQ = new AtomicReference(); + this.oddQ = new AtomicReference(); + } + this.state = (parties == 0)? ((long) EMPTY) : + ((((long) phase) << PHASE_SHIFT) | + (((long) parties) << PARTIES_SHIFT) | + ((long) parties)); } /** - * Adds a new unarrived party to this phaser. - * @return the current barrier phase number upon registration + * Adds a new unarrived party to this phaser. If an ongoing + * invocation of {@link #onAdvance} is in progress, this method + * may await its completion before returning. If this phaser has + * a parent, and this phaser previously had no registered parties, + * this phaser is also registered with its parent. + * + * @return the arrival phase number to which this registration applied * @throws IllegalStateException if attempting to register more - * than the maximum supported number of parties. + * than the maximum supported number of parties */ - public int register() { // increment both parties and unarrived - final AtomicLong state = this.state; - for (;;) { - long s = state.get(); - int phase = phaseOf(s); - int parties = partiesOf(s) + 1; - int unarrived = unarrivedOf(s) + 1; - if (parties > ushortMask || unarrived > ushortMask) - throw badBounds(parties, unarrived); - if (state.compareAndSet(s, stateFor(phase, parties, unarrived))) - return phase; - } + public int register() { + return doRegister(1); } /** - * Arrives at the barrier, but does not wait for others. (You can - * in turn wait for others via {@link #awaitAdvance}). + * Adds the given number of new unarrived parties to this phaser. + * If an ongoing invocation of {@link #onAdvance} is in progress, + * this method may await its completion before returning. If this + * phaser has a parent, and the given number of parities is + * greater than zero, and this phaser previously had no registered + * parties, this phaser is also registered with its parent. * - * @return the current barrier phase number upon entry to - * this method, or a negative value if terminated; - * @throws IllegalStateException if the number of unarrived - * parties would become negative. + * @param parties the number of additional parties required to + * advance to the next phase + * @return the arrival phase number to which this registration applied + * @throws IllegalStateException if attempting to register more + * than the maximum supported number of parties + * @throws IllegalArgumentException if {@code parties < 0} */ - public int arrive() { // decrement unarrived. If zero, trip - final AtomicLong state = this.state; - for (;;) { - long s = state.get(); - int phase = phaseOf(s); - int parties = partiesOf(s); - int unarrived = unarrivedOf(s) - 1; - if (unarrived < 0) - throw badBounds(parties, unarrived); - if (unarrived == 0 && phase >= 0) { - trip(phase, parties); - return phase; - } - if (state.compareAndSet(s, stateFor(phase, parties, unarrived))) - return phase; - } + public int bulkRegister(int parties) { + if (parties < 0) + throw new IllegalArgumentException(); + if (parties == 0) + return getPhase(); + return doRegister(parties); } /** - * Arrives at the barrier, and deregisters from it, without - * waiting for others. + * Arrives at this phaser, without waiting for others to arrive. + * + *

It is a usage error for an unregistered party to invoke this + * method. However, this error may result in an {@code + * IllegalStateException} only upon some subsequent operation on + * this phaser, if ever. * - * @return the current barrier phase number upon entry to - * this method, or a negative value if terminated; - * @throws IllegalStateException if the number of registered or - * unarrived parties would become negative. + * @return the arrival phase number, or a negative value if terminated + * @throws IllegalStateException if not terminated and the number + * of unarrived parties would become negative */ - public int arriveAndDeregister() { // Same as arrive, plus decrement parties - final AtomicLong state = this.state; - for (;;) { - long s = state.get(); - int phase = phaseOf(s); - int parties = partiesOf(s) - 1; - int unarrived = unarrivedOf(s) - 1; - if (parties < 0 || unarrived < 0) - throw badBounds(parties, unarrived); - if (unarrived == 0 && phase >= 0) { - trip(phase, parties); - return phase; - } - if (state.compareAndSet(s, stateFor(phase, parties, unarrived))) - return phase; - } + public int arrive() { + return doArrive(false); + } + + /** + * Arrives at this phaser and deregisters from it without waiting + * for others to arrive. Deregistration reduces the number of + * parties required to advance in future phases. If this phaser + * has a parent, and deregistration causes this phaser to have + * zero parties, this phaser is also deregistered from its parent. + * + *

It is a usage error for an unregistered party to invoke this + * method. However, this error may result in an {@code + * IllegalStateException} only upon some subsequent operation on + * this phaser, if ever. + * + * @return the arrival phase number, or a negative value if terminated + * @throws IllegalStateException if not terminated and the number + * of registered or unarrived parties would become negative + */ + public int arriveAndDeregister() { + return doArrive(true); } /** - * Arrives at the barrier and awaits others. Unlike other arrival - * methods, this method returns the arrival index of the - * caller. The caller tripping the barrier returns zero, the - * previous caller 1, and so on. - * @return the arrival index - * @throws IllegalStateException if the number of unarrived - * parties would become negative. + * Arrives at this phaser and awaits others. Equivalent in effect + * to {@code awaitAdvance(arrive())}. If you need to await with + * interruption or timeout, you can arrange this with an analogous + * construction using one of the other forms of the {@code + * awaitAdvance} method. If instead you need to deregister upon + * arrival, use {@code awaitAdvance(arriveAndDeregister())}. + * + *

It is a usage error for an unregistered party to invoke this + * method. However, this error may result in an {@code + * IllegalStateException} only upon some subsequent operation on + * this phaser, if ever. + * + * @return the arrival phase number, or a negative number if terminated + * @throws IllegalStateException if not terminated and the number + * of unarrived parties would become negative */ public int arriveAndAwaitAdvance() { - final AtomicLong state = this.state; - for (;;) { - long s = state.get(); - int phase = phaseOf(s); - int parties = partiesOf(s); - int unarrived = unarrivedOf(s) - 1; - if (unarrived < 0) - throw badBounds(parties, unarrived); - if (unarrived == 0 && phase >= 0) { - trip(phase, parties); - return 0; - } - if (state.compareAndSet(s, stateFor(phase, parties, unarrived))) { - awaitAdvance(phase); - return unarrived; - } - } + return awaitAdvance(doArrive(false)); } /** - * Awaits the phase of the barrier to advance from the given - * value, or returns immediately if this barrier is terminated - * @param phase the phase on entry to this method - * @return the phase on exit from this method + * Awaits the phase of this phaser to advance from the given phase + * value, returning immediately if the current phase is not equal + * to the given phase value or this phaser is terminated. + * + * @param phase an arrival phase number, or negative value if + * terminated; this argument is normally the value returned by a + * previous call to {@code arrive} or {@code arriveAndDeregister}. + * @return the next arrival phase number, or a negative value + * if terminated or argument is negative */ public int awaitAdvance(int phase) { + Phaser rt; + int p = (int)(state >>> PHASE_SHIFT); if (phase < 0) return phase; - Thread current = Thread.currentThread(); - if (current instanceof ForkJoinWorkerThread) - return helpingWait(phase); - if (untimedWait(current, phase, false)) - current.interrupt(); - return phaseOf(state.get()); + if (p == phase) { + if ((p = (int)((rt = root).state >>> PHASE_SHIFT)) == phase) + return rt.internalAwaitAdvance(phase, null); + reconcileState(); + } + return p; } /** - * Awaits the phase of the barrier to advance from the given - * value, or returns immediately if this barrier is terminated, or - * throws InterruptedException if interrupted while waiting. - * @param phase the phase on entry to this method - * @return the phase on exit from this method + * Awaits the phase of this phaser to advance from the given phase + * value, throwing {@code InterruptedException} if interrupted + * while waiting, or returning immediately if the current phase is + * not equal to the given phase value or this phaser is + * terminated. + * + * @param phase an arrival phase number, or negative value if + * terminated; this argument is normally the value returned by a + * previous call to {@code arrive} or {@code arriveAndDeregister}. + * @return the next arrival phase number, or a negative value + * if terminated or argument is negative * @throws InterruptedException if thread interrupted while waiting */ - public int awaitAdvanceInterruptibly(int phase) throws InterruptedException { + public int awaitAdvanceInterruptibly(int phase) + throws InterruptedException { + Phaser rt; + int p = (int)(state >>> PHASE_SHIFT); if (phase < 0) return phase; - Thread current = Thread.currentThread(); - if (current instanceof ForkJoinWorkerThread) - return helpingWait(phase); - else if (Thread.interrupted() || untimedWait(current, phase, true)) - throw new InterruptedException(); - else - return phaseOf(state.get()); + if (p == phase) { + if ((p = (int)((rt = root).state >>> PHASE_SHIFT)) == phase) { + QNode node = new QNode(this, phase, true, false, 0L); + p = rt.internalAwaitAdvance(phase, node); + if (node.wasInterrupted) + throw new InterruptedException(); + } + else + reconcileState(); + } + return p; } /** - * Awaits the phase of the barrier to advance from the given value - * or the given timeout elapses, or returns immediately if this - * barrier is terminated - * @param phase the phase on entry to this method - * @return the phase on exit from this method + * Awaits the phase of this phaser to advance from the given phase + * value or the given timeout to elapse, throwing {@code + * InterruptedException} if interrupted while waiting, or + * returning immediately if the current phase is not equal to the + * given phase value or this phaser is terminated. + * + * @param phase an arrival phase number, or negative value if + * terminated; this argument is normally the value returned by a + * previous call to {@code arrive} or {@code arriveAndDeregister}. + * @param timeout how long to wait before giving up, in units of + * {@code unit} + * @param unit a {@code TimeUnit} determining how to interpret the + * {@code timeout} parameter + * @return the next arrival phase number, or a negative value + * if terminated or argument is negative * @throws InterruptedException if thread interrupted while waiting * @throws TimeoutException if timed out while waiting */ - public int awaitAdvanceInterruptibly(int phase, long timeout, TimeUnit unit) + public int awaitAdvanceInterruptibly(int phase, + long timeout, TimeUnit unit) throws InterruptedException, TimeoutException { + long nanos = unit.toNanos(timeout); + Phaser rt; + int p = (int)(state >>> PHASE_SHIFT); if (phase < 0) return phase; - long nanos = unit.toNanos(timeout); - Thread current = Thread.currentThread(); - if (current instanceof ForkJoinWorkerThread) - return timedHelpingWait(phase, nanos); - timedWait(current, phase, nanos); - return phaseOf(state.get()); + if (p == phase) { + if ((p = (int)((rt = root).state >>> PHASE_SHIFT)) == phase) { + QNode node = new QNode(this, phase, true, true, nanos); + p = rt.internalAwaitAdvance(phase, node); + if (node.wasInterrupted) + throw new InterruptedException(); + else if (p == phase) + throw new TimeoutException(); + } + else + reconcileState(); + } + return p; } /** - * Forces this barrier to enter termination state. Counts of - * arrived and registered parties are unaffected. This method may - * be useful for coordinating recovery after one or more tasks - * encounter unexpected exceptions. + * Forces this phaser to enter termination state. Counts of + * registered parties are unaffected. If this phaser is a member + * of a tiered set of phasers, then all of the phasers in the set + * are terminated. If this phaser is already terminated, this + * method has no effect. This method may be useful for + * coordinating recovery after one or more tasks encounter + * unexpected exceptions. */ public void forceTermination() { - final AtomicLong state = this.state; - for (;;) { - long s = state.get(); - int phase = phaseOf(s); - int parties = partiesOf(s); - int unarrived = unarrivedOf(s); - if (phase < 0 || - state.compareAndSet(s, stateFor(-1, parties, unarrived))) { - if (head.get() != null) - releaseWaiters(-1); + // Only need to change root state + final Phaser root = this.root; + long s; + while ((s = root.state) >= 0) { + long next = (s & ~(long)(MAX_PARTIES)) | TERMINATION_BIT; + if (UNSAFE.compareAndSwapLong(root, stateOffset, s, next)) { + releaseWaiters(0); // signal all threads + releaseWaiters(1); return; } } } /** - * Resets the barrier with the given numbers of registered unarrived - * parties and phase number 0. This method allows repeated reuse - * of this barrier, but only if it is somehow known not to be in - * use for other purposes. - * @param parties the number of parties required to trip barrier. - * @throws IllegalArgumentException if parties less than zero - * or greater than the maximum number of parties supported. - */ - public void reset(int parties) { - if (parties < 0 || parties > ushortMask) - throw new IllegalArgumentException("Illegal number of parties"); - state.set(stateFor(0, parties, parties)); - if (head.get() != null) - releaseWaiters(0); - } - - /** * Returns the current phase number. The maximum phase number is - * Integer.MAX_VALUE, after which it restarts at - * zero. Upon termination, the phase number is negative. + * {@code Integer.MAX_VALUE}, after which it restarts at + * zero. Upon termination, the phase number is negative, + * in which case the prevailing phase prior to termination + * may be obtained via {@code getPhase() + Integer.MIN_VALUE}. + * * @return the phase number, or a negative value if terminated */ - public int getPhase() { - return phaseOf(state.get()); + public final int getPhase() { + return (int)(root.state >>> PHASE_SHIFT); } /** - * Returns the number of parties registered at this barrier. + * Returns the number of parties registered at this phaser. + * * @return the number of parties */ public int getRegisteredParties() { - return partiesOf(state.get()); + return partiesOf(state); } /** - * Returns the number of parties that have arrived at the current - * phase of this barrier. + * Returns the number of registered parties that have arrived at + * the current phase of this phaser. + * * @return the number of arrived parties */ public int getArrivedParties() { - return arrivedOf(state.get()); + return arrivedOf(reconcileState()); } /** * Returns the number of registered parties that have not yet - * arrived at the current phase of this barrier. + * arrived at the current phase of this phaser. + * * @return the number of unarrived parties */ public int getUnarrivedParties() { - return unarrivedOf(state.get()); + return unarrivedOf(reconcileState()); + } + + /** + * Returns the parent of this phaser, or {@code null} if none. + * + * @return the parent of this phaser, or {@code null} if none + */ + public Phaser getParent() { + return parent; + } + + /** + * Returns the root ancestor of this phaser, which is the same as + * this phaser if it has no parent. + * + * @return the root ancestor of this phaser + */ + public Phaser getRoot() { + return root; } /** - * Returns true if this barrier has been terminated - * @return true if this barrier has been terminated + * Returns {@code true} if this phaser has been terminated. + * + * @return {@code true} if this phaser has been terminated */ public boolean isTerminated() { - return phaseOf(state.get()) < 0; + return root.state < 0L; } /** - * Overridable method to perform an action upon phase advance, and - * to control termination. This method is invoked whenever the - * barrier is tripped (and thus all other waiting parties are - * dormant). If it returns true, then, rather than advance the - * phase number, this barrier will be set to a final termination - * state, and subsequent calls to isTerminated will - * return true. - * - *

The default version returns true when the number of - * registered parties is zero. Normally, overrides that arrange - * termination for other reasons should also preserve this - * property. - * - * @param phase the phase number on entering the barrier - * @param registeredParties the current number of registered - * parties. - * @return true if this barrier should terminate + * Overridable method to perform an action upon impending phase + * advance, and to control termination. This method is invoked + * upon arrival of the party advancing this phaser (when all other + * waiting parties are dormant). If this method returns {@code + * true}, this phaser will be set to a final termination state + * upon advance, and subsequent calls to {@link #isTerminated} + * will return true. Any (unchecked) Exception or Error thrown by + * an invocation of this method is propagated to the party + * attempting to advance this phaser, in which case no advance + * occurs. + * + *

The arguments to this method provide the state of the phaser + * prevailing for the current transition. The effects of invoking + * arrival, registration, and waiting methods on this phaser from + * within {@code onAdvance} are unspecified and should not be + * relied on. + * + *

If this phaser is a member of a tiered set of phasers, then + * {@code onAdvance} is invoked only for its root phaser on each + * advance. + * + *

To support the most common use cases, the default + * implementation of this method returns {@code true} when the + * number of registered parties has become zero as the result of a + * party invoking {@code arriveAndDeregister}. You can disable + * this behavior, thus enabling continuation upon future + * registrations, by overriding this method to always return + * {@code false}: + * + *

 {@code
+     * Phaser phaser = new Phaser() {
+     *   protected boolean onAdvance(int phase, int parties) { return false; }
+     * }}
+ * + * @param phase the current phase number on entry to this method, + * before this phaser is advanced + * @param registeredParties the current number of registered parties + * @return {@code true} if this phaser should terminate */ protected boolean onAdvance(int phase, int registeredParties) { - return registeredParties <= 0; + return registeredParties == 0; } /** - * Returns a string identifying this barrier, as well as its + * Returns a string identifying this phaser, as well as its * state. The state, in brackets, includes the String {@code - * "phase ="} followed by the phase number, {@code "parties ="} + * "phase = "} followed by the phase number, {@code "parties = "} * followed by the number of registered parties, and {@code - * "arrived ="} followed by the number of arrived parties + * "arrived = "} followed by the number of arrived parties. * - * @return a string identifying this barrier, as well as its state + * @return a string identifying this phaser, as well as its state */ public String toString() { - long s = state.get(); - return super.toString() + "[phase = " + phaseOf(s) + " parties = " + partiesOf(s) + " arrived = " + arrivedOf(s) + "]"; + return stateToString(reconcileState()); } - // methods for tripping and waiting - /** - * Advance the current phase (or terminate) + * Implementation of toString and string-based error messages */ - private void trip(int phase, int parties) { - int next = onAdvance(phase, parties)? -1 : ((phase + 1) & phaseMask); - state.set(stateFor(next, parties, parties)); - if (head.get() != null) - releaseWaiters(next); + private String stateToString(long s) { + return super.toString() + + "[phase = " + phaseOf(s) + + " parties = " + partiesOf(s) + + " arrived = " + arrivedOf(s) + "]"; } - private int helpingWait(int phase) { - final AtomicLong state = this.state; - int p; - while ((p = phaseOf(state.get())) == phase) { - ForkJoinTask t = ForkJoinWorkerThread.pollTask(); - if (t != null) { - if ((p = phaseOf(state.get())) == phase) - t.exec(); - else { // push task and exit if barrier advanced - t.fork(); - break; - } + // Waiting mechanics + + /** + * Removes and signals threads from queue for phase. + */ + private void releaseWaiters(int phase) { + QNode q; // first element of queue + int p; // its phase + Thread t; // its thread + // assert phase != phaseOf(root.state); + AtomicReference head = (phase & 1) == 0 ? evenQ : oddQ; + while ((q = head.get()) != null && + q.phase != (int)(root.state >>> PHASE_SHIFT)) { + if (head.compareAndSet(q, q.next) && + (t = q.thread) != null) { + q.thread = null; + LockSupport.unpark(t); } } - return p; } - private int timedHelpingWait(int phase, long nanos) throws TimeoutException { - final AtomicLong state = this.state; - long lastTime = System.nanoTime(); + /** The number of CPUs, for spin control */ + private static final int NCPU = Runtime.getRuntime().availableProcessors(); + + /** + * The number of times to spin before blocking while waiting for + * advance, per arrival while waiting. On multiprocessors, fully + * blocking and waking up a large number of threads all at once is + * usually a very slow process, so we use rechargeable spins to + * avoid it when threads regularly arrive: When a thread in + * internalAwaitAdvance notices another arrival before blocking, + * and there appear to be enough CPUs available, it spins + * SPINS_PER_ARRIVAL more times before blocking. The value trades + * off good-citizenship vs big unnecessary slowdowns. + */ + static final int SPINS_PER_ARRIVAL = (NCPU < 2) ? 1 : 1 << 8; + + /** + * Possibly blocks and waits for phase to advance unless aborted. + * Call only from root node. + * + * @param phase current phase + * @param node if non-null, the wait node to track interrupt and timeout; + * if null, denotes noninterruptible wait + * @return current phase + */ + private int internalAwaitAdvance(int phase, QNode node) { + releaseWaiters(phase-1); // ensure old queue clean + boolean queued = false; // true when node is enqueued + int lastUnarrived = 0; // to increase spins upon change + int spins = SPINS_PER_ARRIVAL; + long s; int p; - while ((p = phaseOf(state.get())) == phase) { - long now = System.nanoTime(); - nanos -= now - lastTime; - lastTime = now; - if (nanos <= 0) { - if ((p = phaseOf(state.get())) == phase) - throw new TimeoutException(); - else - break; + while ((p = (int)((s = state) >>> PHASE_SHIFT)) == phase) { + if (node == null) { // spinning in noninterruptible mode + int unarrived = (int)s & UNARRIVED_MASK; + if (unarrived != lastUnarrived && + (lastUnarrived = unarrived) < NCPU) + spins += SPINS_PER_ARRIVAL; + boolean interrupted = Thread.interrupted(); + if (interrupted || --spins < 0) { // need node to record intr + node = new QNode(this, phase, false, false, 0L); + node.wasInterrupted = interrupted; + } } - ForkJoinTask t = ForkJoinWorkerThread.pollTask(); - if (t != null) { - if ((p = phaseOf(state.get())) == phase) - t.exec(); - else { // push task and exit if barrier advanced - t.fork(); - break; + else if (node.isReleasable()) // done or aborted + break; + else if (!queued) { // push onto queue + AtomicReference head = (phase & 1) == 0 ? evenQ : oddQ; + QNode q = node.next = head.get(); + if ((q == null || q.phase == phase) && + (int)(state >>> PHASE_SHIFT) == phase) // avoid stale enq + queued = head.compareAndSet(q, node); + } + else { + try { + ForkJoinPool.managedBlock(node); + } catch (InterruptedException ie) { + node.wasInterrupted = true; } } } + + if (node != null) { + if (node.thread != null) + node.thread = null; // avoid need for unpark() + if (node.wasInterrupted && !node.interruptible) + Thread.currentThread().interrupt(); + if (p == phase && (p = (int)(state >>> PHASE_SHIFT)) == phase) + return p; // recheck abort + } + releaseWaiters(phase); return p; } /** - * Wait nodes for Treiber stack representing wait queue for non-FJ - * tasks. The waiting scheme is an adaptation of the one used in - * forkjoin.PoolBarrier. + * Wait nodes for Treiber stack representing wait queue */ - static final class QNode { - QNode next; - volatile Thread thread; // nulled to cancel wait + static final class QNode implements ForkJoinPool.ManagedBlocker { + final Phaser phaser; final int phase; - QNode(Thread t, int c) { - thread = t; - phase = c; + final boolean interruptible; + final boolean timed; + boolean wasInterrupted; + long nanos; + long lastTime; + volatile Thread thread; // nulled to cancel wait + QNode next; + + QNode(Phaser phaser, int phase, boolean interruptible, + boolean timed, long nanos) { + this.phaser = phaser; + this.phase = phase; + this.interruptible = interruptible; + this.nanos = nanos; + this.timed = timed; + this.lastTime = timed ? System.nanoTime() : 0L; + thread = Thread.currentThread(); } - } - private void releaseWaiters(int currentPhase) { - final AtomicReference head = this.head; - QNode p; - while ((p = head.get()) != null && p.phase != currentPhase) { - if (head.compareAndSet(p, null)) { - do { - Thread t = p.thread; - if (t != null) { - p.thread = null; - LockSupport.unpark(t); - } - } while ((p = p.next) != null); + public boolean isReleasable() { + if (thread == null) + return true; + if (phaser.getPhase() != phase) { + thread = null; + return true; + } + if (Thread.interrupted()) + wasInterrupted = true; + if (wasInterrupted && interruptible) { + thread = null; + return true; } + if (timed) { + if (nanos > 0L) { + long now = System.nanoTime(); + nanos -= now - lastTime; + lastTime = now; + } + if (nanos <= 0L) { + thread = null; + return true; + } + } + return false; } - } - - /** The number of CPUs, for spin control */ - static final int NCPUS = Runtime.getRuntime().availableProcessors(); - - /** - * The number of times to spin before blocking in timed waits. - * The value is empirically derived - */ - static final int maxTimedSpins = (NCPUS < 2)? 0 : 32; - /** - * The number of times to spin before blocking in untimed waits. - * This is greater than timed value because untimed waits spin - * faster since they don't need to check times on each spin. - */ - static final int maxUntimedSpins = maxTimedSpins * 32; + public boolean block() { + if (isReleasable()) + return true; + else if (!timed) + LockSupport.park(this); + else if (nanos > 0) + LockSupport.parkNanos(this, nanos); + return isReleasable(); + } + } - /** - * The number of nanoseconds for which it is faster to spin - * rather than to use timed park. A rough estimate suffices. - */ - static final long spinForTimeoutThreshold = 1000L; + // Unsafe mechanics - /** - * Enqueues node and waits unless aborted or signalled. - */ - private boolean untimedWait(Thread thread, int currentPhase, - boolean abortOnInterrupt) { - final AtomicReference head = this.head; - final AtomicLong state = this.state; - boolean wasInterrupted = false; - QNode node = null; - boolean queued = false; - int spins = maxUntimedSpins; - while (phaseOf(state.get()) == currentPhase) { - QNode h; - if (node != null && queued) { - if (node.thread != null) { - LockSupport.park(); - if (Thread.interrupted()) { - wasInterrupted = true; - if (abortOnInterrupt) - break; - } - } - } - else if ((h = head.get()) != null && h.phase != currentPhase) { - if (phaseOf(state.get()) == currentPhase) { // must recheck - if (head.compareAndSet(h, h.next)) { - Thread t = h.thread; // help clear out old waiters - if (t != null) { - h.thread = null; - LockSupport.unpark(t); - } - } - } - else - break; - } - else if (node != null) - queued = head.compareAndSet(node.next = h, node); - else if (spins <= 0) - node = new QNode(thread, currentPhase); - else - --spins; + private static final sun.misc.Unsafe UNSAFE = getUnsafe(); + private static final long stateOffset = + objectFieldOffset("state", Phaser.class); + + private static long objectFieldOffset(String field, Class klazz) { + try { + return UNSAFE.objectFieldOffset(klazz.getDeclaredField(field)); + } catch (NoSuchFieldException e) { + // Convert Exception to corresponding Error + NoSuchFieldError error = new NoSuchFieldError(field); + error.initCause(e); + throw error; } - if (node != null) - node.thread = null; - return wasInterrupted; } /** - * Messier timeout version + * Returns a sun.misc.Unsafe. Suitable for use in a 3rd party package. + * Replace with a simple call to Unsafe.getUnsafe when integrating + * into a jdk. + * + * @return a sun.misc.Unsafe */ - private void timedWait(Thread thread, int currentPhase, long nanos) - throws InterruptedException, TimeoutException { - final AtomicReference head = this.head; - final AtomicLong state = this.state; - long lastTime = System.nanoTime(); - QNode node = null; - boolean queued = false; - int spins = maxTimedSpins; - while (phaseOf(state.get()) == currentPhase) { - QNode h; - long now = System.nanoTime(); - nanos -= now - lastTime; - lastTime = now; - if (nanos <= 0) { - if (node != null) - node.thread = null; - if (phaseOf(state.get()) == currentPhase) - throw new TimeoutException(); - else - break; + private static sun.misc.Unsafe getUnsafe() { + try { + return sun.misc.Unsafe.getUnsafe(); + } catch (SecurityException se) { + try { + return java.security.AccessController.doPrivileged + (new java.security + .PrivilegedExceptionAction() { + public sun.misc.Unsafe run() throws Exception { + java.lang.reflect.Field f = sun.misc + .Unsafe.class.getDeclaredField("theUnsafe"); + f.setAccessible(true); + return (sun.misc.Unsafe) f.get(null); + }}); + } catch (java.security.PrivilegedActionException e) { + throw new RuntimeException("Could not initialize intrinsics", + e.getCause()); } - else if (node != null && queued) { - if (node.thread != null && - nanos > spinForTimeoutThreshold) { - // LockSupport.parkNanos(this, nanos); - LockSupport.parkNanos(nanos); - if (Thread.interrupted()) { - node.thread = null; - throw new InterruptedException(); - } - } - } - else if ((h = head.get()) != null && h.phase != currentPhase) { - if (phaseOf(state.get()) == currentPhase) { // must recheck - if (head.compareAndSet(h, h.next)) { - Thread t = h.thread; // help clear out old waiters - if (t != null) { - h.thread = null; - LockSupport.unpark(t); - } - } - } - else - break; - } - else if (node != null) - queued = head.compareAndSet(node.next = h, node); - else if (spins <= 0) - node = new QNode(thread, currentPhase); - else - --spins; } - if (node != null) - node.thread = null; } - } -