1 //========- unittests/Support/ThreadPools.cpp - ThreadPools.h tests --========//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "llvm/Support/ThreadPool.h"
12 #include "llvm/ADT/STLExtras.h"
13 #include "llvm/ADT/SmallVector.h"
14 #include "llvm/ADT/Triple.h"
15 #include "llvm/Support/Host.h"
16 #include "llvm/Support/TargetSelect.h"
18 #include "gtest/gtest.h"
22 // Fixture for the unittests, allowing to *temporarily* disable the unittests
23 // on a particular platform
24 class ThreadPoolTest : public testing::Test {
26 SmallVector<Triple::ArchType, 4> UnsupportedArchs;
27 SmallVector<Triple::OSType, 4> UnsupportedOSs;
28 SmallVector<Triple::EnvironmentType, 1> UnsupportedEnvironments;
30 // This is intended for platform as a temporary "XFAIL"
31 bool isUnsupportedOSOrEnvironment() {
32 Triple Host(Triple::normalize(sys::getProcessTriple()));
34 if (std::find(UnsupportedEnvironments.begin(), UnsupportedEnvironments.end(),
35 Host.getEnvironment()) != UnsupportedEnvironments.end())
38 if (std::find(UnsupportedOSs.begin(), UnsupportedOSs.end(), Host.getOS())
39 != UnsupportedOSs.end())
42 if (std::find(UnsupportedArchs.begin(), UnsupportedArchs.end(), Host.getArch())
43 != UnsupportedArchs.end())
50 // Add unsupported configuration here, example:
51 // UnsupportedArchs.push_back(Triple::x86_64);
53 // See https://llvm.org/bugs/show_bug.cgi?id=25829
54 UnsupportedArchs.push_back(Triple::ppc64le);
55 UnsupportedArchs.push_back(Triple::ppc64);
58 /// Make sure this thread not progress faster than the main thread.
59 void waitForMainThread() {
60 std::unique_lock<std::mutex> LockGuard(WaitMainThreadMutex);
61 WaitMainThread.wait(LockGuard, [&] { return MainThreadReady; });
64 /// Set the readiness of the main thread.
65 void setMainThreadReadyState(bool Ready) {
66 std::unique_lock<std::mutex> LockGuard(WaitMainThreadMutex);
67 MainThreadReady = Ready;
68 WaitMainThread.notify_all();
71 std::condition_variable WaitMainThread;
72 std::mutex WaitMainThreadMutex;
77 #define CHECK_UNSUPPORTED() \
79 if (isUnsupportedOSOrEnvironment()) \
83 TEST_F(ThreadPoolTest, AsyncBarrier) {
85 // test that async & barrier work together properly.
87 std::atomic_int checked_in{0};
89 setMainThreadReadyState(false);
91 for (size_t i = 0; i < 5; ++i) {
92 Pool.async([this, &checked_in, i] {
97 ASSERT_EQ(0, checked_in);
98 setMainThreadReadyState(true);
100 ASSERT_EQ(5, checked_in);
103 static void TestFunc(std::atomic_int &checked_in, int i) { checked_in += i; }
105 TEST_F(ThreadPoolTest, AsyncBarrierArgs) {
107 // Test that async works with a function requiring multiple parameters.
108 std::atomic_int checked_in{0};
111 for (size_t i = 0; i < 5; ++i) {
112 Pool.async(TestFunc, std::ref(checked_in), i);
115 ASSERT_EQ(10, checked_in);
118 TEST_F(ThreadPoolTest, Async) {
121 std::atomic_int i{0};
122 setMainThreadReadyState(false);
123 Pool.async([this, &i] {
127 Pool.async([&i] { ++i; });
128 ASSERT_NE(2, i.load());
129 setMainThreadReadyState(true);
131 ASSERT_EQ(2, i.load());
134 TEST_F(ThreadPoolTest, GetFuture) {
137 std::atomic_int i{0};
138 setMainThreadReadyState(false);
139 Pool.async([this, &i] {
143 // Force the future using get()
144 Pool.async([&i] { ++i; }).get();
145 ASSERT_NE(2, i.load());
146 setMainThreadReadyState(true);
148 ASSERT_EQ(2, i.load());
151 TEST_F(ThreadPoolTest, PoolDestruction) {
153 // Test that we are waiting on destruction
154 std::atomic_int checked_in{0};
156 setMainThreadReadyState(false);
158 for (size_t i = 0; i < 5; ++i) {
159 Pool.async([this, &checked_in, i] {
164 ASSERT_EQ(0, checked_in);
165 setMainThreadReadyState(true);
167 ASSERT_EQ(5, checked_in);