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