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/platf_interface.h"
  22 #include "simgrid/datatypes.h"
  23 #include "simgrid/plugins.h"
  24 #include "simgrid/forward.h"
  25
  26 SG_BEGIN_DECL()
  27 /* Actions and models are highly connected structures... */
  28
  29 /* user-visible parameters */
  30 extern XBT_PRIVATE double sg_tcp_gamma;
  31 extern XBT_PRIVATE double sg_sender_gap;
  32 extern XBT_PRIVATE double sg_latency_factor;
  33 extern XBT_PRIVATE double sg_bandwidth_factor;
  34 extern XBT_PRIVATE double sg_weight_S_parameter;
  35 extern XBT_PRIVATE int sg_network_crosstraffic;
  36 extern XBT_PRIVATE xbt_dynar_t surf_path;
  37
  38 typedef enum {
  39   SURF_NETWORK_ELEMENT_NULL = 0,        /* NULL */
  40   SURF_NETWORK_ELEMENT_HOST,    /* host type */
  41   SURF_NETWORK_ELEMENT_ROUTER,  /* router type */
  42   SURF_NETWORK_ELEMENT_AS       /* AS type */
  43 } e_surf_network_element_type_t;
  44
  45 #ifdef __cplusplus
  46
  47 namespace simgrid {
  48 namespace surf {
  49
  50 class Model;
  51 class CpuModel;
  52 class HostModel;
  53 class VMModel;
  54 class NetworkModel;
  55 class StorageModel;
  56 class Resource;
  57 class ResourceLmm;
  58 class Host;
  59 class HostCLM03;
  60 class NetworkCm02Link;
  61 class Action;
  62 class ActionLmm;
  63 class StorageActionLmm;
  64 class As;
  65 class RoutingPlatf;
  66
  67 }
  68 }
  69
  70 typedef simgrid::surf::Model surf_Model;
  71 typedef simgrid::surf::CpuModel surf_CpuModel;
  72 typedef simgrid::surf::HostModel surf_HostModel;
  73 typedef simgrid::surf::VMModel surf_VMModel;
  74 typedef simgrid::surf::NetworkModel surf_NetworkModel;
  75 typedef simgrid::surf::StorageModel surf_StorageModel;
  76 typedef simgrid::surf::Resource surf_Resource;
  77 typedef simgrid::surf::ResourceLmm surf_ResourceLmm;
  78 typedef simgrid::surf::Host surf_Host;
  79 typedef simgrid::surf::HostCLM03 surf_HostCLM03;
  80 typedef simgrid::surf::NetworkCm02Link surf_NetworkCm02Link;
  81 typedef simgrid::surf::Action surf_Action;
  82 typedef simgrid::surf::ActionLmm surf_ActionLmm;
  83 typedef simgrid::surf::StorageActionLmm surf_StorageActionLmm;
  84 typedef simgrid::surf::RoutingPlatf surf_RoutingPlatf;
  85
  86 #else
  87
  88 typedef struct surf_Model surf_Model;
  89 typedef struct surf_CpuModel surf_CpuModel;
  90 typedef struct surf_HostModel surf_HostModel;
  91 typedef struct surf_VMModel surf_VMModel;
  92 typedef struct surf_NetworkModel surf_NetworkModel;
  93 typedef struct surf_StorageModel surf_StorageModel;
  94 typedef struct surf_Resource surf_Resource;
  95 typedef struct surf_ResourceLmm surf_ResourceLmm;
  96 typedef struct surf_HostCLM03 surf_HostCLM03;
  97 typedef struct surf_Host surf_Host;
  98 typedef struct surf_NetworkCm02Link surf_NetworkCm02Link;
  99 typedef struct surf_Action surf_Action;
 100 typedef struct surf_ActionLmm surf_ActionLmm;
 101 typedef struct surf_StorageActionLmm surf_StorageActionLmm;
 102 typedef struct surf_RoutingPlatf surf_RoutingPlatf;
 103
 104 #endif
 105
 106 /** @ingroup SURF_c_bindings
 107  *  \brief Model datatype
 108  *
 109  *  Generic data structure for a model. The hosts,
 110  *  the CPUs and the network links are examples of models.
 111  */
 112 typedef surf_Model *surf_model_t;
 113 typedef surf_CpuModel *surf_cpu_model_t;
 114 typedef surf_HostModel *surf_host_model_t;
 115 typedef surf_VMModel *surf_vm_model_t;
 116 typedef surf_NetworkModel *surf_network_model_t;
 117 typedef surf_StorageModel *surf_storage_model_t;
 118
 119 typedef xbt_dictelm_t surf_resource_t;
 120 typedef surf_Resource *surf_cpp_resource_t;
 121 typedef surf_Host *surf_host_t;
 122 typedef surf_Cpu *surf_cpu_t;
 123
 124 /** @ingroup SURF_c_bindings
 125  *  \brief Action structure
 126  *
 127  *  Never create s_surf_action_t by yourself ! The actions are created
 128  *  on the fly when you call execute or communicate on a model.
 129  *
 130  *  \see e_surf_action_state_t
 131  */
 132 typedef surf_Action *surf_action_t;
 133 typedef surf_RoutingPlatf *routing_platf_t;
 134
 135 typedef struct surf_file *surf_file_t;
 136
 137 XBT_PUBLIC(e_surf_network_element_type_t)
 138   routing_get_network_element_type(const char* name);
 139
 140 /** @Brief Specify that we use that action */
 141 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
 142
 143 /** @brief Creates a new action.
 144  *
 145  * @param size The size is the one of the subtype you want to create
 146  * @param cost initial value
 147  * @param model to which model we should attach this action
 148  * @param failed whether we should start this action in failed mode
 149  */
 150 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
 151                                    surf_model_t model, int failed);
 152
 153 /** \brief Resource model description
 154  */
 155 typedef struct surf_model_description {
 156   const char *name;
 157   const char *description;
 158   void_f_void_t model_init_preparse;
 159 } s_surf_model_description_t, *surf_model_description_t;
 160
 161 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
 162                                        const char *name);
 163 XBT_PUBLIC(void) model_help(const char *category,
 164                             s_surf_model_description_t * table);
 165
 166 /** @ingroup SURF_interface
 167  *  @brief Action states
 168  *
 169  *  @see Action
 170  */
 171 typedef enum {
 172   SURF_ACTION_READY = 0,        /**< Ready        */
 173   SURF_ACTION_RUNNING,          /**< Running      */
 174   SURF_ACTION_FAILED,           /**< Task Failure */
 175   SURF_ACTION_DONE,             /**< Completed    */
 176   SURF_ACTION_TO_FREE,          /**< Action to free in next cleanup */
 177   SURF_ACTION_NOT_IN_THE_SYSTEM /**< Not in the system anymore. Why did you ask ? */
 178 } e_surf_action_state_t;
 179
 180 /** @ingroup SURF_vm_interface
 181  *
 182  *
 183  */
 184 /* FIXME: Where should the VM state be defined? */
 185 typedef enum {
 186   SURF_VM_STATE_CREATED, /**< created, but not yet started */
 187   SURF_VM_STATE_RUNNING,
 188   SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
 189
 190   SURF_VM_STATE_SAVING, /**< Save/restore involves disk I/O, so there should be transition states. */
 191   SURF_VM_STATE_SAVED,
 192   SURF_VM_STATE_RESTORING,
 193 } e_surf_vm_state_t;
 194
 195 /***************************/
 196 /* Generic model object */
 197 /***************************/
 198
 199 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
 200
 201 static inline surf_host_t surf_host_resource_priv(const void *host){
 202   return (surf_host_t) xbt_lib_get_level((xbt_dictelm_t)host, SURF_HOST_LEVEL);
 203 }
 204 static inline void *surf_storage_resource_priv(const void *storage){
 205   return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
 206 }
 207
 208 static inline void *surf_storage_resource_by_name(const char *name){
 209   return xbt_lib_get_elm_or_null(storage_lib, name);
 210 }
 211
 212 /** @{ @ingroup SURF_c_bindings */
 213
 214 /**
 215  * @brief Pop an action from the done actions set
 216  *
 217  * @param model The model from which the action is extracted
 218  * @return An action in done state
 219  */
 220 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
 221
 222 /**
 223  * @brief Pop an action from the failed actions set
 224  *
 225  * @param model The model from which the action is extracted
 226  * @return An action in failed state
 227  */
 228 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
 229
 230 /**
 231  * @brief Pop an action from the ready actions set
 232  *
 233  * @param model The model from which the action is extracted
 234  * @return An action in ready state
 235  */
 236 XBT_PUBLIC(surf_action_t) surf_model_extract_ready_action_set(surf_model_t model);
 237
 238 /**
 239  * @brief Pop an action from the running actions set
 240  *
 241  * @param model The model from which the action is extracted
 242  * @return An action in running state
 243  */
 244 XBT_PUBLIC(surf_action_t) surf_model_extract_running_action_set(surf_model_t model);
 245
 246 /**
 247  * @brief Get the size of the running action set of a model
 248  *
 249  * @param model The model
 250  * @return The size of the running action set
 251  */
 252 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
 253
 254 /**
 255  * @brief Execute a parallel task
 256  * @details [long description]
 257  *
 258  * @param model The model which handle the parallelisation
 259  * @param host_nb The number of hosts
 260  * @param host_list The list of hosts on which the task is executed
 261  * @param flops_amount The processing amount (in flop) needed to process
 262  * @param bytes_amount The amount of data (in bytes) needed to transfer
 263  * @param rate [description]
 264  * @return The action corresponding to the parallele execution task
 265  */
 266 XBT_PUBLIC(surf_action_t) surf_host_model_execute_parallel_task(surf_host_model_t model,
 267                                                     int host_nb,
 268                                         sg_host_t *host_list,
 269                                             double *flops_amount,
 270                                             double *bytes_amount,
 271                                             double rate);
 272
 273 /** @brief Get the route (dynar of sg_link_t) between two hosts */
 274 XBT_PUBLIC(xbt_dynar_t) surf_host_model_get_route(surf_host_model_t model, surf_resource_t src, surf_resource_t dst);
 275
 276 /** @brief Create a new VM on the specified host */
 277 XBT_PUBLIC(void) surf_vm_model_create(const char *name, surf_resource_t host_PM);
 278
 279 /** @brief Create a communication between two hosts
 280  *
 281  * @param model The model which handle the communication
 282  * @param src The source host
 283  * @param dst The destination host
 284  * @param size The amount of data (in bytes) needed to transfer
 285  * @param rate [description]
 286  * @return The action corresponding to the communication
 287  */
 288 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);
 289
 290 /**
 291  * @brief Get the name of a surf resource (cpu, host, network, …)
 292  *
 293  * @param resource The surf resource
 294  * @return The name of the surf resource
 295  */
 296 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
 297 static inline const char * surf_cpu_name(surf_cpu_t cpu) {
 298         return surf_resource_name((surf_cpp_resource_t)cpu);
 299 }
 300
 301 /** @brief Get the properties of a surf resource (cpu, host, network, …) */
 302 XBT_PUBLIC(xbt_dict_t) surf_resource_get_properties(surf_cpp_resource_t resource);
 303 static XBT_INLINE xbt_dict_t surf_host_get_properties(surf_host_t host) {
 304         return surf_resource_get_properties((surf_cpp_resource_t)host);
 305 }
 306
 307
 308 /** @brief Get the state of a surf resource (cpu, host, network, …) */
 309 XBT_PUBLIC(e_surf_resource_state_t) surf_resource_get_state(surf_cpp_resource_t resource);
 310
 311 static XBT_INLINE e_surf_resource_state_t surf_host_get_state(surf_host_t host) {
 312         return surf_resource_get_state((surf_cpp_resource_t)host);
 313 }
 314
 315
 316 /** @brief Set the state of a surf resource (cpu, host, network, …) */
 317 XBT_PUBLIC(void) surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state);
 318 static inline void surf_host_set_state(surf_host_t host, e_surf_resource_state_t state) {
 319         surf_resource_set_state((surf_cpp_resource_t)host, state);
 320 }
 321
 322 /** @brief Get the speed of the cpu associated to a host */
 323 XBT_PUBLIC(double) surf_host_get_speed(surf_resource_t resource, double load);
 324
 325 /** @brief Get the available speed of cpu associated to a host */
 326 XBT_PUBLIC(double) surf_host_get_available_speed(surf_resource_t host);
 327
 328 /** @brief Get the number of cores of the cpu associated to a host */
 329 XBT_PUBLIC(int) surf_host_get_core(surf_resource_t host);
 330
 331 /** @brief Create a computation action on the given host */
 332 XBT_PUBLIC(surf_action_t) surf_host_execute(surf_resource_t host, double size);
 333
 334 /** @brief Create a sleep action on the given host */
 335 XBT_PUBLIC(surf_action_t) surf_host_sleep(surf_resource_t host, double duration);
 336
 337 /** @brief Create a file opening action on the given host */
 338 XBT_PUBLIC(surf_action_t) surf_host_open(surf_resource_t host, const char* fullpath);
 339
 340 /** @brief Create a file closing action on the given host */
 341 XBT_PUBLIC(surf_action_t) surf_host_close(surf_resource_t host, surf_file_t fd);
 342
 343 /** @brief Create a file reading action on the given host */
 344 XBT_PUBLIC(surf_action_t) surf_host_read(surf_resource_t host, surf_file_t fd, sg_size_t size);
 345
 346 /** @brief Create a file writing action on the given host  */
 347 XBT_PUBLIC(surf_action_t) surf_host_write(surf_resource_t host, surf_file_t fd, sg_size_t size);
 348
 349 /**
 350  * @brief Get the informations of a file descriptor
 351  * @details The returned xbt_dynar_t contains:
 352  *  - the size of the file,
 353  *  - the mount point,
 354  *  - the storage name,
 355  *  - the storage typeId,
 356  *  - the storage content type
 357  *
 358  * @param host The surf host
 359  * @param fd The file descriptor
 360  * @return An xbt_dynar_t with the file informations
 361  */
 362 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(surf_resource_t host, surf_file_t fd);
 363
 364 /**
 365  * @brief Get the available space of the storage at the mount point
 366  *
 367  * @param resource The surf host
 368  * @param name The mount point
 369  * @return The amount of available space in bytes
 370  */
 371 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(surf_resource_t resource, const char* name);
 372
 373 /**
 374  * @brief Get the used space of the storage at the mount point
 375  *
 376  * @param resource The surf host
 377  * @param name The mount point
 378  * @return The amount of used space in bytes
 379  */
 380 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(surf_resource_t resource, const char* name);
 381
 382 /** @brief Get the list of VMs hosted on the host */
 383 XBT_PUBLIC(xbt_dynar_t) surf_host_get_vms(surf_resource_t resource);
 384
 385 /** @brief Retrieve the params of that VM
 386  * @details You can use fields ramsize and overcommit on a PM, too.
 387  */
 388 XBT_PUBLIC(void) surf_host_get_params(surf_resource_t resource, vm_params_t params);
 389
 390 /** @brief Sets the params of that VM/PM
 391  * @details You can use fields ramsize and overcommit on a PM, too.
 392  */
 393 XBT_PUBLIC(void) surf_host_set_params(surf_resource_t resource, vm_params_t params);
 394
 395 /**
 396  * @brief Destroy a VM
 397  *
 398  * @param resource The surf vm
 399  */
 400 XBT_PUBLIC(void) surf_vm_destroy(surf_resource_t resource);
 401
 402 /** @brief Suspend a VM */
 403 XBT_PUBLIC(void) surf_vm_suspend(surf_resource_t resource);
 404
 405 /** @brief Resume a VM */
 406 XBT_PUBLIC(void) surf_vm_resume(surf_resource_t resource);
 407
 408 /**
 409  * @brief Save the VM (Not yet implemented)
 410  *
 411  * @param resource The surf vm
 412  */
 413 XBT_PUBLIC(void) surf_vm_save(surf_resource_t resource);
 414
 415 /**
 416  * @brief Restore the VM (Not yet implemented)
 417  *
 418  * @param resource The surf vm
 419  */
 420 XBT_PUBLIC(void) surf_vm_restore(surf_resource_t resource);
 421
 422 /**
 423  * @brief Migrate the VM to the destination host
 424  *
 425  * @param resource The surf vm
 426  * @param ind_vm_ws_dest The destination host
 427  */
 428 XBT_PUBLIC(void) surf_vm_migrate(surf_resource_t resource, surf_resource_t ind_vm_ws_dest);
 429
 430 /**
 431  * @brief Get the physical machine hosting the VM
 432  *
 433  * @param resource The surf vm
 434  * @return The physical machine hosting the VM
 435  */
 436 XBT_PUBLIC(surf_resource_t) surf_vm_get_pm(surf_resource_t resource);
 437
 438 /**
 439  * @brief [brief description]
 440  * @details [long description]
 441  *
 442  * @param resource [description]
 443  * @param bound [description]
 444  */
 445 XBT_PUBLIC(void) surf_vm_set_bound(surf_resource_t resource, double bound);
 446
 447 /**
 448  * @brief [brief description]
 449  * @details [long description]
 450  *
 451  * @param resource [description]
 452  * @param cpu [description]
 453  * @param mask [description]
 454  */
 455 XBT_PUBLIC(void) surf_vm_set_affinity(surf_resource_t resource, surf_resource_t cpu, unsigned long mask);
 456
 457 /**
 458  * @brief Execute some quantity of computation
 459  *
 460  * @param cpu The surf cpu
 461  * @param size The value of the processing amount (in flop) needed to process
 462  * @return The surf action corresponding to the processing
 463  */
 464 XBT_PUBLIC(surf_action_t) surf_cpu_execute(surf_resource_t cpu, double size);
 465
 466 /**
 467  * @brief Make the cpu sleep for duration (in seconds)
 468  * @details [long description]
 469  *
 470  * @param cpu The surf cpu
 471  * @param duration The number of seconds to sleep
 472  * @return The surf action corresponding to the sleeping
 473  */
 474 XBT_PUBLIC(surf_action_t) surf_cpu_sleep(surf_resource_t cpu, double duration);
 475
 476 /**
 477  * @brief Get the host power peak
 478  * @details [long description]
 479  *
 480  * @param host The surf host
 481  * @return The power peak
 482  */
 483 XBT_PUBLIC(double) surf_host_get_current_power_peak(surf_resource_t host);
 484
 485 /**
 486  * @brief [brief description]
 487  * @details [long description]
 488  *
 489  * @param host [description]
 490  * @param pstate_index [description]
 491  *
 492  * @return [description]
 493  */
 494 XBT_PUBLIC(double) surf_host_get_power_peak_at(surf_resource_t host, int pstate_index);
 495
 496 /**
 497  * @brief [brief description]
 498  * @details [long description]
 499  *
 500  * @param host [description]
 501  * @return [description]
 502  */
 503 XBT_PUBLIC(int) surf_host_get_nb_pstates(surf_resource_t host);
 504
 505 XBT_PUBLIC(void) surf_host_set_pstate(surf_resource_t host, int pstate_index);
 506 XBT_PUBLIC(int) surf_host_get_pstate(surf_resource_t host);
 507 XBT_PUBLIC(double) surf_host_get_wattmin_at(surf_resource_t resource, int pstate);
 508 XBT_PUBLIC(double) surf_host_get_wattmax_at(surf_resource_t resource, int pstate);
 509
 510 /**
 511  * @brief Get the consumed energy (in joules) of an host
 512  *
 513  * @param host The surf host
 514  * @return The consumed energy
 515  */
 516 XBT_PUBLIC(double) surf_host_get_consumed_energy(surf_resource_t host);
 517
 518 /**
 519  * @brief Get the list of storages mounted on an host
 520  *
 521  * @param host The surf host
 522  * @return Dictionary of mount point, Storage
 523  */
 524 XBT_PUBLIC(xbt_dict_t) surf_host_get_mounted_storage_list(surf_resource_t host);
 525
 526 /**
 527  * @brief Get the list of storages attached to an host
 528  *
 529  * @param host The surf host
 530  * @return Dictionary of storage
 531  */
 532 XBT_PUBLIC(xbt_dynar_t) surf_host_get_attached_storage_list(surf_resource_t host);
 533
 534 /**
 535  * @brief Unlink a file descriptor
 536  *
 537  * @param host The surf host
 538  * @param fd The file descriptor
 539  *
 540  * @return 0 if failed to unlink, 1 otherwise
 541  */
 542 XBT_PUBLIC(int) surf_host_unlink(surf_resource_t host, surf_file_t fd);
 543
 544 /**
 545  * @brief Get the size of a file on a host
 546  *
 547  * @param host The surf host
 548  * @param fd The file descriptor
 549  *
 550  * @return The size in bytes of the file
 551  */
 552 XBT_PUBLIC(size_t) surf_host_get_size(surf_resource_t host, surf_file_t fd);
 553
 554 /**
 555  * @brief Get the current position of the file descriptor
 556  *
 557  * @param host The surf host
 558  * @param fd The file descriptor
 559  * @return The current position of the file descriptor
 560  */
 561 XBT_PUBLIC(size_t) surf_host_file_tell(surf_resource_t host, surf_file_t fd);
 562
 563 /**
 564  * @brief Move a file to another location on the *same mount point*.
 565  * @details [long description]
 566  *
 567  * @param host The surf host
 568  * @param fd The file descriptor
 569  * @param fullpath The new full path
 570  *
 571  * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
 572  */
 573 XBT_PUBLIC(int) surf_host_file_move(surf_resource_t host, surf_file_t fd, const char* fullpath);
 574
 575 /**
 576  * @brief Set the position indictator assiociated with the file descriptor to a new position
 577  * @details [long description]
 578  *
 579  * @param host The surf host
 580  * @param fd The file descriptor
 581  * @param offset The offset from the origin
 582  * @param origin Position used as a reference for the offset
 583  *  - SEEK_SET: beginning of the file
 584  *  - SEEK_CUR: current position indicator
 585  *  - SEEK_END: end of the file
 586  * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
 587  */
 588 XBT_PUBLIC(int) surf_host_file_seek(surf_resource_t host,
 589                                            surf_file_t fd, sg_offset_t offset,
 590                                            int origin);
 591
 592 /**
 593  * @brief Get the content of a storage
 594  *
 595  * @param resource The surf storage
 596  * @return A xbt_dict_t with path as keys and size in bytes as values
 597  */
 598 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
 599
 600 /**
 601  * @brief Get the size in bytes of a storage
 602  *
 603  * @param resource The surf storage
 604  * @return The size in bytes of the storage
 605  */
 606 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
 607
 608 /**
 609  * @brief Get the available size in bytes of a storage
 610  *
 611  * @param resource The surf storage
 612  * @return The available size in bytes of the storage
 613  */
 614 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
 615
 616 /**
 617  * @brief Get the size in bytes of a storage
 618  *
 619  * @param resource The surf storage
 620  * @return The used size in bytes of the storage
 621  */
 622 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
 623
 624
 625 /**
 626  * @brief Get the data associated to the action
 627  *
 628  * @param action The surf action
 629  * @return The data associated to the action
 630  */
 631 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
 632
 633 /**
 634  * @brief Set the data associated to the action
 635  * @details [long description]
 636  *
 637  * @param action The surf action
 638  * @param data The new data associated to the action
 639  */
 640 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
 641
 642 /**
 643  * @brief Unreference an action
 644  *
 645  * @param action The surf action
 646  */
 647 XBT_PUBLIC(void) surf_action_unref(surf_action_t action);
 648
 649 /**
 650  * @brief Get the start time of an action
 651  *
 652  * @param action The surf action
 653  * @return The start time in seconds from the beginning of the simulation
 654  */
 655 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
 656
 657 /**
 658  * @brief Get the finish time of an action
 659  *
 660  * @param action The surf action
 661  * @return The finish time in seconds from the beginning of the simulation
 662  */
 663 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
 664
 665 /**
 666  * @brief Get the remains amount of work to do of an action
 667  *
 668  * @param action The surf action
 669  * @return  The remains amount of work to do
 670  */
 671 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
 672
 673 /**
 674  * @brief Suspend an action
 675  *
 676  * @param action The surf action
 677  */
 678 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
 679
 680 /**
 681  * @brief Resume an action
 682  *
 683  * @param action The surf action
 684  */
 685 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
 686
 687 /**
 688  * @brief Cancel an action
 689  *
 690  * @param action The surf action
 691  */
 692 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
 693
 694 /**
 695  * @brief Set the priority of an action
 696  * @details [long description]
 697  *
 698  * @param action The surf action
 699  * @param priority The new priority [TODO]
 700  */
 701 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
 702
 703 /**
 704  * @brief Set the category of an action
 705  * @details [long description]
 706  *
 707  * @param action The surf action
 708  * @param category The new category of the action
 709  */
 710 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
 711
 712 /**
 713  * @brief Get the state of an action
 714  *
 715  * @param action The surf action
 716  * @return The state of the action
 717  */
 718 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
 719
 720 /**
 721  * @brief Get the cost of an action
 722  *
 723  * @param action The surf action
 724  * @return The cost of the action
 725  */
 726 XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
 727
 728 /**
 729  * @brief [brief desrciption]
 730  * @details [long description]
 731  *
 732  * @param action The surf cpu action
 733  * @param cpu [description]
 734  * @param mask [description]
 735  */
 736 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask);
 737
 738 /**
 739  * @brief [brief description]
 740  * @details [long description]
 741  *
 742  * @param action The surf cpu action
 743  * @param bound [description]
 744  */
 745 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
 746
 747 /**
 748  * @brief [brief description]
 749  * @details [long description]
 750  *
 751  * @param action The surf network action
 752  */
 753 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
 754
 755 /**
 756  * @brief Get the file associated to a storage action
 757  *
 758  * @param action The surf storage action
 759  * @return The file associated to a storage action
 760  */
 761 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
 762
 763 /**
 764  * @brief Get the result dictionary of an ls action
 765  *
 766  * @param action The surf storage action
 767  * @return The dictionry listing a path
 768  */
 769 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
 770
 771
 772 /**
 773  * @brief Get the host the storage is attached to
 774  *
 775  * @param resource The surf storage
 776  * @return The host name
 777  */
 778 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
 779
 780 XBT_PUBLIC(surf_model_t) surf_resource_model(const void *host, int level);
 781
 782 /** @} */
 783
 784 /**************************************/
 785 /* Implementations of model object */
 786 /**************************************/
 787
 788 XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
 789 XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
 790
 791 /** \ingroup SURF_models
 792  *  \brief The CPU model object for the physical machine layer
 793  */
 794 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
 795
 796 /** \ingroup SURF_models
 797  *  \brief The CPU model object for the virtual machine layer
 798  */
 799 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
 800
 801
 802 /** \ingroup SURF_models
 803  *  \brief Initializes the CPU model with the model Cas01
 804  *
 805  *  By default, this model uses the lazy optimization mechanism that
 806  *  relies on partial invalidation in LMM and a heap for lazy action update.
 807  *  You can change this behavior by setting the cpu/optim configuration
 808  *  variable to a different value.
 809  *
 810  *  You shouldn't have to call it by yourself.
 811  */
 812 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
 813
 814 /** \ingroup SURF_models
 815  *  \brief Initializes the CPU model with trace integration [Deprecated]
 816  *
 817  *  You shouldn't have to call it by yourself.
 818  */
 819 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
 820
 821 /** \ingroup SURF_models
 822  *  \brief The list of all available optimization modes (both for cpu and networks).
 823  *  These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
 824  */
 825 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
 826
 827 /** \ingroup SURF_plugins
 828  *  \brief The list of all available surf plugins
 829  */
 830 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
 831
 832 /** \ingroup SURF_models
 833  *  \brief The list of all available cpu model models
 834  */
 835 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
 836
 837 /**\brief create new host bypass the parser
 838  *
 839  */
 840
 841
 842 /** \ingroup SURF_models
 843  *  \brief The network model
 844  *
 845  *  When creating a new API on top on SURF, you shouldn't use the
 846  *  network model unless you know what you are doing. Only the host
 847  *  model should be accessed because depending on the platform model,
 848  *  the network model can be NULL.
 849  */
 850 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
 851
 852 /** \ingroup SURF_models
 853  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
 854  *
 855  * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
 856  * based on the model 'LV08' and different correction factors depending on the communication
 857  * size (< 1KiB, < 64KiB, >= 64KiB).
 858  * See comments in the code for more information.
 859  *
 860  *  \see surf_host_model_init_SMPI()
 861  */
 862 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
 863
 864 /** \ingroup SURF_models
 865  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
 866  *
 867  * This model impelments a variant of the contention model on Infinband networks based on
 868  * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
 869  *
 870  *  \see surf_host_model_init_IB()
 871  */
 872 XBT_PUBLIC(void) surf_network_model_init_IB(void);
 873
 874 /** \ingroup SURF_models
 875  *  \brief Initializes the platform with the network model 'LegrandVelho'
 876  *
 877  * This model is proposed by Arnaud Legrand and Pedro Velho based on
 878  * the results obtained with the GTNets simulator for onelink and
 879  * dogbone sharing scenarios. See comments in the code for more information.
 880  *
 881  *  \see surf_host_model_init_LegrandVelho()
 882  */
 883 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
 884
 885 /** \ingroup SURF_models
 886  *  \brief Initializes the platform with the network model 'Constant'
 887  *
 888  *  In this model, the communication time between two network cards is
 889  *  constant, hence no need for a routing table. This is particularly
 890  *  usefull when simulating huge distributed algorithms where
 891  *  scalability is really an issue. This function is called in
 892  *  conjunction with surf_host_model_init_compound.
 893  *
 894  *  \see surf_host_model_init_compound()
 895  */
 896 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
 897
 898 /** \ingroup SURF_models
 899  *  \brief Initializes the platform with the network model CM02
 900  *
 901  *  You sould call this function by yourself only if you plan using
 902  *  surf_host_model_init_compound.
 903  *  See comments in the code for more information.
 904  */
 905 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
 906
 907 #ifdef HAVE_NS3
 908 /** \ingroup SURF_models
 909  *  \brief Initializes the platform with the network model NS3
 910  *
 911  *  This function is called by surf_host_model_init_NS3
 912  *  or by yourself only if you plan using surf_host_model_init_compound
 913  *
 914  *  \see surf_host_model_init_NS3()
 915  */
 916 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
 917 #endif
 918
 919 /** \ingroup SURF_models
 920  *  \brief Initializes the platform with the network model Reno
 921  *
 922  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 923  *
 924  *  Reference:
 925  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
 926  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 927  *
 928  *  Call this function only if you plan using surf_host_model_init_compound.
 929  *
 930  */
 931 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
 932
 933 /** \ingroup SURF_models
 934  *  \brief Initializes the platform with the network model Reno2
 935  *
 936  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 937  *
 938  *  Reference:
 939  *  [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
 940  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 941  *
 942  *  Call this function only if you plan using surf_host_model_init_compound.
 943  *
 944  */
 945 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
 946
 947 /** \ingroup SURF_models
 948  *  \brief Initializes the platform with the network model Vegas
 949  *
 950  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
 951  *  to the proportional fairness.
 952  *
 953  *  Reference:
 954  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
 955  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 956  *
 957  *  Call this function only if you plan using surf_host_model_init_compound.
 958  *
 959  */
 960 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
 961
 962 /** \ingroup SURF_models
 963  *  \brief The list of all available network model models
 964  */
 965 XBT_PUBLIC_DATA(s_surf_model_description_t)
 966     surf_network_model_description[];
 967
 968 /** \ingroup SURF_models
 969  *  \brief The storage model
 970  */
 971 XBT_PUBLIC(void) surf_storage_model_init_default(void);
 972
 973 /** \ingroup SURF_models
 974  *  \brief The list of all available storage modes.
 975  *  This storage mode can be set using --cfg=storage/model:...
 976  */
 977 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
 978
 979 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
 980
 981 /** \ingroup SURF_models
 982  *  \brief The host model
 983  *
 984  *  Note that when you create an API on top of SURF,
 985  *  the host model should be the only one you use
 986  *  because depending on the platform model, the network model and the CPU model
 987  *  may not exist.
 988  */
 989 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
 990
 991 /** \ingroup SURF_models
 992  *  \brief The vm model
 993  *
 994  *  Note that when you create an API on top of SURF,
 995  *  the vm model should be the only one you use
 996  *  because depending on the platform model, the network model and the CPU model
 997  *  may not exist.
 998  */
 999 XBT_PUBLIC_DATA(surf_vm_model_t) surf_vm_model;
1000
1001 /** \ingroup SURF_models
1002  *  \brief Initializes the platform with a compound host model
1003  *
1004  *  This function should be called after a cpu_model and a
1005  *  network_model have been set up.
1006  *
1007  */
1008 XBT_PUBLIC(void) surf_host_model_init_compound(void);
1009
1010 /** \ingroup SURF_models
1011  *  \brief Initializes the platform with the current best network and cpu models at hand
1012  *
1013  *  This platform model separates the host model and the network model.
1014  *  The host model will be initialized with the model compound, the network
1015  *  model with the model LV08 (with cross traffic support) and the CPU model with
1016  *  the model Cas01.
1017  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
1018  *
1019  */
1020 XBT_PUBLIC(void) surf_host_model_init_current_default(void);
1021
1022 /** \ingroup SURF_models
1023  *  \brief Initializes the platform with the model L07
1024  *
1025  *  With this model, only parallel tasks can be used. Resource sharing
1026  *  is done by identifying bottlenecks and giving an equal share of
1027  *  the model to each action.
1028  *
1029  */
1030 XBT_PUBLIC(void) surf_host_model_init_ptask_L07(void);
1031
1032 /** \ingroup SURF_models
1033  *  \brief The list of all available host model models
1034  */
1035 XBT_PUBLIC_DATA(s_surf_model_description_t)
1036     surf_host_model_description[];
1037
1038 /** \ingroup SURF_models
1039  *  \brief Initializes the platform with the current best network and cpu models at hand
1040  *
1041  *  This platform model seperates the host model and the network model.
1042  *  The host model will be initialized with the model compound, the network
1043  *  model with the model LV08 (with cross traffic support) and the CPU model with
1044  *  the model Cas01.
1045  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
1046  *
1047  */
1048 XBT_PUBLIC(void) surf_vm_model_init_HL13(void);
1049
1050 /** \ingroup SURF_models
1051  *  \brief The list of all available vm model models
1052  */
1053 XBT_PUBLIC_DATA(s_surf_model_description_t)
1054     surf_vm_model_description[];
1055
1056 /*******************************************/
1057
1058 /** \ingroup SURF_models
1059  *  \brief List of initialized models
1060  */
1061 XBT_PUBLIC_DATA(xbt_dynar_t) all_existing_models;
1062
1063 /** \ingroup SURF_simulation
1064  *  \brief List of hosts that have just restarted and whose autorestart process should be restarted.
1065  */
1066 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
1067
1068 /** \ingroup SURF_simulation
1069  *  \brief List of hosts for which one want to be notified if they ever restart.
1070  */
1071 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
1072
1073 /*******************************************/
1074 /*** SURF Platform *************************/
1075 /*******************************************/
1076 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
1077 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
1078 XBT_PUBLIC_DATA(AS_t) surf_AS_get_by_name(const char * name);
1079 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
1080 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
1081 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
1082 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
1083 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
1084 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
1085
1086 /*******************************************/
1087 /*** SURF Globals **************************/
1088 /*******************************************/
1089
1090 /** \ingroup SURF_simulation
1091  *  \brief Initialize SURF
1092  *  \param argc argument number
1093  *  \param argv arguments
1094  *
1095  *  This function has to be called to initialize the common
1096  *  structures.  Then you will have to create the environment by
1097  *  calling
1098  *  e.g. surf_host_model_init_CM02()
1099  *
1100  *  \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
1101  */
1102 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
1103
1104 /** \ingroup SURF_simulation
1105  *  \brief Finish simulation initialization
1106  *
1107  *  This function must be called before the first call to surf_solve()
1108  */
1109 XBT_PUBLIC(void) surf_presolve(void);
1110
1111 /** \ingroup SURF_simulation
1112  *  \brief Performs a part of the simulation
1113  *  \param max_date Maximum date to update the simulation to, or -1
1114  *  \return the elapsed time, or -1.0 if no event could be executed
1115  *
1116  *  This function execute all possible events, update the action states
1117  *  and returns the time elapsed.
1118  *  When you call execute or communicate on a model, the corresponding actions
1119  *  are not executed immediately but only when you call surf_solve.
1120  *  Note that the returned elapsed time can be zero.
1121  */
1122 XBT_PUBLIC(double) surf_solve(double max_date);
1123
1124 /** \ingroup SURF_simulation
1125  *  \brief Return the current time
1126  *
1127  *  Return the current time in millisecond.
1128  */
1129 XBT_PUBLIC(double) surf_get_clock(void);
1130
1131 /** \ingroup SURF_simulation
1132  *  \brief Exit SURF
1133  *
1134  *  Clean everything.
1135  *
1136  *  \see surf_init()
1137  */
1138 XBT_PUBLIC(void) surf_exit(void);
1139
1140 /* Prototypes of the functions that handle the properties */
1141 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;       /* the prop set for the currently parsed element (also used in SIMIX) */
1142
1143 /* The same for model_prop set*/
1144 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
1145
1146 /* surf parse file related (public because called from a test suite) */
1147 XBT_PUBLIC(void) parse_platform_file(const char *file);
1148
1149 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
1150 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
1151 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
1152 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
1153 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
1154 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
1155 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
1156
1157
1158 XBT_PUBLIC(double) get_cpu_speed(const char *power);
1159
1160 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
1161
1162 int surf_get_nthreads(void);
1163 void surf_set_nthreads(int nthreads);
1164
1165 /*
1166  * Returns the initial path. On Windows the initial path is
1167  * the current directory for the current process in the other
1168  * case the function returns "./" that represents the current
1169  * directory on Unix/Linux platforms.
1170  */
1171 const char *__surf_get_initial_path(void);
1172
1173 /********** Tracing **********/
1174 /* from surf_instr.c */
1175 void TRACE_surf_action(surf_action_t surf_action, const char *category);
1176 void TRACE_surf_alloc(void);
1177 void TRACE_surf_release(void);
1178
1179 /* instr_routing.c */
1180 void instr_routing_define_callbacks (void);
1181 void instr_new_variable_type (const char *new_typename, const char *color);
1182 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color);
1183 void instr_new_user_state_type (const char *father_type, const char *new_typename);
1184 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
1185 int instr_platform_traced (void);
1186 xbt_graph_t instr_routing_platform_graph (void);
1187 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
1188
1189 /********** Routing **********/
1190 void routing_AS_begin(sg_platf_AS_cbarg_t AS);
1191 void routing_AS_end(void);
1192 surf_RoutingEdge* routing_add_host(surf_As* as, sg_platf_host_cbarg_t host);
1193 void routing_cluster_add_backbone(void* bb);
1194 surf_As* routing_get_current();
1195
1196 SG_END_DECL()
1197 #endif                          /* _SURF_SURF_H */