1 /* Copyright (c) 2014-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 #include "simgrid/kernel/routing/DragonflyZone.hpp"
7 #include "simgrid/kernel/routing/NetPoint.hpp"
8 #include "src/surf/network_interface.hpp"
10 #include <boost/algorithm/string/classification.hpp>
11 #include <boost/algorithm/string/split.hpp>
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_cluster_dragonfly, surf_route_cluster, "Dragonfly Routing part of surf");
21 DragonflyZone::DragonflyZone(const std::string& name) : ClusterBase(name) {}
23 DragonflyZone::Coords DragonflyZone::rankId_to_coords(int rankId) const
25 // coords : group, chassis, blade, node
27 coords.group = rankId / (num_chassis_per_group_ * num_blades_per_chassis_ * num_nodes_per_blade_);
28 rankId = rankId % (num_chassis_per_group_ * num_blades_per_chassis_ * num_nodes_per_blade_);
29 coords.chassis = rankId / (num_blades_per_chassis_ * num_nodes_per_blade_);
30 rankId = rankId % (num_blades_per_chassis_ * num_nodes_per_blade_);
31 coords.blade = rankId / num_nodes_per_blade_;
32 coords.node = rankId % num_nodes_per_blade_;
36 void DragonflyZone::rankId_to_coords(int rankId, unsigned int coords[4]) const // XBT_ATTRIB_DEPRECATED_v330
38 const auto s_coords = rankId_to_coords(rankId);
39 coords[0] = s_coords.group;
40 coords[1] = s_coords.chassis;
41 coords[2] = s_coords.blade;
42 coords[3] = s_coords.node;
45 void DragonflyZone::set_link_characteristics(double bw, double lat, s4u::Link::SharingPolicy sharing_policy)
47 ClusterBase::set_link_characteristics(bw, lat, sharing_policy);
48 if (sharing_policy == s4u::Link::SharingPolicy::SPLITDUPLEX)
49 num_links_per_link_ = 2;
52 void DragonflyZone::set_topology(unsigned int n_groups, unsigned int groups_links, unsigned int n_chassis,
53 unsigned int chassis_links, unsigned int n_routers, unsigned int routers_links,
56 num_groups_ = n_groups;
57 num_links_blue_ = groups_links;
59 num_chassis_per_group_ = n_chassis;
60 num_links_black_ = chassis_links;
62 num_blades_per_chassis_ = n_routers;
63 num_links_green_ = routers_links;
65 num_nodes_per_blade_ = nodes;
68 s4u::DragonflyParams DragonflyZone::parse_topo_parameters(const std::string& topo_parameters)
70 std::vector<std::string> parameters;
71 std::vector<std::string> tmp;
72 boost::split(parameters, topo_parameters, boost::is_any_of(";"));
74 if (parameters.size() != 4)
75 xbt_die("Dragonfly are defined by the number of groups, chassis per groups, blades per chassis, nodes per blade");
77 // Blue network : number of groups, number of links between each group
78 boost::split(tmp, parameters[0], boost::is_any_of(","));
80 xbt_die("Dragonfly topologies are defined by 3 levels with 2 elements each, and one with one element");
82 unsigned int n_groups;
84 n_groups = std::stoi(tmp[0]);
85 } catch (const std::invalid_argument&) {
86 throw std::invalid_argument(std::string("Invalid number of groups:") + tmp[0]);
91 n_blue = std::stoi(tmp[1]);
92 } catch (const std::invalid_argument&) {
93 throw std::invalid_argument(std::string("Invalid number of links for the blue level:") + tmp[1]);
96 // Black network : number of chassis/group, number of links between each router on the black network
97 boost::split(tmp, parameters[1], boost::is_any_of(","));
99 xbt_die("Dragonfly topologies are defined by 3 levels with 2 elements each, and one with one element");
101 unsigned int n_chassis;
103 n_chassis = std::stoi(tmp[0]);
104 } catch (const std::invalid_argument&) {
105 throw std::invalid_argument(std::string("Invalid number of chassis:") + tmp[0]);
108 unsigned int n_black;
110 n_black = std::stoi(tmp[1]);
111 } catch (const std::invalid_argument&) {
112 throw std::invalid_argument(std::string("Invalid number of links for the black level:") + tmp[1]);
115 // Green network : number of blades/chassis, number of links between each router on the green network
116 boost::split(tmp, parameters[2], boost::is_any_of(","));
118 xbt_die("Dragonfly topologies are defined by 3 levels with 2 elements each, and one with one element");
120 unsigned int n_routers;
122 n_routers = std::stoi(tmp[0]);
123 } catch (const std::invalid_argument&) {
124 throw std::invalid_argument(std::string("Invalid number of routers:") + tmp[0]);
127 unsigned int n_green;
129 n_green = std::stoi(tmp[1]);
130 } catch (const std::invalid_argument&) {
131 throw std::invalid_argument(std::string("Invalid number of links for the green level:") + tmp[1]);
134 // The last part of topo_parameters should be the number of nodes per blade
135 unsigned int n_nodes;
137 n_nodes = std::stoi(parameters[3]);
138 } catch (const std::invalid_argument&) {
139 throw std::invalid_argument(std::string("Last parameter is not the amount of nodes per blade:") + parameters[3]);
141 return s4u::DragonflyParams({n_groups, n_blue}, {n_chassis, n_black}, {n_routers, n_green}, n_nodes);
144 /* Generate the cluster once every node is created */
145 void DragonflyZone::build_upper_levels(const s4u::ClusterCallbacks& set_callbacks)
147 generate_routers(set_callbacks);
151 void DragonflyZone::generate_routers(const s4u::ClusterCallbacks& set_callbacks)
154 /* get limiter for this router */
155 auto get_limiter = [this, &id, &set_callbacks](unsigned int i, unsigned int j,
156 unsigned int k) -> resource::LinkImpl* {
157 kernel::resource::LinkImpl* limiter = nullptr;
158 if (set_callbacks.limiter) {
159 const auto* s4u_link =
160 set_callbacks.limiter(get_iface(), {i, j, k, std::numeric_limits<unsigned int>::max()}, --id);
162 limiter = s4u_link->get_impl();
168 routers_.reserve(num_groups_ * num_chassis_per_group_ * num_blades_per_chassis_);
169 for (unsigned int i = 0; i < num_groups_; i++) {
170 for (unsigned int j = 0; j < num_chassis_per_group_; j++) {
171 for (unsigned int k = 0; k < num_blades_per_chassis_; k++) {
172 routers_.emplace_back(i, j, k, get_limiter(i, j, k));
178 void DragonflyZone::generate_link(const std::string& id, int numlinks, resource::LinkImpl** linkup,
179 resource::LinkImpl** linkdown)
181 XBT_DEBUG("Generating link %s", id.c_str());
184 if (get_link_sharing_policy() == s4u::Link::SharingPolicy::SPLITDUPLEX) {
185 *linkup = create_link(id + "_UP", std::vector<double>{get_link_bandwidth() * numlinks})
186 ->set_latency(get_link_latency())
189 *linkdown = create_link(id + "_DOWN", std::vector<double>{get_link_bandwidth() * numlinks})
190 ->set_latency(get_link_latency())
194 *linkup = create_link(id, std::vector<double>{get_link_bandwidth() * numlinks})
195 ->set_latency(get_link_latency())
202 void DragonflyZone::generate_links()
204 static int uniqueId = 0;
205 resource::LinkImpl* linkup;
206 resource::LinkImpl* linkdown;
208 unsigned int numRouters = num_groups_ * num_chassis_per_group_ * num_blades_per_chassis_;
210 // Links from routers to their local nodes.
211 for (unsigned int i = 0; i < numRouters; i++) {
212 // allocate structures
213 routers_[i].my_nodes_.resize(num_links_per_link_ * num_nodes_per_blade_);
214 routers_[i].green_links_.resize(num_blades_per_chassis_);
215 routers_[i].black_links_.resize(num_chassis_per_group_);
217 for (unsigned int j = 0; j < num_links_per_link_ * num_nodes_per_blade_; j += num_links_per_link_) {
218 std::string id = "local_link_from_router_" + std::to_string(i) + "_to_node_" +
219 std::to_string(j / num_links_per_link_) + "_" + std::to_string(uniqueId);
220 generate_link(id, 1, &linkup, &linkdown);
222 routers_[i].my_nodes_[j] = linkup;
223 if (get_link_sharing_policy() == s4u::Link::SharingPolicy::SPLITDUPLEX)
224 routers_[i].my_nodes_[j + 1] = linkdown;
230 // Green links from routers to same chassis routers - alltoall
231 for (unsigned int i = 0; i < num_groups_ * num_chassis_per_group_; i++) {
232 for (unsigned int j = 0; j < num_blades_per_chassis_; j++) {
233 for (unsigned int k = j + 1; k < num_blades_per_chassis_; k++) {
234 std::string id = "green_link_in_chassis_" + std::to_string(i % num_chassis_per_group_) + "_between_routers_" +
235 std::to_string(j) + "_and_" + std::to_string(k) + "_" + std::to_string(uniqueId);
236 generate_link(id, num_links_green_, &linkup, &linkdown);
238 routers_[i * num_blades_per_chassis_ + j].green_links_[k] = linkup;
239 routers_[i * num_blades_per_chassis_ + k].green_links_[j] = linkdown;
245 // Black links from routers to same group routers - alltoall
246 for (unsigned int i = 0; i < num_groups_; i++) {
247 for (unsigned int j = 0; j < num_chassis_per_group_; j++) {
248 for (unsigned int k = j + 1; k < num_chassis_per_group_; k++) {
249 for (unsigned int l = 0; l < num_blades_per_chassis_; l++) {
250 std::string id = "black_link_in_group_" + std::to_string(i) + "_between_chassis_" + std::to_string(j) +
251 "_and_" + std::to_string(k) + "_blade_" + std::to_string(l) + "_" + std::to_string(uniqueId);
252 generate_link(id, num_links_black_, &linkup, &linkdown);
254 routers_[i * num_blades_per_chassis_ * num_chassis_per_group_ + j * num_blades_per_chassis_ + l]
255 .black_links_[k] = linkup;
256 routers_[i * num_blades_per_chassis_ * num_chassis_per_group_ + k * num_blades_per_chassis_ + l]
257 .black_links_[j] = linkdown;
264 // Blue links between groups - Not all routers involved, only one per group is linked to others. Let's say router n of
265 // each group is linked to group n.
266 // FIXME: in reality blue links may be attached to several different routers
267 for (unsigned int i = 0; i < num_groups_; i++) {
268 for (unsigned int j = i + 1; j < num_groups_; j++) {
269 unsigned int routernumi = i * num_blades_per_chassis_ * num_chassis_per_group_ + j;
270 unsigned int routernumj = j * num_blades_per_chassis_ * num_chassis_per_group_ + i;
271 std::string id = "blue_link_between_group_" + std::to_string(i) + "_and_" + std::to_string(j) + "_routers_" +
272 std::to_string(routernumi) + "_and_" + std::to_string(routernumj) + "_" +
273 std::to_string(uniqueId);
274 generate_link(id, num_links_blue_, &linkup, &linkdown);
276 routers_[routernumi].blue_link_ = linkup;
277 routers_[routernumj].blue_link_ = linkdown;
283 void DragonflyZone::get_local_route(NetPoint* src, NetPoint* dst, Route* route, double* latency)
285 // Minimal routing version.
286 // TODO : non-minimal random one, and adaptive ?
288 if (dst->is_router() || src->is_router())
291 XBT_VERB("dragonfly getLocalRoute from '%s'[%u] to '%s'[%u]", src->get_cname(), src->id(), dst->get_cname(),
294 if ((src->id() == dst->id()) && has_loopback()) {
295 resource::LinkImpl* uplink = get_uplink_from(node_pos(src->id()));
297 route->link_list_.push_back(uplink);
299 *latency += uplink->get_latency();
303 const auto myCoords = rankId_to_coords(src->id());
304 const auto targetCoords = rankId_to_coords(dst->id());
305 XBT_DEBUG("src : %u group, %u chassis, %u blade, %u node", myCoords.group, myCoords.chassis, myCoords.blade,
307 XBT_DEBUG("dst : %u group, %u chassis, %u blade, %u node", targetCoords.group, targetCoords.chassis,
308 targetCoords.blade, targetCoords.node);
310 DragonflyRouter* myRouter = &routers_[myCoords.group * (num_chassis_per_group_ * num_blades_per_chassis_) +
311 myCoords.chassis * num_blades_per_chassis_ + myCoords.blade];
312 DragonflyRouter* targetRouter = &routers_[targetCoords.group * (num_chassis_per_group_ * num_blades_per_chassis_) +
313 targetCoords.chassis * num_blades_per_chassis_ + targetCoords.blade];
314 DragonflyRouter* currentRouter = myRouter;
316 if (has_limiter()) { // limiter for sender
317 route->link_list_.push_back(get_uplink_from(node_pos_with_loopback(src->id())));
320 // node->router local link
321 route->link_list_.push_back(myRouter->my_nodes_[myCoords.node * num_links_per_link_]);
323 *latency += myRouter->my_nodes_[myCoords.node * num_links_per_link_]->get_latency();
325 if (targetRouter != myRouter) {
326 // are we on a different group ?
327 if (targetRouter->group_ != currentRouter->group_) {
328 // go to the router of our group connected to this one.
329 if (currentRouter->blade_ != targetCoords.group) {
330 if (currentRouter->limiter_)
331 route->link_list_.push_back(currentRouter->limiter_);
332 // go to the nth router in our chassis
333 route->link_list_.push_back(currentRouter->green_links_[targetCoords.group]);
335 *latency += currentRouter->green_links_[targetCoords.group]->get_latency();
336 currentRouter = &routers_[myCoords.group * (num_chassis_per_group_ * num_blades_per_chassis_) +
337 myCoords.chassis * num_blades_per_chassis_ + targetCoords.group];
340 if (currentRouter->chassis_ != 0) {
341 // go to the first chassis of our group
342 if (currentRouter->limiter_)
343 route->link_list_.push_back(currentRouter->limiter_);
344 route->link_list_.push_back(currentRouter->black_links_[0]);
346 *latency += currentRouter->black_links_[0]->get_latency();
348 &routers_[myCoords.group * (num_chassis_per_group_ * num_blades_per_chassis_) + targetCoords.group];
351 // go to destination group - the only optical hop
352 route->link_list_.push_back(currentRouter->blue_link_);
353 if (currentRouter->limiter_)
354 route->link_list_.push_back(currentRouter->limiter_);
356 *latency += currentRouter->blue_link_->get_latency();
358 &routers_[targetCoords.group * (num_chassis_per_group_ * num_blades_per_chassis_) + myCoords.group];
361 // same group, but same blade ?
362 if (targetRouter->blade_ != currentRouter->blade_) {
363 if (currentRouter->limiter_)
364 route->link_list_.push_back(currentRouter->limiter_);
365 route->link_list_.push_back(currentRouter->green_links_[targetCoords.blade]);
367 *latency += currentRouter->green_links_[targetCoords.blade]->get_latency();
369 &routers_[targetCoords.group * (num_chassis_per_group_ * num_blades_per_chassis_) + targetCoords.blade];
372 // same blade, but same chassis ?
373 if (targetRouter->chassis_ != currentRouter->chassis_) {
374 if (currentRouter->limiter_)
375 route->link_list_.push_back(currentRouter->limiter_);
376 route->link_list_.push_back(currentRouter->black_links_[targetCoords.chassis]);
378 *latency += currentRouter->black_links_[targetCoords.chassis]->get_latency();
382 // router->node local link
383 if (targetRouter->limiter_)
384 route->link_list_.push_back(targetRouter->limiter_);
385 route->link_list_.push_back(
386 targetRouter->my_nodes_[targetCoords.node * num_links_per_link_ + num_links_per_link_ - 1]);
390 targetRouter->my_nodes_[targetCoords.node * num_links_per_link_ + num_links_per_link_ - 1]->get_latency();
392 if (has_limiter()) { // limiter for receiver
393 route->link_list_.push_back(get_downlink_to(node_pos_with_loopback(dst->id())));
396 // set gateways (if any)
397 route->gw_src_ = get_gateway(src->id());
398 route->gw_dst_ = get_gateway(dst->id());
400 } // namespace routing
401 } // namespace kernel
404 DragonflyParams::DragonflyParams(const std::pair<unsigned int, unsigned int>& groups,
405 const std::pair<unsigned int, unsigned int>& chassis,
406 const std::pair<unsigned int, unsigned int>& routers, unsigned int nodes)
407 : groups(groups), chassis(chassis), routers(routers), nodes(nodes)
409 if (groups.first == 0)
410 throw std::invalid_argument("Dragonfly: Invalid number of groups, must be > 0");
411 if (groups.second == 0)
412 throw std::invalid_argument("Dragonfly: Invalid number of blue (groups) links, must be > 0");
413 if (chassis.first == 0)
414 throw std::invalid_argument("Dragonfly: Invalid number of chassis, must be > 0");
415 if (chassis.second == 0)
416 throw std::invalid_argument("Dragonfly: Invalid number of black (chassis) links, must be > 0");
417 if (routers.first == 0)
418 throw std::invalid_argument("Dragonfly: Invalid number of routers, must be > 0");
419 if (routers.second == 0)
420 throw std::invalid_argument("Dragonfly: Invalid number of green (routers) links, must be > 0");
422 throw std::invalid_argument("Dragonfly: Invalid number of nodes, must be > 0");
425 NetZone* create_dragonfly_zone(const std::string& name, const NetZone* parent, const DragonflyParams& params,
426 const ClusterCallbacks& set_callbacks, double bandwidth, double latency,
427 Link::SharingPolicy sharing_policy)
431 throw std::invalid_argument("DragonflyZone: incorrect bandwidth for internode communication, bw=" +
432 std::to_string(bandwidth));
434 throw std::invalid_argument("DragonflyZone: incorrect latency for internode communication, lat=" +
435 std::to_string(latency));
438 auto* zone = new kernel::routing::DragonflyZone(name);
439 zone->set_topology(params.groups.first, params.groups.second, params.chassis.first, params.chassis.second,
440 params.routers.first, params.routers.second, params.nodes);
442 zone->set_parent(parent->get_impl());
443 zone->set_link_characteristics(bandwidth, latency, sharing_policy);
446 std::vector<unsigned int> dimensions = {params.groups.first, params.chassis.first, params.routers.first,
448 int tot_elements = std::accumulate(dimensions.begin(), dimensions.end(), 1, std::multiplies<>());
449 for (int i = 0; i < tot_elements; i++) {
450 kernel::routing::NetPoint* netpoint;
453 zone->fill_leaf_from_cb(i, dimensions, set_callbacks, &netpoint, &loopback, &limiter);
455 zone->build_upper_levels(set_callbacks);
457 return zone->get_iface();
461 } // namespace simgrid