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