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 "surf/surf.hpp"
  15 #include "xbt/module.h"
  16 #include "xbt/xbt_modinter.h" /* whether initialization was already done */
  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 simgrid::kernel::profile::FutureEvtSet future_evt_set;
  33 std::vector<std::string> surf_path;
  34
  35 std::vector<surf_model_description_t>* surf_plugin_description = nullptr;
  36
  37 static void XBT_ATTRIB_DESTRUCTOR(800) simgrid_free_plugin_description()
  38 {
  39   delete surf_plugin_description;
  40   surf_plugin_description = nullptr;
  41 }
  42
  43 XBT_PUBLIC void simgrid_add_plugin_description(const char* name, const char* description, void_f_void_t init_fun)
  44 {
  45   if (not surf_plugin_description)
  46     surf_plugin_description = new std::vector<surf_model_description_t>();
  47   surf_plugin_description->emplace_back(surf_model_description_t{name, description, init_fun});
  48 }
  49
  50 /* Don't forget to update the option description in smx_config when you change this */
  51 const std::vector<surf_model_description_t> surf_network_model_description = {
  52     {"LV08",
  53      "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",
  57      "Simplistic network model where all communication take a constant time (one second). This model "
  58      "provides the lowest realism, but is (marginally) faster.",
  59      &surf_network_model_init_Constant},
  60     {"SMPI",
  61      "Realistic network model specifically tailored for HPC settings (accurate modeling of slow start with "
  62      "correction factors on three intervals: < 1KiB, < 64 KiB, >= 64 KiB)",
  63      &surf_network_model_init_SMPI},
  64     {"IB", "Realistic network model specifically tailored for HPC settings, with Infiniband contention model",
  65      &surf_network_model_init_IB},
  66     {"CM02",
  67      "Legacy network analytic model (Very similar to LV08, but without corrective factors. The timings of "
  68      "small messages are thus poorly modeled).",
  69      &surf_network_model_init_CM02},
  70     {"ns-3", "Network pseudo-model using the ns-3 tcp model instead of an analytic model",
  71      &surf_network_model_init_NS3},
  72 };
  73
  74 #if !HAVE_SMPI
  75 void surf_network_model_init_SMPI()
  76 {
  77   xbt_die("Please activate SMPI support in cmake to use the SMPI network model.");
  78 }
  79 void surf_network_model_init_IB()
  80 {
  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 {
  87   xbt_die("Please activate ns-3 support in cmake and install the dependencies to use the NS3 network model.");
  88 }
  89 #endif
  90
  91 const std::vector<surf_model_description_t> surf_cpu_model_description = {
  92     {"Cas01", "Simplistic CPU model (time=size/speed).", &surf_cpu_model_init_Cas01},
  93 };
  94
  95 const std::vector<surf_model_description_t> surf_host_model_description = {
  96     {"default", "Default host model. Currently, CPU:Cas01 and network:LV08 (with cross traffic enabled)",
  97      &surf_host_model_init_current_default},
  98     {"compound", "Host model that is automatically chosen if you change the network and CPU models",
  99      &surf_host_model_init_compound},
 100     {"ptask_L07", "Host model somehow similar to Cas01+CM02 but allowing parallel tasks",
 101      &surf_host_model_init_ptask_L07},
 102 };
 103
 104 const std::vector<surf_model_description_t> surf_optimization_mode_description = {
 105     {"Lazy", "Lazy action management (partial invalidation in lmm + heap in action remaining).", nullptr},
 106     {"TI",
 107      "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 double NOW = 0;
 118
 119 double surf_get_clock()
 120 {
 121   return NOW;
 122 }
 123
 124 /* returns whether #file_path is an absolute file path. Surprising, isn't it ? */
 125 static bool is_absolute_file_path(const std::string& file_path)
 126 {
 127 #ifdef _WIN32
 128   WIN32_FIND_DATA wfd = {0};
 129   HANDLE hFile        = FindFirstFile(file_path.c_str(), &wfd);
 130
 131   if (INVALID_HANDLE_VALUE == hFile)
 132     return false;
 133
 134   FindClose(hFile);
 135   return true;
 136 #else
 137   return (file_path.c_str()[0] == '/');
 138 #endif
 139 }
 140
 141 std::ifstream* surf_ifsopen(const std::string& name)
 142 {
 143   xbt_assert(not name.empty());
 144
 145   auto* fs = new std::ifstream();
 146   if (is_absolute_file_path(name)) { /* don't mess with absolute file names */
 147     fs->open(name.c_str(), std::ifstream::in);
 148   }
 149
 150   /* search relative files in the path */
 151   for (auto const& path_elm : surf_path) {
 152     std::string buff = path_elm + "/" + name;
 153     fs->open(buff.c_str(), std::ifstream::in);
 154
 155     if (not fs->fail()) {
 156       XBT_DEBUG("Found file at %s", buff.c_str());
 157       return fs;
 158     }
 159   }
 160
 161   return fs;
 162 }
 163
 164 FILE* surf_fopen(const std::string& name, const char* mode)
 165 {
 166   FILE* file = nullptr;
 167
 168   if (is_absolute_file_path(name)) /* don't mess with absolute file names */
 169     return fopen(name.c_str(), mode);
 170
 171   /* search relative files in the path */
 172   for (auto const& path_elm : surf_path) {
 173     std::string buff = path_elm + "/" + name;
 174     file             = fopen(buff.c_str(), mode);
 175
 176     if (file)
 177       return file;
 178   }
 179   return nullptr;
 180 }
 181
 182 /** Displays the long description of all registered models, and quit */
 183 void model_help(const char* category, const std::vector<surf_model_description_t>& table)
 184 {
 185   XBT_HELP("Long description of the %s models accepted by this simulator:", category);
 186   for (auto const& item : table)
 187     XBT_HELP("  %s: %s", item.name, item.description);
 188 }
 189
 190 int find_model_description(const std::vector<surf_model_description_t>& table, const std::string& name)
 191 {
 192   auto pos = std::find_if(table.begin(), table.end(),
 193                           [&name](const surf_model_description_t& item) { return item.name == name; });
 194   if (pos != table.end())
 195     return static_cast<int>(std::distance(table.begin(), pos));
 196
 197   if (table.empty())
 198     xbt_die("No model is valid! This is a bug.");
 199
 200   std::string sep;
 201   std::string name_list;
 202   for (auto const& item : table) {
 203     name_list += sep + item.name;
 204     sep = ", ";
 205   }
 206
 207   xbt_die("Model '%s' is invalid! Valid models are: %s.", name.c_str(), name_list.c_str());
 208   return -1;
 209 }
 210
 211 void surf_init(int* argc, char** argv)
 212 {
 213   if (xbt_initialized > 0)
 214     return;
 215
 216   xbt_init(argc, argv);
 217
 218   sg_config_init(argc, argv);
 219 }
 220
 221 void surf_exit()
 222 {
 223   simgrid::s4u::Engine::shutdown();
 224
 225   tmgr_finalize();
 226   sg_platf_exit();
 227
 228   NOW = 0; /* Just in case the user plans to restart the simulation afterward */
 229 }