Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
give a network_model to each NetZone (unused for now)
[simgrid.git] / src / kernel / routing / DijkstraZone.cpp
index f987ae3..37cd82d 100644 (file)
-/* Copyright (c) 2009-2016. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2009-2018. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include "src/kernel/routing/DijkstraZone.hpp"
-#include "src/kernel/routing/NetPoint.hpp"
+#include "simgrid/kernel/routing/DijkstraZone.hpp"
+#include "simgrid/kernel/routing/NetPoint.hpp"
 #include "src/surf/network_interface.hpp"
+#include "src/surf/xml/platf_private.hpp"
+#include "surf/surf.hpp"
 
-#include <float.h>
+#include <cfloat>
+#include <queue>
+#include <vector>
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_dijkstra, surf, "Routing part of surf -- dijkstra routing logic");
 
-/* Free functions */
+namespace simgrid {
+namespace kernel {
+namespace routing {
 
-static void route_cache_elem_free(void* e)
+class GraphNodeData {
+public:
+  explicit GraphNodeData(int id) : id_(id) {}
+  int id_;
+  int graph_id_ = -1; /* used for caching internal graph id's */
+};
+
+DijkstraZone::DijkstraZone(NetZoneImpl* father, std::string name, resource::NetworkModel* netmodel, bool cached)
+    : RoutedZone(father, name, netmodel), cached_(cached)
 {
-  route_cache_element_t elm = (route_cache_element_t)e;
-  if (elm) {
-    xbt_free(elm->pred_arr);
-    xbt_free(elm);
-  }
 }
 
-static void graph_node_map_elem_free(void* e)
+static void graph_node_data_free(void* n)
 {
-  graph_node_map_element_t elm = (graph_node_map_element_t)e;
-  xbt_free(elm);
+  delete static_cast<simgrid::kernel::routing::GraphNodeData*>(n);
 }
 
-static void graph_edge_data_free(void* e) // FIXME: useless code duplication
+static void graph_edge_data_free(void* e)
 {
-  sg_platf_route_cbarg_t e_route = (sg_platf_route_cbarg_t)e;
-  if (e_route) {
-    delete e_route->link_list;
-    xbt_free(e_route);
-  }
+  delete static_cast<simgrid::kernel::routing::RouteCreationArgs*>(e);
 }
 
-/* Utility functions */
+DijkstraZone::~DijkstraZone()
+{
+  xbt_graph_free_graph(route_graph_, &graph_node_data_free, &graph_edge_data_free, nullptr);
+}
 
-namespace simgrid {
-namespace kernel {
-namespace routing {
 void DijkstraZone::seal()
 {
-  xbt_node_t node = nullptr;
-  unsigned int cursor2;
   unsigned int cursor;
+  xbt_node_t node = nullptr;
 
-  /* Create the topology graph */
-  if (!routeGraph_)
-    routeGraph_ = xbt_graph_new_graph(1, nullptr);
-  if (!graphNodeMap_)
-    graphNodeMap_ = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
+  if (not route_graph_)
+    route_graph_ = xbt_graph_new_graph(1, nullptr);
 
   /* Add the loopback if needed */
   if (surf_network_model->loopback_ && hierarchy_ == RoutingMode::base) {
-    xbt_dynar_foreach (xbt_graph_get_nodes(routeGraph_), cursor, node) {
-      xbt_edge_t edge = nullptr;
 
+    xbt_dynar_foreach (xbt_graph_get_nodes(route_graph_), cursor, node) {
       bool found = false;
+      xbt_edge_t edge = nullptr;
+      unsigned int cursor2;
       xbt_dynar_foreach (xbt_graph_node_get_outedges(node), cursor2, edge) {
-        if (xbt_graph_edge_get_target(edge) == node) {
+        if (xbt_graph_edge_get_target(edge) == node) { // There is an edge from node to itself
           found = true;
           break;
         }
       }
 
-      if (!found) {
-        sg_platf_route_cbarg_t e_route = xbt_new0(s_sg_platf_route_cbarg_t, 1);
-        e_route->link_list             = new std::vector<surf::LinkImpl*>();
-        e_route->link_list->push_back(surf_network_model->loopback_);
-        xbt_graph_new_edge(routeGraph_, node, node, e_route);
+      if (not found) {
+        RouteCreationArgs* e_route = new simgrid::kernel::routing::RouteCreationArgs();
+        e_route->link_list.push_back(surf_network_model->loopback_);
+        xbt_graph_new_edge(route_graph_, node, node, e_route);
       }
     }
   }
 
   /* initialize graph indexes in nodes after graph has been built */
-  xbt_dynar_t nodes = xbt_graph_get_nodes(routeGraph_);
+  xbt_dynar_t nodes = xbt_graph_get_nodes(route_graph_);
 
   xbt_dynar_foreach (nodes, cursor, node) {
-    graph_node_data_t data = (graph_node_data_t)xbt_graph_node_get_data(node);
-    data->graph_id         = cursor;
+    GraphNodeData* data = static_cast<GraphNodeData*>(xbt_graph_node_get_data(node));
+    data->graph_id_     = cursor;
   }
 }
 
-xbt_node_t DijkstraZone::routeGraphNewNode(int id, int graph_id)
+xbt_node_t DijkstraZone::route_graph_new_node(int id)
 {
-  graph_node_data_t data         = xbt_new0(struct graph_node_data, 1);
-  data->id       = id;
-  data->graph_id = graph_id;
-
-  xbt_node_t node                = xbt_graph_new_node(routeGraph_, data);
-  graph_node_map_element_t elm   = xbt_new0(struct graph_node_map_element, 1);
-  elm->node = node;
-  xbt_dict_set_ext(graphNodeMap_, (char*)(&id), sizeof(int), (xbt_dictelm_t)elm, nullptr);
+  xbt_node_t node = xbt_graph_new_node(route_graph_, new GraphNodeData(id));
+  graph_node_map_.emplace(id, node);
 
   return node;
 }
 
-graph_node_map_element_t DijkstraZone::nodeMapSearch(int id)
+xbt_node_t DijkstraZone::node_map_search(int id)
 {
-  return (graph_node_map_element_t)xbt_dict_get_or_null_ext(graphNodeMap_, (char*)(&id), sizeof(int));
+  auto ret = graph_node_map_.find(id);
+  return ret == graph_node_map_.end() ? nullptr : ret->second;
 }
 
 /* Parsing */
 
-void DijkstraZone::newRoute(int src_id, int dst_id, sg_platf_route_cbarg_t e_route)
+void DijkstraZone::get_local_route(NetPoint* src, NetPoint* dst, RouteCreationArgs* route, double* lat)
 {
-  XBT_DEBUG("Load Route from \"%d\" to \"%d\"", src_id, dst_id);
-  xbt_node_t src = nullptr;
-  xbt_node_t dst = nullptr;
-
-  graph_node_map_element_t src_elm = nodeMapSearch(src_id);
-  graph_node_map_element_t dst_elm = nodeMapSearch(dst_id);
-
-  if (src_elm)
-    src = src_elm->node;
-
-  if (dst_elm)
-    dst = dst_elm->node;
-
-  /* add nodes if they don't exist in the graph */
-  if (src_id == dst_id && src == nullptr && dst == nullptr) {
-    src = this->routeGraphNewNode(src_id, -1);
-    dst = src;
-  } else {
-    if (src == nullptr) {
-      src = this->routeGraphNewNode(src_id, -1);
-    }
-    if (dst == nullptr) {
-      dst = this->routeGraphNewNode(dst_id, -1);
-    }
-  }
-
-  /* add link as edge to graph */
-  xbt_graph_new_edge(routeGraph_, src, dst, e_route);
-}
-
-void DijkstraZone::getLocalRoute(NetPoint* src, NetPoint* dst, sg_platf_route_cbarg_t route, double* lat)
-{
-  getRouteCheckParams(src, dst);
+  get_route_check_params(src, dst);
   int src_id = src->id();
   int dst_id = dst->id();
 
-  int* pred_arr     = nullptr;
-  int size          = 0;
-  xbt_dynar_t nodes = xbt_graph_get_nodes(routeGraph_);
+  xbt_dynar_t nodes = xbt_graph_get_nodes(route_graph_);
 
   /* Use the graph_node id mapping set to quickly find the nodes */
-  graph_node_map_element_t src_elm = nodeMapSearch(src_id);
-  graph_node_map_element_t dst_elm = nodeMapSearch(dst_id);
+  xbt_node_t src_elm = node_map_search(src_id);
+  xbt_node_t dst_elm = node_map_search(dst_id);
 
-  int src_node_id = ((graph_node_data_t)xbt_graph_node_get_data(src_elm->node))->graph_id;
-  int dst_node_id = ((graph_node_data_t)xbt_graph_node_get_data(dst_elm->node))->graph_id;
+  int src_node_id = static_cast<GraphNodeData*>(xbt_graph_node_get_data(src_elm))->graph_id_;
+  int dst_node_id = static_cast<GraphNodeData*>(xbt_graph_node_get_data(dst_elm))->graph_id_;
 
   /* if the src and dst are the same */
   if (src_node_id == dst_node_id) {
 
     xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src_node_id, xbt_node_t);
     xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst_node_id, xbt_node_t);
-    xbt_edge_t edge     = xbt_graph_get_edge(routeGraph_, node_s_v, node_e_v);
+    xbt_edge_t edge     = xbt_graph_get_edge(route_graph_, node_s_v, node_e_v);
 
     if (edge == nullptr)
-      THROWF(arg_error, 0, "No route from '%s' to '%s'", src->name().c_str(), dst->name().c_str());
+      THROWF(arg_error, 0, "No route from '%s' to '%s'", src->get_cname(), dst->get_cname());
 
-    sg_platf_route_cbarg_t e_route = (sg_platf_route_cbarg_t)xbt_graph_edge_get_data(edge);
+    RouteCreationArgs* e_route = static_cast<RouteCreationArgs*>(xbt_graph_edge_get_data(edge));
 
-    for (auto link : *e_route->link_list) {
-      route->link_list->insert(route->link_list->begin(), link);
+    for (auto const& link : e_route->link_list) {
+      route->link_list.insert(route->link_list.begin(), link);
       if (lat)
-        *lat += static_cast<surf::LinkImpl*>(link)->latency();
+        *lat += static_cast<resource::LinkImpl*>(link)->get_latency();
     }
   }
 
-  route_cache_element_t elm = nullptr;
-  if (routeCache_) { /* cache mode  */
-    elm = (route_cache_element_t)xbt_dict_get_or_null_ext(routeCache_, (char*)(&src_id), sizeof(int));
-  }
-
-  if (elm) { /* cached mode and cache hit */
-    pred_arr = elm->pred_arr;
-  } else { /* not cached mode, or cache miss */
+  auto elm                   = route_cache_.emplace(src_id, std::vector<int>());
+  std::vector<int>& pred_arr = elm.first->second;
 
+  if (elm.second) { /* new element was inserted (not cached mode, or cache miss) */
     int nr_nodes      = xbt_dynar_length(nodes);
-    double* cost_arr  = xbt_new0(double, nr_nodes); /* link cost from src to other hosts */
-    pred_arr          = xbt_new0(int, nr_nodes);    /* predecessors in path from src */
-    xbt_heap_t pqueue = xbt_heap_new(nr_nodes, xbt_free_f);
+    std::vector<double> cost_arr(nr_nodes); /* link cost from src to other hosts */
+    pred_arr.resize(nr_nodes);              /* predecessors in path from src */
+    typedef std::pair<double, int> Qelt;
+    std::priority_queue<Qelt, std::vector<Qelt>, std::greater<Qelt>> pqueue;
 
     /* initialize */
     cost_arr[src_node_id] = 0.0;
@@ -199,87 +156,74 @@ void DijkstraZone::getLocalRoute(NetPoint* src, NetPoint* dst, sg_platf_route_cb
       pred_arr[i] = 0;
 
       /* initialize priority queue */
-      int* nodeid = xbt_new0(int, 1);
-      *nodeid     = i;
-      xbt_heap_push(pqueue, nodeid, cost_arr[i]);
+      pqueue.emplace(cost_arr[i], i);
     }
 
     /* apply dijkstra using the indexes from the graph's node array */
-    while (xbt_heap_size(pqueue) > 0) {
-      int* v_id         = static_cast<int*>(xbt_heap_pop(pqueue));
-      xbt_node_t v_node = xbt_dynar_get_as(nodes, *v_id, xbt_node_t);
+    while (not pqueue.empty()) {
+      int v_id = pqueue.top().second;
+      pqueue.pop();
+      xbt_node_t v_node = xbt_dynar_get_as(nodes, v_id, xbt_node_t);
       xbt_edge_t edge   = nullptr;
       unsigned int cursor;
 
       xbt_dynar_foreach (xbt_graph_node_get_outedges(v_node), cursor, edge) {
         xbt_node_t u_node                  = xbt_graph_edge_get_target(edge);
-        graph_node_data_t data             = (graph_node_data_t)xbt_graph_node_get_data(u_node);
-        int u_id                           = data->graph_id;
-        sg_platf_route_cbarg_t tmp_e_route = (sg_platf_route_cbarg_t)xbt_graph_edge_get_data(edge);
-        int cost_v_u                       = tmp_e_route->link_list->size(); /* count of links, old model assume 1 */
-
-        if (cost_v_u + cost_arr[*v_id] < cost_arr[u_id]) {
-          pred_arr[u_id] = *v_id;
-          cost_arr[u_id] = cost_v_u + cost_arr[*v_id];
-          int* nodeid    = xbt_new0(int, 1);
-          *nodeid        = u_id;
-          xbt_heap_push(pqueue, nodeid, cost_arr[u_id]);
+        GraphNodeData* data                = static_cast<GraphNodeData*>(xbt_graph_node_get_data(u_node));
+        int u_id                           = data->graph_id_;
+        RouteCreationArgs* tmp_e_route     = static_cast<RouteCreationArgs*>(xbt_graph_edge_get_data(edge));
+        int cost_v_u                       = tmp_e_route->link_list.size(); /* count of links, old model assume 1 */
+
+        if (cost_v_u + cost_arr[v_id] < cost_arr[u_id]) {
+          pred_arr[u_id] = v_id;
+          cost_arr[u_id] = cost_v_u + cost_arr[v_id];
+          pqueue.emplace(cost_arr[u_id], u_id);
         }
       }
-
-      /* free item popped from pqueue */
-      xbt_free(v_id);
     }
-
-    xbt_free(cost_arr);
-    xbt_heap_free(pqueue);
   }
 
   /* compose route path with links */
-  NetPoint* gw_src = nullptr;
-  NetPoint* gw_dst;
-  NetPoint* prev_gw_src;
-  NetPoint* first_gw            = nullptr;
-  NetPoint* gw_dst_net_elm      = nullptr;
-  NetPoint* prev_gw_src_net_elm = nullptr;
+  NetPoint* gw_src   = nullptr;
+  NetPoint* first_gw = nullptr;
 
   for (int v = dst_node_id; v != src_node_id; v = pred_arr[v]) {
     xbt_node_t node_pred_v = xbt_dynar_get_as(nodes, pred_arr[v], xbt_node_t);
     xbt_node_t node_v      = xbt_dynar_get_as(nodes, v, xbt_node_t);
-    xbt_edge_t edge        = xbt_graph_get_edge(routeGraph_, node_pred_v, node_v);
+    xbt_edge_t edge        = xbt_graph_get_edge(route_graph_, node_pred_v, node_v);
 
     if (edge == nullptr)
-      THROWF(arg_error, 0, "No route from '%s' to '%s'", src->name().c_str(), dst->name().c_str());
+      THROWF(arg_error, 0, "No route from '%s' to '%s'", src->get_cname(), dst->get_cname());
 
-    prev_gw_src = gw_src;
+    RouteCreationArgs* e_route = static_cast<RouteCreationArgs*>(xbt_graph_edge_get_data(edge));
 
-    sg_platf_route_cbarg_t e_route = (sg_platf_route_cbarg_t)xbt_graph_edge_get_data(edge);
-    gw_src                         = e_route->gw_src;
-    gw_dst                         = e_route->gw_dst;
+    NetPoint* prev_gw_src = gw_src;
+    gw_src                = e_route->gw_src;
+    NetPoint* gw_dst      = e_route->gw_dst;
 
     if (v == dst_node_id)
       first_gw = gw_dst;
 
-    if (hierarchy_ == RoutingMode::recursive && v != dst_node_id &&
-        strcmp(gw_dst->name().c_str(), prev_gw_src->name().c_str())) {
-      std::vector<surf::LinkImpl*> e_route_as_to_as;
+    if (hierarchy_ == RoutingMode::recursive && v != dst_node_id && gw_dst->get_name() != prev_gw_src->get_name()) {
+      std::vector<resource::LinkImpl*> e_route_as_to_as;
 
-      getGlobalRoute(gw_dst_net_elm, prev_gw_src_net_elm, &e_route_as_to_as, nullptr);
-      auto pos = route->link_list->begin();
-      for (auto link : e_route_as_to_as) {
-        route->link_list->insert(pos, link);
+      NetPoint* gw_dst_net_elm      = nullptr;
+      NetPoint* prev_gw_src_net_elm = nullptr;
+      get_global_route(gw_dst_net_elm, prev_gw_src_net_elm, e_route_as_to_as, nullptr);
+      auto pos = route->link_list.begin();
+      for (auto const& link : e_route_as_to_as) {
+        route->link_list.insert(pos, link);
         if (lat)
-          *lat += link->latency();
+          *lat += link->get_latency();
         pos++;
       }
     }
 
-    for (auto link : *e_route->link_list) {
-      route->link_list->insert(route->link_list->begin(), link);
+    for (auto const& link : e_route->link_list) {
+      route->link_list.insert(route->link_list.begin(), link);
       if (lat)
-        *lat += static_cast<surf::LinkImpl*>(link)->latency();
+        *lat += static_cast<resource::LinkImpl*>(link)->get_latency();
     }
-    size++;
   }
 
   if (hierarchy_ == RoutingMode::recursive) {
@@ -287,80 +231,48 @@ void DijkstraZone::getLocalRoute(NetPoint* src, NetPoint* dst, sg_platf_route_cb
     route->gw_dst = first_gw;
   }
 
-  if (routeCache_ && elm == nullptr) {
-    /* add to predecessor list of the current src-host to cache */
-    elm           = xbt_new0(struct route_cache_element, 1);
-    elm->pred_arr = pred_arr;
-    elm->size     = size;
-    xbt_dict_set_ext(routeCache_, (char*)(&src_id), sizeof(int), (xbt_dictelm_t)elm, nullptr);
-  }
-
-  if (!routeCache_)
-    xbt_free(pred_arr);
+  if (not cached_)
+    route_cache_.clear();
 }
 
-DijkstraZone::~DijkstraZone()
+void DijkstraZone::add_route(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
+                             std::vector<resource::LinkImpl*>& link_list, bool symmetrical)
 {
-  xbt_graph_free_graph(routeGraph_, &xbt_free_f, &graph_edge_data_free, &xbt_free_f);
-  xbt_dict_free(&graphNodeMap_);
-  xbt_dict_free(&routeCache_);
-}
+  add_route_check_params(src, dst, gw_src, gw_dst, link_list, symmetrical);
 
-/* Creation routing model functions */
+  if (not route_graph_)
+    route_graph_ = xbt_graph_new_graph(1, nullptr);
 
-DijkstraZone::DijkstraZone(NetZone* father, const char* name, bool cached) : RoutedZone(father, name)
-{
-  if (cached)
-    routeCache_ = xbt_dict_new_homogeneous(&route_cache_elem_free);
+  new_edge(src->id(), dst->id(), new_extended_route(hierarchy_, src, dst, gw_src, gw_dst, link_list, symmetrical, 1));
+
+  if (symmetrical == true)
+    new_edge(dst->id(), src->id(), new_extended_route(hierarchy_, dst, src, gw_dst, gw_src, link_list, symmetrical, 0));
 }
 
-void DijkstraZone::addRoute(sg_platf_route_cbarg_t route)
+void DijkstraZone::new_edge(int src_id, int dst_id, simgrid::kernel::routing::RouteCreationArgs* route)
 {
-  NetPoint* src       = route->src;
-  NetPoint* dst       = route->dst;
-  const char* srcName = src->name().c_str();
-  const char* dstName = dst->name().c_str();
-
-  addRouteCheckParams(route);
-
-  /* Create the topology graph */
-  if (!routeGraph_)
-    routeGraph_ = xbt_graph_new_graph(1, nullptr);
-  if (!graphNodeMap_)
-    graphNodeMap_ = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
-
-  /* we don't check whether the route already exist, because the algorithm may find another path through some other
-   * nodes */
-
-  /* Add the route to the base */
-  sg_platf_route_cbarg_t e_route = newExtendedRoute(hierarchy_, route, 1);
-  newRoute(src->id(), dst->id(), e_route);
-
-  // Symmetrical YES
-  if (route->symmetrical == true) {
-    if (!route->gw_dst && !route->gw_src)
-      XBT_DEBUG("Load Route from \"%s\" to \"%s\"", dstName, srcName);
+  XBT_DEBUG("Create Route from '%d' to '%d'", src_id, dst_id);
+
+  // Get the extremities, or create them if they don't exist yet
+  xbt_node_t src = node_map_search(src_id);
+  if (src == nullptr)
+    src = route_graph_new_node(src_id);
+
+  xbt_node_t dst = node_map_search(dst_id);
+  if (dst == nullptr)
+    dst = route_graph_new_node(dst_id);
+
+  // Make sure that this graph edge was not already added to the graph
+  if (xbt_graph_get_edge(route_graph_, src, dst) != nullptr) {
+    if (route->gw_dst == nullptr || route->gw_src == nullptr)
+      THROWF(arg_error, 0, "Route from %s to %s already exists", route->src->get_cname(), route->dst->get_cname());
     else
-      XBT_DEBUG("Load NetzoneRoute from %s@%s to %s@%s", dstName, route->gw_dst->name().c_str(), srcName,
-                route->gw_src->name().c_str());
-
-    xbt_dynar_t nodes   = xbt_graph_get_nodes(routeGraph_);
-    xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src->id(), xbt_node_t);
-    xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst->id(), xbt_node_t);
-    xbt_edge_t edge     = xbt_graph_get_edge(routeGraph_, node_e_v, node_s_v);
-
-    if (edge)
-      THROWF(arg_error, 0, "Route from %s@%s to %s@%s already exists", dstName, route->gw_dst->name().c_str(), srcName,
-             route->gw_src->name().c_str());
-
-    if (route->gw_dst && route->gw_src) {
-      NetPoint* gw_tmp = route->gw_src;
-      route->gw_src   = route->gw_dst;
-      route->gw_dst   = gw_tmp;
-    }
-    sg_platf_route_cbarg_t link_route_back = newExtendedRoute(hierarchy_, route, 0);
-    newRoute(dst->id(), src->id(), link_route_back);
+      THROWF(arg_error, 0, "Route from %s@%s to %s@%s already exists", route->src->get_cname(),
+             route->gw_src->get_cname(), route->dst->get_cname(), route->gw_dst->get_cname());
   }
+
+  // Finally add it
+  xbt_graph_new_edge(route_graph_, src, dst, route);
 }
 }
 }