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