src/kernel/routing/RoutedZone.cpp

   1 /* Copyright (c) 2009-2022. 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 "simgrid/kernel/routing/RoutedZone.hpp"
   7 #include "simgrid/kernel/routing/NetPoint.hpp"
   8 #include "src/kernel/resource/StandardLinkImpl.hpp"
   9 #include "xbt/dict.h"
  10 #include "xbt/graph.h"
  11 #include "xbt/log.h"
  12 #include "xbt/sysdep.h"
  13
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_routing_generic, ker_routing, "Kernel Generic Routing");
  15
  16 /* ***************************************************************** */
  17 /* *********************** GENERIC METHODS ************************* */
  18
  19 xbt_node_t new_xbt_graph_node(const s_xbt_graph_t* graph, const char* name,
  20                               std::map<std::string, xbt_node_t, std::less<>>* nodes)
  21 {
  22   auto elm = nodes->find(name);
  23   if (elm == nodes->end()) {
  24     xbt_node_t ret = xbt_graph_new_node(graph, xbt_strdup(name));
  25     nodes->insert({name, ret});
  26     return ret;
  27   } else
  28     return elm->second;
  29 }
  30
  31 xbt_edge_t new_xbt_graph_edge(const s_xbt_graph_t* graph, xbt_node_t s, xbt_node_t d,
  32                               std::map<std::string, xbt_edge_t, std::less<>>* edges)
  33 {
  34   const auto* sn   = static_cast<const char*>(xbt_graph_node_get_data(s));
  35   const auto* dn   = static_cast<const char*>(xbt_graph_node_get_data(d));
  36   std::string name = std::string(sn) + dn;
  37
  38   auto elm = edges->find(name);
  39   if (elm == edges->end()) {
  40     name = std::string(dn) + sn;
  41     elm  = edges->find(name);
  42   }
  43
  44   if (elm == edges->end()) {
  45     xbt_edge_t ret = xbt_graph_new_edge(graph, s, d, nullptr);
  46     edges->insert({name, ret});
  47     return ret;
  48   } else
  49     return elm->second;
  50 }
  51
  52 namespace simgrid {
  53 namespace kernel {
  54 namespace routing {
  55
  56 RoutedZone::RoutedZone(const std::string& name) : NetZoneImpl(name) {}
  57
  58 void RoutedZone::get_graph(const s_xbt_graph_t* graph, std::map<std::string, xbt_node_t, std::less<>>* nodes,
  59                            std::map<std::string, xbt_edge_t, std::less<>>* edges)
  60 {
  61   std::vector<NetPoint*> vertices = get_vertices();
  62
  63   for (auto const& my_src : vertices) {
  64     for (auto const& my_dst : vertices) {
  65       if (my_src == my_dst)
  66         continue;
  67
  68       Route route;
  69
  70       get_local_route(my_src, my_dst, &route, nullptr);
  71
  72       XBT_DEBUG("get_route_and_latency %s -> %s", my_src->get_cname(), my_dst->get_cname());
  73
  74       xbt_node_t current;
  75       xbt_node_t previous;
  76       const char* previous_name;
  77       const char* current_name;
  78
  79       if (route.gw_src_) {
  80         previous      = new_xbt_graph_node(graph, route.gw_src_->get_cname(), nodes);
  81         previous_name = route.gw_src_->get_cname();
  82       } else {
  83         previous      = new_xbt_graph_node(graph, my_src->get_cname(), nodes);
  84         previous_name = my_src->get_cname();
  85       }
  86
  87       for (auto const& link : route.link_list_) {
  88         const char* link_name = link->get_cname();
  89         current               = new_xbt_graph_node(graph, link_name, nodes);
  90         current_name          = link_name;
  91         new_xbt_graph_edge(graph, previous, current, edges);
  92         XBT_DEBUG("  %s -> %s", previous_name, current_name);
  93         previous      = current;
  94         previous_name = current_name;
  95       }
  96
  97       if (route.gw_dst_) {
  98         current      = new_xbt_graph_node(graph, route.gw_dst_->get_cname(), nodes);
  99         current_name = route.gw_dst_->get_cname();
 100       } else {
 101         current      = new_xbt_graph_node(graph, my_dst->get_cname(), nodes);
 102         current_name = my_dst->get_cname();
 103       }
 104       new_xbt_graph_edge(graph, previous, current, edges);
 105       XBT_DEBUG("  %s -> %s", previous_name, current_name);
 106     }
 107   }
 108 }
 109
 110 /* ************************************************************************** */
 111 /* ************************* GENERIC AUX FUNCTIONS ************************** */
 112 /* change a route containing link names into a route containing link entities */
 113 Route* RoutedZone::new_extended_route(RoutingMode hierarchy, NetPoint* gw_src, NetPoint* gw_dst,
 114                                       const std::vector<resource::StandardLinkImpl*>& link_list, bool preserve_order)
 115 {
 116   auto* result = new Route();
 117
 118   if (hierarchy == RoutingMode::recursive) {
 119     xbt_assert(gw_src && gw_dst, "nullptr is obviously a deficient gateway");
 120
 121     result->gw_src_ = gw_src;
 122     result->gw_dst_ = gw_dst;
 123   }
 124
 125   if (preserve_order)
 126     result->link_list_ = link_list;
 127   else
 128     result->link_list_.assign(link_list.rbegin(), link_list.rend()); // reversed
 129   result->link_list_.shrink_to_fit();
 130
 131   return result;
 132 }
 133
 134 void RoutedZone::get_route_check_params(const NetPoint* src, const NetPoint* dst) const
 135 {
 136   xbt_assert(src, "Cannot find a route from nullptr to %s", dst->get_cname());
 137   xbt_assert(dst, "Cannot find a route from %s to nullptr", src->get_cname());
 138
 139   const NetZoneImpl* src_as = src->get_englobing_zone();
 140   const NetZoneImpl* dst_as = dst->get_englobing_zone();
 141
 142   xbt_assert(src_as == dst_as,
 143              "Internal error: %s@%s and %s@%s are not in the same netzone as expected. Please report that bug.",
 144              src->get_cname(), src_as->get_cname(), dst->get_cname(), dst_as->get_cname());
 145
 146   xbt_assert(this == dst_as,
 147              "Internal error: route destination %s@%s is not in netzone %s as expected (route source: "
 148              "%s@%s). Please report that bug.",
 149              src->get_cname(), dst->get_cname(), src_as->get_cname(), dst_as->get_cname(), get_cname());
 150 }
 151 void RoutedZone::add_route_check_params(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
 152                                         const std::vector<s4u::LinkInRoute>& link_list, bool symmetrical) const
 153 {
 154   const char* srcName = src->get_cname();
 155   const char* dstName = dst->get_cname();
 156
 157   if (not gw_dst || not gw_src) {
 158     XBT_DEBUG("Load Route from \"%s\" to \"%s\"", srcName, dstName);
 159     xbt_assert(src, "Cannot add a route from %s to %s: %s does not exist.", srcName, dstName, srcName);
 160     xbt_assert(dst, "Cannot add a route from %s to %s: %s does not exist.", srcName, dstName, dstName);
 161     xbt_assert(not link_list.empty(), "Empty route (between %s and %s) forbidden.", srcName, dstName);
 162     xbt_assert(not src->is_netzone(),
 163                "When defining a route, src cannot be a netzone such as '%s'. Did you meant to have a NetzoneRoute?",
 164                srcName);
 165     xbt_assert(not dst->is_netzone(),
 166                "When defining a route, dst cannot be a netzone such as '%s'. Did you meant to have a NetzoneRoute?",
 167                dstName);
 168     s4u::NetZone::on_route_creation(symmetrical, src, dst, gw_src, gw_dst, get_link_list_impl(link_list, false));
 169     NetZoneImpl::on_route_creation(symmetrical, src, dst, gw_src, gw_dst, get_link_list_impl(link_list, false));
 170   } else {
 171     XBT_DEBUG("Load NetzoneRoute from %s@%s to %s@%s", srcName, gw_src->get_cname(), dstName, gw_dst->get_cname());
 172     xbt_assert(src->is_netzone(), "When defining a NetzoneRoute, src must be a netzone but '%s' is not", srcName);
 173     xbt_assert(dst->is_netzone(), "When defining a NetzoneRoute, dst must be a netzone but '%s' is not", dstName);
 174
 175     xbt_assert(gw_src->is_host() || gw_src->is_router(),
 176                "When defining a NetzoneRoute, gw_src must be a host or a router but '%s' is not.", srcName);
 177     xbt_assert(gw_dst->is_host() || gw_dst->is_router(),
 178                "When defining a NetzoneRoute, gw_dst must be a host or a router but '%s' is not.", dstName);
 179
 180     xbt_assert(gw_src != gw_dst, "Cannot define a NetzoneRoute from '%s' to itself", gw_src->get_cname());
 181
 182     xbt_assert(src, "Cannot add a route from %s@%s to %s@%s: %s does not exist.", srcName, gw_src->get_cname(), dstName,
 183                gw_dst->get_cname(), srcName);
 184     xbt_assert(dst, "Cannot add a route from %s@%s to %s@%s: %s does not exist.", srcName, gw_src->get_cname(), dstName,
 185                gw_dst->get_cname(), dstName);
 186     xbt_assert(not link_list.empty(), "Empty route (between %s@%s and %s@%s) forbidden.", srcName, gw_src->get_cname(),
 187                dstName, gw_dst->get_cname());
 188     const auto* netzone_src = get_netzone_recursive(src);
 189     xbt_assert(netzone_src->is_component_recursive(gw_src),
 190                "Invalid NetzoneRoute from %s@%s to %s@%s: gw_src %s belongs to %s, not to %s.", srcName,
 191                gw_src->get_cname(), dstName, gw_dst->get_cname(), gw_src->get_cname(),
 192                gw_src->get_englobing_zone()->get_cname(), srcName);
 193
 194     const auto* netzone_dst = get_netzone_recursive(dst);
 195     xbt_assert(netzone_dst->is_component_recursive(gw_dst),
 196                "Invalid NetzoneRoute from %s@%s to %s@%s: gw_dst %s belongs to %s, not to %s.", srcName,
 197                gw_src->get_cname(), dstName, gw_dst->get_cname(), gw_dst->get_cname(),
 198                gw_dst->get_englobing_zone()->get_cname(), dst->get_cname());
 199     s4u::NetZone::on_route_creation(symmetrical, gw_src, gw_dst, gw_src, gw_dst, get_link_list_impl(link_list, false));
 200     NetZoneImpl::on_route_creation(symmetrical, gw_src, gw_dst, gw_src, gw_dst, get_link_list_impl(link_list, false));
 201   }
 202 }
 203 } // namespace routing
 204 } // namespace kernel
 205 } // namespace simgrid