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