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);
106 void Write(const Metadata *MD) {
113 template <class T> void Write(const MDTupleTypedArrayWrapper<T> &MD) {
117 void Write(const NamedMDNode *NMD) {
124 void Write(Type *T) {
130 void Write(const Comdat *C) {
136 template <typename T1, typename... Ts>
137 void WriteTs(const T1 &V1, const Ts &... Vs) {
142 template <typename... Ts> void WriteTs() {}
145 /// \brief A check failed, so printout out the condition and the message.
147 /// This provides a nice place to put a breakpoint if you want to see why
148 /// something is not correct.
149 void CheckFailed(const Twine &Message) {
150 OS << Message << '\n';
154 /// \brief A check failed (with values to print).
156 /// This calls the Message-only version so that the above is easier to set a
158 template <typename T1, typename... Ts>
159 void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) {
160 CheckFailed(Message);
165 class Verifier : public InstVisitor<Verifier>, VerifierSupport {
166 friend class InstVisitor<Verifier>;
168 LLVMContext *Context;
171 /// \brief When verifying a basic block, keep track of all of the
172 /// instructions we have seen so far.
174 /// This allows us to do efficient dominance checks for the case when an
175 /// instruction has an operand that is an instruction in the same block.
176 SmallPtrSet<Instruction *, 16> InstsInThisBlock;
178 /// \brief Keep track of the metadata nodes that have been checked already.
179 SmallPtrSet<const Metadata *, 32> MDNodes;
181 /// \brief Track unresolved string-based type references.
182 SmallDenseMap<const MDString *, const MDNode *, 32> UnresolvedTypeRefs;
184 /// \brief The personality function referenced by the LandingPadInsts.
185 /// All LandingPadInsts within the same function must use the same
186 /// personality function.
187 const Value *PersonalityFn;
189 /// \brief Whether we've seen a call to @llvm.frameescape in this function
193 /// Stores the count of how many objects were passed to llvm.frameescape for a
194 /// given function and the largest index passed to llvm.framerecover.
195 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
198 explicit Verifier(raw_ostream &OS)
199 : VerifierSupport(OS), Context(nullptr), PersonalityFn(nullptr),
200 SawFrameEscape(false) {}
202 bool verify(const Function &F) {
204 Context = &M->getContext();
206 // First ensure the function is well-enough formed to compute dominance
209 OS << "Function '" << F.getName()
210 << "' does not contain an entry block!\n";
213 for (Function::const_iterator I = F.begin(), E = F.end(); I != E; ++I) {
214 if (I->empty() || !I->back().isTerminator()) {
215 OS << "Basic Block in function '" << F.getName()
216 << "' does not have terminator!\n";
217 I->printAsOperand(OS, true);
223 // Now directly compute a dominance tree. We don't rely on the pass
224 // manager to provide this as it isolates us from a potentially
225 // out-of-date dominator tree and makes it significantly more complex to
226 // run this code outside of a pass manager.
227 // FIXME: It's really gross that we have to cast away constness here.
228 DT.recalculate(const_cast<Function &>(F));
231 // FIXME: We strip const here because the inst visitor strips const.
232 visit(const_cast<Function &>(F));
233 InstsInThisBlock.clear();
234 PersonalityFn = nullptr;
235 SawFrameEscape = false;
240 bool verify(const Module &M) {
242 Context = &M.getContext();
245 // Scan through, checking all of the external function's linkage now...
246 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
247 visitGlobalValue(*I);
249 // Check to make sure function prototypes are okay.
250 if (I->isDeclaration())
254 // Now that we've visited every function, verify that we never asked to
255 // recover a frame index that wasn't escaped.
256 verifyFrameRecoverIndices();
258 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
260 visitGlobalVariable(*I);
262 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
264 visitGlobalAlias(*I);
266 for (Module::const_named_metadata_iterator I = M.named_metadata_begin(),
267 E = M.named_metadata_end();
269 visitNamedMDNode(*I);
271 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
272 visitComdat(SMEC.getValue());
275 visitModuleIdents(M);
277 // Verify type referneces last.
284 // Verification methods...
285 void visitGlobalValue(const GlobalValue &GV);
286 void visitGlobalVariable(const GlobalVariable &GV);
287 void visitGlobalAlias(const GlobalAlias &GA);
288 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
289 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
290 const GlobalAlias &A, const Constant &C);
291 void visitNamedMDNode(const NamedMDNode &NMD);
292 void visitMDNode(const MDNode &MD);
293 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
294 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
295 void visitComdat(const Comdat &C);
296 void visitModuleIdents(const Module &M);
297 void visitModuleFlags(const Module &M);
298 void visitModuleFlag(const MDNode *Op,
299 DenseMap<const MDString *, const MDNode *> &SeenIDs,
300 SmallVectorImpl<const MDNode *> &Requirements);
301 void visitFunction(const Function &F);
302 void visitBasicBlock(BasicBlock &BB);
303 void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty);
305 template <class Ty> bool isValidMetadataArray(const MDTuple &N);
306 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
307 #include "llvm/IR/Metadata.def"
308 void visitDIScope(const DIScope &N);
309 void visitDIDerivedTypeBase(const DIDerivedTypeBase &N);
310 void visitDIVariable(const DIVariable &N);
311 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
312 void visitDITemplateParameter(const DITemplateParameter &N);
314 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
316 /// \brief Check for a valid string-based type reference.
318 /// Checks if \c MD is a string-based type reference. If it is, keeps track
319 /// of it (and its user, \c N) for error messages later.
320 bool isValidUUID(const MDNode &N, const Metadata *MD);
322 /// \brief Check for a valid type reference.
324 /// Checks for subclasses of \a DIType, or \a isValidUUID().
325 bool isTypeRef(const MDNode &N, const Metadata *MD);
327 /// \brief Check for a valid scope reference.
329 /// Checks for subclasses of \a DIScope, or \a isValidUUID().
330 bool isScopeRef(const MDNode &N, const Metadata *MD);
332 /// \brief Check for a valid debug info reference.
334 /// Checks for subclasses of \a DINode, or \a isValidUUID().
335 bool isDIRef(const MDNode &N, const Metadata *MD);
337 // InstVisitor overrides...
338 using InstVisitor<Verifier>::visit;
339 void visit(Instruction &I);
341 void visitTruncInst(TruncInst &I);
342 void visitZExtInst(ZExtInst &I);
343 void visitSExtInst(SExtInst &I);
344 void visitFPTruncInst(FPTruncInst &I);
345 void visitFPExtInst(FPExtInst &I);
346 void visitFPToUIInst(FPToUIInst &I);
347 void visitFPToSIInst(FPToSIInst &I);
348 void visitUIToFPInst(UIToFPInst &I);
349 void visitSIToFPInst(SIToFPInst &I);
350 void visitIntToPtrInst(IntToPtrInst &I);
351 void visitPtrToIntInst(PtrToIntInst &I);
352 void visitBitCastInst(BitCastInst &I);
353 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
354 void visitPHINode(PHINode &PN);
355 void visitBinaryOperator(BinaryOperator &B);
356 void visitICmpInst(ICmpInst &IC);
357 void visitFCmpInst(FCmpInst &FC);
358 void visitExtractElementInst(ExtractElementInst &EI);
359 void visitInsertElementInst(InsertElementInst &EI);
360 void visitShuffleVectorInst(ShuffleVectorInst &EI);
361 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
362 void visitCallInst(CallInst &CI);
363 void visitInvokeInst(InvokeInst &II);
364 void visitGetElementPtrInst(GetElementPtrInst &GEP);
365 void visitLoadInst(LoadInst &LI);
366 void visitStoreInst(StoreInst &SI);
367 void verifyDominatesUse(Instruction &I, unsigned i);
368 void visitInstruction(Instruction &I);
369 void visitTerminatorInst(TerminatorInst &I);
370 void visitBranchInst(BranchInst &BI);
371 void visitReturnInst(ReturnInst &RI);
372 void visitSwitchInst(SwitchInst &SI);
373 void visitIndirectBrInst(IndirectBrInst &BI);
374 void visitSelectInst(SelectInst &SI);
375 void visitUserOp1(Instruction &I);
376 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
377 void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
378 template <class DbgIntrinsicTy>
379 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
380 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
381 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
382 void visitFenceInst(FenceInst &FI);
383 void visitAllocaInst(AllocaInst &AI);
384 void visitExtractValueInst(ExtractValueInst &EVI);
385 void visitInsertValueInst(InsertValueInst &IVI);
386 void visitLandingPadInst(LandingPadInst &LPI);
388 void VerifyCallSite(CallSite CS);
389 void verifyMustTailCall(CallInst &CI);
390 bool PerformTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
391 unsigned ArgNo, std::string &Suffix);
392 bool VerifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
393 SmallVectorImpl<Type *> &ArgTys);
394 bool VerifyIntrinsicIsVarArg(bool isVarArg,
395 ArrayRef<Intrinsic::IITDescriptor> &Infos);
396 bool VerifyAttributeCount(AttributeSet Attrs, unsigned Params);
397 void VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
399 void VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
400 bool isReturnValue, const Value *V);
401 void VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
404 void VerifyConstantExprBitcastType(const ConstantExpr *CE);
405 void VerifyStatepoint(ImmutableCallSite CS);
406 void verifyFrameRecoverIndices();
408 // Module-level debug info verification...
409 void verifyTypeRefs();
410 template <class MapTy>
411 void verifyBitPieceExpression(const DbgInfoIntrinsic &I,
412 const MapTy &TypeRefs);
413 void visitUnresolvedTypeRef(const MDString *S, const MDNode *N);
415 } // End anonymous namespace
417 // Assert - We know that cond should be true, if not print an error message.
418 #define Assert(C, ...) \
419 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
421 void Verifier::visit(Instruction &I) {
422 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
423 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
424 InstVisitor<Verifier>::visit(I);
428 void Verifier::visitGlobalValue(const GlobalValue &GV) {
429 Assert(!GV.isDeclaration() || GV.hasExternalLinkage() ||
430 GV.hasExternalWeakLinkage(),
431 "Global is external, but doesn't have external or weak linkage!", &GV);
433 Assert(GV.getAlignment() <= Value::MaximumAlignment,
434 "huge alignment values are unsupported", &GV);
435 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
436 "Only global variables can have appending linkage!", &GV);
438 if (GV.hasAppendingLinkage()) {
439 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
440 Assert(GVar && GVar->getValueType()->isArrayTy(),
441 "Only global arrays can have appending linkage!", GVar);
445 void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
446 if (GV.hasInitializer()) {
447 Assert(GV.getInitializer()->getType() == GV.getType()->getElementType(),
448 "Global variable initializer type does not match global "
452 // If the global has common linkage, it must have a zero initializer and
453 // cannot be constant.
454 if (GV.hasCommonLinkage()) {
455 Assert(GV.getInitializer()->isNullValue(),
456 "'common' global must have a zero initializer!", &GV);
457 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
459 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
462 Assert(GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
463 "invalid linkage type for global declaration", &GV);
466 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
467 GV.getName() == "llvm.global_dtors")) {
468 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
469 "invalid linkage for intrinsic global variable", &GV);
470 // Don't worry about emitting an error for it not being an array,
471 // visitGlobalValue will complain on appending non-array.
472 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
473 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
474 PointerType *FuncPtrTy =
475 FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
476 // FIXME: Reject the 2-field form in LLVM 4.0.
478 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
479 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
480 STy->getTypeAtIndex(1) == FuncPtrTy,
481 "wrong type for intrinsic global variable", &GV);
482 if (STy->getNumElements() == 3) {
483 Type *ETy = STy->getTypeAtIndex(2);
484 Assert(ETy->isPointerTy() &&
485 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
486 "wrong type for intrinsic global variable", &GV);
491 if (GV.hasName() && (GV.getName() == "llvm.used" ||
492 GV.getName() == "llvm.compiler.used")) {
493 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
494 "invalid linkage for intrinsic global variable", &GV);
495 Type *GVType = GV.getType()->getElementType();
496 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
497 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
498 Assert(PTy, "wrong type for intrinsic global variable", &GV);
499 if (GV.hasInitializer()) {
500 const Constant *Init = GV.getInitializer();
501 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
502 Assert(InitArray, "wrong initalizer for intrinsic global variable",
504 for (unsigned i = 0, e = InitArray->getNumOperands(); i != e; ++i) {
505 Value *V = Init->getOperand(i)->stripPointerCastsNoFollowAliases();
506 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
508 "invalid llvm.used member", V);
509 Assert(V->hasName(), "members of llvm.used must be named", V);
515 Assert(!GV.hasDLLImportStorageClass() ||
516 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
517 GV.hasAvailableExternallyLinkage(),
518 "Global is marked as dllimport, but not external", &GV);
520 if (!GV.hasInitializer()) {
521 visitGlobalValue(GV);
525 // Walk any aggregate initializers looking for bitcasts between address spaces
526 SmallPtrSet<const Value *, 4> Visited;
527 SmallVector<const Value *, 4> WorkStack;
528 WorkStack.push_back(cast<Value>(GV.getInitializer()));
530 while (!WorkStack.empty()) {
531 const Value *V = WorkStack.pop_back_val();
532 if (!Visited.insert(V).second)
535 if (const User *U = dyn_cast<User>(V)) {
536 WorkStack.append(U->op_begin(), U->op_end());
539 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
540 VerifyConstantExprBitcastType(CE);
546 visitGlobalValue(GV);
549 void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
550 SmallPtrSet<const GlobalAlias*, 4> Visited;
552 visitAliaseeSubExpr(Visited, GA, C);
555 void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
556 const GlobalAlias &GA, const Constant &C) {
557 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
558 Assert(!GV->isDeclaration(), "Alias must point to a definition", &GA);
560 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
561 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
563 Assert(!GA2->mayBeOverridden(), "Alias cannot point to a weak alias",
566 // Only continue verifying subexpressions of GlobalAliases.
567 // Do not recurse into global initializers.
572 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
573 VerifyConstantExprBitcastType(CE);
575 for (const Use &U : C.operands()) {
577 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
578 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
579 else if (const auto *C2 = dyn_cast<Constant>(V))
580 visitAliaseeSubExpr(Visited, GA, *C2);
584 void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
585 Assert(!GA.getName().empty(), "Alias name cannot be empty!", &GA);
586 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
587 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
588 "weak_odr, or external linkage!",
590 const Constant *Aliasee = GA.getAliasee();
591 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
592 Assert(GA.getType() == Aliasee->getType(),
593 "Alias and aliasee types should match!", &GA);
595 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
596 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
598 visitAliaseeSubExpr(GA, *Aliasee);
600 visitGlobalValue(GA);
603 void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
604 for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i) {
605 MDNode *MD = NMD.getOperand(i);
607 if (NMD.getName() == "llvm.dbg.cu") {
608 Assert(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
618 void Verifier::visitMDNode(const MDNode &MD) {
619 // Only visit each node once. Metadata can be mutually recursive, so this
620 // avoids infinite recursion here, as well as being an optimization.
621 if (!MDNodes.insert(&MD).second)
624 switch (MD.getMetadataID()) {
626 llvm_unreachable("Invalid MDNode subclass");
627 case Metadata::MDTupleKind:
629 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
630 case Metadata::CLASS##Kind: \
631 visit##CLASS(cast<CLASS>(MD)); \
633 #include "llvm/IR/Metadata.def"
636 for (unsigned i = 0, e = MD.getNumOperands(); i != e; ++i) {
637 Metadata *Op = MD.getOperand(i);
640 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
642 if (auto *N = dyn_cast<MDNode>(Op)) {
646 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
647 visitValueAsMetadata(*V, nullptr);
652 // Check these last, so we diagnose problems in operands first.
653 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
654 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
657 void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
658 Assert(MD.getValue(), "Expected valid value", &MD);
659 Assert(!MD.getValue()->getType()->isMetadataTy(),
660 "Unexpected metadata round-trip through values", &MD, MD.getValue());
662 auto *L = dyn_cast<LocalAsMetadata>(&MD);
666 Assert(F, "function-local metadata used outside a function", L);
668 // If this was an instruction, bb, or argument, verify that it is in the
669 // function that we expect.
670 Function *ActualF = nullptr;
671 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
672 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
673 ActualF = I->getParent()->getParent();
674 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
675 ActualF = BB->getParent();
676 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
677 ActualF = A->getParent();
678 assert(ActualF && "Unimplemented function local metadata case!");
680 Assert(ActualF == F, "function-local metadata used in wrong function", L);
683 void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
684 Metadata *MD = MDV.getMetadata();
685 if (auto *N = dyn_cast<MDNode>(MD)) {
690 // Only visit each node once. Metadata can be mutually recursive, so this
691 // avoids infinite recursion here, as well as being an optimization.
692 if (!MDNodes.insert(MD).second)
695 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
696 visitValueAsMetadata(*V, F);
699 bool Verifier::isValidUUID(const MDNode &N, const Metadata *MD) {
700 auto *S = dyn_cast<MDString>(MD);
703 if (S->getString().empty())
706 // Keep track of names of types referenced via UUID so we can check that they
708 UnresolvedTypeRefs.insert(std::make_pair(S, &N));
712 /// \brief Check if a value can be a reference to a type.
713 bool Verifier::isTypeRef(const MDNode &N, const Metadata *MD) {
714 return !MD || isValidUUID(N, MD) || isa<DIType>(MD);
717 /// \brief Check if a value can be a ScopeRef.
718 bool Verifier::isScopeRef(const MDNode &N, const Metadata *MD) {
719 return !MD || isValidUUID(N, MD) || isa<DIScope>(MD);
722 /// \brief Check if a value can be a debug info ref.
723 bool Verifier::isDIRef(const MDNode &N, const Metadata *MD) {
724 return !MD || isValidUUID(N, MD) || isa<DINode>(MD);
728 bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
729 for (Metadata *MD : N.operands()) {
742 bool isValidMetadataArray(const MDTuple &N) {
743 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
747 bool isValidMetadataNullArray(const MDTuple &N) {
748 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
751 void Verifier::visitDILocation(const DILocation &N) {
752 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
753 "location requires a valid scope", &N, N.getRawScope());
754 if (auto *IA = N.getRawInlinedAt())
755 Assert(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
758 void Verifier::visitGenericDINode(const GenericDINode &N) {
759 Assert(N.getTag(), "invalid tag", &N);
762 void Verifier::visitDIScope(const DIScope &N) {
763 if (auto *F = N.getRawFile())
764 Assert(isa<DIFile>(F), "invalid file", &N, F);
767 void Verifier::visitDISubrange(const DISubrange &N) {
768 Assert(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
769 Assert(N.getCount() >= -1, "invalid subrange count", &N);
772 void Verifier::visitDIEnumerator(const DIEnumerator &N) {
773 Assert(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
776 void Verifier::visitDIBasicType(const DIBasicType &N) {
777 Assert(N.getTag() == dwarf::DW_TAG_base_type ||
778 N.getTag() == dwarf::DW_TAG_unspecified_type,
782 void Verifier::visitDIDerivedTypeBase(const DIDerivedTypeBase &N) {
783 // Common scope checks.
786 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
787 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
790 // FIXME: Sink this into the subclass verifies.
791 if (!N.getFile() || N.getFile()->getFilename().empty()) {
792 // Check whether the filename is allowed to be empty.
793 uint16_t Tag = N.getTag();
795 Tag == dwarf::DW_TAG_const_type || Tag == dwarf::DW_TAG_volatile_type ||
796 Tag == dwarf::DW_TAG_pointer_type ||
797 Tag == dwarf::DW_TAG_ptr_to_member_type ||
798 Tag == dwarf::DW_TAG_reference_type ||
799 Tag == dwarf::DW_TAG_rvalue_reference_type ||
800 Tag == dwarf::DW_TAG_restrict_type ||
801 Tag == dwarf::DW_TAG_array_type ||
802 Tag == dwarf::DW_TAG_enumeration_type ||
803 Tag == dwarf::DW_TAG_subroutine_type ||
804 Tag == dwarf::DW_TAG_inheritance || Tag == dwarf::DW_TAG_friend ||
805 Tag == dwarf::DW_TAG_structure_type ||
806 Tag == dwarf::DW_TAG_member || Tag == dwarf::DW_TAG_typedef,
807 "derived/composite type requires a filename", &N, N.getFile());
811 void Verifier::visitDIDerivedType(const DIDerivedType &N) {
812 // Common derived type checks.
813 visitDIDerivedTypeBase(N);
815 Assert(N.getTag() == dwarf::DW_TAG_typedef ||
816 N.getTag() == dwarf::DW_TAG_pointer_type ||
817 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
818 N.getTag() == dwarf::DW_TAG_reference_type ||
819 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
820 N.getTag() == dwarf::DW_TAG_const_type ||
821 N.getTag() == dwarf::DW_TAG_volatile_type ||
822 N.getTag() == dwarf::DW_TAG_restrict_type ||
823 N.getTag() == dwarf::DW_TAG_member ||
824 N.getTag() == dwarf::DW_TAG_inheritance ||
825 N.getTag() == dwarf::DW_TAG_friend,
827 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
828 Assert(isTypeRef(N, N.getExtraData()), "invalid pointer to member type", &N,
833 static bool hasConflictingReferenceFlags(unsigned Flags) {
834 return (Flags & DINode::FlagLValueReference) &&
835 (Flags & DINode::FlagRValueReference);
838 void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
839 auto *Params = dyn_cast<MDTuple>(&RawParams);
840 Assert(Params, "invalid template params", &N, &RawParams);
841 for (Metadata *Op : Params->operands()) {
842 Assert(Op && isa<DITemplateParameter>(Op), "invalid template parameter", &N,
847 void Verifier::visitDICompositeType(const DICompositeType &N) {
848 // Common derived type checks.
849 visitDIDerivedTypeBase(N);
851 Assert(N.getTag() == dwarf::DW_TAG_array_type ||
852 N.getTag() == dwarf::DW_TAG_structure_type ||
853 N.getTag() == dwarf::DW_TAG_union_type ||
854 N.getTag() == dwarf::DW_TAG_enumeration_type ||
855 N.getTag() == dwarf::DW_TAG_subroutine_type ||
856 N.getTag() == dwarf::DW_TAG_class_type,
859 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
860 "invalid composite elements", &N, N.getRawElements());
861 Assert(isTypeRef(N, N.getRawVTableHolder()), "invalid vtable holder", &N,
862 N.getRawVTableHolder());
863 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
864 "invalid composite elements", &N, N.getRawElements());
865 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
867 if (auto *Params = N.getRawTemplateParams())
868 visitTemplateParams(N, *Params);
871 void Verifier::visitDISubroutineType(const DISubroutineType &N) {
872 Assert(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
873 if (auto *Types = N.getRawTypeArray()) {
874 Assert(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
875 for (Metadata *Ty : N.getTypeArray()->operands()) {
876 Assert(isTypeRef(N, Ty), "invalid subroutine type ref", &N, Types, Ty);
879 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
883 void Verifier::visitDIFile(const DIFile &N) {
884 Assert(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
887 void Verifier::visitDICompileUnit(const DICompileUnit &N) {
888 Assert(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
890 // Don't bother verifying the compilation directory or producer string
891 // as those could be empty.
892 Assert(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
894 Assert(!N.getFile()->getFilename().empty(), "invalid filename", &N,
897 if (auto *Array = N.getRawEnumTypes()) {
898 Assert(isa<MDTuple>(Array), "invalid enum list", &N, Array);
899 for (Metadata *Op : N.getEnumTypes()->operands()) {
900 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
901 Assert(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
902 "invalid enum type", &N, N.getEnumTypes(), Op);
905 if (auto *Array = N.getRawRetainedTypes()) {
906 Assert(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
907 for (Metadata *Op : N.getRetainedTypes()->operands()) {
908 Assert(Op && isa<DIType>(Op), "invalid retained type", &N, Op);
911 if (auto *Array = N.getRawSubprograms()) {
912 Assert(isa<MDTuple>(Array), "invalid subprogram list", &N, Array);
913 for (Metadata *Op : N.getSubprograms()->operands()) {
914 Assert(Op && isa<DISubprogram>(Op), "invalid subprogram ref", &N, Op);
917 if (auto *Array = N.getRawGlobalVariables()) {
918 Assert(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
919 for (Metadata *Op : N.getGlobalVariables()->operands()) {
920 Assert(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref", &N,
924 if (auto *Array = N.getRawImportedEntities()) {
925 Assert(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
926 for (Metadata *Op : N.getImportedEntities()->operands()) {
927 Assert(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref", &N,
933 void Verifier::visitDISubprogram(const DISubprogram &N) {
934 Assert(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
935 Assert(isScopeRef(N, N.getRawScope()), "invalid scope", &N, N.getRawScope());
936 if (auto *T = N.getRawType())
937 Assert(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
938 Assert(isTypeRef(N, N.getRawContainingType()), "invalid containing type", &N,
939 N.getRawContainingType());
940 if (auto *RawF = N.getRawFunction()) {
941 auto *FMD = dyn_cast<ConstantAsMetadata>(RawF);
942 auto *F = FMD ? FMD->getValue() : nullptr;
943 auto *FT = F ? dyn_cast<PointerType>(F->getType()) : nullptr;
944 Assert(F && FT && isa<FunctionType>(FT->getElementType()),
945 "invalid function", &N, F, FT);
947 if (auto *Params = N.getRawTemplateParams())
948 visitTemplateParams(N, *Params);
949 if (auto *S = N.getRawDeclaration()) {
950 Assert(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
951 "invalid subprogram declaration", &N, S);
953 if (auto *RawVars = N.getRawVariables()) {
954 auto *Vars = dyn_cast<MDTuple>(RawVars);
955 Assert(Vars, "invalid variable list", &N, RawVars);
956 for (Metadata *Op : Vars->operands()) {
957 Assert(Op && isa<DILocalVariable>(Op), "invalid local variable", &N, Vars,
961 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
964 auto *F = N.getFunction();
968 // Check that all !dbg attachments lead to back to N (or, at least, another
969 // subprogram that describes the same function).
971 // FIXME: Check this incrementally while visiting !dbg attachments.
972 // FIXME: Only check when N is the canonical subprogram for F.
973 SmallPtrSet<const MDNode *, 32> Seen;
976 // Be careful about using DILocation here since we might be dealing with
977 // broken code (this is the Verifier after all).
979 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
982 if (!Seen.insert(DL).second)
985 DILocalScope *Scope = DL->getInlinedAtScope();
986 if (Scope && !Seen.insert(Scope).second)
989 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
990 if (SP && !Seen.insert(SP).second)
993 // FIXME: Once N is canonical, check "SP == &N".
994 Assert(SP->describes(F),
995 "!dbg attachment points at wrong subprogram for function", &N, F,
1000 void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
1001 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
1002 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1003 "invalid local scope", &N, N.getRawScope());
1006 void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1007 visitDILexicalBlockBase(N);
1009 Assert(N.getLine() || !N.getColumn(),
1010 "cannot have column info without line info", &N);
1013 void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1014 visitDILexicalBlockBase(N);
1017 void Verifier::visitDINamespace(const DINamespace &N) {
1018 Assert(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
1019 if (auto *S = N.getRawScope())
1020 Assert(isa<DIScope>(S), "invalid scope ref", &N, S);
1023 void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
1024 Assert(isTypeRef(N, N.getType()), "invalid type ref", &N, N.getType());
1027 void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1028 visitDITemplateParameter(N);
1030 Assert(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1034 void Verifier::visitDITemplateValueParameter(
1035 const DITemplateValueParameter &N) {
1036 visitDITemplateParameter(N);
1038 Assert(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1039 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1040 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1044 void Verifier::visitDIVariable(const DIVariable &N) {
1045 if (auto *S = N.getRawScope())
1046 Assert(isa<DIScope>(S), "invalid scope", &N, S);
1047 Assert(isTypeRef(N, N.getRawType()), "invalid type ref", &N, N.getRawType());
1048 if (auto *F = N.getRawFile())
1049 Assert(isa<DIFile>(F), "invalid file", &N, F);
1052 void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
1053 // Checks common to all variables.
1056 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1057 Assert(!N.getName().empty(), "missing global variable name", &N);
1058 if (auto *V = N.getRawVariable()) {
1059 Assert(isa<ConstantAsMetadata>(V) &&
1060 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
1061 "invalid global varaible ref", &N, V);
1063 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
1064 Assert(isa<DIDerivedType>(Member), "invalid static data member declaration",
1069 void Verifier::visitDILocalVariable(const DILocalVariable &N) {
1070 // Checks common to all variables.
1073 Assert(N.getTag() == dwarf::DW_TAG_auto_variable ||
1074 N.getTag() == dwarf::DW_TAG_arg_variable,
1076 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1077 "local variable requires a valid scope", &N, N.getRawScope());
1080 void Verifier::visitDIExpression(const DIExpression &N) {
1081 Assert(N.isValid(), "invalid expression", &N);
1084 void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
1085 Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
1086 if (auto *T = N.getRawType())
1087 Assert(isa<DIType>(T), "invalid type ref", &N, T);
1088 if (auto *F = N.getRawFile())
1089 Assert(isa<DIFile>(F), "invalid file", &N, F);
1092 void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
1093 Assert(N.getTag() == dwarf::DW_TAG_imported_module ||
1094 N.getTag() == dwarf::DW_TAG_imported_declaration,
1096 if (auto *S = N.getRawScope())
1097 Assert(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1098 Assert(isDIRef(N, N.getEntity()), "invalid imported entity", &N,
1102 void Verifier::visitComdat(const Comdat &C) {
1103 // The Module is invalid if the GlobalValue has private linkage. Entities
1104 // with private linkage don't have entries in the symbol table.
1105 if (const GlobalValue *GV = M->getNamedValue(C.getName()))
1106 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1110 void Verifier::visitModuleIdents(const Module &M) {
1111 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1115 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1116 // Scan each llvm.ident entry and make sure that this requirement is met.
1117 for (unsigned i = 0, e = Idents->getNumOperands(); i != e; ++i) {
1118 const MDNode *N = Idents->getOperand(i);
1119 Assert(N->getNumOperands() == 1,
1120 "incorrect number of operands in llvm.ident metadata", N);
1121 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1122 ("invalid value for llvm.ident metadata entry operand"
1123 "(the operand should be a string)"),
1128 void Verifier::visitModuleFlags(const Module &M) {
1129 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1132 // Scan each flag, and track the flags and requirements.
1133 DenseMap<const MDString*, const MDNode*> SeenIDs;
1134 SmallVector<const MDNode*, 16> Requirements;
1135 for (unsigned I = 0, E = Flags->getNumOperands(); I != E; ++I) {
1136 visitModuleFlag(Flags->getOperand(I), SeenIDs, Requirements);
1139 // Validate that the requirements in the module are valid.
1140 for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
1141 const MDNode *Requirement = Requirements[I];
1142 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
1143 const Metadata *ReqValue = Requirement->getOperand(1);
1145 const MDNode *Op = SeenIDs.lookup(Flag);
1147 CheckFailed("invalid requirement on flag, flag is not present in module",
1152 if (Op->getOperand(2) != ReqValue) {
1153 CheckFailed(("invalid requirement on flag, "
1154 "flag does not have the required value"),
1162 Verifier::visitModuleFlag(const MDNode *Op,
1163 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1164 SmallVectorImpl<const MDNode *> &Requirements) {
1165 // Each module flag should have three arguments, the merge behavior (a
1166 // constant int), the flag ID (an MDString), and the value.
1167 Assert(Op->getNumOperands() == 3,
1168 "incorrect number of operands in module flag", Op);
1169 Module::ModFlagBehavior MFB;
1170 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
1172 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
1173 "invalid behavior operand in module flag (expected constant integer)",
1176 "invalid behavior operand in module flag (unexpected constant)",
1179 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
1180 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1183 // Sanity check the values for behaviors with additional requirements.
1186 case Module::Warning:
1187 case Module::Override:
1188 // These behavior types accept any value.
1191 case Module::Require: {
1192 // The value should itself be an MDNode with two operands, a flag ID (an
1193 // MDString), and a value.
1194 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
1195 Assert(Value && Value->getNumOperands() == 2,
1196 "invalid value for 'require' module flag (expected metadata pair)",
1198 Assert(isa<MDString>(Value->getOperand(0)),
1199 ("invalid value for 'require' module flag "
1200 "(first value operand should be a string)"),
1201 Value->getOperand(0));
1203 // Append it to the list of requirements, to check once all module flags are
1205 Requirements.push_back(Value);
1209 case Module::Append:
1210 case Module::AppendUnique: {
1211 // These behavior types require the operand be an MDNode.
1212 Assert(isa<MDNode>(Op->getOperand(2)),
1213 "invalid value for 'append'-type module flag "
1214 "(expected a metadata node)",
1220 // Unless this is a "requires" flag, check the ID is unique.
1221 if (MFB != Module::Require) {
1222 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
1224 "module flag identifiers must be unique (or of 'require' type)", ID);
1228 void Verifier::VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
1229 bool isFunction, const Value *V) {
1230 unsigned Slot = ~0U;
1231 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1232 if (Attrs.getSlotIndex(I) == Idx) {
1237 assert(Slot != ~0U && "Attribute set inconsistency!");
1239 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1241 if (I->isStringAttribute())
1244 if (I->getKindAsEnum() == Attribute::NoReturn ||
1245 I->getKindAsEnum() == Attribute::NoUnwind ||
1246 I->getKindAsEnum() == Attribute::NoInline ||
1247 I->getKindAsEnum() == Attribute::AlwaysInline ||
1248 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1249 I->getKindAsEnum() == Attribute::StackProtect ||
1250 I->getKindAsEnum() == Attribute::StackProtectReq ||
1251 I->getKindAsEnum() == Attribute::StackProtectStrong ||
1252 I->getKindAsEnum() == Attribute::NoRedZone ||
1253 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1254 I->getKindAsEnum() == Attribute::Naked ||
1255 I->getKindAsEnum() == Attribute::InlineHint ||
1256 I->getKindAsEnum() == Attribute::StackAlignment ||
1257 I->getKindAsEnum() == Attribute::UWTable ||
1258 I->getKindAsEnum() == Attribute::NonLazyBind ||
1259 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1260 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1261 I->getKindAsEnum() == Attribute::SanitizeThread ||
1262 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1263 I->getKindAsEnum() == Attribute::MinSize ||
1264 I->getKindAsEnum() == Attribute::NoDuplicate ||
1265 I->getKindAsEnum() == Attribute::Builtin ||
1266 I->getKindAsEnum() == Attribute::NoBuiltin ||
1267 I->getKindAsEnum() == Attribute::Cold ||
1268 I->getKindAsEnum() == Attribute::OptimizeNone ||
1269 I->getKindAsEnum() == Attribute::JumpTable) {
1271 CheckFailed("Attribute '" + I->getAsString() +
1272 "' only applies to functions!", V);
1275 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
1276 I->getKindAsEnum() == Attribute::ReadNone) {
1278 CheckFailed("Attribute '" + I->getAsString() +
1279 "' does not apply to function returns");
1282 } else if (isFunction) {
1283 CheckFailed("Attribute '" + I->getAsString() +
1284 "' does not apply to functions!", V);
1290 // VerifyParameterAttrs - Check the given attributes for an argument or return
1291 // value of the specified type. The value V is printed in error messages.
1292 void Verifier::VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
1293 bool isReturnValue, const Value *V) {
1294 if (!Attrs.hasAttributes(Idx))
1297 VerifyAttributeTypes(Attrs, Idx, false, V);
1300 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1301 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1302 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1303 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1304 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
1305 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1306 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', and "
1307 "'returned' do not apply to return values!",
1310 // Check for mutually incompatible attributes. Only inreg is compatible with
1312 unsigned AttrCount = 0;
1313 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1314 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1315 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1316 Attrs.hasAttribute(Idx, Attribute::InReg);
1317 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
1318 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1319 "and 'sret' are incompatible!",
1322 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1323 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1325 "'inalloca and readonly' are incompatible!",
1328 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1329 Attrs.hasAttribute(Idx, Attribute::Returned)),
1331 "'sret and returned' are incompatible!",
1334 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1335 Attrs.hasAttribute(Idx, Attribute::SExt)),
1337 "'zeroext and signext' are incompatible!",
1340 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1341 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1343 "'readnone and readonly' are incompatible!",
1346 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1347 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1349 "'noinline and alwaysinline' are incompatible!",
1352 Assert(!AttrBuilder(Attrs, Idx)
1353 .overlaps(AttributeFuncs::typeIncompatible(Ty)),
1354 "Wrong types for attribute: " +
1355 AttributeSet::get(*Context, Idx,
1356 AttributeFuncs::typeIncompatible(Ty)).getAsString(Idx),
1359 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
1360 SmallPtrSet<const Type*, 4> Visited;
1361 if (!PTy->getElementType()->isSized(&Visited)) {
1362 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1363 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1364 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1368 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1369 "Attribute 'byval' only applies to parameters with pointer type!",
1374 // VerifyFunctionAttrs - Check parameter attributes against a function type.
1375 // The value V is printed in error messages.
1376 void Verifier::VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
1378 if (Attrs.isEmpty())
1381 bool SawNest = false;
1382 bool SawReturned = false;
1383 bool SawSRet = false;
1385 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
1386 unsigned Idx = Attrs.getSlotIndex(i);
1390 Ty = FT->getReturnType();
1391 else if (Idx-1 < FT->getNumParams())
1392 Ty = FT->getParamType(Idx-1);
1394 break; // VarArgs attributes, verified elsewhere.
1396 VerifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
1401 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
1402 Assert(!SawNest, "More than one parameter has attribute nest!", V);
1406 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
1407 Assert(!SawReturned, "More than one parameter has attribute returned!",
1409 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1411 "argument and return types for 'returned' attribute",
1416 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
1417 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1418 Assert(Idx == 1 || Idx == 2,
1419 "Attribute 'sret' is not on first or second parameter!", V);
1423 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
1424 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1429 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1432 VerifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
1435 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1436 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1437 "Attributes 'readnone and readonly' are incompatible!", V);
1440 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1441 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1442 Attribute::AlwaysInline)),
1443 "Attributes 'noinline and alwaysinline' are incompatible!", V);
1445 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1446 Attribute::OptimizeNone)) {
1447 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1448 "Attribute 'optnone' requires 'noinline'!", V);
1450 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1451 Attribute::OptimizeForSize),
1452 "Attributes 'optsize and optnone' are incompatible!", V);
1454 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1455 "Attributes 'minsize and optnone' are incompatible!", V);
1458 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1459 Attribute::JumpTable)) {
1460 const GlobalValue *GV = cast<GlobalValue>(V);
1461 Assert(GV->hasUnnamedAddr(),
1462 "Attribute 'jumptable' requires 'unnamed_addr'", V);
1466 void Verifier::VerifyConstantExprBitcastType(const ConstantExpr *CE) {
1467 if (CE->getOpcode() != Instruction::BitCast)
1470 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1472 "Invalid bitcast", CE);
1475 bool Verifier::VerifyAttributeCount(AttributeSet Attrs, unsigned Params) {
1476 if (Attrs.getNumSlots() == 0)
1479 unsigned LastSlot = Attrs.getNumSlots() - 1;
1480 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
1481 if (LastIndex <= Params
1482 || (LastIndex == AttributeSet::FunctionIndex
1483 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
1489 /// \brief Verify that statepoint intrinsic is well formed.
1490 void Verifier::VerifyStatepoint(ImmutableCallSite CS) {
1491 assert(CS.getCalledFunction() &&
1492 CS.getCalledFunction()->getIntrinsicID() ==
1493 Intrinsic::experimental_gc_statepoint);
1495 const Instruction &CI = *CS.getInstruction();
1497 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory(),
1498 "gc.statepoint must read and write memory to preserve "
1499 "reordering restrictions required by safepoint semantics",
1502 const Value *Target = CS.getArgument(0);
1503 const PointerType *PT = dyn_cast<PointerType>(Target->getType());
1504 Assert(PT && PT->getElementType()->isFunctionTy(),
1505 "gc.statepoint callee must be of function pointer type", &CI, Target);
1506 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
1508 const Value *NumCallArgsV = CS.getArgument(1);
1509 Assert(isa<ConstantInt>(NumCallArgsV),
1510 "gc.statepoint number of arguments to underlying call "
1511 "must be constant integer",
1513 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
1514 Assert(NumCallArgs >= 0,
1515 "gc.statepoint number of arguments to underlying call "
1518 const int NumParams = (int)TargetFuncType->getNumParams();
1519 if (TargetFuncType->isVarArg()) {
1520 Assert(NumCallArgs >= NumParams,
1521 "gc.statepoint mismatch in number of vararg call args", &CI);
1523 // TODO: Remove this limitation
1524 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1525 "gc.statepoint doesn't support wrapping non-void "
1526 "vararg functions yet",
1529 Assert(NumCallArgs == NumParams,
1530 "gc.statepoint mismatch in number of call args", &CI);
1532 const Value *FlagsV = CS.getArgument(2);
1533 Assert(isa<ConstantInt>(FlagsV),
1534 "gc.statepoint flags must be constant integer", &CI);
1535 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1536 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1537 "unknown flag used in gc.statepoint flags argument", &CI);
1539 // Verify that the types of the call parameter arguments match
1540 // the type of the wrapped callee.
1541 for (int i = 0; i < NumParams; i++) {
1542 Type *ParamType = TargetFuncType->getParamType(i);
1543 Type *ArgType = CS.getArgument(3+i)->getType();
1544 Assert(ArgType == ParamType,
1545 "gc.statepoint call argument does not match wrapped "
1549 const int EndCallArgsInx = 2+NumCallArgs;
1551 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1552 Assert(isa<ConstantInt>(NumTransitionArgsV),
1553 "gc.statepoint number of transition arguments "
1554 "must be constant integer",
1556 const int NumTransitionArgs =
1557 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1558 Assert(NumTransitionArgs >= 0,
1559 "gc.statepoint number of transition arguments must be positive", &CI);
1560 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1562 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
1563 Assert(isa<ConstantInt>(NumDeoptArgsV),
1564 "gc.statepoint number of deoptimization arguments "
1565 "must be constant integer",
1567 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
1568 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1572 const int ExpectedNumArgs =
1573 5 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
1574 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
1575 "gc.statepoint too few arguments according to length fields", &CI);
1577 // Check that the only uses of this gc.statepoint are gc.result or
1578 // gc.relocate calls which are tied to this statepoint and thus part
1579 // of the same statepoint sequence
1580 for (const User *U : CI.users()) {
1581 const CallInst *Call = dyn_cast<const CallInst>(U);
1582 Assert(Call, "illegal use of statepoint token", &CI, U);
1583 if (!Call) continue;
1584 Assert(isGCRelocate(Call) || isGCResult(Call),
1585 "gc.result or gc.relocate are the only value uses"
1586 "of a gc.statepoint",
1588 if (isGCResult(Call)) {
1589 Assert(Call->getArgOperand(0) == &CI,
1590 "gc.result connected to wrong gc.statepoint", &CI, Call);
1591 } else if (isGCRelocate(Call)) {
1592 Assert(Call->getArgOperand(0) == &CI,
1593 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
1597 // Note: It is legal for a single derived pointer to be listed multiple
1598 // times. It's non-optimal, but it is legal. It can also happen after
1599 // insertion if we strip a bitcast away.
1600 // Note: It is really tempting to check that each base is relocated and
1601 // that a derived pointer is never reused as a base pointer. This turns
1602 // out to be problematic since optimizations run after safepoint insertion
1603 // can recognize equality properties that the insertion logic doesn't know
1604 // about. See example statepoint.ll in the verifier subdirectory
1607 void Verifier::verifyFrameRecoverIndices() {
1608 for (auto &Counts : FrameEscapeInfo) {
1609 Function *F = Counts.first;
1610 unsigned EscapedObjectCount = Counts.second.first;
1611 unsigned MaxRecoveredIndex = Counts.second.second;
1612 Assert(MaxRecoveredIndex <= EscapedObjectCount,
1613 "all indices passed to llvm.framerecover must be less than the "
1614 "number of arguments passed ot llvm.frameescape in the parent "
1620 // visitFunction - Verify that a function is ok.
1622 void Verifier::visitFunction(const Function &F) {
1623 // Check function arguments.
1624 FunctionType *FT = F.getFunctionType();
1625 unsigned NumArgs = F.arg_size();
1627 Assert(Context == &F.getContext(),
1628 "Function context does not match Module context!", &F);
1630 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1631 Assert(FT->getNumParams() == NumArgs,
1632 "# formal arguments must match # of arguments for function type!", &F,
1634 Assert(F.getReturnType()->isFirstClassType() ||
1635 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1636 "Functions cannot return aggregate values!", &F);
1638 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1639 "Invalid struct return type!", &F);
1641 AttributeSet Attrs = F.getAttributes();
1643 Assert(VerifyAttributeCount(Attrs, FT->getNumParams()),
1644 "Attribute after last parameter!", &F);
1646 // Check function attributes.
1647 VerifyFunctionAttrs(FT, Attrs, &F);
1649 // On function declarations/definitions, we do not support the builtin
1650 // attribute. We do not check this in VerifyFunctionAttrs since that is
1651 // checking for Attributes that can/can not ever be on functions.
1652 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1653 "Attribute 'builtin' can only be applied to a callsite.", &F);
1655 // Check that this function meets the restrictions on this calling convention.
1656 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1657 // restrictions can be lifted.
1658 switch (F.getCallingConv()) {
1660 case CallingConv::C:
1662 case CallingConv::Fast:
1663 case CallingConv::Cold:
1664 case CallingConv::Intel_OCL_BI:
1665 case CallingConv::PTX_Kernel:
1666 case CallingConv::PTX_Device:
1667 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1668 "perfect forwarding!",
1673 bool isLLVMdotName = F.getName().size() >= 5 &&
1674 F.getName().substr(0, 5) == "llvm.";
1676 // Check that the argument values match the function type for this function...
1678 for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E;
1680 Assert(I->getType() == FT->getParamType(i),
1681 "Argument value does not match function argument type!", I,
1682 FT->getParamType(i));
1683 Assert(I->getType()->isFirstClassType(),
1684 "Function arguments must have first-class types!", I);
1686 Assert(!I->getType()->isMetadataTy(),
1687 "Function takes metadata but isn't an intrinsic", I, &F);
1690 // Get the function metadata attachments.
1691 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1692 F.getAllMetadata(MDs);
1693 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
1695 if (F.isMaterializable()) {
1696 // Function has a body somewhere we can't see.
1697 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
1698 MDs.empty() ? nullptr : MDs.front().second);
1699 } else if (F.isDeclaration()) {
1700 Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1701 "invalid linkage type for function declaration", &F);
1702 Assert(MDs.empty(), "function without a body cannot have metadata", &F,
1703 MDs.empty() ? nullptr : MDs.front().second);
1705 // Verify that this function (which has a body) is not named "llvm.*". It
1706 // is not legal to define intrinsics.
1707 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
1709 // Check the entry node
1710 const BasicBlock *Entry = &F.getEntryBlock();
1711 Assert(pred_empty(Entry),
1712 "Entry block to function must not have predecessors!", Entry);
1714 // The address of the entry block cannot be taken, unless it is dead.
1715 if (Entry->hasAddressTaken()) {
1716 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1717 "blockaddress may not be used with the entry block!", Entry);
1720 // Visit metadata attachments.
1721 for (const auto &I : MDs)
1722 visitMDNode(*I.second);
1725 // If this function is actually an intrinsic, verify that it is only used in
1726 // direct call/invokes, never having its "address taken".
1727 if (F.getIntrinsicID()) {
1729 if (F.hasAddressTaken(&U))
1730 Assert(0, "Invalid user of intrinsic instruction!", U);
1733 Assert(!F.hasDLLImportStorageClass() ||
1734 (F.isDeclaration() && F.hasExternalLinkage()) ||
1735 F.hasAvailableExternallyLinkage(),
1736 "Function is marked as dllimport, but not external.", &F);
1739 // verifyBasicBlock - Verify that a basic block is well formed...
1741 void Verifier::visitBasicBlock(BasicBlock &BB) {
1742 InstsInThisBlock.clear();
1744 // Ensure that basic blocks have terminators!
1745 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
1747 // Check constraints that this basic block imposes on all of the PHI nodes in
1749 if (isa<PHINode>(BB.front())) {
1750 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
1751 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
1752 std::sort(Preds.begin(), Preds.end());
1754 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
1755 // Ensure that PHI nodes have at least one entry!
1756 Assert(PN->getNumIncomingValues() != 0,
1757 "PHI nodes must have at least one entry. If the block is dead, "
1758 "the PHI should be removed!",
1760 Assert(PN->getNumIncomingValues() == Preds.size(),
1761 "PHINode should have one entry for each predecessor of its "
1762 "parent basic block!",
1765 // Get and sort all incoming values in the PHI node...
1767 Values.reserve(PN->getNumIncomingValues());
1768 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1769 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
1770 PN->getIncomingValue(i)));
1771 std::sort(Values.begin(), Values.end());
1773 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
1774 // Check to make sure that if there is more than one entry for a
1775 // particular basic block in this PHI node, that the incoming values are
1778 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
1779 Values[i].second == Values[i - 1].second,
1780 "PHI node has multiple entries for the same basic block with "
1781 "different incoming values!",
1782 PN, Values[i].first, Values[i].second, Values[i - 1].second);
1784 // Check to make sure that the predecessors and PHI node entries are
1786 Assert(Values[i].first == Preds[i],
1787 "PHI node entries do not match predecessors!", PN,
1788 Values[i].first, Preds[i]);
1793 // Check that all instructions have their parent pointers set up correctly.
1796 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
1800 void Verifier::visitTerminatorInst(TerminatorInst &I) {
1801 // Ensure that terminators only exist at the end of the basic block.
1802 Assert(&I == I.getParent()->getTerminator(),
1803 "Terminator found in the middle of a basic block!", I.getParent());
1804 visitInstruction(I);
1807 void Verifier::visitBranchInst(BranchInst &BI) {
1808 if (BI.isConditional()) {
1809 Assert(BI.getCondition()->getType()->isIntegerTy(1),
1810 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
1812 visitTerminatorInst(BI);
1815 void Verifier::visitReturnInst(ReturnInst &RI) {
1816 Function *F = RI.getParent()->getParent();
1817 unsigned N = RI.getNumOperands();
1818 if (F->getReturnType()->isVoidTy())
1820 "Found return instr that returns non-void in Function of void "
1822 &RI, F->getReturnType());
1824 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
1825 "Function return type does not match operand "
1826 "type of return inst!",
1827 &RI, F->getReturnType());
1829 // Check to make sure that the return value has necessary properties for
1831 visitTerminatorInst(RI);
1834 void Verifier::visitSwitchInst(SwitchInst &SI) {
1835 // Check to make sure that all of the constants in the switch instruction
1836 // have the same type as the switched-on value.
1837 Type *SwitchTy = SI.getCondition()->getType();
1838 SmallPtrSet<ConstantInt*, 32> Constants;
1839 for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end(); i != e; ++i) {
1840 Assert(i.getCaseValue()->getType() == SwitchTy,
1841 "Switch constants must all be same type as switch value!", &SI);
1842 Assert(Constants.insert(i.getCaseValue()).second,
1843 "Duplicate integer as switch case", &SI, i.getCaseValue());
1846 visitTerminatorInst(SI);
1849 void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
1850 Assert(BI.getAddress()->getType()->isPointerTy(),
1851 "Indirectbr operand must have pointer type!", &BI);
1852 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
1853 Assert(BI.getDestination(i)->getType()->isLabelTy(),
1854 "Indirectbr destinations must all have pointer type!", &BI);
1856 visitTerminatorInst(BI);
1859 void Verifier::visitSelectInst(SelectInst &SI) {
1860 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
1862 "Invalid operands for select instruction!", &SI);
1864 Assert(SI.getTrueValue()->getType() == SI.getType(),
1865 "Select values must have same type as select instruction!", &SI);
1866 visitInstruction(SI);
1869 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
1870 /// a pass, if any exist, it's an error.
1872 void Verifier::visitUserOp1(Instruction &I) {
1873 Assert(0, "User-defined operators should not live outside of a pass!", &I);
1876 void Verifier::visitTruncInst(TruncInst &I) {
1877 // Get the source and destination types
1878 Type *SrcTy = I.getOperand(0)->getType();
1879 Type *DestTy = I.getType();
1881 // Get the size of the types in bits, we'll need this later
1882 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1883 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1885 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
1886 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
1887 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1888 "trunc source and destination must both be a vector or neither", &I);
1889 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
1891 visitInstruction(I);
1894 void Verifier::visitZExtInst(ZExtInst &I) {
1895 // Get the source and destination types
1896 Type *SrcTy = I.getOperand(0)->getType();
1897 Type *DestTy = I.getType();
1899 // Get the size of the types in bits, we'll need this later
1900 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
1901 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
1902 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1903 "zext source and destination must both be a vector or neither", &I);
1904 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1905 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1907 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
1909 visitInstruction(I);
1912 void Verifier::visitSExtInst(SExtInst &I) {
1913 // Get the source and destination types
1914 Type *SrcTy = I.getOperand(0)->getType();
1915 Type *DestTy = I.getType();
1917 // Get the size of the types in bits, we'll need this later
1918 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1919 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1921 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
1922 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
1923 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1924 "sext source and destination must both be a vector or neither", &I);
1925 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
1927 visitInstruction(I);
1930 void Verifier::visitFPTruncInst(FPTruncInst &I) {
1931 // Get the source and destination types
1932 Type *SrcTy = I.getOperand(0)->getType();
1933 Type *DestTy = I.getType();
1934 // Get the size of the types in bits, we'll need this later
1935 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1936 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1938 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
1939 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
1940 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1941 "fptrunc source and destination must both be a vector or neither", &I);
1942 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
1944 visitInstruction(I);
1947 void Verifier::visitFPExtInst(FPExtInst &I) {
1948 // Get the source and destination types
1949 Type *SrcTy = I.getOperand(0)->getType();
1950 Type *DestTy = I.getType();
1952 // Get the size of the types in bits, we'll need this later
1953 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1954 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1956 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
1957 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
1958 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1959 "fpext source and destination must both be a vector or neither", &I);
1960 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
1962 visitInstruction(I);
1965 void Verifier::visitUIToFPInst(UIToFPInst &I) {
1966 // Get the source and destination types
1967 Type *SrcTy = I.getOperand(0)->getType();
1968 Type *DestTy = I.getType();
1970 bool SrcVec = SrcTy->isVectorTy();
1971 bool DstVec = DestTy->isVectorTy();
1973 Assert(SrcVec == DstVec,
1974 "UIToFP source and dest must both be vector or scalar", &I);
1975 Assert(SrcTy->isIntOrIntVectorTy(),
1976 "UIToFP source must be integer or integer vector", &I);
1977 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
1980 if (SrcVec && DstVec)
1981 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
1982 cast<VectorType>(DestTy)->getNumElements(),
1983 "UIToFP source and dest vector length mismatch", &I);
1985 visitInstruction(I);
1988 void Verifier::visitSIToFPInst(SIToFPInst &I) {
1989 // Get the source and destination types
1990 Type *SrcTy = I.getOperand(0)->getType();
1991 Type *DestTy = I.getType();
1993 bool SrcVec = SrcTy->isVectorTy();
1994 bool DstVec = DestTy->isVectorTy();
1996 Assert(SrcVec == DstVec,
1997 "SIToFP source and dest must both be vector or scalar", &I);
1998 Assert(SrcTy->isIntOrIntVectorTy(),
1999 "SIToFP source must be integer or integer vector", &I);
2000 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2003 if (SrcVec && DstVec)
2004 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2005 cast<VectorType>(DestTy)->getNumElements(),
2006 "SIToFP source and dest vector length mismatch", &I);
2008 visitInstruction(I);
2011 void Verifier::visitFPToUIInst(FPToUIInst &I) {
2012 // Get the source and destination types
2013 Type *SrcTy = I.getOperand(0)->getType();
2014 Type *DestTy = I.getType();
2016 bool SrcVec = SrcTy->isVectorTy();
2017 bool DstVec = DestTy->isVectorTy();
2019 Assert(SrcVec == DstVec,
2020 "FPToUI source and dest must both be vector or scalar", &I);
2021 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2023 Assert(DestTy->isIntOrIntVectorTy(),
2024 "FPToUI result must be integer or integer vector", &I);
2026 if (SrcVec && DstVec)
2027 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2028 cast<VectorType>(DestTy)->getNumElements(),
2029 "FPToUI source and dest vector length mismatch", &I);
2031 visitInstruction(I);
2034 void Verifier::visitFPToSIInst(FPToSIInst &I) {
2035 // Get the source and destination types
2036 Type *SrcTy = I.getOperand(0)->getType();
2037 Type *DestTy = I.getType();
2039 bool SrcVec = SrcTy->isVectorTy();
2040 bool DstVec = DestTy->isVectorTy();
2042 Assert(SrcVec == DstVec,
2043 "FPToSI source and dest must both be vector or scalar", &I);
2044 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2046 Assert(DestTy->isIntOrIntVectorTy(),
2047 "FPToSI result must be integer or integer vector", &I);
2049 if (SrcVec && DstVec)
2050 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2051 cast<VectorType>(DestTy)->getNumElements(),
2052 "FPToSI source and dest vector length mismatch", &I);
2054 visitInstruction(I);
2057 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2058 // Get the source and destination types
2059 Type *SrcTy = I.getOperand(0)->getType();
2060 Type *DestTy = I.getType();
2062 Assert(SrcTy->getScalarType()->isPointerTy(),
2063 "PtrToInt source must be pointer", &I);
2064 Assert(DestTy->getScalarType()->isIntegerTy(),
2065 "PtrToInt result must be integral", &I);
2066 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2069 if (SrcTy->isVectorTy()) {
2070 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2071 VectorType *VDest = dyn_cast<VectorType>(DestTy);
2072 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2073 "PtrToInt Vector width mismatch", &I);
2076 visitInstruction(I);
2079 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2080 // Get the source and destination types
2081 Type *SrcTy = I.getOperand(0)->getType();
2082 Type *DestTy = I.getType();
2084 Assert(SrcTy->getScalarType()->isIntegerTy(),
2085 "IntToPtr source must be an integral", &I);
2086 Assert(DestTy->getScalarType()->isPointerTy(),
2087 "IntToPtr result must be a pointer", &I);
2088 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2090 if (SrcTy->isVectorTy()) {
2091 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2092 VectorType *VDest = dyn_cast<VectorType>(DestTy);
2093 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2094 "IntToPtr Vector width mismatch", &I);
2096 visitInstruction(I);
2099 void Verifier::visitBitCastInst(BitCastInst &I) {
2101 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2102 "Invalid bitcast", &I);
2103 visitInstruction(I);
2106 void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2107 Type *SrcTy = I.getOperand(0)->getType();
2108 Type *DestTy = I.getType();
2110 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2112 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2114 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2115 "AddrSpaceCast must be between different address spaces", &I);
2116 if (SrcTy->isVectorTy())
2117 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2118 "AddrSpaceCast vector pointer number of elements mismatch", &I);
2119 visitInstruction(I);
2122 /// visitPHINode - Ensure that a PHI node is well formed.
2124 void Verifier::visitPHINode(PHINode &PN) {
2125 // Ensure that the PHI nodes are all grouped together at the top of the block.
2126 // This can be tested by checking whether the instruction before this is
2127 // either nonexistent (because this is begin()) or is a PHI node. If not,
2128 // then there is some other instruction before a PHI.
2129 Assert(&PN == &PN.getParent()->front() ||
2130 isa<PHINode>(--BasicBlock::iterator(&PN)),
2131 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
2133 // Check that all of the values of the PHI node have the same type as the
2134 // result, and that the incoming blocks are really basic blocks.
2135 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
2136 Assert(PN.getType() == PN.getIncomingValue(i)->getType(),
2137 "PHI node operands are not the same type as the result!", &PN);
2140 // All other PHI node constraints are checked in the visitBasicBlock method.
2142 visitInstruction(PN);
2145 void Verifier::VerifyCallSite(CallSite CS) {
2146 Instruction *I = CS.getInstruction();
2148 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2149 "Called function must be a pointer!", I);
2150 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
2152 Assert(FPTy->getElementType()->isFunctionTy(),
2153 "Called function is not pointer to function type!", I);
2155 Assert(FPTy->getElementType() == CS.getFunctionType(),
2156 "Called function is not the same type as the call!", I);
2158 FunctionType *FTy = CS.getFunctionType();
2160 // Verify that the correct number of arguments are being passed
2161 if (FTy->isVarArg())
2162 Assert(CS.arg_size() >= FTy->getNumParams(),
2163 "Called function requires more parameters than were provided!", I);
2165 Assert(CS.arg_size() == FTy->getNumParams(),
2166 "Incorrect number of arguments passed to called function!", I);
2168 // Verify that all arguments to the call match the function type.
2169 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2170 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2171 "Call parameter type does not match function signature!",
2172 CS.getArgument(i), FTy->getParamType(i), I);
2174 AttributeSet Attrs = CS.getAttributes();
2176 Assert(VerifyAttributeCount(Attrs, CS.arg_size()),
2177 "Attribute after last parameter!", I);
2179 // Verify call attributes.
2180 VerifyFunctionAttrs(FTy, Attrs, I);
2182 // Conservatively check the inalloca argument.
2183 // We have a bug if we can find that there is an underlying alloca without
2185 if (CS.hasInAllocaArgument()) {
2186 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2187 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
2188 Assert(AI->isUsedWithInAlloca(),
2189 "inalloca argument for call has mismatched alloca", AI, I);
2192 if (FTy->isVarArg()) {
2193 // FIXME? is 'nest' even legal here?
2194 bool SawNest = false;
2195 bool SawReturned = false;
2197 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2198 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2200 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2204 // Check attributes on the varargs part.
2205 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
2206 Type *Ty = CS.getArgument(Idx-1)->getType();
2207 VerifyParameterAttrs(Attrs, Idx, Ty, false, I);
2209 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
2210 Assert(!SawNest, "More than one parameter has attribute nest!", I);
2214 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
2215 Assert(!SawReturned, "More than one parameter has attribute returned!",
2217 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2218 "Incompatible argument and return types for 'returned' "
2224 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2225 "Attribute 'sret' cannot be used for vararg call arguments!", I);
2227 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
2228 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
2232 // Verify that there's no metadata unless it's a direct call to an intrinsic.
2233 if (CS.getCalledFunction() == nullptr ||
2234 !CS.getCalledFunction()->getName().startswith("llvm.")) {
2235 for (FunctionType::param_iterator PI = FTy->param_begin(),
2236 PE = FTy->param_end(); PI != PE; ++PI)
2237 Assert(!(*PI)->isMetadataTy(),
2238 "Function has metadata parameter but isn't an intrinsic", I);
2241 visitInstruction(*I);
2244 /// Two types are "congruent" if they are identical, or if they are both pointer
2245 /// types with different pointee types and the same address space.
2246 static bool isTypeCongruent(Type *L, Type *R) {
2249 PointerType *PL = dyn_cast<PointerType>(L);
2250 PointerType *PR = dyn_cast<PointerType>(R);
2253 return PL->getAddressSpace() == PR->getAddressSpace();
2256 static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2257 static const Attribute::AttrKind ABIAttrs[] = {
2258 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
2259 Attribute::InReg, Attribute::Returned};
2261 for (auto AK : ABIAttrs) {
2262 if (Attrs.hasAttribute(I + 1, AK))
2263 Copy.addAttribute(AK);
2265 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2266 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2270 void Verifier::verifyMustTailCall(CallInst &CI) {
2271 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
2273 // - The caller and callee prototypes must match. Pointer types of
2274 // parameters or return types may differ in pointee type, but not
2276 Function *F = CI.getParent()->getParent();
2277 FunctionType *CallerTy = F->getFunctionType();
2278 FunctionType *CalleeTy = CI.getFunctionType();
2279 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2280 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2281 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2282 "cannot guarantee tail call due to mismatched varargs", &CI);
2283 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2284 "cannot guarantee tail call due to mismatched return types", &CI);
2285 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2287 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2288 "cannot guarantee tail call due to mismatched parameter types", &CI);
2291 // - The calling conventions of the caller and callee must match.
2292 Assert(F->getCallingConv() == CI.getCallingConv(),
2293 "cannot guarantee tail call due to mismatched calling conv", &CI);
2295 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2296 // returned, and inalloca, must match.
2297 AttributeSet CallerAttrs = F->getAttributes();
2298 AttributeSet CalleeAttrs = CI.getAttributes();
2299 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2300 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2301 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
2302 Assert(CallerABIAttrs == CalleeABIAttrs,
2303 "cannot guarantee tail call due to mismatched ABI impacting "
2304 "function attributes",
2305 &CI, CI.getOperand(I));
2308 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2309 // or a pointer bitcast followed by a ret instruction.
2310 // - The ret instruction must return the (possibly bitcasted) value
2311 // produced by the call or void.
2312 Value *RetVal = &CI;
2313 Instruction *Next = CI.getNextNode();
2315 // Handle the optional bitcast.
2316 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
2317 Assert(BI->getOperand(0) == RetVal,
2318 "bitcast following musttail call must use the call", BI);
2320 Next = BI->getNextNode();
2323 // Check the return.
2324 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
2325 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2327 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2328 "musttail call result must be returned", Ret);
2331 void Verifier::visitCallInst(CallInst &CI) {
2332 VerifyCallSite(&CI);
2334 if (CI.isMustTailCall())
2335 verifyMustTailCall(CI);
2337 if (Function *F = CI.getCalledFunction())
2338 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
2339 visitIntrinsicFunctionCall(ID, CI);
2342 void Verifier::visitInvokeInst(InvokeInst &II) {
2343 VerifyCallSite(&II);
2345 // Verify that there is a landingpad instruction as the first non-PHI
2346 // instruction of the 'unwind' destination.
2347 Assert(II.getUnwindDest()->isLandingPad(),
2348 "The unwind destination does not have a landingpad instruction!", &II);
2350 if (Function *F = II.getCalledFunction())
2351 // TODO: Ideally we should use visitIntrinsicFunction here. But it uses
2352 // CallInst as an input parameter. It not woth updating this whole
2353 // function only to support statepoint verification.
2354 if (F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint)
2355 VerifyStatepoint(ImmutableCallSite(&II));
2357 visitTerminatorInst(II);
2360 /// visitBinaryOperator - Check that both arguments to the binary operator are
2361 /// of the same type!
2363 void Verifier::visitBinaryOperator(BinaryOperator &B) {
2364 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2365 "Both operands to a binary operator are not of the same type!", &B);
2367 switch (B.getOpcode()) {
2368 // Check that integer arithmetic operators are only used with
2369 // integral operands.
2370 case Instruction::Add:
2371 case Instruction::Sub:
2372 case Instruction::Mul:
2373 case Instruction::SDiv:
2374 case Instruction::UDiv:
2375 case Instruction::SRem:
2376 case Instruction::URem:
2377 Assert(B.getType()->isIntOrIntVectorTy(),
2378 "Integer arithmetic operators only work with integral types!", &B);
2379 Assert(B.getType() == B.getOperand(0)->getType(),
2380 "Integer arithmetic operators must have same type "
2381 "for operands and result!",
2384 // Check that floating-point arithmetic operators are only used with
2385 // floating-point operands.
2386 case Instruction::FAdd:
2387 case Instruction::FSub:
2388 case Instruction::FMul:
2389 case Instruction::FDiv:
2390 case Instruction::FRem:
2391 Assert(B.getType()->isFPOrFPVectorTy(),
2392 "Floating-point arithmetic operators only work with "
2393 "floating-point types!",
2395 Assert(B.getType() == B.getOperand(0)->getType(),
2396 "Floating-point arithmetic operators must have same type "
2397 "for operands and result!",
2400 // Check that logical operators are only used with integral operands.
2401 case Instruction::And:
2402 case Instruction::Or:
2403 case Instruction::Xor:
2404 Assert(B.getType()->isIntOrIntVectorTy(),
2405 "Logical operators only work with integral types!", &B);
2406 Assert(B.getType() == B.getOperand(0)->getType(),
2407 "Logical operators must have same type for operands and result!",
2410 case Instruction::Shl:
2411 case Instruction::LShr:
2412 case Instruction::AShr:
2413 Assert(B.getType()->isIntOrIntVectorTy(),
2414 "Shifts only work with integral types!", &B);
2415 Assert(B.getType() == B.getOperand(0)->getType(),
2416 "Shift return type must be same as operands!", &B);
2419 llvm_unreachable("Unknown BinaryOperator opcode!");
2422 visitInstruction(B);
2425 void Verifier::visitICmpInst(ICmpInst &IC) {
2426 // Check that the operands are the same type
2427 Type *Op0Ty = IC.getOperand(0)->getType();
2428 Type *Op1Ty = IC.getOperand(1)->getType();
2429 Assert(Op0Ty == Op1Ty,
2430 "Both operands to ICmp instruction are not of the same type!", &IC);
2431 // Check that the operands are the right type
2432 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2433 "Invalid operand types for ICmp instruction", &IC);
2434 // Check that the predicate is valid.
2435 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2436 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2437 "Invalid predicate in ICmp instruction!", &IC);
2439 visitInstruction(IC);
2442 void Verifier::visitFCmpInst(FCmpInst &FC) {
2443 // Check that the operands are the same type
2444 Type *Op0Ty = FC.getOperand(0)->getType();
2445 Type *Op1Ty = FC.getOperand(1)->getType();
2446 Assert(Op0Ty == Op1Ty,
2447 "Both operands to FCmp instruction are not of the same type!", &FC);
2448 // Check that the operands are the right type
2449 Assert(Op0Ty->isFPOrFPVectorTy(),
2450 "Invalid operand types for FCmp instruction", &FC);
2451 // Check that the predicate is valid.
2452 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2453 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2454 "Invalid predicate in FCmp instruction!", &FC);
2456 visitInstruction(FC);
2459 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
2461 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2462 "Invalid extractelement operands!", &EI);
2463 visitInstruction(EI);
2466 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
2467 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2469 "Invalid insertelement operands!", &IE);
2470 visitInstruction(IE);
2473 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
2474 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2476 "Invalid shufflevector operands!", &SV);
2477 visitInstruction(SV);
2480 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
2481 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
2483 Assert(isa<PointerType>(TargetTy),
2484 "GEP base pointer is not a vector or a vector of pointers", &GEP);
2485 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
2486 Assert(GEP.getPointerOperandType()->isVectorTy() ==
2487 GEP.getType()->isVectorTy(),
2488 "Vector GEP must return a vector value", &GEP);
2490 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
2492 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
2493 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
2495 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
2496 GEP.getResultElementType() == ElTy,
2497 "GEP is not of right type for indices!", &GEP, ElTy);
2499 if (GEP.getPointerOperandType()->isVectorTy()) {
2500 // Additional checks for vector GEPs.
2501 unsigned GepWidth = GEP.getPointerOperandType()->getVectorNumElements();
2502 Assert(GepWidth == GEP.getType()->getVectorNumElements(),
2503 "Vector GEP result width doesn't match operand's", &GEP);
2504 for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
2505 Type *IndexTy = Idxs[i]->getType();
2506 Assert(IndexTy->isVectorTy(), "Vector GEP must have vector indices!",
2508 unsigned IndexWidth = IndexTy->getVectorNumElements();
2509 Assert(IndexWidth == GepWidth, "Invalid GEP index vector width", &GEP);
2512 visitInstruction(GEP);
2515 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2516 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2519 void Verifier::visitRangeMetadata(Instruction& I,
2520 MDNode* Range, Type* Ty) {
2522 Range == I.getMetadata(LLVMContext::MD_range) &&
2523 "precondition violation");
2525 unsigned NumOperands = Range->getNumOperands();
2526 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
2527 unsigned NumRanges = NumOperands / 2;
2528 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2530 ConstantRange LastRange(1); // Dummy initial value
2531 for (unsigned i = 0; i < NumRanges; ++i) {
2533 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
2534 Assert(Low, "The lower limit must be an integer!", Low);
2536 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
2537 Assert(High, "The upper limit must be an integer!", High);
2538 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2539 "Range types must match instruction type!", &I);
2541 APInt HighV = High->getValue();
2542 APInt LowV = Low->getValue();
2543 ConstantRange CurRange(LowV, HighV);
2544 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2545 "Range must not be empty!", Range);
2547 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2548 "Intervals are overlapping", Range);
2549 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2551 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2554 LastRange = ConstantRange(LowV, HighV);
2556 if (NumRanges > 2) {
2558 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
2560 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
2561 ConstantRange FirstRange(FirstLow, FirstHigh);
2562 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2563 "Intervals are overlapping", Range);
2564 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2569 void Verifier::visitLoadInst(LoadInst &LI) {
2570 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
2571 Assert(PTy, "Load operand must be a pointer.", &LI);
2572 Type *ElTy = LI.getType();
2573 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2574 "huge alignment values are unsupported", &LI);
2575 if (LI.isAtomic()) {
2576 Assert(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
2577 "Load cannot have Release ordering", &LI);
2578 Assert(LI.getAlignment() != 0,
2579 "Atomic load must specify explicit alignment", &LI);
2580 if (!ElTy->isPointerTy()) {
2581 Assert(ElTy->isIntegerTy(), "atomic load operand must have integer type!",
2583 unsigned Size = ElTy->getPrimitiveSizeInBits();
2584 Assert(Size >= 8 && !(Size & (Size - 1)),
2585 "atomic load operand must be power-of-two byte-sized integer", &LI,
2589 Assert(LI.getSynchScope() == CrossThread,
2590 "Non-atomic load cannot have SynchronizationScope specified", &LI);
2593 visitInstruction(LI);
2596 void Verifier::visitStoreInst(StoreInst &SI) {
2597 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
2598 Assert(PTy, "Store operand must be a pointer.", &SI);
2599 Type *ElTy = PTy->getElementType();
2600 Assert(ElTy == SI.getOperand(0)->getType(),
2601 "Stored value type does not match pointer operand type!", &SI, ElTy);
2602 Assert(SI.getAlignment() <= Value::MaximumAlignment,
2603 "huge alignment values are unsupported", &SI);
2604 if (SI.isAtomic()) {
2605 Assert(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
2606 "Store cannot have Acquire ordering", &SI);
2607 Assert(SI.getAlignment() != 0,
2608 "Atomic store must specify explicit alignment", &SI);
2609 if (!ElTy->isPointerTy()) {
2610 Assert(ElTy->isIntegerTy(),
2611 "atomic store operand must have integer type!", &SI, ElTy);
2612 unsigned Size = ElTy->getPrimitiveSizeInBits();
2613 Assert(Size >= 8 && !(Size & (Size - 1)),
2614 "atomic store operand must be power-of-two byte-sized integer",
2618 Assert(SI.getSynchScope() == CrossThread,
2619 "Non-atomic store cannot have SynchronizationScope specified", &SI);
2621 visitInstruction(SI);
2624 void Verifier::visitAllocaInst(AllocaInst &AI) {
2625 SmallPtrSet<const Type*, 4> Visited;
2626 PointerType *PTy = AI.getType();
2627 Assert(PTy->getAddressSpace() == 0,
2628 "Allocation instruction pointer not in the generic address space!",
2630 Assert(AI.getAllocatedType()->isSized(&Visited),
2631 "Cannot allocate unsized type", &AI);
2632 Assert(AI.getArraySize()->getType()->isIntegerTy(),
2633 "Alloca array size must have integer type", &AI);
2634 Assert(AI.getAlignment() <= Value::MaximumAlignment,
2635 "huge alignment values are unsupported", &AI);
2637 visitInstruction(AI);
2640 void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
2642 // FIXME: more conditions???
2643 Assert(CXI.getSuccessOrdering() != NotAtomic,
2644 "cmpxchg instructions must be atomic.", &CXI);
2645 Assert(CXI.getFailureOrdering() != NotAtomic,
2646 "cmpxchg instructions must be atomic.", &CXI);
2647 Assert(CXI.getSuccessOrdering() != Unordered,
2648 "cmpxchg instructions cannot be unordered.", &CXI);
2649 Assert(CXI.getFailureOrdering() != Unordered,
2650 "cmpxchg instructions cannot be unordered.", &CXI);
2651 Assert(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
2652 "cmpxchg instructions be at least as constrained on success as fail",
2654 Assert(CXI.getFailureOrdering() != Release &&
2655 CXI.getFailureOrdering() != AcquireRelease,
2656 "cmpxchg failure ordering cannot include release semantics", &CXI);
2658 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
2659 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
2660 Type *ElTy = PTy->getElementType();
2661 Assert(ElTy->isIntegerTy(), "cmpxchg operand must have integer type!", &CXI,
2663 unsigned Size = ElTy->getPrimitiveSizeInBits();
2664 Assert(Size >= 8 && !(Size & (Size - 1)),
2665 "cmpxchg operand must be power-of-two byte-sized integer", &CXI, ElTy);
2666 Assert(ElTy == CXI.getOperand(1)->getType(),
2667 "Expected value type does not match pointer operand type!", &CXI,
2669 Assert(ElTy == CXI.getOperand(2)->getType(),
2670 "Stored value type does not match pointer operand type!", &CXI, ElTy);
2671 visitInstruction(CXI);
2674 void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
2675 Assert(RMWI.getOrdering() != NotAtomic,
2676 "atomicrmw instructions must be atomic.", &RMWI);
2677 Assert(RMWI.getOrdering() != Unordered,
2678 "atomicrmw instructions cannot be unordered.", &RMWI);
2679 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
2680 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
2681 Type *ElTy = PTy->getElementType();
2682 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
2684 unsigned Size = ElTy->getPrimitiveSizeInBits();
2685 Assert(Size >= 8 && !(Size & (Size - 1)),
2686 "atomicrmw operand must be power-of-two byte-sized integer", &RMWI,
2688 Assert(ElTy == RMWI.getOperand(1)->getType(),
2689 "Argument value type does not match pointer operand type!", &RMWI,
2691 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
2692 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
2693 "Invalid binary operation!", &RMWI);
2694 visitInstruction(RMWI);
2697 void Verifier::visitFenceInst(FenceInst &FI) {
2698 const AtomicOrdering Ordering = FI.getOrdering();
2699 Assert(Ordering == Acquire || Ordering == Release ||
2700 Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
2701 "fence instructions may only have "
2702 "acquire, release, acq_rel, or seq_cst ordering.",
2704 visitInstruction(FI);
2707 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
2708 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
2709 EVI.getIndices()) == EVI.getType(),
2710 "Invalid ExtractValueInst operands!", &EVI);
2712 visitInstruction(EVI);
2715 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
2716 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
2717 IVI.getIndices()) ==
2718 IVI.getOperand(1)->getType(),
2719 "Invalid InsertValueInst operands!", &IVI);
2721 visitInstruction(IVI);
2724 void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
2725 BasicBlock *BB = LPI.getParent();
2727 // The landingpad instruction is ill-formed if it doesn't have any clauses and
2729 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
2730 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
2732 // The landingpad instruction defines its parent as a landing pad block. The
2733 // landing pad block may be branched to only by the unwind edge of an invoke.
2734 for (pred_iterator I = pred_begin(BB), E = pred_end(BB); I != E; ++I) {
2735 const InvokeInst *II = dyn_cast<InvokeInst>((*I)->getTerminator());
2736 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
2737 "Block containing LandingPadInst must be jumped to "
2738 "only by the unwind edge of an invoke.",
2742 // The landingpad instruction must be the first non-PHI instruction in the
2744 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
2745 "LandingPadInst not the first non-PHI instruction in the block.",
2748 // The personality functions for all landingpad instructions within the same
2749 // function should match.
2751 Assert(LPI.getPersonalityFn() == PersonalityFn,
2752 "Personality function doesn't match others in function", &LPI);
2753 PersonalityFn = LPI.getPersonalityFn();
2755 // All operands must be constants.
2756 Assert(isa<Constant>(PersonalityFn), "Personality function is not constant!",
2758 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
2759 Constant *Clause = LPI.getClause(i);
2760 if (LPI.isCatch(i)) {
2761 Assert(isa<PointerType>(Clause->getType()),
2762 "Catch operand does not have pointer type!", &LPI);
2764 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
2765 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
2766 "Filter operand is not an array of constants!", &LPI);
2770 visitInstruction(LPI);
2773 void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
2774 Instruction *Op = cast<Instruction>(I.getOperand(i));
2775 // If the we have an invalid invoke, don't try to compute the dominance.
2776 // We already reject it in the invoke specific checks and the dominance
2777 // computation doesn't handle multiple edges.
2778 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
2779 if (II->getNormalDest() == II->getUnwindDest())
2783 const Use &U = I.getOperandUse(i);
2784 Assert(InstsInThisBlock.count(Op) || DT.dominates(Op, U),
2785 "Instruction does not dominate all uses!", Op, &I);
2788 /// verifyInstruction - Verify that an instruction is well formed.
2790 void Verifier::visitInstruction(Instruction &I) {
2791 BasicBlock *BB = I.getParent();
2792 Assert(BB, "Instruction not embedded in basic block!", &I);
2794 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
2795 for (User *U : I.users()) {
2796 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
2797 "Only PHI nodes may reference their own value!", &I);
2801 // Check that void typed values don't have names
2802 Assert(!I.getType()->isVoidTy() || !I.hasName(),
2803 "Instruction has a name, but provides a void value!", &I);
2805 // Check that the return value of the instruction is either void or a legal
2807 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
2808 "Instruction returns a non-scalar type!", &I);
2810 // Check that the instruction doesn't produce metadata. Calls are already
2811 // checked against the callee type.
2812 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
2813 "Invalid use of metadata!", &I);
2815 // Check that all uses of the instruction, if they are instructions
2816 // themselves, actually have parent basic blocks. If the use is not an
2817 // instruction, it is an error!
2818 for (Use &U : I.uses()) {
2819 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
2820 Assert(Used->getParent() != nullptr,
2821 "Instruction referencing"
2822 " instruction not embedded in a basic block!",
2825 CheckFailed("Use of instruction is not an instruction!", U);
2830 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
2831 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
2833 // Check to make sure that only first-class-values are operands to
2835 if (!I.getOperand(i)->getType()->isFirstClassType()) {
2836 Assert(0, "Instruction operands must be first-class values!", &I);
2839 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
2840 // Check to make sure that the "address of" an intrinsic function is never
2843 !F->isIntrinsic() ||
2844 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
2845 "Cannot take the address of an intrinsic!", &I);
2847 !F->isIntrinsic() || isa<CallInst>(I) ||
2848 F->getIntrinsicID() == Intrinsic::donothing ||
2849 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
2850 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
2851 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
2852 "Cannot invoke an intrinsinc other than"
2853 " donothing or patchpoint",
2855 Assert(F->getParent() == M, "Referencing function in another module!",
2857 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
2858 Assert(OpBB->getParent() == BB->getParent(),
2859 "Referring to a basic block in another function!", &I);
2860 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
2861 Assert(OpArg->getParent() == BB->getParent(),
2862 "Referring to an argument in another function!", &I);
2863 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
2864 Assert(GV->getParent() == M, "Referencing global in another module!", &I);
2865 } else if (isa<Instruction>(I.getOperand(i))) {
2866 verifyDominatesUse(I, i);
2867 } else if (isa<InlineAsm>(I.getOperand(i))) {
2868 Assert((i + 1 == e && isa<CallInst>(I)) ||
2869 (i + 3 == e && isa<InvokeInst>(I)),
2870 "Cannot take the address of an inline asm!", &I);
2871 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
2872 if (CE->getType()->isPtrOrPtrVectorTy()) {
2873 // If we have a ConstantExpr pointer, we need to see if it came from an
2874 // illegal bitcast (inttoptr <constant int> )
2875 SmallVector<const ConstantExpr *, 4> Stack;
2876 SmallPtrSet<const ConstantExpr *, 4> Visited;
2877 Stack.push_back(CE);
2879 while (!Stack.empty()) {
2880 const ConstantExpr *V = Stack.pop_back_val();
2881 if (!Visited.insert(V).second)
2884 VerifyConstantExprBitcastType(V);
2886 for (unsigned I = 0, N = V->getNumOperands(); I != N; ++I) {
2887 if (ConstantExpr *Op = dyn_cast<ConstantExpr>(V->getOperand(I)))
2888 Stack.push_back(Op);
2895 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
2896 Assert(I.getType()->isFPOrFPVectorTy(),
2897 "fpmath requires a floating point result!", &I);
2898 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
2899 if (ConstantFP *CFP0 =
2900 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
2901 APFloat Accuracy = CFP0->getValueAPF();
2902 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
2903 "fpmath accuracy not a positive number!", &I);
2905 Assert(false, "invalid fpmath accuracy!", &I);
2909 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
2910 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
2911 "Ranges are only for loads, calls and invokes!", &I);
2912 visitRangeMetadata(I, Range, I.getType());
2915 if (I.getMetadata(LLVMContext::MD_nonnull)) {
2916 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
2918 Assert(isa<LoadInst>(I),
2919 "nonnull applies only to load instructions, use attributes"
2920 " for calls or invokes",
2924 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
2925 Assert(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
2929 InstsInThisBlock.insert(&I);
2932 /// VerifyIntrinsicType - Verify that the specified type (which comes from an
2933 /// intrinsic argument or return value) matches the type constraints specified
2934 /// by the .td file (e.g. an "any integer" argument really is an integer).
2936 /// This return true on error but does not print a message.
2937 bool Verifier::VerifyIntrinsicType(Type *Ty,
2938 ArrayRef<Intrinsic::IITDescriptor> &Infos,
2939 SmallVectorImpl<Type*> &ArgTys) {
2940 using namespace Intrinsic;
2942 // If we ran out of descriptors, there are too many arguments.
2943 if (Infos.empty()) return true;
2944 IITDescriptor D = Infos.front();
2945 Infos = Infos.slice(1);
2948 case IITDescriptor::Void: return !Ty->isVoidTy();
2949 case IITDescriptor::VarArg: return true;
2950 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
2951 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
2952 case IITDescriptor::Half: return !Ty->isHalfTy();
2953 case IITDescriptor::Float: return !Ty->isFloatTy();
2954 case IITDescriptor::Double: return !Ty->isDoubleTy();
2955 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
2956 case IITDescriptor::Vector: {
2957 VectorType *VT = dyn_cast<VectorType>(Ty);
2958 return !VT || VT->getNumElements() != D.Vector_Width ||
2959 VerifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
2961 case IITDescriptor::Pointer: {
2962 PointerType *PT = dyn_cast<PointerType>(Ty);
2963 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
2964 VerifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
2967 case IITDescriptor::Struct: {
2968 StructType *ST = dyn_cast<StructType>(Ty);
2969 if (!ST || ST->getNumElements() != D.Struct_NumElements)
2972 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
2973 if (VerifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
2978 case IITDescriptor::Argument:
2979 // Two cases here - If this is the second occurrence of an argument, verify
2980 // that the later instance matches the previous instance.
2981 if (D.getArgumentNumber() < ArgTys.size())
2982 return Ty != ArgTys[D.getArgumentNumber()];
2984 // Otherwise, if this is the first instance of an argument, record it and
2985 // verify the "Any" kind.
2986 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
2987 ArgTys.push_back(Ty);
2989 switch (D.getArgumentKind()) {
2990 case IITDescriptor::AK_Any: return false; // Success
2991 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
2992 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
2993 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
2994 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
2996 llvm_unreachable("all argument kinds not covered");
2998 case IITDescriptor::ExtendArgument: {
2999 // This may only be used when referring to a previous vector argument.
3000 if (D.getArgumentNumber() >= ArgTys.size())
3003 Type *NewTy = ArgTys[D.getArgumentNumber()];
3004 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3005 NewTy = VectorType::getExtendedElementVectorType(VTy);
3006 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3007 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
3013 case IITDescriptor::TruncArgument: {
3014 // This may only be used when referring to a previous vector argument.
3015 if (D.getArgumentNumber() >= ArgTys.size())
3018 Type *NewTy = ArgTys[D.getArgumentNumber()];
3019 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3020 NewTy = VectorType::getTruncatedElementVectorType(VTy);
3021 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3022 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
3028 case IITDescriptor::HalfVecArgument:
3029 // This may only be used when referring to a previous vector argument.
3030 return D.getArgumentNumber() >= ArgTys.size() ||
3031 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
3032 VectorType::getHalfElementsVectorType(
3033 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
3034 case IITDescriptor::SameVecWidthArgument: {
3035 if (D.getArgumentNumber() >= ArgTys.size())
3037 VectorType * ReferenceType =
3038 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
3039 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
3040 if (!ThisArgType || !ReferenceType ||
3041 (ReferenceType->getVectorNumElements() !=
3042 ThisArgType->getVectorNumElements()))
3044 return VerifyIntrinsicType(ThisArgType->getVectorElementType(),
3047 case IITDescriptor::PtrToArgument: {
3048 if (D.getArgumentNumber() >= ArgTys.size())
3050 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
3051 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
3052 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
3054 case IITDescriptor::VecOfPtrsToElt: {
3055 if (D.getArgumentNumber() >= ArgTys.size())
3057 VectorType * ReferenceType =
3058 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
3059 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
3060 if (!ThisArgVecTy || !ReferenceType ||
3061 (ReferenceType->getVectorNumElements() !=
3062 ThisArgVecTy->getVectorNumElements()))
3064 PointerType *ThisArgEltTy =
3065 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
3068 return (!(ThisArgEltTy->getElementType() ==
3069 ReferenceType->getVectorElementType()));
3072 llvm_unreachable("unhandled");
3075 /// \brief Verify if the intrinsic has variable arguments.
3076 /// This method is intended to be called after all the fixed arguments have been
3079 /// This method returns true on error and does not print an error message.
3081 Verifier::VerifyIntrinsicIsVarArg(bool isVarArg,
3082 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
3083 using namespace Intrinsic;
3085 // If there are no descriptors left, then it can't be a vararg.
3089 // There should be only one descriptor remaining at this point.
3090 if (Infos.size() != 1)
3093 // Check and verify the descriptor.
3094 IITDescriptor D = Infos.front();
3095 Infos = Infos.slice(1);
3096 if (D.Kind == IITDescriptor::VarArg)
3102 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
3104 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
3105 Function *IF = CI.getCalledFunction();
3106 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3109 // Verify that the intrinsic prototype lines up with what the .td files
3111 FunctionType *IFTy = IF->getFunctionType();
3112 bool IsVarArg = IFTy->isVarArg();
3114 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3115 getIntrinsicInfoTableEntries(ID, Table);
3116 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
3118 SmallVector<Type *, 4> ArgTys;
3119 Assert(!VerifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
3120 "Intrinsic has incorrect return type!", IF);
3121 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
3122 Assert(!VerifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
3123 "Intrinsic has incorrect argument type!", IF);
3125 // Verify if the intrinsic call matches the vararg property.
3127 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3128 "Intrinsic was not defined with variable arguments!", IF);
3130 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3131 "Callsite was not defined with variable arguments!", IF);
3133 // All descriptors should be absorbed by now.
3134 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
3136 // Now that we have the intrinsic ID and the actual argument types (and we
3137 // know they are legal for the intrinsic!) get the intrinsic name through the
3138 // usual means. This allows us to verify the mangling of argument types into
3140 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
3141 Assert(ExpectedName == IF->getName(),
3142 "Intrinsic name not mangled correctly for type arguments! "
3147 // If the intrinsic takes MDNode arguments, verify that they are either global
3148 // or are local to *this* function.
3149 for (unsigned i = 0, e = CI.getNumArgOperands(); i != e; ++i)
3150 if (auto *MD = dyn_cast<MetadataAsValue>(CI.getArgOperand(i)))
3151 visitMetadataAsValue(*MD, CI.getParent()->getParent());
3156 case Intrinsic::ctlz: // llvm.ctlz
3157 case Intrinsic::cttz: // llvm.cttz
3158 Assert(isa<ConstantInt>(CI.getArgOperand(1)),
3159 "is_zero_undef argument of bit counting intrinsics must be a "
3163 case Intrinsic::dbg_declare: // llvm.dbg.declare
3164 Assert(isa<MetadataAsValue>(CI.getArgOperand(0)),
3165 "invalid llvm.dbg.declare intrinsic call 1", &CI);
3166 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(CI));
3168 case Intrinsic::dbg_value: // llvm.dbg.value
3169 visitDbgIntrinsic("value", cast<DbgValueInst>(CI));
3171 case Intrinsic::memcpy:
3172 case Intrinsic::memmove:
3173 case Intrinsic::memset: {
3174 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CI.getArgOperand(3));
3176 "alignment argument of memory intrinsics must be a constant int",
3178 const APInt &AlignVal = AlignCI->getValue();
3179 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
3180 "alignment argument of memory intrinsics must be a power of 2", &CI);
3181 Assert(isa<ConstantInt>(CI.getArgOperand(4)),
3182 "isvolatile argument of memory intrinsics must be a constant int",
3186 case Intrinsic::gcroot:
3187 case Intrinsic::gcwrite:
3188 case Intrinsic::gcread:
3189 if (ID == Intrinsic::gcroot) {
3191 dyn_cast<AllocaInst>(CI.getArgOperand(0)->stripPointerCasts());
3192 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", &CI);
3193 Assert(isa<Constant>(CI.getArgOperand(1)),
3194 "llvm.gcroot parameter #2 must be a constant.", &CI);
3195 if (!AI->getType()->getElementType()->isPointerTy()) {
3196 Assert(!isa<ConstantPointerNull>(CI.getArgOperand(1)),
3197 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3198 "or argument #2 must be a non-null constant.",
3203 Assert(CI.getParent()->getParent()->hasGC(),
3204 "Enclosing function does not use GC.", &CI);
3206 case Intrinsic::init_trampoline:
3207 Assert(isa<Function>(CI.getArgOperand(1)->stripPointerCasts()),
3208 "llvm.init_trampoline parameter #2 must resolve to a function.",
3211 case Intrinsic::prefetch:
3212 Assert(isa<ConstantInt>(CI.getArgOperand(1)) &&
3213 isa<ConstantInt>(CI.getArgOperand(2)) &&
3214 cast<ConstantInt>(CI.getArgOperand(1))->getZExtValue() < 2 &&
3215 cast<ConstantInt>(CI.getArgOperand(2))->getZExtValue() < 4,
3216 "invalid arguments to llvm.prefetch", &CI);
3218 case Intrinsic::stackprotector:
3219 Assert(isa<AllocaInst>(CI.getArgOperand(1)->stripPointerCasts()),
3220 "llvm.stackprotector parameter #2 must resolve to an alloca.", &CI);
3222 case Intrinsic::lifetime_start:
3223 case Intrinsic::lifetime_end:
3224 case Intrinsic::invariant_start:
3225 Assert(isa<ConstantInt>(CI.getArgOperand(0)),
3226 "size argument of memory use markers must be a constant integer",
3229 case Intrinsic::invariant_end:
3230 Assert(isa<ConstantInt>(CI.getArgOperand(1)),
3231 "llvm.invariant.end parameter #2 must be a constant integer", &CI);
3234 case Intrinsic::frameescape: {
3235 BasicBlock *BB = CI.getParent();
3236 Assert(BB == &BB->getParent()->front(),
3237 "llvm.frameescape used outside of entry block", &CI);
3238 Assert(!SawFrameEscape,
3239 "multiple calls to llvm.frameescape in one function", &CI);
3240 for (Value *Arg : CI.arg_operands()) {
3241 if (isa<ConstantPointerNull>(Arg))
3242 continue; // Null values are allowed as placeholders.
3243 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
3244 Assert(AI && AI->isStaticAlloca(),
3245 "llvm.frameescape only accepts static allocas", &CI);
3247 FrameEscapeInfo[BB->getParent()].first = CI.getNumArgOperands();
3248 SawFrameEscape = true;
3251 case Intrinsic::framerecover: {
3252 Value *FnArg = CI.getArgOperand(0)->stripPointerCasts();
3253 Function *Fn = dyn_cast<Function>(FnArg);
3254 Assert(Fn && !Fn->isDeclaration(),
3255 "llvm.framerecover first "
3256 "argument must be function defined in this module",
3258 auto *IdxArg = dyn_cast<ConstantInt>(CI.getArgOperand(2));
3259 Assert(IdxArg, "idx argument of llvm.framerecover must be a constant int",
3261 auto &Entry = FrameEscapeInfo[Fn];
3262 Entry.second = unsigned(
3263 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
3267 case Intrinsic::experimental_gc_statepoint:
3268 Assert(!CI.isInlineAsm(),
3269 "gc.statepoint support for inline assembly unimplemented", &CI);
3270 Assert(CI.getParent()->getParent()->hasGC(),
3271 "Enclosing function does not use GC.", &CI);
3273 VerifyStatepoint(ImmutableCallSite(&CI));
3275 case Intrinsic::experimental_gc_result_int:
3276 case Intrinsic::experimental_gc_result_float:
3277 case Intrinsic::experimental_gc_result_ptr:
3278 case Intrinsic::experimental_gc_result: {
3279 Assert(CI.getParent()->getParent()->hasGC(),
3280 "Enclosing function does not use GC.", &CI);
3281 // Are we tied to a statepoint properly?
3282 CallSite StatepointCS(CI.getArgOperand(0));
3283 const Function *StatepointFn =
3284 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
3285 Assert(StatepointFn && StatepointFn->isDeclaration() &&
3286 StatepointFn->getIntrinsicID() ==
3287 Intrinsic::experimental_gc_statepoint,
3288 "gc.result operand #1 must be from a statepoint", &CI,
3289 CI.getArgOperand(0));
3291 // Assert that result type matches wrapped callee.
3292 const Value *Target = StatepointCS.getArgument(0);
3293 const PointerType *PT = cast<PointerType>(Target->getType());
3294 const FunctionType *TargetFuncType =
3295 cast<FunctionType>(PT->getElementType());
3296 Assert(CI.getType() == TargetFuncType->getReturnType(),
3297 "gc.result result type does not match wrapped callee", &CI);
3300 case Intrinsic::experimental_gc_relocate: {
3301 Assert(CI.getNumArgOperands() == 3, "wrong number of arguments", &CI);
3303 // Check that this relocate is correctly tied to the statepoint
3305 // This is case for relocate on the unwinding path of an invoke statepoint
3306 if (ExtractValueInst *ExtractValue =
3307 dyn_cast<ExtractValueInst>(CI.getArgOperand(0))) {
3308 Assert(isa<LandingPadInst>(ExtractValue->getAggregateOperand()),
3309 "gc relocate on unwind path incorrectly linked to the statepoint",
3312 const BasicBlock *invokeBB =
3313 ExtractValue->getParent()->getUniquePredecessor();
3315 // Landingpad relocates should have only one predecessor with invoke
3316 // statepoint terminator
3317 Assert(invokeBB, "safepoints should have unique landingpads",
3318 ExtractValue->getParent());
3319 Assert(invokeBB->getTerminator(), "safepoint block should be well formed",
3321 Assert(isStatepoint(invokeBB->getTerminator()),
3322 "gc relocate should be linked to a statepoint", invokeBB);
3325 // In all other cases relocate should be tied to the statepoint directly.
3326 // This covers relocates on a normal return path of invoke statepoint and
3327 // relocates of a call statepoint
3328 auto Token = CI.getArgOperand(0);
3329 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
3330 "gc relocate is incorrectly tied to the statepoint", &CI, Token);
3333 // Verify rest of the relocate arguments
3335 GCRelocateOperands ops(&CI);
3336 ImmutableCallSite StatepointCS(ops.getStatepoint());
3338 // Both the base and derived must be piped through the safepoint
3339 Value* Base = CI.getArgOperand(1);
3340 Assert(isa<ConstantInt>(Base),
3341 "gc.relocate operand #2 must be integer offset", &CI);
3343 Value* Derived = CI.getArgOperand(2);
3344 Assert(isa<ConstantInt>(Derived),
3345 "gc.relocate operand #3 must be integer offset", &CI);
3347 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
3348 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
3350 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
3351 "gc.relocate: statepoint base index out of bounds", &CI);
3352 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
3353 "gc.relocate: statepoint derived index out of bounds", &CI);
3355 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
3356 // section of the statepoint's argument
3357 Assert(StatepointCS.arg_size() > 0,
3358 "gc.statepoint: insufficient arguments");
3359 Assert(isa<ConstantInt>(StatepointCS.getArgument(1)),
3360 "gc.statement: number of call arguments must be constant integer");
3361 const unsigned NumCallArgs =
3362 cast<ConstantInt>(StatepointCS.getArgument(1))->getZExtValue();
3363 Assert(StatepointCS.arg_size() > NumCallArgs+3,
3364 "gc.statepoint: mismatch in number of call arguments");
3365 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs+3)),
3366 "gc.statepoint: number of transition arguments must be "
3367 "a constant integer");
3368 const int NumTransitionArgs =
3369 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 3))->getZExtValue();
3370 const int DeoptArgsStart = 2 + NumCallArgs + 1 + NumTransitionArgs + 1;
3371 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
3372 "gc.statepoint: number of deoptimization arguments must be "
3373 "a constant integer");
3374 const int NumDeoptArgs =
3375 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))->getZExtValue();
3376 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
3377 const int GCParamArgsEnd = StatepointCS.arg_size();
3378 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
3379 "gc.relocate: statepoint base index doesn't fall within the "
3380 "'gc parameters' section of the statepoint call",
3382 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
3383 "gc.relocate: statepoint derived index doesn't fall within the "
3384 "'gc parameters' section of the statepoint call",
3387 // gc_relocate does not need to be the same type as the relocated pointer.
3388 // It can casted to the correct type later if it's desired
3394 /// \brief Carefully grab the subprogram from a local scope.
3396 /// This carefully grabs the subprogram from a local scope, avoiding the
3397 /// built-in assertions that would typically fire.
3398 static DISubprogram *getSubprogram(Metadata *LocalScope) {
3402 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
3405 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
3406 return getSubprogram(LB->getRawScope());
3408 // Just return null; broken scope chains are checked elsewhere.
3409 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
3413 template <class DbgIntrinsicTy>
3414 void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
3415 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
3416 Assert(isa<ValueAsMetadata>(MD) ||
3417 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
3418 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
3419 Assert(isa<DILocalVariable>(DII.getRawVariable()),
3420 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
3421 DII.getRawVariable());
3422 Assert(isa<DIExpression>(DII.getRawExpression()),
3423 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
3424 DII.getRawExpression());
3426 // Ignore broken !dbg attachments; they're checked elsewhere.
3427 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
3428 if (!isa<DILocation>(N))
3431 BasicBlock *BB = DII.getParent();
3432 Function *F = BB ? BB->getParent() : nullptr;
3434 // The scopes for variables and !dbg attachments must agree.
3435 DILocalVariable *Var = DII.getVariable();
3436 DILocation *Loc = DII.getDebugLoc();
3437 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
3440 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
3441 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
3442 if (!VarSP || !LocSP)
3443 return; // Broken scope chains are checked elsewhere.
3445 Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
3446 " variable and !dbg attachment",
3447 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
3448 Loc->getScope()->getSubprogram());
3451 template <class MapTy>
3452 static uint64_t getVariableSize(const DILocalVariable &V, const MapTy &Map) {
3453 // Be careful of broken types (checked elsewhere).
3454 const Metadata *RawType = V.getRawType();
3456 // Try to get the size directly.
3457 if (auto *T = dyn_cast<DIType>(RawType))
3458 if (uint64_t Size = T->getSizeInBits())
3461 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
3462 // Look at the base type.
3463 RawType = DT->getRawBaseType();
3467 if (auto *S = dyn_cast<MDString>(RawType)) {
3468 // Don't error on missing types (checked elsewhere).
3469 RawType = Map.lookup(S);
3473 // Missing type or size.
3481 template <class MapTy>
3482 void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I,
3483 const MapTy &TypeRefs) {
3486 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
3487 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
3488 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
3490 auto *DDI = cast<DbgDeclareInst>(&I);
3491 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
3492 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
3495 // We don't know whether this intrinsic verified correctly.
3496 if (!V || !E || !E->isValid())
3499 // Nothing to do if this isn't a bit piece expression.
3500 if (!E->isBitPiece())
3503 // The frontend helps out GDB by emitting the members of local anonymous
3504 // unions as artificial local variables with shared storage. When SROA splits
3505 // the storage for artificial local variables that are smaller than the entire
3506 // union, the overhang piece will be outside of the allotted space for the
3507 // variable and this check fails.
3508 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
3509 if (V->isArtificial())
3512 // If there's no size, the type is broken, but that should be checked
3514 uint64_t VarSize = getVariableSize(*V, TypeRefs);
3518 unsigned PieceSize = E->getBitPieceSize();
3519 unsigned PieceOffset = E->getBitPieceOffset();
3520 Assert(PieceSize + PieceOffset <= VarSize,
3521 "piece is larger than or outside of variable", &I, V, E);
3522 Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
3525 void Verifier::visitUnresolvedTypeRef(const MDString *S, const MDNode *N) {
3526 // This is in its own function so we get an error for each bad type ref (not
3528 Assert(false, "unresolved type ref", S, N);
3531 void Verifier::verifyTypeRefs() {
3532 auto *CUs = M->getNamedMetadata("llvm.dbg.cu");
3536 // Visit all the compile units again to map the type references.
3537 SmallDenseMap<const MDString *, const DIType *, 32> TypeRefs;
3538 for (auto *CU : CUs->operands())
3539 if (auto Ts = cast<DICompileUnit>(CU)->getRetainedTypes())
3540 for (DIType *Op : Ts)
3541 if (auto *T = dyn_cast<DICompositeType>(Op))
3542 if (auto *S = T->getRawIdentifier()) {
3543 UnresolvedTypeRefs.erase(S);
3544 TypeRefs.insert(std::make_pair(S, T));
3547 // Verify debug info intrinsic bit piece expressions. This needs a second
3548 // pass through the intructions, since we haven't built TypeRefs yet when
3549 // verifying functions, and simply queuing the DbgInfoIntrinsics to evaluate
3550 // later/now would queue up some that could be later deleted.
3551 for (const Function &F : *M)
3552 for (const BasicBlock &BB : F)
3553 for (const Instruction &I : BB)
3554 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
3555 verifyBitPieceExpression(*DII, TypeRefs);
3557 // Return early if all typerefs were resolved.
3558 if (UnresolvedTypeRefs.empty())
3561 // Sort the unresolved references by name so the output is deterministic.
3562 typedef std::pair<const MDString *, const MDNode *> TypeRef;
3563 SmallVector<TypeRef, 32> Unresolved(UnresolvedTypeRefs.begin(),
3564 UnresolvedTypeRefs.end());
3565 std::sort(Unresolved.begin(), Unresolved.end(),
3566 [](const TypeRef &LHS, const TypeRef &RHS) {
3567 return LHS.first->getString() < RHS.first->getString();
3570 // Visit the unresolved refs (printing out the errors).
3571 for (const TypeRef &TR : Unresolved)
3572 visitUnresolvedTypeRef(TR.first, TR.second);
3575 //===----------------------------------------------------------------------===//
3576 // Implement the public interfaces to this file...
3577 //===----------------------------------------------------------------------===//
3579 bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
3580 Function &F = const_cast<Function &>(f);
3581 assert(!F.isDeclaration() && "Cannot verify external functions");
3583 raw_null_ostream NullStr;
3584 Verifier V(OS ? *OS : NullStr);
3586 // Note that this function's return value is inverted from what you would
3587 // expect of a function called "verify".
3588 return !V.verify(F);
3591 bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
3592 raw_null_ostream NullStr;
3593 Verifier V(OS ? *OS : NullStr);
3595 bool Broken = false;
3596 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
3597 if (!I->isDeclaration() && !I->isMaterializable())
3598 Broken |= !V.verify(*I);
3600 // Note that this function's return value is inverted from what you would
3601 // expect of a function called "verify".
3602 return !V.verify(M) || Broken;
3606 struct VerifierLegacyPass : public FunctionPass {
3612 VerifierLegacyPass() : FunctionPass(ID), V(dbgs()), FatalErrors(true) {
3613 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3615 explicit VerifierLegacyPass(bool FatalErrors)
3616 : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
3617 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3620 bool runOnFunction(Function &F) override {
3621 if (!V.verify(F) && FatalErrors)
3622 report_fatal_error("Broken function found, compilation aborted!");
3627 bool doFinalization(Module &M) override {
3628 if (!V.verify(M) && FatalErrors)
3629 report_fatal_error("Broken module found, compilation aborted!");
3634 void getAnalysisUsage(AnalysisUsage &AU) const override {
3635 AU.setPreservesAll();
3640 char VerifierLegacyPass::ID = 0;
3641 INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
3643 FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
3644 return new VerifierLegacyPass(FatalErrors);
3647 PreservedAnalyses VerifierPass::run(Module &M) {
3648 if (verifyModule(M, &dbgs()) && FatalErrors)
3649 report_fatal_error("Broken module found, compilation aborted!");
3651 return PreservedAnalyses::all();
3654 PreservedAnalyses VerifierPass::run(Function &F) {
3655 if (verifyFunction(F, &dbgs()) && FatalErrors)
3656 report_fatal_error("Broken function found, compilation aborted!");
3658 return PreservedAnalyses::all();