folly/Benchmark.h

   1 /*
   2  * Copyright 2015 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 #ifndef FOLLY_BENCHMARK_H_
  18 #define FOLLY_BENCHMARK_H_
  19
  20 #include <folly/ScopeGuard.h>
  21 #include <folly/Portability.h>
  22 #include <folly/Preprocessor.h> // for FB_ANONYMOUS_VARIABLE
  23 #include <cassert>
  24 #include <ctime>
  25 #include <boost/function_types/function_arity.hpp>
  26 #include <functional>
  27 #include <glog/logging.h>
  28 #include <gflags/gflags.h>
  29 #include <limits>
  30 #include <type_traits>
  31
  32 DECLARE_bool(benchmark);
  33
  34 namespace folly {
  35
  36 /**
  37  * Runs all benchmarks defined. Usually put in main().
  38  */
  39 void runBenchmarks();
  40
  41 /**
  42  * Runs all benchmarks defined if and only if the --benchmark flag has
  43  * been passed to the program. Usually put in main().
  44  */
  45 inline bool runBenchmarksOnFlag() {
  46   if (FLAGS_benchmark) {
  47     runBenchmarks();
  48   }
  49   return FLAGS_benchmark;
  50 }
  51
  52 namespace detail {
  53
  54 /**
  55  * This is the clock ID used for measuring time. On older kernels, the
  56  * resolution of this clock will be very coarse, which will cause the
  57  * benchmarks to fail.
  58  */
  59 enum Clock { DEFAULT_CLOCK_ID = CLOCK_REALTIME };
  60
  61 typedef std::pair<uint64_t, unsigned int> TimeIterPair;
  62
  63 /**
  64  * Adds a benchmark wrapped in a std::function. Only used
  65  * internally. Pass by value is intentional.
  66  */
  67 void addBenchmarkImpl(const char* file,
  68                       const char* name,
  69                       std::function<TimeIterPair(unsigned int)>);
  70
  71 /**
  72  * Takes the difference between two timespec values. end is assumed to
  73  * occur after start.
  74  */
  75 inline uint64_t timespecDiff(timespec end, timespec start) {
  76   if (end.tv_sec == start.tv_sec) {
  77     assert(end.tv_nsec >= start.tv_nsec);
  78     return end.tv_nsec - start.tv_nsec;
  79   }
  80   assert(end.tv_sec > start.tv_sec);
  81   auto diff = uint64_t(end.tv_sec - start.tv_sec);
  82   assert(diff <
  83          std::numeric_limits<uint64_t>::max() / 1000000000UL);
  84   return diff * 1000000000UL
  85     + end.tv_nsec - start.tv_nsec;
  86 }
  87
  88 /**
  89  * Takes the difference between two sets of timespec values. The first
  90  * two come from a high-resolution clock whereas the other two come
  91  * from a low-resolution clock. The crux of the matter is that
  92  * high-res values may be bogus as documented in
  93  * http://linux.die.net/man/3/clock_gettime. The trouble is when the
  94  * running process migrates from one CPU to another, which is more
  95  * likely for long-running processes. Therefore we watch for high
  96  * differences between the two timings.
  97  *
  98  * This function is subject to further improvements.
  99  */
 100 inline uint64_t timespecDiff(timespec end, timespec start,
 101                              timespec endCoarse, timespec startCoarse) {
 102   auto fine = timespecDiff(end, start);
 103   auto coarse = timespecDiff(endCoarse, startCoarse);
 104   if (coarse - fine >= 1000000) {
 105     // The fine time is in all likelihood bogus
 106     return coarse;
 107   }
 108   return fine;
 109 }
 110
 111 } // namespace detail
 112
 113 /**
 114  * Supporting type for BENCHMARK_SUSPEND defined below.
 115  */
 116 struct BenchmarkSuspender {
 117   BenchmarkSuspender() {
 118     CHECK_EQ(0, clock_gettime(detail::DEFAULT_CLOCK_ID, &start));
 119   }
 120
 121   BenchmarkSuspender(const BenchmarkSuspender &) = delete;
 122   BenchmarkSuspender(BenchmarkSuspender && rhs) noexcept {
 123     start = rhs.start;
 124     rhs.start.tv_nsec = rhs.start.tv_sec = 0;
 125   }
 126
 127   BenchmarkSuspender& operator=(const BenchmarkSuspender &) = delete;
 128   BenchmarkSuspender& operator=(BenchmarkSuspender && rhs) {
 129     if (start.tv_nsec > 0 || start.tv_sec > 0) {
 130       tally();
 131     }
 132     start = rhs.start;
 133     rhs.start.tv_nsec = rhs.start.tv_sec = 0;
 134     return *this;
 135   }
 136
 137   ~BenchmarkSuspender() {
 138     if (start.tv_nsec > 0 || start.tv_sec > 0) {
 139       tally();
 140     }
 141   }
 142
 143   void dismiss() {
 144     assert(start.tv_nsec > 0 || start.tv_sec > 0);
 145     tally();
 146     start.tv_nsec = start.tv_sec = 0;
 147   }
 148
 149   void rehire() {
 150     assert(start.tv_nsec == 0 || start.tv_sec == 0);
 151     CHECK_EQ(0, clock_gettime(detail::DEFAULT_CLOCK_ID, &start));
 152   }
 153
 154   template <class F>
 155   auto dismissing(F f) -> typename std::result_of<F()>::type {
 156     SCOPE_EXIT { rehire(); };
 157     dismiss();
 158     return f();
 159   }
 160
 161   /**
 162    * This is for use inside of if-conditions, used in BENCHMARK macros.
 163    * If-conditions bypass the explicit on operator bool.
 164    */
 165   explicit operator bool() const {
 166     return false;
 167   }
 168
 169   /**
 170    * Accumulates nanoseconds spent outside benchmark.
 171    */
 172   typedef uint64_t NanosecondsSpent;
 173   static NanosecondsSpent nsSpent;
 174
 175 private:
 176   void tally() {
 177     timespec end;
 178     CHECK_EQ(0, clock_gettime(detail::DEFAULT_CLOCK_ID, &end));
 179     nsSpent += detail::timespecDiff(end, start);
 180     start = end;
 181   }
 182
 183   timespec start;
 184 };
 185
 186 /**
 187  * Adds a benchmark. Usually not called directly but instead through
 188  * the macro BENCHMARK defined below. The lambda function involved
 189  * must take exactly one parameter of type unsigned, and the benchmark
 190  * uses it with counter semantics (iteration occurs inside the
 191  * function).
 192  */
 193 template <typename Lambda>
 194 typename std::enable_if<
 195   boost::function_types::function_arity<decltype(&Lambda::operator())>::value
 196   == 2
 197 >::type
 198 addBenchmark(const char* file, const char* name, Lambda&& lambda) {
 199   auto execute = [=](unsigned int times) {
 200     BenchmarkSuspender::nsSpent = 0;
 201     timespec start, end;
 202     unsigned int niter;
 203
 204     // CORE MEASUREMENT STARTS
 205     auto const r1 = clock_gettime(detail::DEFAULT_CLOCK_ID, &start);
 206     niter = lambda(times);
 207     auto const r2 = clock_gettime(detail::DEFAULT_CLOCK_ID, &end);
 208     // CORE MEASUREMENT ENDS
 209
 210     CHECK_EQ(0, r1);
 211     CHECK_EQ(0, r2);
 212
 213     return detail::TimeIterPair(
 214       detail::timespecDiff(end, start) - BenchmarkSuspender::nsSpent,
 215       niter);
 216   };
 217
 218   detail::addBenchmarkImpl(file, name,
 219     std::function<detail::TimeIterPair(unsigned int)>(execute));
 220 }
 221
 222 /**
 223  * Adds a benchmark. Usually not called directly but instead through
 224  * the macro BENCHMARK defined below. The lambda function involved
 225  * must take zero parameters, and the benchmark calls it repeatedly
 226  * (iteration occurs outside the function).
 227  */
 228 template <typename Lambda>
 229 typename std::enable_if<
 230   boost::function_types::function_arity<decltype(&Lambda::operator())>::value
 231   == 1
 232 >::type
 233 addBenchmark(const char* file, const char* name, Lambda&& lambda) {
 234   addBenchmark(file, name, [=](unsigned int times) {
 235       unsigned int niter = 0;
 236       while (times-- > 0) {
 237         niter += lambda();
 238       }
 239       return niter;
 240     });
 241 }
 242
 243 /**
 244  * Call doNotOptimizeAway(var) against variables that you use for
 245  * benchmarking but otherwise are useless. The compiler tends to do a
 246  * good job at eliminating unused variables, and this function fools
 247  * it into thinking var is in fact needed.
 248  */
 249 #ifdef _MSC_VER
 250
 251 #pragma optimize("", off)
 252
 253 template <class T>
 254 void doNotOptimizeAway(T&& datum) {
 255   datum = datum;
 256 }
 257
 258 #pragma optimize("", on)
 259
 260 #else
 261 template <class T>
 262 void doNotOptimizeAway(T&& datum) {
 263   asm volatile("" : "+r" (datum));
 264 }
 265 #endif
 266
 267 } // namespace folly
 268
 269 /**
 270  * Introduces a benchmark function. Used internally, see BENCHMARK and
 271  * friends below.
 272  */
 273 #define BENCHMARK_IMPL(funName, stringName, rv, paramType, paramName)   \
 274   static void funName(paramType);                                       \
 275   static bool FB_ANONYMOUS_VARIABLE(follyBenchmarkUnused) = (           \
 276     ::folly::addBenchmark(__FILE__, stringName,                         \
 277       [](paramType paramName) -> unsigned { funName(paramName);         \
 278                                             return rv; }),              \
 279     true);                                                              \
 280   static void funName(paramType paramName)
 281
 282 /**
 283  * Introduces a benchmark function with support for returning the actual
 284  * number of iterations. Used internally, see BENCHMARK_MULTI and friends
 285  * below.
 286  */
 287 #define BENCHMARK_MULTI_IMPL(funName, stringName, paramType, paramName) \
 288   static unsigned funName(paramType);                                   \
 289   static bool FB_ANONYMOUS_VARIABLE(follyBenchmarkUnused) = (           \
 290     ::folly::addBenchmark(__FILE__, stringName,                         \
 291       [](paramType paramName) { return funName(paramName); }),          \
 292     true);                                                              \
 293   static unsigned funName(paramType paramName)
 294
 295 /**
 296  * Introduces a benchmark function. Use with either one or two arguments.
 297  * The first is the name of the benchmark. Use something descriptive, such
 298  * as insertVectorBegin. The second argument may be missing, or could be a
 299  * symbolic counter. The counter dictates how many internal iteration the
 300  * benchmark does. Example:
 301  *
 302  * BENCHMARK(vectorPushBack) {
 303  *   vector<int> v;
 304  *   v.push_back(42);
 305  * }
 306  *
 307  * BENCHMARK(insertVectorBegin, n) {
 308  *   vector<int> v;
 309  *   FOR_EACH_RANGE (i, 0, n) {
 310  *     v.insert(v.begin(), 42);
 311  *   }
 312  * }
 313  */
 314 #define BENCHMARK(name, ...)                                    \
 315   BENCHMARK_IMPL(                                               \
 316     name,                                                       \
 317     FB_STRINGIZE(name),                                         \
 318     FB_ARG_2_OR_1(1, ## __VA_ARGS__),                           \
 319     FB_ONE_OR_NONE(unsigned, ## __VA_ARGS__),                   \
 320     __VA_ARGS__)
 321
 322 /**
 323  * Like BENCHMARK above, but allows the user to return the actual
 324  * number of iterations executed in the function body. This can be
 325  * useful if the benchmark function doesn't know upfront how many
 326  * iterations it's going to run or if it runs through a certain
 327  * number of test cases, e.g.:
 328  *
 329  * BENCHMARK_MULTI(benchmarkSomething) {
 330  *   std::vector<int> testCases { 0, 1, 1, 2, 3, 5 };
 331  *   for (int c : testCases) {
 332  *     doSomething(c);
 333  *   }
 334  *   return testCases.size();
 335  * }
 336  */
 337 #define BENCHMARK_MULTI(name, ...)                              \
 338   BENCHMARK_MULTI_IMPL(                                         \
 339     name,                                                       \
 340     FB_STRINGIZE(name),                                         \
 341     FB_ONE_OR_NONE(unsigned, ## __VA_ARGS__),                   \
 342     __VA_ARGS__)
 343
 344 /**
 345  * Defines a benchmark that passes a parameter to another one. This is
 346  * common for benchmarks that need a "problem size" in addition to
 347  * "number of iterations". Consider:
 348  *
 349  * void pushBack(uint n, size_t initialSize) {
 350  *   vector<int> v;
 351  *   BENCHMARK_SUSPEND {
 352  *     v.resize(initialSize);
 353  *   }
 354  *   FOR_EACH_RANGE (i, 0, n) {
 355  *    v.push_back(i);
 356  *   }
 357  * }
 358  * BENCHMARK_PARAM(pushBack, 0)
 359  * BENCHMARK_PARAM(pushBack, 1000)
 360  * BENCHMARK_PARAM(pushBack, 1000000)
 361  *
 362  * The benchmark above estimates the speed of push_back at different
 363  * initial sizes of the vector. The framework will pass 0, 1000, and
 364  * 1000000 for initialSize, and the iteration count for n.
 365  */
 366 #define BENCHMARK_PARAM(name, param)                                    \
 367   BENCHMARK_NAMED_PARAM(name, param, param)
 368
 369 /**
 370  * Same as BENCHMARK_PARAM, but allows to return the actual number of
 371  * iterations that have been run.
 372  */
 373 #define BENCHMARK_PARAM_MULTI(name, param)                              \
 374   BENCHMARK_NAMED_PARAM_MULTI(name, param, param)
 375
 376 /*
 377  * Like BENCHMARK_PARAM(), but allows a custom name to be specified for each
 378  * parameter, rather than using the parameter value.
 379  *
 380  * Useful when the parameter value is not a valid token for string pasting,
 381  * of when you want to specify multiple parameter arguments.
 382  *
 383  * For example:
 384  *
 385  * void addValue(uint n, int64_t bucketSize, int64_t min, int64_t max) {
 386  *   Histogram<int64_t> hist(bucketSize, min, max);
 387  *   int64_t num = min;
 388  *   FOR_EACH_RANGE (i, 0, n) {
 389  *     hist.addValue(num);
 390  *     ++num;
 391  *     if (num > max) { num = min; }
 392  *   }
 393  * }
 394  *
 395  * BENCHMARK_NAMED_PARAM(addValue, 0_to_100, 1, 0, 100)
 396  * BENCHMARK_NAMED_PARAM(addValue, 0_to_1000, 10, 0, 1000)
 397  * BENCHMARK_NAMED_PARAM(addValue, 5k_to_20k, 250, 5000, 20000)
 398  */
 399 #define BENCHMARK_NAMED_PARAM(name, param_name, ...)                    \
 400   BENCHMARK_IMPL(                                                       \
 401       FB_CONCATENATE(name, FB_CONCATENATE(_, param_name)),              \
 402       FB_STRINGIZE(name) "(" FB_STRINGIZE(param_name) ")",              \
 403       iters,                                                            \
 404       unsigned,                                                         \
 405       iters) {                                                          \
 406     name(iters, ## __VA_ARGS__);                                        \
 407   }
 408
 409 /**
 410  * Same as BENCHMARK_NAMED_PARAM, but allows to return the actual number
 411  * of iterations that have been run.
 412  */
 413 #define BENCHMARK_NAMED_PARAM_MULTI(name, param_name, ...)              \
 414   BENCHMARK_MULTI_IMPL(                                                 \
 415       FB_CONCATENATE(name, FB_CONCATENATE(_, param_name)),              \
 416       FB_STRINGIZE(name) "(" FB_STRINGIZE(param_name) ")",              \
 417       unsigned,                                                         \
 418       iters) {                                                          \
 419     return name(iters, ## __VA_ARGS__);                                 \
 420   }
 421
 422 /**
 423  * Just like BENCHMARK, but prints the time relative to a
 424  * baseline. The baseline is the most recent BENCHMARK() seen in
 425  * lexical order. Example:
 426  *
 427  * // This is the baseline
 428  * BENCHMARK(insertVectorBegin, n) {
 429  *   vector<int> v;
 430  *   FOR_EACH_RANGE (i, 0, n) {
 431  *     v.insert(v.begin(), 42);
 432  *   }
 433  * }
 434  *
 435  * BENCHMARK_RELATIVE(insertListBegin, n) {
 436  *   list<int> s;
 437  *   FOR_EACH_RANGE (i, 0, n) {
 438  *     s.insert(s.begin(), 42);
 439  *   }
 440  * }
 441  *
 442  * Any number of relative benchmark can be associated with a
 443  * baseline. Another BENCHMARK() occurrence effectively establishes a
 444  * new baseline.
 445  */
 446 #define BENCHMARK_RELATIVE(name, ...)                           \
 447   BENCHMARK_IMPL(                                               \
 448     name,                                                       \
 449     "%" FB_STRINGIZE(name),                                     \
 450     FB_ARG_2_OR_1(1, ## __VA_ARGS__),                           \
 451     FB_ONE_OR_NONE(unsigned, ## __VA_ARGS__),                   \
 452     __VA_ARGS__)
 453
 454 /**
 455  * Same as BENCHMARK_RELATIVE, but allows to return the actual number
 456  * of iterations that have been run.
 457  */
 458 #define BENCHMARK_RELATIVE_MULTI(name, ...)                     \
 459   BENCHMARK_MULTI_IMPL(                                         \
 460     name,                                                       \
 461     "%" FB_STRINGIZE(name),                                     \
 462     FB_ONE_OR_NONE(unsigned, ## __VA_ARGS__),                   \
 463     __VA_ARGS__)
 464
 465 /**
 466  * A combination of BENCHMARK_RELATIVE and BENCHMARK_PARAM.
 467  */
 468 #define BENCHMARK_RELATIVE_PARAM(name, param)                           \
 469   BENCHMARK_RELATIVE_NAMED_PARAM(name, param, param)
 470
 471 /**
 472  * Same as BENCHMARK_RELATIVE_PARAM, but allows to return the actual
 473  * number of iterations that have been run.
 474  */
 475 #define BENCHMARK_RELATIVE_PARAM_MULTI(name, param)                     \
 476   BENCHMARK_RELATIVE_NAMED_PARAM_MULTI(name, param, param)
 477
 478 /**
 479  * A combination of BENCHMARK_RELATIVE and BENCHMARK_NAMED_PARAM.
 480  */
 481 #define BENCHMARK_RELATIVE_NAMED_PARAM(name, param_name, ...)           \
 482   BENCHMARK_IMPL(                                                       \
 483       FB_CONCATENATE(name, FB_CONCATENATE(_, param_name)),              \
 484       "%" FB_STRINGIZE(name) "(" FB_STRINGIZE(param_name) ")",          \
 485       iters,                                                            \
 486       unsigned,                                                         \
 487       iters) {                                                          \
 488     name(iters, ## __VA_ARGS__);                                        \
 489   }
 490
 491 /**
 492  * Same as BENCHMARK_RELATIVE_NAMED_PARAM, but allows to return the
 493  * actual number of iterations that have been run.
 494  */
 495 #define BENCHMARK_RELATIVE_NAMED_PARAM_MULTI(name, param_name, ...)     \
 496   BENCHMARK_MULTI_IMPL(                                                 \
 497       FB_CONCATENATE(name, FB_CONCATENATE(_, param_name)),              \
 498       "%" FB_STRINGIZE(name) "(" FB_STRINGIZE(param_name) ")",          \
 499       unsigned,                                                         \
 500       iters) {                                                          \
 501     return name(iters, ## __VA_ARGS__);                                 \
 502   }
 503
 504 /**
 505  * Draws a line of dashes.
 506  */
 507 #define BENCHMARK_DRAW_LINE()                                             \
 508   static bool FB_ANONYMOUS_VARIABLE(follyBenchmarkUnused) = (             \
 509     ::folly::addBenchmark(__FILE__, "-", []() -> unsigned { return 0; }), \
 510     true);
 511
 512 /**
 513  * Allows execution of code that doesn't count torward the benchmark's
 514  * time budget. Example:
 515  *
 516  * BENCHMARK_START_GROUP(insertVectorBegin, n) {
 517  *   vector<int> v;
 518  *   BENCHMARK_SUSPEND {
 519  *     v.reserve(n);
 520  *   }
 521  *   FOR_EACH_RANGE (i, 0, n) {
 522  *     v.insert(v.begin(), 42);
 523  *   }
 524  * }
 525  */
 526 #define BENCHMARK_SUSPEND                               \
 527   if (auto FB_ANONYMOUS_VARIABLE(BENCHMARK_SUSPEND) =   \
 528       ::folly::BenchmarkSuspender()) {}                 \
 529   else
 530
 531 #endif // FOLLY_BENCHMARK_H_