src/surf/surf_interface.cpp

   1 /* Copyright (c) 2004-2021. 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/kernel/resource/profile/FutureEvtSet.hpp"
  11 #include "src/kernel/resource/profile/Profile.hpp"
  12 #include "src/surf/HostImpl.hpp"
  13 #include "src/surf/xml/platf.hpp"
  14 #include "src/xbt_modinter.h" /* whether initialization was already done */
  15 #include "surf/surf.hpp"
  16 #include "xbt/module.h"
  17
  18 #include <fstream>
  19 #include <string>
  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; /* to destroy models correctly */
  33
  34 simgrid::kernel::profile::FutureEvtSet future_evt_set;
  35 std::vector<std::string> surf_path;
  36
  37 extern std::map<std::string, simgrid::kernel::resource::StorageType*, std::less<>> storage_types;
  38
  39 std::vector<surf_model_description_t>* surf_plugin_description = nullptr;
  40
  41 static void XBT_ATTRIB_DESTRUCTOR(800) simgrid_free_plugin_description()
  42 {
  43   delete surf_plugin_description;
  44   surf_plugin_description = nullptr;
  45 }
  46
  47 XBT_PUBLIC void simgrid_add_plugin_description(const char* name, const char* description, void_f_void_t init_fun)
  48 {
  49   if (not surf_plugin_description)
  50     surf_plugin_description = new std::vector<surf_model_description_t>();
  51   surf_plugin_description->emplace_back(surf_model_description_t{name, description, init_fun});
  52 }
  53
  54 /* Don't forget to update the option description in smx_config when you change this */
  55 const std::vector<surf_model_description_t> surf_network_model_description = {
  56     {"LV08",
  57      "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",
  61      "Simplistic network model where all communication take a constant time (one second). This model "
  62      "provides the lowest realism, but is (marginally) faster.",
  63      &surf_network_model_init_Constant},
  64     {"SMPI",
  65      "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",
  71      "Legacy network analytic model (Very similar to LV08, but without corrective factors. The timings of "
  72      "small messages are thus poorly modeled).",
  73      &surf_network_model_init_CM02},
  74     {"ns-3", "Network pseudo-model using the ns-3 tcp model instead of an analytic model",
  75      &surf_network_model_init_NS3},
  76 };
  77
  78 #if ! HAVE_SMPI
  79 void surf_network_model_init_SMPI() {
  80   xbt_die("Please activate SMPI support in cmake to use the SMPI network model.");
  81 }
  82 void surf_network_model_init_IB() {
  83   xbt_die("Please activate SMPI support in cmake to use the IB network model.");
  84 }
  85 #endif
  86 #if !SIMGRID_HAVE_NS3
  87 void surf_network_model_init_NS3() {
  88   xbt_die("Please activate ns-3 support in cmake and install the dependencies to use the NS3 network model.");
  89 }
  90 #endif
  91
  92 const std::vector<surf_model_description_t> surf_cpu_model_description = {
  93     {"Cas01", "Simplistic CPU model (time=size/speed).", &surf_cpu_model_init_Cas01},
  94 };
  95
  96 const std::vector<surf_model_description_t> surf_host_model_description = {
  97     {"default", "Default host model. Currently, CPU:Cas01 and network:LV08 (with cross traffic enabled)",
  98      &surf_host_model_init_current_default},
  99     {"compound", "Host model that is automatically chosen if you change the network and CPU models",
 100      &surf_host_model_init_compound},
 101     {"ptask_L07", "Host model somehow similar to Cas01+CM02 but allowing parallel tasks",
 102      &surf_host_model_init_ptask_L07},
 103 };
 104
 105 const std::vector<surf_model_description_t> surf_optimization_mode_description = {
 106     {"Lazy", "Lazy action management (partial invalidation in lmm + heap in action remaining).", nullptr},
 107     {"TI", "Trace integration. Highly optimized mode when using availability traces (only available for the Cas01 CPU "
 108            "model for now).",
 109      nullptr},
 110     {"Full", "Full update of remaining and variables. Slow but may be useful when debugging.", nullptr},
 111 };
 112
 113 const std::vector<surf_model_description_t> surf_disk_model_description = {
 114     {"default", "Simplistic disk model.", &surf_disk_model_init_default},
 115 };
 116
 117 const std::vector<surf_model_description_t> surf_storage_model_description = {
 118     {"default", "Simplistic storage model.", &surf_storage_model_init_default},
 119 };
 120
 121 double NOW = 0;
 122
 123 double surf_get_clock()
 124 {
 125   return NOW;
 126 }
 127
 128 /* returns whether #file_path is an absolute file path. Surprising, isn't it ? */
 129 static bool is_absolute_file_path(const 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(const std::string& name)
 146 {
 147   xbt_assert(not name.empty());
 148
 149   auto* 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(const 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, const std::vector<surf_model_description_t>& table)
 188 {
 189   XBT_HELP("Long description of the %s models accepted by this simulator:", category);
 190   for (auto const& item : table)
 191     XBT_HELP("  %s: %s", item.name, item.description);
 192 }
 193
 194 int find_model_description(const std::vector<surf_model_description_t>& table, const std::string& name)
 195 {
 196   auto pos = std::find_if(table.begin(), table.end(),
 197                           [&name](const surf_model_description_t& item) { return item.name == name; });
 198   if (pos != table.end())
 199     return static_cast<int>(std::distance(table.begin(), pos));
 200
 201   if (table.empty())
 202     xbt_die("No model is valid! This is a bug.");
 203
 204   std::string sep;
 205   std::string name_list;
 206   for (auto const& item : table) {
 207     name_list += sep + item.name;
 208     sep = ", ";
 209   }
 210
 211   xbt_die("Model '%s' is invalid! Valid models are: %s.", name.c_str(), name_list.c_str());
 212   return -1;
 213 }
 214
 215
 216 void surf_init(int *argc, char **argv)
 217 {
 218   if (xbt_initialized > 0)
 219     return;
 220
 221   xbt_init(argc, argv);
 222
 223   sg_config_init(argc, argv);
 224 }
 225
 226 void surf_exit()
 227 {
 228   simgrid::s4u::Engine::shutdown();
 229   for (auto const& e : storage_types) {
 230     const simgrid::kernel::resource::StorageType* stype = e.second;
 231     delete stype->properties;
 232     delete stype->model_properties;
 233     delete stype;
 234   }
 235
 236   for (auto const& model : all_existing_models)
 237     delete model;
 238
 239   tmgr_finalize();
 240   sg_platf_exit();
 241
 242   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
 243 }