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