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