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