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