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