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