1 /* Copyright (c) 2016-2019. 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
9 #include <simgrid/forward.h>
10 #include <simgrid/s4u/NetZone.hpp>
11 #include <xbt/PropertyHolder.hpp>
12 #include <xbt/graph.h>
22 /** @ingroup ROUTING_API
23 * @brief Private implementation of the Networking Zones
25 * A netzone is a network container, in charge of routing information between elements (hosts and sub-netzones)
26 * and to the nearby netzones. In SimGrid, there is a hierarchy of netzones, ie a tree with a unique root
27 * NetZone, that you can retrieve with simgrid::s4u::Engine::netRoot().
29 * The purpose of the kernel::routing module is to retrieve the routing path between two points in a time- and
30 * space-efficient manner. This is done by NetZoneImpl::getGlobalRoute(), called when creating a communication to
31 * retrieve both the list of links that the create communication will use, and the summed latency that these
34 * The network model could recompute the latency by itself from the list, but it would require an additional
35 * traversal of the link set. This operation being on the critical path of SimGrid, the routing computes the
36 * latency on the behalf of the network while constructing the link set.
38 * Finding the path between two nodes is rather complex because we navigate a hierarchy of netzones, each of them
39 * being a full network. In addition, the routing can declare shortcuts (called bypasses), either within a NetZone
40 * at the route level or directly between NetZones. Also, each NetZone can use a differing routing algorithm, depending
41 * on its class. @ref FullZone have a full matrix giving explicitly the path between any pair of their
42 * contained nodes, while @ref DijkstraZone or @ref FloydZone rely on a shortest path algorithm. @ref VivaldiZone
43 * does not even have any link but only use only coordinate information to compute the latency.
45 * So NetZoneImpl::getGlobalRoute builds the path recursively asking its specific information to each traversed NetZone
46 * with NetZoneImpl::getLocalRoute, that is redefined in each sub-class.
47 * The algorithm for that is explained in http://hal.inria.fr/hal-00650233/ (but for historical reasons, NetZones are
48 * called Autonomous Systems in this article).
51 class XBT_PUBLIC NetZoneImpl : public xbt::PropertyHolder {
52 friend EngineImpl; // it destroys netRoot_
55 explicit NetZoneImpl(NetZoneImpl* father, const std::string& name, resource::NetworkModel* network_model);
56 NetZoneImpl(const NetZoneImpl&) = delete;
57 NetZoneImpl& operator=(const NetZoneImpl&) = delete;
58 virtual ~NetZoneImpl();
61 s4u::NetZone* get_iface() { return &piface_; }
63 /** @brief Make a host within that NetZone */
64 s4u::Host* create_host(const std::string& name, const std::vector<double>& speed_per_pstate, int core_count,
65 const std::map<std::string, std::string>* props);
66 /** @brief Creates a new route in this NetZone */
67 virtual void add_bypass_route(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
68 std::vector<resource::LinkImpl*>& link_list, bool symmetrical);
70 /** @brief Seal your netzone once you're done adding content, and before routing stuff through it */
72 virtual int add_component(kernel::routing::NetPoint* elm); /* A host, a router or a netzone, whatever */
73 virtual void add_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
74 kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
75 std::vector<kernel::resource::LinkImpl*>& link_list, bool symmetrical);
79 * @brief Probe the routing path between two points that are local to the called NetZone.
81 * @param src where from
83 * @param into Container into which the traversed links and gateway informations should be pushed
84 * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
86 virtual void get_local_route(NetPoint* src, NetPoint* dst, RouteCreationArgs* into, double* latency) = 0;
87 /** @brief retrieves the list of all routes of size 1 (of type src x dst x Link) */
88 /* returns whether we found a bypass path */
89 bool get_bypass_route(routing::NetPoint* src, routing::NetPoint* dst,
90 /* OUT */ std::vector<resource::LinkImpl*>& links, double* latency);
93 resource::NetworkModel* network_model_;
98 // our content, as known to our graph routing algorithm (maps vertex_id -> vertex)
99 std::vector<kernel::routing::NetPoint*> vertices_;
101 NetZoneImpl* father_ = nullptr;
103 std::vector<NetZoneImpl*> children_; // sub-netzones
106 unsigned int get_table_size() { return vertices_.size(); }
107 std::vector<kernel::routing::NetPoint*> get_vertices() { return vertices_; }
109 NetZoneImpl* get_father();
111 std::vector<NetZoneImpl*>* get_children(); // Sub netzones
115 bool sealed_ = false; // We cannot add more content when sealed
118 /** @brief Retrieves the name of that netzone as a C++ string */
119 const std::string& get_name() const { return name_; }
120 /** @brief Retrieves the name of that netzone as a C string */
121 const char* get_cname() const;
123 std::vector<s4u::Host*> get_all_hosts();
124 int get_host_count();
126 /* @brief get the route between two nodes in the full platform
128 * @param src where from
129 * @param dst where to
130 * @param links Accumulator in which all traversed links should be pushed (caller must empty it)
131 * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
133 static void get_global_route(routing::NetPoint* src, routing::NetPoint* dst,
134 /* OUT */ std::vector<resource::LinkImpl*>& links, double* latency);
136 virtual void get_graph(xbt_graph_t graph, std::map<std::string, xbt_node_t>* nodes,
137 std::map<std::string, xbt_edge_t>* edges) = 0;
138 enum class RoutingMode {
139 unset = 0, /**< Undefined type */
140 base, /**< Base case: use simple link lists for routing */
141 recursive /**< Recursive case: also return gateway information */
143 /* FIXME: protect the following fields once the construction madness is sorted out */
144 RoutingMode hierarchy_ = RoutingMode::unset;
147 std::map<std::pair<NetPoint*, NetPoint*>, BypassRoute*> bypass_routes_; // src x dst -> route
148 routing::NetPoint* netpoint_ = nullptr; // Our representative in the father NetZone
150 } // namespace routing
151 } // namespace kernel
152 } // namespace simgrid
154 #endif /* SIMGRID_ROUTING_NETZONEIMPL_HPP */