Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Count all intercepted allocations/deallocations in order to build a small leak-checker.
[simgrid.git] / src / smpi / internals / smpi_utils.cpp
index 78a50c4..cec9084 100644 (file)
@@ -15,6 +15,7 @@
 #include "smpi_config.hpp"
 #include "src/simix/smx_private.hpp"
 #include <algorithm>
+#include "private.hpp"
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_utils, smpi, "Logging specific to SMPI (utils)");
 
@@ -29,14 +30,24 @@ double total_benched_time=0;
 unsigned long total_malloc_size=0;
 unsigned long total_shared_size=0;
 unsigned int total_shared_calls=0;
-struct MaxMalloc {
+struct alloc_metadata_t {
   size_t size          = 0;
   unsigned int numcall = 0;
   int line             = 0;
   std::string file;
 };
-MaxMalloc max_malloc;
+
+struct current_buffer_metadata_t {
+  alloc_metadata_t alloc;
+  std::string name;
+};
+
+alloc_metadata_t max_malloc;
 F2C* current_handle = nullptr;
+current_buffer_metadata_t current_buffer1;
+current_buffer_metadata_t current_buffer2;
+
+std::unordered_map<const void*, alloc_metadata_t> allocs;
 
 std::vector<s_smpi_factor_t> parse_factor(const std::string& smpi_coef_string)
 {
@@ -101,21 +112,32 @@ void add_benched_time(double time){
   total_benched_time += time;
 }
 
-void account_malloc_size(size_t size, const char* file, int line){
-  total_malloc_size += size;
-  if(size > max_malloc.size){
-    max_malloc.size = size;
-    max_malloc.line = line;
-    max_malloc.numcall = 1;
-    max_malloc.file = std::string(file);
-  }else if(size == max_malloc.size && max_malloc.line == line && not max_malloc.file.compare(file)){
-    max_malloc.numcall++;
+void account_malloc_size(size_t size, std::string file, int line, void* ptr){
+  if (smpi_cfg_display_alloc()) {
+    alloc_metadata_t metadata;
+    metadata.size = size;
+    metadata.line = line;
+    metadata.numcall = 1;
+    metadata.file = std::string(file);
+    allocs.insert(std::make_pair(ptr, metadata));
+
+    total_malloc_size += size;
+    if(size > max_malloc.size){
+      max_malloc.size = size;
+      max_malloc.line = line;
+      max_malloc.numcall = 1;
+      max_malloc.file = std::string(file);
+    }else if(size == max_malloc.size && max_malloc.line == line && not max_malloc.file.compare(file)){
+      max_malloc.numcall++;
+    }
   }
 }
 
 void account_shared_size(size_t size){
-  total_shared_size += size;
-  total_shared_calls++;
+  if (smpi_cfg_display_alloc()) {
+    total_shared_size += size;
+    total_shared_calls++;
+  }
 }
 
 void print_time_analysis(double global_time){
@@ -132,43 +154,69 @@ void print_time_analysis(double global_time){
 
 void print_memory_analysis()
 {
-  // Put the leaked non-default handles in a vector to sort them by id
-  std::vector<std::pair<unsigned int, smpi::F2C*>> handles;
-  if (simgrid::smpi::F2C::lookup() != nullptr)
-    std::copy_if(simgrid::smpi::F2C::lookup()->begin(), simgrid::smpi::F2C::lookup()->end(),
-                 std::back_inserter(handles),
-                 [](auto const& entry) { return entry.first >= simgrid::smpi::F2C::get_num_default_handles(); });
-
-  if (not handles.empty()) {
-    XBT_INFO("Probable memory leaks in your code: SMPI detected %zu unfreed MPI handles : "
-             "display types and addresses (n max) with --cfg=smpi/list-leaks:n.\n"
-             "Running smpirun with -wrapper \"valgrind --leak-check=full\" can provide more information",
-             handles.size());
+  if (smpi_cfg_display_alloc()) {
+    // Put the leaked non-default handles in a vector to sort them by id
+    std::vector<std::pair<unsigned int, smpi::F2C*>> handles;
+    if (simgrid::smpi::F2C::lookup() != nullptr)
+      std::copy_if(simgrid::smpi::F2C::lookup()->begin(), simgrid::smpi::F2C::lookup()->end(),
+                   std::back_inserter(handles),
+                   [](auto const& entry) { return entry.first >= simgrid::smpi::F2C::get_num_default_handles(); });
+
     auto max = static_cast<unsigned long>(simgrid::config::get_value<int>("smpi/list-leaks"));
-    if (max > 0) { // we cannot trust F2C::lookup()->size() > F2C::get_num_default_handles() because some default
-                   // handles are already freed at this point
-      std::sort(handles.begin(), handles.end(), [](auto const& a, auto const& b) { return a.first < b.first; });
-      bool truncate = max < handles.size();
-      if (truncate)
-        handles.resize(max);
-      bool printed_advice=false;
-      for (const auto& p : handles) {
-        if (xbt_log_no_loc || p.second->call_location().empty()) {
-          if (!printed_advice){
-            XBT_INFO("To get more information (location of allocations), compile your code with -trace-call-location flag of smpicc/f90");
-            printed_advice=true;
+    if (not handles.empty()) {
+      XBT_INFO("Probable memory leaks in your code: SMPI detected %zu unfreed MPI handles : "
+               "display types and addresses (n max) with --cfg=smpi/list-leaks:n.\n"
+               "Running smpirun with -wrapper \"valgrind --leak-check=full\" can provide more information",
+               handles.size());
+      if (max > 0) { // we cannot trust F2C::lookup()->size() > F2C::get_num_default_handles() because some default
+                     // handles are already freed at this point
+        std::sort(handles.begin(), handles.end(), [](auto const& a, auto const& b) { return a.first < b.first; });
+        bool truncate = max < handles.size();
+        if (truncate)
+          handles.resize(max);
+        bool printed_advice=false;
+        for (const auto& p : handles) {
+          if (xbt_log_no_loc || p.second->call_location().empty()) {
+            if (!printed_advice){
+              XBT_INFO("To get more information (location of allocations), compile your code with -trace-call-location flag of smpicc/f90");
+              printed_advice=true;
+            }
+            XBT_INFO("Leaked handle of type %s", p.second->name().c_str());
+          } else {
+            XBT_INFO("Leaked handle of type %s at %s", p.second->name().c_str(), p.second->call_location().c_str());
           }
-          XBT_INFO("Leaked handle of type %s", p.second->name().c_str());
-        } else {
-          XBT_INFO("Leaked handle of type %s at %s", p.second->name().c_str(), p.second->call_location().c_str());
         }
+        if (truncate)
+          XBT_INFO("(more handle leaks hidden as you wanted to see only %lu of them)", max);
+      }
+    }
+
+    if (not allocs.empty()) {
+      std::vector<std::pair<const void*, alloc_metadata_t>> leaks;
+      std::copy(allocs.begin(),
+              allocs.end(),
+              std::back_inserter<std::vector<std::pair<const void*, alloc_metadata_t>>>(leaks));
+      XBT_INFO("Probable memory leaks in your code: SMPI detected %zu unfreed buffers : "
+               "display types and addresses (n max) with --cfg=smpi/list-leaks:n.\n"
+               "Running smpirun with -wrapper \"valgrind --leak-check=full\" can provide more information",
+               leaks.size());
+      if (max > 0) {
+        std::sort(leaks.begin(), leaks.end(), [](auto const& a, auto const& b) { return a.second.size < b.second.size; });
+        bool truncate = max < leaks.size();
+        if (truncate)
+          leaks.resize(max);
+        for (const auto& p : leaks) {
+          if (xbt_log_no_loc) {
+            XBT_INFO("Leaked buffer of size %zu", p.second.size);
+          } else {
+            XBT_INFO("Leaked buffer of size %zu, allocated in file %s at line %d", p.second.size, p.second.file.c_str(), p.second.line);
+          }
+        }
+        if (truncate)
+          XBT_INFO("(more buffer leaks hidden as you wanted to see only %lu of them)", max);
       }
-      if (truncate)
-        XBT_INFO("(more handle leaks hidden as you wanted to see only %lu of them)", max);
     }
-  }
 
-  if (simgrid::config::get_value<bool>("smpi/display-allocs")) {
     if(total_malloc_size != 0)
       XBT_INFO("Memory Usage: Simulated application allocated %lu bytes during its lifetime through malloc/calloc calls.\n"
              "Largest allocation at once from a single process was %zu bytes, at %s:%d. It was called %u times during the whole simulation.\n"
@@ -198,6 +246,52 @@ void print_current_handle(){
   }
 }
 
+void set_current_buffer(int i, const char* name, const void* buf){
+  //clear previous one
+  if(i==1){
+    if(not current_buffer1.name.empty()){
+      current_buffer1.name="";
+    }
+    if(not current_buffer2.name.empty()){
+      current_buffer2.name="";
+    }
+  }
+  auto meta = allocs.find(buf);
+  if (meta == allocs.end()) {
+    XBT_DEBUG("Buffer %p was not allocated with malloc/calloc", buf);
+    return;
+  }
+  if(i==1){
+    current_buffer1.alloc = meta->second;
+    current_buffer1.name = name;
+  }else{
+    current_buffer2.alloc=meta->second;
+    current_buffer2.name=name;
+  }
+}
+
+void print_buffer_info(){
+    if(not current_buffer1.name.empty())
+      XBT_INFO("Buffer %s was allocated from %s line %d, with size %zu", current_buffer1.name.c_str(), current_buffer1.alloc.file.c_str(), current_buffer1.alloc.line, current_buffer1.alloc.size);
+    if(not current_buffer2.name.empty())
+      XBT_INFO("Buffer %s was allocated from %s line %d, with size %zu", current_buffer2.name.c_str(), current_buffer2.alloc.file.c_str(), current_buffer2.alloc.line, current_buffer2.alloc.size);    
+}
+
+size_t get_buffer_size(const void* buf){
+  auto meta = allocs.find(buf);
+  if (meta == allocs.end()) {
+    //we don't know this buffer (on stack or feature disabled), assume it's fine.
+    return  std::numeric_limits<std::size_t>::max();
+  }
+  return meta->second.size;
+}
+
+void account_free(const void* ptr){
+  if (smpi_cfg_display_alloc()) {
+    allocs.erase(ptr);
+  }
+}
+
 }
 }
 } // namespace simgrid