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