Relax CHECK condition in benchmark_runner.cc

chfast · chfast · commit 4db5fe363d94 · 2020-02-15T00:03:04.000+01:00
If the benchmark state contains an error, do not expect any iterations has been run.
This allows using SkipWithError() and return early from the benchmark function.
diff --git a/src/benchmark_runner.cc b/src/benchmark_runner.cc
@@ -117,7 +117,7 @@ void RunInThread(const BenchmarkInstance* b, IterationCount iters,
           ? internal::ThreadTimer::CreateProcessCpuTime()
           : internal::ThreadTimer::Create());
   State st = b->Run(iters, thread_id, &timer, manager);
-  CHECK(st.iterations() >= st.max_iterations)
+  CHECK(st.error_occurred() || st.iterations() >= st.max_iterations)
       << "Benchmark returned before State::KeepRunning() returned false!";
   {
     MutexLock l(manager->GetBenchmarkMutex());
diff --git a/test/skip_with_error_test.cc b/test/skip_with_error_test.cc
@@ -61,6 +61,12 @@ int AddCases(const char* base_name, std::initializer_list<TestCase> const& v) {
 
 }  // end namespace
 
+void BM_error_no_running(benchmark::State& state) {
+  state.SkipWithError("error message");
+}
+BENCHMARK(BM_error_no_running);
+ADD_CASES("BM_error_no_running", {{"", true, "error message"}});
+
 void BM_error_before_running(benchmark::State& state) {
   state.SkipWithError("error message");
   while (state.KeepRunning()) {

Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,7 @@ void RunInThread(const BenchmarkInstance* b, IterationCount iters,`
`117`	`117`	`? internal::ThreadTimer::CreateProcessCpuTime()`
`118`	`118`	`: internal::ThreadTimer::Create());`
`119`	`119`	`State st = b->Run(iters, thread_id, &timer, manager);`
`120`		`- CHECK(st.iterations() >= st.max_iterations)`
	`120`	`+ CHECK(st.error_occurred() \|\| st.iterations() >= st.max_iterations)`
`121`	`121`	`<< "Benchmark returned before State::KeepRunning() returned false!";`
`122`	`122`	`{`
`123`	`123`	`MutexLock l(manager->GetBenchmarkMutex());`