blob: 7c64fc65e60c7f6e6e16fbdc2e300181b7890dde [file] [log] [blame]
Bill Wendling5567bb02010-08-19 18:52:17 +00001//===-- MachineVerifier.cpp - Machine Code Verifier -----------------------===//
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// Pass to verify generated machine code. The following is checked:
11//
12// Operand counts: All explicit operands must be present.
13//
14// Register classes: All physical and virtual register operands must be
15// compatible with the register class required by the instruction descriptor.
16//
17// Register live intervals: Registers must be defined only once, and must be
18// defined before use.
19//
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//===----------------------------------------------------------------------===//
25
Bill Wendlingd29052b2011-05-04 22:54:05 +000026#include "llvm/Instructions.h"
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +000027#include "llvm/Function.h"
Jakob Stoklund Olesen1fe9c342010-08-05 22:32:21 +000028#include "llvm/CodeGen/LiveIntervalAnalysis.h"
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +000029#include "llvm/CodeGen/LiveVariables.h"
Jakob Stoklund Olesene8f08232010-11-01 19:49:52 +000030#include "llvm/CodeGen/LiveStackAnalysis.h"
Jakob Stoklund Olesen30e98a02012-02-29 00:33:41 +000031#include "llvm/CodeGen/MachineInstrBundle.h"
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +000032#include "llvm/CodeGen/MachineFunctionPass.h"
Jakob Stoklund Olesena6b677d2009-08-13 16:19:51 +000033#include "llvm/CodeGen/MachineFrameInfo.h"
Dan Gohman2dbc4c82009-10-07 17:36:00 +000034#include "llvm/CodeGen/MachineMemOperand.h"
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +000035#include "llvm/CodeGen/MachineRegisterInfo.h"
36#include "llvm/CodeGen/Passes.h"
Bill Wendlingd29052b2011-05-04 22:54:05 +000037#include "llvm/MC/MCAsmInfo.h"
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +000038#include "llvm/Target/TargetMachine.h"
39#include "llvm/Target/TargetRegisterInfo.h"
40#include "llvm/Target/TargetInstrInfo.h"
Chris Lattnercf143a42009-08-23 03:13:20 +000041#include "llvm/ADT/DenseSet.h"
42#include "llvm/ADT/SetOperations.h"
43#include "llvm/ADT/SmallVector.h"
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +000044#include "llvm/Support/Debug.h"
Torok Edwin7d696d82009-07-11 13:10:19 +000045#include "llvm/Support/ErrorHandling.h"
46#include "llvm/Support/raw_ostream.h"
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +000047using namespace llvm;
48
49namespace {
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +000050 struct MachineVerifier {
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +000051
Jakob Stoklund Olesen89cab932010-12-18 00:06:56 +000052 MachineVerifier(Pass *pass, const char *b) :
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +000053 PASS(pass),
Jakob Stoklund Olesen89cab932010-12-18 00:06:56 +000054 Banner(b),
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +000055 OutFileName(getenv("LLVM_VERIFY_MACHINEINSTRS"))
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +000056 {}
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +000057
58 bool runOnMachineFunction(MachineFunction &MF);
59
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +000060 Pass *const PASS;
Jakob Stoklund Olesen89cab932010-12-18 00:06:56 +000061 const char *Banner;
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +000062 const char *const OutFileName;
Chris Lattner17e9edc2009-08-23 02:51:22 +000063 raw_ostream *OS;
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +000064 const MachineFunction *MF;
65 const TargetMachine *TM;
Evan Cheng15993f82011-06-27 21:26:13 +000066 const TargetInstrInfo *TII;
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +000067 const TargetRegisterInfo *TRI;
68 const MachineRegisterInfo *MRI;
69
70 unsigned foundErrors;
71
72 typedef SmallVector<unsigned, 16> RegVector;
Jakob Stoklund Olesen9ca12d22012-02-28 01:42:41 +000073 typedef SmallVector<const uint32_t*, 4> RegMaskVector;
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +000074 typedef DenseSet<unsigned> RegSet;
75 typedef DenseMap<unsigned, const MachineInstr*> RegMap;
76
Jakob Stoklund Olesen5adc07e2011-09-23 22:45:39 +000077 const MachineInstr *FirstTerminator;
78
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +000079 BitVector regsReserved;
Lang Hames03698de2012-02-14 19:17:48 +000080 BitVector regsAllocatable;
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +000081 RegSet regsLive;
Jakob Stoklund Olesen710b13b2009-08-08 13:19:25 +000082 RegVector regsDefined, regsDead, regsKilled;
Jakob Stoklund Olesen9ca12d22012-02-28 01:42:41 +000083 RegMaskVector regMasks;
Jakob Stoklund Olesen710b13b2009-08-08 13:19:25 +000084 RegSet regsLiveInButUnused;
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +000085
Jakob Stoklund Olesenfc69c372011-01-12 21:27:48 +000086 SlotIndex lastIndex;
87
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +000088 // Add Reg and any sub-registers to RV
89 void addRegWithSubRegs(RegVector &RV, unsigned Reg) {
90 RV.push_back(Reg);
91 if (TargetRegisterInfo::isPhysicalRegister(Reg))
Jakob Stoklund Olesen396618b2012-06-01 23:28:30 +000092 for (MCSubRegIterator SubRegs(Reg, TRI); SubRegs.isValid(); ++SubRegs)
93 RV.push_back(*SubRegs);
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +000094 }
95
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +000096 struct BBInfo {
97 // Is this MBB reachable from the MF entry point?
98 bool reachable;
99
100 // Vregs that must be live in because they are used without being
101 // defined. Map value is the user.
102 RegMap vregsLiveIn;
103
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000104 // Regs killed in MBB. They may be defined again, and will then be in both
105 // regsKilled and regsLiveOut.
106 RegSet regsKilled;
107
108 // Regs defined in MBB and live out. Note that vregs passing through may
109 // be live out without being mentioned here.
110 RegSet regsLiveOut;
111
112 // Vregs that pass through MBB untouched. This set is disjoint from
113 // regsKilled and regsLiveOut.
114 RegSet vregsPassed;
115
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +0000116 // Vregs that must pass through MBB because they are needed by a successor
117 // block. This set is disjoint from regsLiveOut.
118 RegSet vregsRequired;
119
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000120 BBInfo() : reachable(false) {}
121
122 // Add register to vregsPassed if it belongs there. Return true if
123 // anything changed.
124 bool addPassed(unsigned Reg) {
125 if (!TargetRegisterInfo::isVirtualRegister(Reg))
126 return false;
127 if (regsKilled.count(Reg) || regsLiveOut.count(Reg))
128 return false;
129 return vregsPassed.insert(Reg).second;
130 }
131
132 // Same for a full set.
133 bool addPassed(const RegSet &RS) {
134 bool changed = false;
135 for (RegSet::const_iterator I = RS.begin(), E = RS.end(); I != E; ++I)
136 if (addPassed(*I))
137 changed = true;
138 return changed;
139 }
140
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +0000141 // Add register to vregsRequired if it belongs there. Return true if
142 // anything changed.
143 bool addRequired(unsigned Reg) {
144 if (!TargetRegisterInfo::isVirtualRegister(Reg))
145 return false;
146 if (regsLiveOut.count(Reg))
147 return false;
148 return vregsRequired.insert(Reg).second;
149 }
150
151 // Same for a full set.
152 bool addRequired(const RegSet &RS) {
153 bool changed = false;
154 for (RegSet::const_iterator I = RS.begin(), E = RS.end(); I != E; ++I)
155 if (addRequired(*I))
156 changed = true;
157 return changed;
158 }
159
160 // Same for a full map.
161 bool addRequired(const RegMap &RM) {
162 bool changed = false;
163 for (RegMap::const_iterator I = RM.begin(), E = RM.end(); I != E; ++I)
164 if (addRequired(I->first))
165 changed = true;
166 return changed;
167 }
168
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000169 // Live-out registers are either in regsLiveOut or vregsPassed.
170 bool isLiveOut(unsigned Reg) const {
171 return regsLiveOut.count(Reg) || vregsPassed.count(Reg);
172 }
173 };
174
175 // Extra register info per MBB.
176 DenseMap<const MachineBasicBlock*, BBInfo> MBBInfoMap;
177
178 bool isReserved(unsigned Reg) {
Jakob Stoklund Olesend37bc5a2009-08-04 19:18:01 +0000179 return Reg < regsReserved.size() && regsReserved.test(Reg);
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000180 }
181
Lang Hames03698de2012-02-14 19:17:48 +0000182 bool isAllocatable(unsigned Reg) {
183 return Reg < regsAllocatable.size() && regsAllocatable.test(Reg);
184 }
185
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +0000186 // Analysis information if available
187 LiveVariables *LiveVars;
Jakob Stoklund Olesen501dc422010-10-26 22:36:07 +0000188 LiveIntervals *LiveInts;
Jakob Stoklund Olesene8f08232010-11-01 19:49:52 +0000189 LiveStacks *LiveStks;
Jakob Stoklund Olesenf4a1e1a2010-10-26 20:21:46 +0000190 SlotIndexes *Indexes;
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +0000191
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000192 void visitMachineFunctionBefore();
193 void visitMachineBasicBlockBefore(const MachineBasicBlock *MBB);
Jakob Stoklund Olesen1f9c3ec2012-06-06 22:34:30 +0000194 void visitMachineBundleBefore(const MachineInstr *MI);
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000195 void visitMachineInstrBefore(const MachineInstr *MI);
196 void visitMachineOperand(const MachineOperand *MO, unsigned MONum);
197 void visitMachineInstrAfter(const MachineInstr *MI);
Jakob Stoklund Olesen1f9c3ec2012-06-06 22:34:30 +0000198 void visitMachineBundleAfter(const MachineInstr *MI);
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000199 void visitMachineBasicBlockAfter(const MachineBasicBlock *MBB);
200 void visitMachineFunctionAfter();
201
202 void report(const char *msg, const MachineFunction *MF);
203 void report(const char *msg, const MachineBasicBlock *MBB);
204 void report(const char *msg, const MachineInstr *MI);
205 void report(const char *msg, const MachineOperand *MO, unsigned MONum);
206
Jakob Stoklund Olesen948a4442012-03-28 20:47:35 +0000207 void checkLiveness(const MachineOperand *MO, unsigned MONum);
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000208 void markReachable(const MachineBasicBlock *MBB);
Jakob Stoklund Olesenb31defe2010-01-05 20:59:36 +0000209 void calcRegsPassed();
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000210 void checkPHIOps(const MachineBasicBlock *MBB);
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +0000211
212 void calcRegsRequired();
213 void verifyLiveVariables();
Jakob Stoklund Olesen58e12482010-08-06 18:04:19 +0000214 void verifyLiveIntervals();
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000215 };
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +0000216
217 struct MachineVerifierPass : public MachineFunctionPass {
218 static char ID; // Pass ID, replacement for typeid
Jakob Stoklund Olesen89cab932010-12-18 00:06:56 +0000219 const char *const Banner;
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +0000220
Jakob Stoklund Olesen89cab932010-12-18 00:06:56 +0000221 MachineVerifierPass(const char *b = 0)
222 : MachineFunctionPass(ID), Banner(b) {
Owen Anderson081c34b2010-10-19 17:21:58 +0000223 initializeMachineVerifierPassPass(*PassRegistry::getPassRegistry());
224 }
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +0000225
226 void getAnalysisUsage(AnalysisUsage &AU) const {
227 AU.setPreservesAll();
228 MachineFunctionPass::getAnalysisUsage(AU);
229 }
230
231 bool runOnMachineFunction(MachineFunction &MF) {
Jakob Stoklund Olesen89cab932010-12-18 00:06:56 +0000232 MF.verify(this, Banner);
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +0000233 return false;
234 }
235 };
236
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000237}
238
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +0000239char MachineVerifierPass::ID = 0;
Owen Anderson02dd53e2010-08-23 17:52:01 +0000240INITIALIZE_PASS(MachineVerifierPass, "machineverifier",
Owen Andersonce665bd2010-10-07 22:25:06 +0000241 "Verify generated machine code", false, false)
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000242
Jakob Stoklund Olesen89cab932010-12-18 00:06:56 +0000243FunctionPass *llvm::createMachineVerifierPass(const char *Banner) {
244 return new MachineVerifierPass(Banner);
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000245}
246
Jakob Stoklund Olesen89cab932010-12-18 00:06:56 +0000247void MachineFunction::verify(Pass *p, const char *Banner) const {
248 MachineVerifier(p, Banner)
249 .runOnMachineFunction(const_cast<MachineFunction&>(*this));
Jakob Stoklund Olesence727d02009-11-13 21:56:09 +0000250}
251
Chris Lattner17e9edc2009-08-23 02:51:22 +0000252bool MachineVerifier::runOnMachineFunction(MachineFunction &MF) {
253 raw_ostream *OutFile = 0;
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000254 if (OutFileName) {
Chris Lattner17e9edc2009-08-23 02:51:22 +0000255 std::string ErrorInfo;
256 OutFile = new raw_fd_ostream(OutFileName, ErrorInfo,
257 raw_fd_ostream::F_Append);
258 if (!ErrorInfo.empty()) {
259 errs() << "Error opening '" << OutFileName << "': " << ErrorInfo << '\n';
260 exit(1);
261 }
Jakob Stoklund Olesenb44fad72009-10-04 18:18:39 +0000262
Chris Lattner17e9edc2009-08-23 02:51:22 +0000263 OS = OutFile;
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000264 } else {
Chris Lattner17e9edc2009-08-23 02:51:22 +0000265 OS = &errs();
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000266 }
267
268 foundErrors = 0;
269
270 this->MF = &MF;
271 TM = &MF.getTarget();
Evan Cheng15993f82011-06-27 21:26:13 +0000272 TII = TM->getInstrInfo();
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000273 TRI = TM->getRegisterInfo();
274 MRI = &MF.getRegInfo();
275
Jakob Stoklund Olesenc910c8d2010-08-05 23:51:26 +0000276 LiveVars = NULL;
277 LiveInts = NULL;
Jakob Stoklund Olesene8f08232010-11-01 19:49:52 +0000278 LiveStks = NULL;
Jakob Stoklund Olesenf4a1e1a2010-10-26 20:21:46 +0000279 Indexes = NULL;
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +0000280 if (PASS) {
Jakob Stoklund Olesen1fe9c342010-08-05 22:32:21 +0000281 LiveInts = PASS->getAnalysisIfAvailable<LiveIntervals>();
Jakob Stoklund Olesenc910c8d2010-08-05 23:51:26 +0000282 // We don't want to verify LiveVariables if LiveIntervals is available.
283 if (!LiveInts)
284 LiveVars = PASS->getAnalysisIfAvailable<LiveVariables>();
Jakob Stoklund Olesene8f08232010-11-01 19:49:52 +0000285 LiveStks = PASS->getAnalysisIfAvailable<LiveStacks>();
Jakob Stoklund Olesenf4a1e1a2010-10-26 20:21:46 +0000286 Indexes = PASS->getAnalysisIfAvailable<SlotIndexes>();
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +0000287 }
288
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000289 visitMachineFunctionBefore();
290 for (MachineFunction::const_iterator MFI = MF.begin(), MFE = MF.end();
291 MFI!=MFE; ++MFI) {
292 visitMachineBasicBlockBefore(MFI);
Jakob Stoklund Olesen1f9c3ec2012-06-06 22:34:30 +0000293 // Keep track of the current bundle header.
294 const MachineInstr *CurBundle = 0;
Evan Chengddfd1372011-12-14 02:11:42 +0000295 for (MachineBasicBlock::const_instr_iterator MBBI = MFI->instr_begin(),
296 MBBE = MFI->instr_end(); MBBI != MBBE; ++MBBI) {
Jakob Stoklund Olesen7bd46da2011-01-12 21:27:41 +0000297 if (MBBI->getParent() != MFI) {
298 report("Bad instruction parent pointer", MFI);
299 *OS << "Instruction: " << *MBBI;
300 continue;
301 }
Jakob Stoklund Olesen1f9c3ec2012-06-06 22:34:30 +0000302 // Is this a bundle header?
303 if (!MBBI->isInsideBundle()) {
304 if (CurBundle)
305 visitMachineBundleAfter(CurBundle);
306 CurBundle = MBBI;
307 visitMachineBundleBefore(CurBundle);
308 } else if (!CurBundle)
309 report("No bundle header", MBBI);
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000310 visitMachineInstrBefore(MBBI);
311 for (unsigned I = 0, E = MBBI->getNumOperands(); I != E; ++I)
312 visitMachineOperand(&MBBI->getOperand(I), I);
313 visitMachineInstrAfter(MBBI);
314 }
Jakob Stoklund Olesen1f9c3ec2012-06-06 22:34:30 +0000315 if (CurBundle)
316 visitMachineBundleAfter(CurBundle);
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000317 visitMachineBasicBlockAfter(MFI);
318 }
319 visitMachineFunctionAfter();
320
Chris Lattner17e9edc2009-08-23 02:51:22 +0000321 if (OutFile)
322 delete OutFile;
323 else if (foundErrors)
Chris Lattner75361b62010-04-07 22:58:41 +0000324 report_fatal_error("Found "+Twine(foundErrors)+" machine code errors.");
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000325
Jakob Stoklund Olesen63496682009-08-08 15:34:50 +0000326 // Clean up.
327 regsLive.clear();
328 regsDefined.clear();
329 regsDead.clear();
330 regsKilled.clear();
Jakob Stoklund Olesen9ca12d22012-02-28 01:42:41 +0000331 regMasks.clear();
Jakob Stoklund Olesen63496682009-08-08 15:34:50 +0000332 regsLiveInButUnused.clear();
333 MBBInfoMap.clear();
334
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000335 return false; // no changes
336}
337
Chris Lattner372fefe2009-08-23 01:03:30 +0000338void MachineVerifier::report(const char *msg, const MachineFunction *MF) {
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000339 assert(MF);
Chris Lattner17e9edc2009-08-23 02:51:22 +0000340 *OS << '\n';
Jakob Stoklund Olesen89cab932010-12-18 00:06:56 +0000341 if (!foundErrors++) {
342 if (Banner)
343 *OS << "# " << Banner << '\n';
Jakob Stoklund Olesenf4a1e1a2010-10-26 20:21:46 +0000344 MF->print(*OS, Indexes);
Jakob Stoklund Olesen89cab932010-12-18 00:06:56 +0000345 }
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000346 *OS << "*** Bad machine code: " << msg << " ***\n"
Benjamin Kramera7b0cb72011-11-15 16:27:03 +0000347 << "- function: " << MF->getFunction()->getName() << "\n";
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000348}
349
Jakob Stoklund Olesenb44fad72009-10-04 18:18:39 +0000350void MachineVerifier::report(const char *msg, const MachineBasicBlock *MBB) {
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000351 assert(MBB);
352 report(msg, MBB->getParent());
Jakob Stoklund Olesen324da762009-11-20 01:17:03 +0000353 *OS << "- basic block: " << MBB->getName()
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000354 << " " << (void*)MBB
Jakob Stoklund Olesenf4a1e1a2010-10-26 20:21:46 +0000355 << " (BB#" << MBB->getNumber() << ")";
356 if (Indexes)
357 *OS << " [" << Indexes->getMBBStartIdx(MBB)
358 << ';' << Indexes->getMBBEndIdx(MBB) << ')';
359 *OS << '\n';
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000360}
361
Jakob Stoklund Olesenb44fad72009-10-04 18:18:39 +0000362void MachineVerifier::report(const char *msg, const MachineInstr *MI) {
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000363 assert(MI);
364 report(msg, MI->getParent());
365 *OS << "- instruction: ";
Jakob Stoklund Olesenf4a1e1a2010-10-26 20:21:46 +0000366 if (Indexes && Indexes->hasIndex(MI))
367 *OS << Indexes->getInstructionIndex(MI) << '\t';
Chris Lattner705e07f2009-08-23 03:41:05 +0000368 MI->print(*OS, TM);
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000369}
370
Jakob Stoklund Olesenb44fad72009-10-04 18:18:39 +0000371void MachineVerifier::report(const char *msg,
372 const MachineOperand *MO, unsigned MONum) {
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000373 assert(MO);
374 report(msg, MO->getParent());
375 *OS << "- operand " << MONum << ": ";
376 MO->print(*OS, TM);
377 *OS << "\n";
378}
379
Jakob Stoklund Olesenb44fad72009-10-04 18:18:39 +0000380void MachineVerifier::markReachable(const MachineBasicBlock *MBB) {
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000381 BBInfo &MInfo = MBBInfoMap[MBB];
382 if (!MInfo.reachable) {
383 MInfo.reachable = true;
384 for (MachineBasicBlock::const_succ_iterator SuI = MBB->succ_begin(),
385 SuE = MBB->succ_end(); SuI != SuE; ++SuI)
386 markReachable(*SuI);
387 }
388}
389
Jakob Stoklund Olesenb44fad72009-10-04 18:18:39 +0000390void MachineVerifier::visitMachineFunctionBefore() {
Jakob Stoklund Olesenfc69c372011-01-12 21:27:48 +0000391 lastIndex = SlotIndex();
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000392 regsReserved = TRI->getReservedRegs(*MF);
Jakob Stoklund Olesend37bc5a2009-08-04 19:18:01 +0000393
394 // A sub-register of a reserved register is also reserved
395 for (int Reg = regsReserved.find_first(); Reg>=0;
396 Reg = regsReserved.find_next(Reg)) {
Jakob Stoklund Olesen396618b2012-06-01 23:28:30 +0000397 for (MCSubRegIterator SubRegs(Reg, TRI); SubRegs.isValid(); ++SubRegs) {
Jakob Stoklund Olesend37bc5a2009-08-04 19:18:01 +0000398 // FIXME: This should probably be:
Jakob Stoklund Olesen396618b2012-06-01 23:28:30 +0000399 // assert(regsReserved.test(*SubRegs) && "Non-reserved sub-register");
400 regsReserved.set(*SubRegs);
Jakob Stoklund Olesend37bc5a2009-08-04 19:18:01 +0000401 }
402 }
Lang Hames03698de2012-02-14 19:17:48 +0000403
404 regsAllocatable = TRI->getAllocatableSet(*MF);
405
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000406 markReachable(&MF->front());
407}
408
Jakob Stoklund Olesen1dc0fcb2009-11-13 21:55:54 +0000409// Does iterator point to a and b as the first two elements?
Dan Gohmanb3579832010-04-15 17:08:50 +0000410static bool matchPair(MachineBasicBlock::const_succ_iterator i,
411 const MachineBasicBlock *a, const MachineBasicBlock *b) {
Jakob Stoklund Olesen1dc0fcb2009-11-13 21:55:54 +0000412 if (*i == a)
413 return *++i == b;
414 if (*i == b)
415 return *++i == a;
416 return false;
417}
418
419void
420MachineVerifier::visitMachineBasicBlockBefore(const MachineBasicBlock *MBB) {
Jakob Stoklund Olesen5adc07e2011-09-23 22:45:39 +0000421 FirstTerminator = 0;
422
Lang Hames03698de2012-02-14 19:17:48 +0000423 if (MRI->isSSA()) {
424 // If this block has allocatable physical registers live-in, check that
425 // it is an entry block or landing pad.
426 for (MachineBasicBlock::livein_iterator LI = MBB->livein_begin(),
427 LE = MBB->livein_end();
428 LI != LE; ++LI) {
429 unsigned reg = *LI;
430 if (isAllocatable(reg) && !MBB->isLandingPad() &&
431 MBB != MBB->getParent()->begin()) {
432 report("MBB has allocable live-in, but isn't entry or landing-pad.", MBB);
433 }
434 }
435 }
436
Jakob Stoklund Olesen0a7bbcb2010-10-21 18:47:06 +0000437 // Count the number of landing pad successors.
Cameron Zwarich2100d212010-12-20 04:19:48 +0000438 SmallPtrSet<MachineBasicBlock*, 4> LandingPadSuccs;
Jakob Stoklund Olesen0a7bbcb2010-10-21 18:47:06 +0000439 for (MachineBasicBlock::const_succ_iterator I = MBB->succ_begin(),
Cameron Zwarich2100d212010-12-20 04:19:48 +0000440 E = MBB->succ_end(); I != E; ++I) {
441 if ((*I)->isLandingPad())
442 LandingPadSuccs.insert(*I);
443 }
Bill Wendlingd29052b2011-05-04 22:54:05 +0000444
445 const MCAsmInfo *AsmInfo = TM->getMCAsmInfo();
446 const BasicBlock *BB = MBB->getBasicBlock();
447 if (LandingPadSuccs.size() > 1 &&
448 !(AsmInfo &&
449 AsmInfo->getExceptionHandlingType() == ExceptionHandling::SjLj &&
450 BB && isa<SwitchInst>(BB->getTerminator())))
Jakob Stoklund Olesen0a7bbcb2010-10-21 18:47:06 +0000451 report("MBB has more than one landing pad successor", MBB);
452
Dan Gohman27920592009-08-27 02:43:49 +0000453 // Call AnalyzeBranch. If it succeeds, there several more conditions to check.
454 MachineBasicBlock *TBB = 0, *FBB = 0;
455 SmallVector<MachineOperand, 4> Cond;
456 if (!TII->AnalyzeBranch(*const_cast<MachineBasicBlock *>(MBB),
457 TBB, FBB, Cond)) {
458 // Ok, AnalyzeBranch thinks it knows what's going on with this block. Let's
459 // check whether its answers match up with reality.
460 if (!TBB && !FBB) {
461 // Block falls through to its successor.
462 MachineFunction::const_iterator MBBI = MBB;
463 ++MBBI;
464 if (MBBI == MF->end()) {
Dan Gohmana01a80f2009-08-27 18:14:26 +0000465 // It's possible that the block legitimately ends with a noreturn
466 // call or an unreachable, in which case it won't actually fall
467 // out the bottom of the function.
Cameron Zwarich2100d212010-12-20 04:19:48 +0000468 } else if (MBB->succ_size() == LandingPadSuccs.size()) {
Dan Gohmana01a80f2009-08-27 18:14:26 +0000469 // It's possible that the block legitimately ends with a noreturn
470 // call or an unreachable, in which case it won't actuall fall
471 // out of the block.
Cameron Zwarich2100d212010-12-20 04:19:48 +0000472 } else if (MBB->succ_size() != 1+LandingPadSuccs.size()) {
Dan Gohman27920592009-08-27 02:43:49 +0000473 report("MBB exits via unconditional fall-through but doesn't have "
474 "exactly one CFG successor!", MBB);
Jakob Stoklund Olesen0a7bbcb2010-10-21 18:47:06 +0000475 } else if (!MBB->isSuccessor(MBBI)) {
Dan Gohman27920592009-08-27 02:43:49 +0000476 report("MBB exits via unconditional fall-through but its successor "
477 "differs from its CFG successor!", MBB);
478 }
Evan Cheng5a96b3d2011-12-07 07:15:52 +0000479 if (!MBB->empty() && MBB->back().isBarrier() &&
Evan Cheng86050dc2010-06-18 23:09:54 +0000480 !TII->isPredicated(&MBB->back())) {
Dan Gohman27920592009-08-27 02:43:49 +0000481 report("MBB exits via unconditional fall-through but ends with a "
482 "barrier instruction!", MBB);
483 }
484 if (!Cond.empty()) {
485 report("MBB exits via unconditional fall-through but has a condition!",
486 MBB);
487 }
488 } else if (TBB && !FBB && Cond.empty()) {
489 // Block unconditionally branches somewhere.
Cameron Zwarich2100d212010-12-20 04:19:48 +0000490 if (MBB->succ_size() != 1+LandingPadSuccs.size()) {
Dan Gohman27920592009-08-27 02:43:49 +0000491 report("MBB exits via unconditional branch but doesn't have "
492 "exactly one CFG successor!", MBB);
Jakob Stoklund Olesen0a7bbcb2010-10-21 18:47:06 +0000493 } else if (!MBB->isSuccessor(TBB)) {
Dan Gohman27920592009-08-27 02:43:49 +0000494 report("MBB exits via unconditional branch but the CFG "
495 "successor doesn't match the actual successor!", MBB);
496 }
497 if (MBB->empty()) {
498 report("MBB exits via unconditional branch but doesn't contain "
499 "any instructions!", MBB);
Evan Cheng5a96b3d2011-12-07 07:15:52 +0000500 } else if (!MBB->back().isBarrier()) {
Dan Gohman27920592009-08-27 02:43:49 +0000501 report("MBB exits via unconditional branch but doesn't end with a "
502 "barrier instruction!", MBB);
Evan Cheng5a96b3d2011-12-07 07:15:52 +0000503 } else if (!MBB->back().isTerminator()) {
Dan Gohman27920592009-08-27 02:43:49 +0000504 report("MBB exits via unconditional branch but the branch isn't a "
505 "terminator instruction!", MBB);
506 }
507 } else if (TBB && !FBB && !Cond.empty()) {
508 // Block conditionally branches somewhere, otherwise falls through.
509 MachineFunction::const_iterator MBBI = MBB;
510 ++MBBI;
511 if (MBBI == MF->end()) {
512 report("MBB conditionally falls through out of function!", MBB);
513 } if (MBB->succ_size() != 2) {
514 report("MBB exits via conditional branch/fall-through but doesn't have "
515 "exactly two CFG successors!", MBB);
Jakob Stoklund Olesen1dc0fcb2009-11-13 21:55:54 +0000516 } else if (!matchPair(MBB->succ_begin(), TBB, MBBI)) {
Dan Gohman27920592009-08-27 02:43:49 +0000517 report("MBB exits via conditional branch/fall-through but the CFG "
518 "successors don't match the actual successors!", MBB);
519 }
520 if (MBB->empty()) {
521 report("MBB exits via conditional branch/fall-through but doesn't "
522 "contain any instructions!", MBB);
Evan Cheng5a96b3d2011-12-07 07:15:52 +0000523 } else if (MBB->back().isBarrier()) {
Dan Gohman27920592009-08-27 02:43:49 +0000524 report("MBB exits via conditional branch/fall-through but ends with a "
525 "barrier instruction!", MBB);
Evan Cheng5a96b3d2011-12-07 07:15:52 +0000526 } else if (!MBB->back().isTerminator()) {
Dan Gohman27920592009-08-27 02:43:49 +0000527 report("MBB exits via conditional branch/fall-through but the branch "
528 "isn't a terminator instruction!", MBB);
529 }
530 } else if (TBB && FBB) {
531 // Block conditionally branches somewhere, otherwise branches
532 // somewhere else.
533 if (MBB->succ_size() != 2) {
534 report("MBB exits via conditional branch/branch but doesn't have "
535 "exactly two CFG successors!", MBB);
Jakob Stoklund Olesen1dc0fcb2009-11-13 21:55:54 +0000536 } else if (!matchPair(MBB->succ_begin(), TBB, FBB)) {
Dan Gohman27920592009-08-27 02:43:49 +0000537 report("MBB exits via conditional branch/branch but the CFG "
538 "successors don't match the actual successors!", MBB);
539 }
540 if (MBB->empty()) {
541 report("MBB exits via conditional branch/branch but doesn't "
542 "contain any instructions!", MBB);
Evan Cheng5a96b3d2011-12-07 07:15:52 +0000543 } else if (!MBB->back().isBarrier()) {
Dan Gohman27920592009-08-27 02:43:49 +0000544 report("MBB exits via conditional branch/branch but doesn't end with a "
545 "barrier instruction!", MBB);
Evan Cheng5a96b3d2011-12-07 07:15:52 +0000546 } else if (!MBB->back().isTerminator()) {
Dan Gohman27920592009-08-27 02:43:49 +0000547 report("MBB exits via conditional branch/branch but the branch "
548 "isn't a terminator instruction!", MBB);
549 }
550 if (Cond.empty()) {
551 report("MBB exits via conditinal branch/branch but there's no "
552 "condition!", MBB);
553 }
554 } else {
555 report("AnalyzeBranch returned invalid data!", MBB);
556 }
557 }
558
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000559 regsLive.clear();
Dan Gohman81bf03e2010-04-13 16:57:55 +0000560 for (MachineBasicBlock::livein_iterator I = MBB->livein_begin(),
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000561 E = MBB->livein_end(); I != E; ++I) {
562 if (!TargetRegisterInfo::isPhysicalRegister(*I)) {
563 report("MBB live-in list contains non-physical register", MBB);
564 continue;
565 }
566 regsLive.insert(*I);
Jakob Stoklund Olesen396618b2012-06-01 23:28:30 +0000567 for (MCSubRegIterator SubRegs(*I, TRI); SubRegs.isValid(); ++SubRegs)
568 regsLive.insert(*SubRegs);
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000569 }
Jakob Stoklund Olesen710b13b2009-08-08 13:19:25 +0000570 regsLiveInButUnused = regsLive;
Jakob Stoklund Olesena6b677d2009-08-13 16:19:51 +0000571
572 const MachineFrameInfo *MFI = MF->getFrameInfo();
573 assert(MFI && "Function has no frame info");
574 BitVector PR = MFI->getPristineRegs(MBB);
575 for (int I = PR.find_first(); I>0; I = PR.find_next(I)) {
576 regsLive.insert(I);
Jakob Stoklund Olesen396618b2012-06-01 23:28:30 +0000577 for (MCSubRegIterator SubRegs(I, TRI); SubRegs.isValid(); ++SubRegs)
578 regsLive.insert(*SubRegs);
Jakob Stoklund Olesena6b677d2009-08-13 16:19:51 +0000579 }
580
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000581 regsKilled.clear();
582 regsDefined.clear();
Jakob Stoklund Olesenfc69c372011-01-12 21:27:48 +0000583
584 if (Indexes)
585 lastIndex = Indexes->getMBBStartIdx(MBB);
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000586}
587
Jakob Stoklund Olesen1f9c3ec2012-06-06 22:34:30 +0000588// This function gets called for all bundle headers, including normal
589// stand-alone unbundled instructions.
590void MachineVerifier::visitMachineBundleBefore(const MachineInstr *MI) {
591 if (Indexes && Indexes->hasIndex(MI)) {
592 SlotIndex idx = Indexes->getInstructionIndex(MI);
593 if (!(idx > lastIndex)) {
594 report("Instruction index out of order", MI);
595 *OS << "Last instruction was at " << lastIndex << '\n';
596 }
597 lastIndex = idx;
598 }
Pete Cooper83569cb2012-06-07 17:41:39 +0000599
600 // Ensure non-terminators don't follow terminators.
601 // Ignore predicated terminators formed by if conversion.
602 // FIXME: If conversion shouldn't need to violate this rule.
603 if (MI->isTerminator() && !TII->isPredicated(MI)) {
604 if (!FirstTerminator)
605 FirstTerminator = MI;
606 } else if (FirstTerminator) {
607 report("Non-terminator instruction after the first terminator", MI);
608 *OS << "First terminator was:\t" << *FirstTerminator;
609 }
Jakob Stoklund Olesen1f9c3ec2012-06-06 22:34:30 +0000610}
611
Jakob Stoklund Olesenb44fad72009-10-04 18:18:39 +0000612void MachineVerifier::visitMachineInstrBefore(const MachineInstr *MI) {
Evan Chenge837dea2011-06-28 19:10:37 +0000613 const MCInstrDesc &MCID = MI->getDesc();
614 if (MI->getNumOperands() < MCID.getNumOperands()) {
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000615 report("Too few operands", MI);
Evan Chenge837dea2011-06-28 19:10:37 +0000616 *OS << MCID.getNumOperands() << " operands expected, but "
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000617 << MI->getNumExplicitOperands() << " given.\n";
618 }
Dan Gohman2dbc4c82009-10-07 17:36:00 +0000619
620 // Check the MachineMemOperands for basic consistency.
621 for (MachineInstr::mmo_iterator I = MI->memoperands_begin(),
622 E = MI->memoperands_end(); I != E; ++I) {
Evan Cheng5a96b3d2011-12-07 07:15:52 +0000623 if ((*I)->isLoad() && !MI->mayLoad())
Dan Gohman2dbc4c82009-10-07 17:36:00 +0000624 report("Missing mayLoad flag", MI);
Evan Cheng5a96b3d2011-12-07 07:15:52 +0000625 if ((*I)->isStore() && !MI->mayStore())
Dan Gohman2dbc4c82009-10-07 17:36:00 +0000626 report("Missing mayStore flag", MI);
627 }
Jakob Stoklund Olesen1fe9c342010-08-05 22:32:21 +0000628
629 // Debug values must not have a slot index.
Jakob Stoklund Olesen121b1792012-02-27 18:24:30 +0000630 // Other instructions must have one, unless they are inside a bundle.
Jakob Stoklund Olesen1fe9c342010-08-05 22:32:21 +0000631 if (LiveInts) {
632 bool mapped = !LiveInts->isNotInMIMap(MI);
633 if (MI->isDebugValue()) {
634 if (mapped)
635 report("Debug instruction has a slot index", MI);
Jakob Stoklund Olesen121b1792012-02-27 18:24:30 +0000636 } else if (MI->isInsideBundle()) {
637 if (mapped)
638 report("Instruction inside bundle has a slot index", MI);
Jakob Stoklund Olesen1fe9c342010-08-05 22:32:21 +0000639 } else {
640 if (!mapped)
641 report("Missing slot index", MI);
642 }
643 }
644
Andrew Trick3be654f2011-09-21 02:20:46 +0000645 StringRef ErrorInfo;
646 if (!TII->verifyInstruction(MI, ErrorInfo))
647 report(ErrorInfo.data(), MI);
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000648}
649
650void
Jakob Stoklund Olesenb44fad72009-10-04 18:18:39 +0000651MachineVerifier::visitMachineOperand(const MachineOperand *MO, unsigned MONum) {
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000652 const MachineInstr *MI = MO->getParent();
Evan Chenge837dea2011-06-28 19:10:37 +0000653 const MCInstrDesc &MCID = MI->getDesc();
654 const MCOperandInfo &MCOI = MCID.OpInfo[MONum];
Jakob Stoklund Olesen44b27e52009-05-16 07:25:20 +0000655
Evan Chenge837dea2011-06-28 19:10:37 +0000656 // The first MCID.NumDefs operands must be explicit register defines
657 if (MONum < MCID.getNumDefs()) {
Jakob Stoklund Olesen44b27e52009-05-16 07:25:20 +0000658 if (!MO->isReg())
659 report("Explicit definition must be a register", MO, MONum);
Evan Chengcac58aa2012-05-29 19:40:44 +0000660 else if (!MO->isDef() && !MCOI.isOptionalDef())
Jakob Stoklund Olesen44b27e52009-05-16 07:25:20 +0000661 report("Explicit definition marked as use", MO, MONum);
662 else if (MO->isImplicit())
663 report("Explicit definition marked as implicit", MO, MONum);
Evan Chenge837dea2011-06-28 19:10:37 +0000664 } else if (MONum < MCID.getNumOperands()) {
Eric Christopher113a06c2010-11-17 00:55:36 +0000665 // Don't check if it's the last operand in a variadic instruction. See,
666 // e.g., LDM_RET in the arm back end.
Evan Chenge837dea2011-06-28 19:10:37 +0000667 if (MO->isReg() &&
Evan Cheng5a96b3d2011-12-07 07:15:52 +0000668 !(MI->isVariadic() && MONum == MCID.getNumOperands()-1)) {
Evan Chenge837dea2011-06-28 19:10:37 +0000669 if (MO->isDef() && !MCOI.isOptionalDef())
Cameron Zwarich22d67cf2010-12-19 21:37:23 +0000670 report("Explicit operand marked as def", MO, MONum);
Jakob Stoklund Olesen39523e22009-09-23 20:57:55 +0000671 if (MO->isImplicit())
672 report("Explicit operand marked as implicit", MO, MONum);
673 }
674 } else {
Jakob Stoklund Olesen57115642009-12-22 21:48:20 +0000675 // ARM adds %reg0 operands to indicate predicates. We'll allow that.
Evan Cheng5a96b3d2011-12-07 07:15:52 +0000676 if (MO->isReg() && !MO->isImplicit() && !MI->isVariadic() && MO->getReg())
Jakob Stoklund Olesen39523e22009-09-23 20:57:55 +0000677 report("Extra explicit operand on non-variadic instruction", MO, MONum);
Jakob Stoklund Olesen44b27e52009-05-16 07:25:20 +0000678 }
679
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000680 switch (MO->getType()) {
681 case MachineOperand::MO_Register: {
682 const unsigned Reg = MO->getReg();
683 if (!Reg)
684 return;
Jakob Stoklund Olesen948a4442012-03-28 20:47:35 +0000685 if (MRI->tracksLiveness() && !MI->isDebugValue())
686 checkLiveness(MO, MONum);
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000687
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000688
689 // Check register classes.
Evan Chenge837dea2011-06-28 19:10:37 +0000690 if (MONum < MCID.getNumOperands() && !MO->isImplicit()) {
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000691 unsigned SubIdx = MO->getSubReg();
692
693 if (TargetRegisterInfo::isPhysicalRegister(Reg)) {
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000694 if (SubIdx) {
Jakob Stoklund Olesenb4a02212011-10-05 22:12:57 +0000695 report("Illegal subregister index for physical register", MO, MONum);
696 return;
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000697 }
Jakob Stoklund Olesen397fc482012-05-07 22:10:26 +0000698 if (const TargetRegisterClass *DRC =
699 TII->getRegClass(MCID, MONum, TRI, *MF)) {
Jakob Stoklund Olesenb4a02212011-10-05 22:12:57 +0000700 if (!DRC->contains(Reg)) {
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000701 report("Illegal physical register for instruction", MO, MONum);
Jakob Stoklund Olesenb4a02212011-10-05 22:12:57 +0000702 *OS << TRI->getName(Reg) << " is not a "
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000703 << DRC->getName() << " register.\n";
704 }
705 }
706 } else {
707 // Virtual register.
708 const TargetRegisterClass *RC = MRI->getRegClass(Reg);
709 if (SubIdx) {
Jakob Stoklund Olesenb4a02212011-10-05 22:12:57 +0000710 const TargetRegisterClass *SRC =
711 TRI->getSubClassWithSubReg(RC, SubIdx);
Jakob Stoklund Olesen6a8d2c62010-05-18 17:31:12 +0000712 if (!SRC) {
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000713 report("Invalid subregister index for virtual register", MO, MONum);
Jakob Stoklund Olesen6a8d2c62010-05-18 17:31:12 +0000714 *OS << "Register class " << RC->getName()
715 << " does not support subreg index " << SubIdx << "\n";
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000716 return;
717 }
Jakob Stoklund Olesenb4a02212011-10-05 22:12:57 +0000718 if (RC != SRC) {
719 report("Invalid register class for subregister index", MO, MONum);
720 *OS << "Register class " << RC->getName()
721 << " does not fully support subreg index " << SubIdx << "\n";
722 return;
723 }
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000724 }
Jakob Stoklund Olesen397fc482012-05-07 22:10:26 +0000725 if (const TargetRegisterClass *DRC =
726 TII->getRegClass(MCID, MONum, TRI, *MF)) {
Jakob Stoklund Olesenb4a02212011-10-05 22:12:57 +0000727 if (SubIdx) {
728 const TargetRegisterClass *SuperRC =
729 TRI->getLargestLegalSuperClass(RC);
730 if (!SuperRC) {
731 report("No largest legal super class exists.", MO, MONum);
732 return;
733 }
734 DRC = TRI->getMatchingSuperRegClass(SuperRC, DRC, SubIdx);
735 if (!DRC) {
736 report("No matching super-reg register class.", MO, MONum);
737 return;
738 }
739 }
Jakob Stoklund Olesenfa226bc2011-06-02 05:43:46 +0000740 if (!RC->hasSuperClassEq(DRC)) {
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000741 report("Illegal virtual register for instruction", MO, MONum);
742 *OS << "Expected a " << DRC->getName() << " register, but got a "
743 << RC->getName() << " register\n";
744 }
745 }
746 }
747 }
748 break;
749 }
Jakob Stoklund Olesena5ba07c2009-09-21 07:19:08 +0000750
Jakob Stoklund Olesen9ca12d22012-02-28 01:42:41 +0000751 case MachineOperand::MO_RegisterMask:
752 regMasks.push_back(MO->getRegMask());
753 break;
754
Jakob Stoklund Olesena5ba07c2009-09-21 07:19:08 +0000755 case MachineOperand::MO_MachineBasicBlock:
Chris Lattner518bb532010-02-09 19:54:29 +0000756 if (MI->isPHI() && !MO->getMBB()->isSuccessor(MI->getParent()))
757 report("PHI operand is not in the CFG", MO, MONum);
Jakob Stoklund Olesena5ba07c2009-09-21 07:19:08 +0000758 break;
759
Jakob Stoklund Olesene8f08232010-11-01 19:49:52 +0000760 case MachineOperand::MO_FrameIndex:
761 if (LiveStks && LiveStks->hasInterval(MO->getIndex()) &&
762 LiveInts && !LiveInts->isNotInMIMap(MI)) {
763 LiveInterval &LI = LiveStks->getInterval(MO->getIndex());
764 SlotIndex Idx = LiveInts->getInstructionIndex(MI);
Evan Cheng5a96b3d2011-12-07 07:15:52 +0000765 if (MI->mayLoad() && !LI.liveAt(Idx.getRegSlot(true))) {
Jakob Stoklund Olesene8f08232010-11-01 19:49:52 +0000766 report("Instruction loads from dead spill slot", MO, MONum);
767 *OS << "Live stack: " << LI << '\n';
768 }
Evan Cheng5a96b3d2011-12-07 07:15:52 +0000769 if (MI->mayStore() && !LI.liveAt(Idx.getRegSlot())) {
Jakob Stoklund Olesene8f08232010-11-01 19:49:52 +0000770 report("Instruction stores to dead spill slot", MO, MONum);
771 *OS << "Live stack: " << LI << '\n';
772 }
773 }
774 break;
775
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000776 default:
777 break;
778 }
779}
780
Jakob Stoklund Olesen948a4442012-03-28 20:47:35 +0000781void MachineVerifier::checkLiveness(const MachineOperand *MO, unsigned MONum) {
782 const MachineInstr *MI = MO->getParent();
783 const unsigned Reg = MO->getReg();
784
785 // Both use and def operands can read a register.
786 if (MO->readsReg()) {
787 regsLiveInButUnused.erase(Reg);
788
789 bool isKill = false;
790 unsigned defIdx;
791 if (MI->isRegTiedToDefOperand(MONum, &defIdx)) {
792 // A two-addr use counts as a kill if use and def are the same.
793 unsigned DefReg = MI->getOperand(defIdx).getReg();
794 if (Reg == DefReg)
795 isKill = true;
796 else if (TargetRegisterInfo::isPhysicalRegister(Reg)) {
797 report("Two-address instruction operands must be identical", MO, MONum);
798 }
799 } else
800 isKill = MO->isKill();
801
802 if (isKill)
803 addRegWithSubRegs(regsKilled, Reg);
804
805 // Check that LiveVars knows this kill.
806 if (LiveVars && TargetRegisterInfo::isVirtualRegister(Reg) &&
807 MO->isKill()) {
808 LiveVariables::VarInfo &VI = LiveVars->getVarInfo(Reg);
809 if (std::find(VI.Kills.begin(), VI.Kills.end(), MI) == VI.Kills.end())
810 report("Kill missing from LiveVariables", MO, MONum);
811 }
812
813 // Check LiveInts liveness and kill.
814 if (TargetRegisterInfo::isVirtualRegister(Reg) &&
815 LiveInts && !LiveInts->isNotInMIMap(MI)) {
816 SlotIndex UseIdx = LiveInts->getInstructionIndex(MI).getRegSlot(true);
817 if (LiveInts->hasInterval(Reg)) {
818 const LiveInterval &LI = LiveInts->getInterval(Reg);
819 if (!LI.liveAt(UseIdx)) {
820 report("No live range at use", MO, MONum);
821 *OS << UseIdx << " is not live in " << LI << '\n';
822 }
823 // Check for extra kill flags.
824 // Note that we allow missing kill flags for now.
825 if (MO->isKill() && !LI.killedAt(UseIdx.getRegSlot())) {
826 report("Live range continues after kill flag", MO, MONum);
827 *OS << "Live range: " << LI << '\n';
828 }
829 } else {
830 report("Virtual register has no Live interval", MO, MONum);
831 }
832 }
833
834 // Use of a dead register.
835 if (!regsLive.count(Reg)) {
836 if (TargetRegisterInfo::isPhysicalRegister(Reg)) {
837 // Reserved registers may be used even when 'dead'.
838 if (!isReserved(Reg))
839 report("Using an undefined physical register", MO, MONum);
840 } else {
841 BBInfo &MInfo = MBBInfoMap[MI->getParent()];
842 // We don't know which virtual registers are live in, so only complain
843 // if vreg was killed in this MBB. Otherwise keep track of vregs that
844 // must be live in. PHI instructions are handled separately.
845 if (MInfo.regsKilled.count(Reg))
846 report("Using a killed virtual register", MO, MONum);
847 else if (!MI->isPHI())
848 MInfo.vregsLiveIn.insert(std::make_pair(Reg, MI));
849 }
850 }
851 }
852
853 if (MO->isDef()) {
854 // Register defined.
855 // TODO: verify that earlyclobber ops are not used.
856 if (MO->isDead())
857 addRegWithSubRegs(regsDead, Reg);
858 else
859 addRegWithSubRegs(regsDefined, Reg);
860
861 // Verify SSA form.
862 if (MRI->isSSA() && TargetRegisterInfo::isVirtualRegister(Reg) &&
863 llvm::next(MRI->def_begin(Reg)) != MRI->def_end())
864 report("Multiple virtual register defs in SSA form", MO, MONum);
865
866 // Check LiveInts for a live range, but only for virtual registers.
867 if (LiveInts && TargetRegisterInfo::isVirtualRegister(Reg) &&
868 !LiveInts->isNotInMIMap(MI)) {
869 SlotIndex DefIdx = LiveInts->getInstructionIndex(MI).getRegSlot();
870 if (LiveInts->hasInterval(Reg)) {
871 const LiveInterval &LI = LiveInts->getInterval(Reg);
872 if (const VNInfo *VNI = LI.getVNInfoAt(DefIdx)) {
873 assert(VNI && "NULL valno is not allowed");
874 if (VNI->def != DefIdx && !MO->isEarlyClobber()) {
875 report("Inconsistent valno->def", MO, MONum);
876 *OS << "Valno " << VNI->id << " is not defined at "
877 << DefIdx << " in " << LI << '\n';
878 }
879 } else {
880 report("No live range at def", MO, MONum);
881 *OS << DefIdx << " is not live in " << LI << '\n';
882 }
883 } else {
884 report("Virtual register has no Live interval", MO, MONum);
885 }
886 }
887 }
888}
889
Jakob Stoklund Olesenb44fad72009-10-04 18:18:39 +0000890void MachineVerifier::visitMachineInstrAfter(const MachineInstr *MI) {
Jakob Stoklund Olesen1f9c3ec2012-06-06 22:34:30 +0000891}
892
893// This function gets called after visiting all instructions in a bundle. The
894// argument points to the bundle header.
895// Normal stand-alone instructions are also considered 'bundles', and this
896// function is called for all of them.
897void MachineVerifier::visitMachineBundleAfter(const MachineInstr *MI) {
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000898 BBInfo &MInfo = MBBInfoMap[MI->getParent()];
899 set_union(MInfo.regsKilled, regsKilled);
Jakob Stoklund Olesen73cf7092010-08-05 18:59:59 +0000900 set_subtract(regsLive, regsKilled); regsKilled.clear();
Jakob Stoklund Olesen9ca12d22012-02-28 01:42:41 +0000901 // Kill any masked registers.
902 while (!regMasks.empty()) {
903 const uint32_t *Mask = regMasks.pop_back_val();
904 for (RegSet::iterator I = regsLive.begin(), E = regsLive.end(); I != E; ++I)
905 if (TargetRegisterInfo::isPhysicalRegister(*I) &&
906 MachineOperand::clobbersPhysReg(Mask, *I))
907 regsDead.push_back(*I);
908 }
Jakob Stoklund Olesen73cf7092010-08-05 18:59:59 +0000909 set_subtract(regsLive, regsDead); regsDead.clear();
910 set_union(regsLive, regsDefined); regsDefined.clear();
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000911}
912
913void
Jakob Stoklund Olesenb44fad72009-10-04 18:18:39 +0000914MachineVerifier::visitMachineBasicBlockAfter(const MachineBasicBlock *MBB) {
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000915 MBBInfoMap[MBB].regsLiveOut = regsLive;
916 regsLive.clear();
Jakob Stoklund Olesenfc69c372011-01-12 21:27:48 +0000917
918 if (Indexes) {
919 SlotIndex stop = Indexes->getMBBEndIdx(MBB);
920 if (!(stop > lastIndex)) {
921 report("Block ends before last instruction index", MBB);
922 *OS << "Block ends at " << stop
923 << " last instruction was at " << lastIndex << '\n';
924 }
925 lastIndex = stop;
926 }
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000927}
928
929// Calculate the largest possible vregsPassed sets. These are the registers that
930// can pass through an MBB live, but may not be live every time. It is assumed
931// that all vregsPassed sets are empty before the call.
Jakob Stoklund Olesenb31defe2010-01-05 20:59:36 +0000932void MachineVerifier::calcRegsPassed() {
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000933 // First push live-out regs to successors' vregsPassed. Remember the MBBs that
934 // have any vregsPassed.
Jakob Stoklund Olesen1efd6b92012-03-10 00:36:04 +0000935 SmallPtrSet<const MachineBasicBlock*, 8> todo;
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +0000936 for (MachineFunction::const_iterator MFI = MF->begin(), MFE = MF->end();
937 MFI != MFE; ++MFI) {
938 const MachineBasicBlock &MBB(*MFI);
939 BBInfo &MInfo = MBBInfoMap[&MBB];
940 if (!MInfo.reachable)
941 continue;
942 for (MachineBasicBlock::const_succ_iterator SuI = MBB.succ_begin(),
943 SuE = MBB.succ_end(); SuI != SuE; ++SuI) {
944 BBInfo &SInfo = MBBInfoMap[*SuI];
945 if (SInfo.addPassed(MInfo.regsLiveOut))
946 todo.insert(*SuI);
947 }
948 }
949
950 // Iteratively push vregsPassed to successors. This will converge to the same
951 // final state regardless of DenseSet iteration order.
952 while (!todo.empty()) {
953 const MachineBasicBlock *MBB = *todo.begin();
954 todo.erase(MBB);
955 BBInfo &MInfo = MBBInfoMap[MBB];
956 for (MachineBasicBlock::const_succ_iterator SuI = MBB->succ_begin(),
957 SuE = MBB->succ_end(); SuI != SuE; ++SuI) {
958 if (*SuI == MBB)
959 continue;
960 BBInfo &SInfo = MBBInfoMap[*SuI];
961 if (SInfo.addPassed(MInfo.vregsPassed))
962 todo.insert(*SuI);
963 }
964 }
965}
966
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +0000967// Calculate the set of virtual registers that must be passed through each basic
968// block in order to satisfy the requirements of successor blocks. This is very
Jakob Stoklund Olesenb31defe2010-01-05 20:59:36 +0000969// similar to calcRegsPassed, only backwards.
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +0000970void MachineVerifier::calcRegsRequired() {
971 // First push live-in regs to predecessors' vregsRequired.
Jakob Stoklund Olesen1efd6b92012-03-10 00:36:04 +0000972 SmallPtrSet<const MachineBasicBlock*, 8> todo;
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +0000973 for (MachineFunction::const_iterator MFI = MF->begin(), MFE = MF->end();
974 MFI != MFE; ++MFI) {
975 const MachineBasicBlock &MBB(*MFI);
976 BBInfo &MInfo = MBBInfoMap[&MBB];
977 for (MachineBasicBlock::const_pred_iterator PrI = MBB.pred_begin(),
978 PrE = MBB.pred_end(); PrI != PrE; ++PrI) {
979 BBInfo &PInfo = MBBInfoMap[*PrI];
980 if (PInfo.addRequired(MInfo.vregsLiveIn))
981 todo.insert(*PrI);
982 }
983 }
984
985 // Iteratively push vregsRequired to predecessors. This will converge to the
986 // same final state regardless of DenseSet iteration order.
987 while (!todo.empty()) {
988 const MachineBasicBlock *MBB = *todo.begin();
989 todo.erase(MBB);
990 BBInfo &MInfo = MBBInfoMap[MBB];
991 for (MachineBasicBlock::const_pred_iterator PrI = MBB->pred_begin(),
992 PrE = MBB->pred_end(); PrI != PrE; ++PrI) {
993 if (*PrI == MBB)
994 continue;
995 BBInfo &SInfo = MBBInfoMap[*PrI];
996 if (SInfo.addRequired(MInfo.vregsRequired))
997 todo.insert(*PrI);
998 }
999 }
1000}
1001
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +00001002// Check PHI instructions at the beginning of MBB. It is assumed that
Jakob Stoklund Olesenb31defe2010-01-05 20:59:36 +00001003// calcRegsPassed has been run so BBInfo::isLiveOut is valid.
Jakob Stoklund Olesenb44fad72009-10-04 18:18:39 +00001004void MachineVerifier::checkPHIOps(const MachineBasicBlock *MBB) {
Jakob Stoklund Olesen1efd6b92012-03-10 00:36:04 +00001005 SmallPtrSet<const MachineBasicBlock*, 8> seen;
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +00001006 for (MachineBasicBlock::const_iterator BBI = MBB->begin(), BBE = MBB->end();
Chris Lattner518bb532010-02-09 19:54:29 +00001007 BBI != BBE && BBI->isPHI(); ++BBI) {
Jakob Stoklund Olesen1efd6b92012-03-10 00:36:04 +00001008 seen.clear();
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +00001009
1010 for (unsigned i = 1, e = BBI->getNumOperands(); i != e; i += 2) {
1011 unsigned Reg = BBI->getOperand(i).getReg();
1012 const MachineBasicBlock *Pre = BBI->getOperand(i + 1).getMBB();
1013 if (!Pre->isSuccessor(MBB))
1014 continue;
1015 seen.insert(Pre);
1016 BBInfo &PrInfo = MBBInfoMap[Pre];
1017 if (PrInfo.reachable && !PrInfo.isLiveOut(Reg))
1018 report("PHI operand is not live-out from predecessor",
1019 &BBI->getOperand(i), i);
1020 }
1021
1022 // Did we see all predecessors?
1023 for (MachineBasicBlock::const_pred_iterator PrI = MBB->pred_begin(),
1024 PrE = MBB->pred_end(); PrI != PrE; ++PrI) {
1025 if (!seen.count(*PrI)) {
1026 report("Missing PHI operand", BBI);
Dan Gohman0ba90f32009-10-31 20:19:03 +00001027 *OS << "BB#" << (*PrI)->getNumber()
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +00001028 << " is a predecessor according to the CFG.\n";
1029 }
1030 }
1031 }
1032}
1033
Jakob Stoklund Olesenb44fad72009-10-04 18:18:39 +00001034void MachineVerifier::visitMachineFunctionAfter() {
Jakob Stoklund Olesenb31defe2010-01-05 20:59:36 +00001035 calcRegsPassed();
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +00001036
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +00001037 for (MachineFunction::const_iterator MFI = MF->begin(), MFE = MF->end();
1038 MFI != MFE; ++MFI) {
1039 BBInfo &MInfo = MBBInfoMap[MFI];
1040
1041 // Skip unreachable MBBs.
1042 if (!MInfo.reachable)
1043 continue;
1044
1045 checkPHIOps(MFI);
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +00001046 }
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +00001047
Jakob Stoklund Olesen58e12482010-08-06 18:04:19 +00001048 // Now check liveness info if available
Jakob Stoklund Olesen64ffa832012-03-10 00:36:06 +00001049 calcRegsRequired();
1050
1051 if (MRI->isSSA() && !MF->empty()) {
1052 BBInfo &MInfo = MBBInfoMap[&MF->front()];
1053 for (RegSet::iterator
1054 I = MInfo.vregsRequired.begin(), E = MInfo.vregsRequired.end(); I != E;
Jakob Stoklund Olesenff0275e2012-03-10 00:44:11 +00001055 ++I)
1056 report("Virtual register def doesn't dominate all uses.",
1057 MRI->getVRegDef(*I));
Jakob Stoklund Olesen64ffa832012-03-10 00:36:06 +00001058 }
1059
Jakob Stoklund Olesen58e12482010-08-06 18:04:19 +00001060 if (LiveVars)
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +00001061 verifyLiveVariables();
Jakob Stoklund Olesen58e12482010-08-06 18:04:19 +00001062 if (LiveInts)
1063 verifyLiveIntervals();
Jakob Stoklund Olesen48872e02009-05-16 00:33:53 +00001064}
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +00001065
1066void MachineVerifier::verifyLiveVariables() {
1067 assert(LiveVars && "Don't call verifyLiveVariables without LiveVars");
Jakob Stoklund Olesen98c54762011-01-08 23:11:02 +00001068 for (unsigned i = 0, e = MRI->getNumVirtRegs(); i != e; ++i) {
1069 unsigned Reg = TargetRegisterInfo::index2VirtReg(i);
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +00001070 LiveVariables::VarInfo &VI = LiveVars->getVarInfo(Reg);
1071 for (MachineFunction::const_iterator MFI = MF->begin(), MFE = MF->end();
1072 MFI != MFE; ++MFI) {
1073 BBInfo &MInfo = MBBInfoMap[MFI];
1074
1075 // Our vregsRequired should be identical to LiveVariables' AliveBlocks
1076 if (MInfo.vregsRequired.count(Reg)) {
1077 if (!VI.AliveBlocks.test(MFI->getNumber())) {
1078 report("LiveVariables: Block missing from AliveBlocks", MFI);
Jakob Stoklund Olesen43142682011-01-09 03:05:53 +00001079 *OS << "Virtual register " << PrintReg(Reg)
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +00001080 << " must be live through the block.\n";
1081 }
1082 } else {
1083 if (VI.AliveBlocks.test(MFI->getNumber())) {
1084 report("LiveVariables: Block should not be in AliveBlocks", MFI);
Jakob Stoklund Olesen43142682011-01-09 03:05:53 +00001085 *OS << "Virtual register " << PrintReg(Reg)
Jakob Stoklund Olesen8f16e022009-11-18 20:36:57 +00001086 << " is not needed live through the block.\n";
1087 }
1088 }
1089 }
1090 }
1091}
1092
Jakob Stoklund Olesen58e12482010-08-06 18:04:19 +00001093void MachineVerifier::verifyLiveIntervals() {
1094 assert(LiveInts && "Don't call verifyLiveIntervals without LiveInts");
1095 for (LiveIntervals::const_iterator LVI = LiveInts->begin(),
1096 LVE = LiveInts->end(); LVI != LVE; ++LVI) {
1097 const LiveInterval &LI = *LVI->second;
Jakob Stoklund Olesen893ab5d2010-10-06 23:54:35 +00001098
1099 // Spilling and splitting may leave unused registers around. Skip them.
Jakob Stoklund Olesene3da8c62012-05-17 18:32:40 +00001100 if (MRI->reg_nodbg_empty(LI.reg))
Jakob Stoklund Olesen893ab5d2010-10-06 23:54:35 +00001101 continue;
1102
Jakob Stoklund Olesen8c456422010-10-28 20:44:22 +00001103 // Physical registers have much weirdness going on, mostly from coalescing.
1104 // We should probably fix it, but for now just ignore them.
1105 if (TargetRegisterInfo::isPhysicalRegister(LI.reg))
1106 continue;
1107
Jakob Stoklund Olesen58e12482010-08-06 18:04:19 +00001108 assert(LVI->first == LI.reg && "Invalid reg to interval mapping");
1109
1110 for (LiveInterval::const_vni_iterator I = LI.vni_begin(), E = LI.vni_end();
1111 I!=E; ++I) {
1112 VNInfo *VNI = *I;
Jakob Stoklund Olesened826352010-10-02 05:24:46 +00001113 const VNInfo *DefVNI = LI.getVNInfoAt(VNI->def);
Jakob Stoklund Olesen58e12482010-08-06 18:04:19 +00001114
Jakob Stoklund Olesened826352010-10-02 05:24:46 +00001115 if (!DefVNI) {
Jakob Stoklund Olesen58e12482010-08-06 18:04:19 +00001116 if (!VNI->isUnused()) {
1117 report("Valno not live at def and not marked unused", MF);
1118 *OS << "Valno #" << VNI->id << " in " << LI << '\n';
1119 }
1120 continue;
1121 }
1122
1123 if (VNI->isUnused())
1124 continue;
1125
Jakob Stoklund Olesened826352010-10-02 05:24:46 +00001126 if (DefVNI != VNI) {
Jakob Stoklund Olesen58e12482010-08-06 18:04:19 +00001127 report("Live range at def has different valno", MF);
Jakob Stoklund Olesened826352010-10-02 05:24:46 +00001128 *OS << "Valno #" << VNI->id << " is defined at " << VNI->def
Jakob Stoklund Olesendbcc2e12010-10-26 20:21:43 +00001129 << " where valno #" << DefVNI->id << " is live in " << LI << '\n';
Jakob Stoklund Olesen3bf7cf92010-10-22 22:48:58 +00001130 continue;
Jakob Stoklund Olesen58e12482010-08-06 18:04:19 +00001131 }
1132
Jakob Stoklund Olesen3bf7cf92010-10-22 22:48:58 +00001133 const MachineBasicBlock *MBB = LiveInts->getMBBFromIndex(VNI->def);
1134 if (!MBB) {
1135 report("Invalid definition index", MF);
Jakob Stoklund Olesendbcc2e12010-10-26 20:21:43 +00001136 *OS << "Valno #" << VNI->id << " is defined at " << VNI->def
1137 << " in " << LI << '\n';
Jakob Stoklund Olesen3bf7cf92010-10-22 22:48:58 +00001138 continue;
1139 }
1140
1141 if (VNI->isPHIDef()) {
1142 if (VNI->def != LiveInts->getMBBStartIdx(MBB)) {
1143 report("PHIDef value is not defined at MBB start", MF);
1144 *OS << "Valno #" << VNI->id << " is defined at " << VNI->def
Jakob Stoklund Olesendbcc2e12010-10-26 20:21:43 +00001145 << ", not at the beginning of BB#" << MBB->getNumber()
1146 << " in " << LI << '\n';
Jakob Stoklund Olesen3bf7cf92010-10-22 22:48:58 +00001147 }
1148 } else {
1149 // Non-PHI def.
Jakob Stoklund Olesen30e98a02012-02-29 00:33:41 +00001150 const MachineInstr *MI = LiveInts->getInstructionFromIndex(VNI->def);
Jakob Stoklund Olesen3bf7cf92010-10-22 22:48:58 +00001151 if (!MI) {
1152 report("No instruction at def index", MF);
Jakob Stoklund Olesen78716872010-10-23 00:49:09 +00001153 *OS << "Valno #" << VNI->id << " is defined at " << VNI->def
1154 << " in " << LI << '\n';
Jakob Stoklund Olesen121b1792012-02-27 18:24:30 +00001155 continue;
Jakob Stoklund Olesen3bf7cf92010-10-22 22:48:58 +00001156 }
Cameron Zwarich0b13d7d2010-12-20 03:15:20 +00001157
Jakob Stoklund Olesen121b1792012-02-27 18:24:30 +00001158 bool hasDef = false;
Cameron Zwarich0b13d7d2010-12-20 03:15:20 +00001159 bool isEarlyClobber = false;
Jakob Stoklund Olesen30e98a02012-02-29 00:33:41 +00001160 for (ConstMIBundleOperands MOI(MI); MOI.isValid(); ++MOI) {
Jakob Stoklund Olesen121b1792012-02-27 18:24:30 +00001161 if (!MOI->isReg() || !MOI->isDef())
1162 continue;
1163 if (TargetRegisterInfo::isVirtualRegister(LI.reg)) {
1164 if (MOI->getReg() != LI.reg)
1165 continue;
1166 } else {
1167 if (!TargetRegisterInfo::isPhysicalRegister(MOI->getReg()) ||
1168 !TRI->regsOverlap(LI.reg, MOI->getReg()))
1169 continue;
Cameron Zwarich0b13d7d2010-12-20 03:15:20 +00001170 }
Jakob Stoklund Olesen121b1792012-02-27 18:24:30 +00001171 hasDef = true;
1172 if (MOI->isEarlyClobber())
1173 isEarlyClobber = true;
1174 }
1175
1176 if (!hasDef) {
1177 report("Defining instruction does not modify register", MI);
1178 *OS << "Valno #" << VNI->id << " in " << LI << '\n';
Cameron Zwarich0b13d7d2010-12-20 03:15:20 +00001179 }
1180
1181 // Early clobber defs begin at USE slots, but other defs must begin at
1182 // DEF slots.
1183 if (isEarlyClobber) {
Jakob Stoklund Olesen2debd482011-11-13 20:45:27 +00001184 if (!VNI->def.isEarlyClobber()) {
1185 report("Early clobber def must be at an early-clobber slot", MF);
Cameron Zwarich0b13d7d2010-12-20 03:15:20 +00001186 *OS << "Valno #" << VNI->id << " is defined at " << VNI->def
1187 << " in " << LI << '\n';
1188 }
Jakob Stoklund Olesen2debd482011-11-13 20:45:27 +00001189 } else if (!VNI->def.isRegister()) {
1190 report("Non-PHI, non-early clobber def must be at a register slot",
1191 MF);
Cameron Zwarich0b13d7d2010-12-20 03:15:20 +00001192 *OS << "Valno #" << VNI->id << " is defined at " << VNI->def
1193 << " in " << LI << '\n';
1194 }
Jakob Stoklund Olesen3bf7cf92010-10-22 22:48:58 +00001195 }
Jakob Stoklund Olesen58e12482010-08-06 18:04:19 +00001196 }
1197
1198 for (LiveInterval::const_iterator I = LI.begin(), E = LI.end(); I!=E; ++I) {
Jakob Stoklund Olesened826352010-10-02 05:24:46 +00001199 const VNInfo *VNI = I->valno;
1200 assert(VNI && "Live range has no valno");
Jakob Stoklund Olesen58e12482010-08-06 18:04:19 +00001201
Jakob Stoklund Olesened826352010-10-02 05:24:46 +00001202 if (VNI->id >= LI.getNumValNums() || VNI != LI.getValNumInfo(VNI->id)) {
Jakob Stoklund Olesen58e12482010-08-06 18:04:19 +00001203 report("Foreign valno in live range", MF);
Jakob Stoklund Olesened826352010-10-02 05:24:46 +00001204 I->print(*OS);
Jakob Stoklund Olesen58e12482010-08-06 18:04:19 +00001205 *OS << " has a valno not in " << LI << '\n';
1206 }
1207
Jakob Stoklund Olesened826352010-10-02 05:24:46 +00001208 if (VNI->isUnused()) {
Jakob Stoklund Olesen58e12482010-08-06 18:04:19 +00001209 report("Live range valno is marked unused", MF);
Jakob Stoklund Olesened826352010-10-02 05:24:46 +00001210 I->print(*OS);
Jakob Stoklund Olesen58e12482010-08-06 18:04:19 +00001211 *OS << " in " << LI << '\n';
1212 }
1213
Jakob Stoklund Olesen78716872010-10-23 00:49:09 +00001214 const MachineBasicBlock *MBB = LiveInts->getMBBFromIndex(I->start);
1215 if (!MBB) {
1216 report("Bad start of live segment, no basic block", MF);
1217 I->print(*OS);
1218 *OS << " in " << LI << '\n';
1219 continue;
1220 }
1221 SlotIndex MBBStartIdx = LiveInts->getMBBStartIdx(MBB);
1222 if (I->start != MBBStartIdx && I->start != VNI->def) {
1223 report("Live segment must begin at MBB entry or valno def", MBB);
1224 I->print(*OS);
1225 *OS << " in " << LI << '\n' << "Basic block starts at "
1226 << MBBStartIdx << '\n';
1227 }
1228
1229 const MachineBasicBlock *EndMBB =
1230 LiveInts->getMBBFromIndex(I->end.getPrevSlot());
1231 if (!EndMBB) {
1232 report("Bad end of live segment, no basic block", MF);
1233 I->print(*OS);
1234 *OS << " in " << LI << '\n';
1235 continue;
1236 }
Jakob Stoklund Olesen121b1792012-02-27 18:24:30 +00001237
1238 // No more checks for live-out segments.
1239 if (I->end == LiveInts->getMBBEndIdx(EndMBB))
1240 continue;
1241
1242 // The live segment is ending inside EndMBB
Jakob Stoklund Olesen30e98a02012-02-29 00:33:41 +00001243 const MachineInstr *MI =
Jakob Stoklund Olesen121b1792012-02-27 18:24:30 +00001244 LiveInts->getInstructionFromIndex(I->end.getPrevSlot());
1245 if (!MI) {
1246 report("Live segment doesn't end at a valid instruction", EndMBB);
Jakob Stoklund Olesen78716872010-10-23 00:49:09 +00001247 I->print(*OS);
1248 *OS << " in " << LI << '\n' << "Basic block starts at "
Jakob Stoklund Olesen121b1792012-02-27 18:24:30 +00001249 << MBBStartIdx << '\n';
1250 continue;
1251 }
Cameron Zwarich636f15f2010-12-20 01:22:37 +00001252
Jakob Stoklund Olesen121b1792012-02-27 18:24:30 +00001253 // The block slot must refer to a basic block boundary.
1254 if (I->end.isBlock()) {
1255 report("Live segment ends at B slot of an instruction", MI);
1256 I->print(*OS);
1257 *OS << " in " << LI << '\n';
1258 }
1259
1260 if (I->end.isDead()) {
1261 // Segment ends on the dead slot.
1262 // That means there must be a dead def.
1263 if (!SlotIndex::isSameInstr(I->start, I->end)) {
1264 report("Live segment ending at dead slot spans instructions", MI);
1265 I->print(*OS);
1266 *OS << " in " << LI << '\n';
1267 }
1268 }
1269
1270 // A live segment can only end at an early-clobber slot if it is being
1271 // redefined by an early-clobber def.
1272 if (I->end.isEarlyClobber()) {
1273 if (I+1 == E || (I+1)->start != I->end) {
1274 report("Live segment ending at early clobber slot must be "
1275 "redefined by an EC def in the same instruction", MI);
1276 I->print(*OS);
1277 *OS << " in " << LI << '\n';
1278 }
1279 }
1280
1281 // The following checks only apply to virtual registers. Physreg liveness
1282 // is too weird to check.
1283 if (TargetRegisterInfo::isVirtualRegister(LI.reg)) {
1284 // A live range can end with either a redefinition, a kill flag on a
1285 // use, or a dead flag on a def.
1286 bool hasRead = false;
1287 bool hasDeadDef = false;
Jakob Stoklund Olesen30e98a02012-02-29 00:33:41 +00001288 for (ConstMIBundleOperands MOI(MI); MOI.isValid(); ++MOI) {
Jakob Stoklund Olesen121b1792012-02-27 18:24:30 +00001289 if (!MOI->isReg() || MOI->getReg() != LI.reg)
1290 continue;
1291 if (MOI->readsReg())
1292 hasRead = true;
1293 if (MOI->isDef() && MOI->isDead())
1294 hasDeadDef = true;
1295 }
1296
1297 if (I->end.isDead()) {
Cameron Zwarich636f15f2010-12-20 01:22:37 +00001298 if (!hasDeadDef) {
Jakob Stoklund Olesen121b1792012-02-27 18:24:30 +00001299 report("Instruction doesn't have a dead def operand", MI);
1300 I->print(*OS);
1301 *OS << " in " << LI << '\n';
1302 }
1303 } else {
1304 if (!hasRead) {
1305 report("Instruction ending live range doesn't read the register",
1306 MI);
Cameron Zwarich636f15f2010-12-20 01:22:37 +00001307 I->print(*OS);
1308 *OS << " in " << LI << '\n';
1309 }
Jakob Stoklund Olesen78716872010-10-23 00:49:09 +00001310 }
1311 }
1312
1313 // Now check all the basic blocks in this live segment.
1314 MachineFunction::const_iterator MFI = MBB;
Cameron Zwarichcb584d02010-12-28 23:45:38 +00001315 // Is this live range the beginning of a non-PHIDef VN?
1316 if (I->start == VNI->def && !VNI->isPHIDef()) {
Jakob Stoklund Olesen78716872010-10-23 00:49:09 +00001317 // Not live-in to any blocks.
1318 if (MBB == EndMBB)
1319 continue;
1320 // Skip this block.
1321 ++MFI;
1322 }
1323 for (;;) {
1324 assert(LiveInts->isLiveInToMBB(LI, MFI));
Jakob Stoklund Olesene459d552010-10-26 16:49:23 +00001325 // We don't know how to track physregs into a landing pad.
1326 if (TargetRegisterInfo::isPhysicalRegister(LI.reg) &&
1327 MFI->isLandingPad()) {
1328 if (&*MFI == EndMBB)
1329 break;
1330 ++MFI;
1331 continue;
1332 }
Jakob Stoklund Olesen78716872010-10-23 00:49:09 +00001333 // Check that VNI is live-out of all predecessors.
1334 for (MachineBasicBlock::const_pred_iterator PI = MFI->pred_begin(),
1335 PE = MFI->pred_end(); PI != PE; ++PI) {
Jakob Stoklund Olesen194eb712011-11-14 01:39:36 +00001336 SlotIndex PEnd = LiveInts->getMBBEndIdx(*PI);
1337 const VNInfo *PVNI = LI.getVNInfoBefore(PEnd);
Cameron Zwarich4eee42c2010-12-27 05:17:23 +00001338
Jakob Stoklund Olesendf8412c2011-09-15 05:16:30 +00001339 if (VNI->isPHIDef() && VNI->def == LiveInts->getMBBStartIdx(MFI))
Cameron Zwarich4eee42c2010-12-27 05:17:23 +00001340 continue;
Cameron Zwarich4eee42c2010-12-27 05:17:23 +00001341
Cameron Zwarichcb584d02010-12-28 23:45:38 +00001342 if (!PVNI) {
1343 report("Register not marked live out of predecessor", *PI);
1344 *OS << "Valno #" << VNI->id << " live into BB#" << MFI->getNumber()
Jakob Stoklund Olesen194eb712011-11-14 01:39:36 +00001345 << '@' << LiveInts->getMBBStartIdx(MFI) << ", not live before "
Cameron Zwarichcb584d02010-12-28 23:45:38 +00001346 << PEnd << " in " << LI << '\n';
1347 continue;
1348 }
1349
Cameron Zwarich4eee42c2010-12-27 05:17:23 +00001350 if (PVNI != VNI) {
Jakob Stoklund Olesen78716872010-10-23 00:49:09 +00001351 report("Different value live out of predecessor", *PI);
1352 *OS << "Valno #" << PVNI->id << " live out of BB#"
1353 << (*PI)->getNumber() << '@' << PEnd
1354 << "\nValno #" << VNI->id << " live into BB#" << MFI->getNumber()
1355 << '@' << LiveInts->getMBBStartIdx(MFI) << " in " << LI << '\n';
1356 }
1357 }
1358 if (&*MFI == EndMBB)
1359 break;
1360 ++MFI;
1361 }
Jakob Stoklund Olesen58e12482010-08-06 18:04:19 +00001362 }
Jakob Stoklund Olesen501dc422010-10-26 22:36:07 +00001363
1364 // Check the LI only has one connected component.
Jakob Stoklund Olesen8c593f92010-10-27 00:39:01 +00001365 if (TargetRegisterInfo::isVirtualRegister(LI.reg)) {
1366 ConnectedVNInfoEqClasses ConEQ(*LiveInts);
1367 unsigned NumComp = ConEQ.Classify(&LI);
1368 if (NumComp > 1) {
1369 report("Multiple connected components in live interval", MF);
1370 *OS << NumComp << " components in " << LI << '\n';
Jakob Stoklund Olesencb367772010-10-29 00:40:57 +00001371 for (unsigned comp = 0; comp != NumComp; ++comp) {
1372 *OS << comp << ": valnos";
1373 for (LiveInterval::const_vni_iterator I = LI.vni_begin(),
1374 E = LI.vni_end(); I!=E; ++I)
1375 if (comp == ConEQ.getEqClass(*I))
1376 *OS << ' ' << (*I)->id;
1377 *OS << '\n';
1378 }
Jakob Stoklund Olesen8c593f92010-10-27 00:39:01 +00001379 }
Jakob Stoklund Olesen501dc422010-10-26 22:36:07 +00001380 }
Jakob Stoklund Olesen58e12482010-08-06 18:04:19 +00001381 }
1382}