Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
b2c1896b691dbb6a96e51c93624b01544d7a0b04
[simgrid.git] / src / kernel / routing / TorusZone.cpp
1 /* Copyright (c) 2014-2016. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #include "src/kernel/routing/TorusZone.hpp"
7 #include "src/kernel/routing/NetPoint.hpp"
8 #include "src/surf/network_interface.hpp"
9
10 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_cluster_torus, surf_route_cluster, "Torus Routing part of surf");
11
12 inline unsigned int* rankId_to_coords(int rankId, xbt_dynar_t dimensions)
13 {
14
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;
21   }
22
23   return coords;
24 }
25
26 namespace simgrid {
27 namespace kernel {
28 namespace routing {
29 TorusZone::TorusZone(NetZone* father, const char* name) : ClusterZone(father, name)
30 {
31 }
32 TorusZone::~TorusZone()
33 {
34   xbt_dynar_free(&dimensions_);
35 }
36
37 void TorusZone::create_links_for_node(sg_platf_cluster_cbarg_t cluster, int id, int rank, int position)
38 {
39   /*
40    * Create all links that exist in the torus.
41    * Each rank creates @a dimensions-1 links
42    */
43   int neighbor_rank_id  = 0; // The other node the link connects
44   int current_dimension = 0, // which dimension are we currently in?
45       // we need to iterate over all dimensions
46       // and create all links there
47       dim_product = 1; // Needed to calculate the next neighbor_id
48   for (unsigned int j = 0; j < xbt_dynar_length(dimensions_); j++) {
49
50     s_sg_platf_link_cbarg_t link;
51     memset(&link, 0, sizeof(link));
52     current_dimension = xbt_dynar_get_as(dimensions_, j, int);
53     neighbor_rank_id  = (((int)rank / dim_product) % current_dimension == current_dimension - 1)
54                            ? rank - (current_dimension - 1) * dim_product
55                            : rank + dim_product;
56     // name of neighbor is not right for non contiguous cluster radicals (as id != rank in this case)
57     char* link_id  = bprintf("%s_link_from_%i_to_%i", cluster->id, id, neighbor_rank_id);
58     link.id        = link_id;
59     link.bandwidth = cluster->bw;
60     link.latency   = cluster->lat;
61     link.policy    = cluster->sharing_policy;
62     sg_platf_new_link(&link);
63     surf::LinkImpl* linkUp;
64     surf::LinkImpl* linkDown;
65     if (link.policy == SURF_LINK_FULLDUPLEX) {
66       char* tmp_link = bprintf("%s_UP", link_id);
67       linkUp         = surf::LinkImpl::byName(tmp_link);
68       free(tmp_link);
69       tmp_link = bprintf("%s_DOWN", link_id);
70       linkDown = surf::LinkImpl::byName(tmp_link);
71       free(tmp_link);
72     } else {
73       linkUp   = surf::LinkImpl::byName(link_id);
74       linkDown = linkUp;
75     }
76     /*
77      * Add the link to its appropriate position;
78      * note that position rankId*(xbt_dynar_length(dimensions)+has_loopback?+has_limiter?)
79      * holds the link "rankId->rankId"
80      */
81     privateLinks_.insert({position + j, {linkUp, linkDown}});
82     dim_product *= current_dimension;
83     xbt_free(link_id);
84   }
85   rank++;
86 }
87
88 void TorusZone::parse_specific_arguments(sg_platf_cluster_cbarg_t cluster)
89 {
90
91   unsigned int iter;
92   char* groups;
93   xbt_dynar_t dimensions = xbt_str_split(cluster->topo_parameters, ",");
94
95   if (!xbt_dynar_is_empty(dimensions)) {
96     dimensions_ = xbt_dynar_new(sizeof(int), nullptr);
97     /* We are in a torus cluster
98      * Parse attribute dimensions="dim1,dim2,dim3,...,dimN"
99      * and safe it in a dynarray.
100      * Additionally, we need to know how many ranks we have in total
101      */
102     xbt_dynar_foreach (dimensions, iter, groups) {
103       int tmp = surf_parse_get_int(xbt_dynar_get_as(dimensions, iter, char*));
104       xbt_dynar_set_as(dimensions_, iter, int, tmp);
105     }
106
107     linkCountPerNode_ = xbt_dynar_length(dimensions_);
108   }
109   xbt_dynar_free(&dimensions);
110 }
111
112 void TorusZone::getLocalRoute(NetPoint* src, NetPoint* dst, sg_platf_route_cbarg_t route, double* lat)
113 {
114
115   XBT_VERB("torus getLocalRoute from '%s'[%d] to '%s'[%d]", src->name().c_str(), src->id(), dst->name().c_str(),
116            dst->id());
117
118   if (dst->isRouter() || src->isRouter())
119     return;
120
121   if (src->id() == dst->id() && hasLoopback_) {
122     std::pair<surf::LinkImpl*, surf::LinkImpl*> info = privateLinks_.at(src->id() * linkCountPerNode_);
123
124     route->link_list->push_back(info.first);
125     if (lat)
126       *lat += info.first->latency();
127     return;
128   }
129
130   /*
131    * Dimension based routing routes through each dimension consecutively
132    * TODO Change to dynamic assignment
133    */
134   unsigned int j, cur_dim, dim_product = 1;
135   unsigned int current_node = src->id();
136   unsigned int next_node    = 0;
137   /*
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.
142    */
143   unsigned int* myCoords     = rankId_to_coords(src->id(), dimensions_);
144   unsigned int* targetCoords = rankId_to_coords(dst->id(), dimensions_);
145   /*
146    * linkOffset describes the offset where the link
147    * we want to use is stored
148    * (+1 is added because each node has a link from itself to itself,
149    * which can only be the case if src->m_id == dst->m_id -- see above
150    * for this special case)
151    */
152   int nodeOffset = (xbt_dynar_length(dimensions_) + 1) * src->id();
153
154   int linkOffset  = nodeOffset;
155   bool use_lnk_up = false; // Is this link of the form "cur -> next" or "next -> cur"?
156   // false means: next -> cur
157   while (current_node != dst->id()) {
158     dim_product = 1; // First, we will route in x-dimension
159     for (j = 0; j < xbt_dynar_length(dimensions_); j++) {
160       cur_dim = xbt_dynar_get_as(dimensions_, j, int);
161
162       // current_node/dim_product = position in current dimension
163       if ((current_node / dim_product) % cur_dim != (dst->id() / dim_product) % cur_dim) {
164
165         if ((targetCoords[j] > myCoords[j] &&
166              targetCoords[j] <= myCoords[j] + cur_dim / 2) // Is the target node on the right, without the wrap-around?
167             || (myCoords[j] > cur_dim / 2 &&
168                 (myCoords[j] + cur_dim / 2) % cur_dim >=
169                     targetCoords[j])) { // Or do we need to use the wrap around to reach it?
170           if ((current_node / dim_product) % cur_dim == cur_dim - 1)
171             next_node = (current_node + dim_product - dim_product * cur_dim);
172           else
173             next_node = (current_node + dim_product);
174
175           // HERE: We use *CURRENT* node for calculation (as opposed to next_node)
176           nodeOffset = current_node * (linkCountPerNode_);
177           linkOffset = nodeOffset + (hasLoopback_ ? 1 : 0) + (hasLimiter_ ? 1 : 0) + j;
178           use_lnk_up = true;
179           assert(linkOffset >= 0);
180         } else { // Route to the left
181           if ((current_node / dim_product) % cur_dim == 0)
182             next_node = (current_node - dim_product + dim_product * cur_dim);
183           else
184             next_node = (current_node - dim_product);
185
186           // HERE: We use *next* node for calculation (as opposed to current_node!)
187           nodeOffset = next_node * (linkCountPerNode_);
188           linkOffset = nodeOffset + j + (hasLoopback_ ? 1 : 0) + (hasLimiter_ ? 1 : 0);
189           use_lnk_up = false;
190
191           assert(linkOffset >= 0);
192         }
193         XBT_DEBUG("torus_get_route_and_latency - current_node: %i, next_node: %u, linkOffset is %i", current_node,
194                   next_node, linkOffset);
195
196         break;
197       }
198
199       dim_product *= cur_dim;
200     }
201
202     std::pair<surf::LinkImpl*, surf::LinkImpl*> info;
203
204     if (hasLimiter_) { // limiter for sender
205       info = privateLinks_.at(nodeOffset + hasLoopback_);
206       route->link_list->push_back(info.first);
207     }
208
209     info = privateLinks_.at(linkOffset);
210
211     if (use_lnk_up == false) {
212       route->link_list->push_back(info.second);
213       if (lat)
214         *lat += info.second->latency();
215     } else {
216       route->link_list->push_back(info.first);
217       if (lat)
218         *lat += info.first->latency();
219     }
220     current_node = next_node;
221     next_node    = 0;
222   }
223   free(myCoords);
224   free(targetCoords);
225 }
226 }
227 }
228 } // namespace