Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
finish the API under the new format
[simgrid.git] / include / simgrid / kernel / routing / NetZoneImpl.hpp
index f1b55e6..585bc78 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2016-2018. The SimGrid Team. All rights reserved.               */
+/* Copyright (c) 2016-2020. The SimGrid Team. All rights reserved.               */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -8,14 +8,23 @@
 
 #include <simgrid/forward.h>
 #include <simgrid/s4u/NetZone.hpp>
+#include <xbt/PropertyHolder.hpp>
 #include <xbt/graph.h>
 
 #include <map>
+#include <vector>
 
 namespace simgrid {
 namespace kernel {
 namespace routing {
-class BypassRoute;
+
+class BypassRoute {
+public:
+  explicit BypassRoute(NetPoint* gwSrc, NetPoint* gwDst) : gw_src(gwSrc), gw_dst(gwDst) {}
+  NetPoint* gw_src;
+  NetPoint* gw_dst;
+  std::vector<resource::LinkImpl*> links;
+};
 
 /** @ingroup ROUTING_API
  *  @brief Private implementation of the Networking Zones
@@ -46,22 +55,27 @@ class BypassRoute;
  * called Autonomous Systems in this article).
  *
  */
-class XBT_PUBLIC NetZoneImpl : public s4u::NetZone {
-  friend simgrid::kernel::EngineImpl; // it destroys netRoot_
+class XBT_PUBLIC NetZoneImpl : public xbt::PropertyHolder {
+  friend EngineImpl; // it destroys netRoot_
+  s4u::NetZone piface_;
 
-protected:
-  explicit NetZoneImpl(NetZone* father, std::string name);
-  virtual ~NetZoneImpl();
+  // our content, as known to our graph routing algorithm (maps vertex_id -> vertex)
+  std::vector<kernel::routing::NetPoint*> vertices_;
 
-public:
-  /** @brief Make an host within that NetZone */
-  simgrid::s4u::Host* createHost(const char* name, std::vector<double>* speedPerPstate, int coreAmount,
-                                 std::map<std::string, std::string>* props);
-  /** @brief Creates a new route in this NetZone */
-  void addBypassRoute(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
-                      std::vector<simgrid::surf::LinkImpl*>& link_list, bool symmetrical) override;
+  NetZoneImpl* father_ = nullptr;
+  std::vector<NetZoneImpl*> children_; // sub-netzones
+  std::string name_;
+  bool sealed_ = false; // We cannot add more content when sealed
+
+  std::map<std::pair<NetPoint*, NetPoint*>, BypassRoute*> bypass_routes_; // src x dst -> route
+  routing::NetPoint* netpoint_ = nullptr;                                 // Our representative in the father NetZone
 
 protected:
+  explicit NetZoneImpl(NetZoneImpl* father, const std::string& name, resource::NetworkModel* network_model);
+  NetZoneImpl(const NetZoneImpl&) = delete;
+  NetZoneImpl& operator=(const NetZoneImpl&) = delete;
+  virtual ~NetZoneImpl();
+
   /**
    * @brief Probe the routing path between two points that are local to the called NetZone.
    *
@@ -70,39 +84,68 @@ protected:
    * @param into Container into which the traversed links and gateway informations should be pushed
    * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
    */
-  virtual void getLocalRoute(NetPoint* src, NetPoint* dst, RouteCreationArgs* into, double* latency) = 0;
+  virtual void get_local_route(NetPoint* src, NetPoint* dst, RouteCreationArgs* into, double* latency) = 0;
   /** @brief retrieves the list of all routes of size 1 (of type src x dst x Link) */
   /* returns whether we found a bypass path */
-  bool getBypassRoute(routing::NetPoint* src, routing::NetPoint* dst,
-                      /* OUT */ std::vector<surf::LinkImpl*>& links, double* latency);
+  bool get_bypass_route(routing::NetPoint* src, routing::NetPoint* dst,
+                        /* OUT */ std::vector<resource::LinkImpl*>& links, double* latency);
 
 public:
-  /* @brief get the route between two nodes in the full platform
-   *
-   * @param src where from
-   * @param dst where to
-   * @param links Accumulator in which all traversed links should be pushed (caller must empty it)
-   * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
-   */
-  static void getGlobalRoute(routing::NetPoint* src, routing::NetPoint* dst,
-                             /* OUT */ std::vector<surf::LinkImpl*>& links, double* latency);
-
-  virtual void getGraph(xbt_graph_t graph, std::map<std::string, xbt_node_t>* nodes,
-                        std::map<std::string, xbt_edge_t>* edges) = 0;
   enum class RoutingMode {
     unset = 0, /**< Undefined type                                   */
     base,      /**< Base case: use simple link lists for routing     */
     recursive  /**< Recursive case: also return gateway information  */
   };
+
   /* FIXME: protect the following fields once the construction madness is sorted out */
   RoutingMode hierarchy_ = RoutingMode::unset;
 
-private:
-  std::map<std::pair<NetPoint*, NetPoint*>, BypassRoute*> bypassRoutes_; // src x dst -> route
-  routing::NetPoint* netpoint_ = nullptr;                                // Our representative in the father NetZone
+  resource::NetworkModel* network_model_;
+
+  s4u::NetZone* get_iface() { return &piface_; }
+  unsigned int get_table_size() const { return vertices_.size(); }
+  std::vector<kernel::routing::NetPoint*> get_vertices() const { return vertices_; }
+  NetZoneImpl* get_father() const { return father_; }
+  /** @brief Returns the list of direct children (no grand-children). This returns the internal data, no copy.
+   * Don't mess with it.*/
+  std::vector<NetZoneImpl*>* get_children() { return &children_; }
+  /** @brief Retrieves the name of that netzone as a C++ string */
+  const std::string& get_name() const { return name_; }
+  /** @brief Retrieves the name of that netzone as a C string */
+  const char* get_cname() const { return name_.c_str(); };
+
+  std::vector<s4u::Host*> get_all_hosts() const;
+  int get_host_count() const;
+
+  /** @brief Make a host within that NetZone */
+  s4u::Host* create_host(const std::string& name, const std::vector<double>& speed_per_pstate, int core_count,
+                         const std::map<std::string, std::string>* props);
+  /** @brief Creates a new route in this NetZone */
+  virtual void add_bypass_route(NetPoint* src, NetPoint* dst, NetPoint* gw_src, NetPoint* gw_dst,
+                                std::vector<resource::LinkImpl*>& link_list, bool symmetrical);
+
+  /** @brief Seal your netzone once you're done adding content, and before routing stuff through it */
+  virtual void seal() { sealed_ = true; };
+  virtual int add_component(kernel::routing::NetPoint* elm); /* A host, a router or a netzone, whatever */
+  virtual void add_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
+                         kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
+                         std::vector<kernel::resource::LinkImpl*>& link_list, bool symmetrical);
+
+  /* @brief get the route between two nodes in the full platform
+   *
+   * @param src where from
+   * @param dst where to
+   * @param links Accumulator in which all traversed links should be pushed (caller must empty it)
+   * @param latency Accumulator in which the latencies should be added (caller must set it to 0)
+   */
+  static void get_global_route(routing::NetPoint* src, routing::NetPoint* dst,
+                               /* OUT */ std::vector<resource::LinkImpl*>& links, double* latency);
+
+  virtual void get_graph(const s_xbt_graph_t* graph, std::map<std::string, xbt_node_t>* nodes,
+                         std::map<std::string, xbt_edge_t>* edges) = 0;
 };
 } // namespace routing
 } // namespace kernel
-}; // namespace simgrid
+} // namespace simgrid
 
 #endif /* SIMGRID_ROUTING_NETZONEIMPL_HPP */