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(true));
84 struct VerifierSupport {
88 /// \brief Track the brokenness of the module while recursively visiting.
92 explicit VerifierSupport(raw_ostream &OS)
93 : OS(OS), M(nullptr), Broken(false), EverBroken(false) {}
96 void Write(const Value *V) {
99 if (isa<Instruction>(V)) {
102 V->printAsOperand(OS, true, M);
107 void Write(const Metadata *MD) {
114 void Write(const NamedMDNode *NMD) {
121 void Write(Type *T) {
127 void Write(const Comdat *C) {
133 template <typename T1, typename... Ts>
134 void WriteTs(const T1 &V1, const Ts &... Vs) {
139 template <typename... Ts> void WriteTs() {}
142 /// \brief A check failed, so printout out the condition and the message.
144 /// This provides a nice place to put a breakpoint if you want to see why
145 /// something is not correct.
146 void CheckFailed(const Twine &Message) {
147 OS << Message << '\n';
148 EverBroken = Broken = true;
151 /// \brief A check failed (with values to print).
153 /// This calls the Message-only version so that the above is easier to set a
155 template <typename T1, typename... Ts>
156 void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) {
157 CheckFailed(Message);
162 class Verifier : public InstVisitor<Verifier>, VerifierSupport {
163 friend class InstVisitor<Verifier>;
165 LLVMContext *Context;
168 /// \brief When verifying a basic block, keep track of all of the
169 /// instructions we have seen so far.
171 /// This allows us to do efficient dominance checks for the case when an
172 /// instruction has an operand that is an instruction in the same block.
173 SmallPtrSet<Instruction *, 16> InstsInThisBlock;
175 /// \brief Keep track of the metadata nodes that have been checked already.
176 SmallPtrSet<const Metadata *, 32> MDNodes;
178 /// \brief The personality function referenced by the LandingPadInsts.
179 /// All LandingPadInsts within the same function must use the same
180 /// personality function.
181 const Value *PersonalityFn;
183 /// \brief Whether we've seen a call to @llvm.frameescape in this function
187 /// Stores the count of how many objects were passed to llvm.frameescape for a
188 /// given function and the largest index passed to llvm.framerecover.
189 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
192 explicit Verifier(raw_ostream &OS)
193 : VerifierSupport(OS), Context(nullptr), PersonalityFn(nullptr),
194 SawFrameEscape(false) {}
196 bool verify(const Function &F) {
198 Context = &M->getContext();
200 // First ensure the function is well-enough formed to compute dominance
203 OS << "Function '" << F.getName()
204 << "' does not contain an entry block!\n";
207 for (Function::const_iterator I = F.begin(), E = F.end(); I != E; ++I) {
208 if (I->empty() || !I->back().isTerminator()) {
209 OS << "Basic Block in function '" << F.getName()
210 << "' does not have terminator!\n";
211 I->printAsOperand(OS, true);
217 // Now directly compute a dominance tree. We don't rely on the pass
218 // manager to provide this as it isolates us from a potentially
219 // out-of-date dominator tree and makes it significantly more complex to
220 // run this code outside of a pass manager.
221 // FIXME: It's really gross that we have to cast away constness here.
222 DT.recalculate(const_cast<Function &>(F));
225 // FIXME: We strip const here because the inst visitor strips const.
226 visit(const_cast<Function &>(F));
227 InstsInThisBlock.clear();
228 PersonalityFn = nullptr;
229 SawFrameEscape = false;
234 bool verify(const Module &M) {
236 Context = &M.getContext();
239 // Scan through, checking all of the external function's linkage now...
240 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
241 visitGlobalValue(*I);
243 // Check to make sure function prototypes are okay.
244 if (I->isDeclaration())
248 // Now that we've visited every function, verify that we never asked to
249 // recover a frame index that wasn't escaped.
250 verifyFrameRecoverIndices();
252 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
254 visitGlobalVariable(*I);
256 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
258 visitGlobalAlias(*I);
260 for (Module::const_named_metadata_iterator I = M.named_metadata_begin(),
261 E = M.named_metadata_end();
263 visitNamedMDNode(*I);
265 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
266 visitComdat(SMEC.getValue());
269 visitModuleIdents(M);
271 // Verify debug info last.
278 // Verification methods...
279 void visitGlobalValue(const GlobalValue &GV);
280 void visitGlobalVariable(const GlobalVariable &GV);
281 void visitGlobalAlias(const GlobalAlias &GA);
282 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
283 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
284 const GlobalAlias &A, const Constant &C);
285 void visitNamedMDNode(const NamedMDNode &NMD);
286 void visitMDNode(const MDNode &MD);
287 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
288 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
289 void visitComdat(const Comdat &C);
290 void visitModuleIdents(const Module &M);
291 void visitModuleFlags(const Module &M);
292 void visitModuleFlag(const MDNode *Op,
293 DenseMap<const MDString *, const MDNode *> &SeenIDs,
294 SmallVectorImpl<const MDNode *> &Requirements);
295 void visitFunction(const Function &F);
296 void visitBasicBlock(BasicBlock &BB);
297 void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty);
299 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
300 #include "llvm/IR/Metadata.def"
301 void visitMDVariable(const MDVariable &N);
303 // InstVisitor overrides...
304 using InstVisitor<Verifier>::visit;
305 void visit(Instruction &I);
307 void visitTruncInst(TruncInst &I);
308 void visitZExtInst(ZExtInst &I);
309 void visitSExtInst(SExtInst &I);
310 void visitFPTruncInst(FPTruncInst &I);
311 void visitFPExtInst(FPExtInst &I);
312 void visitFPToUIInst(FPToUIInst &I);
313 void visitFPToSIInst(FPToSIInst &I);
314 void visitUIToFPInst(UIToFPInst &I);
315 void visitSIToFPInst(SIToFPInst &I);
316 void visitIntToPtrInst(IntToPtrInst &I);
317 void visitPtrToIntInst(PtrToIntInst &I);
318 void visitBitCastInst(BitCastInst &I);
319 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
320 void visitPHINode(PHINode &PN);
321 void visitBinaryOperator(BinaryOperator &B);
322 void visitICmpInst(ICmpInst &IC);
323 void visitFCmpInst(FCmpInst &FC);
324 void visitExtractElementInst(ExtractElementInst &EI);
325 void visitInsertElementInst(InsertElementInst &EI);
326 void visitShuffleVectorInst(ShuffleVectorInst &EI);
327 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
328 void visitCallInst(CallInst &CI);
329 void visitInvokeInst(InvokeInst &II);
330 void visitGetElementPtrInst(GetElementPtrInst &GEP);
331 void visitLoadInst(LoadInst &LI);
332 void visitStoreInst(StoreInst &SI);
333 void verifyDominatesUse(Instruction &I, unsigned i);
334 void visitInstruction(Instruction &I);
335 void visitTerminatorInst(TerminatorInst &I);
336 void visitBranchInst(BranchInst &BI);
337 void visitReturnInst(ReturnInst &RI);
338 void visitSwitchInst(SwitchInst &SI);
339 void visitIndirectBrInst(IndirectBrInst &BI);
340 void visitSelectInst(SelectInst &SI);
341 void visitUserOp1(Instruction &I);
342 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
343 void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
344 template <class DbgIntrinsicTy>
345 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
346 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
347 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
348 void visitFenceInst(FenceInst &FI);
349 void visitAllocaInst(AllocaInst &AI);
350 void visitExtractValueInst(ExtractValueInst &EVI);
351 void visitInsertValueInst(InsertValueInst &IVI);
352 void visitLandingPadInst(LandingPadInst &LPI);
354 void VerifyCallSite(CallSite CS);
355 void verifyMustTailCall(CallInst &CI);
356 bool PerformTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
357 unsigned ArgNo, std::string &Suffix);
358 bool VerifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
359 SmallVectorImpl<Type *> &ArgTys);
360 bool VerifyIntrinsicIsVarArg(bool isVarArg,
361 ArrayRef<Intrinsic::IITDescriptor> &Infos);
362 bool VerifyAttributeCount(AttributeSet Attrs, unsigned Params);
363 void VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
365 void VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
366 bool isReturnValue, const Value *V);
367 void VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
370 void VerifyConstantExprBitcastType(const ConstantExpr *CE);
371 void VerifyStatepoint(ImmutableCallSite CS);
372 void verifyFrameRecoverIndices();
374 // Module-level debug info verification...
375 void verifyDebugInfo();
376 void processInstructions(DebugInfoFinder &Finder);
377 void processCallInst(DebugInfoFinder &Finder, const CallInst &CI);
379 } // End anonymous namespace
381 // Assert - We know that cond should be true, if not print an error message.
382 #define Assert(C, ...) \
383 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
385 void Verifier::visit(Instruction &I) {
386 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
387 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
388 InstVisitor<Verifier>::visit(I);
392 void Verifier::visitGlobalValue(const GlobalValue &GV) {
393 Assert(!GV.isDeclaration() || GV.hasExternalLinkage() ||
394 GV.hasExternalWeakLinkage(),
395 "Global is external, but doesn't have external or weak linkage!", &GV);
397 Assert(GV.getAlignment() <= Value::MaximumAlignment,
398 "huge alignment values are unsupported", &GV);
399 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
400 "Only global variables can have appending linkage!", &GV);
402 if (GV.hasAppendingLinkage()) {
403 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
404 Assert(GVar && GVar->getType()->getElementType()->isArrayTy(),
405 "Only global arrays can have appending linkage!", GVar);
409 void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
410 if (GV.hasInitializer()) {
411 Assert(GV.getInitializer()->getType() == GV.getType()->getElementType(),
412 "Global variable initializer type does not match global "
416 // If the global has common linkage, it must have a zero initializer and
417 // cannot be constant.
418 if (GV.hasCommonLinkage()) {
419 Assert(GV.getInitializer()->isNullValue(),
420 "'common' global must have a zero initializer!", &GV);
421 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
423 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
426 Assert(GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
427 "invalid linkage type for global declaration", &GV);
430 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
431 GV.getName() == "llvm.global_dtors")) {
432 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
433 "invalid linkage for intrinsic global variable", &GV);
434 // Don't worry about emitting an error for it not being an array,
435 // visitGlobalValue will complain on appending non-array.
436 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getType()->getElementType())) {
437 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
438 PointerType *FuncPtrTy =
439 FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
440 // FIXME: Reject the 2-field form in LLVM 4.0.
442 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
443 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
444 STy->getTypeAtIndex(1) == FuncPtrTy,
445 "wrong type for intrinsic global variable", &GV);
446 if (STy->getNumElements() == 3) {
447 Type *ETy = STy->getTypeAtIndex(2);
448 Assert(ETy->isPointerTy() &&
449 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
450 "wrong type for intrinsic global variable", &GV);
455 if (GV.hasName() && (GV.getName() == "llvm.used" ||
456 GV.getName() == "llvm.compiler.used")) {
457 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
458 "invalid linkage for intrinsic global variable", &GV);
459 Type *GVType = GV.getType()->getElementType();
460 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
461 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
462 Assert(PTy, "wrong type for intrinsic global variable", &GV);
463 if (GV.hasInitializer()) {
464 const Constant *Init = GV.getInitializer();
465 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
466 Assert(InitArray, "wrong initalizer for intrinsic global variable",
468 for (unsigned i = 0, e = InitArray->getNumOperands(); i != e; ++i) {
469 Value *V = Init->getOperand(i)->stripPointerCastsNoFollowAliases();
470 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
472 "invalid llvm.used member", V);
473 Assert(V->hasName(), "members of llvm.used must be named", V);
479 Assert(!GV.hasDLLImportStorageClass() ||
480 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
481 GV.hasAvailableExternallyLinkage(),
482 "Global is marked as dllimport, but not external", &GV);
484 if (!GV.hasInitializer()) {
485 visitGlobalValue(GV);
489 // Walk any aggregate initializers looking for bitcasts between address spaces
490 SmallPtrSet<const Value *, 4> Visited;
491 SmallVector<const Value *, 4> WorkStack;
492 WorkStack.push_back(cast<Value>(GV.getInitializer()));
494 while (!WorkStack.empty()) {
495 const Value *V = WorkStack.pop_back_val();
496 if (!Visited.insert(V).second)
499 if (const User *U = dyn_cast<User>(V)) {
500 WorkStack.append(U->op_begin(), U->op_end());
503 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
504 VerifyConstantExprBitcastType(CE);
510 visitGlobalValue(GV);
513 void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
514 SmallPtrSet<const GlobalAlias*, 4> Visited;
516 visitAliaseeSubExpr(Visited, GA, C);
519 void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
520 const GlobalAlias &GA, const Constant &C) {
521 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
522 Assert(!GV->isDeclaration(), "Alias must point to a definition", &GA);
524 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
525 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
527 Assert(!GA2->mayBeOverridden(), "Alias cannot point to a weak alias",
530 // Only continue verifying subexpressions of GlobalAliases.
531 // Do not recurse into global initializers.
536 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
537 VerifyConstantExprBitcastType(CE);
539 for (const Use &U : C.operands()) {
541 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
542 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
543 else if (const auto *C2 = dyn_cast<Constant>(V))
544 visitAliaseeSubExpr(Visited, GA, *C2);
548 void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
549 Assert(!GA.getName().empty(), "Alias name cannot be empty!", &GA);
550 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
551 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
552 "weak_odr, or external linkage!",
554 const Constant *Aliasee = GA.getAliasee();
555 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
556 Assert(GA.getType() == Aliasee->getType(),
557 "Alias and aliasee types should match!", &GA);
559 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
560 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
562 visitAliaseeSubExpr(GA, *Aliasee);
564 visitGlobalValue(GA);
567 void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
568 for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i) {
569 MDNode *MD = NMD.getOperand(i);
573 if (NMD.getName() == "llvm.dbg.cu") {
574 Assert(isa<MDCompileUnit>(MD), "invalid compile unit", &NMD, MD);
581 void Verifier::visitMDNode(const MDNode &MD) {
582 // Only visit each node once. Metadata can be mutually recursive, so this
583 // avoids infinite recursion here, as well as being an optimization.
584 if (!MDNodes.insert(&MD).second)
587 switch (MD.getMetadataID()) {
589 llvm_unreachable("Invalid MDNode subclass");
590 case Metadata::MDTupleKind:
592 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
593 case Metadata::CLASS##Kind: \
594 visit##CLASS(cast<CLASS>(MD)); \
596 #include "llvm/IR/Metadata.def"
599 for (unsigned i = 0, e = MD.getNumOperands(); i != e; ++i) {
600 Metadata *Op = MD.getOperand(i);
603 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
605 if (auto *N = dyn_cast<MDNode>(Op)) {
609 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
610 visitValueAsMetadata(*V, nullptr);
615 // Check these last, so we diagnose problems in operands first.
616 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
617 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
620 void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
621 Assert(MD.getValue(), "Expected valid value", &MD);
622 Assert(!MD.getValue()->getType()->isMetadataTy(),
623 "Unexpected metadata round-trip through values", &MD, MD.getValue());
625 auto *L = dyn_cast<LocalAsMetadata>(&MD);
629 Assert(F, "function-local metadata used outside a function", L);
631 // If this was an instruction, bb, or argument, verify that it is in the
632 // function that we expect.
633 Function *ActualF = nullptr;
634 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
635 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
636 ActualF = I->getParent()->getParent();
637 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
638 ActualF = BB->getParent();
639 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
640 ActualF = A->getParent();
641 assert(ActualF && "Unimplemented function local metadata case!");
643 Assert(ActualF == F, "function-local metadata used in wrong function", L);
646 void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
647 Metadata *MD = MDV.getMetadata();
648 if (auto *N = dyn_cast<MDNode>(MD)) {
653 // Only visit each node once. Metadata can be mutually recursive, so this
654 // avoids infinite recursion here, as well as being an optimization.
655 if (!MDNodes.insert(MD).second)
658 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
659 visitValueAsMetadata(*V, F);
662 /// \brief Check if a value can be a reference to a type.
663 static bool isTypeRef(const Metadata *MD) {
666 if (auto *S = dyn_cast<MDString>(MD))
667 return !S->getString().empty();
668 return isa<MDType>(MD);
671 void Verifier::visitMDLocation(const MDLocation &N) {
672 Assert(N.getRawScope() && isa<MDLocalScope>(N.getRawScope()),
673 "location requires a valid scope", &N, N.getRawScope());
674 if (auto *IA = N.getRawInlinedAt())
675 Assert(isa<MDLocation>(IA), "inlined-at should be a location", &N, IA);
678 void Verifier::visitGenericDebugNode(const GenericDebugNode &N) {
679 Assert(N.getTag(), "invalid tag", &N);
682 void Verifier::visitMDSubrange(const MDSubrange &N) {
683 Assert(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
686 void Verifier::visitMDEnumerator(const MDEnumerator &N) {
687 Assert(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
690 void Verifier::visitMDBasicType(const MDBasicType &N) {
691 Assert(N.getTag() == dwarf::DW_TAG_base_type ||
692 N.getTag() == dwarf::DW_TAG_unspecified_type,
696 void Verifier::visitMDDerivedType(const MDDerivedType &N) {
697 Assert(N.getTag() == dwarf::DW_TAG_typedef ||
698 N.getTag() == dwarf::DW_TAG_pointer_type ||
699 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
700 N.getTag() == dwarf::DW_TAG_reference_type ||
701 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
702 N.getTag() == dwarf::DW_TAG_const_type ||
703 N.getTag() == dwarf::DW_TAG_volatile_type ||
704 N.getTag() == dwarf::DW_TAG_restrict_type ||
705 N.getTag() == dwarf::DW_TAG_member ||
706 N.getTag() == dwarf::DW_TAG_inheritance ||
707 N.getTag() == dwarf::DW_TAG_friend,
711 void Verifier::visitMDCompositeType(const MDCompositeType &N) {
712 Assert(N.getTag() == dwarf::DW_TAG_array_type ||
713 N.getTag() == dwarf::DW_TAG_structure_type ||
714 N.getTag() == dwarf::DW_TAG_union_type ||
715 N.getTag() == dwarf::DW_TAG_enumeration_type ||
716 N.getTag() == dwarf::DW_TAG_subroutine_type ||
717 N.getTag() == dwarf::DW_TAG_class_type,
721 void Verifier::visitMDSubroutineType(const MDSubroutineType &N) {
722 Assert(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
725 void Verifier::visitMDFile(const MDFile &N) {
726 Assert(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
729 void Verifier::visitMDCompileUnit(const MDCompileUnit &N) {
730 Assert(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
733 void Verifier::visitMDSubprogram(const MDSubprogram &N) {
734 Assert(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
737 void Verifier::visitMDLexicalBlock(const MDLexicalBlock &N) {
738 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
741 void Verifier::visitMDLexicalBlockFile(const MDLexicalBlockFile &N) {
742 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
745 void Verifier::visitMDNamespace(const MDNamespace &N) {
746 Assert(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
749 void Verifier::visitMDTemplateTypeParameter(const MDTemplateTypeParameter &N) {
750 Assert(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
754 void Verifier::visitMDTemplateValueParameter(
755 const MDTemplateValueParameter &N) {
756 Assert(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
757 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
758 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
762 void Verifier::visitMDVariable(const MDVariable &N) {
763 if (auto *S = N.getRawScope())
764 Assert(isa<MDScope>(S), "invalid scope", &N, S);
765 Assert(isTypeRef(N.getRawType()), "invalid type ref", &N, N.getRawType());
766 if (auto *F = N.getRawFile())
767 Assert(isa<MDFile>(F), "invalid file", &N, F);
770 void Verifier::visitMDGlobalVariable(const MDGlobalVariable &N) {
771 // Checks common to all variables.
774 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
775 if (auto *V = N.getRawVariable()) {
776 Assert(isa<ConstantAsMetadata>(V) &&
777 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
778 "invalid global varaible ref", &N, V);
780 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
781 Assert(isa<MDDerivedType>(Member), "invalid static data member declaration",
786 void Verifier::visitMDLocalVariable(const MDLocalVariable &N) {
787 // Checks common to all variables.
790 Assert(N.getTag() == dwarf::DW_TAG_auto_variable ||
791 N.getTag() == dwarf::DW_TAG_arg_variable,
793 Assert(N.getRawScope() && isa<MDLocalScope>(N.getRawScope()),
794 "local variable requires a valid scope", &N, N.getRawScope());
795 if (auto *IA = N.getRawInlinedAt())
796 Assert(isa<MDLocation>(IA), "local variable requires a valid scope", &N,
800 void Verifier::visitMDExpression(const MDExpression &N) {
801 Assert(N.isValid(), "invalid expression", &N);
804 void Verifier::visitMDObjCProperty(const MDObjCProperty &N) {
805 Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
808 void Verifier::visitMDImportedEntity(const MDImportedEntity &N) {
809 Assert(N.getTag() == dwarf::DW_TAG_imported_module ||
810 N.getTag() == dwarf::DW_TAG_imported_declaration,
814 void Verifier::visitComdat(const Comdat &C) {
815 // The Module is invalid if the GlobalValue has private linkage. Entities
816 // with private linkage don't have entries in the symbol table.
817 if (const GlobalValue *GV = M->getNamedValue(C.getName()))
818 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
822 void Verifier::visitModuleIdents(const Module &M) {
823 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
827 // llvm.ident takes a list of metadata entry. Each entry has only one string.
828 // Scan each llvm.ident entry and make sure that this requirement is met.
829 for (unsigned i = 0, e = Idents->getNumOperands(); i != e; ++i) {
830 const MDNode *N = Idents->getOperand(i);
831 Assert(N->getNumOperands() == 1,
832 "incorrect number of operands in llvm.ident metadata", N);
833 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
834 ("invalid value for llvm.ident metadata entry operand"
835 "(the operand should be a string)"),
840 void Verifier::visitModuleFlags(const Module &M) {
841 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
844 // Scan each flag, and track the flags and requirements.
845 DenseMap<const MDString*, const MDNode*> SeenIDs;
846 SmallVector<const MDNode*, 16> Requirements;
847 for (unsigned I = 0, E = Flags->getNumOperands(); I != E; ++I) {
848 visitModuleFlag(Flags->getOperand(I), SeenIDs, Requirements);
851 // Validate that the requirements in the module are valid.
852 for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
853 const MDNode *Requirement = Requirements[I];
854 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
855 const Metadata *ReqValue = Requirement->getOperand(1);
857 const MDNode *Op = SeenIDs.lookup(Flag);
859 CheckFailed("invalid requirement on flag, flag is not present in module",
864 if (Op->getOperand(2) != ReqValue) {
865 CheckFailed(("invalid requirement on flag, "
866 "flag does not have the required value"),
874 Verifier::visitModuleFlag(const MDNode *Op,
875 DenseMap<const MDString *, const MDNode *> &SeenIDs,
876 SmallVectorImpl<const MDNode *> &Requirements) {
877 // Each module flag should have three arguments, the merge behavior (a
878 // constant int), the flag ID (an MDString), and the value.
879 Assert(Op->getNumOperands() == 3,
880 "incorrect number of operands in module flag", Op);
881 Module::ModFlagBehavior MFB;
882 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
884 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
885 "invalid behavior operand in module flag (expected constant integer)",
888 "invalid behavior operand in module flag (unexpected constant)",
891 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
892 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
895 // Sanity check the values for behaviors with additional requirements.
898 case Module::Warning:
899 case Module::Override:
900 // These behavior types accept any value.
903 case Module::Require: {
904 // The value should itself be an MDNode with two operands, a flag ID (an
905 // MDString), and a value.
906 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
907 Assert(Value && Value->getNumOperands() == 2,
908 "invalid value for 'require' module flag (expected metadata pair)",
910 Assert(isa<MDString>(Value->getOperand(0)),
911 ("invalid value for 'require' module flag "
912 "(first value operand should be a string)"),
913 Value->getOperand(0));
915 // Append it to the list of requirements, to check once all module flags are
917 Requirements.push_back(Value);
922 case Module::AppendUnique: {
923 // These behavior types require the operand be an MDNode.
924 Assert(isa<MDNode>(Op->getOperand(2)),
925 "invalid value for 'append'-type module flag "
926 "(expected a metadata node)",
932 // Unless this is a "requires" flag, check the ID is unique.
933 if (MFB != Module::Require) {
934 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
936 "module flag identifiers must be unique (or of 'require' type)", ID);
940 void Verifier::VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
941 bool isFunction, const Value *V) {
943 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
944 if (Attrs.getSlotIndex(I) == Idx) {
949 assert(Slot != ~0U && "Attribute set inconsistency!");
951 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
953 if (I->isStringAttribute())
956 if (I->getKindAsEnum() == Attribute::NoReturn ||
957 I->getKindAsEnum() == Attribute::NoUnwind ||
958 I->getKindAsEnum() == Attribute::NoInline ||
959 I->getKindAsEnum() == Attribute::AlwaysInline ||
960 I->getKindAsEnum() == Attribute::OptimizeForSize ||
961 I->getKindAsEnum() == Attribute::StackProtect ||
962 I->getKindAsEnum() == Attribute::StackProtectReq ||
963 I->getKindAsEnum() == Attribute::StackProtectStrong ||
964 I->getKindAsEnum() == Attribute::NoRedZone ||
965 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
966 I->getKindAsEnum() == Attribute::Naked ||
967 I->getKindAsEnum() == Attribute::InlineHint ||
968 I->getKindAsEnum() == Attribute::StackAlignment ||
969 I->getKindAsEnum() == Attribute::UWTable ||
970 I->getKindAsEnum() == Attribute::NonLazyBind ||
971 I->getKindAsEnum() == Attribute::ReturnsTwice ||
972 I->getKindAsEnum() == Attribute::SanitizeAddress ||
973 I->getKindAsEnum() == Attribute::SanitizeThread ||
974 I->getKindAsEnum() == Attribute::SanitizeMemory ||
975 I->getKindAsEnum() == Attribute::MinSize ||
976 I->getKindAsEnum() == Attribute::NoDuplicate ||
977 I->getKindAsEnum() == Attribute::Builtin ||
978 I->getKindAsEnum() == Attribute::NoBuiltin ||
979 I->getKindAsEnum() == Attribute::Cold ||
980 I->getKindAsEnum() == Attribute::OptimizeNone ||
981 I->getKindAsEnum() == Attribute::JumpTable) {
983 CheckFailed("Attribute '" + I->getAsString() +
984 "' only applies to functions!", V);
987 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
988 I->getKindAsEnum() == Attribute::ReadNone) {
990 CheckFailed("Attribute '" + I->getAsString() +
991 "' does not apply to function returns");
994 } else if (isFunction) {
995 CheckFailed("Attribute '" + I->getAsString() +
996 "' does not apply to functions!", V);
1002 // VerifyParameterAttrs - Check the given attributes for an argument or return
1003 // value of the specified type. The value V is printed in error messages.
1004 void Verifier::VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
1005 bool isReturnValue, const Value *V) {
1006 if (!Attrs.hasAttributes(Idx))
1009 VerifyAttributeTypes(Attrs, Idx, false, V);
1012 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1013 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1014 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1015 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1016 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
1017 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1018 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', and "
1019 "'returned' do not apply to return values!",
1022 // Check for mutually incompatible attributes. Only inreg is compatible with
1024 unsigned AttrCount = 0;
1025 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1026 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1027 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1028 Attrs.hasAttribute(Idx, Attribute::InReg);
1029 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
1030 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1031 "and 'sret' are incompatible!",
1034 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1035 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1037 "'inalloca and readonly' are incompatible!",
1040 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1041 Attrs.hasAttribute(Idx, Attribute::Returned)),
1043 "'sret and returned' are incompatible!",
1046 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1047 Attrs.hasAttribute(Idx, Attribute::SExt)),
1049 "'zeroext and signext' are incompatible!",
1052 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1053 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1055 "'readnone and readonly' are incompatible!",
1058 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1059 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1061 "'noinline and alwaysinline' are incompatible!",
1064 Assert(!AttrBuilder(Attrs, Idx)
1065 .hasAttributes(AttributeFuncs::typeIncompatible(Ty, Idx), Idx),
1066 "Wrong types for attribute: " +
1067 AttributeFuncs::typeIncompatible(Ty, Idx).getAsString(Idx),
1070 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
1071 SmallPtrSet<const Type*, 4> Visited;
1072 if (!PTy->getElementType()->isSized(&Visited)) {
1073 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1074 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1075 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1079 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1080 "Attribute 'byval' only applies to parameters with pointer type!",
1085 // VerifyFunctionAttrs - Check parameter attributes against a function type.
1086 // The value V is printed in error messages.
1087 void Verifier::VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
1089 if (Attrs.isEmpty())
1092 bool SawNest = false;
1093 bool SawReturned = false;
1094 bool SawSRet = false;
1096 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
1097 unsigned Idx = Attrs.getSlotIndex(i);
1101 Ty = FT->getReturnType();
1102 else if (Idx-1 < FT->getNumParams())
1103 Ty = FT->getParamType(Idx-1);
1105 break; // VarArgs attributes, verified elsewhere.
1107 VerifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
1112 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
1113 Assert(!SawNest, "More than one parameter has attribute nest!", V);
1117 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
1118 Assert(!SawReturned, "More than one parameter has attribute returned!",
1120 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1122 "argument and return types for 'returned' attribute",
1127 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
1128 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1129 Assert(Idx == 1 || Idx == 2,
1130 "Attribute 'sret' is not on first or second parameter!", V);
1134 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
1135 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1140 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1143 VerifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
1146 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1147 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1148 "Attributes 'readnone and readonly' are incompatible!", V);
1151 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1152 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1153 Attribute::AlwaysInline)),
1154 "Attributes 'noinline and alwaysinline' are incompatible!", V);
1156 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1157 Attribute::OptimizeNone)) {
1158 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1159 "Attribute 'optnone' requires 'noinline'!", V);
1161 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1162 Attribute::OptimizeForSize),
1163 "Attributes 'optsize and optnone' are incompatible!", V);
1165 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1166 "Attributes 'minsize and optnone' are incompatible!", V);
1169 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1170 Attribute::JumpTable)) {
1171 const GlobalValue *GV = cast<GlobalValue>(V);
1172 Assert(GV->hasUnnamedAddr(),
1173 "Attribute 'jumptable' requires 'unnamed_addr'", V);
1177 void Verifier::VerifyConstantExprBitcastType(const ConstantExpr *CE) {
1178 if (CE->getOpcode() != Instruction::BitCast)
1181 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1183 "Invalid bitcast", CE);
1186 bool Verifier::VerifyAttributeCount(AttributeSet Attrs, unsigned Params) {
1187 if (Attrs.getNumSlots() == 0)
1190 unsigned LastSlot = Attrs.getNumSlots() - 1;
1191 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
1192 if (LastIndex <= Params
1193 || (LastIndex == AttributeSet::FunctionIndex
1194 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
1200 /// \brief Verify that statepoint intrinsic is well formed.
1201 void Verifier::VerifyStatepoint(ImmutableCallSite CS) {
1202 assert(CS.getCalledFunction() &&
1203 CS.getCalledFunction()->getIntrinsicID() ==
1204 Intrinsic::experimental_gc_statepoint);
1206 const Instruction &CI = *CS.getInstruction();
1208 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory(),
1209 "gc.statepoint must read and write memory to preserve "
1210 "reordering restrictions required by safepoint semantics",
1213 const Value *Target = CS.getArgument(0);
1214 const PointerType *PT = dyn_cast<PointerType>(Target->getType());
1215 Assert(PT && PT->getElementType()->isFunctionTy(),
1216 "gc.statepoint callee must be of function pointer type", &CI, Target);
1217 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
1219 const Value *NumCallArgsV = CS.getArgument(1);
1220 Assert(isa<ConstantInt>(NumCallArgsV),
1221 "gc.statepoint number of arguments to underlying call "
1222 "must be constant integer",
1224 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
1225 Assert(NumCallArgs >= 0,
1226 "gc.statepoint number of arguments to underlying call "
1229 const int NumParams = (int)TargetFuncType->getNumParams();
1230 if (TargetFuncType->isVarArg()) {
1231 Assert(NumCallArgs >= NumParams,
1232 "gc.statepoint mismatch in number of vararg call args", &CI);
1234 // TODO: Remove this limitation
1235 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1236 "gc.statepoint doesn't support wrapping non-void "
1237 "vararg functions yet",
1240 Assert(NumCallArgs == NumParams,
1241 "gc.statepoint mismatch in number of call args", &CI);
1243 const Value *Unused = CS.getArgument(2);
1244 Assert(isa<ConstantInt>(Unused) && cast<ConstantInt>(Unused)->isNullValue(),
1245 "gc.statepoint parameter #3 must be zero", &CI);
1247 // Verify that the types of the call parameter arguments match
1248 // the type of the wrapped callee.
1249 for (int i = 0; i < NumParams; i++) {
1250 Type *ParamType = TargetFuncType->getParamType(i);
1251 Type *ArgType = CS.getArgument(3+i)->getType();
1252 Assert(ArgType == ParamType,
1253 "gc.statepoint call argument does not match wrapped "
1257 const int EndCallArgsInx = 2+NumCallArgs;
1258 const Value *NumDeoptArgsV = CS.getArgument(EndCallArgsInx+1);
1259 Assert(isa<ConstantInt>(NumDeoptArgsV),
1260 "gc.statepoint number of deoptimization arguments "
1261 "must be constant integer",
1263 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
1264 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1268 Assert(4 + NumCallArgs + NumDeoptArgs <= (int)CS.arg_size(),
1269 "gc.statepoint too few arguments according to length fields", &CI);
1271 // Check that the only uses of this gc.statepoint are gc.result or
1272 // gc.relocate calls which are tied to this statepoint and thus part
1273 // of the same statepoint sequence
1274 for (const User *U : CI.users()) {
1275 const CallInst *Call = dyn_cast<const CallInst>(U);
1276 Assert(Call, "illegal use of statepoint token", &CI, U);
1277 if (!Call) continue;
1278 Assert(isGCRelocate(Call) || isGCResult(Call),
1279 "gc.result or gc.relocate are the only value uses"
1280 "of a gc.statepoint",
1282 if (isGCResult(Call)) {
1283 Assert(Call->getArgOperand(0) == &CI,
1284 "gc.result connected to wrong gc.statepoint", &CI, Call);
1285 } else if (isGCRelocate(Call)) {
1286 Assert(Call->getArgOperand(0) == &CI,
1287 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
1291 // Note: It is legal for a single derived pointer to be listed multiple
1292 // times. It's non-optimal, but it is legal. It can also happen after
1293 // insertion if we strip a bitcast away.
1294 // Note: It is really tempting to check that each base is relocated and
1295 // that a derived pointer is never reused as a base pointer. This turns
1296 // out to be problematic since optimizations run after safepoint insertion
1297 // can recognize equality properties that the insertion logic doesn't know
1298 // about. See example statepoint.ll in the verifier subdirectory
1301 void Verifier::verifyFrameRecoverIndices() {
1302 for (auto &Counts : FrameEscapeInfo) {
1303 Function *F = Counts.first;
1304 unsigned EscapedObjectCount = Counts.second.first;
1305 unsigned MaxRecoveredIndex = Counts.second.second;
1306 Assert(MaxRecoveredIndex <= EscapedObjectCount,
1307 "all indices passed to llvm.framerecover must be less than the "
1308 "number of arguments passed ot llvm.frameescape in the parent "
1314 // visitFunction - Verify that a function is ok.
1316 void Verifier::visitFunction(const Function &F) {
1317 // Check function arguments.
1318 FunctionType *FT = F.getFunctionType();
1319 unsigned NumArgs = F.arg_size();
1321 Assert(Context == &F.getContext(),
1322 "Function context does not match Module context!", &F);
1324 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1325 Assert(FT->getNumParams() == NumArgs,
1326 "# formal arguments must match # of arguments for function type!", &F,
1328 Assert(F.getReturnType()->isFirstClassType() ||
1329 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1330 "Functions cannot return aggregate values!", &F);
1332 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1333 "Invalid struct return type!", &F);
1335 AttributeSet Attrs = F.getAttributes();
1337 Assert(VerifyAttributeCount(Attrs, FT->getNumParams()),
1338 "Attribute after last parameter!", &F);
1340 // Check function attributes.
1341 VerifyFunctionAttrs(FT, Attrs, &F);
1343 // On function declarations/definitions, we do not support the builtin
1344 // attribute. We do not check this in VerifyFunctionAttrs since that is
1345 // checking for Attributes that can/can not ever be on functions.
1346 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1347 "Attribute 'builtin' can only be applied to a callsite.", &F);
1349 // Check that this function meets the restrictions on this calling convention.
1350 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1351 // restrictions can be lifted.
1352 switch (F.getCallingConv()) {
1354 case CallingConv::C:
1356 case CallingConv::Fast:
1357 case CallingConv::Cold:
1358 case CallingConv::Intel_OCL_BI:
1359 case CallingConv::PTX_Kernel:
1360 case CallingConv::PTX_Device:
1361 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1362 "perfect forwarding!",
1367 bool isLLVMdotName = F.getName().size() >= 5 &&
1368 F.getName().substr(0, 5) == "llvm.";
1370 // Check that the argument values match the function type for this function...
1372 for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E;
1374 Assert(I->getType() == FT->getParamType(i),
1375 "Argument value does not match function argument type!", I,
1376 FT->getParamType(i));
1377 Assert(I->getType()->isFirstClassType(),
1378 "Function arguments must have first-class types!", I);
1380 Assert(!I->getType()->isMetadataTy(),
1381 "Function takes metadata but isn't an intrinsic", I, &F);
1384 if (F.isMaterializable()) {
1385 // Function has a body somewhere we can't see.
1386 } else if (F.isDeclaration()) {
1387 Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1388 "invalid linkage type for function declaration", &F);
1390 // Verify that this function (which has a body) is not named "llvm.*". It
1391 // is not legal to define intrinsics.
1392 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
1394 // Check the entry node
1395 const BasicBlock *Entry = &F.getEntryBlock();
1396 Assert(pred_empty(Entry),
1397 "Entry block to function must not have predecessors!", Entry);
1399 // The address of the entry block cannot be taken, unless it is dead.
1400 if (Entry->hasAddressTaken()) {
1401 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1402 "blockaddress may not be used with the entry block!", Entry);
1406 // If this function is actually an intrinsic, verify that it is only used in
1407 // direct call/invokes, never having its "address taken".
1408 if (F.getIntrinsicID()) {
1410 if (F.hasAddressTaken(&U))
1411 Assert(0, "Invalid user of intrinsic instruction!", U);
1414 Assert(!F.hasDLLImportStorageClass() ||
1415 (F.isDeclaration() && F.hasExternalLinkage()) ||
1416 F.hasAvailableExternallyLinkage(),
1417 "Function is marked as dllimport, but not external.", &F);
1420 // verifyBasicBlock - Verify that a basic block is well formed...
1422 void Verifier::visitBasicBlock(BasicBlock &BB) {
1423 InstsInThisBlock.clear();
1425 // Ensure that basic blocks have terminators!
1426 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
1428 // Check constraints that this basic block imposes on all of the PHI nodes in
1430 if (isa<PHINode>(BB.front())) {
1431 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
1432 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
1433 std::sort(Preds.begin(), Preds.end());
1435 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
1436 // Ensure that PHI nodes have at least one entry!
1437 Assert(PN->getNumIncomingValues() != 0,
1438 "PHI nodes must have at least one entry. If the block is dead, "
1439 "the PHI should be removed!",
1441 Assert(PN->getNumIncomingValues() == Preds.size(),
1442 "PHINode should have one entry for each predecessor of its "
1443 "parent basic block!",
1446 // Get and sort all incoming values in the PHI node...
1448 Values.reserve(PN->getNumIncomingValues());
1449 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1450 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
1451 PN->getIncomingValue(i)));
1452 std::sort(Values.begin(), Values.end());
1454 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
1455 // Check to make sure that if there is more than one entry for a
1456 // particular basic block in this PHI node, that the incoming values are
1459 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
1460 Values[i].second == Values[i - 1].second,
1461 "PHI node has multiple entries for the same basic block with "
1462 "different incoming values!",
1463 PN, Values[i].first, Values[i].second, Values[i - 1].second);
1465 // Check to make sure that the predecessors and PHI node entries are
1467 Assert(Values[i].first == Preds[i],
1468 "PHI node entries do not match predecessors!", PN,
1469 Values[i].first, Preds[i]);
1474 // Check that all instructions have their parent pointers set up correctly.
1477 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
1481 void Verifier::visitTerminatorInst(TerminatorInst &I) {
1482 // Ensure that terminators only exist at the end of the basic block.
1483 Assert(&I == I.getParent()->getTerminator(),
1484 "Terminator found in the middle of a basic block!", I.getParent());
1485 visitInstruction(I);
1488 void Verifier::visitBranchInst(BranchInst &BI) {
1489 if (BI.isConditional()) {
1490 Assert(BI.getCondition()->getType()->isIntegerTy(1),
1491 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
1493 visitTerminatorInst(BI);
1496 void Verifier::visitReturnInst(ReturnInst &RI) {
1497 Function *F = RI.getParent()->getParent();
1498 unsigned N = RI.getNumOperands();
1499 if (F->getReturnType()->isVoidTy())
1501 "Found return instr that returns non-void in Function of void "
1503 &RI, F->getReturnType());
1505 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
1506 "Function return type does not match operand "
1507 "type of return inst!",
1508 &RI, F->getReturnType());
1510 // Check to make sure that the return value has necessary properties for
1512 visitTerminatorInst(RI);
1515 void Verifier::visitSwitchInst(SwitchInst &SI) {
1516 // Check to make sure that all of the constants in the switch instruction
1517 // have the same type as the switched-on value.
1518 Type *SwitchTy = SI.getCondition()->getType();
1519 SmallPtrSet<ConstantInt*, 32> Constants;
1520 for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end(); i != e; ++i) {
1521 Assert(i.getCaseValue()->getType() == SwitchTy,
1522 "Switch constants must all be same type as switch value!", &SI);
1523 Assert(Constants.insert(i.getCaseValue()).second,
1524 "Duplicate integer as switch case", &SI, i.getCaseValue());
1527 visitTerminatorInst(SI);
1530 void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
1531 Assert(BI.getAddress()->getType()->isPointerTy(),
1532 "Indirectbr operand must have pointer type!", &BI);
1533 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
1534 Assert(BI.getDestination(i)->getType()->isLabelTy(),
1535 "Indirectbr destinations must all have pointer type!", &BI);
1537 visitTerminatorInst(BI);
1540 void Verifier::visitSelectInst(SelectInst &SI) {
1541 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
1543 "Invalid operands for select instruction!", &SI);
1545 Assert(SI.getTrueValue()->getType() == SI.getType(),
1546 "Select values must have same type as select instruction!", &SI);
1547 visitInstruction(SI);
1550 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
1551 /// a pass, if any exist, it's an error.
1553 void Verifier::visitUserOp1(Instruction &I) {
1554 Assert(0, "User-defined operators should not live outside of a pass!", &I);
1557 void Verifier::visitTruncInst(TruncInst &I) {
1558 // Get the source and destination types
1559 Type *SrcTy = I.getOperand(0)->getType();
1560 Type *DestTy = I.getType();
1562 // Get the size of the types in bits, we'll need this later
1563 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1564 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1566 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
1567 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
1568 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1569 "trunc source and destination must both be a vector or neither", &I);
1570 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
1572 visitInstruction(I);
1575 void Verifier::visitZExtInst(ZExtInst &I) {
1576 // Get the source and destination types
1577 Type *SrcTy = I.getOperand(0)->getType();
1578 Type *DestTy = I.getType();
1580 // Get the size of the types in bits, we'll need this later
1581 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
1582 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
1583 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1584 "zext source and destination must both be a vector or neither", &I);
1585 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1586 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1588 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
1590 visitInstruction(I);
1593 void Verifier::visitSExtInst(SExtInst &I) {
1594 // Get the source and destination types
1595 Type *SrcTy = I.getOperand(0)->getType();
1596 Type *DestTy = I.getType();
1598 // Get the size of the types in bits, we'll need this later
1599 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1600 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1602 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
1603 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
1604 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1605 "sext source and destination must both be a vector or neither", &I);
1606 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
1608 visitInstruction(I);
1611 void Verifier::visitFPTruncInst(FPTruncInst &I) {
1612 // Get the source and destination types
1613 Type *SrcTy = I.getOperand(0)->getType();
1614 Type *DestTy = I.getType();
1615 // Get the size of the types in bits, we'll need this later
1616 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1617 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1619 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
1620 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
1621 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1622 "fptrunc source and destination must both be a vector or neither", &I);
1623 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
1625 visitInstruction(I);
1628 void Verifier::visitFPExtInst(FPExtInst &I) {
1629 // Get the source and destination types
1630 Type *SrcTy = I.getOperand(0)->getType();
1631 Type *DestTy = I.getType();
1633 // Get the size of the types in bits, we'll need this later
1634 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1635 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1637 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
1638 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
1639 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1640 "fpext source and destination must both be a vector or neither", &I);
1641 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
1643 visitInstruction(I);
1646 void Verifier::visitUIToFPInst(UIToFPInst &I) {
1647 // Get the source and destination types
1648 Type *SrcTy = I.getOperand(0)->getType();
1649 Type *DestTy = I.getType();
1651 bool SrcVec = SrcTy->isVectorTy();
1652 bool DstVec = DestTy->isVectorTy();
1654 Assert(SrcVec == DstVec,
1655 "UIToFP source and dest must both be vector or scalar", &I);
1656 Assert(SrcTy->isIntOrIntVectorTy(),
1657 "UIToFP source must be integer or integer vector", &I);
1658 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
1661 if (SrcVec && DstVec)
1662 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
1663 cast<VectorType>(DestTy)->getNumElements(),
1664 "UIToFP source and dest vector length mismatch", &I);
1666 visitInstruction(I);
1669 void Verifier::visitSIToFPInst(SIToFPInst &I) {
1670 // Get the source and destination types
1671 Type *SrcTy = I.getOperand(0)->getType();
1672 Type *DestTy = I.getType();
1674 bool SrcVec = SrcTy->isVectorTy();
1675 bool DstVec = DestTy->isVectorTy();
1677 Assert(SrcVec == DstVec,
1678 "SIToFP source and dest must both be vector or scalar", &I);
1679 Assert(SrcTy->isIntOrIntVectorTy(),
1680 "SIToFP source must be integer or integer vector", &I);
1681 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
1684 if (SrcVec && DstVec)
1685 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
1686 cast<VectorType>(DestTy)->getNumElements(),
1687 "SIToFP source and dest vector length mismatch", &I);
1689 visitInstruction(I);
1692 void Verifier::visitFPToUIInst(FPToUIInst &I) {
1693 // Get the source and destination types
1694 Type *SrcTy = I.getOperand(0)->getType();
1695 Type *DestTy = I.getType();
1697 bool SrcVec = SrcTy->isVectorTy();
1698 bool DstVec = DestTy->isVectorTy();
1700 Assert(SrcVec == DstVec,
1701 "FPToUI source and dest must both be vector or scalar", &I);
1702 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
1704 Assert(DestTy->isIntOrIntVectorTy(),
1705 "FPToUI result must be integer or integer vector", &I);
1707 if (SrcVec && DstVec)
1708 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
1709 cast<VectorType>(DestTy)->getNumElements(),
1710 "FPToUI source and dest vector length mismatch", &I);
1712 visitInstruction(I);
1715 void Verifier::visitFPToSIInst(FPToSIInst &I) {
1716 // Get the source and destination types
1717 Type *SrcTy = I.getOperand(0)->getType();
1718 Type *DestTy = I.getType();
1720 bool SrcVec = SrcTy->isVectorTy();
1721 bool DstVec = DestTy->isVectorTy();
1723 Assert(SrcVec == DstVec,
1724 "FPToSI source and dest must both be vector or scalar", &I);
1725 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
1727 Assert(DestTy->isIntOrIntVectorTy(),
1728 "FPToSI result must be integer or integer vector", &I);
1730 if (SrcVec && DstVec)
1731 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
1732 cast<VectorType>(DestTy)->getNumElements(),
1733 "FPToSI source and dest vector length mismatch", &I);
1735 visitInstruction(I);
1738 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
1739 // Get the source and destination types
1740 Type *SrcTy = I.getOperand(0)->getType();
1741 Type *DestTy = I.getType();
1743 Assert(SrcTy->getScalarType()->isPointerTy(),
1744 "PtrToInt source must be pointer", &I);
1745 Assert(DestTy->getScalarType()->isIntegerTy(),
1746 "PtrToInt result must be integral", &I);
1747 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
1750 if (SrcTy->isVectorTy()) {
1751 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
1752 VectorType *VDest = dyn_cast<VectorType>(DestTy);
1753 Assert(VSrc->getNumElements() == VDest->getNumElements(),
1754 "PtrToInt Vector width mismatch", &I);
1757 visitInstruction(I);
1760 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
1761 // Get the source and destination types
1762 Type *SrcTy = I.getOperand(0)->getType();
1763 Type *DestTy = I.getType();
1765 Assert(SrcTy->getScalarType()->isIntegerTy(),
1766 "IntToPtr source must be an integral", &I);
1767 Assert(DestTy->getScalarType()->isPointerTy(),
1768 "IntToPtr result must be a pointer", &I);
1769 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
1771 if (SrcTy->isVectorTy()) {
1772 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
1773 VectorType *VDest = dyn_cast<VectorType>(DestTy);
1774 Assert(VSrc->getNumElements() == VDest->getNumElements(),
1775 "IntToPtr Vector width mismatch", &I);
1777 visitInstruction(I);
1780 void Verifier::visitBitCastInst(BitCastInst &I) {
1782 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
1783 "Invalid bitcast", &I);
1784 visitInstruction(I);
1787 void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
1788 Type *SrcTy = I.getOperand(0)->getType();
1789 Type *DestTy = I.getType();
1791 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
1793 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
1795 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
1796 "AddrSpaceCast must be between different address spaces", &I);
1797 if (SrcTy->isVectorTy())
1798 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
1799 "AddrSpaceCast vector pointer number of elements mismatch", &I);
1800 visitInstruction(I);
1803 /// visitPHINode - Ensure that a PHI node is well formed.
1805 void Verifier::visitPHINode(PHINode &PN) {
1806 // Ensure that the PHI nodes are all grouped together at the top of the block.
1807 // This can be tested by checking whether the instruction before this is
1808 // either nonexistent (because this is begin()) or is a PHI node. If not,
1809 // then there is some other instruction before a PHI.
1810 Assert(&PN == &PN.getParent()->front() ||
1811 isa<PHINode>(--BasicBlock::iterator(&PN)),
1812 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
1814 // Check that all of the values of the PHI node have the same type as the
1815 // result, and that the incoming blocks are really basic blocks.
1816 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
1817 Assert(PN.getType() == PN.getIncomingValue(i)->getType(),
1818 "PHI node operands are not the same type as the result!", &PN);
1821 // All other PHI node constraints are checked in the visitBasicBlock method.
1823 visitInstruction(PN);
1826 void Verifier::VerifyCallSite(CallSite CS) {
1827 Instruction *I = CS.getInstruction();
1829 Assert(CS.getCalledValue()->getType()->isPointerTy(),
1830 "Called function must be a pointer!", I);
1831 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
1833 Assert(FPTy->getElementType()->isFunctionTy(),
1834 "Called function is not pointer to function type!", I);
1835 FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
1837 // Verify that the correct number of arguments are being passed
1838 if (FTy->isVarArg())
1839 Assert(CS.arg_size() >= FTy->getNumParams(),
1840 "Called function requires more parameters than were provided!", I);
1842 Assert(CS.arg_size() == FTy->getNumParams(),
1843 "Incorrect number of arguments passed to called function!", I);
1845 // Verify that all arguments to the call match the function type.
1846 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
1847 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
1848 "Call parameter type does not match function signature!",
1849 CS.getArgument(i), FTy->getParamType(i), I);
1851 AttributeSet Attrs = CS.getAttributes();
1853 Assert(VerifyAttributeCount(Attrs, CS.arg_size()),
1854 "Attribute after last parameter!", I);
1856 // Verify call attributes.
1857 VerifyFunctionAttrs(FTy, Attrs, I);
1859 // Conservatively check the inalloca argument.
1860 // We have a bug if we can find that there is an underlying alloca without
1862 if (CS.hasInAllocaArgument()) {
1863 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
1864 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
1865 Assert(AI->isUsedWithInAlloca(),
1866 "inalloca argument for call has mismatched alloca", AI, I);
1869 if (FTy->isVarArg()) {
1870 // FIXME? is 'nest' even legal here?
1871 bool SawNest = false;
1872 bool SawReturned = false;
1874 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
1875 if (Attrs.hasAttribute(Idx, Attribute::Nest))
1877 if (Attrs.hasAttribute(Idx, Attribute::Returned))
1881 // Check attributes on the varargs part.
1882 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
1883 Type *Ty = CS.getArgument(Idx-1)->getType();
1884 VerifyParameterAttrs(Attrs, Idx, Ty, false, I);
1886 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
1887 Assert(!SawNest, "More than one parameter has attribute nest!", I);
1891 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
1892 Assert(!SawReturned, "More than one parameter has attribute returned!",
1894 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
1895 "Incompatible argument and return types for 'returned' "
1901 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
1902 "Attribute 'sret' cannot be used for vararg call arguments!", I);
1904 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
1905 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
1909 // Verify that there's no metadata unless it's a direct call to an intrinsic.
1910 if (CS.getCalledFunction() == nullptr ||
1911 !CS.getCalledFunction()->getName().startswith("llvm.")) {
1912 for (FunctionType::param_iterator PI = FTy->param_begin(),
1913 PE = FTy->param_end(); PI != PE; ++PI)
1914 Assert(!(*PI)->isMetadataTy(),
1915 "Function has metadata parameter but isn't an intrinsic", I);
1918 visitInstruction(*I);
1921 /// Two types are "congruent" if they are identical, or if they are both pointer
1922 /// types with different pointee types and the same address space.
1923 static bool isTypeCongruent(Type *L, Type *R) {
1926 PointerType *PL = dyn_cast<PointerType>(L);
1927 PointerType *PR = dyn_cast<PointerType>(R);
1930 return PL->getAddressSpace() == PR->getAddressSpace();
1933 static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
1934 static const Attribute::AttrKind ABIAttrs[] = {
1935 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
1936 Attribute::InReg, Attribute::Returned};
1938 for (auto AK : ABIAttrs) {
1939 if (Attrs.hasAttribute(I + 1, AK))
1940 Copy.addAttribute(AK);
1942 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
1943 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
1947 void Verifier::verifyMustTailCall(CallInst &CI) {
1948 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
1950 // - The caller and callee prototypes must match. Pointer types of
1951 // parameters or return types may differ in pointee type, but not
1953 Function *F = CI.getParent()->getParent();
1954 auto GetFnTy = [](Value *V) {
1955 return cast<FunctionType>(
1956 cast<PointerType>(V->getType())->getElementType());
1958 FunctionType *CallerTy = GetFnTy(F);
1959 FunctionType *CalleeTy = GetFnTy(CI.getCalledValue());
1960 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
1961 "cannot guarantee tail call due to mismatched parameter counts", &CI);
1962 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
1963 "cannot guarantee tail call due to mismatched varargs", &CI);
1964 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
1965 "cannot guarantee tail call due to mismatched return types", &CI);
1966 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
1968 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
1969 "cannot guarantee tail call due to mismatched parameter types", &CI);
1972 // - The calling conventions of the caller and callee must match.
1973 Assert(F->getCallingConv() == CI.getCallingConv(),
1974 "cannot guarantee tail call due to mismatched calling conv", &CI);
1976 // - All ABI-impacting function attributes, such as sret, byval, inreg,
1977 // returned, and inalloca, must match.
1978 AttributeSet CallerAttrs = F->getAttributes();
1979 AttributeSet CalleeAttrs = CI.getAttributes();
1980 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
1981 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
1982 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
1983 Assert(CallerABIAttrs == CalleeABIAttrs,
1984 "cannot guarantee tail call due to mismatched ABI impacting "
1985 "function attributes",
1986 &CI, CI.getOperand(I));
1989 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
1990 // or a pointer bitcast followed by a ret instruction.
1991 // - The ret instruction must return the (possibly bitcasted) value
1992 // produced by the call or void.
1993 Value *RetVal = &CI;
1994 Instruction *Next = CI.getNextNode();
1996 // Handle the optional bitcast.
1997 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
1998 Assert(BI->getOperand(0) == RetVal,
1999 "bitcast following musttail call must use the call", BI);
2001 Next = BI->getNextNode();
2004 // Check the return.
2005 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
2006 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2008 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2009 "musttail call result must be returned", Ret);
2012 void Verifier::visitCallInst(CallInst &CI) {
2013 VerifyCallSite(&CI);
2015 if (CI.isMustTailCall())
2016 verifyMustTailCall(CI);
2018 if (Function *F = CI.getCalledFunction())
2019 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
2020 visitIntrinsicFunctionCall(ID, CI);
2023 void Verifier::visitInvokeInst(InvokeInst &II) {
2024 VerifyCallSite(&II);
2026 // Verify that there is a landingpad instruction as the first non-PHI
2027 // instruction of the 'unwind' destination.
2028 Assert(II.getUnwindDest()->isLandingPad(),
2029 "The unwind destination does not have a landingpad instruction!", &II);
2031 if (Function *F = II.getCalledFunction())
2032 // TODO: Ideally we should use visitIntrinsicFunction here. But it uses
2033 // CallInst as an input parameter. It not woth updating this whole
2034 // function only to support statepoint verification.
2035 if (F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint)
2036 VerifyStatepoint(ImmutableCallSite(&II));
2038 visitTerminatorInst(II);
2041 /// visitBinaryOperator - Check that both arguments to the binary operator are
2042 /// of the same type!
2044 void Verifier::visitBinaryOperator(BinaryOperator &B) {
2045 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2046 "Both operands to a binary operator are not of the same type!", &B);
2048 switch (B.getOpcode()) {
2049 // Check that integer arithmetic operators are only used with
2050 // integral operands.
2051 case Instruction::Add:
2052 case Instruction::Sub:
2053 case Instruction::Mul:
2054 case Instruction::SDiv:
2055 case Instruction::UDiv:
2056 case Instruction::SRem:
2057 case Instruction::URem:
2058 Assert(B.getType()->isIntOrIntVectorTy(),
2059 "Integer arithmetic operators only work with integral types!", &B);
2060 Assert(B.getType() == B.getOperand(0)->getType(),
2061 "Integer arithmetic operators must have same type "
2062 "for operands and result!",
2065 // Check that floating-point arithmetic operators are only used with
2066 // floating-point operands.
2067 case Instruction::FAdd:
2068 case Instruction::FSub:
2069 case Instruction::FMul:
2070 case Instruction::FDiv:
2071 case Instruction::FRem:
2072 Assert(B.getType()->isFPOrFPVectorTy(),
2073 "Floating-point arithmetic operators only work with "
2074 "floating-point types!",
2076 Assert(B.getType() == B.getOperand(0)->getType(),
2077 "Floating-point arithmetic operators must have same type "
2078 "for operands and result!",
2081 // Check that logical operators are only used with integral operands.
2082 case Instruction::And:
2083 case Instruction::Or:
2084 case Instruction::Xor:
2085 Assert(B.getType()->isIntOrIntVectorTy(),
2086 "Logical operators only work with integral types!", &B);
2087 Assert(B.getType() == B.getOperand(0)->getType(),
2088 "Logical operators must have same type for operands and result!",
2091 case Instruction::Shl:
2092 case Instruction::LShr:
2093 case Instruction::AShr:
2094 Assert(B.getType()->isIntOrIntVectorTy(),
2095 "Shifts only work with integral types!", &B);
2096 Assert(B.getType() == B.getOperand(0)->getType(),
2097 "Shift return type must be same as operands!", &B);
2100 llvm_unreachable("Unknown BinaryOperator opcode!");
2103 visitInstruction(B);
2106 void Verifier::visitICmpInst(ICmpInst &IC) {
2107 // Check that the operands are the same type
2108 Type *Op0Ty = IC.getOperand(0)->getType();
2109 Type *Op1Ty = IC.getOperand(1)->getType();
2110 Assert(Op0Ty == Op1Ty,
2111 "Both operands to ICmp instruction are not of the same type!", &IC);
2112 // Check that the operands are the right type
2113 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2114 "Invalid operand types for ICmp instruction", &IC);
2115 // Check that the predicate is valid.
2116 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2117 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2118 "Invalid predicate in ICmp instruction!", &IC);
2120 visitInstruction(IC);
2123 void Verifier::visitFCmpInst(FCmpInst &FC) {
2124 // Check that the operands are the same type
2125 Type *Op0Ty = FC.getOperand(0)->getType();
2126 Type *Op1Ty = FC.getOperand(1)->getType();
2127 Assert(Op0Ty == Op1Ty,
2128 "Both operands to FCmp instruction are not of the same type!", &FC);
2129 // Check that the operands are the right type
2130 Assert(Op0Ty->isFPOrFPVectorTy(),
2131 "Invalid operand types for FCmp instruction", &FC);
2132 // Check that the predicate is valid.
2133 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2134 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2135 "Invalid predicate in FCmp instruction!", &FC);
2137 visitInstruction(FC);
2140 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
2142 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2143 "Invalid extractelement operands!", &EI);
2144 visitInstruction(EI);
2147 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
2148 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2150 "Invalid insertelement operands!", &IE);
2151 visitInstruction(IE);
2154 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
2155 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2157 "Invalid shufflevector operands!", &SV);
2158 visitInstruction(SV);
2161 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
2162 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
2164 Assert(isa<PointerType>(TargetTy),
2165 "GEP base pointer is not a vector or a vector of pointers", &GEP);
2166 Assert(cast<PointerType>(TargetTy)->getElementType()->isSized(),
2167 "GEP into unsized type!", &GEP);
2168 Assert(GEP.getPointerOperandType()->isVectorTy() ==
2169 GEP.getType()->isVectorTy(),
2170 "Vector GEP must return a vector value", &GEP);
2172 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
2174 GetElementPtrInst::getIndexedType(GEP.getPointerOperandType(), Idxs);
2175 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
2177 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
2178 cast<PointerType>(GEP.getType()->getScalarType())
2179 ->getElementType() == ElTy,
2180 "GEP is not of right type for indices!", &GEP, ElTy);
2182 if (GEP.getPointerOperandType()->isVectorTy()) {
2183 // Additional checks for vector GEPs.
2184 unsigned GepWidth = GEP.getPointerOperandType()->getVectorNumElements();
2185 Assert(GepWidth == GEP.getType()->getVectorNumElements(),
2186 "Vector GEP result width doesn't match operand's", &GEP);
2187 for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
2188 Type *IndexTy = Idxs[i]->getType();
2189 Assert(IndexTy->isVectorTy(), "Vector GEP must have vector indices!",
2191 unsigned IndexWidth = IndexTy->getVectorNumElements();
2192 Assert(IndexWidth == GepWidth, "Invalid GEP index vector width", &GEP);
2195 visitInstruction(GEP);
2198 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2199 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2202 void Verifier::visitRangeMetadata(Instruction& I,
2203 MDNode* Range, Type* Ty) {
2205 Range == I.getMetadata(LLVMContext::MD_range) &&
2206 "precondition violation");
2208 unsigned NumOperands = Range->getNumOperands();
2209 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
2210 unsigned NumRanges = NumOperands / 2;
2211 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2213 ConstantRange LastRange(1); // Dummy initial value
2214 for (unsigned i = 0; i < NumRanges; ++i) {
2216 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
2217 Assert(Low, "The lower limit must be an integer!", Low);
2219 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
2220 Assert(High, "The upper limit must be an integer!", High);
2221 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2222 "Range types must match instruction type!", &I);
2224 APInt HighV = High->getValue();
2225 APInt LowV = Low->getValue();
2226 ConstantRange CurRange(LowV, HighV);
2227 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2228 "Range must not be empty!", Range);
2230 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2231 "Intervals are overlapping", Range);
2232 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2234 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2237 LastRange = ConstantRange(LowV, HighV);
2239 if (NumRanges > 2) {
2241 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
2243 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
2244 ConstantRange FirstRange(FirstLow, FirstHigh);
2245 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2246 "Intervals are overlapping", Range);
2247 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2252 void Verifier::visitLoadInst(LoadInst &LI) {
2253 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
2254 Assert(PTy, "Load operand must be a pointer.", &LI);
2255 Type *ElTy = PTy->getElementType();
2256 Assert(ElTy == LI.getType(),
2257 "Load result type does not match pointer operand type!", &LI, ElTy);
2258 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2259 "huge alignment values are unsupported", &LI);
2260 if (LI.isAtomic()) {
2261 Assert(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
2262 "Load cannot have Release ordering", &LI);
2263 Assert(LI.getAlignment() != 0,
2264 "Atomic load must specify explicit alignment", &LI);
2265 if (!ElTy->isPointerTy()) {
2266 Assert(ElTy->isIntegerTy(), "atomic load operand must have integer type!",
2268 unsigned Size = ElTy->getPrimitiveSizeInBits();
2269 Assert(Size >= 8 && !(Size & (Size - 1)),
2270 "atomic load operand must be power-of-two byte-sized integer", &LI,
2274 Assert(LI.getSynchScope() == CrossThread,
2275 "Non-atomic load cannot have SynchronizationScope specified", &LI);
2278 visitInstruction(LI);
2281 void Verifier::visitStoreInst(StoreInst &SI) {
2282 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
2283 Assert(PTy, "Store operand must be a pointer.", &SI);
2284 Type *ElTy = PTy->getElementType();
2285 Assert(ElTy == SI.getOperand(0)->getType(),
2286 "Stored value type does not match pointer operand type!", &SI, ElTy);
2287 Assert(SI.getAlignment() <= Value::MaximumAlignment,
2288 "huge alignment values are unsupported", &SI);
2289 if (SI.isAtomic()) {
2290 Assert(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
2291 "Store cannot have Acquire ordering", &SI);
2292 Assert(SI.getAlignment() != 0,
2293 "Atomic store must specify explicit alignment", &SI);
2294 if (!ElTy->isPointerTy()) {
2295 Assert(ElTy->isIntegerTy(),
2296 "atomic store operand must have integer type!", &SI, ElTy);
2297 unsigned Size = ElTy->getPrimitiveSizeInBits();
2298 Assert(Size >= 8 && !(Size & (Size - 1)),
2299 "atomic store operand must be power-of-two byte-sized integer",
2303 Assert(SI.getSynchScope() == CrossThread,
2304 "Non-atomic store cannot have SynchronizationScope specified", &SI);
2306 visitInstruction(SI);
2309 void Verifier::visitAllocaInst(AllocaInst &AI) {
2310 SmallPtrSet<const Type*, 4> Visited;
2311 PointerType *PTy = AI.getType();
2312 Assert(PTy->getAddressSpace() == 0,
2313 "Allocation instruction pointer not in the generic address space!",
2315 Assert(PTy->getElementType()->isSized(&Visited),
2316 "Cannot allocate unsized type", &AI);
2317 Assert(AI.getArraySize()->getType()->isIntegerTy(),
2318 "Alloca array size must have integer type", &AI);
2319 Assert(AI.getAlignment() <= Value::MaximumAlignment,
2320 "huge alignment values are unsupported", &AI);
2322 visitInstruction(AI);
2325 void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
2327 // FIXME: more conditions???
2328 Assert(CXI.getSuccessOrdering() != NotAtomic,
2329 "cmpxchg instructions must be atomic.", &CXI);
2330 Assert(CXI.getFailureOrdering() != NotAtomic,
2331 "cmpxchg instructions must be atomic.", &CXI);
2332 Assert(CXI.getSuccessOrdering() != Unordered,
2333 "cmpxchg instructions cannot be unordered.", &CXI);
2334 Assert(CXI.getFailureOrdering() != Unordered,
2335 "cmpxchg instructions cannot be unordered.", &CXI);
2336 Assert(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
2337 "cmpxchg instructions be at least as constrained on success as fail",
2339 Assert(CXI.getFailureOrdering() != Release &&
2340 CXI.getFailureOrdering() != AcquireRelease,
2341 "cmpxchg failure ordering cannot include release semantics", &CXI);
2343 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
2344 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
2345 Type *ElTy = PTy->getElementType();
2346 Assert(ElTy->isIntegerTy(), "cmpxchg operand must have integer type!", &CXI,
2348 unsigned Size = ElTy->getPrimitiveSizeInBits();
2349 Assert(Size >= 8 && !(Size & (Size - 1)),
2350 "cmpxchg operand must be power-of-two byte-sized integer", &CXI, ElTy);
2351 Assert(ElTy == CXI.getOperand(1)->getType(),
2352 "Expected value type does not match pointer operand type!", &CXI,
2354 Assert(ElTy == CXI.getOperand(2)->getType(),
2355 "Stored value type does not match pointer operand type!", &CXI, ElTy);
2356 visitInstruction(CXI);
2359 void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
2360 Assert(RMWI.getOrdering() != NotAtomic,
2361 "atomicrmw instructions must be atomic.", &RMWI);
2362 Assert(RMWI.getOrdering() != Unordered,
2363 "atomicrmw instructions cannot be unordered.", &RMWI);
2364 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
2365 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
2366 Type *ElTy = PTy->getElementType();
2367 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
2369 unsigned Size = ElTy->getPrimitiveSizeInBits();
2370 Assert(Size >= 8 && !(Size & (Size - 1)),
2371 "atomicrmw operand must be power-of-two byte-sized integer", &RMWI,
2373 Assert(ElTy == RMWI.getOperand(1)->getType(),
2374 "Argument value type does not match pointer operand type!", &RMWI,
2376 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
2377 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
2378 "Invalid binary operation!", &RMWI);
2379 visitInstruction(RMWI);
2382 void Verifier::visitFenceInst(FenceInst &FI) {
2383 const AtomicOrdering Ordering = FI.getOrdering();
2384 Assert(Ordering == Acquire || Ordering == Release ||
2385 Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
2386 "fence instructions may only have "
2387 "acquire, release, acq_rel, or seq_cst ordering.",
2389 visitInstruction(FI);
2392 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
2393 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
2394 EVI.getIndices()) == EVI.getType(),
2395 "Invalid ExtractValueInst operands!", &EVI);
2397 visitInstruction(EVI);
2400 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
2401 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
2402 IVI.getIndices()) ==
2403 IVI.getOperand(1)->getType(),
2404 "Invalid InsertValueInst operands!", &IVI);
2406 visitInstruction(IVI);
2409 void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
2410 BasicBlock *BB = LPI.getParent();
2412 // The landingpad instruction is ill-formed if it doesn't have any clauses and
2414 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
2415 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
2417 // The landingpad instruction defines its parent as a landing pad block. The
2418 // landing pad block may be branched to only by the unwind edge of an invoke.
2419 for (pred_iterator I = pred_begin(BB), E = pred_end(BB); I != E; ++I) {
2420 const InvokeInst *II = dyn_cast<InvokeInst>((*I)->getTerminator());
2421 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
2422 "Block containing LandingPadInst must be jumped to "
2423 "only by the unwind edge of an invoke.",
2427 // The landingpad instruction must be the first non-PHI instruction in the
2429 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
2430 "LandingPadInst not the first non-PHI instruction in the block.",
2433 // The personality functions for all landingpad instructions within the same
2434 // function should match.
2436 Assert(LPI.getPersonalityFn() == PersonalityFn,
2437 "Personality function doesn't match others in function", &LPI);
2438 PersonalityFn = LPI.getPersonalityFn();
2440 // All operands must be constants.
2441 Assert(isa<Constant>(PersonalityFn), "Personality function is not constant!",
2443 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
2444 Constant *Clause = LPI.getClause(i);
2445 if (LPI.isCatch(i)) {
2446 Assert(isa<PointerType>(Clause->getType()),
2447 "Catch operand does not have pointer type!", &LPI);
2449 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
2450 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
2451 "Filter operand is not an array of constants!", &LPI);
2455 visitInstruction(LPI);
2458 void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
2459 Instruction *Op = cast<Instruction>(I.getOperand(i));
2460 // If the we have an invalid invoke, don't try to compute the dominance.
2461 // We already reject it in the invoke specific checks and the dominance
2462 // computation doesn't handle multiple edges.
2463 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
2464 if (II->getNormalDest() == II->getUnwindDest())
2468 const Use &U = I.getOperandUse(i);
2469 Assert(InstsInThisBlock.count(Op) || DT.dominates(Op, U),
2470 "Instruction does not dominate all uses!", Op, &I);
2473 /// verifyInstruction - Verify that an instruction is well formed.
2475 void Verifier::visitInstruction(Instruction &I) {
2476 BasicBlock *BB = I.getParent();
2477 Assert(BB, "Instruction not embedded in basic block!", &I);
2479 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
2480 for (User *U : I.users()) {
2481 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
2482 "Only PHI nodes may reference their own value!", &I);
2486 // Check that void typed values don't have names
2487 Assert(!I.getType()->isVoidTy() || !I.hasName(),
2488 "Instruction has a name, but provides a void value!", &I);
2490 // Check that the return value of the instruction is either void or a legal
2492 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
2493 "Instruction returns a non-scalar type!", &I);
2495 // Check that the instruction doesn't produce metadata. Calls are already
2496 // checked against the callee type.
2497 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
2498 "Invalid use of metadata!", &I);
2500 // Check that all uses of the instruction, if they are instructions
2501 // themselves, actually have parent basic blocks. If the use is not an
2502 // instruction, it is an error!
2503 for (Use &U : I.uses()) {
2504 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
2505 Assert(Used->getParent() != nullptr,
2506 "Instruction referencing"
2507 " instruction not embedded in a basic block!",
2510 CheckFailed("Use of instruction is not an instruction!", U);
2515 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
2516 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
2518 // Check to make sure that only first-class-values are operands to
2520 if (!I.getOperand(i)->getType()->isFirstClassType()) {
2521 Assert(0, "Instruction operands must be first-class values!", &I);
2524 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
2525 // Check to make sure that the "address of" an intrinsic function is never
2528 !F->isIntrinsic() ||
2529 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
2530 "Cannot take the address of an intrinsic!", &I);
2532 !F->isIntrinsic() || isa<CallInst>(I) ||
2533 F->getIntrinsicID() == Intrinsic::donothing ||
2534 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
2535 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
2536 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
2537 "Cannot invoke an intrinsinc other than"
2538 " donothing or patchpoint",
2540 Assert(F->getParent() == M, "Referencing function in another module!",
2542 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
2543 Assert(OpBB->getParent() == BB->getParent(),
2544 "Referring to a basic block in another function!", &I);
2545 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
2546 Assert(OpArg->getParent() == BB->getParent(),
2547 "Referring to an argument in another function!", &I);
2548 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
2549 Assert(GV->getParent() == M, "Referencing global in another module!", &I);
2550 } else if (isa<Instruction>(I.getOperand(i))) {
2551 verifyDominatesUse(I, i);
2552 } else if (isa<InlineAsm>(I.getOperand(i))) {
2553 Assert((i + 1 == e && isa<CallInst>(I)) ||
2554 (i + 3 == e && isa<InvokeInst>(I)),
2555 "Cannot take the address of an inline asm!", &I);
2556 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
2557 if (CE->getType()->isPtrOrPtrVectorTy()) {
2558 // If we have a ConstantExpr pointer, we need to see if it came from an
2559 // illegal bitcast (inttoptr <constant int> )
2560 SmallVector<const ConstantExpr *, 4> Stack;
2561 SmallPtrSet<const ConstantExpr *, 4> Visited;
2562 Stack.push_back(CE);
2564 while (!Stack.empty()) {
2565 const ConstantExpr *V = Stack.pop_back_val();
2566 if (!Visited.insert(V).second)
2569 VerifyConstantExprBitcastType(V);
2571 for (unsigned I = 0, N = V->getNumOperands(); I != N; ++I) {
2572 if (ConstantExpr *Op = dyn_cast<ConstantExpr>(V->getOperand(I)))
2573 Stack.push_back(Op);
2580 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
2581 Assert(I.getType()->isFPOrFPVectorTy(),
2582 "fpmath requires a floating point result!", &I);
2583 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
2584 if (ConstantFP *CFP0 =
2585 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
2586 APFloat Accuracy = CFP0->getValueAPF();
2587 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
2588 "fpmath accuracy not a positive number!", &I);
2590 Assert(false, "invalid fpmath accuracy!", &I);
2594 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
2595 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
2596 "Ranges are only for loads, calls and invokes!", &I);
2597 visitRangeMetadata(I, Range, I.getType());
2600 if (I.getMetadata(LLVMContext::MD_nonnull)) {
2601 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
2603 Assert(isa<LoadInst>(I),
2604 "nonnull applies only to load instructions, use attributes"
2605 " for calls or invokes",
2609 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
2610 Assert(isa<MDLocation>(N), "invalid !dbg metadata attachment", &I, N);
2614 InstsInThisBlock.insert(&I);
2617 /// VerifyIntrinsicType - Verify that the specified type (which comes from an
2618 /// intrinsic argument or return value) matches the type constraints specified
2619 /// by the .td file (e.g. an "any integer" argument really is an integer).
2621 /// This return true on error but does not print a message.
2622 bool Verifier::VerifyIntrinsicType(Type *Ty,
2623 ArrayRef<Intrinsic::IITDescriptor> &Infos,
2624 SmallVectorImpl<Type*> &ArgTys) {
2625 using namespace Intrinsic;
2627 // If we ran out of descriptors, there are too many arguments.
2628 if (Infos.empty()) return true;
2629 IITDescriptor D = Infos.front();
2630 Infos = Infos.slice(1);
2633 case IITDescriptor::Void: return !Ty->isVoidTy();
2634 case IITDescriptor::VarArg: return true;
2635 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
2636 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
2637 case IITDescriptor::Half: return !Ty->isHalfTy();
2638 case IITDescriptor::Float: return !Ty->isFloatTy();
2639 case IITDescriptor::Double: return !Ty->isDoubleTy();
2640 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
2641 case IITDescriptor::Vector: {
2642 VectorType *VT = dyn_cast<VectorType>(Ty);
2643 return !VT || VT->getNumElements() != D.Vector_Width ||
2644 VerifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
2646 case IITDescriptor::Pointer: {
2647 PointerType *PT = dyn_cast<PointerType>(Ty);
2648 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
2649 VerifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
2652 case IITDescriptor::Struct: {
2653 StructType *ST = dyn_cast<StructType>(Ty);
2654 if (!ST || ST->getNumElements() != D.Struct_NumElements)
2657 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
2658 if (VerifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
2663 case IITDescriptor::Argument:
2664 // Two cases here - If this is the second occurrence of an argument, verify
2665 // that the later instance matches the previous instance.
2666 if (D.getArgumentNumber() < ArgTys.size())
2667 return Ty != ArgTys[D.getArgumentNumber()];
2669 // Otherwise, if this is the first instance of an argument, record it and
2670 // verify the "Any" kind.
2671 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
2672 ArgTys.push_back(Ty);
2674 switch (D.getArgumentKind()) {
2675 case IITDescriptor::AK_Any: return false; // Success
2676 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
2677 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
2678 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
2679 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
2681 llvm_unreachable("all argument kinds not covered");
2683 case IITDescriptor::ExtendArgument: {
2684 // This may only be used when referring to a previous vector argument.
2685 if (D.getArgumentNumber() >= ArgTys.size())
2688 Type *NewTy = ArgTys[D.getArgumentNumber()];
2689 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
2690 NewTy = VectorType::getExtendedElementVectorType(VTy);
2691 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
2692 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
2698 case IITDescriptor::TruncArgument: {
2699 // This may only be used when referring to a previous vector argument.
2700 if (D.getArgumentNumber() >= ArgTys.size())
2703 Type *NewTy = ArgTys[D.getArgumentNumber()];
2704 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
2705 NewTy = VectorType::getTruncatedElementVectorType(VTy);
2706 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
2707 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
2713 case IITDescriptor::HalfVecArgument:
2714 // This may only be used when referring to a previous vector argument.
2715 return D.getArgumentNumber() >= ArgTys.size() ||
2716 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
2717 VectorType::getHalfElementsVectorType(
2718 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
2719 case IITDescriptor::SameVecWidthArgument: {
2720 if (D.getArgumentNumber() >= ArgTys.size())
2722 VectorType * ReferenceType =
2723 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
2724 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
2725 if (!ThisArgType || !ReferenceType ||
2726 (ReferenceType->getVectorNumElements() !=
2727 ThisArgType->getVectorNumElements()))
2729 return VerifyIntrinsicType(ThisArgType->getVectorElementType(),
2732 case IITDescriptor::PtrToArgument: {
2733 if (D.getArgumentNumber() >= ArgTys.size())
2735 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
2736 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
2737 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
2739 case IITDescriptor::VecOfPtrsToElt: {
2740 if (D.getArgumentNumber() >= ArgTys.size())
2742 VectorType * ReferenceType =
2743 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
2744 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
2745 if (!ThisArgVecTy || !ReferenceType ||
2746 (ReferenceType->getVectorNumElements() !=
2747 ThisArgVecTy->getVectorNumElements()))
2749 PointerType *ThisArgEltTy =
2750 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
2753 return (!(ThisArgEltTy->getElementType() ==
2754 ReferenceType->getVectorElementType()));
2757 llvm_unreachable("unhandled");
2760 /// \brief Verify if the intrinsic has variable arguments.
2761 /// This method is intended to be called after all the fixed arguments have been
2764 /// This method returns true on error and does not print an error message.
2766 Verifier::VerifyIntrinsicIsVarArg(bool isVarArg,
2767 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
2768 using namespace Intrinsic;
2770 // If there are no descriptors left, then it can't be a vararg.
2774 // There should be only one descriptor remaining at this point.
2775 if (Infos.size() != 1)
2778 // Check and verify the descriptor.
2779 IITDescriptor D = Infos.front();
2780 Infos = Infos.slice(1);
2781 if (D.Kind == IITDescriptor::VarArg)
2787 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
2789 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
2790 Function *IF = CI.getCalledFunction();
2791 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
2794 // Verify that the intrinsic prototype lines up with what the .td files
2796 FunctionType *IFTy = IF->getFunctionType();
2797 bool IsVarArg = IFTy->isVarArg();
2799 SmallVector<Intrinsic::IITDescriptor, 8> Table;
2800 getIntrinsicInfoTableEntries(ID, Table);
2801 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
2803 SmallVector<Type *, 4> ArgTys;
2804 Assert(!VerifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
2805 "Intrinsic has incorrect return type!", IF);
2806 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
2807 Assert(!VerifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
2808 "Intrinsic has incorrect argument type!", IF);
2810 // Verify if the intrinsic call matches the vararg property.
2812 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
2813 "Intrinsic was not defined with variable arguments!", IF);
2815 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
2816 "Callsite was not defined with variable arguments!", IF);
2818 // All descriptors should be absorbed by now.
2819 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
2821 // Now that we have the intrinsic ID and the actual argument types (and we
2822 // know they are legal for the intrinsic!) get the intrinsic name through the
2823 // usual means. This allows us to verify the mangling of argument types into
2825 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
2826 Assert(ExpectedName == IF->getName(),
2827 "Intrinsic name not mangled correctly for type arguments! "
2832 // If the intrinsic takes MDNode arguments, verify that they are either global
2833 // or are local to *this* function.
2834 for (unsigned i = 0, e = CI.getNumArgOperands(); i != e; ++i)
2835 if (auto *MD = dyn_cast<MetadataAsValue>(CI.getArgOperand(i)))
2836 visitMetadataAsValue(*MD, CI.getParent()->getParent());
2841 case Intrinsic::ctlz: // llvm.ctlz
2842 case Intrinsic::cttz: // llvm.cttz
2843 Assert(isa<ConstantInt>(CI.getArgOperand(1)),
2844 "is_zero_undef argument of bit counting intrinsics must be a "
2848 case Intrinsic::dbg_declare: // llvm.dbg.declare
2849 Assert(isa<MetadataAsValue>(CI.getArgOperand(0)),
2850 "invalid llvm.dbg.declare intrinsic call 1", &CI);
2851 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(CI));
2853 case Intrinsic::dbg_value: // llvm.dbg.value
2854 visitDbgIntrinsic("value", cast<DbgValueInst>(CI));
2856 case Intrinsic::memcpy:
2857 case Intrinsic::memmove:
2858 case Intrinsic::memset: {
2859 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CI.getArgOperand(3));
2861 "alignment argument of memory intrinsics must be a constant int",
2863 const APInt &AlignVal = AlignCI->getValue();
2864 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
2865 "alignment argument of memory intrinsics must be a power of 2", &CI);
2866 Assert(isa<ConstantInt>(CI.getArgOperand(4)),
2867 "isvolatile argument of memory intrinsics must be a constant int",
2871 case Intrinsic::gcroot:
2872 case Intrinsic::gcwrite:
2873 case Intrinsic::gcread:
2874 if (ID == Intrinsic::gcroot) {
2876 dyn_cast<AllocaInst>(CI.getArgOperand(0)->stripPointerCasts());
2877 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", &CI);
2878 Assert(isa<Constant>(CI.getArgOperand(1)),
2879 "llvm.gcroot parameter #2 must be a constant.", &CI);
2880 if (!AI->getType()->getElementType()->isPointerTy()) {
2881 Assert(!isa<ConstantPointerNull>(CI.getArgOperand(1)),
2882 "llvm.gcroot parameter #1 must either be a pointer alloca, "
2883 "or argument #2 must be a non-null constant.",
2888 Assert(CI.getParent()->getParent()->hasGC(),
2889 "Enclosing function does not use GC.", &CI);
2891 case Intrinsic::init_trampoline:
2892 Assert(isa<Function>(CI.getArgOperand(1)->stripPointerCasts()),
2893 "llvm.init_trampoline parameter #2 must resolve to a function.",
2896 case Intrinsic::prefetch:
2897 Assert(isa<ConstantInt>(CI.getArgOperand(1)) &&
2898 isa<ConstantInt>(CI.getArgOperand(2)) &&
2899 cast<ConstantInt>(CI.getArgOperand(1))->getZExtValue() < 2 &&
2900 cast<ConstantInt>(CI.getArgOperand(2))->getZExtValue() < 4,
2901 "invalid arguments to llvm.prefetch", &CI);
2903 case Intrinsic::stackprotector:
2904 Assert(isa<AllocaInst>(CI.getArgOperand(1)->stripPointerCasts()),
2905 "llvm.stackprotector parameter #2 must resolve to an alloca.", &CI);
2907 case Intrinsic::lifetime_start:
2908 case Intrinsic::lifetime_end:
2909 case Intrinsic::invariant_start:
2910 Assert(isa<ConstantInt>(CI.getArgOperand(0)),
2911 "size argument of memory use markers must be a constant integer",
2914 case Intrinsic::invariant_end:
2915 Assert(isa<ConstantInt>(CI.getArgOperand(1)),
2916 "llvm.invariant.end parameter #2 must be a constant integer", &CI);
2919 case Intrinsic::frameescape: {
2920 BasicBlock *BB = CI.getParent();
2921 Assert(BB == &BB->getParent()->front(),
2922 "llvm.frameescape used outside of entry block", &CI);
2923 Assert(!SawFrameEscape,
2924 "multiple calls to llvm.frameescape in one function", &CI);
2925 for (Value *Arg : CI.arg_operands()) {
2926 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
2927 Assert(AI && AI->isStaticAlloca(),
2928 "llvm.frameescape only accepts static allocas", &CI);
2930 FrameEscapeInfo[BB->getParent()].first = CI.getNumArgOperands();
2931 SawFrameEscape = true;
2934 case Intrinsic::framerecover: {
2935 Value *FnArg = CI.getArgOperand(0)->stripPointerCasts();
2936 Function *Fn = dyn_cast<Function>(FnArg);
2937 Assert(Fn && !Fn->isDeclaration(),
2938 "llvm.framerecover first "
2939 "argument must be function defined in this module",
2941 auto *IdxArg = dyn_cast<ConstantInt>(CI.getArgOperand(2));
2942 Assert(IdxArg, "idx argument of llvm.framerecover must be a constant int",
2944 auto &Entry = FrameEscapeInfo[Fn];
2945 Entry.second = unsigned(
2946 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
2950 case Intrinsic::eh_parentframe: {
2951 auto *AI = dyn_cast<AllocaInst>(CI.getArgOperand(0)->stripPointerCasts());
2952 Assert(AI && AI->isStaticAlloca(),
2953 "llvm.eh.parentframe requires a static alloca", &CI);
2957 case Intrinsic::eh_unwindhelp: {
2958 auto *AI = dyn_cast<AllocaInst>(CI.getArgOperand(0)->stripPointerCasts());
2959 Assert(AI && AI->isStaticAlloca(),
2960 "llvm.eh.unwindhelp requires a static alloca", &CI);
2964 case Intrinsic::experimental_gc_statepoint:
2965 Assert(!CI.isInlineAsm(),
2966 "gc.statepoint support for inline assembly unimplemented", &CI);
2967 Assert(CI.getParent()->getParent()->hasGC(),
2968 "Enclosing function does not use GC.", &CI);
2970 VerifyStatepoint(ImmutableCallSite(&CI));
2972 case Intrinsic::experimental_gc_result_int:
2973 case Intrinsic::experimental_gc_result_float:
2974 case Intrinsic::experimental_gc_result_ptr:
2975 case Intrinsic::experimental_gc_result: {
2976 Assert(CI.getParent()->getParent()->hasGC(),
2977 "Enclosing function does not use GC.", &CI);
2978 // Are we tied to a statepoint properly?
2979 CallSite StatepointCS(CI.getArgOperand(0));
2980 const Function *StatepointFn =
2981 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
2982 Assert(StatepointFn && StatepointFn->isDeclaration() &&
2983 StatepointFn->getIntrinsicID() ==
2984 Intrinsic::experimental_gc_statepoint,
2985 "gc.result operand #1 must be from a statepoint", &CI,
2986 CI.getArgOperand(0));
2988 // Assert that result type matches wrapped callee.
2989 const Value *Target = StatepointCS.getArgument(0);
2990 const PointerType *PT = cast<PointerType>(Target->getType());
2991 const FunctionType *TargetFuncType =
2992 cast<FunctionType>(PT->getElementType());
2993 Assert(CI.getType() == TargetFuncType->getReturnType(),
2994 "gc.result result type does not match wrapped callee", &CI);
2997 case Intrinsic::experimental_gc_relocate: {
2998 Assert(CI.getNumArgOperands() == 3, "wrong number of arguments", &CI);
3000 // Check that this relocate is correctly tied to the statepoint
3002 // This is case for relocate on the unwinding path of an invoke statepoint
3003 if (ExtractValueInst *ExtractValue =
3004 dyn_cast<ExtractValueInst>(CI.getArgOperand(0))) {
3005 Assert(isa<LandingPadInst>(ExtractValue->getAggregateOperand()),
3006 "gc relocate on unwind path incorrectly linked to the statepoint",
3009 const BasicBlock *invokeBB =
3010 ExtractValue->getParent()->getUniquePredecessor();
3012 // Landingpad relocates should have only one predecessor with invoke
3013 // statepoint terminator
3014 Assert(invokeBB, "safepoints should have unique landingpads",
3015 ExtractValue->getParent());
3016 Assert(invokeBB->getTerminator(), "safepoint block should be well formed",
3018 Assert(isStatepoint(invokeBB->getTerminator()),
3019 "gc relocate should be linked to a statepoint", invokeBB);
3022 // In all other cases relocate should be tied to the statepoint directly.
3023 // This covers relocates on a normal return path of invoke statepoint and
3024 // relocates of a call statepoint
3025 auto Token = CI.getArgOperand(0);
3026 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
3027 "gc relocate is incorrectly tied to the statepoint", &CI, Token);
3030 // Verify rest of the relocate arguments
3032 GCRelocateOperands ops(&CI);
3033 ImmutableCallSite StatepointCS(ops.statepoint());
3035 // Both the base and derived must be piped through the safepoint
3036 Value* Base = CI.getArgOperand(1);
3037 Assert(isa<ConstantInt>(Base),
3038 "gc.relocate operand #2 must be integer offset", &CI);
3040 Value* Derived = CI.getArgOperand(2);
3041 Assert(isa<ConstantInt>(Derived),
3042 "gc.relocate operand #3 must be integer offset", &CI);
3044 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
3045 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
3047 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
3048 "gc.relocate: statepoint base index out of bounds", &CI);
3049 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
3050 "gc.relocate: statepoint derived index out of bounds", &CI);
3052 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
3053 // section of the statepoint's argument
3054 Assert(StatepointCS.arg_size() > 0,
3055 "gc.statepoint: insufficient arguments");
3056 Assert(isa<ConstantInt>(StatepointCS.getArgument(1)),
3057 "gc.statement: number of call arguments must be constant integer");
3058 const unsigned NumCallArgs =
3059 cast<ConstantInt>(StatepointCS.getArgument(1))->getZExtValue();
3060 Assert(StatepointCS.arg_size() > NumCallArgs+3,
3061 "gc.statepoint: mismatch in number of call arguments");
3062 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs+3)),
3063 "gc.statepoint: number of deoptimization arguments must be "
3064 "a constant integer");
3065 const int NumDeoptArgs =
3066 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 3))->getZExtValue();
3067 const int GCParamArgsStart = NumCallArgs + NumDeoptArgs + 4;
3068 const int GCParamArgsEnd = StatepointCS.arg_size();
3069 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
3070 "gc.relocate: statepoint base index doesn't fall within the "
3071 "'gc parameters' section of the statepoint call",
3073 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
3074 "gc.relocate: statepoint derived index doesn't fall within the "
3075 "'gc parameters' section of the statepoint call",
3078 // Assert that the result type matches the type of the relocated pointer
3079 GCRelocateOperands Operands(&CI);
3080 Assert(Operands.derivedPtr()->getType() == CI.getType(),
3081 "gc.relocate: relocating a pointer shouldn't change its type", &CI);
3087 template <class DbgIntrinsicTy>
3088 void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
3089 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
3090 Assert(isa<ValueAsMetadata>(MD) ||
3091 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
3092 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
3093 Assert(isa<MDLocalVariable>(DII.getRawVariable()),
3094 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
3095 DII.getRawVariable());
3096 Assert(isa<MDExpression>(DII.getRawExpression()),
3097 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
3098 DII.getRawExpression());
3101 void Verifier::verifyDebugInfo() {
3102 // Run the debug info verifier only if the regular verifier succeeds, since
3103 // sometimes checks that have already failed will cause crashes here.
3104 if (EverBroken || !VerifyDebugInfo)
3107 DebugInfoFinder Finder;
3108 Finder.processModule(*M);
3109 processInstructions(Finder);
3111 // Verify Debug Info.
3113 // NOTE: The loud braces are necessary for MSVC compatibility.
3114 for (DICompileUnit CU : Finder.compile_units()) {
3115 Assert(CU.Verify(), "DICompileUnit does not Verify!", CU);
3117 for (DISubprogram S : Finder.subprograms()) {
3118 Assert(S.Verify(), "DISubprogram does not Verify!", S);
3120 for (DIGlobalVariable GV : Finder.global_variables()) {
3121 Assert(GV.Verify(), "DIGlobalVariable does not Verify!", GV);
3123 for (DIType T : Finder.types()) {
3124 Assert(T.Verify(), "DIType does not Verify!", T);
3126 for (DIScope S : Finder.scopes()) {
3127 Assert(S.Verify(), "DIScope does not Verify!", S);
3131 void Verifier::processInstructions(DebugInfoFinder &Finder) {
3132 for (const Function &F : *M)
3133 for (auto I = inst_begin(&F), E = inst_end(&F); I != E; ++I) {
3134 if (MDNode *MD = I->getMetadata(LLVMContext::MD_dbg))
3135 Finder.processLocation(*M, DILocation(MD));
3136 if (const CallInst *CI = dyn_cast<CallInst>(&*I))
3137 processCallInst(Finder, *CI);
3141 void Verifier::processCallInst(DebugInfoFinder &Finder, const CallInst &CI) {
3142 if (Function *F = CI.getCalledFunction())
3143 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
3145 case Intrinsic::dbg_declare:
3146 Finder.processDeclare(*M, cast<DbgDeclareInst>(&CI));
3148 case Intrinsic::dbg_value:
3149 Finder.processValue(*M, cast<DbgValueInst>(&CI));
3156 //===----------------------------------------------------------------------===//
3157 // Implement the public interfaces to this file...
3158 //===----------------------------------------------------------------------===//
3160 bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
3161 Function &F = const_cast<Function &>(f);
3162 assert(!F.isDeclaration() && "Cannot verify external functions");
3164 raw_null_ostream NullStr;
3165 Verifier V(OS ? *OS : NullStr);
3167 // Note that this function's return value is inverted from what you would
3168 // expect of a function called "verify".
3169 return !V.verify(F);
3172 bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
3173 raw_null_ostream NullStr;
3174 Verifier V(OS ? *OS : NullStr);
3176 bool Broken = false;
3177 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
3178 if (!I->isDeclaration() && !I->isMaterializable())
3179 Broken |= !V.verify(*I);
3181 // Note that this function's return value is inverted from what you would
3182 // expect of a function called "verify".
3183 return !V.verify(M) || Broken;
3187 struct VerifierLegacyPass : public FunctionPass {
3193 VerifierLegacyPass() : FunctionPass(ID), V(dbgs()), FatalErrors(true) {
3194 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3196 explicit VerifierLegacyPass(bool FatalErrors)
3197 : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
3198 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3201 bool runOnFunction(Function &F) override {
3202 if (!V.verify(F) && FatalErrors)
3203 report_fatal_error("Broken function found, compilation aborted!");
3208 bool doFinalization(Module &M) override {
3209 if (!V.verify(M) && FatalErrors)
3210 report_fatal_error("Broken module found, compilation aborted!");
3215 void getAnalysisUsage(AnalysisUsage &AU) const override {
3216 AU.setPreservesAll();
3221 char VerifierLegacyPass::ID = 0;
3222 INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
3224 FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
3225 return new VerifierLegacyPass(FatalErrors);
3228 PreservedAnalyses VerifierPass::run(Module &M) {
3229 if (verifyModule(M, &dbgs()) && FatalErrors)
3230 report_fatal_error("Broken module found, compilation aborted!");
3232 return PreservedAnalyses::all();
3235 PreservedAnalyses VerifierPass::run(Function &F) {
3236 if (verifyFunction(F, &dbgs()) && FatalErrors)
3237 report_fatal_error("Broken function found, compilation aborted!");
3239 return PreservedAnalyses::all();