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