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