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 AsClusterTorus();
  29 }
  30
  31 /* Creation routing model functions */
  32 AsClusterTorus::AsClusterTorus() : AsCluster()
  33 {
  34   p_dimensions = NULL;
  35 }
  36
  37 /* Creation routing model functions */
  38 AsClusterTorus::~AsClusterTorus()
  39 {
  40   if(p_dimensions) xbt_dynar_free(&p_dimensions);
  41 }
  42
  43
  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 = ( ((int) rank / dim_product) % current_dimension == current_dimension-1) ? rank - (current_dimension-1)*dim_product : rank + dim_product;
  62       //name of neighbour is not right for non contiguous cluster radicals (as id != rank in this case)
  63       link_id           = bprintf("%s_link_from_%i_to_%i", cluster->id, id, neighbour_rank_id);
  64       link.id           = link_id;
  65       link.bandwidth    = cluster->bw;
  66       link.latency      = cluster->lat;
  67       link.state        = SURF_RESOURCE_ON;
  68       link.policy       = cluster->sharing_policy;
  69       sg_platf_new_link(&link);
  70       s_surf_parsing_link_up_down_t info;
  71       if (link.policy == SURF_LINK_FULLDUPLEX) {
  72           char *tmp_link = bprintf("%s_UP", link_id);
  73           info.link_up = Link::byName(tmp_link);
  74           free(tmp_link);
  75           tmp_link = bprintf("%s_DOWN", link_id);
  76           info.link_down = Link::byName(tmp_link);
  77           free(tmp_link);
  78       } else {
  79           info.link_up = Link::byName(link_id);
  80           info.link_down = info.link_up;
  81       }
  82       /**
  83        * Add the link to its appropriate position;
  84        * note that position rankId*(xbt_dynar_length(dimensions)+has_loopack?+has_limiter?)
  85        * holds the link "rankId->rankId"
  86        */
  87       xbt_dynar_set(p_linkUpDownList, position
  88           + j,
  89           &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(RoutingEdge *src, RoutingEdge *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(),
 125                dst->getName(), dst->getId());
 126
 127      if (dst->getRcType() == SURF_NETWORK_ELEMENT_ROUTER || src->getRcType() == SURF_NETWORK_ELEMENT_ROUTER) return;
 128
 129      if((src->getId() == dst->getId()) && p_has_loopback  ){
 130        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);
 131        xbt_dynar_push_as(route->link_list, void *, info.link_up);
 132
 133        if (lat)
 134          *lat += static_cast<Link*>(info.link_up)->getLatency();
 135        return;
 136      }
 137
 138
 139      /**
 140       * Dimension based routing routes through each dimension consecutively
 141       * TODO Change to dynamic assignment
 142       */
 143      unsigned int j, cur_dim, dim_product   = 1;
 144      int current_node    = src->getId();
 145      int unsigned next_node       = 0;
 146      /**
 147       * Arrays that hold the coordinates of the current node and
 148       * the target; comparing the values at the i-th position of
 149       * both arrays, we can easily assess whether we need to route
 150       * into this dimension or not.
 151       */
 152      unsigned int* myCoords, *targetCoords;
 153      myCoords     = rankId_to_coords(src->getId(), p_dimensions);
 154      targetCoords = rankId_to_coords(dst->getId(), p_dimensions);
 155      /**
 156       * linkOffset describes the offset where the link
 157       * we want to use is stored
 158       * (+1 is added because each node has a link from itself to itself,
 159       * which can only be the case if src->m_id == dst->m_id -- see above
 160       * for this special case)
 161       */
 162      int nodeOffset = (xbt_dynar_length(p_dimensions)+1)*src->getId();
 163
 164      int linkOffset = nodeOffset;
 165      bool use_lnk_up          = false; // Is this link of the form "cur -> next" or "next -> cur"?
 166                                        // false means: next -> cur
 167      while (current_node != dst->getId()) {
 168        dim_product = 1; // First, we will route in x-dimension
 169        for (j = 0; j < xbt_dynar_length(p_dimensions); j++) {
 170            cur_dim = xbt_dynar_get_as(p_dimensions, j, int);
 171
 172            // current_node/dim_product = position in current dimension
 173            if ((current_node/dim_product) % cur_dim != (dst->getId()/dim_product) % cur_dim) {
 174
 175                if (( targetCoords[j] > myCoords[j] && targetCoords[j] <= myCoords[j]+cur_dim/2) // Is the target node on the right, without the wrap-around?
 176                    || ( 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?
 177                  if ((current_node / dim_product) % cur_dim == cur_dim-1)
 178                      next_node = (current_node+dim_product-dim_product*cur_dim);
 179                  else
 180                      next_node = (current_node+dim_product);
 181
 182                  // HERE: We use *CURRENT* node for calculation (as opposed to next_node)
 183                  nodeOffset = current_node*(p_nb_links_per_node);
 184                  linkOffset = nodeOffset+p_has_loopback+p_has_limiter+j;
 185                  use_lnk_up = true;
 186                  assert(linkOffset >= 0);
 187                }
 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 }