Refactor energy profiler timing functions

Author: DaKerboul

profiling/energy-profiler/kp_energy_profiler.cpp

@@ -20,7 +20,6 @@
 #include <cstdint>
 #include <cstdio>
 #include <cstdlib>
-#include <cstring>
 #include <iostream>
 #include <mutex>
 #include <string>
@@ -93,7 +92,8 @@ void end_region_by_type(RegionType type_to_end) {
 // End region by id
 void end_region_with_id(uint64_t expected_id) {
   try {
-    auto& state = EnergyProfilerState::get_instance();
+    auto end_time = std::chrono::high_resolution_clock::now();
+    auto& state   = EnergyProfilerState::get_instance();
     std::lock_guard<std::mutex> lock(state.get_mutex());
     auto& active_regions = state.get_active_regions();
     if (active_regions.empty()) {
@@ -106,9 +106,9 @@ void end_region_with_id(uint64_t expected_id) {
                              return region.id == expected_id;
                            });
     if (it != active_regions.end()) {
-      auto region = *it;
+      auto region     = *it;
+      region.end_time = end_time;
       active_regions.erase(it);
-      region.end_time = std::chrono::high_resolution_clock::now();
       state.get_completed_timings().push_back(region);
     } else {
       std::cerr << "Warning: No active region found with ID " << expected_id
@@ -154,7 +154,9 @@ void kokkosp_init_library(const int loadSeq, const uint64_t interfaceVer,
                           Kokkos_Profiling_KokkosPDeviceInfo* deviceInfo) {
   (void)devInfoCount;
   (void)deviceInfo;
-  if (std::getenv("KOKKOS_TOOLS_ENERGY_VERBOSE")) {
+  const char* verbose_env = std::getenv("KOKKOS_TOOLS_ENERGY_VERBOSE");
+  if (verbose_env &&
+      (std::string(verbose_env) == "1" || std::string(verbose_env) == "ON")) {
     KokkosTools::EnergyProfiler::EnergyProfilerState::get_instance()
         .set_verbose_enabled(true);
   }
@@ -170,7 +172,8 @@ void kokkosp_finalize_library() {
   printf("Kokkos Energy Profiler: Finalizing library\n");
   std::string prefix = KokkosTools::EnergyProfiler::generate_prefix();
   auto all_timings   = KokkosTools::EnergyProfiler::get_all_timings();
-  KokkosTools::EnergyProfiler::print_all_timings_summary(all_timings);
+  KokkosTools::EnergyProfiler::print_all_timings_summary(
+      std::cout, all_timings.begin(), all_timings.end());
   KokkosTools::EnergyProfiler::export_all_timings_csv(
       all_timings, prefix + "_timing_data.csv");
   printf("Kokkos Energy Profiler: Library finalized\n");

profiling/energy-profiler/timing_export.cpp

@@ -59,27 +59,29 @@ std::string get_category_from_type(RegionType type) {
   }
 }
 
-void print_all_timings_summary(const std::vector<TimingInfo>& all_timings) {
-  std::cout << "\n==== TIMING SUMMARY ====\n";
-  std::cout << "| Category   | Name                             | Type         "
-               "  | Start (ms)        | End (ms)          | Duration (ms) |\n";
-  std::cout << "|------------|----------------------------------|--------------"
-               "--|-------------------|-------------------|---------------|\n";
-  for (const auto& timing_info : all_timings) {
-    auto start_ms = get_epoch_ms(timing_info.start_time);
-    auto end_ms   = get_epoch_ms(timing_info.end_time);
+void print_all_timings_summary(std::ostream& os,
+                               std::vector<TimingInfo>::const_iterator begin,
+                               std::vector<TimingInfo>::const_iterator end) {
+  os << "\n==== TIMING SUMMARY ====\n";
+  os << "| Category   | Name                             | Type         "
+        "  | Start (ms)        | End (ms)          | Duration (ms) |\n";
+  os << "|------------|----------------------------------|--------------"
+        "--|-------------------|-------------------|---------------|\n";
+  for (auto it = begin; it != end; ++it) {
+    const auto& timing_info = *it;
+    auto start_ms           = get_epoch_ms(timing_info.start_time);
+    auto end_ms             = get_epoch_ms(timing_info.end_time);
     auto duration_ms =
         get_duration_ms(timing_info.start_time, timing_info.end_time);
     std::string type_str = region_type_to_string(timing_info.type);
     std::string category = get_category_from_type(timing_info.type);
-    std::cout << "| " << std::setw(COLUMN_WIDTH_CATEGORY) << std::left
-              << category << " | " << std::setw(COLUMN_WIDTH_NAME) << std::left
-              << timing_info.name << " | " << std::setw(COLUMN_WIDTH_TYPE)
-              << std::left << type_str << " | " << std::setw(COLUMN_WIDTH_TIME)
-              << std::right << start_ms << " | " << std::setw(COLUMN_WIDTH_TIME)
-              << std::right << end_ms << " | "
-              << std::setw(COLUMN_WIDTH_DURATION) << std::right << duration_ms
-              << " |\n";
+    os << "| " << std::setw(COLUMN_WIDTH_CATEGORY) << std::left << category
+       << " | " << std::setw(COLUMN_WIDTH_NAME) << std::left << timing_info.name
+       << " | " << std::setw(COLUMN_WIDTH_TYPE) << std::left << type_str
+       << " | " << std::setw(COLUMN_WIDTH_TIME) << std::right << start_ms
+       << " | " << std::setw(COLUMN_WIDTH_TIME) << std::right << end_ms << " | "
+       << std::setw(COLUMN_WIDTH_DURATION) << std::right << duration_ms
+       << " |\n";
   }
 }
 

profiling/energy-profiler/timing_export.hpp

@@ -25,7 +25,9 @@ namespace EnergyProfiler {
 
 void export_all_timings_csv(const std::vector<TimingInfo>& all_timings,
                             const std::string& filename);
-void print_all_timings_summary(const std::vector<TimingInfo>& all_timings);
+void print_all_timings_summary(std::ostream& os,
+                               std::vector<TimingInfo>::const_iterator begin,
+                               std::vector<TimingInfo>::const_iterator end);
 
 }  // namespace EnergyProfiler
 }  // namespace KokkosTools

profiling/energy-profiler/timing_utils.hpp

@@ -96,26 +96,6 @@ void set_verbose_enabled(bool enabled);
 void log_verbose(const char* format, ...);
 std::vector<TimingInfo> get_all_timings();
 
-/// @brief RAII class for automatic timing region management
-class ScopedTimingRegion {
- public:
-  ScopedTimingRegion(const std::string& name, RegionType type)
-      : region_id_(generate_new_region_id()) {
-    start_region(name, type, region_id_);
-  }
-
-  ~ScopedTimingRegion() { end_region_with_id(region_id_); }
-
-  // Delete copy and move operations
-  ScopedTimingRegion(const ScopedTimingRegion&)            = delete;
-  ScopedTimingRegion& operator=(const ScopedTimingRegion&) = delete;
-  ScopedTimingRegion(ScopedTimingRegion&&)                 = delete;
-  ScopedTimingRegion& operator=(ScopedTimingRegion&&)      = delete;
-
- private:
-  uint64_t region_id_;
-};
-
 // Filename prefix generation
 /// @brief Generate a prefix for output files based on hostname and PID
 std::string generate_prefix();