src/kernel/routing/NetZoneImpl.hpp

   1 /* Copyright (c) 2016. 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 "xbt/graph.h"
  10
  11 #include "simgrid/s4u/NetZone.hpp"
  12 #include "simgrid/s4u/forward.hpp"
  13
  14 #include "src/surf/xml/platf_private.hpp" // FIXME: kill sg_platf_route_cbarg_t to remove that UGLY include
  15
  16 namespace simgrid {
  17 namespace kernel {
  18 class EngineImpl;
  19 namespace routing {
  20 class BypassRoute;
  21
  22 /** @brief Networking Zones
  23  *
  24  * A netzone is a network container, in charge of routing information between elements (hosts) and to the nearby
  25  * netzones. In SimGrid, there is a hierarchy of netzones, ie a tree with a unique root NetZone, that you can retrieve
  26  * from the s4u::Engine.
  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 could recompute the latency by itself from the list, but it would require an additional link
  34  * set traversal. This operation being on the critical path of SimGrid, the routing computes the latency on the
  35  * behalf of the network.
  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 XBT_PUBLIC_CLASS NetZoneImpl : public s4u::NetZone
  51 {
  52   friend simgrid::kernel::EngineImpl; // it destroys netRoot_
  53
  54 protected:
  55   explicit NetZoneImpl(NetZone * father, const char* 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   /** @brief Creates a new route in this NetZone */
  62   void addBypassRoute(sg_platf_route_cbarg_t e_route) 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(NetCard * src, NetCard * dst, sg_platf_route_cbarg_t 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 getBypassRoute(routing::NetCard * src, routing::NetCard * dst,
  77                       /* OUT */ std::vector<surf::Link*> * 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 getGlobalRoute(routing::NetCard * src, routing::NetCard * dst,
  88                              /* OUT */ std::vector<surf::Link*> * links, double* latency);
  89
  90   virtual void getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges) = 0;
  91   enum class RoutingMode {
  92     unset = 0, /**< Undefined type                                   */
  93     base,      /**< Base case: use simple link lists for routing     */
  94     recursive  /**< Recursive case: also return gateway information  */
  95   };
  96   /* FIXME: protect the following fields once the construction madness is sorted out */
  97   RoutingMode hierarchy_ = RoutingMode::unset;
  98
  99 private:
 100   std::map<std::pair<NetCard*, NetCard*>, BypassRoute*> bypassRoutes_; // src x dst -> route
 101   routing::NetCard* netcard_ = nullptr;                                // Our representative in the father NetZone
 102 };
 103 }
 104 }
 105 }; // Namespace simgrid::kernel::routing
 106
 107 #endif /* SIMGRID_ROUTING_NETZONEIMPL_HPP */