--- /dev/null
+/* Copyright (c) 2016. 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. */
+
+#ifndef SIMGRID_S4U_AS_HPP
+#define SIMGRID_S4U_AS_HPP
+
+#include "xbt/base.h"
+#include "xbt/graph.h"
+
+#include "simgrid/s4u/forward.hpp"
+#include <vector>
+#include <map>
+
+#include "src/surf/xml/platf_private.hpp" // FIXME: kill sg_platf_route_cbarg_t to remove that UGLY include
+
+namespace simgrid {
+
+namespace surf {
+ class Link;
+ class NetCard;
+ class RoutingPlatf; // FIXME: KILLME
+}
+namespace s4u {
+
+/** @brief Autonomous Systems
+ *
+ * An AS is a network container, in charge of routing information between elements (hosts) and to the nearby ASes.
+ * In SimGrid, there is a hierarchy of ASes, with a unique root AS (that you can retrieve from the s4u::Engine).
+ */
+XBT_PUBLIC_CLASS As {
+protected:
+ As(const char *name);
+ virtual ~As();
+
+public:
+ /** @brief Seal your AS once you're done adding content, and before routing stuff through it */
+ virtual void Seal();
+ char *name();
+ As *father();;
+ xbt_dict_t children(); // Sub AS
+ xbt_dynar_t hosts(); // my content
+
+
+public:
+ /**
+ * @brief Probe the routing path between two points
+ *
+ * The networking model uses this function when creating a communication
+ * to retrieve both the list of links that the create communication will use,
+ * and the summed latency that these links represent.
+ *
+ * The network could recompute the latency by itself from the list, but it would
+ * require an additional link set traversal. This operation being on the critical
+ * path of SimGrid, the routing computes the latency in behalf of the network.
+ *
+ * Things are rather complex here because we have to find the path from ASes to ASes, and within each.
+ * In addition, the different ASes may use differing routing models.
+ * Some ASes may be routed in full, others may have only some connection information and use a shortest path on top of that, and so on.
+ * Some ASes may even not have any predefined links and use only coordinate informations to compute the latency.
+ *
+ * So, the path is constructed recursively, with each traversed AS adding its information to the set.
+ * The algorithm for that is explained in http://hal.inria.fr/hal-00650233/
+ *
+ * @param src Initial point of the routing path
+ * @param dst Final point of the routing path
+ * @param into Container into which the traversed links should be pushed
+ * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
+ */
+ virtual void getRouteAndLatency(surf::NetCard *src, surf::NetCard *dst, sg_platf_route_cbarg_t into, double *latency)=0;
+ /** @brief retrieves the list of all routes of size 1 (of type src x dst x Link) */
+ virtual xbt_dynar_t getOneLinkRoutes();
+
+ virtual void getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges)=0;
+
+ /* Add content to the AS, at parsing time. It should be sealed afterward. */
+ virtual int addComponent(surf::NetCard *elm); /* A host, a router or an AS, whatever */
+ virtual void addRoute(sg_platf_route_cbarg_t route);
+ void addBypassRoute(sg_platf_route_cbarg_t e_route);
+
+
+ enum RoutingKind {
+ ROUTING_NULL = 0, /**< Undefined type */
+ ROUTING_BASE, /**< Base case: use simple link lists for routing */
+ ROUTING_RECURSIVE /**< Recursive case: also return gateway informations */
+ };
+ /* FIXME: protect the following fields once the construction madness is sorted out */
+ RoutingKind hierarchy_ = ROUTING_NULL;
+ xbt_dynar_t upDownLinks = xbt_dynar_new(sizeof(s_surf_parsing_link_up_down_t),NULL);
+ As *father_ = nullptr;
+ surf::NetCard *netcard_ = nullptr; // Our representative in the father AS
+
+protected:
+ char *name_ = nullptr;
+ xbt_dict_t children_ = xbt_dict_new_homogeneous(NULL); // sub-ASes
+ xbt_dynar_t vertices_ = xbt_dynar_new(sizeof(char*),NULL); // our content, as known to our graph routing algorithm (maps vertexId -> vertex)
+
+private:
+ bool sealed_ = false; // We cannot add more content when sealed
+
+ friend surf::RoutingPlatf;
+ std::map<std::pair<std::string, std::string>, std::vector<surf::Link*>*> bypassRoutes_; // srcName x dstName -> route
+ static void getRouteRecursive(surf::NetCard *src, surf::NetCard *dst, /* OUT */ std::vector<surf::Link*> * links, double *latency);
+ std::vector<surf::Link*> *getBypassRoute(surf::NetCard *src, surf::NetCard *dst);
+
+};
+
+}}; // Namespace simgrid::s4u
+
+#endif /* SIMGRID_S4U_AS_HPP */
--- /dev/null
+/* Copyright (c) 2006-2014. 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 "xbt/log.h"
+
+#include "simgrid/s4u/as.hpp"
+#include "src/surf/surf_routing.hpp"
+#include "src/surf/network_interface.hpp" // Link FIXME: move to proper header
+
+XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_as,"S4U autonomous systems");
+
+namespace simgrid {
+ namespace s4u {
+
+ As::As(const char *name)
+ : name_(xbt_strdup(name))
+ {
+ }
+ void As::Seal()
+ {
+ sealed_ = true;
+ }
+ As::~As()
+ {
+ xbt_dict_cursor_t cursor = NULL;
+ char *key;
+ AS_t elem;
+ xbt_dict_foreach(children_, cursor, key, elem) {
+ delete (As*)elem;
+ }
+
+
+ xbt_dict_free(&children_);
+ xbt_dynar_free(&vertices_);
+ xbt_dynar_free(&upDownLinks);
+ for (auto &kv : bypassRoutes_)
+ delete kv.second;
+ xbt_free(name_);
+ delete netcard_;
+ }
+
+ xbt_dict_t As::children()
+ {
+ return children_;
+ }
+ char *As::name()
+ {
+ return name_;
+ }
+ As *As::father() {
+ return father_;
+ }
+
+ xbt_dynar_t As::hosts()
+ {
+ xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), NULL);
+
+ for (unsigned int index = 0; index < xbt_dynar_length(vertices_); index++) {
+ simgrid::surf::NetCard *card = xbt_dynar_get_as(vertices_, index, simgrid::surf::NetCard*);
+ simgrid::s4u::Host *host = simgrid::s4u::Host::by_name_or_null(card->name());
+ if (host!=NULL)
+ xbt_dynar_push(res, &host);
+ }
+ return res;
+ }
+
+ xbt_dynar_t As::getOneLinkRoutes() {
+ return NULL;
+ }
+
+ int As::addComponent(surf::NetCard *elm) {
+ xbt_dynar_push_as(vertices_, surf::NetCard*, elm);
+ return xbt_dynar_length(vertices_)-1;
+ }
+
+ void As::addRoute(sg_platf_route_cbarg_t /*route*/){
+ xbt_die("AS %s does not accept new routes (wrong class).",name_);
+ }
+
+ /** @brief Get the common ancestor and its first childs in each line leading to src and dst */
+ static void find_common_ancestors(surf::NetCard *src, surf::NetCard *dst,
+ /* OUT */ As **common_ancestor, As **src_ancestor, As **dst_ancestor)
+ {
+ #define ROUTING_HIERARCHY_MAXDEPTH 32 /* increase if it is not enough */
+ simgrid::s4u::As *path_src[ROUTING_HIERARCHY_MAXDEPTH];
+ simgrid::s4u::As *path_dst[ROUTING_HIERARCHY_MAXDEPTH];
+ int index_src = 0;
+ int index_dst = 0;
+ simgrid::s4u::As *current_src;
+ simgrid::s4u::As *current_dst;
+ simgrid::s4u::As *father;
+
+ /* (1) find the path to root of src and dst*/
+ simgrid::s4u::As *src_as = src->containingAS();
+ simgrid::s4u::As *dst_as = dst->containingAS();
+
+ xbt_assert(src_as, "Host %s must be in an AS", src->name());
+ xbt_assert(dst_as, "Host %s must be in an AS", dst->name());
+
+ /* (2) find the path to the root routing component */
+ for (simgrid::s4u::As *current = src_as; current != NULL; current = current->father()) {
+ xbt_assert(index_src < ROUTING_HIERARCHY_MAXDEPTH, "ROUTING_HIERARCHY_MAXDEPTH should be increased for element %s", src->name());
+ path_src[index_src++] = current;
+ }
+ for (simgrid::s4u::As *current = dst_as; current != NULL; current = current->father()) {
+ xbt_assert(index_dst < ROUTING_HIERARCHY_MAXDEPTH,"ROUTING_HIERARCHY_MAXDEPTH should be increased for path_dst");
+ path_dst[index_dst++] = current;
+ }
+
+ /* (3) find the common father.
+ * Before that, index_src and index_dst may be different, they both point to NULL in path_src/path_dst
+ * So we move them down simultaneously as long as they point to the same content.
+ */
+ do {
+ current_src = path_src[--index_src];
+ current_dst = path_dst[--index_dst];
+ } while (index_src > 0 && index_dst > 0 && current_src == current_dst);
+
+ /* (4) if we did not find a difference (index_src or index_dst went to 0), both elements are in the same AS */
+ if (current_src == current_dst)
+ father = current_src;
+ else // we found a difference
+ father = path_src[index_src + 1];
+
+ /* (5) result generation */
+ *common_ancestor = father; /* the common father of src and dst */
+ *src_ancestor = current_src; /* the first different father of src */
+ *dst_ancestor = current_dst; /* the first different father of dst */
+ #undef ROUTING_HIERARCHY_MAXDEPTH
+ }
+
+
+ /* PRECONDITION: this is the common ancestor of src and dst */
+ std::vector<surf::Link*> *As::getBypassRoute(surf::NetCard *src, surf::NetCard *dst)
+ {
+ // If never set a bypass route return NULL without any further computations
+ XBT_DEBUG("generic_get_bypassroute from %s to %s", src->name(), dst->name());
+ if (bypassRoutes_.empty())
+ return nullptr;
+
+ std::vector<surf::Link*> *bypassedRoute = nullptr;
+
+ if(dst->containingAS() == this && src->containingAS() == this ){
+ if (bypassRoutes_.find({src->name(),dst->name()}) != bypassRoutes_.end()) {
+ bypassedRoute = bypassRoutes_.at({src->name(),dst->name()});
+ XBT_DEBUG("Found a bypass route with %zu links",bypassedRoute->size());
+ }
+ return bypassedRoute;
+ }
+
+ /* (2) find the path to the root routing component */
+ std::vector<As*> path_src;
+ As *current = src->containingAS();
+ while (current != NULL) {
+ path_src.push_back(current);
+ current = current->father_;
+ }
+
+ std::vector<As*> path_dst;
+ current = dst->containingAS();
+ while (current != NULL) {
+ path_dst.push_back(current);
+ current = current->father_;
+ }
+
+ /* (3) find the common father */
+ while (path_src.size() > 1 && path_dst.size() >1
+ && path_src.at(path_src.size() -1) == path_dst.at(path_dst.size() -1)) {
+ path_src.pop_back();
+ path_dst.pop_back();
+ }
+
+ int max_index_src = path_src.size() - 1;
+ int max_index_dst = path_dst.size() - 1;
+
+ int max_index = std::max(max_index_src, max_index_dst);
+
+ for (int max = 0; max <= max_index; max++) {
+ for (int i = 0; i < max; i++) {
+ if (i <= max_index_src && max <= max_index_dst) {
+ const std::pair<std::string, std::string> key = {path_src.at(i)->name_, path_dst.at(max)->name_};
+ if (bypassRoutes_.find(key) != bypassRoutes_.end())
+ bypassedRoute = bypassRoutes_.at(key);
+ }
+ if (bypassedRoute)
+ break;
+ if (max <= max_index_src && i <= max_index_dst) {
+ const std::pair<std::string, std::string> key = {path_src.at(max)->name_, path_dst.at(i)->name_};
+ if (bypassRoutes_.find(key) != bypassRoutes_.end())
+ bypassedRoute = bypassRoutes_.at(key);
+ }
+ if (bypassedRoute)
+ break;
+ }
+
+ if (bypassedRoute)
+ break;
+
+ if (max <= max_index_src && max <= max_index_dst) {
+ const std::pair<std::string, std::string> key = {path_src.at(max)->name_, path_dst.at(max)->name_};
+ if (bypassRoutes_.find(key) != bypassRoutes_.end())
+ bypassedRoute = bypassRoutes_.at(key);
+ }
+ if (bypassedRoute)
+ break;
+ }
+
+ return bypassedRoute;
+ }
+
+ void As::addBypassRoute(sg_platf_route_cbarg_t e_route){
+ const char *src = e_route->src;
+ const char *dst = e_route->dst;
+
+ /* Argument validity checks */
+ if (e_route->gw_dst) {
+ XBT_DEBUG("Load bypassASroute from %s@%s to %s@%s",
+ src, e_route->gw_src->name(), dst, e_route->gw_dst->name());
+ xbt_assert(!e_route->link_list->empty(), "Bypass route between %s@%s and %s@%s cannot be empty.",
+ src, e_route->gw_src->name(), dst, e_route->gw_dst->name());
+ xbt_assert(bypassRoutes_.find({src,dst}) == bypassRoutes_.end(), "The bypass route between %s@%s and %s@%s already exists.",
+ src, e_route->gw_src->name(), dst, e_route->gw_dst->name());
+ } else {
+ XBT_DEBUG("Load bypassRoute from %s to %s", src, dst);
+ xbt_assert(!e_route->link_list->empty(), "Bypass route between %s and %s cannot be empty.", src, dst);
+ xbt_assert(bypassRoutes_.find({src,dst}) == bypassRoutes_.end(), "The bypass route between %s and %s already exists.", src, dst);
+ }
+
+ /* Build a copy that will be stored in the dict */
+ std::vector<surf::Link*> *newRoute = new std::vector<surf::Link*>();
+ for (auto link: *e_route->link_list)
+ newRoute->push_back(link);
+
+ /* Store it */
+ bypassRoutes_.insert({{src,dst}, newRoute});
+ }
+
+ /**
+ * \brief Recursive function for getRouteAndLatency
+ *
+ * \param src the source host
+ * \param dst the destination host
+ * \param links Where to store the links and the gw information
+ * \param latency If not NULL, the latency of all links will be added in it
+ */
+ void As::getRouteRecursive(surf::NetCard *src, surf::NetCard *dst,
+ /* OUT */ std::vector<surf::Link*> * links, double *latency)
+ {
+ s_sg_platf_route_cbarg_t route;
+ memset(&route,0,sizeof(route));
+
+ XBT_DEBUG("Solve route/latency \"%s\" to \"%s\"", src->name(), dst->name());
+
+ /* Find how src and dst are interconnected */
+ simgrid::s4u::As *common_ancestor, *src_ancestor, *dst_ancestor;
+ find_common_ancestors(src, dst, &common_ancestor, &src_ancestor, &dst_ancestor);
+ XBT_DEBUG("elements_father: common ancestor '%s' src ancestor '%s' dst ancestor '%s'",
+ common_ancestor->name_, src_ancestor->name_, dst_ancestor->name_);
+
+ /* Check whether a direct bypass is defined. If so, use it and bail out */
+ std::vector<surf::Link*> *bypassed_route = common_ancestor->getBypassRoute(src, dst);
+ if (nullptr != bypassed_route) {
+ for (surf::Link *link : *bypassed_route) {
+ links->push_back(link);
+ if (latency)
+ *latency += link->getLatency();
+ }
+ return;
+ }
+
+ /* If src and dst are in the same AS, life is good */
+ if (src_ancestor == dst_ancestor) { /* SURF_ROUTING_BASE */
+ route.link_list = links;
+ common_ancestor->getRouteAndLatency(src, dst, &route, latency);
+ return;
+ }
+
+ /* Not in the same AS, no bypass. We'll have to find our path between the ASes recursively*/
+
+ route.link_list = new std::vector<surf::Link*>();
+
+ common_ancestor->getRouteAndLatency(src_ancestor->netcard_, dst_ancestor->netcard_, &route, latency);
+ xbt_assert((route.gw_src != NULL) && (route.gw_dst != NULL),
+ "bad gateways for route from \"%s\" to \"%s\"", src->name(), dst->name());
+
+ /* If source gateway is not our source, we have to recursively find our way up to this point */
+ if (src != route.gw_src)
+ getRouteRecursive(src, route.gw_src, links, latency);
+ for (auto link: *route.link_list)
+ links->push_back(link);
+
+ /* If dest gateway is not our destination, we have to recursively find our way from this point */
+ if (route.gw_dst != dst)
+ getRouteRecursive(route.gw_dst, dst, links, latency);
+
+ }
+
+ }
+};
