Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
First step to create model storage.
[simgrid.git] / src / include / surf / surf.h
index 41ebfa0..aff8a88 100644 (file)
 #include "portable.h"
 #include "xbt/config.h"
 #include "surf/datatypes.h"
+#include "xbt/lib.h"
+#include "surf/surf_routing.h"
+#include "simgrid/platf_interface.h"
 
 SG_BEGIN_DECL()
 /* Actions and models are highly connected structures... */
-     typedef enum {
-       SURF_RESOURCE_ON = 1,              /**< Up & ready        */
-       SURF_RESOURCE_OFF = 0              /**< Down & broken     */
-     } e_surf_resource_state_t;
+
+typedef enum {
+  SURF_NETWORK_ELEMENT_NULL = 0,        /* NULL */
+  SURF_NETWORK_ELEMENT_HOST,    /* host type */
+  SURF_NETWORK_ELEMENT_ROUTER,  /* router type */
+  SURF_NETWORK_ELEMENT_AS,      /* AS type */
+} e_surf_network_element_type_t;
+
+XBT_PUBLIC(e_surf_network_element_type_t)
+  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);
@@ -34,24 +43,18 @@ XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
                                    surf_model_t model, int failed);
 
-
-
 /** \brief Resource model description
  */
-     typedef struct surf_model_description {
-       const char *name;
-       const char *description;
-       surf_model_t model;
-       void (*model_init_preparse) (const char *filename);
-       void (*model_init_postparse) (void);
-     } s_surf_model_description_t, *surf_model_description_t;
-
-XBT_PUBLIC(void) update_model_description(s_surf_model_description_t * table,
-                                          const char *name,
-                                          surf_model_t model);
+typedef struct surf_model_description {
+  const char *name;
+  const char *description;
+  void_f_void_t model_init_preparse;
+} s_surf_model_description_t, *surf_model_description_t;
+
 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
                                        const char *name);
-XBT_PUBLIC(void) model_help(const char* category, s_surf_model_description_t * table);
+XBT_PUBLIC(void) model_help(const char *category,
+                            s_surf_model_description_t * table);
 
 /** \brief Action structure
  * \ingroup SURF_actions
@@ -61,28 +64,35 @@ XBT_PUBLIC(void) model_help(const char* category, s_surf_model_description_t * t
  *
  *  \see e_surf_action_state_t
  */
-     typedef struct surf_action {
-       s_xbt_swag_hookup_t state_hookup;
-       xbt_swag_t state_set;
-       double cost;             /**< cost        */
-       double priority;         /**< priority (1.0 by default) */
-       double max_duration;     /**< max_duration (may fluctuate until
+typedef struct surf_action {
+  s_xbt_swag_hookup_t state_hookup;
+  xbt_swag_t state_set;
+  double cost;                  /**< cost        */
+  double priority;              /**< priority (1.0 by default) */
+  double max_duration;          /**< max_duration (may fluctuate until
                                   the task is completed) */
-       double remains;          /**< How much of that cost remains to
+  double remains;               /**< How much of that cost remains to
                                 * be done in the currently running task */
-       double start;            /**< start time  */
-       double finish;           /**< finish time : this is modified during the run
+#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 */
-       void *data;              /**< for your convenience */
-       int refcount;
-       surf_model_t model_type;
-     } s_surf_action_t;
+  void *data;                   /**< for your convenience */
+  int refcount;
+  surf_model_t model_type;
+#ifdef HAVE_TRACING
+  char *category;               /**< tracing category for categorized resource utilization monitoring */
+#endif
+} s_surf_action_t;
 
-     typedef struct surf_action_lmm {
-       s_surf_action_t generic_action;
-       lmm_variable_t variable;
-       int suspended;
-     } s_surf_action_lmm_t, *surf_action_lmm_t;
+typedef struct surf_action_lmm {
+  s_surf_action_t generic_action;
+  lmm_variable_t variable;
+  int suspended;
+} s_surf_action_lmm_t, *surf_action_lmm_t;
 
 /** \brief Action states
  *  \ingroup SURF_actions
@@ -91,15 +101,15 @@ XBT_PUBLIC(void) model_help(const char* category, s_surf_model_description_t * t
  *
  *  \see surf_action_t, surf_action_state_t
  */
-     typedef enum {
-       SURF_ACTION_READY = 0,   /**< Ready        */
-       SURF_ACTION_RUNNING,     /**< Running      */
-       SURF_ACTION_FAILED,      /**< Task Failure */
-       SURF_ACTION_DONE,        /**< Completed    */
-       SURF_ACTION_TO_FREE,     /**< Action to free in next cleanup */
-       SURF_ACTION_NOT_IN_THE_SYSTEM
+typedef enum {
+  SURF_ACTION_READY = 0,        /**< Ready        */
+  SURF_ACTION_RUNNING,          /**< Running      */
+  SURF_ACTION_FAILED,           /**< Task Failure */
+  SURF_ACTION_DONE,             /**< Completed    */
+  SURF_ACTION_TO_FREE,          /**< Action to free in next cleanup */
+  SURF_ACTION_NOT_IN_THE_SYSTEM
                                 /**< Not in the system anymore. Why did you ask ? */
-     } e_surf_action_state_t;
+} e_surf_action_state_t;
 
 /** \brief Action state sets
  *  \ingroup SURF_actions
@@ -109,37 +119,28 @@ XBT_PUBLIC(void) model_help(const char* category, s_surf_model_description_t * t
  *
  *  \see surf_action_t, e_surf_action_state_t
  */
-     typedef struct surf_action_state {
-       xbt_swag_t ready_action_set;
+typedef struct surf_action_state {
+  xbt_swag_t ready_action_set;
                                  /**< Actions in state SURF_ACTION_READY */
-       xbt_swag_t running_action_set;
+  xbt_swag_t running_action_set;
                                  /**< Actions in state SURF_ACTION_RUNNING */
-       xbt_swag_t failed_action_set;
+  xbt_swag_t failed_action_set;
                                  /**< Actions in state SURF_ACTION_FAILED */
-       xbt_swag_t done_action_set;
+  xbt_swag_t done_action_set;
                                  /**< Actions in state SURF_ACTION_DONE */
-     } s_surf_action_state_t, *surf_action_state_t;
+} s_surf_action_state_t, *surf_action_state_t;
 
 /***************************/
 /* Generic model object */
 /***************************/
-     typedef struct s_routing s_routing_t, *routing_t;
-XBT_PUBLIC_DATA(routing_t) used_routing;
+typedef struct s_routing_global s_routing_global_t, *routing_global_t;
+XBT_PUBLIC_DATA(routing_global_t) global_routing;
+
 
 /** \brief Private data available on all models
  *  \ingroup SURF_models
  */
-     typedef struct surf_model_private *surf_model_private_t;
-
-     /** \brief Timer model extension public
-      * \ingroup SURF_model
-      *
-      * Additionnal functions specific to the timer model
-      */
-     typedef struct surf_timer_model_extension_public {
-       void (*set) (double date, void *function, void *arg);
-       int (*get) (void **function, void **arg);
-     } s_surf_model_extension_timer_t;
+typedef struct surf_model_private *surf_model_private_t;
 
      /* Cpu model */
 
@@ -148,13 +149,21 @@ XBT_PUBLIC_DATA(routing_t) used_routing;
       *
       *  Public functions specific to the CPU model.
       */
-     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);
-       double (*get_speed) (void *cpu, double load);
-       double (*get_available_speed) (void *cpu);
-     } s_surf_model_extension_cpu_t;
+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);
+  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 */
 
@@ -163,43 +172,103 @@ XBT_PUBLIC_DATA(routing_t) used_routing;
       *
       *  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, int src, int dst,
-                                    double size, double rate);
-       xbt_dynar_t(*get_route) (int src, int dst);
-       double (*get_link_bandwidth) (const void *link);
-       double (*get_link_latency) (const void *link);
-       int (*link_shared) (const void *link);
-     } s_surf_model_extension_network_t;
+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
+  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
+ *
+ *  Public functions specific to the Storage model.
+ */
+typedef struct surf_storage_model_extension_public {
+  surf_action_t(*open) (void *workstation, const char* path, const char* mode);
+  surf_action_t(*close) (void *workstation, surf_file_t fp);
+  surf_action_t(*read) (void *workstation, void* ptr, size_t size, size_t nmemb, surf_file_t stream);
+  surf_action_t(*write) (void *workstation, const void* ptr, size_t size, size_t nmemb, surf_file_t stream);
+  surf_action_t(*stat) (void *workstation, int fd, void* buf);
+void* (*create_resource) (const char *name);
+} s_surf_model_extension_storage_t;
 
      /** \brief Workstation model extension public
       *  \ingroup SURF_models
       *
       *  Public functions specific to the workstation model.
       */
-     typedef struct surf_workstation_model_extension_public {
-       surf_action_t(*execute) (void *workstation, double size);                           /**< Execute a computation amount on a workstation
+typedef struct surf_workstation_model_extension_public {
+  surf_action_t(*execute) (void *workstation, double size);                                /**< Execute a computation amount on a workstation
                                                                                        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 */
-       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 */
-                                      void *workstation_dst, double size,
-                                      double max_rate);
-         xbt_dynar_t(*get_route) (void *workstation_src, void *workstation_dst);           /**< Get the list of links between two ws */
-
-         surf_action_t(*execute_parallel_task) (int workstation_nb,                        /**< Execute a parallel task on several workstations */
-                                                void **workstation_list,
-                                                double *computation_amount,
-                                                double *communication_amount,
-                                                double amount, 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 */
-       int (*link_shared) (const void *link);
-         xbt_dict_t(*get_properties) (const void *resource);
-     } s_surf_model_extension_workstation_t;
+  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 */
+  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 */
+                                void *workstation_dst, double size,
+                                double max_rate);
+   // FIXME: kill next field, which duplicates the routing
+   xbt_dynar_t(*get_route) (void *workstation_src, void *workstation_dst);                 /**< Get the list of links between two ws */
+
+   surf_action_t(*execute_parallel_task) (int workstation_nb,                              /**< Execute a parallel task on several workstations */
+                                          void **workstation_list,
+                                          double *computation_amount,
+                                          double *communication_amount,
+                                          double amount, 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* path, const char* mode);
+  surf_action_t(*close) (void *workstation, surf_file_t fp);
+  surf_action_t(*read) (void *workstation, void* ptr, size_t size, size_t nmemb, surf_file_t stream);
+  surf_action_t(*write) (void *workstation, const void* ptr, size_t size, size_t nmemb, surf_file_t stream);
+  surf_action_t(*stat) (void *workstation, int fd, void* buf);
+  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);
+
+} s_surf_model_extension_workstation_t;
+
+
+
 
 /** \brief Model datatype
  *  \ingroup SURF_models
@@ -207,91 +276,88 @@ XBT_PUBLIC_DATA(routing_t) used_routing;
  *  Generic data structure for a model. The workstations,
  *  the CPUs and the network links are examples of models.
  */
-     typedef struct surf_model {
-       const char *name;/**< Name of this model */
-       s_surf_action_state_t states; /**< Any living action on this model */
+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_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);
+  void (*action_state_set) (surf_action_t action,
+                            e_surf_action_state_t state);
                                                                   /**< Change an action state*/
 
-       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 */
-       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 */
-       void (*suspend) (surf_action_t action);/**< Suspend an action */
-       void (*resume) (surf_action_t action);/**< Resume a suspended action */
-       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 */
-       double (*get_remains) (surf_action_t action);/**< Get the remains of an action */
-
-       xbt_dict_t resource_set;
-
-
-
-       surf_model_private_t model_private;
-
+  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 */
+  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 */
+  void (*suspend) (surf_action_t action);     /**< Suspend an action */
+  void (*resume) (surf_action_t action);     /**< Resume a suspended action */
+  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 */
+#ifdef HAVE_TRACING
+  void (*set_category) (surf_action_t action, const char *category); /**< Set the category of an action */
+#endif
+  double (*get_remains) (surf_action_t action);     /**< Get the remains of an action */
+#ifdef HAVE_LATENCY_BOUND_TRACKING
+  int (*get_latency_limited) (surf_action_t action);     /**< Return 1 if action is limited by latency, 0 otherwise */
+#endif
 
+  surf_model_private_t model_private;
 
-       union extension {
-         s_surf_model_extension_timer_t timer;
-         s_surf_model_extension_cpu_t cpu;
-         s_surf_model_extension_network_t network;
-         s_surf_model_extension_workstation_t workstation;
-       } extension;
-     } s_surf_model_t;
+  union extension {
+    s_surf_model_extension_cpu_t cpu;
+    s_surf_model_extension_network_t network;
+    s_surf_model_extension_storage_t storage;
+    s_surf_model_extension_workstation_t workstation;
+  } extension;
+} s_surf_model_t;
 
-     surf_model_t surf_model_init(void);
-     void surf_model_exit(surf_model_t model);
+surf_model_t surf_model_init(void);
+void surf_model_exit(surf_model_t model);
 
-     void *surf_model_resource_by_name(surf_model_t model, const char *name);
-#define surf_model_resource_set(model) (model)->resource_set
+static inline void *surf_cpu_resource_by_name(const char *name) {
+       return xbt_lib_get_or_null(host_lib, name, SURF_CPU_LEVEL);
+}
+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);
+}
 
-     typedef struct surf_resource {
-       surf_model_t model;
-       char *name;
-       xbt_dict_t properties;
-     } s_surf_resource_t, *surf_resource_t;
+typedef struct surf_resource {
+  surf_model_t model;
+  char *name;
+  xbt_dict_t properties;
+} s_surf_resource_t, *surf_resource_t;
 
 
 
 /**
  * Resource which have a metric handled by a maxmin system
  */
-     typedef struct {
-       double scale;
-       double peak;
-       tmgr_trace_event_t event;
-     } s_surf_metric_t;
+typedef struct {
+  double scale;
+  double peak;
+  tmgr_trace_event_t event;
+} s_surf_metric_t;
 
-     typedef struct surf_resource_lmm {
-       s_surf_resource_t generic_resource;
-       lmm_constraint_t constraint;
-       e_surf_resource_state_t state_current;
-       tmgr_trace_event_t state_event;
-       s_surf_metric_t power;
-     } s_surf_resource_lmm_t, *surf_resource_lmm_t;
+typedef struct surf_resource_lmm {
+  s_surf_resource_t generic_resource;
+  lmm_constraint_t constraint;
+  e_surf_resource_state_t state_current;
+  tmgr_trace_event_t state_event;
+  s_surf_metric_t power;
+} s_surf_resource_lmm_t, *surf_resource_lmm_t;
 
 /**************************************/
 /* Implementations of model object */
 /**************************************/
 
 
-/** \brief The timer model
- *  \ingroup SURF_models
- */
-XBT_PUBLIC_DATA(surf_model_t) surf_timer_model;
-
-/** \brief Initializes the timer model
- *  \ingroup SURF_models
- */
-XBT_PUBLIC(void) surf_timer_model_init(const char *filename);
-
 /** \brief The CPU model
  *  \ingroup SURF_models
  */
@@ -300,28 +366,41 @@ XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model;
 /** \brief Initializes the CPU model with the model Cas01
  *  \ingroup SURF_models
  *
+ *  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()
  */
-XBT_PUBLIC(void) surf_cpu_model_init_Cas01(const char *filename);
+XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
 
-/** \brief Initializes the CPU model with trace integration
+/** \brief Initializes the CPU model with trace integration [Deprecated]
  *  \ingroup SURF_models
  *
+ *  You shouldn't have to call it by yourself.
+ *  \see surf_workstation_model_init_CLM03()
  */
-XBT_PUBLIC(void) surf_cpu_model_init_ti(const char *filename);
+XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
 
-/** \brief Initializes the CPU model with the model Cas01 Improved. This model uses a heap to order the events, decreasing the time complexity to get the minimum next event.
- *  \ingroup SURF_models
+/** \brief This function call the share resources function needed
  *
- *  This function is called by surf_workstation_model_init_CLM03
- *  so you shouldn't have to call it by yourself.
+ */
+XBT_PUBLIC(double) generic_share_resources(double now);
+
+/** \brief This function call the update action state function needed
  *
- *  \see surf_workstation_model_init_CLM03()
  */
-XBT_PUBLIC(void) surf_cpu_model_init_Cas01_im(const char *filename);
+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
+ *  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
@@ -330,6 +409,11 @@ 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
  *
@@ -342,31 +426,29 @@ XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
 
 /** \brief Same as network model 'LagrangeVelho', only with different correction factors.
  *  \ingroup SURF_models
- *  \param filename XML platform file name
  *
  * 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
  * size (< 1KiB, < 64KiB, >= 64KiB).
+ * See comments in the code for more information.
  *
  *  \see surf_workstation_model_init_SMPI()
  */
-XBT_PUBLIC(void) surf_network_model_init_SMPI(const char *filename);
+XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
 
-/** \brief Initializes the platform with the network model 'LagrangeVelho'
+/** \brief Initializes the platform with the network model 'LegrandVelho'
  *  \ingroup SURF_models
- *  \param filename XML platform file name
  *
  * This model is proposed by Arnaud Legrand and Pedro Velho based on
  * the results obtained with the GTNets simulator for onelink and
- * dogbone sharing scenarios.
+ * dogbone sharing scenarios. See comments in the code for more information.
  *
  *  \see surf_workstation_model_init_LegrandVelho()
  */
-XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(const char *filename);
+XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
 
 /** \brief Initializes the platform with the network model 'Constant'
  *  \ingroup SURF_models
- *  \param filename XML platform file name
  *
  *  In this model, the communication time between two network cards is
  *  constant, hence no need for a routing table. This is particularly
@@ -376,20 +458,25 @@ XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(const char *filename);
  *
  *  \see surf_workstation_model_init_compound()
  */
-XBT_PUBLIC(void) surf_network_model_init_Constant(const char *filename);
-
-XBT_PUBLIC(void) surf_network_model_init_Vivaldi(const char *filename);
+XBT_PUBLIC(void) surf_network_model_init_Constant(void);
 
 /** \brief Initializes the platform with the network model CM02
  *  \ingroup SURF_models
- *  \param filename XML platform file name
  *
  *  This function is called by surf_workstation_model_init_CLM03
  *  or 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(const char *filename);
+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
@@ -401,7 +488,33 @@ XBT_PUBLIC(void) surf_network_model_init_CM02(const char *filename);
  *
  *  \see surf_workstation_model_init_GTNETS()
  */
-XBT_PUBLIC(void) surf_network_model_init_GTNETS(const char *filename);
+XBT_PUBLIC(void) surf_network_model_init_GbTNETS(void);
+#endif
+
+#ifdef HAVE_NS3
+/** \brief Initializes the platform with the network model NS3
+ *  \ingroup SURF_models
+ *  \param filename XML platform file name
+ *
+ *  This function is called by surf_workstation_model_init_NS3
+ *  or by yourself only if you plan using surf_workstation_model_init_compound
+ *
+ *  \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
@@ -417,7 +530,7 @@ XBT_PUBLIC(void) surf_network_model_init_GTNETS(const char *filename);
  *  Call this function only if you plan using surf_workstation_model_init_compound.
  *
  */
-XBT_PUBLIC(void) surf_network_model_init_Reno(const char *filename);
+XBT_PUBLIC(void) surf_network_model_init_Reno(void);
 
 /** \brief Initializes the platform with the network model Reno2
  *  \ingroup SURF_models
@@ -432,7 +545,7 @@ XBT_PUBLIC(void) surf_network_model_init_Reno(const char *filename);
  *  Call this function only if you plan using surf_workstation_model_init_compound.
  *
  */
-XBT_PUBLIC(void) surf_network_model_init_Reno2(const char *filename);
+XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
 
 /** \brief Initializes the platform with the network model Vegas
  *  \ingroup SURF_models
@@ -448,12 +561,13 @@ XBT_PUBLIC(void) surf_network_model_init_Reno2(const char *filename);
  *  Call this function only if you plan using surf_workstation_model_init_compound.
  *
  */
-XBT_PUBLIC(void) surf_network_model_init_Vegas(const char *filename);
+XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
 
 /** \brief The list of all available network model models
  *  \ingroup SURF_models
  */
-XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
+XBT_PUBLIC_DATA(s_surf_model_description_t)
+    surf_network_model_description[];
 
 
 /** \brief The workstation model
@@ -468,57 +582,52 @@ XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model;
 
 /** \brief Initializes the platform with a compound workstation model
  *  \ingroup SURF_models
- *  \param filename XML platform file name
  *
  *  This function should be called after a cpu_model and a
  *  network_model have been set up.
  *
  */
-XBT_PUBLIC(void) surf_workstation_model_init_compound(const char *filename);
+XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
 
-/** \brief Initializes the platform with the workstation model CLM03
+/** \brief Initializes the platform with the current best network and cpu models at hand
  *  \ingroup SURF_models
- *  \param filename XML platform file name
  *
  *  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.
+ *  The workstation model will be initialized with the model compound, the network
+ *  model with the model LV08 (with cross traffic support) and the CPU model with
+ *  the model Cas01.
+ *  Such model is subject to modification with warning in the ChangeLog so monitor it!
  *
- *  \see surf_workstation_model_init_KCCFLN05()
  */
-XBT_PUBLIC(void) surf_workstation_model_init_CLM03(const char *filename);
+XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
 
-/** \brief Initializes the platform with the model KCCFLN05
+/** \brief Initializes the platform with the workstation model CLM03
  *  \ingroup SURF_models
- *  \param filename XML platform file name
  *
- *  With this model, the workstations and the network are handled
- *  together. The network model is roughly the same as in CM02 but
- *  interference between computations and communications can be taken
- *  into account. This platform model is the default one for MSG and
- *  SimDag.
+ *  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_KCCFLN05(const char *filename);
+XBT_PUBLIC(void) surf_workstation_model_init_CLM03(void);
 
 /** \brief Initializes the platform with the model KCCFLN05
  *  \ingroup SURF_models
- *  \param filename XML platform file name
  *
  *  With this model, only parallel tasks can be used. Resource sharing
  *  is done by identifying bottlenecks and giving an equal share of
  *  the model to each action.
  *
  */
-XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(const char *filename);
+XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
 
 /** \brief The list of all available workstation model models
  *  \ingroup SURF_models
  */
 XBT_PUBLIC_DATA(s_surf_model_description_t)
-  surf_workstation_model_description[];
+    surf_workstation_model_description[];
 
 /** \brief List of initialized models
  *  \ingroup SURF_models
@@ -537,30 +646,13 @@ XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set;
  *
  *  This function has to be called to initialize the common
  *  structures.  Then you will have to create the environment by
- *  calling surf_timer_model_init() and
- *  e.g. surf_workstation_model_init_CLM03() or
- *  surf_workstation_model_init_KCCFLN05().
+ *  calling 
+ *  e.g. surf_workstation_model_init_CLM03()
  *
- *  \see surf_timer_model_init(), surf_workstation_model_init_CLM03(),
- *  surf_workstation_model_init_KCCFLN05(), surf_workstation_model_init_compound(), surf_exit()
+ *  \see surf_workstation_model_init_CLM03(), surf_workstation_model_init_compound(), surf_exit()
  */
 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
 
-/** \brief Initialize the used models.
- *
- * Must be called after the surf_init so that configuration infrastructure is created
- * Must be called before parsing/creating the environment
- * Must not be called within the initialization process so that the use get a chance to change the settings from
- * its code between, say, MSG_init and MSG_create_environment using MSG_config
- */
-XBT_PUBLIC(void) surf_config_models_setup(const char *platform_file);
-
-/** \brief create the elements of the models
- *
- * Must be called after parsing the platform file and before using any elements
- */
-XBT_PUBLIC(void) surf_config_models_create_elms(void);
-
 /** \brief Finish simulation initialization
  *  \ingroup SURF_simulation
  *
@@ -570,6 +662,7 @@ XBT_PUBLIC(void) surf_presolve(void);
 
 /** \brief Performs a part of the simulation
  *  \ingroup SURF_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
  *
  *  This function execute all possible events, update the action states
@@ -578,7 +671,7 @@ XBT_PUBLIC(void) surf_presolve(void);
  *  are not executed immediately but only when you call surf_solve.
  *  Note that the returned elapsed time can be zero.
  */
-XBT_PUBLIC(double) surf_solve(void);
+XBT_PUBLIC(double) surf_solve(double max_date);
 
 /** \brief Return the current time
  *  \ingroup SURF_simulation
@@ -598,7 +691,7 @@ 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_DATA(void) parse_properties(void);
+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);
@@ -606,16 +699,6 @@ XBT_PUBLIC(void) parse_platform_file(const char *file);
 /* Stores the sets */
 XBT_PUBLIC_DATA(xbt_dict_t) set_list;
 
-XBT_PUBLIC_DATA(void) manage_route(xbt_dict_t route_table,
-                                   const char *route_name, int action,
-                                   int isMultiRoute);
-XBT_PUBLIC_DATA(int) route_action;
-
-/* This is used by all models when creating the routing table while parsing */
-XBT_PUBLIC_DATA(xbt_dict_t) route_table;
-XBT_PUBLIC_DATA(xbt_dict_t) route_multi_table;
-
-
 /* 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;
@@ -627,12 +710,8 @@ XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
 
 XBT_PUBLIC(double) get_cpu_power(const char *power);
 
-
-/* used to byPass XML ( interact direclty with cpu and  avoid callback ) */
-XBT_PUBLIC(void) surf_cpu_init_im_bypass(char* name,double power);
-
-#include "surf/surf_resource.h"
-#include "surf/surf_resource_lmm.h"
+int surf_get_nthreads(void);
+void surf_set_nthreads(int nthreads);
 
 SG_END_DECL()
-#endif /* _SURF_SURF_H */
+#endif                          /* _SURF_SURF_H */