folly/test/DeterministicScheduleTest.cpp

   1 /*
   2  * Copyright 2016 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/test/DeterministicSchedule.h>
  18
  19 #include <gtest/gtest.h>
  20
  21 #include <folly/portability/GFlags.h>
  22
  23 using namespace folly::test;
  24
  25 TEST(DeterministicSchedule, uniform) {
  26   auto p = DeterministicSchedule::uniform(0);
  27   int buckets[10] = {};
  28   for (int i = 0; i < 100000; ++i) {
  29     buckets[p(10)]++;
  30   }
  31   for (int i = 0; i < 10; ++i) {
  32     EXPECT_TRUE(buckets[i] > 9000);
  33   }
  34 }
  35
  36 TEST(DeterministicSchedule, uniformSubset) {
  37   auto ps = DeterministicSchedule::uniformSubset(0, 3, 100);
  38   int buckets[10] = {};
  39   std::set<int> seen;
  40   for (int i = 0; i < 100000; ++i) {
  41     if (i > 0 && (i % 100) == 0) {
  42       EXPECT_EQ(seen.size(), 3);
  43       seen.clear();
  44     }
  45     int x = ps(10);
  46     seen.insert(x);
  47     EXPECT_TRUE(seen.size() <= 3);
  48     buckets[x]++;
  49   }
  50   for (int i = 0; i < 10; ++i) {
  51     EXPECT_TRUE(buckets[i] > 9000);
  52   }
  53 }
  54
  55 TEST(DeterministicSchedule, buggyAdd) {
  56   for (bool bug : {false, true}) {
  57     DeterministicSchedule sched(DeterministicSchedule::uniform(0));
  58     if (bug) {
  59       FOLLY_TEST_DSCHED_VLOG("Test with race condition");
  60     } else {
  61       FOLLY_TEST_DSCHED_VLOG("Test without race condition");
  62     }
  63     DeterministicMutex m;
  64     // The use of DeterinisticAtomic is not needed here, but it makes
  65     // it easier to understand the sequence of events in logs.
  66     DeterministicAtomic<int> test{0};
  67     DeterministicAtomic<int> baseline{0};
  68     int numThreads = 10;
  69     std::vector<std::thread> threads(numThreads);
  70     for (int t = 0; t < numThreads; ++t) {
  71       threads[t] = DeterministicSchedule::thread([&, t] {
  72         baseline.fetch_add(1);
  73         // Atomic increment of test protected by mutex m
  74         do {
  75           // Some threads use lock() others use try_lock()
  76           if ((t & 1) == 0) {
  77             m.lock();
  78           } else {
  79             if (!m.try_lock()) {
  80               continue;
  81             }
  82           }
  83           int newval = test.load() + 1;
  84           if (bug) {
  85             // Break the atomicity of the increment operation
  86             m.unlock();
  87             m.lock();
  88           }
  89           test.store(newval);
  90           m.unlock();
  91           break;
  92         } while (true);
  93       }); // thread lambda
  94     } // for t
  95     for (auto& t : threads) {
  96       DeterministicSchedule::join(t);
  97     }
  98     if (!bug) {
  99       EXPECT_EQ(test.load(), baseline.load());
 100     } else {
 101       if (test.load() == baseline.load()) {
 102         FOLLY_TEST_DSCHED_VLOG("Didn't catch the bug");
 103       } else {
 104         FOLLY_TEST_DSCHED_VLOG("Caught the bug");
 105       }
 106     }
 107   } // for bug
 108 } // TEST
 109
 110 int main(int argc, char** argv) {
 111   testing::InitGoogleTest(&argc, argv);
 112   gflags::ParseCommandLineFlags(&argc, &argv, true);
 113   return RUN_ALL_TESTS();
 114 }