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