Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
make NetZoneImpl public too
[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 <map>
10
11 #include "xbt/graph.h"
12
13 #include "simgrid/forward.h"
14 #include "simgrid/s4u/NetZone.hpp"
15 #include "src/surf/xml/platf_private.hpp" // FIXME: kill sg_platf_route_cbarg_t to remove that UGLY include
16
17 namespace simgrid {
18 namespace kernel {
19 namespace routing {
20 class BypassRoute;
21
22 /** @ingroup ROUTING_API
23  *  @brief Private implementation of the Networking Zones
24  *
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().
28  *
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
32  * links represent.
33  *
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.
37  *
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.
44  *
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).
49  *
50  */
51 class XBT_PUBLIC NetZoneImpl : public s4u::NetZone {
52   friend simgrid::kernel::EngineImpl; // it destroys netRoot_
53
54 protected:
55   explicit NetZoneImpl(NetZone* father, std::string name);
56   virtual ~NetZoneImpl();
57
58 public:
59   /** @brief Make an host within that NetZone */
60   simgrid::s4u::Host* createHost(const char* name, std::vector<double>* speedPerPstate, int coreAmount,
61                                  std::map<std::string, std::string>* props);
62   /** @brief Creates a new route in this NetZone */
63   void addBypassRoute(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
64                       std::vector<simgrid::surf::LinkImpl*>& link_list, bool symmetrical) override;
65
66 protected:
67   /**
68    * @brief Probe the routing path between two points that are local to the called NetZone.
69    *
70    * @param src where from
71    * @param dst where to
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)
74    */
75   virtual void getLocalRoute(NetPoint* src, NetPoint* dst, RouteCreationArgs* 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::NetPoint* src, routing::NetPoint* dst,
79                       /* OUT */ std::vector<surf::LinkImpl*>& links, double* latency);
80
81 public:
82   /* @brief get the route between two nodes in the full platform
83    *
84    * @param src where from
85    * @param dst where to
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)
88    */
89   static void getGlobalRoute(routing::NetPoint* src, routing::NetPoint* dst,
90                              /* OUT */ std::vector<surf::LinkImpl*>& links, double* latency);
91
92   virtual void getGraph(xbt_graph_t graph, std::map<std::string, xbt_node_t>* nodes,
93                         std::map<std::string, xbt_edge_t>* edges) = 0;
94   enum class RoutingMode {
95     unset = 0, /**< Undefined type                                   */
96     base,      /**< Base case: use simple link lists for routing     */
97     recursive  /**< Recursive case: also return gateway information  */
98   };
99   /* FIXME: protect the following fields once the construction madness is sorted out */
100   RoutingMode hierarchy_ = RoutingMode::unset;
101
102 private:
103   std::map<std::pair<NetPoint*, NetPoint*>, BypassRoute*> bypassRoutes_; // src x dst -> route
104   routing::NetPoint* netpoint_ = nullptr;                                // Our representative in the father NetZone
105 };
106 } // namespace routing
107 } // namespace kernel
108 }; // namespace simgrid
109
110 #endif /* SIMGRID_ROUTING_NETZONEIMPL_HPP */