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