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