src/kernel/routing/RoutedZone.cpp

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