src/include/surf/surf.h

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