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