1 //===-- Verifier.cpp - Implement the Module Verifier -----------------------==//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the function verifier interface, that can be used for some
11 // sanity checking of input to the system.
13 // Note that this does not provide full `Java style' security and verifications,
14 // instead it just tries to ensure that code is well-formed.
16 // * Both of a binary operator's parameters are of the same type
17 // * Verify that the indices of mem access instructions match other operands
18 // * Verify that arithmetic and other things are only performed on first-class
19 // types. Verify that shifts & logicals only happen on integrals f.e.
20 // * All of the constants in a switch statement are of the correct type
21 // * The code is in valid SSA form
22 // * It should be illegal to put a label into any other type (like a structure)
23 // or to return one. [except constant arrays!]
24 // * Only phi nodes can be self referential: 'add i32 %0, %0 ; <int>:0' is bad
25 // * PHI nodes must have an entry for each predecessor, with no extras.
26 // * PHI nodes must be the first thing in a basic block, all grouped together
27 // * PHI nodes must have at least one entry
28 // * All basic blocks should only end with terminator insts, not contain them
29 // * The entry node to a function must not have predecessors
30 // * All Instructions must be embedded into a basic block
31 // * Functions cannot take a void-typed parameter
32 // * Verify that a function's argument list agrees with it's declared type.
33 // * It is illegal to specify a name for a void value.
34 // * It is illegal to have a internal global value with no initializer
35 // * It is illegal to have a ret instruction that returns a value that does not
36 // agree with the function return value type.
37 // * Function call argument types match the function prototype
38 // * A landing pad is defined by a landingpad instruction, and can be jumped to
39 // only by the unwind edge of an invoke instruction.
40 // * A landingpad instruction must be the first non-PHI instruction in the
42 // * All landingpad instructions must use the same personality function with
44 // * All other things that are tested by asserts spread about the code...
46 //===----------------------------------------------------------------------===//
48 #include "llvm/IR/Verifier.h"
49 #include "llvm/ADT/STLExtras.h"
50 #include "llvm/ADT/SetVector.h"
51 #include "llvm/ADT/SmallPtrSet.h"
52 #include "llvm/ADT/SmallVector.h"
53 #include "llvm/ADT/StringExtras.h"
54 #include "llvm/IR/CFG.h"
55 #include "llvm/IR/CallSite.h"
56 #include "llvm/IR/CallingConv.h"
57 #include "llvm/IR/ConstantRange.h"
58 #include "llvm/IR/Constants.h"
59 #include "llvm/IR/DataLayout.h"
60 #include "llvm/IR/DebugInfo.h"
61 #include "llvm/IR/DerivedTypes.h"
62 #include "llvm/IR/Dominators.h"
63 #include "llvm/IR/InlineAsm.h"
64 #include "llvm/IR/InstIterator.h"
65 #include "llvm/IR/InstVisitor.h"
66 #include "llvm/IR/IntrinsicInst.h"
67 #include "llvm/IR/LLVMContext.h"
68 #include "llvm/IR/Metadata.h"
69 #include "llvm/IR/Module.h"
70 #include "llvm/IR/PassManager.h"
71 #include "llvm/IR/Statepoint.h"
72 #include "llvm/Pass.h"
73 #include "llvm/Support/CommandLine.h"
74 #include "llvm/Support/Debug.h"
75 #include "llvm/Support/ErrorHandling.h"
76 #include "llvm/Support/raw_ostream.h"
81 static cl::opt<bool> VerifyDebugInfo("verify-debug-info", cl::init(true));
84 struct VerifierSupport {
88 /// \brief Track the brokenness of the module while recursively visiting.
91 explicit VerifierSupport(raw_ostream &OS)
92 : OS(OS), M(nullptr), Broken(false) {}
95 void Write(const Value *V) {
98 if (isa<Instruction>(V)) {
101 V->printAsOperand(OS, true, M);
105 void Write(ImmutableCallSite CS) {
106 Write(CS.getInstruction());
109 void Write(const Metadata *MD) {
116 template <class T> void Write(const MDTupleTypedArrayWrapper<T> &MD) {
120 void Write(const NamedMDNode *NMD) {
127 void Write(Type *T) {
133 void Write(const Comdat *C) {
139 template <typename T1, typename... Ts>
140 void WriteTs(const T1 &V1, const Ts &... Vs) {
145 template <typename... Ts> void WriteTs() {}
148 /// \brief A check failed, so printout out the condition and the message.
150 /// This provides a nice place to put a breakpoint if you want to see why
151 /// something is not correct.
152 void CheckFailed(const Twine &Message) {
153 OS << Message << '\n';
157 /// \brief A check failed (with values to print).
159 /// This calls the Message-only version so that the above is easier to set a
161 template <typename T1, typename... Ts>
162 void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) {
163 CheckFailed(Message);
168 class Verifier : public InstVisitor<Verifier>, VerifierSupport {
169 friend class InstVisitor<Verifier>;
171 LLVMContext *Context;
174 /// \brief When verifying a basic block, keep track of all of the
175 /// instructions we have seen so far.
177 /// This allows us to do efficient dominance checks for the case when an
178 /// instruction has an operand that is an instruction in the same block.
179 SmallPtrSet<Instruction *, 16> InstsInThisBlock;
181 /// \brief Keep track of the metadata nodes that have been checked already.
182 SmallPtrSet<const Metadata *, 32> MDNodes;
184 /// \brief Track unresolved string-based type references.
185 SmallDenseMap<const MDString *, const MDNode *, 32> UnresolvedTypeRefs;
187 /// \brief Whether we've seen a call to @llvm.localescape in this function
191 /// Stores the count of how many objects were passed to llvm.localescape for a
192 /// given function and the largest index passed to llvm.localrecover.
193 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
196 explicit Verifier(raw_ostream &OS)
197 : VerifierSupport(OS), Context(nullptr), SawFrameEscape(false) {}
199 bool verify(const Function &F) {
201 Context = &M->getContext();
203 // First ensure the function is well-enough formed to compute dominance
206 OS << "Function '" << F.getName()
207 << "' does not contain an entry block!\n";
210 for (Function::const_iterator I = F.begin(), E = F.end(); I != E; ++I) {
211 if (I->empty() || !I->back().isTerminator()) {
212 OS << "Basic Block in function '" << F.getName()
213 << "' does not have terminator!\n";
214 I->printAsOperand(OS, true);
220 // Now directly compute a dominance tree. We don't rely on the pass
221 // manager to provide this as it isolates us from a potentially
222 // out-of-date dominator tree and makes it significantly more complex to
223 // run this code outside of a pass manager.
224 // FIXME: It's really gross that we have to cast away constness here.
225 DT.recalculate(const_cast<Function &>(F));
228 // FIXME: We strip const here because the inst visitor strips const.
229 visit(const_cast<Function &>(F));
230 InstsInThisBlock.clear();
231 SawFrameEscape = false;
236 bool verify(const Module &M) {
238 Context = &M.getContext();
241 // Scan through, checking all of the external function's linkage now...
242 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
243 visitGlobalValue(*I);
245 // Check to make sure function prototypes are okay.
246 if (I->isDeclaration())
250 // Now that we've visited every function, verify that we never asked to
251 // recover a frame index that wasn't escaped.
252 verifyFrameRecoverIndices();
254 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
256 visitGlobalVariable(*I);
258 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
260 visitGlobalAlias(*I);
262 for (Module::const_named_metadata_iterator I = M.named_metadata_begin(),
263 E = M.named_metadata_end();
265 visitNamedMDNode(*I);
267 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
268 visitComdat(SMEC.getValue());
271 visitModuleIdents(M);
273 // Verify type referneces last.
280 // Verification methods...
281 void visitGlobalValue(const GlobalValue &GV);
282 void visitGlobalVariable(const GlobalVariable &GV);
283 void visitGlobalAlias(const GlobalAlias &GA);
284 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
285 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
286 const GlobalAlias &A, const Constant &C);
287 void visitNamedMDNode(const NamedMDNode &NMD);
288 void visitMDNode(const MDNode &MD);
289 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
290 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
291 void visitComdat(const Comdat &C);
292 void visitModuleIdents(const Module &M);
293 void visitModuleFlags(const Module &M);
294 void visitModuleFlag(const MDNode *Op,
295 DenseMap<const MDString *, const MDNode *> &SeenIDs,
296 SmallVectorImpl<const MDNode *> &Requirements);
297 void visitFunction(const Function &F);
298 void visitBasicBlock(BasicBlock &BB);
299 void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty);
301 template <class Ty> bool isValidMetadataArray(const MDTuple &N);
302 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
303 #include "llvm/IR/Metadata.def"
304 void visitDIScope(const DIScope &N);
305 void visitDIDerivedTypeBase(const DIDerivedTypeBase &N);
306 void visitDIVariable(const DIVariable &N);
307 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
308 void visitDITemplateParameter(const DITemplateParameter &N);
310 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
312 /// \brief Check for a valid string-based type reference.
314 /// Checks if \c MD is a string-based type reference. If it is, keeps track
315 /// of it (and its user, \c N) for error messages later.
316 bool isValidUUID(const MDNode &N, const Metadata *MD);
318 /// \brief Check for a valid type reference.
320 /// Checks for subclasses of \a DIType, or \a isValidUUID().
321 bool isTypeRef(const MDNode &N, const Metadata *MD);
323 /// \brief Check for a valid scope reference.
325 /// Checks for subclasses of \a DIScope, or \a isValidUUID().
326 bool isScopeRef(const MDNode &N, const Metadata *MD);
328 /// \brief Check for a valid debug info reference.
330 /// Checks for subclasses of \a DINode, or \a isValidUUID().
331 bool isDIRef(const MDNode &N, const Metadata *MD);
333 // InstVisitor overrides...
334 using InstVisitor<Verifier>::visit;
335 void visit(Instruction &I);
337 void visitTruncInst(TruncInst &I);
338 void visitZExtInst(ZExtInst &I);
339 void visitSExtInst(SExtInst &I);
340 void visitFPTruncInst(FPTruncInst &I);
341 void visitFPExtInst(FPExtInst &I);
342 void visitFPToUIInst(FPToUIInst &I);
343 void visitFPToSIInst(FPToSIInst &I);
344 void visitUIToFPInst(UIToFPInst &I);
345 void visitSIToFPInst(SIToFPInst &I);
346 void visitIntToPtrInst(IntToPtrInst &I);
347 void visitPtrToIntInst(PtrToIntInst &I);
348 void visitBitCastInst(BitCastInst &I);
349 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
350 void visitPHINode(PHINode &PN);
351 void visitBinaryOperator(BinaryOperator &B);
352 void visitICmpInst(ICmpInst &IC);
353 void visitFCmpInst(FCmpInst &FC);
354 void visitExtractElementInst(ExtractElementInst &EI);
355 void visitInsertElementInst(InsertElementInst &EI);
356 void visitShuffleVectorInst(ShuffleVectorInst &EI);
357 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
358 void visitCallInst(CallInst &CI);
359 void visitInvokeInst(InvokeInst &II);
360 void visitGetElementPtrInst(GetElementPtrInst &GEP);
361 void visitLoadInst(LoadInst &LI);
362 void visitStoreInst(StoreInst &SI);
363 void verifyDominatesUse(Instruction &I, unsigned i);
364 void visitInstruction(Instruction &I);
365 void visitTerminatorInst(TerminatorInst &I);
366 void visitBranchInst(BranchInst &BI);
367 void visitReturnInst(ReturnInst &RI);
368 void visitSwitchInst(SwitchInst &SI);
369 void visitIndirectBrInst(IndirectBrInst &BI);
370 void visitSelectInst(SelectInst &SI);
371 void visitUserOp1(Instruction &I);
372 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
373 void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS);
374 template <class DbgIntrinsicTy>
375 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
376 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
377 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
378 void visitFenceInst(FenceInst &FI);
379 void visitAllocaInst(AllocaInst &AI);
380 void visitExtractValueInst(ExtractValueInst &EVI);
381 void visitInsertValueInst(InsertValueInst &IVI);
382 void visitLandingPadInst(LandingPadInst &LPI);
383 void visitCatchBlockInst(CatchBlockInst &CBI);
384 void visitCatchEndBlockInst(CatchEndBlockInst &CEBI);
385 void visitCleanupBlockInst(CleanupBlockInst &CBI);
386 void visitTerminateBlockInst(TerminateBlockInst &TBI);
388 void VerifyCallSite(CallSite CS);
389 void verifyMustTailCall(CallInst &CI);
390 bool PerformTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
391 unsigned ArgNo, std::string &Suffix);
392 bool VerifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
393 SmallVectorImpl<Type *> &ArgTys);
394 bool VerifyIntrinsicIsVarArg(bool isVarArg,
395 ArrayRef<Intrinsic::IITDescriptor> &Infos);
396 bool VerifyAttributeCount(AttributeSet Attrs, unsigned Params);
397 void VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
399 void VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
400 bool isReturnValue, const Value *V);
401 void VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
403 void VerifyFunctionMetadata(
404 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs);
406 void VerifyConstantExprBitcastType(const ConstantExpr *CE);
407 void VerifyStatepoint(ImmutableCallSite CS);
408 void verifyFrameRecoverIndices();
410 // Module-level debug info verification...
411 void verifyTypeRefs();
412 template <class MapTy>
413 void verifyBitPieceExpression(const DbgInfoIntrinsic &I,
414 const MapTy &TypeRefs);
415 void visitUnresolvedTypeRef(const MDString *S, const MDNode *N);
417 } // End anonymous namespace
419 // Assert - We know that cond should be true, if not print an error message.
420 #define Assert(C, ...) \
421 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
423 void Verifier::visit(Instruction &I) {
424 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
425 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
426 InstVisitor<Verifier>::visit(I);
430 void Verifier::visitGlobalValue(const GlobalValue &GV) {
431 Assert(!GV.isDeclaration() || GV.hasExternalLinkage() ||
432 GV.hasExternalWeakLinkage(),
433 "Global is external, but doesn't have external or weak linkage!", &GV);
435 Assert(GV.getAlignment() <= Value::MaximumAlignment,
436 "huge alignment values are unsupported", &GV);
437 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
438 "Only global variables can have appending linkage!", &GV);
440 if (GV.hasAppendingLinkage()) {
441 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
442 Assert(GVar && GVar->getValueType()->isArrayTy(),
443 "Only global arrays can have appending linkage!", GVar);
446 if (GV.isDeclarationForLinker())
447 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
450 void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
451 if (GV.hasInitializer()) {
452 Assert(GV.getInitializer()->getType() == GV.getType()->getElementType(),
453 "Global variable initializer type does not match global "
457 // If the global has common linkage, it must have a zero initializer and
458 // cannot be constant.
459 if (GV.hasCommonLinkage()) {
460 Assert(GV.getInitializer()->isNullValue(),
461 "'common' global must have a zero initializer!", &GV);
462 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
464 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
467 Assert(GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
468 "invalid linkage type for global declaration", &GV);
471 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
472 GV.getName() == "llvm.global_dtors")) {
473 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
474 "invalid linkage for intrinsic global variable", &GV);
475 // Don't worry about emitting an error for it not being an array,
476 // visitGlobalValue will complain on appending non-array.
477 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
478 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
479 PointerType *FuncPtrTy =
480 FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
481 // FIXME: Reject the 2-field form in LLVM 4.0.
483 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
484 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
485 STy->getTypeAtIndex(1) == FuncPtrTy,
486 "wrong type for intrinsic global variable", &GV);
487 if (STy->getNumElements() == 3) {
488 Type *ETy = STy->getTypeAtIndex(2);
489 Assert(ETy->isPointerTy() &&
490 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
491 "wrong type for intrinsic global variable", &GV);
496 if (GV.hasName() && (GV.getName() == "llvm.used" ||
497 GV.getName() == "llvm.compiler.used")) {
498 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
499 "invalid linkage for intrinsic global variable", &GV);
500 Type *GVType = GV.getValueType();
501 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
502 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
503 Assert(PTy, "wrong type for intrinsic global variable", &GV);
504 if (GV.hasInitializer()) {
505 const Constant *Init = GV.getInitializer();
506 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
507 Assert(InitArray, "wrong initalizer for intrinsic global variable",
509 for (unsigned i = 0, e = InitArray->getNumOperands(); i != e; ++i) {
510 Value *V = Init->getOperand(i)->stripPointerCastsNoFollowAliases();
511 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
513 "invalid llvm.used member", V);
514 Assert(V->hasName(), "members of llvm.used must be named", V);
520 Assert(!GV.hasDLLImportStorageClass() ||
521 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
522 GV.hasAvailableExternallyLinkage(),
523 "Global is marked as dllimport, but not external", &GV);
525 if (!GV.hasInitializer()) {
526 visitGlobalValue(GV);
530 // Walk any aggregate initializers looking for bitcasts between address spaces
531 SmallPtrSet<const Value *, 4> Visited;
532 SmallVector<const Value *, 4> WorkStack;
533 WorkStack.push_back(cast<Value>(GV.getInitializer()));
535 while (!WorkStack.empty()) {
536 const Value *V = WorkStack.pop_back_val();
537 if (!Visited.insert(V).second)
540 if (const User *U = dyn_cast<User>(V)) {
541 WorkStack.append(U->op_begin(), U->op_end());
544 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
545 VerifyConstantExprBitcastType(CE);
551 visitGlobalValue(GV);
554 void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
555 SmallPtrSet<const GlobalAlias*, 4> Visited;
557 visitAliaseeSubExpr(Visited, GA, C);
560 void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
561 const GlobalAlias &GA, const Constant &C) {
562 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
563 Assert(!GV->isDeclaration(), "Alias must point to a definition", &GA);
565 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
566 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
568 Assert(!GA2->mayBeOverridden(), "Alias cannot point to a weak alias",
571 // Only continue verifying subexpressions of GlobalAliases.
572 // Do not recurse into global initializers.
577 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
578 VerifyConstantExprBitcastType(CE);
580 for (const Use &U : C.operands()) {
582 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
583 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
584 else if (const auto *C2 = dyn_cast<Constant>(V))
585 visitAliaseeSubExpr(Visited, GA, *C2);
589 void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
590 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
591 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
592 "weak_odr, or external linkage!",
594 const Constant *Aliasee = GA.getAliasee();
595 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
596 Assert(GA.getType() == Aliasee->getType(),
597 "Alias and aliasee types should match!", &GA);
599 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
600 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
602 visitAliaseeSubExpr(GA, *Aliasee);
604 visitGlobalValue(GA);
607 void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
608 for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i) {
609 MDNode *MD = NMD.getOperand(i);
611 if (NMD.getName() == "llvm.dbg.cu") {
612 Assert(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
622 void Verifier::visitMDNode(const MDNode &MD) {
623 // Only visit each node once. Metadata can be mutually recursive, so this
624 // avoids infinite recursion here, as well as being an optimization.
625 if (!MDNodes.insert(&MD).second)
628 switch (MD.getMetadataID()) {
630 llvm_unreachable("Invalid MDNode subclass");
631 case Metadata::MDTupleKind:
633 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
634 case Metadata::CLASS##Kind: \
635 visit##CLASS(cast<CLASS>(MD)); \
637 #include "llvm/IR/Metadata.def"
640 for (unsigned i = 0, e = MD.getNumOperands(); i != e; ++i) {
641 Metadata *Op = MD.getOperand(i);
644 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
646 if (auto *N = dyn_cast<MDNode>(Op)) {
650 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
651 visitValueAsMetadata(*V, nullptr);
656 // Check these last, so we diagnose problems in operands first.
657 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
658 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
661 void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
662 Assert(MD.getValue(), "Expected valid value", &MD);
663 Assert(!MD.getValue()->getType()->isMetadataTy(),
664 "Unexpected metadata round-trip through values", &MD, MD.getValue());
666 auto *L = dyn_cast<LocalAsMetadata>(&MD);
670 Assert(F, "function-local metadata used outside a function", L);
672 // If this was an instruction, bb, or argument, verify that it is in the
673 // function that we expect.
674 Function *ActualF = nullptr;
675 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
676 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
677 ActualF = I->getParent()->getParent();
678 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
679 ActualF = BB->getParent();
680 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
681 ActualF = A->getParent();
682 assert(ActualF && "Unimplemented function local metadata case!");
684 Assert(ActualF == F, "function-local metadata used in wrong function", L);
687 void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
688 Metadata *MD = MDV.getMetadata();
689 if (auto *N = dyn_cast<MDNode>(MD)) {
694 // Only visit each node once. Metadata can be mutually recursive, so this
695 // avoids infinite recursion here, as well as being an optimization.
696 if (!MDNodes.insert(MD).second)
699 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
700 visitValueAsMetadata(*V, F);
703 bool Verifier::isValidUUID(const MDNode &N, const Metadata *MD) {
704 auto *S = dyn_cast<MDString>(MD);
707 if (S->getString().empty())
710 // Keep track of names of types referenced via UUID so we can check that they
712 UnresolvedTypeRefs.insert(std::make_pair(S, &N));
716 /// \brief Check if a value can be a reference to a type.
717 bool Verifier::isTypeRef(const MDNode &N, const Metadata *MD) {
718 return !MD || isValidUUID(N, MD) || isa<DIType>(MD);
721 /// \brief Check if a value can be a ScopeRef.
722 bool Verifier::isScopeRef(const MDNode &N, const Metadata *MD) {
723 return !MD || isValidUUID(N, MD) || isa<DIScope>(MD);
726 /// \brief Check if a value can be a debug info ref.
727 bool Verifier::isDIRef(const MDNode &N, const Metadata *MD) {
728 return !MD || isValidUUID(N, MD) || isa<DINode>(MD);
732 bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
733 for (Metadata *MD : N.operands()) {
746 bool isValidMetadataArray(const MDTuple &N) {
747 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
751 bool isValidMetadataNullArray(const MDTuple &N) {
752 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
755 void Verifier::visitDILocation(const DILocation &N) {
756 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
757 "location requires a valid scope", &N, N.getRawScope());
758 if (auto *IA = N.getRawInlinedAt())
759 Assert(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
762 void Verifier::visitGenericDINode(const GenericDINode &N) {
763 Assert(N.getTag(), "invalid tag", &N);
766 void Verifier::visitDIScope(const DIScope &N) {
767 if (auto *F = N.getRawFile())
768 Assert(isa<DIFile>(F), "invalid file", &N, F);
771 void Verifier::visitDISubrange(const DISubrange &N) {
772 Assert(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
773 Assert(N.getCount() >= -1, "invalid subrange count", &N);
776 void Verifier::visitDIEnumerator(const DIEnumerator &N) {
777 Assert(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
780 void Verifier::visitDIBasicType(const DIBasicType &N) {
781 Assert(N.getTag() == dwarf::DW_TAG_base_type ||
782 N.getTag() == dwarf::DW_TAG_unspecified_type,
786 void Verifier::visitDIDerivedTypeBase(const DIDerivedTypeBase &N) {
787 // Common scope checks.
790 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
791 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
794 // FIXME: Sink this into the subclass verifies.
795 if (!N.getFile() || N.getFile()->getFilename().empty()) {
796 // Check whether the filename is allowed to be empty.
797 uint16_t Tag = N.getTag();
799 Tag == dwarf::DW_TAG_const_type || Tag == dwarf::DW_TAG_volatile_type ||
800 Tag == dwarf::DW_TAG_pointer_type ||
801 Tag == dwarf::DW_TAG_ptr_to_member_type ||
802 Tag == dwarf::DW_TAG_reference_type ||
803 Tag == dwarf::DW_TAG_rvalue_reference_type ||
804 Tag == dwarf::DW_TAG_restrict_type ||
805 Tag == dwarf::DW_TAG_array_type ||
806 Tag == dwarf::DW_TAG_enumeration_type ||
807 Tag == dwarf::DW_TAG_subroutine_type ||
808 Tag == dwarf::DW_TAG_inheritance || Tag == dwarf::DW_TAG_friend ||
809 Tag == dwarf::DW_TAG_structure_type ||
810 Tag == dwarf::DW_TAG_member || Tag == dwarf::DW_TAG_typedef,
811 "derived/composite type requires a filename", &N, N.getFile());
815 void Verifier::visitDIDerivedType(const DIDerivedType &N) {
816 // Common derived type checks.
817 visitDIDerivedTypeBase(N);
819 Assert(N.getTag() == dwarf::DW_TAG_typedef ||
820 N.getTag() == dwarf::DW_TAG_pointer_type ||
821 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
822 N.getTag() == dwarf::DW_TAG_reference_type ||
823 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
824 N.getTag() == dwarf::DW_TAG_const_type ||
825 N.getTag() == dwarf::DW_TAG_volatile_type ||
826 N.getTag() == dwarf::DW_TAG_restrict_type ||
827 N.getTag() == dwarf::DW_TAG_member ||
828 N.getTag() == dwarf::DW_TAG_inheritance ||
829 N.getTag() == dwarf::DW_TAG_friend,
831 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
832 Assert(isTypeRef(N, N.getExtraData()), "invalid pointer to member type", &N,
837 static bool hasConflictingReferenceFlags(unsigned Flags) {
838 return (Flags & DINode::FlagLValueReference) &&
839 (Flags & DINode::FlagRValueReference);
842 void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
843 auto *Params = dyn_cast<MDTuple>(&RawParams);
844 Assert(Params, "invalid template params", &N, &RawParams);
845 for (Metadata *Op : Params->operands()) {
846 Assert(Op && isa<DITemplateParameter>(Op), "invalid template parameter", &N,
851 void Verifier::visitDICompositeType(const DICompositeType &N) {
852 // Common derived type checks.
853 visitDIDerivedTypeBase(N);
855 Assert(N.getTag() == dwarf::DW_TAG_array_type ||
856 N.getTag() == dwarf::DW_TAG_structure_type ||
857 N.getTag() == dwarf::DW_TAG_union_type ||
858 N.getTag() == dwarf::DW_TAG_enumeration_type ||
859 N.getTag() == dwarf::DW_TAG_subroutine_type ||
860 N.getTag() == dwarf::DW_TAG_class_type,
863 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
864 "invalid composite elements", &N, N.getRawElements());
865 Assert(isTypeRef(N, N.getRawVTableHolder()), "invalid vtable holder", &N,
866 N.getRawVTableHolder());
867 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
868 "invalid composite elements", &N, N.getRawElements());
869 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
871 if (auto *Params = N.getRawTemplateParams())
872 visitTemplateParams(N, *Params);
875 void Verifier::visitDISubroutineType(const DISubroutineType &N) {
876 Assert(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
877 if (auto *Types = N.getRawTypeArray()) {
878 Assert(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
879 for (Metadata *Ty : N.getTypeArray()->operands()) {
880 Assert(isTypeRef(N, Ty), "invalid subroutine type ref", &N, Types, Ty);
883 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
887 void Verifier::visitDIFile(const DIFile &N) {
888 Assert(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
891 void Verifier::visitDICompileUnit(const DICompileUnit &N) {
892 Assert(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
894 // Don't bother verifying the compilation directory or producer string
895 // as those could be empty.
896 Assert(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
898 Assert(!N.getFile()->getFilename().empty(), "invalid filename", &N,
901 if (auto *Array = N.getRawEnumTypes()) {
902 Assert(isa<MDTuple>(Array), "invalid enum list", &N, Array);
903 for (Metadata *Op : N.getEnumTypes()->operands()) {
904 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
905 Assert(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
906 "invalid enum type", &N, N.getEnumTypes(), Op);
909 if (auto *Array = N.getRawRetainedTypes()) {
910 Assert(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
911 for (Metadata *Op : N.getRetainedTypes()->operands()) {
912 Assert(Op && isa<DIType>(Op), "invalid retained type", &N, Op);
915 if (auto *Array = N.getRawSubprograms()) {
916 Assert(isa<MDTuple>(Array), "invalid subprogram list", &N, Array);
917 for (Metadata *Op : N.getSubprograms()->operands()) {
918 Assert(Op && isa<DISubprogram>(Op), "invalid subprogram ref", &N, Op);
921 if (auto *Array = N.getRawGlobalVariables()) {
922 Assert(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
923 for (Metadata *Op : N.getGlobalVariables()->operands()) {
924 Assert(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref", &N,
928 if (auto *Array = N.getRawImportedEntities()) {
929 Assert(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
930 for (Metadata *Op : N.getImportedEntities()->operands()) {
931 Assert(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref", &N,
937 void Verifier::visitDISubprogram(const DISubprogram &N) {
938 Assert(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
939 Assert(isScopeRef(N, N.getRawScope()), "invalid scope", &N, N.getRawScope());
940 if (auto *T = N.getRawType())
941 Assert(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
942 Assert(isTypeRef(N, N.getRawContainingType()), "invalid containing type", &N,
943 N.getRawContainingType());
944 if (auto *RawF = N.getRawFunction()) {
945 auto *FMD = dyn_cast<ConstantAsMetadata>(RawF);
946 auto *F = FMD ? FMD->getValue() : nullptr;
947 auto *FT = F ? dyn_cast<PointerType>(F->getType()) : nullptr;
948 Assert(F && FT && isa<FunctionType>(FT->getElementType()),
949 "invalid function", &N, F, FT);
951 if (auto *Params = N.getRawTemplateParams())
952 visitTemplateParams(N, *Params);
953 if (auto *S = N.getRawDeclaration()) {
954 Assert(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
955 "invalid subprogram declaration", &N, S);
957 if (auto *RawVars = N.getRawVariables()) {
958 auto *Vars = dyn_cast<MDTuple>(RawVars);
959 Assert(Vars, "invalid variable list", &N, RawVars);
960 for (Metadata *Op : Vars->operands()) {
961 Assert(Op && isa<DILocalVariable>(Op), "invalid local variable", &N, Vars,
965 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
968 auto *F = N.getFunction();
972 // Check that all !dbg attachments lead to back to N (or, at least, another
973 // subprogram that describes the same function).
975 // FIXME: Check this incrementally while visiting !dbg attachments.
976 // FIXME: Only check when N is the canonical subprogram for F.
977 SmallPtrSet<const MDNode *, 32> Seen;
980 // Be careful about using DILocation here since we might be dealing with
981 // broken code (this is the Verifier after all).
983 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
986 if (!Seen.insert(DL).second)
989 DILocalScope *Scope = DL->getInlinedAtScope();
990 if (Scope && !Seen.insert(Scope).second)
993 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
994 if (SP && !Seen.insert(SP).second)
997 // FIXME: Once N is canonical, check "SP == &N".
998 Assert(SP->describes(F),
999 "!dbg attachment points at wrong subprogram for function", &N, F,
1004 void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
1005 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
1006 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1007 "invalid local scope", &N, N.getRawScope());
1010 void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1011 visitDILexicalBlockBase(N);
1013 Assert(N.getLine() || !N.getColumn(),
1014 "cannot have column info without line info", &N);
1017 void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1018 visitDILexicalBlockBase(N);
1021 void Verifier::visitDINamespace(const DINamespace &N) {
1022 Assert(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
1023 if (auto *S = N.getRawScope())
1024 Assert(isa<DIScope>(S), "invalid scope ref", &N, S);
1027 void Verifier::visitDIModule(const DIModule &N) {
1028 Assert(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1029 Assert(!N.getName().empty(), "anonymous module", &N);
1032 void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
1033 Assert(isTypeRef(N, N.getType()), "invalid type ref", &N, N.getType());
1036 void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1037 visitDITemplateParameter(N);
1039 Assert(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1043 void Verifier::visitDITemplateValueParameter(
1044 const DITemplateValueParameter &N) {
1045 visitDITemplateParameter(N);
1047 Assert(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1048 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1049 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1053 void Verifier::visitDIVariable(const DIVariable &N) {
1054 if (auto *S = N.getRawScope())
1055 Assert(isa<DIScope>(S), "invalid scope", &N, S);
1056 Assert(isTypeRef(N, N.getRawType()), "invalid type ref", &N, N.getRawType());
1057 if (auto *F = N.getRawFile())
1058 Assert(isa<DIFile>(F), "invalid file", &N, F);
1061 void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
1062 // Checks common to all variables.
1065 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1066 Assert(!N.getName().empty(), "missing global variable name", &N);
1067 if (auto *V = N.getRawVariable()) {
1068 Assert(isa<ConstantAsMetadata>(V) &&
1069 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
1070 "invalid global varaible ref", &N, V);
1072 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
1073 Assert(isa<DIDerivedType>(Member), "invalid static data member declaration",
1078 void Verifier::visitDILocalVariable(const DILocalVariable &N) {
1079 // Checks common to all variables.
1082 Assert(N.getTag() == dwarf::DW_TAG_auto_variable ||
1083 N.getTag() == dwarf::DW_TAG_arg_variable,
1085 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1086 "local variable requires a valid scope", &N, N.getRawScope());
1089 void Verifier::visitDIExpression(const DIExpression &N) {
1090 Assert(N.isValid(), "invalid expression", &N);
1093 void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
1094 Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
1095 if (auto *T = N.getRawType())
1096 Assert(isTypeRef(N, T), "invalid type ref", &N, T);
1097 if (auto *F = N.getRawFile())
1098 Assert(isa<DIFile>(F), "invalid file", &N, F);
1101 void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
1102 Assert(N.getTag() == dwarf::DW_TAG_imported_module ||
1103 N.getTag() == dwarf::DW_TAG_imported_declaration,
1105 if (auto *S = N.getRawScope())
1106 Assert(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1107 Assert(isDIRef(N, N.getEntity()), "invalid imported entity", &N,
1111 void Verifier::visitComdat(const Comdat &C) {
1112 // The Module is invalid if the GlobalValue has private linkage. Entities
1113 // with private linkage don't have entries in the symbol table.
1114 if (const GlobalValue *GV = M->getNamedValue(C.getName()))
1115 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1119 void Verifier::visitModuleIdents(const Module &M) {
1120 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1124 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1125 // Scan each llvm.ident entry and make sure that this requirement is met.
1126 for (unsigned i = 0, e = Idents->getNumOperands(); i != e; ++i) {
1127 const MDNode *N = Idents->getOperand(i);
1128 Assert(N->getNumOperands() == 1,
1129 "incorrect number of operands in llvm.ident metadata", N);
1130 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1131 ("invalid value for llvm.ident metadata entry operand"
1132 "(the operand should be a string)"),
1137 void Verifier::visitModuleFlags(const Module &M) {
1138 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1141 // Scan each flag, and track the flags and requirements.
1142 DenseMap<const MDString*, const MDNode*> SeenIDs;
1143 SmallVector<const MDNode*, 16> Requirements;
1144 for (unsigned I = 0, E = Flags->getNumOperands(); I != E; ++I) {
1145 visitModuleFlag(Flags->getOperand(I), SeenIDs, Requirements);
1148 // Validate that the requirements in the module are valid.
1149 for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
1150 const MDNode *Requirement = Requirements[I];
1151 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
1152 const Metadata *ReqValue = Requirement->getOperand(1);
1154 const MDNode *Op = SeenIDs.lookup(Flag);
1156 CheckFailed("invalid requirement on flag, flag is not present in module",
1161 if (Op->getOperand(2) != ReqValue) {
1162 CheckFailed(("invalid requirement on flag, "
1163 "flag does not have the required value"),
1171 Verifier::visitModuleFlag(const MDNode *Op,
1172 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1173 SmallVectorImpl<const MDNode *> &Requirements) {
1174 // Each module flag should have three arguments, the merge behavior (a
1175 // constant int), the flag ID (an MDString), and the value.
1176 Assert(Op->getNumOperands() == 3,
1177 "incorrect number of operands in module flag", Op);
1178 Module::ModFlagBehavior MFB;
1179 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
1181 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
1182 "invalid behavior operand in module flag (expected constant integer)",
1185 "invalid behavior operand in module flag (unexpected constant)",
1188 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
1189 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1192 // Sanity check the values for behaviors with additional requirements.
1195 case Module::Warning:
1196 case Module::Override:
1197 // These behavior types accept any value.
1200 case Module::Require: {
1201 // The value should itself be an MDNode with two operands, a flag ID (an
1202 // MDString), and a value.
1203 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
1204 Assert(Value && Value->getNumOperands() == 2,
1205 "invalid value for 'require' module flag (expected metadata pair)",
1207 Assert(isa<MDString>(Value->getOperand(0)),
1208 ("invalid value for 'require' module flag "
1209 "(first value operand should be a string)"),
1210 Value->getOperand(0));
1212 // Append it to the list of requirements, to check once all module flags are
1214 Requirements.push_back(Value);
1218 case Module::Append:
1219 case Module::AppendUnique: {
1220 // These behavior types require the operand be an MDNode.
1221 Assert(isa<MDNode>(Op->getOperand(2)),
1222 "invalid value for 'append'-type module flag "
1223 "(expected a metadata node)",
1229 // Unless this is a "requires" flag, check the ID is unique.
1230 if (MFB != Module::Require) {
1231 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
1233 "module flag identifiers must be unique (or of 'require' type)", ID);
1237 void Verifier::VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
1238 bool isFunction, const Value *V) {
1239 unsigned Slot = ~0U;
1240 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1241 if (Attrs.getSlotIndex(I) == Idx) {
1246 assert(Slot != ~0U && "Attribute set inconsistency!");
1248 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1250 if (I->isStringAttribute())
1253 if (I->getKindAsEnum() == Attribute::NoReturn ||
1254 I->getKindAsEnum() == Attribute::NoUnwind ||
1255 I->getKindAsEnum() == Attribute::NoInline ||
1256 I->getKindAsEnum() == Attribute::AlwaysInline ||
1257 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1258 I->getKindAsEnum() == Attribute::StackProtect ||
1259 I->getKindAsEnum() == Attribute::StackProtectReq ||
1260 I->getKindAsEnum() == Attribute::StackProtectStrong ||
1261 I->getKindAsEnum() == Attribute::SafeStack ||
1262 I->getKindAsEnum() == Attribute::NoRedZone ||
1263 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1264 I->getKindAsEnum() == Attribute::Naked ||
1265 I->getKindAsEnum() == Attribute::InlineHint ||
1266 I->getKindAsEnum() == Attribute::StackAlignment ||
1267 I->getKindAsEnum() == Attribute::UWTable ||
1268 I->getKindAsEnum() == Attribute::NonLazyBind ||
1269 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1270 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1271 I->getKindAsEnum() == Attribute::SanitizeThread ||
1272 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1273 I->getKindAsEnum() == Attribute::MinSize ||
1274 I->getKindAsEnum() == Attribute::NoDuplicate ||
1275 I->getKindAsEnum() == Attribute::Builtin ||
1276 I->getKindAsEnum() == Attribute::NoBuiltin ||
1277 I->getKindAsEnum() == Attribute::Cold ||
1278 I->getKindAsEnum() == Attribute::OptimizeNone ||
1279 I->getKindAsEnum() == Attribute::JumpTable ||
1280 I->getKindAsEnum() == Attribute::Convergent) {
1282 CheckFailed("Attribute '" + I->getAsString() +
1283 "' only applies to functions!", V);
1286 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
1287 I->getKindAsEnum() == Attribute::ReadNone) {
1289 CheckFailed("Attribute '" + I->getAsString() +
1290 "' does not apply to function returns");
1293 } else if (isFunction) {
1294 CheckFailed("Attribute '" + I->getAsString() +
1295 "' does not apply to functions!", V);
1301 // VerifyParameterAttrs - Check the given attributes for an argument or return
1302 // value of the specified type. The value V is printed in error messages.
1303 void Verifier::VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
1304 bool isReturnValue, const Value *V) {
1305 if (!Attrs.hasAttributes(Idx))
1308 VerifyAttributeTypes(Attrs, Idx, false, V);
1311 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1312 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1313 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1314 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1315 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
1316 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1317 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', and "
1318 "'returned' do not apply to return values!",
1321 // Check for mutually incompatible attributes. Only inreg is compatible with
1323 unsigned AttrCount = 0;
1324 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1325 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1326 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1327 Attrs.hasAttribute(Idx, Attribute::InReg);
1328 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
1329 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1330 "and 'sret' are incompatible!",
1333 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1334 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1336 "'inalloca and readonly' are incompatible!",
1339 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1340 Attrs.hasAttribute(Idx, Attribute::Returned)),
1342 "'sret and returned' are incompatible!",
1345 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1346 Attrs.hasAttribute(Idx, Attribute::SExt)),
1348 "'zeroext and signext' are incompatible!",
1351 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1352 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1354 "'readnone and readonly' are incompatible!",
1357 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1358 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1360 "'noinline and alwaysinline' are incompatible!",
1363 Assert(!AttrBuilder(Attrs, Idx)
1364 .overlaps(AttributeFuncs::typeIncompatible(Ty)),
1365 "Wrong types for attribute: " +
1366 AttributeSet::get(*Context, Idx,
1367 AttributeFuncs::typeIncompatible(Ty)).getAsString(Idx),
1370 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
1371 SmallPtrSet<const Type*, 4> Visited;
1372 if (!PTy->getElementType()->isSized(&Visited)) {
1373 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1374 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1375 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1379 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1380 "Attribute 'byval' only applies to parameters with pointer type!",
1385 // VerifyFunctionAttrs - Check parameter attributes against a function type.
1386 // The value V is printed in error messages.
1387 void Verifier::VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
1389 if (Attrs.isEmpty())
1392 bool SawNest = false;
1393 bool SawReturned = false;
1394 bool SawSRet = false;
1396 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
1397 unsigned Idx = Attrs.getSlotIndex(i);
1401 Ty = FT->getReturnType();
1402 else if (Idx-1 < FT->getNumParams())
1403 Ty = FT->getParamType(Idx-1);
1405 break; // VarArgs attributes, verified elsewhere.
1407 VerifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
1412 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
1413 Assert(!SawNest, "More than one parameter has attribute nest!", V);
1417 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
1418 Assert(!SawReturned, "More than one parameter has attribute returned!",
1420 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1422 "argument and return types for 'returned' attribute",
1427 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
1428 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1429 Assert(Idx == 1 || Idx == 2,
1430 "Attribute 'sret' is not on first or second parameter!", V);
1434 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
1435 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1440 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1443 VerifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
1446 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1447 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1448 "Attributes 'readnone and readonly' are incompatible!", V);
1451 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1452 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1453 Attribute::AlwaysInline)),
1454 "Attributes 'noinline and alwaysinline' are incompatible!", V);
1456 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1457 Attribute::OptimizeNone)) {
1458 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1459 "Attribute 'optnone' requires 'noinline'!", V);
1461 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1462 Attribute::OptimizeForSize),
1463 "Attributes 'optsize and optnone' are incompatible!", V);
1465 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1466 "Attributes 'minsize and optnone' are incompatible!", V);
1469 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1470 Attribute::JumpTable)) {
1471 const GlobalValue *GV = cast<GlobalValue>(V);
1472 Assert(GV->hasUnnamedAddr(),
1473 "Attribute 'jumptable' requires 'unnamed_addr'", V);
1477 void Verifier::VerifyFunctionMetadata(
1478 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs) {
1482 for (unsigned i = 0; i < MDs.size(); i++) {
1483 if (MDs[i].first == LLVMContext::MD_prof) {
1484 MDNode *MD = MDs[i].second;
1485 Assert(MD->getNumOperands() == 2,
1486 "!prof annotations should have exactly 2 operands", MD);
1488 // Check first operand.
1489 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1491 Assert(isa<MDString>(MD->getOperand(0)),
1492 "expected string with name of the !prof annotation", MD);
1493 MDString *MDS = cast<MDString>(MD->getOperand(0));
1494 StringRef ProfName = MDS->getString();
1495 Assert(ProfName.equals("function_entry_count"),
1496 "first operand should be 'function_entry_count'", MD);
1498 // Check second operand.
1499 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1501 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1502 "expected integer argument to function_entry_count", MD);
1507 void Verifier::VerifyConstantExprBitcastType(const ConstantExpr *CE) {
1508 if (CE->getOpcode() != Instruction::BitCast)
1511 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1513 "Invalid bitcast", CE);
1516 bool Verifier::VerifyAttributeCount(AttributeSet Attrs, unsigned Params) {
1517 if (Attrs.getNumSlots() == 0)
1520 unsigned LastSlot = Attrs.getNumSlots() - 1;
1521 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
1522 if (LastIndex <= Params
1523 || (LastIndex == AttributeSet::FunctionIndex
1524 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
1530 /// \brief Verify that statepoint intrinsic is well formed.
1531 void Verifier::VerifyStatepoint(ImmutableCallSite CS) {
1532 assert(CS.getCalledFunction() &&
1533 CS.getCalledFunction()->getIntrinsicID() ==
1534 Intrinsic::experimental_gc_statepoint);
1536 const Instruction &CI = *CS.getInstruction();
1538 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory(),
1539 "gc.statepoint must read and write memory to preserve "
1540 "reordering restrictions required by safepoint semantics",
1543 const Value *IDV = CS.getArgument(0);
1544 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1547 const Value *NumPatchBytesV = CS.getArgument(1);
1548 Assert(isa<ConstantInt>(NumPatchBytesV),
1549 "gc.statepoint number of patchable bytes must be a constant integer",
1551 const int64_t NumPatchBytes =
1552 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1553 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1554 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1558 const Value *Target = CS.getArgument(2);
1559 const PointerType *PT = dyn_cast<PointerType>(Target->getType());
1560 Assert(PT && PT->getElementType()->isFunctionTy(),
1561 "gc.statepoint callee must be of function pointer type", &CI, Target);
1562 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
1565 Assert(isa<ConstantPointerNull>(Target->stripPointerCasts()),
1566 "gc.statepoint must have null as call target if number of patchable "
1567 "bytes is non zero",
1570 const Value *NumCallArgsV = CS.getArgument(3);
1571 Assert(isa<ConstantInt>(NumCallArgsV),
1572 "gc.statepoint number of arguments to underlying call "
1573 "must be constant integer",
1575 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
1576 Assert(NumCallArgs >= 0,
1577 "gc.statepoint number of arguments to underlying call "
1580 const int NumParams = (int)TargetFuncType->getNumParams();
1581 if (TargetFuncType->isVarArg()) {
1582 Assert(NumCallArgs >= NumParams,
1583 "gc.statepoint mismatch in number of vararg call args", &CI);
1585 // TODO: Remove this limitation
1586 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1587 "gc.statepoint doesn't support wrapping non-void "
1588 "vararg functions yet",
1591 Assert(NumCallArgs == NumParams,
1592 "gc.statepoint mismatch in number of call args", &CI);
1594 const Value *FlagsV = CS.getArgument(4);
1595 Assert(isa<ConstantInt>(FlagsV),
1596 "gc.statepoint flags must be constant integer", &CI);
1597 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1598 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1599 "unknown flag used in gc.statepoint flags argument", &CI);
1601 // Verify that the types of the call parameter arguments match
1602 // the type of the wrapped callee.
1603 for (int i = 0; i < NumParams; i++) {
1604 Type *ParamType = TargetFuncType->getParamType(i);
1605 Type *ArgType = CS.getArgument(5 + i)->getType();
1606 Assert(ArgType == ParamType,
1607 "gc.statepoint call argument does not match wrapped "
1612 const int EndCallArgsInx = 4 + NumCallArgs;
1614 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1615 Assert(isa<ConstantInt>(NumTransitionArgsV),
1616 "gc.statepoint number of transition arguments "
1617 "must be constant integer",
1619 const int NumTransitionArgs =
1620 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1621 Assert(NumTransitionArgs >= 0,
1622 "gc.statepoint number of transition arguments must be positive", &CI);
1623 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1625 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
1626 Assert(isa<ConstantInt>(NumDeoptArgsV),
1627 "gc.statepoint number of deoptimization arguments "
1628 "must be constant integer",
1630 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
1631 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1635 const int ExpectedNumArgs =
1636 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
1637 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
1638 "gc.statepoint too few arguments according to length fields", &CI);
1640 // Check that the only uses of this gc.statepoint are gc.result or
1641 // gc.relocate calls which are tied to this statepoint and thus part
1642 // of the same statepoint sequence
1643 for (const User *U : CI.users()) {
1644 const CallInst *Call = dyn_cast<const CallInst>(U);
1645 Assert(Call, "illegal use of statepoint token", &CI, U);
1646 if (!Call) continue;
1647 Assert(isGCRelocate(Call) || isGCResult(Call),
1648 "gc.result or gc.relocate are the only value uses"
1649 "of a gc.statepoint",
1651 if (isGCResult(Call)) {
1652 Assert(Call->getArgOperand(0) == &CI,
1653 "gc.result connected to wrong gc.statepoint", &CI, Call);
1654 } else if (isGCRelocate(Call)) {
1655 Assert(Call->getArgOperand(0) == &CI,
1656 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
1660 // Note: It is legal for a single derived pointer to be listed multiple
1661 // times. It's non-optimal, but it is legal. It can also happen after
1662 // insertion if we strip a bitcast away.
1663 // Note: It is really tempting to check that each base is relocated and
1664 // that a derived pointer is never reused as a base pointer. This turns
1665 // out to be problematic since optimizations run after safepoint insertion
1666 // can recognize equality properties that the insertion logic doesn't know
1667 // about. See example statepoint.ll in the verifier subdirectory
1670 void Verifier::verifyFrameRecoverIndices() {
1671 for (auto &Counts : FrameEscapeInfo) {
1672 Function *F = Counts.first;
1673 unsigned EscapedObjectCount = Counts.second.first;
1674 unsigned MaxRecoveredIndex = Counts.second.second;
1675 Assert(MaxRecoveredIndex <= EscapedObjectCount,
1676 "all indices passed to llvm.localrecover must be less than the "
1677 "number of arguments passed ot llvm.localescape in the parent "
1683 // visitFunction - Verify that a function is ok.
1685 void Verifier::visitFunction(const Function &F) {
1686 // Check function arguments.
1687 FunctionType *FT = F.getFunctionType();
1688 unsigned NumArgs = F.arg_size();
1690 Assert(Context == &F.getContext(),
1691 "Function context does not match Module context!", &F);
1693 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1694 Assert(FT->getNumParams() == NumArgs,
1695 "# formal arguments must match # of arguments for function type!", &F,
1697 Assert(F.getReturnType()->isFirstClassType() ||
1698 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1699 "Functions cannot return aggregate values!", &F);
1701 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1702 "Invalid struct return type!", &F);
1704 AttributeSet Attrs = F.getAttributes();
1706 Assert(VerifyAttributeCount(Attrs, FT->getNumParams()),
1707 "Attribute after last parameter!", &F);
1709 // Check function attributes.
1710 VerifyFunctionAttrs(FT, Attrs, &F);
1712 // On function declarations/definitions, we do not support the builtin
1713 // attribute. We do not check this in VerifyFunctionAttrs since that is
1714 // checking for Attributes that can/can not ever be on functions.
1715 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1716 "Attribute 'builtin' can only be applied to a callsite.", &F);
1718 // Check that this function meets the restrictions on this calling convention.
1719 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1720 // restrictions can be lifted.
1721 switch (F.getCallingConv()) {
1723 case CallingConv::C:
1725 case CallingConv::Fast:
1726 case CallingConv::Cold:
1727 case CallingConv::Intel_OCL_BI:
1728 case CallingConv::PTX_Kernel:
1729 case CallingConv::PTX_Device:
1730 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1731 "perfect forwarding!",
1736 bool isLLVMdotName = F.getName().size() >= 5 &&
1737 F.getName().substr(0, 5) == "llvm.";
1739 // Check that the argument values match the function type for this function...
1741 for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E;
1743 Assert(I->getType() == FT->getParamType(i),
1744 "Argument value does not match function argument type!", I,
1745 FT->getParamType(i));
1746 Assert(I->getType()->isFirstClassType(),
1747 "Function arguments must have first-class types!", I);
1749 Assert(!I->getType()->isMetadataTy(),
1750 "Function takes metadata but isn't an intrinsic", I, &F);
1753 // Get the function metadata attachments.
1754 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1755 F.getAllMetadata(MDs);
1756 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
1757 VerifyFunctionMetadata(MDs);
1759 if (F.isMaterializable()) {
1760 // Function has a body somewhere we can't see.
1761 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
1762 MDs.empty() ? nullptr : MDs.front().second);
1763 } else if (F.isDeclaration()) {
1764 Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1765 "invalid linkage type for function declaration", &F);
1766 Assert(MDs.empty(), "function without a body cannot have metadata", &F,
1767 MDs.empty() ? nullptr : MDs.front().second);
1768 Assert(!F.hasPersonalityFn(),
1769 "Function declaration shouldn't have a personality routine", &F);
1771 // Verify that this function (which has a body) is not named "llvm.*". It
1772 // is not legal to define intrinsics.
1773 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
1775 // Check the entry node
1776 const BasicBlock *Entry = &F.getEntryBlock();
1777 Assert(pred_empty(Entry),
1778 "Entry block to function must not have predecessors!", Entry);
1780 // The address of the entry block cannot be taken, unless it is dead.
1781 if (Entry->hasAddressTaken()) {
1782 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1783 "blockaddress may not be used with the entry block!", Entry);
1786 // Visit metadata attachments.
1787 for (const auto &I : MDs)
1788 visitMDNode(*I.second);
1791 // If this function is actually an intrinsic, verify that it is only used in
1792 // direct call/invokes, never having its "address taken".
1793 if (F.getIntrinsicID()) {
1795 if (F.hasAddressTaken(&U))
1796 Assert(0, "Invalid user of intrinsic instruction!", U);
1799 Assert(!F.hasDLLImportStorageClass() ||
1800 (F.isDeclaration() && F.hasExternalLinkage()) ||
1801 F.hasAvailableExternallyLinkage(),
1802 "Function is marked as dllimport, but not external.", &F);
1805 // verifyBasicBlock - Verify that a basic block is well formed...
1807 void Verifier::visitBasicBlock(BasicBlock &BB) {
1808 InstsInThisBlock.clear();
1810 // Ensure that basic blocks have terminators!
1811 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
1813 // Check constraints that this basic block imposes on all of the PHI nodes in
1815 if (isa<PHINode>(BB.front())) {
1816 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
1817 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
1818 std::sort(Preds.begin(), Preds.end());
1820 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
1821 // Ensure that PHI nodes have at least one entry!
1822 Assert(PN->getNumIncomingValues() != 0,
1823 "PHI nodes must have at least one entry. If the block is dead, "
1824 "the PHI should be removed!",
1826 Assert(PN->getNumIncomingValues() == Preds.size(),
1827 "PHINode should have one entry for each predecessor of its "
1828 "parent basic block!",
1831 // Get and sort all incoming values in the PHI node...
1833 Values.reserve(PN->getNumIncomingValues());
1834 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1835 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
1836 PN->getIncomingValue(i)));
1837 std::sort(Values.begin(), Values.end());
1839 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
1840 // Check to make sure that if there is more than one entry for a
1841 // particular basic block in this PHI node, that the incoming values are
1844 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
1845 Values[i].second == Values[i - 1].second,
1846 "PHI node has multiple entries for the same basic block with "
1847 "different incoming values!",
1848 PN, Values[i].first, Values[i].second, Values[i - 1].second);
1850 // Check to make sure that the predecessors and PHI node entries are
1852 Assert(Values[i].first == Preds[i],
1853 "PHI node entries do not match predecessors!", PN,
1854 Values[i].first, Preds[i]);
1859 // Check that all instructions have their parent pointers set up correctly.
1862 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
1866 void Verifier::visitTerminatorInst(TerminatorInst &I) {
1867 // Ensure that terminators only exist at the end of the basic block.
1868 Assert(&I == I.getParent()->getTerminator(),
1869 "Terminator found in the middle of a basic block!", I.getParent());
1870 visitInstruction(I);
1873 void Verifier::visitBranchInst(BranchInst &BI) {
1874 if (BI.isConditional()) {
1875 Assert(BI.getCondition()->getType()->isIntegerTy(1),
1876 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
1878 visitTerminatorInst(BI);
1881 void Verifier::visitReturnInst(ReturnInst &RI) {
1882 Function *F = RI.getParent()->getParent();
1883 unsigned N = RI.getNumOperands();
1884 if (F->getReturnType()->isVoidTy())
1886 "Found return instr that returns non-void in Function of void "
1888 &RI, F->getReturnType());
1890 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
1891 "Function return type does not match operand "
1892 "type of return inst!",
1893 &RI, F->getReturnType());
1895 // Check to make sure that the return value has necessary properties for
1897 visitTerminatorInst(RI);
1900 void Verifier::visitSwitchInst(SwitchInst &SI) {
1901 // Check to make sure that all of the constants in the switch instruction
1902 // have the same type as the switched-on value.
1903 Type *SwitchTy = SI.getCondition()->getType();
1904 SmallPtrSet<ConstantInt*, 32> Constants;
1905 for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end(); i != e; ++i) {
1906 Assert(i.getCaseValue()->getType() == SwitchTy,
1907 "Switch constants must all be same type as switch value!", &SI);
1908 Assert(Constants.insert(i.getCaseValue()).second,
1909 "Duplicate integer as switch case", &SI, i.getCaseValue());
1912 visitTerminatorInst(SI);
1915 void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
1916 Assert(BI.getAddress()->getType()->isPointerTy(),
1917 "Indirectbr operand must have pointer type!", &BI);
1918 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
1919 Assert(BI.getDestination(i)->getType()->isLabelTy(),
1920 "Indirectbr destinations must all have pointer type!", &BI);
1922 visitTerminatorInst(BI);
1925 void Verifier::visitSelectInst(SelectInst &SI) {
1926 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
1928 "Invalid operands for select instruction!", &SI);
1930 Assert(SI.getTrueValue()->getType() == SI.getType(),
1931 "Select values must have same type as select instruction!", &SI);
1932 visitInstruction(SI);
1935 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
1936 /// a pass, if any exist, it's an error.
1938 void Verifier::visitUserOp1(Instruction &I) {
1939 Assert(0, "User-defined operators should not live outside of a pass!", &I);
1942 void Verifier::visitTruncInst(TruncInst &I) {
1943 // Get the source and destination types
1944 Type *SrcTy = I.getOperand(0)->getType();
1945 Type *DestTy = I.getType();
1947 // Get the size of the types in bits, we'll need this later
1948 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1949 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1951 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
1952 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
1953 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1954 "trunc source and destination must both be a vector or neither", &I);
1955 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
1957 visitInstruction(I);
1960 void Verifier::visitZExtInst(ZExtInst &I) {
1961 // Get the source and destination types
1962 Type *SrcTy = I.getOperand(0)->getType();
1963 Type *DestTy = I.getType();
1965 // Get the size of the types in bits, we'll need this later
1966 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
1967 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
1968 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1969 "zext source and destination must both be a vector or neither", &I);
1970 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1971 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1973 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
1975 visitInstruction(I);
1978 void Verifier::visitSExtInst(SExtInst &I) {
1979 // Get the source and destination types
1980 Type *SrcTy = I.getOperand(0)->getType();
1981 Type *DestTy = I.getType();
1983 // Get the size of the types in bits, we'll need this later
1984 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1985 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1987 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
1988 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
1989 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1990 "sext source and destination must both be a vector or neither", &I);
1991 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
1993 visitInstruction(I);
1996 void Verifier::visitFPTruncInst(FPTruncInst &I) {
1997 // Get the source and destination types
1998 Type *SrcTy = I.getOperand(0)->getType();
1999 Type *DestTy = I.getType();
2000 // Get the size of the types in bits, we'll need this later
2001 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2002 unsigned DestBitSize = DestTy->getScalarSizeInBits();
2004 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2005 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2006 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2007 "fptrunc source and destination must both be a vector or neither", &I);
2008 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
2010 visitInstruction(I);
2013 void Verifier::visitFPExtInst(FPExtInst &I) {
2014 // Get the source and destination types
2015 Type *SrcTy = I.getOperand(0)->getType();
2016 Type *DestTy = I.getType();
2018 // Get the size of the types in bits, we'll need this later
2019 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2020 unsigned DestBitSize = DestTy->getScalarSizeInBits();
2022 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2023 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2024 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2025 "fpext source and destination must both be a vector or neither", &I);
2026 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
2028 visitInstruction(I);
2031 void Verifier::visitUIToFPInst(UIToFPInst &I) {
2032 // Get the source and destination types
2033 Type *SrcTy = I.getOperand(0)->getType();
2034 Type *DestTy = I.getType();
2036 bool SrcVec = SrcTy->isVectorTy();
2037 bool DstVec = DestTy->isVectorTy();
2039 Assert(SrcVec == DstVec,
2040 "UIToFP source and dest must both be vector or scalar", &I);
2041 Assert(SrcTy->isIntOrIntVectorTy(),
2042 "UIToFP source must be integer or integer vector", &I);
2043 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2046 if (SrcVec && DstVec)
2047 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2048 cast<VectorType>(DestTy)->getNumElements(),
2049 "UIToFP source and dest vector length mismatch", &I);
2051 visitInstruction(I);
2054 void Verifier::visitSIToFPInst(SIToFPInst &I) {
2055 // Get the source and destination types
2056 Type *SrcTy = I.getOperand(0)->getType();
2057 Type *DestTy = I.getType();
2059 bool SrcVec = SrcTy->isVectorTy();
2060 bool DstVec = DestTy->isVectorTy();
2062 Assert(SrcVec == DstVec,
2063 "SIToFP source and dest must both be vector or scalar", &I);
2064 Assert(SrcTy->isIntOrIntVectorTy(),
2065 "SIToFP source must be integer or integer vector", &I);
2066 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2069 if (SrcVec && DstVec)
2070 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2071 cast<VectorType>(DestTy)->getNumElements(),
2072 "SIToFP source and dest vector length mismatch", &I);
2074 visitInstruction(I);
2077 void Verifier::visitFPToUIInst(FPToUIInst &I) {
2078 // Get the source and destination types
2079 Type *SrcTy = I.getOperand(0)->getType();
2080 Type *DestTy = I.getType();
2082 bool SrcVec = SrcTy->isVectorTy();
2083 bool DstVec = DestTy->isVectorTy();
2085 Assert(SrcVec == DstVec,
2086 "FPToUI source and dest must both be vector or scalar", &I);
2087 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2089 Assert(DestTy->isIntOrIntVectorTy(),
2090 "FPToUI result must be integer or integer vector", &I);
2092 if (SrcVec && DstVec)
2093 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2094 cast<VectorType>(DestTy)->getNumElements(),
2095 "FPToUI source and dest vector length mismatch", &I);
2097 visitInstruction(I);
2100 void Verifier::visitFPToSIInst(FPToSIInst &I) {
2101 // Get the source and destination types
2102 Type *SrcTy = I.getOperand(0)->getType();
2103 Type *DestTy = I.getType();
2105 bool SrcVec = SrcTy->isVectorTy();
2106 bool DstVec = DestTy->isVectorTy();
2108 Assert(SrcVec == DstVec,
2109 "FPToSI source and dest must both be vector or scalar", &I);
2110 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2112 Assert(DestTy->isIntOrIntVectorTy(),
2113 "FPToSI result must be integer or integer vector", &I);
2115 if (SrcVec && DstVec)
2116 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2117 cast<VectorType>(DestTy)->getNumElements(),
2118 "FPToSI source and dest vector length mismatch", &I);
2120 visitInstruction(I);
2123 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2124 // Get the source and destination types
2125 Type *SrcTy = I.getOperand(0)->getType();
2126 Type *DestTy = I.getType();
2128 Assert(SrcTy->getScalarType()->isPointerTy(),
2129 "PtrToInt source must be pointer", &I);
2130 Assert(DestTy->getScalarType()->isIntegerTy(),
2131 "PtrToInt result must be integral", &I);
2132 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2135 if (SrcTy->isVectorTy()) {
2136 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2137 VectorType *VDest = dyn_cast<VectorType>(DestTy);
2138 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2139 "PtrToInt Vector width mismatch", &I);
2142 visitInstruction(I);
2145 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2146 // Get the source and destination types
2147 Type *SrcTy = I.getOperand(0)->getType();
2148 Type *DestTy = I.getType();
2150 Assert(SrcTy->getScalarType()->isIntegerTy(),
2151 "IntToPtr source must be an integral", &I);
2152 Assert(DestTy->getScalarType()->isPointerTy(),
2153 "IntToPtr result must be a pointer", &I);
2154 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2156 if (SrcTy->isVectorTy()) {
2157 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2158 VectorType *VDest = dyn_cast<VectorType>(DestTy);
2159 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2160 "IntToPtr Vector width mismatch", &I);
2162 visitInstruction(I);
2165 void Verifier::visitBitCastInst(BitCastInst &I) {
2167 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2168 "Invalid bitcast", &I);
2169 visitInstruction(I);
2172 void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2173 Type *SrcTy = I.getOperand(0)->getType();
2174 Type *DestTy = I.getType();
2176 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2178 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2180 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2181 "AddrSpaceCast must be between different address spaces", &I);
2182 if (SrcTy->isVectorTy())
2183 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2184 "AddrSpaceCast vector pointer number of elements mismatch", &I);
2185 visitInstruction(I);
2188 /// visitPHINode - Ensure that a PHI node is well formed.
2190 void Verifier::visitPHINode(PHINode &PN) {
2191 // Ensure that the PHI nodes are all grouped together at the top of the block.
2192 // This can be tested by checking whether the instruction before this is
2193 // either nonexistent (because this is begin()) or is a PHI node. If not,
2194 // then there is some other instruction before a PHI.
2195 Assert(&PN == &PN.getParent()->front() ||
2196 isa<PHINode>(--BasicBlock::iterator(&PN)),
2197 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
2199 // Check that all of the values of the PHI node have the same type as the
2200 // result, and that the incoming blocks are really basic blocks.
2201 for (Value *IncValue : PN.incoming_values()) {
2202 Assert(PN.getType() == IncValue->getType(),
2203 "PHI node operands are not the same type as the result!", &PN);
2206 // All other PHI node constraints are checked in the visitBasicBlock method.
2208 visitInstruction(PN);
2211 void Verifier::VerifyCallSite(CallSite CS) {
2212 Instruction *I = CS.getInstruction();
2214 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2215 "Called function must be a pointer!", I);
2216 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
2218 Assert(FPTy->getElementType()->isFunctionTy(),
2219 "Called function is not pointer to function type!", I);
2221 Assert(FPTy->getElementType() == CS.getFunctionType(),
2222 "Called function is not the same type as the call!", I);
2224 FunctionType *FTy = CS.getFunctionType();
2226 // Verify that the correct number of arguments are being passed
2227 if (FTy->isVarArg())
2228 Assert(CS.arg_size() >= FTy->getNumParams(),
2229 "Called function requires more parameters than were provided!", I);
2231 Assert(CS.arg_size() == FTy->getNumParams(),
2232 "Incorrect number of arguments passed to called function!", I);
2234 // Verify that all arguments to the call match the function type.
2235 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2236 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2237 "Call parameter type does not match function signature!",
2238 CS.getArgument(i), FTy->getParamType(i), I);
2240 AttributeSet Attrs = CS.getAttributes();
2242 Assert(VerifyAttributeCount(Attrs, CS.arg_size()),
2243 "Attribute after last parameter!", I);
2245 // Verify call attributes.
2246 VerifyFunctionAttrs(FTy, Attrs, I);
2248 // Conservatively check the inalloca argument.
2249 // We have a bug if we can find that there is an underlying alloca without
2251 if (CS.hasInAllocaArgument()) {
2252 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2253 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
2254 Assert(AI->isUsedWithInAlloca(),
2255 "inalloca argument for call has mismatched alloca", AI, I);
2258 if (FTy->isVarArg()) {
2259 // FIXME? is 'nest' even legal here?
2260 bool SawNest = false;
2261 bool SawReturned = false;
2263 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2264 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2266 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2270 // Check attributes on the varargs part.
2271 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
2272 Type *Ty = CS.getArgument(Idx-1)->getType();
2273 VerifyParameterAttrs(Attrs, Idx, Ty, false, I);
2275 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
2276 Assert(!SawNest, "More than one parameter has attribute nest!", I);
2280 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
2281 Assert(!SawReturned, "More than one parameter has attribute returned!",
2283 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2284 "Incompatible argument and return types for 'returned' "
2290 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2291 "Attribute 'sret' cannot be used for vararg call arguments!", I);
2293 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
2294 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
2298 // Verify that there's no metadata unless it's a direct call to an intrinsic.
2299 if (CS.getCalledFunction() == nullptr ||
2300 !CS.getCalledFunction()->getName().startswith("llvm.")) {
2301 for (FunctionType::param_iterator PI = FTy->param_begin(),
2302 PE = FTy->param_end(); PI != PE; ++PI)
2303 Assert(!(*PI)->isMetadataTy(),
2304 "Function has metadata parameter but isn't an intrinsic", I);
2307 if (Function *F = CS.getCalledFunction())
2308 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
2309 visitIntrinsicCallSite(ID, CS);
2311 visitInstruction(*I);
2314 /// Two types are "congruent" if they are identical, or if they are both pointer
2315 /// types with different pointee types and the same address space.
2316 static bool isTypeCongruent(Type *L, Type *R) {
2319 PointerType *PL = dyn_cast<PointerType>(L);
2320 PointerType *PR = dyn_cast<PointerType>(R);
2323 return PL->getAddressSpace() == PR->getAddressSpace();
2326 static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2327 static const Attribute::AttrKind ABIAttrs[] = {
2328 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
2329 Attribute::InReg, Attribute::Returned};
2331 for (auto AK : ABIAttrs) {
2332 if (Attrs.hasAttribute(I + 1, AK))
2333 Copy.addAttribute(AK);
2335 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2336 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2340 void Verifier::verifyMustTailCall(CallInst &CI) {
2341 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
2343 // - The caller and callee prototypes must match. Pointer types of
2344 // parameters or return types may differ in pointee type, but not
2346 Function *F = CI.getParent()->getParent();
2347 FunctionType *CallerTy = F->getFunctionType();
2348 FunctionType *CalleeTy = CI.getFunctionType();
2349 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2350 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2351 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2352 "cannot guarantee tail call due to mismatched varargs", &CI);
2353 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2354 "cannot guarantee tail call due to mismatched return types", &CI);
2355 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2357 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2358 "cannot guarantee tail call due to mismatched parameter types", &CI);
2361 // - The calling conventions of the caller and callee must match.
2362 Assert(F->getCallingConv() == CI.getCallingConv(),
2363 "cannot guarantee tail call due to mismatched calling conv", &CI);
2365 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2366 // returned, and inalloca, must match.
2367 AttributeSet CallerAttrs = F->getAttributes();
2368 AttributeSet CalleeAttrs = CI.getAttributes();
2369 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2370 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2371 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
2372 Assert(CallerABIAttrs == CalleeABIAttrs,
2373 "cannot guarantee tail call due to mismatched ABI impacting "
2374 "function attributes",
2375 &CI, CI.getOperand(I));
2378 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2379 // or a pointer bitcast followed by a ret instruction.
2380 // - The ret instruction must return the (possibly bitcasted) value
2381 // produced by the call or void.
2382 Value *RetVal = &CI;
2383 Instruction *Next = CI.getNextNode();
2385 // Handle the optional bitcast.
2386 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
2387 Assert(BI->getOperand(0) == RetVal,
2388 "bitcast following musttail call must use the call", BI);
2390 Next = BI->getNextNode();
2393 // Check the return.
2394 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
2395 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2397 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2398 "musttail call result must be returned", Ret);
2401 void Verifier::visitCallInst(CallInst &CI) {
2402 VerifyCallSite(&CI);
2404 if (CI.isMustTailCall())
2405 verifyMustTailCall(CI);
2408 void Verifier::visitInvokeInst(InvokeInst &II) {
2409 VerifyCallSite(&II);
2411 // Verify that the first non-PHI instruction of the unwind destination is an
2412 // exception handling instruction.
2414 II.getUnwindDest()->isEHBlock(),
2415 "The unwind destination does not have an exception handling instruction!",
2418 visitTerminatorInst(II);
2421 /// visitBinaryOperator - Check that both arguments to the binary operator are
2422 /// of the same type!
2424 void Verifier::visitBinaryOperator(BinaryOperator &B) {
2425 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2426 "Both operands to a binary operator are not of the same type!", &B);
2428 switch (B.getOpcode()) {
2429 // Check that integer arithmetic operators are only used with
2430 // integral operands.
2431 case Instruction::Add:
2432 case Instruction::Sub:
2433 case Instruction::Mul:
2434 case Instruction::SDiv:
2435 case Instruction::UDiv:
2436 case Instruction::SRem:
2437 case Instruction::URem:
2438 Assert(B.getType()->isIntOrIntVectorTy(),
2439 "Integer arithmetic operators only work with integral types!", &B);
2440 Assert(B.getType() == B.getOperand(0)->getType(),
2441 "Integer arithmetic operators must have same type "
2442 "for operands and result!",
2445 // Check that floating-point arithmetic operators are only used with
2446 // floating-point operands.
2447 case Instruction::FAdd:
2448 case Instruction::FSub:
2449 case Instruction::FMul:
2450 case Instruction::FDiv:
2451 case Instruction::FRem:
2452 Assert(B.getType()->isFPOrFPVectorTy(),
2453 "Floating-point arithmetic operators only work with "
2454 "floating-point types!",
2456 Assert(B.getType() == B.getOperand(0)->getType(),
2457 "Floating-point arithmetic operators must have same type "
2458 "for operands and result!",
2461 // Check that logical operators are only used with integral operands.
2462 case Instruction::And:
2463 case Instruction::Or:
2464 case Instruction::Xor:
2465 Assert(B.getType()->isIntOrIntVectorTy(),
2466 "Logical operators only work with integral types!", &B);
2467 Assert(B.getType() == B.getOperand(0)->getType(),
2468 "Logical operators must have same type for operands and result!",
2471 case Instruction::Shl:
2472 case Instruction::LShr:
2473 case Instruction::AShr:
2474 Assert(B.getType()->isIntOrIntVectorTy(),
2475 "Shifts only work with integral types!", &B);
2476 Assert(B.getType() == B.getOperand(0)->getType(),
2477 "Shift return type must be same as operands!", &B);
2480 llvm_unreachable("Unknown BinaryOperator opcode!");
2483 visitInstruction(B);
2486 void Verifier::visitICmpInst(ICmpInst &IC) {
2487 // Check that the operands are the same type
2488 Type *Op0Ty = IC.getOperand(0)->getType();
2489 Type *Op1Ty = IC.getOperand(1)->getType();
2490 Assert(Op0Ty == Op1Ty,
2491 "Both operands to ICmp instruction are not of the same type!", &IC);
2492 // Check that the operands are the right type
2493 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2494 "Invalid operand types for ICmp instruction", &IC);
2495 // Check that the predicate is valid.
2496 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2497 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2498 "Invalid predicate in ICmp instruction!", &IC);
2500 visitInstruction(IC);
2503 void Verifier::visitFCmpInst(FCmpInst &FC) {
2504 // Check that the operands are the same type
2505 Type *Op0Ty = FC.getOperand(0)->getType();
2506 Type *Op1Ty = FC.getOperand(1)->getType();
2507 Assert(Op0Ty == Op1Ty,
2508 "Both operands to FCmp instruction are not of the same type!", &FC);
2509 // Check that the operands are the right type
2510 Assert(Op0Ty->isFPOrFPVectorTy(),
2511 "Invalid operand types for FCmp instruction", &FC);
2512 // Check that the predicate is valid.
2513 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2514 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2515 "Invalid predicate in FCmp instruction!", &FC);
2517 visitInstruction(FC);
2520 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
2522 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2523 "Invalid extractelement operands!", &EI);
2524 visitInstruction(EI);
2527 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
2528 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2530 "Invalid insertelement operands!", &IE);
2531 visitInstruction(IE);
2534 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
2535 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2537 "Invalid shufflevector operands!", &SV);
2538 visitInstruction(SV);
2541 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
2542 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
2544 Assert(isa<PointerType>(TargetTy),
2545 "GEP base pointer is not a vector or a vector of pointers", &GEP);
2546 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
2547 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
2549 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
2550 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
2552 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
2553 GEP.getResultElementType() == ElTy,
2554 "GEP is not of right type for indices!", &GEP, ElTy);
2556 if (GEP.getType()->isVectorTy()) {
2557 // Additional checks for vector GEPs.
2558 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2559 if (GEP.getPointerOperandType()->isVectorTy())
2560 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2561 "Vector GEP result width doesn't match operand's", &GEP);
2562 for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
2563 Type *IndexTy = Idxs[i]->getType();
2564 if (IndexTy->isVectorTy()) {
2565 unsigned IndexWidth = IndexTy->getVectorNumElements();
2566 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2568 Assert(IndexTy->getScalarType()->isIntegerTy(),
2569 "All GEP indices should be of integer type");
2572 visitInstruction(GEP);
2575 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2576 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2579 void Verifier::visitRangeMetadata(Instruction& I,
2580 MDNode* Range, Type* Ty) {
2582 Range == I.getMetadata(LLVMContext::MD_range) &&
2583 "precondition violation");
2585 unsigned NumOperands = Range->getNumOperands();
2586 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
2587 unsigned NumRanges = NumOperands / 2;
2588 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2590 ConstantRange LastRange(1); // Dummy initial value
2591 for (unsigned i = 0; i < NumRanges; ++i) {
2593 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
2594 Assert(Low, "The lower limit must be an integer!", Low);
2596 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
2597 Assert(High, "The upper limit must be an integer!", High);
2598 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2599 "Range types must match instruction type!", &I);
2601 APInt HighV = High->getValue();
2602 APInt LowV = Low->getValue();
2603 ConstantRange CurRange(LowV, HighV);
2604 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2605 "Range must not be empty!", Range);
2607 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2608 "Intervals are overlapping", Range);
2609 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2611 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2614 LastRange = ConstantRange(LowV, HighV);
2616 if (NumRanges > 2) {
2618 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
2620 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
2621 ConstantRange FirstRange(FirstLow, FirstHigh);
2622 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2623 "Intervals are overlapping", Range);
2624 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2629 void Verifier::visitLoadInst(LoadInst &LI) {
2630 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
2631 Assert(PTy, "Load operand must be a pointer.", &LI);
2632 Type *ElTy = LI.getType();
2633 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2634 "huge alignment values are unsupported", &LI);
2635 if (LI.isAtomic()) {
2636 Assert(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
2637 "Load cannot have Release ordering", &LI);
2638 Assert(LI.getAlignment() != 0,
2639 "Atomic load must specify explicit alignment", &LI);
2640 if (!ElTy->isPointerTy()) {
2641 Assert(ElTy->isIntegerTy(), "atomic load operand must have integer type!",
2643 unsigned Size = ElTy->getPrimitiveSizeInBits();
2644 Assert(Size >= 8 && !(Size & (Size - 1)),
2645 "atomic load operand must be power-of-two byte-sized integer", &LI,
2649 Assert(LI.getSynchScope() == CrossThread,
2650 "Non-atomic load cannot have SynchronizationScope specified", &LI);
2653 visitInstruction(LI);
2656 void Verifier::visitStoreInst(StoreInst &SI) {
2657 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
2658 Assert(PTy, "Store operand must be a pointer.", &SI);
2659 Type *ElTy = PTy->getElementType();
2660 Assert(ElTy == SI.getOperand(0)->getType(),
2661 "Stored value type does not match pointer operand type!", &SI, ElTy);
2662 Assert(SI.getAlignment() <= Value::MaximumAlignment,
2663 "huge alignment values are unsupported", &SI);
2664 if (SI.isAtomic()) {
2665 Assert(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
2666 "Store cannot have Acquire ordering", &SI);
2667 Assert(SI.getAlignment() != 0,
2668 "Atomic store must specify explicit alignment", &SI);
2669 if (!ElTy->isPointerTy()) {
2670 Assert(ElTy->isIntegerTy(),
2671 "atomic store operand must have integer type!", &SI, ElTy);
2672 unsigned Size = ElTy->getPrimitiveSizeInBits();
2673 Assert(Size >= 8 && !(Size & (Size - 1)),
2674 "atomic store operand must be power-of-two byte-sized integer",
2678 Assert(SI.getSynchScope() == CrossThread,
2679 "Non-atomic store cannot have SynchronizationScope specified", &SI);
2681 visitInstruction(SI);
2684 void Verifier::visitAllocaInst(AllocaInst &AI) {
2685 SmallPtrSet<const Type*, 4> Visited;
2686 PointerType *PTy = AI.getType();
2687 Assert(PTy->getAddressSpace() == 0,
2688 "Allocation instruction pointer not in the generic address space!",
2690 Assert(AI.getAllocatedType()->isSized(&Visited),
2691 "Cannot allocate unsized type", &AI);
2692 Assert(AI.getArraySize()->getType()->isIntegerTy(),
2693 "Alloca array size must have integer type", &AI);
2694 Assert(AI.getAlignment() <= Value::MaximumAlignment,
2695 "huge alignment values are unsupported", &AI);
2697 visitInstruction(AI);
2700 void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
2702 // FIXME: more conditions???
2703 Assert(CXI.getSuccessOrdering() != NotAtomic,
2704 "cmpxchg instructions must be atomic.", &CXI);
2705 Assert(CXI.getFailureOrdering() != NotAtomic,
2706 "cmpxchg instructions must be atomic.", &CXI);
2707 Assert(CXI.getSuccessOrdering() != Unordered,
2708 "cmpxchg instructions cannot be unordered.", &CXI);
2709 Assert(CXI.getFailureOrdering() != Unordered,
2710 "cmpxchg instructions cannot be unordered.", &CXI);
2711 Assert(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
2712 "cmpxchg instructions be at least as constrained on success as fail",
2714 Assert(CXI.getFailureOrdering() != Release &&
2715 CXI.getFailureOrdering() != AcquireRelease,
2716 "cmpxchg failure ordering cannot include release semantics", &CXI);
2718 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
2719 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
2720 Type *ElTy = PTy->getElementType();
2721 Assert(ElTy->isIntegerTy(), "cmpxchg operand must have integer type!", &CXI,
2723 unsigned Size = ElTy->getPrimitiveSizeInBits();
2724 Assert(Size >= 8 && !(Size & (Size - 1)),
2725 "cmpxchg operand must be power-of-two byte-sized integer", &CXI, ElTy);
2726 Assert(ElTy == CXI.getOperand(1)->getType(),
2727 "Expected value type does not match pointer operand type!", &CXI,
2729 Assert(ElTy == CXI.getOperand(2)->getType(),
2730 "Stored value type does not match pointer operand type!", &CXI, ElTy);
2731 visitInstruction(CXI);
2734 void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
2735 Assert(RMWI.getOrdering() != NotAtomic,
2736 "atomicrmw instructions must be atomic.", &RMWI);
2737 Assert(RMWI.getOrdering() != Unordered,
2738 "atomicrmw instructions cannot be unordered.", &RMWI);
2739 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
2740 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
2741 Type *ElTy = PTy->getElementType();
2742 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
2744 unsigned Size = ElTy->getPrimitiveSizeInBits();
2745 Assert(Size >= 8 && !(Size & (Size - 1)),
2746 "atomicrmw operand must be power-of-two byte-sized integer", &RMWI,
2748 Assert(ElTy == RMWI.getOperand(1)->getType(),
2749 "Argument value type does not match pointer operand type!", &RMWI,
2751 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
2752 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
2753 "Invalid binary operation!", &RMWI);
2754 visitInstruction(RMWI);
2757 void Verifier::visitFenceInst(FenceInst &FI) {
2758 const AtomicOrdering Ordering = FI.getOrdering();
2759 Assert(Ordering == Acquire || Ordering == Release ||
2760 Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
2761 "fence instructions may only have "
2762 "acquire, release, acq_rel, or seq_cst ordering.",
2764 visitInstruction(FI);
2767 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
2768 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
2769 EVI.getIndices()) == EVI.getType(),
2770 "Invalid ExtractValueInst operands!", &EVI);
2772 visitInstruction(EVI);
2775 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
2776 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
2777 IVI.getIndices()) ==
2778 IVI.getOperand(1)->getType(),
2779 "Invalid InsertValueInst operands!", &IVI);
2781 visitInstruction(IVI);
2784 void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
2785 BasicBlock *BB = LPI.getParent();
2787 // The landingpad instruction is ill-formed if it doesn't have any clauses and
2789 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
2790 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
2792 // The landingpad instruction defines its parent as a landing pad block. The
2793 // landing pad block may be branched to only by the unwind edge of an invoke.
2794 for (pred_iterator I = pred_begin(BB), E = pred_end(BB); I != E; ++I) {
2795 const InvokeInst *II = dyn_cast<InvokeInst>((*I)->getTerminator());
2796 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
2797 "Block containing LandingPadInst must be jumped to "
2798 "only by the unwind edge of an invoke.",
2802 Function *F = LPI.getParent()->getParent();
2803 Assert(F->hasPersonalityFn(),
2804 "LandingPadInst needs to be in a function with a personality.", &LPI);
2806 // The landingpad instruction must be the first non-PHI instruction in the
2808 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
2809 "LandingPadInst not the first non-PHI instruction in the block.",
2812 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
2813 Constant *Clause = LPI.getClause(i);
2814 if (LPI.isCatch(i)) {
2815 Assert(isa<PointerType>(Clause->getType()),
2816 "Catch operand does not have pointer type!", &LPI);
2818 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
2819 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
2820 "Filter operand is not an array of constants!", &LPI);
2824 visitInstruction(LPI);
2827 void Verifier::visitCatchBlockInst(CatchBlockInst &CBI) {
2828 BasicBlock *BB = CBI.getParent();
2830 Function *F = BB->getParent();
2831 Assert(F->hasPersonalityFn(),
2832 "CatchBlockInst needs to be in a function with a personality.", &CBI);
2834 // The catchblock instruction must be the first non-PHI instruction in the
2836 Assert(BB->getFirstNonPHI() == &CBI,
2837 "CatchBlockInst not the first non-PHI instruction in the block.",
2840 visitTerminatorInst(CBI);
2843 void Verifier::visitCatchEndBlockInst(CatchEndBlockInst &CEBI) {
2844 BasicBlock *BB = CEBI.getParent();
2846 Function *F = BB->getParent();
2847 Assert(F->hasPersonalityFn(),
2848 "CatchEndBlockInst needs to be in a function with a personality.",
2851 // The catchendblock instruction must be the first non-PHI instruction in the
2853 Assert(BB->getFirstNonPHI() == &CEBI,
2854 "CatchEndBlockInst not the first non-PHI instruction in the block.",
2857 visitTerminatorInst(CEBI);
2860 void Verifier::visitCleanupBlockInst(CleanupBlockInst &CBI) {
2861 BasicBlock *BB = CBI.getParent();
2863 Function *F = BB->getParent();
2864 Assert(F->hasPersonalityFn(),
2865 "CleanupBlockInst needs to be in a function with a personality.", &CBI);
2867 // The cleanupblock instruction must be the first non-PHI instruction in the
2869 Assert(BB->getFirstNonPHI() == &CBI,
2870 "CleanupBlockInst not the first non-PHI instruction in the block.",
2873 visitInstruction(CBI);
2876 void Verifier::visitTerminateBlockInst(TerminateBlockInst &TBI) {
2877 BasicBlock *BB = TBI.getParent();
2879 Function *F = BB->getParent();
2880 Assert(F->hasPersonalityFn(),
2881 "TerminateBlockInst needs to be in a function with a personality.",
2884 // The terminateblock instruction must be the first non-PHI instruction in the
2886 Assert(BB->getFirstNonPHI() == &TBI,
2887 "TerminateBlockInst not the first non-PHI instruction in the block.",
2890 visitTerminatorInst(TBI);
2893 void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
2894 Instruction *Op = cast<Instruction>(I.getOperand(i));
2895 // If the we have an invalid invoke, don't try to compute the dominance.
2896 // We already reject it in the invoke specific checks and the dominance
2897 // computation doesn't handle multiple edges.
2898 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
2899 if (II->getNormalDest() == II->getUnwindDest())
2903 const Use &U = I.getOperandUse(i);
2904 Assert(InstsInThisBlock.count(Op) || DT.dominates(Op, U),
2905 "Instruction does not dominate all uses!", Op, &I);
2908 /// verifyInstruction - Verify that an instruction is well formed.
2910 void Verifier::visitInstruction(Instruction &I) {
2911 BasicBlock *BB = I.getParent();
2912 Assert(BB, "Instruction not embedded in basic block!", &I);
2914 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
2915 for (User *U : I.users()) {
2916 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
2917 "Only PHI nodes may reference their own value!", &I);
2921 // Check that void typed values don't have names
2922 Assert(!I.getType()->isVoidTy() || !I.hasName(),
2923 "Instruction has a name, but provides a void value!", &I);
2925 // Check that the return value of the instruction is either void or a legal
2927 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
2928 "Instruction returns a non-scalar type!", &I);
2930 // Check that the instruction doesn't produce metadata. Calls are already
2931 // checked against the callee type.
2932 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
2933 "Invalid use of metadata!", &I);
2935 // Check that all uses of the instruction, if they are instructions
2936 // themselves, actually have parent basic blocks. If the use is not an
2937 // instruction, it is an error!
2938 for (Use &U : I.uses()) {
2939 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
2940 Assert(Used->getParent() != nullptr,
2941 "Instruction referencing"
2942 " instruction not embedded in a basic block!",
2945 CheckFailed("Use of instruction is not an instruction!", U);
2950 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
2951 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
2953 // Check to make sure that only first-class-values are operands to
2955 if (!I.getOperand(i)->getType()->isFirstClassType()) {
2956 Assert(0, "Instruction operands must be first-class values!", &I);
2959 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
2960 // Check to make sure that the "address of" an intrinsic function is never
2963 !F->isIntrinsic() ||
2964 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
2965 "Cannot take the address of an intrinsic!", &I);
2967 !F->isIntrinsic() || isa<CallInst>(I) ||
2968 F->getIntrinsicID() == Intrinsic::donothing ||
2969 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
2970 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
2971 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
2972 "Cannot invoke an intrinsinc other than"
2973 " donothing or patchpoint",
2975 Assert(F->getParent() == M, "Referencing function in another module!",
2977 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
2978 Assert(OpBB->getParent() == BB->getParent(),
2979 "Referring to a basic block in another function!", &I);
2980 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
2981 Assert(OpArg->getParent() == BB->getParent(),
2982 "Referring to an argument in another function!", &I);
2983 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
2984 Assert(GV->getParent() == M, "Referencing global in another module!", &I);
2985 } else if (isa<Instruction>(I.getOperand(i))) {
2986 verifyDominatesUse(I, i);
2987 } else if (isa<InlineAsm>(I.getOperand(i))) {
2988 Assert((i + 1 == e && isa<CallInst>(I)) ||
2989 (i + 3 == e && isa<InvokeInst>(I)),
2990 "Cannot take the address of an inline asm!", &I);
2991 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
2992 if (CE->getType()->isPtrOrPtrVectorTy()) {
2993 // If we have a ConstantExpr pointer, we need to see if it came from an
2994 // illegal bitcast (inttoptr <constant int> )
2995 SmallVector<const ConstantExpr *, 4> Stack;
2996 SmallPtrSet<const ConstantExpr *, 4> Visited;
2997 Stack.push_back(CE);
2999 while (!Stack.empty()) {
3000 const ConstantExpr *V = Stack.pop_back_val();
3001 if (!Visited.insert(V).second)
3004 VerifyConstantExprBitcastType(V);
3006 for (unsigned I = 0, N = V->getNumOperands(); I != N; ++I) {
3007 if (ConstantExpr *Op = dyn_cast<ConstantExpr>(V->getOperand(I)))
3008 Stack.push_back(Op);
3015 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
3016 Assert(I.getType()->isFPOrFPVectorTy(),
3017 "fpmath requires a floating point result!", &I);
3018 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
3019 if (ConstantFP *CFP0 =
3020 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
3021 APFloat Accuracy = CFP0->getValueAPF();
3022 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3023 "fpmath accuracy not a positive number!", &I);
3025 Assert(false, "invalid fpmath accuracy!", &I);
3029 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
3030 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3031 "Ranges are only for loads, calls and invokes!", &I);
3032 visitRangeMetadata(I, Range, I.getType());
3035 if (I.getMetadata(LLVMContext::MD_nonnull)) {
3036 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3038 Assert(isa<LoadInst>(I),
3039 "nonnull applies only to load instructions, use attributes"
3040 " for calls or invokes",
3044 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
3045 Assert(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
3049 InstsInThisBlock.insert(&I);
3052 /// VerifyIntrinsicType - Verify that the specified type (which comes from an
3053 /// intrinsic argument or return value) matches the type constraints specified
3054 /// by the .td file (e.g. an "any integer" argument really is an integer).
3056 /// This return true on error but does not print a message.
3057 bool Verifier::VerifyIntrinsicType(Type *Ty,
3058 ArrayRef<Intrinsic::IITDescriptor> &Infos,
3059 SmallVectorImpl<Type*> &ArgTys) {
3060 using namespace Intrinsic;
3062 // If we ran out of descriptors, there are too many arguments.
3063 if (Infos.empty()) return true;
3064 IITDescriptor D = Infos.front();
3065 Infos = Infos.slice(1);
3068 case IITDescriptor::Void: return !Ty->isVoidTy();
3069 case IITDescriptor::VarArg: return true;
3070 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
3071 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
3072 case IITDescriptor::Half: return !Ty->isHalfTy();
3073 case IITDescriptor::Float: return !Ty->isFloatTy();
3074 case IITDescriptor::Double: return !Ty->isDoubleTy();
3075 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
3076 case IITDescriptor::Vector: {
3077 VectorType *VT = dyn_cast<VectorType>(Ty);
3078 return !VT || VT->getNumElements() != D.Vector_Width ||
3079 VerifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
3081 case IITDescriptor::Pointer: {
3082 PointerType *PT = dyn_cast<PointerType>(Ty);
3083 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
3084 VerifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
3087 case IITDescriptor::Struct: {
3088 StructType *ST = dyn_cast<StructType>(Ty);
3089 if (!ST || ST->getNumElements() != D.Struct_NumElements)
3092 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
3093 if (VerifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
3098 case IITDescriptor::Argument:
3099 // Two cases here - If this is the second occurrence of an argument, verify
3100 // that the later instance matches the previous instance.
3101 if (D.getArgumentNumber() < ArgTys.size())
3102 return Ty != ArgTys[D.getArgumentNumber()];
3104 // Otherwise, if this is the first instance of an argument, record it and
3105 // verify the "Any" kind.
3106 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
3107 ArgTys.push_back(Ty);
3109 switch (D.getArgumentKind()) {
3110 case IITDescriptor::AK_Any: return false; // Success
3111 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
3112 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
3113 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
3114 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
3116 llvm_unreachable("all argument kinds not covered");
3118 case IITDescriptor::ExtendArgument: {
3119 // This may only be used when referring to a previous vector argument.
3120 if (D.getArgumentNumber() >= ArgTys.size())
3123 Type *NewTy = ArgTys[D.getArgumentNumber()];
3124 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3125 NewTy = VectorType::getExtendedElementVectorType(VTy);
3126 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3127 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
3133 case IITDescriptor::TruncArgument: {
3134 // This may only be used when referring to a previous vector argument.
3135 if (D.getArgumentNumber() >= ArgTys.size())
3138 Type *NewTy = ArgTys[D.getArgumentNumber()];
3139 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3140 NewTy = VectorType::getTruncatedElementVectorType(VTy);
3141 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3142 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
3148 case IITDescriptor::HalfVecArgument:
3149 // This may only be used when referring to a previous vector argument.
3150 return D.getArgumentNumber() >= ArgTys.size() ||
3151 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
3152 VectorType::getHalfElementsVectorType(
3153 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
3154 case IITDescriptor::SameVecWidthArgument: {
3155 if (D.getArgumentNumber() >= ArgTys.size())
3157 VectorType * ReferenceType =
3158 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
3159 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
3160 if (!ThisArgType || !ReferenceType ||
3161 (ReferenceType->getVectorNumElements() !=
3162 ThisArgType->getVectorNumElements()))
3164 return VerifyIntrinsicType(ThisArgType->getVectorElementType(),
3167 case IITDescriptor::PtrToArgument: {
3168 if (D.getArgumentNumber() >= ArgTys.size())
3170 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
3171 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
3172 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
3174 case IITDescriptor::VecOfPtrsToElt: {
3175 if (D.getArgumentNumber() >= ArgTys.size())
3177 VectorType * ReferenceType =
3178 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
3179 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
3180 if (!ThisArgVecTy || !ReferenceType ||
3181 (ReferenceType->getVectorNumElements() !=
3182 ThisArgVecTy->getVectorNumElements()))
3184 PointerType *ThisArgEltTy =
3185 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
3188 return ThisArgEltTy->getElementType() !=
3189 ReferenceType->getVectorElementType();
3192 llvm_unreachable("unhandled");
3195 /// \brief Verify if the intrinsic has variable arguments.
3196 /// This method is intended to be called after all the fixed arguments have been
3199 /// This method returns true on error and does not print an error message.
3201 Verifier::VerifyIntrinsicIsVarArg(bool isVarArg,
3202 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
3203 using namespace Intrinsic;
3205 // If there are no descriptors left, then it can't be a vararg.
3209 // There should be only one descriptor remaining at this point.
3210 if (Infos.size() != 1)
3213 // Check and verify the descriptor.
3214 IITDescriptor D = Infos.front();
3215 Infos = Infos.slice(1);
3216 if (D.Kind == IITDescriptor::VarArg)
3222 /// Allow intrinsics to be verified in different ways.
3223 void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
3224 Function *IF = CS.getCalledFunction();
3225 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3228 // Verify that the intrinsic prototype lines up with what the .td files
3230 FunctionType *IFTy = IF->getFunctionType();
3231 bool IsVarArg = IFTy->isVarArg();
3233 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3234 getIntrinsicInfoTableEntries(ID, Table);
3235 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
3237 SmallVector<Type *, 4> ArgTys;
3238 Assert(!VerifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
3239 "Intrinsic has incorrect return type!", IF);
3240 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
3241 Assert(!VerifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
3242 "Intrinsic has incorrect argument type!", IF);
3244 // Verify if the intrinsic call matches the vararg property.
3246 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3247 "Intrinsic was not defined with variable arguments!", IF);
3249 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3250 "Callsite was not defined with variable arguments!", IF);
3252 // All descriptors should be absorbed by now.
3253 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
3255 // Now that we have the intrinsic ID and the actual argument types (and we
3256 // know they are legal for the intrinsic!) get the intrinsic name through the
3257 // usual means. This allows us to verify the mangling of argument types into
3259 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
3260 Assert(ExpectedName == IF->getName(),
3261 "Intrinsic name not mangled correctly for type arguments! "
3266 // If the intrinsic takes MDNode arguments, verify that they are either global
3267 // or are local to *this* function.
3268 for (Value *V : CS.args())
3269 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3270 visitMetadataAsValue(*MD, CS.getCaller());
3275 case Intrinsic::ctlz: // llvm.ctlz
3276 case Intrinsic::cttz: // llvm.cttz
3277 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3278 "is_zero_undef argument of bit counting intrinsics must be a "
3282 case Intrinsic::dbg_declare: // llvm.dbg.declare
3283 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3284 "invalid llvm.dbg.declare intrinsic call 1", CS);
3285 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
3287 case Intrinsic::dbg_value: // llvm.dbg.value
3288 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
3290 case Intrinsic::memcpy:
3291 case Intrinsic::memmove:
3292 case Intrinsic::memset: {
3293 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
3295 "alignment argument of memory intrinsics must be a constant int",
3297 const APInt &AlignVal = AlignCI->getValue();
3298 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
3299 "alignment argument of memory intrinsics must be a power of 2", CS);
3300 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
3301 "isvolatile argument of memory intrinsics must be a constant int",
3305 case Intrinsic::gcroot:
3306 case Intrinsic::gcwrite:
3307 case Intrinsic::gcread:
3308 if (ID == Intrinsic::gcroot) {
3310 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3311 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3312 Assert(isa<Constant>(CS.getArgOperand(1)),
3313 "llvm.gcroot parameter #2 must be a constant.", CS);
3314 if (!AI->getAllocatedType()->isPointerTy()) {
3315 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
3316 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3317 "or argument #2 must be a non-null constant.",
3322 Assert(CS.getParent()->getParent()->hasGC(),
3323 "Enclosing function does not use GC.", CS);
3325 case Intrinsic::init_trampoline:
3326 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
3327 "llvm.init_trampoline parameter #2 must resolve to a function.",
3330 case Intrinsic::prefetch:
3331 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
3332 isa<ConstantInt>(CS.getArgOperand(2)) &&
3333 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
3334 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
3335 "invalid arguments to llvm.prefetch", CS);
3337 case Intrinsic::stackprotector:
3338 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
3339 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
3341 case Intrinsic::lifetime_start:
3342 case Intrinsic::lifetime_end:
3343 case Intrinsic::invariant_start:
3344 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
3345 "size argument of memory use markers must be a constant integer",
3348 case Intrinsic::invariant_end:
3349 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3350 "llvm.invariant.end parameter #2 must be a constant integer", CS);
3353 case Intrinsic::localescape: {
3354 BasicBlock *BB = CS.getParent();
3355 Assert(BB == &BB->getParent()->front(),
3356 "llvm.localescape used outside of entry block", CS);
3357 Assert(!SawFrameEscape,
3358 "multiple calls to llvm.localescape in one function", CS);
3359 for (Value *Arg : CS.args()) {
3360 if (isa<ConstantPointerNull>(Arg))
3361 continue; // Null values are allowed as placeholders.
3362 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
3363 Assert(AI && AI->isStaticAlloca(),
3364 "llvm.localescape only accepts static allocas", CS);
3366 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
3367 SawFrameEscape = true;
3370 case Intrinsic::localrecover: {
3371 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
3372 Function *Fn = dyn_cast<Function>(FnArg);
3373 Assert(Fn && !Fn->isDeclaration(),
3374 "llvm.localrecover first "
3375 "argument must be function defined in this module",
3377 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
3378 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
3380 auto &Entry = FrameEscapeInfo[Fn];
3381 Entry.second = unsigned(
3382 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
3386 case Intrinsic::experimental_gc_statepoint:
3387 Assert(!CS.isInlineAsm(),
3388 "gc.statepoint support for inline assembly unimplemented", CS);
3389 Assert(CS.getParent()->getParent()->hasGC(),
3390 "Enclosing function does not use GC.", CS);
3392 VerifyStatepoint(CS);
3394 case Intrinsic::experimental_gc_result_int:
3395 case Intrinsic::experimental_gc_result_float:
3396 case Intrinsic::experimental_gc_result_ptr:
3397 case Intrinsic::experimental_gc_result: {
3398 Assert(CS.getParent()->getParent()->hasGC(),
3399 "Enclosing function does not use GC.", CS);
3400 // Are we tied to a statepoint properly?
3401 CallSite StatepointCS(CS.getArgOperand(0));
3402 const Function *StatepointFn =
3403 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
3404 Assert(StatepointFn && StatepointFn->isDeclaration() &&
3405 StatepointFn->getIntrinsicID() ==
3406 Intrinsic::experimental_gc_statepoint,
3407 "gc.result operand #1 must be from a statepoint", CS,
3408 CS.getArgOperand(0));
3410 // Assert that result type matches wrapped callee.
3411 const Value *Target = StatepointCS.getArgument(2);
3412 const PointerType *PT = cast<PointerType>(Target->getType());
3413 const FunctionType *TargetFuncType =
3414 cast<FunctionType>(PT->getElementType());
3415 Assert(CS.getType() == TargetFuncType->getReturnType(),
3416 "gc.result result type does not match wrapped callee", CS);
3419 case Intrinsic::experimental_gc_relocate: {
3420 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
3422 // Check that this relocate is correctly tied to the statepoint
3424 // This is case for relocate on the unwinding path of an invoke statepoint
3425 if (ExtractValueInst *ExtractValue =
3426 dyn_cast<ExtractValueInst>(CS.getArgOperand(0))) {
3427 Assert(isa<LandingPadInst>(ExtractValue->getAggregateOperand()),
3428 "gc relocate on unwind path incorrectly linked to the statepoint",
3431 const BasicBlock *InvokeBB =
3432 ExtractValue->getParent()->getUniquePredecessor();
3434 // Landingpad relocates should have only one predecessor with invoke
3435 // statepoint terminator
3436 Assert(InvokeBB, "safepoints should have unique landingpads",
3437 ExtractValue->getParent());
3438 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
3440 Assert(isStatepoint(InvokeBB->getTerminator()),
3441 "gc relocate should be linked to a statepoint", InvokeBB);
3444 // In all other cases relocate should be tied to the statepoint directly.
3445 // This covers relocates on a normal return path of invoke statepoint and
3446 // relocates of a call statepoint
3447 auto Token = CS.getArgOperand(0);
3448 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
3449 "gc relocate is incorrectly tied to the statepoint", CS, Token);
3452 // Verify rest of the relocate arguments
3454 GCRelocateOperands Ops(CS);
3455 ImmutableCallSite StatepointCS(Ops.getStatepoint());
3457 // Both the base and derived must be piped through the safepoint
3458 Value* Base = CS.getArgOperand(1);
3459 Assert(isa<ConstantInt>(Base),
3460 "gc.relocate operand #2 must be integer offset", CS);
3462 Value* Derived = CS.getArgOperand(2);
3463 Assert(isa<ConstantInt>(Derived),
3464 "gc.relocate operand #3 must be integer offset", CS);
3466 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
3467 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
3469 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
3470 "gc.relocate: statepoint base index out of bounds", CS);
3471 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
3472 "gc.relocate: statepoint derived index out of bounds", CS);
3474 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
3475 // section of the statepoint's argument
3476 Assert(StatepointCS.arg_size() > 0,
3477 "gc.statepoint: insufficient arguments");
3478 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
3479 "gc.statement: number of call arguments must be constant integer");
3480 const unsigned NumCallArgs =
3481 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
3482 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
3483 "gc.statepoint: mismatch in number of call arguments");
3484 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
3485 "gc.statepoint: number of transition arguments must be "
3486 "a constant integer");
3487 const int NumTransitionArgs =
3488 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
3490 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
3491 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
3492 "gc.statepoint: number of deoptimization arguments must be "
3493 "a constant integer");
3494 const int NumDeoptArgs =
3495 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))->getZExtValue();
3496 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
3497 const int GCParamArgsEnd = StatepointCS.arg_size();
3498 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
3499 "gc.relocate: statepoint base index doesn't fall within the "
3500 "'gc parameters' section of the statepoint call",
3502 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
3503 "gc.relocate: statepoint derived index doesn't fall within the "
3504 "'gc parameters' section of the statepoint call",
3507 // Relocated value must be a pointer type, but gc_relocate does not need to return the
3508 // same pointer type as the relocated pointer. It can be casted to the correct type later
3509 // if it's desired. However, they must have the same address space.
3510 GCRelocateOperands Operands(CS);
3511 Assert(Operands.getDerivedPtr()->getType()->isPointerTy(),
3512 "gc.relocate: relocated value must be a gc pointer", CS);
3514 // gc_relocate return type must be a pointer type, and is verified earlier in
3515 // VerifyIntrinsicType().
3516 Assert(cast<PointerType>(CS.getType())->getAddressSpace() ==
3517 cast<PointerType>(Operands.getDerivedPtr()->getType())->getAddressSpace(),
3518 "gc.relocate: relocating a pointer shouldn't change its address space", CS);
3524 /// \brief Carefully grab the subprogram from a local scope.
3526 /// This carefully grabs the subprogram from a local scope, avoiding the
3527 /// built-in assertions that would typically fire.
3528 static DISubprogram *getSubprogram(Metadata *LocalScope) {
3532 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
3535 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
3536 return getSubprogram(LB->getRawScope());
3538 // Just return null; broken scope chains are checked elsewhere.
3539 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
3543 template <class DbgIntrinsicTy>
3544 void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
3545 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
3546 Assert(isa<ValueAsMetadata>(MD) ||
3547 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
3548 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
3549 Assert(isa<DILocalVariable>(DII.getRawVariable()),
3550 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
3551 DII.getRawVariable());
3552 Assert(isa<DIExpression>(DII.getRawExpression()),
3553 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
3554 DII.getRawExpression());
3556 // Ignore broken !dbg attachments; they're checked elsewhere.
3557 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
3558 if (!isa<DILocation>(N))
3561 BasicBlock *BB = DII.getParent();
3562 Function *F = BB ? BB->getParent() : nullptr;
3564 // The scopes for variables and !dbg attachments must agree.
3565 DILocalVariable *Var = DII.getVariable();
3566 DILocation *Loc = DII.getDebugLoc();
3567 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
3570 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
3571 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
3572 if (!VarSP || !LocSP)
3573 return; // Broken scope chains are checked elsewhere.
3575 Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
3576 " variable and !dbg attachment",
3577 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
3578 Loc->getScope()->getSubprogram());
3581 template <class MapTy>
3582 static uint64_t getVariableSize(const DILocalVariable &V, const MapTy &Map) {
3583 // Be careful of broken types (checked elsewhere).
3584 const Metadata *RawType = V.getRawType();
3586 // Try to get the size directly.
3587 if (auto *T = dyn_cast<DIType>(RawType))
3588 if (uint64_t Size = T->getSizeInBits())
3591 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
3592 // Look at the base type.
3593 RawType = DT->getRawBaseType();
3597 if (auto *S = dyn_cast<MDString>(RawType)) {
3598 // Don't error on missing types (checked elsewhere).
3599 RawType = Map.lookup(S);
3603 // Missing type or size.
3611 template <class MapTy>
3612 void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I,
3613 const MapTy &TypeRefs) {
3616 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
3617 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
3618 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
3620 auto *DDI = cast<DbgDeclareInst>(&I);
3621 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
3622 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
3625 // We don't know whether this intrinsic verified correctly.
3626 if (!V || !E || !E->isValid())
3629 // Nothing to do if this isn't a bit piece expression.
3630 if (!E->isBitPiece())
3633 // The frontend helps out GDB by emitting the members of local anonymous
3634 // unions as artificial local variables with shared storage. When SROA splits
3635 // the storage for artificial local variables that are smaller than the entire
3636 // union, the overhang piece will be outside of the allotted space for the
3637 // variable and this check fails.
3638 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
3639 if (V->isArtificial())
3642 // If there's no size, the type is broken, but that should be checked
3644 uint64_t VarSize = getVariableSize(*V, TypeRefs);
3648 unsigned PieceSize = E->getBitPieceSize();
3649 unsigned PieceOffset = E->getBitPieceOffset();
3650 Assert(PieceSize + PieceOffset <= VarSize,
3651 "piece is larger than or outside of variable", &I, V, E);
3652 Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
3655 void Verifier::visitUnresolvedTypeRef(const MDString *S, const MDNode *N) {
3656 // This is in its own function so we get an error for each bad type ref (not
3658 Assert(false, "unresolved type ref", S, N);
3661 void Verifier::verifyTypeRefs() {
3662 auto *CUs = M->getNamedMetadata("llvm.dbg.cu");
3666 // Visit all the compile units again to map the type references.
3667 SmallDenseMap<const MDString *, const DIType *, 32> TypeRefs;
3668 for (auto *CU : CUs->operands())
3669 if (auto Ts = cast<DICompileUnit>(CU)->getRetainedTypes())
3670 for (DIType *Op : Ts)
3671 if (auto *T = dyn_cast<DICompositeType>(Op))
3672 if (auto *S = T->getRawIdentifier()) {
3673 UnresolvedTypeRefs.erase(S);
3674 TypeRefs.insert(std::make_pair(S, T));
3677 // Verify debug info intrinsic bit piece expressions. This needs a second
3678 // pass through the intructions, since we haven't built TypeRefs yet when
3679 // verifying functions, and simply queuing the DbgInfoIntrinsics to evaluate
3680 // later/now would queue up some that could be later deleted.
3681 for (const Function &F : *M)
3682 for (const BasicBlock &BB : F)
3683 for (const Instruction &I : BB)
3684 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
3685 verifyBitPieceExpression(*DII, TypeRefs);
3687 // Return early if all typerefs were resolved.
3688 if (UnresolvedTypeRefs.empty())
3691 // Sort the unresolved references by name so the output is deterministic.
3692 typedef std::pair<const MDString *, const MDNode *> TypeRef;
3693 SmallVector<TypeRef, 32> Unresolved(UnresolvedTypeRefs.begin(),
3694 UnresolvedTypeRefs.end());
3695 std::sort(Unresolved.begin(), Unresolved.end(),
3696 [](const TypeRef &LHS, const TypeRef &RHS) {
3697 return LHS.first->getString() < RHS.first->getString();
3700 // Visit the unresolved refs (printing out the errors).
3701 for (const TypeRef &TR : Unresolved)
3702 visitUnresolvedTypeRef(TR.first, TR.second);
3705 //===----------------------------------------------------------------------===//
3706 // Implement the public interfaces to this file...
3707 //===----------------------------------------------------------------------===//
3709 bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
3710 Function &F = const_cast<Function &>(f);
3711 assert(!F.isDeclaration() && "Cannot verify external functions");
3713 raw_null_ostream NullStr;
3714 Verifier V(OS ? *OS : NullStr);
3716 // Note that this function's return value is inverted from what you would
3717 // expect of a function called "verify".
3718 return !V.verify(F);
3721 bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
3722 raw_null_ostream NullStr;
3723 Verifier V(OS ? *OS : NullStr);
3725 bool Broken = false;
3726 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
3727 if (!I->isDeclaration() && !I->isMaterializable())
3728 Broken |= !V.verify(*I);
3730 // Note that this function's return value is inverted from what you would
3731 // expect of a function called "verify".
3732 return !V.verify(M) || Broken;
3736 struct VerifierLegacyPass : public FunctionPass {
3742 VerifierLegacyPass() : FunctionPass(ID), V(dbgs()), FatalErrors(true) {
3743 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3745 explicit VerifierLegacyPass(bool FatalErrors)
3746 : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
3747 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3750 bool runOnFunction(Function &F) override {
3751 if (!V.verify(F) && FatalErrors)
3752 report_fatal_error("Broken function found, compilation aborted!");
3757 bool doFinalization(Module &M) override {
3758 if (!V.verify(M) && FatalErrors)
3759 report_fatal_error("Broken module found, compilation aborted!");
3764 void getAnalysisUsage(AnalysisUsage &AU) const override {
3765 AU.setPreservesAll();
3770 char VerifierLegacyPass::ID = 0;
3771 INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
3773 FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
3774 return new VerifierLegacyPass(FatalErrors);
3777 PreservedAnalyses VerifierPass::run(Module &M) {
3778 if (verifyModule(M, &dbgs()) && FatalErrors)
3779 report_fatal_error("Broken module found, compilation aborted!");
3781 return PreservedAnalyses::all();
3784 PreservedAnalyses VerifierPass::run(Function &F) {
3785 if (verifyFunction(F, &dbgs()) && FatalErrors)
3786 report_fatal_error("Broken function found, compilation aborted!");
3788 return PreservedAnalyses::all();