src/surf/surf_interface.hpp

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