Topology.hh revision 11096:efaacec43726 
1/*
2 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/*
30 * The topology here is configurable; it can be a hierachical (default
31 * one) or a 2D torus or a 2D torus with half switches killed. I think
32 * all input port has a one-input-one-output switch connected just to
33 * control and bandwidth, since we don't control bandwidth on input
34 * ports.  Basically, the class has a vector of nodes and edges. First
35 * 2*m_nodes elements in the node vector are input and output
36 * ports. Edges are represented in two vectors of src and dest
37 * nodes. All edges have latency.
38 */
39
40#ifndef __MEM_RUBY_NETWORK_TOPOLOGY_HH__
41#define __MEM_RUBY_NETWORK_TOPOLOGY_HH__
42
43#include <iostream>
44#include <string>
45#include <vector>
46
47#include "mem/protocol/LinkDirection.hh"
48#include "mem/ruby/common/TypeDefines.hh"
49#include "mem/ruby/network/BasicLink.hh"
50
51class NetDest;
52class Network;
53
54typedef std::vector<std::vector<int> > Matrix;
55
56struct LinkEntry
57{
58    BasicLink *link;
59    LinkDirection direction;
60};
61
62typedef std::map<std::pair<SwitchID, SwitchID>, LinkEntry> LinkMap;
63
64class Topology
65{
66  public:
67    Topology(uint32_t num_routers, const std::vector<BasicExtLink *> &ext_links,
68             const std::vector<BasicIntLink *> &int_links);
69
70    uint32_t numSwitches() const { return m_number_of_switches; }
71    void createLinks(Network *net);
72    void print(std::ostream& out) const { out << "[Topology]"; }
73
74  private:
75    void addLink(SwitchID src, SwitchID dest, BasicLink* link,
76                 LinkDirection dir);
77    void makeLink(Network *net, SwitchID src, SwitchID dest,
78                  const NetDest& routing_table_entry);
79
80    // Helper functions based on chapter 29 of Cormen et al.
81    void extend_shortest_path(Matrix &current_dist, Matrix &latencies,
82                              Matrix &inter_switches);
83
84    std::vector<std::vector<int>> shortest_path(const Matrix &weights,
85            Matrix &latencies, Matrix &inter_switches);
86
87    bool link_is_shortest_path_to_node(SwitchID src, SwitchID next,
88            SwitchID final, const Matrix &weights, const Matrix &dist);
89
90    NetDest shortest_path_to_node(SwitchID src, SwitchID next,
91                                  const Matrix &weights, const Matrix &dist);
92
93    const uint32_t m_nodes;
94    const uint32_t m_number_of_switches;
95
96    std::vector<BasicExtLink*> m_ext_link_vector;
97    std::vector<BasicIntLink*> m_int_link_vector;
98
99    LinkMap m_link_map;
100};
101
102inline std::ostream&
103operator<<(std::ostream& out, const Topology& obj)
104{
105    obj.print(out);
106    out << std::flush;
107    return out;
108}
109
110#endif // __MEM_RUBY_NETWORK_TOPOLOGY_HH__
111