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 // * Landingpad instructions must be in a function with a personality function.
43 // * All other things that are tested by asserts spread about the code...
45 //===----------------------------------------------------------------------===//
47 #include "llvm/IR/Verifier.h"
48 #include "llvm/ADT/STLExtras.h"
49 #include "llvm/ADT/SetVector.h"
50 #include "llvm/ADT/SmallPtrSet.h"
51 #include "llvm/ADT/SmallVector.h"
52 #include "llvm/ADT/StringExtras.h"
53 #include "llvm/IR/CFG.h"
54 #include "llvm/IR/CallSite.h"
55 #include "llvm/IR/CallingConv.h"
56 #include "llvm/IR/ConstantRange.h"
57 #include "llvm/IR/Constants.h"
58 #include "llvm/IR/DataLayout.h"
59 #include "llvm/IR/DebugInfo.h"
60 #include "llvm/IR/DerivedTypes.h"
61 #include "llvm/IR/Dominators.h"
62 #include "llvm/IR/InlineAsm.h"
63 #include "llvm/IR/InstIterator.h"
64 #include "llvm/IR/InstVisitor.h"
65 #include "llvm/IR/IntrinsicInst.h"
66 #include "llvm/IR/LLVMContext.h"
67 #include "llvm/IR/Metadata.h"
68 #include "llvm/IR/Module.h"
69 #include "llvm/IR/PassManager.h"
70 #include "llvm/IR/Statepoint.h"
71 #include "llvm/Pass.h"
72 #include "llvm/Support/CommandLine.h"
73 #include "llvm/Support/Debug.h"
74 #include "llvm/Support/ErrorHandling.h"
75 #include "llvm/Support/raw_ostream.h"
80 static cl::opt<bool> VerifyDebugInfo("verify-debug-info", cl::init(true));
83 struct VerifierSupport {
87 /// \brief Track the brokenness of the module while recursively visiting.
90 explicit VerifierSupport(raw_ostream &OS)
91 : OS(OS), M(nullptr), Broken(false) {}
94 template <class NodeTy> void Write(const ilist_iterator<NodeTy> &I) {
98 void Write(const Value *V) {
101 if (isa<Instruction>(V)) {
104 V->printAsOperand(OS, true, M);
108 void Write(ImmutableCallSite CS) {
109 Write(CS.getInstruction());
112 void Write(const Metadata *MD) {
119 template <class T> void Write(const MDTupleTypedArrayWrapper<T> &MD) {
123 void Write(const NamedMDNode *NMD) {
130 void Write(Type *T) {
136 void Write(const Comdat *C) {
142 template <typename T1, typename... Ts>
143 void WriteTs(const T1 &V1, const Ts &... Vs) {
148 template <typename... Ts> void WriteTs() {}
151 /// \brief A check failed, so printout out the condition and the message.
153 /// This provides a nice place to put a breakpoint if you want to see why
154 /// something is not correct.
155 void CheckFailed(const Twine &Message) {
156 OS << Message << '\n';
160 /// \brief A check failed (with values to print).
162 /// This calls the Message-only version so that the above is easier to set a
164 template <typename T1, typename... Ts>
165 void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) {
166 CheckFailed(Message);
171 class Verifier : public InstVisitor<Verifier>, VerifierSupport {
172 friend class InstVisitor<Verifier>;
174 LLVMContext *Context;
177 /// \brief When verifying a basic block, keep track of all of the
178 /// instructions we have seen so far.
180 /// This allows us to do efficient dominance checks for the case when an
181 /// instruction has an operand that is an instruction in the same block.
182 SmallPtrSet<Instruction *, 16> InstsInThisBlock;
184 /// \brief Keep track of the metadata nodes that have been checked already.
185 SmallPtrSet<const Metadata *, 32> MDNodes;
187 /// \brief Track unresolved string-based type references.
188 SmallDenseMap<const MDString *, const MDNode *, 32> UnresolvedTypeRefs;
190 /// \brief The result type for a landingpad.
191 Type *LandingPadResultTy;
193 /// \brief Whether we've seen a call to @llvm.localescape in this function
197 /// Stores the count of how many objects were passed to llvm.localescape for a
198 /// given function and the largest index passed to llvm.localrecover.
199 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
202 explicit Verifier(raw_ostream &OS)
203 : VerifierSupport(OS), Context(nullptr), LandingPadResultTy(nullptr),
204 SawFrameEscape(false) {}
206 bool verify(const Function &F) {
208 Context = &M->getContext();
210 // First ensure the function is well-enough formed to compute dominance
213 OS << "Function '" << F.getName()
214 << "' does not contain an entry block!\n";
217 for (Function::const_iterator I = F.begin(), E = F.end(); I != E; ++I) {
218 if (I->empty() || !I->back().isTerminator()) {
219 OS << "Basic Block in function '" << F.getName()
220 << "' does not have terminator!\n";
221 I->printAsOperand(OS, true);
227 // Now directly compute a dominance tree. We don't rely on the pass
228 // manager to provide this as it isolates us from a potentially
229 // out-of-date dominator tree and makes it significantly more complex to
230 // run this code outside of a pass manager.
231 // FIXME: It's really gross that we have to cast away constness here.
232 DT.recalculate(const_cast<Function &>(F));
235 // FIXME: We strip const here because the inst visitor strips const.
236 visit(const_cast<Function &>(F));
237 InstsInThisBlock.clear();
238 LandingPadResultTy = nullptr;
239 SawFrameEscape = false;
244 bool verify(const Module &M) {
246 Context = &M.getContext();
249 // Scan through, checking all of the external function's linkage now...
250 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
251 visitGlobalValue(*I);
253 // Check to make sure function prototypes are okay.
254 if (I->isDeclaration())
258 // Now that we've visited every function, verify that we never asked to
259 // recover a frame index that wasn't escaped.
260 verifyFrameRecoverIndices();
262 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
264 visitGlobalVariable(*I);
266 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
268 visitGlobalAlias(*I);
270 for (Module::const_named_metadata_iterator I = M.named_metadata_begin(),
271 E = M.named_metadata_end();
273 visitNamedMDNode(*I);
275 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
276 visitComdat(SMEC.getValue());
279 visitModuleIdents(M);
281 // Verify type referneces last.
288 // Verification methods...
289 void visitGlobalValue(const GlobalValue &GV);
290 void visitGlobalVariable(const GlobalVariable &GV);
291 void visitGlobalAlias(const GlobalAlias &GA);
292 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
293 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
294 const GlobalAlias &A, const Constant &C);
295 void visitNamedMDNode(const NamedMDNode &NMD);
296 void visitMDNode(const MDNode &MD);
297 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
298 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
299 void visitComdat(const Comdat &C);
300 void visitModuleIdents(const Module &M);
301 void visitModuleFlags(const Module &M);
302 void visitModuleFlag(const MDNode *Op,
303 DenseMap<const MDString *, const MDNode *> &SeenIDs,
304 SmallVectorImpl<const MDNode *> &Requirements);
305 void visitFunction(const Function &F);
306 void visitBasicBlock(BasicBlock &BB);
307 void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty);
308 void visitDereferenceableMetadata(Instruction& I, MDNode* MD);
310 template <class Ty> bool isValidMetadataArray(const MDTuple &N);
311 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
312 #include "llvm/IR/Metadata.def"
313 void visitDIScope(const DIScope &N);
314 void visitDIVariable(const DIVariable &N);
315 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
316 void visitDITemplateParameter(const DITemplateParameter &N);
318 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
320 /// \brief Check for a valid string-based type reference.
322 /// Checks if \c MD is a string-based type reference. If it is, keeps track
323 /// of it (and its user, \c N) for error messages later.
324 bool isValidUUID(const MDNode &N, const Metadata *MD);
326 /// \brief Check for a valid type reference.
328 /// Checks for subclasses of \a DIType, or \a isValidUUID().
329 bool isTypeRef(const MDNode &N, const Metadata *MD);
331 /// \brief Check for a valid scope reference.
333 /// Checks for subclasses of \a DIScope, or \a isValidUUID().
334 bool isScopeRef(const MDNode &N, const Metadata *MD);
336 /// \brief Check for a valid debug info reference.
338 /// Checks for subclasses of \a DINode, or \a isValidUUID().
339 bool isDIRef(const MDNode &N, const Metadata *MD);
341 // InstVisitor overrides...
342 using InstVisitor<Verifier>::visit;
343 void visit(Instruction &I);
345 void visitTruncInst(TruncInst &I);
346 void visitZExtInst(ZExtInst &I);
347 void visitSExtInst(SExtInst &I);
348 void visitFPTruncInst(FPTruncInst &I);
349 void visitFPExtInst(FPExtInst &I);
350 void visitFPToUIInst(FPToUIInst &I);
351 void visitFPToSIInst(FPToSIInst &I);
352 void visitUIToFPInst(UIToFPInst &I);
353 void visitSIToFPInst(SIToFPInst &I);
354 void visitIntToPtrInst(IntToPtrInst &I);
355 void visitPtrToIntInst(PtrToIntInst &I);
356 void visitBitCastInst(BitCastInst &I);
357 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
358 void visitPHINode(PHINode &PN);
359 void visitBinaryOperator(BinaryOperator &B);
360 void visitICmpInst(ICmpInst &IC);
361 void visitFCmpInst(FCmpInst &FC);
362 void visitExtractElementInst(ExtractElementInst &EI);
363 void visitInsertElementInst(InsertElementInst &EI);
364 void visitShuffleVectorInst(ShuffleVectorInst &EI);
365 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
366 void visitCallInst(CallInst &CI);
367 void visitInvokeInst(InvokeInst &II);
368 void visitGetElementPtrInst(GetElementPtrInst &GEP);
369 void visitLoadInst(LoadInst &LI);
370 void visitStoreInst(StoreInst &SI);
371 void verifyDominatesUse(Instruction &I, unsigned i);
372 void visitInstruction(Instruction &I);
373 void visitTerminatorInst(TerminatorInst &I);
374 void visitBranchInst(BranchInst &BI);
375 void visitReturnInst(ReturnInst &RI);
376 void visitSwitchInst(SwitchInst &SI);
377 void visitIndirectBrInst(IndirectBrInst &BI);
378 void visitSelectInst(SelectInst &SI);
379 void visitUserOp1(Instruction &I);
380 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
381 void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS);
382 template <class DbgIntrinsicTy>
383 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
384 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
385 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
386 void visitFenceInst(FenceInst &FI);
387 void visitAllocaInst(AllocaInst &AI);
388 void visitExtractValueInst(ExtractValueInst &EVI);
389 void visitInsertValueInst(InsertValueInst &IVI);
390 void visitEHPadPredecessors(Instruction &I);
391 void visitLandingPadInst(LandingPadInst &LPI);
392 void visitCatchPadInst(CatchPadInst &CPI);
393 void visitCatchEndPadInst(CatchEndPadInst &CEPI);
394 void visitCleanupPadInst(CleanupPadInst &CPI);
395 void visitCleanupEndPadInst(CleanupEndPadInst &CEPI);
396 void visitCleanupReturnInst(CleanupReturnInst &CRI);
397 void visitTerminatePadInst(TerminatePadInst &TPI);
399 void VerifyCallSite(CallSite CS);
400 void verifyMustTailCall(CallInst &CI);
401 bool PerformTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
402 unsigned ArgNo, std::string &Suffix);
403 bool VerifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
404 SmallVectorImpl<Type *> &ArgTys);
405 bool VerifyIntrinsicIsVarArg(bool isVarArg,
406 ArrayRef<Intrinsic::IITDescriptor> &Infos);
407 bool VerifyAttributeCount(AttributeSet Attrs, unsigned Params);
408 void VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
410 void VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
411 bool isReturnValue, const Value *V);
412 void VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
414 void VerifyFunctionMetadata(
415 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs);
417 void VerifyConstantExprBitcastType(const ConstantExpr *CE);
418 void VerifyStatepoint(ImmutableCallSite CS);
419 void verifyFrameRecoverIndices();
421 // Module-level debug info verification...
422 void verifyTypeRefs();
423 template <class MapTy>
424 void verifyBitPieceExpression(const DbgInfoIntrinsic &I,
425 const MapTy &TypeRefs);
426 void visitUnresolvedTypeRef(const MDString *S, const MDNode *N);
428 } // End anonymous namespace
430 // Assert - We know that cond should be true, if not print an error message.
431 #define Assert(C, ...) \
432 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
434 void Verifier::visit(Instruction &I) {
435 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
436 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
437 InstVisitor<Verifier>::visit(I);
441 void Verifier::visitGlobalValue(const GlobalValue &GV) {
442 Assert(!GV.isDeclaration() || GV.hasExternalLinkage() ||
443 GV.hasExternalWeakLinkage(),
444 "Global is external, but doesn't have external or weak linkage!", &GV);
446 Assert(GV.getAlignment() <= Value::MaximumAlignment,
447 "huge alignment values are unsupported", &GV);
448 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
449 "Only global variables can have appending linkage!", &GV);
451 if (GV.hasAppendingLinkage()) {
452 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
453 Assert(GVar && GVar->getValueType()->isArrayTy(),
454 "Only global arrays can have appending linkage!", GVar);
457 if (GV.isDeclarationForLinker())
458 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
461 void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
462 if (GV.hasInitializer()) {
463 Assert(GV.getInitializer()->getType() == GV.getType()->getElementType(),
464 "Global variable initializer type does not match global "
468 // If the global has common linkage, it must have a zero initializer and
469 // cannot be constant.
470 if (GV.hasCommonLinkage()) {
471 Assert(GV.getInitializer()->isNullValue(),
472 "'common' global must have a zero initializer!", &GV);
473 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
475 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
478 Assert(GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
479 "invalid linkage type for global declaration", &GV);
482 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
483 GV.getName() == "llvm.global_dtors")) {
484 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
485 "invalid linkage for intrinsic global variable", &GV);
486 // Don't worry about emitting an error for it not being an array,
487 // visitGlobalValue will complain on appending non-array.
488 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
489 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
490 PointerType *FuncPtrTy =
491 FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
492 // FIXME: Reject the 2-field form in LLVM 4.0.
494 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
495 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
496 STy->getTypeAtIndex(1) == FuncPtrTy,
497 "wrong type for intrinsic global variable", &GV);
498 if (STy->getNumElements() == 3) {
499 Type *ETy = STy->getTypeAtIndex(2);
500 Assert(ETy->isPointerTy() &&
501 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
502 "wrong type for intrinsic global variable", &GV);
507 if (GV.hasName() && (GV.getName() == "llvm.used" ||
508 GV.getName() == "llvm.compiler.used")) {
509 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
510 "invalid linkage for intrinsic global variable", &GV);
511 Type *GVType = GV.getValueType();
512 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
513 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
514 Assert(PTy, "wrong type for intrinsic global variable", &GV);
515 if (GV.hasInitializer()) {
516 const Constant *Init = GV.getInitializer();
517 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
518 Assert(InitArray, "wrong initalizer for intrinsic global variable",
520 for (unsigned i = 0, e = InitArray->getNumOperands(); i != e; ++i) {
521 Value *V = Init->getOperand(i)->stripPointerCastsNoFollowAliases();
522 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
524 "invalid llvm.used member", V);
525 Assert(V->hasName(), "members of llvm.used must be named", V);
531 Assert(!GV.hasDLLImportStorageClass() ||
532 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
533 GV.hasAvailableExternallyLinkage(),
534 "Global is marked as dllimport, but not external", &GV);
536 if (!GV.hasInitializer()) {
537 visitGlobalValue(GV);
541 // Walk any aggregate initializers looking for bitcasts between address spaces
542 SmallPtrSet<const Value *, 4> Visited;
543 SmallVector<const Value *, 4> WorkStack;
544 WorkStack.push_back(cast<Value>(GV.getInitializer()));
546 while (!WorkStack.empty()) {
547 const Value *V = WorkStack.pop_back_val();
548 if (!Visited.insert(V).second)
551 if (const User *U = dyn_cast<User>(V)) {
552 WorkStack.append(U->op_begin(), U->op_end());
555 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
556 VerifyConstantExprBitcastType(CE);
562 visitGlobalValue(GV);
565 void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
566 SmallPtrSet<const GlobalAlias*, 4> Visited;
568 visitAliaseeSubExpr(Visited, GA, C);
571 void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
572 const GlobalAlias &GA, const Constant &C) {
573 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
574 Assert(!GV->isDeclaration(), "Alias must point to a definition", &GA);
576 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
577 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
579 Assert(!GA2->mayBeOverridden(), "Alias cannot point to a weak alias",
582 // Only continue verifying subexpressions of GlobalAliases.
583 // Do not recurse into global initializers.
588 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
589 VerifyConstantExprBitcastType(CE);
591 for (const Use &U : C.operands()) {
593 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
594 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
595 else if (const auto *C2 = dyn_cast<Constant>(V))
596 visitAliaseeSubExpr(Visited, GA, *C2);
600 void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
601 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
602 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
603 "weak_odr, or external linkage!",
605 const Constant *Aliasee = GA.getAliasee();
606 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
607 Assert(GA.getType() == Aliasee->getType(),
608 "Alias and aliasee types should match!", &GA);
610 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
611 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
613 visitAliaseeSubExpr(GA, *Aliasee);
615 visitGlobalValue(GA);
618 void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
619 for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i) {
620 MDNode *MD = NMD.getOperand(i);
622 if (NMD.getName() == "llvm.dbg.cu") {
623 Assert(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
633 void Verifier::visitMDNode(const MDNode &MD) {
634 // Only visit each node once. Metadata can be mutually recursive, so this
635 // avoids infinite recursion here, as well as being an optimization.
636 if (!MDNodes.insert(&MD).second)
639 switch (MD.getMetadataID()) {
641 llvm_unreachable("Invalid MDNode subclass");
642 case Metadata::MDTupleKind:
644 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
645 case Metadata::CLASS##Kind: \
646 visit##CLASS(cast<CLASS>(MD)); \
648 #include "llvm/IR/Metadata.def"
651 for (unsigned i = 0, e = MD.getNumOperands(); i != e; ++i) {
652 Metadata *Op = MD.getOperand(i);
655 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
657 if (auto *N = dyn_cast<MDNode>(Op)) {
661 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
662 visitValueAsMetadata(*V, nullptr);
667 // Check these last, so we diagnose problems in operands first.
668 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
669 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
672 void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
673 Assert(MD.getValue(), "Expected valid value", &MD);
674 Assert(!MD.getValue()->getType()->isMetadataTy(),
675 "Unexpected metadata round-trip through values", &MD, MD.getValue());
677 auto *L = dyn_cast<LocalAsMetadata>(&MD);
681 Assert(F, "function-local metadata used outside a function", L);
683 // If this was an instruction, bb, or argument, verify that it is in the
684 // function that we expect.
685 Function *ActualF = nullptr;
686 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
687 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
688 ActualF = I->getParent()->getParent();
689 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
690 ActualF = BB->getParent();
691 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
692 ActualF = A->getParent();
693 assert(ActualF && "Unimplemented function local metadata case!");
695 Assert(ActualF == F, "function-local metadata used in wrong function", L);
698 void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
699 Metadata *MD = MDV.getMetadata();
700 if (auto *N = dyn_cast<MDNode>(MD)) {
705 // Only visit each node once. Metadata can be mutually recursive, so this
706 // avoids infinite recursion here, as well as being an optimization.
707 if (!MDNodes.insert(MD).second)
710 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
711 visitValueAsMetadata(*V, F);
714 bool Verifier::isValidUUID(const MDNode &N, const Metadata *MD) {
715 auto *S = dyn_cast<MDString>(MD);
718 if (S->getString().empty())
721 // Keep track of names of types referenced via UUID so we can check that they
723 UnresolvedTypeRefs.insert(std::make_pair(S, &N));
727 /// \brief Check if a value can be a reference to a type.
728 bool Verifier::isTypeRef(const MDNode &N, const Metadata *MD) {
729 return !MD || isValidUUID(N, MD) || isa<DIType>(MD);
732 /// \brief Check if a value can be a ScopeRef.
733 bool Verifier::isScopeRef(const MDNode &N, const Metadata *MD) {
734 return !MD || isValidUUID(N, MD) || isa<DIScope>(MD);
737 /// \brief Check if a value can be a debug info ref.
738 bool Verifier::isDIRef(const MDNode &N, const Metadata *MD) {
739 return !MD || isValidUUID(N, MD) || isa<DINode>(MD);
743 bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
744 for (Metadata *MD : N.operands()) {
757 bool isValidMetadataArray(const MDTuple &N) {
758 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
762 bool isValidMetadataNullArray(const MDTuple &N) {
763 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
766 void Verifier::visitDILocation(const DILocation &N) {
767 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
768 "location requires a valid scope", &N, N.getRawScope());
769 if (auto *IA = N.getRawInlinedAt())
770 Assert(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
773 void Verifier::visitGenericDINode(const GenericDINode &N) {
774 Assert(N.getTag(), "invalid tag", &N);
777 void Verifier::visitDIScope(const DIScope &N) {
778 if (auto *F = N.getRawFile())
779 Assert(isa<DIFile>(F), "invalid file", &N, F);
782 void Verifier::visitDISubrange(const DISubrange &N) {
783 Assert(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
784 Assert(N.getCount() >= -1, "invalid subrange count", &N);
787 void Verifier::visitDIEnumerator(const DIEnumerator &N) {
788 Assert(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
791 void Verifier::visitDIBasicType(const DIBasicType &N) {
792 Assert(N.getTag() == dwarf::DW_TAG_base_type ||
793 N.getTag() == dwarf::DW_TAG_unspecified_type,
797 void Verifier::visitDIDerivedType(const DIDerivedType &N) {
798 // Common scope checks.
801 Assert(N.getTag() == dwarf::DW_TAG_typedef ||
802 N.getTag() == dwarf::DW_TAG_pointer_type ||
803 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
804 N.getTag() == dwarf::DW_TAG_reference_type ||
805 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
806 N.getTag() == dwarf::DW_TAG_const_type ||
807 N.getTag() == dwarf::DW_TAG_volatile_type ||
808 N.getTag() == dwarf::DW_TAG_restrict_type ||
809 N.getTag() == dwarf::DW_TAG_member ||
810 N.getTag() == dwarf::DW_TAG_inheritance ||
811 N.getTag() == dwarf::DW_TAG_friend,
813 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
814 Assert(isTypeRef(N, N.getExtraData()), "invalid pointer to member type", &N,
818 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
819 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
823 static bool hasConflictingReferenceFlags(unsigned Flags) {
824 return (Flags & DINode::FlagLValueReference) &&
825 (Flags & DINode::FlagRValueReference);
828 void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
829 auto *Params = dyn_cast<MDTuple>(&RawParams);
830 Assert(Params, "invalid template params", &N, &RawParams);
831 for (Metadata *Op : Params->operands()) {
832 Assert(Op && isa<DITemplateParameter>(Op), "invalid template parameter", &N,
837 void Verifier::visitDICompositeType(const DICompositeType &N) {
838 // Common scope checks.
841 Assert(N.getTag() == dwarf::DW_TAG_array_type ||
842 N.getTag() == dwarf::DW_TAG_structure_type ||
843 N.getTag() == dwarf::DW_TAG_union_type ||
844 N.getTag() == dwarf::DW_TAG_enumeration_type ||
845 N.getTag() == dwarf::DW_TAG_class_type,
848 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
849 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
852 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
853 "invalid composite elements", &N, N.getRawElements());
854 Assert(isTypeRef(N, N.getRawVTableHolder()), "invalid vtable holder", &N,
855 N.getRawVTableHolder());
856 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
857 "invalid composite elements", &N, N.getRawElements());
858 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
860 if (auto *Params = N.getRawTemplateParams())
861 visitTemplateParams(N, *Params);
863 if (N.getTag() == dwarf::DW_TAG_class_type ||
864 N.getTag() == dwarf::DW_TAG_union_type) {
865 Assert(N.getFile() && !N.getFile()->getFilename().empty(),
866 "class/union requires a filename", &N, N.getFile());
870 void Verifier::visitDISubroutineType(const DISubroutineType &N) {
871 Assert(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
872 if (auto *Types = N.getRawTypeArray()) {
873 Assert(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
874 for (Metadata *Ty : N.getTypeArray()->operands()) {
875 Assert(isTypeRef(N, Ty), "invalid subroutine type ref", &N, Types, Ty);
878 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
882 void Verifier::visitDIFile(const DIFile &N) {
883 Assert(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
886 void Verifier::visitDICompileUnit(const DICompileUnit &N) {
887 Assert(N.isDistinct(), "compile units must be distinct", &N);
888 Assert(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
890 // Don't bother verifying the compilation directory or producer string
891 // as those could be empty.
892 Assert(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
894 Assert(!N.getFile()->getFilename().empty(), "invalid filename", &N,
897 if (auto *Array = N.getRawEnumTypes()) {
898 Assert(isa<MDTuple>(Array), "invalid enum list", &N, Array);
899 for (Metadata *Op : N.getEnumTypes()->operands()) {
900 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
901 Assert(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
902 "invalid enum type", &N, N.getEnumTypes(), Op);
905 if (auto *Array = N.getRawRetainedTypes()) {
906 Assert(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
907 for (Metadata *Op : N.getRetainedTypes()->operands()) {
908 Assert(Op && isa<DIType>(Op), "invalid retained type", &N, Op);
911 if (auto *Array = N.getRawSubprograms()) {
912 Assert(isa<MDTuple>(Array), "invalid subprogram list", &N, Array);
913 for (Metadata *Op : N.getSubprograms()->operands()) {
914 Assert(Op && isa<DISubprogram>(Op), "invalid subprogram ref", &N, Op);
917 if (auto *Array = N.getRawGlobalVariables()) {
918 Assert(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
919 for (Metadata *Op : N.getGlobalVariables()->operands()) {
920 Assert(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref", &N,
924 if (auto *Array = N.getRawImportedEntities()) {
925 Assert(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
926 for (Metadata *Op : N.getImportedEntities()->operands()) {
927 Assert(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref", &N,
933 void Verifier::visitDISubprogram(const DISubprogram &N) {
934 Assert(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
935 Assert(isScopeRef(N, N.getRawScope()), "invalid scope", &N, N.getRawScope());
936 if (auto *T = N.getRawType())
937 Assert(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
938 Assert(isTypeRef(N, N.getRawContainingType()), "invalid containing type", &N,
939 N.getRawContainingType());
940 if (auto *Params = N.getRawTemplateParams())
941 visitTemplateParams(N, *Params);
942 if (auto *S = N.getRawDeclaration()) {
943 Assert(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
944 "invalid subprogram declaration", &N, S);
946 if (auto *RawVars = N.getRawVariables()) {
947 auto *Vars = dyn_cast<MDTuple>(RawVars);
948 Assert(Vars, "invalid variable list", &N, RawVars);
949 for (Metadata *Op : Vars->operands()) {
950 Assert(Op && isa<DILocalVariable>(Op), "invalid local variable", &N, Vars,
954 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
957 if (N.isDefinition())
958 Assert(N.isDistinct(), "subprogram definitions must be distinct", &N);
961 void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
962 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
963 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
964 "invalid local scope", &N, N.getRawScope());
967 void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
968 visitDILexicalBlockBase(N);
970 Assert(N.getLine() || !N.getColumn(),
971 "cannot have column info without line info", &N);
974 void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
975 visitDILexicalBlockBase(N);
978 void Verifier::visitDINamespace(const DINamespace &N) {
979 Assert(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
980 if (auto *S = N.getRawScope())
981 Assert(isa<DIScope>(S), "invalid scope ref", &N, S);
984 void Verifier::visitDIModule(const DIModule &N) {
985 Assert(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
986 Assert(!N.getName().empty(), "anonymous module", &N);
989 void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
990 Assert(isTypeRef(N, N.getType()), "invalid type ref", &N, N.getType());
993 void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
994 visitDITemplateParameter(N);
996 Assert(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1000 void Verifier::visitDITemplateValueParameter(
1001 const DITemplateValueParameter &N) {
1002 visitDITemplateParameter(N);
1004 Assert(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1005 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1006 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1010 void Verifier::visitDIVariable(const DIVariable &N) {
1011 if (auto *S = N.getRawScope())
1012 Assert(isa<DIScope>(S), "invalid scope", &N, S);
1013 Assert(isTypeRef(N, N.getRawType()), "invalid type ref", &N, N.getRawType());
1014 if (auto *F = N.getRawFile())
1015 Assert(isa<DIFile>(F), "invalid file", &N, F);
1018 void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
1019 // Checks common to all variables.
1022 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1023 Assert(!N.getName().empty(), "missing global variable name", &N);
1024 if (auto *V = N.getRawVariable()) {
1025 Assert(isa<ConstantAsMetadata>(V) &&
1026 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
1027 "invalid global varaible ref", &N, V);
1029 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
1030 Assert(isa<DIDerivedType>(Member), "invalid static data member declaration",
1035 void Verifier::visitDILocalVariable(const DILocalVariable &N) {
1036 // Checks common to all variables.
1039 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1040 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1041 "local variable requires a valid scope", &N, N.getRawScope());
1044 void Verifier::visitDIExpression(const DIExpression &N) {
1045 Assert(N.isValid(), "invalid expression", &N);
1048 void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
1049 Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
1050 if (auto *T = N.getRawType())
1051 Assert(isTypeRef(N, T), "invalid type ref", &N, T);
1052 if (auto *F = N.getRawFile())
1053 Assert(isa<DIFile>(F), "invalid file", &N, F);
1056 void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
1057 Assert(N.getTag() == dwarf::DW_TAG_imported_module ||
1058 N.getTag() == dwarf::DW_TAG_imported_declaration,
1060 if (auto *S = N.getRawScope())
1061 Assert(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1062 Assert(isDIRef(N, N.getEntity()), "invalid imported entity", &N,
1066 void Verifier::visitComdat(const Comdat &C) {
1067 // The Module is invalid if the GlobalValue has private linkage. Entities
1068 // with private linkage don't have entries in the symbol table.
1069 if (const GlobalValue *GV = M->getNamedValue(C.getName()))
1070 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1074 void Verifier::visitModuleIdents(const Module &M) {
1075 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1079 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1080 // Scan each llvm.ident entry and make sure that this requirement is met.
1081 for (unsigned i = 0, e = Idents->getNumOperands(); i != e; ++i) {
1082 const MDNode *N = Idents->getOperand(i);
1083 Assert(N->getNumOperands() == 1,
1084 "incorrect number of operands in llvm.ident metadata", N);
1085 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1086 ("invalid value for llvm.ident metadata entry operand"
1087 "(the operand should be a string)"),
1092 void Verifier::visitModuleFlags(const Module &M) {
1093 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1096 // Scan each flag, and track the flags and requirements.
1097 DenseMap<const MDString*, const MDNode*> SeenIDs;
1098 SmallVector<const MDNode*, 16> Requirements;
1099 for (unsigned I = 0, E = Flags->getNumOperands(); I != E; ++I) {
1100 visitModuleFlag(Flags->getOperand(I), SeenIDs, Requirements);
1103 // Validate that the requirements in the module are valid.
1104 for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
1105 const MDNode *Requirement = Requirements[I];
1106 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
1107 const Metadata *ReqValue = Requirement->getOperand(1);
1109 const MDNode *Op = SeenIDs.lookup(Flag);
1111 CheckFailed("invalid requirement on flag, flag is not present in module",
1116 if (Op->getOperand(2) != ReqValue) {
1117 CheckFailed(("invalid requirement on flag, "
1118 "flag does not have the required value"),
1126 Verifier::visitModuleFlag(const MDNode *Op,
1127 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1128 SmallVectorImpl<const MDNode *> &Requirements) {
1129 // Each module flag should have three arguments, the merge behavior (a
1130 // constant int), the flag ID (an MDString), and the value.
1131 Assert(Op->getNumOperands() == 3,
1132 "incorrect number of operands in module flag", Op);
1133 Module::ModFlagBehavior MFB;
1134 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
1136 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
1137 "invalid behavior operand in module flag (expected constant integer)",
1140 "invalid behavior operand in module flag (unexpected constant)",
1143 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
1144 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1147 // Sanity check the values for behaviors with additional requirements.
1150 case Module::Warning:
1151 case Module::Override:
1152 // These behavior types accept any value.
1155 case Module::Require: {
1156 // The value should itself be an MDNode with two operands, a flag ID (an
1157 // MDString), and a value.
1158 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
1159 Assert(Value && Value->getNumOperands() == 2,
1160 "invalid value for 'require' module flag (expected metadata pair)",
1162 Assert(isa<MDString>(Value->getOperand(0)),
1163 ("invalid value for 'require' module flag "
1164 "(first value operand should be a string)"),
1165 Value->getOperand(0));
1167 // Append it to the list of requirements, to check once all module flags are
1169 Requirements.push_back(Value);
1173 case Module::Append:
1174 case Module::AppendUnique: {
1175 // These behavior types require the operand be an MDNode.
1176 Assert(isa<MDNode>(Op->getOperand(2)),
1177 "invalid value for 'append'-type module flag "
1178 "(expected a metadata node)",
1184 // Unless this is a "requires" flag, check the ID is unique.
1185 if (MFB != Module::Require) {
1186 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
1188 "module flag identifiers must be unique (or of 'require' type)", ID);
1192 void Verifier::VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
1193 bool isFunction, const Value *V) {
1194 unsigned Slot = ~0U;
1195 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1196 if (Attrs.getSlotIndex(I) == Idx) {
1201 assert(Slot != ~0U && "Attribute set inconsistency!");
1203 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1205 if (I->isStringAttribute())
1208 if (I->getKindAsEnum() == Attribute::NoReturn ||
1209 I->getKindAsEnum() == Attribute::NoUnwind ||
1210 I->getKindAsEnum() == Attribute::NoInline ||
1211 I->getKindAsEnum() == Attribute::AlwaysInline ||
1212 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1213 I->getKindAsEnum() == Attribute::StackProtect ||
1214 I->getKindAsEnum() == Attribute::StackProtectReq ||
1215 I->getKindAsEnum() == Attribute::StackProtectStrong ||
1216 I->getKindAsEnum() == Attribute::SafeStack ||
1217 I->getKindAsEnum() == Attribute::NoRedZone ||
1218 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1219 I->getKindAsEnum() == Attribute::Naked ||
1220 I->getKindAsEnum() == Attribute::InlineHint ||
1221 I->getKindAsEnum() == Attribute::StackAlignment ||
1222 I->getKindAsEnum() == Attribute::UWTable ||
1223 I->getKindAsEnum() == Attribute::NonLazyBind ||
1224 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1225 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1226 I->getKindAsEnum() == Attribute::SanitizeThread ||
1227 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1228 I->getKindAsEnum() == Attribute::MinSize ||
1229 I->getKindAsEnum() == Attribute::NoDuplicate ||
1230 I->getKindAsEnum() == Attribute::Builtin ||
1231 I->getKindAsEnum() == Attribute::NoBuiltin ||
1232 I->getKindAsEnum() == Attribute::Cold ||
1233 I->getKindAsEnum() == Attribute::OptimizeNone ||
1234 I->getKindAsEnum() == Attribute::JumpTable ||
1235 I->getKindAsEnum() == Attribute::Convergent ||
1236 I->getKindAsEnum() == Attribute::ArgMemOnly) {
1238 CheckFailed("Attribute '" + I->getAsString() +
1239 "' only applies to functions!", V);
1242 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
1243 I->getKindAsEnum() == Attribute::ReadNone) {
1245 CheckFailed("Attribute '" + I->getAsString() +
1246 "' does not apply to function returns");
1249 } else if (isFunction) {
1250 CheckFailed("Attribute '" + I->getAsString() +
1251 "' does not apply to functions!", V);
1257 // VerifyParameterAttrs - Check the given attributes for an argument or return
1258 // value of the specified type. The value V is printed in error messages.
1259 void Verifier::VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
1260 bool isReturnValue, const Value *V) {
1261 if (!Attrs.hasAttributes(Idx))
1264 VerifyAttributeTypes(Attrs, Idx, false, V);
1267 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1268 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1269 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1270 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1271 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
1272 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1273 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', and "
1274 "'returned' do not apply to return values!",
1277 // Check for mutually incompatible attributes. Only inreg is compatible with
1279 unsigned AttrCount = 0;
1280 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1281 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1282 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1283 Attrs.hasAttribute(Idx, Attribute::InReg);
1284 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
1285 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1286 "and 'sret' are incompatible!",
1289 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1290 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1292 "'inalloca and readonly' are incompatible!",
1295 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1296 Attrs.hasAttribute(Idx, Attribute::Returned)),
1298 "'sret and returned' are incompatible!",
1301 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1302 Attrs.hasAttribute(Idx, Attribute::SExt)),
1304 "'zeroext and signext' are incompatible!",
1307 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1308 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1310 "'readnone and readonly' are incompatible!",
1313 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1314 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1316 "'noinline and alwaysinline' are incompatible!",
1319 Assert(!AttrBuilder(Attrs, Idx)
1320 .overlaps(AttributeFuncs::typeIncompatible(Ty)),
1321 "Wrong types for attribute: " +
1322 AttributeSet::get(*Context, Idx,
1323 AttributeFuncs::typeIncompatible(Ty)).getAsString(Idx),
1326 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
1327 SmallPtrSet<Type*, 4> Visited;
1328 if (!PTy->getElementType()->isSized(&Visited)) {
1329 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1330 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1331 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1335 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1336 "Attribute 'byval' only applies to parameters with pointer type!",
1341 // VerifyFunctionAttrs - Check parameter attributes against a function type.
1342 // The value V is printed in error messages.
1343 void Verifier::VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
1345 if (Attrs.isEmpty())
1348 bool SawNest = false;
1349 bool SawReturned = false;
1350 bool SawSRet = false;
1352 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
1353 unsigned Idx = Attrs.getSlotIndex(i);
1357 Ty = FT->getReturnType();
1358 else if (Idx-1 < FT->getNumParams())
1359 Ty = FT->getParamType(Idx-1);
1361 break; // VarArgs attributes, verified elsewhere.
1363 VerifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
1368 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
1369 Assert(!SawNest, "More than one parameter has attribute nest!", V);
1373 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
1374 Assert(!SawReturned, "More than one parameter has attribute returned!",
1376 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1378 "argument and return types for 'returned' attribute",
1383 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
1384 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1385 Assert(Idx == 1 || Idx == 2,
1386 "Attribute 'sret' is not on first or second parameter!", V);
1390 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
1391 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1396 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1399 VerifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
1402 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1403 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1404 "Attributes 'readnone and readonly' are incompatible!", V);
1407 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1408 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1409 Attribute::AlwaysInline)),
1410 "Attributes 'noinline and alwaysinline' are incompatible!", V);
1412 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1413 Attribute::OptimizeNone)) {
1414 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1415 "Attribute 'optnone' requires 'noinline'!", V);
1417 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1418 Attribute::OptimizeForSize),
1419 "Attributes 'optsize and optnone' are incompatible!", V);
1421 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1422 "Attributes 'minsize and optnone' are incompatible!", V);
1425 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1426 Attribute::JumpTable)) {
1427 const GlobalValue *GV = cast<GlobalValue>(V);
1428 Assert(GV->hasUnnamedAddr(),
1429 "Attribute 'jumptable' requires 'unnamed_addr'", V);
1433 void Verifier::VerifyFunctionMetadata(
1434 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs) {
1438 for (unsigned i = 0; i < MDs.size(); i++) {
1439 if (MDs[i].first == LLVMContext::MD_prof) {
1440 MDNode *MD = MDs[i].second;
1441 Assert(MD->getNumOperands() == 2,
1442 "!prof annotations should have exactly 2 operands", MD);
1444 // Check first operand.
1445 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1447 Assert(isa<MDString>(MD->getOperand(0)),
1448 "expected string with name of the !prof annotation", MD);
1449 MDString *MDS = cast<MDString>(MD->getOperand(0));
1450 StringRef ProfName = MDS->getString();
1451 Assert(ProfName.equals("function_entry_count"),
1452 "first operand should be 'function_entry_count'", MD);
1454 // Check second operand.
1455 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1457 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1458 "expected integer argument to function_entry_count", MD);
1463 void Verifier::VerifyConstantExprBitcastType(const ConstantExpr *CE) {
1464 if (CE->getOpcode() != Instruction::BitCast)
1467 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1469 "Invalid bitcast", CE);
1472 bool Verifier::VerifyAttributeCount(AttributeSet Attrs, unsigned Params) {
1473 if (Attrs.getNumSlots() == 0)
1476 unsigned LastSlot = Attrs.getNumSlots() - 1;
1477 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
1478 if (LastIndex <= Params
1479 || (LastIndex == AttributeSet::FunctionIndex
1480 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
1486 /// \brief Verify that statepoint intrinsic is well formed.
1487 void Verifier::VerifyStatepoint(ImmutableCallSite CS) {
1488 assert(CS.getCalledFunction() &&
1489 CS.getCalledFunction()->getIntrinsicID() ==
1490 Intrinsic::experimental_gc_statepoint);
1492 const Instruction &CI = *CS.getInstruction();
1494 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1495 !CS.onlyAccessesArgMemory(),
1496 "gc.statepoint must read and write all memory to preserve "
1497 "reordering restrictions required by safepoint semantics",
1500 const Value *IDV = CS.getArgument(0);
1501 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1504 const Value *NumPatchBytesV = CS.getArgument(1);
1505 Assert(isa<ConstantInt>(NumPatchBytesV),
1506 "gc.statepoint number of patchable bytes must be a constant integer",
1508 const int64_t NumPatchBytes =
1509 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1510 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1511 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1515 const Value *Target = CS.getArgument(2);
1516 auto *PT = dyn_cast<PointerType>(Target->getType());
1517 Assert(PT && PT->getElementType()->isFunctionTy(),
1518 "gc.statepoint callee must be of function pointer type", &CI, Target);
1519 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
1521 const Value *NumCallArgsV = CS.getArgument(3);
1522 Assert(isa<ConstantInt>(NumCallArgsV),
1523 "gc.statepoint number of arguments to underlying call "
1524 "must be constant integer",
1526 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
1527 Assert(NumCallArgs >= 0,
1528 "gc.statepoint number of arguments to underlying call "
1531 const int NumParams = (int)TargetFuncType->getNumParams();
1532 if (TargetFuncType->isVarArg()) {
1533 Assert(NumCallArgs >= NumParams,
1534 "gc.statepoint mismatch in number of vararg call args", &CI);
1536 // TODO: Remove this limitation
1537 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1538 "gc.statepoint doesn't support wrapping non-void "
1539 "vararg functions yet",
1542 Assert(NumCallArgs == NumParams,
1543 "gc.statepoint mismatch in number of call args", &CI);
1545 const Value *FlagsV = CS.getArgument(4);
1546 Assert(isa<ConstantInt>(FlagsV),
1547 "gc.statepoint flags must be constant integer", &CI);
1548 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1549 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1550 "unknown flag used in gc.statepoint flags argument", &CI);
1552 // Verify that the types of the call parameter arguments match
1553 // the type of the wrapped callee.
1554 for (int i = 0; i < NumParams; i++) {
1555 Type *ParamType = TargetFuncType->getParamType(i);
1556 Type *ArgType = CS.getArgument(5 + i)->getType();
1557 Assert(ArgType == ParamType,
1558 "gc.statepoint call argument does not match wrapped "
1563 const int EndCallArgsInx = 4 + NumCallArgs;
1565 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1566 Assert(isa<ConstantInt>(NumTransitionArgsV),
1567 "gc.statepoint number of transition arguments "
1568 "must be constant integer",
1570 const int NumTransitionArgs =
1571 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1572 Assert(NumTransitionArgs >= 0,
1573 "gc.statepoint number of transition arguments must be positive", &CI);
1574 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1576 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
1577 Assert(isa<ConstantInt>(NumDeoptArgsV),
1578 "gc.statepoint number of deoptimization arguments "
1579 "must be constant integer",
1581 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
1582 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1586 const int ExpectedNumArgs =
1587 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
1588 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
1589 "gc.statepoint too few arguments according to length fields", &CI);
1591 // Check that the only uses of this gc.statepoint are gc.result or
1592 // gc.relocate calls which are tied to this statepoint and thus part
1593 // of the same statepoint sequence
1594 for (const User *U : CI.users()) {
1595 const CallInst *Call = dyn_cast<const CallInst>(U);
1596 Assert(Call, "illegal use of statepoint token", &CI, U);
1597 if (!Call) continue;
1598 Assert(isGCRelocate(Call) || isGCResult(Call),
1599 "gc.result or gc.relocate are the only value uses"
1600 "of a gc.statepoint",
1602 if (isGCResult(Call)) {
1603 Assert(Call->getArgOperand(0) == &CI,
1604 "gc.result connected to wrong gc.statepoint", &CI, Call);
1605 } else if (isGCRelocate(Call)) {
1606 Assert(Call->getArgOperand(0) == &CI,
1607 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
1611 // Note: It is legal for a single derived pointer to be listed multiple
1612 // times. It's non-optimal, but it is legal. It can also happen after
1613 // insertion if we strip a bitcast away.
1614 // Note: It is really tempting to check that each base is relocated and
1615 // that a derived pointer is never reused as a base pointer. This turns
1616 // out to be problematic since optimizations run after safepoint insertion
1617 // can recognize equality properties that the insertion logic doesn't know
1618 // about. See example statepoint.ll in the verifier subdirectory
1621 void Verifier::verifyFrameRecoverIndices() {
1622 for (auto &Counts : FrameEscapeInfo) {
1623 Function *F = Counts.first;
1624 unsigned EscapedObjectCount = Counts.second.first;
1625 unsigned MaxRecoveredIndex = Counts.second.second;
1626 Assert(MaxRecoveredIndex <= EscapedObjectCount,
1627 "all indices passed to llvm.localrecover must be less than the "
1628 "number of arguments passed ot llvm.localescape in the parent "
1634 // visitFunction - Verify that a function is ok.
1636 void Verifier::visitFunction(const Function &F) {
1637 // Check function arguments.
1638 FunctionType *FT = F.getFunctionType();
1639 unsigned NumArgs = F.arg_size();
1641 Assert(Context == &F.getContext(),
1642 "Function context does not match Module context!", &F);
1644 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1645 Assert(FT->getNumParams() == NumArgs,
1646 "# formal arguments must match # of arguments for function type!", &F,
1648 Assert(F.getReturnType()->isFirstClassType() ||
1649 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1650 "Functions cannot return aggregate values!", &F);
1652 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1653 "Invalid struct return type!", &F);
1655 AttributeSet Attrs = F.getAttributes();
1657 Assert(VerifyAttributeCount(Attrs, FT->getNumParams()),
1658 "Attribute after last parameter!", &F);
1660 // Check function attributes.
1661 VerifyFunctionAttrs(FT, Attrs, &F);
1663 // On function declarations/definitions, we do not support the builtin
1664 // attribute. We do not check this in VerifyFunctionAttrs since that is
1665 // checking for Attributes that can/can not ever be on functions.
1666 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1667 "Attribute 'builtin' can only be applied to a callsite.", &F);
1669 // Check that this function meets the restrictions on this calling convention.
1670 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1671 // restrictions can be lifted.
1672 switch (F.getCallingConv()) {
1674 case CallingConv::C:
1676 case CallingConv::Fast:
1677 case CallingConv::Cold:
1678 case CallingConv::Intel_OCL_BI:
1679 case CallingConv::PTX_Kernel:
1680 case CallingConv::PTX_Device:
1681 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1682 "perfect forwarding!",
1687 bool isLLVMdotName = F.getName().size() >= 5 &&
1688 F.getName().substr(0, 5) == "llvm.";
1690 // Check that the argument values match the function type for this function...
1692 for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E;
1694 Assert(I->getType() == FT->getParamType(i),
1695 "Argument value does not match function argument type!", I,
1696 FT->getParamType(i));
1697 Assert(I->getType()->isFirstClassType(),
1698 "Function arguments must have first-class types!", I);
1699 if (!isLLVMdotName) {
1700 Assert(!I->getType()->isMetadataTy(),
1701 "Function takes metadata but isn't an intrinsic", I, &F);
1702 Assert(!I->getType()->isTokenTy(),
1703 "Function takes token but isn't an intrinsic", I, &F);
1708 Assert(!F.getReturnType()->isTokenTy(),
1709 "Functions returns a token but isn't an intrinsic", &F);
1711 // Get the function metadata attachments.
1712 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1713 F.getAllMetadata(MDs);
1714 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
1715 VerifyFunctionMetadata(MDs);
1717 if (F.isMaterializable()) {
1718 // Function has a body somewhere we can't see.
1719 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
1720 MDs.empty() ? nullptr : MDs.front().second);
1721 } else if (F.isDeclaration()) {
1722 Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1723 "invalid linkage type for function declaration", &F);
1724 Assert(MDs.empty(), "function without a body cannot have metadata", &F,
1725 MDs.empty() ? nullptr : MDs.front().second);
1726 Assert(!F.hasPersonalityFn(),
1727 "Function declaration shouldn't have a personality routine", &F);
1729 // Verify that this function (which has a body) is not named "llvm.*". It
1730 // is not legal to define intrinsics.
1731 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
1733 // Check the entry node
1734 const BasicBlock *Entry = &F.getEntryBlock();
1735 Assert(pred_empty(Entry),
1736 "Entry block to function must not have predecessors!", Entry);
1738 // The address of the entry block cannot be taken, unless it is dead.
1739 if (Entry->hasAddressTaken()) {
1740 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1741 "blockaddress may not be used with the entry block!", Entry);
1744 // Visit metadata attachments.
1745 for (const auto &I : MDs) {
1746 // Verify that the attachment is legal.
1750 case LLVMContext::MD_dbg:
1751 Assert(isa<DISubprogram>(I.second),
1752 "function !dbg attachment must be a subprogram", &F, I.second);
1756 // Verify the metadata itself.
1757 visitMDNode(*I.second);
1761 // If this function is actually an intrinsic, verify that it is only used in
1762 // direct call/invokes, never having its "address taken".
1763 if (F.getIntrinsicID()) {
1765 if (F.hasAddressTaken(&U))
1766 Assert(0, "Invalid user of intrinsic instruction!", U);
1769 Assert(!F.hasDLLImportStorageClass() ||
1770 (F.isDeclaration() && F.hasExternalLinkage()) ||
1771 F.hasAvailableExternallyLinkage(),
1772 "Function is marked as dllimport, but not external.", &F);
1774 auto *N = F.getSubprogram();
1778 // Check that all !dbg attachments lead to back to N (or, at least, another
1779 // subprogram that describes the same function).
1781 // FIXME: Check this incrementally while visiting !dbg attachments.
1782 // FIXME: Only check when N is the canonical subprogram for F.
1783 SmallPtrSet<const MDNode *, 32> Seen;
1785 for (auto &I : BB) {
1786 // Be careful about using DILocation here since we might be dealing with
1787 // broken code (this is the Verifier after all).
1789 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
1792 if (!Seen.insert(DL).second)
1795 DILocalScope *Scope = DL->getInlinedAtScope();
1796 if (Scope && !Seen.insert(Scope).second)
1799 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
1800 if (SP && !Seen.insert(SP).second)
1803 // FIXME: Once N is canonical, check "SP == &N".
1804 Assert(SP->describes(&F),
1805 "!dbg attachment points at wrong subprogram for function", N, &F,
1810 // verifyBasicBlock - Verify that a basic block is well formed...
1812 void Verifier::visitBasicBlock(BasicBlock &BB) {
1813 InstsInThisBlock.clear();
1815 // Ensure that basic blocks have terminators!
1816 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
1818 // Check constraints that this basic block imposes on all of the PHI nodes in
1820 if (isa<PHINode>(BB.front())) {
1821 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
1822 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
1823 std::sort(Preds.begin(), Preds.end());
1825 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
1826 // Ensure that PHI nodes have at least one entry!
1827 Assert(PN->getNumIncomingValues() != 0,
1828 "PHI nodes must have at least one entry. If the block is dead, "
1829 "the PHI should be removed!",
1831 Assert(PN->getNumIncomingValues() == Preds.size(),
1832 "PHINode should have one entry for each predecessor of its "
1833 "parent basic block!",
1836 // Get and sort all incoming values in the PHI node...
1838 Values.reserve(PN->getNumIncomingValues());
1839 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1840 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
1841 PN->getIncomingValue(i)));
1842 std::sort(Values.begin(), Values.end());
1844 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
1845 // Check to make sure that if there is more than one entry for a
1846 // particular basic block in this PHI node, that the incoming values are
1849 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
1850 Values[i].second == Values[i - 1].second,
1851 "PHI node has multiple entries for the same basic block with "
1852 "different incoming values!",
1853 PN, Values[i].first, Values[i].second, Values[i - 1].second);
1855 // Check to make sure that the predecessors and PHI node entries are
1857 Assert(Values[i].first == Preds[i],
1858 "PHI node entries do not match predecessors!", PN,
1859 Values[i].first, Preds[i]);
1864 // Check that all instructions have their parent pointers set up correctly.
1867 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
1871 void Verifier::visitTerminatorInst(TerminatorInst &I) {
1872 // Ensure that terminators only exist at the end of the basic block.
1873 Assert(&I == I.getParent()->getTerminator(),
1874 "Terminator found in the middle of a basic block!", I.getParent());
1875 visitInstruction(I);
1878 void Verifier::visitBranchInst(BranchInst &BI) {
1879 if (BI.isConditional()) {
1880 Assert(BI.getCondition()->getType()->isIntegerTy(1),
1881 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
1883 visitTerminatorInst(BI);
1886 void Verifier::visitReturnInst(ReturnInst &RI) {
1887 Function *F = RI.getParent()->getParent();
1888 unsigned N = RI.getNumOperands();
1889 if (F->getReturnType()->isVoidTy())
1891 "Found return instr that returns non-void in Function of void "
1893 &RI, F->getReturnType());
1895 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
1896 "Function return type does not match operand "
1897 "type of return inst!",
1898 &RI, F->getReturnType());
1900 // Check to make sure that the return value has necessary properties for
1902 visitTerminatorInst(RI);
1905 void Verifier::visitSwitchInst(SwitchInst &SI) {
1906 // Check to make sure that all of the constants in the switch instruction
1907 // have the same type as the switched-on value.
1908 Type *SwitchTy = SI.getCondition()->getType();
1909 SmallPtrSet<ConstantInt*, 32> Constants;
1910 for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end(); i != e; ++i) {
1911 Assert(i.getCaseValue()->getType() == SwitchTy,
1912 "Switch constants must all be same type as switch value!", &SI);
1913 Assert(Constants.insert(i.getCaseValue()).second,
1914 "Duplicate integer as switch case", &SI, i.getCaseValue());
1917 visitTerminatorInst(SI);
1920 void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
1921 Assert(BI.getAddress()->getType()->isPointerTy(),
1922 "Indirectbr operand must have pointer type!", &BI);
1923 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
1924 Assert(BI.getDestination(i)->getType()->isLabelTy(),
1925 "Indirectbr destinations must all have pointer type!", &BI);
1927 visitTerminatorInst(BI);
1930 void Verifier::visitSelectInst(SelectInst &SI) {
1931 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
1933 "Invalid operands for select instruction!", &SI);
1935 Assert(SI.getTrueValue()->getType() == SI.getType(),
1936 "Select values must have same type as select instruction!", &SI);
1937 visitInstruction(SI);
1940 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
1941 /// a pass, if any exist, it's an error.
1943 void Verifier::visitUserOp1(Instruction &I) {
1944 Assert(0, "User-defined operators should not live outside of a pass!", &I);
1947 void Verifier::visitTruncInst(TruncInst &I) {
1948 // Get the source and destination types
1949 Type *SrcTy = I.getOperand(0)->getType();
1950 Type *DestTy = I.getType();
1952 // Get the size of the types in bits, we'll need this later
1953 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1954 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1956 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
1957 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
1958 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1959 "trunc source and destination must both be a vector or neither", &I);
1960 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
1962 visitInstruction(I);
1965 void Verifier::visitZExtInst(ZExtInst &I) {
1966 // Get the source and destination types
1967 Type *SrcTy = I.getOperand(0)->getType();
1968 Type *DestTy = I.getType();
1970 // Get the size of the types in bits, we'll need this later
1971 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
1972 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
1973 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1974 "zext source and destination must both be a vector or neither", &I);
1975 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1976 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1978 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
1980 visitInstruction(I);
1983 void Verifier::visitSExtInst(SExtInst &I) {
1984 // Get the source and destination types
1985 Type *SrcTy = I.getOperand(0)->getType();
1986 Type *DestTy = I.getType();
1988 // Get the size of the types in bits, we'll need this later
1989 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1990 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1992 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
1993 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
1994 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1995 "sext source and destination must both be a vector or neither", &I);
1996 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
1998 visitInstruction(I);
2001 void Verifier::visitFPTruncInst(FPTruncInst &I) {
2002 // Get the source and destination types
2003 Type *SrcTy = I.getOperand(0)->getType();
2004 Type *DestTy = I.getType();
2005 // Get the size of the types in bits, we'll need this later
2006 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2007 unsigned DestBitSize = DestTy->getScalarSizeInBits();
2009 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2010 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2011 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2012 "fptrunc source and destination must both be a vector or neither", &I);
2013 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
2015 visitInstruction(I);
2018 void Verifier::visitFPExtInst(FPExtInst &I) {
2019 // Get the source and destination types
2020 Type *SrcTy = I.getOperand(0)->getType();
2021 Type *DestTy = I.getType();
2023 // Get the size of the types in bits, we'll need this later
2024 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2025 unsigned DestBitSize = DestTy->getScalarSizeInBits();
2027 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2028 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2029 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2030 "fpext source and destination must both be a vector or neither", &I);
2031 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
2033 visitInstruction(I);
2036 void Verifier::visitUIToFPInst(UIToFPInst &I) {
2037 // Get the source and destination types
2038 Type *SrcTy = I.getOperand(0)->getType();
2039 Type *DestTy = I.getType();
2041 bool SrcVec = SrcTy->isVectorTy();
2042 bool DstVec = DestTy->isVectorTy();
2044 Assert(SrcVec == DstVec,
2045 "UIToFP source and dest must both be vector or scalar", &I);
2046 Assert(SrcTy->isIntOrIntVectorTy(),
2047 "UIToFP source must be integer or integer vector", &I);
2048 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2051 if (SrcVec && DstVec)
2052 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2053 cast<VectorType>(DestTy)->getNumElements(),
2054 "UIToFP source and dest vector length mismatch", &I);
2056 visitInstruction(I);
2059 void Verifier::visitSIToFPInst(SIToFPInst &I) {
2060 // Get the source and destination types
2061 Type *SrcTy = I.getOperand(0)->getType();
2062 Type *DestTy = I.getType();
2064 bool SrcVec = SrcTy->isVectorTy();
2065 bool DstVec = DestTy->isVectorTy();
2067 Assert(SrcVec == DstVec,
2068 "SIToFP source and dest must both be vector or scalar", &I);
2069 Assert(SrcTy->isIntOrIntVectorTy(),
2070 "SIToFP source must be integer or integer vector", &I);
2071 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2074 if (SrcVec && DstVec)
2075 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2076 cast<VectorType>(DestTy)->getNumElements(),
2077 "SIToFP source and dest vector length mismatch", &I);
2079 visitInstruction(I);
2082 void Verifier::visitFPToUIInst(FPToUIInst &I) {
2083 // Get the source and destination types
2084 Type *SrcTy = I.getOperand(0)->getType();
2085 Type *DestTy = I.getType();
2087 bool SrcVec = SrcTy->isVectorTy();
2088 bool DstVec = DestTy->isVectorTy();
2090 Assert(SrcVec == DstVec,
2091 "FPToUI source and dest must both be vector or scalar", &I);
2092 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2094 Assert(DestTy->isIntOrIntVectorTy(),
2095 "FPToUI result must be integer or integer vector", &I);
2097 if (SrcVec && DstVec)
2098 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2099 cast<VectorType>(DestTy)->getNumElements(),
2100 "FPToUI source and dest vector length mismatch", &I);
2102 visitInstruction(I);
2105 void Verifier::visitFPToSIInst(FPToSIInst &I) {
2106 // Get the source and destination types
2107 Type *SrcTy = I.getOperand(0)->getType();
2108 Type *DestTy = I.getType();
2110 bool SrcVec = SrcTy->isVectorTy();
2111 bool DstVec = DestTy->isVectorTy();
2113 Assert(SrcVec == DstVec,
2114 "FPToSI source and dest must both be vector or scalar", &I);
2115 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2117 Assert(DestTy->isIntOrIntVectorTy(),
2118 "FPToSI result must be integer or integer vector", &I);
2120 if (SrcVec && DstVec)
2121 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2122 cast<VectorType>(DestTy)->getNumElements(),
2123 "FPToSI source and dest vector length mismatch", &I);
2125 visitInstruction(I);
2128 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2129 // Get the source and destination types
2130 Type *SrcTy = I.getOperand(0)->getType();
2131 Type *DestTy = I.getType();
2133 Assert(SrcTy->getScalarType()->isPointerTy(),
2134 "PtrToInt source must be pointer", &I);
2135 Assert(DestTy->getScalarType()->isIntegerTy(),
2136 "PtrToInt result must be integral", &I);
2137 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2140 if (SrcTy->isVectorTy()) {
2141 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2142 VectorType *VDest = dyn_cast<VectorType>(DestTy);
2143 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2144 "PtrToInt Vector width mismatch", &I);
2147 visitInstruction(I);
2150 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2151 // Get the source and destination types
2152 Type *SrcTy = I.getOperand(0)->getType();
2153 Type *DestTy = I.getType();
2155 Assert(SrcTy->getScalarType()->isIntegerTy(),
2156 "IntToPtr source must be an integral", &I);
2157 Assert(DestTy->getScalarType()->isPointerTy(),
2158 "IntToPtr result must be a pointer", &I);
2159 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2161 if (SrcTy->isVectorTy()) {
2162 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2163 VectorType *VDest = dyn_cast<VectorType>(DestTy);
2164 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2165 "IntToPtr Vector width mismatch", &I);
2167 visitInstruction(I);
2170 void Verifier::visitBitCastInst(BitCastInst &I) {
2172 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2173 "Invalid bitcast", &I);
2174 visitInstruction(I);
2177 void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2178 Type *SrcTy = I.getOperand(0)->getType();
2179 Type *DestTy = I.getType();
2181 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2183 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2185 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2186 "AddrSpaceCast must be between different address spaces", &I);
2187 if (SrcTy->isVectorTy())
2188 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2189 "AddrSpaceCast vector pointer number of elements mismatch", &I);
2190 visitInstruction(I);
2193 /// visitPHINode - Ensure that a PHI node is well formed.
2195 void Verifier::visitPHINode(PHINode &PN) {
2196 // Ensure that the PHI nodes are all grouped together at the top of the block.
2197 // This can be tested by checking whether the instruction before this is
2198 // either nonexistent (because this is begin()) or is a PHI node. If not,
2199 // then there is some other instruction before a PHI.
2200 Assert(&PN == &PN.getParent()->front() ||
2201 isa<PHINode>(--BasicBlock::iterator(&PN)),
2202 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
2204 // Check that a PHI doesn't yield a Token.
2205 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2207 // Check that all of the values of the PHI node have the same type as the
2208 // result, and that the incoming blocks are really basic blocks.
2209 for (Value *IncValue : PN.incoming_values()) {
2210 Assert(PN.getType() == IncValue->getType(),
2211 "PHI node operands are not the same type as the result!", &PN);
2214 // All other PHI node constraints are checked in the visitBasicBlock method.
2216 visitInstruction(PN);
2219 void Verifier::VerifyCallSite(CallSite CS) {
2220 Instruction *I = CS.getInstruction();
2222 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2223 "Called function must be a pointer!", I);
2224 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
2226 Assert(FPTy->getElementType()->isFunctionTy(),
2227 "Called function is not pointer to function type!", I);
2229 Assert(FPTy->getElementType() == CS.getFunctionType(),
2230 "Called function is not the same type as the call!", I);
2232 FunctionType *FTy = CS.getFunctionType();
2234 // Verify that the correct number of arguments are being passed
2235 if (FTy->isVarArg())
2236 Assert(CS.arg_size() >= FTy->getNumParams(),
2237 "Called function requires more parameters than were provided!", I);
2239 Assert(CS.arg_size() == FTy->getNumParams(),
2240 "Incorrect number of arguments passed to called function!", I);
2242 // Verify that all arguments to the call match the function type.
2243 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2244 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2245 "Call parameter type does not match function signature!",
2246 CS.getArgument(i), FTy->getParamType(i), I);
2248 AttributeSet Attrs = CS.getAttributes();
2250 Assert(VerifyAttributeCount(Attrs, CS.arg_size()),
2251 "Attribute after last parameter!", I);
2253 // Verify call attributes.
2254 VerifyFunctionAttrs(FTy, Attrs, I);
2256 // Conservatively check the inalloca argument.
2257 // We have a bug if we can find that there is an underlying alloca without
2259 if (CS.hasInAllocaArgument()) {
2260 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2261 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
2262 Assert(AI->isUsedWithInAlloca(),
2263 "inalloca argument for call has mismatched alloca", AI, I);
2266 if (FTy->isVarArg()) {
2267 // FIXME? is 'nest' even legal here?
2268 bool SawNest = false;
2269 bool SawReturned = false;
2271 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2272 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2274 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2278 // Check attributes on the varargs part.
2279 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
2280 Type *Ty = CS.getArgument(Idx-1)->getType();
2281 VerifyParameterAttrs(Attrs, Idx, Ty, false, I);
2283 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
2284 Assert(!SawNest, "More than one parameter has attribute nest!", I);
2288 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
2289 Assert(!SawReturned, "More than one parameter has attribute returned!",
2291 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2292 "Incompatible argument and return types for 'returned' "
2298 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2299 "Attribute 'sret' cannot be used for vararg call arguments!", I);
2301 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
2302 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
2306 // Verify that there's no metadata unless it's a direct call to an intrinsic.
2307 if (CS.getCalledFunction() == nullptr ||
2308 !CS.getCalledFunction()->getName().startswith("llvm.")) {
2309 for (Type *ParamTy : FTy->params()) {
2310 Assert(!ParamTy->isMetadataTy(),
2311 "Function has metadata parameter but isn't an intrinsic", I);
2312 Assert(!ParamTy->isTokenTy(),
2313 "Function has token parameter but isn't an intrinsic", I);
2317 // Verify that indirect calls don't return tokens.
2318 if (CS.getCalledFunction() == nullptr)
2319 Assert(!FTy->getReturnType()->isTokenTy(),
2320 "Return type cannot be token for indirect call!");
2322 if (Function *F = CS.getCalledFunction())
2323 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
2324 visitIntrinsicCallSite(ID, CS);
2326 visitInstruction(*I);
2329 /// Two types are "congruent" if they are identical, or if they are both pointer
2330 /// types with different pointee types and the same address space.
2331 static bool isTypeCongruent(Type *L, Type *R) {
2334 PointerType *PL = dyn_cast<PointerType>(L);
2335 PointerType *PR = dyn_cast<PointerType>(R);
2338 return PL->getAddressSpace() == PR->getAddressSpace();
2341 static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2342 static const Attribute::AttrKind ABIAttrs[] = {
2343 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
2344 Attribute::InReg, Attribute::Returned};
2346 for (auto AK : ABIAttrs) {
2347 if (Attrs.hasAttribute(I + 1, AK))
2348 Copy.addAttribute(AK);
2350 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2351 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2355 void Verifier::verifyMustTailCall(CallInst &CI) {
2356 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
2358 // - The caller and callee prototypes must match. Pointer types of
2359 // parameters or return types may differ in pointee type, but not
2361 Function *F = CI.getParent()->getParent();
2362 FunctionType *CallerTy = F->getFunctionType();
2363 FunctionType *CalleeTy = CI.getFunctionType();
2364 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2365 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2366 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2367 "cannot guarantee tail call due to mismatched varargs", &CI);
2368 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2369 "cannot guarantee tail call due to mismatched return types", &CI);
2370 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2372 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2373 "cannot guarantee tail call due to mismatched parameter types", &CI);
2376 // - The calling conventions of the caller and callee must match.
2377 Assert(F->getCallingConv() == CI.getCallingConv(),
2378 "cannot guarantee tail call due to mismatched calling conv", &CI);
2380 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2381 // returned, and inalloca, must match.
2382 AttributeSet CallerAttrs = F->getAttributes();
2383 AttributeSet CalleeAttrs = CI.getAttributes();
2384 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2385 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2386 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
2387 Assert(CallerABIAttrs == CalleeABIAttrs,
2388 "cannot guarantee tail call due to mismatched ABI impacting "
2389 "function attributes",
2390 &CI, CI.getOperand(I));
2393 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2394 // or a pointer bitcast followed by a ret instruction.
2395 // - The ret instruction must return the (possibly bitcasted) value
2396 // produced by the call or void.
2397 Value *RetVal = &CI;
2398 Instruction *Next = CI.getNextNode();
2400 // Handle the optional bitcast.
2401 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
2402 Assert(BI->getOperand(0) == RetVal,
2403 "bitcast following musttail call must use the call", BI);
2405 Next = BI->getNextNode();
2408 // Check the return.
2409 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
2410 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2412 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2413 "musttail call result must be returned", Ret);
2416 void Verifier::visitCallInst(CallInst &CI) {
2417 VerifyCallSite(&CI);
2419 if (CI.isMustTailCall())
2420 verifyMustTailCall(CI);
2423 void Verifier::visitInvokeInst(InvokeInst &II) {
2424 VerifyCallSite(&II);
2426 // Verify that the first non-PHI instruction of the unwind destination is an
2427 // exception handling instruction.
2429 II.getUnwindDest()->isEHPad(),
2430 "The unwind destination does not have an exception handling instruction!",
2433 visitTerminatorInst(II);
2436 /// visitBinaryOperator - Check that both arguments to the binary operator are
2437 /// of the same type!
2439 void Verifier::visitBinaryOperator(BinaryOperator &B) {
2440 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2441 "Both operands to a binary operator are not of the same type!", &B);
2443 switch (B.getOpcode()) {
2444 // Check that integer arithmetic operators are only used with
2445 // integral operands.
2446 case Instruction::Add:
2447 case Instruction::Sub:
2448 case Instruction::Mul:
2449 case Instruction::SDiv:
2450 case Instruction::UDiv:
2451 case Instruction::SRem:
2452 case Instruction::URem:
2453 Assert(B.getType()->isIntOrIntVectorTy(),
2454 "Integer arithmetic operators only work with integral types!", &B);
2455 Assert(B.getType() == B.getOperand(0)->getType(),
2456 "Integer arithmetic operators must have same type "
2457 "for operands and result!",
2460 // Check that floating-point arithmetic operators are only used with
2461 // floating-point operands.
2462 case Instruction::FAdd:
2463 case Instruction::FSub:
2464 case Instruction::FMul:
2465 case Instruction::FDiv:
2466 case Instruction::FRem:
2467 Assert(B.getType()->isFPOrFPVectorTy(),
2468 "Floating-point arithmetic operators only work with "
2469 "floating-point types!",
2471 Assert(B.getType() == B.getOperand(0)->getType(),
2472 "Floating-point arithmetic operators must have same type "
2473 "for operands and result!",
2476 // Check that logical operators are only used with integral operands.
2477 case Instruction::And:
2478 case Instruction::Or:
2479 case Instruction::Xor:
2480 Assert(B.getType()->isIntOrIntVectorTy(),
2481 "Logical operators only work with integral types!", &B);
2482 Assert(B.getType() == B.getOperand(0)->getType(),
2483 "Logical operators must have same type for operands and result!",
2486 case Instruction::Shl:
2487 case Instruction::LShr:
2488 case Instruction::AShr:
2489 Assert(B.getType()->isIntOrIntVectorTy(),
2490 "Shifts only work with integral types!", &B);
2491 Assert(B.getType() == B.getOperand(0)->getType(),
2492 "Shift return type must be same as operands!", &B);
2495 llvm_unreachable("Unknown BinaryOperator opcode!");
2498 visitInstruction(B);
2501 void Verifier::visitICmpInst(ICmpInst &IC) {
2502 // Check that the operands are the same type
2503 Type *Op0Ty = IC.getOperand(0)->getType();
2504 Type *Op1Ty = IC.getOperand(1)->getType();
2505 Assert(Op0Ty == Op1Ty,
2506 "Both operands to ICmp instruction are not of the same type!", &IC);
2507 // Check that the operands are the right type
2508 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2509 "Invalid operand types for ICmp instruction", &IC);
2510 // Check that the predicate is valid.
2511 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2512 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2513 "Invalid predicate in ICmp instruction!", &IC);
2515 visitInstruction(IC);
2518 void Verifier::visitFCmpInst(FCmpInst &FC) {
2519 // Check that the operands are the same type
2520 Type *Op0Ty = FC.getOperand(0)->getType();
2521 Type *Op1Ty = FC.getOperand(1)->getType();
2522 Assert(Op0Ty == Op1Ty,
2523 "Both operands to FCmp instruction are not of the same type!", &FC);
2524 // Check that the operands are the right type
2525 Assert(Op0Ty->isFPOrFPVectorTy(),
2526 "Invalid operand types for FCmp instruction", &FC);
2527 // Check that the predicate is valid.
2528 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2529 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2530 "Invalid predicate in FCmp instruction!", &FC);
2532 visitInstruction(FC);
2535 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
2537 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2538 "Invalid extractelement operands!", &EI);
2539 visitInstruction(EI);
2542 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
2543 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2545 "Invalid insertelement operands!", &IE);
2546 visitInstruction(IE);
2549 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
2550 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2552 "Invalid shufflevector operands!", &SV);
2553 visitInstruction(SV);
2556 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
2557 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
2559 Assert(isa<PointerType>(TargetTy),
2560 "GEP base pointer is not a vector or a vector of pointers", &GEP);
2561 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
2562 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
2564 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
2565 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
2567 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
2568 GEP.getResultElementType() == ElTy,
2569 "GEP is not of right type for indices!", &GEP, ElTy);
2571 if (GEP.getType()->isVectorTy()) {
2572 // Additional checks for vector GEPs.
2573 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2574 if (GEP.getPointerOperandType()->isVectorTy())
2575 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2576 "Vector GEP result width doesn't match operand's", &GEP);
2577 for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
2578 Type *IndexTy = Idxs[i]->getType();
2579 if (IndexTy->isVectorTy()) {
2580 unsigned IndexWidth = IndexTy->getVectorNumElements();
2581 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2583 Assert(IndexTy->getScalarType()->isIntegerTy(),
2584 "All GEP indices should be of integer type");
2587 visitInstruction(GEP);
2590 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2591 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2594 void Verifier::visitRangeMetadata(Instruction& I,
2595 MDNode* Range, Type* Ty) {
2597 Range == I.getMetadata(LLVMContext::MD_range) &&
2598 "precondition violation");
2600 unsigned NumOperands = Range->getNumOperands();
2601 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
2602 unsigned NumRanges = NumOperands / 2;
2603 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2605 ConstantRange LastRange(1); // Dummy initial value
2606 for (unsigned i = 0; i < NumRanges; ++i) {
2608 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
2609 Assert(Low, "The lower limit must be an integer!", Low);
2611 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
2612 Assert(High, "The upper limit must be an integer!", High);
2613 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2614 "Range types must match instruction type!", &I);
2616 APInt HighV = High->getValue();
2617 APInt LowV = Low->getValue();
2618 ConstantRange CurRange(LowV, HighV);
2619 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2620 "Range must not be empty!", Range);
2622 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2623 "Intervals are overlapping", Range);
2624 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2626 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2629 LastRange = ConstantRange(LowV, HighV);
2631 if (NumRanges > 2) {
2633 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
2635 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
2636 ConstantRange FirstRange(FirstLow, FirstHigh);
2637 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2638 "Intervals are overlapping", Range);
2639 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2644 void Verifier::visitLoadInst(LoadInst &LI) {
2645 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
2646 Assert(PTy, "Load operand must be a pointer.", &LI);
2647 Type *ElTy = LI.getType();
2648 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2649 "huge alignment values are unsupported", &LI);
2650 if (LI.isAtomic()) {
2651 Assert(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
2652 "Load cannot have Release ordering", &LI);
2653 Assert(LI.getAlignment() != 0,
2654 "Atomic load must specify explicit alignment", &LI);
2655 if (!ElTy->isPointerTy()) {
2656 Assert(ElTy->isIntegerTy(), "atomic load operand must have integer type!",
2658 unsigned Size = ElTy->getPrimitiveSizeInBits();
2659 Assert(Size >= 8 && !(Size & (Size - 1)),
2660 "atomic load operand must be power-of-two byte-sized integer", &LI,
2664 Assert(LI.getSynchScope() == CrossThread,
2665 "Non-atomic load cannot have SynchronizationScope specified", &LI);
2668 visitInstruction(LI);
2671 void Verifier::visitStoreInst(StoreInst &SI) {
2672 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
2673 Assert(PTy, "Store operand must be a pointer.", &SI);
2674 Type *ElTy = PTy->getElementType();
2675 Assert(ElTy == SI.getOperand(0)->getType(),
2676 "Stored value type does not match pointer operand type!", &SI, ElTy);
2677 Assert(SI.getAlignment() <= Value::MaximumAlignment,
2678 "huge alignment values are unsupported", &SI);
2679 if (SI.isAtomic()) {
2680 Assert(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
2681 "Store cannot have Acquire ordering", &SI);
2682 Assert(SI.getAlignment() != 0,
2683 "Atomic store must specify explicit alignment", &SI);
2684 if (!ElTy->isPointerTy()) {
2685 Assert(ElTy->isIntegerTy(),
2686 "atomic store operand must have integer type!", &SI, ElTy);
2687 unsigned Size = ElTy->getPrimitiveSizeInBits();
2688 Assert(Size >= 8 && !(Size & (Size - 1)),
2689 "atomic store operand must be power-of-two byte-sized integer",
2693 Assert(SI.getSynchScope() == CrossThread,
2694 "Non-atomic store cannot have SynchronizationScope specified", &SI);
2696 visitInstruction(SI);
2699 void Verifier::visitAllocaInst(AllocaInst &AI) {
2700 SmallPtrSet<Type*, 4> Visited;
2701 PointerType *PTy = AI.getType();
2702 Assert(PTy->getAddressSpace() == 0,
2703 "Allocation instruction pointer not in the generic address space!",
2705 Assert(AI.getAllocatedType()->isSized(&Visited),
2706 "Cannot allocate unsized type", &AI);
2707 Assert(AI.getArraySize()->getType()->isIntegerTy(),
2708 "Alloca array size must have integer type", &AI);
2709 Assert(AI.getAlignment() <= Value::MaximumAlignment,
2710 "huge alignment values are unsupported", &AI);
2712 visitInstruction(AI);
2715 void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
2717 // FIXME: more conditions???
2718 Assert(CXI.getSuccessOrdering() != NotAtomic,
2719 "cmpxchg instructions must be atomic.", &CXI);
2720 Assert(CXI.getFailureOrdering() != NotAtomic,
2721 "cmpxchg instructions must be atomic.", &CXI);
2722 Assert(CXI.getSuccessOrdering() != Unordered,
2723 "cmpxchg instructions cannot be unordered.", &CXI);
2724 Assert(CXI.getFailureOrdering() != Unordered,
2725 "cmpxchg instructions cannot be unordered.", &CXI);
2726 Assert(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
2727 "cmpxchg instructions be at least as constrained on success as fail",
2729 Assert(CXI.getFailureOrdering() != Release &&
2730 CXI.getFailureOrdering() != AcquireRelease,
2731 "cmpxchg failure ordering cannot include release semantics", &CXI);
2733 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
2734 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
2735 Type *ElTy = PTy->getElementType();
2736 Assert(ElTy->isIntegerTy(), "cmpxchg operand must have integer type!", &CXI,
2738 unsigned Size = ElTy->getPrimitiveSizeInBits();
2739 Assert(Size >= 8 && !(Size & (Size - 1)),
2740 "cmpxchg operand must be power-of-two byte-sized integer", &CXI, ElTy);
2741 Assert(ElTy == CXI.getOperand(1)->getType(),
2742 "Expected value type does not match pointer operand type!", &CXI,
2744 Assert(ElTy == CXI.getOperand(2)->getType(),
2745 "Stored value type does not match pointer operand type!", &CXI, ElTy);
2746 visitInstruction(CXI);
2749 void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
2750 Assert(RMWI.getOrdering() != NotAtomic,
2751 "atomicrmw instructions must be atomic.", &RMWI);
2752 Assert(RMWI.getOrdering() != Unordered,
2753 "atomicrmw instructions cannot be unordered.", &RMWI);
2754 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
2755 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
2756 Type *ElTy = PTy->getElementType();
2757 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
2759 unsigned Size = ElTy->getPrimitiveSizeInBits();
2760 Assert(Size >= 8 && !(Size & (Size - 1)),
2761 "atomicrmw operand must be power-of-two byte-sized integer", &RMWI,
2763 Assert(ElTy == RMWI.getOperand(1)->getType(),
2764 "Argument value type does not match pointer operand type!", &RMWI,
2766 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
2767 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
2768 "Invalid binary operation!", &RMWI);
2769 visitInstruction(RMWI);
2772 void Verifier::visitFenceInst(FenceInst &FI) {
2773 const AtomicOrdering Ordering = FI.getOrdering();
2774 Assert(Ordering == Acquire || Ordering == Release ||
2775 Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
2776 "fence instructions may only have "
2777 "acquire, release, acq_rel, or seq_cst ordering.",
2779 visitInstruction(FI);
2782 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
2783 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
2784 EVI.getIndices()) == EVI.getType(),
2785 "Invalid ExtractValueInst operands!", &EVI);
2787 visitInstruction(EVI);
2790 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
2791 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
2792 IVI.getIndices()) ==
2793 IVI.getOperand(1)->getType(),
2794 "Invalid InsertValueInst operands!", &IVI);
2796 visitInstruction(IVI);
2799 void Verifier::visitEHPadPredecessors(Instruction &I) {
2800 assert(I.isEHPad());
2802 BasicBlock *BB = I.getParent();
2803 Function *F = BB->getParent();
2805 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
2807 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
2808 // The landingpad instruction defines its parent as a landing pad block. The
2809 // landing pad block may be branched to only by the unwind edge of an
2811 for (BasicBlock *PredBB : predecessors(BB)) {
2812 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
2813 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
2814 "Block containing LandingPadInst must be jumped to "
2815 "only by the unwind edge of an invoke.",
2821 for (BasicBlock *PredBB : predecessors(BB)) {
2822 TerminatorInst *TI = PredBB->getTerminator();
2823 if (auto *II = dyn_cast<InvokeInst>(TI))
2824 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
2825 "EH pad must be jumped to via an unwind edge", &I, II);
2826 else if (auto *CPI = dyn_cast<CatchPadInst>(TI))
2827 Assert(CPI->getUnwindDest() == BB && CPI->getNormalDest() != BB,
2828 "EH pad must be jumped to via an unwind edge", &I, CPI);
2829 else if (isa<CatchEndPadInst>(TI))
2831 else if (isa<CleanupReturnInst>(TI))
2833 else if (isa<CleanupEndPadInst>(TI))
2835 else if (isa<TerminatePadInst>(TI))
2838 Assert(false, "EH pad must be jumped to via an unwind edge", &I, TI);
2842 void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
2843 // The landingpad instruction is ill-formed if it doesn't have any clauses and
2845 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
2846 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
2848 visitEHPadPredecessors(LPI);
2850 if (!LandingPadResultTy)
2851 LandingPadResultTy = LPI.getType();
2853 Assert(LandingPadResultTy == LPI.getType(),
2854 "The landingpad instruction should have a consistent result type "
2855 "inside a function.",
2858 Function *F = LPI.getParent()->getParent();
2859 Assert(F->hasPersonalityFn(),
2860 "LandingPadInst needs to be in a function with a personality.", &LPI);
2862 // The landingpad instruction must be the first non-PHI instruction in the
2864 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
2865 "LandingPadInst not the first non-PHI instruction in the block.",
2868 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
2869 Constant *Clause = LPI.getClause(i);
2870 if (LPI.isCatch(i)) {
2871 Assert(isa<PointerType>(Clause->getType()),
2872 "Catch operand does not have pointer type!", &LPI);
2874 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
2875 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
2876 "Filter operand is not an array of constants!", &LPI);
2880 visitInstruction(LPI);
2883 void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
2884 visitEHPadPredecessors(CPI);
2886 BasicBlock *BB = CPI.getParent();
2887 Function *F = BB->getParent();
2888 Assert(F->hasPersonalityFn(),
2889 "CatchPadInst needs to be in a function with a personality.", &CPI);
2891 // The catchpad instruction must be the first non-PHI instruction in the
2893 Assert(BB->getFirstNonPHI() == &CPI,
2894 "CatchPadInst not the first non-PHI instruction in the block.",
2897 if (!BB->getSinglePredecessor())
2898 for (BasicBlock *PredBB : predecessors(BB)) {
2899 Assert(!isa<CatchPadInst>(PredBB->getTerminator()),
2900 "CatchPadInst with CatchPadInst predecessor cannot have any other "
2905 BasicBlock *UnwindDest = CPI.getUnwindDest();
2906 Instruction *I = UnwindDest->getFirstNonPHI();
2908 isa<CatchPadInst>(I) || isa<CatchEndPadInst>(I),
2909 "CatchPadInst must unwind to a CatchPadInst or a CatchEndPadInst.",
2912 visitTerminatorInst(CPI);
2915 void Verifier::visitCatchEndPadInst(CatchEndPadInst &CEPI) {
2916 visitEHPadPredecessors(CEPI);
2918 BasicBlock *BB = CEPI.getParent();
2919 Function *F = BB->getParent();
2920 Assert(F->hasPersonalityFn(),
2921 "CatchEndPadInst needs to be in a function with a personality.",
2924 // The catchendpad instruction must be the first non-PHI instruction in the
2926 Assert(BB->getFirstNonPHI() == &CEPI,
2927 "CatchEndPadInst not the first non-PHI instruction in the block.",
2930 unsigned CatchPadsSeen = 0;
2931 for (BasicBlock *PredBB : predecessors(BB))
2932 if (isa<CatchPadInst>(PredBB->getTerminator()))
2935 Assert(CatchPadsSeen <= 1, "CatchEndPadInst must have no more than one "
2936 "CatchPadInst predecessor.",
2939 if (BasicBlock *UnwindDest = CEPI.getUnwindDest()) {
2940 Instruction *I = UnwindDest->getFirstNonPHI();
2942 I->isEHPad() && !isa<LandingPadInst>(I),
2943 "CatchEndPad must unwind to an EH block which is not a landingpad.",
2947 visitTerminatorInst(CEPI);
2950 void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
2951 visitEHPadPredecessors(CPI);
2953 BasicBlock *BB = CPI.getParent();
2955 Function *F = BB->getParent();
2956 Assert(F->hasPersonalityFn(),
2957 "CleanupPadInst needs to be in a function with a personality.", &CPI);
2959 // The cleanuppad instruction must be the first non-PHI instruction in the
2961 Assert(BB->getFirstNonPHI() == &CPI,
2962 "CleanupPadInst not the first non-PHI instruction in the block.",
2965 User *FirstUser = nullptr;
2966 BasicBlock *FirstUnwindDest = nullptr;
2967 for (User *U : CPI.users()) {
2968 BasicBlock *UnwindDest;
2969 if (CleanupReturnInst *CRI = dyn_cast<CleanupReturnInst>(U)) {
2970 UnwindDest = CRI->getUnwindDest();
2972 UnwindDest = cast<CleanupEndPadInst>(U)->getUnwindDest();
2977 FirstUnwindDest = UnwindDest;
2979 Assert(UnwindDest == FirstUnwindDest,
2980 "Cleanuprets/cleanupendpads from the same cleanuppad must "
2981 "have the same unwind destination",
2986 visitInstruction(CPI);
2989 void Verifier::visitCleanupEndPadInst(CleanupEndPadInst &CEPI) {
2990 visitEHPadPredecessors(CEPI);
2992 BasicBlock *BB = CEPI.getParent();
2993 Function *F = BB->getParent();
2994 Assert(F->hasPersonalityFn(),
2995 "CleanupEndPadInst needs to be in a function with a personality.",
2998 // The cleanupendpad instruction must be the first non-PHI instruction in the
3000 Assert(BB->getFirstNonPHI() == &CEPI,
3001 "CleanupEndPadInst not the first non-PHI instruction in the block.",
3004 if (BasicBlock *UnwindDest = CEPI.getUnwindDest()) {
3005 Instruction *I = UnwindDest->getFirstNonPHI();
3007 I->isEHPad() && !isa<LandingPadInst>(I),
3008 "CleanupEndPad must unwind to an EH block which is not a landingpad.",
3012 visitTerminatorInst(CEPI);
3015 void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
3016 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3017 Instruction *I = UnwindDest->getFirstNonPHI();
3018 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3019 "CleanupReturnInst must unwind to an EH block which is not a "
3024 visitTerminatorInst(CRI);
3027 void Verifier::visitTerminatePadInst(TerminatePadInst &TPI) {
3028 visitEHPadPredecessors(TPI);
3030 BasicBlock *BB = TPI.getParent();
3031 Function *F = BB->getParent();
3032 Assert(F->hasPersonalityFn(),
3033 "TerminatePadInst needs to be in a function with a personality.",
3036 // The terminatepad instruction must be the first non-PHI instruction in the
3038 Assert(BB->getFirstNonPHI() == &TPI,
3039 "TerminatePadInst not the first non-PHI instruction in the block.",
3042 if (BasicBlock *UnwindDest = TPI.getUnwindDest()) {
3043 Instruction *I = UnwindDest->getFirstNonPHI();
3044 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3045 "TerminatePadInst must unwind to an EH block which is not a "
3050 visitTerminatorInst(TPI);
3053 void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3054 Instruction *Op = cast<Instruction>(I.getOperand(i));
3055 // If the we have an invalid invoke, don't try to compute the dominance.
3056 // We already reject it in the invoke specific checks and the dominance
3057 // computation doesn't handle multiple edges.
3058 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3059 if (II->getNormalDest() == II->getUnwindDest())
3063 const Use &U = I.getOperandUse(i);
3064 Assert(InstsInThisBlock.count(Op) || DT.dominates(Op, U),
3065 "Instruction does not dominate all uses!", Op, &I);
3068 void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
3069 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
3070 "apply only to pointer types", &I);
3071 Assert(isa<LoadInst>(I),
3072 "dereferenceable, dereferenceable_or_null apply only to load"
3073 " instructions, use attributes for calls or invokes", &I);
3074 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
3075 "take one operand!", &I);
3076 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
3077 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
3078 "dereferenceable_or_null metadata value must be an i64!", &I);
3081 /// verifyInstruction - Verify that an instruction is well formed.
3083 void Verifier::visitInstruction(Instruction &I) {
3084 BasicBlock *BB = I.getParent();
3085 Assert(BB, "Instruction not embedded in basic block!", &I);
3087 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
3088 for (User *U : I.users()) {
3089 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3090 "Only PHI nodes may reference their own value!", &I);
3094 // Check that void typed values don't have names
3095 Assert(!I.getType()->isVoidTy() || !I.hasName(),
3096 "Instruction has a name, but provides a void value!", &I);
3098 // Check that the return value of the instruction is either void or a legal
3100 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3101 "Instruction returns a non-scalar type!", &I);
3103 // Check that the instruction doesn't produce metadata. Calls are already
3104 // checked against the callee type.
3105 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3106 "Invalid use of metadata!", &I);
3108 // Check that all uses of the instruction, if they are instructions
3109 // themselves, actually have parent basic blocks. If the use is not an
3110 // instruction, it is an error!
3111 for (Use &U : I.uses()) {
3112 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
3113 Assert(Used->getParent() != nullptr,
3114 "Instruction referencing"
3115 " instruction not embedded in a basic block!",
3118 CheckFailed("Use of instruction is not an instruction!", U);
3123 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
3124 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
3126 // Check to make sure that only first-class-values are operands to
3128 if (!I.getOperand(i)->getType()->isFirstClassType()) {
3129 Assert(0, "Instruction operands must be first-class values!", &I);
3132 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
3133 // Check to make sure that the "address of" an intrinsic function is never
3136 !F->isIntrinsic() ||
3137 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3138 "Cannot take the address of an intrinsic!", &I);
3140 !F->isIntrinsic() || isa<CallInst>(I) ||
3141 F->getIntrinsicID() == Intrinsic::donothing ||
3142 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
3143 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3144 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
3145 "Cannot invoke an intrinsinc other than"
3146 " donothing or patchpoint",
3148 Assert(F->getParent() == M, "Referencing function in another module!",
3150 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
3151 Assert(OpBB->getParent() == BB->getParent(),
3152 "Referring to a basic block in another function!", &I);
3153 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
3154 Assert(OpArg->getParent() == BB->getParent(),
3155 "Referring to an argument in another function!", &I);
3156 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
3157 Assert(GV->getParent() == M, "Referencing global in another module!", &I);
3158 } else if (isa<Instruction>(I.getOperand(i))) {
3159 verifyDominatesUse(I, i);
3160 } else if (isa<InlineAsm>(I.getOperand(i))) {
3161 Assert((i + 1 == e && isa<CallInst>(I)) ||
3162 (i + 3 == e && isa<InvokeInst>(I)),
3163 "Cannot take the address of an inline asm!", &I);
3164 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
3165 if (CE->getType()->isPtrOrPtrVectorTy()) {
3166 // If we have a ConstantExpr pointer, we need to see if it came from an
3167 // illegal bitcast (inttoptr <constant int> )
3168 SmallVector<const ConstantExpr *, 4> Stack;
3169 SmallPtrSet<const ConstantExpr *, 4> Visited;
3170 Stack.push_back(CE);
3172 while (!Stack.empty()) {
3173 const ConstantExpr *V = Stack.pop_back_val();
3174 if (!Visited.insert(V).second)
3177 VerifyConstantExprBitcastType(V);
3179 for (unsigned I = 0, N = V->getNumOperands(); I != N; ++I) {
3180 if (ConstantExpr *Op = dyn_cast<ConstantExpr>(V->getOperand(I)))
3181 Stack.push_back(Op);
3188 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
3189 Assert(I.getType()->isFPOrFPVectorTy(),
3190 "fpmath requires a floating point result!", &I);
3191 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
3192 if (ConstantFP *CFP0 =
3193 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
3194 APFloat Accuracy = CFP0->getValueAPF();
3195 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3196 "fpmath accuracy not a positive number!", &I);
3198 Assert(false, "invalid fpmath accuracy!", &I);
3202 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
3203 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3204 "Ranges are only for loads, calls and invokes!", &I);
3205 visitRangeMetadata(I, Range, I.getType());
3208 if (I.getMetadata(LLVMContext::MD_nonnull)) {
3209 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3211 Assert(isa<LoadInst>(I),
3212 "nonnull applies only to load instructions, use attributes"
3213 " for calls or invokes",
3217 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
3218 visitDereferenceableMetadata(I, MD);
3220 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
3221 visitDereferenceableMetadata(I, MD);
3223 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
3224 Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
3226 Assert(isa<LoadInst>(I), "align applies only to load instructions, "
3227 "use attributes for calls or invokes", &I);
3228 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
3229 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
3230 Assert(CI && CI->getType()->isIntegerTy(64),
3231 "align metadata value must be an i64!", &I);
3232 uint64_t Align = CI->getZExtValue();
3233 Assert(isPowerOf2_64(Align),
3234 "align metadata value must be a power of 2!", &I);
3235 Assert(Align <= Value::MaximumAlignment,
3236 "alignment is larger that implementation defined limit", &I);
3239 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
3240 Assert(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
3244 InstsInThisBlock.insert(&I);
3247 /// VerifyIntrinsicType - Verify that the specified type (which comes from an
3248 /// intrinsic argument or return value) matches the type constraints specified
3249 /// by the .td file (e.g. an "any integer" argument really is an integer).
3251 /// This return true on error but does not print a message.
3252 bool Verifier::VerifyIntrinsicType(Type *Ty,
3253 ArrayRef<Intrinsic::IITDescriptor> &Infos,
3254 SmallVectorImpl<Type*> &ArgTys) {
3255 using namespace Intrinsic;
3257 // If we ran out of descriptors, there are too many arguments.
3258 if (Infos.empty()) return true;
3259 IITDescriptor D = Infos.front();
3260 Infos = Infos.slice(1);
3263 case IITDescriptor::Void: return !Ty->isVoidTy();
3264 case IITDescriptor::VarArg: return true;
3265 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
3266 case IITDescriptor::Token: return !Ty->isTokenTy();
3267 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
3268 case IITDescriptor::Half: return !Ty->isHalfTy();
3269 case IITDescriptor::Float: return !Ty->isFloatTy();
3270 case IITDescriptor::Double: return !Ty->isDoubleTy();
3271 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
3272 case IITDescriptor::Vector: {
3273 VectorType *VT = dyn_cast<VectorType>(Ty);
3274 return !VT || VT->getNumElements() != D.Vector_Width ||
3275 VerifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
3277 case IITDescriptor::Pointer: {
3278 PointerType *PT = dyn_cast<PointerType>(Ty);
3279 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
3280 VerifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
3283 case IITDescriptor::Struct: {
3284 StructType *ST = dyn_cast<StructType>(Ty);
3285 if (!ST || ST->getNumElements() != D.Struct_NumElements)
3288 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
3289 if (VerifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
3294 case IITDescriptor::Argument:
3295 // Two cases here - If this is the second occurrence of an argument, verify
3296 // that the later instance matches the previous instance.
3297 if (D.getArgumentNumber() < ArgTys.size())
3298 return Ty != ArgTys[D.getArgumentNumber()];
3300 // Otherwise, if this is the first instance of an argument, record it and
3301 // verify the "Any" kind.
3302 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
3303 ArgTys.push_back(Ty);
3305 switch (D.getArgumentKind()) {
3306 case IITDescriptor::AK_Any: return false; // Success
3307 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
3308 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
3309 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
3310 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
3312 llvm_unreachable("all argument kinds not covered");
3314 case IITDescriptor::ExtendArgument: {
3315 // This may only be used when referring to a previous vector argument.
3316 if (D.getArgumentNumber() >= ArgTys.size())
3319 Type *NewTy = ArgTys[D.getArgumentNumber()];
3320 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3321 NewTy = VectorType::getExtendedElementVectorType(VTy);
3322 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3323 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
3329 case IITDescriptor::TruncArgument: {
3330 // This may only be used when referring to a previous vector argument.
3331 if (D.getArgumentNumber() >= ArgTys.size())
3334 Type *NewTy = ArgTys[D.getArgumentNumber()];
3335 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3336 NewTy = VectorType::getTruncatedElementVectorType(VTy);
3337 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3338 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
3344 case IITDescriptor::HalfVecArgument:
3345 // This may only be used when referring to a previous vector argument.
3346 return D.getArgumentNumber() >= ArgTys.size() ||
3347 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
3348 VectorType::getHalfElementsVectorType(
3349 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
3350 case IITDescriptor::SameVecWidthArgument: {
3351 if (D.getArgumentNumber() >= ArgTys.size())
3353 VectorType * ReferenceType =
3354 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
3355 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
3356 if (!ThisArgType || !ReferenceType ||
3357 (ReferenceType->getVectorNumElements() !=
3358 ThisArgType->getVectorNumElements()))
3360 return VerifyIntrinsicType(ThisArgType->getVectorElementType(),
3363 case IITDescriptor::PtrToArgument: {
3364 if (D.getArgumentNumber() >= ArgTys.size())
3366 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
3367 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
3368 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
3370 case IITDescriptor::VecOfPtrsToElt: {
3371 if (D.getArgumentNumber() >= ArgTys.size())
3373 VectorType * ReferenceType =
3374 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
3375 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
3376 if (!ThisArgVecTy || !ReferenceType ||
3377 (ReferenceType->getVectorNumElements() !=
3378 ThisArgVecTy->getVectorNumElements()))
3380 PointerType *ThisArgEltTy =
3381 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
3384 return ThisArgEltTy->getElementType() !=
3385 ReferenceType->getVectorElementType();
3388 llvm_unreachable("unhandled");
3391 /// \brief Verify if the intrinsic has variable arguments.
3392 /// This method is intended to be called after all the fixed arguments have been
3395 /// This method returns true on error and does not print an error message.
3397 Verifier::VerifyIntrinsicIsVarArg(bool isVarArg,
3398 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
3399 using namespace Intrinsic;
3401 // If there are no descriptors left, then it can't be a vararg.
3405 // There should be only one descriptor remaining at this point.
3406 if (Infos.size() != 1)
3409 // Check and verify the descriptor.
3410 IITDescriptor D = Infos.front();
3411 Infos = Infos.slice(1);
3412 if (D.Kind == IITDescriptor::VarArg)
3418 /// Allow intrinsics to be verified in different ways.
3419 void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
3420 Function *IF = CS.getCalledFunction();
3421 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3424 // Verify that the intrinsic prototype lines up with what the .td files
3426 FunctionType *IFTy = IF->getFunctionType();
3427 bool IsVarArg = IFTy->isVarArg();
3429 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3430 getIntrinsicInfoTableEntries(ID, Table);
3431 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
3433 SmallVector<Type *, 4> ArgTys;
3434 Assert(!VerifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
3435 "Intrinsic has incorrect return type!", IF);
3436 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
3437 Assert(!VerifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
3438 "Intrinsic has incorrect argument type!", IF);
3440 // Verify if the intrinsic call matches the vararg property.
3442 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3443 "Intrinsic was not defined with variable arguments!", IF);
3445 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3446 "Callsite was not defined with variable arguments!", IF);
3448 // All descriptors should be absorbed by now.
3449 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
3451 // Now that we have the intrinsic ID and the actual argument types (and we
3452 // know they are legal for the intrinsic!) get the intrinsic name through the
3453 // usual means. This allows us to verify the mangling of argument types into
3455 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
3456 Assert(ExpectedName == IF->getName(),
3457 "Intrinsic name not mangled correctly for type arguments! "
3462 // If the intrinsic takes MDNode arguments, verify that they are either global
3463 // or are local to *this* function.
3464 for (Value *V : CS.args())
3465 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3466 visitMetadataAsValue(*MD, CS.getCaller());
3471 case Intrinsic::ctlz: // llvm.ctlz
3472 case Intrinsic::cttz: // llvm.cttz
3473 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3474 "is_zero_undef argument of bit counting intrinsics must be a "
3478 case Intrinsic::dbg_declare: // llvm.dbg.declare
3479 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3480 "invalid llvm.dbg.declare intrinsic call 1", CS);
3481 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
3483 case Intrinsic::dbg_value: // llvm.dbg.value
3484 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
3486 case Intrinsic::memcpy:
3487 case Intrinsic::memmove:
3488 case Intrinsic::memset: {
3489 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
3491 "alignment argument of memory intrinsics must be a constant int",
3493 const APInt &AlignVal = AlignCI->getValue();
3494 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
3495 "alignment argument of memory intrinsics must be a power of 2", CS);
3496 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
3497 "isvolatile argument of memory intrinsics must be a constant int",
3501 case Intrinsic::gcroot:
3502 case Intrinsic::gcwrite:
3503 case Intrinsic::gcread:
3504 if (ID == Intrinsic::gcroot) {
3506 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3507 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3508 Assert(isa<Constant>(CS.getArgOperand(1)),
3509 "llvm.gcroot parameter #2 must be a constant.", CS);
3510 if (!AI->getAllocatedType()->isPointerTy()) {
3511 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
3512 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3513 "or argument #2 must be a non-null constant.",
3518 Assert(CS.getParent()->getParent()->hasGC(),
3519 "Enclosing function does not use GC.", CS);
3521 case Intrinsic::init_trampoline:
3522 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
3523 "llvm.init_trampoline parameter #2 must resolve to a function.",
3526 case Intrinsic::prefetch:
3527 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
3528 isa<ConstantInt>(CS.getArgOperand(2)) &&
3529 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
3530 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
3531 "invalid arguments to llvm.prefetch", CS);
3533 case Intrinsic::stackprotector:
3534 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
3535 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
3537 case Intrinsic::lifetime_start:
3538 case Intrinsic::lifetime_end:
3539 case Intrinsic::invariant_start:
3540 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
3541 "size argument of memory use markers must be a constant integer",
3544 case Intrinsic::invariant_end:
3545 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3546 "llvm.invariant.end parameter #2 must be a constant integer", CS);
3549 case Intrinsic::localescape: {
3550 BasicBlock *BB = CS.getParent();
3551 Assert(BB == &BB->getParent()->front(),
3552 "llvm.localescape used outside of entry block", CS);
3553 Assert(!SawFrameEscape,
3554 "multiple calls to llvm.localescape in one function", CS);
3555 for (Value *Arg : CS.args()) {
3556 if (isa<ConstantPointerNull>(Arg))
3557 continue; // Null values are allowed as placeholders.
3558 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
3559 Assert(AI && AI->isStaticAlloca(),
3560 "llvm.localescape only accepts static allocas", CS);
3562 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
3563 SawFrameEscape = true;
3566 case Intrinsic::localrecover: {
3567 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
3568 Function *Fn = dyn_cast<Function>(FnArg);
3569 Assert(Fn && !Fn->isDeclaration(),
3570 "llvm.localrecover first "
3571 "argument must be function defined in this module",
3573 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
3574 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
3576 auto &Entry = FrameEscapeInfo[Fn];
3577 Entry.second = unsigned(
3578 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
3582 case Intrinsic::experimental_gc_statepoint:
3583 Assert(!CS.isInlineAsm(),
3584 "gc.statepoint support for inline assembly unimplemented", CS);
3585 Assert(CS.getParent()->getParent()->hasGC(),
3586 "Enclosing function does not use GC.", CS);
3588 VerifyStatepoint(CS);
3590 case Intrinsic::experimental_gc_result_int:
3591 case Intrinsic::experimental_gc_result_float:
3592 case Intrinsic::experimental_gc_result_ptr:
3593 case Intrinsic::experimental_gc_result: {
3594 Assert(CS.getParent()->getParent()->hasGC(),
3595 "Enclosing function does not use GC.", CS);
3596 // Are we tied to a statepoint properly?
3597 CallSite StatepointCS(CS.getArgOperand(0));
3598 const Function *StatepointFn =
3599 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
3600 Assert(StatepointFn && StatepointFn->isDeclaration() &&
3601 StatepointFn->getIntrinsicID() ==
3602 Intrinsic::experimental_gc_statepoint,
3603 "gc.result operand #1 must be from a statepoint", CS,
3604 CS.getArgOperand(0));
3606 // Assert that result type matches wrapped callee.
3607 const Value *Target = StatepointCS.getArgument(2);
3608 auto *PT = cast<PointerType>(Target->getType());
3609 auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
3610 Assert(CS.getType() == TargetFuncType->getReturnType(),
3611 "gc.result result type does not match wrapped callee", CS);
3614 case Intrinsic::experimental_gc_relocate: {
3615 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
3617 // Check that this relocate is correctly tied to the statepoint
3619 // This is case for relocate on the unwinding path of an invoke statepoint
3620 if (ExtractValueInst *ExtractValue =
3621 dyn_cast<ExtractValueInst>(CS.getArgOperand(0))) {
3622 Assert(isa<LandingPadInst>(ExtractValue->getAggregateOperand()),
3623 "gc relocate on unwind path incorrectly linked to the statepoint",
3626 const BasicBlock *InvokeBB =
3627 ExtractValue->getParent()->getUniquePredecessor();
3629 // Landingpad relocates should have only one predecessor with invoke
3630 // statepoint terminator
3631 Assert(InvokeBB, "safepoints should have unique landingpads",
3632 ExtractValue->getParent());
3633 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
3635 Assert(isStatepoint(InvokeBB->getTerminator()),
3636 "gc relocate should be linked to a statepoint", InvokeBB);
3639 // In all other cases relocate should be tied to the statepoint directly.
3640 // This covers relocates on a normal return path of invoke statepoint and
3641 // relocates of a call statepoint
3642 auto Token = CS.getArgOperand(0);
3643 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
3644 "gc relocate is incorrectly tied to the statepoint", CS, Token);
3647 // Verify rest of the relocate arguments
3649 GCRelocateOperands Ops(CS);
3650 ImmutableCallSite StatepointCS(Ops.getStatepoint());
3652 // Both the base and derived must be piped through the safepoint
3653 Value* Base = CS.getArgOperand(1);
3654 Assert(isa<ConstantInt>(Base),
3655 "gc.relocate operand #2 must be integer offset", CS);
3657 Value* Derived = CS.getArgOperand(2);
3658 Assert(isa<ConstantInt>(Derived),
3659 "gc.relocate operand #3 must be integer offset", CS);
3661 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
3662 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
3664 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
3665 "gc.relocate: statepoint base index out of bounds", CS);
3666 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
3667 "gc.relocate: statepoint derived index out of bounds", CS);
3669 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
3670 // section of the statepoint's argument
3671 Assert(StatepointCS.arg_size() > 0,
3672 "gc.statepoint: insufficient arguments");
3673 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
3674 "gc.statement: number of call arguments must be constant integer");
3675 const unsigned NumCallArgs =
3676 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
3677 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
3678 "gc.statepoint: mismatch in number of call arguments");
3679 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
3680 "gc.statepoint: number of transition arguments must be "
3681 "a constant integer");
3682 const int NumTransitionArgs =
3683 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
3685 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
3686 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
3687 "gc.statepoint: number of deoptimization arguments must be "
3688 "a constant integer");
3689 const int NumDeoptArgs =
3690 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))->getZExtValue();
3691 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
3692 const int GCParamArgsEnd = StatepointCS.arg_size();
3693 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
3694 "gc.relocate: statepoint base index doesn't fall within the "
3695 "'gc parameters' section of the statepoint call",
3697 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
3698 "gc.relocate: statepoint derived index doesn't fall within the "
3699 "'gc parameters' section of the statepoint call",
3702 // Relocated value must be a pointer type, but gc_relocate does not need to return the
3703 // same pointer type as the relocated pointer. It can be casted to the correct type later
3704 // if it's desired. However, they must have the same address space.
3705 GCRelocateOperands Operands(CS);
3706 Assert(Operands.getDerivedPtr()->getType()->isPointerTy(),
3707 "gc.relocate: relocated value must be a gc pointer", CS);
3709 // gc_relocate return type must be a pointer type, and is verified earlier in
3710 // VerifyIntrinsicType().
3711 Assert(cast<PointerType>(CS.getType())->getAddressSpace() ==
3712 cast<PointerType>(Operands.getDerivedPtr()->getType())->getAddressSpace(),
3713 "gc.relocate: relocating a pointer shouldn't change its address space", CS);
3716 case Intrinsic::eh_exceptioncode:
3717 case Intrinsic::eh_exceptionpointer: {
3718 Assert(isa<CatchPadInst>(CS.getArgOperand(0)),
3719 "eh.exceptionpointer argument must be a catchpad", CS);
3725 /// \brief Carefully grab the subprogram from a local scope.
3727 /// This carefully grabs the subprogram from a local scope, avoiding the
3728 /// built-in assertions that would typically fire.
3729 static DISubprogram *getSubprogram(Metadata *LocalScope) {
3733 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
3736 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
3737 return getSubprogram(LB->getRawScope());
3739 // Just return null; broken scope chains are checked elsewhere.
3740 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
3744 template <class DbgIntrinsicTy>
3745 void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
3746 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
3747 Assert(isa<ValueAsMetadata>(MD) ||
3748 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
3749 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
3750 Assert(isa<DILocalVariable>(DII.getRawVariable()),
3751 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
3752 DII.getRawVariable());
3753 Assert(isa<DIExpression>(DII.getRawExpression()),
3754 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
3755 DII.getRawExpression());
3757 // Ignore broken !dbg attachments; they're checked elsewhere.
3758 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
3759 if (!isa<DILocation>(N))
3762 BasicBlock *BB = DII.getParent();
3763 Function *F = BB ? BB->getParent() : nullptr;
3765 // The scopes for variables and !dbg attachments must agree.
3766 DILocalVariable *Var = DII.getVariable();
3767 DILocation *Loc = DII.getDebugLoc();
3768 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
3771 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
3772 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
3773 if (!VarSP || !LocSP)
3774 return; // Broken scope chains are checked elsewhere.
3776 Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
3777 " variable and !dbg attachment",
3778 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
3779 Loc->getScope()->getSubprogram());
3782 template <class MapTy>
3783 static uint64_t getVariableSize(const DILocalVariable &V, const MapTy &Map) {
3784 // Be careful of broken types (checked elsewhere).
3785 const Metadata *RawType = V.getRawType();
3787 // Try to get the size directly.
3788 if (auto *T = dyn_cast<DIType>(RawType))
3789 if (uint64_t Size = T->getSizeInBits())
3792 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
3793 // Look at the base type.
3794 RawType = DT->getRawBaseType();
3798 if (auto *S = dyn_cast<MDString>(RawType)) {
3799 // Don't error on missing types (checked elsewhere).
3800 RawType = Map.lookup(S);
3804 // Missing type or size.
3812 template <class MapTy>
3813 void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I,
3814 const MapTy &TypeRefs) {
3817 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
3818 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
3819 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
3821 auto *DDI = cast<DbgDeclareInst>(&I);
3822 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
3823 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
3826 // We don't know whether this intrinsic verified correctly.
3827 if (!V || !E || !E->isValid())
3830 // Nothing to do if this isn't a bit piece expression.
3831 if (!E->isBitPiece())
3834 // The frontend helps out GDB by emitting the members of local anonymous
3835 // unions as artificial local variables with shared storage. When SROA splits
3836 // the storage for artificial local variables that are smaller than the entire
3837 // union, the overhang piece will be outside of the allotted space for the
3838 // variable and this check fails.
3839 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
3840 if (V->isArtificial())
3843 // If there's no size, the type is broken, but that should be checked
3845 uint64_t VarSize = getVariableSize(*V, TypeRefs);
3849 unsigned PieceSize = E->getBitPieceSize();
3850 unsigned PieceOffset = E->getBitPieceOffset();
3851 Assert(PieceSize + PieceOffset <= VarSize,
3852 "piece is larger than or outside of variable", &I, V, E);
3853 Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
3856 void Verifier::visitUnresolvedTypeRef(const MDString *S, const MDNode *N) {
3857 // This is in its own function so we get an error for each bad type ref (not
3859 Assert(false, "unresolved type ref", S, N);
3862 void Verifier::verifyTypeRefs() {
3863 auto *CUs = M->getNamedMetadata("llvm.dbg.cu");
3867 // Visit all the compile units again to map the type references.
3868 SmallDenseMap<const MDString *, const DIType *, 32> TypeRefs;
3869 for (auto *CU : CUs->operands())
3870 if (auto Ts = cast<DICompileUnit>(CU)->getRetainedTypes())
3871 for (DIType *Op : Ts)
3872 if (auto *T = dyn_cast_or_null<DICompositeType>(Op))
3873 if (auto *S = T->getRawIdentifier()) {
3874 UnresolvedTypeRefs.erase(S);
3875 TypeRefs.insert(std::make_pair(S, T));
3878 // Verify debug info intrinsic bit piece expressions. This needs a second
3879 // pass through the intructions, since we haven't built TypeRefs yet when
3880 // verifying functions, and simply queuing the DbgInfoIntrinsics to evaluate
3881 // later/now would queue up some that could be later deleted.
3882 for (const Function &F : *M)
3883 for (const BasicBlock &BB : F)
3884 for (const Instruction &I : BB)
3885 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
3886 verifyBitPieceExpression(*DII, TypeRefs);
3888 // Return early if all typerefs were resolved.
3889 if (UnresolvedTypeRefs.empty())
3892 // Sort the unresolved references by name so the output is deterministic.
3893 typedef std::pair<const MDString *, const MDNode *> TypeRef;
3894 SmallVector<TypeRef, 32> Unresolved(UnresolvedTypeRefs.begin(),
3895 UnresolvedTypeRefs.end());
3896 std::sort(Unresolved.begin(), Unresolved.end(),
3897 [](const TypeRef &LHS, const TypeRef &RHS) {
3898 return LHS.first->getString() < RHS.first->getString();
3901 // Visit the unresolved refs (printing out the errors).
3902 for (const TypeRef &TR : Unresolved)
3903 visitUnresolvedTypeRef(TR.first, TR.second);
3906 //===----------------------------------------------------------------------===//
3907 // Implement the public interfaces to this file...
3908 //===----------------------------------------------------------------------===//
3910 bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
3911 Function &F = const_cast<Function &>(f);
3912 assert(!F.isDeclaration() && "Cannot verify external functions");
3914 raw_null_ostream NullStr;
3915 Verifier V(OS ? *OS : NullStr);
3917 // Note that this function's return value is inverted from what you would
3918 // expect of a function called "verify".
3919 return !V.verify(F);
3922 bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
3923 raw_null_ostream NullStr;
3924 Verifier V(OS ? *OS : NullStr);
3926 bool Broken = false;
3927 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
3928 if (!I->isDeclaration() && !I->isMaterializable())
3929 Broken |= !V.verify(*I);
3931 // Note that this function's return value is inverted from what you would
3932 // expect of a function called "verify".
3933 return !V.verify(M) || Broken;
3937 struct VerifierLegacyPass : public FunctionPass {
3943 VerifierLegacyPass() : FunctionPass(ID), V(dbgs()), FatalErrors(true) {
3944 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3946 explicit VerifierLegacyPass(bool FatalErrors)
3947 : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
3948 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3951 bool runOnFunction(Function &F) override {
3952 if (!V.verify(F) && FatalErrors)
3953 report_fatal_error("Broken function found, compilation aborted!");
3958 bool doFinalization(Module &M) override {
3959 if (!V.verify(M) && FatalErrors)
3960 report_fatal_error("Broken module found, compilation aborted!");
3965 void getAnalysisUsage(AnalysisUsage &AU) const override {
3966 AU.setPreservesAll();
3971 char VerifierLegacyPass::ID = 0;
3972 INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
3974 FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
3975 return new VerifierLegacyPass(FatalErrors);
3978 PreservedAnalyses VerifierPass::run(Module &M) {
3979 if (verifyModule(M, &dbgs()) && FatalErrors)
3980 report_fatal_error("Broken module found, compilation aborted!");
3982 return PreservedAnalyses::all();
3985 PreservedAnalyses VerifierPass::run(Function &F) {
3986 if (verifyFunction(F, &dbgs()) && FatalErrors)
3987 report_fatal_error("Broken function found, compilation aborted!");
3989 return PreservedAnalyses::all();