1 //===-- Verifier.cpp - Implement the Module Verifier -------------*- C++ -*-==//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the function verifier interface, that can be used for some
11 // sanity checking of input to the system.
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.
16 // * Both of a binary operator's parameters are of the same type
17 // * Verify that the indices of mem access instructions match other operands
18 // * Verify that arithmetic and other things are only performed on first-class
19 // types. Verify that shifts & logicals only happen on integrals f.e.
20 // * All of the constants in a switch statement are of the correct type
21 // * The code is in valid SSA form
22 // * It should be illegal to put a label into any other type (like a structure)
23 // or to return one. [except constant arrays!]
24 // * Only phi nodes can be self referential: 'add i32 %0, %0 ; <int>:0' is bad
25 // * PHI nodes must have an entry for each predecessor, with no extras.
26 // * PHI nodes must be the first thing in a basic block, all grouped together
27 // * PHI nodes must have at least one entry
28 // * All basic blocks should only end with terminator insts, not contain them
29 // * The entry node to a function must not have predecessors
30 // * All Instructions must be embedded into a basic block
31 // * Functions cannot take a void-typed parameter
32 // * Verify that a function's argument list agrees with it's declared type.
33 // * It is illegal to specify a name for a void value.
34 // * It is illegal to have a internal global value with no initializer
35 // * It is illegal to have a ret instruction that returns a value that does not
36 // agree with the function return value type.
37 // * Function call argument types match the function prototype
38 // * All other things that are tested by asserts spread about the code...
40 //===----------------------------------------------------------------------===//
42 #include "llvm/Analysis/Verifier.h"
43 #include "llvm/CallingConv.h"
44 #include "llvm/Constants.h"
45 #include "llvm/DerivedTypes.h"
46 #include "llvm/InlineAsm.h"
47 #include "llvm/IntrinsicInst.h"
48 #include "llvm/Metadata.h"
49 #include "llvm/Module.h"
50 #include "llvm/ModuleProvider.h"
51 #include "llvm/Pass.h"
52 #include "llvm/PassManager.h"
53 #include "llvm/TypeSymbolTable.h"
54 #include "llvm/Analysis/Dominators.h"
55 #include "llvm/Assembly/Writer.h"
56 #include "llvm/CodeGen/ValueTypes.h"
57 #include "llvm/Support/CallSite.h"
58 #include "llvm/Support/CFG.h"
59 #include "llvm/Support/InstVisitor.h"
60 #include "llvm/ADT/SetVector.h"
61 #include "llvm/ADT/SmallPtrSet.h"
62 #include "llvm/ADT/SmallVector.h"
63 #include "llvm/ADT/StringExtras.h"
64 #include "llvm/ADT/STLExtras.h"
65 #include "llvm/Support/Compiler.h"
66 #include "llvm/Support/ErrorHandling.h"
67 #include "llvm/Support/raw_ostream.h"
72 namespace { // Anonymous namespace for class
73 struct VISIBILITY_HIDDEN PreVerifier : public FunctionPass {
74 static char ID; // Pass ID, replacement for typeid
76 PreVerifier() : FunctionPass(&ID) { }
78 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
82 // Check that the prerequisites for successful DominatorTree construction
84 bool runOnFunction(Function &F) {
87 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I) {
88 if (I->empty() || !I->back().isTerminator()) {
89 errs() << "Basic Block does not have terminator!\n";
90 WriteAsOperand(errs(), I, true);
97 llvm_report_error("Broken module, no Basic Block terminator!");
104 char PreVerifier::ID = 0;
105 static RegisterPass<PreVerifier>
106 PreVer("preverify", "Preliminary module verification");
107 static const PassInfo *const PreVerifyID = &PreVer;
110 class TypeSet : public AbstractTypeUser {
114 /// Insert a type into the set of types.
115 bool insert(const Type *Ty) {
116 if (!Types.insert(Ty))
118 if (Ty->isAbstract())
119 Ty->addAbstractTypeUser(this);
123 // Remove ourselves as abstract type listeners for any types that remain
124 // abstract when the TypeSet is destroyed.
126 for (SmallSetVector<const Type *, 16>::iterator I = Types.begin(),
127 E = Types.end(); I != E; ++I) {
129 if (Ty->isAbstract())
130 Ty->removeAbstractTypeUser(this);
134 // Abstract type user interface.
136 /// Remove types from the set when refined. Do not insert the type it was
137 /// refined to because that type hasn't been verified yet.
138 void refineAbstractType(const DerivedType *OldTy, const Type *NewTy) {
140 OldTy->removeAbstractTypeUser(this);
143 /// Stop listening for changes to a type which is no longer abstract.
144 void typeBecameConcrete(const DerivedType *AbsTy) {
145 AbsTy->removeAbstractTypeUser(this);
151 SmallSetVector<const Type *, 16> Types;
154 TypeSet(const TypeSet &);
155 TypeSet &operator=(const TypeSet &);
158 struct Verifier : public FunctionPass, public InstVisitor<Verifier> {
159 static char ID; // Pass ID, replacement for typeid
160 bool Broken; // Is this module found to be broken?
161 bool RealPass; // Are we not being run by a PassManager?
162 VerifierFailureAction action;
163 // What to do if verification fails.
164 Module *Mod; // Module we are verifying right now
165 DominatorTree *DT; // Dominator Tree, caution can be null!
167 std::string Messages;
168 raw_string_ostream MessagesStr;
170 /// InstInThisBlock - when verifying a basic block, keep track of all of the
171 /// instructions we have seen so far. This allows us to do efficient
172 /// dominance checks for the case when an instruction has an operand that is
173 /// an instruction in the same block.
174 SmallPtrSet<Instruction*, 16> InstsInThisBlock;
176 /// Types - keep track of the types that have been checked already.
181 Broken(false), RealPass(true), action(AbortProcessAction),
182 DT(0), MessagesStr(Messages) {}
183 explicit Verifier(VerifierFailureAction ctn)
185 Broken(false), RealPass(true), action(ctn), DT(0),
186 MessagesStr(Messages) {}
187 explicit Verifier(bool AB)
189 Broken(false), RealPass(true),
190 action( AB ? AbortProcessAction : PrintMessageAction), DT(0),
191 MessagesStr(Messages) {}
192 explicit Verifier(DominatorTree &dt)
194 Broken(false), RealPass(false), action(PrintMessageAction),
195 DT(&dt), MessagesStr(Messages) {}
198 bool doInitialization(Module &M) {
200 verifyTypeSymbolTable(M.getTypeSymbolTable());
202 // If this is a real pass, in a pass manager, we must abort before
203 // returning back to the pass manager, or else the pass manager may try to
204 // run other passes on the broken module.
206 return abortIfBroken();
210 bool runOnFunction(Function &F) {
211 // Get dominator information if we are being run by PassManager
212 if (RealPass) DT = &getAnalysis<DominatorTree>();
217 InstsInThisBlock.clear();
219 // If this is a real pass, in a pass manager, we must abort before
220 // returning back to the pass manager, or else the pass manager may try to
221 // run other passes on the broken module.
223 return abortIfBroken();
228 bool doFinalization(Module &M) {
229 // Scan through, checking all of the external function's linkage now...
230 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
231 visitGlobalValue(*I);
233 // Check to make sure function prototypes are okay.
234 if (I->isDeclaration()) visitFunction(*I);
237 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
239 visitGlobalVariable(*I);
241 for (Module::alias_iterator I = M.alias_begin(), E = M.alias_end();
243 visitGlobalAlias(*I);
245 // If the module is broken, abort at this time.
246 return abortIfBroken();
249 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
250 AU.setPreservesAll();
251 AU.addRequiredID(PreVerifyID);
253 AU.addRequired<DominatorTree>();
256 /// abortIfBroken - If the module is broken and we are supposed to abort on
257 /// this condition, do so.
259 bool abortIfBroken() {
260 if (!Broken) return false;
261 MessagesStr << "Broken module found, ";
263 default: llvm_unreachable("Unknown action");
264 case AbortProcessAction:
265 MessagesStr << "compilation aborted!\n";
266 errs() << MessagesStr.str();
267 // Client should choose different reaction if abort is not desired
269 case PrintMessageAction:
270 MessagesStr << "verification continues.\n";
271 errs() << MessagesStr.str();
273 case ReturnStatusAction:
274 MessagesStr << "compilation terminated.\n";
280 // Verification methods...
281 void verifyTypeSymbolTable(TypeSymbolTable &ST);
282 void visitGlobalValue(GlobalValue &GV);
283 void visitGlobalVariable(GlobalVariable &GV);
284 void visitGlobalAlias(GlobalAlias &GA);
285 void visitFunction(Function &F);
286 void visitBasicBlock(BasicBlock &BB);
287 using InstVisitor<Verifier>::visit;
289 void visit(Instruction &I);
291 void visitTruncInst(TruncInst &I);
292 void visitZExtInst(ZExtInst &I);
293 void visitSExtInst(SExtInst &I);
294 void visitFPTruncInst(FPTruncInst &I);
295 void visitFPExtInst(FPExtInst &I);
296 void visitFPToUIInst(FPToUIInst &I);
297 void visitFPToSIInst(FPToSIInst &I);
298 void visitUIToFPInst(UIToFPInst &I);
299 void visitSIToFPInst(SIToFPInst &I);
300 void visitIntToPtrInst(IntToPtrInst &I);
301 void visitPtrToIntInst(PtrToIntInst &I);
302 void visitBitCastInst(BitCastInst &I);
303 void visitPHINode(PHINode &PN);
304 void visitBinaryOperator(BinaryOperator &B);
305 void visitICmpInst(ICmpInst &IC);
306 void visitFCmpInst(FCmpInst &FC);
307 void visitExtractElementInst(ExtractElementInst &EI);
308 void visitInsertElementInst(InsertElementInst &EI);
309 void visitShuffleVectorInst(ShuffleVectorInst &EI);
310 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
311 void visitCallInst(CallInst &CI);
312 void visitInvokeInst(InvokeInst &II);
313 void visitGetElementPtrInst(GetElementPtrInst &GEP);
314 void visitLoadInst(LoadInst &LI);
315 void visitStoreInst(StoreInst &SI);
316 void visitInstruction(Instruction &I);
317 void visitTerminatorInst(TerminatorInst &I);
318 void visitReturnInst(ReturnInst &RI);
319 void visitSwitchInst(SwitchInst &SI);
320 void visitSelectInst(SelectInst &SI);
321 void visitUserOp1(Instruction &I);
322 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
323 void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
324 void visitAllocationInst(AllocationInst &AI);
325 void visitExtractValueInst(ExtractValueInst &EVI);
326 void visitInsertValueInst(InsertValueInst &IVI);
328 void VerifyCallSite(CallSite CS);
329 bool PerformTypeCheck(Intrinsic::ID ID, Function *F, const Type *Ty,
330 int VT, unsigned ArgNo, std::string &Suffix);
331 void VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F,
332 unsigned RetNum, unsigned ParamNum, ...);
333 void VerifyParameterAttrs(Attributes Attrs, const Type *Ty,
334 bool isReturnValue, const Value *V);
335 void VerifyFunctionAttrs(const FunctionType *FT, const AttrListPtr &Attrs,
337 void VerifyType(const Type *Ty);
339 void WriteValue(const Value *V) {
341 if (isa<Instruction>(V)) {
344 WriteAsOperand(MessagesStr, V, true, Mod);
349 void WriteType(const Type *T) {
352 WriteTypeSymbolic(MessagesStr, T, Mod);
356 // CheckFailed - A check failed, so print out the condition and the message
357 // that failed. This provides a nice place to put a breakpoint if you want
358 // to see why something is not correct.
359 void CheckFailed(const Twine &Message,
360 const Value *V1 = 0, const Value *V2 = 0,
361 const Value *V3 = 0, const Value *V4 = 0) {
362 MessagesStr << Message.str() << "\n";
370 void CheckFailed(const Twine &Message, const Value *V1,
371 const Type *T2, const Value *V3 = 0) {
372 MessagesStr << Message.str() << "\n";
379 void CheckFailed(const Twine &Message, const Type *T1,
380 const Type *T2 = 0, const Type *T3 = 0) {
381 MessagesStr << Message.str() << "\n";
388 } // End anonymous namespace
390 char Verifier::ID = 0;
391 static RegisterPass<Verifier> X("verify", "Module Verifier");
393 // Assert - We know that cond should be true, if not print an error message.
394 #define Assert(C, M) \
395 do { if (!(C)) { CheckFailed(M); return; } } while (0)
396 #define Assert1(C, M, V1) \
397 do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
398 #define Assert2(C, M, V1, V2) \
399 do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
400 #define Assert3(C, M, V1, V2, V3) \
401 do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
402 #define Assert4(C, M, V1, V2, V3, V4) \
403 do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
405 void Verifier::visit(Instruction &I) {
406 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
407 Assert1(I.getOperand(i) != 0, "Operand is null", &I);
408 InstVisitor<Verifier>::visit(I);
412 void Verifier::visitGlobalValue(GlobalValue &GV) {
413 Assert1(!GV.isDeclaration() ||
414 GV.hasExternalLinkage() ||
415 GV.hasDLLImportLinkage() ||
416 GV.hasExternalWeakLinkage() ||
417 GV.hasGhostLinkage() ||
418 (isa<GlobalAlias>(GV) &&
419 (GV.hasLocalLinkage() || GV.hasWeakLinkage())),
420 "Global is external, but doesn't have external or dllimport or weak linkage!",
423 Assert1(!GV.hasDLLImportLinkage() || GV.isDeclaration(),
424 "Global is marked as dllimport, but not external", &GV);
426 Assert1(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
427 "Only global variables can have appending linkage!", &GV);
429 if (GV.hasAppendingLinkage()) {
430 GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
431 Assert1(GVar && isa<ArrayType>(GVar->getType()->getElementType()),
432 "Only global arrays can have appending linkage!", GVar);
436 void Verifier::visitGlobalVariable(GlobalVariable &GV) {
437 if (GV.hasInitializer()) {
438 Assert1(GV.getInitializer()->getType() == GV.getType()->getElementType(),
439 "Global variable initializer type does not match global "
440 "variable type!", &GV);
442 // If the global has common linkage, it must have a zero initializer and
443 // cannot be constant.
444 if (GV.hasCommonLinkage()) {
445 Assert1(GV.getInitializer()->isNullValue(),
446 "'common' global must have a zero initializer!", &GV);
447 Assert1(!GV.isConstant(), "'common' global may not be marked constant!",
451 Assert1(GV.hasExternalLinkage() || GV.hasDLLImportLinkage() ||
452 GV.hasExternalWeakLinkage(),
453 "invalid linkage type for global declaration", &GV);
456 visitGlobalValue(GV);
459 void Verifier::visitGlobalAlias(GlobalAlias &GA) {
460 Assert1(!GA.getName().empty(),
461 "Alias name cannot be empty!", &GA);
462 Assert1(GA.hasExternalLinkage() || GA.hasLocalLinkage() ||
464 "Alias should have external or external weak linkage!", &GA);
465 Assert1(GA.getAliasee(),
466 "Aliasee cannot be NULL!", &GA);
467 Assert1(GA.getType() == GA.getAliasee()->getType(),
468 "Alias and aliasee types should match!", &GA);
470 if (!isa<GlobalValue>(GA.getAliasee())) {
471 const ConstantExpr *CE = dyn_cast<ConstantExpr>(GA.getAliasee());
473 (CE->getOpcode() == Instruction::BitCast ||
474 CE->getOpcode() == Instruction::GetElementPtr) &&
475 isa<GlobalValue>(CE->getOperand(0)),
476 "Aliasee should be either GlobalValue or bitcast of GlobalValue",
480 const GlobalValue* Aliasee = GA.resolveAliasedGlobal(/*stopOnWeak*/ false);
482 "Aliasing chain should end with function or global variable", &GA);
484 visitGlobalValue(GA);
487 void Verifier::verifyTypeSymbolTable(TypeSymbolTable &ST) {
488 for (TypeSymbolTable::iterator I = ST.begin(), E = ST.end(); I != E; ++I)
489 VerifyType(I->second);
492 // VerifyParameterAttrs - Check the given attributes for an argument or return
493 // value of the specified type. The value V is printed in error messages.
494 void Verifier::VerifyParameterAttrs(Attributes Attrs, const Type *Ty,
495 bool isReturnValue, const Value *V) {
496 if (Attrs == Attribute::None)
499 Attributes FnCheckAttr = Attrs & Attribute::FunctionOnly;
500 Assert1(!FnCheckAttr, "Attribute " + Attribute::getAsString(FnCheckAttr) +
501 " only applies to the function!", V);
504 Attributes RetI = Attrs & Attribute::ParameterOnly;
505 Assert1(!RetI, "Attribute " + Attribute::getAsString(RetI) +
506 " does not apply to return values!", V);
510 i < array_lengthof(Attribute::MutuallyIncompatible); ++i) {
511 Attributes MutI = Attrs & Attribute::MutuallyIncompatible[i];
512 Assert1(!(MutI & (MutI - 1)), "Attributes " +
513 Attribute::getAsString(MutI) + " are incompatible!", V);
516 Attributes TypeI = Attrs & Attribute::typeIncompatible(Ty);
517 Assert1(!TypeI, "Wrong type for attribute " +
518 Attribute::getAsString(TypeI), V);
520 Attributes ByValI = Attrs & Attribute::ByVal;
521 if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
522 Assert1(!ByValI || PTy->getElementType()->isSized(),
523 "Attribute " + Attribute::getAsString(ByValI) +
524 " does not support unsized types!", V);
527 "Attribute " + Attribute::getAsString(ByValI) +
528 " only applies to parameters with pointer type!", V);
532 // VerifyFunctionAttrs - Check parameter attributes against a function type.
533 // The value V is printed in error messages.
534 void Verifier::VerifyFunctionAttrs(const FunctionType *FT,
535 const AttrListPtr &Attrs,
540 bool SawNest = false;
542 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
543 const AttributeWithIndex &Attr = Attrs.getSlot(i);
547 Ty = FT->getReturnType();
548 else if (Attr.Index-1 < FT->getNumParams())
549 Ty = FT->getParamType(Attr.Index-1);
551 break; // VarArgs attributes, verified elsewhere.
553 VerifyParameterAttrs(Attr.Attrs, Ty, Attr.Index == 0, V);
555 if (Attr.Attrs & Attribute::Nest) {
556 Assert1(!SawNest, "More than one parameter has attribute nest!", V);
560 if (Attr.Attrs & Attribute::StructRet)
561 Assert1(Attr.Index == 1, "Attribute sret not on first parameter!", V);
564 Attributes FAttrs = Attrs.getFnAttributes();
565 Attributes NotFn = FAttrs & (~Attribute::FunctionOnly);
566 Assert1(!NotFn, "Attribute " + Attribute::getAsString(NotFn) +
567 " does not apply to the function!", V);
570 i < array_lengthof(Attribute::MutuallyIncompatible); ++i) {
571 Attributes MutI = FAttrs & Attribute::MutuallyIncompatible[i];
572 Assert1(!(MutI & (MutI - 1)), "Attributes " +
573 Attribute::getAsString(MutI) + " are incompatible!", V);
577 static bool VerifyAttributeCount(const AttrListPtr &Attrs, unsigned Params) {
581 unsigned LastSlot = Attrs.getNumSlots() - 1;
582 unsigned LastIndex = Attrs.getSlot(LastSlot).Index;
583 if (LastIndex <= Params
584 || (LastIndex == (unsigned)~0
585 && (LastSlot == 0 || Attrs.getSlot(LastSlot - 1).Index <= Params)))
591 // visitFunction - Verify that a function is ok.
593 void Verifier::visitFunction(Function &F) {
594 // Check function arguments.
595 const FunctionType *FT = F.getFunctionType();
596 unsigned NumArgs = F.arg_size();
598 Assert1(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
599 Assert2(FT->getNumParams() == NumArgs,
600 "# formal arguments must match # of arguments for function type!",
602 Assert1(F.getReturnType()->isFirstClassType() ||
603 F.getReturnType()->isVoidTy() ||
604 isa<StructType>(F.getReturnType()),
605 "Functions cannot return aggregate values!", &F);
607 Assert1(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
608 "Invalid struct return type!", &F);
610 const AttrListPtr &Attrs = F.getAttributes();
612 Assert1(VerifyAttributeCount(Attrs, FT->getNumParams()),
613 "Attributes after last parameter!", &F);
615 // Check function attributes.
616 VerifyFunctionAttrs(FT, Attrs, &F);
618 // Check that this function meets the restrictions on this calling convention.
619 switch (F.getCallingConv()) {
624 case CallingConv::Fast:
625 case CallingConv::Cold:
626 case CallingConv::X86_FastCall:
627 Assert1(!F.isVarArg(),
628 "Varargs functions must have C calling conventions!", &F);
632 bool isLLVMdotName = F.getName().size() >= 5 &&
633 F.getName().substr(0, 5) == "llvm.";
635 // Check that the argument values match the function type for this function...
637 for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end();
639 Assert2(I->getType() == FT->getParamType(i),
640 "Argument value does not match function argument type!",
641 I, FT->getParamType(i));
642 Assert1(I->getType()->isFirstClassType(),
643 "Function arguments must have first-class types!", I);
645 Assert2(!I->getType()->isMetadataTy(),
646 "Function takes metadata but isn't an intrinsic", I, &F);
649 if (F.isDeclaration()) {
650 Assert1(F.hasExternalLinkage() || F.hasDLLImportLinkage() ||
651 F.hasExternalWeakLinkage() || F.hasGhostLinkage(),
652 "invalid linkage type for function declaration", &F);
654 // Verify that this function (which has a body) is not named "llvm.*". It
655 // is not legal to define intrinsics.
656 Assert1(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
658 // Check the entry node
659 BasicBlock *Entry = &F.getEntryBlock();
660 Assert1(pred_begin(Entry) == pred_end(Entry),
661 "Entry block to function must not have predecessors!", Entry);
664 // If this function is actually an intrinsic, verify that it is only used in
665 // direct call/invokes, never having its "address taken".
666 if (F.getIntrinsicID()) {
667 for (Value::use_iterator UI = F.use_begin(), E = F.use_end(); UI != E;++UI){
668 User *U = cast<User>(UI);
669 if ((isa<CallInst>(U) || isa<InvokeInst>(U)) && UI.getOperandNo() == 0)
670 continue; // Direct calls/invokes are ok.
672 Assert1(0, "Invalid user of intrinsic instruction!", U);
677 // verifyBasicBlock - Verify that a basic block is well formed...
679 void Verifier::visitBasicBlock(BasicBlock &BB) {
680 InstsInThisBlock.clear();
682 // Ensure that basic blocks have terminators!
683 Assert1(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
685 // Check constraints that this basic block imposes on all of the PHI nodes in
687 if (isa<PHINode>(BB.front())) {
688 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
689 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
690 std::sort(Preds.begin(), Preds.end());
692 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
693 // Ensure that PHI nodes have at least one entry!
694 Assert1(PN->getNumIncomingValues() != 0,
695 "PHI nodes must have at least one entry. If the block is dead, "
696 "the PHI should be removed!", PN);
697 Assert1(PN->getNumIncomingValues() == Preds.size(),
698 "PHINode should have one entry for each predecessor of its "
699 "parent basic block!", PN);
701 // Get and sort all incoming values in the PHI node...
703 Values.reserve(PN->getNumIncomingValues());
704 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
705 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
706 PN->getIncomingValue(i)));
707 std::sort(Values.begin(), Values.end());
709 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
710 // Check to make sure that if there is more than one entry for a
711 // particular basic block in this PHI node, that the incoming values are
714 Assert4(i == 0 || Values[i].first != Values[i-1].first ||
715 Values[i].second == Values[i-1].second,
716 "PHI node has multiple entries for the same basic block with "
717 "different incoming values!", PN, Values[i].first,
718 Values[i].second, Values[i-1].second);
720 // Check to make sure that the predecessors and PHI node entries are
722 Assert3(Values[i].first == Preds[i],
723 "PHI node entries do not match predecessors!", PN,
724 Values[i].first, Preds[i]);
730 void Verifier::visitTerminatorInst(TerminatorInst &I) {
731 // Ensure that terminators only exist at the end of the basic block.
732 Assert1(&I == I.getParent()->getTerminator(),
733 "Terminator found in the middle of a basic block!", I.getParent());
737 void Verifier::visitReturnInst(ReturnInst &RI) {
738 Function *F = RI.getParent()->getParent();
739 unsigned N = RI.getNumOperands();
740 if (F->getReturnType()->isVoidTy())
742 "Found return instr that returns non-void in Function of void "
743 "return type!", &RI, F->getReturnType());
744 else if (N == 1 && F->getReturnType() == RI.getOperand(0)->getType()) {
745 // Exactly one return value and it matches the return type. Good.
746 } else if (const StructType *STy = dyn_cast<StructType>(F->getReturnType())) {
747 // The return type is a struct; check for multiple return values.
748 Assert2(STy->getNumElements() == N,
749 "Incorrect number of return values in ret instruction!",
750 &RI, F->getReturnType());
751 for (unsigned i = 0; i != N; ++i)
752 Assert2(STy->getElementType(i) == RI.getOperand(i)->getType(),
753 "Function return type does not match operand "
754 "type of return inst!", &RI, F->getReturnType());
755 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(F->getReturnType())) {
756 // The return type is an array; check for multiple return values.
757 Assert2(ATy->getNumElements() == N,
758 "Incorrect number of return values in ret instruction!",
759 &RI, F->getReturnType());
760 for (unsigned i = 0; i != N; ++i)
761 Assert2(ATy->getElementType() == RI.getOperand(i)->getType(),
762 "Function return type does not match operand "
763 "type of return inst!", &RI, F->getReturnType());
765 CheckFailed("Function return type does not match operand "
766 "type of return inst!", &RI, F->getReturnType());
769 // Check to make sure that the return value has necessary properties for
771 visitTerminatorInst(RI);
774 void Verifier::visitSwitchInst(SwitchInst &SI) {
775 // Check to make sure that all of the constants in the switch instruction
776 // have the same type as the switched-on value.
777 const Type *SwitchTy = SI.getCondition()->getType();
778 for (unsigned i = 1, e = SI.getNumCases(); i != e; ++i)
779 Assert1(SI.getCaseValue(i)->getType() == SwitchTy,
780 "Switch constants must all be same type as switch value!", &SI);
782 visitTerminatorInst(SI);
785 void Verifier::visitSelectInst(SelectInst &SI) {
786 Assert1(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
788 "Invalid operands for select instruction!", &SI);
790 Assert1(SI.getTrueValue()->getType() == SI.getType(),
791 "Select values must have same type as select instruction!", &SI);
792 visitInstruction(SI);
795 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
796 /// a pass, if any exist, it's an error.
798 void Verifier::visitUserOp1(Instruction &I) {
799 Assert1(0, "User-defined operators should not live outside of a pass!", &I);
802 void Verifier::visitTruncInst(TruncInst &I) {
803 // Get the source and destination types
804 const Type *SrcTy = I.getOperand(0)->getType();
805 const Type *DestTy = I.getType();
807 // Get the size of the types in bits, we'll need this later
808 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
809 unsigned DestBitSize = DestTy->getScalarSizeInBits();
811 Assert1(SrcTy->isIntOrIntVector(), "Trunc only operates on integer", &I);
812 Assert1(DestTy->isIntOrIntVector(), "Trunc only produces integer", &I);
813 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
814 "trunc source and destination must both be a vector or neither", &I);
815 Assert1(SrcBitSize > DestBitSize,"DestTy too big for Trunc", &I);
820 void Verifier::visitZExtInst(ZExtInst &I) {
821 // Get the source and destination types
822 const Type *SrcTy = I.getOperand(0)->getType();
823 const Type *DestTy = I.getType();
825 // Get the size of the types in bits, we'll need this later
826 Assert1(SrcTy->isIntOrIntVector(), "ZExt only operates on integer", &I);
827 Assert1(DestTy->isIntOrIntVector(), "ZExt only produces an integer", &I);
828 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
829 "zext source and destination must both be a vector or neither", &I);
830 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
831 unsigned DestBitSize = DestTy->getScalarSizeInBits();
833 Assert1(SrcBitSize < DestBitSize,"Type too small for ZExt", &I);
838 void Verifier::visitSExtInst(SExtInst &I) {
839 // Get the source and destination types
840 const Type *SrcTy = I.getOperand(0)->getType();
841 const Type *DestTy = I.getType();
843 // Get the size of the types in bits, we'll need this later
844 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
845 unsigned DestBitSize = DestTy->getScalarSizeInBits();
847 Assert1(SrcTy->isIntOrIntVector(), "SExt only operates on integer", &I);
848 Assert1(DestTy->isIntOrIntVector(), "SExt only produces an integer", &I);
849 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
850 "sext source and destination must both be a vector or neither", &I);
851 Assert1(SrcBitSize < DestBitSize,"Type too small for SExt", &I);
856 void Verifier::visitFPTruncInst(FPTruncInst &I) {
857 // Get the source and destination types
858 const Type *SrcTy = I.getOperand(0)->getType();
859 const Type *DestTy = I.getType();
860 // Get the size of the types in bits, we'll need this later
861 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
862 unsigned DestBitSize = DestTy->getScalarSizeInBits();
864 Assert1(SrcTy->isFPOrFPVector(),"FPTrunc only operates on FP", &I);
865 Assert1(DestTy->isFPOrFPVector(),"FPTrunc only produces an FP", &I);
866 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
867 "fptrunc source and destination must both be a vector or neither",&I);
868 Assert1(SrcBitSize > DestBitSize,"DestTy too big for FPTrunc", &I);
873 void Verifier::visitFPExtInst(FPExtInst &I) {
874 // Get the source and destination types
875 const Type *SrcTy = I.getOperand(0)->getType();
876 const Type *DestTy = I.getType();
878 // Get the size of the types in bits, we'll need this later
879 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
880 unsigned DestBitSize = DestTy->getScalarSizeInBits();
882 Assert1(SrcTy->isFPOrFPVector(),"FPExt only operates on FP", &I);
883 Assert1(DestTy->isFPOrFPVector(),"FPExt only produces an FP", &I);
884 Assert1(isa<VectorType>(SrcTy) == isa<VectorType>(DestTy),
885 "fpext source and destination must both be a vector or neither", &I);
886 Assert1(SrcBitSize < DestBitSize,"DestTy too small for FPExt", &I);
891 void Verifier::visitUIToFPInst(UIToFPInst &I) {
892 // Get the source and destination types
893 const Type *SrcTy = I.getOperand(0)->getType();
894 const Type *DestTy = I.getType();
896 bool SrcVec = isa<VectorType>(SrcTy);
897 bool DstVec = isa<VectorType>(DestTy);
899 Assert1(SrcVec == DstVec,
900 "UIToFP source and dest must both be vector or scalar", &I);
901 Assert1(SrcTy->isIntOrIntVector(),
902 "UIToFP source must be integer or integer vector", &I);
903 Assert1(DestTy->isFPOrFPVector(),
904 "UIToFP result must be FP or FP vector", &I);
906 if (SrcVec && DstVec)
907 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
908 cast<VectorType>(DestTy)->getNumElements(),
909 "UIToFP source and dest vector length mismatch", &I);
914 void Verifier::visitSIToFPInst(SIToFPInst &I) {
915 // Get the source and destination types
916 const Type *SrcTy = I.getOperand(0)->getType();
917 const Type *DestTy = I.getType();
919 bool SrcVec = isa<VectorType>(SrcTy);
920 bool DstVec = isa<VectorType>(DestTy);
922 Assert1(SrcVec == DstVec,
923 "SIToFP source and dest must both be vector or scalar", &I);
924 Assert1(SrcTy->isIntOrIntVector(),
925 "SIToFP source must be integer or integer vector", &I);
926 Assert1(DestTy->isFPOrFPVector(),
927 "SIToFP result must be FP or FP vector", &I);
929 if (SrcVec && DstVec)
930 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
931 cast<VectorType>(DestTy)->getNumElements(),
932 "SIToFP source and dest vector length mismatch", &I);
937 void Verifier::visitFPToUIInst(FPToUIInst &I) {
938 // Get the source and destination types
939 const Type *SrcTy = I.getOperand(0)->getType();
940 const Type *DestTy = I.getType();
942 bool SrcVec = isa<VectorType>(SrcTy);
943 bool DstVec = isa<VectorType>(DestTy);
945 Assert1(SrcVec == DstVec,
946 "FPToUI source and dest must both be vector or scalar", &I);
947 Assert1(SrcTy->isFPOrFPVector(), "FPToUI source must be FP or FP vector", &I);
948 Assert1(DestTy->isIntOrIntVector(),
949 "FPToUI result must be integer or integer vector", &I);
951 if (SrcVec && DstVec)
952 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
953 cast<VectorType>(DestTy)->getNumElements(),
954 "FPToUI source and dest vector length mismatch", &I);
959 void Verifier::visitFPToSIInst(FPToSIInst &I) {
960 // Get the source and destination types
961 const Type *SrcTy = I.getOperand(0)->getType();
962 const Type *DestTy = I.getType();
964 bool SrcVec = isa<VectorType>(SrcTy);
965 bool DstVec = isa<VectorType>(DestTy);
967 Assert1(SrcVec == DstVec,
968 "FPToSI source and dest must both be vector or scalar", &I);
969 Assert1(SrcTy->isFPOrFPVector(),
970 "FPToSI source must be FP or FP vector", &I);
971 Assert1(DestTy->isIntOrIntVector(),
972 "FPToSI result must be integer or integer vector", &I);
974 if (SrcVec && DstVec)
975 Assert1(cast<VectorType>(SrcTy)->getNumElements() ==
976 cast<VectorType>(DestTy)->getNumElements(),
977 "FPToSI source and dest vector length mismatch", &I);
982 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
983 // Get the source and destination types
984 const Type *SrcTy = I.getOperand(0)->getType();
985 const Type *DestTy = I.getType();
987 Assert1(isa<PointerType>(SrcTy), "PtrToInt source must be pointer", &I);
988 Assert1(DestTy->isInteger(), "PtrToInt result must be integral", &I);
993 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
994 // Get the source and destination types
995 const Type *SrcTy = I.getOperand(0)->getType();
996 const Type *DestTy = I.getType();
998 Assert1(SrcTy->isInteger(), "IntToPtr source must be an integral", &I);
999 Assert1(isa<PointerType>(DestTy), "IntToPtr result must be a pointer",&I);
1001 visitInstruction(I);
1004 void Verifier::visitBitCastInst(BitCastInst &I) {
1005 // Get the source and destination types
1006 const Type *SrcTy = I.getOperand(0)->getType();
1007 const Type *DestTy = I.getType();
1009 // Get the size of the types in bits, we'll need this later
1010 unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
1011 unsigned DestBitSize = DestTy->getPrimitiveSizeInBits();
1013 // BitCast implies a no-op cast of type only. No bits change.
1014 // However, you can't cast pointers to anything but pointers.
1015 Assert1(isa<PointerType>(DestTy) == isa<PointerType>(DestTy),
1016 "Bitcast requires both operands to be pointer or neither", &I);
1017 Assert1(SrcBitSize == DestBitSize, "Bitcast requires types of same width",&I);
1019 // Disallow aggregates.
1020 Assert1(!SrcTy->isAggregateType(),
1021 "Bitcast operand must not be aggregate", &I);
1022 Assert1(!DestTy->isAggregateType(),
1023 "Bitcast type must not be aggregate", &I);
1025 visitInstruction(I);
1028 /// visitPHINode - Ensure that a PHI node is well formed.
1030 void Verifier::visitPHINode(PHINode &PN) {
1031 // Ensure that the PHI nodes are all grouped together at the top of the block.
1032 // This can be tested by checking whether the instruction before this is
1033 // either nonexistent (because this is begin()) or is a PHI node. If not,
1034 // then there is some other instruction before a PHI.
1035 Assert2(&PN == &PN.getParent()->front() ||
1036 isa<PHINode>(--BasicBlock::iterator(&PN)),
1037 "PHI nodes not grouped at top of basic block!",
1038 &PN, PN.getParent());
1040 // Check that all of the values of the PHI node have the same type as the
1041 // result, and that the incoming blocks are really basic blocks.
1042 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
1043 Assert1(PN.getType() == PN.getIncomingValue(i)->getType(),
1044 "PHI node operands are not the same type as the result!", &PN);
1045 Assert1(isa<BasicBlock>(PN.getOperand(
1046 PHINode::getOperandNumForIncomingBlock(i))),
1047 "PHI node incoming block is not a BasicBlock!", &PN);
1050 // All other PHI node constraints are checked in the visitBasicBlock method.
1052 visitInstruction(PN);
1055 void Verifier::VerifyCallSite(CallSite CS) {
1056 Instruction *I = CS.getInstruction();
1058 Assert1(isa<PointerType>(CS.getCalledValue()->getType()),
1059 "Called function must be a pointer!", I);
1060 const PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
1062 Assert1(isa<FunctionType>(FPTy->getElementType()),
1063 "Called function is not pointer to function type!", I);
1064 const FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
1066 // Verify that the correct number of arguments are being passed
1067 if (FTy->isVarArg())
1068 Assert1(CS.arg_size() >= FTy->getNumParams(),
1069 "Called function requires more parameters than were provided!",I);
1071 Assert1(CS.arg_size() == FTy->getNumParams(),
1072 "Incorrect number of arguments passed to called function!", I);
1074 // Verify that all arguments to the call match the function type...
1075 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
1076 Assert3(CS.getArgument(i)->getType() == FTy->getParamType(i),
1077 "Call parameter type does not match function signature!",
1078 CS.getArgument(i), FTy->getParamType(i), I);
1080 const AttrListPtr &Attrs = CS.getAttributes();
1082 Assert1(VerifyAttributeCount(Attrs, CS.arg_size()),
1083 "Attributes after last parameter!", I);
1085 // Verify call attributes.
1086 VerifyFunctionAttrs(FTy, Attrs, I);
1088 if (FTy->isVarArg())
1089 // Check attributes on the varargs part.
1090 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
1091 Attributes Attr = Attrs.getParamAttributes(Idx);
1093 VerifyParameterAttrs(Attr, CS.getArgument(Idx-1)->getType(), false, I);
1095 Attributes VArgI = Attr & Attribute::VarArgsIncompatible;
1096 Assert1(!VArgI, "Attribute " + Attribute::getAsString(VArgI) +
1097 " cannot be used for vararg call arguments!", I);
1100 // Verify that there's no metadata unless it's a direct call to an intrinsic.
1101 if (!CS.getCalledFunction() || CS.getCalledFunction()->getName().size() < 5 ||
1102 CS.getCalledFunction()->getName().substr(0, 5) != "llvm.") {
1103 for (FunctionType::param_iterator PI = FTy->param_begin(),
1104 PE = FTy->param_end(); PI != PE; ++PI)
1105 Assert1(!PI->get()->isMetadataTy(),
1106 "Function has metadata parameter but isn't an intrinsic", I);
1109 visitInstruction(*I);
1112 void Verifier::visitCallInst(CallInst &CI) {
1113 VerifyCallSite(&CI);
1115 if (Function *F = CI.getCalledFunction())
1116 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
1117 visitIntrinsicFunctionCall(ID, CI);
1120 void Verifier::visitInvokeInst(InvokeInst &II) {
1121 VerifyCallSite(&II);
1124 /// visitBinaryOperator - Check that both arguments to the binary operator are
1125 /// of the same type!
1127 void Verifier::visitBinaryOperator(BinaryOperator &B) {
1128 Assert1(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
1129 "Both operands to a binary operator are not of the same type!", &B);
1131 switch (B.getOpcode()) {
1132 // Check that integer arithmetic operators are only used with
1133 // integral operands.
1134 case Instruction::Add:
1135 case Instruction::Sub:
1136 case Instruction::Mul:
1137 case Instruction::SDiv:
1138 case Instruction::UDiv:
1139 case Instruction::SRem:
1140 case Instruction::URem:
1141 Assert1(B.getType()->isIntOrIntVector(),
1142 "Integer arithmetic operators only work with integral types!", &B);
1143 Assert1(B.getType() == B.getOperand(0)->getType(),
1144 "Integer arithmetic operators must have same type "
1145 "for operands and result!", &B);
1147 // Check that floating-point arithmetic operators are only used with
1148 // floating-point operands.
1149 case Instruction::FAdd:
1150 case Instruction::FSub:
1151 case Instruction::FMul:
1152 case Instruction::FDiv:
1153 case Instruction::FRem:
1154 Assert1(B.getType()->isFPOrFPVector(),
1155 "Floating-point arithmetic operators only work with "
1156 "floating-point types!", &B);
1157 Assert1(B.getType() == B.getOperand(0)->getType(),
1158 "Floating-point arithmetic operators must have same type "
1159 "for operands and result!", &B);
1161 // Check that logical operators are only used with integral operands.
1162 case Instruction::And:
1163 case Instruction::Or:
1164 case Instruction::Xor:
1165 Assert1(B.getType()->isIntOrIntVector(),
1166 "Logical operators only work with integral types!", &B);
1167 Assert1(B.getType() == B.getOperand(0)->getType(),
1168 "Logical operators must have same type for operands and result!",
1171 case Instruction::Shl:
1172 case Instruction::LShr:
1173 case Instruction::AShr:
1174 Assert1(B.getType()->isIntOrIntVector(),
1175 "Shifts only work with integral types!", &B);
1176 Assert1(B.getType() == B.getOperand(0)->getType(),
1177 "Shift return type must be same as operands!", &B);
1180 llvm_unreachable("Unknown BinaryOperator opcode!");
1183 visitInstruction(B);
1186 void Verifier::visitICmpInst(ICmpInst& IC) {
1187 // Check that the operands are the same type
1188 const Type* Op0Ty = IC.getOperand(0)->getType();
1189 const Type* Op1Ty = IC.getOperand(1)->getType();
1190 Assert1(Op0Ty == Op1Ty,
1191 "Both operands to ICmp instruction are not of the same type!", &IC);
1192 // Check that the operands are the right type
1193 Assert1(Op0Ty->isIntOrIntVector() || isa<PointerType>(Op0Ty),
1194 "Invalid operand types for ICmp instruction", &IC);
1196 visitInstruction(IC);
1199 void Verifier::visitFCmpInst(FCmpInst& FC) {
1200 // Check that the operands are the same type
1201 const Type* Op0Ty = FC.getOperand(0)->getType();
1202 const Type* Op1Ty = FC.getOperand(1)->getType();
1203 Assert1(Op0Ty == Op1Ty,
1204 "Both operands to FCmp instruction are not of the same type!", &FC);
1205 // Check that the operands are the right type
1206 Assert1(Op0Ty->isFPOrFPVector(),
1207 "Invalid operand types for FCmp instruction", &FC);
1208 visitInstruction(FC);
1211 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
1212 Assert1(ExtractElementInst::isValidOperands(EI.getOperand(0),
1214 "Invalid extractelement operands!", &EI);
1215 visitInstruction(EI);
1218 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
1219 Assert1(InsertElementInst::isValidOperands(IE.getOperand(0),
1222 "Invalid insertelement operands!", &IE);
1223 visitInstruction(IE);
1226 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
1227 Assert1(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
1229 "Invalid shufflevector operands!", &SV);
1231 const VectorType *VTy = dyn_cast<VectorType>(SV.getOperand(0)->getType());
1232 Assert1(VTy, "Operands are not a vector type", &SV);
1234 // Check to see if Mask is valid.
1235 if (const ConstantVector *MV = dyn_cast<ConstantVector>(SV.getOperand(2))) {
1236 for (unsigned i = 0, e = MV->getNumOperands(); i != e; ++i) {
1237 if (ConstantInt* CI = dyn_cast<ConstantInt>(MV->getOperand(i))) {
1238 Assert1(!CI->uge(VTy->getNumElements()*2),
1239 "Invalid shufflevector shuffle mask!", &SV);
1241 Assert1(isa<UndefValue>(MV->getOperand(i)),
1242 "Invalid shufflevector shuffle mask!", &SV);
1246 Assert1(isa<UndefValue>(SV.getOperand(2)) ||
1247 isa<ConstantAggregateZero>(SV.getOperand(2)),
1248 "Invalid shufflevector shuffle mask!", &SV);
1251 visitInstruction(SV);
1254 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
1255 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
1257 GetElementPtrInst::getIndexedType(GEP.getOperand(0)->getType(),
1258 Idxs.begin(), Idxs.end());
1259 Assert1(ElTy, "Invalid indices for GEP pointer type!", &GEP);
1260 Assert2(isa<PointerType>(GEP.getType()) &&
1261 cast<PointerType>(GEP.getType())->getElementType() == ElTy,
1262 "GEP is not of right type for indices!", &GEP, ElTy);
1263 visitInstruction(GEP);
1266 void Verifier::visitLoadInst(LoadInst &LI) {
1267 const PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
1268 Assert1(PTy, "Load operand must be a pointer.", &LI);
1269 const Type *ElTy = PTy->getElementType();
1270 Assert2(ElTy == LI.getType(),
1271 "Load result type does not match pointer operand type!", &LI, ElTy);
1272 visitInstruction(LI);
1275 void Verifier::visitStoreInst(StoreInst &SI) {
1276 const PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
1277 Assert1(PTy, "Load operand must be a pointer.", &SI);
1278 const Type *ElTy = PTy->getElementType();
1279 Assert2(ElTy == SI.getOperand(0)->getType(),
1280 "Stored value type does not match pointer operand type!",
1282 visitInstruction(SI);
1285 void Verifier::visitAllocationInst(AllocationInst &AI) {
1286 const PointerType *PTy = AI.getType();
1287 Assert1(PTy->getAddressSpace() == 0,
1288 "Allocation instruction pointer not in the generic address space!",
1290 Assert1(PTy->getElementType()->isSized(), "Cannot allocate unsized type",
1292 visitInstruction(AI);
1295 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
1296 Assert1(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
1297 EVI.idx_begin(), EVI.idx_end()) ==
1299 "Invalid ExtractValueInst operands!", &EVI);
1301 visitInstruction(EVI);
1304 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
1305 Assert1(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
1306 IVI.idx_begin(), IVI.idx_end()) ==
1307 IVI.getOperand(1)->getType(),
1308 "Invalid InsertValueInst operands!", &IVI);
1310 visitInstruction(IVI);
1313 /// verifyInstruction - Verify that an instruction is well formed.
1315 void Verifier::visitInstruction(Instruction &I) {
1316 BasicBlock *BB = I.getParent();
1317 Assert1(BB, "Instruction not embedded in basic block!", &I);
1319 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
1320 for (Value::use_iterator UI = I.use_begin(), UE = I.use_end();
1322 Assert1(*UI != (User*)&I || !DT->isReachableFromEntry(BB),
1323 "Only PHI nodes may reference their own value!", &I);
1326 // Verify that if this is a terminator that it is at the end of the block.
1327 if (isa<TerminatorInst>(I))
1328 Assert1(BB->getTerminator() == &I, "Terminator not at end of block!", &I);
1330 // Check that void typed values don't have names
1331 Assert1(!I.getType()->isVoidTy() || !I.hasName(),
1332 "Instruction has a name, but provides a void value!", &I);
1334 // Check that the return value of the instruction is either void or a legal
1336 Assert1(I.getType()->isVoidTy() ||
1337 I.getType()->isFirstClassType(),
1338 "Instruction returns a non-scalar type!", &I);
1340 // Check that the instruction doesn't produce metadata. Calls are already
1341 // checked against the callee type.
1342 Assert1(!I.getType()->isMetadataTy() ||
1343 isa<CallInst>(I) || isa<InvokeInst>(I),
1344 "Invalid use of metadata!", &I);
1346 // Check that all uses of the instruction, if they are instructions
1347 // themselves, actually have parent basic blocks. If the use is not an
1348 // instruction, it is an error!
1349 for (User::use_iterator UI = I.use_begin(), UE = I.use_end();
1351 if (Instruction *Used = dyn_cast<Instruction>(*UI))
1352 Assert2(Used->getParent() != 0, "Instruction referencing instruction not"
1353 " embedded in a basic block!", &I, Used);
1355 CheckFailed("Use of instruction is not an instruction!", *UI);
1360 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
1361 Assert1(I.getOperand(i) != 0, "Instruction has null operand!", &I);
1363 // Check to make sure that only first-class-values are operands to
1365 if (!I.getOperand(i)->getType()->isFirstClassType()) {
1366 Assert1(0, "Instruction operands must be first-class values!", &I);
1369 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
1370 // Check to make sure that the "address of" an intrinsic function is never
1372 Assert1(!F->isIntrinsic() || (i == 0 && isa<CallInst>(I)),
1373 "Cannot take the address of an intrinsic!", &I);
1374 Assert1(F->getParent() == Mod, "Referencing function in another module!",
1376 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
1377 Assert1(OpBB->getParent() == BB->getParent(),
1378 "Referring to a basic block in another function!", &I);
1379 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
1380 Assert1(OpArg->getParent() == BB->getParent(),
1381 "Referring to an argument in another function!", &I);
1382 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
1383 Assert1(GV->getParent() == Mod, "Referencing global in another module!",
1385 } else if (Instruction *Op = dyn_cast<Instruction>(I.getOperand(i))) {
1386 BasicBlock *OpBlock = Op->getParent();
1388 // Check that a definition dominates all of its uses.
1389 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
1390 // Invoke results are only usable in the normal destination, not in the
1391 // exceptional destination.
1392 BasicBlock *NormalDest = II->getNormalDest();
1394 Assert2(NormalDest != II->getUnwindDest(),
1395 "No uses of invoke possible due to dominance structure!",
1398 // PHI nodes differ from other nodes because they actually "use" the
1399 // value in the predecessor basic blocks they correspond to.
1400 BasicBlock *UseBlock = BB;
1401 if (isa<PHINode>(I))
1402 UseBlock = dyn_cast<BasicBlock>(I.getOperand(i+1));
1403 Assert2(UseBlock, "Invoke operand is PHI node with bad incoming-BB",
1406 if (isa<PHINode>(I) && UseBlock == OpBlock) {
1407 // Special case of a phi node in the normal destination or the unwind
1409 Assert2(BB == NormalDest || !DT->isReachableFromEntry(UseBlock),
1410 "Invoke result not available in the unwind destination!",
1413 Assert2(DT->dominates(NormalDest, UseBlock) ||
1414 !DT->isReachableFromEntry(UseBlock),
1415 "Invoke result does not dominate all uses!", Op, &I);
1417 // If the normal successor of an invoke instruction has multiple
1418 // predecessors, then the normal edge from the invoke is critical,
1419 // so the invoke value can only be live if the destination block
1420 // dominates all of it's predecessors (other than the invoke).
1421 if (!NormalDest->getSinglePredecessor() &&
1422 DT->isReachableFromEntry(UseBlock))
1423 // If it is used by something non-phi, then the other case is that
1424 // 'NormalDest' dominates all of its predecessors other than the
1425 // invoke. In this case, the invoke value can still be used.
1426 for (pred_iterator PI = pred_begin(NormalDest),
1427 E = pred_end(NormalDest); PI != E; ++PI)
1428 if (*PI != II->getParent() && !DT->dominates(NormalDest, *PI) &&
1429 DT->isReachableFromEntry(*PI)) {
1430 CheckFailed("Invoke result does not dominate all uses!", Op,&I);
1434 } else if (isa<PHINode>(I)) {
1435 // PHI nodes are more difficult than other nodes because they actually
1436 // "use" the value in the predecessor basic blocks they correspond to.
1437 BasicBlock *PredBB = dyn_cast<BasicBlock>(I.getOperand(i+1));
1438 Assert2(PredBB && (DT->dominates(OpBlock, PredBB) ||
1439 !DT->isReachableFromEntry(PredBB)),
1440 "Instruction does not dominate all uses!", Op, &I);
1442 if (OpBlock == BB) {
1443 // If they are in the same basic block, make sure that the definition
1444 // comes before the use.
1445 Assert2(InstsInThisBlock.count(Op) || !DT->isReachableFromEntry(BB),
1446 "Instruction does not dominate all uses!", Op, &I);
1449 // Definition must dominate use unless use is unreachable!
1450 Assert2(InstsInThisBlock.count(Op) || DT->dominates(Op, &I) ||
1451 !DT->isReachableFromEntry(BB),
1452 "Instruction does not dominate all uses!", Op, &I);
1454 } else if (isa<InlineAsm>(I.getOperand(i))) {
1455 Assert1(i == 0 && (isa<CallInst>(I) || isa<InvokeInst>(I)),
1456 "Cannot take the address of an inline asm!", &I);
1459 InstsInThisBlock.insert(&I);
1461 VerifyType(I.getType());
1464 /// VerifyType - Verify that a type is well formed.
1466 void Verifier::VerifyType(const Type *Ty) {
1467 if (!Types.insert(Ty)) return;
1469 switch (Ty->getTypeID()) {
1470 case Type::FunctionTyID: {
1471 const FunctionType *FTy = cast<FunctionType>(Ty);
1473 const Type *RetTy = FTy->getReturnType();
1474 Assert2(FunctionType::isValidReturnType(RetTy),
1475 "Function type with invalid return type", RetTy, FTy);
1478 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) {
1479 const Type *ElTy = FTy->getParamType(i);
1480 Assert2(FunctionType::isValidArgumentType(ElTy),
1481 "Function type with invalid parameter type", ElTy, FTy);
1485 case Type::StructTyID: {
1486 const StructType *STy = cast<StructType>(Ty);
1487 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
1488 const Type *ElTy = STy->getElementType(i);
1489 Assert2(StructType::isValidElementType(ElTy),
1490 "Structure type with invalid element type", ElTy, STy);
1494 case Type::ArrayTyID: {
1495 const ArrayType *ATy = cast<ArrayType>(Ty);
1496 Assert1(ArrayType::isValidElementType(ATy->getElementType()),
1497 "Array type with invalid element type", ATy);
1498 VerifyType(ATy->getElementType());
1500 case Type::PointerTyID: {
1501 const PointerType *PTy = cast<PointerType>(Ty);
1502 Assert1(PointerType::isValidElementType(PTy->getElementType()),
1503 "Pointer type with invalid element type", PTy);
1504 VerifyType(PTy->getElementType());
1506 case Type::VectorTyID: {
1507 const VectorType *VTy = cast<VectorType>(Ty);
1508 Assert1(VectorType::isValidElementType(VTy->getElementType()),
1509 "Vector type with invalid element type", VTy);
1510 VerifyType(VTy->getElementType());
1517 // Flags used by TableGen to mark intrinsic parameters with the
1518 // LLVMExtendedElementVectorType and LLVMTruncatedElementVectorType classes.
1519 static const unsigned ExtendedElementVectorType = 0x40000000;
1520 static const unsigned TruncatedElementVectorType = 0x20000000;
1522 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
1524 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
1525 Function *IF = CI.getCalledFunction();
1526 Assert1(IF->isDeclaration(), "Intrinsic functions should never be defined!",
1529 #define GET_INTRINSIC_VERIFIER
1530 #include "llvm/Intrinsics.gen"
1531 #undef GET_INTRINSIC_VERIFIER
1536 case Intrinsic::dbg_declare: // llvm.dbg.declare
1537 if (Constant *C = dyn_cast<Constant>(CI.getOperand(1)))
1538 Assert1(C && !isa<ConstantPointerNull>(C),
1539 "invalid llvm.dbg.declare intrinsic call", &CI);
1541 case Intrinsic::memcpy:
1542 case Intrinsic::memmove:
1543 case Intrinsic::memset:
1544 Assert1(isa<ConstantInt>(CI.getOperand(4)),
1545 "alignment argument of memory intrinsics must be a constant int",
1548 case Intrinsic::gcroot:
1549 case Intrinsic::gcwrite:
1550 case Intrinsic::gcread:
1551 if (ID == Intrinsic::gcroot) {
1553 dyn_cast<AllocaInst>(CI.getOperand(1)->stripPointerCasts());
1554 Assert1(AI && isa<PointerType>(AI->getType()->getElementType()),
1555 "llvm.gcroot parameter #1 must be a pointer alloca.", &CI);
1556 Assert1(isa<Constant>(CI.getOperand(2)),
1557 "llvm.gcroot parameter #2 must be a constant.", &CI);
1560 Assert1(CI.getParent()->getParent()->hasGC(),
1561 "Enclosing function does not use GC.", &CI);
1563 case Intrinsic::init_trampoline:
1564 Assert1(isa<Function>(CI.getOperand(2)->stripPointerCasts()),
1565 "llvm.init_trampoline parameter #2 must resolve to a function.",
1568 case Intrinsic::prefetch:
1569 Assert1(isa<ConstantInt>(CI.getOperand(2)) &&
1570 isa<ConstantInt>(CI.getOperand(3)) &&
1571 cast<ConstantInt>(CI.getOperand(2))->getZExtValue() < 2 &&
1572 cast<ConstantInt>(CI.getOperand(3))->getZExtValue() < 4,
1573 "invalid arguments to llvm.prefetch",
1576 case Intrinsic::stackprotector:
1577 Assert1(isa<AllocaInst>(CI.getOperand(2)->stripPointerCasts()),
1578 "llvm.stackprotector parameter #2 must resolve to an alloca.",
1581 case Intrinsic::lifetime_start:
1582 case Intrinsic::lifetime_end:
1583 case Intrinsic::invariant_start:
1584 Assert1(isa<ConstantInt>(CI.getOperand(1)),
1585 "size argument of memory use markers must be a constant integer",
1588 case Intrinsic::invariant_end:
1589 Assert1(isa<ConstantInt>(CI.getOperand(2)),
1590 "llvm.invariant.end parameter #2 must be a constant integer", &CI);
1595 /// Produce a string to identify an intrinsic parameter or return value.
1596 /// The ArgNo value numbers the return values from 0 to NumRets-1 and the
1597 /// parameters beginning with NumRets.
1599 static std::string IntrinsicParam(unsigned ArgNo, unsigned NumRets) {
1600 if (ArgNo < NumRets) {
1602 return "Intrinsic result type";
1604 return "Intrinsic result type #" + utostr(ArgNo);
1606 return "Intrinsic parameter #" + utostr(ArgNo - NumRets);
1609 bool Verifier::PerformTypeCheck(Intrinsic::ID ID, Function *F, const Type *Ty,
1610 int VT, unsigned ArgNo, std::string &Suffix) {
1611 const FunctionType *FTy = F->getFunctionType();
1613 unsigned NumElts = 0;
1614 const Type *EltTy = Ty;
1615 const VectorType *VTy = dyn_cast<VectorType>(Ty);
1617 EltTy = VTy->getElementType();
1618 NumElts = VTy->getNumElements();
1621 const Type *RetTy = FTy->getReturnType();
1622 const StructType *ST = dyn_cast<StructType>(RetTy);
1623 unsigned NumRets = 1;
1625 NumRets = ST->getNumElements();
1630 // Check flags that indicate a type that is an integral vector type with
1631 // elements that are larger or smaller than the elements of the matched
1633 if ((Match & (ExtendedElementVectorType |
1634 TruncatedElementVectorType)) != 0) {
1635 const IntegerType *IEltTy = dyn_cast<IntegerType>(EltTy);
1636 if (!VTy || !IEltTy) {
1637 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not "
1638 "an integral vector type.", F);
1641 // Adjust the current Ty (in the opposite direction) rather than
1642 // the type being matched against.
1643 if ((Match & ExtendedElementVectorType) != 0) {
1644 if ((IEltTy->getBitWidth() & 1) != 0) {
1645 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " vector "
1646 "element bit-width is odd.", F);
1649 Ty = VectorType::getTruncatedElementVectorType(VTy);
1651 Ty = VectorType::getExtendedElementVectorType(VTy);
1652 Match &= ~(ExtendedElementVectorType | TruncatedElementVectorType);
1655 if (Match <= static_cast<int>(NumRets - 1)) {
1657 RetTy = ST->getElementType(Match);
1660 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " does not "
1661 "match return type.", F);
1665 if (Ty != FTy->getParamType(Match - NumRets)) {
1666 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " does not "
1667 "match parameter %" + utostr(Match - NumRets) + ".", F);
1671 } else if (VT == MVT::iAny) {
1672 if (!EltTy->isInteger()) {
1673 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not "
1674 "an integer type.", F);
1678 unsigned GotBits = cast<IntegerType>(EltTy)->getBitWidth();
1682 Suffix += "v" + utostr(NumElts);
1684 Suffix += "i" + utostr(GotBits);
1686 // Check some constraints on various intrinsics.
1688 default: break; // Not everything needs to be checked.
1689 case Intrinsic::bswap:
1690 if (GotBits < 16 || GotBits % 16 != 0) {
1691 CheckFailed("Intrinsic requires even byte width argument", F);
1696 } else if (VT == MVT::fAny) {
1697 if (!EltTy->isFloatingPoint()) {
1698 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not "
1699 "a floating-point type.", F);
1706 Suffix += "v" + utostr(NumElts);
1708 Suffix += EVT::getEVT(EltTy).getEVTString();
1709 } else if (VT == MVT::vAny) {
1711 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not a vector type.", F);
1714 Suffix += ".v" + utostr(NumElts) + EVT::getEVT(EltTy).getEVTString();
1715 } else if (VT == MVT::iPTR) {
1716 if (!isa<PointerType>(Ty)) {
1717 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not a "
1718 "pointer and a pointer is required.", F);
1721 } else if (VT == MVT::iPTRAny) {
1722 // Outside of TableGen, we don't distinguish iPTRAny (to any address space)
1723 // and iPTR. In the verifier, we can not distinguish which case we have so
1724 // allow either case to be legal.
1725 if (const PointerType* PTyp = dyn_cast<PointerType>(Ty)) {
1726 Suffix += ".p" + utostr(PTyp->getAddressSpace()) +
1727 EVT::getEVT(PTyp->getElementType()).getEVTString();
1729 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is not a "
1730 "pointer and a pointer is required.", F);
1733 } else if (EVT((MVT::SimpleValueType)VT).isVector()) {
1734 EVT VVT = EVT((MVT::SimpleValueType)VT);
1736 // If this is a vector argument, verify the number and type of elements.
1737 if (VVT.getVectorElementType() != EVT::getEVT(EltTy)) {
1738 CheckFailed("Intrinsic prototype has incorrect vector element type!", F);
1742 if (VVT.getVectorNumElements() != NumElts) {
1743 CheckFailed("Intrinsic prototype has incorrect number of "
1744 "vector elements!", F);
1747 } else if (EVT((MVT::SimpleValueType)VT).getTypeForEVT(Ty->getContext()) !=
1749 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is wrong!", F);
1751 } else if (EltTy != Ty) {
1752 CheckFailed(IntrinsicParam(ArgNo, NumRets) + " is a vector "
1753 "and a scalar is required.", F);
1760 /// VerifyIntrinsicPrototype - TableGen emits calls to this function into
1761 /// Intrinsics.gen. This implements a little state machine that verifies the
1762 /// prototype of intrinsics.
1763 void Verifier::VerifyIntrinsicPrototype(Intrinsic::ID ID, Function *F,
1765 unsigned ParamNum, ...) {
1767 va_start(VA, ParamNum);
1768 const FunctionType *FTy = F->getFunctionType();
1770 // For overloaded intrinsics, the Suffix of the function name must match the
1771 // types of the arguments. This variable keeps track of the expected
1772 // suffix, to be checked at the end.
1775 if (FTy->getNumParams() + FTy->isVarArg() != ParamNum) {
1776 CheckFailed("Intrinsic prototype has incorrect number of arguments!", F);
1780 const Type *Ty = FTy->getReturnType();
1781 const StructType *ST = dyn_cast<StructType>(Ty);
1783 // Verify the return types.
1784 if (ST && ST->getNumElements() != RetNum) {
1785 CheckFailed("Intrinsic prototype has incorrect number of return types!", F);
1789 for (unsigned ArgNo = 0; ArgNo < RetNum; ++ArgNo) {
1790 int VT = va_arg(VA, int); // An MVT::SimpleValueType when non-negative.
1792 if (ST) Ty = ST->getElementType(ArgNo);
1794 if (!PerformTypeCheck(ID, F, Ty, VT, ArgNo, Suffix))
1798 // Verify the parameter types.
1799 for (unsigned ArgNo = 0; ArgNo < ParamNum; ++ArgNo) {
1800 int VT = va_arg(VA, int); // An MVT::SimpleValueType when non-negative.
1802 if (VT == MVT::isVoid && ArgNo > 0) {
1803 if (!FTy->isVarArg())
1804 CheckFailed("Intrinsic prototype has no '...'!", F);
1808 if (!PerformTypeCheck(ID, F, FTy->getParamType(ArgNo), VT, ArgNo + RetNum,
1815 // For intrinsics without pointer arguments, if we computed a Suffix then the
1816 // intrinsic is overloaded and we need to make sure that the name of the
1817 // function is correct. We add the suffix to the name of the intrinsic and
1818 // compare against the given function name. If they are not the same, the
1819 // function name is invalid. This ensures that overloading of intrinsics
1820 // uses a sane and consistent naming convention. Note that intrinsics with
1821 // pointer argument may or may not be overloaded so we will check assuming it
1822 // has a suffix and not.
1823 if (!Suffix.empty()) {
1824 std::string Name(Intrinsic::getName(ID));
1825 if (Name + Suffix != F->getName()) {
1826 CheckFailed("Overloaded intrinsic has incorrect suffix: '" +
1827 F->getName().substr(Name.length()) + "'. It should be '" +
1832 // Check parameter attributes.
1833 Assert1(F->getAttributes() == Intrinsic::getAttributes(ID),
1834 "Intrinsic has wrong parameter attributes!", F);
1838 //===----------------------------------------------------------------------===//
1839 // Implement the public interfaces to this file...
1840 //===----------------------------------------------------------------------===//
1842 FunctionPass *llvm::createVerifierPass(VerifierFailureAction action) {
1843 return new Verifier(action);
1847 // verifyFunction - Create
1848 bool llvm::verifyFunction(const Function &f, VerifierFailureAction action) {
1849 Function &F = const_cast<Function&>(f);
1850 assert(!F.isDeclaration() && "Cannot verify external functions");
1852 ExistingModuleProvider MP(F.getParent());
1853 FunctionPassManager FPM(&MP);
1854 Verifier *V = new Verifier(action);
1861 /// verifyModule - Check a module for errors, printing messages on stderr.
1862 /// Return true if the module is corrupt.
1864 bool llvm::verifyModule(const Module &M, VerifierFailureAction action,
1865 std::string *ErrorInfo) {
1867 Verifier *V = new Verifier(action);
1869 PM.run(const_cast<Module&>(M));
1871 if (ErrorInfo && V->Broken)
1872 *ErrorInfo = V->MessagesStr.str();