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 std::vector<surf_model_description_t>* surf_plugin_description = nullptr;
  38
  39 static void XBT_ATTRIB_DESTRUCTOR(800) simgrid_free_plugin_description()
  40 {
  41   delete surf_plugin_description;
  42   surf_plugin_description = nullptr;
  43 }
  44
  45 XBT_PUBLIC void simgrid_add_plugin_description(const char* name, const char* description, void_f_void_t init_fun)
  46 {
  47   if (not surf_plugin_description)
  48     surf_plugin_description = new std::vector<surf_model_description_t>();
  49   surf_plugin_description->emplace_back(surf_model_description_t{name, description, init_fun});
  50 }
  51
  52 /* Don't forget to update the option description in smx_config when you change this */
  53 const std::vector<surf_model_description_t> surf_network_model_description = {
  54     {"LV08",
  55      "Realistic network analytic model (slow-start modeled by multiplying latency by 13.01, bandwidth by .97; "
  56      "bottleneck sharing uses a payload of S=20537 for evaluating RTT). ",
  57      &surf_network_model_init_LegrandVelho},
  58     {"Constant",
  59      "Simplistic network model where all communication take a constant time (one second). This model "
  60      "provides the lowest realism, but is (marginally) faster.",
  61      &surf_network_model_init_Constant},
  62     {"SMPI",
  63      "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",
  69      "Legacy network analytic model (Very similar to LV08, but without corrective factors. The timings of "
  70      "small messages are thus poorly modeled).",
  71      &surf_network_model_init_CM02},
  72     {"ns-3", "Network pseudo-model using the ns-3 tcp model instead of an analytic model",
  73      &surf_network_model_init_NS3},
  74 };
  75
  76 #if ! HAVE_SMPI
  77 void surf_network_model_init_SMPI() {
  78   xbt_die("Please activate SMPI support in cmake to use the SMPI network model.");
  79 }
  80 void surf_network_model_init_IB() {
  81   xbt_die("Please activate SMPI support in cmake to use the IB network model.");
  82 }
  83 #endif
  84 #if !SIMGRID_HAVE_NS3
  85 void surf_network_model_init_NS3() {
  86   xbt_die("Please activate ns-3 support in cmake and install the dependencies to use the NS3 network model.");
  87 }
  88 #endif
  89
  90 const std::vector<surf_model_description_t> surf_cpu_model_description = {
  91     {"Cas01", "Simplistic CPU model (time=size/speed).", &surf_cpu_model_init_Cas01},
  92 };
  93
  94 const std::vector<surf_model_description_t> surf_host_model_description = {
  95     {"default", "Default host model. Currently, CPU:Cas01 and network:LV08 (with cross traffic enabled)",
  96      &surf_host_model_init_current_default},
  97     {"compound", "Host model that is automatically chosen if you change the network and CPU models",
  98      &surf_host_model_init_compound},
  99     {"ptask_L07", "Host model somehow similar to Cas01+CM02 but allowing parallel tasks",
 100      &surf_host_model_init_ptask_L07},
 101 };
 102
 103 const std::vector<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 "
 106            "model for now).",
 107      nullptr},
 108     {"Full", "Full update of remaining and variables. Slow but may be useful when debugging.", nullptr},
 109 };
 110
 111 const std::vector<surf_model_description_t> surf_disk_model_description = {
 112     {"default", "Simplistic disk model.", &surf_disk_model_init_default},
 113 };
 114
 115 double NOW = 0;
 116
 117 double surf_get_clock()
 118 {
 119   return NOW;
 120 }
 121
 122 /* returns whether #file_path is an absolute file path. Surprising, isn't it ? */
 123 static bool is_absolute_file_path(const std::string& file_path)
 124 {
 125 #ifdef _WIN32
 126   WIN32_FIND_DATA wfd = {0};
 127   HANDLE hFile        = FindFirstFile(file_path.c_str(), &wfd);
 128
 129   if (INVALID_HANDLE_VALUE == hFile)
 130     return false;
 131
 132   FindClose(hFile);
 133   return true;
 134 #else
 135   return (file_path.c_str()[0] == '/');
 136 #endif
 137 }
 138
 139 std::ifstream* surf_ifsopen(const std::string& name)
 140 {
 141   xbt_assert(not name.empty());
 142
 143   auto* fs = new std::ifstream();
 144   if (is_absolute_file_path(name)) { /* don't mess with absolute file names */
 145     fs->open(name.c_str(), std::ifstream::in);
 146   }
 147
 148   /* search relative files in the path */
 149   for (auto const& path_elm : surf_path) {
 150     std::string buff = path_elm + "/" + name;
 151     fs->open(buff.c_str(), std::ifstream::in);
 152
 153     if (not fs->fail()) {
 154       XBT_DEBUG("Found file at %s", buff.c_str());
 155       return fs;
 156     }
 157   }
 158
 159   return fs;
 160 }
 161
 162 FILE* surf_fopen(const std::string& name, const char* mode)
 163 {
 164   FILE *file = nullptr;
 165
 166   if (is_absolute_file_path(name)) /* don't mess with absolute file names */
 167     return fopen(name.c_str(), mode);
 168
 169   /* search relative files in the path */
 170   for (auto const& path_elm : surf_path) {
 171     std::string buff = path_elm + "/" + name;
 172     file             = fopen(buff.c_str(), mode);
 173
 174     if (file)
 175       return file;
 176   }
 177   return nullptr;
 178 }
 179
 180 /** Displays the long description of all registered models, and quit */
 181 void model_help(const char* category, const std::vector<surf_model_description_t>& table)
 182 {
 183   XBT_HELP("Long description of the %s models accepted by this simulator:", category);
 184   for (auto const& item : table)
 185     XBT_HELP("  %s: %s", item.name, item.description);
 186 }
 187
 188 int find_model_description(const std::vector<surf_model_description_t>& table, const std::string& name)
 189 {
 190   auto pos = std::find_if(table.begin(), table.end(),
 191                           [&name](const surf_model_description_t& item) { return item.name == name; });
 192   if (pos != table.end())
 193     return static_cast<int>(std::distance(table.begin(), pos));
 194
 195   if (table.empty())
 196     xbt_die("No model is valid! This is a bug.");
 197
 198   std::string sep;
 199   std::string name_list;
 200   for (auto const& item : table) {
 201     name_list += sep + item.name;
 202     sep = ", ";
 203   }
 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
 210 void surf_init(int *argc, char **argv)
 211 {
 212   if (xbt_initialized > 0)
 213     return;
 214
 215   xbt_init(argc, argv);
 216
 217   sg_config_init(argc, argv);
 218 }
 219
 220 void surf_exit()
 221 {
 222   simgrid::s4u::Engine::shutdown();
 223
 224   for (auto const& model : all_existing_models)
 225     delete model;
 226
 227   tmgr_finalize();
 228   sg_platf_exit();
 229
 230   NOW = 0;                      /* Just in case the user plans to restart the simulation afterward */
 231 }