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