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