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