Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
kill the now useless 'cleanup' parameter of routing_get_route_and_latency
[simgrid.git] / src / include / surf / surf.h
index 1281eb6..fe9b4f3 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_LINK_FULLDUPLEX = 2,
-  SURF_LINK_SHARED = 1,
-  SURF_LINK_FATPIPE = 0
-} e_surf_link_sharing_policy_t;
+  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);
@@ -45,14 +48,9 @@ XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
 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);
+  void_f_void_t model_init_preparse;
 } 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);
 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
                                        const char *name);
 XBT_PUBLIC(void) model_help(const char *category,
@@ -157,7 +155,7 @@ typedef struct surf_cpu_model_extension_public {
   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) (char *name, double power_peak,
+  void* (*create_resource) (const char *name, double power_peak,
                            double power_scale,
                            tmgr_trace_t power_trace,
                            int core,
@@ -178,12 +176,12 @@ 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);
+  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) (char *name,
+  void* (*create_resource) (const char *name,
                            double bw_initial,
                            tmgr_trace_t bw_trace,
                            double lat_initial,
@@ -210,6 +208,7 @@ typedef struct surf_workstation_model_extension_public {
    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 */
@@ -221,7 +220,7 @@ typedef struct surf_workstation_model_extension_public {
   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);
-  void (*link_create_resource) (char *name,
+  void* (*link_create_resource) (const char *name,
                                 double bw_initial,
                                 tmgr_trace_t bw_trace,
                                 double lat_initial,
@@ -231,7 +230,7 @@ typedef struct surf_workstation_model_extension_public {
                                 tmgr_trace_t state_trace,
                                 e_surf_link_sharing_policy_t
                                 policy, xbt_dict_t properties);
-  void (*cpu_create_resource) (char *name, double power_peak,
+  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,
@@ -279,12 +278,8 @@ typedef struct surf_model {
   int (*get_latency_limited) (surf_action_t action);     /**< Return 1 if action is limited by latency, 0 otherwise */
 #endif
 
-  xbt_dict_t resource_set;
-
-
   surf_model_private_t model_private;
 
-
   union extension {
     s_surf_model_extension_cpu_t cpu;
     s_surf_model_extension_network_t network;
@@ -295,8 +290,15 @@ typedef struct surf_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;
@@ -341,13 +343,13 @@ XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model;
  *
  *  \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
  *  \ingroup SURF_models
  *
  */
-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
@@ -357,7 +359,7 @@ XBT_PUBLIC(void) surf_cpu_model_init_ti(const char *filename);
  *
  *  \see surf_workstation_model_init_CLM03()
  */
-XBT_PUBLIC(void) surf_cpu_model_init_Cas01_im(const char *filename);
+XBT_PUBLIC(void) surf_cpu_model_init_Cas01_im(void);
 
 /** \brief The list of all available cpu model models
  *  \ingroup SURF_models
@@ -391,7 +393,7 @@ XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
  *
  *  \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'
  *  \ingroup SURF_models
@@ -403,8 +405,7 @@ XBT_PUBLIC(void) surf_network_model_init_SMPI(const char *filename);
  *
  *  \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 'LV08_im'
@@ -418,8 +419,7 @@ XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(const char
  *
  *  \see surf_workstation_model_init_LegrandVelho()
  */
-XBT_PUBLIC(void) im_surf_network_model_init_LegrandVelho(const char
-                                                      *filename);
+XBT_PUBLIC(void) im_surf_network_model_init_LegrandVelho(void);
 
 /** \brief Initializes the platform with the network model 'Constant'
  *  \ingroup SURF_models
@@ -433,7 +433,7 @@ XBT_PUBLIC(void) im_surf_network_model_init_LegrandVelho(const char
  *
  *  \see surf_workstation_model_init_compound()
  */
-XBT_PUBLIC(void) surf_network_model_init_Constant(const char *filename);
+XBT_PUBLIC(void) surf_network_model_init_Constant(void);
 
 /** \brief Initializes the platform with the network model CM02
  *  \ingroup SURF_models
@@ -444,7 +444,7 @@ XBT_PUBLIC(void) surf_network_model_init_Constant(const char *filename);
  *
  *  \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
@@ -463,7 +463,33 @@ XBT_PUBLIC(void) surf_network_model_init_bypass(const char *id,
  *
  *  \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
@@ -479,7 +505,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
@@ -494,7 +520,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
@@ -510,7 +536,7 @@ 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
@@ -537,8 +563,7 @@ XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model;
  *  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
  *  \ingroup SURF_models
@@ -552,7 +577,7 @@ XBT_PUBLIC(void) surf_workstation_model_init_compound(const char
  *
  *  \see surf_workstation_model_init_KCCFLN05()
  */
-XBT_PUBLIC(void) surf_workstation_model_init_CLM03(const char *filename);
+XBT_PUBLIC(void) surf_workstation_model_init_CLM03(void);
 
 /** \brief Initializes the platform with the model KCCFLN05
  *  \ingroup SURF_models
@@ -565,8 +590,7 @@ XBT_PUBLIC(void) surf_workstation_model_init_CLM03(const char *filename);
  *  SimDag.
  *
  */
-XBT_PUBLIC(void) surf_workstation_model_init_KCCFLN05(const char
-                                                      *filename);
+XBT_PUBLIC(void) surf_workstation_model_init_KCCFLN05(void);
 
 /** \brief Initializes the platform with the model KCCFLN05
  *  \ingroup SURF_models
@@ -577,8 +601,7 @@ XBT_PUBLIC(void) surf_workstation_model_init_KCCFLN05(const char
  *  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
@@ -612,21 +635,6 @@ XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set;
  */
 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
  *
@@ -665,7 +673,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);
@@ -684,86 +692,5 @@ XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
 
 XBT_PUBLIC(double) get_cpu_power(const char *power);
 
-/*public interface to create resource bypassing the parser via cpu/network model
- *
- * see surfxml_parse.c
- * */
-XBT_PUBLIC(void) surf_host_create_resource(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);
-
-/*public interface to create resource bypassing the parser via workstation_ptask_L07 model
- *
- * see surfxml_parse.c
- * */
-XBT_PUBLIC(void) surf_wsL07_host_create_resource(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);
-/**
- * create link resource
- * see surfxml_parse.c
- */
-XBT_PUBLIC(void) surf_link_create_resource(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);
-
-
-XBT_PUBLIC(void) surf_wsL07_link_create_resource(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);
-/**
- * add route element (link_ctn) bypassing the parser
- *
- * see surfxml_parse.c
- *
- */
-XBT_PUBLIC(void) surf_add_route_element(char *link_ctn_id);
-
-/**
- * set route src_id,dest_id, and create a route resource
- *
- * see surf_routing.c && surfxml_parse.c
- */
-
-XBT_PUBLIC(void) surf_set_routes(void);
-
-
-/**
- * add traces
- * see surfxml_parse.c
- */
-XBT_PUBLIC(void) surf_add_host_traces(void);
-XBT_PUBLIC(void) surf_add_link_traces(void);
-XBT_PUBLIC(void) surf_wsL07_add_traces(void);
-
-#include "surf/surf_resource.h"
-#include "surf/surf_resource_lmm.h"
-
 SG_END_DECL()
 #endif                          /* _SURF_SURF_H */