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

Comparing jsr166/src/jsr166y/Phaser.java (file contents):
Revision 1.34 by dl, Wed Aug 19 23:05:32 2009 UTC vs.
Revision 1.47 by dl, Wed Jul 7 19:52:32 2010 UTC

# Line 12 | Line 12 | import java.util.concurrent.atomic.Atomi
12   import java.util.concurrent.locks.LockSupport;
13  
14   /**
15 < * A reusable synchronization barrier, similar in functionality to a
15 > * A reusable synchronization barrier, similar in functionality to
16   * {@link java.util.concurrent.CyclicBarrier CyclicBarrier} and
17   * {@link java.util.concurrent.CountDownLatch CountDownLatch}
18   * but supporting more flexible usage.
19   *
20 < * <ul>
21 < *
22 < * <li> The number of parties synchronizing on a phaser may vary over
23 < * time.  A task may register to be a party at any time, and may
24 < * deregister upon arriving at the barrier.  As is the case with most
25 < * basic synchronization constructs, registration and deregistration
26 < * affect only internal counts; they do not establish any further
27 < * internal bookkeeping, so tasks cannot query whether they are
28 < * registered. (However, you can introduce such bookkeeping by
29 < * subclassing this class.)
30 < *
31 < * <li> Each generation has an associated phase value, starting at
32 < * zero, and advancing when all parties reach the barrier (wrapping
33 < * around to zero after reaching {@code Integer.MAX_VALUE}).
34 < *
35 < * <li> Like a {@code CyclicBarrier}, a phaser may be repeatedly
36 < * awaited.  Method {@link #arriveAndAwaitAdvance} has effect
37 < * analogous to {@link java.util.concurrent.CyclicBarrier#await
38 < * CyclicBarrier.await}.  However, phasers separate two aspects of
39 < * coordination, which may also be invoked independently:
20 > * <p> <b>Registration.</b> Unlike the case for other barriers, the
21 > * number of parties <em>registered</em> to synchronize on a phaser
22 > * may vary over time.  Tasks may be registered at any time (using
23 > * methods {@link #register}, {@link #bulkRegister}, or forms of
24 > * constructors establishing initial numbers of parties), and
25 > * optionally deregistered upon any arrival (using {@link
26 > * #arriveAndDeregister}).  As is the case with most basic
27 > * synchronization constructs, registration and deregistration affect
28 > * only internal counts; they do not establish any further internal
29 > * bookkeeping, so tasks cannot query whether they are registered.
30 > * (However, you can introduce such bookkeeping by subclassing this
31 > * class.)
32 > *
33 > * <p> <b>Synchronization.</b> Like a {@code CyclicBarrier}, a {@code
34 > * Phaser} may be repeatedly awaited.  Method {@link
35 > * #arriveAndAwaitAdvance} has effect analogous to {@link
36 > * java.util.concurrent.CyclicBarrier#await CyclicBarrier.await}. Each
37 > * generation of a {@code Phaser} has an associated phase number. The
38 > * phase number starts at zero, and advances when all parties arrive
39 > * at the barrier, wrapping around to zero after reaching {@code
40 > * Integer.MAX_VALUE}. The use of phase numbers enables independent
41 > * control of actions upon arrival at a barrier and upon awaiting
42 > * others, via two kinds of methods that may be invoked by any
43 > * registered party:
44   *
45   * <ul>
46   *
47 < *   <li> Arriving at a barrier. Methods {@link #arrive} and
48 < *       {@link #arriveAndDeregister} do not block, but return
49 < *       the phase value current upon entry to the method.
50 < *
51 < *   <li> Awaiting others. Method {@link #awaitAdvance} requires an
52 < *       argument indicating the entry phase, and returns when the
53 < *       barrier advances to a new phase.
54 < * </ul>
47 > *   <li> <b>Arrival.</b> Methods {@link #arrive} and
48 > *       {@link #arriveAndDeregister} record arrival at a
49 > *       barrier. These methods do not block, but return an associated
50 > *       <em>arrival phase number</em>; that is, the phase number of
51 > *       the barrier to which the arrival applied. When the final
52 > *       party for a given phase arrives, an optional barrier action
53 > *       is performed and the phase advances.  Barrier actions,
54 > *       performed by the party triggering a phase advance, are
55 > *       arranged by overriding method {@link #onAdvance(int, int)},
56 > *       which also controls termination. Overriding this method is
57 > *       similar to, but more flexible than, providing a barrier
58 > *       action to a {@code CyclicBarrier}.
59 > *
60 > *   <li> <b>Waiting.</b> Method {@link #awaitAdvance} requires an
61 > *       argument indicating an arrival phase number, and returns when
62 > *       the barrier advances to (or is already at) a different phase.
63 > *       Unlike similar constructions using {@code CyclicBarrier},
64 > *       method {@code awaitAdvance} continues to wait even if the
65 > *       waiting thread is interrupted. Interruptible and timeout
66 > *       versions are also available, but exceptions encountered while
67 > *       tasks wait interruptibly or with timeout do not change the
68 > *       state of the barrier. If necessary, you can perform any
69 > *       associated recovery within handlers of those exceptions,
70 > *       often after invoking {@code forceTermination}.  Phasers may
71 > *       also be used by tasks executing in a {@link ForkJoinPool},
72 > *       which will ensure sufficient parallelism to execute tasks
73 > *       when others are blocked waiting for a phase to advance.
74   *
75 + * </ul>
76   *
77 < * <li> Barrier actions, performed by the task triggering a phase
78 < * advance, are arranged by overriding method {@link #onAdvance(int,
79 < * int)}, which also controls termination. Overriding this method is
80 < * similar to, but more flexible than, providing a barrier action to a
81 < * {@code CyclicBarrier}.
82 < *
83 < * <li> Phasers may enter a <em>termination</em> state in which all
60 < * actions immediately return without updating phaser state or waiting
61 < * for advance, and indicating (via a negative phase value) that
62 < * execution is complete.  Termination is triggered when an invocation
63 < * of {@code onAdvance} returns {@code true}.  When a phaser is
64 < * controlling an action with a fixed number of iterations, it is
77 > * <p> <b>Termination.</b> A {@code Phaser} may enter a
78 > * <em>termination</em> state in which all synchronization methods
79 > * immediately return without updating phaser state or waiting for
80 > * advance, and indicating (via a negative phase value) that execution
81 > * is complete.  Termination is triggered when an invocation of {@code
82 > * onAdvance} returns {@code true}.  As illustrated below, when
83 > * phasers control actions with a fixed number of iterations, it is
84   * often convenient to override this method to cause termination when
85   * the current phase number reaches a threshold. Method {@link
86   * #forceTermination} is also available to abruptly release waiting
87   * threads and allow them to terminate.
88   *
89 < * <li> Phasers may be tiered to reduce contention. Phasers with large
89 > * <p> <b>Tiering.</b> Phasers may be <em>tiered</em> (i.e., arranged
90 > * in tree structures) to reduce contention. Phasers with large
91   * numbers of parties that would otherwise experience heavy
92 < * synchronization contention costs may instead be arranged in trees.
93 < * This will typically greatly increase throughput even though it
94 < * incurs somewhat greater per-operation overhead.
95 < *
96 < * <li> By default, {@code awaitAdvance} continues to wait even if
97 < * the waiting thread is interrupted. And unlike the case in
98 < * {@code CyclicBarrier}, exceptions encountered while tasks wait
99 < * interruptibly or with timeout do not change the state of the
100 < * barrier. If necessary, you can perform any associated recovery
101 < * within handlers of those exceptions, often after invoking
102 < * {@code forceTermination}.
103 < *
104 < * <li>Phasers may be used to coordinate tasks executing in a {@link
105 < * ForkJoinPool}, which will ensure sufficient parallelism to execute
106 < * tasks when others are blocked waiting for a phase to advance.
107 < *
88 < * </ul>
92 > * synchronization contention costs may instead be set up so that
93 > * groups of sub-phasers share a common parent.  This may greatly
94 > * increase throughput even though it incurs greater per-operation
95 > * overhead.
96 > *
97 > * <p><b>Monitoring.</b> While synchronization methods may be invoked
98 > * only by registered parties, the current state of a phaser may be
99 > * monitored by any caller.  At any given moment there are {@link
100 > * #getRegisteredParties} parties in total, of which {@link
101 > * #getArrivedParties} have arrived at the current phase ({@link
102 > * #getPhase}).  When the remaining ({@link #getUnarrivedParties})
103 > * parties arrive, the phase advances.  The values returned by these
104 > * methods may reflect transient states and so are not in general
105 > * useful for synchronization control.  Method {@link #toString}
106 > * returns snapshots of these state queries in a form convenient for
107 > * informal monitoring.
108   *
109   * <p><b>Sample usages:</b>
110   *
# Line 118 | Line 137 | import java.util.concurrent.locks.LockSu
137   *  <pre> {@code
138   * void startTasks(List<Runnable> tasks, final int iterations) {
139   *   final Phaser phaser = new Phaser() {
140 < *     public boolean onAdvance(int phase, int registeredParties) {
140 > *     protected boolean onAdvance(int phase, int registeredParties) {
141   *       return phase >= iterations || registeredParties == 0;
142   *     }
143   *   };
144   *   phaser.register();
145 < *   for (Runnable task : tasks) {
145 > *   for (final Runnable task : tasks) {
146   *     phaser.register();
147   *     new Thread() {
148   *       public void run() {
149   *         do {
150   *           task.run();
151   *           phaser.arriveAndAwaitAdvance();
152 < *         } while(!phaser.isTerminated();
152 > *         } while (!phaser.isTerminated());
153   *       }
154   *     }.start();
155   *   }
156   *   phaser.arriveAndDeregister(); // deregister self, don't wait
157   * }}</pre>
158   *
159 + * If the main task must later await termination, it
160 + * may re-register and then execute a similar loop:
161 + *  <pre> {@code
162 + *   // ...
163 + *   phaser.register();
164 + *   while (!phaser.isTerminated())
165 + *     phaser.arriveAndAwaitAdvance();}</pre>
166 + *
167 + * <p>Related constructions may be used to await particular phase numbers
168 + * in contexts where you are sure that the phase will never wrap around
169 + * {@code Integer.MAX_VALUE}. For example:
170 + *
171 + *  <pre> {@code
172 + * void awaitPhase(Phaser phaser, int phase) {
173 + *   int p = phaser.register(); // assumes caller not already registered
174 + *   while (p < phase) {
175 + *     if (phaser.isTerminated())
176 + *       // ... deal with unexpected termination
177 + *     else
178 + *       p = phaser.arriveAndAwaitAdvance();
179 + *   }
180 + *   phaser.arriveAndDeregister();
181 + * }}</pre>
182 + *
183 + *
184   * <p>To create a set of tasks using a tree of phasers,
185   * you could use code of the following form, assuming a
186   * Task class with a constructor accepting a phaser that
187   * it registers for upon construction:
188 + *
189   *  <pre> {@code
190 < * void build(Task[] actions, int lo, int hi, Phaser b) {
191 < *   int step = (hi - lo) / TASKS_PER_PHASER;
192 < *   if (step > 1) {
193 < *     int i = lo;
194 < *     while (i < hi) {
150 < *       int r = Math.min(i + step, hi);
151 < *       build(actions, i, r, new Phaser(b));
152 < *       i = r;
190 > * void build(Task[] actions, int lo, int hi, Phaser ph) {
191 > *   if (hi - lo > TASKS_PER_PHASER) {
192 > *     for (int i = lo; i < hi; i += TASKS_PER_PHASER) {
193 > *       int j = Math.min(i + TASKS_PER_PHASER, hi);
194 > *       build(actions, i, j, new Phaser(ph));
195   *     }
196   *   } else {
197   *     for (int i = lo; i < hi; ++i)
198 < *       actions[i] = new Task(b);
199 < *       // assumes new Task(b) performs b.register()
198 > *       actions[i] = new Task(ph);
199 > *       // assumes new Task(ph) performs ph.register()
200   *   }
201   * }
202   * // .. initially called, for n tasks via
# Line 203 | Line 245 | public class Phaser {
245       */
246      private volatile long state;
247  
206    private static final int ushortBits = 16;
248      private static final int ushortMask = 0xffff;
249      private static final int phaseMask  = 0x7fffffff;
250  
# Line 366 | Line 407 | public class Phaser {
407      /**
408       * Adds a new unarrived party to this phaser.
409       *
410 <     * @return the current barrier phase number upon registration
410 >     * @return the arrival phase number to which this registration applied
411       * @throws IllegalStateException if attempting to register more
412       * than the maximum supported number of parties
413       */
# Line 378 | Line 419 | public class Phaser {
419       * Adds the given number of new unarrived parties to this phaser.
420       *
421       * @param parties the number of parties required to trip barrier
422 <     * @return the current barrier phase number upon registration
422 >     * @return the arrival phase number to which this registration applied
423       * @throws IllegalStateException if attempting to register more
424       * than the maximum supported number of parties
425       */
# Line 413 | Line 454 | public class Phaser {
454  
455      /**
456       * Arrives at the barrier, but does not wait for others.  (You can
457 <     * in turn wait for others via {@link #awaitAdvance}).
457 >     * in turn wait for others via {@link #awaitAdvance}).  It is an
458 >     * unenforced usage error for an unregistered party to invoke this
459 >     * method.
460       *
461 <     * @return the barrier phase number upon entry to this method, or a
419 <     * negative value if terminated
461 >     * @return the arrival phase number, or a negative value if terminated
462       * @throws IllegalStateException if not terminated and the number
463       * of unarrived parties would become negative
464       */
# Line 466 | Line 508 | public class Phaser {
508       * required to trip the barrier in future phases.  If this phaser
509       * has a parent, and deregistration causes this phaser to have
510       * zero parties, this phaser also arrives at and is deregistered
511 <     * from its parent.
511 >     * from its parent.  It is an unenforced usage error for an
512 >     * unregistered party to invoke this method.
513       *
514 <     * @return the current barrier phase number upon entry to
472 <     * this method, or a negative value if terminated
514 >     * @return the arrival phase number, or a negative value if terminated
515       * @throws IllegalStateException if not terminated and the number
516       * of registered or unarrived parties would become negative
517       */
# Line 523 | Line 565 | public class Phaser {
565       * interruption or timeout, you can arrange this with an analogous
566       * construction using one of the other forms of the awaitAdvance
567       * method.  If instead you need to deregister upon arrival use
568 <     * {@code arriveAndDeregister}.
568 >     * {@code arriveAndDeregister}. It is an unenforced usage error
569 >     * for an unregistered party to invoke this method.
570       *
571 <     * @return the phase on entry to this method
571 >     * @return the arrival phase number, or a negative number if terminated
572       * @throws IllegalStateException if not terminated and the number
573       * of unarrived parties would become negative
574       */
# Line 537 | Line 580 | public class Phaser {
580       * Awaits the phase of the barrier to advance from the given phase
581       * value, returning immediately if the current phase of the
582       * barrier is not equal to the given phase value or this barrier
583 <     * is terminated.
583 >     * is terminated.  It is an unenforced usage error for an
584 >     * unregistered party to invoke this method.
585       *
586 <     * @param phase the phase on entry to this method
587 <     * @return the current barrier phase number upon exit of
588 <     * this method, or a negative value if terminated or
589 <     * argument is negative
586 >     * @param phase an arrival phase number, or negative value if
587 >     * terminated; this argument is normally the value returned by a
588 >     * previous call to {@code arrive} or its variants
589 >     * @return the next arrival phase number, or a negative value
590 >     * if terminated or argument is negative
591       */
592      public int awaitAdvance(int phase) {
593          if (phase < 0)
# Line 559 | Line 604 | public class Phaser {
604  
605      /**
606       * Awaits the phase of the barrier to advance from the given phase
607 <     * value, throwing {@code InterruptedException} if interrupted while
608 <     * waiting, or returning immediately if the current phase of the
609 <     * barrier is not equal to the given phase value or this barrier
610 <     * is terminated.
611 <     *
612 <     * @param phase the phase on entry to this method
613 <     * @return the current barrier phase number upon exit of
614 <     * this method, or a negative value if terminated or
615 <     * argument is negative
607 >     * value, throwing {@code InterruptedException} if interrupted
608 >     * while waiting, or returning immediately if the current phase of
609 >     * the barrier is not equal to the given phase value or this
610 >     * barrier is terminated. It is an unenforced usage error for an
611 >     * unregistered party to invoke this method.
612 >     *
613 >     * @param phase an arrival phase number, or negative value if
614 >     * terminated; this argument is normally the value returned by a
615 >     * previous call to {@code arrive} or its variants
616 >     * @return the next arrival phase number, or a negative value
617 >     * if terminated or argument is negative
618       * @throws InterruptedException if thread interrupted while waiting
619       */
620      public int awaitAdvanceInterruptibly(int phase)
# Line 585 | Line 632 | public class Phaser {
632  
633      /**
634       * Awaits the phase of the barrier to advance from the given phase
635 <     * value or the given timeout to elapse, throwing
636 <     * {@code InterruptedException} if interrupted while waiting, or
637 <     * returning immediately if the current phase of the barrier is not
638 <     * equal to the given phase value or this barrier is terminated.
639 <     *
640 <     * @param phase the phase on entry to this method
635 >     * value or the given timeout to elapse, throwing {@code
636 >     * InterruptedException} if interrupted while waiting, or
637 >     * returning immediately if the current phase of the barrier is
638 >     * not equal to the given phase value or this barrier is
639 >     * terminated.  It is an unenforced usage error for an
640 >     * unregistered party to invoke this method.
641 >     *
642 >     * @param phase an arrival phase number, or negative value if
643 >     * terminated; this argument is normally the value returned by a
644 >     * previous call to {@code arrive} or its variants
645       * @param timeout how long to wait before giving up, in units of
646       *        {@code unit}
647       * @param unit a {@code TimeUnit} determining how to interpret the
648       *        {@code timeout} parameter
649 <     * @return the current barrier phase number upon exit of
650 <     * this method, or a negative value if terminated or
600 <     * argument is negative
649 >     * @return the next arrival phase number, or a negative value
650 >     * if terminated or argument is negative
651       * @throws InterruptedException if thread interrupted while waiting
652       * @throws TimeoutException if timed out while waiting
653       */
# Line 660 | Line 710 | public class Phaser {
710      }
711  
712      /**
713 <     * Returns the number of parties that have arrived at the current
714 <     * phase of this barrier.
713 >     * Returns the number of registered parties that have arrived at
714 >     * the current phase of this barrier.
715       *
716       * @return the number of arrived parties
717       */
# Line 708 | Line 758 | public class Phaser {
758      }
759  
760      /**
761 <     * Overridable method to perform an action upon phase advance, and
762 <     * to control termination. This method is invoked whenever the
763 <     * barrier is tripped (and thus all other waiting parties are
764 <     * dormant). If it returns {@code true}, then, rather than advance
765 <     * the phase number, this barrier will be set to a final
766 <     * termination state, and subsequent calls to {@link #isTerminated}
767 <     * will return true.
761 >     * Overridable method to perform an action upon impending phase
762 >     * advance, and to control termination. This method is invoked
763 >     * upon arrival of the party tripping the barrier (when all other
764 >     * waiting parties are dormant).  If this method returns {@code
765 >     * true}, then, rather than advance the phase number, this barrier
766 >     * will be set to a final termination state, and subsequent calls
767 >     * to {@link #isTerminated} will return true. Any (unchecked)
768 >     * Exception or Error thrown by an invocation of this method is
769 >     * propagated to the party attempting to trip the barrier, in
770 >     * which case no advance occurs.
771 >     *
772 >     * <p>The arguments to this method provide the state of the phaser
773 >     * prevailing for the current transition. (When called from within
774 >     * an implementation of {@code onAdvance} the values returned by
775 >     * methods such as {@code getPhase} may or may not reliably
776 >     * indicate the state to which this transition applies.)
777       *
778       * <p>The default version returns {@code true} when the number of
779       * registered parties is zero. Normally, overrides that arrange
# Line 722 | Line 781 | public class Phaser {
781       * property.
782       *
783       * <p>You may override this method to perform an action with side
784 <     * effects visible to participating tasks, but it is in general
785 <     * only sensible to do so in designs where all parties register
786 <     * before any arrive, and all {@link #awaitAdvance} at each phase.
784 >     * effects visible to participating tasks, but it is only sensible
785 >     * to do so in designs where all parties register before any
786 >     * arrive, and all {@link #awaitAdvance} at each phase.
787       * Otherwise, you cannot ensure lack of interference from other
788 <     * parties during the invocation of this method.
788 >     * parties during the invocation of this method. Additionally,
789 >     * method {@code onAdvance} may be invoked more than once per
790 >     * transition if registrations are intermixed with arrivals.
791       *
792       * @param phase the phase number on entering the barrier
793       * @param registeredParties the current number of registered parties
# Line 810 | Line 871 | public class Phaser {
871          boolean doWait() {
872              if (thread != null) {
873                  try {
874 <                    ForkJoinPool.managedBlock(this, false);
874 >                    ForkJoinPool.managedBlock(this);
875                  } catch (InterruptedException ie) {
876                  }
877              }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines