src/include/surf/surf.h

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