/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.neo4j.util.concurrent;

import static java.time.Duration.ofSeconds;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTimeoutPreemptively;

import java.util.concurrent.ThreadLocalRandom;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicReference;
import org.junit.jupiter.api.Test;

class BinaryLatchTest {
    @Test
    void releaseThenAwaitDoesNotBlock() {
        assertTimeoutPreemptively(ofSeconds(30), () -> {
            BinaryLatch latch = new BinaryLatch();
            latch.release();
            latch.await();
        });
    }

    @Test
    void releaseMustUnblockAwaiters() {
        assertTimeoutPreemptively(ofSeconds(30), () -> {
            final BinaryLatch latch = new BinaryLatch();
            Runnable awaiter = latch::await;
            int awaiters = 10;
            Thread[] threads = new Thread[awaiters];
            for (int i = 0; i < awaiters; i++) {
                threads[i] = new Thread(awaiter);
                threads[i].start();
            }

            long deadline = TimeUnit.SECONDS.toNanos(10) + System.nanoTime();
            while (deadline - System.nanoTime() > 0) {
                if (threads[0].getState() == Thread.State.WAITING) {
                    break;
                }
                Thread.sleep(10);
            }

            threads[0].join(10);
            try {
                assertEquals(Thread.State.WAITING, threads[0].getState());
            } finally {
                latch.release();
                for (Thread thread : threads) {
                    thread.join();
                }
            }
        });
    }

    @Test
    void stressLatch() {
        assertTimeoutPreemptively(ofSeconds(60), () -> {
            final AtomicReference<BinaryLatch> latchRef = new AtomicReference<>(new BinaryLatch());
            Runnable awaiter = () -> {
                BinaryLatch latch;
                while ((latch = latchRef.get()) != null) {
                    latch.await();
                }
            };

            int awaiters = 6;
            Thread[] threads = new Thread[awaiters];
            for (int i = 0; i < awaiters; i++) {
                threads[i] = new Thread(awaiter);
                threads[i].start();
            }

            ThreadLocalRandom rng = ThreadLocalRandom.current();
            for (int i = 0; i < 50000; i++) {
                latchRef.getAndSet(new BinaryLatch()).release();
                spin(rng.nextLong(0, 10));
            }

            latchRef.getAndSet(null).release();

            // None of the tasks we started should get stuck, e.g. miss a release signal:
            for (Thread thread : threads) {
                thread.join();
            }
        });
    }

    private static void spin(long micros) {
        if (micros == 0) {
            return;
        }

        long now;
        long deadline = System.nanoTime() + TimeUnit.MICROSECONDS.toNanos(micros);
        do {
            now = System.nanoTime();
        } while (now < deadline);
    }
}
