Logo AND Algorithmique Numérique Distribuée

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