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 visitMDScope(const MDScope &N);
309 void visitMDDerivedTypeBase(const MDDerivedTypeBase &N);
310 void visitMDVariable(const MDVariable &N);
311 void visitMDLexicalBlockBase(const MDLexicalBlockBase &N);
312 void visitMDTemplateParameter(const MDTemplateParameter &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 MDType, 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 MDScope, 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 DebugNode, 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->getType()->getElementType()->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.getType()->getElementType())) {
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<MDCompileUnit>(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<MDType>(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<MDScope>(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<DebugNode>(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::visitMDLocation(const MDLocation &N) {
752 Assert(N.getRawScope() && isa<MDLocalScope>(N.getRawScope()),
753 "location requires a valid scope", &N, N.getRawScope());
754 if (auto *IA = N.getRawInlinedAt())
755 Assert(isa<MDLocation>(IA), "inlined-at should be a location", &N, IA);
758 void Verifier::visitGenericDebugNode(const GenericDebugNode &N) {
759 Assert(N.getTag(), "invalid tag", &N);
762 void Verifier::visitMDScope(const MDScope &N) {
763 if (auto *F = N.getRawFile())
764 Assert(isa<MDFile>(F), "invalid file", &N, F);
767 void Verifier::visitMDSubrange(const MDSubrange &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::visitMDEnumerator(const MDEnumerator &N) {
773 Assert(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
776 void Verifier::visitMDBasicType(const MDBasicType &N) {
777 Assert(N.getTag() == dwarf::DW_TAG_base_type ||
778 N.getTag() == dwarf::DW_TAG_unspecified_type,
782 void Verifier::visitMDDerivedTypeBase(const MDDerivedTypeBase &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::visitMDDerivedType(const MDDerivedType &N) {
812 // Common derived type checks.
813 visitMDDerivedTypeBase(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 & DebugNode::FlagLValueReference) &&
835 (Flags & DebugNode::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<MDTemplateParameter>(Op), "invalid template parameter", &N,
847 void Verifier::visitMDCompositeType(const MDCompositeType &N) {
848 // Common derived type checks.
849 visitMDDerivedTypeBase(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::visitMDSubroutineType(const MDSubroutineType &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::visitMDFile(const MDFile &N) {
884 Assert(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
887 void Verifier::visitMDCompileUnit(const MDCompileUnit &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<MDFile>(N.getRawFile()),
893 "invalid file", &N, N.getRawFile());
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<MDCompositeType>(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<MDType>(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<MDSubprogram>(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<MDGlobalVariable>(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<MDImportedEntity>(Op), "invalid imported entity ref", &N,
933 void Verifier::visitMDSubprogram(const MDSubprogram &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<MDSubroutineType>(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<MDSubprogram>(S) && !cast<MDSubprogram>(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<MDLocalVariable>(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 MDLocation here since we might be dealing with
977 // broken code (this is the Verifier after all).
979 dyn_cast_or_null<MDLocation>(I.getDebugLoc().getAsMDNode());
982 if (!Seen.insert(DL).second)
985 MDLocalScope *Scope = DL->getInlinedAtScope();
986 if (Scope && !Seen.insert(Scope).second)
989 MDSubprogram *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::visitMDLexicalBlockBase(const MDLexicalBlockBase &N) {
1001 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
1002 Assert(N.getRawScope() && isa<MDLocalScope>(N.getRawScope()),
1003 "invalid local scope", &N, N.getRawScope());
1006 void Verifier::visitMDLexicalBlock(const MDLexicalBlock &N) {
1007 visitMDLexicalBlockBase(N);
1009 Assert(N.getLine() || !N.getColumn(),
1010 "cannot have column info without line info", &N);
1013 void Verifier::visitMDLexicalBlockFile(const MDLexicalBlockFile &N) {
1014 visitMDLexicalBlockBase(N);
1017 void Verifier::visitMDNamespace(const MDNamespace &N) {
1018 Assert(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
1019 if (auto *S = N.getRawScope())
1020 Assert(isa<MDScope>(S), "invalid scope ref", &N, S);
1023 void Verifier::visitMDTemplateParameter(const MDTemplateParameter &N) {
1024 Assert(isTypeRef(N, N.getType()), "invalid type ref", &N, N.getType());
1027 void Verifier::visitMDTemplateTypeParameter(const MDTemplateTypeParameter &N) {
1028 visitMDTemplateParameter(N);
1030 Assert(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1034 void Verifier::visitMDTemplateValueParameter(
1035 const MDTemplateValueParameter &N) {
1036 visitMDTemplateParameter(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::visitMDVariable(const MDVariable &N) {
1045 if (auto *S = N.getRawScope())
1046 Assert(isa<MDScope>(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<MDFile>(F), "invalid file", &N, F);
1052 void Verifier::visitMDGlobalVariable(const MDGlobalVariable &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<MDDerivedType>(Member), "invalid static data member declaration",
1069 void Verifier::visitMDLocalVariable(const MDLocalVariable &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<MDLocalScope>(N.getRawScope()),
1077 "local variable requires a valid scope", &N, N.getRawScope());
1080 void Verifier::visitMDExpression(const MDExpression &N) {
1081 Assert(N.isValid(), "invalid expression", &N);
1084 void Verifier::visitMDObjCProperty(const MDObjCProperty &N) {
1085 Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
1086 if (auto *T = N.getRawType())
1087 Assert(isa<MDType>(T), "invalid type ref", &N, T);
1088 if (auto *F = N.getRawFile())
1089 Assert(isa<MDFile>(F), "invalid file", &N, F);
1092 void Verifier::visitMDImportedEntity(const MDImportedEntity &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<MDScope>(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 .hasAttributes(AttributeFuncs::typeIncompatible(Ty, Idx), Idx),
1354 "Wrong types for attribute: " +
1355 AttributeFuncs::typeIncompatible(Ty, Idx).getAsString(Idx),
1358 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
1359 SmallPtrSet<const Type*, 4> Visited;
1360 if (!PTy->getElementType()->isSized(&Visited)) {
1361 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1362 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1363 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1367 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1368 "Attribute 'byval' only applies to parameters with pointer type!",
1373 // VerifyFunctionAttrs - Check parameter attributes against a function type.
1374 // The value V is printed in error messages.
1375 void Verifier::VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
1377 if (Attrs.isEmpty())
1380 bool SawNest = false;
1381 bool SawReturned = false;
1382 bool SawSRet = false;
1384 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
1385 unsigned Idx = Attrs.getSlotIndex(i);
1389 Ty = FT->getReturnType();
1390 else if (Idx-1 < FT->getNumParams())
1391 Ty = FT->getParamType(Idx-1);
1393 break; // VarArgs attributes, verified elsewhere.
1395 VerifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
1400 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
1401 Assert(!SawNest, "More than one parameter has attribute nest!", V);
1405 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
1406 Assert(!SawReturned, "More than one parameter has attribute returned!",
1408 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1410 "argument and return types for 'returned' attribute",
1415 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
1416 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1417 Assert(Idx == 1 || Idx == 2,
1418 "Attribute 'sret' is not on first or second parameter!", V);
1422 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
1423 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1428 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1431 VerifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
1434 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1435 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1436 "Attributes 'readnone and readonly' are incompatible!", V);
1439 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1440 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1441 Attribute::AlwaysInline)),
1442 "Attributes 'noinline and alwaysinline' are incompatible!", V);
1444 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1445 Attribute::OptimizeNone)) {
1446 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1447 "Attribute 'optnone' requires 'noinline'!", V);
1449 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1450 Attribute::OptimizeForSize),
1451 "Attributes 'optsize and optnone' are incompatible!", V);
1453 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1454 "Attributes 'minsize and optnone' are incompatible!", V);
1457 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1458 Attribute::JumpTable)) {
1459 const GlobalValue *GV = cast<GlobalValue>(V);
1460 Assert(GV->hasUnnamedAddr(),
1461 "Attribute 'jumptable' requires 'unnamed_addr'", V);
1465 void Verifier::VerifyConstantExprBitcastType(const ConstantExpr *CE) {
1466 if (CE->getOpcode() != Instruction::BitCast)
1469 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1471 "Invalid bitcast", CE);
1474 bool Verifier::VerifyAttributeCount(AttributeSet Attrs, unsigned Params) {
1475 if (Attrs.getNumSlots() == 0)
1478 unsigned LastSlot = Attrs.getNumSlots() - 1;
1479 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
1480 if (LastIndex <= Params
1481 || (LastIndex == AttributeSet::FunctionIndex
1482 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
1488 /// \brief Verify that statepoint intrinsic is well formed.
1489 void Verifier::VerifyStatepoint(ImmutableCallSite CS) {
1490 assert(CS.getCalledFunction() &&
1491 CS.getCalledFunction()->getIntrinsicID() ==
1492 Intrinsic::experimental_gc_statepoint);
1494 const Instruction &CI = *CS.getInstruction();
1496 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory(),
1497 "gc.statepoint must read and write memory to preserve "
1498 "reordering restrictions required by safepoint semantics",
1501 const Value *Target = CS.getArgument(0);
1502 const PointerType *PT = dyn_cast<PointerType>(Target->getType());
1503 Assert(PT && PT->getElementType()->isFunctionTy(),
1504 "gc.statepoint callee must be of function pointer type", &CI, Target);
1505 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
1507 const Value *NumCallArgsV = CS.getArgument(1);
1508 Assert(isa<ConstantInt>(NumCallArgsV),
1509 "gc.statepoint number of arguments to underlying call "
1510 "must be constant integer",
1512 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
1513 Assert(NumCallArgs >= 0,
1514 "gc.statepoint number of arguments to underlying call "
1517 const int NumParams = (int)TargetFuncType->getNumParams();
1518 if (TargetFuncType->isVarArg()) {
1519 Assert(NumCallArgs >= NumParams,
1520 "gc.statepoint mismatch in number of vararg call args", &CI);
1522 // TODO: Remove this limitation
1523 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1524 "gc.statepoint doesn't support wrapping non-void "
1525 "vararg functions yet",
1528 Assert(NumCallArgs == NumParams,
1529 "gc.statepoint mismatch in number of call args", &CI);
1531 const Value *Unused = CS.getArgument(2);
1532 Assert(isa<ConstantInt>(Unused) && cast<ConstantInt>(Unused)->isNullValue(),
1533 "gc.statepoint parameter #3 must be zero", &CI);
1535 // Verify that the types of the call parameter arguments match
1536 // the type of the wrapped callee.
1537 for (int i = 0; i < NumParams; i++) {
1538 Type *ParamType = TargetFuncType->getParamType(i);
1539 Type *ArgType = CS.getArgument(3+i)->getType();
1540 Assert(ArgType == ParamType,
1541 "gc.statepoint call argument does not match wrapped "
1545 const int EndCallArgsInx = 2+NumCallArgs;
1546 const Value *NumDeoptArgsV = CS.getArgument(EndCallArgsInx+1);
1547 Assert(isa<ConstantInt>(NumDeoptArgsV),
1548 "gc.statepoint number of deoptimization arguments "
1549 "must be constant integer",
1551 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
1552 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1556 Assert(4 + NumCallArgs + NumDeoptArgs <= (int)CS.arg_size(),
1557 "gc.statepoint too few arguments according to length fields", &CI);
1559 // Check that the only uses of this gc.statepoint are gc.result or
1560 // gc.relocate calls which are tied to this statepoint and thus part
1561 // of the same statepoint sequence
1562 for (const User *U : CI.users()) {
1563 const CallInst *Call = dyn_cast<const CallInst>(U);
1564 Assert(Call, "illegal use of statepoint token", &CI, U);
1565 if (!Call) continue;
1566 Assert(isGCRelocate(Call) || isGCResult(Call),
1567 "gc.result or gc.relocate are the only value uses"
1568 "of a gc.statepoint",
1570 if (isGCResult(Call)) {
1571 Assert(Call->getArgOperand(0) == &CI,
1572 "gc.result connected to wrong gc.statepoint", &CI, Call);
1573 } else if (isGCRelocate(Call)) {
1574 Assert(Call->getArgOperand(0) == &CI,
1575 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
1579 // Note: It is legal for a single derived pointer to be listed multiple
1580 // times. It's non-optimal, but it is legal. It can also happen after
1581 // insertion if we strip a bitcast away.
1582 // Note: It is really tempting to check that each base is relocated and
1583 // that a derived pointer is never reused as a base pointer. This turns
1584 // out to be problematic since optimizations run after safepoint insertion
1585 // can recognize equality properties that the insertion logic doesn't know
1586 // about. See example statepoint.ll in the verifier subdirectory
1589 void Verifier::verifyFrameRecoverIndices() {
1590 for (auto &Counts : FrameEscapeInfo) {
1591 Function *F = Counts.first;
1592 unsigned EscapedObjectCount = Counts.second.first;
1593 unsigned MaxRecoveredIndex = Counts.second.second;
1594 Assert(MaxRecoveredIndex <= EscapedObjectCount,
1595 "all indices passed to llvm.framerecover must be less than the "
1596 "number of arguments passed ot llvm.frameescape in the parent "
1602 // visitFunction - Verify that a function is ok.
1604 void Verifier::visitFunction(const Function &F) {
1605 // Check function arguments.
1606 FunctionType *FT = F.getFunctionType();
1607 unsigned NumArgs = F.arg_size();
1609 Assert(Context == &F.getContext(),
1610 "Function context does not match Module context!", &F);
1612 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1613 Assert(FT->getNumParams() == NumArgs,
1614 "# formal arguments must match # of arguments for function type!", &F,
1616 Assert(F.getReturnType()->isFirstClassType() ||
1617 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1618 "Functions cannot return aggregate values!", &F);
1620 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1621 "Invalid struct return type!", &F);
1623 AttributeSet Attrs = F.getAttributes();
1625 Assert(VerifyAttributeCount(Attrs, FT->getNumParams()),
1626 "Attribute after last parameter!", &F);
1628 // Check function attributes.
1629 VerifyFunctionAttrs(FT, Attrs, &F);
1631 // On function declarations/definitions, we do not support the builtin
1632 // attribute. We do not check this in VerifyFunctionAttrs since that is
1633 // checking for Attributes that can/can not ever be on functions.
1634 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1635 "Attribute 'builtin' can only be applied to a callsite.", &F);
1637 // Check that this function meets the restrictions on this calling convention.
1638 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1639 // restrictions can be lifted.
1640 switch (F.getCallingConv()) {
1642 case CallingConv::C:
1644 case CallingConv::Fast:
1645 case CallingConv::Cold:
1646 case CallingConv::Intel_OCL_BI:
1647 case CallingConv::PTX_Kernel:
1648 case CallingConv::PTX_Device:
1649 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1650 "perfect forwarding!",
1655 bool isLLVMdotName = F.getName().size() >= 5 &&
1656 F.getName().substr(0, 5) == "llvm.";
1658 // Check that the argument values match the function type for this function...
1660 for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E;
1662 Assert(I->getType() == FT->getParamType(i),
1663 "Argument value does not match function argument type!", I,
1664 FT->getParamType(i));
1665 Assert(I->getType()->isFirstClassType(),
1666 "Function arguments must have first-class types!", I);
1668 Assert(!I->getType()->isMetadataTy(),
1669 "Function takes metadata but isn't an intrinsic", I, &F);
1672 // Get the function metadata attachments.
1673 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1674 F.getAllMetadata(MDs);
1675 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
1677 if (F.isMaterializable()) {
1678 // Function has a body somewhere we can't see.
1679 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
1680 MDs.empty() ? nullptr : MDs.front().second);
1681 } else if (F.isDeclaration()) {
1682 Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1683 "invalid linkage type for function declaration", &F);
1684 Assert(MDs.empty(), "function without a body cannot have metadata", &F,
1685 MDs.empty() ? nullptr : MDs.front().second);
1687 // Verify that this function (which has a body) is not named "llvm.*". It
1688 // is not legal to define intrinsics.
1689 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
1691 // Check the entry node
1692 const BasicBlock *Entry = &F.getEntryBlock();
1693 Assert(pred_empty(Entry),
1694 "Entry block to function must not have predecessors!", Entry);
1696 // The address of the entry block cannot be taken, unless it is dead.
1697 if (Entry->hasAddressTaken()) {
1698 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1699 "blockaddress may not be used with the entry block!", Entry);
1702 // Visit metadata attachments.
1703 for (const auto &I : MDs)
1704 visitMDNode(*I.second);
1707 // If this function is actually an intrinsic, verify that it is only used in
1708 // direct call/invokes, never having its "address taken".
1709 if (F.getIntrinsicID()) {
1711 if (F.hasAddressTaken(&U))
1712 Assert(0, "Invalid user of intrinsic instruction!", U);
1715 Assert(!F.hasDLLImportStorageClass() ||
1716 (F.isDeclaration() && F.hasExternalLinkage()) ||
1717 F.hasAvailableExternallyLinkage(),
1718 "Function is marked as dllimport, but not external.", &F);
1721 // verifyBasicBlock - Verify that a basic block is well formed...
1723 void Verifier::visitBasicBlock(BasicBlock &BB) {
1724 InstsInThisBlock.clear();
1726 // Ensure that basic blocks have terminators!
1727 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
1729 // Check constraints that this basic block imposes on all of the PHI nodes in
1731 if (isa<PHINode>(BB.front())) {
1732 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
1733 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
1734 std::sort(Preds.begin(), Preds.end());
1736 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
1737 // Ensure that PHI nodes have at least one entry!
1738 Assert(PN->getNumIncomingValues() != 0,
1739 "PHI nodes must have at least one entry. If the block is dead, "
1740 "the PHI should be removed!",
1742 Assert(PN->getNumIncomingValues() == Preds.size(),
1743 "PHINode should have one entry for each predecessor of its "
1744 "parent basic block!",
1747 // Get and sort all incoming values in the PHI node...
1749 Values.reserve(PN->getNumIncomingValues());
1750 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1751 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
1752 PN->getIncomingValue(i)));
1753 std::sort(Values.begin(), Values.end());
1755 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
1756 // Check to make sure that if there is more than one entry for a
1757 // particular basic block in this PHI node, that the incoming values are
1760 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
1761 Values[i].second == Values[i - 1].second,
1762 "PHI node has multiple entries for the same basic block with "
1763 "different incoming values!",
1764 PN, Values[i].first, Values[i].second, Values[i - 1].second);
1766 // Check to make sure that the predecessors and PHI node entries are
1768 Assert(Values[i].first == Preds[i],
1769 "PHI node entries do not match predecessors!", PN,
1770 Values[i].first, Preds[i]);
1775 // Check that all instructions have their parent pointers set up correctly.
1778 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
1782 void Verifier::visitTerminatorInst(TerminatorInst &I) {
1783 // Ensure that terminators only exist at the end of the basic block.
1784 Assert(&I == I.getParent()->getTerminator(),
1785 "Terminator found in the middle of a basic block!", I.getParent());
1786 visitInstruction(I);
1789 void Verifier::visitBranchInst(BranchInst &BI) {
1790 if (BI.isConditional()) {
1791 Assert(BI.getCondition()->getType()->isIntegerTy(1),
1792 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
1794 visitTerminatorInst(BI);
1797 void Verifier::visitReturnInst(ReturnInst &RI) {
1798 Function *F = RI.getParent()->getParent();
1799 unsigned N = RI.getNumOperands();
1800 if (F->getReturnType()->isVoidTy())
1802 "Found return instr that returns non-void in Function of void "
1804 &RI, F->getReturnType());
1806 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
1807 "Function return type does not match operand "
1808 "type of return inst!",
1809 &RI, F->getReturnType());
1811 // Check to make sure that the return value has necessary properties for
1813 visitTerminatorInst(RI);
1816 void Verifier::visitSwitchInst(SwitchInst &SI) {
1817 // Check to make sure that all of the constants in the switch instruction
1818 // have the same type as the switched-on value.
1819 Type *SwitchTy = SI.getCondition()->getType();
1820 SmallPtrSet<ConstantInt*, 32> Constants;
1821 for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end(); i != e; ++i) {
1822 Assert(i.getCaseValue()->getType() == SwitchTy,
1823 "Switch constants must all be same type as switch value!", &SI);
1824 Assert(Constants.insert(i.getCaseValue()).second,
1825 "Duplicate integer as switch case", &SI, i.getCaseValue());
1828 visitTerminatorInst(SI);
1831 void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
1832 Assert(BI.getAddress()->getType()->isPointerTy(),
1833 "Indirectbr operand must have pointer type!", &BI);
1834 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
1835 Assert(BI.getDestination(i)->getType()->isLabelTy(),
1836 "Indirectbr destinations must all have pointer type!", &BI);
1838 visitTerminatorInst(BI);
1841 void Verifier::visitSelectInst(SelectInst &SI) {
1842 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
1844 "Invalid operands for select instruction!", &SI);
1846 Assert(SI.getTrueValue()->getType() == SI.getType(),
1847 "Select values must have same type as select instruction!", &SI);
1848 visitInstruction(SI);
1851 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
1852 /// a pass, if any exist, it's an error.
1854 void Verifier::visitUserOp1(Instruction &I) {
1855 Assert(0, "User-defined operators should not live outside of a pass!", &I);
1858 void Verifier::visitTruncInst(TruncInst &I) {
1859 // Get the source and destination types
1860 Type *SrcTy = I.getOperand(0)->getType();
1861 Type *DestTy = I.getType();
1863 // Get the size of the types in bits, we'll need this later
1864 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1865 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1867 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
1868 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
1869 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1870 "trunc source and destination must both be a vector or neither", &I);
1871 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
1873 visitInstruction(I);
1876 void Verifier::visitZExtInst(ZExtInst &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 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
1883 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
1884 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1885 "zext source and destination must both be a vector or neither", &I);
1886 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1887 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1889 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
1891 visitInstruction(I);
1894 void Verifier::visitSExtInst(SExtInst &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 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1901 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1903 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
1904 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
1905 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1906 "sext source and destination must both be a vector or neither", &I);
1907 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
1909 visitInstruction(I);
1912 void Verifier::visitFPTruncInst(FPTruncInst &I) {
1913 // Get the source and destination types
1914 Type *SrcTy = I.getOperand(0)->getType();
1915 Type *DestTy = I.getType();
1916 // Get the size of the types in bits, we'll need this later
1917 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1918 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1920 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
1921 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
1922 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1923 "fptrunc source and destination must both be a vector or neither", &I);
1924 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
1926 visitInstruction(I);
1929 void Verifier::visitFPExtInst(FPExtInst &I) {
1930 // Get the source and destination types
1931 Type *SrcTy = I.getOperand(0)->getType();
1932 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(), "FPExt only operates on FP", &I);
1939 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
1940 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1941 "fpext source and destination must both be a vector or neither", &I);
1942 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
1944 visitInstruction(I);
1947 void Verifier::visitUIToFPInst(UIToFPInst &I) {
1948 // Get the source and destination types
1949 Type *SrcTy = I.getOperand(0)->getType();
1950 Type *DestTy = I.getType();
1952 bool SrcVec = SrcTy->isVectorTy();
1953 bool DstVec = DestTy->isVectorTy();
1955 Assert(SrcVec == DstVec,
1956 "UIToFP source and dest must both be vector or scalar", &I);
1957 Assert(SrcTy->isIntOrIntVectorTy(),
1958 "UIToFP source must be integer or integer vector", &I);
1959 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
1962 if (SrcVec && DstVec)
1963 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
1964 cast<VectorType>(DestTy)->getNumElements(),
1965 "UIToFP source and dest vector length mismatch", &I);
1967 visitInstruction(I);
1970 void Verifier::visitSIToFPInst(SIToFPInst &I) {
1971 // Get the source and destination types
1972 Type *SrcTy = I.getOperand(0)->getType();
1973 Type *DestTy = I.getType();
1975 bool SrcVec = SrcTy->isVectorTy();
1976 bool DstVec = DestTy->isVectorTy();
1978 Assert(SrcVec == DstVec,
1979 "SIToFP source and dest must both be vector or scalar", &I);
1980 Assert(SrcTy->isIntOrIntVectorTy(),
1981 "SIToFP source must be integer or integer vector", &I);
1982 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
1985 if (SrcVec && DstVec)
1986 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
1987 cast<VectorType>(DestTy)->getNumElements(),
1988 "SIToFP source and dest vector length mismatch", &I);
1990 visitInstruction(I);
1993 void Verifier::visitFPToUIInst(FPToUIInst &I) {
1994 // Get the source and destination types
1995 Type *SrcTy = I.getOperand(0)->getType();
1996 Type *DestTy = I.getType();
1998 bool SrcVec = SrcTy->isVectorTy();
1999 bool DstVec = DestTy->isVectorTy();
2001 Assert(SrcVec == DstVec,
2002 "FPToUI source and dest must both be vector or scalar", &I);
2003 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2005 Assert(DestTy->isIntOrIntVectorTy(),
2006 "FPToUI result must be integer or integer vector", &I);
2008 if (SrcVec && DstVec)
2009 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2010 cast<VectorType>(DestTy)->getNumElements(),
2011 "FPToUI source and dest vector length mismatch", &I);
2013 visitInstruction(I);
2016 void Verifier::visitFPToSIInst(FPToSIInst &I) {
2017 // Get the source and destination types
2018 Type *SrcTy = I.getOperand(0)->getType();
2019 Type *DestTy = I.getType();
2021 bool SrcVec = SrcTy->isVectorTy();
2022 bool DstVec = DestTy->isVectorTy();
2024 Assert(SrcVec == DstVec,
2025 "FPToSI source and dest must both be vector or scalar", &I);
2026 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2028 Assert(DestTy->isIntOrIntVectorTy(),
2029 "FPToSI result must be integer or integer vector", &I);
2031 if (SrcVec && DstVec)
2032 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2033 cast<VectorType>(DestTy)->getNumElements(),
2034 "FPToSI source and dest vector length mismatch", &I);
2036 visitInstruction(I);
2039 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2040 // Get the source and destination types
2041 Type *SrcTy = I.getOperand(0)->getType();
2042 Type *DestTy = I.getType();
2044 Assert(SrcTy->getScalarType()->isPointerTy(),
2045 "PtrToInt source must be pointer", &I);
2046 Assert(DestTy->getScalarType()->isIntegerTy(),
2047 "PtrToInt result must be integral", &I);
2048 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2051 if (SrcTy->isVectorTy()) {
2052 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2053 VectorType *VDest = dyn_cast<VectorType>(DestTy);
2054 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2055 "PtrToInt Vector width mismatch", &I);
2058 visitInstruction(I);
2061 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2062 // Get the source and destination types
2063 Type *SrcTy = I.getOperand(0)->getType();
2064 Type *DestTy = I.getType();
2066 Assert(SrcTy->getScalarType()->isIntegerTy(),
2067 "IntToPtr source must be an integral", &I);
2068 Assert(DestTy->getScalarType()->isPointerTy(),
2069 "IntToPtr result must be a pointer", &I);
2070 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2072 if (SrcTy->isVectorTy()) {
2073 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2074 VectorType *VDest = dyn_cast<VectorType>(DestTy);
2075 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2076 "IntToPtr Vector width mismatch", &I);
2078 visitInstruction(I);
2081 void Verifier::visitBitCastInst(BitCastInst &I) {
2083 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2084 "Invalid bitcast", &I);
2085 visitInstruction(I);
2088 void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2089 Type *SrcTy = I.getOperand(0)->getType();
2090 Type *DestTy = I.getType();
2092 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2094 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2096 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2097 "AddrSpaceCast must be between different address spaces", &I);
2098 if (SrcTy->isVectorTy())
2099 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2100 "AddrSpaceCast vector pointer number of elements mismatch", &I);
2101 visitInstruction(I);
2104 /// visitPHINode - Ensure that a PHI node is well formed.
2106 void Verifier::visitPHINode(PHINode &PN) {
2107 // Ensure that the PHI nodes are all grouped together at the top of the block.
2108 // This can be tested by checking whether the instruction before this is
2109 // either nonexistent (because this is begin()) or is a PHI node. If not,
2110 // then there is some other instruction before a PHI.
2111 Assert(&PN == &PN.getParent()->front() ||
2112 isa<PHINode>(--BasicBlock::iterator(&PN)),
2113 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
2115 // Check that all of the values of the PHI node have the same type as the
2116 // result, and that the incoming blocks are really basic blocks.
2117 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
2118 Assert(PN.getType() == PN.getIncomingValue(i)->getType(),
2119 "PHI node operands are not the same type as the result!", &PN);
2122 // All other PHI node constraints are checked in the visitBasicBlock method.
2124 visitInstruction(PN);
2127 void Verifier::VerifyCallSite(CallSite CS) {
2128 Instruction *I = CS.getInstruction();
2130 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2131 "Called function must be a pointer!", I);
2132 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
2134 Assert(FPTy->getElementType()->isFunctionTy(),
2135 "Called function is not pointer to function type!", I);
2137 Assert(FPTy->getElementType() == CS.getFunctionType(),
2138 "Called function is not the same type as the call!", I);
2140 FunctionType *FTy = CS.getFunctionType();
2142 // Verify that the correct number of arguments are being passed
2143 if (FTy->isVarArg())
2144 Assert(CS.arg_size() >= FTy->getNumParams(),
2145 "Called function requires more parameters than were provided!", I);
2147 Assert(CS.arg_size() == FTy->getNumParams(),
2148 "Incorrect number of arguments passed to called function!", I);
2150 // Verify that all arguments to the call match the function type.
2151 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2152 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2153 "Call parameter type does not match function signature!",
2154 CS.getArgument(i), FTy->getParamType(i), I);
2156 AttributeSet Attrs = CS.getAttributes();
2158 Assert(VerifyAttributeCount(Attrs, CS.arg_size()),
2159 "Attribute after last parameter!", I);
2161 // Verify call attributes.
2162 VerifyFunctionAttrs(FTy, Attrs, I);
2164 // Conservatively check the inalloca argument.
2165 // We have a bug if we can find that there is an underlying alloca without
2167 if (CS.hasInAllocaArgument()) {
2168 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2169 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
2170 Assert(AI->isUsedWithInAlloca(),
2171 "inalloca argument for call has mismatched alloca", AI, I);
2174 if (FTy->isVarArg()) {
2175 // FIXME? is 'nest' even legal here?
2176 bool SawNest = false;
2177 bool SawReturned = false;
2179 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2180 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2182 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2186 // Check attributes on the varargs part.
2187 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
2188 Type *Ty = CS.getArgument(Idx-1)->getType();
2189 VerifyParameterAttrs(Attrs, Idx, Ty, false, I);
2191 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
2192 Assert(!SawNest, "More than one parameter has attribute nest!", I);
2196 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
2197 Assert(!SawReturned, "More than one parameter has attribute returned!",
2199 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2200 "Incompatible argument and return types for 'returned' "
2206 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2207 "Attribute 'sret' cannot be used for vararg call arguments!", I);
2209 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
2210 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
2214 // Verify that there's no metadata unless it's a direct call to an intrinsic.
2215 if (CS.getCalledFunction() == nullptr ||
2216 !CS.getCalledFunction()->getName().startswith("llvm.")) {
2217 for (FunctionType::param_iterator PI = FTy->param_begin(),
2218 PE = FTy->param_end(); PI != PE; ++PI)
2219 Assert(!(*PI)->isMetadataTy(),
2220 "Function has metadata parameter but isn't an intrinsic", I);
2223 visitInstruction(*I);
2226 /// Two types are "congruent" if they are identical, or if they are both pointer
2227 /// types with different pointee types and the same address space.
2228 static bool isTypeCongruent(Type *L, Type *R) {
2231 PointerType *PL = dyn_cast<PointerType>(L);
2232 PointerType *PR = dyn_cast<PointerType>(R);
2235 return PL->getAddressSpace() == PR->getAddressSpace();
2238 static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2239 static const Attribute::AttrKind ABIAttrs[] = {
2240 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
2241 Attribute::InReg, Attribute::Returned};
2243 for (auto AK : ABIAttrs) {
2244 if (Attrs.hasAttribute(I + 1, AK))
2245 Copy.addAttribute(AK);
2247 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2248 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2252 void Verifier::verifyMustTailCall(CallInst &CI) {
2253 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
2255 // - The caller and callee prototypes must match. Pointer types of
2256 // parameters or return types may differ in pointee type, but not
2258 Function *F = CI.getParent()->getParent();
2259 FunctionType *CallerTy = F->getFunctionType();
2260 FunctionType *CalleeTy = CI.getFunctionType();
2261 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2262 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2263 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2264 "cannot guarantee tail call due to mismatched varargs", &CI);
2265 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2266 "cannot guarantee tail call due to mismatched return types", &CI);
2267 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2269 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2270 "cannot guarantee tail call due to mismatched parameter types", &CI);
2273 // - The calling conventions of the caller and callee must match.
2274 Assert(F->getCallingConv() == CI.getCallingConv(),
2275 "cannot guarantee tail call due to mismatched calling conv", &CI);
2277 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2278 // returned, and inalloca, must match.
2279 AttributeSet CallerAttrs = F->getAttributes();
2280 AttributeSet CalleeAttrs = CI.getAttributes();
2281 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2282 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2283 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
2284 Assert(CallerABIAttrs == CalleeABIAttrs,
2285 "cannot guarantee tail call due to mismatched ABI impacting "
2286 "function attributes",
2287 &CI, CI.getOperand(I));
2290 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2291 // or a pointer bitcast followed by a ret instruction.
2292 // - The ret instruction must return the (possibly bitcasted) value
2293 // produced by the call or void.
2294 Value *RetVal = &CI;
2295 Instruction *Next = CI.getNextNode();
2297 // Handle the optional bitcast.
2298 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
2299 Assert(BI->getOperand(0) == RetVal,
2300 "bitcast following musttail call must use the call", BI);
2302 Next = BI->getNextNode();
2305 // Check the return.
2306 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
2307 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2309 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2310 "musttail call result must be returned", Ret);
2313 void Verifier::visitCallInst(CallInst &CI) {
2314 VerifyCallSite(&CI);
2316 if (CI.isMustTailCall())
2317 verifyMustTailCall(CI);
2319 if (Function *F = CI.getCalledFunction())
2320 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
2321 visitIntrinsicFunctionCall(ID, CI);
2324 void Verifier::visitInvokeInst(InvokeInst &II) {
2325 VerifyCallSite(&II);
2327 // Verify that there is a landingpad instruction as the first non-PHI
2328 // instruction of the 'unwind' destination.
2329 Assert(II.getUnwindDest()->isLandingPad(),
2330 "The unwind destination does not have a landingpad instruction!", &II);
2332 if (Function *F = II.getCalledFunction())
2333 // TODO: Ideally we should use visitIntrinsicFunction here. But it uses
2334 // CallInst as an input parameter. It not woth updating this whole
2335 // function only to support statepoint verification.
2336 if (F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint)
2337 VerifyStatepoint(ImmutableCallSite(&II));
2339 visitTerminatorInst(II);
2342 /// visitBinaryOperator - Check that both arguments to the binary operator are
2343 /// of the same type!
2345 void Verifier::visitBinaryOperator(BinaryOperator &B) {
2346 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2347 "Both operands to a binary operator are not of the same type!", &B);
2349 switch (B.getOpcode()) {
2350 // Check that integer arithmetic operators are only used with
2351 // integral operands.
2352 case Instruction::Add:
2353 case Instruction::Sub:
2354 case Instruction::Mul:
2355 case Instruction::SDiv:
2356 case Instruction::UDiv:
2357 case Instruction::SRem:
2358 case Instruction::URem:
2359 Assert(B.getType()->isIntOrIntVectorTy(),
2360 "Integer arithmetic operators only work with integral types!", &B);
2361 Assert(B.getType() == B.getOperand(0)->getType(),
2362 "Integer arithmetic operators must have same type "
2363 "for operands and result!",
2366 // Check that floating-point arithmetic operators are only used with
2367 // floating-point operands.
2368 case Instruction::FAdd:
2369 case Instruction::FSub:
2370 case Instruction::FMul:
2371 case Instruction::FDiv:
2372 case Instruction::FRem:
2373 Assert(B.getType()->isFPOrFPVectorTy(),
2374 "Floating-point arithmetic operators only work with "
2375 "floating-point types!",
2377 Assert(B.getType() == B.getOperand(0)->getType(),
2378 "Floating-point arithmetic operators must have same type "
2379 "for operands and result!",
2382 // Check that logical operators are only used with integral operands.
2383 case Instruction::And:
2384 case Instruction::Or:
2385 case Instruction::Xor:
2386 Assert(B.getType()->isIntOrIntVectorTy(),
2387 "Logical operators only work with integral types!", &B);
2388 Assert(B.getType() == B.getOperand(0)->getType(),
2389 "Logical operators must have same type for operands and result!",
2392 case Instruction::Shl:
2393 case Instruction::LShr:
2394 case Instruction::AShr:
2395 Assert(B.getType()->isIntOrIntVectorTy(),
2396 "Shifts only work with integral types!", &B);
2397 Assert(B.getType() == B.getOperand(0)->getType(),
2398 "Shift return type must be same as operands!", &B);
2401 llvm_unreachable("Unknown BinaryOperator opcode!");
2404 visitInstruction(B);
2407 void Verifier::visitICmpInst(ICmpInst &IC) {
2408 // Check that the operands are the same type
2409 Type *Op0Ty = IC.getOperand(0)->getType();
2410 Type *Op1Ty = IC.getOperand(1)->getType();
2411 Assert(Op0Ty == Op1Ty,
2412 "Both operands to ICmp instruction are not of the same type!", &IC);
2413 // Check that the operands are the right type
2414 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2415 "Invalid operand types for ICmp instruction", &IC);
2416 // Check that the predicate is valid.
2417 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2418 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2419 "Invalid predicate in ICmp instruction!", &IC);
2421 visitInstruction(IC);
2424 void Verifier::visitFCmpInst(FCmpInst &FC) {
2425 // Check that the operands are the same type
2426 Type *Op0Ty = FC.getOperand(0)->getType();
2427 Type *Op1Ty = FC.getOperand(1)->getType();
2428 Assert(Op0Ty == Op1Ty,
2429 "Both operands to FCmp instruction are not of the same type!", &FC);
2430 // Check that the operands are the right type
2431 Assert(Op0Ty->isFPOrFPVectorTy(),
2432 "Invalid operand types for FCmp instruction", &FC);
2433 // Check that the predicate is valid.
2434 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2435 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2436 "Invalid predicate in FCmp instruction!", &FC);
2438 visitInstruction(FC);
2441 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
2443 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2444 "Invalid extractelement operands!", &EI);
2445 visitInstruction(EI);
2448 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
2449 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2451 "Invalid insertelement operands!", &IE);
2452 visitInstruction(IE);
2455 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
2456 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2458 "Invalid shufflevector operands!", &SV);
2459 visitInstruction(SV);
2462 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
2463 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
2465 Assert(isa<PointerType>(TargetTy),
2466 "GEP base pointer is not a vector or a vector of pointers", &GEP);
2467 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
2468 Assert(GEP.getPointerOperandType()->isVectorTy() ==
2469 GEP.getType()->isVectorTy(),
2470 "Vector GEP must return a vector value", &GEP);
2472 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
2474 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
2475 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
2477 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
2478 GEP.getResultElementType() == ElTy,
2479 "GEP is not of right type for indices!", &GEP, ElTy);
2481 if (GEP.getPointerOperandType()->isVectorTy()) {
2482 // Additional checks for vector GEPs.
2483 unsigned GepWidth = GEP.getPointerOperandType()->getVectorNumElements();
2484 Assert(GepWidth == GEP.getType()->getVectorNumElements(),
2485 "Vector GEP result width doesn't match operand's", &GEP);
2486 for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
2487 Type *IndexTy = Idxs[i]->getType();
2488 Assert(IndexTy->isVectorTy(), "Vector GEP must have vector indices!",
2490 unsigned IndexWidth = IndexTy->getVectorNumElements();
2491 Assert(IndexWidth == GepWidth, "Invalid GEP index vector width", &GEP);
2494 visitInstruction(GEP);
2497 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2498 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2501 void Verifier::visitRangeMetadata(Instruction& I,
2502 MDNode* Range, Type* Ty) {
2504 Range == I.getMetadata(LLVMContext::MD_range) &&
2505 "precondition violation");
2507 unsigned NumOperands = Range->getNumOperands();
2508 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
2509 unsigned NumRanges = NumOperands / 2;
2510 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2512 ConstantRange LastRange(1); // Dummy initial value
2513 for (unsigned i = 0; i < NumRanges; ++i) {
2515 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
2516 Assert(Low, "The lower limit must be an integer!", Low);
2518 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
2519 Assert(High, "The upper limit must be an integer!", High);
2520 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2521 "Range types must match instruction type!", &I);
2523 APInt HighV = High->getValue();
2524 APInt LowV = Low->getValue();
2525 ConstantRange CurRange(LowV, HighV);
2526 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2527 "Range must not be empty!", Range);
2529 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2530 "Intervals are overlapping", Range);
2531 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2533 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2536 LastRange = ConstantRange(LowV, HighV);
2538 if (NumRanges > 2) {
2540 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
2542 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
2543 ConstantRange FirstRange(FirstLow, FirstHigh);
2544 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2545 "Intervals are overlapping", Range);
2546 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2551 void Verifier::visitLoadInst(LoadInst &LI) {
2552 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
2553 Assert(PTy, "Load operand must be a pointer.", &LI);
2554 Type *ElTy = LI.getType();
2555 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2556 "huge alignment values are unsupported", &LI);
2557 if (LI.isAtomic()) {
2558 Assert(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
2559 "Load cannot have Release ordering", &LI);
2560 Assert(LI.getAlignment() != 0,
2561 "Atomic load must specify explicit alignment", &LI);
2562 if (!ElTy->isPointerTy()) {
2563 Assert(ElTy->isIntegerTy(), "atomic load operand must have integer type!",
2565 unsigned Size = ElTy->getPrimitiveSizeInBits();
2566 Assert(Size >= 8 && !(Size & (Size - 1)),
2567 "atomic load operand must be power-of-two byte-sized integer", &LI,
2571 Assert(LI.getSynchScope() == CrossThread,
2572 "Non-atomic load cannot have SynchronizationScope specified", &LI);
2575 visitInstruction(LI);
2578 void Verifier::visitStoreInst(StoreInst &SI) {
2579 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
2580 Assert(PTy, "Store operand must be a pointer.", &SI);
2581 Type *ElTy = PTy->getElementType();
2582 Assert(ElTy == SI.getOperand(0)->getType(),
2583 "Stored value type does not match pointer operand type!", &SI, ElTy);
2584 Assert(SI.getAlignment() <= Value::MaximumAlignment,
2585 "huge alignment values are unsupported", &SI);
2586 if (SI.isAtomic()) {
2587 Assert(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
2588 "Store cannot have Acquire ordering", &SI);
2589 Assert(SI.getAlignment() != 0,
2590 "Atomic store must specify explicit alignment", &SI);
2591 if (!ElTy->isPointerTy()) {
2592 Assert(ElTy->isIntegerTy(),
2593 "atomic store operand must have integer type!", &SI, ElTy);
2594 unsigned Size = ElTy->getPrimitiveSizeInBits();
2595 Assert(Size >= 8 && !(Size & (Size - 1)),
2596 "atomic store operand must be power-of-two byte-sized integer",
2600 Assert(SI.getSynchScope() == CrossThread,
2601 "Non-atomic store cannot have SynchronizationScope specified", &SI);
2603 visitInstruction(SI);
2606 void Verifier::visitAllocaInst(AllocaInst &AI) {
2607 SmallPtrSet<const Type*, 4> Visited;
2608 PointerType *PTy = AI.getType();
2609 Assert(PTy->getAddressSpace() == 0,
2610 "Allocation instruction pointer not in the generic address space!",
2612 Assert(AI.getAllocatedType()->isSized(&Visited),
2613 "Cannot allocate unsized type", &AI);
2614 Assert(AI.getArraySize()->getType()->isIntegerTy(),
2615 "Alloca array size must have integer type", &AI);
2616 Assert(AI.getAlignment() <= Value::MaximumAlignment,
2617 "huge alignment values are unsupported", &AI);
2619 visitInstruction(AI);
2622 void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
2624 // FIXME: more conditions???
2625 Assert(CXI.getSuccessOrdering() != NotAtomic,
2626 "cmpxchg instructions must be atomic.", &CXI);
2627 Assert(CXI.getFailureOrdering() != NotAtomic,
2628 "cmpxchg instructions must be atomic.", &CXI);
2629 Assert(CXI.getSuccessOrdering() != Unordered,
2630 "cmpxchg instructions cannot be unordered.", &CXI);
2631 Assert(CXI.getFailureOrdering() != Unordered,
2632 "cmpxchg instructions cannot be unordered.", &CXI);
2633 Assert(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
2634 "cmpxchg instructions be at least as constrained on success as fail",
2636 Assert(CXI.getFailureOrdering() != Release &&
2637 CXI.getFailureOrdering() != AcquireRelease,
2638 "cmpxchg failure ordering cannot include release semantics", &CXI);
2640 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
2641 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
2642 Type *ElTy = PTy->getElementType();
2643 Assert(ElTy->isIntegerTy(), "cmpxchg operand must have integer type!", &CXI,
2645 unsigned Size = ElTy->getPrimitiveSizeInBits();
2646 Assert(Size >= 8 && !(Size & (Size - 1)),
2647 "cmpxchg operand must be power-of-two byte-sized integer", &CXI, ElTy);
2648 Assert(ElTy == CXI.getOperand(1)->getType(),
2649 "Expected value type does not match pointer operand type!", &CXI,
2651 Assert(ElTy == CXI.getOperand(2)->getType(),
2652 "Stored value type does not match pointer operand type!", &CXI, ElTy);
2653 visitInstruction(CXI);
2656 void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
2657 Assert(RMWI.getOrdering() != NotAtomic,
2658 "atomicrmw instructions must be atomic.", &RMWI);
2659 Assert(RMWI.getOrdering() != Unordered,
2660 "atomicrmw instructions cannot be unordered.", &RMWI);
2661 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
2662 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
2663 Type *ElTy = PTy->getElementType();
2664 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
2666 unsigned Size = ElTy->getPrimitiveSizeInBits();
2667 Assert(Size >= 8 && !(Size & (Size - 1)),
2668 "atomicrmw operand must be power-of-two byte-sized integer", &RMWI,
2670 Assert(ElTy == RMWI.getOperand(1)->getType(),
2671 "Argument value type does not match pointer operand type!", &RMWI,
2673 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
2674 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
2675 "Invalid binary operation!", &RMWI);
2676 visitInstruction(RMWI);
2679 void Verifier::visitFenceInst(FenceInst &FI) {
2680 const AtomicOrdering Ordering = FI.getOrdering();
2681 Assert(Ordering == Acquire || Ordering == Release ||
2682 Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
2683 "fence instructions may only have "
2684 "acquire, release, acq_rel, or seq_cst ordering.",
2686 visitInstruction(FI);
2689 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
2690 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
2691 EVI.getIndices()) == EVI.getType(),
2692 "Invalid ExtractValueInst operands!", &EVI);
2694 visitInstruction(EVI);
2697 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
2698 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
2699 IVI.getIndices()) ==
2700 IVI.getOperand(1)->getType(),
2701 "Invalid InsertValueInst operands!", &IVI);
2703 visitInstruction(IVI);
2706 void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
2707 BasicBlock *BB = LPI.getParent();
2709 // The landingpad instruction is ill-formed if it doesn't have any clauses and
2711 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
2712 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
2714 // The landingpad instruction defines its parent as a landing pad block. The
2715 // landing pad block may be branched to only by the unwind edge of an invoke.
2716 for (pred_iterator I = pred_begin(BB), E = pred_end(BB); I != E; ++I) {
2717 const InvokeInst *II = dyn_cast<InvokeInst>((*I)->getTerminator());
2718 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
2719 "Block containing LandingPadInst must be jumped to "
2720 "only by the unwind edge of an invoke.",
2724 // The landingpad instruction must be the first non-PHI instruction in the
2726 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
2727 "LandingPadInst not the first non-PHI instruction in the block.",
2730 // The personality functions for all landingpad instructions within the same
2731 // function should match.
2733 Assert(LPI.getPersonalityFn() == PersonalityFn,
2734 "Personality function doesn't match others in function", &LPI);
2735 PersonalityFn = LPI.getPersonalityFn();
2737 // All operands must be constants.
2738 Assert(isa<Constant>(PersonalityFn), "Personality function is not constant!",
2740 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
2741 Constant *Clause = LPI.getClause(i);
2742 if (LPI.isCatch(i)) {
2743 Assert(isa<PointerType>(Clause->getType()),
2744 "Catch operand does not have pointer type!", &LPI);
2746 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
2747 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
2748 "Filter operand is not an array of constants!", &LPI);
2752 visitInstruction(LPI);
2755 void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
2756 Instruction *Op = cast<Instruction>(I.getOperand(i));
2757 // If the we have an invalid invoke, don't try to compute the dominance.
2758 // We already reject it in the invoke specific checks and the dominance
2759 // computation doesn't handle multiple edges.
2760 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
2761 if (II->getNormalDest() == II->getUnwindDest())
2765 const Use &U = I.getOperandUse(i);
2766 Assert(InstsInThisBlock.count(Op) || DT.dominates(Op, U),
2767 "Instruction does not dominate all uses!", Op, &I);
2770 /// verifyInstruction - Verify that an instruction is well formed.
2772 void Verifier::visitInstruction(Instruction &I) {
2773 BasicBlock *BB = I.getParent();
2774 Assert(BB, "Instruction not embedded in basic block!", &I);
2776 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
2777 for (User *U : I.users()) {
2778 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
2779 "Only PHI nodes may reference their own value!", &I);
2783 // Check that void typed values don't have names
2784 Assert(!I.getType()->isVoidTy() || !I.hasName(),
2785 "Instruction has a name, but provides a void value!", &I);
2787 // Check that the return value of the instruction is either void or a legal
2789 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
2790 "Instruction returns a non-scalar type!", &I);
2792 // Check that the instruction doesn't produce metadata. Calls are already
2793 // checked against the callee type.
2794 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
2795 "Invalid use of metadata!", &I);
2797 // Check that all uses of the instruction, if they are instructions
2798 // themselves, actually have parent basic blocks. If the use is not an
2799 // instruction, it is an error!
2800 for (Use &U : I.uses()) {
2801 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
2802 Assert(Used->getParent() != nullptr,
2803 "Instruction referencing"
2804 " instruction not embedded in a basic block!",
2807 CheckFailed("Use of instruction is not an instruction!", U);
2812 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
2813 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
2815 // Check to make sure that only first-class-values are operands to
2817 if (!I.getOperand(i)->getType()->isFirstClassType()) {
2818 Assert(0, "Instruction operands must be first-class values!", &I);
2821 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
2822 // Check to make sure that the "address of" an intrinsic function is never
2825 !F->isIntrinsic() ||
2826 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
2827 "Cannot take the address of an intrinsic!", &I);
2829 !F->isIntrinsic() || isa<CallInst>(I) ||
2830 F->getIntrinsicID() == Intrinsic::donothing ||
2831 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
2832 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
2833 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
2834 "Cannot invoke an intrinsinc other than"
2835 " donothing or patchpoint",
2837 Assert(F->getParent() == M, "Referencing function in another module!",
2839 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
2840 Assert(OpBB->getParent() == BB->getParent(),
2841 "Referring to a basic block in another function!", &I);
2842 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
2843 Assert(OpArg->getParent() == BB->getParent(),
2844 "Referring to an argument in another function!", &I);
2845 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
2846 Assert(GV->getParent() == M, "Referencing global in another module!", &I);
2847 } else if (isa<Instruction>(I.getOperand(i))) {
2848 verifyDominatesUse(I, i);
2849 } else if (isa<InlineAsm>(I.getOperand(i))) {
2850 Assert((i + 1 == e && isa<CallInst>(I)) ||
2851 (i + 3 == e && isa<InvokeInst>(I)),
2852 "Cannot take the address of an inline asm!", &I);
2853 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
2854 if (CE->getType()->isPtrOrPtrVectorTy()) {
2855 // If we have a ConstantExpr pointer, we need to see if it came from an
2856 // illegal bitcast (inttoptr <constant int> )
2857 SmallVector<const ConstantExpr *, 4> Stack;
2858 SmallPtrSet<const ConstantExpr *, 4> Visited;
2859 Stack.push_back(CE);
2861 while (!Stack.empty()) {
2862 const ConstantExpr *V = Stack.pop_back_val();
2863 if (!Visited.insert(V).second)
2866 VerifyConstantExprBitcastType(V);
2868 for (unsigned I = 0, N = V->getNumOperands(); I != N; ++I) {
2869 if (ConstantExpr *Op = dyn_cast<ConstantExpr>(V->getOperand(I)))
2870 Stack.push_back(Op);
2877 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
2878 Assert(I.getType()->isFPOrFPVectorTy(),
2879 "fpmath requires a floating point result!", &I);
2880 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
2881 if (ConstantFP *CFP0 =
2882 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
2883 APFloat Accuracy = CFP0->getValueAPF();
2884 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
2885 "fpmath accuracy not a positive number!", &I);
2887 Assert(false, "invalid fpmath accuracy!", &I);
2891 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
2892 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
2893 "Ranges are only for loads, calls and invokes!", &I);
2894 visitRangeMetadata(I, Range, I.getType());
2897 if (I.getMetadata(LLVMContext::MD_nonnull)) {
2898 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
2900 Assert(isa<LoadInst>(I),
2901 "nonnull applies only to load instructions, use attributes"
2902 " for calls or invokes",
2906 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
2907 Assert(isa<MDLocation>(N), "invalid !dbg metadata attachment", &I, N);
2911 InstsInThisBlock.insert(&I);
2914 /// VerifyIntrinsicType - Verify that the specified type (which comes from an
2915 /// intrinsic argument or return value) matches the type constraints specified
2916 /// by the .td file (e.g. an "any integer" argument really is an integer).
2918 /// This return true on error but does not print a message.
2919 bool Verifier::VerifyIntrinsicType(Type *Ty,
2920 ArrayRef<Intrinsic::IITDescriptor> &Infos,
2921 SmallVectorImpl<Type*> &ArgTys) {
2922 using namespace Intrinsic;
2924 // If we ran out of descriptors, there are too many arguments.
2925 if (Infos.empty()) return true;
2926 IITDescriptor D = Infos.front();
2927 Infos = Infos.slice(1);
2930 case IITDescriptor::Void: return !Ty->isVoidTy();
2931 case IITDescriptor::VarArg: return true;
2932 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
2933 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
2934 case IITDescriptor::Half: return !Ty->isHalfTy();
2935 case IITDescriptor::Float: return !Ty->isFloatTy();
2936 case IITDescriptor::Double: return !Ty->isDoubleTy();
2937 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
2938 case IITDescriptor::Vector: {
2939 VectorType *VT = dyn_cast<VectorType>(Ty);
2940 return !VT || VT->getNumElements() != D.Vector_Width ||
2941 VerifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
2943 case IITDescriptor::Pointer: {
2944 PointerType *PT = dyn_cast<PointerType>(Ty);
2945 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
2946 VerifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
2949 case IITDescriptor::Struct: {
2950 StructType *ST = dyn_cast<StructType>(Ty);
2951 if (!ST || ST->getNumElements() != D.Struct_NumElements)
2954 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
2955 if (VerifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
2960 case IITDescriptor::Argument:
2961 // Two cases here - If this is the second occurrence of an argument, verify
2962 // that the later instance matches the previous instance.
2963 if (D.getArgumentNumber() < ArgTys.size())
2964 return Ty != ArgTys[D.getArgumentNumber()];
2966 // Otherwise, if this is the first instance of an argument, record it and
2967 // verify the "Any" kind.
2968 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
2969 ArgTys.push_back(Ty);
2971 switch (D.getArgumentKind()) {
2972 case IITDescriptor::AK_Any: return false; // Success
2973 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
2974 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
2975 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
2976 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
2978 llvm_unreachable("all argument kinds not covered");
2980 case IITDescriptor::ExtendArgument: {
2981 // This may only be used when referring to a previous vector argument.
2982 if (D.getArgumentNumber() >= ArgTys.size())
2985 Type *NewTy = ArgTys[D.getArgumentNumber()];
2986 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
2987 NewTy = VectorType::getExtendedElementVectorType(VTy);
2988 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
2989 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
2995 case IITDescriptor::TruncArgument: {
2996 // This may only be used when referring to a previous vector argument.
2997 if (D.getArgumentNumber() >= ArgTys.size())
3000 Type *NewTy = ArgTys[D.getArgumentNumber()];
3001 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3002 NewTy = VectorType::getTruncatedElementVectorType(VTy);
3003 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3004 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
3010 case IITDescriptor::HalfVecArgument:
3011 // This may only be used when referring to a previous vector argument.
3012 return D.getArgumentNumber() >= ArgTys.size() ||
3013 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
3014 VectorType::getHalfElementsVectorType(
3015 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
3016 case IITDescriptor::SameVecWidthArgument: {
3017 if (D.getArgumentNumber() >= ArgTys.size())
3019 VectorType * ReferenceType =
3020 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
3021 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
3022 if (!ThisArgType || !ReferenceType ||
3023 (ReferenceType->getVectorNumElements() !=
3024 ThisArgType->getVectorNumElements()))
3026 return VerifyIntrinsicType(ThisArgType->getVectorElementType(),
3029 case IITDescriptor::PtrToArgument: {
3030 if (D.getArgumentNumber() >= ArgTys.size())
3032 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
3033 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
3034 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
3036 case IITDescriptor::VecOfPtrsToElt: {
3037 if (D.getArgumentNumber() >= ArgTys.size())
3039 VectorType * ReferenceType =
3040 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
3041 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
3042 if (!ThisArgVecTy || !ReferenceType ||
3043 (ReferenceType->getVectorNumElements() !=
3044 ThisArgVecTy->getVectorNumElements()))
3046 PointerType *ThisArgEltTy =
3047 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
3050 return (!(ThisArgEltTy->getElementType() ==
3051 ReferenceType->getVectorElementType()));
3054 llvm_unreachable("unhandled");
3057 /// \brief Verify if the intrinsic has variable arguments.
3058 /// This method is intended to be called after all the fixed arguments have been
3061 /// This method returns true on error and does not print an error message.
3063 Verifier::VerifyIntrinsicIsVarArg(bool isVarArg,
3064 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
3065 using namespace Intrinsic;
3067 // If there are no descriptors left, then it can't be a vararg.
3071 // There should be only one descriptor remaining at this point.
3072 if (Infos.size() != 1)
3075 // Check and verify the descriptor.
3076 IITDescriptor D = Infos.front();
3077 Infos = Infos.slice(1);
3078 if (D.Kind == IITDescriptor::VarArg)
3084 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
3086 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
3087 Function *IF = CI.getCalledFunction();
3088 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3091 // Verify that the intrinsic prototype lines up with what the .td files
3093 FunctionType *IFTy = IF->getFunctionType();
3094 bool IsVarArg = IFTy->isVarArg();
3096 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3097 getIntrinsicInfoTableEntries(ID, Table);
3098 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
3100 SmallVector<Type *, 4> ArgTys;
3101 Assert(!VerifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
3102 "Intrinsic has incorrect return type!", IF);
3103 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
3104 Assert(!VerifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
3105 "Intrinsic has incorrect argument type!", IF);
3107 // Verify if the intrinsic call matches the vararg property.
3109 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3110 "Intrinsic was not defined with variable arguments!", IF);
3112 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3113 "Callsite was not defined with variable arguments!", IF);
3115 // All descriptors should be absorbed by now.
3116 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
3118 // Now that we have the intrinsic ID and the actual argument types (and we
3119 // know they are legal for the intrinsic!) get the intrinsic name through the
3120 // usual means. This allows us to verify the mangling of argument types into
3122 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
3123 Assert(ExpectedName == IF->getName(),
3124 "Intrinsic name not mangled correctly for type arguments! "
3129 // If the intrinsic takes MDNode arguments, verify that they are either global
3130 // or are local to *this* function.
3131 for (unsigned i = 0, e = CI.getNumArgOperands(); i != e; ++i)
3132 if (auto *MD = dyn_cast<MetadataAsValue>(CI.getArgOperand(i)))
3133 visitMetadataAsValue(*MD, CI.getParent()->getParent());
3138 case Intrinsic::ctlz: // llvm.ctlz
3139 case Intrinsic::cttz: // llvm.cttz
3140 Assert(isa<ConstantInt>(CI.getArgOperand(1)),
3141 "is_zero_undef argument of bit counting intrinsics must be a "
3145 case Intrinsic::dbg_declare: // llvm.dbg.declare
3146 Assert(isa<MetadataAsValue>(CI.getArgOperand(0)),
3147 "invalid llvm.dbg.declare intrinsic call 1", &CI);
3148 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(CI));
3150 case Intrinsic::dbg_value: // llvm.dbg.value
3151 visitDbgIntrinsic("value", cast<DbgValueInst>(CI));
3153 case Intrinsic::memcpy:
3154 case Intrinsic::memmove:
3155 case Intrinsic::memset: {
3156 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CI.getArgOperand(3));
3158 "alignment argument of memory intrinsics must be a constant int",
3160 const APInt &AlignVal = AlignCI->getValue();
3161 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
3162 "alignment argument of memory intrinsics must be a power of 2", &CI);
3163 Assert(isa<ConstantInt>(CI.getArgOperand(4)),
3164 "isvolatile argument of memory intrinsics must be a constant int",
3168 case Intrinsic::gcroot:
3169 case Intrinsic::gcwrite:
3170 case Intrinsic::gcread:
3171 if (ID == Intrinsic::gcroot) {
3173 dyn_cast<AllocaInst>(CI.getArgOperand(0)->stripPointerCasts());
3174 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", &CI);
3175 Assert(isa<Constant>(CI.getArgOperand(1)),
3176 "llvm.gcroot parameter #2 must be a constant.", &CI);
3177 if (!AI->getType()->getElementType()->isPointerTy()) {
3178 Assert(!isa<ConstantPointerNull>(CI.getArgOperand(1)),
3179 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3180 "or argument #2 must be a non-null constant.",
3185 Assert(CI.getParent()->getParent()->hasGC(),
3186 "Enclosing function does not use GC.", &CI);
3188 case Intrinsic::init_trampoline:
3189 Assert(isa<Function>(CI.getArgOperand(1)->stripPointerCasts()),
3190 "llvm.init_trampoline parameter #2 must resolve to a function.",
3193 case Intrinsic::prefetch:
3194 Assert(isa<ConstantInt>(CI.getArgOperand(1)) &&
3195 isa<ConstantInt>(CI.getArgOperand(2)) &&
3196 cast<ConstantInt>(CI.getArgOperand(1))->getZExtValue() < 2 &&
3197 cast<ConstantInt>(CI.getArgOperand(2))->getZExtValue() < 4,
3198 "invalid arguments to llvm.prefetch", &CI);
3200 case Intrinsic::stackprotector:
3201 Assert(isa<AllocaInst>(CI.getArgOperand(1)->stripPointerCasts()),
3202 "llvm.stackprotector parameter #2 must resolve to an alloca.", &CI);
3204 case Intrinsic::lifetime_start:
3205 case Intrinsic::lifetime_end:
3206 case Intrinsic::invariant_start:
3207 Assert(isa<ConstantInt>(CI.getArgOperand(0)),
3208 "size argument of memory use markers must be a constant integer",
3211 case Intrinsic::invariant_end:
3212 Assert(isa<ConstantInt>(CI.getArgOperand(1)),
3213 "llvm.invariant.end parameter #2 must be a constant integer", &CI);
3216 case Intrinsic::frameescape: {
3217 BasicBlock *BB = CI.getParent();
3218 Assert(BB == &BB->getParent()->front(),
3219 "llvm.frameescape used outside of entry block", &CI);
3220 Assert(!SawFrameEscape,
3221 "multiple calls to llvm.frameescape in one function", &CI);
3222 for (Value *Arg : CI.arg_operands()) {
3223 if (isa<ConstantPointerNull>(Arg))
3224 continue; // Null values are allowed as placeholders.
3225 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
3226 Assert(AI && AI->isStaticAlloca(),
3227 "llvm.frameescape only accepts static allocas", &CI);
3229 FrameEscapeInfo[BB->getParent()].first = CI.getNumArgOperands();
3230 SawFrameEscape = true;
3233 case Intrinsic::framerecover: {
3234 Value *FnArg = CI.getArgOperand(0)->stripPointerCasts();
3235 Function *Fn = dyn_cast<Function>(FnArg);
3236 Assert(Fn && !Fn->isDeclaration(),
3237 "llvm.framerecover first "
3238 "argument must be function defined in this module",
3240 auto *IdxArg = dyn_cast<ConstantInt>(CI.getArgOperand(2));
3241 Assert(IdxArg, "idx argument of llvm.framerecover must be a constant int",
3243 auto &Entry = FrameEscapeInfo[Fn];
3244 Entry.second = unsigned(
3245 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
3249 case Intrinsic::experimental_gc_statepoint:
3250 Assert(!CI.isInlineAsm(),
3251 "gc.statepoint support for inline assembly unimplemented", &CI);
3252 Assert(CI.getParent()->getParent()->hasGC(),
3253 "Enclosing function does not use GC.", &CI);
3255 VerifyStatepoint(ImmutableCallSite(&CI));
3257 case Intrinsic::experimental_gc_result_int:
3258 case Intrinsic::experimental_gc_result_float:
3259 case Intrinsic::experimental_gc_result_ptr:
3260 case Intrinsic::experimental_gc_result: {
3261 Assert(CI.getParent()->getParent()->hasGC(),
3262 "Enclosing function does not use GC.", &CI);
3263 // Are we tied to a statepoint properly?
3264 CallSite StatepointCS(CI.getArgOperand(0));
3265 const Function *StatepointFn =
3266 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
3267 Assert(StatepointFn && StatepointFn->isDeclaration() &&
3268 StatepointFn->getIntrinsicID() ==
3269 Intrinsic::experimental_gc_statepoint,
3270 "gc.result operand #1 must be from a statepoint", &CI,
3271 CI.getArgOperand(0));
3273 // Assert that result type matches wrapped callee.
3274 const Value *Target = StatepointCS.getArgument(0);
3275 const PointerType *PT = cast<PointerType>(Target->getType());
3276 const FunctionType *TargetFuncType =
3277 cast<FunctionType>(PT->getElementType());
3278 Assert(CI.getType() == TargetFuncType->getReturnType(),
3279 "gc.result result type does not match wrapped callee", &CI);
3282 case Intrinsic::experimental_gc_relocate: {
3283 Assert(CI.getNumArgOperands() == 3, "wrong number of arguments", &CI);
3285 // Check that this relocate is correctly tied to the statepoint
3287 // This is case for relocate on the unwinding path of an invoke statepoint
3288 if (ExtractValueInst *ExtractValue =
3289 dyn_cast<ExtractValueInst>(CI.getArgOperand(0))) {
3290 Assert(isa<LandingPadInst>(ExtractValue->getAggregateOperand()),
3291 "gc relocate on unwind path incorrectly linked to the statepoint",
3294 const BasicBlock *invokeBB =
3295 ExtractValue->getParent()->getUniquePredecessor();
3297 // Landingpad relocates should have only one predecessor with invoke
3298 // statepoint terminator
3299 Assert(invokeBB, "safepoints should have unique landingpads",
3300 ExtractValue->getParent());
3301 Assert(invokeBB->getTerminator(), "safepoint block should be well formed",
3303 Assert(isStatepoint(invokeBB->getTerminator()),
3304 "gc relocate should be linked to a statepoint", invokeBB);
3307 // In all other cases relocate should be tied to the statepoint directly.
3308 // This covers relocates on a normal return path of invoke statepoint and
3309 // relocates of a call statepoint
3310 auto Token = CI.getArgOperand(0);
3311 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
3312 "gc relocate is incorrectly tied to the statepoint", &CI, Token);
3315 // Verify rest of the relocate arguments
3317 GCRelocateOperands ops(&CI);
3318 ImmutableCallSite StatepointCS(ops.statepoint());
3320 // Both the base and derived must be piped through the safepoint
3321 Value* Base = CI.getArgOperand(1);
3322 Assert(isa<ConstantInt>(Base),
3323 "gc.relocate operand #2 must be integer offset", &CI);
3325 Value* Derived = CI.getArgOperand(2);
3326 Assert(isa<ConstantInt>(Derived),
3327 "gc.relocate operand #3 must be integer offset", &CI);
3329 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
3330 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
3332 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
3333 "gc.relocate: statepoint base index out of bounds", &CI);
3334 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
3335 "gc.relocate: statepoint derived index out of bounds", &CI);
3337 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
3338 // section of the statepoint's argument
3339 Assert(StatepointCS.arg_size() > 0,
3340 "gc.statepoint: insufficient arguments");
3341 Assert(isa<ConstantInt>(StatepointCS.getArgument(1)),
3342 "gc.statement: number of call arguments must be constant integer");
3343 const unsigned NumCallArgs =
3344 cast<ConstantInt>(StatepointCS.getArgument(1))->getZExtValue();
3345 Assert(StatepointCS.arg_size() > NumCallArgs+3,
3346 "gc.statepoint: mismatch in number of call arguments");
3347 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs+3)),
3348 "gc.statepoint: number of deoptimization arguments must be "
3349 "a constant integer");
3350 const int NumDeoptArgs =
3351 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 3))->getZExtValue();
3352 const int GCParamArgsStart = NumCallArgs + NumDeoptArgs + 4;
3353 const int GCParamArgsEnd = StatepointCS.arg_size();
3354 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
3355 "gc.relocate: statepoint base index doesn't fall within the "
3356 "'gc parameters' section of the statepoint call",
3358 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
3359 "gc.relocate: statepoint derived index doesn't fall within the "
3360 "'gc parameters' section of the statepoint call",
3363 // Assert that the result type matches the type of the relocated pointer
3364 GCRelocateOperands Operands(&CI);
3365 Assert(Operands.derivedPtr()->getType() == CI.getType(),
3366 "gc.relocate: relocating a pointer shouldn't change its type", &CI);
3372 /// \brief Carefully grab the subprogram from a local scope.
3374 /// This carefully grabs the subprogram from a local scope, avoiding the
3375 /// built-in assertions that would typically fire.
3376 static MDSubprogram *getSubprogram(Metadata *LocalScope) {
3380 if (auto *SP = dyn_cast<MDSubprogram>(LocalScope))
3383 if (auto *LB = dyn_cast<MDLexicalBlockBase>(LocalScope))
3384 return getSubprogram(LB->getRawScope());
3386 // Just return null; broken scope chains are checked elsewhere.
3387 assert(!isa<MDLocalScope>(LocalScope) && "Unknown type of local scope");
3391 template <class DbgIntrinsicTy>
3392 void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
3393 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
3394 Assert(isa<ValueAsMetadata>(MD) ||
3395 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
3396 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
3397 Assert(isa<MDLocalVariable>(DII.getRawVariable()),
3398 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
3399 DII.getRawVariable());
3400 Assert(isa<MDExpression>(DII.getRawExpression()),
3401 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
3402 DII.getRawExpression());
3404 // Ignore broken !dbg attachments; they're checked elsewhere.
3405 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
3406 if (!isa<MDLocation>(N))
3409 BasicBlock *BB = DII.getParent();
3410 Function *F = BB ? BB->getParent() : nullptr;
3412 // The scopes for variables and !dbg attachments must agree.
3413 MDLocalVariable *Var = DII.getVariable();
3414 MDLocation *Loc = DII.getDebugLoc();
3415 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
3418 MDSubprogram *VarSP = getSubprogram(Var->getRawScope());
3419 MDSubprogram *LocSP = getSubprogram(Loc->getRawScope());
3420 if (!VarSP || !LocSP)
3421 return; // Broken scope chains are checked elsewhere.
3423 Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
3424 " variable and !dbg attachment",
3425 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
3426 Loc->getScope()->getSubprogram());
3429 template <class MapTy>
3430 static uint64_t getVariableSize(const MDLocalVariable &V, const MapTy &Map) {
3431 // Be careful of broken types (checked elsewhere).
3432 const Metadata *RawType = V.getRawType();
3434 // Try to get the size directly.
3435 if (auto *T = dyn_cast<MDType>(RawType))
3436 if (uint64_t Size = T->getSizeInBits())
3439 if (auto *DT = dyn_cast<MDDerivedType>(RawType)) {
3440 // Look at the base type.
3441 RawType = DT->getRawBaseType();
3445 if (auto *S = dyn_cast<MDString>(RawType)) {
3446 // Don't error on missing types (checked elsewhere).
3447 RawType = Map.lookup(S);
3451 // Missing type or size.
3459 template <class MapTy>
3460 void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I,
3461 const MapTy &TypeRefs) {
3464 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
3465 V = dyn_cast_or_null<MDLocalVariable>(DVI->getRawVariable());
3466 E = dyn_cast_or_null<MDExpression>(DVI->getRawExpression());
3468 auto *DDI = cast<DbgDeclareInst>(&I);
3469 V = dyn_cast_or_null<MDLocalVariable>(DDI->getRawVariable());
3470 E = dyn_cast_or_null<MDExpression>(DDI->getRawExpression());
3473 // We don't know whether this intrinsic verified correctly.
3474 if (!V || !E || !E->isValid())
3477 // Nothing to do if this isn't a bit piece expression.
3478 if (!E->isBitPiece())
3481 // If there's no size, the type is broken, but that should be checked
3483 uint64_t VarSize = getVariableSize(*V, TypeRefs);
3487 unsigned PieceSize = E->getBitPieceSize();
3488 unsigned PieceOffset = E->getBitPieceOffset();
3489 Assert(PieceSize + PieceOffset <= VarSize,
3490 "piece is larger than or outside of variable", &I, V, E);
3491 Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
3494 void Verifier::visitUnresolvedTypeRef(const MDString *S, const MDNode *N) {
3495 // This is in its own function so we get an error for each bad type ref (not
3497 Assert(false, "unresolved type ref", S, N);
3500 void Verifier::verifyTypeRefs() {
3501 auto *CUs = M->getNamedMetadata("llvm.dbg.cu");
3505 // Visit all the compile units again to map the type references.
3506 SmallDenseMap<const MDString *, const MDType *, 32> TypeRefs;
3507 for (auto *CU : CUs->operands())
3508 if (auto Ts = cast<MDCompileUnit>(CU)->getRetainedTypes())
3509 for (MDType *Op : Ts)
3510 if (auto *T = dyn_cast<MDCompositeType>(Op))
3511 if (auto *S = T->getRawIdentifier()) {
3512 UnresolvedTypeRefs.erase(S);
3513 TypeRefs.insert(std::make_pair(S, T));
3516 // Verify debug info intrinsic bit piece expressions. This needs a second
3517 // pass through the intructions, since we haven't built TypeRefs yet when
3518 // verifying functions, and simply queuing the DbgInfoIntrinsics to evaluate
3519 // later/now would queue up some that could be later deleted.
3520 for (const Function &F : *M)
3521 for (const BasicBlock &BB : F)
3522 for (const Instruction &I : BB)
3523 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
3524 verifyBitPieceExpression(*DII, TypeRefs);
3526 // Return early if all typerefs were resolved.
3527 if (UnresolvedTypeRefs.empty())
3530 // Sort the unresolved references by name so the output is deterministic.
3531 typedef std::pair<const MDString *, const MDNode *> TypeRef;
3532 SmallVector<TypeRef, 32> Unresolved(UnresolvedTypeRefs.begin(),
3533 UnresolvedTypeRefs.end());
3534 std::sort(Unresolved.begin(), Unresolved.end(),
3535 [](const TypeRef &LHS, const TypeRef &RHS) {
3536 return LHS.first->getString() < RHS.first->getString();
3539 // Visit the unresolved refs (printing out the errors).
3540 for (const TypeRef &TR : Unresolved)
3541 visitUnresolvedTypeRef(TR.first, TR.second);
3544 //===----------------------------------------------------------------------===//
3545 // Implement the public interfaces to this file...
3546 //===----------------------------------------------------------------------===//
3548 bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
3549 Function &F = const_cast<Function &>(f);
3550 assert(!F.isDeclaration() && "Cannot verify external functions");
3552 raw_null_ostream NullStr;
3553 Verifier V(OS ? *OS : NullStr);
3555 // Note that this function's return value is inverted from what you would
3556 // expect of a function called "verify".
3557 return !V.verify(F);
3560 bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
3561 raw_null_ostream NullStr;
3562 Verifier V(OS ? *OS : NullStr);
3564 bool Broken = false;
3565 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
3566 if (!I->isDeclaration() && !I->isMaterializable())
3567 Broken |= !V.verify(*I);
3569 // Note that this function's return value is inverted from what you would
3570 // expect of a function called "verify".
3571 return !V.verify(M) || Broken;
3575 struct VerifierLegacyPass : public FunctionPass {
3581 VerifierLegacyPass() : FunctionPass(ID), V(dbgs()), FatalErrors(true) {
3582 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3584 explicit VerifierLegacyPass(bool FatalErrors)
3585 : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
3586 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3589 bool runOnFunction(Function &F) override {
3590 if (!V.verify(F) && FatalErrors)
3591 report_fatal_error("Broken function found, compilation aborted!");
3596 bool doFinalization(Module &M) override {
3597 if (!V.verify(M) && FatalErrors)
3598 report_fatal_error("Broken module found, compilation aborted!");
3603 void getAnalysisUsage(AnalysisUsage &AU) const override {
3604 AU.setPreservesAll();
3609 char VerifierLegacyPass::ID = 0;
3610 INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
3612 FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
3613 return new VerifierLegacyPass(FatalErrors);
3616 PreservedAnalyses VerifierPass::run(Module &M) {
3617 if (verifyModule(M, &dbgs()) && FatalErrors)
3618 report_fatal_error("Broken module found, compilation aborted!");
3620 return PreservedAnalyses::all();
3623 PreservedAnalyses VerifierPass::run(Function &F) {
3624 if (verifyFunction(F, &dbgs()) && FatalErrors)
3625 report_fatal_error("Broken function found, compilation aborted!");
3627 return PreservedAnalyses::all();