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