1 //===-- Verifier.cpp - Implement the Module Verifier -----------------------==//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the function verifier interface, that can be used for some
11 // sanity checking of input to the system.
13 // Note that this does not provide full `Java style' security and verifications,
14 // instead it just tries to ensure that code is well-formed.
16 // * Both of a binary operator's parameters are of the same type
17 // * Verify that the indices of mem access instructions match other operands
18 // * Verify that arithmetic and other things are only performed on first-class
19 // types. Verify that shifts & logicals only happen on integrals f.e.
20 // * All of the constants in a switch statement are of the correct type
21 // * The code is in valid SSA form
22 // * It should be illegal to put a label into any other type (like a structure)
23 // or to return one. [except constant arrays!]
24 // * Only phi nodes can be self referential: 'add i32 %0, %0 ; <int>:0' is bad
25 // * PHI nodes must have an entry for each predecessor, with no extras.
26 // * PHI nodes must be the first thing in a basic block, all grouped together
27 // * PHI nodes must have at least one entry
28 // * All basic blocks should only end with terminator insts, not contain them
29 // * The entry node to a function must not have predecessors
30 // * All Instructions must be embedded into a basic block
31 // * Functions cannot take a void-typed parameter
32 // * Verify that a function's argument list agrees with it's declared type.
33 // * It is illegal to specify a name for a void value.
34 // * It is illegal to have a internal global value with no initializer
35 // * It is illegal to have a ret instruction that returns a value that does not
36 // agree with the function return value type.
37 // * Function call argument types match the function prototype
38 // * A landing pad is defined by a landingpad instruction, and can be jumped to
39 // only by the unwind edge of an invoke instruction.
40 // * A landingpad instruction must be the first non-PHI instruction in the
42 // * All landingpad instructions must use the same personality function with
44 // * All other things that are tested by asserts spread about the code...
46 //===----------------------------------------------------------------------===//
48 #include "llvm/IR/Verifier.h"
49 #include "llvm/ADT/STLExtras.h"
50 #include "llvm/ADT/SetVector.h"
51 #include "llvm/ADT/SmallPtrSet.h"
52 #include "llvm/ADT/SmallVector.h"
53 #include "llvm/ADT/StringExtras.h"
54 #include "llvm/IR/CFG.h"
55 #include "llvm/IR/CallSite.h"
56 #include "llvm/IR/CallingConv.h"
57 #include "llvm/IR/ConstantRange.h"
58 #include "llvm/IR/Constants.h"
59 #include "llvm/IR/DataLayout.h"
60 #include "llvm/IR/DebugInfo.h"
61 #include "llvm/IR/DerivedTypes.h"
62 #include "llvm/IR/Dominators.h"
63 #include "llvm/IR/InlineAsm.h"
64 #include "llvm/IR/InstIterator.h"
65 #include "llvm/IR/InstVisitor.h"
66 #include "llvm/IR/IntrinsicInst.h"
67 #include "llvm/IR/LLVMContext.h"
68 #include "llvm/IR/Metadata.h"
69 #include "llvm/IR/Module.h"
70 #include "llvm/IR/PassManager.h"
71 #include "llvm/IR/Statepoint.h"
72 #include "llvm/Pass.h"
73 #include "llvm/Support/CommandLine.h"
74 #include "llvm/Support/Debug.h"
75 #include "llvm/Support/ErrorHandling.h"
76 #include "llvm/Support/raw_ostream.h"
81 static cl::opt<bool> VerifyDebugInfo("verify-debug-info", cl::init(true));
84 struct VerifierSupport {
88 /// \brief Track the brokenness of the module while recursively visiting.
91 explicit VerifierSupport(raw_ostream &OS)
92 : OS(OS), M(nullptr), Broken(false) {}
95 void Write(const Value *V) {
98 if (isa<Instruction>(V)) {
101 V->printAsOperand(OS, true, M);
105 void Write(ImmutableCallSite CS) {
106 Write(CS.getInstruction());
109 void Write(const Metadata *MD) {
116 template <class T> void Write(const MDTupleTypedArrayWrapper<T> &MD) {
120 void Write(const NamedMDNode *NMD) {
127 void Write(Type *T) {
133 void Write(const Comdat *C) {
139 template <typename T1, typename... Ts>
140 void WriteTs(const T1 &V1, const Ts &... Vs) {
145 template <typename... Ts> void WriteTs() {}
148 /// \brief A check failed, so printout out the condition and the message.
150 /// This provides a nice place to put a breakpoint if you want to see why
151 /// something is not correct.
152 void CheckFailed(const Twine &Message) {
153 OS << Message << '\n';
157 /// \brief A check failed (with values to print).
159 /// This calls the Message-only version so that the above is easier to set a
161 template <typename T1, typename... Ts>
162 void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) {
163 CheckFailed(Message);
168 class Verifier : public InstVisitor<Verifier>, VerifierSupport {
169 friend class InstVisitor<Verifier>;
171 LLVMContext *Context;
174 /// \brief When verifying a basic block, keep track of all of the
175 /// instructions we have seen so far.
177 /// This allows us to do efficient dominance checks for the case when an
178 /// instruction has an operand that is an instruction in the same block.
179 SmallPtrSet<Instruction *, 16> InstsInThisBlock;
181 /// \brief Keep track of the metadata nodes that have been checked already.
182 SmallPtrSet<const Metadata *, 32> MDNodes;
184 /// \brief Track unresolved string-based type references.
185 SmallDenseMap<const MDString *, const MDNode *, 32> UnresolvedTypeRefs;
187 /// \brief The result type for a landingpad.
188 Type *LandingPadResultTy;
190 /// \brief Whether we've seen a call to @llvm.localescape in this function
194 /// Stores the count of how many objects were passed to llvm.localescape for a
195 /// given function and the largest index passed to llvm.localrecover.
196 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
199 explicit Verifier(raw_ostream &OS)
200 : VerifierSupport(OS), Context(nullptr), LandingPadResultTy(nullptr),
201 SawFrameEscape(false) {}
203 bool verify(const Function &F) {
205 Context = &M->getContext();
207 // First ensure the function is well-enough formed to compute dominance
210 OS << "Function '" << F.getName()
211 << "' does not contain an entry block!\n";
214 for (Function::const_iterator I = F.begin(), E = F.end(); I != E; ++I) {
215 if (I->empty() || !I->back().isTerminator()) {
216 OS << "Basic Block in function '" << F.getName()
217 << "' does not have terminator!\n";
218 I->printAsOperand(OS, true);
224 // Now directly compute a dominance tree. We don't rely on the pass
225 // manager to provide this as it isolates us from a potentially
226 // out-of-date dominator tree and makes it significantly more complex to
227 // run this code outside of a pass manager.
228 // FIXME: It's really gross that we have to cast away constness here.
229 DT.recalculate(const_cast<Function &>(F));
232 // FIXME: We strip const here because the inst visitor strips const.
233 visit(const_cast<Function &>(F));
234 InstsInThisBlock.clear();
235 LandingPadResultTy = nullptr;
236 SawFrameEscape = false;
241 bool verify(const Module &M) {
243 Context = &M.getContext();
246 // Scan through, checking all of the external function's linkage now...
247 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
248 visitGlobalValue(*I);
250 // Check to make sure function prototypes are okay.
251 if (I->isDeclaration())
255 // Now that we've visited every function, verify that we never asked to
256 // recover a frame index that wasn't escaped.
257 verifyFrameRecoverIndices();
259 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
261 visitGlobalVariable(*I);
263 for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
265 visitGlobalAlias(*I);
267 for (Module::const_named_metadata_iterator I = M.named_metadata_begin(),
268 E = M.named_metadata_end();
270 visitNamedMDNode(*I);
272 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
273 visitComdat(SMEC.getValue());
276 visitModuleIdents(M);
278 // Verify type referneces last.
285 // Verification methods...
286 void visitGlobalValue(const GlobalValue &GV);
287 void visitGlobalVariable(const GlobalVariable &GV);
288 void visitGlobalAlias(const GlobalAlias &GA);
289 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
290 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
291 const GlobalAlias &A, const Constant &C);
292 void visitNamedMDNode(const NamedMDNode &NMD);
293 void visitMDNode(const MDNode &MD);
294 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
295 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
296 void visitComdat(const Comdat &C);
297 void visitModuleIdents(const Module &M);
298 void visitModuleFlags(const Module &M);
299 void visitModuleFlag(const MDNode *Op,
300 DenseMap<const MDString *, const MDNode *> &SeenIDs,
301 SmallVectorImpl<const MDNode *> &Requirements);
302 void visitFunction(const Function &F);
303 void visitBasicBlock(BasicBlock &BB);
304 void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty);
306 template <class Ty> bool isValidMetadataArray(const MDTuple &N);
307 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
308 #include "llvm/IR/Metadata.def"
309 void visitDIScope(const DIScope &N);
310 void visitDIVariable(const DIVariable &N);
311 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
312 void visitDITemplateParameter(const DITemplateParameter &N);
314 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
316 /// \brief Check for a valid string-based type reference.
318 /// Checks if \c MD is a string-based type reference. If it is, keeps track
319 /// of it (and its user, \c N) for error messages later.
320 bool isValidUUID(const MDNode &N, const Metadata *MD);
322 /// \brief Check for a valid type reference.
324 /// Checks for subclasses of \a DIType, or \a isValidUUID().
325 bool isTypeRef(const MDNode &N, const Metadata *MD);
327 /// \brief Check for a valid scope reference.
329 /// Checks for subclasses of \a DIScope, or \a isValidUUID().
330 bool isScopeRef(const MDNode &N, const Metadata *MD);
332 /// \brief Check for a valid debug info reference.
334 /// Checks for subclasses of \a DINode, or \a isValidUUID().
335 bool isDIRef(const MDNode &N, const Metadata *MD);
337 // InstVisitor overrides...
338 using InstVisitor<Verifier>::visit;
339 void visit(Instruction &I);
341 void visitTruncInst(TruncInst &I);
342 void visitZExtInst(ZExtInst &I);
343 void visitSExtInst(SExtInst &I);
344 void visitFPTruncInst(FPTruncInst &I);
345 void visitFPExtInst(FPExtInst &I);
346 void visitFPToUIInst(FPToUIInst &I);
347 void visitFPToSIInst(FPToSIInst &I);
348 void visitUIToFPInst(UIToFPInst &I);
349 void visitSIToFPInst(SIToFPInst &I);
350 void visitIntToPtrInst(IntToPtrInst &I);
351 void visitPtrToIntInst(PtrToIntInst &I);
352 void visitBitCastInst(BitCastInst &I);
353 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
354 void visitPHINode(PHINode &PN);
355 void visitBinaryOperator(BinaryOperator &B);
356 void visitICmpInst(ICmpInst &IC);
357 void visitFCmpInst(FCmpInst &FC);
358 void visitExtractElementInst(ExtractElementInst &EI);
359 void visitInsertElementInst(InsertElementInst &EI);
360 void visitShuffleVectorInst(ShuffleVectorInst &EI);
361 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
362 void visitCallInst(CallInst &CI);
363 void visitInvokeInst(InvokeInst &II);
364 void visitGetElementPtrInst(GetElementPtrInst &GEP);
365 void visitLoadInst(LoadInst &LI);
366 void visitStoreInst(StoreInst &SI);
367 void verifyDominatesUse(Instruction &I, unsigned i);
368 void visitInstruction(Instruction &I);
369 void visitTerminatorInst(TerminatorInst &I);
370 void visitBranchInst(BranchInst &BI);
371 void visitReturnInst(ReturnInst &RI);
372 void visitSwitchInst(SwitchInst &SI);
373 void visitIndirectBrInst(IndirectBrInst &BI);
374 void visitSelectInst(SelectInst &SI);
375 void visitUserOp1(Instruction &I);
376 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
377 void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS);
378 template <class DbgIntrinsicTy>
379 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
380 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
381 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
382 void visitFenceInst(FenceInst &FI);
383 void visitAllocaInst(AllocaInst &AI);
384 void visitExtractValueInst(ExtractValueInst &EVI);
385 void visitInsertValueInst(InsertValueInst &IVI);
386 void visitEHPadPredecessors(Instruction &I);
387 void visitLandingPadInst(LandingPadInst &LPI);
388 void visitCatchPadInst(CatchPadInst &CPI);
389 void visitCatchEndPadInst(CatchEndPadInst &CEPI);
390 void visitCleanupPadInst(CleanupPadInst &CPI);
391 void visitCleanupEndPadInst(CleanupEndPadInst &CEPI);
392 void visitCleanupReturnInst(CleanupReturnInst &CRI);
393 void visitTerminatePadInst(TerminatePadInst &TPI);
395 void VerifyCallSite(CallSite CS);
396 void verifyMustTailCall(CallInst &CI);
397 bool PerformTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
398 unsigned ArgNo, std::string &Suffix);
399 bool VerifyIntrinsicType(Type *Ty, ArrayRef<Intrinsic::IITDescriptor> &Infos,
400 SmallVectorImpl<Type *> &ArgTys);
401 bool VerifyIntrinsicIsVarArg(bool isVarArg,
402 ArrayRef<Intrinsic::IITDescriptor> &Infos);
403 bool VerifyAttributeCount(AttributeSet Attrs, unsigned Params);
404 void VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
406 void VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
407 bool isReturnValue, const Value *V);
408 void VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
410 void VerifyFunctionMetadata(
411 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs);
413 void VerifyConstantExprBitcastType(const ConstantExpr *CE);
414 void VerifyStatepoint(ImmutableCallSite CS);
415 void verifyFrameRecoverIndices();
417 // Module-level debug info verification...
418 void verifyTypeRefs();
419 template <class MapTy>
420 void verifyBitPieceExpression(const DbgInfoIntrinsic &I,
421 const MapTy &TypeRefs);
422 void visitUnresolvedTypeRef(const MDString *S, const MDNode *N);
424 } // End anonymous namespace
426 // Assert - We know that cond should be true, if not print an error message.
427 #define Assert(C, ...) \
428 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0)
430 void Verifier::visit(Instruction &I) {
431 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
432 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
433 InstVisitor<Verifier>::visit(I);
437 void Verifier::visitGlobalValue(const GlobalValue &GV) {
438 Assert(!GV.isDeclaration() || GV.hasExternalLinkage() ||
439 GV.hasExternalWeakLinkage(),
440 "Global is external, but doesn't have external or weak linkage!", &GV);
442 Assert(GV.getAlignment() <= Value::MaximumAlignment,
443 "huge alignment values are unsupported", &GV);
444 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
445 "Only global variables can have appending linkage!", &GV);
447 if (GV.hasAppendingLinkage()) {
448 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
449 Assert(GVar && GVar->getValueType()->isArrayTy(),
450 "Only global arrays can have appending linkage!", GVar);
453 if (GV.isDeclarationForLinker())
454 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
457 void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
458 if (GV.hasInitializer()) {
459 Assert(GV.getInitializer()->getType() == GV.getType()->getElementType(),
460 "Global variable initializer type does not match global "
464 // If the global has common linkage, it must have a zero initializer and
465 // cannot be constant.
466 if (GV.hasCommonLinkage()) {
467 Assert(GV.getInitializer()->isNullValue(),
468 "'common' global must have a zero initializer!", &GV);
469 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
471 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
474 Assert(GV.hasExternalLinkage() || GV.hasExternalWeakLinkage(),
475 "invalid linkage type for global declaration", &GV);
478 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
479 GV.getName() == "llvm.global_dtors")) {
480 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
481 "invalid linkage for intrinsic global variable", &GV);
482 // Don't worry about emitting an error for it not being an array,
483 // visitGlobalValue will complain on appending non-array.
484 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
485 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
486 PointerType *FuncPtrTy =
487 FunctionType::get(Type::getVoidTy(*Context), false)->getPointerTo();
488 // FIXME: Reject the 2-field form in LLVM 4.0.
490 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
491 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
492 STy->getTypeAtIndex(1) == FuncPtrTy,
493 "wrong type for intrinsic global variable", &GV);
494 if (STy->getNumElements() == 3) {
495 Type *ETy = STy->getTypeAtIndex(2);
496 Assert(ETy->isPointerTy() &&
497 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
498 "wrong type for intrinsic global variable", &GV);
503 if (GV.hasName() && (GV.getName() == "llvm.used" ||
504 GV.getName() == "llvm.compiler.used")) {
505 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
506 "invalid linkage for intrinsic global variable", &GV);
507 Type *GVType = GV.getValueType();
508 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
509 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
510 Assert(PTy, "wrong type for intrinsic global variable", &GV);
511 if (GV.hasInitializer()) {
512 const Constant *Init = GV.getInitializer();
513 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
514 Assert(InitArray, "wrong initalizer for intrinsic global variable",
516 for (unsigned i = 0, e = InitArray->getNumOperands(); i != e; ++i) {
517 Value *V = Init->getOperand(i)->stripPointerCastsNoFollowAliases();
518 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
520 "invalid llvm.used member", V);
521 Assert(V->hasName(), "members of llvm.used must be named", V);
527 Assert(!GV.hasDLLImportStorageClass() ||
528 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
529 GV.hasAvailableExternallyLinkage(),
530 "Global is marked as dllimport, but not external", &GV);
532 if (!GV.hasInitializer()) {
533 visitGlobalValue(GV);
537 // Walk any aggregate initializers looking for bitcasts between address spaces
538 SmallPtrSet<const Value *, 4> Visited;
539 SmallVector<const Value *, 4> WorkStack;
540 WorkStack.push_back(cast<Value>(GV.getInitializer()));
542 while (!WorkStack.empty()) {
543 const Value *V = WorkStack.pop_back_val();
544 if (!Visited.insert(V).second)
547 if (const User *U = dyn_cast<User>(V)) {
548 WorkStack.append(U->op_begin(), U->op_end());
551 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
552 VerifyConstantExprBitcastType(CE);
558 visitGlobalValue(GV);
561 void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
562 SmallPtrSet<const GlobalAlias*, 4> Visited;
564 visitAliaseeSubExpr(Visited, GA, C);
567 void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
568 const GlobalAlias &GA, const Constant &C) {
569 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
570 Assert(!GV->isDeclaration(), "Alias must point to a definition", &GA);
572 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
573 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
575 Assert(!GA2->mayBeOverridden(), "Alias cannot point to a weak alias",
578 // Only continue verifying subexpressions of GlobalAliases.
579 // Do not recurse into global initializers.
584 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
585 VerifyConstantExprBitcastType(CE);
587 for (const Use &U : C.operands()) {
589 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
590 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
591 else if (const auto *C2 = dyn_cast<Constant>(V))
592 visitAliaseeSubExpr(Visited, GA, *C2);
596 void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
597 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
598 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
599 "weak_odr, or external linkage!",
601 const Constant *Aliasee = GA.getAliasee();
602 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
603 Assert(GA.getType() == Aliasee->getType(),
604 "Alias and aliasee types should match!", &GA);
606 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
607 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
609 visitAliaseeSubExpr(GA, *Aliasee);
611 visitGlobalValue(GA);
614 void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
615 for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i) {
616 MDNode *MD = NMD.getOperand(i);
618 if (NMD.getName() == "llvm.dbg.cu") {
619 Assert(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
629 void Verifier::visitMDNode(const MDNode &MD) {
630 // Only visit each node once. Metadata can be mutually recursive, so this
631 // avoids infinite recursion here, as well as being an optimization.
632 if (!MDNodes.insert(&MD).second)
635 switch (MD.getMetadataID()) {
637 llvm_unreachable("Invalid MDNode subclass");
638 case Metadata::MDTupleKind:
640 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
641 case Metadata::CLASS##Kind: \
642 visit##CLASS(cast<CLASS>(MD)); \
644 #include "llvm/IR/Metadata.def"
647 for (unsigned i = 0, e = MD.getNumOperands(); i != e; ++i) {
648 Metadata *Op = MD.getOperand(i);
651 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
653 if (auto *N = dyn_cast<MDNode>(Op)) {
657 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
658 visitValueAsMetadata(*V, nullptr);
663 // Check these last, so we diagnose problems in operands first.
664 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
665 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
668 void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
669 Assert(MD.getValue(), "Expected valid value", &MD);
670 Assert(!MD.getValue()->getType()->isMetadataTy(),
671 "Unexpected metadata round-trip through values", &MD, MD.getValue());
673 auto *L = dyn_cast<LocalAsMetadata>(&MD);
677 Assert(F, "function-local metadata used outside a function", L);
679 // If this was an instruction, bb, or argument, verify that it is in the
680 // function that we expect.
681 Function *ActualF = nullptr;
682 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
683 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
684 ActualF = I->getParent()->getParent();
685 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
686 ActualF = BB->getParent();
687 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
688 ActualF = A->getParent();
689 assert(ActualF && "Unimplemented function local metadata case!");
691 Assert(ActualF == F, "function-local metadata used in wrong function", L);
694 void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
695 Metadata *MD = MDV.getMetadata();
696 if (auto *N = dyn_cast<MDNode>(MD)) {
701 // Only visit each node once. Metadata can be mutually recursive, so this
702 // avoids infinite recursion here, as well as being an optimization.
703 if (!MDNodes.insert(MD).second)
706 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
707 visitValueAsMetadata(*V, F);
710 bool Verifier::isValidUUID(const MDNode &N, const Metadata *MD) {
711 auto *S = dyn_cast<MDString>(MD);
714 if (S->getString().empty())
717 // Keep track of names of types referenced via UUID so we can check that they
719 UnresolvedTypeRefs.insert(std::make_pair(S, &N));
723 /// \brief Check if a value can be a reference to a type.
724 bool Verifier::isTypeRef(const MDNode &N, const Metadata *MD) {
725 return !MD || isValidUUID(N, MD) || isa<DIType>(MD);
728 /// \brief Check if a value can be a ScopeRef.
729 bool Verifier::isScopeRef(const MDNode &N, const Metadata *MD) {
730 return !MD || isValidUUID(N, MD) || isa<DIScope>(MD);
733 /// \brief Check if a value can be a debug info ref.
734 bool Verifier::isDIRef(const MDNode &N, const Metadata *MD) {
735 return !MD || isValidUUID(N, MD) || isa<DINode>(MD);
739 bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
740 for (Metadata *MD : N.operands()) {
753 bool isValidMetadataArray(const MDTuple &N) {
754 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
758 bool isValidMetadataNullArray(const MDTuple &N) {
759 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
762 void Verifier::visitDILocation(const DILocation &N) {
763 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
764 "location requires a valid scope", &N, N.getRawScope());
765 if (auto *IA = N.getRawInlinedAt())
766 Assert(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
769 void Verifier::visitGenericDINode(const GenericDINode &N) {
770 Assert(N.getTag(), "invalid tag", &N);
773 void Verifier::visitDIScope(const DIScope &N) {
774 if (auto *F = N.getRawFile())
775 Assert(isa<DIFile>(F), "invalid file", &N, F);
778 void Verifier::visitDISubrange(const DISubrange &N) {
779 Assert(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
780 Assert(N.getCount() >= -1, "invalid subrange count", &N);
783 void Verifier::visitDIEnumerator(const DIEnumerator &N) {
784 Assert(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
787 void Verifier::visitDIBasicType(const DIBasicType &N) {
788 Assert(N.getTag() == dwarf::DW_TAG_base_type ||
789 N.getTag() == dwarf::DW_TAG_unspecified_type,
793 void Verifier::visitDIDerivedType(const DIDerivedType &N) {
794 // Common scope checks.
797 Assert(N.getTag() == dwarf::DW_TAG_typedef ||
798 N.getTag() == dwarf::DW_TAG_pointer_type ||
799 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
800 N.getTag() == dwarf::DW_TAG_reference_type ||
801 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
802 N.getTag() == dwarf::DW_TAG_const_type ||
803 N.getTag() == dwarf::DW_TAG_volatile_type ||
804 N.getTag() == dwarf::DW_TAG_restrict_type ||
805 N.getTag() == dwarf::DW_TAG_member ||
806 N.getTag() == dwarf::DW_TAG_inheritance ||
807 N.getTag() == dwarf::DW_TAG_friend,
809 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
810 Assert(isTypeRef(N, N.getExtraData()), "invalid pointer to member type", &N,
814 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
815 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
819 static bool hasConflictingReferenceFlags(unsigned Flags) {
820 return (Flags & DINode::FlagLValueReference) &&
821 (Flags & DINode::FlagRValueReference);
824 void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
825 auto *Params = dyn_cast<MDTuple>(&RawParams);
826 Assert(Params, "invalid template params", &N, &RawParams);
827 for (Metadata *Op : Params->operands()) {
828 Assert(Op && isa<DITemplateParameter>(Op), "invalid template parameter", &N,
833 void Verifier::visitDICompositeType(const DICompositeType &N) {
834 // Common scope checks.
837 Assert(N.getTag() == dwarf::DW_TAG_array_type ||
838 N.getTag() == dwarf::DW_TAG_structure_type ||
839 N.getTag() == dwarf::DW_TAG_union_type ||
840 N.getTag() == dwarf::DW_TAG_enumeration_type ||
841 N.getTag() == dwarf::DW_TAG_class_type,
844 Assert(isScopeRef(N, N.getScope()), "invalid scope", &N, N.getScope());
845 Assert(isTypeRef(N, N.getBaseType()), "invalid base type", &N,
848 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
849 "invalid composite elements", &N, N.getRawElements());
850 Assert(isTypeRef(N, N.getRawVTableHolder()), "invalid vtable holder", &N,
851 N.getRawVTableHolder());
852 Assert(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
853 "invalid composite elements", &N, N.getRawElements());
854 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
856 if (auto *Params = N.getRawTemplateParams())
857 visitTemplateParams(N, *Params);
859 if (N.getTag() == dwarf::DW_TAG_class_type ||
860 N.getTag() == dwarf::DW_TAG_union_type) {
861 Assert(N.getFile() && !N.getFile()->getFilename().empty(),
862 "class/union requires a filename", &N, N.getFile());
866 void Verifier::visitDISubroutineType(const DISubroutineType &N) {
867 Assert(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
868 if (auto *Types = N.getRawTypeArray()) {
869 Assert(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
870 for (Metadata *Ty : N.getTypeArray()->operands()) {
871 Assert(isTypeRef(N, Ty), "invalid subroutine type ref", &N, Types, Ty);
874 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
878 void Verifier::visitDIFile(const DIFile &N) {
879 Assert(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
882 void Verifier::visitDICompileUnit(const DICompileUnit &N) {
883 Assert(N.isDistinct(), "compile units must be distinct", &N);
884 Assert(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
886 // Don't bother verifying the compilation directory or producer string
887 // as those could be empty.
888 Assert(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
890 Assert(!N.getFile()->getFilename().empty(), "invalid filename", &N,
893 if (auto *Array = N.getRawEnumTypes()) {
894 Assert(isa<MDTuple>(Array), "invalid enum list", &N, Array);
895 for (Metadata *Op : N.getEnumTypes()->operands()) {
896 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
897 Assert(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
898 "invalid enum type", &N, N.getEnumTypes(), Op);
901 if (auto *Array = N.getRawRetainedTypes()) {
902 Assert(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
903 for (Metadata *Op : N.getRetainedTypes()->operands()) {
904 Assert(Op && isa<DIType>(Op), "invalid retained type", &N, Op);
907 if (auto *Array = N.getRawSubprograms()) {
908 Assert(isa<MDTuple>(Array), "invalid subprogram list", &N, Array);
909 for (Metadata *Op : N.getSubprograms()->operands()) {
910 Assert(Op && isa<DISubprogram>(Op), "invalid subprogram ref", &N, Op);
913 if (auto *Array = N.getRawGlobalVariables()) {
914 Assert(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
915 for (Metadata *Op : N.getGlobalVariables()->operands()) {
916 Assert(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref", &N,
920 if (auto *Array = N.getRawImportedEntities()) {
921 Assert(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
922 for (Metadata *Op : N.getImportedEntities()->operands()) {
923 Assert(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref", &N,
929 void Verifier::visitDISubprogram(const DISubprogram &N) {
930 Assert(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
931 Assert(isScopeRef(N, N.getRawScope()), "invalid scope", &N, N.getRawScope());
932 if (auto *T = N.getRawType())
933 Assert(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
934 Assert(isTypeRef(N, N.getRawContainingType()), "invalid containing type", &N,
935 N.getRawContainingType());
936 if (auto *RawF = N.getRawFunction()) {
937 auto *FMD = dyn_cast<ConstantAsMetadata>(RawF);
938 auto *F = FMD ? FMD->getValue() : nullptr;
939 auto *FT = F ? dyn_cast<PointerType>(F->getType()) : nullptr;
940 Assert(F && FT && isa<FunctionType>(FT->getElementType()),
941 "invalid function", &N, F, FT);
943 if (auto *Params = N.getRawTemplateParams())
944 visitTemplateParams(N, *Params);
945 if (auto *S = N.getRawDeclaration()) {
946 Assert(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
947 "invalid subprogram declaration", &N, S);
949 if (auto *RawVars = N.getRawVariables()) {
950 auto *Vars = dyn_cast<MDTuple>(RawVars);
951 Assert(Vars, "invalid variable list", &N, RawVars);
952 for (Metadata *Op : Vars->operands()) {
953 Assert(Op && isa<DILocalVariable>(Op), "invalid local variable", &N, Vars,
957 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags",
960 if (N.isDefinition())
961 Assert(N.isDistinct(), "subprogram definitions must be distinct", &N);
963 auto *F = N.getFunction();
967 // Check that all !dbg attachments lead to back to N (or, at least, another
968 // subprogram that describes the same function).
970 // FIXME: Check this incrementally while visiting !dbg attachments.
971 // FIXME: Only check when N is the canonical subprogram for F.
972 SmallPtrSet<const MDNode *, 32> Seen;
975 // Be careful about using DILocation here since we might be dealing with
976 // broken code (this is the Verifier after all).
978 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
981 if (!Seen.insert(DL).second)
984 DILocalScope *Scope = DL->getInlinedAtScope();
985 if (Scope && !Seen.insert(Scope).second)
988 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
989 if (SP && !Seen.insert(SP).second)
992 // FIXME: Once N is canonical, check "SP == &N".
993 Assert(SP->describes(F),
994 "!dbg attachment points at wrong subprogram for function", &N, F,
999 void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
1000 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
1001 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1002 "invalid local scope", &N, N.getRawScope());
1005 void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1006 visitDILexicalBlockBase(N);
1008 Assert(N.getLine() || !N.getColumn(),
1009 "cannot have column info without line info", &N);
1012 void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1013 visitDILexicalBlockBase(N);
1016 void Verifier::visitDINamespace(const DINamespace &N) {
1017 Assert(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
1018 if (auto *S = N.getRawScope())
1019 Assert(isa<DIScope>(S), "invalid scope ref", &N, S);
1022 void Verifier::visitDIModule(const DIModule &N) {
1023 Assert(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1024 Assert(!N.getName().empty(), "anonymous module", &N);
1027 void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
1028 Assert(isTypeRef(N, N.getType()), "invalid type ref", &N, N.getType());
1031 void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1032 visitDITemplateParameter(N);
1034 Assert(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1038 void Verifier::visitDITemplateValueParameter(
1039 const DITemplateValueParameter &N) {
1040 visitDITemplateParameter(N);
1042 Assert(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1043 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1044 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1048 void Verifier::visitDIVariable(const DIVariable &N) {
1049 if (auto *S = N.getRawScope())
1050 Assert(isa<DIScope>(S), "invalid scope", &N, S);
1051 Assert(isTypeRef(N, N.getRawType()), "invalid type ref", &N, N.getRawType());
1052 if (auto *F = N.getRawFile())
1053 Assert(isa<DIFile>(F), "invalid file", &N, F);
1056 void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
1057 // Checks common to all variables.
1060 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1061 Assert(!N.getName().empty(), "missing global variable name", &N);
1062 if (auto *V = N.getRawVariable()) {
1063 Assert(isa<ConstantAsMetadata>(V) &&
1064 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
1065 "invalid global varaible ref", &N, V);
1067 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
1068 Assert(isa<DIDerivedType>(Member), "invalid static data member declaration",
1073 void Verifier::visitDILocalVariable(const DILocalVariable &N) {
1074 // Checks common to all variables.
1077 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1078 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1079 "local variable requires a valid scope", &N, N.getRawScope());
1082 void Verifier::visitDIExpression(const DIExpression &N) {
1083 Assert(N.isValid(), "invalid expression", &N);
1086 void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
1087 Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
1088 if (auto *T = N.getRawType())
1089 Assert(isTypeRef(N, T), "invalid type ref", &N, T);
1090 if (auto *F = N.getRawFile())
1091 Assert(isa<DIFile>(F), "invalid file", &N, F);
1094 void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
1095 Assert(N.getTag() == dwarf::DW_TAG_imported_module ||
1096 N.getTag() == dwarf::DW_TAG_imported_declaration,
1098 if (auto *S = N.getRawScope())
1099 Assert(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1100 Assert(isDIRef(N, N.getEntity()), "invalid imported entity", &N,
1104 void Verifier::visitComdat(const Comdat &C) {
1105 // The Module is invalid if the GlobalValue has private linkage. Entities
1106 // with private linkage don't have entries in the symbol table.
1107 if (const GlobalValue *GV = M->getNamedValue(C.getName()))
1108 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1112 void Verifier::visitModuleIdents(const Module &M) {
1113 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1117 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1118 // Scan each llvm.ident entry and make sure that this requirement is met.
1119 for (unsigned i = 0, e = Idents->getNumOperands(); i != e; ++i) {
1120 const MDNode *N = Idents->getOperand(i);
1121 Assert(N->getNumOperands() == 1,
1122 "incorrect number of operands in llvm.ident metadata", N);
1123 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1124 ("invalid value for llvm.ident metadata entry operand"
1125 "(the operand should be a string)"),
1130 void Verifier::visitModuleFlags(const Module &M) {
1131 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1134 // Scan each flag, and track the flags and requirements.
1135 DenseMap<const MDString*, const MDNode*> SeenIDs;
1136 SmallVector<const MDNode*, 16> Requirements;
1137 for (unsigned I = 0, E = Flags->getNumOperands(); I != E; ++I) {
1138 visitModuleFlag(Flags->getOperand(I), SeenIDs, Requirements);
1141 // Validate that the requirements in the module are valid.
1142 for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
1143 const MDNode *Requirement = Requirements[I];
1144 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
1145 const Metadata *ReqValue = Requirement->getOperand(1);
1147 const MDNode *Op = SeenIDs.lookup(Flag);
1149 CheckFailed("invalid requirement on flag, flag is not present in module",
1154 if (Op->getOperand(2) != ReqValue) {
1155 CheckFailed(("invalid requirement on flag, "
1156 "flag does not have the required value"),
1164 Verifier::visitModuleFlag(const MDNode *Op,
1165 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1166 SmallVectorImpl<const MDNode *> &Requirements) {
1167 // Each module flag should have three arguments, the merge behavior (a
1168 // constant int), the flag ID (an MDString), and the value.
1169 Assert(Op->getNumOperands() == 3,
1170 "incorrect number of operands in module flag", Op);
1171 Module::ModFlagBehavior MFB;
1172 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
1174 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
1175 "invalid behavior operand in module flag (expected constant integer)",
1178 "invalid behavior operand in module flag (unexpected constant)",
1181 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
1182 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1185 // Sanity check the values for behaviors with additional requirements.
1188 case Module::Warning:
1189 case Module::Override:
1190 // These behavior types accept any value.
1193 case Module::Require: {
1194 // The value should itself be an MDNode with two operands, a flag ID (an
1195 // MDString), and a value.
1196 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
1197 Assert(Value && Value->getNumOperands() == 2,
1198 "invalid value for 'require' module flag (expected metadata pair)",
1200 Assert(isa<MDString>(Value->getOperand(0)),
1201 ("invalid value for 'require' module flag "
1202 "(first value operand should be a string)"),
1203 Value->getOperand(0));
1205 // Append it to the list of requirements, to check once all module flags are
1207 Requirements.push_back(Value);
1211 case Module::Append:
1212 case Module::AppendUnique: {
1213 // These behavior types require the operand be an MDNode.
1214 Assert(isa<MDNode>(Op->getOperand(2)),
1215 "invalid value for 'append'-type module flag "
1216 "(expected a metadata node)",
1222 // Unless this is a "requires" flag, check the ID is unique.
1223 if (MFB != Module::Require) {
1224 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
1226 "module flag identifiers must be unique (or of 'require' type)", ID);
1230 void Verifier::VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
1231 bool isFunction, const Value *V) {
1232 unsigned Slot = ~0U;
1233 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1234 if (Attrs.getSlotIndex(I) == Idx) {
1239 assert(Slot != ~0U && "Attribute set inconsistency!");
1241 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1243 if (I->isStringAttribute())
1246 if (I->getKindAsEnum() == Attribute::NoReturn ||
1247 I->getKindAsEnum() == Attribute::NoUnwind ||
1248 I->getKindAsEnum() == Attribute::NoInline ||
1249 I->getKindAsEnum() == Attribute::AlwaysInline ||
1250 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1251 I->getKindAsEnum() == Attribute::StackProtect ||
1252 I->getKindAsEnum() == Attribute::StackProtectReq ||
1253 I->getKindAsEnum() == Attribute::StackProtectStrong ||
1254 I->getKindAsEnum() == Attribute::SafeStack ||
1255 I->getKindAsEnum() == Attribute::NoRedZone ||
1256 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1257 I->getKindAsEnum() == Attribute::Naked ||
1258 I->getKindAsEnum() == Attribute::InlineHint ||
1259 I->getKindAsEnum() == Attribute::StackAlignment ||
1260 I->getKindAsEnum() == Attribute::UWTable ||
1261 I->getKindAsEnum() == Attribute::NonLazyBind ||
1262 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1263 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1264 I->getKindAsEnum() == Attribute::SanitizeThread ||
1265 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1266 I->getKindAsEnum() == Attribute::MinSize ||
1267 I->getKindAsEnum() == Attribute::NoDuplicate ||
1268 I->getKindAsEnum() == Attribute::Builtin ||
1269 I->getKindAsEnum() == Attribute::NoBuiltin ||
1270 I->getKindAsEnum() == Attribute::Cold ||
1271 I->getKindAsEnum() == Attribute::OptimizeNone ||
1272 I->getKindAsEnum() == Attribute::JumpTable ||
1273 I->getKindAsEnum() == Attribute::Convergent ||
1274 I->getKindAsEnum() == Attribute::ArgMemOnly) {
1276 CheckFailed("Attribute '" + I->getAsString() +
1277 "' only applies to functions!", V);
1280 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
1281 I->getKindAsEnum() == Attribute::ReadNone) {
1283 CheckFailed("Attribute '" + I->getAsString() +
1284 "' does not apply to function returns");
1287 } else if (isFunction) {
1288 CheckFailed("Attribute '" + I->getAsString() +
1289 "' does not apply to functions!", V);
1295 // VerifyParameterAttrs - Check the given attributes for an argument or return
1296 // value of the specified type. The value V is printed in error messages.
1297 void Verifier::VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
1298 bool isReturnValue, const Value *V) {
1299 if (!Attrs.hasAttributes(Idx))
1302 VerifyAttributeTypes(Attrs, Idx, false, V);
1305 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1306 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1307 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1308 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1309 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
1310 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1311 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', and "
1312 "'returned' do not apply to return values!",
1315 // Check for mutually incompatible attributes. Only inreg is compatible with
1317 unsigned AttrCount = 0;
1318 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1319 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1320 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1321 Attrs.hasAttribute(Idx, Attribute::InReg);
1322 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
1323 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1324 "and 'sret' are incompatible!",
1327 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1328 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1330 "'inalloca and readonly' are incompatible!",
1333 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1334 Attrs.hasAttribute(Idx, Attribute::Returned)),
1336 "'sret and returned' are incompatible!",
1339 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1340 Attrs.hasAttribute(Idx, Attribute::SExt)),
1342 "'zeroext and signext' are incompatible!",
1345 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1346 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1348 "'readnone and readonly' are incompatible!",
1351 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1352 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1354 "'noinline and alwaysinline' are incompatible!",
1357 Assert(!AttrBuilder(Attrs, Idx)
1358 .overlaps(AttributeFuncs::typeIncompatible(Ty)),
1359 "Wrong types for attribute: " +
1360 AttributeSet::get(*Context, Idx,
1361 AttributeFuncs::typeIncompatible(Ty)).getAsString(Idx),
1364 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
1365 SmallPtrSet<Type*, 4> Visited;
1366 if (!PTy->getElementType()->isSized(&Visited)) {
1367 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1368 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1369 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1373 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1374 "Attribute 'byval' only applies to parameters with pointer type!",
1379 // VerifyFunctionAttrs - Check parameter attributes against a function type.
1380 // The value V is printed in error messages.
1381 void Verifier::VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
1383 if (Attrs.isEmpty())
1386 bool SawNest = false;
1387 bool SawReturned = false;
1388 bool SawSRet = false;
1390 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
1391 unsigned Idx = Attrs.getSlotIndex(i);
1395 Ty = FT->getReturnType();
1396 else if (Idx-1 < FT->getNumParams())
1397 Ty = FT->getParamType(Idx-1);
1399 break; // VarArgs attributes, verified elsewhere.
1401 VerifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
1406 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
1407 Assert(!SawNest, "More than one parameter has attribute nest!", V);
1411 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
1412 Assert(!SawReturned, "More than one parameter has attribute returned!",
1414 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1416 "argument and return types for 'returned' attribute",
1421 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
1422 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1423 Assert(Idx == 1 || Idx == 2,
1424 "Attribute 'sret' is not on first or second parameter!", V);
1428 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
1429 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1434 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1437 VerifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
1440 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1441 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1442 "Attributes 'readnone and readonly' are incompatible!", V);
1445 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1446 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1447 Attribute::AlwaysInline)),
1448 "Attributes 'noinline and alwaysinline' are incompatible!", V);
1450 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1451 Attribute::OptimizeNone)) {
1452 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1453 "Attribute 'optnone' requires 'noinline'!", V);
1455 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1456 Attribute::OptimizeForSize),
1457 "Attributes 'optsize and optnone' are incompatible!", V);
1459 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1460 "Attributes 'minsize and optnone' are incompatible!", V);
1463 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1464 Attribute::JumpTable)) {
1465 const GlobalValue *GV = cast<GlobalValue>(V);
1466 Assert(GV->hasUnnamedAddr(),
1467 "Attribute 'jumptable' requires 'unnamed_addr'", V);
1471 void Verifier::VerifyFunctionMetadata(
1472 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs) {
1476 for (unsigned i = 0; i < MDs.size(); i++) {
1477 if (MDs[i].first == LLVMContext::MD_prof) {
1478 MDNode *MD = MDs[i].second;
1479 Assert(MD->getNumOperands() == 2,
1480 "!prof annotations should have exactly 2 operands", MD);
1482 // Check first operand.
1483 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1485 Assert(isa<MDString>(MD->getOperand(0)),
1486 "expected string with name of the !prof annotation", MD);
1487 MDString *MDS = cast<MDString>(MD->getOperand(0));
1488 StringRef ProfName = MDS->getString();
1489 Assert(ProfName.equals("function_entry_count"),
1490 "first operand should be 'function_entry_count'", MD);
1492 // Check second operand.
1493 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1495 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1496 "expected integer argument to function_entry_count", MD);
1501 void Verifier::VerifyConstantExprBitcastType(const ConstantExpr *CE) {
1502 if (CE->getOpcode() != Instruction::BitCast)
1505 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1507 "Invalid bitcast", CE);
1510 bool Verifier::VerifyAttributeCount(AttributeSet Attrs, unsigned Params) {
1511 if (Attrs.getNumSlots() == 0)
1514 unsigned LastSlot = Attrs.getNumSlots() - 1;
1515 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
1516 if (LastIndex <= Params
1517 || (LastIndex == AttributeSet::FunctionIndex
1518 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
1524 /// \brief Verify that statepoint intrinsic is well formed.
1525 void Verifier::VerifyStatepoint(ImmutableCallSite CS) {
1526 assert(CS.getCalledFunction() &&
1527 CS.getCalledFunction()->getIntrinsicID() ==
1528 Intrinsic::experimental_gc_statepoint);
1530 const Instruction &CI = *CS.getInstruction();
1532 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1533 !CS.onlyAccessesArgMemory(),
1534 "gc.statepoint must read and write all memory to preserve "
1535 "reordering restrictions required by safepoint semantics",
1538 const Value *IDV = CS.getArgument(0);
1539 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1542 const Value *NumPatchBytesV = CS.getArgument(1);
1543 Assert(isa<ConstantInt>(NumPatchBytesV),
1544 "gc.statepoint number of patchable bytes must be a constant integer",
1546 const int64_t NumPatchBytes =
1547 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1548 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1549 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1553 const Value *Target = CS.getArgument(2);
1554 auto *PT = dyn_cast<PointerType>(Target->getType());
1555 Assert(PT && PT->getElementType()->isFunctionTy(),
1556 "gc.statepoint callee must be of function pointer type", &CI, Target);
1557 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
1559 const Value *NumCallArgsV = CS.getArgument(3);
1560 Assert(isa<ConstantInt>(NumCallArgsV),
1561 "gc.statepoint number of arguments to underlying call "
1562 "must be constant integer",
1564 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
1565 Assert(NumCallArgs >= 0,
1566 "gc.statepoint number of arguments to underlying call "
1569 const int NumParams = (int)TargetFuncType->getNumParams();
1570 if (TargetFuncType->isVarArg()) {
1571 Assert(NumCallArgs >= NumParams,
1572 "gc.statepoint mismatch in number of vararg call args", &CI);
1574 // TODO: Remove this limitation
1575 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1576 "gc.statepoint doesn't support wrapping non-void "
1577 "vararg functions yet",
1580 Assert(NumCallArgs == NumParams,
1581 "gc.statepoint mismatch in number of call args", &CI);
1583 const Value *FlagsV = CS.getArgument(4);
1584 Assert(isa<ConstantInt>(FlagsV),
1585 "gc.statepoint flags must be constant integer", &CI);
1586 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1587 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1588 "unknown flag used in gc.statepoint flags argument", &CI);
1590 // Verify that the types of the call parameter arguments match
1591 // the type of the wrapped callee.
1592 for (int i = 0; i < NumParams; i++) {
1593 Type *ParamType = TargetFuncType->getParamType(i);
1594 Type *ArgType = CS.getArgument(5 + i)->getType();
1595 Assert(ArgType == ParamType,
1596 "gc.statepoint call argument does not match wrapped "
1601 const int EndCallArgsInx = 4 + NumCallArgs;
1603 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1604 Assert(isa<ConstantInt>(NumTransitionArgsV),
1605 "gc.statepoint number of transition arguments "
1606 "must be constant integer",
1608 const int NumTransitionArgs =
1609 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1610 Assert(NumTransitionArgs >= 0,
1611 "gc.statepoint number of transition arguments must be positive", &CI);
1612 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1614 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
1615 Assert(isa<ConstantInt>(NumDeoptArgsV),
1616 "gc.statepoint number of deoptimization arguments "
1617 "must be constant integer",
1619 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
1620 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1624 const int ExpectedNumArgs =
1625 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
1626 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
1627 "gc.statepoint too few arguments according to length fields", &CI);
1629 // Check that the only uses of this gc.statepoint are gc.result or
1630 // gc.relocate calls which are tied to this statepoint and thus part
1631 // of the same statepoint sequence
1632 for (const User *U : CI.users()) {
1633 const CallInst *Call = dyn_cast<const CallInst>(U);
1634 Assert(Call, "illegal use of statepoint token", &CI, U);
1635 if (!Call) continue;
1636 Assert(isGCRelocate(Call) || isGCResult(Call),
1637 "gc.result or gc.relocate are the only value uses"
1638 "of a gc.statepoint",
1640 if (isGCResult(Call)) {
1641 Assert(Call->getArgOperand(0) == &CI,
1642 "gc.result connected to wrong gc.statepoint", &CI, Call);
1643 } else if (isGCRelocate(Call)) {
1644 Assert(Call->getArgOperand(0) == &CI,
1645 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
1649 // Note: It is legal for a single derived pointer to be listed multiple
1650 // times. It's non-optimal, but it is legal. It can also happen after
1651 // insertion if we strip a bitcast away.
1652 // Note: It is really tempting to check that each base is relocated and
1653 // that a derived pointer is never reused as a base pointer. This turns
1654 // out to be problematic since optimizations run after safepoint insertion
1655 // can recognize equality properties that the insertion logic doesn't know
1656 // about. See example statepoint.ll in the verifier subdirectory
1659 void Verifier::verifyFrameRecoverIndices() {
1660 for (auto &Counts : FrameEscapeInfo) {
1661 Function *F = Counts.first;
1662 unsigned EscapedObjectCount = Counts.second.first;
1663 unsigned MaxRecoveredIndex = Counts.second.second;
1664 Assert(MaxRecoveredIndex <= EscapedObjectCount,
1665 "all indices passed to llvm.localrecover must be less than the "
1666 "number of arguments passed ot llvm.localescape in the parent "
1672 // visitFunction - Verify that a function is ok.
1674 void Verifier::visitFunction(const Function &F) {
1675 // Check function arguments.
1676 FunctionType *FT = F.getFunctionType();
1677 unsigned NumArgs = F.arg_size();
1679 Assert(Context == &F.getContext(),
1680 "Function context does not match Module context!", &F);
1682 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1683 Assert(FT->getNumParams() == NumArgs,
1684 "# formal arguments must match # of arguments for function type!", &F,
1686 Assert(F.getReturnType()->isFirstClassType() ||
1687 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1688 "Functions cannot return aggregate values!", &F);
1690 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1691 "Invalid struct return type!", &F);
1693 AttributeSet Attrs = F.getAttributes();
1695 Assert(VerifyAttributeCount(Attrs, FT->getNumParams()),
1696 "Attribute after last parameter!", &F);
1698 // Check function attributes.
1699 VerifyFunctionAttrs(FT, Attrs, &F);
1701 // On function declarations/definitions, we do not support the builtin
1702 // attribute. We do not check this in VerifyFunctionAttrs since that is
1703 // checking for Attributes that can/can not ever be on functions.
1704 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1705 "Attribute 'builtin' can only be applied to a callsite.", &F);
1707 // Check that this function meets the restrictions on this calling convention.
1708 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1709 // restrictions can be lifted.
1710 switch (F.getCallingConv()) {
1712 case CallingConv::C:
1714 case CallingConv::Fast:
1715 case CallingConv::Cold:
1716 case CallingConv::Intel_OCL_BI:
1717 case CallingConv::PTX_Kernel:
1718 case CallingConv::PTX_Device:
1719 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1720 "perfect forwarding!",
1725 bool isLLVMdotName = F.getName().size() >= 5 &&
1726 F.getName().substr(0, 5) == "llvm.";
1728 // Check that the argument values match the function type for this function...
1730 for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E;
1732 Assert(I->getType() == FT->getParamType(i),
1733 "Argument value does not match function argument type!", I,
1734 FT->getParamType(i));
1735 Assert(I->getType()->isFirstClassType(),
1736 "Function arguments must have first-class types!", I);
1737 if (!isLLVMdotName) {
1738 Assert(!I->getType()->isMetadataTy(),
1739 "Function takes metadata but isn't an intrinsic", I, &F);
1740 Assert(!I->getType()->isTokenTy(),
1741 "Function takes token but isn't an intrinsic", I, &F);
1746 Assert(!F.getReturnType()->isTokenTy(),
1747 "Functions returns a token but isn't an intrinsic", &F);
1749 // Get the function metadata attachments.
1750 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1751 F.getAllMetadata(MDs);
1752 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
1753 VerifyFunctionMetadata(MDs);
1755 if (F.isMaterializable()) {
1756 // Function has a body somewhere we can't see.
1757 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
1758 MDs.empty() ? nullptr : MDs.front().second);
1759 } else if (F.isDeclaration()) {
1760 Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(),
1761 "invalid linkage type for function declaration", &F);
1762 Assert(MDs.empty(), "function without a body cannot have metadata", &F,
1763 MDs.empty() ? nullptr : MDs.front().second);
1764 Assert(!F.hasPersonalityFn(),
1765 "Function declaration shouldn't have a personality routine", &F);
1767 // Verify that this function (which has a body) is not named "llvm.*". It
1768 // is not legal to define intrinsics.
1769 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
1771 // Check the entry node
1772 const BasicBlock *Entry = &F.getEntryBlock();
1773 Assert(pred_empty(Entry),
1774 "Entry block to function must not have predecessors!", Entry);
1776 // The address of the entry block cannot be taken, unless it is dead.
1777 if (Entry->hasAddressTaken()) {
1778 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
1779 "blockaddress may not be used with the entry block!", Entry);
1782 // Visit metadata attachments.
1783 for (const auto &I : MDs) {
1784 // Verify that the attachment is legal.
1788 case LLVMContext::MD_dbg:
1789 Assert(isa<DISubprogram>(I.second),
1790 "function !dbg attachment must be a subprogram", &F, I.second);
1794 // Verify the metadata itself.
1795 visitMDNode(*I.second);
1799 // If this function is actually an intrinsic, verify that it is only used in
1800 // direct call/invokes, never having its "address taken".
1801 if (F.getIntrinsicID()) {
1803 if (F.hasAddressTaken(&U))
1804 Assert(0, "Invalid user of intrinsic instruction!", U);
1807 Assert(!F.hasDLLImportStorageClass() ||
1808 (F.isDeclaration() && F.hasExternalLinkage()) ||
1809 F.hasAvailableExternallyLinkage(),
1810 "Function is marked as dllimport, but not external.", &F);
1813 // verifyBasicBlock - Verify that a basic block is well formed...
1815 void Verifier::visitBasicBlock(BasicBlock &BB) {
1816 InstsInThisBlock.clear();
1818 // Ensure that basic blocks have terminators!
1819 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
1821 // Check constraints that this basic block imposes on all of the PHI nodes in
1823 if (isa<PHINode>(BB.front())) {
1824 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
1825 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
1826 std::sort(Preds.begin(), Preds.end());
1828 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
1829 // Ensure that PHI nodes have at least one entry!
1830 Assert(PN->getNumIncomingValues() != 0,
1831 "PHI nodes must have at least one entry. If the block is dead, "
1832 "the PHI should be removed!",
1834 Assert(PN->getNumIncomingValues() == Preds.size(),
1835 "PHINode should have one entry for each predecessor of its "
1836 "parent basic block!",
1839 // Get and sort all incoming values in the PHI node...
1841 Values.reserve(PN->getNumIncomingValues());
1842 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1843 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
1844 PN->getIncomingValue(i)));
1845 std::sort(Values.begin(), Values.end());
1847 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
1848 // Check to make sure that if there is more than one entry for a
1849 // particular basic block in this PHI node, that the incoming values are
1852 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
1853 Values[i].second == Values[i - 1].second,
1854 "PHI node has multiple entries for the same basic block with "
1855 "different incoming values!",
1856 PN, Values[i].first, Values[i].second, Values[i - 1].second);
1858 // Check to make sure that the predecessors and PHI node entries are
1860 Assert(Values[i].first == Preds[i],
1861 "PHI node entries do not match predecessors!", PN,
1862 Values[i].first, Preds[i]);
1867 // Check that all instructions have their parent pointers set up correctly.
1870 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
1874 void Verifier::visitTerminatorInst(TerminatorInst &I) {
1875 // Ensure that terminators only exist at the end of the basic block.
1876 Assert(&I == I.getParent()->getTerminator(),
1877 "Terminator found in the middle of a basic block!", I.getParent());
1878 visitInstruction(I);
1881 void Verifier::visitBranchInst(BranchInst &BI) {
1882 if (BI.isConditional()) {
1883 Assert(BI.getCondition()->getType()->isIntegerTy(1),
1884 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
1886 visitTerminatorInst(BI);
1889 void Verifier::visitReturnInst(ReturnInst &RI) {
1890 Function *F = RI.getParent()->getParent();
1891 unsigned N = RI.getNumOperands();
1892 if (F->getReturnType()->isVoidTy())
1894 "Found return instr that returns non-void in Function of void "
1896 &RI, F->getReturnType());
1898 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
1899 "Function return type does not match operand "
1900 "type of return inst!",
1901 &RI, F->getReturnType());
1903 // Check to make sure that the return value has necessary properties for
1905 visitTerminatorInst(RI);
1908 void Verifier::visitSwitchInst(SwitchInst &SI) {
1909 // Check to make sure that all of the constants in the switch instruction
1910 // have the same type as the switched-on value.
1911 Type *SwitchTy = SI.getCondition()->getType();
1912 SmallPtrSet<ConstantInt*, 32> Constants;
1913 for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end(); i != e; ++i) {
1914 Assert(i.getCaseValue()->getType() == SwitchTy,
1915 "Switch constants must all be same type as switch value!", &SI);
1916 Assert(Constants.insert(i.getCaseValue()).second,
1917 "Duplicate integer as switch case", &SI, i.getCaseValue());
1920 visitTerminatorInst(SI);
1923 void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
1924 Assert(BI.getAddress()->getType()->isPointerTy(),
1925 "Indirectbr operand must have pointer type!", &BI);
1926 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
1927 Assert(BI.getDestination(i)->getType()->isLabelTy(),
1928 "Indirectbr destinations must all have pointer type!", &BI);
1930 visitTerminatorInst(BI);
1933 void Verifier::visitSelectInst(SelectInst &SI) {
1934 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
1936 "Invalid operands for select instruction!", &SI);
1938 Assert(SI.getTrueValue()->getType() == SI.getType(),
1939 "Select values must have same type as select instruction!", &SI);
1940 visitInstruction(SI);
1943 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
1944 /// a pass, if any exist, it's an error.
1946 void Verifier::visitUserOp1(Instruction &I) {
1947 Assert(0, "User-defined operators should not live outside of a pass!", &I);
1950 void Verifier::visitTruncInst(TruncInst &I) {
1951 // Get the source and destination types
1952 Type *SrcTy = I.getOperand(0)->getType();
1953 Type *DestTy = I.getType();
1955 // Get the size of the types in bits, we'll need this later
1956 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1957 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1959 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
1960 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
1961 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1962 "trunc source and destination must both be a vector or neither", &I);
1963 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
1965 visitInstruction(I);
1968 void Verifier::visitZExtInst(ZExtInst &I) {
1969 // Get the source and destination types
1970 Type *SrcTy = I.getOperand(0)->getType();
1971 Type *DestTy = I.getType();
1973 // Get the size of the types in bits, we'll need this later
1974 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
1975 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
1976 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1977 "zext source and destination must both be a vector or neither", &I);
1978 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1979 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1981 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
1983 visitInstruction(I);
1986 void Verifier::visitSExtInst(SExtInst &I) {
1987 // Get the source and destination types
1988 Type *SrcTy = I.getOperand(0)->getType();
1989 Type *DestTy = I.getType();
1991 // Get the size of the types in bits, we'll need this later
1992 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
1993 unsigned DestBitSize = DestTy->getScalarSizeInBits();
1995 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
1996 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
1997 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
1998 "sext source and destination must both be a vector or neither", &I);
1999 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
2001 visitInstruction(I);
2004 void Verifier::visitFPTruncInst(FPTruncInst &I) {
2005 // Get the source and destination types
2006 Type *SrcTy = I.getOperand(0)->getType();
2007 Type *DestTy = I.getType();
2008 // Get the size of the types in bits, we'll need this later
2009 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2010 unsigned DestBitSize = DestTy->getScalarSizeInBits();
2012 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2013 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2014 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2015 "fptrunc source and destination must both be a vector or neither", &I);
2016 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
2018 visitInstruction(I);
2021 void Verifier::visitFPExtInst(FPExtInst &I) {
2022 // Get the source and destination types
2023 Type *SrcTy = I.getOperand(0)->getType();
2024 Type *DestTy = I.getType();
2026 // Get the size of the types in bits, we'll need this later
2027 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2028 unsigned DestBitSize = DestTy->getScalarSizeInBits();
2030 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2031 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2032 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2033 "fpext source and destination must both be a vector or neither", &I);
2034 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
2036 visitInstruction(I);
2039 void Verifier::visitUIToFPInst(UIToFPInst &I) {
2040 // Get the source and destination types
2041 Type *SrcTy = I.getOperand(0)->getType();
2042 Type *DestTy = I.getType();
2044 bool SrcVec = SrcTy->isVectorTy();
2045 bool DstVec = DestTy->isVectorTy();
2047 Assert(SrcVec == DstVec,
2048 "UIToFP source and dest must both be vector or scalar", &I);
2049 Assert(SrcTy->isIntOrIntVectorTy(),
2050 "UIToFP source must be integer or integer vector", &I);
2051 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2054 if (SrcVec && DstVec)
2055 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2056 cast<VectorType>(DestTy)->getNumElements(),
2057 "UIToFP source and dest vector length mismatch", &I);
2059 visitInstruction(I);
2062 void Verifier::visitSIToFPInst(SIToFPInst &I) {
2063 // Get the source and destination types
2064 Type *SrcTy = I.getOperand(0)->getType();
2065 Type *DestTy = I.getType();
2067 bool SrcVec = SrcTy->isVectorTy();
2068 bool DstVec = DestTy->isVectorTy();
2070 Assert(SrcVec == DstVec,
2071 "SIToFP source and dest must both be vector or scalar", &I);
2072 Assert(SrcTy->isIntOrIntVectorTy(),
2073 "SIToFP source must be integer or integer vector", &I);
2074 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2077 if (SrcVec && DstVec)
2078 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2079 cast<VectorType>(DestTy)->getNumElements(),
2080 "SIToFP source and dest vector length mismatch", &I);
2082 visitInstruction(I);
2085 void Verifier::visitFPToUIInst(FPToUIInst &I) {
2086 // Get the source and destination types
2087 Type *SrcTy = I.getOperand(0)->getType();
2088 Type *DestTy = I.getType();
2090 bool SrcVec = SrcTy->isVectorTy();
2091 bool DstVec = DestTy->isVectorTy();
2093 Assert(SrcVec == DstVec,
2094 "FPToUI source and dest must both be vector or scalar", &I);
2095 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2097 Assert(DestTy->isIntOrIntVectorTy(),
2098 "FPToUI result must be integer or integer vector", &I);
2100 if (SrcVec && DstVec)
2101 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2102 cast<VectorType>(DestTy)->getNumElements(),
2103 "FPToUI source and dest vector length mismatch", &I);
2105 visitInstruction(I);
2108 void Verifier::visitFPToSIInst(FPToSIInst &I) {
2109 // Get the source and destination types
2110 Type *SrcTy = I.getOperand(0)->getType();
2111 Type *DestTy = I.getType();
2113 bool SrcVec = SrcTy->isVectorTy();
2114 bool DstVec = DestTy->isVectorTy();
2116 Assert(SrcVec == DstVec,
2117 "FPToSI source and dest must both be vector or scalar", &I);
2118 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2120 Assert(DestTy->isIntOrIntVectorTy(),
2121 "FPToSI result must be integer or integer vector", &I);
2123 if (SrcVec && DstVec)
2124 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2125 cast<VectorType>(DestTy)->getNumElements(),
2126 "FPToSI source and dest vector length mismatch", &I);
2128 visitInstruction(I);
2131 void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2132 // Get the source and destination types
2133 Type *SrcTy = I.getOperand(0)->getType();
2134 Type *DestTy = I.getType();
2136 Assert(SrcTy->getScalarType()->isPointerTy(),
2137 "PtrToInt source must be pointer", &I);
2138 Assert(DestTy->getScalarType()->isIntegerTy(),
2139 "PtrToInt result must be integral", &I);
2140 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2143 if (SrcTy->isVectorTy()) {
2144 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2145 VectorType *VDest = dyn_cast<VectorType>(DestTy);
2146 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2147 "PtrToInt Vector width mismatch", &I);
2150 visitInstruction(I);
2153 void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2154 // Get the source and destination types
2155 Type *SrcTy = I.getOperand(0)->getType();
2156 Type *DestTy = I.getType();
2158 Assert(SrcTy->getScalarType()->isIntegerTy(),
2159 "IntToPtr source must be an integral", &I);
2160 Assert(DestTy->getScalarType()->isPointerTy(),
2161 "IntToPtr result must be a pointer", &I);
2162 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2164 if (SrcTy->isVectorTy()) {
2165 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2166 VectorType *VDest = dyn_cast<VectorType>(DestTy);
2167 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2168 "IntToPtr Vector width mismatch", &I);
2170 visitInstruction(I);
2173 void Verifier::visitBitCastInst(BitCastInst &I) {
2175 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2176 "Invalid bitcast", &I);
2177 visitInstruction(I);
2180 void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2181 Type *SrcTy = I.getOperand(0)->getType();
2182 Type *DestTy = I.getType();
2184 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2186 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2188 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2189 "AddrSpaceCast must be between different address spaces", &I);
2190 if (SrcTy->isVectorTy())
2191 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2192 "AddrSpaceCast vector pointer number of elements mismatch", &I);
2193 visitInstruction(I);
2196 /// visitPHINode - Ensure that a PHI node is well formed.
2198 void Verifier::visitPHINode(PHINode &PN) {
2199 // Ensure that the PHI nodes are all grouped together at the top of the block.
2200 // This can be tested by checking whether the instruction before this is
2201 // either nonexistent (because this is begin()) or is a PHI node. If not,
2202 // then there is some other instruction before a PHI.
2203 Assert(&PN == &PN.getParent()->front() ||
2204 isa<PHINode>(--BasicBlock::iterator(&PN)),
2205 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
2207 // Check that a PHI doesn't yield a Token.
2208 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2210 // Check that all of the values of the PHI node have the same type as the
2211 // result, and that the incoming blocks are really basic blocks.
2212 for (Value *IncValue : PN.incoming_values()) {
2213 Assert(PN.getType() == IncValue->getType(),
2214 "PHI node operands are not the same type as the result!", &PN);
2217 // All other PHI node constraints are checked in the visitBasicBlock method.
2219 visitInstruction(PN);
2222 void Verifier::VerifyCallSite(CallSite CS) {
2223 Instruction *I = CS.getInstruction();
2225 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2226 "Called function must be a pointer!", I);
2227 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
2229 Assert(FPTy->getElementType()->isFunctionTy(),
2230 "Called function is not pointer to function type!", I);
2232 Assert(FPTy->getElementType() == CS.getFunctionType(),
2233 "Called function is not the same type as the call!", I);
2235 FunctionType *FTy = CS.getFunctionType();
2237 // Verify that the correct number of arguments are being passed
2238 if (FTy->isVarArg())
2239 Assert(CS.arg_size() >= FTy->getNumParams(),
2240 "Called function requires more parameters than were provided!", I);
2242 Assert(CS.arg_size() == FTy->getNumParams(),
2243 "Incorrect number of arguments passed to called function!", I);
2245 // Verify that all arguments to the call match the function type.
2246 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2247 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2248 "Call parameter type does not match function signature!",
2249 CS.getArgument(i), FTy->getParamType(i), I);
2251 AttributeSet Attrs = CS.getAttributes();
2253 Assert(VerifyAttributeCount(Attrs, CS.arg_size()),
2254 "Attribute after last parameter!", I);
2256 // Verify call attributes.
2257 VerifyFunctionAttrs(FTy, Attrs, I);
2259 // Conservatively check the inalloca argument.
2260 // We have a bug if we can find that there is an underlying alloca without
2262 if (CS.hasInAllocaArgument()) {
2263 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2264 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
2265 Assert(AI->isUsedWithInAlloca(),
2266 "inalloca argument for call has mismatched alloca", AI, I);
2269 if (FTy->isVarArg()) {
2270 // FIXME? is 'nest' even legal here?
2271 bool SawNest = false;
2272 bool SawReturned = false;
2274 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2275 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2277 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2281 // Check attributes on the varargs part.
2282 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
2283 Type *Ty = CS.getArgument(Idx-1)->getType();
2284 VerifyParameterAttrs(Attrs, Idx, Ty, false, I);
2286 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
2287 Assert(!SawNest, "More than one parameter has attribute nest!", I);
2291 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
2292 Assert(!SawReturned, "More than one parameter has attribute returned!",
2294 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2295 "Incompatible argument and return types for 'returned' "
2301 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2302 "Attribute 'sret' cannot be used for vararg call arguments!", I);
2304 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
2305 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
2309 // Verify that there's no metadata unless it's a direct call to an intrinsic.
2310 if (CS.getCalledFunction() == nullptr ||
2311 !CS.getCalledFunction()->getName().startswith("llvm.")) {
2312 for (Type *ParamTy : FTy->params()) {
2313 Assert(!ParamTy->isMetadataTy(),
2314 "Function has metadata parameter but isn't an intrinsic", I);
2315 Assert(!ParamTy->isTokenTy(),
2316 "Function has token parameter but isn't an intrinsic", I);
2320 // Verify that indirect calls don't return tokens.
2321 if (CS.getCalledFunction() == nullptr)
2322 Assert(!FTy->getReturnType()->isTokenTy(),
2323 "Return type cannot be token for indirect call!");
2325 if (Function *F = CS.getCalledFunction())
2326 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
2327 visitIntrinsicCallSite(ID, CS);
2329 visitInstruction(*I);
2332 /// Two types are "congruent" if they are identical, or if they are both pointer
2333 /// types with different pointee types and the same address space.
2334 static bool isTypeCongruent(Type *L, Type *R) {
2337 PointerType *PL = dyn_cast<PointerType>(L);
2338 PointerType *PR = dyn_cast<PointerType>(R);
2341 return PL->getAddressSpace() == PR->getAddressSpace();
2344 static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2345 static const Attribute::AttrKind ABIAttrs[] = {
2346 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
2347 Attribute::InReg, Attribute::Returned};
2349 for (auto AK : ABIAttrs) {
2350 if (Attrs.hasAttribute(I + 1, AK))
2351 Copy.addAttribute(AK);
2353 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2354 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2358 void Verifier::verifyMustTailCall(CallInst &CI) {
2359 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
2361 // - The caller and callee prototypes must match. Pointer types of
2362 // parameters or return types may differ in pointee type, but not
2364 Function *F = CI.getParent()->getParent();
2365 FunctionType *CallerTy = F->getFunctionType();
2366 FunctionType *CalleeTy = CI.getFunctionType();
2367 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2368 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2369 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2370 "cannot guarantee tail call due to mismatched varargs", &CI);
2371 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2372 "cannot guarantee tail call due to mismatched return types", &CI);
2373 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2375 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2376 "cannot guarantee tail call due to mismatched parameter types", &CI);
2379 // - The calling conventions of the caller and callee must match.
2380 Assert(F->getCallingConv() == CI.getCallingConv(),
2381 "cannot guarantee tail call due to mismatched calling conv", &CI);
2383 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2384 // returned, and inalloca, must match.
2385 AttributeSet CallerAttrs = F->getAttributes();
2386 AttributeSet CalleeAttrs = CI.getAttributes();
2387 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
2388 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2389 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
2390 Assert(CallerABIAttrs == CalleeABIAttrs,
2391 "cannot guarantee tail call due to mismatched ABI impacting "
2392 "function attributes",
2393 &CI, CI.getOperand(I));
2396 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2397 // or a pointer bitcast followed by a ret instruction.
2398 // - The ret instruction must return the (possibly bitcasted) value
2399 // produced by the call or void.
2400 Value *RetVal = &CI;
2401 Instruction *Next = CI.getNextNode();
2403 // Handle the optional bitcast.
2404 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
2405 Assert(BI->getOperand(0) == RetVal,
2406 "bitcast following musttail call must use the call", BI);
2408 Next = BI->getNextNode();
2411 // Check the return.
2412 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
2413 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2415 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2416 "musttail call result must be returned", Ret);
2419 void Verifier::visitCallInst(CallInst &CI) {
2420 VerifyCallSite(&CI);
2422 if (CI.isMustTailCall())
2423 verifyMustTailCall(CI);
2426 void Verifier::visitInvokeInst(InvokeInst &II) {
2427 VerifyCallSite(&II);
2429 // Verify that the first non-PHI instruction of the unwind destination is an
2430 // exception handling instruction.
2432 II.getUnwindDest()->isEHPad(),
2433 "The unwind destination does not have an exception handling instruction!",
2436 visitTerminatorInst(II);
2439 /// visitBinaryOperator - Check that both arguments to the binary operator are
2440 /// of the same type!
2442 void Verifier::visitBinaryOperator(BinaryOperator &B) {
2443 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2444 "Both operands to a binary operator are not of the same type!", &B);
2446 switch (B.getOpcode()) {
2447 // Check that integer arithmetic operators are only used with
2448 // integral operands.
2449 case Instruction::Add:
2450 case Instruction::Sub:
2451 case Instruction::Mul:
2452 case Instruction::SDiv:
2453 case Instruction::UDiv:
2454 case Instruction::SRem:
2455 case Instruction::URem:
2456 Assert(B.getType()->isIntOrIntVectorTy(),
2457 "Integer arithmetic operators only work with integral types!", &B);
2458 Assert(B.getType() == B.getOperand(0)->getType(),
2459 "Integer arithmetic operators must have same type "
2460 "for operands and result!",
2463 // Check that floating-point arithmetic operators are only used with
2464 // floating-point operands.
2465 case Instruction::FAdd:
2466 case Instruction::FSub:
2467 case Instruction::FMul:
2468 case Instruction::FDiv:
2469 case Instruction::FRem:
2470 Assert(B.getType()->isFPOrFPVectorTy(),
2471 "Floating-point arithmetic operators only work with "
2472 "floating-point types!",
2474 Assert(B.getType() == B.getOperand(0)->getType(),
2475 "Floating-point arithmetic operators must have same type "
2476 "for operands and result!",
2479 // Check that logical operators are only used with integral operands.
2480 case Instruction::And:
2481 case Instruction::Or:
2482 case Instruction::Xor:
2483 Assert(B.getType()->isIntOrIntVectorTy(),
2484 "Logical operators only work with integral types!", &B);
2485 Assert(B.getType() == B.getOperand(0)->getType(),
2486 "Logical operators must have same type for operands and result!",
2489 case Instruction::Shl:
2490 case Instruction::LShr:
2491 case Instruction::AShr:
2492 Assert(B.getType()->isIntOrIntVectorTy(),
2493 "Shifts only work with integral types!", &B);
2494 Assert(B.getType() == B.getOperand(0)->getType(),
2495 "Shift return type must be same as operands!", &B);
2498 llvm_unreachable("Unknown BinaryOperator opcode!");
2501 visitInstruction(B);
2504 void Verifier::visitICmpInst(ICmpInst &IC) {
2505 // Check that the operands are the same type
2506 Type *Op0Ty = IC.getOperand(0)->getType();
2507 Type *Op1Ty = IC.getOperand(1)->getType();
2508 Assert(Op0Ty == Op1Ty,
2509 "Both operands to ICmp instruction are not of the same type!", &IC);
2510 // Check that the operands are the right type
2511 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2512 "Invalid operand types for ICmp instruction", &IC);
2513 // Check that the predicate is valid.
2514 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2515 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2516 "Invalid predicate in ICmp instruction!", &IC);
2518 visitInstruction(IC);
2521 void Verifier::visitFCmpInst(FCmpInst &FC) {
2522 // Check that the operands are the same type
2523 Type *Op0Ty = FC.getOperand(0)->getType();
2524 Type *Op1Ty = FC.getOperand(1)->getType();
2525 Assert(Op0Ty == Op1Ty,
2526 "Both operands to FCmp instruction are not of the same type!", &FC);
2527 // Check that the operands are the right type
2528 Assert(Op0Ty->isFPOrFPVectorTy(),
2529 "Invalid operand types for FCmp instruction", &FC);
2530 // Check that the predicate is valid.
2531 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2532 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2533 "Invalid predicate in FCmp instruction!", &FC);
2535 visitInstruction(FC);
2538 void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
2540 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2541 "Invalid extractelement operands!", &EI);
2542 visitInstruction(EI);
2545 void Verifier::visitInsertElementInst(InsertElementInst &IE) {
2546 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2548 "Invalid insertelement operands!", &IE);
2549 visitInstruction(IE);
2552 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
2553 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2555 "Invalid shufflevector operands!", &SV);
2556 visitInstruction(SV);
2559 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
2560 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
2562 Assert(isa<PointerType>(TargetTy),
2563 "GEP base pointer is not a vector or a vector of pointers", &GEP);
2564 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
2565 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
2567 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
2568 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
2570 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
2571 GEP.getResultElementType() == ElTy,
2572 "GEP is not of right type for indices!", &GEP, ElTy);
2574 if (GEP.getType()->isVectorTy()) {
2575 // Additional checks for vector GEPs.
2576 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2577 if (GEP.getPointerOperandType()->isVectorTy())
2578 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2579 "Vector GEP result width doesn't match operand's", &GEP);
2580 for (unsigned i = 0, e = Idxs.size(); i != e; ++i) {
2581 Type *IndexTy = Idxs[i]->getType();
2582 if (IndexTy->isVectorTy()) {
2583 unsigned IndexWidth = IndexTy->getVectorNumElements();
2584 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2586 Assert(IndexTy->getScalarType()->isIntegerTy(),
2587 "All GEP indices should be of integer type");
2590 visitInstruction(GEP);
2593 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2594 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2597 void Verifier::visitRangeMetadata(Instruction& I,
2598 MDNode* Range, Type* Ty) {
2600 Range == I.getMetadata(LLVMContext::MD_range) &&
2601 "precondition violation");
2603 unsigned NumOperands = Range->getNumOperands();
2604 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
2605 unsigned NumRanges = NumOperands / 2;
2606 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2608 ConstantRange LastRange(1); // Dummy initial value
2609 for (unsigned i = 0; i < NumRanges; ++i) {
2611 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
2612 Assert(Low, "The lower limit must be an integer!", Low);
2614 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
2615 Assert(High, "The upper limit must be an integer!", High);
2616 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2617 "Range types must match instruction type!", &I);
2619 APInt HighV = High->getValue();
2620 APInt LowV = Low->getValue();
2621 ConstantRange CurRange(LowV, HighV);
2622 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2623 "Range must not be empty!", Range);
2625 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2626 "Intervals are overlapping", Range);
2627 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2629 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2632 LastRange = ConstantRange(LowV, HighV);
2634 if (NumRanges > 2) {
2636 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
2638 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
2639 ConstantRange FirstRange(FirstLow, FirstHigh);
2640 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
2641 "Intervals are overlapping", Range);
2642 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
2647 void Verifier::visitLoadInst(LoadInst &LI) {
2648 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
2649 Assert(PTy, "Load operand must be a pointer.", &LI);
2650 Type *ElTy = LI.getType();
2651 Assert(LI.getAlignment() <= Value::MaximumAlignment,
2652 "huge alignment values are unsupported", &LI);
2653 if (LI.isAtomic()) {
2654 Assert(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease,
2655 "Load cannot have Release ordering", &LI);
2656 Assert(LI.getAlignment() != 0,
2657 "Atomic load must specify explicit alignment", &LI);
2658 if (!ElTy->isPointerTy()) {
2659 Assert(ElTy->isIntegerTy(), "atomic load operand must have integer type!",
2661 unsigned Size = ElTy->getPrimitiveSizeInBits();
2662 Assert(Size >= 8 && !(Size & (Size - 1)),
2663 "atomic load operand must be power-of-two byte-sized integer", &LI,
2667 Assert(LI.getSynchScope() == CrossThread,
2668 "Non-atomic load cannot have SynchronizationScope specified", &LI);
2671 visitInstruction(LI);
2674 void Verifier::visitStoreInst(StoreInst &SI) {
2675 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
2676 Assert(PTy, "Store operand must be a pointer.", &SI);
2677 Type *ElTy = PTy->getElementType();
2678 Assert(ElTy == SI.getOperand(0)->getType(),
2679 "Stored value type does not match pointer operand type!", &SI, ElTy);
2680 Assert(SI.getAlignment() <= Value::MaximumAlignment,
2681 "huge alignment values are unsupported", &SI);
2682 if (SI.isAtomic()) {
2683 Assert(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease,
2684 "Store cannot have Acquire ordering", &SI);
2685 Assert(SI.getAlignment() != 0,
2686 "Atomic store must specify explicit alignment", &SI);
2687 if (!ElTy->isPointerTy()) {
2688 Assert(ElTy->isIntegerTy(),
2689 "atomic store operand must have integer type!", &SI, ElTy);
2690 unsigned Size = ElTy->getPrimitiveSizeInBits();
2691 Assert(Size >= 8 && !(Size & (Size - 1)),
2692 "atomic store operand must be power-of-two byte-sized integer",
2696 Assert(SI.getSynchScope() == CrossThread,
2697 "Non-atomic store cannot have SynchronizationScope specified", &SI);
2699 visitInstruction(SI);
2702 void Verifier::visitAllocaInst(AllocaInst &AI) {
2703 SmallPtrSet<Type*, 4> Visited;
2704 PointerType *PTy = AI.getType();
2705 Assert(PTy->getAddressSpace() == 0,
2706 "Allocation instruction pointer not in the generic address space!",
2708 Assert(AI.getAllocatedType()->isSized(&Visited),
2709 "Cannot allocate unsized type", &AI);
2710 Assert(AI.getArraySize()->getType()->isIntegerTy(),
2711 "Alloca array size must have integer type", &AI);
2712 Assert(AI.getAlignment() <= Value::MaximumAlignment,
2713 "huge alignment values are unsupported", &AI);
2715 visitInstruction(AI);
2718 void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
2720 // FIXME: more conditions???
2721 Assert(CXI.getSuccessOrdering() != NotAtomic,
2722 "cmpxchg instructions must be atomic.", &CXI);
2723 Assert(CXI.getFailureOrdering() != NotAtomic,
2724 "cmpxchg instructions must be atomic.", &CXI);
2725 Assert(CXI.getSuccessOrdering() != Unordered,
2726 "cmpxchg instructions cannot be unordered.", &CXI);
2727 Assert(CXI.getFailureOrdering() != Unordered,
2728 "cmpxchg instructions cannot be unordered.", &CXI);
2729 Assert(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(),
2730 "cmpxchg instructions be at least as constrained on success as fail",
2732 Assert(CXI.getFailureOrdering() != Release &&
2733 CXI.getFailureOrdering() != AcquireRelease,
2734 "cmpxchg failure ordering cannot include release semantics", &CXI);
2736 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
2737 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
2738 Type *ElTy = PTy->getElementType();
2739 Assert(ElTy->isIntegerTy(), "cmpxchg operand must have integer type!", &CXI,
2741 unsigned Size = ElTy->getPrimitiveSizeInBits();
2742 Assert(Size >= 8 && !(Size & (Size - 1)),
2743 "cmpxchg operand must be power-of-two byte-sized integer", &CXI, ElTy);
2744 Assert(ElTy == CXI.getOperand(1)->getType(),
2745 "Expected value type does not match pointer operand type!", &CXI,
2747 Assert(ElTy == CXI.getOperand(2)->getType(),
2748 "Stored value type does not match pointer operand type!", &CXI, ElTy);
2749 visitInstruction(CXI);
2752 void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
2753 Assert(RMWI.getOrdering() != NotAtomic,
2754 "atomicrmw instructions must be atomic.", &RMWI);
2755 Assert(RMWI.getOrdering() != Unordered,
2756 "atomicrmw instructions cannot be unordered.", &RMWI);
2757 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
2758 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
2759 Type *ElTy = PTy->getElementType();
2760 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
2762 unsigned Size = ElTy->getPrimitiveSizeInBits();
2763 Assert(Size >= 8 && !(Size & (Size - 1)),
2764 "atomicrmw operand must be power-of-two byte-sized integer", &RMWI,
2766 Assert(ElTy == RMWI.getOperand(1)->getType(),
2767 "Argument value type does not match pointer operand type!", &RMWI,
2769 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
2770 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
2771 "Invalid binary operation!", &RMWI);
2772 visitInstruction(RMWI);
2775 void Verifier::visitFenceInst(FenceInst &FI) {
2776 const AtomicOrdering Ordering = FI.getOrdering();
2777 Assert(Ordering == Acquire || Ordering == Release ||
2778 Ordering == AcquireRelease || Ordering == SequentiallyConsistent,
2779 "fence instructions may only have "
2780 "acquire, release, acq_rel, or seq_cst ordering.",
2782 visitInstruction(FI);
2785 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
2786 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
2787 EVI.getIndices()) == EVI.getType(),
2788 "Invalid ExtractValueInst operands!", &EVI);
2790 visitInstruction(EVI);
2793 void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
2794 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
2795 IVI.getIndices()) ==
2796 IVI.getOperand(1)->getType(),
2797 "Invalid InsertValueInst operands!", &IVI);
2799 visitInstruction(IVI);
2802 void Verifier::visitEHPadPredecessors(Instruction &I) {
2803 assert(I.isEHPad());
2805 BasicBlock *BB = I.getParent();
2806 Function *F = BB->getParent();
2808 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
2810 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
2811 // The landingpad instruction defines its parent as a landing pad block. The
2812 // landing pad block may be branched to only by the unwind edge of an
2814 for (BasicBlock *PredBB : predecessors(BB)) {
2815 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
2816 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
2817 "Block containing LandingPadInst must be jumped to "
2818 "only by the unwind edge of an invoke.",
2824 for (BasicBlock *PredBB : predecessors(BB)) {
2825 TerminatorInst *TI = PredBB->getTerminator();
2826 if (auto *II = dyn_cast<InvokeInst>(TI))
2827 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
2828 "EH pad must be jumped to via an unwind edge", &I, II);
2829 else if (auto *CPI = dyn_cast<CatchPadInst>(TI))
2830 Assert(CPI->getUnwindDest() == BB && CPI->getNormalDest() != BB,
2831 "EH pad must be jumped to via an unwind edge", &I, CPI);
2832 else if (isa<CatchEndPadInst>(TI))
2834 else if (isa<CleanupReturnInst>(TI))
2836 else if (isa<CleanupEndPadInst>(TI))
2838 else if (isa<TerminatePadInst>(TI))
2841 Assert(false, "EH pad must be jumped to via an unwind edge", &I, TI);
2845 void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
2846 // The landingpad instruction is ill-formed if it doesn't have any clauses and
2848 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
2849 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
2851 visitEHPadPredecessors(LPI);
2853 if (!LandingPadResultTy)
2854 LandingPadResultTy = LPI.getType();
2856 Assert(LandingPadResultTy == LPI.getType(),
2857 "The landingpad instruction should have a consistent result type "
2858 "inside a function.",
2861 Function *F = LPI.getParent()->getParent();
2862 Assert(F->hasPersonalityFn(),
2863 "LandingPadInst needs to be in a function with a personality.", &LPI);
2865 // The landingpad instruction must be the first non-PHI instruction in the
2867 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
2868 "LandingPadInst not the first non-PHI instruction in the block.",
2871 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
2872 Constant *Clause = LPI.getClause(i);
2873 if (LPI.isCatch(i)) {
2874 Assert(isa<PointerType>(Clause->getType()),
2875 "Catch operand does not have pointer type!", &LPI);
2877 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
2878 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
2879 "Filter operand is not an array of constants!", &LPI);
2883 visitInstruction(LPI);
2886 void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
2887 visitEHPadPredecessors(CPI);
2889 BasicBlock *BB = CPI.getParent();
2890 Function *F = BB->getParent();
2891 Assert(F->hasPersonalityFn(),
2892 "CatchPadInst needs to be in a function with a personality.", &CPI);
2894 // The catchpad instruction must be the first non-PHI instruction in the
2896 Assert(BB->getFirstNonPHI() == &CPI,
2897 "CatchPadInst not the first non-PHI instruction in the block.",
2900 if (!BB->getSinglePredecessor())
2901 for (BasicBlock *PredBB : predecessors(BB)) {
2902 Assert(!isa<CatchPadInst>(PredBB->getTerminator()),
2903 "CatchPadInst with CatchPadInst predecessor cannot have any other "
2908 BasicBlock *UnwindDest = CPI.getUnwindDest();
2909 Instruction *I = UnwindDest->getFirstNonPHI();
2911 isa<CatchPadInst>(I) || isa<CatchEndPadInst>(I),
2912 "CatchPadInst must unwind to a CatchPadInst or a CatchEndPadInst.",
2915 visitTerminatorInst(CPI);
2918 void Verifier::visitCatchEndPadInst(CatchEndPadInst &CEPI) {
2919 visitEHPadPredecessors(CEPI);
2921 BasicBlock *BB = CEPI.getParent();
2922 Function *F = BB->getParent();
2923 Assert(F->hasPersonalityFn(),
2924 "CatchEndPadInst needs to be in a function with a personality.",
2927 // The catchendpad instruction must be the first non-PHI instruction in the
2929 Assert(BB->getFirstNonPHI() == &CEPI,
2930 "CatchEndPadInst not the first non-PHI instruction in the block.",
2933 unsigned CatchPadsSeen = 0;
2934 for (BasicBlock *PredBB : predecessors(BB))
2935 if (isa<CatchPadInst>(PredBB->getTerminator()))
2938 Assert(CatchPadsSeen <= 1, "CatchEndPadInst must have no more than one "
2939 "CatchPadInst predecessor.",
2942 if (BasicBlock *UnwindDest = CEPI.getUnwindDest()) {
2943 Instruction *I = UnwindDest->getFirstNonPHI();
2945 I->isEHPad() && !isa<LandingPadInst>(I),
2946 "CatchEndPad must unwind to an EH block which is not a landingpad.",
2950 visitTerminatorInst(CEPI);
2953 void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
2954 visitEHPadPredecessors(CPI);
2956 BasicBlock *BB = CPI.getParent();
2958 Function *F = BB->getParent();
2959 Assert(F->hasPersonalityFn(),
2960 "CleanupPadInst needs to be in a function with a personality.", &CPI);
2962 // The cleanuppad instruction must be the first non-PHI instruction in the
2964 Assert(BB->getFirstNonPHI() == &CPI,
2965 "CleanupPadInst not the first non-PHI instruction in the block.",
2968 User *FirstUser = nullptr;
2969 BasicBlock *FirstUnwindDest = nullptr;
2970 for (User *U : CPI.users()) {
2971 BasicBlock *UnwindDest;
2972 if (CleanupReturnInst *CRI = dyn_cast<CleanupReturnInst>(U)) {
2973 UnwindDest = CRI->getUnwindDest();
2975 UnwindDest = cast<CleanupEndPadInst>(U)->getUnwindDest();
2980 FirstUnwindDest = UnwindDest;
2982 Assert(UnwindDest == FirstUnwindDest,
2983 "Cleanuprets/cleanupendpads from the same cleanuppad must "
2984 "have the same unwind destination",
2989 visitInstruction(CPI);
2992 void Verifier::visitCleanupEndPadInst(CleanupEndPadInst &CEPI) {
2993 visitEHPadPredecessors(CEPI);
2995 BasicBlock *BB = CEPI.getParent();
2996 Function *F = BB->getParent();
2997 Assert(F->hasPersonalityFn(),
2998 "CleanupEndPadInst needs to be in a function with a personality.",
3001 // The cleanupendpad instruction must be the first non-PHI instruction in the
3003 Assert(BB->getFirstNonPHI() == &CEPI,
3004 "CleanupEndPadInst not the first non-PHI instruction in the block.",
3007 if (BasicBlock *UnwindDest = CEPI.getUnwindDest()) {
3008 Instruction *I = UnwindDest->getFirstNonPHI();
3010 I->isEHPad() && !isa<LandingPadInst>(I),
3011 "CleanupEndPad must unwind to an EH block which is not a landingpad.",
3015 visitTerminatorInst(CEPI);
3018 void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
3019 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3020 Instruction *I = UnwindDest->getFirstNonPHI();
3021 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3022 "CleanupReturnInst must unwind to an EH block which is not a "
3027 visitTerminatorInst(CRI);
3030 void Verifier::visitTerminatePadInst(TerminatePadInst &TPI) {
3031 visitEHPadPredecessors(TPI);
3033 BasicBlock *BB = TPI.getParent();
3034 Function *F = BB->getParent();
3035 Assert(F->hasPersonalityFn(),
3036 "TerminatePadInst needs to be in a function with a personality.",
3039 // The terminatepad instruction must be the first non-PHI instruction in the
3041 Assert(BB->getFirstNonPHI() == &TPI,
3042 "TerminatePadInst not the first non-PHI instruction in the block.",
3045 if (BasicBlock *UnwindDest = TPI.getUnwindDest()) {
3046 Instruction *I = UnwindDest->getFirstNonPHI();
3047 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3048 "TerminatePadInst must unwind to an EH block which is not a "
3053 visitTerminatorInst(TPI);
3056 void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3057 Instruction *Op = cast<Instruction>(I.getOperand(i));
3058 // If the we have an invalid invoke, don't try to compute the dominance.
3059 // We already reject it in the invoke specific checks and the dominance
3060 // computation doesn't handle multiple edges.
3061 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3062 if (II->getNormalDest() == II->getUnwindDest())
3066 const Use &U = I.getOperandUse(i);
3067 Assert(InstsInThisBlock.count(Op) || DT.dominates(Op, U),
3068 "Instruction does not dominate all uses!", Op, &I);
3071 /// verifyInstruction - Verify that an instruction is well formed.
3073 void Verifier::visitInstruction(Instruction &I) {
3074 BasicBlock *BB = I.getParent();
3075 Assert(BB, "Instruction not embedded in basic block!", &I);
3077 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
3078 for (User *U : I.users()) {
3079 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3080 "Only PHI nodes may reference their own value!", &I);
3084 // Check that void typed values don't have names
3085 Assert(!I.getType()->isVoidTy() || !I.hasName(),
3086 "Instruction has a name, but provides a void value!", &I);
3088 // Check that the return value of the instruction is either void or a legal
3090 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3091 "Instruction returns a non-scalar type!", &I);
3093 // Check that the instruction doesn't produce metadata. Calls are already
3094 // checked against the callee type.
3095 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3096 "Invalid use of metadata!", &I);
3098 // Check that all uses of the instruction, if they are instructions
3099 // themselves, actually have parent basic blocks. If the use is not an
3100 // instruction, it is an error!
3101 for (Use &U : I.uses()) {
3102 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
3103 Assert(Used->getParent() != nullptr,
3104 "Instruction referencing"
3105 " instruction not embedded in a basic block!",
3108 CheckFailed("Use of instruction is not an instruction!", U);
3113 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
3114 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
3116 // Check to make sure that only first-class-values are operands to
3118 if (!I.getOperand(i)->getType()->isFirstClassType()) {
3119 Assert(0, "Instruction operands must be first-class values!", &I);
3122 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
3123 // Check to make sure that the "address of" an intrinsic function is never
3126 !F->isIntrinsic() ||
3127 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3128 "Cannot take the address of an intrinsic!", &I);
3130 !F->isIntrinsic() || isa<CallInst>(I) ||
3131 F->getIntrinsicID() == Intrinsic::donothing ||
3132 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
3133 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3134 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
3135 "Cannot invoke an intrinsinc other than"
3136 " donothing or patchpoint",
3138 Assert(F->getParent() == M, "Referencing function in another module!",
3140 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
3141 Assert(OpBB->getParent() == BB->getParent(),
3142 "Referring to a basic block in another function!", &I);
3143 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
3144 Assert(OpArg->getParent() == BB->getParent(),
3145 "Referring to an argument in another function!", &I);
3146 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
3147 Assert(GV->getParent() == M, "Referencing global in another module!", &I);
3148 } else if (isa<Instruction>(I.getOperand(i))) {
3149 verifyDominatesUse(I, i);
3150 } else if (isa<InlineAsm>(I.getOperand(i))) {
3151 Assert((i + 1 == e && isa<CallInst>(I)) ||
3152 (i + 3 == e && isa<InvokeInst>(I)),
3153 "Cannot take the address of an inline asm!", &I);
3154 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
3155 if (CE->getType()->isPtrOrPtrVectorTy()) {
3156 // If we have a ConstantExpr pointer, we need to see if it came from an
3157 // illegal bitcast (inttoptr <constant int> )
3158 SmallVector<const ConstantExpr *, 4> Stack;
3159 SmallPtrSet<const ConstantExpr *, 4> Visited;
3160 Stack.push_back(CE);
3162 while (!Stack.empty()) {
3163 const ConstantExpr *V = Stack.pop_back_val();
3164 if (!Visited.insert(V).second)
3167 VerifyConstantExprBitcastType(V);
3169 for (unsigned I = 0, N = V->getNumOperands(); I != N; ++I) {
3170 if (ConstantExpr *Op = dyn_cast<ConstantExpr>(V->getOperand(I)))
3171 Stack.push_back(Op);
3178 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
3179 Assert(I.getType()->isFPOrFPVectorTy(),
3180 "fpmath requires a floating point result!", &I);
3181 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
3182 if (ConstantFP *CFP0 =
3183 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
3184 APFloat Accuracy = CFP0->getValueAPF();
3185 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3186 "fpmath accuracy not a positive number!", &I);
3188 Assert(false, "invalid fpmath accuracy!", &I);
3192 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
3193 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3194 "Ranges are only for loads, calls and invokes!", &I);
3195 visitRangeMetadata(I, Range, I.getType());
3198 if (I.getMetadata(LLVMContext::MD_nonnull)) {
3199 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3201 Assert(isa<LoadInst>(I),
3202 "nonnull applies only to load instructions, use attributes"
3203 " for calls or invokes",
3207 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
3208 Assert(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
3212 InstsInThisBlock.insert(&I);
3215 /// VerifyIntrinsicType - Verify that the specified type (which comes from an
3216 /// intrinsic argument or return value) matches the type constraints specified
3217 /// by the .td file (e.g. an "any integer" argument really is an integer).
3219 /// This return true on error but does not print a message.
3220 bool Verifier::VerifyIntrinsicType(Type *Ty,
3221 ArrayRef<Intrinsic::IITDescriptor> &Infos,
3222 SmallVectorImpl<Type*> &ArgTys) {
3223 using namespace Intrinsic;
3225 // If we ran out of descriptors, there are too many arguments.
3226 if (Infos.empty()) return true;
3227 IITDescriptor D = Infos.front();
3228 Infos = Infos.slice(1);
3231 case IITDescriptor::Void: return !Ty->isVoidTy();
3232 case IITDescriptor::VarArg: return true;
3233 case IITDescriptor::MMX: return !Ty->isX86_MMXTy();
3234 case IITDescriptor::Token: return !Ty->isTokenTy();
3235 case IITDescriptor::Metadata: return !Ty->isMetadataTy();
3236 case IITDescriptor::Half: return !Ty->isHalfTy();
3237 case IITDescriptor::Float: return !Ty->isFloatTy();
3238 case IITDescriptor::Double: return !Ty->isDoubleTy();
3239 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width);
3240 case IITDescriptor::Vector: {
3241 VectorType *VT = dyn_cast<VectorType>(Ty);
3242 return !VT || VT->getNumElements() != D.Vector_Width ||
3243 VerifyIntrinsicType(VT->getElementType(), Infos, ArgTys);
3245 case IITDescriptor::Pointer: {
3246 PointerType *PT = dyn_cast<PointerType>(Ty);
3247 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace ||
3248 VerifyIntrinsicType(PT->getElementType(), Infos, ArgTys);
3251 case IITDescriptor::Struct: {
3252 StructType *ST = dyn_cast<StructType>(Ty);
3253 if (!ST || ST->getNumElements() != D.Struct_NumElements)
3256 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i)
3257 if (VerifyIntrinsicType(ST->getElementType(i), Infos, ArgTys))
3262 case IITDescriptor::Argument:
3263 // Two cases here - If this is the second occurrence of an argument, verify
3264 // that the later instance matches the previous instance.
3265 if (D.getArgumentNumber() < ArgTys.size())
3266 return Ty != ArgTys[D.getArgumentNumber()];
3268 // Otherwise, if this is the first instance of an argument, record it and
3269 // verify the "Any" kind.
3270 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error");
3271 ArgTys.push_back(Ty);
3273 switch (D.getArgumentKind()) {
3274 case IITDescriptor::AK_Any: return false; // Success
3275 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy();
3276 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy();
3277 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty);
3278 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty);
3280 llvm_unreachable("all argument kinds not covered");
3282 case IITDescriptor::ExtendArgument: {
3283 // This may only be used when referring to a previous vector argument.
3284 if (D.getArgumentNumber() >= ArgTys.size())
3287 Type *NewTy = ArgTys[D.getArgumentNumber()];
3288 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3289 NewTy = VectorType::getExtendedElementVectorType(VTy);
3290 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3291 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth());
3297 case IITDescriptor::TruncArgument: {
3298 // This may only be used when referring to a previous vector argument.
3299 if (D.getArgumentNumber() >= ArgTys.size())
3302 Type *NewTy = ArgTys[D.getArgumentNumber()];
3303 if (VectorType *VTy = dyn_cast<VectorType>(NewTy))
3304 NewTy = VectorType::getTruncatedElementVectorType(VTy);
3305 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy))
3306 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2);
3312 case IITDescriptor::HalfVecArgument:
3313 // This may only be used when referring to a previous vector argument.
3314 return D.getArgumentNumber() >= ArgTys.size() ||
3315 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) ||
3316 VectorType::getHalfElementsVectorType(
3317 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty;
3318 case IITDescriptor::SameVecWidthArgument: {
3319 if (D.getArgumentNumber() >= ArgTys.size())
3321 VectorType * ReferenceType =
3322 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]);
3323 VectorType *ThisArgType = dyn_cast<VectorType>(Ty);
3324 if (!ThisArgType || !ReferenceType ||
3325 (ReferenceType->getVectorNumElements() !=
3326 ThisArgType->getVectorNumElements()))
3328 return VerifyIntrinsicType(ThisArgType->getVectorElementType(),
3331 case IITDescriptor::PtrToArgument: {
3332 if (D.getArgumentNumber() >= ArgTys.size())
3334 Type * ReferenceType = ArgTys[D.getArgumentNumber()];
3335 PointerType *ThisArgType = dyn_cast<PointerType>(Ty);
3336 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType);
3338 case IITDescriptor::VecOfPtrsToElt: {
3339 if (D.getArgumentNumber() >= ArgTys.size())
3341 VectorType * ReferenceType =
3342 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]);
3343 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty);
3344 if (!ThisArgVecTy || !ReferenceType ||
3345 (ReferenceType->getVectorNumElements() !=
3346 ThisArgVecTy->getVectorNumElements()))
3348 PointerType *ThisArgEltTy =
3349 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType());
3352 return ThisArgEltTy->getElementType() !=
3353 ReferenceType->getVectorElementType();
3356 llvm_unreachable("unhandled");
3359 /// \brief Verify if the intrinsic has variable arguments.
3360 /// This method is intended to be called after all the fixed arguments have been
3363 /// This method returns true on error and does not print an error message.
3365 Verifier::VerifyIntrinsicIsVarArg(bool isVarArg,
3366 ArrayRef<Intrinsic::IITDescriptor> &Infos) {
3367 using namespace Intrinsic;
3369 // If there are no descriptors left, then it can't be a vararg.
3373 // There should be only one descriptor remaining at this point.
3374 if (Infos.size() != 1)
3377 // Check and verify the descriptor.
3378 IITDescriptor D = Infos.front();
3379 Infos = Infos.slice(1);
3380 if (D.Kind == IITDescriptor::VarArg)
3386 /// Allow intrinsics to be verified in different ways.
3387 void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
3388 Function *IF = CS.getCalledFunction();
3389 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3392 // Verify that the intrinsic prototype lines up with what the .td files
3394 FunctionType *IFTy = IF->getFunctionType();
3395 bool IsVarArg = IFTy->isVarArg();
3397 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3398 getIntrinsicInfoTableEntries(ID, Table);
3399 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
3401 SmallVector<Type *, 4> ArgTys;
3402 Assert(!VerifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys),
3403 "Intrinsic has incorrect return type!", IF);
3404 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
3405 Assert(!VerifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys),
3406 "Intrinsic has incorrect argument type!", IF);
3408 // Verify if the intrinsic call matches the vararg property.
3410 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3411 "Intrinsic was not defined with variable arguments!", IF);
3413 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef),
3414 "Callsite was not defined with variable arguments!", IF);
3416 // All descriptors should be absorbed by now.
3417 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
3419 // Now that we have the intrinsic ID and the actual argument types (and we
3420 // know they are legal for the intrinsic!) get the intrinsic name through the
3421 // usual means. This allows us to verify the mangling of argument types into
3423 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
3424 Assert(ExpectedName == IF->getName(),
3425 "Intrinsic name not mangled correctly for type arguments! "
3430 // If the intrinsic takes MDNode arguments, verify that they are either global
3431 // or are local to *this* function.
3432 for (Value *V : CS.args())
3433 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3434 visitMetadataAsValue(*MD, CS.getCaller());
3439 case Intrinsic::ctlz: // llvm.ctlz
3440 case Intrinsic::cttz: // llvm.cttz
3441 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3442 "is_zero_undef argument of bit counting intrinsics must be a "
3446 case Intrinsic::dbg_declare: // llvm.dbg.declare
3447 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3448 "invalid llvm.dbg.declare intrinsic call 1", CS);
3449 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
3451 case Intrinsic::dbg_value: // llvm.dbg.value
3452 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
3454 case Intrinsic::memcpy:
3455 case Intrinsic::memmove:
3456 case Intrinsic::memset: {
3457 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
3459 "alignment argument of memory intrinsics must be a constant int",
3461 const APInt &AlignVal = AlignCI->getValue();
3462 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
3463 "alignment argument of memory intrinsics must be a power of 2", CS);
3464 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
3465 "isvolatile argument of memory intrinsics must be a constant int",
3469 case Intrinsic::gcroot:
3470 case Intrinsic::gcwrite:
3471 case Intrinsic::gcread:
3472 if (ID == Intrinsic::gcroot) {
3474 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3475 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3476 Assert(isa<Constant>(CS.getArgOperand(1)),
3477 "llvm.gcroot parameter #2 must be a constant.", CS);
3478 if (!AI->getAllocatedType()->isPointerTy()) {
3479 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
3480 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3481 "or argument #2 must be a non-null constant.",
3486 Assert(CS.getParent()->getParent()->hasGC(),
3487 "Enclosing function does not use GC.", CS);
3489 case Intrinsic::init_trampoline:
3490 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
3491 "llvm.init_trampoline parameter #2 must resolve to a function.",
3494 case Intrinsic::prefetch:
3495 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
3496 isa<ConstantInt>(CS.getArgOperand(2)) &&
3497 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
3498 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
3499 "invalid arguments to llvm.prefetch", CS);
3501 case Intrinsic::stackprotector:
3502 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
3503 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
3505 case Intrinsic::lifetime_start:
3506 case Intrinsic::lifetime_end:
3507 case Intrinsic::invariant_start:
3508 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
3509 "size argument of memory use markers must be a constant integer",
3512 case Intrinsic::invariant_end:
3513 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3514 "llvm.invariant.end parameter #2 must be a constant integer", CS);
3517 case Intrinsic::localescape: {
3518 BasicBlock *BB = CS.getParent();
3519 Assert(BB == &BB->getParent()->front(),
3520 "llvm.localescape used outside of entry block", CS);
3521 Assert(!SawFrameEscape,
3522 "multiple calls to llvm.localescape in one function", CS);
3523 for (Value *Arg : CS.args()) {
3524 if (isa<ConstantPointerNull>(Arg))
3525 continue; // Null values are allowed as placeholders.
3526 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
3527 Assert(AI && AI->isStaticAlloca(),
3528 "llvm.localescape only accepts static allocas", CS);
3530 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
3531 SawFrameEscape = true;
3534 case Intrinsic::localrecover: {
3535 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
3536 Function *Fn = dyn_cast<Function>(FnArg);
3537 Assert(Fn && !Fn->isDeclaration(),
3538 "llvm.localrecover first "
3539 "argument must be function defined in this module",
3541 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
3542 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
3544 auto &Entry = FrameEscapeInfo[Fn];
3545 Entry.second = unsigned(
3546 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
3550 case Intrinsic::experimental_gc_statepoint:
3551 Assert(!CS.isInlineAsm(),
3552 "gc.statepoint support for inline assembly unimplemented", CS);
3553 Assert(CS.getParent()->getParent()->hasGC(),
3554 "Enclosing function does not use GC.", CS);
3556 VerifyStatepoint(CS);
3558 case Intrinsic::experimental_gc_result_int:
3559 case Intrinsic::experimental_gc_result_float:
3560 case Intrinsic::experimental_gc_result_ptr:
3561 case Intrinsic::experimental_gc_result: {
3562 Assert(CS.getParent()->getParent()->hasGC(),
3563 "Enclosing function does not use GC.", CS);
3564 // Are we tied to a statepoint properly?
3565 CallSite StatepointCS(CS.getArgOperand(0));
3566 const Function *StatepointFn =
3567 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
3568 Assert(StatepointFn && StatepointFn->isDeclaration() &&
3569 StatepointFn->getIntrinsicID() ==
3570 Intrinsic::experimental_gc_statepoint,
3571 "gc.result operand #1 must be from a statepoint", CS,
3572 CS.getArgOperand(0));
3574 // Assert that result type matches wrapped callee.
3575 const Value *Target = StatepointCS.getArgument(2);
3576 auto *PT = cast<PointerType>(Target->getType());
3577 auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
3578 Assert(CS.getType() == TargetFuncType->getReturnType(),
3579 "gc.result result type does not match wrapped callee", CS);
3582 case Intrinsic::experimental_gc_relocate: {
3583 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
3585 // Check that this relocate is correctly tied to the statepoint
3587 // This is case for relocate on the unwinding path of an invoke statepoint
3588 if (ExtractValueInst *ExtractValue =
3589 dyn_cast<ExtractValueInst>(CS.getArgOperand(0))) {
3590 Assert(isa<LandingPadInst>(ExtractValue->getAggregateOperand()),
3591 "gc relocate on unwind path incorrectly linked to the statepoint",
3594 const BasicBlock *InvokeBB =
3595 ExtractValue->getParent()->getUniquePredecessor();
3597 // Landingpad relocates should have only one predecessor with invoke
3598 // statepoint terminator
3599 Assert(InvokeBB, "safepoints should have unique landingpads",
3600 ExtractValue->getParent());
3601 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
3603 Assert(isStatepoint(InvokeBB->getTerminator()),
3604 "gc relocate should be linked to a statepoint", InvokeBB);
3607 // In all other cases relocate should be tied to the statepoint directly.
3608 // This covers relocates on a normal return path of invoke statepoint and
3609 // relocates of a call statepoint
3610 auto Token = CS.getArgOperand(0);
3611 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
3612 "gc relocate is incorrectly tied to the statepoint", CS, Token);
3615 // Verify rest of the relocate arguments
3617 GCRelocateOperands Ops(CS);
3618 ImmutableCallSite StatepointCS(Ops.getStatepoint());
3620 // Both the base and derived must be piped through the safepoint
3621 Value* Base = CS.getArgOperand(1);
3622 Assert(isa<ConstantInt>(Base),
3623 "gc.relocate operand #2 must be integer offset", CS);
3625 Value* Derived = CS.getArgOperand(2);
3626 Assert(isa<ConstantInt>(Derived),
3627 "gc.relocate operand #3 must be integer offset", CS);
3629 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
3630 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
3632 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
3633 "gc.relocate: statepoint base index out of bounds", CS);
3634 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
3635 "gc.relocate: statepoint derived index out of bounds", CS);
3637 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
3638 // section of the statepoint's argument
3639 Assert(StatepointCS.arg_size() > 0,
3640 "gc.statepoint: insufficient arguments");
3641 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
3642 "gc.statement: number of call arguments must be constant integer");
3643 const unsigned NumCallArgs =
3644 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
3645 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
3646 "gc.statepoint: mismatch in number of call arguments");
3647 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
3648 "gc.statepoint: number of transition arguments must be "
3649 "a constant integer");
3650 const int NumTransitionArgs =
3651 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
3653 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
3654 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
3655 "gc.statepoint: number of deoptimization arguments must be "
3656 "a constant integer");
3657 const int NumDeoptArgs =
3658 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))->getZExtValue();
3659 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
3660 const int GCParamArgsEnd = StatepointCS.arg_size();
3661 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
3662 "gc.relocate: statepoint base index doesn't fall within the "
3663 "'gc parameters' section of the statepoint call",
3665 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
3666 "gc.relocate: statepoint derived index doesn't fall within the "
3667 "'gc parameters' section of the statepoint call",
3670 // Relocated value must be a pointer type, but gc_relocate does not need to return the
3671 // same pointer type as the relocated pointer. It can be casted to the correct type later
3672 // if it's desired. However, they must have the same address space.
3673 GCRelocateOperands Operands(CS);
3674 Assert(Operands.getDerivedPtr()->getType()->isPointerTy(),
3675 "gc.relocate: relocated value must be a gc pointer", CS);
3677 // gc_relocate return type must be a pointer type, and is verified earlier in
3678 // VerifyIntrinsicType().
3679 Assert(cast<PointerType>(CS.getType())->getAddressSpace() ==
3680 cast<PointerType>(Operands.getDerivedPtr()->getType())->getAddressSpace(),
3681 "gc.relocate: relocating a pointer shouldn't change its address space", CS);
3684 case Intrinsic::eh_exceptioncode:
3685 case Intrinsic::eh_exceptionpointer: {
3686 Assert(isa<CatchPadInst>(CS.getArgOperand(0)),
3687 "eh.exceptionpointer argument must be a catchpad", CS);
3693 /// \brief Carefully grab the subprogram from a local scope.
3695 /// This carefully grabs the subprogram from a local scope, avoiding the
3696 /// built-in assertions that would typically fire.
3697 static DISubprogram *getSubprogram(Metadata *LocalScope) {
3701 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
3704 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
3705 return getSubprogram(LB->getRawScope());
3707 // Just return null; broken scope chains are checked elsewhere.
3708 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
3712 template <class DbgIntrinsicTy>
3713 void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
3714 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
3715 Assert(isa<ValueAsMetadata>(MD) ||
3716 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
3717 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
3718 Assert(isa<DILocalVariable>(DII.getRawVariable()),
3719 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
3720 DII.getRawVariable());
3721 Assert(isa<DIExpression>(DII.getRawExpression()),
3722 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
3723 DII.getRawExpression());
3725 // Ignore broken !dbg attachments; they're checked elsewhere.
3726 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
3727 if (!isa<DILocation>(N))
3730 BasicBlock *BB = DII.getParent();
3731 Function *F = BB ? BB->getParent() : nullptr;
3733 // The scopes for variables and !dbg attachments must agree.
3734 DILocalVariable *Var = DII.getVariable();
3735 DILocation *Loc = DII.getDebugLoc();
3736 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
3739 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
3740 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
3741 if (!VarSP || !LocSP)
3742 return; // Broken scope chains are checked elsewhere.
3744 Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
3745 " variable and !dbg attachment",
3746 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
3747 Loc->getScope()->getSubprogram());
3750 template <class MapTy>
3751 static uint64_t getVariableSize(const DILocalVariable &V, const MapTy &Map) {
3752 // Be careful of broken types (checked elsewhere).
3753 const Metadata *RawType = V.getRawType();
3755 // Try to get the size directly.
3756 if (auto *T = dyn_cast<DIType>(RawType))
3757 if (uint64_t Size = T->getSizeInBits())
3760 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
3761 // Look at the base type.
3762 RawType = DT->getRawBaseType();
3766 if (auto *S = dyn_cast<MDString>(RawType)) {
3767 // Don't error on missing types (checked elsewhere).
3768 RawType = Map.lookup(S);
3772 // Missing type or size.
3780 template <class MapTy>
3781 void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I,
3782 const MapTy &TypeRefs) {
3785 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
3786 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
3787 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
3789 auto *DDI = cast<DbgDeclareInst>(&I);
3790 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
3791 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
3794 // We don't know whether this intrinsic verified correctly.
3795 if (!V || !E || !E->isValid())
3798 // Nothing to do if this isn't a bit piece expression.
3799 if (!E->isBitPiece())
3802 // The frontend helps out GDB by emitting the members of local anonymous
3803 // unions as artificial local variables with shared storage. When SROA splits
3804 // the storage for artificial local variables that are smaller than the entire
3805 // union, the overhang piece will be outside of the allotted space for the
3806 // variable and this check fails.
3807 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
3808 if (V->isArtificial())
3811 // If there's no size, the type is broken, but that should be checked
3813 uint64_t VarSize = getVariableSize(*V, TypeRefs);
3817 unsigned PieceSize = E->getBitPieceSize();
3818 unsigned PieceOffset = E->getBitPieceOffset();
3819 Assert(PieceSize + PieceOffset <= VarSize,
3820 "piece is larger than or outside of variable", &I, V, E);
3821 Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
3824 void Verifier::visitUnresolvedTypeRef(const MDString *S, const MDNode *N) {
3825 // This is in its own function so we get an error for each bad type ref (not
3827 Assert(false, "unresolved type ref", S, N);
3830 void Verifier::verifyTypeRefs() {
3831 auto *CUs = M->getNamedMetadata("llvm.dbg.cu");
3835 // Visit all the compile units again to map the type references.
3836 SmallDenseMap<const MDString *, const DIType *, 32> TypeRefs;
3837 for (auto *CU : CUs->operands())
3838 if (auto Ts = cast<DICompileUnit>(CU)->getRetainedTypes())
3839 for (DIType *Op : Ts)
3840 if (auto *T = dyn_cast_or_null<DICompositeType>(Op))
3841 if (auto *S = T->getRawIdentifier()) {
3842 UnresolvedTypeRefs.erase(S);
3843 TypeRefs.insert(std::make_pair(S, T));
3846 // Verify debug info intrinsic bit piece expressions. This needs a second
3847 // pass through the intructions, since we haven't built TypeRefs yet when
3848 // verifying functions, and simply queuing the DbgInfoIntrinsics to evaluate
3849 // later/now would queue up some that could be later deleted.
3850 for (const Function &F : *M)
3851 for (const BasicBlock &BB : F)
3852 for (const Instruction &I : BB)
3853 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
3854 verifyBitPieceExpression(*DII, TypeRefs);
3856 // Return early if all typerefs were resolved.
3857 if (UnresolvedTypeRefs.empty())
3860 // Sort the unresolved references by name so the output is deterministic.
3861 typedef std::pair<const MDString *, const MDNode *> TypeRef;
3862 SmallVector<TypeRef, 32> Unresolved(UnresolvedTypeRefs.begin(),
3863 UnresolvedTypeRefs.end());
3864 std::sort(Unresolved.begin(), Unresolved.end(),
3865 [](const TypeRef &LHS, const TypeRef &RHS) {
3866 return LHS.first->getString() < RHS.first->getString();
3869 // Visit the unresolved refs (printing out the errors).
3870 for (const TypeRef &TR : Unresolved)
3871 visitUnresolvedTypeRef(TR.first, TR.second);
3874 //===----------------------------------------------------------------------===//
3875 // Implement the public interfaces to this file...
3876 //===----------------------------------------------------------------------===//
3878 bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
3879 Function &F = const_cast<Function &>(f);
3880 assert(!F.isDeclaration() && "Cannot verify external functions");
3882 raw_null_ostream NullStr;
3883 Verifier V(OS ? *OS : NullStr);
3885 // Note that this function's return value is inverted from what you would
3886 // expect of a function called "verify".
3887 return !V.verify(F);
3890 bool llvm::verifyModule(const Module &M, raw_ostream *OS) {
3891 raw_null_ostream NullStr;
3892 Verifier V(OS ? *OS : NullStr);
3894 bool Broken = false;
3895 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
3896 if (!I->isDeclaration() && !I->isMaterializable())
3897 Broken |= !V.verify(*I);
3899 // Note that this function's return value is inverted from what you would
3900 // expect of a function called "verify".
3901 return !V.verify(M) || Broken;
3905 struct VerifierLegacyPass : public FunctionPass {
3911 VerifierLegacyPass() : FunctionPass(ID), V(dbgs()), FatalErrors(true) {
3912 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3914 explicit VerifierLegacyPass(bool FatalErrors)
3915 : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) {
3916 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
3919 bool runOnFunction(Function &F) override {
3920 if (!V.verify(F) && FatalErrors)
3921 report_fatal_error("Broken function found, compilation aborted!");
3926 bool doFinalization(Module &M) override {
3927 if (!V.verify(M) && FatalErrors)
3928 report_fatal_error("Broken module found, compilation aborted!");
3933 void getAnalysisUsage(AnalysisUsage &AU) const override {
3934 AU.setPreservesAll();
3939 char VerifierLegacyPass::ID = 0;
3940 INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
3942 FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
3943 return new VerifierLegacyPass(FatalErrors);
3946 PreservedAnalyses VerifierPass::run(Module &M) {
3947 if (verifyModule(M, &dbgs()) && FatalErrors)
3948 report_fatal_error("Broken module found, compilation aborted!");
3950 return PreservedAnalyses::all();
3953 PreservedAnalyses VerifierPass::run(Function &F) {
3954 if (verifyFunction(F, &dbgs()) && FatalErrors)
3955 report_fatal_error("Broken function found, compilation aborted!");
3957 return PreservedAnalyses::all();