src/surf/surf_interface.hpp

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