blob: dfac6b94cf31295658d6e227b25f57d06d1b2d4f [file] [log] [blame]
Chris Lattner2f7c9632001-06-06 20:29:01 +00001//===-- Verifier.cpp - Implement the Module Verifier -------------*- C++ -*-==//
John Criswell482202a2003-10-20 19:43:21 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file was developed by the LLVM research group and is distributed under
6// the University of Illinois Open Source License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
Chris Lattner2f7c9632001-06-06 20:29:01 +00009//
Chris Lattner3e6e3e62002-03-29 19:06:18 +000010// This file defines the function verifier interface, that can be used for some
Chris Lattner2f7c9632001-06-06 20:29:01 +000011// sanity checking of input to the system.
12//
13// Note that this does not provide full 'java style' security and verifications,
14// instead it just tries to ensure that code is well formed.
15//
Chris Lattner0e851da2002-04-18 20:37:37 +000016// * Both of a binary operator's parameters are the same type
Chris Lattnerd46bb6e2002-04-24 19:12:21 +000017// * Verify that the indices of mem access instructions match other operands
Chris Lattner1f419252002-09-09 20:26:04 +000018// * Verify that arithmetic and other things are only performed on first class
Chris Lattner8e72d6f2002-08-02 17:37:08 +000019// types. Verify that shifts & logicals only happen on integrals f.e.
Chris Lattner2f7c9632001-06-06 20:29:01 +000020// . All of the constants in a switch statement are of the correct type
Chris Lattner8e72d6f2002-08-02 17:37:08 +000021// * The code is in valid SSA form
Chris Lattner2f7c9632001-06-06 20:29:01 +000022// . It should be illegal to put a label into any other type (like a structure)
23// or to return one. [except constant arrays!]
Chris Lattner7704e9f2002-03-14 16:53:48 +000024// * Only phi nodes can be self referential: 'add int %0, %0 ; <int>:0' is bad
Chris Lattnerd02f08d2002-02-20 17:55:43 +000025// * PHI nodes must have an entry for each predecessor, with no extras.
Chris Lattner069a7952002-06-25 15:56:27 +000026// * PHI nodes must be the first thing in a basic block, all grouped together
Chris Lattner4cd9df82002-10-06 21:00:31 +000027// * PHI nodes must have at least one entry
Chris Lattner069a7952002-06-25 15:56:27 +000028// * All basic blocks should only end with terminator insts, not contain them
Chris Lattner3e6e3e62002-03-29 19:06:18 +000029// * The entry node to a function must not have predecessors
Misha Brukmanfa100532003-10-10 17:54:14 +000030// * All Instructions must be embedded into a basic block
Chris Lattner3e6e3e62002-03-29 19:06:18 +000031// . Function's cannot take a void typed parameter
Chris Lattneraf95e582002-04-13 22:48:46 +000032// * Verify that a function's argument list agrees with it's declared type.
Chris Lattnerfbf5be52002-03-15 20:25:09 +000033// * It is illegal to specify a name for a void value.
Misha Brukmanfa100532003-10-10 17:54:14 +000034// * It is illegal to have a internal global value with no initializer
Chris Lattner486302a2002-04-12 18:20:49 +000035// * It is illegal to have a ret instruction that returns a value that does not
36// agree with the function return value type.
Chris Lattner338a4622002-05-08 19:49:50 +000037// * Function call argument types match the function prototype
Chris Lattnerd46bb6e2002-04-24 19:12:21 +000038// * All other things that are tested by asserts spread about the code...
Chris Lattner2f7c9632001-06-06 20:29:01 +000039//
40//===----------------------------------------------------------------------===//
41
42#include "llvm/Analysis/Verifier.h"
Brian Gaeke9f479272003-11-16 23:07:42 +000043#include "llvm/Assembly/Writer.h"
Chris Lattnerdc632112004-02-14 02:47:17 +000044#include "llvm/Constants.h"
Chris Lattnerd02f08d2002-02-20 17:55:43 +000045#include "llvm/Pass.h"
Chris Lattner2f7c9632001-06-06 20:29:01 +000046#include "llvm/Module.h"
Chris Lattneraf95e582002-04-13 22:48:46 +000047#include "llvm/DerivedTypes.h"
Chris Lattnerdc632112004-02-14 02:47:17 +000048#include "llvm/Instructions.h"
Chris Lattnerbb346d02003-05-08 03:47:33 +000049#include "llvm/Intrinsics.h"
Chris Lattnerdc632112004-02-14 02:47:17 +000050#include "llvm/PassManager.h"
51#include "llvm/SymbolTable.h"
Chris Lattner8e72d6f2002-08-02 17:37:08 +000052#include "llvm/Analysis/Dominators.h"
Chris Lattnerd02f08d2002-02-20 17:55:43 +000053#include "llvm/Support/CFG.h"
Chris Lattner0e851da2002-04-18 20:37:37 +000054#include "llvm/Support/InstVisitor.h"
Chris Lattnerd02f08d2002-02-20 17:55:43 +000055#include "Support/STLExtras.h"
56#include <algorithm>
Chris Lattner189d19f2003-11-21 20:23:48 +000057using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +000058
Chris Lattner0e851da2002-04-18 20:37:37 +000059namespace { // Anonymous namespace for class
Chris Lattner2f7c9632001-06-06 20:29:01 +000060
Chris Lattnerc8e66542002-04-27 06:56:12 +000061 struct Verifier : public FunctionPass, InstVisitor<Verifier> {
Chris Lattner8e72d6f2002-08-02 17:37:08 +000062 bool Broken; // Is this module found to be broken?
63 bool RealPass; // Are we not being run by a PassManager?
64 bool AbortBroken; // If broken, should it or should it not abort?
Misha Brukmanc566ca362004-03-02 00:22:19 +000065 Module *Mod; // Module we are verifying right now
66 DominatorSet *DS; // Dominator set, caution can be null!
Chris Lattner2f7c9632001-06-06 20:29:01 +000067
Chris Lattner8e72d6f2002-08-02 17:37:08 +000068 Verifier() : Broken(false), RealPass(true), AbortBroken(true), DS(0) {}
69 Verifier(bool AB) : Broken(false), RealPass(true), AbortBroken(AB), DS(0) {}
70 Verifier(DominatorSet &ds)
71 : Broken(false), RealPass(false), AbortBroken(false), DS(&ds) {}
72
Chris Lattner2f7c9632001-06-06 20:29:01 +000073
Chris Lattner069a7952002-06-25 15:56:27 +000074 bool doInitialization(Module &M) {
Brian Gaeke9f479272003-11-16 23:07:42 +000075 Mod = &M;
Chris Lattner069a7952002-06-25 15:56:27 +000076 verifySymbolTable(M.getSymbolTable());
Chris Lattnera4503972002-09-19 16:12:19 +000077
78 // If this is a real pass, in a pass manager, we must abort before
79 // returning back to the pass manager, or else the pass manager may try to
80 // run other passes on the broken module.
Chris Lattnera4503972002-09-19 16:12:19 +000081 if (RealPass)
82 abortIfBroken();
Chris Lattner0e851da2002-04-18 20:37:37 +000083 return false;
84 }
85
Chris Lattner069a7952002-06-25 15:56:27 +000086 bool runOnFunction(Function &F) {
Chris Lattner8e72d6f2002-08-02 17:37:08 +000087 // Get dominator information if we are being run by PassManager
88 if (RealPass) DS = &getAnalysis<DominatorSet>();
Chris Lattner0e851da2002-04-18 20:37:37 +000089 visit(F);
Chris Lattnera4503972002-09-19 16:12:19 +000090
91 // If this is a real pass, in a pass manager, we must abort before
92 // returning back to the pass manager, or else the pass manager may try to
93 // run other passes on the broken module.
Chris Lattnera4503972002-09-19 16:12:19 +000094 if (RealPass)
95 abortIfBroken();
96
Chris Lattner0e851da2002-04-18 20:37:37 +000097 return false;
98 }
99
Chris Lattner069a7952002-06-25 15:56:27 +0000100 bool doFinalization(Module &M) {
Chris Lattner9713b842002-04-28 16:04:26 +0000101 // Scan through, checking all of the external function's linkage now...
Chris Lattner069a7952002-06-25 15:56:27 +0000102 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
Chris Lattner3ac483b2003-04-16 20:42:40 +0000103 visitGlobalValue(*I);
Chris Lattner9713b842002-04-28 16:04:26 +0000104
Chris Lattner78bc0fa2002-10-06 22:47:32 +0000105 for (Module::giterator I = M.gbegin(), E = M.gend(); I != E; ++I)
Chris Lattnerdcdc3712003-11-21 20:33:27 +0000106 visitGlobalValue(*I);
Chris Lattner78bc0fa2002-10-06 22:47:32 +0000107
Chris Lattnera4503972002-09-19 16:12:19 +0000108 // If the module is broken, abort at this time.
109 abortIfBroken();
Chris Lattnerd46bb6e2002-04-24 19:12:21 +0000110 return false;
111 }
112
Chris Lattnerf12cc842002-04-28 21:27:06 +0000113 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
114 AU.setPreservesAll();
Chris Lattner8e72d6f2002-08-02 17:37:08 +0000115 if (RealPass)
Chris Lattner40eb9da2002-08-08 19:01:28 +0000116 AU.addRequired<DominatorSet>();
Chris Lattnerf12cc842002-04-28 21:27:06 +0000117 }
118
Misha Brukmanc566ca362004-03-02 00:22:19 +0000119 /// abortIfBroken - If the module is broken and we are supposed to abort on
120 /// this condition, do so.
121 ///
Chris Lattnera4503972002-09-19 16:12:19 +0000122 void abortIfBroken() const {
123 if (Broken && AbortBroken) {
124 std::cerr << "Broken module found, compilation aborted!\n";
125 abort();
126 }
127 }
128
Chris Lattner3ac483b2003-04-16 20:42:40 +0000129
Chris Lattner0e851da2002-04-18 20:37:37 +0000130 // Verification methods...
Chris Lattner98cf1f52002-11-20 18:36:02 +0000131 void verifySymbolTable(SymbolTable &ST);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000132 void visitGlobalValue(GlobalValue &GV);
Chris Lattner069a7952002-06-25 15:56:27 +0000133 void visitFunction(Function &F);
134 void visitBasicBlock(BasicBlock &BB);
135 void visitPHINode(PHINode &PN);
136 void visitBinaryOperator(BinaryOperator &B);
Chris Lattner1f419252002-09-09 20:26:04 +0000137 void visitShiftInst(ShiftInst &SI);
Chris Lattner5b337482003-10-18 05:57:43 +0000138 void visitVANextInst(VANextInst &VAN) { visitInstruction(VAN); }
139 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
Chris Lattner069a7952002-06-25 15:56:27 +0000140 void visitCallInst(CallInst &CI);
141 void visitGetElementPtrInst(GetElementPtrInst &GEP);
142 void visitLoadInst(LoadInst &LI);
143 void visitStoreInst(StoreInst &SI);
144 void visitInstruction(Instruction &I);
145 void visitTerminatorInst(TerminatorInst &I);
146 void visitReturnInst(ReturnInst &RI);
Chris Lattner75648e72004-03-12 05:54:31 +0000147 void visitSelectInst(SelectInst &SI);
Chris Lattner903a25d2002-11-21 16:54:22 +0000148 void visitUserOp1(Instruction &I);
149 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
Brian Gaeke960707c2003-11-11 22:41:34 +0000150 void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
Chris Lattner0e851da2002-04-18 20:37:37 +0000151
Chris Lattner7e5e4562003-11-21 17:35:51 +0000152
153 void WriteValue(const Value *V) {
154 if (!V) return;
Chris Lattner189d19f2003-11-21 20:23:48 +0000155 if (isa<Instruction>(V)) {
Chris Lattner7e5e4562003-11-21 17:35:51 +0000156 std::cerr << *V;
Chris Lattner189d19f2003-11-21 20:23:48 +0000157 } else if (const Type *Ty = dyn_cast<Type>(V)) {
158 WriteTypeSymbolic(std::cerr, Ty, Mod);
159 } else {
Chris Lattner7e5e4562003-11-21 17:35:51 +0000160 WriteAsOperand (std::cerr, V, true, true, Mod);
161 std::cerr << "\n";
162 }
163 }
164
165
Chris Lattner0e851da2002-04-18 20:37:37 +0000166 // CheckFailed - A check failed, so print out the condition and the message
167 // that failed. This provides a nice place to put a breakpoint if you want
168 // to see why something is not correct.
Chris Lattner7e5e4562003-11-21 17:35:51 +0000169 void CheckFailed(const std::string &Message,
170 const Value *V1 = 0, const Value *V2 = 0,
171 const Value *V3 = 0, const Value *V4 = 0) {
Chris Lattner0e851da2002-04-18 20:37:37 +0000172 std::cerr << Message << "\n";
Chris Lattner7e5e4562003-11-21 17:35:51 +0000173 WriteValue(V1);
174 WriteValue(V2);
175 WriteValue(V3);
176 WriteValue(V4);
Chris Lattner0e851da2002-04-18 20:37:37 +0000177 Broken = true;
178 }
179 };
Chris Lattner00fb26c2002-07-23 18:08:17 +0000180
Chris Lattneref901292003-11-13 19:47:29 +0000181 RegisterOpt<Verifier> X("verify", "Module Verifier");
Chris Lattner189d19f2003-11-21 20:23:48 +0000182} // End anonymous namespace
183
Chris Lattner2f7c9632001-06-06 20:29:01 +0000184
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000185// Assert - We know that cond should be true, if not print an error message.
186#define Assert(C, M) \
Chris Lattner412d2772002-04-28 16:06:24 +0000187 do { if (!(C)) { CheckFailed(M); return; } } while (0)
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000188#define Assert1(C, M, V1) \
Chris Lattner412d2772002-04-28 16:06:24 +0000189 do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000190#define Assert2(C, M, V1, V2) \
Chris Lattner412d2772002-04-28 16:06:24 +0000191 do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
Chris Lattner069a7952002-06-25 15:56:27 +0000192#define Assert3(C, M, V1, V2, V3) \
193 do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
194#define Assert4(C, M, V1, V2, V3, V4) \
195 do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
Chris Lattner2f7c9632001-06-06 20:29:01 +0000196
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000197
Chris Lattner3ac483b2003-04-16 20:42:40 +0000198void Verifier::visitGlobalValue(GlobalValue &GV) {
199 Assert1(!GV.isExternal() || GV.hasExternalLinkage(),
Chris Lattnerdcdc3712003-11-21 20:33:27 +0000200 "Global is external, but doesn't have external linkage!", &GV);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000201 Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
202 "Only global variables can have appending linkage!", &GV);
203
204 if (GV.hasAppendingLinkage()) {
205 GlobalVariable &GVar = cast<GlobalVariable>(GV);
206 Assert1(isa<ArrayType>(GVar.getType()->getElementType()),
207 "Only global arrays can have appending linkage!", &GV);
208 }
209}
210
Chris Lattneraf95e582002-04-13 22:48:46 +0000211// verifySymbolTable - Verify that a function or module symbol table is ok
Chris Lattnerfbf5be52002-03-15 20:25:09 +0000212//
Chris Lattner98cf1f52002-11-20 18:36:02 +0000213void Verifier::verifySymbolTable(SymbolTable &ST) {
Chris Lattnerfbf5be52002-03-15 20:25:09 +0000214 // Loop over all of the types in the symbol table...
Chris Lattner98cf1f52002-11-20 18:36:02 +0000215 for (SymbolTable::iterator TI = ST.begin(), TE = ST.end(); TI != TE; ++TI)
Chris Lattner0e851da2002-04-18 20:37:37 +0000216 for (SymbolTable::type_iterator I = TI->second.begin(),
Chris Lattnerfbf5be52002-03-15 20:25:09 +0000217 E = TI->second.end(); I != E; ++I) {
218 Value *V = I->second;
219
220 // Check that there are no void typed values in the symbol table. Values
221 // with a void type cannot be put into symbol tables because they cannot
222 // have names!
223 Assert1(V->getType() != Type::VoidTy,
Chris Lattner412d2772002-04-28 16:06:24 +0000224 "Values with void type are not allowed to have names!", V);
Chris Lattnerfbf5be52002-03-15 20:25:09 +0000225 }
Chris Lattnerfbf5be52002-03-15 20:25:09 +0000226}
227
Chris Lattner0e851da2002-04-18 20:37:37 +0000228
229// visitFunction - Verify that a function is ok.
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000230//
Chris Lattner069a7952002-06-25 15:56:27 +0000231void Verifier::visitFunction(Function &F) {
Chris Lattneraf95e582002-04-13 22:48:46 +0000232 // Check function arguments...
Chris Lattner069a7952002-06-25 15:56:27 +0000233 const FunctionType *FT = F.getFunctionType();
234 unsigned NumArgs = F.getArgumentList().size();
Chris Lattneraf95e582002-04-13 22:48:46 +0000235
Chris Lattner149376d2002-10-13 20:57:00 +0000236 Assert2(FT->getNumParams() == NumArgs,
Chris Lattneraf95e582002-04-13 22:48:46 +0000237 "# formal arguments must match # of arguments for function type!",
Chris Lattner069a7952002-06-25 15:56:27 +0000238 &F, FT);
Chris Lattner3ae303c2003-11-21 22:32:23 +0000239 Assert1(F.getReturnType()->isFirstClassType() ||
240 F.getReturnType() == Type::VoidTy,
241 "Functions cannot return aggregate values!", &F);
Chris Lattneraf95e582002-04-13 22:48:46 +0000242
243 // Check that the argument values match the function type for this function...
Chris Lattner149376d2002-10-13 20:57:00 +0000244 unsigned i = 0;
245 for (Function::aiterator I = F.abegin(), E = F.aend(); I != E; ++I, ++i)
246 Assert2(I->getType() == FT->getParamType(i),
247 "Argument value does not match function argument type!",
248 I, FT->getParamType(i));
Chris Lattneraf95e582002-04-13 22:48:46 +0000249
Chris Lattner149376d2002-10-13 20:57:00 +0000250 if (!F.isExternal()) {
251 verifySymbolTable(F.getSymbolTable());
252
253 // Check the entry node
Chris Lattner5dac64f2003-09-20 14:39:18 +0000254 BasicBlock *Entry = &F.getEntryBlock();
Chris Lattner149376d2002-10-13 20:57:00 +0000255 Assert1(pred_begin(Entry) == pred_end(Entry),
256 "Entry block to function must not have predecessors!", Entry);
257 }
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000258}
259
260
Chris Lattner0e851da2002-04-18 20:37:37 +0000261// verifyBasicBlock - Verify that a basic block is well formed...
262//
Chris Lattner069a7952002-06-25 15:56:27 +0000263void Verifier::visitBasicBlock(BasicBlock &BB) {
Chris Lattnerdf9779c2003-10-05 17:44:18 +0000264 // Check constraints that this basic block imposes on all of the PHI nodes in
265 // it.
266 if (isa<PHINode>(BB.front())) {
267 std::vector<BasicBlock*> Preds(pred_begin(&BB), pred_end(&BB));
268 std::sort(Preds.begin(), Preds.end());
269
270 for (BasicBlock::iterator I = BB.begin();
271 PHINode *PN = dyn_cast<PHINode>(I); ++I) {
272
273 // Ensure that PHI nodes have at least one entry!
274 Assert1(PN->getNumIncomingValues() != 0,
275 "PHI nodes must have at least one entry. If the block is dead, "
276 "the PHI should be removed!", PN);
277 Assert1(PN->getNumIncomingValues() >= Preds.size(),
278 "PHINode has more entries than the basic block has predecessors!",
279 PN);
280 Assert1(PN->getNumIncomingValues() <= Preds.size(),
281 "PHINode has less entries than the basic block has predecessors!",
282 PN);
283
284 // Get and sort all incoming values in the PHI node...
285 std::vector<std::pair<BasicBlock*, Value*> > Values;
286 Values.reserve(PN->getNumIncomingValues());
287 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
288 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
289 PN->getIncomingValue(i)));
290 std::sort(Values.begin(), Values.end());
291
292 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
293 // Check to make sure that if there is more than one entry for a
294 // particular basic block in this PHI node, that the incoming values are
295 // all identical.
296 //
297 Assert4(i == 0 || Values[i].first != Values[i-1].first ||
298 Values[i].second == Values[i-1].second,
299 "PHI node has multiple entries for the same basic block with "
300 "different incoming values!", PN, Values[i].first,
301 Values[i].second, Values[i-1].second);
302
303 // Check to make sure that the predecessors and PHI node entries are
304 // matched up.
305 Assert3(Values[i].first == Preds[i],
306 "PHI node entries do not match predecessors!", PN,
307 Values[i].first, Preds[i]);
308 }
309 }
310 }
311
Chris Lattner069a7952002-06-25 15:56:27 +0000312 // Ensure that basic blocks have terminators!
313 Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
314}
Chris Lattnerfbf5be52002-03-15 20:25:09 +0000315
Chris Lattner069a7952002-06-25 15:56:27 +0000316void Verifier::visitTerminatorInst(TerminatorInst &I) {
317 // Ensure that terminators only exist at the end of the basic block.
318 Assert1(&I == I.getParent()->getTerminator(),
319 "Terminator found in the middle of a basic block!", I.getParent());
Chris Lattner7af3ee92002-07-18 00:13:42 +0000320 visitInstruction(I);
Chris Lattner069a7952002-06-25 15:56:27 +0000321}
322
323void Verifier::visitReturnInst(ReturnInst &RI) {
324 Function *F = RI.getParent()->getParent();
325 if (RI.getNumOperands() == 0)
326 Assert1(F->getReturnType() == Type::VoidTy,
327 "Function returns no value, but ret instruction found that does!",
328 &RI);
329 else
330 Assert2(F->getReturnType() == RI.getOperand(0)->getType(),
331 "Function return type does not match operand "
332 "type of return inst!", &RI, F->getReturnType());
333
Misha Brukman7eb05a12003-08-18 14:43:39 +0000334 // Check to make sure that the return value has necessary properties for
Chris Lattner069a7952002-06-25 15:56:27 +0000335 // terminators...
336 visitTerminatorInst(RI);
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000337}
338
Chris Lattner75648e72004-03-12 05:54:31 +0000339void Verifier::visitSelectInst(SelectInst &SI) {
340 Assert1(SI.getCondition()->getType() == Type::BoolTy,
341 "Select condition type must be bool!", &SI);
342 Assert1(SI.getTrueValue()->getType() == SI.getFalseValue()->getType(),
343 "Select values must have identical types!", &SI);
344 Assert1(SI.getTrueValue()->getType() == SI.getType(),
345 "Select values must have same type as select instruction!", &SI);
346}
347
348
Misha Brukmanc566ca362004-03-02 00:22:19 +0000349/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
350/// a pass, if any exist, it's an error.
351///
Chris Lattner903a25d2002-11-21 16:54:22 +0000352void Verifier::visitUserOp1(Instruction &I) {
353 Assert1(0, "User-defined operators should not live outside of a pass!",
354 &I);
355}
Chris Lattner0e851da2002-04-18 20:37:37 +0000356
Misha Brukmanc566ca362004-03-02 00:22:19 +0000357/// visitPHINode - Ensure that a PHI node is well formed.
358///
Chris Lattner069a7952002-06-25 15:56:27 +0000359void Verifier::visitPHINode(PHINode &PN) {
360 // Ensure that the PHI nodes are all grouped together at the top of the block.
361 // This can be tested by checking whether the instruction before this is
Misha Brukmanfa100532003-10-10 17:54:14 +0000362 // either nonexistent (because this is begin()) or is a PHI node. If not,
Chris Lattner069a7952002-06-25 15:56:27 +0000363 // then there is some other instruction before a PHI.
Chris Lattnerdf9779c2003-10-05 17:44:18 +0000364 Assert2(&PN.getParent()->front() == &PN || isa<PHINode>(PN.getPrev()),
Chris Lattner069a7952002-06-25 15:56:27 +0000365 "PHI nodes not grouped at top of basic block!",
366 &PN, PN.getParent());
367
Chris Lattner3b93c912003-11-12 07:13:37 +0000368 // Check that all of the operands of the PHI node have the same type as the
369 // result.
370 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
371 Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
372 "PHI node operands are not the same type as the result!", &PN);
373
Chris Lattnerdf9779c2003-10-05 17:44:18 +0000374 // All other PHI node constraints are checked in the visitBasicBlock method.
Chris Lattner0e851da2002-04-18 20:37:37 +0000375
376 visitInstruction(PN);
377}
378
Chris Lattner069a7952002-06-25 15:56:27 +0000379void Verifier::visitCallInst(CallInst &CI) {
380 Assert1(isa<PointerType>(CI.getOperand(0)->getType()),
381 "Called function must be a pointer!", &CI);
382 const PointerType *FPTy = cast<PointerType>(CI.getOperand(0)->getType());
Chris Lattner21ea83b2002-04-18 22:11:52 +0000383 Assert1(isa<FunctionType>(FPTy->getElementType()),
Chris Lattner069a7952002-06-25 15:56:27 +0000384 "Called function is not pointer to function type!", &CI);
Chris Lattner338a4622002-05-08 19:49:50 +0000385
Chris Lattner069a7952002-06-25 15:56:27 +0000386 const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
Chris Lattner338a4622002-05-08 19:49:50 +0000387
388 // Verify that the correct number of arguments are being passed
389 if (FTy->isVarArg())
Chris Lattner069a7952002-06-25 15:56:27 +0000390 Assert1(CI.getNumOperands()-1 >= FTy->getNumParams(),
391 "Called function requires more parameters than were provided!",&CI);
Chris Lattner338a4622002-05-08 19:49:50 +0000392 else
Chris Lattner069a7952002-06-25 15:56:27 +0000393 Assert1(CI.getNumOperands()-1 == FTy->getNumParams(),
394 "Incorrect number of arguments passed to called function!", &CI);
Chris Lattner338a4622002-05-08 19:49:50 +0000395
396 // Verify that all arguments to the call match the function type...
397 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Chris Lattnerd996e542004-02-24 22:06:07 +0000398 Assert3(CI.getOperand(i+1)->getType() == FTy->getParamType(i),
Chris Lattner338a4622002-05-08 19:49:50 +0000399 "Call parameter type does not match function signature!",
Chris Lattnerd996e542004-02-24 22:06:07 +0000400 CI.getOperand(i+1), FTy->getParamType(i), &CI);
Chris Lattner7af3ee92002-07-18 00:13:42 +0000401
Chris Lattnerbb346d02003-05-08 03:47:33 +0000402 if (Function *F = CI.getCalledFunction())
Brian Gaeke960707c2003-11-11 22:41:34 +0000403 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
Chris Lattnerbb346d02003-05-08 03:47:33 +0000404 visitIntrinsicFunctionCall(ID, CI);
405
Chris Lattner7af3ee92002-07-18 00:13:42 +0000406 visitInstruction(CI);
Chris Lattner21ea83b2002-04-18 22:11:52 +0000407}
Chris Lattner0e851da2002-04-18 20:37:37 +0000408
Misha Brukmanc566ca362004-03-02 00:22:19 +0000409/// visitBinaryOperator - Check that both arguments to the binary operator are
410/// of the same type!
411///
Chris Lattner069a7952002-06-25 15:56:27 +0000412void Verifier::visitBinaryOperator(BinaryOperator &B) {
Chris Lattner1f419252002-09-09 20:26:04 +0000413 Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
414 "Both operands to a binary operator are not of the same type!", &B);
Chris Lattner0e851da2002-04-18 20:37:37 +0000415
Chris Lattner1f419252002-09-09 20:26:04 +0000416 // Check that logical operators are only used with integral operands.
417 if (B.getOpcode() == Instruction::And || B.getOpcode() == Instruction::Or ||
418 B.getOpcode() == Instruction::Xor) {
419 Assert1(B.getType()->isIntegral(),
420 "Logical operators only work with integral types!", &B);
421 Assert1(B.getType() == B.getOperand(0)->getType(),
422 "Logical operators must have same type for operands and result!",
423 &B);
424 } else if (isa<SetCondInst>(B)) {
425 // Check that setcc instructions return bool
426 Assert1(B.getType() == Type::BoolTy,
427 "setcc instructions must return boolean values!", &B);
428 } else {
429 // Arithmetic operators only work on integer or fp values
430 Assert1(B.getType() == B.getOperand(0)->getType(),
431 "Arithmetic operators must have same type for operands and result!",
432 &B);
433 Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint(),
Chris Lattner80a25682002-09-10 04:52:59 +0000434 "Arithmetic operators must have integer or fp type!", &B);
Chris Lattner1f419252002-09-09 20:26:04 +0000435 }
436
Chris Lattner0e851da2002-04-18 20:37:37 +0000437 visitInstruction(B);
438}
439
Chris Lattner1f419252002-09-09 20:26:04 +0000440void Verifier::visitShiftInst(ShiftInst &SI) {
441 Assert1(SI.getType()->isInteger(),
442 "Shift must return an integer result!", &SI);
443 Assert1(SI.getType() == SI.getOperand(0)->getType(),
444 "Shift return type must be same as first operand!", &SI);
445 Assert1(SI.getOperand(1)->getType() == Type::UByteTy,
446 "Second operand to shift must be ubyte type!", &SI);
447 visitInstruction(SI);
448}
449
Chris Lattner069a7952002-06-25 15:56:27 +0000450void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
Chris Lattnerdfb3a2c2002-08-22 23:37:20 +0000451 const Type *ElTy =
452 GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
453 std::vector<Value*>(GEP.idx_begin(), GEP.idx_end()), true);
Chris Lattner069a7952002-06-25 15:56:27 +0000454 Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
455 Assert2(PointerType::get(ElTy) == GEP.getType(),
456 "GEP is not of right type for indices!", &GEP, ElTy);
Chris Lattnerd46bb6e2002-04-24 19:12:21 +0000457 visitInstruction(GEP);
458}
459
Chris Lattner069a7952002-06-25 15:56:27 +0000460void Verifier::visitLoadInst(LoadInst &LI) {
Chris Lattnercd709cb2002-08-22 22:49:05 +0000461 const Type *ElTy =
462 cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
Chris Lattner069a7952002-06-25 15:56:27 +0000463 Assert2(ElTy == LI.getType(),
Chris Lattner9d72c2f2003-11-21 17:06:29 +0000464 "Load result type does not match pointer operand type!", &LI, ElTy);
Chris Lattnerd46bb6e2002-04-24 19:12:21 +0000465 visitInstruction(LI);
466}
467
Chris Lattner069a7952002-06-25 15:56:27 +0000468void Verifier::visitStoreInst(StoreInst &SI) {
Chris Lattnercd709cb2002-08-22 22:49:05 +0000469 const Type *ElTy =
470 cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
Chris Lattner069a7952002-06-25 15:56:27 +0000471 Assert2(ElTy == SI.getOperand(0)->getType(),
Chris Lattner9d72c2f2003-11-21 17:06:29 +0000472 "Stored value type does not match pointer operand type!", &SI, ElTy);
Chris Lattnerd46bb6e2002-04-24 19:12:21 +0000473 visitInstruction(SI);
474}
475
Chris Lattner0e851da2002-04-18 20:37:37 +0000476
Misha Brukmanc566ca362004-03-02 00:22:19 +0000477/// verifyInstruction - Verify that an instruction is well formed.
478///
Chris Lattner069a7952002-06-25 15:56:27 +0000479void Verifier::visitInstruction(Instruction &I) {
Chris Lattner1f419252002-09-09 20:26:04 +0000480 BasicBlock *BB = I.getParent();
481 Assert1(BB, "Instruction not embedded in basic block!", &I);
Chris Lattner0e851da2002-04-18 20:37:37 +0000482
Chris Lattnerdf9779c2003-10-05 17:44:18 +0000483 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
484 for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
485 UI != UE; ++UI)
Chris Lattner37053702004-02-27 17:28:25 +0000486 Assert1(*UI != (User*)&I ||
487 !DS->dominates(&BB->getParent()->getEntryBlock(), BB),
Chris Lattnerdf9779c2003-10-05 17:44:18 +0000488 "Only PHI nodes may reference their own value!", &I);
489 }
490
491 // Check that void typed values don't have names
492 Assert1(I.getType() != Type::VoidTy || !I.hasName(),
493 "Instruction has a name, but provides a void value!", &I);
494
Chris Lattner0e851da2002-04-18 20:37:37 +0000495 // Check that all uses of the instruction, if they are instructions
496 // themselves, actually have parent basic blocks. If the use is not an
497 // instruction, it is an error!
Chris Lattner069a7952002-06-25 15:56:27 +0000498 for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
Chris Lattner0e851da2002-04-18 20:37:37 +0000499 UI != UE; ++UI) {
500 Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
501 *UI);
Chris Lattner21ea83b2002-04-18 22:11:52 +0000502 Instruction *Used = cast<Instruction>(*UI);
503 Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
Chris Lattner069a7952002-06-25 15:56:27 +0000504 " embeded in a basic block!", &I, Used);
Chris Lattner0e851da2002-04-18 20:37:37 +0000505 }
506
Chris Lattnerdf9779c2003-10-05 17:44:18 +0000507 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
508 // Check to make sure that the "address of" an intrinsic function is never
509 // taken.
Chris Lattnerbb346d02003-05-08 03:47:33 +0000510 if (Function *F = dyn_cast<Function>(I.getOperand(i)))
511 Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
512 "Cannot take the address of an intrinsic!", &I);
Chris Lattnerdf9779c2003-10-05 17:44:18 +0000513
514 else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
Chris Lattnerec5089a2004-01-14 04:25:59 +0000515 BasicBlock *OpBlock = Op->getParent();
Chris Lattnerec5089a2004-01-14 04:25:59 +0000516
Chris Lattnerdf9779c2003-10-05 17:44:18 +0000517 // Check that a definition dominates all of its uses.
Chris Lattnerdf9779c2003-10-05 17:44:18 +0000518 if (!isa<PHINode>(I)) {
Chris Lattner02062822004-01-14 05:42:52 +0000519 // Invoke results are only usable in the normal destination, not in the
520 // exceptional destination.
521 if (InvokeInst *II = dyn_cast<InvokeInst>(Op))
522 OpBlock = II->getNormalDest();
523
Chris Lattnerdf9779c2003-10-05 17:44:18 +0000524 // Definition must dominate use unless use is unreachable!
Chris Lattnerec5089a2004-01-14 04:25:59 +0000525 Assert2(DS->dominates(OpBlock, BB) ||
Chris Lattnerdf9779c2003-10-05 17:44:18 +0000526 !DS->dominates(&BB->getParent()->getEntryBlock(), BB),
527 "Instruction does not dominate all uses!", Op, &I);
528 } else {
529 // PHI nodes are more difficult than other nodes because they actually
530 // "use" the value in the predecessor basic blocks they correspond to.
531 BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
Chris Lattnerec5089a2004-01-14 04:25:59 +0000532 Assert2(DS->dominates(OpBlock, PredBB) ||
Chris Lattnerdf9779c2003-10-05 17:44:18 +0000533 !DS->dominates(&BB->getParent()->getEntryBlock(), PredBB),
534 "Instruction does not dominate all uses!", Op, &I);
535 }
536 }
537 }
Chris Lattnerbb346d02003-05-08 03:47:33 +0000538}
539
540/// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
Misha Brukmanc566ca362004-03-02 00:22:19 +0000541///
Brian Gaeke960707c2003-11-11 22:41:34 +0000542void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
Chris Lattnerbb346d02003-05-08 03:47:33 +0000543 Function *IF = CI.getCalledFunction();
544 const FunctionType *FT = IF->getFunctionType();
545 Assert1(IF->isExternal(), "Intrinsic functions should never be defined!", IF);
Chris Lattnerd295d992003-06-05 21:01:26 +0000546 unsigned NumArgs = 0;
Chris Lattnerbb346d02003-05-08 03:47:33 +0000547
Chris Lattnerade94102003-08-24 05:30:29 +0000548 // FIXME: this should check the return type of each intrinsic as well, also
549 // arguments!
Chris Lattnerbb346d02003-05-08 03:47:33 +0000550 switch (ID) {
Brian Gaeke960707c2003-11-11 22:41:34 +0000551 case Intrinsic::va_start:
Chris Lattnerbad4b4a2003-05-08 15:55:31 +0000552 Assert1(CI.getParent()->getParent()->getFunctionType()->isVarArg(),
553 "llvm.va_start intrinsic may only occur in function with variable"
554 " args!", &CI);
Chris Lattner5b337482003-10-18 05:57:43 +0000555 NumArgs = 0;
Chris Lattnerbb346d02003-05-08 03:47:33 +0000556 break;
Brian Gaeke960707c2003-11-11 22:41:34 +0000557 case Intrinsic::va_end: NumArgs = 1; break;
558 case Intrinsic::va_copy: NumArgs = 1; break;
Chris Lattnerade94102003-08-24 05:30:29 +0000559
Chris Lattnerdc632112004-02-14 02:47:17 +0000560 case Intrinsic::returnaddress:
561 case Intrinsic::frameaddress:
562 Assert1(isa<PointerType>(FT->getReturnType()),
563 "llvm.(frame|return)address must return pointers", IF);
564 Assert1(FT->getNumParams() == 1 && isa<ConstantInt>(CI.getOperand(1)),
565 "llvm.(frame|return)address require a single constant integer argument",
566 &CI);
567 NumArgs = 1;
568 break;
569
Brian Gaeke960707c2003-11-11 22:41:34 +0000570 case Intrinsic::setjmp: NumArgs = 1; break;
571 case Intrinsic::longjmp: NumArgs = 2; break;
572 case Intrinsic::sigsetjmp: NumArgs = 2; break;
573 case Intrinsic::siglongjmp: NumArgs = 2; break;
Chris Lattner3d903f02004-01-05 05:36:30 +0000574
575 case Intrinsic::dbg_stoppoint: NumArgs = 4; break;
576 case Intrinsic::dbg_region_start:NumArgs = 1; break;
577 case Intrinsic::dbg_region_end: NumArgs = 1; break;
578 case Intrinsic::dbg_func_start: NumArgs = 1; break;
Chris Lattner59f1ef42004-01-06 05:33:02 +0000579 case Intrinsic::dbg_declare: NumArgs = 1; break;
Chris Lattner17d028d2004-02-12 17:01:09 +0000580
581 case Intrinsic::memcpy: NumArgs = 4; break;
Chris Lattner5ed171e2004-02-12 18:11:20 +0000582 case Intrinsic::memmove: NumArgs = 4; break;
Chris Lattnerdc632112004-02-14 02:47:17 +0000583 case Intrinsic::memset: NumArgs = 4; break;
Chris Lattner60104f02003-07-28 21:20:57 +0000584
Brian Gaeke960707c2003-11-11 22:41:34 +0000585 case Intrinsic::alpha_ctlz: NumArgs = 1; break;
586 case Intrinsic::alpha_cttz: NumArgs = 1; break;
587 case Intrinsic::alpha_ctpop: NumArgs = 1; break;
588 case Intrinsic::alpha_umulh: NumArgs = 2; break;
589 case Intrinsic::alpha_vecop: NumArgs = 4; break;
590 case Intrinsic::alpha_pup: NumArgs = 3; break;
591 case Intrinsic::alpha_bytezap: NumArgs = 2; break;
592 case Intrinsic::alpha_bytemanip: NumArgs = 3; break;
593 case Intrinsic::alpha_dfpbop: NumArgs = 3; break;
594 case Intrinsic::alpha_dfpuop: NumArgs = 2; break;
595 case Intrinsic::alpha_unordered: NumArgs = 2; break;
596 case Intrinsic::alpha_uqtodfp: NumArgs = 2; break;
597 case Intrinsic::alpha_uqtosfp: NumArgs = 2; break;
598 case Intrinsic::alpha_dfptosq: NumArgs = 2; break;
599 case Intrinsic::alpha_sfptosq: NumArgs = 2; break;
Chris Lattner60104f02003-07-28 21:20:57 +0000600
Brian Gaeke960707c2003-11-11 22:41:34 +0000601 case Intrinsic::not_intrinsic:
Chris Lattnerbb346d02003-05-08 03:47:33 +0000602 assert(0 && "Invalid intrinsic!"); NumArgs = 0; break;
603 }
604
605 Assert1(FT->getNumParams() == NumArgs || (FT->getNumParams() < NumArgs &&
606 FT->isVarArg()),
607 "Illegal # arguments for intrinsic function!", IF);
Chris Lattner0e851da2002-04-18 20:37:37 +0000608}
609
610
611//===----------------------------------------------------------------------===//
612// Implement the public interfaces to this file...
613//===----------------------------------------------------------------------===//
614
Chris Lattner189d19f2003-11-21 20:23:48 +0000615FunctionPass *llvm::createVerifierPass() {
Chris Lattner0e851da2002-04-18 20:37:37 +0000616 return new Verifier();
617}
618
Chris Lattner8e72d6f2002-08-02 17:37:08 +0000619
620// verifyFunction - Create
Chris Lattner189d19f2003-11-21 20:23:48 +0000621bool llvm::verifyFunction(const Function &f) {
Chris Lattner8e72d6f2002-08-02 17:37:08 +0000622 Function &F = (Function&)f;
623 assert(!F.isExternal() && "Cannot verify external functions");
624
625 DominatorSet DS;
626 DS.doInitialization(*F.getParent());
627 DS.runOnFunction(F);
628
629 Verifier V(DS);
630 V.runOnFunction(F);
631
632 DS.doFinalization(*F.getParent());
633
Chris Lattner0e851da2002-04-18 20:37:37 +0000634 return V.Broken;
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000635}
636
Misha Brukmanc566ca362004-03-02 00:22:19 +0000637/// verifyModule - Check a module for errors, printing messages on stderr.
638/// Return true if the module is corrupt.
639///
Chris Lattner189d19f2003-11-21 20:23:48 +0000640bool llvm::verifyModule(const Module &M) {
Chris Lattner8e72d6f2002-08-02 17:37:08 +0000641 PassManager PM;
642 Verifier *V = new Verifier();
643 PM.add(V);
644 PM.run((Module&)M);
645 return V->Broken;
Chris Lattner2f7c9632001-06-06 20:29:01 +0000646}