Torus/Fat-Tree/Dragonfly: Aggregate callbacks

[simgrid.git] / include / simgrid / kernel / routing / ClusterZone.hpp

diff --git a/include/simgrid/kernel/routing/ClusterZone.hpp b/include/simgrid/kernel/routing/ClusterZone.hpp
index f6ab794..1280241 100644 (file)
--- a/include/simgrid/kernel/routing/ClusterZone.hpp
+++ b/include/simgrid/kernel/routing/ClusterZone.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2013-2020. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2013-2021. 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. */
@@ -66,22 +66,46 @@ namespace routing {
  */
 
 class ClusterZone : public NetZoneImpl {
-public:
-  explicit ClusterZone(NetZoneImpl* father, const std::string& name, resource::NetworkModel* netmodel);
+  /* 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;
+  unsigned int num_links_per_node_ = 1; /* may be 1 (if only a private link), 2 or 3 (if limiter and loopback) */
 
-  void get_local_route(NetPoint* src, NetPoint* dst, RouteCreationArgs* into, double* latency) override;
-  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) override;
+protected:
+  void set_num_links_per_node(unsigned int 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; }
+
+public:
+  explicit ClusterZone(const std::string& name);
 
-  virtual void create_links_for_node(ClusterCreationArgs* cluster, int id, int rank, unsigned int position);
-  virtual void parse_specific_arguments(ClusterCreationArgs* cluster)
+  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; }
+  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);
+  /** @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
   {
-    /* this routing method does not require any specific argument */
+    return private_links_.find(position) != private_links_.end();
   }
 
-  /* 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<kernel::resource::LinkImpl*, kernel::resource::LinkImpl*>> private_links_;
+  void get_local_route(NetPoint* src, NetPoint* dst, RouteCreationArgs* 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;
+
+  void create_links_for_node(const ClusterCreationArgs* cluster, int id, int rank, unsigned int position);
 
   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); }
@@ -89,13 +113,10 @@ public:
   {
     return node_pos_with_loopback(id) + (has_limiter_ ? 1 : 0);
   }
-
-  void* loopback_                = nullptr;
-  kernel::resource::LinkImpl* backbone_ = nullptr;
-  NetPoint* router_              = nullptr;
-  bool has_limiter_                = false;
-  bool has_loopback_               = false;
-  unsigned int num_links_per_node_ = 1; /* may be 1 (if only a private link), 2 or 3 (if limiter and loopback) */
+  /** Fill the leaf retriving netpoint from a user's callback */
+  void fill_leaf_from_cb(unsigned int position, const std::vector<unsigned int>& dimensions,
+                         const s4u::ClusterCallbacks& set_callbacks, NetPoint** node_netpoint, s4u::Link** lb_link,
+                         s4u::Link** limiter_link);
 };
 } // namespace routing
 } // namespace kernel