1 //===-- Verifier.cpp - Implement the Module Verifier -----------------------==// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 10 // This file defines the function verifier interface, that can be used for some 11 // sanity checking of input to the system. 12 // 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. 15 // 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 41 // block. 42 // * Landingpad instructions must be in a function with a personality function. 43 // * All other things that are tested by asserts spread about the code... 44 // 45 //===----------------------------------------------------------------------===// 46 47 #include "llvm/IR/Verifier.h" 48 #include "llvm/ADT/MapVector.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/DiagnosticInfo.h" 63 #include "llvm/IR/Dominators.h" 64 #include "llvm/IR/InlineAsm.h" 65 #include "llvm/IR/InstIterator.h" 66 #include "llvm/IR/InstVisitor.h" 67 #include "llvm/IR/IntrinsicInst.h" 68 #include "llvm/IR/LLVMContext.h" 69 #include "llvm/IR/Metadata.h" 70 #include "llvm/IR/Module.h" 71 #include "llvm/IR/ModuleSlotTracker.h" 72 #include "llvm/IR/PassManager.h" 73 #include "llvm/IR/Statepoint.h" 74 #include "llvm/Pass.h" 75 #include "llvm/Support/CommandLine.h" 76 #include "llvm/Support/Debug.h" 77 #include "llvm/Support/ErrorHandling.h" 78 #include "llvm/Support/raw_ostream.h" 79 #include <algorithm> 80 #include <cstdarg> 81 using namespace llvm; 82 83 static cl::opt<bool> VerifyDebugInfo("verify-debug-info", cl::init(true)); 84 85 namespace { 86 struct VerifierSupport { 87 raw_ostream *OS; 88 const Module &M; 89 ModuleSlotTracker MST; 90 const DataLayout &DL; 91 LLVMContext &Context; 92 93 /// Track the brokenness of the module while recursively visiting. 94 bool Broken = false; 95 /// Broken debug info can be "recovered" from by stripping the debug info. 96 bool BrokenDebugInfo = false; 97 /// Whether to treat broken debug info as an error. 98 bool TreatBrokenDebugInfoAsError = true; 99 100 explicit VerifierSupport(raw_ostream *OS, const Module &M) 101 : OS(OS), M(M), MST(&M), DL(M.getDataLayout()), Context(M.getContext()) {} 102 103 private: 104 template <class NodeTy> void Write(const ilist_iterator<NodeTy> &I) { 105 Write(&*I); 106 } 107 108 void Write(const Module *M) { 109 *OS << "; ModuleID = '" << M->getModuleIdentifier() << "'\n"; 110 } 111 112 void Write(const Value *V) { 113 if (!V) 114 return; 115 if (isa<Instruction>(V)) { 116 V->print(*OS, MST); 117 *OS << '\n'; 118 } else { 119 V->printAsOperand(*OS, true, MST); 120 *OS << '\n'; 121 } 122 } 123 void Write(ImmutableCallSite CS) { 124 Write(CS.getInstruction()); 125 } 126 127 void Write(const Metadata *MD) { 128 if (!MD) 129 return; 130 MD->print(*OS, MST, &M); 131 *OS << '\n'; 132 } 133 134 template <class T> void Write(const MDTupleTypedArrayWrapper<T> &MD) { 135 Write(MD.get()); 136 } 137 138 void Write(const NamedMDNode *NMD) { 139 if (!NMD) 140 return; 141 NMD->print(*OS, MST); 142 *OS << '\n'; 143 } 144 145 void Write(Type *T) { 146 if (!T) 147 return; 148 *OS << ' ' << *T; 149 } 150 151 void Write(const Comdat *C) { 152 if (!C) 153 return; 154 *OS << *C; 155 } 156 157 template <typename T> void Write(ArrayRef<T> Vs) { 158 for (const T &V : Vs) 159 Write(V); 160 } 161 162 template <typename T1, typename... Ts> 163 void WriteTs(const T1 &V1, const Ts &... Vs) { 164 Write(V1); 165 WriteTs(Vs...); 166 } 167 168 template <typename... Ts> void WriteTs() {} 169 170 public: 171 /// \brief A check failed, so printout out the condition and the message. 172 /// 173 /// This provides a nice place to put a breakpoint if you want to see why 174 /// something is not correct. 175 void CheckFailed(const Twine &Message) { 176 if (OS) 177 *OS << Message << '\n'; 178 Broken = true; 179 } 180 181 /// \brief A check failed (with values to print). 182 /// 183 /// This calls the Message-only version so that the above is easier to set a 184 /// breakpoint on. 185 template <typename T1, typename... Ts> 186 void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) { 187 CheckFailed(Message); 188 if (OS) 189 WriteTs(V1, Vs...); 190 } 191 192 /// A debug info check failed. 193 void DebugInfoCheckFailed(const Twine &Message) { 194 if (OS) 195 *OS << Message << '\n'; 196 Broken |= TreatBrokenDebugInfoAsError; 197 BrokenDebugInfo = true; 198 } 199 200 /// A debug info check failed (with values to print). 201 template <typename T1, typename... Ts> 202 void DebugInfoCheckFailed(const Twine &Message, const T1 &V1, 203 const Ts &... Vs) { 204 DebugInfoCheckFailed(Message); 205 if (OS) 206 WriteTs(V1, Vs...); 207 } 208 }; 209 210 class Verifier : public InstVisitor<Verifier>, VerifierSupport { 211 friend class InstVisitor<Verifier>; 212 213 DominatorTree DT; 214 215 /// \brief When verifying a basic block, keep track of all of the 216 /// instructions we have seen so far. 217 /// 218 /// This allows us to do efficient dominance checks for the case when an 219 /// instruction has an operand that is an instruction in the same block. 220 SmallPtrSet<Instruction *, 16> InstsInThisBlock; 221 222 /// \brief Keep track of the metadata nodes that have been checked already. 223 SmallPtrSet<const Metadata *, 32> MDNodes; 224 225 /// Track all DICompileUnits visited. 226 SmallPtrSet<const Metadata *, 2> CUVisited; 227 228 /// \brief The result type for a landingpad. 229 Type *LandingPadResultTy; 230 231 /// \brief Whether we've seen a call to @llvm.localescape in this function 232 /// already. 233 bool SawFrameEscape; 234 235 /// Stores the count of how many objects were passed to llvm.localescape for a 236 /// given function and the largest index passed to llvm.localrecover. 237 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo; 238 239 // Maps catchswitches and cleanuppads that unwind to siblings to the 240 // terminators that indicate the unwind, used to detect cycles therein. 241 MapVector<Instruction *, TerminatorInst *> SiblingFuncletInfo; 242 243 /// Cache of constants visited in search of ConstantExprs. 244 SmallPtrSet<const Constant *, 32> ConstantExprVisited; 245 246 /// Cache of declarations of the llvm.experimental.deoptimize.<ty> intrinsic. 247 SmallVector<const Function *, 4> DeoptimizeDeclarations; 248 249 // Verify that this GlobalValue is only used in this module. 250 // This map is used to avoid visiting uses twice. We can arrive at a user 251 // twice, if they have multiple operands. In particular for very large 252 // constant expressions, we can arrive at a particular user many times. 253 SmallPtrSet<const Value *, 32> GlobalValueVisited; 254 255 void checkAtomicMemAccessSize(Type *Ty, const Instruction *I); 256 257 public: 258 explicit Verifier(raw_ostream *OS, bool ShouldTreatBrokenDebugInfoAsError, 259 const Module &M) 260 : VerifierSupport(OS, M), LandingPadResultTy(nullptr), 261 SawFrameEscape(false) { 262 TreatBrokenDebugInfoAsError = ShouldTreatBrokenDebugInfoAsError; 263 } 264 265 bool hasBrokenDebugInfo() const { return BrokenDebugInfo; } 266 267 bool verify(const Function &F) { 268 assert(F.getParent() == &M && 269 "An instance of this class only works with a specific module!"); 270 271 // First ensure the function is well-enough formed to compute dominance 272 // information, and directly compute a dominance tree. We don't rely on the 273 // pass manager to provide this as it isolates us from a potentially 274 // out-of-date dominator tree and makes it significantly more complex to run 275 // this code outside of a pass manager. 276 // FIXME: It's really gross that we have to cast away constness here. 277 if (!F.empty()) 278 DT.recalculate(const_cast<Function &>(F)); 279 280 for (const BasicBlock &BB : F) { 281 if (!BB.empty() && BB.back().isTerminator()) 282 continue; 283 284 if (OS) { 285 *OS << "Basic Block in function '" << F.getName() 286 << "' does not have terminator!\n"; 287 BB.printAsOperand(*OS, true, MST); 288 *OS << "\n"; 289 } 290 return false; 291 } 292 293 Broken = false; 294 // FIXME: We strip const here because the inst visitor strips const. 295 visit(const_cast<Function &>(F)); 296 verifySiblingFuncletUnwinds(); 297 InstsInThisBlock.clear(); 298 LandingPadResultTy = nullptr; 299 SawFrameEscape = false; 300 SiblingFuncletInfo.clear(); 301 302 return !Broken; 303 } 304 305 /// Verify the module that this instance of \c Verifier was initialized with. 306 bool verify() { 307 Broken = false; 308 309 // Collect all declarations of the llvm.experimental.deoptimize intrinsic. 310 for (const Function &F : M) 311 if (F.getIntrinsicID() == Intrinsic::experimental_deoptimize) 312 DeoptimizeDeclarations.push_back(&F); 313 314 // Now that we've visited every function, verify that we never asked to 315 // recover a frame index that wasn't escaped. 316 verifyFrameRecoverIndices(); 317 for (const GlobalVariable &GV : M.globals()) 318 visitGlobalVariable(GV); 319 320 for (const GlobalAlias &GA : M.aliases()) 321 visitGlobalAlias(GA); 322 323 for (const NamedMDNode &NMD : M.named_metadata()) 324 visitNamedMDNode(NMD); 325 326 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable()) 327 visitComdat(SMEC.getValue()); 328 329 visitModuleFlags(M); 330 visitModuleIdents(M); 331 332 verifyCompileUnits(); 333 334 verifyDeoptimizeCallingConvs(); 335 336 return !Broken; 337 } 338 339 private: 340 // Verification methods... 341 void visitGlobalValue(const GlobalValue &GV); 342 void visitGlobalVariable(const GlobalVariable &GV); 343 void visitGlobalAlias(const GlobalAlias &GA); 344 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C); 345 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited, 346 const GlobalAlias &A, const Constant &C); 347 void visitNamedMDNode(const NamedMDNode &NMD); 348 void visitMDNode(const MDNode &MD); 349 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F); 350 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F); 351 void visitComdat(const Comdat &C); 352 void visitModuleIdents(const Module &M); 353 void visitModuleFlags(const Module &M); 354 void visitModuleFlag(const MDNode *Op, 355 DenseMap<const MDString *, const MDNode *> &SeenIDs, 356 SmallVectorImpl<const MDNode *> &Requirements); 357 void visitFunction(const Function &F); 358 void visitBasicBlock(BasicBlock &BB); 359 void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty); 360 void visitDereferenceableMetadata(Instruction& I, MDNode* MD); 361 362 template <class Ty> bool isValidMetadataArray(const MDTuple &N); 363 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N); 364 #include "llvm/IR/Metadata.def" 365 void visitDIScope(const DIScope &N); 366 void visitDIVariable(const DIVariable &N); 367 void visitDILexicalBlockBase(const DILexicalBlockBase &N); 368 void visitDITemplateParameter(const DITemplateParameter &N); 369 370 void visitTemplateParams(const MDNode &N, const Metadata &RawParams); 371 372 // InstVisitor overrides... 373 using InstVisitor<Verifier>::visit; 374 void visit(Instruction &I); 375 376 void visitTruncInst(TruncInst &I); 377 void visitZExtInst(ZExtInst &I); 378 void visitSExtInst(SExtInst &I); 379 void visitFPTruncInst(FPTruncInst &I); 380 void visitFPExtInst(FPExtInst &I); 381 void visitFPToUIInst(FPToUIInst &I); 382 void visitFPToSIInst(FPToSIInst &I); 383 void visitUIToFPInst(UIToFPInst &I); 384 void visitSIToFPInst(SIToFPInst &I); 385 void visitIntToPtrInst(IntToPtrInst &I); 386 void visitPtrToIntInst(PtrToIntInst &I); 387 void visitBitCastInst(BitCastInst &I); 388 void visitAddrSpaceCastInst(AddrSpaceCastInst &I); 389 void visitPHINode(PHINode &PN); 390 void visitBinaryOperator(BinaryOperator &B); 391 void visitICmpInst(ICmpInst &IC); 392 void visitFCmpInst(FCmpInst &FC); 393 void visitExtractElementInst(ExtractElementInst &EI); 394 void visitInsertElementInst(InsertElementInst &EI); 395 void visitShuffleVectorInst(ShuffleVectorInst &EI); 396 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); } 397 void visitCallInst(CallInst &CI); 398 void visitInvokeInst(InvokeInst &II); 399 void visitGetElementPtrInst(GetElementPtrInst &GEP); 400 void visitLoadInst(LoadInst &LI); 401 void visitStoreInst(StoreInst &SI); 402 void verifyDominatesUse(Instruction &I, unsigned i); 403 void visitInstruction(Instruction &I); 404 void visitTerminatorInst(TerminatorInst &I); 405 void visitBranchInst(BranchInst &BI); 406 void visitReturnInst(ReturnInst &RI); 407 void visitSwitchInst(SwitchInst &SI); 408 void visitIndirectBrInst(IndirectBrInst &BI); 409 void visitSelectInst(SelectInst &SI); 410 void visitUserOp1(Instruction &I); 411 void visitUserOp2(Instruction &I) { visitUserOp1(I); } 412 void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS); 413 template <class DbgIntrinsicTy> 414 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII); 415 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI); 416 void visitAtomicRMWInst(AtomicRMWInst &RMWI); 417 void visitFenceInst(FenceInst &FI); 418 void visitAllocaInst(AllocaInst &AI); 419 void visitExtractValueInst(ExtractValueInst &EVI); 420 void visitInsertValueInst(InsertValueInst &IVI); 421 void visitEHPadPredecessors(Instruction &I); 422 void visitLandingPadInst(LandingPadInst &LPI); 423 void visitResumeInst(ResumeInst &RI); 424 void visitCatchPadInst(CatchPadInst &CPI); 425 void visitCatchReturnInst(CatchReturnInst &CatchReturn); 426 void visitCleanupPadInst(CleanupPadInst &CPI); 427 void visitFuncletPadInst(FuncletPadInst &FPI); 428 void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch); 429 void visitCleanupReturnInst(CleanupReturnInst &CRI); 430 431 void verifyCallSite(CallSite CS); 432 void verifySwiftErrorCallSite(CallSite CS, const Value *SwiftErrorVal); 433 void verifySwiftErrorValue(const Value *SwiftErrorVal); 434 void verifyMustTailCall(CallInst &CI); 435 bool performTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT, 436 unsigned ArgNo, std::string &Suffix); 437 bool verifyAttributeCount(AttributeSet Attrs, unsigned Params); 438 void verifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction, 439 const Value *V); 440 void verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty, 441 bool isReturnValue, const Value *V); 442 void verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs, 443 const Value *V); 444 void verifyFunctionMetadata(ArrayRef<std::pair<unsigned, MDNode *>> MDs); 445 446 void visitConstantExprsRecursively(const Constant *EntryC); 447 void visitConstantExpr(const ConstantExpr *CE); 448 void verifyStatepoint(ImmutableCallSite CS); 449 void verifyFrameRecoverIndices(); 450 void verifySiblingFuncletUnwinds(); 451 452 void verifyBitPieceExpression(const DbgInfoIntrinsic &I); 453 454 /// Module-level debug info verification... 455 void verifyCompileUnits(); 456 457 /// Module-level verification that all @llvm.experimental.deoptimize 458 /// declarations share the same calling convention. 459 void verifyDeoptimizeCallingConvs(); 460 }; 461 } // End anonymous namespace 462 463 /// We know that cond should be true, if not print an error message. 464 #define Assert(C, ...) \ 465 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (0) 466 467 /// We know that a debug info condition should be true, if not print 468 /// an error message. 469 #define AssertDI(C, ...) \ 470 do { if (!(C)) { DebugInfoCheckFailed(__VA_ARGS__); return; } } while (0) 471 472 473 void Verifier::visit(Instruction &I) { 474 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) 475 Assert(I.getOperand(i) != nullptr, "Operand is null", &I); 476 InstVisitor<Verifier>::visit(I); 477 } 478 479 // Helper to recursively iterate over indirect users. By 480 // returning false, the callback can ask to stop recursing 481 // further. 482 static void forEachUser(const Value *User, 483 SmallPtrSet<const Value *, 32> &Visited, 484 llvm::function_ref<bool(const Value *)> Callback) { 485 if (!Visited.insert(User).second) 486 return; 487 for (const Value *TheNextUser : User->materialized_users()) 488 if (Callback(TheNextUser)) 489 forEachUser(TheNextUser, Visited, Callback); 490 } 491 492 void Verifier::visitGlobalValue(const GlobalValue &GV) { 493 Assert(!GV.isDeclaration() || GV.hasValidDeclarationLinkage(), 494 "Global is external, but doesn't have external or weak linkage!", &GV); 495 496 Assert(GV.getAlignment() <= Value::MaximumAlignment, 497 "huge alignment values are unsupported", &GV); 498 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV), 499 "Only global variables can have appending linkage!", &GV); 500 501 if (GV.hasAppendingLinkage()) { 502 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV); 503 Assert(GVar && GVar->getValueType()->isArrayTy(), 504 "Only global arrays can have appending linkage!", GVar); 505 } 506 507 if (GV.isDeclarationForLinker()) 508 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV); 509 510 forEachUser(&GV, GlobalValueVisited, [&](const Value *V) -> bool { 511 if (const Instruction *I = dyn_cast<Instruction>(V)) { 512 if (!I->getParent() || !I->getParent()->getParent()) 513 CheckFailed("Global is referenced by parentless instruction!", &GV, &M, 514 I); 515 else if (I->getParent()->getParent()->getParent() != &M) 516 CheckFailed("Global is referenced in a different module!", &GV, &M, I, 517 I->getParent()->getParent(), 518 I->getParent()->getParent()->getParent()); 519 return false; 520 } else if (const Function *F = dyn_cast<Function>(V)) { 521 if (F->getParent() != &M) 522 CheckFailed("Global is used by function in a different module", &GV, &M, 523 F, F->getParent()); 524 return false; 525 } 526 return true; 527 }); 528 } 529 530 void Verifier::visitGlobalVariable(const GlobalVariable &GV) { 531 if (GV.hasInitializer()) { 532 Assert(GV.getInitializer()->getType() == GV.getValueType(), 533 "Global variable initializer type does not match global " 534 "variable type!", 535 &GV); 536 537 // If the global has common linkage, it must have a zero initializer and 538 // cannot be constant. 539 if (GV.hasCommonLinkage()) { 540 Assert(GV.getInitializer()->isNullValue(), 541 "'common' global must have a zero initializer!", &GV); 542 Assert(!GV.isConstant(), "'common' global may not be marked constant!", 543 &GV); 544 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV); 545 } 546 } 547 548 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" || 549 GV.getName() == "llvm.global_dtors")) { 550 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(), 551 "invalid linkage for intrinsic global variable", &GV); 552 // Don't worry about emitting an error for it not being an array, 553 // visitGlobalValue will complain on appending non-array. 554 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) { 555 StructType *STy = dyn_cast<StructType>(ATy->getElementType()); 556 PointerType *FuncPtrTy = 557 FunctionType::get(Type::getVoidTy(Context), false)->getPointerTo(); 558 // FIXME: Reject the 2-field form in LLVM 4.0. 559 Assert(STy && 560 (STy->getNumElements() == 2 || STy->getNumElements() == 3) && 561 STy->getTypeAtIndex(0u)->isIntegerTy(32) && 562 STy->getTypeAtIndex(1) == FuncPtrTy, 563 "wrong type for intrinsic global variable", &GV); 564 if (STy->getNumElements() == 3) { 565 Type *ETy = STy->getTypeAtIndex(2); 566 Assert(ETy->isPointerTy() && 567 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8), 568 "wrong type for intrinsic global variable", &GV); 569 } 570 } 571 } 572 573 if (GV.hasName() && (GV.getName() == "llvm.used" || 574 GV.getName() == "llvm.compiler.used")) { 575 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(), 576 "invalid linkage for intrinsic global variable", &GV); 577 Type *GVType = GV.getValueType(); 578 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) { 579 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType()); 580 Assert(PTy, "wrong type for intrinsic global variable", &GV); 581 if (GV.hasInitializer()) { 582 const Constant *Init = GV.getInitializer(); 583 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init); 584 Assert(InitArray, "wrong initalizer for intrinsic global variable", 585 Init); 586 for (Value *Op : InitArray->operands()) { 587 Value *V = Op->stripPointerCastsNoFollowAliases(); 588 Assert(isa<GlobalVariable>(V) || isa<Function>(V) || 589 isa<GlobalAlias>(V), 590 "invalid llvm.used member", V); 591 Assert(V->hasName(), "members of llvm.used must be named", V); 592 } 593 } 594 } 595 } 596 597 Assert(!GV.hasDLLImportStorageClass() || 598 (GV.isDeclaration() && GV.hasExternalLinkage()) || 599 GV.hasAvailableExternallyLinkage(), 600 "Global is marked as dllimport, but not external", &GV); 601 602 if (!GV.hasInitializer()) { 603 visitGlobalValue(GV); 604 return; 605 } 606 607 // Walk any aggregate initializers looking for bitcasts between address spaces 608 visitConstantExprsRecursively(GV.getInitializer()); 609 610 visitGlobalValue(GV); 611 } 612 613 void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) { 614 SmallPtrSet<const GlobalAlias*, 4> Visited; 615 Visited.insert(&GA); 616 visitAliaseeSubExpr(Visited, GA, C); 617 } 618 619 void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited, 620 const GlobalAlias &GA, const Constant &C) { 621 if (const auto *GV = dyn_cast<GlobalValue>(&C)) { 622 Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition", 623 &GA); 624 625 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) { 626 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA); 627 628 Assert(!GA2->isInterposable(), "Alias cannot point to an interposable alias", 629 &GA); 630 } else { 631 // Only continue verifying subexpressions of GlobalAliases. 632 // Do not recurse into global initializers. 633 return; 634 } 635 } 636 637 if (const auto *CE = dyn_cast<ConstantExpr>(&C)) 638 visitConstantExprsRecursively(CE); 639 640 for (const Use &U : C.operands()) { 641 Value *V = &*U; 642 if (const auto *GA2 = dyn_cast<GlobalAlias>(V)) 643 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee()); 644 else if (const auto *C2 = dyn_cast<Constant>(V)) 645 visitAliaseeSubExpr(Visited, GA, *C2); 646 } 647 } 648 649 void Verifier::visitGlobalAlias(const GlobalAlias &GA) { 650 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()), 651 "Alias should have private, internal, linkonce, weak, linkonce_odr, " 652 "weak_odr, or external linkage!", 653 &GA); 654 const Constant *Aliasee = GA.getAliasee(); 655 Assert(Aliasee, "Aliasee cannot be NULL!", &GA); 656 Assert(GA.getType() == Aliasee->getType(), 657 "Alias and aliasee types should match!", &GA); 658 659 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee), 660 "Aliasee should be either GlobalValue or ConstantExpr", &GA); 661 662 visitAliaseeSubExpr(GA, *Aliasee); 663 664 visitGlobalValue(GA); 665 } 666 667 void Verifier::visitNamedMDNode(const NamedMDNode &NMD) { 668 for (const MDNode *MD : NMD.operands()) { 669 if (NMD.getName() == "llvm.dbg.cu") { 670 AssertDI(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD); 671 } 672 673 if (!MD) 674 continue; 675 676 visitMDNode(*MD); 677 } 678 } 679 680 void Verifier::visitMDNode(const MDNode &MD) { 681 // Only visit each node once. Metadata can be mutually recursive, so this 682 // avoids infinite recursion here, as well as being an optimization. 683 if (!MDNodes.insert(&MD).second) 684 return; 685 686 switch (MD.getMetadataID()) { 687 default: 688 llvm_unreachable("Invalid MDNode subclass"); 689 case Metadata::MDTupleKind: 690 break; 691 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \ 692 case Metadata::CLASS##Kind: \ 693 visit##CLASS(cast<CLASS>(MD)); \ 694 break; 695 #include "llvm/IR/Metadata.def" 696 } 697 698 for (const Metadata *Op : MD.operands()) { 699 if (!Op) 700 continue; 701 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!", 702 &MD, Op); 703 if (auto *N = dyn_cast<MDNode>(Op)) { 704 visitMDNode(*N); 705 continue; 706 } 707 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) { 708 visitValueAsMetadata(*V, nullptr); 709 continue; 710 } 711 } 712 713 // Check these last, so we diagnose problems in operands first. 714 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD); 715 Assert(MD.isResolved(), "All nodes should be resolved!", &MD); 716 } 717 718 void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) { 719 Assert(MD.getValue(), "Expected valid value", &MD); 720 Assert(!MD.getValue()->getType()->isMetadataTy(), 721 "Unexpected metadata round-trip through values", &MD, MD.getValue()); 722 723 auto *L = dyn_cast<LocalAsMetadata>(&MD); 724 if (!L) 725 return; 726 727 Assert(F, "function-local metadata used outside a function", L); 728 729 // If this was an instruction, bb, or argument, verify that it is in the 730 // function that we expect. 731 Function *ActualF = nullptr; 732 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) { 733 Assert(I->getParent(), "function-local metadata not in basic block", L, I); 734 ActualF = I->getParent()->getParent(); 735 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue())) 736 ActualF = BB->getParent(); 737 else if (Argument *A = dyn_cast<Argument>(L->getValue())) 738 ActualF = A->getParent(); 739 assert(ActualF && "Unimplemented function local metadata case!"); 740 741 Assert(ActualF == F, "function-local metadata used in wrong function", L); 742 } 743 744 void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) { 745 Metadata *MD = MDV.getMetadata(); 746 if (auto *N = dyn_cast<MDNode>(MD)) { 747 visitMDNode(*N); 748 return; 749 } 750 751 // Only visit each node once. Metadata can be mutually recursive, so this 752 // avoids infinite recursion here, as well as being an optimization. 753 if (!MDNodes.insert(MD).second) 754 return; 755 756 if (auto *V = dyn_cast<ValueAsMetadata>(MD)) 757 visitValueAsMetadata(*V, F); 758 } 759 760 static bool isType(const Metadata *MD) { return !MD || isa<DIType>(MD); } 761 static bool isScope(const Metadata *MD) { return !MD || isa<DIScope>(MD); } 762 static bool isDINode(const Metadata *MD) { return !MD || isa<DINode>(MD); } 763 764 template <class Ty> 765 bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) { 766 for (Metadata *MD : N.operands()) { 767 if (MD) { 768 if (!isa<Ty>(MD)) 769 return false; 770 } else { 771 if (!AllowNull) 772 return false; 773 } 774 } 775 return true; 776 } 777 778 template <class Ty> 779 bool isValidMetadataArray(const MDTuple &N) { 780 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false); 781 } 782 783 template <class Ty> 784 bool isValidMetadataNullArray(const MDTuple &N) { 785 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true); 786 } 787 788 void Verifier::visitDILocation(const DILocation &N) { 789 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()), 790 "location requires a valid scope", &N, N.getRawScope()); 791 if (auto *IA = N.getRawInlinedAt()) 792 AssertDI(isa<DILocation>(IA), "inlined-at should be a location", &N, IA); 793 } 794 795 void Verifier::visitGenericDINode(const GenericDINode &N) { 796 AssertDI(N.getTag(), "invalid tag", &N); 797 } 798 799 void Verifier::visitDIScope(const DIScope &N) { 800 if (auto *F = N.getRawFile()) 801 AssertDI(isa<DIFile>(F), "invalid file", &N, F); 802 } 803 804 void Verifier::visitDISubrange(const DISubrange &N) { 805 AssertDI(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N); 806 AssertDI(N.getCount() >= -1, "invalid subrange count", &N); 807 } 808 809 void Verifier::visitDIEnumerator(const DIEnumerator &N) { 810 AssertDI(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N); 811 } 812 813 void Verifier::visitDIBasicType(const DIBasicType &N) { 814 AssertDI(N.getTag() == dwarf::DW_TAG_base_type || 815 N.getTag() == dwarf::DW_TAG_unspecified_type, 816 "invalid tag", &N); 817 } 818 819 void Verifier::visitDIDerivedType(const DIDerivedType &N) { 820 // Common scope checks. 821 visitDIScope(N); 822 823 AssertDI(N.getTag() == dwarf::DW_TAG_typedef || 824 N.getTag() == dwarf::DW_TAG_pointer_type || 825 N.getTag() == dwarf::DW_TAG_ptr_to_member_type || 826 N.getTag() == dwarf::DW_TAG_reference_type || 827 N.getTag() == dwarf::DW_TAG_rvalue_reference_type || 828 N.getTag() == dwarf::DW_TAG_const_type || 829 N.getTag() == dwarf::DW_TAG_volatile_type || 830 N.getTag() == dwarf::DW_TAG_restrict_type || 831 N.getTag() == dwarf::DW_TAG_member || 832 N.getTag() == dwarf::DW_TAG_inheritance || 833 N.getTag() == dwarf::DW_TAG_friend, 834 "invalid tag", &N); 835 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) { 836 AssertDI(isType(N.getRawExtraData()), "invalid pointer to member type", &N, 837 N.getRawExtraData()); 838 } 839 840 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope()); 841 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N, 842 N.getRawBaseType()); 843 } 844 845 static bool hasConflictingReferenceFlags(unsigned Flags) { 846 return (Flags & DINode::FlagLValueReference) && 847 (Flags & DINode::FlagRValueReference); 848 } 849 850 void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) { 851 auto *Params = dyn_cast<MDTuple>(&RawParams); 852 AssertDI(Params, "invalid template params", &N, &RawParams); 853 for (Metadata *Op : Params->operands()) { 854 AssertDI(Op && isa<DITemplateParameter>(Op), "invalid template parameter", 855 &N, Params, Op); 856 } 857 } 858 859 void Verifier::visitDICompositeType(const DICompositeType &N) { 860 // Common scope checks. 861 visitDIScope(N); 862 863 AssertDI(N.getTag() == dwarf::DW_TAG_array_type || 864 N.getTag() == dwarf::DW_TAG_structure_type || 865 N.getTag() == dwarf::DW_TAG_union_type || 866 N.getTag() == dwarf::DW_TAG_enumeration_type || 867 N.getTag() == dwarf::DW_TAG_class_type, 868 "invalid tag", &N); 869 870 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope()); 871 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N, 872 N.getRawBaseType()); 873 874 AssertDI(!N.getRawElements() || isa<MDTuple>(N.getRawElements()), 875 "invalid composite elements", &N, N.getRawElements()); 876 AssertDI(isType(N.getRawVTableHolder()), "invalid vtable holder", &N, 877 N.getRawVTableHolder()); 878 AssertDI(!hasConflictingReferenceFlags(N.getFlags()), 879 "invalid reference flags", &N); 880 if (auto *Params = N.getRawTemplateParams()) 881 visitTemplateParams(N, *Params); 882 883 if (N.getTag() == dwarf::DW_TAG_class_type || 884 N.getTag() == dwarf::DW_TAG_union_type) { 885 AssertDI(N.getFile() && !N.getFile()->getFilename().empty(), 886 "class/union requires a filename", &N, N.getFile()); 887 } 888 } 889 890 void Verifier::visitDISubroutineType(const DISubroutineType &N) { 891 AssertDI(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N); 892 if (auto *Types = N.getRawTypeArray()) { 893 AssertDI(isa<MDTuple>(Types), "invalid composite elements", &N, Types); 894 for (Metadata *Ty : N.getTypeArray()->operands()) { 895 AssertDI(isType(Ty), "invalid subroutine type ref", &N, Types, Ty); 896 } 897 } 898 AssertDI(!hasConflictingReferenceFlags(N.getFlags()), 899 "invalid reference flags", &N); 900 } 901 902 void Verifier::visitDIFile(const DIFile &N) { 903 AssertDI(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N); 904 } 905 906 void Verifier::visitDICompileUnit(const DICompileUnit &N) { 907 AssertDI(N.isDistinct(), "compile units must be distinct", &N); 908 AssertDI(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N); 909 910 // Don't bother verifying the compilation directory or producer string 911 // as those could be empty. 912 AssertDI(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N, 913 N.getRawFile()); 914 AssertDI(!N.getFile()->getFilename().empty(), "invalid filename", &N, 915 N.getFile()); 916 917 AssertDI((N.getEmissionKind() <= DICompileUnit::LastEmissionKind), 918 "invalid emission kind", &N); 919 920 if (auto *Array = N.getRawEnumTypes()) { 921 AssertDI(isa<MDTuple>(Array), "invalid enum list", &N, Array); 922 for (Metadata *Op : N.getEnumTypes()->operands()) { 923 auto *Enum = dyn_cast_or_null<DICompositeType>(Op); 924 AssertDI(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type, 925 "invalid enum type", &N, N.getEnumTypes(), Op); 926 } 927 } 928 if (auto *Array = N.getRawRetainedTypes()) { 929 AssertDI(isa<MDTuple>(Array), "invalid retained type list", &N, Array); 930 for (Metadata *Op : N.getRetainedTypes()->operands()) { 931 AssertDI(Op && (isa<DIType>(Op) || 932 (isa<DISubprogram>(Op) && 933 cast<DISubprogram>(Op)->isDefinition() == false)), 934 "invalid retained type", &N, Op); 935 } 936 } 937 if (auto *Array = N.getRawGlobalVariables()) { 938 AssertDI(isa<MDTuple>(Array), "invalid global variable list", &N, Array); 939 for (Metadata *Op : N.getGlobalVariables()->operands()) { 940 AssertDI(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref", 941 &N, Op); 942 } 943 } 944 if (auto *Array = N.getRawImportedEntities()) { 945 AssertDI(isa<MDTuple>(Array), "invalid imported entity list", &N, Array); 946 for (Metadata *Op : N.getImportedEntities()->operands()) { 947 AssertDI(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref", 948 &N, Op); 949 } 950 } 951 if (auto *Array = N.getRawMacros()) { 952 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array); 953 for (Metadata *Op : N.getMacros()->operands()) { 954 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op); 955 } 956 } 957 CUVisited.insert(&N); 958 } 959 960 void Verifier::visitDISubprogram(const DISubprogram &N) { 961 AssertDI(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N); 962 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope()); 963 if (auto *F = N.getRawFile()) 964 AssertDI(isa<DIFile>(F), "invalid file", &N, F); 965 if (auto *T = N.getRawType()) 966 AssertDI(isa<DISubroutineType>(T), "invalid subroutine type", &N, T); 967 AssertDI(isType(N.getRawContainingType()), "invalid containing type", &N, 968 N.getRawContainingType()); 969 if (auto *Params = N.getRawTemplateParams()) 970 visitTemplateParams(N, *Params); 971 if (auto *S = N.getRawDeclaration()) 972 AssertDI(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(), 973 "invalid subprogram declaration", &N, S); 974 if (auto *RawVars = N.getRawVariables()) { 975 auto *Vars = dyn_cast<MDTuple>(RawVars); 976 AssertDI(Vars, "invalid variable list", &N, RawVars); 977 for (Metadata *Op : Vars->operands()) { 978 AssertDI(Op && isa<DILocalVariable>(Op), "invalid local variable", &N, 979 Vars, Op); 980 } 981 } 982 AssertDI(!hasConflictingReferenceFlags(N.getFlags()), 983 "invalid reference flags", &N); 984 985 auto *Unit = N.getRawUnit(); 986 if (N.isDefinition()) { 987 // Subprogram definitions (not part of the type hierarchy). 988 AssertDI(N.isDistinct(), "subprogram definitions must be distinct", &N); 989 AssertDI(Unit, "subprogram definitions must have a compile unit", &N); 990 AssertDI(isa<DICompileUnit>(Unit), "invalid unit type", &N, Unit); 991 } else { 992 // Subprogram declarations (part of the type hierarchy). 993 AssertDI(!Unit, "subprogram declarations must not have a compile unit", &N); 994 } 995 } 996 997 void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) { 998 AssertDI(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N); 999 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()), 1000 "invalid local scope", &N, N.getRawScope()); 1001 } 1002 1003 void Verifier::visitDILexicalBlock(const DILexicalBlock &N) { 1004 visitDILexicalBlockBase(N); 1005 1006 AssertDI(N.getLine() || !N.getColumn(), 1007 "cannot have column info without line info", &N); 1008 } 1009 1010 void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) { 1011 visitDILexicalBlockBase(N); 1012 } 1013 1014 void Verifier::visitDINamespace(const DINamespace &N) { 1015 AssertDI(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N); 1016 if (auto *S = N.getRawScope()) 1017 AssertDI(isa<DIScope>(S), "invalid scope ref", &N, S); 1018 } 1019 1020 void Verifier::visitDIMacro(const DIMacro &N) { 1021 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_define || 1022 N.getMacinfoType() == dwarf::DW_MACINFO_undef, 1023 "invalid macinfo type", &N); 1024 AssertDI(!N.getName().empty(), "anonymous macro", &N); 1025 if (!N.getValue().empty()) { 1026 assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix"); 1027 } 1028 } 1029 1030 void Verifier::visitDIMacroFile(const DIMacroFile &N) { 1031 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_start_file, 1032 "invalid macinfo type", &N); 1033 if (auto *F = N.getRawFile()) 1034 AssertDI(isa<DIFile>(F), "invalid file", &N, F); 1035 1036 if (auto *Array = N.getRawElements()) { 1037 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array); 1038 for (Metadata *Op : N.getElements()->operands()) { 1039 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op); 1040 } 1041 } 1042 } 1043 1044 void Verifier::visitDIModule(const DIModule &N) { 1045 AssertDI(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N); 1046 AssertDI(!N.getName().empty(), "anonymous module", &N); 1047 } 1048 1049 void Verifier::visitDITemplateParameter(const DITemplateParameter &N) { 1050 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType()); 1051 } 1052 1053 void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) { 1054 visitDITemplateParameter(N); 1055 1056 AssertDI(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag", 1057 &N); 1058 } 1059 1060 void Verifier::visitDITemplateValueParameter( 1061 const DITemplateValueParameter &N) { 1062 visitDITemplateParameter(N); 1063 1064 AssertDI(N.getTag() == dwarf::DW_TAG_template_value_parameter || 1065 N.getTag() == dwarf::DW_TAG_GNU_template_template_param || 1066 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack, 1067 "invalid tag", &N); 1068 } 1069 1070 void Verifier::visitDIVariable(const DIVariable &N) { 1071 if (auto *S = N.getRawScope()) 1072 AssertDI(isa<DIScope>(S), "invalid scope", &N, S); 1073 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType()); 1074 if (auto *F = N.getRawFile()) 1075 AssertDI(isa<DIFile>(F), "invalid file", &N, F); 1076 } 1077 1078 void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) { 1079 // Checks common to all variables. 1080 visitDIVariable(N); 1081 1082 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N); 1083 AssertDI(!N.getName().empty(), "missing global variable name", &N); 1084 if (auto *V = N.getRawVariable()) { 1085 AssertDI(isa<ConstantAsMetadata>(V) && 1086 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()), 1087 "invalid global varaible ref", &N, V); 1088 visitConstantExprsRecursively(cast<ConstantAsMetadata>(V)->getValue()); 1089 } 1090 if (auto *Member = N.getRawStaticDataMemberDeclaration()) { 1091 AssertDI(isa<DIDerivedType>(Member), 1092 "invalid static data member declaration", &N, Member); 1093 } 1094 } 1095 1096 void Verifier::visitDILocalVariable(const DILocalVariable &N) { 1097 // Checks common to all variables. 1098 visitDIVariable(N); 1099 1100 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N); 1101 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()), 1102 "local variable requires a valid scope", &N, N.getRawScope()); 1103 } 1104 1105 void Verifier::visitDIExpression(const DIExpression &N) { 1106 AssertDI(N.isValid(), "invalid expression", &N); 1107 } 1108 1109 void Verifier::visitDIObjCProperty(const DIObjCProperty &N) { 1110 AssertDI(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N); 1111 if (auto *T = N.getRawType()) 1112 AssertDI(isType(T), "invalid type ref", &N, T); 1113 if (auto *F = N.getRawFile()) 1114 AssertDI(isa<DIFile>(F), "invalid file", &N, F); 1115 } 1116 1117 void Verifier::visitDIImportedEntity(const DIImportedEntity &N) { 1118 AssertDI(N.getTag() == dwarf::DW_TAG_imported_module || 1119 N.getTag() == dwarf::DW_TAG_imported_declaration, 1120 "invalid tag", &N); 1121 if (auto *S = N.getRawScope()) 1122 AssertDI(isa<DIScope>(S), "invalid scope for imported entity", &N, S); 1123 AssertDI(isDINode(N.getRawEntity()), "invalid imported entity", &N, 1124 N.getRawEntity()); 1125 } 1126 1127 void Verifier::visitComdat(const Comdat &C) { 1128 // The Module is invalid if the GlobalValue has private linkage. Entities 1129 // with private linkage don't have entries in the symbol table. 1130 if (const GlobalValue *GV = M.getNamedValue(C.getName())) 1131 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage", 1132 GV); 1133 } 1134 1135 void Verifier::visitModuleIdents(const Module &M) { 1136 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident"); 1137 if (!Idents) 1138 return; 1139 1140 // llvm.ident takes a list of metadata entry. Each entry has only one string. 1141 // Scan each llvm.ident entry and make sure that this requirement is met. 1142 for (const MDNode *N : Idents->operands()) { 1143 Assert(N->getNumOperands() == 1, 1144 "incorrect number of operands in llvm.ident metadata", N); 1145 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)), 1146 ("invalid value for llvm.ident metadata entry operand" 1147 "(the operand should be a string)"), 1148 N->getOperand(0)); 1149 } 1150 } 1151 1152 void Verifier::visitModuleFlags(const Module &M) { 1153 const NamedMDNode *Flags = M.getModuleFlagsMetadata(); 1154 if (!Flags) return; 1155 1156 // Scan each flag, and track the flags and requirements. 1157 DenseMap<const MDString*, const MDNode*> SeenIDs; 1158 SmallVector<const MDNode*, 16> Requirements; 1159 for (const MDNode *MDN : Flags->operands()) 1160 visitModuleFlag(MDN, SeenIDs, Requirements); 1161 1162 // Validate that the requirements in the module are valid. 1163 for (const MDNode *Requirement : Requirements) { 1164 const MDString *Flag = cast<MDString>(Requirement->getOperand(0)); 1165 const Metadata *ReqValue = Requirement->getOperand(1); 1166 1167 const MDNode *Op = SeenIDs.lookup(Flag); 1168 if (!Op) { 1169 CheckFailed("invalid requirement on flag, flag is not present in module", 1170 Flag); 1171 continue; 1172 } 1173 1174 if (Op->getOperand(2) != ReqValue) { 1175 CheckFailed(("invalid requirement on flag, " 1176 "flag does not have the required value"), 1177 Flag); 1178 continue; 1179 } 1180 } 1181 } 1182 1183 void 1184 Verifier::visitModuleFlag(const MDNode *Op, 1185 DenseMap<const MDString *, const MDNode *> &SeenIDs, 1186 SmallVectorImpl<const MDNode *> &Requirements) { 1187 // Each module flag should have three arguments, the merge behavior (a 1188 // constant int), the flag ID (an MDString), and the value. 1189 Assert(Op->getNumOperands() == 3, 1190 "incorrect number of operands in module flag", Op); 1191 Module::ModFlagBehavior MFB; 1192 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) { 1193 Assert( 1194 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)), 1195 "invalid behavior operand in module flag (expected constant integer)", 1196 Op->getOperand(0)); 1197 Assert(false, 1198 "invalid behavior operand in module flag (unexpected constant)", 1199 Op->getOperand(0)); 1200 } 1201 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1)); 1202 Assert(ID, "invalid ID operand in module flag (expected metadata string)", 1203 Op->getOperand(1)); 1204 1205 // Sanity check the values for behaviors with additional requirements. 1206 switch (MFB) { 1207 case Module::Error: 1208 case Module::Warning: 1209 case Module::Override: 1210 // These behavior types accept any value. 1211 break; 1212 1213 case Module::Require: { 1214 // The value should itself be an MDNode with two operands, a flag ID (an 1215 // MDString), and a value. 1216 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2)); 1217 Assert(Value && Value->getNumOperands() == 2, 1218 "invalid value for 'require' module flag (expected metadata pair)", 1219 Op->getOperand(2)); 1220 Assert(isa<MDString>(Value->getOperand(0)), 1221 ("invalid value for 'require' module flag " 1222 "(first value operand should be a string)"), 1223 Value->getOperand(0)); 1224 1225 // Append it to the list of requirements, to check once all module flags are 1226 // scanned. 1227 Requirements.push_back(Value); 1228 break; 1229 } 1230 1231 case Module::Append: 1232 case Module::AppendUnique: { 1233 // These behavior types require the operand be an MDNode. 1234 Assert(isa<MDNode>(Op->getOperand(2)), 1235 "invalid value for 'append'-type module flag " 1236 "(expected a metadata node)", 1237 Op->getOperand(2)); 1238 break; 1239 } 1240 } 1241 1242 // Unless this is a "requires" flag, check the ID is unique. 1243 if (MFB != Module::Require) { 1244 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second; 1245 Assert(Inserted, 1246 "module flag identifiers must be unique (or of 'require' type)", ID); 1247 } 1248 } 1249 1250 void Verifier::verifyAttributeTypes(AttributeSet Attrs, unsigned Idx, 1251 bool isFunction, const Value *V) { 1252 unsigned Slot = ~0U; 1253 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I) 1254 if (Attrs.getSlotIndex(I) == Idx) { 1255 Slot = I; 1256 break; 1257 } 1258 1259 assert(Slot != ~0U && "Attribute set inconsistency!"); 1260 1261 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot); 1262 I != E; ++I) { 1263 if (I->isStringAttribute()) 1264 continue; 1265 1266 if (I->getKindAsEnum() == Attribute::NoReturn || 1267 I->getKindAsEnum() == Attribute::NoUnwind || 1268 I->getKindAsEnum() == Attribute::NoInline || 1269 I->getKindAsEnum() == Attribute::AlwaysInline || 1270 I->getKindAsEnum() == Attribute::OptimizeForSize || 1271 I->getKindAsEnum() == Attribute::StackProtect || 1272 I->getKindAsEnum() == Attribute::StackProtectReq || 1273 I->getKindAsEnum() == Attribute::StackProtectStrong || 1274 I->getKindAsEnum() == Attribute::SafeStack || 1275 I->getKindAsEnum() == Attribute::NoRedZone || 1276 I->getKindAsEnum() == Attribute::NoImplicitFloat || 1277 I->getKindAsEnum() == Attribute::Naked || 1278 I->getKindAsEnum() == Attribute::InlineHint || 1279 I->getKindAsEnum() == Attribute::StackAlignment || 1280 I->getKindAsEnum() == Attribute::UWTable || 1281 I->getKindAsEnum() == Attribute::NonLazyBind || 1282 I->getKindAsEnum() == Attribute::ReturnsTwice || 1283 I->getKindAsEnum() == Attribute::SanitizeAddress || 1284 I->getKindAsEnum() == Attribute::SanitizeThread || 1285 I->getKindAsEnum() == Attribute::SanitizeMemory || 1286 I->getKindAsEnum() == Attribute::MinSize || 1287 I->getKindAsEnum() == Attribute::NoDuplicate || 1288 I->getKindAsEnum() == Attribute::Builtin || 1289 I->getKindAsEnum() == Attribute::NoBuiltin || 1290 I->getKindAsEnum() == Attribute::Cold || 1291 I->getKindAsEnum() == Attribute::OptimizeNone || 1292 I->getKindAsEnum() == Attribute::JumpTable || 1293 I->getKindAsEnum() == Attribute::Convergent || 1294 I->getKindAsEnum() == Attribute::ArgMemOnly || 1295 I->getKindAsEnum() == Attribute::NoRecurse || 1296 I->getKindAsEnum() == Attribute::InaccessibleMemOnly || 1297 I->getKindAsEnum() == Attribute::InaccessibleMemOrArgMemOnly || 1298 I->getKindAsEnum() == Attribute::AllocSize) { 1299 if (!isFunction) { 1300 CheckFailed("Attribute '" + I->getAsString() + 1301 "' only applies to functions!", V); 1302 return; 1303 } 1304 } else if (I->getKindAsEnum() == Attribute::ReadOnly || 1305 I->getKindAsEnum() == Attribute::WriteOnly || 1306 I->getKindAsEnum() == Attribute::ReadNone) { 1307 if (Idx == 0) { 1308 CheckFailed("Attribute '" + I->getAsString() + 1309 "' does not apply to function returns"); 1310 return; 1311 } 1312 } else if (isFunction) { 1313 CheckFailed("Attribute '" + I->getAsString() + 1314 "' does not apply to functions!", V); 1315 return; 1316 } 1317 } 1318 } 1319 1320 // VerifyParameterAttrs - Check the given attributes for an argument or return 1321 // value of the specified type. The value V is printed in error messages. 1322 void Verifier::verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty, 1323 bool isReturnValue, const Value *V) { 1324 if (!Attrs.hasAttributes(Idx)) 1325 return; 1326 1327 verifyAttributeTypes(Attrs, Idx, false, V); 1328 1329 if (isReturnValue) 1330 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) && 1331 !Attrs.hasAttribute(Idx, Attribute::Nest) && 1332 !Attrs.hasAttribute(Idx, Attribute::StructRet) && 1333 !Attrs.hasAttribute(Idx, Attribute::NoCapture) && 1334 !Attrs.hasAttribute(Idx, Attribute::Returned) && 1335 !Attrs.hasAttribute(Idx, Attribute::InAlloca) && 1336 !Attrs.hasAttribute(Idx, Attribute::SwiftSelf) && 1337 !Attrs.hasAttribute(Idx, Attribute::SwiftError), 1338 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', " 1339 "'returned', 'swiftself', and 'swifterror' do not apply to return " 1340 "values!", 1341 V); 1342 1343 // Check for mutually incompatible attributes. Only inreg is compatible with 1344 // sret. 1345 unsigned AttrCount = 0; 1346 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal); 1347 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca); 1348 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) || 1349 Attrs.hasAttribute(Idx, Attribute::InReg); 1350 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest); 1351 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', " 1352 "and 'sret' are incompatible!", 1353 V); 1354 1355 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) && 1356 Attrs.hasAttribute(Idx, Attribute::ReadOnly)), 1357 "Attributes " 1358 "'inalloca and readonly' are incompatible!", 1359 V); 1360 1361 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) && 1362 Attrs.hasAttribute(Idx, Attribute::Returned)), 1363 "Attributes " 1364 "'sret and returned' are incompatible!", 1365 V); 1366 1367 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) && 1368 Attrs.hasAttribute(Idx, Attribute::SExt)), 1369 "Attributes " 1370 "'zeroext and signext' are incompatible!", 1371 V); 1372 1373 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) && 1374 Attrs.hasAttribute(Idx, Attribute::ReadOnly)), 1375 "Attributes " 1376 "'readnone and readonly' are incompatible!", 1377 V); 1378 1379 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) && 1380 Attrs.hasAttribute(Idx, Attribute::WriteOnly)), 1381 "Attributes " 1382 "'readnone and writeonly' are incompatible!", 1383 V); 1384 1385 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadOnly) && 1386 Attrs.hasAttribute(Idx, Attribute::WriteOnly)), 1387 "Attributes " 1388 "'readonly and writeonly' are incompatible!", 1389 V); 1390 1391 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) && 1392 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)), 1393 "Attributes " 1394 "'noinline and alwaysinline' are incompatible!", 1395 V); 1396 1397 Assert( 1398 !AttrBuilder(Attrs, Idx).overlaps(AttributeFuncs::typeIncompatible(Ty)), 1399 "Wrong types for attribute: " + 1400 AttributeSet::get(Context, Idx, AttributeFuncs::typeIncompatible(Ty)) 1401 .getAsString(Idx), 1402 V); 1403 1404 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) { 1405 SmallPtrSet<Type*, 4> Visited; 1406 if (!PTy->getElementType()->isSized(&Visited)) { 1407 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) && 1408 !Attrs.hasAttribute(Idx, Attribute::InAlloca), 1409 "Attributes 'byval' and 'inalloca' do not support unsized types!", 1410 V); 1411 } 1412 if (!isa<PointerType>(PTy->getElementType())) 1413 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError), 1414 "Attribute 'swifterror' only applies to parameters " 1415 "with pointer to pointer type!", 1416 V); 1417 } else { 1418 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal), 1419 "Attribute 'byval' only applies to parameters with pointer type!", 1420 V); 1421 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError), 1422 "Attribute 'swifterror' only applies to parameters " 1423 "with pointer type!", 1424 V); 1425 } 1426 } 1427 1428 // Check parameter attributes against a function type. 1429 // The value V is printed in error messages. 1430 void Verifier::verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs, 1431 const Value *V) { 1432 if (Attrs.isEmpty()) 1433 return; 1434 1435 bool SawNest = false; 1436 bool SawReturned = false; 1437 bool SawSRet = false; 1438 bool SawSwiftSelf = false; 1439 bool SawSwiftError = false; 1440 1441 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) { 1442 unsigned Idx = Attrs.getSlotIndex(i); 1443 1444 Type *Ty; 1445 if (Idx == 0) 1446 Ty = FT->getReturnType(); 1447 else if (Idx-1 < FT->getNumParams()) 1448 Ty = FT->getParamType(Idx-1); 1449 else 1450 break; // VarArgs attributes, verified elsewhere. 1451 1452 verifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V); 1453 1454 if (Idx == 0) 1455 continue; 1456 1457 if (Attrs.hasAttribute(Idx, Attribute::Nest)) { 1458 Assert(!SawNest, "More than one parameter has attribute nest!", V); 1459 SawNest = true; 1460 } 1461 1462 if (Attrs.hasAttribute(Idx, Attribute::Returned)) { 1463 Assert(!SawReturned, "More than one parameter has attribute returned!", 1464 V); 1465 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()), 1466 "Incompatible " 1467 "argument and return types for 'returned' attribute", 1468 V); 1469 SawReturned = true; 1470 } 1471 1472 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) { 1473 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V); 1474 Assert(Idx == 1 || Idx == 2, 1475 "Attribute 'sret' is not on first or second parameter!", V); 1476 SawSRet = true; 1477 } 1478 1479 if (Attrs.hasAttribute(Idx, Attribute::SwiftSelf)) { 1480 Assert(!SawSwiftSelf, "Cannot have multiple 'swiftself' parameters!", V); 1481 SawSwiftSelf = true; 1482 } 1483 1484 if (Attrs.hasAttribute(Idx, Attribute::SwiftError)) { 1485 Assert(!SawSwiftError, "Cannot have multiple 'swifterror' parameters!", 1486 V); 1487 SawSwiftError = true; 1488 } 1489 1490 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) { 1491 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!", 1492 V); 1493 } 1494 } 1495 1496 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex)) 1497 return; 1498 1499 verifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V); 1500 1501 Assert( 1502 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) && 1503 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)), 1504 "Attributes 'readnone and readonly' are incompatible!", V); 1505 1506 Assert( 1507 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) && 1508 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::WriteOnly)), 1509 "Attributes 'readnone and writeonly' are incompatible!", V); 1510 1511 Assert( 1512 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly) && 1513 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::WriteOnly)), 1514 "Attributes 'readonly and writeonly' are incompatible!", V); 1515 1516 Assert( 1517 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) && 1518 Attrs.hasAttribute(AttributeSet::FunctionIndex, 1519 Attribute::InaccessibleMemOrArgMemOnly)), 1520 "Attributes 'readnone and inaccessiblemem_or_argmemonly' are incompatible!", V); 1521 1522 Assert( 1523 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) && 1524 Attrs.hasAttribute(AttributeSet::FunctionIndex, 1525 Attribute::InaccessibleMemOnly)), 1526 "Attributes 'readnone and inaccessiblememonly' are incompatible!", V); 1527 1528 Assert( 1529 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) && 1530 Attrs.hasAttribute(AttributeSet::FunctionIndex, 1531 Attribute::AlwaysInline)), 1532 "Attributes 'noinline and alwaysinline' are incompatible!", V); 1533 1534 if (Attrs.hasAttribute(AttributeSet::FunctionIndex, 1535 Attribute::OptimizeNone)) { 1536 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline), 1537 "Attribute 'optnone' requires 'noinline'!", V); 1538 1539 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, 1540 Attribute::OptimizeForSize), 1541 "Attributes 'optsize and optnone' are incompatible!", V); 1542 1543 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize), 1544 "Attributes 'minsize and optnone' are incompatible!", V); 1545 } 1546 1547 if (Attrs.hasAttribute(AttributeSet::FunctionIndex, 1548 Attribute::JumpTable)) { 1549 const GlobalValue *GV = cast<GlobalValue>(V); 1550 Assert(GV->hasGlobalUnnamedAddr(), 1551 "Attribute 'jumptable' requires 'unnamed_addr'", V); 1552 } 1553 1554 if (Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::AllocSize)) { 1555 std::pair<unsigned, Optional<unsigned>> Args = 1556 Attrs.getAllocSizeArgs(AttributeSet::FunctionIndex); 1557 1558 auto CheckParam = [&](StringRef Name, unsigned ParamNo) { 1559 if (ParamNo >= FT->getNumParams()) { 1560 CheckFailed("'allocsize' " + Name + " argument is out of bounds", V); 1561 return false; 1562 } 1563 1564 if (!FT->getParamType(ParamNo)->isIntegerTy()) { 1565 CheckFailed("'allocsize' " + Name + 1566 " argument must refer to an integer parameter", 1567 V); 1568 return false; 1569 } 1570 1571 return true; 1572 }; 1573 1574 if (!CheckParam("element size", Args.first)) 1575 return; 1576 1577 if (Args.second && !CheckParam("number of elements", *Args.second)) 1578 return; 1579 } 1580 } 1581 1582 void Verifier::verifyFunctionMetadata( 1583 ArrayRef<std::pair<unsigned, MDNode *>> MDs) { 1584 for (const auto &Pair : MDs) { 1585 if (Pair.first == LLVMContext::MD_prof) { 1586 MDNode *MD = Pair.second; 1587 Assert(MD->getNumOperands() == 2, 1588 "!prof annotations should have exactly 2 operands", MD); 1589 1590 // Check first operand. 1591 Assert(MD->getOperand(0) != nullptr, "first operand should not be null", 1592 MD); 1593 Assert(isa<MDString>(MD->getOperand(0)), 1594 "expected string with name of the !prof annotation", MD); 1595 MDString *MDS = cast<MDString>(MD->getOperand(0)); 1596 StringRef ProfName = MDS->getString(); 1597 Assert(ProfName.equals("function_entry_count"), 1598 "first operand should be 'function_entry_count'", MD); 1599 1600 // Check second operand. 1601 Assert(MD->getOperand(1) != nullptr, "second operand should not be null", 1602 MD); 1603 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)), 1604 "expected integer argument to function_entry_count", MD); 1605 } 1606 } 1607 } 1608 1609 void Verifier::visitConstantExprsRecursively(const Constant *EntryC) { 1610 if (!ConstantExprVisited.insert(EntryC).second) 1611 return; 1612 1613 SmallVector<const Constant *, 16> Stack; 1614 Stack.push_back(EntryC); 1615 1616 while (!Stack.empty()) { 1617 const Constant *C = Stack.pop_back_val(); 1618 1619 // Check this constant expression. 1620 if (const auto *CE = dyn_cast<ConstantExpr>(C)) 1621 visitConstantExpr(CE); 1622 1623 if (const auto *GV = dyn_cast<GlobalValue>(C)) { 1624 // Global Values get visited separately, but we do need to make sure 1625 // that the global value is in the correct module 1626 Assert(GV->getParent() == &M, "Referencing global in another module!", 1627 EntryC, &M, GV, GV->getParent()); 1628 continue; 1629 } 1630 1631 // Visit all sub-expressions. 1632 for (const Use &U : C->operands()) { 1633 const auto *OpC = dyn_cast<Constant>(U); 1634 if (!OpC) 1635 continue; 1636 if (!ConstantExprVisited.insert(OpC).second) 1637 continue; 1638 Stack.push_back(OpC); 1639 } 1640 } 1641 } 1642 1643 void Verifier::visitConstantExpr(const ConstantExpr *CE) { 1644 if (CE->getOpcode() == Instruction::BitCast) 1645 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0), 1646 CE->getType()), 1647 "Invalid bitcast", CE); 1648 1649 if (CE->getOpcode() == Instruction::IntToPtr || 1650 CE->getOpcode() == Instruction::PtrToInt) { 1651 auto *PtrTy = CE->getOpcode() == Instruction::IntToPtr 1652 ? CE->getType() 1653 : CE->getOperand(0)->getType(); 1654 StringRef Msg = CE->getOpcode() == Instruction::IntToPtr 1655 ? "inttoptr not supported for non-integral pointers" 1656 : "ptrtoint not supported for non-integral pointers"; 1657 Assert( 1658 !DL.isNonIntegralPointerType(cast<PointerType>(PtrTy->getScalarType())), 1659 Msg); 1660 } 1661 } 1662 1663 bool Verifier::verifyAttributeCount(AttributeSet Attrs, unsigned Params) { 1664 if (Attrs.getNumSlots() == 0) 1665 return true; 1666 1667 unsigned LastSlot = Attrs.getNumSlots() - 1; 1668 unsigned LastIndex = Attrs.getSlotIndex(LastSlot); 1669 if (LastIndex <= Params 1670 || (LastIndex == AttributeSet::FunctionIndex 1671 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params))) 1672 return true; 1673 1674 return false; 1675 } 1676 1677 /// Verify that statepoint intrinsic is well formed. 1678 void Verifier::verifyStatepoint(ImmutableCallSite CS) { 1679 assert(CS.getCalledFunction() && 1680 CS.getCalledFunction()->getIntrinsicID() == 1681 Intrinsic::experimental_gc_statepoint); 1682 1683 const Instruction &CI = *CS.getInstruction(); 1684 1685 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() && 1686 !CS.onlyAccessesArgMemory(), 1687 "gc.statepoint must read and write all memory to preserve " 1688 "reordering restrictions required by safepoint semantics", 1689 &CI); 1690 1691 const Value *IDV = CS.getArgument(0); 1692 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer", 1693 &CI); 1694 1695 const Value *NumPatchBytesV = CS.getArgument(1); 1696 Assert(isa<ConstantInt>(NumPatchBytesV), 1697 "gc.statepoint number of patchable bytes must be a constant integer", 1698 &CI); 1699 const int64_t NumPatchBytes = 1700 cast<ConstantInt>(NumPatchBytesV)->getSExtValue(); 1701 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!"); 1702 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be " 1703 "positive", 1704 &CI); 1705 1706 const Value *Target = CS.getArgument(2); 1707 auto *PT = dyn_cast<PointerType>(Target->getType()); 1708 Assert(PT && PT->getElementType()->isFunctionTy(), 1709 "gc.statepoint callee must be of function pointer type", &CI, Target); 1710 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType()); 1711 1712 const Value *NumCallArgsV = CS.getArgument(3); 1713 Assert(isa<ConstantInt>(NumCallArgsV), 1714 "gc.statepoint number of arguments to underlying call " 1715 "must be constant integer", 1716 &CI); 1717 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue(); 1718 Assert(NumCallArgs >= 0, 1719 "gc.statepoint number of arguments to underlying call " 1720 "must be positive", 1721 &CI); 1722 const int NumParams = (int)TargetFuncType->getNumParams(); 1723 if (TargetFuncType->isVarArg()) { 1724 Assert(NumCallArgs >= NumParams, 1725 "gc.statepoint mismatch in number of vararg call args", &CI); 1726 1727 // TODO: Remove this limitation 1728 Assert(TargetFuncType->getReturnType()->isVoidTy(), 1729 "gc.statepoint doesn't support wrapping non-void " 1730 "vararg functions yet", 1731 &CI); 1732 } else 1733 Assert(NumCallArgs == NumParams, 1734 "gc.statepoint mismatch in number of call args", &CI); 1735 1736 const Value *FlagsV = CS.getArgument(4); 1737 Assert(isa<ConstantInt>(FlagsV), 1738 "gc.statepoint flags must be constant integer", &CI); 1739 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue(); 1740 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0, 1741 "unknown flag used in gc.statepoint flags argument", &CI); 1742 1743 // Verify that the types of the call parameter arguments match 1744 // the type of the wrapped callee. 1745 for (int i = 0; i < NumParams; i++) { 1746 Type *ParamType = TargetFuncType->getParamType(i); 1747 Type *ArgType = CS.getArgument(5 + i)->getType(); 1748 Assert(ArgType == ParamType, 1749 "gc.statepoint call argument does not match wrapped " 1750 "function type", 1751 &CI); 1752 } 1753 1754 const int EndCallArgsInx = 4 + NumCallArgs; 1755 1756 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1); 1757 Assert(isa<ConstantInt>(NumTransitionArgsV), 1758 "gc.statepoint number of transition arguments " 1759 "must be constant integer", 1760 &CI); 1761 const int NumTransitionArgs = 1762 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue(); 1763 Assert(NumTransitionArgs >= 0, 1764 "gc.statepoint number of transition arguments must be positive", &CI); 1765 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs; 1766 1767 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1); 1768 Assert(isa<ConstantInt>(NumDeoptArgsV), 1769 "gc.statepoint number of deoptimization arguments " 1770 "must be constant integer", 1771 &CI); 1772 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue(); 1773 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments " 1774 "must be positive", 1775 &CI); 1776 1777 const int ExpectedNumArgs = 1778 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs; 1779 Assert(ExpectedNumArgs <= (int)CS.arg_size(), 1780 "gc.statepoint too few arguments according to length fields", &CI); 1781 1782 // Check that the only uses of this gc.statepoint are gc.result or 1783 // gc.relocate calls which are tied to this statepoint and thus part 1784 // of the same statepoint sequence 1785 for (const User *U : CI.users()) { 1786 const CallInst *Call = dyn_cast<const CallInst>(U); 1787 Assert(Call, "illegal use of statepoint token", &CI, U); 1788 if (!Call) continue; 1789 Assert(isa<GCRelocateInst>(Call) || isa<GCResultInst>(Call), 1790 "gc.result or gc.relocate are the only value uses" 1791 "of a gc.statepoint", 1792 &CI, U); 1793 if (isa<GCResultInst>(Call)) { 1794 Assert(Call->getArgOperand(0) == &CI, 1795 "gc.result connected to wrong gc.statepoint", &CI, Call); 1796 } else if (isa<GCRelocateInst>(Call)) { 1797 Assert(Call->getArgOperand(0) == &CI, 1798 "gc.relocate connected to wrong gc.statepoint", &CI, Call); 1799 } 1800 } 1801 1802 // Note: It is legal for a single derived pointer to be listed multiple 1803 // times. It's non-optimal, but it is legal. It can also happen after 1804 // insertion if we strip a bitcast away. 1805 // Note: It is really tempting to check that each base is relocated and 1806 // that a derived pointer is never reused as a base pointer. This turns 1807 // out to be problematic since optimizations run after safepoint insertion 1808 // can recognize equality properties that the insertion logic doesn't know 1809 // about. See example statepoint.ll in the verifier subdirectory 1810 } 1811 1812 void Verifier::verifyFrameRecoverIndices() { 1813 for (auto &Counts : FrameEscapeInfo) { 1814 Function *F = Counts.first; 1815 unsigned EscapedObjectCount = Counts.second.first; 1816 unsigned MaxRecoveredIndex = Counts.second.second; 1817 Assert(MaxRecoveredIndex <= EscapedObjectCount, 1818 "all indices passed to llvm.localrecover must be less than the " 1819 "number of arguments passed ot llvm.localescape in the parent " 1820 "function", 1821 F); 1822 } 1823 } 1824 1825 static Instruction *getSuccPad(TerminatorInst *Terminator) { 1826 BasicBlock *UnwindDest; 1827 if (auto *II = dyn_cast<InvokeInst>(Terminator)) 1828 UnwindDest = II->getUnwindDest(); 1829 else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator)) 1830 UnwindDest = CSI->getUnwindDest(); 1831 else 1832 UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest(); 1833 return UnwindDest->getFirstNonPHI(); 1834 } 1835 1836 void Verifier::verifySiblingFuncletUnwinds() { 1837 SmallPtrSet<Instruction *, 8> Visited; 1838 SmallPtrSet<Instruction *, 8> Active; 1839 for (const auto &Pair : SiblingFuncletInfo) { 1840 Instruction *PredPad = Pair.first; 1841 if (Visited.count(PredPad)) 1842 continue; 1843 Active.insert(PredPad); 1844 TerminatorInst *Terminator = Pair.second; 1845 do { 1846 Instruction *SuccPad = getSuccPad(Terminator); 1847 if (Active.count(SuccPad)) { 1848 // Found a cycle; report error 1849 Instruction *CyclePad = SuccPad; 1850 SmallVector<Instruction *, 8> CycleNodes; 1851 do { 1852 CycleNodes.push_back(CyclePad); 1853 TerminatorInst *CycleTerminator = SiblingFuncletInfo[CyclePad]; 1854 if (CycleTerminator != CyclePad) 1855 CycleNodes.push_back(CycleTerminator); 1856 CyclePad = getSuccPad(CycleTerminator); 1857 } while (CyclePad != SuccPad); 1858 Assert(false, "EH pads can't handle each other's exceptions", 1859 ArrayRef<Instruction *>(CycleNodes)); 1860 } 1861 // Don't re-walk a node we've already checked 1862 if (!Visited.insert(SuccPad).second) 1863 break; 1864 // Walk to this successor if it has a map entry. 1865 PredPad = SuccPad; 1866 auto TermI = SiblingFuncletInfo.find(PredPad); 1867 if (TermI == SiblingFuncletInfo.end()) 1868 break; 1869 Terminator = TermI->second; 1870 Active.insert(PredPad); 1871 } while (true); 1872 // Each node only has one successor, so we've walked all the active 1873 // nodes' successors. 1874 Active.clear(); 1875 } 1876 } 1877 1878 // visitFunction - Verify that a function is ok. 1879 // 1880 void Verifier::visitFunction(const Function &F) { 1881 visitGlobalValue(F); 1882 1883 // Check function arguments. 1884 FunctionType *FT = F.getFunctionType(); 1885 unsigned NumArgs = F.arg_size(); 1886 1887 Assert(&Context == &F.getContext(), 1888 "Function context does not match Module context!", &F); 1889 1890 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F); 1891 Assert(FT->getNumParams() == NumArgs, 1892 "# formal arguments must match # of arguments for function type!", &F, 1893 FT); 1894 Assert(F.getReturnType()->isFirstClassType() || 1895 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(), 1896 "Functions cannot return aggregate values!", &F); 1897 1898 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(), 1899 "Invalid struct return type!", &F); 1900 1901 AttributeSet Attrs = F.getAttributes(); 1902 1903 Assert(verifyAttributeCount(Attrs, FT->getNumParams()), 1904 "Attribute after last parameter!", &F); 1905 1906 // Check function attributes. 1907 verifyFunctionAttrs(FT, Attrs, &F); 1908 1909 // On function declarations/definitions, we do not support the builtin 1910 // attribute. We do not check this in VerifyFunctionAttrs since that is 1911 // checking for Attributes that can/can not ever be on functions. 1912 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin), 1913 "Attribute 'builtin' can only be applied to a callsite.", &F); 1914 1915 // Check that this function meets the restrictions on this calling convention. 1916 // Sometimes varargs is used for perfectly forwarding thunks, so some of these 1917 // restrictions can be lifted. 1918 switch (F.getCallingConv()) { 1919 default: 1920 case CallingConv::C: 1921 break; 1922 case CallingConv::Fast: 1923 case CallingConv::Cold: 1924 case CallingConv::Intel_OCL_BI: 1925 case CallingConv::PTX_Kernel: 1926 case CallingConv::PTX_Device: 1927 Assert(!F.isVarArg(), "Calling convention does not support varargs or " 1928 "perfect forwarding!", 1929 &F); 1930 break; 1931 } 1932 1933 bool isLLVMdotName = F.getName().size() >= 5 && 1934 F.getName().substr(0, 5) == "llvm."; 1935 1936 // Check that the argument values match the function type for this function... 1937 unsigned i = 0; 1938 for (const Argument &Arg : F.args()) { 1939 Assert(Arg.getType() == FT->getParamType(i), 1940 "Argument value does not match function argument type!", &Arg, 1941 FT->getParamType(i)); 1942 Assert(Arg.getType()->isFirstClassType(), 1943 "Function arguments must have first-class types!", &Arg); 1944 if (!isLLVMdotName) { 1945 Assert(!Arg.getType()->isMetadataTy(), 1946 "Function takes metadata but isn't an intrinsic", &Arg, &F); 1947 Assert(!Arg.getType()->isTokenTy(), 1948 "Function takes token but isn't an intrinsic", &Arg, &F); 1949 } 1950 1951 // Check that swifterror argument is only used by loads and stores. 1952 if (Attrs.hasAttribute(i+1, Attribute::SwiftError)) { 1953 verifySwiftErrorValue(&Arg); 1954 } 1955 ++i; 1956 } 1957 1958 if (!isLLVMdotName) 1959 Assert(!F.getReturnType()->isTokenTy(), 1960 "Functions returns a token but isn't an intrinsic", &F); 1961 1962 // Get the function metadata attachments. 1963 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs; 1964 F.getAllMetadata(MDs); 1965 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync"); 1966 verifyFunctionMetadata(MDs); 1967 1968 // Check validity of the personality function 1969 if (F.hasPersonalityFn()) { 1970 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts()); 1971 if (Per) 1972 Assert(Per->getParent() == F.getParent(), 1973 "Referencing personality function in another module!", 1974 &F, F.getParent(), Per, Per->getParent()); 1975 } 1976 1977 if (F.isMaterializable()) { 1978 // Function has a body somewhere we can't see. 1979 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F, 1980 MDs.empty() ? nullptr : MDs.front().second); 1981 } else if (F.isDeclaration()) { 1982 for (const auto &I : MDs) { 1983 AssertDI(I.first != LLVMContext::MD_dbg, 1984 "function declaration may not have a !dbg attachment", &F); 1985 Assert(I.first != LLVMContext::MD_prof, 1986 "function declaration may not have a !prof attachment", &F); 1987 1988 // Verify the metadata itself. 1989 visitMDNode(*I.second); 1990 } 1991 Assert(!F.hasPersonalityFn(), 1992 "Function declaration shouldn't have a personality routine", &F); 1993 } else { 1994 // Verify that this function (which has a body) is not named "llvm.*". It 1995 // is not legal to define intrinsics. 1996 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F); 1997 1998 // Check the entry node 1999 const BasicBlock *Entry = &F.getEntryBlock(); 2000 Assert(pred_empty(Entry), 2001 "Entry block to function must not have predecessors!", Entry); 2002 2003 // The address of the entry block cannot be taken, unless it is dead. 2004 if (Entry->hasAddressTaken()) { 2005 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(), 2006 "blockaddress may not be used with the entry block!", Entry); 2007 } 2008 2009 unsigned NumDebugAttachments = 0, NumProfAttachments = 0; 2010 // Visit metadata attachments. 2011 for (const auto &I : MDs) { 2012 // Verify that the attachment is legal. 2013 switch (I.first) { 2014 default: 2015 break; 2016 case LLVMContext::MD_dbg: 2017 ++NumDebugAttachments; 2018 AssertDI(NumDebugAttachments == 1, 2019 "function must have a single !dbg attachment", &F, I.second); 2020 AssertDI(isa<DISubprogram>(I.second), 2021 "function !dbg attachment must be a subprogram", &F, I.second); 2022 break; 2023 case LLVMContext::MD_prof: 2024 ++NumProfAttachments; 2025 Assert(NumProfAttachments == 1, 2026 "function must have a single !prof attachment", &F, I.second); 2027 break; 2028 } 2029 2030 // Verify the metadata itself. 2031 visitMDNode(*I.second); 2032 } 2033 } 2034 2035 // If this function is actually an intrinsic, verify that it is only used in 2036 // direct call/invokes, never having its "address taken". 2037 // Only do this if the module is materialized, otherwise we don't have all the 2038 // uses. 2039 if (F.getIntrinsicID() && F.getParent()->isMaterialized()) { 2040 const User *U; 2041 if (F.hasAddressTaken(&U)) 2042 Assert(0, "Invalid user of intrinsic instruction!", U); 2043 } 2044 2045 Assert(!F.hasDLLImportStorageClass() || 2046 (F.isDeclaration() && F.hasExternalLinkage()) || 2047 F.hasAvailableExternallyLinkage(), 2048 "Function is marked as dllimport, but not external.", &F); 2049 2050 auto *N = F.getSubprogram(); 2051 if (!N) 2052 return; 2053 2054 visitDISubprogram(*N); 2055 2056 // Check that all !dbg attachments lead to back to N (or, at least, another 2057 // subprogram that describes the same function). 2058 // 2059 // FIXME: Check this incrementally while visiting !dbg attachments. 2060 // FIXME: Only check when N is the canonical subprogram for F. 2061 SmallPtrSet<const MDNode *, 32> Seen; 2062 for (auto &BB : F) 2063 for (auto &I : BB) { 2064 // Be careful about using DILocation here since we might be dealing with 2065 // broken code (this is the Verifier after all). 2066 DILocation *DL = 2067 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode()); 2068 if (!DL) 2069 continue; 2070 if (!Seen.insert(DL).second) 2071 continue; 2072 2073 DILocalScope *Scope = DL->getInlinedAtScope(); 2074 if (Scope && !Seen.insert(Scope).second) 2075 continue; 2076 2077 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr; 2078 2079 // Scope and SP could be the same MDNode and we don't want to skip 2080 // validation in that case 2081 if (SP && ((Scope != SP) && !Seen.insert(SP).second)) 2082 continue; 2083 2084 // FIXME: Once N is canonical, check "SP == &N". 2085 Assert(SP->describes(&F), 2086 "!dbg attachment points at wrong subprogram for function", N, &F, 2087 &I, DL, Scope, SP); 2088 } 2089 } 2090 2091 // verifyBasicBlock - Verify that a basic block is well formed... 2092 // 2093 void Verifier::visitBasicBlock(BasicBlock &BB) { 2094 InstsInThisBlock.clear(); 2095 2096 // Ensure that basic blocks have terminators! 2097 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB); 2098 2099 // Check constraints that this basic block imposes on all of the PHI nodes in 2100 // it. 2101 if (isa<PHINode>(BB.front())) { 2102 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB)); 2103 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values; 2104 std::sort(Preds.begin(), Preds.end()); 2105 PHINode *PN; 2106 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) { 2107 // Ensure that PHI nodes have at least one entry! 2108 Assert(PN->getNumIncomingValues() != 0, 2109 "PHI nodes must have at least one entry. If the block is dead, " 2110 "the PHI should be removed!", 2111 PN); 2112 Assert(PN->getNumIncomingValues() == Preds.size(), 2113 "PHINode should have one entry for each predecessor of its " 2114 "parent basic block!", 2115 PN); 2116 2117 // Get and sort all incoming values in the PHI node... 2118 Values.clear(); 2119 Values.reserve(PN->getNumIncomingValues()); 2120 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) 2121 Values.push_back(std::make_pair(PN->getIncomingBlock(i), 2122 PN->getIncomingValue(i))); 2123 std::sort(Values.begin(), Values.end()); 2124 2125 for (unsigned i = 0, e = Values.size(); i != e; ++i) { 2126 // Check to make sure that if there is more than one entry for a 2127 // particular basic block in this PHI node, that the incoming values are 2128 // all identical. 2129 // 2130 Assert(i == 0 || Values[i].first != Values[i - 1].first || 2131 Values[i].second == Values[i - 1].second, 2132 "PHI node has multiple entries for the same basic block with " 2133 "different incoming values!", 2134 PN, Values[i].first, Values[i].second, Values[i - 1].second); 2135 2136 // Check to make sure that the predecessors and PHI node entries are 2137 // matched up. 2138 Assert(Values[i].first == Preds[i], 2139 "PHI node entries do not match predecessors!", PN, 2140 Values[i].first, Preds[i]); 2141 } 2142 } 2143 } 2144 2145 // Check that all instructions have their parent pointers set up correctly. 2146 for (auto &I : BB) 2147 { 2148 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!"); 2149 } 2150 } 2151 2152 void Verifier::visitTerminatorInst(TerminatorInst &I) { 2153 // Ensure that terminators only exist at the end of the basic block. 2154 Assert(&I == I.getParent()->getTerminator(), 2155 "Terminator found in the middle of a basic block!", I.getParent()); 2156 visitInstruction(I); 2157 } 2158 2159 void Verifier::visitBranchInst(BranchInst &BI) { 2160 if (BI.isConditional()) { 2161 Assert(BI.getCondition()->getType()->isIntegerTy(1), 2162 "Branch condition is not 'i1' type!", &BI, BI.getCondition()); 2163 } 2164 visitTerminatorInst(BI); 2165 } 2166 2167 void Verifier::visitReturnInst(ReturnInst &RI) { 2168 Function *F = RI.getParent()->getParent(); 2169 unsigned N = RI.getNumOperands(); 2170 if (F->getReturnType()->isVoidTy()) 2171 Assert(N == 0, 2172 "Found return instr that returns non-void in Function of void " 2173 "return type!", 2174 &RI, F->getReturnType()); 2175 else 2176 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(), 2177 "Function return type does not match operand " 2178 "type of return inst!", 2179 &RI, F->getReturnType()); 2180 2181 // Check to make sure that the return value has necessary properties for 2182 // terminators... 2183 visitTerminatorInst(RI); 2184 } 2185 2186 void Verifier::visitSwitchInst(SwitchInst &SI) { 2187 // Check to make sure that all of the constants in the switch instruction 2188 // have the same type as the switched-on value. 2189 Type *SwitchTy = SI.getCondition()->getType(); 2190 SmallPtrSet<ConstantInt*, 32> Constants; 2191 for (auto &Case : SI.cases()) { 2192 Assert(Case.getCaseValue()->getType() == SwitchTy, 2193 "Switch constants must all be same type as switch value!", &SI); 2194 Assert(Constants.insert(Case.getCaseValue()).second, 2195 "Duplicate integer as switch case", &SI, Case.getCaseValue()); 2196 } 2197 2198 visitTerminatorInst(SI); 2199 } 2200 2201 void Verifier::visitIndirectBrInst(IndirectBrInst &BI) { 2202 Assert(BI.getAddress()->getType()->isPointerTy(), 2203 "Indirectbr operand must have pointer type!", &BI); 2204 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i) 2205 Assert(BI.getDestination(i)->getType()->isLabelTy(), 2206 "Indirectbr destinations must all have pointer type!", &BI); 2207 2208 visitTerminatorInst(BI); 2209 } 2210 2211 void Verifier::visitSelectInst(SelectInst &SI) { 2212 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1), 2213 SI.getOperand(2)), 2214 "Invalid operands for select instruction!", &SI); 2215 2216 Assert(SI.getTrueValue()->getType() == SI.getType(), 2217 "Select values must have same type as select instruction!", &SI); 2218 visitInstruction(SI); 2219 } 2220 2221 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of 2222 /// a pass, if any exist, it's an error. 2223 /// 2224 void Verifier::visitUserOp1(Instruction &I) { 2225 Assert(0, "User-defined operators should not live outside of a pass!", &I); 2226 } 2227 2228 void Verifier::visitTruncInst(TruncInst &I) { 2229 // Get the source and destination types 2230 Type *SrcTy = I.getOperand(0)->getType(); 2231 Type *DestTy = I.getType(); 2232 2233 // Get the size of the types in bits, we'll need this later 2234 unsigned SrcBitSize = SrcTy->getScalarSizeInBits(); 2235 unsigned DestBitSize = DestTy->getScalarSizeInBits(); 2236 2237 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I); 2238 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I); 2239 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), 2240 "trunc source and destination must both be a vector or neither", &I); 2241 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I); 2242 2243 visitInstruction(I); 2244 } 2245 2246 void Verifier::visitZExtInst(ZExtInst &I) { 2247 // Get the source and destination types 2248 Type *SrcTy = I.getOperand(0)->getType(); 2249 Type *DestTy = I.getType(); 2250 2251 // Get the size of the types in bits, we'll need this later 2252 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I); 2253 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I); 2254 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), 2255 "zext source and destination must both be a vector or neither", &I); 2256 unsigned SrcBitSize = SrcTy->getScalarSizeInBits(); 2257 unsigned DestBitSize = DestTy->getScalarSizeInBits(); 2258 2259 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I); 2260 2261 visitInstruction(I); 2262 } 2263 2264 void Verifier::visitSExtInst(SExtInst &I) { 2265 // Get the source and destination types 2266 Type *SrcTy = I.getOperand(0)->getType(); 2267 Type *DestTy = I.getType(); 2268 2269 // Get the size of the types in bits, we'll need this later 2270 unsigned SrcBitSize = SrcTy->getScalarSizeInBits(); 2271 unsigned DestBitSize = DestTy->getScalarSizeInBits(); 2272 2273 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I); 2274 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I); 2275 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), 2276 "sext source and destination must both be a vector or neither", &I); 2277 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I); 2278 2279 visitInstruction(I); 2280 } 2281 2282 void Verifier::visitFPTruncInst(FPTruncInst &I) { 2283 // Get the source and destination types 2284 Type *SrcTy = I.getOperand(0)->getType(); 2285 Type *DestTy = I.getType(); 2286 // Get the size of the types in bits, we'll need this later 2287 unsigned SrcBitSize = SrcTy->getScalarSizeInBits(); 2288 unsigned DestBitSize = DestTy->getScalarSizeInBits(); 2289 2290 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I); 2291 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I); 2292 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), 2293 "fptrunc source and destination must both be a vector or neither", &I); 2294 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I); 2295 2296 visitInstruction(I); 2297 } 2298 2299 void Verifier::visitFPExtInst(FPExtInst &I) { 2300 // Get the source and destination types 2301 Type *SrcTy = I.getOperand(0)->getType(); 2302 Type *DestTy = I.getType(); 2303 2304 // Get the size of the types in bits, we'll need this later 2305 unsigned SrcBitSize = SrcTy->getScalarSizeInBits(); 2306 unsigned DestBitSize = DestTy->getScalarSizeInBits(); 2307 2308 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I); 2309 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I); 2310 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), 2311 "fpext source and destination must both be a vector or neither", &I); 2312 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I); 2313 2314 visitInstruction(I); 2315 } 2316 2317 void Verifier::visitUIToFPInst(UIToFPInst &I) { 2318 // Get the source and destination types 2319 Type *SrcTy = I.getOperand(0)->getType(); 2320 Type *DestTy = I.getType(); 2321 2322 bool SrcVec = SrcTy->isVectorTy(); 2323 bool DstVec = DestTy->isVectorTy(); 2324 2325 Assert(SrcVec == DstVec, 2326 "UIToFP source and dest must both be vector or scalar", &I); 2327 Assert(SrcTy->isIntOrIntVectorTy(), 2328 "UIToFP source must be integer or integer vector", &I); 2329 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector", 2330 &I); 2331 2332 if (SrcVec && DstVec) 2333 Assert(cast<VectorType>(SrcTy)->getNumElements() == 2334 cast<VectorType>(DestTy)->getNumElements(), 2335 "UIToFP source and dest vector length mismatch", &I); 2336 2337 visitInstruction(I); 2338 } 2339 2340 void Verifier::visitSIToFPInst(SIToFPInst &I) { 2341 // Get the source and destination types 2342 Type *SrcTy = I.getOperand(0)->getType(); 2343 Type *DestTy = I.getType(); 2344 2345 bool SrcVec = SrcTy->isVectorTy(); 2346 bool DstVec = DestTy->isVectorTy(); 2347 2348 Assert(SrcVec == DstVec, 2349 "SIToFP source and dest must both be vector or scalar", &I); 2350 Assert(SrcTy->isIntOrIntVectorTy(), 2351 "SIToFP source must be integer or integer vector", &I); 2352 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector", 2353 &I); 2354 2355 if (SrcVec && DstVec) 2356 Assert(cast<VectorType>(SrcTy)->getNumElements() == 2357 cast<VectorType>(DestTy)->getNumElements(), 2358 "SIToFP source and dest vector length mismatch", &I); 2359 2360 visitInstruction(I); 2361 } 2362 2363 void Verifier::visitFPToUIInst(FPToUIInst &I) { 2364 // Get the source and destination types 2365 Type *SrcTy = I.getOperand(0)->getType(); 2366 Type *DestTy = I.getType(); 2367 2368 bool SrcVec = SrcTy->isVectorTy(); 2369 bool DstVec = DestTy->isVectorTy(); 2370 2371 Assert(SrcVec == DstVec, 2372 "FPToUI source and dest must both be vector or scalar", &I); 2373 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector", 2374 &I); 2375 Assert(DestTy->isIntOrIntVectorTy(), 2376 "FPToUI result must be integer or integer vector", &I); 2377 2378 if (SrcVec && DstVec) 2379 Assert(cast<VectorType>(SrcTy)->getNumElements() == 2380 cast<VectorType>(DestTy)->getNumElements(), 2381 "FPToUI source and dest vector length mismatch", &I); 2382 2383 visitInstruction(I); 2384 } 2385 2386 void Verifier::visitFPToSIInst(FPToSIInst &I) { 2387 // Get the source and destination types 2388 Type *SrcTy = I.getOperand(0)->getType(); 2389 Type *DestTy = I.getType(); 2390 2391 bool SrcVec = SrcTy->isVectorTy(); 2392 bool DstVec = DestTy->isVectorTy(); 2393 2394 Assert(SrcVec == DstVec, 2395 "FPToSI source and dest must both be vector or scalar", &I); 2396 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector", 2397 &I); 2398 Assert(DestTy->isIntOrIntVectorTy(), 2399 "FPToSI result must be integer or integer vector", &I); 2400 2401 if (SrcVec && DstVec) 2402 Assert(cast<VectorType>(SrcTy)->getNumElements() == 2403 cast<VectorType>(DestTy)->getNumElements(), 2404 "FPToSI source and dest vector length mismatch", &I); 2405 2406 visitInstruction(I); 2407 } 2408 2409 void Verifier::visitPtrToIntInst(PtrToIntInst &I) { 2410 // Get the source and destination types 2411 Type *SrcTy = I.getOperand(0)->getType(); 2412 Type *DestTy = I.getType(); 2413 2414 Assert(SrcTy->getScalarType()->isPointerTy(), 2415 "PtrToInt source must be pointer", &I); 2416 2417 if (auto *PTy = dyn_cast<PointerType>(SrcTy->getScalarType())) 2418 Assert(!DL.isNonIntegralPointerType(PTy), 2419 "ptrtoint not supported for non-integral pointers"); 2420 2421 Assert(DestTy->getScalarType()->isIntegerTy(), 2422 "PtrToInt result must be integral", &I); 2423 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch", 2424 &I); 2425 2426 if (SrcTy->isVectorTy()) { 2427 VectorType *VSrc = dyn_cast<VectorType>(SrcTy); 2428 VectorType *VDest = dyn_cast<VectorType>(DestTy); 2429 Assert(VSrc->getNumElements() == VDest->getNumElements(), 2430 "PtrToInt Vector width mismatch", &I); 2431 } 2432 2433 visitInstruction(I); 2434 } 2435 2436 void Verifier::visitIntToPtrInst(IntToPtrInst &I) { 2437 // Get the source and destination types 2438 Type *SrcTy = I.getOperand(0)->getType(); 2439 Type *DestTy = I.getType(); 2440 2441 Assert(SrcTy->getScalarType()->isIntegerTy(), 2442 "IntToPtr source must be an integral", &I); 2443 Assert(DestTy->getScalarType()->isPointerTy(), 2444 "IntToPtr result must be a pointer", &I); 2445 2446 if (auto *PTy = dyn_cast<PointerType>(DestTy->getScalarType())) 2447 Assert(!DL.isNonIntegralPointerType(PTy), 2448 "inttoptr not supported for non-integral pointers"); 2449 2450 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch", 2451 &I); 2452 if (SrcTy->isVectorTy()) { 2453 VectorType *VSrc = dyn_cast<VectorType>(SrcTy); 2454 VectorType *VDest = dyn_cast<VectorType>(DestTy); 2455 Assert(VSrc->getNumElements() == VDest->getNumElements(), 2456 "IntToPtr Vector width mismatch", &I); 2457 } 2458 visitInstruction(I); 2459 } 2460 2461 void Verifier::visitBitCastInst(BitCastInst &I) { 2462 Assert( 2463 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()), 2464 "Invalid bitcast", &I); 2465 visitInstruction(I); 2466 } 2467 2468 void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) { 2469 Type *SrcTy = I.getOperand(0)->getType(); 2470 Type *DestTy = I.getType(); 2471 2472 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer", 2473 &I); 2474 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer", 2475 &I); 2476 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(), 2477 "AddrSpaceCast must be between different address spaces", &I); 2478 if (SrcTy->isVectorTy()) 2479 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(), 2480 "AddrSpaceCast vector pointer number of elements mismatch", &I); 2481 visitInstruction(I); 2482 } 2483 2484 /// visitPHINode - Ensure that a PHI node is well formed. 2485 /// 2486 void Verifier::visitPHINode(PHINode &PN) { 2487 // Ensure that the PHI nodes are all grouped together at the top of the block. 2488 // This can be tested by checking whether the instruction before this is 2489 // either nonexistent (because this is begin()) or is a PHI node. If not, 2490 // then there is some other instruction before a PHI. 2491 Assert(&PN == &PN.getParent()->front() || 2492 isa<PHINode>(--BasicBlock::iterator(&PN)), 2493 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent()); 2494 2495 // Check that a PHI doesn't yield a Token. 2496 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!"); 2497 2498 // Check that all of the values of the PHI node have the same type as the 2499 // result, and that the incoming blocks are really basic blocks. 2500 for (Value *IncValue : PN.incoming_values()) { 2501 Assert(PN.getType() == IncValue->getType(), 2502 "PHI node operands are not the same type as the result!", &PN); 2503 } 2504 2505 // All other PHI node constraints are checked in the visitBasicBlock method. 2506 2507 visitInstruction(PN); 2508 } 2509 2510 void Verifier::verifyCallSite(CallSite CS) { 2511 Instruction *I = CS.getInstruction(); 2512 2513 Assert(CS.getCalledValue()->getType()->isPointerTy(), 2514 "Called function must be a pointer!", I); 2515 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType()); 2516 2517 Assert(FPTy->getElementType()->isFunctionTy(), 2518 "Called function is not pointer to function type!", I); 2519 2520 Assert(FPTy->getElementType() == CS.getFunctionType(), 2521 "Called function is not the same type as the call!", I); 2522 2523 FunctionType *FTy = CS.getFunctionType(); 2524 2525 // Verify that the correct number of arguments are being passed 2526 if (FTy->isVarArg()) 2527 Assert(CS.arg_size() >= FTy->getNumParams(), 2528 "Called function requires more parameters than were provided!", I); 2529 else 2530 Assert(CS.arg_size() == FTy->getNumParams(), 2531 "Incorrect number of arguments passed to called function!", I); 2532 2533 // Verify that all arguments to the call match the function type. 2534 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) 2535 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i), 2536 "Call parameter type does not match function signature!", 2537 CS.getArgument(i), FTy->getParamType(i), I); 2538 2539 AttributeSet Attrs = CS.getAttributes(); 2540 2541 Assert(verifyAttributeCount(Attrs, CS.arg_size()), 2542 "Attribute after last parameter!", I); 2543 2544 // Verify call attributes. 2545 verifyFunctionAttrs(FTy, Attrs, I); 2546 2547 // Conservatively check the inalloca argument. 2548 // We have a bug if we can find that there is an underlying alloca without 2549 // inalloca. 2550 if (CS.hasInAllocaArgument()) { 2551 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1); 2552 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets())) 2553 Assert(AI->isUsedWithInAlloca(), 2554 "inalloca argument for call has mismatched alloca", AI, I); 2555 } 2556 2557 // For each argument of the callsite, if it has the swifterror argument, 2558 // make sure the underlying alloca has swifterror as well. 2559 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) 2560 if (CS.paramHasAttr(i+1, Attribute::SwiftError)) { 2561 Value *SwiftErrorArg = CS.getArgument(i); 2562 auto AI = dyn_cast<AllocaInst>(SwiftErrorArg->stripInBoundsOffsets()); 2563 Assert(AI, "swifterror argument should come from alloca", AI, I); 2564 if (AI) 2565 Assert(AI->isSwiftError(), 2566 "swifterror argument for call has mismatched alloca", AI, I); 2567 } 2568 2569 if (FTy->isVarArg()) { 2570 // FIXME? is 'nest' even legal here? 2571 bool SawNest = false; 2572 bool SawReturned = false; 2573 2574 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) { 2575 if (Attrs.hasAttribute(Idx, Attribute::Nest)) 2576 SawNest = true; 2577 if (Attrs.hasAttribute(Idx, Attribute::Returned)) 2578 SawReturned = true; 2579 } 2580 2581 // Check attributes on the varargs part. 2582 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) { 2583 Type *Ty = CS.getArgument(Idx-1)->getType(); 2584 verifyParameterAttrs(Attrs, Idx, Ty, false, I); 2585 2586 if (Attrs.hasAttribute(Idx, Attribute::Nest)) { 2587 Assert(!SawNest, "More than one parameter has attribute nest!", I); 2588 SawNest = true; 2589 } 2590 2591 if (Attrs.hasAttribute(Idx, Attribute::Returned)) { 2592 Assert(!SawReturned, "More than one parameter has attribute returned!", 2593 I); 2594 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()), 2595 "Incompatible argument and return types for 'returned' " 2596 "attribute", 2597 I); 2598 SawReturned = true; 2599 } 2600 2601 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet), 2602 "Attribute 'sret' cannot be used for vararg call arguments!", I); 2603 2604 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) 2605 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I); 2606 } 2607 } 2608 2609 // Verify that there's no metadata unless it's a direct call to an intrinsic. 2610 if (CS.getCalledFunction() == nullptr || 2611 !CS.getCalledFunction()->getName().startswith("llvm.")) { 2612 for (Type *ParamTy : FTy->params()) { 2613 Assert(!ParamTy->isMetadataTy(), 2614 "Function has metadata parameter but isn't an intrinsic", I); 2615 Assert(!ParamTy->isTokenTy(), 2616 "Function has token parameter but isn't an intrinsic", I); 2617 } 2618 } 2619 2620 // Verify that indirect calls don't return tokens. 2621 if (CS.getCalledFunction() == nullptr) 2622 Assert(!FTy->getReturnType()->isTokenTy(), 2623 "Return type cannot be token for indirect call!"); 2624 2625 if (Function *F = CS.getCalledFunction()) 2626 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID()) 2627 visitIntrinsicCallSite(ID, CS); 2628 2629 // Verify that a callsite has at most one "deopt", at most one "funclet" and 2630 // at most one "gc-transition" operand bundle. 2631 bool FoundDeoptBundle = false, FoundFuncletBundle = false, 2632 FoundGCTransitionBundle = false; 2633 for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) { 2634 OperandBundleUse BU = CS.getOperandBundleAt(i); 2635 uint32_t Tag = BU.getTagID(); 2636 if (Tag == LLVMContext::OB_deopt) { 2637 Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I); 2638 FoundDeoptBundle = true; 2639 } else if (Tag == LLVMContext::OB_gc_transition) { 2640 Assert(!FoundGCTransitionBundle, "Multiple gc-transition operand bundles", 2641 I); 2642 FoundGCTransitionBundle = true; 2643 } else if (Tag == LLVMContext::OB_funclet) { 2644 Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", I); 2645 FoundFuncletBundle = true; 2646 Assert(BU.Inputs.size() == 1, 2647 "Expected exactly one funclet bundle operand", I); 2648 Assert(isa<FuncletPadInst>(BU.Inputs.front()), 2649 "Funclet bundle operands should correspond to a FuncletPadInst", 2650 I); 2651 } 2652 } 2653 2654 // Verify that each inlinable callsite of a debug-info-bearing function in a 2655 // debug-info-bearing function has a debug location attached to it. Failure to 2656 // do so causes assertion failures when the inliner sets up inline scope info. 2657 if (I->getFunction()->getSubprogram() && CS.getCalledFunction() && 2658 CS.getCalledFunction()->getSubprogram()) 2659 Assert(I->getDebugLoc(), "inlinable function call in a function with debug " 2660 "info must have a !dbg location", 2661 I); 2662 2663 visitInstruction(*I); 2664 } 2665 2666 /// Two types are "congruent" if they are identical, or if they are both pointer 2667 /// types with different pointee types and the same address space. 2668 static bool isTypeCongruent(Type *L, Type *R) { 2669 if (L == R) 2670 return true; 2671 PointerType *PL = dyn_cast<PointerType>(L); 2672 PointerType *PR = dyn_cast<PointerType>(R); 2673 if (!PL || !PR) 2674 return false; 2675 return PL->getAddressSpace() == PR->getAddressSpace(); 2676 } 2677 2678 static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) { 2679 static const Attribute::AttrKind ABIAttrs[] = { 2680 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca, 2681 Attribute::InReg, Attribute::Returned, Attribute::SwiftSelf, 2682 Attribute::SwiftError}; 2683 AttrBuilder Copy; 2684 for (auto AK : ABIAttrs) { 2685 if (Attrs.hasAttribute(I + 1, AK)) 2686 Copy.addAttribute(AK); 2687 } 2688 if (Attrs.hasAttribute(I + 1, Attribute::Alignment)) 2689 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1)); 2690 return Copy; 2691 } 2692 2693 void Verifier::verifyMustTailCall(CallInst &CI) { 2694 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI); 2695 2696 // - The caller and callee prototypes must match. Pointer types of 2697 // parameters or return types may differ in pointee type, but not 2698 // address space. 2699 Function *F = CI.getParent()->getParent(); 2700 FunctionType *CallerTy = F->getFunctionType(); 2701 FunctionType *CalleeTy = CI.getFunctionType(); 2702 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(), 2703 "cannot guarantee tail call due to mismatched parameter counts", &CI); 2704 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(), 2705 "cannot guarantee tail call due to mismatched varargs", &CI); 2706 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()), 2707 "cannot guarantee tail call due to mismatched return types", &CI); 2708 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) { 2709 Assert( 2710 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)), 2711 "cannot guarantee tail call due to mismatched parameter types", &CI); 2712 } 2713 2714 // - The calling conventions of the caller and callee must match. 2715 Assert(F->getCallingConv() == CI.getCallingConv(), 2716 "cannot guarantee tail call due to mismatched calling conv", &CI); 2717 2718 // - All ABI-impacting function attributes, such as sret, byval, inreg, 2719 // returned, and inalloca, must match. 2720 AttributeSet CallerAttrs = F->getAttributes(); 2721 AttributeSet CalleeAttrs = CI.getAttributes(); 2722 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) { 2723 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs); 2724 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs); 2725 Assert(CallerABIAttrs == CalleeABIAttrs, 2726 "cannot guarantee tail call due to mismatched ABI impacting " 2727 "function attributes", 2728 &CI, CI.getOperand(I)); 2729 } 2730 2731 // - The call must immediately precede a :ref:`ret <i_ret>` instruction, 2732 // or a pointer bitcast followed by a ret instruction. 2733 // - The ret instruction must return the (possibly bitcasted) value 2734 // produced by the call or void. 2735 Value *RetVal = &CI; 2736 Instruction *Next = CI.getNextNode(); 2737 2738 // Handle the optional bitcast. 2739 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) { 2740 Assert(BI->getOperand(0) == RetVal, 2741 "bitcast following musttail call must use the call", BI); 2742 RetVal = BI; 2743 Next = BI->getNextNode(); 2744 } 2745 2746 // Check the return. 2747 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next); 2748 Assert(Ret, "musttail call must be precede a ret with an optional bitcast", 2749 &CI); 2750 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal, 2751 "musttail call result must be returned", Ret); 2752 } 2753 2754 void Verifier::visitCallInst(CallInst &CI) { 2755 verifyCallSite(&CI); 2756 2757 if (CI.isMustTailCall()) 2758 verifyMustTailCall(CI); 2759 } 2760 2761 void Verifier::visitInvokeInst(InvokeInst &II) { 2762 verifyCallSite(&II); 2763 2764 // Verify that the first non-PHI instruction of the unwind destination is an 2765 // exception handling instruction. 2766 Assert( 2767 II.getUnwindDest()->isEHPad(), 2768 "The unwind destination does not have an exception handling instruction!", 2769 &II); 2770 2771 visitTerminatorInst(II); 2772 } 2773 2774 /// visitBinaryOperator - Check that both arguments to the binary operator are 2775 /// of the same type! 2776 /// 2777 void Verifier::visitBinaryOperator(BinaryOperator &B) { 2778 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(), 2779 "Both operands to a binary operator are not of the same type!", &B); 2780 2781 switch (B.getOpcode()) { 2782 // Check that integer arithmetic operators are only used with 2783 // integral operands. 2784 case Instruction::Add: 2785 case Instruction::Sub: 2786 case Instruction::Mul: 2787 case Instruction::SDiv: 2788 case Instruction::UDiv: 2789 case Instruction::SRem: 2790 case Instruction::URem: 2791 Assert(B.getType()->isIntOrIntVectorTy(), 2792 "Integer arithmetic operators only work with integral types!", &B); 2793 Assert(B.getType() == B.getOperand(0)->getType(), 2794 "Integer arithmetic operators must have same type " 2795 "for operands and result!", 2796 &B); 2797 break; 2798 // Check that floating-point arithmetic operators are only used with 2799 // floating-point operands. 2800 case Instruction::FAdd: 2801 case Instruction::FSub: 2802 case Instruction::FMul: 2803 case Instruction::FDiv: 2804 case Instruction::FRem: 2805 Assert(B.getType()->isFPOrFPVectorTy(), 2806 "Floating-point arithmetic operators only work with " 2807 "floating-point types!", 2808 &B); 2809 Assert(B.getType() == B.getOperand(0)->getType(), 2810 "Floating-point arithmetic operators must have same type " 2811 "for operands and result!", 2812 &B); 2813 break; 2814 // Check that logical operators are only used with integral operands. 2815 case Instruction::And: 2816 case Instruction::Or: 2817 case Instruction::Xor: 2818 Assert(B.getType()->isIntOrIntVectorTy(), 2819 "Logical operators only work with integral types!", &B); 2820 Assert(B.getType() == B.getOperand(0)->getType(), 2821 "Logical operators must have same type for operands and result!", 2822 &B); 2823 break; 2824 case Instruction::Shl: 2825 case Instruction::LShr: 2826 case Instruction::AShr: 2827 Assert(B.getType()->isIntOrIntVectorTy(), 2828 "Shifts only work with integral types!", &B); 2829 Assert(B.getType() == B.getOperand(0)->getType(), 2830 "Shift return type must be same as operands!", &B); 2831 break; 2832 default: 2833 llvm_unreachable("Unknown BinaryOperator opcode!"); 2834 } 2835 2836 visitInstruction(B); 2837 } 2838 2839 void Verifier::visitICmpInst(ICmpInst &IC) { 2840 // Check that the operands are the same type 2841 Type *Op0Ty = IC.getOperand(0)->getType(); 2842 Type *Op1Ty = IC.getOperand(1)->getType(); 2843 Assert(Op0Ty == Op1Ty, 2844 "Both operands to ICmp instruction are not of the same type!", &IC); 2845 // Check that the operands are the right type 2846 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(), 2847 "Invalid operand types for ICmp instruction", &IC); 2848 // Check that the predicate is valid. 2849 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE && 2850 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE, 2851 "Invalid predicate in ICmp instruction!", &IC); 2852 2853 visitInstruction(IC); 2854 } 2855 2856 void Verifier::visitFCmpInst(FCmpInst &FC) { 2857 // Check that the operands are the same type 2858 Type *Op0Ty = FC.getOperand(0)->getType(); 2859 Type *Op1Ty = FC.getOperand(1)->getType(); 2860 Assert(Op0Ty == Op1Ty, 2861 "Both operands to FCmp instruction are not of the same type!", &FC); 2862 // Check that the operands are the right type 2863 Assert(Op0Ty->isFPOrFPVectorTy(), 2864 "Invalid operand types for FCmp instruction", &FC); 2865 // Check that the predicate is valid. 2866 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE && 2867 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE, 2868 "Invalid predicate in FCmp instruction!", &FC); 2869 2870 visitInstruction(FC); 2871 } 2872 2873 void Verifier::visitExtractElementInst(ExtractElementInst &EI) { 2874 Assert( 2875 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)), 2876 "Invalid extractelement operands!", &EI); 2877 visitInstruction(EI); 2878 } 2879 2880 void Verifier::visitInsertElementInst(InsertElementInst &IE) { 2881 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1), 2882 IE.getOperand(2)), 2883 "Invalid insertelement operands!", &IE); 2884 visitInstruction(IE); 2885 } 2886 2887 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) { 2888 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1), 2889 SV.getOperand(2)), 2890 "Invalid shufflevector operands!", &SV); 2891 visitInstruction(SV); 2892 } 2893 2894 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) { 2895 Type *TargetTy = GEP.getPointerOperandType()->getScalarType(); 2896 2897 Assert(isa<PointerType>(TargetTy), 2898 "GEP base pointer is not a vector or a vector of pointers", &GEP); 2899 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP); 2900 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end()); 2901 Type *ElTy = 2902 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs); 2903 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP); 2904 2905 Assert(GEP.getType()->getScalarType()->isPointerTy() && 2906 GEP.getResultElementType() == ElTy, 2907 "GEP is not of right type for indices!", &GEP, ElTy); 2908 2909 if (GEP.getType()->isVectorTy()) { 2910 // Additional checks for vector GEPs. 2911 unsigned GEPWidth = GEP.getType()->getVectorNumElements(); 2912 if (GEP.getPointerOperandType()->isVectorTy()) 2913 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(), 2914 "Vector GEP result width doesn't match operand's", &GEP); 2915 for (Value *Idx : Idxs) { 2916 Type *IndexTy = Idx->getType(); 2917 if (IndexTy->isVectorTy()) { 2918 unsigned IndexWidth = IndexTy->getVectorNumElements(); 2919 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP); 2920 } 2921 Assert(IndexTy->getScalarType()->isIntegerTy(), 2922 "All GEP indices should be of integer type"); 2923 } 2924 } 2925 visitInstruction(GEP); 2926 } 2927 2928 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) { 2929 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper(); 2930 } 2931 2932 void Verifier::visitRangeMetadata(Instruction& I, 2933 MDNode* Range, Type* Ty) { 2934 assert(Range && 2935 Range == I.getMetadata(LLVMContext::MD_range) && 2936 "precondition violation"); 2937 2938 unsigned NumOperands = Range->getNumOperands(); 2939 Assert(NumOperands % 2 == 0, "Unfinished range!", Range); 2940 unsigned NumRanges = NumOperands / 2; 2941 Assert(NumRanges >= 1, "It should have at least one range!", Range); 2942 2943 ConstantRange LastRange(1); // Dummy initial value 2944 for (unsigned i = 0; i < NumRanges; ++i) { 2945 ConstantInt *Low = 2946 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i)); 2947 Assert(Low, "The lower limit must be an integer!", Low); 2948 ConstantInt *High = 2949 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1)); 2950 Assert(High, "The upper limit must be an integer!", High); 2951 Assert(High->getType() == Low->getType() && High->getType() == Ty, 2952 "Range types must match instruction type!", &I); 2953 2954 APInt HighV = High->getValue(); 2955 APInt LowV = Low->getValue(); 2956 ConstantRange CurRange(LowV, HighV); 2957 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(), 2958 "Range must not be empty!", Range); 2959 if (i != 0) { 2960 Assert(CurRange.intersectWith(LastRange).isEmptySet(), 2961 "Intervals are overlapping", Range); 2962 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order", 2963 Range); 2964 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous", 2965 Range); 2966 } 2967 LastRange = ConstantRange(LowV, HighV); 2968 } 2969 if (NumRanges > 2) { 2970 APInt FirstLow = 2971 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue(); 2972 APInt FirstHigh = 2973 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue(); 2974 ConstantRange FirstRange(FirstLow, FirstHigh); 2975 Assert(FirstRange.intersectWith(LastRange).isEmptySet(), 2976 "Intervals are overlapping", Range); 2977 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous", 2978 Range); 2979 } 2980 } 2981 2982 void Verifier::checkAtomicMemAccessSize(Type *Ty, const Instruction *I) { 2983 unsigned Size = DL.getTypeSizeInBits(Ty); 2984 Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I); 2985 Assert(!(Size & (Size - 1)), 2986 "atomic memory access' operand must have a power-of-two size", Ty, I); 2987 } 2988 2989 void Verifier::visitLoadInst(LoadInst &LI) { 2990 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType()); 2991 Assert(PTy, "Load operand must be a pointer.", &LI); 2992 Type *ElTy = LI.getType(); 2993 Assert(LI.getAlignment() <= Value::MaximumAlignment, 2994 "huge alignment values are unsupported", &LI); 2995 Assert(ElTy->isSized(), "loading unsized types is not allowed", &LI); 2996 if (LI.isAtomic()) { 2997 Assert(LI.getOrdering() != AtomicOrdering::Release && 2998 LI.getOrdering() != AtomicOrdering::AcquireRelease, 2999 "Load cannot have Release ordering", &LI); 3000 Assert(LI.getAlignment() != 0, 3001 "Atomic load must specify explicit alignment", &LI); 3002 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() || 3003 ElTy->isFloatingPointTy(), 3004 "atomic load operand must have integer, pointer, or floating point " 3005 "type!", 3006 ElTy, &LI); 3007 checkAtomicMemAccessSize(ElTy, &LI); 3008 } else { 3009 Assert(LI.getSynchScope() == CrossThread, 3010 "Non-atomic load cannot have SynchronizationScope specified", &LI); 3011 } 3012 3013 visitInstruction(LI); 3014 } 3015 3016 void Verifier::visitStoreInst(StoreInst &SI) { 3017 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType()); 3018 Assert(PTy, "Store operand must be a pointer.", &SI); 3019 Type *ElTy = PTy->getElementType(); 3020 Assert(ElTy == SI.getOperand(0)->getType(), 3021 "Stored value type does not match pointer operand type!", &SI, ElTy); 3022 Assert(SI.getAlignment() <= Value::MaximumAlignment, 3023 "huge alignment values are unsupported", &SI); 3024 Assert(ElTy->isSized(), "storing unsized types is not allowed", &SI); 3025 if (SI.isAtomic()) { 3026 Assert(SI.getOrdering() != AtomicOrdering::Acquire && 3027 SI.getOrdering() != AtomicOrdering::AcquireRelease, 3028 "Store cannot have Acquire ordering", &SI); 3029 Assert(SI.getAlignment() != 0, 3030 "Atomic store must specify explicit alignment", &SI); 3031 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() || 3032 ElTy->isFloatingPointTy(), 3033 "atomic store operand must have integer, pointer, or floating point " 3034 "type!", 3035 ElTy, &SI); 3036 checkAtomicMemAccessSize(ElTy, &SI); 3037 } else { 3038 Assert(SI.getSynchScope() == CrossThread, 3039 "Non-atomic store cannot have SynchronizationScope specified", &SI); 3040 } 3041 visitInstruction(SI); 3042 } 3043 3044 /// Check that SwiftErrorVal is used as a swifterror argument in CS. 3045 void Verifier::verifySwiftErrorCallSite(CallSite CS, 3046 const Value *SwiftErrorVal) { 3047 unsigned Idx = 0; 3048 for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end(); 3049 I != E; ++I, ++Idx) { 3050 if (*I == SwiftErrorVal) { 3051 Assert(CS.paramHasAttr(Idx+1, Attribute::SwiftError), 3052 "swifterror value when used in a callsite should be marked " 3053 "with swifterror attribute", 3054 SwiftErrorVal, CS); 3055 } 3056 } 3057 } 3058 3059 void Verifier::verifySwiftErrorValue(const Value *SwiftErrorVal) { 3060 // Check that swifterror value is only used by loads, stores, or as 3061 // a swifterror argument. 3062 for (const User *U : SwiftErrorVal->users()) { 3063 Assert(isa<LoadInst>(U) || isa<StoreInst>(U) || isa<CallInst>(U) || 3064 isa<InvokeInst>(U), 3065 "swifterror value can only be loaded and stored from, or " 3066 "as a swifterror argument!", 3067 SwiftErrorVal, U); 3068 // If it is used by a store, check it is the second operand. 3069 if (auto StoreI = dyn_cast<StoreInst>(U)) 3070 Assert(StoreI->getOperand(1) == SwiftErrorVal, 3071 "swifterror value should be the second operand when used " 3072 "by stores", SwiftErrorVal, U); 3073 if (auto CallI = dyn_cast<CallInst>(U)) 3074 verifySwiftErrorCallSite(const_cast<CallInst*>(CallI), SwiftErrorVal); 3075 if (auto II = dyn_cast<InvokeInst>(U)) 3076 verifySwiftErrorCallSite(const_cast<InvokeInst*>(II), SwiftErrorVal); 3077 } 3078 } 3079 3080 void Verifier::visitAllocaInst(AllocaInst &AI) { 3081 SmallPtrSet<Type*, 4> Visited; 3082 PointerType *PTy = AI.getType(); 3083 Assert(PTy->getAddressSpace() == 0, 3084 "Allocation instruction pointer not in the generic address space!", 3085 &AI); 3086 Assert(AI.getAllocatedType()->isSized(&Visited), 3087 "Cannot allocate unsized type", &AI); 3088 Assert(AI.getArraySize()->getType()->isIntegerTy(), 3089 "Alloca array size must have integer type", &AI); 3090 Assert(AI.getAlignment() <= Value::MaximumAlignment, 3091 "huge alignment values are unsupported", &AI); 3092 3093 if (AI.isSwiftError()) { 3094 verifySwiftErrorValue(&AI); 3095 } 3096 3097 visitInstruction(AI); 3098 } 3099 3100 void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) { 3101 3102 // FIXME: more conditions??? 3103 Assert(CXI.getSuccessOrdering() != AtomicOrdering::NotAtomic, 3104 "cmpxchg instructions must be atomic.", &CXI); 3105 Assert(CXI.getFailureOrdering() != AtomicOrdering::NotAtomic, 3106 "cmpxchg instructions must be atomic.", &CXI); 3107 Assert(CXI.getSuccessOrdering() != AtomicOrdering::Unordered, 3108 "cmpxchg instructions cannot be unordered.", &CXI); 3109 Assert(CXI.getFailureOrdering() != AtomicOrdering::Unordered, 3110 "cmpxchg instructions cannot be unordered.", &CXI); 3111 Assert(!isStrongerThan(CXI.getFailureOrdering(), CXI.getSuccessOrdering()), 3112 "cmpxchg instructions failure argument shall be no stronger than the " 3113 "success argument", 3114 &CXI); 3115 Assert(CXI.getFailureOrdering() != AtomicOrdering::Release && 3116 CXI.getFailureOrdering() != AtomicOrdering::AcquireRelease, 3117 "cmpxchg failure ordering cannot include release semantics", &CXI); 3118 3119 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType()); 3120 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI); 3121 Type *ElTy = PTy->getElementType(); 3122 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy(), 3123 "cmpxchg operand must have integer or pointer type", 3124 ElTy, &CXI); 3125 checkAtomicMemAccessSize(ElTy, &CXI); 3126 Assert(ElTy == CXI.getOperand(1)->getType(), 3127 "Expected value type does not match pointer operand type!", &CXI, 3128 ElTy); 3129 Assert(ElTy == CXI.getOperand(2)->getType(), 3130 "Stored value type does not match pointer operand type!", &CXI, ElTy); 3131 visitInstruction(CXI); 3132 } 3133 3134 void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) { 3135 Assert(RMWI.getOrdering() != AtomicOrdering::NotAtomic, 3136 "atomicrmw instructions must be atomic.", &RMWI); 3137 Assert(RMWI.getOrdering() != AtomicOrdering::Unordered, 3138 "atomicrmw instructions cannot be unordered.", &RMWI); 3139 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType()); 3140 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI); 3141 Type *ElTy = PTy->getElementType(); 3142 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!", 3143 &RMWI, ElTy); 3144 checkAtomicMemAccessSize(ElTy, &RMWI); 3145 Assert(ElTy == RMWI.getOperand(1)->getType(), 3146 "Argument value type does not match pointer operand type!", &RMWI, 3147 ElTy); 3148 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() && 3149 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP, 3150 "Invalid binary operation!", &RMWI); 3151 visitInstruction(RMWI); 3152 } 3153 3154 void Verifier::visitFenceInst(FenceInst &FI) { 3155 const AtomicOrdering Ordering = FI.getOrdering(); 3156 Assert(Ordering == AtomicOrdering::Acquire || 3157 Ordering == AtomicOrdering::Release || 3158 Ordering == AtomicOrdering::AcquireRelease || 3159 Ordering == AtomicOrdering::SequentiallyConsistent, 3160 "fence instructions may only have acquire, release, acq_rel, or " 3161 "seq_cst ordering.", 3162 &FI); 3163 visitInstruction(FI); 3164 } 3165 3166 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) { 3167 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(), 3168 EVI.getIndices()) == EVI.getType(), 3169 "Invalid ExtractValueInst operands!", &EVI); 3170 3171 visitInstruction(EVI); 3172 } 3173 3174 void Verifier::visitInsertValueInst(InsertValueInst &IVI) { 3175 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(), 3176 IVI.getIndices()) == 3177 IVI.getOperand(1)->getType(), 3178 "Invalid InsertValueInst operands!", &IVI); 3179 3180 visitInstruction(IVI); 3181 } 3182 3183 static Value *getParentPad(Value *EHPad) { 3184 if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad)) 3185 return FPI->getParentPad(); 3186 3187 return cast<CatchSwitchInst>(EHPad)->getParentPad(); 3188 } 3189 3190 void Verifier::visitEHPadPredecessors(Instruction &I) { 3191 assert(I.isEHPad()); 3192 3193 BasicBlock *BB = I.getParent(); 3194 Function *F = BB->getParent(); 3195 3196 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I); 3197 3198 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) { 3199 // The landingpad instruction defines its parent as a landing pad block. The 3200 // landing pad block may be branched to only by the unwind edge of an 3201 // invoke. 3202 for (BasicBlock *PredBB : predecessors(BB)) { 3203 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator()); 3204 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB, 3205 "Block containing LandingPadInst must be jumped to " 3206 "only by the unwind edge of an invoke.", 3207 LPI); 3208 } 3209 return; 3210 } 3211 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) { 3212 if (!pred_empty(BB)) 3213 Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(), 3214 "Block containg CatchPadInst must be jumped to " 3215 "only by its catchswitch.", 3216 CPI); 3217 Assert(BB != CPI->getCatchSwitch()->getUnwindDest(), 3218 "Catchswitch cannot unwind to one of its catchpads", 3219 CPI->getCatchSwitch(), CPI); 3220 return; 3221 } 3222 3223 // Verify that each pred has a legal terminator with a legal to/from EH 3224 // pad relationship. 3225 Instruction *ToPad = &I; 3226 Value *ToPadParent = getParentPad(ToPad); 3227 for (BasicBlock *PredBB : predecessors(BB)) { 3228 TerminatorInst *TI = PredBB->getTerminator(); 3229 Value *FromPad; 3230 if (auto *II = dyn_cast<InvokeInst>(TI)) { 3231 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB, 3232 "EH pad must be jumped to via an unwind edge", ToPad, II); 3233 if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet)) 3234 FromPad = Bundle->Inputs[0]; 3235 else 3236 FromPad = ConstantTokenNone::get(II->getContext()); 3237 } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) { 3238 FromPad = CRI->getOperand(0); 3239 Assert(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI); 3240 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) { 3241 FromPad = CSI; 3242 } else { 3243 Assert(false, "EH pad must be jumped to via an unwind edge", ToPad, TI); 3244 } 3245 3246 // The edge may exit from zero or more nested pads. 3247 SmallSet<Value *, 8> Seen; 3248 for (;; FromPad = getParentPad(FromPad)) { 3249 Assert(FromPad != ToPad, 3250 "EH pad cannot handle exceptions raised within it", FromPad, TI); 3251 if (FromPad == ToPadParent) { 3252 // This is a legal unwind edge. 3253 break; 3254 } 3255 Assert(!isa<ConstantTokenNone>(FromPad), 3256 "A single unwind edge may only enter one EH pad", TI); 3257 Assert(Seen.insert(FromPad).second, 3258 "EH pad jumps through a cycle of pads", FromPad); 3259 } 3260 } 3261 } 3262 3263 void Verifier::visitLandingPadInst(LandingPadInst &LPI) { 3264 // The landingpad instruction is ill-formed if it doesn't have any clauses and 3265 // isn't a cleanup. 3266 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(), 3267 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI); 3268 3269 visitEHPadPredecessors(LPI); 3270 3271 if (!LandingPadResultTy) 3272 LandingPadResultTy = LPI.getType(); 3273 else 3274 Assert(LandingPadResultTy == LPI.getType(), 3275 "The landingpad instruction should have a consistent result type " 3276 "inside a function.", 3277 &LPI); 3278 3279 Function *F = LPI.getParent()->getParent(); 3280 Assert(F->hasPersonalityFn(), 3281 "LandingPadInst needs to be in a function with a personality.", &LPI); 3282 3283 // The landingpad instruction must be the first non-PHI instruction in the 3284 // block. 3285 Assert(LPI.getParent()->getLandingPadInst() == &LPI, 3286 "LandingPadInst not the first non-PHI instruction in the block.", 3287 &LPI); 3288 3289 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) { 3290 Constant *Clause = LPI.getClause(i); 3291 if (LPI.isCatch(i)) { 3292 Assert(isa<PointerType>(Clause->getType()), 3293 "Catch operand does not have pointer type!", &LPI); 3294 } else { 3295 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI); 3296 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause), 3297 "Filter operand is not an array of constants!", &LPI); 3298 } 3299 } 3300 3301 visitInstruction(LPI); 3302 } 3303 3304 void Verifier::visitResumeInst(ResumeInst &RI) { 3305 Assert(RI.getFunction()->hasPersonalityFn(), 3306 "ResumeInst needs to be in a function with a personality.", &RI); 3307 3308 if (!LandingPadResultTy) 3309 LandingPadResultTy = RI.getValue()->getType(); 3310 else 3311 Assert(LandingPadResultTy == RI.getValue()->getType(), 3312 "The resume instruction should have a consistent result type " 3313 "inside a function.", 3314 &RI); 3315 3316 visitTerminatorInst(RI); 3317 } 3318 3319 void Verifier::visitCatchPadInst(CatchPadInst &CPI) { 3320 BasicBlock *BB = CPI.getParent(); 3321 3322 Function *F = BB->getParent(); 3323 Assert(F->hasPersonalityFn(), 3324 "CatchPadInst needs to be in a function with a personality.", &CPI); 3325 3326 Assert(isa<CatchSwitchInst>(CPI.getParentPad()), 3327 "CatchPadInst needs to be directly nested in a CatchSwitchInst.", 3328 CPI.getParentPad()); 3329 3330 // The catchpad instruction must be the first non-PHI instruction in the 3331 // block. 3332 Assert(BB->getFirstNonPHI() == &CPI, 3333 "CatchPadInst not the first non-PHI instruction in the block.", &CPI); 3334 3335 visitEHPadPredecessors(CPI); 3336 visitFuncletPadInst(CPI); 3337 } 3338 3339 void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) { 3340 Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)), 3341 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn, 3342 CatchReturn.getOperand(0)); 3343 3344 visitTerminatorInst(CatchReturn); 3345 } 3346 3347 void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) { 3348 BasicBlock *BB = CPI.getParent(); 3349 3350 Function *F = BB->getParent(); 3351 Assert(F->hasPersonalityFn(), 3352 "CleanupPadInst needs to be in a function with a personality.", &CPI); 3353 3354 // The cleanuppad instruction must be the first non-PHI instruction in the 3355 // block. 3356 Assert(BB->getFirstNonPHI() == &CPI, 3357 "CleanupPadInst not the first non-PHI instruction in the block.", 3358 &CPI); 3359 3360 auto *ParentPad = CPI.getParentPad(); 3361 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad), 3362 "CleanupPadInst has an invalid parent.", &CPI); 3363 3364 visitEHPadPredecessors(CPI); 3365 visitFuncletPadInst(CPI); 3366 } 3367 3368 void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) { 3369 User *FirstUser = nullptr; 3370 Value *FirstUnwindPad = nullptr; 3371 SmallVector<FuncletPadInst *, 8> Worklist({&FPI}); 3372 SmallSet<FuncletPadInst *, 8> Seen; 3373 3374 while (!Worklist.empty()) { 3375 FuncletPadInst *CurrentPad = Worklist.pop_back_val(); 3376 Assert(Seen.insert(CurrentPad).second, 3377 "FuncletPadInst must not be nested within itself", CurrentPad); 3378 Value *UnresolvedAncestorPad = nullptr; 3379 for (User *U : CurrentPad->users()) { 3380 BasicBlock *UnwindDest; 3381 if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) { 3382 UnwindDest = CRI->getUnwindDest(); 3383 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) { 3384 // We allow catchswitch unwind to caller to nest 3385 // within an outer pad that unwinds somewhere else, 3386 // because catchswitch doesn't have a nounwind variant. 3387 // See e.g. SimplifyCFGOpt::SimplifyUnreachable. 3388 if (CSI->unwindsToCaller()) 3389 continue; 3390 UnwindDest = CSI->getUnwindDest(); 3391 } else if (auto *II = dyn_cast<InvokeInst>(U)) { 3392 UnwindDest = II->getUnwindDest(); 3393 } else if (isa<CallInst>(U)) { 3394 // Calls which don't unwind may be found inside funclet 3395 // pads that unwind somewhere else. We don't *require* 3396 // such calls to be annotated nounwind. 3397 continue; 3398 } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) { 3399 // The unwind dest for a cleanup can only be found by 3400 // recursive search. Add it to the worklist, and we'll 3401 // search for its first use that determines where it unwinds. 3402 Worklist.push_back(CPI); 3403 continue; 3404 } else { 3405 Assert(isa<CatchReturnInst>(U), "Bogus funclet pad use", U); 3406 continue; 3407 } 3408 3409 Value *UnwindPad; 3410 bool ExitsFPI; 3411 if (UnwindDest) { 3412 UnwindPad = UnwindDest->getFirstNonPHI(); 3413 if (!cast<Instruction>(UnwindPad)->isEHPad()) 3414 continue; 3415 Value *UnwindParent = getParentPad(UnwindPad); 3416 // Ignore unwind edges that don't exit CurrentPad. 3417 if (UnwindParent == CurrentPad) 3418 continue; 3419 // Determine whether the original funclet pad is exited, 3420 // and if we are scanning nested pads determine how many 3421 // of them are exited so we can stop searching their 3422 // children. 3423 Value *ExitedPad = CurrentPad; 3424 ExitsFPI = false; 3425 do { 3426 if (ExitedPad == &FPI) { 3427 ExitsFPI = true; 3428 // Now we can resolve any ancestors of CurrentPad up to 3429 // FPI, but not including FPI since we need to make sure 3430 // to check all direct users of FPI for consistency. 3431 UnresolvedAncestorPad = &FPI; 3432 break; 3433 } 3434 Value *ExitedParent = getParentPad(ExitedPad); 3435 if (ExitedParent == UnwindParent) { 3436 // ExitedPad is the ancestor-most pad which this unwind 3437 // edge exits, so we can resolve up to it, meaning that 3438 // ExitedParent is the first ancestor still unresolved. 3439 UnresolvedAncestorPad = ExitedParent; 3440 break; 3441 } 3442 ExitedPad = ExitedParent; 3443 } while (!isa<ConstantTokenNone>(ExitedPad)); 3444 } else { 3445 // Unwinding to caller exits all pads. 3446 UnwindPad = ConstantTokenNone::get(FPI.getContext()); 3447 ExitsFPI = true; 3448 UnresolvedAncestorPad = &FPI; 3449 } 3450 3451 if (ExitsFPI) { 3452 // This unwind edge exits FPI. Make sure it agrees with other 3453 // such edges. 3454 if (FirstUser) { 3455 Assert(UnwindPad == FirstUnwindPad, "Unwind edges out of a funclet " 3456 "pad must have the same unwind " 3457 "dest", 3458 &FPI, U, FirstUser); 3459 } else { 3460 FirstUser = U; 3461 FirstUnwindPad = UnwindPad; 3462 // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds 3463 if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) && 3464 getParentPad(UnwindPad) == getParentPad(&FPI)) 3465 SiblingFuncletInfo[&FPI] = cast<TerminatorInst>(U); 3466 } 3467 } 3468 // Make sure we visit all uses of FPI, but for nested pads stop as 3469 // soon as we know where they unwind to. 3470 if (CurrentPad != &FPI) 3471 break; 3472 } 3473 if (UnresolvedAncestorPad) { 3474 if (CurrentPad == UnresolvedAncestorPad) { 3475 // When CurrentPad is FPI itself, we don't mark it as resolved even if 3476 // we've found an unwind edge that exits it, because we need to verify 3477 // all direct uses of FPI. 3478 assert(CurrentPad == &FPI); 3479 continue; 3480 } 3481 // Pop off the worklist any nested pads that we've found an unwind 3482 // destination for. The pads on the worklist are the uncles, 3483 // great-uncles, etc. of CurrentPad. We've found an unwind destination 3484 // for all ancestors of CurrentPad up to but not including 3485 // UnresolvedAncestorPad. 3486 Value *ResolvedPad = CurrentPad; 3487 while (!Worklist.empty()) { 3488 Value *UnclePad = Worklist.back(); 3489 Value *AncestorPad = getParentPad(UnclePad); 3490 // Walk ResolvedPad up the ancestor list until we either find the 3491 // uncle's parent or the last resolved ancestor. 3492 while (ResolvedPad != AncestorPad) { 3493 Value *ResolvedParent = getParentPad(ResolvedPad); 3494 if (ResolvedParent == UnresolvedAncestorPad) { 3495 break; 3496 } 3497 ResolvedPad = ResolvedParent; 3498 } 3499 // If the resolved ancestor search didn't find the uncle's parent, 3500 // then the uncle is not yet resolved. 3501 if (ResolvedPad != AncestorPad) 3502 break; 3503 // This uncle is resolved, so pop it from the worklist. 3504 Worklist.pop_back(); 3505 } 3506 } 3507 } 3508 3509 if (FirstUnwindPad) { 3510 if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) { 3511 BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest(); 3512 Value *SwitchUnwindPad; 3513 if (SwitchUnwindDest) 3514 SwitchUnwindPad = SwitchUnwindDest->getFirstNonPHI(); 3515 else 3516 SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext()); 3517 Assert(SwitchUnwindPad == FirstUnwindPad, 3518 "Unwind edges out of a catch must have the same unwind dest as " 3519 "the parent catchswitch", 3520 &FPI, FirstUser, CatchSwitch); 3521 } 3522 } 3523 3524 visitInstruction(FPI); 3525 } 3526 3527 void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) { 3528 BasicBlock *BB = CatchSwitch.getParent(); 3529 3530 Function *F = BB->getParent(); 3531 Assert(F->hasPersonalityFn(), 3532 "CatchSwitchInst needs to be in a function with a personality.", 3533 &CatchSwitch); 3534 3535 // The catchswitch instruction must be the first non-PHI instruction in the 3536 // block. 3537 Assert(BB->getFirstNonPHI() == &CatchSwitch, 3538 "CatchSwitchInst not the first non-PHI instruction in the block.", 3539 &CatchSwitch); 3540 3541 auto *ParentPad = CatchSwitch.getParentPad(); 3542 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad), 3543 "CatchSwitchInst has an invalid parent.", ParentPad); 3544 3545 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) { 3546 Instruction *I = UnwindDest->getFirstNonPHI(); 3547 Assert(I->isEHPad() && !isa<LandingPadInst>(I), 3548 "CatchSwitchInst must unwind to an EH block which is not a " 3549 "landingpad.", 3550 &CatchSwitch); 3551 3552 // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds 3553 if (getParentPad(I) == ParentPad) 3554 SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch; 3555 } 3556 3557 Assert(CatchSwitch.getNumHandlers() != 0, 3558 "CatchSwitchInst cannot have empty handler list", &CatchSwitch); 3559 3560 for (BasicBlock *Handler : CatchSwitch.handlers()) { 3561 Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()), 3562 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler); 3563 } 3564 3565 visitEHPadPredecessors(CatchSwitch); 3566 visitTerminatorInst(CatchSwitch); 3567 } 3568 3569 void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) { 3570 Assert(isa<CleanupPadInst>(CRI.getOperand(0)), 3571 "CleanupReturnInst needs to be provided a CleanupPad", &CRI, 3572 CRI.getOperand(0)); 3573 3574 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) { 3575 Instruction *I = UnwindDest->getFirstNonPHI(); 3576 Assert(I->isEHPad() && !isa<LandingPadInst>(I), 3577 "CleanupReturnInst must unwind to an EH block which is not a " 3578 "landingpad.", 3579 &CRI); 3580 } 3581 3582 visitTerminatorInst(CRI); 3583 } 3584 3585 void Verifier::verifyDominatesUse(Instruction &I, unsigned i) { 3586 Instruction *Op = cast<Instruction>(I.getOperand(i)); 3587 // If the we have an invalid invoke, don't try to compute the dominance. 3588 // We already reject it in the invoke specific checks and the dominance 3589 // computation doesn't handle multiple edges. 3590 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) { 3591 if (II->getNormalDest() == II->getUnwindDest()) 3592 return; 3593 } 3594 3595 // Quick check whether the def has already been encountered in the same block. 3596 // PHI nodes are not checked to prevent accepting preceeding PHIs, because PHI 3597 // uses are defined to happen on the incoming edge, not at the instruction. 3598 // 3599 // FIXME: If this operand is a MetadataAsValue (wrapping a LocalAsMetadata) 3600 // wrapping an SSA value, assert that we've already encountered it. See 3601 // related FIXME in Mapper::mapLocalAsMetadata in ValueMapper.cpp. 3602 if (!isa<PHINode>(I) && InstsInThisBlock.count(Op)) 3603 return; 3604 3605 const Use &U = I.getOperandUse(i); 3606 Assert(DT.dominates(Op, U), 3607 "Instruction does not dominate all uses!", Op, &I); 3608 } 3609 3610 void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) { 3611 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null " 3612 "apply only to pointer types", &I); 3613 Assert(isa<LoadInst>(I), 3614 "dereferenceable, dereferenceable_or_null apply only to load" 3615 " instructions, use attributes for calls or invokes", &I); 3616 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null " 3617 "take one operand!", &I); 3618 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0)); 3619 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, " 3620 "dereferenceable_or_null metadata value must be an i64!", &I); 3621 } 3622 3623 /// verifyInstruction - Verify that an instruction is well formed. 3624 /// 3625 void Verifier::visitInstruction(Instruction &I) { 3626 BasicBlock *BB = I.getParent(); 3627 Assert(BB, "Instruction not embedded in basic block!", &I); 3628 3629 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential 3630 for (User *U : I.users()) { 3631 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB), 3632 "Only PHI nodes may reference their own value!", &I); 3633 } 3634 } 3635 3636 // Check that void typed values don't have names 3637 Assert(!I.getType()->isVoidTy() || !I.hasName(), 3638 "Instruction has a name, but provides a void value!", &I); 3639 3640 // Check that the return value of the instruction is either void or a legal 3641 // value type. 3642 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(), 3643 "Instruction returns a non-scalar type!", &I); 3644 3645 // Check that the instruction doesn't produce metadata. Calls are already 3646 // checked against the callee type. 3647 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I), 3648 "Invalid use of metadata!", &I); 3649 3650 // Check that all uses of the instruction, if they are instructions 3651 // themselves, actually have parent basic blocks. If the use is not an 3652 // instruction, it is an error! 3653 for (Use &U : I.uses()) { 3654 if (Instruction *Used = dyn_cast<Instruction>(U.getUser())) 3655 Assert(Used->getParent() != nullptr, 3656 "Instruction referencing" 3657 " instruction not embedded in a basic block!", 3658 &I, Used); 3659 else { 3660 CheckFailed("Use of instruction is not an instruction!", U); 3661 return; 3662 } 3663 } 3664 3665 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) { 3666 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I); 3667 3668 // Check to make sure that only first-class-values are operands to 3669 // instructions. 3670 if (!I.getOperand(i)->getType()->isFirstClassType()) { 3671 Assert(0, "Instruction operands must be first-class values!", &I); 3672 } 3673 3674 if (Function *F = dyn_cast<Function>(I.getOperand(i))) { 3675 // Check to make sure that the "address of" an intrinsic function is never 3676 // taken. 3677 Assert( 3678 !F->isIntrinsic() || 3679 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0), 3680 "Cannot take the address of an intrinsic!", &I); 3681 Assert( 3682 !F->isIntrinsic() || isa<CallInst>(I) || 3683 F->getIntrinsicID() == Intrinsic::donothing || 3684 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void || 3685 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 || 3686 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint, 3687 "Cannot invoke an intrinsic other than donothing, patchpoint or " 3688 "statepoint", 3689 &I); 3690 Assert(F->getParent() == &M, "Referencing function in another module!", 3691 &I, &M, F, F->getParent()); 3692 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) { 3693 Assert(OpBB->getParent() == BB->getParent(), 3694 "Referring to a basic block in another function!", &I); 3695 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) { 3696 Assert(OpArg->getParent() == BB->getParent(), 3697 "Referring to an argument in another function!", &I); 3698 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) { 3699 Assert(GV->getParent() == &M, "Referencing global in another module!", &I, 3700 &M, GV, GV->getParent()); 3701 } else if (isa<Instruction>(I.getOperand(i))) { 3702 verifyDominatesUse(I, i); 3703 } else if (isa<InlineAsm>(I.getOperand(i))) { 3704 Assert((i + 1 == e && isa<CallInst>(I)) || 3705 (i + 3 == e && isa<InvokeInst>(I)), 3706 "Cannot take the address of an inline asm!", &I); 3707 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) { 3708 if (CE->getType()->isPtrOrPtrVectorTy() || 3709 !DL.getNonIntegralAddressSpaces().empty()) { 3710 // If we have a ConstantExpr pointer, we need to see if it came from an 3711 // illegal bitcast. If the datalayout string specifies non-integral 3712 // address spaces then we also need to check for illegal ptrtoint and 3713 // inttoptr expressions. 3714 visitConstantExprsRecursively(CE); 3715 } 3716 } 3717 } 3718 3719 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) { 3720 Assert(I.getType()->isFPOrFPVectorTy(), 3721 "fpmath requires a floating point result!", &I); 3722 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I); 3723 if (ConstantFP *CFP0 = 3724 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) { 3725 const APFloat &Accuracy = CFP0->getValueAPF(); 3726 Assert(&Accuracy.getSemantics() == &APFloat::IEEEsingle, 3727 "fpmath accuracy must have float type", &I); 3728 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(), 3729 "fpmath accuracy not a positive number!", &I); 3730 } else { 3731 Assert(false, "invalid fpmath accuracy!", &I); 3732 } 3733 } 3734 3735 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) { 3736 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I), 3737 "Ranges are only for loads, calls and invokes!", &I); 3738 visitRangeMetadata(I, Range, I.getType()); 3739 } 3740 3741 if (I.getMetadata(LLVMContext::MD_nonnull)) { 3742 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types", 3743 &I); 3744 Assert(isa<LoadInst>(I), 3745 "nonnull applies only to load instructions, use attributes" 3746 " for calls or invokes", 3747 &I); 3748 } 3749 3750 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable)) 3751 visitDereferenceableMetadata(I, MD); 3752 3753 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null)) 3754 visitDereferenceableMetadata(I, MD); 3755 3756 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) { 3757 Assert(I.getType()->isPointerTy(), "align applies only to pointer types", 3758 &I); 3759 Assert(isa<LoadInst>(I), "align applies only to load instructions, " 3760 "use attributes for calls or invokes", &I); 3761 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I); 3762 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0)); 3763 Assert(CI && CI->getType()->isIntegerTy(64), 3764 "align metadata value must be an i64!", &I); 3765 uint64_t Align = CI->getZExtValue(); 3766 Assert(isPowerOf2_64(Align), 3767 "align metadata value must be a power of 2!", &I); 3768 Assert(Align <= Value::MaximumAlignment, 3769 "alignment is larger that implementation defined limit", &I); 3770 } 3771 3772 if (MDNode *N = I.getDebugLoc().getAsMDNode()) { 3773 AssertDI(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N); 3774 visitMDNode(*N); 3775 } 3776 3777 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I)) 3778 verifyBitPieceExpression(*DII); 3779 3780 InstsInThisBlock.insert(&I); 3781 } 3782 3783 /// Allow intrinsics to be verified in different ways. 3784 void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) { 3785 Function *IF = CS.getCalledFunction(); 3786 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!", 3787 IF); 3788 3789 // Verify that the intrinsic prototype lines up with what the .td files 3790 // describe. 3791 FunctionType *IFTy = IF->getFunctionType(); 3792 bool IsVarArg = IFTy->isVarArg(); 3793 3794 SmallVector<Intrinsic::IITDescriptor, 8> Table; 3795 getIntrinsicInfoTableEntries(ID, Table); 3796 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table; 3797 3798 SmallVector<Type *, 4> ArgTys; 3799 Assert(!Intrinsic::matchIntrinsicType(IFTy->getReturnType(), 3800 TableRef, ArgTys), 3801 "Intrinsic has incorrect return type!", IF); 3802 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i) 3803 Assert(!Intrinsic::matchIntrinsicType(IFTy->getParamType(i), 3804 TableRef, ArgTys), 3805 "Intrinsic has incorrect argument type!", IF); 3806 3807 // Verify if the intrinsic call matches the vararg property. 3808 if (IsVarArg) 3809 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef), 3810 "Intrinsic was not defined with variable arguments!", IF); 3811 else 3812 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef), 3813 "Callsite was not defined with variable arguments!", IF); 3814 3815 // All descriptors should be absorbed by now. 3816 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF); 3817 3818 // Now that we have the intrinsic ID and the actual argument types (and we 3819 // know they are legal for the intrinsic!) get the intrinsic name through the 3820 // usual means. This allows us to verify the mangling of argument types into 3821 // the name. 3822 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys); 3823 Assert(ExpectedName == IF->getName(), 3824 "Intrinsic name not mangled correctly for type arguments! " 3825 "Should be: " + 3826 ExpectedName, 3827 IF); 3828 3829 // If the intrinsic takes MDNode arguments, verify that they are either global 3830 // or are local to *this* function. 3831 for (Value *V : CS.args()) 3832 if (auto *MD = dyn_cast<MetadataAsValue>(V)) 3833 visitMetadataAsValue(*MD, CS.getCaller()); 3834 3835 switch (ID) { 3836 default: 3837 break; 3838 case Intrinsic::ctlz: // llvm.ctlz 3839 case Intrinsic::cttz: // llvm.cttz 3840 Assert(isa<ConstantInt>(CS.getArgOperand(1)), 3841 "is_zero_undef argument of bit counting intrinsics must be a " 3842 "constant int", 3843 CS); 3844 break; 3845 case Intrinsic::dbg_declare: // llvm.dbg.declare 3846 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)), 3847 "invalid llvm.dbg.declare intrinsic call 1", CS); 3848 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction())); 3849 break; 3850 case Intrinsic::dbg_value: // llvm.dbg.value 3851 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction())); 3852 break; 3853 case Intrinsic::memcpy: 3854 case Intrinsic::memmove: 3855 case Intrinsic::memset: { 3856 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3)); 3857 Assert(AlignCI, 3858 "alignment argument of memory intrinsics must be a constant int", 3859 CS); 3860 const APInt &AlignVal = AlignCI->getValue(); 3861 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(), 3862 "alignment argument of memory intrinsics must be a power of 2", CS); 3863 Assert(isa<ConstantInt>(CS.getArgOperand(4)), 3864 "isvolatile argument of memory intrinsics must be a constant int", 3865 CS); 3866 break; 3867 } 3868 case Intrinsic::gcroot: 3869 case Intrinsic::gcwrite: 3870 case Intrinsic::gcread: 3871 if (ID == Intrinsic::gcroot) { 3872 AllocaInst *AI = 3873 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts()); 3874 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS); 3875 Assert(isa<Constant>(CS.getArgOperand(1)), 3876 "llvm.gcroot parameter #2 must be a constant.", CS); 3877 if (!AI->getAllocatedType()->isPointerTy()) { 3878 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)), 3879 "llvm.gcroot parameter #1 must either be a pointer alloca, " 3880 "or argument #2 must be a non-null constant.", 3881 CS); 3882 } 3883 } 3884 3885 Assert(CS.getParent()->getParent()->hasGC(), 3886 "Enclosing function does not use GC.", CS); 3887 break; 3888 case Intrinsic::init_trampoline: 3889 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()), 3890 "llvm.init_trampoline parameter #2 must resolve to a function.", 3891 CS); 3892 break; 3893 case Intrinsic::prefetch: 3894 Assert(isa<ConstantInt>(CS.getArgOperand(1)) && 3895 isa<ConstantInt>(CS.getArgOperand(2)) && 3896 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 && 3897 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4, 3898 "invalid arguments to llvm.prefetch", CS); 3899 break; 3900 case Intrinsic::stackprotector: 3901 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()), 3902 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS); 3903 break; 3904 case Intrinsic::lifetime_start: 3905 case Intrinsic::lifetime_end: 3906 case Intrinsic::invariant_start: 3907 Assert(isa<ConstantInt>(CS.getArgOperand(0)), 3908 "size argument of memory use markers must be a constant integer", 3909 CS); 3910 break; 3911 case Intrinsic::invariant_end: 3912 Assert(isa<ConstantInt>(CS.getArgOperand(1)), 3913 "llvm.invariant.end parameter #2 must be a constant integer", CS); 3914 break; 3915 3916 case Intrinsic::localescape: { 3917 BasicBlock *BB = CS.getParent(); 3918 Assert(BB == &BB->getParent()->front(), 3919 "llvm.localescape used outside of entry block", CS); 3920 Assert(!SawFrameEscape, 3921 "multiple calls to llvm.localescape in one function", CS); 3922 for (Value *Arg : CS.args()) { 3923 if (isa<ConstantPointerNull>(Arg)) 3924 continue; // Null values are allowed as placeholders. 3925 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts()); 3926 Assert(AI && AI->isStaticAlloca(), 3927 "llvm.localescape only accepts static allocas", CS); 3928 } 3929 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands(); 3930 SawFrameEscape = true; 3931 break; 3932 } 3933 case Intrinsic::localrecover: { 3934 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts(); 3935 Function *Fn = dyn_cast<Function>(FnArg); 3936 Assert(Fn && !Fn->isDeclaration(), 3937 "llvm.localrecover first " 3938 "argument must be function defined in this module", 3939 CS); 3940 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2)); 3941 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int", 3942 CS); 3943 auto &Entry = FrameEscapeInfo[Fn]; 3944 Entry.second = unsigned( 3945 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1)); 3946 break; 3947 } 3948 3949 case Intrinsic::experimental_gc_statepoint: 3950 Assert(!CS.isInlineAsm(), 3951 "gc.statepoint support for inline assembly unimplemented", CS); 3952 Assert(CS.getParent()->getParent()->hasGC(), 3953 "Enclosing function does not use GC.", CS); 3954 3955 verifyStatepoint(CS); 3956 break; 3957 case Intrinsic::experimental_gc_result: { 3958 Assert(CS.getParent()->getParent()->hasGC(), 3959 "Enclosing function does not use GC.", CS); 3960 // Are we tied to a statepoint properly? 3961 CallSite StatepointCS(CS.getArgOperand(0)); 3962 const Function *StatepointFn = 3963 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr; 3964 Assert(StatepointFn && StatepointFn->isDeclaration() && 3965 StatepointFn->getIntrinsicID() == 3966 Intrinsic::experimental_gc_statepoint, 3967 "gc.result operand #1 must be from a statepoint", CS, 3968 CS.getArgOperand(0)); 3969 3970 // Assert that result type matches wrapped callee. 3971 const Value *Target = StatepointCS.getArgument(2); 3972 auto *PT = cast<PointerType>(Target->getType()); 3973 auto *TargetFuncType = cast<FunctionType>(PT->getElementType()); 3974 Assert(CS.getType() == TargetFuncType->getReturnType(), 3975 "gc.result result type does not match wrapped callee", CS); 3976 break; 3977 } 3978 case Intrinsic::experimental_gc_relocate: { 3979 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS); 3980 3981 Assert(isa<PointerType>(CS.getType()->getScalarType()), 3982 "gc.relocate must return a pointer or a vector of pointers", CS); 3983 3984 // Check that this relocate is correctly tied to the statepoint 3985 3986 // This is case for relocate on the unwinding path of an invoke statepoint 3987 if (LandingPadInst *LandingPad = 3988 dyn_cast<LandingPadInst>(CS.getArgOperand(0))) { 3989 3990 const BasicBlock *InvokeBB = 3991 LandingPad->getParent()->getUniquePredecessor(); 3992 3993 // Landingpad relocates should have only one predecessor with invoke 3994 // statepoint terminator 3995 Assert(InvokeBB, "safepoints should have unique landingpads", 3996 LandingPad->getParent()); 3997 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed", 3998 InvokeBB); 3999 Assert(isStatepoint(InvokeBB->getTerminator()), 4000 "gc relocate should be linked to a statepoint", InvokeBB); 4001 } 4002 else { 4003 // In all other cases relocate should be tied to the statepoint directly. 4004 // This covers relocates on a normal return path of invoke statepoint and 4005 // relocates of a call statepoint. 4006 auto Token = CS.getArgOperand(0); 4007 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)), 4008 "gc relocate is incorrectly tied to the statepoint", CS, Token); 4009 } 4010 4011 // Verify rest of the relocate arguments. 4012 4013 ImmutableCallSite StatepointCS( 4014 cast<GCRelocateInst>(*CS.getInstruction()).getStatepoint()); 4015 4016 // Both the base and derived must be piped through the safepoint. 4017 Value* Base = CS.getArgOperand(1); 4018 Assert(isa<ConstantInt>(Base), 4019 "gc.relocate operand #2 must be integer offset", CS); 4020 4021 Value* Derived = CS.getArgOperand(2); 4022 Assert(isa<ConstantInt>(Derived), 4023 "gc.relocate operand #3 must be integer offset", CS); 4024 4025 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue(); 4026 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue(); 4027 // Check the bounds 4028 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(), 4029 "gc.relocate: statepoint base index out of bounds", CS); 4030 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(), 4031 "gc.relocate: statepoint derived index out of bounds", CS); 4032 4033 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters' 4034 // section of the statepoint's argument. 4035 Assert(StatepointCS.arg_size() > 0, 4036 "gc.statepoint: insufficient arguments"); 4037 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)), 4038 "gc.statement: number of call arguments must be constant integer"); 4039 const unsigned NumCallArgs = 4040 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue(); 4041 Assert(StatepointCS.arg_size() > NumCallArgs + 5, 4042 "gc.statepoint: mismatch in number of call arguments"); 4043 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)), 4044 "gc.statepoint: number of transition arguments must be " 4045 "a constant integer"); 4046 const int NumTransitionArgs = 4047 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)) 4048 ->getZExtValue(); 4049 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1; 4050 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)), 4051 "gc.statepoint: number of deoptimization arguments must be " 4052 "a constant integer"); 4053 const int NumDeoptArgs = 4054 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)) 4055 ->getZExtValue(); 4056 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs; 4057 const int GCParamArgsEnd = StatepointCS.arg_size(); 4058 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd, 4059 "gc.relocate: statepoint base index doesn't fall within the " 4060 "'gc parameters' section of the statepoint call", 4061 CS); 4062 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd, 4063 "gc.relocate: statepoint derived index doesn't fall within the " 4064 "'gc parameters' section of the statepoint call", 4065 CS); 4066 4067 // Relocated value must be either a pointer type or vector-of-pointer type, 4068 // but gc_relocate does not need to return the same pointer type as the 4069 // relocated pointer. It can be casted to the correct type later if it's 4070 // desired. However, they must have the same address space and 'vectorness' 4071 GCRelocateInst &Relocate = cast<GCRelocateInst>(*CS.getInstruction()); 4072 Assert(Relocate.getDerivedPtr()->getType()->getScalarType()->isPointerTy(), 4073 "gc.relocate: relocated value must be a gc pointer", CS); 4074 4075 auto ResultType = CS.getType(); 4076 auto DerivedType = Relocate.getDerivedPtr()->getType(); 4077 Assert(ResultType->isVectorTy() == DerivedType->isVectorTy(), 4078 "gc.relocate: vector relocates to vector and pointer to pointer", 4079 CS); 4080 Assert( 4081 ResultType->getPointerAddressSpace() == 4082 DerivedType->getPointerAddressSpace(), 4083 "gc.relocate: relocating a pointer shouldn't change its address space", 4084 CS); 4085 break; 4086 } 4087 case Intrinsic::eh_exceptioncode: 4088 case Intrinsic::eh_exceptionpointer: { 4089 Assert(isa<CatchPadInst>(CS.getArgOperand(0)), 4090 "eh.exceptionpointer argument must be a catchpad", CS); 4091 break; 4092 } 4093 case Intrinsic::masked_load: { 4094 Assert(CS.getType()->isVectorTy(), "masked_load: must return a vector", CS); 4095 4096 Value *Ptr = CS.getArgOperand(0); 4097 //Value *Alignment = CS.getArgOperand(1); 4098 Value *Mask = CS.getArgOperand(2); 4099 Value *PassThru = CS.getArgOperand(3); 4100 Assert(Mask->getType()->isVectorTy(), 4101 "masked_load: mask must be vector", CS); 4102 4103 // DataTy is the overloaded type 4104 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType(); 4105 Assert(DataTy == CS.getType(), 4106 "masked_load: return must match pointer type", CS); 4107 Assert(PassThru->getType() == DataTy, 4108 "masked_load: pass through and data type must match", CS); 4109 Assert(Mask->getType()->getVectorNumElements() == 4110 DataTy->getVectorNumElements(), 4111 "masked_load: vector mask must be same length as data", CS); 4112 break; 4113 } 4114 case Intrinsic::masked_store: { 4115 Value *Val = CS.getArgOperand(0); 4116 Value *Ptr = CS.getArgOperand(1); 4117 //Value *Alignment = CS.getArgOperand(2); 4118 Value *Mask = CS.getArgOperand(3); 4119 Assert(Mask->getType()->isVectorTy(), 4120 "masked_store: mask must be vector", CS); 4121 4122 // DataTy is the overloaded type 4123 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType(); 4124 Assert(DataTy == Val->getType(), 4125 "masked_store: storee must match pointer type", CS); 4126 Assert(Mask->getType()->getVectorNumElements() == 4127 DataTy->getVectorNumElements(), 4128 "masked_store: vector mask must be same length as data", CS); 4129 break; 4130 } 4131 4132 case Intrinsic::experimental_guard: { 4133 Assert(CS.isCall(), "experimental_guard cannot be invoked", CS); 4134 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1, 4135 "experimental_guard must have exactly one " 4136 "\"deopt\" operand bundle"); 4137 break; 4138 } 4139 4140 case Intrinsic::experimental_deoptimize: { 4141 Assert(CS.isCall(), "experimental_deoptimize cannot be invoked", CS); 4142 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1, 4143 "experimental_deoptimize must have exactly one " 4144 "\"deopt\" operand bundle"); 4145 Assert(CS.getType() == CS.getInstruction()->getFunction()->getReturnType(), 4146 "experimental_deoptimize return type must match caller return type"); 4147 4148 if (CS.isCall()) { 4149 auto *DeoptCI = CS.getInstruction(); 4150 auto *RI = dyn_cast<ReturnInst>(DeoptCI->getNextNode()); 4151 Assert(RI, 4152 "calls to experimental_deoptimize must be followed by a return"); 4153 4154 if (!CS.getType()->isVoidTy() && RI) 4155 Assert(RI->getReturnValue() == DeoptCI, 4156 "calls to experimental_deoptimize must be followed by a return " 4157 "of the value computed by experimental_deoptimize"); 4158 } 4159 4160 break; 4161 } 4162 }; 4163 } 4164 4165 /// \brief Carefully grab the subprogram from a local scope. 4166 /// 4167 /// This carefully grabs the subprogram from a local scope, avoiding the 4168 /// built-in assertions that would typically fire. 4169 static DISubprogram *getSubprogram(Metadata *LocalScope) { 4170 if (!LocalScope) 4171 return nullptr; 4172 4173 if (auto *SP = dyn_cast<DISubprogram>(LocalScope)) 4174 return SP; 4175 4176 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope)) 4177 return getSubprogram(LB->getRawScope()); 4178 4179 // Just return null; broken scope chains are checked elsewhere. 4180 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope"); 4181 return nullptr; 4182 } 4183 4184 template <class DbgIntrinsicTy> 4185 void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) { 4186 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata(); 4187 AssertDI(isa<ValueAsMetadata>(MD) || 4188 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()), 4189 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD); 4190 AssertDI(isa<DILocalVariable>(DII.getRawVariable()), 4191 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII, 4192 DII.getRawVariable()); 4193 AssertDI(isa<DIExpression>(DII.getRawExpression()), 4194 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII, 4195 DII.getRawExpression()); 4196 4197 // Ignore broken !dbg attachments; they're checked elsewhere. 4198 if (MDNode *N = DII.getDebugLoc().getAsMDNode()) 4199 if (!isa<DILocation>(N)) 4200 return; 4201 4202 BasicBlock *BB = DII.getParent(); 4203 Function *F = BB ? BB->getParent() : nullptr; 4204 4205 // The scopes for variables and !dbg attachments must agree. 4206 DILocalVariable *Var = DII.getVariable(); 4207 DILocation *Loc = DII.getDebugLoc(); 4208 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment", 4209 &DII, BB, F); 4210 4211 DISubprogram *VarSP = getSubprogram(Var->getRawScope()); 4212 DISubprogram *LocSP = getSubprogram(Loc->getRawScope()); 4213 if (!VarSP || !LocSP) 4214 return; // Broken scope chains are checked elsewhere. 4215 4216 Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind + 4217 " variable and !dbg attachment", 4218 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc, 4219 Loc->getScope()->getSubprogram()); 4220 } 4221 4222 static uint64_t getVariableSize(const DILocalVariable &V) { 4223 // Be careful of broken types (checked elsewhere). 4224 const Metadata *RawType = V.getRawType(); 4225 while (RawType) { 4226 // Try to get the size directly. 4227 if (auto *T = dyn_cast<DIType>(RawType)) 4228 if (uint64_t Size = T->getSizeInBits()) 4229 return Size; 4230 4231 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) { 4232 // Look at the base type. 4233 RawType = DT->getRawBaseType(); 4234 continue; 4235 } 4236 4237 // Missing type or size. 4238 break; 4239 } 4240 4241 // Fail gracefully. 4242 return 0; 4243 } 4244 4245 void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I) { 4246 DILocalVariable *V; 4247 DIExpression *E; 4248 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) { 4249 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable()); 4250 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression()); 4251 } else { 4252 auto *DDI = cast<DbgDeclareInst>(&I); 4253 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable()); 4254 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression()); 4255 } 4256 4257 // We don't know whether this intrinsic verified correctly. 4258 if (!V || !E || !E->isValid()) 4259 return; 4260 4261 // Nothing to do if this isn't a bit piece expression. 4262 if (!E->isBitPiece()) 4263 return; 4264 4265 // The frontend helps out GDB by emitting the members of local anonymous 4266 // unions as artificial local variables with shared storage. When SROA splits 4267 // the storage for artificial local variables that are smaller than the entire 4268 // union, the overhang piece will be outside of the allotted space for the 4269 // variable and this check fails. 4270 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs. 4271 if (V->isArtificial()) 4272 return; 4273 4274 // If there's no size, the type is broken, but that should be checked 4275 // elsewhere. 4276 uint64_t VarSize = getVariableSize(*V); 4277 if (!VarSize) 4278 return; 4279 4280 unsigned PieceSize = E->getBitPieceSize(); 4281 unsigned PieceOffset = E->getBitPieceOffset(); 4282 Assert(PieceSize + PieceOffset <= VarSize, 4283 "piece is larger than or outside of variable", &I, V, E); 4284 Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E); 4285 } 4286 4287 void Verifier::verifyCompileUnits() { 4288 auto *CUs = M.getNamedMetadata("llvm.dbg.cu"); 4289 SmallPtrSet<const Metadata *, 2> Listed; 4290 if (CUs) 4291 Listed.insert(CUs->op_begin(), CUs->op_end()); 4292 Assert( 4293 std::all_of(CUVisited.begin(), CUVisited.end(), 4294 [&Listed](const Metadata *CU) { return Listed.count(CU); }), 4295 "All DICompileUnits must be listed in llvm.dbg.cu"); 4296 CUVisited.clear(); 4297 } 4298 4299 void Verifier::verifyDeoptimizeCallingConvs() { 4300 if (DeoptimizeDeclarations.empty()) 4301 return; 4302 4303 const Function *First = DeoptimizeDeclarations[0]; 4304 for (auto *F : makeArrayRef(DeoptimizeDeclarations).slice(1)) { 4305 Assert(First->getCallingConv() == F->getCallingConv(), 4306 "All llvm.experimental.deoptimize declarations must have the same " 4307 "calling convention", 4308 First, F); 4309 } 4310 } 4311 4312 //===----------------------------------------------------------------------===// 4313 // Implement the public interfaces to this file... 4314 //===----------------------------------------------------------------------===// 4315 4316 bool llvm::verifyFunction(const Function &f, raw_ostream *OS) { 4317 Function &F = const_cast<Function &>(f); 4318 4319 // Don't use a raw_null_ostream. Printing IR is expensive. 4320 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/true, *f.getParent()); 4321 4322 // Note that this function's return value is inverted from what you would 4323 // expect of a function called "verify". 4324 return !V.verify(F); 4325 } 4326 4327 bool llvm::verifyModule(const Module &M, raw_ostream *OS, 4328 bool *BrokenDebugInfo) { 4329 // Don't use a raw_null_ostream. Printing IR is expensive. 4330 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/!BrokenDebugInfo, M); 4331 4332 bool Broken = false; 4333 for (const Function &F : M) 4334 Broken |= !V.verify(F); 4335 4336 Broken |= !V.verify(); 4337 if (BrokenDebugInfo) 4338 *BrokenDebugInfo = V.hasBrokenDebugInfo(); 4339 // Note that this function's return value is inverted from what you would 4340 // expect of a function called "verify". 4341 return Broken; 4342 } 4343 4344 namespace { 4345 struct VerifierLegacyPass : public FunctionPass { 4346 static char ID; 4347 4348 std::unique_ptr<Verifier> V; 4349 bool FatalErrors = true; 4350 4351 VerifierLegacyPass() : FunctionPass(ID) { 4352 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry()); 4353 } 4354 explicit VerifierLegacyPass(bool FatalErrors) 4355 : FunctionPass(ID), 4356 FatalErrors(FatalErrors) { 4357 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry()); 4358 } 4359 4360 bool doInitialization(Module &M) override { 4361 V = llvm::make_unique<Verifier>( 4362 &dbgs(), /*ShouldTreatBrokenDebugInfoAsError=*/false, M); 4363 return false; 4364 } 4365 4366 bool runOnFunction(Function &F) override { 4367 if (!V->verify(F) && FatalErrors) 4368 report_fatal_error("Broken function found, compilation aborted!"); 4369 4370 return false; 4371 } 4372 4373 bool doFinalization(Module &M) override { 4374 bool HasErrors = false; 4375 for (Function &F : M) 4376 if (F.isDeclaration()) 4377 HasErrors |= !V->verify(F); 4378 4379 HasErrors |= !V->verify(); 4380 if (FatalErrors) { 4381 if (HasErrors) 4382 report_fatal_error("Broken module found, compilation aborted!"); 4383 assert(!V->hasBrokenDebugInfo() && "Module contains invalid debug info"); 4384 } 4385 4386 // Strip broken debug info. 4387 if (V->hasBrokenDebugInfo()) { 4388 DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M); 4389 M.getContext().diagnose(DiagInvalid); 4390 if (!StripDebugInfo(M)) 4391 report_fatal_error("Failed to strip malformed debug info"); 4392 } 4393 return false; 4394 } 4395 4396 void getAnalysisUsage(AnalysisUsage &AU) const override { 4397 AU.setPreservesAll(); 4398 } 4399 }; 4400 } 4401 4402 char VerifierLegacyPass::ID = 0; 4403 INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false) 4404 4405 FunctionPass *llvm::createVerifierPass(bool FatalErrors) { 4406 return new VerifierLegacyPass(FatalErrors); 4407 } 4408 4409 char VerifierAnalysis::PassID; 4410 VerifierAnalysis::Result VerifierAnalysis::run(Module &M, 4411 ModuleAnalysisManager &) { 4412 Result Res; 4413 Res.IRBroken = llvm::verifyModule(M, &dbgs(), &Res.DebugInfoBroken); 4414 return Res; 4415 } 4416 4417 VerifierAnalysis::Result VerifierAnalysis::run(Function &F, 4418 FunctionAnalysisManager &) { 4419 return { llvm::verifyFunction(F, &dbgs()), false }; 4420 } 4421 4422 PreservedAnalyses VerifierPass::run(Module &M, ModuleAnalysisManager &AM) { 4423 auto Res = AM.getResult<VerifierAnalysis>(M); 4424 if (FatalErrors) { 4425 if (Res.IRBroken) 4426 report_fatal_error("Broken module found, compilation aborted!"); 4427 assert(!Res.DebugInfoBroken && "Module contains invalid debug info"); 4428 } 4429 4430 // Strip broken debug info. 4431 if (Res.DebugInfoBroken) { 4432 DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M); 4433 M.getContext().diagnose(DiagInvalid); 4434 if (!StripDebugInfo(M)) 4435 report_fatal_error("Failed to strip malformed debug info"); 4436 } 4437 return PreservedAnalyses::all(); 4438 } 4439 4440 PreservedAnalyses VerifierPass::run(Function &F, FunctionAnalysisManager &AM) { 4441 auto res = AM.getResult<VerifierAnalysis>(F); 4442 if (res.IRBroken && FatalErrors) 4443 report_fatal_error("Broken function found, compilation aborted!"); 4444 4445 return PreservedAnalyses::all(); 4446 } 4447