1 //===- MachineVerifier.cpp - Machine Code Verifier ------------------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 // 9 // Pass to verify generated machine code. The following is checked: 10 // 11 // Operand counts: All explicit operands must be present. 12 // 13 // Register classes: All physical and virtual register operands must be 14 // compatible with the register class required by the instruction descriptor. 15 // 16 // Register live intervals: Registers must be defined only once, and must be 17 // defined before use. 18 // 19 // The machine code verifier is enabled from LLVMTargetMachine.cpp with the 20 // command-line option -verify-machineinstrs, or by defining the environment 21 // variable LLVM_VERIFY_MACHINEINSTRS to the name of a file that will receive 22 // the verifier errors. 23 //===----------------------------------------------------------------------===// 24 25 #include "LiveRangeCalc.h" 26 #include "llvm/ADT/BitVector.h" 27 #include "llvm/ADT/DenseMap.h" 28 #include "llvm/ADT/DenseSet.h" 29 #include "llvm/ADT/DepthFirstIterator.h" 30 #include "llvm/ADT/STLExtras.h" 31 #include "llvm/ADT/SetOperations.h" 32 #include "llvm/ADT/SmallPtrSet.h" 33 #include "llvm/ADT/SmallVector.h" 34 #include "llvm/ADT/StringRef.h" 35 #include "llvm/ADT/Twine.h" 36 #include "llvm/Analysis/EHPersonalities.h" 37 #include "llvm/CodeGen/GlobalISel/RegisterBank.h" 38 #include "llvm/CodeGen/LiveInterval.h" 39 #include "llvm/CodeGen/LiveIntervals.h" 40 #include "llvm/CodeGen/LiveStacks.h" 41 #include "llvm/CodeGen/LiveVariables.h" 42 #include "llvm/CodeGen/MachineBasicBlock.h" 43 #include "llvm/CodeGen/MachineFrameInfo.h" 44 #include "llvm/CodeGen/MachineFunction.h" 45 #include "llvm/CodeGen/MachineFunctionPass.h" 46 #include "llvm/CodeGen/MachineInstr.h" 47 #include "llvm/CodeGen/MachineInstrBundle.h" 48 #include "llvm/CodeGen/MachineMemOperand.h" 49 #include "llvm/CodeGen/MachineOperand.h" 50 #include "llvm/CodeGen/MachineRegisterInfo.h" 51 #include "llvm/CodeGen/PseudoSourceValue.h" 52 #include "llvm/CodeGen/SlotIndexes.h" 53 #include "llvm/CodeGen/StackMaps.h" 54 #include "llvm/CodeGen/TargetInstrInfo.h" 55 #include "llvm/CodeGen/TargetOpcodes.h" 56 #include "llvm/CodeGen/TargetRegisterInfo.h" 57 #include "llvm/CodeGen/TargetSubtargetInfo.h" 58 #include "llvm/IR/BasicBlock.h" 59 #include "llvm/IR/Function.h" 60 #include "llvm/IR/InlineAsm.h" 61 #include "llvm/IR/Instructions.h" 62 #include "llvm/MC/LaneBitmask.h" 63 #include "llvm/MC/MCAsmInfo.h" 64 #include "llvm/MC/MCInstrDesc.h" 65 #include "llvm/MC/MCRegisterInfo.h" 66 #include "llvm/MC/MCTargetOptions.h" 67 #include "llvm/Pass.h" 68 #include "llvm/Support/Casting.h" 69 #include "llvm/Support/ErrorHandling.h" 70 #include "llvm/Support/LowLevelTypeImpl.h" 71 #include "llvm/Support/MathExtras.h" 72 #include "llvm/Support/raw_ostream.h" 73 #include "llvm/Target/TargetMachine.h" 74 #include <algorithm> 75 #include <cassert> 76 #include <cstddef> 77 #include <cstdint> 78 #include <iterator> 79 #include <string> 80 #include <utility> 81 82 using namespace llvm; 83 84 namespace { 85 86 struct MachineVerifier { 87 MachineVerifier(Pass *pass, const char *b) : PASS(pass), Banner(b) {} 88 89 unsigned verify(MachineFunction &MF); 90 91 Pass *const PASS; 92 const char *Banner; 93 const MachineFunction *MF; 94 const TargetMachine *TM; 95 const TargetInstrInfo *TII; 96 const TargetRegisterInfo *TRI; 97 const MachineRegisterInfo *MRI; 98 99 unsigned foundErrors; 100 101 // Avoid querying the MachineFunctionProperties for each operand. 102 bool isFunctionRegBankSelected; 103 bool isFunctionSelected; 104 105 using RegVector = SmallVector<unsigned, 16>; 106 using RegMaskVector = SmallVector<const uint32_t *, 4>; 107 using RegSet = DenseSet<unsigned>; 108 using RegMap = DenseMap<unsigned, const MachineInstr *>; 109 using BlockSet = SmallPtrSet<const MachineBasicBlock *, 8>; 110 111 const MachineInstr *FirstNonPHI; 112 const MachineInstr *FirstTerminator; 113 BlockSet FunctionBlocks; 114 115 BitVector regsReserved; 116 RegSet regsLive; 117 RegVector regsDefined, regsDead, regsKilled; 118 RegMaskVector regMasks; 119 120 SlotIndex lastIndex; 121 122 // Add Reg and any sub-registers to RV 123 void addRegWithSubRegs(RegVector &RV, unsigned Reg) { 124 RV.push_back(Reg); 125 if (TargetRegisterInfo::isPhysicalRegister(Reg)) 126 for (MCSubRegIterator SubRegs(Reg, TRI); SubRegs.isValid(); ++SubRegs) 127 RV.push_back(*SubRegs); 128 } 129 130 struct BBInfo { 131 // Is this MBB reachable from the MF entry point? 132 bool reachable = false; 133 134 // Vregs that must be live in because they are used without being 135 // defined. Map value is the user. 136 RegMap vregsLiveIn; 137 138 // Regs killed in MBB. They may be defined again, and will then be in both 139 // regsKilled and regsLiveOut. 140 RegSet regsKilled; 141 142 // Regs defined in MBB and live out. Note that vregs passing through may 143 // be live out without being mentioned here. 144 RegSet regsLiveOut; 145 146 // Vregs that pass through MBB untouched. This set is disjoint from 147 // regsKilled and regsLiveOut. 148 RegSet vregsPassed; 149 150 // Vregs that must pass through MBB because they are needed by a successor 151 // block. This set is disjoint from regsLiveOut. 152 RegSet vregsRequired; 153 154 // Set versions of block's predecessor and successor lists. 155 BlockSet Preds, Succs; 156 157 BBInfo() = default; 158 159 // Add register to vregsPassed if it belongs there. Return true if 160 // anything changed. 161 bool addPassed(unsigned Reg) { 162 if (!TargetRegisterInfo::isVirtualRegister(Reg)) 163 return false; 164 if (regsKilled.count(Reg) || regsLiveOut.count(Reg)) 165 return false; 166 return vregsPassed.insert(Reg).second; 167 } 168 169 // Same for a full set. 170 bool addPassed(const RegSet &RS) { 171 bool changed = false; 172 for (RegSet::const_iterator I = RS.begin(), E = RS.end(); I != E; ++I) 173 if (addPassed(*I)) 174 changed = true; 175 return changed; 176 } 177 178 // Add register to vregsRequired if it belongs there. Return true if 179 // anything changed. 180 bool addRequired(unsigned Reg) { 181 if (!TargetRegisterInfo::isVirtualRegister(Reg)) 182 return false; 183 if (regsLiveOut.count(Reg)) 184 return false; 185 return vregsRequired.insert(Reg).second; 186 } 187 188 // Same for a full set. 189 bool addRequired(const RegSet &RS) { 190 bool changed = false; 191 for (RegSet::const_iterator I = RS.begin(), E = RS.end(); I != E; ++I) 192 if (addRequired(*I)) 193 changed = true; 194 return changed; 195 } 196 197 // Same for a full map. 198 bool addRequired(const RegMap &RM) { 199 bool changed = false; 200 for (RegMap::const_iterator I = RM.begin(), E = RM.end(); I != E; ++I) 201 if (addRequired(I->first)) 202 changed = true; 203 return changed; 204 } 205 206 // Live-out registers are either in regsLiveOut or vregsPassed. 207 bool isLiveOut(unsigned Reg) const { 208 return regsLiveOut.count(Reg) || vregsPassed.count(Reg); 209 } 210 }; 211 212 // Extra register info per MBB. 213 DenseMap<const MachineBasicBlock*, BBInfo> MBBInfoMap; 214 215 bool isReserved(unsigned Reg) { 216 return Reg < regsReserved.size() && regsReserved.test(Reg); 217 } 218 219 bool isAllocatable(unsigned Reg) const { 220 return Reg < TRI->getNumRegs() && TRI->isInAllocatableClass(Reg) && 221 !regsReserved.test(Reg); 222 } 223 224 // Analysis information if available 225 LiveVariables *LiveVars; 226 LiveIntervals *LiveInts; 227 LiveStacks *LiveStks; 228 SlotIndexes *Indexes; 229 230 void visitMachineFunctionBefore(); 231 void visitMachineBasicBlockBefore(const MachineBasicBlock *MBB); 232 void visitMachineBundleBefore(const MachineInstr *MI); 233 234 bool verifyVectorElementMatch(LLT Ty0, LLT Ty1, const MachineInstr *MI); 235 void verifyPreISelGenericInstruction(const MachineInstr *MI); 236 void visitMachineInstrBefore(const MachineInstr *MI); 237 void visitMachineOperand(const MachineOperand *MO, unsigned MONum); 238 void visitMachineInstrAfter(const MachineInstr *MI); 239 void visitMachineBundleAfter(const MachineInstr *MI); 240 void visitMachineBasicBlockAfter(const MachineBasicBlock *MBB); 241 void visitMachineFunctionAfter(); 242 243 void report(const char *msg, const MachineFunction *MF); 244 void report(const char *msg, const MachineBasicBlock *MBB); 245 void report(const char *msg, const MachineInstr *MI); 246 void report(const char *msg, const MachineOperand *MO, unsigned MONum, 247 LLT MOVRegType = LLT{}); 248 249 void report_context(const LiveInterval &LI) const; 250 void report_context(const LiveRange &LR, unsigned VRegUnit, 251 LaneBitmask LaneMask) const; 252 void report_context(const LiveRange::Segment &S) const; 253 void report_context(const VNInfo &VNI) const; 254 void report_context(SlotIndex Pos) const; 255 void report_context(MCPhysReg PhysReg) const; 256 void report_context_liverange(const LiveRange &LR) const; 257 void report_context_lanemask(LaneBitmask LaneMask) const; 258 void report_context_vreg(unsigned VReg) const; 259 void report_context_vreg_regunit(unsigned VRegOrUnit) const; 260 261 void verifyInlineAsm(const MachineInstr *MI); 262 263 void checkLiveness(const MachineOperand *MO, unsigned MONum); 264 void checkLivenessAtUse(const MachineOperand *MO, unsigned MONum, 265 SlotIndex UseIdx, const LiveRange &LR, unsigned VRegOrUnit, 266 LaneBitmask LaneMask = LaneBitmask::getNone()); 267 void checkLivenessAtDef(const MachineOperand *MO, unsigned MONum, 268 SlotIndex DefIdx, const LiveRange &LR, unsigned VRegOrUnit, 269 bool SubRangeCheck = false, 270 LaneBitmask LaneMask = LaneBitmask::getNone()); 271 272 void markReachable(const MachineBasicBlock *MBB); 273 void calcRegsPassed(); 274 void checkPHIOps(const MachineBasicBlock &MBB); 275 276 void calcRegsRequired(); 277 void verifyLiveVariables(); 278 void verifyLiveIntervals(); 279 void verifyLiveInterval(const LiveInterval&); 280 void verifyLiveRangeValue(const LiveRange&, const VNInfo*, unsigned, 281 LaneBitmask); 282 void verifyLiveRangeSegment(const LiveRange&, 283 const LiveRange::const_iterator I, unsigned, 284 LaneBitmask); 285 void verifyLiveRange(const LiveRange&, unsigned, 286 LaneBitmask LaneMask = LaneBitmask::getNone()); 287 288 void verifyStackFrame(); 289 290 void verifySlotIndexes() const; 291 void verifyProperties(const MachineFunction &MF); 292 }; 293 294 struct MachineVerifierPass : public MachineFunctionPass { 295 static char ID; // Pass ID, replacement for typeid 296 297 const std::string Banner; 298 299 MachineVerifierPass(std::string banner = std::string()) 300 : MachineFunctionPass(ID), Banner(std::move(banner)) { 301 initializeMachineVerifierPassPass(*PassRegistry::getPassRegistry()); 302 } 303 304 void getAnalysisUsage(AnalysisUsage &AU) const override { 305 AU.setPreservesAll(); 306 MachineFunctionPass::getAnalysisUsage(AU); 307 } 308 309 bool runOnMachineFunction(MachineFunction &MF) override { 310 unsigned FoundErrors = MachineVerifier(this, Banner.c_str()).verify(MF); 311 if (FoundErrors) 312 report_fatal_error("Found "+Twine(FoundErrors)+" machine code errors."); 313 return false; 314 } 315 }; 316 317 } // end anonymous namespace 318 319 char MachineVerifierPass::ID = 0; 320 321 INITIALIZE_PASS(MachineVerifierPass, "machineverifier", 322 "Verify generated machine code", false, false) 323 324 FunctionPass *llvm::createMachineVerifierPass(const std::string &Banner) { 325 return new MachineVerifierPass(Banner); 326 } 327 328 bool MachineFunction::verify(Pass *p, const char *Banner, bool AbortOnErrors) 329 const { 330 MachineFunction &MF = const_cast<MachineFunction&>(*this); 331 unsigned FoundErrors = MachineVerifier(p, Banner).verify(MF); 332 if (AbortOnErrors && FoundErrors) 333 report_fatal_error("Found "+Twine(FoundErrors)+" machine code errors."); 334 return FoundErrors == 0; 335 } 336 337 void MachineVerifier::verifySlotIndexes() const { 338 if (Indexes == nullptr) 339 return; 340 341 // Ensure the IdxMBB list is sorted by slot indexes. 342 SlotIndex Last; 343 for (SlotIndexes::MBBIndexIterator I = Indexes->MBBIndexBegin(), 344 E = Indexes->MBBIndexEnd(); I != E; ++I) { 345 assert(!Last.isValid() || I->first > Last); 346 Last = I->first; 347 } 348 } 349 350 void MachineVerifier::verifyProperties(const MachineFunction &MF) { 351 // If a pass has introduced virtual registers without clearing the 352 // NoVRegs property (or set it without allocating the vregs) 353 // then report an error. 354 if (MF.getProperties().hasProperty( 355 MachineFunctionProperties::Property::NoVRegs) && 356 MRI->getNumVirtRegs()) 357 report("Function has NoVRegs property but there are VReg operands", &MF); 358 } 359 360 unsigned MachineVerifier::verify(MachineFunction &MF) { 361 foundErrors = 0; 362 363 this->MF = &MF; 364 TM = &MF.getTarget(); 365 TII = MF.getSubtarget().getInstrInfo(); 366 TRI = MF.getSubtarget().getRegisterInfo(); 367 MRI = &MF.getRegInfo(); 368 369 const bool isFunctionFailedISel = MF.getProperties().hasProperty( 370 MachineFunctionProperties::Property::FailedISel); 371 372 // If we're mid-GlobalISel and we already triggered the fallback path then 373 // it's expected that the MIR is somewhat broken but that's ok since we'll 374 // reset it and clear the FailedISel attribute in ResetMachineFunctions. 375 if (isFunctionFailedISel) 376 return foundErrors; 377 378 isFunctionRegBankSelected = 379 !isFunctionFailedISel && 380 MF.getProperties().hasProperty( 381 MachineFunctionProperties::Property::RegBankSelected); 382 isFunctionSelected = !isFunctionFailedISel && 383 MF.getProperties().hasProperty( 384 MachineFunctionProperties::Property::Selected); 385 LiveVars = nullptr; 386 LiveInts = nullptr; 387 LiveStks = nullptr; 388 Indexes = nullptr; 389 if (PASS) { 390 LiveInts = PASS->getAnalysisIfAvailable<LiveIntervals>(); 391 // We don't want to verify LiveVariables if LiveIntervals is available. 392 if (!LiveInts) 393 LiveVars = PASS->getAnalysisIfAvailable<LiveVariables>(); 394 LiveStks = PASS->getAnalysisIfAvailable<LiveStacks>(); 395 Indexes = PASS->getAnalysisIfAvailable<SlotIndexes>(); 396 } 397 398 verifySlotIndexes(); 399 400 verifyProperties(MF); 401 402 visitMachineFunctionBefore(); 403 for (MachineFunction::const_iterator MFI = MF.begin(), MFE = MF.end(); 404 MFI!=MFE; ++MFI) { 405 visitMachineBasicBlockBefore(&*MFI); 406 // Keep track of the current bundle header. 407 const MachineInstr *CurBundle = nullptr; 408 // Do we expect the next instruction to be part of the same bundle? 409 bool InBundle = false; 410 411 for (MachineBasicBlock::const_instr_iterator MBBI = MFI->instr_begin(), 412 MBBE = MFI->instr_end(); MBBI != MBBE; ++MBBI) { 413 if (MBBI->getParent() != &*MFI) { 414 report("Bad instruction parent pointer", &*MFI); 415 errs() << "Instruction: " << *MBBI; 416 continue; 417 } 418 419 // Check for consistent bundle flags. 420 if (InBundle && !MBBI->isBundledWithPred()) 421 report("Missing BundledPred flag, " 422 "BundledSucc was set on predecessor", 423 &*MBBI); 424 if (!InBundle && MBBI->isBundledWithPred()) 425 report("BundledPred flag is set, " 426 "but BundledSucc not set on predecessor", 427 &*MBBI); 428 429 // Is this a bundle header? 430 if (!MBBI->isInsideBundle()) { 431 if (CurBundle) 432 visitMachineBundleAfter(CurBundle); 433 CurBundle = &*MBBI; 434 visitMachineBundleBefore(CurBundle); 435 } else if (!CurBundle) 436 report("No bundle header", &*MBBI); 437 visitMachineInstrBefore(&*MBBI); 438 for (unsigned I = 0, E = MBBI->getNumOperands(); I != E; ++I) { 439 const MachineInstr &MI = *MBBI; 440 const MachineOperand &Op = MI.getOperand(I); 441 if (Op.getParent() != &MI) { 442 // Make sure to use correct addOperand / RemoveOperand / ChangeTo 443 // functions when replacing operands of a MachineInstr. 444 report("Instruction has operand with wrong parent set", &MI); 445 } 446 447 visitMachineOperand(&Op, I); 448 } 449 450 visitMachineInstrAfter(&*MBBI); 451 452 // Was this the last bundled instruction? 453 InBundle = MBBI->isBundledWithSucc(); 454 } 455 if (CurBundle) 456 visitMachineBundleAfter(CurBundle); 457 if (InBundle) 458 report("BundledSucc flag set on last instruction in block", &MFI->back()); 459 visitMachineBasicBlockAfter(&*MFI); 460 } 461 visitMachineFunctionAfter(); 462 463 // Clean up. 464 regsLive.clear(); 465 regsDefined.clear(); 466 regsDead.clear(); 467 regsKilled.clear(); 468 regMasks.clear(); 469 MBBInfoMap.clear(); 470 471 return foundErrors; 472 } 473 474 void MachineVerifier::report(const char *msg, const MachineFunction *MF) { 475 assert(MF); 476 errs() << '\n'; 477 if (!foundErrors++) { 478 if (Banner) 479 errs() << "# " << Banner << '\n'; 480 if (LiveInts != nullptr) 481 LiveInts->print(errs()); 482 else 483 MF->print(errs(), Indexes); 484 } 485 errs() << "*** Bad machine code: " << msg << " ***\n" 486 << "- function: " << MF->getName() << "\n"; 487 } 488 489 void MachineVerifier::report(const char *msg, const MachineBasicBlock *MBB) { 490 assert(MBB); 491 report(msg, MBB->getParent()); 492 errs() << "- basic block: " << printMBBReference(*MBB) << ' ' 493 << MBB->getName() << " (" << (const void *)MBB << ')'; 494 if (Indexes) 495 errs() << " [" << Indexes->getMBBStartIdx(MBB) 496 << ';' << Indexes->getMBBEndIdx(MBB) << ')'; 497 errs() << '\n'; 498 } 499 500 void MachineVerifier::report(const char *msg, const MachineInstr *MI) { 501 assert(MI); 502 report(msg, MI->getParent()); 503 errs() << "- instruction: "; 504 if (Indexes && Indexes->hasIndex(*MI)) 505 errs() << Indexes->getInstructionIndex(*MI) << '\t'; 506 MI->print(errs(), /*SkipOpers=*/true); 507 } 508 509 void MachineVerifier::report(const char *msg, const MachineOperand *MO, 510 unsigned MONum, LLT MOVRegType) { 511 assert(MO); 512 report(msg, MO->getParent()); 513 errs() << "- operand " << MONum << ": "; 514 MO->print(errs(), MOVRegType, TRI); 515 errs() << "\n"; 516 } 517 518 void MachineVerifier::report_context(SlotIndex Pos) const { 519 errs() << "- at: " << Pos << '\n'; 520 } 521 522 void MachineVerifier::report_context(const LiveInterval &LI) const { 523 errs() << "- interval: " << LI << '\n'; 524 } 525 526 void MachineVerifier::report_context(const LiveRange &LR, unsigned VRegUnit, 527 LaneBitmask LaneMask) const { 528 report_context_liverange(LR); 529 report_context_vreg_regunit(VRegUnit); 530 if (LaneMask.any()) 531 report_context_lanemask(LaneMask); 532 } 533 534 void MachineVerifier::report_context(const LiveRange::Segment &S) const { 535 errs() << "- segment: " << S << '\n'; 536 } 537 538 void MachineVerifier::report_context(const VNInfo &VNI) const { 539 errs() << "- ValNo: " << VNI.id << " (def " << VNI.def << ")\n"; 540 } 541 542 void MachineVerifier::report_context_liverange(const LiveRange &LR) const { 543 errs() << "- liverange: " << LR << '\n'; 544 } 545 546 void MachineVerifier::report_context(MCPhysReg PReg) const { 547 errs() << "- p. register: " << printReg(PReg, TRI) << '\n'; 548 } 549 550 void MachineVerifier::report_context_vreg(unsigned VReg) const { 551 errs() << "- v. register: " << printReg(VReg, TRI) << '\n'; 552 } 553 554 void MachineVerifier::report_context_vreg_regunit(unsigned VRegOrUnit) const { 555 if (TargetRegisterInfo::isVirtualRegister(VRegOrUnit)) { 556 report_context_vreg(VRegOrUnit); 557 } else { 558 errs() << "- regunit: " << printRegUnit(VRegOrUnit, TRI) << '\n'; 559 } 560 } 561 562 void MachineVerifier::report_context_lanemask(LaneBitmask LaneMask) const { 563 errs() << "- lanemask: " << PrintLaneMask(LaneMask) << '\n'; 564 } 565 566 void MachineVerifier::markReachable(const MachineBasicBlock *MBB) { 567 BBInfo &MInfo = MBBInfoMap[MBB]; 568 if (!MInfo.reachable) { 569 MInfo.reachable = true; 570 for (MachineBasicBlock::const_succ_iterator SuI = MBB->succ_begin(), 571 SuE = MBB->succ_end(); SuI != SuE; ++SuI) 572 markReachable(*SuI); 573 } 574 } 575 576 void MachineVerifier::visitMachineFunctionBefore() { 577 lastIndex = SlotIndex(); 578 regsReserved = MRI->reservedRegsFrozen() ? MRI->getReservedRegs() 579 : TRI->getReservedRegs(*MF); 580 581 if (!MF->empty()) 582 markReachable(&MF->front()); 583 584 // Build a set of the basic blocks in the function. 585 FunctionBlocks.clear(); 586 for (const auto &MBB : *MF) { 587 FunctionBlocks.insert(&MBB); 588 BBInfo &MInfo = MBBInfoMap[&MBB]; 589 590 MInfo.Preds.insert(MBB.pred_begin(), MBB.pred_end()); 591 if (MInfo.Preds.size() != MBB.pred_size()) 592 report("MBB has duplicate entries in its predecessor list.", &MBB); 593 594 MInfo.Succs.insert(MBB.succ_begin(), MBB.succ_end()); 595 if (MInfo.Succs.size() != MBB.succ_size()) 596 report("MBB has duplicate entries in its successor list.", &MBB); 597 } 598 599 // Check that the register use lists are sane. 600 MRI->verifyUseLists(); 601 602 if (!MF->empty()) 603 verifyStackFrame(); 604 } 605 606 // Does iterator point to a and b as the first two elements? 607 static bool matchPair(MachineBasicBlock::const_succ_iterator i, 608 const MachineBasicBlock *a, const MachineBasicBlock *b) { 609 if (*i == a) 610 return *++i == b; 611 if (*i == b) 612 return *++i == a; 613 return false; 614 } 615 616 void 617 MachineVerifier::visitMachineBasicBlockBefore(const MachineBasicBlock *MBB) { 618 FirstTerminator = nullptr; 619 FirstNonPHI = nullptr; 620 621 if (!MF->getProperties().hasProperty( 622 MachineFunctionProperties::Property::NoPHIs) && MRI->tracksLiveness()) { 623 // If this block has allocatable physical registers live-in, check that 624 // it is an entry block or landing pad. 625 for (const auto &LI : MBB->liveins()) { 626 if (isAllocatable(LI.PhysReg) && !MBB->isEHPad() && 627 MBB->getIterator() != MBB->getParent()->begin()) { 628 report("MBB has allocatable live-in, but isn't entry or landing-pad.", MBB); 629 report_context(LI.PhysReg); 630 } 631 } 632 } 633 634 // Count the number of landing pad successors. 635 SmallPtrSet<MachineBasicBlock*, 4> LandingPadSuccs; 636 for (MachineBasicBlock::const_succ_iterator I = MBB->succ_begin(), 637 E = MBB->succ_end(); I != E; ++I) { 638 if ((*I)->isEHPad()) 639 LandingPadSuccs.insert(*I); 640 if (!FunctionBlocks.count(*I)) 641 report("MBB has successor that isn't part of the function.", MBB); 642 if (!MBBInfoMap[*I].Preds.count(MBB)) { 643 report("Inconsistent CFG", MBB); 644 errs() << "MBB is not in the predecessor list of the successor " 645 << printMBBReference(*(*I)) << ".\n"; 646 } 647 } 648 649 // Check the predecessor list. 650 for (MachineBasicBlock::const_pred_iterator I = MBB->pred_begin(), 651 E = MBB->pred_end(); I != E; ++I) { 652 if (!FunctionBlocks.count(*I)) 653 report("MBB has predecessor that isn't part of the function.", MBB); 654 if (!MBBInfoMap[*I].Succs.count(MBB)) { 655 report("Inconsistent CFG", MBB); 656 errs() << "MBB is not in the successor list of the predecessor " 657 << printMBBReference(*(*I)) << ".\n"; 658 } 659 } 660 661 const MCAsmInfo *AsmInfo = TM->getMCAsmInfo(); 662 const BasicBlock *BB = MBB->getBasicBlock(); 663 const Function &F = MF->getFunction(); 664 if (LandingPadSuccs.size() > 1 && 665 !(AsmInfo && 666 AsmInfo->getExceptionHandlingType() == ExceptionHandling::SjLj && 667 BB && isa<SwitchInst>(BB->getTerminator())) && 668 !isScopedEHPersonality(classifyEHPersonality(F.getPersonalityFn()))) 669 report("MBB has more than one landing pad successor", MBB); 670 671 // Call AnalyzeBranch. If it succeeds, there several more conditions to check. 672 MachineBasicBlock *TBB = nullptr, *FBB = nullptr; 673 SmallVector<MachineOperand, 4> Cond; 674 if (!TII->analyzeBranch(*const_cast<MachineBasicBlock *>(MBB), TBB, FBB, 675 Cond)) { 676 // Ok, AnalyzeBranch thinks it knows what's going on with this block. Let's 677 // check whether its answers match up with reality. 678 if (!TBB && !FBB) { 679 // Block falls through to its successor. 680 MachineFunction::const_iterator MBBI = MBB->getIterator(); 681 ++MBBI; 682 if (MBBI == MF->end()) { 683 // It's possible that the block legitimately ends with a noreturn 684 // call or an unreachable, in which case it won't actually fall 685 // out the bottom of the function. 686 } else if (MBB->succ_size() == LandingPadSuccs.size()) { 687 // It's possible that the block legitimately ends with a noreturn 688 // call or an unreachable, in which case it won't actually fall 689 // out of the block. 690 } else if (MBB->succ_size() != 1+LandingPadSuccs.size()) { 691 report("MBB exits via unconditional fall-through but doesn't have " 692 "exactly one CFG successor!", MBB); 693 } else if (!MBB->isSuccessor(&*MBBI)) { 694 report("MBB exits via unconditional fall-through but its successor " 695 "differs from its CFG successor!", MBB); 696 } 697 if (!MBB->empty() && MBB->back().isBarrier() && 698 !TII->isPredicated(MBB->back())) { 699 report("MBB exits via unconditional fall-through but ends with a " 700 "barrier instruction!", MBB); 701 } 702 if (!Cond.empty()) { 703 report("MBB exits via unconditional fall-through but has a condition!", 704 MBB); 705 } 706 } else if (TBB && !FBB && Cond.empty()) { 707 // Block unconditionally branches somewhere. 708 // If the block has exactly one successor, that happens to be a 709 // landingpad, accept it as valid control flow. 710 if (MBB->succ_size() != 1+LandingPadSuccs.size() && 711 (MBB->succ_size() != 1 || LandingPadSuccs.size() != 1 || 712 *MBB->succ_begin() != *LandingPadSuccs.begin())) { 713 report("MBB exits via unconditional branch but doesn't have " 714 "exactly one CFG successor!", MBB); 715 } else if (!MBB->isSuccessor(TBB)) { 716 report("MBB exits via unconditional branch but the CFG " 717 "successor doesn't match the actual successor!", MBB); 718 } 719 if (MBB->empty()) { 720 report("MBB exits via unconditional branch but doesn't contain " 721 "any instructions!", MBB); 722 } else if (!MBB->back().isBarrier()) { 723 report("MBB exits via unconditional branch but doesn't end with a " 724 "barrier instruction!", MBB); 725 } else if (!MBB->back().isTerminator()) { 726 report("MBB exits via unconditional branch but the branch isn't a " 727 "terminator instruction!", MBB); 728 } 729 } else if (TBB && !FBB && !Cond.empty()) { 730 // Block conditionally branches somewhere, otherwise falls through. 731 MachineFunction::const_iterator MBBI = MBB->getIterator(); 732 ++MBBI; 733 if (MBBI == MF->end()) { 734 report("MBB conditionally falls through out of function!", MBB); 735 } else if (MBB->succ_size() == 1) { 736 // A conditional branch with only one successor is weird, but allowed. 737 if (&*MBBI != TBB) 738 report("MBB exits via conditional branch/fall-through but only has " 739 "one CFG successor!", MBB); 740 else if (TBB != *MBB->succ_begin()) 741 report("MBB exits via conditional branch/fall-through but the CFG " 742 "successor don't match the actual successor!", MBB); 743 } else if (MBB->succ_size() != 2) { 744 report("MBB exits via conditional branch/fall-through but doesn't have " 745 "exactly two CFG successors!", MBB); 746 } else if (!matchPair(MBB->succ_begin(), TBB, &*MBBI)) { 747 report("MBB exits via conditional branch/fall-through but the CFG " 748 "successors don't match the actual successors!", MBB); 749 } 750 if (MBB->empty()) { 751 report("MBB exits via conditional branch/fall-through but doesn't " 752 "contain any instructions!", MBB); 753 } else if (MBB->back().isBarrier()) { 754 report("MBB exits via conditional branch/fall-through but ends with a " 755 "barrier instruction!", MBB); 756 } else if (!MBB->back().isTerminator()) { 757 report("MBB exits via conditional branch/fall-through but the branch " 758 "isn't a terminator instruction!", MBB); 759 } 760 } else if (TBB && FBB) { 761 // Block conditionally branches somewhere, otherwise branches 762 // somewhere else. 763 if (MBB->succ_size() == 1) { 764 // A conditional branch with only one successor is weird, but allowed. 765 if (FBB != TBB) 766 report("MBB exits via conditional branch/branch through but only has " 767 "one CFG successor!", MBB); 768 else if (TBB != *MBB->succ_begin()) 769 report("MBB exits via conditional branch/branch through but the CFG " 770 "successor don't match the actual successor!", MBB); 771 } else if (MBB->succ_size() != 2) { 772 report("MBB exits via conditional branch/branch but doesn't have " 773 "exactly two CFG successors!", MBB); 774 } else if (!matchPair(MBB->succ_begin(), TBB, FBB)) { 775 report("MBB exits via conditional branch/branch but the CFG " 776 "successors don't match the actual successors!", MBB); 777 } 778 if (MBB->empty()) { 779 report("MBB exits via conditional branch/branch but doesn't " 780 "contain any instructions!", MBB); 781 } else if (!MBB->back().isBarrier()) { 782 report("MBB exits via conditional branch/branch but doesn't end with a " 783 "barrier instruction!", MBB); 784 } else if (!MBB->back().isTerminator()) { 785 report("MBB exits via conditional branch/branch but the branch " 786 "isn't a terminator instruction!", MBB); 787 } 788 if (Cond.empty()) { 789 report("MBB exits via conditional branch/branch but there's no " 790 "condition!", MBB); 791 } 792 } else { 793 report("AnalyzeBranch returned invalid data!", MBB); 794 } 795 } 796 797 regsLive.clear(); 798 if (MRI->tracksLiveness()) { 799 for (const auto &LI : MBB->liveins()) { 800 if (!TargetRegisterInfo::isPhysicalRegister(LI.PhysReg)) { 801 report("MBB live-in list contains non-physical register", MBB); 802 continue; 803 } 804 for (MCSubRegIterator SubRegs(LI.PhysReg, TRI, /*IncludeSelf=*/true); 805 SubRegs.isValid(); ++SubRegs) 806 regsLive.insert(*SubRegs); 807 } 808 } 809 810 const MachineFrameInfo &MFI = MF->getFrameInfo(); 811 BitVector PR = MFI.getPristineRegs(*MF); 812 for (unsigned I : PR.set_bits()) { 813 for (MCSubRegIterator SubRegs(I, TRI, /*IncludeSelf=*/true); 814 SubRegs.isValid(); ++SubRegs) 815 regsLive.insert(*SubRegs); 816 } 817 818 regsKilled.clear(); 819 regsDefined.clear(); 820 821 if (Indexes) 822 lastIndex = Indexes->getMBBStartIdx(MBB); 823 } 824 825 // This function gets called for all bundle headers, including normal 826 // stand-alone unbundled instructions. 827 void MachineVerifier::visitMachineBundleBefore(const MachineInstr *MI) { 828 if (Indexes && Indexes->hasIndex(*MI)) { 829 SlotIndex idx = Indexes->getInstructionIndex(*MI); 830 if (!(idx > lastIndex)) { 831 report("Instruction index out of order", MI); 832 errs() << "Last instruction was at " << lastIndex << '\n'; 833 } 834 lastIndex = idx; 835 } 836 837 // Ensure non-terminators don't follow terminators. 838 // Ignore predicated terminators formed by if conversion. 839 // FIXME: If conversion shouldn't need to violate this rule. 840 if (MI->isTerminator() && !TII->isPredicated(*MI)) { 841 if (!FirstTerminator) 842 FirstTerminator = MI; 843 } else if (FirstTerminator) { 844 report("Non-terminator instruction after the first terminator", MI); 845 errs() << "First terminator was:\t" << *FirstTerminator; 846 } 847 } 848 849 // The operands on an INLINEASM instruction must follow a template. 850 // Verify that the flag operands make sense. 851 void MachineVerifier::verifyInlineAsm(const MachineInstr *MI) { 852 // The first two operands on INLINEASM are the asm string and global flags. 853 if (MI->getNumOperands() < 2) { 854 report("Too few operands on inline asm", MI); 855 return; 856 } 857 if (!MI->getOperand(0).isSymbol()) 858 report("Asm string must be an external symbol", MI); 859 if (!MI->getOperand(1).isImm()) 860 report("Asm flags must be an immediate", MI); 861 // Allowed flags are Extra_HasSideEffects = 1, Extra_IsAlignStack = 2, 862 // Extra_AsmDialect = 4, Extra_MayLoad = 8, and Extra_MayStore = 16, 863 // and Extra_IsConvergent = 32. 864 if (!isUInt<6>(MI->getOperand(1).getImm())) 865 report("Unknown asm flags", &MI->getOperand(1), 1); 866 867 static_assert(InlineAsm::MIOp_FirstOperand == 2, "Asm format changed"); 868 869 unsigned OpNo = InlineAsm::MIOp_FirstOperand; 870 unsigned NumOps; 871 for (unsigned e = MI->getNumOperands(); OpNo < e; OpNo += NumOps) { 872 const MachineOperand &MO = MI->getOperand(OpNo); 873 // There may be implicit ops after the fixed operands. 874 if (!MO.isImm()) 875 break; 876 NumOps = 1 + InlineAsm::getNumOperandRegisters(MO.getImm()); 877 } 878 879 if (OpNo > MI->getNumOperands()) 880 report("Missing operands in last group", MI); 881 882 // An optional MDNode follows the groups. 883 if (OpNo < MI->getNumOperands() && MI->getOperand(OpNo).isMetadata()) 884 ++OpNo; 885 886 // All trailing operands must be implicit registers. 887 for (unsigned e = MI->getNumOperands(); OpNo < e; ++OpNo) { 888 const MachineOperand &MO = MI->getOperand(OpNo); 889 if (!MO.isReg() || !MO.isImplicit()) 890 report("Expected implicit register after groups", &MO, OpNo); 891 } 892 } 893 894 /// Check that types are consistent when two operands need to have the same 895 /// number of vector elements. 896 /// \return true if the types are valid. 897 bool MachineVerifier::verifyVectorElementMatch(LLT Ty0, LLT Ty1, 898 const MachineInstr *MI) { 899 if (Ty0.isVector() != Ty1.isVector()) { 900 report("operand types must be all-vector or all-scalar", MI); 901 // Generally we try to report as many issues as possible at once, but in 902 // this case it's not clear what should we be comparing the size of the 903 // scalar with: the size of the whole vector or its lane. Instead of 904 // making an arbitrary choice and emitting not so helpful message, let's 905 // avoid the extra noise and stop here. 906 return false; 907 } 908 909 if (Ty0.isVector() && Ty0.getNumElements() != Ty1.getNumElements()) { 910 report("operand types must preserve number of vector elements", MI); 911 return false; 912 } 913 914 return true; 915 } 916 917 void MachineVerifier::verifyPreISelGenericInstruction(const MachineInstr *MI) { 918 if (isFunctionSelected) 919 report("Unexpected generic instruction in a Selected function", MI); 920 921 const MCInstrDesc &MCID = MI->getDesc(); 922 unsigned NumOps = MI->getNumOperands(); 923 924 // Check types. 925 SmallVector<LLT, 4> Types; 926 for (unsigned I = 0, E = std::min(MCID.getNumOperands(), NumOps); 927 I != E; ++I) { 928 if (!MCID.OpInfo[I].isGenericType()) 929 continue; 930 // Generic instructions specify type equality constraints between some of 931 // their operands. Make sure these are consistent. 932 size_t TypeIdx = MCID.OpInfo[I].getGenericTypeIndex(); 933 Types.resize(std::max(TypeIdx + 1, Types.size())); 934 935 const MachineOperand *MO = &MI->getOperand(I); 936 if (!MO->isReg()) { 937 report("generic instruction must use register operands", MI); 938 continue; 939 } 940 941 LLT OpTy = MRI->getType(MO->getReg()); 942 // Don't report a type mismatch if there is no actual mismatch, only a 943 // type missing, to reduce noise: 944 if (OpTy.isValid()) { 945 // Only the first valid type for a type index will be printed: don't 946 // overwrite it later so it's always clear which type was expected: 947 if (!Types[TypeIdx].isValid()) 948 Types[TypeIdx] = OpTy; 949 else if (Types[TypeIdx] != OpTy) 950 report("Type mismatch in generic instruction", MO, I, OpTy); 951 } else { 952 // Generic instructions must have types attached to their operands. 953 report("Generic instruction is missing a virtual register type", MO, I); 954 } 955 } 956 957 // Generic opcodes must not have physical register operands. 958 for (unsigned I = 0; I < MI->getNumOperands(); ++I) { 959 const MachineOperand *MO = &MI->getOperand(I); 960 if (MO->isReg() && TargetRegisterInfo::isPhysicalRegister(MO->getReg())) 961 report("Generic instruction cannot have physical register", MO, I); 962 } 963 964 // Avoid out of bounds in checks below. This was already reported earlier. 965 if (MI->getNumOperands() < MCID.getNumOperands()) 966 return; 967 968 StringRef ErrorInfo; 969 if (!TII->verifyInstruction(*MI, ErrorInfo)) 970 report(ErrorInfo.data(), MI); 971 972 // Verify properties of various specific instruction types 973 switch (MI->getOpcode()) { 974 case TargetOpcode::G_CONSTANT: 975 case TargetOpcode::G_FCONSTANT: { 976 if (MI->getNumOperands() < MCID.getNumOperands()) 977 break; 978 979 LLT DstTy = MRI->getType(MI->getOperand(0).getReg()); 980 if (DstTy.isVector()) 981 report("Instruction cannot use a vector result type", MI); 982 983 if (MI->getOpcode() == TargetOpcode::G_CONSTANT) { 984 if (!MI->getOperand(1).isCImm()) { 985 report("G_CONSTANT operand must be cimm", MI); 986 break; 987 } 988 989 const ConstantInt *CI = MI->getOperand(1).getCImm(); 990 if (CI->getBitWidth() != DstTy.getSizeInBits()) 991 report("inconsistent constant size", MI); 992 } else { 993 if (!MI->getOperand(1).isFPImm()) { 994 report("G_FCONSTANT operand must be fpimm", MI); 995 break; 996 } 997 const ConstantFP *CF = MI->getOperand(1).getFPImm(); 998 999 if (APFloat::getSizeInBits(CF->getValueAPF().getSemantics()) != 1000 DstTy.getSizeInBits()) { 1001 report("inconsistent constant size", MI); 1002 } 1003 } 1004 1005 break; 1006 } 1007 case TargetOpcode::G_LOAD: 1008 case TargetOpcode::G_STORE: 1009 case TargetOpcode::G_ZEXTLOAD: 1010 case TargetOpcode::G_SEXTLOAD: { 1011 LLT ValTy = MRI->getType(MI->getOperand(0).getReg()); 1012 LLT PtrTy = MRI->getType(MI->getOperand(1).getReg()); 1013 if (!PtrTy.isPointer()) 1014 report("Generic memory instruction must access a pointer", MI); 1015 1016 // Generic loads and stores must have a single MachineMemOperand 1017 // describing that access. 1018 if (!MI->hasOneMemOperand()) { 1019 report("Generic instruction accessing memory must have one mem operand", 1020 MI); 1021 } else { 1022 const MachineMemOperand &MMO = **MI->memoperands_begin(); 1023 if (MI->getOpcode() == TargetOpcode::G_ZEXTLOAD || 1024 MI->getOpcode() == TargetOpcode::G_SEXTLOAD) { 1025 if (MMO.getSizeInBits() >= ValTy.getSizeInBits()) 1026 report("Generic extload must have a narrower memory type", MI); 1027 } else if (MI->getOpcode() == TargetOpcode::G_LOAD) { 1028 if (MMO.getSize() > ValTy.getSizeInBytes()) 1029 report("load memory size cannot exceed result size", MI); 1030 } else if (MI->getOpcode() == TargetOpcode::G_STORE) { 1031 if (ValTy.getSizeInBytes() < MMO.getSize()) 1032 report("store memory size cannot exceed value size", MI); 1033 } 1034 } 1035 1036 break; 1037 } 1038 case TargetOpcode::G_PHI: { 1039 LLT DstTy = MRI->getType(MI->getOperand(0).getReg()); 1040 if (!DstTy.isValid() || 1041 !std::all_of(MI->operands_begin() + 1, MI->operands_end(), 1042 [this, &DstTy](const MachineOperand &MO) { 1043 if (!MO.isReg()) 1044 return true; 1045 LLT Ty = MRI->getType(MO.getReg()); 1046 if (!Ty.isValid() || (Ty != DstTy)) 1047 return false; 1048 return true; 1049 })) 1050 report("Generic Instruction G_PHI has operands with incompatible/missing " 1051 "types", 1052 MI); 1053 break; 1054 } 1055 case TargetOpcode::G_BITCAST: { 1056 LLT DstTy = MRI->getType(MI->getOperand(0).getReg()); 1057 LLT SrcTy = MRI->getType(MI->getOperand(1).getReg()); 1058 if (!DstTy.isValid() || !SrcTy.isValid()) 1059 break; 1060 1061 if (SrcTy.isPointer() != DstTy.isPointer()) 1062 report("bitcast cannot convert between pointers and other types", MI); 1063 1064 if (SrcTy.getSizeInBits() != DstTy.getSizeInBits()) 1065 report("bitcast sizes must match", MI); 1066 break; 1067 } 1068 case TargetOpcode::G_INTTOPTR: 1069 case TargetOpcode::G_PTRTOINT: 1070 case TargetOpcode::G_ADDRSPACE_CAST: { 1071 LLT DstTy = MRI->getType(MI->getOperand(0).getReg()); 1072 LLT SrcTy = MRI->getType(MI->getOperand(1).getReg()); 1073 if (!DstTy.isValid() || !SrcTy.isValid()) 1074 break; 1075 1076 verifyVectorElementMatch(DstTy, SrcTy, MI); 1077 1078 DstTy = DstTy.getScalarType(); 1079 SrcTy = SrcTy.getScalarType(); 1080 1081 if (MI->getOpcode() == TargetOpcode::G_INTTOPTR) { 1082 if (!DstTy.isPointer()) 1083 report("inttoptr result type must be a pointer", MI); 1084 if (SrcTy.isPointer()) 1085 report("inttoptr source type must not be a pointer", MI); 1086 } else if (MI->getOpcode() == TargetOpcode::G_PTRTOINT) { 1087 if (!SrcTy.isPointer()) 1088 report("ptrtoint source type must be a pointer", MI); 1089 if (DstTy.isPointer()) 1090 report("ptrtoint result type must not be a pointer", MI); 1091 } else { 1092 assert(MI->getOpcode() == TargetOpcode::G_ADDRSPACE_CAST); 1093 if (!SrcTy.isPointer() || !DstTy.isPointer()) 1094 report("addrspacecast types must be pointers", MI); 1095 else { 1096 if (SrcTy.getAddressSpace() == DstTy.getAddressSpace()) 1097 report("addrspacecast must convert different address spaces", MI); 1098 } 1099 } 1100 1101 break; 1102 } 1103 case TargetOpcode::G_GEP: { 1104 LLT DstTy = MRI->getType(MI->getOperand(0).getReg()); 1105 LLT PtrTy = MRI->getType(MI->getOperand(1).getReg()); 1106 LLT OffsetTy = MRI->getType(MI->getOperand(2).getReg()); 1107 if (!DstTy.isValid() || !PtrTy.isValid() || !OffsetTy.isValid()) 1108 break; 1109 1110 if (!PtrTy.getScalarType().isPointer()) 1111 report("gep first operand must be a pointer", MI); 1112 1113 if (OffsetTy.getScalarType().isPointer()) 1114 report("gep offset operand must not be a pointer", MI); 1115 1116 // TODO: Is the offset allowed to be a scalar with a vector? 1117 break; 1118 } 1119 case TargetOpcode::G_SEXT: 1120 case TargetOpcode::G_ZEXT: 1121 case TargetOpcode::G_ANYEXT: 1122 case TargetOpcode::G_TRUNC: 1123 case TargetOpcode::G_FPEXT: 1124 case TargetOpcode::G_FPTRUNC: { 1125 // Number of operands and presense of types is already checked (and 1126 // reported in case of any issues), so no need to report them again. As 1127 // we're trying to report as many issues as possible at once, however, the 1128 // instructions aren't guaranteed to have the right number of operands or 1129 // types attached to them at this point 1130 assert(MCID.getNumOperands() == 2 && "Expected 2 operands G_*{EXT,TRUNC}"); 1131 LLT DstTy = MRI->getType(MI->getOperand(0).getReg()); 1132 LLT SrcTy = MRI->getType(MI->getOperand(1).getReg()); 1133 if (!DstTy.isValid() || !SrcTy.isValid()) 1134 break; 1135 1136 LLT DstElTy = DstTy.getScalarType(); 1137 LLT SrcElTy = SrcTy.getScalarType(); 1138 if (DstElTy.isPointer() || SrcElTy.isPointer()) 1139 report("Generic extend/truncate can not operate on pointers", MI); 1140 1141 verifyVectorElementMatch(DstTy, SrcTy, MI); 1142 1143 unsigned DstSize = DstElTy.getSizeInBits(); 1144 unsigned SrcSize = SrcElTy.getSizeInBits(); 1145 switch (MI->getOpcode()) { 1146 default: 1147 if (DstSize <= SrcSize) 1148 report("Generic extend has destination type no larger than source", MI); 1149 break; 1150 case TargetOpcode::G_TRUNC: 1151 case TargetOpcode::G_FPTRUNC: 1152 if (DstSize >= SrcSize) 1153 report("Generic truncate has destination type no smaller than source", 1154 MI); 1155 break; 1156 } 1157 break; 1158 } 1159 case TargetOpcode::G_SELECT: { 1160 LLT SelTy = MRI->getType(MI->getOperand(0).getReg()); 1161 LLT CondTy = MRI->getType(MI->getOperand(1).getReg()); 1162 if (!SelTy.isValid() || !CondTy.isValid()) 1163 break; 1164 1165 // Scalar condition select on a vector is valid. 1166 if (CondTy.isVector()) 1167 verifyVectorElementMatch(SelTy, CondTy, MI); 1168 break; 1169 } 1170 case TargetOpcode::G_MERGE_VALUES: { 1171 // G_MERGE_VALUES should only be used to merge scalars into a larger scalar, 1172 // e.g. s2N = MERGE sN, sN 1173 // Merging multiple scalars into a vector is not allowed, should use 1174 // G_BUILD_VECTOR for that. 1175 LLT DstTy = MRI->getType(MI->getOperand(0).getReg()); 1176 LLT SrcTy = MRI->getType(MI->getOperand(1).getReg()); 1177 if (DstTy.isVector() || SrcTy.isVector()) 1178 report("G_MERGE_VALUES cannot operate on vectors", MI); 1179 break; 1180 } 1181 case TargetOpcode::G_UNMERGE_VALUES: { 1182 LLT DstTy = MRI->getType(MI->getOperand(0).getReg()); 1183 LLT SrcTy = MRI->getType(MI->getOperand(MI->getNumOperands()-1).getReg()); 1184 // For now G_UNMERGE can split vectors. 1185 for (unsigned i = 0; i < MI->getNumOperands()-1; ++i) { 1186 if (MRI->getType(MI->getOperand(i).getReg()) != DstTy) 1187 report("G_UNMERGE_VALUES destination types do not match", MI); 1188 } 1189 if (SrcTy.getSizeInBits() != 1190 (DstTy.getSizeInBits() * (MI->getNumOperands() - 1))) { 1191 report("G_UNMERGE_VALUES source operand does not cover dest operands", 1192 MI); 1193 } 1194 break; 1195 } 1196 case TargetOpcode::G_BUILD_VECTOR: { 1197 // Source types must be scalars, dest type a vector. Total size of scalars 1198 // must match the dest vector size. 1199 LLT DstTy = MRI->getType(MI->getOperand(0).getReg()); 1200 LLT SrcEltTy = MRI->getType(MI->getOperand(1).getReg()); 1201 if (!DstTy.isVector() || SrcEltTy.isVector()) { 1202 report("G_BUILD_VECTOR must produce a vector from scalar operands", MI); 1203 break; 1204 } 1205 1206 if (DstTy.getElementType() != SrcEltTy) 1207 report("G_BUILD_VECTOR result element type must match source type", MI); 1208 1209 if (DstTy.getNumElements() != MI->getNumOperands() - 1) 1210 report("G_BUILD_VECTOR must have an operand for each elemement", MI); 1211 1212 for (unsigned i = 2; i < MI->getNumOperands(); ++i) { 1213 if (MRI->getType(MI->getOperand(1).getReg()) != 1214 MRI->getType(MI->getOperand(i).getReg())) 1215 report("G_BUILD_VECTOR source operand types are not homogeneous", MI); 1216 } 1217 1218 break; 1219 } 1220 case TargetOpcode::G_BUILD_VECTOR_TRUNC: { 1221 // Source types must be scalars, dest type a vector. Scalar types must be 1222 // larger than the dest vector elt type, as this is a truncating operation. 1223 LLT DstTy = MRI->getType(MI->getOperand(0).getReg()); 1224 LLT SrcEltTy = MRI->getType(MI->getOperand(1).getReg()); 1225 if (!DstTy.isVector() || SrcEltTy.isVector()) 1226 report("G_BUILD_VECTOR_TRUNC must produce a vector from scalar operands", 1227 MI); 1228 for (unsigned i = 2; i < MI->getNumOperands(); ++i) { 1229 if (MRI->getType(MI->getOperand(1).getReg()) != 1230 MRI->getType(MI->getOperand(i).getReg())) 1231 report("G_BUILD_VECTOR_TRUNC source operand types are not homogeneous", 1232 MI); 1233 } 1234 if (SrcEltTy.getSizeInBits() <= DstTy.getElementType().getSizeInBits()) 1235 report("G_BUILD_VECTOR_TRUNC source operand types are not larger than " 1236 "dest elt type", 1237 MI); 1238 break; 1239 } 1240 case TargetOpcode::G_CONCAT_VECTORS: { 1241 // Source types should be vectors, and total size should match the dest 1242 // vector size. 1243 LLT DstTy = MRI->getType(MI->getOperand(0).getReg()); 1244 LLT SrcTy = MRI->getType(MI->getOperand(1).getReg()); 1245 if (!DstTy.isVector() || !SrcTy.isVector()) 1246 report("G_CONCAT_VECTOR requires vector source and destination operands", 1247 MI); 1248 for (unsigned i = 2; i < MI->getNumOperands(); ++i) { 1249 if (MRI->getType(MI->getOperand(1).getReg()) != 1250 MRI->getType(MI->getOperand(i).getReg())) 1251 report("G_CONCAT_VECTOR source operand types are not homogeneous", MI); 1252 } 1253 if (DstTy.getNumElements() != 1254 SrcTy.getNumElements() * (MI->getNumOperands() - 1)) 1255 report("G_CONCAT_VECTOR num dest and source elements should match", MI); 1256 break; 1257 } 1258 case TargetOpcode::G_ICMP: 1259 case TargetOpcode::G_FCMP: { 1260 LLT DstTy = MRI->getType(MI->getOperand(0).getReg()); 1261 LLT SrcTy = MRI->getType(MI->getOperand(2).getReg()); 1262 1263 if ((DstTy.isVector() != SrcTy.isVector()) || 1264 (DstTy.isVector() && DstTy.getNumElements() != SrcTy.getNumElements())) 1265 report("Generic vector icmp/fcmp must preserve number of lanes", MI); 1266 1267 break; 1268 } 1269 case TargetOpcode::G_EXTRACT: { 1270 const MachineOperand &SrcOp = MI->getOperand(1); 1271 if (!SrcOp.isReg()) { 1272 report("extract source must be a register", MI); 1273 break; 1274 } 1275 1276 const MachineOperand &OffsetOp = MI->getOperand(2); 1277 if (!OffsetOp.isImm()) { 1278 report("extract offset must be a constant", MI); 1279 break; 1280 } 1281 1282 unsigned DstSize = MRI->getType(MI->getOperand(0).getReg()).getSizeInBits(); 1283 unsigned SrcSize = MRI->getType(SrcOp.getReg()).getSizeInBits(); 1284 if (SrcSize == DstSize) 1285 report("extract source must be larger than result", MI); 1286 1287 if (DstSize + OffsetOp.getImm() > SrcSize) 1288 report("extract reads past end of register", MI); 1289 break; 1290 } 1291 case TargetOpcode::G_INSERT: { 1292 const MachineOperand &SrcOp = MI->getOperand(2); 1293 if (!SrcOp.isReg()) { 1294 report("insert source must be a register", MI); 1295 break; 1296 } 1297 1298 const MachineOperand &OffsetOp = MI->getOperand(3); 1299 if (!OffsetOp.isImm()) { 1300 report("insert offset must be a constant", MI); 1301 break; 1302 } 1303 1304 unsigned DstSize = MRI->getType(MI->getOperand(0).getReg()).getSizeInBits(); 1305 unsigned SrcSize = MRI->getType(SrcOp.getReg()).getSizeInBits(); 1306 1307 if (DstSize <= SrcSize) 1308 report("inserted size must be smaller than total register", MI); 1309 1310 if (SrcSize + OffsetOp.getImm() > DstSize) 1311 report("insert writes past end of register", MI); 1312 1313 break; 1314 } 1315 case TargetOpcode::G_JUMP_TABLE: { 1316 if (!MI->getOperand(1).isJTI()) 1317 report("G_JUMP_TABLE source operand must be a jump table index", MI); 1318 LLT DstTy = MRI->getType(MI->getOperand(0).getReg()); 1319 if (!DstTy.isPointer()) 1320 report("G_JUMP_TABLE dest operand must have a pointer type", MI); 1321 break; 1322 } 1323 case TargetOpcode::G_BRJT: { 1324 if (!MRI->getType(MI->getOperand(0).getReg()).isPointer()) 1325 report("G_BRJT src operand 0 must be a pointer type", MI); 1326 1327 if (!MI->getOperand(1).isJTI()) 1328 report("G_BRJT src operand 1 must be a jump table index", MI); 1329 1330 const auto &IdxOp = MI->getOperand(2); 1331 if (!IdxOp.isReg() || MRI->getType(IdxOp.getReg()).isPointer()) 1332 report("G_BRJT src operand 2 must be a scalar reg type", MI); 1333 break; 1334 } 1335 case TargetOpcode::G_INTRINSIC: 1336 case TargetOpcode::G_INTRINSIC_W_SIDE_EFFECTS: { 1337 // TODO: Should verify number of def and use operands, but the current 1338 // interface requires passing in IR types for mangling. 1339 const MachineOperand &IntrIDOp = MI->getOperand(MI->getNumExplicitDefs()); 1340 if (!IntrIDOp.isIntrinsicID()) { 1341 report("G_INTRINSIC first src operand must be an intrinsic ID", MI); 1342 break; 1343 } 1344 1345 bool NoSideEffects = MI->getOpcode() == TargetOpcode::G_INTRINSIC; 1346 unsigned IntrID = IntrIDOp.getIntrinsicID(); 1347 if (IntrID != 0 && IntrID < Intrinsic::num_intrinsics) { 1348 AttributeList Attrs 1349 = Intrinsic::getAttributes(MF->getFunction().getContext(), 1350 static_cast<Intrinsic::ID>(IntrID)); 1351 bool DeclHasSideEffects = !Attrs.hasFnAttribute(Attribute::ReadNone); 1352 if (NoSideEffects && DeclHasSideEffects) { 1353 report("G_INTRINSIC used with intrinsic that accesses memory", MI); 1354 break; 1355 } 1356 if (!NoSideEffects && !DeclHasSideEffects) { 1357 report("G_INTRINSIC_W_SIDE_EFFECTS used with readnone intrinsic", MI); 1358 break; 1359 } 1360 } 1361 1362 break; 1363 } 1364 default: 1365 break; 1366 } 1367 } 1368 1369 void MachineVerifier::visitMachineInstrBefore(const MachineInstr *MI) { 1370 const MCInstrDesc &MCID = MI->getDesc(); 1371 if (MI->getNumOperands() < MCID.getNumOperands()) { 1372 report("Too few operands", MI); 1373 errs() << MCID.getNumOperands() << " operands expected, but " 1374 << MI->getNumOperands() << " given.\n"; 1375 } 1376 1377 if (MI->isPHI()) { 1378 if (MF->getProperties().hasProperty( 1379 MachineFunctionProperties::Property::NoPHIs)) 1380 report("Found PHI instruction with NoPHIs property set", MI); 1381 1382 if (FirstNonPHI) 1383 report("Found PHI instruction after non-PHI", MI); 1384 } else if (FirstNonPHI == nullptr) 1385 FirstNonPHI = MI; 1386 1387 // Check the tied operands. 1388 if (MI->isInlineAsm()) 1389 verifyInlineAsm(MI); 1390 1391 // Check the MachineMemOperands for basic consistency. 1392 for (MachineInstr::mmo_iterator I = MI->memoperands_begin(), 1393 E = MI->memoperands_end(); 1394 I != E; ++I) { 1395 if ((*I)->isLoad() && !MI->mayLoad()) 1396 report("Missing mayLoad flag", MI); 1397 if ((*I)->isStore() && !MI->mayStore()) 1398 report("Missing mayStore flag", MI); 1399 } 1400 1401 // Debug values must not have a slot index. 1402 // Other instructions must have one, unless they are inside a bundle. 1403 if (LiveInts) { 1404 bool mapped = !LiveInts->isNotInMIMap(*MI); 1405 if (MI->isDebugInstr()) { 1406 if (mapped) 1407 report("Debug instruction has a slot index", MI); 1408 } else if (MI->isInsideBundle()) { 1409 if (mapped) 1410 report("Instruction inside bundle has a slot index", MI); 1411 } else { 1412 if (!mapped) 1413 report("Missing slot index", MI); 1414 } 1415 } 1416 1417 if (isPreISelGenericOpcode(MCID.getOpcode())) { 1418 verifyPreISelGenericInstruction(MI); 1419 return; 1420 } 1421 1422 StringRef ErrorInfo; 1423 if (!TII->verifyInstruction(*MI, ErrorInfo)) 1424 report(ErrorInfo.data(), MI); 1425 1426 // Verify properties of various specific instruction types 1427 switch (MI->getOpcode()) { 1428 case TargetOpcode::COPY: { 1429 if (foundErrors) 1430 break; 1431 const MachineOperand &DstOp = MI->getOperand(0); 1432 const MachineOperand &SrcOp = MI->getOperand(1); 1433 LLT DstTy = MRI->getType(DstOp.getReg()); 1434 LLT SrcTy = MRI->getType(SrcOp.getReg()); 1435 if (SrcTy.isValid() && DstTy.isValid()) { 1436 // If both types are valid, check that the types are the same. 1437 if (SrcTy != DstTy) { 1438 report("Copy Instruction is illegal with mismatching types", MI); 1439 errs() << "Def = " << DstTy << ", Src = " << SrcTy << "\n"; 1440 } 1441 } 1442 if (SrcTy.isValid() || DstTy.isValid()) { 1443 // If one of them have valid types, let's just check they have the same 1444 // size. 1445 unsigned SrcSize = TRI->getRegSizeInBits(SrcOp.getReg(), *MRI); 1446 unsigned DstSize = TRI->getRegSizeInBits(DstOp.getReg(), *MRI); 1447 assert(SrcSize && "Expecting size here"); 1448 assert(DstSize && "Expecting size here"); 1449 if (SrcSize != DstSize) 1450 if (!DstOp.getSubReg() && !SrcOp.getSubReg()) { 1451 report("Copy Instruction is illegal with mismatching sizes", MI); 1452 errs() << "Def Size = " << DstSize << ", Src Size = " << SrcSize 1453 << "\n"; 1454 } 1455 } 1456 break; 1457 } 1458 case TargetOpcode::STATEPOINT: 1459 if (!MI->getOperand(StatepointOpers::IDPos).isImm() || 1460 !MI->getOperand(StatepointOpers::NBytesPos).isImm() || 1461 !MI->getOperand(StatepointOpers::NCallArgsPos).isImm()) 1462 report("meta operands to STATEPOINT not constant!", MI); 1463 break; 1464 1465 auto VerifyStackMapConstant = [&](unsigned Offset) { 1466 if (!MI->getOperand(Offset).isImm() || 1467 MI->getOperand(Offset).getImm() != StackMaps::ConstantOp || 1468 !MI->getOperand(Offset + 1).isImm()) 1469 report("stack map constant to STATEPOINT not well formed!", MI); 1470 }; 1471 const unsigned VarStart = StatepointOpers(MI).getVarIdx(); 1472 VerifyStackMapConstant(VarStart + StatepointOpers::CCOffset); 1473 VerifyStackMapConstant(VarStart + StatepointOpers::FlagsOffset); 1474 VerifyStackMapConstant(VarStart + StatepointOpers::NumDeoptOperandsOffset); 1475 1476 // TODO: verify we have properly encoded deopt arguments 1477 break; 1478 } 1479 } 1480 1481 void 1482 MachineVerifier::visitMachineOperand(const MachineOperand *MO, unsigned MONum) { 1483 const MachineInstr *MI = MO->getParent(); 1484 const MCInstrDesc &MCID = MI->getDesc(); 1485 unsigned NumDefs = MCID.getNumDefs(); 1486 if (MCID.getOpcode() == TargetOpcode::PATCHPOINT) 1487 NumDefs = (MONum == 0 && MO->isReg()) ? NumDefs : 0; 1488 1489 // The first MCID.NumDefs operands must be explicit register defines 1490 if (MONum < NumDefs) { 1491 const MCOperandInfo &MCOI = MCID.OpInfo[MONum]; 1492 if (!MO->isReg()) 1493 report("Explicit definition must be a register", MO, MONum); 1494 else if (!MO->isDef() && !MCOI.isOptionalDef()) 1495 report("Explicit definition marked as use", MO, MONum); 1496 else if (MO->isImplicit()) 1497 report("Explicit definition marked as implicit", MO, MONum); 1498 } else if (MONum < MCID.getNumOperands()) { 1499 const MCOperandInfo &MCOI = MCID.OpInfo[MONum]; 1500 // Don't check if it's the last operand in a variadic instruction. See, 1501 // e.g., LDM_RET in the arm back end. 1502 if (MO->isReg() && 1503 !(MI->isVariadic() && MONum == MCID.getNumOperands()-1)) { 1504 if (MO->isDef() && !MCOI.isOptionalDef()) 1505 report("Explicit operand marked as def", MO, MONum); 1506 if (MO->isImplicit()) 1507 report("Explicit operand marked as implicit", MO, MONum); 1508 } 1509 1510 int TiedTo = MCID.getOperandConstraint(MONum, MCOI::TIED_TO); 1511 if (TiedTo != -1) { 1512 if (!MO->isReg()) 1513 report("Tied use must be a register", MO, MONum); 1514 else if (!MO->isTied()) 1515 report("Operand should be tied", MO, MONum); 1516 else if (unsigned(TiedTo) != MI->findTiedOperandIdx(MONum)) 1517 report("Tied def doesn't match MCInstrDesc", MO, MONum); 1518 else if (TargetRegisterInfo::isPhysicalRegister(MO->getReg())) { 1519 const MachineOperand &MOTied = MI->getOperand(TiedTo); 1520 if (!MOTied.isReg()) 1521 report("Tied counterpart must be a register", &MOTied, TiedTo); 1522 else if (TargetRegisterInfo::isPhysicalRegister(MOTied.getReg()) && 1523 MO->getReg() != MOTied.getReg()) 1524 report("Tied physical registers must match.", &MOTied, TiedTo); 1525 } 1526 } else if (MO->isReg() && MO->isTied()) 1527 report("Explicit operand should not be tied", MO, MONum); 1528 } else { 1529 // ARM adds %reg0 operands to indicate predicates. We'll allow that. 1530 if (MO->isReg() && !MO->isImplicit() && !MI->isVariadic() && MO->getReg()) 1531 report("Extra explicit operand on non-variadic instruction", MO, MONum); 1532 } 1533 1534 switch (MO->getType()) { 1535 case MachineOperand::MO_Register: { 1536 const unsigned Reg = MO->getReg(); 1537 if (!Reg) 1538 return; 1539 if (MRI->tracksLiveness() && !MI->isDebugValue()) 1540 checkLiveness(MO, MONum); 1541 1542 // Verify the consistency of tied operands. 1543 if (MO->isTied()) { 1544 unsigned OtherIdx = MI->findTiedOperandIdx(MONum); 1545 const MachineOperand &OtherMO = MI->getOperand(OtherIdx); 1546 if (!OtherMO.isReg()) 1547 report("Must be tied to a register", MO, MONum); 1548 if (!OtherMO.isTied()) 1549 report("Missing tie flags on tied operand", MO, MONum); 1550 if (MI->findTiedOperandIdx(OtherIdx) != MONum) 1551 report("Inconsistent tie links", MO, MONum); 1552 if (MONum < MCID.getNumDefs()) { 1553 if (OtherIdx < MCID.getNumOperands()) { 1554 if (-1 == MCID.getOperandConstraint(OtherIdx, MCOI::TIED_TO)) 1555 report("Explicit def tied to explicit use without tie constraint", 1556 MO, MONum); 1557 } else { 1558 if (!OtherMO.isImplicit()) 1559 report("Explicit def should be tied to implicit use", MO, MONum); 1560 } 1561 } 1562 } 1563 1564 // Verify two-address constraints after leaving SSA form. 1565 unsigned DefIdx; 1566 if (!MRI->isSSA() && MO->isUse() && 1567 MI->isRegTiedToDefOperand(MONum, &DefIdx) && 1568 Reg != MI->getOperand(DefIdx).getReg()) 1569 report("Two-address instruction operands must be identical", MO, MONum); 1570 1571 // Check register classes. 1572 unsigned SubIdx = MO->getSubReg(); 1573 1574 if (TargetRegisterInfo::isPhysicalRegister(Reg)) { 1575 if (SubIdx) { 1576 report("Illegal subregister index for physical register", MO, MONum); 1577 return; 1578 } 1579 if (MONum < MCID.getNumOperands()) { 1580 if (const TargetRegisterClass *DRC = 1581 TII->getRegClass(MCID, MONum, TRI, *MF)) { 1582 if (!DRC->contains(Reg)) { 1583 report("Illegal physical register for instruction", MO, MONum); 1584 errs() << printReg(Reg, TRI) << " is not a " 1585 << TRI->getRegClassName(DRC) << " register.\n"; 1586 } 1587 } 1588 } 1589 if (MO->isRenamable()) { 1590 if (MRI->isReserved(Reg)) { 1591 report("isRenamable set on reserved register", MO, MONum); 1592 return; 1593 } 1594 } 1595 if (MI->isDebugValue() && MO->isUse() && !MO->isDebug()) { 1596 report("Use-reg is not IsDebug in a DBG_VALUE", MO, MONum); 1597 return; 1598 } 1599 } else { 1600 // Virtual register. 1601 const TargetRegisterClass *RC = MRI->getRegClassOrNull(Reg); 1602 if (!RC) { 1603 // This is a generic virtual register. 1604 1605 // If we're post-Select, we can't have gvregs anymore. 1606 if (isFunctionSelected) { 1607 report("Generic virtual register invalid in a Selected function", 1608 MO, MONum); 1609 return; 1610 } 1611 1612 // The gvreg must have a type and it must not have a SubIdx. 1613 LLT Ty = MRI->getType(Reg); 1614 if (!Ty.isValid()) { 1615 report("Generic virtual register must have a valid type", MO, 1616 MONum); 1617 return; 1618 } 1619 1620 const RegisterBank *RegBank = MRI->getRegBankOrNull(Reg); 1621 1622 // If we're post-RegBankSelect, the gvreg must have a bank. 1623 if (!RegBank && isFunctionRegBankSelected) { 1624 report("Generic virtual register must have a bank in a " 1625 "RegBankSelected function", 1626 MO, MONum); 1627 return; 1628 } 1629 1630 // Make sure the register fits into its register bank if any. 1631 if (RegBank && Ty.isValid() && 1632 RegBank->getSize() < Ty.getSizeInBits()) { 1633 report("Register bank is too small for virtual register", MO, 1634 MONum); 1635 errs() << "Register bank " << RegBank->getName() << " too small(" 1636 << RegBank->getSize() << ") to fit " << Ty.getSizeInBits() 1637 << "-bits\n"; 1638 return; 1639 } 1640 if (SubIdx) { 1641 report("Generic virtual register does not allow subregister index", MO, 1642 MONum); 1643 return; 1644 } 1645 1646 // If this is a target specific instruction and this operand 1647 // has register class constraint, the virtual register must 1648 // comply to it. 1649 if (!isPreISelGenericOpcode(MCID.getOpcode()) && 1650 MONum < MCID.getNumOperands() && 1651 TII->getRegClass(MCID, MONum, TRI, *MF)) { 1652 report("Virtual register does not match instruction constraint", MO, 1653 MONum); 1654 errs() << "Expect register class " 1655 << TRI->getRegClassName( 1656 TII->getRegClass(MCID, MONum, TRI, *MF)) 1657 << " but got nothing\n"; 1658 return; 1659 } 1660 1661 break; 1662 } 1663 if (SubIdx) { 1664 const TargetRegisterClass *SRC = 1665 TRI->getSubClassWithSubReg(RC, SubIdx); 1666 if (!SRC) { 1667 report("Invalid subregister index for virtual register", MO, MONum); 1668 errs() << "Register class " << TRI->getRegClassName(RC) 1669 << " does not support subreg index " << SubIdx << "\n"; 1670 return; 1671 } 1672 if (RC != SRC) { 1673 report("Invalid register class for subregister index", MO, MONum); 1674 errs() << "Register class " << TRI->getRegClassName(RC) 1675 << " does not fully support subreg index " << SubIdx << "\n"; 1676 return; 1677 } 1678 } 1679 if (MONum < MCID.getNumOperands()) { 1680 if (const TargetRegisterClass *DRC = 1681 TII->getRegClass(MCID, MONum, TRI, *MF)) { 1682 if (SubIdx) { 1683 const TargetRegisterClass *SuperRC = 1684 TRI->getLargestLegalSuperClass(RC, *MF); 1685 if (!SuperRC) { 1686 report("No largest legal super class exists.", MO, MONum); 1687 return; 1688 } 1689 DRC = TRI->getMatchingSuperRegClass(SuperRC, DRC, SubIdx); 1690 if (!DRC) { 1691 report("No matching super-reg register class.", MO, MONum); 1692 return; 1693 } 1694 } 1695 if (!RC->hasSuperClassEq(DRC)) { 1696 report("Illegal virtual register for instruction", MO, MONum); 1697 errs() << "Expected a " << TRI->getRegClassName(DRC) 1698 << " register, but got a " << TRI->getRegClassName(RC) 1699 << " register\n"; 1700 } 1701 } 1702 } 1703 } 1704 break; 1705 } 1706 1707 case MachineOperand::MO_RegisterMask: 1708 regMasks.push_back(MO->getRegMask()); 1709 break; 1710 1711 case MachineOperand::MO_MachineBasicBlock: 1712 if (MI->isPHI() && !MO->getMBB()->isSuccessor(MI->getParent())) 1713 report("PHI operand is not in the CFG", MO, MONum); 1714 break; 1715 1716 case MachineOperand::MO_FrameIndex: 1717 if (LiveStks && LiveStks->hasInterval(MO->getIndex()) && 1718 LiveInts && !LiveInts->isNotInMIMap(*MI)) { 1719 int FI = MO->getIndex(); 1720 LiveInterval &LI = LiveStks->getInterval(FI); 1721 SlotIndex Idx = LiveInts->getInstructionIndex(*MI); 1722 1723 bool stores = MI->mayStore(); 1724 bool loads = MI->mayLoad(); 1725 // For a memory-to-memory move, we need to check if the frame 1726 // index is used for storing or loading, by inspecting the 1727 // memory operands. 1728 if (stores && loads) { 1729 for (auto *MMO : MI->memoperands()) { 1730 const PseudoSourceValue *PSV = MMO->getPseudoValue(); 1731 if (PSV == nullptr) continue; 1732 const FixedStackPseudoSourceValue *Value = 1733 dyn_cast<FixedStackPseudoSourceValue>(PSV); 1734 if (Value == nullptr) continue; 1735 if (Value->getFrameIndex() != FI) continue; 1736 1737 if (MMO->isStore()) 1738 loads = false; 1739 else 1740 stores = false; 1741 break; 1742 } 1743 if (loads == stores) 1744 report("Missing fixed stack memoperand.", MI); 1745 } 1746 if (loads && !LI.liveAt(Idx.getRegSlot(true))) { 1747 report("Instruction loads from dead spill slot", MO, MONum); 1748 errs() << "Live stack: " << LI << '\n'; 1749 } 1750 if (stores && !LI.liveAt(Idx.getRegSlot())) { 1751 report("Instruction stores to dead spill slot", MO, MONum); 1752 errs() << "Live stack: " << LI << '\n'; 1753 } 1754 } 1755 break; 1756 1757 default: 1758 break; 1759 } 1760 } 1761 1762 void MachineVerifier::checkLivenessAtUse(const MachineOperand *MO, 1763 unsigned MONum, SlotIndex UseIdx, const LiveRange &LR, unsigned VRegOrUnit, 1764 LaneBitmask LaneMask) { 1765 LiveQueryResult LRQ = LR.Query(UseIdx); 1766 // Check if we have a segment at the use, note however that we only need one 1767 // live subregister range, the others may be dead. 1768 if (!LRQ.valueIn() && LaneMask.none()) { 1769 report("No live segment at use", MO, MONum); 1770 report_context_liverange(LR); 1771 report_context_vreg_regunit(VRegOrUnit); 1772 report_context(UseIdx); 1773 } 1774 if (MO->isKill() && !LRQ.isKill()) { 1775 report("Live range continues after kill flag", MO, MONum); 1776 report_context_liverange(LR); 1777 report_context_vreg_regunit(VRegOrUnit); 1778 if (LaneMask.any()) 1779 report_context_lanemask(LaneMask); 1780 report_context(UseIdx); 1781 } 1782 } 1783 1784 void MachineVerifier::checkLivenessAtDef(const MachineOperand *MO, 1785 unsigned MONum, SlotIndex DefIdx, const LiveRange &LR, unsigned VRegOrUnit, 1786 bool SubRangeCheck, LaneBitmask LaneMask) { 1787 if (const VNInfo *VNI = LR.getVNInfoAt(DefIdx)) { 1788 assert(VNI && "NULL valno is not allowed"); 1789 if (VNI->def != DefIdx) { 1790 report("Inconsistent valno->def", MO, MONum); 1791 report_context_liverange(LR); 1792 report_context_vreg_regunit(VRegOrUnit); 1793 if (LaneMask.any()) 1794 report_context_lanemask(LaneMask); 1795 report_context(*VNI); 1796 report_context(DefIdx); 1797 } 1798 } else { 1799 report("No live segment at def", MO, MONum); 1800 report_context_liverange(LR); 1801 report_context_vreg_regunit(VRegOrUnit); 1802 if (LaneMask.any()) 1803 report_context_lanemask(LaneMask); 1804 report_context(DefIdx); 1805 } 1806 // Check that, if the dead def flag is present, LiveInts agree. 1807 if (MO->isDead()) { 1808 LiveQueryResult LRQ = LR.Query(DefIdx); 1809 if (!LRQ.isDeadDef()) { 1810 assert(TargetRegisterInfo::isVirtualRegister(VRegOrUnit) && 1811 "Expecting a virtual register."); 1812 // A dead subreg def only tells us that the specific subreg is dead. There 1813 // could be other non-dead defs of other subregs, or we could have other 1814 // parts of the register being live through the instruction. So unless we 1815 // are checking liveness for a subrange it is ok for the live range to 1816 // continue, given that we have a dead def of a subregister. 1817 if (SubRangeCheck || MO->getSubReg() == 0) { 1818 report("Live range continues after dead def flag", MO, MONum); 1819 report_context_liverange(LR); 1820 report_context_vreg_regunit(VRegOrUnit); 1821 if (LaneMask.any()) 1822 report_context_lanemask(LaneMask); 1823 } 1824 } 1825 } 1826 } 1827 1828 void MachineVerifier::checkLiveness(const MachineOperand *MO, unsigned MONum) { 1829 const MachineInstr *MI = MO->getParent(); 1830 const unsigned Reg = MO->getReg(); 1831 1832 // Both use and def operands can read a register. 1833 if (MO->readsReg()) { 1834 if (MO->isKill()) 1835 addRegWithSubRegs(regsKilled, Reg); 1836 1837 // Check that LiveVars knows this kill. 1838 if (LiveVars && TargetRegisterInfo::isVirtualRegister(Reg) && 1839 MO->isKill()) { 1840 LiveVariables::VarInfo &VI = LiveVars->getVarInfo(Reg); 1841 if (!is_contained(VI.Kills, MI)) 1842 report("Kill missing from LiveVariables", MO, MONum); 1843 } 1844 1845 // Check LiveInts liveness and kill. 1846 if (LiveInts && !LiveInts->isNotInMIMap(*MI)) { 1847 SlotIndex UseIdx = LiveInts->getInstructionIndex(*MI); 1848 // Check the cached regunit intervals. 1849 if (TargetRegisterInfo::isPhysicalRegister(Reg) && !isReserved(Reg)) { 1850 for (MCRegUnitIterator Units(Reg, TRI); Units.isValid(); ++Units) { 1851 if (MRI->isReservedRegUnit(*Units)) 1852 continue; 1853 if (const LiveRange *LR = LiveInts->getCachedRegUnit(*Units)) 1854 checkLivenessAtUse(MO, MONum, UseIdx, *LR, *Units); 1855 } 1856 } 1857 1858 if (TargetRegisterInfo::isVirtualRegister(Reg)) { 1859 if (LiveInts->hasInterval(Reg)) { 1860 // This is a virtual register interval. 1861 const LiveInterval &LI = LiveInts->getInterval(Reg); 1862 checkLivenessAtUse(MO, MONum, UseIdx, LI, Reg); 1863 1864 if (LI.hasSubRanges() && !MO->isDef()) { 1865 unsigned SubRegIdx = MO->getSubReg(); 1866 LaneBitmask MOMask = SubRegIdx != 0 1867 ? TRI->getSubRegIndexLaneMask(SubRegIdx) 1868 : MRI->getMaxLaneMaskForVReg(Reg); 1869 LaneBitmask LiveInMask; 1870 for (const LiveInterval::SubRange &SR : LI.subranges()) { 1871 if ((MOMask & SR.LaneMask).none()) 1872 continue; 1873 checkLivenessAtUse(MO, MONum, UseIdx, SR, Reg, SR.LaneMask); 1874 LiveQueryResult LRQ = SR.Query(UseIdx); 1875 if (LRQ.valueIn()) 1876 LiveInMask |= SR.LaneMask; 1877 } 1878 // At least parts of the register has to be live at the use. 1879 if ((LiveInMask & MOMask).none()) { 1880 report("No live subrange at use", MO, MONum); 1881 report_context(LI); 1882 report_context(UseIdx); 1883 } 1884 } 1885 } else { 1886 report("Virtual register has no live interval", MO, MONum); 1887 } 1888 } 1889 } 1890 1891 // Use of a dead register. 1892 if (!regsLive.count(Reg)) { 1893 if (TargetRegisterInfo::isPhysicalRegister(Reg)) { 1894 // Reserved registers may be used even when 'dead'. 1895 bool Bad = !isReserved(Reg); 1896 // We are fine if just any subregister has a defined value. 1897 if (Bad) { 1898 for (MCSubRegIterator SubRegs(Reg, TRI); SubRegs.isValid(); 1899 ++SubRegs) { 1900 if (regsLive.count(*SubRegs)) { 1901 Bad = false; 1902 break; 1903 } 1904 } 1905 } 1906 // If there is an additional implicit-use of a super register we stop 1907 // here. By definition we are fine if the super register is not 1908 // (completely) dead, if the complete super register is dead we will 1909 // get a report for its operand. 1910 if (Bad) { 1911 for (const MachineOperand &MOP : MI->uses()) { 1912 if (!MOP.isReg() || !MOP.isImplicit()) 1913 continue; 1914 1915 if (!TargetRegisterInfo::isPhysicalRegister(MOP.getReg())) 1916 continue; 1917 1918 for (MCSubRegIterator SubRegs(MOP.getReg(), TRI); SubRegs.isValid(); 1919 ++SubRegs) { 1920 if (*SubRegs == Reg) { 1921 Bad = false; 1922 break; 1923 } 1924 } 1925 } 1926 } 1927 if (Bad) 1928 report("Using an undefined physical register", MO, MONum); 1929 } else if (MRI->def_empty(Reg)) { 1930 report("Reading virtual register without a def", MO, MONum); 1931 } else { 1932 BBInfo &MInfo = MBBInfoMap[MI->getParent()]; 1933 // We don't know which virtual registers are live in, so only complain 1934 // if vreg was killed in this MBB. Otherwise keep track of vregs that 1935 // must be live in. PHI instructions are handled separately. 1936 if (MInfo.regsKilled.count(Reg)) 1937 report("Using a killed virtual register", MO, MONum); 1938 else if (!MI->isPHI()) 1939 MInfo.vregsLiveIn.insert(std::make_pair(Reg, MI)); 1940 } 1941 } 1942 } 1943 1944 if (MO->isDef()) { 1945 // Register defined. 1946 // TODO: verify that earlyclobber ops are not used. 1947 if (MO->isDead()) 1948 addRegWithSubRegs(regsDead, Reg); 1949 else 1950 addRegWithSubRegs(regsDefined, Reg); 1951 1952 // Verify SSA form. 1953 if (MRI->isSSA() && TargetRegisterInfo::isVirtualRegister(Reg) && 1954 std::next(MRI->def_begin(Reg)) != MRI->def_end()) 1955 report("Multiple virtual register defs in SSA form", MO, MONum); 1956 1957 // Check LiveInts for a live segment, but only for virtual registers. 1958 if (LiveInts && !LiveInts->isNotInMIMap(*MI)) { 1959 SlotIndex DefIdx = LiveInts->getInstructionIndex(*MI); 1960 DefIdx = DefIdx.getRegSlot(MO->isEarlyClobber()); 1961 1962 if (TargetRegisterInfo::isVirtualRegister(Reg)) { 1963 if (LiveInts->hasInterval(Reg)) { 1964 const LiveInterval &LI = LiveInts->getInterval(Reg); 1965 checkLivenessAtDef(MO, MONum, DefIdx, LI, Reg); 1966 1967 if (LI.hasSubRanges()) { 1968 unsigned SubRegIdx = MO->getSubReg(); 1969 LaneBitmask MOMask = SubRegIdx != 0 1970 ? TRI->getSubRegIndexLaneMask(SubRegIdx) 1971 : MRI->getMaxLaneMaskForVReg(Reg); 1972 for (const LiveInterval::SubRange &SR : LI.subranges()) { 1973 if ((SR.LaneMask & MOMask).none()) 1974 continue; 1975 checkLivenessAtDef(MO, MONum, DefIdx, SR, Reg, true, SR.LaneMask); 1976 } 1977 } 1978 } else { 1979 report("Virtual register has no Live interval", MO, MONum); 1980 } 1981 } 1982 } 1983 } 1984 } 1985 1986 void MachineVerifier::visitMachineInstrAfter(const MachineInstr *MI) {} 1987 1988 // This function gets called after visiting all instructions in a bundle. The 1989 // argument points to the bundle header. 1990 // Normal stand-alone instructions are also considered 'bundles', and this 1991 // function is called for all of them. 1992 void MachineVerifier::visitMachineBundleAfter(const MachineInstr *MI) { 1993 BBInfo &MInfo = MBBInfoMap[MI->getParent()]; 1994 set_union(MInfo.regsKilled, regsKilled); 1995 set_subtract(regsLive, regsKilled); regsKilled.clear(); 1996 // Kill any masked registers. 1997 while (!regMasks.empty()) { 1998 const uint32_t *Mask = regMasks.pop_back_val(); 1999 for (RegSet::iterator I = regsLive.begin(), E = regsLive.end(); I != E; ++I) 2000 if (TargetRegisterInfo::isPhysicalRegister(*I) && 2001 MachineOperand::clobbersPhysReg(Mask, *I)) 2002 regsDead.push_back(*I); 2003 } 2004 set_subtract(regsLive, regsDead); regsDead.clear(); 2005 set_union(regsLive, regsDefined); regsDefined.clear(); 2006 } 2007 2008 void 2009 MachineVerifier::visitMachineBasicBlockAfter(const MachineBasicBlock *MBB) { 2010 MBBInfoMap[MBB].regsLiveOut = regsLive; 2011 regsLive.clear(); 2012 2013 if (Indexes) { 2014 SlotIndex stop = Indexes->getMBBEndIdx(MBB); 2015 if (!(stop > lastIndex)) { 2016 report("Block ends before last instruction index", MBB); 2017 errs() << "Block ends at " << stop 2018 << " last instruction was at " << lastIndex << '\n'; 2019 } 2020 lastIndex = stop; 2021 } 2022 } 2023 2024 // Calculate the largest possible vregsPassed sets. These are the registers that 2025 // can pass through an MBB live, but may not be live every time. It is assumed 2026 // that all vregsPassed sets are empty before the call. 2027 void MachineVerifier::calcRegsPassed() { 2028 // First push live-out regs to successors' vregsPassed. Remember the MBBs that 2029 // have any vregsPassed. 2030 SmallPtrSet<const MachineBasicBlock*, 8> todo; 2031 for (const auto &MBB : *MF) { 2032 BBInfo &MInfo = MBBInfoMap[&MBB]; 2033 if (!MInfo.reachable) 2034 continue; 2035 for (MachineBasicBlock::const_succ_iterator SuI = MBB.succ_begin(), 2036 SuE = MBB.succ_end(); SuI != SuE; ++SuI) { 2037 BBInfo &SInfo = MBBInfoMap[*SuI]; 2038 if (SInfo.addPassed(MInfo.regsLiveOut)) 2039 todo.insert(*SuI); 2040 } 2041 } 2042 2043 // Iteratively push vregsPassed to successors. This will converge to the same 2044 // final state regardless of DenseSet iteration order. 2045 while (!todo.empty()) { 2046 const MachineBasicBlock *MBB = *todo.begin(); 2047 todo.erase(MBB); 2048 BBInfo &MInfo = MBBInfoMap[MBB]; 2049 for (MachineBasicBlock::const_succ_iterator SuI = MBB->succ_begin(), 2050 SuE = MBB->succ_end(); SuI != SuE; ++SuI) { 2051 if (*SuI == MBB) 2052 continue; 2053 BBInfo &SInfo = MBBInfoMap[*SuI]; 2054 if (SInfo.addPassed(MInfo.vregsPassed)) 2055 todo.insert(*SuI); 2056 } 2057 } 2058 } 2059 2060 // Calculate the set of virtual registers that must be passed through each basic 2061 // block in order to satisfy the requirements of successor blocks. This is very 2062 // similar to calcRegsPassed, only backwards. 2063 void MachineVerifier::calcRegsRequired() { 2064 // First push live-in regs to predecessors' vregsRequired. 2065 SmallPtrSet<const MachineBasicBlock*, 8> todo; 2066 for (const auto &MBB : *MF) { 2067 BBInfo &MInfo = MBBInfoMap[&MBB]; 2068 for (MachineBasicBlock::const_pred_iterator PrI = MBB.pred_begin(), 2069 PrE = MBB.pred_end(); PrI != PrE; ++PrI) { 2070 BBInfo &PInfo = MBBInfoMap[*PrI]; 2071 if (PInfo.addRequired(MInfo.vregsLiveIn)) 2072 todo.insert(*PrI); 2073 } 2074 } 2075 2076 // Iteratively push vregsRequired to predecessors. This will converge to the 2077 // same final state regardless of DenseSet iteration order. 2078 while (!todo.empty()) { 2079 const MachineBasicBlock *MBB = *todo.begin(); 2080 todo.erase(MBB); 2081 BBInfo &MInfo = MBBInfoMap[MBB]; 2082 for (MachineBasicBlock::const_pred_iterator PrI = MBB->pred_begin(), 2083 PrE = MBB->pred_end(); PrI != PrE; ++PrI) { 2084 if (*PrI == MBB) 2085 continue; 2086 BBInfo &SInfo = MBBInfoMap[*PrI]; 2087 if (SInfo.addRequired(MInfo.vregsRequired)) 2088 todo.insert(*PrI); 2089 } 2090 } 2091 } 2092 2093 // Check PHI instructions at the beginning of MBB. It is assumed that 2094 // calcRegsPassed has been run so BBInfo::isLiveOut is valid. 2095 void MachineVerifier::checkPHIOps(const MachineBasicBlock &MBB) { 2096 BBInfo &MInfo = MBBInfoMap[&MBB]; 2097 2098 SmallPtrSet<const MachineBasicBlock*, 8> seen; 2099 for (const MachineInstr &Phi : MBB) { 2100 if (!Phi.isPHI()) 2101 break; 2102 seen.clear(); 2103 2104 const MachineOperand &MODef = Phi.getOperand(0); 2105 if (!MODef.isReg() || !MODef.isDef()) { 2106 report("Expected first PHI operand to be a register def", &MODef, 0); 2107 continue; 2108 } 2109 if (MODef.isTied() || MODef.isImplicit() || MODef.isInternalRead() || 2110 MODef.isEarlyClobber() || MODef.isDebug()) 2111 report("Unexpected flag on PHI operand", &MODef, 0); 2112 unsigned DefReg = MODef.getReg(); 2113 if (!TargetRegisterInfo::isVirtualRegister(DefReg)) 2114 report("Expected first PHI operand to be a virtual register", &MODef, 0); 2115 2116 for (unsigned I = 1, E = Phi.getNumOperands(); I != E; I += 2) { 2117 const MachineOperand &MO0 = Phi.getOperand(I); 2118 if (!MO0.isReg()) { 2119 report("Expected PHI operand to be a register", &MO0, I); 2120 continue; 2121 } 2122 if (MO0.isImplicit() || MO0.isInternalRead() || MO0.isEarlyClobber() || 2123 MO0.isDebug() || MO0.isTied()) 2124 report("Unexpected flag on PHI operand", &MO0, I); 2125 2126 const MachineOperand &MO1 = Phi.getOperand(I + 1); 2127 if (!MO1.isMBB()) { 2128 report("Expected PHI operand to be a basic block", &MO1, I + 1); 2129 continue; 2130 } 2131 2132 const MachineBasicBlock &Pre = *MO1.getMBB(); 2133 if (!Pre.isSuccessor(&MBB)) { 2134 report("PHI input is not a predecessor block", &MO1, I + 1); 2135 continue; 2136 } 2137 2138 if (MInfo.reachable) { 2139 seen.insert(&Pre); 2140 BBInfo &PrInfo = MBBInfoMap[&Pre]; 2141 if (!MO0.isUndef() && PrInfo.reachable && 2142 !PrInfo.isLiveOut(MO0.getReg())) 2143 report("PHI operand is not live-out from predecessor", &MO0, I); 2144 } 2145 } 2146 2147 // Did we see all predecessors? 2148 if (MInfo.reachable) { 2149 for (MachineBasicBlock *Pred : MBB.predecessors()) { 2150 if (!seen.count(Pred)) { 2151 report("Missing PHI operand", &Phi); 2152 errs() << printMBBReference(*Pred) 2153 << " is a predecessor according to the CFG.\n"; 2154 } 2155 } 2156 } 2157 } 2158 } 2159 2160 void MachineVerifier::visitMachineFunctionAfter() { 2161 calcRegsPassed(); 2162 2163 for (const MachineBasicBlock &MBB : *MF) 2164 checkPHIOps(MBB); 2165 2166 // Now check liveness info if available 2167 calcRegsRequired(); 2168 2169 // Check for killed virtual registers that should be live out. 2170 for (const auto &MBB : *MF) { 2171 BBInfo &MInfo = MBBInfoMap[&MBB]; 2172 for (RegSet::iterator 2173 I = MInfo.vregsRequired.begin(), E = MInfo.vregsRequired.end(); I != E; 2174 ++I) 2175 if (MInfo.regsKilled.count(*I)) { 2176 report("Virtual register killed in block, but needed live out.", &MBB); 2177 errs() << "Virtual register " << printReg(*I) 2178 << " is used after the block.\n"; 2179 } 2180 } 2181 2182 if (!MF->empty()) { 2183 BBInfo &MInfo = MBBInfoMap[&MF->front()]; 2184 for (RegSet::iterator 2185 I = MInfo.vregsRequired.begin(), E = MInfo.vregsRequired.end(); I != E; 2186 ++I) { 2187 report("Virtual register defs don't dominate all uses.", MF); 2188 report_context_vreg(*I); 2189 } 2190 } 2191 2192 if (LiveVars) 2193 verifyLiveVariables(); 2194 if (LiveInts) 2195 verifyLiveIntervals(); 2196 2197 for (auto CSInfo : MF->getCallSitesInfo()) 2198 if (!CSInfo.first->isCall()) 2199 report("Call site info referencing instruction that is not call", MF); 2200 } 2201 2202 void MachineVerifier::verifyLiveVariables() { 2203 assert(LiveVars && "Don't call verifyLiveVariables without LiveVars"); 2204 for (unsigned i = 0, e = MRI->getNumVirtRegs(); i != e; ++i) { 2205 unsigned Reg = TargetRegisterInfo::index2VirtReg(i); 2206 LiveVariables::VarInfo &VI = LiveVars->getVarInfo(Reg); 2207 for (const auto &MBB : *MF) { 2208 BBInfo &MInfo = MBBInfoMap[&MBB]; 2209 2210 // Our vregsRequired should be identical to LiveVariables' AliveBlocks 2211 if (MInfo.vregsRequired.count(Reg)) { 2212 if (!VI.AliveBlocks.test(MBB.getNumber())) { 2213 report("LiveVariables: Block missing from AliveBlocks", &MBB); 2214 errs() << "Virtual register " << printReg(Reg) 2215 << " must be live through the block.\n"; 2216 } 2217 } else { 2218 if (VI.AliveBlocks.test(MBB.getNumber())) { 2219 report("LiveVariables: Block should not be in AliveBlocks", &MBB); 2220 errs() << "Virtual register " << printReg(Reg) 2221 << " is not needed live through the block.\n"; 2222 } 2223 } 2224 } 2225 } 2226 } 2227 2228 void MachineVerifier::verifyLiveIntervals() { 2229 assert(LiveInts && "Don't call verifyLiveIntervals without LiveInts"); 2230 for (unsigned i = 0, e = MRI->getNumVirtRegs(); i != e; ++i) { 2231 unsigned Reg = TargetRegisterInfo::index2VirtReg(i); 2232 2233 // Spilling and splitting may leave unused registers around. Skip them. 2234 if (MRI->reg_nodbg_empty(Reg)) 2235 continue; 2236 2237 if (!LiveInts->hasInterval(Reg)) { 2238 report("Missing live interval for virtual register", MF); 2239 errs() << printReg(Reg, TRI) << " still has defs or uses\n"; 2240 continue; 2241 } 2242 2243 const LiveInterval &LI = LiveInts->getInterval(Reg); 2244 assert(Reg == LI.reg && "Invalid reg to interval mapping"); 2245 verifyLiveInterval(LI); 2246 } 2247 2248 // Verify all the cached regunit intervals. 2249 for (unsigned i = 0, e = TRI->getNumRegUnits(); i != e; ++i) 2250 if (const LiveRange *LR = LiveInts->getCachedRegUnit(i)) 2251 verifyLiveRange(*LR, i); 2252 } 2253 2254 void MachineVerifier::verifyLiveRangeValue(const LiveRange &LR, 2255 const VNInfo *VNI, unsigned Reg, 2256 LaneBitmask LaneMask) { 2257 if (VNI->isUnused()) 2258 return; 2259 2260 const VNInfo *DefVNI = LR.getVNInfoAt(VNI->def); 2261 2262 if (!DefVNI) { 2263 report("Value not live at VNInfo def and not marked unused", MF); 2264 report_context(LR, Reg, LaneMask); 2265 report_context(*VNI); 2266 return; 2267 } 2268 2269 if (DefVNI != VNI) { 2270 report("Live segment at def has different VNInfo", MF); 2271 report_context(LR, Reg, LaneMask); 2272 report_context(*VNI); 2273 return; 2274 } 2275 2276 const MachineBasicBlock *MBB = LiveInts->getMBBFromIndex(VNI->def); 2277 if (!MBB) { 2278 report("Invalid VNInfo definition index", MF); 2279 report_context(LR, Reg, LaneMask); 2280 report_context(*VNI); 2281 return; 2282 } 2283 2284 if (VNI->isPHIDef()) { 2285 if (VNI->def != LiveInts->getMBBStartIdx(MBB)) { 2286 report("PHIDef VNInfo is not defined at MBB start", MBB); 2287 report_context(LR, Reg, LaneMask); 2288 report_context(*VNI); 2289 } 2290 return; 2291 } 2292 2293 // Non-PHI def. 2294 const MachineInstr *MI = LiveInts->getInstructionFromIndex(VNI->def); 2295 if (!MI) { 2296 report("No instruction at VNInfo def index", MBB); 2297 report_context(LR, Reg, LaneMask); 2298 report_context(*VNI); 2299 return; 2300 } 2301 2302 if (Reg != 0) { 2303 bool hasDef = false; 2304 bool isEarlyClobber = false; 2305 for (ConstMIBundleOperands MOI(*MI); MOI.isValid(); ++MOI) { 2306 if (!MOI->isReg() || !MOI->isDef()) 2307 continue; 2308 if (TargetRegisterInfo::isVirtualRegister(Reg)) { 2309 if (MOI->getReg() != Reg) 2310 continue; 2311 } else { 2312 if (!TargetRegisterInfo::isPhysicalRegister(MOI->getReg()) || 2313 !TRI->hasRegUnit(MOI->getReg(), Reg)) 2314 continue; 2315 } 2316 if (LaneMask.any() && 2317 (TRI->getSubRegIndexLaneMask(MOI->getSubReg()) & LaneMask).none()) 2318 continue; 2319 hasDef = true; 2320 if (MOI->isEarlyClobber()) 2321 isEarlyClobber = true; 2322 } 2323 2324 if (!hasDef) { 2325 report("Defining instruction does not modify register", MI); 2326 report_context(LR, Reg, LaneMask); 2327 report_context(*VNI); 2328 } 2329 2330 // Early clobber defs begin at USE slots, but other defs must begin at 2331 // DEF slots. 2332 if (isEarlyClobber) { 2333 if (!VNI->def.isEarlyClobber()) { 2334 report("Early clobber def must be at an early-clobber slot", MBB); 2335 report_context(LR, Reg, LaneMask); 2336 report_context(*VNI); 2337 } 2338 } else if (!VNI->def.isRegister()) { 2339 report("Non-PHI, non-early clobber def must be at a register slot", MBB); 2340 report_context(LR, Reg, LaneMask); 2341 report_context(*VNI); 2342 } 2343 } 2344 } 2345 2346 void MachineVerifier::verifyLiveRangeSegment(const LiveRange &LR, 2347 const LiveRange::const_iterator I, 2348 unsigned Reg, LaneBitmask LaneMask) 2349 { 2350 const LiveRange::Segment &S = *I; 2351 const VNInfo *VNI = S.valno; 2352 assert(VNI && "Live segment has no valno"); 2353 2354 if (VNI->id >= LR.getNumValNums() || VNI != LR.getValNumInfo(VNI->id)) { 2355 report("Foreign valno in live segment", MF); 2356 report_context(LR, Reg, LaneMask); 2357 report_context(S); 2358 report_context(*VNI); 2359 } 2360 2361 if (VNI->isUnused()) { 2362 report("Live segment valno is marked unused", MF); 2363 report_context(LR, Reg, LaneMask); 2364 report_context(S); 2365 } 2366 2367 const MachineBasicBlock *MBB = LiveInts->getMBBFromIndex(S.start); 2368 if (!MBB) { 2369 report("Bad start of live segment, no basic block", MF); 2370 report_context(LR, Reg, LaneMask); 2371 report_context(S); 2372 return; 2373 } 2374 SlotIndex MBBStartIdx = LiveInts->getMBBStartIdx(MBB); 2375 if (S.start != MBBStartIdx && S.start != VNI->def) { 2376 report("Live segment must begin at MBB entry or valno def", MBB); 2377 report_context(LR, Reg, LaneMask); 2378 report_context(S); 2379 } 2380 2381 const MachineBasicBlock *EndMBB = 2382 LiveInts->getMBBFromIndex(S.end.getPrevSlot()); 2383 if (!EndMBB) { 2384 report("Bad end of live segment, no basic block", MF); 2385 report_context(LR, Reg, LaneMask); 2386 report_context(S); 2387 return; 2388 } 2389 2390 // No more checks for live-out segments. 2391 if (S.end == LiveInts->getMBBEndIdx(EndMBB)) 2392 return; 2393 2394 // RegUnit intervals are allowed dead phis. 2395 if (!TargetRegisterInfo::isVirtualRegister(Reg) && VNI->isPHIDef() && 2396 S.start == VNI->def && S.end == VNI->def.getDeadSlot()) 2397 return; 2398 2399 // The live segment is ending inside EndMBB 2400 const MachineInstr *MI = 2401 LiveInts->getInstructionFromIndex(S.end.getPrevSlot()); 2402 if (!MI) { 2403 report("Live segment doesn't end at a valid instruction", EndMBB); 2404 report_context(LR, Reg, LaneMask); 2405 report_context(S); 2406 return; 2407 } 2408 2409 // The block slot must refer to a basic block boundary. 2410 if (S.end.isBlock()) { 2411 report("Live segment ends at B slot of an instruction", EndMBB); 2412 report_context(LR, Reg, LaneMask); 2413 report_context(S); 2414 } 2415 2416 if (S.end.isDead()) { 2417 // Segment ends on the dead slot. 2418 // That means there must be a dead def. 2419 if (!SlotIndex::isSameInstr(S.start, S.end)) { 2420 report("Live segment ending at dead slot spans instructions", EndMBB); 2421 report_context(LR, Reg, LaneMask); 2422 report_context(S); 2423 } 2424 } 2425 2426 // A live segment can only end at an early-clobber slot if it is being 2427 // redefined by an early-clobber def. 2428 if (S.end.isEarlyClobber()) { 2429 if (I+1 == LR.end() || (I+1)->start != S.end) { 2430 report("Live segment ending at early clobber slot must be " 2431 "redefined by an EC def in the same instruction", EndMBB); 2432 report_context(LR, Reg, LaneMask); 2433 report_context(S); 2434 } 2435 } 2436 2437 // The following checks only apply to virtual registers. Physreg liveness 2438 // is too weird to check. 2439 if (TargetRegisterInfo::isVirtualRegister(Reg)) { 2440 // A live segment can end with either a redefinition, a kill flag on a 2441 // use, or a dead flag on a def. 2442 bool hasRead = false; 2443 bool hasSubRegDef = false; 2444 bool hasDeadDef = false; 2445 for (ConstMIBundleOperands MOI(*MI); MOI.isValid(); ++MOI) { 2446 if (!MOI->isReg() || MOI->getReg() != Reg) 2447 continue; 2448 unsigned Sub = MOI->getSubReg(); 2449 LaneBitmask SLM = Sub != 0 ? TRI->getSubRegIndexLaneMask(Sub) 2450 : LaneBitmask::getAll(); 2451 if (MOI->isDef()) { 2452 if (Sub != 0) { 2453 hasSubRegDef = true; 2454 // An operand %0:sub0 reads %0:sub1..n. Invert the lane 2455 // mask for subregister defs. Read-undef defs will be handled by 2456 // readsReg below. 2457 SLM = ~SLM; 2458 } 2459 if (MOI->isDead()) 2460 hasDeadDef = true; 2461 } 2462 if (LaneMask.any() && (LaneMask & SLM).none()) 2463 continue; 2464 if (MOI->readsReg()) 2465 hasRead = true; 2466 } 2467 if (S.end.isDead()) { 2468 // Make sure that the corresponding machine operand for a "dead" live 2469 // range has the dead flag. We cannot perform this check for subregister 2470 // liveranges as partially dead values are allowed. 2471 if (LaneMask.none() && !hasDeadDef) { 2472 report("Instruction ending live segment on dead slot has no dead flag", 2473 MI); 2474 report_context(LR, Reg, LaneMask); 2475 report_context(S); 2476 } 2477 } else { 2478 if (!hasRead) { 2479 // When tracking subregister liveness, the main range must start new 2480 // values on partial register writes, even if there is no read. 2481 if (!MRI->shouldTrackSubRegLiveness(Reg) || LaneMask.any() || 2482 !hasSubRegDef) { 2483 report("Instruction ending live segment doesn't read the register", 2484 MI); 2485 report_context(LR, Reg, LaneMask); 2486 report_context(S); 2487 } 2488 } 2489 } 2490 } 2491 2492 // Now check all the basic blocks in this live segment. 2493 MachineFunction::const_iterator MFI = MBB->getIterator(); 2494 // Is this live segment the beginning of a non-PHIDef VN? 2495 if (S.start == VNI->def && !VNI->isPHIDef()) { 2496 // Not live-in to any blocks. 2497 if (MBB == EndMBB) 2498 return; 2499 // Skip this block. 2500 ++MFI; 2501 } 2502 2503 SmallVector<SlotIndex, 4> Undefs; 2504 if (LaneMask.any()) { 2505 LiveInterval &OwnerLI = LiveInts->getInterval(Reg); 2506 OwnerLI.computeSubRangeUndefs(Undefs, LaneMask, *MRI, *Indexes); 2507 } 2508 2509 while (true) { 2510 assert(LiveInts->isLiveInToMBB(LR, &*MFI)); 2511 // We don't know how to track physregs into a landing pad. 2512 if (!TargetRegisterInfo::isVirtualRegister(Reg) && 2513 MFI->isEHPad()) { 2514 if (&*MFI == EndMBB) 2515 break; 2516 ++MFI; 2517 continue; 2518 } 2519 2520 // Is VNI a PHI-def in the current block? 2521 bool IsPHI = VNI->isPHIDef() && 2522 VNI->def == LiveInts->getMBBStartIdx(&*MFI); 2523 2524 // Check that VNI is live-out of all predecessors. 2525 for (MachineBasicBlock::const_pred_iterator PI = MFI->pred_begin(), 2526 PE = MFI->pred_end(); PI != PE; ++PI) { 2527 SlotIndex PEnd = LiveInts->getMBBEndIdx(*PI); 2528 const VNInfo *PVNI = LR.getVNInfoBefore(PEnd); 2529 2530 // All predecessors must have a live-out value. However for a phi 2531 // instruction with subregister intervals 2532 // only one of the subregisters (not necessarily the current one) needs to 2533 // be defined. 2534 if (!PVNI && (LaneMask.none() || !IsPHI)) { 2535 if (LiveRangeCalc::isJointlyDominated(*PI, Undefs, *Indexes)) 2536 continue; 2537 report("Register not marked live out of predecessor", *PI); 2538 report_context(LR, Reg, LaneMask); 2539 report_context(*VNI); 2540 errs() << " live into " << printMBBReference(*MFI) << '@' 2541 << LiveInts->getMBBStartIdx(&*MFI) << ", not live before " 2542 << PEnd << '\n'; 2543 continue; 2544 } 2545 2546 // Only PHI-defs can take different predecessor values. 2547 if (!IsPHI && PVNI != VNI) { 2548 report("Different value live out of predecessor", *PI); 2549 report_context(LR, Reg, LaneMask); 2550 errs() << "Valno #" << PVNI->id << " live out of " 2551 << printMBBReference(*(*PI)) << '@' << PEnd << "\nValno #" 2552 << VNI->id << " live into " << printMBBReference(*MFI) << '@' 2553 << LiveInts->getMBBStartIdx(&*MFI) << '\n'; 2554 } 2555 } 2556 if (&*MFI == EndMBB) 2557 break; 2558 ++MFI; 2559 } 2560 } 2561 2562 void MachineVerifier::verifyLiveRange(const LiveRange &LR, unsigned Reg, 2563 LaneBitmask LaneMask) { 2564 for (const VNInfo *VNI : LR.valnos) 2565 verifyLiveRangeValue(LR, VNI, Reg, LaneMask); 2566 2567 for (LiveRange::const_iterator I = LR.begin(), E = LR.end(); I != E; ++I) 2568 verifyLiveRangeSegment(LR, I, Reg, LaneMask); 2569 } 2570 2571 void MachineVerifier::verifyLiveInterval(const LiveInterval &LI) { 2572 unsigned Reg = LI.reg; 2573 assert(TargetRegisterInfo::isVirtualRegister(Reg)); 2574 verifyLiveRange(LI, Reg); 2575 2576 LaneBitmask Mask; 2577 LaneBitmask MaxMask = MRI->getMaxLaneMaskForVReg(Reg); 2578 for (const LiveInterval::SubRange &SR : LI.subranges()) { 2579 if ((Mask & SR.LaneMask).any()) { 2580 report("Lane masks of sub ranges overlap in live interval", MF); 2581 report_context(LI); 2582 } 2583 if ((SR.LaneMask & ~MaxMask).any()) { 2584 report("Subrange lanemask is invalid", MF); 2585 report_context(LI); 2586 } 2587 if (SR.empty()) { 2588 report("Subrange must not be empty", MF); 2589 report_context(SR, LI.reg, SR.LaneMask); 2590 } 2591 Mask |= SR.LaneMask; 2592 verifyLiveRange(SR, LI.reg, SR.LaneMask); 2593 if (!LI.covers(SR)) { 2594 report("A Subrange is not covered by the main range", MF); 2595 report_context(LI); 2596 } 2597 } 2598 2599 // Check the LI only has one connected component. 2600 ConnectedVNInfoEqClasses ConEQ(*LiveInts); 2601 unsigned NumComp = ConEQ.Classify(LI); 2602 if (NumComp > 1) { 2603 report("Multiple connected components in live interval", MF); 2604 report_context(LI); 2605 for (unsigned comp = 0; comp != NumComp; ++comp) { 2606 errs() << comp << ": valnos"; 2607 for (LiveInterval::const_vni_iterator I = LI.vni_begin(), 2608 E = LI.vni_end(); I!=E; ++I) 2609 if (comp == ConEQ.getEqClass(*I)) 2610 errs() << ' ' << (*I)->id; 2611 errs() << '\n'; 2612 } 2613 } 2614 } 2615 2616 namespace { 2617 2618 // FrameSetup and FrameDestroy can have zero adjustment, so using a single 2619 // integer, we can't tell whether it is a FrameSetup or FrameDestroy if the 2620 // value is zero. 2621 // We use a bool plus an integer to capture the stack state. 2622 struct StackStateOfBB { 2623 StackStateOfBB() = default; 2624 StackStateOfBB(int EntryVal, int ExitVal, bool EntrySetup, bool ExitSetup) : 2625 EntryValue(EntryVal), ExitValue(ExitVal), EntryIsSetup(EntrySetup), 2626 ExitIsSetup(ExitSetup) {} 2627 2628 // Can be negative, which means we are setting up a frame. 2629 int EntryValue = 0; 2630 int ExitValue = 0; 2631 bool EntryIsSetup = false; 2632 bool ExitIsSetup = false; 2633 }; 2634 2635 } // end anonymous namespace 2636 2637 /// Make sure on every path through the CFG, a FrameSetup <n> is always followed 2638 /// by a FrameDestroy <n>, stack adjustments are identical on all 2639 /// CFG edges to a merge point, and frame is destroyed at end of a return block. 2640 void MachineVerifier::verifyStackFrame() { 2641 unsigned FrameSetupOpcode = TII->getCallFrameSetupOpcode(); 2642 unsigned FrameDestroyOpcode = TII->getCallFrameDestroyOpcode(); 2643 if (FrameSetupOpcode == ~0u && FrameDestroyOpcode == ~0u) 2644 return; 2645 2646 SmallVector<StackStateOfBB, 8> SPState; 2647 SPState.resize(MF->getNumBlockIDs()); 2648 df_iterator_default_set<const MachineBasicBlock*> Reachable; 2649 2650 // Visit the MBBs in DFS order. 2651 for (df_ext_iterator<const MachineFunction *, 2652 df_iterator_default_set<const MachineBasicBlock *>> 2653 DFI = df_ext_begin(MF, Reachable), DFE = df_ext_end(MF, Reachable); 2654 DFI != DFE; ++DFI) { 2655 const MachineBasicBlock *MBB = *DFI; 2656 2657 StackStateOfBB BBState; 2658 // Check the exit state of the DFS stack predecessor. 2659 if (DFI.getPathLength() >= 2) { 2660 const MachineBasicBlock *StackPred = DFI.getPath(DFI.getPathLength() - 2); 2661 assert(Reachable.count(StackPred) && 2662 "DFS stack predecessor is already visited.\n"); 2663 BBState.EntryValue = SPState[StackPred->getNumber()].ExitValue; 2664 BBState.EntryIsSetup = SPState[StackPred->getNumber()].ExitIsSetup; 2665 BBState.ExitValue = BBState.EntryValue; 2666 BBState.ExitIsSetup = BBState.EntryIsSetup; 2667 } 2668 2669 // Update stack state by checking contents of MBB. 2670 for (const auto &I : *MBB) { 2671 if (I.getOpcode() == FrameSetupOpcode) { 2672 if (BBState.ExitIsSetup) 2673 report("FrameSetup is after another FrameSetup", &I); 2674 BBState.ExitValue -= TII->getFrameTotalSize(I); 2675 BBState.ExitIsSetup = true; 2676 } 2677 2678 if (I.getOpcode() == FrameDestroyOpcode) { 2679 int Size = TII->getFrameTotalSize(I); 2680 if (!BBState.ExitIsSetup) 2681 report("FrameDestroy is not after a FrameSetup", &I); 2682 int AbsSPAdj = BBState.ExitValue < 0 ? -BBState.ExitValue : 2683 BBState.ExitValue; 2684 if (BBState.ExitIsSetup && AbsSPAdj != Size) { 2685 report("FrameDestroy <n> is after FrameSetup <m>", &I); 2686 errs() << "FrameDestroy <" << Size << "> is after FrameSetup <" 2687 << AbsSPAdj << ">.\n"; 2688 } 2689 BBState.ExitValue += Size; 2690 BBState.ExitIsSetup = false; 2691 } 2692 } 2693 SPState[MBB->getNumber()] = BBState; 2694 2695 // Make sure the exit state of any predecessor is consistent with the entry 2696 // state. 2697 for (MachineBasicBlock::const_pred_iterator I = MBB->pred_begin(), 2698 E = MBB->pred_end(); I != E; ++I) { 2699 if (Reachable.count(*I) && 2700 (SPState[(*I)->getNumber()].ExitValue != BBState.EntryValue || 2701 SPState[(*I)->getNumber()].ExitIsSetup != BBState.EntryIsSetup)) { 2702 report("The exit stack state of a predecessor is inconsistent.", MBB); 2703 errs() << "Predecessor " << printMBBReference(*(*I)) 2704 << " has exit state (" << SPState[(*I)->getNumber()].ExitValue 2705 << ", " << SPState[(*I)->getNumber()].ExitIsSetup << "), while " 2706 << printMBBReference(*MBB) << " has entry state (" 2707 << BBState.EntryValue << ", " << BBState.EntryIsSetup << ").\n"; 2708 } 2709 } 2710 2711 // Make sure the entry state of any successor is consistent with the exit 2712 // state. 2713 for (MachineBasicBlock::const_succ_iterator I = MBB->succ_begin(), 2714 E = MBB->succ_end(); I != E; ++I) { 2715 if (Reachable.count(*I) && 2716 (SPState[(*I)->getNumber()].EntryValue != BBState.ExitValue || 2717 SPState[(*I)->getNumber()].EntryIsSetup != BBState.ExitIsSetup)) { 2718 report("The entry stack state of a successor is inconsistent.", MBB); 2719 errs() << "Successor " << printMBBReference(*(*I)) 2720 << " has entry state (" << SPState[(*I)->getNumber()].EntryValue 2721 << ", " << SPState[(*I)->getNumber()].EntryIsSetup << "), while " 2722 << printMBBReference(*MBB) << " has exit state (" 2723 << BBState.ExitValue << ", " << BBState.ExitIsSetup << ").\n"; 2724 } 2725 } 2726 2727 // Make sure a basic block with return ends with zero stack adjustment. 2728 if (!MBB->empty() && MBB->back().isReturn()) { 2729 if (BBState.ExitIsSetup) 2730 report("A return block ends with a FrameSetup.", MBB); 2731 if (BBState.ExitValue) 2732 report("A return block ends with a nonzero stack adjustment.", MBB); 2733 } 2734 } 2735 } 2736