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