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 (a tree) of ASes, with a unique root AS (that you can retrieve from the
28 XBT_PUBLIC_CLASS AsImpl : public s4u::As
30 friend simgrid::kernel::routing::RoutingPlatf;
33 explicit AsImpl(As * father, const char* name);
36 /** @brief Make an host within that AS */
37 simgrid::s4u::Host* createHost(const char* name, std::vector<double>* speedPerPstate, int coreAmount);
40 * @brief Probe the routing path between two points
42 * The networking model uses this function when creating a communication
43 * to retrieve both the list of links that the create communication will use,
44 * and the summed latency that these links represent.
46 * The network could recompute the latency by itself from the list, but it would
47 * require an additional link set traversal. This operation being on the critical
48 * path of SimGrid, the routing computes the latency in behalf of the network.
50 * Things are rather complex here because we have to find the path from ASes to ASes, and within each.
51 * In addition, the different ASes may use differing routing models.
52 * Some ASes may be routed in full, others may have only some connection information and use a shortest path on top
54 * Some ASes may even not have any predefined links and use only coordinate information to compute the latency.
56 * So, the path is constructed recursively, with each traversed AS adding its information to the set.
57 * The algorithm for that is explained in http://hal.inria.fr/hal-00650233/
59 * @param src Initial point of the routing path
60 * @param dst Final point of the routing path
61 * @param into Container into which the traversed links should be pushed
62 * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
65 virtual void getLocalRoute(NetCard * src, NetCard * dst, sg_platf_route_cbarg_t into, double* latency) = 0;
66 /** @brief retrieves the list of all routes of size 1 (of type src x dst x Link) */
67 /* returns whether we found a bypass path */
68 bool getBypassRoute(routing::NetCard * src, routing::NetCard * dst,
69 /* OUT */ std::vector<surf::Link*> * links, double* latency);
72 virtual void getOneLinkRoutes(std::vector<Onelink*> * accumulator);
73 virtual void getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges) = 0;
74 static void getRouteRecursive(routing::NetCard * src, routing::NetCard * dst,
75 /* OUT */ std::vector<surf::Link*> * links, double* latency);
76 enum class RoutingMode {
77 unset = 0, /**< Undefined type */
78 base, /**< Base case: use simple link lists for routing */
79 recursive /**< Recursive case: also return gateway information */
81 /* FIXME: protect the following fields once the construction madness is sorted out */
82 RoutingMode hierarchy_ = RoutingMode::unset;
85 routing::NetCard* netcard_ = nullptr; // Our representative in the father AS
88 }}}; // Namespace simgrid::kernel::routing
90 #endif /* SIMGRID_SURF_AS_HPP */