src/include/surf/surf.h

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