Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
give a network_model to each NetZone (unused for now)
[simgrid.git] / include / simgrid / kernel / routing / ClusterZone.hpp
1 /* Copyright (c) 2013-2018. 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_CLUSTER_HPP_
7 #define SIMGRID_ROUTING_CLUSTER_HPP_
8
9 #include <simgrid/kernel/routing/NetZoneImpl.hpp>
10
11 #include <unordered_map>
12
13 namespace simgrid {
14 namespace kernel {
15 namespace routing {
16
17 /** @ingroup ROUTING_API
18  *  @brief NetZone where each component is connected through a private link
19  *
20  *  Cluster zones have a collection of private links that interconnect their components.
21  *  This is particularly well adapted to model a collection of elements interconnected
22  *  through a hub or a through a switch.
23  *
24  *  In a cluster, each component are given from 1 to 3 private links at creation:
25  *   - Private link (mandatory): link connecting the component to the cluster core.
26  *   - Limiter (optional): Additional link on the way from the component to the cluster core
27  *   - Loopback (optional): non-shared link connecting the component to itself.
28  *
29  *  Then, the cluster core may be constituted of a specific backbone link or not;
30  *  A backbone can easily represent a network connected in a Hub.
31  *  If you want to model a switch, either don't use a backbone at all,
32  *  or use a fatpipe link (non-shared link) to represent the switch backplane.
33  *
34  *  \verbatim
35  *   (outer world)
36  *         |
37  *   ======+====== <--backbone
38  *   |   |   |   |
39  * l0| l1| l2| l4| <-- private links + limiters
40  *   |   |   |   |
41  *   X   X   X   X <-- cluster's hosts
42  * \endverbatim
43  *
44  * \verbatim
45  *   (outer world)
46  *         |       <-- NO backbone
47  *        /|\
48  *       / | \     <-- private links + limiters     __________
49  *      /  |  \
50  *  l0 / l1|   \l2
51  *    /    |    \
52  * host0 host1 host2
53  * \endverbatim
54
55  *  So, a communication from an host A to an host B goes through the following links (if they exist):
56  *   <tt>limiter(A)_UP, private(A)_UP, backbone, private(B)_DOWN, limiter(B)_DOWN.</tt>
57  *  link_UP and link_DOWN usually share the exact same characteristics, but their
58  *  performance are not shared, to model the fact that TCP links are full-duplex.
59  *
60  *  A cluster is connected to the outer world through a router that is connected
61  *  directly to the cluster's backbone (no private link).
62  *
63  *  A communication from an host A to the outer world goes through the following links:
64  *   <tt>limiter(A)_UP, private(A)_UP, backbone</tt>
65  *  (because the private router is directly connected to the cluster core).
66  */
67
68 class ClusterZone : public NetZoneImpl {
69 public:
70   explicit ClusterZone(NetZoneImpl* father, std::string name, resource::NetworkModel* netmodel);
71
72   void get_local_route(NetPoint* src, NetPoint* dst, RouteCreationArgs* into, double* latency) override;
73   void get_graph(xbt_graph_t graph, std::map<std::string, xbt_node_t>* nodes,
74                  std::map<std::string, xbt_edge_t>* edges) override;
75
76   virtual void create_links_for_node(ClusterCreationArgs* cluster, int id, int rank, unsigned int position);
77   virtual void parse_specific_arguments(ClusterCreationArgs* cluster)
78   {
79     /* this routing method does not require any specific argument */
80   }
81
82   /* We use a map instead of a std::vector here because that's a sparse vector. Some values may not exist */
83   /* The pair is {link_up, link_down} */
84   std::unordered_map<unsigned int, std::pair<kernel::resource::LinkImpl*, kernel::resource::LinkImpl*>> private_links_;
85
86   unsigned int node_pos(int id) { return id * num_links_per_node_; }
87   unsigned int node_pos_with_loopback(int id) { return node_pos(id) + (has_loopback_ ? 1 : 0); }
88   unsigned int node_pos_with_loopback_limiter(int id) { return node_pos_with_loopback(id) + (has_limiter_ ? 1 : 0); }
89
90   void* loopback_                = nullptr;
91   kernel::resource::LinkImpl* backbone_ = nullptr;
92   NetPoint* router_              = nullptr;
93   bool has_limiter_                = false;
94   bool has_loopback_               = false;
95   unsigned int num_links_per_node_ = 1; /* may be 1 (if only a private link), 2 or 3 (if limiter and loopback) */
96 };
97 } // namespace routing
98 } // namespace kernel
99 } // namespace simgrid
100
101 #endif /* SIMGRID_ROUTING_CLUSTER_HPP_ */