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