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
 190 /**************************************/
 191 /* Implementations of model object */
 192 /**************************************/
 193
 194 /** \brief Timer model extension public
 195  * \ingroup SURF_model
 196  *
 197  * Additionnal functions specific to the timer model
 198  */
 199      typedef struct surf_timer_model_extension_public {
 200        void (*set) (double date, void *function, void *arg);
 201        int (*get) (void **function, void **arg);
 202      } s_surf_timer_model_extension_public_t,
 203   *surf_timer_model_extension_public_t;
 204
 205 /** \brief Timer model
 206  *  \ingroup SURF_models
 207  */
 208      typedef struct surf_timer_model {
 209        s_surf_model_public_t common_public;
 210        surf_model_private_t common_private;
 211        surf_timer_model_extension_public_t extension_public;
 212      } s_surf_timer_model_t, *surf_timer_model_t;
 213
 214 /** \brief The timer model
 215  *  \ingroup SURF_models
 216  */
 217 XBT_PUBLIC_DATA(surf_timer_model_t) surf_timer_model;
 218
 219 /** \brief Initializes the timer model
 220  *  \ingroup SURF_models
 221  */
 222 XBT_PUBLIC(void) surf_timer_model_init(const char *filename);
 223
 224 /* Cpu model */
 225
 226 /** \brief CPU state
 227  *  \ingroup SURF_models
 228  */
 229      typedef enum {
 230        SURF_CPU_ON = 1,         /**< Up & ready        */
 231        SURF_CPU_OFF = 0         /**< Down & broken     */
 232      } e_surf_cpu_state_t;
 233
 234 /** \brief CPU model extension public
 235  *  \ingroup SURF_models
 236  *
 237  *  Public functions specific to the CPU model.
 238  */
 239      typedef struct surf_cpu_model_extension_public {
 240        surf_action_t(*execute) (void *cpu, double size);
 241        surf_action_t(*sleep) (void *cpu, double duration);
 242        e_surf_cpu_state_t(*get_state) (void *cpu);
 243        double (*get_speed) (void *cpu, double load);
 244        double (*get_available_speed) (void *cpu);
 245      } s_surf_cpu_model_extension_public_t,
 246   *surf_cpu_model_extension_public_t;
 247
 248 /** \brief CPU model datatype
 249  *  \ingroup SURF_models
 250  */
 251      typedef struct surf_cpu_model {
 252        s_surf_model_public_t common_public;
 253        surf_model_private_t common_private;
 254        surf_cpu_model_extension_public_t extension_public;
 255      } s_surf_cpu_model_t, *surf_cpu_model_t;
 256
 257 /** \brief The CPU model
 258  *  \ingroup SURF_models
 259  */
 260 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model;
 261
 262 /** \brief Initializes the CPU model with the model Cas01
 263  *  \ingroup SURF_models
 264  *
 265  *  This function is called by surf_workstation_model_init_CLM03
 266  *  so you shouldn't have to call it by yourself.
 267  *
 268  *  \see surf_workstation_model_init_CLM03()
 269  */
 270 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(const char *filename);
 271
 272 /** \brief The list of all available cpu model models
 273  *  \ingroup SURF_models
 274  */
 275 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
 276
 277 /* Network model */
 278
 279 /** \brief Network model extension public
 280  *  \ingroup SURF_models
 281  *
 282  *  Public functions specific to the network model
 283  */
 284      typedef struct surf_network_model_extension_public {
 285        surf_action_t(*communicate) (void *src, void *dst, double size,
 286                                     double max_rate);
 287        const void **(*get_route) (void *src, void *dst);
 288        int (*get_route_size) (void *src, void *dst);
 289        const char *(*get_link_name) (const void *link);
 290        double (*get_link_bandwidth) (const void *link);
 291        double (*get_link_latency) (const void *link);
 292        int (*link_shared) (const void *link);
 293      } s_surf_network_model_extension_public_t,
 294   *surf_network_model_extension_public_t;
 295
 296 /** \brief Network model datatype
 297  *  \ingroup SURF_models
 298  */
 299      typedef struct surf_network_model {
 300        s_surf_model_public_t common_public;
 301        surf_model_private_t common_private;
 302        surf_network_model_extension_public_t extension_public;
 303      } s_surf_network_model_t, *surf_network_model_t;
 304
 305 XBT_PUBLIC(void) create_workstations(void);
 306
 307 /** \brief The network model
 308  *  \ingroup SURF_models
 309  *
 310  *  When creating a new API on top on SURF, you shouldn't use the
 311  *  network model unless you know what you are doing. Only the workstation
 312  *  model should be accessed because depending on the platform model,
 313  *  the network model can be NULL.
 314  */
 315 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
 316
 317 /** \brief Initializes the platform with the network model 'LagrangeVelho'
 318  *  \ingroup SURF_models
 319  *  \param filename XML platform file name
 320  *
 321  * This model is proposed by Arnaud Legrand and Pedro Velho based on
 322  * the results obtained with the GTNets simulator for onelink and
 323  * dogbone sharing scenarios.
 324  *
 325  *  \see surf_workstation_model_init_LegrandVelho()
 326  */
 327 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(const char *filename);
 328
 329 /** \brief Initializes the platform with the network model 'Constant'
 330  *  \ingroup SURF_models
 331  *  \param filename XML platform file name
 332  *
 333  *  In this model, the communication time between two network cards is
 334  *  constant, hence no need for a routing table. This is particularly
 335  *  usefull when simulating huge distributed algorithms where
 336  *  scalability is really an issue. This function is called in
 337  *  conjunction with surf_workstation_model_init_compound.
 338  *
 339  *  \see surf_workstation_model_init_compound()
 340  */
 341 XBT_PUBLIC(void) surf_network_model_init_Constant(const char *filename);
 342
 343 /** \brief Initializes the platform with the network model CM02
 344  *  \ingroup SURF_models
 345  *  \param filename XML platform file name
 346  *
 347  *  This function is called by surf_workstation_model_init_CLM03
 348  *  or by yourself only if you plan using surf_workstation_model_init_compound
 349  *
 350  *  \see surf_workstation_model_init_CLM03()
 351  */
 352 XBT_PUBLIC(void) surf_network_model_init_CM02(const char *filename);
 353
 354 #ifdef HAVE_GTNETS
 355 /** \brief Initializes the platform with the network model GTNETS
 356  *  \ingroup SURF_models
 357  *  \param filename XML platform file name
 358  *
 359  *  This function is called by surf_workstation_model_init_GTNETS
 360  *  or by yourself only if you plan using surf_workstation_model_init_compound
 361  *
 362  *  \see surf_workstation_model_init_GTNETS()
 363  */
 364 XBT_PUBLIC(void) surf_network_model_init_GTNETS(const char *filename);
 365 #endif
 366
 367 /** \brief Initializes the platform with the network model Reno
 368  *  \ingroup SURF_models
 369  *  \param filename XML platform file name
 370  *
 371  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 372  *
 373  *  Reference:
 374  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
 375  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 376  *
 377  *  Call this function only if you plan using surf_workstation_model_init_compound.
 378  *
 379  */
 380 XBT_PUBLIC(void) surf_network_model_init_Reno(const char *filename);
 381
 382 /** \brief Initializes the platform with the network model Reno2
 383  *  \ingroup SURF_models
 384  *  \param filename XML platform file name
 385  *
 386  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 387  *
 388  *  Reference:
 389  *  [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
 390  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 391  *
 392  *  Call this function only if you plan using surf_workstation_model_init_compound.
 393  *
 394  */
 395 XBT_PUBLIC(void) surf_network_model_init_Reno2(const char *filename);
 396
 397 /** \brief Initializes the platform with the network model Vegas
 398  *  \ingroup SURF_models
 399  *  \param filename XML platform file name
 400  *
 401  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
 402  *  to the proportional fairness.
 403  *
 404  *  Reference:
 405  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
 406  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 407  *
 408  *  Call this function only if you plan using surf_workstation_model_init_compound.
 409  *
 410  */
 411 XBT_PUBLIC(void) surf_network_model_init_Vegas(const char *filename);
 412
 413 #ifdef HAVE_SDP
 414 /** \brief Initializes the platform with the network model based on SDP
 415  *  \ingroup SURF_models
 416  *  \param filename XML platform file name
 417  *
 418  *  This function implements the proportional fairness known as the maximization
 419  *  of x1*x2*...*xn .
 420  *
 421  *  Reference:
 422  *
 423  *  [TAG03]. Corinne Touati, Eitan Altman, and Jerome Galtier.
 424  *  Semi-definite programming approach for bandwidth allocation and routing in networks.
 425  *  Game Theory and Applications, 9:169-179, December 2003. Nova publisher.
 426  *
 427  *  Call this function only if you plan using surf_workstation_model_init_compound.
 428  */
 429 XBT_PUBLIC(void) surf_network_model_init_SDP(const char *filename);
 430 #endif
 431
 432 /** \brief The list of all available network model models
 433  *  \ingroup SURF_models
 434  */
 435 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
 436
 437 /** \brief Workstation model extension public
 438  *  \ingroup SURF_models
 439  *
 440  *  Public functions specific to the workstation model.
 441  */
 442      typedef struct surf_workstation_model_extension_public {
 443        surf_action_t(*execute) (void *workstation, double size);       /**< Execute a computation amount on a workstation
 444                                                                         and create the corresponding action */
 445        surf_action_t(*sleep) (void *workstation, double duration);     /**< Make a workstation sleep during a given duration */
 446        e_surf_cpu_state_t(*get_state) (void *workstation);             /**< Return the CPU state of a workstation */
 447        double (*get_speed) (void *workstation, double load);           /**< Return the speed of a workstation */
 448        double (*get_available_speed) (void *workstation);              /**< Return tha available speed of a workstation */
 449          surf_action_t(*communicate) (void *workstation_src,           /**< Execute a communication amount between two workstations */
 450                                       void *workstation_dst, double size,
 451                                       double max_rate);
 452
 453          surf_action_t(*execute_parallel_task) (int workstation_nb,    /**< Execute a parallel task on several workstations */
 454                                                 void **workstation_list,
 455                                                 double *computation_amount,
 456                                                 double *communication_amount,
 457                                                 double amount, double rate);
 458        const void **(*get_route) (void *src, void *dst);               /**< Return the network link list between two workstations */
 459        int (*get_route_size) (void *src, void *dst);                   /**< Return the route size between two workstations */
 460        const char *(*get_link_name) (const void *link);                /**< Return the name of a network link */
 461        double (*get_link_bandwidth) (const void *link);                /**< Return the current bandwidth of a network link */
 462        double (*get_link_latency) (const void *link);                  /**< Return the current latency of a network link */
 463        int (*link_shared) (const void *link);
 464      } s_surf_workstation_model_extension_public_t,
 465   *surf_workstation_model_extension_public_t;
 466
 467 /** \brief Workstation model datatype.
 468  *  \ingroup SURF_models
 469  *
 470  */
 471      typedef struct surf_workstation_model {
 472        s_surf_model_public_t common_public;
 473        surf_model_private_t common_private;
 474        surf_workstation_model_extension_public_t extension_public;
 475      } s_surf_workstation_model_t, *surf_workstation_model_t;
 476
 477 /** \brief The workstation model
 478  *  \ingroup SURF_models
 479  *
 480  *  Note that when you create an API on top of SURF,
 481  *  the workstation model should be the only one you use
 482  *  because depending on the platform model, the network model and the CPU model
 483  *  may not exist.
 484  */
 485 XBT_PUBLIC_DATA(surf_workstation_model_t) surf_workstation_model;
 486
 487 /** \brief Initializes the platform with a compound workstation model
 488  *  \ingroup SURF_models
 489  *  \param filename XML platform file name
 490  *
 491  *  This function should be called after a cpu_model and a
 492  *  network_model have been set up.
 493  *
 494  */
 495 XBT_PUBLIC(void) surf_workstation_model_init_compound(const char *filename);
 496
 497 /** \brief Initializes the platform with the workstation model CLM03
 498  *  \ingroup SURF_models
 499  *  \param filename XML platform file name
 500  *
 501  *  This platform model seperates the workstation model and the network model.
 502  *  The workstation model will be initialized with the model CLM03, the network
 503  *  model with the model CM02 and the CPU model with the model Cas01.
 504  *  In future releases, some other network models will be implemented and will be
 505  *  combined with the workstation model CLM03.
 506  *
 507  *  \see surf_workstation_model_init_KCCFLN05()
 508  */
 509 XBT_PUBLIC(void) surf_workstation_model_init_CLM03(const char *filename);
 510
 511 /** \brief Initializes the platform with the model KCCFLN05
 512  *  \ingroup SURF_models
 513  *  \param filename XML platform file name
 514  *
 515  *  With this model, the workstations and the network are handled
 516  *  together. The network model is roughly the same as in CM02 but
 517  *  interference between computations and communications can be taken
 518  *  into account. This platform model is the default one for MSG and
 519  *  SimDag.
 520  *
 521  */
 522 XBT_PUBLIC(void) surf_workstation_model_init_KCCFLN05(const char *filename);
 523
 524 /** \brief Initializes the platform with the model KCCFLN05
 525  *  \ingroup SURF_models
 526  *  \param filename XML platform file name
 527  *
 528  *  With this model, only parallel tasks can be used. Resource sharing
 529  *  is done by identifying bottlenecks and giving an equal share of
 530  *  the model to each action.
 531  *
 532  */
 533 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(const char *filename);
 534
 535 /** \brief The list of all available workstation model models
 536  *  \ingroup SURF_models
 537  */
 538 XBT_PUBLIC_DATA(s_surf_model_description_t)
 539   surf_workstation_model_description[];
 540
 541 /** \brief The network links
 542  *  \ingroup SURF_models
 543  *
 544  *  This dict contains all network links.
 545  *
 546  *  \see workstation_set
 547  */
 548 XBT_PUBLIC_DATA(xbt_dict_t) link_set;
 549
 550 /** \brief The workstations
 551  *  \ingroup SURF_models
 552  *
 553  *  This dict contains all workstations.
 554  *
 555  *  \see link_set
 556  */
 557 /*XBT_PUBLIC_DATA(xbt_dict_t) workstation_set; //KILLME
 558 XBT_PUBLIC_DATA(xbt_dict_t) cpu_set; //KILLME*/
 559 /** \brief List of initialized models
 560  *  \ingroup SURF_models
 561  */
 562 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
 563
 564 /*******************************************/
 565 /*** SURF Globals **************************/
 566 /*******************************************/
 567 XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set;
 568
 569 /** \brief Initialize SURF
 570  *  \ingroup SURF_simulation
 571  *  \param argc argument number
 572  *  \param argv arguments
 573  *
 574  *  This function has to be called to initialize the common
 575  *  structures.  Then you will have to create the environment by
 576  *  calling surf_timer_model_init() and
 577  *  e.g. surf_workstation_model_init_CLM03() or
 578  *  surf_workstation_model_init_KCCFLN05().
 579  *
 580  *  \see surf_timer_model_init(), surf_workstation_model_init_CLM03(),
 581  *  surf_workstation_model_init_KCCFLN05(), surf_workstation_model_init_compound(), surf_exit()
 582  */
 583 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
 584
 585 /** \brief Initialize the used models.
 586  *
 587  * Must be called after the surf_init so that configuration infrastructure is created
 588  * Must be called before parsing/creating the environment
 589  * Must not be called within the initialization process so that the use get a chance to change the settings from
 590  * its code between, say, MSG_init and MSG_create_environment using MSG_config
 591  */
 592 XBT_PUBLIC(void) surf_config_models_setup(const char *platform_file);
 593
 594 /** \brief create the elements of the models
 595  *
 596  * Must be called after parsing the platform file and before using any elements
 597  */
 598 XBT_PUBLIC(void) surf_config_models_create_elms(void);
 599
 600 /** \brief Finish simulation initialization
 601  *  \ingroup SURF_simulation
 602  *
 603  *  This function must be called before the first call to surf_solve()
 604  */
 605 XBT_PUBLIC(void) surf_presolve(void);
 606
 607 /** \brief Performs a part of the simulation
 608  *  \ingroup SURF_simulation
 609  *  \return the elapsed time, or -1.0 if no event could be executed
 610  *
 611  *  This function execute all possible events, update the action states
 612  *  and returns the time elapsed.
 613  *  When you call execute or communicate on a model, the corresponding actions
 614  *  are not executed immediately but only when you call surf_solve.
 615  *  Note that the returned elapsed time can be zero.
 616  */
 617 XBT_PUBLIC(double) surf_solve(void);
 618
 619 /** \brief Return the current time
 620  *  \ingroup SURF_simulation
 621  *
 622  *  Return the current time in millisecond.
 623  */
 624 XBT_PUBLIC(double) surf_get_clock(void);
 625
 626 /** \brief Exit SURF
 627  *  \ingroup SURF_simulation
 628  *
 629  *  Clean everything.
 630  *
 631  *  \see surf_init()
 632  */
 633 XBT_PUBLIC(void) surf_exit(void);
 634
 635 /* Prototypes of the functions that handle the properties */
 636 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;       /* the prop set for the currently parsed element (also used in SIMIX) */
 637 XBT_PUBLIC_DATA(void) parse_properties(void);
 638
 639 /* surf parse file related (public because called from a test suite) */
 640 XBT_PUBLIC(void) parse_platform_file(const char *file);
 641
 642 /* Stores the sets */
 643 XBT_PUBLIC_DATA(xbt_dict_t) set_list;
 644
 645 XBT_PUBLIC_DATA(void) manage_route(xbt_dict_t route_table,
 646                                    const char *route_name, int action,
 647                                    int isMultiRoute);
 648 XBT_PUBLIC_DATA(int) route_action;
 649
 650 /* This is used by all models when creating the routing table while parsing */
 651 XBT_PUBLIC_DATA(xbt_dict_t) route_table;
 652 XBT_PUBLIC_DATA(xbt_dict_t) route_multi_table;
 653
 654
 655 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
 656 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
 657 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
 658 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
 659 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
 660 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
 661 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
 662
 663
 664 XBT_PUBLIC_DATA(double) get_cpu_power(const char *power);
 665
 666
 667 SG_END_DECL()
 668 #endif /* _SURF_SURF_H */