src/surf/surf_interface.hpp

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