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