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