| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 1 | // Copyright 2015 Google Inc. All rights reserved. |
| 2 | // |
| 3 | // Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | // you may not use this file except in compliance with the License. |
| 5 | // You may obtain a copy of the License at |
| 6 | // |
| 7 | // http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | // |
| 9 | // Unless required by applicable law or agreed to in writing, software |
| 10 | // distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | // See the License for the specific language governing permissions and |
| 13 | // limitations under the License. |
| 14 | |
| 15 | #include "benchmark/benchmark.h" |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 16 | #include "benchmark_api_internal.h" |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 17 | #include "internal_macros.h" |
| 18 | |
| 19 | #ifndef BENCHMARK_OS_WINDOWS |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 20 | #include <sys/resource.h> |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 21 | #include <sys/time.h> |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 22 | #include <unistd.h> |
| 23 | #endif |
| 24 | |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 25 | #include <algorithm> |
| 26 | #include <atomic> |
| 27 | #include <condition_variable> |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 28 | #include <cstdio> |
| 29 | #include <cstdlib> |
| 30 | #include <cstring> |
| Eric Fiselier | f6e09e5 | 2016-08-09 18:56:48 +0000 | [diff] [blame] | 31 | #include <fstream> |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 32 | #include <iostream> |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 33 | #include <memory> |
| 34 | #include <thread> |
| 35 | |
| 36 | #include "check.h" |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 37 | #include "colorprint.h" |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 38 | #include "commandlineflags.h" |
| 39 | #include "complexity.h" |
| Eric Fiselier | 133a720 | 2017-04-18 07:17:20 +0000 | [diff] [blame] | 40 | #include "counter.h" |
| Eric Fiselier | 1903976 | 2018-01-18 04:23:01 +0000 | [diff] [blame] | 41 | #include "internal_macros.h" |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 42 | #include "log.h" |
| 43 | #include "mutex.h" |
| 44 | #include "re.h" |
| Eric Fiselier | 1903976 | 2018-01-18 04:23:01 +0000 | [diff] [blame] | 45 | #include "statistics.h" |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 46 | #include "string_util.h" |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 47 | #include "timers.h" |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 48 | |
| 49 | DEFINE_bool(benchmark_list_tests, false, |
| 50 | "Print a list of benchmarks. This option overrides all other " |
| 51 | "options."); |
| 52 | |
| 53 | DEFINE_string(benchmark_filter, ".", |
| 54 | "A regular expression that specifies the set of benchmarks " |
| 55 | "to execute. If this flag is empty, no benchmarks are run. " |
| 56 | "If this flag is the string \"all\", all benchmarks linked " |
| 57 | "into the process are run."); |
| 58 | |
| 59 | DEFINE_double(benchmark_min_time, 0.5, |
| 60 | "Minimum number of seconds we should run benchmark before " |
| 61 | "results are considered significant. For cpu-time based " |
| 62 | "tests, this is the lower bound on the total cpu time " |
| 63 | "used by all threads that make up the test. For real-time " |
| 64 | "based tests, this is the lower bound on the elapsed time " |
| 65 | "of the benchmark execution, regardless of number of " |
| 66 | "threads."); |
| 67 | |
| 68 | DEFINE_int32(benchmark_repetitions, 1, |
| 69 | "The number of runs of each benchmark. If greater than 1, the " |
| 70 | "mean and standard deviation of the runs will be reported."); |
| 71 | |
| Eric Fiselier | 4d5e91d | 2016-08-29 19:12:01 +0000 | [diff] [blame] | 72 | DEFINE_bool(benchmark_report_aggregates_only, false, |
| 73 | "Report the result of each benchmark repetitions. When 'true' is " |
| 74 | "specified only the mean, standard deviation, and other statistics " |
| 75 | "are reported for repeated benchmarks."); |
| 76 | |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 77 | DEFINE_string(benchmark_format, "console", |
| 78 | "The format to use for console output. Valid values are " |
| 79 | "'console', 'json', or 'csv'."); |
| 80 | |
| Eric Fiselier | f6e09e5 | 2016-08-09 18:56:48 +0000 | [diff] [blame] | 81 | DEFINE_string(benchmark_out_format, "json", |
| 82 | "The format to use for file output. Valid values are " |
| 83 | "'console', 'json', or 'csv'."); |
| 84 | |
| 85 | DEFINE_string(benchmark_out, "", "The file to write additonal output to"); |
| 86 | |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 87 | DEFINE_string(benchmark_color, "auto", |
| 88 | "Whether to use colors in the output. Valid values: " |
| 89 | "'true'/'yes'/1, 'false'/'no'/0, and 'auto'. 'auto' means to use " |
| 90 | "colors if the output is being sent to a terminal and the TERM " |
| 91 | "environment variable is set to a terminal type that supports " |
| 92 | "colors."); |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 93 | |
| Eric Fiselier | 1903976 | 2018-01-18 04:23:01 +0000 | [diff] [blame] | 94 | DEFINE_bool(benchmark_counters_tabular, false, |
| 95 | "Whether to use tabular format when printing user counters to " |
| 96 | "the console. Valid values: 'true'/'yes'/1, 'false'/'no'/0." |
| 97 | "Defaults to false."); |
| 98 | |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 99 | DEFINE_int32(v, 0, "The level of verbose logging to output"); |
| 100 | |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 101 | namespace benchmark { |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 102 | |
| 103 | namespace { |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 104 | static const size_t kMaxIterations = 1000000000; |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 105 | } // end namespace |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 106 | |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 107 | namespace internal { |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 108 | |
| Eric Fiselier | 1903976 | 2018-01-18 04:23:01 +0000 | [diff] [blame] | 109 | void UseCharPointer(char const volatile*) {} |
| 110 | |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 111 | class ThreadManager { |
| 112 | public: |
| 113 | ThreadManager(int num_threads) |
| 114 | : alive_threads_(num_threads), start_stop_barrier_(num_threads) {} |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 115 | |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 116 | Mutex& GetBenchmarkMutex() const RETURN_CAPABILITY(benchmark_mutex_) { |
| 117 | return benchmark_mutex_; |
| 118 | } |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 119 | |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 120 | bool StartStopBarrier() EXCLUDES(end_cond_mutex_) { |
| 121 | return start_stop_barrier_.wait(); |
| 122 | } |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 123 | |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 124 | void NotifyThreadComplete() EXCLUDES(end_cond_mutex_) { |
| 125 | start_stop_barrier_.removeThread(); |
| 126 | if (--alive_threads_ == 0) { |
| 127 | MutexLock lock(end_cond_mutex_); |
| 128 | end_condition_.notify_all(); |
| 129 | } |
| 130 | } |
| 131 | |
| 132 | void WaitForAllThreads() EXCLUDES(end_cond_mutex_) { |
| 133 | MutexLock lock(end_cond_mutex_); |
| 134 | end_condition_.wait(lock.native_handle(), |
| 135 | [this]() { return alive_threads_ == 0; }); |
| 136 | } |
| 137 | |
| 138 | public: |
| 139 | struct Result { |
| 140 | double real_time_used = 0; |
| 141 | double cpu_time_used = 0; |
| 142 | double manual_time_used = 0; |
| 143 | int64_t bytes_processed = 0; |
| 144 | int64_t items_processed = 0; |
| 145 | int complexity_n = 0; |
| 146 | std::string report_label_; |
| 147 | std::string error_message_; |
| 148 | bool has_error_ = false; |
| Eric Fiselier | 133a720 | 2017-04-18 07:17:20 +0000 | [diff] [blame] | 149 | UserCounters counters; |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 150 | }; |
| 151 | GUARDED_BY(GetBenchmarkMutex()) Result results; |
| 152 | |
| 153 | private: |
| 154 | mutable Mutex benchmark_mutex_; |
| 155 | std::atomic<int> alive_threads_; |
| 156 | Barrier start_stop_barrier_; |
| 157 | Mutex end_cond_mutex_; |
| 158 | Condition end_condition_; |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 159 | }; |
| 160 | |
| 161 | // Timer management class |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 162 | class ThreadTimer { |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 163 | public: |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 164 | ThreadTimer() = default; |
| 165 | |
| 166 | // Called by each thread |
| 167 | void StartTimer() { |
| 168 | running_ = true; |
| 169 | start_real_time_ = ChronoClockNow(); |
| 170 | start_cpu_time_ = ThreadCPUUsage(); |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 171 | } |
| 172 | |
| 173 | // Called by each thread |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 174 | void StopTimer() { |
| 175 | CHECK(running_); |
| 176 | running_ = false; |
| 177 | real_time_used_ += ChronoClockNow() - start_real_time_; |
| Eric Fiselier | 1903976 | 2018-01-18 04:23:01 +0000 | [diff] [blame] | 178 | // Floating point error can result in the subtraction producing a negative |
| 179 | // time. Guard against that. |
| 180 | cpu_time_used_ += std::max<double>(ThreadCPUUsage() - start_cpu_time_, 0); |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 181 | } |
| 182 | |
| 183 | // Called by each thread |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 184 | void SetIterationTime(double seconds) { manual_time_used_ += seconds; } |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 185 | |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 186 | bool running() const { return running_; } |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 187 | |
| 188 | // REQUIRES: timer is not running |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 189 | double real_time_used() { |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 190 | CHECK(!running_); |
| 191 | return real_time_used_; |
| 192 | } |
| 193 | |
| 194 | // REQUIRES: timer is not running |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 195 | double cpu_time_used() { |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 196 | CHECK(!running_); |
| 197 | return cpu_time_used_; |
| 198 | } |
| 199 | |
| 200 | // REQUIRES: timer is not running |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 201 | double manual_time_used() { |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 202 | CHECK(!running_); |
| 203 | return manual_time_used_; |
| 204 | } |
| 205 | |
| 206 | private: |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 207 | bool running_ = false; // Is the timer running |
| 208 | double start_real_time_ = 0; // If running_ |
| 209 | double start_cpu_time_ = 0; // If running_ |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 210 | |
| 211 | // Accumulated time so far (does not contain current slice if running_) |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 212 | double real_time_used_ = 0; |
| 213 | double cpu_time_used_ = 0; |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 214 | // Manually set iteration time. User sets this with SetIterationTime(seconds). |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 215 | double manual_time_used_ = 0; |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 216 | }; |
| 217 | |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 218 | namespace { |
| 219 | |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 220 | BenchmarkReporter::Run CreateRunReport( |
| 221 | const benchmark::internal::Benchmark::Instance& b, |
| 222 | const internal::ThreadManager::Result& results, size_t iters, |
| 223 | double seconds) { |
| 224 | // Create report about this benchmark run. |
| 225 | BenchmarkReporter::Run report; |
| 226 | |
| 227 | report.benchmark_name = b.name; |
| 228 | report.error_occurred = results.has_error_; |
| 229 | report.error_message = results.error_message_; |
| 230 | report.report_label = results.report_label_; |
| 231 | // Report the total iterations across all threads. |
| 232 | report.iterations = static_cast<int64_t>(iters) * b.threads; |
| 233 | report.time_unit = b.time_unit; |
| 234 | |
| 235 | if (!report.error_occurred) { |
| 236 | double bytes_per_second = 0; |
| 237 | if (results.bytes_processed > 0 && seconds > 0.0) { |
| 238 | bytes_per_second = (results.bytes_processed / seconds); |
| 239 | } |
| 240 | double items_per_second = 0; |
| 241 | if (results.items_processed > 0 && seconds > 0.0) { |
| 242 | items_per_second = (results.items_processed / seconds); |
| 243 | } |
| 244 | |
| 245 | if (b.use_manual_time) { |
| 246 | report.real_accumulated_time = results.manual_time_used; |
| 247 | } else { |
| 248 | report.real_accumulated_time = results.real_time_used; |
| 249 | } |
| 250 | report.cpu_accumulated_time = results.cpu_time_used; |
| 251 | report.bytes_per_second = bytes_per_second; |
| 252 | report.items_per_second = items_per_second; |
| 253 | report.complexity_n = results.complexity_n; |
| 254 | report.complexity = b.complexity; |
| 255 | report.complexity_lambda = b.complexity_lambda; |
| Eric Fiselier | 1903976 | 2018-01-18 04:23:01 +0000 | [diff] [blame] | 256 | report.statistics = b.statistics; |
| Eric Fiselier | 133a720 | 2017-04-18 07:17:20 +0000 | [diff] [blame] | 257 | report.counters = results.counters; |
| Eric Fiselier | 1903976 | 2018-01-18 04:23:01 +0000 | [diff] [blame] | 258 | internal::Finish(&report.counters, seconds, b.threads); |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 259 | } |
| 260 | return report; |
| 261 | } |
| 262 | |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 263 | // Execute one thread of benchmark b for the specified number of iterations. |
| 264 | // Adds the stats collected for the thread into *total. |
| 265 | void RunInThread(const benchmark::internal::Benchmark::Instance* b, |
| 266 | size_t iters, int thread_id, |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 267 | internal::ThreadManager* manager) { |
| 268 | internal::ThreadTimer timer; |
| 269 | State st(iters, b->arg, thread_id, b->threads, &timer, manager); |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 270 | b->benchmark->Run(st); |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 271 | CHECK(st.iterations() == st.max_iterations) |
| 272 | << "Benchmark returned before State::KeepRunning() returned false!"; |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 273 | { |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 274 | MutexLock l(manager->GetBenchmarkMutex()); |
| 275 | internal::ThreadManager::Result& results = manager->results; |
| 276 | results.cpu_time_used += timer.cpu_time_used(); |
| 277 | results.real_time_used += timer.real_time_used(); |
| 278 | results.manual_time_used += timer.manual_time_used(); |
| 279 | results.bytes_processed += st.bytes_processed(); |
| 280 | results.items_processed += st.items_processed(); |
| 281 | results.complexity_n += st.complexity_length_n(); |
| Eric Fiselier | 133a720 | 2017-04-18 07:17:20 +0000 | [diff] [blame] | 282 | internal::Increment(&results.counters, st.counters); |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 283 | } |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 284 | manager->NotifyThreadComplete(); |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 285 | } |
| 286 | |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 287 | std::vector<BenchmarkReporter::Run> RunBenchmark( |
| 288 | const benchmark::internal::Benchmark::Instance& b, |
| 289 | std::vector<BenchmarkReporter::Run>* complexity_reports) { |
| 290 | std::vector<BenchmarkReporter::Run> reports; // return value |
| Eric Fiselier | 4d5e91d | 2016-08-29 19:12:01 +0000 | [diff] [blame] | 291 | |
| Eric Fiselier | 133a720 | 2017-04-18 07:17:20 +0000 | [diff] [blame] | 292 | const bool has_explicit_iteration_count = b.iterations != 0; |
| 293 | size_t iters = has_explicit_iteration_count ? b.iterations : 1; |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 294 | std::unique_ptr<internal::ThreadManager> manager; |
| 295 | std::vector<std::thread> pool(b.threads - 1); |
| 296 | const int repeats = |
| 297 | b.repetitions != 0 ? b.repetitions : FLAGS_benchmark_repetitions; |
| 298 | const bool report_aggregates_only = |
| 299 | repeats != 1 && |
| Eric Fiselier | 4d5e91d | 2016-08-29 19:12:01 +0000 | [diff] [blame] | 300 | (b.report_mode == internal::RM_Unspecified |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 301 | ? FLAGS_benchmark_report_aggregates_only |
| 302 | : b.report_mode == internal::RM_ReportAggregatesOnly); |
| Eric Fiselier | 133a720 | 2017-04-18 07:17:20 +0000 | [diff] [blame] | 303 | for (int repetition_num = 0; repetition_num < repeats; repetition_num++) { |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 304 | for (;;) { |
| 305 | // Try benchmark |
| 306 | VLOG(2) << "Running " << b.name << " for " << iters << "\n"; |
| 307 | |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 308 | manager.reset(new internal::ThreadManager(b.threads)); |
| 309 | for (std::size_t ti = 0; ti < pool.size(); ++ti) { |
| 310 | pool[ti] = std::thread(&RunInThread, &b, iters, |
| 311 | static_cast<int>(ti + 1), manager.get()); |
| 312 | } |
| 313 | RunInThread(&b, iters, 0, manager.get()); |
| 314 | manager->WaitForAllThreads(); |
| 315 | for (std::thread& thread : pool) thread.join(); |
| 316 | internal::ThreadManager::Result results; |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 317 | { |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 318 | MutexLock l(manager->GetBenchmarkMutex()); |
| 319 | results = manager->results; |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 320 | } |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 321 | manager.reset(); |
| 322 | // Adjust real/manual time stats since they were reported per thread. |
| 323 | results.real_time_used /= b.threads; |
| 324 | results.manual_time_used /= b.threads; |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 325 | |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 326 | VLOG(2) << "Ran in " << results.cpu_time_used << "/" |
| 327 | << results.real_time_used << "\n"; |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 328 | |
| 329 | // Base decisions off of real time if requested by this benchmark. |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 330 | double seconds = results.cpu_time_used; |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 331 | if (b.use_manual_time) { |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 332 | seconds = results.manual_time_used; |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 333 | } else if (b.use_real_time) { |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 334 | seconds = results.real_time_used; |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 335 | } |
| 336 | |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 337 | const double min_time = |
| 338 | !IsZero(b.min_time) ? b.min_time : FLAGS_benchmark_min_time; |
| Eric Fiselier | 133a720 | 2017-04-18 07:17:20 +0000 | [diff] [blame] | 339 | |
| 340 | // Determine if this run should be reported; Either it has |
| 341 | // run for a sufficient amount of time or because an error was reported. |
| 342 | const bool should_report = repetition_num > 0 |
| 343 | || has_explicit_iteration_count // An exact iteration count was requested |
| 344 | || results.has_error_ |
| 345 | || iters >= kMaxIterations |
| 346 | || seconds >= min_time // the elapsed time is large enough |
| 347 | // CPU time is specified but the elapsed real time greatly exceeds the |
| 348 | // minimum time. Note that user provided timers are except from this |
| 349 | // sanity check. |
| 350 | || ((results.real_time_used >= 5 * min_time) && !b.use_manual_time); |
| 351 | |
| 352 | if (should_report) { |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 353 | BenchmarkReporter::Run report = |
| 354 | CreateRunReport(b, results, iters, seconds); |
| 355 | if (!report.error_occurred && b.complexity != oNone) |
| 356 | complexity_reports->push_back(report); |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 357 | reports.push_back(report); |
| 358 | break; |
| 359 | } |
| 360 | |
| 361 | // See how much iterations should be increased by |
| 362 | // Note: Avoid division by zero with max(seconds, 1ns). |
| 363 | double multiplier = min_time * 1.4 / std::max(seconds, 1e-9); |
| 364 | // If our last run was at least 10% of FLAGS_benchmark_min_time then we |
| 365 | // use the multiplier directly. Otherwise we use at most 10 times |
| 366 | // expansion. |
| 367 | // NOTE: When the last run was at least 10% of the min time the max |
| 368 | // expansion should be 14x. |
| 369 | bool is_significant = (seconds / min_time) > 0.1; |
| 370 | multiplier = is_significant ? multiplier : std::min(10.0, multiplier); |
| 371 | if (multiplier <= 1.0) multiplier = 2.0; |
| 372 | double next_iters = std::max(multiplier * iters, iters + 1.0); |
| 373 | if (next_iters > kMaxIterations) { |
| 374 | next_iters = kMaxIterations; |
| 375 | } |
| 376 | VLOG(3) << "Next iters: " << next_iters << ", " << multiplier << "\n"; |
| 377 | iters = static_cast<int>(next_iters + 0.5); |
| 378 | } |
| 379 | } |
| Eric Fiselier | 4d5e91d | 2016-08-29 19:12:01 +0000 | [diff] [blame] | 380 | // Calculate additional statistics |
| 381 | auto stat_reports = ComputeStats(reports); |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 382 | if ((b.complexity != oNone) && b.last_benchmark_instance) { |
| Eric Fiselier | 4d5e91d | 2016-08-29 19:12:01 +0000 | [diff] [blame] | 383 | auto additional_run_stats = ComputeBigO(*complexity_reports); |
| 384 | stat_reports.insert(stat_reports.end(), additional_run_stats.begin(), |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 385 | additional_run_stats.end()); |
| Eric Fiselier | 4d5e91d | 2016-08-29 19:12:01 +0000 | [diff] [blame] | 386 | complexity_reports->clear(); |
| 387 | } |
| Eric Fiselier | f6e09e5 | 2016-08-09 18:56:48 +0000 | [diff] [blame] | 388 | |
| Eric Fiselier | 4d5e91d | 2016-08-29 19:12:01 +0000 | [diff] [blame] | 389 | if (report_aggregates_only) reports.clear(); |
| 390 | reports.insert(reports.end(), stat_reports.begin(), stat_reports.end()); |
| Eric Fiselier | f6e09e5 | 2016-08-09 18:56:48 +0000 | [diff] [blame] | 391 | return reports; |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 392 | } |
| 393 | |
| 394 | } // namespace |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 395 | } // namespace internal |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 396 | |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 397 | State::State(size_t max_iters, const std::vector<int>& ranges, int thread_i, |
| 398 | int n_threads, internal::ThreadTimer* timer, |
| 399 | internal::ThreadManager* manager) |
| 400 | : started_(false), |
| 401 | finished_(false), |
| Eric Fiselier | 1903976 | 2018-01-18 04:23:01 +0000 | [diff] [blame] | 402 | total_iterations_(max_iters + 1), |
| Eric Fiselier | f6e09e5 | 2016-08-09 18:56:48 +0000 | [diff] [blame] | 403 | range_(ranges), |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 404 | bytes_processed_(0), |
| 405 | items_processed_(0), |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 406 | complexity_n_(0), |
| 407 | error_occurred_(false), |
| Eric Fiselier | 133a720 | 2017-04-18 07:17:20 +0000 | [diff] [blame] | 408 | counters(), |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 409 | thread_index(thread_i), |
| 410 | threads(n_threads), |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 411 | max_iterations(max_iters), |
| 412 | timer_(timer), |
| 413 | manager_(manager) { |
| 414 | CHECK(max_iterations != 0) << "At least one iteration must be run"; |
| Eric Fiselier | 1903976 | 2018-01-18 04:23:01 +0000 | [diff] [blame] | 415 | CHECK(total_iterations_ != 0) << "max iterations wrapped around"; |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 416 | CHECK_LT(thread_index, threads) << "thread_index must be less than threads"; |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 417 | } |
| 418 | |
| 419 | void State::PauseTiming() { |
| 420 | // Add in time accumulated so far |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 421 | CHECK(started_ && !finished_ && !error_occurred_); |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 422 | timer_->StopTimer(); |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 423 | } |
| 424 | |
| 425 | void State::ResumeTiming() { |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 426 | CHECK(started_ && !finished_ && !error_occurred_); |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 427 | timer_->StartTimer(); |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 428 | } |
| 429 | |
| 430 | void State::SkipWithError(const char* msg) { |
| 431 | CHECK(msg); |
| 432 | error_occurred_ = true; |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 433 | { |
| 434 | MutexLock l(manager_->GetBenchmarkMutex()); |
| 435 | if (manager_->results.has_error_ == false) { |
| 436 | manager_->results.error_message_ = msg; |
| 437 | manager_->results.has_error_ = true; |
| 438 | } |
| 439 | } |
| Eric Fiselier | 1903976 | 2018-01-18 04:23:01 +0000 | [diff] [blame] | 440 | total_iterations_ = 1; |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 441 | if (timer_->running()) timer_->StopTimer(); |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 442 | } |
| 443 | |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 444 | void State::SetIterationTime(double seconds) { |
| 445 | timer_->SetIterationTime(seconds); |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 446 | } |
| 447 | |
| 448 | void State::SetLabel(const char* label) { |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 449 | MutexLock l(manager_->GetBenchmarkMutex()); |
| 450 | manager_->results.report_label_ = label; |
| 451 | } |
| 452 | |
| 453 | void State::StartKeepRunning() { |
| 454 | CHECK(!started_ && !finished_); |
| 455 | started_ = true; |
| 456 | manager_->StartStopBarrier(); |
| 457 | if (!error_occurred_) ResumeTiming(); |
| 458 | } |
| 459 | |
| 460 | void State::FinishKeepRunning() { |
| 461 | CHECK(started_ && (!finished_ || error_occurred_)); |
| 462 | if (!error_occurred_) { |
| 463 | PauseTiming(); |
| 464 | } |
| Eric Fiselier | 1903976 | 2018-01-18 04:23:01 +0000 | [diff] [blame] | 465 | // Total iterations has now wrapped around zero. Fix this. |
| 466 | total_iterations_ = 1; |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 467 | finished_ = true; |
| 468 | manager_->StartStopBarrier(); |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 469 | } |
| 470 | |
| 471 | namespace internal { |
| 472 | namespace { |
| 473 | |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 474 | void RunBenchmarks(const std::vector<Benchmark::Instance>& benchmarks, |
| Eric Fiselier | f6e09e5 | 2016-08-09 18:56:48 +0000 | [diff] [blame] | 475 | BenchmarkReporter* console_reporter, |
| 476 | BenchmarkReporter* file_reporter) { |
| 477 | // Note the file_reporter can be null. |
| 478 | CHECK(console_reporter != nullptr); |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 479 | |
| 480 | // Determine the width of the name field using a minimum width of 10. |
| 481 | bool has_repetitions = FLAGS_benchmark_repetitions > 1; |
| 482 | size_t name_field_width = 10; |
| Eric Fiselier | 1903976 | 2018-01-18 04:23:01 +0000 | [diff] [blame] | 483 | size_t stat_field_width = 0; |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 484 | for (const Benchmark::Instance& benchmark : benchmarks) { |
| 485 | name_field_width = |
| 486 | std::max<size_t>(name_field_width, benchmark.name.size()); |
| 487 | has_repetitions |= benchmark.repetitions > 1; |
| Eric Fiselier | 1903976 | 2018-01-18 04:23:01 +0000 | [diff] [blame] | 488 | |
| 489 | for(const auto& Stat : *benchmark.statistics) |
| 490 | stat_field_width = std::max<size_t>(stat_field_width, Stat.name_.size()); |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 491 | } |
| Eric Fiselier | 1903976 | 2018-01-18 04:23:01 +0000 | [diff] [blame] | 492 | if (has_repetitions) name_field_width += 1 + stat_field_width; |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 493 | |
| 494 | // Print header here |
| 495 | BenchmarkReporter::Context context; |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 496 | context.name_field_width = name_field_width; |
| 497 | |
| 498 | // Keep track of runing times of all instances of current benchmark |
| 499 | std::vector<BenchmarkReporter::Run> complexity_reports; |
| 500 | |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 501 | // We flush streams after invoking reporter methods that write to them. This |
| 502 | // ensures users get timely updates even when streams are not line-buffered. |
| 503 | auto flushStreams = [](BenchmarkReporter* reporter) { |
| 504 | if (!reporter) return; |
| 505 | std::flush(reporter->GetOutputStream()); |
| 506 | std::flush(reporter->GetErrorStream()); |
| 507 | }; |
| 508 | |
| 509 | if (console_reporter->ReportContext(context) && |
| 510 | (!file_reporter || file_reporter->ReportContext(context))) { |
| 511 | flushStreams(console_reporter); |
| 512 | flushStreams(file_reporter); |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 513 | for (const auto& benchmark : benchmarks) { |
| Eric Fiselier | f6e09e5 | 2016-08-09 18:56:48 +0000 | [diff] [blame] | 514 | std::vector<BenchmarkReporter::Run> reports = |
| 515 | RunBenchmark(benchmark, &complexity_reports); |
| 516 | console_reporter->ReportRuns(reports); |
| 517 | if (file_reporter) file_reporter->ReportRuns(reports); |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 518 | flushStreams(console_reporter); |
| 519 | flushStreams(file_reporter); |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 520 | } |
| 521 | } |
| Eric Fiselier | f6e09e5 | 2016-08-09 18:56:48 +0000 | [diff] [blame] | 522 | console_reporter->Finalize(); |
| 523 | if (file_reporter) file_reporter->Finalize(); |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 524 | flushStreams(console_reporter); |
| 525 | flushStreams(file_reporter); |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 526 | } |
| 527 | |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 528 | std::unique_ptr<BenchmarkReporter> CreateReporter( |
| Eric Fiselier | 1903976 | 2018-01-18 04:23:01 +0000 | [diff] [blame] | 529 | std::string const& name, ConsoleReporter::OutputOptions output_opts) { |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 530 | typedef std::unique_ptr<BenchmarkReporter> PtrType; |
| Eric Fiselier | f6e09e5 | 2016-08-09 18:56:48 +0000 | [diff] [blame] | 531 | if (name == "console") { |
| Eric Fiselier | 1903976 | 2018-01-18 04:23:01 +0000 | [diff] [blame] | 532 | return PtrType(new ConsoleReporter(output_opts)); |
| Eric Fiselier | f6e09e5 | 2016-08-09 18:56:48 +0000 | [diff] [blame] | 533 | } else if (name == "json") { |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 534 | return PtrType(new JSONReporter); |
| Eric Fiselier | f6e09e5 | 2016-08-09 18:56:48 +0000 | [diff] [blame] | 535 | } else if (name == "csv") { |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 536 | return PtrType(new CSVReporter); |
| 537 | } else { |
| Eric Fiselier | f6e09e5 | 2016-08-09 18:56:48 +0000 | [diff] [blame] | 538 | std::cerr << "Unexpected format: '" << name << "'\n"; |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 539 | std::exit(1); |
| 540 | } |
| 541 | } |
| 542 | |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 543 | } // end namespace |
| Eric Fiselier | 1903976 | 2018-01-18 04:23:01 +0000 | [diff] [blame] | 544 | |
| 545 | bool IsZero(double n) { |
| 546 | return std::abs(n) < std::numeric_limits<double>::epsilon(); |
| 547 | } |
| 548 | |
| 549 | ConsoleReporter::OutputOptions GetOutputOptions(bool force_no_color) { |
| 550 | int output_opts = ConsoleReporter::OO_Defaults; |
| 551 | if ((FLAGS_benchmark_color == "auto" && IsColorTerminal()) || |
| 552 | IsTruthyFlagValue(FLAGS_benchmark_color)) { |
| 553 | output_opts |= ConsoleReporter::OO_Color; |
| 554 | } else { |
| 555 | output_opts &= ~ConsoleReporter::OO_Color; |
| 556 | } |
| 557 | if(force_no_color) { |
| 558 | output_opts &= ~ConsoleReporter::OO_Color; |
| 559 | } |
| 560 | if(FLAGS_benchmark_counters_tabular) { |
| 561 | output_opts |= ConsoleReporter::OO_Tabular; |
| 562 | } else { |
| 563 | output_opts &= ~ConsoleReporter::OO_Tabular; |
| 564 | } |
| 565 | return static_cast< ConsoleReporter::OutputOptions >(output_opts); |
| 566 | } |
| 567 | |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 568 | } // end namespace internal |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 569 | |
| 570 | size_t RunSpecifiedBenchmarks() { |
| Eric Fiselier | f6e09e5 | 2016-08-09 18:56:48 +0000 | [diff] [blame] | 571 | return RunSpecifiedBenchmarks(nullptr, nullptr); |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 572 | } |
| 573 | |
| Eric Fiselier | f6e09e5 | 2016-08-09 18:56:48 +0000 | [diff] [blame] | 574 | size_t RunSpecifiedBenchmarks(BenchmarkReporter* console_reporter) { |
| 575 | return RunSpecifiedBenchmarks(console_reporter, nullptr); |
| 576 | } |
| 577 | |
| Eric Fiselier | f6e09e5 | 2016-08-09 18:56:48 +0000 | [diff] [blame] | 578 | size_t RunSpecifiedBenchmarks(BenchmarkReporter* console_reporter, |
| 579 | BenchmarkReporter* file_reporter) { |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 580 | std::string spec = FLAGS_benchmark_filter; |
| 581 | if (spec.empty() || spec == "all") |
| 582 | spec = "."; // Regexp that matches all benchmarks |
| 583 | |
| Eric Fiselier | 4d5e91d | 2016-08-29 19:12:01 +0000 | [diff] [blame] | 584 | // Setup the reporters |
| 585 | std::ofstream output_file; |
| 586 | std::unique_ptr<BenchmarkReporter> default_console_reporter; |
| 587 | std::unique_ptr<BenchmarkReporter> default_file_reporter; |
| 588 | if (!console_reporter) { |
| Eric Fiselier | 1903976 | 2018-01-18 04:23:01 +0000 | [diff] [blame] | 589 | default_console_reporter = internal::CreateReporter( |
| 590 | FLAGS_benchmark_format, internal::GetOutputOptions()); |
| Eric Fiselier | 4d5e91d | 2016-08-29 19:12:01 +0000 | [diff] [blame] | 591 | console_reporter = default_console_reporter.get(); |
| 592 | } |
| 593 | auto& Out = console_reporter->GetOutputStream(); |
| 594 | auto& Err = console_reporter->GetErrorStream(); |
| 595 | |
| 596 | std::string const& fname = FLAGS_benchmark_out; |
| Eric Fiselier | 1903976 | 2018-01-18 04:23:01 +0000 | [diff] [blame] | 597 | if (fname.empty() && file_reporter) { |
| Eric Fiselier | 4d5e91d | 2016-08-29 19:12:01 +0000 | [diff] [blame] | 598 | Err << "A custom file reporter was provided but " |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 599 | "--benchmark_out=<file> was not specified." |
| 600 | << std::endl; |
| Eric Fiselier | 4d5e91d | 2016-08-29 19:12:01 +0000 | [diff] [blame] | 601 | std::exit(1); |
| 602 | } |
| Eric Fiselier | 1903976 | 2018-01-18 04:23:01 +0000 | [diff] [blame] | 603 | if (!fname.empty()) { |
| Eric Fiselier | 4d5e91d | 2016-08-29 19:12:01 +0000 | [diff] [blame] | 604 | output_file.open(fname); |
| 605 | if (!output_file.is_open()) { |
| 606 | Err << "invalid file name: '" << fname << std::endl; |
| 607 | std::exit(1); |
| 608 | } |
| 609 | if (!file_reporter) { |
| 610 | default_file_reporter = internal::CreateReporter( |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 611 | FLAGS_benchmark_out_format, ConsoleReporter::OO_None); |
| Eric Fiselier | 4d5e91d | 2016-08-29 19:12:01 +0000 | [diff] [blame] | 612 | file_reporter = default_file_reporter.get(); |
| 613 | } |
| 614 | file_reporter->SetOutputStream(&output_file); |
| 615 | file_reporter->SetErrorStream(&output_file); |
| 616 | } |
| 617 | |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 618 | std::vector<internal::Benchmark::Instance> benchmarks; |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 619 | if (!FindBenchmarksInternal(spec, &benchmarks, &Err)) return 0; |
| 620 | |
| 621 | if (benchmarks.empty()) { |
| 622 | Err << "Failed to match any benchmarks against regex: " << spec << "\n"; |
| 623 | return 0; |
| 624 | } |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 625 | |
| 626 | if (FLAGS_benchmark_list_tests) { |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 627 | for (auto const& benchmark : benchmarks) Out << benchmark.name << "\n"; |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 628 | } else { |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 629 | internal::RunBenchmarks(benchmarks, console_reporter, file_reporter); |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 630 | } |
| Eric Fiselier | 4d5e91d | 2016-08-29 19:12:01 +0000 | [diff] [blame] | 631 | |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 632 | return benchmarks.size(); |
| 633 | } |
| 634 | |
| 635 | namespace internal { |
| 636 | |
| 637 | void PrintUsageAndExit() { |
| 638 | fprintf(stdout, |
| 639 | "benchmark" |
| 640 | " [--benchmark_list_tests={true|false}]\n" |
| 641 | " [--benchmark_filter=<regex>]\n" |
| 642 | " [--benchmark_min_time=<min_time>]\n" |
| 643 | " [--benchmark_repetitions=<num_repetitions>]\n" |
| Eric Fiselier | 4d5e91d | 2016-08-29 19:12:01 +0000 | [diff] [blame] | 644 | " [--benchmark_report_aggregates_only={true|false}\n" |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 645 | " [--benchmark_format=<console|json|csv>]\n" |
| Eric Fiselier | f6e09e5 | 2016-08-09 18:56:48 +0000 | [diff] [blame] | 646 | " [--benchmark_out=<filename>]\n" |
| 647 | " [--benchmark_out_format=<json|console|csv>]\n" |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 648 | " [--benchmark_color={auto|true|false}]\n" |
| Eric Fiselier | 1903976 | 2018-01-18 04:23:01 +0000 | [diff] [blame] | 649 | " [--benchmark_counters_tabular={true|false}]\n" |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 650 | " [--v=<verbosity>]\n"); |
| 651 | exit(0); |
| 652 | } |
| 653 | |
| 654 | void ParseCommandLineFlags(int* argc, char** argv) { |
| 655 | using namespace benchmark; |
| 656 | for (int i = 1; i < *argc; ++i) { |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 657 | if (ParseBoolFlag(argv[i], "benchmark_list_tests", |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 658 | &FLAGS_benchmark_list_tests) || |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 659 | ParseStringFlag(argv[i], "benchmark_filter", &FLAGS_benchmark_filter) || |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 660 | ParseDoubleFlag(argv[i], "benchmark_min_time", |
| 661 | &FLAGS_benchmark_min_time) || |
| 662 | ParseInt32Flag(argv[i], "benchmark_repetitions", |
| 663 | &FLAGS_benchmark_repetitions) || |
| Eric Fiselier | 4d5e91d | 2016-08-29 19:12:01 +0000 | [diff] [blame] | 664 | ParseBoolFlag(argv[i], "benchmark_report_aggregates_only", |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 665 | &FLAGS_benchmark_report_aggregates_only) || |
| 666 | ParseStringFlag(argv[i], "benchmark_format", &FLAGS_benchmark_format) || |
| 667 | ParseStringFlag(argv[i], "benchmark_out", &FLAGS_benchmark_out) || |
| Eric Fiselier | f6e09e5 | 2016-08-09 18:56:48 +0000 | [diff] [blame] | 668 | ParseStringFlag(argv[i], "benchmark_out_format", |
| 669 | &FLAGS_benchmark_out_format) || |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 670 | ParseStringFlag(argv[i], "benchmark_color", &FLAGS_benchmark_color) || |
| 671 | // "color_print" is the deprecated name for "benchmark_color". |
| 672 | // TODO: Remove this. |
| 673 | ParseStringFlag(argv[i], "color_print", &FLAGS_benchmark_color) || |
| Eric Fiselier | 1903976 | 2018-01-18 04:23:01 +0000 | [diff] [blame] | 674 | ParseBoolFlag(argv[i], "benchmark_counters_tabular", |
| 675 | &FLAGS_benchmark_counters_tabular) || |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 676 | ParseInt32Flag(argv[i], "v", &FLAGS_v)) { |
| Eric Fiselier | 133a720 | 2017-04-18 07:17:20 +0000 | [diff] [blame] | 677 | for (int j = i; j != *argc - 1; ++j) argv[j] = argv[j + 1]; |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 678 | |
| 679 | --(*argc); |
| 680 | --i; |
| 681 | } else if (IsFlag(argv[i], "help")) { |
| 682 | PrintUsageAndExit(); |
| 683 | } |
| 684 | } |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 685 | for (auto const* flag : |
| 686 | {&FLAGS_benchmark_format, &FLAGS_benchmark_out_format}) |
| 687 | if (*flag != "console" && *flag != "json" && *flag != "csv") { |
| 688 | PrintUsageAndExit(); |
| 689 | } |
| 690 | if (FLAGS_benchmark_color.empty()) { |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 691 | PrintUsageAndExit(); |
| 692 | } |
| 693 | } |
| 694 | |
| Eric Fiselier | 4d5e91d | 2016-08-29 19:12:01 +0000 | [diff] [blame] | 695 | int InitializeStreams() { |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 696 | static std::ios_base::Init init; |
| 697 | return 0; |
| Eric Fiselier | 4d5e91d | 2016-08-29 19:12:01 +0000 | [diff] [blame] | 698 | } |
| 699 | |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 700 | } // end namespace internal |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 701 | |
| 702 | void Initialize(int* argc, char** argv) { |
| 703 | internal::ParseCommandLineFlags(argc, argv); |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 704 | internal::LogLevel() = FLAGS_v; |
| Eric Fiselier | b08d8b1 | 2016-07-19 23:07:03 +0000 | [diff] [blame] | 705 | } |
| 706 | |
| Eric Fiselier | 133a720 | 2017-04-18 07:17:20 +0000 | [diff] [blame] | 707 | bool ReportUnrecognizedArguments(int argc, char** argv) { |
| 708 | for (int i = 1; i < argc; ++i) { |
| 709 | fprintf(stderr, "%s: error: unrecognized command-line flag: %s\n", argv[0], argv[i]); |
| 710 | } |
| 711 | return argc > 1; |
| 712 | } |
| 713 | |
| Eric Fiselier | fbc9ff2 | 2016-11-05 00:30:27 +0000 | [diff] [blame] | 714 | } // end namespace benchmark |