src/kernel/routing/RoutedZone.cpp

   1 /* Copyright (c) 2009-2017. The SimGrid Team. All rights reserved.          */
   2
   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. */
   5
   6 #include "xbt/dict.h"
   7 #include "xbt/graph.h"
   8 #include "xbt/log.h"
   9 #include "xbt/sysdep.h"
  10
  11 #include "src/kernel/routing/NetPoint.hpp"
  12 #include "src/kernel/routing/RoutedZone.hpp"
  13 #include "src/surf/network_interface.hpp"
  14
  15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_routing_generic, surf_route, "Generic implementation of the surf routing");
  16
  17 /* ***************************************************************** */
  18 /* *********************** GENERIC METHODS ************************* */
  19
  20 static const char* instr_node_name(xbt_node_t node)
  21 {
  22   void* data = xbt_graph_node_get_data(node);
  23   return static_cast<const char*>(data);
  24 }
  25
  26 xbt_node_t new_xbt_graph_node(xbt_graph_t graph, const char* name, std::map<std::string, xbt_node_t>* nodes)
  27 {
  28
  29   auto elm = nodes->find(name);
  30   if (elm == nodes->end()) {
  31     xbt_node_t ret = xbt_graph_new_node(graph, xbt_strdup(name));
  32     nodes->insert({name, ret});
  33     return ret;
  34   } else
  35     return elm->second;
  36 }
  37
  38 xbt_edge_t new_xbt_graph_edge(xbt_graph_t graph, xbt_node_t s, xbt_node_t d, std::map<std::string, xbt_edge_t>* edges)
  39 {
  40   const char* sn = instr_node_name(s);
  41   const char* dn = instr_node_name(d);
  42   std::string name = std::string(sn) + dn;
  43
  44   auto elm = edges->find(name);
  45   if (elm == edges->end()) {
  46     name = std::string(dn) + sn;
  47     elm  = edges->find(name);
  48   }
  49
  50   if (elm == edges->end()) {
  51     xbt_edge_t ret = xbt_graph_new_edge(graph, s, d, nullptr);
  52     edges->insert({name, ret});
  53     return ret;
  54   } else
  55     return elm->second;
  56 }
  57
  58 namespace simgrid {
  59 namespace kernel {
  60 namespace routing {
  61
  62 RoutedZone::RoutedZone(NetZone* father, std::string name) : NetZoneImpl(father, name)
  63 {
  64 }
  65
  66 void RoutedZone::getGraph(xbt_graph_t graph, std::map<std::string, xbt_node_t>* nodes,
  67                           std::map<std::string, xbt_edge_t>* edges)
  68 {
  69   std::vector<kernel::routing::NetPoint*> vertices = getVertices();
  70
  71   for (auto const& my_src : vertices) {
  72     for (auto const& my_dst : vertices) {
  73       if (my_src == my_dst)
  74         continue;
  75
  76       sg_platf_route_cbarg_t route = new s_sg_platf_route_cbarg_t;
  77
  78       getLocalRoute(my_src, my_dst, route, nullptr);
  79
  80       XBT_DEBUG("get_route_and_latency %s -> %s", my_src->getCname(), my_dst->getCname());
  81
  82       xbt_node_t current;
  83       xbt_node_t previous;
  84       const char *previous_name;
  85       const char *current_name;
  86
  87       if (route->gw_src) {
  88         previous      = new_xbt_graph_node(graph, route->gw_src->getCname(), nodes);
  89         previous_name = route->gw_src->getCname();
  90       } else {
  91         previous      = new_xbt_graph_node(graph, my_src->getCname(), nodes);
  92         previous_name = my_src->getCname();
  93       }
  94
  95       for (auto const& link : route->link_list) {
  96         const char* link_name = link->getCname();
  97         current               = new_xbt_graph_node(graph, link_name, nodes);
  98         current_name          = link_name;
  99         new_xbt_graph_edge(graph, previous, current, edges);
 100         XBT_DEBUG("  %s -> %s", previous_name, current_name);
 101         previous      = current;
 102         previous_name = current_name;
 103       }
 104
 105       if (route->gw_dst) {
 106         current      = new_xbt_graph_node(graph, route->gw_dst->getCname(), nodes);
 107         current_name = route->gw_dst->getCname();
 108       } else {
 109         current      = new_xbt_graph_node(graph, my_dst->getCname(), nodes);
 110         current_name = my_dst->getCname();
 111       }
 112       new_xbt_graph_edge(graph, previous, current, edges);
 113       XBT_DEBUG("  %s -> %s", previous_name, current_name);
 114
 115       delete route;
 116     }
 117   }
 118 }
 119
 120 /* ************************************************************************** */
 121 /* ************************* GENERIC AUX FUNCTIONS ************************** */
 122 /* change a route containing link names into a route containing link entities */
 123 sg_platf_route_cbarg_t RoutedZone::newExtendedRoute(RoutingMode hierarchy, sg_platf_route_cbarg_t routearg,
 124                                                     bool change_order)
 125 {
 126   sg_platf_route_cbarg_t result;
 127
 128   result            = new s_sg_platf_route_cbarg_t;
 129
 130   xbt_assert(hierarchy == RoutingMode::base || hierarchy == RoutingMode::recursive,
 131              "The hierarchy of this netzone is neither BASIC nor RECURSIVE, I'm lost here.");
 132
 133   if (hierarchy == RoutingMode::recursive) {
 134     xbt_assert(routearg->gw_src && routearg->gw_dst, "nullptr is obviously a deficient gateway");
 135
 136     result->gw_src = routearg->gw_src;
 137     result->gw_dst = routearg->gw_dst;
 138   }
 139
 140   for (auto const& link : routearg->link_list) {
 141     if (change_order)
 142       result->link_list.push_back(link);
 143     else
 144       result->link_list.insert(result->link_list.begin(), link);
 145   }
 146   result->link_list.shrink_to_fit();
 147
 148   return result;
 149 }
 150
 151 void RoutedZone::getRouteCheckParams(NetPoint* src, NetPoint* dst)
 152 {
 153   xbt_assert(src, "Cannot find a route from nullptr to %s", dst->getCname());
 154   xbt_assert(dst, "Cannot find a route from %s to nullptr", src->getCname());
 155
 156   NetZone* src_as = src->netzone();
 157   NetZone* dst_as = dst->netzone();
 158
 159   xbt_assert(src_as == dst_as,
 160              "Internal error: %s@%s and %s@%s are not in the same netzone as expected. Please report that bug.",
 161              src->getCname(), src_as->getCname(), dst->getCname(), dst_as->getCname());
 162
 163   xbt_assert(this == dst_as, "Internal error: route destination %s@%s is not in netzone %s as expected (route source: "
 164                              "%s@%s). Please report that bug.",
 165              src->getCname(), dst->getCname(), src_as->getCname(), dst_as->getCname(), getCname());
 166 }
 167 void RoutedZone::addRouteCheckParams(sg_platf_route_cbarg_t route)
 168 {
 169   NetPoint* src       = route->src;
 170   NetPoint* dst       = route->dst;
 171   const char* srcName = src->getCname();
 172   const char* dstName = dst->getCname();
 173
 174   if (not route->gw_dst || not route->gw_src) {
 175     XBT_DEBUG("Load Route from \"%s\" to \"%s\"", srcName, dstName);
 176     xbt_assert(src, "Cannot add a route from %s to %s: %s does not exist.", srcName, dstName, srcName);
 177     xbt_assert(dst, "Cannot add a route from %s to %s: %s does not exist.", srcName, dstName, dstName);
 178     xbt_assert(not route->link_list.empty(), "Empty route (between %s and %s) forbidden.", srcName, dstName);
 179     xbt_assert(not src->isNetZone(),
 180                "When defining a route, src cannot be a netzone such as '%s'. Did you meant to have an NetzoneRoute?",
 181                srcName);
 182     xbt_assert(not dst->isNetZone(),
 183                "When defining a route, dst cannot be a netzone such as '%s'. Did you meant to have an NetzoneRoute?",
 184                dstName);
 185   } else {
 186     XBT_DEBUG("Load NetzoneRoute from %s@%s to %s@%s", srcName, route->gw_src->getCname(), dstName,
 187               route->gw_dst->getCname());
 188     xbt_assert(src->isNetZone(), "When defining a NetzoneRoute, src must be a netzone but '%s' is not", srcName);
 189     xbt_assert(dst->isNetZone(), "When defining a NetzoneRoute, dst must be a netzone but '%s' is not", dstName);
 190
 191     xbt_assert(route->gw_src->isHost() || route->gw_src->isRouter(),
 192                "When defining a NetzoneRoute, gw_src must be an host or a router but '%s' is not.", srcName);
 193     xbt_assert(route->gw_dst->isHost() || route->gw_dst->isRouter(),
 194                "When defining a NetzoneRoute, gw_dst must be an host or a router but '%s' is not.", dstName);
 195
 196     xbt_assert(route->gw_src != route->gw_dst, "Cannot define an NetzoneRoute from '%s' to itself",
 197                route->gw_src->getCname());
 198
 199     xbt_assert(src, "Cannot add a route from %s@%s to %s@%s: %s does not exist.", srcName, route->gw_src->getCname(),
 200                dstName, route->gw_dst->getCname(), srcName);
 201     xbt_assert(dst, "Cannot add a route from %s@%s to %s@%s: %s does not exist.", srcName, route->gw_src->getCname(),
 202                dstName, route->gw_dst->getCname(), dstName);
 203     xbt_assert(not route->link_list.empty(), "Empty route (between %s@%s and %s@%s) forbidden.", srcName,
 204                route->gw_src->getCname(), dstName, route->gw_dst->getCname());
 205   }
 206
 207   onRouteCreation(route->symmetrical, route->src, route->dst, route->gw_src, route->gw_dst, route->link_list);
 208 }
 209 }
 210 }
 211 }