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