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);
305 void visitMDLexicalBlockBase(const MDLexicalBlockBase &N);
307 // InstVisitor overrides...
308 using InstVisitor<Verifier>::visit;
309 void visit(Instruction &I);
311 void visitTruncInst(TruncInst &I);
312 void visitZExtInst(ZExtInst &I);
313 void visitSExtInst(SExtInst &I);
314 void visitFPTruncInst(FPTruncInst &I);
315 void visitFPExtInst(FPExtInst &I);
316 void visitFPToUIInst(FPToUIInst &I);
317 void visitFPToSIInst(FPToSIInst &I);
318 void visitUIToFPInst(UIToFPInst &I);
319 void visitSIToFPInst(SIToFPInst &I);
320 void visitIntToPtrInst(IntToPtrInst &I);
321 void visitPtrToIntInst(PtrToIntInst &I);
322 void visitBitCastInst(BitCastInst &I);
323 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
324 void visitPHINode(PHINode &PN);
325 void visitBinaryOperator(BinaryOperator &B);
326 void visitICmpInst(ICmpInst &IC);
327 void visitFCmpInst(FCmpInst &FC);
328 void visitExtractElementInst(ExtractElementInst &EI);
329 void visitInsertElementInst(InsertElementInst &EI);
330 void visitShuffleVectorInst(ShuffleVectorInst &EI);
331 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
332 void visitCallInst(CallInst &CI);
333 void visitInvokeInst(InvokeInst &II);
334 void visitGetElementPtrInst(GetElementPtrInst &GEP);
335 void visitLoadInst(LoadInst &LI);
336 void visitStoreInst(StoreInst &SI);
337 void verifyDominatesUse(Instruction &I, unsigned i);
338 void visitInstruction(Instruction &I);
339 void visitTerminatorInst(TerminatorInst &I);
340 void visitBranchInst(BranchInst &BI);
341 void visitReturnInst(ReturnInst &RI);
342 void visitSwitchInst(SwitchInst &SI);
343 void visitIndirectBrInst(IndirectBrInst &BI);
344 void visitSelectInst(SelectInst &SI);
345 void visitUserOp1(Instruction &I);
346 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
347 void visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI);
348 template <class DbgIntrinsicTy>
349 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
350 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
351 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
352 void visitFenceInst(FenceInst &FI);
353 void visitAllocaInst(AllocaInst &AI);
354 void visitExtractValueInst(ExtractValueInst &EVI);
355 void visitInsertValueInst(InsertValueInst &IVI);
356 void visitLandingPadInst(LandingPadInst &LPI);
358 void VerifyCallSite(CallSite CS);
359 void verifyMustTailCall(CallInst &CI);
360 bool PerformTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
361 unsigned ArgNo, std::string &Suffix);
362 bool VerifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
363 SmallVectorImpl<Type *> &ArgTys);
364 bool VerifyIntrinsicIsVarArg(bool isVarArg,
365 ArrayRef<Intrinsic::IITDescriptor> &Infos);
366 bool VerifyAttributeCount(AttributeSet Attrs, unsigned Params);
367 void VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
369 void VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
370 bool isReturnValue, const Value *V);
371 void VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
374 void VerifyConstantExprBitcastType(const ConstantExpr *CE);
375 void VerifyStatepoint(ImmutableCallSite CS);
376 void verifyFrameRecoverIndices();
378 // Module-level debug info verification...
379 void verifyDebugInfo();
380 void processInstructions(DebugInfoFinder &Finder);
381 void processCallInst(DebugInfoFinder &Finder, const CallInst &CI);
383 } // End anonymous namespace
385 // Assert - We know that cond should be true, if not print an error message.
386 #define Assert(C, ...) \
387 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
389 void Verifier::visit(Instruction &I) {
390 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
391 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
392 InstVisitor<Verifier>::visit(I);
396 void Verifier::visitGlobalValue(const GlobalValue &GV) {
397 Assert(!GV.isDeclaration() || GV.hasExternalLinkage() ||
398 GV.hasExternalWeakLinkage(),
399 "Global is external, but doesn't have external or weak linkage!", &GV);
401 Assert(GV.getAlignment() <= Value::MaximumAlignment,
402 "huge alignment values are unsupported", &GV);
403 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
404 "Only global variables can have appending linkage!", &GV);
406 if (GV.hasAppendingLinkage()) {
407 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
408 Assert(GVar && GVar->getType()->getElementType()->isArrayTy(),
409 "Only global arrays can have appending linkage!", GVar);
413 void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
414 if (GV.hasInitializer()) {
415 Assert(GV.getInitializer()->getType() == GV.getType()->getElementType(),
416 "Global variable initializer type does not match global "
420 // If the global has common linkage, it must have a zero initializer and
421 // cannot be constant.
422 if (GV.hasCommonLinkage()) {
423 Assert(GV.getInitializer()->isNullValue(),
424 "'common' global must have a zero initializer!", &GV);
425 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
427 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
430 Assert(GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
431 "invalid linkage type for global declaration", &GV);
434 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
435 GV.getName() == "llvm.global_dtors")) {
436 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
437 "invalid linkage for intrinsic global variable", &GV);
438 // Don't worry about emitting an error for it not being an array,
439 // visitGlobalValue will complain on appending non-array.
440 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getType()->getElementType())) {
441 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
442 PointerType *FuncPtrTy =
443 FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
444 // FIXME: Reject the 2-field form in LLVM 4.0.
446 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
447 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
448 STy->getTypeAtIndex(1) == FuncPtrTy,
449 "wrong type for intrinsic global variable", &GV);
450 if (STy->getNumElements() == 3) {
451 Type *ETy = STy->getTypeAtIndex(2);
452 Assert(ETy->isPointerTy() &&
453 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
454 "wrong type for intrinsic global variable", &GV);
459 if (GV.hasName() && (GV.getName() == "llvm.used" ||
460 GV.getName() == "llvm.compiler.used")) {
461 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
462 "invalid linkage for intrinsic global variable", &GV);
463 Type *GVType = GV.getType()->getElementType();
464 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
465 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
466 Assert(PTy, "wrong type for intrinsic global variable", &GV);
467 if (GV.hasInitializer()) {
468 const Constant *Init = GV.getInitializer();
469 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
470 Assert(InitArray, "wrong initalizer for intrinsic global variable",
472 for (unsigned i = 0, e = InitArray->getNumOperands(); i != e; ++i) {
473 Value *V = Init->getOperand(i)->stripPointerCastsNoFollowAliases();
474 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
476 "invalid llvm.used member", V);
477 Assert(V->hasName(), "members of llvm.used must be named", V);
483 Assert(!GV.hasDLLImportStorageClass() ||
484 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
485 GV.hasAvailableExternallyLinkage(),
486 "Global is marked as dllimport, but not external", &GV);
488 if (!GV.hasInitializer()) {
489 visitGlobalValue(GV);
493 // Walk any aggregate initializers looking for bitcasts between address spaces
494 SmallPtrSet<const Value *, 4> Visited;
495 SmallVector<const Value *, 4> WorkStack;
496 WorkStack.push_back(cast<Value>(GV.getInitializer()));
498 while (!WorkStack.empty()) {
499 const Value *V = WorkStack.pop_back_val();
500 if (!Visited.insert(V).second)
503 if (const User *U = dyn_cast<User>(V)) {
504 WorkStack.append(U->op_begin(), U->op_end());
507 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
508 VerifyConstantExprBitcastType(CE);
514 visitGlobalValue(GV);
517 void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
518 SmallPtrSet<const GlobalAlias*, 4> Visited;
520 visitAliaseeSubExpr(Visited, GA, C);
523 void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
524 const GlobalAlias &GA, const Constant &C) {
525 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
526 Assert(!GV->isDeclaration(), "Alias must point to a definition", &GA);
528 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
529 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
531 Assert(!GA2->mayBeOverridden(), "Alias cannot point to a weak alias",
534 // Only continue verifying subexpressions of GlobalAliases.
535 // Do not recurse into global initializers.
540 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
541 VerifyConstantExprBitcastType(CE);
543 for (const Use &U : C.operands()) {
545 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
546 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
547 else if (const auto *C2 = dyn_cast<Constant>(V))
548 visitAliaseeSubExpr(Visited, GA, *C2);
552 void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
553 Assert(!GA.getName().empty(), "Alias name cannot be empty!", &GA);
554 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
555 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
556 "weak_odr, or external linkage!",
558 const Constant *Aliasee = GA.getAliasee();
559 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
560 Assert(GA.getType() == Aliasee->getType(),
561 "Alias and aliasee types should match!", &GA);
563 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
564 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
566 visitAliaseeSubExpr(GA, *Aliasee);
568 visitGlobalValue(GA);
571 void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
572 for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i) {
573 MDNode *MD = NMD.getOperand(i);
577 if (NMD.getName() == "llvm.dbg.cu") {
578 Assert(isa<MDCompileUnit>(MD), "invalid compile unit", &NMD, MD);
585 void Verifier::visitMDNode(const MDNode &MD) {
586 // Only visit each node once. Metadata can be mutually recursive, so this
587 // avoids infinite recursion here, as well as being an optimization.
588 if (!MDNodes.insert(&MD).second)
591 switch (MD.getMetadataID()) {
593 llvm_unreachable("Invalid MDNode subclass");
594 case Metadata::MDTupleKind:
596 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
597 case Metadata::CLASS##Kind: \
598 visit##CLASS(cast<CLASS>(MD)); \
600 #include "llvm/IR/Metadata.def"
603 for (unsigned i = 0, e = MD.getNumOperands(); i != e; ++i) {
604 Metadata *Op = MD.getOperand(i);
607 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
609 if (auto *N = dyn_cast<MDNode>(Op)) {
613 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
614 visitValueAsMetadata(*V, nullptr);
619 // Check these last, so we diagnose problems in operands first.
620 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
621 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
624 void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
625 Assert(MD.getValue(), "Expected valid value", &MD);
626 Assert(!MD.getValue()->getType()->isMetadataTy(),
627 "Unexpected metadata round-trip through values", &MD, MD.getValue());
629 auto *L = dyn_cast<LocalAsMetadata>(&MD);
633 Assert(F, "function-local metadata used outside a function", L);
635 // If this was an instruction, bb, or argument, verify that it is in the
636 // function that we expect.
637 Function *ActualF = nullptr;
638 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
639 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
640 ActualF = I->getParent()->getParent();
641 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
642 ActualF = BB->getParent();
643 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
644 ActualF = A->getParent();
645 assert(ActualF && "Unimplemented function local metadata case!");
647 Assert(ActualF == F, "function-local metadata used in wrong function", L);
650 void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
651 Metadata *MD = MDV.getMetadata();
652 if (auto *N = dyn_cast<MDNode>(MD)) {
657 // Only visit each node once. Metadata can be mutually recursive, so this
658 // avoids infinite recursion here, as well as being an optimization.
659 if (!MDNodes.insert(MD).second)
662 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
663 visitValueAsMetadata(*V, F);
666 /// \brief Check if a value can be a reference to a type.
667 static bool isTypeRef(const Metadata *MD) {
670 if (auto *S = dyn_cast<MDString>(MD))
671 return !S->getString().empty();
672 return isa<MDType>(MD);
675 /// \brief Check if a value can be a ScopeRef.
676 static bool isScopeRef(const Metadata *MD) {
679 if (auto *S = dyn_cast<MDString>(MD))
680 return !S->getString().empty();
681 return isa<MDScope>(MD);
685 bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
686 for (Metadata *MD : N.operands()) {
699 bool isValidMetadataArray(const MDTuple &N) {
700 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
704 bool isValidMetadataNullArray(const MDTuple &N) {
705 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
708 void Verifier::visitMDLocation(const MDLocation &N) {
709 Assert(N.getRawScope() && isa<MDLocalScope>(N.getRawScope()),
710 "location requires a valid scope", &N, N.getRawScope());
711 if (auto *IA = N.getRawInlinedAt())
712 Assert(isa<MDLocation>(IA), "inlined-at should be a location", &N, IA);
715 void Verifier::visitGenericDebugNode(const GenericDebugNode &N) {
716 Assert(N.getTag(), "invalid tag", &N);
719 void Verifier::visitMDScope(const MDScope &N) {
720 if (auto *F = N.getRawFile())
721 Assert(isa<MDFile>(F), "invalid file", &N, F);
724 void Verifier::visitMDSubrange(const MDSubrange &N) {
725 Assert(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
726 Assert(N.getCount() >= -1, "invalid subrange count", &N);
729 void Verifier::visitMDEnumerator(const MDEnumerator &N) {
730 Assert(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
733 void Verifier::visitMDBasicType(const MDBasicType &N) {
734 Assert(N.getTag() == dwarf::DW_TAG_base_type ||
735 N.getTag() == dwarf::DW_TAG_unspecified_type,
739 void Verifier::visitMDDerivedTypeBase(const MDDerivedTypeBase &N) {
740 // Common scope checks.
743 Assert(isScopeRef(N.getScope()), "invalid scope", &N, N.getScope());
744 Assert(isTypeRef(N.getBaseType()), "invalid base type", &N, N.getBaseType());
747 void Verifier::visitMDDerivedType(const MDDerivedType &N) {
748 // Common derived type checks.
749 visitMDDerivedTypeBase(N);
751 Assert(N.getTag() == dwarf::DW_TAG_typedef ||
752 N.getTag() == dwarf::DW_TAG_pointer_type ||
753 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
754 N.getTag() == dwarf::DW_TAG_reference_type ||
755 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
756 N.getTag() == dwarf::DW_TAG_const_type ||
757 N.getTag() == dwarf::DW_TAG_volatile_type ||
758 N.getTag() == dwarf::DW_TAG_restrict_type ||
759 N.getTag() == dwarf::DW_TAG_member ||
760 N.getTag() == dwarf::DW_TAG_inheritance ||
761 N.getTag() == dwarf::DW_TAG_friend,
765 void Verifier::visitMDCompositeType(const MDCompositeType &N) {
766 // Common derived type checks.
767 visitMDDerivedTypeBase(N);
769 Assert(N.getTag() == dwarf::DW_TAG_array_type ||
770 N.getTag() == dwarf::DW_TAG_structure_type ||
771 N.getTag() == dwarf::DW_TAG_union_type ||
772 N.getTag() == dwarf::DW_TAG_enumeration_type ||
773 N.getTag() == dwarf::DW_TAG_subroutine_type ||
774 N.getTag() == dwarf::DW_TAG_class_type,
777 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
778 "invalid composite elements", &N, N.getRawElements());
779 Assert(isTypeRef(N.getRawVTableHolder()), "invalid vtable holder", &N,
780 N.getRawVTableHolder());
781 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
782 "invalid composite elements", &N, N.getRawElements());
785 void Verifier::visitMDSubroutineType(const MDSubroutineType &N) {
786 Assert(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
787 if (auto *Types = N.getRawTypeArray()) {
788 Assert(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
789 for (Metadata *Ty : N.getTypeArray()->operands()) {
790 Assert(isTypeRef(Ty), "invalid subroutine type ref", &N, Types, Ty);
795 void Verifier::visitMDFile(const MDFile &N) {
796 Assert(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
799 void Verifier::visitMDCompileUnit(const MDCompileUnit &N) {
800 Assert(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
802 if (auto *Array = N.getRawEnumTypes()) {
803 Assert(isa<MDTuple>(Array), "invalid enum list", &N, Array);
804 for (Metadata *Op : N.getEnumTypes()->operands()) {
805 auto *Enum = dyn_cast_or_null<MDCompositeType>(Op);
806 Assert(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
807 "invalid enum type", &N, N.getEnumTypes(), Op);
810 if (auto *Array = N.getRawRetainedTypes()) {
811 Assert(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
812 for (Metadata *Op : N.getRetainedTypes()->operands()) {
813 Assert(Op && isa<MDType>(Op), "invalid retained type", &N, Op);
816 if (auto *Array = N.getRawSubprograms()) {
817 Assert(isa<MDTuple>(Array), "invalid subprogram list", &N, Array);
818 for (Metadata *Op : N.getSubprograms()->operands()) {
819 Assert(Op && isa<MDSubprogram>(Op), "invalid subprogram ref", &N, Op);
822 if (auto *Array = N.getRawGlobalVariables()) {
823 Assert(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
824 for (Metadata *Op : N.getGlobalVariables()->operands()) {
825 Assert(Op && isa<MDGlobalVariable>(Op), "invalid global variable ref", &N,
829 if (auto *Array = N.getRawImportedEntities()) {
830 Assert(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
831 for (Metadata *Op : N.getImportedEntities()->operands()) {
832 Assert(Op && isa<MDImportedEntity>(Op), "invalid imported entity ref", &N,
838 void Verifier::visitMDSubprogram(const MDSubprogram &N) {
839 Assert(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
840 Assert(isScopeRef(N.getRawScope()), "invalid scope", &N, N.getRawScope());
841 if (auto *T = N.getRawType())
842 Assert(isa<MDSubroutineType>(T), "invalid subroutine type", &N, T);
843 Assert(isTypeRef(N.getRawContainingType()), "invalid containing type", &N,
844 N.getRawContainingType());
845 if (auto *RawF = N.getRawFunction()) {
846 auto *FMD = dyn_cast<ConstantAsMetadata>(RawF);
847 auto *F = FMD ? FMD->getValue() : nullptr;
848 auto *FT = F ? dyn_cast<PointerType>(F->getType()) : nullptr;
849 Assert(F && (isa<Function>(F) || isa<ConstantPointerNull>(F)) && FT &&
850 isa<FunctionType>(FT->getElementType()),
851 "invalid function", &N, F);
853 if (N.getRawTemplateParams()) {
854 auto *Params = dyn_cast<MDTuple>(N.getRawTemplateParams());
855 Assert(Params, "invalid template params", &N, Params);
856 for (Metadata *Op : Params->operands()) {
857 Assert(Op && isa<MDTemplateParameter>(Op), "invalid template parameter",
861 if (auto *S = N.getRawDeclaration()) {
862 Assert(isa<MDSubprogram>(S) && !cast<MDSubprogram>(S)->isDefinition(),
863 "invalid subprogram declaration", &N, S);
865 if (N.getRawVariables()) {
866 auto *Vars = dyn_cast<MDTuple>(N.getRawVariables());
867 Assert(Vars, "invalid variable list", &N, Vars);
868 for (Metadata *Op : Vars->operands()) {
869 Assert(Op && isa<MDLocalVariable>(Op), "invalid local variable", &N, Vars,
875 void Verifier::visitMDLexicalBlockBase(const MDLexicalBlockBase &N) {
876 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
877 Assert(N.getRawScope() && isa<MDLocalScope>(N.getRawScope()),
878 "invalid local scope", &N, N.getRawScope());
881 void Verifier::visitMDLexicalBlock(const MDLexicalBlock &N) {
882 visitMDLexicalBlockBase(N);
884 Assert(N.getLine() || !N.getColumn(),
885 "cannot have column info without line info", &N);
888 void Verifier::visitMDLexicalBlockFile(const MDLexicalBlockFile &N) {
889 visitMDLexicalBlockBase(N);
892 void Verifier::visitMDNamespace(const MDNamespace &N) {
893 Assert(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
896 void Verifier::visitMDTemplateTypeParameter(const MDTemplateTypeParameter &N) {
897 Assert(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
901 void Verifier::visitMDTemplateValueParameter(
902 const MDTemplateValueParameter &N) {
903 Assert(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
904 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
905 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
909 void Verifier::visitMDVariable(const MDVariable &N) {
910 if (auto *S = N.getRawScope())
911 Assert(isa<MDScope>(S), "invalid scope", &N, S);
912 Assert(isTypeRef(N.getRawType()), "invalid type ref", &N, N.getRawType());
913 if (auto *F = N.getRawFile())
914 Assert(isa<MDFile>(F), "invalid file", &N, F);
917 void Verifier::visitMDGlobalVariable(const MDGlobalVariable &N) {
918 // Checks common to all variables.
921 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
922 if (auto *V = N.getRawVariable()) {
923 Assert(isa<ConstantAsMetadata>(V) &&
924 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
925 "invalid global varaible ref", &N, V);
927 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
928 Assert(isa<MDDerivedType>(Member), "invalid static data member declaration",
933 void Verifier::visitMDLocalVariable(const MDLocalVariable &N) {
934 // Checks common to all variables.
937 Assert(N.getTag() == dwarf::DW_TAG_auto_variable ||
938 N.getTag() == dwarf::DW_TAG_arg_variable,
940 Assert(N.getRawScope() && isa<MDLocalScope>(N.getRawScope()),
941 "local variable requires a valid scope", &N, N.getRawScope());
942 if (auto *IA = N.getRawInlinedAt())
943 Assert(isa<MDLocation>(IA), "local variable requires a valid scope", &N,
947 void Verifier::visitMDExpression(const MDExpression &N) {
948 Assert(N.isValid(), "invalid expression", &N);
951 void Verifier::visitMDObjCProperty(const MDObjCProperty &N) {
952 Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
955 void Verifier::visitMDImportedEntity(const MDImportedEntity &N) {
956 Assert(N.getTag() == dwarf::DW_TAG_imported_module ||
957 N.getTag() == dwarf::DW_TAG_imported_declaration,
961 void Verifier::visitComdat(const Comdat &C) {
962 // The Module is invalid if the GlobalValue has private linkage. Entities
963 // with private linkage don't have entries in the symbol table.
964 if (const GlobalValue *GV = M->getNamedValue(C.getName()))
965 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
969 void Verifier::visitModuleIdents(const Module &M) {
970 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
974 // llvm.ident takes a list of metadata entry. Each entry has only one string.
975 // Scan each llvm.ident entry and make sure that this requirement is met.
976 for (unsigned i = 0, e = Idents->getNumOperands(); i != e; ++i) {
977 const MDNode *N = Idents->getOperand(i);
978 Assert(N->getNumOperands() == 1,
979 "incorrect number of operands in llvm.ident metadata", N);
980 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
981 ("invalid value for llvm.ident metadata entry operand"
982 "(the operand should be a string)"),
987 void Verifier::visitModuleFlags(const Module &M) {
988 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
991 // Scan each flag, and track the flags and requirements.
992 DenseMap<const MDString*, const MDNode*> SeenIDs;
993 SmallVector<const MDNode*, 16> Requirements;
994 for (unsigned I = 0, E = Flags->getNumOperands(); I != E; ++I) {
995 visitModuleFlag(Flags->getOperand(I), SeenIDs, Requirements);
998 // Validate that the requirements in the module are valid.
999 for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
1000 const MDNode *Requirement = Requirements[I];
1001 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
1002 const Metadata *ReqValue = Requirement->getOperand(1);
1004 const MDNode *Op = SeenIDs.lookup(Flag);
1006 CheckFailed("invalid requirement on flag, flag is not present in module",
1011 if (Op->getOperand(2) != ReqValue) {
1012 CheckFailed(("invalid requirement on flag, "
1013 "flag does not have the required value"),
1021 Verifier::visitModuleFlag(const MDNode *Op,
1022 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1023 SmallVectorImpl<const MDNode *> &Requirements) {
1024 // Each module flag should have three arguments, the merge behavior (a
1025 // constant int), the flag ID (an MDString), and the value.
1026 Assert(Op->getNumOperands() == 3,
1027 "incorrect number of operands in module flag", Op);
1028 Module::ModFlagBehavior MFB;
1029 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
1031 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
1032 "invalid behavior operand in module flag (expected constant integer)",
1035 "invalid behavior operand in module flag (unexpected constant)",
1038 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
1039 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1042 // Sanity check the values for behaviors with additional requirements.
1045 case Module::Warning:
1046 case Module::Override:
1047 // These behavior types accept any value.
1050 case Module::Require: {
1051 // The value should itself be an MDNode with two operands, a flag ID (an
1052 // MDString), and a value.
1053 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
1054 Assert(Value && Value->getNumOperands() == 2,
1055 "invalid value for 'require' module flag (expected metadata pair)",
1057 Assert(isa<MDString>(Value->getOperand(0)),
1058 ("invalid value for 'require' module flag "
1059 "(first value operand should be a string)"),
1060 Value->getOperand(0));
1062 // Append it to the list of requirements, to check once all module flags are
1064 Requirements.push_back(Value);
1068 case Module::Append:
1069 case Module::AppendUnique: {
1070 // These behavior types require the operand be an MDNode.
1071 Assert(isa<MDNode>(Op->getOperand(2)),
1072 "invalid value for 'append'-type module flag "
1073 "(expected a metadata node)",
1079 // Unless this is a "requires" flag, check the ID is unique.
1080 if (MFB != Module::Require) {
1081 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
1083 "module flag identifiers must be unique (or of 'require' type)", ID);
1087 void Verifier::VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
1088 bool isFunction, const Value *V) {
1089 unsigned Slot = ~0U;
1090 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1091 if (Attrs.getSlotIndex(I) == Idx) {
1096 assert(Slot != ~0U && "Attribute set inconsistency!");
1098 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1100 if (I->isStringAttribute())
1103 if (I->getKindAsEnum() == Attribute::NoReturn ||
1104 I->getKindAsEnum() == Attribute::NoUnwind ||
1105 I->getKindAsEnum() == Attribute::NoInline ||
1106 I->getKindAsEnum() == Attribute::AlwaysInline ||
1107 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1108 I->getKindAsEnum() == Attribute::StackProtect ||
1109 I->getKindAsEnum() == Attribute::StackProtectReq ||
1110 I->getKindAsEnum() == Attribute::StackProtectStrong ||
1111 I->getKindAsEnum() == Attribute::NoRedZone ||
1112 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1113 I->getKindAsEnum() == Attribute::Naked ||
1114 I->getKindAsEnum() == Attribute::InlineHint ||
1115 I->getKindAsEnum() == Attribute::StackAlignment ||
1116 I->getKindAsEnum() == Attribute::UWTable ||
1117 I->getKindAsEnum() == Attribute::NonLazyBind ||
1118 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1119 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1120 I->getKindAsEnum() == Attribute::SanitizeThread ||
1121 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1122 I->getKindAsEnum() == Attribute::MinSize ||
1123 I->getKindAsEnum() == Attribute::NoDuplicate ||
1124 I->getKindAsEnum() == Attribute::Builtin ||
1125 I->getKindAsEnum() == Attribute::NoBuiltin ||
1126 I->getKindAsEnum() == Attribute::Cold ||
1127 I->getKindAsEnum() == Attribute::OptimizeNone ||
1128 I->getKindAsEnum() == Attribute::JumpTable) {
1130 CheckFailed("Attribute '" + I->getAsString() +
1131 "' only applies to functions!", V);
1134 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
1135 I->getKindAsEnum() == Attribute::ReadNone) {
1137 CheckFailed("Attribute '" + I->getAsString() +
1138 "' does not apply to function returns");
1141 } else if (isFunction) {
1142 CheckFailed("Attribute '" + I->getAsString() +
1143 "' does not apply to functions!", V);
1149 // VerifyParameterAttrs - Check the given attributes for an argument or return
1150 // value of the specified type. The value V is printed in error messages.
1151 void Verifier::VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
1152 bool isReturnValue, const Value *V) {
1153 if (!Attrs.hasAttributes(Idx))
1156 VerifyAttributeTypes(Attrs, Idx, false, V);
1159 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1160 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1161 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1162 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1163 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
1164 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1165 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', and "
1166 "'returned' do not apply to return values!",
1169 // Check for mutually incompatible attributes. Only inreg is compatible with
1171 unsigned AttrCount = 0;
1172 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1173 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1174 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1175 Attrs.hasAttribute(Idx, Attribute::InReg);
1176 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
1177 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1178 "and 'sret' are incompatible!",
1181 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1182 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1184 "'inalloca and readonly' are incompatible!",
1187 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1188 Attrs.hasAttribute(Idx, Attribute::Returned)),
1190 "'sret and returned' are incompatible!",
1193 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1194 Attrs.hasAttribute(Idx, Attribute::SExt)),
1196 "'zeroext and signext' are incompatible!",
1199 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1200 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1202 "'readnone and readonly' are incompatible!",
1205 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1206 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1208 "'noinline and alwaysinline' are incompatible!",
1211 Assert(!AttrBuilder(Attrs, Idx)
1212 .hasAttributes(AttributeFuncs::typeIncompatible(Ty, Idx), Idx),
1213 "Wrong types for attribute: " +
1214 AttributeFuncs::typeIncompatible(Ty, Idx).getAsString(Idx),
1217 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
1218 SmallPtrSet<const Type*, 4> Visited;
1219 if (!PTy->getElementType()->isSized(&Visited)) {
1220 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1221 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1222 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1226 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1227 "Attribute 'byval' only applies to parameters with pointer type!",
1232 // VerifyFunctionAttrs - Check parameter attributes against a function type.
1233 // The value V is printed in error messages.
1234 void Verifier::VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
1236 if (Attrs.isEmpty())
1239 bool SawNest = false;
1240 bool SawReturned = false;
1241 bool SawSRet = false;
1243 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
1244 unsigned Idx = Attrs.getSlotIndex(i);
1248 Ty = FT->getReturnType();
1249 else if (Idx-1 < FT->getNumParams())
1250 Ty = FT->getParamType(Idx-1);
1252 break; // VarArgs attributes, verified elsewhere.
1254 VerifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
1259 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
1260 Assert(!SawNest, "More than one parameter has attribute nest!", V);
1264 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
1265 Assert(!SawReturned, "More than one parameter has attribute returned!",
1267 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1269 "argument and return types for 'returned' attribute",
1274 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
1275 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1276 Assert(Idx == 1 || Idx == 2,
1277 "Attribute 'sret' is not on first or second parameter!", V);
1281 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
1282 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1287 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1290 VerifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
1293 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1294 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1295 "Attributes 'readnone and readonly' are incompatible!", V);
1298 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1299 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1300 Attribute::AlwaysInline)),
1301 "Attributes 'noinline and alwaysinline' are incompatible!", V);
1303 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1304 Attribute::OptimizeNone)) {
1305 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1306 "Attribute 'optnone' requires 'noinline'!", V);
1308 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1309 Attribute::OptimizeForSize),
1310 "Attributes 'optsize and optnone' are incompatible!", V);
1312 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1313 "Attributes 'minsize and optnone' are incompatible!", V);
1316 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1317 Attribute::JumpTable)) {
1318 const GlobalValue *GV = cast<GlobalValue>(V);
1319 Assert(GV->hasUnnamedAddr(),
1320 "Attribute 'jumptable' requires 'unnamed_addr'", V);
1324 void Verifier::VerifyConstantExprBitcastType(const ConstantExpr *CE) {
1325 if (CE->getOpcode() != Instruction::BitCast)
1328 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1330 "Invalid bitcast", CE);
1333 bool Verifier::VerifyAttributeCount(AttributeSet Attrs, unsigned Params) {
1334 if (Attrs.getNumSlots() == 0)
1337 unsigned LastSlot = Attrs.getNumSlots() - 1;
1338 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
1339 if (LastIndex <= Params
1340 || (LastIndex == AttributeSet::FunctionIndex
1341 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
1347 /// \brief Verify that statepoint intrinsic is well formed.
1348 void Verifier::VerifyStatepoint(ImmutableCallSite CS) {
1349 assert(CS.getCalledFunction() &&
1350 CS.getCalledFunction()->getIntrinsicID() ==
1351 Intrinsic::experimental_gc_statepoint);
1353 const Instruction &CI = *CS.getInstruction();
1355 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory(),
1356 "gc.statepoint must read and write memory to preserve "
1357 "reordering restrictions required by safepoint semantics",
1360 const Value *Target = CS.getArgument(0);
1361 const PointerType *PT = dyn_cast<PointerType>(Target->getType());
1362 Assert(PT && PT->getElementType()->isFunctionTy(),
1363 "gc.statepoint callee must be of function pointer type", &CI, Target);
1364 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
1366 const Value *NumCallArgsV = CS.getArgument(1);
1367 Assert(isa<ConstantInt>(NumCallArgsV),
1368 "gc.statepoint number of arguments to underlying call "
1369 "must be constant integer",
1371 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
1372 Assert(NumCallArgs >= 0,
1373 "gc.statepoint number of arguments to underlying call "
1376 const int NumParams = (int)TargetFuncType->getNumParams();
1377 if (TargetFuncType->isVarArg()) {
1378 Assert(NumCallArgs >= NumParams,
1379 "gc.statepoint mismatch in number of vararg call args", &CI);
1381 // TODO: Remove this limitation
1382 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1383 "gc.statepoint doesn't support wrapping non-void "
1384 "vararg functions yet",
1387 Assert(NumCallArgs == NumParams,
1388 "gc.statepoint mismatch in number of call args", &CI);
1390 const Value *Unused = CS.getArgument(2);
1391 Assert(isa<ConstantInt>(Unused) && cast<ConstantInt>(Unused)->isNullValue(),
1392 "gc.statepoint parameter #3 must be zero", &CI);
1394 // Verify that the types of the call parameter arguments match
1395 // the type of the wrapped callee.
1396 for (int i = 0; i < NumParams; i++) {
1397 Type *ParamType = TargetFuncType->getParamType(i);
1398 Type *ArgType = CS.getArgument(3+i)->getType();
1399 Assert(ArgType == ParamType,
1400 "gc.statepoint call argument does not match wrapped "
1404 const int EndCallArgsInx = 2+NumCallArgs;
1405 const Value *NumDeoptArgsV = CS.getArgument(EndCallArgsInx+1);
1406 Assert(isa<ConstantInt>(NumDeoptArgsV),
1407 "gc.statepoint number of deoptimization arguments "
1408 "must be constant integer",
1410 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
1411 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1415 Assert(4 + NumCallArgs + NumDeoptArgs <= (int)CS.arg_size(),
1416 "gc.statepoint too few arguments according to length fields", &CI);
1418 // Check that the only uses of this gc.statepoint are gc.result or
1419 // gc.relocate calls which are tied to this statepoint and thus part
1420 // of the same statepoint sequence
1421 for (const User *U : CI.users()) {
1422 const CallInst *Call = dyn_cast<const CallInst>(U);
1423 Assert(Call, "illegal use of statepoint token", &CI, U);
1424 if (!Call) continue;
1425 Assert(isGCRelocate(Call) || isGCResult(Call),
1426 "gc.result or gc.relocate are the only value uses"
1427 "of a gc.statepoint",
1429 if (isGCResult(Call)) {
1430 Assert(Call->getArgOperand(0) == &CI,
1431 "gc.result connected to wrong gc.statepoint", &CI, Call);
1432 } else if (isGCRelocate(Call)) {
1433 Assert(Call->getArgOperand(0) == &CI,
1434 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
1438 // Note: It is legal for a single derived pointer to be listed multiple
1439 // times. It's non-optimal, but it is legal. It can also happen after
1440 // insertion if we strip a bitcast away.
1441 // Note: It is really tempting to check that each base is relocated and
1442 // that a derived pointer is never reused as a base pointer. This turns
1443 // out to be problematic since optimizations run after safepoint insertion
1444 // can recognize equality properties that the insertion logic doesn't know
1445 // about. See example statepoint.ll in the verifier subdirectory
1448 void Verifier::verifyFrameRecoverIndices() {
1449 for (auto &Counts : FrameEscapeInfo) {
1450 Function *F = Counts.first;
1451 unsigned EscapedObjectCount = Counts.second.first;
1452 unsigned MaxRecoveredIndex = Counts.second.second;
1453 Assert(MaxRecoveredIndex <= EscapedObjectCount,
1454 "all indices passed to llvm.framerecover must be less than the "
1455 "number of arguments passed ot llvm.frameescape in the parent "
1461 // visitFunction - Verify that a function is ok.
1463 void Verifier::visitFunction(const Function &F) {
1464 // Check function arguments.
1465 FunctionType *FT = F.getFunctionType();
1466 unsigned NumArgs = F.arg_size();
1468 Assert(Context == &F.getContext(),
1469 "Function context does not match Module context!", &F);
1471 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1472 Assert(FT->getNumParams() == NumArgs,
1473 "# formal arguments must match # of arguments for function type!", &F,
1475 Assert(F.getReturnType()->isFirstClassType() ||
1476 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1477 "Functions cannot return aggregate values!", &F);
1479 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1480 "Invalid struct return type!", &F);
1482 AttributeSet Attrs = F.getAttributes();
1484 Assert(VerifyAttributeCount(Attrs, FT->getNumParams()),
1485 "Attribute after last parameter!", &F);
1487 // Check function attributes.
1488 VerifyFunctionAttrs(FT, Attrs, &F);
1490 // On function declarations/definitions, we do not support the builtin
1491 // attribute. We do not check this in VerifyFunctionAttrs since that is
1492 // checking for Attributes that can/can not ever be on functions.
1493 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1494 "Attribute 'builtin' can only be applied to a callsite.", &F);
1496 // Check that this function meets the restrictions on this calling convention.
1497 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1498 // restrictions can be lifted.
1499 switch (F.getCallingConv()) {
1501 case CallingConv::C:
1503 case CallingConv::Fast:
1504 case CallingConv::Cold:
1505 case CallingConv::Intel_OCL_BI:
1506 case CallingConv::PTX_Kernel:
1507 case CallingConv::PTX_Device:
1508 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1509 "perfect forwarding!",
1514 bool isLLVMdotName = F.getName().size() >= 5 &&
1515 F.getName().substr(0, 5) == "llvm.";
1517 // Check that the argument values match the function type for this function...
1519 for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E;
1521 Assert(I->getType() == FT->getParamType(i),
1522 "Argument value does not match function argument type!", I,
1523 FT->getParamType(i));
1524 Assert(I->getType()->isFirstClassType(),
1525 "Function arguments must have first-class types!", I);
1527 Assert(!I->getType()->isMetadataTy(),
1528 "Function takes metadata but isn't an intrinsic", I, &F);
1531 if (F.isMaterializable()) {
1532 // Function has a body somewhere we can't see.
1533 } else if (F.isDeclaration()) {
1534 Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1535 "invalid linkage type for function declaration", &F);
1537 // Verify that this function (which has a body) is not named "llvm.*". It
1538 // is not legal to define intrinsics.
1539 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
1541 // Check the entry node
1542 const BasicBlock *Entry = &F.getEntryBlock();
1543 Assert(pred_empty(Entry),
1544 "Entry block to function must not have predecessors!", Entry);
1546 // The address of the entry block cannot be taken, unless it is dead.
1547 if (Entry->hasAddressTaken()) {
1548 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1549 "blockaddress may not be used with the entry block!", Entry);
1553 // If this function is actually an intrinsic, verify that it is only used in
1554 // direct call/invokes, never having its "address taken".
1555 if (F.getIntrinsicID()) {
1557 if (F.hasAddressTaken(&U))
1558 Assert(0, "Invalid user of intrinsic instruction!", U);
1561 Assert(!F.hasDLLImportStorageClass() ||
1562 (F.isDeclaration() && F.hasExternalLinkage()) ||
1563 F.hasAvailableExternallyLinkage(),
1564 "Function is marked as dllimport, but not external.", &F);
1567 // verifyBasicBlock - Verify that a basic block is well formed...
1569 void Verifier::visitBasicBlock(BasicBlock &BB) {
1570 InstsInThisBlock.clear();
1572 // Ensure that basic blocks have terminators!
1573 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
1575 // Check constraints that this basic block imposes on all of the PHI nodes in
1577 if (isa<PHINode>(BB.front())) {
1578 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
1579 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
1580 std::sort(Preds.begin(), Preds.end());
1582 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
1583 // Ensure that PHI nodes have at least one entry!
1584 Assert(PN->getNumIncomingValues() != 0,
1585 "PHI nodes must have at least one entry. If the block is dead, "
1586 "the PHI should be removed!",
1588 Assert(PN->getNumIncomingValues() == Preds.size(),
1589 "PHINode should have one entry for each predecessor of its "
1590 "parent basic block!",
1593 // Get and sort all incoming values in the PHI node...
1595 Values.reserve(PN->getNumIncomingValues());
1596 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1597 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
1598 PN->getIncomingValue(i)));
1599 std::sort(Values.begin(), Values.end());
1601 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
1602 // Check to make sure that if there is more than one entry for a
1603 // particular basic block in this PHI node, that the incoming values are
1606 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
1607 Values[i].second == Values[i - 1].second,
1608 "PHI node has multiple entries for the same basic block with "
1609 "different incoming values!",
1610 PN, Values[i].first, Values[i].second, Values[i - 1].second);
1612 // Check to make sure that the predecessors and PHI node entries are
1614 Assert(Values[i].first == Preds[i],
1615 "PHI node entries do not match predecessors!", PN,
1616 Values[i].first, Preds[i]);
1621 // Check that all instructions have their parent pointers set up correctly.
1624 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
1628 void Verifier::visitTerminatorInst(TerminatorInst &I) {
1629 // Ensure that terminators only exist at the end of the basic block.
1630 Assert(&I == I.getParent()->getTerminator(),
1631 "Terminator found in the middle of a basic block!", I.getParent());
1632 visitInstruction(I);
1635 void Verifier::visitBranchInst(BranchInst &BI) {
1636 if (BI.isConditional()) {
1637 Assert(BI.getCondition()->getType()->isIntegerTy(1),
1638 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
1640 visitTerminatorInst(BI);
1643 void Verifier::visitReturnInst(ReturnInst &RI) {
1644 Function *F = RI.getParent()->getParent();
1645 unsigned N = RI.getNumOperands();
1646 if (F->getReturnType()->isVoidTy())
1648 "Found return instr that returns non-void in Function of void "
1650 &RI, F->getReturnType());
1652 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
1653 "Function return type does not match operand "
1654 "type of return inst!",
1655 &RI, F->getReturnType());
1657 // Check to make sure that the return value has necessary properties for
1659 visitTerminatorInst(RI);
1662 void Verifier::visitSwitchInst(SwitchInst &SI) {
1663 // Check to make sure that all of the constants in the switch instruction
1664 // have the same type as the switched-on value.
1665 Type *SwitchTy = SI.getCondition()->getType();
1666 SmallPtrSet<ConstantInt*, 32> Constants;
1667 for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end(); i != e; ++i) {
1668 Assert(i.getCaseValue()->getType() == SwitchTy,
1669 "Switch constants must all be same type as switch value!", &SI);
1670 Assert(Constants.insert(i.getCaseValue()).second,
1671 "Duplicate integer as switch case", &SI, i.getCaseValue());
1674 visitTerminatorInst(SI);
1677 void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
1678 Assert(BI.getAddress()->getType()->isPointerTy(),
1679 "Indirectbr operand must have pointer type!", &BI);
1680 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
1681 Assert(BI.getDestination(i)->getType()->isLabelTy(),
1682 "Indirectbr destinations must all have pointer type!", &BI);
1684 visitTerminatorInst(BI);
1687 void Verifier::visitSelectInst(SelectInst &SI) {
1688 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
1690 "Invalid operands for select instruction!", &SI);
1692 Assert(SI.getTrueValue()->getType() == SI.getType(),
1693 "Select values must have same type as select instruction!", &SI);
1694 visitInstruction(SI);
1697 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
1698 /// a pass, if any exist, it's an error.
1700 void Verifier::visitUserOp1(Instruction &I) {
1701 Assert(0, "User-defined operators should not live outside of a pass!", &I);
1704 void Verifier::visitTruncInst(TruncInst &I) {
1705 // Get the source and destination types
1706 Type *SrcTy = I.getOperand(0)->getType();
1707 Type *DestTy = I.getType();
1709 // Get the size of the types in bits, we'll need this later
1710 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1711 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1713 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
1714 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
1715 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1716 "trunc source and destination must both be a vector or neither", &I);
1717 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
1719 visitInstruction(I);
1722 void Verifier::visitZExtInst(ZExtInst &I) {
1723 // Get the source and destination types
1724 Type *SrcTy = I.getOperand(0)->getType();
1725 Type *DestTy = I.getType();
1727 // Get the size of the types in bits, we'll need this later
1728 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
1729 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
1730 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1731 "zext source and destination must both be a vector or neither", &I);
1732 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1733 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1735 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
1737 visitInstruction(I);
1740 void Verifier::visitSExtInst(SExtInst &I) {
1741 // Get the source and destination types
1742 Type *SrcTy = I.getOperand(0)->getType();
1743 Type *DestTy = I.getType();
1745 // Get the size of the types in bits, we'll need this later
1746 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1747 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1749 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
1750 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
1751 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1752 "sext source and destination must both be a vector or neither", &I);
1753 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
1755 visitInstruction(I);
1758 void Verifier::visitFPTruncInst(FPTruncInst &I) {
1759 // Get the source and destination types
1760 Type *SrcTy = I.getOperand(0)->getType();
1761 Type *DestTy = I.getType();
1762 // Get the size of the types in bits, we'll need this later
1763 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1764 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1766 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
1767 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
1768 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1769 "fptrunc source and destination must both be a vector or neither", &I);
1770 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
1772 visitInstruction(I);
1775 void Verifier::visitFPExtInst(FPExtInst &I) {
1776 // Get the source and destination types
1777 Type *SrcTy = I.getOperand(0)->getType();
1778 Type *DestTy = I.getType();
1780 // Get the size of the types in bits, we'll need this later
1781 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1782 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1784 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
1785 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
1786 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1787 "fpext source and destination must both be a vector or neither", &I);
1788 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
1790 visitInstruction(I);
1793 void Verifier::visitUIToFPInst(UIToFPInst &I) {
1794 // Get the source and destination types
1795 Type *SrcTy = I.getOperand(0)->getType();
1796 Type *DestTy = I.getType();
1798 bool SrcVec = SrcTy->isVectorTy();
1799 bool DstVec = DestTy->isVectorTy();
1801 Assert(SrcVec == DstVec,
1802 "UIToFP source and dest must both be vector or scalar", &I);
1803 Assert(SrcTy->isIntOrIntVectorTy(),
1804 "UIToFP source must be integer or integer vector", &I);
1805 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
1808 if (SrcVec && DstVec)
1809 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
1810 cast<VectorType>(DestTy)->getNumElements(),
1811 "UIToFP source and dest vector length mismatch", &I);
1813 visitInstruction(I);
1816 void Verifier::visitSIToFPInst(SIToFPInst &I) {
1817 // Get the source and destination types
1818 Type *SrcTy = I.getOperand(0)->getType();
1819 Type *DestTy = I.getType();
1821 bool SrcVec = SrcTy->isVectorTy();
1822 bool DstVec = DestTy->isVectorTy();
1824 Assert(SrcVec == DstVec,
1825 "SIToFP source and dest must both be vector or scalar", &I);
1826 Assert(SrcTy->isIntOrIntVectorTy(),
1827 "SIToFP source must be integer or integer vector", &I);
1828 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
1831 if (SrcVec && DstVec)
1832 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
1833 cast<VectorType>(DestTy)->getNumElements(),
1834 "SIToFP source and dest vector length mismatch", &I);
1836 visitInstruction(I);
1839 void Verifier::visitFPToUIInst(FPToUIInst &I) {
1840 // Get the source and destination types
1841 Type *SrcTy = I.getOperand(0)->getType();
1842 Type *DestTy = I.getType();
1844 bool SrcVec = SrcTy->isVectorTy();
1845 bool DstVec = DestTy->isVectorTy();
1847 Assert(SrcVec == DstVec,
1848 "FPToUI source and dest must both be vector or scalar", &I);
1849 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
1851 Assert(DestTy->isIntOrIntVectorTy(),
1852 "FPToUI result must be integer or integer vector", &I);
1854 if (SrcVec && DstVec)
1855 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
1856 cast<VectorType>(DestTy)->getNumElements(),
1857 "FPToUI source and dest vector length mismatch", &I);
1859 visitInstruction(I);
1862 void Verifier::visitFPToSIInst(FPToSIInst &I) {
1863 // Get the source and destination types
1864 Type *SrcTy = I.getOperand(0)->getType();
1865 Type *DestTy = I.getType();
1867 bool SrcVec = SrcTy->isVectorTy();
1868 bool DstVec = DestTy->isVectorTy();
1870 Assert(SrcVec == DstVec,
1871 "FPToSI source and dest must both be vector or scalar", &I);
1872 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
1874 Assert(DestTy->isIntOrIntVectorTy(),
1875 "FPToSI result must be integer or integer vector", &I);
1877 if (SrcVec && DstVec)
1878 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
1879 cast<VectorType>(DestTy)->getNumElements(),
1880 "FPToSI source and dest vector length mismatch", &I);
1882 visitInstruction(I);
1885 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
1886 // Get the source and destination types
1887 Type *SrcTy = I.getOperand(0)->getType();
1888 Type *DestTy = I.getType();
1890 Assert(SrcTy->getScalarType()->isPointerTy(),
1891 "PtrToInt source must be pointer", &I);
1892 Assert(DestTy->getScalarType()->isIntegerTy(),
1893 "PtrToInt result must be integral", &I);
1894 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
1897 if (SrcTy->isVectorTy()) {
1898 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
1899 VectorType *VDest = dyn_cast<VectorType>(DestTy);
1900 Assert(VSrc->getNumElements() == VDest->getNumElements(),
1901 "PtrToInt Vector width mismatch", &I);
1904 visitInstruction(I);
1907 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
1908 // Get the source and destination types
1909 Type *SrcTy = I.getOperand(0)->getType();
1910 Type *DestTy = I.getType();
1912 Assert(SrcTy->getScalarType()->isIntegerTy(),
1913 "IntToPtr source must be an integral", &I);
1914 Assert(DestTy->getScalarType()->isPointerTy(),
1915 "IntToPtr result must be a pointer", &I);
1916 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
1918 if (SrcTy->isVectorTy()) {
1919 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
1920 VectorType *VDest = dyn_cast<VectorType>(DestTy);
1921 Assert(VSrc->getNumElements() == VDest->getNumElements(),
1922 "IntToPtr Vector width mismatch", &I);
1924 visitInstruction(I);
1927 void Verifier::visitBitCastInst(BitCastInst &I) {
1929 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
1930 "Invalid bitcast", &I);
1931 visitInstruction(I);
1934 void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
1935 Type *SrcTy = I.getOperand(0)->getType();
1936 Type *DestTy = I.getType();
1938 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
1940 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
1942 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
1943 "AddrSpaceCast must be between different address spaces", &I);
1944 if (SrcTy->isVectorTy())
1945 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
1946 "AddrSpaceCast vector pointer number of elements mismatch", &I);
1947 visitInstruction(I);
1950 /// visitPHINode - Ensure that a PHI node is well formed.
1952 void Verifier::visitPHINode(PHINode &PN) {
1953 // Ensure that the PHI nodes are all grouped together at the top of the block.
1954 // This can be tested by checking whether the instruction before this is
1955 // either nonexistent (because this is begin()) or is a PHI node. If not,
1956 // then there is some other instruction before a PHI.
1957 Assert(&PN == &PN.getParent()->front() ||
1958 isa<PHINode>(--BasicBlock::iterator(&PN)),
1959 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
1961 // Check that all of the values of the PHI node have the same type as the
1962 // result, and that the incoming blocks are really basic blocks.
1963 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
1964 Assert(PN.getType() == PN.getIncomingValue(i)->getType(),
1965 "PHI node operands are not the same type as the result!", &PN);
1968 // All other PHI node constraints are checked in the visitBasicBlock method.
1970 visitInstruction(PN);
1973 void Verifier::VerifyCallSite(CallSite CS) {
1974 Instruction *I = CS.getInstruction();
1976 Assert(CS.getCalledValue()->getType()->isPointerTy(),
1977 "Called function must be a pointer!", I);
1978 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
1980 Assert(FPTy->getElementType()->isFunctionTy(),
1981 "Called function is not pointer to function type!", I);
1982 FunctionType *FTy = cast<FunctionType>(FPTy->getElementType());
1984 // Verify that the correct number of arguments are being passed
1985 if (FTy->isVarArg())
1986 Assert(CS.arg_size() >= FTy->getNumParams(),
1987 "Called function requires more parameters than were provided!", I);
1989 Assert(CS.arg_size() == FTy->getNumParams(),
1990 "Incorrect number of arguments passed to called function!", I);
1992 // Verify that all arguments to the call match the function type.
1993 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
1994 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
1995 "Call parameter type does not match function signature!",
1996 CS.getArgument(i), FTy->getParamType(i), I);
1998 AttributeSet Attrs = CS.getAttributes();
2000 Assert(VerifyAttributeCount(Attrs, CS.arg_size()),
2001 "Attribute after last parameter!", I);
2003 // Verify call attributes.
2004 VerifyFunctionAttrs(FTy, Attrs, I);
2006 // Conservatively check the inalloca argument.
2007 // We have a bug if we can find that there is an underlying alloca without
2009 if (CS.hasInAllocaArgument()) {
2010 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2011 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
2012 Assert(AI->isUsedWithInAlloca(),
2013 "inalloca argument for call has mismatched alloca", AI, I);
2016 if (FTy->isVarArg()) {
2017 // FIXME? is 'nest' even legal here?
2018 bool SawNest = false;
2019 bool SawReturned = false;
2021 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2022 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2024 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2028 // Check attributes on the varargs part.
2029 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
2030 Type *Ty = CS.getArgument(Idx-1)->getType();
2031 VerifyParameterAttrs(Attrs, Idx, Ty, false, I);
2033 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
2034 Assert(!SawNest, "More than one parameter has attribute nest!", I);
2038 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
2039 Assert(!SawReturned, "More than one parameter has attribute returned!",
2041 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2042 "Incompatible argument and return types for 'returned' "
2048 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2049 "Attribute 'sret' cannot be used for vararg call arguments!", I);
2051 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
2052 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
2056 // Verify that there's no metadata unless it's a direct call to an intrinsic.
2057 if (CS.getCalledFunction() == nullptr ||
2058 !CS.getCalledFunction()->getName().startswith("llvm.")) {
2059 for (FunctionType::param_iterator PI = FTy->param_begin(),
2060 PE = FTy->param_end(); PI != PE; ++PI)
2061 Assert(!(*PI)->isMetadataTy(),
2062 "Function has metadata parameter but isn't an intrinsic", I);
2065 visitInstruction(*I);
2068 /// Two types are "congruent" if they are identical, or if they are both pointer
2069 /// types with different pointee types and the same address space.
2070 static bool isTypeCongruent(Type *L, Type *R) {
2073 PointerType *PL = dyn_cast<PointerType>(L);
2074 PointerType *PR = dyn_cast<PointerType>(R);
2077 return PL->getAddressSpace() == PR->getAddressSpace();
2080 static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2081 static const Attribute::AttrKind ABIAttrs[] = {
2082 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
2083 Attribute::InReg, Attribute::Returned};
2085 for (auto AK : ABIAttrs) {
2086 if (Attrs.hasAttribute(I + 1, AK))
2087 Copy.addAttribute(AK);
2089 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2090 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2094 void Verifier::verifyMustTailCall(CallInst &CI) {
2095 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
2097 // - The caller and callee prototypes must match. Pointer types of
2098 // parameters or return types may differ in pointee type, but not
2100 Function *F = CI.getParent()->getParent();
2101 auto GetFnTy = [](Value *V) {
2102 return cast<FunctionType>(
2103 cast<PointerType>(V->getType())->getElementType());
2105 FunctionType *CallerTy = GetFnTy(F);
2106 FunctionType *CalleeTy = GetFnTy(CI.getCalledValue());
2107 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2108 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2109 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2110 "cannot guarantee tail call due to mismatched varargs", &CI);
2111 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2112 "cannot guarantee tail call due to mismatched return types", &CI);
2113 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2115 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2116 "cannot guarantee tail call due to mismatched parameter types", &CI);
2119 // - The calling conventions of the caller and callee must match.
2120 Assert(F->getCallingConv() == CI.getCallingConv(),
2121 "cannot guarantee tail call due to mismatched calling conv", &CI);
2123 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2124 // returned, and inalloca, must match.
2125 AttributeSet CallerAttrs = F->getAttributes();
2126 AttributeSet CalleeAttrs = CI.getAttributes();
2127 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2128 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2129 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
2130 Assert(CallerABIAttrs == CalleeABIAttrs,
2131 "cannot guarantee tail call due to mismatched ABI impacting "
2132 "function attributes",
2133 &CI, CI.getOperand(I));
2136 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2137 // or a pointer bitcast followed by a ret instruction.
2138 // - The ret instruction must return the (possibly bitcasted) value
2139 // produced by the call or void.
2140 Value *RetVal = &CI;
2141 Instruction *Next = CI.getNextNode();
2143 // Handle the optional bitcast.
2144 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
2145 Assert(BI->getOperand(0) == RetVal,
2146 "bitcast following musttail call must use the call", BI);
2148 Next = BI->getNextNode();
2151 // Check the return.
2152 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
2153 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2155 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2156 "musttail call result must be returned", Ret);
2159 void Verifier::visitCallInst(CallInst &CI) {
2160 VerifyCallSite(&CI);
2162 if (CI.isMustTailCall())
2163 verifyMustTailCall(CI);
2165 if (Function *F = CI.getCalledFunction())
2166 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
2167 visitIntrinsicFunctionCall(ID, CI);
2170 void Verifier::visitInvokeInst(InvokeInst &II) {
2171 VerifyCallSite(&II);
2173 // Verify that there is a landingpad instruction as the first non-PHI
2174 // instruction of the 'unwind' destination.
2175 Assert(II.getUnwindDest()->isLandingPad(),
2176 "The unwind destination does not have a landingpad instruction!", &II);
2178 if (Function *F = II.getCalledFunction())
2179 // TODO: Ideally we should use visitIntrinsicFunction here. But it uses
2180 // CallInst as an input parameter. It not woth updating this whole
2181 // function only to support statepoint verification.
2182 if (F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint)
2183 VerifyStatepoint(ImmutableCallSite(&II));
2185 visitTerminatorInst(II);
2188 /// visitBinaryOperator - Check that both arguments to the binary operator are
2189 /// of the same type!
2191 void Verifier::visitBinaryOperator(BinaryOperator &B) {
2192 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2193 "Both operands to a binary operator are not of the same type!", &B);
2195 switch (B.getOpcode()) {
2196 // Check that integer arithmetic operators are only used with
2197 // integral operands.
2198 case Instruction::Add:
2199 case Instruction::Sub:
2200 case Instruction::Mul:
2201 case Instruction::SDiv:
2202 case Instruction::UDiv:
2203 case Instruction::SRem:
2204 case Instruction::URem:
2205 Assert(B.getType()->isIntOrIntVectorTy(),
2206 "Integer arithmetic operators only work with integral types!", &B);
2207 Assert(B.getType() == B.getOperand(0)->getType(),
2208 "Integer arithmetic operators must have same type "
2209 "for operands and result!",
2212 // Check that floating-point arithmetic operators are only used with
2213 // floating-point operands.
2214 case Instruction::FAdd:
2215 case Instruction::FSub:
2216 case Instruction::FMul:
2217 case Instruction::FDiv:
2218 case Instruction::FRem:
2219 Assert(B.getType()->isFPOrFPVectorTy(),
2220 "Floating-point arithmetic operators only work with "
2221 "floating-point types!",
2223 Assert(B.getType() == B.getOperand(0)->getType(),
2224 "Floating-point arithmetic operators must have same type "
2225 "for operands and result!",
2228 // Check that logical operators are only used with integral operands.
2229 case Instruction::And:
2230 case Instruction::Or:
2231 case Instruction::Xor:
2232 Assert(B.getType()->isIntOrIntVectorTy(),
2233 "Logical operators only work with integral types!", &B);
2234 Assert(B.getType() == B.getOperand(0)->getType(),
2235 "Logical operators must have same type for operands and result!",
2238 case Instruction::Shl:
2239 case Instruction::LShr:
2240 case Instruction::AShr:
2241 Assert(B.getType()->isIntOrIntVectorTy(),
2242 "Shifts only work with integral types!", &B);
2243 Assert(B.getType() == B.getOperand(0)->getType(),
2244 "Shift return type must be same as operands!", &B);
2247 llvm_unreachable("Unknown BinaryOperator opcode!");
2250 visitInstruction(B);
2253 void Verifier::visitICmpInst(ICmpInst &IC) {
2254 // Check that the operands are the same type
2255 Type *Op0Ty = IC.getOperand(0)->getType();
2256 Type *Op1Ty = IC.getOperand(1)->getType();
2257 Assert(Op0Ty == Op1Ty,
2258 "Both operands to ICmp instruction are not of the same type!", &IC);
2259 // Check that the operands are the right type
2260 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2261 "Invalid operand types for ICmp instruction", &IC);
2262 // Check that the predicate is valid.
2263 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2264 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2265 "Invalid predicate in ICmp instruction!", &IC);
2267 visitInstruction(IC);
2270 void Verifier::visitFCmpInst(FCmpInst &FC) {
2271 // Check that the operands are the same type
2272 Type *Op0Ty = FC.getOperand(0)->getType();
2273 Type *Op1Ty = FC.getOperand(1)->getType();
2274 Assert(Op0Ty == Op1Ty,
2275 "Both operands to FCmp instruction are not of the same type!", &FC);
2276 // Check that the operands are the right type
2277 Assert(Op0Ty->isFPOrFPVectorTy(),
2278 "Invalid operand types for FCmp instruction", &FC);
2279 // Check that the predicate is valid.
2280 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2281 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2282 "Invalid predicate in FCmp instruction!", &FC);
2284 visitInstruction(FC);
2287 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
2289 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2290 "Invalid extractelement operands!", &EI);
2291 visitInstruction(EI);
2294 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
2295 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2297 "Invalid insertelement operands!", &IE);
2298 visitInstruction(IE);
2301 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
2302 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2304 "Invalid shufflevector operands!", &SV);
2305 visitInstruction(SV);
2308 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
2309 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
2311 Assert(isa<PointerType>(TargetTy),
2312 "GEP base pointer is not a vector or a vector of pointers", &GEP);
2313 Assert(cast<PointerType>(TargetTy)->getElementType()->isSized(),
2314 "GEP into unsized type!", &GEP);
2315 Assert(GEP.getPointerOperandType()->isVectorTy() ==
2316 GEP.getType()->isVectorTy(),
2317 "Vector GEP must return a vector value", &GEP);
2319 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
2321 GetElementPtrInst::getIndexedType(GEP.getPointerOperandType(), Idxs);
2322 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
2324 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
2325 cast<PointerType>(GEP.getType()->getScalarType())
2326 ->getElementType() == ElTy,
2327 "GEP is not of right type for indices!", &GEP, ElTy);
2329 if (GEP.getPointerOperandType()->isVectorTy()) {
2330 // Additional checks for vector GEPs.
2331 unsigned GepWidth = GEP.getPointerOperandType()->getVectorNumElements();
2332 Assert(GepWidth == GEP.getType()->getVectorNumElements(),
2333 "Vector GEP result width doesn't match operand's", &GEP);
2334 for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
2335 Type *IndexTy = Idxs[i]->getType();
2336 Assert(IndexTy->isVectorTy(), "Vector GEP must have vector indices!",
2338 unsigned IndexWidth = IndexTy->getVectorNumElements();
2339 Assert(IndexWidth == GepWidth, "Invalid GEP index vector width", &GEP);
2342 visitInstruction(GEP);
2345 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2346 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2349 void Verifier::visitRangeMetadata(Instruction& I,
2350 MDNode* Range, Type* Ty) {
2352 Range == I.getMetadata(LLVMContext::MD_range) &&
2353 "precondition violation");
2355 unsigned NumOperands = Range->getNumOperands();
2356 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
2357 unsigned NumRanges = NumOperands / 2;
2358 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2360 ConstantRange LastRange(1); // Dummy initial value
2361 for (unsigned i = 0; i < NumRanges; ++i) {
2363 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
2364 Assert(Low, "The lower limit must be an integer!", Low);
2366 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
2367 Assert(High, "The upper limit must be an integer!", High);
2368 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2369 "Range types must match instruction type!", &I);
2371 APInt HighV = High->getValue();
2372 APInt LowV = Low->getValue();
2373 ConstantRange CurRange(LowV, HighV);
2374 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2375 "Range must not be empty!", Range);
2377 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2378 "Intervals are overlapping", Range);
2379 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2381 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2384 LastRange = ConstantRange(LowV, HighV);
2386 if (NumRanges > 2) {
2388 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
2390 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
2391 ConstantRange FirstRange(FirstLow, FirstHigh);
2392 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2393 "Intervals are overlapping", Range);
2394 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2399 void Verifier::visitLoadInst(LoadInst &LI) {
2400 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
2401 Assert(PTy, "Load operand must be a pointer.", &LI);
2402 Type *ElTy = PTy->getElementType();
2403 Assert(ElTy == LI.getType(),
2404 "Load result type does not match pointer operand type!", &LI, ElTy);
2405 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2406 "huge alignment values are unsupported", &LI);
2407 if (LI.isAtomic()) {
2408 Assert(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
2409 "Load cannot have Release ordering", &LI);
2410 Assert(LI.getAlignment() != 0,
2411 "Atomic load must specify explicit alignment", &LI);
2412 if (!ElTy->isPointerTy()) {
2413 Assert(ElTy->isIntegerTy(), "atomic load operand must have integer type!",
2415 unsigned Size = ElTy->getPrimitiveSizeInBits();
2416 Assert(Size >= 8 && !(Size & (Size - 1)),
2417 "atomic load operand must be power-of-two byte-sized integer", &LI,
2421 Assert(LI.getSynchScope() == CrossThread,
2422 "Non-atomic load cannot have SynchronizationScope specified", &LI);
2425 visitInstruction(LI);
2428 void Verifier::visitStoreInst(StoreInst &SI) {
2429 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
2430 Assert(PTy, "Store operand must be a pointer.", &SI);
2431 Type *ElTy = PTy->getElementType();
2432 Assert(ElTy == SI.getOperand(0)->getType(),
2433 "Stored value type does not match pointer operand type!", &SI, ElTy);
2434 Assert(SI.getAlignment() <= Value::MaximumAlignment,
2435 "huge alignment values are unsupported", &SI);
2436 if (SI.isAtomic()) {
2437 Assert(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
2438 "Store cannot have Acquire ordering", &SI);
2439 Assert(SI.getAlignment() != 0,
2440 "Atomic store must specify explicit alignment", &SI);
2441 if (!ElTy->isPointerTy()) {
2442 Assert(ElTy->isIntegerTy(),
2443 "atomic store operand must have integer type!", &SI, ElTy);
2444 unsigned Size = ElTy->getPrimitiveSizeInBits();
2445 Assert(Size >= 8 && !(Size & (Size - 1)),
2446 "atomic store operand must be power-of-two byte-sized integer",
2450 Assert(SI.getSynchScope() == CrossThread,
2451 "Non-atomic store cannot have SynchronizationScope specified", &SI);
2453 visitInstruction(SI);
2456 void Verifier::visitAllocaInst(AllocaInst &AI) {
2457 SmallPtrSet<const Type*, 4> Visited;
2458 PointerType *PTy = AI.getType();
2459 Assert(PTy->getAddressSpace() == 0,
2460 "Allocation instruction pointer not in the generic address space!",
2462 Assert(PTy->getElementType()->isSized(&Visited),
2463 "Cannot allocate unsized type", &AI);
2464 Assert(AI.getArraySize()->getType()->isIntegerTy(),
2465 "Alloca array size must have integer type", &AI);
2466 Assert(AI.getAlignment() <= Value::MaximumAlignment,
2467 "huge alignment values are unsupported", &AI);
2469 visitInstruction(AI);
2472 void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
2474 // FIXME: more conditions???
2475 Assert(CXI.getSuccessOrdering() != NotAtomic,
2476 "cmpxchg instructions must be atomic.", &CXI);
2477 Assert(CXI.getFailureOrdering() != NotAtomic,
2478 "cmpxchg instructions must be atomic.", &CXI);
2479 Assert(CXI.getSuccessOrdering() != Unordered,
2480 "cmpxchg instructions cannot be unordered.", &CXI);
2481 Assert(CXI.getFailureOrdering() != Unordered,
2482 "cmpxchg instructions cannot be unordered.", &CXI);
2483 Assert(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
2484 "cmpxchg instructions be at least as constrained on success as fail",
2486 Assert(CXI.getFailureOrdering() != Release &&
2487 CXI.getFailureOrdering() != AcquireRelease,
2488 "cmpxchg failure ordering cannot include release semantics", &CXI);
2490 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
2491 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
2492 Type *ElTy = PTy->getElementType();
2493 Assert(ElTy->isIntegerTy(), "cmpxchg operand must have integer type!", &CXI,
2495 unsigned Size = ElTy->getPrimitiveSizeInBits();
2496 Assert(Size >= 8 && !(Size & (Size - 1)),
2497 "cmpxchg operand must be power-of-two byte-sized integer", &CXI, ElTy);
2498 Assert(ElTy == CXI.getOperand(1)->getType(),
2499 "Expected value type does not match pointer operand type!", &CXI,
2501 Assert(ElTy == CXI.getOperand(2)->getType(),
2502 "Stored value type does not match pointer operand type!", &CXI, ElTy);
2503 visitInstruction(CXI);
2506 void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
2507 Assert(RMWI.getOrdering() != NotAtomic,
2508 "atomicrmw instructions must be atomic.", &RMWI);
2509 Assert(RMWI.getOrdering() != Unordered,
2510 "atomicrmw instructions cannot be unordered.", &RMWI);
2511 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
2512 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
2513 Type *ElTy = PTy->getElementType();
2514 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
2516 unsigned Size = ElTy->getPrimitiveSizeInBits();
2517 Assert(Size >= 8 && !(Size & (Size - 1)),
2518 "atomicrmw operand must be power-of-two byte-sized integer", &RMWI,
2520 Assert(ElTy == RMWI.getOperand(1)->getType(),
2521 "Argument value type does not match pointer operand type!", &RMWI,
2523 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
2524 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
2525 "Invalid binary operation!", &RMWI);
2526 visitInstruction(RMWI);
2529 void Verifier::visitFenceInst(FenceInst &FI) {
2530 const AtomicOrdering Ordering = FI.getOrdering();
2531 Assert(Ordering == Acquire || Ordering == Release ||
2532 Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
2533 "fence instructions may only have "
2534 "acquire, release, acq_rel, or seq_cst ordering.",
2536 visitInstruction(FI);
2539 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
2540 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
2541 EVI.getIndices()) == EVI.getType(),
2542 "Invalid ExtractValueInst operands!", &EVI);
2544 visitInstruction(EVI);
2547 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
2548 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
2549 IVI.getIndices()) ==
2550 IVI.getOperand(1)->getType(),
2551 "Invalid InsertValueInst operands!", &IVI);
2553 visitInstruction(IVI);
2556 void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
2557 BasicBlock *BB = LPI.getParent();
2559 // The landingpad instruction is ill-formed if it doesn't have any clauses and
2561 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
2562 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
2564 // The landingpad instruction defines its parent as a landing pad block. The
2565 // landing pad block may be branched to only by the unwind edge of an invoke.
2566 for (pred_iterator I = pred_begin(BB), E = pred_end(BB); I != E; ++I) {
2567 const InvokeInst *II = dyn_cast<InvokeInst>((*I)->getTerminator());
2568 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
2569 "Block containing LandingPadInst must be jumped to "
2570 "only by the unwind edge of an invoke.",
2574 // The landingpad instruction must be the first non-PHI instruction in the
2576 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
2577 "LandingPadInst not the first non-PHI instruction in the block.",
2580 // The personality functions for all landingpad instructions within the same
2581 // function should match.
2583 Assert(LPI.getPersonalityFn() == PersonalityFn,
2584 "Personality function doesn't match others in function", &LPI);
2585 PersonalityFn = LPI.getPersonalityFn();
2587 // All operands must be constants.
2588 Assert(isa<Constant>(PersonalityFn), "Personality function is not constant!",
2590 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
2591 Constant *Clause = LPI.getClause(i);
2592 if (LPI.isCatch(i)) {
2593 Assert(isa<PointerType>(Clause->getType()),
2594 "Catch operand does not have pointer type!", &LPI);
2596 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
2597 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
2598 "Filter operand is not an array of constants!", &LPI);
2602 visitInstruction(LPI);
2605 void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
2606 Instruction *Op = cast<Instruction>(I.getOperand(i));
2607 // If the we have an invalid invoke, don't try to compute the dominance.
2608 // We already reject it in the invoke specific checks and the dominance
2609 // computation doesn't handle multiple edges.
2610 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
2611 if (II->getNormalDest() == II->getUnwindDest())
2615 const Use &U = I.getOperandUse(i);
2616 Assert(InstsInThisBlock.count(Op) || DT.dominates(Op, U),
2617 "Instruction does not dominate all uses!", Op, &I);
2620 /// verifyInstruction - Verify that an instruction is well formed.
2622 void Verifier::visitInstruction(Instruction &I) {
2623 BasicBlock *BB = I.getParent();
2624 Assert(BB, "Instruction not embedded in basic block!", &I);
2626 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
2627 for (User *U : I.users()) {
2628 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
2629 "Only PHI nodes may reference their own value!", &I);
2633 // Check that void typed values don't have names
2634 Assert(!I.getType()->isVoidTy() || !I.hasName(),
2635 "Instruction has a name, but provides a void value!", &I);
2637 // Check that the return value of the instruction is either void or a legal
2639 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
2640 "Instruction returns a non-scalar type!", &I);
2642 // Check that the instruction doesn't produce metadata. Calls are already
2643 // checked against the callee type.
2644 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
2645 "Invalid use of metadata!", &I);
2647 // Check that all uses of the instruction, if they are instructions
2648 // themselves, actually have parent basic blocks. If the use is not an
2649 // instruction, it is an error!
2650 for (Use &U : I.uses()) {
2651 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
2652 Assert(Used->getParent() != nullptr,
2653 "Instruction referencing"
2654 " instruction not embedded in a basic block!",
2657 CheckFailed("Use of instruction is not an instruction!", U);
2662 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
2663 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
2665 // Check to make sure that only first-class-values are operands to
2667 if (!I.getOperand(i)->getType()->isFirstClassType()) {
2668 Assert(0, "Instruction operands must be first-class values!", &I);
2671 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
2672 // Check to make sure that the "address of" an intrinsic function is never
2675 !F->isIntrinsic() ||
2676 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
2677 "Cannot take the address of an intrinsic!", &I);
2679 !F->isIntrinsic() || isa<CallInst>(I) ||
2680 F->getIntrinsicID() == Intrinsic::donothing ||
2681 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
2682 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
2683 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
2684 "Cannot invoke an intrinsinc other than"
2685 " donothing or patchpoint",
2687 Assert(F->getParent() == M, "Referencing function in another module!",
2689 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
2690 Assert(OpBB->getParent() == BB->getParent(),
2691 "Referring to a basic block in another function!", &I);
2692 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
2693 Assert(OpArg->getParent() == BB->getParent(),
2694 "Referring to an argument in another function!", &I);
2695 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
2696 Assert(GV->getParent() == M, "Referencing global in another module!", &I);
2697 } else if (isa<Instruction>(I.getOperand(i))) {
2698 verifyDominatesUse(I, i);
2699 } else if (isa<InlineAsm>(I.getOperand(i))) {
2700 Assert((i + 1 == e && isa<CallInst>(I)) ||
2701 (i + 3 == e && isa<InvokeInst>(I)),
2702 "Cannot take the address of an inline asm!", &I);
2703 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
2704 if (CE->getType()->isPtrOrPtrVectorTy()) {
2705 // If we have a ConstantExpr pointer, we need to see if it came from an
2706 // illegal bitcast (inttoptr <constant int> )
2707 SmallVector<const ConstantExpr *, 4> Stack;
2708 SmallPtrSet<const ConstantExpr *, 4> Visited;
2709 Stack.push_back(CE);
2711 while (!Stack.empty()) {
2712 const ConstantExpr *V = Stack.pop_back_val();
2713 if (!Visited.insert(V).second)
2716 VerifyConstantExprBitcastType(V);
2718 for (unsigned I = 0, N = V->getNumOperands(); I != N; ++I) {
2719 if (ConstantExpr *Op = dyn_cast<ConstantExpr>(V->getOperand(I)))
2720 Stack.push_back(Op);
2727 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
2728 Assert(I.getType()->isFPOrFPVectorTy(),
2729 "fpmath requires a floating point result!", &I);
2730 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
2731 if (ConstantFP *CFP0 =
2732 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
2733 APFloat Accuracy = CFP0->getValueAPF();
2734 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
2735 "fpmath accuracy not a positive number!", &I);
2737 Assert(false, "invalid fpmath accuracy!", &I);
2741 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
2742 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
2743 "Ranges are only for loads, calls and invokes!", &I);
2744 visitRangeMetadata(I, Range, I.getType());
2747 if (I.getMetadata(LLVMContext::MD_nonnull)) {
2748 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
2750 Assert(isa<LoadInst>(I),
2751 "nonnull applies only to load instructions, use attributes"
2752 " for calls or invokes",
2756 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
2757 Assert(isa<MDLocation>(N), "invalid !dbg metadata attachment", &I, N);
2761 InstsInThisBlock.insert(&I);
2764 /// VerifyIntrinsicType - Verify that the specified type (which comes from an
2765 /// intrinsic argument or return value) matches the type constraints specified
2766 /// by the .td file (e.g. an "any integer" argument really is an integer).
2768 /// This return true on error but does not print a message.
2769 bool Verifier::VerifyIntrinsicType(Type *Ty,
2770 ArrayRef<Intrinsic::IITDescriptor> &Infos,
2771 SmallVectorImpl<Type*> &ArgTys) {
2772 using namespace Intrinsic;
2774 // If we ran out of descriptors, there are too many arguments.
2775 if (Infos.empty()) return true;
2776 IITDescriptor D = Infos.front();
2777 Infos = Infos.slice(1);
2780 case IITDescriptor::Void: return !Ty->isVoidTy();
2781 case IITDescriptor::VarArg: return true;
2782 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
2783 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
2784 case IITDescriptor::Half: return !Ty->isHalfTy();
2785 case IITDescriptor::Float: return !Ty->isFloatTy();
2786 case IITDescriptor::Double: return !Ty->isDoubleTy();
2787 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
2788 case IITDescriptor::Vector: {
2789 VectorType *VT = dyn_cast<VectorType>(Ty);
2790 return !VT || VT->getNumElements() != D.Vector_Width ||
2791 VerifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
2793 case IITDescriptor::Pointer: {
2794 PointerType *PT = dyn_cast<PointerType>(Ty);
2795 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
2796 VerifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
2799 case IITDescriptor::Struct: {
2800 StructType *ST = dyn_cast<StructType>(Ty);
2801 if (!ST || ST->getNumElements() != D.Struct_NumElements)
2804 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
2805 if (VerifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
2810 case IITDescriptor::Argument:
2811 // Two cases here - If this is the second occurrence of an argument, verify
2812 // that the later instance matches the previous instance.
2813 if (D.getArgumentNumber() < ArgTys.size())
2814 return Ty != ArgTys[D.getArgumentNumber()];
2816 // Otherwise, if this is the first instance of an argument, record it and
2817 // verify the "Any" kind.
2818 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
2819 ArgTys.push_back(Ty);
2821 switch (D.getArgumentKind()) {
2822 case IITDescriptor::AK_Any: return false; // Success
2823 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
2824 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
2825 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
2826 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
2828 llvm_unreachable("all argument kinds not covered");
2830 case IITDescriptor::ExtendArgument: {
2831 // This may only be used when referring to a previous vector argument.
2832 if (D.getArgumentNumber() >= ArgTys.size())
2835 Type *NewTy = ArgTys[D.getArgumentNumber()];
2836 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
2837 NewTy = VectorType::getExtendedElementVectorType(VTy);
2838 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
2839 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
2845 case IITDescriptor::TruncArgument: {
2846 // This may only be used when referring to a previous vector argument.
2847 if (D.getArgumentNumber() >= ArgTys.size())
2850 Type *NewTy = ArgTys[D.getArgumentNumber()];
2851 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
2852 NewTy = VectorType::getTruncatedElementVectorType(VTy);
2853 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
2854 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
2860 case IITDescriptor::HalfVecArgument:
2861 // This may only be used when referring to a previous vector argument.
2862 return D.getArgumentNumber() >= ArgTys.size() ||
2863 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
2864 VectorType::getHalfElementsVectorType(
2865 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
2866 case IITDescriptor::SameVecWidthArgument: {
2867 if (D.getArgumentNumber() >= ArgTys.size())
2869 VectorType * ReferenceType =
2870 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
2871 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
2872 if (!ThisArgType || !ReferenceType ||
2873 (ReferenceType->getVectorNumElements() !=
2874 ThisArgType->getVectorNumElements()))
2876 return VerifyIntrinsicType(ThisArgType->getVectorElementType(),
2879 case IITDescriptor::PtrToArgument: {
2880 if (D.getArgumentNumber() >= ArgTys.size())
2882 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
2883 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
2884 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
2886 case IITDescriptor::VecOfPtrsToElt: {
2887 if (D.getArgumentNumber() >= ArgTys.size())
2889 VectorType * ReferenceType =
2890 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
2891 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
2892 if (!ThisArgVecTy || !ReferenceType ||
2893 (ReferenceType->getVectorNumElements() !=
2894 ThisArgVecTy->getVectorNumElements()))
2896 PointerType *ThisArgEltTy =
2897 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
2900 return (!(ThisArgEltTy->getElementType() ==
2901 ReferenceType->getVectorElementType()));
2904 llvm_unreachable("unhandled");
2907 /// \brief Verify if the intrinsic has variable arguments.
2908 /// This method is intended to be called after all the fixed arguments have been
2911 /// This method returns true on error and does not print an error message.
2913 Verifier::VerifyIntrinsicIsVarArg(bool isVarArg,
2914 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
2915 using namespace Intrinsic;
2917 // If there are no descriptors left, then it can't be a vararg.
2921 // There should be only one descriptor remaining at this point.
2922 if (Infos.size() != 1)
2925 // Check and verify the descriptor.
2926 IITDescriptor D = Infos.front();
2927 Infos = Infos.slice(1);
2928 if (D.Kind == IITDescriptor::VarArg)
2934 /// visitIntrinsicFunction - Allow intrinsics to be verified in different ways.
2936 void Verifier::visitIntrinsicFunctionCall(Intrinsic::ID ID, CallInst &CI) {
2937 Function *IF = CI.getCalledFunction();
2938 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
2941 // Verify that the intrinsic prototype lines up with what the .td files
2943 FunctionType *IFTy = IF->getFunctionType();
2944 bool IsVarArg = IFTy->isVarArg();
2946 SmallVector<Intrinsic::IITDescriptor, 8> Table;
2947 getIntrinsicInfoTableEntries(ID, Table);
2948 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
2950 SmallVector<Type *, 4> ArgTys;
2951 Assert(!VerifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
2952 "Intrinsic has incorrect return type!", IF);
2953 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
2954 Assert(!VerifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
2955 "Intrinsic has incorrect argument type!", IF);
2957 // Verify if the intrinsic call matches the vararg property.
2959 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
2960 "Intrinsic was not defined with variable arguments!", IF);
2962 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
2963 "Callsite was not defined with variable arguments!", IF);
2965 // All descriptors should be absorbed by now.
2966 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
2968 // Now that we have the intrinsic ID and the actual argument types (and we
2969 // know they are legal for the intrinsic!) get the intrinsic name through the
2970 // usual means. This allows us to verify the mangling of argument types into
2972 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
2973 Assert(ExpectedName == IF->getName(),
2974 "Intrinsic name not mangled correctly for type arguments! "
2979 // If the intrinsic takes MDNode arguments, verify that they are either global
2980 // or are local to *this* function.
2981 for (unsigned i = 0, e = CI.getNumArgOperands(); i != e; ++i)
2982 if (auto *MD = dyn_cast<MetadataAsValue>(CI.getArgOperand(i)))
2983 visitMetadataAsValue(*MD, CI.getParent()->getParent());
2988 case Intrinsic::ctlz: // llvm.ctlz
2989 case Intrinsic::cttz: // llvm.cttz
2990 Assert(isa<ConstantInt>(CI.getArgOperand(1)),
2991 "is_zero_undef argument of bit counting intrinsics must be a "
2995 case Intrinsic::dbg_declare: // llvm.dbg.declare
2996 Assert(isa<MetadataAsValue>(CI.getArgOperand(0)),
2997 "invalid llvm.dbg.declare intrinsic call 1", &CI);
2998 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(CI));
3000 case Intrinsic::dbg_value: // llvm.dbg.value
3001 visitDbgIntrinsic("value", cast<DbgValueInst>(CI));
3003 case Intrinsic::memcpy:
3004 case Intrinsic::memmove:
3005 case Intrinsic::memset: {
3006 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CI.getArgOperand(3));
3008 "alignment argument of memory intrinsics must be a constant int",
3010 const APInt &AlignVal = AlignCI->getValue();
3011 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
3012 "alignment argument of memory intrinsics must be a power of 2", &CI);
3013 Assert(isa<ConstantInt>(CI.getArgOperand(4)),
3014 "isvolatile argument of memory intrinsics must be a constant int",
3018 case Intrinsic::gcroot:
3019 case Intrinsic::gcwrite:
3020 case Intrinsic::gcread:
3021 if (ID == Intrinsic::gcroot) {
3023 dyn_cast<AllocaInst>(CI.getArgOperand(0)->stripPointerCasts());
3024 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", &CI);
3025 Assert(isa<Constant>(CI.getArgOperand(1)),
3026 "llvm.gcroot parameter #2 must be a constant.", &CI);
3027 if (!AI->getType()->getElementType()->isPointerTy()) {
3028 Assert(!isa<ConstantPointerNull>(CI.getArgOperand(1)),
3029 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3030 "or argument #2 must be a non-null constant.",
3035 Assert(CI.getParent()->getParent()->hasGC(),
3036 "Enclosing function does not use GC.", &CI);
3038 case Intrinsic::init_trampoline:
3039 Assert(isa<Function>(CI.getArgOperand(1)->stripPointerCasts()),
3040 "llvm.init_trampoline parameter #2 must resolve to a function.",
3043 case Intrinsic::prefetch:
3044 Assert(isa<ConstantInt>(CI.getArgOperand(1)) &&
3045 isa<ConstantInt>(CI.getArgOperand(2)) &&
3046 cast<ConstantInt>(CI.getArgOperand(1))->getZExtValue() < 2 &&
3047 cast<ConstantInt>(CI.getArgOperand(2))->getZExtValue() < 4,
3048 "invalid arguments to llvm.prefetch", &CI);
3050 case Intrinsic::stackprotector:
3051 Assert(isa<AllocaInst>(CI.getArgOperand(1)->stripPointerCasts()),
3052 "llvm.stackprotector parameter #2 must resolve to an alloca.", &CI);
3054 case Intrinsic::lifetime_start:
3055 case Intrinsic::lifetime_end:
3056 case Intrinsic::invariant_start:
3057 Assert(isa<ConstantInt>(CI.getArgOperand(0)),
3058 "size argument of memory use markers must be a constant integer",
3061 case Intrinsic::invariant_end:
3062 Assert(isa<ConstantInt>(CI.getArgOperand(1)),
3063 "llvm.invariant.end parameter #2 must be a constant integer", &CI);
3066 case Intrinsic::frameescape: {
3067 BasicBlock *BB = CI.getParent();
3068 Assert(BB == &BB->getParent()->front(),
3069 "llvm.frameescape used outside of entry block", &CI);
3070 Assert(!SawFrameEscape,
3071 "multiple calls to llvm.frameescape in one function", &CI);
3072 for (Value *Arg : CI.arg_operands()) {
3073 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
3074 Assert(AI && AI->isStaticAlloca(),
3075 "llvm.frameescape only accepts static allocas", &CI);
3077 FrameEscapeInfo[BB->getParent()].first = CI.getNumArgOperands();
3078 SawFrameEscape = true;
3081 case Intrinsic::framerecover: {
3082 Value *FnArg = CI.getArgOperand(0)->stripPointerCasts();
3083 Function *Fn = dyn_cast<Function>(FnArg);
3084 Assert(Fn && !Fn->isDeclaration(),
3085 "llvm.framerecover first "
3086 "argument must be function defined in this module",
3088 auto *IdxArg = dyn_cast<ConstantInt>(CI.getArgOperand(2));
3089 Assert(IdxArg, "idx argument of llvm.framerecover must be a constant int",
3091 auto &Entry = FrameEscapeInfo[Fn];
3092 Entry.second = unsigned(
3093 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
3097 case Intrinsic::eh_parentframe: {
3098 auto *AI = dyn_cast<AllocaInst>(CI.getArgOperand(0)->stripPointerCasts());
3099 Assert(AI && AI->isStaticAlloca(),
3100 "llvm.eh.parentframe requires a static alloca", &CI);
3104 case Intrinsic::eh_unwindhelp: {
3105 auto *AI = dyn_cast<AllocaInst>(CI.getArgOperand(0)->stripPointerCasts());
3106 Assert(AI && AI->isStaticAlloca(),
3107 "llvm.eh.unwindhelp requires a static alloca", &CI);
3111 case Intrinsic::experimental_gc_statepoint:
3112 Assert(!CI.isInlineAsm(),
3113 "gc.statepoint support for inline assembly unimplemented", &CI);
3114 Assert(CI.getParent()->getParent()->hasGC(),
3115 "Enclosing function does not use GC.", &CI);
3117 VerifyStatepoint(ImmutableCallSite(&CI));
3119 case Intrinsic::experimental_gc_result_int:
3120 case Intrinsic::experimental_gc_result_float:
3121 case Intrinsic::experimental_gc_result_ptr:
3122 case Intrinsic::experimental_gc_result: {
3123 Assert(CI.getParent()->getParent()->hasGC(),
3124 "Enclosing function does not use GC.", &CI);
3125 // Are we tied to a statepoint properly?
3126 CallSite StatepointCS(CI.getArgOperand(0));
3127 const Function *StatepointFn =
3128 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
3129 Assert(StatepointFn && StatepointFn->isDeclaration() &&
3130 StatepointFn->getIntrinsicID() ==
3131 Intrinsic::experimental_gc_statepoint,
3132 "gc.result operand #1 must be from a statepoint", &CI,
3133 CI.getArgOperand(0));
3135 // Assert that result type matches wrapped callee.
3136 const Value *Target = StatepointCS.getArgument(0);
3137 const PointerType *PT = cast<PointerType>(Target->getType());
3138 const FunctionType *TargetFuncType =
3139 cast<FunctionType>(PT->getElementType());
3140 Assert(CI.getType() == TargetFuncType->getReturnType(),
3141 "gc.result result type does not match wrapped callee", &CI);
3144 case Intrinsic::experimental_gc_relocate: {
3145 Assert(CI.getNumArgOperands() == 3, "wrong number of arguments", &CI);
3147 // Check that this relocate is correctly tied to the statepoint
3149 // This is case for relocate on the unwinding path of an invoke statepoint
3150 if (ExtractValueInst *ExtractValue =
3151 dyn_cast<ExtractValueInst>(CI.getArgOperand(0))) {
3152 Assert(isa<LandingPadInst>(ExtractValue->getAggregateOperand()),
3153 "gc relocate on unwind path incorrectly linked to the statepoint",
3156 const BasicBlock *invokeBB =
3157 ExtractValue->getParent()->getUniquePredecessor();
3159 // Landingpad relocates should have only one predecessor with invoke
3160 // statepoint terminator
3161 Assert(invokeBB, "safepoints should have unique landingpads",
3162 ExtractValue->getParent());
3163 Assert(invokeBB->getTerminator(), "safepoint block should be well formed",
3165 Assert(isStatepoint(invokeBB->getTerminator()),
3166 "gc relocate should be linked to a statepoint", invokeBB);
3169 // In all other cases relocate should be tied to the statepoint directly.
3170 // This covers relocates on a normal return path of invoke statepoint and
3171 // relocates of a call statepoint
3172 auto Token = CI.getArgOperand(0);
3173 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
3174 "gc relocate is incorrectly tied to the statepoint", &CI, Token);
3177 // Verify rest of the relocate arguments
3179 GCRelocateOperands ops(&CI);
3180 ImmutableCallSite StatepointCS(ops.statepoint());
3182 // Both the base and derived must be piped through the safepoint
3183 Value* Base = CI.getArgOperand(1);
3184 Assert(isa<ConstantInt>(Base),
3185 "gc.relocate operand #2 must be integer offset", &CI);
3187 Value* Derived = CI.getArgOperand(2);
3188 Assert(isa<ConstantInt>(Derived),
3189 "gc.relocate operand #3 must be integer offset", &CI);
3191 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
3192 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
3194 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
3195 "gc.relocate: statepoint base index out of bounds", &CI);
3196 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
3197 "gc.relocate: statepoint derived index out of bounds", &CI);
3199 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
3200 // section of the statepoint's argument
3201 Assert(StatepointCS.arg_size() > 0,
3202 "gc.statepoint: insufficient arguments");
3203 Assert(isa<ConstantInt>(StatepointCS.getArgument(1)),
3204 "gc.statement: number of call arguments must be constant integer");
3205 const unsigned NumCallArgs =
3206 cast<ConstantInt>(StatepointCS.getArgument(1))->getZExtValue();
3207 Assert(StatepointCS.arg_size() > NumCallArgs+3,
3208 "gc.statepoint: mismatch in number of call arguments");
3209 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs+3)),
3210 "gc.statepoint: number of deoptimization arguments must be "
3211 "a constant integer");
3212 const int NumDeoptArgs =
3213 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 3))->getZExtValue();
3214 const int GCParamArgsStart = NumCallArgs + NumDeoptArgs + 4;
3215 const int GCParamArgsEnd = StatepointCS.arg_size();
3216 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
3217 "gc.relocate: statepoint base index doesn't fall within the "
3218 "'gc parameters' section of the statepoint call",
3220 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
3221 "gc.relocate: statepoint derived index doesn't fall within the "
3222 "'gc parameters' section of the statepoint call",
3225 // Assert that the result type matches the type of the relocated pointer
3226 GCRelocateOperands Operands(&CI);
3227 Assert(Operands.derivedPtr()->getType() == CI.getType(),
3228 "gc.relocate: relocating a pointer shouldn't change its type", &CI);
3234 template <class DbgIntrinsicTy>
3235 void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
3236 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
3237 Assert(isa<ValueAsMetadata>(MD) ||
3238 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
3239 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
3240 Assert(isa<MDLocalVariable>(DII.getRawVariable()),
3241 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
3242 DII.getRawVariable());
3243 Assert(isa<MDExpression>(DII.getRawExpression()),
3244 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
3245 DII.getRawExpression());
3248 void Verifier::verifyDebugInfo() {
3249 // Run the debug info verifier only if the regular verifier succeeds, since
3250 // sometimes checks that have already failed will cause crashes here.
3251 if (EverBroken || !VerifyDebugInfo)
3254 DebugInfoFinder Finder;
3255 Finder.processModule(*M);
3256 processInstructions(Finder);
3258 // Verify Debug Info.
3260 // NOTE: The loud braces are necessary for MSVC compatibility.
3261 for (DICompileUnit CU : Finder.compile_units()) {
3262 Assert(CU.Verify(), "DICompileUnit does not Verify!", CU);
3264 for (DISubprogram S : Finder.subprograms()) {
3265 Assert(S.Verify(), "DISubprogram does not Verify!", S);
3267 for (DIGlobalVariable GV : Finder.global_variables()) {
3268 Assert(GV.Verify(), "DIGlobalVariable does not Verify!", GV);
3270 for (DIType T : Finder.types()) {
3271 Assert(T.Verify(), "DIType does not Verify!", T);
3273 for (DIScope S : Finder.scopes()) {
3274 Assert(S.Verify(), "DIScope does not Verify!", S);
3278 void Verifier::processInstructions(DebugInfoFinder &Finder) {
3279 for (const Function &F : *M)
3280 for (auto I = inst_begin(&F), E = inst_end(&F); I != E; ++I) {
3281 if (MDNode *MD = I->getMetadata(LLVMContext::MD_dbg))
3282 Finder.processLocation(*M, DILocation(MD));
3283 if (const CallInst *CI = dyn_cast<CallInst>(&*I))
3284 processCallInst(Finder, *CI);
3288 void Verifier::processCallInst(DebugInfoFinder &Finder, const CallInst &CI) {
3289 if (Function *F = CI.getCalledFunction())
3290 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
3292 case Intrinsic::dbg_declare:
3293 Finder.processDeclare(*M, cast<DbgDeclareInst>(&CI));
3295 case Intrinsic::dbg_value:
3296 Finder.processValue(*M, cast<DbgValueInst>(&CI));
3303 //===----------------------------------------------------------------------===//
3304 // Implement the public interfaces to this file...
3305 //===----------------------------------------------------------------------===//
3307 bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
3308 Function &F = const_cast<Function &>(f);
3309 assert(!F.isDeclaration() && "Cannot verify external functions");
3311 raw_null_ostream NullStr;
3312 Verifier V(OS ? *OS : NullStr);
3314 // Note that this function's return value is inverted from what you would
3315 // expect of a function called "verify".
3316 return !V.verify(F);
3319 bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
3320 raw_null_ostream NullStr;
3321 Verifier V(OS ? *OS : NullStr);
3323 bool Broken = false;
3324 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
3325 if (!I->isDeclaration() && !I->isMaterializable())
3326 Broken |= !V.verify(*I);
3328 // Note that this function's return value is inverted from what you would
3329 // expect of a function called "verify".
3330 return !V.verify(M) || Broken;
3334 struct VerifierLegacyPass : public FunctionPass {
3340 VerifierLegacyPass() : FunctionPass(ID), V(dbgs()), FatalErrors(true) {
3341 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3343 explicit VerifierLegacyPass(bool FatalErrors)
3344 : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
3345 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3348 bool runOnFunction(Function &F) override {
3349 if (!V.verify(F) && FatalErrors)
3350 report_fatal_error("Broken function found, compilation aborted!");
3355 bool doFinalization(Module &M) override {
3356 if (!V.verify(M) && FatalErrors)
3357 report_fatal_error("Broken module found, compilation aborted!");
3362 void getAnalysisUsage(AnalysisUsage &AU) const override {
3363 AU.setPreservesAll();
3368 char VerifierLegacyPass::ID = 0;
3369 INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
3371 FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
3372 return new VerifierLegacyPass(FatalErrors);
3375 PreservedAnalyses VerifierPass::run(Module &M) {
3376 if (verifyModule(M, &dbgs()) && FatalErrors)
3377 report_fatal_error("Broken module found, compilation aborted!");
3379 return PreservedAnalyses::all();
3382 PreservedAnalyses VerifierPass::run(Function &F) {
3383 if (verifyFunction(F, &dbgs()) && FatalErrors)
3384 report_fatal_error("Broken function found, compilation aborted!");
3386 return PreservedAnalyses::all();