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.44 by dl, Tue Aug 25 16:32:28 2009 UTC vs.
Revision 1.58 by dl, Wed Nov 24 15:48:01 2010 UTC

#	Line 6 | Line 6
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
#	Line 86 | Line 86 | import java.util.concurrent.locks.LockSu
86		* #forceTermination} is also available to abruptly release waiting
87		* threads and allow them to terminate.
88		*
89	<	* <p> <b>Tiering.</b> Phasers may be <em>tiered</em> (i.e., arranged
90	<	* in tree structures) to reduce contention. Phasers with large
91	<	* numbers of parties that would otherwise experience heavy
89	>	* <p> <b>Tiering.</b> Phasers may be <em>tiered</em> (i.e.,
90	>	* constructed in tree structures) to reduce contention. Phasers with
91	>	* large numbers of parties that would otherwise experience heavy
92		* synchronization contention costs may instead be set up so that
93		* groups of sub-phasers share a common parent.  This may greatly
94		* increase throughput even though it incurs greater per-operation
#	Line 109 | Line 109 | import java.util.concurrent.locks.LockSu
109		* <p><b>Sample usages:</b>
110		*
111		* <p>A {@code Phaser} may be used instead of a {@code CountDownLatch}
112	<	* to control a one-shot action serving a variable number of
113	<	* parties. The typical idiom is for the method setting this up to
114	<	* first register, then start the actions, then deregister, as in:
112	>	* to control a one-shot action serving a variable number of parties.
113	>	* The typical idiom is for the method setting this up to first
114	>	* register, then start the actions, then deregister, as in:
115		*
116		*  <pre> {@code
117		* void runTasks(List<Runnable> tasks) {
#	Line 142 | Line 142 | import java.util.concurrent.locks.LockSu
142		*     }
143		*   };
144		*   phaser.register();
145	<	*   for (Runnable task : tasks) {
145	>	*   for (final Runnable task : tasks) {
146		*     phaser.register();
147		*     new Thread() {
148		*       public void run() {
149		*         do {
150		*           task.run();
151		*           phaser.arriveAndAwaitAdvance();
152	<	*         } while(!phaser.isTerminated();
152	>	*         } while (!phaser.isTerminated());
153		*       }
154		*     }.start();
155		*   }
#	Line 158 | Line 158 | import java.util.concurrent.locks.LockSu
158		*
159		* If the main task must later await termination, it
160		* may re-register and then execute a similar loop:
161	<	* <pre> {@code
161	>	*  <pre> {@code
162		*   // ...
163		*   phaser.register();
164		*   while (!phaser.isTerminated())
165	<	*     phaser.arriveAndAwaitAdvance();
166	<	* }</pre>
165	>	*     phaser.arriveAndAwaitAdvance();}</pre>
166		*
167	<	* Related constructions may be used to await particular phase numbers
167	>	* <p>Related constructions may be used to await particular phase numbers
168		* in contexts where you are sure that the phase will never wrap around
169		* {@code Integer.MAX_VALUE}. For example:
170		*
171	<	* <pre> {@code
172	<	*   void awaitPhase(Phaser phaser, int phase) {
173	<	*     int p = phaser.register(); // assumes caller not already registered
174	<	*     while (p < phase) {
175	<	*       if (phaser.isTerminated())
176	<	*         // ... deal with unexpected termination
177	<	*       else
178	<	*         p = phaser.arriveAndAwaitAdvance();
180	<	*     }
181	<	*     phaser.arriveAndDeregister();
171	>	*  <pre> {@code
172	>	* void awaitPhase(Phaser phaser, int phase) {
173	>	*   int p = phaser.register(); // assumes caller not already registered
174	>	*   while (p < phase) {
175	>	*     if (phaser.isTerminated())
176	>	*       // ... deal with unexpected termination
177	>	*     else
178	>	*       p = phaser.arriveAndAwaitAdvance();
179		*   }
180	<	* }</pre>
180	>	*   phaser.arriveAndDeregister();
181	>	* }}</pre>
182		*
183		*
184		* <p>To create a set of tasks using a tree of phasers,
185		* you could use code of the following form, assuming a
186		* Task class with a constructor accepting a phaser that
187	<	* it registers for upon construction:
187	>	* it registers with upon construction:
188	>	*
189		*  <pre> {@code
190		* void build(Task[] actions, int lo, int hi, Phaser ph) {
191		*   if (hi - lo > TASKS_PER_PHASER) {
#	Line 208 | Line 207 | import java.util.concurrent.locks.LockSu
207		* be appropriate for extremely small per-barrier task bodies (thus
208		* high rates), or up to hundreds for extremely large ones.
209		*
211	–	* </pre>
212	–	*
210		* <p><b>Implementation notes</b>: This implementation restricts the
211		* maximum number of parties to 65535. Attempts to register additional
212		* parties result in {@code IllegalStateException}. However, you can and
#	Line 230 | Line 227 | public class Phaser {
227		* Barrier state representation. Conceptually, a barrier contains
228		* four values:
229		*
230	<	* * parties -- the number of parties to wait (16 bits)
231	<	* * unarrived -- the number of parties yet to hit barrier (16 bits)
232	<	* * phase -- the generation of the barrier (31 bits)
233	<	* * terminated -- set if barrier is terminated (1 bit)
230	>	* * unarrived -- the number of parties yet to hit barrier (bits  0-15)
231	>	* * parties -- the number of parties to wait              (bits 16-31)
232	>	* * phase -- the generation of the barrier                (bits 32-62)
233	>	* * terminated -- set if barrier is terminated            (bit  63 / sign)
234		*
235		* However, to efficiently maintain atomicity, these values are
236		* packed into a single (atomic) long. Termination uses the sign
237		* bit of 32 bit representation of phase, so phase is set to -1 on
238		* termination. Good performance relies on keeping state decoding
239		* and encoding simple, and keeping race windows short.
243	–	*
244	–	* Note: there are some cheats in arrive() that rely on unarrived
245	–	* count being lowest 16 bits.
240		*/
241		private volatile long state;
242
243	<	private static final int ushortMask = 0xffff;
244	<	private static final int phaseMask  = 0x7fffffff;
243	>	private static final int  MAX_PARTIES    = 0xffff;
244	>	private static final int  MAX_PHASE      = 0x7fffffff;
245	>	private static final int  PARTIES_SHIFT  = 16;
246	>	private static final int  PHASE_SHIFT    = 32;
247	>	private static final int  UNARRIVED_MASK = 0xffff;
248	>	private static final long PARTIES_MASK   = 0xffff0000L; // for masking long
249	>	private static final long ONE_ARRIVAL    = 1L;
250	>	private static final long ONE_PARTY      = 1L << PARTIES_SHIFT;
251	>	private static final long TERMINATION_PHASE  = -1L << PHASE_SHIFT;
252	>
253	>	// The following unpacking methods are usually manually inlined
254
255		private static int unarrivedOf(long s) {
256	<	return (int) (s & ushortMask);
256	>	return (int)s & UNARRIVED_MASK;
257		}
258
259		private static int partiesOf(long s) {
260	<	return ((int) s) >>> 16;
260	>	return (int)s >>> PARTIES_SHIFT;
261		}
262
263		private static int phaseOf(long s) {
264	<	return (int) (s >>> 32);
264	>	return (int) (s >>> PHASE_SHIFT);
265		}
266
267		private static int arrivedOf(long s) {
268		return partiesOf(s) - unarrivedOf(s);
269		}
270
268	–	private static long stateFor(int phase, int parties, int unarrived) {
269	–	return ((((long) phase) << 32) | (((long) parties) << 16) |
270	–	(long) unarrived);
271	–	}
272	–
273	–	private static long trippedStateFor(int phase, int parties) {
274	–	long lp = (long) parties;
275	–	return (((long) phase) << 32) | (lp << 16) | lp;
276	–	}
277	–
278	–	/**
279	–	* Returns message string for bad bounds exceptions.
280	–	*/
281	–	private static String badBounds(int parties, int unarrived) {
282	–	return ("Attempt to set " + unarrived +
283	–	" unarrived of " + parties + " parties");
284	–	}
285	–
271		/**
272		* The parent of this phaser, or null if none
273		*/
#	Line 294 | Line 279 | public class Phaser {
279		*/
280		private final Phaser root;
281
297	–	// Wait queues
298	–
282		/**
283		* Heads of Treiber stacks for waiting threads. To eliminate
284	<	* contention while releasing some threads while adding others, we
284	>	* contention when releasing some threads while adding others, we
285		* use two of them, alternating across even and odd phases.
286	+	* Subphasers share queues with root to speed up releases.
287		*/
288	<	private final AtomicReference<QNode> evenQ = new AtomicReference<QNode>();
289	<	private final AtomicReference<QNode> oddQ  = new AtomicReference<QNode>();
288	>	private final AtomicReference<QNode> evenQ;
289	>	private final AtomicReference<QNode> oddQ;
290
291		private AtomicReference<QNode> queueFor(int phase) {
292		return ((phase & 1) == 0) ? evenQ : oddQ;
293		}
294
295		/**
296	<	* Returns current state, first resolving lagged propagation from
297	<	* root if necessary.
296	>	* Main implementation for methods arrive and arriveAndDeregister.
297	>	* Manually tuned to speed up and minimize race windows for the
298	>	* common case of just decrementing unarrived field.
299	>	*
300	>	* @param adj - adjustment to apply to state -- either
301	>	* ONE_ARRIVAL (for arrive) or
302	>	* ONE_ARRIVAL|ONE_PARTY (for arriveAndDeregister)
303	>	*/
304	>	private int doArrive(long adj) {
305	>	for (;;) {
306	>	long s = state;
307	>	int phase = (int)(s >>> PHASE_SHIFT);
308	>	if (phase < 0)
309	>	return phase;
310	>	int unarrived = (int)s & UNARRIVED_MASK;
311	>	if (unarrived == 0)
312	>	checkBadArrive(s);
313	>	else if (UNSAFE.compareAndSwapLong(this, stateOffset, s, s-=adj)) {
314	>	if (unarrived == 1) {
315	>	long p = s & PARTIES_MASK; // unshifted parties field
316	>	long lu = p >>> PARTIES_SHIFT;
317	>	int u = (int)lu;
318	>	int nextPhase = (phase + 1) & MAX_PHASE;
319	>	long next = ((long)nextPhase << PHASE_SHIFT) | p | lu;
320	>	final Phaser parent = this.parent;
321	>	if (parent == null) {
322	>	if (onAdvance(phase, u))
323	>	next |= TERMINATION_PHASE; // obliterate phase
324	>	UNSAFE.compareAndSwapLong(this, stateOffset, s, next);
325	>	releaseWaiters(phase);
326	>	}
327	>	else {
328	>	parent.doArrive((u == 0) ?
329	>	ONE_ARRIVAL|ONE_PARTY : ONE_ARRIVAL);
330	>	if ((int)(parent.state >>> PHASE_SHIFT) != nextPhase ||
331	>	((int)(state >>> PHASE_SHIFT) != nextPhase &&
332	>	!UNSAFE.compareAndSwapLong(this, stateOffset,
333	>	s, next)))
334	>	reconcileState();
335	>	}
336	>	}
337	>	return phase;
338	>	}
339	>	}
340	>	}
341	>
342	>	/**
343	>	* Rechecks state and throws bounds exceptions on arrival -- called
344	>	* only if unarrived is apparently zero.
345		*/
346	<	private long getReconciledState() {
347	<	return (parent == null) ? state : reconcileState();
346	>	private void checkBadArrive(long s) {
347	>	if (reconcileState() == s)
348	>	throw new IllegalStateException
349	>	("Attempted arrival of unregistered party for " +
350	>	stateToString(s));
351		}
352
353		/**
354	<	* Recursively resolves state.
354	>	* Implementation of register, bulkRegister
355	>	*
356	>	* @param registrations number to add to both parties and
357	>	* unarrived fields. Must be greater than zero.
358	>	*/
359	>	private int doRegister(int registrations) {
360	>	// adjustment to state
361	>	long adj = ((long)registrations << PARTIES_SHIFT) | registrations;
362	>	final Phaser parent = this.parent;
363	>	for (;;) {
364	>	long s = (parent == null) ? state : reconcileState();
365	>	int parties = (int)s >>> PARTIES_SHIFT;
366	>	int phase = (int)(s >>> PHASE_SHIFT);
367	>	if (phase < 0)
368	>	return phase;
369	>	else if (parties != 0 && ((int)s & UNARRIVED_MASK) == 0)
370	>	internalAwaitAdvance(phase, null); // wait for onAdvance
371	>	else if (registrations > MAX_PARTIES - parties)
372	>	throw new IllegalStateException(badRegister(s));
373	>	else if (UNSAFE.compareAndSwapLong(this, stateOffset, s, s + adj))
374	>	return phase;
375	>	}
376	>	}
377	>
378	>	/**
379	>	* Returns message string for out of bounds exceptions on registration.
380	>	*/
381	>	private String badRegister(long s) {
382	>	return "Attempt to register more than " +
383	>	MAX_PARTIES + " parties for " + stateToString(s);
384	>	}
385	>
386	>	/**
387	>	* Recursively resolves lagged phase propagation from root if necessary.
388		*/
389		private long reconcileState() {
390	<	Phaser p = parent;
390	>	Phaser par = parent;
391		long s = state;
392	<	if (p != null) {
393	<	while (unarrivedOf(s) == 0 && phaseOf(s) != phaseOf(root.state)) {
394	<	long parentState = p.getReconciledState();
395	<	int parentPhase = phaseOf(parentState);
396	<	int phase = phaseOf(s = state);
397	<	if (phase != parentPhase) {
398	<	long next = trippedStateFor(parentPhase, partiesOf(s));
399	<	if (casState(s, next)) {
400	<	releaseWaiters(phase);
401	<	s = next;
402	<	}
392	>	if (par != null) {
393	>	Phaser rt = root;
394	>	int phase, rPhase;
395	>	while ((phase = (int)(s >>> PHASE_SHIFT)) >= 0 &&
396	>	(rPhase = (int)(rt.state >>> PHASE_SHIFT)) != phase) {
397	>	if ((int)(par.state >>> PHASE_SHIFT) != rPhase)
398	>	par.reconcileState();
399	>	else if (rPhase < 0 || ((int)s & UNARRIVED_MASK) == 0) {
400	>	long u = s & PARTIES_MASK; // reset unarrived to parties
401	>	long next = ((((long) rPhase) << PHASE_SHIFT) | u |
402	>	(u >>> PARTIES_SHIFT));
403	>	if (state == s &&
404	>	UNSAFE.compareAndSwapLong(this, stateOffset,
405	>	s, s = next))
406	>	break;
407		}
408	+	s = state;
409		}
410		}
411		return s;
#	Line 345 | Line 417 | public class Phaser {
417		* phaser will need to first register for it.
418		*/
419		public Phaser() {
420	<	this(null);
420	>	this(null, 0);
421		}
422
423		/**
424	<	* Creates a new phaser with the given numbers of registered
424	>	* Creates a new phaser with the given number of registered
425		* unarrived parties, initial phase number 0, and no parent.
426		*
427		* @param parties the number of parties required to trip barrier
#	Line 361 | Line 433 | public class Phaser {
433		}
434
435		/**
436	<	* Creates a new phaser with the given parent, without any
365	<	* initially registered parties. If parent is non-null this phaser
366	<	* is registered with the parent and its initial phase number is
367	<	* the same as that of parent phaser.
436	>	* Equivalent to {@link #Phaser(Phaser, int) Phaser(parent, 0)}.
437		*
438		* @param parent the parent phaser
439		*/
440		public Phaser(Phaser parent) {
441	<	int phase = 0;
373	<	this.parent = parent;
374	<	if (parent != null) {
375	<	this.root = parent.root;
376	<	phase = parent.register();
377	<	}
378	<	else
379	<	this.root = this;
380	<	this.state = trippedStateFor(phase, 0);
441	>	this(parent, 0);
442		}
443
444		/**
445	<	* Creates a new phaser with the given parent and numbers of
446	<	* registered unarrived parties. If parent is non-null, this phaser
447	<	* is registered with the parent and its initial phase number is
448	<	* the same as that of parent phaser.
445	>	* Creates a new phaser with the given parent and number of
446	>	* registered unarrived parties. If parent is non-null, this
447	>	* phaser is registered with the parent and its initial phase
448	>	* number is the same as that of parent phaser.  If the number of
449	>	* parties is zero, the parent phaser will not proceed until this
450	>	* child phaser registers parties and advances, or this child
451	>	* phaser deregisters with its parent, or the parent is otherwise
452	>	* terminated.  This child Phaser will be deregistered from its
453	>	* parent automatically upon any invocation of the child's {@link
454	>	* #arriveAndDeregister} method that results in the child's number
455	>	* of registered parties becoming zero. (Although rarely
456	>	* appropriate, this child may also explicity deregister from its
457	>	* parent using {@code getParent().arriveAndDeregister()}.)  After
458	>	* deregistration, the child cannot re-register. (Instead, you can
459	>	* create a new child Phaser.)
460		*
461		* @param parent the parent phaser
462		* @param parties the number of parties required to trip barrier
#	Line 392 | Line 464 | public class Phaser {
464		* or greater than the maximum number of parties supported
465		*/
466		public Phaser(Phaser parent, int parties) {
467	<	if (parties < 0 || parties > ushortMask)
467	>	if (parties >>> PARTIES_SHIFT != 0)
468		throw new IllegalArgumentException("Illegal number of parties");
469	<	int phase = 0;
469	>	int phase;
470		this.parent = parent;
471		if (parent != null) {
472	<	this.root = parent.root;
473	<	phase = parent.register();
472	>	Phaser r = parent.root;
473	>	this.root = r;
474	>	this.evenQ = r.evenQ;
475	>	this.oddQ = r.oddQ;
476	>	phase = parent.doRegister(1);
477		}
478	<	else
478	>	else {
479		this.root = this;
480	<	this.state = trippedStateFor(phase, parties);
480	>	this.evenQ = new AtomicReference<QNode>();
481	>	this.oddQ = new AtomicReference<QNode>();
482	>	phase = 0;
483	>	}
484	>	long p = (long)parties;
485	>	this.state = (((long)phase) << PHASE_SHIFT) | p | (p << PARTIES_SHIFT);
486		}
487
488		/**
489		* Adds a new unarrived party to this phaser.
490	+	* If an ongoing invocation of {@link #onAdvance} is in progress,
491	+	* this method may wait until its completion before registering.
492		*
493		* @return the arrival phase number to which this registration applied
494		* @throws IllegalStateException if attempting to register more
#	Line 418 | Line 500 | public class Phaser {
500
501		/**
502		* Adds the given number of new unarrived parties to this phaser.
503	+	* If an ongoing invocation of {@link #onAdvance} is in progress,
504	+	* this method may wait until its completion before registering.
505		*
506	<	* @param parties the number of parties required to trip barrier
506	>	* @param parties the number of additional parties required to trip barrier
507		* @return the arrival phase number to which this registration applied
508		* @throws IllegalStateException if attempting to register more
509		* than the maximum supported number of parties
510	+	* @throws IllegalArgumentException if {@code parties < 0}
511		*/
512		public int bulkRegister(int parties) {
513		if (parties < 0)
#	Line 433 | Line 518 | public class Phaser {
518		}
519
520		/**
436	–	* Shared code for register, bulkRegister
437	–	*/
438	–	private int doRegister(int registrations) {
439	–	int phase;
440	–	for (;;) {
441	–	long s = getReconciledState();
442	–	phase = phaseOf(s);
443	–	int unarrived = unarrivedOf(s) + registrations;
444	–	int parties = partiesOf(s) + registrations;
445	–	if (phase < 0)
446	–	break;
447	–	if (parties > ushortMask || unarrived > ushortMask)
448	–	throw new IllegalStateException(badBounds(parties, unarrived));
449	–	if (phase == phaseOf(root.state) &&
450	–	casState(s, stateFor(phase, parties, unarrived)))
451	–	break;
452	–	}
453	–	return phase;
454	–	}
455	–
456	–	/**
521		* Arrives at the barrier, but does not wait for others.  (You can
522		* in turn wait for others via {@link #awaitAdvance}).  It is an
523		* unenforced usage error for an unregistered party to invoke this
#	Line 464 | Line 528 | public class Phaser {
528		* of unarrived parties would become negative
529		*/
530		public int arrive() {
531	<	int phase;
468	<	for (;;) {
469	<	long s = state;
470	<	phase = phaseOf(s);
471	<	if (phase < 0)
472	<	break;
473	<	int parties = partiesOf(s);
474	<	int unarrived = unarrivedOf(s) - 1;
475	<	if (unarrived > 0) {        // Not the last arrival
476	<	if (casState(s, s - 1)) // s-1 adds one arrival
477	<	break;
478	<	}
479	<	else if (unarrived == 0) {  // the last arrival
480	<	Phaser par = parent;
481	<	if (par == null) {      // directly trip
482	<	if (casState
483	<	(s,
484	<	trippedStateFor(onAdvance(phase, parties) ? -1 :
485	<	((phase + 1) & phaseMask), parties))) {
486	<	releaseWaiters(phase);
487	<	break;
488	<	}
489	<	}
490	<	else {                  // cascade to parent
491	<	if (casState(s, s - 1)) { // zeroes unarrived
492	<	par.arrive();
493	<	reconcileState();
494	<	break;
495	<	}
496	<	}
497	<	}
498	<	else if (phase != phaseOf(root.state)) // or if unreconciled
499	<	reconcileState();
500	<	else
501	<	throw new IllegalStateException(badBounds(parties, unarrived));
502	<	}
503	<	return phase;
531	>	return doArrive(ONE_ARRIVAL);
532		}
533
534		/**
#	Line 517 | Line 545 | public class Phaser {
545		* of registered or unarrived parties would become negative
546		*/
547		public int arriveAndDeregister() {
548	<	// similar code to arrive, but too different to merge
521	<	Phaser par = parent;
522	<	int phase;
523	<	for (;;) {
524	<	long s = state;
525	<	phase = phaseOf(s);
526	<	if (phase < 0)
527	<	break;
528	<	int parties = partiesOf(s) - 1;
529	<	int unarrived = unarrivedOf(s) - 1;
530	<	if (parties >= 0) {
531	<	if (unarrived > 0 || (unarrived == 0 && par != null)) {
532	<	if (casState
533	<	(s,
534	<	stateFor(phase, parties, unarrived))) {
535	<	if (unarrived == 0) {
536	<	par.arriveAndDeregister();
537	<	reconcileState();
538	<	}
539	<	break;
540	<	}
541	<	continue;
542	<	}
543	<	if (unarrived == 0) {
544	<	if (casState
545	<	(s,
546	<	trippedStateFor(onAdvance(phase, parties) ? -1 :
547	<	((phase + 1) & phaseMask), parties))) {
548	<	releaseWaiters(phase);
549	<	break;
550	<	}
551	<	continue;
552	<	}
553	<	if (par != null && phase != phaseOf(root.state)) {
554	<	reconcileState();
555	<	continue;
556	<	}
557	<	}
558	<	throw new IllegalStateException(badBounds(parties, unarrived));
559	<	}
560	<	return phase;
548	>	return doArrive(ONE_ARRIVAL|ONE_PARTY);
549		}
550
551		/**
552		* Arrives at the barrier and awaits others. Equivalent in effect
553		* to {@code awaitAdvance(arrive())}.  If you need to await with
554		* interruption or timeout, you can arrange this with an analogous
555	<	* construction using one of the other forms of the awaitAdvance
556	<	* method.  If instead you need to deregister upon arrival use
557	<	* {@code arriveAndDeregister}. It is an unenforced usage error
558	<	* for an unregistered party to invoke this method.
555	>	* construction using one of the other forms of the {@code
556	>	* awaitAdvance} method.  If instead you need to deregister upon
557	>	* arrival, use {@link #arriveAndDeregister}. It is an unenforced
558	>	* usage error for an unregistered party to invoke this method.
559		*
560		* @return the arrival phase number, or a negative number if terminated
561		* @throws IllegalStateException if not terminated and the number
#	Line 581 | Line 569 | public class Phaser {
569		* Awaits the phase of the barrier to advance from the given phase
570		* value, returning immediately if the current phase of the
571		* barrier is not equal to the given phase value or this barrier
572	<	* is terminated.  It is an unenforced usage error for an
585	<	* unregistered party to invoke this method.
572	>	* is terminated.
573		*
574		* @param phase an arrival phase number, or negative value if
575		* terminated; this argument is normally the value returned by a
#	Line 593 | Line 580 | public class Phaser {
580		public int awaitAdvance(int phase) {
581		if (phase < 0)
582		return phase;
583	<	long s = getReconciledState();
584	<	int p = phaseOf(s);
585	<	if (p != phase)
599	<	return p;
600	<	if (unarrivedOf(s) == 0 && parent != null)
601	<	parent.awaitAdvance(phase);
602	<	// Fall here even if parent waited, to reconcile and help release
603	<	return untimedWait(phase);
583	>	long s = (parent == null) ? state : reconcileState();
584	>	int p = (int)(s >>> PHASE_SHIFT);
585	>	return (p != phase) ? p : internalAwaitAdvance(phase, null);
586		}
587
588		/**
#	Line 608 | Line 590 | public class Phaser {
590		* value, throwing {@code InterruptedException} if interrupted
591		* while waiting, or returning immediately if the current phase of
592		* the barrier is not equal to the given phase value or this
593	<	* barrier is terminated. It is an unenforced usage error for an
612	<	* unregistered party to invoke this method.
593	>	* barrier is terminated.
594		*
595		* @param phase an arrival phase number, or negative value if
596		* terminated; this argument is normally the value returned by a
#	Line 622 | Line 603 | public class Phaser {
603		throws InterruptedException {
604		if (phase < 0)
605		return phase;
606	<	long s = getReconciledState();
607	<	int p = phaseOf(s);
608	<	if (p != phase)
609	<	return p;
610	<	if (unarrivedOf(s) == 0 && parent != null)
611	<	parent.awaitAdvanceInterruptibly(phase);
612	<	return interruptibleWait(phase);
606	>	long s = (parent == null) ? state : reconcileState();
607	>	int p = (int)(s >>> PHASE_SHIFT);
608	>	if (p == phase) {
609	>	QNode node = new QNode(this, phase, true, false, 0L);
610	>	p = internalAwaitAdvance(phase, node);
611	>	if (node.wasInterrupted)
612	>	throw new InterruptedException();
613	>	}
614	>	return p;
615		}
616
617		/**
#	Line 637 | Line 620 | public class Phaser {
620		* InterruptedException} if interrupted while waiting, or
621		* returning immediately if the current phase of the barrier is
622		* not equal to the given phase value or this barrier is
623	<	* terminated.  It is an unenforced usage error for an
641	<	* unregistered party to invoke this method.
623	>	* terminated.
624		*
625		* @param phase an arrival phase number, or negative value if
626		* terminated; this argument is normally the value returned by a
#	Line 657 | Line 639 | public class Phaser {
639		throws InterruptedException, TimeoutException {
640		if (phase < 0)
641		return phase;
642	<	long s = getReconciledState();
643	<	int p = phaseOf(s);
644	<	if (p != phase)
645	<	return p;
646	<	if (unarrivedOf(s) == 0 && parent != null)
647	<	parent.awaitAdvanceInterruptibly(phase, timeout, unit);
648	<	return timedWait(phase, unit.toNanos(timeout));
642	>	long s = (parent == null) ? state : reconcileState();
643	>	int p = (int)(s >>> PHASE_SHIFT);
644	>	if (p == phase) {
645	>	long nanos = unit.toNanos(timeout);
646	>	QNode node = new QNode(this, phase, true, true, nanos);
647	>	p = internalAwaitAdvance(phase, node);
648	>	if (node.wasInterrupted)
649	>	throw new InterruptedException();
650	>	else if (p == phase)
651	>	throw new TimeoutException();
652	>	}
653	>	return p;
654		}
655
656		/**
657	<	* Forces this barrier to enter termination state. Counts of
658	<	* arrived and registered parties are unaffected. If this phaser
659	<	* has a parent, it too is terminated. This method may be useful
660	<	* for coordinating recovery after one or more tasks encounter
661	<	* unexpected exceptions.
657	>	* Forces this barrier to enter termination state.  Counts of
658	>	* arrived and registered parties are unaffected.  If this phaser
659	>	* is a member of a tiered set of phasers, then all of the phasers
660	>	* in the set are terminated.  If this phaser is already
661	>	* terminated, this method has no effect.  This method may be
662	>	* useful for coordinating recovery after one or more tasks
663	>	* encounter unexpected exceptions.
664		*/
665		public void forceTermination() {
666	<	for (;;) {
667	<	long s = getReconciledState();
668	<	int phase = phaseOf(s);
669	<	int parties = partiesOf(s);
670	<	int unarrived = unarrivedOf(s);
671	<	if (phase < 0 ||
672	<	casState(s, stateFor(-1, parties, unarrived))) {
684	<	releaseWaiters(0);
666	>	// Only need to change root state
667	>	final Phaser root = this.root;
668	>	long s;
669	>	while ((s = root.state) >= 0) {
670	>	if (UNSAFE.compareAndSwapLong(root, stateOffset,
671	>	s, s | TERMINATION_PHASE)) {
672	>	releaseWaiters(0); // signal all threads
673		releaseWaiters(1);
686	–	if (parent != null)
687	–	parent.forceTermination();
674		return;
675		}
676		}
#	Line 698 | Line 684 | public class Phaser {
684		* @return the phase number, or a negative value if terminated
685		*/
686		public final int getPhase() {
687	<	return phaseOf(getReconciledState());
687	>	return (int)(root.state >>> PHASE_SHIFT);
688		}
689
690		/**
#	Line 717 | Line 703 | public class Phaser {
703		* @return the number of arrived parties
704		*/
705		public int getArrivedParties() {
706	<	return arrivedOf(state);
706	>	return arrivedOf(parent==null? state : reconcileState());
707		}
708
709		/**
#	Line 727 | Line 713 | public class Phaser {
713		* @return the number of unarrived parties
714		*/
715		public int getUnarrivedParties() {
716	<	return unarrivedOf(state);
716	>	return unarrivedOf(parent==null? state : reconcileState());
717		}
718
719		/**
#	Line 755 | Line 741 | public class Phaser {
741		* @return {@code true} if this barrier has been terminated
742		*/
743		public boolean isTerminated() {
744	<	return getPhase() < 0;
744	>	return root.state < 0L;
745		}
746
747		/**
#	Line 771 | Line 757 | public class Phaser {
757		* which case no advance occurs.
758		*
759		* <p>The arguments to this method provide the state of the phaser
760	<	* prevailing for the current transition. (When called from within
761	<	* an implementation of {@code onAdvance} the values returned by
762	<	* methods such as {@code getPhase} may or may not reliably
763	<	* indicate the state to which this transition applies.)
760	>	* prevailing for the current transition.  The effects of invoking
761	>	* arrival, registration, and waiting methods on this Phaser from
762	>	* within {@code onAdvance} are unspecified and should not be
763	>	* relied on.
764	>	*
765	>	* <p>If this Phaser is a member of a tiered set of Phasers, then
766	>	* {@code onAdvance} is invoked only for its root Phaser on each
767	>	* advance.
768		*
769		* <p>The default version returns {@code true} when the number of
770		* registered parties is zero. Normally, overrides that arrange
771		* termination for other reasons should also preserve this
772		* property.
773		*
784	–	* <p>You may override this method to perform an action with side
785	–	* effects visible to participating tasks, but doing so requires
786	–	* care: Method {@code onAdvance} may be invoked more than once
787	–	* per transition.  Further, unless all parties register before
788	–	* any arrive, and all {@link #awaitAdvance} at each phase, then
789	–	* you cannot ensure lack of interference from other parties
790	–	* during the invocation of this method.
791	–	*
774		* @param phase the phase number on entering the barrier
775		* @param registeredParties the current number of registered parties
776		* @return {@code true} if this barrier should terminate
#	Line 807 | Line 789 | public class Phaser {
789		* @return a string identifying this barrier, as well as its state
790		*/
791		public String toString() {
792	<	long s = getReconciledState();
792	>	return stateToString(reconcileState());
793	>	}
794	>
795	>	/**
796	>	* Implementation of toString and string-based error messages
797	>	*/
798	>	private String stateToString(long s) {
799		return super.toString() +
800		"[phase = " + phaseOf(s) +
801		" parties = " + partiesOf(s) +
802		" arrived = " + arrivedOf(s) + "]";
803		}
804
805	<	// methods for waiting
805	>	// Waiting mechanics
806	>
807	>	/**
808	>	* Removes and signals threads from queue for phase.
809	>	*/
810	>	private void releaseWaiters(int phase) {
811	>	AtomicReference<QNode> head = queueFor(phase);
812	>	QNode q;
813	>	int p;
814	>	while ((q = head.get()) != null &&
815	>	((p = q.phase) == phase ||
816	>	(int)(root.state >>> PHASE_SHIFT) != p)) {
817	>	if (head.compareAndSet(q, q.next))
818	>	q.signal();
819	>	}
820	>	}
821	>
822	>	/** The number of CPUs, for spin control */
823	>	private static final int NCPU = Runtime.getRuntime().availableProcessors();
824	>
825	>	/**
826	>	* The number of times to spin before blocking while waiting for
827	>	* advance, per arrival while waiting. On multiprocessors, fully
828	>	* blocking and waking up a large number of threads all at once is
829	>	* usually a very slow process, so we use rechargeable spins to
830	>	* avoid it when threads regularly arrive: When a thread in
831	>	* internalAwaitAdvance notices another arrival before blocking,
832	>	* and there appear to be enough CPUs available, it spins
833	>	* SPINS_PER_ARRIVAL more times before blocking. Plus, even on
834	>	* uniprocessors, there is at least one intervening Thread.yield
835	>	* before blocking. The value trades off good-citizenship vs big
836	>	* unnecessary slowdowns.
837	>	*/
838	>	static final int SPINS_PER_ARRIVAL = (NCPU < 2) ? 1 : 1 << 8;
839	>
840	>	/**
841	>	* Possibly blocks and waits for phase to advance unless aborted.
842	>	*
843	>	* @param phase current phase
844	>	* @param node if non-null, the wait node to track interrupt and timeout;
845	>	* if null, denotes noninterruptible wait
846	>	* @return current phase
847	>	*/
848	>	private int internalAwaitAdvance(int phase, QNode node) {
849	>	Phaser current = this;       // to eventually wait at root if tiered
850	>	boolean queued = false;      // true when node is enqueued
851	>	int lastUnarrived = -1;      // to increase spins upon change
852	>	int spins = SPINS_PER_ARRIVAL;
853	>	long s;
854	>	int p;
855	>	while ((p = (int)((s = current.state) >>> PHASE_SHIFT)) == phase) {
856	>	Phaser par;
857	>	int unarrived = (int)s & UNARRIVED_MASK;
858	>	if (unarrived != lastUnarrived) {
859	>	if (lastUnarrived == -1) // ensure old queue clean
860	>	releaseWaiters(phase-1);
861	>	if ((lastUnarrived = unarrived) < NCPU)
862	>	spins += SPINS_PER_ARRIVAL;
863	>	}
864	>	else if (unarrived == 0 && (par = current.parent) != null) {
865	>	current = par;       // if all arrived, use parent
866	>	par = par.parent;
867	>	lastUnarrived = -1;
868	>	}
869	>	else if (spins > 0) {
870	>	if (--spins == (SPINS_PER_ARRIVAL >>> 1))
871	>	Thread.yield();  // yield midway through spin
872	>	}
873	>	else if (node == null)   // must be noninterruptible
874	>	node = new QNode(this, phase, false, false, 0L);
875	>	else if (node.isReleasable()) {
876	>	if ((p = (int)(root.state >>> PHASE_SHIFT)) != phase)
877	>	break;
878	>	else
879	>	return phase;    // aborted
880	>	}
881	>	else if (!queued) {      // push onto queue
882	>	AtomicReference<QNode> head = queueFor(phase);
883	>	QNode q = head.get();
884	>	if (q == null || q.phase == phase) {
885	>	node.next = q;
886	>	if ((p = (int)(root.state >>> PHASE_SHIFT)) != phase)
887	>	break;       // recheck to avoid stale enqueue
888	>	else
889	>	queued = head.compareAndSet(q, node);
890	>	}
891	>	}
892	>	else {
893	>	try {
894	>	ForkJoinPool.managedBlock(node);
895	>	} catch (InterruptedException ie) {
896	>	node.wasInterrupted = true;
897	>	}
898	>	}
899	>	}
900	>	releaseWaiters(phase);
901	>	if (node != null)
902	>	node.onRelease();
903	>	return p;
904	>	}
905
906		/**
907		* Wait nodes for Treiber stack representing wait queue
#	Line 822 | Line 909 | public class Phaser {
909		static final class QNode implements ForkJoinPool.ManagedBlocker {
910		final Phaser phaser;
911		final int phase;
825	–	final long startTime;
826	–	final long nanos;
827	–	final boolean timed;
912		final boolean interruptible;
913	<	volatile boolean wasInterrupted = false;
913	>	final boolean timed;
914	>	boolean wasInterrupted;
915	>	long nanos;
916	>	long lastTime;
917		volatile Thread thread; // nulled to cancel wait
918		QNode next;
919	+
920		QNode(Phaser phaser, int phase, boolean interruptible,
921	<	boolean timed, long startTime, long nanos) {
921	>	boolean timed, long nanos) {
922		this.phaser = phaser;
923		this.phase = phase;
836	–	this.timed = timed;
924		this.interruptible = interruptible;
838	–	this.startTime = startTime;
925		this.nanos = nanos;
926	+	this.timed = timed;
927	+	this.lastTime = timed? System.nanoTime() : 0L;
928		thread = Thread.currentThread();
929		}
930	+
931		public boolean isReleasable() {
932	<	return (thread == null ||
933	<	phaser.getPhase() != phase ||
934	<	(interruptible && wasInterrupted) ||
935	<	(timed && (nanos - (System.nanoTime() - startTime)) <= 0));
932	>	Thread t = thread;
933	>	if (t != null) {
934	>	if (phaser.getPhase() != phase)
935	>	t = null;
936	>	else {
937	>	if (Thread.interrupted())
938	>	wasInterrupted = true;
939	>	if (interruptible && wasInterrupted)
940	>	t = null;
941	>	else if (timed) {
942	>	if (nanos > 0) {
943	>	long now = System.nanoTime();
944	>	nanos -= now - lastTime;
945	>	lastTime = now;
946	>	}
947	>	if (nanos <= 0)
948	>	t = null;
949	>	}
950	>	}
951	>	if (t != null)
952	>	return false;
953	>	thread = null;
954	>	}
955	>	return true;
956		}
957	+
958		public boolean block() {
959	<	if (Thread.interrupted()) {
960	<	wasInterrupted = true;
961	<	if (interruptible)
852	<	return true;
853	<	}
854	<	if (!timed)
959	>	if (isReleasable())
960	>	return true;
961	>	else if (!timed)
962		LockSupport.park(this);
963	<	else {
964	<	long waitTime = nanos - (System.nanoTime() - startTime);
858	<	if (waitTime <= 0)
859	<	return true;
860	<	LockSupport.parkNanos(this, waitTime);
861	<	}
963	>	else if (nanos > 0)
964	>	LockSupport.parkNanos(this, nanos);
965		return isReleasable();
966		}
967	+
968		void signal() {
969		Thread t = thread;
970		if (t != null) {
#	Line 868 | Line 972 | public class Phaser {
972		LockSupport.unpark(t);
973		}
974		}
871	–	boolean doWait() {
872	–	if (thread != null) {
873	–	try {
874	–	ForkJoinPool.managedBlock(this, false);
875	–	} catch (InterruptedException ie) {
876	–	}
877	–	}
878	–	return wasInterrupted;
879	–	}
975
976	<	}
977	<
978	<	/**
979	<	* Removes and signals waiting threads from wait queue.
980	<	*/
886	<	private void releaseWaiters(int phase) {
887	<	AtomicReference<QNode> head = queueFor(phase);
888	<	QNode q;
889	<	while ((q = head.get()) != null) {
890	<	if (head.compareAndSet(q, q.next))
891	<	q.signal();
892	<	}
893	<	}
894	<
895	<	/**
896	<	* Tries to enqueue given node in the appropriate wait queue.
897	<	*
898	<	* @return true if successful
899	<	*/
900	<	private boolean tryEnqueue(QNode node) {
901	<	AtomicReference<QNode> head = queueFor(node.phase);
902	<	return head.compareAndSet(node.next = head.get(), node);
903	<	}
904	<
905	<	/**
906	<	* Enqueues node and waits unless aborted or signalled.
907	<	*
908	<	* @return current phase
909	<	*/
910	<	private int untimedWait(int phase) {
911	<	QNode node = null;
912	<	boolean queued = false;
913	<	boolean interrupted = false;
914	<	int p;
915	<	while ((p = getPhase()) == phase) {
916	<	if (Thread.interrupted())
917	<	interrupted = true;
918	<	else if (node == null)
919	<	node = new QNode(this, phase, false, false, 0, 0);
920	<	else if (!queued)
921	<	queued = tryEnqueue(node);
922	<	else
923	<	interrupted = node.doWait();
924	<	}
925	<	if (node != null)
926	<	node.thread = null;
927	<	releaseWaiters(phase);
928	<	if (interrupted)
929	<	Thread.currentThread().interrupt();
930	<	return p;
931	<	}
932	<
933	<	/**
934	<	* Interruptible version
935	<	* @return current phase
936	<	*/
937	<	private int interruptibleWait(int phase) throws InterruptedException {
938	<	QNode node = null;
939	<	boolean queued = false;
940	<	boolean interrupted = false;
941	<	int p;
942	<	while ((p = getPhase()) == phase && !interrupted) {
943	<	if (Thread.interrupted())
944	<	interrupted = true;
945	<	else if (node == null)
946	<	node = new QNode(this, phase, true, false, 0, 0);
947	<	else if (!queued)
948	<	queued = tryEnqueue(node);
949	<	else
950	<	interrupted = node.doWait();
976	>	void onRelease() { // actions upon return from internalAwaitAdvance
977	>	if (!interruptible && wasInterrupted)
978	>	Thread.currentThread().interrupt();
979	>	if (thread != null)
980	>	thread = null;
981		}
952	–	if (node != null)
953	–	node.thread = null;
954	–	if (p != phase || (p = getPhase()) != phase)
955	–	releaseWaiters(phase);
956	–	if (interrupted)
957	–	throw new InterruptedException();
958	–	return p;
959	–	}
982
961	–	/**
962	–	* Timeout version.
963	–	* @return current phase
964	–	*/
965	–	private int timedWait(int phase, long nanos)
966	–	throws InterruptedException, TimeoutException {
967	–	long startTime = System.nanoTime();
968	–	QNode node = null;
969	–	boolean queued = false;
970	–	boolean interrupted = false;
971	–	int p;
972	–	while ((p = getPhase()) == phase && !interrupted) {
973	–	if (Thread.interrupted())
974	–	interrupted = true;
975	–	else if (nanos - (System.nanoTime() - startTime) <= 0)
976	–	break;
977	–	else if (node == null)
978	–	node = new QNode(this, phase, true, true, startTime, nanos);
979	–	else if (!queued)
980	–	queued = tryEnqueue(node);
981	–	else
982	–	interrupted = node.doWait();
983	–	}
984	–	if (node != null)
985	–	node.thread = null;
986	–	if (p != phase || (p = getPhase()) != phase)
987	–	releaseWaiters(phase);
988	–	if (interrupted)
989	–	throw new InterruptedException();
990	–	if (p == phase)
991	–	throw new TimeoutException();
992	–	return p;
983		}
984
985		// Unsafe mechanics
#	Line 998 | Line 988 | public class Phaser {
988		private static final long stateOffset =
989		objectFieldOffset("state", Phaser.class);
990
1001	–	private final boolean casState(long cmp, long val) {
1002	–	return UNSAFE.compareAndSwapLong(this, stateOffset, cmp, val);
1003	–	}
1004	–
991		private static long objectFieldOffset(String field, Class<?> klazz) {
992		try {
993		return UNSAFE.objectFieldOffset(klazz.getDeclaredField(field));

Diff Legend

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