X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/7bc243d6e8ffba1fe8414c61d27639192198c30f..15badc71ce964f6dae6428c9a4c0198fad5d4936:/src/include/surf/surf.h

diff --git a/src/include/surf/surf.h b/src/include/surf/surf.h
index e3a6d1bebc..cb867e323b 100644
--- a/src/include/surf/surf.h
+++ b/src/include/surf/surf.h
@@ -10,6 +10,7 @@
 #include "xbt/swag.h"
 #include "xbt/dynar.h"
 #include "xbt/dict.h"
+#include "xbt/graph.h"
 #include "xbt/misc.h"
 #include "portable.h"
 #include "xbt/config.h"
@@ -21,6 +22,20 @@
 SG_BEGIN_DECL()
 /* Actions and models are highly connected structures... */
 
+/* user-visible parameters */
+extern double sg_tcp_gamma;
+extern double sg_sender_gap;
+extern double sg_latency_factor;
+extern double sg_bandwidth_factor;
+extern double sg_weight_S_parameter;
+extern int sg_network_crosstraffic;
+#ifdef HAVE_GTNETS
+extern double sg_gtnets_jitter;
+extern int sg_gtnets_jitter_seed;
+#endif
+extern xbt_dynar_t surf_path;
+
+
 typedef enum {
   SURF_NETWORK_ELEMENT_NULL = 0,        /* NULL */
   SURF_NETWORK_ELEMENT_HOST,    /* host type */
@@ -29,10 +44,11 @@ typedef enum {
 } e_surf_network_element_type_t;
 
 XBT_PUBLIC(e_surf_network_element_type_t)
-  routing_get_network_element_type(const char *name);
+  routing_get_network_element_type(const char* name);
 
 /** @Brief Specify that we use that action */
 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
+
 /** @brief Creates a new action.
  *
  * @param size The size is the one of the subtype you want to create
@@ -63,8 +79,15 @@ enum heap_action_type{
   NOTSET
 };
 
-/** \brief Action structure
- * \ingroup SURF_actions
+
+typedef struct surf_resource {
+  surf_model_t model;
+  char *name;
+  xbt_dict_t properties;
+} s_surf_resource_t, *surf_resource_t;
+
+/** \ingroup SURF_actions
+ *  \brief Action structure
  *
  *  Never create s_surf_action_t by yourself ! The actions are created
  *  on the fly when you call execute or communicate on a model.
@@ -76,33 +99,46 @@ typedef struct surf_action {
   xbt_swag_t state_set;
   double cost;                  /**< cost        */
   double priority;              /**< priority (1.0 by default) */
+  double bound;              /**< the capping of the CPU use  */
   double max_duration;          /**< max_duration (may fluctuate until
-				   the task is completed) */
+           the task is completed) */
   double remains;               /**< How much of that cost remains to
-				 * be done in the currently running task */
+         * be done in the currently running task */
 #ifdef HAVE_LATENCY_BOUND_TRACKING
   int latency_limited;               /**< Set to 1 if is limited by latency, 0 otherwise */
 #endif
 
   double start;                 /**< start time  */
   double finish;                /**< finish time : this is modified during the run
-				 * and fluctuates until the task is completed */
+         * and fluctuates until the task is completed */
   void *data;                   /**< for your convenience */
   int refcount;
-  surf_model_t model_type;
+
+  /* The previous name was model_type. For VM support, we have to distinguish a
+   * model type and its model object. Thus, we use model_obj here. The type of
+   * a model object is available by looking at the inside of the model object. */
+  surf_model_t model_obj;       /**< the surf model object */
+
 #ifdef HAVE_TRACING
   char *category;               /**< tracing category for categorized resource utilization monitoring */
 #endif
+  surf_file_t file;        /**< surf_file_t for storage model */
+  xbt_dict_t ls_dict;
 } s_surf_action_t;
 
 typedef struct surf_action_lmm {
   s_surf_action_t generic_action;
   lmm_variable_t variable;
   int suspended;
+  s_xbt_swag_hookup_t action_list_hookup;
+  int index_heap;
+  double last_update;
+  double last_value;
+  enum heap_action_type hat;
 } s_surf_action_lmm_t, *surf_action_lmm_t;
 
-/** \brief Action states
- *  \ingroup SURF_actions
+/** \ingroup SURF_actions
+ *  \brief Action states
  *
  *  Action states.
  *
@@ -118,8 +154,8 @@ typedef enum {
                                 /**< Not in the system anymore. Why did you ask ? */
 } e_surf_action_state_t;
 
-/** \brief Action state sets
- *  \ingroup SURF_actions
+/** \ingroup SURF_actions
+ *  \brief Action state sets
  *
  *  This structure contains some sets of actions.
  *  It provides a fast access to the actions in each state.
@@ -140,19 +176,29 @@ typedef struct surf_action_state {
 /***************************/
 /* Generic model object */
 /***************************/
-typedef struct s_routing_global s_routing_global_t, *routing_global_t;
-XBT_PUBLIC_DATA(routing_global_t) global_routing;
-
+typedef struct s_routing_platf s_routing_platf_t, *routing_platf_t;
+XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
+
+/*******************************************
+ *  TUTORIAL: New model
+ *  New model extension public
+ *  Public functions specific to a New model.
+ */
+typedef struct surf_new_model_extension_public {
+  surf_action_t(*fct) ();
+  void* (*create_resource) ();
+} s_surf_model_extension_new_model_t;
+/*******************************************/
 
-/** \brief Private data available on all models
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief Private data available on all models
  */
 typedef struct surf_model_private *surf_model_private_t;
 
      /* Cpu model */
 
-     /** \brief CPU model extension public
-      *  \ingroup SURF_models
+     /** \ingroup SURF_models
+      *  \brief CPU model extension public
       *
       *  Public functions specific to the CPU model.
       */
@@ -160,80 +206,66 @@ typedef struct surf_cpu_model_extension_public {
   surf_action_t(*execute) (void *cpu, double size);
   surf_action_t(*sleep) (void *cpu, double duration);
   e_surf_resource_state_t(*get_state) (void *cpu);
+  void(*set_state) (void *cpu, e_surf_resource_state_t state);
+
+  int (*get_core) (void *cpu);
   double (*get_speed) (void *cpu, double load);
   double (*get_available_speed) (void *cpu);
-  void* (*create_resource) (const char *name, double power_peak,
-                           double power_scale,
-                           tmgr_trace_t power_trace,
-                           int core,
-                           e_surf_resource_state_t state_initial,
-                           tmgr_trace_t state_trace,
-                           xbt_dict_t cpu_properties);
   void (*add_traces) (void);
 } s_surf_model_extension_cpu_t;
 
      /* Network model */
 
-     /** \brief Network model extension public
-      *  \ingroup SURF_models
+     /** \ingroup SURF_models
+      *  \brief Network model extension public
       *
       *  Public functions specific to the network model
       */
 typedef struct surf_network_model_extension_public {
-  surf_action_t(*communicate) (const char *src_name,
-                               const char *dst_name,
-                               double size, double rate);
-  xbt_dynar_t(*get_route) (const char *src_name, const char *dst_name); //FIXME: kill field? That is done by the routing nowadays
+  surf_action_t (*communicate) (sg_routing_edge_t src,
+                                sg_routing_edge_t dst,
+                                double size, double rate);
+  xbt_dynar_t(*get_route) (void *src, void *dst); //FIXME: kill field? That is done by the routing nowadays
   double (*get_link_bandwidth) (const void *link);
   double (*get_link_latency) (const void *link);
   int (*link_shared) (const void *link);
   void (*add_traces) (void);
-  void* (*create_resource) (const char *name,
-                           double bw_initial,
-                           tmgr_trace_t bw_trace,
-                           double lat_initial,
-                           tmgr_trace_t lat_trace,
-                           e_surf_resource_state_t
-                           state_initial,
-                           tmgr_trace_t state_trace,
-                           e_surf_link_sharing_policy_t policy,
-                           xbt_dict_t properties);
 } s_surf_model_extension_network_t;
 
-typedef struct s_surf_file {
-  char *name;                   /**< @brief host name if any */
-  void *data;                   /**< @brief user data */
-} s_surf_file_t;
-typedef struct s_surf_file *surf_file_t;
-
 /* Storage model */
 
-/** \brief Storage model extension public
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief Storage model extension public
  *
  *  Public functions specific to the Storage model.
  */
 
 typedef struct surf_storage_model_extension_public {
-  surf_action_t(*open) (void *storage, const char* path, const char* mode);
-  surf_action_t(*close) (void *storage, surf_file_t fp);
-  surf_action_t(*read) (void *storage, void* ptr, size_t size, size_t nmemb, surf_file_t stream);
-  surf_action_t(*write) (void *storage, const void* ptr, size_t size, size_t nmemb, surf_file_t stream);
-  surf_action_t(*stat) (void *storage, int fd, void* buf);
-  void* (*create_resource) (const char* id, const char* model,const char* type_id,
-      const char* content, xbt_dict_t storage_properties);
+  surf_action_t(*open) (void *storage, const char* mount, const char* path);
+  surf_action_t(*close) (void *storage, surf_file_t fd);
+  surf_action_t(*read) (void *storage, void* ptr, size_t size,
+                        surf_file_t fd);
+  surf_action_t(*write) (void *storage, const void* ptr, size_t size,
+                         surf_file_t fd);
+  surf_action_t(*stat) (void *storage, surf_file_t fd);
+  surf_action_t(*ls) (void *storage, const char *path);
 } s_surf_model_extension_storage_t;
 
-     /** \brief Workstation model extension public
-      *  \ingroup SURF_models
-      *
-      *  Public functions specific to the workstation model.
-      */
+/** \ingroup SURF_models
+ *  \brief Workstation model extension public
+ *
+ *  Public functions specific to the workstation model.
+ */
 typedef struct surf_workstation_model_extension_public {
+  /* This points to the surf cpu model object bound to the workstation model. */
+  surf_model_t cpu_model;
+
   surf_action_t(*execute) (void *workstation, double size);                                /**< Execute a computation amount on a workstation
-                    									and create the corresponding action */
+                                      and create the corresponding action */
   surf_action_t(*sleep) (void *workstation, double duration);                              /**< Make a workstation sleep during a given duration */
   e_surf_resource_state_t(*get_state) (void *workstation);                                      /**< Return the CPU state of a workstation */
+  void(*set_state) (void *workstation, e_surf_resource_state_t state);
+  int (*get_core) (void *workstation); 
   double (*get_speed) (void *workstation, double load);                                    /**< Return the speed of a workstation */
   double (*get_available_speed) (void *workstation);                                       /**< Return tha available speed of a workstation */
    surf_action_t(*communicate) (void *workstation_src,                                     /**< Execute a communication amount between two workstations */
@@ -246,41 +278,82 @@ typedef struct surf_workstation_model_extension_public {
                                           void **workstation_list,
                                           double *computation_amount,
                                           double *communication_amount,
-                                          double amount, double rate);
+                                          double rate);
   double (*get_link_bandwidth) (const void *link);                                         /**< Return the current bandwidth of a network link */
   double (*get_link_latency) (const void *link);                                           /**< Return the current latency of a network link */
-  surf_action_t(*open) (void *workstation, const char* storage, const char* path, const char* mode);
-  surf_action_t(*close) (void *workstation, const char* storage, surf_file_t fp);
-  surf_action_t(*read) (void *workstation, const char* storage, void* ptr, size_t size, size_t nmemb, surf_file_t stream);
-  surf_action_t(*write) (void *workstation, const char* storage, const void* ptr, size_t size, size_t nmemb, surf_file_t stream);
-  surf_action_t(*stat) (void *workstation, const char* storage, int fd, void* buf);
+  surf_action_t(*open) (void *workstation, const char* storage,
+                        const char* path);
+  surf_action_t(*close) (void *workstation, surf_file_t fd);
+  surf_action_t(*read) (void *workstation, void* ptr, size_t size,
+                        surf_file_t fd);
+  surf_action_t(*write) (void *workstation, const void* ptr, size_t size,
+                         surf_file_t fd);
+  surf_action_t(*stat) (void *workstation, surf_file_t fd);
+  int(*unlink) (void *workstation, surf_file_t fd);
+  surf_action_t(*ls) (void *workstation, const char* mount, const char *path);
+  size_t (*get_size) (void *workstation, surf_file_t fd);
+
   int (*link_shared) (const void *link);
    xbt_dict_t(*get_properties) (const void *resource);
-  void* (*link_create_resource) (const char *name,
-                                double bw_initial,
-                                tmgr_trace_t bw_trace,
-                                double lat_initial,
-                                tmgr_trace_t lat_trace,
-                                e_surf_resource_state_t
-                                state_initial,
-                                tmgr_trace_t state_trace,
-                                e_surf_link_sharing_policy_t
-                                policy, xbt_dict_t properties);
-  void* (*cpu_create_resource) (const char *name, double power_peak,
-                               double power_scale,
-                               tmgr_trace_t power_trace,
-                               e_surf_resource_state_t state_initial,
-                               tmgr_trace_t state_trace,
-                               xbt_dict_t cpu_properties);
   void (*add_traces) (void);
 
+  void (*get_params) (void *ind_vm_ws, ws_params_t param);
+  void (*set_params) (void *ind_vm_ws, ws_params_t param);
+  xbt_dynar_t (*get_vms) (void *ind_vm_ws);
+
 } s_surf_model_extension_workstation_t;
 
+typedef struct surf_vm_workstation_model_extension_public {
+  /* The vm workstation model object has all members of the physical machine
+   * workstation model object. If these members are correctly initialized also
+   * in the vm workstation model object, we can access the vm workstation model
+   * object as if it is the pm workstatoin model object.
+   *
+   * But, it's not so clean. Think it again later.
+   * */
+  s_surf_model_extension_workstation_t basic;
+
+  // start does not appear here as it corresponds to turn the state from created to running (see smx_vm.c)
 
+  void   (*create)  (const char *name, void *ind_phys_workstation); // First operation of the VM model
+  void   (*destroy) (void *ind_vm_ws); // will be vm_ws_destroy(), which destroies the vm-workstation-specific data
 
+  void   (*suspend) (void *ind_vm_ws);
+  void   (*resume)  (void *ind_vm_ws);
 
-/** \brief Model datatype
- *  \ingroup SURF_models
+  void   (*save)    (void *ind_vm_ws);
+  void   (*restore) (void *ind_vm_ws);
+
+  void   (*migrate) (void *ind_vm_ws, void *ind_vm_ws_dest); // will be vm_ws_migrate()
+
+  int    (*get_state) (void *ind_vm_ws);
+  void   (*set_state) (void *ind_vm_ws, int state);
+
+  void * (*get_pm) (void *ind_vm_ws); // will be vm_ws_get_pm()
+
+  void   (*set_vm_bound) (void *ind_vm_ws, double bound); // will be vm_ws_set_vm_bound()
+
+} s_surf_model_extension_vm_workstation_t;
+
+/** \ingroup SURF_models
+ *  \brief Model types
+ *
+ *  The type of the model object. For example, we will have two model objects
+ *  of the surf cpu model. One is for physical machines, and the other is for
+ *  virtual machines.
+ *
+ */
+typedef enum {
+  SURF_MODEL_TYPE_CPU = 0,
+  SURF_MODEL_TYPE_NETWORK,
+  SURF_MODEL_TYPE_STORAGE,
+  SURF_MODEL_TYPE_WORKSTATION,
+  SURF_MODEL_TYPE_VM_WORKSTATION,
+  SURF_MODEL_TYPE_NEW_MODEL
+} e_surf_model_type_t;
+
+/** \ingroup SURF_models
+ *  \brief Model datatype
  *
  *  Generic data structure for a model. The workstations,
  *  the CPUs and the network links are examples of models.
@@ -289,7 +362,9 @@ typedef struct surf_model {
   const char *name;     /**< Name of this model */
   s_surf_action_state_t states;      /**< Any living action on this model */
 
-   e_surf_action_state_t(*action_state_get) (surf_action_t action);
+  e_surf_model_type_t type; /**< See e_surf_model_type_t */
+
+  e_surf_action_state_t(*action_state_get) (surf_action_t action);
                                                                        /**< Return the state of an action */
   void (*action_state_set) (surf_action_t action,
                             e_surf_action_state_t state);
@@ -297,7 +372,7 @@ typedef struct surf_model {
 
   double (*action_get_start_time) (surf_action_t action);     /**< Return the start time of an action */
   double (*action_get_finish_time) (surf_action_t action);     /**< Return the finish time of an action */
-  int (*action_unref) (surf_action_t action);     /**< Specify that we don't use that action anymore */
+  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. */
   void (*action_cancel) (surf_action_t action);     /**< Cancel a running action */
   void (*action_recycle) (surf_action_t action);     /**< Recycle an action */
   void (*action_data_set) (surf_action_t action, void *data);     /**< Set the user data of an action */
@@ -306,6 +381,7 @@ typedef struct surf_model {
   int (*is_suspended) (surf_action_t action);     /**< Return whether an action is suspended */
   void (*set_max_duration) (surf_action_t action, double duration);     /**< Set the max duration of an action*/
   void (*set_priority) (surf_action_t action, double priority);     /**< Set the priority of an action */
+  void (*set_bound) (surf_action_t action, double bound);     /**< Set the bound (the maximum CPU utilization) of an action */
 #ifdef HAVE_TRACING
   void (*set_category) (surf_action_t action, const char *category); /**< Set the category of an action */
 #endif
@@ -314,6 +390,8 @@ typedef struct surf_model {
   int (*get_latency_limited) (surf_action_t action);     /**< Return 1 if action is limited by latency, 0 otherwise */
 #endif
 
+  void (*gap_remove) (surf_action_lmm_t action);
+
   surf_model_private_t model_private;
 
   union extension {
@@ -321,45 +399,46 @@ typedef struct surf_model {
     s_surf_model_extension_network_t network;
     s_surf_model_extension_storage_t storage;
     s_surf_model_extension_workstation_t workstation;
+    // TODO Implement the corresponding model
+    s_surf_model_extension_vm_workstation_t vm_workstation;
+    /*******************************************/
+    /* TUTORIAL: New model                     */
+    s_surf_model_extension_new_model_t new_model;
+    /*******************************************/
   } extension;
 } s_surf_model_t;
 
 surf_model_t surf_model_init(void);
 void surf_model_exit(surf_model_t model);
 
+static inline void *surf_cpu_resource_priv(const void *host) {
+  return xbt_lib_get_level((void *)host, SURF_CPU_LEVEL);
+}
+static inline void *surf_workstation_resource_priv(const void *host){
+  return xbt_lib_get_level((void *)host, SURF_WKS_LEVEL);
+}
+static inline void *surf_storage_resource_priv(const void *host){
+  return xbt_lib_get_level((void *)host, SURF_STORAGE_LEVEL);
+}
+
 static inline void *surf_cpu_resource_by_name(const char *name) {
-	return xbt_lib_get_or_null(host_lib, name, SURF_CPU_LEVEL);
+  return xbt_lib_get_elm_or_null(host_lib, name);
 }
 static inline void *surf_workstation_resource_by_name(const char *name){
-	return xbt_lib_get_or_null(host_lib, name, SURF_WKS_LEVEL);
-}
-static inline void *surf_network_resource_by_name(const char *name){
-	return xbt_lib_get_or_null(link_lib, name, SURF_LINK_LEVEL);
+  return xbt_lib_get_elm_or_null(host_lib, name);
 }
 static inline void *surf_storage_resource_by_name(const char *name){
-    return xbt_lib_get_or_null(storage_lib, name, SURF_STORAGE_LEVEL);
+  return xbt_lib_get_elm_or_null(storage_lib, name);
 }
 
-typedef struct surf_resource {
-  surf_model_t model;
-  char *name;
-  xbt_dict_t properties;
-} s_surf_resource_t, *surf_resource_t;
+static inline surf_model_t surf_resource_model(const void *host, int level) {
+  /* If level is SURF_WKS_LEVEL, ws is a workstation_CLM03 object. It has
+   * surf_resource at the generic_resource field. */
+  surf_resource_t ws = xbt_lib_get_level((void *) host, level);
+  return ws->model;
+}
 
-/**
- * Storage struct
- */
-typedef struct s_storage_type {
-  char *model;
-  char *content;
-  char *type_id;
-  xbt_dict_t properties;
-} s_storage_type_t, *storage_type_t;
 
-typedef struct s_mount {
-  char *id;
-  char *name;
-} s_mount_t, *mount_t;
 
 /**
  * Resource which have a metric handled by a maxmin system
@@ -383,64 +462,53 @@ typedef struct surf_resource_lmm {
 /**************************************/
 
 
-/** \brief The CPU model
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief The CPU model object for the physical machine layer
+ */
+XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model_pm;
+
+/** \ingroup SURF_models
+ *  \brief The CPU model object for the virtual machine layer
  */
-XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model;
+XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model_vm;
 
-/** \brief Initializes the CPU model with the model Cas01
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief Initializes the CPU model with the model Cas01
  *
  *  By default, this model uses the lazy optimization mechanism that
  *  relies on partial invalidation in LMM and a heap for lazy action update.
  *  You can change this behavior by setting the cpu/optim configuration
  *  variable to a different value.
  *
- *  This function is called by surf_workstation_model_init_CLM03
- *  so you shouldn't have to call it by yourself.
- *
- *  \see surf_workstation_model_init_CLM03()
+ *  You shouldn't have to call it by yourself.
  */
 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
 
-/** \brief Initializes the CPU model with trace integration [Deprecated]
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief Initializes the CPU model with trace integration [Deprecated]
  *
  *  You shouldn't have to call it by yourself.
- *  \see surf_workstation_model_init_CLM03()
  */
-XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
+XBT_PUBLIC(surf_model_t) surf_cpu_model_init_ti(void);
 
-/** \brief This function call the share resources function needed
- *
- */
-XBT_PUBLIC(double) generic_share_resources(double now);
-
-/** \brief This function call the update action state function needed
- *
- */
-XBT_PUBLIC(void)   generic_update_actions_state(double now, double delta);
-
-/** \brief The list of all available optimization modes (both for cpu and networks).
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief The list of all available optimization modes (both for cpu and networks).
  *  These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
  */
 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
 
-/** \brief The list of all available cpu model models
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief The list of all available cpu model models
  */
 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
 
-XBT_PUBLIC(void) create_workstations(void);
-
 /**\brief create new host bypass the parser
  *
  */
 
 
-/** \brief The network model
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief The network model
  *
  *  When creating a new API on top on SURF, you shouldn't use the
  *  network model unless you know what you are doing. Only the workstation
@@ -449,8 +517,8 @@ XBT_PUBLIC(void) create_workstations(void);
  */
 XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
 
-/** \brief Same as network model 'LagrangeVelho', only with different correction factors.
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
  *
  * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
  * based on the model 'LV08' and different correction factors depending on the communication
@@ -461,8 +529,8 @@ XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
  */
 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
 
-/** \brief Initializes the platform with the network model 'LegrandVelho'
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief Initializes the platform with the network model 'LegrandVelho'
  *
  * This model is proposed by Arnaud Legrand and Pedro Velho based on
  * the results obtained with the GTNets simulator for onelink and
@@ -472,8 +540,8 @@ XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
  */
 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
 
-/** \brief Initializes the platform with the network model 'Constant'
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief Initializes the platform with the network model 'Constant'
  *
  *  In this model, the communication time between two network cards is
  *  constant, hence no need for a routing table. This is particularly
@@ -485,27 +553,18 @@ XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
  */
 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
 
-/** \brief Initializes the platform with the network model CM02
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief Initializes the platform with the network model CM02
  *
- *  This function is called by surf_workstation_model_init_CLM03
- *  or by yourself only if you plan using surf_workstation_model_init_compound
+ *  You sould call this function by yourself only if you plan using
+ *  surf_workstation_model_init_compound.
  *  See comments in the code for more information.
- *
- *  \see surf_workstation_model_init_CLM03()
  */
 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
 
-/**
- * brief initialize the the network model bypassing the XML parser
- */
-XBT_PUBLIC(void) surf_network_model_init_bypass(const char *id,
-                                                double initial_bw,
-                                                double initial_lat);
-
 #ifdef HAVE_GTNETS
-/** \brief Initializes the platform with the network model GTNETS
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief Initializes the platform with the network model GTNETS
  *  \param filename XML platform file name
  *
  *  This function is called by surf_workstation_model_init_GTNETS
@@ -513,12 +572,12 @@ XBT_PUBLIC(void) surf_network_model_init_bypass(const char *id,
  *
  *  \see surf_workstation_model_init_GTNETS()
  */
-XBT_PUBLIC(void) surf_network_model_init_GbTNETS(void);
+XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
 #endif
 
 #ifdef HAVE_NS3
-/** \brief Initializes the platform with the network model NS3
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief Initializes the platform with the network model NS3
  *  \param filename XML platform file name
  *
  *  This function is called by surf_workstation_model_init_NS3
@@ -527,23 +586,10 @@ XBT_PUBLIC(void) surf_network_model_init_GbTNETS(void);
  *  \see surf_workstation_model_init_NS3()
  */
 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
-
-XBT_PUBLIC(void) parse_ns3_add_host(void);
-XBT_PUBLIC(void) parse_ns3_add_router(void);
-XBT_PUBLIC(void) parse_ns3_add_link(void);
-XBT_PUBLIC(void) parse_ns3_add_AS(void);
-XBT_PUBLIC(void) parse_ns3_add_route(void);
-XBT_PUBLIC(void) parse_ns3_add_ASroute(void);
-XBT_PUBLIC(void) parse_ns3_add_cluster(void);
-XBT_PUBLIC(void) parse_ns3_end_platform(void);
-XBT_PUBLIC(void) create_ns3_topology(void);
-XBT_PUBLIC(double) ns3_get_link_latency(const void *link);
-XBT_PUBLIC(double) ns3_get_link_bandwidth(const void *link);
-
 #endif
 
-/** \brief Initializes the platform with the network model Reno
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief Initializes the platform with the network model Reno
  *  \param filename XML platform file name
  *
  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
@@ -557,8 +603,8 @@ XBT_PUBLIC(double) ns3_get_link_bandwidth(const void *link);
  */
 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
 
-/** \brief Initializes the platform with the network model Reno2
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief Initializes the platform with the network model Reno2
  *  \param filename XML platform file name
  *
  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
@@ -572,8 +618,8 @@ XBT_PUBLIC(void) surf_network_model_init_Reno(void);
  */
 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
 
-/** \brief Initializes the platform with the network model Vegas
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief Initializes the platform with the network model Vegas
  *  \param filename XML platform file name
  *
  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
@@ -588,36 +634,25 @@ XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
  */
 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
 
-/** \brief The list of all available network model models
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief The list of all available network model models
  */
 XBT_PUBLIC_DATA(s_surf_model_description_t)
     surf_network_model_description[];
 
-
-
-
-
-
-/** \brief The storage model
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief The storage model
  */
 XBT_PUBLIC(void) surf_storage_model_init_default(void);
 
-/** \brief The list of all available storage modes.
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief The list of all available storage modes.
  *  This storage mode can be set using --cfg=storage/model:...
  */
 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
 
-
-
-
-
-
-
-/** \brief The workstation model
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief The workstation model
  *
  *  Note that when you create an API on top of SURF,
  *  the workstation model should be the only one you use
@@ -626,8 +661,18 @@ XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
  */
 XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model;
 
-/** \brief Initializes the platform with a compound workstation model
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief The vm_workstation model
+ *
+ *  Note that when you create an API on top of SURF,
+ *  the vm_workstation model should be the only one you use
+ *  because depending on the platform model, the network model and the CPU model
+ *  may not exist.
+ */
+XBT_PUBLIC_DATA(surf_model_t) surf_vm_workstation_model;
+
+/** \ingroup SURF_models
+ *  \brief Initializes the platform with a compound workstation model
  *
  *  This function should be called after a cpu_model and a
  *  network_model have been set up.
@@ -635,8 +680,8 @@ XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model;
  */
 XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
 
-/** \brief Initializes the platform with the current best network and cpu models at hand
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief Initializes the platform with the current best network and cpu models at hand
  *
  *  This platform model seperates the workstation model and the network model.
  *  The workstation model will be initialized with the model compound, the network
@@ -647,20 +692,8 @@ XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
  */
 XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
 
-/** \brief Initializes the platform with the workstation model CLM03
- *  \ingroup SURF_models
- *
- *  This platform model seperates the workstation model and the network model.
- *  The workstation model will be initialized with the model CLM03, the network
- *  model with the model CM02 and the CPU model with the model Cas01.
- *  In future releases, some other network models will be implemented and will be
- *  combined with the workstation model CLM03.
- *
- */
-XBT_PUBLIC(void) surf_workstation_model_init_CLM03(void);
-
-/** \brief Initializes the platform with the model KCCFLN05
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief Initializes the platform with the model KCCFLN05
  *
  *  With this model, only parallel tasks can be used. Resource sharing
  *  is done by identifying bottlenecks and giving an equal share of
@@ -669,45 +702,63 @@ XBT_PUBLIC(void) surf_workstation_model_init_CLM03(void);
  */
 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
 
-/** \brief The list of all available workstation model models
- *  \ingroup SURF_models
+/** \ingroup SURF_models
+ *  \brief The list of all available workstation model models
  */
 XBT_PUBLIC_DATA(s_surf_model_description_t)
     surf_workstation_model_description[];
 
-/** \brief List of initialized models
- *  \ingroup SURF_models
+/*******************************************
+ *  TUTORIAL: New model
+ */
+XBT_PUBLIC(void) surf_new_model_init_default(void);
+XBT_PUBLIC_DATA(s_surf_model_description_t) surf_new_model_description[];
+/*******************************************/
+
+/** \ingroup SURF_models
+ *  \brief List of initialized models
  */
 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
+XBT_PUBLIC_DATA(xbt_dynar_t) model_list_invoke;
+
+/*******************************************/
+/*** SURF Platform *************************/
+/*******************************************/
+typedef struct s_as *AS_t;
+
+XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void); 
+XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
+XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
+XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
+XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
 
 /*******************************************/
 /*** SURF Globals **************************/
 /*******************************************/
-XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set;
 
-/** \brief Initialize SURF
- *  \ingroup SURF_simulation
+/** \ingroup SURF_simulation
+ *  \brief Initialize SURF
  *  \param argc argument number
  *  \param argv arguments
  *
  *  This function has to be called to initialize the common
  *  structures.  Then you will have to create the environment by
  *  calling 
- *  e.g. surf_workstation_model_init_CLM03()
+ *  e.g. surf_workstation_model_init_CM02()
  *
- *  \see surf_workstation_model_init_CLM03(), surf_workstation_model_init_compound(), surf_exit()
+ *  \see surf_workstation_model_init_CM02(), surf_workstation_model_init_compound(), surf_exit()
  */
 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
 
-/** \brief Finish simulation initialization
- *  \ingroup SURF_simulation
+/** \ingroup SURF_simulation
+ *  \brief Finish simulation initialization
  *
  *  This function must be called before the first call to surf_solve()
  */
 XBT_PUBLIC(void) surf_presolve(void);
 
-/** \brief Performs a part of the simulation
- *  \ingroup SURF_simulation
+/** \ingroup SURF_simulation
+ *  \brief Performs a part of the simulation
  *  \param max_date Maximum date to update the simulation to, or -1
  *  \return the elapsed time, or -1.0 if no event could be executed
  *
@@ -719,15 +770,15 @@ XBT_PUBLIC(void) surf_presolve(void);
  */
 XBT_PUBLIC(double) surf_solve(double max_date);
 
-/** \brief Return the current time
- *  \ingroup SURF_simulation
+/** \ingroup SURF_simulation
+ *  \brief Return the current time
  *
  *  Return the current time in millisecond.
  */
 XBT_PUBLIC(double) surf_get_clock(void);
 
-/** \brief Exit SURF
- *  \ingroup SURF_simulation
+/** \ingroup SURF_simulation
+ *  \brief Exit SURF
  *
  *  Clean everything.
  *
@@ -737,14 +788,10 @@ XBT_PUBLIC(void) surf_exit(void);
 
 /* Prototypes of the functions that handle the properties */
 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;       /* the prop set for the currently parsed element (also used in SIMIX) */
-XBT_PUBLIC(void) parse_properties(void);
 
 /* surf parse file related (public because called from a test suite) */
 XBT_PUBLIC(void) parse_platform_file(const char *file);
 
-/* Stores the sets */
-XBT_PUBLIC_DATA(xbt_dict_t) set_list;
-
 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
@@ -756,8 +803,36 @@ XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
 
 XBT_PUBLIC(double) get_cpu_power(const char *power);
 
+XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
+
 int surf_get_nthreads(void);
 void surf_set_nthreads(int nthreads);
 
+void surf_watched_hosts(void);
+
+/*
+ * Returns the initial path. On Windows the initial path is
+ * the current directory for the current process in the other
+ * case the function returns "./" that represents the current
+ * directory on Unix/Linux platforms.
+ */
+const char *__surf_get_initial_path(void);
+
+/********** Tracing **********/
+/* from surf_instr.c */
+void TRACE_surf_action(surf_action_t surf_action, const char *category);
+void TRACE_surf_alloc(void);
+void TRACE_surf_release(void);
+
+/* instr_routing.c */
+void instr_routing_define_callbacks (void);
+void instr_new_variable_type (const char *new_typename, const char *color);
+void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color);
+void instr_new_user_state_type (const char *father_type, const char *new_typename);
+void instr_new_value_for_user_state_type (const char *typename, const char *value, const char *color);
+int instr_platform_traced (void);
+xbt_graph_t instr_routing_platform_graph (void);
+void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
+
 SG_END_DECL()
 #endif                          /* _SURF_SURF_H */