src/mem/ruby/network/garnet2.0/RoutingUnit.hh

   1 /*
   2  * Copyright (c) 2008 Princeton University
   3  * Copyright (c) 2016 Georgia Institute of Technology
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions are
   8  * met: redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer;
  10  * redistributions in binary form must reproduce the above copyright
  11  * notice, this list of conditions and the following disclaimer in the
  12  * documentation and/or other materials provided with the distribution;
  13  * neither the name of the copyright holders nor the names of its
  14  * contributors may be used to endorse or promote products derived from
  15  * this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30
  31 #ifndef __MEM_RUBY_NETWORK_GARNET2_0_ROUTINGUNIT_HH__
  32 #define __MEM_RUBY_NETWORK_GARNET2_0_ROUTINGUNIT_HH__
  33
  34 #include "mem/ruby/common/Consumer.hh"
  35 #include "mem/ruby/common/NetDest.hh"
  36 #include "mem/ruby/network/garnet2.0/CommonTypes.hh"
  37 #include "mem/ruby/network/garnet2.0/GarnetNetwork.hh"
  38 #include "mem/ruby/network/garnet2.0/flit.hh"
  39
  40 class InputUnit;
  41 class Router;
  42
  43 class RoutingUnit
  44 {
  45   public:
  46     RoutingUnit(Router *router);
  47     int outportCompute(RouteInfo route,
  48                       int inport,
  49                       PortDirection inport_dirn);
  50
  51     // Topology-agnostic Routing Table based routing (default)
  52     void addRoute(std::vector<NetDest>& routing_table_entry);
  53     void addWeight(int link_weight);
  54
  55     // get output port from routing table
  56     int  lookupRoutingTable(int vnet, NetDest net_dest);
  57
  58     // Topology-specific direction based routing
  59     void addInDirection(PortDirection inport_dirn, int inport);
  60     void addOutDirection(PortDirection outport_dirn, int outport);
  61
  62     // Routing for Mesh
  63     int outportComputeXY(RouteInfo route,
  64                          int inport,
  65                          PortDirection inport_dirn);
  66
  67     // Custom Routing Algorithm using Port Directions
  68     int outportComputeCustom(RouteInfo route,
  69                              int inport,
  70                              PortDirection inport_dirn);
  71
  72     // Returns true if vnet is present in the vector
  73     // of vnets or if the vector supports all vnets.
  74     bool supportsVnet(int vnet, std::vector<int> sVnets);
  75
  76
  77   private:
  78     Router *m_router;
  79
  80     // Routing Table
  81     std::vector<std::vector<NetDest>> m_routing_table;
  82     std::vector<int> m_weight_table;
  83
  84     // Inport and Outport direction to idx maps
  85     std::map<PortDirection, int> m_inports_dirn2idx;
  86     std::map<int, PortDirection> m_inports_idx2dirn;
  87     std::map<int, PortDirection> m_outports_idx2dirn;
  88     std::map<PortDirection, int> m_outports_dirn2idx;
  89 };
  90
  91 #endif // __MEM_RUBY_NETWORK_GARNET2_0_ROUTINGUNIT_HH__