src/include/surf/surf.h

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