Move folly/Baton.h to folly/synchronization/
[folly.git] / folly / synchronization / test / BatonBenchmark.cpp
1 /*
2  * Copyright 2017 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/synchronization/Baton.h>
18
19 #include <thread>
20
21 #include <folly/Benchmark.h>
22 #include <folly/portability/GFlags.h>
23 #include <folly/portability/GTest.h>
24 #include <folly/portability/Semaphore.h>
25 #include <folly/synchronization/test/BatonTestHelpers.h>
26 #include <folly/test/DeterministicSchedule.h>
27
28 using namespace folly;
29 using namespace folly::test;
30 using folly::detail::EmulatedFutexAtomic;
31
32 typedef DeterministicSchedule DSched;
33
34 BENCHMARK(baton_pingpong_single_poster_blocking, iters) {
35   run_pingpong_test<std::atomic, true, true>(iters);
36 }
37
38 BENCHMARK(baton_pingpong_multi_poster_blocking, iters) {
39   run_pingpong_test<std::atomic, false, true>(iters);
40 }
41
42 BENCHMARK(baton_pingpong_single_poster_nonblocking, iters) {
43   run_pingpong_test<std::atomic, true, false>(iters);
44 }
45
46 BENCHMARK(baton_pingpong_multi_poster_nonblocking, iters) {
47   run_pingpong_test<std::atomic, false, false>(iters);
48 }
49
50 BENCHMARK_DRAW_LINE()
51
52 BENCHMARK(baton_pingpong_emulated_futex_single_poster_blocking, iters) {
53   run_pingpong_test<EmulatedFutexAtomic, true, true>(iters);
54 }
55
56 BENCHMARK(baton_pingpong_emulated_futex_multi_poster_blocking, iters) {
57   run_pingpong_test<EmulatedFutexAtomic, false, true>(iters);
58 }
59
60 BENCHMARK(baton_pingpong_emulated_futex_single_poster_nonblocking, iters) {
61   run_pingpong_test<EmulatedFutexAtomic, true, false>(iters);
62 }
63
64 BENCHMARK(baton_pingpong_emulated_futex_multi_poster_nonblocking, iters) {
65   run_pingpong_test<EmulatedFutexAtomic, false, false>(iters);
66 }
67
68 BENCHMARK_DRAW_LINE()
69
70 BENCHMARK(posix_sem_pingpong, iters) {
71   sem_t sems[3];
72   sem_t* a = sems + 0;
73   sem_t* b = sems + 2; // to get it on a different cache line
74
75   sem_init(a, 0, 0);
76   sem_init(b, 0, 0);
77   auto thr = std::thread([=] {
78     for (size_t i = 0; i < iters; ++i) {
79       sem_wait(a);
80       sem_post(b);
81     }
82   });
83   for (size_t i = 0; i < iters; ++i) {
84     sem_post(a);
85     sem_wait(b);
86   }
87   thr.join();
88 }
89
90 // I am omitting a benchmark result snapshot because these microbenchmarks
91 // mainly illustrate that PreBlockAttempts is very effective for rapid
92 // handoffs.  The performance of Baton and sem_t is essentially identical
93 // to the required futex calls for the blocking case
94
95 int main(int argc, char** argv) {
96   testing::InitGoogleTest(&argc, argv);
97   gflags::ParseCommandLineFlags(&argc, &argv, true);
98
99   auto rv = RUN_ALL_TESTS();
100   if (!rv && FLAGS_benchmark) {
101     folly::runBenchmarks();
102   }
103   return rv;
104 }