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