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