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