ViewVC Help

View File | Revision Log | Show Annotations | Download File | Root Listing

root/jsr166/jsr166/src/jsr166y/Phaser.java

Comparing jsr166/src/jsr166y/Phaser.java (file contents):
Revision 1.3 by jsr166, Fri Jul 25 18:11:53 2008 UTC vs.
Revision 1.72 by dl, Mon May 16 11:41:14 2011 UTC

#	Line 1 | Line 1
1		/*
2		* Written by Doug Lea with assistance from members of JCP JSR-166
3		* Expert Group and released to the public domain, as explained at
4	<	* http://creativecommons.org/licenses/publicdomain
4	>	* http://creativecommons.org/publicdomain/zero/1.0/
5		*/
6
7		package jsr166y;
8	<	import jsr166y.forkjoin.*;
9	<	import java.util.concurrent.*;
10	<	import java.util.concurrent.atomic.*;
8	>
9	>	import java.util.concurrent.TimeUnit;
10	>	import java.util.concurrent.TimeoutException;
11	>	import java.util.concurrent.atomic.AtomicReference;
12		import java.util.concurrent.locks.LockSupport;
13
14		/**
15	<	* A reusable synchronization barrier, similar in functionality to a
16	<	* {@link java.util.concurrent.CyclicBarrier}, but supporting more
17	<	* flexible usage.
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>
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	<	* <li> The number of parties synchronizing on the barrier may vary
34	<	* over time.  A task may register to be a party in a barrier at any
35	<	* time, and may deregister upon arriving at the barrier.  As is the
36	<	* case with most basic synchronization constructs, registration
37	<	* and deregistration affect only internal counts; they do not
38	<	* establish any further internal bookkeeping, so tasks cannot query
39	<	* whether they are registered.
40	<	*
41	<	* <li> Each generation has an associated phase value, starting at
42	<	* zero, and advancing when all parties reach the barrier (wrapping
43	<	* around to zero after reaching <tt>Integer.MAX_VALUE</tt>).
31	<	*
32	<	* <li> Like a CyclicBarrier, a Phaser may be repeatedly awaited.
33	<	* Method <tt>arriveAndAwaitAdvance</tt> has effect analogous to
34	<	* <tt>CyclicBarrier.await</tt>.  However, Phasers separate two
35	<	* aspects of coordination, that may be invoked independently:
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 phaser has an associated phase number. The phase
38	>	* number starts at zero, and advances when all parties arrive at the
39	>	* phaser, 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 phaser 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 <tt>arrive</tt> and
48	<	*       <tt>arriveAndDeregister</tt> do not block, but return
49	<	*       the phase value on entry to the method.
50	<	*
51	<	*   <li> Awaiting others. Method <tt>awaitAdvance</tt> requires an
52	<	*       argument indicating the entry phase, and returns when the
53	<	*       barrier advances to a new phase.
47	>	*   <li> <b>Arrival.</b> Methods {@link #arrive} and
48	>	*       {@link #arriveAndDeregister} record arrival.  These methods
49	>	*       do not block, but return an associated <em>arrival phase
50	>	*       number</em>; that is, the phase number of the phaser to which
51	>	*       the arrival applied. When the final party for a given phase
52	>	*       arrives, an optional action is performed and the phase
53	>	*       advances.  These actions are performed by the party
54	>	*       triggering a phase advance, and are arranged by overriding
55	>	*       method {@link #onAdvance(int, int)}, which also controls
56	>	*       termination. Overriding this method is similar to, but more
57	>	*       flexible than, providing a barrier action to a {@code
58	>	*       CyclicBarrier}.
59	>	*
60	>	*   <li> <b>Waiting.</b> Method {@link #awaitAdvance} requires an
61	>	*       argument indicating an arrival phase number, and returns when
62	>	*       the phaser 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 phaser. 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	+	* <p> <b>Termination.</b> A phaser may enter a <em>termination</em>
78	+	* state, that may be checked using method {@link #isTerminated}. Upon
79	+	* termination, all synchronization methods immediately return without
80	+	* waiting for advance, as indicated by a negative return value.
81	+	* Similarly, attempts to register upon termination have no effect.
82	+	* Termination is triggered when an invocation of {@code onAdvance}
83	+	* returns {@code true}. The default implementation returns {@code
84	+	* true} if a deregistration has caused the number of registered
85	+	* parties to become zero.  As illustrated below, when phasers control
86	+	* actions with a fixed number of iterations, it is often convenient
87	+	* to override this method to cause termination when the current phase
88	+	* number reaches a threshold. Method {@link #forceTermination} is
89	+	* also available to abruptly release waiting threads and allow them
90	+	* to terminate.
91		*
92	<	* <li> Barrier actions, performed by the task triggering a phase
93	<	* advance while others may be waiting, are arranged by overriding
94	<	* method <tt>onAdvance</tt>, that also controls termination.
95	<	*
96	<	* <li> Phasers may enter a <em>termination</em> state in which all
97	<	* await actions immediately return, indicating (via a negative phase
98	<	* value) that execution is complete.  Termination is triggered by
56	<	* executing the overridable <tt>onAdvance</tt> method that is invoked
57	<	* each time the barrier is tripped. When a Phaser is controlling an
58	<	* action with a fixed number of iterations, it is often convenient to
59	<	* override this method to cause termination when the current phase
60	<	* number reaches a threshold.  Method <tt>forceTermination</tt> is
61	<	* also available to assist recovery actions upon failure.
62	<	*
63	<	* <li> Unlike most synchronizers, a Phaser may also be used with
64	<	* ForkJoinTasks (as well as plain threads).
65	<	*
66	<	* <li> By default, <tt>awaitAdvance</tt> continues to wait even if
67	<	* the current thread is interrupted. And unlike the case in
68	<	* CyclicBarriers, exceptions encountered while tasks wait
69	<	* interruptibly or with timeout do not change the state of the
70	<	* barrier. If necessary, you can perform any associated recovery
71	<	* within handlers of those exceptions.
92	>	* <p> <b>Tiering.</b> Phasers may be <em>tiered</em> (i.e.,
93	>	* constructed in tree structures) to reduce contention. Phasers with
94	>	* large numbers of parties that would otherwise experience heavy
95	>	* synchronization contention costs may instead be set up so that
96	>	* groups of sub-phasers share a common parent.  This may greatly
97	>	* increase throughput even though it incurs greater per-operation
98	>	* overhead.
99		*
100	<	* </ul>
100	>	* <p>In a tree of tiered phasers, registration and deregistration of
101	>	* child phasers with their parent are managed automatically.
102	>	* Whenever the number of registered parties of a child phaser becomes
103	>	* non-zero (as established in the {@link #Phaser(Phaser,int)}
104	>	* constructor, {@link #register}, or {@link #bulkRegister}), the
105	>	* child phaser is registered with its parent.  Whenever the number of
106	>	* registered parties becomes zero as the result of an invocation of
107	>	* {@link #arriveAndDeregister}, the child phaser is deregistered
108	>	* from its parent.
109	>	*
110	>	* <p><b>Monitoring.</b> While synchronization methods may be invoked
111	>	* only by registered parties, the current state of a phaser may be
112	>	* monitored by any caller.  At any given moment there are {@link
113	>	* #getRegisteredParties} parties in total, of which {@link
114	>	* #getArrivedParties} have arrived at the current phase ({@link
115	>	* #getPhase}).  When the remaining ({@link #getUnarrivedParties})
116	>	* parties arrive, the phase advances.  The values returned by these
117	>	* methods may reflect transient states and so are not in general
118	>	* useful for synchronization control.  Method {@link #toString}
119	>	* returns snapshots of these state queries in a form convenient for
120	>	* informal monitoring.
121	>	*
122	>	* <p><b>Sample usages:</b>
123	>	*
124	>	* <p>A {@code Phaser} may be used instead of a {@code CountDownLatch}
125	>	* to control a one-shot action serving a variable number of parties.
126	>	* The typical idiom is for the method setting this up to first
127	>	* register, then start the actions, then deregister, as in:
128	>	*
129	>	*  <pre> {@code
130	>	* void runTasks(List<Runnable> tasks) {
131	>	*   final Phaser phaser = new Phaser(1); // "1" to register self
132	>	*   // create and start threads
133	>	*   for (final Runnable task : tasks) {
134	>	*     phaser.register();
135	>	*     new Thread() {
136	>	*       public void run() {
137	>	*         phaser.arriveAndAwaitAdvance(); // await all creation
138	>	*         task.run();
139	>	*       }
140	>	*     }.start();
141	>	*   }
142	>	*
143	>	*   // allow threads to start and deregister self
144	>	*   phaser.arriveAndDeregister();
145	>	* }}</pre>
146	>	*
147	>	* <p>One way to cause a set of threads to repeatedly perform actions
148	>	* for a given number of iterations is to override {@code onAdvance}:
149	>	*
150	>	*  <pre> {@code
151	>	* void startTasks(List<Runnable> tasks, final int iterations) {
152	>	*   final Phaser phaser = new Phaser() {
153	>	*     protected boolean onAdvance(int phase, int registeredParties) {
154	>	*       return phase >= iterations || registeredParties == 0;
155	>	*     }
156	>	*   };
157	>	*   phaser.register();
158	>	*   for (final Runnable task : tasks) {
159	>	*     phaser.register();
160	>	*     new Thread() {
161	>	*       public void run() {
162	>	*         do {
163	>	*           task.run();
164	>	*           phaser.arriveAndAwaitAdvance();
165	>	*         } while (!phaser.isTerminated());
166	>	*       }
167	>	*     }.start();
168	>	*   }
169	>	*   phaser.arriveAndDeregister(); // deregister self, don't wait
170	>	* }}</pre>
171		*
172	<	* <p><b>Sample usage:</b>
172	>	* If the main task must later await termination, it
173	>	* may re-register and then execute a similar loop:
174	>	*  <pre> {@code
175	>	*   // ...
176	>	*   phaser.register();
177	>	*   while (!phaser.isTerminated())
178	>	*     phaser.arriveAndAwaitAdvance();}</pre>
179		*
180	<	* <p>[todo: non-FJ example]
180	>	* <p>Related constructions may be used to await particular phase numbers
181	>	* in contexts where you are sure that the phase will never wrap around
182	>	* {@code Integer.MAX_VALUE}. For example:
183		*
184	<	* <p> A Phaser may be used to support a style of programming in
185	<	* which a task waits for others to complete, without otherwise
186	<	* needing to keep track of which tasks it is waiting for. This is
187	<	* similar to the "sync" construct in Cilk and "clocks" in X10.
188	<	* Special constructions based on such barriers are available using
189	<	* the <tt>LinkedAsyncAction</tt> and <tt>CyclicAction</tt> classes,
190	<	* but they can be useful in other contexts as well.  For a simple
191	<	* (but not very useful) example, here is a variant of Fibonacci:
87	<	*
88	<	* <pre>
89	<	* class BarrierFibonacci extends RecursiveAction {
90	<	*   int argument, result;
91	<	*   final Phaser parentBarrier;
92	<	*   BarrierFibonacci(int n, Phaser parentBarrier) {
93	<	*     this.argument = n;
94	<	*     this.parentBarrier = parentBarrier;
95	<	*     parentBarrier.register();
184	>	*  <pre> {@code
185	>	* void awaitPhase(Phaser phaser, int phase) {
186	>	*   int p = phaser.register(); // assumes caller not already registered
187	>	*   while (p < phase) {
188	>	*     if (phaser.isTerminated())
189	>	*       // ... deal with unexpected termination
190	>	*     else
191	>	*       p = phaser.arriveAndAwaitAdvance();
192		*   }
193	<	*   protected void compute() {
194	<	*     int n = argument;
195	<	*     if (n &lt;= 1)
196	<	*        result = n;
197	<	*     else {
198	<	*        Phaser childBarrier = new Phaser(1);
199	<	*        BarrierFibonacci f1 = new BarrierFibonacci(n - 1, childBarrier);
200	<	*        BarrierFibonacci f2 = new BarrierFibonacci(n - 2, childBarrier);
201	<	*        f1.fork();
202	<	*        f2.fork();
203	<	*        childBarrier.arriveAndAwait();
204	<	*        result = f1.result + f2.result;
193	>	*   phaser.arriveAndDeregister();
194	>	* }}</pre>
195	>	*
196	>	*
197	>	* <p>To create a set of {@code n} tasks using a tree of phasers, you
198	>	* could use code of the following form, assuming a Task class with a
199	>	* constructor accepting a {@code Phaser} that it registers with upon
200	>	* construction. After invocation of {@code build(new Task[n], 0, n,
201	>	* new Phaser())}, these tasks could then be started, for example by
202	>	* submitting to a pool:
203	>	*
204	>	*  <pre> {@code
205	>	* void build(Task[] tasks, int lo, int hi, Phaser ph) {
206	>	*   if (hi - lo > TASKS_PER_PHASER) {
207	>	*     for (int i = lo; i < hi; i += TASKS_PER_PHASER) {
208	>	*       int j = Math.min(i + TASKS_PER_PHASER, hi);
209	>	*       build(tasks, i, j, new Phaser(ph));
210		*     }
211	<	*     parentBarrier.arriveAndDeregister();
211	>	*   } else {
212	>	*     for (int i = lo; i < hi; ++i)
213	>	*       tasks[i] = new Task(ph);
214	>	*       // assumes new Task(ph) performs ph.register()
215		*   }
216	<	* }
217	<	* </pre>
216	>	* }}</pre>
217	>	*
218	>	* The best value of {@code TASKS_PER_PHASER} depends mainly on
219	>	* expected synchronization rates. A value as low as four may
220	>	* be appropriate for extremely small per-phase task bodies (thus
221	>	* high rates), or up to hundreds for extremely large ones.
222		*
223		* <p><b>Implementation notes</b>: This implementation restricts the
224	<	* maximum number of parties to 65535. Attempts to register
225	<	* additional parties result in IllegalStateExceptions.
224	>	* maximum number of parties to 65535. Attempts to register additional
225	>	* parties result in {@code IllegalStateException}. However, you can and
226	>	* should create tiered phasers to accommodate arbitrarily large sets
227	>	* of participants.
228	>	*
229	>	* @since 1.7
230	>	* @author Doug Lea
231		*/
232		public class Phaser {
233		/*
234		* This class implements an extension of X10 "clocks".  Thanks to
235	<	* Vijay Saraswat for the idea of applying it to ForkJoinTasks,
236	<	* and to Vivek Sarkar for enhancements to extend functionality.
235	>	* Vijay Saraswat for the idea, and to Vivek Sarkar for
236	>	* enhancements to extend functionality.
237		*/
238
239		/**
240	<	* Barrier state representation. Conceptually, a barrier contains
128	<	* four values:
240	>	* Primary state representation, holding four fields:
241		*
242	<	* * parties -- the number of parties to wait (16 bits)
243	<	* * unarrived -- the number of parties yet to hit barrier (16 bits)
244	<	* * phase -- the generation of the barrier (31 bits)
245	<	* * terminated -- set if barrier is terminated (1 bit)
242	>	* * unarrived -- the number of parties yet to hit barrier (bits  0-15)
243	>	* * parties -- the number of parties to wait              (bits 16-31)
244	>	* * phase -- the generation of the barrier                (bits 32-62)
245	>	* * terminated -- set if barrier is terminated            (bit  63 / sign)
246		*
247	<	* However, to efficiently maintain atomicity, these values are
248	<	* packed into a single AtomicLong. Termination uses the sign bit
249	<	* of 32 bit representation of phase, so phase is set to -1 on
250	<	* termination.
251	<	*/
252	<	private final AtomicLong state;
253	<
254	<	/**
255	<	* Head of Treiber stack for waiting nonFJ threads.
256	<	*/
257	<	private final AtomicReference<QNode> head = new AtomicReference<QNode>();
247	>	* Except that a phaser with no registered parties is
248	>	* distinguished with the otherwise illegal state of having zero
249	>	* parties and one unarrived parties (encoded as EMPTY below).
250	>	*
251	>	* To efficiently maintain atomicity, these values are packed into
252	>	* a single (atomic) long. Good performance relies on keeping
253	>	* state decoding and encoding simple, and keeping race windows
254	>	* short.
255	>	*
256	>	* All state updates are performed via CAS except initial
257	>	* registration of a sub-phaser (i.e., one with a non-null
258	>	* parent).  In this (relatively rare) case, we use built-in
259	>	* synchronization to lock while first registering with its
260	>	* parent.
261	>	*
262	>	* The phase of a subphaser is allowed to lag that of its
263	>	* ancestors until it is actually accessed -- see method
264	>	* reconcileState.
265	>	*/
266	>	private volatile long state;
267	>
268	>	private static final int  MAX_PARTIES     = 0xffff;
269	>	private static final int  MAX_PHASE       = 0x7fffffff;
270	>	private static final int  PARTIES_SHIFT   = 16;
271	>	private static final int  PHASE_SHIFT     = 32;
272	>	private static final long PHASE_MASK      = -1L << PHASE_SHIFT;
273	>	private static final int  UNARRIVED_MASK  = 0xffff;      // to mask ints
274	>	private static final long PARTIES_MASK    = 0xffff0000L; // to mask longs
275	>	private static final long TERMINATION_BIT = 1L << 63;
276	>
277	>	// some special values
278	>	private static final int  ONE_ARRIVAL     = 1;
279	>	private static final int  ONE_PARTY       = 1 << PARTIES_SHIFT;
280	>	private static final int  EMPTY           = 1;
281
282	<	private static final int ushortBits = 16;
148	<	private static final int ushortMask =  (1 << ushortBits) - 1;
149	<	private static final int phaseMask = 0x7fffffff;
282	>	// The following unpacking methods are usually manually inlined
283
284		private static int unarrivedOf(long s) {
285	<	return (int)(s & ushortMask);
285	>	int counts = (int)s;
286	>	return (counts == EMPTY) ? 0 : counts & UNARRIVED_MASK;
287		}
288
289		private static int partiesOf(long s) {
290	<	return (int)(s & (ushortMask << 16)) >>> 16;
290	>	return (int)s >>> PARTIES_SHIFT;
291		}
292
293		private static int phaseOf(long s) {
294	<	return (int)(s >>> 32);
294	>	return (int) (s >>> PHASE_SHIFT);
295		}
296
297		private static int arrivedOf(long s) {
298	<	return partiesOf(s) - unarrivedOf(s);
298	>	int counts = (int)s;
299	>	return (counts == EMPTY) ? 0 :
300	>	(counts >>> PARTIES_SHIFT) - (counts & UNARRIVED_MASK);
301		}
302
303	<	private static long stateFor(int phase, int parties, int unarrived) {
304	<	return (((long)phase) << 32) | ((parties << 16) | unarrived);
305	<	}
303	>	/**
304	>	* The parent of this phaser, or null if none
305	>	*/
306	>	private final Phaser parent;
307
308	<	private static IllegalStateException badBounds(int parties, int unarrived) {
309	<	return new IllegalStateException("Attempt to set " + unarrived +
310	<	" unarrived of " + parties + " parties");
311	<	}
308	>	/**
309	>	* The root of phaser tree. Equals this if not in a tree.
310	>	*/
311	>	private final Phaser root;
312
313		/**
314	<	* Creates a new Phaser without any initially registered parties,
315	<	* and initial phase number 0.
314	>	* Heads of Treiber stacks for waiting threads. To eliminate
315	>	* contention when releasing some threads while adding others, we
316	>	* use two of them, alternating across even and odd phases.
317	>	* Subphasers share queues with root to speed up releases.
318		*/
319	<	public Phaser() {
320	<	state = new AtomicLong(stateFor(0, 0, 0));
319	>	private final AtomicReference<QNode> evenQ;
320	>	private final AtomicReference<QNode> oddQ;
321	>
322	>	private AtomicReference<QNode> queueFor(int phase) {
323	>	return ((phase & 1) == 0) ? evenQ : oddQ;
324		}
325
326		/**
327	<	* Creates a new Phaser with the given numbers of registered
186	<	* unarrived parties and initial phase number 0.
187	<	* @param parties the number of parties required to trip barrier.
188	<	* @throws IllegalArgumentException if parties less than zero
189	<	* or greater than the maximum number of parties supported.
327	>	* Returns message string for bounds exceptions on arrival.
328		*/
329	<	public Phaser(int parties) {
330	<	if (parties < 0 || parties > ushortMask)
331	<	throw new IllegalArgumentException("Illegal number of parties");
194	<	state = new AtomicLong(stateFor(0, parties, parties));
329	>	private String badArrive(long s) {
330	>	return "Attempted arrival of unregistered party for " +
331	>	stateToString(s);
332		}
333
334		/**
335	<	* Adds a new unarrived party to this phaser.
199	<	* @return the current barrier phase number upon registration
200	<	* @throws IllegalStateException if attempting to register more
201	<	* than the maximum supported number of parties.
335	>	* Returns message string for bounds exceptions on registration.
336		*/
337	<	public int register() { // increment both parties and unarrived
338	<	final AtomicLong state = this.state;
339	<	for (;;) {
206	<	long s = state.get();
207	<	int phase = phaseOf(s);
208	<	int parties = partiesOf(s) + 1;
209	<	int unarrived = unarrivedOf(s) + 1;
210	<	if (parties > ushortMask || unarrived > ushortMask)
211	<	throw badBounds(parties, unarrived);
212	<	if (state.compareAndSet(s, stateFor(phase, parties, unarrived)))
213	<	return phase;
214	<	}
337	>	private String badRegister(long s) {
338	>	return "Attempt to register more than " +
339	>	MAX_PARTIES + " parties for " + stateToString(s);
340		}
341
342		/**
343	<	* Arrives at the barrier, but does not wait for others.  (You can
344	<	* in turn wait for others via {@link #awaitAdvance}).
343	>	* Main implementation for methods arrive and arriveAndDeregister.
344	>	* Manually tuned to speed up and minimize race windows for the
345	>	* common case of just decrementing unarrived field.
346		*
347	<	* @return the current barrier phase number upon entry to
222	<	* this method, or a negative value if terminated;
223	<	* @throws IllegalStateException if the number of unarrived
224	<	* parties would become negative.
347	>	* @param deregister false for arrive, true for arriveAndDeregister
348		*/
349	<	public int arrive() { // decrement unarrived. If zero, trip
350	<	final AtomicLong state = this.state;
349	>	private int doArrive(boolean deregister) {
350	>	int adj = deregister ? ONE_ARRIVAL|ONE_PARTY : ONE_ARRIVAL;
351	>	final Phaser root = this.root;
352		for (;;) {
353	<	long s = state.get();
354	<	int phase = phaseOf(s);
355	<	int parties = partiesOf(s);
356	<	int unarrived = unarrivedOf(s) - 1;
357	<	if (unarrived < 0)
234	<	throw badBounds(parties, unarrived);
235	<	if (unarrived == 0 && phase >= 0) {
236	<	trip(phase, parties);
353	>	long s = (root == this) ? state : reconcileState();
354	>	int phase = (int)(s >>> PHASE_SHIFT);
355	>	int counts = (int)s;
356	>	int unarrived = (counts & UNARRIVED_MASK) - 1;
357	>	if (phase < 0)
358		return phase;
359	+	else if (counts == EMPTY || unarrived < 0) {
360	+	if (root == this || reconcileState() == s)
361	+	throw new IllegalStateException(badArrive(s));
362		}
363	<	if (state.compareAndSet(s, stateFor(phase, parties, unarrived)))
363	>	else if (UNSAFE.compareAndSwapLong(this, stateOffset, s, s-=adj)) {
364	>	if (unarrived == 0) {
365	>	long n = s & PARTIES_MASK;  // base of next state
366	>	int nextUnarrived = ((int)n) >>> PARTIES_SHIFT;
367	>	if (root != this)
368	>	return parent.doArrive(nextUnarrived == 0);
369	>	if (onAdvance(phase, nextUnarrived))
370	>	n |= TERMINATION_BIT;
371	>	else if (nextUnarrived == 0)
372	>	n |= EMPTY;
373	>	else
374	>	n |= nextUnarrived;
375	>	n |= ((long)((phase + 1) & MAX_PHASE)) << PHASE_SHIFT;
376	>	UNSAFE.compareAndSwapLong(this, stateOffset, s, n);
377	>	releaseWaiters(phase);
378	>	}
379		return phase;
380	+	}
381		}
382		}
383
384		/**
385	<	* Arrives at the barrier, and deregisters from it, without
246	<	* waiting for others.
385	>	* Implementation of register, bulkRegister
386		*
387	<	* @return the current barrier phase number upon entry to
388	<	* this method, or a negative value if terminated;
250	<	* @throws IllegalStateException if the number of registered or
251	<	* unarrived parties would become negative.
387	>	* @param registrations number to add to both parties and
388	>	* unarrived fields. Must be greater than zero.
389		*/
390	<	public int arriveAndDeregister() { // Same as arrive, plus decrement parties
391	<	final AtomicLong state = this.state;
390	>	private int doRegister(int registrations) {
391	>	// adjustment to state
392	>	long adj = ((long)registrations << PARTIES_SHIFT) | registrations;
393	>	Phaser par = parent;
394	>	int phase;
395		for (;;) {
396	<	long s = state.get();
397	<	int phase = phaseOf(s);
398	<	int parties = partiesOf(s) - 1;
399	<	int unarrived = unarrivedOf(s) - 1;
400	<	if (parties < 0 || unarrived < 0)
401	<	throw badBounds(parties, unarrived);
402	<	if (unarrived == 0 && phase >= 0) {
403	<	trip(phase, parties);
404	<	return phase;
396	>	long s = state;
397	>	int counts = (int)s;
398	>	int parties = counts >>> PARTIES_SHIFT;
399	>	int unarrived = counts & UNARRIVED_MASK;
400	>	if (registrations > MAX_PARTIES - parties)
401	>	throw new IllegalStateException(badRegister(s));
402	>	else if ((phase = (int)(s >>> PHASE_SHIFT)) < 0)
403	>	break;
404	>	else if (counts != EMPTY) {             // not 1st registration
405	>	if (par == null || reconcileState() == s) {
406	>	if (unarrived == 0)             // wait out advance
407	>	root.internalAwaitAdvance(phase, null);
408	>	else if (UNSAFE.compareAndSwapLong(this, stateOffset,
409	>	s, s + adj))
410	>	break;
411	>	}
412		}
413	<	if (state.compareAndSet(s, stateFor(phase, parties, unarrived)))
414	<	return phase;
413	>	else if (par == null) {                 // 1st root registration
414	>	long next = (((long) phase) << PHASE_SHIFT) | adj;
415	>	if (UNSAFE.compareAndSwapLong(this, stateOffset, s, next))
416	>	break;
417	>	}
418	>	else {
419	>	synchronized (this) {               // 1st sub registration
420	>	if (state == s) {               // recheck under lock
421	>	par.doRegister(1);
422	>	do {                        // force current phase
423	>	phase = (int)(root.state >>> PHASE_SHIFT);
424	>	// assert phase < 0 || (int)state == EMPTY;
425	>	} while (!UNSAFE.compareAndSwapLong
426	>	(this, stateOffset, state,
427	>	(((long) phase) << PHASE_SHIFT) | adj));
428	>	break;
429	>	}
430	>	}
431	>	}
432	>	}
433	>	return phase;
434	>	}
435	>
436	>	/**
437	>	* Resolves lagged phase propagation from root if necessary.
438	>	* Reconciliation normally occurs when root has advanced but
439	>	* subphasers have not yet done so, in which case they must finish
440	>	* their own advance by setting unarrived to parties (or if
441	>	* parties is zero, resetting to unregistered EMPTY state).
442	>	* However, this method may also be called when "floating"
443	>	* subphasers with possibly some unarrived parties are merely
444	>	* catching up to current phase, in which case counts are
445	>	* unaffected.
446	>	*
447	>	* @return reconciled state
448	>	*/
449	>	private long reconcileState() {
450	>	final Phaser root = this.root;
451	>	long s = state;
452	>	if (root != this) {
453	>	int phase, u, p;
454	>	// CAS root phase with current parties; possibly trip unarrived
455	>	while ((phase = (int)(root.state >>> PHASE_SHIFT)) !=
456	>	(int)(s >>> PHASE_SHIFT) &&
457	>	!UNSAFE.compareAndSwapLong
458	>	(this, stateOffset, s,
459	>	s = ((((long) phase) << PHASE_SHIFT) | (s & PARTIES_MASK) |
460	>	((p = (int)s >>> PARTIES_SHIFT) == 0 ? EMPTY :
461	>	(u = (int)s & UNARRIVED_MASK) == 0 ? p : u))))
462	>	s = state;
463		}
464	+	return s;
465	+	}
466	+
467	+	/**
468	+	* Creates a new phaser with no initially registered parties, no
469	+	* parent, and initial phase number 0. Any thread using this
470	+	* phaser will need to first register for it.
471	+	*/
472	+	public Phaser() {
473	+	this(null, 0);
474	+	}
475	+
476	+	/**
477	+	* Creates a new phaser with the given number of registered
478	+	* unarrived parties, no parent, and initial phase number 0.
479	+	*
480	+	* @param parties the number of parties required to advance to the
481	+	* next phase
482	+	* @throws IllegalArgumentException if parties less than zero
483	+	* or greater than the maximum number of parties supported
484	+	*/
485	+	public Phaser(int parties) {
486	+	this(null, parties);
487		}
488
489		/**
490	<	* Arrives at the barrier and awaits others. Unlike other arrival
491	<	* methods, this method returns the arrival index of the
492	<	* caller. The caller tripping the barrier returns zero, the
493	<	* previous caller 1, and so on.
494	<	* @return the arrival index
495	<	* @throws IllegalStateException if the number of unarrived
496	<	* parties would become negative.
490	>	* Equivalent to {@link #Phaser(Phaser, int) Phaser(parent, 0)}.
491	>	*
492	>	* @param parent the parent phaser
493	>	*/
494	>	public Phaser(Phaser parent) {
495	>	this(parent, 0);
496	>	}
497	>
498	>	/**
499	>	* Creates a new phaser with the given parent and number of
500	>	* registered unarrived parties.  When the given parent is non-null
501	>	* and the given number of parties is greater than zero, this
502	>	* child phaser is registered with its parent.
503	>	*
504	>	* @param parent the parent phaser
505	>	* @param parties the number of parties required to advance to the
506	>	* next phase
507	>	* @throws IllegalArgumentException if parties less than zero
508	>	* or greater than the maximum number of parties supported
509	>	*/
510	>	public Phaser(Phaser parent, int parties) {
511	>	if (parties >>> PARTIES_SHIFT != 0)
512	>	throw new IllegalArgumentException("Illegal number of parties");
513	>	int phase = 0;
514	>	this.parent = parent;
515	>	if (parent != null) {
516	>	final Phaser root = parent.root;
517	>	this.root = root;
518	>	this.evenQ = root.evenQ;
519	>	this.oddQ = root.oddQ;
520	>	if (parties != 0)
521	>	phase = parent.doRegister(1);
522	>	}
523	>	else {
524	>	this.root = this;
525	>	this.evenQ = new AtomicReference<QNode>();
526	>	this.oddQ = new AtomicReference<QNode>();
527	>	}
528	>	this.state = (parties == 0) ? (long) EMPTY :
529	>	((((long) phase) << PHASE_SHIFT) |
530	>	(((long) parties) << PARTIES_SHIFT) |
531	>	((long) parties));
532	>	}
533	>
534	>	/**
535	>	* Adds a new unarrived party to this phaser.  If an ongoing
536	>	* invocation of {@link #onAdvance} is in progress, this method
537	>	* may await its completion before returning.  If this phaser has
538	>	* a parent, and this phaser previously had no registered parties,
539	>	* this child phaser is also registered with its parent. If
540	>	* this phaser is terminated, the attempt to register has
541	>	* no effect, and a negative value is returned.
542	>	*
543	>	* @return the arrival phase number to which this registration
544	>	* applied.  If this value is negative, then this phaser has
545	>	* terminated, in which case registration has no effect.
546	>	* @throws IllegalStateException if attempting to register more
547	>	* than the maximum supported number of parties
548	>	*/
549	>	public int register() {
550	>	return doRegister(1);
551	>	}
552	>
553	>	/**
554	>	* Adds the given number of new unarrived parties to this phaser.
555	>	* If an ongoing invocation of {@link #onAdvance} is in progress,
556	>	* this method may await its completion before returning.  If this
557	>	* phaser has a parent, and the given number of parties is greater
558	>	* than zero, and this phaser previously had no registered
559	>	* parties, this child phaser is also registered with its parent.
560	>	* If this phaser is terminated, the attempt to register has no
561	>	* effect, and a negative value is returned.
562	>	*
563	>	* @param parties the number of additional parties required to
564	>	* advance to the next phase
565	>	* @return the arrival phase number to which this registration
566	>	* applied.  If this value is negative, then this phaser has
567	>	* terminated, in which case registration has no effect.
568	>	* @throws IllegalStateException if attempting to register more
569	>	* than the maximum supported number of parties
570	>	* @throws IllegalArgumentException if {@code parties < 0}
571	>	*/
572	>	public int bulkRegister(int parties) {
573	>	if (parties < 0)
574	>	throw new IllegalArgumentException();
575	>	if (parties == 0)
576	>	return getPhase();
577	>	return doRegister(parties);
578	>	}
579	>
580	>	/**
581	>	* Arrives at this phaser, without waiting for others to arrive.
582	>	*
583	>	* <p>It is a usage error for an unregistered party to invoke this
584	>	* method.  However, this error may result in an {@code
585	>	* IllegalStateException} only upon some subsequent operation on
586	>	* this phaser, if ever.
587	>	*
588	>	* @return the arrival phase number, or a negative value if terminated
589	>	* @throws IllegalStateException if not terminated and the number
590	>	* of unarrived parties would become negative
591	>	*/
592	>	public int arrive() {
593	>	return doArrive(false);
594	>	}
595	>
596	>	/**
597	>	* Arrives at this phaser and deregisters from it without waiting
598	>	* for others to arrive. Deregistration reduces the number of
599	>	* parties required to advance in future phases.  If this phaser
600	>	* has a parent, and deregistration causes this phaser to have
601	>	* zero parties, this phaser is also deregistered from its parent.
602	>	*
603	>	* <p>It is a usage error for an unregistered party to invoke this
604	>	* method.  However, this error may result in an {@code
605	>	* IllegalStateException} only upon some subsequent operation on
606	>	* this phaser, if ever.
607	>	*
608	>	* @return the arrival phase number, or a negative value if terminated
609	>	* @throws IllegalStateException if not terminated and the number
610	>	* of registered or unarrived parties would become negative
611	>	*/
612	>	public int arriveAndDeregister() {
613	>	return doArrive(true);
614	>	}
615	>
616	>	/**
617	>	* Arrives at this phaser and awaits others. Equivalent in effect
618	>	* to {@code awaitAdvance(arrive())}.  If you need to await with
619	>	* interruption or timeout, you can arrange this with an analogous
620	>	* construction using one of the other forms of the {@code
621	>	* awaitAdvance} method.  If instead you need to deregister upon
622	>	* arrival, use {@code awaitAdvance(arriveAndDeregister())}.
623	>	*
624	>	* <p>It is a usage error for an unregistered party to invoke this
625	>	* method.  However, this error may result in an {@code
626	>	* IllegalStateException} only upon some subsequent operation on
627	>	* this phaser, if ever.
628	>	*
629	>	* @return the arrival phase number, or the (negative)
630	>	* {@linkplain #getPhase() current phase} if terminated
631	>	* @throws IllegalStateException if not terminated and the number
632	>	* of unarrived parties would become negative
633		*/
634		public int arriveAndAwaitAdvance() {
635	<	final AtomicLong state = this.state;
635	>	// Specialization of doArrive+awaitAdvance eliminating some reads/paths
636	>	final Phaser root = this.root;
637		for (;;) {
638	<	long s = state.get();
639	<	int phase = phaseOf(s);
640	<	int parties = partiesOf(s);
641	<	int unarrived = unarrivedOf(s) - 1;
642	<	if (unarrived < 0)
643	<	throw badBounds(parties, unarrived);
644	<	if (unarrived == 0 && phase >= 0) {
645	<	trip(phase, parties);
646	<	return 0;
638	>	long s = (root == this) ? state : reconcileState();
639	>	int phase = (int)(s >>> PHASE_SHIFT);
640	>	int counts = (int)s;
641	>	int unarrived = (counts & UNARRIVED_MASK) - 1;
642	>	if (phase < 0)
643	>	return phase;
644	>	else if (counts == EMPTY || unarrived < 0) {
645	>	if (reconcileState() == s)
646	>	throw new IllegalStateException(badArrive(s));
647		}
648	<	if (state.compareAndSet(s, stateFor(phase, parties, unarrived))) {
649	<	awaitAdvance(phase);
650	<	return unarrived;
648	>	else if (UNSAFE.compareAndSwapLong(this, stateOffset, s,
649	>	s -= ONE_ARRIVAL)) {
650	>	if (unarrived != 0)
651	>	return root.internalAwaitAdvance(phase, null);
652	>	if (root != this)
653	>	return parent.arriveAndAwaitAdvance();
654	>	long n = s & PARTIES_MASK;  // base of next state
655	>	int nextUnarrived = ((int)n) >>> PARTIES_SHIFT;
656	>	if (onAdvance(phase, nextUnarrived))
657	>	n |= TERMINATION_BIT;
658	>	else if (nextUnarrived == 0)
659	>	n |= EMPTY;
660	>	else
661	>	n |= nextUnarrived;
662	>	int nextPhase = (phase + 1) & MAX_PHASE;
663	>	n |= (long)nextPhase << PHASE_SHIFT;
664	>	if (!UNSAFE.compareAndSwapLong(this, stateOffset, s, n))
665	>	return (int)(state >>> PHASE_SHIFT); // terminated
666	>	releaseWaiters(phase);
667	>	return nextPhase;
668		}
669		}
670		}
671
672		/**
673	<	* Awaits the phase of the barrier to advance from the given
674	<	* value, or returns immediately if this barrier is terminated.
675	<	* @param phase the phase on entry to this method
676	<	* @return the phase on exit from this method
673	>	* Awaits the phase of this phaser to advance from the given phase
674	>	* value, returning immediately if the current phase is not equal
675	>	* to the given phase value or this phaser is terminated.
676	>	*
677	>	* @param phase an arrival phase number, or negative value if
678	>	* terminated; this argument is normally the value returned by a
679	>	* previous call to {@code arrive} or {@code arriveAndDeregister}.
680	>	* @return the next arrival phase number, or the argument if it is
681	>	* negative, or the (negative) {@linkplain #getPhase() current phase}
682	>	* if terminated
683		*/
684		public int awaitAdvance(int phase) {
685	+	final Phaser root = this.root;
686	+	long s = (root == this) ? state : reconcileState();
687	+	int p = (int)(s >>> PHASE_SHIFT);
688		if (phase < 0)
689		return phase;
690	<	Thread current = Thread.currentThread();
691	<	if (current instanceof ForkJoinWorkerThread)
692	<	return helpingWait(phase);
312	<	if (untimedWait(current, phase, false))
313	<	current.interrupt();
314	<	return phaseOf(state.get());
690	>	if (p == phase)
691	>	return root.internalAwaitAdvance(phase, null);
692	>	return p;
693		}
694
695		/**
696	<	* Awaits the phase of the barrier to advance from the given
697	<	* value, or returns immediately if this barrier is terminated, or
698	<	* throws InterruptedException if interrupted while waiting.
699	<	* @param phase the phase on entry to this method
700	<	* @return the phase on exit from this method
696	>	* Awaits the phase of this phaser to advance from the given phase
697	>	* value, throwing {@code InterruptedException} if interrupted
698	>	* while waiting, or returning immediately if the current phase is
699	>	* not equal to the given phase value or this phaser is
700	>	* terminated.
701	>	*
702	>	* @param phase an arrival phase number, or negative value if
703	>	* terminated; this argument is normally the value returned by a
704	>	* previous call to {@code arrive} or {@code arriveAndDeregister}.
705	>	* @return the next arrival phase number, or the argument if it is
706	>	* negative, or the (negative) {@linkplain #getPhase() current phase}
707	>	* if terminated
708		* @throws InterruptedException if thread interrupted while waiting
709		*/
710	<	public int awaitAdvanceInterruptibly(int phase) throws InterruptedException {
710	>	public int awaitAdvanceInterruptibly(int phase)
711	>	throws InterruptedException {
712	>	final Phaser root = this.root;
713	>	long s = (root == this) ? state : reconcileState();
714	>	int p = (int)(s >>> PHASE_SHIFT);
715		if (phase < 0)
716		return phase;
717	<	Thread current = Thread.currentThread();
718	<	if (current instanceof ForkJoinWorkerThread)
719	<	return helpingWait(phase);
720	<	else if (Thread.interrupted() || untimedWait(current, phase, true))
721	<	throw new InterruptedException();
722	<	else
723	<	return phaseOf(state.get());
717	>	if (p == phase) {
718	>	QNode node = new QNode(this, phase, true, false, 0L);
719	>	p = root.internalAwaitAdvance(phase, node);
720	>	if (node.wasInterrupted)
721	>	throw new InterruptedException();
722	>	}
723	>	return p;
724		}
725
726		/**
727	<	* Awaits the phase of the barrier to advance from the given value
728	<	* or the given timeout elapses, or returns immediately if this
729	<	* barrier is terminated.
730	<	* @param phase the phase on entry to this method
731	<	* @return the phase on exit from this method
727	>	* Awaits the phase of this phaser to advance from the given phase
728	>	* value or the given timeout to elapse, throwing {@code
729	>	* InterruptedException} if interrupted while waiting, or
730	>	* returning immediately if the current phase is not equal to the
731	>	* given phase value or this phaser is terminated.
732	>	*
733	>	* @param phase an arrival phase number, or negative value if
734	>	* terminated; this argument is normally the value returned by a
735	>	* previous call to {@code arrive} or {@code arriveAndDeregister}.
736	>	* @param timeout how long to wait before giving up, in units of
737	>	*        {@code unit}
738	>	* @param unit a {@code TimeUnit} determining how to interpret the
739	>	*        {@code timeout} parameter
740	>	* @return the next arrival phase number, or the argument if it is
741	>	* negative, or the (negative) {@linkplain #getPhase() current phase}
742	>	* if terminated
743		* @throws InterruptedException if thread interrupted while waiting
744		* @throws TimeoutException if timed out while waiting
745		*/
746	<	public int awaitAdvanceInterruptibly(int phase, long timeout, TimeUnit unit)
746	>	public int awaitAdvanceInterruptibly(int phase,
747	>	long timeout, TimeUnit unit)
748		throws InterruptedException, TimeoutException {
749	+	long nanos = unit.toNanos(timeout);
750	+	final Phaser root = this.root;
751	+	long s = (root == this) ? state : reconcileState();
752	+	int p = (int)(s >>> PHASE_SHIFT);
753		if (phase < 0)
754		return phase;
755	<	long nanos = unit.toNanos(timeout);
756	<	Thread current = Thread.currentThread();
757	<	if (current instanceof ForkJoinWorkerThread)
758	<	return timedHelpingWait(phase, nanos);
759	<	timedWait(current, phase, nanos);
760	<	return phaseOf(state.get());
755	>	if (p == phase) {
756	>	QNode node = new QNode(this, phase, true, true, nanos);
757	>	p = root.internalAwaitAdvance(phase, node);
758	>	if (node.wasInterrupted)
759	>	throw new InterruptedException();
760	>	else if (p == phase)
761	>	throw new TimeoutException();
762	>	}
763	>	return p;
764		}
765
766		/**
767	<	* Forces this barrier to enter termination state. Counts of
768	<	* arrived and registered parties are unaffected. This method may
769	<	* be useful for coordinating recovery after one or more tasks
770	<	* encounter unexpected exceptions.
767	>	* Forces this phaser to enter termination state.  Counts of
768	>	* registered parties are unaffected.  If this phaser is a member
769	>	* of a tiered set of phasers, then all of the phasers in the set
770	>	* are terminated.  If this phaser is already terminated, this
771	>	* method has no effect.  This method may be useful for
772	>	* coordinating recovery after one or more tasks encounter
773	>	* unexpected exceptions.
774		*/
775		public void forceTermination() {
776	<	final AtomicLong state = this.state;
777	<	for (;;) {
778	<	long s = state.get();
779	<	int phase = phaseOf(s);
780	<	int parties = partiesOf(s);
781	<	int unarrived = unarrivedOf(s);
782	<	if (phase < 0 ||
783	<	state.compareAndSet(s, stateFor(-1, parties, unarrived))) {
784	<	if (head.get() != null)
374	<	releaseWaiters(-1);
776	>	// Only need to change root state
777	>	final Phaser root = this.root;
778	>	long s;
779	>	while ((s = root.state) >= 0) {
780	>	if (UNSAFE.compareAndSwapLong(root, stateOffset,
781	>	s, s | TERMINATION_BIT)) {
782	>	// signal all threads
783	>	releaseWaiters(0);
784	>	releaseWaiters(1);
785		return;
786		}
787		}
788		}
789
790		/**
381	–	* Resets the barrier with the given numbers of registered unarrived
382	–	* parties and phase number 0. This method allows repeated reuse
383	–	* of this barrier, but only if it is somehow known not to be in
384	–	* use for other purposes.
385	–	* @param parties the number of parties required to trip barrier.
386	–	* @throws IllegalArgumentException if parties less than zero
387	–	* or greater than the maximum number of parties supported.
388	–	*/
389	–	public void reset(int parties) {
390	–	if (parties < 0 || parties > ushortMask)
391	–	throw new IllegalArgumentException("Illegal number of parties");
392	–	state.set(stateFor(0, parties, parties));
393	–	if (head.get() != null)
394	–	releaseWaiters(0);
395	–	}
396	–
397	–	/**
791		* Returns the current phase number. The maximum phase number is
792	<	* <tt>Integer.MAX_VALUE</tt>, after which it restarts at
793	<	* zero. Upon termination, the phase number is negative.
792	>	* {@code Integer.MAX_VALUE}, after which it restarts at
793	>	* zero. Upon termination, the phase number is negative,
794	>	* in which case the prevailing phase prior to termination
795	>	* may be obtained via {@code getPhase() + Integer.MIN_VALUE}.
796	>	*
797		* @return the phase number, or a negative value if terminated
798		*/
799	<	public int getPhase() {
800	<	return phaseOf(state.get());
799	>	public final int getPhase() {
800	>	return (int)(root.state >>> PHASE_SHIFT);
801		}
802
803		/**
804	<	* Returns the number of parties registered at this barrier.
804	>	* Returns the number of parties registered at this phaser.
805	>	*
806		* @return the number of parties
807		*/
808		public int getRegisteredParties() {
809	<	return partiesOf(state.get());
809	>	return partiesOf(state);
810		}
811
812		/**
813	<	* Returns the number of parties that have arrived at the current
814	<	* phase of this barrier.
813	>	* Returns the number of registered parties that have arrived at
814	>	* the current phase of this phaser. If this phaser has terminated,
815	>	* the returned value is meaningless and arbitrary.
816	>	*
817		* @return the number of arrived parties
818		*/
819		public int getArrivedParties() {
820	<	return arrivedOf(state.get());
820	>	return arrivedOf(reconcileState());
821		}
822
823		/**
824		* Returns the number of registered parties that have not yet
825	<	* arrived at the current phase of this barrier.
825	>	* arrived at the current phase of this phaser. If this phaser has
826	>	* terminated, the returned value is meaningless and arbitrary.
827	>	*
828		* @return the number of unarrived parties
829		*/
830		public int getUnarrivedParties() {
831	<	return unarrivedOf(state.get());
831	>	return unarrivedOf(reconcileState());
832		}
833
834		/**
835	<	* Returns true if this barrier has been terminated.
836	<	* @return true if this barrier has been terminated
835	>	* Returns the parent of this phaser, or {@code null} if none.
836	>	*
837	>	* @return the parent of this phaser, or {@code null} if none
838	>	*/
839	>	public Phaser getParent() {
840	>	return parent;
841	>	}
842	>
843	>	/**
844	>	* Returns the root ancestor of this phaser, which is the same as
845	>	* this phaser if it has no parent.
846	>	*
847	>	* @return the root ancestor of this phaser
848	>	*/
849	>	public Phaser getRoot() {
850	>	return root;
851	>	}
852	>
853	>	/**
854	>	* Returns {@code true} if this phaser has been terminated.
855	>	*
856	>	* @return {@code true} if this phaser has been terminated
857		*/
858		public boolean isTerminated() {
859	<	return phaseOf(state.get()) < 0;
859	>	return root.state < 0L;
860		}
861
862		/**
863	<	* Overridable method to perform an action upon phase advance, and
864	<	* to control termination. This method is invoked whenever the
865	<	* barrier is tripped (and thus all other waiting parties are
866	<	* dormant). If it returns true, then, rather than advance the
867	<	* phase number, this barrier will be set to a final termination
868	<	* state, and subsequent calls to <tt>isTerminated</tt> will
869	<	* return true.
870	<	*
871	<	* <p> The default version returns true when the number of
872	<	* registered parties is zero. Normally, overrides that arrange
873	<	* termination for other reasons should also preserve this
874	<	* property.
875	<	*
876	<	* @param phase the phase number on entering the barrier
877	<	* @param registeredParties the current number of registered
878	<	* parties.
879	<	* @return true if this barrier should terminate
863	>	* Overridable method to perform an action upon impending phase
864	>	* advance, and to control termination. This method is invoked
865	>	* upon arrival of the party advancing this phaser (when all other
866	>	* waiting parties are dormant).  If this method returns {@code
867	>	* true}, this phaser will be set to a final termination state
868	>	* upon advance, and subsequent calls to {@link #isTerminated}
869	>	* will return true. Any (unchecked) Exception or Error thrown by
870	>	* an invocation of this method is propagated to the party
871	>	* attempting to advance this phaser, in which case no advance
872	>	* occurs.
873	>	*
874	>	* <p>The arguments to this method provide the state of the phaser
875	>	* prevailing for the current transition.  The effects of invoking
876	>	* arrival, registration, and waiting methods on this phaser from
877	>	* within {@code onAdvance} are unspecified and should not be
878	>	* relied on.
879	>	*
880	>	* <p>If this phaser is a member of a tiered set of phasers, then
881	>	* {@code onAdvance} is invoked only for its root phaser on each
882	>	* advance.
883	>	*
884	>	* <p>To support the most common use cases, the default
885	>	* implementation of this method returns {@code true} when the
886	>	* number of registered parties has become zero as the result of a
887	>	* party invoking {@code arriveAndDeregister}.  You can disable
888	>	* this behavior, thus enabling continuation upon future
889	>	* registrations, by overriding this method to always return
890	>	* {@code false}:
891	>	*
892	>	* <pre> {@code
893	>	* Phaser phaser = new Phaser() {
894	>	*   protected boolean onAdvance(int phase, int parties) { return false; }
895	>	* }}</pre>
896	>	*
897	>	* @param phase the current phase number on entry to this method,
898	>	* before this phaser is advanced
899	>	* @param registeredParties the current number of registered parties
900	>	* @return {@code true} if this phaser should terminate
901		*/
902		protected boolean onAdvance(int phase, int registeredParties) {
903	<	return registeredParties <= 0;
903	>	return registeredParties == 0;
904		}
905
906		/**
907	<	* Returns a string identifying this barrier, as well as its
907	>	* Returns a string identifying this phaser, as well as its
908		* state.  The state, in brackets, includes the String {@code
909	<	* "phase ="} followed by the phase number, {@code "parties ="}
909	>	* "phase = "} followed by the phase number, {@code "parties = "}
910		* followed by the number of registered parties, and {@code
911	<	* "arrived ="} followed by the number of arrived parties
911	>	* "arrived = "} followed by the number of arrived parties.
912		*
913	<	* @return a string identifying this barrier, as well as its state
913	>	* @return a string identifying this phaser, as well as its state
914		*/
915		public String toString() {
916	<	long s = state.get();
475	<	return super.toString() + "[phase = " + phaseOf(s) + " parties = " + partiesOf(s) + " arrived = " + arrivedOf(s) + "]";
916	>	return stateToString(reconcileState());
917		}
918
478	–	// methods for tripping and waiting
479	–
919		/**
920	<	* Advance the current phase (or terminate)
920	>	* Implementation of toString and string-based error messages
921		*/
922	<	private void trip(int phase, int parties) {
923	<	int next = onAdvance(phase, parties)? -1 : ((phase + 1) & phaseMask);
924	<	state.set(stateFor(next, parties, parties));
925	<	if (head.get() != null)
926	<	releaseWaiters(next);
922	>	private String stateToString(long s) {
923	>	return super.toString() +
924	>	"[phase = " + phaseOf(s) +
925	>	" parties = " + partiesOf(s) +
926	>	" arrived = " + arrivedOf(s) + "]";
927		}
928
929	<	private int helpingWait(int phase) {
491	<	final AtomicLong state = this.state;
492	<	int p;
493	<	while ((p = phaseOf(state.get())) == phase) {
494	<	ForkJoinTask<?> t = ForkJoinWorkerThread.pollTask();
495	<	if (t != null) {
496	<	if ((p = phaseOf(state.get())) == phase)
497	<	t.exec();
498	<	else {   // push task and exit if barrier advanced
499	<	t.fork();
500	<	break;
501	<	}
502	<	}
503	<	}
504	<	return p;
505	<	}
929	>	// Waiting mechanics
930
931	<	private int timedHelpingWait(int phase, long nanos) throws TimeoutException {
932	<	final AtomicLong state = this.state;
933	<	long lastTime = System.nanoTime();
934	<	int p;
935	<	while ((p = phaseOf(state.get())) == phase) {
936	<	long now = System.nanoTime();
937	<	nanos -= now - lastTime;
938	<	lastTime = now;
939	<	if (nanos <= 0) {
940	<	if ((p = phaseOf(state.get())) == phase)
941	<	throw new TimeoutException();
942	<	else
943	<	break;
520	<	}
521	<	ForkJoinTask<?> t = ForkJoinWorkerThread.pollTask();
522	<	if (t != null) {
523	<	if ((p = phaseOf(state.get())) == phase)
524	<	t.exec();
525	<	else {   // push task and exit if barrier advanced
526	<	t.fork();
527	<	break;
528	<	}
931	>	/**
932	>	* Removes and signals threads from queue for phase.
933	>	*/
934	>	private void releaseWaiters(int phase) {
935	>	QNode q;   // first element of queue
936	>	Thread t;  // its thread
937	>	AtomicReference<QNode> head = (phase & 1) == 0 ? evenQ : oddQ;
938	>	while ((q = head.get()) != null &&
939	>	q.phase != (int)(root.state >>> PHASE_SHIFT)) {
940	>	if (head.compareAndSet(q, q.next) &&
941	>	(t = q.thread) != null) {
942	>	q.thread = null;
943	>	LockSupport.unpark(t);
944		}
945		}
531	–	return p;
946		}
947
948		/**
949	<	* Wait nodes for Treiber stack representing wait queue for non-FJ
950	<	* tasks. The waiting scheme is an adaptation of the one used in
951	<	* forkjoin.PoolBarrier.
949	>	* Variant of releaseWaiters that additionally tries to remove any
950	>	* nodes no longer waiting for advance due to timeout or
951	>	* interrupt. Currently, nodes are removed only if they are at
952	>	* head of queue, which suffices to reduce memory footprint in
953	>	* most usages.
954	>	*
955	>	* @return current phase on exit
956		*/
957	<	static final class QNode {
958	<	QNode next;
959	<	volatile Thread thread; // nulled to cancel wait
960	<	final int phase;
961	<	QNode(Thread t, int c) {
962	<	thread = t;
963	<	phase = c;
964	<	}
965	<	}
966	<
967	<	private void releaseWaiters(int currentPhase) {
550	<	final AtomicReference<QNode> head = this.head;
551	<	QNode p;
552	<	while ((p = head.get()) != null && p.phase != currentPhase) {
553	<	if (head.compareAndSet(p, null)) {
554	<	do {
555	<	Thread t = p.thread;
556	<	if (t != null) {
557	<	p.thread = null;
558	<	LockSupport.unpark(t);
559	<	}
560	<	} while ((p = p.next) != null);
957	>	private int abortWait(int phase) {
958	>	AtomicReference<QNode> head = (phase & 1) == 0 ? evenQ : oddQ;
959	>	for (;;) {
960	>	Thread t;
961	>	QNode q = head.get();
962	>	int p = (int)(root.state >>> PHASE_SHIFT);
963	>	if (q == null || ((t = q.thread) != null && q.phase == p))
964	>	return p;
965	>	if (head.compareAndSet(q, q.next) && t != null) {
966	>	q.thread = null;
967	>	LockSupport.unpark(t);
968		}
969		}
970		}
971
972		/** The number of CPUs, for spin control */
973	<	static final int NCPUS = Runtime.getRuntime().availableProcessors();
973	>	private static final int NCPU = Runtime.getRuntime().availableProcessors();
974
975		/**
976	<	* The number of times to spin before blocking in timed waits.
977	<	* The value is empirically derived.
976	>	* The number of times to spin before blocking while waiting for
977	>	* advance, per arrival while waiting. On multiprocessors, fully
978	>	* blocking and waking up a large number of threads all at once is
979	>	* usually a very slow process, so we use rechargeable spins to
980	>	* avoid it when threads regularly arrive: When a thread in
981	>	* internalAwaitAdvance notices another arrival before blocking,
982	>	* and there appear to be enough CPUs available, it spins
983	>	* SPINS_PER_ARRIVAL more times before blocking. The value trades
984	>	* off good-citizenship vs big unnecessary slowdowns.
985		*/
986	<	static final int maxTimedSpins = (NCPUS < 2)? 0 : 32;
986	>	static final int SPINS_PER_ARRIVAL = (NCPU < 2) ? 1 : 1 << 8;
987
988		/**
989	<	* The number of times to spin before blocking in untimed waits.
990	<	* This is greater than timed value because untimed waits spin
991	<	* faster since they don't need to check times on each spin.
992	<	*/
993	<	static final int maxUntimedSpins = maxTimedSpins * 32;
994	<
995	<	/**
996	<	* The number of nanoseconds for which it is faster to spin
997	<	* rather than to use timed park. A rough estimate suffices.
998	<	*/
999	<	static final long spinForTimeoutThreshold = 1000L;
1000	<
1001	<	/**
1002	<	* Enqueues node and waits unless aborted or signalled.
1003	<	*/
1004	<	private boolean untimedWait(Thread thread, int currentPhase,
1005	<	boolean abortOnInterrupt) {
1006	<	final AtomicReference<QNode> head = this.head;
1007	<	final AtomicLong state = this.state;
1008	<	boolean wasInterrupted = false;
1009	<	QNode node = null;
1010	<	boolean queued = false;
1011	<	int spins = maxUntimedSpins;
1012	<	while (phaseOf(state.get()) == currentPhase) {
1013	<	QNode h;
600	<	if (node != null && queued) {
601	<	if (node.thread != null) {
602	<	LockSupport.park();
603	<	if (Thread.interrupted()) {
604	<	wasInterrupted = true;
605	<	if (abortOnInterrupt)
606	<	break;
607	<	}
989	>	* Possibly blocks and waits for phase to advance unless aborted.
990	>	* Call only from root node.
991	>	*
992	>	* @param phase current phase
993	>	* @param node if non-null, the wait node to track interrupt and timeout;
994	>	* if null, denotes noninterruptible wait
995	>	* @return current phase
996	>	*/
997	>	private int internalAwaitAdvance(int phase, QNode node) {
998	>	releaseWaiters(phase-1);          // ensure old queue clean
999	>	boolean queued = false;           // true when node is enqueued
1000	>	int lastUnarrived = 0;            // to increase spins upon change
1001	>	int spins = SPINS_PER_ARRIVAL;
1002	>	long s;
1003	>	int p;
1004	>	while ((p = (int)((s = state) >>> PHASE_SHIFT)) == phase) {
1005	>	if (node == null) {           // spinning in noninterruptible mode
1006	>	int unarrived = (int)s & UNARRIVED_MASK;
1007	>	if (unarrived != lastUnarrived &&
1008	>	(lastUnarrived = unarrived) < NCPU)
1009	>	spins += SPINS_PER_ARRIVAL;
1010	>	boolean interrupted = Thread.interrupted();
1011	>	if (interrupted || --spins < 0) { // need node to record intr
1012	>	node = new QNode(this, phase, false, false, 0L);
1013	>	node.wasInterrupted = interrupted;
1014		}
1015		}
1016	<	else if ((h = head.get()) != null && h.phase != currentPhase) {
1017	<	if (phaseOf(state.get()) == currentPhase) { // must recheck
1018	<	if (head.compareAndSet(h, h.next)) {
1019	<	Thread t = h.thread; // help clear out old waiters
1020	<	if (t != null) {
1021	<	h.thread = null;
1022	<	LockSupport.unpark(t);
1023	<	}
1024	<	}
1016	>	else if (node.isReleasable()) // done or aborted
1017	>	break;
1018	>	else if (!queued) {           // push onto queue
1019	>	AtomicReference<QNode> head = (phase & 1) == 0 ? evenQ : oddQ;
1020	>	QNode q = node.next = head.get();
1021	>	if ((q == null || q.phase == phase) &&
1022	>	(int)(state >>> PHASE_SHIFT) == phase) // avoid stale enq
1023	>	queued = head.compareAndSet(q, node);
1024	>	}
1025	>	else {
1026	>	try {
1027	>	ForkJoinPool.managedBlock(node);
1028	>	} catch (InterruptedException ie) {
1029	>	node.wasInterrupted = true;
1030		}
620	–	else
621	–	break;
1031		}
623	–	else if (node != null)
624	–	queued = head.compareAndSet(node.next = h, node);
625	–	else if (spins <= 0)
626	–	node = new QNode(thread, currentPhase);
627	–	else
628	–	--spins;
1032		}
1033	<	if (node != null)
1034	<	node.thread = null;
1035	<	return wasInterrupted;
1033	>
1034	>	if (node != null) {
1035	>	if (node.thread != null)
1036	>	node.thread = null;       // avoid need for unpark()
1037	>	if (node.wasInterrupted && !node.interruptible)
1038	>	Thread.currentThread().interrupt();
1039	>	if (p == phase && (p = (int)(state >>> PHASE_SHIFT)) == phase)
1040	>	return abortWait(phase); // possibly clean up on abort
1041	>	}
1042	>	releaseWaiters(phase);
1043	>	return p;
1044		}
1045
1046		/**
1047	<	* Messier timeout version
1047	>	* Wait nodes for Treiber stack representing wait queue
1048		*/
1049	<	private void timedWait(Thread thread, int currentPhase, long nanos)
1050	<	throws InterruptedException, TimeoutException {
1051	<	final AtomicReference<QNode> head = this.head;
1052	<	final AtomicLong state = this.state;
1053	<	long lastTime = System.nanoTime();
1054	<	QNode node = null;
1055	<	boolean queued = false;
1056	<	int spins = maxTimedSpins;
1057	<	while (phaseOf(state.get()) == currentPhase) {
1058	<	QNode h;
1059	<	long now = System.nanoTime();
1060	<	nanos -= now - lastTime;
1061	<	lastTime = now;
1062	<	if (nanos <= 0) {
1063	<	if (node != null)
1064	<	node.thread = null;
1065	<	if (phaseOf(state.get()) == currentPhase)
1066	<	throw new TimeoutException();
1067	<	else
1068	<	break;
1049	>	static final class QNode implements ForkJoinPool.ManagedBlocker {
1050	>	final Phaser phaser;
1051	>	final int phase;
1052	>	final boolean interruptible;
1053	>	final boolean timed;
1054	>	boolean wasInterrupted;
1055	>	long nanos;
1056	>	long lastTime;
1057	>	volatile Thread thread; // nulled to cancel wait
1058	>	QNode next;
1059	>
1060	>	QNode(Phaser phaser, int phase, boolean interruptible,
1061	>	boolean timed, long nanos) {
1062	>	this.phaser = phaser;
1063	>	this.phase = phase;
1064	>	this.interruptible = interruptible;
1065	>	this.nanos = nanos;
1066	>	this.timed = timed;
1067	>	this.lastTime = timed ? System.nanoTime() : 0L;
1068	>	thread = Thread.currentThread();
1069	>	}
1070	>
1071	>	public boolean isReleasable() {
1072	>	if (thread == null)
1073	>	return true;
1074	>	if (phaser.getPhase() != phase) {
1075	>	thread = null;
1076	>	return true;
1077		}
1078	<	else if (node != null && queued) {
1079	<	if (node.thread != null &&
1080	<	nanos > spinForTimeoutThreshold) {
1081	<	//                LockSupport.parkNanos(this, nanos);
1082	<	LockSupport.parkNanos(nanos);
664	<	if (Thread.interrupted()) {
665	<	node.thread = null;
666	<	throw new InterruptedException();
667	<	}
668	<	}
1078	>	if (Thread.interrupted())
1079	>	wasInterrupted = true;
1080	>	if (wasInterrupted && interruptible) {
1081	>	thread = null;
1082	>	return true;
1083		}
1084	<	else if ((h = head.get()) != null && h.phase != currentPhase) {
1085	<	if (phaseOf(state.get()) == currentPhase) { // must recheck
1086	<	if (head.compareAndSet(h, h.next)) {
1087	<	Thread t = h.thread; // help clear out old waiters
1088	<	if (t != null) {
1089	<	h.thread = null;
1090	<	LockSupport.unpark(t);
1091	<	}
1092	<	}
1084	>	if (timed) {
1085	>	if (nanos > 0L) {
1086	>	long now = System.nanoTime();
1087	>	nanos -= now - lastTime;
1088	>	lastTime = now;
1089	>	}
1090	>	if (nanos <= 0L) {
1091	>	thread = null;
1092	>	return true;
1093		}
680	–	else
681	–	break;
1094		}
1095	<	else if (node != null)
1096	<	queued = head.compareAndSet(node.next = h, node);
1097	<	else if (spins <= 0)
1098	<	node = new QNode(thread, currentPhase);
1099	<	else
1100	<	--spins;
1095	>	return false;
1096	>	}
1097	>
1098	>	public boolean block() {
1099	>	if (isReleasable())
1100	>	return true;
1101	>	else if (!timed)
1102	>	LockSupport.park(this);
1103	>	else if (nanos > 0)
1104	>	LockSupport.parkNanos(this, nanos);
1105	>	return isReleasable();
1106	>	}
1107	>	}
1108	>
1109	>	// Unsafe mechanics
1110	>
1111	>	private static final sun.misc.Unsafe UNSAFE = getUnsafe();
1112	>	private static final long stateOffset =
1113	>	objectFieldOffset("state", Phaser.class);
1114	>
1115	>	private static long objectFieldOffset(String field, Class<?> klazz) {
1116	>	try {
1117	>	return UNSAFE.objectFieldOffset(klazz.getDeclaredField(field));
1118	>	} catch (NoSuchFieldException e) {
1119	>	// Convert Exception to corresponding Error
1120	>	NoSuchFieldError error = new NoSuchFieldError(field);
1121	>	error.initCause(e);
1122	>	throw error;
1123		}
690	–	if (node != null)
691	–	node.thread = null;
1124		}
1125
1126	+	/**
1127	+	* Returns a sun.misc.Unsafe.  Suitable for use in a 3rd party package.
1128	+	* Replace with a simple call to Unsafe.getUnsafe when integrating
1129	+	* into a jdk.
1130	+	*
1131	+	* @return a sun.misc.Unsafe
1132	+	*/
1133	+	private static sun.misc.Unsafe getUnsafe() {
1134	+	try {
1135	+	return sun.misc.Unsafe.getUnsafe();
1136	+	} catch (SecurityException se) {
1137	+	try {
1138	+	return java.security.AccessController.doPrivileged
1139	+	(new java.security
1140	+	.PrivilegedExceptionAction<sun.misc.Unsafe>() {
1141	+	public sun.misc.Unsafe run() throws Exception {
1142	+	java.lang.reflect.Field f = sun.misc
1143	+	.Unsafe.class.getDeclaredField("theUnsafe");
1144	+	f.setAccessible(true);
1145	+	return (sun.misc.Unsafe) f.get(null);
1146	+	}});
1147	+	} catch (java.security.PrivilegedActionException e) {
1148	+	throw new RuntimeException("Could not initialize intrinsics",
1149	+	e.getCause());
1150	+	}
1151	+	}
1152	+	}
1153		}

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines