#include #include #include #include #include #include using namespace llarp; using namespace llarp::thread; using LockGuard = std::unique_lock< std::mutex >; class Element { private: double data; bool shouldStop; public: Element(double d, bool _stop = false) : data(d), shouldStop(_stop) { } double val() const { return data; } bool stop() const { return shouldStop; } }; bool operator==(const Element& lhs, const Element& rhs) { return lhs.val() == rhs.val(); } using ObjQueue = Queue< Element >; class Args { public: std::condition_variable startCond; std::condition_variable runCond; std::mutex mutex; ObjQueue queue; // Use volatile over atomic int in order to verify the thread safety. // If we used atomics here, we would introduce new potential synchronisation // points. volatile size_t iterations; volatile size_t count; volatile size_t startSignal; volatile size_t runSignal; volatile size_t endSignal; Args(size_t _iterations, size_t size = 20 * 1000) : queue(size) , iterations(_iterations) , count(0) , startSignal(0) , runSignal(0) , endSignal(0) { } }; void popFrontTester(Args& args) { { LockGuard guard(args.mutex); args.count++; args.startCond.notify_one(); args.runCond.wait(guard, [&args]() { return args.runSignal; }); } for(;;) { Element e = args.queue.popFront(); if(e.stop()) { break; } } } void pushBackTester(Args& args) { { LockGuard guard(args.mutex); args.count++; args.startCond.notify_one(); args.runCond.wait(guard, [&args]() { return args.runSignal; }); } for(size_t i = 0; i < args.iterations; ++i) { Element e{static_cast< double >(i)}; args.queue.pushBack(e); } args.queue.pushBack(Element{0, true}); } void abaThread(char* firstValue, char* lastValue, Queue< char* >& queue, util::Barrier& barrier) { barrier.wait(); for(char* val = firstValue; val <= lastValue; ++val) { queue.pushBack(val); } } struct Exception : public std::exception { }; struct ExceptionTester { static std::atomic< std::thread::id > throwFrom; void test() { if(throwFrom != std::thread::id() && std::this_thread::get_id() == throwFrom) { throw Exception(); } } ExceptionTester() { } ExceptionTester(const ExceptionTester&) { test(); } ExceptionTester& operator=(const ExceptionTester&) { test(); return *this; } }; std::atomic< std::thread::id > ExceptionTester::throwFrom = {std::thread::id()}; void sleepNWait(size_t microseconds, util::Barrier& barrier) { std::this_thread::sleep_for( std::chrono::duration< double, std::micro >(microseconds)); barrier.wait(); } void exceptionProducer(Queue< ExceptionTester >& queue, util::Semaphore& semaphore, std::atomic_size_t& caught) { static constexpr size_t iterations = 3; for(size_t i = 0; i < iterations; ++i) { try { queue.pushBack(ExceptionTester()); } catch(const Exception&) { ++caught; } semaphore.notify(); } } struct MoveTester { bool moved; size_t& moveCounter; size_t value; explicit MoveTester(size_t& counter, size_t val) : moved(false), moveCounter(counter), value(val) { } explicit MoveTester(const MoveTester& rhs) = delete; MoveTester& operator=(const MoveTester& rhs) = delete; MoveTester(MoveTester&& rhs) : moved(false), moveCounter(rhs.moveCounter), value(rhs.value) { rhs.moved = true; moveCounter++; } MoveTester& operator=(MoveTester&& rhs) { value = rhs.value; rhs.moved = true; moveCounter = rhs.moveCounter; moveCounter++; return *this; } }; TEST(TestQueue, single) { ObjQueue queue(1u); ASSERT_EQ(0u, queue.size()); ASSERT_EQ(1u, queue.capacity()); } TEST(TestQueue, breathing) { static constexpr size_t DEFAULT_CAP = 10 * 1000; ObjQueue queue(DEFAULT_CAP); ASSERT_EQ(0u, queue.size()); ASSERT_EQ(DEFAULT_CAP, queue.capacity()); Element e1(1.0); Element e2(2.0); Element e3(3.0); queue.pushBack(e1); queue.pushBack(e2); queue.pushBack(e3); Element p1 = queue.popFront(); Element p2 = queue.popFront(); Element p3 = queue.popFront(); ASSERT_EQ(e1, p1); ASSERT_EQ(e2, p2); ASSERT_EQ(e3, p3); } TEST(TestQueue, singleProducerManyConsumer) { static constexpr size_t iterations = 100 * 1000; static constexpr size_t numThreads = 5; std::array< std::thread, numThreads > threads; Args args{iterations}; LockGuard lock(args.mutex); for(size_t i = 0; i < threads.size(); ++i) { threads[i] = std::thread(std::bind(&popFrontTester, std::ref(args))); args.startCond.wait(lock, [&args, i]() { return args.count == (i + 1); }); } args.runSignal++; args.runCond.notify_all(); lock.unlock(); for(size_t i = 0; i < iterations; ++i) { Element e{static_cast< double >(i)}; args.queue.pushBack(e); } for(size_t i = 0; i < numThreads; ++i) { Element e{0.0, true}; args.queue.pushBack(e); } for(size_t i = 0; i < numThreads; ++i) { threads[i].join(); } ASSERT_EQ(0u, args.queue.size()); } TEST(TestQueue, manyProducerManyConsumer) { static constexpr size_t iterations = 100 * 1000; static constexpr size_t numThreads = 5; std::array< std::thread, numThreads * 2 > threads; Args args{iterations}; LockGuard lock(args.mutex); for(size_t i = 0; i < numThreads; ++i) { threads[i] = std::thread(std::bind(&popFrontTester, std::ref(args))); args.startCond.wait(lock, [&args, i]() { return args.count == (i + 1); }); } for(size_t i = 0; i < numThreads; ++i) { threads[i + numThreads] = std::thread(std::bind(&pushBackTester, std::ref(args))); args.startCond.wait( lock, [&args, i]() { return args.count == (numThreads + i + 1); }); } args.runSignal++; args.runCond.notify_all(); lock.unlock(); for(auto& thread : threads) { thread.join(); } ASSERT_EQ(0u, args.queue.size()); } TEST(TestQueue, ABAEmpty) { // Verify we avoid the ABA problem, where multiple threads try to push an // object to the same "empty" position in the queue. static constexpr size_t numThreads = 50; static constexpr size_t numValues = 6; static constexpr size_t numIterations = 1000; static constexpr size_t numEntries = numThreads * numValues; char block[numEntries]; for(size_t i = 0; i < numIterations; ++i) { util::Barrier barrier{numThreads + 1}; Queue< char* > queue{numEntries + 1}; std::array< std::thread, numThreads + 1 > threads; char* nextValue[numThreads]; char* lastValue[numThreads]; for(size_t j = 0; j < numThreads; ++j) { nextValue[j] = block + (numValues * j); lastValue[j] = block + (numValues * (j + 1)) - 1; threads[j] = std::thread(std::bind(&abaThread, nextValue[j], lastValue[j], std::ref(queue), std::ref(barrier))); } threads[numThreads] = std::thread(std::bind(&sleepNWait, 100, std::ref(barrier))); for(size_t j = 0; j < numEntries; ++j) { char* val = queue.popFront(); size_t k = 0; for(k = 0; k < numThreads; ++k) { if(val == nextValue[k]) { nextValue[k] += (val == lastValue[k] ? 0 : 1); ASSERT_LE(nextValue[k], lastValue[k]); break; } } ASSERT_LT(k, numThreads); } for(auto& thread : threads) { thread.join(); } ASSERT_EQ(0u, queue.size()); } } TEST(TestQueue, generationCount) { // Verify functionality after running through a full cycle (and invoking the // generation rollover logic). // For a queue of size 3, this is currently 508 cycles, implying we need to go // through at least 3048 objects (3 * 508 * 2) to trigger this logic twice. static constexpr size_t numThreads = 6; static constexpr size_t queueSize = 3; static constexpr size_t numEntries = 3060; static constexpr size_t numValues = numEntries / numThreads; char block[numEntries]; util::Barrier barrier{numThreads + 1}; Queue< char* > queue{queueSize}; std::array< std::thread, numThreads + 1 > threads; char* nextValue[numThreads]; char* lastValue[numThreads]; for(size_t j = 0; j < numThreads; ++j) { nextValue[j] = block + (numValues * j); lastValue[j] = block + (numValues * (j + 1)) - 1; threads[j] = std::thread(std::bind(&abaThread, nextValue[j], lastValue[j], std::ref(queue), std::ref(barrier))); } threads[numThreads] = std::thread(std::bind(&sleepNWait, 100, std::ref(barrier))); for(size_t j = 0; j < numEntries; ++j) { char* val = queue.popFront(); size_t k = 0; for(k = 0; k < numThreads; ++k) { if(val == nextValue[k]) { nextValue[k] += (val == lastValue[k] ? 0 : 1); ASSERT_LE(nextValue[k], lastValue[k]); break; } } ASSERT_LT(k, numThreads); } for(auto& thread : threads) { thread.join(); } ASSERT_EQ(0u, queue.size()); } TEST(TestQueue, basicExceptionSafety) { ExceptionTester::throwFrom = std::this_thread::get_id(); Queue< ExceptionTester > queue{1}; ASSERT_THROW(queue.pushBack(ExceptionTester()), Exception); ExceptionTester::throwFrom = std::thread::id(); } TEST(TestQueue, exceptionSafety) { ExceptionTester::throwFrom = std::thread::id(); static constexpr size_t queueSize = 3; Queue< ExceptionTester > queue{queueSize}; ASSERT_EQ(QueueReturn::Success, queue.pushBack(ExceptionTester())); ASSERT_EQ(QueueReturn::Success, queue.pushBack(ExceptionTester())); ASSERT_EQ(QueueReturn::Success, queue.pushBack(ExceptionTester())); ASSERT_NE(QueueReturn::Success, queue.tryPushBack(ExceptionTester())); util::Semaphore semaphore{0}; std::atomic_size_t caught = {0}; std::thread producer(std::bind(&exceptionProducer, std::ref(queue), std::ref(semaphore), std::ref(caught))); ExceptionTester::throwFrom = std::this_thread::get_id(); ASSERT_THROW({ (void)queue.popFront(); }, Exception); // Now the queue is not full, and the producer thread can start adding items. ASSERT_TRUE(semaphore.waitFor(std::chrono::seconds{1})); ASSERT_EQ(queueSize, queue.size()); ASSERT_THROW({ (void)queue.popFront(); }, Exception); // Now the queue is not full, and the producer thread can start adding items. ASSERT_TRUE(semaphore.waitFor(std::chrono::seconds{1})); ASSERT_EQ(queueSize, queue.size()); // Pushing into the queue with exception empties the queue. ExceptionTester::throwFrom = producer.get_id(); // pop an item to unblock the pusher (void)queue.popFront(); ASSERT_TRUE(semaphore.waitFor(std::chrono::seconds{1})); ASSERT_EQ(1u, caught); ASSERT_EQ(0u, queue.size()); ASSERT_TRUE(queue.empty()); // after throwing, the queue works fine. ASSERT_EQ(QueueReturn::Success, queue.pushBack(ExceptionTester())); ASSERT_EQ(QueueReturn::Success, queue.pushBack(ExceptionTester())); ASSERT_EQ(QueueReturn::Success, queue.pushBack(ExceptionTester())); ASSERT_NE(QueueReturn::Success, queue.tryPushBack(ExceptionTester())); ExceptionTester::throwFrom = std::thread::id(); producer.join(); } TEST(TestQueue, moveIt) { static constexpr size_t queueSize = 40; Queue< MoveTester > queue{queueSize}; size_t counter = 0; queue.pushBack(MoveTester{counter, 0}); ASSERT_EQ(1u, counter); MoveTester tester2(counter, 2); queue.pushBack(std::move(tester2)); ASSERT_TRUE(tester2.moved); ASSERT_EQ(2u, counter); ASSERT_EQ(QueueReturn::Success, queue.tryPushBack(MoveTester{counter, 3})); ASSERT_EQ(3u, counter); MoveTester tester4(counter, 4); ASSERT_EQ(QueueReturn::Success, queue.tryPushBack(std::move(tester4))); ASSERT_TRUE(tester4.moved); ASSERT_EQ(4u, counter); MoveTester popped = queue.popFront(); (void)popped; ASSERT_EQ(5u, counter); #if __cplusplus >= 201703L std::optional< MoveTester > #else tl::optional< MoveTester > #endif optPopped = queue.tryPopFront(); ASSERT_TRUE(optPopped.has_value()); // Moved twice here to construct the optional. ASSERT_EQ(6u, counter); }