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