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