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