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 <map>
  10
  11 #include "xbt/graph.h"
  12
  13 #include "simgrid/s4u/NetZone.hpp"
  14 #include "simgrid/s4u/forward.hpp"
  15
  16 #include "src/surf/xml/platf_private.hpp" // FIXME: kill sg_platf_route_cbarg_t to remove that UGLY include
  17
  18 namespace simgrid {
  19 namespace kernel {
  20 class EngineImpl;
  21 namespace routing {
  22 class BypassRoute;
  23
  24 /** @ingroup ROUTING_API
  25  *  @brief Private implementation of the Networking Zones
  26  *
  27  * A netzone is a network container, in charge of routing information between elements (hosts and sub-netzones)
  28  * and to the nearby netzones. In SimGrid, there is a hierarchy of netzones, ie a tree with a unique root
  29  * NetZone, that you can retrieve with simgrid::s4u::Engine::netRoot().
  30  *
  31  * The purpose of the kernel::routing module is to retrieve the routing path between two points in a time- and
  32  * space-efficient manner. This is done by NetZoneImpl::getGlobalRoute(), called when creating a communication to
  33  * retrieve both the list of links that the create communication will use, and the summed latency that these
  34  * links represent.
  35  *
  36  * The network model could recompute the latency by itself from the list, but it would require an additional
  37  * traversal of the link set. This operation being on the critical path of SimGrid, the routing computes the
  38  * latency on the behalf of the network while constructing the link set.
  39  *
  40  * Finding the path between two nodes is rather complex because we navigate a hierarchy of netzones, each of them
  41  * being a full network. In addition, the routing can declare shortcuts (called bypasses), either within a NetZone
  42  * at the route level or directly between NetZones. Also, each NetZone can use a differing routing algorithm, depending
  43  * on its class. @ref{FullZone} have a full matrix giving explicitly the path between any pair of their
  44  * contained nodes, while @ref{DijkstraZone} or @ref{FloydZone} rely on a shortest path algorithm. @ref{VivaldiZone}
  45  * does not even have any link but only use only coordinate information to compute the latency.
  46  *
  47  * So NetZoneImpl::getGlobalRoute builds the path recursively asking its specific information to each traversed NetZone
  48  * with NetZoneImpl::getLocalRoute, that is redefined in each sub-class.
  49  * The algorithm for that is explained in http://hal.inria.fr/hal-00650233/ (but for historical reasons, NetZones are
  50  * called Autonomous Systems in this article).
  51  *
  52  */
  53 XBT_PUBLIC_CLASS NetZoneImpl : public s4u::NetZone
  54 {
  55   friend simgrid::kernel::EngineImpl; // it destroys netRoot_
  56
  57 protected:
  58   explicit NetZoneImpl(NetZone * father, const char* name);
  59   virtual ~NetZoneImpl();
  60
  61 public:
  62   /** @brief Make an host within that NetZone */
  63   simgrid::s4u::Host* createHost(const char* name, std::vector<double>* speedPerPstate, int coreAmount);
  64   /** @brief Creates a new route in this NetZone */
  65   void addBypassRoute(sg_platf_route_cbarg_t e_route) override;
  66
  67 protected:
  68   /**
  69    * @brief Probe the routing path between two points that are local to the called NetZone.
  70    *
  71    * @param src where from
  72    * @param dst where to
  73    * @param into Container into which the traversed links and gateway informations should be pushed
  74    * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
  75    */
  76   virtual void getLocalRoute(NetCard * src, NetCard * dst, sg_platf_route_cbarg_t into, double* latency) = 0;
  77   /** @brief retrieves the list of all routes of size 1 (of type src x dst x Link) */
  78   /* returns whether we found a bypass path */
  79   bool getBypassRoute(routing::NetCard * src, routing::NetCard * dst,
  80                       /* OUT */ std::vector<surf::Link*> * links, double* latency);
  81
  82 public:
  83   /* @brief get the route between two nodes in the full platform
  84    *
  85    * @param src where from
  86    * @param dst where to
  87    * @param links Accumulator in which all traversed links should be pushed (caller must empty it)
  88    * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
  89    */
  90   static void getGlobalRoute(routing::NetCard * src, routing::NetCard * dst,
  91                              /* OUT */ std::vector<surf::Link*> * links, double* latency);
  92
  93   virtual void getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_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<NetCard*, NetCard*>, BypassRoute*> bypassRoutes_; // src x dst -> route
 104   routing::NetCard* netcard_ = nullptr;                                // Our representative in the father NetZone
 105 };
 106 }
 107 }
 108 }; // Namespace simgrid::kernel::routing
 109
 110 #endif /* SIMGRID_ROUTING_NETZONEIMPL_HPP */