src/kernel/routing/NetZoneImpl.hpp

   1 /* Copyright (c) 2016-2017. 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/s4u/NetZone.hpp"
  14 #include "simgrid/s4u/forward.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 class EngineImpl;
  20 namespace routing {
  21 class BypassRoute;
  22
  23 /** @ingroup ROUTING_API
  24  *  @brief Private implementation of the Networking Zones
  25  *
  26  * A netzone is a network container, in charge of routing information between elements (hosts and sub-netzones)
  27  * and to the nearby netzones. In SimGrid, there is a hierarchy of netzones, ie a tree with a unique root
  28  * NetZone, that you can retrieve with simgrid::s4u::Engine::netRoot().
  29  *
  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
  33  * links represent.
  34  *
  35  * The network model could recompute the latency by itself from the list, but it would require an additional
  36  * traversal of the link set. This operation being on the critical path of SimGrid, the routing computes the
  37  * latency on the behalf of the network while constructing the link set.
  38  *
  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.
  45  *
  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).
  50  *
  51  */
  52 XBT_PUBLIC_CLASS NetZoneImpl : public s4u::NetZone
  53 {
  54   friend simgrid::kernel::EngineImpl; // it destroys netRoot_
  55
  56 protected:
  57   explicit NetZoneImpl(NetZone * father, std::string name);
  58   virtual ~NetZoneImpl();
  59
  60 public:
  61   /** @brief Make an host within that NetZone */
  62   simgrid::s4u::Host* createHost(const char* name, std::vector<double>* speedPerPstate, int coreAmount,
  63                                  std::map<std::string, std::string>* props);
  64   /** @brief Creates a new route in this NetZone */
  65   void addBypassRoute(NetPoint * src, NetPoint * dst, NetPoint * gw_src, NetPoint * gw_dst,
  66                       std::vector<simgrid::surf::LinkImpl*> & link_list, bool symmetrical) override;
  67
  68 protected:
  69   /**
  70    * @brief Probe the routing path between two points that are local to the called NetZone.
  71    *
  72    * @param src where from
  73    * @param dst where to
  74    * @param into Container into which the traversed links and gateway informations should be pushed
  75    * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
  76    */
  77   virtual void getLocalRoute(NetPoint * src, NetPoint * dst, RouteCreationArgs * into, double* latency) = 0;
  78   /** @brief retrieves the list of all routes of size 1 (of type src x dst x Link) */
  79   /* returns whether we found a bypass path */
  80   bool getBypassRoute(routing::NetPoint * src, routing::NetPoint * dst,
  81                       /* OUT */ std::vector<surf::LinkImpl*>& links, double* latency);
  82
  83 public:
  84   /* @brief get the route between two nodes in the full platform
  85    *
  86    * @param src where from
  87    * @param dst where to
  88    * @param links Accumulator in which all traversed links should be pushed (caller must empty it)
  89    * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
  90    */
  91   static void getGlobalRoute(routing::NetPoint * src, routing::NetPoint * dst,
  92                              /* OUT */ std::vector<surf::LinkImpl*>& links, double* latency);
  93
  94   virtual void getGraph(xbt_graph_t graph, std::map<std::string, xbt_node_t> * nodes,
  95                         std::map<std::string, xbt_edge_t> * edges) = 0;
  96   enum class RoutingMode {
  97     unset = 0, /**< Undefined type                                   */
  98     base,      /**< Base case: use simple link lists for routing     */
  99     recursive  /**< Recursive case: also return gateway information  */
 100   };
 101   /* FIXME: protect the following fields once the construction madness is sorted out */
 102   RoutingMode hierarchy_ = RoutingMode::unset;
 103
 104 private:
 105   std::map<std::pair<NetPoint*, NetPoint*>, BypassRoute*> bypassRoutes_; // src x dst -> route
 106   routing::NetPoint* netpoint_ = nullptr;                                // Our representative in the father NetZone
 107 };
 108 }
 109 }
 110 }; // Namespace simgrid::kernel::routing
 111
 112 #endif /* SIMGRID_ROUTING_NETZONEIMPL_HPP */