perf_timer: new class and macros to make performance logs easier

Call PERF_TIMER(name), which is scoped.

3 files changed, 142 insertions, 1 deletions

diff --git a/src/common/CMakeLists.txt b/src/common/CMakeLists.txt
index 6bf8b1777..4b6149cbd 100644
--- a/src/common/CMakeLists.txt
+++ b/src/common/CMakeLists.txt
@@ -31,7 +31,8 @@ set(common_sources
   command_line.cpp
   dns_utils.cpp
   util.cpp
-  i18n.cpp)
+  i18n.cpp
+  perf_timer.cpp)
 
 if (STACK_TRACE)
   list(APPEND common_sources stack_trace.cpp)
@@ -53,6 +54,7 @@ set(common_private_headers
   util.h
   varint.h
   i18n.h
+  perf_timer.h
   stack_trace.h)
 
 monero_private_headers(common
diff --git a/src/common/perf_timer.cpp b/src/common/perf_timer.cpp
new file mode 100644
index 000000000..d23c9f11d
--- /dev/null
+++ b/src/common/perf_timer.cpp
@@ -0,0 +1,47 @@
+// Copyright (c) 2016, The Monero Project
+// 
+// All rights reserved.
+// 
+// Redistribution and use in source and binary forms, with or without modification, are
+// permitted provided that the following conditions are met:
+// 
+// 1. Redistributions of source code must retain the above copyright notice, this list of
+//    conditions and the following disclaimer.
+// 
+// 2. Redistributions in binary form must reproduce the above copyright notice, this list
+//    of conditions and the following disclaimer in the documentation and/or other
+//    materials provided with the distribution.
+// 
+// 3. Neither the name of the copyright holder nor the names of its contributors may be
+//    used to endorse or promote products derived from this software without specific
+//    prior written permission.
+// 
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
+// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+// THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+#include "perf_timer.h"
+
+namespace tools
+{
+
+int performance_timer_log_level = 2;
+__thread std::vector<PerformanceTimer*> *performance_timers = NULL;
+
+void set_performance_timer_log_level(int level)
+{
+  if (level < LOG_LEVEL_MIN || level > LOG_LEVEL_MAX)
+  {
+    LOG_PRINT_L0("Wrong log level: " << level << ", using 2");
+    level = 2;
+  }
+  performance_timer_log_level = level;
+}
+
+}
diff --git a/src/common/perf_timer.h b/src/common/perf_timer.h
new file mode 100644
index 000000000..3d732012d
--- /dev/null
+++ b/src/common/perf_timer.h
@@ -0,0 +1,92 @@
+// Copyright (c) 2016, The Monero Project
+// 
+// All rights reserved.
+// 
+// Redistribution and use in source and binary forms, with or without modification, are
+// permitted provided that the following conditions are met:
+// 
+// 1. Redistributions of source code must retain the above copyright notice, this list of
+//    conditions and the following disclaimer.
+// 
+// 2. Redistributions in binary form must reproduce the above copyright notice, this list
+//    of conditions and the following disclaimer in the documentation and/or other
+//    materials provided with the distribution.
+// 
+// 3. Neither the name of the copyright holder nor the names of its contributors may be
+//    used to endorse or promote products derived from this software without specific
+//    prior written permission.
+// 
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
+// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+// THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+#pragma once
+
+#include <string>
+#include <stdio.h>
+#include "misc_log_ex.h"
+
+namespace tools
+{
+
+class PerformanceTimer;
+
+extern int performance_timer_log_level;
+extern __thread std::vector<PerformanceTimer*> *performance_timers;
+
+class PerformanceTimer
+{
+public:
+  PerformanceTimer(const std::string &s, int l = LOG_LEVEL_2): name(s), level(l), started(false)
+  {
+    ticks = epee::misc_utils::get_tick_count();
+    if (!performance_timers)
+    {
+      LOG_PRINT("PERF             ----------", level);
+      performance_timers = new std::vector<PerformanceTimer*>();
+    }
+    else
+    {
+      PerformanceTimer *pt = performance_timers->back();
+      if (!pt->started)
+      {
+        LOG_PRINT("PERF           " << std::string((performance_timers->size()-1) * 2, ' ') << "  " << pt->name, pt->level);
+        pt->started = true;
+      }
+    }
+    performance_timers->push_back(this);
+  }
+
+  ~PerformanceTimer()
+  {
+    performance_timers->pop_back();
+    ticks = epee::misc_utils::get_tick_count() - ticks;
+    char s[12];
+    snprintf(s, sizeof(s), "%8lu  ", ticks);
+    LOG_PRINT("PERF " << s << std::string(performance_timers->size() * 2, ' ') << "  " << name, level);
+    if (performance_timers->empty())
+    {
+      delete performance_timers;
+      performance_timers = NULL;
+    }
+  }
+
+private:
+  std::string name;
+  int level;
+  uint64_t ticks;
+  bool started;
+};
+
+void set_performance_timer_log_level(int level);
+
+#define PERF_TIMER(name) tools::PerformanceTimer pt_##name(#name, tools::performance_timer_log_level)
+#define PERF_TIMER_L(name, l) tools::PerformanceTimer pt_##name(#name, l)
+
+}