folly/test/BatonTest.cpp

   1 /*
   2  * Copyright 2014 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <folly/Baton.h>
  18 #include <folly/test/DeterministicSchedule.h>
  19 #include <thread>
  20 #include <semaphore.h>
  21 #include <gflags/gflags.h>
  22 #include <gtest/gtest.h>
  23 #include <folly/Benchmark.h>
  24
  25 using namespace folly;
  26 using namespace folly::test;
  27
  28 typedef DeterministicSchedule DSched;
  29
  30 TEST(Baton, basic) {
  31   Baton<> b;
  32   b.post();
  33   b.wait();
  34 }
  35
  36 template <template<typename> class Atom>
  37 void run_pingpong_test(int numRounds) {
  38   Baton<Atom> batons[17];
  39   Baton<Atom>& a = batons[0];
  40   Baton<Atom>& b = batons[16]; // to get it on a different cache line
  41   auto thr = DSched::thread([&]{
  42     for (int i = 0; i < numRounds; ++i) {
  43       a.wait();
  44       a.reset();
  45       b.post();
  46     }
  47   });
  48   for (int i = 0; i < numRounds; ++i) {
  49     a.post();
  50     b.wait();
  51     b.reset();
  52   }
  53   DSched::join(thr);
  54 }
  55
  56 TEST(Baton, pingpong) {
  57   DSched sched(DSched::uniform(0));
  58
  59   run_pingpong_test<DeterministicAtomic>(1000);
  60 }
  61
  62 BENCHMARK(baton_pingpong, iters) {
  63   run_pingpong_test<std::atomic>(iters);
  64 }
  65
  66 BENCHMARK(posix_sem_pingpong, iters) {
  67   sem_t sems[3];
  68   sem_t* a = sems + 0;
  69   sem_t* b = sems + 2; // to get it on a different cache line
  70
  71   sem_init(a, 0, 0);
  72   sem_init(b, 0, 0);
  73   auto thr = std::thread([=]{
  74     for (int i = 0; i < iters; ++i) {
  75       sem_wait(a);
  76       sem_post(b);
  77     }
  78   });
  79   for (int i = 0; i < iters; ++i) {
  80     sem_post(a);
  81     sem_wait(b);
  82   }
  83   thr.join();
  84 }
  85
  86 // I am omitting a benchmark result snapshot because these microbenchmarks
  87 // mainly illustrate that PreBlockAttempts is very effective for rapid
  88 // handoffs.  The performance of Baton and sem_t is essentially identical
  89 // to the required futex calls for the blocking case
  90
  91 int main(int argc, char** argv) {
  92   testing::InitGoogleTest(&argc, argv);
  93   google::ParseCommandLineFlags(&argc, &argv, true);
  94
  95   auto rv = RUN_ALL_TESTS();
  96   if (!rv && FLAGS_benchmark) {
  97     folly::runBenchmarks();
  98   }
  99   return rv;
 100 }