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
  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 : public s4u::NetZone {
  51   friend simgrid::kernel::EngineImpl; // it destroys netRoot_
  52
  53 protected:
  54   explicit NetZoneImpl(NetZone* father, std::string name);
  55   virtual ~NetZoneImpl();
  56
  57 public:
  58   /** @brief Make an host within that NetZone */
  59   simgrid::s4u::Host* createHost(const char* name, std::vector<double>* speedPerPstate, int coreAmount,
  60                                  std::map<std::string, std::string>* props);
  61   /** @brief Creates a new route in this NetZone */
  62   void addBypassRoute(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
  63                       std::vector<simgrid::surf::LinkImpl*>& link_list, bool symmetrical) override;
  64
  65 protected:
  66   /**
  67    * @brief Probe the routing path between two points that are local to the called NetZone.
  68    *
  69    * @param src where from
  70    * @param dst where to
  71    * @param into Container into which the traversed links and gateway informations should be pushed
  72    * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
  73    */
  74   virtual void getLocalRoute(NetPoint* src, NetPoint* dst, RouteCreationArgs* into, double* latency) = 0;
  75   /** @brief retrieves the list of all routes of size 1 (of type src x dst x Link) */
  76   /* returns whether we found a bypass path */
  77   bool getBypassRoute(routing::NetPoint* src, routing::NetPoint* dst,
  78                       /* OUT */ std::vector<surf::LinkImpl*>& links, double* latency);
  79
  80 public:
  81   /* @brief get the route between two nodes in the full platform
  82    *
  83    * @param src where from
  84    * @param dst where to
  85    * @param links Accumulator in which all traversed links should be pushed (caller must empty it)
  86    * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
  87    */
  88   static void getGlobalRoute(routing::NetPoint* src, routing::NetPoint* dst,
  89                              /* OUT */ std::vector<surf::LinkImpl*>& links, double* latency);
  90
  91   virtual void getGraph(xbt_graph_t graph, std::map<std::string, xbt_node_t>* nodes,
  92                         std::map<std::string, xbt_edge_t>* edges) = 0;
  93   enum class RoutingMode {
  94     unset = 0, /**< Undefined type                                   */
  95     base,      /**< Base case: use simple link lists for routing     */
  96     recursive  /**< Recursive case: also return gateway information  */
  97   };
  98   /* FIXME: protect the following fields once the construction madness is sorted out */
  99   RoutingMode hierarchy_ = RoutingMode::unset;
 100
 101 private:
 102   std::map<std::pair<NetPoint*, NetPoint*>, BypassRoute*> bypassRoutes_; // src x dst -> route
 103   routing::NetPoint* netpoint_ = nullptr;                                // Our representative in the father NetZone
 104 };
 105 } // namespace routing
 106 } // namespace kernel
 107 }; // namespace simgrid
 108
 109 #endif /* SIMGRID_ROUTING_NETZONEIMPL_HPP */