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