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