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 // * Landingpad instructions must be in a function with a personality function.
43 // * All other things that are tested by asserts spread about the code...
45 //===----------------------------------------------------------------------===//
47 #include "llvm/IR/Verifier.h"
48 #include "llvm/ADT/STLExtras.h"
49 #include "llvm/ADT/SetVector.h"
50 #include "llvm/ADT/SmallPtrSet.h"
51 #include "llvm/ADT/SmallVector.h"
52 #include "llvm/ADT/StringExtras.h"
53 #include "llvm/IR/CFG.h"
54 #include "llvm/IR/CallSite.h"
55 #include "llvm/IR/CallingConv.h"
56 #include "llvm/IR/ConstantRange.h"
57 #include "llvm/IR/Constants.h"
58 #include "llvm/IR/DataLayout.h"
59 #include "llvm/IR/DebugInfo.h"
60 #include "llvm/IR/DerivedTypes.h"
61 #include "llvm/IR/Dominators.h"
62 #include "llvm/IR/InlineAsm.h"
63 #include "llvm/IR/InstIterator.h"
64 #include "llvm/IR/InstVisitor.h"
65 #include "llvm/IR/IntrinsicInst.h"
66 #include "llvm/IR/LLVMContext.h"
67 #include "llvm/IR/Metadata.h"
68 #include "llvm/IR/Module.h"
69 #include "llvm/IR/PassManager.h"
70 #include "llvm/IR/Statepoint.h"
71 #include "llvm/Pass.h"
72 #include "llvm/Support/CommandLine.h"
73 #include "llvm/Support/Debug.h"
74 #include "llvm/Support/ErrorHandling.h"
75 #include "llvm/Support/raw_ostream.h"
80 static cl::opt<bool> VerifyDebugInfo("verify-debug-info", cl::init(true));
83 struct VerifierSupport {
87 /// \brief Track the brokenness of the module while recursively visiting.
90 explicit VerifierSupport(raw_ostream &OS)
91 : OS(OS), M(nullptr), Broken(false) {}
94 template <class NodeTy> void Write(const ilist_iterator<NodeTy> &I) {
98 void Write(const Module *M) {
101 OS << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
104 void Write(const Value *V) {
107 if (isa<Instruction>(V)) {
110 V->printAsOperand(OS, true, M);
114 void Write(ImmutableCallSite CS) {
115 Write(CS.getInstruction());
118 void Write(const Metadata *MD) {
125 template <class T> void Write(const MDTupleTypedArrayWrapper<T> &MD) {
129 void Write(const NamedMDNode *NMD) {
136 void Write(Type *T) {
142 void Write(const Comdat *C) {
148 template <typename T1, typename... Ts>
149 void WriteTs(const T1 &V1, const Ts &... Vs) {
154 template <typename... Ts> void WriteTs() {}
157 /// \brief A check failed, so printout out the condition and the message.
159 /// This provides a nice place to put a breakpoint if you want to see why
160 /// something is not correct.
161 void CheckFailed(const Twine &Message) {
162 OS << Message << '\n';
166 /// \brief A check failed (with values to print).
168 /// This calls the Message-only version so that the above is easier to set a
170 template <typename T1, typename... Ts>
171 void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) {
172 CheckFailed(Message);
177 class Verifier : public InstVisitor<Verifier>, VerifierSupport {
178 friend class InstVisitor<Verifier>;
180 LLVMContext *Context;
183 /// \brief When verifying a basic block, keep track of all of the
184 /// instructions we have seen so far.
186 /// This allows us to do efficient dominance checks for the case when an
187 /// instruction has an operand that is an instruction in the same block.
188 SmallPtrSet<Instruction *, 16> InstsInThisBlock;
190 /// \brief Keep track of the metadata nodes that have been checked already.
191 SmallPtrSet<const Metadata *, 32> MDNodes;
193 /// \brief Track unresolved string-based type references.
194 SmallDenseMap<const MDString *, const MDNode *, 32> UnresolvedTypeRefs;
196 /// \brief The result type for a landingpad.
197 Type *LandingPadResultTy;
199 /// \brief Whether we've seen a call to @llvm.localescape in this function
203 /// Stores the count of how many objects were passed to llvm.localescape for a
204 /// given function and the largest index passed to llvm.localrecover.
205 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
207 /// Cache of constants visited in search of ConstantExprs.
208 SmallPtrSet<const Constant *, 32> ConstantExprVisited;
210 void checkAtomicMemAccessSize(const Module *M, Type *Ty,
211 const Instruction *I);
213 explicit Verifier(raw_ostream &OS)
214 : VerifierSupport(OS), Context(nullptr), LandingPadResultTy(nullptr),
215 SawFrameEscape(false) {}
217 bool verify(const Function &F) {
219 Context = &M->getContext();
221 // First ensure the function is well-enough formed to compute dominance
224 OS << "Function '" << F.getName()
225 << "' does not contain an entry block!\n";
228 for (Function::const_iterator I = F.begin(), E = F.end(); I != E; ++I) {
229 if (I->empty() || !I->back().isTerminator()) {
230 OS << "Basic Block in function '" << F.getName()
231 << "' does not have terminator!\n";
232 I->printAsOperand(OS, true);
238 // Now directly compute a dominance tree. We don't rely on the pass
239 // manager to provide this as it isolates us from a potentially
240 // out-of-date dominator tree and makes it significantly more complex to
241 // run this code outside of a pass manager.
242 // FIXME: It's really gross that we have to cast away constness here.
243 DT.recalculate(const_cast<Function &>(F));
246 // FIXME: We strip const here because the inst visitor strips const.
247 visit(const_cast<Function &>(F));
248 InstsInThisBlock.clear();
249 LandingPadResultTy = nullptr;
250 SawFrameEscape = false;
255 bool verify(const Module &M) {
257 Context = &M.getContext();
260 // Scan through, checking all of the external function's linkage now...
261 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
262 visitGlobalValue(*I);
264 // Check to make sure function prototypes are okay.
265 if (I->isDeclaration())
269 // Now that we've visited every function, verify that we never asked to
270 // recover a frame index that wasn't escaped.
271 verifyFrameRecoverIndices();
273 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
275 visitGlobalVariable(*I);
277 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
279 visitGlobalAlias(*I);
281 for (Module::const_named_metadata_iterator I = M.named_metadata_begin(),
282 E = M.named_metadata_end();
284 visitNamedMDNode(*I);
286 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
287 visitComdat(SMEC.getValue());
290 visitModuleIdents(M);
292 // Verify type referneces last.
299 // Verification methods...
300 void visitGlobalValue(const GlobalValue &GV);
301 void visitGlobalVariable(const GlobalVariable &GV);
302 void visitGlobalAlias(const GlobalAlias &GA);
303 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
304 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
305 const GlobalAlias &A, const Constant &C);
306 void visitNamedMDNode(const NamedMDNode &NMD);
307 void visitMDNode(const MDNode &MD);
308 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
309 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
310 void visitComdat(const Comdat &C);
311 void visitModuleIdents(const Module &M);
312 void visitModuleFlags(const Module &M);
313 void visitModuleFlag(const MDNode *Op,
314 DenseMap<const MDString *, const MDNode *> &SeenIDs,
315 SmallVectorImpl<const MDNode *> &Requirements);
316 void visitFunction(const Function &F);
317 void visitBasicBlock(BasicBlock &BB);
318 void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty);
319 void visitDereferenceableMetadata(Instruction& I, MDNode* MD);
321 template <class Ty> bool isValidMetadataArray(const MDTuple &N);
322 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
323 #include "llvm/IR/Metadata.def"
324 void visitDIScope(const DIScope &N);
325 void visitDIVariable(const DIVariable &N);
326 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
327 void visitDITemplateParameter(const DITemplateParameter &N);
329 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
331 /// \brief Check for a valid string-based type reference.
333 /// Checks if \c MD is a string-based type reference. If it is, keeps track
334 /// of it (and its user, \c N) for error messages later.
335 bool isValidUUID(const MDNode &N, const Metadata *MD);
337 /// \brief Check for a valid type reference.
339 /// Checks for subclasses of \a DIType, or \a isValidUUID().
340 bool isTypeRef(const MDNode &N, const Metadata *MD);
342 /// \brief Check for a valid scope reference.
344 /// Checks for subclasses of \a DIScope, or \a isValidUUID().
345 bool isScopeRef(const MDNode &N, const Metadata *MD);
347 /// \brief Check for a valid debug info reference.
349 /// Checks for subclasses of \a DINode, or \a isValidUUID().
350 bool isDIRef(const MDNode &N, const Metadata *MD);
352 // InstVisitor overrides...
353 using InstVisitor<Verifier>::visit;
354 void visit(Instruction &I);
356 void visitTruncInst(TruncInst &I);
357 void visitZExtInst(ZExtInst &I);
358 void visitSExtInst(SExtInst &I);
359 void visitFPTruncInst(FPTruncInst &I);
360 void visitFPExtInst(FPExtInst &I);
361 void visitFPToUIInst(FPToUIInst &I);
362 void visitFPToSIInst(FPToSIInst &I);
363 void visitUIToFPInst(UIToFPInst &I);
364 void visitSIToFPInst(SIToFPInst &I);
365 void visitIntToPtrInst(IntToPtrInst &I);
366 void visitPtrToIntInst(PtrToIntInst &I);
367 void visitBitCastInst(BitCastInst &I);
368 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
369 void visitPHINode(PHINode &PN);
370 void visitBinaryOperator(BinaryOperator &B);
371 void visitICmpInst(ICmpInst &IC);
372 void visitFCmpInst(FCmpInst &FC);
373 void visitExtractElementInst(ExtractElementInst &EI);
374 void visitInsertElementInst(InsertElementInst &EI);
375 void visitShuffleVectorInst(ShuffleVectorInst &EI);
376 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
377 void visitCallInst(CallInst &CI);
378 void visitInvokeInst(InvokeInst &II);
379 void visitGetElementPtrInst(GetElementPtrInst &GEP);
380 void visitLoadInst(LoadInst &LI);
381 void visitStoreInst(StoreInst &SI);
382 void verifyDominatesUse(Instruction &I, unsigned i);
383 void visitInstruction(Instruction &I);
384 void visitTerminatorInst(TerminatorInst &I);
385 void visitBranchInst(BranchInst &BI);
386 void visitReturnInst(ReturnInst &RI);
387 void visitSwitchInst(SwitchInst &SI);
388 void visitIndirectBrInst(IndirectBrInst &BI);
389 void visitSelectInst(SelectInst &SI);
390 void visitUserOp1(Instruction &I);
391 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
392 void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS);
393 template <class DbgIntrinsicTy>
394 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
395 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
396 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
397 void visitFenceInst(FenceInst &FI);
398 void visitAllocaInst(AllocaInst &AI);
399 void visitExtractValueInst(ExtractValueInst &EVI);
400 void visitInsertValueInst(InsertValueInst &IVI);
401 void visitEHPadPredecessors(Instruction &I);
402 void visitLandingPadInst(LandingPadInst &LPI);
403 void visitCatchPadInst(CatchPadInst &CPI);
404 void visitCatchReturnInst(CatchReturnInst &CatchReturn);
405 void visitCleanupPadInst(CleanupPadInst &CPI);
406 void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch);
407 void visitCleanupReturnInst(CleanupReturnInst &CRI);
409 void VerifyCallSite(CallSite CS);
410 void verifyMustTailCall(CallInst &CI);
411 bool PerformTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
412 unsigned ArgNo, std::string &Suffix);
413 bool VerifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
414 SmallVectorImpl<Type *> &ArgTys);
415 bool VerifyIntrinsicIsVarArg(bool isVarArg,
416 ArrayRef<Intrinsic::IITDescriptor> &Infos);
417 bool VerifyAttributeCount(AttributeSet Attrs, unsigned Params);
418 void VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
420 void VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
421 bool isReturnValue, const Value *V);
422 void VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
424 void VerifyFunctionMetadata(
425 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs);
427 void visitConstantExprsRecursively(const Constant *EntryC);
428 void visitConstantExpr(const ConstantExpr *CE);
429 void VerifyStatepoint(ImmutableCallSite CS);
430 void verifyFrameRecoverIndices();
432 // Module-level debug info verification...
433 void verifyTypeRefs();
434 template <class MapTy>
435 void verifyDIExpression(const DbgInfoIntrinsic &I, const MapTy &TypeRefs);
436 void visitUnresolvedTypeRef(const MDString *S, const MDNode *N);
438 } // End anonymous namespace
440 // Assert - We know that cond should be true, if not print an error message.
441 #define Assert(C, ...) \
442 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
444 void Verifier::visit(Instruction &I) {
445 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
446 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
447 InstVisitor<Verifier>::visit(I);
451 void Verifier::visitGlobalValue(const GlobalValue &GV) {
452 Assert(!GV.isDeclaration() || GV.hasExternalLinkage() ||
453 GV.hasExternalWeakLinkage(),
454 "Global is external, but doesn't have external or weak linkage!", &GV);
456 Assert(GV.getAlignment() <= Value::MaximumAlignment,
457 "huge alignment values are unsupported", &GV);
458 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
459 "Only global variables can have appending linkage!", &GV);
461 if (GV.hasAppendingLinkage()) {
462 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
463 Assert(GVar && GVar->getValueType()->isArrayTy(),
464 "Only global arrays can have appending linkage!", GVar);
467 if (GV.isDeclarationForLinker())
468 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
471 void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
472 if (GV.hasInitializer()) {
473 Assert(GV.getInitializer()->getType() == GV.getType()->getElementType(),
474 "Global variable initializer type does not match global "
478 // If the global has common linkage, it must have a zero initializer and
479 // cannot be constant.
480 if (GV.hasCommonLinkage()) {
481 Assert(GV.getInitializer()->isNullValue(),
482 "'common' global must have a zero initializer!", &GV);
483 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
485 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
488 Assert(GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
489 "invalid linkage type for global declaration", &GV);
492 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
493 GV.getName() == "llvm.global_dtors")) {
494 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
495 "invalid linkage for intrinsic global variable", &GV);
496 // Don't worry about emitting an error for it not being an array,
497 // visitGlobalValue will complain on appending non-array.
498 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
499 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
500 PointerType *FuncPtrTy =
501 FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
502 // FIXME: Reject the 2-field form in LLVM 4.0.
504 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
505 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
506 STy->getTypeAtIndex(1) == FuncPtrTy,
507 "wrong type for intrinsic global variable", &GV);
508 if (STy->getNumElements() == 3) {
509 Type *ETy = STy->getTypeAtIndex(2);
510 Assert(ETy->isPointerTy() &&
511 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
512 "wrong type for intrinsic global variable", &GV);
517 if (GV.hasName() && (GV.getName() == "llvm.used" ||
518 GV.getName() == "llvm.compiler.used")) {
519 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
520 "invalid linkage for intrinsic global variable", &GV);
521 Type *GVType = GV.getValueType();
522 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
523 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
524 Assert(PTy, "wrong type for intrinsic global variable", &GV);
525 if (GV.hasInitializer()) {
526 const Constant *Init = GV.getInitializer();
527 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
528 Assert(InitArray, "wrong initalizer for intrinsic global variable",
530 for (unsigned i = 0, e = InitArray->getNumOperands(); i != e; ++i) {
531 Value *V = Init->getOperand(i)->stripPointerCastsNoFollowAliases();
532 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
534 "invalid llvm.used member", V);
535 Assert(V->hasName(), "members of llvm.used must be named", V);
541 Assert(!GV.hasDLLImportStorageClass() ||
542 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
543 GV.hasAvailableExternallyLinkage(),
544 "Global is marked as dllimport, but not external", &GV);
546 if (!GV.hasInitializer()) {
547 visitGlobalValue(GV);
551 // Walk any aggregate initializers looking for bitcasts between address spaces
552 visitConstantExprsRecursively(GV.getInitializer());
554 visitGlobalValue(GV);
557 void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
558 SmallPtrSet<const GlobalAlias*, 4> Visited;
560 visitAliaseeSubExpr(Visited, GA, C);
563 void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
564 const GlobalAlias &GA, const Constant &C) {
565 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
566 Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition",
569 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
570 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
572 Assert(!GA2->mayBeOverridden(), "Alias cannot point to a weak alias",
575 // Only continue verifying subexpressions of GlobalAliases.
576 // Do not recurse into global initializers.
581 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
582 visitConstantExprsRecursively(CE);
584 for (const Use &U : C.operands()) {
586 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
587 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
588 else if (const auto *C2 = dyn_cast<Constant>(V))
589 visitAliaseeSubExpr(Visited, GA, *C2);
593 void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
594 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
595 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
596 "weak_odr, or external linkage!",
598 const Constant *Aliasee = GA.getAliasee();
599 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
600 Assert(GA.getType() == Aliasee->getType(),
601 "Alias and aliasee types should match!", &GA);
603 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
604 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
606 visitAliaseeSubExpr(GA, *Aliasee);
608 visitGlobalValue(GA);
611 void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
612 for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i) {
613 MDNode *MD = NMD.getOperand(i);
615 if (NMD.getName() == "llvm.dbg.cu") {
616 Assert(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
626 void Verifier::visitMDNode(const MDNode &MD) {
627 // Only visit each node once. Metadata can be mutually recursive, so this
628 // avoids infinite recursion here, as well as being an optimization.
629 if (!MDNodes.insert(&MD).second)
632 switch (MD.getMetadataID()) {
634 llvm_unreachable("Invalid MDNode subclass");
635 case Metadata::MDTupleKind:
637 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
638 case Metadata::CLASS##Kind: \
639 visit##CLASS(cast<CLASS>(MD)); \
641 #include "llvm/IR/Metadata.def"
644 for (unsigned i = 0, e = MD.getNumOperands(); i != e; ++i) {
645 Metadata *Op = MD.getOperand(i);
648 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
650 if (auto *N = dyn_cast<MDNode>(Op)) {
654 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
655 visitValueAsMetadata(*V, nullptr);
660 // Check these last, so we diagnose problems in operands first.
661 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
662 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
665 void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
666 Assert(MD.getValue(), "Expected valid value", &MD);
667 Assert(!MD.getValue()->getType()->isMetadataTy(),
668 "Unexpected metadata round-trip through values", &MD, MD.getValue());
670 auto *L = dyn_cast<LocalAsMetadata>(&MD);
674 Assert(F, "function-local metadata used outside a function", L);
676 // If this was an instruction, bb, or argument, verify that it is in the
677 // function that we expect.
678 Function *ActualF = nullptr;
679 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
680 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
681 ActualF = I->getParent()->getParent();
682 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
683 ActualF = BB->getParent();
684 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
685 ActualF = A->getParent();
686 assert(ActualF && "Unimplemented function local metadata case!");
688 Assert(ActualF == F, "function-local metadata used in wrong function", L);
691 void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
692 Metadata *MD = MDV.getMetadata();
693 if (auto *N = dyn_cast<MDNode>(MD)) {
698 // Only visit each node once. Metadata can be mutually recursive, so this
699 // avoids infinite recursion here, as well as being an optimization.
700 if (!MDNodes.insert(MD).second)
703 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
704 visitValueAsMetadata(*V, F);
707 bool Verifier::isValidUUID(const MDNode &N, const Metadata *MD) {
708 auto *S = dyn_cast<MDString>(MD);
711 if (S->getString().empty())
714 // Keep track of names of types referenced via UUID so we can check that they
716 UnresolvedTypeRefs.insert(std::make_pair(S, &N));
720 /// \brief Check if a value can be a reference to a type.
721 bool Verifier::isTypeRef(const MDNode &N, const Metadata *MD) {
722 return !MD || isValidUUID(N, MD) || isa<DIType>(MD);
725 /// \brief Check if a value can be a ScopeRef.
726 bool Verifier::isScopeRef(const MDNode &N, const Metadata *MD) {
727 return !MD || isValidUUID(N, MD) || isa<DIScope>(MD);
730 /// \brief Check if a value can be a debug info ref.
731 bool Verifier::isDIRef(const MDNode &N, const Metadata *MD) {
732 return !MD || isValidUUID(N, MD) || isa<DINode>(MD);
736 bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
737 for (Metadata *MD : N.operands()) {
750 bool isValidMetadataArray(const MDTuple &N) {
751 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
755 bool isValidMetadataNullArray(const MDTuple &N) {
756 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
759 void Verifier::visitDILocation(const DILocation &N) {
760 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
761 "location requires a valid scope", &N, N.getRawScope());
762 if (auto *IA = N.getRawInlinedAt())
763 Assert(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
766 void Verifier::visitGenericDINode(const GenericDINode &N) {
767 Assert(N.getTag(), "invalid tag", &N);
770 void Verifier::visitDIScope(const DIScope &N) {
771 if (auto *F = N.getRawFile())
772 Assert(isa<DIFile>(F), "invalid file", &N, F);
775 void Verifier::visitDISubrange(const DISubrange &N) {
776 Assert(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
777 Assert(N.getCount() >= -1, "invalid subrange count", &N);
780 void Verifier::visitDIEnumerator(const DIEnumerator &N) {
781 Assert(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
784 void Verifier::visitDIBasicType(const DIBasicType &N) {
785 Assert(N.getTag() == dwarf::DW_TAG_base_type ||
786 N.getTag() == dwarf::DW_TAG_unspecified_type,
790 void Verifier::visitDIDerivedType(const DIDerivedType &N) {
791 // Common scope checks.
794 Assert(N.getTag() == dwarf::DW_TAG_typedef ||
795 N.getTag() == dwarf::DW_TAG_pointer_type ||
796 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
797 N.getTag() == dwarf::DW_TAG_reference_type ||
798 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
799 N.getTag() == dwarf::DW_TAG_const_type ||
800 N.getTag() == dwarf::DW_TAG_volatile_type ||
801 N.getTag() == dwarf::DW_TAG_restrict_type ||
802 N.getTag() == dwarf::DW_TAG_member ||
803 N.getTag() == dwarf::DW_TAG_inheritance ||
804 N.getTag() == dwarf::DW_TAG_friend,
806 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
807 Assert(isTypeRef(N, N.getExtraData()), "invalid pointer to member type", &N,
811 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
812 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
816 static bool hasConflictingReferenceFlags(unsigned Flags) {
817 return (Flags & DINode::FlagLValueReference) &&
818 (Flags & DINode::FlagRValueReference);
821 void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
822 auto *Params = dyn_cast<MDTuple>(&RawParams);
823 Assert(Params, "invalid template params", &N, &RawParams);
824 for (Metadata *Op : Params->operands()) {
825 Assert(Op && isa<DITemplateParameter>(Op), "invalid template parameter", &N,
830 void Verifier::visitDICompositeType(const DICompositeType &N) {
831 // Common scope checks.
834 Assert(N.getTag() == dwarf::DW_TAG_array_type ||
835 N.getTag() == dwarf::DW_TAG_structure_type ||
836 N.getTag() == dwarf::DW_TAG_union_type ||
837 N.getTag() == dwarf::DW_TAG_enumeration_type ||
838 N.getTag() == dwarf::DW_TAG_class_type,
841 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
842 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
845 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
846 "invalid composite elements", &N, N.getRawElements());
847 Assert(isTypeRef(N, N.getRawVTableHolder()), "invalid vtable holder", &N,
848 N.getRawVTableHolder());
849 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
851 if (auto *Params = N.getRawTemplateParams())
852 visitTemplateParams(N, *Params);
854 if (N.getTag() == dwarf::DW_TAG_class_type ||
855 N.getTag() == dwarf::DW_TAG_union_type) {
856 Assert(N.getFile() && !N.getFile()->getFilename().empty(),
857 "class/union requires a filename", &N, N.getFile());
861 void Verifier::visitDISubroutineType(const DISubroutineType &N) {
862 Assert(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
863 if (auto *Types = N.getRawTypeArray()) {
864 Assert(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
865 for (Metadata *Ty : N.getTypeArray()->operands()) {
866 Assert(isTypeRef(N, Ty), "invalid subroutine type ref", &N, Types, Ty);
869 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
873 void Verifier::visitDIFile(const DIFile &N) {
874 Assert(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
877 void Verifier::visitDICompileUnit(const DICompileUnit &N) {
878 Assert(N.isDistinct(), "compile units must be distinct", &N);
879 Assert(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
881 // Don't bother verifying the compilation directory or producer string
882 // as those could be empty.
883 Assert(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
885 Assert(!N.getFile()->getFilename().empty(), "invalid filename", &N,
888 if (auto *Array = N.getRawEnumTypes()) {
889 Assert(isa<MDTuple>(Array), "invalid enum list", &N, Array);
890 for (Metadata *Op : N.getEnumTypes()->operands()) {
891 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
892 Assert(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
893 "invalid enum type", &N, N.getEnumTypes(), Op);
896 if (auto *Array = N.getRawRetainedTypes()) {
897 Assert(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
898 for (Metadata *Op : N.getRetainedTypes()->operands()) {
899 Assert(Op && isa<DIType>(Op), "invalid retained type", &N, Op);
902 if (auto *Array = N.getRawSubprograms()) {
903 Assert(isa<MDTuple>(Array), "invalid subprogram list", &N, Array);
904 for (Metadata *Op : N.getSubprograms()->operands()) {
905 Assert(Op && isa<DISubprogram>(Op), "invalid subprogram ref", &N, Op);
908 if (auto *Array = N.getRawGlobalVariables()) {
909 Assert(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
910 for (Metadata *Op : N.getGlobalVariables()->operands()) {
911 Assert(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref", &N,
915 if (auto *Array = N.getRawImportedEntities()) {
916 Assert(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
917 for (Metadata *Op : N.getImportedEntities()->operands()) {
918 Assert(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref", &N,
922 if (auto *Array = N.getRawMacros()) {
923 Assert(isa<MDTuple>(Array), "invalid macro list", &N, Array);
924 for (Metadata *Op : N.getMacros()->operands()) {
925 Assert(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
930 void Verifier::visitDISubprogram(const DISubprogram &N) {
931 Assert(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
932 Assert(isScopeRef(N, N.getRawScope()), "invalid scope", &N, N.getRawScope());
933 if (auto *T = N.getRawType())
934 Assert(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
935 Assert(isTypeRef(N, N.getRawContainingType()), "invalid containing type", &N,
936 N.getRawContainingType());
937 if (auto *Params = N.getRawTemplateParams())
938 visitTemplateParams(N, *Params);
939 if (auto *S = N.getRawDeclaration()) {
940 Assert(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
941 "invalid subprogram declaration", &N, S);
943 if (auto *RawVars = N.getRawVariables()) {
944 auto *Vars = dyn_cast<MDTuple>(RawVars);
945 Assert(Vars, "invalid variable list", &N, RawVars);
946 for (Metadata *Op : Vars->operands()) {
947 Assert(Op && isa<DILocalVariable>(Op), "invalid local variable", &N, Vars,
951 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
954 if (N.isDefinition())
955 Assert(N.isDistinct(), "subprogram definitions must be distinct", &N);
958 void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
959 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
960 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
961 "invalid local scope", &N, N.getRawScope());
964 void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
965 visitDILexicalBlockBase(N);
967 Assert(N.getLine() || !N.getColumn(),
968 "cannot have column info without line info", &N);
971 void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
972 visitDILexicalBlockBase(N);
975 void Verifier::visitDINamespace(const DINamespace &N) {
976 Assert(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
977 if (auto *S = N.getRawScope())
978 Assert(isa<DIScope>(S), "invalid scope ref", &N, S);
981 void Verifier::visitDIMacro(const DIMacro &N) {
982 Assert(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
983 N.getMacinfoType() == dwarf::DW_MACINFO_undef,
984 "invalid macinfo type", &N);
985 Assert(!N.getName().empty(), "anonymous macro", &N);
986 if (!N.getValue().empty()) {
987 assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
991 void Verifier::visitDIMacroFile(const DIMacroFile &N) {
992 Assert(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
993 "invalid macinfo type", &N);
994 if (auto *F = N.getRawFile())
995 Assert(isa<DIFile>(F), "invalid file", &N, F);
997 if (auto *Array = N.getRawElements()) {
998 Assert(isa<MDTuple>(Array), "invalid macro list", &N, Array);
999 for (Metadata *Op : N.getElements()->operands()) {
1000 Assert(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
1005 void Verifier::visitDIModule(const DIModule &N) {
1006 Assert(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1007 Assert(!N.getName().empty(), "anonymous module", &N);
1010 void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
1011 Assert(isTypeRef(N, N.getType()), "invalid type ref", &N, N.getType());
1014 void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1015 visitDITemplateParameter(N);
1017 Assert(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1021 void Verifier::visitDITemplateValueParameter(
1022 const DITemplateValueParameter &N) {
1023 visitDITemplateParameter(N);
1025 Assert(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1026 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1027 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1031 void Verifier::visitDIVariable(const DIVariable &N) {
1032 if (auto *S = N.getRawScope())
1033 Assert(isa<DIScope>(S), "invalid scope", &N, S);
1034 Assert(isTypeRef(N, N.getRawType()), "invalid type ref", &N, N.getRawType());
1035 if (auto *F = N.getRawFile())
1036 Assert(isa<DIFile>(F), "invalid file", &N, F);
1039 void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
1040 // Checks common to all variables.
1043 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1044 Assert(!N.getName().empty(), "missing global variable name", &N);
1045 if (auto *V = N.getRawVariable()) {
1046 Assert(isa<ConstantAsMetadata>(V) &&
1047 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
1048 "invalid global varaible ref", &N, V);
1050 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
1051 Assert(isa<DIDerivedType>(Member), "invalid static data member declaration",
1056 void Verifier::visitDILocalVariable(const DILocalVariable &N) {
1057 // Checks common to all variables.
1060 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1061 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1062 "local variable requires a valid scope", &N, N.getRawScope());
1065 void Verifier::visitDIExpression(const DIExpression &N) {
1066 Assert(N.isValid(), "invalid expression", &N);
1069 void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
1070 Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
1071 if (auto *T = N.getRawType())
1072 Assert(isTypeRef(N, T), "invalid type ref", &N, T);
1073 if (auto *F = N.getRawFile())
1074 Assert(isa<DIFile>(F), "invalid file", &N, F);
1077 void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
1078 Assert(N.getTag() == dwarf::DW_TAG_imported_module ||
1079 N.getTag() == dwarf::DW_TAG_imported_declaration,
1081 if (auto *S = N.getRawScope())
1082 Assert(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1083 Assert(isDIRef(N, N.getEntity()), "invalid imported entity", &N,
1087 void Verifier::visitComdat(const Comdat &C) {
1088 // The Module is invalid if the GlobalValue has private linkage. Entities
1089 // with private linkage don't have entries in the symbol table.
1090 if (const GlobalValue *GV = M->getNamedValue(C.getName()))
1091 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1095 void Verifier::visitModuleIdents(const Module &M) {
1096 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1100 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1101 // Scan each llvm.ident entry and make sure that this requirement is met.
1102 for (unsigned i = 0, e = Idents->getNumOperands(); i != e; ++i) {
1103 const MDNode *N = Idents->getOperand(i);
1104 Assert(N->getNumOperands() == 1,
1105 "incorrect number of operands in llvm.ident metadata", N);
1106 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1107 ("invalid value for llvm.ident metadata entry operand"
1108 "(the operand should be a string)"),
1113 void Verifier::visitModuleFlags(const Module &M) {
1114 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1117 // Scan each flag, and track the flags and requirements.
1118 DenseMap<const MDString*, const MDNode*> SeenIDs;
1119 SmallVector<const MDNode*, 16> Requirements;
1120 for (unsigned I = 0, E = Flags->getNumOperands(); I != E; ++I) {
1121 visitModuleFlag(Flags->getOperand(I), SeenIDs, Requirements);
1124 // Validate that the requirements in the module are valid.
1125 for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
1126 const MDNode *Requirement = Requirements[I];
1127 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
1128 const Metadata *ReqValue = Requirement->getOperand(1);
1130 const MDNode *Op = SeenIDs.lookup(Flag);
1132 CheckFailed("invalid requirement on flag, flag is not present in module",
1137 if (Op->getOperand(2) != ReqValue) {
1138 CheckFailed(("invalid requirement on flag, "
1139 "flag does not have the required value"),
1147 Verifier::visitModuleFlag(const MDNode *Op,
1148 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1149 SmallVectorImpl<const MDNode *> &Requirements) {
1150 // Each module flag should have three arguments, the merge behavior (a
1151 // constant int), the flag ID (an MDString), and the value.
1152 Assert(Op->getNumOperands() == 3,
1153 "incorrect number of operands in module flag", Op);
1154 Module::ModFlagBehavior MFB;
1155 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
1157 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
1158 "invalid behavior operand in module flag (expected constant integer)",
1161 "invalid behavior operand in module flag (unexpected constant)",
1164 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
1165 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1168 // Sanity check the values for behaviors with additional requirements.
1171 case Module::Warning:
1172 case Module::Override:
1173 // These behavior types accept any value.
1176 case Module::Require: {
1177 // The value should itself be an MDNode with two operands, a flag ID (an
1178 // MDString), and a value.
1179 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
1180 Assert(Value && Value->getNumOperands() == 2,
1181 "invalid value for 'require' module flag (expected metadata pair)",
1183 Assert(isa<MDString>(Value->getOperand(0)),
1184 ("invalid value for 'require' module flag "
1185 "(first value operand should be a string)"),
1186 Value->getOperand(0));
1188 // Append it to the list of requirements, to check once all module flags are
1190 Requirements.push_back(Value);
1194 case Module::Append:
1195 case Module::AppendUnique: {
1196 // These behavior types require the operand be an MDNode.
1197 Assert(isa<MDNode>(Op->getOperand(2)),
1198 "invalid value for 'append'-type module flag "
1199 "(expected a metadata node)",
1205 // Unless this is a "requires" flag, check the ID is unique.
1206 if (MFB != Module::Require) {
1207 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
1209 "module flag identifiers must be unique (or of 'require' type)", ID);
1213 void Verifier::VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
1214 bool isFunction, const Value *V) {
1215 unsigned Slot = ~0U;
1216 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1217 if (Attrs.getSlotIndex(I) == Idx) {
1222 assert(Slot != ~0U && "Attribute set inconsistency!");
1224 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1226 if (I->isStringAttribute())
1229 if (I->getKindAsEnum() == Attribute::NoReturn ||
1230 I->getKindAsEnum() == Attribute::NoUnwind ||
1231 I->getKindAsEnum() == Attribute::NoInline ||
1232 I->getKindAsEnum() == Attribute::AlwaysInline ||
1233 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1234 I->getKindAsEnum() == Attribute::StackProtect ||
1235 I->getKindAsEnum() == Attribute::StackProtectReq ||
1236 I->getKindAsEnum() == Attribute::StackProtectStrong ||
1237 I->getKindAsEnum() == Attribute::SafeStack ||
1238 I->getKindAsEnum() == Attribute::NoRedZone ||
1239 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1240 I->getKindAsEnum() == Attribute::Naked ||
1241 I->getKindAsEnum() == Attribute::InlineHint ||
1242 I->getKindAsEnum() == Attribute::StackAlignment ||
1243 I->getKindAsEnum() == Attribute::UWTable ||
1244 I->getKindAsEnum() == Attribute::NonLazyBind ||
1245 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1246 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1247 I->getKindAsEnum() == Attribute::SanitizeThread ||
1248 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1249 I->getKindAsEnum() == Attribute::MinSize ||
1250 I->getKindAsEnum() == Attribute::NoDuplicate ||
1251 I->getKindAsEnum() == Attribute::Builtin ||
1252 I->getKindAsEnum() == Attribute::NoBuiltin ||
1253 I->getKindAsEnum() == Attribute::Cold ||
1254 I->getKindAsEnum() == Attribute::OptimizeNone ||
1255 I->getKindAsEnum() == Attribute::JumpTable ||
1256 I->getKindAsEnum() == Attribute::Convergent ||
1257 I->getKindAsEnum() == Attribute::ArgMemOnly ||
1258 I->getKindAsEnum() == Attribute::NoRecurse ||
1259 I->getKindAsEnum() == Attribute::InaccessibleMemOnly ||
1260 I->getKindAsEnum() == Attribute::InaccessibleMemOrArgMemOnly) {
1262 CheckFailed("Attribute '" + I->getAsString() +
1263 "' only applies to functions!", V);
1266 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
1267 I->getKindAsEnum() == Attribute::ReadNone) {
1269 CheckFailed("Attribute '" + I->getAsString() +
1270 "' does not apply to function returns");
1273 } else if (isFunction) {
1274 CheckFailed("Attribute '" + I->getAsString() +
1275 "' does not apply to functions!", V);
1281 // VerifyParameterAttrs - Check the given attributes for an argument or return
1282 // value of the specified type. The value V is printed in error messages.
1283 void Verifier::VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
1284 bool isReturnValue, const Value *V) {
1285 if (!Attrs.hasAttributes(Idx))
1288 VerifyAttributeTypes(Attrs, Idx, false, V);
1291 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1292 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1293 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1294 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1295 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
1296 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1297 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', and "
1298 "'returned' do not apply to return values!",
1301 // Check for mutually incompatible attributes. Only inreg is compatible with
1303 unsigned AttrCount = 0;
1304 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1305 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1306 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1307 Attrs.hasAttribute(Idx, Attribute::InReg);
1308 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
1309 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1310 "and 'sret' are incompatible!",
1313 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1314 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1316 "'inalloca and readonly' are incompatible!",
1319 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1320 Attrs.hasAttribute(Idx, Attribute::Returned)),
1322 "'sret and returned' are incompatible!",
1325 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1326 Attrs.hasAttribute(Idx, Attribute::SExt)),
1328 "'zeroext and signext' are incompatible!",
1331 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1332 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1334 "'readnone and readonly' are incompatible!",
1337 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1338 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1340 "'noinline and alwaysinline' are incompatible!",
1343 Assert(!AttrBuilder(Attrs, Idx)
1344 .overlaps(AttributeFuncs::typeIncompatible(Ty)),
1345 "Wrong types for attribute: " +
1346 AttributeSet::get(*Context, Idx,
1347 AttributeFuncs::typeIncompatible(Ty)).getAsString(Idx),
1350 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
1351 SmallPtrSet<Type*, 4> Visited;
1352 if (!PTy->getElementType()->isSized(&Visited)) {
1353 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1354 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1355 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1359 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1360 "Attribute 'byval' only applies to parameters with pointer type!",
1365 // VerifyFunctionAttrs - Check parameter attributes against a function type.
1366 // The value V is printed in error messages.
1367 void Verifier::VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
1369 if (Attrs.isEmpty())
1372 bool SawNest = false;
1373 bool SawReturned = false;
1374 bool SawSRet = false;
1376 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
1377 unsigned Idx = Attrs.getSlotIndex(i);
1381 Ty = FT->getReturnType();
1382 else if (Idx-1 < FT->getNumParams())
1383 Ty = FT->getParamType(Idx-1);
1385 break; // VarArgs attributes, verified elsewhere.
1387 VerifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
1392 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
1393 Assert(!SawNest, "More than one parameter has attribute nest!", V);
1397 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
1398 Assert(!SawReturned, "More than one parameter has attribute returned!",
1400 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1402 "argument and return types for 'returned' attribute",
1407 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
1408 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1409 Assert(Idx == 1 || Idx == 2,
1410 "Attribute 'sret' is not on first or second parameter!", V);
1414 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
1415 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1420 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1423 VerifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
1426 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1427 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1428 "Attributes 'readnone and readonly' are incompatible!", V);
1431 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1432 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1433 Attribute::InaccessibleMemOrArgMemOnly)),
1434 "Attributes 'readnone and inaccessiblemem_or_argmemonly' are incompatible!", V);
1437 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1438 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1439 Attribute::InaccessibleMemOnly)),
1440 "Attributes 'readnone and inaccessiblememonly' are incompatible!", V);
1443 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1444 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1445 Attribute::AlwaysInline)),
1446 "Attributes 'noinline and alwaysinline' are incompatible!", V);
1448 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1449 Attribute::OptimizeNone)) {
1450 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1451 "Attribute 'optnone' requires 'noinline'!", V);
1453 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1454 Attribute::OptimizeForSize),
1455 "Attributes 'optsize and optnone' are incompatible!", V);
1457 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1458 "Attributes 'minsize and optnone' are incompatible!", V);
1461 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1462 Attribute::JumpTable)) {
1463 const GlobalValue *GV = cast<GlobalValue>(V);
1464 Assert(GV->hasUnnamedAddr(),
1465 "Attribute 'jumptable' requires 'unnamed_addr'", V);
1469 void Verifier::VerifyFunctionMetadata(
1470 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs) {
1474 for (unsigned i = 0; i < MDs.size(); i++) {
1475 if (MDs[i].first == LLVMContext::MD_prof) {
1476 MDNode *MD = MDs[i].second;
1477 Assert(MD->getNumOperands() == 2,
1478 "!prof annotations should have exactly 2 operands", MD);
1480 // Check first operand.
1481 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1483 Assert(isa<MDString>(MD->getOperand(0)),
1484 "expected string with name of the !prof annotation", MD);
1485 MDString *MDS = cast<MDString>(MD->getOperand(0));
1486 StringRef ProfName = MDS->getString();
1487 Assert(ProfName.equals("function_entry_count"),
1488 "first operand should be 'function_entry_count'", MD);
1490 // Check second operand.
1491 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1493 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1494 "expected integer argument to function_entry_count", MD);
1499 void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
1500 if (!ConstantExprVisited.insert(EntryC).second)
1503 SmallVector<const Constant *, 16> Stack;
1504 Stack.push_back(EntryC);
1506 while (!Stack.empty()) {
1507 const Constant *C = Stack.pop_back_val();
1509 // Check this constant expression.
1510 if (const auto *CE = dyn_cast<ConstantExpr>(C))
1511 visitConstantExpr(CE);
1513 // Visit all sub-expressions.
1514 for (const Use &U : C->operands()) {
1515 const auto *OpC = dyn_cast<Constant>(U);
1518 if (isa<GlobalValue>(OpC))
1519 continue; // Global values get visited separately.
1520 if (!ConstantExprVisited.insert(OpC).second)
1522 Stack.push_back(OpC);
1527 void Verifier::visitConstantExpr(const ConstantExpr *CE) {
1528 if (CE->getOpcode() != Instruction::BitCast)
1531 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1533 "Invalid bitcast", CE);
1536 bool Verifier::VerifyAttributeCount(AttributeSet Attrs, unsigned Params) {
1537 if (Attrs.getNumSlots() == 0)
1540 unsigned LastSlot = Attrs.getNumSlots() - 1;
1541 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
1542 if (LastIndex <= Params
1543 || (LastIndex == AttributeSet::FunctionIndex
1544 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
1550 /// \brief Verify that statepoint intrinsic is well formed.
1551 void Verifier::VerifyStatepoint(ImmutableCallSite CS) {
1552 assert(CS.getCalledFunction() &&
1553 CS.getCalledFunction()->getIntrinsicID() ==
1554 Intrinsic::experimental_gc_statepoint);
1556 const Instruction &CI = *CS.getInstruction();
1558 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1559 !CS.onlyAccessesArgMemory(),
1560 "gc.statepoint must read and write all memory to preserve "
1561 "reordering restrictions required by safepoint semantics",
1564 const Value *IDV = CS.getArgument(0);
1565 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1568 const Value *NumPatchBytesV = CS.getArgument(1);
1569 Assert(isa<ConstantInt>(NumPatchBytesV),
1570 "gc.statepoint number of patchable bytes must be a constant integer",
1572 const int64_t NumPatchBytes =
1573 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1574 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1575 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1579 const Value *Target = CS.getArgument(2);
1580 auto *PT = dyn_cast<PointerType>(Target->getType());
1581 Assert(PT && PT->getElementType()->isFunctionTy(),
1582 "gc.statepoint callee must be of function pointer type", &CI, Target);
1583 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
1585 const Value *NumCallArgsV = CS.getArgument(3);
1586 Assert(isa<ConstantInt>(NumCallArgsV),
1587 "gc.statepoint number of arguments to underlying call "
1588 "must be constant integer",
1590 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
1591 Assert(NumCallArgs >= 0,
1592 "gc.statepoint number of arguments to underlying call "
1595 const int NumParams = (int)TargetFuncType->getNumParams();
1596 if (TargetFuncType->isVarArg()) {
1597 Assert(NumCallArgs >= NumParams,
1598 "gc.statepoint mismatch in number of vararg call args", &CI);
1600 // TODO: Remove this limitation
1601 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1602 "gc.statepoint doesn't support wrapping non-void "
1603 "vararg functions yet",
1606 Assert(NumCallArgs == NumParams,
1607 "gc.statepoint mismatch in number of call args", &CI);
1609 const Value *FlagsV = CS.getArgument(4);
1610 Assert(isa<ConstantInt>(FlagsV),
1611 "gc.statepoint flags must be constant integer", &CI);
1612 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1613 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1614 "unknown flag used in gc.statepoint flags argument", &CI);
1616 // Verify that the types of the call parameter arguments match
1617 // the type of the wrapped callee.
1618 for (int i = 0; i < NumParams; i++) {
1619 Type *ParamType = TargetFuncType->getParamType(i);
1620 Type *ArgType = CS.getArgument(5 + i)->getType();
1621 Assert(ArgType == ParamType,
1622 "gc.statepoint call argument does not match wrapped "
1627 const int EndCallArgsInx = 4 + NumCallArgs;
1629 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1630 Assert(isa<ConstantInt>(NumTransitionArgsV),
1631 "gc.statepoint number of transition arguments "
1632 "must be constant integer",
1634 const int NumTransitionArgs =
1635 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1636 Assert(NumTransitionArgs >= 0,
1637 "gc.statepoint number of transition arguments must be positive", &CI);
1638 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1640 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
1641 Assert(isa<ConstantInt>(NumDeoptArgsV),
1642 "gc.statepoint number of deoptimization arguments "
1643 "must be constant integer",
1645 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
1646 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1650 const int ExpectedNumArgs =
1651 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
1652 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
1653 "gc.statepoint too few arguments according to length fields", &CI);
1655 // Check that the only uses of this gc.statepoint are gc.result or
1656 // gc.relocate calls which are tied to this statepoint and thus part
1657 // of the same statepoint sequence
1658 for (const User *U : CI.users()) {
1659 const CallInst *Call = dyn_cast<const CallInst>(U);
1660 Assert(Call, "illegal use of statepoint token", &CI, U);
1661 if (!Call) continue;
1662 Assert(isa<GCRelocateInst>(Call) || isGCResult(Call),
1663 "gc.result or gc.relocate are the only value uses"
1664 "of a gc.statepoint",
1666 if (isGCResult(Call)) {
1667 Assert(Call->getArgOperand(0) == &CI,
1668 "gc.result connected to wrong gc.statepoint", &CI, Call);
1669 } else if (isa<GCRelocateInst>(Call)) {
1670 Assert(Call->getArgOperand(0) == &CI,
1671 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
1675 // Note: It is legal for a single derived pointer to be listed multiple
1676 // times. It's non-optimal, but it is legal. It can also happen after
1677 // insertion if we strip a bitcast away.
1678 // Note: It is really tempting to check that each base is relocated and
1679 // that a derived pointer is never reused as a base pointer. This turns
1680 // out to be problematic since optimizations run after safepoint insertion
1681 // can recognize equality properties that the insertion logic doesn't know
1682 // about. See example statepoint.ll in the verifier subdirectory
1685 void Verifier::verifyFrameRecoverIndices() {
1686 for (auto &Counts : FrameEscapeInfo) {
1687 Function *F = Counts.first;
1688 unsigned EscapedObjectCount = Counts.second.first;
1689 unsigned MaxRecoveredIndex = Counts.second.second;
1690 Assert(MaxRecoveredIndex <= EscapedObjectCount,
1691 "all indices passed to llvm.localrecover must be less than the "
1692 "number of arguments passed ot llvm.localescape in the parent "
1698 // visitFunction - Verify that a function is ok.
1700 void Verifier::visitFunction(const Function &F) {
1701 // Check function arguments.
1702 FunctionType *FT = F.getFunctionType();
1703 unsigned NumArgs = F.arg_size();
1705 Assert(Context == &F.getContext(),
1706 "Function context does not match Module context!", &F);
1708 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1709 Assert(FT->getNumParams() == NumArgs,
1710 "# formal arguments must match # of arguments for function type!", &F,
1712 Assert(F.getReturnType()->isFirstClassType() ||
1713 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1714 "Functions cannot return aggregate values!", &F);
1716 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1717 "Invalid struct return type!", &F);
1719 AttributeSet Attrs = F.getAttributes();
1721 Assert(VerifyAttributeCount(Attrs, FT->getNumParams()),
1722 "Attribute after last parameter!", &F);
1724 // Check function attributes.
1725 VerifyFunctionAttrs(FT, Attrs, &F);
1727 // On function declarations/definitions, we do not support the builtin
1728 // attribute. We do not check this in VerifyFunctionAttrs since that is
1729 // checking for Attributes that can/can not ever be on functions.
1730 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1731 "Attribute 'builtin' can only be applied to a callsite.", &F);
1733 // Check that this function meets the restrictions on this calling convention.
1734 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1735 // restrictions can be lifted.
1736 switch (F.getCallingConv()) {
1738 case CallingConv::C:
1740 case CallingConv::Fast:
1741 case CallingConv::Cold:
1742 case CallingConv::Intel_OCL_BI:
1743 case CallingConv::PTX_Kernel:
1744 case CallingConv::PTX_Device:
1745 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1746 "perfect forwarding!",
1751 bool isLLVMdotName = F.getName().size() >= 5 &&
1752 F.getName().substr(0, 5) == "llvm.";
1754 // Check that the argument values match the function type for this function...
1756 for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E;
1758 Assert(I->getType() == FT->getParamType(i),
1759 "Argument value does not match function argument type!", I,
1760 FT->getParamType(i));
1761 Assert(I->getType()->isFirstClassType(),
1762 "Function arguments must have first-class types!", I);
1763 if (!isLLVMdotName) {
1764 Assert(!I->getType()->isMetadataTy(),
1765 "Function takes metadata but isn't an intrinsic", I, &F);
1766 Assert(!I->getType()->isTokenTy(),
1767 "Function takes token but isn't an intrinsic", I, &F);
1772 Assert(!F.getReturnType()->isTokenTy(),
1773 "Functions returns a token but isn't an intrinsic", &F);
1775 // Get the function metadata attachments.
1776 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1777 F.getAllMetadata(MDs);
1778 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
1779 VerifyFunctionMetadata(MDs);
1781 // Check validity of the personality function
1782 if (F.hasPersonalityFn()) {
1783 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
1785 Assert(Per->getParent() == F.getParent(),
1786 "Referencing personality function in another module!",
1787 &F, F.getParent(), Per, Per->getParent());
1790 if (F.isMaterializable()) {
1791 // Function has a body somewhere we can't see.
1792 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
1793 MDs.empty() ? nullptr : MDs.front().second);
1794 } else if (F.isDeclaration()) {
1795 Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1796 "invalid linkage type for function declaration", &F);
1797 Assert(MDs.empty(), "function without a body cannot have metadata", &F,
1798 MDs.empty() ? nullptr : MDs.front().second);
1799 Assert(!F.hasPersonalityFn(),
1800 "Function declaration shouldn't have a personality routine", &F);
1802 // Verify that this function (which has a body) is not named "llvm.*". It
1803 // is not legal to define intrinsics.
1804 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
1806 // Check the entry node
1807 const BasicBlock *Entry = &F.getEntryBlock();
1808 Assert(pred_empty(Entry),
1809 "Entry block to function must not have predecessors!", Entry);
1811 // The address of the entry block cannot be taken, unless it is dead.
1812 if (Entry->hasAddressTaken()) {
1813 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1814 "blockaddress may not be used with the entry block!", Entry);
1817 // Visit metadata attachments.
1818 for (const auto &I : MDs) {
1819 // Verify that the attachment is legal.
1823 case LLVMContext::MD_dbg:
1824 Assert(isa<DISubprogram>(I.second),
1825 "function !dbg attachment must be a subprogram", &F, I.second);
1829 // Verify the metadata itself.
1830 visitMDNode(*I.second);
1834 // If this function is actually an intrinsic, verify that it is only used in
1835 // direct call/invokes, never having its "address taken".
1836 // Only do this if the module is materialized, otherwise we don't have all the
1838 if (F.getIntrinsicID() && F.getParent()->isMaterialized()) {
1840 if (F.hasAddressTaken(&U))
1841 Assert(0, "Invalid user of intrinsic instruction!", U);
1844 Assert(!F.hasDLLImportStorageClass() ||
1845 (F.isDeclaration() && F.hasExternalLinkage()) ||
1846 F.hasAvailableExternallyLinkage(),
1847 "Function is marked as dllimport, but not external.", &F);
1849 auto *N = F.getSubprogram();
1853 // Check that all !dbg attachments lead to back to N (or, at least, another
1854 // subprogram that describes the same function).
1856 // FIXME: Check this incrementally while visiting !dbg attachments.
1857 // FIXME: Only check when N is the canonical subprogram for F.
1858 SmallPtrSet<const MDNode *, 32> Seen;
1860 for (auto &I : BB) {
1861 // Be careful about using DILocation here since we might be dealing with
1862 // broken code (this is the Verifier after all).
1864 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
1867 if (!Seen.insert(DL).second)
1870 DILocalScope *Scope = DL->getInlinedAtScope();
1871 if (Scope && !Seen.insert(Scope).second)
1874 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
1876 // Scope and SP could be the same MDNode and we don't want to skip
1877 // validation in that case
1878 if (SP && ((Scope != SP) && !Seen.insert(SP).second))
1881 // FIXME: Once N is canonical, check "SP == &N".
1882 Assert(SP->describes(&F),
1883 "!dbg attachment points at wrong subprogram for function", N, &F,
1888 // verifyBasicBlock - Verify that a basic block is well formed...
1890 void Verifier::visitBasicBlock(BasicBlock &BB) {
1891 InstsInThisBlock.clear();
1893 // Ensure that basic blocks have terminators!
1894 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
1896 // Check constraints that this basic block imposes on all of the PHI nodes in
1898 if (isa<PHINode>(BB.front())) {
1899 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
1900 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
1901 std::sort(Preds.begin(), Preds.end());
1903 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
1904 // Ensure that PHI nodes have at least one entry!
1905 Assert(PN->getNumIncomingValues() != 0,
1906 "PHI nodes must have at least one entry. If the block is dead, "
1907 "the PHI should be removed!",
1909 Assert(PN->getNumIncomingValues() == Preds.size(),
1910 "PHINode should have one entry for each predecessor of its "
1911 "parent basic block!",
1914 // Get and sort all incoming values in the PHI node...
1916 Values.reserve(PN->getNumIncomingValues());
1917 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1918 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
1919 PN->getIncomingValue(i)));
1920 std::sort(Values.begin(), Values.end());
1922 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
1923 // Check to make sure that if there is more than one entry for a
1924 // particular basic block in this PHI node, that the incoming values are
1927 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
1928 Values[i].second == Values[i - 1].second,
1929 "PHI node has multiple entries for the same basic block with "
1930 "different incoming values!",
1931 PN, Values[i].first, Values[i].second, Values[i - 1].second);
1933 // Check to make sure that the predecessors and PHI node entries are
1935 Assert(Values[i].first == Preds[i],
1936 "PHI node entries do not match predecessors!", PN,
1937 Values[i].first, Preds[i]);
1942 // Check that all instructions have their parent pointers set up correctly.
1945 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
1949 void Verifier::visitTerminatorInst(TerminatorInst &I) {
1950 // Ensure that terminators only exist at the end of the basic block.
1951 Assert(&I == I.getParent()->getTerminator(),
1952 "Terminator found in the middle of a basic block!", I.getParent());
1953 visitInstruction(I);
1956 void Verifier::visitBranchInst(BranchInst &BI) {
1957 if (BI.isConditional()) {
1958 Assert(BI.getCondition()->getType()->isIntegerTy(1),
1959 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
1961 visitTerminatorInst(BI);
1964 void Verifier::visitReturnInst(ReturnInst &RI) {
1965 Function *F = RI.getParent()->getParent();
1966 unsigned N = RI.getNumOperands();
1967 if (F->getReturnType()->isVoidTy())
1969 "Found return instr that returns non-void in Function of void "
1971 &RI, F->getReturnType());
1973 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
1974 "Function return type does not match operand "
1975 "type of return inst!",
1976 &RI, F->getReturnType());
1978 // Check to make sure that the return value has necessary properties for
1980 visitTerminatorInst(RI);
1983 void Verifier::visitSwitchInst(SwitchInst &SI) {
1984 // Check to make sure that all of the constants in the switch instruction
1985 // have the same type as the switched-on value.
1986 Type *SwitchTy = SI.getCondition()->getType();
1987 SmallPtrSet<ConstantInt*, 32> Constants;
1988 for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end(); i != e; ++i) {
1989 Assert(i.getCaseValue()->getType() == SwitchTy,
1990 "Switch constants must all be same type as switch value!", &SI);
1991 Assert(Constants.insert(i.getCaseValue()).second,
1992 "Duplicate integer as switch case", &SI, i.getCaseValue());
1995 visitTerminatorInst(SI);
1998 void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
1999 Assert(BI.getAddress()->getType()->isPointerTy(),
2000 "Indirectbr operand must have pointer type!", &BI);
2001 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
2002 Assert(BI.getDestination(i)->getType()->isLabelTy(),
2003 "Indirectbr destinations must all have pointer type!", &BI);
2005 visitTerminatorInst(BI);
2008 void Verifier::visitSelectInst(SelectInst &SI) {
2009 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
2011 "Invalid operands for select instruction!", &SI);
2013 Assert(SI.getTrueValue()->getType() == SI.getType(),
2014 "Select values must have same type as select instruction!", &SI);
2015 visitInstruction(SI);
2018 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
2019 /// a pass, if any exist, it's an error.
2021 void Verifier::visitUserOp1(Instruction &I) {
2022 Assert(0, "User-defined operators should not live outside of a pass!", &I);
2025 void Verifier::visitTruncInst(TruncInst &I) {
2026 // Get the source and destination types
2027 Type *SrcTy = I.getOperand(0)->getType();
2028 Type *DestTy = I.getType();
2030 // Get the size of the types in bits, we'll need this later
2031 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2032 unsigned DestBitSize = DestTy->getScalarSizeInBits();
2034 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
2035 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
2036 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2037 "trunc source and destination must both be a vector or neither", &I);
2038 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
2040 visitInstruction(I);
2043 void Verifier::visitZExtInst(ZExtInst &I) {
2044 // Get the source and destination types
2045 Type *SrcTy = I.getOperand(0)->getType();
2046 Type *DestTy = I.getType();
2048 // Get the size of the types in bits, we'll need this later
2049 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
2050 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
2051 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2052 "zext source and destination must both be a vector or neither", &I);
2053 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2054 unsigned DestBitSize = DestTy->getScalarSizeInBits();
2056 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
2058 visitInstruction(I);
2061 void Verifier::visitSExtInst(SExtInst &I) {
2062 // Get the source and destination types
2063 Type *SrcTy = I.getOperand(0)->getType();
2064 Type *DestTy = I.getType();
2066 // Get the size of the types in bits, we'll need this later
2067 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2068 unsigned DestBitSize = DestTy->getScalarSizeInBits();
2070 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
2071 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
2072 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2073 "sext source and destination must both be a vector or neither", &I);
2074 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
2076 visitInstruction(I);
2079 void Verifier::visitFPTruncInst(FPTruncInst &I) {
2080 // Get the source and destination types
2081 Type *SrcTy = I.getOperand(0)->getType();
2082 Type *DestTy = I.getType();
2083 // Get the size of the types in bits, we'll need this later
2084 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2085 unsigned DestBitSize = DestTy->getScalarSizeInBits();
2087 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2088 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2089 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2090 "fptrunc source and destination must both be a vector or neither", &I);
2091 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
2093 visitInstruction(I);
2096 void Verifier::visitFPExtInst(FPExtInst &I) {
2097 // Get the source and destination types
2098 Type *SrcTy = I.getOperand(0)->getType();
2099 Type *DestTy = I.getType();
2101 // Get the size of the types in bits, we'll need this later
2102 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2103 unsigned DestBitSize = DestTy->getScalarSizeInBits();
2105 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2106 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2107 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2108 "fpext source and destination must both be a vector or neither", &I);
2109 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
2111 visitInstruction(I);
2114 void Verifier::visitUIToFPInst(UIToFPInst &I) {
2115 // Get the source and destination types
2116 Type *SrcTy = I.getOperand(0)->getType();
2117 Type *DestTy = I.getType();
2119 bool SrcVec = SrcTy->isVectorTy();
2120 bool DstVec = DestTy->isVectorTy();
2122 Assert(SrcVec == DstVec,
2123 "UIToFP source and dest must both be vector or scalar", &I);
2124 Assert(SrcTy->isIntOrIntVectorTy(),
2125 "UIToFP source must be integer or integer vector", &I);
2126 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2129 if (SrcVec && DstVec)
2130 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2131 cast<VectorType>(DestTy)->getNumElements(),
2132 "UIToFP source and dest vector length mismatch", &I);
2134 visitInstruction(I);
2137 void Verifier::visitSIToFPInst(SIToFPInst &I) {
2138 // Get the source and destination types
2139 Type *SrcTy = I.getOperand(0)->getType();
2140 Type *DestTy = I.getType();
2142 bool SrcVec = SrcTy->isVectorTy();
2143 bool DstVec = DestTy->isVectorTy();
2145 Assert(SrcVec == DstVec,
2146 "SIToFP source and dest must both be vector or scalar", &I);
2147 Assert(SrcTy->isIntOrIntVectorTy(),
2148 "SIToFP source must be integer or integer vector", &I);
2149 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2152 if (SrcVec && DstVec)
2153 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2154 cast<VectorType>(DestTy)->getNumElements(),
2155 "SIToFP source and dest vector length mismatch", &I);
2157 visitInstruction(I);
2160 void Verifier::visitFPToUIInst(FPToUIInst &I) {
2161 // Get the source and destination types
2162 Type *SrcTy = I.getOperand(0)->getType();
2163 Type *DestTy = I.getType();
2165 bool SrcVec = SrcTy->isVectorTy();
2166 bool DstVec = DestTy->isVectorTy();
2168 Assert(SrcVec == DstVec,
2169 "FPToUI source and dest must both be vector or scalar", &I);
2170 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2172 Assert(DestTy->isIntOrIntVectorTy(),
2173 "FPToUI result must be integer or integer vector", &I);
2175 if (SrcVec && DstVec)
2176 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2177 cast<VectorType>(DestTy)->getNumElements(),
2178 "FPToUI source and dest vector length mismatch", &I);
2180 visitInstruction(I);
2183 void Verifier::visitFPToSIInst(FPToSIInst &I) {
2184 // Get the source and destination types
2185 Type *SrcTy = I.getOperand(0)->getType();
2186 Type *DestTy = I.getType();
2188 bool SrcVec = SrcTy->isVectorTy();
2189 bool DstVec = DestTy->isVectorTy();
2191 Assert(SrcVec == DstVec,
2192 "FPToSI source and dest must both be vector or scalar", &I);
2193 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2195 Assert(DestTy->isIntOrIntVectorTy(),
2196 "FPToSI result must be integer or integer vector", &I);
2198 if (SrcVec && DstVec)
2199 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2200 cast<VectorType>(DestTy)->getNumElements(),
2201 "FPToSI source and dest vector length mismatch", &I);
2203 visitInstruction(I);
2206 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2207 // Get the source and destination types
2208 Type *SrcTy = I.getOperand(0)->getType();
2209 Type *DestTy = I.getType();
2211 Assert(SrcTy->getScalarType()->isPointerTy(),
2212 "PtrToInt source must be pointer", &I);
2213 Assert(DestTy->getScalarType()->isIntegerTy(),
2214 "PtrToInt result must be integral", &I);
2215 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2218 if (SrcTy->isVectorTy()) {
2219 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2220 VectorType *VDest = dyn_cast<VectorType>(DestTy);
2221 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2222 "PtrToInt Vector width mismatch", &I);
2225 visitInstruction(I);
2228 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2229 // Get the source and destination types
2230 Type *SrcTy = I.getOperand(0)->getType();
2231 Type *DestTy = I.getType();
2233 Assert(SrcTy->getScalarType()->isIntegerTy(),
2234 "IntToPtr source must be an integral", &I);
2235 Assert(DestTy->getScalarType()->isPointerTy(),
2236 "IntToPtr result must be a pointer", &I);
2237 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2239 if (SrcTy->isVectorTy()) {
2240 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2241 VectorType *VDest = dyn_cast<VectorType>(DestTy);
2242 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2243 "IntToPtr Vector width mismatch", &I);
2245 visitInstruction(I);
2248 void Verifier::visitBitCastInst(BitCastInst &I) {
2250 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2251 "Invalid bitcast", &I);
2252 visitInstruction(I);
2255 void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2256 Type *SrcTy = I.getOperand(0)->getType();
2257 Type *DestTy = I.getType();
2259 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2261 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2263 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2264 "AddrSpaceCast must be between different address spaces", &I);
2265 if (SrcTy->isVectorTy())
2266 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2267 "AddrSpaceCast vector pointer number of elements mismatch", &I);
2268 visitInstruction(I);
2271 /// visitPHINode - Ensure that a PHI node is well formed.
2273 void Verifier::visitPHINode(PHINode &PN) {
2274 // Ensure that the PHI nodes are all grouped together at the top of the block.
2275 // This can be tested by checking whether the instruction before this is
2276 // either nonexistent (because this is begin()) or is a PHI node. If not,
2277 // then there is some other instruction before a PHI.
2278 Assert(&PN == &PN.getParent()->front() ||
2279 isa<PHINode>(--BasicBlock::iterator(&PN)),
2280 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
2282 // Check that a PHI doesn't yield a Token.
2283 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2285 // Check that all of the values of the PHI node have the same type as the
2286 // result, and that the incoming blocks are really basic blocks.
2287 for (Value *IncValue : PN.incoming_values()) {
2288 Assert(PN.getType() == IncValue->getType(),
2289 "PHI node operands are not the same type as the result!", &PN);
2292 // All other PHI node constraints are checked in the visitBasicBlock method.
2294 visitInstruction(PN);
2297 void Verifier::VerifyCallSite(CallSite CS) {
2298 Instruction *I = CS.getInstruction();
2300 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2301 "Called function must be a pointer!", I);
2302 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
2304 Assert(FPTy->getElementType()->isFunctionTy(),
2305 "Called function is not pointer to function type!", I);
2307 Assert(FPTy->getElementType() == CS.getFunctionType(),
2308 "Called function is not the same type as the call!", I);
2310 FunctionType *FTy = CS.getFunctionType();
2312 // Verify that the correct number of arguments are being passed
2313 if (FTy->isVarArg())
2314 Assert(CS.arg_size() >= FTy->getNumParams(),
2315 "Called function requires more parameters than were provided!", I);
2317 Assert(CS.arg_size() == FTy->getNumParams(),
2318 "Incorrect number of arguments passed to called function!", I);
2320 // Verify that all arguments to the call match the function type.
2321 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2322 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2323 "Call parameter type does not match function signature!",
2324 CS.getArgument(i), FTy->getParamType(i), I);
2326 AttributeSet Attrs = CS.getAttributes();
2328 Assert(VerifyAttributeCount(Attrs, CS.arg_size()),
2329 "Attribute after last parameter!", I);
2331 // Verify call attributes.
2332 VerifyFunctionAttrs(FTy, Attrs, I);
2334 // Conservatively check the inalloca argument.
2335 // We have a bug if we can find that there is an underlying alloca without
2337 if (CS.hasInAllocaArgument()) {
2338 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2339 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
2340 Assert(AI->isUsedWithInAlloca(),
2341 "inalloca argument for call has mismatched alloca", AI, I);
2344 if (FTy->isVarArg()) {
2345 // FIXME? is 'nest' even legal here?
2346 bool SawNest = false;
2347 bool SawReturned = false;
2349 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2350 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2352 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2356 // Check attributes on the varargs part.
2357 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
2358 Type *Ty = CS.getArgument(Idx-1)->getType();
2359 VerifyParameterAttrs(Attrs, Idx, Ty, false, I);
2361 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
2362 Assert(!SawNest, "More than one parameter has attribute nest!", I);
2366 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
2367 Assert(!SawReturned, "More than one parameter has attribute returned!",
2369 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2370 "Incompatible argument and return types for 'returned' "
2376 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2377 "Attribute 'sret' cannot be used for vararg call arguments!", I);
2379 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
2380 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
2384 // Verify that there's no metadata unless it's a direct call to an intrinsic.
2385 if (CS.getCalledFunction() == nullptr ||
2386 !CS.getCalledFunction()->getName().startswith("llvm.")) {
2387 for (Type *ParamTy : FTy->params()) {
2388 Assert(!ParamTy->isMetadataTy(),
2389 "Function has metadata parameter but isn't an intrinsic", I);
2390 Assert(!ParamTy->isTokenTy(),
2391 "Function has token parameter but isn't an intrinsic", I);
2395 // Verify that indirect calls don't return tokens.
2396 if (CS.getCalledFunction() == nullptr)
2397 Assert(!FTy->getReturnType()->isTokenTy(),
2398 "Return type cannot be token for indirect call!");
2400 if (Function *F = CS.getCalledFunction())
2401 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
2402 visitIntrinsicCallSite(ID, CS);
2404 // Verify that a callsite has at most one "deopt" and one "funclet" operand
2406 bool FoundDeoptBundle = false, FoundFuncletBundle = false;
2407 for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) {
2408 OperandBundleUse BU = CS.getOperandBundleAt(i);
2409 uint32_t Tag = BU.getTagID();
2410 if (Tag == LLVMContext::OB_deopt) {
2411 Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I);
2412 FoundDeoptBundle = true;
2414 if (Tag == LLVMContext::OB_funclet) {
2415 Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", I);
2416 FoundFuncletBundle = true;
2417 Assert(BU.Inputs.size() == 1,
2418 "Expected exactly one funclet bundle operand", I);
2419 Assert(isa<FuncletPadInst>(BU.Inputs.front()),
2420 "Funclet bundle operands should correspond to a FuncletPadInst",
2425 visitInstruction(*I);
2428 /// Two types are "congruent" if they are identical, or if they are both pointer
2429 /// types with different pointee types and the same address space.
2430 static bool isTypeCongruent(Type *L, Type *R) {
2433 PointerType *PL = dyn_cast<PointerType>(L);
2434 PointerType *PR = dyn_cast<PointerType>(R);
2437 return PL->getAddressSpace() == PR->getAddressSpace();
2440 static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2441 static const Attribute::AttrKind ABIAttrs[] = {
2442 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
2443 Attribute::InReg, Attribute::Returned};
2445 for (auto AK : ABIAttrs) {
2446 if (Attrs.hasAttribute(I + 1, AK))
2447 Copy.addAttribute(AK);
2449 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2450 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2454 void Verifier::verifyMustTailCall(CallInst &CI) {
2455 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
2457 // - The caller and callee prototypes must match. Pointer types of
2458 // parameters or return types may differ in pointee type, but not
2460 Function *F = CI.getParent()->getParent();
2461 FunctionType *CallerTy = F->getFunctionType();
2462 FunctionType *CalleeTy = CI.getFunctionType();
2463 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2464 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2465 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2466 "cannot guarantee tail call due to mismatched varargs", &CI);
2467 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2468 "cannot guarantee tail call due to mismatched return types", &CI);
2469 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2471 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2472 "cannot guarantee tail call due to mismatched parameter types", &CI);
2475 // - The calling conventions of the caller and callee must match.
2476 Assert(F->getCallingConv() == CI.getCallingConv(),
2477 "cannot guarantee tail call due to mismatched calling conv", &CI);
2479 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2480 // returned, and inalloca, must match.
2481 AttributeSet CallerAttrs = F->getAttributes();
2482 AttributeSet CalleeAttrs = CI.getAttributes();
2483 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2484 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2485 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
2486 Assert(CallerABIAttrs == CalleeABIAttrs,
2487 "cannot guarantee tail call due to mismatched ABI impacting "
2488 "function attributes",
2489 &CI, CI.getOperand(I));
2492 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2493 // or a pointer bitcast followed by a ret instruction.
2494 // - The ret instruction must return the (possibly bitcasted) value
2495 // produced by the call or void.
2496 Value *RetVal = &CI;
2497 Instruction *Next = CI.getNextNode();
2499 // Handle the optional bitcast.
2500 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
2501 Assert(BI->getOperand(0) == RetVal,
2502 "bitcast following musttail call must use the call", BI);
2504 Next = BI->getNextNode();
2507 // Check the return.
2508 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
2509 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2511 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2512 "musttail call result must be returned", Ret);
2515 void Verifier::visitCallInst(CallInst &CI) {
2516 VerifyCallSite(&CI);
2518 if (CI.isMustTailCall())
2519 verifyMustTailCall(CI);
2522 void Verifier::visitInvokeInst(InvokeInst &II) {
2523 VerifyCallSite(&II);
2525 // Verify that the first non-PHI instruction of the unwind destination is an
2526 // exception handling instruction.
2528 II.getUnwindDest()->isEHPad(),
2529 "The unwind destination does not have an exception handling instruction!",
2532 visitTerminatorInst(II);
2535 /// visitBinaryOperator - Check that both arguments to the binary operator are
2536 /// of the same type!
2538 void Verifier::visitBinaryOperator(BinaryOperator &B) {
2539 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2540 "Both operands to a binary operator are not of the same type!", &B);
2542 switch (B.getOpcode()) {
2543 // Check that integer arithmetic operators are only used with
2544 // integral operands.
2545 case Instruction::Add:
2546 case Instruction::Sub:
2547 case Instruction::Mul:
2548 case Instruction::SDiv:
2549 case Instruction::UDiv:
2550 case Instruction::SRem:
2551 case Instruction::URem:
2552 Assert(B.getType()->isIntOrIntVectorTy(),
2553 "Integer arithmetic operators only work with integral types!", &B);
2554 Assert(B.getType() == B.getOperand(0)->getType(),
2555 "Integer arithmetic operators must have same type "
2556 "for operands and result!",
2559 // Check that floating-point arithmetic operators are only used with
2560 // floating-point operands.
2561 case Instruction::FAdd:
2562 case Instruction::FSub:
2563 case Instruction::FMul:
2564 case Instruction::FDiv:
2565 case Instruction::FRem:
2566 Assert(B.getType()->isFPOrFPVectorTy(),
2567 "Floating-point arithmetic operators only work with "
2568 "floating-point types!",
2570 Assert(B.getType() == B.getOperand(0)->getType(),
2571 "Floating-point arithmetic operators must have same type "
2572 "for operands and result!",
2575 // Check that logical operators are only used with integral operands.
2576 case Instruction::And:
2577 case Instruction::Or:
2578 case Instruction::Xor:
2579 Assert(B.getType()->isIntOrIntVectorTy(),
2580 "Logical operators only work with integral types!", &B);
2581 Assert(B.getType() == B.getOperand(0)->getType(),
2582 "Logical operators must have same type for operands and result!",
2585 case Instruction::Shl:
2586 case Instruction::LShr:
2587 case Instruction::AShr:
2588 Assert(B.getType()->isIntOrIntVectorTy(),
2589 "Shifts only work with integral types!", &B);
2590 Assert(B.getType() == B.getOperand(0)->getType(),
2591 "Shift return type must be same as operands!", &B);
2594 llvm_unreachable("Unknown BinaryOperator opcode!");
2597 visitInstruction(B);
2600 void Verifier::visitICmpInst(ICmpInst &IC) {
2601 // Check that the operands are the same type
2602 Type *Op0Ty = IC.getOperand(0)->getType();
2603 Type *Op1Ty = IC.getOperand(1)->getType();
2604 Assert(Op0Ty == Op1Ty,
2605 "Both operands to ICmp instruction are not of the same type!", &IC);
2606 // Check that the operands are the right type
2607 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2608 "Invalid operand types for ICmp instruction", &IC);
2609 // Check that the predicate is valid.
2610 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2611 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2612 "Invalid predicate in ICmp instruction!", &IC);
2614 visitInstruction(IC);
2617 void Verifier::visitFCmpInst(FCmpInst &FC) {
2618 // Check that the operands are the same type
2619 Type *Op0Ty = FC.getOperand(0)->getType();
2620 Type *Op1Ty = FC.getOperand(1)->getType();
2621 Assert(Op0Ty == Op1Ty,
2622 "Both operands to FCmp instruction are not of the same type!", &FC);
2623 // Check that the operands are the right type
2624 Assert(Op0Ty->isFPOrFPVectorTy(),
2625 "Invalid operand types for FCmp instruction", &FC);
2626 // Check that the predicate is valid.
2627 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2628 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2629 "Invalid predicate in FCmp instruction!", &FC);
2631 visitInstruction(FC);
2634 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
2636 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2637 "Invalid extractelement operands!", &EI);
2638 visitInstruction(EI);
2641 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
2642 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2644 "Invalid insertelement operands!", &IE);
2645 visitInstruction(IE);
2648 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
2649 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2651 "Invalid shufflevector operands!", &SV);
2652 visitInstruction(SV);
2655 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
2656 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
2658 Assert(isa<PointerType>(TargetTy),
2659 "GEP base pointer is not a vector or a vector of pointers", &GEP);
2660 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
2661 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
2663 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
2664 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
2666 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
2667 GEP.getResultElementType() == ElTy,
2668 "GEP is not of right type for indices!", &GEP, ElTy);
2670 if (GEP.getType()->isVectorTy()) {
2671 // Additional checks for vector GEPs.
2672 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2673 if (GEP.getPointerOperandType()->isVectorTy())
2674 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2675 "Vector GEP result width doesn't match operand's", &GEP);
2676 for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
2677 Type *IndexTy = Idxs[i]->getType();
2678 if (IndexTy->isVectorTy()) {
2679 unsigned IndexWidth = IndexTy->getVectorNumElements();
2680 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2682 Assert(IndexTy->getScalarType()->isIntegerTy(),
2683 "All GEP indices should be of integer type");
2686 visitInstruction(GEP);
2689 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2690 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2693 void Verifier::visitRangeMetadata(Instruction& I,
2694 MDNode* Range, Type* Ty) {
2696 Range == I.getMetadata(LLVMContext::MD_range) &&
2697 "precondition violation");
2699 unsigned NumOperands = Range->getNumOperands();
2700 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
2701 unsigned NumRanges = NumOperands / 2;
2702 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2704 ConstantRange LastRange(1); // Dummy initial value
2705 for (unsigned i = 0; i < NumRanges; ++i) {
2707 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
2708 Assert(Low, "The lower limit must be an integer!", Low);
2710 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
2711 Assert(High, "The upper limit must be an integer!", High);
2712 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2713 "Range types must match instruction type!", &I);
2715 APInt HighV = High->getValue();
2716 APInt LowV = Low->getValue();
2717 ConstantRange CurRange(LowV, HighV);
2718 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2719 "Range must not be empty!", Range);
2721 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2722 "Intervals are overlapping", Range);
2723 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2725 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2728 LastRange = ConstantRange(LowV, HighV);
2730 if (NumRanges > 2) {
2732 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
2734 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
2735 ConstantRange FirstRange(FirstLow, FirstHigh);
2736 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2737 "Intervals are overlapping", Range);
2738 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2743 void Verifier::checkAtomicMemAccessSize(const Module *M, Type *Ty,
2744 const Instruction *I) {
2745 unsigned Size = M->getDataLayout().getTypeSizeInBits(Ty);
2746 Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
2747 Assert(!(Size & (Size - 1)),
2748 "atomic memory access' operand must have a power-of-two size", Ty, I);
2751 void Verifier::visitLoadInst(LoadInst &LI) {
2752 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
2753 Assert(PTy, "Load operand must be a pointer.", &LI);
2754 Type *ElTy = LI.getType();
2755 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2756 "huge alignment values are unsupported", &LI);
2757 if (LI.isAtomic()) {
2758 Assert(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
2759 "Load cannot have Release ordering", &LI);
2760 Assert(LI.getAlignment() != 0,
2761 "Atomic load must specify explicit alignment", &LI);
2762 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
2763 ElTy->isFloatingPointTy(),
2764 "atomic load operand must have integer, pointer, or floating point "
2767 checkAtomicMemAccessSize(M, ElTy, &LI);
2769 Assert(LI.getSynchScope() == CrossThread,
2770 "Non-atomic load cannot have SynchronizationScope specified", &LI);
2773 visitInstruction(LI);
2776 void Verifier::visitStoreInst(StoreInst &SI) {
2777 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
2778 Assert(PTy, "Store operand must be a pointer.", &SI);
2779 Type *ElTy = PTy->getElementType();
2780 Assert(ElTy == SI.getOperand(0)->getType(),
2781 "Stored value type does not match pointer operand type!", &SI, ElTy);
2782 Assert(SI.getAlignment() <= Value::MaximumAlignment,
2783 "huge alignment values are unsupported", &SI);
2784 if (SI.isAtomic()) {
2785 Assert(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
2786 "Store cannot have Acquire ordering", &SI);
2787 Assert(SI.getAlignment() != 0,
2788 "Atomic store must specify explicit alignment", &SI);
2789 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
2790 ElTy->isFloatingPointTy(),
2791 "atomic store operand must have integer, pointer, or floating point "
2794 checkAtomicMemAccessSize(M, ElTy, &SI);
2796 Assert(SI.getSynchScope() == CrossThread,
2797 "Non-atomic store cannot have SynchronizationScope specified", &SI);
2799 visitInstruction(SI);
2802 void Verifier::visitAllocaInst(AllocaInst &AI) {
2803 SmallPtrSet<Type*, 4> Visited;
2804 PointerType *PTy = AI.getType();
2805 Assert(PTy->getAddressSpace() == 0,
2806 "Allocation instruction pointer not in the generic address space!",
2808 Assert(AI.getAllocatedType()->isSized(&Visited),
2809 "Cannot allocate unsized type", &AI);
2810 Assert(AI.getArraySize()->getType()->isIntegerTy(),
2811 "Alloca array size must have integer type", &AI);
2812 Assert(AI.getAlignment() <= Value::MaximumAlignment,
2813 "huge alignment values are unsupported", &AI);
2815 visitInstruction(AI);
2818 void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
2820 // FIXME: more conditions???
2821 Assert(CXI.getSuccessOrdering() != NotAtomic,
2822 "cmpxchg instructions must be atomic.", &CXI);
2823 Assert(CXI.getFailureOrdering() != NotAtomic,
2824 "cmpxchg instructions must be atomic.", &CXI);
2825 Assert(CXI.getSuccessOrdering() != Unordered,
2826 "cmpxchg instructions cannot be unordered.", &CXI);
2827 Assert(CXI.getFailureOrdering() != Unordered,
2828 "cmpxchg instructions cannot be unordered.", &CXI);
2829 Assert(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
2830 "cmpxchg instructions be at least as constrained on success as fail",
2832 Assert(CXI.getFailureOrdering() != Release &&
2833 CXI.getFailureOrdering() != AcquireRelease,
2834 "cmpxchg failure ordering cannot include release semantics", &CXI);
2836 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
2837 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
2838 Type *ElTy = PTy->getElementType();
2839 Assert(ElTy->isIntegerTy(), "cmpxchg operand must have integer type!", &CXI,
2841 checkAtomicMemAccessSize(M, ElTy, &CXI);
2842 Assert(ElTy == CXI.getOperand(1)->getType(),
2843 "Expected value type does not match pointer operand type!", &CXI,
2845 Assert(ElTy == CXI.getOperand(2)->getType(),
2846 "Stored value type does not match pointer operand type!", &CXI, ElTy);
2847 visitInstruction(CXI);
2850 void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
2851 Assert(RMWI.getOrdering() != NotAtomic,
2852 "atomicrmw instructions must be atomic.", &RMWI);
2853 Assert(RMWI.getOrdering() != Unordered,
2854 "atomicrmw instructions cannot be unordered.", &RMWI);
2855 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
2856 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
2857 Type *ElTy = PTy->getElementType();
2858 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
2860 checkAtomicMemAccessSize(M, ElTy, &RMWI);
2861 Assert(ElTy == RMWI.getOperand(1)->getType(),
2862 "Argument value type does not match pointer operand type!", &RMWI,
2864 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
2865 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
2866 "Invalid binary operation!", &RMWI);
2867 visitInstruction(RMWI);
2870 void Verifier::visitFenceInst(FenceInst &FI) {
2871 const AtomicOrdering Ordering = FI.getOrdering();
2872 Assert(Ordering == Acquire || Ordering == Release ||
2873 Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
2874 "fence instructions may only have "
2875 "acquire, release, acq_rel, or seq_cst ordering.",
2877 visitInstruction(FI);
2880 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
2881 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
2882 EVI.getIndices()) == EVI.getType(),
2883 "Invalid ExtractValueInst operands!", &EVI);
2885 visitInstruction(EVI);
2888 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
2889 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
2890 IVI.getIndices()) ==
2891 IVI.getOperand(1)->getType(),
2892 "Invalid InsertValueInst operands!", &IVI);
2894 visitInstruction(IVI);
2897 void Verifier::visitEHPadPredecessors(Instruction &I) {
2898 assert(I.isEHPad());
2900 BasicBlock *BB = I.getParent();
2901 Function *F = BB->getParent();
2903 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
2905 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
2906 // The landingpad instruction defines its parent as a landing pad block. The
2907 // landing pad block may be branched to only by the unwind edge of an
2909 for (BasicBlock *PredBB : predecessors(BB)) {
2910 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
2911 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
2912 "Block containing LandingPadInst must be jumped to "
2913 "only by the unwind edge of an invoke.",
2918 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
2919 if (!pred_empty(BB))
2920 Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
2921 "Block containg CatchPadInst must be jumped to "
2922 "only by its catchswitch.",
2927 for (BasicBlock *PredBB : predecessors(BB)) {
2928 TerminatorInst *TI = PredBB->getTerminator();
2929 if (auto *II = dyn_cast<InvokeInst>(TI)) {
2930 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
2931 "EH pad must be jumped to via an unwind edge", &I, II);
2932 } else if (!isa<CleanupReturnInst>(TI) && !isa<CatchSwitchInst>(TI)) {
2933 Assert(false, "EH pad must be jumped to via an unwind edge", &I, TI);
2938 void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
2939 // The landingpad instruction is ill-formed if it doesn't have any clauses and
2941 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
2942 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
2944 visitEHPadPredecessors(LPI);
2946 if (!LandingPadResultTy)
2947 LandingPadResultTy = LPI.getType();
2949 Assert(LandingPadResultTy == LPI.getType(),
2950 "The landingpad instruction should have a consistent result type "
2951 "inside a function.",
2954 Function *F = LPI.getParent()->getParent();
2955 Assert(F->hasPersonalityFn(),
2956 "LandingPadInst needs to be in a function with a personality.", &LPI);
2958 // The landingpad instruction must be the first non-PHI instruction in the
2960 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
2961 "LandingPadInst not the first non-PHI instruction in the block.",
2964 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
2965 Constant *Clause = LPI.getClause(i);
2966 if (LPI.isCatch(i)) {
2967 Assert(isa<PointerType>(Clause->getType()),
2968 "Catch operand does not have pointer type!", &LPI);
2970 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
2971 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
2972 "Filter operand is not an array of constants!", &LPI);
2976 visitInstruction(LPI);
2979 void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
2980 visitEHPadPredecessors(CPI);
2982 BasicBlock *BB = CPI.getParent();
2984 Function *F = BB->getParent();
2985 Assert(F->hasPersonalityFn(),
2986 "CatchPadInst needs to be in a function with a personality.", &CPI);
2988 Assert(isa<CatchSwitchInst>(CPI.getParentPad()),
2989 "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
2990 CPI.getParentPad());
2992 // The catchpad instruction must be the first non-PHI instruction in the
2994 Assert(BB->getFirstNonPHI() == &CPI,
2995 "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
2997 visitInstruction(CPI);
3000 void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
3001 Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)),
3002 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
3003 CatchReturn.getOperand(0));
3005 visitTerminatorInst(CatchReturn);
3008 void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
3009 visitEHPadPredecessors(CPI);
3011 BasicBlock *BB = CPI.getParent();
3013 Function *F = BB->getParent();
3014 Assert(F->hasPersonalityFn(),
3015 "CleanupPadInst needs to be in a function with a personality.", &CPI);
3017 // The cleanuppad instruction must be the first non-PHI instruction in the
3019 Assert(BB->getFirstNonPHI() == &CPI,
3020 "CleanupPadInst not the first non-PHI instruction in the block.",
3023 auto *ParentPad = CPI.getParentPad();
3024 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3025 "CleanupPadInst has an invalid parent.", &CPI);
3027 User *FirstUser = nullptr;
3028 BasicBlock *FirstUnwindDest = nullptr;
3029 for (User *U : CPI.users()) {
3030 BasicBlock *UnwindDest;
3031 if (CleanupReturnInst *CRI = dyn_cast<CleanupReturnInst>(U)) {
3032 UnwindDest = CRI->getUnwindDest();
3033 } else if (isa<CleanupPadInst>(U) || isa<CatchSwitchInst>(U)) {
3035 } else if (CallSite(U)) {
3038 Assert(false, "bogus cleanuppad use", &CPI);
3043 FirstUnwindDest = UnwindDest;
3046 UnwindDest == FirstUnwindDest,
3047 "cleanupret instructions from the same cleanuppad must have the same "
3048 "unwind destination",
3053 visitInstruction(CPI);
3056 void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
3057 visitEHPadPredecessors(CatchSwitch);
3059 BasicBlock *BB = CatchSwitch.getParent();
3061 Function *F = BB->getParent();
3062 Assert(F->hasPersonalityFn(),
3063 "CatchSwitchInst needs to be in a function with a personality.",
3066 // The catchswitch instruction must be the first non-PHI instruction in the
3068 Assert(BB->getFirstNonPHI() == &CatchSwitch,
3069 "CatchSwitchInst not the first non-PHI instruction in the block.",
3072 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
3073 Instruction *I = UnwindDest->getFirstNonPHI();
3074 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3075 "CatchSwitchInst must unwind to an EH block which is not a "
3080 auto *ParentPad = CatchSwitch.getParentPad();
3081 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3082 "CatchSwitchInst has an invalid parent.", ParentPad);
3084 Assert(CatchSwitch.getNumHandlers() != 0,
3085 "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
3087 for (BasicBlock *Handler : CatchSwitch.handlers()) {
3088 Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()),
3089 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
3092 visitTerminatorInst(CatchSwitch);
3095 void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
3096 Assert(isa<CleanupPadInst>(CRI.getOperand(0)),
3097 "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
3100 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3101 Instruction *I = UnwindDest->getFirstNonPHI();
3102 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3103 "CleanupReturnInst must unwind to an EH block which is not a "
3108 visitTerminatorInst(CRI);
3111 void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3112 Instruction *Op = cast<Instruction>(I.getOperand(i));
3113 // If the we have an invalid invoke, don't try to compute the dominance.
3114 // We already reject it in the invoke specific checks and the dominance
3115 // computation doesn't handle multiple edges.
3116 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3117 if (II->getNormalDest() == II->getUnwindDest())
3121 const Use &U = I.getOperandUse(i);
3122 Assert(InstsInThisBlock.count(Op) || DT.dominates(Op, U),
3123 "Instruction does not dominate all uses!", Op, &I);
3126 void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
3127 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
3128 "apply only to pointer types", &I);
3129 Assert(isa<LoadInst>(I),
3130 "dereferenceable, dereferenceable_or_null apply only to load"
3131 " instructions, use attributes for calls or invokes", &I);
3132 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
3133 "take one operand!", &I);
3134 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
3135 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
3136 "dereferenceable_or_null metadata value must be an i64!", &I);
3139 /// verifyInstruction - Verify that an instruction is well formed.
3141 void Verifier::visitInstruction(Instruction &I) {
3142 BasicBlock *BB = I.getParent();
3143 Assert(BB, "Instruction not embedded in basic block!", &I);
3145 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
3146 for (User *U : I.users()) {
3147 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3148 "Only PHI nodes may reference their own value!", &I);
3152 // Check that void typed values don't have names
3153 Assert(!I.getType()->isVoidTy() || !I.hasName(),
3154 "Instruction has a name, but provides a void value!", &I);
3156 // Check that the return value of the instruction is either void or a legal
3158 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3159 "Instruction returns a non-scalar type!", &I);
3161 // Check that the instruction doesn't produce metadata. Calls are already
3162 // checked against the callee type.
3163 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3164 "Invalid use of metadata!", &I);
3166 // Check that all uses of the instruction, if they are instructions
3167 // themselves, actually have parent basic blocks. If the use is not an
3168 // instruction, it is an error!
3169 for (Use &U : I.uses()) {
3170 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
3171 Assert(Used->getParent() != nullptr,
3172 "Instruction referencing"
3173 " instruction not embedded in a basic block!",
3176 CheckFailed("Use of instruction is not an instruction!", U);
3181 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
3182 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
3184 // Check to make sure that only first-class-values are operands to
3186 if (!I.getOperand(i)->getType()->isFirstClassType()) {
3187 Assert(0, "Instruction operands must be first-class values!", &I);
3190 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
3191 // Check to make sure that the "address of" an intrinsic function is never
3194 !F->isIntrinsic() ||
3195 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3196 "Cannot take the address of an intrinsic!", &I);
3198 !F->isIntrinsic() || isa<CallInst>(I) ||
3199 F->getIntrinsicID() == Intrinsic::donothing ||
3200 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
3201 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3202 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
3203 "Cannot invoke an intrinsinc other than"
3204 " donothing or patchpoint",
3206 Assert(F->getParent() == M, "Referencing function in another module!",
3207 &I, M, F, F->getParent());
3208 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
3209 Assert(OpBB->getParent() == BB->getParent(),
3210 "Referring to a basic block in another function!", &I);
3211 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
3212 Assert(OpArg->getParent() == BB->getParent(),
3213 "Referring to an argument in another function!", &I);
3214 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
3215 Assert(GV->getParent() == M, "Referencing global in another module!", &I, M, GV, GV->getParent());
3216 } else if (isa<Instruction>(I.getOperand(i))) {
3217 verifyDominatesUse(I, i);
3218 } else if (isa<InlineAsm>(I.getOperand(i))) {
3219 Assert((i + 1 == e && isa<CallInst>(I)) ||
3220 (i + 3 == e && isa<InvokeInst>(I)),
3221 "Cannot take the address of an inline asm!", &I);
3222 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
3223 if (CE->getType()->isPtrOrPtrVectorTy()) {
3224 // If we have a ConstantExpr pointer, we need to see if it came from an
3225 // illegal bitcast (inttoptr <constant int> )
3226 visitConstantExprsRecursively(CE);
3231 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
3232 Assert(I.getType()->isFPOrFPVectorTy(),
3233 "fpmath requires a floating point result!", &I);
3234 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
3235 if (ConstantFP *CFP0 =
3236 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
3237 APFloat Accuracy = CFP0->getValueAPF();
3238 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3239 "fpmath accuracy not a positive number!", &I);
3241 Assert(false, "invalid fpmath accuracy!", &I);
3245 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
3246 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3247 "Ranges are only for loads, calls and invokes!", &I);
3248 visitRangeMetadata(I, Range, I.getType());
3251 if (I.getMetadata(LLVMContext::MD_nonnull)) {
3252 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3254 Assert(isa<LoadInst>(I),
3255 "nonnull applies only to load instructions, use attributes"
3256 " for calls or invokes",
3260 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
3261 visitDereferenceableMetadata(I, MD);
3263 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
3264 visitDereferenceableMetadata(I, MD);
3266 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
3267 Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
3269 Assert(isa<LoadInst>(I), "align applies only to load instructions, "
3270 "use attributes for calls or invokes", &I);
3271 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
3272 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
3273 Assert(CI && CI->getType()->isIntegerTy(64),
3274 "align metadata value must be an i64!", &I);
3275 uint64_t Align = CI->getZExtValue();
3276 Assert(isPowerOf2_64(Align),
3277 "align metadata value must be a power of 2!", &I);
3278 Assert(Align <= Value::MaximumAlignment,
3279 "alignment is larger that implementation defined limit", &I);
3282 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
3283 Assert(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
3287 InstsInThisBlock.insert(&I);
3290 /// VerifyIntrinsicType - Verify that the specified type (which comes from an
3291 /// intrinsic argument or return value) matches the type constraints specified
3292 /// by the .td file (e.g. an "any integer" argument really is an integer).
3294 /// This return true on error but does not print a message.
3295 bool Verifier::VerifyIntrinsicType(Type *Ty,
3296 ArrayRef<Intrinsic::IITDescriptor> &Infos,
3297 SmallVectorImpl<Type*> &ArgTys) {
3298 using namespace Intrinsic;
3300 // If we ran out of descriptors, there are too many arguments.
3301 if (Infos.empty()) return true;
3302 IITDescriptor D = Infos.front();
3303 Infos = Infos.slice(1);
3306 case IITDescriptor::Void: return !Ty->isVoidTy();
3307 case IITDescriptor::VarArg: return true;
3308 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
3309 case IITDescriptor::Token: return !Ty->isTokenTy();
3310 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
3311 case IITDescriptor::Half: return !Ty->isHalfTy();
3312 case IITDescriptor::Float: return !Ty->isFloatTy();
3313 case IITDescriptor::Double: return !Ty->isDoubleTy();
3314 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
3315 case IITDescriptor::Vector: {
3316 VectorType *VT = dyn_cast<VectorType>(Ty);
3317 return !VT || VT->getNumElements() != D.Vector_Width ||
3318 VerifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
3320 case IITDescriptor::Pointer: {
3321 PointerType *PT = dyn_cast<PointerType>(Ty);
3322 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
3323 VerifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
3326 case IITDescriptor::Struct: {
3327 StructType *ST = dyn_cast<StructType>(Ty);
3328 if (!ST || ST->getNumElements() != D.Struct_NumElements)
3331 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
3332 if (VerifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
3337 case IITDescriptor::Argument:
3338 // Two cases here - If this is the second occurrence of an argument, verify
3339 // that the later instance matches the previous instance.
3340 if (D.getArgumentNumber() < ArgTys.size())
3341 return Ty != ArgTys[D.getArgumentNumber()];
3343 // Otherwise, if this is the first instance of an argument, record it and
3344 // verify the "Any" kind.
3345 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
3346 ArgTys.push_back(Ty);
3348 switch (D.getArgumentKind()) {
3349 case IITDescriptor::AK_Any: return false; // Success
3350 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
3351 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
3352 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
3353 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
3355 llvm_unreachable("all argument kinds not covered");
3357 case IITDescriptor::ExtendArgument: {
3358 // This may only be used when referring to a previous vector argument.
3359 if (D.getArgumentNumber() >= ArgTys.size())
3362 Type *NewTy = ArgTys[D.getArgumentNumber()];
3363 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3364 NewTy = VectorType::getExtendedElementVectorType(VTy);
3365 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3366 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
3372 case IITDescriptor::TruncArgument: {
3373 // This may only be used when referring to a previous vector argument.
3374 if (D.getArgumentNumber() >= ArgTys.size())
3377 Type *NewTy = ArgTys[D.getArgumentNumber()];
3378 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3379 NewTy = VectorType::getTruncatedElementVectorType(VTy);
3380 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3381 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
3387 case IITDescriptor::HalfVecArgument:
3388 // This may only be used when referring to a previous vector argument.
3389 return D.getArgumentNumber() >= ArgTys.size() ||
3390 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
3391 VectorType::getHalfElementsVectorType(
3392 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
3393 case IITDescriptor::SameVecWidthArgument: {
3394 if (D.getArgumentNumber() >= ArgTys.size())
3396 VectorType * ReferenceType =
3397 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
3398 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
3399 if (!ThisArgType || !ReferenceType ||
3400 (ReferenceType->getVectorNumElements() !=
3401 ThisArgType->getVectorNumElements()))
3403 return VerifyIntrinsicType(ThisArgType->getVectorElementType(),
3406 case IITDescriptor::PtrToArgument: {
3407 if (D.getArgumentNumber() >= ArgTys.size())
3409 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
3410 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
3411 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
3413 case IITDescriptor::VecOfPtrsToElt: {
3414 if (D.getArgumentNumber() >= ArgTys.size())
3416 VectorType * ReferenceType =
3417 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
3418 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
3419 if (!ThisArgVecTy || !ReferenceType ||
3420 (ReferenceType->getVectorNumElements() !=
3421 ThisArgVecTy->getVectorNumElements()))
3423 PointerType *ThisArgEltTy =
3424 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
3427 return ThisArgEltTy->getElementType() !=
3428 ReferenceType->getVectorElementType();
3431 llvm_unreachable("unhandled");
3434 /// \brief Verify if the intrinsic has variable arguments.
3435 /// This method is intended to be called after all the fixed arguments have been
3438 /// This method returns true on error and does not print an error message.
3440 Verifier::VerifyIntrinsicIsVarArg(bool isVarArg,
3441 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
3442 using namespace Intrinsic;
3444 // If there are no descriptors left, then it can't be a vararg.
3448 // There should be only one descriptor remaining at this point.
3449 if (Infos.size() != 1)
3452 // Check and verify the descriptor.
3453 IITDescriptor D = Infos.front();
3454 Infos = Infos.slice(1);
3455 if (D.Kind == IITDescriptor::VarArg)
3461 /// Allow intrinsics to be verified in different ways.
3462 void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
3463 Function *IF = CS.getCalledFunction();
3464 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3467 // Verify that the intrinsic prototype lines up with what the .td files
3469 FunctionType *IFTy = IF->getFunctionType();
3470 bool IsVarArg = IFTy->isVarArg();
3472 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3473 getIntrinsicInfoTableEntries(ID, Table);
3474 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
3476 SmallVector<Type *, 4> ArgTys;
3477 Assert(!VerifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
3478 "Intrinsic has incorrect return type!", IF);
3479 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
3480 Assert(!VerifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
3481 "Intrinsic has incorrect argument type!", IF);
3483 // Verify if the intrinsic call matches the vararg property.
3485 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3486 "Intrinsic was not defined with variable arguments!", IF);
3488 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3489 "Callsite was not defined with variable arguments!", IF);
3491 // All descriptors should be absorbed by now.
3492 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
3494 // Now that we have the intrinsic ID and the actual argument types (and we
3495 // know they are legal for the intrinsic!) get the intrinsic name through the
3496 // usual means. This allows us to verify the mangling of argument types into
3498 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
3499 Assert(ExpectedName == IF->getName(),
3500 "Intrinsic name not mangled correctly for type arguments! "
3505 // If the intrinsic takes MDNode arguments, verify that they are either global
3506 // or are local to *this* function.
3507 for (Value *V : CS.args())
3508 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3509 visitMetadataAsValue(*MD, CS.getCaller());
3514 case Intrinsic::ctlz: // llvm.ctlz
3515 case Intrinsic::cttz: // llvm.cttz
3516 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3517 "is_zero_undef argument of bit counting intrinsics must be a "
3521 case Intrinsic::dbg_declare: // llvm.dbg.declare
3522 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3523 "invalid llvm.dbg.declare intrinsic call 1", CS);
3524 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
3526 case Intrinsic::dbg_value: // llvm.dbg.value
3527 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
3529 case Intrinsic::memcpy:
3530 case Intrinsic::memmove:
3531 case Intrinsic::memset: {
3532 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
3534 "alignment argument of memory intrinsics must be a constant int",
3536 const APInt &AlignVal = AlignCI->getValue();
3537 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
3538 "alignment argument of memory intrinsics must be a power of 2", CS);
3539 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
3540 "isvolatile argument of memory intrinsics must be a constant int",
3544 case Intrinsic::gcroot:
3545 case Intrinsic::gcwrite:
3546 case Intrinsic::gcread:
3547 if (ID == Intrinsic::gcroot) {
3549 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3550 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3551 Assert(isa<Constant>(CS.getArgOperand(1)),
3552 "llvm.gcroot parameter #2 must be a constant.", CS);
3553 if (!AI->getAllocatedType()->isPointerTy()) {
3554 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
3555 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3556 "or argument #2 must be a non-null constant.",
3561 Assert(CS.getParent()->getParent()->hasGC(),
3562 "Enclosing function does not use GC.", CS);
3564 case Intrinsic::init_trampoline:
3565 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
3566 "llvm.init_trampoline parameter #2 must resolve to a function.",
3569 case Intrinsic::prefetch:
3570 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
3571 isa<ConstantInt>(CS.getArgOperand(2)) &&
3572 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
3573 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
3574 "invalid arguments to llvm.prefetch", CS);
3576 case Intrinsic::stackprotector:
3577 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
3578 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
3580 case Intrinsic::lifetime_start:
3581 case Intrinsic::lifetime_end:
3582 case Intrinsic::invariant_start:
3583 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
3584 "size argument of memory use markers must be a constant integer",
3587 case Intrinsic::invariant_end:
3588 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3589 "llvm.invariant.end parameter #2 must be a constant integer", CS);
3592 case Intrinsic::localescape: {
3593 BasicBlock *BB = CS.getParent();
3594 Assert(BB == &BB->getParent()->front(),
3595 "llvm.localescape used outside of entry block", CS);
3596 Assert(!SawFrameEscape,
3597 "multiple calls to llvm.localescape in one function", CS);
3598 for (Value *Arg : CS.args()) {
3599 if (isa<ConstantPointerNull>(Arg))
3600 continue; // Null values are allowed as placeholders.
3601 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
3602 Assert(AI && AI->isStaticAlloca(),
3603 "llvm.localescape only accepts static allocas", CS);
3605 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
3606 SawFrameEscape = true;
3609 case Intrinsic::localrecover: {
3610 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
3611 Function *Fn = dyn_cast<Function>(FnArg);
3612 Assert(Fn && !Fn->isDeclaration(),
3613 "llvm.localrecover first "
3614 "argument must be function defined in this module",
3616 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
3617 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
3619 auto &Entry = FrameEscapeInfo[Fn];
3620 Entry.second = unsigned(
3621 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
3625 case Intrinsic::experimental_gc_statepoint:
3626 Assert(!CS.isInlineAsm(),
3627 "gc.statepoint support for inline assembly unimplemented", CS);
3628 Assert(CS.getParent()->getParent()->hasGC(),
3629 "Enclosing function does not use GC.", CS);
3631 VerifyStatepoint(CS);
3633 case Intrinsic::experimental_gc_result: {
3634 Assert(CS.getParent()->getParent()->hasGC(),
3635 "Enclosing function does not use GC.", CS);
3636 // Are we tied to a statepoint properly?
3637 CallSite StatepointCS(CS.getArgOperand(0));
3638 const Function *StatepointFn =
3639 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
3640 Assert(StatepointFn && StatepointFn->isDeclaration() &&
3641 StatepointFn->getIntrinsicID() ==
3642 Intrinsic::experimental_gc_statepoint,
3643 "gc.result operand #1 must be from a statepoint", CS,
3644 CS.getArgOperand(0));
3646 // Assert that result type matches wrapped callee.
3647 const Value *Target = StatepointCS.getArgument(2);
3648 auto *PT = cast<PointerType>(Target->getType());
3649 auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
3650 Assert(CS.getType() == TargetFuncType->getReturnType(),
3651 "gc.result result type does not match wrapped callee", CS);
3654 case Intrinsic::experimental_gc_relocate: {
3655 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
3657 Assert(isa<PointerType>(CS.getType()->getScalarType()),
3658 "gc.relocate must return a pointer or a vector of pointers", CS);
3660 // Check that this relocate is correctly tied to the statepoint
3662 // This is case for relocate on the unwinding path of an invoke statepoint
3663 if (LandingPadInst *LandingPad =
3664 dyn_cast<LandingPadInst>(CS.getArgOperand(0))) {
3666 const BasicBlock *InvokeBB =
3667 LandingPad->getParent()->getUniquePredecessor();
3669 // Landingpad relocates should have only one predecessor with invoke
3670 // statepoint terminator
3671 Assert(InvokeBB, "safepoints should have unique landingpads",
3672 LandingPad->getParent());
3673 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
3675 Assert(isStatepoint(InvokeBB->getTerminator()),
3676 "gc relocate should be linked to a statepoint", InvokeBB);
3679 // In all other cases relocate should be tied to the statepoint directly.
3680 // This covers relocates on a normal return path of invoke statepoint and
3681 // relocates of a call statepoint
3682 auto Token = CS.getArgOperand(0);
3683 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
3684 "gc relocate is incorrectly tied to the statepoint", CS, Token);
3687 // Verify rest of the relocate arguments
3689 ImmutableCallSite StatepointCS(
3690 cast<GCRelocateInst>(*CS.getInstruction()).getStatepoint());
3692 // Both the base and derived must be piped through the safepoint
3693 Value* Base = CS.getArgOperand(1);
3694 Assert(isa<ConstantInt>(Base),
3695 "gc.relocate operand #2 must be integer offset", CS);
3697 Value* Derived = CS.getArgOperand(2);
3698 Assert(isa<ConstantInt>(Derived),
3699 "gc.relocate operand #3 must be integer offset", CS);
3701 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
3702 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
3704 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
3705 "gc.relocate: statepoint base index out of bounds", CS);
3706 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
3707 "gc.relocate: statepoint derived index out of bounds", CS);
3709 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
3710 // section of the statepoint's argument
3711 Assert(StatepointCS.arg_size() > 0,
3712 "gc.statepoint: insufficient arguments");
3713 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
3714 "gc.statement: number of call arguments must be constant integer");
3715 const unsigned NumCallArgs =
3716 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
3717 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
3718 "gc.statepoint: mismatch in number of call arguments");
3719 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
3720 "gc.statepoint: number of transition arguments must be "
3721 "a constant integer");
3722 const int NumTransitionArgs =
3723 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
3725 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
3726 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
3727 "gc.statepoint: number of deoptimization arguments must be "
3728 "a constant integer");
3729 const int NumDeoptArgs =
3730 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))->getZExtValue();
3731 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
3732 const int GCParamArgsEnd = StatepointCS.arg_size();
3733 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
3734 "gc.relocate: statepoint base index doesn't fall within the "
3735 "'gc parameters' section of the statepoint call",
3737 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
3738 "gc.relocate: statepoint derived index doesn't fall within the "
3739 "'gc parameters' section of the statepoint call",
3742 // Relocated value must be either a pointer type or vector-of-pointer type,
3743 // but gc_relocate does not need to return the same pointer type as the
3744 // relocated pointer. It can be casted to the correct type later if it's
3745 // desired. However, they must have the same address space and 'vectorness'
3746 GCRelocateInst &Relocate = cast<GCRelocateInst>(*CS.getInstruction());
3747 Assert(Relocate.getDerivedPtr()->getType()->getScalarType()->isPointerTy(),
3748 "gc.relocate: relocated value must be a gc pointer", CS);
3750 auto ResultType = CS.getType();
3751 auto DerivedType = Relocate.getDerivedPtr()->getType();
3752 Assert(ResultType->isVectorTy() == DerivedType->isVectorTy(),
3753 "gc.relocate: vector relocates to vector and pointer to pointer", CS);
3754 Assert(ResultType->getPointerAddressSpace() ==
3755 DerivedType->getPointerAddressSpace(),
3756 "gc.relocate: relocating a pointer shouldn't change its address space", CS);
3759 case Intrinsic::eh_exceptioncode:
3760 case Intrinsic::eh_exceptionpointer: {
3761 Assert(isa<CatchPadInst>(CS.getArgOperand(0)),
3762 "eh.exceptionpointer argument must be a catchpad", CS);
3768 /// \brief Carefully grab the subprogram from a local scope.
3770 /// This carefully grabs the subprogram from a local scope, avoiding the
3771 /// built-in assertions that would typically fire.
3772 static DISubprogram *getSubprogram(Metadata *LocalScope) {
3776 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
3779 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
3780 return getSubprogram(LB->getRawScope());
3782 // Just return null; broken scope chains are checked elsewhere.
3783 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
3787 template <class DbgIntrinsicTy>
3788 void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
3789 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
3790 Assert(isa<ValueAsMetadata>(MD) ||
3791 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
3792 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
3793 Assert(isa<DILocalVariable>(DII.getRawVariable()),
3794 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
3795 DII.getRawVariable());
3796 Assert(isa<DIExpression>(DII.getRawExpression()),
3797 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
3798 DII.getRawExpression());
3800 // Ignore broken !dbg attachments; they're checked elsewhere.
3801 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
3802 if (!isa<DILocation>(N))
3805 BasicBlock *BB = DII.getParent();
3806 Function *F = BB ? BB->getParent() : nullptr;
3808 // The scopes for variables and !dbg attachments must agree.
3809 DILocalVariable *Var = DII.getVariable();
3810 DILocation *Loc = DII.getDebugLoc();
3811 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
3814 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
3815 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
3816 if (!VarSP || !LocSP)
3817 return; // Broken scope chains are checked elsewhere.
3819 Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
3820 " variable and !dbg attachment",
3821 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
3822 Loc->getScope()->getSubprogram());
3825 template <class MapTy>
3826 static uint64_t getVariableSize(const DILocalVariable &V, const MapTy &Map) {
3827 // Be careful of broken types (checked elsewhere).
3828 const Metadata *RawType = V.getRawType();
3830 // Try to get the size directly.
3831 if (auto *T = dyn_cast<DIType>(RawType))
3832 if (uint64_t Size = T->getSizeInBits())
3835 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
3836 // Look at the base type.
3837 RawType = DT->getRawBaseType();
3841 if (auto *S = dyn_cast<MDString>(RawType)) {
3842 // Don't error on missing types (checked elsewhere).
3843 RawType = Map.lookup(S);
3847 // Missing type or size.
3855 template <class MapTy>
3856 void Verifier::verifyDIExpression(const DbgInfoIntrinsic &I,
3857 const MapTy &TypeRefs) {
3861 uint64_t ArgumentTypeSizeInBits = 0;
3862 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
3863 Arg = DVI->getValue();
3865 ArgumentTypeSizeInBits =
3866 M->getDataLayout().getTypeAllocSizeInBits(Arg->getType());
3867 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
3868 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
3870 auto *DDI = cast<DbgDeclareInst>(&I);
3871 // For declare intrinsics, get the total size of the alloca, to allow
3872 // case where the variable may span more than one element.
3873 Arg = DDI->getAddress();
3875 Arg = Arg->stripPointerCasts();
3876 const AllocaInst *AI = dyn_cast_or_null<AllocaInst>(Arg);
3878 // We can only say something about constant size allocations
3879 if (const ConstantInt *CI = dyn_cast<ConstantInt>(AI->getArraySize()))
3880 ArgumentTypeSizeInBits =
3881 CI->getLimitedValue() *
3882 M->getDataLayout().getTypeAllocSizeInBits(AI->getAllocatedType());
3884 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
3885 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
3888 // We don't know whether this intrinsic verified correctly.
3889 if (!V || !E || !E->isValid())
3892 // The frontend helps out GDB by emitting the members of local anonymous
3893 // unions as artificial local variables with shared storage. When SROA splits
3894 // the storage for artificial local variables that are smaller than the entire
3895 // union, the overhang piece will be outside of the allotted space for the
3896 // variable and this check fails.
3897 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
3898 if (V->isArtificial())
3901 // If there's no size, the type is broken, but that should be checked
3903 uint64_t VarSize = getVariableSize(*V, TypeRefs);
3907 if (E->isBitPiece()) {
3908 unsigned PieceSize = E->getBitPieceSize();
3909 unsigned PieceOffset = E->getBitPieceOffset();
3910 Assert(PieceSize + PieceOffset <= VarSize,
3911 "piece is larger than or outside of variable", &I, V, E);
3912 Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
3916 if (!ArgumentTypeSizeInBits)
3917 return; // We were unable to determine the size of the argument
3919 if (E->getNumElements() == 0) {
3920 // In the case where the expression is empty, verify the size of the
3921 // argument. Doing this in the general case would require looking through
3922 // any dereferences that may be in the expression.
3923 Assert(ArgumentTypeSizeInBits == VarSize,
3924 "size of passed value (" + std::to_string(ArgumentTypeSizeInBits) +
3925 ") does not match size of declared variable (" +
3926 std::to_string(VarSize) + ")",
3927 &I, Arg, V, V->getType(), E);
3928 } else if (E->getElement(0) == dwarf::DW_OP_deref) {
3929 Assert(ArgumentTypeSizeInBits == M->getDataLayout().getPointerSizeInBits(),
3930 "the operation of the expression is a deref, but the passed value "
3931 "is not pointer sized",
3932 &I, Arg, V, V->getType(), E);
3936 void Verifier::visitUnresolvedTypeRef(const MDString *S, const MDNode *N) {
3937 // This is in its own function so we get an error for each bad type ref (not
3939 Assert(false, "unresolved type ref", S, N);
3942 void Verifier::verifyTypeRefs() {
3943 auto *CUs = M->getNamedMetadata("llvm.dbg.cu");
3947 // Visit all the compile units again to map the type references.
3948 SmallDenseMap<const MDString *, const DIType *, 32> TypeRefs;
3949 for (auto *CU : CUs->operands())
3950 if (auto Ts = cast<DICompileUnit>(CU)->getRetainedTypes())
3951 for (DIType *Op : Ts)
3952 if (auto *T = dyn_cast_or_null<DICompositeType>(Op))
3953 if (auto *S = T->getRawIdentifier()) {
3954 UnresolvedTypeRefs.erase(S);
3955 TypeRefs.insert(std::make_pair(S, T));
3958 // Verify debug info intrinsic bit piece expressions. This needs a second
3959 // pass through the intructions, since we haven't built TypeRefs yet when
3960 // verifying functions, and simply queuing the DbgInfoIntrinsics to evaluate
3961 // later/now would queue up some that could be later deleted.
3962 for (const Function &F : *M)
3963 for (const BasicBlock &BB : F)
3964 for (const Instruction &I : BB)
3965 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
3966 verifyDIExpression(*DII, TypeRefs);
3968 // Return early if all typerefs were resolved.
3969 if (UnresolvedTypeRefs.empty())
3972 // Sort the unresolved references by name so the output is deterministic.
3973 typedef std::pair<const MDString *, const MDNode *> TypeRef;
3974 SmallVector<TypeRef, 32> Unresolved(UnresolvedTypeRefs.begin(),
3975 UnresolvedTypeRefs.end());
3976 std::sort(Unresolved.begin(), Unresolved.end(),
3977 [](const TypeRef &LHS, const TypeRef &RHS) {
3978 return LHS.first->getString() < RHS.first->getString();
3981 // Visit the unresolved refs (printing out the errors).
3982 for (const TypeRef &TR : Unresolved)
3983 visitUnresolvedTypeRef(TR.first, TR.second);
3986 //===----------------------------------------------------------------------===//
3987 // Implement the public interfaces to this file...
3988 //===----------------------------------------------------------------------===//
3990 bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
3991 Function &F = const_cast<Function &>(f);
3992 assert(!F.isDeclaration() && "Cannot verify external functions");
3994 raw_null_ostream NullStr;
3995 Verifier V(OS ? *OS : NullStr);
3997 // Note that this function's return value is inverted from what you would
3998 // expect of a function called "verify".
3999 return !V.verify(F);
4002 bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
4003 raw_null_ostream NullStr;
4004 Verifier V(OS ? *OS : NullStr);
4006 bool Broken = false;
4007 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
4008 if (!I->isDeclaration() && !I->isMaterializable())
4009 Broken |= !V.verify(*I);
4011 // Note that this function's return value is inverted from what you would
4012 // expect of a function called "verify".
4013 return !V.verify(M) || Broken;
4017 struct VerifierLegacyPass : public FunctionPass {
4023 VerifierLegacyPass() : FunctionPass(ID), V(dbgs()), FatalErrors(true) {
4024 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
4026 explicit VerifierLegacyPass(bool FatalErrors)
4027 : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
4028 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
4031 bool runOnFunction(Function &F) override {
4032 if (!V.verify(F) && FatalErrors)
4033 report_fatal_error("Broken function found, compilation aborted!");
4038 bool doFinalization(Module &M) override {
4039 if (!V.verify(M) && FatalErrors)
4040 report_fatal_error("Broken module found, compilation aborted!");
4045 void getAnalysisUsage(AnalysisUsage &AU) const override {
4046 AU.setPreservesAll();
4051 char VerifierLegacyPass::ID = 0;
4052 INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
4054 FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
4055 return new VerifierLegacyPass(FatalErrors);
4058 PreservedAnalyses VerifierPass::run(Module &M) {
4059 if (verifyModule(M, &dbgs()) && FatalErrors)
4060 report_fatal_error("Broken module found, compilation aborted!");
4062 return PreservedAnalyses::all();
4065 PreservedAnalyses VerifierPass::run(Function &F) {
4066 if (verifyFunction(F, &dbgs()) && FatalErrors)
4067 report_fatal_error("Broken function found, compilation aborted!");
4069 return PreservedAnalyses::all();