-/* Copyright (c) 2014-2016. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2014-2022. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
-#include "src/kernel/routing/TorusZone.hpp"
-#include "src/kernel/routing/NetPoint.hpp"
-#include "src/surf/network_interface.hpp"
+#include "simgrid/kernel/routing/TorusZone.hpp"
+#include "simgrid/kernel/routing/NetPoint.hpp"
+#include "simgrid/s4u/Host.hpp"
+#include "src/kernel/resource/LinkImpl.hpp"
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_cluster_torus, surf_route_cluster, "Torus Routing part of surf");
+#include <boost/algorithm/string/classification.hpp>
+#include <boost/algorithm/string/split.hpp>
+#include <numeric>
+#include <string>
+#include <vector>
-inline unsigned int* rankId_to_coords(int rankId, std::vector<unsigned int> dimensions)
-{
-
- unsigned int dim_size_product = 1;
- unsigned int* coords = new unsigned int[dimensions.size()];
- unsigned int i = 0;
- for (auto cur_dim_size: dimensions) {
- coords[i] = (rankId / dim_size_product) % cur_dim_size;
- dim_size_product *= cur_dim_size;
- i++;
- }
-
- return coords;
-}
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_routing_torus, ker_routing, "Kernel Torus Routing");
namespace simgrid {
namespace kernel {
namespace routing {
-TorusZone::TorusZone(NetZone* father, const char* name) : ClusterZone(father, name)
-{
-}
-void TorusZone::create_links_for_node(sg_platf_cluster_cbarg_t cluster, int id, int rank, int position)
+void TorusZone::create_torus_links(unsigned long id, int rank, unsigned long position)
{
- /*
- * Create all links that exist in the torus.
- * Each rank creates @a dimensions-1 links
- */
- int neighbor_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
- int dim_product = 1; // Needed to calculate the next neighbor_id
- for (unsigned int j = 0; j < dimensions_.size(); j++) {
-
- LinkCreationArgs link;
- current_dimension = dimensions_.at(j);
- neighbor_rank_id = ((static_cast<int>(rank) / dim_product) % current_dimension == current_dimension - 1)
- ? rank - (current_dimension - 1) * dim_product
- : rank + dim_product;
+ /* Create all links that exist in the torus. Each rank creates @a dimensions-1 links */
+ unsigned long dim_product = 1; // Needed to calculate the next neighbor_id
+
+ for (unsigned long j = 0; j < dimensions_.size(); j++) {
+ unsigned long current_dimension =
+ dimensions_[j]; // which dimension are we currently in?
+ // we need to iterate over all dimensions and create all links there
+ // The other node the link connects
+ unsigned long neighbor_rank_id = ((rank / dim_product) % current_dimension == current_dimension - 1)
+ ? rank - (current_dimension - 1) * dim_product
+ : rank + dim_product;
// name of neighbor is not right for non contiguous cluster radicals (as id != rank in this case)
- char* link_id = bprintf("%s_link_from_%i_to_%i", cluster->id, id, neighbor_rank_id);
- link.id = link_id;
- link.bandwidth = cluster->bw;
- link.latency = cluster->lat;
- link.policy = cluster->sharing_policy;
- sg_platf_new_link(&link);
- surf::LinkImpl* linkUp;
- surf::LinkImpl* linkDown;
- if (link.policy == SURF_LINK_FULLDUPLEX) {
- char* tmp_link = bprintf("%s_UP", link_id);
- linkUp = surf::LinkImpl::byName(tmp_link);
- free(tmp_link);
- tmp_link = bprintf("%s_DOWN", link_id);
- linkDown = surf::LinkImpl::byName(tmp_link);
- free(tmp_link);
+ std::string link_id = get_name() + "_link_from_" + std::to_string(id) + "_to_" + std::to_string(neighbor_rank_id);
+ const s4u::Link* linkup;
+ const s4u::Link* linkdown;
+ if (get_link_sharing_policy() == s4u::Link::SharingPolicy::SPLITDUPLEX) {
+ linkup = create_link(link_id + "_UP", {get_link_bandwidth()})->set_latency(get_link_latency())->seal();
+ linkdown = create_link(link_id + "_DOWN", {get_link_bandwidth()})->set_latency(get_link_latency())->seal();
+
} else {
- linkUp = surf::LinkImpl::byName(link_id);
- linkDown = linkUp;
+ linkup = create_link(link_id, {get_link_bandwidth()})->set_latency(get_link_latency())->seal();
+ linkdown = linkup;
}
/*
- * Add the link to its appropriate position;
- * note that position rankId*(xbt_dynar_length(dimensions)+has_loopback?+has_limiter?)
+ * Add the link to its appropriate position.
+ * Note that position rankId*(xbt_dynar_length(dimensions)+has_loopback?+has_limiter?)
* holds the link "rankId->rankId"
*/
- privateLinks_.insert({position + j, {linkUp, linkDown}});
+ add_private_link_at(position + j, {linkup->get_impl(), linkdown->get_impl()});
dim_product *= current_dimension;
- xbt_free(link_id);
}
- rank++;
}
-void TorusZone::parse_specific_arguments(sg_platf_cluster_cbarg_t cluster)
+std::vector<unsigned long> TorusZone::parse_topo_parameters(const std::string& topo_parameters)
{
+ std::vector<std::string> dimensions_str;
+ boost::split(dimensions_str, topo_parameters, boost::is_any_of(","));
+ std::vector<unsigned long> dimensions;
- unsigned int iter;
- char* groups;
- xbt_dynar_t dimensions = xbt_str_split(cluster->topo_parameters, ",");
-
- if (!xbt_dynar_is_empty(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 (dimensions, iter, groups) {
- int tmp = surf_parse_get_int(xbt_dynar_get_as(dimensions, iter, char*));
- dimensions_.push_back(tmp);
- }
+ /* We are in a torus cluster
+ * Parse attribute dimensions="dim1,dim2,dim3,...,dimN" and save them into a vector.
+ * Additionally, we need to know how many ranks we have in total
+ */
+ std::transform(begin(dimensions_str), end(dimensions_str), std::back_inserter(dimensions),
+ [](const std::string& s) { return std::stoi(s); });
- linkCountPerNode_ = dimensions_.size();
- }
- xbt_dynar_free(&dimensions);
+ return dimensions;
}
-void TorusZone::getLocalRoute(NetPoint* src, NetPoint* dst, sg_platf_route_cbarg_t route, double* lat)
+void TorusZone::set_topology(const std::vector<unsigned long>& dimensions)
{
+ xbt_assert(not dimensions.empty(), "Torus dimensions cannot be empty");
+ dimensions_ = dimensions;
+ set_num_links_per_node(dimensions_.size());
+}
- XBT_VERB("torus getLocalRoute from '%s'[%d] to '%s'[%d]", src->name().c_str(), src->id(), dst->name().c_str(),
- dst->id());
+void TorusZone::get_local_route(const NetPoint* src, const NetPoint* dst, Route* route, double* lat)
+{
+ XBT_VERB("torus getLocalRoute from '%s'[%lu] to '%s'[%lu]", src->get_cname(), src->id(), dst->get_cname(), dst->id());
- if (dst->isRouter() || src->isRouter())
+ if (dst->is_router() || src->is_router())
return;
- if (src->id() == dst->id() && hasLoopback_) {
- std::pair<surf::LinkImpl*, surf::LinkImpl*> info = privateLinks_.at(src->id() * linkCountPerNode_);
+ if (src->id() == dst->id() && has_loopback()) {
+ resource::StandardLinkImpl* uplink = get_uplink_from(node_pos(src->id()));
- route->link_list->push_back(info.first);
- if (lat)
- *lat += info.first->latency();
+ add_link_latency(route->link_list_, uplink, lat);
return;
}
* Dimension based routing routes through each dimension consecutively
* TODO Change to dynamic assignment
*/
- unsigned int dim_product = 1;
- unsigned int current_node = src->id();
- unsigned int 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.
+ * 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 = rankId_to_coords(src->id(), dimensions_);
- unsigned int* targetCoords = rankId_to_coords(dst->id(), dimensions_);
+ const unsigned long dsize = dimensions_.size();
+ std::vector<unsigned long> myCoords(dsize);
+ std::vector<unsigned long> targetCoords(dsize);
+ unsigned int dim_size_product = 1;
+ for (unsigned long i = 0; i < dsize; i++) {
+ unsigned long cur_dim_size = dimensions_[i];
+ myCoords[i] = (src->id() / dim_size_product) % cur_dim_size;
+ targetCoords[i] = (dst->id() / dim_size_product) % cur_dim_size;
+ dim_size_product *= cur_dim_size;
+ }
+
/*
- * 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)
+ * 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)
*/
- int nodeOffset = (dimensions_.size() + 1) * src->id();
+ unsigned long linkOffset = (dsize + 1) * src->id();
- int linkOffset = nodeOffset;
- bool use_lnk_up = false; // Is this link of the form "cur -> next" or "next -> cur"?
- // false means: next -> cur
+ bool use_lnk_up = false; // Is this link of the form "cur -> next" or "next -> cur"? false means: next -> cur
+ unsigned long current_node = src->id();
while (current_node != dst->id()) {
- dim_product = 1; // First, we will route in x-dimension
- int j=0;
- for (auto cur_dim : dimensions_){
+ unsigned long next_node = 0;
+ unsigned long dim_product = 1; // First, we will route in x-dimension
+ for (unsigned long j = 0; j < dsize; j++) {
+ const unsigned long cur_dim = dimensions_[j];
// current_node/dim_product = position in current dimension
if ((current_node / dim_product) % cur_dim != (dst->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?
+ ||
+ (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 * (linkCountPerNode_);
- linkOffset = nodeOffset + (hasLoopback_ ? 1 : 0) + (hasLimiter_ ? 1 : 0) + j;
+ linkOffset = node_pos_with_loopback_limiter(current_node) + 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);
next_node = (current_node - dim_product);
// HERE: We use *next* node for calculation (as opposed to current_node!)
- nodeOffset = next_node * (linkCountPerNode_);
- linkOffset = nodeOffset + j + (hasLoopback_ ? 1 : 0) + (hasLimiter_ ? 1 : 0);
+ linkOffset = node_pos_with_loopback_limiter(next_node) + j;
use_lnk_up = false;
-
- assert(linkOffset >= 0);
}
- XBT_DEBUG("torus_get_route_and_latency - current_node: %i, next_node: %u, linkOffset is %i", current_node,
+ XBT_DEBUG("torus_get_route_and_latency - current_node: %lu, next_node: %lu, linkOffset is %lu", current_node,
next_node, linkOffset);
break;
}
- j++;
dim_product *= cur_dim;
}
- std::pair<surf::LinkImpl*, surf::LinkImpl*> info;
-
- if (hasLimiter_) { // limiter for sender
- info = privateLinks_.at(nodeOffset + hasLoopback_);
- route->link_list->push_back(info.first);
+ if (has_limiter()) { // limiter for sender
+ route->link_list_.push_back(get_uplink_from(node_pos_with_loopback(current_node)));
}
- info = privateLinks_.at(linkOffset);
+ resource::StandardLinkImpl* lnk;
+ if (use_lnk_up)
+ lnk = get_uplink_from(linkOffset);
+ else
+ lnk = get_downlink_to(linkOffset);
+
+ add_link_latency(route->link_list_, lnk, lat);
- if (use_lnk_up == false) {
- route->link_list->push_back(info.second);
- if (lat)
- *lat += info.second->latency();
- } else {
- route->link_list->push_back(info.first);
- if (lat)
- *lat += info.first->latency();
- }
current_node = next_node;
- next_node = 0;
}
- delete[] myCoords;
- delete[] targetCoords;
-}
+ if (has_limiter()) { // limiter for receiver/destination
+ route->link_list_.push_back(get_downlink_to(node_pos_with_loopback(dst->id())));
+ }
+ // set gateways (if any)
+ route->gw_src_ = get_gateway(src->id());
+ route->gw_dst_ = get_gateway(dst->id());
}
+
+} // namespace routing
+} // namespace kernel
+
+namespace s4u {
+
+NetZone* create_torus_zone(const std::string& name, const NetZone* parent, const std::vector<unsigned long>& dimensions,
+ const ClusterCallbacks& set_callbacks, double bandwidth, double latency,
+ Link::SharingPolicy sharing_policy)
+{
+ int tot_elements = std::accumulate(dimensions.begin(), dimensions.end(), 1, std::multiplies<>());
+ if (dimensions.empty() || tot_elements <= 0)
+ throw std::invalid_argument("TorusZone: incorrect dimensions parameter, each value must be > 0");
+ if (bandwidth <= 0)
+ throw std::invalid_argument("TorusZone: incorrect bandwidth for internode communication, bw=" +
+ std::to_string(bandwidth));
+ if (latency < 0)
+ throw std::invalid_argument("TorusZone: incorrect latency for internode communication, lat=" +
+ std::to_string(latency));
+
+ auto* zone = new kernel::routing::TorusZone(name);
+ zone->set_topology(dimensions);
+ if (parent)
+ zone->set_parent(parent->get_impl());
+
+ zone->set_link_characteristics(bandwidth, latency, sharing_policy);
+
+ for (int i = 0; i < tot_elements; i++) {
+ kernel::routing::NetPoint* netpoint;
+ Link* limiter;
+ Link* loopback;
+ zone->fill_leaf_from_cb(i, dimensions, set_callbacks, &netpoint, &loopback, &limiter);
+
+ zone->create_torus_links(netpoint->id(), i, zone->node_pos_with_loopback_limiter(netpoint->id()));
+ }
+
+ return zone->get_iface();
}
-} // namespace
+} // namespace s4u
+
+} // namespace simgrid