1 //===-- Verifier.cpp - Implement the Module Verifier -----------------------==//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the function verifier interface, that can be used for some
11 // sanity checking of input to the system.
13 // Note that this does not provide full `Java style' security and verifications,
14 // instead it just tries to ensure that code is well-formed.
16 // * Both of a binary operator's parameters are of the same type
17 // * Verify that the indices of mem access instructions match other operands
18 // * Verify that arithmetic and other things are only performed on first-class
19 // types. Verify that shifts & logicals only happen on integrals f.e.
20 // * All of the constants in a switch statement are of the correct type
21 // * The code is in valid SSA form
22 // * It should be illegal to put a label into any other type (like a structure)
23 // or to return one. [except constant arrays!]
24 // * Only phi nodes can be self referential: 'add i32 %0, %0 ; <int>:0' is bad
25 // * PHI nodes must have an entry for each predecessor, with no extras.
26 // * PHI nodes must be the first thing in a basic block, all grouped together
27 // * PHI nodes must have at least one entry
28 // * All basic blocks should only end with terminator insts, not contain them
29 // * The entry node to a function must not have predecessors
30 // * All Instructions must be embedded into a basic block
31 // * Functions cannot take a void-typed parameter
32 // * Verify that a function's argument list agrees with it's declared type.
33 // * It is illegal to specify a name for a void value.
34 // * It is illegal to have a internal global value with no initializer
35 // * It is illegal to have a ret instruction that returns a value that does not
36 // agree with the function return value type.
37 // * Function call argument types match the function prototype
38 // * A landing pad is defined by a landingpad instruction, and can be jumped to
39 // only by the unwind edge of an invoke instruction.
40 // * A landingpad instruction must be the first non-PHI instruction in the
42 // * All landingpad instructions must use the same personality function with
44 // * All other things that are tested by asserts spread about the code...
46 //===----------------------------------------------------------------------===//
48 #include "llvm/IR/Verifier.h"
49 #include "llvm/ADT/STLExtras.h"
50 #include "llvm/ADT/SetVector.h"
51 #include "llvm/ADT/SmallPtrSet.h"
52 #include "llvm/ADT/SmallVector.h"
53 #include "llvm/ADT/StringExtras.h"
54 #include "llvm/IR/CFG.h"
55 #include "llvm/IR/CallSite.h"
56 #include "llvm/IR/CallingConv.h"
57 #include "llvm/IR/ConstantRange.h"
58 #include "llvm/IR/Constants.h"
59 #include "llvm/IR/DataLayout.h"
60 #include "llvm/IR/DebugInfo.h"
61 #include "llvm/IR/DerivedTypes.h"
62 #include "llvm/IR/Dominators.h"
63 #include "llvm/IR/InlineAsm.h"
64 #include "llvm/IR/InstIterator.h"
65 #include "llvm/IR/InstVisitor.h"
66 #include "llvm/IR/IntrinsicInst.h"
67 #include "llvm/IR/LLVMContext.h"
68 #include "llvm/IR/Metadata.h"
69 #include "llvm/IR/Module.h"
70 #include "llvm/IR/PassManager.h"
71 #include "llvm/IR/Statepoint.h"
72 #include "llvm/Pass.h"
73 #include "llvm/Support/CommandLine.h"
74 #include "llvm/Support/Debug.h"
75 #include "llvm/Support/ErrorHandling.h"
76 #include "llvm/Support/raw_ostream.h"
81 static cl::opt<bool> VerifyDebugInfo("verify-debug-info", cl::init(true));
84 struct VerifierSupport {
88 /// \brief Track the brokenness of the module while recursively visiting.
91 explicit VerifierSupport(raw_ostream &OS)
92 : OS(OS), M(nullptr), Broken(false) {}
95 void Write(const Value *V) {
98 if (isa<Instruction>(V)) {
101 V->printAsOperand(OS, true, M);
105 void Write(ImmutableCallSite CS) {
106 Write(CS.getInstruction());
109 void Write(const Metadata *MD) {
116 template <class T> void Write(const MDTupleTypedArrayWrapper<T> &MD) {
120 void Write(const NamedMDNode *NMD) {
127 void Write(Type *T) {
133 void Write(const Comdat *C) {
139 template <typename T1, typename... Ts>
140 void WriteTs(const T1 &V1, const Ts &... Vs) {
145 template <typename... Ts> void WriteTs() {}
148 /// \brief A check failed, so printout out the condition and the message.
150 /// This provides a nice place to put a breakpoint if you want to see why
151 /// something is not correct.
152 void CheckFailed(const Twine &Message) {
153 OS << Message << '\n';
157 /// \brief A check failed (with values to print).
159 /// This calls the Message-only version so that the above is easier to set a
161 template <typename T1, typename... Ts>
162 void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) {
163 CheckFailed(Message);
168 class Verifier : public InstVisitor<Verifier>, VerifierSupport {
169 friend class InstVisitor<Verifier>;
171 LLVMContext *Context;
174 /// \brief When verifying a basic block, keep track of all of the
175 /// instructions we have seen so far.
177 /// This allows us to do efficient dominance checks for the case when an
178 /// instruction has an operand that is an instruction in the same block.
179 SmallPtrSet<Instruction *, 16> InstsInThisBlock;
181 /// \brief Keep track of the metadata nodes that have been checked already.
182 SmallPtrSet<const Metadata *, 32> MDNodes;
184 /// \brief Track unresolved string-based type references.
185 SmallDenseMap<const MDString *, const MDNode *, 32> UnresolvedTypeRefs;
187 /// \brief The result type for a catchpad.
188 Type *CatchPadResultTy;
190 /// \brief The result type for a cleanuppad.
191 Type *CleanupPadResultTy;
193 /// \brief The result type for a landingpad.
194 Type *LandingPadResultTy;
196 /// \brief Whether we've seen a call to @llvm.localescape in this function
200 /// Stores the count of how many objects were passed to llvm.localescape for a
201 /// given function and the largest index passed to llvm.localrecover.
202 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
205 explicit Verifier(raw_ostream &OS)
206 : VerifierSupport(OS), Context(nullptr), CatchPadResultTy(nullptr),
207 CleanupPadResultTy(nullptr), LandingPadResultTy(nullptr),
208 SawFrameEscape(false) {}
210 bool verify(const Function &F) {
212 Context = &M->getContext();
214 // First ensure the function is well-enough formed to compute dominance
217 OS << "Function '" << F.getName()
218 << "' does not contain an entry block!\n";
221 for (Function::const_iterator I = F.begin(), E = F.end(); I != E; ++I) {
222 if (I->empty() || !I->back().isTerminator()) {
223 OS << "Basic Block in function '" << F.getName()
224 << "' does not have terminator!\n";
225 I->printAsOperand(OS, true);
231 // Now directly compute a dominance tree. We don't rely on the pass
232 // manager to provide this as it isolates us from a potentially
233 // out-of-date dominator tree and makes it significantly more complex to
234 // run this code outside of a pass manager.
235 // FIXME: It's really gross that we have to cast away constness here.
236 DT.recalculate(const_cast<Function &>(F));
239 // FIXME: We strip const here because the inst visitor strips const.
240 visit(const_cast<Function &>(F));
241 InstsInThisBlock.clear();
242 CatchPadResultTy = nullptr;
243 CleanupPadResultTy = nullptr;
244 LandingPadResultTy = nullptr;
245 SawFrameEscape = false;
250 bool verify(const Module &M) {
252 Context = &M.getContext();
255 // Scan through, checking all of the external function's linkage now...
256 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
257 visitGlobalValue(*I);
259 // Check to make sure function prototypes are okay.
260 if (I->isDeclaration())
264 // Now that we've visited every function, verify that we never asked to
265 // recover a frame index that wasn't escaped.
266 verifyFrameRecoverIndices();
268 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
270 visitGlobalVariable(*I);
272 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
274 visitGlobalAlias(*I);
276 for (Module::const_named_metadata_iterator I = M.named_metadata_begin(),
277 E = M.named_metadata_end();
279 visitNamedMDNode(*I);
281 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
282 visitComdat(SMEC.getValue());
285 visitModuleIdents(M);
287 // Verify type referneces last.
294 // Verification methods...
295 void visitGlobalValue(const GlobalValue &GV);
296 void visitGlobalVariable(const GlobalVariable &GV);
297 void visitGlobalAlias(const GlobalAlias &GA);
298 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
299 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
300 const GlobalAlias &A, const Constant &C);
301 void visitNamedMDNode(const NamedMDNode &NMD);
302 void visitMDNode(const MDNode &MD);
303 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
304 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
305 void visitComdat(const Comdat &C);
306 void visitModuleIdents(const Module &M);
307 void visitModuleFlags(const Module &M);
308 void visitModuleFlag(const MDNode *Op,
309 DenseMap<const MDString *, const MDNode *> &SeenIDs,
310 SmallVectorImpl<const MDNode *> &Requirements);
311 void visitFunction(const Function &F);
312 void visitBasicBlock(BasicBlock &BB);
313 void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty);
315 template <class Ty> bool isValidMetadataArray(const MDTuple &N);
316 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
317 #include "llvm/IR/Metadata.def"
318 void visitDIScope(const DIScope &N);
319 void visitDIVariable(const DIVariable &N);
320 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
321 void visitDITemplateParameter(const DITemplateParameter &N);
323 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
325 /// \brief Check for a valid string-based type reference.
327 /// Checks if \c MD is a string-based type reference. If it is, keeps track
328 /// of it (and its user, \c N) for error messages later.
329 bool isValidUUID(const MDNode &N, const Metadata *MD);
331 /// \brief Check for a valid type reference.
333 /// Checks for subclasses of \a DIType, or \a isValidUUID().
334 bool isTypeRef(const MDNode &N, const Metadata *MD);
336 /// \brief Check for a valid scope reference.
338 /// Checks for subclasses of \a DIScope, or \a isValidUUID().
339 bool isScopeRef(const MDNode &N, const Metadata *MD);
341 /// \brief Check for a valid debug info reference.
343 /// Checks for subclasses of \a DINode, or \a isValidUUID().
344 bool isDIRef(const MDNode &N, const Metadata *MD);
346 // InstVisitor overrides...
347 using InstVisitor<Verifier>::visit;
348 void visit(Instruction &I);
350 void visitTruncInst(TruncInst &I);
351 void visitZExtInst(ZExtInst &I);
352 void visitSExtInst(SExtInst &I);
353 void visitFPTruncInst(FPTruncInst &I);
354 void visitFPExtInst(FPExtInst &I);
355 void visitFPToUIInst(FPToUIInst &I);
356 void visitFPToSIInst(FPToSIInst &I);
357 void visitUIToFPInst(UIToFPInst &I);
358 void visitSIToFPInst(SIToFPInst &I);
359 void visitIntToPtrInst(IntToPtrInst &I);
360 void visitPtrToIntInst(PtrToIntInst &I);
361 void visitBitCastInst(BitCastInst &I);
362 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
363 void visitPHINode(PHINode &PN);
364 void visitBinaryOperator(BinaryOperator &B);
365 void visitICmpInst(ICmpInst &IC);
366 void visitFCmpInst(FCmpInst &FC);
367 void visitExtractElementInst(ExtractElementInst &EI);
368 void visitInsertElementInst(InsertElementInst &EI);
369 void visitShuffleVectorInst(ShuffleVectorInst &EI);
370 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
371 void visitCallInst(CallInst &CI);
372 void visitInvokeInst(InvokeInst &II);
373 void visitGetElementPtrInst(GetElementPtrInst &GEP);
374 void visitLoadInst(LoadInst &LI);
375 void visitStoreInst(StoreInst &SI);
376 void verifyDominatesUse(Instruction &I, unsigned i);
377 void visitInstruction(Instruction &I);
378 void visitTerminatorInst(TerminatorInst &I);
379 void visitBranchInst(BranchInst &BI);
380 void visitReturnInst(ReturnInst &RI);
381 void visitSwitchInst(SwitchInst &SI);
382 void visitIndirectBrInst(IndirectBrInst &BI);
383 void visitSelectInst(SelectInst &SI);
384 void visitUserOp1(Instruction &I);
385 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
386 void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS);
387 template <class DbgIntrinsicTy>
388 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
389 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
390 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
391 void visitFenceInst(FenceInst &FI);
392 void visitAllocaInst(AllocaInst &AI);
393 void visitExtractValueInst(ExtractValueInst &EVI);
394 void visitInsertValueInst(InsertValueInst &IVI);
395 void visitLandingPadInst(LandingPadInst &LPI);
396 void visitCatchPadInst(CatchPadInst &CPI);
397 void visitCatchEndPadInst(CatchEndPadInst &CEPI);
398 void visitCleanupPadInst(CleanupPadInst &CPI);
399 void visitCleanupReturnInst(CleanupReturnInst &CRI);
400 void visitTerminatePadInst(TerminatePadInst &TPI);
402 void VerifyCallSite(CallSite CS);
403 void verifyMustTailCall(CallInst &CI);
404 bool PerformTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
405 unsigned ArgNo, std::string &Suffix);
406 bool VerifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
407 SmallVectorImpl<Type *> &ArgTys);
408 bool VerifyIntrinsicIsVarArg(bool isVarArg,
409 ArrayRef<Intrinsic::IITDescriptor> &Infos);
410 bool VerifyAttributeCount(AttributeSet Attrs, unsigned Params);
411 void VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
413 void VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
414 bool isReturnValue, const Value *V);
415 void VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
417 void VerifyFunctionMetadata(
418 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs);
420 void VerifyConstantExprBitcastType(const ConstantExpr *CE);
421 void VerifyStatepoint(ImmutableCallSite CS);
422 void verifyFrameRecoverIndices();
424 // Module-level debug info verification...
425 void verifyTypeRefs();
426 template <class MapTy>
427 void verifyBitPieceExpression(const DbgInfoIntrinsic &I,
428 const MapTy &TypeRefs);
429 void visitUnresolvedTypeRef(const MDString *S, const MDNode *N);
431 } // End anonymous namespace
433 // Assert - We know that cond should be true, if not print an error message.
434 #define Assert(C, ...) \
435 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
437 void Verifier::visit(Instruction &I) {
438 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
439 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
440 InstVisitor<Verifier>::visit(I);
444 void Verifier::visitGlobalValue(const GlobalValue &GV) {
445 Assert(!GV.isDeclaration() || GV.hasExternalLinkage() ||
446 GV.hasExternalWeakLinkage(),
447 "Global is external, but doesn't have external or weak linkage!", &GV);
449 Assert(GV.getAlignment() <= Value::MaximumAlignment,
450 "huge alignment values are unsupported", &GV);
451 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
452 "Only global variables can have appending linkage!", &GV);
454 if (GV.hasAppendingLinkage()) {
455 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
456 Assert(GVar && GVar->getValueType()->isArrayTy(),
457 "Only global arrays can have appending linkage!", GVar);
460 if (GV.isDeclarationForLinker())
461 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
464 void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
465 if (GV.hasInitializer()) {
466 Assert(GV.getInitializer()->getType() == GV.getType()->getElementType(),
467 "Global variable initializer type does not match global "
471 // If the global has common linkage, it must have a zero initializer and
472 // cannot be constant.
473 if (GV.hasCommonLinkage()) {
474 Assert(GV.getInitializer()->isNullValue(),
475 "'common' global must have a zero initializer!", &GV);
476 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
478 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
481 Assert(GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
482 "invalid linkage type for global declaration", &GV);
485 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
486 GV.getName() == "llvm.global_dtors")) {
487 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
488 "invalid linkage for intrinsic global variable", &GV);
489 // Don't worry about emitting an error for it not being an array,
490 // visitGlobalValue will complain on appending non-array.
491 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
492 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
493 PointerType *FuncPtrTy =
494 FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
495 // FIXME: Reject the 2-field form in LLVM 4.0.
497 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
498 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
499 STy->getTypeAtIndex(1) == FuncPtrTy,
500 "wrong type for intrinsic global variable", &GV);
501 if (STy->getNumElements() == 3) {
502 Type *ETy = STy->getTypeAtIndex(2);
503 Assert(ETy->isPointerTy() &&
504 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
505 "wrong type for intrinsic global variable", &GV);
510 if (GV.hasName() && (GV.getName() == "llvm.used" ||
511 GV.getName() == "llvm.compiler.used")) {
512 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
513 "invalid linkage for intrinsic global variable", &GV);
514 Type *GVType = GV.getValueType();
515 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
516 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
517 Assert(PTy, "wrong type for intrinsic global variable", &GV);
518 if (GV.hasInitializer()) {
519 const Constant *Init = GV.getInitializer();
520 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
521 Assert(InitArray, "wrong initalizer for intrinsic global variable",
523 for (unsigned i = 0, e = InitArray->getNumOperands(); i != e; ++i) {
524 Value *V = Init->getOperand(i)->stripPointerCastsNoFollowAliases();
525 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
527 "invalid llvm.used member", V);
528 Assert(V->hasName(), "members of llvm.used must be named", V);
534 Assert(!GV.hasDLLImportStorageClass() ||
535 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
536 GV.hasAvailableExternallyLinkage(),
537 "Global is marked as dllimport, but not external", &GV);
539 if (!GV.hasInitializer()) {
540 visitGlobalValue(GV);
544 // Walk any aggregate initializers looking for bitcasts between address spaces
545 SmallPtrSet<const Value *, 4> Visited;
546 SmallVector<const Value *, 4> WorkStack;
547 WorkStack.push_back(cast<Value>(GV.getInitializer()));
549 while (!WorkStack.empty()) {
550 const Value *V = WorkStack.pop_back_val();
551 if (!Visited.insert(V).second)
554 if (const User *U = dyn_cast<User>(V)) {
555 WorkStack.append(U->op_begin(), U->op_end());
558 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
559 VerifyConstantExprBitcastType(CE);
565 visitGlobalValue(GV);
568 void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
569 SmallPtrSet<const GlobalAlias*, 4> Visited;
571 visitAliaseeSubExpr(Visited, GA, C);
574 void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
575 const GlobalAlias &GA, const Constant &C) {
576 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
577 Assert(!GV->isDeclaration(), "Alias must point to a definition", &GA);
579 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
580 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
582 Assert(!GA2->mayBeOverridden(), "Alias cannot point to a weak alias",
585 // Only continue verifying subexpressions of GlobalAliases.
586 // Do not recurse into global initializers.
591 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
592 VerifyConstantExprBitcastType(CE);
594 for (const Use &U : C.operands()) {
596 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
597 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
598 else if (const auto *C2 = dyn_cast<Constant>(V))
599 visitAliaseeSubExpr(Visited, GA, *C2);
603 void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
604 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
605 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
606 "weak_odr, or external linkage!",
608 const Constant *Aliasee = GA.getAliasee();
609 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
610 Assert(GA.getType() == Aliasee->getType(),
611 "Alias and aliasee types should match!", &GA);
613 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
614 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
616 visitAliaseeSubExpr(GA, *Aliasee);
618 visitGlobalValue(GA);
621 void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
622 for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i) {
623 MDNode *MD = NMD.getOperand(i);
625 if (NMD.getName() == "llvm.dbg.cu") {
626 Assert(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
636 void Verifier::visitMDNode(const MDNode &MD) {
637 // Only visit each node once. Metadata can be mutually recursive, so this
638 // avoids infinite recursion here, as well as being an optimization.
639 if (!MDNodes.insert(&MD).second)
642 switch (MD.getMetadataID()) {
644 llvm_unreachable("Invalid MDNode subclass");
645 case Metadata::MDTupleKind:
647 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
648 case Metadata::CLASS##Kind: \
649 visit##CLASS(cast<CLASS>(MD)); \
651 #include "llvm/IR/Metadata.def"
654 for (unsigned i = 0, e = MD.getNumOperands(); i != e; ++i) {
655 Metadata *Op = MD.getOperand(i);
658 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
660 if (auto *N = dyn_cast<MDNode>(Op)) {
664 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
665 visitValueAsMetadata(*V, nullptr);
670 // Check these last, so we diagnose problems in operands first.
671 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
672 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
675 void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
676 Assert(MD.getValue(), "Expected valid value", &MD);
677 Assert(!MD.getValue()->getType()->isMetadataTy(),
678 "Unexpected metadata round-trip through values", &MD, MD.getValue());
680 auto *L = dyn_cast<LocalAsMetadata>(&MD);
684 Assert(F, "function-local metadata used outside a function", L);
686 // If this was an instruction, bb, or argument, verify that it is in the
687 // function that we expect.
688 Function *ActualF = nullptr;
689 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
690 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
691 ActualF = I->getParent()->getParent();
692 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
693 ActualF = BB->getParent();
694 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
695 ActualF = A->getParent();
696 assert(ActualF && "Unimplemented function local metadata case!");
698 Assert(ActualF == F, "function-local metadata used in wrong function", L);
701 void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
702 Metadata *MD = MDV.getMetadata();
703 if (auto *N = dyn_cast<MDNode>(MD)) {
708 // Only visit each node once. Metadata can be mutually recursive, so this
709 // avoids infinite recursion here, as well as being an optimization.
710 if (!MDNodes.insert(MD).second)
713 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
714 visitValueAsMetadata(*V, F);
717 bool Verifier::isValidUUID(const MDNode &N, const Metadata *MD) {
718 auto *S = dyn_cast<MDString>(MD);
721 if (S->getString().empty())
724 // Keep track of names of types referenced via UUID so we can check that they
726 UnresolvedTypeRefs.insert(std::make_pair(S, &N));
730 /// \brief Check if a value can be a reference to a type.
731 bool Verifier::isTypeRef(const MDNode &N, const Metadata *MD) {
732 return !MD || isValidUUID(N, MD) || isa<DIType>(MD);
735 /// \brief Check if a value can be a ScopeRef.
736 bool Verifier::isScopeRef(const MDNode &N, const Metadata *MD) {
737 return !MD || isValidUUID(N, MD) || isa<DIScope>(MD);
740 /// \brief Check if a value can be a debug info ref.
741 bool Verifier::isDIRef(const MDNode &N, const Metadata *MD) {
742 return !MD || isValidUUID(N, MD) || isa<DINode>(MD);
746 bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
747 for (Metadata *MD : N.operands()) {
760 bool isValidMetadataArray(const MDTuple &N) {
761 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
765 bool isValidMetadataNullArray(const MDTuple &N) {
766 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
769 void Verifier::visitDILocation(const DILocation &N) {
770 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
771 "location requires a valid scope", &N, N.getRawScope());
772 if (auto *IA = N.getRawInlinedAt())
773 Assert(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
776 void Verifier::visitGenericDINode(const GenericDINode &N) {
777 Assert(N.getTag(), "invalid tag", &N);
780 void Verifier::visitDIScope(const DIScope &N) {
781 if (auto *F = N.getRawFile())
782 Assert(isa<DIFile>(F), "invalid file", &N, F);
785 void Verifier::visitDISubrange(const DISubrange &N) {
786 Assert(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
787 Assert(N.getCount() >= -1, "invalid subrange count", &N);
790 void Verifier::visitDIEnumerator(const DIEnumerator &N) {
791 Assert(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
794 void Verifier::visitDIBasicType(const DIBasicType &N) {
795 Assert(N.getTag() == dwarf::DW_TAG_base_type ||
796 N.getTag() == dwarf::DW_TAG_unspecified_type,
800 void Verifier::visitDIDerivedType(const DIDerivedType &N) {
801 // Common scope checks.
804 Assert(N.getTag() == dwarf::DW_TAG_typedef ||
805 N.getTag() == dwarf::DW_TAG_pointer_type ||
806 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
807 N.getTag() == dwarf::DW_TAG_reference_type ||
808 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
809 N.getTag() == dwarf::DW_TAG_const_type ||
810 N.getTag() == dwarf::DW_TAG_volatile_type ||
811 N.getTag() == dwarf::DW_TAG_restrict_type ||
812 N.getTag() == dwarf::DW_TAG_member ||
813 N.getTag() == dwarf::DW_TAG_inheritance ||
814 N.getTag() == dwarf::DW_TAG_friend,
816 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
817 Assert(isTypeRef(N, N.getExtraData()), "invalid pointer to member type", &N,
821 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
822 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
826 static bool hasConflictingReferenceFlags(unsigned Flags) {
827 return (Flags & DINode::FlagLValueReference) &&
828 (Flags & DINode::FlagRValueReference);
831 void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
832 auto *Params = dyn_cast<MDTuple>(&RawParams);
833 Assert(Params, "invalid template params", &N, &RawParams);
834 for (Metadata *Op : Params->operands()) {
835 Assert(Op && isa<DITemplateParameter>(Op), "invalid template parameter", &N,
840 void Verifier::visitDICompositeType(const DICompositeType &N) {
841 // Common scope checks.
844 Assert(N.getTag() == dwarf::DW_TAG_array_type ||
845 N.getTag() == dwarf::DW_TAG_structure_type ||
846 N.getTag() == dwarf::DW_TAG_union_type ||
847 N.getTag() == dwarf::DW_TAG_enumeration_type ||
848 N.getTag() == dwarf::DW_TAG_class_type,
851 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
852 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
855 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
856 "invalid composite elements", &N, N.getRawElements());
857 Assert(isTypeRef(N, N.getRawVTableHolder()), "invalid vtable holder", &N,
858 N.getRawVTableHolder());
859 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
860 "invalid composite elements", &N, N.getRawElements());
861 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
863 if (auto *Params = N.getRawTemplateParams())
864 visitTemplateParams(N, *Params);
866 if (N.getTag() == dwarf::DW_TAG_class_type ||
867 N.getTag() == dwarf::DW_TAG_union_type) {
868 Assert(N.getFile() && !N.getFile()->getFilename().empty(),
869 "class/union requires a filename", &N, N.getFile());
873 void Verifier::visitDISubroutineType(const DISubroutineType &N) {
874 Assert(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
875 if (auto *Types = N.getRawTypeArray()) {
876 Assert(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
877 for (Metadata *Ty : N.getTypeArray()->operands()) {
878 Assert(isTypeRef(N, Ty), "invalid subroutine type ref", &N, Types, Ty);
881 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
885 void Verifier::visitDIFile(const DIFile &N) {
886 Assert(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
889 void Verifier::visitDICompileUnit(const DICompileUnit &N) {
890 Assert(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
892 // Don't bother verifying the compilation directory or producer string
893 // as those could be empty.
894 Assert(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
896 Assert(!N.getFile()->getFilename().empty(), "invalid filename", &N,
899 if (auto *Array = N.getRawEnumTypes()) {
900 Assert(isa<MDTuple>(Array), "invalid enum list", &N, Array);
901 for (Metadata *Op : N.getEnumTypes()->operands()) {
902 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
903 Assert(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
904 "invalid enum type", &N, N.getEnumTypes(), Op);
907 if (auto *Array = N.getRawRetainedTypes()) {
908 Assert(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
909 for (Metadata *Op : N.getRetainedTypes()->operands()) {
910 Assert(Op && isa<DIType>(Op), "invalid retained type", &N, Op);
913 if (auto *Array = N.getRawSubprograms()) {
914 Assert(isa<MDTuple>(Array), "invalid subprogram list", &N, Array);
915 for (Metadata *Op : N.getSubprograms()->operands()) {
916 Assert(Op && isa<DISubprogram>(Op), "invalid subprogram ref", &N, Op);
919 if (auto *Array = N.getRawGlobalVariables()) {
920 Assert(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
921 for (Metadata *Op : N.getGlobalVariables()->operands()) {
922 Assert(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref", &N,
926 if (auto *Array = N.getRawImportedEntities()) {
927 Assert(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
928 for (Metadata *Op : N.getImportedEntities()->operands()) {
929 Assert(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref", &N,
935 void Verifier::visitDISubprogram(const DISubprogram &N) {
936 Assert(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
937 Assert(isScopeRef(N, N.getRawScope()), "invalid scope", &N, N.getRawScope());
938 if (auto *T = N.getRawType())
939 Assert(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
940 Assert(isTypeRef(N, N.getRawContainingType()), "invalid containing type", &N,
941 N.getRawContainingType());
942 if (auto *RawF = N.getRawFunction()) {
943 auto *FMD = dyn_cast<ConstantAsMetadata>(RawF);
944 auto *F = FMD ? FMD->getValue() : nullptr;
945 auto *FT = F ? dyn_cast<PointerType>(F->getType()) : nullptr;
946 Assert(F && FT && isa<FunctionType>(FT->getElementType()),
947 "invalid function", &N, F, FT);
949 if (auto *Params = N.getRawTemplateParams())
950 visitTemplateParams(N, *Params);
951 if (auto *S = N.getRawDeclaration()) {
952 Assert(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
953 "invalid subprogram declaration", &N, S);
955 if (auto *RawVars = N.getRawVariables()) {
956 auto *Vars = dyn_cast<MDTuple>(RawVars);
957 Assert(Vars, "invalid variable list", &N, RawVars);
958 for (Metadata *Op : Vars->operands()) {
959 Assert(Op && isa<DILocalVariable>(Op), "invalid local variable", &N, Vars,
963 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
966 auto *F = N.getFunction();
970 // Check that all !dbg attachments lead to back to N (or, at least, another
971 // subprogram that describes the same function).
973 // FIXME: Check this incrementally while visiting !dbg attachments.
974 // FIXME: Only check when N is the canonical subprogram for F.
975 SmallPtrSet<const MDNode *, 32> Seen;
978 // Be careful about using DILocation here since we might be dealing with
979 // broken code (this is the Verifier after all).
981 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
984 if (!Seen.insert(DL).second)
987 DILocalScope *Scope = DL->getInlinedAtScope();
988 if (Scope && !Seen.insert(Scope).second)
991 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
992 if (SP && !Seen.insert(SP).second)
995 // FIXME: Once N is canonical, check "SP == &N".
996 Assert(SP->describes(F),
997 "!dbg attachment points at wrong subprogram for function", &N, F,
1002 void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
1003 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
1004 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1005 "invalid local scope", &N, N.getRawScope());
1008 void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1009 visitDILexicalBlockBase(N);
1011 Assert(N.getLine() || !N.getColumn(),
1012 "cannot have column info without line info", &N);
1015 void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1016 visitDILexicalBlockBase(N);
1019 void Verifier::visitDINamespace(const DINamespace &N) {
1020 Assert(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
1021 if (auto *S = N.getRawScope())
1022 Assert(isa<DIScope>(S), "invalid scope ref", &N, S);
1025 void Verifier::visitDIModule(const DIModule &N) {
1026 Assert(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1027 Assert(!N.getName().empty(), "anonymous module", &N);
1030 void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
1031 Assert(isTypeRef(N, N.getType()), "invalid type ref", &N, N.getType());
1034 void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1035 visitDITemplateParameter(N);
1037 Assert(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1041 void Verifier::visitDITemplateValueParameter(
1042 const DITemplateValueParameter &N) {
1043 visitDITemplateParameter(N);
1045 Assert(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1046 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1047 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1051 void Verifier::visitDIVariable(const DIVariable &N) {
1052 if (auto *S = N.getRawScope())
1053 Assert(isa<DIScope>(S), "invalid scope", &N, S);
1054 Assert(isTypeRef(N, N.getRawType()), "invalid type ref", &N, N.getRawType());
1055 if (auto *F = N.getRawFile())
1056 Assert(isa<DIFile>(F), "invalid file", &N, F);
1059 void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
1060 // Checks common to all variables.
1063 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1064 Assert(!N.getName().empty(), "missing global variable name", &N);
1065 if (auto *V = N.getRawVariable()) {
1066 Assert(isa<ConstantAsMetadata>(V) &&
1067 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
1068 "invalid global varaible ref", &N, V);
1070 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
1071 Assert(isa<DIDerivedType>(Member), "invalid static data member declaration",
1076 void Verifier::visitDILocalVariable(const DILocalVariable &N) {
1077 // Checks common to all variables.
1080 Assert(N.getTag() == dwarf::DW_TAG_auto_variable ||
1081 N.getTag() == dwarf::DW_TAG_arg_variable,
1083 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1084 "local variable requires a valid scope", &N, N.getRawScope());
1085 Assert(bool(N.getArg()) == (N.getTag() == dwarf::DW_TAG_arg_variable),
1086 "local variable should have arg iff it's a DW_TAG_arg_variable", &N);
1089 void Verifier::visitDIExpression(const DIExpression &N) {
1090 Assert(N.isValid(), "invalid expression", &N);
1093 void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
1094 Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
1095 if (auto *T = N.getRawType())
1096 Assert(isTypeRef(N, T), "invalid type ref", &N, T);
1097 if (auto *F = N.getRawFile())
1098 Assert(isa<DIFile>(F), "invalid file", &N, F);
1101 void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
1102 Assert(N.getTag() == dwarf::DW_TAG_imported_module ||
1103 N.getTag() == dwarf::DW_TAG_imported_declaration,
1105 if (auto *S = N.getRawScope())
1106 Assert(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1107 Assert(isDIRef(N, N.getEntity()), "invalid imported entity", &N,
1111 void Verifier::visitComdat(const Comdat &C) {
1112 // The Module is invalid if the GlobalValue has private linkage. Entities
1113 // with private linkage don't have entries in the symbol table.
1114 if (const GlobalValue *GV = M->getNamedValue(C.getName()))
1115 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1119 void Verifier::visitModuleIdents(const Module &M) {
1120 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1124 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1125 // Scan each llvm.ident entry and make sure that this requirement is met.
1126 for (unsigned i = 0, e = Idents->getNumOperands(); i != e; ++i) {
1127 const MDNode *N = Idents->getOperand(i);
1128 Assert(N->getNumOperands() == 1,
1129 "incorrect number of operands in llvm.ident metadata", N);
1130 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1131 ("invalid value for llvm.ident metadata entry operand"
1132 "(the operand should be a string)"),
1137 void Verifier::visitModuleFlags(const Module &M) {
1138 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1141 // Scan each flag, and track the flags and requirements.
1142 DenseMap<const MDString*, const MDNode*> SeenIDs;
1143 SmallVector<const MDNode*, 16> Requirements;
1144 for (unsigned I = 0, E = Flags->getNumOperands(); I != E; ++I) {
1145 visitModuleFlag(Flags->getOperand(I), SeenIDs, Requirements);
1148 // Validate that the requirements in the module are valid.
1149 for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
1150 const MDNode *Requirement = Requirements[I];
1151 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
1152 const Metadata *ReqValue = Requirement->getOperand(1);
1154 const MDNode *Op = SeenIDs.lookup(Flag);
1156 CheckFailed("invalid requirement on flag, flag is not present in module",
1161 if (Op->getOperand(2) != ReqValue) {
1162 CheckFailed(("invalid requirement on flag, "
1163 "flag does not have the required value"),
1171 Verifier::visitModuleFlag(const MDNode *Op,
1172 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1173 SmallVectorImpl<const MDNode *> &Requirements) {
1174 // Each module flag should have three arguments, the merge behavior (a
1175 // constant int), the flag ID (an MDString), and the value.
1176 Assert(Op->getNumOperands() == 3,
1177 "incorrect number of operands in module flag", Op);
1178 Module::ModFlagBehavior MFB;
1179 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
1181 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
1182 "invalid behavior operand in module flag (expected constant integer)",
1185 "invalid behavior operand in module flag (unexpected constant)",
1188 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
1189 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1192 // Sanity check the values for behaviors with additional requirements.
1195 case Module::Warning:
1196 case Module::Override:
1197 // These behavior types accept any value.
1200 case Module::Require: {
1201 // The value should itself be an MDNode with two operands, a flag ID (an
1202 // MDString), and a value.
1203 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
1204 Assert(Value && Value->getNumOperands() == 2,
1205 "invalid value for 'require' module flag (expected metadata pair)",
1207 Assert(isa<MDString>(Value->getOperand(0)),
1208 ("invalid value for 'require' module flag "
1209 "(first value operand should be a string)"),
1210 Value->getOperand(0));
1212 // Append it to the list of requirements, to check once all module flags are
1214 Requirements.push_back(Value);
1218 case Module::Append:
1219 case Module::AppendUnique: {
1220 // These behavior types require the operand be an MDNode.
1221 Assert(isa<MDNode>(Op->getOperand(2)),
1222 "invalid value for 'append'-type module flag "
1223 "(expected a metadata node)",
1229 // Unless this is a "requires" flag, check the ID is unique.
1230 if (MFB != Module::Require) {
1231 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
1233 "module flag identifiers must be unique (or of 'require' type)", ID);
1237 void Verifier::VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
1238 bool isFunction, const Value *V) {
1239 unsigned Slot = ~0U;
1240 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1241 if (Attrs.getSlotIndex(I) == Idx) {
1246 assert(Slot != ~0U && "Attribute set inconsistency!");
1248 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1250 if (I->isStringAttribute())
1253 if (I->getKindAsEnum() == Attribute::NoReturn ||
1254 I->getKindAsEnum() == Attribute::NoUnwind ||
1255 I->getKindAsEnum() == Attribute::NoInline ||
1256 I->getKindAsEnum() == Attribute::AlwaysInline ||
1257 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1258 I->getKindAsEnum() == Attribute::StackProtect ||
1259 I->getKindAsEnum() == Attribute::StackProtectReq ||
1260 I->getKindAsEnum() == Attribute::StackProtectStrong ||
1261 I->getKindAsEnum() == Attribute::SafeStack ||
1262 I->getKindAsEnum() == Attribute::NoRedZone ||
1263 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1264 I->getKindAsEnum() == Attribute::Naked ||
1265 I->getKindAsEnum() == Attribute::InlineHint ||
1266 I->getKindAsEnum() == Attribute::StackAlignment ||
1267 I->getKindAsEnum() == Attribute::UWTable ||
1268 I->getKindAsEnum() == Attribute::NonLazyBind ||
1269 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1270 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1271 I->getKindAsEnum() == Attribute::SanitizeThread ||
1272 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1273 I->getKindAsEnum() == Attribute::MinSize ||
1274 I->getKindAsEnum() == Attribute::NoDuplicate ||
1275 I->getKindAsEnum() == Attribute::Builtin ||
1276 I->getKindAsEnum() == Attribute::NoBuiltin ||
1277 I->getKindAsEnum() == Attribute::Cold ||
1278 I->getKindAsEnum() == Attribute::OptimizeNone ||
1279 I->getKindAsEnum() == Attribute::JumpTable ||
1280 I->getKindAsEnum() == Attribute::Convergent ||
1281 I->getKindAsEnum() == Attribute::ArgMemOnly) {
1283 CheckFailed("Attribute '" + I->getAsString() +
1284 "' only applies to functions!", V);
1287 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
1288 I->getKindAsEnum() == Attribute::ReadNone) {
1290 CheckFailed("Attribute '" + I->getAsString() +
1291 "' does not apply to function returns");
1294 } else if (isFunction) {
1295 CheckFailed("Attribute '" + I->getAsString() +
1296 "' does not apply to functions!", V);
1302 // VerifyParameterAttrs - Check the given attributes for an argument or return
1303 // value of the specified type. The value V is printed in error messages.
1304 void Verifier::VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
1305 bool isReturnValue, const Value *V) {
1306 if (!Attrs.hasAttributes(Idx))
1309 VerifyAttributeTypes(Attrs, Idx, false, V);
1312 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1313 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1314 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1315 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1316 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
1317 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1318 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', and "
1319 "'returned' do not apply to return values!",
1322 // Check for mutually incompatible attributes. Only inreg is compatible with
1324 unsigned AttrCount = 0;
1325 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1326 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1327 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1328 Attrs.hasAttribute(Idx, Attribute::InReg);
1329 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
1330 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1331 "and 'sret' are incompatible!",
1334 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1335 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1337 "'inalloca and readonly' are incompatible!",
1340 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1341 Attrs.hasAttribute(Idx, Attribute::Returned)),
1343 "'sret and returned' are incompatible!",
1346 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1347 Attrs.hasAttribute(Idx, Attribute::SExt)),
1349 "'zeroext and signext' are incompatible!",
1352 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1353 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1355 "'readnone and readonly' are incompatible!",
1358 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1359 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1361 "'noinline and alwaysinline' are incompatible!",
1364 Assert(!AttrBuilder(Attrs, Idx)
1365 .overlaps(AttributeFuncs::typeIncompatible(Ty)),
1366 "Wrong types for attribute: " +
1367 AttributeSet::get(*Context, Idx,
1368 AttributeFuncs::typeIncompatible(Ty)).getAsString(Idx),
1371 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
1372 SmallPtrSet<const Type*, 4> Visited;
1373 if (!PTy->getElementType()->isSized(&Visited)) {
1374 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1375 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1376 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1380 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1381 "Attribute 'byval' only applies to parameters with pointer type!",
1386 // VerifyFunctionAttrs - Check parameter attributes against a function type.
1387 // The value V is printed in error messages.
1388 void Verifier::VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
1390 if (Attrs.isEmpty())
1393 bool SawNest = false;
1394 bool SawReturned = false;
1395 bool SawSRet = false;
1397 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
1398 unsigned Idx = Attrs.getSlotIndex(i);
1402 Ty = FT->getReturnType();
1403 else if (Idx-1 < FT->getNumParams())
1404 Ty = FT->getParamType(Idx-1);
1406 break; // VarArgs attributes, verified elsewhere.
1408 VerifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
1413 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
1414 Assert(!SawNest, "More than one parameter has attribute nest!", V);
1418 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
1419 Assert(!SawReturned, "More than one parameter has attribute returned!",
1421 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1423 "argument and return types for 'returned' attribute",
1428 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
1429 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1430 Assert(Idx == 1 || Idx == 2,
1431 "Attribute 'sret' is not on first or second parameter!", V);
1435 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
1436 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1441 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1444 VerifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
1447 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1448 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1449 "Attributes 'readnone and readonly' are incompatible!", V);
1452 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1453 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1454 Attribute::AlwaysInline)),
1455 "Attributes 'noinline and alwaysinline' are incompatible!", V);
1457 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1458 Attribute::OptimizeNone)) {
1459 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1460 "Attribute 'optnone' requires 'noinline'!", V);
1462 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1463 Attribute::OptimizeForSize),
1464 "Attributes 'optsize and optnone' are incompatible!", V);
1466 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1467 "Attributes 'minsize and optnone' are incompatible!", V);
1470 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1471 Attribute::JumpTable)) {
1472 const GlobalValue *GV = cast<GlobalValue>(V);
1473 Assert(GV->hasUnnamedAddr(),
1474 "Attribute 'jumptable' requires 'unnamed_addr'", V);
1478 void Verifier::VerifyFunctionMetadata(
1479 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs) {
1483 for (unsigned i = 0; i < MDs.size(); i++) {
1484 if (MDs[i].first == LLVMContext::MD_prof) {
1485 MDNode *MD = MDs[i].second;
1486 Assert(MD->getNumOperands() == 2,
1487 "!prof annotations should have exactly 2 operands", MD);
1489 // Check first operand.
1490 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1492 Assert(isa<MDString>(MD->getOperand(0)),
1493 "expected string with name of the !prof annotation", MD);
1494 MDString *MDS = cast<MDString>(MD->getOperand(0));
1495 StringRef ProfName = MDS->getString();
1496 Assert(ProfName.equals("function_entry_count"),
1497 "first operand should be 'function_entry_count'", MD);
1499 // Check second operand.
1500 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1502 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1503 "expected integer argument to function_entry_count", MD);
1508 void Verifier::VerifyConstantExprBitcastType(const ConstantExpr *CE) {
1509 if (CE->getOpcode() != Instruction::BitCast)
1512 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1514 "Invalid bitcast", CE);
1517 bool Verifier::VerifyAttributeCount(AttributeSet Attrs, unsigned Params) {
1518 if (Attrs.getNumSlots() == 0)
1521 unsigned LastSlot = Attrs.getNumSlots() - 1;
1522 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
1523 if (LastIndex <= Params
1524 || (LastIndex == AttributeSet::FunctionIndex
1525 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
1531 /// \brief Verify that statepoint intrinsic is well formed.
1532 void Verifier::VerifyStatepoint(ImmutableCallSite CS) {
1533 assert(CS.getCalledFunction() &&
1534 CS.getCalledFunction()->getIntrinsicID() ==
1535 Intrinsic::experimental_gc_statepoint);
1537 const Instruction &CI = *CS.getInstruction();
1539 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1540 !CS.onlyAccessesArgMemory(),
1541 "gc.statepoint must read and write all memory to preserve "
1542 "reordering restrictions required by safepoint semantics",
1545 const Value *IDV = CS.getArgument(0);
1546 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1549 const Value *NumPatchBytesV = CS.getArgument(1);
1550 Assert(isa<ConstantInt>(NumPatchBytesV),
1551 "gc.statepoint number of patchable bytes must be a constant integer",
1553 const int64_t NumPatchBytes =
1554 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1555 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1556 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1560 const Value *Target = CS.getArgument(2);
1561 const PointerType *PT = dyn_cast<PointerType>(Target->getType());
1562 Assert(PT && PT->getElementType()->isFunctionTy(),
1563 "gc.statepoint callee must be of function pointer type", &CI, Target);
1564 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
1566 const Value *NumCallArgsV = CS.getArgument(3);
1567 Assert(isa<ConstantInt>(NumCallArgsV),
1568 "gc.statepoint number of arguments to underlying call "
1569 "must be constant integer",
1571 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
1572 Assert(NumCallArgs >= 0,
1573 "gc.statepoint number of arguments to underlying call "
1576 const int NumParams = (int)TargetFuncType->getNumParams();
1577 if (TargetFuncType->isVarArg()) {
1578 Assert(NumCallArgs >= NumParams,
1579 "gc.statepoint mismatch in number of vararg call args", &CI);
1581 // TODO: Remove this limitation
1582 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1583 "gc.statepoint doesn't support wrapping non-void "
1584 "vararg functions yet",
1587 Assert(NumCallArgs == NumParams,
1588 "gc.statepoint mismatch in number of call args", &CI);
1590 const Value *FlagsV = CS.getArgument(4);
1591 Assert(isa<ConstantInt>(FlagsV),
1592 "gc.statepoint flags must be constant integer", &CI);
1593 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1594 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1595 "unknown flag used in gc.statepoint flags argument", &CI);
1597 // Verify that the types of the call parameter arguments match
1598 // the type of the wrapped callee.
1599 for (int i = 0; i < NumParams; i++) {
1600 Type *ParamType = TargetFuncType->getParamType(i);
1601 Type *ArgType = CS.getArgument(5 + i)->getType();
1602 Assert(ArgType == ParamType,
1603 "gc.statepoint call argument does not match wrapped "
1608 const int EndCallArgsInx = 4 + NumCallArgs;
1610 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1611 Assert(isa<ConstantInt>(NumTransitionArgsV),
1612 "gc.statepoint number of transition arguments "
1613 "must be constant integer",
1615 const int NumTransitionArgs =
1616 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1617 Assert(NumTransitionArgs >= 0,
1618 "gc.statepoint number of transition arguments must be positive", &CI);
1619 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1621 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
1622 Assert(isa<ConstantInt>(NumDeoptArgsV),
1623 "gc.statepoint number of deoptimization arguments "
1624 "must be constant integer",
1626 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
1627 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1631 const int ExpectedNumArgs =
1632 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
1633 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
1634 "gc.statepoint too few arguments according to length fields", &CI);
1636 // Check that the only uses of this gc.statepoint are gc.result or
1637 // gc.relocate calls which are tied to this statepoint and thus part
1638 // of the same statepoint sequence
1639 for (const User *U : CI.users()) {
1640 const CallInst *Call = dyn_cast<const CallInst>(U);
1641 Assert(Call, "illegal use of statepoint token", &CI, U);
1642 if (!Call) continue;
1643 Assert(isGCRelocate(Call) || isGCResult(Call),
1644 "gc.result or gc.relocate are the only value uses"
1645 "of a gc.statepoint",
1647 if (isGCResult(Call)) {
1648 Assert(Call->getArgOperand(0) == &CI,
1649 "gc.result connected to wrong gc.statepoint", &CI, Call);
1650 } else if (isGCRelocate(Call)) {
1651 Assert(Call->getArgOperand(0) == &CI,
1652 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
1656 // Note: It is legal for a single derived pointer to be listed multiple
1657 // times. It's non-optimal, but it is legal. It can also happen after
1658 // insertion if we strip a bitcast away.
1659 // Note: It is really tempting to check that each base is relocated and
1660 // that a derived pointer is never reused as a base pointer. This turns
1661 // out to be problematic since optimizations run after safepoint insertion
1662 // can recognize equality properties that the insertion logic doesn't know
1663 // about. See example statepoint.ll in the verifier subdirectory
1666 void Verifier::verifyFrameRecoverIndices() {
1667 for (auto &Counts : FrameEscapeInfo) {
1668 Function *F = Counts.first;
1669 unsigned EscapedObjectCount = Counts.second.first;
1670 unsigned MaxRecoveredIndex = Counts.second.second;
1671 Assert(MaxRecoveredIndex <= EscapedObjectCount,
1672 "all indices passed to llvm.localrecover must be less than the "
1673 "number of arguments passed ot llvm.localescape in the parent "
1679 // visitFunction - Verify that a function is ok.
1681 void Verifier::visitFunction(const Function &F) {
1682 // Check function arguments.
1683 FunctionType *FT = F.getFunctionType();
1684 unsigned NumArgs = F.arg_size();
1686 Assert(Context == &F.getContext(),
1687 "Function context does not match Module context!", &F);
1689 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1690 Assert(FT->getNumParams() == NumArgs,
1691 "# formal arguments must match # of arguments for function type!", &F,
1693 Assert(F.getReturnType()->isFirstClassType() ||
1694 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1695 "Functions cannot return aggregate values!", &F);
1697 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1698 "Invalid struct return type!", &F);
1700 AttributeSet Attrs = F.getAttributes();
1702 Assert(VerifyAttributeCount(Attrs, FT->getNumParams()),
1703 "Attribute after last parameter!", &F);
1705 // Check function attributes.
1706 VerifyFunctionAttrs(FT, Attrs, &F);
1708 // On function declarations/definitions, we do not support the builtin
1709 // attribute. We do not check this in VerifyFunctionAttrs since that is
1710 // checking for Attributes that can/can not ever be on functions.
1711 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1712 "Attribute 'builtin' can only be applied to a callsite.", &F);
1714 // Check that this function meets the restrictions on this calling convention.
1715 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1716 // restrictions can be lifted.
1717 switch (F.getCallingConv()) {
1719 case CallingConv::C:
1721 case CallingConv::Fast:
1722 case CallingConv::Cold:
1723 case CallingConv::Intel_OCL_BI:
1724 case CallingConv::PTX_Kernel:
1725 case CallingConv::PTX_Device:
1726 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1727 "perfect forwarding!",
1732 bool isLLVMdotName = F.getName().size() >= 5 &&
1733 F.getName().substr(0, 5) == "llvm.";
1735 // Check that the argument values match the function type for this function...
1737 for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E;
1739 Assert(I->getType() == FT->getParamType(i),
1740 "Argument value does not match function argument type!", I,
1741 FT->getParamType(i));
1742 Assert(I->getType()->isFirstClassType(),
1743 "Function arguments must have first-class types!", I);
1745 Assert(!I->getType()->isMetadataTy(),
1746 "Function takes metadata but isn't an intrinsic", I, &F);
1749 // Get the function metadata attachments.
1750 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1751 F.getAllMetadata(MDs);
1752 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
1753 VerifyFunctionMetadata(MDs);
1755 if (F.isMaterializable()) {
1756 // Function has a body somewhere we can't see.
1757 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
1758 MDs.empty() ? nullptr : MDs.front().second);
1759 } else if (F.isDeclaration()) {
1760 Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1761 "invalid linkage type for function declaration", &F);
1762 Assert(MDs.empty(), "function without a body cannot have metadata", &F,
1763 MDs.empty() ? nullptr : MDs.front().second);
1764 Assert(!F.hasPersonalityFn(),
1765 "Function declaration shouldn't have a personality routine", &F);
1767 // Verify that this function (which has a body) is not named "llvm.*". It
1768 // is not legal to define intrinsics.
1769 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
1771 // Check the entry node
1772 const BasicBlock *Entry = &F.getEntryBlock();
1773 Assert(pred_empty(Entry),
1774 "Entry block to function must not have predecessors!", Entry);
1776 // The address of the entry block cannot be taken, unless it is dead.
1777 if (Entry->hasAddressTaken()) {
1778 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1779 "blockaddress may not be used with the entry block!", Entry);
1782 // Visit metadata attachments.
1783 for (const auto &I : MDs)
1784 visitMDNode(*I.second);
1787 // If this function is actually an intrinsic, verify that it is only used in
1788 // direct call/invokes, never having its "address taken".
1789 if (F.getIntrinsicID()) {
1791 if (F.hasAddressTaken(&U))
1792 Assert(0, "Invalid user of intrinsic instruction!", U);
1795 Assert(!F.hasDLLImportStorageClass() ||
1796 (F.isDeclaration() && F.hasExternalLinkage()) ||
1797 F.hasAvailableExternallyLinkage(),
1798 "Function is marked as dllimport, but not external.", &F);
1801 // verifyBasicBlock - Verify that a basic block is well formed...
1803 void Verifier::visitBasicBlock(BasicBlock &BB) {
1804 InstsInThisBlock.clear();
1806 // Ensure that basic blocks have terminators!
1807 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
1809 // Check constraints that this basic block imposes on all of the PHI nodes in
1811 if (isa<PHINode>(BB.front())) {
1812 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
1813 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
1814 std::sort(Preds.begin(), Preds.end());
1816 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
1817 // Ensure that PHI nodes have at least one entry!
1818 Assert(PN->getNumIncomingValues() != 0,
1819 "PHI nodes must have at least one entry. If the block is dead, "
1820 "the PHI should be removed!",
1822 Assert(PN->getNumIncomingValues() == Preds.size(),
1823 "PHINode should have one entry for each predecessor of its "
1824 "parent basic block!",
1827 // Get and sort all incoming values in the PHI node...
1829 Values.reserve(PN->getNumIncomingValues());
1830 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1831 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
1832 PN->getIncomingValue(i)));
1833 std::sort(Values.begin(), Values.end());
1835 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
1836 // Check to make sure that if there is more than one entry for a
1837 // particular basic block in this PHI node, that the incoming values are
1840 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
1841 Values[i].second == Values[i - 1].second,
1842 "PHI node has multiple entries for the same basic block with "
1843 "different incoming values!",
1844 PN, Values[i].first, Values[i].second, Values[i - 1].second);
1846 // Check to make sure that the predecessors and PHI node entries are
1848 Assert(Values[i].first == Preds[i],
1849 "PHI node entries do not match predecessors!", PN,
1850 Values[i].first, Preds[i]);
1855 // Check that all instructions have their parent pointers set up correctly.
1858 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
1862 void Verifier::visitTerminatorInst(TerminatorInst &I) {
1863 // Ensure that terminators only exist at the end of the basic block.
1864 Assert(&I == I.getParent()->getTerminator(),
1865 "Terminator found in the middle of a basic block!", I.getParent());
1866 visitInstruction(I);
1869 void Verifier::visitBranchInst(BranchInst &BI) {
1870 if (BI.isConditional()) {
1871 Assert(BI.getCondition()->getType()->isIntegerTy(1),
1872 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
1874 visitTerminatorInst(BI);
1877 void Verifier::visitReturnInst(ReturnInst &RI) {
1878 Function *F = RI.getParent()->getParent();
1879 unsigned N = RI.getNumOperands();
1880 if (F->getReturnType()->isVoidTy())
1882 "Found return instr that returns non-void in Function of void "
1884 &RI, F->getReturnType());
1886 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
1887 "Function return type does not match operand "
1888 "type of return inst!",
1889 &RI, F->getReturnType());
1891 // Check to make sure that the return value has necessary properties for
1893 visitTerminatorInst(RI);
1896 void Verifier::visitSwitchInst(SwitchInst &SI) {
1897 // Check to make sure that all of the constants in the switch instruction
1898 // have the same type as the switched-on value.
1899 Type *SwitchTy = SI.getCondition()->getType();
1900 SmallPtrSet<ConstantInt*, 32> Constants;
1901 for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end(); i != e; ++i) {
1902 Assert(i.getCaseValue()->getType() == SwitchTy,
1903 "Switch constants must all be same type as switch value!", &SI);
1904 Assert(Constants.insert(i.getCaseValue()).second,
1905 "Duplicate integer as switch case", &SI, i.getCaseValue());
1908 visitTerminatorInst(SI);
1911 void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
1912 Assert(BI.getAddress()->getType()->isPointerTy(),
1913 "Indirectbr operand must have pointer type!", &BI);
1914 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
1915 Assert(BI.getDestination(i)->getType()->isLabelTy(),
1916 "Indirectbr destinations must all have pointer type!", &BI);
1918 visitTerminatorInst(BI);
1921 void Verifier::visitSelectInst(SelectInst &SI) {
1922 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
1924 "Invalid operands for select instruction!", &SI);
1926 Assert(SI.getTrueValue()->getType() == SI.getType(),
1927 "Select values must have same type as select instruction!", &SI);
1928 visitInstruction(SI);
1931 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
1932 /// a pass, if any exist, it's an error.
1934 void Verifier::visitUserOp1(Instruction &I) {
1935 Assert(0, "User-defined operators should not live outside of a pass!", &I);
1938 void Verifier::visitTruncInst(TruncInst &I) {
1939 // Get the source and destination types
1940 Type *SrcTy = I.getOperand(0)->getType();
1941 Type *DestTy = I.getType();
1943 // Get the size of the types in bits, we'll need this later
1944 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1945 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1947 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
1948 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
1949 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1950 "trunc source and destination must both be a vector or neither", &I);
1951 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
1953 visitInstruction(I);
1956 void Verifier::visitZExtInst(ZExtInst &I) {
1957 // Get the source and destination types
1958 Type *SrcTy = I.getOperand(0)->getType();
1959 Type *DestTy = I.getType();
1961 // Get the size of the types in bits, we'll need this later
1962 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
1963 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
1964 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1965 "zext source and destination must both be a vector or neither", &I);
1966 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1967 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1969 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
1971 visitInstruction(I);
1974 void Verifier::visitSExtInst(SExtInst &I) {
1975 // Get the source and destination types
1976 Type *SrcTy = I.getOperand(0)->getType();
1977 Type *DestTy = I.getType();
1979 // Get the size of the types in bits, we'll need this later
1980 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1981 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1983 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
1984 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
1985 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1986 "sext source and destination must both be a vector or neither", &I);
1987 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
1989 visitInstruction(I);
1992 void Verifier::visitFPTruncInst(FPTruncInst &I) {
1993 // Get the source and destination types
1994 Type *SrcTy = I.getOperand(0)->getType();
1995 Type *DestTy = I.getType();
1996 // Get the size of the types in bits, we'll need this later
1997 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1998 unsigned DestBitSize = DestTy->getScalarSizeInBits();
2000 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2001 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2002 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2003 "fptrunc source and destination must both be a vector or neither", &I);
2004 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
2006 visitInstruction(I);
2009 void Verifier::visitFPExtInst(FPExtInst &I) {
2010 // Get the source and destination types
2011 Type *SrcTy = I.getOperand(0)->getType();
2012 Type *DestTy = I.getType();
2014 // Get the size of the types in bits, we'll need this later
2015 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2016 unsigned DestBitSize = DestTy->getScalarSizeInBits();
2018 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2019 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2020 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2021 "fpext source and destination must both be a vector or neither", &I);
2022 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
2024 visitInstruction(I);
2027 void Verifier::visitUIToFPInst(UIToFPInst &I) {
2028 // Get the source and destination types
2029 Type *SrcTy = I.getOperand(0)->getType();
2030 Type *DestTy = I.getType();
2032 bool SrcVec = SrcTy->isVectorTy();
2033 bool DstVec = DestTy->isVectorTy();
2035 Assert(SrcVec == DstVec,
2036 "UIToFP source and dest must both be vector or scalar", &I);
2037 Assert(SrcTy->isIntOrIntVectorTy(),
2038 "UIToFP source must be integer or integer vector", &I);
2039 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2042 if (SrcVec && DstVec)
2043 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2044 cast<VectorType>(DestTy)->getNumElements(),
2045 "UIToFP source and dest vector length mismatch", &I);
2047 visitInstruction(I);
2050 void Verifier::visitSIToFPInst(SIToFPInst &I) {
2051 // Get the source and destination types
2052 Type *SrcTy = I.getOperand(0)->getType();
2053 Type *DestTy = I.getType();
2055 bool SrcVec = SrcTy->isVectorTy();
2056 bool DstVec = DestTy->isVectorTy();
2058 Assert(SrcVec == DstVec,
2059 "SIToFP source and dest must both be vector or scalar", &I);
2060 Assert(SrcTy->isIntOrIntVectorTy(),
2061 "SIToFP source must be integer or integer vector", &I);
2062 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2065 if (SrcVec && DstVec)
2066 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2067 cast<VectorType>(DestTy)->getNumElements(),
2068 "SIToFP source and dest vector length mismatch", &I);
2070 visitInstruction(I);
2073 void Verifier::visitFPToUIInst(FPToUIInst &I) {
2074 // Get the source and destination types
2075 Type *SrcTy = I.getOperand(0)->getType();
2076 Type *DestTy = I.getType();
2078 bool SrcVec = SrcTy->isVectorTy();
2079 bool DstVec = DestTy->isVectorTy();
2081 Assert(SrcVec == DstVec,
2082 "FPToUI source and dest must both be vector or scalar", &I);
2083 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2085 Assert(DestTy->isIntOrIntVectorTy(),
2086 "FPToUI result must be integer or integer vector", &I);
2088 if (SrcVec && DstVec)
2089 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2090 cast<VectorType>(DestTy)->getNumElements(),
2091 "FPToUI source and dest vector length mismatch", &I);
2093 visitInstruction(I);
2096 void Verifier::visitFPToSIInst(FPToSIInst &I) {
2097 // Get the source and destination types
2098 Type *SrcTy = I.getOperand(0)->getType();
2099 Type *DestTy = I.getType();
2101 bool SrcVec = SrcTy->isVectorTy();
2102 bool DstVec = DestTy->isVectorTy();
2104 Assert(SrcVec == DstVec,
2105 "FPToSI source and dest must both be vector or scalar", &I);
2106 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2108 Assert(DestTy->isIntOrIntVectorTy(),
2109 "FPToSI result must be integer or integer vector", &I);
2111 if (SrcVec && DstVec)
2112 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2113 cast<VectorType>(DestTy)->getNumElements(),
2114 "FPToSI source and dest vector length mismatch", &I);
2116 visitInstruction(I);
2119 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2120 // Get the source and destination types
2121 Type *SrcTy = I.getOperand(0)->getType();
2122 Type *DestTy = I.getType();
2124 Assert(SrcTy->getScalarType()->isPointerTy(),
2125 "PtrToInt source must be pointer", &I);
2126 Assert(DestTy->getScalarType()->isIntegerTy(),
2127 "PtrToInt result must be integral", &I);
2128 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2131 if (SrcTy->isVectorTy()) {
2132 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2133 VectorType *VDest = dyn_cast<VectorType>(DestTy);
2134 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2135 "PtrToInt Vector width mismatch", &I);
2138 visitInstruction(I);
2141 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2142 // Get the source and destination types
2143 Type *SrcTy = I.getOperand(0)->getType();
2144 Type *DestTy = I.getType();
2146 Assert(SrcTy->getScalarType()->isIntegerTy(),
2147 "IntToPtr source must be an integral", &I);
2148 Assert(DestTy->getScalarType()->isPointerTy(),
2149 "IntToPtr result must be a pointer", &I);
2150 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2152 if (SrcTy->isVectorTy()) {
2153 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2154 VectorType *VDest = dyn_cast<VectorType>(DestTy);
2155 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2156 "IntToPtr Vector width mismatch", &I);
2158 visitInstruction(I);
2161 void Verifier::visitBitCastInst(BitCastInst &I) {
2163 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2164 "Invalid bitcast", &I);
2165 visitInstruction(I);
2168 void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2169 Type *SrcTy = I.getOperand(0)->getType();
2170 Type *DestTy = I.getType();
2172 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2174 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2176 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2177 "AddrSpaceCast must be between different address spaces", &I);
2178 if (SrcTy->isVectorTy())
2179 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2180 "AddrSpaceCast vector pointer number of elements mismatch", &I);
2181 visitInstruction(I);
2184 /// visitPHINode - Ensure that a PHI node is well formed.
2186 void Verifier::visitPHINode(PHINode &PN) {
2187 // Ensure that the PHI nodes are all grouped together at the top of the block.
2188 // This can be tested by checking whether the instruction before this is
2189 // either nonexistent (because this is begin()) or is a PHI node. If not,
2190 // then there is some other instruction before a PHI.
2191 Assert(&PN == &PN.getParent()->front() ||
2192 isa<PHINode>(--BasicBlock::iterator(&PN)),
2193 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
2195 // Check that all of the values of the PHI node have the same type as the
2196 // result, and that the incoming blocks are really basic blocks.
2197 for (Value *IncValue : PN.incoming_values()) {
2198 Assert(PN.getType() == IncValue->getType(),
2199 "PHI node operands are not the same type as the result!", &PN);
2202 // All other PHI node constraints are checked in the visitBasicBlock method.
2204 visitInstruction(PN);
2207 void Verifier::VerifyCallSite(CallSite CS) {
2208 Instruction *I = CS.getInstruction();
2210 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2211 "Called function must be a pointer!", I);
2212 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
2214 Assert(FPTy->getElementType()->isFunctionTy(),
2215 "Called function is not pointer to function type!", I);
2217 Assert(FPTy->getElementType() == CS.getFunctionType(),
2218 "Called function is not the same type as the call!", I);
2220 FunctionType *FTy = CS.getFunctionType();
2222 // Verify that the correct number of arguments are being passed
2223 if (FTy->isVarArg())
2224 Assert(CS.arg_size() >= FTy->getNumParams(),
2225 "Called function requires more parameters than were provided!", I);
2227 Assert(CS.arg_size() == FTy->getNumParams(),
2228 "Incorrect number of arguments passed to called function!", I);
2230 // Verify that all arguments to the call match the function type.
2231 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2232 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2233 "Call parameter type does not match function signature!",
2234 CS.getArgument(i), FTy->getParamType(i), I);
2236 AttributeSet Attrs = CS.getAttributes();
2238 Assert(VerifyAttributeCount(Attrs, CS.arg_size()),
2239 "Attribute after last parameter!", I);
2241 // Verify call attributes.
2242 VerifyFunctionAttrs(FTy, Attrs, I);
2244 // Conservatively check the inalloca argument.
2245 // We have a bug if we can find that there is an underlying alloca without
2247 if (CS.hasInAllocaArgument()) {
2248 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2249 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
2250 Assert(AI->isUsedWithInAlloca(),
2251 "inalloca argument for call has mismatched alloca", AI, I);
2254 if (FTy->isVarArg()) {
2255 // FIXME? is 'nest' even legal here?
2256 bool SawNest = false;
2257 bool SawReturned = false;
2259 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2260 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2262 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2266 // Check attributes on the varargs part.
2267 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
2268 Type *Ty = CS.getArgument(Idx-1)->getType();
2269 VerifyParameterAttrs(Attrs, Idx, Ty, false, I);
2271 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
2272 Assert(!SawNest, "More than one parameter has attribute nest!", I);
2276 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
2277 Assert(!SawReturned, "More than one parameter has attribute returned!",
2279 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2280 "Incompatible argument and return types for 'returned' "
2286 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2287 "Attribute 'sret' cannot be used for vararg call arguments!", I);
2289 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
2290 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
2294 // Verify that there's no metadata unless it's a direct call to an intrinsic.
2295 if (CS.getCalledFunction() == nullptr ||
2296 !CS.getCalledFunction()->getName().startswith("llvm.")) {
2297 for (FunctionType::param_iterator PI = FTy->param_begin(),
2298 PE = FTy->param_end(); PI != PE; ++PI)
2299 Assert(!(*PI)->isMetadataTy(),
2300 "Function has metadata parameter but isn't an intrinsic", I);
2303 if (Function *F = CS.getCalledFunction())
2304 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
2305 visitIntrinsicCallSite(ID, CS);
2307 visitInstruction(*I);
2310 /// Two types are "congruent" if they are identical, or if they are both pointer
2311 /// types with different pointee types and the same address space.
2312 static bool isTypeCongruent(Type *L, Type *R) {
2315 PointerType *PL = dyn_cast<PointerType>(L);
2316 PointerType *PR = dyn_cast<PointerType>(R);
2319 return PL->getAddressSpace() == PR->getAddressSpace();
2322 static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2323 static const Attribute::AttrKind ABIAttrs[] = {
2324 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
2325 Attribute::InReg, Attribute::Returned};
2327 for (auto AK : ABIAttrs) {
2328 if (Attrs.hasAttribute(I + 1, AK))
2329 Copy.addAttribute(AK);
2331 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2332 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2336 void Verifier::verifyMustTailCall(CallInst &CI) {
2337 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
2339 // - The caller and callee prototypes must match. Pointer types of
2340 // parameters or return types may differ in pointee type, but not
2342 Function *F = CI.getParent()->getParent();
2343 FunctionType *CallerTy = F->getFunctionType();
2344 FunctionType *CalleeTy = CI.getFunctionType();
2345 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2346 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2347 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2348 "cannot guarantee tail call due to mismatched varargs", &CI);
2349 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2350 "cannot guarantee tail call due to mismatched return types", &CI);
2351 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2353 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2354 "cannot guarantee tail call due to mismatched parameter types", &CI);
2357 // - The calling conventions of the caller and callee must match.
2358 Assert(F->getCallingConv() == CI.getCallingConv(),
2359 "cannot guarantee tail call due to mismatched calling conv", &CI);
2361 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2362 // returned, and inalloca, must match.
2363 AttributeSet CallerAttrs = F->getAttributes();
2364 AttributeSet CalleeAttrs = CI.getAttributes();
2365 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2366 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2367 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
2368 Assert(CallerABIAttrs == CalleeABIAttrs,
2369 "cannot guarantee tail call due to mismatched ABI impacting "
2370 "function attributes",
2371 &CI, CI.getOperand(I));
2374 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2375 // or a pointer bitcast followed by a ret instruction.
2376 // - The ret instruction must return the (possibly bitcasted) value
2377 // produced by the call or void.
2378 Value *RetVal = &CI;
2379 Instruction *Next = CI.getNextNode();
2381 // Handle the optional bitcast.
2382 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
2383 Assert(BI->getOperand(0) == RetVal,
2384 "bitcast following musttail call must use the call", BI);
2386 Next = BI->getNextNode();
2389 // Check the return.
2390 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
2391 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2393 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2394 "musttail call result must be returned", Ret);
2397 void Verifier::visitCallInst(CallInst &CI) {
2398 VerifyCallSite(&CI);
2400 if (CI.isMustTailCall())
2401 verifyMustTailCall(CI);
2404 void Verifier::visitInvokeInst(InvokeInst &II) {
2405 VerifyCallSite(&II);
2407 // Verify that the first non-PHI instruction of the unwind destination is an
2408 // exception handling instruction.
2410 II.getUnwindDest()->isEHPad(),
2411 "The unwind destination does not have an exception handling instruction!",
2414 visitTerminatorInst(II);
2417 /// visitBinaryOperator - Check that both arguments to the binary operator are
2418 /// of the same type!
2420 void Verifier::visitBinaryOperator(BinaryOperator &B) {
2421 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2422 "Both operands to a binary operator are not of the same type!", &B);
2424 switch (B.getOpcode()) {
2425 // Check that integer arithmetic operators are only used with
2426 // integral operands.
2427 case Instruction::Add:
2428 case Instruction::Sub:
2429 case Instruction::Mul:
2430 case Instruction::SDiv:
2431 case Instruction::UDiv:
2432 case Instruction::SRem:
2433 case Instruction::URem:
2434 Assert(B.getType()->isIntOrIntVectorTy(),
2435 "Integer arithmetic operators only work with integral types!", &B);
2436 Assert(B.getType() == B.getOperand(0)->getType(),
2437 "Integer arithmetic operators must have same type "
2438 "for operands and result!",
2441 // Check that floating-point arithmetic operators are only used with
2442 // floating-point operands.
2443 case Instruction::FAdd:
2444 case Instruction::FSub:
2445 case Instruction::FMul:
2446 case Instruction::FDiv:
2447 case Instruction::FRem:
2448 Assert(B.getType()->isFPOrFPVectorTy(),
2449 "Floating-point arithmetic operators only work with "
2450 "floating-point types!",
2452 Assert(B.getType() == B.getOperand(0)->getType(),
2453 "Floating-point arithmetic operators must have same type "
2454 "for operands and result!",
2457 // Check that logical operators are only used with integral operands.
2458 case Instruction::And:
2459 case Instruction::Or:
2460 case Instruction::Xor:
2461 Assert(B.getType()->isIntOrIntVectorTy(),
2462 "Logical operators only work with integral types!", &B);
2463 Assert(B.getType() == B.getOperand(0)->getType(),
2464 "Logical operators must have same type for operands and result!",
2467 case Instruction::Shl:
2468 case Instruction::LShr:
2469 case Instruction::AShr:
2470 Assert(B.getType()->isIntOrIntVectorTy(),
2471 "Shifts only work with integral types!", &B);
2472 Assert(B.getType() == B.getOperand(0)->getType(),
2473 "Shift return type must be same as operands!", &B);
2476 llvm_unreachable("Unknown BinaryOperator opcode!");
2479 visitInstruction(B);
2482 void Verifier::visitICmpInst(ICmpInst &IC) {
2483 // Check that the operands are the same type
2484 Type *Op0Ty = IC.getOperand(0)->getType();
2485 Type *Op1Ty = IC.getOperand(1)->getType();
2486 Assert(Op0Ty == Op1Ty,
2487 "Both operands to ICmp instruction are not of the same type!", &IC);
2488 // Check that the operands are the right type
2489 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2490 "Invalid operand types for ICmp instruction", &IC);
2491 // Check that the predicate is valid.
2492 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2493 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2494 "Invalid predicate in ICmp instruction!", &IC);
2496 visitInstruction(IC);
2499 void Verifier::visitFCmpInst(FCmpInst &FC) {
2500 // Check that the operands are the same type
2501 Type *Op0Ty = FC.getOperand(0)->getType();
2502 Type *Op1Ty = FC.getOperand(1)->getType();
2503 Assert(Op0Ty == Op1Ty,
2504 "Both operands to FCmp instruction are not of the same type!", &FC);
2505 // Check that the operands are the right type
2506 Assert(Op0Ty->isFPOrFPVectorTy(),
2507 "Invalid operand types for FCmp instruction", &FC);
2508 // Check that the predicate is valid.
2509 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2510 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2511 "Invalid predicate in FCmp instruction!", &FC);
2513 visitInstruction(FC);
2516 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
2518 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2519 "Invalid extractelement operands!", &EI);
2520 visitInstruction(EI);
2523 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
2524 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2526 "Invalid insertelement operands!", &IE);
2527 visitInstruction(IE);
2530 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
2531 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2533 "Invalid shufflevector operands!", &SV);
2534 visitInstruction(SV);
2537 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
2538 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
2540 Assert(isa<PointerType>(TargetTy),
2541 "GEP base pointer is not a vector or a vector of pointers", &GEP);
2542 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
2543 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
2545 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
2546 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
2548 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
2549 GEP.getResultElementType() == ElTy,
2550 "GEP is not of right type for indices!", &GEP, ElTy);
2552 if (GEP.getType()->isVectorTy()) {
2553 // Additional checks for vector GEPs.
2554 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2555 if (GEP.getPointerOperandType()->isVectorTy())
2556 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2557 "Vector GEP result width doesn't match operand's", &GEP);
2558 for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
2559 Type *IndexTy = Idxs[i]->getType();
2560 if (IndexTy->isVectorTy()) {
2561 unsigned IndexWidth = IndexTy->getVectorNumElements();
2562 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2564 Assert(IndexTy->getScalarType()->isIntegerTy(),
2565 "All GEP indices should be of integer type");
2568 visitInstruction(GEP);
2571 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2572 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2575 void Verifier::visitRangeMetadata(Instruction& I,
2576 MDNode* Range, Type* Ty) {
2578 Range == I.getMetadata(LLVMContext::MD_range) &&
2579 "precondition violation");
2581 unsigned NumOperands = Range->getNumOperands();
2582 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
2583 unsigned NumRanges = NumOperands / 2;
2584 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2586 ConstantRange LastRange(1); // Dummy initial value
2587 for (unsigned i = 0; i < NumRanges; ++i) {
2589 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
2590 Assert(Low, "The lower limit must be an integer!", Low);
2592 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
2593 Assert(High, "The upper limit must be an integer!", High);
2594 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2595 "Range types must match instruction type!", &I);
2597 APInt HighV = High->getValue();
2598 APInt LowV = Low->getValue();
2599 ConstantRange CurRange(LowV, HighV);
2600 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2601 "Range must not be empty!", Range);
2603 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2604 "Intervals are overlapping", Range);
2605 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2607 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2610 LastRange = ConstantRange(LowV, HighV);
2612 if (NumRanges > 2) {
2614 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
2616 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
2617 ConstantRange FirstRange(FirstLow, FirstHigh);
2618 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2619 "Intervals are overlapping", Range);
2620 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2625 void Verifier::visitLoadInst(LoadInst &LI) {
2626 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
2627 Assert(PTy, "Load operand must be a pointer.", &LI);
2628 Type *ElTy = LI.getType();
2629 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2630 "huge alignment values are unsupported", &LI);
2631 if (LI.isAtomic()) {
2632 Assert(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
2633 "Load cannot have Release ordering", &LI);
2634 Assert(LI.getAlignment() != 0,
2635 "Atomic load must specify explicit alignment", &LI);
2636 if (!ElTy->isPointerTy()) {
2637 Assert(ElTy->isIntegerTy(), "atomic load operand must have integer type!",
2639 unsigned Size = ElTy->getPrimitiveSizeInBits();
2640 Assert(Size >= 8 && !(Size & (Size - 1)),
2641 "atomic load operand must be power-of-two byte-sized integer", &LI,
2645 Assert(LI.getSynchScope() == CrossThread,
2646 "Non-atomic load cannot have SynchronizationScope specified", &LI);
2649 visitInstruction(LI);
2652 void Verifier::visitStoreInst(StoreInst &SI) {
2653 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
2654 Assert(PTy, "Store operand must be a pointer.", &SI);
2655 Type *ElTy = PTy->getElementType();
2656 Assert(ElTy == SI.getOperand(0)->getType(),
2657 "Stored value type does not match pointer operand type!", &SI, ElTy);
2658 Assert(SI.getAlignment() <= Value::MaximumAlignment,
2659 "huge alignment values are unsupported", &SI);
2660 if (SI.isAtomic()) {
2661 Assert(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
2662 "Store cannot have Acquire ordering", &SI);
2663 Assert(SI.getAlignment() != 0,
2664 "Atomic store must specify explicit alignment", &SI);
2665 if (!ElTy->isPointerTy()) {
2666 Assert(ElTy->isIntegerTy(),
2667 "atomic store operand must have integer type!", &SI, ElTy);
2668 unsigned Size = ElTy->getPrimitiveSizeInBits();
2669 Assert(Size >= 8 && !(Size & (Size - 1)),
2670 "atomic store operand must be power-of-two byte-sized integer",
2674 Assert(SI.getSynchScope() == CrossThread,
2675 "Non-atomic store cannot have SynchronizationScope specified", &SI);
2677 visitInstruction(SI);
2680 void Verifier::visitAllocaInst(AllocaInst &AI) {
2681 SmallPtrSet<const Type*, 4> Visited;
2682 PointerType *PTy = AI.getType();
2683 Assert(PTy->getAddressSpace() == 0,
2684 "Allocation instruction pointer not in the generic address space!",
2686 Assert(AI.getAllocatedType()->isSized(&Visited),
2687 "Cannot allocate unsized type", &AI);
2688 Assert(AI.getArraySize()->getType()->isIntegerTy(),
2689 "Alloca array size must have integer type", &AI);
2690 Assert(AI.getAlignment() <= Value::MaximumAlignment,
2691 "huge alignment values are unsupported", &AI);
2693 visitInstruction(AI);
2696 void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
2698 // FIXME: more conditions???
2699 Assert(CXI.getSuccessOrdering() != NotAtomic,
2700 "cmpxchg instructions must be atomic.", &CXI);
2701 Assert(CXI.getFailureOrdering() != NotAtomic,
2702 "cmpxchg instructions must be atomic.", &CXI);
2703 Assert(CXI.getSuccessOrdering() != Unordered,
2704 "cmpxchg instructions cannot be unordered.", &CXI);
2705 Assert(CXI.getFailureOrdering() != Unordered,
2706 "cmpxchg instructions cannot be unordered.", &CXI);
2707 Assert(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
2708 "cmpxchg instructions be at least as constrained on success as fail",
2710 Assert(CXI.getFailureOrdering() != Release &&
2711 CXI.getFailureOrdering() != AcquireRelease,
2712 "cmpxchg failure ordering cannot include release semantics", &CXI);
2714 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
2715 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
2716 Type *ElTy = PTy->getElementType();
2717 Assert(ElTy->isIntegerTy(), "cmpxchg operand must have integer type!", &CXI,
2719 unsigned Size = ElTy->getPrimitiveSizeInBits();
2720 Assert(Size >= 8 && !(Size & (Size - 1)),
2721 "cmpxchg operand must be power-of-two byte-sized integer", &CXI, ElTy);
2722 Assert(ElTy == CXI.getOperand(1)->getType(),
2723 "Expected value type does not match pointer operand type!", &CXI,
2725 Assert(ElTy == CXI.getOperand(2)->getType(),
2726 "Stored value type does not match pointer operand type!", &CXI, ElTy);
2727 visitInstruction(CXI);
2730 void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
2731 Assert(RMWI.getOrdering() != NotAtomic,
2732 "atomicrmw instructions must be atomic.", &RMWI);
2733 Assert(RMWI.getOrdering() != Unordered,
2734 "atomicrmw instructions cannot be unordered.", &RMWI);
2735 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
2736 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
2737 Type *ElTy = PTy->getElementType();
2738 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
2740 unsigned Size = ElTy->getPrimitiveSizeInBits();
2741 Assert(Size >= 8 && !(Size & (Size - 1)),
2742 "atomicrmw operand must be power-of-two byte-sized integer", &RMWI,
2744 Assert(ElTy == RMWI.getOperand(1)->getType(),
2745 "Argument value type does not match pointer operand type!", &RMWI,
2747 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
2748 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
2749 "Invalid binary operation!", &RMWI);
2750 visitInstruction(RMWI);
2753 void Verifier::visitFenceInst(FenceInst &FI) {
2754 const AtomicOrdering Ordering = FI.getOrdering();
2755 Assert(Ordering == Acquire || Ordering == Release ||
2756 Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
2757 "fence instructions may only have "
2758 "acquire, release, acq_rel, or seq_cst ordering.",
2760 visitInstruction(FI);
2763 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
2764 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
2765 EVI.getIndices()) == EVI.getType(),
2766 "Invalid ExtractValueInst operands!", &EVI);
2768 visitInstruction(EVI);
2771 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
2772 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
2773 IVI.getIndices()) ==
2774 IVI.getOperand(1)->getType(),
2775 "Invalid InsertValueInst operands!", &IVI);
2777 visitInstruction(IVI);
2780 void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
2781 BasicBlock *BB = LPI.getParent();
2783 // The landingpad instruction is ill-formed if it doesn't have any clauses and
2785 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
2786 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
2788 // The landingpad instruction defines its parent as a landing pad block. The
2789 // landing pad block may be branched to only by the unwind edge of an invoke.
2790 for (pred_iterator I = pred_begin(BB), E = pred_end(BB); I != E; ++I) {
2791 const InvokeInst *II = dyn_cast<InvokeInst>((*I)->getTerminator());
2792 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
2793 "Block containing LandingPadInst must be jumped to "
2794 "only by the unwind edge of an invoke.",
2798 if (!LandingPadResultTy)
2799 LandingPadResultTy = LPI.getType();
2801 Assert(LandingPadResultTy == LPI.getType(),
2802 "The landingpad instruction should have a consistent result type "
2803 "inside a function.",
2806 Function *F = LPI.getParent()->getParent();
2807 Assert(F->hasPersonalityFn(),
2808 "LandingPadInst needs to be in a function with a personality.", &LPI);
2810 // The landingpad instruction must be the first non-PHI instruction in the
2812 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
2813 "LandingPadInst not the first non-PHI instruction in the block.",
2816 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
2817 Constant *Clause = LPI.getClause(i);
2818 if (LPI.isCatch(i)) {
2819 Assert(isa<PointerType>(Clause->getType()),
2820 "Catch operand does not have pointer type!", &LPI);
2822 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
2823 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
2824 "Filter operand is not an array of constants!", &LPI);
2828 visitInstruction(LPI);
2831 void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
2832 BasicBlock *BB = CPI.getParent();
2834 if (!CatchPadResultTy)
2835 CatchPadResultTy = CPI.getType();
2837 Assert(CatchPadResultTy == CPI.getType(),
2838 "The catchpad instruction should have a consistent result type "
2839 "inside a function.",
2842 Function *F = BB->getParent();
2843 Assert(F->hasPersonalityFn(),
2844 "CatchPadInst needs to be in a function with a personality.", &CPI);
2846 // The catchpad instruction must be the first non-PHI instruction in the
2848 Assert(BB->getFirstNonPHI() == &CPI,
2849 "CatchPadInst not the first non-PHI instruction in the block.",
2852 BasicBlock *UnwindDest = CPI.getUnwindDest();
2853 Instruction *I = UnwindDest->getFirstNonPHI();
2855 isa<CatchPadInst>(I) || isa<CatchEndPadInst>(I),
2856 "CatchPadInst must unwind to a CatchPadInst or a CatchEndPadInst.",
2859 visitTerminatorInst(CPI);
2862 void Verifier::visitCatchEndPadInst(CatchEndPadInst &CEPI) {
2863 BasicBlock *BB = CEPI.getParent();
2865 Function *F = BB->getParent();
2866 Assert(F->hasPersonalityFn(),
2867 "CatchEndPadInst needs to be in a function with a personality.",
2870 // The catchendpad instruction must be the first non-PHI instruction in the
2872 Assert(BB->getFirstNonPHI() == &CEPI,
2873 "CatchEndPadInst not the first non-PHI instruction in the block.",
2876 unsigned CatchPadsSeen = 0;
2877 for (BasicBlock *PredBB : predecessors(BB))
2878 if (isa<CatchPadInst>(PredBB->getTerminator()))
2881 Assert(CatchPadsSeen <= 1, "CatchEndPadInst must have no more than one "
2882 "CatchPadInst predecessor.",
2885 if (BasicBlock *UnwindDest = CEPI.getUnwindDest()) {
2886 Instruction *I = UnwindDest->getFirstNonPHI();
2888 I->isEHPad() && !isa<LandingPadInst>(I),
2889 "CatchEndPad must unwind to an EH block which is not a landingpad.",
2893 visitTerminatorInst(CEPI);
2896 void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
2897 BasicBlock *BB = CPI.getParent();
2899 if (!CleanupPadResultTy)
2900 CleanupPadResultTy = CPI.getType();
2902 Assert(CleanupPadResultTy == CPI.getType(),
2903 "The cleanuppad instruction should have a consistent result type "
2904 "inside a function.",
2907 Function *F = BB->getParent();
2908 Assert(F->hasPersonalityFn(),
2909 "CleanupPadInst needs to be in a function with a personality.", &CPI);
2911 // The cleanuppad instruction must be the first non-PHI instruction in the
2913 Assert(BB->getFirstNonPHI() == &CPI,
2914 "CleanupPadInst not the first non-PHI instruction in the block.",
2917 visitInstruction(CPI);
2920 void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
2921 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
2922 Instruction *I = UnwindDest->getFirstNonPHI();
2923 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
2924 "CleanupReturnInst must unwind to an EH block which is not a "
2929 visitTerminatorInst(CRI);
2932 void Verifier::visitTerminatePadInst(TerminatePadInst &TPI) {
2933 BasicBlock *BB = TPI.getParent();
2935 Function *F = BB->getParent();
2936 Assert(F->hasPersonalityFn(),
2937 "TerminatePadInst needs to be in a function with a personality.",
2940 // The terminatepad instruction must be the first non-PHI instruction in the
2942 Assert(BB->getFirstNonPHI() == &TPI,
2943 "TerminatePadInst not the first non-PHI instruction in the block.",
2946 if (BasicBlock *UnwindDest = TPI.getUnwindDest()) {
2947 Instruction *I = UnwindDest->getFirstNonPHI();
2948 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
2949 "TerminatePadInst must unwind to an EH block which is not a "
2954 visitTerminatorInst(TPI);
2957 void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
2958 Instruction *Op = cast<Instruction>(I.getOperand(i));
2959 // If the we have an invalid invoke, don't try to compute the dominance.
2960 // We already reject it in the invoke specific checks and the dominance
2961 // computation doesn't handle multiple edges.
2962 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
2963 if (II->getNormalDest() == II->getUnwindDest())
2967 const Use &U = I.getOperandUse(i);
2968 Assert(InstsInThisBlock.count(Op) || DT.dominates(Op, U),
2969 "Instruction does not dominate all uses!", Op, &I);
2972 /// verifyInstruction - Verify that an instruction is well formed.
2974 void Verifier::visitInstruction(Instruction &I) {
2975 BasicBlock *BB = I.getParent();
2976 Assert(BB, "Instruction not embedded in basic block!", &I);
2978 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
2979 for (User *U : I.users()) {
2980 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
2981 "Only PHI nodes may reference their own value!", &I);
2985 // Check that void typed values don't have names
2986 Assert(!I.getType()->isVoidTy() || !I.hasName(),
2987 "Instruction has a name, but provides a void value!", &I);
2989 // Check that the return value of the instruction is either void or a legal
2991 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
2992 "Instruction returns a non-scalar type!", &I);
2994 // Check that the instruction doesn't produce metadata. Calls are already
2995 // checked against the callee type.
2996 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
2997 "Invalid use of metadata!", &I);
2999 // Check that all uses of the instruction, if they are instructions
3000 // themselves, actually have parent basic blocks. If the use is not an
3001 // instruction, it is an error!
3002 for (Use &U : I.uses()) {
3003 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
3004 Assert(Used->getParent() != nullptr,
3005 "Instruction referencing"
3006 " instruction not embedded in a basic block!",
3009 CheckFailed("Use of instruction is not an instruction!", U);
3014 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
3015 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
3017 // Check to make sure that only first-class-values are operands to
3019 if (!I.getOperand(i)->getType()->isFirstClassType()) {
3020 Assert(0, "Instruction operands must be first-class values!", &I);
3023 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
3024 // Check to make sure that the "address of" an intrinsic function is never
3027 !F->isIntrinsic() ||
3028 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3029 "Cannot take the address of an intrinsic!", &I);
3031 !F->isIntrinsic() || isa<CallInst>(I) ||
3032 F->getIntrinsicID() == Intrinsic::donothing ||
3033 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
3034 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3035 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
3036 "Cannot invoke an intrinsinc other than"
3037 " donothing or patchpoint",
3039 Assert(F->getParent() == M, "Referencing function in another module!",
3041 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
3042 Assert(OpBB->getParent() == BB->getParent(),
3043 "Referring to a basic block in another function!", &I);
3044 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
3045 Assert(OpArg->getParent() == BB->getParent(),
3046 "Referring to an argument in another function!", &I);
3047 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
3048 Assert(GV->getParent() == M, "Referencing global in another module!", &I);
3049 } else if (isa<Instruction>(I.getOperand(i))) {
3050 verifyDominatesUse(I, i);
3051 } else if (isa<InlineAsm>(I.getOperand(i))) {
3052 Assert((i + 1 == e && isa<CallInst>(I)) ||
3053 (i + 3 == e && isa<InvokeInst>(I)),
3054 "Cannot take the address of an inline asm!", &I);
3055 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
3056 if (CE->getType()->isPtrOrPtrVectorTy()) {
3057 // If we have a ConstantExpr pointer, we need to see if it came from an
3058 // illegal bitcast (inttoptr <constant int> )
3059 SmallVector<const ConstantExpr *, 4> Stack;
3060 SmallPtrSet<const ConstantExpr *, 4> Visited;
3061 Stack.push_back(CE);
3063 while (!Stack.empty()) {
3064 const ConstantExpr *V = Stack.pop_back_val();
3065 if (!Visited.insert(V).second)
3068 VerifyConstantExprBitcastType(V);
3070 for (unsigned I = 0, N = V->getNumOperands(); I != N; ++I) {
3071 if (ConstantExpr *Op = dyn_cast<ConstantExpr>(V->getOperand(I)))
3072 Stack.push_back(Op);
3079 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
3080 Assert(I.getType()->isFPOrFPVectorTy(),
3081 "fpmath requires a floating point result!", &I);
3082 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
3083 if (ConstantFP *CFP0 =
3084 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
3085 APFloat Accuracy = CFP0->getValueAPF();
3086 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3087 "fpmath accuracy not a positive number!", &I);
3089 Assert(false, "invalid fpmath accuracy!", &I);
3093 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
3094 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3095 "Ranges are only for loads, calls and invokes!", &I);
3096 visitRangeMetadata(I, Range, I.getType());
3099 if (I.getMetadata(LLVMContext::MD_nonnull)) {
3100 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3102 Assert(isa<LoadInst>(I),
3103 "nonnull applies only to load instructions, use attributes"
3104 " for calls or invokes",
3108 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
3109 Assert(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
3113 InstsInThisBlock.insert(&I);
3116 /// VerifyIntrinsicType - Verify that the specified type (which comes from an
3117 /// intrinsic argument or return value) matches the type constraints specified
3118 /// by the .td file (e.g. an "any integer" argument really is an integer).
3120 /// This return true on error but does not print a message.
3121 bool Verifier::VerifyIntrinsicType(Type *Ty,
3122 ArrayRef<Intrinsic::IITDescriptor> &Infos,
3123 SmallVectorImpl<Type*> &ArgTys) {
3124 using namespace Intrinsic;
3126 // If we ran out of descriptors, there are too many arguments.
3127 if (Infos.empty()) return true;
3128 IITDescriptor D = Infos.front();
3129 Infos = Infos.slice(1);
3132 case IITDescriptor::Void: return !Ty->isVoidTy();
3133 case IITDescriptor::VarArg: return true;
3134 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
3135 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
3136 case IITDescriptor::Half: return !Ty->isHalfTy();
3137 case IITDescriptor::Float: return !Ty->isFloatTy();
3138 case IITDescriptor::Double: return !Ty->isDoubleTy();
3139 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
3140 case IITDescriptor::Vector: {
3141 VectorType *VT = dyn_cast<VectorType>(Ty);
3142 return !VT || VT->getNumElements() != D.Vector_Width ||
3143 VerifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
3145 case IITDescriptor::Pointer: {
3146 PointerType *PT = dyn_cast<PointerType>(Ty);
3147 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
3148 VerifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
3151 case IITDescriptor::Struct: {
3152 StructType *ST = dyn_cast<StructType>(Ty);
3153 if (!ST || ST->getNumElements() != D.Struct_NumElements)
3156 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
3157 if (VerifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
3162 case IITDescriptor::Argument:
3163 // Two cases here - If this is the second occurrence of an argument, verify
3164 // that the later instance matches the previous instance.
3165 if (D.getArgumentNumber() < ArgTys.size())
3166 return Ty != ArgTys[D.getArgumentNumber()];
3168 // Otherwise, if this is the first instance of an argument, record it and
3169 // verify the "Any" kind.
3170 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
3171 ArgTys.push_back(Ty);
3173 switch (D.getArgumentKind()) {
3174 case IITDescriptor::AK_Any: return false; // Success
3175 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
3176 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
3177 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
3178 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
3180 llvm_unreachable("all argument kinds not covered");
3182 case IITDescriptor::ExtendArgument: {
3183 // This may only be used when referring to a previous vector argument.
3184 if (D.getArgumentNumber() >= ArgTys.size())
3187 Type *NewTy = ArgTys[D.getArgumentNumber()];
3188 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3189 NewTy = VectorType::getExtendedElementVectorType(VTy);
3190 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3191 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
3197 case IITDescriptor::TruncArgument: {
3198 // This may only be used when referring to a previous vector argument.
3199 if (D.getArgumentNumber() >= ArgTys.size())
3202 Type *NewTy = ArgTys[D.getArgumentNumber()];
3203 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3204 NewTy = VectorType::getTruncatedElementVectorType(VTy);
3205 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3206 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
3212 case IITDescriptor::HalfVecArgument:
3213 // This may only be used when referring to a previous vector argument.
3214 return D.getArgumentNumber() >= ArgTys.size() ||
3215 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
3216 VectorType::getHalfElementsVectorType(
3217 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
3218 case IITDescriptor::SameVecWidthArgument: {
3219 if (D.getArgumentNumber() >= ArgTys.size())
3221 VectorType * ReferenceType =
3222 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
3223 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
3224 if (!ThisArgType || !ReferenceType ||
3225 (ReferenceType->getVectorNumElements() !=
3226 ThisArgType->getVectorNumElements()))
3228 return VerifyIntrinsicType(ThisArgType->getVectorElementType(),
3231 case IITDescriptor::PtrToArgument: {
3232 if (D.getArgumentNumber() >= ArgTys.size())
3234 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
3235 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
3236 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
3238 case IITDescriptor::VecOfPtrsToElt: {
3239 if (D.getArgumentNumber() >= ArgTys.size())
3241 VectorType * ReferenceType =
3242 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
3243 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
3244 if (!ThisArgVecTy || !ReferenceType ||
3245 (ReferenceType->getVectorNumElements() !=
3246 ThisArgVecTy->getVectorNumElements()))
3248 PointerType *ThisArgEltTy =
3249 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
3252 return ThisArgEltTy->getElementType() !=
3253 ReferenceType->getVectorElementType();
3256 llvm_unreachable("unhandled");
3259 /// \brief Verify if the intrinsic has variable arguments.
3260 /// This method is intended to be called after all the fixed arguments have been
3263 /// This method returns true on error and does not print an error message.
3265 Verifier::VerifyIntrinsicIsVarArg(bool isVarArg,
3266 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
3267 using namespace Intrinsic;
3269 // If there are no descriptors left, then it can't be a vararg.
3273 // There should be only one descriptor remaining at this point.
3274 if (Infos.size() != 1)
3277 // Check and verify the descriptor.
3278 IITDescriptor D = Infos.front();
3279 Infos = Infos.slice(1);
3280 if (D.Kind == IITDescriptor::VarArg)
3286 /// Allow intrinsics to be verified in different ways.
3287 void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
3288 Function *IF = CS.getCalledFunction();
3289 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3292 // Verify that the intrinsic prototype lines up with what the .td files
3294 FunctionType *IFTy = IF->getFunctionType();
3295 bool IsVarArg = IFTy->isVarArg();
3297 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3298 getIntrinsicInfoTableEntries(ID, Table);
3299 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
3301 SmallVector<Type *, 4> ArgTys;
3302 Assert(!VerifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
3303 "Intrinsic has incorrect return type!", IF);
3304 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
3305 Assert(!VerifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
3306 "Intrinsic has incorrect argument type!", IF);
3308 // Verify if the intrinsic call matches the vararg property.
3310 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3311 "Intrinsic was not defined with variable arguments!", IF);
3313 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3314 "Callsite was not defined with variable arguments!", IF);
3316 // All descriptors should be absorbed by now.
3317 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
3319 // Now that we have the intrinsic ID and the actual argument types (and we
3320 // know they are legal for the intrinsic!) get the intrinsic name through the
3321 // usual means. This allows us to verify the mangling of argument types into
3323 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
3324 Assert(ExpectedName == IF->getName(),
3325 "Intrinsic name not mangled correctly for type arguments! "
3330 // If the intrinsic takes MDNode arguments, verify that they are either global
3331 // or are local to *this* function.
3332 for (Value *V : CS.args())
3333 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3334 visitMetadataAsValue(*MD, CS.getCaller());
3339 case Intrinsic::ctlz: // llvm.ctlz
3340 case Intrinsic::cttz: // llvm.cttz
3341 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3342 "is_zero_undef argument of bit counting intrinsics must be a "
3346 case Intrinsic::dbg_declare: // llvm.dbg.declare
3347 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3348 "invalid llvm.dbg.declare intrinsic call 1", CS);
3349 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
3351 case Intrinsic::dbg_value: // llvm.dbg.value
3352 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
3354 case Intrinsic::memcpy:
3355 case Intrinsic::memmove:
3356 case Intrinsic::memset: {
3357 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
3359 "alignment argument of memory intrinsics must be a constant int",
3361 const APInt &AlignVal = AlignCI->getValue();
3362 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
3363 "alignment argument of memory intrinsics must be a power of 2", CS);
3364 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
3365 "isvolatile argument of memory intrinsics must be a constant int",
3369 case Intrinsic::gcroot:
3370 case Intrinsic::gcwrite:
3371 case Intrinsic::gcread:
3372 if (ID == Intrinsic::gcroot) {
3374 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3375 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3376 Assert(isa<Constant>(CS.getArgOperand(1)),
3377 "llvm.gcroot parameter #2 must be a constant.", CS);
3378 if (!AI->getAllocatedType()->isPointerTy()) {
3379 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
3380 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3381 "or argument #2 must be a non-null constant.",
3386 Assert(CS.getParent()->getParent()->hasGC(),
3387 "Enclosing function does not use GC.", CS);
3389 case Intrinsic::init_trampoline:
3390 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
3391 "llvm.init_trampoline parameter #2 must resolve to a function.",
3394 case Intrinsic::prefetch:
3395 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
3396 isa<ConstantInt>(CS.getArgOperand(2)) &&
3397 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
3398 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
3399 "invalid arguments to llvm.prefetch", CS);
3401 case Intrinsic::stackprotector:
3402 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
3403 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
3405 case Intrinsic::lifetime_start:
3406 case Intrinsic::lifetime_end:
3407 case Intrinsic::invariant_start:
3408 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
3409 "size argument of memory use markers must be a constant integer",
3412 case Intrinsic::invariant_end:
3413 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3414 "llvm.invariant.end parameter #2 must be a constant integer", CS);
3417 case Intrinsic::localescape: {
3418 BasicBlock *BB = CS.getParent();
3419 Assert(BB == &BB->getParent()->front(),
3420 "llvm.localescape used outside of entry block", CS);
3421 Assert(!SawFrameEscape,
3422 "multiple calls to llvm.localescape in one function", CS);
3423 for (Value *Arg : CS.args()) {
3424 if (isa<ConstantPointerNull>(Arg))
3425 continue; // Null values are allowed as placeholders.
3426 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
3427 Assert(AI && AI->isStaticAlloca(),
3428 "llvm.localescape only accepts static allocas", CS);
3430 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
3431 SawFrameEscape = true;
3434 case Intrinsic::localrecover: {
3435 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
3436 Function *Fn = dyn_cast<Function>(FnArg);
3437 Assert(Fn && !Fn->isDeclaration(),
3438 "llvm.localrecover first "
3439 "argument must be function defined in this module",
3441 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
3442 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
3444 auto &Entry = FrameEscapeInfo[Fn];
3445 Entry.second = unsigned(
3446 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
3450 case Intrinsic::experimental_gc_statepoint:
3451 Assert(!CS.isInlineAsm(),
3452 "gc.statepoint support for inline assembly unimplemented", CS);
3453 Assert(CS.getParent()->getParent()->hasGC(),
3454 "Enclosing function does not use GC.", CS);
3456 VerifyStatepoint(CS);
3458 case Intrinsic::experimental_gc_result_int:
3459 case Intrinsic::experimental_gc_result_float:
3460 case Intrinsic::experimental_gc_result_ptr:
3461 case Intrinsic::experimental_gc_result: {
3462 Assert(CS.getParent()->getParent()->hasGC(),
3463 "Enclosing function does not use GC.", CS);
3464 // Are we tied to a statepoint properly?
3465 CallSite StatepointCS(CS.getArgOperand(0));
3466 const Function *StatepointFn =
3467 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
3468 Assert(StatepointFn && StatepointFn->isDeclaration() &&
3469 StatepointFn->getIntrinsicID() ==
3470 Intrinsic::experimental_gc_statepoint,
3471 "gc.result operand #1 must be from a statepoint", CS,
3472 CS.getArgOperand(0));
3474 // Assert that result type matches wrapped callee.
3475 const Value *Target = StatepointCS.getArgument(2);
3476 const PointerType *PT = cast<PointerType>(Target->getType());
3477 const FunctionType *TargetFuncType =
3478 cast<FunctionType>(PT->getElementType());
3479 Assert(CS.getType() == TargetFuncType->getReturnType(),
3480 "gc.result result type does not match wrapped callee", CS);
3483 case Intrinsic::experimental_gc_relocate: {
3484 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
3486 // Check that this relocate is correctly tied to the statepoint
3488 // This is case for relocate on the unwinding path of an invoke statepoint
3489 if (ExtractValueInst *ExtractValue =
3490 dyn_cast<ExtractValueInst>(CS.getArgOperand(0))) {
3491 Assert(isa<LandingPadInst>(ExtractValue->getAggregateOperand()),
3492 "gc relocate on unwind path incorrectly linked to the statepoint",
3495 const BasicBlock *InvokeBB =
3496 ExtractValue->getParent()->getUniquePredecessor();
3498 // Landingpad relocates should have only one predecessor with invoke
3499 // statepoint terminator
3500 Assert(InvokeBB, "safepoints should have unique landingpads",
3501 ExtractValue->getParent());
3502 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
3504 Assert(isStatepoint(InvokeBB->getTerminator()),
3505 "gc relocate should be linked to a statepoint", InvokeBB);
3508 // In all other cases relocate should be tied to the statepoint directly.
3509 // This covers relocates on a normal return path of invoke statepoint and
3510 // relocates of a call statepoint
3511 auto Token = CS.getArgOperand(0);
3512 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
3513 "gc relocate is incorrectly tied to the statepoint", CS, Token);
3516 // Verify rest of the relocate arguments
3518 GCRelocateOperands Ops(CS);
3519 ImmutableCallSite StatepointCS(Ops.getStatepoint());
3521 // Both the base and derived must be piped through the safepoint
3522 Value* Base = CS.getArgOperand(1);
3523 Assert(isa<ConstantInt>(Base),
3524 "gc.relocate operand #2 must be integer offset", CS);
3526 Value* Derived = CS.getArgOperand(2);
3527 Assert(isa<ConstantInt>(Derived),
3528 "gc.relocate operand #3 must be integer offset", CS);
3530 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
3531 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
3533 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
3534 "gc.relocate: statepoint base index out of bounds", CS);
3535 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
3536 "gc.relocate: statepoint derived index out of bounds", CS);
3538 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
3539 // section of the statepoint's argument
3540 Assert(StatepointCS.arg_size() > 0,
3541 "gc.statepoint: insufficient arguments");
3542 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
3543 "gc.statement: number of call arguments must be constant integer");
3544 const unsigned NumCallArgs =
3545 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
3546 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
3547 "gc.statepoint: mismatch in number of call arguments");
3548 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
3549 "gc.statepoint: number of transition arguments must be "
3550 "a constant integer");
3551 const int NumTransitionArgs =
3552 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
3554 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
3555 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
3556 "gc.statepoint: number of deoptimization arguments must be "
3557 "a constant integer");
3558 const int NumDeoptArgs =
3559 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))->getZExtValue();
3560 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
3561 const int GCParamArgsEnd = StatepointCS.arg_size();
3562 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
3563 "gc.relocate: statepoint base index doesn't fall within the "
3564 "'gc parameters' section of the statepoint call",
3566 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
3567 "gc.relocate: statepoint derived index doesn't fall within the "
3568 "'gc parameters' section of the statepoint call",
3571 // Relocated value must be a pointer type, but gc_relocate does not need to return the
3572 // same pointer type as the relocated pointer. It can be casted to the correct type later
3573 // if it's desired. However, they must have the same address space.
3574 GCRelocateOperands Operands(CS);
3575 Assert(Operands.getDerivedPtr()->getType()->isPointerTy(),
3576 "gc.relocate: relocated value must be a gc pointer", CS);
3578 // gc_relocate return type must be a pointer type, and is verified earlier in
3579 // VerifyIntrinsicType().
3580 Assert(cast<PointerType>(CS.getType())->getAddressSpace() ==
3581 cast<PointerType>(Operands.getDerivedPtr()->getType())->getAddressSpace(),
3582 "gc.relocate: relocating a pointer shouldn't change its address space", CS);
3588 /// \brief Carefully grab the subprogram from a local scope.
3590 /// This carefully grabs the subprogram from a local scope, avoiding the
3591 /// built-in assertions that would typically fire.
3592 static DISubprogram *getSubprogram(Metadata *LocalScope) {
3596 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
3599 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
3600 return getSubprogram(LB->getRawScope());
3602 // Just return null; broken scope chains are checked elsewhere.
3603 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
3607 template <class DbgIntrinsicTy>
3608 void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
3609 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
3610 Assert(isa<ValueAsMetadata>(MD) ||
3611 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
3612 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
3613 Assert(isa<DILocalVariable>(DII.getRawVariable()),
3614 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
3615 DII.getRawVariable());
3616 Assert(isa<DIExpression>(DII.getRawExpression()),
3617 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
3618 DII.getRawExpression());
3620 // Ignore broken !dbg attachments; they're checked elsewhere.
3621 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
3622 if (!isa<DILocation>(N))
3625 BasicBlock *BB = DII.getParent();
3626 Function *F = BB ? BB->getParent() : nullptr;
3628 // The scopes for variables and !dbg attachments must agree.
3629 DILocalVariable *Var = DII.getVariable();
3630 DILocation *Loc = DII.getDebugLoc();
3631 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
3634 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
3635 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
3636 if (!VarSP || !LocSP)
3637 return; // Broken scope chains are checked elsewhere.
3639 Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
3640 " variable and !dbg attachment",
3641 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
3642 Loc->getScope()->getSubprogram());
3645 template <class MapTy>
3646 static uint64_t getVariableSize(const DILocalVariable &V, const MapTy &Map) {
3647 // Be careful of broken types (checked elsewhere).
3648 const Metadata *RawType = V.getRawType();
3650 // Try to get the size directly.
3651 if (auto *T = dyn_cast<DIType>(RawType))
3652 if (uint64_t Size = T->getSizeInBits())
3655 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
3656 // Look at the base type.
3657 RawType = DT->getRawBaseType();
3661 if (auto *S = dyn_cast<MDString>(RawType)) {
3662 // Don't error on missing types (checked elsewhere).
3663 RawType = Map.lookup(S);
3667 // Missing type or size.
3675 template <class MapTy>
3676 void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I,
3677 const MapTy &TypeRefs) {
3680 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
3681 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
3682 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
3684 auto *DDI = cast<DbgDeclareInst>(&I);
3685 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
3686 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
3689 // We don't know whether this intrinsic verified correctly.
3690 if (!V || !E || !E->isValid())
3693 // Nothing to do if this isn't a bit piece expression.
3694 if (!E->isBitPiece())
3697 // The frontend helps out GDB by emitting the members of local anonymous
3698 // unions as artificial local variables with shared storage. When SROA splits
3699 // the storage for artificial local variables that are smaller than the entire
3700 // union, the overhang piece will be outside of the allotted space for the
3701 // variable and this check fails.
3702 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
3703 if (V->isArtificial())
3706 // If there's no size, the type is broken, but that should be checked
3708 uint64_t VarSize = getVariableSize(*V, TypeRefs);
3712 unsigned PieceSize = E->getBitPieceSize();
3713 unsigned PieceOffset = E->getBitPieceOffset();
3714 Assert(PieceSize + PieceOffset <= VarSize,
3715 "piece is larger than or outside of variable", &I, V, E);
3716 Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
3719 void Verifier::visitUnresolvedTypeRef(const MDString *S, const MDNode *N) {
3720 // This is in its own function so we get an error for each bad type ref (not
3722 Assert(false, "unresolved type ref", S, N);
3725 void Verifier::verifyTypeRefs() {
3726 auto *CUs = M->getNamedMetadata("llvm.dbg.cu");
3730 // Visit all the compile units again to map the type references.
3731 SmallDenseMap<const MDString *, const DIType *, 32> TypeRefs;
3732 for (auto *CU : CUs->operands())
3733 if (auto Ts = cast<DICompileUnit>(CU)->getRetainedTypes())
3734 for (DIType *Op : Ts)
3735 if (auto *T = dyn_cast<DICompositeType>(Op))
3736 if (auto *S = T->getRawIdentifier()) {
3737 UnresolvedTypeRefs.erase(S);
3738 TypeRefs.insert(std::make_pair(S, T));
3741 // Verify debug info intrinsic bit piece expressions. This needs a second
3742 // pass through the intructions, since we haven't built TypeRefs yet when
3743 // verifying functions, and simply queuing the DbgInfoIntrinsics to evaluate
3744 // later/now would queue up some that could be later deleted.
3745 for (const Function &F : *M)
3746 for (const BasicBlock &BB : F)
3747 for (const Instruction &I : BB)
3748 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
3749 verifyBitPieceExpression(*DII, TypeRefs);
3751 // Return early if all typerefs were resolved.
3752 if (UnresolvedTypeRefs.empty())
3755 // Sort the unresolved references by name so the output is deterministic.
3756 typedef std::pair<const MDString *, const MDNode *> TypeRef;
3757 SmallVector<TypeRef, 32> Unresolved(UnresolvedTypeRefs.begin(),
3758 UnresolvedTypeRefs.end());
3759 std::sort(Unresolved.begin(), Unresolved.end(),
3760 [](const TypeRef &LHS, const TypeRef &RHS) {
3761 return LHS.first->getString() < RHS.first->getString();
3764 // Visit the unresolved refs (printing out the errors).
3765 for (const TypeRef &TR : Unresolved)
3766 visitUnresolvedTypeRef(TR.first, TR.second);
3769 //===----------------------------------------------------------------------===//
3770 // Implement the public interfaces to this file...
3771 //===----------------------------------------------------------------------===//
3773 bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
3774 Function &F = const_cast<Function &>(f);
3775 assert(!F.isDeclaration() && "Cannot verify external functions");
3777 raw_null_ostream NullStr;
3778 Verifier V(OS ? *OS : NullStr);
3780 // Note that this function's return value is inverted from what you would
3781 // expect of a function called "verify".
3782 return !V.verify(F);
3785 bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
3786 raw_null_ostream NullStr;
3787 Verifier V(OS ? *OS : NullStr);
3789 bool Broken = false;
3790 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
3791 if (!I->isDeclaration() && !I->isMaterializable())
3792 Broken |= !V.verify(*I);
3794 // Note that this function's return value is inverted from what you would
3795 // expect of a function called "verify".
3796 return !V.verify(M) || Broken;
3800 struct VerifierLegacyPass : public FunctionPass {
3806 VerifierLegacyPass() : FunctionPass(ID), V(dbgs()), FatalErrors(true) {
3807 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3809 explicit VerifierLegacyPass(bool FatalErrors)
3810 : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
3811 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3814 bool runOnFunction(Function &F) override {
3815 if (!V.verify(F) && FatalErrors)
3816 report_fatal_error("Broken function found, compilation aborted!");
3821 bool doFinalization(Module &M) override {
3822 if (!V.verify(M) && FatalErrors)
3823 report_fatal_error("Broken module found, compilation aborted!");
3828 void getAnalysisUsage(AnalysisUsage &AU) const override {
3829 AU.setPreservesAll();
3834 char VerifierLegacyPass::ID = 0;
3835 INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
3837 FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
3838 return new VerifierLegacyPass(FatalErrors);
3841 PreservedAnalyses VerifierPass::run(Module &M) {
3842 if (verifyModule(M, &dbgs()) && FatalErrors)
3843 report_fatal_error("Broken module found, compilation aborted!");
3845 return PreservedAnalyses::all();
3848 PreservedAnalyses VerifierPass::run(Function &F) {
3849 if (verifyFunction(F, &dbgs()) && FatalErrors)
3850 report_fatal_error("Broken function found, compilation aborted!");
3852 return PreservedAnalyses::all();