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