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 typedef struct s_surf_file {
 197   char *name;                   /**< @brief host name if any */
 198   void *data;                   /**< @brief user data */
 199 } s_surf_file_t;
 200 typedef struct s_surf_file *surf_file_t;
 201
 202 /* Storage model */
 203
 204 /** \brief Storage model extension public
 205  *  \ingroup SURF_models
 206  *
 207  *  Public functions specific to the Storage model.
 208  */
 209
 210 typedef struct surf_storage_model_extension_public {
 211   surf_action_t(*open) (void *workstation, const char* path, const char* mode);
 212   surf_action_t(*close) (void *workstation, surf_file_t fp);
 213   surf_action_t(*read) (void *workstation, void* ptr, size_t size, size_t nmemb, surf_file_t stream);
 214   surf_action_t(*write) (void *workstation, const void* ptr, size_t size, size_t nmemb, surf_file_t stream);
 215   surf_action_t(*stat) (void *workstation, int fd, void* buf);
 216   void* (*create_resource) (const char* id, const char* model,
 217       const char* content, xbt_dict_t properties);
 218 } s_surf_model_extension_storage_t;
 219
 220      /** \brief Workstation model extension public
 221       *  \ingroup SURF_models
 222       *
 223       *  Public functions specific to the workstation model.
 224       */
 225 typedef struct surf_workstation_model_extension_public {
 226   surf_action_t(*execute) (void *workstation, double size);                                /**< Execute a computation amount on a workstation
 227                                                                                         and create the corresponding action */
 228   surf_action_t(*sleep) (void *workstation, double duration);                              /**< Make a workstation sleep during a given duration */
 229   e_surf_resource_state_t(*get_state) (void *workstation);                                      /**< Return the CPU state of a workstation */
 230   double (*get_speed) (void *workstation, double load);                                    /**< Return the speed of a workstation */
 231   double (*get_available_speed) (void *workstation);                                       /**< Return tha available speed of a workstation */
 232    surf_action_t(*communicate) (void *workstation_src,                                     /**< Execute a communication amount between two workstations */
 233                                 void *workstation_dst, double size,
 234                                 double max_rate);
 235    // FIXME: kill next field, which duplicates the routing
 236    xbt_dynar_t(*get_route) (void *workstation_src, void *workstation_dst);                 /**< Get the list of links between two ws */
 237
 238    surf_action_t(*execute_parallel_task) (int workstation_nb,                              /**< Execute a parallel task on several workstations */
 239                                           void **workstation_list,
 240                                           double *computation_amount,
 241                                           double *communication_amount,
 242                                           double amount, double rate);
 243   double (*get_link_bandwidth) (const void *link);                                         /**< Return the current bandwidth of a network link */
 244   double (*get_link_latency) (const void *link);                                           /**< Return the current latency of a network link */
 245   surf_action_t(*open) (void *workstation, const char* path, const char* mode);
 246   surf_action_t(*close) (void *workstation, surf_file_t fp);
 247   surf_action_t(*read) (void *workstation, void* ptr, size_t size, size_t nmemb, surf_file_t stream);
 248   surf_action_t(*write) (void *workstation, const void* ptr, size_t size, size_t nmemb, surf_file_t stream);
 249   surf_action_t(*stat) (void *workstation, int fd, void* buf);
 250   int (*link_shared) (const void *link);
 251    xbt_dict_t(*get_properties) (const void *resource);
 252   void* (*link_create_resource) (const char *name,
 253                                 double bw_initial,
 254                                 tmgr_trace_t bw_trace,
 255                                 double lat_initial,
 256                                 tmgr_trace_t lat_trace,
 257                                 e_surf_resource_state_t
 258                                 state_initial,
 259                                 tmgr_trace_t state_trace,
 260                                 e_surf_link_sharing_policy_t
 261                                 policy, xbt_dict_t properties);
 262   void* (*cpu_create_resource) (const char *name, double power_peak,
 263                                double power_scale,
 264                                tmgr_trace_t power_trace,
 265                                e_surf_resource_state_t state_initial,
 266                                tmgr_trace_t state_trace,
 267                                xbt_dict_t cpu_properties);
 268   void (*add_traces) (void);
 269
 270 } s_surf_model_extension_workstation_t;
 271
 272
 273
 274
 275 /** \brief Model datatype
 276  *  \ingroup SURF_models
 277  *
 278  *  Generic data structure for a model. The workstations,
 279  *  the CPUs and the network links are examples of models.
 280  */
 281 typedef struct surf_model {
 282   const char *name;     /**< Name of this model */
 283   s_surf_action_state_t states;      /**< Any living action on this model */
 284
 285    e_surf_action_state_t(*action_state_get) (surf_action_t action);
 286                                                                        /**< Return the state of an action */
 287   void (*action_state_set) (surf_action_t action,
 288                             e_surf_action_state_t state);
 289                                                                   /**< Change an action state*/
 290
 291   double (*action_get_start_time) (surf_action_t action);     /**< Return the start time of an action */
 292   double (*action_get_finish_time) (surf_action_t action);     /**< Return the finish time of an action */
 293   int (*action_unref) (surf_action_t action);     /**< Specify that we don't use that action anymore */
 294   void (*action_cancel) (surf_action_t action);     /**< Cancel a running action */
 295   void (*action_recycle) (surf_action_t action);     /**< Recycle an action */
 296   void (*action_data_set) (surf_action_t action, void *data);     /**< Set the user data of an action */
 297   void (*suspend) (surf_action_t action);     /**< Suspend an action */
 298   void (*resume) (surf_action_t action);     /**< Resume a suspended action */
 299   int (*is_suspended) (surf_action_t action);     /**< Return whether an action is suspended */
 300   void (*set_max_duration) (surf_action_t action, double duration);     /**< Set the max duration of an action*/
 301   void (*set_priority) (surf_action_t action, double priority);     /**< Set the priority of an action */
 302 #ifdef HAVE_TRACING
 303   void (*set_category) (surf_action_t action, const char *category); /**< Set the category of an action */
 304 #endif
 305   double (*get_remains) (surf_action_t action);     /**< Get the remains of an action */
 306 #ifdef HAVE_LATENCY_BOUND_TRACKING
 307   int (*get_latency_limited) (surf_action_t action);     /**< Return 1 if action is limited by latency, 0 otherwise */
 308 #endif
 309
 310   surf_model_private_t model_private;
 311
 312   union extension {
 313     s_surf_model_extension_cpu_t cpu;
 314     s_surf_model_extension_network_t network;
 315     s_surf_model_extension_storage_t storage;
 316     s_surf_model_extension_workstation_t workstation;
 317   } extension;
 318 } s_surf_model_t;
 319
 320 surf_model_t surf_model_init(void);
 321 void surf_model_exit(surf_model_t model);
 322
 323 static inline void *surf_cpu_resource_by_name(const char *name) {
 324         return xbt_lib_get_or_null(host_lib, name, SURF_CPU_LEVEL);
 325 }
 326 static inline void *surf_workstation_resource_by_name(const char *name){
 327         return xbt_lib_get_or_null(host_lib, name, SURF_WKS_LEVEL);
 328 }
 329 static inline void *surf_network_resource_by_name(const char *name){
 330         return xbt_lib_get_or_null(link_lib, name, SURF_LINK_LEVEL);
 331 }
 332
 333 typedef struct surf_resource {
 334   surf_model_t model;
 335   char *name;
 336   xbt_dict_t properties;
 337 } s_surf_resource_t, *surf_resource_t;
 338
 339 /**
 340  * Storage struct
 341  */
 342 typedef struct s_storage_type {
 343   char *model;
 344   char *content;
 345   xbt_dict_t properties;
 346   char *type_id;
 347 } s_storage_type_t, *storage_type_t;
 348
 349 typedef struct s_mount {
 350   char *type_id;
 351   char *name;
 352 } s_mount_t, *mount_t;
 353
 354 /**
 355  * Resource which have a metric handled by a maxmin system
 356  */
 357 typedef struct {
 358   double scale;
 359   double peak;
 360   tmgr_trace_event_t event;
 361 } s_surf_metric_t;
 362
 363 typedef struct surf_resource_lmm {
 364   s_surf_resource_t generic_resource;
 365   lmm_constraint_t constraint;
 366   e_surf_resource_state_t state_current;
 367   tmgr_trace_event_t state_event;
 368   s_surf_metric_t power;
 369 } s_surf_resource_lmm_t, *surf_resource_lmm_t;
 370
 371 /**************************************/
 372 /* Implementations of model object */
 373 /**************************************/
 374
 375
 376 /** \brief The CPU model
 377  *  \ingroup SURF_models
 378  */
 379 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model;
 380
 381 /** \brief Initializes the CPU model with the model Cas01
 382  *  \ingroup SURF_models
 383  *
 384  *  By default, this model uses the lazy optimization mechanism that
 385  *  relies on partial invalidation in LMM and a heap for lazy action update.
 386  *  You can change this behavior by setting the cpu/optim configuration
 387  *  variable to a different value.
 388  *
 389  *  This function is called by surf_workstation_model_init_CLM03
 390  *  so you shouldn't have to call it by yourself.
 391  *
 392  *  \see surf_workstation_model_init_CLM03()
 393  */
 394 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
 395
 396 /** \brief Initializes the CPU model with trace integration [Deprecated]
 397  *  \ingroup SURF_models
 398  *
 399  *  You shouldn't have to call it by yourself.
 400  *  \see surf_workstation_model_init_CLM03()
 401  */
 402 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
 403
 404 /** \brief This function call the share resources function needed
 405  *
 406  */
 407 XBT_PUBLIC(double) generic_share_resources(double now);
 408
 409 /** \brief This function call the update action state function needed
 410  *
 411  */
 412 XBT_PUBLIC(void)   generic_update_actions_state(double now, double delta);
 413
 414 /** \brief The list of all available optimization modes (both for cpu and networks).
 415  *  \ingroup SURF_models
 416  *  These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
 417  */
 418 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
 419
 420 /** \brief The list of all available cpu model models
 421  *  \ingroup SURF_models
 422  */
 423 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
 424
 425 XBT_PUBLIC(void) create_workstations(void);
 426
 427 /**\brief create new host bypass the parser
 428  *
 429  */
 430
 431
 432 /** \brief The network model
 433  *  \ingroup SURF_models
 434  *
 435  *  When creating a new API on top on SURF, you shouldn't use the
 436  *  network model unless you know what you are doing. Only the workstation
 437  *  model should be accessed because depending on the platform model,
 438  *  the network model can be NULL.
 439  */
 440 XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
 441
 442 /** \brief Same as network model 'LagrangeVelho', only with different correction factors.
 443  *  \ingroup SURF_models
 444  *
 445  * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
 446  * based on the model 'LV08' and different correction factors depending on the communication
 447  * size (< 1KiB, < 64KiB, >= 64KiB).
 448  * See comments in the code for more information.
 449  *
 450  *  \see surf_workstation_model_init_SMPI()
 451  */
 452 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
 453
 454 /** \brief Initializes the platform with the network model 'LegrandVelho'
 455  *  \ingroup SURF_models
 456  *
 457  * This model is proposed by Arnaud Legrand and Pedro Velho based on
 458  * the results obtained with the GTNets simulator for onelink and
 459  * dogbone sharing scenarios. See comments in the code for more information.
 460  *
 461  *  \see surf_workstation_model_init_LegrandVelho()
 462  */
 463 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
 464
 465 /** \brief Initializes the platform with the network model 'Constant'
 466  *  \ingroup SURF_models
 467  *
 468  *  In this model, the communication time between two network cards is
 469  *  constant, hence no need for a routing table. This is particularly
 470  *  usefull when simulating huge distributed algorithms where
 471  *  scalability is really an issue. This function is called in
 472  *  conjunction with surf_workstation_model_init_compound.
 473  *
 474  *  \see surf_workstation_model_init_compound()
 475  */
 476 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
 477
 478 /** \brief Initializes the platform with the network model CM02
 479  *  \ingroup SURF_models
 480  *
 481  *  This function is called by surf_workstation_model_init_CLM03
 482  *  or by yourself only if you plan using surf_workstation_model_init_compound
 483  *  See comments in the code for more information.
 484  *
 485  *  \see surf_workstation_model_init_CLM03()
 486  */
 487 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
 488
 489 /**
 490  * brief initialize the the network model bypassing the XML parser
 491  */
 492 XBT_PUBLIC(void) surf_network_model_init_bypass(const char *id,
 493                                                 double initial_bw,
 494                                                 double initial_lat);
 495
 496 #ifdef HAVE_GTNETS
 497 /** \brief Initializes the platform with the network model GTNETS
 498  *  \ingroup SURF_models
 499  *  \param filename XML platform file name
 500  *
 501  *  This function is called by surf_workstation_model_init_GTNETS
 502  *  or by yourself only if you plan using surf_workstation_model_init_compound
 503  *
 504  *  \see surf_workstation_model_init_GTNETS()
 505  */
 506 XBT_PUBLIC(void) surf_network_model_init_GbTNETS(void);
 507 #endif
 508
 509 #ifdef HAVE_NS3
 510 /** \brief Initializes the platform with the network model NS3
 511  *  \ingroup SURF_models
 512  *  \param filename XML platform file name
 513  *
 514  *  This function is called by surf_workstation_model_init_NS3
 515  *  or by yourself only if you plan using surf_workstation_model_init_compound
 516  *
 517  *  \see surf_workstation_model_init_NS3()
 518  */
 519 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
 520
 521 XBT_PUBLIC(void) parse_ns3_add_host(void);
 522 XBT_PUBLIC(void) parse_ns3_add_router(void);
 523 XBT_PUBLIC(void) parse_ns3_add_link(void);
 524 XBT_PUBLIC(void) parse_ns3_add_AS(void);
 525 XBT_PUBLIC(void) parse_ns3_add_route(void);
 526 XBT_PUBLIC(void) parse_ns3_add_ASroute(void);
 527 XBT_PUBLIC(void) parse_ns3_add_cluster(void);
 528 XBT_PUBLIC(void) parse_ns3_end_platform(void);
 529 XBT_PUBLIC(void) create_ns3_topology(void);
 530 XBT_PUBLIC(double) ns3_get_link_latency(const void *link);
 531 XBT_PUBLIC(double) ns3_get_link_bandwidth(const void *link);
 532
 533 #endif
 534
 535 /** \brief Initializes the platform with the network model Reno
 536  *  \ingroup SURF_models
 537  *  \param filename XML platform file name
 538  *
 539  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 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_Reno(void);
 549
 550 /** \brief Initializes the platform with the network model Reno2
 551  *  \ingroup SURF_models
 552  *  \param filename XML platform file name
 553  *
 554  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 555  *
 556  *  Reference:
 557  *  [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
 558  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 559  *
 560  *  Call this function only if you plan using surf_workstation_model_init_compound.
 561  *
 562  */
 563 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
 564
 565 /** \brief Initializes the platform with the network model Vegas
 566  *  \ingroup SURF_models
 567  *  \param filename XML platform file name
 568  *
 569  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
 570  *  to the proportional fairness.
 571  *
 572  *  Reference:
 573  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
 574  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 575  *
 576  *  Call this function only if you plan using surf_workstation_model_init_compound.
 577  *
 578  */
 579 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
 580
 581 /** \brief The list of all available network model models
 582  *  \ingroup SURF_models
 583  */
 584 XBT_PUBLIC_DATA(s_surf_model_description_t)
 585     surf_network_model_description[];
 586
 587
 588
 589
 590
 591
 592 /** \brief The storage model
 593  *  \ingroup SURF_models
 594  */
 595 XBT_PUBLIC(void) surf_storage_model_init_default(void);
 596
 597 /** \brief The list of all available storage modes.
 598  *  \ingroup SURF_models
 599  *  This storage mode can be set using --cfg=storage/model:...
 600  */
 601 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
 602
 603
 604
 605
 606
 607
 608
 609 /** \brief The workstation model
 610  *  \ingroup SURF_models
 611  *
 612  *  Note that when you create an API on top of SURF,
 613  *  the workstation model should be the only one you use
 614  *  because depending on the platform model, the network model and the CPU model
 615  *  may not exist.
 616  */
 617 XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model;
 618
 619 /** \brief Initializes the platform with a compound workstation model
 620  *  \ingroup SURF_models
 621  *
 622  *  This function should be called after a cpu_model and a
 623  *  network_model have been set up.
 624  *
 625  */
 626 XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
 627
 628 /** \brief Initializes the platform with the current best network and cpu models at hand
 629  *  \ingroup SURF_models
 630  *
 631  *  This platform model seperates the workstation model and the network model.
 632  *  The workstation model will be initialized with the model compound, the network
 633  *  model with the model LV08 (with cross traffic support) and the CPU model with
 634  *  the model Cas01.
 635  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
 636  *
 637  */
 638 XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
 639
 640 /** \brief Initializes the platform with the workstation model CLM03
 641  *  \ingroup SURF_models
 642  *
 643  *  This platform model seperates the workstation model and the network model.
 644  *  The workstation model will be initialized with the model CLM03, the network
 645  *  model with the model CM02 and the CPU model with the model Cas01.
 646  *  In future releases, some other network models will be implemented and will be
 647  *  combined with the workstation model CLM03.
 648  *
 649  */
 650 XBT_PUBLIC(void) surf_workstation_model_init_CLM03(void);
 651
 652 /** \brief Initializes the platform with the model KCCFLN05
 653  *  \ingroup SURF_models
 654  *
 655  *  With this model, only parallel tasks can be used. Resource sharing
 656  *  is done by identifying bottlenecks and giving an equal share of
 657  *  the model to each action.
 658  *
 659  */
 660 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
 661
 662 /** \brief The list of all available workstation model models
 663  *  \ingroup SURF_models
 664  */
 665 XBT_PUBLIC_DATA(s_surf_model_description_t)
 666     surf_workstation_model_description[];
 667
 668 /** \brief List of initialized models
 669  *  \ingroup SURF_models
 670  */
 671 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
 672
 673 /*******************************************/
 674 /*** SURF Globals **************************/
 675 /*******************************************/
 676 XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set;
 677
 678 /** \brief Initialize SURF
 679  *  \ingroup SURF_simulation
 680  *  \param argc argument number
 681  *  \param argv arguments
 682  *
 683  *  This function has to be called to initialize the common
 684  *  structures.  Then you will have to create the environment by
 685  *  calling
 686  *  e.g. surf_workstation_model_init_CLM03()
 687  *
 688  *  \see surf_workstation_model_init_CLM03(), surf_workstation_model_init_compound(), surf_exit()
 689  */
 690 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
 691
 692 /** \brief Finish simulation initialization
 693  *  \ingroup SURF_simulation
 694  *
 695  *  This function must be called before the first call to surf_solve()
 696  */
 697 XBT_PUBLIC(void) surf_presolve(void);
 698
 699 /** \brief Performs a part of the simulation
 700  *  \ingroup SURF_simulation
 701  *  \param max_date Maximum date to update the simulation to, or -1
 702  *  \return the elapsed time, or -1.0 if no event could be executed
 703  *
 704  *  This function execute all possible events, update the action states
 705  *  and returns the time elapsed.
 706  *  When you call execute or communicate on a model, the corresponding actions
 707  *  are not executed immediately but only when you call surf_solve.
 708  *  Note that the returned elapsed time can be zero.
 709  */
 710 XBT_PUBLIC(double) surf_solve(double max_date);
 711
 712 /** \brief Return the current time
 713  *  \ingroup SURF_simulation
 714  *
 715  *  Return the current time in millisecond.
 716  */
 717 XBT_PUBLIC(double) surf_get_clock(void);
 718
 719 /** \brief Exit SURF
 720  *  \ingroup SURF_simulation
 721  *
 722  *  Clean everything.
 723  *
 724  *  \see surf_init()
 725  */
 726 XBT_PUBLIC(void) surf_exit(void);
 727
 728 /* Prototypes of the functions that handle the properties */
 729 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;       /* the prop set for the currently parsed element (also used in SIMIX) */
 730 XBT_PUBLIC(void) parse_properties(void);
 731
 732 /* surf parse file related (public because called from a test suite) */
 733 XBT_PUBLIC(void) parse_platform_file(const char *file);
 734
 735 /* Stores the sets */
 736 XBT_PUBLIC_DATA(xbt_dict_t) set_list;
 737
 738 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
 739 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
 740 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
 741 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
 742 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
 743 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
 744 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
 745
 746
 747 XBT_PUBLIC(double) get_cpu_power(const char *power);
 748
 749 int surf_get_nthreads(void);
 750 void surf_set_nthreads(int nthreads);
 751
 752 SG_END_DECL()
 753 #endif                          /* _SURF_SURF_H */