1 /* Copyright (c) 2014-2016. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
9 #include "src/kernel/routing/FatTreeZone.hpp"
10 #include "src/kernel/routing/NetCard.hpp"
11 #include "src/surf/network_interface.hpp"
15 #include <boost/algorithm/string/classification.hpp>
16 #include <boost/algorithm/string/split.hpp>
18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_fat_tree, surf, "Routing for fat trees");
24 FatTreeZone::FatTreeZone(NetZone* father, const char* name) : ClusterZone(father, name)
26 XBT_DEBUG("Creating a new fat tree.");
29 FatTreeZone::~FatTreeZone()
31 for (unsigned int i = 0; i < this->nodes_.size(); i++) {
32 delete this->nodes_[i];
34 for (unsigned int i = 0; i < this->links_.size(); i++) {
35 delete this->links_[i];
39 bool FatTreeZone::isInSubTree(FatTreeNode* root, FatTreeNode* node)
41 XBT_DEBUG("Is %d(%u,%u) in the sub tree of %d(%u,%u) ?", node->id, node->level, node->position, root->id, root->level,
43 if (root->level <= node->level) {
46 for (unsigned int i = 0; i < node->level; i++) {
47 if (root->label[i] != node->label[i]) {
52 for (unsigned int i = root->level; i < this->levels_; i++) {
53 if (root->label[i] != node->label[i]) {
60 void FatTreeZone::getLocalRoute(NetCard* src, NetCard* dst, sg_platf_route_cbarg_t into, double* latency)
63 if (dst->isRouter() || src->isRouter())
66 /* Let's find the source and the destination in our internal structure */
67 auto searchedNode = this->computeNodes_.find(src->id());
68 xbt_assert(searchedNode != this->computeNodes_.end(), "Could not find the source %s [%d] in the fat tree",
69 src->name().c_str(), src->id());
70 FatTreeNode* source = searchedNode->second;
72 searchedNode = this->computeNodes_.find(dst->id());
73 xbt_assert(searchedNode != this->computeNodes_.end(), "Could not find the destination %s [%d] in the fat tree",
74 dst->name().c_str(), dst->id());
75 FatTreeNode* destination = searchedNode->second;
77 XBT_VERB("Get route and latency from '%s' [%d] to '%s' [%d] in a fat tree", src->name().c_str(), src->id(),
78 dst->name().c_str(), dst->id());
80 /* In case destination is the source, and there is a loopback, let's use it instead of going up to a switch */
81 if (source->id == destination->id && this->hasLoopback_) {
82 into->link_list->push_back(source->loopback);
84 *latency += source->loopback->latency();
88 FatTreeNode* currentNode = source;
91 while (!isInSubTree(currentNode, destination)) {
92 int d = destination->position; // as in d-mod-k
94 for (unsigned int i = 0; i < currentNode->level; i++)
95 d /= this->upperLevelNodesNumber_[i];
97 int k = this->upperLevelNodesNumber_[currentNode->level];
99 into->link_list->push_back(currentNode->parents[d]->upLink);
102 *latency += currentNode->parents[d]->upLink->latency();
104 if (this->hasLimiter_)
105 into->link_list->push_back(currentNode->limiterLink);
106 currentNode = currentNode->parents[d]->upNode;
109 XBT_DEBUG("%d(%u,%u) is in the sub tree of %d(%u,%u).", destination->id, destination->level, destination->position,
110 currentNode->id, currentNode->level, currentNode->position);
113 while (currentNode != destination) {
114 for (unsigned int i = 0; i < currentNode->children.size(); i++) {
115 if (i % this->lowerLevelNodesNumber_[currentNode->level - 1] == destination->label[currentNode->level - 1]) {
116 into->link_list->push_back(currentNode->children[i]->downLink);
118 *latency += currentNode->children[i]->downLink->latency();
119 currentNode = currentNode->children[i]->downNode;
120 if (this->hasLimiter_)
121 into->link_list->push_back(currentNode->limiterLink);
122 XBT_DEBUG("%d(%u,%u) is accessible through %d(%u,%u)", destination->id, destination->level,
123 destination->position, currentNode->id, currentNode->level, currentNode->position);
129 /* This function makes the assumption that parse_specific_arguments() and
130 * addNodes() have already been called
132 void FatTreeZone::seal()
134 if (this->levels_ == 0) {
137 this->generateSwitches();
139 if (XBT_LOG_ISENABLED(surf_route_fat_tree, xbt_log_priority_debug)) {
140 std::stringstream msgBuffer;
142 msgBuffer << "We are creating a fat tree of " << this->levels_ << " levels "
143 << "with " << this->nodesByLevel_[0] << " processing nodes";
144 for (unsigned int i = 1; i <= this->levels_; i++) {
145 msgBuffer << ", " << this->nodesByLevel_[i] << " switches at level " << i;
147 XBT_DEBUG("%s", msgBuffer.str().c_str());
149 msgBuffer << "Nodes are : ";
151 for (unsigned int i = 0; i < this->nodes_.size(); i++) {
152 msgBuffer << this->nodes_[i]->id << "(" << this->nodes_[i]->level << "," << this->nodes_[i]->position << ") ";
154 XBT_DEBUG("%s", msgBuffer.str().c_str());
157 this->generateLabels();
160 // Nodes are totally ordered, by level and then by position, in this->nodes
161 for (unsigned int i = 0; i < this->levels_; i++) {
162 for (unsigned int j = 0; j < this->nodesByLevel_[i]; j++) {
163 this->connectNodeToParents(this->nodes_[k]);
168 if (XBT_LOG_ISENABLED(surf_route_fat_tree, xbt_log_priority_debug)) {
169 std::stringstream msgBuffer;
170 msgBuffer << "Links are : ";
171 for (unsigned int i = 0; i < this->links_.size(); i++) {
172 msgBuffer << "(" << this->links_[i]->upNode->id << "," << this->links_[i]->downNode->id << ") ";
174 XBT_DEBUG("%s", msgBuffer.str().c_str());
178 int FatTreeZone::connectNodeToParents(FatTreeNode* node)
180 std::vector<FatTreeNode*>::iterator currentParentNode = this->nodes_.begin();
181 int connectionsNumber = 0;
182 const int level = node->level;
183 XBT_DEBUG("We are connecting node %d(%u,%u) to his parents.", node->id, node->level, node->position);
184 currentParentNode += this->getLevelPosition(level + 1);
185 for (unsigned int i = 0; i < this->nodesByLevel_[level + 1]; i++) {
186 if (this->areRelated(*currentParentNode, node)) {
187 XBT_DEBUG("%d(%u,%u) and %d(%u,%u) are related,"
188 " with %u links between them.",
189 node->id, node->level, node->position, (*currentParentNode)->id, (*currentParentNode)->level,
190 (*currentParentNode)->position, this->lowerLevelPortsNumber_[level]);
191 for (unsigned int j = 0; j < this->lowerLevelPortsNumber_[level]; j++) {
192 this->addLink(*currentParentNode, node->label[level] + j * this->lowerLevelNodesNumber_[level], node,
193 (*currentParentNode)->label[level] + j * this->upperLevelNodesNumber_[level]);
199 return connectionsNumber;
202 bool FatTreeZone::areRelated(FatTreeNode* parent, FatTreeNode* child)
204 std::stringstream msgBuffer;
206 if (XBT_LOG_ISENABLED(surf_route_fat_tree, xbt_log_priority_debug)) {
207 msgBuffer << "Are " << child->id << "(" << child->level << "," << child->position << ") <";
209 for (unsigned int i = 0; i < this->levels_; i++) {
210 msgBuffer << child->label[i] << ",";
214 msgBuffer << " and " << parent->id << "(" << parent->level << "," << parent->position << ") <";
215 for (unsigned int i = 0; i < this->levels_; i++) {
216 msgBuffer << parent->label[i] << ",";
219 msgBuffer << " related ? ";
220 XBT_DEBUG("%s", msgBuffer.str().c_str());
222 if (parent->level != child->level + 1) {
226 for (unsigned int i = 0; i < this->levels_; i++) {
227 if (parent->label[i] != child->label[i] && i + 1 != parent->level) {
234 void FatTreeZone::generateSwitches()
236 XBT_DEBUG("Generating switches.");
237 this->nodesByLevel_.resize(this->levels_ + 1, 0);
239 // Take care of the number of nodes by level
240 this->nodesByLevel_[0] = 1;
241 for (unsigned int i = 0; i < this->levels_; i++)
242 this->nodesByLevel_[0] *= this->lowerLevelNodesNumber_[i];
244 if (this->nodesByLevel_[0] != this->nodes_.size()) {
245 surf_parse_error("The number of provided nodes does not fit with the wanted topology."
246 " Please check your platform description (We need %d nodes, we got %zu)",
247 this->nodesByLevel_[0], this->nodes_.size());
251 for (unsigned int i = 0; i < this->levels_; i++) {
252 int nodesInThisLevel = 1;
254 for (unsigned int j = 0; j <= i; j++)
255 nodesInThisLevel *= this->upperLevelNodesNumber_[j];
257 for (unsigned int j = i + 1; j < this->levels_; j++)
258 nodesInThisLevel *= this->lowerLevelNodesNumber_[j];
260 this->nodesByLevel_[i + 1] = nodesInThisLevel;
263 // Create the switches
265 for (unsigned int i = 0; i < this->levels_; i++) {
266 for (unsigned int j = 0; j < this->nodesByLevel_[i + 1]; j++) {
267 FatTreeNode* newNode = new FatTreeNode(this->cluster_, --k, i + 1, j);
268 XBT_DEBUG("We create the switch %d(%d,%d)", newNode->id, newNode->level, newNode->position);
269 newNode->children.resize(this->lowerLevelNodesNumber_[i] * this->lowerLevelPortsNumber_[i]);
270 if (i != this->levels_ - 1) {
271 newNode->parents.resize(this->upperLevelNodesNumber_[i + 1] * this->lowerLevelPortsNumber_[i + 1]);
273 newNode->label.resize(this->levels_);
274 this->nodes_.push_back(newNode);
279 void FatTreeZone::generateLabels()
281 XBT_DEBUG("Generating labels.");
282 // TODO : check if nodesByLevel and nodes are filled
283 std::vector<int> maxLabel(this->levels_);
284 std::vector<int> currentLabel(this->levels_);
286 for (unsigned int i = 0; i <= this->levels_; i++) {
287 currentLabel.assign(this->levels_, 0);
288 for (unsigned int j = 0; j < this->levels_; j++) {
289 maxLabel[j] = j + 1 > i ? this->lowerLevelNodesNumber_[j] : this->upperLevelNodesNumber_[j];
292 for (unsigned int j = 0; j < this->nodesByLevel_[i]; j++) {
294 if (XBT_LOG_ISENABLED(surf_route_fat_tree, xbt_log_priority_debug)) {
295 std::stringstream msgBuffer;
297 msgBuffer << "Assigning label <";
298 for (unsigned int l = 0; l < this->levels_; l++) {
299 msgBuffer << currentLabel[l] << ",";
301 msgBuffer << "> to " << k << " (" << i << "," << j << ")";
303 XBT_DEBUG("%s", msgBuffer.str().c_str());
305 this->nodes_[k]->label.assign(currentLabel.begin(), currentLabel.end());
307 bool remainder = true;
308 unsigned int pos = 0;
309 while (remainder && pos < this->levels_) {
311 if (currentLabel[pos] >= maxLabel[pos]) {
312 currentLabel[pos] = 0;
325 int FatTreeZone::getLevelPosition(const unsigned int level)
327 xbt_assert(level <= this->levels_, "The impossible did happen. Yet again.");
328 int tempPosition = 0;
330 for (unsigned int i = 0; i < level; i++)
331 tempPosition += this->nodesByLevel_[i];
336 void FatTreeZone::addProcessingNode(int id)
338 using std::make_pair;
339 static int position = 0;
340 FatTreeNode* newNode;
341 newNode = new FatTreeNode(this->cluster_, id, 0, position++);
342 newNode->parents.resize(this->upperLevelNodesNumber_[0] * this->lowerLevelPortsNumber_[0]);
343 newNode->label.resize(this->levels_);
344 this->computeNodes_.insert(make_pair(id, newNode));
345 this->nodes_.push_back(newNode);
348 void FatTreeZone::addLink(FatTreeNode* parent, unsigned int parentPort, FatTreeNode* child, unsigned int childPort)
350 FatTreeLink* newLink;
351 newLink = new FatTreeLink(this->cluster_, child, parent);
352 XBT_DEBUG("Creating a link between the parent (%d,%d,%u) and the child (%d,%d,%u)", parent->level, parent->position,
353 parentPort, child->level, child->position, childPort);
354 parent->children[parentPort] = newLink;
355 child->parents[childPort] = newLink;
357 this->links_.push_back(newLink);
360 void FatTreeZone::parse_specific_arguments(sg_platf_cluster_cbarg_t cluster)
362 std::vector<std::string> parameters;
363 std::vector<std::string> tmp;
364 boost::split(parameters, cluster->topo_parameters, boost::is_any_of(";"));
366 // TODO : we have to check for zeros and negative numbers, or it might crash
367 if (parameters.size() != 4) {
369 "Fat trees are defined by the levels number and 3 vectors, see the documentation for more information");
372 // The first parts of topo_parameters should be the levels number
373 this->levels_ = xbt_str_parse_int(parameters[0].c_str(), "First parameter is not the amount of levels: %s");
375 // Then, a l-sized vector standing for the children number by level
376 boost::split(tmp, parameters[1], boost::is_any_of(","));
377 if (tmp.size() != this->levels_) {
378 surf_parse_error("Fat trees are defined by the levels number and 3 vectors"
379 ", see the documentation for more information");
381 for (size_t i = 0; i < tmp.size(); i++) {
382 this->lowerLevelNodesNumber_.push_back(xbt_str_parse_int(tmp[i].c_str(), "Invalid lower level node number: %s"));
385 // Then, a l-sized vector standing for the parents number by level
386 boost::split(tmp, parameters[2], boost::is_any_of(","));
387 if (tmp.size() != this->levels_) {
388 surf_parse_error("Fat trees are defined by the levels number and 3 vectors"
389 ", see the documentation for more information");
391 for (size_t i = 0; i < tmp.size(); i++) {
392 this->upperLevelNodesNumber_.push_back(xbt_str_parse_int(tmp[i].c_str(), "Invalid upper level node number: %s"));
395 // Finally, a l-sized vector standing for the ports number with the lower level
396 boost::split(tmp, parameters[3], boost::is_any_of(","));
397 if (tmp.size() != this->levels_) {
398 surf_parse_error("Fat trees are defined by the levels number and 3 vectors"
399 ", see the documentation for more information");
401 for (size_t i = 0; i < tmp.size(); i++) {
402 this->lowerLevelPortsNumber_.push_back(xbt_str_parse_int(tmp[i].c_str(), "Invalid lower level node number: %s"));
404 this->cluster_ = cluster;
407 void FatTreeZone::generateDotFile(const std::string& filename) const
410 file.open(filename, std::ios::out | std::ios::trunc);
411 xbt_assert(file.is_open(), "Unable to open file %s", filename.c_str());
413 file << "graph AsClusterFatTree {\n";
414 for (unsigned int i = 0; i < this->nodes_.size(); i++) {
415 file << this->nodes_[i]->id;
416 if (this->nodes_[i]->id < 0)
417 file << " [shape=circle];\n";
419 file << " [shape=hexagon];\n";
422 for (unsigned int i = 0; i < this->links_.size(); i++) {
423 file << this->links_[i]->downNode->id << " -- " << this->links_[i]->upNode->id << ";\n";
429 FatTreeNode::FatTreeNode(sg_platf_cluster_cbarg_t cluster, int id, int level, int position)
430 : id(id), level(level), position(position)
432 s_sg_platf_link_cbarg_t linkTemplate;
433 if (cluster->limiter_link) {
434 memset(&linkTemplate, 0, sizeof(linkTemplate));
435 linkTemplate.bandwidth = cluster->limiter_link;
436 linkTemplate.latency = 0;
437 linkTemplate.policy = SURF_LINK_SHARED;
438 linkTemplate.id = bprintf("limiter_%d", id);
439 sg_platf_new_link(&linkTemplate);
440 this->limiterLink = Link::byName(linkTemplate.id);
441 free(const_cast<char*>(linkTemplate.id));
443 if (cluster->loopback_bw || cluster->loopback_lat) {
444 memset(&linkTemplate, 0, sizeof(linkTemplate));
445 linkTemplate.bandwidth = cluster->loopback_bw;
446 linkTemplate.latency = cluster->loopback_lat;
447 linkTemplate.policy = SURF_LINK_FATPIPE;
448 linkTemplate.id = bprintf("loopback_%d", id);
449 sg_platf_new_link(&linkTemplate);
450 this->loopback = Link::byName(linkTemplate.id);
451 free(const_cast<char*>(linkTemplate.id));
455 FatTreeLink::FatTreeLink(sg_platf_cluster_cbarg_t cluster, FatTreeNode* downNode, FatTreeNode* upNode)
456 : upNode(upNode), downNode(downNode)
458 static int uniqueId = 0;
459 s_sg_platf_link_cbarg_t linkTemplate;
460 memset(&linkTemplate, 0, sizeof(linkTemplate));
461 linkTemplate.bandwidth = cluster->bw;
462 linkTemplate.latency = cluster->lat;
463 linkTemplate.policy = cluster->sharing_policy; // sthg to do with that ?
464 linkTemplate.id = bprintf("link_from_%d_to_%d_%d", downNode->id, upNode->id, uniqueId);
465 sg_platf_new_link(&linkTemplate);
467 if (cluster->sharing_policy == SURF_LINK_FULLDUPLEX) {
468 std::string tmpID = std::string(linkTemplate.id) + "_UP";
469 this->upLink = Link::byName(tmpID.c_str()); // check link?
470 tmpID = std::string(linkTemplate.id) + "_DOWN";
471 this->downLink = Link::byName(tmpID.c_str()); // check link ?
473 this->upLink = Link::byName(linkTemplate.id);
474 this->downLink = this->upLink;
476 free(const_cast<char*>(linkTemplate.id));