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_ROUTING_NETZONEIMPL_HPP
7 #define SIMGRID_ROUTING_NETZONEIMPL_HPP
11 #include "xbt/graph.h"
13 #include "simgrid/s4u/NetZone.hpp"
14 #include "simgrid/s4u/forward.hpp"
16 #include "src/surf/xml/platf_private.hpp" // FIXME: kill sg_platf_route_cbarg_t to remove that UGLY include
24 /** @brief Networking Zones
26 * A netzone is a network container, in charge of routing information between elements (hosts) and to the nearby
27 * netzones. In SimGrid, there is a hierarchy of netzones, ie a tree with a unique root NetZone, that you can retrieve
28 * from the s4u::Engine.
30 * The purpose of the kernel::routing module is to retrieve the routing path between two points in a time- and
31 * space-efficient manner. This is done by NetZoneImpl::getGlobalRoute(), called when creating a communication to
32 * retrieve both the list of links that the create communication will use, and the summed latency that these
35 * The network could recompute the latency by itself from the list, but it would require an additional link
36 * set traversal. This operation being on the critical path of SimGrid, the routing computes the latency on the
37 * behalf of the network.
39 * Finding the path between two nodes is rather complex because we navigate a hierarchy of netzones, each of them
40 * being a full network. In addition, the routing can declare shortcuts (called bypasses), either within a NetZone
41 * at the route level or directly between NetZones. Also, each NetZone can use a differing routing algorithm, depending
42 * on its class. @ref{FullZone} have a full matrix giving explicitly the path between any pair of their
43 * contained nodes, while @ref{DijkstraZone} or @ref{FloydZone} rely on a shortest path algorithm. @ref{VivaldiZone}
44 * does not even have any link but only use only coordinate information to compute the latency.
46 * So NetZoneImpl::getGlobalRoute builds the path recursively asking its specific information to each traversed NetZone
47 * with NetZoneImpl::getLocalRoute, that is redefined in each sub-class.
48 * The algorithm for that is explained in http://hal.inria.fr/hal-00650233/ (but for historical reasons, NetZones are
49 * called Autonomous Systems in this article).
52 XBT_PUBLIC_CLASS NetZoneImpl : public s4u::NetZone
54 friend simgrid::kernel::EngineImpl; // it destroys netRoot_
57 explicit NetZoneImpl(NetZone * father, const char* name);
58 virtual ~NetZoneImpl();
61 /** @brief Make an host within that NetZone */
62 simgrid::s4u::Host* createHost(const char* name, std::vector<double>* speedPerPstate, int coreAmount);
63 /** @brief Creates a new route in this NetZone */
64 void addBypassRoute(sg_platf_route_cbarg_t e_route) override;
68 * @brief Probe the routing path between two points that are local to the called NetZone.
70 * @param src where from
72 * @param into Container into which the traversed links and gateway informations should be pushed
73 * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
75 virtual void getLocalRoute(NetCard * src, NetCard * dst, sg_platf_route_cbarg_t into, double* latency) = 0;
76 /** @brief retrieves the list of all routes of size 1 (of type src x dst x Link) */
77 /* returns whether we found a bypass path */
78 bool getBypassRoute(routing::NetCard * src, routing::NetCard * dst,
79 /* OUT */ std::vector<surf::Link*> * links, double* latency);
82 /* @brief get the route between two nodes in the full platform
84 * @param src where from
86 * @param links Accumulator in which all traversed links should be pushed (caller must empty it)
87 * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
89 static void getGlobalRoute(routing::NetCard * src, routing::NetCard * dst,
90 /* OUT */ std::vector<surf::Link*> * links, double* latency);
92 virtual void getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges) = 0;
93 enum class RoutingMode {
94 unset = 0, /**< Undefined type */
95 base, /**< Base case: use simple link lists for routing */
96 recursive /**< Recursive case: also return gateway information */
98 /* FIXME: protect the following fields once the construction madness is sorted out */
99 RoutingMode hierarchy_ = RoutingMode::unset;
102 std::map<std::pair<NetCard*, NetCard*>, BypassRoute*> bypassRoutes_; // src x dst -> route
103 routing::NetCard* netcard_ = nullptr; // Our representative in the father NetZone
107 }; // Namespace simgrid::kernel::routing
109 #endif /* SIMGRID_ROUTING_NETZONEIMPL_HPP */