Network.hh revision 8257 
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 Network class is the base class for classes that implement the
31 * interconnection network between components (processor/cache
32 * components and memory/directory components).  The interconnection
33 * network as described here is not a physical network, but a
34 * programming concept used to implement all communication between
35 * components.  Thus parts of this 'network' will model the on-chip
36 * connections between cache controllers and directory controllers as
37 * well as the links between chip and network switches.
38 */
39
40#ifndef __MEM_RUBY_NETWORK_NETWORK_HH__
41#define __MEM_RUBY_NETWORK_NETWORK_HH__
42
43#include <iostream>
44#include <string>
45#include <vector>
46
47#include "mem/protocol/LinkDirection.hh"
48#include "mem/protocol/MessageSizeType.hh"
49#include "mem/ruby/common/Global.hh"
50#include "mem/ruby/system/NodeID.hh"
51#include "mem/ruby/system/System.hh"
52#include "params/RubyNetwork.hh"
53#include "sim/sim_object.hh"
54
55class NetDest;
56class MessageBuffer;
57class Throttle;
58class Topology;
59
60class Network : public SimObject
61{
62  public:
63    typedef RubyNetworkParams Params;
64    Network(const Params *p);
65    virtual ~Network() {}
66
67    virtual void init();
68
69    int getBufferSize() { return m_buffer_size; }
70    int getNumberOfVirtualNetworks() { return m_virtual_networks; }
71    int getEndpointBandwidth() { return m_endpoint_bandwidth; }
72    bool getAdaptiveRouting() {return m_adaptive_routing; }
73    int getLinkLatency() { return m_link_latency; }
74    int MessageSizeType_to_int(MessageSizeType size_type);
75
76    // returns the queue requested for the given component
77    virtual MessageBuffer* getToNetQueue(NodeID id, bool ordered,
78        int netNumber) = 0;
79    virtual MessageBuffer* getFromNetQueue(NodeID id, bool ordered,
80        int netNumber) = 0;
81    virtual const std::vector<Throttle*>* getThrottles(NodeID id) const;
82    virtual int getNumNodes() {return 1;}
83
84    virtual void makeOutLink(SwitchID src, NodeID dest, BasicLink* link,
85                             LinkDirection direction,
86                             const NetDest& routing_table_entry,
87                             bool isReconfiguration) = 0;
88    virtual void makeInLink(NodeID src, SwitchID dest, BasicLink* link,
89                            LinkDirection direction,
90                            const NetDest& routing_table_entry,
91                            bool isReconfiguration) = 0;
92    virtual void makeInternalLink(SwitchID src, SwitchID dest, BasicLink* link,
93                                  LinkDirection direction,
94                                  const NetDest& routing_table_entry,
95                                  bool isReconfiguration) = 0;
96
97    virtual void reset() = 0;
98
99    virtual void printStats(std::ostream& out) const = 0;
100    virtual void clearStats() = 0;
101    virtual void printConfig(std::ostream& out) const = 0;
102    virtual void print(std::ostream& out) const = 0;
103
104  protected:
105    // Private copy constructor and assignment operator
106    Network(const Network& obj);
107    Network& operator=(const Network& obj);
108
109  protected:
110    const std::string m_name;
111    int m_nodes;
112    int m_virtual_networks;
113    int m_buffer_size;
114    int m_endpoint_bandwidth;
115    Topology* m_topology_ptr;
116    bool m_adaptive_routing;
117    int m_link_latency;
118    int m_control_msg_size;
119    int m_data_msg_size;
120};
121
122inline std::ostream&
123operator<<(std::ostream& out, const Network& obj)
124{
125    obj.print(out);
126    out << std::flush;
127    return out;
128}
129
130#endif // __MEM_RUBY_NETWORK_NETWORK_HH__
131