Merge pull request #2 from solvcon/feature/profile

Add a simple profiler

Author: yungyuc

CMakeLists.txt

@@ -14,10 +14,18 @@ set(CMAKE_EXPORT_COMPILE_COMMANDS ON CACHE BOOL "Export compile commands")
 option(HIDE_SYMBOL "hide the symbols of python wrapper" OFF)
 message(STATUS "HIDE_SYMBOL: ${HIDE_SYMBOL}")
 
+option(DEBUG_SYMBOL "add debug information" ON)
+message(STATUS "DEBUG_SYMBOL: ${DEBUG_SYMBOL}")
 if(DEBUG_SYMBOL)
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g")
 endif()
 
+option(MODMESH_PROFILE "enable profiler" OFF)
+message(STATUS "MODMESH_PROFILE: ${MODMESH_PROFILE}")
+if(MODMESH_PROFILE)
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DMODMESH_PROFILE")
+endif()
+
 option(pybind11_path "pybind11 path")
 find_package(pybind11 REQUIRED PATHS ${pybind11_path})
 message(STATUS "pybind11_INCLUDE_DIRS: ${pybind11_INCLUDE_DIRS}")
@@ -32,6 +40,7 @@ include_directories("include")
 set(MODMESH_HEADERS
     include/modmesh/modmesh.hpp
     include/modmesh/base.hpp
+    include/modmesh/profile.hpp
     include/modmesh/grid.hpp
 )
 string(REPLACE "include/" "${CMAKE_CURRENT_SOURCE_DIR}/include/"

Makefile

@@ -10,6 +10,7 @@
 
 HIDE_SYMBOL ?= OFF
 DEBUG_SYMBOL ?= ON
+MODMESH_PROFILE ?= OFF
 USE_CLANG_TIDY ?= OFF
 CMAKE_BUILD_TYPE ?= Release
 MODMESH_ROOT ?= $(shell pwd)
@@ -70,6 +71,7 @@ $(BUILD_PATH)/Makefile: CMakelists.txt Makefile
 		-DCMAKE_BUILD_TYPE=$(CMAKE_BUILD_TYPE) \
 		-DHIDE_SYMBOL=$(HIDE_SYMBOL) \
 		-DDEBUG_SYMBOL=$(DEBUG_SYMBOL) \
+		-DMODMESH_PROFILE=$(MODMESH_PROFILE) \
 		-DUSE_CLANG_TIDY=$(USE_CLANG_TIDY) \
 		-DLINT_AS_ERRORS=ON \
 		$(CMAKE_ARGS)

include/modmesh/base.hpp

@@ -11,6 +11,8 @@
 // Shared by all code.
 #include <algorithm>
 #include <memory>
+#include <iostream>
+#include <map>
 
 #define MODMESH_EXCEPT(CLS, EXC, MSG) throw EXC(#CLS ": " MSG);
 

include/modmesh/grid.hpp

@@ -10,6 +10,7 @@
  */
 
 #include "modmesh/base.hpp"
+#include "modmesh/profile.hpp"
 
 namespace modmesh
 {
@@ -87,6 +88,12 @@ class StaticGrid1d
     real_type   at (size_t it) const { ensure_range(it); return (*this)[it]; }
     real_type & at (size_t it)       { ensure_range(it); return (*this)[it]; }
 
+    void fill(real_type val)
+    {
+        MODMESH_TIME("StaticGrid1d::fill");
+        std::fill(m_coord.get(), m_coord.get()+m_nx, val);
+    }
+
 private:
 
     std::unique_ptr<real_type[]> allocate(serial_type nx)

include/modmesh/modmesh.hpp

@@ -6,6 +6,7 @@
  */
 
 #include "modmesh/base.hpp"
+#include "modmesh/profile.hpp"
 #include "modmesh/grid.hpp"
 
 // vim: set ff=unix fenc=utf8 et sw=4 ts=4 sts=4:

include/modmesh/profile.hpp

@@ -0,0 +1,190 @@
+#pragma once
+
+/*
+ * Copyright (c) 2019, Yung-Yu Chen <[email protected]>
+ * BSD-style license; see COPYING
+ */
+
+#include "modmesh/base.hpp"
+
+/*
+ * MODMESH_PROFILE defined: Enable profiling API.
+ */
+#ifdef MODMESH_PROFILE
+
+#define MODMESH_TIME(NAME) \
+    ScopedTimer local_scoped_timer_ ## __LINE__(NAME);
+
+/*
+ * No MODMESH_PROFILE defined: Disable profiling API.
+ */
+#else // MODMESH_PROFILE
+
+#define MODMESH_TIME(NAME)
+
+#endif // MODMESH_PROFILE
+/*
+ * End MODMESH_PROFILE.
+ */
+
+namespace modmesh
+{
+
+#if __APPLE__
+
+#include <assert.h>
+#include <CoreServices/CoreServices.h>
+#include <mach/mach.h>
+#include <mach/mach_time.h>
+
+struct StopWatch
+{
+
+    StopWatch()
+    {
+        mach_timebase_info(&m_tbinfo);
+        lap();
+    }
+
+    double lap()
+    {
+        m_start = m_end;
+        m_end = mach_absolute_time();
+        uint64_t elapsed = m_end - m_start;
+        return elapsed * m_tbinfo.numer / m_tbinfo.denom * 1.e-9;
+    }
+
+    /// A global singleton.
+    static StopWatch & me()
+    {
+        static StopWatch instance;
+        return instance;
+    }
+
+    mach_timebase_info_data_t m_tbinfo;
+    uint64_t m_start = 0;
+    uint64_t m_end = 0;
+
+}; /* end struct StopWatch */
+
+#elif __linux__
+
+#include <time.h>
+
+struct StopWatch
+{
+    StopWatch()
+    {
+        clock_getres(CLOCK_PROCESS_CPUTIME_ID, &m_res);
+        lap();
+    }
+
+    double lap()
+    {
+        m_start = m_end;
+        clock_gettime(CLOCK_PROCESS_CPUTIME_ID, &m_end);
+        return diff(m_start, m_end) * 1.e-9;
+    }
+
+    int64_t diff(timespec const & t1, timespec const & t2)
+    {
+        timespec temp;
+        int64_t nsec;
+        if ((t2.tv_nsec - t1.tv_nsec)<0)
+        {
+            nsec = 1000000000 + t2.tv_nsec - t1.tv_nsec;
+            nsec += 1000000000 * (t2.tv_sec - t1.tv_sec - 1);
+        }
+        else
+        {
+            nsec = t2.tv_nsec - t1.tv_nsec;
+            nsec += 1000000000 * (t2.tv_sec - t1.tv_sec);
+        }
+        return nsec;
+    }
+
+    /// A global singleton.
+    static StopWatch & me()
+    {
+        static StopWatch instance;
+        return instance;
+    }
+
+    timespec m_res;
+    timespec m_start;
+    timespec m_end;
+
+}; /* end struct StopWatch */
+
+#endif
+
+struct TimedEntry
+{
+    size_t m_count = 0;
+    double m_time = 0.0;
+}; /* end struct TimedEntry */
+
+class TimeRegistry
+{
+
+public:
+
+    static TimeRegistry & me()
+    {
+        static TimeRegistry inst;
+        return inst;
+    }
+
+    void add(const char * name, double time)
+    {
+        auto it = m_time.find(name);
+        if (it == m_time.end())
+        {
+            it = std::get<0>(m_time.insert({name, {0, 0.0}}));
+        }
+        ++(it->second.m_count);
+        it->second.m_time += time;
+    }
+
+    ~TimeRegistry()
+    {
+        for (auto it = m_time.begin() ; it != m_time.end() ; ++it)
+        {
+            std::cout
+                << it->first << " : "
+                << "count = " << it->second.m_count << " , "
+                << "time = " << it->second.m_time << " (second)"
+                << std::endl;
+        }
+    }
+
+private:
+
+    TimeRegistry()
+    {
+    }
+
+    std::map<const char *, TimedEntry> m_time;
+
+}; /* end struct TimeRegistry */
+
+struct ScopedTimer
+{
+
+    ScopedTimer() = delete;
+
+    ScopedTimer(const char * name) : m_name(name) {}
+
+    ~ScopedTimer()
+    {
+        TimeRegistry::me().add(m_name, m_sw.lap());
+    }
+
+    StopWatch m_sw;
+    char const * m_name;
+
+}; /* end struct ScopedTimer */
+
+} /* end namespace modmesh */
+
+// vim: set ff=unix fenc=utf8 et sw=4 ts=4 sts=4:

include/modmesh/python/python.hpp

@@ -78,7 +78,8 @@ WrapBase
 #define DECL_MM_PYBIND_CLASS_METHOD(METHOD) \
     template< class... Args > \
     /* NOLINTNEXTLINE(bugprone-macro-parentheses) */ \
-    wrapper_type & METHOD(Args&&... args) { \
+    wrapper_type & METHOD(Args&&... args) \
+    { \
         m_cls.METHOD(std::forward<Args>(args)...); \
         return *static_cast<wrapper_type*>(this); \
     }
@@ -230,6 +231,12 @@ class WrapStaticGrid1d
                     }
                 }
             )
+            .def
+            (
+                "fill"
+              , &wrapped_type::fill
+              , py::arg("value")
+            )
         ;
 
     }

tests/test_grid1d.py

@@ -39,4 +39,9 @@ def check_life_cycle():
         coord = check_life_cycle()
         self.assertEqual([0, 1, 2, 3, 4], coord.tolist())
 
+    def test_fill(self):
+
+        gd = modmesh.StaticGrid1d(11)
+        gd.fill(102)
+
 # vim: set ff=unix fenc=utf8 et sw=4 ts=4 sts=4: