1 //===-- MachineVerifier.cpp - Machine Code Verifier -------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // Pass to verify generated machine code. The following is checked:
12 // Operand counts: All explicit operands must be present.
14 // Register classes: All physical and virtual register operands must be
15 // compatible with the register class required by the instruction descriptor.
17 // Register live intervals: Registers must be defined only once, and must be
18 // defined before use.
20 // The machine code verifier is enabled from LLVMTargetMachine.cpp with the
21 // command-line option -verify-machineinstrs, or by defining the environment
22 // variable LLVM_VERIFY_MACHINEINSTRS to the name of a file that will receive
23 // the verifier errors.
24 //===----------------------------------------------------------------------===//
26 #include "llvm/ADT/DenseSet.h"
27 #include "llvm/ADT/SetOperations.h"
28 #include "llvm/ADT/SmallVector.h"
29 #include "llvm/Function.h"
30 #include "llvm/CodeGen/LiveVariables.h"
31 #include "llvm/CodeGen/MachineFunctionPass.h"
32 #include "llvm/CodeGen/MachineFrameInfo.h"
33 #include "llvm/CodeGen/MachineRegisterInfo.h"
34 #include "llvm/CodeGen/Passes.h"
35 #include "llvm/Target/TargetMachine.h"
36 #include "llvm/Target/TargetRegisterInfo.h"
37 #include "llvm/Target/TargetInstrInfo.h"
38 #include "llvm/Support/Compiler.h"
39 #include "llvm/Support/Debug.h"
40 #include "llvm/Support/ErrorHandling.h"
41 #include "llvm/Support/raw_ostream.h"
47 struct VISIBILITY_HIDDEN MachineVerifier : public MachineFunctionPass {
48 static char ID; // Pass ID, replacement for typeid
50 MachineVerifier(bool allowDoubleDefs = false) :
51 MachineFunctionPass(&ID),
52 allowVirtDoubleDefs(allowDoubleDefs),
53 allowPhysDoubleDefs(allowDoubleDefs),
54 OutFileName(getenv("LLVM_VERIFY_MACHINEINSTRS"))
57 void getAnalysisUsage(AnalysisUsage &AU) const {
59 MachineFunctionPass::getAnalysisUsage(AU);
62 bool runOnMachineFunction(MachineFunction &MF);
64 const bool allowVirtDoubleDefs;
65 const bool allowPhysDoubleDefs;
67 const char *const OutFileName;
69 const MachineFunction *MF;
70 const TargetMachine *TM;
71 const TargetRegisterInfo *TRI;
72 const MachineRegisterInfo *MRI;
76 typedef SmallVector<unsigned, 16> RegVector;
77 typedef DenseSet<unsigned> RegSet;
78 typedef DenseMap<unsigned, const MachineInstr*> RegMap;
80 BitVector regsReserved;
82 RegVector regsDefined, regsDead, regsKilled;
83 RegSet regsLiveInButUnused;
85 // Add Reg and any sub-registers to RV
86 void addRegWithSubRegs(RegVector &RV, unsigned Reg) {
88 if (TargetRegisterInfo::isPhysicalRegister(Reg))
89 for (const unsigned *R = TRI->getSubRegisters(Reg); *R; R++)
94 // Is this MBB reachable from the MF entry point?
97 // Vregs that must be live in because they are used without being
98 // defined. Map value is the user.
101 // Vregs that must be dead in because they are defined without being
102 // killed first. Map value is the defining instruction.
105 // Regs killed in MBB. They may be defined again, and will then be in both
106 // regsKilled and regsLiveOut.
109 // Regs defined in MBB and live out. Note that vregs passing through may
110 // be live out without being mentioned here.
113 // Vregs that pass through MBB untouched. This set is disjoint from
114 // regsKilled and regsLiveOut.
117 BBInfo() : reachable(false) {}
119 // Add register to vregsPassed if it belongs there. Return true if
121 bool addPassed(unsigned Reg) {
122 if (!TargetRegisterInfo::isVirtualRegister(Reg))
124 if (regsKilled.count(Reg) || regsLiveOut.count(Reg))
126 return vregsPassed.insert(Reg).second;
129 // Same for a full set.
130 bool addPassed(const RegSet &RS) {
131 bool changed = false;
132 for (RegSet::const_iterator I = RS.begin(), E = RS.end(); I != E; ++I)
138 // Live-out registers are either in regsLiveOut or vregsPassed.
139 bool isLiveOut(unsigned Reg) const {
140 return regsLiveOut.count(Reg) || vregsPassed.count(Reg);
144 // Extra register info per MBB.
145 DenseMap<const MachineBasicBlock*, BBInfo> MBBInfoMap;
147 bool isReserved(unsigned Reg) {
148 return Reg < regsReserved.size() && regsReserved.test(Reg);
151 void visitMachineFunctionBefore();
152 void visitMachineBasicBlockBefore(const MachineBasicBlock *MBB);
153 void visitMachineInstrBefore(const MachineInstr *MI);
154 void visitMachineOperand(const MachineOperand *MO, unsigned MONum);
155 void visitMachineInstrAfter(const MachineInstr *MI);
156 void visitMachineBasicBlockAfter(const MachineBasicBlock *MBB);
157 void visitMachineFunctionAfter();
159 void report(const char *msg, const MachineFunction *MF);
160 void report(const char *msg, const MachineBasicBlock *MBB);
161 void report(const char *msg, const MachineInstr *MI);
162 void report(const char *msg, const MachineOperand *MO, unsigned MONum);
164 void markReachable(const MachineBasicBlock *MBB);
165 void calcMaxRegsPassed();
166 void calcMinRegsPassed();
167 void checkPHIOps(const MachineBasicBlock *MBB);
171 char MachineVerifier::ID = 0;
172 static RegisterPass<MachineVerifier>
173 MachineVer("machineverifier", "Verify generated machine code");
174 static const PassInfo *const MachineVerifyID = &MachineVer;
177 llvm::createMachineVerifierPass(bool allowPhysDoubleDefs)
179 return new MachineVerifier(allowPhysDoubleDefs);
183 MachineVerifier::runOnMachineFunction(MachineFunction &MF)
185 std::ofstream OutFile;
187 OutFile.open(OutFileName, std::ios::out | std::ios::app);
196 TM = &MF.getTarget();
197 TRI = TM->getRegisterInfo();
198 MRI = &MF.getRegInfo();
200 visitMachineFunctionBefore();
201 for (MachineFunction::const_iterator MFI = MF.begin(), MFE = MF.end();
203 visitMachineBasicBlockBefore(MFI);
204 for (MachineBasicBlock::const_iterator MBBI = MFI->begin(),
205 MBBE = MFI->end(); MBBI != MBBE; ++MBBI) {
206 visitMachineInstrBefore(MBBI);
207 for (unsigned I = 0, E = MBBI->getNumOperands(); I != E; ++I)
208 visitMachineOperand(&MBBI->getOperand(I), I);
209 visitMachineInstrAfter(MBBI);
211 visitMachineBasicBlockAfter(MFI);
213 visitMachineFunctionAfter();
217 else if (foundErrors) {
219 raw_string_ostream Msg(msg);
220 Msg << "Found " << foundErrors << " machine code errors.";
221 llvm_report_error(Msg.str());
229 regsLiveInButUnused.clear();
232 return false; // no changes
236 MachineVerifier::report(const char *msg, const MachineFunction *MF)
242 *OS << "*** Bad machine code: " << msg << " ***\n"
243 << "- function: " << MF->getFunction()->getNameStr() << "\n";
247 MachineVerifier::report(const char *msg, const MachineBasicBlock *MBB)
250 report(msg, MBB->getParent());
251 *OS << "- basic block: " << MBB->getBasicBlock()->getNameStr()
253 << " (#" << MBB->getNumber() << ")\n";
257 MachineVerifier::report(const char *msg, const MachineInstr *MI)
260 report(msg, MI->getParent());
261 *OS << "- instruction: ";
266 MachineVerifier::report(const char *msg,
267 const MachineOperand *MO, unsigned MONum)
270 report(msg, MO->getParent());
271 *OS << "- operand " << MONum << ": ";
277 MachineVerifier::markReachable(const MachineBasicBlock *MBB)
279 BBInfo &MInfo = MBBInfoMap[MBB];
280 if (!MInfo.reachable) {
281 MInfo.reachable = true;
282 for (MachineBasicBlock::const_succ_iterator SuI = MBB->succ_begin(),
283 SuE = MBB->succ_end(); SuI != SuE; ++SuI)
289 MachineVerifier::visitMachineFunctionBefore()
291 regsReserved = TRI->getReservedRegs(*MF);
293 // A sub-register of a reserved register is also reserved
294 for (int Reg = regsReserved.find_first(); Reg>=0;
295 Reg = regsReserved.find_next(Reg)) {
296 for (const unsigned *Sub = TRI->getSubRegisters(Reg); *Sub; ++Sub) {
297 // FIXME: This should probably be:
298 // assert(regsReserved.test(*Sub) && "Non-reserved sub-register");
299 regsReserved.set(*Sub);
302 markReachable(&MF->front());
306 MachineVerifier::visitMachineBasicBlockBefore(const MachineBasicBlock *MBB)
309 for (MachineBasicBlock::const_livein_iterator I = MBB->livein_begin(),
310 E = MBB->livein_end(); I != E; ++I) {
311 if (!TargetRegisterInfo::isPhysicalRegister(*I)) {
312 report("MBB live-in list contains non-physical register", MBB);
316 for (const unsigned *R = TRI->getSubRegisters(*I); *R; R++)
319 regsLiveInButUnused = regsLive;
321 const MachineFrameInfo *MFI = MF->getFrameInfo();
322 assert(MFI && "Function has no frame info");
323 BitVector PR = MFI->getPristineRegs(MBB);
324 for (int I = PR.find_first(); I>0; I = PR.find_next(I)) {
326 for (const unsigned *R = TRI->getSubRegisters(I); *R; R++)
335 MachineVerifier::visitMachineInstrBefore(const MachineInstr *MI)
337 const TargetInstrDesc &TI = MI->getDesc();
338 if (MI->getNumExplicitOperands() < TI.getNumOperands()) {
339 report("Too few operands", MI);
340 *OS << TI.getNumOperands() << " operands expected, but "
341 << MI->getNumExplicitOperands() << " given.\n";
343 if (!TI.isVariadic()) {
344 if (MI->getNumExplicitOperands() > TI.getNumOperands()) {
345 report("Too many operands", MI);
346 *OS << TI.getNumOperands() << " operands expected, but "
347 << MI->getNumExplicitOperands() << " given.\n";
353 MachineVerifier::visitMachineOperand(const MachineOperand *MO, unsigned MONum)
355 const MachineInstr *MI = MO->getParent();
356 const TargetInstrDesc &TI = MI->getDesc();
358 // The first TI.NumDefs operands must be explicit register defines
359 if (MONum < TI.getNumDefs()) {
361 report("Explicit definition must be a register", MO, MONum);
362 else if (!MO->isDef())
363 report("Explicit definition marked as use", MO, MONum);
364 else if (MO->isImplicit())
365 report("Explicit definition marked as implicit", MO, MONum);
368 switch (MO->getType()) {
369 case MachineOperand::MO_Register: {
370 const unsigned Reg = MO->getReg();
374 // Check Live Variables.
376 // An <undef> doesn't refer to any register, so just skip it.
377 } else if (MO->isUse()) {
378 regsLiveInButUnused.erase(Reg);
381 addRegWithSubRegs(regsKilled, Reg);
382 // Tied operands on two-address instuctions MUST NOT have a <kill> flag.
383 if (MI->isRegTiedToDefOperand(MONum))
384 report("Illegal kill flag on two-address instruction operand",
387 // TwoAddress instr modifying a reg is treated as kill+def.
389 if (MI->isRegTiedToDefOperand(MONum, &defIdx) &&
390 MI->getOperand(defIdx).getReg() == Reg)
391 addRegWithSubRegs(regsKilled, Reg);
393 // Use of a dead register.
394 if (!regsLive.count(Reg)) {
395 if (TargetRegisterInfo::isPhysicalRegister(Reg)) {
396 // Reserved registers may be used even when 'dead'.
397 if (!isReserved(Reg))
398 report("Using an undefined physical register", MO, MONum);
400 BBInfo &MInfo = MBBInfoMap[MI->getParent()];
401 // We don't know which virtual registers are live in, so only complain
402 // if vreg was killed in this MBB. Otherwise keep track of vregs that
403 // must be live in. PHI instructions are handled separately.
404 if (MInfo.regsKilled.count(Reg))
405 report("Using a killed virtual register", MO, MONum);
406 else if (MI->getOpcode() != TargetInstrInfo::PHI)
407 MInfo.vregsLiveIn.insert(std::make_pair(Reg, MI));
413 // TODO: verify that earlyclobber ops are not used.
415 addRegWithSubRegs(regsDead, Reg);
417 addRegWithSubRegs(regsDefined, Reg);
420 // Check register classes.
421 if (MONum < TI.getNumOperands() && !MO->isImplicit()) {
422 const TargetOperandInfo &TOI = TI.OpInfo[MONum];
423 unsigned SubIdx = MO->getSubReg();
425 if (TargetRegisterInfo::isPhysicalRegister(Reg)) {
428 unsigned s = TRI->getSubReg(Reg, SubIdx);
430 report("Invalid subregister index for physical register",
436 if (const TargetRegisterClass *DRC = TOI.getRegClass(TRI)) {
437 if (!DRC->contains(sr)) {
438 report("Illegal physical register for instruction", MO, MONum);
439 *OS << TRI->getName(sr) << " is not a "
440 << DRC->getName() << " register.\n";
445 const TargetRegisterClass *RC = MRI->getRegClass(Reg);
447 if (RC->subregclasses_begin()+SubIdx >= RC->subregclasses_end()) {
448 report("Invalid subregister index for virtual register", MO, MONum);
451 RC = *(RC->subregclasses_begin()+SubIdx);
453 if (const TargetRegisterClass *DRC = TOI.getRegClass(TRI)) {
454 if (RC != DRC && !RC->hasSuperClass(DRC)) {
455 report("Illegal virtual register for instruction", MO, MONum);
456 *OS << "Expected a " << DRC->getName() << " register, but got a "
457 << RC->getName() << " register\n";
464 // Can PHI instrs refer to MBBs not in the CFG? X86 and ARM do.
465 // case MachineOperand::MO_MachineBasicBlock:
466 // if (MI->getOpcode() == TargetInstrInfo::PHI) {
467 // if (!MO->getMBB()->isSuccessor(MI->getParent()))
468 // report("PHI operand is not in the CFG", MO, MONum);
477 MachineVerifier::visitMachineInstrAfter(const MachineInstr *MI)
479 BBInfo &MInfo = MBBInfoMap[MI->getParent()];
480 set_union(MInfo.regsKilled, regsKilled);
481 set_subtract(regsLive, regsKilled);
484 // Verify that both <def> and <def,dead> operands refer to dead registers.
485 RegVector defs(regsDefined);
486 defs.append(regsDead.begin(), regsDead.end());
488 for (RegVector::const_iterator I = defs.begin(), E = defs.end();
490 if (regsLive.count(*I)) {
491 if (TargetRegisterInfo::isPhysicalRegister(*I)) {
492 if (!allowPhysDoubleDefs && !isReserved(*I) &&
493 !regsLiveInButUnused.count(*I)) {
494 report("Redefining a live physical register", MI);
495 *OS << "Register " << TRI->getName(*I)
496 << " was defined but already live.\n";
499 if (!allowVirtDoubleDefs) {
500 report("Redefining a live virtual register", MI);
501 *OS << "Virtual register %reg" << *I
502 << " was defined but already live.\n";
505 } else if (TargetRegisterInfo::isVirtualRegister(*I) &&
506 !MInfo.regsKilled.count(*I)) {
507 // Virtual register defined without being killed first must be dead on
509 MInfo.vregsDeadIn.insert(std::make_pair(*I, MI));
513 set_subtract(regsLive, regsDead); regsDead.clear();
514 set_union(regsLive, regsDefined); regsDefined.clear();
518 MachineVerifier::visitMachineBasicBlockAfter(const MachineBasicBlock *MBB)
520 MBBInfoMap[MBB].regsLiveOut = regsLive;
524 // Calculate the largest possible vregsPassed sets. These are the registers that
525 // can pass through an MBB live, but may not be live every time. It is assumed
526 // that all vregsPassed sets are empty before the call.
528 MachineVerifier::calcMaxRegsPassed()
530 // First push live-out regs to successors' vregsPassed. Remember the MBBs that
531 // have any vregsPassed.
532 DenseSet<const MachineBasicBlock*> todo;
533 for (MachineFunction::const_iterator MFI = MF->begin(), MFE = MF->end();
535 const MachineBasicBlock &MBB(*MFI);
536 BBInfo &MInfo = MBBInfoMap[&MBB];
537 if (!MInfo.reachable)
539 for (MachineBasicBlock::const_succ_iterator SuI = MBB.succ_begin(),
540 SuE = MBB.succ_end(); SuI != SuE; ++SuI) {
541 BBInfo &SInfo = MBBInfoMap[*SuI];
542 if (SInfo.addPassed(MInfo.regsLiveOut))
547 // Iteratively push vregsPassed to successors. This will converge to the same
548 // final state regardless of DenseSet iteration order.
549 while (!todo.empty()) {
550 const MachineBasicBlock *MBB = *todo.begin();
552 BBInfo &MInfo = MBBInfoMap[MBB];
553 for (MachineBasicBlock::const_succ_iterator SuI = MBB->succ_begin(),
554 SuE = MBB->succ_end(); SuI != SuE; ++SuI) {
557 BBInfo &SInfo = MBBInfoMap[*SuI];
558 if (SInfo.addPassed(MInfo.vregsPassed))
564 // Calculate the minimum vregsPassed set. These are the registers that always
565 // pass live through an MBB. The calculation assumes that calcMaxRegsPassed has
566 // been called earlier.
568 MachineVerifier::calcMinRegsPassed()
570 DenseSet<const MachineBasicBlock*> todo;
571 for (MachineFunction::const_iterator MFI = MF->begin(), MFE = MF->end();
575 while (!todo.empty()) {
576 const MachineBasicBlock *MBB = *todo.begin();
578 BBInfo &MInfo = MBBInfoMap[MBB];
580 // Remove entries from vRegsPassed that are not live out from all
581 // reachable predecessors.
583 for (RegSet::iterator I = MInfo.vregsPassed.begin(),
584 E = MInfo.vregsPassed.end(); I != E; ++I) {
585 for (MachineBasicBlock::const_pred_iterator PrI = MBB->pred_begin(),
586 PrE = MBB->pred_end(); PrI != PrE; ++PrI) {
587 BBInfo &PrInfo = MBBInfoMap[*PrI];
588 if (PrInfo.reachable && !PrInfo.isLiveOut(*I)) {
594 // If any regs removed, we need to recheck successors.
596 set_subtract(MInfo.vregsPassed, dead);
597 todo.insert(MBB->succ_begin(), MBB->succ_end());
602 // Check PHI instructions at the beginning of MBB. It is assumed that
603 // calcMinRegsPassed has been run so BBInfo::isLiveOut is valid.
605 MachineVerifier::checkPHIOps(const MachineBasicBlock *MBB)
607 for (MachineBasicBlock::const_iterator BBI = MBB->begin(), BBE = MBB->end();
608 BBI != BBE && BBI->getOpcode() == TargetInstrInfo::PHI; ++BBI) {
609 DenseSet<const MachineBasicBlock*> seen;
611 for (unsigned i = 1, e = BBI->getNumOperands(); i != e; i += 2) {
612 unsigned Reg = BBI->getOperand(i).getReg();
613 const MachineBasicBlock *Pre = BBI->getOperand(i + 1).getMBB();
614 if (!Pre->isSuccessor(MBB))
617 BBInfo &PrInfo = MBBInfoMap[Pre];
618 if (PrInfo.reachable && !PrInfo.isLiveOut(Reg))
619 report("PHI operand is not live-out from predecessor",
620 &BBI->getOperand(i), i);
623 // Did we see all predecessors?
624 for (MachineBasicBlock::const_pred_iterator PrI = MBB->pred_begin(),
625 PrE = MBB->pred_end(); PrI != PrE; ++PrI) {
626 if (!seen.count(*PrI)) {
627 report("Missing PHI operand", BBI);
628 *OS << "MBB #" << (*PrI)->getNumber()
629 << " is a predecessor according to the CFG.\n";
636 MachineVerifier::visitMachineFunctionAfter()
640 // With the maximal set of vregsPassed we can verify dead-in registers.
641 for (MachineFunction::const_iterator MFI = MF->begin(), MFE = MF->end();
643 BBInfo &MInfo = MBBInfoMap[MFI];
645 // Skip unreachable MBBs.
646 if (!MInfo.reachable)
649 for (MachineBasicBlock::const_pred_iterator PrI = MFI->pred_begin(),
650 PrE = MFI->pred_end(); PrI != PrE; ++PrI) {
651 BBInfo &PrInfo = MBBInfoMap[*PrI];
652 if (!PrInfo.reachable)
655 // Verify physical live-ins. EH landing pads have magic live-ins so we
657 if (!MFI->isLandingPad()) {
658 for (MachineBasicBlock::const_livein_iterator I = MFI->livein_begin(),
659 E = MFI->livein_end(); I != E; ++I) {
660 if (TargetRegisterInfo::isPhysicalRegister(*I) &&
661 !isReserved (*I) && !PrInfo.isLiveOut(*I)) {
662 report("Live-in physical register is not live-out from predecessor",
664 *OS << "Register " << TRI->getName(*I)
665 << " is not live-out from MBB #" << (*PrI)->getNumber()
672 // Verify dead-in virtual registers.
673 if (!allowVirtDoubleDefs) {
674 for (RegMap::iterator I = MInfo.vregsDeadIn.begin(),
675 E = MInfo.vregsDeadIn.end(); I != E; ++I) {
676 // DeadIn register must be in neither regsLiveOut or vregsPassed of
678 if (PrInfo.isLiveOut(I->first)) {
679 report("Live-in virtual register redefined", I->second);
680 *OS << "Register %reg" << I->first
681 << " was live-out from predecessor MBB #"
682 << (*PrI)->getNumber() << ".\n";
691 // With the minimal set of vregsPassed we can verify live-in virtual
692 // registers, including PHI instructions.
693 for (MachineFunction::const_iterator MFI = MF->begin(), MFE = MF->end();
695 BBInfo &MInfo = MBBInfoMap[MFI];
697 // Skip unreachable MBBs.
698 if (!MInfo.reachable)
703 for (MachineBasicBlock::const_pred_iterator PrI = MFI->pred_begin(),
704 PrE = MFI->pred_end(); PrI != PrE; ++PrI) {
705 BBInfo &PrInfo = MBBInfoMap[*PrI];
706 if (!PrInfo.reachable)
709 for (RegMap::iterator I = MInfo.vregsLiveIn.begin(),
710 E = MInfo.vregsLiveIn.end(); I != E; ++I) {
711 if (!PrInfo.isLiveOut(I->first)) {
712 report("Used virtual register is not live-in", I->second);
713 *OS << "Register %reg" << I->first
714 << " is not live-out from predecessor MBB #"
715 << (*PrI)->getNumber()