include/simgrid/kernel/routing/NetZoneImpl.hpp

   1 /* Copyright (c) 2016-2019. 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 <simgrid/forward.h>
  10 #include <simgrid/s4u/NetZone.hpp>
  11 #include <xbt/graph.h>
  12
  13 #include <map>
  14 #include <vector>
  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 {
  51   friend simgrid::kernel::EngineImpl; // it destroys netRoot_
  52
  53 protected:
  54   explicit NetZoneImpl(NetZoneImpl* father, const std::string& name, resource::NetworkModel* network_model);
  55   NetZoneImpl(const NetZoneImpl&) = delete;
  56   NetZoneImpl& operator=(const NetZoneImpl&) = delete;
  57   virtual ~NetZoneImpl();
  58
  59 public:
  60   s4u::NetZone* get_iface() { return &piface_; }
  61
  62   /** @brief Make a host within that NetZone */
  63   simgrid::s4u::Host* create_host(const char* name, const std::vector<double>& speed_per_pstate, int core_count,
  64                                   const std::map<std::string, std::string>* props);
  65   /** @brief Creates a new route in this NetZone */
  66   virtual void add_bypass_route(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
  67                                 std::vector<resource::LinkImpl*>& link_list, bool symmetrical);
  68
  69   /** @brief Seal your netzone once you're done adding content, and before routing stuff through it */
  70   virtual void seal();
  71   virtual int add_component(kernel::routing::NetPoint* elm); /* A host, a router or a netzone, whatever */
  72   virtual void add_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
  73                          kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
  74                          std::vector<kernel::resource::LinkImpl*>& link_list, bool symmetrical);
  75
  76 protected:
  77   /**
  78    * @brief Probe the routing path between two points that are local to the called NetZone.
  79    *
  80    * @param src where from
  81    * @param dst where to
  82    * @param into Container into which the traversed links and gateway informations should be pushed
  83    * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
  84    */
  85   virtual void get_local_route(NetPoint* src, NetPoint* dst, RouteCreationArgs* into, double* latency) = 0;
  86   /** @brief retrieves the list of all routes of size 1 (of type src x dst x Link) */
  87   /* returns whether we found a bypass path */
  88   bool get_bypass_route(routing::NetPoint* src, routing::NetPoint* dst,
  89                         /* OUT */ std::vector<resource::LinkImpl*>& links, double* latency);
  90
  91 public:
  92   resource::NetworkModel* network_model_;
  93
  94 private:
  95   s4u::NetZone piface_;
  96
  97   // our content, as known to our graph routing algorithm (maps vertex_id -> vertex)
  98   std::vector<kernel::routing::NetPoint*> vertices_;
  99
 100   NetZoneImpl* father_ = nullptr;
 101
 102   std::vector<NetZoneImpl*> children_; // sub-netzones
 103
 104 public:
 105   unsigned int get_table_size() { return vertices_.size(); }
 106   std::vector<kernel::routing::NetPoint*> get_vertices() { return vertices_; }
 107
 108   NetZoneImpl* get_father();
 109
 110   std::vector<NetZoneImpl*>* get_children(); // Sub netzones
 111
 112 private:
 113   std::string name_;
 114   bool sealed_ = false; // We cannot add more content when sealed
 115
 116 public:
 117   /** @brief Retrieves the name of that netzone as a C++ string */
 118   const std::string& get_name() const { return name_; }
 119   /** @brief Retrieves the name of that netzone as a C string */
 120   const char* get_cname() const;
 121
 122   std::vector<s4u::Host*> get_all_hosts();
 123   int get_host_count();
 124
 125   /* @brief get the route between two nodes in the full platform
 126    *
 127    * @param src where from
 128    * @param dst where to
 129    * @param links Accumulator in which all traversed links should be pushed (caller must empty it)
 130    * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
 131    */
 132   static void get_global_route(routing::NetPoint* src, routing::NetPoint* dst,
 133                                /* OUT */ std::vector<resource::LinkImpl*>& links, double* latency);
 134
 135   virtual void get_graph(xbt_graph_t graph, std::map<std::string, xbt_node_t>* nodes,
 136                          std::map<std::string, xbt_edge_t>* edges) = 0;
 137   enum class RoutingMode {
 138     unset = 0, /**< Undefined type                                   */
 139     base,      /**< Base case: use simple link lists for routing     */
 140     recursive  /**< Recursive case: also return gateway information  */
 141   };
 142   /* FIXME: protect the following fields once the construction madness is sorted out */
 143   RoutingMode hierarchy_ = RoutingMode::unset;
 144
 145 private:
 146   std::map<std::pair<NetPoint*, NetPoint*>, BypassRoute*> bypass_routes_; // src x dst -> route
 147   routing::NetPoint* netpoint_ = nullptr;                                // Our representative in the father NetZone
 148 };
 149 } // namespace routing
 150 } // namespace kernel
 151 }; // namespace simgrid
 152
 153 #endif /* SIMGRID_ROUTING_NETZONEIMPL_HPP */