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 #include "xbt/asserts.hpp"
  14
  15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_routing_generic, ker_routing, "Kernel Generic Routing");
  16
  17 /* ***************************************************************** */
  18 /* *********************** GENERIC METHODS ************************* */
  19
  20 namespace simgrid::kernel::routing {
  21
  22 RoutedZone::RoutedZone(const std::string& name) : NetZoneImpl(name) {}
  23
  24 /* ************************************************************************** */
  25 /* ************************* GENERIC AUX FUNCTIONS ************************** */
  26 /* change a route containing link names into a route containing link entities */
  27 Route* RoutedZone::new_extended_route(RoutingMode hierarchy, NetPoint* gw_src, NetPoint* gw_dst,
  28                                       const std::vector<resource::StandardLinkImpl*>& link_list, bool preserve_order)
  29 {
  30   auto* result = new Route();
  31
  32   if (hierarchy == RoutingMode::recursive) {
  33     xbt_enforce(gw_src && gw_dst, "nullptr is obviously a deficient gateway");
  34
  35     result->gw_src_ = gw_src;
  36     result->gw_dst_ = gw_dst;
  37   }
  38
  39   if (preserve_order)
  40     result->link_list_ = link_list;
  41   else
  42     result->link_list_.assign(link_list.rbegin(), link_list.rend()); // reversed
  43   result->link_list_.shrink_to_fit();
  44
  45   return result;
  46 }
  47
  48 void RoutedZone::get_route_check_params(const NetPoint* src, const NetPoint* dst) const
  49 {
  50   xbt_enforce(src, "Cannot have a route with (nullptr) source");
  51   xbt_enforce(dst, "Cannot have a route with (nullptr) destination");
  52
  53   const NetZoneImpl* src_as = src->get_englobing_zone();
  54   const NetZoneImpl* dst_as = dst->get_englobing_zone();
  55
  56   xbt_enforce(src_as == dst_as,
  57              "Internal error: %s@%s and %s@%s are not in the same netzone as expected. Please report that bug.",
  58              src->get_cname(), src_as->get_cname(), dst->get_cname(), dst_as->get_cname());
  59
  60   xbt_enforce(this == dst_as,
  61              "Internal error: route destination %s@%s is not in netzone %s as expected (route source: "
  62              "%s@%s). Please report that bug.",
  63              src->get_cname(), dst->get_cname(), src_as->get_cname(), dst_as->get_cname(), get_cname());
  64 }
  65
  66 void RoutedZone::add_route_check_params(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
  67                                         const std::vector<s4u::LinkInRoute>& link_list, bool symmetrical) const
  68 {
  69   get_route_check_params(src, dst);
  70   const char* srcName = src->get_cname();
  71   const char* dstName = dst->get_cname();
  72
  73   if (not gw_dst || not gw_src) {
  74     XBT_DEBUG("Load Route from \"%s\" to \"%s\"", srcName, dstName);
  75     xbt_enforce(not link_list.empty(), "Empty route (between %s and %s) forbidden.", srcName, dstName);
  76     xbt_enforce(not src->is_netzone(),
  77                "When defining a route, src cannot be a netzone such as '%s'. Did you meant to have a NetzoneRoute?",
  78                srcName);
  79     xbt_enforce(not dst->is_netzone(),
  80                "When defining a route, dst cannot be a netzone such as '%s'. Did you meant to have a NetzoneRoute?",
  81                dstName);
  82     NetZoneImpl::on_route_creation(symmetrical, src, dst, gw_src, gw_dst, get_link_list_impl(link_list, false));
  83   } else {
  84     XBT_DEBUG("Load NetzoneRoute from %s@%s to %s@%s", srcName, gw_src->get_cname(), dstName, gw_dst->get_cname());
  85     xbt_enforce(src->is_netzone(), "When defining a NetzoneRoute, src must be a netzone but '%s' is not", srcName);
  86     xbt_enforce(dst->is_netzone(), "When defining a NetzoneRoute, dst must be a netzone but '%s' is not", dstName);
  87
  88     xbt_enforce(gw_src->is_host() || gw_src->is_router(),
  89                "When defining a NetzoneRoute, gw_src must be a host or a router but '%s' is not.", srcName);
  90     xbt_enforce(gw_dst->is_host() || gw_dst->is_router(),
  91                "When defining a NetzoneRoute, gw_dst must be a host or a router but '%s' is not.", dstName);
  92
  93     xbt_enforce(gw_src != gw_dst, "Cannot define a NetzoneRoute from '%s' to itself", gw_src->get_cname());
  94
  95     xbt_enforce(src, "Cannot add a route from %s@%s to %s@%s: %s does not exist.", srcName, gw_src->get_cname(), dstName,
  96                gw_dst->get_cname(), srcName);
  97     xbt_enforce(dst, "Cannot add a route from %s@%s to %s@%s: %s does not exist.", srcName, gw_src->get_cname(), dstName,
  98                gw_dst->get_cname(), dstName);
  99     xbt_enforce(not link_list.empty(), "Empty route (between %s@%s and %s@%s) forbidden.", srcName, gw_src->get_cname(),
 100                dstName, gw_dst->get_cname());
 101     const auto* netzone_src = get_netzone_recursive(src);
 102     xbt_enforce(netzone_src->is_component_recursive(gw_src),
 103                "Invalid NetzoneRoute from %s@%s to %s@%s: gw_src %s belongs to %s, not to %s.", srcName,
 104                gw_src->get_cname(), dstName, gw_dst->get_cname(), gw_src->get_cname(),
 105                gw_src->get_englobing_zone()->get_cname(), srcName);
 106
 107     const auto* netzone_dst = get_netzone_recursive(dst);
 108     xbt_enforce(netzone_dst->is_component_recursive(gw_dst),
 109                "Invalid NetzoneRoute from %s@%s to %s@%s: gw_dst %s belongs to %s, not to %s.", srcName,
 110                gw_src->get_cname(), dstName, gw_dst->get_cname(), gw_dst->get_cname(),
 111                gw_dst->get_englobing_zone()->get_cname(), dst->get_cname());
 112     NetZoneImpl::on_route_creation(symmetrical, gw_src, gw_dst, gw_src, gw_dst, get_link_list_impl(link_list, false));
 113   }
 114 }
 115 } // namespace simgrid::kernel::routing