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 XBT_PUBLIC(void) surf_workstation_set_pstate(surf_resource_t host, int pstate_index);
 624 XBT_PUBLIC(int) surf_workstation_get_pstate(surf_resource_t host);
 625
 626 /**
 627  * @brief Get the consumed energy (in joules) of a workstation
 628  *
 629  * @param host The surf workstation
 630  * @return The consumed energy
 631  */
 632 XBT_PUBLIC(double) surf_workstation_get_consumed_energy(surf_resource_t host);
 633
 634 /**
 635  * @brief Get the list of storages mounted on a workstation
 636  *
 637  * @param workstation The surf workstation
 638  * @return Dictionary of mount point, Storage
 639  */
 640 XBT_PUBLIC(xbt_dict_t) surf_workstation_get_mounted_storage_list(surf_resource_t workstation);
 641
 642 /**
 643  * @brief Get the list of storages attached to a workstation
 644  *
 645  * @param workstation The surf workstation
 646  * @return Dictionary of storage
 647  */
 648 XBT_PUBLIC(xbt_dynar_t) surf_workstation_get_attached_storage_list(surf_resource_t workstation);
 649
 650 /**
 651  * @brief Unlink a file descriptor
 652  *
 653  * @param workstation The surf workstation
 654  * @param fd The file descriptor
 655  *
 656  * @return 0 if failed to unlink, 1 otherwise
 657  */
 658 XBT_PUBLIC(int) surf_workstation_unlink(surf_resource_t workstation, surf_file_t fd);
 659
 660 /**
 661  * @brief Get the size of a file on a workstation
 662  *
 663  * @param workstation The surf workstation
 664  * @param fd The file descriptor
 665  *
 666  * @return The size in bytes of the file
 667  */
 668 XBT_PUBLIC(size_t) surf_workstation_get_size(surf_resource_t workstation, surf_file_t fd);
 669
 670 /**
 671  * @brief Get the current position of the file descriptor
 672  *
 673  * @param workstation The surf workstation
 674  * @param fd The file descriptor
 675  * @return The current position of the file descriptor
 676  */
 677 XBT_PUBLIC(size_t) surf_workstation_file_tell(surf_resource_t workstation, surf_file_t fd);
 678
 679 /**
 680  * @brief Move a file to another location on the *same mount point*.
 681  * @details [long description]
 682  *
 683  * @param workstation The surf workstation
 684  * @param fd The file descriptor
 685  * @param fullpath The new full path
 686  *
 687  * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
 688  */
 689 XBT_PUBLIC(int) surf_workstation_file_move(surf_resource_t workstation, surf_file_t fd, const char* fullpath);
 690
 691 /**
 692  * @brief Set the position indictator assiociated with the file descriptor to a new position
 693  * @details [long description]
 694  *
 695  * @param workstation The surf workstation
 696  * @param fd The file descriptor
 697  * @param offset The offset from the origin
 698  * @param origin Position used as a reference for the offset
 699  *  - SEEK_SET: beginning of the file
 700  *  - SEEK_CUR: current position indicator
 701  *  - SEEK_END: end of the file
 702  * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
 703  */
 704 XBT_PUBLIC(int) surf_workstation_file_seek(surf_resource_t workstation,
 705                                            surf_file_t fd, sg_offset_t offset,
 706                                            int origin);
 707
 708 /**
 709  * @brief [brief description]
 710  * @details [long description]
 711  *
 712  * @param link [description]
 713  * @return [description]
 714  */
 715 XBT_PUBLIC(int) surf_network_link_is_shared(surf_cpp_resource_t link);
 716
 717 /**
 718  * @brief Get the bandwidth of a link in bytes per second
 719  *
 720  * @param link The surf link
 721  * @return The bandwidth in bytes per second
 722  */
 723 XBT_PUBLIC(double) surf_network_link_get_bandwidth(surf_cpp_resource_t link);
 724
 725 /**
 726  * @brief Get the latency of a link in seconds
 727  *
 728  * @param link The surf link
 729  * @return The latency in seconds
 730  */
 731 XBT_PUBLIC(double) surf_network_link_get_latency(surf_cpp_resource_t link);
 732
 733 /**
 734  * @brief Get the content of a storage
 735  *
 736  * @param resource The surf storage
 737  * @return A xbt_dict_t with path as keys and size in bytes as values
 738  */
 739 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
 740
 741 /**
 742  * @brief Get the size in bytes of a storage
 743  *
 744  * @param resource The surf storage
 745  * @return The size in bytes of the storage
 746  */
 747 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
 748
 749 /**
 750  * @brief Get the available size in bytes of a storage
 751  *
 752  * @param resource The surf storage
 753  * @return The available size in bytes of the storage
 754  */
 755 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
 756
 757 /**
 758  * @brief Get the size in bytes of a storage
 759  *
 760  * @param resource The surf storage
 761  * @return The used size in bytes of the storage
 762  */
 763 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
 764
 765
 766 /**
 767  * @brief Get the data associated to the action
 768  *
 769  * @param action The surf action
 770  * @return The data associated to the action
 771  */
 772 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
 773
 774 /**
 775  * @brief Set the data associated to the action
 776  * @details [long description]
 777  *
 778  * @param action The surf action
 779  * @param data The new data associated to the action
 780  */
 781 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
 782
 783 /**
 784  * @brief Unreference an action
 785  *
 786  * @param action The surf action
 787  */
 788 XBT_PUBLIC(void) surf_action_unref(surf_action_t action);
 789
 790 /**
 791  * @brief Get the start time of an action
 792  *
 793  * @param action The surf action
 794  * @return The start time in seconds from the beginning of the simulation
 795  */
 796 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
 797
 798 /**
 799  * @brief Get the finish time of an action
 800  *
 801  * @param action The surf action
 802  * @return The finish time in seconds from the beginning of the simulation
 803  */
 804 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
 805
 806 /**
 807  * @brief Get the remains amount of work to do of an action
 808  *
 809  * @param action The surf action
 810  * @return  The remains amount of work to do
 811  */
 812 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
 813
 814 /**
 815  * @brief Suspend an action
 816  *
 817  * @param action The surf action
 818  */
 819 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
 820
 821 /**
 822  * @brief Resume an action
 823  *
 824  * @param action The surf action
 825  */
 826 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
 827
 828 /**
 829  * @brief Cancel an action
 830  *
 831  * @param action The surf action
 832  */
 833 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
 834
 835 /**
 836  * @brief Set the priority of an action
 837  * @details [long description]
 838  *
 839  * @param action The surf action
 840  * @param priority The new priority [TODO]
 841  */
 842 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
 843
 844 /**
 845  * @brief Set the category of an action
 846  * @details [long description]
 847  *
 848  * @param action The surf action
 849  * @param category The new category of the action
 850  */
 851 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
 852
 853 /**
 854  * @brief Get the state of an action
 855  *
 856  * @param action The surf action
 857  * @return The state of the action
 858  */
 859 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
 860
 861 /**
 862  * @brief Get the cost of an action
 863  *
 864  * @param action The surf action
 865  * @return The cost of the action
 866  */
 867 XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
 868
 869 /**
 870  * @brief [brief desrciption]
 871  * @details [long description]
 872  *
 873  * @param action The surf cpu action
 874  * @param cpu [description]
 875  * @param mask [description]
 876  */
 877 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask);
 878
 879 /**
 880  * @brief [brief description]
 881  * @details [long description]
 882  *
 883  * @param action The surf cpu action
 884  * @param bound [description]
 885  */
 886 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
 887
 888 /**
 889  * @brief [brief description]
 890  * @details [long description]
 891  *
 892  * @param action The surf network action
 893  */
 894 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
 895
 896 /**
 897  * @brief Get the file associated to a storage action
 898  *
 899  * @param action The surf storage action
 900  * @return The file associated to a storage action
 901  */
 902 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
 903
 904 /**
 905  * @brief Get the result dictionary of an ls action
 906  *
 907  * @param action The surf storage action
 908  * @return The dictionry listing a path
 909  */
 910 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
 911
 912
 913 /**
 914  * @brief Get the host the storage is attached to
 915  *
 916  * @param resource The surf storage
 917  * @return The host name
 918  */
 919 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
 920
 921 XBT_PUBLIC(surf_model_t) surf_resource_model(const void *host, int level);
 922
 923 /** @} */
 924
 925 /**************************************/
 926 /* Implementations of model object */
 927 /**************************************/
 928
 929 XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
 930 XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
 931
 932 /** \ingroup SURF_models
 933  *  \brief The CPU model object for the physical machine layer
 934  */
 935 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
 936
 937 /** \ingroup SURF_models
 938  *  \brief The CPU model object for the virtual machine layer
 939  */
 940 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
 941
 942
 943 /** \ingroup SURF_models
 944  *  \brief Initializes the CPU model with the model Cas01
 945  *
 946  *  By default, this model uses the lazy optimization mechanism that
 947  *  relies on partial invalidation in LMM and a heap for lazy action update.
 948  *  You can change this behavior by setting the cpu/optim configuration
 949  *  variable to a different value.
 950  *
 951  *  You shouldn't have to call it by yourself.
 952  */
 953 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
 954
 955 /** \ingroup SURF_models
 956  *  \brief Initializes the CPU model with trace integration [Deprecated]
 957  *
 958  *  You shouldn't have to call it by yourself.
 959  */
 960 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
 961
 962 /** \ingroup SURF_models
 963  *  \brief The list of all available optimization modes (both for cpu and networks).
 964  *  These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
 965  */
 966 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
 967
 968 /** \ingroup SURF_plugins
 969  *  \brief The list of all available surf plugins
 970  */
 971 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
 972
 973 /** \ingroup SURF_models
 974  *  \brief The list of all available cpu model models
 975  */
 976 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
 977
 978 /**\brief create new host bypass the parser
 979  *
 980  */
 981
 982
 983 /** \ingroup SURF_models
 984  *  \brief The network model
 985  *
 986  *  When creating a new API on top on SURF, you shouldn't use the
 987  *  network model unless you know what you are doing. Only the workstation
 988  *  model should be accessed because depending on the platform model,
 989  *  the network model can be NULL.
 990  */
 991 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
 992
 993 /** \ingroup SURF_models
 994  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
 995  *
 996  * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
 997  * based on the model 'LV08' and different correction factors depending on the communication
 998  * size (< 1KiB, < 64KiB, >= 64KiB).
 999  * See comments in the code for more information.
1000  *
1001  *  \see surf_workstation_model_init_SMPI()
1002  */
1003 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
1004
1005 /** \ingroup SURF_models
1006  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
1007  *
1008  * This model impelments a variant of the contention model on Infinband networks based on
1009  * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
1010  *
1011  *  \see surf_workstation_model_init_IB()
1012  */
1013 XBT_PUBLIC(void) surf_network_model_init_IB(void);
1014
1015 /** \ingroup SURF_models
1016  *  \brief Initializes the platform with the network model 'LegrandVelho'
1017  *
1018  * This model is proposed by Arnaud Legrand and Pedro Velho based on
1019  * the results obtained with the GTNets simulator for onelink and
1020  * dogbone sharing scenarios. See comments in the code for more information.
1021  *
1022  *  \see surf_workstation_model_init_LegrandVelho()
1023  */
1024 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
1025
1026 /** \ingroup SURF_models
1027  *  \brief Initializes the platform with the network model 'Constant'
1028  *
1029  *  In this model, the communication time between two network cards is
1030  *  constant, hence no need for a routing table. This is particularly
1031  *  usefull when simulating huge distributed algorithms where
1032  *  scalability is really an issue. This function is called in
1033  *  conjunction with surf_workstation_model_init_compound.
1034  *
1035  *  \see surf_workstation_model_init_compound()
1036  */
1037 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
1038
1039 /** \ingroup SURF_models
1040  *  \brief Initializes the platform with the network model CM02
1041  *
1042  *  You sould call this function by yourself only if you plan using
1043  *  surf_workstation_model_init_compound.
1044  *  See comments in the code for more information.
1045  */
1046 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
1047
1048 #ifdef HAVE_GTNETS
1049 /** \ingroup SURF_models
1050  *  \brief Initializes the platform with the network model GTNETS
1051  *  \param filename XML platform file name
1052  *
1053  *  This function is called by surf_workstation_model_init_GTNETS
1054  *  or by yourself only if you plan using surf_workstation_model_init_compound
1055  *
1056  *  \see surf_workstation_model_init_GTNETS()
1057  */
1058 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
1059 #endif
1060
1061 #ifdef HAVE_NS3
1062 /** \ingroup SURF_models
1063  *  \brief Initializes the platform with the network model NS3
1064  *  \param filename XML platform file name
1065  *
1066  *  This function is called by surf_workstation_model_init_NS3
1067  *  or by yourself only if you plan using surf_workstation_model_init_compound
1068  *
1069  *  \see surf_workstation_model_init_NS3()
1070  */
1071 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
1072 #endif
1073
1074 /** \ingroup SURF_models
1075  *  \brief Initializes the platform with the network model Reno
1076  *  \param filename XML platform file name
1077  *
1078  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
1079  *
1080  *  Reference:
1081  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1082  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1083  *
1084  *  Call this function only if you plan using surf_workstation_model_init_compound.
1085  *
1086  */
1087 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
1088
1089 /** \ingroup SURF_models
1090  *  \brief Initializes the platform with the network model Reno2
1091  *  \param filename XML platform file name
1092  *
1093  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
1094  *
1095  *  Reference:
1096  *  [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
1097  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1098  *
1099  *  Call this function only if you plan using surf_workstation_model_init_compound.
1100  *
1101  */
1102 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
1103
1104 /** \ingroup SURF_models
1105  *  \brief Initializes the platform with the network model Vegas
1106  *  \param filename XML platform file name
1107  *
1108  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
1109  *  to the proportional fairness.
1110  *
1111  *  Reference:
1112  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1113  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1114  *
1115  *  Call this function only if you plan using surf_workstation_model_init_compound.
1116  *
1117  */
1118 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
1119
1120 /** \ingroup SURF_models
1121  *  \brief The list of all available network model models
1122  */
1123 XBT_PUBLIC_DATA(s_surf_model_description_t)
1124     surf_network_model_description[];
1125
1126 /** \ingroup SURF_models
1127  *  \brief The storage model
1128  */
1129 XBT_PUBLIC(void) surf_storage_model_init_default(void);
1130
1131 /** \ingroup SURF_models
1132  *  \brief The list of all available storage modes.
1133  *  This storage mode can be set using --cfg=storage/model:...
1134  */
1135 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
1136
1137 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
1138
1139 /** \ingroup SURF_models
1140  *  \brief The workstation model
1141  *
1142  *  Note that when you create an API on top of SURF,
1143  *  the workstation model should be the only one you use
1144  *  because depending on the platform model, the network model and the CPU model
1145  *  may not exist.
1146  */
1147 XBT_PUBLIC_DATA(surf_workstation_model_t) surf_workstation_model;
1148
1149 /** \ingroup SURF_models
1150  *  \brief The vm_workstation model
1151  *
1152  *  Note that when you create an API on top of SURF,
1153  *  the vm_workstation model should be the only one you use
1154  *  because depending on the platform model, the network model and the CPU model
1155  *  may not exist.
1156  */
1157 XBT_PUBLIC_DATA(surf_vm_workstation_model_t) surf_vm_workstation_model;
1158
1159 /** \ingroup SURF_models
1160  *  \brief Initializes the platform with a compound workstation model
1161  *
1162  *  This function should be called after a cpu_model and a
1163  *  network_model have been set up.
1164  *
1165  */
1166 XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
1167
1168 /** \ingroup SURF_models
1169  *  \brief Initializes the platform with the current best network and cpu models at hand
1170  *
1171  *  This platform model seperates the workstation model and the network model.
1172  *  The workstation model will be initialized with the model compound, the network
1173  *  model with the model LV08 (with cross traffic support) and the CPU model with
1174  *  the model Cas01.
1175  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
1176  *
1177  */
1178 XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
1179
1180 /** \ingroup SURF_models
1181  *  \brief Initializes the platform with the model KCCFLN05
1182  *
1183  *  With this model, only parallel tasks can be used. Resource sharing
1184  *  is done by identifying bottlenecks and giving an equal share of
1185  *  the model to each action.
1186  *
1187  */
1188 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
1189
1190 /** \ingroup SURF_models
1191  *  \brief The list of all available workstation model models
1192  */
1193 XBT_PUBLIC_DATA(s_surf_model_description_t)
1194     surf_workstation_model_description[];
1195
1196 /** \ingroup SURF_models
1197  *  \brief Initializes the platform with the current best network and cpu models at hand
1198  *
1199  *  This platform model seperates the workstation model and the network model.
1200  *  The workstation model will be initialized with the model compound, the network
1201  *  model with the model LV08 (with cross traffic support) and the CPU model with
1202  *  the model Cas01.
1203  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
1204  *
1205  */
1206 XBT_PUBLIC(void) surf_vm_workstation_model_init_HL13(void);
1207
1208 /** \ingroup SURF_models
1209  *  \brief The list of all available vm workstation model models
1210  */
1211 XBT_PUBLIC_DATA(s_surf_model_description_t)
1212     surf_vm_workstation_model_description[];
1213
1214 /*******************************************/
1215
1216 /** \ingroup SURF_models
1217  *  \brief List of initialized models
1218  */
1219 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
1220 XBT_PUBLIC_DATA(xbt_dynar_t) model_list_invoke;
1221
1222 /** \ingroup SURF_simulation
1223  *  \brief List of hosts that have juste restarted and whose autorestart process should be restarted.
1224  */
1225 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
1226
1227 /** \ingroup SURF_simulation
1228  *  \brief List of hosts for which one want to be notified if they ever restart.
1229  */
1230 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
1231
1232 /*******************************************/
1233 /*** SURF Platform *************************/
1234 /*******************************************/
1235 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
1236 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
1237 XBT_PUBLIC_DATA(AS_t) surf_AS_get_by_name(const char * name);
1238 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
1239 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
1240 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
1241 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
1242 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
1243 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
1244
1245 /*******************************************/
1246 /*** SURF Globals **************************/
1247 /*******************************************/
1248
1249 /** \ingroup SURF_simulation
1250  *  \brief Initialize SURF
1251  *  \param argc argument number
1252  *  \param argv arguments
1253  *
1254  *  This function has to be called to initialize the common
1255  *  structures.  Then you will have to create the environment by
1256  *  calling
1257  *  e.g. surf_workstation_model_init_CM02()
1258  *
1259  *  \see surf_workstation_model_init_CM02(), surf_workstation_model_init_compound(), surf_exit()
1260  */
1261 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
1262
1263 /** \ingroup SURF_simulation
1264  *  \brief Finish simulation initialization
1265  *
1266  *  This function must be called before the first call to surf_solve()
1267  */
1268 XBT_PUBLIC(void) surf_presolve(void);
1269
1270 /** \ingroup SURF_simulation
1271  *  \brief Performs a part of the simulation
1272  *  \param max_date Maximum date to update the simulation to, or -1
1273  *  \return the elapsed time, or -1.0 if no event could be executed
1274  *
1275  *  This function execute all possible events, update the action states
1276  *  and returns the time elapsed.
1277  *  When you call execute or communicate on a model, the corresponding actions
1278  *  are not executed immediately but only when you call surf_solve.
1279  *  Note that the returned elapsed time can be zero.
1280  */
1281 XBT_PUBLIC(double) surf_solve(double max_date);
1282
1283 /** \ingroup SURF_simulation
1284  *  \brief Return the current time
1285  *
1286  *  Return the current time in millisecond.
1287  */
1288 XBT_PUBLIC(double) surf_get_clock(void);
1289
1290 /** \ingroup SURF_simulation
1291  *  \brief Exit SURF
1292  *
1293  *  Clean everything.
1294  *
1295  *  \see surf_init()
1296  */
1297 XBT_PUBLIC(void) surf_exit(void);
1298
1299 /* Prototypes of the functions that handle the properties */
1300 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;       /* the prop set for the currently parsed element (also used in SIMIX) */
1301
1302 /* The same for model_prop set*/
1303 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
1304
1305 /* surf parse file related (public because called from a test suite) */
1306 XBT_PUBLIC(void) parse_platform_file(const char *file);
1307
1308 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
1309 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
1310 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
1311 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
1312 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
1313 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
1314 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
1315
1316
1317 XBT_PUBLIC(double) get_cpu_power(const char *power);
1318
1319 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
1320
1321 int surf_get_nthreads(void);
1322 void surf_set_nthreads(int nthreads);
1323
1324 /*
1325  * Returns the initial path. On Windows the initial path is
1326  * the current directory for the current process in the other
1327  * case the function returns "./" that represents the current
1328  * directory on Unix/Linux platforms.
1329  */
1330 const char *__surf_get_initial_path(void);
1331
1332 /********** Tracing **********/
1333 /* from surf_instr.c */
1334 void TRACE_surf_action(surf_action_t surf_action, const char *category);
1335 void TRACE_surf_alloc(void);
1336 void TRACE_surf_release(void);
1337
1338 /* instr_routing.c */
1339 void instr_routing_define_callbacks (void);
1340 void instr_new_variable_type (const char *new_typename, const char *color);
1341 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color);
1342 void instr_new_user_state_type (const char *father_type, const char *new_typename);
1343 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
1344 int instr_platform_traced (void);
1345 xbt_graph_t instr_routing_platform_graph (void);
1346 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
1347
1348 SG_END_DECL()
1349 #endif                          /* _SURF_SURF_H */