1 /* Copyright (c) 2016. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_SURF_AS_HPP
7 #define SIMGRID_SURF_AS_HPP
11 #include "simgrid/s4u/forward.hpp"
12 #include "simgrid/s4u/As.hpp"
14 #include "src/surf/xml/platf_private.hpp" // FIXME: kill sg_platf_route_cbarg_t to remove that UGLY include
19 class RoutingPlatf; // FIXME: KILLME
22 /** @brief Autonomous Systems
24 * An AS is a network container, in charge of routing information between elements (hosts) and to the nearby ASes.
25 * In SimGrid, there is a hierarchy of ASes, ie a tree with a unique root AS, that you can retrieve from the
28 * The purpose of the kernel::routing module is to retrieve the routing path between two points in a time- and
29 * space-efficient manner. This is done by AsImpl::getGlobalRoute(), called when creating a communication to
30 * retrieve both the list of links that the create communication will use, and the summed latency that these
33 * The network could recompute the latency by itself from the list, but it would require an additional link
34 * set traversal. This operation being on the critical path of SimGrid, the routing computes the latency on the
35 * behalf of the network.
37 * Finding the path between two nodes is rather complex because we navigate a hierarchy of ASes, each of them
38 * being a full network. In addition, the routing can declare shortcuts (called bypasses), either within an AS
39 * at the route level or directly between ASes. Also, each AS can use a differing routing algorithm, depending
40 * on its class. @ref{AsFull} have a full matrix giving explicitly the path between any pair of their
41 * contained nodes, while @ref{AsDijkstra} or @ref{AsFloyd} rely on a shortest path algorithm. @ref{AsVivaldi}
42 * does not even have any link but only use only coordinate information to compute the latency.
44 * So AsImpl::getGlobalRoute builds the path recursively asking its specific information to each traversed AS with
45 * AsImpl::getLocalRoute, that is redefined in each sub-class.
46 * The algorithm for that is explained in http://hal.inria.fr/hal-00650233/
49 XBT_PUBLIC_CLASS AsImpl : public s4u::As
51 friend simgrid::kernel::routing::RoutingPlatf;
54 explicit AsImpl(As * father, const char* name);
57 /** @brief Make an host within that AS */
58 simgrid::s4u::Host* createHost(const char* name, std::vector<double>* speedPerPstate, int coreAmount);
62 * @brief Probe the routing path between two points that are local to the called AS.
64 * @param src where from
66 * @param into Container into which the traversed links and gateway informations should be pushed
67 * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
69 virtual void getLocalRoute(NetCard * src, NetCard * dst, sg_platf_route_cbarg_t into, double* latency) = 0;
70 /** @brief retrieves the list of all routes of size 1 (of type src x dst x Link) */
71 /* returns whether we found a bypass path */
72 bool getBypassRoute(routing::NetCard * src, routing::NetCard * dst,
73 /* OUT */ std::vector<surf::Link*> * links, double* latency);
76 /* @brief get the route between two nodes in the full platform
78 * @param src where from
80 * @param links Accumulator in which all traversed links should be pushed (caller must empty it)
81 * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
83 static void getGlobalRoute(routing::NetCard * src, routing::NetCard * dst,
84 /* OUT */ std::vector<surf::Link*> * links, double* latency);
86 virtual void getOneLinkRoutes(std::vector<Onelink*> * accumulator);
87 virtual void getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges) = 0;
88 enum class RoutingMode {
89 unset = 0, /**< Undefined type */
90 base, /**< Base case: use simple link lists for routing */
91 recursive /**< Recursive case: also return gateway information */
93 /* FIXME: protect the following fields once the construction madness is sorted out */
94 RoutingMode hierarchy_ = RoutingMode::unset;
97 routing::NetCard* netcard_ = nullptr; // Our representative in the father AS
100 }}}; // Namespace simgrid::kernel::routing
102 #endif /* SIMGRID_SURF_AS_HPP */