1 /* Copyright (c) 2014-2019. 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/TorusZone.hpp"
7 #include "simgrid/kernel/routing/NetPoint.hpp"
8 #include "src/surf/network_interface.hpp"
9 #include "src/surf/xml/platf_private.hpp"
11 #include <boost/algorithm/string/classification.hpp>
12 #include <boost/algorithm/string/split.hpp>
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_cluster_torus, surf_route_cluster, "Torus Routing part of surf");
21 TorusZone::TorusZone(NetZoneImpl* father, const std::string& name, resource::NetworkModel* netmodel)
22 : ClusterZone(father, name, netmodel)
26 void TorusZone::create_links_for_node(ClusterCreationArgs* cluster, int id, int rank, unsigned int position)
28 /* Create all links that exist in the torus. Each rank creates @a dimensions-1 links */
29 int dim_product = 1; // Needed to calculate the next neighbor_id
31 for (unsigned int j = 0; j < dimensions_.size(); j++) {
32 LinkCreationArgs link;
33 int current_dimension = dimensions_[j]; // which dimension are we currently in?
34 // we need to iterate over all dimensions and create all links there
35 // The other node the link connects
36 int neighbor_rank_id = ((static_cast<int>(rank) / dim_product) % current_dimension == current_dimension - 1)
37 ? rank - (current_dimension - 1) * dim_product
39 // name of neighbor is not right for non contiguous cluster radicals (as id != rank in this case)
41 std::string(cluster->id) + "_link_from_" + std::to_string(id) + "_to_" + std::to_string(neighbor_rank_id);
43 link.bandwidths.push_back(cluster->bw);
44 link.latency = cluster->lat;
45 link.policy = cluster->sharing_policy;
46 sg_platf_new_link(&link);
47 resource::LinkImpl* linkUp;
48 resource::LinkImpl* linkDown;
49 if (link.policy == s4u::Link::SharingPolicy::SPLITDUPLEX) {
50 linkUp = s4u::Link::by_name(link_id + "_UP")->get_impl();
51 linkDown = s4u::Link::by_name(link_id + "_DOWN")->get_impl();
53 linkUp = s4u::Link::by_name(link_id)->get_impl();
57 * Add the link to its appropriate position.
58 * Note that position rankId*(xbt_dynar_length(dimensions)+has_loopback?+has_limiter?)
59 * holds the link "rankId->rankId"
61 private_links_.insert({position + j, {linkUp, linkDown}});
62 dim_product *= current_dimension;
67 void TorusZone::parse_specific_arguments(ClusterCreationArgs* cluster)
69 std::vector<std::string> dimensions;
70 boost::split(dimensions, cluster->topo_parameters, boost::is_any_of(","));
72 if (not dimensions.empty()) {
73 /* We are in a torus cluster
74 * Parse attribute dimensions="dim1,dim2,dim3,...,dimN" and save them into a vector.
75 * Additionally, we need to know how many ranks we have in total
77 for (auto const& group : dimensions)
78 dimensions_.push_back(surf_parse_get_int(group));
80 num_links_per_node_ = dimensions_.size();
84 void TorusZone::get_local_route(NetPoint* src, NetPoint* dst, RouteCreationArgs* route, double* lat)
87 XBT_VERB("torus getLocalRoute from '%s'[%u] to '%s'[%u]", src->get_cname(), src->id(), dst->get_cname(), dst->id());
89 if (dst->is_router() || src->is_router())
92 if (src->id() == dst->id() && has_loopback_) {
93 std::pair<resource::LinkImpl*, resource::LinkImpl*> info = private_links_.at(src->id() * num_links_per_node_);
95 route->link_list.push_back(info.first);
97 *lat += info.first->get_latency();
102 * Dimension based routing routes through each dimension consecutively
103 * TODO Change to dynamic assignment
107 * Arrays that hold the coordinates of the current node andthe target; comparing the values at the i-th position of
108 * both arrays, we can easily assess whether we need to route into this dimension or not.
110 const unsigned int dsize = dimensions_.size();
111 unsigned int myCoords[dsize];
112 unsigned int targetCoords[dsize];
113 unsigned int dim_size_product = 1;
114 for (unsigned i = 0; i < dsize; i++) {
115 unsigned cur_dim_size = dimensions_[i];
116 myCoords[i] = (src->id() / dim_size_product) % cur_dim_size;
117 targetCoords[i] = (dst->id() / dim_size_product) % cur_dim_size;
118 dim_size_product *= cur_dim_size;
122 * linkOffset describes the offset where the link we want to use is stored(+1 is added because each node has a link
123 * from itself to itself, which can only be the case if src->m_id == dst->m_id -- see above for this special case)
125 int nodeOffset = (dsize + 1) * src->id();
127 int linkOffset = nodeOffset;
128 bool use_lnk_up = false; // Is this link of the form "cur -> next" or "next -> cur"? false means: next -> cur
129 unsigned int current_node = src->id();
130 while (current_node != dst->id()) {
131 unsigned int next_node = 0;
132 unsigned int dim_product = 1; // First, we will route in x-dimension
133 for (unsigned j = 0; j < dsize; j++) {
134 const unsigned cur_dim = dimensions_[j];
135 // current_node/dim_product = position in current dimension
136 if ((current_node / dim_product) % cur_dim != (dst->id() / dim_product) % cur_dim) {
138 if ((targetCoords[j] > myCoords[j] &&
139 targetCoords[j] <= myCoords[j] + cur_dim / 2) // Is the target node on the right, without the wrap-around?
140 || (myCoords[j] > cur_dim / 2 &&
141 (myCoords[j] + cur_dim / 2) % cur_dim >=
142 targetCoords[j])) { // Or do we need to use the wrap around to reach it?
143 if ((current_node / dim_product) % cur_dim == cur_dim - 1)
144 next_node = (current_node + dim_product - dim_product * cur_dim);
146 next_node = (current_node + dim_product);
148 // HERE: We use *CURRENT* node for calculation (as opposed to next_node)
149 nodeOffset = current_node * (num_links_per_node_);
150 linkOffset = nodeOffset + (has_loopback_ ? 1 : 0) + (has_limiter_ ? 1 : 0) + j;
152 assert(linkOffset >= 0);
153 } else { // Route to the left
154 if ((current_node / dim_product) % cur_dim == 0)
155 next_node = (current_node - dim_product + dim_product * cur_dim);
157 next_node = (current_node - dim_product);
159 // HERE: We use *next* node for calculation (as opposed to current_node!)
160 nodeOffset = next_node * (num_links_per_node_);
161 linkOffset = nodeOffset + j + (has_loopback_ ? 1 : 0) + (has_limiter_ ? 1 : 0);
164 assert(linkOffset >= 0);
166 XBT_DEBUG("torus_get_route_and_latency - current_node: %u, next_node: %u, linkOffset is %i", current_node,
167 next_node, linkOffset);
171 dim_product *= cur_dim;
174 std::pair<resource::LinkImpl*, resource::LinkImpl*> info;
176 if (has_limiter_) { // limiter for sender
177 info = private_links_.at(nodeOffset + (has_loopback_ ? 1 : 0));
178 route->link_list.push_back(info.first);
181 info = private_links_.at(linkOffset);
182 resource::LinkImpl* lnk = use_lnk_up ? info.first : info.second;
184 route->link_list.push_back(lnk);
186 *lat += lnk->get_latency();
188 current_node = next_node;