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