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