feat: add support for benchmark markers

Author: not-matthias

core/include/measurement.hpp

@@ -1,6 +1,7 @@
 #ifndef MEASUREMENT_H
 #define MEASUREMENT_H
 
+#include <cassert>
 #include <string>
 #ifdef _WIN32
 #include <process.h>
@@ -49,4 +50,23 @@ ALWAYS_INLINE void measurement_set_executed_benchmark(const std::string& name) {
   instrument_hooks_executed_benchmark(g_hooks, current_pid, name.c_str());
 }
 
+ALWAYS_INLINE uint64_t measurement_current_timestamp() {
+  return instrument_hooks_current_timestamp();
+}
+
+ALWAYS_INLINE int8_t measurement_add_marker(uint8_t marker_type,
+                                            uint64_t timestamp) {
+  auto pid = getpid();
+  return instrument_hooks_add_marker(g_hooks, pid, marker_type, timestamp);
+}
+
+ALWAYS_INLINE void measurement_add_benchmark_timestamps(uint64_t start,
+                                                        uint64_t end) {
+  assert(start <= end);
+  assert(start != 0 && end != 0);
+
+  measurement_add_marker(MARKER_TYPE_BENCHMARK_START, start);
+  measurement_add_marker(MARKER_TYPE_BENCHMARK_END, end);
+}
+
 #endif  // MEASUREMENT_H

core/instrument-hooks

@@ -949,6 +949,9 @@ class BENCHMARK_EXPORT BENCHMARK_INTERNAL_CACHELINE_ALIGNED State {
 #if defined(CODSPEED_INSTRUMENTATION) || defined(CODSPEED_WALLTIME)
   codspeed::CodSpeed* codspeed_;
 #endif
+#ifdef CODSPEED_WALLTIME
+  uint64_t resume_timestamp_;
+#endif
 
  private:
   bool started_;
@@ -1044,11 +1047,13 @@ struct State::StateIterator {
  private:
   friend class State;
   BENCHMARK_ALWAYS_INLINE
-  StateIterator() : cached_(0), parent_() {}
+  StateIterator() : cached_(0), parent_()
+  {}
 
   BENCHMARK_ALWAYS_INLINE
   explicit StateIterator(State* st)
-      : cached_(st->skipped() ? 0 : st->max_iterations), parent_(st) {}
+      : cached_(st->skipped() ? 0 : st->max_iterations), parent_(st)
+  {}
 
  public:
   BENCHMARK_ALWAYS_INLINE
@@ -1063,7 +1068,9 @@ struct State::StateIterator {
 
   BENCHMARK_ALWAYS_INLINE
   bool operator!=(StateIterator const&) const {
-    if (BENCHMARK_BUILTIN_EXPECT(cached_ != 0, true)) return true;
+    if (BENCHMARK_BUILTIN_EXPECT(cached_ != 0, true)) {
+      return true;
+    }
 #ifdef CODSPEED_INSTRUMENTATION
     measurement_stop();
 #endif

google_benchmark/include/benchmark/benchmark.h

@@ -19,6 +19,10 @@
 #include "codspeed.h"
 #include "internal_macros.h"
 
+#ifdef CODSPEED_WALLTIME
+#include "measurement.hpp"
+#endif
+
 #ifndef BENCHMARK_OS_WINDOWS
 #if !defined(BENCHMARK_OS_FUCHSIA) && !defined(BENCHMARK_OS_QURT)
 #include <sys/resource.h>
@@ -185,6 +189,7 @@ State::State(std::string name, IterationCount max_iters,
       max_iterations(max_iters),
 #if defined(CODSPEED_INSTRUMENTATION) || defined(CODSPEED_WALLTIME)
       codspeed_(codspeed),
+      resume_timestamp_(0),
 #endif
       started_(false),
       finished_(false),
@@ -255,6 +260,15 @@ void State::PauseTiming() {
   // Add in time accumulated so far
   BM_CHECK(started_ && !finished_ && !skipped());
   timer_->StopTimer();
+
+#ifdef CODSPEED_WALLTIME
+  if (resume_timestamp_ != 0) {
+    uint64_t pause_timestamp = measurement_current_timestamp();
+    measurement_add_benchmark_timestamps(resume_timestamp_, pause_timestamp);
+    resume_timestamp_ = 0;
+  }
+#endif
+
   if (perf_counters_measurement_ != nullptr) {
     std::vector<std::pair<std::string, double>> measurements;
     if (!perf_counters_measurement_->Stop(measurements)) {
@@ -272,6 +286,10 @@ void State::PauseTiming() {
 
 void State::ResumeTiming() {
   BM_CHECK(started_ && !finished_ && !skipped());
+#ifdef CODSPEED_WALLTIME
+  BM_CHECK(resume_timestamp_ == 0);
+  resume_timestamp_ = measurement_current_timestamp();
+#endif
   timer_->StartTimer();
   if (perf_counters_measurement_ != nullptr) {
     perf_counters_measurement_->Start();