src/include/surf/surf.h

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