Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
fixing lua console (brain dead) damages to the parser
[simgrid.git] / src / include / surf / surf.h
index 541534b..7f48885 100644 (file)
@@ -14,6 +14,8 @@
 #include "portable.h"
 #include "xbt/config.h"
 #include "surf/datatypes.h"
+#include "xbt/lib.h"
+#include "surf/surf_routing.h"
 
 SG_BEGIN_DECL()
 /* Actions and models are highly connected structures... */
@@ -28,6 +30,16 @@ typedef enum {
   SURF_LINK_FATPIPE = 0
 } e_surf_link_sharing_policy_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) 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.
@@ -46,7 +58,7 @@ 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_preparse) (void);
   void (*model_init_postparse) (void);
 } s_surf_model_description_t, *surf_model_description_t;
 
@@ -157,7 +169,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,
@@ -183,7 +195,7 @@ typedef struct surf_network_model_extension_public {
   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,
@@ -221,7 +233,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 +243,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,
@@ -271,17 +283,16 @@ 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 */
+#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
 
-  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;
@@ -292,8 +303,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;
@@ -338,13 +356,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
@@ -354,7 +372,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
@@ -388,7 +406,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
@@ -400,8 +418,21 @@ 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'
+ *  \ingroup SURF_models
+ *  \param filename XML platform file name
+ *
+ * This model is adds the lazy management improvement to Legrand and
+ * Velho model. This improvement essentially replaces the list of actions
+ * inside the simulation kernel by a heap in order to reduce the complexity
+ * at each iteration of the simulation kernel.
+ *
+ *  \see surf_workstation_model_init_LegrandVelho()
+ */
+XBT_PUBLIC(void) im_surf_network_model_init_LegrandVelho(void);
 
 /** \brief Initializes the platform with the network model 'Constant'
  *  \ingroup SURF_models
@@ -415,7 +446,7 @@ XBT_PUBLIC(void) 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
@@ -426,7 +457,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
@@ -445,7 +476,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
@@ -461,7 +518,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
@@ -476,7 +533,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
@@ -492,7 +549,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
@@ -519,8 +576,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
@@ -534,7 +590,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
@@ -547,8 +603,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
@@ -559,8 +614,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
@@ -594,15 +648,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
@@ -634,7 +679,7 @@ XBT_PUBLIC(double) surf_solve(double max_date);
  *
  *  Return the current time in millisecond.
  */
-XBT_PUBLIC(double) surf_get_clock(void);
+XBT_INLINE XBT_PUBLIC(double) surf_get_clock(void);
 
 /** \brief Exit SURF
  *  \ingroup SURF_simulation
@@ -647,7 +692,8 @@ 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_DATA(void) parse_properties(const char* prop_id, const char* prop_value);
+XBT_PUBLIC_DATA(void) parse_properties_XML(void);
 
 /* surf parse file related (public because called from a test suite) */
 XBT_PUBLIC(void) parse_platform_file(const char *file);
@@ -670,7 +716,7 @@ XBT_PUBLIC(double) get_cpu_power(const char *power);
  *
  * see surfxml_parse.c
  * */
-XBT_PUBLIC(void) surf_host_create_resource(char *name, double power_peak,
+XBT_PUBLIC(void*) surf_host_create_resource(char *name, double power_peak,
                                            double power_scale,
                                            tmgr_trace_t power_trace,
                                            int core,
@@ -683,7 +729,7 @@ XBT_PUBLIC(void) surf_host_create_resource(char *name, double power_peak,
  *
  * see surfxml_parse.c
  * */
-XBT_PUBLIC(void) surf_wsL07_host_create_resource(char *name,
+XBT_PUBLIC(void*) surf_wsL07_host_create_resource(char *name,
                                                  double power_peak,
                                                  double power_scale,
                                                  tmgr_trace_t power_trace,
@@ -696,7 +742,7 @@ XBT_PUBLIC(void) surf_wsL07_host_create_resource(char *name,
  * create link resource
  * see surfxml_parse.c
  */
-XBT_PUBLIC(void) surf_link_create_resource(char *name,
+XBT_PUBLIC(void*) surf_link_create_resource(char *name,
                                            double bw_initial,
                                            tmgr_trace_t bw_trace,
                                            double lat_initial,
@@ -708,7 +754,7 @@ XBT_PUBLIC(void) surf_link_create_resource(char *name,
                                            policy, xbt_dict_t properties);
 
 
-XBT_PUBLIC(void) surf_wsL07_link_create_resource(char *name,
+XBT_PUBLIC(void*) surf_wsL07_link_create_resource(char *name,
                                                  double bw_initial,
                                                  tmgr_trace_t bw_trace,
                                                  double lat_initial,
@@ -763,8 +809,6 @@ XBT_PUBLIC(void) routing_store_route(void);
  * interface between surf and lua bindings
  * see surfxml_parse.c
  */
-XBT_PUBLIC(void) surf_AS_new(const char *id, const char *mode);
-XBT_PUBLIC(void) surf_AS_finalize(const char *id);
 XBT_PUBLIC(void) surf_route_add_host(const char *id);
 XBT_PUBLIC(void) surf_routing_add_route(const char *src_id,
                                         const char *dest_id,