src/surf/surf_interface.cpp

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