-/* Copyright (c) 2009-2017. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2009-2023. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
+#include "simgrid/kernel/routing/RoutedZone.hpp"
+#include "simgrid/kernel/routing/NetPoint.hpp"
+#include "src/kernel/resource/StandardLinkImpl.hpp"
#include "xbt/dict.h"
#include "xbt/graph.h"
#include "xbt/log.h"
#include "xbt/sysdep.h"
+#include "xbt/asserts.hpp"
-#include "src/kernel/routing/NetPoint.hpp"
-#include "src/kernel/routing/RoutedZone.hpp"
-#include "src/surf/network_interface.hpp"
-
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_routing_generic, surf_route, "Generic implementation of the surf routing");
-
-void routing_route_free(sg_platf_route_cbarg_t route)
-{
- if (route) {
- delete route->link_list;
- delete route;
- }
-}
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_routing_generic, ker_platform, "Kernel Generic Routing");
/* ***************************************************************** */
/* *********************** GENERIC METHODS ************************* */
-static const char* instr_node_name(xbt_node_t node)
-{
- void* data = xbt_graph_node_get_data(node);
- return static_cast<const char*>(data);
-}
-
-xbt_node_t new_xbt_graph_node(xbt_graph_t graph, const char* name, xbt_dict_t nodes)
-{
- xbt_node_t ret = static_cast<xbt_node_t>(xbt_dict_get_or_null(nodes, name));
- if (ret)
- return ret;
-
- ret = xbt_graph_new_node(graph, xbt_strdup(name));
- xbt_dict_set(nodes, name, ret, nullptr);
- return ret;
-}
-
-xbt_edge_t new_xbt_graph_edge(xbt_graph_t graph, xbt_node_t s, xbt_node_t d, xbt_dict_t edges)
-{
- const char* sn = instr_node_name(s);
- const char* dn = instr_node_name(d);
- std::string name = std::string(sn) + dn;
-
- xbt_edge_t ret = static_cast<xbt_edge_t>(xbt_dict_get_or_null(edges, name.c_str()));
- if (ret == nullptr) {
- name = std::string(dn) + sn;
- ret = static_cast<xbt_edge_t>(xbt_dict_get_or_null(edges, name.c_str()));
- }
-
- if (ret == nullptr) {
- ret = xbt_graph_new_edge(graph, s, d, nullptr);
- xbt_dict_set(edges, name.c_str(), ret, nullptr);
- }
- return ret;
-}
+namespace simgrid::kernel::routing {
-namespace simgrid {
-namespace kernel {
-namespace routing {
-
-RoutedZone::RoutedZone(NetZone* father, std::string name) : NetZoneImpl(father, name)
-{
-}
-
-void RoutedZone::getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges)
-{
- std::vector<kernel::routing::NetPoint*> vertices = getVertices();
-
- for (auto const& my_src : vertices) {
- for (auto const& my_dst : vertices) {
- if (my_src == my_dst)
- continue;
-
- sg_platf_route_cbarg_t route = new s_sg_platf_route_cbarg_t;
- route->link_list = new std::vector<surf::LinkImpl*>();
-
- getLocalRoute(my_src, my_dst, route, nullptr);
-
- XBT_DEBUG("get_route_and_latency %s -> %s", my_src->cname(), my_dst->cname());
-
- xbt_node_t current;
- xbt_node_t previous;
- const char *previous_name;
- const char *current_name;
-
- if (route->gw_src) {
- previous = new_xbt_graph_node(graph, route->gw_src->cname(), nodes);
- previous_name = route->gw_src->cname();
- } else {
- previous = new_xbt_graph_node(graph, my_src->cname(), nodes);
- previous_name = my_src->cname();
- }
-
- for (auto const& link : *route->link_list) {
- const char* link_name = link->cname();
- current = new_xbt_graph_node(graph, link_name, nodes);
- current_name = link_name;
- new_xbt_graph_edge(graph, previous, current, edges);
- XBT_DEBUG(" %s -> %s", previous_name, current_name);
- previous = current;
- previous_name = current_name;
- }
-
- if (route->gw_dst) {
- current = new_xbt_graph_node(graph, route->gw_dst->cname(), nodes);
- current_name = route->gw_dst->cname();
- } else {
- current = new_xbt_graph_node(graph, my_dst->cname(), nodes);
- current_name = my_dst->cname();
- }
- new_xbt_graph_edge(graph, previous, current, edges);
- XBT_DEBUG(" %s -> %s", previous_name, current_name);
-
- delete route->link_list;
- delete route;
- }
- }
-}
+RoutedZone::RoutedZone(const std::string& name) : NetZoneImpl(name) {}
/* ************************************************************************** */
/* ************************* GENERIC AUX FUNCTIONS ************************** */
/* change a route containing link names into a route containing link entities */
-sg_platf_route_cbarg_t RoutedZone::newExtendedRoute(RoutingMode hierarchy, sg_platf_route_cbarg_t routearg,
- bool change_order)
+Route* RoutedZone::new_extended_route(RoutingMode hierarchy, NetPoint* gw_src, NetPoint* gw_dst,
+ const std::vector<resource::StandardLinkImpl*>& link_list, bool preserve_order)
{
- sg_platf_route_cbarg_t result;
-
- result = new s_sg_platf_route_cbarg_t;
- result->link_list = new std::vector<surf::LinkImpl*>();
-
- xbt_assert(hierarchy == RoutingMode::base || hierarchy == RoutingMode::recursive,
- "The hierarchy of this netzone is neither BASIC nor RECURSIVE, I'm lost here.");
+ xbt_enforce(hierarchy != RoutingMode::recursive || (gw_src && gw_dst), "nullptr is obviously a deficient gateway");
+ auto* result = new Route();
if (hierarchy == RoutingMode::recursive) {
- xbt_assert(routearg->gw_src && routearg->gw_dst, "nullptr is obviously a deficient gateway");
-
- result->gw_src = routearg->gw_src;
- result->gw_dst = routearg->gw_dst;
+ result->gw_src_ = gw_src;
+ result->gw_dst_ = gw_dst;
}
- for (auto const& link : *routearg->link_list) {
- if (change_order)
- result->link_list->push_back(link);
- else
- result->link_list->insert(result->link_list->begin(), link);
- }
- result->link_list->shrink_to_fit();
+ if (preserve_order)
+ result->link_list_ = link_list;
+ else
+ result->link_list_.assign(link_list.rbegin(), link_list.rend()); // reversed
+ result->link_list_.shrink_to_fit();
return result;
}
-void RoutedZone::getRouteCheckParams(NetPoint* src, NetPoint* dst)
+void RoutedZone::get_route_check_params(const NetPoint* src, const NetPoint* dst) const
{
- xbt_assert(src, "Cannot find a route from nullptr to %s", dst->cname());
- xbt_assert(dst, "Cannot find a route from %s to nullptr", src->cname());
+ xbt_enforce(src, "Cannot have a route with (nullptr) source");
+ xbt_enforce(dst, "Cannot have a route with (nullptr) destination");
- NetZone* src_as = src->netzone();
- NetZone* dst_as = dst->netzone();
+ const NetZoneImpl* src_as = src->get_englobing_zone();
+ const NetZoneImpl* dst_as = dst->get_englobing_zone();
- xbt_assert(src_as == dst_as,
+ xbt_enforce(src_as == dst_as,
"Internal error: %s@%s and %s@%s are not in the same netzone as expected. Please report that bug.",
- src->cname(), src_as->getCname(), dst->cname(), dst_as->getCname());
+ src->get_cname(), src_as->get_cname(), dst->get_cname(), dst_as->get_cname());
- xbt_assert(this == dst_as, "Internal error: route destination %s@%s is not in netzone %s as expected (route source: "
- "%s@%s). Please report that bug.",
- src->cname(), dst->cname(), src_as->getCname(), dst_as->getCname(), getCname());
+ xbt_enforce(this == dst_as,
+ "Internal error: route destination %s@%s is not in netzone %s as expected (route source: "
+ "%s@%s). Please report that bug.",
+ src->get_cname(), dst->get_cname(), src_as->get_cname(), dst_as->get_cname(), get_cname());
}
-void RoutedZone::addRouteCheckParams(sg_platf_route_cbarg_t route)
+
+void RoutedZone::add_route_check_params(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
+ const std::vector<s4u::LinkInRoute>& link_list, bool symmetrical) const
{
- NetPoint* src = route->src;
- NetPoint* dst = route->dst;
- const char* srcName = src->cname();
- const char* dstName = dst->cname();
+ get_route_check_params(src, dst);
+ const char* srcName = src->get_cname();
+ const char* dstName = dst->get_cname();
- if (not route->gw_dst || not route->gw_src) {
+ if (not gw_dst || not gw_src) {
XBT_DEBUG("Load Route from \"%s\" to \"%s\"", srcName, dstName);
- xbt_assert(src, "Cannot add a route from %s to %s: %s does not exist.", srcName, dstName, srcName);
- xbt_assert(dst, "Cannot add a route from %s to %s: %s does not exist.", srcName, dstName, dstName);
- xbt_assert(not route->link_list->empty(), "Empty route (between %s and %s) forbidden.", srcName, dstName);
- xbt_assert(not src->isNetZone(),
- "When defining a route, src cannot be a netzone such as '%s'. Did you meant to have an NetzoneRoute?",
+ xbt_enforce(not link_list.empty(), "Empty route (between %s and %s) forbidden.", srcName, dstName);
+ xbt_enforce(not src->is_netzone(),
+ "When defining a route, src cannot be a netzone such as '%s'. Did you meant to have a NetzoneRoute?",
srcName);
- xbt_assert(not dst->isNetZone(),
- "When defining a route, dst cannot be a netzone such as '%s'. Did you meant to have an NetzoneRoute?",
+ xbt_enforce(not dst->is_netzone(),
+ "When defining a route, dst cannot be a netzone such as '%s'. Did you meant to have a NetzoneRoute?",
dstName);
+ NetZoneImpl::on_route_creation(symmetrical, src, dst, gw_src, gw_dst, get_link_list_impl(link_list, false));
} else {
- XBT_DEBUG("Load NetzoneRoute from %s@%s to %s@%s", srcName, route->gw_src->cname(), dstName, route->gw_dst->cname());
- xbt_assert(src->isNetZone(), "When defining a NetzoneRoute, src must be a netzone but '%s' is not", srcName);
- xbt_assert(dst->isNetZone(), "When defining a NetzoneRoute, dst must be a netzone but '%s' is not", dstName);
-
- xbt_assert(route->gw_src->isHost() || route->gw_src->isRouter(),
- "When defining a NetzoneRoute, gw_src must be an host or a router but '%s' is not.", srcName);
- xbt_assert(route->gw_dst->isHost() || route->gw_dst->isRouter(),
- "When defining a NetzoneRoute, gw_dst must be an host or a router but '%s' is not.", dstName);
-
- xbt_assert(route->gw_src != route->gw_dst, "Cannot define an NetzoneRoute from '%s' to itself", route->gw_src->cname());
-
- xbt_assert(src, "Cannot add a route from %s@%s to %s@%s: %s does not exist.", srcName, route->gw_src->cname(),
- dstName, route->gw_dst->cname(), srcName);
- xbt_assert(dst, "Cannot add a route from %s@%s to %s@%s: %s does not exist.", srcName, route->gw_src->cname(),
- dstName, route->gw_dst->cname(), dstName);
- xbt_assert(not route->link_list->empty(), "Empty route (between %s@%s and %s@%s) forbidden.", srcName,
- route->gw_src->cname(), dstName, route->gw_dst->cname());
+ XBT_DEBUG("Load NetzoneRoute from %s@%s to %s@%s", srcName, gw_src->get_cname(), dstName, gw_dst->get_cname());
+ xbt_enforce(src->is_netzone(), "When defining a NetzoneRoute, src must be a netzone but '%s' is not", srcName);
+ xbt_enforce(dst->is_netzone(), "When defining a NetzoneRoute, dst must be a netzone but '%s' is not", dstName);
+
+ xbt_enforce(gw_src->is_host() || gw_src->is_router(),
+ "When defining a NetzoneRoute, gw_src must be a host or a router but '%s' is not.", srcName);
+ xbt_enforce(gw_dst->is_host() || gw_dst->is_router(),
+ "When defining a NetzoneRoute, gw_dst must be a host or a router but '%s' is not.", dstName);
+
+ xbt_enforce(gw_src != gw_dst, "Cannot define a NetzoneRoute from '%s' to itself", gw_src->get_cname());
+
+ xbt_enforce(src, "Cannot add a route from %s@%s to %s@%s: %s does not exist.", srcName, gw_src->get_cname(), dstName,
+ gw_dst->get_cname(), srcName);
+ xbt_enforce(dst, "Cannot add a route from %s@%s to %s@%s: %s does not exist.", srcName, gw_src->get_cname(), dstName,
+ gw_dst->get_cname(), dstName);
+ xbt_enforce(not link_list.empty(), "Empty route (between %s@%s and %s@%s) forbidden.", srcName, gw_src->get_cname(),
+ dstName, gw_dst->get_cname());
+ const auto* netzone_src = get_netzone_recursive(src);
+ xbt_enforce(netzone_src->is_component_recursive(gw_src),
+ "Invalid NetzoneRoute from %s@%s to %s@%s: gw_src %s belongs to %s, not to %s.", srcName,
+ gw_src->get_cname(), dstName, gw_dst->get_cname(), gw_src->get_cname(),
+ gw_src->get_englobing_zone()->get_cname(), srcName);
+
+ const auto* netzone_dst = get_netzone_recursive(dst);
+ xbt_enforce(netzone_dst->is_component_recursive(gw_dst),
+ "Invalid NetzoneRoute from %s@%s to %s@%s: gw_dst %s belongs to %s, not to %s.", srcName,
+ gw_src->get_cname(), dstName, gw_dst->get_cname(), gw_dst->get_cname(),
+ gw_dst->get_englobing_zone()->get_cname(), dst->get_cname());
+ NetZoneImpl::on_route_creation(symmetrical, gw_src, gw_dst, gw_src, gw_dst, get_link_list_impl(link_list, false));
}
-
- onRouteCreation(route->symmetrical, route->src, route->dst, route->gw_src, route->gw_dst, route->link_list);
-}
-}
-}
}
+} // namespace simgrid::kernel::routing