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 NetworkModel;
  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 NetworkModel NetworkModel;
  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 NetworkModel *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 XBT_PUBLIC(char *) surf_routing_edge_name(sg_routing_edge_t edge);
 214 XBT_PUBLIC(void *) surf_as_cluster_get_backbone(AS_t as);
 215 XBT_PUBLIC(void) surf_as_cluster_set_backbone(AS_t as, void* backbone);
 216 XBT_PUBLIC(const char *) surf_model_name(surf_model_t model);
 217 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
 218 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
 219 XBT_PUBLIC(surf_action_t) surf_model_extract_ready_action_set(surf_model_t model);
 220 XBT_PUBLIC(surf_action_t) surf_model_extract_running_action_set(surf_model_t model);
 221 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
 222 XBT_PUBLIC(surf_action_t) surf_workstation_model_execute_parallel_task(surf_workstation_model_t model,
 223                                                     int workstation_nb,
 224                                             void **workstation_list,
 225                                             double *computation_amount,
 226                                             double *communication_amount,
 227                                             double rate);
 228 XBT_PUBLIC(surf_action_t) surf_workstation_model_communicate(surf_workstation_model_t model, surf_resource_t src, surf_resource_t dst, double size, double rate);
 229 XBT_PUBLIC(xbt_dynar_t) surf_workstation_model_get_route(surf_workstation_model_t model, surf_resource_t src, surf_resource_t dst);
 230 XBT_PUBLIC(void) surf_vm_workstation_model_create(const char *name, surf_resource_t ind_phys_host);
 231 XBT_PUBLIC(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);
 232 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
 233 XBT_PUBLIC(xbt_dict_t) surf_resource_get_properties(surf_cpp_resource_t resource);
 234 XBT_PUBLIC(e_surf_resource_state_t) surf_resource_get_state(surf_cpp_resource_t resource);
 235 XBT_PUBLIC(void) surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state);
 236 XBT_PUBLIC(double) surf_workstation_get_speed(surf_resource_t resource, double load);
 237 XBT_PUBLIC(double) surf_workstation_get_available_speed(surf_resource_t resource);
 238 XBT_PUBLIC(int) surf_workstation_get_core(surf_resource_t resource);
 239 XBT_PUBLIC(surf_action_t) surf_workstation_execute(surf_resource_t resource, double size);
 240 XBT_PUBLIC(surf_action_t) surf_workstation_sleep(surf_resource_t resource, double duration);
 241 XBT_PUBLIC(surf_action_t) surf_workstation_open(surf_resource_t workstation, const char* mount, const char* path);
 242 XBT_PUBLIC(surf_action_t) surf_workstation_close(surf_resource_t workstation, surf_file_t fd);
 243 XBT_PUBLIC(surf_action_t) surf_workstation_read(surf_resource_t resource, surf_file_t fd, sg_size_t size);
 244 XBT_PUBLIC(surf_action_t) surf_workstation_write(surf_resource_t resource, surf_file_t fd, sg_size_t size);
 245 XBT_PUBLIC(xbt_dynar_t) surf_workstation_get_info(surf_resource_t resource, surf_file_t fd);
 246 XBT_PUBLIC(sg_size_t) surf_workstation_get_free_size(surf_resource_t resource, const char* name);
 247 XBT_PUBLIC(sg_size_t) surf_workstation_get_used_size(surf_resource_t resource, const char* name);
 248 XBT_PUBLIC(xbt_dynar_t) surf_workstation_get_vms(surf_resource_t resource);
 249 XBT_PUBLIC(void) surf_workstation_get_params(surf_resource_t resource, ws_params_t params);
 250 XBT_PUBLIC(void) surf_workstation_set_params(surf_resource_t resource, ws_params_t params);
 251 XBT_PUBLIC(void) surf_vm_workstation_destroy(surf_resource_t resource);
 252 XBT_PUBLIC(void) surf_vm_workstation_suspend(surf_resource_t resource);
 253 XBT_PUBLIC(void) surf_vm_workstation_resume(surf_resource_t resource);
 254 XBT_PUBLIC(void) surf_vm_workstation_save(surf_resource_t resource);
 255 XBT_PUBLIC(void) surf_vm_workstation_restore(surf_resource_t resource);
 256 XBT_PUBLIC(void) surf_vm_workstation_migrate(surf_resource_t resource, surf_resource_t ind_vm_ws_dest);
 257 XBT_PUBLIC(surf_resource_t) surf_vm_workstation_get_pm(surf_resource_t resource);
 258 XBT_PUBLIC(void) surf_vm_workstation_set_bound(surf_resource_t resource, double bound);
 259 XBT_PUBLIC(void) surf_vm_workstation_set_affinity(surf_resource_t resource, surf_resource_t cpu, unsigned long mask);
 260 XBT_PUBLIC(surf_action_t) surf_cpu_execute(surf_resource_t cpu, double size);
 261 XBT_PUBLIC(surf_action_t) surf_cpu_sleep(surf_resource_t cpu, double duration);
 262 XBT_PUBLIC(double) surf_workstation_get_current_power_peak(surf_resource_t host);
 263 XBT_PUBLIC(double) surf_workstation_get_power_peak_at(surf_resource_t host, int pstate_index);
 264 XBT_PUBLIC(int) surf_workstation_get_nb_pstates(surf_resource_t host);
 265 XBT_PUBLIC(void) surf_workstation_set_power_peak_at(surf_resource_t host, int pstate_index);
 266 XBT_PUBLIC(double) surf_workstation_get_consumed_energy(surf_resource_t host);
 267 XBT_PUBLIC(xbt_dict_t) surf_workstation_get_storage_list(surf_resource_t workstation);
 268 XBT_PUBLIC(int) surf_workstation_unlink(surf_resource_t workstation, surf_file_t fd);
 269 XBT_PUBLIC(surf_action_t) surf_workstation_ls(surf_resource_t workstation, const char* mount, const char *path);
 270 XBT_PUBLIC(size_t) surf_workstation_get_size(surf_resource_t workstation, surf_file_t fd);
 271 XBT_PUBLIC(size_t) surf_workstation_file_tell(surf_resource_t workstation, surf_file_t fd);
 272 XBT_PUBLIC(int) surf_workstation_file_seek(surf_resource_t workstation, surf_file_t fd, sg_size_t offset, int origin);
 273 XBT_PUBLIC(int) surf_network_link_is_shared(surf_cpp_resource_t link);
 274 XBT_PUBLIC(double) surf_network_link_get_bandwidth(surf_cpp_resource_t link);
 275 XBT_PUBLIC(double) surf_network_link_get_latency(surf_cpp_resource_t link);
 276 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
 277 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
 278 XBT_PUBLIC(void) surf_storage_rename(surf_resource_t resource, const char* src, const char* dest);
 279 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
 280 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
 281 XBT_PUBLIC(void) surf_action_unref(surf_action_t action);
 282 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
 283 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
 284 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
 285 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
 286 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
 287 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
 288 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
 289 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
 290 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
 291 XBT_PUBLIC(int) surf_action_get_cost(surf_action_t action);
 292 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask);
 293 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
 294 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
 295 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
 296 XBT_PUBLIC(surf_model_t) surf_resource_model(const void *host, int level);
 297
 298 /**************************************/
 299 /* Implementations of model object */
 300 /**************************************/
 301
 302
 303 /** \ingroup SURF_models
 304  *  \brief The CPU model object for the physical machine layer
 305  */
 306 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
 307
 308 /** \ingroup SURF_models
 309  *  \brief The CPU model object for the virtual machine layer
 310  */
 311 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
 312
 313
 314 /** \ingroup SURF_models
 315  *  \brief Initializes the CPU model with the model Cas01
 316  *
 317  *  By default, this model uses the lazy optimization mechanism that
 318  *  relies on partial invalidation in LMM and a heap for lazy action update.
 319  *  You can change this behavior by setting the cpu/optim configuration
 320  *  variable to a different value.
 321  *
 322  *  You shouldn't have to call it by yourself.
 323  */
 324 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
 325
 326 /** \ingroup SURF_models
 327  *  \brief Initializes the CPU model with trace integration [Deprecated]
 328  *
 329  *  You shouldn't have to call it by yourself.
 330  */
 331 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
 332
 333 /** \ingroup SURF_models
 334  *  \brief The list of all available optimization modes (both for cpu and networks).
 335  *  These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
 336  */
 337 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
 338
 339 /** \ingroup SURF_models
 340  *  \brief The list of all available cpu model models
 341  */
 342 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
 343
 344 /**\brief create new host bypass the parser
 345  *
 346  */
 347
 348
 349 /** \ingroup SURF_models
 350  *  \brief The network model
 351  *
 352  *  When creating a new API on top on SURF, you shouldn't use the
 353  *  network model unless you know what you are doing. Only the workstation
 354  *  model should be accessed because depending on the platform model,
 355  *  the network model can be NULL.
 356  */
 357 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
 358
 359 /** \ingroup SURF_models
 360  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
 361  *
 362  * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
 363  * based on the model 'LV08' and different correction factors depending on the communication
 364  * size (< 1KiB, < 64KiB, >= 64KiB).
 365  * See comments in the code for more information.
 366  *
 367  *  \see surf_workstation_model_init_SMPI()
 368  */
 369 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
 370
 371 /** \ingroup SURF_models
 372  *  \brief Initializes the platform with the network model 'LegrandVelho'
 373  *
 374  * This model is proposed by Arnaud Legrand and Pedro Velho based on
 375  * the results obtained with the GTNets simulator for onelink and
 376  * dogbone sharing scenarios. See comments in the code for more information.
 377  *
 378  *  \see surf_workstation_model_init_LegrandVelho()
 379  */
 380 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
 381
 382 /** \ingroup SURF_models
 383  *  \brief Initializes the platform with the network model 'Constant'
 384  *
 385  *  In this model, the communication time between two network cards is
 386  *  constant, hence no need for a routing table. This is particularly
 387  *  usefull when simulating huge distributed algorithms where
 388  *  scalability is really an issue. This function is called in
 389  *  conjunction with surf_workstation_model_init_compound.
 390  *
 391  *  \see surf_workstation_model_init_compound()
 392  */
 393 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
 394
 395 /** \ingroup SURF_models
 396  *  \brief Initializes the platform with the network model CM02
 397  *
 398  *  You sould call this function by yourself only if you plan using
 399  *  surf_workstation_model_init_compound.
 400  *  See comments in the code for more information.
 401  */
 402 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
 403
 404 #ifdef HAVE_GTNETS
 405 /** \ingroup SURF_models
 406  *  \brief Initializes the platform with the network model GTNETS
 407  *  \param filename XML platform file name
 408  *
 409  *  This function is called by surf_workstation_model_init_GTNETS
 410  *  or by yourself only if you plan using surf_workstation_model_init_compound
 411  *
 412  *  \see surf_workstation_model_init_GTNETS()
 413  */
 414 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
 415 #endif
 416
 417 #ifdef HAVE_NS3
 418 /** \ingroup SURF_models
 419  *  \brief Initializes the platform with the network model NS3
 420  *  \param filename XML platform file name
 421  *
 422  *  This function is called by surf_workstation_model_init_NS3
 423  *  or by yourself only if you plan using surf_workstation_model_init_compound
 424  *
 425  *  \see surf_workstation_model_init_NS3()
 426  */
 427 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
 428 #endif
 429
 430 /** \ingroup SURF_models
 431  *  \brief Initializes the platform with the network model Reno
 432  *  \param filename XML platform file name
 433  *
 434  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 435  *
 436  *  Reference:
 437  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
 438  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 439  *
 440  *  Call this function only if you plan using surf_workstation_model_init_compound.
 441  *
 442  */
 443 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
 444
 445 /** \ingroup SURF_models
 446  *  \brief Initializes the platform with the network model Reno2
 447  *  \param filename XML platform file name
 448  *
 449  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 450  *
 451  *  Reference:
 452  *  [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
 453  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 454  *
 455  *  Call this function only if you plan using surf_workstation_model_init_compound.
 456  *
 457  */
 458 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
 459
 460 /** \ingroup SURF_models
 461  *  \brief Initializes the platform with the network model Vegas
 462  *  \param filename XML platform file name
 463  *
 464  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
 465  *  to the proportional fairness.
 466  *
 467  *  Reference:
 468  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
 469  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 470  *
 471  *  Call this function only if you plan using surf_workstation_model_init_compound.
 472  *
 473  */
 474 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
 475
 476 /** \ingroup SURF_models
 477  *  \brief The list of all available network model models
 478  */
 479 XBT_PUBLIC_DATA(s_surf_model_description_t)
 480     surf_network_model_description[];
 481
 482 /** \ingroup SURF_models
 483  *  \brief The storage model
 484  */
 485 XBT_PUBLIC(void) surf_storage_model_init_default(void);
 486
 487 /** \ingroup SURF_models
 488  *  \brief The list of all available storage modes.
 489  *  This storage mode can be set using --cfg=storage/model:...
 490  */
 491 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
 492
 493 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
 494
 495 /** \ingroup SURF_models
 496  *  \brief The workstation model
 497  *
 498  *  Note that when you create an API on top of SURF,
 499  *  the workstation model should be the only one you use
 500  *  because depending on the platform model, the network model and the CPU model
 501  *  may not exist.
 502  */
 503 XBT_PUBLIC_DATA(surf_workstation_model_t) surf_workstation_model;
 504
 505 /** \ingroup SURF_models
 506  *  \brief The vm_workstation model
 507  *
 508  *  Note that when you create an API on top of SURF,
 509  *  the vm_workstation model should be the only one you use
 510  *  because depending on the platform model, the network model and the CPU model
 511  *  may not exist.
 512  */
 513 XBT_PUBLIC_DATA(surf_vm_workstation_model_t) surf_vm_workstation_model;
 514
 515 /** \ingroup SURF_models
 516  *  \brief Initializes the platform with a compound workstation model
 517  *
 518  *  This function should be called after a cpu_model and a
 519  *  network_model have been set up.
 520  *
 521  */
 522 XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
 523
 524 /** \ingroup SURF_models
 525  *  \brief Initializes the platform with the current best network and cpu models at hand
 526  *
 527  *  This platform model seperates the workstation model and the network model.
 528  *  The workstation model will be initialized with the model compound, the network
 529  *  model with the model LV08 (with cross traffic support) and the CPU model with
 530  *  the model Cas01.
 531  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
 532  *
 533  */
 534 XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
 535
 536 /** \ingroup SURF_models
 537  *  \brief Initializes the platform with the model KCCFLN05
 538  *
 539  *  With this model, only parallel tasks can be used. Resource sharing
 540  *  is done by identifying bottlenecks and giving an equal share of
 541  *  the model to each action.
 542  *
 543  */
 544 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
 545
 546 /** \ingroup SURF_models
 547  *  \brief The list of all available workstation model models
 548  */
 549 XBT_PUBLIC_DATA(s_surf_model_description_t)
 550     surf_workstation_model_description[];
 551
 552 /** \ingroup SURF_models
 553  *  \brief Initializes the platform with the current best network and cpu models at hand
 554  *
 555  *  This platform model seperates the workstation model and the network model.
 556  *  The workstation model will be initialized with the model compound, the network
 557  *  model with the model LV08 (with cross traffic support) and the CPU model with
 558  *  the model Cas01.
 559  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
 560  *
 561  */
 562 XBT_PUBLIC(void) surf_vm_workstation_model_init_current_default(void);
 563
 564 /** \ingroup SURF_models
 565  *  \brief The list of all available vm workstation model models
 566  */
 567 XBT_PUBLIC_DATA(s_surf_model_description_t)
 568     surf_vm_workstation_model_description[];
 569
 570 /*******************************************/
 571
 572 /** \ingroup SURF_models
 573  *  \brief List of initialized models
 574  */
 575 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
 576 XBT_PUBLIC_DATA(xbt_dynar_t) model_list_invoke;
 577
 578 /** \ingroup SURF_simulation
 579  *  \brief List of hosts that have juste restarted and whose autorestart process should be restarted.
 580  */
 581 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
 582
 583 /** \ingroup SURF_simulation
 584  *  \brief List of hosts for which one want to be notified if they ever restart.
 585  */
 586 XBT_PUBLIC(xbt_dict_t) watched_hosts_lib;
 587
 588 /*******************************************/
 589 /*** SURF Platform *************************/
 590 /*******************************************/
 591 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
 592 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
 593 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
 594 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
 595 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
 596 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
 597 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
 598 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
 599
 600 /*******************************************/
 601 /*** SURF Globals **************************/
 602 /*******************************************/
 603
 604 /** \ingroup SURF_simulation
 605  *  \brief Initialize SURF
 606  *  \param argc argument number
 607  *  \param argv arguments
 608  *
 609  *  This function has to be called to initialize the common
 610  *  structures.  Then you will have to create the environment by
 611  *  calling
 612  *  e.g. surf_workstation_model_init_CM02()
 613  *
 614  *  \see surf_workstation_model_init_CM02(), surf_workstation_model_init_compound(), surf_exit()
 615  */
 616 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
 617
 618 /** \ingroup SURF_simulation
 619  *  \brief Finish simulation initialization
 620  *
 621  *  This function must be called before the first call to surf_solve()
 622  */
 623 XBT_PUBLIC(void) surf_presolve(void);
 624
 625 /** \ingroup SURF_simulation
 626  *  \brief Performs a part of the simulation
 627  *  \param max_date Maximum date to update the simulation to, or -1
 628  *  \return the elapsed time, or -1.0 if no event could be executed
 629  *
 630  *  This function execute all possible events, update the action states
 631  *  and returns the time elapsed.
 632  *  When you call execute or communicate on a model, the corresponding actions
 633  *  are not executed immediately but only when you call surf_solve.
 634  *  Note that the returned elapsed time can be zero.
 635  */
 636 XBT_PUBLIC(double) surf_solve(double max_date);
 637
 638 /** \ingroup SURF_simulation
 639  *  \brief Return the current time
 640  *
 641  *  Return the current time in millisecond.
 642  */
 643 XBT_PUBLIC(double) surf_get_clock(void);
 644
 645 /** \ingroup SURF_simulation
 646  *  \brief Exit SURF
 647  *
 648  *  Clean everything.
 649  *
 650  *  \see surf_init()
 651  */
 652 XBT_PUBLIC(void) surf_exit(void);
 653
 654 /* Prototypes of the functions that handle the properties */
 655 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;       /* the prop set for the currently parsed element (also used in SIMIX) */
 656
 657 /* surf parse file related (public because called from a test suite) */
 658 XBT_PUBLIC(void) parse_platform_file(const char *file);
 659
 660 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
 661 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
 662 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
 663 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
 664 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
 665 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
 666 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
 667
 668
 669 XBT_PUBLIC(double) get_cpu_power(const char *power);
 670
 671 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
 672
 673 int surf_get_nthreads(void);
 674 void surf_set_nthreads(int nthreads);
 675
 676 /*
 677  * Returns the initial path. On Windows the initial path is
 678  * the current directory for the current process in the other
 679  * case the function returns "./" that represents the current
 680  * directory on Unix/Linux platforms.
 681  */
 682 const char *__surf_get_initial_path(void);
 683
 684 /********** Tracing **********/
 685 /* from surf_instr.c */
 686 void TRACE_surf_action(surf_action_t surf_action, const char *category);
 687 void TRACE_surf_alloc(void);
 688 void TRACE_surf_release(void);
 689
 690 /* instr_routing.c */
 691 void instr_routing_define_callbacks (void);
 692 void instr_new_variable_type (const char *new_typename, const char *color);
 693 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color);
 694 void instr_new_user_state_type (const char *father_type, const char *new_typename);
 695 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
 696 int instr_platform_traced (void);
 697 xbt_graph_t instr_routing_platform_graph (void);
 698 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
 699
 700 SG_END_DECL()
 701 #endif                          /* _SURF_SURF_H */