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