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