1 /* Copyright (c) 2014-2016. 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 "src/kernel/routing/AsClusterTorus.hpp"
7 #include "src/surf/network_interface.hpp"
8 #include "src/surf/xml/platf.hpp" // FIXME: move that back to the parsing area
10 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_cluster_torus, surf_route_cluster, "Torus Routing part of surf");
12 inline unsigned int *rankId_to_coords(int rankId, xbt_dynar_t dimensions)
15 unsigned int i = 0, cur_dim_size = 1, dim_size_product = 1;
16 unsigned int *coords = (unsigned int *) malloc(xbt_dynar_length(dimensions) * sizeof(unsigned int));
17 for (i = 0; i < xbt_dynar_length(dimensions); i++) {
18 cur_dim_size = xbt_dynar_get_as(dimensions, i, int);
19 coords[i] = (rankId / dim_size_product) % cur_dim_size;
20 dim_size_product *= cur_dim_size;
30 AsClusterTorus::AsClusterTorus(const char*name)
33 AsClusterTorus::~AsClusterTorus() {
34 xbt_dynar_free(&dimensions_);
37 void AsClusterTorus::create_links_for_node(sg_platf_cluster_cbarg_t cluster, int id, int rank, int position) {
41 * Create all links that exist in the torus.
42 * Each rank creates @a dimensions-1 links
44 int neighbour_rank_id = 0; // The other node the link connects
45 int current_dimension = 0, // which dimension are we currently in?
46 // we need to iterate over all dimensions
47 // and create all links there
48 dim_product = 1; // Needed to calculate the next neighbour_id
49 for (j = 0; j < xbt_dynar_length(dimensions_); j++) {
51 s_sg_platf_link_cbarg_t link;
52 memset(&link, 0, sizeof(link));
53 current_dimension = xbt_dynar_get_as(dimensions_, j, int);
55 (((int) rank / dim_product) % current_dimension ==
56 current_dimension - 1) ? rank - (current_dimension - 1) * dim_product : rank + dim_product;
57 //name of neighbor is not right for non contiguous cluster radicals (as id != rank in this case)
58 link_id = bprintf("%s_link_from_%i_to_%i", cluster->id, id, neighbour_rank_id);
60 link.bandwidth = cluster->bw;
61 link.latency = cluster->lat;
62 link.policy = cluster->sharing_policy;
63 sg_platf_new_link(&link);
64 s_surf_parsing_link_up_down_t info;
65 if (link.policy == SURF_LINK_FULLDUPLEX) {
66 char *tmp_link = bprintf("%s_UP", link_id);
67 info.linkUp = Link::byName(tmp_link);
69 tmp_link = bprintf("%s_DOWN", link_id);
70 info.linkDown = Link::byName(tmp_link);
73 info.linkUp = Link::byName(link_id);
74 info.linkDown = info.linkUp;
77 * Add the link to its appropriate position;
78 * note that position rankId*(xbt_dynar_length(dimensions)+has_loopack?+has_limiter?)
79 * holds the link "rankId->rankId"
81 privateLinks_.insert(privateLinks_.begin() + position + j, info);
82 dim_product *= current_dimension;
88 void AsClusterTorus::parse_specific_arguments(sg_platf_cluster_cbarg_t cluster) {
92 xbt_dynar_t dimensions = xbt_str_split(cluster->topo_parameters, ",");
94 if (!xbt_dynar_is_empty(dimensions)) {
95 dimensions_ = xbt_dynar_new(sizeof(int), nullptr);
96 /* We are in a torus cluster
97 * Parse attribute dimensions="dim1,dim2,dim3,...,dimN"
98 * and safe it in a dynarray.
99 * Additionally, we need to know how many ranks we have in total
101 xbt_dynar_foreach(dimensions, iter, groups) {
102 int tmp = surf_parse_get_int(xbt_dynar_get_as(dimensions, iter, char *));
103 xbt_dynar_set_as(dimensions_, iter, int, tmp);
106 linkCountPerNode_ = xbt_dynar_length(dimensions_);
109 xbt_dynar_free(&dimensions);
112 void AsClusterTorus::getRouteAndLatency(NetCard * src, NetCard * dst, sg_platf_route_cbarg_t route, double *lat) {
114 XBT_VERB("torus_get_route_and_latency from '%s'[%d] to '%s'[%d]",
115 src->name(), src->id(), dst->name(), dst->id());
117 if (dst->isRouter() || src->isRouter())
120 if ((src->id() == dst->id()) && hasLoopback_) {
121 s_surf_parsing_link_up_down_t info = privateLinks_.at(src->id() * linkCountPerNode_);
123 route->link_list->push_back(info.linkUp);
125 *lat += info.linkUp->getLatency();
131 * Dimension based routing routes through each dimension consecutively
132 * TODO Change to dynamic assignment
134 unsigned int j, cur_dim, dim_product = 1;
135 unsigned int current_node = src->id();
136 unsigned int next_node = 0;
138 * Arrays that hold the coordinates of the current node and
139 * the target; comparing the values at the i-th position of
140 * both arrays, we can easily assess whether we need to route
141 * into this dimension or not.
143 unsigned int *myCoords, *targetCoords;
144 myCoords = rankId_to_coords(src->id(), dimensions_);
145 targetCoords = rankId_to_coords(dst->id(), dimensions_);
147 * linkOffset describes the offset where the link
148 * we want to use is stored
149 * (+1 is added because each node has a link from itself to itself,
150 * which can only be the case if src->m_id == dst->m_id -- see above
151 * for this special case)
153 int nodeOffset = (xbt_dynar_length(dimensions_) + 1) * src->id();
155 int linkOffset = nodeOffset;
156 bool use_lnk_up = false; // Is this link of the form "cur -> next" or "next -> cur"?
157 // false means: next -> cur
158 while (current_node != dst->id()) {
159 dim_product = 1; // First, we will route in x-dimension
160 for (j = 0; j < xbt_dynar_length(dimensions_); j++) {
161 cur_dim = xbt_dynar_get_as(dimensions_, j, int);
163 // current_node/dim_product = position in current dimension
164 if ((current_node / dim_product) % cur_dim != (dst->id() / dim_product) % cur_dim) {
166 if ((targetCoords[j] > myCoords[j] && targetCoords[j] <= myCoords[j] + cur_dim / 2) // Is the target node on the right, without the wrap-around?
167 || (myCoords[j] > cur_dim / 2 && (myCoords[j] + cur_dim / 2) % cur_dim >= targetCoords[j])) { // Or do we need to use the wrap around to reach it?
168 if ((current_node / dim_product) % cur_dim == cur_dim - 1)
169 next_node = (current_node + dim_product - dim_product * cur_dim);
171 next_node = (current_node + dim_product);
173 // HERE: We use *CURRENT* node for calculation (as opposed to next_node)
174 nodeOffset = current_node * (linkCountPerNode_);
175 linkOffset = nodeOffset + (hasLoopback_?1:0) + (hasLimiter_?1:0) + j;
177 assert(linkOffset >= 0);
178 } else { // Route to the left
179 if ((current_node / dim_product) % cur_dim == 0)
180 next_node = (current_node - dim_product + dim_product * cur_dim);
182 next_node = (current_node - dim_product);
184 // HERE: We use *next* node for calculation (as opposed to current_node!)
185 nodeOffset = next_node * (linkCountPerNode_);
186 linkOffset = nodeOffset + j + (hasLoopback_?1:0) + (hasLimiter_?1:0) ;
189 assert(linkOffset >= 0);
191 XBT_DEBUG("torus_get_route_and_latency - current_node: %i, next_node: %u, linkOffset is %i",
192 current_node, next_node, linkOffset);
197 dim_product *= cur_dim;
200 s_surf_parsing_link_up_down_t info;
202 if (hasLimiter_) { // limiter for sender
203 info = privateLinks_.at(nodeOffset + hasLoopback_);
204 route->link_list->push_back(info.linkUp);
207 info = privateLinks_.at(linkOffset);
209 if (use_lnk_up == false) {
210 route->link_list->push_back(info.linkDown);
212 *lat += info.linkDown->getLatency();
214 route->link_list->push_back(info.linkUp);
216 *lat += info.linkUp->getLatency();
218 current_node = next_node;