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 The result type for a catchpad.
188 Type *CatchPadResultTy;
190 /// \brief The result type for a cleanuppad.
191 Type *CleanupPadResultTy;
193 /// \brief The result type for a landingpad.
194 Type *LandingPadResultTy;
196 /// \brief Whether we've seen a call to @llvm.localescape in this function
200 /// Stores the count of how many objects were passed to llvm.localescape for a
201 /// given function and the largest index passed to llvm.localrecover.
202 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
205 explicit Verifier(raw_ostream &OS)
206 : VerifierSupport(OS), Context(nullptr), CatchPadResultTy(nullptr),
207 CleanupPadResultTy(nullptr), LandingPadResultTy(nullptr),
208 SawFrameEscape(false) {}
210 bool verify(const Function &F) {
212 Context = &M->getContext();
214 // First ensure the function is well-enough formed to compute dominance
217 OS << "Function '" << F.getName()
218 << "' does not contain an entry block!\n";
221 for (Function::const_iterator I = F.begin(), E = F.end(); I != E; ++I) {
222 if (I->empty() || !I->back().isTerminator()) {
223 OS << "Basic Block in function '" << F.getName()
224 << "' does not have terminator!\n";
225 I->printAsOperand(OS, true);
231 // Now directly compute a dominance tree. We don't rely on the pass
232 // manager to provide this as it isolates us from a potentially
233 // out-of-date dominator tree and makes it significantly more complex to
234 // run this code outside of a pass manager.
235 // FIXME: It's really gross that we have to cast away constness here.
236 DT.recalculate(const_cast<Function &>(F));
239 // FIXME: We strip const here because the inst visitor strips const.
240 visit(const_cast<Function &>(F));
241 InstsInThisBlock.clear();
242 CatchPadResultTy = nullptr;
243 CleanupPadResultTy = nullptr;
244 LandingPadResultTy = nullptr;
245 SawFrameEscape = false;
250 bool verify(const Module &M) {
252 Context = &M.getContext();
255 // Scan through, checking all of the external function's linkage now...
256 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
257 visitGlobalValue(*I);
259 // Check to make sure function prototypes are okay.
260 if (I->isDeclaration())
264 // Now that we've visited every function, verify that we never asked to
265 // recover a frame index that wasn't escaped.
266 verifyFrameRecoverIndices();
268 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
270 visitGlobalVariable(*I);
272 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
274 visitGlobalAlias(*I);
276 for (Module::const_named_metadata_iterator I = M.named_metadata_begin(),
277 E = M.named_metadata_end();
279 visitNamedMDNode(*I);
281 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
282 visitComdat(SMEC.getValue());
285 visitModuleIdents(M);
287 // Verify type referneces last.
294 // Verification methods...
295 void visitGlobalValue(const GlobalValue &GV);
296 void visitGlobalVariable(const GlobalVariable &GV);
297 void visitGlobalAlias(const GlobalAlias &GA);
298 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
299 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
300 const GlobalAlias &A, const Constant &C);
301 void visitNamedMDNode(const NamedMDNode &NMD);
302 void visitMDNode(const MDNode &MD);
303 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
304 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
305 void visitComdat(const Comdat &C);
306 void visitModuleIdents(const Module &M);
307 void visitModuleFlags(const Module &M);
308 void visitModuleFlag(const MDNode *Op,
309 DenseMap<const MDString *, const MDNode *> &SeenIDs,
310 SmallVectorImpl<const MDNode *> &Requirements);
311 void visitFunction(const Function &F);
312 void visitBasicBlock(BasicBlock &BB);
313 void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty);
315 template <class Ty> bool isValidMetadataArray(const MDTuple &N);
316 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
317 #include "llvm/IR/Metadata.def"
318 void visitDIScope(const DIScope &N);
319 void visitDIVariable(const DIVariable &N);
320 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
321 void visitDITemplateParameter(const DITemplateParameter &N);
323 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
325 /// \brief Check for a valid string-based type reference.
327 /// Checks if \c MD is a string-based type reference. If it is, keeps track
328 /// of it (and its user, \c N) for error messages later.
329 bool isValidUUID(const MDNode &N, const Metadata *MD);
331 /// \brief Check for a valid type reference.
333 /// Checks for subclasses of \a DIType, or \a isValidUUID().
334 bool isTypeRef(const MDNode &N, const Metadata *MD);
336 /// \brief Check for a valid scope reference.
338 /// Checks for subclasses of \a DIScope, or \a isValidUUID().
339 bool isScopeRef(const MDNode &N, const Metadata *MD);
341 /// \brief Check for a valid debug info reference.
343 /// Checks for subclasses of \a DINode, or \a isValidUUID().
344 bool isDIRef(const MDNode &N, const Metadata *MD);
346 // InstVisitor overrides...
347 using InstVisitor<Verifier>::visit;
348 void visit(Instruction &I);
350 void visitTruncInst(TruncInst &I);
351 void visitZExtInst(ZExtInst &I);
352 void visitSExtInst(SExtInst &I);
353 void visitFPTruncInst(FPTruncInst &I);
354 void visitFPExtInst(FPExtInst &I);
355 void visitFPToUIInst(FPToUIInst &I);
356 void visitFPToSIInst(FPToSIInst &I);
357 void visitUIToFPInst(UIToFPInst &I);
358 void visitSIToFPInst(SIToFPInst &I);
359 void visitIntToPtrInst(IntToPtrInst &I);
360 void visitPtrToIntInst(PtrToIntInst &I);
361 void visitBitCastInst(BitCastInst &I);
362 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
363 void visitPHINode(PHINode &PN);
364 void visitBinaryOperator(BinaryOperator &B);
365 void visitICmpInst(ICmpInst &IC);
366 void visitFCmpInst(FCmpInst &FC);
367 void visitExtractElementInst(ExtractElementInst &EI);
368 void visitInsertElementInst(InsertElementInst &EI);
369 void visitShuffleVectorInst(ShuffleVectorInst &EI);
370 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
371 void visitCallInst(CallInst &CI);
372 void visitInvokeInst(InvokeInst &II);
373 void visitGetElementPtrInst(GetElementPtrInst &GEP);
374 void visitLoadInst(LoadInst &LI);
375 void visitStoreInst(StoreInst &SI);
376 void verifyDominatesUse(Instruction &I, unsigned i);
377 void visitInstruction(Instruction &I);
378 void visitTerminatorInst(TerminatorInst &I);
379 void visitBranchInst(BranchInst &BI);
380 void visitReturnInst(ReturnInst &RI);
381 void visitSwitchInst(SwitchInst &SI);
382 void visitIndirectBrInst(IndirectBrInst &BI);
383 void visitSelectInst(SelectInst &SI);
384 void visitUserOp1(Instruction &I);
385 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
386 void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS);
387 template <class DbgIntrinsicTy>
388 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
389 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
390 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
391 void visitFenceInst(FenceInst &FI);
392 void visitAllocaInst(AllocaInst &AI);
393 void visitExtractValueInst(ExtractValueInst &EVI);
394 void visitInsertValueInst(InsertValueInst &IVI);
395 void visitLandingPadInst(LandingPadInst &LPI);
396 void visitCatchPadInst(CatchPadInst &CPI);
397 void visitCatchEndPadInst(CatchEndPadInst &CEPI);
398 void visitCleanupPadInst(CleanupPadInst &CPI);
399 void visitCleanupReturnInst(CleanupReturnInst &CRI);
400 void visitTerminatePadInst(TerminatePadInst &TPI);
402 void VerifyCallSite(CallSite CS);
403 void verifyMustTailCall(CallInst &CI);
404 bool PerformTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
405 unsigned ArgNo, std::string &Suffix);
406 bool VerifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
407 SmallVectorImpl<Type *> &ArgTys);
408 bool VerifyIntrinsicIsVarArg(bool isVarArg,
409 ArrayRef<Intrinsic::IITDescriptor> &Infos);
410 bool VerifyAttributeCount(AttributeSet Attrs, unsigned Params);
411 void VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
413 void VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
414 bool isReturnValue, const Value *V);
415 void VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
417 void VerifyFunctionMetadata(
418 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs);
420 void VerifyConstantExprBitcastType(const ConstantExpr *CE);
421 void VerifyStatepoint(ImmutableCallSite CS);
422 void verifyFrameRecoverIndices();
424 // Module-level debug info verification...
425 void verifyTypeRefs();
426 template <class MapTy>
427 void verifyBitPieceExpression(const DbgInfoIntrinsic &I,
428 const MapTy &TypeRefs);
429 void visitUnresolvedTypeRef(const MDString *S, const MDNode *N);
431 } // End anonymous namespace
433 // Assert - We know that cond should be true, if not print an error message.
434 #define Assert(C, ...) \
435 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
437 void Verifier::visit(Instruction &I) {
438 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
439 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
440 InstVisitor<Verifier>::visit(I);
444 void Verifier::visitGlobalValue(const GlobalValue &GV) {
445 Assert(!GV.isDeclaration() || GV.hasExternalLinkage() ||
446 GV.hasExternalWeakLinkage(),
447 "Global is external, but doesn't have external or weak linkage!", &GV);
449 Assert(GV.getAlignment() <= Value::MaximumAlignment,
450 "huge alignment values are unsupported", &GV);
451 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
452 "Only global variables can have appending linkage!", &GV);
454 if (GV.hasAppendingLinkage()) {
455 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
456 Assert(GVar && GVar->getValueType()->isArrayTy(),
457 "Only global arrays can have appending linkage!", GVar);
460 if (GV.isDeclarationForLinker())
461 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
464 void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
465 if (GV.hasInitializer()) {
466 Assert(GV.getInitializer()->getType() == GV.getType()->getElementType(),
467 "Global variable initializer type does not match global "
471 // If the global has common linkage, it must have a zero initializer and
472 // cannot be constant.
473 if (GV.hasCommonLinkage()) {
474 Assert(GV.getInitializer()->isNullValue(),
475 "'common' global must have a zero initializer!", &GV);
476 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
478 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
481 Assert(GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
482 "invalid linkage type for global declaration", &GV);
485 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
486 GV.getName() == "llvm.global_dtors")) {
487 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
488 "invalid linkage for intrinsic global variable", &GV);
489 // Don't worry about emitting an error for it not being an array,
490 // visitGlobalValue will complain on appending non-array.
491 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
492 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
493 PointerType *FuncPtrTy =
494 FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
495 // FIXME: Reject the 2-field form in LLVM 4.0.
497 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
498 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
499 STy->getTypeAtIndex(1) == FuncPtrTy,
500 "wrong type for intrinsic global variable", &GV);
501 if (STy->getNumElements() == 3) {
502 Type *ETy = STy->getTypeAtIndex(2);
503 Assert(ETy->isPointerTy() &&
504 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
505 "wrong type for intrinsic global variable", &GV);
510 if (GV.hasName() && (GV.getName() == "llvm.used" ||
511 GV.getName() == "llvm.compiler.used")) {
512 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
513 "invalid linkage for intrinsic global variable", &GV);
514 Type *GVType = GV.getValueType();
515 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
516 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
517 Assert(PTy, "wrong type for intrinsic global variable", &GV);
518 if (GV.hasInitializer()) {
519 const Constant *Init = GV.getInitializer();
520 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
521 Assert(InitArray, "wrong initalizer for intrinsic global variable",
523 for (unsigned i = 0, e = InitArray->getNumOperands(); i != e; ++i) {
524 Value *V = Init->getOperand(i)->stripPointerCastsNoFollowAliases();
525 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
527 "invalid llvm.used member", V);
528 Assert(V->hasName(), "members of llvm.used must be named", V);
534 Assert(!GV.hasDLLImportStorageClass() ||
535 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
536 GV.hasAvailableExternallyLinkage(),
537 "Global is marked as dllimport, but not external", &GV);
539 if (!GV.hasInitializer()) {
540 visitGlobalValue(GV);
544 // Walk any aggregate initializers looking for bitcasts between address spaces
545 SmallPtrSet<const Value *, 4> Visited;
546 SmallVector<const Value *, 4> WorkStack;
547 WorkStack.push_back(cast<Value>(GV.getInitializer()));
549 while (!WorkStack.empty()) {
550 const Value *V = WorkStack.pop_back_val();
551 if (!Visited.insert(V).second)
554 if (const User *U = dyn_cast<User>(V)) {
555 WorkStack.append(U->op_begin(), U->op_end());
558 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
559 VerifyConstantExprBitcastType(CE);
565 visitGlobalValue(GV);
568 void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
569 SmallPtrSet<const GlobalAlias*, 4> Visited;
571 visitAliaseeSubExpr(Visited, GA, C);
574 void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
575 const GlobalAlias &GA, const Constant &C) {
576 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
577 Assert(!GV->isDeclaration(), "Alias must point to a definition", &GA);
579 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
580 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
582 Assert(!GA2->mayBeOverridden(), "Alias cannot point to a weak alias",
585 // Only continue verifying subexpressions of GlobalAliases.
586 // Do not recurse into global initializers.
591 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
592 VerifyConstantExprBitcastType(CE);
594 for (const Use &U : C.operands()) {
596 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
597 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
598 else if (const auto *C2 = dyn_cast<Constant>(V))
599 visitAliaseeSubExpr(Visited, GA, *C2);
603 void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
604 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
605 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
606 "weak_odr, or external linkage!",
608 const Constant *Aliasee = GA.getAliasee();
609 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
610 Assert(GA.getType() == Aliasee->getType(),
611 "Alias and aliasee types should match!", &GA);
613 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
614 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
616 visitAliaseeSubExpr(GA, *Aliasee);
618 visitGlobalValue(GA);
621 void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
622 for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i) {
623 MDNode *MD = NMD.getOperand(i);
625 if (NMD.getName() == "llvm.dbg.cu") {
626 Assert(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
636 void Verifier::visitMDNode(const MDNode &MD) {
637 // Only visit each node once. Metadata can be mutually recursive, so this
638 // avoids infinite recursion here, as well as being an optimization.
639 if (!MDNodes.insert(&MD).second)
642 switch (MD.getMetadataID()) {
644 llvm_unreachable("Invalid MDNode subclass");
645 case Metadata::MDTupleKind:
647 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
648 case Metadata::CLASS##Kind: \
649 visit##CLASS(cast<CLASS>(MD)); \
651 #include "llvm/IR/Metadata.def"
654 for (unsigned i = 0, e = MD.getNumOperands(); i != e; ++i) {
655 Metadata *Op = MD.getOperand(i);
658 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
660 if (auto *N = dyn_cast<MDNode>(Op)) {
664 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
665 visitValueAsMetadata(*V, nullptr);
670 // Check these last, so we diagnose problems in operands first.
671 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
672 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
675 void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
676 Assert(MD.getValue(), "Expected valid value", &MD);
677 Assert(!MD.getValue()->getType()->isMetadataTy(),
678 "Unexpected metadata round-trip through values", &MD, MD.getValue());
680 auto *L = dyn_cast<LocalAsMetadata>(&MD);
684 Assert(F, "function-local metadata used outside a function", L);
686 // If this was an instruction, bb, or argument, verify that it is in the
687 // function that we expect.
688 Function *ActualF = nullptr;
689 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
690 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
691 ActualF = I->getParent()->getParent();
692 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
693 ActualF = BB->getParent();
694 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
695 ActualF = A->getParent();
696 assert(ActualF && "Unimplemented function local metadata case!");
698 Assert(ActualF == F, "function-local metadata used in wrong function", L);
701 void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
702 Metadata *MD = MDV.getMetadata();
703 if (auto *N = dyn_cast<MDNode>(MD)) {
708 // Only visit each node once. Metadata can be mutually recursive, so this
709 // avoids infinite recursion here, as well as being an optimization.
710 if (!MDNodes.insert(MD).second)
713 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
714 visitValueAsMetadata(*V, F);
717 bool Verifier::isValidUUID(const MDNode &N, const Metadata *MD) {
718 auto *S = dyn_cast<MDString>(MD);
721 if (S->getString().empty())
724 // Keep track of names of types referenced via UUID so we can check that they
726 UnresolvedTypeRefs.insert(std::make_pair(S, &N));
730 /// \brief Check if a value can be a reference to a type.
731 bool Verifier::isTypeRef(const MDNode &N, const Metadata *MD) {
732 return !MD || isValidUUID(N, MD) || isa<DIType>(MD);
735 /// \brief Check if a value can be a ScopeRef.
736 bool Verifier::isScopeRef(const MDNode &N, const Metadata *MD) {
737 return !MD || isValidUUID(N, MD) || isa<DIScope>(MD);
740 /// \brief Check if a value can be a debug info ref.
741 bool Verifier::isDIRef(const MDNode &N, const Metadata *MD) {
742 return !MD || isValidUUID(N, MD) || isa<DINode>(MD);
746 bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
747 for (Metadata *MD : N.operands()) {
760 bool isValidMetadataArray(const MDTuple &N) {
761 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
765 bool isValidMetadataNullArray(const MDTuple &N) {
766 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
769 void Verifier::visitDILocation(const DILocation &N) {
770 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
771 "location requires a valid scope", &N, N.getRawScope());
772 if (auto *IA = N.getRawInlinedAt())
773 Assert(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
776 void Verifier::visitGenericDINode(const GenericDINode &N) {
777 Assert(N.getTag(), "invalid tag", &N);
780 void Verifier::visitDIScope(const DIScope &N) {
781 if (auto *F = N.getRawFile())
782 Assert(isa<DIFile>(F), "invalid file", &N, F);
785 void Verifier::visitDISubrange(const DISubrange &N) {
786 Assert(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
787 Assert(N.getCount() >= -1, "invalid subrange count", &N);
790 void Verifier::visitDIEnumerator(const DIEnumerator &N) {
791 Assert(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
794 void Verifier::visitDIBasicType(const DIBasicType &N) {
795 Assert(N.getTag() == dwarf::DW_TAG_base_type ||
796 N.getTag() == dwarf::DW_TAG_unspecified_type,
800 void Verifier::visitDIDerivedType(const DIDerivedType &N) {
801 // Common scope checks.
804 Assert(N.getTag() == dwarf::DW_TAG_typedef ||
805 N.getTag() == dwarf::DW_TAG_pointer_type ||
806 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
807 N.getTag() == dwarf::DW_TAG_reference_type ||
808 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
809 N.getTag() == dwarf::DW_TAG_const_type ||
810 N.getTag() == dwarf::DW_TAG_volatile_type ||
811 N.getTag() == dwarf::DW_TAG_restrict_type ||
812 N.getTag() == dwarf::DW_TAG_member ||
813 N.getTag() == dwarf::DW_TAG_inheritance ||
814 N.getTag() == dwarf::DW_TAG_friend,
816 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
817 Assert(isTypeRef(N, N.getExtraData()), "invalid pointer to member type", &N,
821 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
822 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
826 static bool hasConflictingReferenceFlags(unsigned Flags) {
827 return (Flags & DINode::FlagLValueReference) &&
828 (Flags & DINode::FlagRValueReference);
831 void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
832 auto *Params = dyn_cast<MDTuple>(&RawParams);
833 Assert(Params, "invalid template params", &N, &RawParams);
834 for (Metadata *Op : Params->operands()) {
835 Assert(Op && isa<DITemplateParameter>(Op), "invalid template parameter", &N,
840 void Verifier::visitDICompositeType(const DICompositeType &N) {
841 // Common scope checks.
844 Assert(N.getTag() == dwarf::DW_TAG_array_type ||
845 N.getTag() == dwarf::DW_TAG_structure_type ||
846 N.getTag() == dwarf::DW_TAG_union_type ||
847 N.getTag() == dwarf::DW_TAG_enumeration_type ||
848 N.getTag() == dwarf::DW_TAG_class_type,
851 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
852 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
855 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
856 "invalid composite elements", &N, N.getRawElements());
857 Assert(isTypeRef(N, N.getRawVTableHolder()), "invalid vtable holder", &N,
858 N.getRawVTableHolder());
859 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
860 "invalid composite elements", &N, N.getRawElements());
861 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
863 if (auto *Params = N.getRawTemplateParams())
864 visitTemplateParams(N, *Params);
866 if (N.getTag() == dwarf::DW_TAG_class_type ||
867 N.getTag() == dwarf::DW_TAG_union_type) {
868 Assert(N.getFile() && !N.getFile()->getFilename().empty(),
869 "class/union requires a filename", &N, N.getFile());
873 void Verifier::visitDISubroutineType(const DISubroutineType &N) {
874 Assert(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
875 if (auto *Types = N.getRawTypeArray()) {
876 Assert(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
877 for (Metadata *Ty : N.getTypeArray()->operands()) {
878 Assert(isTypeRef(N, Ty), "invalid subroutine type ref", &N, Types, Ty);
881 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
885 void Verifier::visitDIFile(const DIFile &N) {
886 Assert(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
889 void Verifier::visitDICompileUnit(const DICompileUnit &N) {
890 Assert(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
892 // Don't bother verifying the compilation directory or producer string
893 // as those could be empty.
894 Assert(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
896 Assert(!N.getFile()->getFilename().empty(), "invalid filename", &N,
899 if (auto *Array = N.getRawEnumTypes()) {
900 Assert(isa<MDTuple>(Array), "invalid enum list", &N, Array);
901 for (Metadata *Op : N.getEnumTypes()->operands()) {
902 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
903 Assert(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
904 "invalid enum type", &N, N.getEnumTypes(), Op);
907 if (auto *Array = N.getRawRetainedTypes()) {
908 Assert(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
909 for (Metadata *Op : N.getRetainedTypes()->operands()) {
910 Assert(Op && isa<DIType>(Op), "invalid retained type", &N, Op);
913 if (auto *Array = N.getRawSubprograms()) {
914 Assert(isa<MDTuple>(Array), "invalid subprogram list", &N, Array);
915 for (Metadata *Op : N.getSubprograms()->operands()) {
916 Assert(Op && isa<DISubprogram>(Op), "invalid subprogram ref", &N, Op);
919 if (auto *Array = N.getRawGlobalVariables()) {
920 Assert(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
921 for (Metadata *Op : N.getGlobalVariables()->operands()) {
922 Assert(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref", &N,
926 if (auto *Array = N.getRawImportedEntities()) {
927 Assert(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
928 for (Metadata *Op : N.getImportedEntities()->operands()) {
929 Assert(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref", &N,
935 void Verifier::visitDISubprogram(const DISubprogram &N) {
936 Assert(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
937 Assert(isScopeRef(N, N.getRawScope()), "invalid scope", &N, N.getRawScope());
938 if (auto *T = N.getRawType())
939 Assert(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
940 Assert(isTypeRef(N, N.getRawContainingType()), "invalid containing type", &N,
941 N.getRawContainingType());
942 if (auto *RawF = N.getRawFunction()) {
943 auto *FMD = dyn_cast<ConstantAsMetadata>(RawF);
944 auto *F = FMD ? FMD->getValue() : nullptr;
945 auto *FT = F ? dyn_cast<PointerType>(F->getType()) : nullptr;
946 Assert(F && FT && isa<FunctionType>(FT->getElementType()),
947 "invalid function", &N, F, FT);
949 if (auto *Params = N.getRawTemplateParams())
950 visitTemplateParams(N, *Params);
951 if (auto *S = N.getRawDeclaration()) {
952 Assert(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
953 "invalid subprogram declaration", &N, S);
955 if (auto *RawVars = N.getRawVariables()) {
956 auto *Vars = dyn_cast<MDTuple>(RawVars);
957 Assert(Vars, "invalid variable list", &N, RawVars);
958 for (Metadata *Op : Vars->operands()) {
959 Assert(Op && isa<DILocalVariable>(Op), "invalid local variable", &N, Vars,
963 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
966 auto *F = N.getFunction();
970 // Check that all !dbg attachments lead to back to N (or, at least, another
971 // subprogram that describes the same function).
973 // FIXME: Check this incrementally while visiting !dbg attachments.
974 // FIXME: Only check when N is the canonical subprogram for F.
975 SmallPtrSet<const MDNode *, 32> Seen;
978 // Be careful about using DILocation here since we might be dealing with
979 // broken code (this is the Verifier after all).
981 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
984 if (!Seen.insert(DL).second)
987 DILocalScope *Scope = DL->getInlinedAtScope();
988 if (Scope && !Seen.insert(Scope).second)
991 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
992 if (SP && !Seen.insert(SP).second)
995 // FIXME: Once N is canonical, check "SP == &N".
996 Assert(SP->describes(F),
997 "!dbg attachment points at wrong subprogram for function", &N, F,
1002 void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
1003 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
1004 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1005 "invalid local scope", &N, N.getRawScope());
1008 void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1009 visitDILexicalBlockBase(N);
1011 Assert(N.getLine() || !N.getColumn(),
1012 "cannot have column info without line info", &N);
1015 void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1016 visitDILexicalBlockBase(N);
1019 void Verifier::visitDINamespace(const DINamespace &N) {
1020 Assert(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
1021 if (auto *S = N.getRawScope())
1022 Assert(isa<DIScope>(S), "invalid scope ref", &N, S);
1025 void Verifier::visitDIModule(const DIModule &N) {
1026 Assert(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1027 Assert(!N.getName().empty(), "anonymous module", &N);
1030 void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
1031 Assert(isTypeRef(N, N.getType()), "invalid type ref", &N, N.getType());
1034 void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1035 visitDITemplateParameter(N);
1037 Assert(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1041 void Verifier::visitDITemplateValueParameter(
1042 const DITemplateValueParameter &N) {
1043 visitDITemplateParameter(N);
1045 Assert(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1046 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1047 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1051 void Verifier::visitDIVariable(const DIVariable &N) {
1052 if (auto *S = N.getRawScope())
1053 Assert(isa<DIScope>(S), "invalid scope", &N, S);
1054 Assert(isTypeRef(N, N.getRawType()), "invalid type ref", &N, N.getRawType());
1055 if (auto *F = N.getRawFile())
1056 Assert(isa<DIFile>(F), "invalid file", &N, F);
1059 void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
1060 // Checks common to all variables.
1063 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1064 Assert(!N.getName().empty(), "missing global variable name", &N);
1065 if (auto *V = N.getRawVariable()) {
1066 Assert(isa<ConstantAsMetadata>(V) &&
1067 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
1068 "invalid global varaible ref", &N, V);
1070 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
1071 Assert(isa<DIDerivedType>(Member), "invalid static data member declaration",
1076 void Verifier::visitDILocalVariable(const DILocalVariable &N) {
1077 // Checks common to all variables.
1080 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1081 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1082 "local variable requires a valid scope", &N, N.getRawScope());
1085 void Verifier::visitDIExpression(const DIExpression &N) {
1086 Assert(N.isValid(), "invalid expression", &N);
1089 void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
1090 Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
1091 if (auto *T = N.getRawType())
1092 Assert(isTypeRef(N, T), "invalid type ref", &N, T);
1093 if (auto *F = N.getRawFile())
1094 Assert(isa<DIFile>(F), "invalid file", &N, F);
1097 void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
1098 Assert(N.getTag() == dwarf::DW_TAG_imported_module ||
1099 N.getTag() == dwarf::DW_TAG_imported_declaration,
1101 if (auto *S = N.getRawScope())
1102 Assert(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1103 Assert(isDIRef(N, N.getEntity()), "invalid imported entity", &N,
1107 void Verifier::visitComdat(const Comdat &C) {
1108 // The Module is invalid if the GlobalValue has private linkage. Entities
1109 // with private linkage don't have entries in the symbol table.
1110 if (const GlobalValue *GV = M->getNamedValue(C.getName()))
1111 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1115 void Verifier::visitModuleIdents(const Module &M) {
1116 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1120 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1121 // Scan each llvm.ident entry and make sure that this requirement is met.
1122 for (unsigned i = 0, e = Idents->getNumOperands(); i != e; ++i) {
1123 const MDNode *N = Idents->getOperand(i);
1124 Assert(N->getNumOperands() == 1,
1125 "incorrect number of operands in llvm.ident metadata", N);
1126 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1127 ("invalid value for llvm.ident metadata entry operand"
1128 "(the operand should be a string)"),
1133 void Verifier::visitModuleFlags(const Module &M) {
1134 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1137 // Scan each flag, and track the flags and requirements.
1138 DenseMap<const MDString*, const MDNode*> SeenIDs;
1139 SmallVector<const MDNode*, 16> Requirements;
1140 for (unsigned I = 0, E = Flags->getNumOperands(); I != E; ++I) {
1141 visitModuleFlag(Flags->getOperand(I), SeenIDs, Requirements);
1144 // Validate that the requirements in the module are valid.
1145 for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
1146 const MDNode *Requirement = Requirements[I];
1147 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
1148 const Metadata *ReqValue = Requirement->getOperand(1);
1150 const MDNode *Op = SeenIDs.lookup(Flag);
1152 CheckFailed("invalid requirement on flag, flag is not present in module",
1157 if (Op->getOperand(2) != ReqValue) {
1158 CheckFailed(("invalid requirement on flag, "
1159 "flag does not have the required value"),
1167 Verifier::visitModuleFlag(const MDNode *Op,
1168 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1169 SmallVectorImpl<const MDNode *> &Requirements) {
1170 // Each module flag should have three arguments, the merge behavior (a
1171 // constant int), the flag ID (an MDString), and the value.
1172 Assert(Op->getNumOperands() == 3,
1173 "incorrect number of operands in module flag", Op);
1174 Module::ModFlagBehavior MFB;
1175 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
1177 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
1178 "invalid behavior operand in module flag (expected constant integer)",
1181 "invalid behavior operand in module flag (unexpected constant)",
1184 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
1185 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1188 // Sanity check the values for behaviors with additional requirements.
1191 case Module::Warning:
1192 case Module::Override:
1193 // These behavior types accept any value.
1196 case Module::Require: {
1197 // The value should itself be an MDNode with two operands, a flag ID (an
1198 // MDString), and a value.
1199 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
1200 Assert(Value && Value->getNumOperands() == 2,
1201 "invalid value for 'require' module flag (expected metadata pair)",
1203 Assert(isa<MDString>(Value->getOperand(0)),
1204 ("invalid value for 'require' module flag "
1205 "(first value operand should be a string)"),
1206 Value->getOperand(0));
1208 // Append it to the list of requirements, to check once all module flags are
1210 Requirements.push_back(Value);
1214 case Module::Append:
1215 case Module::AppendUnique: {
1216 // These behavior types require the operand be an MDNode.
1217 Assert(isa<MDNode>(Op->getOperand(2)),
1218 "invalid value for 'append'-type module flag "
1219 "(expected a metadata node)",
1225 // Unless this is a "requires" flag, check the ID is unique.
1226 if (MFB != Module::Require) {
1227 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
1229 "module flag identifiers must be unique (or of 'require' type)", ID);
1233 void Verifier::VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
1234 bool isFunction, const Value *V) {
1235 unsigned Slot = ~0U;
1236 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1237 if (Attrs.getSlotIndex(I) == Idx) {
1242 assert(Slot != ~0U && "Attribute set inconsistency!");
1244 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1246 if (I->isStringAttribute())
1249 if (I->getKindAsEnum() == Attribute::NoReturn ||
1250 I->getKindAsEnum() == Attribute::NoUnwind ||
1251 I->getKindAsEnum() == Attribute::NoInline ||
1252 I->getKindAsEnum() == Attribute::AlwaysInline ||
1253 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1254 I->getKindAsEnum() == Attribute::StackProtect ||
1255 I->getKindAsEnum() == Attribute::StackProtectReq ||
1256 I->getKindAsEnum() == Attribute::StackProtectStrong ||
1257 I->getKindAsEnum() == Attribute::SafeStack ||
1258 I->getKindAsEnum() == Attribute::NoRedZone ||
1259 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1260 I->getKindAsEnum() == Attribute::Naked ||
1261 I->getKindAsEnum() == Attribute::InlineHint ||
1262 I->getKindAsEnum() == Attribute::StackAlignment ||
1263 I->getKindAsEnum() == Attribute::UWTable ||
1264 I->getKindAsEnum() == Attribute::NonLazyBind ||
1265 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1266 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1267 I->getKindAsEnum() == Attribute::SanitizeThread ||
1268 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1269 I->getKindAsEnum() == Attribute::MinSize ||
1270 I->getKindAsEnum() == Attribute::NoDuplicate ||
1271 I->getKindAsEnum() == Attribute::Builtin ||
1272 I->getKindAsEnum() == Attribute::NoBuiltin ||
1273 I->getKindAsEnum() == Attribute::Cold ||
1274 I->getKindAsEnum() == Attribute::OptimizeNone ||
1275 I->getKindAsEnum() == Attribute::JumpTable ||
1276 I->getKindAsEnum() == Attribute::Convergent ||
1277 I->getKindAsEnum() == Attribute::ArgMemOnly) {
1279 CheckFailed("Attribute '" + I->getAsString() +
1280 "' only applies to functions!", V);
1283 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
1284 I->getKindAsEnum() == Attribute::ReadNone) {
1286 CheckFailed("Attribute '" + I->getAsString() +
1287 "' does not apply to function returns");
1290 } else if (isFunction) {
1291 CheckFailed("Attribute '" + I->getAsString() +
1292 "' does not apply to functions!", V);
1298 // VerifyParameterAttrs - Check the given attributes for an argument or return
1299 // value of the specified type. The value V is printed in error messages.
1300 void Verifier::VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
1301 bool isReturnValue, const Value *V) {
1302 if (!Attrs.hasAttributes(Idx))
1305 VerifyAttributeTypes(Attrs, Idx, false, V);
1308 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1309 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1310 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1311 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1312 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
1313 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1314 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', and "
1315 "'returned' do not apply to return values!",
1318 // Check for mutually incompatible attributes. Only inreg is compatible with
1320 unsigned AttrCount = 0;
1321 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1322 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1323 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1324 Attrs.hasAttribute(Idx, Attribute::InReg);
1325 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
1326 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1327 "and 'sret' are incompatible!",
1330 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1331 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1333 "'inalloca and readonly' are incompatible!",
1336 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1337 Attrs.hasAttribute(Idx, Attribute::Returned)),
1339 "'sret and returned' are incompatible!",
1342 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1343 Attrs.hasAttribute(Idx, Attribute::SExt)),
1345 "'zeroext and signext' are incompatible!",
1348 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1349 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1351 "'readnone and readonly' are incompatible!",
1354 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1355 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1357 "'noinline and alwaysinline' are incompatible!",
1360 Assert(!AttrBuilder(Attrs, Idx)
1361 .overlaps(AttributeFuncs::typeIncompatible(Ty)),
1362 "Wrong types for attribute: " +
1363 AttributeSet::get(*Context, Idx,
1364 AttributeFuncs::typeIncompatible(Ty)).getAsString(Idx),
1367 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
1368 SmallPtrSet<Type*, 4> Visited;
1369 if (!PTy->getElementType()->isSized(&Visited)) {
1370 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1371 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1372 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1376 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1377 "Attribute 'byval' only applies to parameters with pointer type!",
1382 // VerifyFunctionAttrs - Check parameter attributes against a function type.
1383 // The value V is printed in error messages.
1384 void Verifier::VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
1386 if (Attrs.isEmpty())
1389 bool SawNest = false;
1390 bool SawReturned = false;
1391 bool SawSRet = false;
1393 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
1394 unsigned Idx = Attrs.getSlotIndex(i);
1398 Ty = FT->getReturnType();
1399 else if (Idx-1 < FT->getNumParams())
1400 Ty = FT->getParamType(Idx-1);
1402 break; // VarArgs attributes, verified elsewhere.
1404 VerifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
1409 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
1410 Assert(!SawNest, "More than one parameter has attribute nest!", V);
1414 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
1415 Assert(!SawReturned, "More than one parameter has attribute returned!",
1417 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1419 "argument and return types for 'returned' attribute",
1424 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
1425 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1426 Assert(Idx == 1 || Idx == 2,
1427 "Attribute 'sret' is not on first or second parameter!", V);
1431 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
1432 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1437 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1440 VerifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
1443 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1444 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1445 "Attributes 'readnone and readonly' are incompatible!", V);
1448 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1449 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1450 Attribute::AlwaysInline)),
1451 "Attributes 'noinline and alwaysinline' are incompatible!", V);
1453 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1454 Attribute::OptimizeNone)) {
1455 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1456 "Attribute 'optnone' requires 'noinline'!", V);
1458 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1459 Attribute::OptimizeForSize),
1460 "Attributes 'optsize and optnone' are incompatible!", V);
1462 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1463 "Attributes 'minsize and optnone' are incompatible!", V);
1466 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1467 Attribute::JumpTable)) {
1468 const GlobalValue *GV = cast<GlobalValue>(V);
1469 Assert(GV->hasUnnamedAddr(),
1470 "Attribute 'jumptable' requires 'unnamed_addr'", V);
1474 void Verifier::VerifyFunctionMetadata(
1475 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs) {
1479 for (unsigned i = 0; i < MDs.size(); i++) {
1480 if (MDs[i].first == LLVMContext::MD_prof) {
1481 MDNode *MD = MDs[i].second;
1482 Assert(MD->getNumOperands() == 2,
1483 "!prof annotations should have exactly 2 operands", MD);
1485 // Check first operand.
1486 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1488 Assert(isa<MDString>(MD->getOperand(0)),
1489 "expected string with name of the !prof annotation", MD);
1490 MDString *MDS = cast<MDString>(MD->getOperand(0));
1491 StringRef ProfName = MDS->getString();
1492 Assert(ProfName.equals("function_entry_count"),
1493 "first operand should be 'function_entry_count'", MD);
1495 // Check second operand.
1496 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1498 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1499 "expected integer argument to function_entry_count", MD);
1504 void Verifier::VerifyConstantExprBitcastType(const ConstantExpr *CE) {
1505 if (CE->getOpcode() != Instruction::BitCast)
1508 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1510 "Invalid bitcast", CE);
1513 bool Verifier::VerifyAttributeCount(AttributeSet Attrs, unsigned Params) {
1514 if (Attrs.getNumSlots() == 0)
1517 unsigned LastSlot = Attrs.getNumSlots() - 1;
1518 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
1519 if (LastIndex <= Params
1520 || (LastIndex == AttributeSet::FunctionIndex
1521 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
1527 /// \brief Verify that statepoint intrinsic is well formed.
1528 void Verifier::VerifyStatepoint(ImmutableCallSite CS) {
1529 assert(CS.getCalledFunction() &&
1530 CS.getCalledFunction()->getIntrinsicID() ==
1531 Intrinsic::experimental_gc_statepoint);
1533 const Instruction &CI = *CS.getInstruction();
1535 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1536 !CS.onlyAccessesArgMemory(),
1537 "gc.statepoint must read and write all memory to preserve "
1538 "reordering restrictions required by safepoint semantics",
1541 const Value *IDV = CS.getArgument(0);
1542 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1545 const Value *NumPatchBytesV = CS.getArgument(1);
1546 Assert(isa<ConstantInt>(NumPatchBytesV),
1547 "gc.statepoint number of patchable bytes must be a constant integer",
1549 const int64_t NumPatchBytes =
1550 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1551 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1552 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1556 const Value *Target = CS.getArgument(2);
1557 auto *PT = dyn_cast<PointerType>(Target->getType());
1558 Assert(PT && PT->getElementType()->isFunctionTy(),
1559 "gc.statepoint callee must be of function pointer type", &CI, Target);
1560 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
1562 const Value *NumCallArgsV = CS.getArgument(3);
1563 Assert(isa<ConstantInt>(NumCallArgsV),
1564 "gc.statepoint number of arguments to underlying call "
1565 "must be constant integer",
1567 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
1568 Assert(NumCallArgs >= 0,
1569 "gc.statepoint number of arguments to underlying call "
1572 const int NumParams = (int)TargetFuncType->getNumParams();
1573 if (TargetFuncType->isVarArg()) {
1574 Assert(NumCallArgs >= NumParams,
1575 "gc.statepoint mismatch in number of vararg call args", &CI);
1577 // TODO: Remove this limitation
1578 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1579 "gc.statepoint doesn't support wrapping non-void "
1580 "vararg functions yet",
1583 Assert(NumCallArgs == NumParams,
1584 "gc.statepoint mismatch in number of call args", &CI);
1586 const Value *FlagsV = CS.getArgument(4);
1587 Assert(isa<ConstantInt>(FlagsV),
1588 "gc.statepoint flags must be constant integer", &CI);
1589 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1590 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1591 "unknown flag used in gc.statepoint flags argument", &CI);
1593 // Verify that the types of the call parameter arguments match
1594 // the type of the wrapped callee.
1595 for (int i = 0; i < NumParams; i++) {
1596 Type *ParamType = TargetFuncType->getParamType(i);
1597 Type *ArgType = CS.getArgument(5 + i)->getType();
1598 Assert(ArgType == ParamType,
1599 "gc.statepoint call argument does not match wrapped "
1604 const int EndCallArgsInx = 4 + NumCallArgs;
1606 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1607 Assert(isa<ConstantInt>(NumTransitionArgsV),
1608 "gc.statepoint number of transition arguments "
1609 "must be constant integer",
1611 const int NumTransitionArgs =
1612 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1613 Assert(NumTransitionArgs >= 0,
1614 "gc.statepoint number of transition arguments must be positive", &CI);
1615 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1617 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
1618 Assert(isa<ConstantInt>(NumDeoptArgsV),
1619 "gc.statepoint number of deoptimization arguments "
1620 "must be constant integer",
1622 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
1623 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1627 const int ExpectedNumArgs =
1628 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
1629 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
1630 "gc.statepoint too few arguments according to length fields", &CI);
1632 // Check that the only uses of this gc.statepoint are gc.result or
1633 // gc.relocate calls which are tied to this statepoint and thus part
1634 // of the same statepoint sequence
1635 for (const User *U : CI.users()) {
1636 const CallInst *Call = dyn_cast<const CallInst>(U);
1637 Assert(Call, "illegal use of statepoint token", &CI, U);
1638 if (!Call) continue;
1639 Assert(isGCRelocate(Call) || isGCResult(Call),
1640 "gc.result or gc.relocate are the only value uses"
1641 "of a gc.statepoint",
1643 if (isGCResult(Call)) {
1644 Assert(Call->getArgOperand(0) == &CI,
1645 "gc.result connected to wrong gc.statepoint", &CI, Call);
1646 } else if (isGCRelocate(Call)) {
1647 Assert(Call->getArgOperand(0) == &CI,
1648 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
1652 // Note: It is legal for a single derived pointer to be listed multiple
1653 // times. It's non-optimal, but it is legal. It can also happen after
1654 // insertion if we strip a bitcast away.
1655 // Note: It is really tempting to check that each base is relocated and
1656 // that a derived pointer is never reused as a base pointer. This turns
1657 // out to be problematic since optimizations run after safepoint insertion
1658 // can recognize equality properties that the insertion logic doesn't know
1659 // about. See example statepoint.ll in the verifier subdirectory
1662 void Verifier::verifyFrameRecoverIndices() {
1663 for (auto &Counts : FrameEscapeInfo) {
1664 Function *F = Counts.first;
1665 unsigned EscapedObjectCount = Counts.second.first;
1666 unsigned MaxRecoveredIndex = Counts.second.second;
1667 Assert(MaxRecoveredIndex <= EscapedObjectCount,
1668 "all indices passed to llvm.localrecover must be less than the "
1669 "number of arguments passed ot llvm.localescape in the parent "
1675 // visitFunction - Verify that a function is ok.
1677 void Verifier::visitFunction(const Function &F) {
1678 // Check function arguments.
1679 FunctionType *FT = F.getFunctionType();
1680 unsigned NumArgs = F.arg_size();
1682 Assert(Context == &F.getContext(),
1683 "Function context does not match Module context!", &F);
1685 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1686 Assert(FT->getNumParams() == NumArgs,
1687 "# formal arguments must match # of arguments for function type!", &F,
1689 Assert(F.getReturnType()->isFirstClassType() ||
1690 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1691 "Functions cannot return aggregate values!", &F);
1693 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1694 "Invalid struct return type!", &F);
1696 AttributeSet Attrs = F.getAttributes();
1698 Assert(VerifyAttributeCount(Attrs, FT->getNumParams()),
1699 "Attribute after last parameter!", &F);
1701 // Check function attributes.
1702 VerifyFunctionAttrs(FT, Attrs, &F);
1704 // On function declarations/definitions, we do not support the builtin
1705 // attribute. We do not check this in VerifyFunctionAttrs since that is
1706 // checking for Attributes that can/can not ever be on functions.
1707 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1708 "Attribute 'builtin' can only be applied to a callsite.", &F);
1710 // Check that this function meets the restrictions on this calling convention.
1711 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1712 // restrictions can be lifted.
1713 switch (F.getCallingConv()) {
1715 case CallingConv::C:
1717 case CallingConv::Fast:
1718 case CallingConv::Cold:
1719 case CallingConv::Intel_OCL_BI:
1720 case CallingConv::PTX_Kernel:
1721 case CallingConv::PTX_Device:
1722 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1723 "perfect forwarding!",
1728 bool isLLVMdotName = F.getName().size() >= 5 &&
1729 F.getName().substr(0, 5) == "llvm.";
1731 // Check that the argument values match the function type for this function...
1733 for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E;
1735 Assert(I->getType() == FT->getParamType(i),
1736 "Argument value does not match function argument type!", I,
1737 FT->getParamType(i));
1738 Assert(I->getType()->isFirstClassType(),
1739 "Function arguments must have first-class types!", I);
1741 Assert(!I->getType()->isMetadataTy(),
1742 "Function takes metadata but isn't an intrinsic", I, &F);
1745 // Get the function metadata attachments.
1746 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1747 F.getAllMetadata(MDs);
1748 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
1749 VerifyFunctionMetadata(MDs);
1751 if (F.isMaterializable()) {
1752 // Function has a body somewhere we can't see.
1753 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
1754 MDs.empty() ? nullptr : MDs.front().second);
1755 } else if (F.isDeclaration()) {
1756 Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1757 "invalid linkage type for function declaration", &F);
1758 Assert(MDs.empty(), "function without a body cannot have metadata", &F,
1759 MDs.empty() ? nullptr : MDs.front().second);
1760 Assert(!F.hasPersonalityFn(),
1761 "Function declaration shouldn't have a personality routine", &F);
1763 // Verify that this function (which has a body) is not named "llvm.*". It
1764 // is not legal to define intrinsics.
1765 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
1767 // Check the entry node
1768 const BasicBlock *Entry = &F.getEntryBlock();
1769 Assert(pred_empty(Entry),
1770 "Entry block to function must not have predecessors!", Entry);
1772 // The address of the entry block cannot be taken, unless it is dead.
1773 if (Entry->hasAddressTaken()) {
1774 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1775 "blockaddress may not be used with the entry block!", Entry);
1778 // Visit metadata attachments.
1779 for (const auto &I : MDs)
1780 visitMDNode(*I.second);
1783 // If this function is actually an intrinsic, verify that it is only used in
1784 // direct call/invokes, never having its "address taken".
1785 if (F.getIntrinsicID()) {
1787 if (F.hasAddressTaken(&U))
1788 Assert(0, "Invalid user of intrinsic instruction!", U);
1791 Assert(!F.hasDLLImportStorageClass() ||
1792 (F.isDeclaration() && F.hasExternalLinkage()) ||
1793 F.hasAvailableExternallyLinkage(),
1794 "Function is marked as dllimport, but not external.", &F);
1797 // verifyBasicBlock - Verify that a basic block is well formed...
1799 void Verifier::visitBasicBlock(BasicBlock &BB) {
1800 InstsInThisBlock.clear();
1802 // Ensure that basic blocks have terminators!
1803 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
1805 // Check constraints that this basic block imposes on all of the PHI nodes in
1807 if (isa<PHINode>(BB.front())) {
1808 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
1809 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
1810 std::sort(Preds.begin(), Preds.end());
1812 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
1813 // Ensure that PHI nodes have at least one entry!
1814 Assert(PN->getNumIncomingValues() != 0,
1815 "PHI nodes must have at least one entry. If the block is dead, "
1816 "the PHI should be removed!",
1818 Assert(PN->getNumIncomingValues() == Preds.size(),
1819 "PHINode should have one entry for each predecessor of its "
1820 "parent basic block!",
1823 // Get and sort all incoming values in the PHI node...
1825 Values.reserve(PN->getNumIncomingValues());
1826 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1827 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
1828 PN->getIncomingValue(i)));
1829 std::sort(Values.begin(), Values.end());
1831 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
1832 // Check to make sure that if there is more than one entry for a
1833 // particular basic block in this PHI node, that the incoming values are
1836 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
1837 Values[i].second == Values[i - 1].second,
1838 "PHI node has multiple entries for the same basic block with "
1839 "different incoming values!",
1840 PN, Values[i].first, Values[i].second, Values[i - 1].second);
1842 // Check to make sure that the predecessors and PHI node entries are
1844 Assert(Values[i].first == Preds[i],
1845 "PHI node entries do not match predecessors!", PN,
1846 Values[i].first, Preds[i]);
1851 // Check that all instructions have their parent pointers set up correctly.
1854 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
1858 void Verifier::visitTerminatorInst(TerminatorInst &I) {
1859 // Ensure that terminators only exist at the end of the basic block.
1860 Assert(&I == I.getParent()->getTerminator(),
1861 "Terminator found in the middle of a basic block!", I.getParent());
1862 visitInstruction(I);
1865 void Verifier::visitBranchInst(BranchInst &BI) {
1866 if (BI.isConditional()) {
1867 Assert(BI.getCondition()->getType()->isIntegerTy(1),
1868 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
1870 visitTerminatorInst(BI);
1873 void Verifier::visitReturnInst(ReturnInst &RI) {
1874 Function *F = RI.getParent()->getParent();
1875 unsigned N = RI.getNumOperands();
1876 if (F->getReturnType()->isVoidTy())
1878 "Found return instr that returns non-void in Function of void "
1880 &RI, F->getReturnType());
1882 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
1883 "Function return type does not match operand "
1884 "type of return inst!",
1885 &RI, F->getReturnType());
1887 // Check to make sure that the return value has necessary properties for
1889 visitTerminatorInst(RI);
1892 void Verifier::visitSwitchInst(SwitchInst &SI) {
1893 // Check to make sure that all of the constants in the switch instruction
1894 // have the same type as the switched-on value.
1895 Type *SwitchTy = SI.getCondition()->getType();
1896 SmallPtrSet<ConstantInt*, 32> Constants;
1897 for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end(); i != e; ++i) {
1898 Assert(i.getCaseValue()->getType() == SwitchTy,
1899 "Switch constants must all be same type as switch value!", &SI);
1900 Assert(Constants.insert(i.getCaseValue()).second,
1901 "Duplicate integer as switch case", &SI, i.getCaseValue());
1904 visitTerminatorInst(SI);
1907 void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
1908 Assert(BI.getAddress()->getType()->isPointerTy(),
1909 "Indirectbr operand must have pointer type!", &BI);
1910 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
1911 Assert(BI.getDestination(i)->getType()->isLabelTy(),
1912 "Indirectbr destinations must all have pointer type!", &BI);
1914 visitTerminatorInst(BI);
1917 void Verifier::visitSelectInst(SelectInst &SI) {
1918 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
1920 "Invalid operands for select instruction!", &SI);
1922 Assert(SI.getTrueValue()->getType() == SI.getType(),
1923 "Select values must have same type as select instruction!", &SI);
1924 visitInstruction(SI);
1927 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
1928 /// a pass, if any exist, it's an error.
1930 void Verifier::visitUserOp1(Instruction &I) {
1931 Assert(0, "User-defined operators should not live outside of a pass!", &I);
1934 void Verifier::visitTruncInst(TruncInst &I) {
1935 // Get the source and destination types
1936 Type *SrcTy = I.getOperand(0)->getType();
1937 Type *DestTy = I.getType();
1939 // Get the size of the types in bits, we'll need this later
1940 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1941 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1943 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
1944 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
1945 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1946 "trunc source and destination must both be a vector or neither", &I);
1947 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
1949 visitInstruction(I);
1952 void Verifier::visitZExtInst(ZExtInst &I) {
1953 // Get the source and destination types
1954 Type *SrcTy = I.getOperand(0)->getType();
1955 Type *DestTy = I.getType();
1957 // Get the size of the types in bits, we'll need this later
1958 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
1959 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
1960 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1961 "zext source and destination must both be a vector or neither", &I);
1962 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1963 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1965 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
1967 visitInstruction(I);
1970 void Verifier::visitSExtInst(SExtInst &I) {
1971 // Get the source and destination types
1972 Type *SrcTy = I.getOperand(0)->getType();
1973 Type *DestTy = I.getType();
1975 // Get the size of the types in bits, we'll need this later
1976 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1977 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1979 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
1980 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
1981 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1982 "sext source and destination must both be a vector or neither", &I);
1983 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
1985 visitInstruction(I);
1988 void Verifier::visitFPTruncInst(FPTruncInst &I) {
1989 // Get the source and destination types
1990 Type *SrcTy = I.getOperand(0)->getType();
1991 Type *DestTy = I.getType();
1992 // Get the size of the types in bits, we'll need this later
1993 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1994 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1996 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
1997 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
1998 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1999 "fptrunc source and destination must both be a vector or neither", &I);
2000 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
2002 visitInstruction(I);
2005 void Verifier::visitFPExtInst(FPExtInst &I) {
2006 // Get the source and destination types
2007 Type *SrcTy = I.getOperand(0)->getType();
2008 Type *DestTy = I.getType();
2010 // Get the size of the types in bits, we'll need this later
2011 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2012 unsigned DestBitSize = DestTy->getScalarSizeInBits();
2014 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2015 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2016 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2017 "fpext source and destination must both be a vector or neither", &I);
2018 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
2020 visitInstruction(I);
2023 void Verifier::visitUIToFPInst(UIToFPInst &I) {
2024 // Get the source and destination types
2025 Type *SrcTy = I.getOperand(0)->getType();
2026 Type *DestTy = I.getType();
2028 bool SrcVec = SrcTy->isVectorTy();
2029 bool DstVec = DestTy->isVectorTy();
2031 Assert(SrcVec == DstVec,
2032 "UIToFP source and dest must both be vector or scalar", &I);
2033 Assert(SrcTy->isIntOrIntVectorTy(),
2034 "UIToFP source must be integer or integer vector", &I);
2035 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2038 if (SrcVec && DstVec)
2039 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2040 cast<VectorType>(DestTy)->getNumElements(),
2041 "UIToFP source and dest vector length mismatch", &I);
2043 visitInstruction(I);
2046 void Verifier::visitSIToFPInst(SIToFPInst &I) {
2047 // Get the source and destination types
2048 Type *SrcTy = I.getOperand(0)->getType();
2049 Type *DestTy = I.getType();
2051 bool SrcVec = SrcTy->isVectorTy();
2052 bool DstVec = DestTy->isVectorTy();
2054 Assert(SrcVec == DstVec,
2055 "SIToFP source and dest must both be vector or scalar", &I);
2056 Assert(SrcTy->isIntOrIntVectorTy(),
2057 "SIToFP source must be integer or integer vector", &I);
2058 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2061 if (SrcVec && DstVec)
2062 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2063 cast<VectorType>(DestTy)->getNumElements(),
2064 "SIToFP source and dest vector length mismatch", &I);
2066 visitInstruction(I);
2069 void Verifier::visitFPToUIInst(FPToUIInst &I) {
2070 // Get the source and destination types
2071 Type *SrcTy = I.getOperand(0)->getType();
2072 Type *DestTy = I.getType();
2074 bool SrcVec = SrcTy->isVectorTy();
2075 bool DstVec = DestTy->isVectorTy();
2077 Assert(SrcVec == DstVec,
2078 "FPToUI source and dest must both be vector or scalar", &I);
2079 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2081 Assert(DestTy->isIntOrIntVectorTy(),
2082 "FPToUI result must be integer or integer vector", &I);
2084 if (SrcVec && DstVec)
2085 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2086 cast<VectorType>(DestTy)->getNumElements(),
2087 "FPToUI source and dest vector length mismatch", &I);
2089 visitInstruction(I);
2092 void Verifier::visitFPToSIInst(FPToSIInst &I) {
2093 // Get the source and destination types
2094 Type *SrcTy = I.getOperand(0)->getType();
2095 Type *DestTy = I.getType();
2097 bool SrcVec = SrcTy->isVectorTy();
2098 bool DstVec = DestTy->isVectorTy();
2100 Assert(SrcVec == DstVec,
2101 "FPToSI source and dest must both be vector or scalar", &I);
2102 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2104 Assert(DestTy->isIntOrIntVectorTy(),
2105 "FPToSI result must be integer or integer vector", &I);
2107 if (SrcVec && DstVec)
2108 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2109 cast<VectorType>(DestTy)->getNumElements(),
2110 "FPToSI source and dest vector length mismatch", &I);
2112 visitInstruction(I);
2115 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2116 // Get the source and destination types
2117 Type *SrcTy = I.getOperand(0)->getType();
2118 Type *DestTy = I.getType();
2120 Assert(SrcTy->getScalarType()->isPointerTy(),
2121 "PtrToInt source must be pointer", &I);
2122 Assert(DestTy->getScalarType()->isIntegerTy(),
2123 "PtrToInt result must be integral", &I);
2124 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2127 if (SrcTy->isVectorTy()) {
2128 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2129 VectorType *VDest = dyn_cast<VectorType>(DestTy);
2130 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2131 "PtrToInt Vector width mismatch", &I);
2134 visitInstruction(I);
2137 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2138 // Get the source and destination types
2139 Type *SrcTy = I.getOperand(0)->getType();
2140 Type *DestTy = I.getType();
2142 Assert(SrcTy->getScalarType()->isIntegerTy(),
2143 "IntToPtr source must be an integral", &I);
2144 Assert(DestTy->getScalarType()->isPointerTy(),
2145 "IntToPtr result must be a pointer", &I);
2146 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2148 if (SrcTy->isVectorTy()) {
2149 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2150 VectorType *VDest = dyn_cast<VectorType>(DestTy);
2151 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2152 "IntToPtr Vector width mismatch", &I);
2154 visitInstruction(I);
2157 void Verifier::visitBitCastInst(BitCastInst &I) {
2159 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2160 "Invalid bitcast", &I);
2161 visitInstruction(I);
2164 void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2165 Type *SrcTy = I.getOperand(0)->getType();
2166 Type *DestTy = I.getType();
2168 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2170 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2172 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2173 "AddrSpaceCast must be between different address spaces", &I);
2174 if (SrcTy->isVectorTy())
2175 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2176 "AddrSpaceCast vector pointer number of elements mismatch", &I);
2177 visitInstruction(I);
2180 /// visitPHINode - Ensure that a PHI node is well formed.
2182 void Verifier::visitPHINode(PHINode &PN) {
2183 // Ensure that the PHI nodes are all grouped together at the top of the block.
2184 // This can be tested by checking whether the instruction before this is
2185 // either nonexistent (because this is begin()) or is a PHI node. If not,
2186 // then there is some other instruction before a PHI.
2187 Assert(&PN == &PN.getParent()->front() ||
2188 isa<PHINode>(--BasicBlock::iterator(&PN)),
2189 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
2191 // Check that all of the values of the PHI node have the same type as the
2192 // result, and that the incoming blocks are really basic blocks.
2193 for (Value *IncValue : PN.incoming_values()) {
2194 Assert(PN.getType() == IncValue->getType(),
2195 "PHI node operands are not the same type as the result!", &PN);
2198 // All other PHI node constraints are checked in the visitBasicBlock method.
2200 visitInstruction(PN);
2203 void Verifier::VerifyCallSite(CallSite CS) {
2204 Instruction *I = CS.getInstruction();
2206 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2207 "Called function must be a pointer!", I);
2208 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
2210 Assert(FPTy->getElementType()->isFunctionTy(),
2211 "Called function is not pointer to function type!", I);
2213 Assert(FPTy->getElementType() == CS.getFunctionType(),
2214 "Called function is not the same type as the call!", I);
2216 FunctionType *FTy = CS.getFunctionType();
2218 // Verify that the correct number of arguments are being passed
2219 if (FTy->isVarArg())
2220 Assert(CS.arg_size() >= FTy->getNumParams(),
2221 "Called function requires more parameters than were provided!", I);
2223 Assert(CS.arg_size() == FTy->getNumParams(),
2224 "Incorrect number of arguments passed to called function!", I);
2226 // Verify that all arguments to the call match the function type.
2227 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2228 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2229 "Call parameter type does not match function signature!",
2230 CS.getArgument(i), FTy->getParamType(i), I);
2232 AttributeSet Attrs = CS.getAttributes();
2234 Assert(VerifyAttributeCount(Attrs, CS.arg_size()),
2235 "Attribute after last parameter!", I);
2237 // Verify call attributes.
2238 VerifyFunctionAttrs(FTy, Attrs, I);
2240 // Conservatively check the inalloca argument.
2241 // We have a bug if we can find that there is an underlying alloca without
2243 if (CS.hasInAllocaArgument()) {
2244 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2245 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
2246 Assert(AI->isUsedWithInAlloca(),
2247 "inalloca argument for call has mismatched alloca", AI, I);
2250 if (FTy->isVarArg()) {
2251 // FIXME? is 'nest' even legal here?
2252 bool SawNest = false;
2253 bool SawReturned = false;
2255 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2256 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2258 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2262 // Check attributes on the varargs part.
2263 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
2264 Type *Ty = CS.getArgument(Idx-1)->getType();
2265 VerifyParameterAttrs(Attrs, Idx, Ty, false, I);
2267 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
2268 Assert(!SawNest, "More than one parameter has attribute nest!", I);
2272 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
2273 Assert(!SawReturned, "More than one parameter has attribute returned!",
2275 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2276 "Incompatible argument and return types for 'returned' "
2282 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2283 "Attribute 'sret' cannot be used for vararg call arguments!", I);
2285 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
2286 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
2290 // Verify that there's no metadata unless it's a direct call to an intrinsic.
2291 if (CS.getCalledFunction() == nullptr ||
2292 !CS.getCalledFunction()->getName().startswith("llvm.")) {
2293 for (FunctionType::param_iterator PI = FTy->param_begin(),
2294 PE = FTy->param_end(); PI != PE; ++PI)
2295 Assert(!(*PI)->isMetadataTy(),
2296 "Function has metadata parameter but isn't an intrinsic", I);
2299 if (Function *F = CS.getCalledFunction())
2300 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
2301 visitIntrinsicCallSite(ID, CS);
2303 visitInstruction(*I);
2306 /// Two types are "congruent" if they are identical, or if they are both pointer
2307 /// types with different pointee types and the same address space.
2308 static bool isTypeCongruent(Type *L, Type *R) {
2311 PointerType *PL = dyn_cast<PointerType>(L);
2312 PointerType *PR = dyn_cast<PointerType>(R);
2315 return PL->getAddressSpace() == PR->getAddressSpace();
2318 static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2319 static const Attribute::AttrKind ABIAttrs[] = {
2320 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
2321 Attribute::InReg, Attribute::Returned};
2323 for (auto AK : ABIAttrs) {
2324 if (Attrs.hasAttribute(I + 1, AK))
2325 Copy.addAttribute(AK);
2327 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2328 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2332 void Verifier::verifyMustTailCall(CallInst &CI) {
2333 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
2335 // - The caller and callee prototypes must match. Pointer types of
2336 // parameters or return types may differ in pointee type, but not
2338 Function *F = CI.getParent()->getParent();
2339 FunctionType *CallerTy = F->getFunctionType();
2340 FunctionType *CalleeTy = CI.getFunctionType();
2341 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2342 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2343 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2344 "cannot guarantee tail call due to mismatched varargs", &CI);
2345 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2346 "cannot guarantee tail call due to mismatched return types", &CI);
2347 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2349 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2350 "cannot guarantee tail call due to mismatched parameter types", &CI);
2353 // - The calling conventions of the caller and callee must match.
2354 Assert(F->getCallingConv() == CI.getCallingConv(),
2355 "cannot guarantee tail call due to mismatched calling conv", &CI);
2357 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2358 // returned, and inalloca, must match.
2359 AttributeSet CallerAttrs = F->getAttributes();
2360 AttributeSet CalleeAttrs = CI.getAttributes();
2361 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2362 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2363 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
2364 Assert(CallerABIAttrs == CalleeABIAttrs,
2365 "cannot guarantee tail call due to mismatched ABI impacting "
2366 "function attributes",
2367 &CI, CI.getOperand(I));
2370 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2371 // or a pointer bitcast followed by a ret instruction.
2372 // - The ret instruction must return the (possibly bitcasted) value
2373 // produced by the call or void.
2374 Value *RetVal = &CI;
2375 Instruction *Next = CI.getNextNode();
2377 // Handle the optional bitcast.
2378 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
2379 Assert(BI->getOperand(0) == RetVal,
2380 "bitcast following musttail call must use the call", BI);
2382 Next = BI->getNextNode();
2385 // Check the return.
2386 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
2387 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2389 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2390 "musttail call result must be returned", Ret);
2393 void Verifier::visitCallInst(CallInst &CI) {
2394 VerifyCallSite(&CI);
2396 if (CI.isMustTailCall())
2397 verifyMustTailCall(CI);
2400 void Verifier::visitInvokeInst(InvokeInst &II) {
2401 VerifyCallSite(&II);
2403 // Verify that the first non-PHI instruction of the unwind destination is an
2404 // exception handling instruction.
2406 II.getUnwindDest()->isEHPad(),
2407 "The unwind destination does not have an exception handling instruction!",
2410 visitTerminatorInst(II);
2413 /// visitBinaryOperator - Check that both arguments to the binary operator are
2414 /// of the same type!
2416 void Verifier::visitBinaryOperator(BinaryOperator &B) {
2417 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2418 "Both operands to a binary operator are not of the same type!", &B);
2420 switch (B.getOpcode()) {
2421 // Check that integer arithmetic operators are only used with
2422 // integral operands.
2423 case Instruction::Add:
2424 case Instruction::Sub:
2425 case Instruction::Mul:
2426 case Instruction::SDiv:
2427 case Instruction::UDiv:
2428 case Instruction::SRem:
2429 case Instruction::URem:
2430 Assert(B.getType()->isIntOrIntVectorTy(),
2431 "Integer arithmetic operators only work with integral types!", &B);
2432 Assert(B.getType() == B.getOperand(0)->getType(),
2433 "Integer arithmetic operators must have same type "
2434 "for operands and result!",
2437 // Check that floating-point arithmetic operators are only used with
2438 // floating-point operands.
2439 case Instruction::FAdd:
2440 case Instruction::FSub:
2441 case Instruction::FMul:
2442 case Instruction::FDiv:
2443 case Instruction::FRem:
2444 Assert(B.getType()->isFPOrFPVectorTy(),
2445 "Floating-point arithmetic operators only work with "
2446 "floating-point types!",
2448 Assert(B.getType() == B.getOperand(0)->getType(),
2449 "Floating-point arithmetic operators must have same type "
2450 "for operands and result!",
2453 // Check that logical operators are only used with integral operands.
2454 case Instruction::And:
2455 case Instruction::Or:
2456 case Instruction::Xor:
2457 Assert(B.getType()->isIntOrIntVectorTy(),
2458 "Logical operators only work with integral types!", &B);
2459 Assert(B.getType() == B.getOperand(0)->getType(),
2460 "Logical operators must have same type for operands and result!",
2463 case Instruction::Shl:
2464 case Instruction::LShr:
2465 case Instruction::AShr:
2466 Assert(B.getType()->isIntOrIntVectorTy(),
2467 "Shifts only work with integral types!", &B);
2468 Assert(B.getType() == B.getOperand(0)->getType(),
2469 "Shift return type must be same as operands!", &B);
2472 llvm_unreachable("Unknown BinaryOperator opcode!");
2475 visitInstruction(B);
2478 void Verifier::visitICmpInst(ICmpInst &IC) {
2479 // Check that the operands are the same type
2480 Type *Op0Ty = IC.getOperand(0)->getType();
2481 Type *Op1Ty = IC.getOperand(1)->getType();
2482 Assert(Op0Ty == Op1Ty,
2483 "Both operands to ICmp instruction are not of the same type!", &IC);
2484 // Check that the operands are the right type
2485 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2486 "Invalid operand types for ICmp instruction", &IC);
2487 // Check that the predicate is valid.
2488 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2489 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2490 "Invalid predicate in ICmp instruction!", &IC);
2492 visitInstruction(IC);
2495 void Verifier::visitFCmpInst(FCmpInst &FC) {
2496 // Check that the operands are the same type
2497 Type *Op0Ty = FC.getOperand(0)->getType();
2498 Type *Op1Ty = FC.getOperand(1)->getType();
2499 Assert(Op0Ty == Op1Ty,
2500 "Both operands to FCmp instruction are not of the same type!", &FC);
2501 // Check that the operands are the right type
2502 Assert(Op0Ty->isFPOrFPVectorTy(),
2503 "Invalid operand types for FCmp instruction", &FC);
2504 // Check that the predicate is valid.
2505 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2506 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2507 "Invalid predicate in FCmp instruction!", &FC);
2509 visitInstruction(FC);
2512 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
2514 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2515 "Invalid extractelement operands!", &EI);
2516 visitInstruction(EI);
2519 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
2520 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2522 "Invalid insertelement operands!", &IE);
2523 visitInstruction(IE);
2526 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
2527 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2529 "Invalid shufflevector operands!", &SV);
2530 visitInstruction(SV);
2533 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
2534 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
2536 Assert(isa<PointerType>(TargetTy),
2537 "GEP base pointer is not a vector or a vector of pointers", &GEP);
2538 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
2539 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
2541 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
2542 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
2544 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
2545 GEP.getResultElementType() == ElTy,
2546 "GEP is not of right type for indices!", &GEP, ElTy);
2548 if (GEP.getType()->isVectorTy()) {
2549 // Additional checks for vector GEPs.
2550 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2551 if (GEP.getPointerOperandType()->isVectorTy())
2552 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2553 "Vector GEP result width doesn't match operand's", &GEP);
2554 for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
2555 Type *IndexTy = Idxs[i]->getType();
2556 if (IndexTy->isVectorTy()) {
2557 unsigned IndexWidth = IndexTy->getVectorNumElements();
2558 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2560 Assert(IndexTy->getScalarType()->isIntegerTy(),
2561 "All GEP indices should be of integer type");
2564 visitInstruction(GEP);
2567 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2568 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2571 void Verifier::visitRangeMetadata(Instruction& I,
2572 MDNode* Range, Type* Ty) {
2574 Range == I.getMetadata(LLVMContext::MD_range) &&
2575 "precondition violation");
2577 unsigned NumOperands = Range->getNumOperands();
2578 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
2579 unsigned NumRanges = NumOperands / 2;
2580 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2582 ConstantRange LastRange(1); // Dummy initial value
2583 for (unsigned i = 0; i < NumRanges; ++i) {
2585 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
2586 Assert(Low, "The lower limit must be an integer!", Low);
2588 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
2589 Assert(High, "The upper limit must be an integer!", High);
2590 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2591 "Range types must match instruction type!", &I);
2593 APInt HighV = High->getValue();
2594 APInt LowV = Low->getValue();
2595 ConstantRange CurRange(LowV, HighV);
2596 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2597 "Range must not be empty!", Range);
2599 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2600 "Intervals are overlapping", Range);
2601 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2603 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2606 LastRange = ConstantRange(LowV, HighV);
2608 if (NumRanges > 2) {
2610 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
2612 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
2613 ConstantRange FirstRange(FirstLow, FirstHigh);
2614 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2615 "Intervals are overlapping", Range);
2616 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2621 void Verifier::visitLoadInst(LoadInst &LI) {
2622 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
2623 Assert(PTy, "Load operand must be a pointer.", &LI);
2624 Type *ElTy = LI.getType();
2625 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2626 "huge alignment values are unsupported", &LI);
2627 if (LI.isAtomic()) {
2628 Assert(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
2629 "Load cannot have Release ordering", &LI);
2630 Assert(LI.getAlignment() != 0,
2631 "Atomic load must specify explicit alignment", &LI);
2632 if (!ElTy->isPointerTy()) {
2633 Assert(ElTy->isIntegerTy(), "atomic load operand must have integer type!",
2635 unsigned Size = ElTy->getPrimitiveSizeInBits();
2636 Assert(Size >= 8 && !(Size & (Size - 1)),
2637 "atomic load operand must be power-of-two byte-sized integer", &LI,
2641 Assert(LI.getSynchScope() == CrossThread,
2642 "Non-atomic load cannot have SynchronizationScope specified", &LI);
2645 visitInstruction(LI);
2648 void Verifier::visitStoreInst(StoreInst &SI) {
2649 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
2650 Assert(PTy, "Store operand must be a pointer.", &SI);
2651 Type *ElTy = PTy->getElementType();
2652 Assert(ElTy == SI.getOperand(0)->getType(),
2653 "Stored value type does not match pointer operand type!", &SI, ElTy);
2654 Assert(SI.getAlignment() <= Value::MaximumAlignment,
2655 "huge alignment values are unsupported", &SI);
2656 if (SI.isAtomic()) {
2657 Assert(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
2658 "Store cannot have Acquire ordering", &SI);
2659 Assert(SI.getAlignment() != 0,
2660 "Atomic store must specify explicit alignment", &SI);
2661 if (!ElTy->isPointerTy()) {
2662 Assert(ElTy->isIntegerTy(),
2663 "atomic store operand must have integer type!", &SI, ElTy);
2664 unsigned Size = ElTy->getPrimitiveSizeInBits();
2665 Assert(Size >= 8 && !(Size & (Size - 1)),
2666 "atomic store operand must be power-of-two byte-sized integer",
2670 Assert(SI.getSynchScope() == CrossThread,
2671 "Non-atomic store cannot have SynchronizationScope specified", &SI);
2673 visitInstruction(SI);
2676 void Verifier::visitAllocaInst(AllocaInst &AI) {
2677 SmallPtrSet<Type*, 4> Visited;
2678 PointerType *PTy = AI.getType();
2679 Assert(PTy->getAddressSpace() == 0,
2680 "Allocation instruction pointer not in the generic address space!",
2682 Assert(AI.getAllocatedType()->isSized(&Visited),
2683 "Cannot allocate unsized type", &AI);
2684 Assert(AI.getArraySize()->getType()->isIntegerTy(),
2685 "Alloca array size must have integer type", &AI);
2686 Assert(AI.getAlignment() <= Value::MaximumAlignment,
2687 "huge alignment values are unsupported", &AI);
2689 visitInstruction(AI);
2692 void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
2694 // FIXME: more conditions???
2695 Assert(CXI.getSuccessOrdering() != NotAtomic,
2696 "cmpxchg instructions must be atomic.", &CXI);
2697 Assert(CXI.getFailureOrdering() != NotAtomic,
2698 "cmpxchg instructions must be atomic.", &CXI);
2699 Assert(CXI.getSuccessOrdering() != Unordered,
2700 "cmpxchg instructions cannot be unordered.", &CXI);
2701 Assert(CXI.getFailureOrdering() != Unordered,
2702 "cmpxchg instructions cannot be unordered.", &CXI);
2703 Assert(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
2704 "cmpxchg instructions be at least as constrained on success as fail",
2706 Assert(CXI.getFailureOrdering() != Release &&
2707 CXI.getFailureOrdering() != AcquireRelease,
2708 "cmpxchg failure ordering cannot include release semantics", &CXI);
2710 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
2711 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
2712 Type *ElTy = PTy->getElementType();
2713 Assert(ElTy->isIntegerTy(), "cmpxchg operand must have integer type!", &CXI,
2715 unsigned Size = ElTy->getPrimitiveSizeInBits();
2716 Assert(Size >= 8 && !(Size & (Size - 1)),
2717 "cmpxchg operand must be power-of-two byte-sized integer", &CXI, ElTy);
2718 Assert(ElTy == CXI.getOperand(1)->getType(),
2719 "Expected value type does not match pointer operand type!", &CXI,
2721 Assert(ElTy == CXI.getOperand(2)->getType(),
2722 "Stored value type does not match pointer operand type!", &CXI, ElTy);
2723 visitInstruction(CXI);
2726 void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
2727 Assert(RMWI.getOrdering() != NotAtomic,
2728 "atomicrmw instructions must be atomic.", &RMWI);
2729 Assert(RMWI.getOrdering() != Unordered,
2730 "atomicrmw instructions cannot be unordered.", &RMWI);
2731 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
2732 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
2733 Type *ElTy = PTy->getElementType();
2734 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
2736 unsigned Size = ElTy->getPrimitiveSizeInBits();
2737 Assert(Size >= 8 && !(Size & (Size - 1)),
2738 "atomicrmw operand must be power-of-two byte-sized integer", &RMWI,
2740 Assert(ElTy == RMWI.getOperand(1)->getType(),
2741 "Argument value type does not match pointer operand type!", &RMWI,
2743 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
2744 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
2745 "Invalid binary operation!", &RMWI);
2746 visitInstruction(RMWI);
2749 void Verifier::visitFenceInst(FenceInst &FI) {
2750 const AtomicOrdering Ordering = FI.getOrdering();
2751 Assert(Ordering == Acquire || Ordering == Release ||
2752 Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
2753 "fence instructions may only have "
2754 "acquire, release, acq_rel, or seq_cst ordering.",
2756 visitInstruction(FI);
2759 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
2760 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
2761 EVI.getIndices()) == EVI.getType(),
2762 "Invalid ExtractValueInst operands!", &EVI);
2764 visitInstruction(EVI);
2767 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
2768 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
2769 IVI.getIndices()) ==
2770 IVI.getOperand(1)->getType(),
2771 "Invalid InsertValueInst operands!", &IVI);
2773 visitInstruction(IVI);
2776 void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
2777 BasicBlock *BB = LPI.getParent();
2779 // The landingpad instruction is ill-formed if it doesn't have any clauses and
2781 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
2782 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
2784 // The landingpad instruction defines its parent as a landing pad block. The
2785 // landing pad block may be branched to only by the unwind edge of an invoke.
2786 for (pred_iterator I = pred_begin(BB), E = pred_end(BB); I != E; ++I) {
2787 const InvokeInst *II = dyn_cast<InvokeInst>((*I)->getTerminator());
2788 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
2789 "Block containing LandingPadInst must be jumped to "
2790 "only by the unwind edge of an invoke.",
2794 if (!LandingPadResultTy)
2795 LandingPadResultTy = LPI.getType();
2797 Assert(LandingPadResultTy == LPI.getType(),
2798 "The landingpad instruction should have a consistent result type "
2799 "inside a function.",
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::visitCatchPadInst(CatchPadInst &CPI) {
2828 BasicBlock *BB = CPI.getParent();
2830 if (!CatchPadResultTy)
2831 CatchPadResultTy = CPI.getType();
2833 Assert(CatchPadResultTy == CPI.getType(),
2834 "The catchpad instruction should have a consistent result type "
2835 "inside a function.",
2838 Function *F = BB->getParent();
2839 Assert(F->hasPersonalityFn(),
2840 "CatchPadInst needs to be in a function with a personality.", &CPI);
2842 // The catchpad instruction must be the first non-PHI instruction in the
2844 Assert(BB->getFirstNonPHI() == &CPI,
2845 "CatchPadInst not the first non-PHI instruction in the block.",
2848 BasicBlock *UnwindDest = CPI.getUnwindDest();
2849 Instruction *I = UnwindDest->getFirstNonPHI();
2851 isa<CatchPadInst>(I) || isa<CatchEndPadInst>(I),
2852 "CatchPadInst must unwind to a CatchPadInst or a CatchEndPadInst.",
2855 visitTerminatorInst(CPI);
2858 void Verifier::visitCatchEndPadInst(CatchEndPadInst &CEPI) {
2859 BasicBlock *BB = CEPI.getParent();
2861 Function *F = BB->getParent();
2862 Assert(F->hasPersonalityFn(),
2863 "CatchEndPadInst needs to be in a function with a personality.",
2866 // The catchendpad instruction must be the first non-PHI instruction in the
2868 Assert(BB->getFirstNonPHI() == &CEPI,
2869 "CatchEndPadInst not the first non-PHI instruction in the block.",
2872 unsigned CatchPadsSeen = 0;
2873 for (BasicBlock *PredBB : predecessors(BB))
2874 if (isa<CatchPadInst>(PredBB->getTerminator()))
2877 Assert(CatchPadsSeen <= 1, "CatchEndPadInst must have no more than one "
2878 "CatchPadInst predecessor.",
2881 if (BasicBlock *UnwindDest = CEPI.getUnwindDest()) {
2882 Instruction *I = UnwindDest->getFirstNonPHI();
2884 I->isEHPad() && !isa<LandingPadInst>(I),
2885 "CatchEndPad must unwind to an EH block which is not a landingpad.",
2889 visitTerminatorInst(CEPI);
2892 void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
2893 BasicBlock *BB = CPI.getParent();
2895 if (!CleanupPadResultTy)
2896 CleanupPadResultTy = CPI.getType();
2898 Assert(CleanupPadResultTy == CPI.getType(),
2899 "The cleanuppad instruction should have a consistent result type "
2900 "inside a function.",
2903 Function *F = BB->getParent();
2904 Assert(F->hasPersonalityFn(),
2905 "CleanupPadInst needs to be in a function with a personality.", &CPI);
2907 // The cleanuppad instruction must be the first non-PHI instruction in the
2909 Assert(BB->getFirstNonPHI() == &CPI,
2910 "CleanupPadInst not the first non-PHI instruction in the block.",
2913 visitInstruction(CPI);
2916 void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
2917 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
2918 Instruction *I = UnwindDest->getFirstNonPHI();
2919 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
2920 "CleanupReturnInst must unwind to an EH block which is not a "
2925 visitTerminatorInst(CRI);
2928 void Verifier::visitTerminatePadInst(TerminatePadInst &TPI) {
2929 BasicBlock *BB = TPI.getParent();
2931 Function *F = BB->getParent();
2932 Assert(F->hasPersonalityFn(),
2933 "TerminatePadInst needs to be in a function with a personality.",
2936 // The terminatepad instruction must be the first non-PHI instruction in the
2938 Assert(BB->getFirstNonPHI() == &TPI,
2939 "TerminatePadInst not the first non-PHI instruction in the block.",
2942 if (BasicBlock *UnwindDest = TPI.getUnwindDest()) {
2943 Instruction *I = UnwindDest->getFirstNonPHI();
2944 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
2945 "TerminatePadInst must unwind to an EH block which is not a "
2950 visitTerminatorInst(TPI);
2953 void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
2954 Instruction *Op = cast<Instruction>(I.getOperand(i));
2955 // If the we have an invalid invoke, don't try to compute the dominance.
2956 // We already reject it in the invoke specific checks and the dominance
2957 // computation doesn't handle multiple edges.
2958 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
2959 if (II->getNormalDest() == II->getUnwindDest())
2963 const Use &U = I.getOperandUse(i);
2964 Assert(InstsInThisBlock.count(Op) || DT.dominates(Op, U),
2965 "Instruction does not dominate all uses!", Op, &I);
2968 /// verifyInstruction - Verify that an instruction is well formed.
2970 void Verifier::visitInstruction(Instruction &I) {
2971 BasicBlock *BB = I.getParent();
2972 Assert(BB, "Instruction not embedded in basic block!", &I);
2974 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
2975 for (User *U : I.users()) {
2976 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
2977 "Only PHI nodes may reference their own value!", &I);
2981 // Check that void typed values don't have names
2982 Assert(!I.getType()->isVoidTy() || !I.hasName(),
2983 "Instruction has a name, but provides a void value!", &I);
2985 // Check that the return value of the instruction is either void or a legal
2987 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
2988 "Instruction returns a non-scalar type!", &I);
2990 // Check that the instruction doesn't produce metadata. Calls are already
2991 // checked against the callee type.
2992 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
2993 "Invalid use of metadata!", &I);
2995 // Check that all uses of the instruction, if they are instructions
2996 // themselves, actually have parent basic blocks. If the use is not an
2997 // instruction, it is an error!
2998 for (Use &U : I.uses()) {
2999 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
3000 Assert(Used->getParent() != nullptr,
3001 "Instruction referencing"
3002 " instruction not embedded in a basic block!",
3005 CheckFailed("Use of instruction is not an instruction!", U);
3010 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
3011 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
3013 // Check to make sure that only first-class-values are operands to
3015 if (!I.getOperand(i)->getType()->isFirstClassType()) {
3016 Assert(0, "Instruction operands must be first-class values!", &I);
3019 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
3020 // Check to make sure that the "address of" an intrinsic function is never
3023 !F->isIntrinsic() ||
3024 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3025 "Cannot take the address of an intrinsic!", &I);
3027 !F->isIntrinsic() || isa<CallInst>(I) ||
3028 F->getIntrinsicID() == Intrinsic::donothing ||
3029 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
3030 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3031 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
3032 "Cannot invoke an intrinsinc other than"
3033 " donothing or patchpoint",
3035 Assert(F->getParent() == M, "Referencing function in another module!",
3037 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
3038 Assert(OpBB->getParent() == BB->getParent(),
3039 "Referring to a basic block in another function!", &I);
3040 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
3041 Assert(OpArg->getParent() == BB->getParent(),
3042 "Referring to an argument in another function!", &I);
3043 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
3044 Assert(GV->getParent() == M, "Referencing global in another module!", &I);
3045 } else if (isa<Instruction>(I.getOperand(i))) {
3046 verifyDominatesUse(I, i);
3047 } else if (isa<InlineAsm>(I.getOperand(i))) {
3048 Assert((i + 1 == e && isa<CallInst>(I)) ||
3049 (i + 3 == e && isa<InvokeInst>(I)),
3050 "Cannot take the address of an inline asm!", &I);
3051 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
3052 if (CE->getType()->isPtrOrPtrVectorTy()) {
3053 // If we have a ConstantExpr pointer, we need to see if it came from an
3054 // illegal bitcast (inttoptr <constant int> )
3055 SmallVector<const ConstantExpr *, 4> Stack;
3056 SmallPtrSet<const ConstantExpr *, 4> Visited;
3057 Stack.push_back(CE);
3059 while (!Stack.empty()) {
3060 const ConstantExpr *V = Stack.pop_back_val();
3061 if (!Visited.insert(V).second)
3064 VerifyConstantExprBitcastType(V);
3066 for (unsigned I = 0, N = V->getNumOperands(); I != N; ++I) {
3067 if (ConstantExpr *Op = dyn_cast<ConstantExpr>(V->getOperand(I)))
3068 Stack.push_back(Op);
3075 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
3076 Assert(I.getType()->isFPOrFPVectorTy(),
3077 "fpmath requires a floating point result!", &I);
3078 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
3079 if (ConstantFP *CFP0 =
3080 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
3081 APFloat Accuracy = CFP0->getValueAPF();
3082 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3083 "fpmath accuracy not a positive number!", &I);
3085 Assert(false, "invalid fpmath accuracy!", &I);
3089 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
3090 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3091 "Ranges are only for loads, calls and invokes!", &I);
3092 visitRangeMetadata(I, Range, I.getType());
3095 if (I.getMetadata(LLVMContext::MD_nonnull)) {
3096 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3098 Assert(isa<LoadInst>(I),
3099 "nonnull applies only to load instructions, use attributes"
3100 " for calls or invokes",
3104 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
3105 Assert(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
3109 InstsInThisBlock.insert(&I);
3112 /// VerifyIntrinsicType - Verify that the specified type (which comes from an
3113 /// intrinsic argument or return value) matches the type constraints specified
3114 /// by the .td file (e.g. an "any integer" argument really is an integer).
3116 /// This return true on error but does not print a message.
3117 bool Verifier::VerifyIntrinsicType(Type *Ty,
3118 ArrayRef<Intrinsic::IITDescriptor> &Infos,
3119 SmallVectorImpl<Type*> &ArgTys) {
3120 using namespace Intrinsic;
3122 // If we ran out of descriptors, there are too many arguments.
3123 if (Infos.empty()) return true;
3124 IITDescriptor D = Infos.front();
3125 Infos = Infos.slice(1);
3128 case IITDescriptor::Void: return !Ty->isVoidTy();
3129 case IITDescriptor::VarArg: return true;
3130 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
3131 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
3132 case IITDescriptor::Half: return !Ty->isHalfTy();
3133 case IITDescriptor::Float: return !Ty->isFloatTy();
3134 case IITDescriptor::Double: return !Ty->isDoubleTy();
3135 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
3136 case IITDescriptor::Vector: {
3137 VectorType *VT = dyn_cast<VectorType>(Ty);
3138 return !VT || VT->getNumElements() != D.Vector_Width ||
3139 VerifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
3141 case IITDescriptor::Pointer: {
3142 PointerType *PT = dyn_cast<PointerType>(Ty);
3143 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
3144 VerifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
3147 case IITDescriptor::Struct: {
3148 StructType *ST = dyn_cast<StructType>(Ty);
3149 if (!ST || ST->getNumElements() != D.Struct_NumElements)
3152 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
3153 if (VerifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
3158 case IITDescriptor::Argument:
3159 // Two cases here - If this is the second occurrence of an argument, verify
3160 // that the later instance matches the previous instance.
3161 if (D.getArgumentNumber() < ArgTys.size())
3162 return Ty != ArgTys[D.getArgumentNumber()];
3164 // Otherwise, if this is the first instance of an argument, record it and
3165 // verify the "Any" kind.
3166 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
3167 ArgTys.push_back(Ty);
3169 switch (D.getArgumentKind()) {
3170 case IITDescriptor::AK_Any: return false; // Success
3171 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
3172 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
3173 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
3174 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
3176 llvm_unreachable("all argument kinds not covered");
3178 case IITDescriptor::ExtendArgument: {
3179 // This may only be used when referring to a previous vector argument.
3180 if (D.getArgumentNumber() >= ArgTys.size())
3183 Type *NewTy = ArgTys[D.getArgumentNumber()];
3184 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3185 NewTy = VectorType::getExtendedElementVectorType(VTy);
3186 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3187 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
3193 case IITDescriptor::TruncArgument: {
3194 // This may only be used when referring to a previous vector argument.
3195 if (D.getArgumentNumber() >= ArgTys.size())
3198 Type *NewTy = ArgTys[D.getArgumentNumber()];
3199 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3200 NewTy = VectorType::getTruncatedElementVectorType(VTy);
3201 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3202 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
3208 case IITDescriptor::HalfVecArgument:
3209 // This may only be used when referring to a previous vector argument.
3210 return D.getArgumentNumber() >= ArgTys.size() ||
3211 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
3212 VectorType::getHalfElementsVectorType(
3213 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
3214 case IITDescriptor::SameVecWidthArgument: {
3215 if (D.getArgumentNumber() >= ArgTys.size())
3217 VectorType * ReferenceType =
3218 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
3219 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
3220 if (!ThisArgType || !ReferenceType ||
3221 (ReferenceType->getVectorNumElements() !=
3222 ThisArgType->getVectorNumElements()))
3224 return VerifyIntrinsicType(ThisArgType->getVectorElementType(),
3227 case IITDescriptor::PtrToArgument: {
3228 if (D.getArgumentNumber() >= ArgTys.size())
3230 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
3231 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
3232 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
3234 case IITDescriptor::VecOfPtrsToElt: {
3235 if (D.getArgumentNumber() >= ArgTys.size())
3237 VectorType * ReferenceType =
3238 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
3239 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
3240 if (!ThisArgVecTy || !ReferenceType ||
3241 (ReferenceType->getVectorNumElements() !=
3242 ThisArgVecTy->getVectorNumElements()))
3244 PointerType *ThisArgEltTy =
3245 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
3248 return ThisArgEltTy->getElementType() !=
3249 ReferenceType->getVectorElementType();
3252 llvm_unreachable("unhandled");
3255 /// \brief Verify if the intrinsic has variable arguments.
3256 /// This method is intended to be called after all the fixed arguments have been
3259 /// This method returns true on error and does not print an error message.
3261 Verifier::VerifyIntrinsicIsVarArg(bool isVarArg,
3262 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
3263 using namespace Intrinsic;
3265 // If there are no descriptors left, then it can't be a vararg.
3269 // There should be only one descriptor remaining at this point.
3270 if (Infos.size() != 1)
3273 // Check and verify the descriptor.
3274 IITDescriptor D = Infos.front();
3275 Infos = Infos.slice(1);
3276 if (D.Kind == IITDescriptor::VarArg)
3282 /// Allow intrinsics to be verified in different ways.
3283 void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
3284 Function *IF = CS.getCalledFunction();
3285 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3288 // Verify that the intrinsic prototype lines up with what the .td files
3290 FunctionType *IFTy = IF->getFunctionType();
3291 bool IsVarArg = IFTy->isVarArg();
3293 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3294 getIntrinsicInfoTableEntries(ID, Table);
3295 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
3297 SmallVector<Type *, 4> ArgTys;
3298 Assert(!VerifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
3299 "Intrinsic has incorrect return type!", IF);
3300 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
3301 Assert(!VerifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
3302 "Intrinsic has incorrect argument type!", IF);
3304 // Verify if the intrinsic call matches the vararg property.
3306 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3307 "Intrinsic was not defined with variable arguments!", IF);
3309 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3310 "Callsite was not defined with variable arguments!", IF);
3312 // All descriptors should be absorbed by now.
3313 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
3315 // Now that we have the intrinsic ID and the actual argument types (and we
3316 // know they are legal for the intrinsic!) get the intrinsic name through the
3317 // usual means. This allows us to verify the mangling of argument types into
3319 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
3320 Assert(ExpectedName == IF->getName(),
3321 "Intrinsic name not mangled correctly for type arguments! "
3326 // If the intrinsic takes MDNode arguments, verify that they are either global
3327 // or are local to *this* function.
3328 for (Value *V : CS.args())
3329 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3330 visitMetadataAsValue(*MD, CS.getCaller());
3335 case Intrinsic::ctlz: // llvm.ctlz
3336 case Intrinsic::cttz: // llvm.cttz
3337 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3338 "is_zero_undef argument of bit counting intrinsics must be a "
3342 case Intrinsic::dbg_declare: // llvm.dbg.declare
3343 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3344 "invalid llvm.dbg.declare intrinsic call 1", CS);
3345 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
3347 case Intrinsic::dbg_value: // llvm.dbg.value
3348 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
3350 case Intrinsic::memcpy:
3351 case Intrinsic::memmove:
3352 case Intrinsic::memset: {
3353 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
3355 "alignment argument of memory intrinsics must be a constant int",
3357 const APInt &AlignVal = AlignCI->getValue();
3358 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
3359 "alignment argument of memory intrinsics must be a power of 2", CS);
3360 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
3361 "isvolatile argument of memory intrinsics must be a constant int",
3365 case Intrinsic::gcroot:
3366 case Intrinsic::gcwrite:
3367 case Intrinsic::gcread:
3368 if (ID == Intrinsic::gcroot) {
3370 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3371 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3372 Assert(isa<Constant>(CS.getArgOperand(1)),
3373 "llvm.gcroot parameter #2 must be a constant.", CS);
3374 if (!AI->getAllocatedType()->isPointerTy()) {
3375 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
3376 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3377 "or argument #2 must be a non-null constant.",
3382 Assert(CS.getParent()->getParent()->hasGC(),
3383 "Enclosing function does not use GC.", CS);
3385 case Intrinsic::init_trampoline:
3386 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
3387 "llvm.init_trampoline parameter #2 must resolve to a function.",
3390 case Intrinsic::prefetch:
3391 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
3392 isa<ConstantInt>(CS.getArgOperand(2)) &&
3393 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
3394 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
3395 "invalid arguments to llvm.prefetch", CS);
3397 case Intrinsic::stackprotector:
3398 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
3399 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
3401 case Intrinsic::lifetime_start:
3402 case Intrinsic::lifetime_end:
3403 case Intrinsic::invariant_start:
3404 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
3405 "size argument of memory use markers must be a constant integer",
3408 case Intrinsic::invariant_end:
3409 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3410 "llvm.invariant.end parameter #2 must be a constant integer", CS);
3413 case Intrinsic::localescape: {
3414 BasicBlock *BB = CS.getParent();
3415 Assert(BB == &BB->getParent()->front(),
3416 "llvm.localescape used outside of entry block", CS);
3417 Assert(!SawFrameEscape,
3418 "multiple calls to llvm.localescape in one function", CS);
3419 for (Value *Arg : CS.args()) {
3420 if (isa<ConstantPointerNull>(Arg))
3421 continue; // Null values are allowed as placeholders.
3422 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
3423 Assert(AI && AI->isStaticAlloca(),
3424 "llvm.localescape only accepts static allocas", CS);
3426 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
3427 SawFrameEscape = true;
3430 case Intrinsic::localrecover: {
3431 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
3432 Function *Fn = dyn_cast<Function>(FnArg);
3433 Assert(Fn && !Fn->isDeclaration(),
3434 "llvm.localrecover first "
3435 "argument must be function defined in this module",
3437 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
3438 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
3440 auto &Entry = FrameEscapeInfo[Fn];
3441 Entry.second = unsigned(
3442 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
3446 case Intrinsic::experimental_gc_statepoint:
3447 Assert(!CS.isInlineAsm(),
3448 "gc.statepoint support for inline assembly unimplemented", CS);
3449 Assert(CS.getParent()->getParent()->hasGC(),
3450 "Enclosing function does not use GC.", CS);
3452 VerifyStatepoint(CS);
3454 case Intrinsic::experimental_gc_result_int:
3455 case Intrinsic::experimental_gc_result_float:
3456 case Intrinsic::experimental_gc_result_ptr:
3457 case Intrinsic::experimental_gc_result: {
3458 Assert(CS.getParent()->getParent()->hasGC(),
3459 "Enclosing function does not use GC.", CS);
3460 // Are we tied to a statepoint properly?
3461 CallSite StatepointCS(CS.getArgOperand(0));
3462 const Function *StatepointFn =
3463 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
3464 Assert(StatepointFn && StatepointFn->isDeclaration() &&
3465 StatepointFn->getIntrinsicID() ==
3466 Intrinsic::experimental_gc_statepoint,
3467 "gc.result operand #1 must be from a statepoint", CS,
3468 CS.getArgOperand(0));
3470 // Assert that result type matches wrapped callee.
3471 const Value *Target = StatepointCS.getArgument(2);
3472 auto *PT = cast<PointerType>(Target->getType());
3473 auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
3474 Assert(CS.getType() == TargetFuncType->getReturnType(),
3475 "gc.result result type does not match wrapped callee", CS);
3478 case Intrinsic::experimental_gc_relocate: {
3479 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
3481 // Check that this relocate is correctly tied to the statepoint
3483 // This is case for relocate on the unwinding path of an invoke statepoint
3484 if (ExtractValueInst *ExtractValue =
3485 dyn_cast<ExtractValueInst>(CS.getArgOperand(0))) {
3486 Assert(isa<LandingPadInst>(ExtractValue->getAggregateOperand()),
3487 "gc relocate on unwind path incorrectly linked to the statepoint",
3490 const BasicBlock *InvokeBB =
3491 ExtractValue->getParent()->getUniquePredecessor();
3493 // Landingpad relocates should have only one predecessor with invoke
3494 // statepoint terminator
3495 Assert(InvokeBB, "safepoints should have unique landingpads",
3496 ExtractValue->getParent());
3497 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
3499 Assert(isStatepoint(InvokeBB->getTerminator()),
3500 "gc relocate should be linked to a statepoint", InvokeBB);
3503 // In all other cases relocate should be tied to the statepoint directly.
3504 // This covers relocates on a normal return path of invoke statepoint and
3505 // relocates of a call statepoint
3506 auto Token = CS.getArgOperand(0);
3507 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
3508 "gc relocate is incorrectly tied to the statepoint", CS, Token);
3511 // Verify rest of the relocate arguments
3513 GCRelocateOperands Ops(CS);
3514 ImmutableCallSite StatepointCS(Ops.getStatepoint());
3516 // Both the base and derived must be piped through the safepoint
3517 Value* Base = CS.getArgOperand(1);
3518 Assert(isa<ConstantInt>(Base),
3519 "gc.relocate operand #2 must be integer offset", CS);
3521 Value* Derived = CS.getArgOperand(2);
3522 Assert(isa<ConstantInt>(Derived),
3523 "gc.relocate operand #3 must be integer offset", CS);
3525 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
3526 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
3528 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
3529 "gc.relocate: statepoint base index out of bounds", CS);
3530 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
3531 "gc.relocate: statepoint derived index out of bounds", CS);
3533 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
3534 // section of the statepoint's argument
3535 Assert(StatepointCS.arg_size() > 0,
3536 "gc.statepoint: insufficient arguments");
3537 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
3538 "gc.statement: number of call arguments must be constant integer");
3539 const unsigned NumCallArgs =
3540 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
3541 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
3542 "gc.statepoint: mismatch in number of call arguments");
3543 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
3544 "gc.statepoint: number of transition arguments must be "
3545 "a constant integer");
3546 const int NumTransitionArgs =
3547 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
3549 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
3550 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
3551 "gc.statepoint: number of deoptimization arguments must be "
3552 "a constant integer");
3553 const int NumDeoptArgs =
3554 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))->getZExtValue();
3555 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
3556 const int GCParamArgsEnd = StatepointCS.arg_size();
3557 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
3558 "gc.relocate: statepoint base index doesn't fall within the "
3559 "'gc parameters' section of the statepoint call",
3561 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
3562 "gc.relocate: statepoint derived index doesn't fall within the "
3563 "'gc parameters' section of the statepoint call",
3566 // Relocated value must be a pointer type, but gc_relocate does not need to return the
3567 // same pointer type as the relocated pointer. It can be casted to the correct type later
3568 // if it's desired. However, they must have the same address space.
3569 GCRelocateOperands Operands(CS);
3570 Assert(Operands.getDerivedPtr()->getType()->isPointerTy(),
3571 "gc.relocate: relocated value must be a gc pointer", CS);
3573 // gc_relocate return type must be a pointer type, and is verified earlier in
3574 // VerifyIntrinsicType().
3575 Assert(cast<PointerType>(CS.getType())->getAddressSpace() ==
3576 cast<PointerType>(Operands.getDerivedPtr()->getType())->getAddressSpace(),
3577 "gc.relocate: relocating a pointer shouldn't change its address space", CS);
3583 /// \brief Carefully grab the subprogram from a local scope.
3585 /// This carefully grabs the subprogram from a local scope, avoiding the
3586 /// built-in assertions that would typically fire.
3587 static DISubprogram *getSubprogram(Metadata *LocalScope) {
3591 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
3594 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
3595 return getSubprogram(LB->getRawScope());
3597 // Just return null; broken scope chains are checked elsewhere.
3598 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
3602 template <class DbgIntrinsicTy>
3603 void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
3604 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
3605 Assert(isa<ValueAsMetadata>(MD) ||
3606 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
3607 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
3608 Assert(isa<DILocalVariable>(DII.getRawVariable()),
3609 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
3610 DII.getRawVariable());
3611 Assert(isa<DIExpression>(DII.getRawExpression()),
3612 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
3613 DII.getRawExpression());
3615 // Ignore broken !dbg attachments; they're checked elsewhere.
3616 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
3617 if (!isa<DILocation>(N))
3620 BasicBlock *BB = DII.getParent();
3621 Function *F = BB ? BB->getParent() : nullptr;
3623 // The scopes for variables and !dbg attachments must agree.
3624 DILocalVariable *Var = DII.getVariable();
3625 DILocation *Loc = DII.getDebugLoc();
3626 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
3629 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
3630 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
3631 if (!VarSP || !LocSP)
3632 return; // Broken scope chains are checked elsewhere.
3634 Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
3635 " variable and !dbg attachment",
3636 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
3637 Loc->getScope()->getSubprogram());
3640 template <class MapTy>
3641 static uint64_t getVariableSize(const DILocalVariable &V, const MapTy &Map) {
3642 // Be careful of broken types (checked elsewhere).
3643 const Metadata *RawType = V.getRawType();
3645 // Try to get the size directly.
3646 if (auto *T = dyn_cast<DIType>(RawType))
3647 if (uint64_t Size = T->getSizeInBits())
3650 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
3651 // Look at the base type.
3652 RawType = DT->getRawBaseType();
3656 if (auto *S = dyn_cast<MDString>(RawType)) {
3657 // Don't error on missing types (checked elsewhere).
3658 RawType = Map.lookup(S);
3662 // Missing type or size.
3670 template <class MapTy>
3671 void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I,
3672 const MapTy &TypeRefs) {
3675 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
3676 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
3677 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
3679 auto *DDI = cast<DbgDeclareInst>(&I);
3680 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
3681 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
3684 // We don't know whether this intrinsic verified correctly.
3685 if (!V || !E || !E->isValid())
3688 // Nothing to do if this isn't a bit piece expression.
3689 if (!E->isBitPiece())
3692 // The frontend helps out GDB by emitting the members of local anonymous
3693 // unions as artificial local variables with shared storage. When SROA splits
3694 // the storage for artificial local variables that are smaller than the entire
3695 // union, the overhang piece will be outside of the allotted space for the
3696 // variable and this check fails.
3697 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
3698 if (V->isArtificial())
3701 // If there's no size, the type is broken, but that should be checked
3703 uint64_t VarSize = getVariableSize(*V, TypeRefs);
3707 unsigned PieceSize = E->getBitPieceSize();
3708 unsigned PieceOffset = E->getBitPieceOffset();
3709 Assert(PieceSize + PieceOffset <= VarSize,
3710 "piece is larger than or outside of variable", &I, V, E);
3711 Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
3714 void Verifier::visitUnresolvedTypeRef(const MDString *S, const MDNode *N) {
3715 // This is in its own function so we get an error for each bad type ref (not
3717 Assert(false, "unresolved type ref", S, N);
3720 void Verifier::verifyTypeRefs() {
3721 auto *CUs = M->getNamedMetadata("llvm.dbg.cu");
3725 // Visit all the compile units again to map the type references.
3726 SmallDenseMap<const MDString *, const DIType *, 32> TypeRefs;
3727 for (auto *CU : CUs->operands())
3728 if (auto Ts = cast<DICompileUnit>(CU)->getRetainedTypes())
3729 for (DIType *Op : Ts)
3730 if (auto *T = dyn_cast<DICompositeType>(Op))
3731 if (auto *S = T->getRawIdentifier()) {
3732 UnresolvedTypeRefs.erase(S);
3733 TypeRefs.insert(std::make_pair(S, T));
3736 // Verify debug info intrinsic bit piece expressions. This needs a second
3737 // pass through the intructions, since we haven't built TypeRefs yet when
3738 // verifying functions, and simply queuing the DbgInfoIntrinsics to evaluate
3739 // later/now would queue up some that could be later deleted.
3740 for (const Function &F : *M)
3741 for (const BasicBlock &BB : F)
3742 for (const Instruction &I : BB)
3743 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
3744 verifyBitPieceExpression(*DII, TypeRefs);
3746 // Return early if all typerefs were resolved.
3747 if (UnresolvedTypeRefs.empty())
3750 // Sort the unresolved references by name so the output is deterministic.
3751 typedef std::pair<const MDString *, const MDNode *> TypeRef;
3752 SmallVector<TypeRef, 32> Unresolved(UnresolvedTypeRefs.begin(),
3753 UnresolvedTypeRefs.end());
3754 std::sort(Unresolved.begin(), Unresolved.end(),
3755 [](const TypeRef &LHS, const TypeRef &RHS) {
3756 return LHS.first->getString() < RHS.first->getString();
3759 // Visit the unresolved refs (printing out the errors).
3760 for (const TypeRef &TR : Unresolved)
3761 visitUnresolvedTypeRef(TR.first, TR.second);
3764 //===----------------------------------------------------------------------===//
3765 // Implement the public interfaces to this file...
3766 //===----------------------------------------------------------------------===//
3768 bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
3769 Function &F = const_cast<Function &>(f);
3770 assert(!F.isDeclaration() && "Cannot verify external functions");
3772 raw_null_ostream NullStr;
3773 Verifier V(OS ? *OS : NullStr);
3775 // Note that this function's return value is inverted from what you would
3776 // expect of a function called "verify".
3777 return !V.verify(F);
3780 bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
3781 raw_null_ostream NullStr;
3782 Verifier V(OS ? *OS : NullStr);
3784 bool Broken = false;
3785 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
3786 if (!I->isDeclaration() && !I->isMaterializable())
3787 Broken |= !V.verify(*I);
3789 // Note that this function's return value is inverted from what you would
3790 // expect of a function called "verify".
3791 return !V.verify(M) || Broken;
3795 struct VerifierLegacyPass : public FunctionPass {
3801 VerifierLegacyPass() : FunctionPass(ID), V(dbgs()), FatalErrors(true) {
3802 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3804 explicit VerifierLegacyPass(bool FatalErrors)
3805 : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
3806 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3809 bool runOnFunction(Function &F) override {
3810 if (!V.verify(F) && FatalErrors)
3811 report_fatal_error("Broken function found, compilation aborted!");
3816 bool doFinalization(Module &M) override {
3817 if (!V.verify(M) && FatalErrors)
3818 report_fatal_error("Broken module found, compilation aborted!");
3823 void getAnalysisUsage(AnalysisUsage &AU) const override {
3824 AU.setPreservesAll();
3829 char VerifierLegacyPass::ID = 0;
3830 INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
3832 FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
3833 return new VerifierLegacyPass(FatalErrors);
3836 PreservedAnalyses VerifierPass::run(Module &M) {
3837 if (verifyModule(M, &dbgs()) && FatalErrors)
3838 report_fatal_error("Broken module found, compilation aborted!");
3840 return PreservedAnalyses::all();
3843 PreservedAnalyses VerifierPass::run(Function &F) {
3844 if (verifyFunction(F, &dbgs()) && FatalErrors)
3845 report_fatal_error("Broken function found, compilation aborted!");
3847 return PreservedAnalyses::all();