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 setMainThreadReady() {
67 std::unique_lock<std::mutex> LockGuard(WaitMainThreadMutex);
68 MainThreadReady = true;
70 WaitMainThread.notify_all();
73 void SetUp() override { MainThreadReady = false; }
75 std::condition_variable WaitMainThread;
76 std::mutex WaitMainThreadMutex;
81 #define CHECK_UNSUPPORTED() \
83 if (isUnsupportedOSOrEnvironment()) \
87 TEST_F(ThreadPoolTest, AsyncBarrier) {
89 // test that async & barrier work together properly.
91 std::atomic_int checked_in{0};
94 for (size_t i = 0; i < 5; ++i) {
95 Pool.async([this, &checked_in, i] {
100 ASSERT_EQ(0, checked_in);
101 setMainThreadReady();
103 ASSERT_EQ(5, checked_in);
106 static void TestFunc(std::atomic_int &checked_in, int i) { checked_in += i; }
108 TEST_F(ThreadPoolTest, AsyncBarrierArgs) {
110 // Test that async works with a function requiring multiple parameters.
111 std::atomic_int checked_in{0};
114 for (size_t i = 0; i < 5; ++i) {
115 Pool.async(TestFunc, std::ref(checked_in), i);
118 ASSERT_EQ(10, checked_in);
121 TEST_F(ThreadPoolTest, Async) {
124 std::atomic_int i{0};
125 Pool.async([this, &i] {
129 Pool.async([&i] { ++i; });
130 ASSERT_NE(2, i.load());
131 setMainThreadReady();
133 ASSERT_EQ(2, i.load());
136 TEST_F(ThreadPoolTest, GetFuture) {
139 std::atomic_int i{0};
140 Pool.async([this, &i] {
144 // Force the future using get()
145 Pool.async([&i] { ++i; }).get();
146 ASSERT_NE(2, i.load());
147 setMainThreadReady();
149 ASSERT_EQ(2, i.load());
152 TEST_F(ThreadPoolTest, PoolDestruction) {
154 // Test that we are waiting on destruction
155 std::atomic_int checked_in{0};
158 for (size_t i = 0; i < 5; ++i) {
159 Pool.async([this, &checked_in, i] {
164 ASSERT_EQ(0, checked_in);
165 setMainThreadReady();
167 ASSERT_EQ(5, checked_in);