1/*
2 * Copyright (c) 2011 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) 2006 The Regents of The University of Michigan
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Kevin Lim
41 * Geoffrey Blake
42 */
43
44#include <list>
45#include <string>
46
47#include "arch/kernel_stats.hh"
48#include "arch/vtophys.hh"
49#include "cpu/checker/cpu.hh"
50#include "cpu/base.hh"
51#include "cpu/simple_thread.hh"
52#include "cpu/static_inst.hh"
53#include "cpu/thread_context.hh"
54#include "params/CheckerCPU.hh"
55#include "sim/full_system.hh"
56#include "sim/tlb.hh"
57
58using namespace std;
59using namespace TheISA;
60
61void
62CheckerCPU::init()
63{
64 masterId = systemPtr->getMasterId(name());
65}
66
67CheckerCPU::CheckerCPU(Params *p)
68 : BaseCPU(p, true), thread(NULL), tc(NULL)
69{
70 memReq = NULL;
71 curStaticInst = NULL;
72 curMacroStaticInst = NULL;
73
74 numInst = 0;
75 startNumInst = 0;
76 numLoad = 0;
77 startNumLoad = 0;
78 youngestSN = 0;
79
80 changedPC = willChangePC = changedNextPC = false;
81
82 exitOnError = p->exitOnError;
83 warnOnlyOnLoadError = p->warnOnlyOnLoadError;
84 itb = p->itb;
85 dtb = p->dtb;
86 systemPtr = NULL;
87 workload = p->workload;
88 thread = NULL;
89
90 updateOnError = true;
91}
92
93CheckerCPU::~CheckerCPU()
94{
95}
96
97void
98CheckerCPU::setSystem(System *system)
99{
100 systemPtr = system;
101
102 if (FullSystem) {
103 thread = new SimpleThread(this, 0, systemPtr, itb, dtb, false);
104 } else {
105 thread = new SimpleThread(this, 0, systemPtr,
106 workload.size() ? workload[0] : NULL,
107 itb, dtb);
108 }
109
110 tc = thread->getTC();
111 threadContexts.push_back(tc);
112 thread->kernelStats = NULL;
113 // Thread should never be null after this
114 assert(thread != NULL);
115}
116
117void
118CheckerCPU::setIcachePort(CpuPort *icache_port)
119{
120 icachePort = icache_port;
121}
122
123void
124CheckerCPU::setDcachePort(CpuPort *dcache_port)
125{
126 dcachePort = dcache_port;
127}
128
129void
130CheckerCPU::serialize(ostream &os)
131{
132}
133
134void
135CheckerCPU::unserialize(Checkpoint *cp, const string &section)
136{
137}
138
139Fault
140CheckerCPU::readMem(Addr addr, uint8_t *data, unsigned size, unsigned flags)
141{
142 Fault fault = NoFault;
143 unsigned blockSize = dcachePort->peerBlockSize();
144 int fullSize = size;
145 Addr secondAddr = roundDown(addr + size - 1, blockSize);
146 bool checked_flags = false;
147 bool flags_match = true;
148 Addr pAddr = 0x0;
149
150
151 if (secondAddr > addr)
152 size = secondAddr - addr;
153
154 // Need to account for multiple accesses like the Atomic and TimingSimple
155 while (1) {
156 memReq = new Request();
157 memReq->setVirt(0, addr, size, flags, masterId, thread->pcState().instAddr());
158
159 // translate to physical address
160 fault = dtb->translateFunctional(memReq, tc, BaseTLB::Read);
161
162 if (!checked_flags && fault == NoFault && unverifiedReq) {
163 flags_match = checkFlags(unverifiedReq, memReq->getVaddr(),
164 memReq->getPaddr(), memReq->getFlags());
165 pAddr = memReq->getPaddr();
166 checked_flags = true;
167 }
168
169 // Now do the access
170 if (fault == NoFault &&
171 !memReq->getFlags().isSet(Request::NO_ACCESS)) {
172 PacketPtr pkt = new Packet(memReq,
173 memReq->isLLSC() ?
174 MemCmd::LoadLockedReq :
175 MemCmd::ReadReq);
176
177 pkt->dataStatic(data);
178
179 if (!(memReq->isUncacheable() || memReq->isMmappedIpr())) {
180 // Access memory to see if we have the same data
181 dcachePort->sendFunctional(pkt);
182 } else {
183 // Assume the data is correct if it's an uncached access
184 memcpy(data, unverifiedMemData, size);
185 }
186
187 delete memReq;
188 memReq = NULL;
189 delete pkt;
190 }
191
192 if (fault != NoFault) {
193 if (memReq->isPrefetch()) {
194 fault = NoFault;
195 }
196 delete memReq;
197 memReq = NULL;
198 break;
199 }
200
201 if (memReq != NULL) {
202 delete memReq;
203 }
204
205 //If we don't need to access a second cache line, stop now.
206 if (secondAddr <= addr)
207 {
208 break;
209 }
210
211 // Setup for accessing next cache line
212 data += size;
213 unverifiedMemData += size;
214 size = addr + fullSize - secondAddr;
215 addr = secondAddr;
216 }
217
218 if (!flags_match) {
219 warn("%lli: Flags do not match CPU:%#x %#x %#x Checker:%#x %#x %#x\n",
220 curTick(), unverifiedReq->getVaddr(), unverifiedReq->getPaddr(),
221 unverifiedReq->getFlags(), addr, pAddr, flags);
222 handleError();
223 }
224
225 return fault;
226}
227
228Fault
229CheckerCPU::writeMem(uint8_t *data, unsigned size,
230 Addr addr, unsigned flags, uint64_t *res)
231{
232 Fault fault = NoFault;
233 bool checked_flags = false;
234 bool flags_match = true;
235 Addr pAddr = 0x0;
236
237 unsigned blockSize = dcachePort->peerBlockSize();
238 int fullSize = size;
239
240 Addr secondAddr = roundDown(addr + size - 1, blockSize);
241
242 if (secondAddr > addr)
243 size = secondAddr - addr;
244
245 // Need to account for a multiple access like Atomic and Timing CPUs
246 while (1) {
247 memReq = new Request();
248 memReq->setVirt(0, addr, size, flags, masterId, thread->pcState().instAddr());
249
250 // translate to physical address
251 fault = dtb->translateFunctional(memReq, tc, BaseTLB::Write);
252
253 if (!checked_flags && fault == NoFault && unverifiedReq) {
254 flags_match = checkFlags(unverifiedReq, memReq->getVaddr(),
255 memReq->getPaddr(), memReq->getFlags());
256 pAddr = memReq->getPaddr();
257 checked_flags = true;
258 }
259
260 /*
261 * We don't actually check memory for the store because there
262 * is no guarantee it has left the lsq yet, and therefore we
263 * can't verify the memory on stores without lsq snooping
264 * enabled. This is left as future work for the Checker: LSQ snooping
265 * and memory validation after stores have committed.
266 */
267 bool was_prefetch = memReq->isPrefetch();
268
269 delete memReq;
270
271 //If we don't need to access a second cache line, stop now.
272 if (fault != NoFault || secondAddr <= addr)
273 {
274 if (fault != NoFault && was_prefetch) {
275 fault = NoFault;
276 }
277 break;
278 }
279
280 //Update size and access address
281 size = addr + fullSize - secondAddr;
282 //And access the right address.
283 addr = secondAddr;
284 }
285
286 if (!flags_match) {
287 warn("%lli: Flags do not match CPU:%#x %#x Checker:%#x %#x %#x\n",
288 curTick(), unverifiedReq->getVaddr(), unverifiedReq->getPaddr(),
289 unverifiedReq->getFlags(), addr, pAddr, flags);
290 handleError();
291 }
292
293 // Assume the result was the same as the one passed in. This checker
294 // doesn't check if the SC should succeed or fail, it just checks the
295 // value.
296 if (unverifiedReq && res && unverifiedReq->extraDataValid())
297 *res = unverifiedReq->getExtraData();
298
299 // Entire purpose here is to make sure we are getting the
300 // same data to send to the mem system as the CPU did.
301 // Cannot check this is actually what went to memory because
302 // there stores can be in ld/st queue or coherent operations
303 // overwriting values.
304 bool extraData;
305 if (unverifiedReq) {
306 extraData = unverifiedReq->extraDataValid() ?
307 unverifiedReq->getExtraData() : 1;
308 }
309
310 if (unverifiedReq && unverifiedMemData &&
311 memcmp(data, unverifiedMemData, fullSize) && extraData) {
312 warn("%lli: Store value does not match value sent to memory!\
313 data: %#x inst_data: %#x", curTick(), data,
314 unverifiedMemData);
315 handleError();
316 }
317
318 return fault;
319}
320
321Addr
322CheckerCPU::dbg_vtophys(Addr addr)
323{
324 return vtophys(tc, addr);
325}
326
327/**
328 * Checks if the flags set by the Checker and Checkee match.
329 */
330bool
331CheckerCPU::checkFlags(Request *unverified_req, Addr vAddr,
332 Addr pAddr, int flags)
333{
334 Addr unverifiedVAddr = unverified_req->getVaddr();
335 Addr unverifiedPAddr = unverified_req->getPaddr();
336 int unverifiedFlags = unverified_req->getFlags();
337
338 if (unverifiedVAddr != vAddr ||
339 unverifiedPAddr != pAddr ||
340 unverifiedFlags != flags) {
341 return false;
342 }
343
344 return true;
345}
346
347void
348CheckerCPU::dumpAndExit()
349{
350 warn("%lli: Checker PC:%s",
351 curTick(), thread->pcState());
352 panic("Checker found an error!");
353}