src/smpi/internals/smpi_config.cpp

   1 /* Copyright (c) 2008-2021. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5 #include "smpi_config.hpp"
   6 #include "include/xbt/config.hpp"
   7 #include "mc/mc.h"
   8 #include "private.hpp"
   9 #include "smpi_coll.hpp"
  10 #include "src/simix/smx_private.hpp"
  11 #include "xbt/parse_units.hpp"
  12
  13 #include <cfloat> /* DBL_MAX */
  14 #include <boost/algorithm/string.hpp> /* trim */
  15 #include <boost/tokenizer.hpp>
  16
  17 #if SIMGRID_HAVE_MC
  18 #include "src/mc/mc_config.hpp"
  19 #endif
  20
  21 #if defined(__APPLE__)
  22 # include <AvailabilityMacros.h>
  23 # ifndef MAC_OS_X_VERSION_10_12
  24 #   define MAC_OS_X_VERSION_10_12 101200
  25 # endif
  26 constexpr bool HAVE_WORKING_MMAP = (MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_10_12);
  27 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__sun) || defined(__HAIKU__)
  28 constexpr bool HAVE_WORKING_MMAP = false;
  29 #else
  30 constexpr bool HAVE_WORKING_MMAP = true;
  31 #endif
  32
  33 SharedMallocType _smpi_cfg_shared_malloc = SharedMallocType::GLOBAL;
  34 SmpiPrivStrategies _smpi_cfg_privatization = SmpiPrivStrategies::NONE;
  35 double _smpi_cfg_host_speed;
  36
  37 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_config, smpi, "Logging specific to SMPI (config)");
  38
  39 simgrid::config::Flag<std::string> _smpi_cfg_host_speed_string{
  40     "smpi/host-speed", "Speed of the host running the simulation (in flop/s). Used to bench the operations.", "20000f",
  41     [](const std::string& str) {
  42       _smpi_cfg_host_speed = xbt_parse_get_speed("smpi/host-speed", 1, str, "option smpi/host-speed");
  43       xbt_assert(_smpi_cfg_host_speed > 0.0, "Invalid value (%s) for 'smpi/host-speed': it must be positive.",
  44                  _smpi_cfg_host_speed_string.get().c_str());
  45     }};
  46
  47 simgrid::config::Flag<bool> _smpi_cfg_simulate_computation{
  48   "smpi/simulate-computation", "Whether the computational part of the simulated application should be simulated.",
  49    true};
  50 simgrid::config::Flag<std::string> _smpi_cfg_shared_malloc_string{
  51   "smpi/shared-malloc", "Whether SMPI_SHARED_MALLOC is enabled. Disable it for debugging purposes.", "global",
  52   [](const std::string& val) {
  53     if ((val == "yes") || (val == "1") || (val == "on") || (val == "global")) {
  54       _smpi_cfg_shared_malloc = SharedMallocType::GLOBAL;
  55     } else if (val == "local") {
  56       _smpi_cfg_shared_malloc = SharedMallocType::LOCAL;
  57     } else if ((val == "no") || (val == "0") || (val == "off")) {
  58       _smpi_cfg_shared_malloc = SharedMallocType::NONE;
  59     } else {
  60       xbt_die("Invalid value '%s' for option smpi/shared-malloc. Possible values: 'on' or 'global', 'local', 'off'",
  61       val.c_str());
  62     }
  63   } };
  64
  65 simgrid::config::Flag<double> _smpi_cfg_cpu_threshold{
  66   "smpi/cpu-threshold", "Minimal computation time (in seconds) not discarded, or -1 for infinity.", 1e-6,
  67   [](const double& val){
  68     if (val < 0)
  69       _smpi_cfg_cpu_threshold = DBL_MAX;
  70   }};
  71
  72 simgrid::config::Flag<int> _smpi_cfg_async_small_thresh{"smpi/async-small-thresh",
  73                                                         "Maximal size of messages that are to be sent asynchronously, without waiting for the receiver",
  74                                                         0};
  75 simgrid::config::Flag<int> _smpi_cfg_detached_send_thresh{"smpi/send-is-detached-thresh",
  76                                                           "Threshold of message size where MPI_Send stops behaving like MPI_Isend and becomes MPI_Ssend",
  77                                                           65536};
  78 simgrid::config::Flag<bool> _smpi_cfg_grow_injected_times{"smpi/grow-injected-times",
  79                                                           "Whether we want to make the injected time in MPI_Iprobe and MPI_Test grow, to "
  80                                                           "allow faster simulation. This can make simulation less precise, though.",
  81                                                           true};
  82 simgrid::config::Flag<double> _smpi_cfg_iprobe_cpu_usage{"smpi/iprobe-cpu-usage",
  83                                                         "Maximum usage of CPUs by MPI_Iprobe() calls. We've observed that MPI_Iprobes "
  84                                                         "consume significantly less power than the maximum of a specific application. "
  85                                                         "This value is then (Iprobe_Usage/Max_Application_Usage).",
  86                                                         1.0};
  87
  88 simgrid::config::Flag<bool>  _smpi_cfg_trace_call_location{"smpi/trace-call-location",
  89                                                            "Should filename and linenumber of MPI calls be traced?", false};
  90 simgrid::config::Flag<bool> _smpi_cfg_trace_call_use_absolute_path{"smpi/trace-call-use-absolute-path",
  91                                                                    "Should filenames for trace-call tracing be absolute or not?", false};
  92 simgrid::config::Flag<std::string> _smpi_cfg_comp_adjustment_file{"smpi/comp-adjustment-file",
  93     "A file containing speedups or slowdowns for some parts of the code.",
  94     "", [](const std::string& filename){
  95       if (not filename.empty()) {
  96         std::ifstream fstream(filename);
  97         xbt_assert(fstream.is_open(), "Could not open file %s. Does it exist?", filename.c_str());
  98         std::string line;
  99         using Tokenizer = boost::tokenizer<boost::escaped_list_separator<char>>;
 100         std::getline(fstream, line); // Skip the header line
 101         while (std::getline(fstream, line)) {
 102           Tokenizer tok(line);
 103           Tokenizer::iterator it  = tok.begin();
 104           Tokenizer::iterator end = std::next(tok.begin());
 105           std::string location = *it;
 106           boost::trim(location);
 107           location2speedup.insert(std::pair<std::string, double>(location, std::stod(*end)));
 108         }
 109       }
 110     }};
 111
 112 simgrid::config::Flag<bool> _smpi_cfg_default_errhandler_is_error{
 113   "smpi/errors-are-fatal", "Whether MPI errors are fatal or just return. Default is true", true };
 114 #if HAVE_PAPI
 115   simgrid::config::Flag<std::string> _smpi_cfg_papi_events_file{"smpi/papi-events",
 116                                                                 "This switch enables tracking the specified counters with PAPI", ""};
 117 #endif
 118
 119 simgrid::config::Flag<double> _smpi_cfg_auto_shared_malloc_thresh("smpi/auto-shared-malloc-thresh",
 120                                                                   "Threshold size for the automatic sharing of memory",
 121                                                                   0);
 122
 123 simgrid::config::Flag<bool> _smpi_cfg_display_alloc("smpi/display-allocs",
 124                                                     "Whether we should display a memory allocations analysis after simulation.",
 125                                                      false);
 126
 127 simgrid::config::Flag<int> _smpi_cfg_list_leaks("smpi/list-leaks",
 128                                                 "Whether we should display the n first MPI handle leaks (addresses and type only) after simulation",
 129                                                 -1);
 130
 131 double smpi_cfg_host_speed(){
 132   return _smpi_cfg_host_speed;
 133 }
 134
 135 bool smpi_cfg_simulate_computation(){
 136   return _smpi_cfg_simulate_computation;
 137 }
 138
 139 SharedMallocType smpi_cfg_shared_malloc(){
 140   return _smpi_cfg_shared_malloc;
 141 }
 142
 143 double smpi_cfg_cpu_thresh(){
 144   return _smpi_cfg_cpu_threshold;
 145 }
 146
 147 SmpiPrivStrategies smpi_cfg_privatization(){
 148   return _smpi_cfg_privatization;
 149 }
 150
 151 int smpi_cfg_async_small_thresh(){
 152   return _smpi_cfg_async_small_thresh;
 153 }
 154
 155 int smpi_cfg_detached_send_thresh(){
 156   return _smpi_cfg_detached_send_thresh;
 157 }
 158
 159 bool smpi_cfg_grow_injected_times(){
 160   return _smpi_cfg_grow_injected_times;
 161 }
 162
 163 double smpi_cfg_iprobe_cpu_usage(){
 164   return _smpi_cfg_iprobe_cpu_usage;
 165 }
 166
 167 bool smpi_cfg_trace_call_location(){
 168   return _smpi_cfg_trace_call_location;
 169 }
 170
 171 bool smpi_cfg_trace_call_use_absolute_path(){
 172   return _smpi_cfg_trace_call_use_absolute_path;
 173 }
 174
 175 bool smpi_cfg_display_alloc(){
 176   return _smpi_cfg_list_leaks != -1 ? true : _smpi_cfg_display_alloc;
 177 }
 178
 179 std::string smpi_cfg_comp_adjustment_file(){
 180   return _smpi_cfg_comp_adjustment_file;
 181 }
 182 #if HAVE_PAPI
 183 std::string smpi_cfg_papi_events_file(){
 184   return _smpi_cfg_papi_events_file;
 185 }
 186 #endif
 187 double smpi_cfg_auto_shared_malloc_thresh(){
 188   return _smpi_cfg_auto_shared_malloc_thresh;
 189 }
 190
 191 // public version declared in smpi.h (without parameter, and with C linkage)
 192 void smpi_init_options()
 193 {
 194   smpi_init_options_internal(false);
 195 }
 196
 197 void smpi_init_options_internal(bool called_by_smpi_main)
 198 {
 199   static bool smpi_options_initialized = false;
 200   static bool running_with_smpi_main   = false;
 201
 202   if (called_by_smpi_main)
 203     running_with_smpi_main = true;
 204
 205   // return if already called
 206   if (smpi_options_initialized)
 207     return;
 208   simgrid::config::declare_flag<bool>("smpi/display-timing", "Whether we should display the timing after simulation.", false);
 209   simgrid::config::declare_flag<bool>("smpi/keep-temps", "Whether we should keep the generated temporary files.", false);
 210   simgrid::config::declare_flag<std::string>("smpi/tmpdir", "tmp dir for dlopen files", "/tmp");
 211
 212   simgrid::config::declare_flag<std::string>("smpi/coll-selector", "Which collective selector to use", "default");
 213   simgrid::config::declare_flag<std::string>("smpi/gather", "Which collective to use for gather", "");
 214   simgrid::config::declare_flag<std::string>("smpi/allgather", "Which collective to use for allgather", "");
 215   simgrid::config::declare_flag<std::string>("smpi/barrier", "Which collective to use for barrier", "");
 216   simgrid::config::declare_flag<std::string>("smpi/reduce_scatter", "Which collective to use for reduce_scatter", "");
 217   simgrid::config::declare_flag<std::string>("smpi/scatter", "Which collective to use for scatter", "");
 218   simgrid::config::declare_flag<std::string>("smpi/allgatherv", "Which collective to use for allgatherv", "");
 219   simgrid::config::declare_flag<std::string>("smpi/allreduce", "Which collective to use for allreduce", "");
 220   simgrid::config::declare_flag<std::string>("smpi/alltoall", "Which collective to use for alltoall", "");
 221   simgrid::config::declare_flag<std::string>("smpi/alltoallv", "Which collective to use for alltoallv", "");
 222   simgrid::config::declare_flag<std::string>("smpi/bcast", "Which collective to use for bcast", "");
 223   simgrid::config::declare_flag<std::string>("smpi/reduce", "Which collective to use for reduce", "");
 224
 225   const char* default_privatization = std::getenv("SMPI_PRIVATIZATION");
 226   if (default_privatization == nullptr)
 227     default_privatization = "no";
 228
 229   simgrid::config::declare_flag<std::string>(
 230       "smpi/privatization", "How we should privatize global variable at runtime (no, yes, mmap, dlopen).",
 231       default_privatization, [](const std::string& smpi_privatize_option) {
 232         if (smpi_privatize_option == "no" || smpi_privatize_option == "0")
 233           _smpi_cfg_privatization = SmpiPrivStrategies::NONE;
 234         else if (smpi_privatize_option == "yes" || smpi_privatize_option == "1")
 235           _smpi_cfg_privatization = SmpiPrivStrategies::DEFAULT;
 236         else if (smpi_privatize_option == "mmap")
 237           _smpi_cfg_privatization = SmpiPrivStrategies::MMAP;
 238         else if (smpi_privatize_option == "dlopen")
 239           _smpi_cfg_privatization = SmpiPrivStrategies::DLOPEN;
 240         else
 241           xbt_die("Invalid value for smpi/privatization: '%s'", smpi_privatize_option.c_str());
 242
 243         if (not running_with_smpi_main) {
 244           XBT_DEBUG("Running without smpi_main(); disable smpi/privatization.");
 245           _smpi_cfg_privatization = SmpiPrivStrategies::NONE;
 246         }
 247         if (not HAVE_WORKING_MMAP && _smpi_cfg_privatization == SmpiPrivStrategies::MMAP) {
 248           XBT_INFO("mmap privatization is broken on this platform, switching to dlopen privatization instead.");
 249           _smpi_cfg_privatization = SmpiPrivStrategies::DLOPEN;
 250         }
 251       });
 252
 253   simgrid::config::declare_flag<std::string>("smpi/privatize-libs",
 254                                             "Add libraries (; separated) to privatize (libgfortran for example)."
 255                                             "You need to provide the full names of the files (libgfortran.so.4), or its full path",
 256                                             "");
 257   simgrid::config::declare_flag<double>("smpi/shared-malloc-blocksize",
 258                                         "Size of the bogus file which will be created for global shared allocations",
 259                                         1UL << 20);
 260   simgrid::config::declare_flag<std::string>("smpi/shared-malloc-hugepage",
 261                                              "Path to a mounted hugetlbfs, to use huge pages with shared malloc.",
 262                                              "");
 263
 264   simgrid::config::declare_flag<std::string>(
 265       "smpi/os", "Small messages timings (MPI_Send minimum time for small messages)", "0:0:0:0:0");
 266   simgrid::config::declare_flag<std::string>(
 267       "smpi/ois", "Small messages timings (MPI_Isend minimum time for small messages)", "0:0:0:0:0");
 268   simgrid::config::declare_flag<std::string>(
 269       "smpi/or", "Small messages timings (MPI_Recv minimum time for small messages)", "0:0:0:0:0");
 270
 271   simgrid::config::declare_flag<bool>("smpi/finalization-barrier", "Do we add a barrier in MPI_Finalize or not", false);
 272
 273   smpi_options_initialized = true;
 274 }
 275
 276 void smpi_check_options()
 277 {
 278 #if SIMGRID_HAVE_MC
 279   if (MC_is_active()) {
 280     if (_sg_mc_buffering == "zero")
 281       simgrid::config::set_value<int>("smpi/send-is-detached-thresh", 0);
 282     else if (_sg_mc_buffering == "infty")
 283       simgrid::config::set_value<int>("smpi/send-is-detached-thresh", INT_MAX);
 284     else
 285       THROW_IMPOSSIBLE;
 286   }
 287 #endif
 288
 289   xbt_assert(smpi_cfg_async_small_thresh() <= smpi_cfg_detached_send_thresh(),
 290              "smpi/async-small-thresh (=%d) should be smaller or equal to smpi/send-is-detached-thresh (=%d)",
 291              smpi_cfg_async_small_thresh(),
 292              smpi_cfg_detached_send_thresh());
 293
 294   if (simgrid::config::is_default("smpi/host-speed") && not MC_is_active()) {
 295     XBT_INFO("You did not set the power of the host running the simulation.  "
 296              "The timings will certainly not be accurate.  "
 297              "Use the option \"--cfg=smpi/host-speed:<flops>\" to set its value.  "
 298              "Check "
 299              "https://simgrid.org/doc/latest/Configuring_SimGrid.html#automatic-benchmarking-of-smpi-code for more "
 300              "information.");
 301   }
 302
 303   simgrid::smpi::colls::set_collectives();
 304   simgrid::smpi::colls::smpi_coll_cleanup_callback = nullptr;
 305 }
 306