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