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