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