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 <simgrid/s4u/Engine.hpp>
   7 #include <xbt/module.h>
   8
   9 #include "mc/mc.h"
  10 #include "simgrid/sg_config.hpp"
  11 #include "src/kernel/resource/profile/FutureEvtSet.hpp"
  12 #include "src/kernel/resource/profile/Profile.hpp"
  13 #include "src/surf/HostImpl.hpp"
  14 #include "src/surf/surf_interface.hpp"
  15 #include "surf/surf.hpp"
  16
  17 #include <fstream>
  18 #include <string>
  19
  20 #ifdef _WIN32
  21 #include <windows.h>
  22 #endif
  23
  24 XBT_LOG_NEW_CATEGORY(surf, "All SURF categories");
  25 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf, "Logging specific to SURF (kernel)");
  26
  27 /*********
  28  * Utils *
  29  *********/
  30
  31 simgrid::kernel::profile::FutureEvtSet future_evt_set;
  32 std::vector<std::string> surf_path;
  33
  34 /* Don't forget to update the option description in smx_config when you change this */
  35 const std::vector<surf_model_description_t> surf_network_model_description = {
  36     {"LV08",
  37      "Realistic network analytic model (slow-start modeled by multiplying latency by 13.01, bandwidth by .97; "
  38      "bottleneck sharing uses a payload of S=20537 for evaluating RTT). ",
  39      &surf_network_model_init_LegrandVelho},
  40     {"Constant",
  41      "Simplistic network model where all communication take a constant time (one second). This model "
  42      "provides the lowest realism, but is (marginally) faster.",
  43      &surf_network_model_init_Constant},
  44     {"SMPI",
  45      "Realistic network model specifically tailored for HPC settings (accurate modeling of slow start with "
  46      "correction factors on three intervals: < 1KiB, < 64 KiB, >= 64 KiB)",
  47      &surf_network_model_init_SMPI},
  48     {"IB", "Realistic network model specifically tailored for HPC settings, with Infiniband contention model",
  49      &surf_network_model_init_IB},
  50     {"CM02",
  51      "Legacy network analytic model (Very similar to LV08, but without corrective factors. The timings of "
  52      "small messages are thus poorly modeled).",
  53      &surf_network_model_init_CM02},
  54     {"ns-3", "Network pseudo-model using the ns-3 tcp model instead of an analytic model",
  55      &surf_network_model_init_NS3},
  56 };
  57
  58 #if !HAVE_SMPI
  59 void surf_network_model_init_SMPI()
  60 {
  61   xbt_die("Please activate SMPI support in cmake to use the SMPI network model.");
  62 }
  63 void surf_network_model_init_IB()
  64 {
  65   xbt_die("Please activate SMPI support in cmake to use the IB network model.");
  66 }
  67 #endif
  68 #if !SIMGRID_HAVE_NS3
  69 void surf_network_model_init_NS3()
  70 {
  71   xbt_die("Please activate ns-3 support in cmake and install the dependencies to use the NS3 network model.");
  72 }
  73 #endif
  74
  75 const std::vector<surf_model_description_t> surf_cpu_model_description = {
  76     {"Cas01", "Simplistic CPU model (time=size/speed).", &surf_cpu_model_init_Cas01},
  77 };
  78
  79 const std::vector<surf_model_description_t> surf_host_model_description = {
  80     {"default", "Default host model. Currently, CPU:Cas01 and network:LV08 (with cross traffic enabled)",
  81      &surf_host_model_init_current_default},
  82     {"compound", "Host model that is automatically chosen if you change the network and CPU models",
  83      &surf_host_model_init_compound},
  84     {"ptask_L07", "Host model somehow similar to Cas01+CM02 but allowing parallel tasks",
  85      &surf_host_model_init_ptask_L07},
  86 };
  87
  88 const std::vector<surf_model_description_t> surf_optimization_mode_description = {
  89     {"Lazy", "Lazy action management (partial invalidation in lmm + heap in action remaining).", nullptr},
  90     {"TI",
  91      "Trace integration. Highly optimized mode when using availability traces (only available for the Cas01 CPU "
  92      "model for now).",
  93      nullptr},
  94     {"Full", "Full update of remaining and variables. Slow but may be useful when debugging.", nullptr},
  95 };
  96
  97 const std::vector<surf_model_description_t> surf_disk_model_description = {
  98     {"default", "Simplistic disk model.", &surf_disk_model_init_default},
  99 };
 100
 101 double NOW = 0;
 102
 103 double surf_get_clock()
 104 {
 105   return NOW;
 106 }
 107
 108 /* returns whether #file_path is an absolute file path. Surprising, isn't it ? */
 109 static bool is_absolute_file_path(const std::string& file_path)
 110 {
 111 #ifdef _WIN32
 112   WIN32_FIND_DATA wfd = {0};
 113   HANDLE hFile        = FindFirstFile(file_path.c_str(), &wfd);
 114
 115   if (INVALID_HANDLE_VALUE == hFile)
 116     return false;
 117
 118   FindClose(hFile);
 119   return true;
 120 #else
 121   return (file_path.c_str()[0] == '/');
 122 #endif
 123 }
 124
 125 std::ifstream* surf_ifsopen(const std::string& name)
 126 {
 127   xbt_assert(not name.empty());
 128
 129   auto* fs = new std::ifstream();
 130   if (is_absolute_file_path(name)) { /* don't mess with absolute file names */
 131     fs->open(name.c_str(), std::ifstream::in);
 132   }
 133
 134   /* search relative files in the path */
 135   for (auto const& path_elm : surf_path) {
 136     std::string buff = path_elm + "/" + name;
 137     fs->open(buff.c_str(), std::ifstream::in);
 138
 139     if (not fs->fail()) {
 140       XBT_DEBUG("Found file at %s", buff.c_str());
 141       return fs;
 142     }
 143   }
 144
 145   return fs;
 146 }
 147
 148 FILE* surf_fopen(const std::string& name, const char* mode)
 149 {
 150   FILE* file = nullptr;
 151
 152   if (is_absolute_file_path(name)) /* don't mess with absolute file names */
 153     return fopen(name.c_str(), mode);
 154
 155   /* search relative files in the path */
 156   for (auto const& path_elm : surf_path) {
 157     std::string buff = path_elm + "/" + name;
 158     file             = fopen(buff.c_str(), mode);
 159
 160     if (file)
 161       return file;
 162   }
 163   return nullptr;
 164 }
 165
 166 /** Displays the long description of all registered models, and quit */
 167 void model_help(const char* category, const std::vector<surf_model_description_t>& table)
 168 {
 169   XBT_HELP("Long description of the %s models accepted by this simulator:", category);
 170   for (auto const& item : table)
 171     XBT_HELP("  %s: %s", item.name, item.description);
 172 }
 173
 174 const surf_model_description_t* find_model_description(const std::vector<surf_model_description_t>& table,
 175                                                        const std::string& name)
 176 {
 177   auto pos = std::find_if(table.begin(), table.end(),
 178                           [&name](const surf_model_description_t& item) { return item.name == name; });
 179   if (pos != table.end())
 180     return &*pos;
 181
 182   std::string sep;
 183   std::string name_list;
 184   for (auto const& item : table) {
 185     name_list += sep + item.name;
 186     sep = ", ";
 187   }
 188   xbt_die("Model '%s' is invalid! Valid models are: %s.", name.c_str(), name_list.c_str());
 189 }