1/*
2 * Copyright (c) 2009 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#ifndef __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__
30#define __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__
31
32#include <iostream>
33#include <string>
34
35#include "base/callback.hh"
36#include "mem/protocol/AccessPermission.hh"
37#include "mem/ruby/buffers/MessageBuffer.hh"
38#include "mem/ruby/common/Address.hh"
39#include "mem/ruby/common/Consumer.hh"
40#include "mem/ruby/common/DataBlock.hh"
41#include "mem/ruby/common/Histogram.hh"
42#include "mem/ruby/network/Network.hh"
43#include "mem/ruby/recorder/CacheRecorder.hh"
44#include "mem/ruby/system/MachineID.hh"
45#include "mem/packet.hh"
46#include "params/RubyController.hh"
47#include "sim/clocked_object.hh"
48
49class Network;
50
51class AbstractController : public ClockedObject, public Consumer
52{
53 public:
54 typedef RubyControllerParams Params;
55 AbstractController(const Params *p);
56 void init();
57 const Params *params() const { return (const Params *)_params; }
58
59 const NodeID getVersion() const { return m_machineID.getNum(); }
60 const MachineType getType() const { return m_machineID.getType(); }
61
62 void initNetworkPtr(Network* net_ptr) { m_net_ptr = net_ptr; }
63
64 // return instance name
65 void blockOnQueue(Address, MessageBuffer*);
66 void unblock(Address);
67
68 virtual MessageBuffer* getMandatoryQueue() const = 0;
69 virtual const std::string toString() const = 0; // returns text version of
70 // controller type
71 virtual AccessPermission getAccessPermission(const Address& addr) = 0;
72 virtual DataBlock& getDataBlock(const Address& addr) = 0;
73
74 virtual void print(std::ostream & out) const = 0;
75 virtual void wakeup() = 0;
76 virtual void resetStats() = 0;
77 virtual void regStats();
78
79 virtual void recordCacheTrace(int cntrl, CacheRecorder* tr) = 0;
80 virtual Sequencer* getSequencer() const = 0;
81
82 //! These functions are used by ruby system to read/write the message
83 //! queues that exist with in the controller.
84 //! The boolean return value indicates if the read was performed
85 //! successfully.
86 virtual bool functionalReadBuffers(PacketPtr&) = 0;
87 //! The return value indicates the number of messages written with the
88 //! data from the packet.
89 virtual uint32_t functionalWriteBuffers(PacketPtr&) = 0;
90
91 //! Function for enqueuing a prefetch request
92 virtual void enqueuePrefetch(const Address&, const RubyRequestType&)
93 { fatal("Prefetches not implemented!");}
94
95 //! Function for collating statistics from all the controllers of this
96 //! particular type. This function should only be called from the
97 //! version 0 of this controller type.
98 virtual void collateStats()
99 {fatal("collateStats() should be overridden!");}
100
101 public:
102 MachineID getMachineID() const { return m_machineID; }
103
104 Stats::Histogram& getDelayHist() { return m_delayHistogram; }
105 Stats::Histogram& getDelayVCHist(uint32_t index)
106 { return *(m_delayVCHistogram[index]); }
107
108 MessageBuffer *getPeerQueue(uint32_t pid)
109 {
110 std::map<uint32_t, MessageBuffer *>::iterator it =
111 peerQueueMap.find(pid);
112 assert(it != peerQueueMap.end());
113 return (*it).second;
114 }
115
116 protected:
117 //! Profiles original cache requests including PUTs
118 void profileRequest(const std::string &request);
119 //! Profiles the delay associated with messages.
120 void profileMsgDelay(uint32_t virtualNetwork, Cycles delay);
121
122 //! Function for connecting peer controllers
123 void connectWithPeer(AbstractController *);
124 virtual void getQueuesFromPeer(AbstractController *)
125 { fatal("getQueuesFromPeer() should be called only if implemented!"); }
126
127 void stallBuffer(MessageBuffer* buf, Address addr);
128 void wakeUpBuffers(Address addr);
129 void wakeUpAllBuffers(Address addr);
130 void wakeUpAllBuffers();
131
132 protected:
133 NodeID m_version;
134 MachineID m_machineID;
135 NodeID m_clusterID;
136
137 Network* m_net_ptr;
138 bool m_is_blocking;
139 std::map<Address, MessageBuffer*> m_block_map;
140
141 typedef std::vector<MessageBuffer*> MsgVecType;
142 typedef std::map< Address, MsgVecType* > WaitingBufType;
143 WaitingBufType m_waiting_buffers;
144
145 unsigned int m_in_ports;
146 unsigned int m_cur_in_port;
147 int m_number_of_TBEs;
148 int m_transitions_per_cycle;
| 1/*
2 * Copyright (c) 2009 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#ifndef __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__
30#define __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__
31
32#include <iostream>
33#include <string>
34
35#include "base/callback.hh"
36#include "mem/protocol/AccessPermission.hh"
37#include "mem/ruby/buffers/MessageBuffer.hh"
38#include "mem/ruby/common/Address.hh"
39#include "mem/ruby/common/Consumer.hh"
40#include "mem/ruby/common/DataBlock.hh"
41#include "mem/ruby/common/Histogram.hh"
42#include "mem/ruby/network/Network.hh"
43#include "mem/ruby/recorder/CacheRecorder.hh"
44#include "mem/ruby/system/MachineID.hh"
45#include "mem/packet.hh"
46#include "params/RubyController.hh"
47#include "sim/clocked_object.hh"
48
49class Network;
50
51class AbstractController : public ClockedObject, public Consumer
52{
53 public:
54 typedef RubyControllerParams Params;
55 AbstractController(const Params *p);
56 void init();
57 const Params *params() const { return (const Params *)_params; }
58
59 const NodeID getVersion() const { return m_machineID.getNum(); }
60 const MachineType getType() const { return m_machineID.getType(); }
61
62 void initNetworkPtr(Network* net_ptr) { m_net_ptr = net_ptr; }
63
64 // return instance name
65 void blockOnQueue(Address, MessageBuffer*);
66 void unblock(Address);
67
68 virtual MessageBuffer* getMandatoryQueue() const = 0;
69 virtual const std::string toString() const = 0; // returns text version of
70 // controller type
71 virtual AccessPermission getAccessPermission(const Address& addr) = 0;
72 virtual DataBlock& getDataBlock(const Address& addr) = 0;
73
74 virtual void print(std::ostream & out) const = 0;
75 virtual void wakeup() = 0;
76 virtual void resetStats() = 0;
77 virtual void regStats();
78
79 virtual void recordCacheTrace(int cntrl, CacheRecorder* tr) = 0;
80 virtual Sequencer* getSequencer() const = 0;
81
82 //! These functions are used by ruby system to read/write the message
83 //! queues that exist with in the controller.
84 //! The boolean return value indicates if the read was performed
85 //! successfully.
86 virtual bool functionalReadBuffers(PacketPtr&) = 0;
87 //! The return value indicates the number of messages written with the
88 //! data from the packet.
89 virtual uint32_t functionalWriteBuffers(PacketPtr&) = 0;
90
91 //! Function for enqueuing a prefetch request
92 virtual void enqueuePrefetch(const Address&, const RubyRequestType&)
93 { fatal("Prefetches not implemented!");}
94
95 //! Function for collating statistics from all the controllers of this
96 //! particular type. This function should only be called from the
97 //! version 0 of this controller type.
98 virtual void collateStats()
99 {fatal("collateStats() should be overridden!");}
100
101 public:
102 MachineID getMachineID() const { return m_machineID; }
103
104 Stats::Histogram& getDelayHist() { return m_delayHistogram; }
105 Stats::Histogram& getDelayVCHist(uint32_t index)
106 { return *(m_delayVCHistogram[index]); }
107
108 MessageBuffer *getPeerQueue(uint32_t pid)
109 {
110 std::map<uint32_t, MessageBuffer *>::iterator it =
111 peerQueueMap.find(pid);
112 assert(it != peerQueueMap.end());
113 return (*it).second;
114 }
115
116 protected:
117 //! Profiles original cache requests including PUTs
118 void profileRequest(const std::string &request);
119 //! Profiles the delay associated with messages.
120 void profileMsgDelay(uint32_t virtualNetwork, Cycles delay);
121
122 //! Function for connecting peer controllers
123 void connectWithPeer(AbstractController *);
124 virtual void getQueuesFromPeer(AbstractController *)
125 { fatal("getQueuesFromPeer() should be called only if implemented!"); }
126
127 void stallBuffer(MessageBuffer* buf, Address addr);
128 void wakeUpBuffers(Address addr);
129 void wakeUpAllBuffers(Address addr);
130 void wakeUpAllBuffers();
131
132 protected:
133 NodeID m_version;
134 MachineID m_machineID;
135 NodeID m_clusterID;
136
137 Network* m_net_ptr;
138 bool m_is_blocking;
139 std::map<Address, MessageBuffer*> m_block_map;
140
141 typedef std::vector<MessageBuffer*> MsgVecType;
142 typedef std::map< Address, MsgVecType* > WaitingBufType;
143 WaitingBufType m_waiting_buffers;
144
145 unsigned int m_in_ports;
146 unsigned int m_cur_in_port;
147 int m_number_of_TBEs;
148 int m_transitions_per_cycle;
|