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