src/include/surf/surf.h

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