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