src/include/surf/surf.h

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