1 //===-- Verifier.cpp - Implement the Module Verifier -----------------------==//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the function verifier interface, that can be used for some
11 // sanity checking of input to the system.
13 // Note that this does not provide full `Java style' security and verifications,
14 // instead it just tries to ensure that code is well-formed.
16 // * Both of a binary operator's parameters are of the same type
17 // * Verify that the indices of mem access instructions match other operands
18 // * Verify that arithmetic and other things are only performed on first-class
19 // types. Verify that shifts & logicals only happen on integrals f.e.
20 // * All of the constants in a switch statement are of the correct type
21 // * The code is in valid SSA form
22 // * It should be illegal to put a label into any other type (like a structure)
23 // or to return one. [except constant arrays!]
24 // * Only phi nodes can be self referential: 'add i32 %0, %0 ; <int>:0' is bad
25 // * PHI nodes must have an entry for each predecessor, with no extras.
26 // * PHI nodes must be the first thing in a basic block, all grouped together
27 // * PHI nodes must have at least one entry
28 // * All basic blocks should only end with terminator insts, not contain them
29 // * The entry node to a function must not have predecessors
30 // * All Instructions must be embedded into a basic block
31 // * Functions cannot take a void-typed parameter
32 // * Verify that a function's argument list agrees with it's declared type.
33 // * It is illegal to specify a name for a void value.
34 // * It is illegal to have a internal global value with no initializer
35 // * It is illegal to have a ret instruction that returns a value that does not
36 // agree with the function return value type.
37 // * Function call argument types match the function prototype
38 // * A landing pad is defined by a landingpad instruction, and can be jumped to
39 // only by the unwind edge of an invoke instruction.
40 // * A landingpad instruction must be the first non-PHI instruction in the
42 // * All landingpad instructions must use the same personality function with
44 // * All other things that are tested by asserts spread about the code...
46 //===----------------------------------------------------------------------===//
48 #include "llvm/IR/Verifier.h"
49 #include "llvm/ADT/STLExtras.h"
50 #include "llvm/ADT/SetVector.h"
51 #include "llvm/ADT/SmallPtrSet.h"
52 #include "llvm/ADT/SmallVector.h"
53 #include "llvm/ADT/StringExtras.h"
54 #include "llvm/IR/CFG.h"
55 #include "llvm/IR/CallSite.h"
56 #include "llvm/IR/CallingConv.h"
57 #include "llvm/IR/ConstantRange.h"
58 #include "llvm/IR/Constants.h"
59 #include "llvm/IR/DataLayout.h"
60 #include "llvm/IR/DebugInfo.h"
61 #include "llvm/IR/DerivedTypes.h"
62 #include "llvm/IR/Dominators.h"
63 #include "llvm/IR/InlineAsm.h"
64 #include "llvm/IR/InstIterator.h"
65 #include "llvm/IR/InstVisitor.h"
66 #include "llvm/IR/IntrinsicInst.h"
67 #include "llvm/IR/LLVMContext.h"
68 #include "llvm/IR/Metadata.h"
69 #include "llvm/IR/Module.h"
70 #include "llvm/IR/PassManager.h"
71 #include "llvm/IR/Statepoint.h"
72 #include "llvm/Pass.h"
73 #include "llvm/Support/CommandLine.h"
74 #include "llvm/Support/Debug.h"
75 #include "llvm/Support/ErrorHandling.h"
76 #include "llvm/Support/raw_ostream.h"
81 static cl::opt<bool> VerifyDebugInfo("verify-debug-info", cl::init(true));
84 struct VerifierSupport {
88 /// \brief Track the brokenness of the module while recursively visiting.
91 explicit VerifierSupport(raw_ostream &OS)
92 : OS(OS), M(nullptr), Broken(false) {}
95 void Write(const Value *V) {
98 if (isa<Instruction>(V)) {
101 V->printAsOperand(OS, true, M);
106 void Write(const Metadata *MD) {
113 void Write(const NamedMDNode *NMD) {
120 void Write(Type *T) {
126 void Write(const Comdat *C) {
132 template <typename T1, typename... Ts>
133 void WriteTs(const T1 &V1, const Ts &... Vs) {
138 template <typename... Ts> void WriteTs() {}
141 /// \brief A check failed, so printout out the condition and the message.
143 /// This provides a nice place to put a breakpoint if you want to see why
144 /// something is not correct.
145 void CheckFailed(const Twine &Message) {
146 OS << Message << '\n';
150 /// \brief A check failed (with values to print).
152 /// This calls the Message-only version so that the above is easier to set a
154 template <typename T1, typename... Ts>
155 void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) {
156 CheckFailed(Message);
161 class Verifier : public InstVisitor<Verifier>, VerifierSupport {
162 friend class InstVisitor<Verifier>;
164 LLVMContext *Context;
167 /// \brief When verifying a basic block, keep track of all of the
168 /// instructions we have seen so far.
170 /// This allows us to do efficient dominance checks for the case when an
171 /// instruction has an operand that is an instruction in the same block.
172 SmallPtrSet<Instruction *, 16> InstsInThisBlock;
174 /// \brief Keep track of the metadata nodes that have been checked already.
175 SmallPtrSet<const Metadata *, 32> MDNodes;
177 /// \brief Track string-based type references.
178 SmallDenseMap<const MDString *, const MDNode *, 32> TypeRefs;
180 /// \brief The personality function referenced by the LandingPadInsts.
181 /// All LandingPadInsts within the same function must use the same
182 /// personality function.
183 const Value *PersonalityFn;
185 /// \brief Whether we've seen a call to @llvm.frameescape in this function
189 /// Stores the count of how many objects were passed to llvm.frameescape for a
190 /// given function and the largest index passed to llvm.framerecover.
191 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
194 explicit Verifier(raw_ostream &OS)
195 : VerifierSupport(OS), Context(nullptr), PersonalityFn(nullptr),
196 SawFrameEscape(false) {}
198 bool verify(const Function &F) {
200 Context = &M->getContext();
202 // First ensure the function is well-enough formed to compute dominance
205 OS << "Function '" << F.getName()
206 << "' does not contain an entry block!\n";
209 for (Function::const_iterator I = F.begin(), E = F.end(); I != E; ++I) {
210 if (I->empty() || !I->back().isTerminator()) {
211 OS << "Basic Block in function '" << F.getName()
212 << "' does not have terminator!\n";
213 I->printAsOperand(OS, true);
219 // Now directly compute a dominance tree. We don't rely on the pass
220 // manager to provide this as it isolates us from a potentially
221 // out-of-date dominator tree and makes it significantly more complex to
222 // run this code outside of a pass manager.
223 // FIXME: It's really gross that we have to cast away constness here.
224 DT.recalculate(const_cast<Function &>(F));
227 // FIXME: We strip const here because the inst visitor strips const.
228 visit(const_cast<Function &>(F));
229 InstsInThisBlock.clear();
230 PersonalityFn = nullptr;
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 visitMDScope(const MDScope &N);
305 void visitMDDerivedTypeBase(const MDDerivedTypeBase &N);
306 void visitMDVariable(const MDVariable &N);
307 void visitMDLexicalBlockBase(const MDLexicalBlockBase &N);
308 void visitMDTemplateParameter(const MDTemplateParameter &N);
310 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
312 /// \brief Check for a valid string-based type reference.
314 /// Checks if \c MD is a string-based type reference. If it is, keeps track
315 /// of it (and its user, \c N) for error messages later.
316 bool isValidUUID(const MDNode &N, const Metadata *MD);
318 /// \brief Check for a valid type reference.
320 /// Checks for subclasses of \a MDType, or \a isValidUUID().
321 bool isTypeRef(const MDNode &N, const Metadata *MD);
323 /// \brief Check for a valid scope reference.
325 /// Checks for subclasses of \a MDScope, or \a isValidUUID().
326 bool isScopeRef(const MDNode &N, const Metadata *MD);
328 /// \brief Check for a valid debug info reference.
330 /// Checks for subclasses of \a DebugNode, or \a isValidUUID().
331 bool isDIRef(const MDNode &N, const Metadata *MD);
333 // InstVisitor overrides...
334 using InstVisitor<Verifier>::visit;
335 void visit(Instruction &I);
337 void visitTruncInst(TruncInst &I);
338 void visitZExtInst(ZExtInst &I);
339 void visitSExtInst(SExtInst &I);
340 void visitFPTruncInst(FPTruncInst &I);
341 void visitFPExtInst(FPExtInst &I);
342 void visitFPToUIInst(FPToUIInst &I);
343 void visitFPToSIInst(FPToSIInst &I);
344 void visitUIToFPInst(UIToFPInst &I);
345 void visitSIToFPInst(SIToFPInst &I);
346 void visitIntToPtrInst(IntToPtrInst &I);
347 void visitPtrToIntInst(PtrToIntInst &I);
348 void visitBitCastInst(BitCastInst &I);
349 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
350 void visitPHINode(PHINode &PN);
351 void visitBinaryOperator(BinaryOperator &B);
352 void visitICmpInst(ICmpInst &IC);
353 void visitFCmpInst(FCmpInst &FC);
354 void visitExtractElementInst(ExtractElementInst &EI);
355 void visitInsertElementInst(InsertElementInst &EI);
356 void visitShuffleVectorInst(ShuffleVectorInst &EI);
357 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
358 void visitCallInst(CallInst &CI);
359 void visitInvokeInst(InvokeInst &II);
360 void visitGetElementPtrInst(GetElementPtrInst &GEP);
361 void visitLoadInst(LoadInst &LI);
362 void visitStoreInst(StoreInst &SI);
363 void verifyDominatesUse(Instruction &I, unsigned i);
364 void visitInstruction(Instruction &I);
365 void visitTerminatorInst(TerminatorInst &I);
366 void visitBranchInst(BranchInst &BI);
367 void visitReturnInst(ReturnInst &RI);
368 void visitSwitchInst(SwitchInst &SI);
369 void visitIndirectBrInst(IndirectBrInst &BI);
370 void visitSelectInst(SelectInst &SI);
371 void visitUserOp1(Instruction &I);
372 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
373 void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
374 template <class DbgIntrinsicTy>
375 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
376 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
377 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
378 void visitFenceInst(FenceInst &FI);
379 void visitAllocaInst(AllocaInst &AI);
380 void visitExtractValueInst(ExtractValueInst &EVI);
381 void visitInsertValueInst(InsertValueInst &IVI);
382 void visitLandingPadInst(LandingPadInst &LPI);
384 void VerifyCallSite(CallSite CS);
385 void verifyMustTailCall(CallInst &CI);
386 bool PerformTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
387 unsigned ArgNo, std::string &Suffix);
388 bool VerifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
389 SmallVectorImpl<Type *> &ArgTys);
390 bool VerifyIntrinsicIsVarArg(bool isVarArg,
391 ArrayRef<Intrinsic::IITDescriptor> &Infos);
392 bool VerifyAttributeCount(AttributeSet Attrs, unsigned Params);
393 void VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
395 void VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
396 bool isReturnValue, const Value *V);
397 void VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
400 void VerifyConstantExprBitcastType(const ConstantExpr *CE);
401 void VerifyStatepoint(ImmutableCallSite CS);
402 void verifyFrameRecoverIndices();
404 // Module-level debug info verification...
405 void verifyTypeRefs();
406 void visitUnresolvedTypeRef(const MDString *S, const MDNode *N);
408 } // End anonymous namespace
410 // Assert - We know that cond should be true, if not print an error message.
411 #define Assert(C, ...) \
412 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
414 void Verifier::visit(Instruction &I) {
415 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
416 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
417 InstVisitor<Verifier>::visit(I);
421 void Verifier::visitGlobalValue(const GlobalValue &GV) {
422 Assert(!GV.isDeclaration() || GV.hasExternalLinkage() ||
423 GV.hasExternalWeakLinkage(),
424 "Global is external, but doesn't have external or weak linkage!", &GV);
426 Assert(GV.getAlignment() <= Value::MaximumAlignment,
427 "huge alignment values are unsupported", &GV);
428 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
429 "Only global variables can have appending linkage!", &GV);
431 if (GV.hasAppendingLinkage()) {
432 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
433 Assert(GVar && GVar->getType()->getElementType()->isArrayTy(),
434 "Only global arrays can have appending linkage!", GVar);
438 void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
439 if (GV.hasInitializer()) {
440 Assert(GV.getInitializer()->getType() == GV.getType()->getElementType(),
441 "Global variable initializer type does not match global "
445 // If the global has common linkage, it must have a zero initializer and
446 // cannot be constant.
447 if (GV.hasCommonLinkage()) {
448 Assert(GV.getInitializer()->isNullValue(),
449 "'common' global must have a zero initializer!", &GV);
450 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
452 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
455 Assert(GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
456 "invalid linkage type for global declaration", &GV);
459 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
460 GV.getName() == "llvm.global_dtors")) {
461 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
462 "invalid linkage for intrinsic global variable", &GV);
463 // Don't worry about emitting an error for it not being an array,
464 // visitGlobalValue will complain on appending non-array.
465 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getType()->getElementType())) {
466 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
467 PointerType *FuncPtrTy =
468 FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
469 // FIXME: Reject the 2-field form in LLVM 4.0.
471 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
472 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
473 STy->getTypeAtIndex(1) == FuncPtrTy,
474 "wrong type for intrinsic global variable", &GV);
475 if (STy->getNumElements() == 3) {
476 Type *ETy = STy->getTypeAtIndex(2);
477 Assert(ETy->isPointerTy() &&
478 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
479 "wrong type for intrinsic global variable", &GV);
484 if (GV.hasName() && (GV.getName() == "llvm.used" ||
485 GV.getName() == "llvm.compiler.used")) {
486 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
487 "invalid linkage for intrinsic global variable", &GV);
488 Type *GVType = GV.getType()->getElementType();
489 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
490 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
491 Assert(PTy, "wrong type for intrinsic global variable", &GV);
492 if (GV.hasInitializer()) {
493 const Constant *Init = GV.getInitializer();
494 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
495 Assert(InitArray, "wrong initalizer for intrinsic global variable",
497 for (unsigned i = 0, e = InitArray->getNumOperands(); i != e; ++i) {
498 Value *V = Init->getOperand(i)->stripPointerCastsNoFollowAliases();
499 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
501 "invalid llvm.used member", V);
502 Assert(V->hasName(), "members of llvm.used must be named", V);
508 Assert(!GV.hasDLLImportStorageClass() ||
509 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
510 GV.hasAvailableExternallyLinkage(),
511 "Global is marked as dllimport, but not external", &GV);
513 if (!GV.hasInitializer()) {
514 visitGlobalValue(GV);
518 // Walk any aggregate initializers looking for bitcasts between address spaces
519 SmallPtrSet<const Value *, 4> Visited;
520 SmallVector<const Value *, 4> WorkStack;
521 WorkStack.push_back(cast<Value>(GV.getInitializer()));
523 while (!WorkStack.empty()) {
524 const Value *V = WorkStack.pop_back_val();
525 if (!Visited.insert(V).second)
528 if (const User *U = dyn_cast<User>(V)) {
529 WorkStack.append(U->op_begin(), U->op_end());
532 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
533 VerifyConstantExprBitcastType(CE);
539 visitGlobalValue(GV);
542 void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
543 SmallPtrSet<const GlobalAlias*, 4> Visited;
545 visitAliaseeSubExpr(Visited, GA, C);
548 void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
549 const GlobalAlias &GA, const Constant &C) {
550 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
551 Assert(!GV->isDeclaration(), "Alias must point to a definition", &GA);
553 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
554 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
556 Assert(!GA2->mayBeOverridden(), "Alias cannot point to a weak alias",
559 // Only continue verifying subexpressions of GlobalAliases.
560 // Do not recurse into global initializers.
565 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
566 VerifyConstantExprBitcastType(CE);
568 for (const Use &U : C.operands()) {
570 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
571 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
572 else if (const auto *C2 = dyn_cast<Constant>(V))
573 visitAliaseeSubExpr(Visited, GA, *C2);
577 void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
578 Assert(!GA.getName().empty(), "Alias name cannot be empty!", &GA);
579 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
580 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
581 "weak_odr, or external linkage!",
583 const Constant *Aliasee = GA.getAliasee();
584 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
585 Assert(GA.getType() == Aliasee->getType(),
586 "Alias and aliasee types should match!", &GA);
588 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
589 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
591 visitAliaseeSubExpr(GA, *Aliasee);
593 visitGlobalValue(GA);
596 void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
597 for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i) {
598 MDNode *MD = NMD.getOperand(i);
600 if (NMD.getName() == "llvm.dbg.cu") {
601 Assert(MD && isa<MDCompileUnit>(MD), "invalid compile unit", &NMD, MD);
611 void Verifier::visitMDNode(const MDNode &MD) {
612 // Only visit each node once. Metadata can be mutually recursive, so this
613 // avoids infinite recursion here, as well as being an optimization.
614 if (!MDNodes.insert(&MD).second)
617 switch (MD.getMetadataID()) {
619 llvm_unreachable("Invalid MDNode subclass");
620 case Metadata::MDTupleKind:
622 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
623 case Metadata::CLASS##Kind: \
624 visit##CLASS(cast<CLASS>(MD)); \
626 #include "llvm/IR/Metadata.def"
629 for (unsigned i = 0, e = MD.getNumOperands(); i != e; ++i) {
630 Metadata *Op = MD.getOperand(i);
633 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
635 if (auto *N = dyn_cast<MDNode>(Op)) {
639 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
640 visitValueAsMetadata(*V, nullptr);
645 // Check these last, so we diagnose problems in operands first.
646 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
647 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
650 void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
651 Assert(MD.getValue(), "Expected valid value", &MD);
652 Assert(!MD.getValue()->getType()->isMetadataTy(),
653 "Unexpected metadata round-trip through values", &MD, MD.getValue());
655 auto *L = dyn_cast<LocalAsMetadata>(&MD);
659 Assert(F, "function-local metadata used outside a function", L);
661 // If this was an instruction, bb, or argument, verify that it is in the
662 // function that we expect.
663 Function *ActualF = nullptr;
664 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
665 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
666 ActualF = I->getParent()->getParent();
667 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
668 ActualF = BB->getParent();
669 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
670 ActualF = A->getParent();
671 assert(ActualF && "Unimplemented function local metadata case!");
673 Assert(ActualF == F, "function-local metadata used in wrong function", L);
676 void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
677 Metadata *MD = MDV.getMetadata();
678 if (auto *N = dyn_cast<MDNode>(MD)) {
683 // Only visit each node once. Metadata can be mutually recursive, so this
684 // avoids infinite recursion here, as well as being an optimization.
685 if (!MDNodes.insert(MD).second)
688 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
689 visitValueAsMetadata(*V, F);
692 bool Verifier::isValidUUID(const MDNode &N, const Metadata *MD) {
693 auto *S = dyn_cast<MDString>(MD);
696 if (S->getString().empty())
699 // Keep track of names of types referenced via UUID so we can check that they
701 TypeRefs.insert(std::make_pair(S, &N));
705 /// \brief Check if a value can be a reference to a type.
706 bool Verifier::isTypeRef(const MDNode &N, const Metadata *MD) {
707 return !MD || isValidUUID(N, MD) || isa<MDType>(MD);
710 /// \brief Check if a value can be a ScopeRef.
711 bool Verifier::isScopeRef(const MDNode &N, const Metadata *MD) {
712 return !MD || isValidUUID(N, MD) || isa<MDScope>(MD);
715 /// \brief Check if a value can be a debug info ref.
716 bool Verifier::isDIRef(const MDNode &N, const Metadata *MD) {
717 return !MD || isValidUUID(N, MD) || isa<DebugNode>(MD);
721 bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
722 for (Metadata *MD : N.operands()) {
735 bool isValidMetadataArray(const MDTuple &N) {
736 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
740 bool isValidMetadataNullArray(const MDTuple &N) {
741 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
744 void Verifier::visitMDLocation(const MDLocation &N) {
745 Assert(N.getRawScope() && isa<MDLocalScope>(N.getRawScope()),
746 "location requires a valid scope", &N, N.getRawScope());
747 if (auto *IA = N.getRawInlinedAt())
748 Assert(isa<MDLocation>(IA), "inlined-at should be a location", &N, IA);
751 void Verifier::visitGenericDebugNode(const GenericDebugNode &N) {
752 Assert(N.getTag(), "invalid tag", &N);
755 void Verifier::visitMDScope(const MDScope &N) {
756 if (auto *F = N.getRawFile())
757 Assert(isa<MDFile>(F), "invalid file", &N, F);
760 void Verifier::visitMDSubrange(const MDSubrange &N) {
761 Assert(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
762 Assert(N.getCount() >= -1, "invalid subrange count", &N);
765 void Verifier::visitMDEnumerator(const MDEnumerator &N) {
766 Assert(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
769 void Verifier::visitMDBasicType(const MDBasicType &N) {
770 Assert(N.getTag() == dwarf::DW_TAG_base_type ||
771 N.getTag() == dwarf::DW_TAG_unspecified_type,
775 void Verifier::visitMDDerivedTypeBase(const MDDerivedTypeBase &N) {
776 // Common scope checks.
779 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
780 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
783 // FIXME: Sink this into the subclass verifies.
784 if (!N.getFile() || N.getFile()->getFilename().empty()) {
785 // Check whether the filename is allowed to be empty.
786 uint16_t Tag = N.getTag();
788 Tag == dwarf::DW_TAG_const_type || Tag == dwarf::DW_TAG_volatile_type ||
789 Tag == dwarf::DW_TAG_pointer_type ||
790 Tag == dwarf::DW_TAG_ptr_to_member_type ||
791 Tag == dwarf::DW_TAG_reference_type ||
792 Tag == dwarf::DW_TAG_rvalue_reference_type ||
793 Tag == dwarf::DW_TAG_restrict_type ||
794 Tag == dwarf::DW_TAG_array_type ||
795 Tag == dwarf::DW_TAG_enumeration_type ||
796 Tag == dwarf::DW_TAG_subroutine_type ||
797 Tag == dwarf::DW_TAG_inheritance || Tag == dwarf::DW_TAG_friend ||
798 Tag == dwarf::DW_TAG_structure_type ||
799 Tag == dwarf::DW_TAG_member || Tag == dwarf::DW_TAG_typedef,
800 "derived/composite type requires a filename", &N, N.getFile());
804 void Verifier::visitMDDerivedType(const MDDerivedType &N) {
805 // Common derived type checks.
806 visitMDDerivedTypeBase(N);
808 Assert(N.getTag() == dwarf::DW_TAG_typedef ||
809 N.getTag() == dwarf::DW_TAG_pointer_type ||
810 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
811 N.getTag() == dwarf::DW_TAG_reference_type ||
812 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
813 N.getTag() == dwarf::DW_TAG_const_type ||
814 N.getTag() == dwarf::DW_TAG_volatile_type ||
815 N.getTag() == dwarf::DW_TAG_restrict_type ||
816 N.getTag() == dwarf::DW_TAG_member ||
817 N.getTag() == dwarf::DW_TAG_inheritance ||
818 N.getTag() == dwarf::DW_TAG_friend,
820 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
821 Assert(isTypeRef(N, N.getExtraData()), "invalid pointer to member type", &N,
826 static bool hasConflictingReferenceFlags(unsigned Flags) {
827 return (Flags & DebugNode::FlagLValueReference) &&
828 (Flags & DebugNode::FlagRValueReference);
831 void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
832 auto *Params = dyn_cast<MDTuple>(&RawParams);
833 Assert(Params, "invalid template params", &N, &RawParams);
834 for (Metadata *Op : Params->operands()) {
835 Assert(Op && isa<MDTemplateParameter>(Op), "invalid template parameter", &N,
840 void Verifier::visitMDCompositeType(const MDCompositeType &N) {
841 // Common derived type checks.
842 visitMDDerivedTypeBase(N);
844 Assert(N.getTag() == dwarf::DW_TAG_array_type ||
845 N.getTag() == dwarf::DW_TAG_structure_type ||
846 N.getTag() == dwarf::DW_TAG_union_type ||
847 N.getTag() == dwarf::DW_TAG_enumeration_type ||
848 N.getTag() == dwarf::DW_TAG_subroutine_type ||
849 N.getTag() == dwarf::DW_TAG_class_type,
852 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
853 "invalid composite elements", &N, N.getRawElements());
854 Assert(isTypeRef(N, N.getRawVTableHolder()), "invalid vtable holder", &N,
855 N.getRawVTableHolder());
856 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
857 "invalid composite elements", &N, N.getRawElements());
858 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
860 if (auto *Params = N.getRawTemplateParams())
861 visitTemplateParams(N, *Params);
864 void Verifier::visitMDSubroutineType(const MDSubroutineType &N) {
865 Assert(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
866 if (auto *Types = N.getRawTypeArray()) {
867 Assert(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
868 for (Metadata *Ty : N.getTypeArray()->operands()) {
869 Assert(isTypeRef(N, Ty), "invalid subroutine type ref", &N, Types, Ty);
872 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
876 void Verifier::visitMDFile(const MDFile &N) {
877 Assert(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
880 void Verifier::visitMDCompileUnit(const MDCompileUnit &N) {
881 Assert(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
883 // Don't bother verifying the compilation directory or producer string
884 // as those could be empty.
885 Assert(N.getRawFile() && isa<MDFile>(N.getRawFile()),
886 "invalid file", &N, N.getRawFile());
887 Assert(!N.getFile()->getFilename().empty(), "invalid filename", &N,
890 if (auto *Array = N.getRawEnumTypes()) {
891 Assert(isa<MDTuple>(Array), "invalid enum list", &N, Array);
892 for (Metadata *Op : N.getEnumTypes()->operands()) {
893 auto *Enum = dyn_cast_or_null<MDCompositeType>(Op);
894 Assert(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
895 "invalid enum type", &N, N.getEnumTypes(), Op);
898 if (auto *Array = N.getRawRetainedTypes()) {
899 Assert(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
900 for (Metadata *Op : N.getRetainedTypes()->operands()) {
901 Assert(Op && isa<MDType>(Op), "invalid retained type", &N, Op);
904 if (auto *Array = N.getRawSubprograms()) {
905 Assert(isa<MDTuple>(Array), "invalid subprogram list", &N, Array);
906 for (Metadata *Op : N.getSubprograms()->operands()) {
907 Assert(Op && isa<MDSubprogram>(Op), "invalid subprogram ref", &N, Op);
910 if (auto *Array = N.getRawGlobalVariables()) {
911 Assert(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
912 for (Metadata *Op : N.getGlobalVariables()->operands()) {
913 Assert(Op && isa<MDGlobalVariable>(Op), "invalid global variable ref", &N,
917 if (auto *Array = N.getRawImportedEntities()) {
918 Assert(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
919 for (Metadata *Op : N.getImportedEntities()->operands()) {
920 Assert(Op && isa<MDImportedEntity>(Op), "invalid imported entity ref", &N,
926 void Verifier::visitMDSubprogram(const MDSubprogram &N) {
927 Assert(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
928 Assert(isScopeRef(N, N.getRawScope()), "invalid scope", &N, N.getRawScope());
929 if (auto *T = N.getRawType())
930 Assert(isa<MDSubroutineType>(T), "invalid subroutine type", &N, T);
931 Assert(isTypeRef(N, N.getRawContainingType()), "invalid containing type", &N,
932 N.getRawContainingType());
933 if (auto *RawF = N.getRawFunction()) {
934 auto *FMD = dyn_cast<ConstantAsMetadata>(RawF);
935 auto *F = FMD ? FMD->getValue() : nullptr;
936 auto *FT = F ? dyn_cast<PointerType>(F->getType()) : nullptr;
937 Assert(F && FT && isa<FunctionType>(FT->getElementType()),
938 "invalid function", &N, F, FT);
940 if (auto *Params = N.getRawTemplateParams())
941 visitTemplateParams(N, *Params);
942 if (auto *S = N.getRawDeclaration()) {
943 Assert(isa<MDSubprogram>(S) && !cast<MDSubprogram>(S)->isDefinition(),
944 "invalid subprogram declaration", &N, S);
946 if (auto *RawVars = N.getRawVariables()) {
947 auto *Vars = dyn_cast<MDTuple>(RawVars);
948 Assert(Vars, "invalid variable list", &N, RawVars);
949 for (Metadata *Op : Vars->operands()) {
950 Assert(Op && isa<MDLocalVariable>(Op), "invalid local variable", &N, Vars,
954 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
957 if (!N.getFunction())
960 // FIXME: Should this be looking through bitcasts?
961 auto *F = dyn_cast<Function>(N.getFunction()->getValue());
965 // Check that all !dbg attachments lead to back to N (or, at least, another
966 // subprogram that describes the same function).
968 // FIXME: Check this incrementally while visiting !dbg attachments.
969 // FIXME: Only check when N is the canonical subprogram for F.
970 SmallPtrSet<const MDNode *, 32> Seen;
973 // Be careful about using MDLocation here since we might be dealing with
974 // broken code (this is the Verifier after all).
976 dyn_cast_or_null<MDLocation>(I.getDebugLoc().getAsMDNode());
979 if (!Seen.insert(DL).second)
982 MDLocalScope *Scope = DL->getInlinedAtScope();
983 if (Scope && !Seen.insert(Scope).second)
986 MDSubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
987 if (SP && !Seen.insert(SP).second)
990 // FIXME: Once N is canonical, check "SP == &N".
991 Assert(DISubprogram(SP).describes(F),
992 "!dbg attachment points at wrong subprogram for function", &N, F,
997 void Verifier::visitMDLexicalBlockBase(const MDLexicalBlockBase &N) {
998 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
999 Assert(N.getRawScope() && isa<MDLocalScope>(N.getRawScope()),
1000 "invalid local scope", &N, N.getRawScope());
1003 void Verifier::visitMDLexicalBlock(const MDLexicalBlock &N) {
1004 visitMDLexicalBlockBase(N);
1006 Assert(N.getLine() || !N.getColumn(),
1007 "cannot have column info without line info", &N);
1010 void Verifier::visitMDLexicalBlockFile(const MDLexicalBlockFile &N) {
1011 visitMDLexicalBlockBase(N);
1014 void Verifier::visitMDNamespace(const MDNamespace &N) {
1015 Assert(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
1016 if (auto *S = N.getRawScope())
1017 Assert(isa<MDScope>(S), "invalid scope ref", &N, S);
1020 void Verifier::visitMDTemplateParameter(const MDTemplateParameter &N) {
1021 Assert(isTypeRef(N, N.getType()), "invalid type ref", &N, N.getType());
1024 void Verifier::visitMDTemplateTypeParameter(const MDTemplateTypeParameter &N) {
1025 visitMDTemplateParameter(N);
1027 Assert(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1031 void Verifier::visitMDTemplateValueParameter(
1032 const MDTemplateValueParameter &N) {
1033 visitMDTemplateParameter(N);
1035 Assert(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1036 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1037 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1041 void Verifier::visitMDVariable(const MDVariable &N) {
1042 if (auto *S = N.getRawScope())
1043 Assert(isa<MDScope>(S), "invalid scope", &N, S);
1044 Assert(isTypeRef(N, N.getRawType()), "invalid type ref", &N, N.getRawType());
1045 if (auto *F = N.getRawFile())
1046 Assert(isa<MDFile>(F), "invalid file", &N, F);
1049 void Verifier::visitMDGlobalVariable(const MDGlobalVariable &N) {
1050 // Checks common to all variables.
1053 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1054 Assert(!N.getName().empty(), "missing global variable name", &N);
1055 if (auto *V = N.getRawVariable()) {
1056 Assert(isa<ConstantAsMetadata>(V) &&
1057 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
1058 "invalid global varaible ref", &N, V);
1060 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
1061 Assert(isa<MDDerivedType>(Member), "invalid static data member declaration",
1066 void Verifier::visitMDLocalVariable(const MDLocalVariable &N) {
1067 // Checks common to all variables.
1070 Assert(N.getTag() == dwarf::DW_TAG_auto_variable ||
1071 N.getTag() == dwarf::DW_TAG_arg_variable,
1073 Assert(N.getRawScope() && isa<MDLocalScope>(N.getRawScope()),
1074 "local variable requires a valid scope", &N, N.getRawScope());
1075 if (auto *IA = N.getRawInlinedAt())
1076 Assert(isa<MDLocation>(IA), "local variable requires a valid scope", &N,
1080 void Verifier::visitMDExpression(const MDExpression &N) {
1081 Assert(N.isValid(), "invalid expression", &N);
1084 void Verifier::visitMDObjCProperty(const MDObjCProperty &N) {
1085 Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
1086 if (auto *T = N.getRawType())
1087 Assert(isa<MDType>(T), "invalid type ref", &N, T);
1088 if (auto *F = N.getRawFile())
1089 Assert(isa<MDFile>(F), "invalid file", &N, F);
1092 void Verifier::visitMDImportedEntity(const MDImportedEntity &N) {
1093 Assert(N.getTag() == dwarf::DW_TAG_imported_module ||
1094 N.getTag() == dwarf::DW_TAG_imported_declaration,
1096 if (auto *S = N.getRawScope())
1097 Assert(isa<MDScope>(S), "invalid scope for imported entity", &N, S);
1098 Assert(isDIRef(N, N.getEntity()), "invalid imported entity", &N,
1102 void Verifier::visitComdat(const Comdat &C) {
1103 // The Module is invalid if the GlobalValue has private linkage. Entities
1104 // with private linkage don't have entries in the symbol table.
1105 if (const GlobalValue *GV = M->getNamedValue(C.getName()))
1106 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1110 void Verifier::visitModuleIdents(const Module &M) {
1111 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1115 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1116 // Scan each llvm.ident entry and make sure that this requirement is met.
1117 for (unsigned i = 0, e = Idents->getNumOperands(); i != e; ++i) {
1118 const MDNode *N = Idents->getOperand(i);
1119 Assert(N->getNumOperands() == 1,
1120 "incorrect number of operands in llvm.ident metadata", N);
1121 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1122 ("invalid value for llvm.ident metadata entry operand"
1123 "(the operand should be a string)"),
1128 void Verifier::visitModuleFlags(const Module &M) {
1129 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1132 // Scan each flag, and track the flags and requirements.
1133 DenseMap<const MDString*, const MDNode*> SeenIDs;
1134 SmallVector<const MDNode*, 16> Requirements;
1135 for (unsigned I = 0, E = Flags->getNumOperands(); I != E; ++I) {
1136 visitModuleFlag(Flags->getOperand(I), SeenIDs, Requirements);
1139 // Validate that the requirements in the module are valid.
1140 for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
1141 const MDNode *Requirement = Requirements[I];
1142 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
1143 const Metadata *ReqValue = Requirement->getOperand(1);
1145 const MDNode *Op = SeenIDs.lookup(Flag);
1147 CheckFailed("invalid requirement on flag, flag is not present in module",
1152 if (Op->getOperand(2) != ReqValue) {
1153 CheckFailed(("invalid requirement on flag, "
1154 "flag does not have the required value"),
1162 Verifier::visitModuleFlag(const MDNode *Op,
1163 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1164 SmallVectorImpl<const MDNode *> &Requirements) {
1165 // Each module flag should have three arguments, the merge behavior (a
1166 // constant int), the flag ID (an MDString), and the value.
1167 Assert(Op->getNumOperands() == 3,
1168 "incorrect number of operands in module flag", Op);
1169 Module::ModFlagBehavior MFB;
1170 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
1172 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
1173 "invalid behavior operand in module flag (expected constant integer)",
1176 "invalid behavior operand in module flag (unexpected constant)",
1179 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
1180 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1183 // Sanity check the values for behaviors with additional requirements.
1186 case Module::Warning:
1187 case Module::Override:
1188 // These behavior types accept any value.
1191 case Module::Require: {
1192 // The value should itself be an MDNode with two operands, a flag ID (an
1193 // MDString), and a value.
1194 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
1195 Assert(Value && Value->getNumOperands() == 2,
1196 "invalid value for 'require' module flag (expected metadata pair)",
1198 Assert(isa<MDString>(Value->getOperand(0)),
1199 ("invalid value for 'require' module flag "
1200 "(first value operand should be a string)"),
1201 Value->getOperand(0));
1203 // Append it to the list of requirements, to check once all module flags are
1205 Requirements.push_back(Value);
1209 case Module::Append:
1210 case Module::AppendUnique: {
1211 // These behavior types require the operand be an MDNode.
1212 Assert(isa<MDNode>(Op->getOperand(2)),
1213 "invalid value for 'append'-type module flag "
1214 "(expected a metadata node)",
1220 // Unless this is a "requires" flag, check the ID is unique.
1221 if (MFB != Module::Require) {
1222 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
1224 "module flag identifiers must be unique (or of 'require' type)", ID);
1228 void Verifier::VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
1229 bool isFunction, const Value *V) {
1230 unsigned Slot = ~0U;
1231 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1232 if (Attrs.getSlotIndex(I) == Idx) {
1237 assert(Slot != ~0U && "Attribute set inconsistency!");
1239 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1241 if (I->isStringAttribute())
1244 if (I->getKindAsEnum() == Attribute::NoReturn ||
1245 I->getKindAsEnum() == Attribute::NoUnwind ||
1246 I->getKindAsEnum() == Attribute::NoInline ||
1247 I->getKindAsEnum() == Attribute::AlwaysInline ||
1248 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1249 I->getKindAsEnum() == Attribute::StackProtect ||
1250 I->getKindAsEnum() == Attribute::StackProtectReq ||
1251 I->getKindAsEnum() == Attribute::StackProtectStrong ||
1252 I->getKindAsEnum() == Attribute::NoRedZone ||
1253 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1254 I->getKindAsEnum() == Attribute::Naked ||
1255 I->getKindAsEnum() == Attribute::InlineHint ||
1256 I->getKindAsEnum() == Attribute::StackAlignment ||
1257 I->getKindAsEnum() == Attribute::UWTable ||
1258 I->getKindAsEnum() == Attribute::NonLazyBind ||
1259 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1260 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1261 I->getKindAsEnum() == Attribute::SanitizeThread ||
1262 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1263 I->getKindAsEnum() == Attribute::MinSize ||
1264 I->getKindAsEnum() == Attribute::NoDuplicate ||
1265 I->getKindAsEnum() == Attribute::Builtin ||
1266 I->getKindAsEnum() == Attribute::NoBuiltin ||
1267 I->getKindAsEnum() == Attribute::Cold ||
1268 I->getKindAsEnum() == Attribute::OptimizeNone ||
1269 I->getKindAsEnum() == Attribute::JumpTable) {
1271 CheckFailed("Attribute '" + I->getAsString() +
1272 "' only applies to functions!", V);
1275 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
1276 I->getKindAsEnum() == Attribute::ReadNone) {
1278 CheckFailed("Attribute '" + I->getAsString() +
1279 "' does not apply to function returns");
1282 } else if (isFunction) {
1283 CheckFailed("Attribute '" + I->getAsString() +
1284 "' does not apply to functions!", V);
1290 // VerifyParameterAttrs - Check the given attributes for an argument or return
1291 // value of the specified type. The value V is printed in error messages.
1292 void Verifier::VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
1293 bool isReturnValue, const Value *V) {
1294 if (!Attrs.hasAttributes(Idx))
1297 VerifyAttributeTypes(Attrs, Idx, false, V);
1300 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1301 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1302 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1303 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1304 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
1305 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1306 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', and "
1307 "'returned' do not apply to return values!",
1310 // Check for mutually incompatible attributes. Only inreg is compatible with
1312 unsigned AttrCount = 0;
1313 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1314 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1315 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1316 Attrs.hasAttribute(Idx, Attribute::InReg);
1317 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
1318 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1319 "and 'sret' are incompatible!",
1322 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1323 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1325 "'inalloca and readonly' are incompatible!",
1328 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1329 Attrs.hasAttribute(Idx, Attribute::Returned)),
1331 "'sret and returned' are incompatible!",
1334 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1335 Attrs.hasAttribute(Idx, Attribute::SExt)),
1337 "'zeroext and signext' are incompatible!",
1340 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1341 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1343 "'readnone and readonly' are incompatible!",
1346 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1347 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1349 "'noinline and alwaysinline' are incompatible!",
1352 Assert(!AttrBuilder(Attrs, Idx)
1353 .hasAttributes(AttributeFuncs::typeIncompatible(Ty, Idx), Idx),
1354 "Wrong types for attribute: " +
1355 AttributeFuncs::typeIncompatible(Ty, Idx).getAsString(Idx),
1358 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
1359 SmallPtrSet<const Type*, 4> Visited;
1360 if (!PTy->getElementType()->isSized(&Visited)) {
1361 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1362 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1363 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1367 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1368 "Attribute 'byval' only applies to parameters with pointer type!",
1373 // VerifyFunctionAttrs - Check parameter attributes against a function type.
1374 // The value V is printed in error messages.
1375 void Verifier::VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
1377 if (Attrs.isEmpty())
1380 bool SawNest = false;
1381 bool SawReturned = false;
1382 bool SawSRet = false;
1384 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
1385 unsigned Idx = Attrs.getSlotIndex(i);
1389 Ty = FT->getReturnType();
1390 else if (Idx-1 < FT->getNumParams())
1391 Ty = FT->getParamType(Idx-1);
1393 break; // VarArgs attributes, verified elsewhere.
1395 VerifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
1400 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
1401 Assert(!SawNest, "More than one parameter has attribute nest!", V);
1405 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
1406 Assert(!SawReturned, "More than one parameter has attribute returned!",
1408 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1410 "argument and return types for 'returned' attribute",
1415 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
1416 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1417 Assert(Idx == 1 || Idx == 2,
1418 "Attribute 'sret' is not on first or second parameter!", V);
1422 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
1423 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1428 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1431 VerifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
1434 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1435 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1436 "Attributes 'readnone and readonly' are incompatible!", V);
1439 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1440 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1441 Attribute::AlwaysInline)),
1442 "Attributes 'noinline and alwaysinline' are incompatible!", V);
1444 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1445 Attribute::OptimizeNone)) {
1446 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1447 "Attribute 'optnone' requires 'noinline'!", V);
1449 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1450 Attribute::OptimizeForSize),
1451 "Attributes 'optsize and optnone' are incompatible!", V);
1453 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1454 "Attributes 'minsize and optnone' are incompatible!", V);
1457 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1458 Attribute::JumpTable)) {
1459 const GlobalValue *GV = cast<GlobalValue>(V);
1460 Assert(GV->hasUnnamedAddr(),
1461 "Attribute 'jumptable' requires 'unnamed_addr'", V);
1465 void Verifier::VerifyConstantExprBitcastType(const ConstantExpr *CE) {
1466 if (CE->getOpcode() != Instruction::BitCast)
1469 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1471 "Invalid bitcast", CE);
1474 bool Verifier::VerifyAttributeCount(AttributeSet Attrs, unsigned Params) {
1475 if (Attrs.getNumSlots() == 0)
1478 unsigned LastSlot = Attrs.getNumSlots() - 1;
1479 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
1480 if (LastIndex <= Params
1481 || (LastIndex == AttributeSet::FunctionIndex
1482 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
1488 /// \brief Verify that statepoint intrinsic is well formed.
1489 void Verifier::VerifyStatepoint(ImmutableCallSite CS) {
1490 assert(CS.getCalledFunction() &&
1491 CS.getCalledFunction()->getIntrinsicID() ==
1492 Intrinsic::experimental_gc_statepoint);
1494 const Instruction &CI = *CS.getInstruction();
1496 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory(),
1497 "gc.statepoint must read and write memory to preserve "
1498 "reordering restrictions required by safepoint semantics",
1501 const Value *Target = CS.getArgument(0);
1502 const PointerType *PT = dyn_cast<PointerType>(Target->getType());
1503 Assert(PT && PT->getElementType()->isFunctionTy(),
1504 "gc.statepoint callee must be of function pointer type", &CI, Target);
1505 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
1507 const Value *NumCallArgsV = CS.getArgument(1);
1508 Assert(isa<ConstantInt>(NumCallArgsV),
1509 "gc.statepoint number of arguments to underlying call "
1510 "must be constant integer",
1512 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
1513 Assert(NumCallArgs >= 0,
1514 "gc.statepoint number of arguments to underlying call "
1517 const int NumParams = (int)TargetFuncType->getNumParams();
1518 if (TargetFuncType->isVarArg()) {
1519 Assert(NumCallArgs >= NumParams,
1520 "gc.statepoint mismatch in number of vararg call args", &CI);
1522 // TODO: Remove this limitation
1523 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1524 "gc.statepoint doesn't support wrapping non-void "
1525 "vararg functions yet",
1528 Assert(NumCallArgs == NumParams,
1529 "gc.statepoint mismatch in number of call args", &CI);
1531 const Value *Unused = CS.getArgument(2);
1532 Assert(isa<ConstantInt>(Unused) && cast<ConstantInt>(Unused)->isNullValue(),
1533 "gc.statepoint parameter #3 must be zero", &CI);
1535 // Verify that the types of the call parameter arguments match
1536 // the type of the wrapped callee.
1537 for (int i = 0; i < NumParams; i++) {
1538 Type *ParamType = TargetFuncType->getParamType(i);
1539 Type *ArgType = CS.getArgument(3+i)->getType();
1540 Assert(ArgType == ParamType,
1541 "gc.statepoint call argument does not match wrapped "
1545 const int EndCallArgsInx = 2+NumCallArgs;
1546 const Value *NumDeoptArgsV = CS.getArgument(EndCallArgsInx+1);
1547 Assert(isa<ConstantInt>(NumDeoptArgsV),
1548 "gc.statepoint number of deoptimization arguments "
1549 "must be constant integer",
1551 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
1552 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1556 Assert(4 + NumCallArgs + NumDeoptArgs <= (int)CS.arg_size(),
1557 "gc.statepoint too few arguments according to length fields", &CI);
1559 // Check that the only uses of this gc.statepoint are gc.result or
1560 // gc.relocate calls which are tied to this statepoint and thus part
1561 // of the same statepoint sequence
1562 for (const User *U : CI.users()) {
1563 const CallInst *Call = dyn_cast<const CallInst>(U);
1564 Assert(Call, "illegal use of statepoint token", &CI, U);
1565 if (!Call) continue;
1566 Assert(isGCRelocate(Call) || isGCResult(Call),
1567 "gc.result or gc.relocate are the only value uses"
1568 "of a gc.statepoint",
1570 if (isGCResult(Call)) {
1571 Assert(Call->getArgOperand(0) == &CI,
1572 "gc.result connected to wrong gc.statepoint", &CI, Call);
1573 } else if (isGCRelocate(Call)) {
1574 Assert(Call->getArgOperand(0) == &CI,
1575 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
1579 // Note: It is legal for a single derived pointer to be listed multiple
1580 // times. It's non-optimal, but it is legal. It can also happen after
1581 // insertion if we strip a bitcast away.
1582 // Note: It is really tempting to check that each base is relocated and
1583 // that a derived pointer is never reused as a base pointer. This turns
1584 // out to be problematic since optimizations run after safepoint insertion
1585 // can recognize equality properties that the insertion logic doesn't know
1586 // about. See example statepoint.ll in the verifier subdirectory
1589 void Verifier::verifyFrameRecoverIndices() {
1590 for (auto &Counts : FrameEscapeInfo) {
1591 Function *F = Counts.first;
1592 unsigned EscapedObjectCount = Counts.second.first;
1593 unsigned MaxRecoveredIndex = Counts.second.second;
1594 Assert(MaxRecoveredIndex <= EscapedObjectCount,
1595 "all indices passed to llvm.framerecover must be less than the "
1596 "number of arguments passed ot llvm.frameescape in the parent "
1602 // visitFunction - Verify that a function is ok.
1604 void Verifier::visitFunction(const Function &F) {
1605 // Check function arguments.
1606 FunctionType *FT = F.getFunctionType();
1607 unsigned NumArgs = F.arg_size();
1609 Assert(Context == &F.getContext(),
1610 "Function context does not match Module context!", &F);
1612 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1613 Assert(FT->getNumParams() == NumArgs,
1614 "# formal arguments must match # of arguments for function type!", &F,
1616 Assert(F.getReturnType()->isFirstClassType() ||
1617 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1618 "Functions cannot return aggregate values!", &F);
1620 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1621 "Invalid struct return type!", &F);
1623 AttributeSet Attrs = F.getAttributes();
1625 Assert(VerifyAttributeCount(Attrs, FT->getNumParams()),
1626 "Attribute after last parameter!", &F);
1628 // Check function attributes.
1629 VerifyFunctionAttrs(FT, Attrs, &F);
1631 // On function declarations/definitions, we do not support the builtin
1632 // attribute. We do not check this in VerifyFunctionAttrs since that is
1633 // checking for Attributes that can/can not ever be on functions.
1634 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1635 "Attribute 'builtin' can only be applied to a callsite.", &F);
1637 // Check that this function meets the restrictions on this calling convention.
1638 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1639 // restrictions can be lifted.
1640 switch (F.getCallingConv()) {
1642 case CallingConv::C:
1644 case CallingConv::Fast:
1645 case CallingConv::Cold:
1646 case CallingConv::Intel_OCL_BI:
1647 case CallingConv::PTX_Kernel:
1648 case CallingConv::PTX_Device:
1649 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1650 "perfect forwarding!",
1655 bool isLLVMdotName = F.getName().size() >= 5 &&
1656 F.getName().substr(0, 5) == "llvm.";
1658 // Check that the argument values match the function type for this function...
1660 for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E;
1662 Assert(I->getType() == FT->getParamType(i),
1663 "Argument value does not match function argument type!", I,
1664 FT->getParamType(i));
1665 Assert(I->getType()->isFirstClassType(),
1666 "Function arguments must have first-class types!", I);
1668 Assert(!I->getType()->isMetadataTy(),
1669 "Function takes metadata but isn't an intrinsic", I, &F);
1672 if (F.isMaterializable()) {
1673 // Function has a body somewhere we can't see.
1674 } else if (F.isDeclaration()) {
1675 Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1676 "invalid linkage type for function declaration", &F);
1678 // Verify that this function (which has a body) is not named "llvm.*". It
1679 // is not legal to define intrinsics.
1680 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
1682 // Check the entry node
1683 const BasicBlock *Entry = &F.getEntryBlock();
1684 Assert(pred_empty(Entry),
1685 "Entry block to function must not have predecessors!", Entry);
1687 // The address of the entry block cannot be taken, unless it is dead.
1688 if (Entry->hasAddressTaken()) {
1689 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1690 "blockaddress may not be used with the entry block!", Entry);
1694 // If this function is actually an intrinsic, verify that it is only used in
1695 // direct call/invokes, never having its "address taken".
1696 if (F.getIntrinsicID()) {
1698 if (F.hasAddressTaken(&U))
1699 Assert(0, "Invalid user of intrinsic instruction!", U);
1702 Assert(!F.hasDLLImportStorageClass() ||
1703 (F.isDeclaration() && F.hasExternalLinkage()) ||
1704 F.hasAvailableExternallyLinkage(),
1705 "Function is marked as dllimport, but not external.", &F);
1708 // verifyBasicBlock - Verify that a basic block is well formed...
1710 void Verifier::visitBasicBlock(BasicBlock &BB) {
1711 InstsInThisBlock.clear();
1713 // Ensure that basic blocks have terminators!
1714 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
1716 // Check constraints that this basic block imposes on all of the PHI nodes in
1718 if (isa<PHINode>(BB.front())) {
1719 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
1720 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
1721 std::sort(Preds.begin(), Preds.end());
1723 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
1724 // Ensure that PHI nodes have at least one entry!
1725 Assert(PN->getNumIncomingValues() != 0,
1726 "PHI nodes must have at least one entry. If the block is dead, "
1727 "the PHI should be removed!",
1729 Assert(PN->getNumIncomingValues() == Preds.size(),
1730 "PHINode should have one entry for each predecessor of its "
1731 "parent basic block!",
1734 // Get and sort all incoming values in the PHI node...
1736 Values.reserve(PN->getNumIncomingValues());
1737 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1738 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
1739 PN->getIncomingValue(i)));
1740 std::sort(Values.begin(), Values.end());
1742 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
1743 // Check to make sure that if there is more than one entry for a
1744 // particular basic block in this PHI node, that the incoming values are
1747 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
1748 Values[i].second == Values[i - 1].second,
1749 "PHI node has multiple entries for the same basic block with "
1750 "different incoming values!",
1751 PN, Values[i].first, Values[i].second, Values[i - 1].second);
1753 // Check to make sure that the predecessors and PHI node entries are
1755 Assert(Values[i].first == Preds[i],
1756 "PHI node entries do not match predecessors!", PN,
1757 Values[i].first, Preds[i]);
1762 // Check that all instructions have their parent pointers set up correctly.
1765 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
1769 void Verifier::visitTerminatorInst(TerminatorInst &I) {
1770 // Ensure that terminators only exist at the end of the basic block.
1771 Assert(&I == I.getParent()->getTerminator(),
1772 "Terminator found in the middle of a basic block!", I.getParent());
1773 visitInstruction(I);
1776 void Verifier::visitBranchInst(BranchInst &BI) {
1777 if (BI.isConditional()) {
1778 Assert(BI.getCondition()->getType()->isIntegerTy(1),
1779 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
1781 visitTerminatorInst(BI);
1784 void Verifier::visitReturnInst(ReturnInst &RI) {
1785 Function *F = RI.getParent()->getParent();
1786 unsigned N = RI.getNumOperands();
1787 if (F->getReturnType()->isVoidTy())
1789 "Found return instr that returns non-void in Function of void "
1791 &RI, F->getReturnType());
1793 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
1794 "Function return type does not match operand "
1795 "type of return inst!",
1796 &RI, F->getReturnType());
1798 // Check to make sure that the return value has necessary properties for
1800 visitTerminatorInst(RI);
1803 void Verifier::visitSwitchInst(SwitchInst &SI) {
1804 // Check to make sure that all of the constants in the switch instruction
1805 // have the same type as the switched-on value.
1806 Type *SwitchTy = SI.getCondition()->getType();
1807 SmallPtrSet<ConstantInt*, 32> Constants;
1808 for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end(); i != e; ++i) {
1809 Assert(i.getCaseValue()->getType() == SwitchTy,
1810 "Switch constants must all be same type as switch value!", &SI);
1811 Assert(Constants.insert(i.getCaseValue()).second,
1812 "Duplicate integer as switch case", &SI, i.getCaseValue());
1815 visitTerminatorInst(SI);
1818 void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
1819 Assert(BI.getAddress()->getType()->isPointerTy(),
1820 "Indirectbr operand must have pointer type!", &BI);
1821 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
1822 Assert(BI.getDestination(i)->getType()->isLabelTy(),
1823 "Indirectbr destinations must all have pointer type!", &BI);
1825 visitTerminatorInst(BI);
1828 void Verifier::visitSelectInst(SelectInst &SI) {
1829 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
1831 "Invalid operands for select instruction!", &SI);
1833 Assert(SI.getTrueValue()->getType() == SI.getType(),
1834 "Select values must have same type as select instruction!", &SI);
1835 visitInstruction(SI);
1838 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
1839 /// a pass, if any exist, it's an error.
1841 void Verifier::visitUserOp1(Instruction &I) {
1842 Assert(0, "User-defined operators should not live outside of a pass!", &I);
1845 void Verifier::visitTruncInst(TruncInst &I) {
1846 // Get the source and destination types
1847 Type *SrcTy = I.getOperand(0)->getType();
1848 Type *DestTy = I.getType();
1850 // Get the size of the types in bits, we'll need this later
1851 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1852 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1854 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
1855 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
1856 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1857 "trunc source and destination must both be a vector or neither", &I);
1858 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
1860 visitInstruction(I);
1863 void Verifier::visitZExtInst(ZExtInst &I) {
1864 // Get the source and destination types
1865 Type *SrcTy = I.getOperand(0)->getType();
1866 Type *DestTy = I.getType();
1868 // Get the size of the types in bits, we'll need this later
1869 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
1870 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
1871 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1872 "zext source and destination must both be a vector or neither", &I);
1873 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1874 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1876 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
1878 visitInstruction(I);
1881 void Verifier::visitSExtInst(SExtInst &I) {
1882 // Get the source and destination types
1883 Type *SrcTy = I.getOperand(0)->getType();
1884 Type *DestTy = I.getType();
1886 // Get the size of the types in bits, we'll need this later
1887 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1888 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1890 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
1891 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
1892 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1893 "sext source and destination must both be a vector or neither", &I);
1894 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
1896 visitInstruction(I);
1899 void Verifier::visitFPTruncInst(FPTruncInst &I) {
1900 // Get the source and destination types
1901 Type *SrcTy = I.getOperand(0)->getType();
1902 Type *DestTy = I.getType();
1903 // Get the size of the types in bits, we'll need this later
1904 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1905 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1907 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
1908 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
1909 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1910 "fptrunc source and destination must both be a vector or neither", &I);
1911 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
1913 visitInstruction(I);
1916 void Verifier::visitFPExtInst(FPExtInst &I) {
1917 // Get the source and destination types
1918 Type *SrcTy = I.getOperand(0)->getType();
1919 Type *DestTy = I.getType();
1921 // Get the size of the types in bits, we'll need this later
1922 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1923 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1925 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
1926 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
1927 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1928 "fpext source and destination must both be a vector or neither", &I);
1929 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
1931 visitInstruction(I);
1934 void Verifier::visitUIToFPInst(UIToFPInst &I) {
1935 // Get the source and destination types
1936 Type *SrcTy = I.getOperand(0)->getType();
1937 Type *DestTy = I.getType();
1939 bool SrcVec = SrcTy->isVectorTy();
1940 bool DstVec = DestTy->isVectorTy();
1942 Assert(SrcVec == DstVec,
1943 "UIToFP source and dest must both be vector or scalar", &I);
1944 Assert(SrcTy->isIntOrIntVectorTy(),
1945 "UIToFP source must be integer or integer vector", &I);
1946 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
1949 if (SrcVec && DstVec)
1950 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
1951 cast<VectorType>(DestTy)->getNumElements(),
1952 "UIToFP source and dest vector length mismatch", &I);
1954 visitInstruction(I);
1957 void Verifier::visitSIToFPInst(SIToFPInst &I) {
1958 // Get the source and destination types
1959 Type *SrcTy = I.getOperand(0)->getType();
1960 Type *DestTy = I.getType();
1962 bool SrcVec = SrcTy->isVectorTy();
1963 bool DstVec = DestTy->isVectorTy();
1965 Assert(SrcVec == DstVec,
1966 "SIToFP source and dest must both be vector or scalar", &I);
1967 Assert(SrcTy->isIntOrIntVectorTy(),
1968 "SIToFP source must be integer or integer vector", &I);
1969 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
1972 if (SrcVec && DstVec)
1973 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
1974 cast<VectorType>(DestTy)->getNumElements(),
1975 "SIToFP source and dest vector length mismatch", &I);
1977 visitInstruction(I);
1980 void Verifier::visitFPToUIInst(FPToUIInst &I) {
1981 // Get the source and destination types
1982 Type *SrcTy = I.getOperand(0)->getType();
1983 Type *DestTy = I.getType();
1985 bool SrcVec = SrcTy->isVectorTy();
1986 bool DstVec = DestTy->isVectorTy();
1988 Assert(SrcVec == DstVec,
1989 "FPToUI source and dest must both be vector or scalar", &I);
1990 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
1992 Assert(DestTy->isIntOrIntVectorTy(),
1993 "FPToUI result must be integer or integer vector", &I);
1995 if (SrcVec && DstVec)
1996 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
1997 cast<VectorType>(DestTy)->getNumElements(),
1998 "FPToUI source and dest vector length mismatch", &I);
2000 visitInstruction(I);
2003 void Verifier::visitFPToSIInst(FPToSIInst &I) {
2004 // Get the source and destination types
2005 Type *SrcTy = I.getOperand(0)->getType();
2006 Type *DestTy = I.getType();
2008 bool SrcVec = SrcTy->isVectorTy();
2009 bool DstVec = DestTy->isVectorTy();
2011 Assert(SrcVec == DstVec,
2012 "FPToSI source and dest must both be vector or scalar", &I);
2013 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2015 Assert(DestTy->isIntOrIntVectorTy(),
2016 "FPToSI result must be integer or integer vector", &I);
2018 if (SrcVec && DstVec)
2019 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2020 cast<VectorType>(DestTy)->getNumElements(),
2021 "FPToSI source and dest vector length mismatch", &I);
2023 visitInstruction(I);
2026 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2027 // Get the source and destination types
2028 Type *SrcTy = I.getOperand(0)->getType();
2029 Type *DestTy = I.getType();
2031 Assert(SrcTy->getScalarType()->isPointerTy(),
2032 "PtrToInt source must be pointer", &I);
2033 Assert(DestTy->getScalarType()->isIntegerTy(),
2034 "PtrToInt result must be integral", &I);
2035 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2038 if (SrcTy->isVectorTy()) {
2039 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2040 VectorType *VDest = dyn_cast<VectorType>(DestTy);
2041 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2042 "PtrToInt Vector width mismatch", &I);
2045 visitInstruction(I);
2048 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2049 // Get the source and destination types
2050 Type *SrcTy = I.getOperand(0)->getType();
2051 Type *DestTy = I.getType();
2053 Assert(SrcTy->getScalarType()->isIntegerTy(),
2054 "IntToPtr source must be an integral", &I);
2055 Assert(DestTy->getScalarType()->isPointerTy(),
2056 "IntToPtr result must be a pointer", &I);
2057 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2059 if (SrcTy->isVectorTy()) {
2060 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2061 VectorType *VDest = dyn_cast<VectorType>(DestTy);
2062 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2063 "IntToPtr Vector width mismatch", &I);
2065 visitInstruction(I);
2068 void Verifier::visitBitCastInst(BitCastInst &I) {
2070 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2071 "Invalid bitcast", &I);
2072 visitInstruction(I);
2075 void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2076 Type *SrcTy = I.getOperand(0)->getType();
2077 Type *DestTy = I.getType();
2079 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2081 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2083 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2084 "AddrSpaceCast must be between different address spaces", &I);
2085 if (SrcTy->isVectorTy())
2086 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2087 "AddrSpaceCast vector pointer number of elements mismatch", &I);
2088 visitInstruction(I);
2091 /// visitPHINode - Ensure that a PHI node is well formed.
2093 void Verifier::visitPHINode(PHINode &PN) {
2094 // Ensure that the PHI nodes are all grouped together at the top of the block.
2095 // This can be tested by checking whether the instruction before this is
2096 // either nonexistent (because this is begin()) or is a PHI node. If not,
2097 // then there is some other instruction before a PHI.
2098 Assert(&PN == &PN.getParent()->front() ||
2099 isa<PHINode>(--BasicBlock::iterator(&PN)),
2100 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
2102 // Check that all of the values of the PHI node have the same type as the
2103 // result, and that the incoming blocks are really basic blocks.
2104 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
2105 Assert(PN.getType() == PN.getIncomingValue(i)->getType(),
2106 "PHI node operands are not the same type as the result!", &PN);
2109 // All other PHI node constraints are checked in the visitBasicBlock method.
2111 visitInstruction(PN);
2114 void Verifier::VerifyCallSite(CallSite CS) {
2115 Instruction *I = CS.getInstruction();
2117 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2118 "Called function must be a pointer!", I);
2119 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
2121 Assert(FPTy->getElementType()->isFunctionTy(),
2122 "Called function is not pointer to function type!", I);
2123 FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
2125 // Verify that the correct number of arguments are being passed
2126 if (FTy->isVarArg())
2127 Assert(CS.arg_size() >= FTy->getNumParams(),
2128 "Called function requires more parameters than were provided!", I);
2130 Assert(CS.arg_size() == FTy->getNumParams(),
2131 "Incorrect number of arguments passed to called function!", I);
2133 // Verify that all arguments to the call match the function type.
2134 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2135 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2136 "Call parameter type does not match function signature!",
2137 CS.getArgument(i), FTy->getParamType(i), I);
2139 AttributeSet Attrs = CS.getAttributes();
2141 Assert(VerifyAttributeCount(Attrs, CS.arg_size()),
2142 "Attribute after last parameter!", I);
2144 // Verify call attributes.
2145 VerifyFunctionAttrs(FTy, Attrs, I);
2147 // Conservatively check the inalloca argument.
2148 // We have a bug if we can find that there is an underlying alloca without
2150 if (CS.hasInAllocaArgument()) {
2151 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2152 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
2153 Assert(AI->isUsedWithInAlloca(),
2154 "inalloca argument for call has mismatched alloca", AI, I);
2157 if (FTy->isVarArg()) {
2158 // FIXME? is 'nest' even legal here?
2159 bool SawNest = false;
2160 bool SawReturned = false;
2162 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2163 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2165 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2169 // Check attributes on the varargs part.
2170 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
2171 Type *Ty = CS.getArgument(Idx-1)->getType();
2172 VerifyParameterAttrs(Attrs, Idx, Ty, false, I);
2174 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
2175 Assert(!SawNest, "More than one parameter has attribute nest!", I);
2179 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
2180 Assert(!SawReturned, "More than one parameter has attribute returned!",
2182 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2183 "Incompatible argument and return types for 'returned' "
2189 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2190 "Attribute 'sret' cannot be used for vararg call arguments!", I);
2192 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
2193 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
2197 // Verify that there's no metadata unless it's a direct call to an intrinsic.
2198 if (CS.getCalledFunction() == nullptr ||
2199 !CS.getCalledFunction()->getName().startswith("llvm.")) {
2200 for (FunctionType::param_iterator PI = FTy->param_begin(),
2201 PE = FTy->param_end(); PI != PE; ++PI)
2202 Assert(!(*PI)->isMetadataTy(),
2203 "Function has metadata parameter but isn't an intrinsic", I);
2206 visitInstruction(*I);
2209 /// Two types are "congruent" if they are identical, or if they are both pointer
2210 /// types with different pointee types and the same address space.
2211 static bool isTypeCongruent(Type *L, Type *R) {
2214 PointerType *PL = dyn_cast<PointerType>(L);
2215 PointerType *PR = dyn_cast<PointerType>(R);
2218 return PL->getAddressSpace() == PR->getAddressSpace();
2221 static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2222 static const Attribute::AttrKind ABIAttrs[] = {
2223 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
2224 Attribute::InReg, Attribute::Returned};
2226 for (auto AK : ABIAttrs) {
2227 if (Attrs.hasAttribute(I + 1, AK))
2228 Copy.addAttribute(AK);
2230 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2231 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2235 void Verifier::verifyMustTailCall(CallInst &CI) {
2236 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
2238 // - The caller and callee prototypes must match. Pointer types of
2239 // parameters or return types may differ in pointee type, but not
2241 Function *F = CI.getParent()->getParent();
2242 auto GetFnTy = [](Value *V) {
2243 return cast<FunctionType>(
2244 cast<PointerType>(V->getType())->getElementType());
2246 FunctionType *CallerTy = GetFnTy(F);
2247 FunctionType *CalleeTy = GetFnTy(CI.getCalledValue());
2248 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2249 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2250 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2251 "cannot guarantee tail call due to mismatched varargs", &CI);
2252 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2253 "cannot guarantee tail call due to mismatched return types", &CI);
2254 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2256 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2257 "cannot guarantee tail call due to mismatched parameter types", &CI);
2260 // - The calling conventions of the caller and callee must match.
2261 Assert(F->getCallingConv() == CI.getCallingConv(),
2262 "cannot guarantee tail call due to mismatched calling conv", &CI);
2264 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2265 // returned, and inalloca, must match.
2266 AttributeSet CallerAttrs = F->getAttributes();
2267 AttributeSet CalleeAttrs = CI.getAttributes();
2268 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2269 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2270 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
2271 Assert(CallerABIAttrs == CalleeABIAttrs,
2272 "cannot guarantee tail call due to mismatched ABI impacting "
2273 "function attributes",
2274 &CI, CI.getOperand(I));
2277 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2278 // or a pointer bitcast followed by a ret instruction.
2279 // - The ret instruction must return the (possibly bitcasted) value
2280 // produced by the call or void.
2281 Value *RetVal = &CI;
2282 Instruction *Next = CI.getNextNode();
2284 // Handle the optional bitcast.
2285 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
2286 Assert(BI->getOperand(0) == RetVal,
2287 "bitcast following musttail call must use the call", BI);
2289 Next = BI->getNextNode();
2292 // Check the return.
2293 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
2294 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2296 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2297 "musttail call result must be returned", Ret);
2300 void Verifier::visitCallInst(CallInst &CI) {
2301 VerifyCallSite(&CI);
2303 if (CI.isMustTailCall())
2304 verifyMustTailCall(CI);
2306 if (Function *F = CI.getCalledFunction())
2307 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
2308 visitIntrinsicFunctionCall(ID, CI);
2311 void Verifier::visitInvokeInst(InvokeInst &II) {
2312 VerifyCallSite(&II);
2314 // Verify that there is a landingpad instruction as the first non-PHI
2315 // instruction of the 'unwind' destination.
2316 Assert(II.getUnwindDest()->isLandingPad(),
2317 "The unwind destination does not have a landingpad instruction!", &II);
2319 if (Function *F = II.getCalledFunction())
2320 // TODO: Ideally we should use visitIntrinsicFunction here. But it uses
2321 // CallInst as an input parameter. It not woth updating this whole
2322 // function only to support statepoint verification.
2323 if (F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint)
2324 VerifyStatepoint(ImmutableCallSite(&II));
2326 visitTerminatorInst(II);
2329 /// visitBinaryOperator - Check that both arguments to the binary operator are
2330 /// of the same type!
2332 void Verifier::visitBinaryOperator(BinaryOperator &B) {
2333 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2334 "Both operands to a binary operator are not of the same type!", &B);
2336 switch (B.getOpcode()) {
2337 // Check that integer arithmetic operators are only used with
2338 // integral operands.
2339 case Instruction::Add:
2340 case Instruction::Sub:
2341 case Instruction::Mul:
2342 case Instruction::SDiv:
2343 case Instruction::UDiv:
2344 case Instruction::SRem:
2345 case Instruction::URem:
2346 Assert(B.getType()->isIntOrIntVectorTy(),
2347 "Integer arithmetic operators only work with integral types!", &B);
2348 Assert(B.getType() == B.getOperand(0)->getType(),
2349 "Integer arithmetic operators must have same type "
2350 "for operands and result!",
2353 // Check that floating-point arithmetic operators are only used with
2354 // floating-point operands.
2355 case Instruction::FAdd:
2356 case Instruction::FSub:
2357 case Instruction::FMul:
2358 case Instruction::FDiv:
2359 case Instruction::FRem:
2360 Assert(B.getType()->isFPOrFPVectorTy(),
2361 "Floating-point arithmetic operators only work with "
2362 "floating-point types!",
2364 Assert(B.getType() == B.getOperand(0)->getType(),
2365 "Floating-point arithmetic operators must have same type "
2366 "for operands and result!",
2369 // Check that logical operators are only used with integral operands.
2370 case Instruction::And:
2371 case Instruction::Or:
2372 case Instruction::Xor:
2373 Assert(B.getType()->isIntOrIntVectorTy(),
2374 "Logical operators only work with integral types!", &B);
2375 Assert(B.getType() == B.getOperand(0)->getType(),
2376 "Logical operators must have same type for operands and result!",
2379 case Instruction::Shl:
2380 case Instruction::LShr:
2381 case Instruction::AShr:
2382 Assert(B.getType()->isIntOrIntVectorTy(),
2383 "Shifts only work with integral types!", &B);
2384 Assert(B.getType() == B.getOperand(0)->getType(),
2385 "Shift return type must be same as operands!", &B);
2388 llvm_unreachable("Unknown BinaryOperator opcode!");
2391 visitInstruction(B);
2394 void Verifier::visitICmpInst(ICmpInst &IC) {
2395 // Check that the operands are the same type
2396 Type *Op0Ty = IC.getOperand(0)->getType();
2397 Type *Op1Ty = IC.getOperand(1)->getType();
2398 Assert(Op0Ty == Op1Ty,
2399 "Both operands to ICmp instruction are not of the same type!", &IC);
2400 // Check that the operands are the right type
2401 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2402 "Invalid operand types for ICmp instruction", &IC);
2403 // Check that the predicate is valid.
2404 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2405 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2406 "Invalid predicate in ICmp instruction!", &IC);
2408 visitInstruction(IC);
2411 void Verifier::visitFCmpInst(FCmpInst &FC) {
2412 // Check that the operands are the same type
2413 Type *Op0Ty = FC.getOperand(0)->getType();
2414 Type *Op1Ty = FC.getOperand(1)->getType();
2415 Assert(Op0Ty == Op1Ty,
2416 "Both operands to FCmp instruction are not of the same type!", &FC);
2417 // Check that the operands are the right type
2418 Assert(Op0Ty->isFPOrFPVectorTy(),
2419 "Invalid operand types for FCmp instruction", &FC);
2420 // Check that the predicate is valid.
2421 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2422 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2423 "Invalid predicate in FCmp instruction!", &FC);
2425 visitInstruction(FC);
2428 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
2430 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2431 "Invalid extractelement operands!", &EI);
2432 visitInstruction(EI);
2435 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
2436 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2438 "Invalid insertelement operands!", &IE);
2439 visitInstruction(IE);
2442 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
2443 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2445 "Invalid shufflevector operands!", &SV);
2446 visitInstruction(SV);
2449 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
2450 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
2452 Assert(isa<PointerType>(TargetTy),
2453 "GEP base pointer is not a vector or a vector of pointers", &GEP);
2454 Assert(cast<PointerType>(TargetTy)->getElementType()->isSized(),
2455 "GEP into unsized type!", &GEP);
2456 Assert(GEP.getPointerOperandType()->isVectorTy() ==
2457 GEP.getType()->isVectorTy(),
2458 "Vector GEP must return a vector value", &GEP);
2460 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
2462 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
2463 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
2465 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
2466 cast<PointerType>(GEP.getType()->getScalarType())
2467 ->getElementType() == ElTy,
2468 "GEP is not of right type for indices!", &GEP, ElTy);
2470 if (GEP.getPointerOperandType()->isVectorTy()) {
2471 // Additional checks for vector GEPs.
2472 unsigned GepWidth = GEP.getPointerOperandType()->getVectorNumElements();
2473 Assert(GepWidth == GEP.getType()->getVectorNumElements(),
2474 "Vector GEP result width doesn't match operand's", &GEP);
2475 for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
2476 Type *IndexTy = Idxs[i]->getType();
2477 Assert(IndexTy->isVectorTy(), "Vector GEP must have vector indices!",
2479 unsigned IndexWidth = IndexTy->getVectorNumElements();
2480 Assert(IndexWidth == GepWidth, "Invalid GEP index vector width", &GEP);
2483 visitInstruction(GEP);
2486 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2487 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2490 void Verifier::visitRangeMetadata(Instruction& I,
2491 MDNode* Range, Type* Ty) {
2493 Range == I.getMetadata(LLVMContext::MD_range) &&
2494 "precondition violation");
2496 unsigned NumOperands = Range->getNumOperands();
2497 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
2498 unsigned NumRanges = NumOperands / 2;
2499 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2501 ConstantRange LastRange(1); // Dummy initial value
2502 for (unsigned i = 0; i < NumRanges; ++i) {
2504 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
2505 Assert(Low, "The lower limit must be an integer!", Low);
2507 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
2508 Assert(High, "The upper limit must be an integer!", High);
2509 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2510 "Range types must match instruction type!", &I);
2512 APInt HighV = High->getValue();
2513 APInt LowV = Low->getValue();
2514 ConstantRange CurRange(LowV, HighV);
2515 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2516 "Range must not be empty!", Range);
2518 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2519 "Intervals are overlapping", Range);
2520 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2522 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2525 LastRange = ConstantRange(LowV, HighV);
2527 if (NumRanges > 2) {
2529 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
2531 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
2532 ConstantRange FirstRange(FirstLow, FirstHigh);
2533 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2534 "Intervals are overlapping", Range);
2535 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2540 void Verifier::visitLoadInst(LoadInst &LI) {
2541 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
2542 Assert(PTy, "Load operand must be a pointer.", &LI);
2543 Type *ElTy = LI.getType();
2544 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2545 "huge alignment values are unsupported", &LI);
2546 if (LI.isAtomic()) {
2547 Assert(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
2548 "Load cannot have Release ordering", &LI);
2549 Assert(LI.getAlignment() != 0,
2550 "Atomic load must specify explicit alignment", &LI);
2551 if (!ElTy->isPointerTy()) {
2552 Assert(ElTy->isIntegerTy(), "atomic load operand must have integer type!",
2554 unsigned Size = ElTy->getPrimitiveSizeInBits();
2555 Assert(Size >= 8 && !(Size & (Size - 1)),
2556 "atomic load operand must be power-of-two byte-sized integer", &LI,
2560 Assert(LI.getSynchScope() == CrossThread,
2561 "Non-atomic load cannot have SynchronizationScope specified", &LI);
2564 visitInstruction(LI);
2567 void Verifier::visitStoreInst(StoreInst &SI) {
2568 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
2569 Assert(PTy, "Store operand must be a pointer.", &SI);
2570 Type *ElTy = PTy->getElementType();
2571 Assert(ElTy == SI.getOperand(0)->getType(),
2572 "Stored value type does not match pointer operand type!", &SI, ElTy);
2573 Assert(SI.getAlignment() <= Value::MaximumAlignment,
2574 "huge alignment values are unsupported", &SI);
2575 if (SI.isAtomic()) {
2576 Assert(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
2577 "Store cannot have Acquire ordering", &SI);
2578 Assert(SI.getAlignment() != 0,
2579 "Atomic store must specify explicit alignment", &SI);
2580 if (!ElTy->isPointerTy()) {
2581 Assert(ElTy->isIntegerTy(),
2582 "atomic store operand must have integer type!", &SI, ElTy);
2583 unsigned Size = ElTy->getPrimitiveSizeInBits();
2584 Assert(Size >= 8 && !(Size & (Size - 1)),
2585 "atomic store operand must be power-of-two byte-sized integer",
2589 Assert(SI.getSynchScope() == CrossThread,
2590 "Non-atomic store cannot have SynchronizationScope specified", &SI);
2592 visitInstruction(SI);
2595 void Verifier::visitAllocaInst(AllocaInst &AI) {
2596 SmallPtrSet<const Type*, 4> Visited;
2597 PointerType *PTy = AI.getType();
2598 Assert(PTy->getAddressSpace() == 0,
2599 "Allocation instruction pointer not in the generic address space!",
2601 Assert(PTy->getElementType()->isSized(&Visited),
2602 "Cannot allocate unsized type", &AI);
2603 Assert(AI.getArraySize()->getType()->isIntegerTy(),
2604 "Alloca array size must have integer type", &AI);
2605 Assert(AI.getAlignment() <= Value::MaximumAlignment,
2606 "huge alignment values are unsupported", &AI);
2608 visitInstruction(AI);
2611 void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
2613 // FIXME: more conditions???
2614 Assert(CXI.getSuccessOrdering() != NotAtomic,
2615 "cmpxchg instructions must be atomic.", &CXI);
2616 Assert(CXI.getFailureOrdering() != NotAtomic,
2617 "cmpxchg instructions must be atomic.", &CXI);
2618 Assert(CXI.getSuccessOrdering() != Unordered,
2619 "cmpxchg instructions cannot be unordered.", &CXI);
2620 Assert(CXI.getFailureOrdering() != Unordered,
2621 "cmpxchg instructions cannot be unordered.", &CXI);
2622 Assert(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
2623 "cmpxchg instructions be at least as constrained on success as fail",
2625 Assert(CXI.getFailureOrdering() != Release &&
2626 CXI.getFailureOrdering() != AcquireRelease,
2627 "cmpxchg failure ordering cannot include release semantics", &CXI);
2629 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
2630 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
2631 Type *ElTy = PTy->getElementType();
2632 Assert(ElTy->isIntegerTy(), "cmpxchg operand must have integer type!", &CXI,
2634 unsigned Size = ElTy->getPrimitiveSizeInBits();
2635 Assert(Size >= 8 && !(Size & (Size - 1)),
2636 "cmpxchg operand must be power-of-two byte-sized integer", &CXI, ElTy);
2637 Assert(ElTy == CXI.getOperand(1)->getType(),
2638 "Expected value type does not match pointer operand type!", &CXI,
2640 Assert(ElTy == CXI.getOperand(2)->getType(),
2641 "Stored value type does not match pointer operand type!", &CXI, ElTy);
2642 visitInstruction(CXI);
2645 void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
2646 Assert(RMWI.getOrdering() != NotAtomic,
2647 "atomicrmw instructions must be atomic.", &RMWI);
2648 Assert(RMWI.getOrdering() != Unordered,
2649 "atomicrmw instructions cannot be unordered.", &RMWI);
2650 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
2651 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
2652 Type *ElTy = PTy->getElementType();
2653 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
2655 unsigned Size = ElTy->getPrimitiveSizeInBits();
2656 Assert(Size >= 8 && !(Size & (Size - 1)),
2657 "atomicrmw operand must be power-of-two byte-sized integer", &RMWI,
2659 Assert(ElTy == RMWI.getOperand(1)->getType(),
2660 "Argument value type does not match pointer operand type!", &RMWI,
2662 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
2663 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
2664 "Invalid binary operation!", &RMWI);
2665 visitInstruction(RMWI);
2668 void Verifier::visitFenceInst(FenceInst &FI) {
2669 const AtomicOrdering Ordering = FI.getOrdering();
2670 Assert(Ordering == Acquire || Ordering == Release ||
2671 Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
2672 "fence instructions may only have "
2673 "acquire, release, acq_rel, or seq_cst ordering.",
2675 visitInstruction(FI);
2678 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
2679 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
2680 EVI.getIndices()) == EVI.getType(),
2681 "Invalid ExtractValueInst operands!", &EVI);
2683 visitInstruction(EVI);
2686 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
2687 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
2688 IVI.getIndices()) ==
2689 IVI.getOperand(1)->getType(),
2690 "Invalid InsertValueInst operands!", &IVI);
2692 visitInstruction(IVI);
2695 void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
2696 BasicBlock *BB = LPI.getParent();
2698 // The landingpad instruction is ill-formed if it doesn't have any clauses and
2700 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
2701 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
2703 // The landingpad instruction defines its parent as a landing pad block. The
2704 // landing pad block may be branched to only by the unwind edge of an invoke.
2705 for (pred_iterator I = pred_begin(BB), E = pred_end(BB); I != E; ++I) {
2706 const InvokeInst *II = dyn_cast<InvokeInst>((*I)->getTerminator());
2707 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
2708 "Block containing LandingPadInst must be jumped to "
2709 "only by the unwind edge of an invoke.",
2713 // The landingpad instruction must be the first non-PHI instruction in the
2715 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
2716 "LandingPadInst not the first non-PHI instruction in the block.",
2719 // The personality functions for all landingpad instructions within the same
2720 // function should match.
2722 Assert(LPI.getPersonalityFn() == PersonalityFn,
2723 "Personality function doesn't match others in function", &LPI);
2724 PersonalityFn = LPI.getPersonalityFn();
2726 // All operands must be constants.
2727 Assert(isa<Constant>(PersonalityFn), "Personality function is not constant!",
2729 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
2730 Constant *Clause = LPI.getClause(i);
2731 if (LPI.isCatch(i)) {
2732 Assert(isa<PointerType>(Clause->getType()),
2733 "Catch operand does not have pointer type!", &LPI);
2735 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
2736 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
2737 "Filter operand is not an array of constants!", &LPI);
2741 visitInstruction(LPI);
2744 void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
2745 Instruction *Op = cast<Instruction>(I.getOperand(i));
2746 // If the we have an invalid invoke, don't try to compute the dominance.
2747 // We already reject it in the invoke specific checks and the dominance
2748 // computation doesn't handle multiple edges.
2749 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
2750 if (II->getNormalDest() == II->getUnwindDest())
2754 const Use &U = I.getOperandUse(i);
2755 Assert(InstsInThisBlock.count(Op) || DT.dominates(Op, U),
2756 "Instruction does not dominate all uses!", Op, &I);
2759 /// verifyInstruction - Verify that an instruction is well formed.
2761 void Verifier::visitInstruction(Instruction &I) {
2762 BasicBlock *BB = I.getParent();
2763 Assert(BB, "Instruction not embedded in basic block!", &I);
2765 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
2766 for (User *U : I.users()) {
2767 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
2768 "Only PHI nodes may reference their own value!", &I);
2772 // Check that void typed values don't have names
2773 Assert(!I.getType()->isVoidTy() || !I.hasName(),
2774 "Instruction has a name, but provides a void value!", &I);
2776 // Check that the return value of the instruction is either void or a legal
2778 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
2779 "Instruction returns a non-scalar type!", &I);
2781 // Check that the instruction doesn't produce metadata. Calls are already
2782 // checked against the callee type.
2783 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
2784 "Invalid use of metadata!", &I);
2786 // Check that all uses of the instruction, if they are instructions
2787 // themselves, actually have parent basic blocks. If the use is not an
2788 // instruction, it is an error!
2789 for (Use &U : I.uses()) {
2790 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
2791 Assert(Used->getParent() != nullptr,
2792 "Instruction referencing"
2793 " instruction not embedded in a basic block!",
2796 CheckFailed("Use of instruction is not an instruction!", U);
2801 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
2802 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
2804 // Check to make sure that only first-class-values are operands to
2806 if (!I.getOperand(i)->getType()->isFirstClassType()) {
2807 Assert(0, "Instruction operands must be first-class values!", &I);
2810 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
2811 // Check to make sure that the "address of" an intrinsic function is never
2814 !F->isIntrinsic() ||
2815 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
2816 "Cannot take the address of an intrinsic!", &I);
2818 !F->isIntrinsic() || isa<CallInst>(I) ||
2819 F->getIntrinsicID() == Intrinsic::donothing ||
2820 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
2821 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
2822 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
2823 "Cannot invoke an intrinsinc other than"
2824 " donothing or patchpoint",
2826 Assert(F->getParent() == M, "Referencing function in another module!",
2828 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
2829 Assert(OpBB->getParent() == BB->getParent(),
2830 "Referring to a basic block in another function!", &I);
2831 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
2832 Assert(OpArg->getParent() == BB->getParent(),
2833 "Referring to an argument in another function!", &I);
2834 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
2835 Assert(GV->getParent() == M, "Referencing global in another module!", &I);
2836 } else if (isa<Instruction>(I.getOperand(i))) {
2837 verifyDominatesUse(I, i);
2838 } else if (isa<InlineAsm>(I.getOperand(i))) {
2839 Assert((i + 1 == e && isa<CallInst>(I)) ||
2840 (i + 3 == e && isa<InvokeInst>(I)),
2841 "Cannot take the address of an inline asm!", &I);
2842 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
2843 if (CE->getType()->isPtrOrPtrVectorTy()) {
2844 // If we have a ConstantExpr pointer, we need to see if it came from an
2845 // illegal bitcast (inttoptr <constant int> )
2846 SmallVector<const ConstantExpr *, 4> Stack;
2847 SmallPtrSet<const ConstantExpr *, 4> Visited;
2848 Stack.push_back(CE);
2850 while (!Stack.empty()) {
2851 const ConstantExpr *V = Stack.pop_back_val();
2852 if (!Visited.insert(V).second)
2855 VerifyConstantExprBitcastType(V);
2857 for (unsigned I = 0, N = V->getNumOperands(); I != N; ++I) {
2858 if (ConstantExpr *Op = dyn_cast<ConstantExpr>(V->getOperand(I)))
2859 Stack.push_back(Op);
2866 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
2867 Assert(I.getType()->isFPOrFPVectorTy(),
2868 "fpmath requires a floating point result!", &I);
2869 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
2870 if (ConstantFP *CFP0 =
2871 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
2872 APFloat Accuracy = CFP0->getValueAPF();
2873 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
2874 "fpmath accuracy not a positive number!", &I);
2876 Assert(false, "invalid fpmath accuracy!", &I);
2880 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
2881 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
2882 "Ranges are only for loads, calls and invokes!", &I);
2883 visitRangeMetadata(I, Range, I.getType());
2886 if (I.getMetadata(LLVMContext::MD_nonnull)) {
2887 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
2889 Assert(isa<LoadInst>(I),
2890 "nonnull applies only to load instructions, use attributes"
2891 " for calls or invokes",
2895 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
2896 Assert(isa<MDLocation>(N), "invalid !dbg metadata attachment", &I, N);
2900 InstsInThisBlock.insert(&I);
2903 /// VerifyIntrinsicType - Verify that the specified type (which comes from an
2904 /// intrinsic argument or return value) matches the type constraints specified
2905 /// by the .td file (e.g. an "any integer" argument really is an integer).
2907 /// This return true on error but does not print a message.
2908 bool Verifier::VerifyIntrinsicType(Type *Ty,
2909 ArrayRef<Intrinsic::IITDescriptor> &Infos,
2910 SmallVectorImpl<Type*> &ArgTys) {
2911 using namespace Intrinsic;
2913 // If we ran out of descriptors, there are too many arguments.
2914 if (Infos.empty()) return true;
2915 IITDescriptor D = Infos.front();
2916 Infos = Infos.slice(1);
2919 case IITDescriptor::Void: return !Ty->isVoidTy();
2920 case IITDescriptor::VarArg: return true;
2921 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
2922 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
2923 case IITDescriptor::Half: return !Ty->isHalfTy();
2924 case IITDescriptor::Float: return !Ty->isFloatTy();
2925 case IITDescriptor::Double: return !Ty->isDoubleTy();
2926 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
2927 case IITDescriptor::Vector: {
2928 VectorType *VT = dyn_cast<VectorType>(Ty);
2929 return !VT || VT->getNumElements() != D.Vector_Width ||
2930 VerifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
2932 case IITDescriptor::Pointer: {
2933 PointerType *PT = dyn_cast<PointerType>(Ty);
2934 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
2935 VerifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
2938 case IITDescriptor::Struct: {
2939 StructType *ST = dyn_cast<StructType>(Ty);
2940 if (!ST || ST->getNumElements() != D.Struct_NumElements)
2943 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
2944 if (VerifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
2949 case IITDescriptor::Argument:
2950 // Two cases here - If this is the second occurrence of an argument, verify
2951 // that the later instance matches the previous instance.
2952 if (D.getArgumentNumber() < ArgTys.size())
2953 return Ty != ArgTys[D.getArgumentNumber()];
2955 // Otherwise, if this is the first instance of an argument, record it and
2956 // verify the "Any" kind.
2957 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
2958 ArgTys.push_back(Ty);
2960 switch (D.getArgumentKind()) {
2961 case IITDescriptor::AK_Any: return false; // Success
2962 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
2963 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
2964 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
2965 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
2967 llvm_unreachable("all argument kinds not covered");
2969 case IITDescriptor::ExtendArgument: {
2970 // This may only be used when referring to a previous vector argument.
2971 if (D.getArgumentNumber() >= ArgTys.size())
2974 Type *NewTy = ArgTys[D.getArgumentNumber()];
2975 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
2976 NewTy = VectorType::getExtendedElementVectorType(VTy);
2977 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
2978 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
2984 case IITDescriptor::TruncArgument: {
2985 // This may only be used when referring to a previous vector argument.
2986 if (D.getArgumentNumber() >= ArgTys.size())
2989 Type *NewTy = ArgTys[D.getArgumentNumber()];
2990 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
2991 NewTy = VectorType::getTruncatedElementVectorType(VTy);
2992 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
2993 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
2999 case IITDescriptor::HalfVecArgument:
3000 // This may only be used when referring to a previous vector argument.
3001 return D.getArgumentNumber() >= ArgTys.size() ||
3002 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
3003 VectorType::getHalfElementsVectorType(
3004 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
3005 case IITDescriptor::SameVecWidthArgument: {
3006 if (D.getArgumentNumber() >= ArgTys.size())
3008 VectorType * ReferenceType =
3009 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
3010 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
3011 if (!ThisArgType || !ReferenceType ||
3012 (ReferenceType->getVectorNumElements() !=
3013 ThisArgType->getVectorNumElements()))
3015 return VerifyIntrinsicType(ThisArgType->getVectorElementType(),
3018 case IITDescriptor::PtrToArgument: {
3019 if (D.getArgumentNumber() >= ArgTys.size())
3021 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
3022 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
3023 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
3025 case IITDescriptor::VecOfPtrsToElt: {
3026 if (D.getArgumentNumber() >= ArgTys.size())
3028 VectorType * ReferenceType =
3029 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
3030 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
3031 if (!ThisArgVecTy || !ReferenceType ||
3032 (ReferenceType->getVectorNumElements() !=
3033 ThisArgVecTy->getVectorNumElements()))
3035 PointerType *ThisArgEltTy =
3036 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
3039 return (!(ThisArgEltTy->getElementType() ==
3040 ReferenceType->getVectorElementType()));
3043 llvm_unreachable("unhandled");
3046 /// \brief Verify if the intrinsic has variable arguments.
3047 /// This method is intended to be called after all the fixed arguments have been
3050 /// This method returns true on error and does not print an error message.
3052 Verifier::VerifyIntrinsicIsVarArg(bool isVarArg,
3053 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
3054 using namespace Intrinsic;
3056 // If there are no descriptors left, then it can't be a vararg.
3060 // There should be only one descriptor remaining at this point.
3061 if (Infos.size() != 1)
3064 // Check and verify the descriptor.
3065 IITDescriptor D = Infos.front();
3066 Infos = Infos.slice(1);
3067 if (D.Kind == IITDescriptor::VarArg)
3073 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
3075 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
3076 Function *IF = CI.getCalledFunction();
3077 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3080 // Verify that the intrinsic prototype lines up with what the .td files
3082 FunctionType *IFTy = IF->getFunctionType();
3083 bool IsVarArg = IFTy->isVarArg();
3085 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3086 getIntrinsicInfoTableEntries(ID, Table);
3087 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
3089 SmallVector<Type *, 4> ArgTys;
3090 Assert(!VerifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
3091 "Intrinsic has incorrect return type!", IF);
3092 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
3093 Assert(!VerifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
3094 "Intrinsic has incorrect argument type!", IF);
3096 // Verify if the intrinsic call matches the vararg property.
3098 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3099 "Intrinsic was not defined with variable arguments!", IF);
3101 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3102 "Callsite was not defined with variable arguments!", IF);
3104 // All descriptors should be absorbed by now.
3105 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
3107 // Now that we have the intrinsic ID and the actual argument types (and we
3108 // know they are legal for the intrinsic!) get the intrinsic name through the
3109 // usual means. This allows us to verify the mangling of argument types into
3111 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
3112 Assert(ExpectedName == IF->getName(),
3113 "Intrinsic name not mangled correctly for type arguments! "
3118 // If the intrinsic takes MDNode arguments, verify that they are either global
3119 // or are local to *this* function.
3120 for (unsigned i = 0, e = CI.getNumArgOperands(); i != e; ++i)
3121 if (auto *MD = dyn_cast<MetadataAsValue>(CI.getArgOperand(i)))
3122 visitMetadataAsValue(*MD, CI.getParent()->getParent());
3127 case Intrinsic::ctlz: // llvm.ctlz
3128 case Intrinsic::cttz: // llvm.cttz
3129 Assert(isa<ConstantInt>(CI.getArgOperand(1)),
3130 "is_zero_undef argument of bit counting intrinsics must be a "
3134 case Intrinsic::dbg_declare: // llvm.dbg.declare
3135 Assert(isa<MetadataAsValue>(CI.getArgOperand(0)),
3136 "invalid llvm.dbg.declare intrinsic call 1", &CI);
3137 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(CI));
3139 case Intrinsic::dbg_value: // llvm.dbg.value
3140 visitDbgIntrinsic("value", cast<DbgValueInst>(CI));
3142 case Intrinsic::memcpy:
3143 case Intrinsic::memmove:
3144 case Intrinsic::memset: {
3145 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CI.getArgOperand(3));
3147 "alignment argument of memory intrinsics must be a constant int",
3149 const APInt &AlignVal = AlignCI->getValue();
3150 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
3151 "alignment argument of memory intrinsics must be a power of 2", &CI);
3152 Assert(isa<ConstantInt>(CI.getArgOperand(4)),
3153 "isvolatile argument of memory intrinsics must be a constant int",
3157 case Intrinsic::gcroot:
3158 case Intrinsic::gcwrite:
3159 case Intrinsic::gcread:
3160 if (ID == Intrinsic::gcroot) {
3162 dyn_cast<AllocaInst>(CI.getArgOperand(0)->stripPointerCasts());
3163 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", &CI);
3164 Assert(isa<Constant>(CI.getArgOperand(1)),
3165 "llvm.gcroot parameter #2 must be a constant.", &CI);
3166 if (!AI->getType()->getElementType()->isPointerTy()) {
3167 Assert(!isa<ConstantPointerNull>(CI.getArgOperand(1)),
3168 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3169 "or argument #2 must be a non-null constant.",
3174 Assert(CI.getParent()->getParent()->hasGC(),
3175 "Enclosing function does not use GC.", &CI);
3177 case Intrinsic::init_trampoline:
3178 Assert(isa<Function>(CI.getArgOperand(1)->stripPointerCasts()),
3179 "llvm.init_trampoline parameter #2 must resolve to a function.",
3182 case Intrinsic::prefetch:
3183 Assert(isa<ConstantInt>(CI.getArgOperand(1)) &&
3184 isa<ConstantInt>(CI.getArgOperand(2)) &&
3185 cast<ConstantInt>(CI.getArgOperand(1))->getZExtValue() < 2 &&
3186 cast<ConstantInt>(CI.getArgOperand(2))->getZExtValue() < 4,
3187 "invalid arguments to llvm.prefetch", &CI);
3189 case Intrinsic::stackprotector:
3190 Assert(isa<AllocaInst>(CI.getArgOperand(1)->stripPointerCasts()),
3191 "llvm.stackprotector parameter #2 must resolve to an alloca.", &CI);
3193 case Intrinsic::lifetime_start:
3194 case Intrinsic::lifetime_end:
3195 case Intrinsic::invariant_start:
3196 Assert(isa<ConstantInt>(CI.getArgOperand(0)),
3197 "size argument of memory use markers must be a constant integer",
3200 case Intrinsic::invariant_end:
3201 Assert(isa<ConstantInt>(CI.getArgOperand(1)),
3202 "llvm.invariant.end parameter #2 must be a constant integer", &CI);
3205 case Intrinsic::frameescape: {
3206 BasicBlock *BB = CI.getParent();
3207 Assert(BB == &BB->getParent()->front(),
3208 "llvm.frameescape used outside of entry block", &CI);
3209 Assert(!SawFrameEscape,
3210 "multiple calls to llvm.frameescape in one function", &CI);
3211 for (Value *Arg : CI.arg_operands()) {
3212 if (isa<ConstantPointerNull>(Arg))
3213 continue; // Null values are allowed as placeholders.
3214 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
3215 Assert(AI && AI->isStaticAlloca(),
3216 "llvm.frameescape only accepts static allocas", &CI);
3218 FrameEscapeInfo[BB->getParent()].first = CI.getNumArgOperands();
3219 SawFrameEscape = true;
3222 case Intrinsic::framerecover: {
3223 Value *FnArg = CI.getArgOperand(0)->stripPointerCasts();
3224 Function *Fn = dyn_cast<Function>(FnArg);
3225 Assert(Fn && !Fn->isDeclaration(),
3226 "llvm.framerecover first "
3227 "argument must be function defined in this module",
3229 auto *IdxArg = dyn_cast<ConstantInt>(CI.getArgOperand(2));
3230 Assert(IdxArg, "idx argument of llvm.framerecover must be a constant int",
3232 auto &Entry = FrameEscapeInfo[Fn];
3233 Entry.second = unsigned(
3234 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
3238 case Intrinsic::experimental_gc_statepoint:
3239 Assert(!CI.isInlineAsm(),
3240 "gc.statepoint support for inline assembly unimplemented", &CI);
3241 Assert(CI.getParent()->getParent()->hasGC(),
3242 "Enclosing function does not use GC.", &CI);
3244 VerifyStatepoint(ImmutableCallSite(&CI));
3246 case Intrinsic::experimental_gc_result_int:
3247 case Intrinsic::experimental_gc_result_float:
3248 case Intrinsic::experimental_gc_result_ptr:
3249 case Intrinsic::experimental_gc_result: {
3250 Assert(CI.getParent()->getParent()->hasGC(),
3251 "Enclosing function does not use GC.", &CI);
3252 // Are we tied to a statepoint properly?
3253 CallSite StatepointCS(CI.getArgOperand(0));
3254 const Function *StatepointFn =
3255 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
3256 Assert(StatepointFn && StatepointFn->isDeclaration() &&
3257 StatepointFn->getIntrinsicID() ==
3258 Intrinsic::experimental_gc_statepoint,
3259 "gc.result operand #1 must be from a statepoint", &CI,
3260 CI.getArgOperand(0));
3262 // Assert that result type matches wrapped callee.
3263 const Value *Target = StatepointCS.getArgument(0);
3264 const PointerType *PT = cast<PointerType>(Target->getType());
3265 const FunctionType *TargetFuncType =
3266 cast<FunctionType>(PT->getElementType());
3267 Assert(CI.getType() == TargetFuncType->getReturnType(),
3268 "gc.result result type does not match wrapped callee", &CI);
3271 case Intrinsic::experimental_gc_relocate: {
3272 Assert(CI.getNumArgOperands() == 3, "wrong number of arguments", &CI);
3274 // Check that this relocate is correctly tied to the statepoint
3276 // This is case for relocate on the unwinding path of an invoke statepoint
3277 if (ExtractValueInst *ExtractValue =
3278 dyn_cast<ExtractValueInst>(CI.getArgOperand(0))) {
3279 Assert(isa<LandingPadInst>(ExtractValue->getAggregateOperand()),
3280 "gc relocate on unwind path incorrectly linked to the statepoint",
3283 const BasicBlock *invokeBB =
3284 ExtractValue->getParent()->getUniquePredecessor();
3286 // Landingpad relocates should have only one predecessor with invoke
3287 // statepoint terminator
3288 Assert(invokeBB, "safepoints should have unique landingpads",
3289 ExtractValue->getParent());
3290 Assert(invokeBB->getTerminator(), "safepoint block should be well formed",
3292 Assert(isStatepoint(invokeBB->getTerminator()),
3293 "gc relocate should be linked to a statepoint", invokeBB);
3296 // In all other cases relocate should be tied to the statepoint directly.
3297 // This covers relocates on a normal return path of invoke statepoint and
3298 // relocates of a call statepoint
3299 auto Token = CI.getArgOperand(0);
3300 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
3301 "gc relocate is incorrectly tied to the statepoint", &CI, Token);
3304 // Verify rest of the relocate arguments
3306 GCRelocateOperands ops(&CI);
3307 ImmutableCallSite StatepointCS(ops.statepoint());
3309 // Both the base and derived must be piped through the safepoint
3310 Value* Base = CI.getArgOperand(1);
3311 Assert(isa<ConstantInt>(Base),
3312 "gc.relocate operand #2 must be integer offset", &CI);
3314 Value* Derived = CI.getArgOperand(2);
3315 Assert(isa<ConstantInt>(Derived),
3316 "gc.relocate operand #3 must be integer offset", &CI);
3318 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
3319 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
3321 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
3322 "gc.relocate: statepoint base index out of bounds", &CI);
3323 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
3324 "gc.relocate: statepoint derived index out of bounds", &CI);
3326 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
3327 // section of the statepoint's argument
3328 Assert(StatepointCS.arg_size() > 0,
3329 "gc.statepoint: insufficient arguments");
3330 Assert(isa<ConstantInt>(StatepointCS.getArgument(1)),
3331 "gc.statement: number of call arguments must be constant integer");
3332 const unsigned NumCallArgs =
3333 cast<ConstantInt>(StatepointCS.getArgument(1))->getZExtValue();
3334 Assert(StatepointCS.arg_size() > NumCallArgs+3,
3335 "gc.statepoint: mismatch in number of call arguments");
3336 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs+3)),
3337 "gc.statepoint: number of deoptimization arguments must be "
3338 "a constant integer");
3339 const int NumDeoptArgs =
3340 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 3))->getZExtValue();
3341 const int GCParamArgsStart = NumCallArgs + NumDeoptArgs + 4;
3342 const int GCParamArgsEnd = StatepointCS.arg_size();
3343 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
3344 "gc.relocate: statepoint base index doesn't fall within the "
3345 "'gc parameters' section of the statepoint call",
3347 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
3348 "gc.relocate: statepoint derived index doesn't fall within the "
3349 "'gc parameters' section of the statepoint call",
3352 // Assert that the result type matches the type of the relocated pointer
3353 GCRelocateOperands Operands(&CI);
3354 Assert(Operands.derivedPtr()->getType() == CI.getType(),
3355 "gc.relocate: relocating a pointer shouldn't change its type", &CI);
3361 template <class DbgIntrinsicTy>
3362 void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
3363 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
3364 Assert(isa<ValueAsMetadata>(MD) ||
3365 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
3366 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
3367 Assert(isa<MDLocalVariable>(DII.getRawVariable()),
3368 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
3369 DII.getRawVariable());
3370 Assert(isa<MDExpression>(DII.getRawExpression()),
3371 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
3372 DII.getRawExpression());
3374 // Ignore broken !dbg attachments; they're checked elsewhere.
3375 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
3376 if (!isa<MDLocation>(N))
3379 // The inlined-at attachments for variables and !dbg attachments must agree.
3380 MDLocalVariable *Var = DII.getVariable();
3381 MDLocation *VarIA = Var->getInlinedAt();
3382 MDLocation *Loc = DII.getDebugLoc();
3383 MDLocation *LocIA = Loc ? Loc->getInlinedAt() : nullptr;
3384 BasicBlock *BB = DII.getParent();
3385 Assert(VarIA == LocIA, "mismatched variable and !dbg inlined-at", &DII, BB,
3386 BB ? BB->getParent() : nullptr, Var, VarIA, Loc, LocIA);
3389 void Verifier::visitUnresolvedTypeRef(const MDString *S, const MDNode *N) {
3390 // This is in its own function so we get an error for each bad type ref (not
3392 Assert(false, "unresolved type ref", S, N);
3395 void Verifier::verifyTypeRefs() {
3396 auto *CUs = M->getNamedMetadata("llvm.dbg.cu");
3400 // Visit all the compile units again to check the type references.
3401 for (auto *CU : CUs->operands())
3402 if (auto Ts = cast<MDCompileUnit>(CU)->getRetainedTypes())
3403 for (MDType *Op : Ts)
3404 if (auto *T = dyn_cast<MDCompositeType>(Op))
3405 TypeRefs.erase(T->getRawIdentifier());
3406 if (TypeRefs.empty())
3409 // Sort the unresolved references by name so the output is deterministic.
3410 typedef std::pair<const MDString *, const MDNode *> TypeRef;
3411 SmallVector<TypeRef, 32> Unresolved(TypeRefs.begin(), TypeRefs.end());
3412 std::sort(Unresolved.begin(), Unresolved.end(),
3413 [](const TypeRef &LHS, const TypeRef &RHS) {
3414 return LHS.first->getString() < RHS.first->getString();
3417 // Visit the unresolved refs (printing out the errors).
3418 for (const TypeRef &TR : Unresolved)
3419 visitUnresolvedTypeRef(TR.first, TR.second);
3422 //===----------------------------------------------------------------------===//
3423 // Implement the public interfaces to this file...
3424 //===----------------------------------------------------------------------===//
3426 bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
3427 Function &F = const_cast<Function &>(f);
3428 assert(!F.isDeclaration() && "Cannot verify external functions");
3430 raw_null_ostream NullStr;
3431 Verifier V(OS ? *OS : NullStr);
3433 // Note that this function's return value is inverted from what you would
3434 // expect of a function called "verify".
3435 return !V.verify(F);
3438 bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
3439 raw_null_ostream NullStr;
3440 Verifier V(OS ? *OS : NullStr);
3442 bool Broken = false;
3443 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
3444 if (!I->isDeclaration() && !I->isMaterializable())
3445 Broken |= !V.verify(*I);
3447 // Note that this function's return value is inverted from what you would
3448 // expect of a function called "verify".
3449 return !V.verify(M) || Broken;
3453 struct VerifierLegacyPass : public FunctionPass {
3459 VerifierLegacyPass() : FunctionPass(ID), V(dbgs()), FatalErrors(true) {
3460 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3462 explicit VerifierLegacyPass(bool FatalErrors)
3463 : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
3464 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3467 bool runOnFunction(Function &F) override {
3468 if (!V.verify(F) && FatalErrors)
3469 report_fatal_error("Broken function found, compilation aborted!");
3474 bool doFinalization(Module &M) override {
3475 if (!V.verify(M) && FatalErrors)
3476 report_fatal_error("Broken module found, compilation aborted!");
3481 void getAnalysisUsage(AnalysisUsage &AU) const override {
3482 AU.setPreservesAll();
3487 char VerifierLegacyPass::ID = 0;
3488 INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
3490 FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
3491 return new VerifierLegacyPass(FatalErrors);
3494 PreservedAnalyses VerifierPass::run(Module &M) {
3495 if (verifyModule(M, &dbgs()) && FatalErrors)
3496 report_fatal_error("Broken module found, compilation aborted!");
3498 return PreservedAnalyses::all();
3501 PreservedAnalyses VerifierPass::run(Function &F) {
3502 if (verifyFunction(F, &dbgs()) && FatalErrors)
3503 report_fatal_error("Broken function found, compilation aborted!");
3505 return PreservedAnalyses::all();