src/surf/surf_interface.cpp

   1 /* Copyright (c) 2004-2019. 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
   6 #include "surf_interface.hpp"
   7 #include "mc/mc.h"
   8 #include "simgrid/s4u/Engine.hpp"
   9 #include "simgrid/sg_config.hpp"
  10 #include "src/internal_config.h"
  11 #include "src/simgrid/version.h"
  12 #include "src/surf/HostImpl.hpp"
  13 #include "src/surf/xml/platf.hpp"
  14 #include "surf/surf.hpp"
  15 #include "xbt/module.h"
  16
  17 #include <fstream>
  18 #include <string>
  19
  20 #ifdef _WIN32
  21 #include <windows.h>
  22 #endif
  23
  24 XBT_LOG_NEW_CATEGORY(surf, "All SURF categories");
  25 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf, "Logging specific to SURF (kernel)");
  26
  27 /*********
  28  * Utils *
  29  *********/
  30
  31 std::vector<simgrid::kernel::resource::Model*> all_existing_models; /* to destroy models correctly */
  32
  33 simgrid::kernel::profile::FutureEvtSet future_evt_set;
  34 std::vector<std::string> surf_path;
  35 /**  set of hosts for which one want to be notified if they ever restart. */
  36 std::set<std::string> watched_hosts;
  37 extern std::map<std::string, simgrid::kernel::resource::StorageType*> storage_types;
  38
  39 std::vector<surf_model_description_t>* surf_plugin_description = nullptr;
  40
  41 static void XBT_ATTRIB_DESTRUCTOR(800) simgrid_free_plugin_description()
  42 {
  43   delete surf_plugin_description;
  44   surf_plugin_description = nullptr;
  45 }
  46
  47 XBT_PUBLIC void simgrid_add_plugin_description(const char* name, const char* description, void_f_void_t init_fun)
  48 {
  49   if (not surf_plugin_description)
  50     surf_plugin_description = new std::vector<surf_model_description_t>;
  51   surf_plugin_description->emplace_back(surf_model_description_t{name, description, init_fun});
  52 }
  53
  54 /* Don't forget to update the option description in smx_config when you change this */
  55 const std::vector<surf_model_description_t> surf_network_model_description = {
  56     {"LV08", "Realistic network analytic model (slow-start modeled by multiplying latency by 13.01, bandwidth by .97; "
  57              "bottleneck sharing uses a payload of S=20537 for evaluating RTT). ",
  58      &surf_network_model_init_LegrandVelho},
  59     {"Constant", "Simplistic network model where all communication take a constant time (one second). This model "
  60                  "provides the lowest realism, but is (marginally) faster.",
  61      &surf_network_model_init_Constant},
  62     {"SMPI", "Realistic network model specifically tailored for HPC settings (accurate modeling of slow start with "
  63              "correction factors on three intervals: < 1KiB, < 64 KiB, >= 64 KiB)",
  64      &surf_network_model_init_SMPI},
  65     {"IB", "Realistic network model specifically tailored for HPC settings, with Infiniband contention model",
  66      &surf_network_model_init_IB},
  67     {"CM02", "Legacy network analytic model (Very similar to LV08, but without corrective factors. The timings of "
  68              "small messages are thus poorly modeled).",
  69      &surf_network_model_init_CM02},
  70     {"NS3", "Network pseudo-model using the NS3 tcp model instead of an analytic model", &surf_network_model_init_NS3},
  71     {"Reno",
  72      "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
  73      &surf_network_model_init_Reno},
  74     {"Reno2",
  75      "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
  76      &surf_network_model_init_Reno2},
  77     {"Vegas",
  78      "Model from Steven H. Low using lagrange_solve instead of lmm_solve (experts only; check the code for more info).",
  79      &surf_network_model_init_Vegas},
  80 };
  81
  82 #if ! HAVE_SMPI
  83 void surf_network_model_init_SMPI() {
  84   xbt_die("Please activate SMPI support in cmake to use the SMPI network model.");
  85 }
  86 void surf_network_model_init_IB() {
  87   xbt_die("Please activate SMPI support in cmake to use the IB network model.");
  88 }
  89 #endif
  90 #if !SIMGRID_HAVE_NS3
  91 void surf_network_model_init_NS3() {
  92   xbt_die("Please activate NS3 support in cmake and install the dependencies to use the NS3 network model.");
  93 }
  94 #endif
  95
  96 const std::vector<surf_model_description_t> surf_cpu_model_description = {
  97     {"Cas01", "Simplistic CPU model (time=size/power).", &surf_cpu_model_init_Cas01},
  98 };
  99
 100 const std::vector<surf_model_description_t> surf_host_model_description = {
 101     {"default", "Default host model. Currently, CPU:Cas01 and network:LV08 (with cross traffic enabled)",
 102      &surf_host_model_init_current_default},
 103     {"compound", "Host model that is automatically chosen if you change the network and CPU models",
 104      &surf_host_model_init_compound},
 105     {"ptask_L07", "Host model somehow similar to Cas01+CM02 but allowing parallel tasks",
 106      &surf_host_model_init_ptask_L07},
 107 };
 108
 109 const std::vector<surf_model_description_t> surf_optimization_mode_description = {
 110     {"Lazy", "Lazy action management (partial invalidation in lmm + heap in action remaining).", nullptr},
 111     {"TI", "Trace integration. Highly optimized mode when using availability traces (only available for the Cas01 CPU "
 112            "model for now).",
 113      nullptr},
 114     {"Full", "Full update of remaining and variables. Slow but may be useful when debugging.", nullptr},
 115 };
 116
 117 const std::vector<surf_model_description_t> surf_storage_model_description = {
 118     {"default", "Simplistic storage model.", &surf_storage_model_init_default},
 119 };
 120
 121 double NOW = 0;
 122
 123 double surf_get_clock()
 124 {
 125   return NOW;
 126 }
 127
 128 /* returns whether #file_path is a absolute file path. Surprising, isn't it ? */
 129 static bool is_absolute_file_path(const std::string& file_path)
 130 {
 131 #ifdef _WIN32
 132   WIN32_FIND_DATA wfd = {0};
 133   HANDLE hFile        = FindFirstFile(file_path.c_str(), &wfd);
 134
 135   if (INVALID_HANDLE_VALUE == hFile)
 136     return false;
 137
 138   FindClose(hFile);
 139   return true;
 140 #else
 141   return (file_path.c_str()[0] == '/');
 142 #endif
 143 }
 144
 145 std::ifstream* surf_ifsopen(const std::string& name)
 146 {
 147   xbt_assert(not name.empty());
 148
 149   std::ifstream* fs = new std::ifstream();
 150   if (is_absolute_file_path(name)) { /* don't mess with absolute file names */
 151     fs->open(name.c_str(), std::ifstream::in);
 152   }
 153
 154   /* search relative files in the path */
 155   for (auto const& path_elm : surf_path) {
 156     std::string buff = path_elm + "/" + name;
 157     fs->open(buff.c_str(), std::ifstream::in);
 158
 159     if (not fs->fail()) {
 160       XBT_DEBUG("Found file at %s", buff.c_str());
 161       return fs;
 162     }
 163   }
 164
 165   return fs;
 166 }
 167
 168 FILE* surf_fopen(const std::string& name, const char* mode)
 169 {
 170   FILE *file = nullptr;
 171
 172   if (is_absolute_file_path(name)) /* don't mess with absolute file names */
 173     return fopen(name.c_str(), mode);
 174
 175   /* search relative files in the path */
 176   for (auto const& path_elm : surf_path) {
 177     std::string buff = path_elm + "/" + name;
 178     file             = fopen(buff.c_str(), mode);
 179
 180     if (file)
 181       return file;
 182   }
 183   return nullptr;
 184 }
 185
 186 /** Displays the long description of all registered models, and quit */
 187 void model_help(const char* category, const std::vector<surf_model_description_t>& table)
 188 {
 189   XBT_HELP("Long description of the %s models accepted by this simulator:", category);
 190   for (auto const& item : table)
 191     XBT_HELP("  %s: %s", item.name, item.description);
 192 }
 193
 194 int find_model_description(const std::vector<surf_model_description_t>& table, const std::string& name)
 195 {
 196   auto pos = std::find_if(table.begin(), table.end(),
 197                           [&name](const surf_model_description_t& item) { return item.name == name; });
 198   if (pos != table.end())
 199     return std::distance(table.begin(), pos);
 200
 201   if (table.empty())
 202     xbt_die("No model is valid! This is a bug.");
 203
 204   std::string sep;
 205   std::string name_list;
 206   for (auto const& item : table) {
 207     name_list += sep + item.name;
 208     sep = ", ";
 209   }
 210
 211   xbt_die("Model '%s' is invalid! Valid models are: %s.", name.c_str(), name_list.c_str());
 212   return -1;
 213 }
 214
 215 void sg_version_check(int lib_version_major, int lib_version_minor, int lib_version_patch)
 216 {
 217   if ((lib_version_major != SIMGRID_VERSION_MAJOR) || (lib_version_minor != SIMGRID_VERSION_MINOR)) {
 218     fprintf(stderr, "FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, "
 219                     "and then linked against SimGrid %d.%d.%d. Please fix this.\n",
 220             lib_version_major, lib_version_minor, lib_version_patch, SIMGRID_VERSION_MAJOR, SIMGRID_VERSION_MINOR,
 221             SIMGRID_VERSION_PATCH);
 222     abort();
 223   }
 224   if (lib_version_patch != SIMGRID_VERSION_PATCH) {
 225     if (SIMGRID_VERSION_PATCH > 89 || lib_version_patch > 89) {
 226       fprintf(
 227           stderr,
 228           "FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, "
 229           "and then linked against SimGrid %d.%d.%d. \n"
 230           "One of them is a development version, and should not be mixed with the stable release. Please fix this.\n",
 231           lib_version_major, lib_version_minor, lib_version_patch, SIMGRID_VERSION_MAJOR, SIMGRID_VERSION_MINOR,
 232           SIMGRID_VERSION_PATCH);
 233       abort();
 234     }
 235     fprintf(stderr, "Warning: Your program was compiled with SimGrid version %d.%d.%d, "
 236                     "and then linked against SimGrid %d.%d.%d. Proceeding anyway.\n",
 237             lib_version_major, lib_version_minor, lib_version_patch, SIMGRID_VERSION_MAJOR, SIMGRID_VERSION_MINOR,
 238             SIMGRID_VERSION_PATCH);
 239   }
 240 }
 241
 242 void sg_version_get(int* ver_major, int* ver_minor, int* ver_patch)
 243 {
 244   *ver_major = SIMGRID_VERSION_MAJOR;
 245   *ver_minor = SIMGRID_VERSION_MINOR;
 246   *ver_patch = SIMGRID_VERSION_PATCH;
 247 }
 248
 249 void sg_version()
 250 {
 251   XBT_HELP("This program was linked against %s (git: %s), found in %s.", SIMGRID_VERSION_STRING, SIMGRID_GIT_VERSION,
 252            SIMGRID_INSTALL_PREFIX);
 253
 254 #if SIMGRID_HAVE_MC
 255   XBT_HELP("   Model-checking support compiled in.");
 256 #else
 257   XBT_HELP("   Model-checking support disabled at compilation.");
 258 #endif
 259
 260 #if SIMGRID_HAVE_NS3
 261   XBT_HELP("   NS3 support compiled in.");
 262 #else
 263   XBT_HELP("   NS3 support disabled at compilation.");
 264 #endif
 265
 266 #if SIMGRID_HAVE_JEDULE
 267   XBT_HELP("   Jedule support compiled in.");
 268 #else
 269   XBT_HELP("   Jedule support disabled at compilation.");
 270 #endif
 271
 272 #if SIMGRID_HAVE_LUA
 273   XBT_HELP("   Lua support compiled in.");
 274 #else
 275   XBT_HELP("   Lua support disabled at compilation.");
 276 #endif
 277
 278 #if SIMGRID_HAVE_MALLOCATOR
 279   XBT_HELP("   Mallocator support compiled in.");
 280 #else
 281   XBT_HELP("   Mallocator support disabled at compilation.");
 282 #endif
 283
 284   XBT_HELP("\nTo cite SimGrid in a publication, please use:\n"
 285            "   Henri Casanova, Arnaud Giersch, Arnaud Legrand, Martin Quinson, Frédéric Suter. \n"
 286            "   Versatile, Scalable, and Accurate Simulation of Distributed Applications and Platforms. \n"
 287            "   Journal of Parallel and Distributed Computing, Elsevier, 2014, 74 (10), pp.2899-2917.\n"
 288            "The pdf file and a BibTeX entry for LaTeX users can be found at http://hal.inria.fr/hal-01017319");
 289 }
 290
 291 void surf_init(int *argc, char **argv)
 292 {
 293   if (USER_HOST_LEVEL != -1) // Already initialized
 294     return;
 295
 296   XBT_DEBUG("Create all Libs");
 297   USER_HOST_LEVEL = simgrid::s4u::Host::extension_create(nullptr);
 298
 299   xbt_init(argc, argv);
 300
 301   sg_config_init(argc, argv);
 302
 303   if (MC_is_active())
 304     MC_memory_init();
 305 }
 306
 307 void surf_exit()
 308 {
 309   simgrid::s4u::Engine::shutdown();
 310   for (auto const& e : storage_types) {
 311     simgrid::kernel::resource::StorageType* stype = e.second;
 312     delete stype->properties;
 313     delete stype->model_properties;
 314     delete stype;
 315   }
 316
 317   for (auto const& model : all_existing_models)
 318     delete model;
 319
 320   tmgr_finalize();
 321   sg_platf_exit();
 322
 323   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
 324 }