1 //===-- Verifier.cpp - Implement the Module Verifier -----------------------==//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the function verifier interface, that can be used for some
11 // sanity checking of input to the system.
13 // Note that this does not provide full `Java style' security and verifications,
14 // instead it just tries to ensure that code is well-formed.
16 // * Both of a binary operator's parameters are of the same type
17 // * Verify that the indices of mem access instructions match other operands
18 // * Verify that arithmetic and other things are only performed on first-class
19 // types. Verify that shifts & logicals only happen on integrals f.e.
20 // * All of the constants in a switch statement are of the correct type
21 // * The code is in valid SSA form
22 // * It should be illegal to put a label into any other type (like a structure)
23 // or to return one. [except constant arrays!]
24 // * Only phi nodes can be self referential: 'add i32 %0, %0 ; <int>:0' is bad
25 // * PHI nodes must have an entry for each predecessor, with no extras.
26 // * PHI nodes must be the first thing in a basic block, all grouped together
27 // * PHI nodes must have at least one entry
28 // * All basic blocks should only end with terminator insts, not contain them
29 // * The entry node to a function must not have predecessors
30 // * All Instructions must be embedded into a basic block
31 // * Functions cannot take a void-typed parameter
32 // * Verify that a function's argument list agrees with it's declared type.
33 // * It is illegal to specify a name for a void value.
34 // * It is illegal to have a internal global value with no initializer
35 // * It is illegal to have a ret instruction that returns a value that does not
36 // agree with the function return value type.
37 // * Function call argument types match the function prototype
38 // * A landing pad is defined by a landingpad instruction, and can be jumped to
39 // only by the unwind edge of an invoke instruction.
40 // * A landingpad instruction must be the first non-PHI instruction in the
42 // * All landingpad instructions must use the same personality function with
44 // * All other things that are tested by asserts spread about the code...
46 //===----------------------------------------------------------------------===//
48 #include "llvm/IR/Verifier.h"
49 #include "llvm/ADT/STLExtras.h"
50 #include "llvm/ADT/SetVector.h"
51 #include "llvm/ADT/SmallPtrSet.h"
52 #include "llvm/ADT/SmallVector.h"
53 #include "llvm/ADT/StringExtras.h"
54 #include "llvm/IR/CFG.h"
55 #include "llvm/IR/CallSite.h"
56 #include "llvm/IR/CallingConv.h"
57 #include "llvm/IR/ConstantRange.h"
58 #include "llvm/IR/Constants.h"
59 #include "llvm/IR/DataLayout.h"
60 #include "llvm/IR/DebugInfo.h"
61 #include "llvm/IR/DerivedTypes.h"
62 #include "llvm/IR/Dominators.h"
63 #include "llvm/IR/InlineAsm.h"
64 #include "llvm/IR/InstIterator.h"
65 #include "llvm/IR/InstVisitor.h"
66 #include "llvm/IR/IntrinsicInst.h"
67 #include "llvm/IR/LLVMContext.h"
68 #include "llvm/IR/Metadata.h"
69 #include "llvm/IR/Module.h"
70 #include "llvm/IR/PassManager.h"
71 #include "llvm/IR/Statepoint.h"
72 #include "llvm/Pass.h"
73 #include "llvm/Support/CommandLine.h"
74 #include "llvm/Support/Debug.h"
75 #include "llvm/Support/ErrorHandling.h"
76 #include "llvm/Support/raw_ostream.h"
81 static cl::opt<bool> VerifyDebugInfo("verify-debug-info", cl::init(true));
84 struct VerifierSupport {
88 /// \brief Track the brokenness of the module while recursively visiting.
91 explicit VerifierSupport(raw_ostream &OS)
92 : OS(OS), M(nullptr), Broken(false) {}
95 void Write(const Value *V) {
98 if (isa<Instruction>(V)) {
101 V->printAsOperand(OS, true, M);
105 void Write(ImmutableCallSite CS) {
106 Write(CS.getInstruction());
109 void Write(const Metadata *MD) {
116 template <class T> void Write(const MDTupleTypedArrayWrapper<T> &MD) {
120 void Write(const NamedMDNode *NMD) {
127 void Write(Type *T) {
133 void Write(const Comdat *C) {
139 template <typename T1, typename... Ts>
140 void WriteTs(const T1 &V1, const Ts &... Vs) {
145 template <typename... Ts> void WriteTs() {}
148 /// \brief A check failed, so printout out the condition and the message.
150 /// This provides a nice place to put a breakpoint if you want to see why
151 /// something is not correct.
152 void CheckFailed(const Twine &Message) {
153 OS << Message << '\n';
157 /// \brief A check failed (with values to print).
159 /// This calls the Message-only version so that the above is easier to set a
161 template <typename T1, typename... Ts>
162 void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) {
163 CheckFailed(Message);
168 class Verifier : public InstVisitor<Verifier>, VerifierSupport {
169 friend class InstVisitor<Verifier>;
171 LLVMContext *Context;
174 /// \brief When verifying a basic block, keep track of all of the
175 /// instructions we have seen so far.
177 /// This allows us to do efficient dominance checks for the case when an
178 /// instruction has an operand that is an instruction in the same block.
179 SmallPtrSet<Instruction *, 16> InstsInThisBlock;
181 /// \brief Keep track of the metadata nodes that have been checked already.
182 SmallPtrSet<const Metadata *, 32> MDNodes;
184 /// \brief Track unresolved string-based type references.
185 SmallDenseMap<const MDString *, const MDNode *, 32> UnresolvedTypeRefs;
187 /// \brief Whether we've seen a call to @llvm.localescape in this function
191 /// Stores the count of how many objects were passed to llvm.localescape for a
192 /// given function and the largest index passed to llvm.localrecover.
193 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
196 explicit Verifier(raw_ostream &OS)
197 : VerifierSupport(OS), Context(nullptr), SawFrameEscape(false) {}
199 bool verify(const Function &F) {
201 Context = &M->getContext();
203 // First ensure the function is well-enough formed to compute dominance
206 OS << "Function '" << F.getName()
207 << "' does not contain an entry block!\n";
210 for (Function::const_iterator I = F.begin(), E = F.end(); I != E; ++I) {
211 if (I->empty() || !I->back().isTerminator()) {
212 OS << "Basic Block in function '" << F.getName()
213 << "' does not have terminator!\n";
214 I->printAsOperand(OS, true);
220 // Now directly compute a dominance tree. We don't rely on the pass
221 // manager to provide this as it isolates us from a potentially
222 // out-of-date dominator tree and makes it significantly more complex to
223 // run this code outside of a pass manager.
224 // FIXME: It's really gross that we have to cast away constness here.
225 DT.recalculate(const_cast<Function &>(F));
228 // FIXME: We strip const here because the inst visitor strips const.
229 visit(const_cast<Function &>(F));
230 InstsInThisBlock.clear();
231 SawFrameEscape = false;
236 bool verify(const Module &M) {
238 Context = &M.getContext();
241 // Scan through, checking all of the external function's linkage now...
242 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
243 visitGlobalValue(*I);
245 // Check to make sure function prototypes are okay.
246 if (I->isDeclaration())
250 // Now that we've visited every function, verify that we never asked to
251 // recover a frame index that wasn't escaped.
252 verifyFrameRecoverIndices();
254 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
256 visitGlobalVariable(*I);
258 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
260 visitGlobalAlias(*I);
262 for (Module::const_named_metadata_iterator I = M.named_metadata_begin(),
263 E = M.named_metadata_end();
265 visitNamedMDNode(*I);
267 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
268 visitComdat(SMEC.getValue());
271 visitModuleIdents(M);
273 // Verify type referneces last.
280 // Verification methods...
281 void visitGlobalValue(const GlobalValue &GV);
282 void visitGlobalVariable(const GlobalVariable &GV);
283 void visitGlobalAlias(const GlobalAlias &GA);
284 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
285 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
286 const GlobalAlias &A, const Constant &C);
287 void visitNamedMDNode(const NamedMDNode &NMD);
288 void visitMDNode(const MDNode &MD);
289 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
290 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
291 void visitComdat(const Comdat &C);
292 void visitModuleIdents(const Module &M);
293 void visitModuleFlags(const Module &M);
294 void visitModuleFlag(const MDNode *Op,
295 DenseMap<const MDString *, const MDNode *> &SeenIDs,
296 SmallVectorImpl<const MDNode *> &Requirements);
297 void visitFunction(const Function &F);
298 void visitBasicBlock(BasicBlock &BB);
299 void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty);
301 template <class Ty> bool isValidMetadataArray(const MDTuple &N);
302 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
303 #include "llvm/IR/Metadata.def"
304 void visitDIScope(const DIScope &N);
305 void visitDIVariable(const DIVariable &N);
306 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
307 void visitDITemplateParameter(const DITemplateParameter &N);
309 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
311 /// \brief Check for a valid string-based type reference.
313 /// Checks if \c MD is a string-based type reference. If it is, keeps track
314 /// of it (and its user, \c N) for error messages later.
315 bool isValidUUID(const MDNode &N, const Metadata *MD);
317 /// \brief Check for a valid type reference.
319 /// Checks for subclasses of \a DIType, or \a isValidUUID().
320 bool isTypeRef(const MDNode &N, const Metadata *MD);
322 /// \brief Check for a valid scope reference.
324 /// Checks for subclasses of \a DIScope, or \a isValidUUID().
325 bool isScopeRef(const MDNode &N, const Metadata *MD);
327 /// \brief Check for a valid debug info reference.
329 /// Checks for subclasses of \a DINode, or \a isValidUUID().
330 bool isDIRef(const MDNode &N, const Metadata *MD);
332 // InstVisitor overrides...
333 using InstVisitor<Verifier>::visit;
334 void visit(Instruction &I);
336 void visitTruncInst(TruncInst &I);
337 void visitZExtInst(ZExtInst &I);
338 void visitSExtInst(SExtInst &I);
339 void visitFPTruncInst(FPTruncInst &I);
340 void visitFPExtInst(FPExtInst &I);
341 void visitFPToUIInst(FPToUIInst &I);
342 void visitFPToSIInst(FPToSIInst &I);
343 void visitUIToFPInst(UIToFPInst &I);
344 void visitSIToFPInst(SIToFPInst &I);
345 void visitIntToPtrInst(IntToPtrInst &I);
346 void visitPtrToIntInst(PtrToIntInst &I);
347 void visitBitCastInst(BitCastInst &I);
348 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
349 void visitPHINode(PHINode &PN);
350 void visitBinaryOperator(BinaryOperator &B);
351 void visitICmpInst(ICmpInst &IC);
352 void visitFCmpInst(FCmpInst &FC);
353 void visitExtractElementInst(ExtractElementInst &EI);
354 void visitInsertElementInst(InsertElementInst &EI);
355 void visitShuffleVectorInst(ShuffleVectorInst &EI);
356 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
357 void visitCallInst(CallInst &CI);
358 void visitInvokeInst(InvokeInst &II);
359 void visitGetElementPtrInst(GetElementPtrInst &GEP);
360 void visitLoadInst(LoadInst &LI);
361 void visitStoreInst(StoreInst &SI);
362 void verifyDominatesUse(Instruction &I, unsigned i);
363 void visitInstruction(Instruction &I);
364 void visitTerminatorInst(TerminatorInst &I);
365 void visitBranchInst(BranchInst &BI);
366 void visitReturnInst(ReturnInst &RI);
367 void visitSwitchInst(SwitchInst &SI);
368 void visitIndirectBrInst(IndirectBrInst &BI);
369 void visitSelectInst(SelectInst &SI);
370 void visitUserOp1(Instruction &I);
371 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
372 void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS);
373 template <class DbgIntrinsicTy>
374 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
375 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
376 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
377 void visitFenceInst(FenceInst &FI);
378 void visitAllocaInst(AllocaInst &AI);
379 void visitExtractValueInst(ExtractValueInst &EVI);
380 void visitInsertValueInst(InsertValueInst &IVI);
381 void visitLandingPadInst(LandingPadInst &LPI);
383 void VerifyCallSite(CallSite CS);
384 void verifyMustTailCall(CallInst &CI);
385 bool PerformTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
386 unsigned ArgNo, std::string &Suffix);
387 bool VerifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
388 SmallVectorImpl<Type *> &ArgTys);
389 bool VerifyIntrinsicIsVarArg(bool isVarArg,
390 ArrayRef<Intrinsic::IITDescriptor> &Infos);
391 bool VerifyAttributeCount(AttributeSet Attrs, unsigned Params);
392 void VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
394 void VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
395 bool isReturnValue, const Value *V);
396 void VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
398 void VerifyFunctionMetadata(
399 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs);
401 void VerifyConstantExprBitcastType(const ConstantExpr *CE);
402 void VerifyStatepoint(ImmutableCallSite CS);
403 void verifyFrameRecoverIndices();
405 // Module-level debug info verification...
406 void verifyTypeRefs();
407 template <class MapTy>
408 void verifyBitPieceExpression(const DbgInfoIntrinsic &I,
409 const MapTy &TypeRefs);
410 void visitUnresolvedTypeRef(const MDString *S, const MDNode *N);
412 } // End anonymous namespace
414 // Assert - We know that cond should be true, if not print an error message.
415 #define Assert(C, ...) \
416 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
418 void Verifier::visit(Instruction &I) {
419 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
420 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
421 InstVisitor<Verifier>::visit(I);
425 void Verifier::visitGlobalValue(const GlobalValue &GV) {
426 Assert(!GV.isDeclaration() || GV.hasExternalLinkage() ||
427 GV.hasExternalWeakLinkage(),
428 "Global is external, but doesn't have external or weak linkage!", &GV);
430 Assert(GV.getAlignment() <= Value::MaximumAlignment,
431 "huge alignment values are unsupported", &GV);
432 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
433 "Only global variables can have appending linkage!", &GV);
435 if (GV.hasAppendingLinkage()) {
436 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
437 Assert(GVar && GVar->getValueType()->isArrayTy(),
438 "Only global arrays can have appending linkage!", GVar);
441 if (GV.isDeclarationForLinker())
442 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
445 void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
446 if (GV.hasInitializer()) {
447 Assert(GV.getInitializer()->getType() == GV.getType()->getElementType(),
448 "Global variable initializer type does not match global "
452 // If the global has common linkage, it must have a zero initializer and
453 // cannot be constant.
454 if (GV.hasCommonLinkage()) {
455 Assert(GV.getInitializer()->isNullValue(),
456 "'common' global must have a zero initializer!", &GV);
457 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
459 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
462 Assert(GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
463 "invalid linkage type for global declaration", &GV);
466 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
467 GV.getName() == "llvm.global_dtors")) {
468 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
469 "invalid linkage for intrinsic global variable", &GV);
470 // Don't worry about emitting an error for it not being an array,
471 // visitGlobalValue will complain on appending non-array.
472 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
473 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
474 PointerType *FuncPtrTy =
475 FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
476 // FIXME: Reject the 2-field form in LLVM 4.0.
478 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
479 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
480 STy->getTypeAtIndex(1) == FuncPtrTy,
481 "wrong type for intrinsic global variable", &GV);
482 if (STy->getNumElements() == 3) {
483 Type *ETy = STy->getTypeAtIndex(2);
484 Assert(ETy->isPointerTy() &&
485 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
486 "wrong type for intrinsic global variable", &GV);
491 if (GV.hasName() && (GV.getName() == "llvm.used" ||
492 GV.getName() == "llvm.compiler.used")) {
493 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
494 "invalid linkage for intrinsic global variable", &GV);
495 Type *GVType = GV.getValueType();
496 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
497 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
498 Assert(PTy, "wrong type for intrinsic global variable", &GV);
499 if (GV.hasInitializer()) {
500 const Constant *Init = GV.getInitializer();
501 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
502 Assert(InitArray, "wrong initalizer for intrinsic global variable",
504 for (unsigned i = 0, e = InitArray->getNumOperands(); i != e; ++i) {
505 Value *V = Init->getOperand(i)->stripPointerCastsNoFollowAliases();
506 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
508 "invalid llvm.used member", V);
509 Assert(V->hasName(), "members of llvm.used must be named", V);
515 Assert(!GV.hasDLLImportStorageClass() ||
516 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
517 GV.hasAvailableExternallyLinkage(),
518 "Global is marked as dllimport, but not external", &GV);
520 if (!GV.hasInitializer()) {
521 visitGlobalValue(GV);
525 // Walk any aggregate initializers looking for bitcasts between address spaces
526 SmallPtrSet<const Value *, 4> Visited;
527 SmallVector<const Value *, 4> WorkStack;
528 WorkStack.push_back(cast<Value>(GV.getInitializer()));
530 while (!WorkStack.empty()) {
531 const Value *V = WorkStack.pop_back_val();
532 if (!Visited.insert(V).second)
535 if (const User *U = dyn_cast<User>(V)) {
536 WorkStack.append(U->op_begin(), U->op_end());
539 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
540 VerifyConstantExprBitcastType(CE);
546 visitGlobalValue(GV);
549 void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
550 SmallPtrSet<const GlobalAlias*, 4> Visited;
552 visitAliaseeSubExpr(Visited, GA, C);
555 void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
556 const GlobalAlias &GA, const Constant &C) {
557 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
558 Assert(!GV->isDeclaration(), "Alias must point to a definition", &GA);
560 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
561 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
563 Assert(!GA2->mayBeOverridden(), "Alias cannot point to a weak alias",
566 // Only continue verifying subexpressions of GlobalAliases.
567 // Do not recurse into global initializers.
572 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
573 VerifyConstantExprBitcastType(CE);
575 for (const Use &U : C.operands()) {
577 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
578 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
579 else if (const auto *C2 = dyn_cast<Constant>(V))
580 visitAliaseeSubExpr(Visited, GA, *C2);
584 void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
585 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
586 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
587 "weak_odr, or external linkage!",
589 const Constant *Aliasee = GA.getAliasee();
590 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
591 Assert(GA.getType() == Aliasee->getType(),
592 "Alias and aliasee types should match!", &GA);
594 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
595 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
597 visitAliaseeSubExpr(GA, *Aliasee);
599 visitGlobalValue(GA);
602 void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
603 for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i) {
604 MDNode *MD = NMD.getOperand(i);
606 if (NMD.getName() == "llvm.dbg.cu") {
607 Assert(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
617 void Verifier::visitMDNode(const MDNode &MD) {
618 // Only visit each node once. Metadata can be mutually recursive, so this
619 // avoids infinite recursion here, as well as being an optimization.
620 if (!MDNodes.insert(&MD).second)
623 switch (MD.getMetadataID()) {
625 llvm_unreachable("Invalid MDNode subclass");
626 case Metadata::MDTupleKind:
628 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
629 case Metadata::CLASS##Kind: \
630 visit##CLASS(cast<CLASS>(MD)); \
632 #include "llvm/IR/Metadata.def"
635 for (unsigned i = 0, e = MD.getNumOperands(); i != e; ++i) {
636 Metadata *Op = MD.getOperand(i);
639 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
641 if (auto *N = dyn_cast<MDNode>(Op)) {
645 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
646 visitValueAsMetadata(*V, nullptr);
651 // Check these last, so we diagnose problems in operands first.
652 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
653 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
656 void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
657 Assert(MD.getValue(), "Expected valid value", &MD);
658 Assert(!MD.getValue()->getType()->isMetadataTy(),
659 "Unexpected metadata round-trip through values", &MD, MD.getValue());
661 auto *L = dyn_cast<LocalAsMetadata>(&MD);
665 Assert(F, "function-local metadata used outside a function", L);
667 // If this was an instruction, bb, or argument, verify that it is in the
668 // function that we expect.
669 Function *ActualF = nullptr;
670 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
671 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
672 ActualF = I->getParent()->getParent();
673 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
674 ActualF = BB->getParent();
675 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
676 ActualF = A->getParent();
677 assert(ActualF && "Unimplemented function local metadata case!");
679 Assert(ActualF == F, "function-local metadata used in wrong function", L);
682 void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
683 Metadata *MD = MDV.getMetadata();
684 if (auto *N = dyn_cast<MDNode>(MD)) {
689 // Only visit each node once. Metadata can be mutually recursive, so this
690 // avoids infinite recursion here, as well as being an optimization.
691 if (!MDNodes.insert(MD).second)
694 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
695 visitValueAsMetadata(*V, F);
698 bool Verifier::isValidUUID(const MDNode &N, const Metadata *MD) {
699 auto *S = dyn_cast<MDString>(MD);
702 if (S->getString().empty())
705 // Keep track of names of types referenced via UUID so we can check that they
707 UnresolvedTypeRefs.insert(std::make_pair(S, &N));
711 /// \brief Check if a value can be a reference to a type.
712 bool Verifier::isTypeRef(const MDNode &N, const Metadata *MD) {
713 return !MD || isValidUUID(N, MD) || isa<DIType>(MD);
716 /// \brief Check if a value can be a ScopeRef.
717 bool Verifier::isScopeRef(const MDNode &N, const Metadata *MD) {
718 return !MD || isValidUUID(N, MD) || isa<DIScope>(MD);
721 /// \brief Check if a value can be a debug info ref.
722 bool Verifier::isDIRef(const MDNode &N, const Metadata *MD) {
723 return !MD || isValidUUID(N, MD) || isa<DINode>(MD);
727 bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
728 for (Metadata *MD : N.operands()) {
741 bool isValidMetadataArray(const MDTuple &N) {
742 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
746 bool isValidMetadataNullArray(const MDTuple &N) {
747 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
750 void Verifier::visitDILocation(const DILocation &N) {
751 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
752 "location requires a valid scope", &N, N.getRawScope());
753 if (auto *IA = N.getRawInlinedAt())
754 Assert(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
757 void Verifier::visitGenericDINode(const GenericDINode &N) {
758 Assert(N.getTag(), "invalid tag", &N);
761 void Verifier::visitDIScope(const DIScope &N) {
762 if (auto *F = N.getRawFile())
763 Assert(isa<DIFile>(F), "invalid file", &N, F);
766 void Verifier::visitDISubrange(const DISubrange &N) {
767 Assert(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
768 Assert(N.getCount() >= -1, "invalid subrange count", &N);
771 void Verifier::visitDIEnumerator(const DIEnumerator &N) {
772 Assert(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
775 void Verifier::visitDIBasicType(const DIBasicType &N) {
776 Assert(N.getTag() == dwarf::DW_TAG_base_type ||
777 N.getTag() == dwarf::DW_TAG_unspecified_type,
781 void Verifier::visitDIDerivedType(const DIDerivedType &N) {
782 // Common scope checks.
785 Assert(N.getTag() == dwarf::DW_TAG_typedef ||
786 N.getTag() == dwarf::DW_TAG_pointer_type ||
787 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
788 N.getTag() == dwarf::DW_TAG_reference_type ||
789 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
790 N.getTag() == dwarf::DW_TAG_const_type ||
791 N.getTag() == dwarf::DW_TAG_volatile_type ||
792 N.getTag() == dwarf::DW_TAG_restrict_type ||
793 N.getTag() == dwarf::DW_TAG_member ||
794 N.getTag() == dwarf::DW_TAG_inheritance ||
795 N.getTag() == dwarf::DW_TAG_friend,
797 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
798 Assert(isTypeRef(N, N.getExtraData()), "invalid pointer to member type", &N,
802 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
803 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
807 static bool hasConflictingReferenceFlags(unsigned Flags) {
808 return (Flags & DINode::FlagLValueReference) &&
809 (Flags & DINode::FlagRValueReference);
812 void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
813 auto *Params = dyn_cast<MDTuple>(&RawParams);
814 Assert(Params, "invalid template params", &N, &RawParams);
815 for (Metadata *Op : Params->operands()) {
816 Assert(Op && isa<DITemplateParameter>(Op), "invalid template parameter", &N,
821 void Verifier::visitDICompositeType(const DICompositeType &N) {
822 // Common scope checks.
825 Assert(N.getTag() == dwarf::DW_TAG_array_type ||
826 N.getTag() == dwarf::DW_TAG_structure_type ||
827 N.getTag() == dwarf::DW_TAG_union_type ||
828 N.getTag() == dwarf::DW_TAG_enumeration_type ||
829 N.getTag() == dwarf::DW_TAG_class_type,
832 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
833 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
836 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
837 "invalid composite elements", &N, N.getRawElements());
838 Assert(isTypeRef(N, N.getRawVTableHolder()), "invalid vtable holder", &N,
839 N.getRawVTableHolder());
840 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
841 "invalid composite elements", &N, N.getRawElements());
842 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
844 if (auto *Params = N.getRawTemplateParams())
845 visitTemplateParams(N, *Params);
847 if (N.getTag() == dwarf::DW_TAG_class_type ||
848 N.getTag() == dwarf::DW_TAG_union_type) {
849 Assert(N.getFile() && !N.getFile()->getFilename().empty(),
850 "class/union requires a filename", &N, N.getFile());
854 void Verifier::visitDISubroutineType(const DISubroutineType &N) {
855 Assert(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
856 if (auto *Types = N.getRawTypeArray()) {
857 Assert(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
858 for (Metadata *Ty : N.getTypeArray()->operands()) {
859 Assert(isTypeRef(N, Ty), "invalid subroutine type ref", &N, Types, Ty);
862 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
866 void Verifier::visitDIFile(const DIFile &N) {
867 Assert(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
870 void Verifier::visitDICompileUnit(const DICompileUnit &N) {
871 Assert(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
873 // Don't bother verifying the compilation directory or producer string
874 // as those could be empty.
875 Assert(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
877 Assert(!N.getFile()->getFilename().empty(), "invalid filename", &N,
880 if (auto *Array = N.getRawEnumTypes()) {
881 Assert(isa<MDTuple>(Array), "invalid enum list", &N, Array);
882 for (Metadata *Op : N.getEnumTypes()->operands()) {
883 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
884 Assert(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
885 "invalid enum type", &N, N.getEnumTypes(), Op);
888 if (auto *Array = N.getRawRetainedTypes()) {
889 Assert(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
890 for (Metadata *Op : N.getRetainedTypes()->operands()) {
891 Assert(Op && isa<DIType>(Op), "invalid retained type", &N, Op);
894 if (auto *Array = N.getRawSubprograms()) {
895 Assert(isa<MDTuple>(Array), "invalid subprogram list", &N, Array);
896 for (Metadata *Op : N.getSubprograms()->operands()) {
897 Assert(Op && isa<DISubprogram>(Op), "invalid subprogram ref", &N, Op);
900 if (auto *Array = N.getRawGlobalVariables()) {
901 Assert(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
902 for (Metadata *Op : N.getGlobalVariables()->operands()) {
903 Assert(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref", &N,
907 if (auto *Array = N.getRawImportedEntities()) {
908 Assert(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
909 for (Metadata *Op : N.getImportedEntities()->operands()) {
910 Assert(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref", &N,
916 void Verifier::visitDISubprogram(const DISubprogram &N) {
917 Assert(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
918 Assert(isScopeRef(N, N.getRawScope()), "invalid scope", &N, N.getRawScope());
919 if (auto *T = N.getRawType())
920 Assert(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
921 Assert(isTypeRef(N, N.getRawContainingType()), "invalid containing type", &N,
922 N.getRawContainingType());
923 if (auto *RawF = N.getRawFunction()) {
924 auto *FMD = dyn_cast<ConstantAsMetadata>(RawF);
925 auto *F = FMD ? FMD->getValue() : nullptr;
926 auto *FT = F ? dyn_cast<PointerType>(F->getType()) : nullptr;
927 Assert(F && FT && isa<FunctionType>(FT->getElementType()),
928 "invalid function", &N, F, FT);
930 if (auto *Params = N.getRawTemplateParams())
931 visitTemplateParams(N, *Params);
932 if (auto *S = N.getRawDeclaration()) {
933 Assert(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
934 "invalid subprogram declaration", &N, S);
936 if (auto *RawVars = N.getRawVariables()) {
937 auto *Vars = dyn_cast<MDTuple>(RawVars);
938 Assert(Vars, "invalid variable list", &N, RawVars);
939 for (Metadata *Op : Vars->operands()) {
940 Assert(Op && isa<DILocalVariable>(Op), "invalid local variable", &N, Vars,
944 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
947 auto *F = N.getFunction();
951 // Check that all !dbg attachments lead to back to N (or, at least, another
952 // subprogram that describes the same function).
954 // FIXME: Check this incrementally while visiting !dbg attachments.
955 // FIXME: Only check when N is the canonical subprogram for F.
956 SmallPtrSet<const MDNode *, 32> Seen;
959 // Be careful about using DILocation here since we might be dealing with
960 // broken code (this is the Verifier after all).
962 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
965 if (!Seen.insert(DL).second)
968 DILocalScope *Scope = DL->getInlinedAtScope();
969 if (Scope && !Seen.insert(Scope).second)
972 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
973 if (SP && !Seen.insert(SP).second)
976 // FIXME: Once N is canonical, check "SP == &N".
977 Assert(SP->describes(F),
978 "!dbg attachment points at wrong subprogram for function", &N, F,
983 void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
984 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
985 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
986 "invalid local scope", &N, N.getRawScope());
989 void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
990 visitDILexicalBlockBase(N);
992 Assert(N.getLine() || !N.getColumn(),
993 "cannot have column info without line info", &N);
996 void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
997 visitDILexicalBlockBase(N);
1000 void Verifier::visitDINamespace(const DINamespace &N) {
1001 Assert(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
1002 if (auto *S = N.getRawScope())
1003 Assert(isa<DIScope>(S), "invalid scope ref", &N, S);
1006 void Verifier::visitDIModule(const DIModule &N) {
1007 Assert(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1008 Assert(!N.getName().empty(), "anonymous module", &N);
1011 void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
1012 Assert(isTypeRef(N, N.getType()), "invalid type ref", &N, N.getType());
1015 void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1016 visitDITemplateParameter(N);
1018 Assert(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1022 void Verifier::visitDITemplateValueParameter(
1023 const DITemplateValueParameter &N) {
1024 visitDITemplateParameter(N);
1026 Assert(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1027 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1028 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1032 void Verifier::visitDIVariable(const DIVariable &N) {
1033 if (auto *S = N.getRawScope())
1034 Assert(isa<DIScope>(S), "invalid scope", &N, S);
1035 Assert(isTypeRef(N, N.getRawType()), "invalid type ref", &N, N.getRawType());
1036 if (auto *F = N.getRawFile())
1037 Assert(isa<DIFile>(F), "invalid file", &N, F);
1040 void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
1041 // Checks common to all variables.
1044 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1045 Assert(!N.getName().empty(), "missing global variable name", &N);
1046 if (auto *V = N.getRawVariable()) {
1047 Assert(isa<ConstantAsMetadata>(V) &&
1048 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
1049 "invalid global varaible ref", &N, V);
1051 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
1052 Assert(isa<DIDerivedType>(Member), "invalid static data member declaration",
1057 void Verifier::visitDILocalVariable(const DILocalVariable &N) {
1058 // Checks common to all variables.
1061 Assert(N.getTag() == dwarf::DW_TAG_auto_variable ||
1062 N.getTag() == dwarf::DW_TAG_arg_variable,
1064 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1065 "local variable requires a valid scope", &N, N.getRawScope());
1066 Assert(bool(N.getArg()) == (N.getTag() == dwarf::DW_TAG_arg_variable),
1067 "local variable should have arg iff it's a DW_TAG_arg_variable", &N);
1070 void Verifier::visitDIExpression(const DIExpression &N) {
1071 Assert(N.isValid(), "invalid expression", &N);
1074 void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
1075 Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
1076 if (auto *T = N.getRawType())
1077 Assert(isTypeRef(N, T), "invalid type ref", &N, T);
1078 if (auto *F = N.getRawFile())
1079 Assert(isa<DIFile>(F), "invalid file", &N, F);
1082 void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
1083 Assert(N.getTag() == dwarf::DW_TAG_imported_module ||
1084 N.getTag() == dwarf::DW_TAG_imported_declaration,
1086 if (auto *S = N.getRawScope())
1087 Assert(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1088 Assert(isDIRef(N, N.getEntity()), "invalid imported entity", &N,
1092 void Verifier::visitComdat(const Comdat &C) {
1093 // The Module is invalid if the GlobalValue has private linkage. Entities
1094 // with private linkage don't have entries in the symbol table.
1095 if (const GlobalValue *GV = M->getNamedValue(C.getName()))
1096 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1100 void Verifier::visitModuleIdents(const Module &M) {
1101 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1105 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1106 // Scan each llvm.ident entry and make sure that this requirement is met.
1107 for (unsigned i = 0, e = Idents->getNumOperands(); i != e; ++i) {
1108 const MDNode *N = Idents->getOperand(i);
1109 Assert(N->getNumOperands() == 1,
1110 "incorrect number of operands in llvm.ident metadata", N);
1111 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1112 ("invalid value for llvm.ident metadata entry operand"
1113 "(the operand should be a string)"),
1118 void Verifier::visitModuleFlags(const Module &M) {
1119 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1122 // Scan each flag, and track the flags and requirements.
1123 DenseMap<const MDString*, const MDNode*> SeenIDs;
1124 SmallVector<const MDNode*, 16> Requirements;
1125 for (unsigned I = 0, E = Flags->getNumOperands(); I != E; ++I) {
1126 visitModuleFlag(Flags->getOperand(I), SeenIDs, Requirements);
1129 // Validate that the requirements in the module are valid.
1130 for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
1131 const MDNode *Requirement = Requirements[I];
1132 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
1133 const Metadata *ReqValue = Requirement->getOperand(1);
1135 const MDNode *Op = SeenIDs.lookup(Flag);
1137 CheckFailed("invalid requirement on flag, flag is not present in module",
1142 if (Op->getOperand(2) != ReqValue) {
1143 CheckFailed(("invalid requirement on flag, "
1144 "flag does not have the required value"),
1152 Verifier::visitModuleFlag(const MDNode *Op,
1153 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1154 SmallVectorImpl<const MDNode *> &Requirements) {
1155 // Each module flag should have three arguments, the merge behavior (a
1156 // constant int), the flag ID (an MDString), and the value.
1157 Assert(Op->getNumOperands() == 3,
1158 "incorrect number of operands in module flag", Op);
1159 Module::ModFlagBehavior MFB;
1160 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
1162 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
1163 "invalid behavior operand in module flag (expected constant integer)",
1166 "invalid behavior operand in module flag (unexpected constant)",
1169 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
1170 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1173 // Sanity check the values for behaviors with additional requirements.
1176 case Module::Warning:
1177 case Module::Override:
1178 // These behavior types accept any value.
1181 case Module::Require: {
1182 // The value should itself be an MDNode with two operands, a flag ID (an
1183 // MDString), and a value.
1184 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
1185 Assert(Value && Value->getNumOperands() == 2,
1186 "invalid value for 'require' module flag (expected metadata pair)",
1188 Assert(isa<MDString>(Value->getOperand(0)),
1189 ("invalid value for 'require' module flag "
1190 "(first value operand should be a string)"),
1191 Value->getOperand(0));
1193 // Append it to the list of requirements, to check once all module flags are
1195 Requirements.push_back(Value);
1199 case Module::Append:
1200 case Module::AppendUnique: {
1201 // These behavior types require the operand be an MDNode.
1202 Assert(isa<MDNode>(Op->getOperand(2)),
1203 "invalid value for 'append'-type module flag "
1204 "(expected a metadata node)",
1210 // Unless this is a "requires" flag, check the ID is unique.
1211 if (MFB != Module::Require) {
1212 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
1214 "module flag identifiers must be unique (or of 'require' type)", ID);
1218 void Verifier::VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
1219 bool isFunction, const Value *V) {
1220 unsigned Slot = ~0U;
1221 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1222 if (Attrs.getSlotIndex(I) == Idx) {
1227 assert(Slot != ~0U && "Attribute set inconsistency!");
1229 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1231 if (I->isStringAttribute())
1234 if (I->getKindAsEnum() == Attribute::NoReturn ||
1235 I->getKindAsEnum() == Attribute::NoUnwind ||
1236 I->getKindAsEnum() == Attribute::NoInline ||
1237 I->getKindAsEnum() == Attribute::AlwaysInline ||
1238 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1239 I->getKindAsEnum() == Attribute::StackProtect ||
1240 I->getKindAsEnum() == Attribute::StackProtectReq ||
1241 I->getKindAsEnum() == Attribute::StackProtectStrong ||
1242 I->getKindAsEnum() == Attribute::SafeStack ||
1243 I->getKindAsEnum() == Attribute::NoRedZone ||
1244 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1245 I->getKindAsEnum() == Attribute::Naked ||
1246 I->getKindAsEnum() == Attribute::InlineHint ||
1247 I->getKindAsEnum() == Attribute::StackAlignment ||
1248 I->getKindAsEnum() == Attribute::UWTable ||
1249 I->getKindAsEnum() == Attribute::NonLazyBind ||
1250 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1251 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1252 I->getKindAsEnum() == Attribute::SanitizeThread ||
1253 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1254 I->getKindAsEnum() == Attribute::MinSize ||
1255 I->getKindAsEnum() == Attribute::NoDuplicate ||
1256 I->getKindAsEnum() == Attribute::Builtin ||
1257 I->getKindAsEnum() == Attribute::NoBuiltin ||
1258 I->getKindAsEnum() == Attribute::Cold ||
1259 I->getKindAsEnum() == Attribute::OptimizeNone ||
1260 I->getKindAsEnum() == Attribute::JumpTable ||
1261 I->getKindAsEnum() == Attribute::Convergent ||
1262 I->getKindAsEnum() == Attribute::ArgMemOnly) {
1264 CheckFailed("Attribute '" + I->getAsString() +
1265 "' only applies to functions!", V);
1268 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
1269 I->getKindAsEnum() == Attribute::ReadNone) {
1271 CheckFailed("Attribute '" + I->getAsString() +
1272 "' does not apply to function returns");
1275 } else if (isFunction) {
1276 CheckFailed("Attribute '" + I->getAsString() +
1277 "' does not apply to functions!", V);
1283 // VerifyParameterAttrs - Check the given attributes for an argument or return
1284 // value of the specified type. The value V is printed in error messages.
1285 void Verifier::VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
1286 bool isReturnValue, const Value *V) {
1287 if (!Attrs.hasAttributes(Idx))
1290 VerifyAttributeTypes(Attrs, Idx, false, V);
1293 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1294 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1295 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1296 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1297 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
1298 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1299 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', and "
1300 "'returned' do not apply to return values!",
1303 // Check for mutually incompatible attributes. Only inreg is compatible with
1305 unsigned AttrCount = 0;
1306 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1307 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1308 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1309 Attrs.hasAttribute(Idx, Attribute::InReg);
1310 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
1311 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1312 "and 'sret' are incompatible!",
1315 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1316 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1318 "'inalloca and readonly' are incompatible!",
1321 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1322 Attrs.hasAttribute(Idx, Attribute::Returned)),
1324 "'sret and returned' are incompatible!",
1327 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1328 Attrs.hasAttribute(Idx, Attribute::SExt)),
1330 "'zeroext and signext' are incompatible!",
1333 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1334 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1336 "'readnone and readonly' are incompatible!",
1339 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1340 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1342 "'noinline and alwaysinline' are incompatible!",
1345 Assert(!AttrBuilder(Attrs, Idx)
1346 .overlaps(AttributeFuncs::typeIncompatible(Ty)),
1347 "Wrong types for attribute: " +
1348 AttributeSet::get(*Context, Idx,
1349 AttributeFuncs::typeIncompatible(Ty)).getAsString(Idx),
1352 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
1353 SmallPtrSet<const Type*, 4> Visited;
1354 if (!PTy->getElementType()->isSized(&Visited)) {
1355 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1356 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1357 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1361 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1362 "Attribute 'byval' only applies to parameters with pointer type!",
1367 // VerifyFunctionAttrs - Check parameter attributes against a function type.
1368 // The value V is printed in error messages.
1369 void Verifier::VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
1371 if (Attrs.isEmpty())
1374 bool SawNest = false;
1375 bool SawReturned = false;
1376 bool SawSRet = false;
1378 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
1379 unsigned Idx = Attrs.getSlotIndex(i);
1383 Ty = FT->getReturnType();
1384 else if (Idx-1 < FT->getNumParams())
1385 Ty = FT->getParamType(Idx-1);
1387 break; // VarArgs attributes, verified elsewhere.
1389 VerifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
1394 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
1395 Assert(!SawNest, "More than one parameter has attribute nest!", V);
1399 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
1400 Assert(!SawReturned, "More than one parameter has attribute returned!",
1402 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1404 "argument and return types for 'returned' attribute",
1409 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
1410 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1411 Assert(Idx == 1 || Idx == 2,
1412 "Attribute 'sret' is not on first or second parameter!", V);
1416 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
1417 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1422 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1425 VerifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
1428 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1429 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1430 "Attributes 'readnone and readonly' are incompatible!", V);
1433 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1434 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1435 Attribute::AlwaysInline)),
1436 "Attributes 'noinline and alwaysinline' are incompatible!", V);
1438 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1439 Attribute::OptimizeNone)) {
1440 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1441 "Attribute 'optnone' requires 'noinline'!", V);
1443 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1444 Attribute::OptimizeForSize),
1445 "Attributes 'optsize and optnone' are incompatible!", V);
1447 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1448 "Attributes 'minsize and optnone' are incompatible!", V);
1451 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1452 Attribute::JumpTable)) {
1453 const GlobalValue *GV = cast<GlobalValue>(V);
1454 Assert(GV->hasUnnamedAddr(),
1455 "Attribute 'jumptable' requires 'unnamed_addr'", V);
1459 void Verifier::VerifyFunctionMetadata(
1460 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs) {
1464 for (unsigned i = 0; i < MDs.size(); i++) {
1465 if (MDs[i].first == LLVMContext::MD_prof) {
1466 MDNode *MD = MDs[i].second;
1467 Assert(MD->getNumOperands() == 2,
1468 "!prof annotations should have exactly 2 operands", MD);
1470 // Check first operand.
1471 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1473 Assert(isa<MDString>(MD->getOperand(0)),
1474 "expected string with name of the !prof annotation", MD);
1475 MDString *MDS = cast<MDString>(MD->getOperand(0));
1476 StringRef ProfName = MDS->getString();
1477 Assert(ProfName.equals("function_entry_count"),
1478 "first operand should be 'function_entry_count'", MD);
1480 // Check second operand.
1481 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1483 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1484 "expected integer argument to function_entry_count", MD);
1489 void Verifier::VerifyConstantExprBitcastType(const ConstantExpr *CE) {
1490 if (CE->getOpcode() != Instruction::BitCast)
1493 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1495 "Invalid bitcast", CE);
1498 bool Verifier::VerifyAttributeCount(AttributeSet Attrs, unsigned Params) {
1499 if (Attrs.getNumSlots() == 0)
1502 unsigned LastSlot = Attrs.getNumSlots() - 1;
1503 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
1504 if (LastIndex <= Params
1505 || (LastIndex == AttributeSet::FunctionIndex
1506 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
1512 /// \brief Verify that statepoint intrinsic is well formed.
1513 void Verifier::VerifyStatepoint(ImmutableCallSite CS) {
1514 assert(CS.getCalledFunction() &&
1515 CS.getCalledFunction()->getIntrinsicID() ==
1516 Intrinsic::experimental_gc_statepoint);
1518 const Instruction &CI = *CS.getInstruction();
1520 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1521 !CS.onlyAccessesArgMemory(),
1522 "gc.statepoint must read and write all memory to preserve "
1523 "reordering restrictions required by safepoint semantics",
1526 const Value *IDV = CS.getArgument(0);
1527 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1530 const Value *NumPatchBytesV = CS.getArgument(1);
1531 Assert(isa<ConstantInt>(NumPatchBytesV),
1532 "gc.statepoint number of patchable bytes must be a constant integer",
1534 const int64_t NumPatchBytes =
1535 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1536 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1537 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1541 const Value *Target = CS.getArgument(2);
1542 const PointerType *PT = dyn_cast<PointerType>(Target->getType());
1543 Assert(PT && PT->getElementType()->isFunctionTy(),
1544 "gc.statepoint callee must be of function pointer type", &CI, Target);
1545 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
1548 Assert(isa<ConstantPointerNull>(Target->stripPointerCasts()),
1549 "gc.statepoint must have null as call target if number of patchable "
1550 "bytes is non zero",
1553 const Value *NumCallArgsV = CS.getArgument(3);
1554 Assert(isa<ConstantInt>(NumCallArgsV),
1555 "gc.statepoint number of arguments to underlying call "
1556 "must be constant integer",
1558 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
1559 Assert(NumCallArgs >= 0,
1560 "gc.statepoint number of arguments to underlying call "
1563 const int NumParams = (int)TargetFuncType->getNumParams();
1564 if (TargetFuncType->isVarArg()) {
1565 Assert(NumCallArgs >= NumParams,
1566 "gc.statepoint mismatch in number of vararg call args", &CI);
1568 // TODO: Remove this limitation
1569 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1570 "gc.statepoint doesn't support wrapping non-void "
1571 "vararg functions yet",
1574 Assert(NumCallArgs == NumParams,
1575 "gc.statepoint mismatch in number of call args", &CI);
1577 const Value *FlagsV = CS.getArgument(4);
1578 Assert(isa<ConstantInt>(FlagsV),
1579 "gc.statepoint flags must be constant integer", &CI);
1580 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1581 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1582 "unknown flag used in gc.statepoint flags argument", &CI);
1584 // Verify that the types of the call parameter arguments match
1585 // the type of the wrapped callee.
1586 for (int i = 0; i < NumParams; i++) {
1587 Type *ParamType = TargetFuncType->getParamType(i);
1588 Type *ArgType = CS.getArgument(5 + i)->getType();
1589 Assert(ArgType == ParamType,
1590 "gc.statepoint call argument does not match wrapped "
1595 const int EndCallArgsInx = 4 + NumCallArgs;
1597 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1598 Assert(isa<ConstantInt>(NumTransitionArgsV),
1599 "gc.statepoint number of transition arguments "
1600 "must be constant integer",
1602 const int NumTransitionArgs =
1603 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1604 Assert(NumTransitionArgs >= 0,
1605 "gc.statepoint number of transition arguments must be positive", &CI);
1606 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1608 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
1609 Assert(isa<ConstantInt>(NumDeoptArgsV),
1610 "gc.statepoint number of deoptimization arguments "
1611 "must be constant integer",
1613 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
1614 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1618 const int ExpectedNumArgs =
1619 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
1620 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
1621 "gc.statepoint too few arguments according to length fields", &CI);
1623 // Check that the only uses of this gc.statepoint are gc.result or
1624 // gc.relocate calls which are tied to this statepoint and thus part
1625 // of the same statepoint sequence
1626 for (const User *U : CI.users()) {
1627 const CallInst *Call = dyn_cast<const CallInst>(U);
1628 Assert(Call, "illegal use of statepoint token", &CI, U);
1629 if (!Call) continue;
1630 Assert(isGCRelocate(Call) || isGCResult(Call),
1631 "gc.result or gc.relocate are the only value uses"
1632 "of a gc.statepoint",
1634 if (isGCResult(Call)) {
1635 Assert(Call->getArgOperand(0) == &CI,
1636 "gc.result connected to wrong gc.statepoint", &CI, Call);
1637 } else if (isGCRelocate(Call)) {
1638 Assert(Call->getArgOperand(0) == &CI,
1639 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
1643 // Note: It is legal for a single derived pointer to be listed multiple
1644 // times. It's non-optimal, but it is legal. It can also happen after
1645 // insertion if we strip a bitcast away.
1646 // Note: It is really tempting to check that each base is relocated and
1647 // that a derived pointer is never reused as a base pointer. This turns
1648 // out to be problematic since optimizations run after safepoint insertion
1649 // can recognize equality properties that the insertion logic doesn't know
1650 // about. See example statepoint.ll in the verifier subdirectory
1653 void Verifier::verifyFrameRecoverIndices() {
1654 for (auto &Counts : FrameEscapeInfo) {
1655 Function *F = Counts.first;
1656 unsigned EscapedObjectCount = Counts.second.first;
1657 unsigned MaxRecoveredIndex = Counts.second.second;
1658 Assert(MaxRecoveredIndex <= EscapedObjectCount,
1659 "all indices passed to llvm.localrecover must be less than the "
1660 "number of arguments passed ot llvm.localescape in the parent "
1666 // visitFunction - Verify that a function is ok.
1668 void Verifier::visitFunction(const Function &F) {
1669 // Check function arguments.
1670 FunctionType *FT = F.getFunctionType();
1671 unsigned NumArgs = F.arg_size();
1673 Assert(Context == &F.getContext(),
1674 "Function context does not match Module context!", &F);
1676 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1677 Assert(FT->getNumParams() == NumArgs,
1678 "# formal arguments must match # of arguments for function type!", &F,
1680 Assert(F.getReturnType()->isFirstClassType() ||
1681 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1682 "Functions cannot return aggregate values!", &F);
1684 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1685 "Invalid struct return type!", &F);
1687 AttributeSet Attrs = F.getAttributes();
1689 Assert(VerifyAttributeCount(Attrs, FT->getNumParams()),
1690 "Attribute after last parameter!", &F);
1692 // Check function attributes.
1693 VerifyFunctionAttrs(FT, Attrs, &F);
1695 // On function declarations/definitions, we do not support the builtin
1696 // attribute. We do not check this in VerifyFunctionAttrs since that is
1697 // checking for Attributes that can/can not ever be on functions.
1698 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1699 "Attribute 'builtin' can only be applied to a callsite.", &F);
1701 // Check that this function meets the restrictions on this calling convention.
1702 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1703 // restrictions can be lifted.
1704 switch (F.getCallingConv()) {
1706 case CallingConv::C:
1708 case CallingConv::Fast:
1709 case CallingConv::Cold:
1710 case CallingConv::Intel_OCL_BI:
1711 case CallingConv::PTX_Kernel:
1712 case CallingConv::PTX_Device:
1713 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1714 "perfect forwarding!",
1719 bool isLLVMdotName = F.getName().size() >= 5 &&
1720 F.getName().substr(0, 5) == "llvm.";
1722 // Check that the argument values match the function type for this function...
1724 for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E;
1726 Assert(I->getType() == FT->getParamType(i),
1727 "Argument value does not match function argument type!", I,
1728 FT->getParamType(i));
1729 Assert(I->getType()->isFirstClassType(),
1730 "Function arguments must have first-class types!", I);
1732 Assert(!I->getType()->isMetadataTy(),
1733 "Function takes metadata but isn't an intrinsic", I, &F);
1736 // Get the function metadata attachments.
1737 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1738 F.getAllMetadata(MDs);
1739 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
1740 VerifyFunctionMetadata(MDs);
1742 if (F.isMaterializable()) {
1743 // Function has a body somewhere we can't see.
1744 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
1745 MDs.empty() ? nullptr : MDs.front().second);
1746 } else if (F.isDeclaration()) {
1747 Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1748 "invalid linkage type for function declaration", &F);
1749 Assert(MDs.empty(), "function without a body cannot have metadata", &F,
1750 MDs.empty() ? nullptr : MDs.front().second);
1751 Assert(!F.hasPersonalityFn(),
1752 "Function declaration shouldn't have a personality routine", &F);
1754 // Verify that this function (which has a body) is not named "llvm.*". It
1755 // is not legal to define intrinsics.
1756 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
1758 // Check the entry node
1759 const BasicBlock *Entry = &F.getEntryBlock();
1760 Assert(pred_empty(Entry),
1761 "Entry block to function must not have predecessors!", Entry);
1763 // The address of the entry block cannot be taken, unless it is dead.
1764 if (Entry->hasAddressTaken()) {
1765 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1766 "blockaddress may not be used with the entry block!", Entry);
1769 // Visit metadata attachments.
1770 for (const auto &I : MDs)
1771 visitMDNode(*I.second);
1774 // If this function is actually an intrinsic, verify that it is only used in
1775 // direct call/invokes, never having its "address taken".
1776 if (F.getIntrinsicID()) {
1778 if (F.hasAddressTaken(&U))
1779 Assert(0, "Invalid user of intrinsic instruction!", U);
1782 Assert(!F.hasDLLImportStorageClass() ||
1783 (F.isDeclaration() && F.hasExternalLinkage()) ||
1784 F.hasAvailableExternallyLinkage(),
1785 "Function is marked as dllimport, but not external.", &F);
1788 // verifyBasicBlock - Verify that a basic block is well formed...
1790 void Verifier::visitBasicBlock(BasicBlock &BB) {
1791 InstsInThisBlock.clear();
1793 // Ensure that basic blocks have terminators!
1794 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
1796 // Check constraints that this basic block imposes on all of the PHI nodes in
1798 if (isa<PHINode>(BB.front())) {
1799 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
1800 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
1801 std::sort(Preds.begin(), Preds.end());
1803 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
1804 // Ensure that PHI nodes have at least one entry!
1805 Assert(PN->getNumIncomingValues() != 0,
1806 "PHI nodes must have at least one entry. If the block is dead, "
1807 "the PHI should be removed!",
1809 Assert(PN->getNumIncomingValues() == Preds.size(),
1810 "PHINode should have one entry for each predecessor of its "
1811 "parent basic block!",
1814 // Get and sort all incoming values in the PHI node...
1816 Values.reserve(PN->getNumIncomingValues());
1817 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1818 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
1819 PN->getIncomingValue(i)));
1820 std::sort(Values.begin(), Values.end());
1822 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
1823 // Check to make sure that if there is more than one entry for a
1824 // particular basic block in this PHI node, that the incoming values are
1827 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
1828 Values[i].second == Values[i - 1].second,
1829 "PHI node has multiple entries for the same basic block with "
1830 "different incoming values!",
1831 PN, Values[i].first, Values[i].second, Values[i - 1].second);
1833 // Check to make sure that the predecessors and PHI node entries are
1835 Assert(Values[i].first == Preds[i],
1836 "PHI node entries do not match predecessors!", PN,
1837 Values[i].first, Preds[i]);
1842 // Check that all instructions have their parent pointers set up correctly.
1845 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
1849 void Verifier::visitTerminatorInst(TerminatorInst &I) {
1850 // Ensure that terminators only exist at the end of the basic block.
1851 Assert(&I == I.getParent()->getTerminator(),
1852 "Terminator found in the middle of a basic block!", I.getParent());
1853 visitInstruction(I);
1856 void Verifier::visitBranchInst(BranchInst &BI) {
1857 if (BI.isConditional()) {
1858 Assert(BI.getCondition()->getType()->isIntegerTy(1),
1859 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
1861 visitTerminatorInst(BI);
1864 void Verifier::visitReturnInst(ReturnInst &RI) {
1865 Function *F = RI.getParent()->getParent();
1866 unsigned N = RI.getNumOperands();
1867 if (F->getReturnType()->isVoidTy())
1869 "Found return instr that returns non-void in Function of void "
1871 &RI, F->getReturnType());
1873 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
1874 "Function return type does not match operand "
1875 "type of return inst!",
1876 &RI, F->getReturnType());
1878 // Check to make sure that the return value has necessary properties for
1880 visitTerminatorInst(RI);
1883 void Verifier::visitSwitchInst(SwitchInst &SI) {
1884 // Check to make sure that all of the constants in the switch instruction
1885 // have the same type as the switched-on value.
1886 Type *SwitchTy = SI.getCondition()->getType();
1887 SmallPtrSet<ConstantInt*, 32> Constants;
1888 for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end(); i != e; ++i) {
1889 Assert(i.getCaseValue()->getType() == SwitchTy,
1890 "Switch constants must all be same type as switch value!", &SI);
1891 Assert(Constants.insert(i.getCaseValue()).second,
1892 "Duplicate integer as switch case", &SI, i.getCaseValue());
1895 visitTerminatorInst(SI);
1898 void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
1899 Assert(BI.getAddress()->getType()->isPointerTy(),
1900 "Indirectbr operand must have pointer type!", &BI);
1901 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
1902 Assert(BI.getDestination(i)->getType()->isLabelTy(),
1903 "Indirectbr destinations must all have pointer type!", &BI);
1905 visitTerminatorInst(BI);
1908 void Verifier::visitSelectInst(SelectInst &SI) {
1909 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
1911 "Invalid operands for select instruction!", &SI);
1913 Assert(SI.getTrueValue()->getType() == SI.getType(),
1914 "Select values must have same type as select instruction!", &SI);
1915 visitInstruction(SI);
1918 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
1919 /// a pass, if any exist, it's an error.
1921 void Verifier::visitUserOp1(Instruction &I) {
1922 Assert(0, "User-defined operators should not live outside of a pass!", &I);
1925 void Verifier::visitTruncInst(TruncInst &I) {
1926 // Get the source and destination types
1927 Type *SrcTy = I.getOperand(0)->getType();
1928 Type *DestTy = I.getType();
1930 // Get the size of the types in bits, we'll need this later
1931 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1932 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1934 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
1935 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
1936 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1937 "trunc source and destination must both be a vector or neither", &I);
1938 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
1940 visitInstruction(I);
1943 void Verifier::visitZExtInst(ZExtInst &I) {
1944 // Get the source and destination types
1945 Type *SrcTy = I.getOperand(0)->getType();
1946 Type *DestTy = I.getType();
1948 // Get the size of the types in bits, we'll need this later
1949 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
1950 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
1951 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1952 "zext source and destination must both be a vector or neither", &I);
1953 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1954 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1956 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
1958 visitInstruction(I);
1961 void Verifier::visitSExtInst(SExtInst &I) {
1962 // Get the source and destination types
1963 Type *SrcTy = I.getOperand(0)->getType();
1964 Type *DestTy = I.getType();
1966 // Get the size of the types in bits, we'll need this later
1967 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1968 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1970 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
1971 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
1972 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1973 "sext source and destination must both be a vector or neither", &I);
1974 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
1976 visitInstruction(I);
1979 void Verifier::visitFPTruncInst(FPTruncInst &I) {
1980 // Get the source and destination types
1981 Type *SrcTy = I.getOperand(0)->getType();
1982 Type *DestTy = I.getType();
1983 // Get the size of the types in bits, we'll need this later
1984 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1985 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1987 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
1988 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
1989 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1990 "fptrunc source and destination must both be a vector or neither", &I);
1991 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
1993 visitInstruction(I);
1996 void Verifier::visitFPExtInst(FPExtInst &I) {
1997 // Get the source and destination types
1998 Type *SrcTy = I.getOperand(0)->getType();
1999 Type *DestTy = I.getType();
2001 // Get the size of the types in bits, we'll need this later
2002 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2003 unsigned DestBitSize = DestTy->getScalarSizeInBits();
2005 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2006 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2007 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2008 "fpext source and destination must both be a vector or neither", &I);
2009 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
2011 visitInstruction(I);
2014 void Verifier::visitUIToFPInst(UIToFPInst &I) {
2015 // Get the source and destination types
2016 Type *SrcTy = I.getOperand(0)->getType();
2017 Type *DestTy = I.getType();
2019 bool SrcVec = SrcTy->isVectorTy();
2020 bool DstVec = DestTy->isVectorTy();
2022 Assert(SrcVec == DstVec,
2023 "UIToFP source and dest must both be vector or scalar", &I);
2024 Assert(SrcTy->isIntOrIntVectorTy(),
2025 "UIToFP source must be integer or integer vector", &I);
2026 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2029 if (SrcVec && DstVec)
2030 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2031 cast<VectorType>(DestTy)->getNumElements(),
2032 "UIToFP source and dest vector length mismatch", &I);
2034 visitInstruction(I);
2037 void Verifier::visitSIToFPInst(SIToFPInst &I) {
2038 // Get the source and destination types
2039 Type *SrcTy = I.getOperand(0)->getType();
2040 Type *DestTy = I.getType();
2042 bool SrcVec = SrcTy->isVectorTy();
2043 bool DstVec = DestTy->isVectorTy();
2045 Assert(SrcVec == DstVec,
2046 "SIToFP source and dest must both be vector or scalar", &I);
2047 Assert(SrcTy->isIntOrIntVectorTy(),
2048 "SIToFP source must be integer or integer vector", &I);
2049 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2052 if (SrcVec && DstVec)
2053 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2054 cast<VectorType>(DestTy)->getNumElements(),
2055 "SIToFP source and dest vector length mismatch", &I);
2057 visitInstruction(I);
2060 void Verifier::visitFPToUIInst(FPToUIInst &I) {
2061 // Get the source and destination types
2062 Type *SrcTy = I.getOperand(0)->getType();
2063 Type *DestTy = I.getType();
2065 bool SrcVec = SrcTy->isVectorTy();
2066 bool DstVec = DestTy->isVectorTy();
2068 Assert(SrcVec == DstVec,
2069 "FPToUI source and dest must both be vector or scalar", &I);
2070 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2072 Assert(DestTy->isIntOrIntVectorTy(),
2073 "FPToUI result must be integer or integer vector", &I);
2075 if (SrcVec && DstVec)
2076 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2077 cast<VectorType>(DestTy)->getNumElements(),
2078 "FPToUI source and dest vector length mismatch", &I);
2080 visitInstruction(I);
2083 void Verifier::visitFPToSIInst(FPToSIInst &I) {
2084 // Get the source and destination types
2085 Type *SrcTy = I.getOperand(0)->getType();
2086 Type *DestTy = I.getType();
2088 bool SrcVec = SrcTy->isVectorTy();
2089 bool DstVec = DestTy->isVectorTy();
2091 Assert(SrcVec == DstVec,
2092 "FPToSI source and dest must both be vector or scalar", &I);
2093 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2095 Assert(DestTy->isIntOrIntVectorTy(),
2096 "FPToSI result must be integer or integer vector", &I);
2098 if (SrcVec && DstVec)
2099 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2100 cast<VectorType>(DestTy)->getNumElements(),
2101 "FPToSI source and dest vector length mismatch", &I);
2103 visitInstruction(I);
2106 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2107 // Get the source and destination types
2108 Type *SrcTy = I.getOperand(0)->getType();
2109 Type *DestTy = I.getType();
2111 Assert(SrcTy->getScalarType()->isPointerTy(),
2112 "PtrToInt source must be pointer", &I);
2113 Assert(DestTy->getScalarType()->isIntegerTy(),
2114 "PtrToInt result must be integral", &I);
2115 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2118 if (SrcTy->isVectorTy()) {
2119 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2120 VectorType *VDest = dyn_cast<VectorType>(DestTy);
2121 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2122 "PtrToInt Vector width mismatch", &I);
2125 visitInstruction(I);
2128 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2129 // Get the source and destination types
2130 Type *SrcTy = I.getOperand(0)->getType();
2131 Type *DestTy = I.getType();
2133 Assert(SrcTy->getScalarType()->isIntegerTy(),
2134 "IntToPtr source must be an integral", &I);
2135 Assert(DestTy->getScalarType()->isPointerTy(),
2136 "IntToPtr result must be a pointer", &I);
2137 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2139 if (SrcTy->isVectorTy()) {
2140 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2141 VectorType *VDest = dyn_cast<VectorType>(DestTy);
2142 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2143 "IntToPtr Vector width mismatch", &I);
2145 visitInstruction(I);
2148 void Verifier::visitBitCastInst(BitCastInst &I) {
2150 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2151 "Invalid bitcast", &I);
2152 visitInstruction(I);
2155 void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2156 Type *SrcTy = I.getOperand(0)->getType();
2157 Type *DestTy = I.getType();
2159 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2161 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2163 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2164 "AddrSpaceCast must be between different address spaces", &I);
2165 if (SrcTy->isVectorTy())
2166 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2167 "AddrSpaceCast vector pointer number of elements mismatch", &I);
2168 visitInstruction(I);
2171 /// visitPHINode - Ensure that a PHI node is well formed.
2173 void Verifier::visitPHINode(PHINode &PN) {
2174 // Ensure that the PHI nodes are all grouped together at the top of the block.
2175 // This can be tested by checking whether the instruction before this is
2176 // either nonexistent (because this is begin()) or is a PHI node. If not,
2177 // then there is some other instruction before a PHI.
2178 Assert(&PN == &PN.getParent()->front() ||
2179 isa<PHINode>(--BasicBlock::iterator(&PN)),
2180 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
2182 // Check that all of the values of the PHI node have the same type as the
2183 // result, and that the incoming blocks are really basic blocks.
2184 for (Value *IncValue : PN.incoming_values()) {
2185 Assert(PN.getType() == IncValue->getType(),
2186 "PHI node operands are not the same type as the result!", &PN);
2189 // All other PHI node constraints are checked in the visitBasicBlock method.
2191 visitInstruction(PN);
2194 void Verifier::VerifyCallSite(CallSite CS) {
2195 Instruction *I = CS.getInstruction();
2197 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2198 "Called function must be a pointer!", I);
2199 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
2201 Assert(FPTy->getElementType()->isFunctionTy(),
2202 "Called function is not pointer to function type!", I);
2204 Assert(FPTy->getElementType() == CS.getFunctionType(),
2205 "Called function is not the same type as the call!", I);
2207 FunctionType *FTy = CS.getFunctionType();
2209 // Verify that the correct number of arguments are being passed
2210 if (FTy->isVarArg())
2211 Assert(CS.arg_size() >= FTy->getNumParams(),
2212 "Called function requires more parameters than were provided!", I);
2214 Assert(CS.arg_size() == FTy->getNumParams(),
2215 "Incorrect number of arguments passed to called function!", I);
2217 // Verify that all arguments to the call match the function type.
2218 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2219 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2220 "Call parameter type does not match function signature!",
2221 CS.getArgument(i), FTy->getParamType(i), I);
2223 AttributeSet Attrs = CS.getAttributes();
2225 Assert(VerifyAttributeCount(Attrs, CS.arg_size()),
2226 "Attribute after last parameter!", I);
2228 // Verify call attributes.
2229 VerifyFunctionAttrs(FTy, Attrs, I);
2231 // Conservatively check the inalloca argument.
2232 // We have a bug if we can find that there is an underlying alloca without
2234 if (CS.hasInAllocaArgument()) {
2235 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2236 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
2237 Assert(AI->isUsedWithInAlloca(),
2238 "inalloca argument for call has mismatched alloca", AI, I);
2241 if (FTy->isVarArg()) {
2242 // FIXME? is 'nest' even legal here?
2243 bool SawNest = false;
2244 bool SawReturned = false;
2246 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2247 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2249 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2253 // Check attributes on the varargs part.
2254 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
2255 Type *Ty = CS.getArgument(Idx-1)->getType();
2256 VerifyParameterAttrs(Attrs, Idx, Ty, false, I);
2258 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
2259 Assert(!SawNest, "More than one parameter has attribute nest!", I);
2263 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
2264 Assert(!SawReturned, "More than one parameter has attribute returned!",
2266 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2267 "Incompatible argument and return types for 'returned' "
2273 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2274 "Attribute 'sret' cannot be used for vararg call arguments!", I);
2276 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
2277 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
2281 // Verify that there's no metadata unless it's a direct call to an intrinsic.
2282 if (CS.getCalledFunction() == nullptr ||
2283 !CS.getCalledFunction()->getName().startswith("llvm.")) {
2284 for (FunctionType::param_iterator PI = FTy->param_begin(),
2285 PE = FTy->param_end(); PI != PE; ++PI)
2286 Assert(!(*PI)->isMetadataTy(),
2287 "Function has metadata parameter but isn't an intrinsic", I);
2290 if (Function *F = CS.getCalledFunction())
2291 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
2292 visitIntrinsicCallSite(ID, CS);
2294 visitInstruction(*I);
2297 /// Two types are "congruent" if they are identical, or if they are both pointer
2298 /// types with different pointee types and the same address space.
2299 static bool isTypeCongruent(Type *L, Type *R) {
2302 PointerType *PL = dyn_cast<PointerType>(L);
2303 PointerType *PR = dyn_cast<PointerType>(R);
2306 return PL->getAddressSpace() == PR->getAddressSpace();
2309 static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2310 static const Attribute::AttrKind ABIAttrs[] = {
2311 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
2312 Attribute::InReg, Attribute::Returned};
2314 for (auto AK : ABIAttrs) {
2315 if (Attrs.hasAttribute(I + 1, AK))
2316 Copy.addAttribute(AK);
2318 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2319 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2323 void Verifier::verifyMustTailCall(CallInst &CI) {
2324 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
2326 // - The caller and callee prototypes must match. Pointer types of
2327 // parameters or return types may differ in pointee type, but not
2329 Function *F = CI.getParent()->getParent();
2330 FunctionType *CallerTy = F->getFunctionType();
2331 FunctionType *CalleeTy = CI.getFunctionType();
2332 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2333 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2334 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2335 "cannot guarantee tail call due to mismatched varargs", &CI);
2336 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2337 "cannot guarantee tail call due to mismatched return types", &CI);
2338 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2340 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2341 "cannot guarantee tail call due to mismatched parameter types", &CI);
2344 // - The calling conventions of the caller and callee must match.
2345 Assert(F->getCallingConv() == CI.getCallingConv(),
2346 "cannot guarantee tail call due to mismatched calling conv", &CI);
2348 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2349 // returned, and inalloca, must match.
2350 AttributeSet CallerAttrs = F->getAttributes();
2351 AttributeSet CalleeAttrs = CI.getAttributes();
2352 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2353 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2354 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
2355 Assert(CallerABIAttrs == CalleeABIAttrs,
2356 "cannot guarantee tail call due to mismatched ABI impacting "
2357 "function attributes",
2358 &CI, CI.getOperand(I));
2361 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2362 // or a pointer bitcast followed by a ret instruction.
2363 // - The ret instruction must return the (possibly bitcasted) value
2364 // produced by the call or void.
2365 Value *RetVal = &CI;
2366 Instruction *Next = CI.getNextNode();
2368 // Handle the optional bitcast.
2369 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
2370 Assert(BI->getOperand(0) == RetVal,
2371 "bitcast following musttail call must use the call", BI);
2373 Next = BI->getNextNode();
2376 // Check the return.
2377 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
2378 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2380 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2381 "musttail call result must be returned", Ret);
2384 void Verifier::visitCallInst(CallInst &CI) {
2385 VerifyCallSite(&CI);
2387 if (CI.isMustTailCall())
2388 verifyMustTailCall(CI);
2391 void Verifier::visitInvokeInst(InvokeInst &II) {
2392 VerifyCallSite(&II);
2394 // Verify that there is a landingpad instruction as the first non-PHI
2395 // instruction of the 'unwind' destination.
2396 Assert(II.getUnwindDest()->isLandingPad(),
2397 "The unwind destination does not have a landingpad instruction!", &II);
2399 visitTerminatorInst(II);
2402 /// visitBinaryOperator - Check that both arguments to the binary operator are
2403 /// of the same type!
2405 void Verifier::visitBinaryOperator(BinaryOperator &B) {
2406 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2407 "Both operands to a binary operator are not of the same type!", &B);
2409 switch (B.getOpcode()) {
2410 // Check that integer arithmetic operators are only used with
2411 // integral operands.
2412 case Instruction::Add:
2413 case Instruction::Sub:
2414 case Instruction::Mul:
2415 case Instruction::SDiv:
2416 case Instruction::UDiv:
2417 case Instruction::SRem:
2418 case Instruction::URem:
2419 Assert(B.getType()->isIntOrIntVectorTy(),
2420 "Integer arithmetic operators only work with integral types!", &B);
2421 Assert(B.getType() == B.getOperand(0)->getType(),
2422 "Integer arithmetic operators must have same type "
2423 "for operands and result!",
2426 // Check that floating-point arithmetic operators are only used with
2427 // floating-point operands.
2428 case Instruction::FAdd:
2429 case Instruction::FSub:
2430 case Instruction::FMul:
2431 case Instruction::FDiv:
2432 case Instruction::FRem:
2433 Assert(B.getType()->isFPOrFPVectorTy(),
2434 "Floating-point arithmetic operators only work with "
2435 "floating-point types!",
2437 Assert(B.getType() == B.getOperand(0)->getType(),
2438 "Floating-point arithmetic operators must have same type "
2439 "for operands and result!",
2442 // Check that logical operators are only used with integral operands.
2443 case Instruction::And:
2444 case Instruction::Or:
2445 case Instruction::Xor:
2446 Assert(B.getType()->isIntOrIntVectorTy(),
2447 "Logical operators only work with integral types!", &B);
2448 Assert(B.getType() == B.getOperand(0)->getType(),
2449 "Logical operators must have same type for operands and result!",
2452 case Instruction::Shl:
2453 case Instruction::LShr:
2454 case Instruction::AShr:
2455 Assert(B.getType()->isIntOrIntVectorTy(),
2456 "Shifts only work with integral types!", &B);
2457 Assert(B.getType() == B.getOperand(0)->getType(),
2458 "Shift return type must be same as operands!", &B);
2461 llvm_unreachable("Unknown BinaryOperator opcode!");
2464 visitInstruction(B);
2467 void Verifier::visitICmpInst(ICmpInst &IC) {
2468 // Check that the operands are the same type
2469 Type *Op0Ty = IC.getOperand(0)->getType();
2470 Type *Op1Ty = IC.getOperand(1)->getType();
2471 Assert(Op0Ty == Op1Ty,
2472 "Both operands to ICmp instruction are not of the same type!", &IC);
2473 // Check that the operands are the right type
2474 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2475 "Invalid operand types for ICmp instruction", &IC);
2476 // Check that the predicate is valid.
2477 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2478 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2479 "Invalid predicate in ICmp instruction!", &IC);
2481 visitInstruction(IC);
2484 void Verifier::visitFCmpInst(FCmpInst &FC) {
2485 // Check that the operands are the same type
2486 Type *Op0Ty = FC.getOperand(0)->getType();
2487 Type *Op1Ty = FC.getOperand(1)->getType();
2488 Assert(Op0Ty == Op1Ty,
2489 "Both operands to FCmp instruction are not of the same type!", &FC);
2490 // Check that the operands are the right type
2491 Assert(Op0Ty->isFPOrFPVectorTy(),
2492 "Invalid operand types for FCmp instruction", &FC);
2493 // Check that the predicate is valid.
2494 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2495 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2496 "Invalid predicate in FCmp instruction!", &FC);
2498 visitInstruction(FC);
2501 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
2503 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2504 "Invalid extractelement operands!", &EI);
2505 visitInstruction(EI);
2508 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
2509 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2511 "Invalid insertelement operands!", &IE);
2512 visitInstruction(IE);
2515 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
2516 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2518 "Invalid shufflevector operands!", &SV);
2519 visitInstruction(SV);
2522 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
2523 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
2525 Assert(isa<PointerType>(TargetTy),
2526 "GEP base pointer is not a vector or a vector of pointers", &GEP);
2527 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
2528 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
2530 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
2531 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
2533 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
2534 GEP.getResultElementType() == ElTy,
2535 "GEP is not of right type for indices!", &GEP, ElTy);
2537 if (GEP.getType()->isVectorTy()) {
2538 // Additional checks for vector GEPs.
2539 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2540 if (GEP.getPointerOperandType()->isVectorTy())
2541 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2542 "Vector GEP result width doesn't match operand's", &GEP);
2543 for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
2544 Type *IndexTy = Idxs[i]->getType();
2545 if (IndexTy->isVectorTy()) {
2546 unsigned IndexWidth = IndexTy->getVectorNumElements();
2547 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2549 Assert(IndexTy->getScalarType()->isIntegerTy(),
2550 "All GEP indices should be of integer type");
2553 visitInstruction(GEP);
2556 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2557 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2560 void Verifier::visitRangeMetadata(Instruction& I,
2561 MDNode* Range, Type* Ty) {
2563 Range == I.getMetadata(LLVMContext::MD_range) &&
2564 "precondition violation");
2566 unsigned NumOperands = Range->getNumOperands();
2567 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
2568 unsigned NumRanges = NumOperands / 2;
2569 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2571 ConstantRange LastRange(1); // Dummy initial value
2572 for (unsigned i = 0; i < NumRanges; ++i) {
2574 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
2575 Assert(Low, "The lower limit must be an integer!", Low);
2577 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
2578 Assert(High, "The upper limit must be an integer!", High);
2579 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2580 "Range types must match instruction type!", &I);
2582 APInt HighV = High->getValue();
2583 APInt LowV = Low->getValue();
2584 ConstantRange CurRange(LowV, HighV);
2585 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2586 "Range must not be empty!", Range);
2588 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2589 "Intervals are overlapping", Range);
2590 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2592 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2595 LastRange = ConstantRange(LowV, HighV);
2597 if (NumRanges > 2) {
2599 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
2601 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
2602 ConstantRange FirstRange(FirstLow, FirstHigh);
2603 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2604 "Intervals are overlapping", Range);
2605 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2610 void Verifier::visitLoadInst(LoadInst &LI) {
2611 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
2612 Assert(PTy, "Load operand must be a pointer.", &LI);
2613 Type *ElTy = LI.getType();
2614 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2615 "huge alignment values are unsupported", &LI);
2616 if (LI.isAtomic()) {
2617 Assert(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
2618 "Load cannot have Release ordering", &LI);
2619 Assert(LI.getAlignment() != 0,
2620 "Atomic load must specify explicit alignment", &LI);
2621 if (!ElTy->isPointerTy()) {
2622 Assert(ElTy->isIntegerTy(), "atomic load operand must have integer type!",
2624 unsigned Size = ElTy->getPrimitiveSizeInBits();
2625 Assert(Size >= 8 && !(Size & (Size - 1)),
2626 "atomic load operand must be power-of-two byte-sized integer", &LI,
2630 Assert(LI.getSynchScope() == CrossThread,
2631 "Non-atomic load cannot have SynchronizationScope specified", &LI);
2634 visitInstruction(LI);
2637 void Verifier::visitStoreInst(StoreInst &SI) {
2638 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
2639 Assert(PTy, "Store operand must be a pointer.", &SI);
2640 Type *ElTy = PTy->getElementType();
2641 Assert(ElTy == SI.getOperand(0)->getType(),
2642 "Stored value type does not match pointer operand type!", &SI, ElTy);
2643 Assert(SI.getAlignment() <= Value::MaximumAlignment,
2644 "huge alignment values are unsupported", &SI);
2645 if (SI.isAtomic()) {
2646 Assert(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
2647 "Store cannot have Acquire ordering", &SI);
2648 Assert(SI.getAlignment() != 0,
2649 "Atomic store must specify explicit alignment", &SI);
2650 if (!ElTy->isPointerTy()) {
2651 Assert(ElTy->isIntegerTy(),
2652 "atomic store operand must have integer type!", &SI, ElTy);
2653 unsigned Size = ElTy->getPrimitiveSizeInBits();
2654 Assert(Size >= 8 && !(Size & (Size - 1)),
2655 "atomic store operand must be power-of-two byte-sized integer",
2659 Assert(SI.getSynchScope() == CrossThread,
2660 "Non-atomic store cannot have SynchronizationScope specified", &SI);
2662 visitInstruction(SI);
2665 void Verifier::visitAllocaInst(AllocaInst &AI) {
2666 SmallPtrSet<const Type*, 4> Visited;
2667 PointerType *PTy = AI.getType();
2668 Assert(PTy->getAddressSpace() == 0,
2669 "Allocation instruction pointer not in the generic address space!",
2671 Assert(AI.getAllocatedType()->isSized(&Visited),
2672 "Cannot allocate unsized type", &AI);
2673 Assert(AI.getArraySize()->getType()->isIntegerTy(),
2674 "Alloca array size must have integer type", &AI);
2675 Assert(AI.getAlignment() <= Value::MaximumAlignment,
2676 "huge alignment values are unsupported", &AI);
2678 visitInstruction(AI);
2681 void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
2683 // FIXME: more conditions???
2684 Assert(CXI.getSuccessOrdering() != NotAtomic,
2685 "cmpxchg instructions must be atomic.", &CXI);
2686 Assert(CXI.getFailureOrdering() != NotAtomic,
2687 "cmpxchg instructions must be atomic.", &CXI);
2688 Assert(CXI.getSuccessOrdering() != Unordered,
2689 "cmpxchg instructions cannot be unordered.", &CXI);
2690 Assert(CXI.getFailureOrdering() != Unordered,
2691 "cmpxchg instructions cannot be unordered.", &CXI);
2692 Assert(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
2693 "cmpxchg instructions be at least as constrained on success as fail",
2695 Assert(CXI.getFailureOrdering() != Release &&
2696 CXI.getFailureOrdering() != AcquireRelease,
2697 "cmpxchg failure ordering cannot include release semantics", &CXI);
2699 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
2700 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
2701 Type *ElTy = PTy->getElementType();
2702 Assert(ElTy->isIntegerTy(), "cmpxchg operand must have integer type!", &CXI,
2704 unsigned Size = ElTy->getPrimitiveSizeInBits();
2705 Assert(Size >= 8 && !(Size & (Size - 1)),
2706 "cmpxchg operand must be power-of-two byte-sized integer", &CXI, ElTy);
2707 Assert(ElTy == CXI.getOperand(1)->getType(),
2708 "Expected value type does not match pointer operand type!", &CXI,
2710 Assert(ElTy == CXI.getOperand(2)->getType(),
2711 "Stored value type does not match pointer operand type!", &CXI, ElTy);
2712 visitInstruction(CXI);
2715 void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
2716 Assert(RMWI.getOrdering() != NotAtomic,
2717 "atomicrmw instructions must be atomic.", &RMWI);
2718 Assert(RMWI.getOrdering() != Unordered,
2719 "atomicrmw instructions cannot be unordered.", &RMWI);
2720 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
2721 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
2722 Type *ElTy = PTy->getElementType();
2723 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
2725 unsigned Size = ElTy->getPrimitiveSizeInBits();
2726 Assert(Size >= 8 && !(Size & (Size - 1)),
2727 "atomicrmw operand must be power-of-two byte-sized integer", &RMWI,
2729 Assert(ElTy == RMWI.getOperand(1)->getType(),
2730 "Argument value type does not match pointer operand type!", &RMWI,
2732 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
2733 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
2734 "Invalid binary operation!", &RMWI);
2735 visitInstruction(RMWI);
2738 void Verifier::visitFenceInst(FenceInst &FI) {
2739 const AtomicOrdering Ordering = FI.getOrdering();
2740 Assert(Ordering == Acquire || Ordering == Release ||
2741 Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
2742 "fence instructions may only have "
2743 "acquire, release, acq_rel, or seq_cst ordering.",
2745 visitInstruction(FI);
2748 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
2749 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
2750 EVI.getIndices()) == EVI.getType(),
2751 "Invalid ExtractValueInst operands!", &EVI);
2753 visitInstruction(EVI);
2756 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
2757 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
2758 IVI.getIndices()) ==
2759 IVI.getOperand(1)->getType(),
2760 "Invalid InsertValueInst operands!", &IVI);
2762 visitInstruction(IVI);
2765 void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
2766 BasicBlock *BB = LPI.getParent();
2768 // The landingpad instruction is ill-formed if it doesn't have any clauses and
2770 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
2771 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
2773 // The landingpad instruction defines its parent as a landing pad block. The
2774 // landing pad block may be branched to only by the unwind edge of an invoke.
2775 for (pred_iterator I = pred_begin(BB), E = pred_end(BB); I != E; ++I) {
2776 const InvokeInst *II = dyn_cast<InvokeInst>((*I)->getTerminator());
2777 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
2778 "Block containing LandingPadInst must be jumped to "
2779 "only by the unwind edge of an invoke.",
2783 Function *F = LPI.getParent()->getParent();
2784 Assert(F->hasPersonalityFn(),
2785 "LandingPadInst needs to be in a function with a personality.", &LPI);
2787 // The landingpad instruction must be the first non-PHI instruction in the
2789 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
2790 "LandingPadInst not the first non-PHI instruction in the block.",
2793 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
2794 Constant *Clause = LPI.getClause(i);
2795 if (LPI.isCatch(i)) {
2796 Assert(isa<PointerType>(Clause->getType()),
2797 "Catch operand does not have pointer type!", &LPI);
2799 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
2800 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
2801 "Filter operand is not an array of constants!", &LPI);
2805 visitInstruction(LPI);
2808 void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
2809 Instruction *Op = cast<Instruction>(I.getOperand(i));
2810 // If the we have an invalid invoke, don't try to compute the dominance.
2811 // We already reject it in the invoke specific checks and the dominance
2812 // computation doesn't handle multiple edges.
2813 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
2814 if (II->getNormalDest() == II->getUnwindDest())
2818 const Use &U = I.getOperandUse(i);
2819 Assert(InstsInThisBlock.count(Op) || DT.dominates(Op, U),
2820 "Instruction does not dominate all uses!", Op, &I);
2823 /// verifyInstruction - Verify that an instruction is well formed.
2825 void Verifier::visitInstruction(Instruction &I) {
2826 BasicBlock *BB = I.getParent();
2827 Assert(BB, "Instruction not embedded in basic block!", &I);
2829 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
2830 for (User *U : I.users()) {
2831 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
2832 "Only PHI nodes may reference their own value!", &I);
2836 // Check that void typed values don't have names
2837 Assert(!I.getType()->isVoidTy() || !I.hasName(),
2838 "Instruction has a name, but provides a void value!", &I);
2840 // Check that the return value of the instruction is either void or a legal
2842 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
2843 "Instruction returns a non-scalar type!", &I);
2845 // Check that the instruction doesn't produce metadata. Calls are already
2846 // checked against the callee type.
2847 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
2848 "Invalid use of metadata!", &I);
2850 // Check that all uses of the instruction, if they are instructions
2851 // themselves, actually have parent basic blocks. If the use is not an
2852 // instruction, it is an error!
2853 for (Use &U : I.uses()) {
2854 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
2855 Assert(Used->getParent() != nullptr,
2856 "Instruction referencing"
2857 " instruction not embedded in a basic block!",
2860 CheckFailed("Use of instruction is not an instruction!", U);
2865 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
2866 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
2868 // Check to make sure that only first-class-values are operands to
2870 if (!I.getOperand(i)->getType()->isFirstClassType()) {
2871 Assert(0, "Instruction operands must be first-class values!", &I);
2874 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
2875 // Check to make sure that the "address of" an intrinsic function is never
2878 !F->isIntrinsic() ||
2879 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
2880 "Cannot take the address of an intrinsic!", &I);
2882 !F->isIntrinsic() || isa<CallInst>(I) ||
2883 F->getIntrinsicID() == Intrinsic::donothing ||
2884 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
2885 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
2886 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
2887 "Cannot invoke an intrinsinc other than"
2888 " donothing or patchpoint",
2890 Assert(F->getParent() == M, "Referencing function in another module!",
2892 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
2893 Assert(OpBB->getParent() == BB->getParent(),
2894 "Referring to a basic block in another function!", &I);
2895 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
2896 Assert(OpArg->getParent() == BB->getParent(),
2897 "Referring to an argument in another function!", &I);
2898 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
2899 Assert(GV->getParent() == M, "Referencing global in another module!", &I);
2900 } else if (isa<Instruction>(I.getOperand(i))) {
2901 verifyDominatesUse(I, i);
2902 } else if (isa<InlineAsm>(I.getOperand(i))) {
2903 Assert((i + 1 == e && isa<CallInst>(I)) ||
2904 (i + 3 == e && isa<InvokeInst>(I)),
2905 "Cannot take the address of an inline asm!", &I);
2906 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
2907 if (CE->getType()->isPtrOrPtrVectorTy()) {
2908 // If we have a ConstantExpr pointer, we need to see if it came from an
2909 // illegal bitcast (inttoptr <constant int> )
2910 SmallVector<const ConstantExpr *, 4> Stack;
2911 SmallPtrSet<const ConstantExpr *, 4> Visited;
2912 Stack.push_back(CE);
2914 while (!Stack.empty()) {
2915 const ConstantExpr *V = Stack.pop_back_val();
2916 if (!Visited.insert(V).second)
2919 VerifyConstantExprBitcastType(V);
2921 for (unsigned I = 0, N = V->getNumOperands(); I != N; ++I) {
2922 if (ConstantExpr *Op = dyn_cast<ConstantExpr>(V->getOperand(I)))
2923 Stack.push_back(Op);
2930 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
2931 Assert(I.getType()->isFPOrFPVectorTy(),
2932 "fpmath requires a floating point result!", &I);
2933 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
2934 if (ConstantFP *CFP0 =
2935 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
2936 APFloat Accuracy = CFP0->getValueAPF();
2937 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
2938 "fpmath accuracy not a positive number!", &I);
2940 Assert(false, "invalid fpmath accuracy!", &I);
2944 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
2945 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
2946 "Ranges are only for loads, calls and invokes!", &I);
2947 visitRangeMetadata(I, Range, I.getType());
2950 if (I.getMetadata(LLVMContext::MD_nonnull)) {
2951 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
2953 Assert(isa<LoadInst>(I),
2954 "nonnull applies only to load instructions, use attributes"
2955 " for calls or invokes",
2959 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
2960 Assert(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
2964 InstsInThisBlock.insert(&I);
2967 /// VerifyIntrinsicType - Verify that the specified type (which comes from an
2968 /// intrinsic argument or return value) matches the type constraints specified
2969 /// by the .td file (e.g. an "any integer" argument really is an integer).
2971 /// This return true on error but does not print a message.
2972 bool Verifier::VerifyIntrinsicType(Type *Ty,
2973 ArrayRef<Intrinsic::IITDescriptor> &Infos,
2974 SmallVectorImpl<Type*> &ArgTys) {
2975 using namespace Intrinsic;
2977 // If we ran out of descriptors, there are too many arguments.
2978 if (Infos.empty()) return true;
2979 IITDescriptor D = Infos.front();
2980 Infos = Infos.slice(1);
2983 case IITDescriptor::Void: return !Ty->isVoidTy();
2984 case IITDescriptor::VarArg: return true;
2985 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
2986 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
2987 case IITDescriptor::Half: return !Ty->isHalfTy();
2988 case IITDescriptor::Float: return !Ty->isFloatTy();
2989 case IITDescriptor::Double: return !Ty->isDoubleTy();
2990 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
2991 case IITDescriptor::Vector: {
2992 VectorType *VT = dyn_cast<VectorType>(Ty);
2993 return !VT || VT->getNumElements() != D.Vector_Width ||
2994 VerifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
2996 case IITDescriptor::Pointer: {
2997 PointerType *PT = dyn_cast<PointerType>(Ty);
2998 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
2999 VerifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
3002 case IITDescriptor::Struct: {
3003 StructType *ST = dyn_cast<StructType>(Ty);
3004 if (!ST || ST->getNumElements() != D.Struct_NumElements)
3007 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
3008 if (VerifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
3013 case IITDescriptor::Argument:
3014 // Two cases here - If this is the second occurrence of an argument, verify
3015 // that the later instance matches the previous instance.
3016 if (D.getArgumentNumber() < ArgTys.size())
3017 return Ty != ArgTys[D.getArgumentNumber()];
3019 // Otherwise, if this is the first instance of an argument, record it and
3020 // verify the "Any" kind.
3021 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
3022 ArgTys.push_back(Ty);
3024 switch (D.getArgumentKind()) {
3025 case IITDescriptor::AK_Any: return false; // Success
3026 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
3027 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
3028 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
3029 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
3031 llvm_unreachable("all argument kinds not covered");
3033 case IITDescriptor::ExtendArgument: {
3034 // This may only be used when referring to a previous vector argument.
3035 if (D.getArgumentNumber() >= ArgTys.size())
3038 Type *NewTy = ArgTys[D.getArgumentNumber()];
3039 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3040 NewTy = VectorType::getExtendedElementVectorType(VTy);
3041 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3042 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
3048 case IITDescriptor::TruncArgument: {
3049 // This may only be used when referring to a previous vector argument.
3050 if (D.getArgumentNumber() >= ArgTys.size())
3053 Type *NewTy = ArgTys[D.getArgumentNumber()];
3054 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3055 NewTy = VectorType::getTruncatedElementVectorType(VTy);
3056 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3057 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
3063 case IITDescriptor::HalfVecArgument:
3064 // This may only be used when referring to a previous vector argument.
3065 return D.getArgumentNumber() >= ArgTys.size() ||
3066 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
3067 VectorType::getHalfElementsVectorType(
3068 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
3069 case IITDescriptor::SameVecWidthArgument: {
3070 if (D.getArgumentNumber() >= ArgTys.size())
3072 VectorType * ReferenceType =
3073 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
3074 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
3075 if (!ThisArgType || !ReferenceType ||
3076 (ReferenceType->getVectorNumElements() !=
3077 ThisArgType->getVectorNumElements()))
3079 return VerifyIntrinsicType(ThisArgType->getVectorElementType(),
3082 case IITDescriptor::PtrToArgument: {
3083 if (D.getArgumentNumber() >= ArgTys.size())
3085 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
3086 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
3087 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
3089 case IITDescriptor::VecOfPtrsToElt: {
3090 if (D.getArgumentNumber() >= ArgTys.size())
3092 VectorType * ReferenceType =
3093 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
3094 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
3095 if (!ThisArgVecTy || !ReferenceType ||
3096 (ReferenceType->getVectorNumElements() !=
3097 ThisArgVecTy->getVectorNumElements()))
3099 PointerType *ThisArgEltTy =
3100 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
3103 return ThisArgEltTy->getElementType() !=
3104 ReferenceType->getVectorElementType();
3107 llvm_unreachable("unhandled");
3110 /// \brief Verify if the intrinsic has variable arguments.
3111 /// This method is intended to be called after all the fixed arguments have been
3114 /// This method returns true on error and does not print an error message.
3116 Verifier::VerifyIntrinsicIsVarArg(bool isVarArg,
3117 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
3118 using namespace Intrinsic;
3120 // If there are no descriptors left, then it can't be a vararg.
3124 // There should be only one descriptor remaining at this point.
3125 if (Infos.size() != 1)
3128 // Check and verify the descriptor.
3129 IITDescriptor D = Infos.front();
3130 Infos = Infos.slice(1);
3131 if (D.Kind == IITDescriptor::VarArg)
3137 /// Allow intrinsics to be verified in different ways.
3138 void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
3139 Function *IF = CS.getCalledFunction();
3140 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3143 // Verify that the intrinsic prototype lines up with what the .td files
3145 FunctionType *IFTy = IF->getFunctionType();
3146 bool IsVarArg = IFTy->isVarArg();
3148 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3149 getIntrinsicInfoTableEntries(ID, Table);
3150 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
3152 SmallVector<Type *, 4> ArgTys;
3153 Assert(!VerifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
3154 "Intrinsic has incorrect return type!", IF);
3155 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
3156 Assert(!VerifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
3157 "Intrinsic has incorrect argument type!", IF);
3159 // Verify if the intrinsic call matches the vararg property.
3161 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3162 "Intrinsic was not defined with variable arguments!", IF);
3164 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3165 "Callsite was not defined with variable arguments!", IF);
3167 // All descriptors should be absorbed by now.
3168 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
3170 // Now that we have the intrinsic ID and the actual argument types (and we
3171 // know they are legal for the intrinsic!) get the intrinsic name through the
3172 // usual means. This allows us to verify the mangling of argument types into
3174 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
3175 Assert(ExpectedName == IF->getName(),
3176 "Intrinsic name not mangled correctly for type arguments! "
3181 // If the intrinsic takes MDNode arguments, verify that they are either global
3182 // or are local to *this* function.
3183 for (Value *V : CS.args())
3184 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3185 visitMetadataAsValue(*MD, CS.getCaller());
3190 case Intrinsic::ctlz: // llvm.ctlz
3191 case Intrinsic::cttz: // llvm.cttz
3192 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3193 "is_zero_undef argument of bit counting intrinsics must be a "
3197 case Intrinsic::dbg_declare: // llvm.dbg.declare
3198 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3199 "invalid llvm.dbg.declare intrinsic call 1", CS);
3200 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
3202 case Intrinsic::dbg_value: // llvm.dbg.value
3203 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
3205 case Intrinsic::memcpy:
3206 case Intrinsic::memmove:
3207 case Intrinsic::memset: {
3208 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
3210 "alignment argument of memory intrinsics must be a constant int",
3212 const APInt &AlignVal = AlignCI->getValue();
3213 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
3214 "alignment argument of memory intrinsics must be a power of 2", CS);
3215 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
3216 "isvolatile argument of memory intrinsics must be a constant int",
3220 case Intrinsic::gcroot:
3221 case Intrinsic::gcwrite:
3222 case Intrinsic::gcread:
3223 if (ID == Intrinsic::gcroot) {
3225 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3226 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3227 Assert(isa<Constant>(CS.getArgOperand(1)),
3228 "llvm.gcroot parameter #2 must be a constant.", CS);
3229 if (!AI->getAllocatedType()->isPointerTy()) {
3230 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
3231 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3232 "or argument #2 must be a non-null constant.",
3237 Assert(CS.getParent()->getParent()->hasGC(),
3238 "Enclosing function does not use GC.", CS);
3240 case Intrinsic::init_trampoline:
3241 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
3242 "llvm.init_trampoline parameter #2 must resolve to a function.",
3245 case Intrinsic::prefetch:
3246 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
3247 isa<ConstantInt>(CS.getArgOperand(2)) &&
3248 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
3249 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
3250 "invalid arguments to llvm.prefetch", CS);
3252 case Intrinsic::stackprotector:
3253 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
3254 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
3256 case Intrinsic::lifetime_start:
3257 case Intrinsic::lifetime_end:
3258 case Intrinsic::invariant_start:
3259 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
3260 "size argument of memory use markers must be a constant integer",
3263 case Intrinsic::invariant_end:
3264 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3265 "llvm.invariant.end parameter #2 must be a constant integer", CS);
3268 case Intrinsic::localescape: {
3269 BasicBlock *BB = CS.getParent();
3270 Assert(BB == &BB->getParent()->front(),
3271 "llvm.localescape used outside of entry block", CS);
3272 Assert(!SawFrameEscape,
3273 "multiple calls to llvm.localescape in one function", CS);
3274 for (Value *Arg : CS.args()) {
3275 if (isa<ConstantPointerNull>(Arg))
3276 continue; // Null values are allowed as placeholders.
3277 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
3278 Assert(AI && AI->isStaticAlloca(),
3279 "llvm.localescape only accepts static allocas", CS);
3281 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
3282 SawFrameEscape = true;
3285 case Intrinsic::localrecover: {
3286 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
3287 Function *Fn = dyn_cast<Function>(FnArg);
3288 Assert(Fn && !Fn->isDeclaration(),
3289 "llvm.localrecover first "
3290 "argument must be function defined in this module",
3292 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
3293 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
3295 auto &Entry = FrameEscapeInfo[Fn];
3296 Entry.second = unsigned(
3297 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
3301 case Intrinsic::experimental_gc_statepoint:
3302 Assert(!CS.isInlineAsm(),
3303 "gc.statepoint support for inline assembly unimplemented", CS);
3304 Assert(CS.getParent()->getParent()->hasGC(),
3305 "Enclosing function does not use GC.", CS);
3307 VerifyStatepoint(CS);
3309 case Intrinsic::experimental_gc_result_int:
3310 case Intrinsic::experimental_gc_result_float:
3311 case Intrinsic::experimental_gc_result_ptr:
3312 case Intrinsic::experimental_gc_result: {
3313 Assert(CS.getParent()->getParent()->hasGC(),
3314 "Enclosing function does not use GC.", CS);
3315 // Are we tied to a statepoint properly?
3316 CallSite StatepointCS(CS.getArgOperand(0));
3317 const Function *StatepointFn =
3318 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
3319 Assert(StatepointFn && StatepointFn->isDeclaration() &&
3320 StatepointFn->getIntrinsicID() ==
3321 Intrinsic::experimental_gc_statepoint,
3322 "gc.result operand #1 must be from a statepoint", CS,
3323 CS.getArgOperand(0));
3325 // Assert that result type matches wrapped callee.
3326 const Value *Target = StatepointCS.getArgument(2);
3327 const PointerType *PT = cast<PointerType>(Target->getType());
3328 const FunctionType *TargetFuncType =
3329 cast<FunctionType>(PT->getElementType());
3330 Assert(CS.getType() == TargetFuncType->getReturnType(),
3331 "gc.result result type does not match wrapped callee", CS);
3334 case Intrinsic::experimental_gc_relocate: {
3335 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
3337 // Check that this relocate is correctly tied to the statepoint
3339 // This is case for relocate on the unwinding path of an invoke statepoint
3340 if (ExtractValueInst *ExtractValue =
3341 dyn_cast<ExtractValueInst>(CS.getArgOperand(0))) {
3342 Assert(isa<LandingPadInst>(ExtractValue->getAggregateOperand()),
3343 "gc relocate on unwind path incorrectly linked to the statepoint",
3346 const BasicBlock *InvokeBB =
3347 ExtractValue->getParent()->getUniquePredecessor();
3349 // Landingpad relocates should have only one predecessor with invoke
3350 // statepoint terminator
3351 Assert(InvokeBB, "safepoints should have unique landingpads",
3352 ExtractValue->getParent());
3353 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
3355 Assert(isStatepoint(InvokeBB->getTerminator()),
3356 "gc relocate should be linked to a statepoint", InvokeBB);
3359 // In all other cases relocate should be tied to the statepoint directly.
3360 // This covers relocates on a normal return path of invoke statepoint and
3361 // relocates of a call statepoint
3362 auto Token = CS.getArgOperand(0);
3363 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
3364 "gc relocate is incorrectly tied to the statepoint", CS, Token);
3367 // Verify rest of the relocate arguments
3369 GCRelocateOperands Ops(CS);
3370 ImmutableCallSite StatepointCS(Ops.getStatepoint());
3372 // Both the base and derived must be piped through the safepoint
3373 Value* Base = CS.getArgOperand(1);
3374 Assert(isa<ConstantInt>(Base),
3375 "gc.relocate operand #2 must be integer offset", CS);
3377 Value* Derived = CS.getArgOperand(2);
3378 Assert(isa<ConstantInt>(Derived),
3379 "gc.relocate operand #3 must be integer offset", CS);
3381 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
3382 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
3384 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
3385 "gc.relocate: statepoint base index out of bounds", CS);
3386 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
3387 "gc.relocate: statepoint derived index out of bounds", CS);
3389 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
3390 // section of the statepoint's argument
3391 Assert(StatepointCS.arg_size() > 0,
3392 "gc.statepoint: insufficient arguments");
3393 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
3394 "gc.statement: number of call arguments must be constant integer");
3395 const unsigned NumCallArgs =
3396 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
3397 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
3398 "gc.statepoint: mismatch in number of call arguments");
3399 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
3400 "gc.statepoint: number of transition arguments must be "
3401 "a constant integer");
3402 const int NumTransitionArgs =
3403 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
3405 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
3406 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
3407 "gc.statepoint: number of deoptimization arguments must be "
3408 "a constant integer");
3409 const int NumDeoptArgs =
3410 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))->getZExtValue();
3411 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
3412 const int GCParamArgsEnd = StatepointCS.arg_size();
3413 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
3414 "gc.relocate: statepoint base index doesn't fall within the "
3415 "'gc parameters' section of the statepoint call",
3417 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
3418 "gc.relocate: statepoint derived index doesn't fall within the "
3419 "'gc parameters' section of the statepoint call",
3422 // Relocated value must be a pointer type, but gc_relocate does not need to return the
3423 // same pointer type as the relocated pointer. It can be casted to the correct type later
3424 // if it's desired. However, they must have the same address space.
3425 GCRelocateOperands Operands(CS);
3426 Assert(Operands.getDerivedPtr()->getType()->isPointerTy(),
3427 "gc.relocate: relocated value must be a gc pointer", CS);
3429 // gc_relocate return type must be a pointer type, and is verified earlier in
3430 // VerifyIntrinsicType().
3431 Assert(cast<PointerType>(CS.getType())->getAddressSpace() ==
3432 cast<PointerType>(Operands.getDerivedPtr()->getType())->getAddressSpace(),
3433 "gc.relocate: relocating a pointer shouldn't change its address space", CS);
3439 /// \brief Carefully grab the subprogram from a local scope.
3441 /// This carefully grabs the subprogram from a local scope, avoiding the
3442 /// built-in assertions that would typically fire.
3443 static DISubprogram *getSubprogram(Metadata *LocalScope) {
3447 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
3450 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
3451 return getSubprogram(LB->getRawScope());
3453 // Just return null; broken scope chains are checked elsewhere.
3454 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
3458 template <class DbgIntrinsicTy>
3459 void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
3460 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
3461 Assert(isa<ValueAsMetadata>(MD) ||
3462 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
3463 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
3464 Assert(isa<DILocalVariable>(DII.getRawVariable()),
3465 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
3466 DII.getRawVariable());
3467 Assert(isa<DIExpression>(DII.getRawExpression()),
3468 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
3469 DII.getRawExpression());
3471 // Ignore broken !dbg attachments; they're checked elsewhere.
3472 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
3473 if (!isa<DILocation>(N))
3476 BasicBlock *BB = DII.getParent();
3477 Function *F = BB ? BB->getParent() : nullptr;
3479 // The scopes for variables and !dbg attachments must agree.
3480 DILocalVariable *Var = DII.getVariable();
3481 DILocation *Loc = DII.getDebugLoc();
3482 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
3485 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
3486 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
3487 if (!VarSP || !LocSP)
3488 return; // Broken scope chains are checked elsewhere.
3490 Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
3491 " variable and !dbg attachment",
3492 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
3493 Loc->getScope()->getSubprogram());
3496 template <class MapTy>
3497 static uint64_t getVariableSize(const DILocalVariable &V, const MapTy &Map) {
3498 // Be careful of broken types (checked elsewhere).
3499 const Metadata *RawType = V.getRawType();
3501 // Try to get the size directly.
3502 if (auto *T = dyn_cast<DIType>(RawType))
3503 if (uint64_t Size = T->getSizeInBits())
3506 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
3507 // Look at the base type.
3508 RawType = DT->getRawBaseType();
3512 if (auto *S = dyn_cast<MDString>(RawType)) {
3513 // Don't error on missing types (checked elsewhere).
3514 RawType = Map.lookup(S);
3518 // Missing type or size.
3526 template <class MapTy>
3527 void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I,
3528 const MapTy &TypeRefs) {
3531 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
3532 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
3533 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
3535 auto *DDI = cast<DbgDeclareInst>(&I);
3536 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
3537 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
3540 // We don't know whether this intrinsic verified correctly.
3541 if (!V || !E || !E->isValid())
3544 // Nothing to do if this isn't a bit piece expression.
3545 if (!E->isBitPiece())
3548 // The frontend helps out GDB by emitting the members of local anonymous
3549 // unions as artificial local variables with shared storage. When SROA splits
3550 // the storage for artificial local variables that are smaller than the entire
3551 // union, the overhang piece will be outside of the allotted space for the
3552 // variable and this check fails.
3553 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
3554 if (V->isArtificial())
3557 // If there's no size, the type is broken, but that should be checked
3559 uint64_t VarSize = getVariableSize(*V, TypeRefs);
3563 unsigned PieceSize = E->getBitPieceSize();
3564 unsigned PieceOffset = E->getBitPieceOffset();
3565 Assert(PieceSize + PieceOffset <= VarSize,
3566 "piece is larger than or outside of variable", &I, V, E);
3567 Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
3570 void Verifier::visitUnresolvedTypeRef(const MDString *S, const MDNode *N) {
3571 // This is in its own function so we get an error for each bad type ref (not
3573 Assert(false, "unresolved type ref", S, N);
3576 void Verifier::verifyTypeRefs() {
3577 auto *CUs = M->getNamedMetadata("llvm.dbg.cu");
3581 // Visit all the compile units again to map the type references.
3582 SmallDenseMap<const MDString *, const DIType *, 32> TypeRefs;
3583 for (auto *CU : CUs->operands())
3584 if (auto Ts = cast<DICompileUnit>(CU)->getRetainedTypes())
3585 for (DIType *Op : Ts)
3586 if (auto *T = dyn_cast<DICompositeType>(Op))
3587 if (auto *S = T->getRawIdentifier()) {
3588 UnresolvedTypeRefs.erase(S);
3589 TypeRefs.insert(std::make_pair(S, T));
3592 // Verify debug info intrinsic bit piece expressions. This needs a second
3593 // pass through the intructions, since we haven't built TypeRefs yet when
3594 // verifying functions, and simply queuing the DbgInfoIntrinsics to evaluate
3595 // later/now would queue up some that could be later deleted.
3596 for (const Function &F : *M)
3597 for (const BasicBlock &BB : F)
3598 for (const Instruction &I : BB)
3599 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
3600 verifyBitPieceExpression(*DII, TypeRefs);
3602 // Return early if all typerefs were resolved.
3603 if (UnresolvedTypeRefs.empty())
3606 // Sort the unresolved references by name so the output is deterministic.
3607 typedef std::pair<const MDString *, const MDNode *> TypeRef;
3608 SmallVector<TypeRef, 32> Unresolved(UnresolvedTypeRefs.begin(),
3609 UnresolvedTypeRefs.end());
3610 std::sort(Unresolved.begin(), Unresolved.end(),
3611 [](const TypeRef &LHS, const TypeRef &RHS) {
3612 return LHS.first->getString() < RHS.first->getString();
3615 // Visit the unresolved refs (printing out the errors).
3616 for (const TypeRef &TR : Unresolved)
3617 visitUnresolvedTypeRef(TR.first, TR.second);
3620 //===----------------------------------------------------------------------===//
3621 // Implement the public interfaces to this file...
3622 //===----------------------------------------------------------------------===//
3624 bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
3625 Function &F = const_cast<Function &>(f);
3626 assert(!F.isDeclaration() && "Cannot verify external functions");
3628 raw_null_ostream NullStr;
3629 Verifier V(OS ? *OS : NullStr);
3631 // Note that this function's return value is inverted from what you would
3632 // expect of a function called "verify".
3633 return !V.verify(F);
3636 bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
3637 raw_null_ostream NullStr;
3638 Verifier V(OS ? *OS : NullStr);
3640 bool Broken = false;
3641 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
3642 if (!I->isDeclaration() && !I->isMaterializable())
3643 Broken |= !V.verify(*I);
3645 // Note that this function's return value is inverted from what you would
3646 // expect of a function called "verify".
3647 return !V.verify(M) || Broken;
3651 struct VerifierLegacyPass : public FunctionPass {
3657 VerifierLegacyPass() : FunctionPass(ID), V(dbgs()), FatalErrors(true) {
3658 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3660 explicit VerifierLegacyPass(bool FatalErrors)
3661 : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
3662 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3665 bool runOnFunction(Function &F) override {
3666 if (!V.verify(F) && FatalErrors)
3667 report_fatal_error("Broken function found, compilation aborted!");
3672 bool doFinalization(Module &M) override {
3673 if (!V.verify(M) && FatalErrors)
3674 report_fatal_error("Broken module found, compilation aborted!");
3679 void getAnalysisUsage(AnalysisUsage &AU) const override {
3680 AU.setPreservesAll();
3685 char VerifierLegacyPass::ID = 0;
3686 INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
3688 FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
3689 return new VerifierLegacyPass(FatalErrors);
3692 PreservedAnalyses VerifierPass::run(Module &M) {
3693 if (verifyModule(M, &dbgs()) && FatalErrors)
3694 report_fatal_error("Broken module found, compilation aborted!");
3696 return PreservedAnalyses::all();
3699 PreservedAnalyses VerifierPass::run(Function &F) {
3700 if (verifyFunction(F, &dbgs()) && FatalErrors)
3701 report_fatal_error("Broken function found, compilation aborted!");
3703 return PreservedAnalyses::all();