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