blob: feaef83bbb35e3958e5212ce6bfc389932474497 [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 Lattnerb870ca72004-03-14 03:16:15 +000047#include "llvm/ModuleProvider.h"
Chris Lattneraf95e582002-04-13 22:48:46 +000048#include "llvm/DerivedTypes.h"
Chris Lattnerdc632112004-02-14 02:47:17 +000049#include "llvm/Instructions.h"
Chris Lattnerbb346d02003-05-08 03:47:33 +000050#include "llvm/Intrinsics.h"
Chris Lattnerdc632112004-02-14 02:47:17 +000051#include "llvm/PassManager.h"
52#include "llvm/SymbolTable.h"
Chris Lattner8e72d6f2002-08-02 17:37:08 +000053#include "llvm/Analysis/Dominators.h"
Chris Lattnerd02f08d2002-02-20 17:55:43 +000054#include "llvm/Support/CFG.h"
Chris Lattner0e851da2002-04-18 20:37:37 +000055#include "llvm/Support/InstVisitor.h"
Chris Lattnerd02f08d2002-02-20 17:55:43 +000056#include "Support/STLExtras.h"
57#include <algorithm>
Chris Lattner189d19f2003-11-21 20:23:48 +000058using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +000059
Chris Lattner0e851da2002-04-18 20:37:37 +000060namespace { // Anonymous namespace for class
Chris Lattner2f7c9632001-06-06 20:29:01 +000061
Chris Lattnerc8e66542002-04-27 06:56:12 +000062 struct Verifier : public FunctionPass, InstVisitor<Verifier> {
Chris Lattner8e72d6f2002-08-02 17:37:08 +000063 bool Broken; // Is this module found to be broken?
64 bool RealPass; // Are we not being run by a PassManager?
65 bool AbortBroken; // If broken, should it or should it not abort?
Misha Brukmanc566ca362004-03-02 00:22:19 +000066 Module *Mod; // Module we are verifying right now
67 DominatorSet *DS; // Dominator set, caution can be null!
Chris Lattner2f7c9632001-06-06 20:29:01 +000068
Chris Lattner8e72d6f2002-08-02 17:37:08 +000069 Verifier() : Broken(false), RealPass(true), AbortBroken(true), DS(0) {}
70 Verifier(bool AB) : Broken(false), RealPass(true), AbortBroken(AB), DS(0) {}
71 Verifier(DominatorSet &ds)
72 : Broken(false), RealPass(false), AbortBroken(false), DS(&ds) {}
73
Chris Lattner2f7c9632001-06-06 20:29:01 +000074
Chris Lattner069a7952002-06-25 15:56:27 +000075 bool doInitialization(Module &M) {
Brian Gaeke9f479272003-11-16 23:07:42 +000076 Mod = &M;
Chris Lattner069a7952002-06-25 15:56:27 +000077 verifySymbolTable(M.getSymbolTable());
Chris Lattnera4503972002-09-19 16:12:19 +000078
79 // If this is a real pass, in a pass manager, we must abort before
80 // returning back to the pass manager, or else the pass manager may try to
81 // run other passes on the broken module.
Chris Lattnera4503972002-09-19 16:12:19 +000082 if (RealPass)
83 abortIfBroken();
Chris Lattner0e851da2002-04-18 20:37:37 +000084 return false;
85 }
86
Chris Lattner069a7952002-06-25 15:56:27 +000087 bool runOnFunction(Function &F) {
Chris Lattner8e72d6f2002-08-02 17:37:08 +000088 // Get dominator information if we are being run by PassManager
89 if (RealPass) DS = &getAnalysis<DominatorSet>();
Chris Lattner0e851da2002-04-18 20:37:37 +000090 visit(F);
Chris Lattnera4503972002-09-19 16:12:19 +000091
92 // If this is a real pass, in a pass manager, we must abort before
93 // returning back to the pass manager, or else the pass manager may try to
94 // run other passes on the broken module.
Chris Lattnera4503972002-09-19 16:12:19 +000095 if (RealPass)
96 abortIfBroken();
97
Chris Lattner0e851da2002-04-18 20:37:37 +000098 return false;
99 }
100
Chris Lattner069a7952002-06-25 15:56:27 +0000101 bool doFinalization(Module &M) {
Chris Lattner9713b842002-04-28 16:04:26 +0000102 // Scan through, checking all of the external function's linkage now...
Chris Lattner069a7952002-06-25 15:56:27 +0000103 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
Chris Lattner3ac483b2003-04-16 20:42:40 +0000104 visitGlobalValue(*I);
Chris Lattner9713b842002-04-28 16:04:26 +0000105
Chris Lattner78bc0fa2002-10-06 22:47:32 +0000106 for (Module::giterator I = M.gbegin(), E = M.gend(); I != E; ++I)
Chris Lattnerdcdc3712003-11-21 20:33:27 +0000107 visitGlobalValue(*I);
Chris Lattner78bc0fa2002-10-06 22:47:32 +0000108
Chris Lattnera4503972002-09-19 16:12:19 +0000109 // If the module is broken, abort at this time.
110 abortIfBroken();
Chris Lattnerd46bb6e2002-04-24 19:12:21 +0000111 return false;
112 }
113
Chris Lattnerf12cc842002-04-28 21:27:06 +0000114 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
115 AU.setPreservesAll();
Chris Lattner8e72d6f2002-08-02 17:37:08 +0000116 if (RealPass)
Chris Lattner40eb9da2002-08-08 19:01:28 +0000117 AU.addRequired<DominatorSet>();
Chris Lattnerf12cc842002-04-28 21:27:06 +0000118 }
119
Misha Brukmanc566ca362004-03-02 00:22:19 +0000120 /// abortIfBroken - If the module is broken and we are supposed to abort on
121 /// this condition, do so.
122 ///
Chris Lattnera4503972002-09-19 16:12:19 +0000123 void abortIfBroken() const {
124 if (Broken && AbortBroken) {
125 std::cerr << "Broken module found, compilation aborted!\n";
126 abort();
127 }
128 }
129
Chris Lattner3ac483b2003-04-16 20:42:40 +0000130
Chris Lattner0e851da2002-04-18 20:37:37 +0000131 // Verification methods...
Chris Lattner98cf1f52002-11-20 18:36:02 +0000132 void verifySymbolTable(SymbolTable &ST);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000133 void visitGlobalValue(GlobalValue &GV);
Chris Lattner069a7952002-06-25 15:56:27 +0000134 void visitFunction(Function &F);
135 void visitBasicBlock(BasicBlock &BB);
136 void visitPHINode(PHINode &PN);
137 void visitBinaryOperator(BinaryOperator &B);
Chris Lattner1f419252002-09-09 20:26:04 +0000138 void visitShiftInst(ShiftInst &SI);
Chris Lattner5b337482003-10-18 05:57:43 +0000139 void visitVANextInst(VANextInst &VAN) { visitInstruction(VAN); }
140 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
Chris Lattner069a7952002-06-25 15:56:27 +0000141 void visitCallInst(CallInst &CI);
142 void visitGetElementPtrInst(GetElementPtrInst &GEP);
143 void visitLoadInst(LoadInst &LI);
144 void visitStoreInst(StoreInst &SI);
145 void visitInstruction(Instruction &I);
146 void visitTerminatorInst(TerminatorInst &I);
147 void visitReturnInst(ReturnInst &RI);
Chris Lattner75648e72004-03-12 05:54:31 +0000148 void visitSelectInst(SelectInst &SI);
Chris Lattner903a25d2002-11-21 16:54:22 +0000149 void visitUserOp1(Instruction &I);
150 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
Brian Gaeke960707c2003-11-11 22:41:34 +0000151 void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
Chris Lattner0e851da2002-04-18 20:37:37 +0000152
Chris Lattner7e5e4562003-11-21 17:35:51 +0000153
154 void WriteValue(const Value *V) {
155 if (!V) return;
Chris Lattner189d19f2003-11-21 20:23:48 +0000156 if (isa<Instruction>(V)) {
Chris Lattner7e5e4562003-11-21 17:35:51 +0000157 std::cerr << *V;
Chris Lattner189d19f2003-11-21 20:23:48 +0000158 } else if (const Type *Ty = dyn_cast<Type>(V)) {
159 WriteTypeSymbolic(std::cerr, Ty, Mod);
160 } else {
Chris Lattner7e5e4562003-11-21 17:35:51 +0000161 WriteAsOperand (std::cerr, V, true, true, Mod);
162 std::cerr << "\n";
163 }
164 }
165
166
Chris Lattner0e851da2002-04-18 20:37:37 +0000167 // CheckFailed - A check failed, so print out the condition and the message
168 // that failed. This provides a nice place to put a breakpoint if you want
169 // to see why something is not correct.
Chris Lattner7e5e4562003-11-21 17:35:51 +0000170 void CheckFailed(const std::string &Message,
171 const Value *V1 = 0, const Value *V2 = 0,
172 const Value *V3 = 0, const Value *V4 = 0) {
Chris Lattner0e851da2002-04-18 20:37:37 +0000173 std::cerr << Message << "\n";
Chris Lattner7e5e4562003-11-21 17:35:51 +0000174 WriteValue(V1);
175 WriteValue(V2);
176 WriteValue(V3);
177 WriteValue(V4);
Chris Lattner0e851da2002-04-18 20:37:37 +0000178 Broken = true;
179 }
180 };
Chris Lattner00fb26c2002-07-23 18:08:17 +0000181
Chris Lattneref901292003-11-13 19:47:29 +0000182 RegisterOpt<Verifier> X("verify", "Module Verifier");
Chris Lattner189d19f2003-11-21 20:23:48 +0000183} // End anonymous namespace
184
Chris Lattner2f7c9632001-06-06 20:29:01 +0000185
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000186// Assert - We know that cond should be true, if not print an error message.
187#define Assert(C, M) \
Chris Lattner412d2772002-04-28 16:06:24 +0000188 do { if (!(C)) { CheckFailed(M); return; } } while (0)
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000189#define Assert1(C, M, V1) \
Chris Lattner412d2772002-04-28 16:06:24 +0000190 do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000191#define Assert2(C, M, V1, V2) \
Chris Lattner412d2772002-04-28 16:06:24 +0000192 do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
Chris Lattner069a7952002-06-25 15:56:27 +0000193#define Assert3(C, M, V1, V2, V3) \
194 do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
195#define Assert4(C, M, V1, V2, V3, V4) \
196 do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
Chris Lattner2f7c9632001-06-06 20:29:01 +0000197
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000198
Chris Lattner3ac483b2003-04-16 20:42:40 +0000199void Verifier::visitGlobalValue(GlobalValue &GV) {
200 Assert1(!GV.isExternal() || GV.hasExternalLinkage(),
Chris Lattnerdcdc3712003-11-21 20:33:27 +0000201 "Global is external, but doesn't have external linkage!", &GV);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000202 Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
203 "Only global variables can have appending linkage!", &GV);
204
205 if (GV.hasAppendingLinkage()) {
206 GlobalVariable &GVar = cast<GlobalVariable>(GV);
207 Assert1(isa<ArrayType>(GVar.getType()->getElementType()),
208 "Only global arrays can have appending linkage!", &GV);
209 }
210}
211
Chris Lattneraf95e582002-04-13 22:48:46 +0000212// verifySymbolTable - Verify that a function or module symbol table is ok
Chris Lattnerfbf5be52002-03-15 20:25:09 +0000213//
Chris Lattner98cf1f52002-11-20 18:36:02 +0000214void Verifier::verifySymbolTable(SymbolTable &ST) {
Chris Lattnerfbf5be52002-03-15 20:25:09 +0000215 // Loop over all of the types in the symbol table...
Chris Lattner98cf1f52002-11-20 18:36:02 +0000216 for (SymbolTable::iterator TI = ST.begin(), TE = ST.end(); TI != TE; ++TI)
Chris Lattner0e851da2002-04-18 20:37:37 +0000217 for (SymbolTable::type_iterator I = TI->second.begin(),
Chris Lattnerfbf5be52002-03-15 20:25:09 +0000218 E = TI->second.end(); I != E; ++I) {
219 Value *V = I->second;
220
221 // Check that there are no void typed values in the symbol table. Values
222 // with a void type cannot be put into symbol tables because they cannot
223 // have names!
224 Assert1(V->getType() != Type::VoidTy,
Chris Lattner412d2772002-04-28 16:06:24 +0000225 "Values with void type are not allowed to have names!", V);
Chris Lattnerfbf5be52002-03-15 20:25:09 +0000226 }
Chris Lattnerfbf5be52002-03-15 20:25:09 +0000227}
228
Chris Lattner0e851da2002-04-18 20:37:37 +0000229
230// visitFunction - Verify that a function is ok.
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000231//
Chris Lattner069a7952002-06-25 15:56:27 +0000232void Verifier::visitFunction(Function &F) {
Chris Lattneraf95e582002-04-13 22:48:46 +0000233 // Check function arguments...
Chris Lattner069a7952002-06-25 15:56:27 +0000234 const FunctionType *FT = F.getFunctionType();
235 unsigned NumArgs = F.getArgumentList().size();
Chris Lattneraf95e582002-04-13 22:48:46 +0000236
Chris Lattner149376d2002-10-13 20:57:00 +0000237 Assert2(FT->getNumParams() == NumArgs,
Chris Lattneraf95e582002-04-13 22:48:46 +0000238 "# formal arguments must match # of arguments for function type!",
Chris Lattner069a7952002-06-25 15:56:27 +0000239 &F, FT);
Chris Lattner3ae303c2003-11-21 22:32:23 +0000240 Assert1(F.getReturnType()->isFirstClassType() ||
241 F.getReturnType() == Type::VoidTy,
242 "Functions cannot return aggregate values!", &F);
Chris Lattneraf95e582002-04-13 22:48:46 +0000243
244 // Check that the argument values match the function type for this function...
Chris Lattner149376d2002-10-13 20:57:00 +0000245 unsigned i = 0;
246 for (Function::aiterator I = F.abegin(), E = F.aend(); I != E; ++I, ++i)
247 Assert2(I->getType() == FT->getParamType(i),
248 "Argument value does not match function argument type!",
249 I, FT->getParamType(i));
Chris Lattneraf95e582002-04-13 22:48:46 +0000250
Chris Lattner149376d2002-10-13 20:57:00 +0000251 if (!F.isExternal()) {
252 verifySymbolTable(F.getSymbolTable());
253
254 // Check the entry node
Chris Lattner5dac64f2003-09-20 14:39:18 +0000255 BasicBlock *Entry = &F.getEntryBlock();
Chris Lattner149376d2002-10-13 20:57:00 +0000256 Assert1(pred_begin(Entry) == pred_end(Entry),
257 "Entry block to function must not have predecessors!", Entry);
258 }
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000259}
260
261
Chris Lattner0e851da2002-04-18 20:37:37 +0000262// verifyBasicBlock - Verify that a basic block is well formed...
263//
Chris Lattner069a7952002-06-25 15:56:27 +0000264void Verifier::visitBasicBlock(BasicBlock &BB) {
Chris Lattnerdf9779c2003-10-05 17:44:18 +0000265 // Check constraints that this basic block imposes on all of the PHI nodes in
266 // it.
267 if (isa<PHINode>(BB.front())) {
268 std::vector<BasicBlock*> Preds(pred_begin(&BB), pred_end(&BB));
269 std::sort(Preds.begin(), Preds.end());
270
271 for (BasicBlock::iterator I = BB.begin();
272 PHINode *PN = dyn_cast<PHINode>(I); ++I) {
273
274 // Ensure that PHI nodes have at least one entry!
275 Assert1(PN->getNumIncomingValues() != 0,
276 "PHI nodes must have at least one entry. If the block is dead, "
277 "the PHI should be removed!", PN);
278 Assert1(PN->getNumIncomingValues() >= Preds.size(),
279 "PHINode has more entries than the basic block has predecessors!",
280 PN);
281 Assert1(PN->getNumIncomingValues() <= Preds.size(),
282 "PHINode has less entries than the basic block has predecessors!",
283 PN);
284
285 // Get and sort all incoming values in the PHI node...
286 std::vector<std::pair<BasicBlock*, Value*> > Values;
287 Values.reserve(PN->getNumIncomingValues());
288 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
289 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
290 PN->getIncomingValue(i)));
291 std::sort(Values.begin(), Values.end());
292
293 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
294 // Check to make sure that if there is more than one entry for a
295 // particular basic block in this PHI node, that the incoming values are
296 // all identical.
297 //
298 Assert4(i == 0 || Values[i].first != Values[i-1].first ||
299 Values[i].second == Values[i-1].second,
300 "PHI node has multiple entries for the same basic block with "
301 "different incoming values!", PN, Values[i].first,
302 Values[i].second, Values[i-1].second);
303
304 // Check to make sure that the predecessors and PHI node entries are
305 // matched up.
306 Assert3(Values[i].first == Preds[i],
307 "PHI node entries do not match predecessors!", PN,
308 Values[i].first, Preds[i]);
309 }
310 }
311 }
312
Chris Lattner069a7952002-06-25 15:56:27 +0000313 // Ensure that basic blocks have terminators!
314 Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
315}
Chris Lattnerfbf5be52002-03-15 20:25:09 +0000316
Chris Lattner069a7952002-06-25 15:56:27 +0000317void Verifier::visitTerminatorInst(TerminatorInst &I) {
318 // Ensure that terminators only exist at the end of the basic block.
319 Assert1(&I == I.getParent()->getTerminator(),
320 "Terminator found in the middle of a basic block!", I.getParent());
Chris Lattner7af3ee92002-07-18 00:13:42 +0000321 visitInstruction(I);
Chris Lattner069a7952002-06-25 15:56:27 +0000322}
323
324void Verifier::visitReturnInst(ReturnInst &RI) {
325 Function *F = RI.getParent()->getParent();
326 if (RI.getNumOperands() == 0)
327 Assert1(F->getReturnType() == Type::VoidTy,
328 "Function returns no value, but ret instruction found that does!",
329 &RI);
330 else
331 Assert2(F->getReturnType() == RI.getOperand(0)->getType(),
332 "Function return type does not match operand "
333 "type of return inst!", &RI, F->getReturnType());
334
Misha Brukman7eb05a12003-08-18 14:43:39 +0000335 // Check to make sure that the return value has necessary properties for
Chris Lattner069a7952002-06-25 15:56:27 +0000336 // terminators...
337 visitTerminatorInst(RI);
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000338}
339
Chris Lattner75648e72004-03-12 05:54:31 +0000340void Verifier::visitSelectInst(SelectInst &SI) {
341 Assert1(SI.getCondition()->getType() == Type::BoolTy,
342 "Select condition type must be bool!", &SI);
343 Assert1(SI.getTrueValue()->getType() == SI.getFalseValue()->getType(),
344 "Select values must have identical types!", &SI);
345 Assert1(SI.getTrueValue()->getType() == SI.getType(),
346 "Select values must have same type as select instruction!", &SI);
347}
348
349
Misha Brukmanc566ca362004-03-02 00:22:19 +0000350/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
351/// a pass, if any exist, it's an error.
352///
Chris Lattner903a25d2002-11-21 16:54:22 +0000353void Verifier::visitUserOp1(Instruction &I) {
354 Assert1(0, "User-defined operators should not live outside of a pass!",
355 &I);
356}
Chris Lattner0e851da2002-04-18 20:37:37 +0000357
Misha Brukmanc566ca362004-03-02 00:22:19 +0000358/// visitPHINode - Ensure that a PHI node is well formed.
359///
Chris Lattner069a7952002-06-25 15:56:27 +0000360void Verifier::visitPHINode(PHINode &PN) {
361 // Ensure that the PHI nodes are all grouped together at the top of the block.
362 // This can be tested by checking whether the instruction before this is
Misha Brukmanfa100532003-10-10 17:54:14 +0000363 // either nonexistent (because this is begin()) or is a PHI node. If not,
Chris Lattner069a7952002-06-25 15:56:27 +0000364 // then there is some other instruction before a PHI.
Chris Lattnerdf9779c2003-10-05 17:44:18 +0000365 Assert2(&PN.getParent()->front() == &PN || isa<PHINode>(PN.getPrev()),
Chris Lattner069a7952002-06-25 15:56:27 +0000366 "PHI nodes not grouped at top of basic block!",
367 &PN, PN.getParent());
368
Chris Lattner3b93c912003-11-12 07:13:37 +0000369 // Check that all of the operands of the PHI node have the same type as the
370 // result.
371 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i)
372 Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
373 "PHI node operands are not the same type as the result!", &PN);
374
Chris Lattnerdf9779c2003-10-05 17:44:18 +0000375 // All other PHI node constraints are checked in the visitBasicBlock method.
Chris Lattner0e851da2002-04-18 20:37:37 +0000376
377 visitInstruction(PN);
378}
379
Chris Lattner069a7952002-06-25 15:56:27 +0000380void Verifier::visitCallInst(CallInst &CI) {
381 Assert1(isa<PointerType>(CI.getOperand(0)->getType()),
382 "Called function must be a pointer!", &CI);
383 const PointerType *FPTy = cast<PointerType>(CI.getOperand(0)->getType());
Chris Lattner21ea83b2002-04-18 22:11:52 +0000384 Assert1(isa<FunctionType>(FPTy->getElementType()),
Chris Lattner069a7952002-06-25 15:56:27 +0000385 "Called function is not pointer to function type!", &CI);
Chris Lattner338a4622002-05-08 19:49:50 +0000386
Chris Lattner069a7952002-06-25 15:56:27 +0000387 const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
Chris Lattner338a4622002-05-08 19:49:50 +0000388
389 // Verify that the correct number of arguments are being passed
390 if (FTy->isVarArg())
Chris Lattner069a7952002-06-25 15:56:27 +0000391 Assert1(CI.getNumOperands()-1 >= FTy->getNumParams(),
392 "Called function requires more parameters than were provided!",&CI);
Chris Lattner338a4622002-05-08 19:49:50 +0000393 else
Chris Lattner069a7952002-06-25 15:56:27 +0000394 Assert1(CI.getNumOperands()-1 == FTy->getNumParams(),
395 "Incorrect number of arguments passed to called function!", &CI);
Chris Lattner338a4622002-05-08 19:49:50 +0000396
397 // Verify that all arguments to the call match the function type...
398 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Chris Lattnerd996e542004-02-24 22:06:07 +0000399 Assert3(CI.getOperand(i+1)->getType() == FTy->getParamType(i),
Chris Lattner338a4622002-05-08 19:49:50 +0000400 "Call parameter type does not match function signature!",
Chris Lattnerd996e542004-02-24 22:06:07 +0000401 CI.getOperand(i+1), FTy->getParamType(i), &CI);
Chris Lattner7af3ee92002-07-18 00:13:42 +0000402
Chris Lattnerbb346d02003-05-08 03:47:33 +0000403 if (Function *F = CI.getCalledFunction())
Brian Gaeke960707c2003-11-11 22:41:34 +0000404 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
Chris Lattnerbb346d02003-05-08 03:47:33 +0000405 visitIntrinsicFunctionCall(ID, CI);
406
Chris Lattner7af3ee92002-07-18 00:13:42 +0000407 visitInstruction(CI);
Chris Lattner21ea83b2002-04-18 22:11:52 +0000408}
Chris Lattner0e851da2002-04-18 20:37:37 +0000409
Misha Brukmanc566ca362004-03-02 00:22:19 +0000410/// visitBinaryOperator - Check that both arguments to the binary operator are
411/// of the same type!
412///
Chris Lattner069a7952002-06-25 15:56:27 +0000413void Verifier::visitBinaryOperator(BinaryOperator &B) {
Chris Lattner1f419252002-09-09 20:26:04 +0000414 Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
415 "Both operands to a binary operator are not of the same type!", &B);
Chris Lattner0e851da2002-04-18 20:37:37 +0000416
Chris Lattner1f419252002-09-09 20:26:04 +0000417 // Check that logical operators are only used with integral operands.
418 if (B.getOpcode() == Instruction::And || B.getOpcode() == Instruction::Or ||
419 B.getOpcode() == Instruction::Xor) {
420 Assert1(B.getType()->isIntegral(),
421 "Logical operators only work with integral types!", &B);
422 Assert1(B.getType() == B.getOperand(0)->getType(),
423 "Logical operators must have same type for operands and result!",
424 &B);
425 } else if (isa<SetCondInst>(B)) {
426 // Check that setcc instructions return bool
427 Assert1(B.getType() == Type::BoolTy,
428 "setcc instructions must return boolean values!", &B);
429 } else {
430 // Arithmetic operators only work on integer or fp values
431 Assert1(B.getType() == B.getOperand(0)->getType(),
432 "Arithmetic operators must have same type for operands and result!",
433 &B);
434 Assert1(B.getType()->isInteger() || B.getType()->isFloatingPoint(),
Chris Lattner80a25682002-09-10 04:52:59 +0000435 "Arithmetic operators must have integer or fp type!", &B);
Chris Lattner1f419252002-09-09 20:26:04 +0000436 }
437
Chris Lattner0e851da2002-04-18 20:37:37 +0000438 visitInstruction(B);
439}
440
Chris Lattner1f419252002-09-09 20:26:04 +0000441void Verifier::visitShiftInst(ShiftInst &SI) {
442 Assert1(SI.getType()->isInteger(),
443 "Shift must return an integer result!", &SI);
444 Assert1(SI.getType() == SI.getOperand(0)->getType(),
445 "Shift return type must be same as first operand!", &SI);
446 Assert1(SI.getOperand(1)->getType() == Type::UByteTy,
447 "Second operand to shift must be ubyte type!", &SI);
448 visitInstruction(SI);
449}
450
Chris Lattner069a7952002-06-25 15:56:27 +0000451void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
Chris Lattnerdfb3a2c2002-08-22 23:37:20 +0000452 const Type *ElTy =
453 GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
454 std::vector<Value*>(GEP.idx_begin(), GEP.idx_end()), true);
Chris Lattner069a7952002-06-25 15:56:27 +0000455 Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
456 Assert2(PointerType::get(ElTy) == GEP.getType(),
457 "GEP is not of right type for indices!", &GEP, ElTy);
Chris Lattnerd46bb6e2002-04-24 19:12:21 +0000458 visitInstruction(GEP);
459}
460
Chris Lattner069a7952002-06-25 15:56:27 +0000461void Verifier::visitLoadInst(LoadInst &LI) {
Chris Lattnercd709cb2002-08-22 22:49:05 +0000462 const Type *ElTy =
463 cast<PointerType>(LI.getOperand(0)->getType())->getElementType();
Chris Lattner069a7952002-06-25 15:56:27 +0000464 Assert2(ElTy == LI.getType(),
Chris Lattner9d72c2f2003-11-21 17:06:29 +0000465 "Load result type does not match pointer operand type!", &LI, ElTy);
Chris Lattnerd46bb6e2002-04-24 19:12:21 +0000466 visitInstruction(LI);
467}
468
Chris Lattner069a7952002-06-25 15:56:27 +0000469void Verifier::visitStoreInst(StoreInst &SI) {
Chris Lattnercd709cb2002-08-22 22:49:05 +0000470 const Type *ElTy =
471 cast<PointerType>(SI.getOperand(1)->getType())->getElementType();
Chris Lattner069a7952002-06-25 15:56:27 +0000472 Assert2(ElTy == SI.getOperand(0)->getType(),
Chris Lattner9d72c2f2003-11-21 17:06:29 +0000473 "Stored value type does not match pointer operand type!", &SI, ElTy);
Chris Lattnerd46bb6e2002-04-24 19:12:21 +0000474 visitInstruction(SI);
475}
476
Chris Lattner0e851da2002-04-18 20:37:37 +0000477
Misha Brukmanc566ca362004-03-02 00:22:19 +0000478/// verifyInstruction - Verify that an instruction is well formed.
479///
Chris Lattner069a7952002-06-25 15:56:27 +0000480void Verifier::visitInstruction(Instruction &I) {
Chris Lattner1f419252002-09-09 20:26:04 +0000481 BasicBlock *BB = I.getParent();
482 Assert1(BB, "Instruction not embedded in basic block!", &I);
Chris Lattner0e851da2002-04-18 20:37:37 +0000483
Chris Lattnerdf9779c2003-10-05 17:44:18 +0000484 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
485 for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
486 UI != UE; ++UI)
Chris Lattner37053702004-02-27 17:28:25 +0000487 Assert1(*UI != (User*)&I ||
488 !DS->dominates(&BB->getParent()->getEntryBlock(), BB),
Chris Lattnerdf9779c2003-10-05 17:44:18 +0000489 "Only PHI nodes may reference their own value!", &I);
490 }
491
492 // Check that void typed values don't have names
493 Assert1(I.getType() != Type::VoidTy || !I.hasName(),
494 "Instruction has a name, but provides a void value!", &I);
495
Chris Lattner5f126b72004-03-29 00:29:36 +0000496 // Check that the return value of the instruction is either void or a legal
497 // value type.
498 Assert1(I.getType() == Type::VoidTy || I.getType()->isFirstClassType(),
499 "Instruction returns a non-scalar type!", &I);
500
Chris Lattner0e851da2002-04-18 20:37:37 +0000501 // Check that all uses of the instruction, if they are instructions
502 // themselves, actually have parent basic blocks. If the use is not an
503 // instruction, it is an error!
Chris Lattner069a7952002-06-25 15:56:27 +0000504 for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
Chris Lattner0e851da2002-04-18 20:37:37 +0000505 UI != UE; ++UI) {
506 Assert1(isa<Instruction>(*UI), "Use of instruction is not an instruction!",
507 *UI);
Chris Lattner21ea83b2002-04-18 22:11:52 +0000508 Instruction *Used = cast<Instruction>(*UI);
509 Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
Chris Lattner069a7952002-06-25 15:56:27 +0000510 " embeded in a basic block!", &I, Used);
Chris Lattner0e851da2002-04-18 20:37:37 +0000511 }
512
Chris Lattnerdf9779c2003-10-05 17:44:18 +0000513 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
514 // Check to make sure that the "address of" an intrinsic function is never
515 // taken.
Chris Lattner9ece94b2004-03-14 03:23:54 +0000516 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
Chris Lattnerbb346d02003-05-08 03:47:33 +0000517 Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
518 "Cannot take the address of an intrinsic!", &I);
Chris Lattner9ece94b2004-03-14 03:23:54 +0000519 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
520 Assert1(OpBB->getParent() == BB->getParent(),
521 "Referring to a basic block in another function!", &I);
522 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
523 Assert1(OpArg->getParent() == BB->getParent(),
524 "Referring to an argument in another function!", &I);
525 } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
Chris Lattnerec5089a2004-01-14 04:25:59 +0000526 BasicBlock *OpBlock = Op->getParent();
Chris Lattnerec5089a2004-01-14 04:25:59 +0000527
Chris Lattnerdf9779c2003-10-05 17:44:18 +0000528 // Check that a definition dominates all of its uses.
Chris Lattnerdf9779c2003-10-05 17:44:18 +0000529 if (!isa<PHINode>(I)) {
Chris Lattner02062822004-01-14 05:42:52 +0000530 // Invoke results are only usable in the normal destination, not in the
531 // exceptional destination.
532 if (InvokeInst *II = dyn_cast<InvokeInst>(Op))
533 OpBlock = II->getNormalDest();
534
Chris Lattnerdf9779c2003-10-05 17:44:18 +0000535 // Definition must dominate use unless use is unreachable!
Chris Lattnerec5089a2004-01-14 04:25:59 +0000536 Assert2(DS->dominates(OpBlock, BB) ||
Chris Lattnerdf9779c2003-10-05 17:44:18 +0000537 !DS->dominates(&BB->getParent()->getEntryBlock(), BB),
538 "Instruction does not dominate all uses!", Op, &I);
539 } else {
540 // PHI nodes are more difficult than other nodes because they actually
541 // "use" the value in the predecessor basic blocks they correspond to.
542 BasicBlock *PredBB = cast<BasicBlock>(I.getOperand(i+1));
Chris Lattnerec5089a2004-01-14 04:25:59 +0000543 Assert2(DS->dominates(OpBlock, PredBB) ||
Chris Lattnerdf9779c2003-10-05 17:44:18 +0000544 !DS->dominates(&BB->getParent()->getEntryBlock(), PredBB),
545 "Instruction does not dominate all uses!", Op, &I);
546 }
547 }
548 }
Chris Lattnerbb346d02003-05-08 03:47:33 +0000549}
550
551/// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
Misha Brukmanc566ca362004-03-02 00:22:19 +0000552///
Brian Gaeke960707c2003-11-11 22:41:34 +0000553void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
Chris Lattnerbb346d02003-05-08 03:47:33 +0000554 Function *IF = CI.getCalledFunction();
555 const FunctionType *FT = IF->getFunctionType();
556 Assert1(IF->isExternal(), "Intrinsic functions should never be defined!", IF);
Chris Lattnerd295d992003-06-05 21:01:26 +0000557 unsigned NumArgs = 0;
Chris Lattnerbb346d02003-05-08 03:47:33 +0000558
Chris Lattnerade94102003-08-24 05:30:29 +0000559 // FIXME: this should check the return type of each intrinsic as well, also
560 // arguments!
Chris Lattnerbb346d02003-05-08 03:47:33 +0000561 switch (ID) {
Chris Lattner071a5e52004-03-13 00:24:00 +0000562 case Intrinsic::vastart:
Chris Lattnerbad4b4a2003-05-08 15:55:31 +0000563 Assert1(CI.getParent()->getParent()->getFunctionType()->isVarArg(),
564 "llvm.va_start intrinsic may only occur in function with variable"
565 " args!", &CI);
Chris Lattner5b337482003-10-18 05:57:43 +0000566 NumArgs = 0;
Chris Lattnerbb346d02003-05-08 03:47:33 +0000567 break;
Chris Lattner071a5e52004-03-13 00:24:00 +0000568 case Intrinsic::vaend: NumArgs = 1; break;
569 case Intrinsic::vacopy: NumArgs = 1; break;
Chris Lattnerade94102003-08-24 05:30:29 +0000570
Chris Lattnerdc632112004-02-14 02:47:17 +0000571 case Intrinsic::returnaddress:
572 case Intrinsic::frameaddress:
573 Assert1(isa<PointerType>(FT->getReturnType()),
574 "llvm.(frame|return)address must return pointers", IF);
575 Assert1(FT->getNumParams() == 1 && isa<ConstantInt>(CI.getOperand(1)),
576 "llvm.(frame|return)address require a single constant integer argument",
577 &CI);
578 NumArgs = 1;
579 break;
580
Brian Gaeke960707c2003-11-11 22:41:34 +0000581 case Intrinsic::setjmp: NumArgs = 1; break;
582 case Intrinsic::longjmp: NumArgs = 2; break;
583 case Intrinsic::sigsetjmp: NumArgs = 2; break;
584 case Intrinsic::siglongjmp: NumArgs = 2; break;
Chris Lattner3d903f02004-01-05 05:36:30 +0000585
586 case Intrinsic::dbg_stoppoint: NumArgs = 4; break;
587 case Intrinsic::dbg_region_start:NumArgs = 1; break;
588 case Intrinsic::dbg_region_end: NumArgs = 1; break;
589 case Intrinsic::dbg_func_start: NumArgs = 1; break;
Chris Lattner59f1ef42004-01-06 05:33:02 +0000590 case Intrinsic::dbg_declare: NumArgs = 1; break;
Chris Lattner17d028d2004-02-12 17:01:09 +0000591
592 case Intrinsic::memcpy: NumArgs = 4; break;
Chris Lattner5ed171e2004-02-12 18:11:20 +0000593 case Intrinsic::memmove: NumArgs = 4; break;
Chris Lattnerdc632112004-02-14 02:47:17 +0000594 case Intrinsic::memset: NumArgs = 4; break;
Chris Lattner60104f02003-07-28 21:20:57 +0000595
Brian Gaeke960707c2003-11-11 22:41:34 +0000596 case Intrinsic::alpha_ctlz: NumArgs = 1; break;
597 case Intrinsic::alpha_cttz: NumArgs = 1; break;
598 case Intrinsic::alpha_ctpop: NumArgs = 1; break;
599 case Intrinsic::alpha_umulh: NumArgs = 2; break;
600 case Intrinsic::alpha_vecop: NumArgs = 4; break;
601 case Intrinsic::alpha_pup: NumArgs = 3; break;
602 case Intrinsic::alpha_bytezap: NumArgs = 2; break;
603 case Intrinsic::alpha_bytemanip: NumArgs = 3; break;
604 case Intrinsic::alpha_dfpbop: NumArgs = 3; break;
605 case Intrinsic::alpha_dfpuop: NumArgs = 2; break;
606 case Intrinsic::alpha_unordered: NumArgs = 2; break;
607 case Intrinsic::alpha_uqtodfp: NumArgs = 2; break;
608 case Intrinsic::alpha_uqtosfp: NumArgs = 2; break;
609 case Intrinsic::alpha_dfptosq: NumArgs = 2; break;
610 case Intrinsic::alpha_sfptosq: NumArgs = 2; break;
Chris Lattner60104f02003-07-28 21:20:57 +0000611
Brian Gaeke960707c2003-11-11 22:41:34 +0000612 case Intrinsic::not_intrinsic:
Chris Lattnerbb346d02003-05-08 03:47:33 +0000613 assert(0 && "Invalid intrinsic!"); NumArgs = 0; break;
614 }
615
616 Assert1(FT->getNumParams() == NumArgs || (FT->getNumParams() < NumArgs &&
617 FT->isVarArg()),
618 "Illegal # arguments for intrinsic function!", IF);
Chris Lattner0e851da2002-04-18 20:37:37 +0000619}
620
621
622//===----------------------------------------------------------------------===//
623// Implement the public interfaces to this file...
624//===----------------------------------------------------------------------===//
625
Chris Lattner189d19f2003-11-21 20:23:48 +0000626FunctionPass *llvm::createVerifierPass() {
Chris Lattner0e851da2002-04-18 20:37:37 +0000627 return new Verifier();
628}
629
Chris Lattner8e72d6f2002-08-02 17:37:08 +0000630
631// verifyFunction - Create
Chris Lattner189d19f2003-11-21 20:23:48 +0000632bool llvm::verifyFunction(const Function &f) {
Chris Lattnerb870ca72004-03-14 03:16:15 +0000633 Function &F = const_cast<Function&>(f);
Chris Lattner8e72d6f2002-08-02 17:37:08 +0000634 assert(!F.isExternal() && "Cannot verify external functions");
Chris Lattnerb870ca72004-03-14 03:16:15 +0000635
636 FunctionPassManager FPM(new ExistingModuleProvider(F.getParent()));
637 Verifier *V = new Verifier();
638 FPM.add(V);
639 FPM.run(F);
640 return V->Broken;
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000641}
642
Misha Brukmanc566ca362004-03-02 00:22:19 +0000643/// verifyModule - Check a module for errors, printing messages on stderr.
644/// Return true if the module is corrupt.
645///
Chris Lattner189d19f2003-11-21 20:23:48 +0000646bool llvm::verifyModule(const Module &M) {
Chris Lattner8e72d6f2002-08-02 17:37:08 +0000647 PassManager PM;
648 Verifier *V = new Verifier();
649 PM.add(V);
650 PM.run((Module&)M);
651 return V->Broken;
Chris Lattner2f7c9632001-06-06 20:29:01 +0000652}