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/graph.h"
  14 #include "xbt/misc.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 /* user-visible parameters */
  26 extern double sg_tcp_gamma;
  27 extern double sg_sender_gap;
  28 extern double sg_latency_factor;
  29 extern double sg_bandwidth_factor;
  30 extern double sg_weight_S_parameter;
  31 extern int sg_network_crosstraffic;
  32 #ifdef HAVE_GTNETS
  33 extern double sg_gtnets_jitter;
  34 extern int sg_gtnets_jitter_seed;
  35 #endif
  36 extern xbt_dynar_t surf_path;
  37
  38 typedef enum {
  39   SURF_NETWORK_ELEMENT_NULL = 0,        /* NULL */
  40   SURF_NETWORK_ELEMENT_HOST,    /* host type */
  41   SURF_NETWORK_ELEMENT_ROUTER,  /* router type */
  42   SURF_NETWORK_ELEMENT_AS       /* AS type */
  43 } e_surf_network_element_type_t;
  44
  45 #ifdef __cplusplus
  46 class Model;
  47 class CpuModel;
  48 class WorkstationModel;
  49 class NetworkCm02Model;
  50 class Resource;
  51 class ResourceLmm;
  52 class WorkstationCLM03;
  53 class NetworkCm02Link;
  54 class Cpu;
  55 class Action;
  56 class ActionLmm;
  57 class StorageActionLmm;
  58 class As;
  59 class RoutingEdge;
  60 class RoutingPlatf;
  61 #else
  62 typedef struct Model Model;
  63 typedef struct CpuModel CpuModel;
  64 typedef struct WorkstationModel WorkstationModel;
  65 typedef struct NetworkCm02Model NetworkCm02Model;
  66 typedef struct Resource Resource;
  67 typedef struct ResourceLmm ResourceLmm;
  68 typedef struct WorkstationCLM03 WorkstationCLM03;
  69 typedef struct NetworkCm02Link NetworkCm02Link;
  70 typedef struct Cpu Cpu;
  71 typedef struct Action Action;
  72 typedef struct ActionLmm ActionLmm;
  73 typedef struct StorageActionLmm StorageActionLmm;
  74 typedef struct As As;
  75 typedef struct RoutingEdge RoutingEdge;
  76 typedef struct RoutingPlatf RoutingPlatf;
  77 #endif
  78
  79 /** \ingroup SURF_models
  80  *  \brief Model datatype
  81  *
  82  *  Generic data structure for a model. The workstations,
  83  *  the CPUs and the network links are examples of models.
  84  */
  85 typedef Model *surf_model_t;
  86 typedef CpuModel *surf_cpu_model_t;
  87 typedef WorkstationModel *surf_workstation_model_t;
  88 typedef NetworkCm02Model *surf_network_model_t;
  89
  90 typedef xbt_dictelm_t surf_resource_t;
  91 typedef Resource *surf_cpp_resource_t;
  92 typedef WorkstationCLM03 *surf_workstation_CLM03_t;
  93 typedef NetworkCm02Link *surf_network_link_t;
  94 typedef Cpu *surf_cpu_t;
  95
  96 /** \ingroup SURF_actions
  97  *  \brief Action structure
  98  *
  99  *  Never create s_surf_action_t by yourself ! The actions are created
 100  *  on the fly when you call execute or communicate on a model.
 101  *
 102  *  \see e_surf_action_state_t
 103  */
 104 typedef Action *surf_action_t;
 105 typedef ActionLmm *surf_action_lmm_t;
 106 typedef StorageActionLmm *surf_storage_action_lmm_t;
 107
 108 typedef As *AS_t;
 109 typedef RoutingEdge *routing_edge_t;
 110 typedef RoutingPlatf *routing_platf_t;
 111
 112 typedef struct surf_file *surf_file_t;
 113
 114 XBT_PUBLIC(e_surf_network_element_type_t)
 115   routing_get_network_element_type(const char* name);
 116
 117 /** @Brief Specify that we use that action */
 118 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
 119
 120 /** @brief Creates a new action.
 121  *
 122  * @param size The size is the one of the subtype you want to create
 123  * @param cost initial value
 124  * @param model to which model we should attach this action
 125  * @param failed whether we should start this action in failed mode
 126  */
 127 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
 128                                    surf_model_t model, int failed);
 129
 130 /** \brief Resource model description
 131  */
 132 typedef struct surf_model_description {
 133   const char *name;
 134   const char *description;
 135   void_f_void_t model_init_preparse;
 136 } s_surf_model_description_t, *surf_model_description_t;
 137
 138 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
 139                                        const char *name);
 140 XBT_PUBLIC(void) model_help(const char *category,
 141                             s_surf_model_description_t * table);
 142
 143
 144
 145 /** \ingroup SURF_actions
 146  *  \brief Action states
 147  *
 148  *  Action states.
 149  *
 150  *  \see surf_action_t, surf_action_state_t
 151  */
 152
 153 typedef enum {
 154   SURF_ACTION_READY = 0,        /**< Ready        */
 155   SURF_ACTION_RUNNING,          /**< Running      */
 156   SURF_ACTION_FAILED,           /**< Task Failure */
 157   SURF_ACTION_DONE,             /**< Completed    */
 158   SURF_ACTION_TO_FREE,          /**< Action to free in next cleanup */
 159   SURF_ACTION_NOT_IN_THE_SYSTEM
 160                                 /**< Not in the system anymore. Why did you ask ? */
 161 } e_surf_action_state_t;
 162
 163 /***************************/
 164 /* Generic model object */
 165 /***************************/
 166 //FIXME:REMOVE typedef struct s_routing_platf s_routing_platf_t, *routing_platf_t;
 167 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
 168
 169 /*******************************************
 170  *  TUTORIAL: New model
 171  *  New model extension public
 172  *  Public functions specific to a New model.
 173  */
 174 typedef struct surf_new_model_extension_public {
 175   surf_action_t(*fct) ();
 176   void* (*create_resource) ();
 177 } s_surf_model_extension_new_model_t;
 178 /*******************************************/
 179
 180 /** \ingroup SURF_models
 181  *  \brief Private data available on all models
 182  */
 183 typedef struct surf_model_private *surf_model_private_t;
 184
 185      /* Cpu model */
 186
 187      /** \ingroup SURF_models
 188       *  \brief CPU model extension public
 189       *
 190       *  Public functions specific to the CPU model.
 191       */
 192 typedef struct surf_cpu_model_extension_public {
 193   surf_action_t(*execute) (void *cpu, double size);
 194   surf_action_t(*sleep) (void *cpu, double duration);
 195   e_surf_resource_state_t(*get_state) (void *cpu);
 196   int (*get_core) (void *cpu);
 197   double (*get_speed) (void *cpu, double load);
 198   double (*get_available_speed) (void *cpu);
 199   void (*add_traces) (void);
 200 } s_surf_model_extension_cpu_t;
 201
 202      /* Network model */
 203
 204      /** \ingroup SURF_models
 205       *  \brief Network model extension public
 206       *
 207       *  Public functions specific to the network model
 208       */
 209 typedef struct surf_network_model_extension_public {
 210   surf_action_t (*communicate) (sg_routing_edge_t src,
 211                                 sg_routing_edge_t dst,
 212                                 double size, double rate);
 213   xbt_dynar_t(*get_route) (void *src, void *dst); //FIXME: kill field? That is done by the routing nowadays
 214   double (*get_link_bandwidth) (const void *link);
 215   double (*get_link_latency) (const void *link);
 216   int (*link_shared) (const void *link);
 217   void (*add_traces) (void);
 218 } s_surf_model_extension_network_t;
 219
 220 /* Storage model */
 221 //
 222 /** \ingroup SURF_models
 223  *  \brief Storage model extension public
 224  *
 225  *  Public functions specific to the Storage model.
 226  */
 227
 228 typedef struct surf_storage_model_extension_public {
 229   surf_action_t(*open) (void *storage, const char* mount, const char* path);
 230   surf_action_t(*close) (void *storage, surf_file_t fd);
 231   surf_action_t(*read) (void *storage, void* ptr, size_t size,
 232                         surf_file_t fd);
 233   surf_action_t(*write) (void *storage, const void* ptr, size_t size,
 234                          surf_file_t fd);
 235   surf_action_t(*stat) (void *storage, surf_file_t fd);
 236   surf_action_t(*ls) (void *storage, const char *path);
 237 } s_surf_model_extension_storage_t;
 238
 239      /** \ingroup SURF_models
 240       *  \brief Workstation model extension public
 241       *
 242       *  Public functions specific to the workstation model.
 243       */
 244 typedef struct surf_workstation_model_extension_public {
 245   surf_action_t(*execute) (void *workstation, double size);                                /**< Execute a computation amount on a workstation
 246                                       and create the corresponding action */
 247   surf_action_t(*sleep) (void *workstation, double duration);                              /**< Make a workstation sleep during a given duration */
 248   e_surf_resource_state_t(*get_state) (void *workstation);                                      /**< Return the CPU state of a workstation */
 249   int (*get_core) (void *workstation);
 250   double (*get_speed) (void *workstation, double load);                                    /**< Return the speed of a workstation */
 251   double (*get_available_speed) (void *workstation);                                       /**< Return tha available speed of a workstation */
 252    surf_action_t(*communicate) (void *workstation_src,                                     /**< Execute a communication amount between two workstations */
 253                                 void *workstation_dst, double size,
 254                                 double max_rate);
 255    // FIXME: kill next field, which duplicates the routing
 256    xbt_dynar_t(*get_route) (void *workstation_src, void *workstation_dst);                 /**< Get the list of links between two ws */
 257
 258    surf_action_t(*execute_parallel_task) (int workstation_nb,                              /**< Execute a parallel task on several workstations */
 259                                           void **workstation_list,
 260                                           double *computation_amount,
 261                                           double *communication_amount,
 262                                           double rate);
 263   double (*get_link_bandwidth) (const void *link);                                         /**< Return the current bandwidth of a network link */
 264   double (*get_link_latency) (const void *link);                                           /**< Return the current latency of a network link */
 265   surf_action_t(*open) (void *workstation, const char* storage,
 266                         const char* path);
 267   surf_action_t(*close) (void *workstation, surf_file_t fd);
 268   surf_action_t(*read) (void *workstation, void* ptr, size_t size,
 269                         surf_file_t fd);
 270   surf_action_t(*write) (void *workstation, const void* ptr, size_t size,
 271                          surf_file_t fd);
 272   surf_action_t(*stat) (void *workstation, surf_file_t fd);
 273   int(*unlink) (void *workstation, surf_file_t fd);
 274   surf_action_t(*ls) (void *workstation, const char* mount, const char *path);
 275   size_t (*get_size) (void *workstation, surf_file_t fd);
 276
 277   int (*link_shared) (const void *link);
 278    xbt_dict_t(*get_properties) (const void *resource);
 279   void (*add_traces) (void);
 280
 281 } s_surf_model_extension_workstation_t;
 282
 283
 284 static inline void *surf_cpu_resource_priv(const void *host) {
 285   return xbt_lib_get_level((xbt_dictelm_t)host, SURF_CPU_LEVEL);
 286 }
 287 static inline void *surf_workstation_resource_priv(const void *host){
 288   return (void*)xbt_lib_get_level((xbt_dictelm_t)host, SURF_WKS_LEVEL);
 289 }
 290 static inline void *surf_storage_resource_priv(const void *host){
 291   return (void*)xbt_lib_get_level((xbt_dictelm_t)host, SURF_STORAGE_LEVEL);
 292 }
 293
 294 static inline void *surf_cpu_resource_by_name(const char *name) {
 295   return xbt_lib_get_elm_or_null(host_lib, name);
 296 }
 297 static inline void *surf_workstation_resource_by_name(const char *name){
 298   return xbt_lib_get_elm_or_null(host_lib, name);
 299 }
 300 static inline void *surf_storage_resource_by_name(const char *name){
 301   return xbt_lib_get_elm_or_null(storage_lib, name);
 302 }
 303
 304 #ifdef __cplusplus
 305 extern "C" {
 306 #endif
 307 char *surf_routing_edge_name(sg_routing_edge_t edge);
 308 void *surf_as_cluster_get_backbone(AS_t as);
 309 void surf_as_cluster_set_backbone(AS_t as, void* backbone);
 310 const char *surf_model_name(surf_model_t model);
 311 xbt_swag_t surf_model_done_action_set(surf_model_t model);
 312 xbt_swag_t surf_model_failed_action_set(surf_model_t model);
 313 xbt_swag_t surf_model_ready_action_set(surf_model_t model);
 314 xbt_swag_t surf_model_running_action_set(surf_model_t model);
 315 surf_action_t surf_workstation_model_execute_parallel_task(surf_workstation_model_t model,
 316                                                     int workstation_nb,
 317                                             void **workstation_list,
 318                                             double *computation_amount,
 319                                             double *communication_amount,
 320                                             double rate);
 321 surf_action_t surf_workstation_model_communicate(surf_workstation_model_t model, surf_resource_t src, surf_resource_t dst, double size, double rate);
 322 xbt_dynar_t surf_workstation_model_get_route(surf_workstation_model_t model, surf_resource_t src, surf_resource_t dst);
 323 surf_action_t surf_network_model_communicate(surf_network_model_t model, sg_routing_edge_t src, sg_routing_edge_t dst, double size, double rate);
 324 const char *surf_resource_name(surf_cpp_resource_t resource);
 325 xbt_dict_t surf_resource_get_properties(surf_cpp_resource_t resource);
 326 e_surf_resource_state_t surf_resource_get_state(surf_cpp_resource_t resource);
 327 double surf_workstation_get_speed(surf_resource_t resource, double load);
 328 double surf_workstation_get_available_speed(surf_resource_t resource);
 329 int surf_workstation_get_core(surf_resource_t resource);
 330 surf_action_t surf_workstation_execute(surf_resource_t resource, double size);
 331 surf_action_t surf_workstation_sleep(surf_resource_t resource, double duration);
 332 surf_action_t surf_workstation_open(surf_resource_t workstation, const char* mount, const char* path);
 333 surf_action_t surf_workstation_close(surf_resource_t workstation, surf_file_t fd);
 334 surf_action_t surf_cpu_execute(surf_resource_t cpu, double size);
 335 surf_action_t surf_cpu_sleep(surf_resource_t cpu, double duration);
 336 int surf_workstation_unlink(surf_resource_t workstation, surf_file_t fd);
 337 surf_action_t surf_workstation_ls(surf_resource_t workstation, const char* mount, const char *path);
 338 size_t surf_workstation_get_size(surf_resource_t workstation, surf_file_t fd);
 339 surf_action_t surf_workstation_read(surf_resource_t resource, void *ptr, size_t size, surf_file_t fd);
 340 surf_action_t surf_workstation_write(surf_resource_t resource, const void *ptr, size_t size, surf_file_t fd);
 341 int surf_network_link_is_shared(surf_cpp_resource_t link);
 342 double surf_network_link_get_bandwidth(surf_cpp_resource_t link);
 343 double surf_network_link_get_latency(surf_cpp_resource_t link);
 344 void *surf_action_get_data(surf_action_t action);
 345 void surf_action_set_data(surf_action_t action, void *data);
 346 void surf_action_unref(surf_action_t action);
 347 double surf_action_get_start_time(surf_action_t action);
 348 double surf_action_get_finish_time(surf_action_t action);
 349 double surf_action_get_remains(surf_action_t action);
 350 void surf_action_suspend(surf_action_t action);
 351 void surf_action_resume(surf_action_t action);
 352 void surf_action_cancel(surf_action_t action);
 353 void surf_action_set_priority(surf_action_t action, double priority);
 354 void surf_action_set_category(surf_action_t action, const char *category);
 355 e_surf_action_state_t surf_action_get_state(surf_action_t action);
 356 int surf_action_get_cost(surf_action_t action);
 357 surf_file_t surf_storage_action_get_file(surf_storage_action_lmm_t action);
 358 xbt_dict_t surf_storage_action_get_ls_dict(surf_storage_action_lmm_t action);
 359
 360 #ifdef __cplusplus
 361 }
 362 #endif
 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_cpu_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  *  You shouldn't have to call it by yourself.
 383  */
 384 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
 385
 386 /** \ingroup SURF_models
 387  *  \brief Initializes the CPU model with trace integration [Deprecated]
 388  *
 389  *  You shouldn't have to call it by yourself.
 390  */
 391 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
 392
 393 /** \ingroup SURF_models
 394  *  \brief The list of all available optimization modes (both for cpu and networks).
 395  *  These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
 396  */
 397 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
 398
 399 /** \ingroup SURF_models
 400  *  \brief The list of all available cpu model models
 401  */
 402 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
 403
 404 /**\brief create new host bypass the parser
 405  *
 406  */
 407
 408
 409 /** \ingroup SURF_models
 410  *  \brief The network model
 411  *
 412  *  When creating a new API on top on SURF, you shouldn't use the
 413  *  network model unless you know what you are doing. Only the workstation
 414  *  model should be accessed because depending on the platform model,
 415  *  the network model can be NULL.
 416  */
 417 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
 418
 419 /** \ingroup SURF_models
 420  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
 421  *
 422  * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
 423  * based on the model 'LV08' and different correction factors depending on the communication
 424  * size (< 1KiB, < 64KiB, >= 64KiB).
 425  * See comments in the code for more information.
 426  *
 427  *  \see surf_workstation_model_init_SMPI()
 428  */
 429 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
 430
 431 /** \ingroup SURF_models
 432  *  \brief Initializes the platform with the network model 'LegrandVelho'
 433  *
 434  * This model is proposed by Arnaud Legrand and Pedro Velho based on
 435  * the results obtained with the GTNets simulator for onelink and
 436  * dogbone sharing scenarios. See comments in the code for more information.
 437  *
 438  *  \see surf_workstation_model_init_LegrandVelho()
 439  */
 440 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
 441
 442 /** \ingroup SURF_models
 443  *  \brief Initializes the platform with the network model 'Constant'
 444  *
 445  *  In this model, the communication time between two network cards is
 446  *  constant, hence no need for a routing table. This is particularly
 447  *  usefull when simulating huge distributed algorithms where
 448  *  scalability is really an issue. This function is called in
 449  *  conjunction with surf_workstation_model_init_compound.
 450  *
 451  *  \see surf_workstation_model_init_compound()
 452  */
 453 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
 454
 455 /** \ingroup SURF_models
 456  *  \brief Initializes the platform with the network model CM02
 457  *
 458  *  You sould call this function by yourself only if you plan using
 459  *  surf_workstation_model_init_compound.
 460  *  See comments in the code for more information.
 461  */
 462 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
 463
 464 #ifdef HAVE_GTNETS
 465 /** \ingroup SURF_models
 466  *  \brief Initializes the platform with the network model GTNETS
 467  *  \param filename XML platform file name
 468  *
 469  *  This function is called by surf_workstation_model_init_GTNETS
 470  *  or by yourself only if you plan using surf_workstation_model_init_compound
 471  *
 472  *  \see surf_workstation_model_init_GTNETS()
 473  */
 474 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
 475 #endif
 476
 477 #ifdef HAVE_NS3
 478 /** \ingroup SURF_models
 479  *  \brief Initializes the platform with the network model NS3
 480  *  \param filename XML platform file name
 481  *
 482  *  This function is called by surf_workstation_model_init_NS3
 483  *  or by yourself only if you plan using surf_workstation_model_init_compound
 484  *
 485  *  \see surf_workstation_model_init_NS3()
 486  */
 487 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
 488 #endif
 489
 490 /** \ingroup SURF_models
 491  *  \brief Initializes the platform with the network model Reno
 492  *  \param filename XML platform file name
 493  *
 494  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 495  *
 496  *  Reference:
 497  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
 498  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 499  *
 500  *  Call this function only if you plan using surf_workstation_model_init_compound.
 501  *
 502  */
 503 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
 504
 505 /** \ingroup SURF_models
 506  *  \brief Initializes the platform with the network model Reno2
 507  *  \param filename XML platform file name
 508  *
 509  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 510  *
 511  *  Reference:
 512  *  [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
 513  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 514  *
 515  *  Call this function only if you plan using surf_workstation_model_init_compound.
 516  *
 517  */
 518 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
 519
 520 /** \ingroup SURF_models
 521  *  \brief Initializes the platform with the network model Vegas
 522  *  \param filename XML platform file name
 523  *
 524  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
 525  *  to the proportional fairness.
 526  *
 527  *  Reference:
 528  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
 529  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 530  *
 531  *  Call this function only if you plan using surf_workstation_model_init_compound.
 532  *
 533  */
 534 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
 535
 536 /** \ingroup SURF_models
 537  *  \brief The list of all available network model models
 538  */
 539 XBT_PUBLIC_DATA(s_surf_model_description_t)
 540     surf_network_model_description[];
 541
 542 /** \ingroup SURF_models
 543  *  \brief The storage model
 544  */
 545 XBT_PUBLIC(void) surf_storage_model_init_default(void);
 546
 547 /** \ingroup SURF_models
 548  *  \brief The list of all available storage modes.
 549  *  This storage mode can be set using --cfg=storage/model:...
 550  */
 551 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
 552
 553 /** \ingroup SURF_models
 554  *  \brief The workstation model
 555  *
 556  *  Note that when you create an API on top of SURF,
 557  *  the workstation model should be the only one you use
 558  *  because depending on the platform model, the network model and the CPU model
 559  *  may not exist.
 560  */
 561 XBT_PUBLIC_DATA(surf_workstation_model_t) surf_workstation_model;
 562
 563 /** \ingroup SURF_models
 564  *  \brief Initializes the platform with a compound workstation model
 565  *
 566  *  This function should be called after a cpu_model and a
 567  *  network_model have been set up.
 568  *
 569  */
 570 XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
 571
 572 /** \ingroup SURF_models
 573  *  \brief Initializes the platform with the current best network and cpu models at hand
 574  *
 575  *  This platform model seperates the workstation model and the network model.
 576  *  The workstation model will be initialized with the model compound, the network
 577  *  model with the model LV08 (with cross traffic support) and the CPU model with
 578  *  the model Cas01.
 579  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
 580  *
 581  */
 582 XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
 583
 584 /** \ingroup SURF_models
 585  *  \brief Initializes the platform with the model KCCFLN05
 586  *
 587  *  With this model, only parallel tasks can be used. Resource sharing
 588  *  is done by identifying bottlenecks and giving an equal share of
 589  *  the model to each action.
 590  *
 591  */
 592 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
 593
 594 /** \ingroup SURF_models
 595  *  \brief The list of all available workstation model models
 596  */
 597 XBT_PUBLIC_DATA(s_surf_model_description_t)
 598     surf_workstation_model_description[];
 599
 600 /*******************************************
 601  *  TUTORIAL: New model
 602  */
 603 XBT_PUBLIC(void) surf_new_model_init_default(void);
 604
 605 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_new_model_description[];
 606
 607 /*******************************************/
 608
 609 /** \ingroup SURF_models
 610  *  \brief List of initialized models
 611  */
 612 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
 613
 614 /*******************************************/
 615 /*** SURF Platform *************************/
 616 /*******************************************/
 617 #ifdef __cplusplus
 618 extern "C" {
 619 #endif
 620 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
 621 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
 622 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
 623 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
 624 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
 625 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
 626 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
 627 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
 628 #ifdef __cplusplus
 629 }
 630 #endif
 631
 632 /*******************************************/
 633 /*** SURF Globals **************************/
 634 /*******************************************/
 635
 636 /** \ingroup SURF_simulation
 637  *  \brief Initialize SURF
 638  *  \param argc argument number
 639  *  \param argv arguments
 640  *
 641  *  This function has to be called to initialize the common
 642  *  structures.  Then you will have to create the environment by
 643  *  calling
 644  *  e.g. surf_workstation_model_init_CM02()
 645  *
 646  *  \see surf_workstation_model_init_CM02(), surf_workstation_model_init_compound(), surf_exit()
 647  */
 648 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
 649
 650 /** \ingroup SURF_simulation
 651  *  \brief Finish simulation initialization
 652  *
 653  *  This function must be called before the first call to surf_solve()
 654  */
 655 XBT_PUBLIC(void) surf_presolve(void);
 656
 657 /** \ingroup SURF_simulation
 658  *  \brief Performs a part of the simulation
 659  *  \param max_date Maximum date to update the simulation to, or -1
 660  *  \return the elapsed time, or -1.0 if no event could be executed
 661  *
 662  *  This function execute all possible events, update the action states
 663  *  and returns the time elapsed.
 664  *  When you call execute or communicate on a model, the corresponding actions
 665  *  are not executed immediately but only when you call surf_solve.
 666  *  Note that the returned elapsed time can be zero.
 667  */
 668 XBT_PUBLIC(double) surf_solve(double max_date);
 669
 670 /** \ingroup SURF_simulation
 671  *  \brief Return the current time
 672  *
 673  *  Return the current time in millisecond.
 674  */
 675 XBT_PUBLIC(double) surf_get_clock(void);
 676
 677 /** \ingroup SURF_simulation
 678  *  \brief Exit SURF
 679  *
 680  *  Clean everything.
 681  *
 682  *  \see surf_init()
 683  */
 684 XBT_PUBLIC(void) surf_exit(void);
 685
 686 /* Prototypes of the functions that handle the properties */
 687 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;       /* the prop set for the currently parsed element (also used in SIMIX) */
 688
 689 /* surf parse file related (public because called from a test suite) */
 690 XBT_PUBLIC(void) parse_platform_file(const char *file);
 691
 692 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
 693 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
 694 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
 695 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
 696 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
 697 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
 698 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
 699
 700
 701 XBT_PUBLIC(double) get_cpu_power(const char *power);
 702
 703 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
 704
 705 int surf_get_nthreads(void);
 706 void surf_set_nthreads(int nthreads);
 707
 708 void surf_watched_hosts(void);
 709
 710 /*
 711  * Returns the initial path. On Windows the initial path is
 712  * the current directory for the current process in the other
 713  * case the function returns "./" that represents the current
 714  * directory on Unix/Linux platforms.
 715  */
 716 const char *__surf_get_initial_path(void);
 717
 718 /********** Tracing **********/
 719 /* from surf_instr.c */
 720 void TRACE_surf_action(surf_action_t surf_action, const char *category);
 721 void TRACE_surf_alloc(void);
 722 void TRACE_surf_release(void);
 723
 724 /* instr_routing.c */
 725 void instr_routing_define_callbacks (void);
 726 void instr_new_variable_type (const char *new_typename, const char *color);
 727 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color);
 728 void instr_new_user_state_type (const char *father_type, const char *new_typename);
 729 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
 730 int instr_platform_traced (void);
 731 xbt_graph_t instr_routing_platform_graph (void);
 732 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
 733
 734 SG_END_DECL()
 735 #endif                          /* _SURF_SURF_H */