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.33 by jsr166, Wed Aug 19 18:00:55 2009 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
9	<	import java.util.concurrent.*;
10	<
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
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 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 {@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>
55	<	*
56	<	*
57	<	* <li> Barrier actions, performed by the task triggering a phase
58	<	* advance, are arranged by overriding method {@link #onAdvance(int,
59	<	* int)}, which also controls termination. Overriding this method is
60	<	* similar to, but more flexible than, providing a barrier action to a
61	<	* {@code CyclicBarrier}.
62	<	*
63	<	* <li> Phasers may enter a <em>termination</em> state in which all
64	<	* actions immediately return without updating phaser state or waiting
65	<	* for advance, and indicating (via a negative phase value) that
66	<	* execution is complete.  Termination is triggered when an invocation
67	<	* of {@code onAdvance} returns {@code true}.  When a phaser is
68	<	* controlling an action with a fixed number of iterations, it is
69	<	* often convenient to override this method to cause termination when
70	<	* the current phase number reaches a threshold. Method {@link
71	<	* #forceTermination} is also available to abruptly release waiting
72	<	* threads and allow them to terminate.
73	<	*
70	<	* <li> Phasers may be tiered to reduce contention. Phasers with large
71	<	* numbers of parties that would otherwise experience heavy
72	<	* synchronization contention costs may instead be arranged in trees.
73	<	* This will typically greatly increase throughput even though it
74	<	* incurs somewhat greater per-operation overhead.
75	<	*
76	<	* <li> By default, {@code awaitAdvance} continues to wait even if
77	<	* the waiting thread is interrupted. And unlike the case in
78	<	* {@code CyclicBarrier}, exceptions encountered while tasks wait
79	<	* interruptibly or with timeout do not change the state of the
80	<	* barrier. If necessary, you can perform any associated recovery
81	<	* within handlers of those exceptions, often after invoking
82	<	* {@code forceTermination}.
83	<	*
84	<	* <li>Phasers may be used to coordinate tasks executing in a {@link
85	<	* ForkJoinPool}, which will ensure sufficient parallelism to execute
86	<	* tasks when others are blocked waiting for a phase to advance.
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	+	* <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	+	* <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
126	<	* parties. The typical idiom is for the method setting this up to
127	<	* first register, then start the actions, then deregister, as in:
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 (Runnable task : tasks) {
133	>	*   for (final Runnable task : tasks) {
134		*     phaser.register();
135		*     new Thread() {
136		*       public void run() {
#	Line 118 | Line 150 | import java.util.concurrent.locks.LockSu
150		*  <pre> {@code
151		* void startTasks(List<Runnable> tasks, final int iterations) {
152		*   final Phaser phaser = new Phaser() {
153	<	*     public boolean onAdvance(int phase, int registeredParties) {
153	>	*     protected boolean onAdvance(int phase, int registeredParties) {
154		*       return phase >= iterations || registeredParties == 0;
155		*     }
156		*   };
157		*   phaser.register();
158	<	*   for (Runnable task : tasks) {
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();
165	>	*         } while (!phaser.isTerminated());
166		*       }
167		*     }.start();
168		*   }
169		*   phaser.arriveAndDeregister(); // deregister self, don't wait
170		* }}</pre>
171		*
172	<	* <p>To create a set of tasks using a tree of phasers,
173	<	* you could use code of the following form, assuming a
174	<	* Task class with a constructor accepting a phaser that
175	<	* it registers for upon construction:
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>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	>	*  <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	>	*   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[] actions, int lo, int hi, Phaser b) {
206	<	*   int step = (hi - lo) / TASKS_PER_PHASER;
207	<	*   if (step > 1) {
208	<	*     int i = lo;
209	<	*     while (i < hi) {
150	<	*       int r = Math.min(i + step, hi);
151	<	*       build(actions, i, r, new Phaser(b));
152	<	*       i = r;
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		*   } else {
212		*     for (int i = lo; i < hi; ++i)
213	<	*       actions[i] = new Task(b);
214	<	*       // assumes new Task(b) performs b.register()
213	>	*       tasks[i] = new Task(ph);
214	>	*       // assumes new Task(ph) performs ph.register()
215		*   }
216	<	* }
160	<	* // .. initially called, for n tasks via
161	<	* build(new Task[n], 0, n, new Phaser());}</pre>
216	>	* }}</pre>
217		*
218		* The best value of {@code TASKS_PER_PHASER} depends mainly on
219	<	* expected barrier synchronization rates. A value as low as four may
220	<	* be appropriate for extremely small per-barrier task bodies (thus
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		*
168	–	* </pre>
169	–	*
223		* <p><b>Implementation notes</b>: This implementation restricts the
224		* maximum number of parties to 65535. Attempts to register additional
225		* parties result in {@code IllegalStateException}. However, you can and
#	Line 184 | Line 237 | public class Phaser {
237		*/
238
239		/**
240	<	* Barrier state representation. Conceptually, a barrier contains
188	<	* 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)
246	<	*
247	<	* However, to efficiently maintain atomicity, these values are
248	<	* packed into a single (atomic) long. Termination uses the sign
249	<	* bit of 32 bit representation of phase, so phase is set to -1 on
250	<	* termination. Good performance relies on keeping state decoding
251	<	* and encoding simple, and keeping race windows short.
252	<	*
253	<	* Note: there are some cheats in arrive() that rely on unarrived
254	<	* count being lowest 16 bits.
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	>	* 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 ushortBits = 16;
269	<	private static final int ushortMask = 0xffff;
270	<	private static final int phaseMask  = 0x7fffffff;
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	>	// 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) >>> 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);
299	<	}
300	<
226	<	private static long stateFor(int phase, int parties, int unarrived) {
227	<	return ((((long) phase) << 32) | (((long) parties) << 16) |
228	<	(long) unarrived);
229	<	}
230	<
231	<	private static long trippedStateFor(int phase, int parties) {
232	<	long lp = (long) parties;
233	<	return (((long) phase) << 32) | (lp << 16) | lp;
234	<	}
235	<
236	<	/**
237	<	* Returns message string for bad bounds exceptions.
238	<	*/
239	<	private static String badBounds(int parties, int unarrived) {
240	<	return ("Attempt to set " + unarrived +
241	<	" unarrived of " + parties + " parties");
298	>	int counts = (int)s;
299	>	return (counts == EMPTY) ? 0 :
300	>	(counts >>> PARTIES_SHIFT) - (counts & UNARRIVED_MASK);
301		}
302
303		/**
#	Line 247 | Line 306 | public class Phaser {
306		private final Phaser parent;
307
308		/**
309	<	* The root of phaser tree. Equals this if not in a tree.  Used to
251	<	* support faster state push-down.
309	>	* The root of phaser tree. Equals this if not in a tree.
310		*/
311		private final Phaser root;
312
255	–	// Wait queues
256	–
313		/**
314		* Heads of Treiber stacks for waiting threads. To eliminate
315	<	* contention while releasing some threads while adding others, we
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	<	private final AtomicReference<QNode> evenQ = new AtomicReference<QNode>();
320	<	private final AtomicReference<QNode> oddQ  = new AtomicReference<QNode>();
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	<	* Returns current state, first resolving lagged propagation from
271	<	* root if necessary.
327	>	* Returns message string for bounds exceptions on arrival.
328		*/
329	<	private long getReconciledState() {
330	<	return (parent == null) ? state : reconcileState();
329	>	private String badArrive(long s) {
330	>	return "Attempted arrival of unregistered party for " +
331	>	stateToString(s);
332		}
333
334		/**
335	<	* Recursively resolves state.
335	>	* Returns message string for bounds exceptions on registration.
336		*/
337	<	private long reconcileState() {
338	<	Phaser p = parent;
339	<	long s = state;
340	<	if (p != null) {
341	<	while (unarrivedOf(s) == 0 && phaseOf(s) != phaseOf(root.state)) {
342	<	long parentState = p.getReconciledState();
343	<	int parentPhase = phaseOf(parentState);
344	<	int phase = phaseOf(s = state);
345	<	if (phase != parentPhase) {
346	<	long next = trippedStateFor(parentPhase, partiesOf(s));
347	<	if (casState(s, next)) {
348	<	releaseWaiters(phase);
349	<	s = next;
337	>	private String badRegister(long s) {
338	>	return "Attempt to register more than " +
339	>	MAX_PARTIES + " parties for " + stateToString(s);
340	>	}
341	>
342	>	/**
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	>	* @param deregister false for arrive, true for arriveAndDeregister
348	>	*/
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 = (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	>	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	>	* Implementation of register, bulkRegister
386	>	*
387	>	* @param registrations number to add to both parties and
388	>	* unarrived fields. Must be greater than zero.
389	>	*/
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;
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	>	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 without any initially registered parties,
469	<	* initial phase number 0, and no parent. Any thread using this
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);
473	>	this(null, 0);
474		}
475
476		/**
477	<	* Creates a new phaser with the given numbers of registered
478	<	* unarrived parties, initial phase number 0, and no parent.
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 trip barrier
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		*/
#	Line 319 | Line 487 | public class Phaser {
487		}
488
489		/**
490	<	* Creates a new phaser with the given parent, without any
323	<	* initially registered parties. If parent is non-null this phaser
324	<	* is registered with the parent and its initial phase number is
325	<	* the same as that of parent phaser.
490	>	* Equivalent to {@link #Phaser(Phaser, int) Phaser(parent, 0)}.
491		*
492		* @param parent the parent phaser
493		*/
494		public Phaser(Phaser parent) {
495	<	int phase = 0;
331	<	this.parent = parent;
332	<	if (parent != null) {
333	<	this.root = parent.root;
334	<	phase = parent.register();
335	<	}
336	<	else
337	<	this.root = this;
338	<	this.state = trippedStateFor(phase, 0);
495	>	this(parent, 0);
496		}
497
498		/**
499	<	* Creates a new phaser with the given parent and numbers of
500	<	* registered unarrived parties. If parent is non-null, this phaser
501	<	* is registered with the parent and its initial phase number is
502	<	* the same as that of parent phaser.
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 trip barrier
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 < 0 || parties > ushortMask)
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	<	this.root = parent.root;
517	<	phase = parent.register();
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
523	>	else {
524		this.root = this;
525	<	this.state = trippedStateFor(phase, parties);
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.
536	<	*
537	<	* @return the current barrier phase number upon registration
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		*/
#	Line 376 | Line 552 | public class Phaser {
552
553		/**
554		* Adds the given number of new unarrived parties to this phaser.
555	<	*
556	<	* @param parties the number of parties required to trip barrier
557	<	* @return the current barrier phase number upon registration
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)
#	Line 391 | Line 578 | public class Phaser {
578		}
579
580		/**
581	<	* Shared code for register, bulkRegister
582	<	*/
583	<	private int doRegister(int registrations) {
584	<	int phase;
585	<	for (;;) {
586	<	long s = getReconciledState();
400	<	phase = phaseOf(s);
401	<	int unarrived = unarrivedOf(s) + registrations;
402	<	int parties = partiesOf(s) + registrations;
403	<	if (phase < 0)
404	<	break;
405	<	if (parties > ushortMask || unarrived > ushortMask)
406	<	throw new IllegalStateException(badBounds(parties, unarrived));
407	<	if (phase == phaseOf(root.state) &&
408	<	casState(s, stateFor(phase, parties, unarrived)))
409	<	break;
410	<	}
411	<	return phase;
412	<	}
413	<
414	<	/**
415	<	* Arrives at the barrier, but does not wait for others.  (You can
416	<	* in turn wait for others via {@link #awaitAdvance}).
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 barrier phase number upon entry to this method, or a
419	<	* negative value if terminated
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	<	int phase;
425	<	for (;;) {
426	<	long s = state;
427	<	phase = phaseOf(s);
428	<	if (phase < 0)
429	<	break;
430	<	int parties = partiesOf(s);
431	<	int unarrived = unarrivedOf(s) - 1;
432	<	if (unarrived > 0) {        // Not the last arrival
433	<	if (casState(s, s - 1)) // s-1 adds one arrival
434	<	break;
435	<	}
436	<	else if (unarrived == 0) {  // the last arrival
437	<	Phaser par = parent;
438	<	if (par == null) {      // directly trip
439	<	if (casState
440	<	(s,
441	<	trippedStateFor(onAdvance(phase, parties) ? -1 :
442	<	((phase + 1) & phaseMask), parties))) {
443	<	releaseWaiters(phase);
444	<	break;
445	<	}
446	<	}
447	<	else {                  // cascade to parent
448	<	if (casState(s, s - 1)) { // zeroes unarrived
449	<	par.arrive();
450	<	reconcileState();
451	<	break;
452	<	}
453	<	}
454	<	}
455	<	else if (phase != phaseOf(root.state)) // or if unreconciled
456	<	reconcileState();
457	<	else
458	<	throw new IllegalStateException(badBounds(parties, unarrived));
459	<	}
460	<	return phase;
593	>	return doArrive(false);
594		}
595
596		/**
597	<	* Arrives at the barrier and deregisters from it without waiting
598	<	* for others. Deregistration reduces the number of parties
599	<	* required to trip the barrier in future phases.  If this phaser
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 also arrives at and is deregistered
602	<	* from its parent.
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 current barrier phase number upon entry to
472	<	* this method, or a negative value if terminated
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	<	// similar code to arrive, but too different to merge
478	<	Phaser par = parent;
479	<	int phase;
480	<	for (;;) {
481	<	long s = state;
482	<	phase = phaseOf(s);
483	<	if (phase < 0)
484	<	break;
485	<	int parties = partiesOf(s) - 1;
486	<	int unarrived = unarrivedOf(s) - 1;
487	<	if (parties >= 0) {
488	<	if (unarrived > 0 || (unarrived == 0 && par != null)) {
489	<	if (casState
490	<	(s,
491	<	stateFor(phase, parties, unarrived))) {
492	<	if (unarrived == 0) {
493	<	par.arriveAndDeregister();
494	<	reconcileState();
495	<	}
496	<	break;
497	<	}
498	<	continue;
499	<	}
500	<	if (unarrived == 0) {
501	<	if (casState
502	<	(s,
503	<	trippedStateFor(onAdvance(phase, parties) ? -1 :
504	<	((phase + 1) & phaseMask), parties))) {
505	<	releaseWaiters(phase);
506	<	break;
507	<	}
508	<	continue;
509	<	}
510	<	if (par != null && phase != phaseOf(root.state)) {
511	<	reconcileState();
512	<	continue;
513	<	}
514	<	}
515	<	throw new IllegalStateException(badBounds(parties, unarrived));
516	<	}
517	<	return phase;
613	>	return doArrive(true);
614		}
615
616		/**
617	<	* Arrives at the barrier and awaits others. Equivalent in effect
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 awaitAdvance
621	<	* method.  If instead you need to deregister upon arrival use
622	<	* {@code arriveAndDeregister}.
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 phase on entry to this method
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	<	return awaitAdvance(arrive());
635	>	// Specialization of doArrive+awaitAdvance eliminating some reads/paths
636	>	final Phaser root = this.root;
637	>	for (;;) {
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	>	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 phase
674	<	* value, returning immediately if the current phase of the
675	<	* barrier is not equal to the given phase value or this barrier
676	<	* is terminated.
677	<	*
678	<	* @param phase the phase on entry to this method
679	<	* @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	<	long s = getReconciledState();
691	<	int p = phaseOf(s);
692	<	if (p != phase)
551	<	return p;
552	<	if (unarrivedOf(s) == 0 && parent != null)
553	<	parent.awaitAdvance(phase);
554	<	// Fall here even if parent waited, to reconcile and help release
555	<	return untimedWait(phase);
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 phase
697	<	* value, throwing {@code InterruptedException} if interrupted while
698	<	* waiting, or returning immediately if the current phase of the
699	<	* barrier is not equal to the given phase value or this barrier
700	<	* is terminated.
701	<	*
702	<	* @param phase the phase on entry to this method
703	<	* @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)
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	<	long s = getReconciledState();
718	<	int p = phaseOf(s);
719	<	if (p != phase)
720	<	return p;
721	<	if (unarrivedOf(s) == 0 && parent != null)
722	<	parent.awaitAdvanceInterruptibly(phase);
723	<	return interruptibleWait(phase);
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 phase
728	<	* value or the given timeout to elapse, throwing
729	<	* {@code InterruptedException} if interrupted while waiting, or
730	<	* returning immediately if the current phase of the barrier is not
731	<	* equal to the given phase value or this barrier is terminated.
732	<	*
733	<	* @param phase the phase on entry to 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 phase on exit from this method
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,
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 s = getReconciledState();
756	<	int p = phaseOf(s);
757	<	if (p != phase)
758	<	return p;
759	<	if (unarrivedOf(s) == 0 && parent != null)
760	<	parent.awaitAdvanceInterruptibly(phase, timeout, unit);
761	<	return timedWait(phase, unit.toNanos(timeout));
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. If this phaser
769	<	* has a parent, it too is terminated. This method may be useful
770	<	* for coordinating recovery after one or more tasks encounter
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	<	for (;;) {
777	<	long s = getReconciledState();
778	<	int phase = phaseOf(s);
779	<	int parties = partiesOf(s);
780	<	int unarrived = unarrivedOf(s);
781	<	if (phase < 0 ||
782	<	casState(s, stateFor(-1, parties, unarrived))) {
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);
629	–	if (parent != null)
630	–	parent.forceTermination();
785		return;
786		}
787		}
#	Line 636 | Line 790 | public class Phaser {
790		/**
791		* Returns the current phase number. The maximum phase number is
792		* {@code Integer.MAX_VALUE}, after which it restarts at
793	<	* zero. Upon termination, the phase number is negative.
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 final int getPhase() {
800	<	return phaseOf(getReconciledState());
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		*/
#	Line 654 | Line 810 | public class Phaser {
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);
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);
831	>	return unarrivedOf(reconcileState());
832		}
833
834		/**
#	Line 693 | Line 851 | public class Phaser {
851		}
852
853		/**
854	<	* Returns {@code true} if this barrier has been terminated.
854	>	* Returns {@code true} if this phaser has been terminated.
855		*
856	<	* @return {@code true} if this barrier has been terminated
856	>	* @return {@code true} if this phaser has been terminated
857		*/
858		public boolean isTerminated() {
859	<	return getPhase() < 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 {@code true}, then, rather than advance
867	<	* the phase number, this barrier will be set to a final
868	<	* termination state, and subsequent calls to {@link #isTerminated}
869	<	* will return true.
870	<	*
871	<	* <p>The default version returns {@code 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	<	* <p>You may override this method to perform an action with side
877	<	* effects visible to participating tasks, but it is in general
878	<	* only sensible to do so in designs where all parties register
879	<	* before any arrive, and all {@link #awaitAdvance} at each phase.
880	<	* Otherwise, you cannot ensure lack of interference from other
881	<	* parties during the invocation of this method.
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 phase number on entering the barrier
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 barrier should terminate
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		/**
#	Line 737 | Line 910 | public class Phaser {
910		* followed by the number of registered parties, and {@code
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 = getReconciledState();
916	>	return stateToString(reconcileState());
917	>	}
918	>
919	>	/**
920	>	* Implementation of toString and string-based error messages
921	>	*/
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	<	// methods for waiting
929	>	// Waiting mechanics
930
931		/**
932	<	* Wait nodes for Treiber stack representing wait queue
932	>	* Removes and signals threads from queue for phase.
933		*/
934	<	static final class QNode implements ForkJoinPool.ManagedBlocker {
935	<	final Phaser phaser;
936	<	final int phase;
937	<	final long startTime;
938	<	final long nanos;
939	<	final boolean timed;
940	<	final boolean interruptible;
941	<	volatile boolean wasInterrupted = false;
942	<	volatile Thread thread; // nulled to cancel wait
764	<	QNode next;
765	<	QNode(Phaser phaser, int phase, boolean interruptible,
766	<	boolean timed, long startTime, long nanos) {
767	<	this.phaser = phaser;
768	<	this.phase = phase;
769	<	this.timed = timed;
770	<	this.interruptible = interruptible;
771	<	this.startTime = startTime;
772	<	this.nanos = nanos;
773	<	thread = Thread.currentThread();
774	<	}
775	<	public boolean isReleasable() {
776	<	return (thread == null ||
777	<	phaser.getPhase() != phase ||
778	<	(interruptible && wasInterrupted) ||
779	<	(timed && (nanos - (System.nanoTime() - startTime)) <= 0));
780	<	}
781	<	public boolean block() {
782	<	if (Thread.interrupted()) {
783	<	wasInterrupted = true;
784	<	if (interruptible)
785	<	return true;
786	<	}
787	<	if (!timed)
788	<	LockSupport.park(this);
789	<	else {
790	<	long waitTime = nanos - (System.nanoTime() - startTime);
791	<	if (waitTime <= 0)
792	<	return true;
793	<	LockSupport.parkNanos(this, waitTime);
794	<	}
795	<	return isReleasable();
796	<	}
797	<	void signal() {
798	<	Thread t = thread;
799	<	if (t != null) {
800	<	thread = null;
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		}
804	–	boolean doWait() {
805	–	if (thread != null) {
806	–	try {
807	–	ForkJoinPool.managedBlock(this, false);
808	–	} catch (InterruptedException ie) {
809	–	}
810	–	}
811	–	return wasInterrupted;
812	–	}
813	–
946		}
947
948		/**
949	<	* Removes and signals waiting threads from wait queue.
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	<	private void releaseWaiters(int phase) {
958	<	AtomicReference<QNode> head = queueFor(phase);
959	<	QNode q;
960	<	while ((q = head.get()) != null) {
961	<	if (head.compareAndSet(q, q.next))
962	<	q.signal();
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	+	private static final int NCPU = Runtime.getRuntime().availableProcessors();
974	+
975		/**
976	<	* Tries to enqueue given node in the appropriate wait queue.
977	<	*
978	<	* @return true if successful
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	<	private boolean tryEnqueue(QNode node) {
834	<	AtomicReference<QNode> head = queueFor(node.phase);
835	<	return head.compareAndSet(node.next = head.get(), node);
836	<	}
986	>	static final int SPINS_PER_ARRIVAL = (NCPU < 2) ? 1 : 1 << 8;
987
988		/**
989	<	* Enqueues node and waits unless aborted or signalled.
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 untimedWait(int phase) {
998	<	QNode node = null;
999	<	boolean queued = false;
1000	<	boolean interrupted = false;
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 = getPhase()) == phase) {
1005	<	if (Thread.interrupted())
1006	<	interrupted = true;
1007	<	else if (node == null)
1008	<	node = new QNode(this, phase, false, false, 0, 0);
1009	<	else if (!queued)
1010	<	queued = tryEnqueue(node);
1011	<	else
1012	<	interrupted = node.doWait();
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 (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	>	}
1031	>	}
1032	>	}
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		}
858	–	if (node != null)
859	–	node.thread = null;
1042		releaseWaiters(phase);
861	–	if (interrupted)
862	–	Thread.currentThread().interrupt();
1043		return p;
1044		}
1045
1046		/**
1047	<	* Interruptible version
868	<	* @return current phase
1047	>	* Wait nodes for Treiber stack representing wait queue
1048		*/
1049	<	private int interruptibleWait(int phase) throws InterruptedException {
1050	<	QNode node = null;
1051	<	boolean queued = false;
1052	<	boolean interrupted = false;
1053	<	int p;
1054	<	while ((p = getPhase()) == phase && !interrupted) {
1055	<	if (Thread.interrupted())
1056	<	interrupted = true;
1057	<	else if (node == null)
1058	<	node = new QNode(this, phase, true, false, 0, 0);
880	<	else if (!queued)
881	<	queued = tryEnqueue(node);
882	<	else
883	<	interrupted = node.doWait();
884	<	}
885	<	if (node != null)
886	<	node.thread = null;
887	<	if (p != phase || (p = getPhase()) != phase)
888	<	releaseWaiters(phase);
889	<	if (interrupted)
890	<	throw new InterruptedException();
891	<	return p;
892	<	}
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	<	/**
1061	<	* Timeout version.
1062	<	* @return current phase
1063	<	*/
1064	<	private int timedWait(int phase, long nanos)
1065	<	throws InterruptedException, TimeoutException {
1066	<	long startTime = System.nanoTime();
1067	<	QNode node = null;
1068	<	boolean queued = false;
1069	<	boolean interrupted = false;
1070	<	int p;
1071	<	while ((p = getPhase()) == phase && !interrupted) {
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		if (Thread.interrupted())
1079	<	interrupted = true;
1080	<	else if (nanos - (System.nanoTime() - startTime) <= 0)
1081	<	break;
1082	<	else if (node == null)
1083	<	node = new QNode(this, phase, true, true, startTime, nanos);
1084	<	else if (!queued)
1085	<	queued = tryEnqueue(node);
1086	<	else
1087	<	interrupted = node.doWait();
1088	<	}
1089	<	if (node != null)
1090	<	node.thread = null;
1091	<	if (p != phase || (p = getPhase()) != phase)
1092	<	releaseWaiters(phase);
1093	<	if (interrupted)
1094	<	throw new InterruptedException();
1095	<	if (p == phase)
1096	<	throw new TimeoutException();
1097	<	return p;
1079	>	wasInterrupted = true;
1080	>	if (wasInterrupted && interruptible) {
1081	>	thread = null;
1082	>	return true;
1083	>	}
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	>	}
1094	>	}
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
#	Line 931 | Line 1112 | public class Phaser {
1112		private static final long stateOffset =
1113		objectFieldOffset("state", Phaser.class);
1114
934	–	private final boolean casState(long cmp, long val) {
935	–	return UNSAFE.compareAndSwapLong(this, stateOffset, cmp, val);
936	–	}
937	–
1115		private static long objectFieldOffset(String field, Class<?> klazz) {
1116		try {
1117		return UNSAFE.objectFieldOffset(klazz.getDeclaredField(field));

Diff Legend

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