src/include/surf/surf.h

   1 /*      $Id$     */
   2
   3 /* Copyright (c) 2004 Arnaud Legrand. All rights reserved.                  */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 #ifndef _SURF_SURF_H
   9 #define _SURF_SURF_H
  10
  11 #include "xbt/swag.h"
  12 #include "xbt/dynar.h"
  13 #include "xbt/dict.h"
  14 #include "xbt/misc.h"
  15 #include "portable.h"
  16 #include "xbt/config.h"
  17
  18 SG_BEGIN_DECL()
  19
  20
  21
  22 /* Actions and models are higly connected structures... */
  23 /** \brief Action datatype
  24  *  \ingroup SURF_actions
  25  *
  26  * An action is some working amount on a model.
  27  * It is represented as a cost, a priority, a duration and a state.
  28  *
  29  * \see e_surf_action_state_t
  30  */
  31      typedef struct surf_action *surf_action_t;
  32
  33 /** \brief Model datatype
  34  *  \ingroup SURF_models
  35  *
  36  *  Generic data structure for a model. The workstations,
  37  *  the CPUs and the network links are examples of models.
  38  */
  39      typedef struct surf_model *surf_model_t;
  40
  41 /** \brief Resource model description
  42  */
  43      typedef struct surf_model_description {
  44        const char *name;
  45        surf_model_t model;
  46        void (*model_init) (const char *filename);
  47        void (*create_ws) (void);
  48      } s_surf_model_description_t, *surf_model_description_t;
  49
  50 XBT_PUBLIC(void) update_model_description(s_surf_model_description_t * table,
  51                                           const char *name,
  52                                           surf_model_t model);
  53 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
  54                                        const char *name);
  55
  56 /** \brief Action structure
  57  * \ingroup SURF_actions
  58  *
  59  *  Never create s_surf_action_t by yourself ! The actions are created
  60  *  on the fly when you call execute or communicate on a model.
  61  *
  62  *  \see e_surf_action_state_t
  63  */
  64      typedef struct surf_action {
  65        s_xbt_swag_hookup_t state_hookup;
  66        xbt_swag_t state_set;
  67        double cost;             /**< cost        */
  68        double priority;         /**< priority (1.0 by default) */
  69        double max_duration;     /**< max_duration (may fluctuate until
  70                                    the task is completed) */
  71        double remains;          /**< How much of that cost remains to
  72                                  * be done in the currently running task */
  73        double start;            /**< start time  */
  74        double finish;           /**< finish time : this is modified during the run
  75                                  * and fluctuates until the task is completed */
  76        void *data;              /**< for your convenience */
  77        int refcount;
  78        surf_model_t model_type;
  79      } s_surf_action_t;
  80
  81 /** \brief Action states
  82  *  \ingroup SURF_actions
  83  *
  84  *  Action states.
  85  *
  86  *  \see surf_action_t, surf_action_state_t
  87  */
  88      typedef enum {
  89        SURF_ACTION_READY = 0,   /**< Ready        */
  90        SURF_ACTION_RUNNING,     /**< Running      */
  91        SURF_ACTION_FAILED,      /**< Task Failure */
  92        SURF_ACTION_DONE,        /**< Completed    */
  93        SURF_ACTION_TO_FREE,     /**< Action to free in next cleanup */
  94        SURF_ACTION_NOT_IN_THE_SYSTEM
  95                                 /**< Not in the system anymore. Why did you ask ? */
  96      } e_surf_action_state_t;
  97
  98 /** \brief Action state sets
  99  *  \ingroup SURF_actions
 100  *
 101  *  This structure contains some sets of actions.
 102  *  It provides a fast access to the actions in each state.
 103  *
 104  *  \see surf_action_t, e_surf_action_state_t
 105  */
 106      typedef struct surf_action_state {
 107        xbt_swag_t ready_action_set;
 108                                  /**< Actions in state SURF_ACTION_READY */
 109        xbt_swag_t running_action_set;
 110                                  /**< Actions in state SURF_ACTION_RUNNING */
 111        xbt_swag_t failed_action_set;
 112                                  /**< Actions in state SURF_ACTION_FAILED */
 113        xbt_swag_t done_action_set;
 114                                  /**< Actions in state SURF_ACTION_DONE */
 115      } s_surf_action_state_t, *surf_action_state_t;
 116
 117 /***************************/
 118 /* Generic model object */
 119 /***************************/
 120
 121 /** \brief Public data available on all models
 122  *  \ingroup SURF_models
 123  *
 124  *  These functions are implemented by all models.
 125  */
 126      typedef struct surf_model_public {
 127        s_surf_action_state_t states;
 128                                 /**< Any living action on this model */
 129        const char *(*get_resource_name) (void *resource_id);
 130                                                         /**< Return the name of a resource */
 131
 132        e_surf_action_state_t(*action_get_state) (surf_action_t action);
 133                                                                    /**< Return the state of an action */
 134        double (*action_get_start_time) (surf_action_t action);
 135                                                           /**< Return the start time of an action */
 136        double (*action_get_finish_time) (surf_action_t action);
 137                                                            /**< Return the finish time of an action */
 138        void (*action_use) (surf_action_t action);
 139                                              /**< Set an action used */
 140        int (*action_free) (surf_action_t action);
 141                                               /**< Free an action */
 142        void (*action_cancel) (surf_action_t action);
 143                                                 /**< Cancel a running action */
 144        void (*action_recycle) (surf_action_t action);
 145                                                  /**< Recycle an action */
 146        void (*action_change_state) (surf_action_t action,
 147                                                      /**< Change an action state*/
 148                                     e_surf_action_state_t state);
 149        void (*action_set_data) (surf_action_t action, void *data);
 150                                                               /**< Set the user data of an action */
 151        void (*suspend) (surf_action_t action);
 152                                           /**< Suspend an action */
 153        void (*resume) (surf_action_t action);
 154                                          /**< Resume a suspended action */
 155        int (*is_suspended) (surf_action_t action);
 156                                               /**< Return whether an action is suspended */
 157        void (*set_max_duration) (surf_action_t action, double duration);
 158                                                                     /**< Set the max duration of an action*/
 159        void (*set_priority) (surf_action_t action, double priority);
 160                                                                 /**< Set the priority of an action */
 161        xbt_dict_t(*get_properties) (void *resource_id);
 162                                                     /**< Return the properties dictionary */
 163        const char *name;
 164                     /**< Name of this model */
 165        xbt_dict_t resource_set;
 166      } s_surf_model_public_t, *surf_model_public_t;
 167
 168 /** \brief Private data available on all models
 169  *  \ingroup SURF_models
 170  */
 171      typedef struct surf_model_private *surf_model_private_t;
 172
 173 /** \brief Model datatype
 174  *  \ingroup SURF_models
 175  *
 176  *  Generic data structure for a model. The workstations,
 177  *  the CPUs and the network links are examples of models.
 178  */
 179      typedef struct surf_model {
 180        s_surf_model_public_t common_public;
 181        surf_model_private_t common_private;
 182      } s_surf_model_t;
 183
 184      void surf_model_init(surf_model_t model);
 185      void* surf_model_resource_by_name(void* model, const char *name);
 186 #define surf_model_resource_set(model) (model)->common_public.resource_set
 187      void surf_model_exit(surf_model_t model);
 188
 189      typedef struct surf_resource {
 190        surf_model_t model;
 191      } s_surf_resource_t, *surf_resource_t;
 192
 193 /**************************************/
 194 /* Implementations of model object */
 195 /**************************************/
 196
 197 /** \brief Timer model extension public
 198  * \ingroup SURF_model
 199  *
 200  * Additionnal functions specific to the timer model
 201  */
 202      typedef struct surf_timer_model_extension_public {
 203        void (*set) (double date, void *function, void *arg);
 204        int (*get) (void **function, void **arg);
 205      } s_surf_timer_model_extension_public_t,
 206   *surf_timer_model_extension_public_t;
 207
 208 /** \brief Timer model
 209  *  \ingroup SURF_models
 210  */
 211      typedef struct surf_timer_model {
 212        s_surf_model_public_t common_public;
 213        surf_model_private_t common_private;
 214        surf_timer_model_extension_public_t extension_public;
 215      } s_surf_timer_model_t, *surf_timer_model_t;
 216
 217 /** \brief The timer model
 218  *  \ingroup SURF_models
 219  */
 220 XBT_PUBLIC_DATA(surf_timer_model_t) surf_timer_model;
 221
 222 /** \brief Initializes the timer model
 223  *  \ingroup SURF_models
 224  */
 225 XBT_PUBLIC(void) surf_timer_model_init(const char *filename);
 226
 227 /* Cpu model */
 228
 229 /** \brief CPU state
 230  *  \ingroup SURF_models
 231  */
 232      typedef enum {
 233        SURF_CPU_ON = 1,         /**< Up & ready        */
 234        SURF_CPU_OFF = 0         /**< Down & broken     */
 235      } e_surf_cpu_state_t;
 236
 237 /** \brief CPU model extension public
 238  *  \ingroup SURF_models
 239  *
 240  *  Public functions specific to the CPU model.
 241  */
 242      typedef struct surf_cpu_model_extension_public {
 243        surf_action_t(*execute) (void *cpu, double size);
 244        surf_action_t(*sleep) (void *cpu, double duration);
 245        e_surf_cpu_state_t(*get_state) (void *cpu);
 246        double (*get_speed) (void *cpu, double load);
 247        double (*get_available_speed) (void *cpu);
 248      } s_surf_cpu_model_extension_public_t,
 249   *surf_cpu_model_extension_public_t;
 250
 251 /** \brief CPU model datatype
 252  *  \ingroup SURF_models
 253  */
 254      typedef struct surf_cpu_model {
 255        s_surf_model_public_t common_public;
 256        surf_model_private_t common_private;
 257        surf_cpu_model_extension_public_t extension_public;
 258      } s_surf_cpu_model_t, *surf_cpu_model_t;
 259
 260 /** \brief The CPU model
 261  *  \ingroup SURF_models
 262  */
 263 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model;
 264
 265 /** \brief Initializes the CPU model with the model Cas01
 266  *  \ingroup SURF_models
 267  *
 268  *  This function is called by surf_workstation_model_init_CLM03
 269  *  so you shouldn't have to call it by yourself.
 270  *
 271  *  \see surf_workstation_model_init_CLM03()
 272  */
 273 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(const char *filename);
 274
 275 /** \brief The list of all available cpu model models
 276  *  \ingroup SURF_models
 277  */
 278 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
 279
 280 /* Network model */
 281
 282 /** \brief Network model extension public
 283  *  \ingroup SURF_models
 284  *
 285  *  Public functions specific to the network model
 286  */
 287      typedef struct surf_network_model_extension_public {
 288        surf_action_t(*communicate) (void *src, void *dst, double size,
 289                                     double max_rate);
 290        const void **(*get_route) (void *src, void *dst);
 291        int (*get_route_size) (void *src, void *dst);
 292        const char *(*get_link_name) (const void *link);
 293        double (*get_link_bandwidth) (const void *link);
 294        double (*get_link_latency) (const void *link);
 295        int (*link_shared) (const void *link);
 296      } s_surf_network_model_extension_public_t,
 297   *surf_network_model_extension_public_t;
 298
 299 /** \brief Network model datatype
 300  *  \ingroup SURF_models
 301  */
 302      typedef struct surf_network_model {
 303        s_surf_model_public_t common_public;
 304        surf_model_private_t common_private;
 305        surf_network_model_extension_public_t extension_public;
 306      } s_surf_network_model_t, *surf_network_model_t;
 307
 308 XBT_PUBLIC(void) create_workstations(void);
 309
 310 /** \brief The network model
 311  *  \ingroup SURF_models
 312  *
 313  *  When creating a new API on top on SURF, you shouldn't use the
 314  *  network model unless you know what you are doing. Only the workstation
 315  *  model should be accessed because depending on the platform model,
 316  *  the network model can be NULL.
 317  */
 318 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
 319
 320 /** \brief Initializes the platform with the network model 'LagrangeVelho'
 321  *  \ingroup SURF_models
 322  *  \param filename XML platform file name
 323  *
 324  * This model is proposed by Arnaud Legrand and Pedro Velho based on
 325  * the results obtained with the GTNets simulator for onelink and
 326  * dogbone sharing scenarios.
 327  *
 328  *  \see surf_workstation_model_init_LegrandVelho()
 329  */
 330 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(const char *filename);
 331
 332 /** \brief Initializes the platform with the network model 'Constant'
 333  *  \ingroup SURF_models
 334  *  \param filename XML platform file name
 335  *
 336  *  In this model, the communication time between two network cards is
 337  *  constant, hence no need for a routing table. This is particularly
 338  *  usefull when simulating huge distributed algorithms where
 339  *  scalability is really an issue. This function is called in
 340  *  conjunction with surf_workstation_model_init_compound.
 341  *
 342  *  \see surf_workstation_model_init_compound()
 343  */
 344 XBT_PUBLIC(void) surf_network_model_init_Constant(const char *filename);
 345
 346 /** \brief Initializes the platform with the network model CM02
 347  *  \ingroup SURF_models
 348  *  \param filename XML platform file name
 349  *
 350  *  This function is called by surf_workstation_model_init_CLM03
 351  *  or by yourself only if you plan using surf_workstation_model_init_compound
 352  *
 353  *  \see surf_workstation_model_init_CLM03()
 354  */
 355 XBT_PUBLIC(void) surf_network_model_init_CM02(const char *filename);
 356
 357 #ifdef HAVE_GTNETS
 358 /** \brief Initializes the platform with the network model GTNETS
 359  *  \ingroup SURF_models
 360  *  \param filename XML platform file name
 361  *
 362  *  This function is called by surf_workstation_model_init_GTNETS
 363  *  or by yourself only if you plan using surf_workstation_model_init_compound
 364  *
 365  *  \see surf_workstation_model_init_GTNETS()
 366  */
 367 XBT_PUBLIC(void) surf_network_model_init_GTNETS(const char *filename);
 368 #endif
 369
 370 /** \brief Initializes the platform with the network model Reno
 371  *  \ingroup SURF_models
 372  *  \param filename XML platform file name
 373  *
 374  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 375  *
 376  *  Reference:
 377  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
 378  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 379  *
 380  *  Call this function only if you plan using surf_workstation_model_init_compound.
 381  *
 382  */
 383 XBT_PUBLIC(void) surf_network_model_init_Reno(const char *filename);
 384
 385 /** \brief Initializes the platform with the network model Reno2
 386  *  \ingroup SURF_models
 387  *  \param filename XML platform file name
 388  *
 389  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 390  *
 391  *  Reference:
 392  *  [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
 393  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 394  *
 395  *  Call this function only if you plan using surf_workstation_model_init_compound.
 396  *
 397  */
 398 XBT_PUBLIC(void) surf_network_model_init_Reno2(const char *filename);
 399
 400 /** \brief Initializes the platform with the network model Vegas
 401  *  \ingroup SURF_models
 402  *  \param filename XML platform file name
 403  *
 404  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
 405  *  to the proportional fairness.
 406  *
 407  *  Reference:
 408  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
 409  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 410  *
 411  *  Call this function only if you plan using surf_workstation_model_init_compound.
 412  *
 413  */
 414 XBT_PUBLIC(void) surf_network_model_init_Vegas(const char *filename);
 415
 416 #ifdef HAVE_SDP
 417 /** \brief Initializes the platform with the network model based on SDP
 418  *  \ingroup SURF_models
 419  *  \param filename XML platform file name
 420  *
 421  *  This function implements the proportional fairness known as the maximization
 422  *  of x1*x2*...*xn .
 423  *
 424  *  Reference:
 425  *
 426  *  [TAG03]. Corinne Touati, Eitan Altman, and Jerome Galtier.
 427  *  Semi-definite programming approach for bandwidth allocation and routing in networks.
 428  *  Game Theory and Applications, 9:169-179, December 2003. Nova publisher.
 429  *
 430  *  Call this function only if you plan using surf_workstation_model_init_compound.
 431  */
 432 XBT_PUBLIC(void) surf_network_model_init_SDP(const char *filename);
 433 #endif
 434
 435 /** \brief The list of all available network model models
 436  *  \ingroup SURF_models
 437  */
 438 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
 439
 440 /** \brief Workstation model extension public
 441  *  \ingroup SURF_models
 442  *
 443  *  Public functions specific to the workstation model.
 444  */
 445      typedef struct surf_workstation_model_extension_public {
 446        surf_action_t(*execute) (void *workstation, double size);       /**< Execute a computation amount on a workstation
 447                                                                         and create the corresponding action */
 448        surf_action_t(*sleep) (void *workstation, double duration);     /**< Make a workstation sleep during a given duration */
 449        e_surf_cpu_state_t(*get_state) (void *workstation);             /**< Return the CPU state of a workstation */
 450        double (*get_speed) (void *workstation, double load);           /**< Return the speed of a workstation */
 451        double (*get_available_speed) (void *workstation);              /**< Return tha available speed of a workstation */
 452          surf_action_t(*communicate) (void *workstation_src,           /**< Execute a communication amount between two workstations */
 453                                       void *workstation_dst, double size,
 454                                       double max_rate);
 455
 456          surf_action_t(*execute_parallel_task) (int workstation_nb,    /**< Execute a parallel task on several workstations */
 457                                                 void **workstation_list,
 458                                                 double *computation_amount,
 459                                                 double *communication_amount,
 460                                                 double amount, double rate);
 461        const void **(*get_route) (void *src, void *dst);               /**< Return the network link list between two workstations */
 462        int (*get_route_size) (void *src, void *dst);                   /**< Return the route size between two workstations */
 463        const char *(*get_link_name) (const void *link);                /**< Return the name of a network link */
 464        double (*get_link_bandwidth) (const void *link);                /**< Return the current bandwidth of a network link */
 465        double (*get_link_latency) (const void *link);                  /**< Return the current latency of a network link */
 466        int (*link_shared) (const void *link);
 467      } s_surf_workstation_model_extension_public_t,
 468   *surf_workstation_model_extension_public_t;
 469
 470 /** \brief Workstation model datatype.
 471  *  \ingroup SURF_models
 472  *
 473  */
 474      typedef struct surf_workstation_model {
 475        s_surf_model_public_t common_public;
 476        surf_model_private_t common_private;
 477        surf_workstation_model_extension_public_t extension_public;
 478      } s_surf_workstation_model_t, *surf_workstation_model_t;
 479
 480 /** \brief The workstation model
 481  *  \ingroup SURF_models
 482  *
 483  *  Note that when you create an API on top of SURF,
 484  *  the workstation model should be the only one you use
 485  *  because depending on the platform model, the network model and the CPU model
 486  *  may not exist.
 487  */
 488 XBT_PUBLIC_DATA(surf_workstation_model_t) surf_workstation_model;
 489
 490 /** \brief Initializes the platform with a compound workstation model
 491  *  \ingroup SURF_models
 492  *  \param filename XML platform file name
 493  *
 494  *  This function should be called after a cpu_model and a
 495  *  network_model have been set up.
 496  *
 497  */
 498 XBT_PUBLIC(void) surf_workstation_model_init_compound(const char *filename);
 499
 500 /** \brief Initializes the platform with the workstation model CLM03
 501  *  \ingroup SURF_models
 502  *  \param filename XML platform file name
 503  *
 504  *  This platform model seperates the workstation model and the network model.
 505  *  The workstation model will be initialized with the model CLM03, the network
 506  *  model with the model CM02 and the CPU model with the model Cas01.
 507  *  In future releases, some other network models will be implemented and will be
 508  *  combined with the workstation model CLM03.
 509  *
 510  *  \see surf_workstation_model_init_KCCFLN05()
 511  */
 512 XBT_PUBLIC(void) surf_workstation_model_init_CLM03(const char *filename);
 513
 514 /** \brief Initializes the platform with the model KCCFLN05
 515  *  \ingroup SURF_models
 516  *  \param filename XML platform file name
 517  *
 518  *  With this model, the workstations and the network are handled
 519  *  together. The network model is roughly the same as in CM02 but
 520  *  interference between computations and communications can be taken
 521  *  into account. This platform model is the default one for MSG and
 522  *  SimDag.
 523  *
 524  */
 525 XBT_PUBLIC(void) surf_workstation_model_init_KCCFLN05(const char *filename);
 526
 527 /** \brief Initializes the platform with the model KCCFLN05
 528  *  \ingroup SURF_models
 529  *  \param filename XML platform file name
 530  *
 531  *  With this model, only parallel tasks can be used. Resource sharing
 532  *  is done by identifying bottlenecks and giving an equal share of
 533  *  the model to each action.
 534  *
 535  */
 536 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(const char *filename);
 537
 538 /** \brief The list of all available workstation model models
 539  *  \ingroup SURF_models
 540  */
 541 XBT_PUBLIC_DATA(s_surf_model_description_t)
 542   surf_workstation_model_description[];
 543
 544 /** \brief The network links
 545  *  \ingroup SURF_models
 546  *
 547  *  This dict contains all network links.
 548  *
 549  *  \see workstation_set
 550  */
 551 XBT_PUBLIC_DATA(xbt_dict_t) link_set;
 552
 553 /** \brief The workstations
 554  *  \ingroup SURF_models
 555  *
 556  *  This dict contains all workstations.
 557  *
 558  *  \see link_set
 559  */
 560 /*XBT_PUBLIC_DATA(xbt_dict_t) workstation_set; //KILLME
 561 XBT_PUBLIC_DATA(xbt_dict_t) cpu_set; //KILLME*/
 562 /** \brief List of initialized models
 563  *  \ingroup SURF_models
 564  */
 565 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
 566
 567 /*******************************************/
 568 /*** SURF Globals **************************/
 569 /*******************************************/
 570 XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set;
 571
 572 /** \brief Initialize SURF
 573  *  \ingroup SURF_simulation
 574  *  \param argc argument number
 575  *  \param argv arguments
 576  *
 577  *  This function has to be called to initialize the common
 578  *  structures.  Then you will have to create the environment by
 579  *  calling surf_timer_model_init() and
 580  *  e.g. surf_workstation_model_init_CLM03() or
 581  *  surf_workstation_model_init_KCCFLN05().
 582  *
 583  *  \see surf_timer_model_init(), surf_workstation_model_init_CLM03(),
 584  *  surf_workstation_model_init_KCCFLN05(), surf_workstation_model_init_compound(), surf_exit()
 585  */
 586 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
 587
 588 /** \brief Initialize the used models.
 589  *
 590  * Must be called after the surf_init so that configuration infrastructure is created
 591  * Must be called before parsing/creating the environment
 592  * Must not be called within the initialization process so that the use get a chance to change the settings from
 593  * its code between, say, MSG_init and MSG_create_environment using MSG_config
 594  */
 595 XBT_PUBLIC(void) surf_config_models_setup(const char *platform_file);
 596
 597 /** \brief create the elements of the models
 598  *
 599  * Must be called after parsing the platform file and before using any elements
 600  */
 601 XBT_PUBLIC(void) surf_config_models_create_elms(void);
 602
 603 /** \brief Finish simulation initialization
 604  *  \ingroup SURF_simulation
 605  *
 606  *  This function must be called before the first call to surf_solve()
 607  */
 608 XBT_PUBLIC(void) surf_presolve(void);
 609
 610 /** \brief Performs a part of the simulation
 611  *  \ingroup SURF_simulation
 612  *  \return the elapsed time, or -1.0 if no event could be executed
 613  *
 614  *  This function execute all possible events, update the action states
 615  *  and returns the time elapsed.
 616  *  When you call execute or communicate on a model, the corresponding actions
 617  *  are not executed immediately but only when you call surf_solve.
 618  *  Note that the returned elapsed time can be zero.
 619  */
 620 XBT_PUBLIC(double) surf_solve(void);
 621
 622 /** \brief Return the current time
 623  *  \ingroup SURF_simulation
 624  *
 625  *  Return the current time in millisecond.
 626  */
 627 XBT_PUBLIC(double) surf_get_clock(void);
 628
 629 /** \brief Exit SURF
 630  *  \ingroup SURF_simulation
 631  *
 632  *  Clean everything.
 633  *
 634  *  \see surf_init()
 635  */
 636 XBT_PUBLIC(void) surf_exit(void);
 637
 638 /* Prototypes of the functions that handle the properties */
 639 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;       /* the prop set for the currently parsed element (also used in SIMIX) */
 640 XBT_PUBLIC_DATA(void) parse_properties(void);
 641
 642 /* surf parse file related (public because called from a test suite) */
 643 XBT_PUBLIC(void) parse_platform_file(const char *file);
 644
 645 /* Stores the sets */
 646 XBT_PUBLIC_DATA(xbt_dict_t) set_list;
 647
 648 XBT_PUBLIC_DATA(void) manage_route(xbt_dict_t route_table,
 649                                    const char *route_name, int action,
 650                                    int isMultiRoute);
 651 XBT_PUBLIC_DATA(int) route_action;
 652
 653 /* This is used by all models when creating the routing table while parsing */
 654 XBT_PUBLIC_DATA(xbt_dict_t) route_table;
 655 XBT_PUBLIC_DATA(xbt_dict_t) route_multi_table;
 656
 657
 658 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
 659 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
 660 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
 661 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
 662 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
 663 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
 664 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
 665
 666
 667 XBT_PUBLIC_DATA(double) get_cpu_power(const char *power);
 668
 669
 670 SG_END_DECL()
 671 #endif /* _SURF_SURF_H */