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