--- jsr166/src/test/tck/PhaserTest.java 2010/11/30 01:56:12 1.25 +++ jsr166/src/test/tck/PhaserTest.java 2017/02/18 15:05:55 1.45 @@ -1,24 +1,26 @@ /* * Written by Doug Lea with assistance from members of JCP JSR-166 * Expert Group and released to the public domain, as explained at - * http://creativecommons.org/licenses/publicdomain + * http://creativecommons.org/publicdomain/zero/1.0/ * Other contributors include John Vint */ +import static java.util.concurrent.TimeUnit.MILLISECONDS; + import java.util.ArrayList; import java.util.List; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.Phaser; +import java.util.concurrent.TimeoutException; import java.util.concurrent.atomic.AtomicInteger; -import java.util.concurrent.atomic.AtomicBoolean; -import java.util.concurrent.*; -import static java.util.concurrent.TimeUnit.MILLISECONDS; -import static java.util.concurrent.TimeUnit.NANOSECONDS; + import junit.framework.Test; import junit.framework.TestSuite; public class PhaserTest extends JSR166TestCase { public static void main(String[] args) { - junit.textui.TestRunner.run(suite()); + main(suite(), args); } public static Test suite() { @@ -27,29 +29,29 @@ public class PhaserTest extends JSR166Te private static final int maxParties = 65535; - /** Checks state of phaser. */ + /** Checks state of unterminated phaser. */ protected void assertState(Phaser phaser, int phase, int parties, int unarrived) { assertEquals(phase, phaser.getPhase()); assertEquals(parties, phaser.getRegisteredParties()); assertEquals(unarrived, phaser.getUnarrivedParties()); assertEquals(parties - unarrived, phaser.getArrivedParties()); - assertTrue((phaser.getPhase() >= 0) ^ phaser.isTerminated()); + assertFalse(phaser.isTerminated()); } /** Checks state of terminated phaser. */ - protected void assertTerminated(Phaser phaser, - int maxPhase, int parties, int unarrived) { + protected void assertTerminated(Phaser phaser, int maxPhase, int parties) { assertTrue(phaser.isTerminated()); int expectedPhase = maxPhase + Integer.MIN_VALUE; - assertState(phaser, expectedPhase, parties, unarrived); + assertEquals(expectedPhase, phaser.getPhase()); + assertEquals(parties, phaser.getRegisteredParties()); assertEquals(expectedPhase, phaser.register()); assertEquals(expectedPhase, phaser.arrive()); assertEquals(expectedPhase, phaser.arriveAndDeregister()); } protected void assertTerminated(Phaser phaser, int maxPhase) { - assertTerminated(phaser, maxPhase, 0, 0); + assertTerminated(phaser, maxPhase, 0); } /** @@ -158,11 +160,14 @@ public class PhaserTest extends JSR166Te phaser.bulkRegister(Integer.MAX_VALUE); shouldThrow(); } catch (IllegalStateException success) {} + + assertEquals(0, phaser.bulkRegister(0)); + assertState(phaser, 0, maxParties, maxParties); } /** - * register() correctly returns the current barrier phase number when - * invoked + * register() correctly returns the current barrier phase number + * when invoked */ public void testRegister3() { Phaser phaser = new Phaser(); @@ -173,8 +178,8 @@ public class PhaserTest extends JSR166Te } /** - * register causes the next arrive to not increment the phase rather retain - * the phase number + * register causes the next arrive to not increment the phase + * rather retain the phase number */ public void testRegister4() { Phaser phaser = new Phaser(1); @@ -185,6 +190,33 @@ public class PhaserTest extends JSR166Te } /** + * register on a subphaser that is currently empty succeeds, even + * in the presence of another non-empty subphaser + */ + public void testRegisterEmptySubPhaser() { + Phaser root = new Phaser(); + Phaser child1 = new Phaser(root, 1); + Phaser child2 = new Phaser(root, 0); + assertEquals(0, child2.register()); + assertState(root, 0, 2, 2); + assertState(child1, 0, 1, 1); + assertState(child2, 0, 1, 1); + assertEquals(0, child2.arriveAndDeregister()); + assertState(root, 0, 1, 1); + assertState(child1, 0, 1, 1); + assertState(child2, 0, 0, 0); + assertEquals(0, child2.register()); + assertEquals(0, child2.arriveAndDeregister()); + assertState(root, 0, 1, 1); + assertState(child1, 0, 1, 1); + assertState(child2, 0, 0, 0); + assertEquals(0, child1.arriveAndDeregister()); + assertTerminated(root, 1); + assertTerminated(child1, 1); + assertTerminated(child2, 1); + } + + /** * Invoking bulkRegister with a negative parameter throws an * IllegalArgumentException */ @@ -196,11 +228,13 @@ public class PhaserTest extends JSR166Te } /** - * bulkRegister should correctly record the number of unarrived parties with - * the number of parties being registered + * bulkRegister should correctly record the number of unarrived + * parties with the number of parties being registered */ public void testBulkRegister2() { Phaser phaser = new Phaser(); + assertEquals(0, phaser.bulkRegister(0)); + assertState(phaser, 0, 0, 0); assertEquals(0, phaser.bulkRegister(20)); assertState(phaser, 0, 20, 20); } @@ -249,7 +283,7 @@ public class PhaserTest extends JSR166Te /** * arriveAndDeregister does not wait for others to arrive at barrier */ - public void testArriveAndDeregister() throws InterruptedException { + public void testArriveAndDeregister() { final Phaser phaser = new Phaser(1); for (int i = 0; i < 10; i++) { assertState(phaser, 0, 1, 1); @@ -265,20 +299,20 @@ public class PhaserTest extends JSR166Te /** * arriveAndDeregister does not wait for others to arrive at barrier */ - public void testArrive2() throws InterruptedException { + public void testArrive2() { final Phaser phaser = new Phaser(); assertEquals(0, phaser.register()); - List threads = new ArrayList(); + List threads = new ArrayList<>(); for (int i = 0; i < 10; i++) { assertEquals(0, phaser.register()); threads.add(newStartedThread(new CheckedRunnable() { - public void realRun() throws InterruptedException { + public void realRun() { assertEquals(0, phaser.arriveAndDeregister()); }})); } for (Thread thread : threads) - awaitTermination(thread, LONG_DELAY_MS); + awaitTermination(thread); assertState(phaser, 0, 1, 1); assertEquals(0, phaser.arrive()); assertState(phaser, 1, 1, 1); @@ -290,7 +324,7 @@ public class PhaserTest extends JSR166Te public void testArrive3() { Phaser phaser = new Phaser(1); phaser.forceTermination(); - assertTerminated(phaser, 0, 1, 1); + assertTerminated(phaser, 0, 1); assertEquals(0, phaser.getPhase() + Integer.MIN_VALUE); assertTrue(phaser.arrive() < 0); assertTrue(phaser.register() < 0); @@ -304,8 +338,8 @@ public class PhaserTest extends JSR166Te * registered or unarrived parties would become negative */ public void testArriveAndDeregister1() { + Phaser phaser = new Phaser(); try { - Phaser phaser = new Phaser(); phaser.arriveAndDeregister(); shouldThrow(); } catch (IllegalStateException success) {} @@ -382,7 +416,7 @@ public class PhaserTest extends JSR166Te * arriveAndDeregister returns the phase in which it leaves the * phaser in after deregistration */ - public void testArriveAndDeregister6() throws InterruptedException { + public void testArriveAndDeregister6() { final Phaser phaser = new Phaser(2); Thread t = newStartedThread(new CheckedRunnable() { public void realRun() { @@ -394,7 +428,7 @@ public class PhaserTest extends JSR166Te assertState(phaser, 1, 1, 1); assertEquals(1, phaser.arriveAndDeregister()); assertTerminated(phaser, 2); - awaitTermination(t, SHORT_DELAY_MS); + awaitTermination(t); } /** @@ -417,28 +451,81 @@ public class PhaserTest extends JSR166Te } /** + * awaitAdvanceInterruptibly blocks interruptibly + */ + public void testAwaitAdvanceInterruptibly_interruptible() throws InterruptedException { + final Phaser phaser = new Phaser(1); + final CountDownLatch pleaseInterrupt = new CountDownLatch(2); + + Thread t1 = newStartedThread(new CheckedRunnable() { + public void realRun() { + Thread.currentThread().interrupt(); + try { + phaser.awaitAdvanceInterruptibly(0); + shouldThrow(); + } catch (InterruptedException success) {} + assertFalse(Thread.interrupted()); + + pleaseInterrupt.countDown(); + try { + phaser.awaitAdvanceInterruptibly(0); + shouldThrow(); + } catch (InterruptedException success) {} + assertFalse(Thread.interrupted()); + }}); + + Thread t2 = newStartedThread(new CheckedRunnable() { + public void realRun() throws TimeoutException { + Thread.currentThread().interrupt(); + try { + phaser.awaitAdvanceInterruptibly(0, 2*LONG_DELAY_MS, MILLISECONDS); + shouldThrow(); + } catch (InterruptedException success) {} + assertFalse(Thread.interrupted()); + + pleaseInterrupt.countDown(); + try { + phaser.awaitAdvanceInterruptibly(0, 2*LONG_DELAY_MS, MILLISECONDS); + shouldThrow(); + } catch (InterruptedException success) {} + assertFalse(Thread.interrupted()); + }}); + + await(pleaseInterrupt); + assertState(phaser, 0, 1, 1); + assertThreadsStayAlive(t1, t2); + t1.interrupt(); + t2.interrupt(); + awaitTermination(t1); + awaitTermination(t2); + assertState(phaser, 0, 1, 1); + assertEquals(0, phaser.arrive()); + assertState(phaser, 1, 1, 1); + } + + /** * awaitAdvance continues waiting if interrupted before waiting */ - public void testAwaitAdvanceAfterInterrupt() throws InterruptedException { + public void testAwaitAdvanceAfterInterrupt() { final Phaser phaser = new Phaser(); assertEquals(0, phaser.register()); - final CountDownLatch threadStarted = new CountDownLatch(1); + final CountDownLatch pleaseArrive = new CountDownLatch(1); Thread t = newStartedThread(new CheckedRunnable() { - public void realRun() throws InterruptedException { + public void realRun() { Thread.currentThread().interrupt(); assertEquals(0, phaser.register()); assertEquals(0, phaser.arrive()); - threadStarted.countDown(); + pleaseArrive.countDown(); assertTrue(Thread.currentThread().isInterrupted()); assertEquals(1, phaser.awaitAdvance(0)); - assertTrue(Thread.currentThread().isInterrupted()); + assertTrue(Thread.interrupted()); }}); - assertTrue(threadStarted.await(SMALL_DELAY_MS, MILLISECONDS)); - waitForThreadToEnterWaitState(t, SMALL_DELAY_MS); + await(pleaseArrive); + waitForThreadToEnterWaitState(t); assertEquals(0, phaser.arrive()); - awaitTermination(t, SMALL_DELAY_MS); + awaitTermination(t); Thread.currentThread().interrupt(); assertEquals(1, phaser.awaitAdvance(0)); @@ -446,28 +533,28 @@ public class PhaserTest extends JSR166Te } /** - * awaitAdvance continues waiting if interrupted while waiting + * awaitAdvance continues waiting if interrupted while waiting */ - public void testAwaitAdvanceBeforeInterrupt() throws InterruptedException { + public void testAwaitAdvanceBeforeInterrupt() { final Phaser phaser = new Phaser(); assertEquals(0, phaser.register()); - final CountDownLatch threadStarted = new CountDownLatch(1); + final CountDownLatch pleaseArrive = new CountDownLatch(1); Thread t = newStartedThread(new CheckedRunnable() { - public void realRun() throws InterruptedException { + public void realRun() { assertEquals(0, phaser.register()); assertEquals(0, phaser.arrive()); - threadStarted.countDown(); assertFalse(Thread.currentThread().isInterrupted()); + pleaseArrive.countDown(); assertEquals(1, phaser.awaitAdvance(0)); - assertTrue(Thread.currentThread().isInterrupted()); + assertTrue(Thread.interrupted()); }}); - assertTrue(threadStarted.await(SMALL_DELAY_MS, MILLISECONDS)); - waitForThreadToEnterWaitState(t, SMALL_DELAY_MS); + await(pleaseArrive); + waitForThreadToEnterWaitState(t); t.interrupt(); assertEquals(0, phaser.arrive()); - awaitTermination(t, SMALL_DELAY_MS); + awaitTermination(t); Thread.currentThread().interrupt(); assertEquals(1, phaser.awaitAdvance(0)); @@ -477,123 +564,168 @@ public class PhaserTest extends JSR166Te /** * arriveAndAwaitAdvance continues waiting if interrupted before waiting */ - public void testArriveAndAwaitAdvanceAfterInterrupt() - throws InterruptedException { + public void testArriveAndAwaitAdvanceAfterInterrupt() { final Phaser phaser = new Phaser(); assertEquals(0, phaser.register()); - final CountDownLatch threadStarted = new CountDownLatch(1); + final CountDownLatch pleaseArrive = new CountDownLatch(1); Thread t = newStartedThread(new CheckedRunnable() { - public void realRun() throws InterruptedException { + public void realRun() { Thread.currentThread().interrupt(); assertEquals(0, phaser.register()); - threadStarted.countDown(); + pleaseArrive.countDown(); assertTrue(Thread.currentThread().isInterrupted()); assertEquals(1, phaser.arriveAndAwaitAdvance()); - assertTrue(Thread.currentThread().isInterrupted()); + assertTrue(Thread.interrupted()); }}); - assertTrue(threadStarted.await(SMALL_DELAY_MS, MILLISECONDS)); - waitForThreadToEnterWaitState(t, SMALL_DELAY_MS); + await(pleaseArrive); + waitForThreadToEnterWaitState(t); Thread.currentThread().interrupt(); assertEquals(1, phaser.arriveAndAwaitAdvance()); assertTrue(Thread.interrupted()); - awaitTermination(t, SMALL_DELAY_MS); + awaitTermination(t); } /** * arriveAndAwaitAdvance continues waiting if interrupted while waiting */ - public void testArriveAndAwaitAdvanceBeforeInterrupt() - throws InterruptedException { + public void testArriveAndAwaitAdvanceBeforeInterrupt() { final Phaser phaser = new Phaser(); assertEquals(0, phaser.register()); - final CountDownLatch threadStarted = new CountDownLatch(1); + final CountDownLatch pleaseInterrupt = new CountDownLatch(1); Thread t = newStartedThread(new CheckedRunnable() { - public void realRun() throws InterruptedException { + public void realRun() { assertEquals(0, phaser.register()); - threadStarted.countDown(); assertFalse(Thread.currentThread().isInterrupted()); + pleaseInterrupt.countDown(); assertEquals(1, phaser.arriveAndAwaitAdvance()); - assertTrue(Thread.currentThread().isInterrupted()); + assertTrue(Thread.interrupted()); }}); - assertTrue(threadStarted.await(SMALL_DELAY_MS, MILLISECONDS)); - waitForThreadToEnterWaitState(t, SMALL_DELAY_MS); + await(pleaseInterrupt); + waitForThreadToEnterWaitState(t); t.interrupt(); Thread.currentThread().interrupt(); assertEquals(1, phaser.arriveAndAwaitAdvance()); assertTrue(Thread.interrupted()); - awaitTermination(t, SMALL_DELAY_MS); + awaitTermination(t); } /** * awaitAdvance atomically waits for all parties within the same phase to * complete before continuing */ - public void testAwaitAdvance4() throws InterruptedException { + public void testAwaitAdvance4() { final Phaser phaser = new Phaser(4); final AtomicInteger count = new AtomicInteger(0); - List threads = new ArrayList(); + List threads = new ArrayList<>(); for (int i = 0; i < 4; i++) threads.add(newStartedThread(new CheckedRunnable() { public void realRun() { for (int k = 0; k < 3; k++) { - assertEquals(2*k+1, phaser.arriveAndAwaitAdvance()); + assertEquals(2 * k + 1, phaser.arriveAndAwaitAdvance()); count.incrementAndGet(); - assertEquals(2*k+1, phaser.arrive()); - assertEquals(2*k+2, phaser.awaitAdvance(2*k+1)); - assertEquals(count.get(), 4*(k+1)); + assertEquals(2 * k + 1, phaser.arrive()); + assertEquals(2 * k + 2, phaser.awaitAdvance(2 * k + 1)); + assertEquals(4 * (k + 1), count.get()); }}})); for (Thread thread : threads) - awaitTermination(thread, MEDIUM_DELAY_MS); + awaitTermination(thread); } /** * awaitAdvance returns the current phase */ - public void testAwaitAdvance5() throws InterruptedException { + public void testAwaitAdvance5() { final Phaser phaser = new Phaser(1); assertEquals(1, phaser.awaitAdvance(phaser.arrive())); assertEquals(1, phaser.getPhase()); assertEquals(1, phaser.register()); - List threads = new ArrayList(); + List threads = new ArrayList<>(); for (int i = 0; i < 8; i++) { final CountDownLatch latch = new CountDownLatch(1); final boolean goesFirst = ((i & 1) == 0); threads.add(newStartedThread(new CheckedRunnable() { - public void realRun() throws InterruptedException { + public void realRun() { if (goesFirst) latch.countDown(); else - assertTrue(latch.await(SMALL_DELAY_MS, MILLISECONDS)); + await(latch); phaser.arrive(); }})); if (goesFirst) - assertTrue(latch.await(SMALL_DELAY_MS, MILLISECONDS)); + await(latch); else latch.countDown(); assertEquals(i + 2, phaser.awaitAdvance(phaser.arrive())); assertEquals(i + 2, phaser.getPhase()); } for (Thread thread : threads) - awaitTermination(thread, SMALL_DELAY_MS); + awaitTermination(thread); + } + + /** + * awaitAdvance returns the current phase in child phasers + */ + public void testAwaitAdvanceTieredPhaser() throws Exception { + final Phaser parent = new Phaser(); + final List zeroPartyChildren = new ArrayList<>(3); + final List onePartyChildren = new ArrayList<>(3); + for (int i = 0; i < 3; i++) { + zeroPartyChildren.add(new Phaser(parent, 0)); + onePartyChildren.add(new Phaser(parent, 1)); + } + final List phasers = new ArrayList<>(); + phasers.addAll(zeroPartyChildren); + phasers.addAll(onePartyChildren); + phasers.add(parent); + for (Phaser phaser : phasers) { + assertEquals(-42, phaser.awaitAdvance(-42)); + assertEquals(-42, phaser.awaitAdvanceInterruptibly(-42)); + assertEquals(-42, phaser.awaitAdvanceInterruptibly(-42, MEDIUM_DELAY_MS, MILLISECONDS)); + } + + for (Phaser child : onePartyChildren) + assertEquals(0, child.arrive()); + for (Phaser phaser : phasers) { + assertEquals(-42, phaser.awaitAdvance(-42)); + assertEquals(-42, phaser.awaitAdvanceInterruptibly(-42)); + assertEquals(-42, phaser.awaitAdvanceInterruptibly(-42, MEDIUM_DELAY_MS, MILLISECONDS)); + assertEquals(1, phaser.awaitAdvance(0)); + assertEquals(1, phaser.awaitAdvanceInterruptibly(0)); + assertEquals(1, phaser.awaitAdvanceInterruptibly(0, MEDIUM_DELAY_MS, MILLISECONDS)); + } + + for (Phaser child : onePartyChildren) + assertEquals(1, child.arrive()); + for (Phaser phaser : phasers) { + assertEquals(-42, phaser.awaitAdvance(-42)); + assertEquals(-42, phaser.awaitAdvanceInterruptibly(-42)); + assertEquals(-42, phaser.awaitAdvanceInterruptibly(-42, MEDIUM_DELAY_MS, MILLISECONDS)); + assertEquals(2, phaser.awaitAdvance(0)); + assertEquals(2, phaser.awaitAdvanceInterruptibly(0)); + assertEquals(2, phaser.awaitAdvanceInterruptibly(0, MEDIUM_DELAY_MS, MILLISECONDS)); + assertEquals(2, phaser.awaitAdvance(1)); + assertEquals(2, phaser.awaitAdvanceInterruptibly(1)); + assertEquals(2, phaser.awaitAdvanceInterruptibly(1, MEDIUM_DELAY_MS, MILLISECONDS)); + } } /** * awaitAdvance returns when the phaser is externally terminated */ - public void testAwaitAdvance6() throws InterruptedException { + public void testAwaitAdvance6() { final Phaser phaser = new Phaser(3); - final CountDownLatch threadsStarted = new CountDownLatch(2); - final List threads = new ArrayList(); + final CountDownLatch pleaseForceTermination = new CountDownLatch(2); + final List threads = new ArrayList<>(); for (int i = 0; i < 2; i++) { Runnable r = new CheckedRunnable() { public void realRun() { assertEquals(0, phaser.arrive()); - threadsStarted.countDown(); + pleaseForceTermination.countDown(); assertTrue(phaser.awaitAdvance(0) < 0); assertTrue(phaser.isTerminated()); assertTrue(phaser.getPhase() < 0); @@ -602,13 +734,12 @@ public class PhaserTest extends JSR166Te }}; threads.add(newStartedThread(r)); } - threadsStarted.await(); + await(pleaseForceTermination); phaser.forceTermination(); + assertTrue(phaser.isTerminated()); assertEquals(0, phaser.getPhase() + Integer.MIN_VALUE); for (Thread thread : threads) - awaitTermination(thread, SMALL_DELAY_MS); - assertTrue(phaser.isTerminated()); - assertTrue(phaser.getPhase() < 0); + awaitTermination(thread); assertEquals(3, phaser.getRegisteredParties()); } @@ -617,8 +748,8 @@ public class PhaserTest extends JSR166Te * unarrived parties */ public void testArriveAndAwaitAdvance1() { + Phaser phaser = new Phaser(); try { - Phaser phaser = new Phaser(); phaser.arriveAndAwaitAdvance(); shouldThrow(); } catch (IllegalStateException success) {} @@ -629,31 +760,33 @@ public class PhaserTest extends JSR166Te * number of arrived parties is the same number that is accounted * for when the main thread awaitsAdvance */ - public void testArriveAndAwaitAdvance3() throws InterruptedException { + public void testArriveAndAwaitAdvance3() { final Phaser phaser = new Phaser(1); final int THREADS = 3; - final CountDownLatch threadsStarted = new CountDownLatch(THREADS); - final List threads = new ArrayList(); + final CountDownLatch pleaseArrive = new CountDownLatch(THREADS); + final List threads = new ArrayList<>(); for (int i = 0; i < THREADS; i++) threads.add(newStartedThread(new CheckedRunnable() { - public void realRun() throws InterruptedException { + public void realRun() { assertEquals(0, phaser.register()); - threadsStarted.countDown(); + pleaseArrive.countDown(); assertEquals(1, phaser.arriveAndAwaitAdvance()); }})); - assertTrue(threadsStarted.await(MEDIUM_DELAY_MS, MILLISECONDS)); - long t0 = System.nanoTime(); + await(pleaseArrive); + long startTime = System.nanoTime(); while (phaser.getArrivedParties() < THREADS) Thread.yield(); assertEquals(THREADS, phaser.getArrivedParties()); - assertTrue(NANOSECONDS.toMillis(System.nanoTime() - t0) < SMALL_DELAY_MS); + assertTrue(millisElapsedSince(startTime) < LONG_DELAY_MS); + for (Thread thread : threads) + waitForThreadToEnterWaitState(thread); for (Thread thread : threads) assertTrue(thread.isAlive()); assertState(phaser, 0, THREADS + 1, 1); phaser.arriveAndAwaitAdvance(); for (Thread thread : threads) - awaitTermination(thread, SMALL_DELAY_MS); + awaitTermination(thread); assertState(phaser, 1, THREADS + 1, THREADS + 1); }