1/*
2 * Copyright (c) 2012 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder. You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
15 * Copyright (c) 2009 Advanced Micro Devices, Inc.
16 * All rights reserved.
17 *
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions are
20 * met: redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer;
22 * redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in the
24 * documentation and/or other materials provided with the distribution;
25 * neither the name of the copyright holders nor the names of its
26 * contributors may be used to endorse or promote products derived from
27 * this software without specific prior written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
30 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
31 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
32 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
33 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
34 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
35 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
36 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
37 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
39 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 */
41
42#include "base/misc.hh"
43#include "cpu/testers/rubytest/Check.hh"
44#include "cpu/testers/rubytest/RubyTester.hh"
45#include "debug/RubyTest.hh"
46#include "mem/ruby/common/Global.hh"
47#include "mem/ruby/common/SubBlock.hh"
48#include "mem/ruby/eventqueue/RubyEventQueue.hh"
49#include "mem/ruby/system/System.hh"
50#include "sim/sim_exit.hh"
51#include "sim/system.hh"
52
53RubyTester::RubyTester(const Params *p)
54 : MemObject(p), checkStartEvent(this),
55 _masterId(p->system->getMasterId(name())),
56 m_checks_to_complete(p->checks_to_complete),
57 m_deadlock_threshold(p->deadlock_threshold),
58 m_wakeup_frequency(p->wakeup_frequency),
59 m_check_flush(p->check_flush)
60{
61 m_checks_completed = 0;
62
63 // create the ports
64 for (int i = 0; i < p->port_cpuPort_connection_count; ++i) {
65 ports.push_back(new CpuPort(csprintf("%s-port%d", name(), i),
66 this, i));
67 }
68
69 // add the check start event to the event queue
70 schedule(checkStartEvent, 1);
71}
72
73RubyTester::~RubyTester()
74{
75 delete m_checkTable_ptr;
76 for (int i = 0; i < ports.size(); i++)
77 delete ports[i];
78}
79
80void
81RubyTester::init()
82{
83 assert(ports.size() > 0);
84
85 m_last_progress_vector.resize(ports.size());
86 for (int i = 0; i < m_last_progress_vector.size(); i++) {
87 m_last_progress_vector[i] = 0;
88 }
89
90 m_num_cpu_sequencers = ports.size();
91
92 m_checkTable_ptr = new CheckTable(m_num_cpu_sequencers, this);
93}
94
95MasterPort &
96RubyTester::getMasterPort(const std::string &if_name, int idx)
97{
98 if (if_name != "cpuPort") {
99 // pass it along to our super class
100 return MemObject::getMasterPort(if_name, idx);
101 } else {
102 if (idx >= static_cast<int>(ports.size())) {
103 panic("RubyTester::getMasterPort: unknown index %d\n", idx);
104 }
105
106 return *ports[idx];
107 }
108}
109
110Tick
111RubyTester::CpuPort::recvAtomic(PacketPtr pkt)
112{
113 panic("RubyTester::CpuPort::recvAtomic() not implemented!\n");
114 return 0;
115}
116
117bool
118RubyTester::CpuPort::recvTiming(PacketPtr pkt)
119{
120 // retrieve the subblock and call hitCallback
121 RubyTester::SenderState* senderState =
122 safe_cast<RubyTester::SenderState*>(pkt->senderState);
123 SubBlock* subblock = senderState->subBlock;
124 assert(subblock != NULL);
125
126 // pop the sender state from the packet
127 pkt->senderState = senderState->saved;
128
129 tester->hitCallback(idx, subblock);
130
131 // Now that the tester has completed, delete the senderState
132 // (includes sublock) and the packet, then return
133 delete senderState;
134 delete pkt->req;
135 delete pkt;
136 return true;
137}
138
139MasterPort*
140RubyTester::getCpuPort(int idx)
141{
142 assert(idx >= 0 && idx < ports.size());
143
144 return ports[idx];
145}
146
147void
148RubyTester::hitCallback(NodeID proc, SubBlock* data)
149{
150 // Mark that we made progress
151 m_last_progress_vector[proc] = g_eventQueue_ptr->getTime();
152
153 DPRINTF(RubyTest, "completed request for proc: %d\n", proc);
154 DPRINTF(RubyTest, "addr: 0x%x, size: %d, data: ",
155 data->getAddress(), data->getSize());
156 for (int byte = 0; byte < data->getSize(); byte++) {
157 DPRINTF(RubyTest, "%d", data->getByte(byte));
158 }
159 DPRINTF(RubyTest, "\n");
160
161 // This tells us our store has 'completed' or for a load gives us
162 // back the data to make the check
163 Check* check_ptr = m_checkTable_ptr->getCheck(data->getAddress());
164 assert(check_ptr != NULL);
165 check_ptr->performCallback(proc, data);
166}
167
168void
169RubyTester::wakeup()
170{
171 if (m_checks_completed < m_checks_to_complete) {
172 // Try to perform an action or check
173 Check* check_ptr = m_checkTable_ptr->getRandomCheck();
174 assert(check_ptr != NULL);
175 check_ptr->initiate();
176
177 checkForDeadlock();
178
179 schedule(checkStartEvent, curTick() + m_wakeup_frequency);
180 } else {
181 exitSimLoop("Ruby Tester completed");
182 }
183}
184
185void
186RubyTester::checkForDeadlock()
187{
188 int size = m_last_progress_vector.size();
189 Time current_time = g_eventQueue_ptr->getTime();
190 for (int processor = 0; processor < size; processor++) {
191 if ((current_time - m_last_progress_vector[processor]) >
192 m_deadlock_threshold) {
193 panic("Deadlock detected: current_time: %d last_progress_time: %d "
194 "difference: %d processor: %d\n",
195 current_time, m_last_progress_vector[processor],
196 current_time - m_last_progress_vector[processor], processor);
197 }
198 }
199}
200
201void
202RubyTester::print(std::ostream& out) const
203{
204 out << "[RubyTester]" << std::endl;
205}
206
207RubyTester *
208RubyTesterParams::create()
209{
210 return new RubyTester(this);
211}