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