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