1 /* Copyright (c) 2016-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_S4U_NETZONE_HPP
7 #define SIMGRID_S4U_NETZONE_HPP
9 #include <simgrid/forward.h>
10 #include <simgrid/s4u/Link.hpp>
11 #include <xbt/graph.h>
12 #include <xbt/signal.hpp>
16 #include <unordered_map>
23 /** @brief Networking Zones
25 * A netzone is a network container, in charge of routing information between elements (hosts) and to the nearby
26 * netzones. In SimGrid, there is a hierarchy of netzones, with a unique root zone (that you can retrieve from the
29 class XBT_PUBLIC NetZone {
30 kernel::routing::NetZoneImpl* const pimpl_;
33 friend kernel::routing::NetZoneImpl;
35 explicit NetZone(kernel::routing::NetZoneImpl* impl) : pimpl_(impl) {}
38 /** @brief Retrieves the name of that netzone as a C++ string */
39 const std::string& get_name() const;
40 /** @brief Retrieves the name of that netzone as a C string */
41 const char* get_cname() const;
43 XBT_ATTRIB_DEPRECATED_v331("Please use get_parent()") NetZone* get_father();
44 NetZone* get_parent() const;
45 NetZone* set_parent(const NetZone* parent);
47 std::vector<Host*> get_all_hosts() const;
48 int get_host_count() const;
50 kernel::routing::NetZoneImpl* get_impl() const { return pimpl_; }
52 /** Get the properties assigned to a netzone */
53 const std::unordered_map<std::string, std::string>* get_properties() const;
54 /** Retrieve the property value (or nullptr if not set) */
55 const char* get_property(const std::string& key) const;
56 void set_property(const std::string& key, const std::string& value);
57 /** @brief Get the netpoint associated to this netzone */
58 kernel::routing::NetPoint* get_netpoint();
60 std::vector<NetZone*> get_children() const;
61 XBT_ATTRIB_DEPRECATED_v332("Please use set_parent() to manage NetZone's relationship") NetZone* add_child(
64 void extract_xbt_graph(const s_xbt_graph_t* graph, std::map<std::string, xbt_node_t, std::less<>>* nodes,
65 std::map<std::string, xbt_edge_t, std::less<>>* edges);
67 /* Add content to the netzone, at parsing time. It should be sealed afterward. */
68 int add_component(kernel::routing::NetPoint* elm); /* A host, a router or a netzone, whatever */
71 * @brief Add a route between 2 netpoints
74 * - route between 2 hosts/routers in same netzone, no gateway is needed
75 * - route between 2 netzones, connecting 2 gateways.
77 * @param src Source netzone's netpoint
78 * @param dst Destination netzone' netpoint
79 * @param src_gw Netpoint of the gateway in the source netzone
80 * @param dst_gw Netpoint of the gateway in the destination netzone
81 * @param link_list List of links used in this communication
82 * @param symmetrical Bi-directional communication
84 void add_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
85 kernel::routing::NetPoint* gw_dst, const std::vector<Link*>& link_list, bool symmetrical = true);
87 XBT_ATTRIB_DEPRECATED_v332("Please use add_route() method which uses s4u::Link instead of LinkImpl") void add_route(
88 kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst, kernel::routing::NetPoint* gw_src,
89 kernel::routing::NetPoint* gw_dst, const std::vector<kernel::resource::LinkImpl*>& link_list, bool symmetrical);
90 void add_bypass_route(kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
91 kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
92 std::vector<kernel::resource::LinkImpl*>& link_list, bool symmetrical);
94 /*** Called on each newly created regular route (not on bypass routes) */
95 static xbt::signal<void(bool symmetrical, kernel::routing::NetPoint* src, kernel::routing::NetPoint* dst,
96 kernel::routing::NetPoint* gw_src, kernel::routing::NetPoint* gw_dst,
97 std::vector<kernel::resource::LinkImpl*> const& link_list)>
99 static xbt::signal<void(NetZone const&)> on_creation;
100 static xbt::signal<void(NetZone const&)> on_seal;
103 * @brief Create a host
105 * @param name Host name
106 * @param speed_per_state Vector of CPU's speeds
108 s4u::Host* create_host(const std::string& name, const std::vector<double>& speed_per_pstate);
109 s4u::Host* create_host(const std::string& name, double speed);
111 * @brief Create a Host (string version)
113 * @throw std::invalid_argument if speed format is incorrect.
115 s4u::Host* create_host(const std::string& name, const std::vector<std::string>& speed_per_pstate);
116 s4u::Host* create_host(const std::string& name, const std::string& speed);
119 * @brief Create a link
121 * @param name Link name
122 * @param bandwidths Link's speed (vector for wifi links)
123 * @throw std::invalid_argument if bandwidth format is incorrect.
125 s4u::Link* create_link(const std::string& name, const std::vector<double>& bandwidths);
126 s4u::Link* create_link(const std::string& name, double bandwidth);
128 /** @brief Create a link (string version) */
129 s4u::Link* create_link(const std::string& name, const std::vector<std::string>& bandwidths);
130 s4u::Link* create_link(const std::string& name, const std::string& bandwidth);
133 * @brief Make a router within that NetZone
135 * @param name Router name
137 kernel::routing::NetPoint* create_router(const std::string& name);
139 /** @brief Seal this netzone configuration */
143 /** @brief Auxiliary function to get list of LinkImpl */
144 static std::vector<kernel::resource::LinkImpl*> get_link_list_impl(const std::vector<Link*> link_list);
147 // External constructors so that the types (and the types of their content) remain hidden
148 XBT_PUBLIC NetZone* create_full_zone(const std::string& name);
149 XBT_PUBLIC NetZone* create_cluster_zone(const std::string& name);
150 XBT_PUBLIC NetZone* create_star_zone(const std::string& name);
151 XBT_PUBLIC NetZone* create_dijkstra_zone(const std::string& name, bool cache);
152 XBT_PUBLIC NetZone* create_empty_zone(const std::string& name);
153 XBT_PUBLIC NetZone* create_floyd_zone(const std::string& name);
154 XBT_PUBLIC NetZone* create_vivaldi_zone(const std::string& name);
155 XBT_PUBLIC NetZone* create_wifi_zone(const std::string& name);
157 * @brief Callback used to set the netpoint and gateway located at some leaf of clusters (Torus, FatTree, etc)
159 * The netpoint can be either a host, router or another netzone.
160 * Gateway must be non-null if netpoint is a netzone
162 * @param zone: The newly create zone, needed for creating new resources (hosts, links)
163 * @param coord: the coordinates of the element
164 * @param id: Internal identifier of the element
165 * @return pair<NetPoint*, NetPoint*>: returns a pair of netpoint and gateway.
167 using ClusterNetPointCb = std::pair<kernel::routing::NetPoint*, kernel::routing::NetPoint*>(
168 NetZone* zone, const std::vector<unsigned int>& coord, int id);
170 * @brief Callback used to set the links for some leaf of the cluster (Torus, FatTree, etc)
172 * @param zone: The newly create zone, needed for creating new resources (hosts, links)
173 * @param coord: the coordinates of the element
174 * @param id: Internal identifier of the element
175 * @return Pointer to the Link
177 using ClusterLinkCb = Link*(NetZone* zone, const std::vector<unsigned int>& coord, int id);
179 * @brief Create a torus zone
181 * Torus clusters are characterized by:
182 * - dimensions, eg. {3,3,3} creates a torus with X = 3 elements, Y = 3 and Z = 3. In total, this cluster have 27
184 * - inter-node communication: (bandwidth, latency, sharing_policy) the elements are connected through regular links
185 * with these characteristics
186 * More details in: <a href="https://simgrid.org/doc/latest/Platform_examples.html?highlight=torus#torus-cluster">Torus
189 * Moreover, this method accepts 3 callbacks to populate the cluster: set_netpoint, set_loopback and set_limiter .
191 * Note that the all elements in a Torus cluster must have (or not) the same elements (loopback and limiter)
193 * @param name NetZone's name
194 * @param parent Pointer to parent's netzone (nullptr if root netzone). Needed to be able to create the resources inside
196 * @param dimensions List of positive integers (> 0) which determines the torus' dimensions
197 * @param bandwidth Characteristics of the inter-nodes link
198 * @param latency Characteristics of the inter-nodes link
199 * @param sharing_policy Characteristics of the inter-nodes link
200 * @param set_netpoint Callback to set the netpoint of an element in the torus
201 * @param set_loopback Callback to set the loopback
202 * @param set_limiter Callback to set the limiter
203 * @return Pointer to new netzone
205 XBT_PUBLIC NetZone* create_torus_zone(const std::string& name, const NetZone* parent,
206 const std::vector<unsigned int>& dimensions, double bandwidth, double latency,
207 Link::SharingPolicy sharing_policy,
208 const std::function<ClusterNetPointCb>& set_netpoint,
209 const std::function<ClusterLinkCb>& set_loopback = {},
210 const std::function<ClusterLinkCb>& set_limiter = {});
212 /** @brief Aggregates the parameters necessary to build a Fat-tree zone */
213 struct FatTreeParams {
215 std::vector<unsigned int> down;
216 std::vector<unsigned int> up;
217 std::vector<unsigned int> number;
218 FatTreeParams(unsigned int n_levels, const std::vector<unsigned int>& down_links,
219 const std::vector<unsigned int>& up_links, const std::vector<unsigned int>& links_number)
220 : levels(n_levels), down(down_links), up(up_links), number(links_number)
221 { /* nothing to do */
225 * @brief Create a Fat-Tree zone
227 * Fat-Tree clusters are characterized by:
228 * - levels: number of levels in the cluster, e.g. 2 (the final tree will have n+1 levels)
229 * - downlinks: for each level, how many connections between elements below them, e.g. 2, 3: level 1 nodes are connected
230 * to 2 nodes in level 2, which are connected to 3 nodes below. Determines the number total of leaves in the tree.
231 * - uplinks: for each level, how nodes are connected, e.g. 1, 2
232 * - link count: for each level, number of links connecting the nodes, e.g. 1, 1
234 * The best way to understand it is looking to the doc available in: <a
235 * href="https://simgrid.org/doc/latest/Platform_examples.html#fat-tree-cluster">Fat Tree Cluster</a>
237 * Moreover, this method accepts 3 callbacks to populate the cluster: set_netpoint, set_loopback and set_limiter .
239 * Note that the all elements in a Fat-Tree cluster must have (or not) the same elements (loopback and limiter)
241 * @param name NetZone's name
242 * @param parent Pointer to parent's netzone (nullptr if root netzone). Needed to be able to create the resources inside
244 * @param parameters Characteristics of this Fat-Tree
245 * @param bandwidth Characteristics of the inter-nodes link
246 * @param latency Characteristics of the inter-nodes link
247 * @param sharing_policy Characteristics of the inter-nodes link
248 * @param set_netpoint Callback to set the netpoint of an element in the torus
249 * @param set_loopback Callback to set the loopback
250 * @param set_limiter Callback to set the limiter
251 * @return Pointer to new netzone
253 XBT_PUBLIC NetZone* create_fatTree_zone(const std::string& name, const NetZone* parent, const FatTreeParams& parameters,
254 double bandwidth, double latency, Link::SharingPolicy sharing_policy,
255 const std::function<ClusterNetPointCb>& set_netpoint,
256 const std::function<ClusterLinkCb>& set_loopback = {},
257 const std::function<ClusterLinkCb>& set_limiter = {});
259 /** @brief Aggregates the parameters necessary to build a Dragonfly zone */
260 struct DragonflyParams {
261 std::pair<unsigned int, unsigned int> groups;
262 std::pair<unsigned int, unsigned int> chassis;
263 std::pair<unsigned int, unsigned int> routers;
265 DragonflyParams(const std::pair<unsigned int, unsigned int>& groups,
266 const std::pair<unsigned int, unsigned int>& chassis,
267 const std::pair<unsigned int, unsigned int>& routers, unsigned int nodes);
270 * @brief Create a Dragonfly zone
272 * Dragonfly clusters are characterized by:
273 * - groups: number of groups and links between each group, e.g. 2,2.
274 * - chassis: number of chassis in each group and the number of links used to connect the chassis, e.g. 2,3
275 * - routers: number of routers in each chassis and their links, e.g. 3,1
276 * - nodes: number of nodes connected to each router using a single link, e.g. 2
278 * In total, the cluster will have groups * chassis * routers * nodes elements/leaves.
280 * The best way to understand it is looking to the doc available in: <a
281 * href="https://simgrid.org/doc/latest/Platform_examples.html#dragonfly-cluster">Dragonfly Cluster</a>
283 * Moreover, this method accepts 3 callbacks to populate the cluster: set_netpoint, set_loopback and set_limiter .
285 * Note that the all elements in a Dragonfly cluster must have (or not) the same elements (loopback and limiter)
287 * @param name NetZone's name
288 * @param parent Pointer to parent's netzone (nullptr if root netzone). Needed to be able to create the resources inside
290 * @param parameters Characteristics of this Dragonfly
291 * @param bandwidth Characteristics of the inter-nodes link
292 * @param latency Characteristics of the inter-nodes link
293 * @param sharing_policy Characteristics of the inter-nodes link
294 * @param set_netpoint Callback to set the netpoint of an element in the torus
295 * @param set_loopback Callback to set the loopback
296 * @param set_limiter Callback to set the limiter
297 * @return Pointer to new netzone
299 XBT_PUBLIC NetZone* create_dragonfly_zone(const std::string& name, const NetZone* parent,
300 const DragonflyParams& parameters, double bandwidth, double latency,
301 Link::SharingPolicy sharing_policy,
302 const std::function<ClusterNetPointCb>& set_netpoint,
303 const std::function<ClusterLinkCb>& set_loopback = {},
304 const std::function<ClusterLinkCb>& set_limiter = {});
307 } // namespace simgrid
309 #endif /* SIMGRID_S4U_NETZONE_HPP */