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