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