src/include/surf/surf.hpp

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