Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Display leak origin in message, if -trace-call-location is used.
[simgrid.git] / src / smpi / internals / smpi_utils.cpp
index f15557a..90ef155 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2016-2020. The SimGrid Team.
+/* Copyright (c) 2016-2021. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
 #include "xbt/log.h"
 #include "xbt/parse_units.hpp"
 #include "xbt/sysdep.h"
+#include "xbt/file.hpp"
 #include <boost/tokenizer.hpp>
+#include "smpi_config.hpp"
+#include "src/simix/smx_private.hpp"
+#include <algorithm>
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_utils, smpi, "Logging specific to SMPI (utils)");
 
 extern std::string surf_parsed_filename;
 extern int surf_parse_lineno;
 
+namespace simgrid {
+namespace smpi {
+namespace utils {
+
+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 {
+  size_t size          = 0;
+  unsigned int numcall = 0;
+  int line             = 0;
+  std::string file;
+};
+MaxMalloc max_malloc;
+F2C* current_handle=0;
+
 std::vector<s_smpi_factor_t> parse_factor(const std::string& smpi_coef_string)
 {
   std::vector<s_smpi_factor_t> smpi_factor;
@@ -38,9 +59,8 @@ std::vector<s_smpi_factor_t> parse_factor(const std::string& smpi_coef_string)
     XBT_DEBUG("token : %s", token_iter->c_str());
     Tokenizer factor_values(*token_iter, factor_separator);
     s_smpi_factor_t fact;
-    if (factor_values.begin() == factor_values.end()) {
-      xbt_die("Malformed radical for smpi factor: '%s'", smpi_coef_string.c_str());
-    }
+    xbt_assert(factor_values.begin() != factor_values.end(), "Malformed radical for smpi factor: '%s'",
+               smpi_coef_string.c_str());
     unsigned int iteration = 0;
     for (Tokenizer::iterator factor_iter = factor_values.begin(); factor_iter != factor_values.end(); ++factor_iter) {
       iteration++;
@@ -76,3 +96,108 @@ std::vector<s_smpi_factor_t> parse_factor(const std::string& smpi_coef_string)
 
   return smpi_factor;
 }
+
+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_shared_size(size_t size){
+  total_shared_size += size;
+  total_shared_calls++;
+}
+
+void print_time_analysis(double global_time){
+  if (simgrid::config::get_value<bool>("smpi/display-timing")) {
+    XBT_INFO("Simulated time: %g seconds. \n\n"
+        "The simulation took %g seconds (after parsing and platform setup)\n"
+        "%g seconds were actual computation of the application",
+        SIMIX_get_clock(), global_time , total_benched_time);
+    if (total_benched_time/global_time>=0.75)
+      XBT_INFO("More than 75%% of the time was spent inside the application code.\n"
+    "You may want to use sampling functions or trace replay to reduce this.");
+  }
+}
+
+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());
+    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;
+          }
+          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 (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"
+             "If this is too much, consider sharing allocations for computation buffers.\n"
+             "This can be done automatically by setting --cfg=smpi/auto-shared-malloc-thresh to the minimum size wanted size (this can alter execution if data content is necessary)\n",
+             total_malloc_size, max_malloc.size, simgrid::xbt::Path(max_malloc.file).get_base_name().c_str(), max_malloc.line, max_malloc.numcall
+      );
+    else
+      XBT_INFO("Allocations analysis asked, but 0 bytes were allocated through malloc/calloc calls intercepted by SMPI.\n"
+               "Either code is using other ways of allocating memory, or it was built with SMPI_NO_OVERRIDE_MALLOC");
+    if(total_shared_size != 0)
+      XBT_INFO("%lu bytes were automatically shared between processes, in %u calls\n", total_shared_size, total_shared_calls);
+  }
+}
+
+void set_current_handle(F2C* handle){
+  current_handle=handle;
+}
+
+void print_current_handle(){
+  if(current_handle){
+    if(current_handle->call_location().empty())
+      XBT_INFO("To get handle location information, pass -trace-call-location flag to smpicc/f90 as well");
+    else
+      XBT_INFO("Handle %s was allocated by a call at %s", current_handle->name().c_str(),
+               (char*)(current_handle->call_location().c_str()));
+  }
+}
+
+}
+}
+} // namespace simgrid