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