Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
populate the routing_none_finalize to make sure that we always call these functions
[simgrid.git] / src / surf / surf_routing.c
index 101626c..35e71ac 100644 (file)
@@ -32,13 +32,11 @@ int ROUTING_ASR_LEVEL;          //Routing level
 int COORD_ASR_LEVEL;            //Coordinates level
 int NS3_ASR_LEVEL;              //host node for ns3
 
-static xbt_dict_t patterns = NULL;
 static xbt_dict_t random_value = NULL;
 
 /* Global vars */
 routing_global_t global_routing = NULL;
-routing_component_t current_routing = NULL;
-routing_model_description_t current_routing_model = NULL;
+AS_t current_routing = NULL;
 
 /* global parse functions */
 xbt_dynar_t link_list = NULL;   /* temporary store of current list link of a route */
@@ -294,7 +292,7 @@ static void routing_parse_E_bypassRoute(void)
  */
 void routing_AS_begin(const char *AS_id, const char *wanted_routing_type)
 {
-  routing_component_t new_routing;
+  AS_t new_as;
   routing_model_description_t model = NULL;
   int cpt;
 
@@ -313,17 +311,16 @@ void routing_AS_begin(const char *AS_id, const char *wanted_routing_type)
   }
 
   /* make a new routing component */
-  new_routing = (routing_component_t) (*(model->create)) ();
-  new_routing->routing = model;
-  new_routing->hierarchy = SURF_ROUTING_NULL;
-  new_routing->name = xbt_strdup(AS_id);
-  new_routing->routing_sons = xbt_dict_new();
+  new_as = (AS_t) (*(model->create)) ();
+  new_as->model_desc = model;
+  new_as->hierarchy = SURF_ROUTING_NULL;
+  new_as->name = xbt_strdup(AS_id);
 
   if (current_routing == NULL && global_routing->root == NULL) {
 
     /* it is the first one */
-    new_routing->routing_father = NULL;
-    global_routing->root = new_routing;
+    new_as->routing_father = NULL;
+    global_routing->root = new_as;
 
   } else if (current_routing != NULL && global_routing->root != NULL) {
 
@@ -331,20 +328,20 @@ void routing_AS_begin(const char *AS_id, const char *wanted_routing_type)
                (current_routing->routing_sons, AS_id),
                "The AS \"%s\" already exists", AS_id);
     /* it is a part of the tree */
-    new_routing->routing_father = current_routing;
+    new_as->routing_father = current_routing;
     /* set the father behavior */
     if (current_routing->hierarchy == SURF_ROUTING_NULL)
       current_routing->hierarchy = SURF_ROUTING_RECURSIVE;
     /* add to the sons dictionary */
     xbt_dict_set(current_routing->routing_sons, AS_id,
-                 (void *) new_routing, NULL);
+                 (void *) new_as, NULL);
     /* add to the father element list */
     (*(current_routing->parse_AS)) (current_routing, AS_id);
   } else {
     THROWF(arg_error, 0, "All defined components must be belong to a AS");
   }
   /* set the new current component of the tree */
-  current_routing = new_routing;
+  current_routing = new_as;
 }
 
 /**
@@ -374,32 +371,14 @@ void routing_AS_end()
     xbt_lib_set(as_router_lib, current_routing->name, ROUTING_ASR_LEVEL,
                 (void *) info);
 
-    if (current_routing->routing->end)
-      (*(current_routing->routing->end)) ();
+    if (current_routing->model_desc->end)
+      (*(current_routing->model_desc->end)) (current_routing);
     current_routing = current_routing->routing_father;
   }
 }
 
 /* Aux Business methods */
 
-/**
- * \brief Get the AS name of the element
- *
- * \param name the host name
- *
- */
-static char *elements_As_name(const char *name)
-{
-  routing_component_t as_comp;
-
-  /* (1) find the as where the host is located */
-  as_comp = ((network_element_info_t)
-             xbt_lib_get_or_null(host_lib, name,
-                                 ROUTING_HOST_LEVEL))->rc_component;
-  return as_comp->name;
-}
-
-
 /**
  * \brief Get the AS father and the first elements of the chain
  *
@@ -410,21 +389,21 @@ static char *elements_As_name(const char *name)
  * father in the chain
  */
 static void elements_father(const char *src, const char *dst,
-                            routing_component_t * res_father,
-                            routing_component_t * res_src,
-                            routing_component_t * res_dst)
+                            AS_t * res_father,
+                            AS_t * res_src,
+                            AS_t * res_dst)
 {
   xbt_assert(src && dst, "bad parameters for \"elements_father\" method");
 #define ELEMENTS_FATHER_MAXDEPTH 16     /* increase if it is not enough */
-  routing_component_t src_as, dst_as;
-  routing_component_t path_src[ELEMENTS_FATHER_MAXDEPTH];
-  routing_component_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
+  AS_t src_as, dst_as;
+  AS_t path_src[ELEMENTS_FATHER_MAXDEPTH];
+  AS_t path_dst[ELEMENTS_FATHER_MAXDEPTH];
   int index_src = 0;
   int index_dst = 0;
-  routing_component_t current;
-  routing_component_t current_src;
-  routing_component_t current_dst;
-  routing_component_t father;
+  AS_t current;
+  AS_t current_src;
+  AS_t current_dst;
+  AS_t father;
 
   /* (1) find the as where the src and dst are located */
   network_element_info_t src_data = xbt_lib_get_or_null(host_lib, src,
@@ -492,9 +471,9 @@ static void _get_route_latency(const char *src, const char *dst,
   XBT_DEBUG("Solve route/latency  \"%s\" to \"%s\"", src, dst);
   xbt_assert(src && dst, "bad parameters for \"_get_route_latency\" method");
 
-  routing_component_t common_father;
-  routing_component_t src_father;
-  routing_component_t dst_father;
+  AS_t common_father;
+  AS_t src_father;
+  AS_t dst_father;
   elements_father(src, dst, &common_father, &src_father, &dst_father);
 
   if (src_father == dst_father) {       /* SURF_ROUTING_BASE */
@@ -614,18 +593,20 @@ static void _get_route_latency(const char *src, const char *dst,
 static void get_route_latency(const char *src, const char *dst,
                               xbt_dynar_t * route, double *latency, int cleanup)
 {
+  static xbt_dynar_t last_route = NULL;
+
   _get_route_latency(src, dst, route, latency);
   xbt_assert(!route || *route, "no route between \"%s\" and \"%s\"", src, dst);
   xbt_assert(!latency || *latency >= 0.0,
              "latency error on route between \"%s\" and \"%s\"", src, dst);
   if (route) {
-    xbt_dynar_free(&global_routing->last_route);
-    global_routing->last_route = cleanup ? *route : NULL;
+    xbt_dynar_free(&last_route);
+    last_route = cleanup ? *route : NULL;
   }
 }
 
 /**
- * \brief Generic method: find a route between hosts
+ * \brief Find a route between hosts
  *
  * \param src the source host name 
  * \param dst the destination host name
@@ -634,34 +615,12 @@ static void get_route_latency(const char *src, const char *dst,
  * by calling the differents "get_route" functions in each routing component.
  * No need to free the returned dynar. It will be freed at the next call.
  */
-static xbt_dynar_t get_route(const char *src, const char *dst)
-{
+xbt_dynar_t routing_get_route(const char *src, const char *dst) {
   xbt_dynar_t route = NULL;
   get_route_latency(src, dst, &route, NULL, 1);
   return route;
 }
 
-/**
- * \brief Generic method: find a route between hosts
- *
- * \param src the source host name
- * \param dst the destination host name
- *
- * same as get_route, but return NULL if any exception is raised.
- */
-static xbt_dynar_t get_route_or_null(const char *src, const char *dst)
-{
-  xbt_dynar_t route = NULL;
-  xbt_ex_t exception;
-  TRY {
-    get_route_latency(src, dst, &route, NULL, 1);
-  } CATCH(exception) {
-    xbt_ex_free(exception);
-    return NULL;
-  }
-  return route;
-}
-
 /**
  * \brief Generic method: find a route between hosts
  *
@@ -679,58 +638,7 @@ static xbt_dynar_t get_route_no_cleanup(const char *src, const char *dst)
   return route;
 }
 
-/*Get Latency*/
-static double get_latency(const char *src, const char *dst)
-{
-  double latency = -1.0;
-  get_route_latency(src, dst, NULL, &latency, 0);
-  return latency;
-}
-
-/**
- * \brief Recursive function for finalize
- *
- * \param rc the source host name 
- * 
- * This fuction is call by "finalize". It allow to finalize the 
- * AS or routing components. It delete all the structures.
- */
-static void _finalize(routing_component_t rc)
-{
-  if (rc) {
-    xbt_dict_cursor_t cursor = NULL;
-    char *key;
-    routing_component_t elem;
-    xbt_dict_foreach(rc->routing_sons, cursor, key, elem) {
-      _finalize(elem);
-    }
-    xbt_dict_t tmp_sons = rc->routing_sons;
-    char *tmp_name = rc->name;
-    xbt_dict_free(&tmp_sons);
-    xbt_free(tmp_name);
-    xbt_assert(rc->finalize, "no defined method \"finalize\" in \"%s\"",
-               current_routing->name);
-    (*(rc->finalize)) (rc);
-  }
-}
-
-/**
- * \brief Generic method: delete all the routing structures
- * 
- * walk through the routing components tree and delete the structures
- * by calling the different "finalize" functions in each routing component
- */
-static void finalize(void)
-{
-  /* delete recursively all the tree */
-  _finalize(global_routing->root);
-  /* delete last_route */
-  xbt_dynar_free(&(global_routing->last_route));
-  /* delete global routing structure */
-  xbt_free(global_routing);
-}
-
-static xbt_dynar_t recursive_get_onelink_routes(routing_component_t rc)
+static xbt_dynar_t recursive_get_onelink_routes(AS_t rc)
 {
   xbt_dynar_t ret = xbt_dynar_new(sizeof(onelink_t), xbt_free);
 
@@ -746,7 +654,7 @@ static xbt_dynar_t recursive_get_onelink_routes(routing_component_t rc)
   //recursing
   char *key;
   xbt_dict_cursor_t cursor = NULL;
-  routing_component_t rc_child;
+  AS_t rc_child;
   xbt_dict_foreach(rc->routing_sons, cursor, key, rc_child) {
     xbt_dynar_t onelink_child = recursive_get_onelink_routes(rc_child);
     if (onelink_child) {
@@ -763,7 +671,7 @@ static xbt_dynar_t get_onelink_routes(void)
   return recursive_get_onelink_routes(global_routing->root);
 }
 
-e_surf_network_element_type_t get_network_element_type(const char *name)
+e_surf_network_element_type_t routing_get_network_element_type(const char *name)
 {
   network_element_info_t rc = NULL;
 
@@ -788,17 +696,11 @@ void routing_model_create(size_t size_of_links, void *loopback)
   /* config the uniq global routing */
   global_routing = xbt_new0(s_routing_global_t, 1);
   global_routing->root = NULL;
-  global_routing->get_route = get_route;
-  global_routing->get_route_or_null = get_route_or_null;
-  global_routing->get_latency = get_latency;
   global_routing->get_route_no_cleanup = get_route_no_cleanup;
   global_routing->get_onelink_routes = get_onelink_routes;
   global_routing->get_route_latency = get_route_latency;
-  global_routing->get_network_element_type = get_network_element_type;
-  global_routing->finalize = finalize;
   global_routing->loopback = loopback;
   global_routing->size_of_link = size_of_links;
-  global_routing->last_route = NULL;
   /* no current routing at moment */
   current_routing = NULL;
 }
@@ -854,14 +756,14 @@ void routing_model_create(size_t size_of_links, void *loopback)
 static void routing_parse_cluster(void)
 {
   char *host_id, *groups, *link_id = NULL;
+  xbt_dict_t patterns = NULL;
 
   s_sg_platf_host_cbarg_t host;
   s_sg_platf_link_cbarg_t link;
 
   if (strcmp(struct_cluster->availability_trace, "")
       || strcmp(struct_cluster->state_trace, "")) {
-    if (xbt_dict_size(patterns) == 0)
-      patterns = xbt_dict_new();
+    patterns = xbt_dict_new();
     xbt_dict_set(patterns, "id", xbt_strdup(struct_cluster->id), free);
     xbt_dict_set(patterns, "prefix", xbt_strdup(struct_cluster->prefix), free);
     xbt_dict_set(patterns, "suffix", xbt_strdup(struct_cluster->suffix), free);
@@ -905,8 +807,7 @@ static void routing_parse_cluster(void)
       if (strcmp(struct_cluster->availability_trace, "")) {
         xbt_dict_set(patterns, "radical", bprintf("%d", i), xbt_free);
         char *tmp_availability_file =
-            xbt_strdup(struct_cluster->availability_trace);
-        xbt_str_varsubst(tmp_availability_file, patterns);
+            xbt_str_varsubst(struct_cluster->availability_trace, patterns);
         XBT_DEBUG("\tavailability_file=\"%s\"", tmp_availability_file);
         host.power_trace = tmgr_trace_new(tmp_availability_file);
         xbt_free(tmp_availability_file);
@@ -914,8 +815,8 @@ static void routing_parse_cluster(void)
         XBT_DEBUG("\tavailability_file=\"\"");
       }
       if (strcmp(struct_cluster->state_trace, "")) {
-        char *tmp_state_file = xbt_strdup(struct_cluster->state_trace);
-        xbt_str_varsubst(tmp_state_file, patterns);
+        char *tmp_state_file =
+            xbt_str_varsubst(struct_cluster->state_trace, patterns);
         XBT_DEBUG("\tstate_file=\"%s\"", tmp_state_file);
         host.state_trace = tmgr_trace_new(tmp_state_file);
         xbt_free(tmp_state_file);
@@ -1052,43 +953,14 @@ static void routing_parse_cluster(void)
   xbt_dynar_free(&radical_elements);
   xbt_free(new_suffix);
 
-  if (strcmp(struct_cluster->availability_trace, "")
-      || strcmp(struct_cluster->state_trace, ""))
-    xbt_dict_free(&patterns);
-
   XBT_DEBUG("</AS>");
   sg_platf_new_AS_end();
   XBT_DEBUG(" ");
+  xbt_dict_free(&patterns); // no op if it were never set
 }
 
-/*
- * This function take a string and replace parameters from patterns dict.
- * It returns the new value.
- */
-static char *replace_random_parameter(char *string)
-{
-  char *test_string = NULL;
-
-  if (xbt_dict_size(random_value) == 0)
-    return string;
-
-  string = xbt_str_varsubst(string, patterns);  // for patterns of cluster
-  test_string = bprintf("${%s}", string);
-  test_string = xbt_str_varsubst(test_string, random_value);    //Add ${xxxxx} for random Generator
-
-  if (strcmp(test_string, "")) {        //if not empty, keep this value.
-    xbt_free(string);
-    string = test_string;
-  }                             //In other case take old value (without ${})
-  else
-    free(test_string);
-  return string;
-}
-
-static void routing_parse_postparse(void)
-{
+static void routing_parse_postparse(void) {
   xbt_dict_free(&random_value);
-  xbt_dict_free(&patterns);
 }
 
 static void routing_parse_peer(sg_platf_peer_cbarg_t peer)
@@ -1335,3 +1207,31 @@ void routing_register_callbacks()
   instr_routing_define_callbacks();
 #endif
 }
+
+/**
+ * \brief Recursive function for finalize
+ *
+ * \param rc the source host name
+ *
+ * This fuction is call by "finalize". It allow to finalize the
+ * AS or routing components. It delete all the structures.
+ */
+static void finalize_rec(AS_t as) {
+  xbt_dict_cursor_t cursor = NULL;
+  char *key;
+  AS_t elem;
+
+  xbt_dict_foreach(as->routing_sons, cursor, key, elem) {
+    finalize_rec(elem);
+  }
+
+  as->finalize(as);
+}
+
+/** \brief Frees all memory allocated by the routing module */
+void routing_exit(void) {
+  if (!global_routing)
+    return;
+  finalize_rec(global_routing->root);
+  xbt_free(global_routing);
+}