unittests/Support/ThreadPool.cpp

   1 //========- unittests/Support/ThreadPools.cpp - ThreadPools.h tests --========//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #include "llvm/Support/ThreadPool.h"
  11
  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"
  17
  18 #include "gtest/gtest.h"
  19
  20 using namespace llvm;
  21
  22 // Fixture for the unittests, allowing to *temporarily* disable the unittests
  23 // on a particular platform
  24 class ThreadPoolTest : public testing::Test {
  25   Triple Host;
  26   SmallVector<Triple::ArchType, 4> UnsupportedArchs;
  27   SmallVector<Triple::OSType, 4> UnsupportedOSs;
  28   SmallVector<Triple::EnvironmentType, 1> UnsupportedEnvironments;
  29 protected:
  30   // This is intended for platform as a temporary "XFAIL"
  31   bool isUnsupportedOSOrEnvironment() {
  32     Triple Host(Triple::normalize(sys::getProcessTriple()));
  33
  34     if (std::find(UnsupportedEnvironments.begin(), UnsupportedEnvironments.end(),
  35                   Host.getEnvironment()) != UnsupportedEnvironments.end())
  36       return true;
  37
  38     if (std::find(UnsupportedOSs.begin(), UnsupportedOSs.end(), Host.getOS())
  39         != UnsupportedOSs.end())
  40       return true;
  41
  42     if (std::find(UnsupportedArchs.begin(), UnsupportedArchs.end(), Host.getArch())
  43         != UnsupportedArchs.end())
  44       return true;
  45
  46     return false;
  47   }
  48
  49   ThreadPoolTest() {
  50     // Add unsupported configuration here, example:
  51     //   UnsupportedArchs.push_back(Triple::x86_64);
  52
  53     // See https://llvm.org/bugs/show_bug.cgi?id=25829
  54     UnsupportedArchs.push_back(Triple::ppc64le);
  55     UnsupportedArchs.push_back(Triple::ppc64);
  56   }
  57
  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; });
  62   }
  63
  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();
  69   }
  70
  71   std::condition_variable WaitMainThread;
  72   std::mutex WaitMainThreadMutex;
  73   bool MainThreadReady;
  74
  75 };
  76
  77 #define CHECK_UNSUPPORTED() \
  78   do { \
  79     if (isUnsupportedOSOrEnvironment()) \
  80       return; \
  81   } while (0); \
  82
  83 TEST_F(ThreadPoolTest, AsyncBarrier) {
  84   CHECK_UNSUPPORTED();
  85   // test that async & barrier work together properly.
  86
  87   std::atomic_int checked_in{0};
  88
  89   setMainThreadReadyState(false);
  90   ThreadPool Pool;
  91   for (size_t i = 0; i < 5; ++i) {
  92     Pool.async([this, &checked_in, i] {
  93       waitForMainThread();
  94       ++checked_in;
  95     });
  96   }
  97   ASSERT_EQ(0, checked_in);
  98   setMainThreadReadyState(true);
  99   Pool.wait();
 100   ASSERT_EQ(5, checked_in);
 101 }
 102
 103 static void TestFunc(std::atomic_int &checked_in, int i) { checked_in += i; }
 104
 105 TEST_F(ThreadPoolTest, AsyncBarrierArgs) {
 106   CHECK_UNSUPPORTED();
 107   // Test that async works with a function requiring multiple parameters.
 108   std::atomic_int checked_in{0};
 109
 110   ThreadPool Pool;
 111   for (size_t i = 0; i < 5; ++i) {
 112     Pool.async(TestFunc, std::ref(checked_in), i);
 113   }
 114   Pool.wait();
 115   ASSERT_EQ(10, checked_in);
 116 }
 117
 118 TEST_F(ThreadPoolTest, Async) {
 119   CHECK_UNSUPPORTED();
 120   ThreadPool Pool;
 121   std::atomic_int i{0};
 122   setMainThreadReadyState(false);
 123   Pool.async([this, &i] {
 124     waitForMainThread();
 125     ++i;
 126   });
 127   Pool.async([&i] { ++i; });
 128   ASSERT_NE(2, i.load());
 129   setMainThreadReadyState(true);
 130   Pool.wait();
 131   ASSERT_EQ(2, i.load());
 132 }
 133
 134 TEST_F(ThreadPoolTest, GetFuture) {
 135   CHECK_UNSUPPORTED();
 136   ThreadPool Pool;
 137   std::atomic_int i{0};
 138   setMainThreadReadyState(false);
 139   Pool.async([this, &i] {
 140     waitForMainThread();
 141     ++i;
 142   });
 143   // Force the future using get()
 144   Pool.async([&i] { ++i; }).get();
 145   ASSERT_NE(2, i.load());
 146   setMainThreadReadyState(true);
 147   Pool.wait();
 148   ASSERT_EQ(2, i.load());
 149 }
 150
 151 TEST_F(ThreadPoolTest, PoolDestruction) {
 152   CHECK_UNSUPPORTED();
 153   // Test that we are waiting on destruction
 154   std::atomic_int checked_in{0};
 155   {
 156     setMainThreadReadyState(false);
 157     ThreadPool Pool;
 158     for (size_t i = 0; i < 5; ++i) {
 159       Pool.async([this, &checked_in, i] {
 160         waitForMainThread();
 161         ++checked_in;
 162       });
 163     }
 164     ASSERT_EQ(0, checked_in);
 165     setMainThreadReadyState(true);
 166   }
 167   ASSERT_EQ(5, checked_in);
 168 }