Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
further snake_case in routing
[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
15 namespace simgrid {
16 namespace kernel {
17 namespace routing {
18 class BypassRoute;
19
20 /** @ingroup ROUTING_API
21  *  @brief Private implementation of the Networking Zones
22  *
23  * A netzone is a network container, in charge of routing information between elements (hosts and sub-netzones)
24  * and to the nearby netzones. In SimGrid, there is a hierarchy of netzones, ie a tree with a unique root
25  * NetZone, that you can retrieve with simgrid::s4u::Engine::netRoot().
26  *
27  * The purpose of the kernel::routing module is to retrieve the routing path between two points in a time- and
28  * space-efficient manner. This is done by NetZoneImpl::getGlobalRoute(), called when creating a communication to
29  * retrieve both the list of links that the create communication will use, and the summed latency that these
30  * links represent.
31  *
32  * The network model could recompute the latency by itself from the list, but it would require an additional
33  * traversal of the link set. This operation being on the critical path of SimGrid, the routing computes the
34  * latency on the behalf of the network while constructing the link set.
35  *
36  * Finding the path between two nodes is rather complex because we navigate a hierarchy of netzones, each of them
37  * being a full network. In addition, the routing can declare shortcuts (called bypasses), either within a NetZone
38  * at the route level or directly between NetZones. Also, each NetZone can use a differing routing algorithm, depending
39  * on its class. @ref FullZone have a full matrix giving explicitly the path between any pair of their
40  * contained nodes, while @ref DijkstraZone or @ref FloydZone rely on a shortest path algorithm. @ref VivaldiZone
41  * does not even have any link but only use only coordinate information to compute the latency.
42  *
43  * So NetZoneImpl::getGlobalRoute builds the path recursively asking its specific information to each traversed NetZone
44  * with NetZoneImpl::getLocalRoute, that is redefined in each sub-class.
45  * The algorithm for that is explained in http://hal.inria.fr/hal-00650233/ (but for historical reasons, NetZones are
46  * called Autonomous Systems in this article).
47  *
48  */
49 class XBT_PUBLIC NetZoneImpl : public s4u::NetZone {
50   friend simgrid::kernel::EngineImpl; // it destroys netRoot_
51
52 protected:
53   explicit NetZoneImpl(NetZone* father, std::string name);
54   virtual ~NetZoneImpl();
55
56 public:
57   /** @brief Make an host within that NetZone */
58   simgrid::s4u::Host* create_host(const char* name, std::vector<double>* speedPerPstate, int coreAmount,
59                                   std::map<std::string, std::string>* props);
60   /** @brief Creates a new route in this NetZone */
61   void add_bypass_route(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
62                         std::vector<simgrid::surf::LinkImpl*>& link_list, bool symmetrical) override;
63
64 protected:
65   /**
66    * @brief Probe the routing path between two points that are local to the called NetZone.
67    *
68    * @param src where from
69    * @param dst where to
70    * @param into Container into which the traversed links and gateway informations should be pushed
71    * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
72    */
73   virtual void getLocalRoute(NetPoint* src, NetPoint* dst, RouteCreationArgs* into, double* latency) = 0;
74   /** @brief retrieves the list of all routes of size 1 (of type src x dst x Link) */
75   /* returns whether we found a bypass path */
76   bool get_bypass_route(routing::NetPoint* src, routing::NetPoint* dst,
77                         /* OUT */ std::vector<surf::LinkImpl*>& links, double* latency);
78
79 public:
80   /* @brief get the route between two nodes in the full platform
81    *
82    * @param src where from
83    * @param dst where to
84    * @param links Accumulator in which all traversed links should be pushed (caller must empty it)
85    * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
86    */
87   static void get_global_route(routing::NetPoint* src, routing::NetPoint* dst,
88                                /* OUT */ std::vector<surf::LinkImpl*>& links, double* latency);
89
90   virtual void get_graph(xbt_graph_t graph, std::map<std::string, xbt_node_t>* nodes,
91                          std::map<std::string, xbt_edge_t>* edges) = 0;
92   enum class RoutingMode {
93     unset = 0, /**< Undefined type                                   */
94     base,      /**< Base case: use simple link lists for routing     */
95     recursive  /**< Recursive case: also return gateway information  */
96   };
97   /* FIXME: protect the following fields once the construction madness is sorted out */
98   RoutingMode hierarchy_ = RoutingMode::unset;
99
100 private:
101   std::map<std::pair<NetPoint*, NetPoint*>, BypassRoute*> bypass_routes_; // src x dst -> route
102   routing::NetPoint* netpoint_ = nullptr;                                // Our representative in the father NetZone
103 };
104 } // namespace routing
105 } // namespace kernel
106 }; // namespace simgrid
107
108 #endif /* SIMGRID_ROUTING_NETZONEIMPL_HPP */