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 namespace simgrid::kernel::routing {
  20
  21 RoutedZone::RoutedZone(const std::string& name) : NetZoneImpl(name) {}
  22
  23 void RoutedZone::get_graph(const s_xbt_graph_t* graph, std::map<std::string, xbt_node_t, std::less<>>* nodes,
  24                            std::map<std::string, xbt_edge_t, std::less<>>* edges)
  25 {
  26   std::vector<NetPoint*> vertices = get_vertices();
  27
  28   for (auto const& my_src : vertices) {
  29     for (auto const& my_dst : vertices) {
  30       if (my_src == my_dst)
  31         continue;
  32
  33       Route route;
  34
  35       get_local_route(my_src, my_dst, &route, nullptr);
  36
  37       XBT_DEBUG("get_route_and_latency %s -> %s", my_src->get_cname(), my_dst->get_cname());
  38
  39       xbt_node_t current;
  40       xbt_node_t previous;
  41       const char* previous_name;
  42       const char* current_name;
  43
  44       if (route.gw_src_) {
  45         previous      = new_xbt_graph_node(graph, route.gw_src_->get_cname(), nodes);
  46         previous_name = route.gw_src_->get_cname();
  47       } else {
  48         previous      = new_xbt_graph_node(graph, my_src->get_cname(), nodes);
  49         previous_name = my_src->get_cname();
  50       }
  51
  52       for (auto const& link : route.link_list_) {
  53         const char* link_name = link->get_cname();
  54         current               = new_xbt_graph_node(graph, link_name, nodes);
  55         current_name          = link_name;
  56         new_xbt_graph_edge(graph, previous, current, edges);
  57         XBT_DEBUG("  %s -> %s", previous_name, current_name);
  58         previous      = current;
  59         previous_name = current_name;
  60       }
  61
  62       if (route.gw_dst_) {
  63         current      = new_xbt_graph_node(graph, route.gw_dst_->get_cname(), nodes);
  64         current_name = route.gw_dst_->get_cname();
  65       } else {
  66         current      = new_xbt_graph_node(graph, my_dst->get_cname(), nodes);
  67         current_name = my_dst->get_cname();
  68       }
  69       new_xbt_graph_edge(graph, previous, current, edges);
  70       XBT_DEBUG("  %s -> %s", previous_name, current_name);
  71     }
  72   }
  73 }
  74
  75 /* ************************************************************************** */
  76 /* ************************* GENERIC AUX FUNCTIONS ************************** */
  77 /* change a route containing link names into a route containing link entities */
  78 Route* RoutedZone::new_extended_route(RoutingMode hierarchy, NetPoint* gw_src, NetPoint* gw_dst,
  79                                       const std::vector<resource::StandardLinkImpl*>& link_list, bool preserve_order)
  80 {
  81   auto* result = new Route();
  82
  83   if (hierarchy == RoutingMode::recursive) {
  84     xbt_assert(gw_src && gw_dst, "nullptr is obviously a deficient gateway");
  85
  86     result->gw_src_ = gw_src;
  87     result->gw_dst_ = gw_dst;
  88   }
  89
  90   if (preserve_order)
  91     result->link_list_ = link_list;
  92   else
  93     result->link_list_.assign(link_list.rbegin(), link_list.rend()); // reversed
  94   result->link_list_.shrink_to_fit();
  95
  96   return result;
  97 }
  98
  99 void RoutedZone::get_route_check_params(const NetPoint* src, const NetPoint* dst) const
 100 {
 101   xbt_assert(src, "Cannot find a route from nullptr to %s", dst->get_cname());
 102   xbt_assert(dst, "Cannot find a route from %s to nullptr", src->get_cname());
 103
 104   const NetZoneImpl* src_as = src->get_englobing_zone();
 105   const NetZoneImpl* dst_as = dst->get_englobing_zone();
 106
 107   xbt_assert(src_as == dst_as,
 108              "Internal error: %s@%s and %s@%s are not in the same netzone as expected. Please report that bug.",
 109              src->get_cname(), src_as->get_cname(), dst->get_cname(), dst_as->get_cname());
 110
 111   xbt_assert(this == dst_as,
 112              "Internal error: route destination %s@%s is not in netzone %s as expected (route source: "
 113              "%s@%s). Please report that bug.",
 114              src->get_cname(), dst->get_cname(), src_as->get_cname(), dst_as->get_cname(), get_cname());
 115 }
 116 void RoutedZone::add_route_check_params(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
 117                                         const std::vector<s4u::LinkInRoute>& link_list, bool symmetrical) const
 118 {
 119   const char* srcName = src->get_cname();
 120   const char* dstName = dst->get_cname();
 121
 122   if (not gw_dst || not gw_src) {
 123     XBT_DEBUG("Load Route from \"%s\" to \"%s\"", srcName, dstName);
 124     xbt_assert(src, "Cannot add a route from %s to %s: %s does not exist.", srcName, dstName, srcName);
 125     xbt_assert(dst, "Cannot add a route from %s to %s: %s does not exist.", srcName, dstName, dstName);
 126     xbt_assert(not link_list.empty(), "Empty route (between %s and %s) forbidden.", srcName, dstName);
 127     xbt_assert(not src->is_netzone(),
 128                "When defining a route, src cannot be a netzone such as '%s'. Did you meant to have a NetzoneRoute?",
 129                srcName);
 130     xbt_assert(not dst->is_netzone(),
 131                "When defining a route, dst cannot be a netzone such as '%s'. Did you meant to have a NetzoneRoute?",
 132                dstName);
 133     NetZoneImpl::on_route_creation(symmetrical, src, dst, gw_src, gw_dst, get_link_list_impl(link_list, false));
 134   } else {
 135     XBT_DEBUG("Load NetzoneRoute from %s@%s to %s@%s", srcName, gw_src->get_cname(), dstName, gw_dst->get_cname());
 136     xbt_assert(src->is_netzone(), "When defining a NetzoneRoute, src must be a netzone but '%s' is not", srcName);
 137     xbt_assert(dst->is_netzone(), "When defining a NetzoneRoute, dst must be a netzone but '%s' is not", dstName);
 138
 139     xbt_assert(gw_src->is_host() || gw_src->is_router(),
 140                "When defining a NetzoneRoute, gw_src must be a host or a router but '%s' is not.", srcName);
 141     xbt_assert(gw_dst->is_host() || gw_dst->is_router(),
 142                "When defining a NetzoneRoute, gw_dst must be a host or a router but '%s' is not.", dstName);
 143
 144     xbt_assert(gw_src != gw_dst, "Cannot define a NetzoneRoute from '%s' to itself", gw_src->get_cname());
 145
 146     xbt_assert(src, "Cannot add a route from %s@%s to %s@%s: %s does not exist.", srcName, gw_src->get_cname(), dstName,
 147                gw_dst->get_cname(), srcName);
 148     xbt_assert(dst, "Cannot add a route from %s@%s to %s@%s: %s does not exist.", srcName, gw_src->get_cname(), dstName,
 149                gw_dst->get_cname(), dstName);
 150     xbt_assert(not link_list.empty(), "Empty route (between %s@%s and %s@%s) forbidden.", srcName, gw_src->get_cname(),
 151                dstName, gw_dst->get_cname());
 152     const auto* netzone_src = get_netzone_recursive(src);
 153     xbt_assert(netzone_src->is_component_recursive(gw_src),
 154                "Invalid NetzoneRoute from %s@%s to %s@%s: gw_src %s belongs to %s, not to %s.", srcName,
 155                gw_src->get_cname(), dstName, gw_dst->get_cname(), gw_src->get_cname(),
 156                gw_src->get_englobing_zone()->get_cname(), srcName);
 157
 158     const auto* netzone_dst = get_netzone_recursive(dst);
 159     xbt_assert(netzone_dst->is_component_recursive(gw_dst),
 160                "Invalid NetzoneRoute from %s@%s to %s@%s: gw_dst %s belongs to %s, not to %s.", srcName,
 161                gw_src->get_cname(), dstName, gw_dst->get_cname(), gw_dst->get_cname(),
 162                gw_dst->get_englobing_zone()->get_cname(), dst->get_cname());
 163     NetZoneImpl::on_route_creation(symmetrical, gw_src, gw_dst, gw_src, gw_dst, get_link_list_impl(link_list, false));
 164   }
 165 }
 166 } // namespace simgrid::kernel::routing