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
21 /** @brief Autonomous Systems
23 * An AS is a network container, in charge of routing information between elements (hosts) and to the nearby ASes.
24 * In SimGrid, there is a hierarchy of ASes, with a unique root AS (that you can retrieve from the s4u::Engine).
26 XBT_PUBLIC_CLASS AsImpl : public s4u::As {
27 friend simgrid::kernel::routing::RoutingPlatf;
29 explicit AsImpl(As * father, const char* name);
33 /** @brief attach the given host to that AS */
34 void attachHost(s4u::Host * host);
37 * @brief Probe the routing path between two points
39 * The networking model uses this function when creating a communication
40 * to retrieve both the list of links that the create communication will use,
41 * and the summed latency that these links represent.
43 * The network could recompute the latency by itself from the list, but it would
44 * require an additional link set traversal. This operation being on the critical
45 * path of SimGrid, the routing computes the latency in behalf of the network.
47 * Things are rather complex here because we have to find the path from ASes to ASes, and within each.
48 * In addition, the different ASes may use differing routing models.
49 * 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.
50 * Some ASes may even not have any predefined links and use only coordinate information to compute the latency.
52 * So, the path is constructed recursively, with each traversed AS adding its information to the set.
53 * The algorithm for that is explained in http://hal.inria.fr/hal-00650233/
55 * @param src Initial point of the routing path
56 * @param dst Final point of the routing path
57 * @param into Container into which the traversed links should be pushed
58 * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
60 virtual void getRouteAndLatency(NetCard *src, NetCard *dst, sg_platf_route_cbarg_t into, double *latency)=0;
61 /** @brief retrieves the list of all routes of size 1 (of type src x dst x Link) */
62 virtual xbt_dynar_t getOneLinkRoutes();
63 /* returns whether we found a bypass path */
64 bool getBypassRoute(routing::NetCard * src, routing::NetCard * dst,
65 /* OUT */ std::vector<surf::Link*> * links, double* latency);
67 virtual void getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges)=0;
68 static void getRouteRecursive(routing::NetCard * src, routing::NetCard * dst,
69 /* OUT */ std::vector<surf::Link*> * links, double* latency);
71 enum class RoutingMode {
72 unset = 0, /**< Undefined type */
73 base, /**< Base case: use simple link lists for routing */
74 recursive /**< Recursive case: also return gateway information */
76 /* FIXME: protect the following fields once the construction madness is sorted out */
77 RoutingMode hierarchy_ = RoutingMode::unset;
78 routing::NetCard *netcard_ = nullptr; // Our representative in the father AS
81 }}}; // Namespace simgrid::kernel::routing
83 #endif /* SIMGRID_SURF_AS_HPP */