src/surf/surf_interface.cpp

   1 /* Copyright (c) 2004-2018. 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/surf/HostImpl.hpp"
  12 #include "src/surf/xml/platf.hpp"
  13 #include "surf/surf.hpp"
  14 #include "xbt/module.h"
  15
  16 #include <fstream>
  17 #include <string>
  18
  19 #ifdef _WIN32
  20 #include <windows.h>
  21 #endif
  22
  23 XBT_LOG_NEW_CATEGORY(surf, "All SURF categories");
  24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf, "Logging specific to SURF (kernel)");
  25
  26 /*********
  27  * Utils *
  28  *********/
  29
  30 std::vector<simgrid::kernel::resource::Model*> all_existing_models; /* to destroy models correctly */
  31
  32 simgrid::trace_mgr::future_evt_set future_evt_set;
  33 std::vector<std::string> surf_path;
  34 /**  set of hosts for which one want to be notified if they ever restart. */
  35 std::set<std::string> watched_hosts;
  36 extern std::map<std::string, simgrid::surf::StorageType*> storage_types;
  37
  38 s_surf_model_description_t* surf_plugin_description = nullptr;
  39 XBT_PUBLIC void simgrid_add_plugin_description(const char* name, const char* description, void_f_void_t init_fun)
  40 {
  41   static int plugin_amount = 0;
  42
  43   /* no need to check for plugin name conflict: the compiler already ensures that the generated
  44    * simgrid_##id##_plugin_register() is unique */
  45
  46   plugin_amount++;
  47   surf_plugin_description = static_cast<s_surf_model_description_t*>(
  48       xbt_realloc(surf_plugin_description, sizeof(s_surf_model_description_t) * (plugin_amount + 2)));
  49
  50   surf_plugin_description[plugin_amount - 1] = {name, description, init_fun};
  51   surf_plugin_description[plugin_amount]     = {nullptr, nullptr, nullptr}; // this array must be null terminated
  52 }
  53
  54 /* Don't forget to update the option description in smx_config when you change this */
  55 s_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     {nullptr, nullptr, nullptr} /* this array must be nullptr terminated */
  81 };
  82
  83 #if ! HAVE_SMPI
  84 void surf_network_model_init_SMPI() {
  85   xbt_die("Please activate SMPI support in cmake to use the SMPI network model.");
  86 }
  87 void surf_network_model_init_IB() {
  88   xbt_die("Please activate SMPI support in cmake to use the IB network model.");
  89 }
  90 #endif
  91 #if !SIMGRID_HAVE_NS3
  92 void surf_network_model_init_NS3() {
  93   xbt_die("Please activate NS3 support in cmake and install the dependencies to use the NS3 network model.");
  94 }
  95 #endif
  96
  97 s_surf_model_description_t surf_cpu_model_description[] = {
  98   {"Cas01", "Simplistic CPU model (time=size/power).", &surf_cpu_model_init_Cas01},
  99   {nullptr, nullptr,  nullptr}      /* this array must be nullptr terminated */
 100 };
 101
 102 s_surf_model_description_t surf_host_model_description[] = {
 103   {"default",   "Default host model. Currently, CPU:Cas01 and network:LV08 (with cross traffic enabled)", &surf_host_model_init_current_default},
 104   {"compound",  "Host model that is automatically chosen if you change the network and CPU models", &surf_host_model_init_compound},
 105   {"ptask_L07", "Host model somehow similar to Cas01+CM02 but allowing parallel tasks", &surf_host_model_init_ptask_L07},
 106   {nullptr, nullptr, nullptr}      /* this array must be nullptr terminated */
 107 };
 108
 109 s_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 model for now).", nullptr},
 112   {"Full", "Full update of remaining and variables. Slow but may be useful when debugging.", nullptr},
 113   {nullptr, nullptr, nullptr}      /* this array must be nullptr terminated */
 114 };
 115
 116 s_surf_model_description_t surf_storage_model_description[] = {
 117   {"default", "Simplistic storage model.", &surf_storage_model_init_default},
 118   {nullptr, nullptr,  nullptr}      /* this array must be nullptr terminated */
 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(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(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(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, s_surf_model_description_t * table)
 188 {
 189   printf("Long description of the %s models accepted by this simulator:\n", category);
 190   for (int i = 0; table[i].name; i++)
 191     printf("  %s: %s\n", table[i].name, table[i].description);
 192 }
 193
 194 int find_model_description(s_surf_model_description_t* table, std::string name)
 195 {
 196   for (int i = 0; table[i].name; i++)
 197     if (name == table[i].name)
 198       return i;
 199
 200   if (not table[0].name)
 201     xbt_die("No model is valid! This is a bug.");
 202
 203   std::string name_list = std::string(table[0].name);
 204   for (int i = 1; table[i].name; i++)
 205     name_list = name_list + ", " + table[i].name;
 206
 207   xbt_die("Model '%s' is invalid! Valid models are: %s.", name.c_str(), name_list.c_str());
 208   return -1;
 209 }
 210
 211 void sg_version_check(int lib_version_major, int lib_version_minor, int lib_version_patch)
 212 {
 213   if ((lib_version_major != SIMGRID_VERSION_MAJOR) || (lib_version_minor != SIMGRID_VERSION_MINOR)) {
 214     fprintf(stderr, "FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, "
 215                     "and then linked against SimGrid %d.%d.%d. Please fix this.\n",
 216             lib_version_major, lib_version_minor, lib_version_patch, SIMGRID_VERSION_MAJOR, SIMGRID_VERSION_MINOR,
 217             SIMGRID_VERSION_PATCH);
 218     abort();
 219   }
 220   if (lib_version_patch != SIMGRID_VERSION_PATCH) {
 221     if (SIMGRID_VERSION_PATCH >= 90 || lib_version_patch >= 90) {
 222       fprintf(
 223           stderr,
 224           "FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, "
 225           "and then linked against SimGrid %d.%d.%d. \n"
 226           "One of them is a development version, and should not be mixed with the stable release. Please fix this.\n",
 227           lib_version_major, lib_version_minor, lib_version_patch, SIMGRID_VERSION_MAJOR, SIMGRID_VERSION_MINOR,
 228           SIMGRID_VERSION_PATCH);
 229       abort();
 230     }
 231     fprintf(stderr, "Warning: Your program was compiled with SimGrid version %d.%d.%d, "
 232                     "and then linked against SimGrid %d.%d.%d. Proceeding anyway.\n",
 233             lib_version_major, lib_version_minor, lib_version_patch, SIMGRID_VERSION_MAJOR, SIMGRID_VERSION_MINOR,
 234             SIMGRID_VERSION_PATCH);
 235   }
 236 }
 237
 238 void sg_version_get(int* ver_major, int* ver_minor, int* ver_patch)
 239 {
 240   *ver_major = SIMGRID_VERSION_MAJOR;
 241   *ver_minor = SIMGRID_VERSION_MINOR;
 242   *ver_patch = SIMGRID_VERSION_PATCH;
 243 }
 244
 245 void sg_version()
 246 {
 247   std::printf("This program was linked against %s (git: %s), found in %s.\n",
 248               SIMGRID_VERSION_STRING, SIMGRID_GIT_VERSION, SIMGRID_INSTALL_PREFIX);
 249
 250 #if SIMGRID_HAVE_MC
 251   std::printf("   Model-checking support compiled in.\n");
 252 #else
 253   std::printf("   Model-checking support disabled at compilation.\n");
 254 #endif
 255
 256 #if SIMGRID_HAVE_NS3
 257   std::printf("   NS3 support compiled in.\n");
 258 #else
 259   std::printf("   NS3 support disabled at compilation.\n");
 260 #endif
 261
 262 #if SIMGRID_HAVE_JEDULE
 263   std::printf("   Jedule support compiled in.\n");
 264 #else
 265   std::printf("   Jedule support disabled at compilation.\n");
 266 #endif
 267
 268 #if SIMGRID_HAVE_LUA
 269   std::printf("   Lua support compiled in.\n");
 270 #else
 271   std::printf("   Lua support disabled at compilation.\n");
 272 #endif
 273
 274 #if SIMGRID_HAVE_MALLOCATOR
 275   std::printf("   Mallocator support compiled in.\n");
 276 #else
 277   std::printf("   Mallocator support disabled at compilation.\n");
 278 #endif
 279
 280   std::printf("\nTo cite SimGrid in a publication, please use:\n"
 281               "   Henri Casanova, Arnaud Giersch, Arnaud Legrand, Martin Quinson, Frédéric Suter. \n"
 282               "   Versatile, Scalable, and Accurate Simulation of Distributed Applications and Platforms. \n"
 283               "   Journal of Parallel and Distributed Computing, Elsevier, 2014, 74 (10), pp.2899-2917.\n");
 284   std::printf("The pdf file and a BibTeX entry for LaTeX users can be found at http://hal.inria.fr/hal-01017319\n");
 285 }
 286
 287 void surf_init(int *argc, char **argv)
 288 {
 289   if (USER_HOST_LEVEL != -1) // Already initialized
 290     return;
 291
 292   XBT_DEBUG("Create all Libs");
 293   USER_HOST_LEVEL = simgrid::s4u::Host::extension_create(nullptr);
 294
 295   xbt_init(argc, argv);
 296
 297   sg_config_init(argc, argv);
 298
 299   if (MC_is_active())
 300     MC_memory_init();
 301 }
 302
 303 void surf_exit()
 304 {
 305   simgrid::s4u::Engine::shutdown();
 306   for (auto const& e : storage_types) {
 307     simgrid::surf::StorageType* stype = e.second;
 308     delete stype->properties;
 309     delete stype->model_properties;
 310     delete stype;
 311   }
 312
 313   for (auto const& model : all_existing_models)
 314     delete model;
 315
 316   xbt_free(surf_plugin_description);
 317
 318   tmgr_finalize();
 319   sg_platf_exit();
 320
 321   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
 322 }