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