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.
92 explicit VerifierSupport(raw_ostream &OS)
93 : OS(OS), M(nullptr), Broken(false), EverBroken(false) {}
96 void Write(const Value *V) {
99 if (isa<Instruction>(V)) {
102 V->printAsOperand(OS, true, M);
107 void Write(const Metadata *MD) {
114 void Write(const NamedMDNode *NMD) {
121 void Write(Type *T) {
127 void Write(const Comdat *C) {
133 template <typename T1, typename... Ts>
134 void WriteTs(const T1 &V1, const Ts &... Vs) {
139 template <typename... Ts> void WriteTs() {}
142 /// \brief A check failed, so printout out the condition and the message.
144 /// This provides a nice place to put a breakpoint if you want to see why
145 /// something is not correct.
146 void CheckFailed(const Twine &Message) {
147 OS << Message << '\n';
148 EverBroken = Broken = true;
151 /// \brief A check failed (with values to print).
153 /// This calls the Message-only version so that the above is easier to set a
155 template <typename T1, typename... Ts>
156 void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) {
157 CheckFailed(Message);
162 class Verifier : public InstVisitor<Verifier>, VerifierSupport {
163 friend class InstVisitor<Verifier>;
165 LLVMContext *Context;
168 /// \brief When verifying a basic block, keep track of all of the
169 /// instructions we have seen so far.
171 /// This allows us to do efficient dominance checks for the case when an
172 /// instruction has an operand that is an instruction in the same block.
173 SmallPtrSet<Instruction *, 16> InstsInThisBlock;
175 /// \brief Keep track of the metadata nodes that have been checked already.
176 SmallPtrSet<const Metadata *, 32> MDNodes;
178 /// \brief The personality function referenced by the LandingPadInsts.
179 /// All LandingPadInsts within the same function must use the same
180 /// personality function.
181 const Value *PersonalityFn;
183 /// \brief Whether we've seen a call to @llvm.frameescape in this function
187 /// Stores the count of how many objects were passed to llvm.frameescape for a
188 /// given function and the largest index passed to llvm.framerecover.
189 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
192 explicit Verifier(raw_ostream &OS)
193 : VerifierSupport(OS), Context(nullptr), PersonalityFn(nullptr),
194 SawFrameEscape(false) {}
196 bool verify(const Function &F) {
198 Context = &M->getContext();
200 // First ensure the function is well-enough formed to compute dominance
203 OS << "Function '" << F.getName()
204 << "' does not contain an entry block!\n";
207 for (Function::const_iterator I = F.begin(), E = F.end(); I != E; ++I) {
208 if (I->empty() || !I->back().isTerminator()) {
209 OS << "Basic Block in function '" << F.getName()
210 << "' does not have terminator!\n";
211 I->printAsOperand(OS, true);
217 // Now directly compute a dominance tree. We don't rely on the pass
218 // manager to provide this as it isolates us from a potentially
219 // out-of-date dominator tree and makes it significantly more complex to
220 // run this code outside of a pass manager.
221 // FIXME: It's really gross that we have to cast away constness here.
222 DT.recalculate(const_cast<Function &>(F));
225 // FIXME: We strip const here because the inst visitor strips const.
226 visit(const_cast<Function &>(F));
227 InstsInThisBlock.clear();
228 PersonalityFn = nullptr;
229 SawFrameEscape = false;
234 bool verify(const Module &M) {
236 Context = &M.getContext();
239 // Scan through, checking all of the external function's linkage now...
240 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
241 visitGlobalValue(*I);
243 // Check to make sure function prototypes are okay.
244 if (I->isDeclaration())
248 // Now that we've visited every function, verify that we never asked to
249 // recover a frame index that wasn't escaped.
250 verifyFrameRecoverIndices();
252 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
254 visitGlobalVariable(*I);
256 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
258 visitGlobalAlias(*I);
260 for (Module::const_named_metadata_iterator I = M.named_metadata_begin(),
261 E = M.named_metadata_end();
263 visitNamedMDNode(*I);
265 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
266 visitComdat(SMEC.getValue());
269 visitModuleIdents(M);
271 // Verify debug info last.
278 // Verification methods...
279 void visitGlobalValue(const GlobalValue &GV);
280 void visitGlobalVariable(const GlobalVariable &GV);
281 void visitGlobalAlias(const GlobalAlias &GA);
282 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
283 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
284 const GlobalAlias &A, const Constant &C);
285 void visitNamedMDNode(const NamedMDNode &NMD);
286 void visitMDNode(const MDNode &MD);
287 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
288 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
289 void visitComdat(const Comdat &C);
290 void visitModuleIdents(const Module &M);
291 void visitModuleFlags(const Module &M);
292 void visitModuleFlag(const MDNode *Op,
293 DenseMap<const MDString *, const MDNode *> &SeenIDs,
294 SmallVectorImpl<const MDNode *> &Requirements);
295 void visitFunction(const Function &F);
296 void visitBasicBlock(BasicBlock &BB);
297 void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty);
299 template <class Ty> bool isValidMetadataArray(const MDTuple &N);
300 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
301 #include "llvm/IR/Metadata.def"
302 void visitMDScope(const MDScope &N);
303 void visitMDDerivedTypeBase(const MDDerivedTypeBase &N);
304 void visitMDVariable(const MDVariable &N);
306 // InstVisitor overrides...
307 using InstVisitor<Verifier>::visit;
308 void visit(Instruction &I);
310 void visitTruncInst(TruncInst &I);
311 void visitZExtInst(ZExtInst &I);
312 void visitSExtInst(SExtInst &I);
313 void visitFPTruncInst(FPTruncInst &I);
314 void visitFPExtInst(FPExtInst &I);
315 void visitFPToUIInst(FPToUIInst &I);
316 void visitFPToSIInst(FPToSIInst &I);
317 void visitUIToFPInst(UIToFPInst &I);
318 void visitSIToFPInst(SIToFPInst &I);
319 void visitIntToPtrInst(IntToPtrInst &I);
320 void visitPtrToIntInst(PtrToIntInst &I);
321 void visitBitCastInst(BitCastInst &I);
322 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
323 void visitPHINode(PHINode &PN);
324 void visitBinaryOperator(BinaryOperator &B);
325 void visitICmpInst(ICmpInst &IC);
326 void visitFCmpInst(FCmpInst &FC);
327 void visitExtractElementInst(ExtractElementInst &EI);
328 void visitInsertElementInst(InsertElementInst &EI);
329 void visitShuffleVectorInst(ShuffleVectorInst &EI);
330 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
331 void visitCallInst(CallInst &CI);
332 void visitInvokeInst(InvokeInst &II);
333 void visitGetElementPtrInst(GetElementPtrInst &GEP);
334 void visitLoadInst(LoadInst &LI);
335 void visitStoreInst(StoreInst &SI);
336 void verifyDominatesUse(Instruction &I, unsigned i);
337 void visitInstruction(Instruction &I);
338 void visitTerminatorInst(TerminatorInst &I);
339 void visitBranchInst(BranchInst &BI);
340 void visitReturnInst(ReturnInst &RI);
341 void visitSwitchInst(SwitchInst &SI);
342 void visitIndirectBrInst(IndirectBrInst &BI);
343 void visitSelectInst(SelectInst &SI);
344 void visitUserOp1(Instruction &I);
345 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
346 void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
347 template <class DbgIntrinsicTy>
348 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
349 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
350 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
351 void visitFenceInst(FenceInst &FI);
352 void visitAllocaInst(AllocaInst &AI);
353 void visitExtractValueInst(ExtractValueInst &EVI);
354 void visitInsertValueInst(InsertValueInst &IVI);
355 void visitLandingPadInst(LandingPadInst &LPI);
357 void VerifyCallSite(CallSite CS);
358 void verifyMustTailCall(CallInst &CI);
359 bool PerformTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
360 unsigned ArgNo, std::string &Suffix);
361 bool VerifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
362 SmallVectorImpl<Type *> &ArgTys);
363 bool VerifyIntrinsicIsVarArg(bool isVarArg,
364 ArrayRef<Intrinsic::IITDescriptor> &Infos);
365 bool VerifyAttributeCount(AttributeSet Attrs, unsigned Params);
366 void VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
368 void VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
369 bool isReturnValue, const Value *V);
370 void VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
373 void VerifyConstantExprBitcastType(const ConstantExpr *CE);
374 void VerifyStatepoint(ImmutableCallSite CS);
375 void verifyFrameRecoverIndices();
377 // Module-level debug info verification...
378 void verifyDebugInfo();
379 void processInstructions(DebugInfoFinder &Finder);
380 void processCallInst(DebugInfoFinder &Finder, const CallInst &CI);
382 } // End anonymous namespace
384 // Assert - We know that cond should be true, if not print an error message.
385 #define Assert(C, ...) \
386 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
388 void Verifier::visit(Instruction &I) {
389 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
390 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
391 InstVisitor<Verifier>::visit(I);
395 void Verifier::visitGlobalValue(const GlobalValue &GV) {
396 Assert(!GV.isDeclaration() || GV.hasExternalLinkage() ||
397 GV.hasExternalWeakLinkage(),
398 "Global is external, but doesn't have external or weak linkage!", &GV);
400 Assert(GV.getAlignment() <= Value::MaximumAlignment,
401 "huge alignment values are unsupported", &GV);
402 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
403 "Only global variables can have appending linkage!", &GV);
405 if (GV.hasAppendingLinkage()) {
406 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
407 Assert(GVar && GVar->getType()->getElementType()->isArrayTy(),
408 "Only global arrays can have appending linkage!", GVar);
412 void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
413 if (GV.hasInitializer()) {
414 Assert(GV.getInitializer()->getType() == GV.getType()->getElementType(),
415 "Global variable initializer type does not match global "
419 // If the global has common linkage, it must have a zero initializer and
420 // cannot be constant.
421 if (GV.hasCommonLinkage()) {
422 Assert(GV.getInitializer()->isNullValue(),
423 "'common' global must have a zero initializer!", &GV);
424 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
426 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
429 Assert(GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
430 "invalid linkage type for global declaration", &GV);
433 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
434 GV.getName() == "llvm.global_dtors")) {
435 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
436 "invalid linkage for intrinsic global variable", &GV);
437 // Don't worry about emitting an error for it not being an array,
438 // visitGlobalValue will complain on appending non-array.
439 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getType()->getElementType())) {
440 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
441 PointerType *FuncPtrTy =
442 FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
443 // FIXME: Reject the 2-field form in LLVM 4.0.
445 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
446 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
447 STy->getTypeAtIndex(1) == FuncPtrTy,
448 "wrong type for intrinsic global variable", &GV);
449 if (STy->getNumElements() == 3) {
450 Type *ETy = STy->getTypeAtIndex(2);
451 Assert(ETy->isPointerTy() &&
452 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
453 "wrong type for intrinsic global variable", &GV);
458 if (GV.hasName() && (GV.getName() == "llvm.used" ||
459 GV.getName() == "llvm.compiler.used")) {
460 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
461 "invalid linkage for intrinsic global variable", &GV);
462 Type *GVType = GV.getType()->getElementType();
463 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
464 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
465 Assert(PTy, "wrong type for intrinsic global variable", &GV);
466 if (GV.hasInitializer()) {
467 const Constant *Init = GV.getInitializer();
468 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
469 Assert(InitArray, "wrong initalizer for intrinsic global variable",
471 for (unsigned i = 0, e = InitArray->getNumOperands(); i != e; ++i) {
472 Value *V = Init->getOperand(i)->stripPointerCastsNoFollowAliases();
473 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
475 "invalid llvm.used member", V);
476 Assert(V->hasName(), "members of llvm.used must be named", V);
482 Assert(!GV.hasDLLImportStorageClass() ||
483 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
484 GV.hasAvailableExternallyLinkage(),
485 "Global is marked as dllimport, but not external", &GV);
487 if (!GV.hasInitializer()) {
488 visitGlobalValue(GV);
492 // Walk any aggregate initializers looking for bitcasts between address spaces
493 SmallPtrSet<const Value *, 4> Visited;
494 SmallVector<const Value *, 4> WorkStack;
495 WorkStack.push_back(cast<Value>(GV.getInitializer()));
497 while (!WorkStack.empty()) {
498 const Value *V = WorkStack.pop_back_val();
499 if (!Visited.insert(V).second)
502 if (const User *U = dyn_cast<User>(V)) {
503 WorkStack.append(U->op_begin(), U->op_end());
506 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
507 VerifyConstantExprBitcastType(CE);
513 visitGlobalValue(GV);
516 void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
517 SmallPtrSet<const GlobalAlias*, 4> Visited;
519 visitAliaseeSubExpr(Visited, GA, C);
522 void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
523 const GlobalAlias &GA, const Constant &C) {
524 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
525 Assert(!GV->isDeclaration(), "Alias must point to a definition", &GA);
527 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
528 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
530 Assert(!GA2->mayBeOverridden(), "Alias cannot point to a weak alias",
533 // Only continue verifying subexpressions of GlobalAliases.
534 // Do not recurse into global initializers.
539 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
540 VerifyConstantExprBitcastType(CE);
542 for (const Use &U : C.operands()) {
544 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
545 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
546 else if (const auto *C2 = dyn_cast<Constant>(V))
547 visitAliaseeSubExpr(Visited, GA, *C2);
551 void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
552 Assert(!GA.getName().empty(), "Alias name cannot be empty!", &GA);
553 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
554 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
555 "weak_odr, or external linkage!",
557 const Constant *Aliasee = GA.getAliasee();
558 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
559 Assert(GA.getType() == Aliasee->getType(),
560 "Alias and aliasee types should match!", &GA);
562 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
563 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
565 visitAliaseeSubExpr(GA, *Aliasee);
567 visitGlobalValue(GA);
570 void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
571 for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i) {
572 MDNode *MD = NMD.getOperand(i);
576 if (NMD.getName() == "llvm.dbg.cu") {
577 Assert(isa<MDCompileUnit>(MD), "invalid compile unit", &NMD, MD);
584 void Verifier::visitMDNode(const MDNode &MD) {
585 // Only visit each node once. Metadata can be mutually recursive, so this
586 // avoids infinite recursion here, as well as being an optimization.
587 if (!MDNodes.insert(&MD).second)
590 switch (MD.getMetadataID()) {
592 llvm_unreachable("Invalid MDNode subclass");
593 case Metadata::MDTupleKind:
595 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
596 case Metadata::CLASS##Kind: \
597 visit##CLASS(cast<CLASS>(MD)); \
599 #include "llvm/IR/Metadata.def"
602 for (unsigned i = 0, e = MD.getNumOperands(); i != e; ++i) {
603 Metadata *Op = MD.getOperand(i);
606 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
608 if (auto *N = dyn_cast<MDNode>(Op)) {
612 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
613 visitValueAsMetadata(*V, nullptr);
618 // Check these last, so we diagnose problems in operands first.
619 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
620 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
623 void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
624 Assert(MD.getValue(), "Expected valid value", &MD);
625 Assert(!MD.getValue()->getType()->isMetadataTy(),
626 "Unexpected metadata round-trip through values", &MD, MD.getValue());
628 auto *L = dyn_cast<LocalAsMetadata>(&MD);
632 Assert(F, "function-local metadata used outside a function", L);
634 // If this was an instruction, bb, or argument, verify that it is in the
635 // function that we expect.
636 Function *ActualF = nullptr;
637 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
638 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
639 ActualF = I->getParent()->getParent();
640 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
641 ActualF = BB->getParent();
642 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
643 ActualF = A->getParent();
644 assert(ActualF && "Unimplemented function local metadata case!");
646 Assert(ActualF == F, "function-local metadata used in wrong function", L);
649 void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
650 Metadata *MD = MDV.getMetadata();
651 if (auto *N = dyn_cast<MDNode>(MD)) {
656 // Only visit each node once. Metadata can be mutually recursive, so this
657 // avoids infinite recursion here, as well as being an optimization.
658 if (!MDNodes.insert(MD).second)
661 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
662 visitValueAsMetadata(*V, F);
665 /// \brief Check if a value can be a reference to a type.
666 static bool isTypeRef(const Metadata *MD) {
669 if (auto *S = dyn_cast<MDString>(MD))
670 return !S->getString().empty();
671 return isa<MDType>(MD);
674 /// \brief Check if a value can be a ScopeRef.
675 static bool isScopeRef(const Metadata *MD) {
678 if (auto *S = dyn_cast<MDString>(MD))
679 return !S->getString().empty();
680 return isa<MDScope>(MD);
684 bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
685 for (Metadata *MD : N.operands()) {
698 bool isValidMetadataArray(const MDTuple &N) {
699 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
703 bool isValidMetadataNullArray(const MDTuple &N) {
704 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
707 void Verifier::visitMDLocation(const MDLocation &N) {
708 Assert(N.getRawScope() && isa<MDLocalScope>(N.getRawScope()),
709 "location requires a valid scope", &N, N.getRawScope());
710 if (auto *IA = N.getRawInlinedAt())
711 Assert(isa<MDLocation>(IA), "inlined-at should be a location", &N, IA);
714 void Verifier::visitGenericDebugNode(const GenericDebugNode &N) {
715 Assert(N.getTag(), "invalid tag", &N);
718 void Verifier::visitMDScope(const MDScope &N) {
719 if (auto *F = N.getRawFile())
720 Assert(isa<MDFile>(F), "invalid file", &N, F);
723 void Verifier::visitMDSubrange(const MDSubrange &N) {
724 Assert(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
725 Assert(N.getCount() >= -1, "invalid subrange count", &N);
728 void Verifier::visitMDEnumerator(const MDEnumerator &N) {
729 Assert(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
732 void Verifier::visitMDBasicType(const MDBasicType &N) {
733 Assert(N.getTag() == dwarf::DW_TAG_base_type ||
734 N.getTag() == dwarf::DW_TAG_unspecified_type,
738 void Verifier::visitMDDerivedTypeBase(const MDDerivedTypeBase &N) {
739 // Common scope checks.
742 Assert(isScopeRef(N.getScope()), "invalid scope", &N, N.getScope());
743 Assert(isTypeRef(N.getBaseType()), "invalid base type", &N, N.getBaseType());
746 void Verifier::visitMDDerivedType(const MDDerivedType &N) {
747 // Common derived type checks.
748 visitMDDerivedTypeBase(N);
750 Assert(N.getTag() == dwarf::DW_TAG_typedef ||
751 N.getTag() == dwarf::DW_TAG_pointer_type ||
752 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
753 N.getTag() == dwarf::DW_TAG_reference_type ||
754 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
755 N.getTag() == dwarf::DW_TAG_const_type ||
756 N.getTag() == dwarf::DW_TAG_volatile_type ||
757 N.getTag() == dwarf::DW_TAG_restrict_type ||
758 N.getTag() == dwarf::DW_TAG_member ||
759 N.getTag() == dwarf::DW_TAG_inheritance ||
760 N.getTag() == dwarf::DW_TAG_friend,
764 void Verifier::visitMDCompositeType(const MDCompositeType &N) {
765 // Common derived type checks.
766 visitMDDerivedTypeBase(N);
768 Assert(N.getTag() == dwarf::DW_TAG_array_type ||
769 N.getTag() == dwarf::DW_TAG_structure_type ||
770 N.getTag() == dwarf::DW_TAG_union_type ||
771 N.getTag() == dwarf::DW_TAG_enumeration_type ||
772 N.getTag() == dwarf::DW_TAG_subroutine_type ||
773 N.getTag() == dwarf::DW_TAG_class_type,
776 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
777 "invalid composite elements", &N, N.getRawElements());
778 Assert(isTypeRef(N.getRawVTableHolder()), "invalid vtable holder", &N,
779 N.getRawVTableHolder());
780 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
781 "invalid composite elements", &N, N.getRawElements());
784 void Verifier::visitMDSubroutineType(const MDSubroutineType &N) {
785 Assert(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
786 if (auto *Types = N.getRawTypeArray()) {
787 Assert(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
788 for (Metadata *Ty : N.getTypeArray()->operands()) {
789 Assert(isTypeRef(Ty), "invalid subroutine type ref", &N, Types, Ty);
794 void Verifier::visitMDFile(const MDFile &N) {
795 Assert(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
798 void Verifier::visitMDCompileUnit(const MDCompileUnit &N) {
799 Assert(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
801 if (auto *Array = N.getRawEnumTypes()) {
802 Assert(isa<MDTuple>(Array), "invalid enum list", &N, Array);
803 for (Metadata *Op : N.getEnumTypes()->operands()) {
804 auto *Enum = dyn_cast_or_null<MDCompositeType>(Op);
805 Assert(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
806 "invalid enum type", &N, N.getEnumTypes(), Op);
809 if (auto *Array = N.getRawRetainedTypes()) {
810 Assert(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
811 for (Metadata *Op : N.getRetainedTypes()->operands()) {
812 Assert(Op && isa<MDType>(Op), "invalid retained type", &N, Op);
815 if (auto *Array = N.getRawSubprograms()) {
816 Assert(isa<MDTuple>(Array), "invalid subprogram list", &N, Array);
817 for (Metadata *Op : N.getSubprograms()->operands()) {
818 Assert(Op && isa<MDSubprogram>(Op), "invalid subprogram ref", &N, Op);
821 if (auto *Array = N.getRawGlobalVariables()) {
822 Assert(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
823 for (Metadata *Op : N.getGlobalVariables()->operands()) {
824 Assert(Op && isa<MDGlobalVariable>(Op), "invalid global variable ref", &N,
828 if (auto *Array = N.getRawImportedEntities()) {
829 Assert(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
830 for (Metadata *Op : N.getImportedEntities()->operands()) {
831 Assert(Op && isa<MDImportedEntity>(Op), "invalid imported entity ref", &N,
837 void Verifier::visitMDSubprogram(const MDSubprogram &N) {
838 Assert(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
839 Assert(isScopeRef(N.getRawScope()), "invalid scope", &N, N.getRawScope());
840 if (auto *T = N.getRawType())
841 Assert(isa<MDSubroutineType>(T), "invalid subroutine type", &N, T);
842 Assert(isTypeRef(N.getRawContainingType()), "invalid containing type", &N,
843 N.getRawContainingType());
844 if (auto *RawF = N.getRawFunction()) {
845 auto *FMD = dyn_cast<ConstantAsMetadata>(RawF);
846 auto *F = FMD ? FMD->getValue() : nullptr;
847 auto *FT = F ? dyn_cast<PointerType>(F->getType()) : nullptr;
848 Assert(F && (isa<Function>(F) || isa<ConstantPointerNull>(F)) && FT &&
849 isa<FunctionType>(FT->getElementType()),
850 "invalid function", &N, F);
852 if (N.getRawTemplateParams()) {
853 auto *Params = dyn_cast<MDTuple>(N.getRawTemplateParams());
854 Assert(Params, "invalid template params", &N, Params);
855 for (Metadata *Op : Params->operands()) {
856 Assert(Op && isa<MDTemplateParameter>(Op), "invalid template parameter",
860 if (auto *S = N.getRawDeclaration()) {
861 Assert(isa<MDSubprogram>(S) && !cast<MDSubprogram>(S)->isDefinition(),
862 "invalid subprogram declaration", &N, S);
864 if (N.getRawVariables()) {
865 auto *Vars = dyn_cast<MDTuple>(N.getRawVariables());
866 Assert(Vars, "invalid variable list", &N, Vars);
867 for (Metadata *Op : Vars->operands()) {
868 Assert(Op && isa<MDLocalVariable>(Op), "invalid local variable", &N, Vars,
874 void Verifier::visitMDLexicalBlock(const MDLexicalBlock &N) {
875 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
878 void Verifier::visitMDLexicalBlockFile(const MDLexicalBlockFile &N) {
879 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
882 void Verifier::visitMDNamespace(const MDNamespace &N) {
883 Assert(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
886 void Verifier::visitMDTemplateTypeParameter(const MDTemplateTypeParameter &N) {
887 Assert(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
891 void Verifier::visitMDTemplateValueParameter(
892 const MDTemplateValueParameter &N) {
893 Assert(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
894 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
895 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
899 void Verifier::visitMDVariable(const MDVariable &N) {
900 if (auto *S = N.getRawScope())
901 Assert(isa<MDScope>(S), "invalid scope", &N, S);
902 Assert(isTypeRef(N.getRawType()), "invalid type ref", &N, N.getRawType());
903 if (auto *F = N.getRawFile())
904 Assert(isa<MDFile>(F), "invalid file", &N, F);
907 void Verifier::visitMDGlobalVariable(const MDGlobalVariable &N) {
908 // Checks common to all variables.
911 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
912 if (auto *V = N.getRawVariable()) {
913 Assert(isa<ConstantAsMetadata>(V) &&
914 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
915 "invalid global varaible ref", &N, V);
917 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
918 Assert(isa<MDDerivedType>(Member), "invalid static data member declaration",
923 void Verifier::visitMDLocalVariable(const MDLocalVariable &N) {
924 // Checks common to all variables.
927 Assert(N.getTag() == dwarf::DW_TAG_auto_variable ||
928 N.getTag() == dwarf::DW_TAG_arg_variable,
930 Assert(N.getRawScope() && isa<MDLocalScope>(N.getRawScope()),
931 "local variable requires a valid scope", &N, N.getRawScope());
932 if (auto *IA = N.getRawInlinedAt())
933 Assert(isa<MDLocation>(IA), "local variable requires a valid scope", &N,
937 void Verifier::visitMDExpression(const MDExpression &N) {
938 Assert(N.isValid(), "invalid expression", &N);
941 void Verifier::visitMDObjCProperty(const MDObjCProperty &N) {
942 Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
945 void Verifier::visitMDImportedEntity(const MDImportedEntity &N) {
946 Assert(N.getTag() == dwarf::DW_TAG_imported_module ||
947 N.getTag() == dwarf::DW_TAG_imported_declaration,
951 void Verifier::visitComdat(const Comdat &C) {
952 // The Module is invalid if the GlobalValue has private linkage. Entities
953 // with private linkage don't have entries in the symbol table.
954 if (const GlobalValue *GV = M->getNamedValue(C.getName()))
955 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
959 void Verifier::visitModuleIdents(const Module &M) {
960 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
964 // llvm.ident takes a list of metadata entry. Each entry has only one string.
965 // Scan each llvm.ident entry and make sure that this requirement is met.
966 for (unsigned i = 0, e = Idents->getNumOperands(); i != e; ++i) {
967 const MDNode *N = Idents->getOperand(i);
968 Assert(N->getNumOperands() == 1,
969 "incorrect number of operands in llvm.ident metadata", N);
970 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
971 ("invalid value for llvm.ident metadata entry operand"
972 "(the operand should be a string)"),
977 void Verifier::visitModuleFlags(const Module &M) {
978 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
981 // Scan each flag, and track the flags and requirements.
982 DenseMap<const MDString*, const MDNode*> SeenIDs;
983 SmallVector<const MDNode*, 16> Requirements;
984 for (unsigned I = 0, E = Flags->getNumOperands(); I != E; ++I) {
985 visitModuleFlag(Flags->getOperand(I), SeenIDs, Requirements);
988 // Validate that the requirements in the module are valid.
989 for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
990 const MDNode *Requirement = Requirements[I];
991 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
992 const Metadata *ReqValue = Requirement->getOperand(1);
994 const MDNode *Op = SeenIDs.lookup(Flag);
996 CheckFailed("invalid requirement on flag, flag is not present in module",
1001 if (Op->getOperand(2) != ReqValue) {
1002 CheckFailed(("invalid requirement on flag, "
1003 "flag does not have the required value"),
1011 Verifier::visitModuleFlag(const MDNode *Op,
1012 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1013 SmallVectorImpl<const MDNode *> &Requirements) {
1014 // Each module flag should have three arguments, the merge behavior (a
1015 // constant int), the flag ID (an MDString), and the value.
1016 Assert(Op->getNumOperands() == 3,
1017 "incorrect number of operands in module flag", Op);
1018 Module::ModFlagBehavior MFB;
1019 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
1021 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
1022 "invalid behavior operand in module flag (expected constant integer)",
1025 "invalid behavior operand in module flag (unexpected constant)",
1028 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
1029 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1032 // Sanity check the values for behaviors with additional requirements.
1035 case Module::Warning:
1036 case Module::Override:
1037 // These behavior types accept any value.
1040 case Module::Require: {
1041 // The value should itself be an MDNode with two operands, a flag ID (an
1042 // MDString), and a value.
1043 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
1044 Assert(Value && Value->getNumOperands() == 2,
1045 "invalid value for 'require' module flag (expected metadata pair)",
1047 Assert(isa<MDString>(Value->getOperand(0)),
1048 ("invalid value for 'require' module flag "
1049 "(first value operand should be a string)"),
1050 Value->getOperand(0));
1052 // Append it to the list of requirements, to check once all module flags are
1054 Requirements.push_back(Value);
1058 case Module::Append:
1059 case Module::AppendUnique: {
1060 // These behavior types require the operand be an MDNode.
1061 Assert(isa<MDNode>(Op->getOperand(2)),
1062 "invalid value for 'append'-type module flag "
1063 "(expected a metadata node)",
1069 // Unless this is a "requires" flag, check the ID is unique.
1070 if (MFB != Module::Require) {
1071 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
1073 "module flag identifiers must be unique (or of 'require' type)", ID);
1077 void Verifier::VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
1078 bool isFunction, const Value *V) {
1079 unsigned Slot = ~0U;
1080 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1081 if (Attrs.getSlotIndex(I) == Idx) {
1086 assert(Slot != ~0U && "Attribute set inconsistency!");
1088 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1090 if (I->isStringAttribute())
1093 if (I->getKindAsEnum() == Attribute::NoReturn ||
1094 I->getKindAsEnum() == Attribute::NoUnwind ||
1095 I->getKindAsEnum() == Attribute::NoInline ||
1096 I->getKindAsEnum() == Attribute::AlwaysInline ||
1097 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1098 I->getKindAsEnum() == Attribute::StackProtect ||
1099 I->getKindAsEnum() == Attribute::StackProtectReq ||
1100 I->getKindAsEnum() == Attribute::StackProtectStrong ||
1101 I->getKindAsEnum() == Attribute::NoRedZone ||
1102 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1103 I->getKindAsEnum() == Attribute::Naked ||
1104 I->getKindAsEnum() == Attribute::InlineHint ||
1105 I->getKindAsEnum() == Attribute::StackAlignment ||
1106 I->getKindAsEnum() == Attribute::UWTable ||
1107 I->getKindAsEnum() == Attribute::NonLazyBind ||
1108 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1109 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1110 I->getKindAsEnum() == Attribute::SanitizeThread ||
1111 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1112 I->getKindAsEnum() == Attribute::MinSize ||
1113 I->getKindAsEnum() == Attribute::NoDuplicate ||
1114 I->getKindAsEnum() == Attribute::Builtin ||
1115 I->getKindAsEnum() == Attribute::NoBuiltin ||
1116 I->getKindAsEnum() == Attribute::Cold ||
1117 I->getKindAsEnum() == Attribute::OptimizeNone ||
1118 I->getKindAsEnum() == Attribute::JumpTable) {
1120 CheckFailed("Attribute '" + I->getAsString() +
1121 "' only applies to functions!", V);
1124 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
1125 I->getKindAsEnum() == Attribute::ReadNone) {
1127 CheckFailed("Attribute '" + I->getAsString() +
1128 "' does not apply to function returns");
1131 } else if (isFunction) {
1132 CheckFailed("Attribute '" + I->getAsString() +
1133 "' does not apply to functions!", V);
1139 // VerifyParameterAttrs - Check the given attributes for an argument or return
1140 // value of the specified type. The value V is printed in error messages.
1141 void Verifier::VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
1142 bool isReturnValue, const Value *V) {
1143 if (!Attrs.hasAttributes(Idx))
1146 VerifyAttributeTypes(Attrs, Idx, false, V);
1149 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1150 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1151 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1152 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1153 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
1154 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1155 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', and "
1156 "'returned' do not apply to return values!",
1159 // Check for mutually incompatible attributes. Only inreg is compatible with
1161 unsigned AttrCount = 0;
1162 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1163 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1164 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1165 Attrs.hasAttribute(Idx, Attribute::InReg);
1166 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
1167 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1168 "and 'sret' are incompatible!",
1171 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1172 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1174 "'inalloca and readonly' are incompatible!",
1177 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1178 Attrs.hasAttribute(Idx, Attribute::Returned)),
1180 "'sret and returned' are incompatible!",
1183 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1184 Attrs.hasAttribute(Idx, Attribute::SExt)),
1186 "'zeroext and signext' are incompatible!",
1189 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1190 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1192 "'readnone and readonly' are incompatible!",
1195 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1196 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1198 "'noinline and alwaysinline' are incompatible!",
1201 Assert(!AttrBuilder(Attrs, Idx)
1202 .hasAttributes(AttributeFuncs::typeIncompatible(Ty, Idx), Idx),
1203 "Wrong types for attribute: " +
1204 AttributeFuncs::typeIncompatible(Ty, Idx).getAsString(Idx),
1207 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
1208 SmallPtrSet<const Type*, 4> Visited;
1209 if (!PTy->getElementType()->isSized(&Visited)) {
1210 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1211 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1212 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1216 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1217 "Attribute 'byval' only applies to parameters with pointer type!",
1222 // VerifyFunctionAttrs - Check parameter attributes against a function type.
1223 // The value V is printed in error messages.
1224 void Verifier::VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
1226 if (Attrs.isEmpty())
1229 bool SawNest = false;
1230 bool SawReturned = false;
1231 bool SawSRet = false;
1233 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
1234 unsigned Idx = Attrs.getSlotIndex(i);
1238 Ty = FT->getReturnType();
1239 else if (Idx-1 < FT->getNumParams())
1240 Ty = FT->getParamType(Idx-1);
1242 break; // VarArgs attributes, verified elsewhere.
1244 VerifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
1249 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
1250 Assert(!SawNest, "More than one parameter has attribute nest!", V);
1254 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
1255 Assert(!SawReturned, "More than one parameter has attribute returned!",
1257 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1259 "argument and return types for 'returned' attribute",
1264 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
1265 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1266 Assert(Idx == 1 || Idx == 2,
1267 "Attribute 'sret' is not on first or second parameter!", V);
1271 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
1272 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1277 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1280 VerifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
1283 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1284 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1285 "Attributes 'readnone and readonly' are incompatible!", V);
1288 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1289 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1290 Attribute::AlwaysInline)),
1291 "Attributes 'noinline and alwaysinline' are incompatible!", V);
1293 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1294 Attribute::OptimizeNone)) {
1295 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1296 "Attribute 'optnone' requires 'noinline'!", V);
1298 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1299 Attribute::OptimizeForSize),
1300 "Attributes 'optsize and optnone' are incompatible!", V);
1302 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1303 "Attributes 'minsize and optnone' are incompatible!", V);
1306 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1307 Attribute::JumpTable)) {
1308 const GlobalValue *GV = cast<GlobalValue>(V);
1309 Assert(GV->hasUnnamedAddr(),
1310 "Attribute 'jumptable' requires 'unnamed_addr'", V);
1314 void Verifier::VerifyConstantExprBitcastType(const ConstantExpr *CE) {
1315 if (CE->getOpcode() != Instruction::BitCast)
1318 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1320 "Invalid bitcast", CE);
1323 bool Verifier::VerifyAttributeCount(AttributeSet Attrs, unsigned Params) {
1324 if (Attrs.getNumSlots() == 0)
1327 unsigned LastSlot = Attrs.getNumSlots() - 1;
1328 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
1329 if (LastIndex <= Params
1330 || (LastIndex == AttributeSet::FunctionIndex
1331 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
1337 /// \brief Verify that statepoint intrinsic is well formed.
1338 void Verifier::VerifyStatepoint(ImmutableCallSite CS) {
1339 assert(CS.getCalledFunction() &&
1340 CS.getCalledFunction()->getIntrinsicID() ==
1341 Intrinsic::experimental_gc_statepoint);
1343 const Instruction &CI = *CS.getInstruction();
1345 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory(),
1346 "gc.statepoint must read and write memory to preserve "
1347 "reordering restrictions required by safepoint semantics",
1350 const Value *Target = CS.getArgument(0);
1351 const PointerType *PT = dyn_cast<PointerType>(Target->getType());
1352 Assert(PT && PT->getElementType()->isFunctionTy(),
1353 "gc.statepoint callee must be of function pointer type", &CI, Target);
1354 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
1356 const Value *NumCallArgsV = CS.getArgument(1);
1357 Assert(isa<ConstantInt>(NumCallArgsV),
1358 "gc.statepoint number of arguments to underlying call "
1359 "must be constant integer",
1361 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
1362 Assert(NumCallArgs >= 0,
1363 "gc.statepoint number of arguments to underlying call "
1366 const int NumParams = (int)TargetFuncType->getNumParams();
1367 if (TargetFuncType->isVarArg()) {
1368 Assert(NumCallArgs >= NumParams,
1369 "gc.statepoint mismatch in number of vararg call args", &CI);
1371 // TODO: Remove this limitation
1372 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1373 "gc.statepoint doesn't support wrapping non-void "
1374 "vararg functions yet",
1377 Assert(NumCallArgs == NumParams,
1378 "gc.statepoint mismatch in number of call args", &CI);
1380 const Value *Unused = CS.getArgument(2);
1381 Assert(isa<ConstantInt>(Unused) && cast<ConstantInt>(Unused)->isNullValue(),
1382 "gc.statepoint parameter #3 must be zero", &CI);
1384 // Verify that the types of the call parameter arguments match
1385 // the type of the wrapped callee.
1386 for (int i = 0; i < NumParams; i++) {
1387 Type *ParamType = TargetFuncType->getParamType(i);
1388 Type *ArgType = CS.getArgument(3+i)->getType();
1389 Assert(ArgType == ParamType,
1390 "gc.statepoint call argument does not match wrapped "
1394 const int EndCallArgsInx = 2+NumCallArgs;
1395 const Value *NumDeoptArgsV = CS.getArgument(EndCallArgsInx+1);
1396 Assert(isa<ConstantInt>(NumDeoptArgsV),
1397 "gc.statepoint number of deoptimization arguments "
1398 "must be constant integer",
1400 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
1401 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1405 Assert(4 + NumCallArgs + NumDeoptArgs <= (int)CS.arg_size(),
1406 "gc.statepoint too few arguments according to length fields", &CI);
1408 // Check that the only uses of this gc.statepoint are gc.result or
1409 // gc.relocate calls which are tied to this statepoint and thus part
1410 // of the same statepoint sequence
1411 for (const User *U : CI.users()) {
1412 const CallInst *Call = dyn_cast<const CallInst>(U);
1413 Assert(Call, "illegal use of statepoint token", &CI, U);
1414 if (!Call) continue;
1415 Assert(isGCRelocate(Call) || isGCResult(Call),
1416 "gc.result or gc.relocate are the only value uses"
1417 "of a gc.statepoint",
1419 if (isGCResult(Call)) {
1420 Assert(Call->getArgOperand(0) == &CI,
1421 "gc.result connected to wrong gc.statepoint", &CI, Call);
1422 } else if (isGCRelocate(Call)) {
1423 Assert(Call->getArgOperand(0) == &CI,
1424 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
1428 // Note: It is legal for a single derived pointer to be listed multiple
1429 // times. It's non-optimal, but it is legal. It can also happen after
1430 // insertion if we strip a bitcast away.
1431 // Note: It is really tempting to check that each base is relocated and
1432 // that a derived pointer is never reused as a base pointer. This turns
1433 // out to be problematic since optimizations run after safepoint insertion
1434 // can recognize equality properties that the insertion logic doesn't know
1435 // about. See example statepoint.ll in the verifier subdirectory
1438 void Verifier::verifyFrameRecoverIndices() {
1439 for (auto &Counts : FrameEscapeInfo) {
1440 Function *F = Counts.first;
1441 unsigned EscapedObjectCount = Counts.second.first;
1442 unsigned MaxRecoveredIndex = Counts.second.second;
1443 Assert(MaxRecoveredIndex <= EscapedObjectCount,
1444 "all indices passed to llvm.framerecover must be less than the "
1445 "number of arguments passed ot llvm.frameescape in the parent "
1451 // visitFunction - Verify that a function is ok.
1453 void Verifier::visitFunction(const Function &F) {
1454 // Check function arguments.
1455 FunctionType *FT = F.getFunctionType();
1456 unsigned NumArgs = F.arg_size();
1458 Assert(Context == &F.getContext(),
1459 "Function context does not match Module context!", &F);
1461 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1462 Assert(FT->getNumParams() == NumArgs,
1463 "# formal arguments must match # of arguments for function type!", &F,
1465 Assert(F.getReturnType()->isFirstClassType() ||
1466 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1467 "Functions cannot return aggregate values!", &F);
1469 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1470 "Invalid struct return type!", &F);
1472 AttributeSet Attrs = F.getAttributes();
1474 Assert(VerifyAttributeCount(Attrs, FT->getNumParams()),
1475 "Attribute after last parameter!", &F);
1477 // Check function attributes.
1478 VerifyFunctionAttrs(FT, Attrs, &F);
1480 // On function declarations/definitions, we do not support the builtin
1481 // attribute. We do not check this in VerifyFunctionAttrs since that is
1482 // checking for Attributes that can/can not ever be on functions.
1483 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1484 "Attribute 'builtin' can only be applied to a callsite.", &F);
1486 // Check that this function meets the restrictions on this calling convention.
1487 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1488 // restrictions can be lifted.
1489 switch (F.getCallingConv()) {
1491 case CallingConv::C:
1493 case CallingConv::Fast:
1494 case CallingConv::Cold:
1495 case CallingConv::Intel_OCL_BI:
1496 case CallingConv::PTX_Kernel:
1497 case CallingConv::PTX_Device:
1498 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1499 "perfect forwarding!",
1504 bool isLLVMdotName = F.getName().size() >= 5 &&
1505 F.getName().substr(0, 5) == "llvm.";
1507 // Check that the argument values match the function type for this function...
1509 for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E;
1511 Assert(I->getType() == FT->getParamType(i),
1512 "Argument value does not match function argument type!", I,
1513 FT->getParamType(i));
1514 Assert(I->getType()->isFirstClassType(),
1515 "Function arguments must have first-class types!", I);
1517 Assert(!I->getType()->isMetadataTy(),
1518 "Function takes metadata but isn't an intrinsic", I, &F);
1521 if (F.isMaterializable()) {
1522 // Function has a body somewhere we can't see.
1523 } else if (F.isDeclaration()) {
1524 Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1525 "invalid linkage type for function declaration", &F);
1527 // Verify that this function (which has a body) is not named "llvm.*". It
1528 // is not legal to define intrinsics.
1529 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
1531 // Check the entry node
1532 const BasicBlock *Entry = &F.getEntryBlock();
1533 Assert(pred_empty(Entry),
1534 "Entry block to function must not have predecessors!", Entry);
1536 // The address of the entry block cannot be taken, unless it is dead.
1537 if (Entry->hasAddressTaken()) {
1538 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1539 "blockaddress may not be used with the entry block!", Entry);
1543 // If this function is actually an intrinsic, verify that it is only used in
1544 // direct call/invokes, never having its "address taken".
1545 if (F.getIntrinsicID()) {
1547 if (F.hasAddressTaken(&U))
1548 Assert(0, "Invalid user of intrinsic instruction!", U);
1551 Assert(!F.hasDLLImportStorageClass() ||
1552 (F.isDeclaration() && F.hasExternalLinkage()) ||
1553 F.hasAvailableExternallyLinkage(),
1554 "Function is marked as dllimport, but not external.", &F);
1557 // verifyBasicBlock - Verify that a basic block is well formed...
1559 void Verifier::visitBasicBlock(BasicBlock &BB) {
1560 InstsInThisBlock.clear();
1562 // Ensure that basic blocks have terminators!
1563 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
1565 // Check constraints that this basic block imposes on all of the PHI nodes in
1567 if (isa<PHINode>(BB.front())) {
1568 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
1569 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
1570 std::sort(Preds.begin(), Preds.end());
1572 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
1573 // Ensure that PHI nodes have at least one entry!
1574 Assert(PN->getNumIncomingValues() != 0,
1575 "PHI nodes must have at least one entry. If the block is dead, "
1576 "the PHI should be removed!",
1578 Assert(PN->getNumIncomingValues() == Preds.size(),
1579 "PHINode should have one entry for each predecessor of its "
1580 "parent basic block!",
1583 // Get and sort all incoming values in the PHI node...
1585 Values.reserve(PN->getNumIncomingValues());
1586 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1587 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
1588 PN->getIncomingValue(i)));
1589 std::sort(Values.begin(), Values.end());
1591 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
1592 // Check to make sure that if there is more than one entry for a
1593 // particular basic block in this PHI node, that the incoming values are
1596 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
1597 Values[i].second == Values[i - 1].second,
1598 "PHI node has multiple entries for the same basic block with "
1599 "different incoming values!",
1600 PN, Values[i].first, Values[i].second, Values[i - 1].second);
1602 // Check to make sure that the predecessors and PHI node entries are
1604 Assert(Values[i].first == Preds[i],
1605 "PHI node entries do not match predecessors!", PN,
1606 Values[i].first, Preds[i]);
1611 // Check that all instructions have their parent pointers set up correctly.
1614 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
1618 void Verifier::visitTerminatorInst(TerminatorInst &I) {
1619 // Ensure that terminators only exist at the end of the basic block.
1620 Assert(&I == I.getParent()->getTerminator(),
1621 "Terminator found in the middle of a basic block!", I.getParent());
1622 visitInstruction(I);
1625 void Verifier::visitBranchInst(BranchInst &BI) {
1626 if (BI.isConditional()) {
1627 Assert(BI.getCondition()->getType()->isIntegerTy(1),
1628 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
1630 visitTerminatorInst(BI);
1633 void Verifier::visitReturnInst(ReturnInst &RI) {
1634 Function *F = RI.getParent()->getParent();
1635 unsigned N = RI.getNumOperands();
1636 if (F->getReturnType()->isVoidTy())
1638 "Found return instr that returns non-void in Function of void "
1640 &RI, F->getReturnType());
1642 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
1643 "Function return type does not match operand "
1644 "type of return inst!",
1645 &RI, F->getReturnType());
1647 // Check to make sure that the return value has necessary properties for
1649 visitTerminatorInst(RI);
1652 void Verifier::visitSwitchInst(SwitchInst &SI) {
1653 // Check to make sure that all of the constants in the switch instruction
1654 // have the same type as the switched-on value.
1655 Type *SwitchTy = SI.getCondition()->getType();
1656 SmallPtrSet<ConstantInt*, 32> Constants;
1657 for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end(); i != e; ++i) {
1658 Assert(i.getCaseValue()->getType() == SwitchTy,
1659 "Switch constants must all be same type as switch value!", &SI);
1660 Assert(Constants.insert(i.getCaseValue()).second,
1661 "Duplicate integer as switch case", &SI, i.getCaseValue());
1664 visitTerminatorInst(SI);
1667 void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
1668 Assert(BI.getAddress()->getType()->isPointerTy(),
1669 "Indirectbr operand must have pointer type!", &BI);
1670 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
1671 Assert(BI.getDestination(i)->getType()->isLabelTy(),
1672 "Indirectbr destinations must all have pointer type!", &BI);
1674 visitTerminatorInst(BI);
1677 void Verifier::visitSelectInst(SelectInst &SI) {
1678 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
1680 "Invalid operands for select instruction!", &SI);
1682 Assert(SI.getTrueValue()->getType() == SI.getType(),
1683 "Select values must have same type as select instruction!", &SI);
1684 visitInstruction(SI);
1687 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
1688 /// a pass, if any exist, it's an error.
1690 void Verifier::visitUserOp1(Instruction &I) {
1691 Assert(0, "User-defined operators should not live outside of a pass!", &I);
1694 void Verifier::visitTruncInst(TruncInst &I) {
1695 // Get the source and destination types
1696 Type *SrcTy = I.getOperand(0)->getType();
1697 Type *DestTy = I.getType();
1699 // Get the size of the types in bits, we'll need this later
1700 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1701 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1703 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
1704 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
1705 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1706 "trunc source and destination must both be a vector or neither", &I);
1707 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
1709 visitInstruction(I);
1712 void Verifier::visitZExtInst(ZExtInst &I) {
1713 // Get the source and destination types
1714 Type *SrcTy = I.getOperand(0)->getType();
1715 Type *DestTy = I.getType();
1717 // Get the size of the types in bits, we'll need this later
1718 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
1719 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
1720 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1721 "zext source and destination must both be a vector or neither", &I);
1722 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1723 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1725 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
1727 visitInstruction(I);
1730 void Verifier::visitSExtInst(SExtInst &I) {
1731 // Get the source and destination types
1732 Type *SrcTy = I.getOperand(0)->getType();
1733 Type *DestTy = I.getType();
1735 // Get the size of the types in bits, we'll need this later
1736 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1737 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1739 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
1740 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
1741 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1742 "sext source and destination must both be a vector or neither", &I);
1743 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
1745 visitInstruction(I);
1748 void Verifier::visitFPTruncInst(FPTruncInst &I) {
1749 // Get the source and destination types
1750 Type *SrcTy = I.getOperand(0)->getType();
1751 Type *DestTy = I.getType();
1752 // Get the size of the types in bits, we'll need this later
1753 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1754 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1756 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
1757 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
1758 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1759 "fptrunc source and destination must both be a vector or neither", &I);
1760 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
1762 visitInstruction(I);
1765 void Verifier::visitFPExtInst(FPExtInst &I) {
1766 // Get the source and destination types
1767 Type *SrcTy = I.getOperand(0)->getType();
1768 Type *DestTy = I.getType();
1770 // Get the size of the types in bits, we'll need this later
1771 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1772 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1774 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
1775 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
1776 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1777 "fpext source and destination must both be a vector or neither", &I);
1778 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
1780 visitInstruction(I);
1783 void Verifier::visitUIToFPInst(UIToFPInst &I) {
1784 // Get the source and destination types
1785 Type *SrcTy = I.getOperand(0)->getType();
1786 Type *DestTy = I.getType();
1788 bool SrcVec = SrcTy->isVectorTy();
1789 bool DstVec = DestTy->isVectorTy();
1791 Assert(SrcVec == DstVec,
1792 "UIToFP source and dest must both be vector or scalar", &I);
1793 Assert(SrcTy->isIntOrIntVectorTy(),
1794 "UIToFP source must be integer or integer vector", &I);
1795 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
1798 if (SrcVec && DstVec)
1799 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
1800 cast<VectorType>(DestTy)->getNumElements(),
1801 "UIToFP source and dest vector length mismatch", &I);
1803 visitInstruction(I);
1806 void Verifier::visitSIToFPInst(SIToFPInst &I) {
1807 // Get the source and destination types
1808 Type *SrcTy = I.getOperand(0)->getType();
1809 Type *DestTy = I.getType();
1811 bool SrcVec = SrcTy->isVectorTy();
1812 bool DstVec = DestTy->isVectorTy();
1814 Assert(SrcVec == DstVec,
1815 "SIToFP source and dest must both be vector or scalar", &I);
1816 Assert(SrcTy->isIntOrIntVectorTy(),
1817 "SIToFP source must be integer or integer vector", &I);
1818 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
1821 if (SrcVec && DstVec)
1822 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
1823 cast<VectorType>(DestTy)->getNumElements(),
1824 "SIToFP source and dest vector length mismatch", &I);
1826 visitInstruction(I);
1829 void Verifier::visitFPToUIInst(FPToUIInst &I) {
1830 // Get the source and destination types
1831 Type *SrcTy = I.getOperand(0)->getType();
1832 Type *DestTy = I.getType();
1834 bool SrcVec = SrcTy->isVectorTy();
1835 bool DstVec = DestTy->isVectorTy();
1837 Assert(SrcVec == DstVec,
1838 "FPToUI source and dest must both be vector or scalar", &I);
1839 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
1841 Assert(DestTy->isIntOrIntVectorTy(),
1842 "FPToUI result must be integer or integer vector", &I);
1844 if (SrcVec && DstVec)
1845 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
1846 cast<VectorType>(DestTy)->getNumElements(),
1847 "FPToUI source and dest vector length mismatch", &I);
1849 visitInstruction(I);
1852 void Verifier::visitFPToSIInst(FPToSIInst &I) {
1853 // Get the source and destination types
1854 Type *SrcTy = I.getOperand(0)->getType();
1855 Type *DestTy = I.getType();
1857 bool SrcVec = SrcTy->isVectorTy();
1858 bool DstVec = DestTy->isVectorTy();
1860 Assert(SrcVec == DstVec,
1861 "FPToSI source and dest must both be vector or scalar", &I);
1862 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
1864 Assert(DestTy->isIntOrIntVectorTy(),
1865 "FPToSI result must be integer or integer vector", &I);
1867 if (SrcVec && DstVec)
1868 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
1869 cast<VectorType>(DestTy)->getNumElements(),
1870 "FPToSI source and dest vector length mismatch", &I);
1872 visitInstruction(I);
1875 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
1876 // Get the source and destination types
1877 Type *SrcTy = I.getOperand(0)->getType();
1878 Type *DestTy = I.getType();
1880 Assert(SrcTy->getScalarType()->isPointerTy(),
1881 "PtrToInt source must be pointer", &I);
1882 Assert(DestTy->getScalarType()->isIntegerTy(),
1883 "PtrToInt result must be integral", &I);
1884 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
1887 if (SrcTy->isVectorTy()) {
1888 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
1889 VectorType *VDest = dyn_cast<VectorType>(DestTy);
1890 Assert(VSrc->getNumElements() == VDest->getNumElements(),
1891 "PtrToInt Vector width mismatch", &I);
1894 visitInstruction(I);
1897 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
1898 // Get the source and destination types
1899 Type *SrcTy = I.getOperand(0)->getType();
1900 Type *DestTy = I.getType();
1902 Assert(SrcTy->getScalarType()->isIntegerTy(),
1903 "IntToPtr source must be an integral", &I);
1904 Assert(DestTy->getScalarType()->isPointerTy(),
1905 "IntToPtr result must be a pointer", &I);
1906 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
1908 if (SrcTy->isVectorTy()) {
1909 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
1910 VectorType *VDest = dyn_cast<VectorType>(DestTy);
1911 Assert(VSrc->getNumElements() == VDest->getNumElements(),
1912 "IntToPtr Vector width mismatch", &I);
1914 visitInstruction(I);
1917 void Verifier::visitBitCastInst(BitCastInst &I) {
1919 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
1920 "Invalid bitcast", &I);
1921 visitInstruction(I);
1924 void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
1925 Type *SrcTy = I.getOperand(0)->getType();
1926 Type *DestTy = I.getType();
1928 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
1930 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
1932 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
1933 "AddrSpaceCast must be between different address spaces", &I);
1934 if (SrcTy->isVectorTy())
1935 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
1936 "AddrSpaceCast vector pointer number of elements mismatch", &I);
1937 visitInstruction(I);
1940 /// visitPHINode - Ensure that a PHI node is well formed.
1942 void Verifier::visitPHINode(PHINode &PN) {
1943 // Ensure that the PHI nodes are all grouped together at the top of the block.
1944 // This can be tested by checking whether the instruction before this is
1945 // either nonexistent (because this is begin()) or is a PHI node. If not,
1946 // then there is some other instruction before a PHI.
1947 Assert(&PN == &PN.getParent()->front() ||
1948 isa<PHINode>(--BasicBlock::iterator(&PN)),
1949 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
1951 // Check that all of the values of the PHI node have the same type as the
1952 // result, and that the incoming blocks are really basic blocks.
1953 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
1954 Assert(PN.getType() == PN.getIncomingValue(i)->getType(),
1955 "PHI node operands are not the same type as the result!", &PN);
1958 // All other PHI node constraints are checked in the visitBasicBlock method.
1960 visitInstruction(PN);
1963 void Verifier::VerifyCallSite(CallSite CS) {
1964 Instruction *I = CS.getInstruction();
1966 Assert(CS.getCalledValue()->getType()->isPointerTy(),
1967 "Called function must be a pointer!", I);
1968 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
1970 Assert(FPTy->getElementType()->isFunctionTy(),
1971 "Called function is not pointer to function type!", I);
1972 FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
1974 // Verify that the correct number of arguments are being passed
1975 if (FTy->isVarArg())
1976 Assert(CS.arg_size() >= FTy->getNumParams(),
1977 "Called function requires more parameters than were provided!", I);
1979 Assert(CS.arg_size() == FTy->getNumParams(),
1980 "Incorrect number of arguments passed to called function!", I);
1982 // Verify that all arguments to the call match the function type.
1983 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
1984 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
1985 "Call parameter type does not match function signature!",
1986 CS.getArgument(i), FTy->getParamType(i), I);
1988 AttributeSet Attrs = CS.getAttributes();
1990 Assert(VerifyAttributeCount(Attrs, CS.arg_size()),
1991 "Attribute after last parameter!", I);
1993 // Verify call attributes.
1994 VerifyFunctionAttrs(FTy, Attrs, I);
1996 // Conservatively check the inalloca argument.
1997 // We have a bug if we can find that there is an underlying alloca without
1999 if (CS.hasInAllocaArgument()) {
2000 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2001 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
2002 Assert(AI->isUsedWithInAlloca(),
2003 "inalloca argument for call has mismatched alloca", AI, I);
2006 if (FTy->isVarArg()) {
2007 // FIXME? is 'nest' even legal here?
2008 bool SawNest = false;
2009 bool SawReturned = false;
2011 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2012 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2014 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2018 // Check attributes on the varargs part.
2019 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
2020 Type *Ty = CS.getArgument(Idx-1)->getType();
2021 VerifyParameterAttrs(Attrs, Idx, Ty, false, I);
2023 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
2024 Assert(!SawNest, "More than one parameter has attribute nest!", I);
2028 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
2029 Assert(!SawReturned, "More than one parameter has attribute returned!",
2031 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2032 "Incompatible argument and return types for 'returned' "
2038 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2039 "Attribute 'sret' cannot be used for vararg call arguments!", I);
2041 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
2042 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
2046 // Verify that there's no metadata unless it's a direct call to an intrinsic.
2047 if (CS.getCalledFunction() == nullptr ||
2048 !CS.getCalledFunction()->getName().startswith("llvm.")) {
2049 for (FunctionType::param_iterator PI = FTy->param_begin(),
2050 PE = FTy->param_end(); PI != PE; ++PI)
2051 Assert(!(*PI)->isMetadataTy(),
2052 "Function has metadata parameter but isn't an intrinsic", I);
2055 visitInstruction(*I);
2058 /// Two types are "congruent" if they are identical, or if they are both pointer
2059 /// types with different pointee types and the same address space.
2060 static bool isTypeCongruent(Type *L, Type *R) {
2063 PointerType *PL = dyn_cast<PointerType>(L);
2064 PointerType *PR = dyn_cast<PointerType>(R);
2067 return PL->getAddressSpace() == PR->getAddressSpace();
2070 static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2071 static const Attribute::AttrKind ABIAttrs[] = {
2072 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
2073 Attribute::InReg, Attribute::Returned};
2075 for (auto AK : ABIAttrs) {
2076 if (Attrs.hasAttribute(I + 1, AK))
2077 Copy.addAttribute(AK);
2079 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2080 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2084 void Verifier::verifyMustTailCall(CallInst &CI) {
2085 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
2087 // - The caller and callee prototypes must match. Pointer types of
2088 // parameters or return types may differ in pointee type, but not
2090 Function *F = CI.getParent()->getParent();
2091 auto GetFnTy = [](Value *V) {
2092 return cast<FunctionType>(
2093 cast<PointerType>(V->getType())->getElementType());
2095 FunctionType *CallerTy = GetFnTy(F);
2096 FunctionType *CalleeTy = GetFnTy(CI.getCalledValue());
2097 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2098 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2099 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2100 "cannot guarantee tail call due to mismatched varargs", &CI);
2101 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2102 "cannot guarantee tail call due to mismatched return types", &CI);
2103 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2105 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2106 "cannot guarantee tail call due to mismatched parameter types", &CI);
2109 // - The calling conventions of the caller and callee must match.
2110 Assert(F->getCallingConv() == CI.getCallingConv(),
2111 "cannot guarantee tail call due to mismatched calling conv", &CI);
2113 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2114 // returned, and inalloca, must match.
2115 AttributeSet CallerAttrs = F->getAttributes();
2116 AttributeSet CalleeAttrs = CI.getAttributes();
2117 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2118 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2119 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
2120 Assert(CallerABIAttrs == CalleeABIAttrs,
2121 "cannot guarantee tail call due to mismatched ABI impacting "
2122 "function attributes",
2123 &CI, CI.getOperand(I));
2126 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2127 // or a pointer bitcast followed by a ret instruction.
2128 // - The ret instruction must return the (possibly bitcasted) value
2129 // produced by the call or void.
2130 Value *RetVal = &CI;
2131 Instruction *Next = CI.getNextNode();
2133 // Handle the optional bitcast.
2134 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
2135 Assert(BI->getOperand(0) == RetVal,
2136 "bitcast following musttail call must use the call", BI);
2138 Next = BI->getNextNode();
2141 // Check the return.
2142 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
2143 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2145 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2146 "musttail call result must be returned", Ret);
2149 void Verifier::visitCallInst(CallInst &CI) {
2150 VerifyCallSite(&CI);
2152 if (CI.isMustTailCall())
2153 verifyMustTailCall(CI);
2155 if (Function *F = CI.getCalledFunction())
2156 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
2157 visitIntrinsicFunctionCall(ID, CI);
2160 void Verifier::visitInvokeInst(InvokeInst &II) {
2161 VerifyCallSite(&II);
2163 // Verify that there is a landingpad instruction as the first non-PHI
2164 // instruction of the 'unwind' destination.
2165 Assert(II.getUnwindDest()->isLandingPad(),
2166 "The unwind destination does not have a landingpad instruction!", &II);
2168 if (Function *F = II.getCalledFunction())
2169 // TODO: Ideally we should use visitIntrinsicFunction here. But it uses
2170 // CallInst as an input parameter. It not woth updating this whole
2171 // function only to support statepoint verification.
2172 if (F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint)
2173 VerifyStatepoint(ImmutableCallSite(&II));
2175 visitTerminatorInst(II);
2178 /// visitBinaryOperator - Check that both arguments to the binary operator are
2179 /// of the same type!
2181 void Verifier::visitBinaryOperator(BinaryOperator &B) {
2182 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2183 "Both operands to a binary operator are not of the same type!", &B);
2185 switch (B.getOpcode()) {
2186 // Check that integer arithmetic operators are only used with
2187 // integral operands.
2188 case Instruction::Add:
2189 case Instruction::Sub:
2190 case Instruction::Mul:
2191 case Instruction::SDiv:
2192 case Instruction::UDiv:
2193 case Instruction::SRem:
2194 case Instruction::URem:
2195 Assert(B.getType()->isIntOrIntVectorTy(),
2196 "Integer arithmetic operators only work with integral types!", &B);
2197 Assert(B.getType() == B.getOperand(0)->getType(),
2198 "Integer arithmetic operators must have same type "
2199 "for operands and result!",
2202 // Check that floating-point arithmetic operators are only used with
2203 // floating-point operands.
2204 case Instruction::FAdd:
2205 case Instruction::FSub:
2206 case Instruction::FMul:
2207 case Instruction::FDiv:
2208 case Instruction::FRem:
2209 Assert(B.getType()->isFPOrFPVectorTy(),
2210 "Floating-point arithmetic operators only work with "
2211 "floating-point types!",
2213 Assert(B.getType() == B.getOperand(0)->getType(),
2214 "Floating-point arithmetic operators must have same type "
2215 "for operands and result!",
2218 // Check that logical operators are only used with integral operands.
2219 case Instruction::And:
2220 case Instruction::Or:
2221 case Instruction::Xor:
2222 Assert(B.getType()->isIntOrIntVectorTy(),
2223 "Logical operators only work with integral types!", &B);
2224 Assert(B.getType() == B.getOperand(0)->getType(),
2225 "Logical operators must have same type for operands and result!",
2228 case Instruction::Shl:
2229 case Instruction::LShr:
2230 case Instruction::AShr:
2231 Assert(B.getType()->isIntOrIntVectorTy(),
2232 "Shifts only work with integral types!", &B);
2233 Assert(B.getType() == B.getOperand(0)->getType(),
2234 "Shift return type must be same as operands!", &B);
2237 llvm_unreachable("Unknown BinaryOperator opcode!");
2240 visitInstruction(B);
2243 void Verifier::visitICmpInst(ICmpInst &IC) {
2244 // Check that the operands are the same type
2245 Type *Op0Ty = IC.getOperand(0)->getType();
2246 Type *Op1Ty = IC.getOperand(1)->getType();
2247 Assert(Op0Ty == Op1Ty,
2248 "Both operands to ICmp instruction are not of the same type!", &IC);
2249 // Check that the operands are the right type
2250 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2251 "Invalid operand types for ICmp instruction", &IC);
2252 // Check that the predicate is valid.
2253 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2254 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2255 "Invalid predicate in ICmp instruction!", &IC);
2257 visitInstruction(IC);
2260 void Verifier::visitFCmpInst(FCmpInst &FC) {
2261 // Check that the operands are the same type
2262 Type *Op0Ty = FC.getOperand(0)->getType();
2263 Type *Op1Ty = FC.getOperand(1)->getType();
2264 Assert(Op0Ty == Op1Ty,
2265 "Both operands to FCmp instruction are not of the same type!", &FC);
2266 // Check that the operands are the right type
2267 Assert(Op0Ty->isFPOrFPVectorTy(),
2268 "Invalid operand types for FCmp instruction", &FC);
2269 // Check that the predicate is valid.
2270 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2271 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2272 "Invalid predicate in FCmp instruction!", &FC);
2274 visitInstruction(FC);
2277 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
2279 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2280 "Invalid extractelement operands!", &EI);
2281 visitInstruction(EI);
2284 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
2285 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2287 "Invalid insertelement operands!", &IE);
2288 visitInstruction(IE);
2291 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
2292 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2294 "Invalid shufflevector operands!", &SV);
2295 visitInstruction(SV);
2298 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
2299 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
2301 Assert(isa<PointerType>(TargetTy),
2302 "GEP base pointer is not a vector or a vector of pointers", &GEP);
2303 Assert(cast<PointerType>(TargetTy)->getElementType()->isSized(),
2304 "GEP into unsized type!", &GEP);
2305 Assert(GEP.getPointerOperandType()->isVectorTy() ==
2306 GEP.getType()->isVectorTy(),
2307 "Vector GEP must return a vector value", &GEP);
2309 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
2311 GetElementPtrInst::getIndexedType(GEP.getPointerOperandType(), Idxs);
2312 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
2314 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
2315 cast<PointerType>(GEP.getType()->getScalarType())
2316 ->getElementType() == ElTy,
2317 "GEP is not of right type for indices!", &GEP, ElTy);
2319 if (GEP.getPointerOperandType()->isVectorTy()) {
2320 // Additional checks for vector GEPs.
2321 unsigned GepWidth = GEP.getPointerOperandType()->getVectorNumElements();
2322 Assert(GepWidth == GEP.getType()->getVectorNumElements(),
2323 "Vector GEP result width doesn't match operand's", &GEP);
2324 for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
2325 Type *IndexTy = Idxs[i]->getType();
2326 Assert(IndexTy->isVectorTy(), "Vector GEP must have vector indices!",
2328 unsigned IndexWidth = IndexTy->getVectorNumElements();
2329 Assert(IndexWidth == GepWidth, "Invalid GEP index vector width", &GEP);
2332 visitInstruction(GEP);
2335 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2336 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2339 void Verifier::visitRangeMetadata(Instruction& I,
2340 MDNode* Range, Type* Ty) {
2342 Range == I.getMetadata(LLVMContext::MD_range) &&
2343 "precondition violation");
2345 unsigned NumOperands = Range->getNumOperands();
2346 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
2347 unsigned NumRanges = NumOperands / 2;
2348 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2350 ConstantRange LastRange(1); // Dummy initial value
2351 for (unsigned i = 0; i < NumRanges; ++i) {
2353 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
2354 Assert(Low, "The lower limit must be an integer!", Low);
2356 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
2357 Assert(High, "The upper limit must be an integer!", High);
2358 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2359 "Range types must match instruction type!", &I);
2361 APInt HighV = High->getValue();
2362 APInt LowV = Low->getValue();
2363 ConstantRange CurRange(LowV, HighV);
2364 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2365 "Range must not be empty!", Range);
2367 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2368 "Intervals are overlapping", Range);
2369 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2371 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2374 LastRange = ConstantRange(LowV, HighV);
2376 if (NumRanges > 2) {
2378 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
2380 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
2381 ConstantRange FirstRange(FirstLow, FirstHigh);
2382 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2383 "Intervals are overlapping", Range);
2384 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2389 void Verifier::visitLoadInst(LoadInst &LI) {
2390 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
2391 Assert(PTy, "Load operand must be a pointer.", &LI);
2392 Type *ElTy = PTy->getElementType();
2393 Assert(ElTy == LI.getType(),
2394 "Load result type does not match pointer operand type!", &LI, ElTy);
2395 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2396 "huge alignment values are unsupported", &LI);
2397 if (LI.isAtomic()) {
2398 Assert(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
2399 "Load cannot have Release ordering", &LI);
2400 Assert(LI.getAlignment() != 0,
2401 "Atomic load must specify explicit alignment", &LI);
2402 if (!ElTy->isPointerTy()) {
2403 Assert(ElTy->isIntegerTy(), "atomic load operand must have integer type!",
2405 unsigned Size = ElTy->getPrimitiveSizeInBits();
2406 Assert(Size >= 8 && !(Size & (Size - 1)),
2407 "atomic load operand must be power-of-two byte-sized integer", &LI,
2411 Assert(LI.getSynchScope() == CrossThread,
2412 "Non-atomic load cannot have SynchronizationScope specified", &LI);
2415 visitInstruction(LI);
2418 void Verifier::visitStoreInst(StoreInst &SI) {
2419 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
2420 Assert(PTy, "Store operand must be a pointer.", &SI);
2421 Type *ElTy = PTy->getElementType();
2422 Assert(ElTy == SI.getOperand(0)->getType(),
2423 "Stored value type does not match pointer operand type!", &SI, ElTy);
2424 Assert(SI.getAlignment() <= Value::MaximumAlignment,
2425 "huge alignment values are unsupported", &SI);
2426 if (SI.isAtomic()) {
2427 Assert(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
2428 "Store cannot have Acquire ordering", &SI);
2429 Assert(SI.getAlignment() != 0,
2430 "Atomic store must specify explicit alignment", &SI);
2431 if (!ElTy->isPointerTy()) {
2432 Assert(ElTy->isIntegerTy(),
2433 "atomic store operand must have integer type!", &SI, ElTy);
2434 unsigned Size = ElTy->getPrimitiveSizeInBits();
2435 Assert(Size >= 8 && !(Size & (Size - 1)),
2436 "atomic store operand must be power-of-two byte-sized integer",
2440 Assert(SI.getSynchScope() == CrossThread,
2441 "Non-atomic store cannot have SynchronizationScope specified", &SI);
2443 visitInstruction(SI);
2446 void Verifier::visitAllocaInst(AllocaInst &AI) {
2447 SmallPtrSet<const Type*, 4> Visited;
2448 PointerType *PTy = AI.getType();
2449 Assert(PTy->getAddressSpace() == 0,
2450 "Allocation instruction pointer not in the generic address space!",
2452 Assert(PTy->getElementType()->isSized(&Visited),
2453 "Cannot allocate unsized type", &AI);
2454 Assert(AI.getArraySize()->getType()->isIntegerTy(),
2455 "Alloca array size must have integer type", &AI);
2456 Assert(AI.getAlignment() <= Value::MaximumAlignment,
2457 "huge alignment values are unsupported", &AI);
2459 visitInstruction(AI);
2462 void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
2464 // FIXME: more conditions???
2465 Assert(CXI.getSuccessOrdering() != NotAtomic,
2466 "cmpxchg instructions must be atomic.", &CXI);
2467 Assert(CXI.getFailureOrdering() != NotAtomic,
2468 "cmpxchg instructions must be atomic.", &CXI);
2469 Assert(CXI.getSuccessOrdering() != Unordered,
2470 "cmpxchg instructions cannot be unordered.", &CXI);
2471 Assert(CXI.getFailureOrdering() != Unordered,
2472 "cmpxchg instructions cannot be unordered.", &CXI);
2473 Assert(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
2474 "cmpxchg instructions be at least as constrained on success as fail",
2476 Assert(CXI.getFailureOrdering() != Release &&
2477 CXI.getFailureOrdering() != AcquireRelease,
2478 "cmpxchg failure ordering cannot include release semantics", &CXI);
2480 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
2481 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
2482 Type *ElTy = PTy->getElementType();
2483 Assert(ElTy->isIntegerTy(), "cmpxchg operand must have integer type!", &CXI,
2485 unsigned Size = ElTy->getPrimitiveSizeInBits();
2486 Assert(Size >= 8 && !(Size & (Size - 1)),
2487 "cmpxchg operand must be power-of-two byte-sized integer", &CXI, ElTy);
2488 Assert(ElTy == CXI.getOperand(1)->getType(),
2489 "Expected value type does not match pointer operand type!", &CXI,
2491 Assert(ElTy == CXI.getOperand(2)->getType(),
2492 "Stored value type does not match pointer operand type!", &CXI, ElTy);
2493 visitInstruction(CXI);
2496 void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
2497 Assert(RMWI.getOrdering() != NotAtomic,
2498 "atomicrmw instructions must be atomic.", &RMWI);
2499 Assert(RMWI.getOrdering() != Unordered,
2500 "atomicrmw instructions cannot be unordered.", &RMWI);
2501 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
2502 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
2503 Type *ElTy = PTy->getElementType();
2504 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
2506 unsigned Size = ElTy->getPrimitiveSizeInBits();
2507 Assert(Size >= 8 && !(Size & (Size - 1)),
2508 "atomicrmw operand must be power-of-two byte-sized integer", &RMWI,
2510 Assert(ElTy == RMWI.getOperand(1)->getType(),
2511 "Argument value type does not match pointer operand type!", &RMWI,
2513 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
2514 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
2515 "Invalid binary operation!", &RMWI);
2516 visitInstruction(RMWI);
2519 void Verifier::visitFenceInst(FenceInst &FI) {
2520 const AtomicOrdering Ordering = FI.getOrdering();
2521 Assert(Ordering == Acquire || Ordering == Release ||
2522 Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
2523 "fence instructions may only have "
2524 "acquire, release, acq_rel, or seq_cst ordering.",
2526 visitInstruction(FI);
2529 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
2530 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
2531 EVI.getIndices()) == EVI.getType(),
2532 "Invalid ExtractValueInst operands!", &EVI);
2534 visitInstruction(EVI);
2537 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
2538 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
2539 IVI.getIndices()) ==
2540 IVI.getOperand(1)->getType(),
2541 "Invalid InsertValueInst operands!", &IVI);
2543 visitInstruction(IVI);
2546 void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
2547 BasicBlock *BB = LPI.getParent();
2549 // The landingpad instruction is ill-formed if it doesn't have any clauses and
2551 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
2552 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
2554 // The landingpad instruction defines its parent as a landing pad block. The
2555 // landing pad block may be branched to only by the unwind edge of an invoke.
2556 for (pred_iterator I = pred_begin(BB), E = pred_end(BB); I != E; ++I) {
2557 const InvokeInst *II = dyn_cast<InvokeInst>((*I)->getTerminator());
2558 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
2559 "Block containing LandingPadInst must be jumped to "
2560 "only by the unwind edge of an invoke.",
2564 // The landingpad instruction must be the first non-PHI instruction in the
2566 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
2567 "LandingPadInst not the first non-PHI instruction in the block.",
2570 // The personality functions for all landingpad instructions within the same
2571 // function should match.
2573 Assert(LPI.getPersonalityFn() == PersonalityFn,
2574 "Personality function doesn't match others in function", &LPI);
2575 PersonalityFn = LPI.getPersonalityFn();
2577 // All operands must be constants.
2578 Assert(isa<Constant>(PersonalityFn), "Personality function is not constant!",
2580 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
2581 Constant *Clause = LPI.getClause(i);
2582 if (LPI.isCatch(i)) {
2583 Assert(isa<PointerType>(Clause->getType()),
2584 "Catch operand does not have pointer type!", &LPI);
2586 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
2587 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
2588 "Filter operand is not an array of constants!", &LPI);
2592 visitInstruction(LPI);
2595 void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
2596 Instruction *Op = cast<Instruction>(I.getOperand(i));
2597 // If the we have an invalid invoke, don't try to compute the dominance.
2598 // We already reject it in the invoke specific checks and the dominance
2599 // computation doesn't handle multiple edges.
2600 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
2601 if (II->getNormalDest() == II->getUnwindDest())
2605 const Use &U = I.getOperandUse(i);
2606 Assert(InstsInThisBlock.count(Op) || DT.dominates(Op, U),
2607 "Instruction does not dominate all uses!", Op, &I);
2610 /// verifyInstruction - Verify that an instruction is well formed.
2612 void Verifier::visitInstruction(Instruction &I) {
2613 BasicBlock *BB = I.getParent();
2614 Assert(BB, "Instruction not embedded in basic block!", &I);
2616 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
2617 for (User *U : I.users()) {
2618 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
2619 "Only PHI nodes may reference their own value!", &I);
2623 // Check that void typed values don't have names
2624 Assert(!I.getType()->isVoidTy() || !I.hasName(),
2625 "Instruction has a name, but provides a void value!", &I);
2627 // Check that the return value of the instruction is either void or a legal
2629 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
2630 "Instruction returns a non-scalar type!", &I);
2632 // Check that the instruction doesn't produce metadata. Calls are already
2633 // checked against the callee type.
2634 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
2635 "Invalid use of metadata!", &I);
2637 // Check that all uses of the instruction, if they are instructions
2638 // themselves, actually have parent basic blocks. If the use is not an
2639 // instruction, it is an error!
2640 for (Use &U : I.uses()) {
2641 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
2642 Assert(Used->getParent() != nullptr,
2643 "Instruction referencing"
2644 " instruction not embedded in a basic block!",
2647 CheckFailed("Use of instruction is not an instruction!", U);
2652 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
2653 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
2655 // Check to make sure that only first-class-values are operands to
2657 if (!I.getOperand(i)->getType()->isFirstClassType()) {
2658 Assert(0, "Instruction operands must be first-class values!", &I);
2661 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
2662 // Check to make sure that the "address of" an intrinsic function is never
2665 !F->isIntrinsic() ||
2666 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
2667 "Cannot take the address of an intrinsic!", &I);
2669 !F->isIntrinsic() || isa<CallInst>(I) ||
2670 F->getIntrinsicID() == Intrinsic::donothing ||
2671 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
2672 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
2673 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
2674 "Cannot invoke an intrinsinc other than"
2675 " donothing or patchpoint",
2677 Assert(F->getParent() == M, "Referencing function in another module!",
2679 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
2680 Assert(OpBB->getParent() == BB->getParent(),
2681 "Referring to a basic block in another function!", &I);
2682 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
2683 Assert(OpArg->getParent() == BB->getParent(),
2684 "Referring to an argument in another function!", &I);
2685 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
2686 Assert(GV->getParent() == M, "Referencing global in another module!", &I);
2687 } else if (isa<Instruction>(I.getOperand(i))) {
2688 verifyDominatesUse(I, i);
2689 } else if (isa<InlineAsm>(I.getOperand(i))) {
2690 Assert((i + 1 == e && isa<CallInst>(I)) ||
2691 (i + 3 == e && isa<InvokeInst>(I)),
2692 "Cannot take the address of an inline asm!", &I);
2693 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
2694 if (CE->getType()->isPtrOrPtrVectorTy()) {
2695 // If we have a ConstantExpr pointer, we need to see if it came from an
2696 // illegal bitcast (inttoptr <constant int> )
2697 SmallVector<const ConstantExpr *, 4> Stack;
2698 SmallPtrSet<const ConstantExpr *, 4> Visited;
2699 Stack.push_back(CE);
2701 while (!Stack.empty()) {
2702 const ConstantExpr *V = Stack.pop_back_val();
2703 if (!Visited.insert(V).second)
2706 VerifyConstantExprBitcastType(V);
2708 for (unsigned I = 0, N = V->getNumOperands(); I != N; ++I) {
2709 if (ConstantExpr *Op = dyn_cast<ConstantExpr>(V->getOperand(I)))
2710 Stack.push_back(Op);
2717 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
2718 Assert(I.getType()->isFPOrFPVectorTy(),
2719 "fpmath requires a floating point result!", &I);
2720 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
2721 if (ConstantFP *CFP0 =
2722 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
2723 APFloat Accuracy = CFP0->getValueAPF();
2724 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
2725 "fpmath accuracy not a positive number!", &I);
2727 Assert(false, "invalid fpmath accuracy!", &I);
2731 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
2732 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
2733 "Ranges are only for loads, calls and invokes!", &I);
2734 visitRangeMetadata(I, Range, I.getType());
2737 if (I.getMetadata(LLVMContext::MD_nonnull)) {
2738 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
2740 Assert(isa<LoadInst>(I),
2741 "nonnull applies only to load instructions, use attributes"
2742 " for calls or invokes",
2746 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
2747 Assert(isa<MDLocation>(N), "invalid !dbg metadata attachment", &I, N);
2751 InstsInThisBlock.insert(&I);
2754 /// VerifyIntrinsicType - Verify that the specified type (which comes from an
2755 /// intrinsic argument or return value) matches the type constraints specified
2756 /// by the .td file (e.g. an "any integer" argument really is an integer).
2758 /// This return true on error but does not print a message.
2759 bool Verifier::VerifyIntrinsicType(Type *Ty,
2760 ArrayRef<Intrinsic::IITDescriptor> &Infos,
2761 SmallVectorImpl<Type*> &ArgTys) {
2762 using namespace Intrinsic;
2764 // If we ran out of descriptors, there are too many arguments.
2765 if (Infos.empty()) return true;
2766 IITDescriptor D = Infos.front();
2767 Infos = Infos.slice(1);
2770 case IITDescriptor::Void: return !Ty->isVoidTy();
2771 case IITDescriptor::VarArg: return true;
2772 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
2773 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
2774 case IITDescriptor::Half: return !Ty->isHalfTy();
2775 case IITDescriptor::Float: return !Ty->isFloatTy();
2776 case IITDescriptor::Double: return !Ty->isDoubleTy();
2777 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
2778 case IITDescriptor::Vector: {
2779 VectorType *VT = dyn_cast<VectorType>(Ty);
2780 return !VT || VT->getNumElements() != D.Vector_Width ||
2781 VerifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
2783 case IITDescriptor::Pointer: {
2784 PointerType *PT = dyn_cast<PointerType>(Ty);
2785 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
2786 VerifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
2789 case IITDescriptor::Struct: {
2790 StructType *ST = dyn_cast<StructType>(Ty);
2791 if (!ST || ST->getNumElements() != D.Struct_NumElements)
2794 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
2795 if (VerifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
2800 case IITDescriptor::Argument:
2801 // Two cases here - If this is the second occurrence of an argument, verify
2802 // that the later instance matches the previous instance.
2803 if (D.getArgumentNumber() < ArgTys.size())
2804 return Ty != ArgTys[D.getArgumentNumber()];
2806 // Otherwise, if this is the first instance of an argument, record it and
2807 // verify the "Any" kind.
2808 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
2809 ArgTys.push_back(Ty);
2811 switch (D.getArgumentKind()) {
2812 case IITDescriptor::AK_Any: return false; // Success
2813 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
2814 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
2815 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
2816 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
2818 llvm_unreachable("all argument kinds not covered");
2820 case IITDescriptor::ExtendArgument: {
2821 // This may only be used when referring to a previous vector argument.
2822 if (D.getArgumentNumber() >= ArgTys.size())
2825 Type *NewTy = ArgTys[D.getArgumentNumber()];
2826 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
2827 NewTy = VectorType::getExtendedElementVectorType(VTy);
2828 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
2829 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
2835 case IITDescriptor::TruncArgument: {
2836 // This may only be used when referring to a previous vector argument.
2837 if (D.getArgumentNumber() >= ArgTys.size())
2840 Type *NewTy = ArgTys[D.getArgumentNumber()];
2841 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
2842 NewTy = VectorType::getTruncatedElementVectorType(VTy);
2843 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
2844 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
2850 case IITDescriptor::HalfVecArgument:
2851 // This may only be used when referring to a previous vector argument.
2852 return D.getArgumentNumber() >= ArgTys.size() ||
2853 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
2854 VectorType::getHalfElementsVectorType(
2855 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
2856 case IITDescriptor::SameVecWidthArgument: {
2857 if (D.getArgumentNumber() >= ArgTys.size())
2859 VectorType * ReferenceType =
2860 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
2861 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
2862 if (!ThisArgType || !ReferenceType ||
2863 (ReferenceType->getVectorNumElements() !=
2864 ThisArgType->getVectorNumElements()))
2866 return VerifyIntrinsicType(ThisArgType->getVectorElementType(),
2869 case IITDescriptor::PtrToArgument: {
2870 if (D.getArgumentNumber() >= ArgTys.size())
2872 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
2873 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
2874 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
2876 case IITDescriptor::VecOfPtrsToElt: {
2877 if (D.getArgumentNumber() >= ArgTys.size())
2879 VectorType * ReferenceType =
2880 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
2881 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
2882 if (!ThisArgVecTy || !ReferenceType ||
2883 (ReferenceType->getVectorNumElements() !=
2884 ThisArgVecTy->getVectorNumElements()))
2886 PointerType *ThisArgEltTy =
2887 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
2890 return (!(ThisArgEltTy->getElementType() ==
2891 ReferenceType->getVectorElementType()));
2894 llvm_unreachable("unhandled");
2897 /// \brief Verify if the intrinsic has variable arguments.
2898 /// This method is intended to be called after all the fixed arguments have been
2901 /// This method returns true on error and does not print an error message.
2903 Verifier::VerifyIntrinsicIsVarArg(bool isVarArg,
2904 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
2905 using namespace Intrinsic;
2907 // If there are no descriptors left, then it can't be a vararg.
2911 // There should be only one descriptor remaining at this point.
2912 if (Infos.size() != 1)
2915 // Check and verify the descriptor.
2916 IITDescriptor D = Infos.front();
2917 Infos = Infos.slice(1);
2918 if (D.Kind == IITDescriptor::VarArg)
2924 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
2926 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
2927 Function *IF = CI.getCalledFunction();
2928 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
2931 // Verify that the intrinsic prototype lines up with what the .td files
2933 FunctionType *IFTy = IF->getFunctionType();
2934 bool IsVarArg = IFTy->isVarArg();
2936 SmallVector<Intrinsic::IITDescriptor, 8> Table;
2937 getIntrinsicInfoTableEntries(ID, Table);
2938 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
2940 SmallVector<Type *, 4> ArgTys;
2941 Assert(!VerifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
2942 "Intrinsic has incorrect return type!", IF);
2943 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
2944 Assert(!VerifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
2945 "Intrinsic has incorrect argument type!", IF);
2947 // Verify if the intrinsic call matches the vararg property.
2949 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
2950 "Intrinsic was not defined with variable arguments!", IF);
2952 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
2953 "Callsite was not defined with variable arguments!", IF);
2955 // All descriptors should be absorbed by now.
2956 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
2958 // Now that we have the intrinsic ID and the actual argument types (and we
2959 // know they are legal for the intrinsic!) get the intrinsic name through the
2960 // usual means. This allows us to verify the mangling of argument types into
2962 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
2963 Assert(ExpectedName == IF->getName(),
2964 "Intrinsic name not mangled correctly for type arguments! "
2969 // If the intrinsic takes MDNode arguments, verify that they are either global
2970 // or are local to *this* function.
2971 for (unsigned i = 0, e = CI.getNumArgOperands(); i != e; ++i)
2972 if (auto *MD = dyn_cast<MetadataAsValue>(CI.getArgOperand(i)))
2973 visitMetadataAsValue(*MD, CI.getParent()->getParent());
2978 case Intrinsic::ctlz: // llvm.ctlz
2979 case Intrinsic::cttz: // llvm.cttz
2980 Assert(isa<ConstantInt>(CI.getArgOperand(1)),
2981 "is_zero_undef argument of bit counting intrinsics must be a "
2985 case Intrinsic::dbg_declare: // llvm.dbg.declare
2986 Assert(isa<MetadataAsValue>(CI.getArgOperand(0)),
2987 "invalid llvm.dbg.declare intrinsic call 1", &CI);
2988 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(CI));
2990 case Intrinsic::dbg_value: // llvm.dbg.value
2991 visitDbgIntrinsic("value", cast<DbgValueInst>(CI));
2993 case Intrinsic::memcpy:
2994 case Intrinsic::memmove:
2995 case Intrinsic::memset: {
2996 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CI.getArgOperand(3));
2998 "alignment argument of memory intrinsics must be a constant int",
3000 const APInt &AlignVal = AlignCI->getValue();
3001 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
3002 "alignment argument of memory intrinsics must be a power of 2", &CI);
3003 Assert(isa<ConstantInt>(CI.getArgOperand(4)),
3004 "isvolatile argument of memory intrinsics must be a constant int",
3008 case Intrinsic::gcroot:
3009 case Intrinsic::gcwrite:
3010 case Intrinsic::gcread:
3011 if (ID == Intrinsic::gcroot) {
3013 dyn_cast<AllocaInst>(CI.getArgOperand(0)->stripPointerCasts());
3014 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", &CI);
3015 Assert(isa<Constant>(CI.getArgOperand(1)),
3016 "llvm.gcroot parameter #2 must be a constant.", &CI);
3017 if (!AI->getType()->getElementType()->isPointerTy()) {
3018 Assert(!isa<ConstantPointerNull>(CI.getArgOperand(1)),
3019 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3020 "or argument #2 must be a non-null constant.",
3025 Assert(CI.getParent()->getParent()->hasGC(),
3026 "Enclosing function does not use GC.", &CI);
3028 case Intrinsic::init_trampoline:
3029 Assert(isa<Function>(CI.getArgOperand(1)->stripPointerCasts()),
3030 "llvm.init_trampoline parameter #2 must resolve to a function.",
3033 case Intrinsic::prefetch:
3034 Assert(isa<ConstantInt>(CI.getArgOperand(1)) &&
3035 isa<ConstantInt>(CI.getArgOperand(2)) &&
3036 cast<ConstantInt>(CI.getArgOperand(1))->getZExtValue() < 2 &&
3037 cast<ConstantInt>(CI.getArgOperand(2))->getZExtValue() < 4,
3038 "invalid arguments to llvm.prefetch", &CI);
3040 case Intrinsic::stackprotector:
3041 Assert(isa<AllocaInst>(CI.getArgOperand(1)->stripPointerCasts()),
3042 "llvm.stackprotector parameter #2 must resolve to an alloca.", &CI);
3044 case Intrinsic::lifetime_start:
3045 case Intrinsic::lifetime_end:
3046 case Intrinsic::invariant_start:
3047 Assert(isa<ConstantInt>(CI.getArgOperand(0)),
3048 "size argument of memory use markers must be a constant integer",
3051 case Intrinsic::invariant_end:
3052 Assert(isa<ConstantInt>(CI.getArgOperand(1)),
3053 "llvm.invariant.end parameter #2 must be a constant integer", &CI);
3056 case Intrinsic::frameescape: {
3057 BasicBlock *BB = CI.getParent();
3058 Assert(BB == &BB->getParent()->front(),
3059 "llvm.frameescape used outside of entry block", &CI);
3060 Assert(!SawFrameEscape,
3061 "multiple calls to llvm.frameescape in one function", &CI);
3062 for (Value *Arg : CI.arg_operands()) {
3063 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
3064 Assert(AI && AI->isStaticAlloca(),
3065 "llvm.frameescape only accepts static allocas", &CI);
3067 FrameEscapeInfo[BB->getParent()].first = CI.getNumArgOperands();
3068 SawFrameEscape = true;
3071 case Intrinsic::framerecover: {
3072 Value *FnArg = CI.getArgOperand(0)->stripPointerCasts();
3073 Function *Fn = dyn_cast<Function>(FnArg);
3074 Assert(Fn && !Fn->isDeclaration(),
3075 "llvm.framerecover first "
3076 "argument must be function defined in this module",
3078 auto *IdxArg = dyn_cast<ConstantInt>(CI.getArgOperand(2));
3079 Assert(IdxArg, "idx argument of llvm.framerecover must be a constant int",
3081 auto &Entry = FrameEscapeInfo[Fn];
3082 Entry.second = unsigned(
3083 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
3087 case Intrinsic::eh_parentframe: {
3088 auto *AI = dyn_cast<AllocaInst>(CI.getArgOperand(0)->stripPointerCasts());
3089 Assert(AI && AI->isStaticAlloca(),
3090 "llvm.eh.parentframe requires a static alloca", &CI);
3094 case Intrinsic::eh_unwindhelp: {
3095 auto *AI = dyn_cast<AllocaInst>(CI.getArgOperand(0)->stripPointerCasts());
3096 Assert(AI && AI->isStaticAlloca(),
3097 "llvm.eh.unwindhelp requires a static alloca", &CI);
3101 case Intrinsic::experimental_gc_statepoint:
3102 Assert(!CI.isInlineAsm(),
3103 "gc.statepoint support for inline assembly unimplemented", &CI);
3104 Assert(CI.getParent()->getParent()->hasGC(),
3105 "Enclosing function does not use GC.", &CI);
3107 VerifyStatepoint(ImmutableCallSite(&CI));
3109 case Intrinsic::experimental_gc_result_int:
3110 case Intrinsic::experimental_gc_result_float:
3111 case Intrinsic::experimental_gc_result_ptr:
3112 case Intrinsic::experimental_gc_result: {
3113 Assert(CI.getParent()->getParent()->hasGC(),
3114 "Enclosing function does not use GC.", &CI);
3115 // Are we tied to a statepoint properly?
3116 CallSite StatepointCS(CI.getArgOperand(0));
3117 const Function *StatepointFn =
3118 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
3119 Assert(StatepointFn && StatepointFn->isDeclaration() &&
3120 StatepointFn->getIntrinsicID() ==
3121 Intrinsic::experimental_gc_statepoint,
3122 "gc.result operand #1 must be from a statepoint", &CI,
3123 CI.getArgOperand(0));
3125 // Assert that result type matches wrapped callee.
3126 const Value *Target = StatepointCS.getArgument(0);
3127 const PointerType *PT = cast<PointerType>(Target->getType());
3128 const FunctionType *TargetFuncType =
3129 cast<FunctionType>(PT->getElementType());
3130 Assert(CI.getType() == TargetFuncType->getReturnType(),
3131 "gc.result result type does not match wrapped callee", &CI);
3134 case Intrinsic::experimental_gc_relocate: {
3135 Assert(CI.getNumArgOperands() == 3, "wrong number of arguments", &CI);
3137 // Check that this relocate is correctly tied to the statepoint
3139 // This is case for relocate on the unwinding path of an invoke statepoint
3140 if (ExtractValueInst *ExtractValue =
3141 dyn_cast<ExtractValueInst>(CI.getArgOperand(0))) {
3142 Assert(isa<LandingPadInst>(ExtractValue->getAggregateOperand()),
3143 "gc relocate on unwind path incorrectly linked to the statepoint",
3146 const BasicBlock *invokeBB =
3147 ExtractValue->getParent()->getUniquePredecessor();
3149 // Landingpad relocates should have only one predecessor with invoke
3150 // statepoint terminator
3151 Assert(invokeBB, "safepoints should have unique landingpads",
3152 ExtractValue->getParent());
3153 Assert(invokeBB->getTerminator(), "safepoint block should be well formed",
3155 Assert(isStatepoint(invokeBB->getTerminator()),
3156 "gc relocate should be linked to a statepoint", invokeBB);
3159 // In all other cases relocate should be tied to the statepoint directly.
3160 // This covers relocates on a normal return path of invoke statepoint and
3161 // relocates of a call statepoint
3162 auto Token = CI.getArgOperand(0);
3163 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
3164 "gc relocate is incorrectly tied to the statepoint", &CI, Token);
3167 // Verify rest of the relocate arguments
3169 GCRelocateOperands ops(&CI);
3170 ImmutableCallSite StatepointCS(ops.statepoint());
3172 // Both the base and derived must be piped through the safepoint
3173 Value* Base = CI.getArgOperand(1);
3174 Assert(isa<ConstantInt>(Base),
3175 "gc.relocate operand #2 must be integer offset", &CI);
3177 Value* Derived = CI.getArgOperand(2);
3178 Assert(isa<ConstantInt>(Derived),
3179 "gc.relocate operand #3 must be integer offset", &CI);
3181 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
3182 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
3184 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
3185 "gc.relocate: statepoint base index out of bounds", &CI);
3186 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
3187 "gc.relocate: statepoint derived index out of bounds", &CI);
3189 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
3190 // section of the statepoint's argument
3191 Assert(StatepointCS.arg_size() > 0,
3192 "gc.statepoint: insufficient arguments");
3193 Assert(isa<ConstantInt>(StatepointCS.getArgument(1)),
3194 "gc.statement: number of call arguments must be constant integer");
3195 const unsigned NumCallArgs =
3196 cast<ConstantInt>(StatepointCS.getArgument(1))->getZExtValue();
3197 Assert(StatepointCS.arg_size() > NumCallArgs+3,
3198 "gc.statepoint: mismatch in number of call arguments");
3199 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs+3)),
3200 "gc.statepoint: number of deoptimization arguments must be "
3201 "a constant integer");
3202 const int NumDeoptArgs =
3203 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 3))->getZExtValue();
3204 const int GCParamArgsStart = NumCallArgs + NumDeoptArgs + 4;
3205 const int GCParamArgsEnd = StatepointCS.arg_size();
3206 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
3207 "gc.relocate: statepoint base index doesn't fall within the "
3208 "'gc parameters' section of the statepoint call",
3210 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
3211 "gc.relocate: statepoint derived index doesn't fall within the "
3212 "'gc parameters' section of the statepoint call",
3215 // Assert that the result type matches the type of the relocated pointer
3216 GCRelocateOperands Operands(&CI);
3217 Assert(Operands.derivedPtr()->getType() == CI.getType(),
3218 "gc.relocate: relocating a pointer shouldn't change its type", &CI);
3224 template <class DbgIntrinsicTy>
3225 void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
3226 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
3227 Assert(isa<ValueAsMetadata>(MD) ||
3228 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
3229 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
3230 Assert(isa<MDLocalVariable>(DII.getRawVariable()),
3231 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
3232 DII.getRawVariable());
3233 Assert(isa<MDExpression>(DII.getRawExpression()),
3234 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
3235 DII.getRawExpression());
3238 void Verifier::verifyDebugInfo() {
3239 // Run the debug info verifier only if the regular verifier succeeds, since
3240 // sometimes checks that have already failed will cause crashes here.
3241 if (EverBroken || !VerifyDebugInfo)
3244 DebugInfoFinder Finder;
3245 Finder.processModule(*M);
3246 processInstructions(Finder);
3248 // Verify Debug Info.
3250 // NOTE: The loud braces are necessary for MSVC compatibility.
3251 for (DICompileUnit CU : Finder.compile_units()) {
3252 Assert(CU.Verify(), "DICompileUnit does not Verify!", CU);
3254 for (DISubprogram S : Finder.subprograms()) {
3255 Assert(S.Verify(), "DISubprogram does not Verify!", S);
3257 for (DIGlobalVariable GV : Finder.global_variables()) {
3258 Assert(GV.Verify(), "DIGlobalVariable does not Verify!", GV);
3260 for (DIType T : Finder.types()) {
3261 Assert(T.Verify(), "DIType does not Verify!", T);
3263 for (DIScope S : Finder.scopes()) {
3264 Assert(S.Verify(), "DIScope does not Verify!", S);
3268 void Verifier::processInstructions(DebugInfoFinder &Finder) {
3269 for (const Function &F : *M)
3270 for (auto I = inst_begin(&F), E = inst_end(&F); I != E; ++I) {
3271 if (MDNode *MD = I->getMetadata(LLVMContext::MD_dbg))
3272 Finder.processLocation(*M, DILocation(MD));
3273 if (const CallInst *CI = dyn_cast<CallInst>(&*I))
3274 processCallInst(Finder, *CI);
3278 void Verifier::processCallInst(DebugInfoFinder &Finder, const CallInst &CI) {
3279 if (Function *F = CI.getCalledFunction())
3280 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
3282 case Intrinsic::dbg_declare:
3283 Finder.processDeclare(*M, cast<DbgDeclareInst>(&CI));
3285 case Intrinsic::dbg_value:
3286 Finder.processValue(*M, cast<DbgValueInst>(&CI));
3293 //===----------------------------------------------------------------------===//
3294 // Implement the public interfaces to this file...
3295 //===----------------------------------------------------------------------===//
3297 bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
3298 Function &F = const_cast<Function &>(f);
3299 assert(!F.isDeclaration() && "Cannot verify external functions");
3301 raw_null_ostream NullStr;
3302 Verifier V(OS ? *OS : NullStr);
3304 // Note that this function's return value is inverted from what you would
3305 // expect of a function called "verify".
3306 return !V.verify(F);
3309 bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
3310 raw_null_ostream NullStr;
3311 Verifier V(OS ? *OS : NullStr);
3313 bool Broken = false;
3314 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
3315 if (!I->isDeclaration() && !I->isMaterializable())
3316 Broken |= !V.verify(*I);
3318 // Note that this function's return value is inverted from what you would
3319 // expect of a function called "verify".
3320 return !V.verify(M) || Broken;
3324 struct VerifierLegacyPass : public FunctionPass {
3330 VerifierLegacyPass() : FunctionPass(ID), V(dbgs()), FatalErrors(true) {
3331 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3333 explicit VerifierLegacyPass(bool FatalErrors)
3334 : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
3335 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3338 bool runOnFunction(Function &F) override {
3339 if (!V.verify(F) && FatalErrors)
3340 report_fatal_error("Broken function found, compilation aborted!");
3345 bool doFinalization(Module &M) override {
3346 if (!V.verify(M) && FatalErrors)
3347 report_fatal_error("Broken module found, compilation aborted!");
3352 void getAnalysisUsage(AnalysisUsage &AU) const override {
3353 AU.setPreservesAll();
3358 char VerifierLegacyPass::ID = 0;
3359 INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
3361 FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
3362 return new VerifierLegacyPass(FatalErrors);
3365 PreservedAnalyses VerifierPass::run(Module &M) {
3366 if (verifyModule(M, &dbgs()) && FatalErrors)
3367 report_fatal_error("Broken module found, compilation aborted!");
3369 return PreservedAnalyses::all();
3372 PreservedAnalyses VerifierPass::run(Function &F) {
3373 if (verifyFunction(F, &dbgs()) && FatalErrors)
3374 report_fatal_error("Broken function found, compilation aborted!");
3376 return PreservedAnalyses::all();