+#include "surf_routing_cluster_torus.hpp"
+
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_cluster_torus, surf_route_cluster, "Torus Routing part of surf");
+
+
+inline unsigned int* rankId_to_coords(int rankId, xbt_dynar_t dimensions) {
+
+ unsigned int i = 0, cur_dim_size = 1, dim_size_product = 1;
+ unsigned int* coords = (unsigned int*)malloc(xbt_dynar_length(dimensions)*sizeof(unsigned int));
+ for (i = 0; i < xbt_dynar_length(dimensions); i++) {
+ cur_dim_size = xbt_dynar_get_as(dimensions, i, int);
+ coords[i] = (rankId / dim_size_product) % cur_dim_size;
+ dim_size_product *= cur_dim_size;
+ }
+
+ return coords;
+}
+
+
+AS_t model_torus_cluster_create(void)
+{
+ return new AsClusterTorus();
+}
+
+/* Creation routing model functions */
+AsClusterTorus::AsClusterTorus() : AsCluster()
+{
+ p_dimensions = NULL;
+}
+
+
+
+void AsClusterTorus::create_links_for_node(sg_platf_cluster_cbarg_t cluster, int id, int rank, int position){
+ s_sg_platf_link_cbarg_t link;
+ char* link_id;
+ unsigned int j = 0;
+ /**
+ * Create all links that exist in the torus.
+ * Each rank creates #dimensions-1 links
+ */
+ int neighbour_rank_id = 0; // The other node the link connects
+ int current_dimension = 0, // which dimension are we currently in?
+ // we need to iterate over all dimensions
+ // and create all links there
+ dim_product = 1; // Needed to calculate the next neighbour_id
+ for (j = 0; j < xbt_dynar_length(p_dimensions); j++) {
+
+ memset(&link, 0, sizeof(link));
+ current_dimension = xbt_dynar_get_as(p_dimensions, j, int);
+ neighbour_rank_id = ( ((int) rank / dim_product) % current_dimension == current_dimension-1) ? rank - (current_dimension-1)*dim_product : rank + dim_product;
+ //name of neighbour is not right for non contiguous cluster radicals (as id != rank in this case)
+ link_id = bprintf("%s_link_from_%i_to_%i", cluster->id, id, neighbour_rank_id);
+ link.id = link_id;
+ link.bandwidth = cluster->bw;
+ link.latency = cluster->lat;
+ link.state = SURF_RESOURCE_ON;
+ link.policy = cluster->sharing_policy;
+ sg_platf_new_link(&link);
+ s_surf_parsing_link_up_down_t info;
+ if (link.policy == SURF_LINK_FULLDUPLEX) {
+ char *tmp_link = bprintf("%s_UP", link_id);
+ info.link_up =
+ xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
+ free(tmp_link);
+ tmp_link = bprintf("%s_DOWN", link_id);
+ info.link_down =
+ xbt_lib_get_or_null(link_lib, tmp_link, SURF_LINK_LEVEL);
+ free(tmp_link);
+ } else {
+ info.link_up = xbt_lib_get_or_null(link_lib, link_id, SURF_LINK_LEVEL);
+ info.link_down = info.link_up;
+ }
+ /**
+ * Add the link to its appropriate position;
+ * note that position rankId*(xbt_dynar_length(dimensions)+has_loopack?+has_limiter?)
+ * holds the link "rankId->rankId"
+ */
+ xbt_dynar_set(p_linkUpDownList, position
+ + j,
+ &info);
+ dim_product *= current_dimension;
+ xbt_free(link_id);
+ }
+ rank++;
+}
+
+void AsClusterTorus::parse_specific_arguments(sg_platf_cluster_cbarg_t cluster){
+
+ unsigned int iter;
+ char *groups;
+ p_dimensions = xbt_str_split(cluster->topo_parameters, ",");
+
+ if (!xbt_dynar_is_empty(p_dimensions)) {
+ /**
+ * We are in a torus cluster
+ * Parse attribute dimensions="dim1,dim2,dim3,...,dimN"
+ * and safe it in a dynarray.
+ * Additionally, we need to know how many ranks we have in total
+ */
+ xbt_dynar_foreach(p_dimensions, iter, groups) {
+ int tmp = surf_parse_get_int(xbt_dynar_get_as(p_dimensions, iter, char *));
+ xbt_dynar_set_as(p_dimensions, iter, int, tmp);
+ }
+
+ p_nb_links_per_node = xbt_dynar_length(p_dimensions);
+
+ }
+}
+
+void AsClusterTorus::getRouteAndLatency(RoutingEdgePtr src, RoutingEdgePtr dst, sg_platf_route_cbarg_t route, double *lat){
+
+ XBT_INFO("torus_get_route_and_latency from '%s'[%d] to '%s'[%d]",
+ src->p_name,src->m_id,
+ dst->p_name,dst->m_id);
+
+ if (dst->p_rcType == SURF_NETWORK_ELEMENT_ROUTER || src->p_rcType == SURF_NETWORK_ELEMENT_ROUTER) return;
+
+ if((src->m_id == dst->m_id) && p_has_loopback ){
+ s_surf_parsing_link_up_down_t info = xbt_dynar_get_as(p_linkUpDownList, src->m_id * p_nb_links_per_node, s_surf_parsing_link_up_down_t);
+ xbt_dynar_push_as(route->link_list, void *, info.link_up);
+
+ if (lat)
+ *lat += static_cast<NetworkLinkPtr>(info.link_up)->getLatency();
+ return;
+ }
+
+
+ /**
+ * Dimension based routing routes through each dimension consecutively
+ * TODO Change to dynamic assignment
+ */
+ unsigned int j, cur_dim, dim_product = 1;
+ long current_node = src->m_id;
+ long unsigned next_node = 0;
+ /**
+ * Arrays that hold the coordinates of the current node and
+ * the target; comparing the values at the i-th position of
+ * both arrays, we can easily assess whether we need to route
+ * into this dimension or not.
+ */
+ unsigned int* myCoords, *targetCoords;
+ myCoords = rankId_to_coords(src->m_id, p_dimensions);
+ targetCoords = rankId_to_coords(dst->m_id, p_dimensions);
+ /**
+ * linkOffset describes the offset where the link
+ * we want to use is stored
+ * (+1 is added because each node has a link from itself to itself,
+ * which can only be the case if src->m_id == dst->m_id -- see above
+ * for this special case)
+ */
+ long nodeOffset = (xbt_dynar_length(p_dimensions)+1)*src->m_id;
+
+ long linkOffset = nodeOffset;
+ bool use_lnk_up = false; // Is this link of the form "cur -> next" or "next -> cur"?
+ // false means: next -> cur
+ while (current_node != dst->m_id) {
+ dim_product = 1; // First, we will route in x-dimension
+ for (j = 0; j < xbt_dynar_length(p_dimensions); j++) {
+ cur_dim = xbt_dynar_get_as(p_dimensions, j, int);
+
+ // current_node/dim_product = position in current dimension
+ if ((current_node/dim_product) % cur_dim != (dst->m_id/dim_product) % cur_dim) {
+
+ if (( targetCoords[j] > myCoords[j] && targetCoords[j] <= myCoords[j]+cur_dim/2) // Is the target node on the right, without the wrap-around?
+ || ( 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?
+ if ((current_node / dim_product) % cur_dim == cur_dim-1)
+ next_node = (current_node+dim_product-dim_product*cur_dim);
+ else
+ next_node = (current_node+dim_product);
+
+ // HERE: We use *CURRENT* node for calculation (as opposed to next_node)
+ nodeOffset = current_node*(p_nb_links_per_node);
+ linkOffset = nodeOffset+p_has_loopback+p_has_limiter+j;
+ use_lnk_up = true;
+ assert(linkOffset >= 0);
+ }
+ else { // Route to the left
+ if ((current_node / dim_product) % cur_dim == 0)
+ next_node = (current_node-dim_product+dim_product*cur_dim);
+ else
+ next_node = (current_node-dim_product);
+
+ // HERE: We use *next* node for calculation (as opposed to current_node!)
+ nodeOffset = next_node*(p_nb_links_per_node);
+ linkOffset = nodeOffset+j+p_has_loopback+p_has_limiter;
+ use_lnk_up = false;
+
+ assert(linkOffset >= 0);
+ }
+ XBT_DEBUG("torus_get_route_and_latency - current_node: %lu, next_node: %lu, linkOffset is %lu",
+ current_node, next_node, linkOffset);
+
+ break;
+ }
+
+ dim_product *= cur_dim;
+ }
+
+ s_surf_parsing_link_up_down_t info;
+
+ if (p_has_limiter){ // limiter for sender
+ info = xbt_dynar_get_as(p_linkUpDownList, nodeOffset + p_has_loopback, s_surf_parsing_link_up_down_t);
+ xbt_dynar_push_as(route->link_list, void *, info.link_up);
+ }
+
+ info = xbt_dynar_get_as(p_linkUpDownList,linkOffset, s_surf_parsing_link_up_down_t);
+
+ if (use_lnk_up == false)
+ xbt_dynar_push_as(route->link_list,void*,info.link_down);
+ else
+ xbt_dynar_push_as(route->link_list,void*,info.link_up);
+
+ current_node = next_node;
+ next_node = 0;
+ }
+ free(myCoords);
+ free(targetCoords);
+
+
+
+ return;
+}