2 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
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.
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.
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.
40 #ifndef __MEM_RUBY_NETWORK_NETWORK_HH__
41 #define __MEM_RUBY_NETWORK_NETWORK_HH__
47 #include "mem/protocol/MessageSizeType.hh"
48 #include "mem/ruby/common/Global.hh"
49 #include "mem/ruby/system/NodeID.hh"
50 #include "mem/ruby/system/System.hh"
51 #include "params/RubyNetwork.hh"
52 #include "sim/sim_object.hh"
59 class Network : public SimObject
62 typedef RubyNetworkParams Params;
63 Network(const Params *p);
68 int getBufferSize() { return m_buffer_size; }
69 int getNumberOfVirtualNetworks() { return m_virtual_networks; }
70 int getEndpointBandwidth() { return m_endpoint_bandwidth; }
71 bool getAdaptiveRouting() {return m_adaptive_routing; }
72 int getLinkLatency() { return m_link_latency; }
73 int MessageSizeType_to_int(MessageSizeType size_type);
75 // returns the queue requested for the given component
76 virtual MessageBuffer* getToNetQueue(NodeID id, bool ordered,
78 virtual MessageBuffer* getFromNetQueue(NodeID id, bool ordered,
80 virtual const std::vector<Throttle*>* getThrottles(NodeID id) const;
81 virtual int getNumNodes() {return 1;}
83 virtual void makeOutLink(SwitchID src, NodeID dest,
84 const NetDest& routing_table_entry, int link_latency, int link_weight,
85 int bw_multiplier, bool isReconfiguration) = 0;
86 virtual void makeInLink(SwitchID src, NodeID dest,
87 const NetDest& routing_table_entry, int link_latency,
88 int bw_multiplier, bool isReconfiguration) = 0;
89 virtual void makeInternalLink(SwitchID src, NodeID dest,
90 const NetDest& routing_table_entry, int link_latency, int link_weight,
91 int bw_multiplier, bool isReconfiguration) = 0;
93 virtual void reset() = 0;
95 virtual void printStats(std::ostream& out) const = 0;
96 virtual void clearStats() = 0;
97 virtual void printConfig(std::ostream& out) const = 0;
98 virtual void print(std::ostream& out) const = 0;
101 // Private copy constructor and assignment operator
102 Network(const Network& obj);
103 Network& operator=(const Network& obj);
106 const std::string m_name;
108 int m_virtual_networks;
110 int m_endpoint_bandwidth;
111 Topology* m_topology_ptr;
112 bool m_adaptive_routing;
114 int m_control_msg_size;
119 operator<<(std::ostream& out, const Network& obj)
126 #endif // __MEM_RUBY_NETWORK_NETWORK_HH__