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 #include "xbt/lib.h"
  18 #include "surf/surf_routing.h"
  19 #include "simgrid/platf_interface.h"
  20
  21 SG_BEGIN_DECL()
  22 /* Actions and models are highly connected structures... */
  23
  24 typedef enum {
  25   SURF_LINK_FULLDUPLEX = 2,
  26   SURF_LINK_SHARED = 1,
  27   SURF_LINK_FATPIPE = 0
  28 } e_surf_link_sharing_policy_t;
  29
  30 typedef enum {
  31   SURF_NETWORK_ELEMENT_NULL = 0,        /* NULL */
  32   SURF_NETWORK_ELEMENT_HOST,    /* host type */
  33   SURF_NETWORK_ELEMENT_ROUTER,  /* router type */
  34   SURF_NETWORK_ELEMENT_AS,      /* AS type */
  35 } e_surf_network_element_type_t;
  36
  37 XBT_PUBLIC(e_surf_network_element_type_t) get_network_element_type(const char
  38                                                               *name);
  39
  40 /** @Brief Specify that we use that action */
  41 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
  42 /** @brief Creates a new action.
  43  *
  44  * @param size The size is the one of the subtype you want to create
  45  * @param cost initial value
  46  * @param model to which model we should attach this action
  47  * @param failed whether we should start this action in failed mode
  48  */
  49 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
  50                                    surf_model_t model, int failed);
  51
  52 /** \brief Resource model description
  53  */
  54 typedef struct surf_model_description {
  55   const char *name;
  56   const char *description;
  57   surf_model_t model;
  58   void (*model_init_preparse) (void);
  59   void (*model_init_postparse) (void);
  60 } s_surf_model_description_t, *surf_model_description_t;
  61
  62 XBT_PUBLIC(void) update_model_description(s_surf_model_description_t *
  63                                           table, const char *name,
  64                                           surf_model_t model);
  65 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
  66                                        const char *name);
  67 XBT_PUBLIC(void) model_help(const char *category,
  68                             s_surf_model_description_t * table);
  69
  70 /** \brief Action structure
  71  * \ingroup SURF_actions
  72  *
  73  *  Never create s_surf_action_t by yourself ! The actions are created
  74  *  on the fly when you call execute or communicate on a model.
  75  *
  76  *  \see e_surf_action_state_t
  77  */
  78 typedef struct surf_action {
  79   s_xbt_swag_hookup_t state_hookup;
  80   xbt_swag_t state_set;
  81   double cost;                  /**< cost        */
  82   double priority;              /**< priority (1.0 by default) */
  83   double max_duration;          /**< max_duration (may fluctuate until
  84                                    the task is completed) */
  85   double remains;               /**< How much of that cost remains to
  86                                  * be done in the currently running task */
  87 #ifdef HAVE_LATENCY_BOUND_TRACKING
  88   int latency_limited;               /**< Set to 1 if is limited by latency, 0 otherwise */
  89 #endif
  90
  91   double start;                 /**< start time  */
  92   double finish;                /**< finish time : this is modified during the run
  93                                  * and fluctuates until the task is completed */
  94   void *data;                   /**< for your convenience */
  95   int refcount;
  96   surf_model_t model_type;
  97 #ifdef HAVE_TRACING
  98   char *category;               /**< tracing category for categorized resource utilization monitoring */
  99 #endif
 100 } s_surf_action_t;
 101
 102 typedef struct surf_action_lmm {
 103   s_surf_action_t generic_action;
 104   lmm_variable_t variable;
 105   int suspended;
 106 } s_surf_action_lmm_t, *surf_action_lmm_t;
 107
 108 /** \brief Action states
 109  *  \ingroup SURF_actions
 110  *
 111  *  Action states.
 112  *
 113  *  \see surf_action_t, surf_action_state_t
 114  */
 115 typedef enum {
 116   SURF_ACTION_READY = 0,        /**< Ready        */
 117   SURF_ACTION_RUNNING,          /**< Running      */
 118   SURF_ACTION_FAILED,           /**< Task Failure */
 119   SURF_ACTION_DONE,             /**< Completed    */
 120   SURF_ACTION_TO_FREE,          /**< Action to free in next cleanup */
 121   SURF_ACTION_NOT_IN_THE_SYSTEM
 122                                 /**< Not in the system anymore. Why did you ask ? */
 123 } e_surf_action_state_t;
 124
 125 /** \brief Action state sets
 126  *  \ingroup SURF_actions
 127  *
 128  *  This structure contains some sets of actions.
 129  *  It provides a fast access to the actions in each state.
 130  *
 131  *  \see surf_action_t, e_surf_action_state_t
 132  */
 133 typedef struct surf_action_state {
 134   xbt_swag_t ready_action_set;
 135                                  /**< Actions in state SURF_ACTION_READY */
 136   xbt_swag_t running_action_set;
 137                                  /**< Actions in state SURF_ACTION_RUNNING */
 138   xbt_swag_t failed_action_set;
 139                                  /**< Actions in state SURF_ACTION_FAILED */
 140   xbt_swag_t done_action_set;
 141                                  /**< Actions in state SURF_ACTION_DONE */
 142 } s_surf_action_state_t, *surf_action_state_t;
 143
 144 /***************************/
 145 /* Generic model object */
 146 /***************************/
 147 typedef struct s_routing_global s_routing_global_t, *routing_global_t;
 148 XBT_PUBLIC_DATA(routing_global_t) global_routing;
 149
 150
 151 /** \brief Private data available on all models
 152  *  \ingroup SURF_models
 153  */
 154 typedef struct surf_model_private *surf_model_private_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) (const char *name, double power_peak,
 170                            double power_scale,
 171                            tmgr_trace_t power_trace,
 172                            int core,
 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) (const 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) (const 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) (const 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 #ifdef HAVE_TRACING
 284   void (*set_category) (surf_action_t action, const char *category); /**< Set the category of an action */
 285 #endif
 286   double (*get_remains) (surf_action_t action);     /**< Get the remains of an action */
 287 #ifdef HAVE_LATENCY_BOUND_TRACKING
 288   int (*get_latency_limited) (surf_action_t action);     /**< Return 1 if action is limited by latency, 0 otherwise */
 289 #endif
 290
 291   surf_model_private_t model_private;
 292
 293   union extension {
 294     s_surf_model_extension_cpu_t cpu;
 295     s_surf_model_extension_network_t network;
 296     s_surf_model_extension_workstation_t workstation;
 297   } extension;
 298 } s_surf_model_t;
 299
 300 surf_model_t surf_model_init(void);
 301 void surf_model_exit(surf_model_t model);
 302
 303 static inline void *surf_cpu_resource_by_name(const char *name) {
 304         return xbt_lib_get_or_null(host_lib, name, SURF_CPU_LEVEL);
 305 }
 306 static inline void *surf_workstation_resource_by_name(const char *name){
 307         return xbt_lib_get_or_null(host_lib, name, SURF_WKS_LEVEL);
 308 }
 309 static inline void *surf_network_resource_by_name(const char *name){
 310         return xbt_lib_get_or_null(link_lib, name, SURF_LINK_LEVEL);
 311 }
 312
 313 typedef struct surf_resource {
 314   surf_model_t model;
 315   char *name;
 316   xbt_dict_t properties;
 317 } s_surf_resource_t, *surf_resource_t;
 318
 319
 320
 321 /**
 322  * Resource which have a metric handled by a maxmin system
 323  */
 324 typedef struct {
 325   double scale;
 326   double peak;
 327   tmgr_trace_event_t event;
 328 } s_surf_metric_t;
 329
 330 typedef struct surf_resource_lmm {
 331   s_surf_resource_t generic_resource;
 332   lmm_constraint_t constraint;
 333   e_surf_resource_state_t state_current;
 334   tmgr_trace_event_t state_event;
 335   s_surf_metric_t power;
 336 } s_surf_resource_lmm_t, *surf_resource_lmm_t;
 337
 338 /**************************************/
 339 /* Implementations of model object */
 340 /**************************************/
 341
 342
 343 /** \brief The CPU model
 344  *  \ingroup SURF_models
 345  */
 346 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model;
 347
 348 /** \brief Initializes the CPU model with the model Cas01
 349  *  \ingroup SURF_models
 350  *
 351  *  This function is called by surf_workstation_model_init_CLM03
 352  *  so you shouldn't have to call it by yourself.
 353  *
 354  *  \see surf_workstation_model_init_CLM03()
 355  */
 356 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
 357
 358 /** \brief Initializes the CPU model with trace integration
 359  *  \ingroup SURF_models
 360  *
 361  */
 362 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
 363
 364 /** \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.
 365  *  \ingroup SURF_models
 366  *
 367  *  This function is called by surf_workstation_model_init_CLM03
 368  *  so you shouldn't have to call it by yourself.
 369  *
 370  *  \see surf_workstation_model_init_CLM03()
 371  */
 372 XBT_PUBLIC(void) surf_cpu_model_init_Cas01_im(void);
 373
 374 /** \brief The list of all available cpu model models
 375  *  \ingroup SURF_models
 376  */
 377 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
 378
 379 XBT_PUBLIC(void) create_workstations(void);
 380
 381 /**\brief create new host bypass the parser
 382  *
 383  */
 384
 385
 386 /** \brief The network model
 387  *  \ingroup SURF_models
 388  *
 389  *  When creating a new API on top on SURF, you shouldn't use the
 390  *  network model unless you know what you are doing. Only the workstation
 391  *  model should be accessed because depending on the platform model,
 392  *  the network model can be NULL.
 393  */
 394 XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
 395
 396 /** \brief Same as network model 'LagrangeVelho', only with different correction factors.
 397  *  \ingroup SURF_models
 398  *  \param filename XML platform file name
 399  *
 400  * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
 401  * based on the model 'LV08' and different correction factors depending on the communication
 402  * size (< 1KiB, < 64KiB, >= 64KiB).
 403  *
 404  *  \see surf_workstation_model_init_SMPI()
 405  */
 406 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
 407
 408 /** \brief Initializes the platform with the network model 'LagrangeVelho'
 409  *  \ingroup SURF_models
 410  *  \param filename XML platform file name
 411  *
 412  * This model is proposed by Arnaud Legrand and Pedro Velho based on
 413  * the results obtained with the GTNets simulator for onelink and
 414  * dogbone sharing scenarios.
 415  *
 416  *  \see surf_workstation_model_init_LegrandVelho()
 417  */
 418 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
 419
 420
 421 /** \brief Initializes the platform with the network model 'LV08_im'
 422  *  \ingroup SURF_models
 423  *  \param filename XML platform file name
 424  *
 425  * This model is adds the lazy management improvement to Legrand and
 426  * Velho model. This improvement essentially replaces the list of actions
 427  * inside the simulation kernel by a heap in order to reduce the complexity
 428  * at each iteration of the simulation kernel.
 429  *
 430  *  \see surf_workstation_model_init_LegrandVelho()
 431  */
 432 XBT_PUBLIC(void) im_surf_network_model_init_LegrandVelho(void);
 433
 434 /** \brief Initializes the platform with the network model 'Constant'
 435  *  \ingroup SURF_models
 436  *  \param filename XML platform file name
 437  *
 438  *  In this model, the communication time between two network cards is
 439  *  constant, hence no need for a routing table. This is particularly
 440  *  usefull when simulating huge distributed algorithms where
 441  *  scalability is really an issue. This function is called in
 442  *  conjunction with surf_workstation_model_init_compound.
 443  *
 444  *  \see surf_workstation_model_init_compound()
 445  */
 446 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
 447
 448 /** \brief Initializes the platform with the network model CM02
 449  *  \ingroup SURF_models
 450  *  \param filename XML platform file name
 451  *
 452  *  This function is called by surf_workstation_model_init_CLM03
 453  *  or by yourself only if you plan using surf_workstation_model_init_compound
 454  *
 455  *  \see surf_workstation_model_init_CLM03()
 456  */
 457 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
 458
 459 /**
 460  * brief initialize the the network model bypassing the XML parser
 461  */
 462 XBT_PUBLIC(void) surf_network_model_init_bypass(const char *id,
 463                                                 double initial_bw,
 464                                                 double initial_lat);
 465
 466 #ifdef HAVE_GTNETS
 467 /** \brief Initializes the platform with the network model GTNETS
 468  *  \ingroup SURF_models
 469  *  \param filename XML platform file name
 470  *
 471  *  This function is called by surf_workstation_model_init_GTNETS
 472  *  or by yourself only if you plan using surf_workstation_model_init_compound
 473  *
 474  *  \see surf_workstation_model_init_GTNETS()
 475  */
 476 XBT_PUBLIC(void) surf_network_model_init_GbTNETS(void);
 477 #endif
 478
 479 #ifdef HAVE_NS3
 480 /** \brief Initializes the platform with the network model NS3
 481  *  \ingroup SURF_models
 482  *  \param filename XML platform file name
 483  *
 484  *  This function is called by surf_workstation_model_init_NS3
 485  *  or by yourself only if you plan using surf_workstation_model_init_compound
 486  *
 487  *  \see surf_workstation_model_init_NS3()
 488  */
 489 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
 490
 491 XBT_PUBLIC(void) parse_ns3_add_host(void);
 492 XBT_PUBLIC(void) parse_ns3_add_router(void);
 493 XBT_PUBLIC(void) parse_ns3_add_link(void);
 494 XBT_PUBLIC(void) parse_ns3_add_AS(void);
 495 XBT_PUBLIC(void) parse_ns3_add_route(void);
 496 XBT_PUBLIC(void) parse_ns3_add_ASroute(void);
 497 XBT_PUBLIC(void) parse_ns3_add_cluster(void);
 498 XBT_PUBLIC(void) parse_ns3_end_platform(void);
 499 XBT_PUBLIC(void) create_ns3_topology(void);
 500 XBT_PUBLIC(double) ns3_get_link_latency(const void *link);
 501 XBT_PUBLIC(double) ns3_get_link_bandwidth(const void *link);
 502
 503 #endif
 504
 505 /** \brief Initializes the platform with the network model Reno
 506  *  \ingroup SURF_models
 507  *  \param filename XML platform file name
 508  *
 509  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 510  *
 511  *  Reference:
 512  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
 513  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 514  *
 515  *  Call this function only if you plan using surf_workstation_model_init_compound.
 516  *
 517  */
 518 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
 519
 520 /** \brief Initializes the platform with the network model Reno2
 521  *  \ingroup SURF_models
 522  *  \param filename XML platform file name
 523  *
 524  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 525  *
 526  *  Reference:
 527  *  [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
 528  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 529  *
 530  *  Call this function only if you plan using surf_workstation_model_init_compound.
 531  *
 532  */
 533 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
 534
 535 /** \brief Initializes the platform with the network model Vegas
 536  *  \ingroup SURF_models
 537  *  \param filename XML platform file name
 538  *
 539  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
 540  *  to the proportional fairness.
 541  *
 542  *  Reference:
 543  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
 544  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 545  *
 546  *  Call this function only if you plan using surf_workstation_model_init_compound.
 547  *
 548  */
 549 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
 550
 551 /** \brief The list of all available network model models
 552  *  \ingroup SURF_models
 553  */
 554 XBT_PUBLIC_DATA(s_surf_model_description_t)
 555     surf_network_model_description[];
 556
 557
 558 /** \brief The workstation model
 559  *  \ingroup SURF_models
 560  *
 561  *  Note that when you create an API on top of SURF,
 562  *  the workstation model should be the only one you use
 563  *  because depending on the platform model, the network model and the CPU model
 564  *  may not exist.
 565  */
 566 XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model;
 567
 568 /** \brief Initializes the platform with a compound workstation model
 569  *  \ingroup SURF_models
 570  *  \param filename XML platform file name
 571  *
 572  *  This function should be called after a cpu_model and a
 573  *  network_model have been set up.
 574  *
 575  */
 576 XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
 577
 578 /** \brief Initializes the platform with the workstation model CLM03
 579  *  \ingroup SURF_models
 580  *  \param filename XML platform file name
 581  *
 582  *  This platform model seperates the workstation model and the network model.
 583  *  The workstation model will be initialized with the model CLM03, the network
 584  *  model with the model CM02 and the CPU model with the model Cas01.
 585  *  In future releases, some other network models will be implemented and will be
 586  *  combined with the workstation model CLM03.
 587  *
 588  *  \see surf_workstation_model_init_KCCFLN05()
 589  */
 590 XBT_PUBLIC(void) surf_workstation_model_init_CLM03(void);
 591
 592 /** \brief Initializes the platform with the model KCCFLN05
 593  *  \ingroup SURF_models
 594  *  \param filename XML platform file name
 595  *
 596  *  With this model, the workstations and the network are handled
 597  *  together. The network model is roughly the same as in CM02 but
 598  *  interference between computations and communications can be taken
 599  *  into account. This platform model is the default one for MSG and
 600  *  SimDag.
 601  *
 602  */
 603 XBT_PUBLIC(void) surf_workstation_model_init_KCCFLN05(void);
 604
 605 /** \brief Initializes the platform with the model KCCFLN05
 606  *  \ingroup SURF_models
 607  *  \param filename XML platform file name
 608  *
 609  *  With this model, only parallel tasks can be used. Resource sharing
 610  *  is done by identifying bottlenecks and giving an equal share of
 611  *  the model to each action.
 612  *
 613  */
 614 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
 615
 616 /** \brief The list of all available workstation model models
 617  *  \ingroup SURF_models
 618  */
 619 XBT_PUBLIC_DATA(s_surf_model_description_t)
 620     surf_workstation_model_description[];
 621
 622 /** \brief List of initialized models
 623  *  \ingroup SURF_models
 624  */
 625 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
 626
 627 /*******************************************/
 628 /*** SURF Globals **************************/
 629 /*******************************************/
 630 XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set;
 631
 632 /** \brief Initialize SURF
 633  *  \ingroup SURF_simulation
 634  *  \param argc argument number
 635  *  \param argv arguments
 636  *
 637  *  This function has to be called to initialize the common
 638  *  structures.  Then you will have to create the environment by
 639  *  calling
 640  *  e.g. surf_workstation_model_init_CLM03() or
 641  *  surf_workstation_model_init_KCCFLN05().
 642  *
 643  *  \see surf_workstation_model_init_CLM03(),
 644  *  surf_workstation_model_init_KCCFLN05(), surf_workstation_model_init_compound(), surf_exit()
 645  */
 646 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
 647
 648 /** \brief create the elements of the models
 649  *
 650  * Must be called after parsing the platform file and before using any elements
 651  */
 652 XBT_PUBLIC(void) surf_config_models_create_elms(void);
 653
 654 /** \brief Finish simulation initialization
 655  *  \ingroup SURF_simulation
 656  *
 657  *  This function must be called before the first call to surf_solve()
 658  */
 659 XBT_PUBLIC(void) surf_presolve(void);
 660
 661 /** \brief Performs a part of the simulation
 662  *  \ingroup SURF_simulation
 663  *  \param max_date Maximum date to update the simulation to, or -1
 664  *  \return the elapsed time, or -1.0 if no event could be executed
 665  *
 666  *  This function execute all possible events, update the action states
 667  *  and returns the time elapsed.
 668  *  When you call execute or communicate on a model, the corresponding actions
 669  *  are not executed immediately but only when you call surf_solve.
 670  *  Note that the returned elapsed time can be zero.
 671  */
 672 XBT_PUBLIC(double) surf_solve(double max_date);
 673
 674 /** \brief Return the current time
 675  *  \ingroup SURF_simulation
 676  *
 677  *  Return the current time in millisecond.
 678  */
 679 XBT_INLINE XBT_PUBLIC(double) surf_get_clock(void);
 680
 681 /** \brief Exit SURF
 682  *  \ingroup SURF_simulation
 683  *
 684  *  Clean everything.
 685  *
 686  *  \see surf_init()
 687  */
 688 XBT_PUBLIC(void) surf_exit(void);
 689
 690 /* Prototypes of the functions that handle the properties */
 691 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;       /* the prop set for the currently parsed element (also used in SIMIX) */
 692 XBT_PUBLIC_DATA(void) parse_properties(const char* prop_id, const char* prop_value);
 693 XBT_PUBLIC_DATA(void) parse_properties_XML(void);
 694
 695 /* surf parse file related (public because called from a test suite) */
 696 XBT_PUBLIC(void) parse_platform_file(const char *file);
 697
 698 /* Stores the sets */
 699 XBT_PUBLIC_DATA(xbt_dict_t) set_list;
 700
 701 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
 702 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
 703 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
 704 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
 705 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
 706 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
 707 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
 708
 709
 710 XBT_PUBLIC(double) get_cpu_power(const char *power);
 711
 712 /*public interface to create resource bypassing the parser via cpu/network model
 713  *
 714  * see surfxml_parse.c
 715  * */
 716 XBT_PUBLIC(void*) surf_host_create_resource(char *name, double power_peak,
 717                                            double power_scale,
 718                                            tmgr_trace_t power_trace,
 719                                            int core,
 720                                            e_surf_resource_state_t
 721                                            state_initial,
 722                                            tmgr_trace_t state_trace,
 723                                            xbt_dict_t cpu_properties);
 724
 725 /*public interface to create resource bypassing the parser via workstation_ptask_L07 model
 726  *
 727  * see surfxml_parse.c
 728  * */
 729 XBT_PUBLIC(void*) surf_wsL07_host_create_resource(char *name,
 730                                                  double power_peak,
 731                                                  double power_scale,
 732                                                  tmgr_trace_t power_trace,
 733                                                  e_surf_resource_state_t
 734                                                  state_initial,
 735                                                  tmgr_trace_t state_trace,
 736                                                  xbt_dict_t
 737                                                  cpu_properties);
 738 /**
 739  * create link resource
 740  * see surfxml_parse.c
 741  */
 742 XBT_PUBLIC(void*) surf_link_create_resource(char *name,
 743                                            double bw_initial,
 744                                            tmgr_trace_t bw_trace,
 745                                            double lat_initial,
 746                                            tmgr_trace_t lat_trace,
 747                                            e_surf_resource_state_t
 748                                            state_initial,
 749                                            tmgr_trace_t state_trace,
 750                                            e_surf_link_sharing_policy_t
 751                                            policy, xbt_dict_t properties);
 752
 753
 754 XBT_PUBLIC(void*) surf_wsL07_link_create_resource(char *name,
 755                                                  double bw_initial,
 756                                                  tmgr_trace_t bw_trace,
 757                                                  double lat_initial,
 758                                                  tmgr_trace_t lat_trace,
 759                                                  e_surf_resource_state_t
 760                                                  state_initial,
 761                                                  tmgr_trace_t state_trace,
 762                                                  e_surf_link_sharing_policy_t
 763                                                  policy,
 764                                                  xbt_dict_t properties);
 765 /**
 766  * add route element (link_ctn) bypassing the parser
 767  *
 768  * see surfxml_parse.c
 769  *
 770  */
 771 XBT_PUBLIC(void) surf_add_route_element(char *link_ctn_id);
 772
 773 /**
 774  * set route src_id,dest_id, and create a route resource
 775  *
 776  * see surf_routing.c && surfxml_parse.c
 777  */
 778
 779 XBT_PUBLIC(void) surf_set_routes(void);
 780
 781
 782 /**
 783  * add traces
 784  * see surfxml_parse.c
 785  */
 786 XBT_PUBLIC(void) surf_add_host_traces(void);
 787 XBT_PUBLIC(void) surf_add_link_traces(void);
 788 XBT_PUBLIC(void) surf_wsL07_add_traces(void);
 789
 790 //Set a new link on the actual list of link for a route or ASroute
 791 XBT_PUBLIC(void) routing_add_link(const char *link_id);
 792 //Set the endpoints for a route
 793 XBT_PUBLIC(void) routing_set_route(const char *src_id, const char *dst_id);
 794 //Store the route
 795 XBT_PUBLIC(void) routing_store_route(void);
 796 XBT_PUBLIC(void) surf_routing_add_route(const char *src_id,
 797                                         const char *dest_id,
 798                                         xbt_dynar_t links_id);
 799
 800 #include "surf/surf_resource.h"
 801 #include "surf/surf_resource_lmm.h"
 802
 803 SG_END_DECL()
 804 #endif                          /* _SURF_SURF_H */