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