src/surf/surf_routing_cluster_fat_tree.hpp

   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 #ifndef SURF_ROUTING_CLUSTER_FAT_TREE_HPP_
   8 #define SURF_ROUTING_CLUSTER_FAT_TREE_HPP_
   9
  10 #include <string>
  11 #include <map>
  12 #include <vector>
  13
  14 #include <xbt/base.h>
  15
  16 #include "surf_routing_cluster.hpp"
  17
  18
  19 /** \file surf_routing_cluster_fat_tree.cpp
  20  *  The class AsClusterFatTree describes PGFT, as introduced by Eitan Zahavi
  21  * in "D-Mod-K Routing Providing Non-Blocking Traffic for Shift Permutations
  22  * on Real Life Fat Trees" (2010). RLFT are PGFT with some restrictions to
  23  * address real world constraints, which are not currently enforced.
  24  */
  25
  26 class XBT_PRIVATE FatTreeNode;
  27 class XBT_PRIVATE FatTreeLink;
  28
  29 /** \brief A node in a fat tree.
  30  * A FatTreeNode can either be a switch or a processing node. Switches are
  31  * identified by a negative ID. This class is closely related to fat
  32  */
  33 class FatTreeNode {
  34 public:
  35   /** Unique ID which identifies every node. */
  36   int id;
  37   /* Level into the tree, with 0 being the leafs.
  38    */
  39   unsigned int level;
  40   /* \brief Position into the level, starting from 0.
  41    */
  42   unsigned int position;
  43   /** In order to link nodes between them, each one must be assigned a label,
  44    * consisting of l integers, l being the levels number of the tree. Each label
  45    * is unique in the level, and the way it is generated allows the construction
  46    * of a fat tree which fits the desired topology.
  47    */
  48   std::vector<unsigned int> label;
  49
  50   /** Links to the lower level, where the position in the vector corresponds to
  51    * a port number.
  52    */
  53   std::vector<FatTreeLink*> children;
  54   /** Links to the upper level, where the position in the vector corresponds to
  55    * a port number.
  56    */
  57   std::vector<FatTreeLink*> parents;
  58
  59   /** Virtual link standing for the node global capacity.
  60    */
  61   Link* limiterLink;
  62   /** If present, communications from this node to this node will pass through it
  63    * instead of passing by an upper level switch.
  64    */
  65   Link* loopback;
  66   FatTreeNode(sg_platf_cluster_cbarg_t cluster, int id, int level,
  67               int position);
  68 };
  69
  70
  71
  72 /** \brief Link in a fat tree.
  73  *
  74  * Represents a single, duplex link in a fat tree. This is necessary to have a tree.
  75  * It is equivalent to a physical link.
  76  */
  77 class FatTreeLink {
  78 public:
  79   FatTreeLink(sg_platf_cluster_cbarg_t cluster, FatTreeNode *source,
  80               FatTreeNode *destination);
  81   /** Link going up in the tree
  82    */
  83   Link *upLink;
  84   /** Link going down in the tree
  85    */
  86   Link *downLink;
  87   /** Upper end of the link
  88    */
  89   FatTreeNode *upNode;
  90   /** Lower end of the link
  91    */
  92   FatTreeNode *downNode;
  93 };
  94
  95
  96 /** \brief Fat tree representation and routing.
  97  *
  98  * Generate fat trees according to the topology asked for. Almost everything
  99  * is based on the work of Eitan Zahavi in "D-Mod-K Routing Providing
 100  * Non-Blocking Traffic for Shift Permutations on Real Life Fat Trees" (2010).
 101  *
 102  * The exact topology is described in the mandatory topo_parameters
 103  * field, and follow the "h ; m_h, ..., m_1 ; w_h, ..., w_1 ; p_h, ..., p_1" format.
 104  * h stands for the switches levels number, i.e. the fat tree is of height h,
 105  * without the processing nodes. m_i stands for the number of lower level nodes
 106  * connected to a node in level i. w_i stands for the number of upper levels
 107  * nodes connected to a node in level i-1. p_i stands for the number of
 108  * parallel links connecting two nodes between level i and i - 1. Level h is
 109  * the topmost switch level, level 1 is the lowest switch level, and level 0
 110  * represents the processing nodes. The number of provided nodes must be exactly
 111  * the number of processing nodes required to fit the topology, which is the
 112  * product of the m_i's.
 113  *
 114  * Routing is made using a destination-mod-k scheme.
 115  */
 116 class XBT_PRIVATE AsClusterFatTree : public AsCluster {
 117 public:
 118   AsClusterFatTree();
 119   ~AsClusterFatTree();
 120   virtual void getRouteAndLatency(RoutingEdge *src, RoutingEdge *dst,
 121                                   sg_platf_route_cbarg_t into,
 122                                   double *latency);
 123
 124   /** \brief Generate the fat tree
 125    *
 126    * Once all processing nodes have been added, this will make sure the fat
 127    * tree is generated by calling generateLabels(), generateSwitches() and
 128    * then connection all nodes between them, using their label.
 129    */
 130   virtual void create_links();
 131   /** \brief Read the parameters in topo_parameters field.
 132    *
 133    * It will also store the cluster for future use.
 134    */
 135   void parse_specific_arguments(sg_platf_cluster_cbarg_t cluster);
 136   /** \brief Add a processing node.
 137    */
 138   void addProcessingNode(int id);
 139   void generateDotFile(const std::string& filename = "fatTree.dot") const;
 140
 141 private:
 142
 143   //description of a PGFT (TODO : better doc)
 144   unsigned int levels;
 145   std::vector<unsigned int> lowerLevelNodesNumber; // number of children by node
 146   std::vector<unsigned int> upperLevelNodesNumber; // number of parents by node
 147   std::vector<unsigned int> lowerLevelPortsNumber; // ports between each level l and l-1
 148
 149   std::map<int, FatTreeNode*> computeNodes;
 150   std::vector<FatTreeNode*> nodes;
 151   std::vector<FatTreeLink*> links;
 152   std::vector<unsigned int> nodesByLevel;
 153
 154   sg_platf_cluster_cbarg_t cluster;
 155
 156   void addLink(FatTreeNode *parent, unsigned int parentPort,
 157                FatTreeNode *child, unsigned int childPort);
 158   int getLevelPosition(const unsigned int level);
 159   void generateLabels();
 160   void generateSwitches();
 161   int connectNodeToParents(FatTreeNode *node);
 162   bool areRelated(FatTreeNode *parent, FatTreeNode *child);
 163   bool isInSubTree(FatTreeNode *root, FatTreeNode *node);
 164 };
 165 #endif