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