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