src/include/surf/surf.h

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