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