src/kernel/routing/RoutedZone.cpp

   1 /* Copyright (c) 2009-2018. 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 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::get_graph(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 = get_vertices();
  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       RouteCreationArgs* route = new RouteCreationArgs();
  77
  78       get_local_route(my_src, my_dst, route, nullptr);
  79
  80       XBT_DEBUG("get_route_and_latency %s -> %s", my_src->get_cname(), my_dst->get_cname());
  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->get_cname(), nodes);
  89         previous_name = route->gw_src->get_cname();
  90       } else {
  91         previous      = new_xbt_graph_node(graph, my_src->get_cname(), nodes);
  92         previous_name = my_src->get_cname();
  93       }
  94
  95       for (auto const& link : route->link_list) {
  96         const char* link_name = link->get_cname();
  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->get_cname(), nodes);
 107         current_name = route->gw_dst->get_cname();
 108       } else {
 109         current      = new_xbt_graph_node(graph, my_dst->get_cname(), nodes);
 110         current_name = my_dst->get_cname();
 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 RouteCreationArgs* RoutedZone::newExtendedRoute(RoutingMode hierarchy, NetPoint* src, NetPoint* dst, NetPoint* gw_src,
 124                                                 NetPoint* gw_dst, std::vector<resource::LinkImpl*>& link_list,
 125                                                 bool symmetrical, bool change_order)
 126 {
 127   RouteCreationArgs* result = new RouteCreationArgs();
 128
 129   xbt_assert(hierarchy == RoutingMode::base || hierarchy == RoutingMode::recursive,
 130              "The hierarchy of this netzone is neither BASIC nor RECURSIVE, I'm lost here.");
 131
 132   if (hierarchy == RoutingMode::recursive) {
 133     xbt_assert(gw_src && gw_dst, "nullptr is obviously a deficient gateway");
 134
 135     result->gw_src = gw_src;
 136     result->gw_dst = gw_dst;
 137   }
 138
 139   for (auto const& link : link_list) {
 140     if (change_order)
 141       result->link_list.push_back(link);
 142     else
 143       result->link_list.insert(result->link_list.begin(), link);
 144   }
 145   result->link_list.shrink_to_fit();
 146
 147   return result;
 148 }
 149
 150 void RoutedZone::getRouteCheckParams(NetPoint* src, NetPoint* dst)
 151 {
 152   xbt_assert(src, "Cannot find a route from nullptr to %s", dst->get_cname());
 153   xbt_assert(dst, "Cannot find a route from %s to nullptr", src->get_cname());
 154
 155   NetZone* src_as = src->get_englobing_zone();
 156   NetZone* dst_as = dst->get_englobing_zone();
 157
 158   xbt_assert(src_as == dst_as,
 159              "Internal error: %s@%s and %s@%s are not in the same netzone as expected. Please report that bug.",
 160              src->get_cname(), src_as->get_cname(), dst->get_cname(), dst_as->get_cname());
 161
 162   xbt_assert(this == dst_as,
 163              "Internal error: route destination %s@%s is not in netzone %s as expected (route source: "
 164              "%s@%s). Please report that bug.",
 165              src->get_cname(), dst->get_cname(), src_as->get_cname(), dst_as->get_cname(), get_cname());
 166 }
 167 void RoutedZone::addRouteCheckParams(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
 168                                      std::vector<resource::LinkImpl*>& link_list, bool symmetrical)
 169 {
 170   const char* srcName = src->get_cname();
 171   const char* dstName = dst->get_cname();
 172
 173   if (not gw_dst || not gw_src) {
 174     XBT_DEBUG("Load Route from \"%s\" to \"%s\"", srcName, dstName);
 175     xbt_assert(src, "Cannot add a route from %s to %s: %s does not exist.", srcName, dstName, srcName);
 176     xbt_assert(dst, "Cannot add a route from %s to %s: %s does not exist.", srcName, dstName, dstName);
 177     xbt_assert(not link_list.empty(), "Empty route (between %s and %s) forbidden.", srcName, dstName);
 178     xbt_assert(not src->is_netzone(),
 179                "When defining a route, src cannot be a netzone such as '%s'. Did you meant to have an NetzoneRoute?",
 180                srcName);
 181     xbt_assert(not dst->is_netzone(),
 182                "When defining a route, dst cannot be a netzone such as '%s'. Did you meant to have an NetzoneRoute?",
 183                dstName);
 184   } else {
 185     XBT_DEBUG("Load NetzoneRoute from %s@%s to %s@%s", srcName, gw_src->get_cname(), dstName, gw_dst->get_cname());
 186     xbt_assert(src->is_netzone(), "When defining a NetzoneRoute, src must be a netzone but '%s' is not", srcName);
 187     xbt_assert(dst->is_netzone(), "When defining a NetzoneRoute, dst must be a netzone but '%s' is not", dstName);
 188
 189     xbt_assert(gw_src->is_host() || gw_src->is_router(),
 190                "When defining a NetzoneRoute, gw_src must be an host or a router but '%s' is not.", srcName);
 191     xbt_assert(gw_dst->is_host() || gw_dst->is_router(),
 192                "When defining a NetzoneRoute, gw_dst must be an host or a router but '%s' is not.", dstName);
 193
 194     xbt_assert(gw_src != gw_dst, "Cannot define an NetzoneRoute from '%s' to itself", gw_src->get_cname());
 195
 196     xbt_assert(src, "Cannot add a route from %s@%s to %s@%s: %s does not exist.", srcName, gw_src->get_cname(), dstName,
 197                gw_dst->get_cname(), srcName);
 198     xbt_assert(dst, "Cannot add a route from %s@%s to %s@%s: %s does not exist.", srcName, gw_src->get_cname(), dstName,
 199                gw_dst->get_cname(), dstName);
 200     xbt_assert(not link_list.empty(), "Empty route (between %s@%s and %s@%s) forbidden.", srcName, gw_src->get_cname(),
 201                dstName, gw_dst->get_cname());
 202   }
 203
 204   on_route_creation(symmetrical, src, dst, gw_src, gw_dst, link_list);
 205 }
 206 }
 207 }
 208 }