1 //===-- Verifier.cpp - Implement the Module Verifier -----------------------==//
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 // * A landing pad is defined by a landingpad instruction, and can be jumped to
39 // only by the unwind edge of an invoke instruction.
40 // * A landingpad instruction must be the first non-PHI instruction in the
42 // * All landingpad instructions must use the same personality function with
44 // * All other things that are tested by asserts spread about the code...
46 //===----------------------------------------------------------------------===//
48 #include "llvm/IR/Verifier.h"
49 #include "llvm/ADT/STLExtras.h"
50 #include "llvm/ADT/SetVector.h"
51 #include "llvm/ADT/SmallPtrSet.h"
52 #include "llvm/ADT/SmallVector.h"
53 #include "llvm/ADT/StringExtras.h"
54 #include "llvm/IR/CFG.h"
55 #include "llvm/IR/CallSite.h"
56 #include "llvm/IR/CallingConv.h"
57 #include "llvm/IR/ConstantRange.h"
58 #include "llvm/IR/Constants.h"
59 #include "llvm/IR/DataLayout.h"
60 #include "llvm/IR/DebugInfo.h"
61 #include "llvm/IR/DerivedTypes.h"
62 #include "llvm/IR/Dominators.h"
63 #include "llvm/IR/InlineAsm.h"
64 #include "llvm/IR/InstIterator.h"
65 #include "llvm/IR/InstVisitor.h"
66 #include "llvm/IR/IntrinsicInst.h"
67 #include "llvm/IR/LLVMContext.h"
68 #include "llvm/IR/Metadata.h"
69 #include "llvm/IR/Module.h"
70 #include "llvm/IR/PassManager.h"
71 #include "llvm/IR/Statepoint.h"
72 #include "llvm/Pass.h"
73 #include "llvm/Support/CommandLine.h"
74 #include "llvm/Support/Debug.h"
75 #include "llvm/Support/ErrorHandling.h"
76 #include "llvm/Support/raw_ostream.h"
81 static cl::opt<bool> VerifyDebugInfo("verify-debug-info", cl::init(false));
84 struct VerifierSupport {
88 /// \brief Track the brokenness of the module while recursively visiting.
91 explicit VerifierSupport(raw_ostream &OS)
92 : OS(OS), M(nullptr), Broken(false) {}
95 void Write(const Value *V) {
98 if (isa<Instruction>(V)) {
101 V->printAsOperand(OS, true, M);
106 void Write(const Metadata *MD) {
109 MD->printAsOperand(OS, true, M);
113 void Write(Type *T) {
119 void Write(const Comdat *C) {
125 template <typename T1, typename... Ts>
126 void WriteTs(const T1 &V1, const Ts &... Vs) {
131 template <typename... Ts> void WriteTs() {}
134 // CheckFailed - A check failed, so print out the condition and the message
135 // that failed. This provides a nice place to put a breakpoint if you want
136 // to see why something is not correct.
137 template <typename... Ts>
138 void CheckFailed(const Twine &Message, const Ts &... Vs) {
139 OS << Message << '\n';
145 class Verifier : public InstVisitor<Verifier>, VerifierSupport {
146 friend class InstVisitor<Verifier>;
148 LLVMContext *Context;
151 /// \brief When verifying a basic block, keep track of all of the
152 /// instructions we have seen so far.
154 /// This allows us to do efficient dominance checks for the case when an
155 /// instruction has an operand that is an instruction in the same block.
156 SmallPtrSet<Instruction *, 16> InstsInThisBlock;
158 /// \brief Keep track of the metadata nodes that have been checked already.
159 SmallPtrSet<const Metadata *, 32> MDNodes;
161 /// \brief The personality function referenced by the LandingPadInsts.
162 /// All LandingPadInsts within the same function must use the same
163 /// personality function.
164 const Value *PersonalityFn;
166 /// \brief Whether we've seen a call to @llvm.frameescape in this function
170 /// Stores the count of how many objects were passed to llvm.frameescape for a
171 /// given function and the largest index passed to llvm.framerecover.
172 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
175 explicit Verifier(raw_ostream &OS = dbgs())
176 : VerifierSupport(OS), Context(nullptr), PersonalityFn(nullptr),
177 SawFrameEscape(false) {}
179 bool verify(const Function &F) {
181 Context = &M->getContext();
183 // First ensure the function is well-enough formed to compute dominance
186 OS << "Function '" << F.getName()
187 << "' does not contain an entry block!\n";
190 for (Function::const_iterator I = F.begin(), E = F.end(); I != E; ++I) {
191 if (I->empty() || !I->back().isTerminator()) {
192 OS << "Basic Block in function '" << F.getName()
193 << "' does not have terminator!\n";
194 I->printAsOperand(OS, true);
200 // Now directly compute a dominance tree. We don't rely on the pass
201 // manager to provide this as it isolates us from a potentially
202 // out-of-date dominator tree and makes it significantly more complex to
203 // run this code outside of a pass manager.
204 // FIXME: It's really gross that we have to cast away constness here.
205 DT.recalculate(const_cast<Function &>(F));
208 // FIXME: We strip const here because the inst visitor strips const.
209 visit(const_cast<Function &>(F));
210 InstsInThisBlock.clear();
211 PersonalityFn = nullptr;
212 SawFrameEscape = false;
217 bool verify(const Module &M) {
219 Context = &M.getContext();
222 // Scan through, checking all of the external function's linkage now...
223 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
224 visitGlobalValue(*I);
226 // Check to make sure function prototypes are okay.
227 if (I->isDeclaration())
231 // Now that we've visited every function, verify that we never asked to
232 // recover a frame index that wasn't escaped.
233 verifyFrameRecoverIndices();
235 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
237 visitGlobalVariable(*I);
239 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
241 visitGlobalAlias(*I);
243 for (Module::const_named_metadata_iterator I = M.named_metadata_begin(),
244 E = M.named_metadata_end();
246 visitNamedMDNode(*I);
248 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
249 visitComdat(SMEC.getValue());
252 visitModuleIdents(M);
258 // Verification methods...
259 void visitGlobalValue(const GlobalValue &GV);
260 void visitGlobalVariable(const GlobalVariable &GV);
261 void visitGlobalAlias(const GlobalAlias &GA);
262 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
263 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
264 const GlobalAlias &A, const Constant &C);
265 void visitNamedMDNode(const NamedMDNode &NMD);
266 void visitMDNode(const MDNode &MD);
267 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
268 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
269 void visitComdat(const Comdat &C);
270 void visitModuleIdents(const Module &M);
271 void visitModuleFlags(const Module &M);
272 void visitModuleFlag(const MDNode *Op,
273 DenseMap<const MDString *, const MDNode *> &SeenIDs,
274 SmallVectorImpl<const MDNode *> &Requirements);
275 void visitFunction(const Function &F);
276 void visitBasicBlock(BasicBlock &BB);
277 void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty);
279 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
280 #include "llvm/IR/Metadata.def"
282 // InstVisitor overrides...
283 using InstVisitor<Verifier>::visit;
284 void visit(Instruction &I);
286 void visitTruncInst(TruncInst &I);
287 void visitZExtInst(ZExtInst &I);
288 void visitSExtInst(SExtInst &I);
289 void visitFPTruncInst(FPTruncInst &I);
290 void visitFPExtInst(FPExtInst &I);
291 void visitFPToUIInst(FPToUIInst &I);
292 void visitFPToSIInst(FPToSIInst &I);
293 void visitUIToFPInst(UIToFPInst &I);
294 void visitSIToFPInst(SIToFPInst &I);
295 void visitIntToPtrInst(IntToPtrInst &I);
296 void visitPtrToIntInst(PtrToIntInst &I);
297 void visitBitCastInst(BitCastInst &I);
298 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
299 void visitPHINode(PHINode &PN);
300 void visitBinaryOperator(BinaryOperator &B);
301 void visitICmpInst(ICmpInst &IC);
302 void visitFCmpInst(FCmpInst &FC);
303 void visitExtractElementInst(ExtractElementInst &EI);
304 void visitInsertElementInst(InsertElementInst &EI);
305 void visitShuffleVectorInst(ShuffleVectorInst &EI);
306 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
307 void visitCallInst(CallInst &CI);
308 void visitInvokeInst(InvokeInst &II);
309 void visitGetElementPtrInst(GetElementPtrInst &GEP);
310 void visitLoadInst(LoadInst &LI);
311 void visitStoreInst(StoreInst &SI);
312 void verifyDominatesUse(Instruction &I, unsigned i);
313 void visitInstruction(Instruction &I);
314 void visitTerminatorInst(TerminatorInst &I);
315 void visitBranchInst(BranchInst &BI);
316 void visitReturnInst(ReturnInst &RI);
317 void visitSwitchInst(SwitchInst &SI);
318 void visitIndirectBrInst(IndirectBrInst &BI);
319 void visitSelectInst(SelectInst &SI);
320 void visitUserOp1(Instruction &I);
321 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
322 void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
323 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
324 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
325 void visitFenceInst(FenceInst &FI);
326 void visitAllocaInst(AllocaInst &AI);
327 void visitExtractValueInst(ExtractValueInst &EVI);
328 void visitInsertValueInst(InsertValueInst &IVI);
329 void visitLandingPadInst(LandingPadInst &LPI);
331 void VerifyCallSite(CallSite CS);
332 void verifyMustTailCall(CallInst &CI);
333 bool PerformTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
334 unsigned ArgNo, std::string &Suffix);
335 bool VerifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
336 SmallVectorImpl<Type *> &ArgTys);
337 bool VerifyIntrinsicIsVarArg(bool isVarArg,
338 ArrayRef<Intrinsic::IITDescriptor> &Infos);
339 bool VerifyAttributeCount(AttributeSet Attrs, unsigned Params);
340 void VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
342 void VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
343 bool isReturnValue, const Value *V);
344 void VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
347 void VerifyConstantExprBitcastType(const ConstantExpr *CE);
348 void VerifyStatepoint(ImmutableCallSite CS);
349 void verifyFrameRecoverIndices();
351 class DebugInfoVerifier : public VerifierSupport {
353 explicit DebugInfoVerifier(raw_ostream &OS = dbgs()) : VerifierSupport(OS) {}
355 bool verify(const Module &M) {
362 void verifyDebugInfo();
363 void processInstructions(DebugInfoFinder &Finder);
364 void processCallInst(DebugInfoFinder &Finder, const CallInst &CI);
366 } // End anonymous namespace
368 // Assert - We know that cond should be true, if not print an error message.
369 #define Assert(C, ...) \
370 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
372 void Verifier::visit(Instruction &I) {
373 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
374 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
375 InstVisitor<Verifier>::visit(I);
379 void Verifier::visitGlobalValue(const GlobalValue &GV) {
380 Assert(!GV.isDeclaration() || GV.hasExternalLinkage() ||
381 GV.hasExternalWeakLinkage(),
382 "Global is external, but doesn't have external or weak linkage!", &GV);
384 Assert(GV.getAlignment() <= Value::MaximumAlignment,
385 "huge alignment values are unsupported", &GV);
386 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
387 "Only global variables can have appending linkage!", &GV);
389 if (GV.hasAppendingLinkage()) {
390 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
391 Assert(GVar && GVar->getType()->getElementType()->isArrayTy(),
392 "Only global arrays can have appending linkage!", GVar);
396 void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
397 if (GV.hasInitializer()) {
398 Assert(GV.getInitializer()->getType() == GV.getType()->getElementType(),
399 "Global variable initializer type does not match global "
403 // If the global has common linkage, it must have a zero initializer and
404 // cannot be constant.
405 if (GV.hasCommonLinkage()) {
406 Assert(GV.getInitializer()->isNullValue(),
407 "'common' global must have a zero initializer!", &GV);
408 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
410 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
413 Assert(GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
414 "invalid linkage type for global declaration", &GV);
417 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
418 GV.getName() == "llvm.global_dtors")) {
419 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
420 "invalid linkage for intrinsic global variable", &GV);
421 // Don't worry about emitting an error for it not being an array,
422 // visitGlobalValue will complain on appending non-array.
423 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getType()->getElementType())) {
424 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
425 PointerType *FuncPtrTy =
426 FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
427 // FIXME: Reject the 2-field form in LLVM 4.0.
429 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
430 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
431 STy->getTypeAtIndex(1) == FuncPtrTy,
432 "wrong type for intrinsic global variable", &GV);
433 if (STy->getNumElements() == 3) {
434 Type *ETy = STy->getTypeAtIndex(2);
435 Assert(ETy->isPointerTy() &&
436 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
437 "wrong type for intrinsic global variable", &GV);
442 if (GV.hasName() && (GV.getName() == "llvm.used" ||
443 GV.getName() == "llvm.compiler.used")) {
444 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
445 "invalid linkage for intrinsic global variable", &GV);
446 Type *GVType = GV.getType()->getElementType();
447 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
448 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
449 Assert(PTy, "wrong type for intrinsic global variable", &GV);
450 if (GV.hasInitializer()) {
451 const Constant *Init = GV.getInitializer();
452 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
453 Assert(InitArray, "wrong initalizer for intrinsic global variable",
455 for (unsigned i = 0, e = InitArray->getNumOperands(); i != e; ++i) {
456 Value *V = Init->getOperand(i)->stripPointerCastsNoFollowAliases();
457 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
459 "invalid llvm.used member", V);
460 Assert(V->hasName(), "members of llvm.used must be named", V);
466 Assert(!GV.hasDLLImportStorageClass() ||
467 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
468 GV.hasAvailableExternallyLinkage(),
469 "Global is marked as dllimport, but not external", &GV);
471 if (!GV.hasInitializer()) {
472 visitGlobalValue(GV);
476 // Walk any aggregate initializers looking for bitcasts between address spaces
477 SmallPtrSet<const Value *, 4> Visited;
478 SmallVector<const Value *, 4> WorkStack;
479 WorkStack.push_back(cast<Value>(GV.getInitializer()));
481 while (!WorkStack.empty()) {
482 const Value *V = WorkStack.pop_back_val();
483 if (!Visited.insert(V).second)
486 if (const User *U = dyn_cast<User>(V)) {
487 WorkStack.append(U->op_begin(), U->op_end());
490 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
491 VerifyConstantExprBitcastType(CE);
497 visitGlobalValue(GV);
500 void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
501 SmallPtrSet<const GlobalAlias*, 4> Visited;
503 visitAliaseeSubExpr(Visited, GA, C);
506 void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
507 const GlobalAlias &GA, const Constant &C) {
508 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
509 Assert(!GV->isDeclaration(), "Alias must point to a definition", &GA);
511 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
512 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
514 Assert(!GA2->mayBeOverridden(), "Alias cannot point to a weak alias",
517 // Only continue verifying subexpressions of GlobalAliases.
518 // Do not recurse into global initializers.
523 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
524 VerifyConstantExprBitcastType(CE);
526 for (const Use &U : C.operands()) {
528 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
529 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
530 else if (const auto *C2 = dyn_cast<Constant>(V))
531 visitAliaseeSubExpr(Visited, GA, *C2);
535 void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
536 Assert(!GA.getName().empty(), "Alias name cannot be empty!", &GA);
537 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
538 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
539 "weak_odr, or external linkage!",
541 const Constant *Aliasee = GA.getAliasee();
542 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
543 Assert(GA.getType() == Aliasee->getType(),
544 "Alias and aliasee types should match!", &GA);
546 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
547 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
549 visitAliaseeSubExpr(GA, *Aliasee);
551 visitGlobalValue(GA);
554 void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
555 for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i) {
556 MDNode *MD = NMD.getOperand(i);
564 void Verifier::visitMDNode(const MDNode &MD) {
565 // Only visit each node once. Metadata can be mutually recursive, so this
566 // avoids infinite recursion here, as well as being an optimization.
567 if (!MDNodes.insert(&MD).second)
570 switch (MD.getMetadataID()) {
572 llvm_unreachable("Invalid MDNode subclass");
573 case Metadata::MDTupleKind:
575 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
576 case Metadata::CLASS##Kind: \
577 visit##CLASS(cast<CLASS>(MD)); \
579 #include "llvm/IR/Metadata.def"
582 for (unsigned i = 0, e = MD.getNumOperands(); i != e; ++i) {
583 Metadata *Op = MD.getOperand(i);
586 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
588 if (auto *N = dyn_cast<MDNode>(Op)) {
592 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
593 visitValueAsMetadata(*V, nullptr);
598 // Check these last, so we diagnose problems in operands first.
599 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
600 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
603 void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
604 Assert(MD.getValue(), "Expected valid value", &MD);
605 Assert(!MD.getValue()->getType()->isMetadataTy(),
606 "Unexpected metadata round-trip through values", &MD, MD.getValue());
608 auto *L = dyn_cast<LocalAsMetadata>(&MD);
612 Assert(F, "function-local metadata used outside a function", L);
614 // If this was an instruction, bb, or argument, verify that it is in the
615 // function that we expect.
616 Function *ActualF = nullptr;
617 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
618 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
619 ActualF = I->getParent()->getParent();
620 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
621 ActualF = BB->getParent();
622 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
623 ActualF = A->getParent();
624 assert(ActualF && "Unimplemented function local metadata case!");
626 Assert(ActualF == F, "function-local metadata used in wrong function", L);
629 void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
630 Metadata *MD = MDV.getMetadata();
631 if (auto *N = dyn_cast<MDNode>(MD)) {
636 // Only visit each node once. Metadata can be mutually recursive, so this
637 // avoids infinite recursion here, as well as being an optimization.
638 if (!MDNodes.insert(MD).second)
641 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
642 visitValueAsMetadata(*V, F);
645 void Verifier::visitMDLocation(const MDLocation &N) {
646 Assert(N.getScope(), "location requires a valid scope", &N);
647 if (auto *IA = N.getInlinedAt())
648 Assert(isa<MDLocation>(IA), "inlined-at should be a location", &N, IA);
651 void Verifier::visitGenericDebugNode(const GenericDebugNode &N) {
652 Assert(N.getTag(), "invalid tag", &N);
655 void Verifier::visitMDSubrange(const MDSubrange &N) {
656 Assert(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
659 void Verifier::visitMDEnumerator(const MDEnumerator &N) {
660 Assert(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
663 void Verifier::visitMDBasicType(const MDBasicType &N) {
664 Assert(N.getTag() == dwarf::DW_TAG_base_type ||
665 N.getTag() == dwarf::DW_TAG_unspecified_type,
669 void Verifier::visitMDDerivedType(const MDDerivedType &N) {
670 Assert(N.getTag() == dwarf::DW_TAG_typedef ||
671 N.getTag() == dwarf::DW_TAG_pointer_type ||
672 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
673 N.getTag() == dwarf::DW_TAG_reference_type ||
674 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
675 N.getTag() == dwarf::DW_TAG_const_type ||
676 N.getTag() == dwarf::DW_TAG_volatile_type ||
677 N.getTag() == dwarf::DW_TAG_restrict_type ||
678 N.getTag() == dwarf::DW_TAG_member ||
679 N.getTag() == dwarf::DW_TAG_inheritance ||
680 N.getTag() == dwarf::DW_TAG_friend,
684 void Verifier::visitMDCompositeType(const MDCompositeType &N) {
685 Assert(N.getTag() == dwarf::DW_TAG_array_type ||
686 N.getTag() == dwarf::DW_TAG_structure_type ||
687 N.getTag() == dwarf::DW_TAG_union_type ||
688 N.getTag() == dwarf::DW_TAG_enumeration_type ||
689 N.getTag() == dwarf::DW_TAG_subroutine_type ||
690 N.getTag() == dwarf::DW_TAG_class_type,
694 void Verifier::visitMDSubroutineType(const MDSubroutineType &N) {
695 Assert(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
698 void Verifier::visitMDFile(const MDFile &N) {
699 Assert(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
702 void Verifier::visitMDCompileUnit(const MDCompileUnit &N) {
703 Assert(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
706 void Verifier::visitMDSubprogram(const MDSubprogram &N) {
707 Assert(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
710 void Verifier::visitMDLexicalBlock(const MDLexicalBlock &N) {
711 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
714 void Verifier::visitMDLexicalBlockFile(const MDLexicalBlockFile &N) {
715 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
718 void Verifier::visitMDNamespace(const MDNamespace &N) {
719 Assert(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
722 void Verifier::visitMDTemplateTypeParameter(const MDTemplateTypeParameter &N) {
723 Assert(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
727 void Verifier::visitMDTemplateValueParameter(
728 const MDTemplateValueParameter &N) {
729 Assert(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
730 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
731 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
735 void Verifier::visitMDGlobalVariable(const MDGlobalVariable &N) {
736 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
739 void Verifier::visitMDLocalVariable(const MDLocalVariable &N) {
740 Assert(N.getTag() == dwarf::DW_TAG_auto_variable ||
741 N.getTag() == dwarf::DW_TAG_arg_variable,
745 void Verifier::visitMDExpression(const MDExpression &N) {
746 Assert(N.getTag() == dwarf::DW_TAG_expression, "invalid tag", &N);
747 Assert(N.isValid(), "invalid expression", &N);
750 void Verifier::visitMDObjCProperty(const MDObjCProperty &N) {
751 Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
754 void Verifier::visitMDImportedEntity(const MDImportedEntity &N) {
755 Assert(N.getTag() == dwarf::DW_TAG_imported_module ||
756 N.getTag() == dwarf::DW_TAG_imported_declaration,
760 void Verifier::visitComdat(const Comdat &C) {
761 // The Module is invalid if the GlobalValue has private linkage. Entities
762 // with private linkage don't have entries in the symbol table.
763 if (const GlobalValue *GV = M->getNamedValue(C.getName()))
764 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
768 void Verifier::visitModuleIdents(const Module &M) {
769 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
773 // llvm.ident takes a list of metadata entry. Each entry has only one string.
774 // Scan each llvm.ident entry and make sure that this requirement is met.
775 for (unsigned i = 0, e = Idents->getNumOperands(); i != e; ++i) {
776 const MDNode *N = Idents->getOperand(i);
777 Assert(N->getNumOperands() == 1,
778 "incorrect number of operands in llvm.ident metadata", N);
779 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
780 ("invalid value for llvm.ident metadata entry operand"
781 "(the operand should be a string)"),
786 void Verifier::visitModuleFlags(const Module &M) {
787 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
790 // Scan each flag, and track the flags and requirements.
791 DenseMap<const MDString*, const MDNode*> SeenIDs;
792 SmallVector<const MDNode*, 16> Requirements;
793 for (unsigned I = 0, E = Flags->getNumOperands(); I != E; ++I) {
794 visitModuleFlag(Flags->getOperand(I), SeenIDs, Requirements);
797 // Validate that the requirements in the module are valid.
798 for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
799 const MDNode *Requirement = Requirements[I];
800 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
801 const Metadata *ReqValue = Requirement->getOperand(1);
803 const MDNode *Op = SeenIDs.lookup(Flag);
805 CheckFailed("invalid requirement on flag, flag is not present in module",
810 if (Op->getOperand(2) != ReqValue) {
811 CheckFailed(("invalid requirement on flag, "
812 "flag does not have the required value"),
820 Verifier::visitModuleFlag(const MDNode *Op,
821 DenseMap<const MDString *, const MDNode *> &SeenIDs,
822 SmallVectorImpl<const MDNode *> &Requirements) {
823 // Each module flag should have three arguments, the merge behavior (a
824 // constant int), the flag ID (an MDString), and the value.
825 Assert(Op->getNumOperands() == 3,
826 "incorrect number of operands in module flag", Op);
827 Module::ModFlagBehavior MFB;
828 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
830 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
831 "invalid behavior operand in module flag (expected constant integer)",
834 "invalid behavior operand in module flag (unexpected constant)",
837 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
838 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
841 // Sanity check the values for behaviors with additional requirements.
844 case Module::Warning:
845 case Module::Override:
846 // These behavior types accept any value.
849 case Module::Require: {
850 // The value should itself be an MDNode with two operands, a flag ID (an
851 // MDString), and a value.
852 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
853 Assert(Value && Value->getNumOperands() == 2,
854 "invalid value for 'require' module flag (expected metadata pair)",
856 Assert(isa<MDString>(Value->getOperand(0)),
857 ("invalid value for 'require' module flag "
858 "(first value operand should be a string)"),
859 Value->getOperand(0));
861 // Append it to the list of requirements, to check once all module flags are
863 Requirements.push_back(Value);
868 case Module::AppendUnique: {
869 // These behavior types require the operand be an MDNode.
870 Assert(isa<MDNode>(Op->getOperand(2)),
871 "invalid value for 'append'-type module flag "
872 "(expected a metadata node)",
878 // Unless this is a "requires" flag, check the ID is unique.
879 if (MFB != Module::Require) {
880 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
882 "module flag identifiers must be unique (or of 'require' type)", ID);
886 void Verifier::VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
887 bool isFunction, const Value *V) {
889 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
890 if (Attrs.getSlotIndex(I) == Idx) {
895 assert(Slot != ~0U && "Attribute set inconsistency!");
897 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
899 if (I->isStringAttribute())
902 if (I->getKindAsEnum() == Attribute::NoReturn ||
903 I->getKindAsEnum() == Attribute::NoUnwind ||
904 I->getKindAsEnum() == Attribute::NoInline ||
905 I->getKindAsEnum() == Attribute::AlwaysInline ||
906 I->getKindAsEnum() == Attribute::OptimizeForSize ||
907 I->getKindAsEnum() == Attribute::StackProtect ||
908 I->getKindAsEnum() == Attribute::StackProtectReq ||
909 I->getKindAsEnum() == Attribute::StackProtectStrong ||
910 I->getKindAsEnum() == Attribute::NoRedZone ||
911 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
912 I->getKindAsEnum() == Attribute::Naked ||
913 I->getKindAsEnum() == Attribute::InlineHint ||
914 I->getKindAsEnum() == Attribute::StackAlignment ||
915 I->getKindAsEnum() == Attribute::UWTable ||
916 I->getKindAsEnum() == Attribute::NonLazyBind ||
917 I->getKindAsEnum() == Attribute::ReturnsTwice ||
918 I->getKindAsEnum() == Attribute::SanitizeAddress ||
919 I->getKindAsEnum() == Attribute::SanitizeThread ||
920 I->getKindAsEnum() == Attribute::SanitizeMemory ||
921 I->getKindAsEnum() == Attribute::MinSize ||
922 I->getKindAsEnum() == Attribute::NoDuplicate ||
923 I->getKindAsEnum() == Attribute::Builtin ||
924 I->getKindAsEnum() == Attribute::NoBuiltin ||
925 I->getKindAsEnum() == Attribute::Cold ||
926 I->getKindAsEnum() == Attribute::OptimizeNone ||
927 I->getKindAsEnum() == Attribute::JumpTable) {
929 CheckFailed("Attribute '" + I->getAsString() +
930 "' only applies to functions!", V);
933 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
934 I->getKindAsEnum() == Attribute::ReadNone) {
936 CheckFailed("Attribute '" + I->getAsString() +
937 "' does not apply to function returns");
940 } else if (isFunction) {
941 CheckFailed("Attribute '" + I->getAsString() +
942 "' does not apply to functions!", V);
948 // VerifyParameterAttrs - Check the given attributes for an argument or return
949 // value of the specified type. The value V is printed in error messages.
950 void Verifier::VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
951 bool isReturnValue, const Value *V) {
952 if (!Attrs.hasAttributes(Idx))
955 VerifyAttributeTypes(Attrs, Idx, false, V);
958 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
959 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
960 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
961 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
962 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
963 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
964 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', and "
965 "'returned' do not apply to return values!",
968 // Check for mutually incompatible attributes. Only inreg is compatible with
970 unsigned AttrCount = 0;
971 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
972 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
973 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
974 Attrs.hasAttribute(Idx, Attribute::InReg);
975 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
976 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
977 "and 'sret' are incompatible!",
980 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
981 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
983 "'inalloca and readonly' are incompatible!",
986 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
987 Attrs.hasAttribute(Idx, Attribute::Returned)),
989 "'sret and returned' are incompatible!",
992 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
993 Attrs.hasAttribute(Idx, Attribute::SExt)),
995 "'zeroext and signext' are incompatible!",
998 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
999 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1001 "'readnone and readonly' are incompatible!",
1004 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1005 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1007 "'noinline and alwaysinline' are incompatible!",
1010 Assert(!AttrBuilder(Attrs, Idx)
1011 .hasAttributes(AttributeFuncs::typeIncompatible(Ty, Idx), Idx),
1012 "Wrong types for attribute: " +
1013 AttributeFuncs::typeIncompatible(Ty, Idx).getAsString(Idx),
1016 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
1017 if (!PTy->getElementType()->isSized()) {
1018 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1019 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1020 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1024 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1025 "Attribute 'byval' only applies to parameters with pointer type!",
1030 // VerifyFunctionAttrs - Check parameter attributes against a function type.
1031 // The value V is printed in error messages.
1032 void Verifier::VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
1034 if (Attrs.isEmpty())
1037 bool SawNest = false;
1038 bool SawReturned = false;
1039 bool SawSRet = false;
1041 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
1042 unsigned Idx = Attrs.getSlotIndex(i);
1046 Ty = FT->getReturnType();
1047 else if (Idx-1 < FT->getNumParams())
1048 Ty = FT->getParamType(Idx-1);
1050 break; // VarArgs attributes, verified elsewhere.
1052 VerifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
1057 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
1058 Assert(!SawNest, "More than one parameter has attribute nest!", V);
1062 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
1063 Assert(!SawReturned, "More than one parameter has attribute returned!",
1065 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1067 "argument and return types for 'returned' attribute",
1072 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
1073 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1074 Assert(Idx == 1 || Idx == 2,
1075 "Attribute 'sret' is not on first or second parameter!", V);
1079 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
1080 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1085 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1088 VerifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
1091 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1092 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1093 "Attributes 'readnone and readonly' are incompatible!", V);
1096 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1097 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1098 Attribute::AlwaysInline)),
1099 "Attributes 'noinline and alwaysinline' are incompatible!", V);
1101 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1102 Attribute::OptimizeNone)) {
1103 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1104 "Attribute 'optnone' requires 'noinline'!", V);
1106 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1107 Attribute::OptimizeForSize),
1108 "Attributes 'optsize and optnone' are incompatible!", V);
1110 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1111 "Attributes 'minsize and optnone' are incompatible!", V);
1114 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1115 Attribute::JumpTable)) {
1116 const GlobalValue *GV = cast<GlobalValue>(V);
1117 Assert(GV->hasUnnamedAddr(),
1118 "Attribute 'jumptable' requires 'unnamed_addr'", V);
1122 void Verifier::VerifyConstantExprBitcastType(const ConstantExpr *CE) {
1123 if (CE->getOpcode() != Instruction::BitCast)
1126 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1128 "Invalid bitcast", CE);
1131 bool Verifier::VerifyAttributeCount(AttributeSet Attrs, unsigned Params) {
1132 if (Attrs.getNumSlots() == 0)
1135 unsigned LastSlot = Attrs.getNumSlots() - 1;
1136 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
1137 if (LastIndex <= Params
1138 || (LastIndex == AttributeSet::FunctionIndex
1139 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
1145 /// \brief Verify that statepoint intrinsic is well formed.
1146 void Verifier::VerifyStatepoint(ImmutableCallSite CS) {
1147 assert(CS.getCalledFunction() &&
1148 CS.getCalledFunction()->getIntrinsicID() ==
1149 Intrinsic::experimental_gc_statepoint);
1151 const Instruction &CI = *CS.getInstruction();
1153 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory(),
1154 "gc.statepoint must read and write memory to preserve "
1155 "reordering restrictions required by safepoint semantics",
1158 const Value *Target = CS.getArgument(0);
1159 const PointerType *PT = dyn_cast<PointerType>(Target->getType());
1160 Assert(PT && PT->getElementType()->isFunctionTy(),
1161 "gc.statepoint callee must be of function pointer type", &CI, Target);
1162 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
1164 const Value *NumCallArgsV = CS.getArgument(1);
1165 Assert(isa<ConstantInt>(NumCallArgsV),
1166 "gc.statepoint number of arguments to underlying call "
1167 "must be constant integer",
1169 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
1170 Assert(NumCallArgs >= 0,
1171 "gc.statepoint number of arguments to underlying call "
1174 const int NumParams = (int)TargetFuncType->getNumParams();
1175 if (TargetFuncType->isVarArg()) {
1176 Assert(NumCallArgs >= NumParams,
1177 "gc.statepoint mismatch in number of vararg call args", &CI);
1179 // TODO: Remove this limitation
1180 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1181 "gc.statepoint doesn't support wrapping non-void "
1182 "vararg functions yet",
1185 Assert(NumCallArgs == NumParams,
1186 "gc.statepoint mismatch in number of call args", &CI);
1188 const Value *Unused = CS.getArgument(2);
1189 Assert(isa<ConstantInt>(Unused) && cast<ConstantInt>(Unused)->isNullValue(),
1190 "gc.statepoint parameter #3 must be zero", &CI);
1192 // Verify that the types of the call parameter arguments match
1193 // the type of the wrapped callee.
1194 for (int i = 0; i < NumParams; i++) {
1195 Type *ParamType = TargetFuncType->getParamType(i);
1196 Type *ArgType = CS.getArgument(3+i)->getType();
1197 Assert(ArgType == ParamType,
1198 "gc.statepoint call argument does not match wrapped "
1202 const int EndCallArgsInx = 2+NumCallArgs;
1203 const Value *NumDeoptArgsV = CS.getArgument(EndCallArgsInx+1);
1204 Assert(isa<ConstantInt>(NumDeoptArgsV),
1205 "gc.statepoint number of deoptimization arguments "
1206 "must be constant integer",
1208 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
1209 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1213 Assert(4 + NumCallArgs + NumDeoptArgs <= (int)CS.arg_size(),
1214 "gc.statepoint too few arguments according to length fields", &CI);
1216 // Check that the only uses of this gc.statepoint are gc.result or
1217 // gc.relocate calls which are tied to this statepoint and thus part
1218 // of the same statepoint sequence
1219 for (const User *U : CI.users()) {
1220 const CallInst *Call = dyn_cast<const CallInst>(U);
1221 Assert(Call, "illegal use of statepoint token", &CI, U);
1222 if (!Call) continue;
1223 Assert(isGCRelocate(Call) || isGCResult(Call),
1224 "gc.result or gc.relocate are the only value uses"
1225 "of a gc.statepoint",
1227 if (isGCResult(Call)) {
1228 Assert(Call->getArgOperand(0) == &CI,
1229 "gc.result connected to wrong gc.statepoint", &CI, Call);
1230 } else if (isGCRelocate(Call)) {
1231 Assert(Call->getArgOperand(0) == &CI,
1232 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
1236 // Note: It is legal for a single derived pointer to be listed multiple
1237 // times. It's non-optimal, but it is legal. It can also happen after
1238 // insertion if we strip a bitcast away.
1239 // Note: It is really tempting to check that each base is relocated and
1240 // that a derived pointer is never reused as a base pointer. This turns
1241 // out to be problematic since optimizations run after safepoint insertion
1242 // can recognize equality properties that the insertion logic doesn't know
1243 // about. See example statepoint.ll in the verifier subdirectory
1246 void Verifier::verifyFrameRecoverIndices() {
1247 for (auto &Counts : FrameEscapeInfo) {
1248 Function *F = Counts.first;
1249 unsigned EscapedObjectCount = Counts.second.first;
1250 unsigned MaxRecoveredIndex = Counts.second.second;
1251 Assert(MaxRecoveredIndex <= EscapedObjectCount,
1252 "all indices passed to llvm.framerecover must be less than the "
1253 "number of arguments passed ot llvm.frameescape in the parent "
1259 // visitFunction - Verify that a function is ok.
1261 void Verifier::visitFunction(const Function &F) {
1262 // Check function arguments.
1263 FunctionType *FT = F.getFunctionType();
1264 unsigned NumArgs = F.arg_size();
1266 Assert(Context == &F.getContext(),
1267 "Function context does not match Module context!", &F);
1269 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1270 Assert(FT->getNumParams() == NumArgs,
1271 "# formal arguments must match # of arguments for function type!", &F,
1273 Assert(F.getReturnType()->isFirstClassType() ||
1274 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1275 "Functions cannot return aggregate values!", &F);
1277 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1278 "Invalid struct return type!", &F);
1280 AttributeSet Attrs = F.getAttributes();
1282 Assert(VerifyAttributeCount(Attrs, FT->getNumParams()),
1283 "Attribute after last parameter!", &F);
1285 // Check function attributes.
1286 VerifyFunctionAttrs(FT, Attrs, &F);
1288 // On function declarations/definitions, we do not support the builtin
1289 // attribute. We do not check this in VerifyFunctionAttrs since that is
1290 // checking for Attributes that can/can not ever be on functions.
1291 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1292 "Attribute 'builtin' can only be applied to a callsite.", &F);
1294 // Check that this function meets the restrictions on this calling convention.
1295 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1296 // restrictions can be lifted.
1297 switch (F.getCallingConv()) {
1299 case CallingConv::C:
1301 case CallingConv::Fast:
1302 case CallingConv::Cold:
1303 case CallingConv::Intel_OCL_BI:
1304 case CallingConv::PTX_Kernel:
1305 case CallingConv::PTX_Device:
1306 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1307 "perfect forwarding!",
1312 bool isLLVMdotName = F.getName().size() >= 5 &&
1313 F.getName().substr(0, 5) == "llvm.";
1315 // Check that the argument values match the function type for this function...
1317 for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E;
1319 Assert(I->getType() == FT->getParamType(i),
1320 "Argument value does not match function argument type!", I,
1321 FT->getParamType(i));
1322 Assert(I->getType()->isFirstClassType(),
1323 "Function arguments must have first-class types!", I);
1325 Assert(!I->getType()->isMetadataTy(),
1326 "Function takes metadata but isn't an intrinsic", I, &F);
1329 if (F.isMaterializable()) {
1330 // Function has a body somewhere we can't see.
1331 } else if (F.isDeclaration()) {
1332 Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1333 "invalid linkage type for function declaration", &F);
1335 // Verify that this function (which has a body) is not named "llvm.*". It
1336 // is not legal to define intrinsics.
1337 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
1339 // Check the entry node
1340 const BasicBlock *Entry = &F.getEntryBlock();
1341 Assert(pred_empty(Entry),
1342 "Entry block to function must not have predecessors!", Entry);
1344 // The address of the entry block cannot be taken, unless it is dead.
1345 if (Entry->hasAddressTaken()) {
1346 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1347 "blockaddress may not be used with the entry block!", Entry);
1351 // If this function is actually an intrinsic, verify that it is only used in
1352 // direct call/invokes, never having its "address taken".
1353 if (F.getIntrinsicID()) {
1355 if (F.hasAddressTaken(&U))
1356 Assert(0, "Invalid user of intrinsic instruction!", U);
1359 Assert(!F.hasDLLImportStorageClass() ||
1360 (F.isDeclaration() && F.hasExternalLinkage()) ||
1361 F.hasAvailableExternallyLinkage(),
1362 "Function is marked as dllimport, but not external.", &F);
1365 // verifyBasicBlock - Verify that a basic block is well formed...
1367 void Verifier::visitBasicBlock(BasicBlock &BB) {
1368 InstsInThisBlock.clear();
1370 // Ensure that basic blocks have terminators!
1371 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
1373 // Check constraints that this basic block imposes on all of the PHI nodes in
1375 if (isa<PHINode>(BB.front())) {
1376 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
1377 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
1378 std::sort(Preds.begin(), Preds.end());
1380 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
1381 // Ensure that PHI nodes have at least one entry!
1382 Assert(PN->getNumIncomingValues() != 0,
1383 "PHI nodes must have at least one entry. If the block is dead, "
1384 "the PHI should be removed!",
1386 Assert(PN->getNumIncomingValues() == Preds.size(),
1387 "PHINode should have one entry for each predecessor of its "
1388 "parent basic block!",
1391 // Get and sort all incoming values in the PHI node...
1393 Values.reserve(PN->getNumIncomingValues());
1394 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1395 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
1396 PN->getIncomingValue(i)));
1397 std::sort(Values.begin(), Values.end());
1399 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
1400 // Check to make sure that if there is more than one entry for a
1401 // particular basic block in this PHI node, that the incoming values are
1404 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
1405 Values[i].second == Values[i - 1].second,
1406 "PHI node has multiple entries for the same basic block with "
1407 "different incoming values!",
1408 PN, Values[i].first, Values[i].second, Values[i - 1].second);
1410 // Check to make sure that the predecessors and PHI node entries are
1412 Assert(Values[i].first == Preds[i],
1413 "PHI node entries do not match predecessors!", PN,
1414 Values[i].first, Preds[i]);
1419 // Check that all instructions have their parent pointers set up correctly.
1422 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
1426 void Verifier::visitTerminatorInst(TerminatorInst &I) {
1427 // Ensure that terminators only exist at the end of the basic block.
1428 Assert(&I == I.getParent()->getTerminator(),
1429 "Terminator found in the middle of a basic block!", I.getParent());
1430 visitInstruction(I);
1433 void Verifier::visitBranchInst(BranchInst &BI) {
1434 if (BI.isConditional()) {
1435 Assert(BI.getCondition()->getType()->isIntegerTy(1),
1436 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
1438 visitTerminatorInst(BI);
1441 void Verifier::visitReturnInst(ReturnInst &RI) {
1442 Function *F = RI.getParent()->getParent();
1443 unsigned N = RI.getNumOperands();
1444 if (F->getReturnType()->isVoidTy())
1446 "Found return instr that returns non-void in Function of void "
1448 &RI, F->getReturnType());
1450 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
1451 "Function return type does not match operand "
1452 "type of return inst!",
1453 &RI, F->getReturnType());
1455 // Check to make sure that the return value has necessary properties for
1457 visitTerminatorInst(RI);
1460 void Verifier::visitSwitchInst(SwitchInst &SI) {
1461 // Check to make sure that all of the constants in the switch instruction
1462 // have the same type as the switched-on value.
1463 Type *SwitchTy = SI.getCondition()->getType();
1464 SmallPtrSet<ConstantInt*, 32> Constants;
1465 for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end(); i != e; ++i) {
1466 Assert(i.getCaseValue()->getType() == SwitchTy,
1467 "Switch constants must all be same type as switch value!", &SI);
1468 Assert(Constants.insert(i.getCaseValue()).second,
1469 "Duplicate integer as switch case", &SI, i.getCaseValue());
1472 visitTerminatorInst(SI);
1475 void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
1476 Assert(BI.getAddress()->getType()->isPointerTy(),
1477 "Indirectbr operand must have pointer type!", &BI);
1478 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
1479 Assert(BI.getDestination(i)->getType()->isLabelTy(),
1480 "Indirectbr destinations must all have pointer type!", &BI);
1482 visitTerminatorInst(BI);
1485 void Verifier::visitSelectInst(SelectInst &SI) {
1486 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
1488 "Invalid operands for select instruction!", &SI);
1490 Assert(SI.getTrueValue()->getType() == SI.getType(),
1491 "Select values must have same type as select instruction!", &SI);
1492 visitInstruction(SI);
1495 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
1496 /// a pass, if any exist, it's an error.
1498 void Verifier::visitUserOp1(Instruction &I) {
1499 Assert(0, "User-defined operators should not live outside of a pass!", &I);
1502 void Verifier::visitTruncInst(TruncInst &I) {
1503 // Get the source and destination types
1504 Type *SrcTy = I.getOperand(0)->getType();
1505 Type *DestTy = I.getType();
1507 // Get the size of the types in bits, we'll need this later
1508 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1509 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1511 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
1512 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
1513 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1514 "trunc source and destination must both be a vector or neither", &I);
1515 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
1517 visitInstruction(I);
1520 void Verifier::visitZExtInst(ZExtInst &I) {
1521 // Get the source and destination types
1522 Type *SrcTy = I.getOperand(0)->getType();
1523 Type *DestTy = I.getType();
1525 // Get the size of the types in bits, we'll need this later
1526 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
1527 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
1528 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1529 "zext source and destination must both be a vector or neither", &I);
1530 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1531 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1533 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
1535 visitInstruction(I);
1538 void Verifier::visitSExtInst(SExtInst &I) {
1539 // Get the source and destination types
1540 Type *SrcTy = I.getOperand(0)->getType();
1541 Type *DestTy = I.getType();
1543 // Get the size of the types in bits, we'll need this later
1544 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1545 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1547 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
1548 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
1549 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1550 "sext source and destination must both be a vector or neither", &I);
1551 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
1553 visitInstruction(I);
1556 void Verifier::visitFPTruncInst(FPTruncInst &I) {
1557 // Get the source and destination types
1558 Type *SrcTy = I.getOperand(0)->getType();
1559 Type *DestTy = I.getType();
1560 // Get the size of the types in bits, we'll need this later
1561 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1562 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1564 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
1565 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
1566 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1567 "fptrunc source and destination must both be a vector or neither", &I);
1568 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
1570 visitInstruction(I);
1573 void Verifier::visitFPExtInst(FPExtInst &I) {
1574 // Get the source and destination types
1575 Type *SrcTy = I.getOperand(0)->getType();
1576 Type *DestTy = I.getType();
1578 // Get the size of the types in bits, we'll need this later
1579 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1580 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1582 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
1583 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
1584 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1585 "fpext source and destination must both be a vector or neither", &I);
1586 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
1588 visitInstruction(I);
1591 void Verifier::visitUIToFPInst(UIToFPInst &I) {
1592 // Get the source and destination types
1593 Type *SrcTy = I.getOperand(0)->getType();
1594 Type *DestTy = I.getType();
1596 bool SrcVec = SrcTy->isVectorTy();
1597 bool DstVec = DestTy->isVectorTy();
1599 Assert(SrcVec == DstVec,
1600 "UIToFP source and dest must both be vector or scalar", &I);
1601 Assert(SrcTy->isIntOrIntVectorTy(),
1602 "UIToFP source must be integer or integer vector", &I);
1603 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
1606 if (SrcVec && DstVec)
1607 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
1608 cast<VectorType>(DestTy)->getNumElements(),
1609 "UIToFP source and dest vector length mismatch", &I);
1611 visitInstruction(I);
1614 void Verifier::visitSIToFPInst(SIToFPInst &I) {
1615 // Get the source and destination types
1616 Type *SrcTy = I.getOperand(0)->getType();
1617 Type *DestTy = I.getType();
1619 bool SrcVec = SrcTy->isVectorTy();
1620 bool DstVec = DestTy->isVectorTy();
1622 Assert(SrcVec == DstVec,
1623 "SIToFP source and dest must both be vector or scalar", &I);
1624 Assert(SrcTy->isIntOrIntVectorTy(),
1625 "SIToFP source must be integer or integer vector", &I);
1626 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
1629 if (SrcVec && DstVec)
1630 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
1631 cast<VectorType>(DestTy)->getNumElements(),
1632 "SIToFP source and dest vector length mismatch", &I);
1634 visitInstruction(I);
1637 void Verifier::visitFPToUIInst(FPToUIInst &I) {
1638 // Get the source and destination types
1639 Type *SrcTy = I.getOperand(0)->getType();
1640 Type *DestTy = I.getType();
1642 bool SrcVec = SrcTy->isVectorTy();
1643 bool DstVec = DestTy->isVectorTy();
1645 Assert(SrcVec == DstVec,
1646 "FPToUI source and dest must both be vector or scalar", &I);
1647 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
1649 Assert(DestTy->isIntOrIntVectorTy(),
1650 "FPToUI result must be integer or integer vector", &I);
1652 if (SrcVec && DstVec)
1653 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
1654 cast<VectorType>(DestTy)->getNumElements(),
1655 "FPToUI source and dest vector length mismatch", &I);
1657 visitInstruction(I);
1660 void Verifier::visitFPToSIInst(FPToSIInst &I) {
1661 // Get the source and destination types
1662 Type *SrcTy = I.getOperand(0)->getType();
1663 Type *DestTy = I.getType();
1665 bool SrcVec = SrcTy->isVectorTy();
1666 bool DstVec = DestTy->isVectorTy();
1668 Assert(SrcVec == DstVec,
1669 "FPToSI source and dest must both be vector or scalar", &I);
1670 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
1672 Assert(DestTy->isIntOrIntVectorTy(),
1673 "FPToSI result must be integer or integer vector", &I);
1675 if (SrcVec && DstVec)
1676 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
1677 cast<VectorType>(DestTy)->getNumElements(),
1678 "FPToSI source and dest vector length mismatch", &I);
1680 visitInstruction(I);
1683 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
1684 // Get the source and destination types
1685 Type *SrcTy = I.getOperand(0)->getType();
1686 Type *DestTy = I.getType();
1688 Assert(SrcTy->getScalarType()->isPointerTy(),
1689 "PtrToInt source must be pointer", &I);
1690 Assert(DestTy->getScalarType()->isIntegerTy(),
1691 "PtrToInt result must be integral", &I);
1692 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
1695 if (SrcTy->isVectorTy()) {
1696 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
1697 VectorType *VDest = dyn_cast<VectorType>(DestTy);
1698 Assert(VSrc->getNumElements() == VDest->getNumElements(),
1699 "PtrToInt Vector width mismatch", &I);
1702 visitInstruction(I);
1705 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
1706 // Get the source and destination types
1707 Type *SrcTy = I.getOperand(0)->getType();
1708 Type *DestTy = I.getType();
1710 Assert(SrcTy->getScalarType()->isIntegerTy(),
1711 "IntToPtr source must be an integral", &I);
1712 Assert(DestTy->getScalarType()->isPointerTy(),
1713 "IntToPtr result must be a pointer", &I);
1714 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
1716 if (SrcTy->isVectorTy()) {
1717 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
1718 VectorType *VDest = dyn_cast<VectorType>(DestTy);
1719 Assert(VSrc->getNumElements() == VDest->getNumElements(),
1720 "IntToPtr Vector width mismatch", &I);
1722 visitInstruction(I);
1725 void Verifier::visitBitCastInst(BitCastInst &I) {
1727 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
1728 "Invalid bitcast", &I);
1729 visitInstruction(I);
1732 void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
1733 Type *SrcTy = I.getOperand(0)->getType();
1734 Type *DestTy = I.getType();
1736 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
1738 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
1740 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
1741 "AddrSpaceCast must be between different address spaces", &I);
1742 if (SrcTy->isVectorTy())
1743 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
1744 "AddrSpaceCast vector pointer number of elements mismatch", &I);
1745 visitInstruction(I);
1748 /// visitPHINode - Ensure that a PHI node is well formed.
1750 void Verifier::visitPHINode(PHINode &PN) {
1751 // Ensure that the PHI nodes are all grouped together at the top of the block.
1752 // This can be tested by checking whether the instruction before this is
1753 // either nonexistent (because this is begin()) or is a PHI node. If not,
1754 // then there is some other instruction before a PHI.
1755 Assert(&PN == &PN.getParent()->front() ||
1756 isa<PHINode>(--BasicBlock::iterator(&PN)),
1757 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
1759 // Check that all of the values of the PHI node have the same type as the
1760 // result, and that the incoming blocks are really basic blocks.
1761 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
1762 Assert(PN.getType() == PN.getIncomingValue(i)->getType(),
1763 "PHI node operands are not the same type as the result!", &PN);
1766 // All other PHI node constraints are checked in the visitBasicBlock method.
1768 visitInstruction(PN);
1771 void Verifier::VerifyCallSite(CallSite CS) {
1772 Instruction *I = CS.getInstruction();
1774 Assert(CS.getCalledValue()->getType()->isPointerTy(),
1775 "Called function must be a pointer!", I);
1776 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
1778 Assert(FPTy->getElementType()->isFunctionTy(),
1779 "Called function is not pointer to function type!", I);
1780 FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
1782 // Verify that the correct number of arguments are being passed
1783 if (FTy->isVarArg())
1784 Assert(CS.arg_size() >= FTy->getNumParams(),
1785 "Called function requires more parameters than were provided!", I);
1787 Assert(CS.arg_size() == FTy->getNumParams(),
1788 "Incorrect number of arguments passed to called function!", I);
1790 // Verify that all arguments to the call match the function type.
1791 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
1792 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
1793 "Call parameter type does not match function signature!",
1794 CS.getArgument(i), FTy->getParamType(i), I);
1796 AttributeSet Attrs = CS.getAttributes();
1798 Assert(VerifyAttributeCount(Attrs, CS.arg_size()),
1799 "Attribute after last parameter!", I);
1801 // Verify call attributes.
1802 VerifyFunctionAttrs(FTy, Attrs, I);
1804 // Conservatively check the inalloca argument.
1805 // We have a bug if we can find that there is an underlying alloca without
1807 if (CS.hasInAllocaArgument()) {
1808 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
1809 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
1810 Assert(AI->isUsedWithInAlloca(),
1811 "inalloca argument for call has mismatched alloca", AI, I);
1814 if (FTy->isVarArg()) {
1815 // FIXME? is 'nest' even legal here?
1816 bool SawNest = false;
1817 bool SawReturned = false;
1819 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
1820 if (Attrs.hasAttribute(Idx, Attribute::Nest))
1822 if (Attrs.hasAttribute(Idx, Attribute::Returned))
1826 // Check attributes on the varargs part.
1827 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
1828 Type *Ty = CS.getArgument(Idx-1)->getType();
1829 VerifyParameterAttrs(Attrs, Idx, Ty, false, I);
1831 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
1832 Assert(!SawNest, "More than one parameter has attribute nest!", I);
1836 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
1837 Assert(!SawReturned, "More than one parameter has attribute returned!",
1839 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
1840 "Incompatible argument and return types for 'returned' "
1846 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
1847 "Attribute 'sret' cannot be used for vararg call arguments!", I);
1849 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
1850 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
1854 // Verify that there's no metadata unless it's a direct call to an intrinsic.
1855 if (CS.getCalledFunction() == nullptr ||
1856 !CS.getCalledFunction()->getName().startswith("llvm.")) {
1857 for (FunctionType::param_iterator PI = FTy->param_begin(),
1858 PE = FTy->param_end(); PI != PE; ++PI)
1859 Assert(!(*PI)->isMetadataTy(),
1860 "Function has metadata parameter but isn't an intrinsic", I);
1863 visitInstruction(*I);
1866 /// Two types are "congruent" if they are identical, or if they are both pointer
1867 /// types with different pointee types and the same address space.
1868 static bool isTypeCongruent(Type *L, Type *R) {
1871 PointerType *PL = dyn_cast<PointerType>(L);
1872 PointerType *PR = dyn_cast<PointerType>(R);
1875 return PL->getAddressSpace() == PR->getAddressSpace();
1878 static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
1879 static const Attribute::AttrKind ABIAttrs[] = {
1880 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
1881 Attribute::InReg, Attribute::Returned};
1883 for (auto AK : ABIAttrs) {
1884 if (Attrs.hasAttribute(I + 1, AK))
1885 Copy.addAttribute(AK);
1887 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
1888 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
1892 void Verifier::verifyMustTailCall(CallInst &CI) {
1893 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
1895 // - The caller and callee prototypes must match. Pointer types of
1896 // parameters or return types may differ in pointee type, but not
1898 Function *F = CI.getParent()->getParent();
1899 auto GetFnTy = [](Value *V) {
1900 return cast<FunctionType>(
1901 cast<PointerType>(V->getType())->getElementType());
1903 FunctionType *CallerTy = GetFnTy(F);
1904 FunctionType *CalleeTy = GetFnTy(CI.getCalledValue());
1905 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
1906 "cannot guarantee tail call due to mismatched parameter counts", &CI);
1907 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
1908 "cannot guarantee tail call due to mismatched varargs", &CI);
1909 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
1910 "cannot guarantee tail call due to mismatched return types", &CI);
1911 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
1913 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
1914 "cannot guarantee tail call due to mismatched parameter types", &CI);
1917 // - The calling conventions of the caller and callee must match.
1918 Assert(F->getCallingConv() == CI.getCallingConv(),
1919 "cannot guarantee tail call due to mismatched calling conv", &CI);
1921 // - All ABI-impacting function attributes, such as sret, byval, inreg,
1922 // returned, and inalloca, must match.
1923 AttributeSet CallerAttrs = F->getAttributes();
1924 AttributeSet CalleeAttrs = CI.getAttributes();
1925 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
1926 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
1927 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
1928 Assert(CallerABIAttrs == CalleeABIAttrs,
1929 "cannot guarantee tail call due to mismatched ABI impacting "
1930 "function attributes",
1931 &CI, CI.getOperand(I));
1934 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
1935 // or a pointer bitcast followed by a ret instruction.
1936 // - The ret instruction must return the (possibly bitcasted) value
1937 // produced by the call or void.
1938 Value *RetVal = &CI;
1939 Instruction *Next = CI.getNextNode();
1941 // Handle the optional bitcast.
1942 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
1943 Assert(BI->getOperand(0) == RetVal,
1944 "bitcast following musttail call must use the call", BI);
1946 Next = BI->getNextNode();
1949 // Check the return.
1950 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
1951 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
1953 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
1954 "musttail call result must be returned", Ret);
1957 void Verifier::visitCallInst(CallInst &CI) {
1958 VerifyCallSite(&CI);
1960 if (CI.isMustTailCall())
1961 verifyMustTailCall(CI);
1963 if (Function *F = CI.getCalledFunction())
1964 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
1965 visitIntrinsicFunctionCall(ID, CI);
1968 void Verifier::visitInvokeInst(InvokeInst &II) {
1969 VerifyCallSite(&II);
1971 // Verify that there is a landingpad instruction as the first non-PHI
1972 // instruction of the 'unwind' destination.
1973 Assert(II.getUnwindDest()->isLandingPad(),
1974 "The unwind destination does not have a landingpad instruction!", &II);
1976 if (Function *F = II.getCalledFunction())
1977 // TODO: Ideally we should use visitIntrinsicFunction here. But it uses
1978 // CallInst as an input parameter. It not woth updating this whole
1979 // function only to support statepoint verification.
1980 if (F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint)
1981 VerifyStatepoint(ImmutableCallSite(&II));
1983 visitTerminatorInst(II);
1986 /// visitBinaryOperator - Check that both arguments to the binary operator are
1987 /// of the same type!
1989 void Verifier::visitBinaryOperator(BinaryOperator &B) {
1990 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
1991 "Both operands to a binary operator are not of the same type!", &B);
1993 switch (B.getOpcode()) {
1994 // Check that integer arithmetic operators are only used with
1995 // integral operands.
1996 case Instruction::Add:
1997 case Instruction::Sub:
1998 case Instruction::Mul:
1999 case Instruction::SDiv:
2000 case Instruction::UDiv:
2001 case Instruction::SRem:
2002 case Instruction::URem:
2003 Assert(B.getType()->isIntOrIntVectorTy(),
2004 "Integer arithmetic operators only work with integral types!", &B);
2005 Assert(B.getType() == B.getOperand(0)->getType(),
2006 "Integer arithmetic operators must have same type "
2007 "for operands and result!",
2010 // Check that floating-point arithmetic operators are only used with
2011 // floating-point operands.
2012 case Instruction::FAdd:
2013 case Instruction::FSub:
2014 case Instruction::FMul:
2015 case Instruction::FDiv:
2016 case Instruction::FRem:
2017 Assert(B.getType()->isFPOrFPVectorTy(),
2018 "Floating-point arithmetic operators only work with "
2019 "floating-point types!",
2021 Assert(B.getType() == B.getOperand(0)->getType(),
2022 "Floating-point arithmetic operators must have same type "
2023 "for operands and result!",
2026 // Check that logical operators are only used with integral operands.
2027 case Instruction::And:
2028 case Instruction::Or:
2029 case Instruction::Xor:
2030 Assert(B.getType()->isIntOrIntVectorTy(),
2031 "Logical operators only work with integral types!", &B);
2032 Assert(B.getType() == B.getOperand(0)->getType(),
2033 "Logical operators must have same type for operands and result!",
2036 case Instruction::Shl:
2037 case Instruction::LShr:
2038 case Instruction::AShr:
2039 Assert(B.getType()->isIntOrIntVectorTy(),
2040 "Shifts only work with integral types!", &B);
2041 Assert(B.getType() == B.getOperand(0)->getType(),
2042 "Shift return type must be same as operands!", &B);
2045 llvm_unreachable("Unknown BinaryOperator opcode!");
2048 visitInstruction(B);
2051 void Verifier::visitICmpInst(ICmpInst &IC) {
2052 // Check that the operands are the same type
2053 Type *Op0Ty = IC.getOperand(0)->getType();
2054 Type *Op1Ty = IC.getOperand(1)->getType();
2055 Assert(Op0Ty == Op1Ty,
2056 "Both operands to ICmp instruction are not of the same type!", &IC);
2057 // Check that the operands are the right type
2058 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2059 "Invalid operand types for ICmp instruction", &IC);
2060 // Check that the predicate is valid.
2061 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2062 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2063 "Invalid predicate in ICmp instruction!", &IC);
2065 visitInstruction(IC);
2068 void Verifier::visitFCmpInst(FCmpInst &FC) {
2069 // Check that the operands are the same type
2070 Type *Op0Ty = FC.getOperand(0)->getType();
2071 Type *Op1Ty = FC.getOperand(1)->getType();
2072 Assert(Op0Ty == Op1Ty,
2073 "Both operands to FCmp instruction are not of the same type!", &FC);
2074 // Check that the operands are the right type
2075 Assert(Op0Ty->isFPOrFPVectorTy(),
2076 "Invalid operand types for FCmp instruction", &FC);
2077 // Check that the predicate is valid.
2078 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2079 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2080 "Invalid predicate in FCmp instruction!", &FC);
2082 visitInstruction(FC);
2085 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
2087 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2088 "Invalid extractelement operands!", &EI);
2089 visitInstruction(EI);
2092 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
2093 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2095 "Invalid insertelement operands!", &IE);
2096 visitInstruction(IE);
2099 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
2100 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2102 "Invalid shufflevector operands!", &SV);
2103 visitInstruction(SV);
2106 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
2107 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
2109 Assert(isa<PointerType>(TargetTy),
2110 "GEP base pointer is not a vector or a vector of pointers", &GEP);
2111 Assert(cast<PointerType>(TargetTy)->getElementType()->isSized(),
2112 "GEP into unsized type!", &GEP);
2113 Assert(GEP.getPointerOperandType()->isVectorTy() ==
2114 GEP.getType()->isVectorTy(),
2115 "Vector GEP must return a vector value", &GEP);
2117 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
2119 GetElementPtrInst::getIndexedType(GEP.getPointerOperandType(), Idxs);
2120 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
2122 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
2123 cast<PointerType>(GEP.getType()->getScalarType())
2124 ->getElementType() == ElTy,
2125 "GEP is not of right type for indices!", &GEP, ElTy);
2127 if (GEP.getPointerOperandType()->isVectorTy()) {
2128 // Additional checks for vector GEPs.
2129 unsigned GepWidth = GEP.getPointerOperandType()->getVectorNumElements();
2130 Assert(GepWidth == GEP.getType()->getVectorNumElements(),
2131 "Vector GEP result width doesn't match operand's", &GEP);
2132 for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
2133 Type *IndexTy = Idxs[i]->getType();
2134 Assert(IndexTy->isVectorTy(), "Vector GEP must have vector indices!",
2136 unsigned IndexWidth = IndexTy->getVectorNumElements();
2137 Assert(IndexWidth == GepWidth, "Invalid GEP index vector width", &GEP);
2140 visitInstruction(GEP);
2143 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2144 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2147 void Verifier::visitRangeMetadata(Instruction& I,
2148 MDNode* Range, Type* Ty) {
2150 Range == I.getMetadata(LLVMContext::MD_range) &&
2151 "precondition violation");
2153 unsigned NumOperands = Range->getNumOperands();
2154 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
2155 unsigned NumRanges = NumOperands / 2;
2156 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2158 ConstantRange LastRange(1); // Dummy initial value
2159 for (unsigned i = 0; i < NumRanges; ++i) {
2161 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
2162 Assert(Low, "The lower limit must be an integer!", Low);
2164 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
2165 Assert(High, "The upper limit must be an integer!", High);
2166 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2167 "Range types must match instruction type!", &I);
2169 APInt HighV = High->getValue();
2170 APInt LowV = Low->getValue();
2171 ConstantRange CurRange(LowV, HighV);
2172 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2173 "Range must not be empty!", Range);
2175 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2176 "Intervals are overlapping", Range);
2177 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2179 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2182 LastRange = ConstantRange(LowV, HighV);
2184 if (NumRanges > 2) {
2186 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
2188 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
2189 ConstantRange FirstRange(FirstLow, FirstHigh);
2190 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2191 "Intervals are overlapping", Range);
2192 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2197 void Verifier::visitLoadInst(LoadInst &LI) {
2198 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
2199 Assert(PTy, "Load operand must be a pointer.", &LI);
2200 Type *ElTy = PTy->getElementType();
2201 Assert(ElTy == LI.getType(),
2202 "Load result type does not match pointer operand type!", &LI, ElTy);
2203 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2204 "huge alignment values are unsupported", &LI);
2205 if (LI.isAtomic()) {
2206 Assert(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
2207 "Load cannot have Release ordering", &LI);
2208 Assert(LI.getAlignment() != 0,
2209 "Atomic load must specify explicit alignment", &LI);
2210 if (!ElTy->isPointerTy()) {
2211 Assert(ElTy->isIntegerTy(), "atomic load operand must have integer type!",
2213 unsigned Size = ElTy->getPrimitiveSizeInBits();
2214 Assert(Size >= 8 && !(Size & (Size - 1)),
2215 "atomic load operand must be power-of-two byte-sized integer", &LI,
2219 Assert(LI.getSynchScope() == CrossThread,
2220 "Non-atomic load cannot have SynchronizationScope specified", &LI);
2223 visitInstruction(LI);
2226 void Verifier::visitStoreInst(StoreInst &SI) {
2227 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
2228 Assert(PTy, "Store operand must be a pointer.", &SI);
2229 Type *ElTy = PTy->getElementType();
2230 Assert(ElTy == SI.getOperand(0)->getType(),
2231 "Stored value type does not match pointer operand type!", &SI, ElTy);
2232 Assert(SI.getAlignment() <= Value::MaximumAlignment,
2233 "huge alignment values are unsupported", &SI);
2234 if (SI.isAtomic()) {
2235 Assert(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
2236 "Store cannot have Acquire ordering", &SI);
2237 Assert(SI.getAlignment() != 0,
2238 "Atomic store must specify explicit alignment", &SI);
2239 if (!ElTy->isPointerTy()) {
2240 Assert(ElTy->isIntegerTy(),
2241 "atomic store operand must have integer type!", &SI, ElTy);
2242 unsigned Size = ElTy->getPrimitiveSizeInBits();
2243 Assert(Size >= 8 && !(Size & (Size - 1)),
2244 "atomic store operand must be power-of-two byte-sized integer",
2248 Assert(SI.getSynchScope() == CrossThread,
2249 "Non-atomic store cannot have SynchronizationScope specified", &SI);
2251 visitInstruction(SI);
2254 void Verifier::visitAllocaInst(AllocaInst &AI) {
2255 SmallPtrSet<const Type*, 4> Visited;
2256 PointerType *PTy = AI.getType();
2257 Assert(PTy->getAddressSpace() == 0,
2258 "Allocation instruction pointer not in the generic address space!",
2260 Assert(PTy->getElementType()->isSized(&Visited),
2261 "Cannot allocate unsized type", &AI);
2262 Assert(AI.getArraySize()->getType()->isIntegerTy(),
2263 "Alloca array size must have integer type", &AI);
2264 Assert(AI.getAlignment() <= Value::MaximumAlignment,
2265 "huge alignment values are unsupported", &AI);
2267 visitInstruction(AI);
2270 void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
2272 // FIXME: more conditions???
2273 Assert(CXI.getSuccessOrdering() != NotAtomic,
2274 "cmpxchg instructions must be atomic.", &CXI);
2275 Assert(CXI.getFailureOrdering() != NotAtomic,
2276 "cmpxchg instructions must be atomic.", &CXI);
2277 Assert(CXI.getSuccessOrdering() != Unordered,
2278 "cmpxchg instructions cannot be unordered.", &CXI);
2279 Assert(CXI.getFailureOrdering() != Unordered,
2280 "cmpxchg instructions cannot be unordered.", &CXI);
2281 Assert(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
2282 "cmpxchg instructions be at least as constrained on success as fail",
2284 Assert(CXI.getFailureOrdering() != Release &&
2285 CXI.getFailureOrdering() != AcquireRelease,
2286 "cmpxchg failure ordering cannot include release semantics", &CXI);
2288 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
2289 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
2290 Type *ElTy = PTy->getElementType();
2291 Assert(ElTy->isIntegerTy(), "cmpxchg operand must have integer type!", &CXI,
2293 unsigned Size = ElTy->getPrimitiveSizeInBits();
2294 Assert(Size >= 8 && !(Size & (Size - 1)),
2295 "cmpxchg operand must be power-of-two byte-sized integer", &CXI, ElTy);
2296 Assert(ElTy == CXI.getOperand(1)->getType(),
2297 "Expected value type does not match pointer operand type!", &CXI,
2299 Assert(ElTy == CXI.getOperand(2)->getType(),
2300 "Stored value type does not match pointer operand type!", &CXI, ElTy);
2301 visitInstruction(CXI);
2304 void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
2305 Assert(RMWI.getOrdering() != NotAtomic,
2306 "atomicrmw instructions must be atomic.", &RMWI);
2307 Assert(RMWI.getOrdering() != Unordered,
2308 "atomicrmw instructions cannot be unordered.", &RMWI);
2309 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
2310 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
2311 Type *ElTy = PTy->getElementType();
2312 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
2314 unsigned Size = ElTy->getPrimitiveSizeInBits();
2315 Assert(Size >= 8 && !(Size & (Size - 1)),
2316 "atomicrmw operand must be power-of-two byte-sized integer", &RMWI,
2318 Assert(ElTy == RMWI.getOperand(1)->getType(),
2319 "Argument value type does not match pointer operand type!", &RMWI,
2321 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
2322 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
2323 "Invalid binary operation!", &RMWI);
2324 visitInstruction(RMWI);
2327 void Verifier::visitFenceInst(FenceInst &FI) {
2328 const AtomicOrdering Ordering = FI.getOrdering();
2329 Assert(Ordering == Acquire || Ordering == Release ||
2330 Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
2331 "fence instructions may only have "
2332 "acquire, release, acq_rel, or seq_cst ordering.",
2334 visitInstruction(FI);
2337 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
2338 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
2339 EVI.getIndices()) == EVI.getType(),
2340 "Invalid ExtractValueInst operands!", &EVI);
2342 visitInstruction(EVI);
2345 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
2346 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
2347 IVI.getIndices()) ==
2348 IVI.getOperand(1)->getType(),
2349 "Invalid InsertValueInst operands!", &IVI);
2351 visitInstruction(IVI);
2354 void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
2355 BasicBlock *BB = LPI.getParent();
2357 // The landingpad instruction is ill-formed if it doesn't have any clauses and
2359 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
2360 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
2362 // The landingpad instruction defines its parent as a landing pad block. The
2363 // landing pad block may be branched to only by the unwind edge of an invoke.
2364 for (pred_iterator I = pred_begin(BB), E = pred_end(BB); I != E; ++I) {
2365 const InvokeInst *II = dyn_cast<InvokeInst>((*I)->getTerminator());
2366 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
2367 "Block containing LandingPadInst must be jumped to "
2368 "only by the unwind edge of an invoke.",
2372 // The landingpad instruction must be the first non-PHI instruction in the
2374 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
2375 "LandingPadInst not the first non-PHI instruction in the block.",
2378 // The personality functions for all landingpad instructions within the same
2379 // function should match.
2381 Assert(LPI.getPersonalityFn() == PersonalityFn,
2382 "Personality function doesn't match others in function", &LPI);
2383 PersonalityFn = LPI.getPersonalityFn();
2385 // All operands must be constants.
2386 Assert(isa<Constant>(PersonalityFn), "Personality function is not constant!",
2388 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
2389 Constant *Clause = LPI.getClause(i);
2390 if (LPI.isCatch(i)) {
2391 Assert(isa<PointerType>(Clause->getType()),
2392 "Catch operand does not have pointer type!", &LPI);
2394 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
2395 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
2396 "Filter operand is not an array of constants!", &LPI);
2400 visitInstruction(LPI);
2403 void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
2404 Instruction *Op = cast<Instruction>(I.getOperand(i));
2405 // If the we have an invalid invoke, don't try to compute the dominance.
2406 // We already reject it in the invoke specific checks and the dominance
2407 // computation doesn't handle multiple edges.
2408 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
2409 if (II->getNormalDest() == II->getUnwindDest())
2413 const Use &U = I.getOperandUse(i);
2414 Assert(InstsInThisBlock.count(Op) || DT.dominates(Op, U),
2415 "Instruction does not dominate all uses!", Op, &I);
2418 /// verifyInstruction - Verify that an instruction is well formed.
2420 void Verifier::visitInstruction(Instruction &I) {
2421 BasicBlock *BB = I.getParent();
2422 Assert(BB, "Instruction not embedded in basic block!", &I);
2424 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
2425 for (User *U : I.users()) {
2426 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
2427 "Only PHI nodes may reference their own value!", &I);
2431 // Check that void typed values don't have names
2432 Assert(!I.getType()->isVoidTy() || !I.hasName(),
2433 "Instruction has a name, but provides a void value!", &I);
2435 // Check that the return value of the instruction is either void or a legal
2437 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
2438 "Instruction returns a non-scalar type!", &I);
2440 // Check that the instruction doesn't produce metadata. Calls are already
2441 // checked against the callee type.
2442 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
2443 "Invalid use of metadata!", &I);
2445 // Check that all uses of the instruction, if they are instructions
2446 // themselves, actually have parent basic blocks. If the use is not an
2447 // instruction, it is an error!
2448 for (Use &U : I.uses()) {
2449 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
2450 Assert(Used->getParent() != nullptr,
2451 "Instruction referencing"
2452 " instruction not embedded in a basic block!",
2455 CheckFailed("Use of instruction is not an instruction!", U);
2460 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
2461 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
2463 // Check to make sure that only first-class-values are operands to
2465 if (!I.getOperand(i)->getType()->isFirstClassType()) {
2466 Assert(0, "Instruction operands must be first-class values!", &I);
2469 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
2470 // Check to make sure that the "address of" an intrinsic function is never
2473 !F->isIntrinsic() ||
2474 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
2475 "Cannot take the address of an intrinsic!", &I);
2477 !F->isIntrinsic() || isa<CallInst>(I) ||
2478 F->getIntrinsicID() == Intrinsic::donothing ||
2479 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
2480 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
2481 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
2482 "Cannot invoke an intrinsinc other than"
2483 " donothing or patchpoint",
2485 Assert(F->getParent() == M, "Referencing function in another module!",
2487 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
2488 Assert(OpBB->getParent() == BB->getParent(),
2489 "Referring to a basic block in another function!", &I);
2490 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
2491 Assert(OpArg->getParent() == BB->getParent(),
2492 "Referring to an argument in another function!", &I);
2493 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
2494 Assert(GV->getParent() == M, "Referencing global in another module!", &I);
2495 } else if (isa<Instruction>(I.getOperand(i))) {
2496 verifyDominatesUse(I, i);
2497 } else if (isa<InlineAsm>(I.getOperand(i))) {
2498 Assert((i + 1 == e && isa<CallInst>(I)) ||
2499 (i + 3 == e && isa<InvokeInst>(I)),
2500 "Cannot take the address of an inline asm!", &I);
2501 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
2502 if (CE->getType()->isPtrOrPtrVectorTy()) {
2503 // If we have a ConstantExpr pointer, we need to see if it came from an
2504 // illegal bitcast (inttoptr <constant int> )
2505 SmallVector<const ConstantExpr *, 4> Stack;
2506 SmallPtrSet<const ConstantExpr *, 4> Visited;
2507 Stack.push_back(CE);
2509 while (!Stack.empty()) {
2510 const ConstantExpr *V = Stack.pop_back_val();
2511 if (!Visited.insert(V).second)
2514 VerifyConstantExprBitcastType(V);
2516 for (unsigned I = 0, N = V->getNumOperands(); I != N; ++I) {
2517 if (ConstantExpr *Op = dyn_cast<ConstantExpr>(V->getOperand(I)))
2518 Stack.push_back(Op);
2525 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
2526 Assert(I.getType()->isFPOrFPVectorTy(),
2527 "fpmath requires a floating point result!", &I);
2528 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
2529 if (ConstantFP *CFP0 =
2530 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
2531 APFloat Accuracy = CFP0->getValueAPF();
2532 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
2533 "fpmath accuracy not a positive number!", &I);
2535 Assert(false, "invalid fpmath accuracy!", &I);
2539 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
2540 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
2541 "Ranges are only for loads, calls and invokes!", &I);
2542 visitRangeMetadata(I, Range, I.getType());
2545 if (I.getMetadata(LLVMContext::MD_nonnull)) {
2546 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
2548 Assert(isa<LoadInst>(I),
2549 "nonnull applies only to load instructions, use attributes"
2550 " for calls or invokes",
2554 InstsInThisBlock.insert(&I);
2557 /// VerifyIntrinsicType - Verify that the specified type (which comes from an
2558 /// intrinsic argument or return value) matches the type constraints specified
2559 /// by the .td file (e.g. an "any integer" argument really is an integer).
2561 /// This return true on error but does not print a message.
2562 bool Verifier::VerifyIntrinsicType(Type *Ty,
2563 ArrayRef<Intrinsic::IITDescriptor> &Infos,
2564 SmallVectorImpl<Type*> &ArgTys) {
2565 using namespace Intrinsic;
2567 // If we ran out of descriptors, there are too many arguments.
2568 if (Infos.empty()) return true;
2569 IITDescriptor D = Infos.front();
2570 Infos = Infos.slice(1);
2573 case IITDescriptor::Void: return !Ty->isVoidTy();
2574 case IITDescriptor::VarArg: return true;
2575 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
2576 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
2577 case IITDescriptor::Half: return !Ty->isHalfTy();
2578 case IITDescriptor::Float: return !Ty->isFloatTy();
2579 case IITDescriptor::Double: return !Ty->isDoubleTy();
2580 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
2581 case IITDescriptor::Vector: {
2582 VectorType *VT = dyn_cast<VectorType>(Ty);
2583 return !VT || VT->getNumElements() != D.Vector_Width ||
2584 VerifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
2586 case IITDescriptor::Pointer: {
2587 PointerType *PT = dyn_cast<PointerType>(Ty);
2588 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
2589 VerifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
2592 case IITDescriptor::Struct: {
2593 StructType *ST = dyn_cast<StructType>(Ty);
2594 if (!ST || ST->getNumElements() != D.Struct_NumElements)
2597 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
2598 if (VerifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
2603 case IITDescriptor::Argument:
2604 // Two cases here - If this is the second occurrence of an argument, verify
2605 // that the later instance matches the previous instance.
2606 if (D.getArgumentNumber() < ArgTys.size())
2607 return Ty != ArgTys[D.getArgumentNumber()];
2609 // Otherwise, if this is the first instance of an argument, record it and
2610 // verify the "Any" kind.
2611 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
2612 ArgTys.push_back(Ty);
2614 switch (D.getArgumentKind()) {
2615 case IITDescriptor::AK_Any: return false; // Success
2616 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
2617 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
2618 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
2619 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
2621 llvm_unreachable("all argument kinds not covered");
2623 case IITDescriptor::ExtendArgument: {
2624 // This may only be used when referring to a previous vector argument.
2625 if (D.getArgumentNumber() >= ArgTys.size())
2628 Type *NewTy = ArgTys[D.getArgumentNumber()];
2629 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
2630 NewTy = VectorType::getExtendedElementVectorType(VTy);
2631 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
2632 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
2638 case IITDescriptor::TruncArgument: {
2639 // This may only be used when referring to a previous vector argument.
2640 if (D.getArgumentNumber() >= ArgTys.size())
2643 Type *NewTy = ArgTys[D.getArgumentNumber()];
2644 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
2645 NewTy = VectorType::getTruncatedElementVectorType(VTy);
2646 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
2647 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
2653 case IITDescriptor::HalfVecArgument:
2654 // This may only be used when referring to a previous vector argument.
2655 return D.getArgumentNumber() >= ArgTys.size() ||
2656 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
2657 VectorType::getHalfElementsVectorType(
2658 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
2659 case IITDescriptor::SameVecWidthArgument: {
2660 if (D.getArgumentNumber() >= ArgTys.size())
2662 VectorType * ReferenceType =
2663 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
2664 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
2665 if (!ThisArgType || !ReferenceType ||
2666 (ReferenceType->getVectorNumElements() !=
2667 ThisArgType->getVectorNumElements()))
2669 return VerifyIntrinsicType(ThisArgType->getVectorElementType(),
2672 case IITDescriptor::PtrToArgument: {
2673 if (D.getArgumentNumber() >= ArgTys.size())
2675 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
2676 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
2677 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
2679 case IITDescriptor::VecOfPtrsToElt: {
2680 if (D.getArgumentNumber() >= ArgTys.size())
2682 VectorType * ReferenceType =
2683 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
2684 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
2685 if (!ThisArgVecTy || !ReferenceType ||
2686 (ReferenceType->getVectorNumElements() !=
2687 ThisArgVecTy->getVectorNumElements()))
2689 PointerType *ThisArgEltTy =
2690 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
2693 return (!(ThisArgEltTy->getElementType() ==
2694 ReferenceType->getVectorElementType()));
2697 llvm_unreachable("unhandled");
2700 /// \brief Verify if the intrinsic has variable arguments.
2701 /// This method is intended to be called after all the fixed arguments have been
2704 /// This method returns true on error and does not print an error message.
2706 Verifier::VerifyIntrinsicIsVarArg(bool isVarArg,
2707 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
2708 using namespace Intrinsic;
2710 // If there are no descriptors left, then it can't be a vararg.
2712 return isVarArg ? true : false;
2714 // There should be only one descriptor remaining at this point.
2715 if (Infos.size() != 1)
2718 // Check and verify the descriptor.
2719 IITDescriptor D = Infos.front();
2720 Infos = Infos.slice(1);
2721 if (D.Kind == IITDescriptor::VarArg)
2722 return isVarArg ? false : true;
2727 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
2729 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
2730 Function *IF = CI.getCalledFunction();
2731 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
2734 // Verify that the intrinsic prototype lines up with what the .td files
2736 FunctionType *IFTy = IF->getFunctionType();
2737 bool IsVarArg = IFTy->isVarArg();
2739 SmallVector<Intrinsic::IITDescriptor, 8> Table;
2740 getIntrinsicInfoTableEntries(ID, Table);
2741 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
2743 SmallVector<Type *, 4> ArgTys;
2744 Assert(!VerifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
2745 "Intrinsic has incorrect return type!", IF);
2746 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
2747 Assert(!VerifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
2748 "Intrinsic has incorrect argument type!", IF);
2750 // Verify if the intrinsic call matches the vararg property.
2752 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
2753 "Intrinsic was not defined with variable arguments!", IF);
2755 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
2756 "Callsite was not defined with variable arguments!", IF);
2758 // All descriptors should be absorbed by now.
2759 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
2761 // Now that we have the intrinsic ID and the actual argument types (and we
2762 // know they are legal for the intrinsic!) get the intrinsic name through the
2763 // usual means. This allows us to verify the mangling of argument types into
2765 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
2766 Assert(ExpectedName == IF->getName(),
2767 "Intrinsic name not mangled correctly for type arguments! "
2772 // If the intrinsic takes MDNode arguments, verify that they are either global
2773 // or are local to *this* function.
2774 for (unsigned i = 0, e = CI.getNumArgOperands(); i != e; ++i)
2775 if (auto *MD = dyn_cast<MetadataAsValue>(CI.getArgOperand(i)))
2776 visitMetadataAsValue(*MD, CI.getParent()->getParent());
2781 case Intrinsic::ctlz: // llvm.ctlz
2782 case Intrinsic::cttz: // llvm.cttz
2783 Assert(isa<ConstantInt>(CI.getArgOperand(1)),
2784 "is_zero_undef argument of bit counting intrinsics must be a "
2788 case Intrinsic::dbg_declare: { // llvm.dbg.declare
2789 Assert(CI.getArgOperand(0) && isa<MetadataAsValue>(CI.getArgOperand(0)),
2790 "invalid llvm.dbg.declare intrinsic call 1", &CI);
2792 case Intrinsic::memcpy:
2793 case Intrinsic::memmove:
2794 case Intrinsic::memset: {
2795 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CI.getArgOperand(3));
2797 "alignment argument of memory intrinsics must be a constant int",
2799 const APInt &AlignVal = AlignCI->getValue();
2800 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
2801 "alignment argument of memory intrinsics must be a power of 2", &CI);
2802 Assert(isa<ConstantInt>(CI.getArgOperand(4)),
2803 "isvolatile argument of memory intrinsics must be a constant int",
2807 case Intrinsic::gcroot:
2808 case Intrinsic::gcwrite:
2809 case Intrinsic::gcread:
2810 if (ID == Intrinsic::gcroot) {
2812 dyn_cast<AllocaInst>(CI.getArgOperand(0)->stripPointerCasts());
2813 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", &CI);
2814 Assert(isa<Constant>(CI.getArgOperand(1)),
2815 "llvm.gcroot parameter #2 must be a constant.", &CI);
2816 if (!AI->getType()->getElementType()->isPointerTy()) {
2817 Assert(!isa<ConstantPointerNull>(CI.getArgOperand(1)),
2818 "llvm.gcroot parameter #1 must either be a pointer alloca, "
2819 "or argument #2 must be a non-null constant.",
2824 Assert(CI.getParent()->getParent()->hasGC(),
2825 "Enclosing function does not use GC.", &CI);
2827 case Intrinsic::init_trampoline:
2828 Assert(isa<Function>(CI.getArgOperand(1)->stripPointerCasts()),
2829 "llvm.init_trampoline parameter #2 must resolve to a function.",
2832 case Intrinsic::prefetch:
2833 Assert(isa<ConstantInt>(CI.getArgOperand(1)) &&
2834 isa<ConstantInt>(CI.getArgOperand(2)) &&
2835 cast<ConstantInt>(CI.getArgOperand(1))->getZExtValue() < 2 &&
2836 cast<ConstantInt>(CI.getArgOperand(2))->getZExtValue() < 4,
2837 "invalid arguments to llvm.prefetch", &CI);
2839 case Intrinsic::stackprotector:
2840 Assert(isa<AllocaInst>(CI.getArgOperand(1)->stripPointerCasts()),
2841 "llvm.stackprotector parameter #2 must resolve to an alloca.", &CI);
2843 case Intrinsic::lifetime_start:
2844 case Intrinsic::lifetime_end:
2845 case Intrinsic::invariant_start:
2846 Assert(isa<ConstantInt>(CI.getArgOperand(0)),
2847 "size argument of memory use markers must be a constant integer",
2850 case Intrinsic::invariant_end:
2851 Assert(isa<ConstantInt>(CI.getArgOperand(1)),
2852 "llvm.invariant.end parameter #2 must be a constant integer", &CI);
2855 case Intrinsic::frameescape: {
2856 BasicBlock *BB = CI.getParent();
2857 Assert(BB == &BB->getParent()->front(),
2858 "llvm.frameescape used outside of entry block", &CI);
2859 Assert(!SawFrameEscape,
2860 "multiple calls to llvm.frameescape in one function", &CI);
2861 for (Value *Arg : CI.arg_operands()) {
2862 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
2863 Assert(AI && AI->isStaticAlloca(),
2864 "llvm.frameescape only accepts static allocas", &CI);
2866 FrameEscapeInfo[BB->getParent()].first = CI.getNumArgOperands();
2867 SawFrameEscape = true;
2870 case Intrinsic::framerecover: {
2871 Value *FnArg = CI.getArgOperand(0)->stripPointerCasts();
2872 Function *Fn = dyn_cast<Function>(FnArg);
2873 Assert(Fn && !Fn->isDeclaration(),
2874 "llvm.framerecover first "
2875 "argument must be function defined in this module",
2877 auto *IdxArg = dyn_cast<ConstantInt>(CI.getArgOperand(2));
2878 Assert(IdxArg, "idx argument of llvm.framerecover must be a constant int",
2880 auto &Entry = FrameEscapeInfo[Fn];
2881 Entry.second = unsigned(
2882 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
2886 case Intrinsic::experimental_gc_statepoint:
2887 Assert(!CI.isInlineAsm(),
2888 "gc.statepoint support for inline assembly unimplemented", &CI);
2890 VerifyStatepoint(ImmutableCallSite(&CI));
2892 case Intrinsic::experimental_gc_result_int:
2893 case Intrinsic::experimental_gc_result_float:
2894 case Intrinsic::experimental_gc_result_ptr:
2895 case Intrinsic::experimental_gc_result: {
2896 // Are we tied to a statepoint properly?
2897 CallSite StatepointCS(CI.getArgOperand(0));
2898 const Function *StatepointFn =
2899 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
2900 Assert(StatepointFn && StatepointFn->isDeclaration() &&
2901 StatepointFn->getIntrinsicID() ==
2902 Intrinsic::experimental_gc_statepoint,
2903 "gc.result operand #1 must be from a statepoint", &CI,
2904 CI.getArgOperand(0));
2906 // Assert that result type matches wrapped callee.
2907 const Value *Target = StatepointCS.getArgument(0);
2908 const PointerType *PT = cast<PointerType>(Target->getType());
2909 const FunctionType *TargetFuncType =
2910 cast<FunctionType>(PT->getElementType());
2911 Assert(CI.getType() == TargetFuncType->getReturnType(),
2912 "gc.result result type does not match wrapped callee", &CI);
2915 case Intrinsic::experimental_gc_relocate: {
2916 Assert(CI.getNumArgOperands() == 3, "wrong number of arguments", &CI);
2918 // Check that this relocate is correctly tied to the statepoint
2920 // This is case for relocate on the unwinding path of an invoke statepoint
2921 if (ExtractValueInst *ExtractValue =
2922 dyn_cast<ExtractValueInst>(CI.getArgOperand(0))) {
2923 Assert(isa<LandingPadInst>(ExtractValue->getAggregateOperand()),
2924 "gc relocate on unwind path incorrectly linked to the statepoint",
2927 const BasicBlock *invokeBB =
2928 ExtractValue->getParent()->getUniquePredecessor();
2930 // Landingpad relocates should have only one predecessor with invoke
2931 // statepoint terminator
2932 Assert(invokeBB, "safepoints should have unique landingpads",
2933 ExtractValue->getParent());
2934 Assert(invokeBB->getTerminator(), "safepoint block should be well formed",
2936 Assert(isStatepoint(invokeBB->getTerminator()),
2937 "gc relocate should be linked to a statepoint", invokeBB);
2940 // In all other cases relocate should be tied to the statepoint directly.
2941 // This covers relocates on a normal return path of invoke statepoint and
2942 // relocates of a call statepoint
2943 auto Token = CI.getArgOperand(0);
2944 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
2945 "gc relocate is incorrectly tied to the statepoint", &CI, Token);
2948 // Verify rest of the relocate arguments
2950 GCRelocateOperands ops(&CI);
2951 ImmutableCallSite StatepointCS(ops.statepoint());
2953 // Both the base and derived must be piped through the safepoint
2954 Value* Base = CI.getArgOperand(1);
2955 Assert(isa<ConstantInt>(Base),
2956 "gc.relocate operand #2 must be integer offset", &CI);
2958 Value* Derived = CI.getArgOperand(2);
2959 Assert(isa<ConstantInt>(Derived),
2960 "gc.relocate operand #3 must be integer offset", &CI);
2962 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
2963 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
2965 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
2966 "gc.relocate: statepoint base index out of bounds", &CI);
2967 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
2968 "gc.relocate: statepoint derived index out of bounds", &CI);
2970 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
2971 // section of the statepoint's argument
2972 const int NumCallArgs =
2973 cast<ConstantInt>(StatepointCS.getArgument(1))->getZExtValue();
2974 const int NumDeoptArgs =
2975 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 3))->getZExtValue();
2976 const int GCParamArgsStart = NumCallArgs + NumDeoptArgs + 4;
2977 const int GCParamArgsEnd = StatepointCS.arg_size();
2978 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
2979 "gc.relocate: statepoint base index doesn't fall within the "
2980 "'gc parameters' section of the statepoint call",
2982 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
2983 "gc.relocate: statepoint derived index doesn't fall within the "
2984 "'gc parameters' section of the statepoint call",
2987 // Assert that the result type matches the type of the relocated pointer
2988 GCRelocateOperands Operands(&CI);
2989 Assert(Operands.derivedPtr()->getType() == CI.getType(),
2990 "gc.relocate: relocating a pointer shouldn't change its type", &CI);
2996 void DebugInfoVerifier::verifyDebugInfo() {
2997 if (!VerifyDebugInfo)
3000 DebugInfoFinder Finder;
3001 Finder.processModule(*M);
3002 processInstructions(Finder);
3004 // Verify Debug Info.
3006 // NOTE: The loud braces are necessary for MSVC compatibility.
3007 for (DICompileUnit CU : Finder.compile_units()) {
3008 Assert(CU.Verify(), "DICompileUnit does not Verify!", CU);
3010 for (DISubprogram S : Finder.subprograms()) {
3011 Assert(S.Verify(), "DISubprogram does not Verify!", S);
3013 for (DIGlobalVariable GV : Finder.global_variables()) {
3014 Assert(GV.Verify(), "DIGlobalVariable does not Verify!", GV);
3016 for (DIType T : Finder.types()) {
3017 Assert(T.Verify(), "DIType does not Verify!", T);
3019 for (DIScope S : Finder.scopes()) {
3020 Assert(S.Verify(), "DIScope does not Verify!", S);
3024 void DebugInfoVerifier::processInstructions(DebugInfoFinder &Finder) {
3025 for (const Function &F : *M)
3026 for (auto I = inst_begin(&F), E = inst_end(&F); I != E; ++I) {
3027 if (MDNode *MD = I->getMetadata(LLVMContext::MD_dbg))
3028 Finder.processLocation(*M, DILocation(MD));
3029 if (const CallInst *CI = dyn_cast<CallInst>(&*I))
3030 processCallInst(Finder, *CI);
3034 void DebugInfoVerifier::processCallInst(DebugInfoFinder &Finder,
3035 const CallInst &CI) {
3036 if (Function *F = CI.getCalledFunction())
3037 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
3039 case Intrinsic::dbg_declare: {
3040 auto *DDI = cast<DbgDeclareInst>(&CI);
3041 Finder.processDeclare(*M, DDI);
3042 if (auto E = DDI->getExpression())
3043 Assert(DIExpression(E).Verify(), "DIExpression does not Verify!", E);
3046 case Intrinsic::dbg_value: {
3047 auto *DVI = cast<DbgValueInst>(&CI);
3048 Finder.processValue(*M, DVI);
3049 if (auto E = DVI->getExpression())
3050 Assert(DIExpression(E).Verify(), "DIExpression does not Verify!", E);
3058 //===----------------------------------------------------------------------===//
3059 // Implement the public interfaces to this file...
3060 //===----------------------------------------------------------------------===//
3062 bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
3063 Function &F = const_cast<Function &>(f);
3064 assert(!F.isDeclaration() && "Cannot verify external functions");
3066 raw_null_ostream NullStr;
3067 Verifier V(OS ? *OS : NullStr);
3069 // Note that this function's return value is inverted from what you would
3070 // expect of a function called "verify".
3071 return !V.verify(F);
3074 bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
3075 raw_null_ostream NullStr;
3076 Verifier V(OS ? *OS : NullStr);
3078 bool Broken = false;
3079 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
3080 if (!I->isDeclaration() && !I->isMaterializable())
3081 Broken |= !V.verify(*I);
3083 // Note that this function's return value is inverted from what you would
3084 // expect of a function called "verify".
3085 DebugInfoVerifier DIV(OS ? *OS : NullStr);
3086 return !V.verify(M) || !DIV.verify(M) || Broken;
3090 struct VerifierLegacyPass : public FunctionPass {
3096 VerifierLegacyPass() : FunctionPass(ID), FatalErrors(true) {
3097 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3099 explicit VerifierLegacyPass(bool FatalErrors)
3100 : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
3101 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3104 bool runOnFunction(Function &F) override {
3105 if (!V.verify(F) && FatalErrors)
3106 report_fatal_error("Broken function found, compilation aborted!");
3111 bool doFinalization(Module &M) override {
3112 if (!V.verify(M) && FatalErrors)
3113 report_fatal_error("Broken module found, compilation aborted!");
3118 void getAnalysisUsage(AnalysisUsage &AU) const override {
3119 AU.setPreservesAll();
3122 struct DebugInfoVerifierLegacyPass : public ModulePass {
3125 DebugInfoVerifier V;
3128 DebugInfoVerifierLegacyPass() : ModulePass(ID), FatalErrors(true) {
3129 initializeDebugInfoVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3131 explicit DebugInfoVerifierLegacyPass(bool FatalErrors)
3132 : ModulePass(ID), V(dbgs()), FatalErrors(FatalErrors) {
3133 initializeDebugInfoVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3136 bool runOnModule(Module &M) override {
3137 if (!V.verify(M) && FatalErrors)
3138 report_fatal_error("Broken debug info found, compilation aborted!");
3143 void getAnalysisUsage(AnalysisUsage &AU) const override {
3144 AU.setPreservesAll();
3149 char VerifierLegacyPass::ID = 0;
3150 INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
3152 char DebugInfoVerifierLegacyPass::ID = 0;
3153 INITIALIZE_PASS(DebugInfoVerifierLegacyPass, "verify-di", "Debug Info Verifier",
3156 FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
3157 return new VerifierLegacyPass(FatalErrors);
3160 ModulePass *llvm::createDebugInfoVerifierPass(bool FatalErrors) {
3161 return new DebugInfoVerifierLegacyPass(FatalErrors);
3164 PreservedAnalyses VerifierPass::run(Module &M) {
3165 if (verifyModule(M, &dbgs()) && FatalErrors)
3166 report_fatal_error("Broken module found, compilation aborted!");
3168 return PreservedAnalyses::all();
3171 PreservedAnalyses VerifierPass::run(Function &F) {
3172 if (verifyFunction(F, &dbgs()) && FatalErrors)
3173 report_fatal_error("Broken function found, compilation aborted!");
3175 return PreservedAnalyses::all();