RoutingUnit.hh revision 11666:10d59d546ea2 
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 * Authors: Niket Agarwal
30 *          Tushar Krishna
31 */
32
33
34#ifndef __MEM_RUBY_NETWORK_GARNET_ROUTING_UNIT_HH__
35#define __MEM_RUBY_NETWORK_GARNET_ROUTING_UNIT_HH__
36
37#include "mem/ruby/common/Consumer.hh"
38#include "mem/ruby/common/NetDest.hh"
39#include "mem/ruby/network/garnet2.0/CommonTypes.hh"
40#include "mem/ruby/network/garnet2.0/GarnetNetwork.hh"
41#include "mem/ruby/network/garnet2.0/flit.hh"
42
43class InputUnit;
44class Router;
45
46class RoutingUnit
47{
48  public:
49    RoutingUnit(Router *router);
50    int outportCompute(RouteInfo route,
51                      int inport,
52                      PortDirection inport_dirn);
53
54    // Topology-agnostic Routing Table based routing (default)
55    void addRoute(const NetDest& routing_table_entry);
56    void addWeight(int link_weight);
57
58    // get output port from routing table
59    int  lookupRoutingTable(int vnet, NetDest net_dest);
60
61    // Topology-specific direction based routing
62    void addInDirection(PortDirection inport_dirn, int inport);
63    void addOutDirection(PortDirection outport_dirn, int outport);
64
65    // Routing for Mesh
66    int outportComputeXY(RouteInfo route,
67                         int inport,
68                         PortDirection inport_dirn);
69
70    // Custom Routing Algorithm using Port Directions
71    int outportComputeCustom(RouteInfo route,
72                             int inport,
73                             PortDirection inport_dirn);
74
75  private:
76    Router *m_router;
77
78    // Routing Table
79    std::vector<NetDest> m_routing_table;
80    std::vector<int> m_weight_table;
81
82    // Inport and Outport direction to idx maps
83    std::map<PortDirection, int> m_inports_dirn2idx;
84    std::map<int, PortDirection> m_inports_idx2dirn;
85    std::map<int, PortDirection> m_outports_idx2dirn;
86    std::map<PortDirection, int> m_outports_dirn2idx;
87};
88
89#endif // __MEM_RUBY_NETWORK_GARNET_ROUTING_UNIT_HH__
90