X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/a22eb0ac7d22d5beaa6e33adf8f85c28dac59024..de57b34916659892d2dc26edabf552253afe2c18:/src/kernel/routing/ClusterZone.hpp

diff --git a/src/kernel/routing/ClusterZone.hpp b/src/kernel/routing/ClusterZone.hpp
index 8f08d195ef..a9a786603d 100644
--- a/src/kernel/routing/ClusterZone.hpp
+++ b/src/kernel/routing/ClusterZone.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2013-2016. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2013-2017. 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. */
@@ -14,29 +14,88 @@ namespace simgrid {
 namespace kernel {
 namespace routing {
 
-class XBT_PRIVATE AsCluster: public AsImpl {
+/** @ingroup ROUTING_API
+ *  @brief 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
+ *  through a hub or a through a switch.
+ *
+ *  In a cluster, each component are given from 1 to 3 private links at creation:
+ *   - Private link (mandatory): link connecting the component to the cluster core.
+ *   - Limiter (optional): Additional link on the way from the component to the cluster core
+ *   - Loopback (optional): non-shared link connecting the component to itself.
+ *
+ *  Then, the cluster core may be constituted of a specific backbone link or not;
+ *  A backbone can easily represent a network connected in a Hub.
+ *  If you want to model a switch, either don't use a backbone at all,
+ *  or use a fatpipe link (non-shared link) to represent the switch backplane.
+ *
+ *  \verbatim
+ *   (outer world)
+ *         |
+ *   ======+====== <--backbone
+ *   |   |   |   |
+ * l0| l1| l2| l4| <-- private links + limiters
+ *   |   |   |   |
+ *   X   X   X   X <-- cluster's hosts
+ * \endverbatim
+ *
+ * \verbatim
+ *   (outer world)
+ *         |       <-- NO backbone
+ *        /|\
+ *       / | \     <-- private links + limiters     __________
+ *      /  |  \
+ *  l0 / l1|   \l2
+ *    /    |    \
+ * host0 host1 host2
+ * \endverbatim
+
+ *  So, a communication from an host A to an host B goes through the following links (if they exist):
+ *   <tt>limiter(A)_UP, private(A)_UP, backbone, private(B)_DOWN, limiter(B)_DOWN.</tt>
+ *  link_UP and link_DOWN usually share the exact same characteristics, but their
+ *  performance are not shared, to model the fact that TCP links are full-duplex.
+ *
+ *  A cluster is connected to the outer world through a router that is connected
+ *  directly to the cluster's backbone (no private link).
+ *
+ *  A communication from an host A to the outer world goes through the following links:
+ *   <tt>limiter(A)_UP, private(A)_UP, backbone</tt>
+ *  (because the private router is directly connected to the cluster core).
+ */
+
+class ClusterZone : public NetZoneImpl {
 public:
-  explicit AsCluster(As* father, const char* name);
+  explicit ClusterZone(NetZone* father, std::string name);
 
-  void getLocalRoute(NetCard* src, NetCard* dst, sg_platf_route_cbarg_t into, double* latency) override;
-  void getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges) override;
+  void getLocalRoute(NetPoint* src, NetPoint* dst, RouteCreationArgs* into, double* latency) override;
+  void getGraph(xbt_graph_t graph, std::map<std::string, xbt_node_t>* nodes,
+                std::map<std::string, xbt_edge_t>* edges) override;
 
-  virtual void create_links_for_node(sg_platf_cluster_cbarg_t cluster, int id, int rank, int position);
-  virtual void parse_specific_arguments(sg_platf_cluster_cbarg_t cluster) {}
+  virtual void create_links_for_node(ClusterCreationArgs* cluster, int id, int rank, unsigned int position);
+  virtual void parse_specific_arguments(ClusterCreationArgs* cluster)
+  {
+    /* this routing method does not require any specific argument */
+  }
 
   /* We use a map instead of a std::vector here because that's a sparse vector. Some values may not exist */
   /* The pair is {linkUp, linkDown} */
-  std::unordered_map<unsigned int, std::pair<Link*, Link*>> privateLinks_;
+  std::unordered_map<unsigned int, std::pair<surf::LinkImpl*, surf::LinkImpl*>> privateLinks_;
 
-  Link* backbone_ = nullptr;
-  void *loopback_ = nullptr;
-  NetCard *router_ = nullptr;
-  bool hasLimiter_  = false;
-  bool hasLoopback_ = false;
-  unsigned int linkCountPerNode_ = 1; /* may be 1 (if only a private link), 2 or 3 (if limiter and loopback) */
+  unsigned int nodePosition(int id) { return id * linkCountPerNode_; }
+  unsigned int nodePositionWithLoopback(int id) { return nodePosition(id) + (hasLoopback_ ? 1 : 0); }
+  unsigned int nodePositionWithLimiter(int id) { return nodePositionWithLoopback(id) + (hasLimiter_ ? 1 : 0); }
 
+  surf::LinkImpl* backbone_      = nullptr;
+  void* loopback_                = nullptr;
+  NetPoint* router_              = nullptr;
+  bool hasLimiter_               = false;
+  bool hasLoopback_              = false;
+  unsigned int linkCountPerNode_ = 1; /* may be 1 (if only a private link), 2 or 3 (if limiter and loopback) */
 };
-
-}}} // namespace
+}
+}
+} // namespace
 
 #endif /* SIMGRID_ROUTING_CLUSTER_HPP_ */