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