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