Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
compile with -Wmissing-declarations to catch more errors
[simgrid.git] / src / surf / surf_routing_cluster_torus.cpp
1 /* Copyright (c) 2014-2015. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #include "src/surf/surf_routing_private.hpp"
8 #include "src/surf/surf_routing_cluster_torus.hpp"
9
10 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_cluster_torus, surf_route_cluster, "Torus Routing part of surf");
11
12
13 inline unsigned int* rankId_to_coords(int rankId, xbt_dynar_t dimensions) {
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
27 AS_t model_torus_cluster_create(void)
28 {
29   return new simgrid::surf::AsClusterTorus();
30 }
31
32 namespace simgrid {
33 namespace surf {
34
35 /* Creation routing model functions */
36 AsClusterTorus::AsClusterTorus() : AsCluster()
37 {
38   p_dimensions = NULL;
39 }
40
41 /* Creation routing model functions */
42 AsClusterTorus::~AsClusterTorus()
43 {
44   if(p_dimensions) xbt_dynar_free(&p_dimensions);
45 }
46
47
48 void AsClusterTorus::create_links_for_node(sg_platf_cluster_cbarg_t cluster, int id, int rank, int position){
49   s_sg_platf_link_cbarg_t link = SG_PLATF_LINK_INITIALIZER;
50   char* link_id;
51   unsigned int j = 0;
52   /**
53    * Create all links that exist in the torus.
54    * Each rank creates #dimensions-1 links
55    */
56   int neighbour_rank_id = 0; // The other node the link connects
57   int current_dimension = 0, // which dimension are we currently in?
58       // we need to iterate over all dimensions
59       // and create all links there
60       dim_product       = 1; // Needed to calculate the next neighbour_id
61   for (j = 0; j < xbt_dynar_length(p_dimensions); j++) {
62
63       memset(&link, 0, sizeof(link));
64       current_dimension = xbt_dynar_get_as(p_dimensions, j, int);
65       neighbour_rank_id = ( ((int) rank / dim_product) % current_dimension == current_dimension-1) ? rank - (current_dimension-1)*dim_product : rank + dim_product;
66       //name of neighbor is not right for non contiguous cluster radicals (as id != rank in this case)
67       link_id           = bprintf("%s_link_from_%i_to_%i", cluster->id, id, neighbour_rank_id);
68       link.id           = link_id;
69       link.bandwidth    = cluster->bw;
70       link.latency      = cluster->lat;
71       link.initiallyOn  = 1;
72       link.policy       = cluster->sharing_policy;
73       sg_platf_new_link(&link);
74       s_surf_parsing_link_up_down_t info;
75       if (link.policy == SURF_LINK_FULLDUPLEX) {
76           char *tmp_link = bprintf("%s_UP", link_id);
77           info.link_up = Link::byName(tmp_link);
78           free(tmp_link);
79           tmp_link = bprintf("%s_DOWN", link_id);
80           info.link_down = Link::byName(tmp_link);
81           free(tmp_link);
82       } else {
83           info.link_up = Link::byName(link_id);
84           info.link_down = info.link_up;
85       }
86       /**
87        * Add the link to its appropriate position;
88        * note that position rankId*(xbt_dynar_length(dimensions)+has_loopack?+has_limiter?)
89        * holds the link "rankId->rankId"
90        */
91       xbt_dynar_set(p_linkUpDownList, position
92           + j,
93           &info);
94       dim_product   *= current_dimension;
95       xbt_free(link_id);
96   }
97   rank++;
98 }
99
100 void AsClusterTorus::parse_specific_arguments(sg_platf_cluster_cbarg_t cluster){
101
102   unsigned int iter;
103   char *groups;
104   xbt_dynar_t dimensions = xbt_str_split(cluster->topo_parameters, ",");
105
106     if (!xbt_dynar_is_empty(dimensions)) {
107       p_dimensions= xbt_dynar_new(sizeof(int), NULL);
108       /**
109        * We are in a torus cluster
110        * Parse attribute dimensions="dim1,dim2,dim3,...,dimN"
111        * and safe it in a dynarray.
112        * Additionally, we need to know how many ranks we have in total
113        */
114       xbt_dynar_foreach(dimensions, iter, groups) {
115           int tmp = surf_parse_get_int(xbt_dynar_get_as(dimensions, iter, char *));
116           xbt_dynar_set_as(p_dimensions, iter, int, tmp);
117       }
118
119       p_nb_links_per_node = xbt_dynar_length(p_dimensions);
120
121     }
122     xbt_dynar_free(&dimensions);
123 }
124
125 void AsClusterTorus::getRouteAndLatency(NetCard *src, NetCard *dst, sg_platf_route_cbarg_t route, double *lat){
126
127   XBT_VERB("torus_get_route_and_latency from '%s'[%d] to '%s'[%d]",
128                src->getName(), src->getId(),
129                dst->getName(), dst->getId());
130
131      if (dst->getRcType() == SURF_NETWORK_ELEMENT_ROUTER || src->getRcType() == SURF_NETWORK_ELEMENT_ROUTER) return;
132
133      if((src->getId() == dst->getId()) && p_has_loopback  ){
134        s_surf_parsing_link_up_down_t info = xbt_dynar_get_as(p_linkUpDownList, src->getId() * p_nb_links_per_node, s_surf_parsing_link_up_down_t);
135        xbt_dynar_push_as(route->link_list, void *, info.link_up);
136
137        if (lat)
138          *lat += static_cast<Link*>(info.link_up)->getLatency();
139        return;
140      }
141
142
143      /**
144       * Dimension based routing routes through each dimension consecutively
145       * TODO Change to dynamic assignment
146       */
147      unsigned int j, cur_dim, dim_product   = 1;
148      int current_node    = src->getId();
149      int unsigned next_node       = 0;
150      /**
151       * Arrays that hold the coordinates of the current node and
152       * the target; comparing the values at the i-th position of
153       * both arrays, we can easily assess whether we need to route
154       * into this dimension or not.
155       */
156      unsigned int* myCoords, *targetCoords;
157      myCoords     = rankId_to_coords(src->getId(), p_dimensions);
158      targetCoords = rankId_to_coords(dst->getId(), p_dimensions);
159      /**
160       * linkOffset describes the offset where the link
161       * we want to use is stored
162       * (+1 is added because each node has a link from itself to itself,
163       * which can only be the case if src->m_id == dst->m_id -- see above
164       * for this special case)
165       */
166      int nodeOffset = (xbt_dynar_length(p_dimensions)+1)*src->getId();
167
168      int linkOffset = nodeOffset;
169      bool use_lnk_up          = false; // Is this link of the form "cur -> next" or "next -> cur"?
170                                        // false means: next -> cur
171      while (current_node != dst->getId()) {
172        dim_product = 1; // First, we will route in x-dimension
173        for (j = 0; j < xbt_dynar_length(p_dimensions); j++) {
174            cur_dim = xbt_dynar_get_as(p_dimensions, j, int);
175
176            // current_node/dim_product = position in current dimension
177            if ((current_node/dim_product) % cur_dim != (dst->getId()/dim_product) % cur_dim) {
178
179                if (( targetCoords[j] > myCoords[j] && targetCoords[j] <= myCoords[j]+cur_dim/2) // Is the target node on the right, without the wrap-around?
180                    || ( 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?
181                  if ((current_node / dim_product) % cur_dim == cur_dim-1)
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 *CURRENT* node for calculation (as opposed to next_node)
187                  nodeOffset = current_node*(p_nb_links_per_node);
188                  linkOffset = nodeOffset+p_has_loopback+p_has_limiter+j;
189                  use_lnk_up = true;
190                  assert(linkOffset >= 0);
191                }
192                else { // Route to the left
193                  if ((current_node / dim_product) % cur_dim == 0)
194                      next_node = (current_node-dim_product+dim_product*cur_dim);
195                  else
196                      next_node = (current_node-dim_product);
197
198                  // HERE: We use *next* node for calculation (as opposed to current_node!)
199                  nodeOffset = next_node*(p_nb_links_per_node);
200                  linkOffset = nodeOffset+j+p_has_loopback+p_has_limiter;
201                  use_lnk_up = false;
202
203                  assert(linkOffset >= 0);
204                }
205                XBT_DEBUG("torus_get_route_and_latency - current_node: %i, next_node: %u, linkOffset is %i",
206                current_node, next_node, linkOffset);
207
208                break;
209            }
210
211            dim_product *= cur_dim;
212        }
213
214        s_surf_parsing_link_up_down_t info;
215
216        if (p_has_limiter){          // limiter for sender
217              info = xbt_dynar_get_as(p_linkUpDownList, nodeOffset + p_has_loopback, s_surf_parsing_link_up_down_t);
218              xbt_dynar_push_as(route->link_list, void *, info.link_up);
219        }
220
221        info = xbt_dynar_get_as(p_linkUpDownList,linkOffset, s_surf_parsing_link_up_down_t);
222
223        if (use_lnk_up == false){
224            xbt_dynar_push_as(route->link_list,void*,info.link_down);
225
226        if (lat)
227          *lat += static_cast<Link*>(info.link_down)->getLatency();
228        }else{
229            xbt_dynar_push_as(route->link_list,void*,info.link_up);
230
231        if (lat)
232          *lat += static_cast<Link*>(info.link_up)->getLatency();
233        }
234        current_node = next_node;
235        next_node = 0;
236      }
237      free(myCoords);
238      free(targetCoords);
239
240
241
242   return;
243 }
244
245 }
246 }