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_ATTRIB_DEPRECATED_v337 ("Please use surf_disk_model_init_S19()") XBT_PUBLIC void surf_disk_model_init_default();
  79 XBT_PUBLIC void surf_disk_model_init_S19();
  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 XBT_PUBLIC void surf_network_model_init_SMPI();
  91
  92 /** @ingroup SURF_models
  93  *  @brief Same as network model 'LagrangeVelho', only with different correction factors.
  94  *
  95  * This model implements a variant of the contention model on Infiniband networks based on
  96  * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
  97  *
  98  *  @see surf_host_model_init_IB()
  99  */
 100 #if !HAVE_SMPI
 101 XBT_ATTRIB_NORETURN
 102 #endif
 103 XBT_PUBLIC void surf_network_model_init_IB();
 104
 105 /** @ingroup SURF_models
 106  *  @brief Initializes the platform with the network model 'LegrandVelho'
 107  *
 108  * This model is proposed by Arnaud Legrand and Pedro Velho based on the results obtained with the GTNets simulator for
 109  * onelink and dogbone sharing scenarios. See comments in the code for more information.
 110  *
 111  *  @see surf_host_model_init_LegrandVelho()
 112  */
 113 XBT_PUBLIC void surf_network_model_init_LegrandVelho();
 114
 115 /** @ingroup SURF_models
 116  *  @brief Initializes the platform with the network model 'Constant'
 117  *
 118  *  In this model, the communication time between two network cards is constant, hence no need for a routing table.
 119  *  This is particularly useful when simulating huge distributed algorithms where scalability is really an issue. This
 120  *  function is called in conjunction with surf_host_model_init_compound.
 121  *
 122  *  @see surf_host_model_init_compound()
 123  */
 124 XBT_PUBLIC void surf_network_model_init_Constant();
 125
 126 /** @ingroup SURF_models
 127  *  @brief Initializes the platform with the network model CM02
 128  *
 129  *  You should call this function by yourself only if you plan using surf_host_model_init_compound.
 130  *  See comments in the code for more information.
 131  */
 132 XBT_PUBLIC void surf_network_model_init_CM02();
 133
 134 /** @ingroup SURF_models
 135  *  @brief Initializes the platform with the network model NS3
 136  *
 137  *  This function is called by surf_host_model_init_NS3 or by yourself only if you plan using
 138  *  surf_host_model_init_compound
 139  *
 140  *  @see surf_host_model_init_NS3()
 141  */
 142 #if !SIMGRID_HAVE_NS3
 143 XBT_ATTRIB_NORETURN
 144 #endif
 145 XBT_PUBLIC void surf_network_model_init_NS3();
 146
 147 /** @ingroup SURF_models
 148  *  @brief Initializes the VM model used in the platform
 149  *
 150  *  A VM model depends on the physical CPU model to share the resources inside the VM
 151  *  It will also creates the CPU model for actions running inside the VM
 152  *
 153  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
 154  */
 155 XBT_PUBLIC void surf_vm_model_init_HL13(simgrid::kernel::resource::CpuModel* cpu_pm_model);
 156
 157 /** @ingroup SURF_models
 158  *  @brief Initializes the platform with a compound host model
 159  *
 160  *  This function should be called after a cpu_model and a network_model have been set up.
 161  */
 162 XBT_PUBLIC void surf_host_model_init_compound();
 163
 164 /** @ingroup SURF_models
 165  *  @brief Initializes the platform with the current best network and cpu models at hand
 166  *
 167  *  This platform model separates the host model and the network model.
 168  *  The host model will be initialized with the model compound, the network model with the model LV08 (with cross
 169  *  traffic support) and the CPU model with the model Cas01.
 170  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
 171  */
 172 XBT_PUBLIC void surf_host_model_init_current_default();
 173
 174 /** @ingroup SURF_models
 175  *  @brief Initializes the platform with the model L07
 176  *
 177  *  With this model, only parallel tasks can be used. Resource sharing is done by identifying bottlenecks and giving an
 178  *  equal share of the model to each action.
 179  */
 180 XBT_PUBLIC void surf_host_model_init_ptask_L07();
 181
 182 /* --------------------
 183  *  Model Descriptions
 184  * -------------------- */
 185 /** @brief Resource model description */
 186 struct surf_model_description_t {
 187   const char* name;
 188   const char* description;
 189   std::function<void()> model_init_preparse;
 190 };
 191
 192 XBT_PUBLIC const surf_model_description_t* find_model_description(const std::vector<surf_model_description_t>& table,
 193                                                                   const std::string& name);
 194 XBT_PUBLIC void model_help(const char* category, const std::vector<surf_model_description_t>& table);
 195
 196 #define SIMGRID_REGISTER_PLUGIN(id, desc, init)                                                                        \
 197   static void XBT_ATTRIB_CONSTRUCTOR(800) _XBT_CONCAT3(simgrid_, id, _plugin_register)()                               \
 198   {                                                                                                                    \
 199     surf_plugin_description().emplace_back(surf_model_description_t{_XBT_STRINGIFY(id), (desc), (init)});              \
 200   }
 201
 202 /** @brief The list of all available plugins */
 203 inline auto& surf_plugin_description() // Function to avoid static initialization order fiasco
 204 {
 205   static std::vector<surf_model_description_t> plugin_description_table;
 206   return plugin_description_table;
 207 }
 208 /** @brief The list of all available optimization modes (both for cpu and networks).
 209  *  These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:... */
 210 XBT_PUBLIC_DATA const std::vector<surf_model_description_t> surf_optimization_mode_description;
 211 /** @brief The list of all cpu models (pick one with --cfg=cpu/model) */
 212 XBT_PUBLIC_DATA const std::vector<surf_model_description_t> surf_cpu_model_description;
 213 /** @brief The list of all network models (pick one with --cfg=network/model) */
 214 XBT_PUBLIC_DATA const std::vector<surf_model_description_t> surf_network_model_description;
 215 /** @brief The list of all disk models (pick one with --cfg=disk/model) */
 216 XBT_PUBLIC_DATA const std::vector<surf_model_description_t> surf_disk_model_description;
 217 /** @brief The list of all host models (pick one with --cfg=host/model:) */
 218 XBT_PUBLIC_DATA const std::vector<surf_model_description_t> surf_host_model_description;
 219
 220 #endif /* SURF_MODEL_H_ */