include/simgrid/kernel/routing/NetZoneImpl.hpp

   1 /* Copyright (c) 2016-2020. 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/PropertyHolder.hpp>
  12 #include <xbt/graph.h>
  13
  14 #include <map>
  15 #include <vector>
  16
  17 namespace simgrid {
  18 namespace kernel {
  19 namespace routing {
  20
  21 class BypassRoute {
  22 public:
  23   explicit BypassRoute(NetPoint* gwSrc, NetPoint* gwDst) : gw_src(gwSrc), gw_dst(gwDst) {}
  24   NetPoint* gw_src;
  25   NetPoint* gw_dst;
  26   std::vector<resource::LinkImpl*> links;
  27 };
  28
  29 /** @ingroup ROUTING_API
  30  *  @brief Private implementation of the Networking Zones
  31  *
  32  * A netzone is a network container, in charge of routing information between elements (hosts and sub-netzones)
  33  * and to the nearby netzones. In SimGrid, there is a hierarchy of netzones, ie a tree with a unique root
  34  * NetZone, that you can retrieve with simgrid::s4u::Engine::netRoot().
  35  *
  36  * The purpose of the kernel::routing module is to retrieve the routing path between two points in a time- and
  37  * space-efficient manner. This is done by NetZoneImpl::getGlobalRoute(), called when creating a communication to
  38  * retrieve both the list of links that the create communication will use, and the summed latency that these
  39  * links represent.
  40  *
  41  * The network model could recompute the latency by itself from the list, but it would require an additional
  42  * traversal of the link set. This operation being on the critical path of SimGrid, the routing computes the
  43  * latency on the behalf of the network while constructing the link set.
  44  *
  45  * Finding the path between two nodes is rather complex because we navigate a hierarchy of netzones, each of them
  46  * being a full network. In addition, the routing can declare shortcuts (called bypasses), either within a NetZone
  47  * at the route level or directly between NetZones. Also, each NetZone can use a differing routing algorithm, depending
  48  * on its class. @ref FullZone have a full matrix giving explicitly the path between any pair of their
  49  * contained nodes, while @ref DijkstraZone or @ref FloydZone rely on a shortest path algorithm. @ref VivaldiZone
  50  * does not even have any link but only use only coordinate information to compute the latency.
  51  *
  52  * So NetZoneImpl::getGlobalRoute builds the path recursively asking its specific information to each traversed NetZone
  53  * with NetZoneImpl::getLocalRoute, that is redefined in each sub-class.
  54  * The algorithm for that is explained in http://hal.inria.fr/hal-00650233/ (but for historical reasons, NetZones are
  55  * called Autonomous Systems in this article).
  56  *
  57  */
  58 class XBT_PUBLIC NetZoneImpl : public xbt::PropertyHolder {
  59   friend EngineImpl; // it destroys netRoot_
  60   s4u::NetZone piface_;
  61
  62   // our content, as known to our graph routing algorithm (maps vertex_id -> vertex)
  63   std::vector<kernel::routing::NetPoint*> vertices_;
  64
  65   NetZoneImpl* father_ = nullptr;
  66   std::vector<NetZoneImpl*> children_; // sub-netzones
  67   std::string name_;
  68   bool sealed_ = false; // We cannot add more content when sealed
  69
  70   std::map<std::pair<NetPoint*, NetPoint*>, BypassRoute*> bypass_routes_; // src x dst -> route
  71   routing::NetPoint* netpoint_ = nullptr;                                 // Our representative in the father NetZone
  72
  73 protected:
  74   explicit NetZoneImpl(NetZoneImpl* father, const std::string& name, resource::NetworkModel* network_model);
  75   NetZoneImpl(const NetZoneImpl&) = delete;
  76   NetZoneImpl& operator=(const NetZoneImpl&) = delete;
  77   virtual ~NetZoneImpl();
  78
  79   /**
  80    * @brief Probe the routing path between two points that are local to the called NetZone.
  81    *
  82    * @param src where from
  83    * @param dst where to
  84    * @param into Container into which the traversed links and gateway informations should be pushed
  85    * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
  86    */
  87   virtual void get_local_route(NetPoint* src, NetPoint* dst, RouteCreationArgs* into, double* latency) = 0;
  88   /** @brief retrieves the list of all routes of size 1 (of type src x dst x Link) */
  89   /* returns whether we found a bypass path */
  90   bool get_bypass_route(routing::NetPoint* src, routing::NetPoint* dst,
  91                         /* OUT */ std::vector<resource::LinkImpl*>& links, double* latency);
  92
  93 public:
  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
 100   /* FIXME: protect the following fields once the construction madness is sorted out */
 101   RoutingMode hierarchy_ = RoutingMode::unset;
 102
 103   resource::NetworkModel* network_model_;
 104
 105   s4u::NetZone* get_iface() { return &piface_; }
 106   unsigned int get_table_size() const { return vertices_.size(); }
 107   std::vector<kernel::routing::NetPoint*> get_vertices() const { return vertices_; }
 108   NetZoneImpl* get_father() const { return father_; }
 109   /** @brief Returns the list of direct children (no grand-children). This returns the internal data, no copy.
 110    * Don't mess with it.*/
 111   std::vector<NetZoneImpl*>* get_children() { return &children_; }
 112   /** @brief Retrieves the name of that netzone as a C++ string */
 113   const std::string& get_name() const { return name_; }
 114   /** @brief Retrieves the name of that netzone as a C string */
 115   const char* get_cname() const { return name_.c_str(); };
 116
 117   std::vector<s4u::Host*> get_all_hosts() const;
 118   int get_host_count() const;
 119
 120   /** @brief Make a host within that NetZone */
 121   s4u::Host* create_host(const std::string& name, const std::vector<double>& speed_per_pstate, int core_count,
 122                          const std::map<std::string, std::string>* props);
 123   /** @brief Creates a new route in this NetZone */
 124   virtual void add_bypass_route(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
 125                                 std::vector<resource::LinkImpl*>& link_list, bool symmetrical);
 126
 127   /** @brief Seal your netzone once you're done adding content, and before routing stuff through it */
 128   virtual void seal() { sealed_ = true; };
 129   virtual int add_component(kernel::routing::NetPoint* elm); /* A host, a router or a netzone, whatever */
 130   virtual void add_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
 131                          kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
 132                          std::vector<kernel::resource::LinkImpl*>& link_list, bool symmetrical);
 133
 134   /* @brief get the route between two nodes in the full platform
 135    *
 136    * @param src where from
 137    * @param dst where to
 138    * @param links Accumulator in which all traversed links should be pushed (caller must empty it)
 139    * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
 140    */
 141   static void get_global_route(routing::NetPoint* src, routing::NetPoint* dst,
 142                                /* OUT */ std::vector<resource::LinkImpl*>& links, double* latency);
 143
 144   virtual void get_graph(const s_xbt_graph_t* graph, std::map<std::string, xbt_node_t>* nodes,
 145                          std::map<std::string, xbt_edge_t>* edges) = 0;
 146 };
 147 } // namespace routing
 148 } // namespace kernel
 149 } // namespace simgrid
 150
 151 #endif /* SIMGRID_ROUTING_NETZONEIMPL_HPP */