feat: add support for memory mode

Author: not-matthias

core/BUILD

@@ -81,8 +81,9 @@ cc_library(
     defines = [
         "CODSPEED_VERSION=\\\"{}\\\"".format(CODSPEED_VERSION),
     ] + select({
-        ":instrumentation_mode": ["CODSPEED_ENABLED", "CODSPEED_SIMULATION"],
-        ":simulation_mode": ["CODSPEED_ENABLED", "CODSPEED_SIMULATION"],
+        ":instrumentation_mode": ["CODSPEED_ENABLED", "CODSPEED_ANALYSIS"],
+        ":simulation_mode": ["CODSPEED_ENABLED", "CODSPEED_ANALYSIS"],
+        ":memory_mode": ["CODSPEED_ENABLED", "CODSPEED_ANALYSIS"],
         ":walltime_mode": ["CODSPEED_ENABLED", "CODSPEED_WALLTIME"],
         "//conditions:default": [],
     }),
@@ -98,6 +99,7 @@ string_flag(
         "off",
         "instrumentation",
         "simulation",
+        "memory",
         "walltime",
     ],
     visibility = ["//visibility:public"],
@@ -113,6 +115,11 @@ config_setting(
     flag_values = {":codspeed_mode": "simulation"},
 )
 
+config_setting(
+    name = "memory_mode",
+    flag_values = {":codspeed_mode": "memory"},
+)
+
 config_setting(
     name = "walltime_mode",
     flag_values = {":codspeed_mode": "walltime"},

core/CMakeLists.txt

@@ -143,7 +143,7 @@ target_compile_definitions(
 
 message(STATUS "Using codspeed root directory: ${CODSPEED_ROOT_DIR}")
 
-set(CODSPEED_MODE_ALLOWED_VALUES "off" "instrumentation" "simulation" "walltime")
+set(CODSPEED_MODE_ALLOWED_VALUES "off" "instrumentation" "simulation" "memory" "walltime")
 set(CODSPEED_MODE "off" CACHE STRING "Build mode for Codspeed")
 set_property(
     CACHE CODSPEED_MODE
@@ -166,10 +166,10 @@ if(NOT CODSPEED_MODE STREQUAL "off")
     endif()
 
     # Define a preprocessor macro based on the build mode
-    if(CODSPEED_MODE STREQUAL "instrumentation" OR CODSPEED_MODE STREQUAL "simulation")
+    if(CODSPEED_MODE STREQUAL "instrumentation" OR CODSPEED_MODE STREQUAL "simulation" OR CODSPEED_MODE STREQUAL "memory")
         target_compile_definitions(
             codspeed
-            PUBLIC -DCODSPEED_SIMULATION
+            PUBLIC -DCODSPEED_ANALYSIS
         )
     elseif(CODSPEED_MODE STREQUAL "walltime")
         target_compile_definitions(codspeed PUBLIC -DCODSPEED_WALLTIME)

google_benchmark/include/benchmark/benchmark.h

@@ -946,7 +946,7 @@ class BENCHMARK_EXPORT BENCHMARK_INTERNAL_CACHELINE_ALIGNED State {
 
  public:
   const IterationCount max_iterations;
-#if defined(CODSPEED_SIMULATION) || defined(CODSPEED_WALLTIME)
+#if defined(CODSPEED_ANALYSIS) || defined(CODSPEED_WALLTIME)
   codspeed::CodSpeed* codspeed_;
 #endif
 #ifdef CODSPEED_WALLTIME
@@ -974,7 +974,7 @@ class BENCHMARK_EXPORT BENCHMARK_INTERNAL_CACHELINE_ALIGNED State {
         internal::ThreadTimer* timer, internal::ThreadManager* manager,
         internal::PerfCountersMeasurement* perf_counters_measurement,
         ProfilerManager* profiler_manager
-#if defined(CODSPEED_SIMULATION) || defined(CODSPEED_WALLTIME)
+#if defined(CODSPEED_ANALYSIS) || defined(CODSPEED_WALLTIME)
         ,
         codspeed::CodSpeed* codspeed = NULL
 #endif
@@ -1074,12 +1074,12 @@ struct State::StateIterator {
     if (BENCHMARK_BUILTIN_EXPECT(cached_ != 0, true)) {
       return true;
     }
-#ifdef CODSPEED_SIMULATION
+#ifdef CODSPEED_ANALYSIS
     measurement_stop();
 #endif
     parent_->FinishKeepRunning();
 
-#ifdef CODSPEED_SIMULATION
+#ifdef CODSPEED_ANALYSIS
     if (parent_->codspeed_ != NULL) {
       parent_->codspeed_->end_benchmark();
     }
@@ -1096,14 +1096,14 @@ inline BENCHMARK_ALWAYS_INLINE State::StateIterator State::begin() {
   return StateIterator(this);
 }
 inline BENCHMARK_ALWAYS_INLINE State::StateIterator State::end() {
-#ifdef CODSPEED_SIMULATION
+#ifdef CODSPEED_ANALYSIS
   if (this->codspeed_ != NULL) {
     this->codspeed_->start_benchmark(name_);
   }
 #endif
 
   StartKeepRunning();
-#ifdef CODSPEED_SIMULATION
+#ifdef CODSPEED_ANALYSIS
   measurement_start();
 #endif
   return StateIterator();

google_benchmark/src/benchmark.cc

@@ -186,7 +186,7 @@ State::State(std::string name, IterationCount max_iters,
              internal::ThreadTimer* timer, internal::ThreadManager* manager,
              internal::PerfCountersMeasurement* perf_counters_measurement,
              ProfilerManager* profiler_manager
-#if defined(CODSPEED_SIMULATION) || defined(CODSPEED_WALLTIME)
+#if defined(CODSPEED_ANALYSIS) || defined(CODSPEED_WALLTIME)
              ,
              codspeed::CodSpeed* codspeed
 #endif
@@ -196,7 +196,7 @@ State::State(std::string name, IterationCount max_iters,
     : total_iterations_(0),
       batch_leftover_(0),
       max_iterations(max_iters),
-#if defined(CODSPEED_SIMULATION) || defined(CODSPEED_WALLTIME)
+#if defined(CODSPEED_ANALYSIS) || defined(CODSPEED_WALLTIME)
       codspeed_(codspeed),
 #endif
 #ifdef CODSPEED_WALLTIME
@@ -465,7 +465,7 @@ void RunBenchmarks(const std::vector<BenchmarkInstance>& benchmarks,
 #ifdef CODSPEED_ENABLED
   auto& Err = display_reporter->GetErrorStream();
   // Determine the width of the name field using a minimum width of 10.
-#ifdef CODSPEED_SIMULATION
+#ifdef CODSPEED_ANALYSIS
   Err << "Codspeed mode: simulation" << "\n";
 #elif defined(CODSPEED_WALLTIME)
   Err << "Codspeed mode: walltime" << "\n";

google_benchmark/src/benchmark_api_internal.cc

@@ -91,8 +91,8 @@ BenchmarkInstance::BenchmarkInstance(Benchmark* benchmark, int family_idx,
   teardown_ = benchmark_.teardown_;
 }
 
-#ifdef CODSPEED_SIMULATION
-State BenchmarkInstance::RunSimulation(
+#ifdef CODSPEED_ANALYSIS
+State BenchmarkInstance::RunAnalysis(
     codspeed::CodSpeed* codspeed, internal::ThreadTimer* timer,
     internal::ThreadManager* manager,
     internal::PerfCountersMeasurement* perf_counters_measurement,
@@ -103,7 +103,7 @@ State BenchmarkInstance::RunSimulation(
   internal::ThreadTimer warmup_timer = internal::ThreadTimer::Create();
   State warmup_state(name_.function_name, 1, args_, 0, 1, &warmup_timer,
                      manager, perf_counters_measurement, profiler_manager,
-                     NULL);
+                     NULL, /*is_warmup=*/true );
   benchmark_.Run(warmup_state);
 
   State st(name().str(), 1, args_, 0, 1, timer, manager,
@@ -119,7 +119,7 @@ State BenchmarkInstance::__codspeed_root_frame__Run(
     internal::ThreadManager* manager,
     internal::PerfCountersMeasurement* perf_counters_measurement,
     ProfilerManager* profiler_manager, bool is_warmup) const {
-#if defined(CODSPEED_SIMULATION) || defined(CODSPEED_WALLTIME)
+#if defined(CODSPEED_ANALYSIS) || defined(CODSPEED_WALLTIME)
   State st(name_.function_name, iters, args_, thread_id, threads_, timer,
            manager, perf_counters_measurement, profiler_manager, codspeed::CodSpeed::getInstance(), is_warmup);
 #else

google_benchmark/src/benchmark_api_internal.h

@@ -9,7 +9,7 @@
 #include <vector>
 
 #include "benchmark/benchmark.h"
-#ifdef CODSPEED_SIMULATION
+#ifdef CODSPEED_ANALYSIS
 #include "codspeed.h"
 #endif
 #include "commandlineflags.h"
@@ -38,7 +38,7 @@ class BenchmarkInstance {
   BigOFunc* complexity_lambda() const { return complexity_lambda_; }
   const std::vector<Statistics>& statistics() const { return statistics_; }
   int repetitions() const {
-#ifdef CODSPEED_SIMULATION
+#ifdef CODSPEED_ANALYSIS
     (void)repetitions_;
     return 1;
 #else
@@ -57,8 +57,8 @@ class BenchmarkInstance {
                 internal::PerfCountersMeasurement* perf_counters_measurement,
                 ProfilerManager* profiler_manager, bool is_warmup = false) const;
 
-#ifdef CODSPEED_SIMULATION
-  State RunSimulation(
+#ifdef CODSPEED_ANALYSIS
+  State RunAnalysis(
       codspeed::CodSpeed* codspeed, internal::ThreadTimer* timer,
       internal::ThreadManager* manager,
       internal::PerfCountersMeasurement* perf_counters_measurement,

google_benchmark/src/benchmark_runner.cc

@@ -461,13 +461,13 @@ void BenchmarkRunner::RunProfilerManager(IterationCount profile_iterations) {
 }
 
 void BenchmarkRunner::DoOneRepetition() {
-#ifdef CODSPEED_SIMULATION
+#ifdef CODSPEED_ANALYSIS
   std::unique_ptr<internal::ThreadManager> manager;
   manager.reset(new internal::ThreadManager(b.threads()));
   internal::ThreadTimer timer = internal::ThreadTimer::Create();
   b.Setup();
-  State st = b.RunSimulation(codspeed::CodSpeed::getInstance(), &timer,
-                             manager.get(), nullptr, nullptr);
+  State st = b.RunAnalysis(codspeed::CodSpeed::getInstance(), &timer,
+                           manager.get(), nullptr, nullptr);
   b.Teardown();
 
   return;