src/include/surf/surf.h

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