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