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