src/surf/surf_routing_cluster_torus.cpp

   1 /* Copyright (c) 2014. 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;
  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 =
  74               xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
  75           free(tmp_link);
  76           tmp_link = bprintf("%s_DOWN", link_id);
  77           info.link_down =
  78               xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
  79           free(tmp_link);
  80       } else {
  81           info.link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
  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
  90           + j,
  91           &info);
  92       dim_product   *= current_dimension;
  93       xbt_free(link_id);
  94   }
  95   rank++;
  96 }
  97
  98 void AsClusterTorus::parse_specific_arguments(sg_platf_cluster_cbarg_t cluster){
  99
 100   unsigned int iter;
 101   char *groups;
 102   xbt_dynar_t dimensions = xbt_str_split(cluster->topo_parameters, ",");
 103
 104     if (!xbt_dynar_is_empty(dimensions)) {
 105       p_dimensions= xbt_dynar_new(sizeof(int), NULL);
 106       /**
 107        * We are in a torus cluster
 108        * Parse attribute dimensions="dim1,dim2,dim3,...,dimN"
 109        * and safe it in a dynarray.
 110        * Additionally, we need to know how many ranks we have in total
 111        */
 112       xbt_dynar_foreach(dimensions, iter, groups) {
 113           int tmp = surf_parse_get_int(xbt_dynar_get_as(dimensions, iter, char *));
 114           xbt_dynar_set_as(p_dimensions, iter, int, tmp);
 115       }
 116
 117       p_nb_links_per_node = xbt_dynar_length(p_dimensions);
 118
 119     }
 120     xbt_dynar_free(&dimensions);
 121 }
 122
 123 void AsClusterTorus::getRouteAndLatency(RoutingEdgePtr src, RoutingEdgePtr dst, sg_platf_route_cbarg_t route, double *lat){
 124
 125   XBT_VERB("torus_get_route_and_latency from '%s'[%d] to '%s'[%d]",
 126                src->getName(), src->getId(),
 127                dst->getName(), dst->getId());
 128
 129      if (dst->getRcType() == SURF_NETWORK_ELEMENT_ROUTER || src->getRcType() == SURF_NETWORK_ELEMENT_ROUTER) return;
 130
 131      if((src->getId() == dst->getId()) && p_has_loopback  ){
 132        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);
 133        xbt_dynar_push_as(route->link_list, void *, info.link_up);
 134
 135        if (lat)
 136          *lat += static_cast<NetworkLinkPtr>(info.link_up)->getLatency();
 137        return;
 138      }
 139
 140
 141      /**
 142       * Dimension based routing routes through each dimension consecutively
 143       * TODO Change to dynamic assignment
 144       */
 145      unsigned int j, cur_dim, dim_product   = 1;
 146      int current_node    = src->getId();
 147      int unsigned next_node       = 0;
 148      /**
 149       * Arrays that hold the coordinates of the current node and
 150       * the target; comparing the values at the i-th position of
 151       * both arrays, we can easily assess whether we need to route
 152       * into this dimension or not.
 153       */
 154      unsigned int* myCoords, *targetCoords;
 155      myCoords     = rankId_to_coords(src->getId(), p_dimensions);
 156      targetCoords = rankId_to_coords(dst->getId(), p_dimensions);
 157      /**
 158       * linkOffset describes the offset where the link
 159       * we want to use is stored
 160       * (+1 is added because each node has a link from itself to itself,
 161       * which can only be the case if src->m_id == dst->m_id -- see above
 162       * for this special case)
 163       */
 164      int nodeOffset = (xbt_dynar_length(p_dimensions)+1)*src->getId();
 165
 166      int linkOffset = nodeOffset;
 167      bool use_lnk_up          = false; // Is this link of the form "cur -> next" or "next -> cur"?
 168                                        // false means: next -> cur
 169      while (current_node != dst->getId()) {
 170        dim_product = 1; // First, we will route in x-dimension
 171        for (j = 0; j < xbt_dynar_length(p_dimensions); j++) {
 172            cur_dim = xbt_dynar_get_as(p_dimensions, j, int);
 173
 174            // current_node/dim_product = position in current dimension
 175            if ((current_node/dim_product) % cur_dim != (dst->getId()/dim_product) % cur_dim) {
 176
 177                if (( targetCoords[j] > myCoords[j] && targetCoords[j] <= myCoords[j]+cur_dim/2) // Is the target node on the right, without the wrap-around?
 178                    || ( 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?
 179                  if ((current_node / dim_product) % cur_dim == cur_dim-1)
 180                      next_node = (current_node+dim_product-dim_product*cur_dim);
 181                  else
 182                      next_node = (current_node+dim_product);
 183
 184                  // HERE: We use *CURRENT* node for calculation (as opposed to next_node)
 185                  nodeOffset = current_node*(p_nb_links_per_node);
 186                  linkOffset = nodeOffset+p_has_loopback+p_has_limiter+j;
 187                  use_lnk_up = true;
 188                  assert(linkOffset >= 0);
 189                }
 190                else { // Route to the left
 191                  if ((current_node / dim_product) % cur_dim == 0)
 192                      next_node = (current_node-dim_product+dim_product*cur_dim);
 193                  else
 194                      next_node = (current_node-dim_product);
 195
 196                  // HERE: We use *next* node for calculation (as opposed to current_node!)
 197                  nodeOffset = next_node*(p_nb_links_per_node);
 198                  linkOffset = nodeOffset+j+p_has_loopback+p_has_limiter;
 199                  use_lnk_up = false;
 200
 201                  assert(linkOffset >= 0);
 202                }
 203                XBT_DEBUG("torus_get_route_and_latency - current_node: %i, next_node: %u, linkOffset is %i",
 204                current_node, next_node, linkOffset);
 205
 206                break;
 207            }
 208
 209            dim_product *= cur_dim;
 210        }
 211
 212        s_surf_parsing_link_up_down_t info;
 213
 214        if (p_has_limiter){          // limiter for sender
 215              info = xbt_dynar_get_as(p_linkUpDownList, nodeOffset + p_has_loopback, s_surf_parsing_link_up_down_t);
 216              xbt_dynar_push_as(route->link_list, void *, info.link_up);
 217        }
 218
 219        info = xbt_dynar_get_as(p_linkUpDownList,linkOffset, s_surf_parsing_link_up_down_t);
 220
 221        if (use_lnk_up == false){
 222            xbt_dynar_push_as(route->link_list,void*,info.link_down);
 223
 224        if (lat)
 225          *lat += static_cast<NetworkLinkPtr>(info.link_down)->getLatency();
 226        }else{
 227            xbt_dynar_push_as(route->link_list,void*,info.link_up);
 228
 229        if (lat)
 230          *lat += static_cast<NetworkLinkPtr>(info.link_up)->getLatency();
 231        }
 232        current_node = next_node;
 233        next_node = 0;
 234      }
 235      free(myCoords);
 236      free(targetCoords);
 237
 238
 239
 240   return;
 241 }