src/surf/surf_interface.hpp

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