1 /* Copyright (c) 2013-2021. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_ROUTING_CLUSTER_HPP_
7 #define SIMGRID_ROUTING_CLUSTER_HPP_
9 #include <simgrid/kernel/routing/NetZoneImpl.hpp>
11 #include <unordered_map>
17 /** @ingroup ROUTING_API
18 * @brief NetZone where each component is connected through a private link
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.
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.
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.
37 * ======+====== <--backbone
39 * l0| l1| l2| l4| <-- private links + limiters
41 * X X X X <-- cluster's hosts
48 * / | \ <-- private links + limiters __________
55 * So, a communication from a host A to a 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.
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).
63 * A communication from a 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).
68 class ClusterZone : public NetZoneImpl {
70 explicit ClusterZone(NetZoneImpl* father, const std::string& name, resource::NetworkModel* netmodel);
72 void get_local_route(NetPoint* src, NetPoint* dst, RouteCreationArgs* into, double* latency) override;
73 void get_graph(const s_xbt_graph_t* graph, std::map<std::string, xbt_node_t, std::less<>>* nodes,
74 std::map<std::string, xbt_edge_t, std::less<>>* edges) override;
76 virtual void create_links_for_node(ClusterCreationArgs* cluster, int id, int rank, unsigned int position);
77 virtual void parse_specific_arguments(ClusterCreationArgs*)
79 /* this routing method does not require any specific argument */
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_;
86 unsigned int node_pos(int id) const { return id * num_links_per_node_; }
87 unsigned int node_pos_with_loopback(int id) const { return node_pos(id) + (has_loopback_ ? 1 : 0); }
88 unsigned int node_pos_with_loopback_limiter(int id) const
90 return node_pos_with_loopback(id) + (has_limiter_ ? 1 : 0);
93 kernel::resource::LinkImpl* backbone_ = nullptr;
94 NetPoint* router_ = nullptr;
95 bool has_limiter_ = false;
96 bool has_loopback_ = false;
97 unsigned int num_links_per_node_ = 1; /* may be 1 (if only a private link), 2 or 3 (if limiter and loopback) */
99 } // namespace routing
100 } // namespace kernel
101 } // namespace simgrid
103 #endif /* SIMGRID_ROUTING_CLUSTER_HPP_ */