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;

--- 13 unchanged lines hidden (view full) ---

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 "mem/protocol/MessageSizeType.hh"
44#include "mem/ruby/common/Global.hh"
45#include "mem/ruby/system/NodeID.hh"
46#include "mem/ruby/system/System.hh"
47#include "params/RubyNetwork.hh"
48#include "sim/sim_object.hh"
49
50class NetDest;
51class MessageBuffer;
52class Throttle;
53class Topology;
54
55class Network : public SimObject
56{
57 public:
58 typedef RubyNetworkParams Params;
59 Network(const Params *p);
60 virtual ~Network() {}
61
62 virtual void init();
63
64 int getBufferSize() { return m_buffer_size; }
65 int getNumberOfVirtualNetworks() { return m_virtual_networks; }
66 int getEndpointBandwidth() { return m_endpoint_bandwidth; }
67 bool getAdaptiveRouting() {return m_adaptive_routing; }
68 int getLinkLatency() { return m_link_latency; }
69 int MessageSizeType_to_int(MessageSizeType size_type);
70
71 // returns the queue requested for the given component
72 virtual MessageBuffer* getToNetQueue(NodeID id, bool ordered,
73 int netNumber) = 0;
74 virtual MessageBuffer* getFromNetQueue(NodeID id, bool ordered,
75 int netNumber) = 0;
76 virtual const Vector<Throttle*>* getThrottles(NodeID id) const;
77 virtual int getNumNodes() {return 1;}
78
79 virtual void makeOutLink(SwitchID src, NodeID dest,
80 const NetDest& routing_table_entry, int link_latency, int link_weight,
81 int bw_multiplier, bool isReconfiguration) = 0;
82 virtual void makeInLink(SwitchID src, NodeID dest,
83 const NetDest& routing_table_entry, int link_latency,
84 int bw_multiplier, bool isReconfiguration) = 0;
85 virtual void makeInternalLink(SwitchID src, NodeID dest,
86 const NetDest& routing_table_entry, int link_latency, int link_weight,
87 int bw_multiplier, bool isReconfiguration) = 0;
88
89 virtual void reset() = 0;
90
91 virtual void printStats(ostream& out) const = 0;
92 virtual void clearStats() = 0;
93 virtual void printConfig(ostream& out) const = 0;
94 virtual void print(ostream& out) const = 0;
95
96 protected:
97 // Private copy constructor and assignment operator
98 Network(const Network& obj);
99 Network& operator=(const Network& obj);
100
101 protected:
102 const string m_name;
103 int m_nodes;
104 int m_virtual_networks;
105 int m_buffer_size;
106 int m_endpoint_bandwidth;
107 Topology* m_topology_ptr;
108 bool m_adaptive_routing;
109 int m_link_latency;
110 int m_control_msg_size;
111 int m_data_msg_size;
112};
113
114inline ostream&
115operator<<(ostream& out, const Network& obj)
116{
117 obj.print(out);
118 out << flush;
119 return out;
120}
121
122#endif // __MEM_RUBY_NETWORK_NETWORK_HH__