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

Comparing jsr166/src/test/tck/CyclicBarrierTest.java (file contents):
Revision 1.3 by dl, Sat Sep 20 18:20:07 2003 UTC vs.
Revision 1.33 by jsr166, Mon Sep 9 00:03:07 2019 UTC

# Line 1 | Line 1
1   /*
2 < * Written by members of JCP JSR-166 Expert Group and released to the
3 < * public domain. Use, modify, and redistribute this code in any way
4 < * without acknowledgement. Other contributors include Andrew Wright,
5 < * Jeffrey Hayes, Pat Fischer, Mike Judd.
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/publicdomain/zero/1.0/
5 > * Other contributors include Andrew Wright, Jeffrey Hayes,
6 > * Pat Fisher, Mike Judd.
7   */
8  
9 < import junit.framework.*;
9 < import java.util.*;
10 < import java.util.concurrent.*;
9 > import static java.util.concurrent.TimeUnit.MILLISECONDS;
10  
11 < public class CyclicBarrierTest extends JSR166TestCase{
11 > import java.util.concurrent.BrokenBarrierException;
12 > import java.util.concurrent.CountDownLatch;
13 > import java.util.concurrent.CyclicBarrier;
14 > import java.util.concurrent.ExecutorService;
15 > import java.util.concurrent.Executors;
16 > import java.util.concurrent.ThreadLocalRandom;
17 > import java.util.concurrent.TimeoutException;
18 > import java.util.concurrent.atomic.AtomicBoolean;
19 > import java.util.concurrent.atomic.AtomicInteger;
20 >
21 > import junit.framework.Test;
22 > import junit.framework.TestSuite;
23 >
24 > public class CyclicBarrierTest extends JSR166TestCase {
25      public static void main(String[] args) {
26 <        junit.textui.TestRunner.run (suite());  
26 >        main(suite(), args);
27      }
28      public static Test suite() {
29 <        return new TestSuite(CyclicBarrierTest.class);
29 >        return new TestSuite(CyclicBarrierTest.class);
30      }
31  
32 <    private volatile int countAction;
33 <    private class MyAction implements Runnable {
34 <        public void run() { ++countAction; }
32 >    /**
33 >     * Spin-waits till the number of waiters == numberOfWaiters.
34 >     */
35 >    void awaitNumberWaiting(CyclicBarrier barrier, int numberOfWaiters) {
36 >        long startTime = System.nanoTime();
37 >        while (barrier.getNumberWaiting() != numberOfWaiters) {
38 >            if (millisElapsedSince(startTime) > LONG_DELAY_MS)
39 >                fail("timed out");
40 >            Thread.yield();
41 >        }
42      }
43 <    
43 >
44      /**
45 <     *
45 >     * Creating with negative parties throws IllegalArgumentException
46       */
47      public void testConstructor1() {
48          try {
49              new CyclicBarrier(-1, (Runnable)null);
50              shouldThrow();
51 <        } catch(IllegalArgumentException e){}
51 >        } catch (IllegalArgumentException success) {}
52      }
53  
54      /**
55 <     *
55 >     * Creating with negative parties and no action throws
56 >     * IllegalArgumentException
57       */
58      public void testConstructor2() {
59          try {
60              new CyclicBarrier(-1);
61              shouldThrow();
62 <        } catch(IllegalArgumentException e){}
62 >        } catch (IllegalArgumentException success) {}
63      }
64  
65      /**
66 <     *
66 >     * getParties returns the number of parties given in constructor
67       */
68 <    public void testConstructor3() {
68 >    public void testGetParties() {
69          CyclicBarrier b = new CyclicBarrier(2);
70 <        assertEquals(2, b.getParties());
70 >        assertEquals(2, b.getParties());
71          assertEquals(0, b.getNumberWaiting());
72      }
73  
74      /**
75 <     *
75 >     * A 1-party barrier triggers after single await
76       */
77 <    public void testSingleParty() {
78 <        try {
79 <            CyclicBarrier b = new CyclicBarrier(1);
80 <            assertEquals(1, b.getParties());
81 <            assertEquals(0, b.getNumberWaiting());
82 <            b.await();
83 <            b.await();
64 <            assertEquals(0, b.getNumberWaiting());
65 <        }
66 <        catch(Exception e) {
67 <            unexpectedException();
68 <        }
77 >    public void testSingleParty() throws Exception {
78 >        CyclicBarrier b = new CyclicBarrier(1);
79 >        assertEquals(1, b.getParties());
80 >        assertEquals(0, b.getNumberWaiting());
81 >        b.await();
82 >        b.await();
83 >        assertEquals(0, b.getNumberWaiting());
84      }
85 <    
85 >
86      /**
87 <     *
87 >     * The supplied barrier action is run at barrier
88       */
89 <    public void testBarrierAction() {
90 <        try {
91 <            countAction = 0;
92 <            CyclicBarrier b = new CyclicBarrier(1, new MyAction());
93 <            assertEquals(1, b.getParties());
94 <            assertEquals(0, b.getNumberWaiting());
95 <            b.await();
96 <            b.await();
97 <            assertEquals(0, b.getNumberWaiting());
98 <            assertEquals(countAction, 2);
99 <        }
85 <        catch(Exception e) {
86 <            unexpectedException();
87 <        }
89 >    public void testBarrierAction() throws Exception {
90 >        final AtomicInteger count = new AtomicInteger(0);
91 >        final Runnable incCount = new Runnable() { public void run() {
92 >            count.getAndIncrement(); }};
93 >        CyclicBarrier b = new CyclicBarrier(1, incCount);
94 >        assertEquals(1, b.getParties());
95 >        assertEquals(0, b.getNumberWaiting());
96 >        b.await();
97 >        b.await();
98 >        assertEquals(0, b.getNumberWaiting());
99 >        assertEquals(2, count.get());
100      }
101  
90
102      /**
103 <     *
103 >     * A 2-party/thread barrier triggers after both threads invoke await
104       */
105 <    public void testTwoParties() {
105 >    public void testTwoParties() throws Exception {
106          final CyclicBarrier b = new CyclicBarrier(2);
107 <        Thread t = new Thread(new Runnable() {
108 <                public void run() {
109 <                    try {
110 <                        b.await();
111 <                        b.await();
112 <                        b.await();
113 <                        b.await();
114 <                    } catch(Exception e){
115 <                        threadUnexpectedException();
116 <                    }}});
107 >        Thread t = newStartedThread(new CheckedRunnable() {
108 >            public void realRun() throws Exception {
109 >                b.await();
110 >                b.await();
111 >                b.await();
112 >                b.await();
113 >            }});
114 >
115 >        b.await();
116 >        b.await();
117 >        b.await();
118 >        b.await();
119 >        awaitTermination(t);
120 >    }
121  
122 <        try {
123 <            t.start();
124 <            b.await();
125 <            b.await();
126 <            b.await();
127 <            b.await();
128 <            t.join();
129 <        } catch(Exception e){
130 <            unexpectedException();
131 <        }
122 >    /**
123 >     * An interruption in one party causes others waiting in await to
124 >     * throw BrokenBarrierException
125 >     */
126 >    public void testAwait1_Interrupted_BrokenBarrier() {
127 >        final CyclicBarrier c = new CyclicBarrier(3);
128 >        final CountDownLatch pleaseInterrupt = new CountDownLatch(2);
129 >        Thread t1 = new ThreadShouldThrow(InterruptedException.class) {
130 >            public void realRun() throws Exception {
131 >                pleaseInterrupt.countDown();
132 >                c.await();
133 >            }};
134 >        Thread t2 = new ThreadShouldThrow(BrokenBarrierException.class) {
135 >            public void realRun() throws Exception {
136 >                pleaseInterrupt.countDown();
137 >                c.await();
138 >            }};
139 >
140 >        t1.start();
141 >        t2.start();
142 >        await(pleaseInterrupt);
143 >        t1.interrupt();
144 >        awaitTermination(t1);
145 >        awaitTermination(t2);
146 >    }
147 >
148 >    /**
149 >     * An interruption in one party causes others waiting in timed await to
150 >     * throw BrokenBarrierException
151 >     */
152 >    public void testAwait2_Interrupted_BrokenBarrier() throws Exception {
153 >        final CyclicBarrier c = new CyclicBarrier(3);
154 >        final CountDownLatch pleaseInterrupt = new CountDownLatch(2);
155 >        Thread t1 = new ThreadShouldThrow(InterruptedException.class) {
156 >            public void realRun() throws Exception {
157 >                pleaseInterrupt.countDown();
158 >                c.await(LONG_DELAY_MS, MILLISECONDS);
159 >            }};
160 >        Thread t2 = new ThreadShouldThrow(BrokenBarrierException.class) {
161 >            public void realRun() throws Exception {
162 >                pleaseInterrupt.countDown();
163 >                c.await(LONG_DELAY_MS, MILLISECONDS);
164 >            }};
165 >
166 >        t1.start();
167 >        t2.start();
168 >        await(pleaseInterrupt);
169 >        t1.interrupt();
170 >        awaitTermination(t1);
171 >        awaitTermination(t2);
172      }
173  
174 +    /**
175 +     * A timeout in timed await throws TimeoutException
176 +     */
177 +    public void testAwait3_TimeoutException() throws InterruptedException {
178 +        final CyclicBarrier c = new CyclicBarrier(2);
179 +        Thread t = newStartedThread(new CheckedRunnable() {
180 +            public void realRun() throws Exception {
181 +                long startTime = System.nanoTime();
182 +                try {
183 +                    c.await(timeoutMillis(), MILLISECONDS);
184 +                    shouldThrow();
185 +                } catch (TimeoutException success) {}
186 +                assertTrue(millisElapsedSince(startTime) >= timeoutMillis());
187 +            }});
188 +
189 +        awaitTermination(t);
190 +    }
191  
192      /**
193 <     *
193 >     * A timeout in one party causes others waiting in timed await to
194 >     * throw BrokenBarrierException
195       */
196 <    public void testAwait1_Interrupted_BrokenBarrier() {
196 >    public void testAwait4_Timeout_BrokenBarrier() throws InterruptedException {
197          final CyclicBarrier c = new CyclicBarrier(3);
198 <        Thread t1 = new Thread(new Runnable() {
199 <                public void run() {
200 <                    try {
201 <                        c.await();
202 <                        threadShouldThrow();
203 <                    } catch(InterruptedException success){}                
204 <                    catch(Exception b){
205 <                        threadFail("should throw IE");
206 <                    }
207 <                }
208 <            });
209 <        Thread t2 = new Thread(new Runnable() {
210 <                public void run() {
211 <                    try {
212 <                        c.await();
213 <                        threadShouldThrow();                        
214 <                    } catch(BrokenBarrierException success){
215 <                    } catch(Exception i){
216 <                        threadFail("should throw BBE");
217 <                    }
218 <                }
219 <            });
220 <        try {
198 >        Thread t1 = newStartedThread(new CheckedRunnable() {
199 >            public void realRun() throws Exception {
200 >                try {
201 >                    c.await(LONG_DELAY_MS, MILLISECONDS);
202 >                    shouldThrow();
203 >                } catch (BrokenBarrierException success) {}
204 >            }});
205 >        Thread t2 = newStartedThread(new CheckedRunnable() {
206 >            public void realRun() throws Exception {
207 >                awaitNumberWaiting(c, 1);
208 >                long startTime = System.nanoTime();
209 >                try {
210 >                    c.await(timeoutMillis(), MILLISECONDS);
211 >                    shouldThrow();
212 >                } catch (TimeoutException success) {}
213 >                assertTrue(millisElapsedSince(startTime) >= timeoutMillis());
214 >            }});
215 >
216 >        awaitTermination(t1);
217 >        awaitTermination(t2);
218 >    }
219 >
220 >    /**
221 >     * A timeout in one party causes others waiting in await to
222 >     * throw BrokenBarrierException
223 >     */
224 >    public void testAwait5_Timeout_BrokenBarrier() throws InterruptedException {
225 >        final CyclicBarrier c = new CyclicBarrier(3);
226 >        Thread t1 = newStartedThread(new CheckedRunnable() {
227 >            public void realRun() throws Exception {
228 >                try {
229 >                    c.await();
230 >                    shouldThrow();
231 >                } catch (BrokenBarrierException success) {}
232 >            }});
233 >        Thread t2 = newStartedThread(new CheckedRunnable() {
234 >            public void realRun() throws Exception {
235 >                awaitNumberWaiting(c, 1);
236 >                long startTime = System.nanoTime();
237 >                try {
238 >                    c.await(timeoutMillis(), MILLISECONDS);
239 >                    shouldThrow();
240 >                } catch (TimeoutException success) {}
241 >                assertTrue(millisElapsedSince(startTime) >= timeoutMillis());
242 >            }});
243 >
244 >        awaitTermination(t1);
245 >        awaitTermination(t2);
246 >    }
247 >
248 >    /**
249 >     * A reset of an active barrier causes waiting threads to throw
250 >     * BrokenBarrierException
251 >     */
252 >    public void testReset_BrokenBarrier() throws InterruptedException {
253 >        final CyclicBarrier c = new CyclicBarrier(3);
254 >        final CountDownLatch pleaseReset = new CountDownLatch(2);
255 >        Thread t1 = new ThreadShouldThrow(BrokenBarrierException.class) {
256 >            public void realRun() throws Exception {
257 >                pleaseReset.countDown();
258 >                c.await();
259 >            }};
260 >        Thread t2 = new ThreadShouldThrow(BrokenBarrierException.class) {
261 >            public void realRun() throws Exception {
262 >                pleaseReset.countDown();
263 >                c.await();
264 >            }};
265 >
266 >        t1.start();
267 >        t2.start();
268 >        await(pleaseReset);
269 >
270 >        awaitNumberWaiting(c, 2);
271 >        c.reset();
272 >        awaitTermination(t1);
273 >        awaitTermination(t2);
274 >    }
275 >
276 >    /**
277 >     * A reset before threads enter barrier does not throw
278 >     * BrokenBarrierException
279 >     */
280 >    public void testReset_NoBrokenBarrier() throws Exception {
281 >        final CyclicBarrier c = new CyclicBarrier(3);
282 >        c.reset();
283 >
284 >        Thread t1 = newStartedThread(new CheckedRunnable() {
285 >            public void realRun() throws Exception {
286 >                c.await();
287 >            }});
288 >        Thread t2 = newStartedThread(new CheckedRunnable() {
289 >            public void realRun() throws Exception {
290 >                c.await();
291 >            }});
292 >
293 >        c.await();
294 >        awaitTermination(t1);
295 >        awaitTermination(t2);
296 >    }
297 >
298 >    /**
299 >     * Reset of a non-broken barrier does not break barrier
300 >     */
301 >    public void testResetWithoutBreakage() throws Exception {
302 >        final CyclicBarrier barrier = new CyclicBarrier(3);
303 >        for (int i = 0; i < 3; i++) {
304 >            final CyclicBarrier start = new CyclicBarrier(3);
305 >            Thread t1 = newStartedThread(new CheckedRunnable() {
306 >                public void realRun() throws Exception {
307 >                    start.await();
308 >                    barrier.await();
309 >                }});
310 >
311 >            Thread t2 = newStartedThread(new CheckedRunnable() {
312 >                public void realRun() throws Exception {
313 >                    start.await();
314 >                    barrier.await();
315 >                }});
316 >
317 >            start.await();
318 >            barrier.await();
319 >            awaitTermination(t1);
320 >            awaitTermination(t2);
321 >            assertFalse(barrier.isBroken());
322 >            assertEquals(0, barrier.getNumberWaiting());
323 >            if (i == 1) barrier.reset();
324 >            assertFalse(barrier.isBroken());
325 >            assertEquals(0, barrier.getNumberWaiting());
326 >        }
327 >    }
328 >
329 >    /**
330 >     * Reset of a barrier after interruption reinitializes it.
331 >     */
332 >    public void testResetAfterInterrupt() throws Exception {
333 >        final CyclicBarrier barrier = new CyclicBarrier(3);
334 >        for (int i = 0; i < 2; i++) {
335 >            final CyclicBarrier start = new CyclicBarrier(3);
336 >            Thread t1 = new ThreadShouldThrow(InterruptedException.class) {
337 >                public void realRun() throws Exception {
338 >                    start.await();
339 >                    barrier.await();
340 >                }};
341 >
342 >            Thread t2 = new ThreadShouldThrow(BrokenBarrierException.class) {
343 >                public void realRun() throws Exception {
344 >                    start.await();
345 >                    barrier.await();
346 >                }};
347 >
348              t1.start();
349              t2.start();
350 <            Thread.sleep(SHORT_DELAY_MS);
350 >            start.await();
351              t1.interrupt();
352 <            t1.join();
353 <            t2.join();
354 <        } catch(InterruptedException e){
355 <            unexpectedException();
352 >            awaitTermination(t1);
353 >            awaitTermination(t2);
354 >            assertTrue(barrier.isBroken());
355 >            assertEquals(0, barrier.getNumberWaiting());
356 >            barrier.reset();
357 >            assertFalse(barrier.isBroken());
358 >            assertEquals(0, barrier.getNumberWaiting());
359          }
360      }
361  
362      /**
363 <     *
363 >     * Reset of a barrier after timeout reinitializes it.
364       */
365 <    public void testAwait2_Interrupted_BrokenBarrier() {
366 <      final CyclicBarrier c = new CyclicBarrier(3);
367 <        Thread t1 = new Thread(new Runnable() {
368 <                public void run() {
365 >    public void testResetAfterTimeout() throws Exception {
366 >        final CyclicBarrier barrier = new CyclicBarrier(3);
367 >        for (int i = 0; i < 2; i++) {
368 >            assertEquals(0, barrier.getNumberWaiting());
369 >            Thread t1 = newStartedThread(new CheckedRunnable() {
370 >                public void realRun() throws Exception {
371                      try {
372 <                        c.await(MEDIUM_DELAY_MS, TimeUnit.MILLISECONDS);
373 <                        threadShouldThrow();
374 <                    } catch(InterruptedException success){
375 <                    } catch(Exception b){
376 <                        threadFail("should throw IE");
377 <                    }
378 <                }
379 <            });
175 <        Thread t2 = new Thread(new Runnable() {
176 <                public void run() {
372 >                        barrier.await();
373 >                        shouldThrow();
374 >                    } catch (BrokenBarrierException success) {}
375 >                }});
376 >            Thread t2 = newStartedThread(new CheckedRunnable() {
377 >                public void realRun() throws Exception {
378 >                    awaitNumberWaiting(barrier, 1);
379 >                    long startTime = System.nanoTime();
380                      try {
381 <                        c.await(MEDIUM_DELAY_MS, TimeUnit.MILLISECONDS);
382 <                        threadShouldThrow();                        
383 <                    } catch(BrokenBarrierException success){
384 <                    } catch(Exception i){
385 <                        threadFail("should throw BBE");
386 <                    }
387 <                }
388 <            });
389 <        try {
381 >                        barrier.await(timeoutMillis(), MILLISECONDS);
382 >                        shouldThrow();
383 >                    } catch (TimeoutException success) {}
384 >                    assertTrue(millisElapsedSince(startTime) >= timeoutMillis());
385 >                }});
386 >
387 >            awaitTermination(t1);
388 >            awaitTermination(t2);
389 >            assertEquals(0, barrier.getNumberWaiting());
390 >            assertTrue(barrier.isBroken());
391 >            assertEquals(0, barrier.getNumberWaiting());
392 >            barrier.reset();
393 >            assertFalse(barrier.isBroken());
394 >            assertEquals(0, barrier.getNumberWaiting());
395 >        }
396 >    }
397 >
398 >    /**
399 >     * Reset of a barrier after a failed command reinitializes it.
400 >     */
401 >    public void testResetAfterCommandException() throws Exception {
402 >        final CyclicBarrier barrier =
403 >            new CyclicBarrier(3, new Runnable() {
404 >                    public void run() {
405 >                        throw new NullPointerException(); }});
406 >        for (int i = 0; i < 2; i++) {
407 >            final CyclicBarrier start = new CyclicBarrier(3);
408 >            Thread t1 = new ThreadShouldThrow(BrokenBarrierException.class) {
409 >                public void realRun() throws Exception {
410 >                    start.await();
411 >                    barrier.await();
412 >                }};
413 >
414 >            Thread t2 = new ThreadShouldThrow(BrokenBarrierException.class) {
415 >                public void realRun() throws Exception {
416 >                    start.await();
417 >                    barrier.await();
418 >                }};
419 >
420              t1.start();
421              t2.start();
422 <            Thread.sleep(SHORT_DELAY_MS);
423 <            t1.interrupt();
424 <            t1.join();
425 <            t2.join();
426 <        } catch(InterruptedException e){
427 <            unexpectedException();
422 >            start.await();
423 >            awaitNumberWaiting(barrier, 2);
424 >            try {
425 >                barrier.await();
426 >                shouldThrow();
427 >            } catch (NullPointerException success) {}
428 >            awaitTermination(t1);
429 >            awaitTermination(t2);
430 >            assertTrue(barrier.isBroken());
431 >            assertEquals(0, barrier.getNumberWaiting());
432 >            barrier.reset();
433 >            assertFalse(barrier.isBroken());
434 >            assertEquals(0, barrier.getNumberWaiting());
435          }
436      }
437 <    
437 >
438      /**
439 <     *
439 >     * There can be more threads calling await() than parties, as long as each
440 >     * task only calls await once and the task count is a multiple of parties.
441       */
442 <    public void testAwait3_TimeOutException() {
443 <        final CyclicBarrier c = new CyclicBarrier(2);
444 <        Thread t = new Thread(new Runnable() {
445 <                public void run() {
446 <                    try {
447 <                        c.await(SHORT_DELAY_MS, TimeUnit.MILLISECONDS);
448 <                        threadShouldThrow();
449 <                    } catch(TimeoutException success){
450 <                    } catch(Exception b){
451 <                        threadFail("should throw TOE");
452 <                        
453 <                    }
454 <                }
455 <            });
456 <        try {
457 <            t.start();
458 <            t.join();
459 <        } catch(InterruptedException e){
460 <            unexpectedException();
442 >    public void testMoreTasksThanParties() throws Exception {
443 >        final ThreadLocalRandom rnd = ThreadLocalRandom.current();
444 >        final int parties = rnd.nextInt(1, 5);
445 >        final int nTasks = rnd.nextInt(1, 5) * parties;
446 >        final AtomicInteger tripCount = new AtomicInteger(0);
447 >        final AtomicInteger awaitCount = new AtomicInteger(0);
448 >        final CyclicBarrier barrier =
449 >            new CyclicBarrier(parties, () -> tripCount.getAndIncrement());
450 >        final ExecutorService e = Executors.newFixedThreadPool(nTasks);
451 >        final Runnable awaiter = () -> {
452 >            try {
453 >                if (randomBoolean())
454 >                    barrier.await();
455 >                else
456 >                    barrier.await(LONG_DELAY_MS, MILLISECONDS);
457 >                awaitCount.getAndIncrement();
458 >            } catch (Throwable fail) { threadUnexpectedException(fail); }};
459 >        try (PoolCleaner cleaner = cleaner(e)) {
460 >            for (int i = nTasks; i--> 0; )
461 >                e.execute(awaiter);
462          }
463 +        assertEquals(nTasks / parties, tripCount.get());
464 +        assertEquals(nTasks, awaitCount.get());
465 +        assertEquals(0, barrier.getNumberWaiting());
466      }
222    
467   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines