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