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