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