src/include/surf/surf.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_SURF_H
   7 #define SURF_SURF_H
   8
   9 #include "simgrid/forward.h"
  10 #include "src/internal_config.h"
  11 #include "xbt/config.h"
  12 #include "xbt/dict.h"
  13 #include "xbt/dynar.h"
  14 #include "xbt/graph.h"
  15 #include "xbt/misc.h"
  16
  17 #ifndef __cplusplus
  18 #error This is a C++ only file, now
  19 #endif
  20
  21 namespace simgrid {
  22 namespace surf {
  23 class CpuModel;
  24 class HostModel;
  25 class NetworkModel;
  26 class StorageModel;
  27 class NetworkCm02Link;
  28 }
  29 }
  30
  31 /** @ingroup SURF_c_bindings
  32  *  \brief Model datatype
  33  *
  34  *  Generic data structure for a model. The hosts,
  35  *  the CPUs and the network links are examples of models.
  36  */
  37 typedef simgrid::surf::CpuModel* surf_cpu_model_t;
  38 typedef simgrid::surf::HostModel* surf_host_model_t;
  39 typedef simgrid::surf::NetworkModel* surf_network_model_t;
  40 typedef simgrid::surf::StorageModel* surf_storage_model_t;
  41
  42 SG_BEGIN_DECL()
  43 /* Actions and models are highly connected structures... */
  44
  45 /* user-visible parameters */
  46 extern XBT_PRIVATE double sg_tcp_gamma;
  47 extern XBT_PRIVATE double sg_latency_factor;
  48 extern XBT_PRIVATE double sg_bandwidth_factor;
  49 extern XBT_PRIVATE double sg_weight_S_parameter;
  50 extern XBT_PRIVATE int sg_network_crosstraffic;
  51
  52 /** \brief Resource model description
  53  */
  54 struct surf_model_description {
  55   const char* name;
  56   const char* description;
  57   void_f_void_t model_init_preparse;
  58 };
  59 typedef struct surf_model_description s_surf_model_description_t;
  60
  61 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t* table, std::string name);
  62 XBT_PUBLIC(void) model_help(const char* category, s_surf_model_description_t* table);
  63
  64 /***************************/
  65 /* Generic model object */
  66 /***************************/
  67
  68 /** @{ @ingroup SURF_c_bindings */
  69
  70 /**
  71  * @brief Pop an action from the done actions set
  72  *
  73  * @param model The model from which the action is extracted
  74  * @return An action in done state
  75  */
  76 XBT_PUBLIC(simgrid::kernel::resource::Action*)
  77 surf_model_extract_done_action_set(simgrid::kernel::resource::Model* model);
  78
  79 /**
  80  * @brief Pop an action from the failed actions set
  81  *
  82  * @param model The model from which the action is extracted
  83  * @return An action in failed state
  84  */
  85 XBT_PUBLIC(simgrid::kernel::resource::Action*)
  86 surf_model_extract_failed_action_set(simgrid::kernel::resource::Model* model);
  87
  88 /**
  89  * @brief Get the size of the running action set of a model
  90  *
  91  * @param model The model
  92  * @return The size of the running action set
  93  */
  94 XBT_PUBLIC(int) surf_model_running_action_set_size(simgrid::kernel::resource::Model* model);
  95
  96 /**
  97  * @brief [brief description]
  98  * @details [long description]
  99  *
 100  * @param action The surf cpu action
 101  * @param bound [description]
 102  */
 103 XBT_PUBLIC(void) surf_cpu_action_set_bound(simgrid::kernel::resource::Action* action, double bound);
 104
 105 /** @} */
 106
 107 /**************************************/
 108 /* Implementations of model object */
 109 /**************************************/
 110
 111 /** \ingroup SURF_models
 112  *  \brief The CPU model object for the physical machine layer
 113  */
 114 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
 115
 116 /** \ingroup SURF_models
 117  *  \brief The CPU model object for the virtual machine layer
 118  */
 119 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
 120
 121 /** \ingroup SURF_models
 122  *  \brief Initializes the CPU model with the model Cas01
 123  *
 124  *  By default, this model uses the lazy optimization mechanism that relies on partial invalidation in LMM and a heap
 125  *  for lazy action update.
 126  *  You can change this behavior by setting the cpu/optim configuration variable to a different value.
 127  *
 128  *  You shouldn't have to call it by yourself.
 129  */
 130 XBT_PUBLIC(void) surf_cpu_model_init_Cas01();
 131
 132 /** \ingroup SURF_models
 133  *  \brief Initializes the CPU model with trace integration [Deprecated]
 134  *
 135  *  You shouldn't have to call it by yourself.
 136  */
 137 XBT_PUBLIC(void) surf_cpu_model_init_ti();
 138
 139 /** \ingroup SURF_models
 140  *  \brief The list of all available optimization modes (both for cpu and networks).
 141  *  These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
 142  */
 143 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
 144
 145 /** \ingroup SURF_plugins
 146  *  \brief The list of all available surf plugins
 147  */
 148 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
 149
 150 /** \ingroup SURF_models
 151  *  \brief The list of all available cpu model models
 152  */
 153 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
 154
 155 /** \ingroup SURF_models
 156  *  \brief The network model
 157  *
 158  *  When creating a new API on top on SURF, you shouldn't use the network model unless you know what you are doing.
 159  *  Only the host model should be accessed because depending on the platform model, the network model can be NULL.
 160  */
 161 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
 162
 163 /** \ingroup SURF_models
 164  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
 165  *
 166  * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud based on the model 'LV08' and
 167  * different correction factors depending on the communication size (< 1KiB, < 64KiB, >= 64KiB).
 168  * See comments in the code for more information.
 169  *
 170  *  \see surf_host_model_init_SMPI()
 171  */
 172 XBT_PUBLIC(void) surf_network_model_init_SMPI();
 173
 174 /** \ingroup SURF_models
 175  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
 176  *
 177  * This model impelments a variant of the contention model on Infinband networks based on
 178  * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
 179  *
 180  *  \see surf_host_model_init_IB()
 181  */
 182 XBT_PUBLIC(void) surf_network_model_init_IB();
 183
 184 /** \ingroup SURF_models
 185  *  \brief Initializes the platform with the network model 'LegrandVelho'
 186  *
 187  * This model is proposed by Arnaud Legrand and Pedro Velho based on the results obtained with the GTNets simulator for
 188  * onelink and dogbone sharing scenarios. See comments in the code for more information.
 189  *
 190  *  \see surf_host_model_init_LegrandVelho()
 191  */
 192 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho();
 193
 194 /** \ingroup SURF_models
 195  *  \brief Initializes the platform with the network model 'Constant'
 196  *
 197  *  In this model, the communication time between two network cards is constant, hence no need for a routing table.
 198  *  This is particularly useful when simulating huge distributed algorithms where scalability is really an issue. This
 199  *  function is called in conjunction with surf_host_model_init_compound.
 200  *
 201  *  \see surf_host_model_init_compound()
 202  */
 203 XBT_PUBLIC(void) surf_network_model_init_Constant();
 204
 205 /** \ingroup SURF_models
 206  *  \brief Initializes the platform with the network model CM02
 207  *
 208  *  You sould call this function by yourself only if you plan using surf_host_model_init_compound.
 209  *  See comments in the code for more information.
 210  */
 211 XBT_PUBLIC(void) surf_network_model_init_CM02();
 212
 213 /** \ingroup SURF_models
 214  *  \brief Initializes the platform with the network model NS3
 215  *
 216  *  This function is called by surf_host_model_init_NS3 or by yourself only if you plan using
 217  *  surf_host_model_init_compound
 218  *
 219  *  \see surf_host_model_init_NS3()
 220  */
 221 XBT_PUBLIC(void) surf_network_model_init_NS3();
 222
 223 /** \ingroup SURF_models
 224  *  \brief Initializes the platform with the network model Reno
 225  *
 226  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 227  *
 228  *  Reference:
 229  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
 230  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 231  *
 232  *  Call this function only if you plan using surf_host_model_init_compound.
 233  */
 234 XBT_PUBLIC(void) surf_network_model_init_Reno();
 235
 236 /** \ingroup SURF_models
 237  *  \brief Initializes the platform with the network model Reno2
 238  *
 239  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 240  *
 241  *  Reference:
 242  *  [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
 243  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 244  *
 245  *  Call this function only if you plan using surf_host_model_init_compound.
 246  */
 247 XBT_PUBLIC(void) surf_network_model_init_Reno2();
 248
 249 /** \ingroup SURF_models
 250  *  \brief Initializes the platform with the network model Vegas
 251  *
 252  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent  to the proportional fairness.
 253  *
 254  *  Reference:
 255  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
 256  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 257  *
 258  *  Call this function only if you plan using surf_host_model_init_compound.
 259  */
 260 XBT_PUBLIC(void) surf_network_model_init_Vegas();
 261
 262 /** \ingroup SURF_models
 263  *  \brief The list of all available network model models
 264  */
 265 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
 266
 267 /** \ingroup SURF_models
 268  *  \brief The storage model
 269  */
 270 XBT_PUBLIC(void) surf_storage_model_init_default();
 271
 272 /** \ingroup SURF_models
 273  *  \brief The list of all available storage modes.
 274  *  This storage mode can be set using --cfg=storage/model:...
 275  */
 276 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
 277
 278 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
 279
 280 /** \ingroup SURF_models
 281  *  \brief The host model
 282  *
 283  *  Note that when you create an API on top of SURF, the host model should be the only one you use
 284  *  because depending on the platform model, the network model and the CPU model may not exist.
 285  */
 286 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
 287
 288 /** \ingroup SURF_models
 289  *  \brief Initializes the platform with a compound host model
 290  *
 291  *  This function should be called after a cpu_model and a network_model have been set up.
 292  */
 293 XBT_PUBLIC(void) surf_host_model_init_compound();
 294
 295 /** \ingroup SURF_models
 296  *  \brief Initializes the platform with the current best network and cpu models at hand
 297  *
 298  *  This platform model separates the host model and the network model.
 299  *  The host model will be initialized with the model compound, the network model with the model LV08 (with cross
 300  *  traffic support) and the CPU model with the model Cas01.
 301  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
 302  */
 303 XBT_PUBLIC(void) surf_host_model_init_current_default();
 304
 305 /** \ingroup SURF_models
 306  *  \brief Initializes the platform with the model L07
 307  *
 308  *  With this model, only parallel tasks can be used. Resource sharing is done by identifying bottlenecks and giving an
 309  *  equal share of the model to each action.
 310  */
 311 XBT_PUBLIC(void) surf_host_model_init_ptask_L07();
 312
 313 /** \ingroup SURF_models
 314  *  \brief The list of all available host model models
 315  */
 316 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_host_model_description[];
 317
 318 /** \ingroup SURF_models
 319  *  \brief Initializes the platform with the current best network and cpu models at hand
 320  *
 321  *  This platform model seperates the host model and the network model.
 322  *  The host model will be initialized with the model compound, the network model with the model LV08 (with cross
 323  *  traffic support) and the CPU model with the model Cas01.
 324  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
 325  */
 326 XBT_PUBLIC(void) surf_vm_model_init_HL13();
 327
 328 /*** SURF Globals **************************/
 329
 330 /** \ingroup SURF_simulation
 331  *  \brief Initialize SURF
 332  *  \param argc argument number
 333  *  \param argv arguments
 334  *
 335  *  This function has to be called to initialize the common structures. Then you will have to create the environment by
 336  *  calling  e.g. surf_host_model_init_CM02()
 337  *
 338  *  \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
 339  */
 340 XBT_PUBLIC(void) surf_init(int* argc, char** argv); /* initialize common structures */
 341
 342 /** \ingroup SURF_simulation
 343  *  \brief Finish simulation initialization
 344  *
 345  *  This function must be called before the first call to surf_solve()
 346  */
 347 XBT_PUBLIC(void) surf_presolve();
 348
 349 /** \ingroup SURF_simulation
 350  *  \brief Performs a part of the simulation
 351  *  \param max_date Maximum date to update the simulation to, or -1
 352  *  \return the elapsed time, or -1.0 if no event could be executed
 353  *
 354  *  This function execute all possible events, update the action states  and returns the time elapsed.
 355  *  When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
 356  *  when you call surf_solve.
 357  *  Note that the returned elapsed time can be zero.
 358  */
 359 XBT_PUBLIC(double) surf_solve(double max_date);
 360
 361 /** \ingroup SURF_simulation
 362  *  \brief Return the current time
 363  *
 364  *  Return the current time in millisecond.
 365  */
 366 XBT_PUBLIC(double) surf_get_clock();
 367
 368 /** \ingroup SURF_simulation
 369  *  \brief Exit SURF
 370  *
 371  *  Clean everything.
 372  *
 373  *  \see surf_init()
 374  */
 375 XBT_PUBLIC(void) surf_exit();
 376
 377 /* surf parse file related (public because called from a test suite) */
 378 XBT_PUBLIC(void) parse_platform_file(const char* file);
 379
 380 /********** Tracing **********/
 381
 382 /* instr_routing.c */
 383 void instr_routing_define_callbacks();
 384 xbt_graph_t instr_routing_platform_graph();
 385 void instr_routing_platform_graph_export_graphviz(xbt_graph_t g, const char* filename);
 386
 387 SG_END_DECL()
 388
 389 #endif