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