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