cpu.hh revision 9920
1/* 2 * Copyright (c) 2011 ARM Limited 3 * Copyright (c) 2013 Advanced Micro Devices, Inc. 4 * All rights reserved 5 * 6 * The license below extends only to copyright in the software and shall 7 * not be construed as granting a license to any other intellectual 8 * property including but not limited to intellectual property relating 9 * to a hardware implementation of the functionality of the software 10 * licensed hereunder. You may use the software subject to the license 11 * terms below provided that you ensure that this notice is replicated 12 * unmodified and in its entirety in all distributions of the software, 13 * modified or unmodified, in source code or in binary form. 14 * 15 * Copyright (c) 2006 The Regents of The University of Michigan 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 * Authors: Kevin Lim 42 */ 43 44#ifndef __CPU_CHECKER_CPU_HH__ 45#define __CPU_CHECKER_CPU_HH__ 46 47#include <list> 48#include <map> 49#include <queue> 50 51#include "arch/types.hh" 52#include "base/statistics.hh" 53#include "cpu/base.hh" 54#include "cpu/base_dyn_inst.hh" 55#include "cpu/pc_event.hh" 56#include "cpu/simple_thread.hh" 57#include "cpu/static_inst.hh" 58#include "debug/Checker.hh" 59#include "params/CheckerCPU.hh" 60#include "sim/eventq.hh" 61 62// forward declarations 63namespace TheISA 64{ 65 class TLB; 66} 67 68template <class> 69class BaseDynInst; 70class ThreadContext; 71class Request; 72 73/** 74 * CheckerCPU class. Dynamically verifies instructions as they are 75 * completed by making sure that the instruction and its results match 76 * the independent execution of the benchmark inside the checker. The 77 * checker verifies instructions in order, regardless of the order in 78 * which instructions complete. There are certain results that can 79 * not be verified, specifically the result of a store conditional or 80 * the values of uncached accesses. In these cases, and with 81 * instructions marked as "IsUnverifiable", the checker assumes that 82 * the value from the main CPU's execution is correct and simply 83 * copies that value. It provides a CheckerThreadContext (see 84 * checker/thread_context.hh) that provides hooks for updating the 85 * Checker's state through any ThreadContext accesses. This allows the 86 * checker to be able to correctly verify instructions, even with 87 * external accesses to the ThreadContext that change state. 88 */ 89class CheckerCPU : public BaseCPU 90{ 91 protected: 92 typedef TheISA::MachInst MachInst; 93 typedef TheISA::FloatReg FloatReg; 94 typedef TheISA::FloatRegBits FloatRegBits; 95 typedef TheISA::MiscReg MiscReg; 96 97 /** id attached to all issued requests */ 98 MasterID masterId; 99 public: 100 virtual void init(); 101 102 typedef CheckerCPUParams Params; 103 CheckerCPU(Params *p); 104 virtual ~CheckerCPU(); 105 106 void setSystem(System *system); 107 108 void setIcachePort(MasterPort *icache_port); 109 110 void setDcachePort(MasterPort *dcache_port); 111 112 MasterPort &getDataPort() 113 { 114 // the checker does not have ports on its own so return the 115 // data port of the actual CPU core 116 assert(dcachePort); 117 return *dcachePort; 118 } 119 120 MasterPort &getInstPort() 121 { 122 // the checker does not have ports on its own so return the 123 // data port of the actual CPU core 124 assert(icachePort); 125 return *icachePort; 126 } 127 128 protected: 129 130 std::vector<Process*> workload; 131 132 System *systemPtr; 133 134 MasterPort *icachePort; 135 MasterPort *dcachePort; 136 137 ThreadContext *tc; 138 139 TheISA::TLB *itb; 140 TheISA::TLB *dtb; 141 142 Addr dbg_vtophys(Addr addr); 143 144 union Result { 145 uint64_t integer; 146 double dbl; 147 void set(uint64_t i) { integer = i; } 148 void set(double d) { dbl = d; } 149 void get(uint64_t& i) { i = integer; } 150 void get(double& d) { d = dbl; } 151 }; 152 153 // ISAs like ARM can have multiple destination registers to check, 154 // keep them all in a std::queue 155 std::queue<Result> result; 156 157 // Pointer to the one memory request. 158 RequestPtr memReq; 159 160 StaticInstPtr curStaticInst; 161 StaticInstPtr curMacroStaticInst; 162 163 // number of simulated instructions 164 Counter numInst; 165 Counter startNumInst; 166 167 std::queue<int> miscRegIdxs; 168 169 public: 170 171 // Primary thread being run. 172 SimpleThread *thread; 173 174 TheISA::TLB* getITBPtr() { return itb; } 175 TheISA::TLB* getDTBPtr() { return dtb; } 176 177 virtual Counter totalInsts() const 178 { 179 return 0; 180 } 181 182 virtual Counter totalOps() const 183 { 184 return 0; 185 } 186 187 // number of simulated loads 188 Counter numLoad; 189 Counter startNumLoad; 190 191 virtual void serialize(std::ostream &os); 192 virtual void unserialize(Checkpoint *cp, const std::string §ion); 193 194 // These functions are only used in CPU models that split 195 // effective address computation from the actual memory access. 196 void setEA(Addr EA) { panic("SimpleCPU::setEA() not implemented\n"); } 197 Addr getEA() { panic("SimpleCPU::getEA() not implemented\n"); } 198 199 // The register accessor methods provide the index of the 200 // instruction's operand (e.g., 0 or 1), not the architectural 201 // register index, to simplify the implementation of register 202 // renaming. We find the architectural register index by indexing 203 // into the instruction's own operand index table. Note that a 204 // raw pointer to the StaticInst is provided instead of a 205 // ref-counted StaticInstPtr to redice overhead. This is fine as 206 // long as these methods don't copy the pointer into any long-term 207 // storage (which is pretty hard to imagine they would have reason 208 // to do). 209 210 uint64_t readIntRegOperand(const StaticInst *si, int idx) 211 { 212 return thread->readIntReg(si->srcRegIdx(idx)); 213 } 214 215 FloatReg readFloatRegOperand(const StaticInst *si, int idx) 216 { 217 int reg_idx = si->srcRegIdx(idx) - TheISA::FP_Reg_Base; 218 return thread->readFloatReg(reg_idx); 219 } 220 221 FloatRegBits readFloatRegOperandBits(const StaticInst *si, int idx) 222 { 223 int reg_idx = si->srcRegIdx(idx) - TheISA::FP_Reg_Base; 224 return thread->readFloatRegBits(reg_idx); 225 } 226 227 uint64_t readCCRegOperand(const StaticInst *si, int idx) 228 { 229 int reg_idx = si->srcRegIdx(idx) - TheISA::CC_Reg_Base; 230 return thread->readCCReg(reg_idx); 231 } 232 233 template <class T> 234 void setResult(T t) 235 { 236 Result instRes; 237 instRes.set(t); 238 result.push(instRes); 239 } 240 241 void setIntRegOperand(const StaticInst *si, int idx, uint64_t val) 242 { 243 thread->setIntReg(si->destRegIdx(idx), val); 244 setResult<uint64_t>(val); 245 } 246 247 void setFloatRegOperand(const StaticInst *si, int idx, FloatReg val) 248 { 249 int reg_idx = si->destRegIdx(idx) - TheISA::FP_Reg_Base; 250 thread->setFloatReg(reg_idx, val); 251 setResult<double>(val); 252 } 253 254 void setFloatRegOperandBits(const StaticInst *si, int idx, 255 FloatRegBits val) 256 { 257 int reg_idx = si->destRegIdx(idx) - TheISA::FP_Reg_Base; 258 thread->setFloatRegBits(reg_idx, val); 259 setResult<uint64_t>(val); 260 } 261 262 void setCCRegOperand(const StaticInst *si, int idx, uint64_t val) 263 { 264 int reg_idx = si->destRegIdx(idx) - TheISA::CC_Reg_Base; 265 thread->setCCReg(reg_idx, val); 266 setResult<uint64_t>(val); 267 } 268 269 bool readPredicate() { return thread->readPredicate(); } 270 void setPredicate(bool val) 271 { 272 thread->setPredicate(val); 273 } 274 275 TheISA::PCState pcState() { return thread->pcState(); } 276 void pcState(const TheISA::PCState &val) 277 { 278 DPRINTF(Checker, "Changing PC to %s, old PC %s.\n", 279 val, thread->pcState()); 280 thread->pcState(val); 281 } 282 Addr instAddr() { return thread->instAddr(); } 283 Addr nextInstAddr() { return thread->nextInstAddr(); } 284 MicroPC microPC() { return thread->microPC(); } 285 ////////////////////////////////////////// 286 287 MiscReg readMiscRegNoEffect(int misc_reg) 288 { 289 return thread->readMiscRegNoEffect(misc_reg); 290 } 291 292 MiscReg readMiscReg(int misc_reg) 293 { 294 return thread->readMiscReg(misc_reg); 295 } 296 297 void setMiscRegNoEffect(int misc_reg, const MiscReg &val) 298 { 299 miscRegIdxs.push(misc_reg); 300 return thread->setMiscRegNoEffect(misc_reg, val); 301 } 302 303 void setMiscReg(int misc_reg, const MiscReg &val) 304 { 305 miscRegIdxs.push(misc_reg); 306 return thread->setMiscReg(misc_reg, val); 307 } 308 309 MiscReg readMiscRegOperand(const StaticInst *si, int idx) 310 { 311 int reg_idx = si->srcRegIdx(idx) - TheISA::Misc_Reg_Base; 312 return thread->readMiscReg(reg_idx); 313 } 314 315 void setMiscRegOperand( 316 const StaticInst *si, int idx, const MiscReg &val) 317 { 318 int reg_idx = si->destRegIdx(idx) - TheISA::Misc_Reg_Base; 319 return thread->setMiscReg(reg_idx, val); 320 } 321 322#if THE_ISA == MIPS_ISA 323 uint64_t readRegOtherThread(int misc_reg) 324 { 325 panic("MIPS MT not defined for CheckerCPU.\n"); 326 return 0; 327 } 328 329 void setRegOtherThread(int misc_reg, const TheISA::MiscReg &val) 330 { 331 panic("MIPS MT not defined for CheckerCPU.\n"); 332 } 333#endif 334 335 ///////////////////////////////////////// 336 337 void recordPCChange(const TheISA::PCState &val) 338 { 339 changedPC = true; 340 newPCState = val; 341 } 342 343 void demapPage(Addr vaddr, uint64_t asn) 344 { 345 this->itb->demapPage(vaddr, asn); 346 this->dtb->demapPage(vaddr, asn); 347 } 348 349 void demapInstPage(Addr vaddr, uint64_t asn) 350 { 351 this->itb->demapPage(vaddr, asn); 352 } 353 354 void demapDataPage(Addr vaddr, uint64_t asn) 355 { 356 this->dtb->demapPage(vaddr, asn); 357 } 358 359 Fault readMem(Addr addr, uint8_t *data, unsigned size, unsigned flags); 360 Fault writeMem(uint8_t *data, unsigned size, 361 Addr addr, unsigned flags, uint64_t *res); 362 363 void setStCondFailures(unsigned sc_failures) 364 {} 365 ///////////////////////////////////////////////////// 366 367 Fault hwrei() { return thread->hwrei(); } 368 bool simPalCheck(int palFunc) { return thread->simPalCheck(palFunc); } 369 void wakeup() { } 370 // Assume that the normal CPU's call to syscall was successful. 371 // The checker's state would have already been updated by the syscall. 372 void syscall(uint64_t callnum) { } 373 374 void handleError() 375 { 376 if (exitOnError) 377 dumpAndExit(); 378 } 379 380 bool checkFlags(Request *unverified_req, Addr vAddr, 381 Addr pAddr, int flags); 382 383 void dumpAndExit(); 384 385 ThreadContext *tcBase() { return tc; } 386 SimpleThread *threadBase() { return thread; } 387 388 Result unverifiedResult; 389 Request *unverifiedReq; 390 uint8_t *unverifiedMemData; 391 392 bool changedPC; 393 bool willChangePC; 394 TheISA::PCState newPCState; 395 bool changedNextPC; 396 bool exitOnError; 397 bool updateOnError; 398 bool warnOnlyOnLoadError; 399 400 InstSeqNum youngestSN; 401}; 402 403/** 404 * Templated Checker class. This Checker class is templated on the 405 * DynInstPtr of the instruction type that will be verified. Proper 406 * template instantiations of the Checker must be placed at the bottom 407 * of checker/cpu.cc. 408 */ 409template <class Impl> 410class Checker : public CheckerCPU 411{ 412 private: 413 typedef typename Impl::DynInstPtr DynInstPtr; 414 415 public: 416 Checker(Params *p) 417 : CheckerCPU(p), updateThisCycle(false), unverifiedInst(NULL) 418 { } 419 420 void switchOut(); 421 void takeOverFrom(BaseCPU *oldCPU); 422 423 void advancePC(Fault fault); 424 425 void verify(DynInstPtr &inst); 426 427 void validateInst(DynInstPtr &inst); 428 void validateExecution(DynInstPtr &inst); 429 void validateState(); 430 431 void copyResult(DynInstPtr &inst, uint64_t mismatch_val, int start_idx); 432 void handlePendingInt(); 433 434 private: 435 void handleError(DynInstPtr &inst) 436 { 437 if (exitOnError) { 438 dumpAndExit(inst); 439 } else if (updateOnError) { 440 updateThisCycle = true; 441 } 442 } 443 444 void dumpAndExit(DynInstPtr &inst); 445 446 bool updateThisCycle; 447 448 DynInstPtr unverifiedInst; 449 450 std::list<DynInstPtr> instList; 451 typedef typename std::list<DynInstPtr>::iterator InstListIt; 452 void dumpInsts(); 453}; 454 455#endif // __CPU_CHECKER_CPU_HH__ 456