src/include/surf/surf.h

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