src/include/surf/surf.h

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