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