1 /* Copyright (c) 2009-2016. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #include "src/kernel/routing/AsDijkstra.hpp"
7 #include "src/surf/network_interface.hpp"
9 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_dijkstra, surf, "Routing part of surf -- dijkstra routing logic");
13 static void route_cache_elem_free(void *e)
15 route_cache_element_t elm = (route_cache_element_t) e;
17 xbt_free(elm->pred_arr);
22 static void graph_node_map_elem_free(void *e)
24 graph_node_map_element_t elm = (graph_node_map_element_t) e;
28 static void graph_edge_data_free(void *e) // FIXME: useless code duplication
30 sg_platf_route_cbarg_t e_route = (sg_platf_route_cbarg_t) e;
32 delete e_route->link_list;
37 /* Utility functions */
42 void AsDijkstra::seal()
44 xbt_node_t node = nullptr;
45 unsigned int cursor2, cursor;
47 /* Create the topology graph */
49 routeGraph_ = xbt_graph_new_graph(1, nullptr);
51 graphNodeMap_ = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
53 /* Add the loopback if needed */
54 if (routing_platf->loopback_ && hierarchy_ == RoutingMode::base) {
55 xbt_dynar_foreach(xbt_graph_get_nodes(routeGraph_), cursor, node) {
56 xbt_edge_t edge = nullptr;
59 xbt_dynar_foreach(xbt_graph_node_get_outedges(node), cursor2, edge) {
60 if (xbt_graph_edge_get_target(edge) == node) {
67 sg_platf_route_cbarg_t e_route = xbt_new0(s_sg_platf_route_cbarg_t, 1);
68 e_route->link_list = new std::vector<Link*>();
69 e_route->link_list->push_back(routing_platf->loopback_);
70 xbt_graph_new_edge(routeGraph_, node, node, e_route);
75 /* initialize graph indexes in nodes after graph has been built */
76 xbt_dynar_t nodes = xbt_graph_get_nodes(routeGraph_);
78 xbt_dynar_foreach(nodes, cursor, node) {
79 graph_node_data_t data = (graph_node_data_t) xbt_graph_node_get_data(node);
80 data->graph_id = cursor;
84 xbt_node_t AsDijkstra::routeGraphNewNode(int id, int graph_id)
86 xbt_node_t node = nullptr;
87 graph_node_data_t data = nullptr;
88 graph_node_map_element_t elm = nullptr;
90 data = xbt_new0(struct graph_node_data, 1);
92 data->graph_id = graph_id;
93 node = xbt_graph_new_node(routeGraph_, data);
95 elm = xbt_new0(struct graph_node_map_element, 1);
97 xbt_dict_set_ext(graphNodeMap_, (char *) (&id), sizeof(int), (xbt_dictelm_t) elm, nullptr);
102 graph_node_map_element_t AsDijkstra::nodeMapSearch(int id)
104 return (graph_node_map_element_t)xbt_dict_get_or_null_ext(graphNodeMap_, (char *) (&id), sizeof(int));
109 void AsDijkstra::newRoute(int src_id, int dst_id, sg_platf_route_cbarg_t e_route)
111 XBT_DEBUG("Load Route from \"%d\" to \"%d\"", src_id, dst_id);
112 xbt_node_t src = nullptr;
113 xbt_node_t dst = nullptr;
115 graph_node_map_element_t src_elm = nodeMapSearch(src_id);
116 graph_node_map_element_t dst_elm = nodeMapSearch(dst_id);
124 /* add nodes if they don't exist in the graph */
125 if (src_id == dst_id && src == nullptr && dst == nullptr) {
126 src = this->routeGraphNewNode(src_id, -1);
129 if (src == nullptr) {
130 src = this->routeGraphNewNode(src_id, -1);
132 if (dst == nullptr) {
133 dst = this->routeGraphNewNode(dst_id, -1);
137 /* add link as edge to graph */
138 xbt_graph_new_edge(routeGraph_, src, dst, e_route);
141 void AsDijkstra::getRouteAndLatency(NetCard *src, NetCard *dst, sg_platf_route_cbarg_t route, double *lat)
143 getRouteCheckParams(src, dst);
144 int src_id = src->id();
145 int dst_id = dst->id();
147 int *pred_arr = nullptr;
148 sg_platf_route_cbarg_t e_route;
150 xbt_dynar_t nodes = xbt_graph_get_nodes(routeGraph_);
152 /* Use the graph_node id mapping set to quickly find the nodes */
153 graph_node_map_element_t src_elm = nodeMapSearch(src_id);
154 graph_node_map_element_t dst_elm = nodeMapSearch(dst_id);
156 int src_node_id = ((graph_node_data_t) xbt_graph_node_get_data(src_elm->node))->graph_id;
157 int dst_node_id = ((graph_node_data_t) xbt_graph_node_get_data(dst_elm->node))->graph_id;
159 /* if the src and dst are the same */
160 if (src_node_id == dst_node_id) {
162 xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src_node_id, xbt_node_t);
163 xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst_node_id, xbt_node_t);
164 xbt_edge_t edge = xbt_graph_get_edge(routeGraph_, node_s_v, node_e_v);
167 THROWF(arg_error, 0, "No route from '%s' to '%s'", src->name().c_str(), dst->name().c_str());
169 e_route = (sg_platf_route_cbarg_t) xbt_graph_edge_get_data(edge);
171 for (auto link: *e_route->link_list) {
172 route->link_list->insert(route->link_list->begin(), link);
174 *lat += static_cast<Link*>(link)->latency();
179 route_cache_element_t elm = nullptr;
180 if (routeCache_) { /* cache mode */
181 elm = (route_cache_element_t) xbt_dict_get_or_null_ext(routeCache_, (char *) (&src_id), sizeof(int));
184 if (elm) { /* cached mode and cache hit */
185 pred_arr = elm->pred_arr;
186 } else { /* not cached mode, or cache miss */
188 int nr_nodes = xbt_dynar_length(nodes);
189 double * cost_arr = xbt_new0(double, nr_nodes); /* link cost from src to other hosts */
190 pred_arr = xbt_new0(int, nr_nodes); /* predecessors in path from src */
191 xbt_heap_t pqueue = xbt_heap_new(nr_nodes, xbt_free_f);
194 cost_arr[src_node_id] = 0.0;
196 for (int i = 0; i < nr_nodes; i++) {
197 if (i != src_node_id) {
198 cost_arr[i] = DBL_MAX;
203 /* initialize priority queue */
204 int *nodeid = xbt_new0(int, 1);
206 xbt_heap_push(pqueue, nodeid, cost_arr[i]);
210 /* apply dijkstra using the indexes from the graph's node array */
211 while (xbt_heap_size(pqueue) > 0) {
212 int *v_id = (int *) xbt_heap_pop(pqueue);
213 xbt_node_t v_node = xbt_dynar_get_as(nodes, *v_id, xbt_node_t);
214 xbt_edge_t edge = nullptr;
217 xbt_dynar_foreach(xbt_graph_node_get_outedges(v_node), cursor, edge) {
218 xbt_node_t u_node = xbt_graph_edge_get_target(edge);
219 graph_node_data_t data = (graph_node_data_t) xbt_graph_node_get_data(u_node);
220 int u_id = data->graph_id;
221 sg_platf_route_cbarg_t tmp_e_route = (sg_platf_route_cbarg_t) xbt_graph_edge_get_data(edge);
222 int cost_v_u = tmp_e_route->link_list->size(); /* count of links, old model assume 1 */
224 if (cost_v_u + cost_arr[*v_id] < cost_arr[u_id]) {
225 pred_arr[u_id] = *v_id;
226 cost_arr[u_id] = cost_v_u + cost_arr[*v_id];
227 int *nodeid = xbt_new0(int, 1);
229 xbt_heap_push(pqueue, nodeid, cost_arr[u_id]);
233 /* free item popped from pqueue */
238 xbt_heap_free(pqueue);
241 /* compose route path with links */
242 NetCard *gw_src = nullptr, *gw_dst, *prev_gw_src, *first_gw = nullptr;
243 NetCard *gw_dst_net_elm = nullptr, *prev_gw_src_net_elm = nullptr;
245 for (int v = dst_node_id; v != src_node_id; v = pred_arr[v]) {
246 xbt_node_t node_pred_v = xbt_dynar_get_as(nodes, pred_arr[v], xbt_node_t);
247 xbt_node_t node_v = xbt_dynar_get_as(nodes, v, xbt_node_t);
248 xbt_edge_t edge = xbt_graph_get_edge(routeGraph_, node_pred_v, node_v);
251 THROWF(arg_error, 0, "No route from '%s' to '%s'", src->name().c_str(), dst->name().c_str());
253 prev_gw_src = gw_src;
255 e_route = (sg_platf_route_cbarg_t) xbt_graph_edge_get_data(edge);
256 gw_src = e_route->gw_src;
257 gw_dst = e_route->gw_dst;
259 if (v == dst_node_id)
262 if (hierarchy_ == RoutingMode::recursive && v != dst_node_id &&
263 strcmp(gw_dst->name().c_str(), prev_gw_src->name().c_str())) {
264 std::vector<Link*> *e_route_as_to_as = new std::vector<Link*>();
266 routing_platf->getRouteAndLatency(gw_dst_net_elm, prev_gw_src_net_elm, e_route_as_to_as, nullptr);
267 auto pos = route->link_list->begin();
268 for (auto link : *e_route_as_to_as) {
269 route->link_list->insert(pos, link);
271 *lat += link->latency();
276 for (auto link: *e_route->link_list) {
277 route->link_list->insert(route->link_list->begin(), link);
279 *lat += static_cast<Link*>(link)->latency();
284 if (hierarchy_ == RoutingMode::recursive) {
285 route->gw_src = gw_src;
286 route->gw_dst = first_gw;
289 if (routeCache_ && elm == nullptr) {
290 /* add to predecessor list of the current src-host to cache */
291 elm = xbt_new0(struct route_cache_element, 1);
292 elm->pred_arr = pred_arr;
294 xbt_dict_set_ext(routeCache_, (char *) (&src_id), sizeof(int), (xbt_dictelm_t) elm, nullptr);
301 AsDijkstra::~AsDijkstra()
303 xbt_graph_free_graph(routeGraph_, &xbt_free_f, &graph_edge_data_free, &xbt_free_f);
304 xbt_dict_free(&graphNodeMap_);
305 xbt_dict_free(&routeCache_);
308 /* Creation routing model functions */
310 AsDijkstra::AsDijkstra(As* father, const char* name, bool cached) : AsRoutedGraph(father, name)
313 routeCache_ = xbt_dict_new_homogeneous(&route_cache_elem_free);
316 void AsDijkstra::addRoute(sg_platf_route_cbarg_t route)
318 NetCard *src = route->src;
319 NetCard *dst = route->dst;
320 const char* srcName = src->name().c_str();
321 const char* dstName = dst->name().c_str();
323 addRouteCheckParams(route);
325 /* Create the topology graph */
327 routeGraph_ = xbt_graph_new_graph(1, nullptr);
329 graphNodeMap_ = xbt_dict_new_homogeneous(&graph_node_map_elem_free);
331 /* we don't check whether the route already exist, because the algorithm may find another path through some other nodes */
333 /* Add the route to the base */
334 sg_platf_route_cbarg_t e_route = newExtendedRoute(hierarchy_, route, 1);
335 newRoute(src->id(), dst->id(), e_route);
338 if (route->symmetrical == true) {
339 if(!route->gw_dst && !route->gw_src)
340 XBT_DEBUG("Load Route from \"%s\" to \"%s\"", dstName, srcName);
342 XBT_DEBUG("Load ASroute from %s@%s to %s@%s", dstName, route->gw_dst->name().c_str(), srcName,
343 route->gw_src->name().c_str());
345 xbt_dynar_t nodes = xbt_graph_get_nodes(routeGraph_);
346 xbt_node_t node_s_v = xbt_dynar_get_as(nodes, src->id(), xbt_node_t);
347 xbt_node_t node_e_v = xbt_dynar_get_as(nodes, dst->id(), xbt_node_t);
348 xbt_edge_t edge = xbt_graph_get_edge(routeGraph_, node_e_v, node_s_v);
351 THROWF(arg_error, 0, "Route from %s@%s to %s@%s already exists", dstName, route->gw_dst->name().c_str(), srcName,
352 route->gw_src->name().c_str());
354 if (route->gw_dst && route->gw_src) {
355 NetCard *gw_tmp = route->gw_src;
356 route->gw_src = route->gw_dst;
357 route->gw_dst = gw_tmp;
359 sg_platf_route_cbarg_t link_route_back = newExtendedRoute(hierarchy_, route, 0);
360 newRoute(dst->id(), src->id(), link_route_back);