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