X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/aa5349f5cacefafa8fb42f88fd7d3e77928b19f3..ea74f5d95928a521a588737e81f1de94eef25d19:/include/simgrid/kernel/routing/ClusterZone.hpp

diff --git a/include/simgrid/kernel/routing/ClusterZone.hpp b/include/simgrid/kernel/routing/ClusterZone.hpp
index 29b0076662..258e354525 100644
--- a/include/simgrid/kernel/routing/ClusterZone.hpp
+++ b/include/simgrid/kernel/routing/ClusterZone.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2013-2021. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2013-2022. 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. */
@@ -7,6 +7,7 @@
 #define SIMGRID_ROUTING_CLUSTER_HPP_
 
 #include <simgrid/kernel/routing/NetZoneImpl.hpp>
+#include <xbt/ex.h>
 
 #include <unordered_map>
 
@@ -14,8 +15,28 @@ namespace simgrid {
 namespace kernel {
 namespace routing {
 
-/** @ingroup ROUTING_API
- *  @brief NetZone where each component is connected through a private link
+/**
+ * @brief Placeholder for old ClusterZone class
+ *
+ * The ClusterZone is now implemented through a StarZone.
+ *
+ * Leave this class as a placeholder to avoid compatibility issues
+ * with codes that use the Engine::get_filtered_netzones.
+ *
+ * The old ClusterZone is now called BaseCluster and it's used ONLY as base to
+ * implement the complex cluster such as Torus, DragonFly and Fat-Tree
+ */
+class ClusterZone : public NetZoneImpl {
+protected:
+  using NetZoneImpl::NetZoneImpl;
+};
+
+/**
+ *  @brief Old ClusterZone implementation
+ *
+ *  NOTE: Cannot be directly instantiated anymore.
+ *
+ *  NetZone where each component is connected through a private link
  *
  *  Cluster zones have a collection of private links that interconnect their components.
  *  This is particularly well adapted to model a collection of elements interconnected
@@ -64,69 +85,77 @@ namespace routing {
  *   <tt>limiter(A)_UP, private(A)_UP, backbone</tt>
  *  (because the private router is directly connected to the cluster core).
  */
-
-class ClusterZone : public NetZoneImpl {
+class XBT_PRIVATE ClusterBase : public ClusterZone {
   /* We use a map instead of a std::vector here because that's a sparse vector. Some values may not exist */
   /* The pair is {link_up, link_down} */
-  std::unordered_map<unsigned int, std::pair<resource::LinkImpl*, resource::LinkImpl*>> private_links_;
-  std::unordered_map<unsigned int, NetPoint*> gateways_; //!< list of gateways for leafs (if they're netzones)
-  resource::LinkImpl* backbone_    = nullptr;
-  NetPoint* router_                = nullptr;
-  bool has_limiter_                = false;
-  bool has_loopback_               = false;
+  std::unordered_map<unsigned long, std::pair<resource::StandardLinkImpl*, resource::StandardLinkImpl*>> private_links_;
+  std::unordered_map<unsigned long, NetPoint*> gateways_; //!< list of gateways for leafs (if they're netzones)
+  resource::StandardLinkImpl* backbone_ = nullptr;
+  NetPoint* router_                 = nullptr;
+  bool has_limiter_                 = false;
+  bool has_loopback_                = false;
   unsigned long num_links_per_node_ = 1; /* may be 1 (if only a private link), 2 or 3 (if limiter and loopback) */
 
-  s4u::Link::SharingPolicy link_sharing_policy_; //!< cluster links: sharing policy
-  double link_bw_;                               //!< cluster links: bandwidth
-  double link_lat_;                              //!< cluster links: latency
+  s4u::Link::SharingPolicy link_sharing_policy_ =
+      s4u::Link::SharingPolicy::SPLITDUPLEX; //!< cluster links: sharing policy
+  double link_bw_  = 0.0;                    //!< cluster links: bandwidth
+  double link_lat_ = 0.0;                    //!< cluster links: latency
 
 protected:
+  using ClusterZone::ClusterZone;
   void set_num_links_per_node(unsigned long num) { num_links_per_node_ = num; }
-  resource::LinkImpl* get_uplink_from(unsigned int position) const { return private_links_.at(position).first; }
-  resource::LinkImpl* get_downlink_to(unsigned int position) const { return private_links_.at(position).second; }
+  resource::StandardLinkImpl* get_uplink_from(unsigned long position) const
+  {
+    return private_links_.at(position).first;
+  }
+  resource::StandardLinkImpl* get_downlink_to(unsigned long position) const
+  {
+    return private_links_.at(position).second;
+  }
 
   double get_link_latency() const { return link_lat_; }
   double get_link_bandwidth() const { return link_bw_; }
   s4u::Link::SharingPolicy get_link_sharing_policy() const { return link_sharing_policy_; }
 
-public:
-  explicit ClusterZone(const std::string& name);
-
-  /** @brief Set the characteristics of links inside a Cluster zone */
-  virtual void set_link_characteristics(double bw, double lat, s4u::Link::SharingPolicy sharing_policy);
   void set_loopback();
   bool has_loopback() const { return has_loopback_; }
   void set_limiter();
   bool has_limiter() const { return has_limiter_; }
-  void set_backbone(resource::LinkImpl* bb) { backbone_ = bb; }
+  void set_backbone(resource::StandardLinkImpl* bb) { backbone_ = bb; }
   bool has_backbone() const { return backbone_ != nullptr; }
   void set_router(NetPoint* router) { router_ = router; }
   /** @brief Sets gateway for the leaf */
-  void set_gateway(unsigned int position, NetPoint* gateway);
+  void set_gateway(unsigned long position, NetPoint* gateway);
   /** @brief Gets gateway for the leaf or nullptr */
-  NetPoint* get_gateway(unsigned int position);
-  void add_private_link_at(unsigned int position, std::pair<resource::LinkImpl*, resource::LinkImpl*> link);
-  bool private_link_exists_at(unsigned int position) const
+  NetPoint* get_gateway(unsigned long position);
+  void add_private_link_at(unsigned long position,
+                           std::pair<resource::StandardLinkImpl*, resource::StandardLinkImpl*> link);
+  bool private_link_exists_at(unsigned long position) const
   {
     return private_links_.find(position) != private_links_.end();
   }
 
-  void get_local_route(NetPoint* src, NetPoint* dst, Route* into, double* latency) override;
   void get_graph(const s_xbt_graph_t* graph, std::map<std::string, xbt_node_t, std::less<>>* nodes,
-                 std::map<std::string, xbt_edge_t, std::less<>>* edges) override;
+                 std::map<std::string, xbt_edge_t, std::less<>>* edges) override
+  {
+    /* the old and generic implementation of get_graph doesn't make sense for complex clusters */
+    THROW_UNIMPLEMENTED;
+  };
 
-  void create_links(int id, int rank);
+  unsigned long node_pos(unsigned long id) const { return id * num_links_per_node_; }
+  unsigned long node_pos_with_loopback(unsigned long id) const { return node_pos(id) + (has_loopback_ ? 1 : 0); }
 
-  unsigned int node_pos(int id) const { return id * num_links_per_node_; }
-  unsigned int node_pos_with_loopback(int id) const { return node_pos(id) + (has_loopback_ ? 1 : 0); }
-  unsigned int node_pos_with_loopback_limiter(int id) const
-  {
-    return node_pos_with_loopback(id) + (has_limiter_ ? 1 : 0);
-  }
+public:
   /** Fill the leaf retriving netpoint from a user's callback */
-  void fill_leaf_from_cb(unsigned int position, const std::vector<unsigned int>& dimensions,
+  void fill_leaf_from_cb(unsigned long position, const std::vector<unsigned long>& dimensions,
                          const s4u::ClusterCallbacks& set_callbacks, NetPoint** node_netpoint, s4u::Link** lb_link,
                          s4u::Link** limiter_link);
+  /** @brief Set the characteristics of links inside a Cluster zone */
+  virtual void set_link_characteristics(double bw, double lat, s4u::Link::SharingPolicy sharing_policy);
+  unsigned long node_pos_with_loopback_limiter(unsigned long id) const
+  {
+    return node_pos_with_loopback(id) + (has_limiter_ ? 1 : 0);
+  }
 };
 } // namespace routing
 } // namespace kernel