src/surf/surf_interface.cpp

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