Logo AND Algorithmique Numérique Distribuée

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