src/surf/surf_interface.hpp

   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 #ifndef SURF_MODEL_H_
   7 #define SURF_MODEL_H_
   8
   9 #include <xbt/asserts.h>
  10 #include <xbt/function_types.h>
  11
  12 #include "src/internal_config.h"
  13
  14 #include <cfloat>
  15 #include <cmath>
  16 #include <functional>
  17 #include <set>
  18 #include <string>
  19 #include <unordered_map>
  20 #include <vector>
  21
  22 /*********
  23  * Utils *
  24  *********/
  25 XBT_PRIVATE FILE* surf_fopen(const std::string& name, const char* mode);
  26 XBT_PRIVATE std::ifstream* surf_ifsopen(const std::string& name);
  27
  28 /* user-visible parameters */
  29 XBT_PUBLIC_DATA double sg_maxmin_precision;
  30 XBT_PUBLIC_DATA double sg_surf_precision;
  31 XBT_PUBLIC_DATA int sg_concurrency_limit;
  32 XBT_PUBLIC_DATA int sg_bmf_max_iterations;
  33
  34 extern XBT_PRIVATE double sg_latency_factor;
  35 extern XBT_PRIVATE double sg_bandwidth_factor;
  36 extern XBT_PRIVATE double sg_weight_S_parameter;
  37 extern XBT_PRIVATE std::vector<std::string> surf_path;
  38 extern XBT_PRIVATE std::unordered_map<std::string, simgrid::kernel::profile::Profile*> traces_set_list;
  39
  40 /** set of hosts for which one want to be notified if they ever restart */
  41 inline auto& watched_hosts() // avoid static initialization order fiasco
  42 {
  43   static std::set<std::string, std::less<>> value;
  44   return value;
  45 }
  46
  47 static inline void double_update(double* variable, double value, double precision)
  48 {
  49   if (false) { // debug
  50     fprintf(stderr, "Updating %g -= %g +- %g\n", *variable, value, precision);
  51     xbt_assert(value == 0.0 || value > precision);
  52     // Check that precision is higher than the machine-dependent size of the mantissa. If not, brutal rounding  may
  53     // happen, and the precision mechanism is not active...
  54     xbt_assert(FLT_RADIX == 2 && *variable < precision * exp2(DBL_MANT_DIG));
  55   }
  56   *variable -= value;
  57   if (*variable < precision)
  58     *variable = 0.0;
  59 }
  60
  61 static inline int double_positive(double value, double precision)
  62 {
  63   return (value > precision);
  64 }
  65
  66 static inline int double_equals(double value1, double value2, double precision)
  67 {
  68   return (fabs(value1 - value2) < precision);
  69 }
  70
  71 /** @ingroup SURF_models
  72  *  @brief Initializes the CPU model with the model Cas01
  73  *
  74  *  By default, this model uses the lazy optimization mechanism that relies on partial invalidation in LMM and a heap
  75  *  for lazy action update.
  76  *  You can change this behavior by setting the cpu/optim configuration variable to a different value.
  77  *
  78  *  You shouldn't have to call it by yourself.
  79  */
  80 XBT_PUBLIC void surf_cpu_model_init_Cas01();
  81
  82 /** @ingroup SURF_models
  83  *  @brief Same as network model 'LagrangeVelho', only with different correction factors.
  84  *
  85  * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud based on the model 'LV08' and
  86  * different correction factors depending on the communication size (< 1KiB, < 64KiB, >= 64KiB).
  87  * See comments in the code for more information.
  88  *
  89  *  @see surf_host_model_init_SMPI()
  90  */
  91 #if !HAVE_SMPI
  92 XBT_ATTRIB_NORETURN
  93 #endif
  94 XBT_PUBLIC void surf_network_model_init_SMPI();
  95
  96 /** @ingroup SURF_models
  97  *  @brief Same as network model 'LagrangeVelho', only with different correction factors.
  98  *
  99  * This model implements a variant of the contention model on Infiniband networks based on
 100  * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
 101  *
 102  *  @see surf_host_model_init_IB()
 103  */
 104 #if !HAVE_SMPI
 105 XBT_ATTRIB_NORETURN
 106 #endif
 107 XBT_PUBLIC void surf_network_model_init_IB();
 108
 109 /** @ingroup SURF_models
 110  *  @brief Initializes the platform with the network model 'LegrandVelho'
 111  *
 112  * This model is proposed by Arnaud Legrand and Pedro Velho based on the results obtained with the GTNets simulator for
 113  * onelink and dogbone sharing scenarios. See comments in the code for more information.
 114  *
 115  *  @see surf_host_model_init_LegrandVelho()
 116  */
 117 XBT_PUBLIC void surf_network_model_init_LegrandVelho();
 118
 119 /** @ingroup SURF_models
 120  *  @brief Initializes the platform with the network model 'Constant'
 121  *
 122  *  In this model, the communication time between two network cards is constant, hence no need for a routing table.
 123  *  This is particularly useful when simulating huge distributed algorithms where scalability is really an issue. This
 124  *  function is called in conjunction with surf_host_model_init_compound.
 125  *
 126  *  @see surf_host_model_init_compound()
 127  */
 128 XBT_PUBLIC void surf_network_model_init_Constant();
 129
 130 /** @ingroup SURF_models
 131  *  @brief Initializes the platform with the network model CM02
 132  *
 133  *  You should call this function by yourself only if you plan using surf_host_model_init_compound.
 134  *  See comments in the code for more information.
 135  */
 136 XBT_PUBLIC void surf_network_model_init_CM02();
 137
 138 /** @ingroup SURF_models
 139  *  @brief Initializes the platform with the network model NS3
 140  *
 141  *  This function is called by surf_host_model_init_NS3 or by yourself only if you plan using
 142  *  surf_host_model_init_compound
 143  *
 144  *  @see surf_host_model_init_NS3()
 145  */
 146 #if !SIMGRID_HAVE_NS3
 147 XBT_ATTRIB_NORETURN
 148 #endif
 149 XBT_PUBLIC void surf_network_model_init_NS3();
 150
 151 /** @ingroup SURF_models
 152  *  @brief Initializes the VM model used in the platform
 153  *
 154  *  A VM model depends on the physical CPU model to share the resources inside the VM
 155  *  It will also creates the CPU model for actions running inside the VM
 156  *
 157  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
 158  */
 159 XBT_PUBLIC void surf_vm_model_init_HL13(simgrid::kernel::resource::CpuModel* cpu_pm_model);
 160
 161 /** @ingroup SURF_models
 162  *  @brief Initializes the platform with a compound host model
 163  *
 164  *  This function should be called after a cpu_model and a network_model have been set up.
 165  */
 166 XBT_PUBLIC void surf_host_model_init_compound();
 167
 168 /** @ingroup SURF_models
 169  *  @brief Initializes the platform with the current best network and cpu models at hand
 170  *
 171  *  This platform model separates the host model and the network model.
 172  *  The host model will be initialized with the model compound, the network model with the model LV08 (with cross
 173  *  traffic support) and the CPU model with the model Cas01.
 174  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
 175  */
 176 XBT_PUBLIC void surf_host_model_init_current_default();
 177
 178 /** @ingroup SURF_models
 179  *  @brief Initializes the platform with the model L07
 180  *
 181  *  With this model, only parallel tasks can be used. Resource sharing is done by identifying bottlenecks and giving an
 182  *  equal share of the model to each action.
 183  */
 184 XBT_PUBLIC void surf_host_model_init_ptask_L07();
 185
 186 /** @ingroup SURF_models
 187  *  @brief Initializes the platform with the model BMF
 188  *
 189  *  With this model, only parallel tasks can be used.
 190  *  Resource sharing is done by calculating a BMF (bottleneck max fairness) allocation
 191  */
 192 XBT_PUBLIC void surf_host_model_init_ptask_BMF();
 193
 194 XBT_PUBLIC void surf_disk_model_init_default();
 195
 196 /* --------------------
 197  *  Model Descriptions
 198  * -------------------- */
 199 /** @brief Resource model description */
 200 struct surf_model_description_t {
 201   const char* name;
 202   const char* description;
 203   std::function<void()> model_init_preparse;
 204 };
 205
 206 XBT_PUBLIC const surf_model_description_t* find_model_description(const std::vector<surf_model_description_t>& table,
 207                                                                   const std::string& name);
 208 XBT_PUBLIC void model_help(const char* category, const std::vector<surf_model_description_t>& table);
 209
 210 #define SIMGRID_REGISTER_PLUGIN(id, desc, init)                                                                        \
 211   static void XBT_ATTRIB_CONSTRUCTOR(800) _XBT_CONCAT3(simgrid_, id, _plugin_register)()                               \
 212   {                                                                                                                    \
 213     surf_plugin_description().emplace_back(surf_model_description_t{_XBT_STRINGIFY(id), (desc), (init)});              \
 214   }
 215
 216 /** @brief The list of all available plugins */
 217 inline auto& surf_plugin_description() // Function to avoid static initialization order fiasco
 218 {
 219   static std::vector<surf_model_description_t> plugin_description_table;
 220   return plugin_description_table;
 221 }
 222 /** @brief The list of all available optimization modes (both for cpu and networks).
 223  *  These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:... */
 224 XBT_PUBLIC_DATA const std::vector<surf_model_description_t> surf_optimization_mode_description;
 225 /** @brief The list of all cpu models (pick one with --cfg=cpu/model) */
 226 XBT_PUBLIC_DATA const std::vector<surf_model_description_t> surf_cpu_model_description;
 227 /** @brief The list of all network models (pick one with --cfg=network/model) */
 228 XBT_PUBLIC_DATA const std::vector<surf_model_description_t> surf_network_model_description;
 229 /** @brief The list of all disk models (pick one with --cfg=disk/model) */
 230 XBT_PUBLIC_DATA const std::vector<surf_model_description_t> surf_disk_model_description;
 231 /** @brief The list of all host models (pick one with --cfg=host/model:) */
 232 XBT_PUBLIC_DATA const std::vector<surf_model_description_t> surf_host_model_description;
 233
 234 #endif /* SURF_MODEL_H_ */