src/include/surf/surf.h

   1 /* Copyright (c) 2004-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef _SURF_SURF_H
   8 #define _SURF_SURF_H
   9
  10 #include "xbt/swag.h"
  11 #include "xbt/dynar.h"
  12 #include "xbt/dict.h"
  13 #include "xbt/graph.h"
  14 #include "xbt/misc.h"
  15 #include "xbt/config.h"
  16 #include "src/internal_config.h"
  17 #include "surf/surf_routing.h"
  18 #include "surf/datatypes.h"
  19 #include "xbt/lib.h"
  20 #include "surf/surf_routing.h"
  21 #include "simgrid/datatypes.h"
  22 #include "simgrid/forward.h"
  23
  24 SG_BEGIN_DECL()
  25 /* Actions and models are highly connected structures... */
  26
  27 /* user-visible parameters */
  28 extern XBT_PRIVATE double sg_tcp_gamma;
  29 extern XBT_PRIVATE double sg_sender_gap;
  30 extern XBT_PRIVATE double sg_latency_factor;
  31 extern XBT_PRIVATE double sg_bandwidth_factor;
  32 extern XBT_PRIVATE double sg_weight_S_parameter;
  33 extern XBT_PRIVATE int sg_network_crosstraffic;
  34 extern XBT_PRIVATE xbt_dynar_t surf_path;
  35
  36 #ifdef __cplusplus
  37
  38 namespace simgrid {
  39 namespace surf {
  40
  41 class Model;
  42 class CpuModel;
  43 class HostModel;
  44 class NetworkModel;
  45 class StorageModel;
  46 class Resource;
  47 class ResourceLmm;
  48 class HostCLM03;
  49 class NetworkCm02Link;
  50 class Action;
  51 class ActionLmm;
  52 class StorageActionLmm;
  53 }
  54 namespace kernel {
  55 namespace routing {
  56 class RoutingPlatf;
  57 }
  58 }
  59 }
  60
  61 typedef simgrid::surf::Model surf_Model;
  62 typedef simgrid::surf::CpuModel surf_CpuModel;
  63 typedef simgrid::surf::HostModel surf_HostModel;
  64 typedef simgrid::surf::NetworkModel surf_NetworkModel;
  65 typedef simgrid::surf::StorageModel surf_StorageModel;
  66 typedef simgrid::surf::Resource surf_Resource;
  67 typedef simgrid::surf::ResourceLmm surf_ResourceLmm;
  68 typedef simgrid::surf::HostImpl surf_Host;
  69 typedef simgrid::surf::HostCLM03 surf_HostCLM03;
  70 typedef simgrid::surf::NetworkCm02Link surf_NetworkCm02Link;
  71 typedef simgrid::surf::Action surf_Action;
  72 typedef simgrid::surf::ActionLmm surf_ActionLmm;
  73 typedef simgrid::surf::StorageActionLmm surf_StorageActionLmm;
  74 typedef simgrid::kernel::routing::RoutingPlatf surf_RoutingPlatf;
  75
  76 #else
  77
  78 typedef struct surf_Model surf_Model;
  79 typedef struct surf_CpuModel surf_CpuModel;
  80 typedef struct surf_HostModel surf_HostModel;
  81 typedef struct surf_NetworkModel surf_NetworkModel;
  82 typedef struct surf_StorageModel surf_StorageModel;
  83 typedef struct surf_Resource surf_Resource;
  84 typedef struct surf_ResourceLmm surf_ResourceLmm;
  85 typedef struct surf_HostCLM03 surf_HostCLM03;
  86 typedef struct surf_Host surf_Host;
  87 typedef struct surf_NetworkCm02Link surf_NetworkCm02Link;
  88 typedef struct surf_Action surf_Action;
  89 typedef struct surf_ActionLmm surf_ActionLmm;
  90 typedef struct surf_StorageActionLmm surf_StorageActionLmm;
  91 typedef struct surf_RoutingPlatf surf_RoutingPlatf;
  92
  93 #endif
  94
  95 /** @ingroup SURF_c_bindings
  96  *  \brief Model datatype
  97  *
  98  *  Generic data structure for a model. The hosts,
  99  *  the CPUs and the network links are examples of models.
 100  */
 101 typedef surf_Model *surf_model_t;
 102 typedef surf_CpuModel *surf_cpu_model_t;
 103 typedef surf_HostModel *surf_host_model_t;
 104 typedef surf_NetworkModel *surf_network_model_t;
 105 typedef surf_StorageModel *surf_storage_model_t;
 106
 107 typedef xbt_dictelm_t surf_resource_t;
 108 typedef surf_Resource *surf_cpp_resource_t;
 109 typedef surf_Host *surf_host_t;
 110 typedef surf_Cpu *surf_cpu_t;
 111
 112 /** @ingroup SURF_c_bindings
 113  *  \brief Action structure
 114  *
 115  *  Never create s_surf_action_t by yourself ! The actions are created
 116  *  on the fly when you call execute or communicate on a model.
 117  *
 118  *  \see e_surf_action_state_t
 119  */
 120 typedef surf_Action *surf_action_t;
 121 typedef surf_RoutingPlatf *routing_platf_t;
 122
 123 typedef struct surf_file *surf_file_t;
 124
 125 /** \brief Resource model description
 126  */
 127 struct surf_model_description {
 128   const char *name;
 129   const char *description;
 130   void_f_void_t model_init_preparse;
 131 };
 132 typedef struct surf_model_description  s_surf_model_description_t;
 133 typedef struct surf_model_description* surf_model_description_t;
 134
 135 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table, const char *name);
 136 XBT_PUBLIC(void) model_help(const char *category, s_surf_model_description_t * table);
 137
 138 /***************************/
 139 /* Generic model object */
 140 /***************************/
 141
 142 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
 143
 144 static inline void *surf_storage_resource_priv(const void *storage){
 145   return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
 146 }
 147
 148 static inline void *surf_storage_resource_by_name(const char *name){
 149   return xbt_lib_get_elm_or_null(storage_lib, name);
 150 }
 151
 152 /** @{ @ingroup SURF_c_bindings */
 153
 154 /**
 155  * @brief Pop an action from the done actions set
 156  *
 157  * @param model The model from which the action is extracted
 158  * @return An action in done state
 159  */
 160 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
 161
 162 /**
 163  * @brief Pop an action from the failed actions set
 164  *
 165  * @param model The model from which the action is extracted
 166  * @return An action in failed state
 167  */
 168 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
 169
 170 /**
 171  * @brief Get the size of the running action set of a model
 172  *
 173  * @param model The model
 174  * @return The size of the running action set
 175  */
 176 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
 177
 178 /** @brief Create a sleep action on the given host */
 179 XBT_PUBLIC(surf_action_t) surf_host_sleep(sg_host_t host, double duration);
 180
 181 /** @brief Create a file opening action on the given host */
 182 XBT_PUBLIC(surf_action_t) surf_host_open(sg_host_t host, const char* fullpath);
 183
 184 /** @brief Create a file closing action on the given host */
 185 XBT_PUBLIC(surf_action_t) surf_host_close(sg_host_t host, surf_file_t fd);
 186
 187 /** @brief Create a file reading action on the given host */
 188 XBT_PUBLIC(surf_action_t) surf_host_read(sg_host_t host, surf_file_t fd, sg_size_t size);
 189
 190 /** @brief Create a file writing action on the given host  */
 191 XBT_PUBLIC(surf_action_t) surf_host_write(sg_host_t host, surf_file_t fd, sg_size_t size);
 192
 193 /**
 194  * @brief Get the information of a file descriptor
 195  * @details The returned xbt_dynar_t contains:
 196  *  - the size of the file,
 197  *  - the mount point,
 198  *  - the storage name,
 199  *  - the storage typeId,
 200  *  - the storage content type
 201  *
 202  * @param host The surf host
 203  * @param fd The file descriptor
 204  * @return An xbt_dynar_t with the file information
 205  */
 206 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(sg_host_t host, surf_file_t fd);
 207
 208 /**
 209  * @brief Get the available space of the storage at the mount point
 210  *
 211  * @param resource The surf host
 212  * @param name The mount point
 213  * @return The amount of available space in bytes
 214  */
 215 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(sg_host_t resource, const char* name);
 216
 217 /**
 218  * @brief Get the used space of the storage at the mount point
 219  *
 220  * @param resource The surf host
 221  * @param name The mount point
 222  * @return The amount of used space in bytes
 223  */
 224 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(sg_host_t resource, const char* name);
 225
 226 /**
 227  * @brief Unlink a file descriptor
 228  *
 229  * @param host The surf host
 230  * @param fd The file descriptor
 231  *
 232  * @return 0 if failed to unlink, 1 otherwise
 233  */
 234 XBT_PUBLIC(int) surf_host_unlink(sg_host_t host, surf_file_t fd);
 235
 236 /**
 237  * @brief Get the size of a file on a host
 238  *
 239  * @param host The surf host
 240  * @param fd The file descriptor
 241  *
 242  * @return The size in bytes of the file
 243  */
 244 XBT_PUBLIC(size_t) surf_host_get_size(sg_host_t host, surf_file_t fd);
 245
 246 /**
 247  * @brief Get the current position of the file descriptor
 248  *
 249  * @param host The surf host
 250  * @param fd The file descriptor
 251  * @return The current position of the file descriptor
 252  */
 253 XBT_PUBLIC(size_t) surf_host_file_tell(sg_host_t host, surf_file_t fd);
 254
 255 /**
 256  * @brief Move a file to another location on the *same mount point*.
 257  * @details [long description]
 258  *
 259  * @param host The surf host
 260  * @param fd The file descriptor
 261  * @param fullpath The new full path
 262  *
 263  * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
 264  */
 265 XBT_PUBLIC(int) surf_host_file_move(sg_host_t host, surf_file_t fd, const char* fullpath);
 266
 267 /**
 268  * @brief Set the position indictator assiociated with the file descriptor to a new position
 269  * @details [long description]
 270  *
 271  * @param host The surf host
 272  * @param fd The file descriptor
 273  * @param offset The offset from the origin
 274  * @param origin Position used as a reference for the offset
 275  *  - SEEK_SET: beginning of the file
 276  *  - SEEK_CUR: current position indicator
 277  *  - SEEK_END: end of the file
 278  * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
 279  */
 280 XBT_PUBLIC(int) surf_host_file_seek(sg_host_t host, surf_file_t fd, sg_offset_t offset, int origin);
 281
 282 /**
 283  * @brief Get the content of a storage
 284  *
 285  * @param resource The surf storage
 286  * @return A xbt_dict_t with path as keys and size in bytes as values
 287  */
 288 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
 289
 290 /**
 291  * @brief Get the size in bytes of a storage
 292  *
 293  * @param resource The surf storage
 294  * @return The size in bytes of the storage
 295  */
 296 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
 297
 298 /**
 299  * @brief Get the available size in bytes of a storage
 300  *
 301  * @param resource The surf storage
 302  * @return The available size in bytes of the storage
 303  */
 304 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
 305
 306 /**
 307  * @brief Get the size in bytes of a storage
 308  *
 309  * @param resource The surf storage
 310  * @return The used size in bytes of the storage
 311  */
 312 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
 313
 314 /** @brief return the properties set associated to that storage */
 315 XBT_PUBLIC(xbt_dict_t) surf_storage_get_properties(surf_resource_t resource);
 316
 317 /**
 318  * @brief [brief description]
 319  * @details [long description]
 320  *
 321  * @param action The surf cpu action
 322  * @param bound [description]
 323  */
 324 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
 325
 326 /**
 327  * @brief [brief description]
 328  * @details [long description]
 329  *
 330  * @param action The surf network action
 331  */
 332 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
 333
 334 /**
 335  * @brief Get the file associated to a storage action
 336  *
 337  * @param action The surf storage action
 338  * @return The file associated to a storage action
 339  */
 340 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
 341
 342 /**
 343  * @brief Get the result dictionary of an ls action
 344  *
 345  * @param action The surf storage action
 346  * @return The dictionry listing a path
 347  */
 348 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
 349
 350
 351 /**
 352  * @brief Get the host the storage is attached to
 353  *
 354  * @param resource The surf storage
 355  * @return The host name
 356  * may not exist.
 357  */
 358 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
 359
 360 /** @} */
 361
 362 /**************************************/
 363 /* Implementations of model object */
 364 /**************************************/
 365
 366 /** \ingroup SURF_models
 367  *  \brief The CPU model object for the physical machine layer
 368  */
 369 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
 370
 371 /** \ingroup SURF_models
 372  *  \brief The CPU model object for the virtual machine layer
 373  */
 374 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
 375
 376
 377 /** \ingroup SURF_models
 378  *  \brief Initializes the CPU model with the model Cas01
 379  *
 380  *  By default, this model uses the lazy optimization mechanism that relies on partial invalidation in LMM and a heap
 381  *  for lazy action update.
 382  *  You can change this behavior by setting the cpu/optim configuration variable to a different value.
 383  *
 384  *  You shouldn't have to call it by yourself.
 385  */
 386 XBT_PUBLIC(void) surf_cpu_model_init_Cas01();
 387
 388 /** \ingroup SURF_models
 389  *  \brief Initializes the CPU model with trace integration [Deprecated]
 390  *
 391  *  You shouldn't have to call it by yourself.
 392  */
 393 XBT_PUBLIC(void) surf_cpu_model_init_ti();
 394
 395 /** \ingroup SURF_models
 396  *  \brief The list of all available optimization modes (both for cpu and networks).
 397  *  These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
 398  */
 399 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
 400
 401 /** \ingroup SURF_plugins
 402  *  \brief The list of all available surf plugins
 403  */
 404 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
 405
 406 /** \ingroup SURF_models
 407  *  \brief The list of all available cpu model models
 408  */
 409 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
 410
 411 /** \ingroup SURF_models
 412  *  \brief The network model
 413  *
 414  *  When creating a new API on top on SURF, you shouldn't use the network model unless you know what you are doing.
 415  *  Only the host model should be accessed because depending on the platform model, the network model can be NULL.
 416  */
 417 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
 418
 419 /** \ingroup SURF_models
 420  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
 421  *
 422  * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud based on the model 'LV08' and
 423  * different correction factors depending on the communication size (< 1KiB, < 64KiB, >= 64KiB).
 424  * See comments in the code for more information.
 425  *
 426  *  \see surf_host_model_init_SMPI()
 427  */
 428 XBT_PUBLIC(void) surf_network_model_init_SMPI();
 429
 430 /** \ingroup SURF_models
 431  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
 432  *
 433  * This model impelments a variant of the contention model on Infinband networks based on
 434  * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
 435  *
 436  *  \see surf_host_model_init_IB()
 437  */
 438 XBT_PUBLIC(void) surf_network_model_init_IB();
 439
 440 /** \ingroup SURF_models
 441  *  \brief Initializes the platform with the network model 'LegrandVelho'
 442  *
 443  * This model is proposed by Arnaud Legrand and Pedro Velho based on the results obtained with the GTNets simulator for
 444  * onelink and dogbone sharing scenarios. See comments in the code for more information.
 445  *
 446  *  \see surf_host_model_init_LegrandVelho()
 447  */
 448 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho();
 449
 450 /** \ingroup SURF_models
 451  *  \brief Initializes the platform with the network model 'Constant'
 452  *
 453  *  In this model, the communication time between two network cards is constant, hence no need for a routing table.
 454  *  This is particularly useful when simulating huge distributed algorithms where scalability is really an issue. This
 455  *  function is called in conjunction with surf_host_model_init_compound.
 456  *
 457  *  \see surf_host_model_init_compound()
 458  */
 459 XBT_PUBLIC(void) surf_network_model_init_Constant();
 460
 461 /** \ingroup SURF_models
 462  *  \brief Initializes the platform with the network model CM02
 463  *
 464  *  You sould call this function by yourself only if you plan using surf_host_model_init_compound.
 465  *  See comments in the code for more information.
 466  */
 467 XBT_PUBLIC(void) surf_network_model_init_CM02();
 468
 469 /** \ingroup SURF_models
 470  *  \brief Initializes the platform with the network model NS3
 471  *
 472  *  This function is called by surf_host_model_init_NS3 or by yourself only if you plan using
 473  *  surf_host_model_init_compound
 474  *
 475  *  \see surf_host_model_init_NS3()
 476  */
 477 XBT_PUBLIC(void) surf_network_model_init_NS3();
 478
 479 /** \ingroup SURF_models
 480  *  \brief Initializes the platform with the network model Reno
 481  *
 482  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 483  *
 484  *  Reference:
 485  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
 486  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 487  *
 488  *  Call this function only if you plan using surf_host_model_init_compound.
 489  */
 490 XBT_PUBLIC(void) surf_network_model_init_Reno();
 491
 492 /** \ingroup SURF_models
 493  *  \brief Initializes the platform with the network model Reno2
 494  *
 495  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 496  *
 497  *  Reference:
 498  *  [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
 499  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 500  *
 501  *  Call this function only if you plan using surf_host_model_init_compound.
 502  */
 503 XBT_PUBLIC(void) surf_network_model_init_Reno2();
 504
 505 /** \ingroup SURF_models
 506  *  \brief Initializes the platform with the network model Vegas
 507  *
 508  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent  to the proportional fairness.
 509  *
 510  *  Reference:
 511  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
 512  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 513  *
 514  *  Call this function only if you plan using surf_host_model_init_compound.
 515  */
 516 XBT_PUBLIC(void) surf_network_model_init_Vegas();
 517
 518 /** \ingroup SURF_models
 519  *  \brief The list of all available network model models
 520  */
 521 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
 522
 523 /** \ingroup SURF_models
 524  *  \brief The storage model
 525  */
 526 XBT_PUBLIC(void) surf_storage_model_init_default();
 527
 528 /** \ingroup SURF_models
 529  *  \brief The list of all available storage modes.
 530  *  This storage mode can be set using --cfg=storage/model:...
 531  */
 532 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
 533
 534 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
 535
 536 /** \ingroup SURF_models
 537  *  \brief The host model
 538  *
 539  *  Note that when you create an API on top of SURF, the host model should be the only one you use
 540  *  because depending on the platform model, the network model and the CPU model may not exist.
 541  */
 542 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
 543
 544 /** \ingroup SURF_models
 545  *  \brief Initializes the platform with a compound host model
 546  *
 547  *  This function should be called after a cpu_model and a network_model have been set up.
 548  */
 549 XBT_PUBLIC(void) surf_host_model_init_compound();
 550
 551 /** \ingroup SURF_models
 552  *  \brief Initializes the platform with the current best network and cpu models at hand
 553  *
 554  *  This platform model separates the host model and the network model.
 555  *  The host model will be initialized with the model compound, the network model with the model LV08 (with cross
 556  *  traffic support) and the CPU model with the model Cas01.
 557  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
 558  */
 559 XBT_PUBLIC(void) surf_host_model_init_current_default();
 560
 561 /** \ingroup SURF_models
 562  *  \brief Initializes the platform with the model L07
 563  *
 564  *  With this model, only parallel tasks can be used. Resource sharing is done by identifying bottlenecks and giving an
 565  *  equal share of the model to each action.
 566  */
 567 XBT_PUBLIC(void) surf_host_model_init_ptask_L07();
 568
 569 /** \ingroup SURF_models
 570  *  \brief The list of all available host model models
 571  */
 572 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_host_model_description[];
 573
 574 /** \ingroup SURF_models
 575  *  \brief Initializes the platform with the current best network and cpu models at hand
 576  *
 577  *  This platform model seperates the host model and the network model.
 578  *  The host model will be initialized with the model compound, the network model with the model LV08 (with cross
 579  *  traffic support) and the CPU model with the model Cas01.
 580  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
 581  */
 582 XBT_PUBLIC(void) surf_vm_model_init_HL13();
 583
 584 /** \ingroup SURF_simulation
 585  *  \brief List of hosts for which one want to be notified if they ever restart.
 586  */
 587 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
 588
 589 /*** SURF Globals **************************/
 590
 591 /** \ingroup SURF_simulation
 592  *  \brief Initialize SURF
 593  *  \param argc argument number
 594  *  \param argv arguments
 595  *
 596  *  This function has to be called to initialize the common structures. Then you will have to create the environment by
 597  *  calling  e.g. surf_host_model_init_CM02()
 598  *
 599  *  \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
 600  */
 601 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
 602
 603 /** \ingroup SURF_simulation
 604  *  \brief Finish simulation initialization
 605  *
 606  *  This function must be called before the first call to surf_solve()
 607  */
 608 XBT_PUBLIC(void) surf_presolve();
 609
 610 /** \ingroup SURF_simulation
 611  *  \brief Performs a part of the simulation
 612  *  \param max_date Maximum date to update the simulation to, or -1
 613  *  \return the elapsed time, or -1.0 if no event could be executed
 614  *
 615  *  This function execute all possible events, update the action states  and returns the time elapsed.
 616  *  When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
 617  *  when you call surf_solve.
 618  *  Note that the returned elapsed time can be zero.
 619  */
 620 XBT_PUBLIC(double) surf_solve(double max_date);
 621
 622 /** \ingroup SURF_simulation
 623  *  \brief Return the current time
 624  *
 625  *  Return the current time in millisecond.
 626  */
 627 XBT_PUBLIC(double) surf_get_clock();
 628
 629 /** \ingroup SURF_simulation
 630  *  \brief Exit SURF
 631  *
 632  *  Clean everything.
 633  *
 634  *  \see surf_init()
 635  */
 636 XBT_PUBLIC(void) surf_exit();
 637
 638 /* Prototypes of the functions that handle the properties */
 639 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;// the prop set for the currently parsed element (also used in SIMIX)
 640 /* The same for model_prop set*/
 641 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
 642
 643 /* surf parse file related (public because called from a test suite) */
 644 XBT_PUBLIC(void) parse_platform_file(const char *file);
 645
 646 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
 647 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
 648
 649 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
 650
 651 /*
 652  * Returns the initial path. On Windows the initial path is the current directory for the current process in the other
 653  * case the function returns "./" that represents the current directory on Unix/Linux platforms.
 654  */
 655 const char *__surf_get_initial_path();
 656
 657 /********** Tracing **********/
 658 /* from surf_instr.c */
 659 void TRACE_surf_action(surf_action_t surf_action, const char *category);
 660 void TRACE_surf_alloc();
 661 void TRACE_surf_release();
 662
 663 /* instr_routing.c */
 664 void instr_routing_define_callbacks ();
 665 void instr_new_variable_type (const char *new_typename, const char *color);
 666 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color);
 667 void instr_new_user_state_type (const char *father_type, const char *new_typename);
 668 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
 669 int instr_platform_traced ();
 670 xbt_graph_t instr_routing_platform_graph ();
 671 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
 672
 673 SG_END_DECL()
 674 #endif                          /* _SURF_SURF_H */