Merge pull request #115 from cindytsai/valgrind

Add method for Python to call valgrind massif detailed snapshot

Author: cindytsai

CMakeLists.txt

@@ -13,13 +13,15 @@ option(INTERACTIVE_MODE  "Use interactive mode"
 option(JUPYTER_KERNEL    "Use Jupyter notebook interface"                            OFF)
 option(SUPPORT_TIMER     "Support time profiling"                                    OFF)
 option(USE_PYBIND11      "Use pybind11"                                              OFF)
+option(SUPPORT_VALGRIND  "Support valgrind"                                          OFF)
 
 ## set paths ##
 # It is recommended that we always provide PYTHON_PATH and MPI_PATH.
 # libyt will also try to find the package if the paths weren't provided.
 set(PYTHON_PATH    "" CACHE PATH "Path to Python installation prefix (Always)")
 set(MPI_PATH       "" CACHE PATH "Path to MPI installation prefix (-DSERIAL_MODE=OFF)")
 set(READLINE_PATH  "" CACHE PATH "Path to Readline installation prefix (-DINTERACTIVE_MODE=ON)")
+set(VALGRIND_PATH  "" CACHE PATH "Path to valgrind installation prefix (-DSUPPORT_VALGRIND=ON / -DLIBYT_RUN_MEMORY_PROFILE=ON)")
 
 ## set paths (optional) ##
 # libyt will get the dependencies if it cannot find one when needed.
@@ -40,8 +42,6 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
 option(BUILD_SHARED_LIBS "Building using shared libraries"                           ON )
 
 # run test ##
-set(VALGRIND_PATH     "" CACHE PATH "Path to valgrind installation prefix (-DLIBYT_RUN_MEMORY_PROFILE=ON)")
-
 option(LIBYT_RUN_TEST                "Run unit test"                                 OFF)
 option(LIBYT_RUN_MEMORY_PROFILE      "Run memory profile"                            OFF)
 

src/CMakeLists.txt

@@ -73,14 +73,17 @@ set_option(INTERACTIVE_MODE)
 set_option(JUPYTER_KERNEL)
 set_option(SUPPORT_TIMER)
 set_option(USE_PYBIND11)
+set_option(SUPPORT_VALGRIND)
 
 # include dir
 target_include_directories(
   yt
   PRIVATE
     ${PROJECT_SOURCE_DIR}/include
-    $<$<NOT:$<BOOL:${SERIAL_MODE}>>:${MPI_CXX_INCLUDE_DIRS}> ${Python_INCLUDE_DIRS}
+    $<$<NOT:$<BOOL:${SERIAL_MODE}>>:${MPI_CXX_INCLUDE_DIRS}>
+    ${Python_INCLUDE_DIRS}
     $<$<BOOL:${INTERACTIVE_MODE}>:${Readline_INCLUDE_DIR}>
+    $<$<BOOL:${SUPPORT_VALGRIND}>:${VALGRIND_PATH}/include>
 )
 
 # link lib

src/libyt_python_module.cpp

@@ -15,6 +15,10 @@
 #include <pybind11/pytypes.h>
 #endif
 
+#ifdef SUPPORT_VALGRIND
+#include <valgrind/valgrind.h>
+#endif
+
 //-------------------------------------------------------------------------------------------------------
 // Description :  List of libyt C extension python methods built using Pybind11 API
 //
@@ -514,6 +518,16 @@ pybind11::object GetParticleRemote(const pybind11::dict& py_ptf,
 #endif  // #ifndef SERIAL_MODE
 }
 
+#ifdef SUPPORT_VALGRIND
+pybind11::object DumpValgrindDetailedSnapshot(const char* filename) {
+  std::string valgrind_cmd = "detailed_snapshot ";
+  valgrind_cmd += filename;
+
+  VALGRIND_MONITOR_COMMAND(valgrind_cmd.c_str());
+  return pybind11::none();
+}
+#endif
+
 PYBIND11_EMBEDDED_MODULE(libyt, m) {
   SET_TIMER(__PRETTY_FUNCTION__);
 
@@ -561,6 +575,11 @@ PYBIND11_EMBEDDED_MODULE(libyt, m) {
   m.def("get_particle_remote",
         &GetParticleRemote,
         pybind11::return_value_policy::take_ownership);
+#ifdef SUPPORT_VALGRIND
+  m.def("dump_valgrind_detailed_snapshot",
+        &DumpValgrindDetailedSnapshot,
+        pybind11::return_value_policy::take_ownership);
+#endif
 }
 
 #else  // #ifdef USE_PYBIND11
@@ -1120,6 +1139,25 @@ static PyObject* LibytParticleGetParticleRemote(PyObject* self, PyObject* args)
 #endif  // #ifndef SERIAL_MODE
 }
 
+#ifdef SUPPORT_VALGRIND
+static PyObject* LibytDumpValgrindDetailedSnapshot(PyObject* self, PyObject* args) {
+  char* filename;
+  if (!PyArg_ParseTuple(args, "s", &filename)) {
+    PyErr_SetString(
+        PyExc_TypeError,
+        "Wrong input type, expect to be libyt.dump_valgrind_detailed_snapshot(str).");
+    return NULL;
+  }
+
+  std::string valgrind_cmd = "detailed_snapshot ";
+  valgrind_cmd += filename;
+
+  VALGRIND_MONITOR_COMMAND(valgrind_cmd.c_str());
+
+  Py_RETURN_NONE;
+}
+#endif
+
 //-------------------------------------------------------------------------------------------------------
 // Description :  Preparation for creating libyt python module
 //
@@ -1152,6 +1190,12 @@ static PyMethodDef libyt_method_list[] = {
      LibytParticleGetParticleRemote,
      METH_VARARGS,
      "Get remote particle attribute data."},
+#ifdef SUPPORT_VALGRIND
+    {"dump_valgrind_detailed_snapshot",
+     LibytDumpValgrindDetailedSnapshot,
+     METH_VARARGS,
+     "Dump valgrind detailed snapshot."},
+#endif
     {NULL, NULL, 0, NULL}  // sentinel
 };