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