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