1 //===-- Verifier.cpp - Implement the Module Verifier -----------------------==// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 // 9 // This file defines the function verifier interface, that can be used for some 10 // sanity checking of input to the system. 11 // 12 // Note that this does not provide full `Java style' security and verifications, 13 // instead it just tries to ensure that code is well-formed. 14 // 15 // * Both of a binary operator's parameters are of the same type 16 // * Verify that the indices of mem access instructions match other operands 17 // * Verify that arithmetic and other things are only performed on first-class 18 // types. Verify that shifts & logicals only happen on integrals f.e. 19 // * All of the constants in a switch statement are of the correct type 20 // * The code is in valid SSA form 21 // * It should be illegal to put a label into any other type (like a structure) 22 // or to return one. [except constant arrays!] 23 // * Only phi nodes can be self referential: 'add i32 %0, %0 ; <int>:0' is bad 24 // * PHI nodes must have an entry for each predecessor, with no extras. 25 // * PHI nodes must be the first thing in a basic block, all grouped together 26 // * PHI nodes must have at least one entry 27 // * All basic blocks should only end with terminator insts, not contain them 28 // * The entry node to a function must not have predecessors 29 // * All Instructions must be embedded into a basic block 30 // * Functions cannot take a void-typed parameter 31 // * Verify that a function's argument list agrees with it's declared type. 32 // * It is illegal to specify a name for a void value. 33 // * It is illegal to have a internal global value with no initializer 34 // * It is illegal to have a ret instruction that returns a value that does not 35 // agree with the function return value type. 36 // * Function call argument types match the function prototype 37 // * A landing pad is defined by a landingpad instruction, and can be jumped to 38 // only by the unwind edge of an invoke instruction. 39 // * A landingpad instruction must be the first non-PHI instruction in the 40 // block. 41 // * Landingpad instructions must be in a function with a personality function. 42 // * All other things that are tested by asserts spread about the code... 43 // 44 //===----------------------------------------------------------------------===// 45 46 #include "llvm/IR/Verifier.h" 47 #include "llvm/ADT/APFloat.h" 48 #include "llvm/ADT/APInt.h" 49 #include "llvm/ADT/ArrayRef.h" 50 #include "llvm/ADT/DenseMap.h" 51 #include "llvm/ADT/MapVector.h" 52 #include "llvm/ADT/Optional.h" 53 #include "llvm/ADT/STLExtras.h" 54 #include "llvm/ADT/SmallPtrSet.h" 55 #include "llvm/ADT/SmallSet.h" 56 #include "llvm/ADT/SmallVector.h" 57 #include "llvm/ADT/StringExtras.h" 58 #include "llvm/ADT/StringMap.h" 59 #include "llvm/ADT/StringRef.h" 60 #include "llvm/ADT/Twine.h" 61 #include "llvm/ADT/ilist.h" 62 #include "llvm/BinaryFormat/Dwarf.h" 63 #include "llvm/IR/Argument.h" 64 #include "llvm/IR/Attributes.h" 65 #include "llvm/IR/BasicBlock.h" 66 #include "llvm/IR/CFG.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/Dominators.h" 78 #include "llvm/IR/Function.h" 79 #include "llvm/IR/GlobalAlias.h" 80 #include "llvm/IR/GlobalValue.h" 81 #include "llvm/IR/GlobalVariable.h" 82 #include "llvm/IR/InlineAsm.h" 83 #include "llvm/IR/InstVisitor.h" 84 #include "llvm/IR/InstrTypes.h" 85 #include "llvm/IR/Instruction.h" 86 #include "llvm/IR/Instructions.h" 87 #include "llvm/IR/IntrinsicInst.h" 88 #include "llvm/IR/Intrinsics.h" 89 #include "llvm/IR/IntrinsicsWebAssembly.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/InitializePasses.h" 101 #include "llvm/Pass.h" 102 #include "llvm/Support/AtomicOrdering.h" 103 #include "llvm/Support/Casting.h" 104 #include "llvm/Support/CommandLine.h" 105 #include "llvm/Support/Debug.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> VerifyNoAliasScopeDomination( 119 "verify-noalias-scope-decl-dom", cl::Hidden, cl::init(false), 120 cl::desc("Ensure that llvm.experimental.noalias.scope.decl for identical " 121 "scopes are not dominating")); 122 123 namespace llvm { 124 125 struct VerifierSupport { 126 raw_ostream *OS; 127 const Module &M; 128 ModuleSlotTracker MST; 129 Triple TT; 130 const DataLayout &DL; 131 LLVMContext &Context; 132 133 /// Track the brokenness of the module while recursively visiting. 134 bool Broken = false; 135 /// Broken debug info can be "recovered" from by stripping the debug info. 136 bool BrokenDebugInfo = false; 137 /// Whether to treat broken debug info as an error. 138 bool TreatBrokenDebugInfoAsError = true; 139 140 explicit VerifierSupport(raw_ostream *OS, const Module &M) 141 : OS(OS), M(M), MST(&M), TT(M.getTargetTriple()), DL(M.getDataLayout()), 142 Context(M.getContext()) {} 143 144 private: 145 void Write(const Module *M) { 146 *OS << "; ModuleID = '" << M->getModuleIdentifier() << "'\n"; 147 } 148 149 void Write(const Value *V) { 150 if (V) 151 Write(*V); 152 } 153 154 void Write(const Value &V) { 155 if (isa<Instruction>(V)) { 156 V.print(*OS, MST); 157 *OS << '\n'; 158 } else { 159 V.printAsOperand(*OS, true, MST); 160 *OS << '\n'; 161 } 162 } 163 164 void Write(const Metadata *MD) { 165 if (!MD) 166 return; 167 MD->print(*OS, MST, &M); 168 *OS << '\n'; 169 } 170 171 template <class T> void Write(const MDTupleTypedArrayWrapper<T> &MD) { 172 Write(MD.get()); 173 } 174 175 void Write(const NamedMDNode *NMD) { 176 if (!NMD) 177 return; 178 NMD->print(*OS, MST); 179 *OS << '\n'; 180 } 181 182 void Write(Type *T) { 183 if (!T) 184 return; 185 *OS << ' ' << *T; 186 } 187 188 void Write(const Comdat *C) { 189 if (!C) 190 return; 191 *OS << *C; 192 } 193 194 void Write(const APInt *AI) { 195 if (!AI) 196 return; 197 *OS << *AI << '\n'; 198 } 199 200 void Write(const unsigned i) { *OS << i << '\n'; } 201 202 // NOLINTNEXTLINE(readability-identifier-naming) 203 void Write(const Attribute *A) { 204 if (!A) 205 return; 206 *OS << A->getAsString() << '\n'; 207 } 208 209 // NOLINTNEXTLINE(readability-identifier-naming) 210 void Write(const AttributeSet *AS) { 211 if (!AS) 212 return; 213 *OS << AS->getAsString() << '\n'; 214 } 215 216 // NOLINTNEXTLINE(readability-identifier-naming) 217 void Write(const AttributeList *AL) { 218 if (!AL) 219 return; 220 AL->print(*OS); 221 } 222 223 template <typename T> void Write(ArrayRef<T> Vs) { 224 for (const T &V : Vs) 225 Write(V); 226 } 227 228 template <typename T1, typename... Ts> 229 void WriteTs(const T1 &V1, const Ts &... Vs) { 230 Write(V1); 231 WriteTs(Vs...); 232 } 233 234 template <typename... Ts> void WriteTs() {} 235 236 public: 237 /// A check failed, so printout out the condition and the message. 238 /// 239 /// This provides a nice place to put a breakpoint if you want to see why 240 /// something is not correct. 241 void CheckFailed(const Twine &Message) { 242 if (OS) 243 *OS << Message << '\n'; 244 Broken = true; 245 } 246 247 /// A check failed (with values to print). 248 /// 249 /// This calls the Message-only version so that the above is easier to set a 250 /// breakpoint on. 251 template <typename T1, typename... Ts> 252 void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) { 253 CheckFailed(Message); 254 if (OS) 255 WriteTs(V1, Vs...); 256 } 257 258 /// A debug info check failed. 259 void DebugInfoCheckFailed(const Twine &Message) { 260 if (OS) 261 *OS << Message << '\n'; 262 Broken |= TreatBrokenDebugInfoAsError; 263 BrokenDebugInfo = true; 264 } 265 266 /// A debug info check failed (with values to print). 267 template <typename T1, typename... Ts> 268 void DebugInfoCheckFailed(const Twine &Message, const T1 &V1, 269 const Ts &... Vs) { 270 DebugInfoCheckFailed(Message); 271 if (OS) 272 WriteTs(V1, Vs...); 273 } 274 }; 275 276 } // namespace llvm 277 278 namespace { 279 280 class Verifier : public InstVisitor<Verifier>, VerifierSupport { 281 friend class InstVisitor<Verifier>; 282 283 DominatorTree DT; 284 285 /// When verifying a basic block, keep track of all of the 286 /// instructions we have seen so far. 287 /// 288 /// This allows us to do efficient dominance checks for the case when an 289 /// instruction has an operand that is an instruction in the same block. 290 SmallPtrSet<Instruction *, 16> InstsInThisBlock; 291 292 /// Keep track of the metadata nodes that have been checked already. 293 SmallPtrSet<const Metadata *, 32> MDNodes; 294 295 /// Keep track which DISubprogram is attached to which function. 296 DenseMap<const DISubprogram *, const Function *> DISubprogramAttachments; 297 298 /// Track all DICompileUnits visited. 299 SmallPtrSet<const Metadata *, 2> CUVisited; 300 301 /// The result type for a landingpad. 302 Type *LandingPadResultTy; 303 304 /// Whether we've seen a call to @llvm.localescape in this function 305 /// already. 306 bool SawFrameEscape; 307 308 /// Whether the current function has a DISubprogram attached to it. 309 bool HasDebugInfo = false; 310 311 /// The current source language. 312 dwarf::SourceLanguage CurrentSourceLang = dwarf::DW_LANG_lo_user; 313 314 /// Whether source was present on the first DIFile encountered in each CU. 315 DenseMap<const DICompileUnit *, bool> HasSourceDebugInfo; 316 317 /// Stores the count of how many objects were passed to llvm.localescape for a 318 /// given function and the largest index passed to llvm.localrecover. 319 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo; 320 321 // Maps catchswitches and cleanuppads that unwind to siblings to the 322 // terminators that indicate the unwind, used to detect cycles therein. 323 MapVector<Instruction *, Instruction *> SiblingFuncletInfo; 324 325 /// Cache of constants visited in search of ConstantExprs. 326 SmallPtrSet<const Constant *, 32> ConstantExprVisited; 327 328 /// Cache of declarations of the llvm.experimental.deoptimize.<ty> intrinsic. 329 SmallVector<const Function *, 4> DeoptimizeDeclarations; 330 331 /// Cache of attribute lists verified. 332 SmallPtrSet<const void *, 32> AttributeListsVisited; 333 334 // Verify that this GlobalValue is only used in this module. 335 // This map is used to avoid visiting uses twice. We can arrive at a user 336 // twice, if they have multiple operands. In particular for very large 337 // constant expressions, we can arrive at a particular user many times. 338 SmallPtrSet<const Value *, 32> GlobalValueVisited; 339 340 // Keeps track of duplicate function argument debug info. 341 SmallVector<const DILocalVariable *, 16> DebugFnArgs; 342 343 TBAAVerifier TBAAVerifyHelper; 344 345 SmallVector<IntrinsicInst *, 4> NoAliasScopeDecls; 346 347 void checkAtomicMemAccessSize(Type *Ty, const Instruction *I); 348 349 public: 350 explicit Verifier(raw_ostream *OS, bool ShouldTreatBrokenDebugInfoAsError, 351 const Module &M) 352 : VerifierSupport(OS, M), LandingPadResultTy(nullptr), 353 SawFrameEscape(false), TBAAVerifyHelper(this) { 354 TreatBrokenDebugInfoAsError = ShouldTreatBrokenDebugInfoAsError; 355 } 356 357 bool hasBrokenDebugInfo() const { return BrokenDebugInfo; } 358 359 bool verify(const Function &F) { 360 assert(F.getParent() == &M && 361 "An instance of this class only works with a specific module!"); 362 363 // First ensure the function is well-enough formed to compute dominance 364 // information, and directly compute a dominance tree. We don't rely on the 365 // pass manager to provide this as it isolates us from a potentially 366 // out-of-date dominator tree and makes it significantly more complex to run 367 // this code outside of a pass manager. 368 // FIXME: It's really gross that we have to cast away constness here. 369 if (!F.empty()) 370 DT.recalculate(const_cast<Function &>(F)); 371 372 for (const BasicBlock &BB : F) { 373 if (!BB.empty() && BB.back().isTerminator()) 374 continue; 375 376 if (OS) { 377 *OS << "Basic Block in function '" << F.getName() 378 << "' does not have terminator!\n"; 379 BB.printAsOperand(*OS, true, MST); 380 *OS << "\n"; 381 } 382 return false; 383 } 384 385 Broken = false; 386 // FIXME: We strip const here because the inst visitor strips const. 387 visit(const_cast<Function &>(F)); 388 verifySiblingFuncletUnwinds(); 389 InstsInThisBlock.clear(); 390 DebugFnArgs.clear(); 391 LandingPadResultTy = nullptr; 392 SawFrameEscape = false; 393 SiblingFuncletInfo.clear(); 394 verifyNoAliasScopeDecl(); 395 NoAliasScopeDecls.clear(); 396 397 return !Broken; 398 } 399 400 /// Verify the module that this instance of \c Verifier was initialized with. 401 bool verify() { 402 Broken = false; 403 404 // Collect all declarations of the llvm.experimental.deoptimize intrinsic. 405 for (const Function &F : M) 406 if (F.getIntrinsicID() == Intrinsic::experimental_deoptimize) 407 DeoptimizeDeclarations.push_back(&F); 408 409 // Now that we've visited every function, verify that we never asked to 410 // recover a frame index that wasn't escaped. 411 verifyFrameRecoverIndices(); 412 for (const GlobalVariable &GV : M.globals()) 413 visitGlobalVariable(GV); 414 415 for (const GlobalAlias &GA : M.aliases()) 416 visitGlobalAlias(GA); 417 418 for (const NamedMDNode &NMD : M.named_metadata()) 419 visitNamedMDNode(NMD); 420 421 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable()) 422 visitComdat(SMEC.getValue()); 423 424 visitModuleFlags(M); 425 visitModuleIdents(M); 426 visitModuleCommandLines(M); 427 428 verifyCompileUnits(); 429 430 verifyDeoptimizeCallingConvs(); 431 DISubprogramAttachments.clear(); 432 return !Broken; 433 } 434 435 private: 436 /// Whether a metadata node is allowed to be, or contain, a DILocation. 437 enum class AreDebugLocsAllowed { No, Yes }; 438 439 // Verification methods... 440 void visitGlobalValue(const GlobalValue &GV); 441 void visitGlobalVariable(const GlobalVariable &GV); 442 void visitGlobalAlias(const GlobalAlias &GA); 443 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C); 444 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited, 445 const GlobalAlias &A, const Constant &C); 446 void visitNamedMDNode(const NamedMDNode &NMD); 447 void visitMDNode(const MDNode &MD, AreDebugLocsAllowed AllowLocs); 448 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F); 449 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F); 450 void visitComdat(const Comdat &C); 451 void visitModuleIdents(const Module &M); 452 void visitModuleCommandLines(const Module &M); 453 void visitModuleFlags(const Module &M); 454 void visitModuleFlag(const MDNode *Op, 455 DenseMap<const MDString *, const MDNode *> &SeenIDs, 456 SmallVectorImpl<const MDNode *> &Requirements); 457 void visitModuleFlagCGProfileEntry(const MDOperand &MDO); 458 void visitFunction(const Function &F); 459 void visitBasicBlock(BasicBlock &BB); 460 void visitRangeMetadata(Instruction &I, MDNode *Range, Type *Ty); 461 void visitDereferenceableMetadata(Instruction &I, MDNode *MD); 462 void visitProfMetadata(Instruction &I, MDNode *MD); 463 void visitAnnotationMetadata(MDNode *Annotation); 464 465 template <class Ty> bool isValidMetadataArray(const MDTuple &N); 466 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N); 467 #include "llvm/IR/Metadata.def" 468 void visitDIScope(const DIScope &N); 469 void visitDIVariable(const DIVariable &N); 470 void visitDILexicalBlockBase(const DILexicalBlockBase &N); 471 void visitDITemplateParameter(const DITemplateParameter &N); 472 473 void visitTemplateParams(const MDNode &N, const Metadata &RawParams); 474 475 // InstVisitor overrides... 476 using InstVisitor<Verifier>::visit; 477 void visit(Instruction &I); 478 479 void visitTruncInst(TruncInst &I); 480 void visitZExtInst(ZExtInst &I); 481 void visitSExtInst(SExtInst &I); 482 void visitFPTruncInst(FPTruncInst &I); 483 void visitFPExtInst(FPExtInst &I); 484 void visitFPToUIInst(FPToUIInst &I); 485 void visitFPToSIInst(FPToSIInst &I); 486 void visitUIToFPInst(UIToFPInst &I); 487 void visitSIToFPInst(SIToFPInst &I); 488 void visitIntToPtrInst(IntToPtrInst &I); 489 void visitPtrToIntInst(PtrToIntInst &I); 490 void visitBitCastInst(BitCastInst &I); 491 void visitAddrSpaceCastInst(AddrSpaceCastInst &I); 492 void visitPHINode(PHINode &PN); 493 void visitCallBase(CallBase &Call); 494 void visitUnaryOperator(UnaryOperator &U); 495 void visitBinaryOperator(BinaryOperator &B); 496 void visitICmpInst(ICmpInst &IC); 497 void visitFCmpInst(FCmpInst &FC); 498 void visitExtractElementInst(ExtractElementInst &EI); 499 void visitInsertElementInst(InsertElementInst &EI); 500 void visitShuffleVectorInst(ShuffleVectorInst &EI); 501 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); } 502 void visitCallInst(CallInst &CI); 503 void visitInvokeInst(InvokeInst &II); 504 void visitGetElementPtrInst(GetElementPtrInst &GEP); 505 void visitLoadInst(LoadInst &LI); 506 void visitStoreInst(StoreInst &SI); 507 void verifyDominatesUse(Instruction &I, unsigned i); 508 void visitInstruction(Instruction &I); 509 void visitTerminator(Instruction &I); 510 void visitBranchInst(BranchInst &BI); 511 void visitReturnInst(ReturnInst &RI); 512 void visitSwitchInst(SwitchInst &SI); 513 void visitIndirectBrInst(IndirectBrInst &BI); 514 void visitCallBrInst(CallBrInst &CBI); 515 void visitSelectInst(SelectInst &SI); 516 void visitUserOp1(Instruction &I); 517 void visitUserOp2(Instruction &I) { visitUserOp1(I); } 518 void visitIntrinsicCall(Intrinsic::ID ID, CallBase &Call); 519 void visitConstrainedFPIntrinsic(ConstrainedFPIntrinsic &FPI); 520 void visitDbgIntrinsic(StringRef Kind, DbgVariableIntrinsic &DII); 521 void visitDbgLabelIntrinsic(StringRef Kind, DbgLabelInst &DLI); 522 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI); 523 void visitAtomicRMWInst(AtomicRMWInst &RMWI); 524 void visitFenceInst(FenceInst &FI); 525 void visitAllocaInst(AllocaInst &AI); 526 void visitExtractValueInst(ExtractValueInst &EVI); 527 void visitInsertValueInst(InsertValueInst &IVI); 528 void visitEHPadPredecessors(Instruction &I); 529 void visitLandingPadInst(LandingPadInst &LPI); 530 void visitResumeInst(ResumeInst &RI); 531 void visitCatchPadInst(CatchPadInst &CPI); 532 void visitCatchReturnInst(CatchReturnInst &CatchReturn); 533 void visitCleanupPadInst(CleanupPadInst &CPI); 534 void visitFuncletPadInst(FuncletPadInst &FPI); 535 void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch); 536 void visitCleanupReturnInst(CleanupReturnInst &CRI); 537 538 void verifySwiftErrorCall(CallBase &Call, const Value *SwiftErrorVal); 539 void verifySwiftErrorValue(const Value *SwiftErrorVal); 540 void verifyTailCCMustTailAttrs(AttrBuilder Attrs, StringRef Context); 541 void verifyMustTailCall(CallInst &CI); 542 bool verifyAttributeCount(AttributeList Attrs, unsigned Params); 543 void verifyAttributeTypes(AttributeSet Attrs, const Value *V); 544 void verifyParameterAttrs(AttributeSet Attrs, Type *Ty, const Value *V); 545 void checkUnsignedBaseTenFuncAttr(AttributeList Attrs, StringRef Attr, 546 const Value *V); 547 void verifyFunctionAttrs(FunctionType *FT, AttributeList Attrs, 548 const Value *V, bool IsIntrinsic); 549 void verifyFunctionMetadata(ArrayRef<std::pair<unsigned, MDNode *>> MDs); 550 551 void visitConstantExprsRecursively(const Constant *EntryC); 552 void visitConstantExpr(const ConstantExpr *CE); 553 void verifyStatepoint(const CallBase &Call); 554 void verifyFrameRecoverIndices(); 555 void verifySiblingFuncletUnwinds(); 556 557 void verifyFragmentExpression(const DbgVariableIntrinsic &I); 558 template <typename ValueOrMetadata> 559 void verifyFragmentExpression(const DIVariable &V, 560 DIExpression::FragmentInfo Fragment, 561 ValueOrMetadata *Desc); 562 void verifyFnArgs(const DbgVariableIntrinsic &I); 563 void verifyNotEntryValue(const DbgVariableIntrinsic &I); 564 565 /// Module-level debug info verification... 566 void verifyCompileUnits(); 567 568 /// Module-level verification that all @llvm.experimental.deoptimize 569 /// declarations share the same calling convention. 570 void verifyDeoptimizeCallingConvs(); 571 572 /// Verify all-or-nothing property of DIFile source attribute within a CU. 573 void verifySourceDebugInfo(const DICompileUnit &U, const DIFile &F); 574 575 /// Verify the llvm.experimental.noalias.scope.decl declarations 576 void verifyNoAliasScopeDecl(); 577 }; 578 579 } // end anonymous namespace 580 581 /// We know that cond should be true, if not print an error message. 582 #define Assert(C, ...) \ 583 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (false) 584 585 /// We know that a debug info condition should be true, if not print 586 /// an error message. 587 #define AssertDI(C, ...) \ 588 do { if (!(C)) { DebugInfoCheckFailed(__VA_ARGS__); return; } } while (false) 589 590 void Verifier::visit(Instruction &I) { 591 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) 592 Assert(I.getOperand(i) != nullptr, "Operand is null", &I); 593 InstVisitor<Verifier>::visit(I); 594 } 595 596 // Helper to recursively iterate over indirect users. By 597 // returning false, the callback can ask to stop recursing 598 // further. 599 static void forEachUser(const Value *User, 600 SmallPtrSet<const Value *, 32> &Visited, 601 llvm::function_ref<bool(const Value *)> Callback) { 602 if (!Visited.insert(User).second) 603 return; 604 for (const Value *TheNextUser : User->materialized_users()) 605 if (Callback(TheNextUser)) 606 forEachUser(TheNextUser, Visited, Callback); 607 } 608 609 void Verifier::visitGlobalValue(const GlobalValue &GV) { 610 Assert(!GV.isDeclaration() || GV.hasValidDeclarationLinkage(), 611 "Global is external, but doesn't have external or weak linkage!", &GV); 612 613 if (const GlobalObject *GO = dyn_cast<GlobalObject>(&GV)) 614 Assert(GO->getAlignment() <= Value::MaximumAlignment, 615 "huge alignment values are unsupported", GO); 616 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV), 617 "Only global variables can have appending linkage!", &GV); 618 619 if (GV.hasAppendingLinkage()) { 620 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV); 621 Assert(GVar && GVar->getValueType()->isArrayTy(), 622 "Only global arrays can have appending linkage!", GVar); 623 } 624 625 if (GV.isDeclarationForLinker()) 626 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV); 627 628 if (GV.hasDLLImportStorageClass()) { 629 Assert(!GV.isDSOLocal(), 630 "GlobalValue with DLLImport Storage is dso_local!", &GV); 631 632 Assert((GV.isDeclaration() && 633 (GV.hasExternalLinkage() || GV.hasExternalWeakLinkage())) || 634 GV.hasAvailableExternallyLinkage(), 635 "Global is marked as dllimport, but not external", &GV); 636 } 637 638 if (GV.isImplicitDSOLocal()) 639 Assert(GV.isDSOLocal(), 640 "GlobalValue with local linkage or non-default " 641 "visibility must be dso_local!", 642 &GV); 643 644 forEachUser(&GV, GlobalValueVisited, [&](const Value *V) -> bool { 645 if (const Instruction *I = dyn_cast<Instruction>(V)) { 646 if (!I->getParent() || !I->getParent()->getParent()) 647 CheckFailed("Global is referenced by parentless instruction!", &GV, &M, 648 I); 649 else if (I->getParent()->getParent()->getParent() != &M) 650 CheckFailed("Global is referenced in a different module!", &GV, &M, I, 651 I->getParent()->getParent(), 652 I->getParent()->getParent()->getParent()); 653 return false; 654 } else if (const Function *F = dyn_cast<Function>(V)) { 655 if (F->getParent() != &M) 656 CheckFailed("Global is used by function in a different module", &GV, &M, 657 F, F->getParent()); 658 return false; 659 } 660 return true; 661 }); 662 } 663 664 void Verifier::visitGlobalVariable(const GlobalVariable &GV) { 665 if (GV.hasInitializer()) { 666 Assert(GV.getInitializer()->getType() == GV.getValueType(), 667 "Global variable initializer type does not match global " 668 "variable type!", 669 &GV); 670 // If the global has common linkage, it must have a zero initializer and 671 // cannot be constant. 672 if (GV.hasCommonLinkage()) { 673 Assert(GV.getInitializer()->isNullValue(), 674 "'common' global must have a zero initializer!", &GV); 675 Assert(!GV.isConstant(), "'common' global may not be marked constant!", 676 &GV); 677 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV); 678 } 679 } 680 681 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" || 682 GV.getName() == "llvm.global_dtors")) { 683 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(), 684 "invalid linkage for intrinsic global variable", &GV); 685 // Don't worry about emitting an error for it not being an array, 686 // visitGlobalValue will complain on appending non-array. 687 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) { 688 StructType *STy = dyn_cast<StructType>(ATy->getElementType()); 689 PointerType *FuncPtrTy = 690 FunctionType::get(Type::getVoidTy(Context), false)-> 691 getPointerTo(DL.getProgramAddressSpace()); 692 Assert(STy && 693 (STy->getNumElements() == 2 || STy->getNumElements() == 3) && 694 STy->getTypeAtIndex(0u)->isIntegerTy(32) && 695 STy->getTypeAtIndex(1) == FuncPtrTy, 696 "wrong type for intrinsic global variable", &GV); 697 Assert(STy->getNumElements() == 3, 698 "the third field of the element type is mandatory, " 699 "specify i8* null to migrate from the obsoleted 2-field form"); 700 Type *ETy = STy->getTypeAtIndex(2); 701 Type *Int8Ty = Type::getInt8Ty(ETy->getContext()); 702 Assert(ETy->isPointerTy() && 703 cast<PointerType>(ETy)->isOpaqueOrPointeeTypeMatches(Int8Ty), 704 "wrong type for intrinsic global variable", &GV); 705 } 706 } 707 708 if (GV.hasName() && (GV.getName() == "llvm.used" || 709 GV.getName() == "llvm.compiler.used")) { 710 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(), 711 "invalid linkage for intrinsic global variable", &GV); 712 Type *GVType = GV.getValueType(); 713 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) { 714 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType()); 715 Assert(PTy, "wrong type for intrinsic global variable", &GV); 716 if (GV.hasInitializer()) { 717 const Constant *Init = GV.getInitializer(); 718 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init); 719 Assert(InitArray, "wrong initalizer for intrinsic global variable", 720 Init); 721 for (Value *Op : InitArray->operands()) { 722 Value *V = Op->stripPointerCasts(); 723 Assert(isa<GlobalVariable>(V) || isa<Function>(V) || 724 isa<GlobalAlias>(V), 725 "invalid llvm.used member", V); 726 Assert(V->hasName(), "members of llvm.used must be named", V); 727 } 728 } 729 } 730 } 731 732 // Visit any debug info attachments. 733 SmallVector<MDNode *, 1> MDs; 734 GV.getMetadata(LLVMContext::MD_dbg, MDs); 735 for (auto *MD : MDs) { 736 if (auto *GVE = dyn_cast<DIGlobalVariableExpression>(MD)) 737 visitDIGlobalVariableExpression(*GVE); 738 else 739 AssertDI(false, "!dbg attachment of global variable must be a " 740 "DIGlobalVariableExpression"); 741 } 742 743 // Scalable vectors cannot be global variables, since we don't know 744 // the runtime size. If the global is an array containing scalable vectors, 745 // that will be caught by the isValidElementType methods in StructType or 746 // ArrayType instead. 747 Assert(!isa<ScalableVectorType>(GV.getValueType()), 748 "Globals cannot contain scalable vectors", &GV); 749 750 if (auto *STy = dyn_cast<StructType>(GV.getValueType())) 751 Assert(!STy->containsScalableVectorType(), 752 "Globals cannot contain scalable vectors", &GV); 753 754 if (!GV.hasInitializer()) { 755 visitGlobalValue(GV); 756 return; 757 } 758 759 // Walk any aggregate initializers looking for bitcasts between address spaces 760 visitConstantExprsRecursively(GV.getInitializer()); 761 762 visitGlobalValue(GV); 763 } 764 765 void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) { 766 SmallPtrSet<const GlobalAlias*, 4> Visited; 767 Visited.insert(&GA); 768 visitAliaseeSubExpr(Visited, GA, C); 769 } 770 771 void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited, 772 const GlobalAlias &GA, const Constant &C) { 773 if (const auto *GV = dyn_cast<GlobalValue>(&C)) { 774 Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition", 775 &GA); 776 777 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) { 778 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA); 779 780 Assert(!GA2->isInterposable(), "Alias cannot point to an interposable alias", 781 &GA); 782 } else { 783 // Only continue verifying subexpressions of GlobalAliases. 784 // Do not recurse into global initializers. 785 return; 786 } 787 } 788 789 if (const auto *CE = dyn_cast<ConstantExpr>(&C)) 790 visitConstantExprsRecursively(CE); 791 792 for (const Use &U : C.operands()) { 793 Value *V = &*U; 794 if (const auto *GA2 = dyn_cast<GlobalAlias>(V)) 795 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee()); 796 else if (const auto *C2 = dyn_cast<Constant>(V)) 797 visitAliaseeSubExpr(Visited, GA, *C2); 798 } 799 } 800 801 void Verifier::visitGlobalAlias(const GlobalAlias &GA) { 802 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()), 803 "Alias should have private, internal, linkonce, weak, linkonce_odr, " 804 "weak_odr, or external linkage!", 805 &GA); 806 const Constant *Aliasee = GA.getAliasee(); 807 Assert(Aliasee, "Aliasee cannot be NULL!", &GA); 808 Assert(GA.getType() == Aliasee->getType(), 809 "Alias and aliasee types should match!", &GA); 810 811 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee), 812 "Aliasee should be either GlobalValue or ConstantExpr", &GA); 813 814 visitAliaseeSubExpr(GA, *Aliasee); 815 816 visitGlobalValue(GA); 817 } 818 819 void Verifier::visitNamedMDNode(const NamedMDNode &NMD) { 820 // There used to be various other llvm.dbg.* nodes, but we don't support 821 // upgrading them and we want to reserve the namespace for future uses. 822 if (NMD.getName().startswith("llvm.dbg.")) 823 AssertDI(NMD.getName() == "llvm.dbg.cu", 824 "unrecognized named metadata node in the llvm.dbg namespace", 825 &NMD); 826 for (const MDNode *MD : NMD.operands()) { 827 if (NMD.getName() == "llvm.dbg.cu") 828 AssertDI(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD); 829 830 if (!MD) 831 continue; 832 833 visitMDNode(*MD, AreDebugLocsAllowed::Yes); 834 } 835 } 836 837 void Verifier::visitMDNode(const MDNode &MD, AreDebugLocsAllowed AllowLocs) { 838 // Only visit each node once. Metadata can be mutually recursive, so this 839 // avoids infinite recursion here, as well as being an optimization. 840 if (!MDNodes.insert(&MD).second) 841 return; 842 843 Assert(&MD.getContext() == &Context, 844 "MDNode context does not match Module context!", &MD); 845 846 switch (MD.getMetadataID()) { 847 default: 848 llvm_unreachable("Invalid MDNode subclass"); 849 case Metadata::MDTupleKind: 850 break; 851 #define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \ 852 case Metadata::CLASS##Kind: \ 853 visit##CLASS(cast<CLASS>(MD)); \ 854 break; 855 #include "llvm/IR/Metadata.def" 856 } 857 858 for (const Metadata *Op : MD.operands()) { 859 if (!Op) 860 continue; 861 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!", 862 &MD, Op); 863 AssertDI(!isa<DILocation>(Op) || AllowLocs == AreDebugLocsAllowed::Yes, 864 "DILocation not allowed within this metadata node", &MD, Op); 865 if (auto *N = dyn_cast<MDNode>(Op)) { 866 visitMDNode(*N, AllowLocs); 867 continue; 868 } 869 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) { 870 visitValueAsMetadata(*V, nullptr); 871 continue; 872 } 873 } 874 875 // Check these last, so we diagnose problems in operands first. 876 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD); 877 Assert(MD.isResolved(), "All nodes should be resolved!", &MD); 878 } 879 880 void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) { 881 Assert(MD.getValue(), "Expected valid value", &MD); 882 Assert(!MD.getValue()->getType()->isMetadataTy(), 883 "Unexpected metadata round-trip through values", &MD, MD.getValue()); 884 885 auto *L = dyn_cast<LocalAsMetadata>(&MD); 886 if (!L) 887 return; 888 889 Assert(F, "function-local metadata used outside a function", L); 890 891 // If this was an instruction, bb, or argument, verify that it is in the 892 // function that we expect. 893 Function *ActualF = nullptr; 894 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) { 895 Assert(I->getParent(), "function-local metadata not in basic block", L, I); 896 ActualF = I->getParent()->getParent(); 897 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue())) 898 ActualF = BB->getParent(); 899 else if (Argument *A = dyn_cast<Argument>(L->getValue())) 900 ActualF = A->getParent(); 901 assert(ActualF && "Unimplemented function local metadata case!"); 902 903 Assert(ActualF == F, "function-local metadata used in wrong function", L); 904 } 905 906 void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) { 907 Metadata *MD = MDV.getMetadata(); 908 if (auto *N = dyn_cast<MDNode>(MD)) { 909 visitMDNode(*N, AreDebugLocsAllowed::No); 910 return; 911 } 912 913 // Only visit each node once. Metadata can be mutually recursive, so this 914 // avoids infinite recursion here, as well as being an optimization. 915 if (!MDNodes.insert(MD).second) 916 return; 917 918 if (auto *V = dyn_cast<ValueAsMetadata>(MD)) 919 visitValueAsMetadata(*V, F); 920 } 921 922 static bool isType(const Metadata *MD) { return !MD || isa<DIType>(MD); } 923 static bool isScope(const Metadata *MD) { return !MD || isa<DIScope>(MD); } 924 static bool isDINode(const Metadata *MD) { return !MD || isa<DINode>(MD); } 925 926 void Verifier::visitDILocation(const DILocation &N) { 927 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()), 928 "location requires a valid scope", &N, N.getRawScope()); 929 if (auto *IA = N.getRawInlinedAt()) 930 AssertDI(isa<DILocation>(IA), "inlined-at should be a location", &N, IA); 931 if (auto *SP = dyn_cast<DISubprogram>(N.getRawScope())) 932 AssertDI(SP->isDefinition(), "scope points into the type hierarchy", &N); 933 } 934 935 void Verifier::visitGenericDINode(const GenericDINode &N) { 936 AssertDI(N.getTag(), "invalid tag", &N); 937 } 938 939 void Verifier::visitDIScope(const DIScope &N) { 940 if (auto *F = N.getRawFile()) 941 AssertDI(isa<DIFile>(F), "invalid file", &N, F); 942 } 943 944 void Verifier::visitDISubrange(const DISubrange &N) { 945 AssertDI(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N); 946 bool HasAssumedSizedArraySupport = dwarf::isFortran(CurrentSourceLang); 947 AssertDI(HasAssumedSizedArraySupport || N.getRawCountNode() || 948 N.getRawUpperBound(), 949 "Subrange must contain count or upperBound", &N); 950 AssertDI(!N.getRawCountNode() || !N.getRawUpperBound(), 951 "Subrange can have any one of count or upperBound", &N); 952 auto *CBound = N.getRawCountNode(); 953 AssertDI(!CBound || isa<ConstantAsMetadata>(CBound) || 954 isa<DIVariable>(CBound) || isa<DIExpression>(CBound), 955 "Count must be signed constant or DIVariable or DIExpression", &N); 956 auto Count = N.getCount(); 957 AssertDI(!Count || !Count.is<ConstantInt *>() || 958 Count.get<ConstantInt *>()->getSExtValue() >= -1, 959 "invalid subrange count", &N); 960 auto *LBound = N.getRawLowerBound(); 961 AssertDI(!LBound || isa<ConstantAsMetadata>(LBound) || 962 isa<DIVariable>(LBound) || isa<DIExpression>(LBound), 963 "LowerBound must be signed constant or DIVariable or DIExpression", 964 &N); 965 auto *UBound = N.getRawUpperBound(); 966 AssertDI(!UBound || isa<ConstantAsMetadata>(UBound) || 967 isa<DIVariable>(UBound) || isa<DIExpression>(UBound), 968 "UpperBound must be signed constant or DIVariable or DIExpression", 969 &N); 970 auto *Stride = N.getRawStride(); 971 AssertDI(!Stride || isa<ConstantAsMetadata>(Stride) || 972 isa<DIVariable>(Stride) || isa<DIExpression>(Stride), 973 "Stride must be signed constant or DIVariable or DIExpression", &N); 974 } 975 976 void Verifier::visitDIGenericSubrange(const DIGenericSubrange &N) { 977 AssertDI(N.getTag() == dwarf::DW_TAG_generic_subrange, "invalid tag", &N); 978 AssertDI(N.getRawCountNode() || N.getRawUpperBound(), 979 "GenericSubrange must contain count or upperBound", &N); 980 AssertDI(!N.getRawCountNode() || !N.getRawUpperBound(), 981 "GenericSubrange can have any one of count or upperBound", &N); 982 auto *CBound = N.getRawCountNode(); 983 AssertDI(!CBound || isa<DIVariable>(CBound) || isa<DIExpression>(CBound), 984 "Count must be signed constant or DIVariable or DIExpression", &N); 985 auto *LBound = N.getRawLowerBound(); 986 AssertDI(LBound, "GenericSubrange must contain lowerBound", &N); 987 AssertDI(isa<DIVariable>(LBound) || isa<DIExpression>(LBound), 988 "LowerBound must be signed constant or DIVariable or DIExpression", 989 &N); 990 auto *UBound = N.getRawUpperBound(); 991 AssertDI(!UBound || isa<DIVariable>(UBound) || isa<DIExpression>(UBound), 992 "UpperBound must be signed constant or DIVariable or DIExpression", 993 &N); 994 auto *Stride = N.getRawStride(); 995 AssertDI(Stride, "GenericSubrange must contain stride", &N); 996 AssertDI(isa<DIVariable>(Stride) || isa<DIExpression>(Stride), 997 "Stride must be signed constant or DIVariable or DIExpression", &N); 998 } 999 1000 void Verifier::visitDIEnumerator(const DIEnumerator &N) { 1001 AssertDI(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N); 1002 } 1003 1004 void Verifier::visitDIBasicType(const DIBasicType &N) { 1005 AssertDI(N.getTag() == dwarf::DW_TAG_base_type || 1006 N.getTag() == dwarf::DW_TAG_unspecified_type || 1007 N.getTag() == dwarf::DW_TAG_string_type, 1008 "invalid tag", &N); 1009 } 1010 1011 void Verifier::visitDIStringType(const DIStringType &N) { 1012 AssertDI(N.getTag() == dwarf::DW_TAG_string_type, "invalid tag", &N); 1013 AssertDI(!(N.isBigEndian() && N.isLittleEndian()) , 1014 "has conflicting flags", &N); 1015 } 1016 1017 void Verifier::visitDIDerivedType(const DIDerivedType &N) { 1018 // Common scope checks. 1019 visitDIScope(N); 1020 1021 AssertDI(N.getTag() == dwarf::DW_TAG_typedef || 1022 N.getTag() == dwarf::DW_TAG_pointer_type || 1023 N.getTag() == dwarf::DW_TAG_ptr_to_member_type || 1024 N.getTag() == dwarf::DW_TAG_reference_type || 1025 N.getTag() == dwarf::DW_TAG_rvalue_reference_type || 1026 N.getTag() == dwarf::DW_TAG_const_type || 1027 N.getTag() == dwarf::DW_TAG_volatile_type || 1028 N.getTag() == dwarf::DW_TAG_restrict_type || 1029 N.getTag() == dwarf::DW_TAG_atomic_type || 1030 N.getTag() == dwarf::DW_TAG_member || 1031 N.getTag() == dwarf::DW_TAG_inheritance || 1032 N.getTag() == dwarf::DW_TAG_friend || 1033 N.getTag() == dwarf::DW_TAG_set_type, 1034 "invalid tag", &N); 1035 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) { 1036 AssertDI(isType(N.getRawExtraData()), "invalid pointer to member type", &N, 1037 N.getRawExtraData()); 1038 } 1039 1040 if (N.getTag() == dwarf::DW_TAG_set_type) { 1041 if (auto *T = N.getRawBaseType()) { 1042 auto *Enum = dyn_cast_or_null<DICompositeType>(T); 1043 auto *Basic = dyn_cast_or_null<DIBasicType>(T); 1044 AssertDI( 1045 (Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type) || 1046 (Basic && (Basic->getEncoding() == dwarf::DW_ATE_unsigned || 1047 Basic->getEncoding() == dwarf::DW_ATE_signed || 1048 Basic->getEncoding() == dwarf::DW_ATE_unsigned_char || 1049 Basic->getEncoding() == dwarf::DW_ATE_signed_char || 1050 Basic->getEncoding() == dwarf::DW_ATE_boolean)), 1051 "invalid set base type", &N, T); 1052 } 1053 } 1054 1055 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope()); 1056 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N, 1057 N.getRawBaseType()); 1058 1059 if (N.getDWARFAddressSpace()) { 1060 AssertDI(N.getTag() == dwarf::DW_TAG_pointer_type || 1061 N.getTag() == dwarf::DW_TAG_reference_type || 1062 N.getTag() == dwarf::DW_TAG_rvalue_reference_type, 1063 "DWARF address space only applies to pointer or reference types", 1064 &N); 1065 } 1066 } 1067 1068 /// Detect mutually exclusive flags. 1069 static bool hasConflictingReferenceFlags(unsigned Flags) { 1070 return ((Flags & DINode::FlagLValueReference) && 1071 (Flags & DINode::FlagRValueReference)) || 1072 ((Flags & DINode::FlagTypePassByValue) && 1073 (Flags & DINode::FlagTypePassByReference)); 1074 } 1075 1076 void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) { 1077 auto *Params = dyn_cast<MDTuple>(&RawParams); 1078 AssertDI(Params, "invalid template params", &N, &RawParams); 1079 for (Metadata *Op : Params->operands()) { 1080 AssertDI(Op && isa<DITemplateParameter>(Op), "invalid template parameter", 1081 &N, Params, Op); 1082 } 1083 } 1084 1085 void Verifier::visitDICompositeType(const DICompositeType &N) { 1086 // Common scope checks. 1087 visitDIScope(N); 1088 1089 AssertDI(N.getTag() == dwarf::DW_TAG_array_type || 1090 N.getTag() == dwarf::DW_TAG_structure_type || 1091 N.getTag() == dwarf::DW_TAG_union_type || 1092 N.getTag() == dwarf::DW_TAG_enumeration_type || 1093 N.getTag() == dwarf::DW_TAG_class_type || 1094 N.getTag() == dwarf::DW_TAG_variant_part, 1095 "invalid tag", &N); 1096 1097 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope()); 1098 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N, 1099 N.getRawBaseType()); 1100 1101 AssertDI(!N.getRawElements() || isa<MDTuple>(N.getRawElements()), 1102 "invalid composite elements", &N, N.getRawElements()); 1103 AssertDI(isType(N.getRawVTableHolder()), "invalid vtable holder", &N, 1104 N.getRawVTableHolder()); 1105 AssertDI(!hasConflictingReferenceFlags(N.getFlags()), 1106 "invalid reference flags", &N); 1107 unsigned DIBlockByRefStruct = 1 << 4; 1108 AssertDI((N.getFlags() & DIBlockByRefStruct) == 0, 1109 "DIBlockByRefStruct on DICompositeType is no longer supported", &N); 1110 1111 if (N.isVector()) { 1112 const DINodeArray Elements = N.getElements(); 1113 AssertDI(Elements.size() == 1 && 1114 Elements[0]->getTag() == dwarf::DW_TAG_subrange_type, 1115 "invalid vector, expected one element of type subrange", &N); 1116 } 1117 1118 if (auto *Params = N.getRawTemplateParams()) 1119 visitTemplateParams(N, *Params); 1120 1121 if (auto *D = N.getRawDiscriminator()) { 1122 AssertDI(isa<DIDerivedType>(D) && N.getTag() == dwarf::DW_TAG_variant_part, 1123 "discriminator can only appear on variant part"); 1124 } 1125 1126 if (N.getRawDataLocation()) { 1127 AssertDI(N.getTag() == dwarf::DW_TAG_array_type, 1128 "dataLocation can only appear in array type"); 1129 } 1130 1131 if (N.getRawAssociated()) { 1132 AssertDI(N.getTag() == dwarf::DW_TAG_array_type, 1133 "associated can only appear in array type"); 1134 } 1135 1136 if (N.getRawAllocated()) { 1137 AssertDI(N.getTag() == dwarf::DW_TAG_array_type, 1138 "allocated can only appear in array type"); 1139 } 1140 1141 if (N.getRawRank()) { 1142 AssertDI(N.getTag() == dwarf::DW_TAG_array_type, 1143 "rank can only appear in array type"); 1144 } 1145 } 1146 1147 void Verifier::visitDISubroutineType(const DISubroutineType &N) { 1148 AssertDI(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N); 1149 if (auto *Types = N.getRawTypeArray()) { 1150 AssertDI(isa<MDTuple>(Types), "invalid composite elements", &N, Types); 1151 for (Metadata *Ty : N.getTypeArray()->operands()) { 1152 AssertDI(isType(Ty), "invalid subroutine type ref", &N, Types, Ty); 1153 } 1154 } 1155 AssertDI(!hasConflictingReferenceFlags(N.getFlags()), 1156 "invalid reference flags", &N); 1157 } 1158 1159 void Verifier::visitDIFile(const DIFile &N) { 1160 AssertDI(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N); 1161 Optional<DIFile::ChecksumInfo<StringRef>> Checksum = N.getChecksum(); 1162 if (Checksum) { 1163 AssertDI(Checksum->Kind <= DIFile::ChecksumKind::CSK_Last, 1164 "invalid checksum kind", &N); 1165 size_t Size; 1166 switch (Checksum->Kind) { 1167 case DIFile::CSK_MD5: 1168 Size = 32; 1169 break; 1170 case DIFile::CSK_SHA1: 1171 Size = 40; 1172 break; 1173 case DIFile::CSK_SHA256: 1174 Size = 64; 1175 break; 1176 } 1177 AssertDI(Checksum->Value.size() == Size, "invalid checksum length", &N); 1178 AssertDI(Checksum->Value.find_if_not(llvm::isHexDigit) == StringRef::npos, 1179 "invalid checksum", &N); 1180 } 1181 } 1182 1183 void Verifier::visitDICompileUnit(const DICompileUnit &N) { 1184 AssertDI(N.isDistinct(), "compile units must be distinct", &N); 1185 AssertDI(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N); 1186 1187 // Don't bother verifying the compilation directory or producer string 1188 // as those could be empty. 1189 AssertDI(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N, 1190 N.getRawFile()); 1191 AssertDI(!N.getFile()->getFilename().empty(), "invalid filename", &N, 1192 N.getFile()); 1193 1194 CurrentSourceLang = (dwarf::SourceLanguage)N.getSourceLanguage(); 1195 1196 verifySourceDebugInfo(N, *N.getFile()); 1197 1198 AssertDI((N.getEmissionKind() <= DICompileUnit::LastEmissionKind), 1199 "invalid emission kind", &N); 1200 1201 if (auto *Array = N.getRawEnumTypes()) { 1202 AssertDI(isa<MDTuple>(Array), "invalid enum list", &N, Array); 1203 for (Metadata *Op : N.getEnumTypes()->operands()) { 1204 auto *Enum = dyn_cast_or_null<DICompositeType>(Op); 1205 AssertDI(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type, 1206 "invalid enum type", &N, N.getEnumTypes(), Op); 1207 } 1208 } 1209 if (auto *Array = N.getRawRetainedTypes()) { 1210 AssertDI(isa<MDTuple>(Array), "invalid retained type list", &N, Array); 1211 for (Metadata *Op : N.getRetainedTypes()->operands()) { 1212 AssertDI(Op && (isa<DIType>(Op) || 1213 (isa<DISubprogram>(Op) && 1214 !cast<DISubprogram>(Op)->isDefinition())), 1215 "invalid retained type", &N, Op); 1216 } 1217 } 1218 if (auto *Array = N.getRawGlobalVariables()) { 1219 AssertDI(isa<MDTuple>(Array), "invalid global variable list", &N, Array); 1220 for (Metadata *Op : N.getGlobalVariables()->operands()) { 1221 AssertDI(Op && (isa<DIGlobalVariableExpression>(Op)), 1222 "invalid global variable ref", &N, Op); 1223 } 1224 } 1225 if (auto *Array = N.getRawImportedEntities()) { 1226 AssertDI(isa<MDTuple>(Array), "invalid imported entity list", &N, Array); 1227 for (Metadata *Op : N.getImportedEntities()->operands()) { 1228 AssertDI(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref", 1229 &N, Op); 1230 } 1231 } 1232 if (auto *Array = N.getRawMacros()) { 1233 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array); 1234 for (Metadata *Op : N.getMacros()->operands()) { 1235 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op); 1236 } 1237 } 1238 CUVisited.insert(&N); 1239 } 1240 1241 void Verifier::visitDISubprogram(const DISubprogram &N) { 1242 AssertDI(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N); 1243 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope()); 1244 if (auto *F = N.getRawFile()) 1245 AssertDI(isa<DIFile>(F), "invalid file", &N, F); 1246 else 1247 AssertDI(N.getLine() == 0, "line specified with no file", &N, N.getLine()); 1248 if (auto *T = N.getRawType()) 1249 AssertDI(isa<DISubroutineType>(T), "invalid subroutine type", &N, T); 1250 AssertDI(isType(N.getRawContainingType()), "invalid containing type", &N, 1251 N.getRawContainingType()); 1252 if (auto *Params = N.getRawTemplateParams()) 1253 visitTemplateParams(N, *Params); 1254 if (auto *S = N.getRawDeclaration()) 1255 AssertDI(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(), 1256 "invalid subprogram declaration", &N, S); 1257 if (auto *RawNode = N.getRawRetainedNodes()) { 1258 auto *Node = dyn_cast<MDTuple>(RawNode); 1259 AssertDI(Node, "invalid retained nodes list", &N, RawNode); 1260 for (Metadata *Op : Node->operands()) { 1261 AssertDI(Op && (isa<DILocalVariable>(Op) || isa<DILabel>(Op)), 1262 "invalid retained nodes, expected DILocalVariable or DILabel", 1263 &N, Node, Op); 1264 } 1265 } 1266 AssertDI(!hasConflictingReferenceFlags(N.getFlags()), 1267 "invalid reference flags", &N); 1268 1269 auto *Unit = N.getRawUnit(); 1270 if (N.isDefinition()) { 1271 // Subprogram definitions (not part of the type hierarchy). 1272 AssertDI(N.isDistinct(), "subprogram definitions must be distinct", &N); 1273 AssertDI(Unit, "subprogram definitions must have a compile unit", &N); 1274 AssertDI(isa<DICompileUnit>(Unit), "invalid unit type", &N, Unit); 1275 if (N.getFile()) 1276 verifySourceDebugInfo(*N.getUnit(), *N.getFile()); 1277 } else { 1278 // Subprogram declarations (part of the type hierarchy). 1279 AssertDI(!Unit, "subprogram declarations must not have a compile unit", &N); 1280 } 1281 1282 if (auto *RawThrownTypes = N.getRawThrownTypes()) { 1283 auto *ThrownTypes = dyn_cast<MDTuple>(RawThrownTypes); 1284 AssertDI(ThrownTypes, "invalid thrown types list", &N, RawThrownTypes); 1285 for (Metadata *Op : ThrownTypes->operands()) 1286 AssertDI(Op && isa<DIType>(Op), "invalid thrown type", &N, ThrownTypes, 1287 Op); 1288 } 1289 1290 if (N.areAllCallsDescribed()) 1291 AssertDI(N.isDefinition(), 1292 "DIFlagAllCallsDescribed must be attached to a definition"); 1293 } 1294 1295 void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) { 1296 AssertDI(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N); 1297 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()), 1298 "invalid local scope", &N, N.getRawScope()); 1299 if (auto *SP = dyn_cast<DISubprogram>(N.getRawScope())) 1300 AssertDI(SP->isDefinition(), "scope points into the type hierarchy", &N); 1301 } 1302 1303 void Verifier::visitDILexicalBlock(const DILexicalBlock &N) { 1304 visitDILexicalBlockBase(N); 1305 1306 AssertDI(N.getLine() || !N.getColumn(), 1307 "cannot have column info without line info", &N); 1308 } 1309 1310 void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) { 1311 visitDILexicalBlockBase(N); 1312 } 1313 1314 void Verifier::visitDICommonBlock(const DICommonBlock &N) { 1315 AssertDI(N.getTag() == dwarf::DW_TAG_common_block, "invalid tag", &N); 1316 if (auto *S = N.getRawScope()) 1317 AssertDI(isa<DIScope>(S), "invalid scope ref", &N, S); 1318 if (auto *S = N.getRawDecl()) 1319 AssertDI(isa<DIGlobalVariable>(S), "invalid declaration", &N, S); 1320 } 1321 1322 void Verifier::visitDINamespace(const DINamespace &N) { 1323 AssertDI(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N); 1324 if (auto *S = N.getRawScope()) 1325 AssertDI(isa<DIScope>(S), "invalid scope ref", &N, S); 1326 } 1327 1328 void Verifier::visitDIMacro(const DIMacro &N) { 1329 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_define || 1330 N.getMacinfoType() == dwarf::DW_MACINFO_undef, 1331 "invalid macinfo type", &N); 1332 AssertDI(!N.getName().empty(), "anonymous macro", &N); 1333 if (!N.getValue().empty()) { 1334 assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix"); 1335 } 1336 } 1337 1338 void Verifier::visitDIMacroFile(const DIMacroFile &N) { 1339 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_start_file, 1340 "invalid macinfo type", &N); 1341 if (auto *F = N.getRawFile()) 1342 AssertDI(isa<DIFile>(F), "invalid file", &N, F); 1343 1344 if (auto *Array = N.getRawElements()) { 1345 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array); 1346 for (Metadata *Op : N.getElements()->operands()) { 1347 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op); 1348 } 1349 } 1350 } 1351 1352 void Verifier::visitDIArgList(const DIArgList &N) { 1353 AssertDI(!N.getNumOperands(), 1354 "DIArgList should have no operands other than a list of " 1355 "ValueAsMetadata", 1356 &N); 1357 } 1358 1359 void Verifier::visitDIModule(const DIModule &N) { 1360 AssertDI(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N); 1361 AssertDI(!N.getName().empty(), "anonymous module", &N); 1362 } 1363 1364 void Verifier::visitDITemplateParameter(const DITemplateParameter &N) { 1365 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType()); 1366 } 1367 1368 void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) { 1369 visitDITemplateParameter(N); 1370 1371 AssertDI(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag", 1372 &N); 1373 } 1374 1375 void Verifier::visitDITemplateValueParameter( 1376 const DITemplateValueParameter &N) { 1377 visitDITemplateParameter(N); 1378 1379 AssertDI(N.getTag() == dwarf::DW_TAG_template_value_parameter || 1380 N.getTag() == dwarf::DW_TAG_GNU_template_template_param || 1381 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack, 1382 "invalid tag", &N); 1383 } 1384 1385 void Verifier::visitDIVariable(const DIVariable &N) { 1386 if (auto *S = N.getRawScope()) 1387 AssertDI(isa<DIScope>(S), "invalid scope", &N, S); 1388 if (auto *F = N.getRawFile()) 1389 AssertDI(isa<DIFile>(F), "invalid file", &N, F); 1390 } 1391 1392 void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) { 1393 // Checks common to all variables. 1394 visitDIVariable(N); 1395 1396 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N); 1397 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType()); 1398 // Assert only if the global variable is not an extern 1399 if (N.isDefinition()) 1400 AssertDI(N.getType(), "missing global variable type", &N); 1401 if (auto *Member = N.getRawStaticDataMemberDeclaration()) { 1402 AssertDI(isa<DIDerivedType>(Member), 1403 "invalid static data member declaration", &N, Member); 1404 } 1405 } 1406 1407 void Verifier::visitDILocalVariable(const DILocalVariable &N) { 1408 // Checks common to all variables. 1409 visitDIVariable(N); 1410 1411 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType()); 1412 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N); 1413 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()), 1414 "local variable requires a valid scope", &N, N.getRawScope()); 1415 if (auto Ty = N.getType()) 1416 AssertDI(!isa<DISubroutineType>(Ty), "invalid type", &N, N.getType()); 1417 } 1418 1419 void Verifier::visitDILabel(const DILabel &N) { 1420 if (auto *S = N.getRawScope()) 1421 AssertDI(isa<DIScope>(S), "invalid scope", &N, S); 1422 if (auto *F = N.getRawFile()) 1423 AssertDI(isa<DIFile>(F), "invalid file", &N, F); 1424 1425 AssertDI(N.getTag() == dwarf::DW_TAG_label, "invalid tag", &N); 1426 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()), 1427 "label requires a valid scope", &N, N.getRawScope()); 1428 } 1429 1430 void Verifier::visitDIExpression(const DIExpression &N) { 1431 AssertDI(N.isValid(), "invalid expression", &N); 1432 } 1433 1434 void Verifier::visitDIGlobalVariableExpression( 1435 const DIGlobalVariableExpression &GVE) { 1436 AssertDI(GVE.getVariable(), "missing variable"); 1437 if (auto *Var = GVE.getVariable()) 1438 visitDIGlobalVariable(*Var); 1439 if (auto *Expr = GVE.getExpression()) { 1440 visitDIExpression(*Expr); 1441 if (auto Fragment = Expr->getFragmentInfo()) 1442 verifyFragmentExpression(*GVE.getVariable(), *Fragment, &GVE); 1443 } 1444 } 1445 1446 void Verifier::visitDIObjCProperty(const DIObjCProperty &N) { 1447 AssertDI(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N); 1448 if (auto *T = N.getRawType()) 1449 AssertDI(isType(T), "invalid type ref", &N, T); 1450 if (auto *F = N.getRawFile()) 1451 AssertDI(isa<DIFile>(F), "invalid file", &N, F); 1452 } 1453 1454 void Verifier::visitDIImportedEntity(const DIImportedEntity &N) { 1455 AssertDI(N.getTag() == dwarf::DW_TAG_imported_module || 1456 N.getTag() == dwarf::DW_TAG_imported_declaration, 1457 "invalid tag", &N); 1458 if (auto *S = N.getRawScope()) 1459 AssertDI(isa<DIScope>(S), "invalid scope for imported entity", &N, S); 1460 AssertDI(isDINode(N.getRawEntity()), "invalid imported entity", &N, 1461 N.getRawEntity()); 1462 } 1463 1464 void Verifier::visitComdat(const Comdat &C) { 1465 // In COFF the Module is invalid if the GlobalValue has private linkage. 1466 // Entities with private linkage don't have entries in the symbol table. 1467 if (TT.isOSBinFormatCOFF()) 1468 if (const GlobalValue *GV = M.getNamedValue(C.getName())) 1469 Assert(!GV->hasPrivateLinkage(), 1470 "comdat global value has private linkage", GV); 1471 } 1472 1473 void Verifier::visitModuleIdents(const Module &M) { 1474 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident"); 1475 if (!Idents) 1476 return; 1477 1478 // llvm.ident takes a list of metadata entry. Each entry has only one string. 1479 // Scan each llvm.ident entry and make sure that this requirement is met. 1480 for (const MDNode *N : Idents->operands()) { 1481 Assert(N->getNumOperands() == 1, 1482 "incorrect number of operands in llvm.ident metadata", N); 1483 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)), 1484 ("invalid value for llvm.ident metadata entry operand" 1485 "(the operand should be a string)"), 1486 N->getOperand(0)); 1487 } 1488 } 1489 1490 void Verifier::visitModuleCommandLines(const Module &M) { 1491 const NamedMDNode *CommandLines = M.getNamedMetadata("llvm.commandline"); 1492 if (!CommandLines) 1493 return; 1494 1495 // llvm.commandline takes a list of metadata entry. Each entry has only one 1496 // string. Scan each llvm.commandline entry and make sure that this 1497 // requirement is met. 1498 for (const MDNode *N : CommandLines->operands()) { 1499 Assert(N->getNumOperands() == 1, 1500 "incorrect number of operands in llvm.commandline metadata", N); 1501 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)), 1502 ("invalid value for llvm.commandline metadata entry operand" 1503 "(the operand should be a string)"), 1504 N->getOperand(0)); 1505 } 1506 } 1507 1508 void Verifier::visitModuleFlags(const Module &M) { 1509 const NamedMDNode *Flags = M.getModuleFlagsMetadata(); 1510 if (!Flags) return; 1511 1512 // Scan each flag, and track the flags and requirements. 1513 DenseMap<const MDString*, const MDNode*> SeenIDs; 1514 SmallVector<const MDNode*, 16> Requirements; 1515 for (const MDNode *MDN : Flags->operands()) 1516 visitModuleFlag(MDN, SeenIDs, Requirements); 1517 1518 // Validate that the requirements in the module are valid. 1519 for (const MDNode *Requirement : Requirements) { 1520 const MDString *Flag = cast<MDString>(Requirement->getOperand(0)); 1521 const Metadata *ReqValue = Requirement->getOperand(1); 1522 1523 const MDNode *Op = SeenIDs.lookup(Flag); 1524 if (!Op) { 1525 CheckFailed("invalid requirement on flag, flag is not present in module", 1526 Flag); 1527 continue; 1528 } 1529 1530 if (Op->getOperand(2) != ReqValue) { 1531 CheckFailed(("invalid requirement on flag, " 1532 "flag does not have the required value"), 1533 Flag); 1534 continue; 1535 } 1536 } 1537 } 1538 1539 void 1540 Verifier::visitModuleFlag(const MDNode *Op, 1541 DenseMap<const MDString *, const MDNode *> &SeenIDs, 1542 SmallVectorImpl<const MDNode *> &Requirements) { 1543 // Each module flag should have three arguments, the merge behavior (a 1544 // constant int), the flag ID (an MDString), and the value. 1545 Assert(Op->getNumOperands() == 3, 1546 "incorrect number of operands in module flag", Op); 1547 Module::ModFlagBehavior MFB; 1548 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) { 1549 Assert( 1550 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)), 1551 "invalid behavior operand in module flag (expected constant integer)", 1552 Op->getOperand(0)); 1553 Assert(false, 1554 "invalid behavior operand in module flag (unexpected constant)", 1555 Op->getOperand(0)); 1556 } 1557 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1)); 1558 Assert(ID, "invalid ID operand in module flag (expected metadata string)", 1559 Op->getOperand(1)); 1560 1561 // Sanity check the values for behaviors with additional requirements. 1562 switch (MFB) { 1563 case Module::Error: 1564 case Module::Warning: 1565 case Module::Override: 1566 // These behavior types accept any value. 1567 break; 1568 1569 case Module::Max: { 1570 Assert(mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(2)), 1571 "invalid value for 'max' module flag (expected constant integer)", 1572 Op->getOperand(2)); 1573 break; 1574 } 1575 1576 case Module::Require: { 1577 // The value should itself be an MDNode with two operands, a flag ID (an 1578 // MDString), and a value. 1579 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2)); 1580 Assert(Value && Value->getNumOperands() == 2, 1581 "invalid value for 'require' module flag (expected metadata pair)", 1582 Op->getOperand(2)); 1583 Assert(isa<MDString>(Value->getOperand(0)), 1584 ("invalid value for 'require' module flag " 1585 "(first value operand should be a string)"), 1586 Value->getOperand(0)); 1587 1588 // Append it to the list of requirements, to check once all module flags are 1589 // scanned. 1590 Requirements.push_back(Value); 1591 break; 1592 } 1593 1594 case Module::Append: 1595 case Module::AppendUnique: { 1596 // These behavior types require the operand be an MDNode. 1597 Assert(isa<MDNode>(Op->getOperand(2)), 1598 "invalid value for 'append'-type module flag " 1599 "(expected a metadata node)", 1600 Op->getOperand(2)); 1601 break; 1602 } 1603 } 1604 1605 // Unless this is a "requires" flag, check the ID is unique. 1606 if (MFB != Module::Require) { 1607 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second; 1608 Assert(Inserted, 1609 "module flag identifiers must be unique (or of 'require' type)", ID); 1610 } 1611 1612 if (ID->getString() == "wchar_size") { 1613 ConstantInt *Value 1614 = mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(2)); 1615 Assert(Value, "wchar_size metadata requires constant integer argument"); 1616 } 1617 1618 if (ID->getString() == "Linker Options") { 1619 // If the llvm.linker.options named metadata exists, we assume that the 1620 // bitcode reader has upgraded the module flag. Otherwise the flag might 1621 // have been created by a client directly. 1622 Assert(M.getNamedMetadata("llvm.linker.options"), 1623 "'Linker Options' named metadata no longer supported"); 1624 } 1625 1626 if (ID->getString() == "SemanticInterposition") { 1627 ConstantInt *Value = 1628 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(2)); 1629 Assert(Value, 1630 "SemanticInterposition metadata requires constant integer argument"); 1631 } 1632 1633 if (ID->getString() == "CG Profile") { 1634 for (const MDOperand &MDO : cast<MDNode>(Op->getOperand(2))->operands()) 1635 visitModuleFlagCGProfileEntry(MDO); 1636 } 1637 } 1638 1639 void Verifier::visitModuleFlagCGProfileEntry(const MDOperand &MDO) { 1640 auto CheckFunction = [&](const MDOperand &FuncMDO) { 1641 if (!FuncMDO) 1642 return; 1643 auto F = dyn_cast<ValueAsMetadata>(FuncMDO); 1644 Assert(F && isa<Function>(F->getValue()->stripPointerCasts()), 1645 "expected a Function or null", FuncMDO); 1646 }; 1647 auto Node = dyn_cast_or_null<MDNode>(MDO); 1648 Assert(Node && Node->getNumOperands() == 3, "expected a MDNode triple", MDO); 1649 CheckFunction(Node->getOperand(0)); 1650 CheckFunction(Node->getOperand(1)); 1651 auto Count = dyn_cast_or_null<ConstantAsMetadata>(Node->getOperand(2)); 1652 Assert(Count && Count->getType()->isIntegerTy(), 1653 "expected an integer constant", Node->getOperand(2)); 1654 } 1655 1656 void Verifier::verifyAttributeTypes(AttributeSet Attrs, const Value *V) { 1657 for (Attribute A : Attrs) { 1658 1659 if (A.isStringAttribute()) { 1660 #define GET_ATTR_NAMES 1661 #define ATTRIBUTE_ENUM(ENUM_NAME, DISPLAY_NAME) 1662 #define ATTRIBUTE_STRBOOL(ENUM_NAME, DISPLAY_NAME) \ 1663 if (A.getKindAsString() == #DISPLAY_NAME) { \ 1664 auto V = A.getValueAsString(); \ 1665 if (!(V.empty() || V == "true" || V == "false")) \ 1666 CheckFailed("invalid value for '" #DISPLAY_NAME "' attribute: " + V + \ 1667 ""); \ 1668 } 1669 1670 #include "llvm/IR/Attributes.inc" 1671 continue; 1672 } 1673 1674 if (A.isIntAttribute() != Attribute::isIntAttrKind(A.getKindAsEnum())) { 1675 CheckFailed("Attribute '" + A.getAsString() + "' should have an Argument", 1676 V); 1677 return; 1678 } 1679 } 1680 } 1681 1682 // VerifyParameterAttrs - Check the given attributes for an argument or return 1683 // value of the specified type. The value V is printed in error messages. 1684 void Verifier::verifyParameterAttrs(AttributeSet Attrs, Type *Ty, 1685 const Value *V) { 1686 if (!Attrs.hasAttributes()) 1687 return; 1688 1689 verifyAttributeTypes(Attrs, V); 1690 1691 for (Attribute Attr : Attrs) 1692 Assert(Attr.isStringAttribute() || 1693 Attribute::canUseAsParamAttr(Attr.getKindAsEnum()), 1694 "Attribute '" + Attr.getAsString() + 1695 "' does not apply to parameters", 1696 V); 1697 1698 if (Attrs.hasAttribute(Attribute::ImmArg)) { 1699 Assert(Attrs.getNumAttributes() == 1, 1700 "Attribute 'immarg' is incompatible with other attributes", V); 1701 } 1702 1703 // Check for mutually incompatible attributes. Only inreg is compatible with 1704 // sret. 1705 unsigned AttrCount = 0; 1706 AttrCount += Attrs.hasAttribute(Attribute::ByVal); 1707 AttrCount += Attrs.hasAttribute(Attribute::InAlloca); 1708 AttrCount += Attrs.hasAttribute(Attribute::Preallocated); 1709 AttrCount += Attrs.hasAttribute(Attribute::StructRet) || 1710 Attrs.hasAttribute(Attribute::InReg); 1711 AttrCount += Attrs.hasAttribute(Attribute::Nest); 1712 AttrCount += Attrs.hasAttribute(Attribute::ByRef); 1713 Assert(AttrCount <= 1, 1714 "Attributes 'byval', 'inalloca', 'preallocated', 'inreg', 'nest', " 1715 "'byref', and 'sret' are incompatible!", 1716 V); 1717 1718 Assert(!(Attrs.hasAttribute(Attribute::InAlloca) && 1719 Attrs.hasAttribute(Attribute::ReadOnly)), 1720 "Attributes " 1721 "'inalloca and readonly' are incompatible!", 1722 V); 1723 1724 Assert(!(Attrs.hasAttribute(Attribute::StructRet) && 1725 Attrs.hasAttribute(Attribute::Returned)), 1726 "Attributes " 1727 "'sret and returned' are incompatible!", 1728 V); 1729 1730 Assert(!(Attrs.hasAttribute(Attribute::ZExt) && 1731 Attrs.hasAttribute(Attribute::SExt)), 1732 "Attributes " 1733 "'zeroext and signext' are incompatible!", 1734 V); 1735 1736 Assert(!(Attrs.hasAttribute(Attribute::ReadNone) && 1737 Attrs.hasAttribute(Attribute::ReadOnly)), 1738 "Attributes " 1739 "'readnone and readonly' are incompatible!", 1740 V); 1741 1742 Assert(!(Attrs.hasAttribute(Attribute::ReadNone) && 1743 Attrs.hasAttribute(Attribute::WriteOnly)), 1744 "Attributes " 1745 "'readnone and writeonly' are incompatible!", 1746 V); 1747 1748 Assert(!(Attrs.hasAttribute(Attribute::ReadOnly) && 1749 Attrs.hasAttribute(Attribute::WriteOnly)), 1750 "Attributes " 1751 "'readonly and writeonly' are incompatible!", 1752 V); 1753 1754 Assert(!(Attrs.hasAttribute(Attribute::NoInline) && 1755 Attrs.hasAttribute(Attribute::AlwaysInline)), 1756 "Attributes " 1757 "'noinline and alwaysinline' are incompatible!", 1758 V); 1759 1760 AttrBuilder IncompatibleAttrs = AttributeFuncs::typeIncompatible(Ty); 1761 for (Attribute Attr : Attrs) { 1762 if (!Attr.isStringAttribute() && 1763 IncompatibleAttrs.contains(Attr.getKindAsEnum())) { 1764 CheckFailed("Attribute '" + Attr.getAsString() + 1765 "' applied to incompatible type!", V); 1766 return; 1767 } 1768 } 1769 1770 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) { 1771 if (Attrs.hasAttribute(Attribute::ByVal)) { 1772 SmallPtrSet<Type *, 4> Visited; 1773 Assert(Attrs.getByValType()->isSized(&Visited), 1774 "Attribute 'byval' does not support unsized types!", V); 1775 } 1776 if (Attrs.hasAttribute(Attribute::ByRef)) { 1777 SmallPtrSet<Type *, 4> Visited; 1778 Assert(Attrs.getByRefType()->isSized(&Visited), 1779 "Attribute 'byref' does not support unsized types!", V); 1780 } 1781 if (Attrs.hasAttribute(Attribute::InAlloca)) { 1782 SmallPtrSet<Type *, 4> Visited; 1783 Assert(Attrs.getInAllocaType()->isSized(&Visited), 1784 "Attribute 'inalloca' does not support unsized types!", V); 1785 } 1786 if (Attrs.hasAttribute(Attribute::Preallocated)) { 1787 SmallPtrSet<Type *, 4> Visited; 1788 Assert(Attrs.getPreallocatedType()->isSized(&Visited), 1789 "Attribute 'preallocated' does not support unsized types!", V); 1790 } 1791 if (!PTy->isOpaque()) { 1792 if (!isa<PointerType>(PTy->getElementType())) 1793 Assert(!Attrs.hasAttribute(Attribute::SwiftError), 1794 "Attribute 'swifterror' only applies to parameters " 1795 "with pointer to pointer type!", 1796 V); 1797 if (Attrs.hasAttribute(Attribute::ByRef)) { 1798 Assert(Attrs.getByRefType() == PTy->getElementType(), 1799 "Attribute 'byref' type does not match parameter!", V); 1800 } 1801 1802 if (Attrs.hasAttribute(Attribute::ByVal) && Attrs.getByValType()) { 1803 Assert(Attrs.getByValType() == PTy->getElementType(), 1804 "Attribute 'byval' type does not match parameter!", V); 1805 } 1806 1807 if (Attrs.hasAttribute(Attribute::Preallocated)) { 1808 Assert(Attrs.getPreallocatedType() == PTy->getElementType(), 1809 "Attribute 'preallocated' type does not match parameter!", V); 1810 } 1811 1812 if (Attrs.hasAttribute(Attribute::InAlloca)) { 1813 Assert(Attrs.getInAllocaType() == PTy->getElementType(), 1814 "Attribute 'inalloca' type does not match parameter!", V); 1815 } 1816 1817 if (Attrs.hasAttribute(Attribute::ElementType)) { 1818 Assert(Attrs.getElementType() == PTy->getElementType(), 1819 "Attribute 'elementtype' type does not match parameter!", V); 1820 } 1821 } 1822 } 1823 } 1824 1825 void Verifier::checkUnsignedBaseTenFuncAttr(AttributeList Attrs, StringRef Attr, 1826 const Value *V) { 1827 if (Attrs.hasFnAttribute(Attr)) { 1828 StringRef S = Attrs.getAttribute(AttributeList::FunctionIndex, Attr) 1829 .getValueAsString(); 1830 unsigned N; 1831 if (S.getAsInteger(10, N)) 1832 CheckFailed("\"" + Attr + "\" takes an unsigned integer: " + S, V); 1833 } 1834 } 1835 1836 // Check parameter attributes against a function type. 1837 // The value V is printed in error messages. 1838 void Verifier::verifyFunctionAttrs(FunctionType *FT, AttributeList Attrs, 1839 const Value *V, bool IsIntrinsic) { 1840 if (Attrs.isEmpty()) 1841 return; 1842 1843 if (AttributeListsVisited.insert(Attrs.getRawPointer()).second) { 1844 Assert(Attrs.hasParentContext(Context), 1845 "Attribute list does not match Module context!", &Attrs, V); 1846 for (const auto &AttrSet : Attrs) { 1847 Assert(!AttrSet.hasAttributes() || AttrSet.hasParentContext(Context), 1848 "Attribute set does not match Module context!", &AttrSet, V); 1849 for (const auto &A : AttrSet) { 1850 Assert(A.hasParentContext(Context), 1851 "Attribute does not match Module context!", &A, V); 1852 } 1853 } 1854 } 1855 1856 bool SawNest = false; 1857 bool SawReturned = false; 1858 bool SawSRet = false; 1859 bool SawSwiftSelf = false; 1860 bool SawSwiftAsync = false; 1861 bool SawSwiftError = false; 1862 1863 // Verify return value attributes. 1864 AttributeSet RetAttrs = Attrs.getRetAttributes(); 1865 for (Attribute RetAttr : RetAttrs) 1866 Assert(RetAttr.isStringAttribute() || 1867 Attribute::canUseAsRetAttr(RetAttr.getKindAsEnum()), 1868 "Attribute '" + RetAttr.getAsString() + 1869 "' does not apply to function return values", 1870 V); 1871 1872 verifyParameterAttrs(RetAttrs, FT->getReturnType(), V); 1873 1874 // Verify parameter attributes. 1875 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) { 1876 Type *Ty = FT->getParamType(i); 1877 AttributeSet ArgAttrs = Attrs.getParamAttributes(i); 1878 1879 if (!IsIntrinsic) { 1880 Assert(!ArgAttrs.hasAttribute(Attribute::ImmArg), 1881 "immarg attribute only applies to intrinsics",V); 1882 Assert(!ArgAttrs.hasAttribute(Attribute::ElementType), 1883 "Attribute 'elementtype' can only be applied to intrinsics.", V); 1884 } 1885 1886 verifyParameterAttrs(ArgAttrs, Ty, V); 1887 1888 if (ArgAttrs.hasAttribute(Attribute::Nest)) { 1889 Assert(!SawNest, "More than one parameter has attribute nest!", V); 1890 SawNest = true; 1891 } 1892 1893 if (ArgAttrs.hasAttribute(Attribute::Returned)) { 1894 Assert(!SawReturned, "More than one parameter has attribute returned!", 1895 V); 1896 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()), 1897 "Incompatible argument and return types for 'returned' attribute", 1898 V); 1899 SawReturned = true; 1900 } 1901 1902 if (ArgAttrs.hasAttribute(Attribute::StructRet)) { 1903 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V); 1904 Assert(i == 0 || i == 1, 1905 "Attribute 'sret' is not on first or second parameter!", V); 1906 SawSRet = true; 1907 } 1908 1909 if (ArgAttrs.hasAttribute(Attribute::SwiftSelf)) { 1910 Assert(!SawSwiftSelf, "Cannot have multiple 'swiftself' parameters!", V); 1911 SawSwiftSelf = true; 1912 } 1913 1914 if (ArgAttrs.hasAttribute(Attribute::SwiftAsync)) { 1915 Assert(!SawSwiftAsync, "Cannot have multiple 'swiftasync' parameters!", V); 1916 SawSwiftAsync = true; 1917 } 1918 1919 if (ArgAttrs.hasAttribute(Attribute::SwiftError)) { 1920 Assert(!SawSwiftError, "Cannot have multiple 'swifterror' parameters!", 1921 V); 1922 SawSwiftError = true; 1923 } 1924 1925 if (ArgAttrs.hasAttribute(Attribute::InAlloca)) { 1926 Assert(i == FT->getNumParams() - 1, 1927 "inalloca isn't on the last parameter!", V); 1928 } 1929 } 1930 1931 if (!Attrs.hasAttributes(AttributeList::FunctionIndex)) 1932 return; 1933 1934 verifyAttributeTypes(Attrs.getFnAttributes(), V); 1935 for (Attribute FnAttr : Attrs.getFnAttributes()) 1936 Assert(FnAttr.isStringAttribute() || 1937 Attribute::canUseAsFnAttr(FnAttr.getKindAsEnum()), 1938 "Attribute '" + FnAttr.getAsString() + 1939 "' does not apply to functions!", 1940 V); 1941 1942 Assert(!(Attrs.hasFnAttribute(Attribute::ReadNone) && 1943 Attrs.hasFnAttribute(Attribute::ReadOnly)), 1944 "Attributes 'readnone and readonly' are incompatible!", V); 1945 1946 Assert(!(Attrs.hasFnAttribute(Attribute::ReadNone) && 1947 Attrs.hasFnAttribute(Attribute::WriteOnly)), 1948 "Attributes 'readnone and writeonly' are incompatible!", V); 1949 1950 Assert(!(Attrs.hasFnAttribute(Attribute::ReadOnly) && 1951 Attrs.hasFnAttribute(Attribute::WriteOnly)), 1952 "Attributes 'readonly and writeonly' are incompatible!", V); 1953 1954 Assert(!(Attrs.hasFnAttribute(Attribute::ReadNone) && 1955 Attrs.hasFnAttribute(Attribute::InaccessibleMemOrArgMemOnly)), 1956 "Attributes 'readnone and inaccessiblemem_or_argmemonly' are " 1957 "incompatible!", 1958 V); 1959 1960 Assert(!(Attrs.hasFnAttribute(Attribute::ReadNone) && 1961 Attrs.hasFnAttribute(Attribute::InaccessibleMemOnly)), 1962 "Attributes 'readnone and inaccessiblememonly' are incompatible!", V); 1963 1964 Assert(!(Attrs.hasFnAttribute(Attribute::NoInline) && 1965 Attrs.hasFnAttribute(Attribute::AlwaysInline)), 1966 "Attributes 'noinline and alwaysinline' are incompatible!", V); 1967 1968 if (Attrs.hasFnAttribute(Attribute::OptimizeNone)) { 1969 Assert(Attrs.hasFnAttribute(Attribute::NoInline), 1970 "Attribute 'optnone' requires 'noinline'!", V); 1971 1972 Assert(!Attrs.hasFnAttribute(Attribute::OptimizeForSize), 1973 "Attributes 'optsize and optnone' are incompatible!", V); 1974 1975 Assert(!Attrs.hasFnAttribute(Attribute::MinSize), 1976 "Attributes 'minsize and optnone' are incompatible!", V); 1977 } 1978 1979 if (Attrs.hasFnAttribute(Attribute::JumpTable)) { 1980 const GlobalValue *GV = cast<GlobalValue>(V); 1981 Assert(GV->hasGlobalUnnamedAddr(), 1982 "Attribute 'jumptable' requires 'unnamed_addr'", V); 1983 } 1984 1985 if (Attrs.hasFnAttribute(Attribute::AllocSize)) { 1986 std::pair<unsigned, Optional<unsigned>> Args = 1987 Attrs.getAllocSizeArgs(AttributeList::FunctionIndex); 1988 1989 auto CheckParam = [&](StringRef Name, unsigned ParamNo) { 1990 if (ParamNo >= FT->getNumParams()) { 1991 CheckFailed("'allocsize' " + Name + " argument is out of bounds", V); 1992 return false; 1993 } 1994 1995 if (!FT->getParamType(ParamNo)->isIntegerTy()) { 1996 CheckFailed("'allocsize' " + Name + 1997 " argument must refer to an integer parameter", 1998 V); 1999 return false; 2000 } 2001 2002 return true; 2003 }; 2004 2005 if (!CheckParam("element size", Args.first)) 2006 return; 2007 2008 if (Args.second && !CheckParam("number of elements", *Args.second)) 2009 return; 2010 } 2011 2012 if (Attrs.hasFnAttribute(Attribute::VScaleRange)) { 2013 std::pair<unsigned, unsigned> Args = 2014 Attrs.getVScaleRangeArgs(AttributeList::FunctionIndex); 2015 2016 if (Args.first > Args.second && Args.second != 0) 2017 CheckFailed("'vscale_range' minimum cannot be greater than maximum", V); 2018 } 2019 2020 if (Attrs.hasFnAttribute("frame-pointer")) { 2021 StringRef FP = Attrs.getAttribute(AttributeList::FunctionIndex, 2022 "frame-pointer").getValueAsString(); 2023 if (FP != "all" && FP != "non-leaf" && FP != "none") 2024 CheckFailed("invalid value for 'frame-pointer' attribute: " + FP, V); 2025 } 2026 2027 checkUnsignedBaseTenFuncAttr(Attrs, "patchable-function-prefix", V); 2028 checkUnsignedBaseTenFuncAttr(Attrs, "patchable-function-entry", V); 2029 checkUnsignedBaseTenFuncAttr(Attrs, "warn-stack-size", V); 2030 } 2031 2032 void Verifier::verifyFunctionMetadata( 2033 ArrayRef<std::pair<unsigned, MDNode *>> MDs) { 2034 for (const auto &Pair : MDs) { 2035 if (Pair.first == LLVMContext::MD_prof) { 2036 MDNode *MD = Pair.second; 2037 Assert(MD->getNumOperands() >= 2, 2038 "!prof annotations should have no less than 2 operands", MD); 2039 2040 // Check first operand. 2041 Assert(MD->getOperand(0) != nullptr, "first operand should not be null", 2042 MD); 2043 Assert(isa<MDString>(MD->getOperand(0)), 2044 "expected string with name of the !prof annotation", MD); 2045 MDString *MDS = cast<MDString>(MD->getOperand(0)); 2046 StringRef ProfName = MDS->getString(); 2047 Assert(ProfName.equals("function_entry_count") || 2048 ProfName.equals("synthetic_function_entry_count"), 2049 "first operand should be 'function_entry_count'" 2050 " or 'synthetic_function_entry_count'", 2051 MD); 2052 2053 // Check second operand. 2054 Assert(MD->getOperand(1) != nullptr, "second operand should not be null", 2055 MD); 2056 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)), 2057 "expected integer argument to function_entry_count", MD); 2058 } 2059 } 2060 } 2061 2062 void Verifier::visitConstantExprsRecursively(const Constant *EntryC) { 2063 if (!ConstantExprVisited.insert(EntryC).second) 2064 return; 2065 2066 SmallVector<const Constant *, 16> Stack; 2067 Stack.push_back(EntryC); 2068 2069 while (!Stack.empty()) { 2070 const Constant *C = Stack.pop_back_val(); 2071 2072 // Check this constant expression. 2073 if (const auto *CE = dyn_cast<ConstantExpr>(C)) 2074 visitConstantExpr(CE); 2075 2076 if (const auto *GV = dyn_cast<GlobalValue>(C)) { 2077 // Global Values get visited separately, but we do need to make sure 2078 // that the global value is in the correct module 2079 Assert(GV->getParent() == &M, "Referencing global in another module!", 2080 EntryC, &M, GV, GV->getParent()); 2081 continue; 2082 } 2083 2084 // Visit all sub-expressions. 2085 for (const Use &U : C->operands()) { 2086 const auto *OpC = dyn_cast<Constant>(U); 2087 if (!OpC) 2088 continue; 2089 if (!ConstantExprVisited.insert(OpC).second) 2090 continue; 2091 Stack.push_back(OpC); 2092 } 2093 } 2094 } 2095 2096 void Verifier::visitConstantExpr(const ConstantExpr *CE) { 2097 if (CE->getOpcode() == Instruction::BitCast) 2098 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0), 2099 CE->getType()), 2100 "Invalid bitcast", CE); 2101 } 2102 2103 bool Verifier::verifyAttributeCount(AttributeList Attrs, unsigned Params) { 2104 // There shouldn't be more attribute sets than there are parameters plus the 2105 // function and return value. 2106 return Attrs.getNumAttrSets() <= Params + 2; 2107 } 2108 2109 /// Verify that statepoint intrinsic is well formed. 2110 void Verifier::verifyStatepoint(const CallBase &Call) { 2111 assert(Call.getCalledFunction() && 2112 Call.getCalledFunction()->getIntrinsicID() == 2113 Intrinsic::experimental_gc_statepoint); 2114 2115 Assert(!Call.doesNotAccessMemory() && !Call.onlyReadsMemory() && 2116 !Call.onlyAccessesArgMemory(), 2117 "gc.statepoint must read and write all memory to preserve " 2118 "reordering restrictions required by safepoint semantics", 2119 Call); 2120 2121 const int64_t NumPatchBytes = 2122 cast<ConstantInt>(Call.getArgOperand(1))->getSExtValue(); 2123 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!"); 2124 Assert(NumPatchBytes >= 0, 2125 "gc.statepoint number of patchable bytes must be " 2126 "positive", 2127 Call); 2128 2129 const Value *Target = Call.getArgOperand(2); 2130 auto *PT = dyn_cast<PointerType>(Target->getType()); 2131 Assert(PT && PT->getElementType()->isFunctionTy(), 2132 "gc.statepoint callee must be of function pointer type", Call, Target); 2133 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType()); 2134 2135 const int NumCallArgs = cast<ConstantInt>(Call.getArgOperand(3))->getZExtValue(); 2136 Assert(NumCallArgs >= 0, 2137 "gc.statepoint number of arguments to underlying call " 2138 "must be positive", 2139 Call); 2140 const int NumParams = (int)TargetFuncType->getNumParams(); 2141 if (TargetFuncType->isVarArg()) { 2142 Assert(NumCallArgs >= NumParams, 2143 "gc.statepoint mismatch in number of vararg call args", Call); 2144 2145 // TODO: Remove this limitation 2146 Assert(TargetFuncType->getReturnType()->isVoidTy(), 2147 "gc.statepoint doesn't support wrapping non-void " 2148 "vararg functions yet", 2149 Call); 2150 } else 2151 Assert(NumCallArgs == NumParams, 2152 "gc.statepoint mismatch in number of call args", Call); 2153 2154 const uint64_t Flags 2155 = cast<ConstantInt>(Call.getArgOperand(4))->getZExtValue(); 2156 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0, 2157 "unknown flag used in gc.statepoint flags argument", Call); 2158 2159 // Verify that the types of the call parameter arguments match 2160 // the type of the wrapped callee. 2161 AttributeList Attrs = Call.getAttributes(); 2162 for (int i = 0; i < NumParams; i++) { 2163 Type *ParamType = TargetFuncType->getParamType(i); 2164 Type *ArgType = Call.getArgOperand(5 + i)->getType(); 2165 Assert(ArgType == ParamType, 2166 "gc.statepoint call argument does not match wrapped " 2167 "function type", 2168 Call); 2169 2170 if (TargetFuncType->isVarArg()) { 2171 AttributeSet ArgAttrs = Attrs.getParamAttributes(5 + i); 2172 Assert(!ArgAttrs.hasAttribute(Attribute::StructRet), 2173 "Attribute 'sret' cannot be used for vararg call arguments!", 2174 Call); 2175 } 2176 } 2177 2178 const int EndCallArgsInx = 4 + NumCallArgs; 2179 2180 const Value *NumTransitionArgsV = Call.getArgOperand(EndCallArgsInx + 1); 2181 Assert(isa<ConstantInt>(NumTransitionArgsV), 2182 "gc.statepoint number of transition arguments " 2183 "must be constant integer", 2184 Call); 2185 const int NumTransitionArgs = 2186 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue(); 2187 Assert(NumTransitionArgs == 0, 2188 "gc.statepoint w/inline transition bundle is deprecated", Call); 2189 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs; 2190 2191 const Value *NumDeoptArgsV = Call.getArgOperand(EndTransitionArgsInx + 1); 2192 Assert(isa<ConstantInt>(NumDeoptArgsV), 2193 "gc.statepoint number of deoptimization arguments " 2194 "must be constant integer", 2195 Call); 2196 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue(); 2197 Assert(NumDeoptArgs == 0, 2198 "gc.statepoint w/inline deopt operands is deprecated", Call); 2199 2200 const int ExpectedNumArgs = 7 + NumCallArgs; 2201 Assert(ExpectedNumArgs == (int)Call.arg_size(), 2202 "gc.statepoint too many arguments", Call); 2203 2204 // Check that the only uses of this gc.statepoint are gc.result or 2205 // gc.relocate calls which are tied to this statepoint and thus part 2206 // of the same statepoint sequence 2207 for (const User *U : Call.users()) { 2208 const CallInst *UserCall = dyn_cast<const CallInst>(U); 2209 Assert(UserCall, "illegal use of statepoint token", Call, U); 2210 if (!UserCall) 2211 continue; 2212 Assert(isa<GCRelocateInst>(UserCall) || isa<GCResultInst>(UserCall), 2213 "gc.result or gc.relocate are the only value uses " 2214 "of a gc.statepoint", 2215 Call, U); 2216 if (isa<GCResultInst>(UserCall)) { 2217 Assert(UserCall->getArgOperand(0) == &Call, 2218 "gc.result connected to wrong gc.statepoint", Call, UserCall); 2219 } else if (isa<GCRelocateInst>(Call)) { 2220 Assert(UserCall->getArgOperand(0) == &Call, 2221 "gc.relocate connected to wrong gc.statepoint", Call, UserCall); 2222 } 2223 } 2224 2225 // Note: It is legal for a single derived pointer to be listed multiple 2226 // times. It's non-optimal, but it is legal. It can also happen after 2227 // insertion if we strip a bitcast away. 2228 // Note: It is really tempting to check that each base is relocated and 2229 // that a derived pointer is never reused as a base pointer. This turns 2230 // out to be problematic since optimizations run after safepoint insertion 2231 // can recognize equality properties that the insertion logic doesn't know 2232 // about. See example statepoint.ll in the verifier subdirectory 2233 } 2234 2235 void Verifier::verifyFrameRecoverIndices() { 2236 for (auto &Counts : FrameEscapeInfo) { 2237 Function *F = Counts.first; 2238 unsigned EscapedObjectCount = Counts.second.first; 2239 unsigned MaxRecoveredIndex = Counts.second.second; 2240 Assert(MaxRecoveredIndex <= EscapedObjectCount, 2241 "all indices passed to llvm.localrecover must be less than the " 2242 "number of arguments passed to llvm.localescape in the parent " 2243 "function", 2244 F); 2245 } 2246 } 2247 2248 static Instruction *getSuccPad(Instruction *Terminator) { 2249 BasicBlock *UnwindDest; 2250 if (auto *II = dyn_cast<InvokeInst>(Terminator)) 2251 UnwindDest = II->getUnwindDest(); 2252 else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator)) 2253 UnwindDest = CSI->getUnwindDest(); 2254 else 2255 UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest(); 2256 return UnwindDest->getFirstNonPHI(); 2257 } 2258 2259 void Verifier::verifySiblingFuncletUnwinds() { 2260 SmallPtrSet<Instruction *, 8> Visited; 2261 SmallPtrSet<Instruction *, 8> Active; 2262 for (const auto &Pair : SiblingFuncletInfo) { 2263 Instruction *PredPad = Pair.first; 2264 if (Visited.count(PredPad)) 2265 continue; 2266 Active.insert(PredPad); 2267 Instruction *Terminator = Pair.second; 2268 do { 2269 Instruction *SuccPad = getSuccPad(Terminator); 2270 if (Active.count(SuccPad)) { 2271 // Found a cycle; report error 2272 Instruction *CyclePad = SuccPad; 2273 SmallVector<Instruction *, 8> CycleNodes; 2274 do { 2275 CycleNodes.push_back(CyclePad); 2276 Instruction *CycleTerminator = SiblingFuncletInfo[CyclePad]; 2277 if (CycleTerminator != CyclePad) 2278 CycleNodes.push_back(CycleTerminator); 2279 CyclePad = getSuccPad(CycleTerminator); 2280 } while (CyclePad != SuccPad); 2281 Assert(false, "EH pads can't handle each other's exceptions", 2282 ArrayRef<Instruction *>(CycleNodes)); 2283 } 2284 // Don't re-walk a node we've already checked 2285 if (!Visited.insert(SuccPad).second) 2286 break; 2287 // Walk to this successor if it has a map entry. 2288 PredPad = SuccPad; 2289 auto TermI = SiblingFuncletInfo.find(PredPad); 2290 if (TermI == SiblingFuncletInfo.end()) 2291 break; 2292 Terminator = TermI->second; 2293 Active.insert(PredPad); 2294 } while (true); 2295 // Each node only has one successor, so we've walked all the active 2296 // nodes' successors. 2297 Active.clear(); 2298 } 2299 } 2300 2301 // visitFunction - Verify that a function is ok. 2302 // 2303 void Verifier::visitFunction(const Function &F) { 2304 visitGlobalValue(F); 2305 2306 // Check function arguments. 2307 FunctionType *FT = F.getFunctionType(); 2308 unsigned NumArgs = F.arg_size(); 2309 2310 Assert(&Context == &F.getContext(), 2311 "Function context does not match Module context!", &F); 2312 2313 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F); 2314 Assert(FT->getNumParams() == NumArgs, 2315 "# formal arguments must match # of arguments for function type!", &F, 2316 FT); 2317 Assert(F.getReturnType()->isFirstClassType() || 2318 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(), 2319 "Functions cannot return aggregate values!", &F); 2320 2321 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(), 2322 "Invalid struct return type!", &F); 2323 2324 AttributeList Attrs = F.getAttributes(); 2325 2326 Assert(verifyAttributeCount(Attrs, FT->getNumParams()), 2327 "Attribute after last parameter!", &F); 2328 2329 bool IsIntrinsic = F.isIntrinsic(); 2330 2331 // Check function attributes. 2332 verifyFunctionAttrs(FT, Attrs, &F, IsIntrinsic); 2333 2334 // On function declarations/definitions, we do not support the builtin 2335 // attribute. We do not check this in VerifyFunctionAttrs since that is 2336 // checking for Attributes that can/can not ever be on functions. 2337 Assert(!Attrs.hasFnAttribute(Attribute::Builtin), 2338 "Attribute 'builtin' can only be applied to a callsite.", &F); 2339 2340 Assert(!Attrs.hasAttrSomewhere(Attribute::ElementType), 2341 "Attribute 'elementtype' can only be applied to a callsite.", &F); 2342 2343 // Check that this function meets the restrictions on this calling convention. 2344 // Sometimes varargs is used for perfectly forwarding thunks, so some of these 2345 // restrictions can be lifted. 2346 switch (F.getCallingConv()) { 2347 default: 2348 case CallingConv::C: 2349 break; 2350 case CallingConv::X86_INTR: { 2351 Assert(F.arg_empty() || Attrs.hasParamAttribute(0, Attribute::ByVal), 2352 "Calling convention parameter requires byval", &F); 2353 break; 2354 } 2355 case CallingConv::AMDGPU_KERNEL: 2356 case CallingConv::SPIR_KERNEL: 2357 Assert(F.getReturnType()->isVoidTy(), 2358 "Calling convention requires void return type", &F); 2359 LLVM_FALLTHROUGH; 2360 case CallingConv::AMDGPU_VS: 2361 case CallingConv::AMDGPU_HS: 2362 case CallingConv::AMDGPU_GS: 2363 case CallingConv::AMDGPU_PS: 2364 case CallingConv::AMDGPU_CS: 2365 Assert(!F.hasStructRetAttr(), 2366 "Calling convention does not allow sret", &F); 2367 if (F.getCallingConv() != CallingConv::SPIR_KERNEL) { 2368 const unsigned StackAS = DL.getAllocaAddrSpace(); 2369 unsigned i = 0; 2370 for (const Argument &Arg : F.args()) { 2371 Assert(!Attrs.hasParamAttribute(i, Attribute::ByVal), 2372 "Calling convention disallows byval", &F); 2373 Assert(!Attrs.hasParamAttribute(i, Attribute::Preallocated), 2374 "Calling convention disallows preallocated", &F); 2375 Assert(!Attrs.hasParamAttribute(i, Attribute::InAlloca), 2376 "Calling convention disallows inalloca", &F); 2377 2378 if (Attrs.hasParamAttribute(i, Attribute::ByRef)) { 2379 // FIXME: Should also disallow LDS and GDS, but we don't have the enum 2380 // value here. 2381 Assert(Arg.getType()->getPointerAddressSpace() != StackAS, 2382 "Calling convention disallows stack byref", &F); 2383 } 2384 2385 ++i; 2386 } 2387 } 2388 2389 LLVM_FALLTHROUGH; 2390 case CallingConv::Fast: 2391 case CallingConv::Cold: 2392 case CallingConv::Intel_OCL_BI: 2393 case CallingConv::PTX_Kernel: 2394 case CallingConv::PTX_Device: 2395 Assert(!F.isVarArg(), "Calling convention does not support varargs or " 2396 "perfect forwarding!", 2397 &F); 2398 break; 2399 } 2400 2401 // Check that the argument values match the function type for this function... 2402 unsigned i = 0; 2403 for (const Argument &Arg : F.args()) { 2404 Assert(Arg.getType() == FT->getParamType(i), 2405 "Argument value does not match function argument type!", &Arg, 2406 FT->getParamType(i)); 2407 Assert(Arg.getType()->isFirstClassType(), 2408 "Function arguments must have first-class types!", &Arg); 2409 if (!IsIntrinsic) { 2410 Assert(!Arg.getType()->isMetadataTy(), 2411 "Function takes metadata but isn't an intrinsic", &Arg, &F); 2412 Assert(!Arg.getType()->isTokenTy(), 2413 "Function takes token but isn't an intrinsic", &Arg, &F); 2414 Assert(!Arg.getType()->isX86_AMXTy(), 2415 "Function takes x86_amx but isn't an intrinsic", &Arg, &F); 2416 } 2417 2418 // Check that swifterror argument is only used by loads and stores. 2419 if (Attrs.hasParamAttribute(i, Attribute::SwiftError)) { 2420 verifySwiftErrorValue(&Arg); 2421 } 2422 ++i; 2423 } 2424 2425 if (!IsIntrinsic) { 2426 Assert(!F.getReturnType()->isTokenTy(), 2427 "Function returns a token but isn't an intrinsic", &F); 2428 Assert(!F.getReturnType()->isX86_AMXTy(), 2429 "Function returns a x86_amx but isn't an intrinsic", &F); 2430 } 2431 2432 // Get the function metadata attachments. 2433 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs; 2434 F.getAllMetadata(MDs); 2435 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync"); 2436 verifyFunctionMetadata(MDs); 2437 2438 // Check validity of the personality function 2439 if (F.hasPersonalityFn()) { 2440 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts()); 2441 if (Per) 2442 Assert(Per->getParent() == F.getParent(), 2443 "Referencing personality function in another module!", 2444 &F, F.getParent(), Per, Per->getParent()); 2445 } 2446 2447 if (F.isMaterializable()) { 2448 // Function has a body somewhere we can't see. 2449 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F, 2450 MDs.empty() ? nullptr : MDs.front().second); 2451 } else if (F.isDeclaration()) { 2452 for (const auto &I : MDs) { 2453 // This is used for call site debug information. 2454 AssertDI(I.first != LLVMContext::MD_dbg || 2455 !cast<DISubprogram>(I.second)->isDistinct(), 2456 "function declaration may only have a unique !dbg attachment", 2457 &F); 2458 Assert(I.first != LLVMContext::MD_prof, 2459 "function declaration may not have a !prof attachment", &F); 2460 2461 // Verify the metadata itself. 2462 visitMDNode(*I.second, AreDebugLocsAllowed::Yes); 2463 } 2464 Assert(!F.hasPersonalityFn(), 2465 "Function declaration shouldn't have a personality routine", &F); 2466 } else { 2467 // Verify that this function (which has a body) is not named "llvm.*". It 2468 // is not legal to define intrinsics. 2469 Assert(!IsIntrinsic, "llvm intrinsics cannot be defined!", &F); 2470 2471 // Check the entry node 2472 const BasicBlock *Entry = &F.getEntryBlock(); 2473 Assert(pred_empty(Entry), 2474 "Entry block to function must not have predecessors!", Entry); 2475 2476 // The address of the entry block cannot be taken, unless it is dead. 2477 if (Entry->hasAddressTaken()) { 2478 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(), 2479 "blockaddress may not be used with the entry block!", Entry); 2480 } 2481 2482 unsigned NumDebugAttachments = 0, NumProfAttachments = 0; 2483 // Visit metadata attachments. 2484 for (const auto &I : MDs) { 2485 // Verify that the attachment is legal. 2486 auto AllowLocs = AreDebugLocsAllowed::No; 2487 switch (I.first) { 2488 default: 2489 break; 2490 case LLVMContext::MD_dbg: { 2491 ++NumDebugAttachments; 2492 AssertDI(NumDebugAttachments == 1, 2493 "function must have a single !dbg attachment", &F, I.second); 2494 AssertDI(isa<DISubprogram>(I.second), 2495 "function !dbg attachment must be a subprogram", &F, I.second); 2496 AssertDI(cast<DISubprogram>(I.second)->isDistinct(), 2497 "function definition may only have a distinct !dbg attachment", 2498 &F); 2499 2500 auto *SP = cast<DISubprogram>(I.second); 2501 const Function *&AttachedTo = DISubprogramAttachments[SP]; 2502 AssertDI(!AttachedTo || AttachedTo == &F, 2503 "DISubprogram attached to more than one function", SP, &F); 2504 AttachedTo = &F; 2505 AllowLocs = AreDebugLocsAllowed::Yes; 2506 break; 2507 } 2508 case LLVMContext::MD_prof: 2509 ++NumProfAttachments; 2510 Assert(NumProfAttachments == 1, 2511 "function must have a single !prof attachment", &F, I.second); 2512 break; 2513 } 2514 2515 // Verify the metadata itself. 2516 visitMDNode(*I.second, AllowLocs); 2517 } 2518 } 2519 2520 // If this function is actually an intrinsic, verify that it is only used in 2521 // direct call/invokes, never having its "address taken". 2522 // Only do this if the module is materialized, otherwise we don't have all the 2523 // uses. 2524 if (F.isIntrinsic() && F.getParent()->isMaterialized()) { 2525 const User *U; 2526 if (F.hasAddressTaken(&U)) 2527 Assert(false, "Invalid user of intrinsic instruction!", U); 2528 } 2529 2530 // Check intrinsics' signatures. 2531 switch (F.getIntrinsicID()) { 2532 case Intrinsic::experimental_gc_get_pointer_base: { 2533 FunctionType *FT = F.getFunctionType(); 2534 Assert(FT->getNumParams() == 1, "wrong number of parameters", F); 2535 Assert(isa<PointerType>(F.getReturnType()), 2536 "gc.get.pointer.base must return a pointer", F); 2537 Assert(FT->getParamType(0) == F.getReturnType(), 2538 "gc.get.pointer.base operand and result must be of the same type", 2539 F); 2540 break; 2541 } 2542 case Intrinsic::experimental_gc_get_pointer_offset: { 2543 FunctionType *FT = F.getFunctionType(); 2544 Assert(FT->getNumParams() == 1, "wrong number of parameters", F); 2545 Assert(isa<PointerType>(FT->getParamType(0)), 2546 "gc.get.pointer.offset operand must be a pointer", F); 2547 Assert(F.getReturnType()->isIntegerTy(), 2548 "gc.get.pointer.offset must return integer", F); 2549 break; 2550 } 2551 } 2552 2553 auto *N = F.getSubprogram(); 2554 HasDebugInfo = (N != nullptr); 2555 if (!HasDebugInfo) 2556 return; 2557 2558 // Check that all !dbg attachments lead to back to N. 2559 // 2560 // FIXME: Check this incrementally while visiting !dbg attachments. 2561 // FIXME: Only check when N is the canonical subprogram for F. 2562 SmallPtrSet<const MDNode *, 32> Seen; 2563 auto VisitDebugLoc = [&](const Instruction &I, const MDNode *Node) { 2564 // Be careful about using DILocation here since we might be dealing with 2565 // broken code (this is the Verifier after all). 2566 const DILocation *DL = dyn_cast_or_null<DILocation>(Node); 2567 if (!DL) 2568 return; 2569 if (!Seen.insert(DL).second) 2570 return; 2571 2572 Metadata *Parent = DL->getRawScope(); 2573 AssertDI(Parent && isa<DILocalScope>(Parent), 2574 "DILocation's scope must be a DILocalScope", N, &F, &I, DL, 2575 Parent); 2576 2577 DILocalScope *Scope = DL->getInlinedAtScope(); 2578 Assert(Scope, "Failed to find DILocalScope", DL); 2579 2580 if (!Seen.insert(Scope).second) 2581 return; 2582 2583 DISubprogram *SP = Scope->getSubprogram(); 2584 2585 // Scope and SP could be the same MDNode and we don't want to skip 2586 // validation in that case 2587 if (SP && ((Scope != SP) && !Seen.insert(SP).second)) 2588 return; 2589 2590 AssertDI(SP->describes(&F), 2591 "!dbg attachment points at wrong subprogram for function", N, &F, 2592 &I, DL, Scope, SP); 2593 }; 2594 for (auto &BB : F) 2595 for (auto &I : BB) { 2596 VisitDebugLoc(I, I.getDebugLoc().getAsMDNode()); 2597 // The llvm.loop annotations also contain two DILocations. 2598 if (auto MD = I.getMetadata(LLVMContext::MD_loop)) 2599 for (unsigned i = 1; i < MD->getNumOperands(); ++i) 2600 VisitDebugLoc(I, dyn_cast_or_null<MDNode>(MD->getOperand(i))); 2601 if (BrokenDebugInfo) 2602 return; 2603 } 2604 } 2605 2606 // verifyBasicBlock - Verify that a basic block is well formed... 2607 // 2608 void Verifier::visitBasicBlock(BasicBlock &BB) { 2609 InstsInThisBlock.clear(); 2610 2611 // Ensure that basic blocks have terminators! 2612 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB); 2613 2614 // Check constraints that this basic block imposes on all of the PHI nodes in 2615 // it. 2616 if (isa<PHINode>(BB.front())) { 2617 SmallVector<BasicBlock *, 8> Preds(predecessors(&BB)); 2618 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values; 2619 llvm::sort(Preds); 2620 for (const PHINode &PN : BB.phis()) { 2621 Assert(PN.getNumIncomingValues() == Preds.size(), 2622 "PHINode should have one entry for each predecessor of its " 2623 "parent basic block!", 2624 &PN); 2625 2626 // Get and sort all incoming values in the PHI node... 2627 Values.clear(); 2628 Values.reserve(PN.getNumIncomingValues()); 2629 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) 2630 Values.push_back( 2631 std::make_pair(PN.getIncomingBlock(i), PN.getIncomingValue(i))); 2632 llvm::sort(Values); 2633 2634 for (unsigned i = 0, e = Values.size(); i != e; ++i) { 2635 // Check to make sure that if there is more than one entry for a 2636 // particular basic block in this PHI node, that the incoming values are 2637 // all identical. 2638 // 2639 Assert(i == 0 || Values[i].first != Values[i - 1].first || 2640 Values[i].second == Values[i - 1].second, 2641 "PHI node has multiple entries for the same basic block with " 2642 "different incoming values!", 2643 &PN, Values[i].first, Values[i].second, Values[i - 1].second); 2644 2645 // Check to make sure that the predecessors and PHI node entries are 2646 // matched up. 2647 Assert(Values[i].first == Preds[i], 2648 "PHI node entries do not match predecessors!", &PN, 2649 Values[i].first, Preds[i]); 2650 } 2651 } 2652 } 2653 2654 // Check that all instructions have their parent pointers set up correctly. 2655 for (auto &I : BB) 2656 { 2657 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!"); 2658 } 2659 } 2660 2661 void Verifier::visitTerminator(Instruction &I) { 2662 // Ensure that terminators only exist at the end of the basic block. 2663 Assert(&I == I.getParent()->getTerminator(), 2664 "Terminator found in the middle of a basic block!", I.getParent()); 2665 visitInstruction(I); 2666 } 2667 2668 void Verifier::visitBranchInst(BranchInst &BI) { 2669 if (BI.isConditional()) { 2670 Assert(BI.getCondition()->getType()->isIntegerTy(1), 2671 "Branch condition is not 'i1' type!", &BI, BI.getCondition()); 2672 } 2673 visitTerminator(BI); 2674 } 2675 2676 void Verifier::visitReturnInst(ReturnInst &RI) { 2677 Function *F = RI.getParent()->getParent(); 2678 unsigned N = RI.getNumOperands(); 2679 if (F->getReturnType()->isVoidTy()) 2680 Assert(N == 0, 2681 "Found return instr that returns non-void in Function of void " 2682 "return type!", 2683 &RI, F->getReturnType()); 2684 else 2685 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(), 2686 "Function return type does not match operand " 2687 "type of return inst!", 2688 &RI, F->getReturnType()); 2689 2690 // Check to make sure that the return value has necessary properties for 2691 // terminators... 2692 visitTerminator(RI); 2693 } 2694 2695 void Verifier::visitSwitchInst(SwitchInst &SI) { 2696 // Check to make sure that all of the constants in the switch instruction 2697 // have the same type as the switched-on value. 2698 Type *SwitchTy = SI.getCondition()->getType(); 2699 SmallPtrSet<ConstantInt*, 32> Constants; 2700 for (auto &Case : SI.cases()) { 2701 Assert(Case.getCaseValue()->getType() == SwitchTy, 2702 "Switch constants must all be same type as switch value!", &SI); 2703 Assert(Constants.insert(Case.getCaseValue()).second, 2704 "Duplicate integer as switch case", &SI, Case.getCaseValue()); 2705 } 2706 2707 visitTerminator(SI); 2708 } 2709 2710 void Verifier::visitIndirectBrInst(IndirectBrInst &BI) { 2711 Assert(BI.getAddress()->getType()->isPointerTy(), 2712 "Indirectbr operand must have pointer type!", &BI); 2713 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i) 2714 Assert(BI.getDestination(i)->getType()->isLabelTy(), 2715 "Indirectbr destinations must all have pointer type!", &BI); 2716 2717 visitTerminator(BI); 2718 } 2719 2720 void Verifier::visitCallBrInst(CallBrInst &CBI) { 2721 Assert(CBI.isInlineAsm(), "Callbr is currently only used for asm-goto!", 2722 &CBI); 2723 const InlineAsm *IA = cast<InlineAsm>(CBI.getCalledOperand()); 2724 Assert(!IA->canThrow(), "Unwinding from Callbr is not allowed"); 2725 for (unsigned i = 0, e = CBI.getNumSuccessors(); i != e; ++i) 2726 Assert(CBI.getSuccessor(i)->getType()->isLabelTy(), 2727 "Callbr successors must all have pointer type!", &CBI); 2728 for (unsigned i = 0, e = CBI.getNumOperands(); i != e; ++i) { 2729 Assert(i >= CBI.getNumArgOperands() || !isa<BasicBlock>(CBI.getOperand(i)), 2730 "Using an unescaped label as a callbr argument!", &CBI); 2731 if (isa<BasicBlock>(CBI.getOperand(i))) 2732 for (unsigned j = i + 1; j != e; ++j) 2733 Assert(CBI.getOperand(i) != CBI.getOperand(j), 2734 "Duplicate callbr destination!", &CBI); 2735 } 2736 { 2737 SmallPtrSet<BasicBlock *, 4> ArgBBs; 2738 for (Value *V : CBI.args()) 2739 if (auto *BA = dyn_cast<BlockAddress>(V)) 2740 ArgBBs.insert(BA->getBasicBlock()); 2741 for (BasicBlock *BB : CBI.getIndirectDests()) 2742 Assert(ArgBBs.count(BB), "Indirect label missing from arglist.", &CBI); 2743 } 2744 2745 visitTerminator(CBI); 2746 } 2747 2748 void Verifier::visitSelectInst(SelectInst &SI) { 2749 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1), 2750 SI.getOperand(2)), 2751 "Invalid operands for select instruction!", &SI); 2752 2753 Assert(SI.getTrueValue()->getType() == SI.getType(), 2754 "Select values must have same type as select instruction!", &SI); 2755 visitInstruction(SI); 2756 } 2757 2758 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of 2759 /// a pass, if any exist, it's an error. 2760 /// 2761 void Verifier::visitUserOp1(Instruction &I) { 2762 Assert(false, "User-defined operators should not live outside of a pass!", &I); 2763 } 2764 2765 void Verifier::visitTruncInst(TruncInst &I) { 2766 // Get the source and destination types 2767 Type *SrcTy = I.getOperand(0)->getType(); 2768 Type *DestTy = I.getType(); 2769 2770 // Get the size of the types in bits, we'll need this later 2771 unsigned SrcBitSize = SrcTy->getScalarSizeInBits(); 2772 unsigned DestBitSize = DestTy->getScalarSizeInBits(); 2773 2774 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I); 2775 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I); 2776 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), 2777 "trunc source and destination must both be a vector or neither", &I); 2778 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I); 2779 2780 visitInstruction(I); 2781 } 2782 2783 void Verifier::visitZExtInst(ZExtInst &I) { 2784 // Get the source and destination types 2785 Type *SrcTy = I.getOperand(0)->getType(); 2786 Type *DestTy = I.getType(); 2787 2788 // Get the size of the types in bits, we'll need this later 2789 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I); 2790 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I); 2791 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), 2792 "zext source and destination must both be a vector or neither", &I); 2793 unsigned SrcBitSize = SrcTy->getScalarSizeInBits(); 2794 unsigned DestBitSize = DestTy->getScalarSizeInBits(); 2795 2796 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I); 2797 2798 visitInstruction(I); 2799 } 2800 2801 void Verifier::visitSExtInst(SExtInst &I) { 2802 // Get the source and destination types 2803 Type *SrcTy = I.getOperand(0)->getType(); 2804 Type *DestTy = I.getType(); 2805 2806 // Get the size of the types in bits, we'll need this later 2807 unsigned SrcBitSize = SrcTy->getScalarSizeInBits(); 2808 unsigned DestBitSize = DestTy->getScalarSizeInBits(); 2809 2810 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I); 2811 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I); 2812 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), 2813 "sext source and destination must both be a vector or neither", &I); 2814 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I); 2815 2816 visitInstruction(I); 2817 } 2818 2819 void Verifier::visitFPTruncInst(FPTruncInst &I) { 2820 // Get the source and destination types 2821 Type *SrcTy = I.getOperand(0)->getType(); 2822 Type *DestTy = I.getType(); 2823 // Get the size of the types in bits, we'll need this later 2824 unsigned SrcBitSize = SrcTy->getScalarSizeInBits(); 2825 unsigned DestBitSize = DestTy->getScalarSizeInBits(); 2826 2827 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I); 2828 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I); 2829 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), 2830 "fptrunc source and destination must both be a vector or neither", &I); 2831 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I); 2832 2833 visitInstruction(I); 2834 } 2835 2836 void Verifier::visitFPExtInst(FPExtInst &I) { 2837 // Get the source and destination types 2838 Type *SrcTy = I.getOperand(0)->getType(); 2839 Type *DestTy = I.getType(); 2840 2841 // Get the size of the types in bits, we'll need this later 2842 unsigned SrcBitSize = SrcTy->getScalarSizeInBits(); 2843 unsigned DestBitSize = DestTy->getScalarSizeInBits(); 2844 2845 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I); 2846 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I); 2847 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), 2848 "fpext source and destination must both be a vector or neither", &I); 2849 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I); 2850 2851 visitInstruction(I); 2852 } 2853 2854 void Verifier::visitUIToFPInst(UIToFPInst &I) { 2855 // Get the source and destination types 2856 Type *SrcTy = I.getOperand(0)->getType(); 2857 Type *DestTy = I.getType(); 2858 2859 bool SrcVec = SrcTy->isVectorTy(); 2860 bool DstVec = DestTy->isVectorTy(); 2861 2862 Assert(SrcVec == DstVec, 2863 "UIToFP source and dest must both be vector or scalar", &I); 2864 Assert(SrcTy->isIntOrIntVectorTy(), 2865 "UIToFP source must be integer or integer vector", &I); 2866 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector", 2867 &I); 2868 2869 if (SrcVec && DstVec) 2870 Assert(cast<VectorType>(SrcTy)->getElementCount() == 2871 cast<VectorType>(DestTy)->getElementCount(), 2872 "UIToFP source and dest vector length mismatch", &I); 2873 2874 visitInstruction(I); 2875 } 2876 2877 void Verifier::visitSIToFPInst(SIToFPInst &I) { 2878 // Get the source and destination types 2879 Type *SrcTy = I.getOperand(0)->getType(); 2880 Type *DestTy = I.getType(); 2881 2882 bool SrcVec = SrcTy->isVectorTy(); 2883 bool DstVec = DestTy->isVectorTy(); 2884 2885 Assert(SrcVec == DstVec, 2886 "SIToFP source and dest must both be vector or scalar", &I); 2887 Assert(SrcTy->isIntOrIntVectorTy(), 2888 "SIToFP source must be integer or integer vector", &I); 2889 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector", 2890 &I); 2891 2892 if (SrcVec && DstVec) 2893 Assert(cast<VectorType>(SrcTy)->getElementCount() == 2894 cast<VectorType>(DestTy)->getElementCount(), 2895 "SIToFP source and dest vector length mismatch", &I); 2896 2897 visitInstruction(I); 2898 } 2899 2900 void Verifier::visitFPToUIInst(FPToUIInst &I) { 2901 // Get the source and destination types 2902 Type *SrcTy = I.getOperand(0)->getType(); 2903 Type *DestTy = I.getType(); 2904 2905 bool SrcVec = SrcTy->isVectorTy(); 2906 bool DstVec = DestTy->isVectorTy(); 2907 2908 Assert(SrcVec == DstVec, 2909 "FPToUI source and dest must both be vector or scalar", &I); 2910 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector", 2911 &I); 2912 Assert(DestTy->isIntOrIntVectorTy(), 2913 "FPToUI result must be integer or integer vector", &I); 2914 2915 if (SrcVec && DstVec) 2916 Assert(cast<VectorType>(SrcTy)->getElementCount() == 2917 cast<VectorType>(DestTy)->getElementCount(), 2918 "FPToUI source and dest vector length mismatch", &I); 2919 2920 visitInstruction(I); 2921 } 2922 2923 void Verifier::visitFPToSIInst(FPToSIInst &I) { 2924 // Get the source and destination types 2925 Type *SrcTy = I.getOperand(0)->getType(); 2926 Type *DestTy = I.getType(); 2927 2928 bool SrcVec = SrcTy->isVectorTy(); 2929 bool DstVec = DestTy->isVectorTy(); 2930 2931 Assert(SrcVec == DstVec, 2932 "FPToSI source and dest must both be vector or scalar", &I); 2933 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector", 2934 &I); 2935 Assert(DestTy->isIntOrIntVectorTy(), 2936 "FPToSI result must be integer or integer vector", &I); 2937 2938 if (SrcVec && DstVec) 2939 Assert(cast<VectorType>(SrcTy)->getElementCount() == 2940 cast<VectorType>(DestTy)->getElementCount(), 2941 "FPToSI source and dest vector length mismatch", &I); 2942 2943 visitInstruction(I); 2944 } 2945 2946 void Verifier::visitPtrToIntInst(PtrToIntInst &I) { 2947 // Get the source and destination types 2948 Type *SrcTy = I.getOperand(0)->getType(); 2949 Type *DestTy = I.getType(); 2950 2951 Assert(SrcTy->isPtrOrPtrVectorTy(), "PtrToInt source must be pointer", &I); 2952 2953 Assert(DestTy->isIntOrIntVectorTy(), "PtrToInt result must be integral", &I); 2954 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch", 2955 &I); 2956 2957 if (SrcTy->isVectorTy()) { 2958 auto *VSrc = cast<VectorType>(SrcTy); 2959 auto *VDest = cast<VectorType>(DestTy); 2960 Assert(VSrc->getElementCount() == VDest->getElementCount(), 2961 "PtrToInt Vector width mismatch", &I); 2962 } 2963 2964 visitInstruction(I); 2965 } 2966 2967 void Verifier::visitIntToPtrInst(IntToPtrInst &I) { 2968 // Get the source and destination types 2969 Type *SrcTy = I.getOperand(0)->getType(); 2970 Type *DestTy = I.getType(); 2971 2972 Assert(SrcTy->isIntOrIntVectorTy(), 2973 "IntToPtr source must be an integral", &I); 2974 Assert(DestTy->isPtrOrPtrVectorTy(), "IntToPtr result must be a pointer", &I); 2975 2976 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch", 2977 &I); 2978 if (SrcTy->isVectorTy()) { 2979 auto *VSrc = cast<VectorType>(SrcTy); 2980 auto *VDest = cast<VectorType>(DestTy); 2981 Assert(VSrc->getElementCount() == VDest->getElementCount(), 2982 "IntToPtr Vector width mismatch", &I); 2983 } 2984 visitInstruction(I); 2985 } 2986 2987 void Verifier::visitBitCastInst(BitCastInst &I) { 2988 Assert( 2989 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()), 2990 "Invalid bitcast", &I); 2991 visitInstruction(I); 2992 } 2993 2994 void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) { 2995 Type *SrcTy = I.getOperand(0)->getType(); 2996 Type *DestTy = I.getType(); 2997 2998 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer", 2999 &I); 3000 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer", 3001 &I); 3002 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(), 3003 "AddrSpaceCast must be between different address spaces", &I); 3004 if (auto *SrcVTy = dyn_cast<VectorType>(SrcTy)) 3005 Assert(SrcVTy->getElementCount() == 3006 cast<VectorType>(DestTy)->getElementCount(), 3007 "AddrSpaceCast vector pointer number of elements mismatch", &I); 3008 visitInstruction(I); 3009 } 3010 3011 /// visitPHINode - Ensure that a PHI node is well formed. 3012 /// 3013 void Verifier::visitPHINode(PHINode &PN) { 3014 // Ensure that the PHI nodes are all grouped together at the top of the block. 3015 // This can be tested by checking whether the instruction before this is 3016 // either nonexistent (because this is begin()) or is a PHI node. If not, 3017 // then there is some other instruction before a PHI. 3018 Assert(&PN == &PN.getParent()->front() || 3019 isa<PHINode>(--BasicBlock::iterator(&PN)), 3020 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent()); 3021 3022 // Check that a PHI doesn't yield a Token. 3023 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!"); 3024 3025 // Check that all of the values of the PHI node have the same type as the 3026 // result, and that the incoming blocks are really basic blocks. 3027 for (Value *IncValue : PN.incoming_values()) { 3028 Assert(PN.getType() == IncValue->getType(), 3029 "PHI node operands are not the same type as the result!", &PN); 3030 } 3031 3032 // All other PHI node constraints are checked in the visitBasicBlock method. 3033 3034 visitInstruction(PN); 3035 } 3036 3037 void Verifier::visitCallBase(CallBase &Call) { 3038 Assert(Call.getCalledOperand()->getType()->isPointerTy(), 3039 "Called function must be a pointer!", Call); 3040 PointerType *FPTy = cast<PointerType>(Call.getCalledOperand()->getType()); 3041 3042 Assert(FPTy->isOpaqueOrPointeeTypeMatches(Call.getFunctionType()), 3043 "Called function is not the same type as the call!", Call); 3044 3045 FunctionType *FTy = Call.getFunctionType(); 3046 3047 // Verify that the correct number of arguments are being passed 3048 if (FTy->isVarArg()) 3049 Assert(Call.arg_size() >= FTy->getNumParams(), 3050 "Called function requires more parameters than were provided!", 3051 Call); 3052 else 3053 Assert(Call.arg_size() == FTy->getNumParams(), 3054 "Incorrect number of arguments passed to called function!", Call); 3055 3056 // Verify that all arguments to the call match the function type. 3057 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) 3058 Assert(Call.getArgOperand(i)->getType() == FTy->getParamType(i), 3059 "Call parameter type does not match function signature!", 3060 Call.getArgOperand(i), FTy->getParamType(i), Call); 3061 3062 AttributeList Attrs = Call.getAttributes(); 3063 3064 Assert(verifyAttributeCount(Attrs, Call.arg_size()), 3065 "Attribute after last parameter!", Call); 3066 3067 bool IsIntrinsic = Call.getCalledFunction() && 3068 Call.getCalledFunction()->isIntrinsic(); 3069 3070 Function *Callee = 3071 dyn_cast<Function>(Call.getCalledOperand()->stripPointerCasts()); 3072 3073 if (Attrs.hasFnAttribute(Attribute::Speculatable)) { 3074 // Don't allow speculatable on call sites, unless the underlying function 3075 // declaration is also speculatable. 3076 Assert(Callee && Callee->isSpeculatable(), 3077 "speculatable attribute may not apply to call sites", Call); 3078 } 3079 3080 if (Attrs.hasFnAttribute(Attribute::Preallocated)) { 3081 Assert(Call.getCalledFunction()->getIntrinsicID() == 3082 Intrinsic::call_preallocated_arg, 3083 "preallocated as a call site attribute can only be on " 3084 "llvm.call.preallocated.arg"); 3085 } 3086 3087 // Verify call attributes. 3088 verifyFunctionAttrs(FTy, Attrs, &Call, IsIntrinsic); 3089 3090 // Conservatively check the inalloca argument. 3091 // We have a bug if we can find that there is an underlying alloca without 3092 // inalloca. 3093 if (Call.hasInAllocaArgument()) { 3094 Value *InAllocaArg = Call.getArgOperand(FTy->getNumParams() - 1); 3095 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets())) 3096 Assert(AI->isUsedWithInAlloca(), 3097 "inalloca argument for call has mismatched alloca", AI, Call); 3098 } 3099 3100 // For each argument of the callsite, if it has the swifterror argument, 3101 // make sure the underlying alloca/parameter it comes from has a swifterror as 3102 // well. 3103 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) { 3104 if (Call.paramHasAttr(i, Attribute::SwiftError)) { 3105 Value *SwiftErrorArg = Call.getArgOperand(i); 3106 if (auto AI = dyn_cast<AllocaInst>(SwiftErrorArg->stripInBoundsOffsets())) { 3107 Assert(AI->isSwiftError(), 3108 "swifterror argument for call has mismatched alloca", AI, Call); 3109 continue; 3110 } 3111 auto ArgI = dyn_cast<Argument>(SwiftErrorArg); 3112 Assert(ArgI, 3113 "swifterror argument should come from an alloca or parameter", 3114 SwiftErrorArg, Call); 3115 Assert(ArgI->hasSwiftErrorAttr(), 3116 "swifterror argument for call has mismatched parameter", ArgI, 3117 Call); 3118 } 3119 3120 if (Attrs.hasParamAttribute(i, Attribute::ImmArg)) { 3121 // Don't allow immarg on call sites, unless the underlying declaration 3122 // also has the matching immarg. 3123 Assert(Callee && Callee->hasParamAttribute(i, Attribute::ImmArg), 3124 "immarg may not apply only to call sites", 3125 Call.getArgOperand(i), Call); 3126 } 3127 3128 if (Call.paramHasAttr(i, Attribute::ImmArg)) { 3129 Value *ArgVal = Call.getArgOperand(i); 3130 Assert(isa<ConstantInt>(ArgVal) || isa<ConstantFP>(ArgVal), 3131 "immarg operand has non-immediate parameter", ArgVal, Call); 3132 } 3133 3134 if (Call.paramHasAttr(i, Attribute::Preallocated)) { 3135 Value *ArgVal = Call.getArgOperand(i); 3136 bool hasOB = 3137 Call.countOperandBundlesOfType(LLVMContext::OB_preallocated) != 0; 3138 bool isMustTail = Call.isMustTailCall(); 3139 Assert(hasOB != isMustTail, 3140 "preallocated operand either requires a preallocated bundle or " 3141 "the call to be musttail (but not both)", 3142 ArgVal, Call); 3143 } 3144 } 3145 3146 if (FTy->isVarArg()) { 3147 // FIXME? is 'nest' even legal here? 3148 bool SawNest = false; 3149 bool SawReturned = false; 3150 3151 for (unsigned Idx = 0; Idx < FTy->getNumParams(); ++Idx) { 3152 if (Attrs.hasParamAttribute(Idx, Attribute::Nest)) 3153 SawNest = true; 3154 if (Attrs.hasParamAttribute(Idx, Attribute::Returned)) 3155 SawReturned = true; 3156 } 3157 3158 // Check attributes on the varargs part. 3159 for (unsigned Idx = FTy->getNumParams(); Idx < Call.arg_size(); ++Idx) { 3160 Type *Ty = Call.getArgOperand(Idx)->getType(); 3161 AttributeSet ArgAttrs = Attrs.getParamAttributes(Idx); 3162 verifyParameterAttrs(ArgAttrs, Ty, &Call); 3163 3164 if (ArgAttrs.hasAttribute(Attribute::Nest)) { 3165 Assert(!SawNest, "More than one parameter has attribute nest!", Call); 3166 SawNest = true; 3167 } 3168 3169 if (ArgAttrs.hasAttribute(Attribute::Returned)) { 3170 Assert(!SawReturned, "More than one parameter has attribute returned!", 3171 Call); 3172 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()), 3173 "Incompatible argument and return types for 'returned' " 3174 "attribute", 3175 Call); 3176 SawReturned = true; 3177 } 3178 3179 // Statepoint intrinsic is vararg but the wrapped function may be not. 3180 // Allow sret here and check the wrapped function in verifyStatepoint. 3181 if (!Call.getCalledFunction() || 3182 Call.getCalledFunction()->getIntrinsicID() != 3183 Intrinsic::experimental_gc_statepoint) 3184 Assert(!ArgAttrs.hasAttribute(Attribute::StructRet), 3185 "Attribute 'sret' cannot be used for vararg call arguments!", 3186 Call); 3187 3188 if (ArgAttrs.hasAttribute(Attribute::InAlloca)) 3189 Assert(Idx == Call.arg_size() - 1, 3190 "inalloca isn't on the last argument!", Call); 3191 } 3192 } 3193 3194 // Verify that there's no metadata unless it's a direct call to an intrinsic. 3195 if (!IsIntrinsic) { 3196 for (Type *ParamTy : FTy->params()) { 3197 Assert(!ParamTy->isMetadataTy(), 3198 "Function has metadata parameter but isn't an intrinsic", Call); 3199 Assert(!ParamTy->isTokenTy(), 3200 "Function has token parameter but isn't an intrinsic", Call); 3201 } 3202 } 3203 3204 // Verify that indirect calls don't return tokens. 3205 if (!Call.getCalledFunction()) { 3206 Assert(!FTy->getReturnType()->isTokenTy(), 3207 "Return type cannot be token for indirect call!"); 3208 Assert(!FTy->getReturnType()->isX86_AMXTy(), 3209 "Return type cannot be x86_amx for indirect call!"); 3210 } 3211 3212 if (Function *F = Call.getCalledFunction()) 3213 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID()) 3214 visitIntrinsicCall(ID, Call); 3215 3216 // Verify that a callsite has at most one "deopt", at most one "funclet", at 3217 // most one "gc-transition", at most one "cfguardtarget", 3218 // and at most one "preallocated" operand bundle. 3219 bool FoundDeoptBundle = false, FoundFuncletBundle = false, 3220 FoundGCTransitionBundle = false, FoundCFGuardTargetBundle = false, 3221 FoundPreallocatedBundle = false, FoundGCLiveBundle = false, 3222 FoundAttachedCallBundle = false; 3223 for (unsigned i = 0, e = Call.getNumOperandBundles(); i < e; ++i) { 3224 OperandBundleUse BU = Call.getOperandBundleAt(i); 3225 uint32_t Tag = BU.getTagID(); 3226 if (Tag == LLVMContext::OB_deopt) { 3227 Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", Call); 3228 FoundDeoptBundle = true; 3229 } else if (Tag == LLVMContext::OB_gc_transition) { 3230 Assert(!FoundGCTransitionBundle, "Multiple gc-transition operand bundles", 3231 Call); 3232 FoundGCTransitionBundle = true; 3233 } else if (Tag == LLVMContext::OB_funclet) { 3234 Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", Call); 3235 FoundFuncletBundle = true; 3236 Assert(BU.Inputs.size() == 1, 3237 "Expected exactly one funclet bundle operand", Call); 3238 Assert(isa<FuncletPadInst>(BU.Inputs.front()), 3239 "Funclet bundle operands should correspond to a FuncletPadInst", 3240 Call); 3241 } else if (Tag == LLVMContext::OB_cfguardtarget) { 3242 Assert(!FoundCFGuardTargetBundle, 3243 "Multiple CFGuardTarget operand bundles", Call); 3244 FoundCFGuardTargetBundle = true; 3245 Assert(BU.Inputs.size() == 1, 3246 "Expected exactly one cfguardtarget bundle operand", Call); 3247 } else if (Tag == LLVMContext::OB_preallocated) { 3248 Assert(!FoundPreallocatedBundle, "Multiple preallocated operand bundles", 3249 Call); 3250 FoundPreallocatedBundle = true; 3251 Assert(BU.Inputs.size() == 1, 3252 "Expected exactly one preallocated bundle operand", Call); 3253 auto Input = dyn_cast<IntrinsicInst>(BU.Inputs.front()); 3254 Assert(Input && 3255 Input->getIntrinsicID() == Intrinsic::call_preallocated_setup, 3256 "\"preallocated\" argument must be a token from " 3257 "llvm.call.preallocated.setup", 3258 Call); 3259 } else if (Tag == LLVMContext::OB_gc_live) { 3260 Assert(!FoundGCLiveBundle, "Multiple gc-live operand bundles", 3261 Call); 3262 FoundGCLiveBundle = true; 3263 } else if (Tag == LLVMContext::OB_clang_arc_attachedcall) { 3264 Assert(!FoundAttachedCallBundle, 3265 "Multiple \"clang.arc.attachedcall\" operand bundles", Call); 3266 FoundAttachedCallBundle = true; 3267 } 3268 } 3269 3270 if (FoundAttachedCallBundle) 3271 Assert((FTy->getReturnType()->isPointerTy() || 3272 (Call.doesNotReturn() && FTy->getReturnType()->isVoidTy())), 3273 "a call with operand bundle \"clang.arc.attachedcall\" must call a " 3274 "function returning a pointer or a non-returning function that has " 3275 "a void return type", 3276 Call); 3277 3278 // Verify that each inlinable callsite of a debug-info-bearing function in a 3279 // debug-info-bearing function has a debug location attached to it. Failure to 3280 // do so causes assertion failures when the inliner sets up inline scope info. 3281 if (Call.getFunction()->getSubprogram() && Call.getCalledFunction() && 3282 Call.getCalledFunction()->getSubprogram()) 3283 AssertDI(Call.getDebugLoc(), 3284 "inlinable function call in a function with " 3285 "debug info must have a !dbg location", 3286 Call); 3287 3288 visitInstruction(Call); 3289 } 3290 3291 void Verifier::verifyTailCCMustTailAttrs(AttrBuilder Attrs, 3292 StringRef Context) { 3293 Assert(!Attrs.contains(Attribute::InAlloca), 3294 Twine("inalloca attribute not allowed in ") + Context); 3295 Assert(!Attrs.contains(Attribute::InReg), 3296 Twine("inreg attribute not allowed in ") + Context); 3297 Assert(!Attrs.contains(Attribute::SwiftError), 3298 Twine("swifterror attribute not allowed in ") + Context); 3299 Assert(!Attrs.contains(Attribute::Preallocated), 3300 Twine("preallocated attribute not allowed in ") + Context); 3301 Assert(!Attrs.contains(Attribute::ByRef), 3302 Twine("byref attribute not allowed in ") + Context); 3303 } 3304 3305 /// Two types are "congruent" if they are identical, or if they are both pointer 3306 /// types with different pointee types and the same address space. 3307 static bool isTypeCongruent(Type *L, Type *R) { 3308 if (L == R) 3309 return true; 3310 PointerType *PL = dyn_cast<PointerType>(L); 3311 PointerType *PR = dyn_cast<PointerType>(R); 3312 if (!PL || !PR) 3313 return false; 3314 return PL->getAddressSpace() == PR->getAddressSpace(); 3315 } 3316 3317 static AttrBuilder getParameterABIAttributes(int I, AttributeList Attrs) { 3318 static const Attribute::AttrKind ABIAttrs[] = { 3319 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca, 3320 Attribute::InReg, Attribute::StackAlignment, Attribute::SwiftSelf, 3321 Attribute::SwiftAsync, Attribute::SwiftError, Attribute::Preallocated, 3322 Attribute::ByRef}; 3323 AttrBuilder Copy; 3324 for (auto AK : ABIAttrs) { 3325 if (Attrs.hasParamAttribute(I, AK)) 3326 Copy.addAttribute(AK); 3327 } 3328 3329 // `align` is ABI-affecting only in combination with `byval` or `byref`. 3330 if (Attrs.hasParamAttribute(I, Attribute::Alignment) && 3331 (Attrs.hasParamAttribute(I, Attribute::ByVal) || 3332 Attrs.hasParamAttribute(I, Attribute::ByRef))) 3333 Copy.addAlignmentAttr(Attrs.getParamAlignment(I)); 3334 return Copy; 3335 } 3336 3337 void Verifier::verifyMustTailCall(CallInst &CI) { 3338 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI); 3339 3340 Function *F = CI.getParent()->getParent(); 3341 FunctionType *CallerTy = F->getFunctionType(); 3342 FunctionType *CalleeTy = CI.getFunctionType(); 3343 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(), 3344 "cannot guarantee tail call due to mismatched varargs", &CI); 3345 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()), 3346 "cannot guarantee tail call due to mismatched return types", &CI); 3347 3348 // - The calling conventions of the caller and callee must match. 3349 Assert(F->getCallingConv() == CI.getCallingConv(), 3350 "cannot guarantee tail call due to mismatched calling conv", &CI); 3351 3352 // - The call must immediately precede a :ref:`ret <i_ret>` instruction, 3353 // or a pointer bitcast followed by a ret instruction. 3354 // - The ret instruction must return the (possibly bitcasted) value 3355 // produced by the call or void. 3356 Value *RetVal = &CI; 3357 Instruction *Next = CI.getNextNode(); 3358 3359 // Handle the optional bitcast. 3360 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) { 3361 Assert(BI->getOperand(0) == RetVal, 3362 "bitcast following musttail call must use the call", BI); 3363 RetVal = BI; 3364 Next = BI->getNextNode(); 3365 } 3366 3367 // Check the return. 3368 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next); 3369 Assert(Ret, "musttail call must precede a ret with an optional bitcast", 3370 &CI); 3371 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal || 3372 isa<UndefValue>(Ret->getReturnValue()), 3373 "musttail call result must be returned", Ret); 3374 3375 AttributeList CallerAttrs = F->getAttributes(); 3376 AttributeList CalleeAttrs = CI.getAttributes(); 3377 if (CI.getCallingConv() == CallingConv::SwiftTail || 3378 CI.getCallingConv() == CallingConv::Tail) { 3379 StringRef CCName = 3380 CI.getCallingConv() == CallingConv::Tail ? "tailcc" : "swifttailcc"; 3381 3382 // - Only sret, byval, swiftself, and swiftasync ABI-impacting attributes 3383 // are allowed in swifttailcc call 3384 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) { 3385 AttrBuilder ABIAttrs = getParameterABIAttributes(I, CallerAttrs); 3386 SmallString<32> Context{CCName, StringRef(" musttail caller")}; 3387 verifyTailCCMustTailAttrs(ABIAttrs, Context); 3388 } 3389 for (int I = 0, E = CalleeTy->getNumParams(); I != E; ++I) { 3390 AttrBuilder ABIAttrs = getParameterABIAttributes(I, CalleeAttrs); 3391 SmallString<32> Context{CCName, StringRef(" musttail callee")}; 3392 verifyTailCCMustTailAttrs(ABIAttrs, Context); 3393 } 3394 // - Varargs functions are not allowed 3395 Assert(!CallerTy->isVarArg(), Twine("cannot guarantee ") + CCName + 3396 " tail call for varargs function"); 3397 return; 3398 } 3399 3400 // - The caller and callee prototypes must match. Pointer types of 3401 // parameters or return types may differ in pointee type, but not 3402 // address space. 3403 if (!CI.getCalledFunction() || !CI.getCalledFunction()->isIntrinsic()) { 3404 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(), 3405 "cannot guarantee tail call due to mismatched parameter counts", 3406 &CI); 3407 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) { 3408 Assert( 3409 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)), 3410 "cannot guarantee tail call due to mismatched parameter types", &CI); 3411 } 3412 } 3413 3414 // - All ABI-impacting function attributes, such as sret, byval, inreg, 3415 // returned, preallocated, and inalloca, must match. 3416 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) { 3417 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs); 3418 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs); 3419 Assert(CallerABIAttrs == CalleeABIAttrs, 3420 "cannot guarantee tail call due to mismatched ABI impacting " 3421 "function attributes", 3422 &CI, CI.getOperand(I)); 3423 } 3424 } 3425 3426 void Verifier::visitCallInst(CallInst &CI) { 3427 visitCallBase(CI); 3428 3429 if (CI.isMustTailCall()) 3430 verifyMustTailCall(CI); 3431 } 3432 3433 void Verifier::visitInvokeInst(InvokeInst &II) { 3434 visitCallBase(II); 3435 3436 // Verify that the first non-PHI instruction of the unwind destination is an 3437 // exception handling instruction. 3438 Assert( 3439 II.getUnwindDest()->isEHPad(), 3440 "The unwind destination does not have an exception handling instruction!", 3441 &II); 3442 3443 visitTerminator(II); 3444 } 3445 3446 /// visitUnaryOperator - Check the argument to the unary operator. 3447 /// 3448 void Verifier::visitUnaryOperator(UnaryOperator &U) { 3449 Assert(U.getType() == U.getOperand(0)->getType(), 3450 "Unary operators must have same type for" 3451 "operands and result!", 3452 &U); 3453 3454 switch (U.getOpcode()) { 3455 // Check that floating-point arithmetic operators are only used with 3456 // floating-point operands. 3457 case Instruction::FNeg: 3458 Assert(U.getType()->isFPOrFPVectorTy(), 3459 "FNeg operator only works with float types!", &U); 3460 break; 3461 default: 3462 llvm_unreachable("Unknown UnaryOperator opcode!"); 3463 } 3464 3465 visitInstruction(U); 3466 } 3467 3468 /// visitBinaryOperator - Check that both arguments to the binary operator are 3469 /// of the same type! 3470 /// 3471 void Verifier::visitBinaryOperator(BinaryOperator &B) { 3472 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(), 3473 "Both operands to a binary operator are not of the same type!", &B); 3474 3475 switch (B.getOpcode()) { 3476 // Check that integer arithmetic operators are only used with 3477 // integral operands. 3478 case Instruction::Add: 3479 case Instruction::Sub: 3480 case Instruction::Mul: 3481 case Instruction::SDiv: 3482 case Instruction::UDiv: 3483 case Instruction::SRem: 3484 case Instruction::URem: 3485 Assert(B.getType()->isIntOrIntVectorTy(), 3486 "Integer arithmetic operators only work with integral types!", &B); 3487 Assert(B.getType() == B.getOperand(0)->getType(), 3488 "Integer arithmetic operators must have same type " 3489 "for operands and result!", 3490 &B); 3491 break; 3492 // Check that floating-point arithmetic operators are only used with 3493 // floating-point operands. 3494 case Instruction::FAdd: 3495 case Instruction::FSub: 3496 case Instruction::FMul: 3497 case Instruction::FDiv: 3498 case Instruction::FRem: 3499 Assert(B.getType()->isFPOrFPVectorTy(), 3500 "Floating-point arithmetic operators only work with " 3501 "floating-point types!", 3502 &B); 3503 Assert(B.getType() == B.getOperand(0)->getType(), 3504 "Floating-point arithmetic operators must have same type " 3505 "for operands and result!", 3506 &B); 3507 break; 3508 // Check that logical operators are only used with integral operands. 3509 case Instruction::And: 3510 case Instruction::Or: 3511 case Instruction::Xor: 3512 Assert(B.getType()->isIntOrIntVectorTy(), 3513 "Logical operators only work with integral types!", &B); 3514 Assert(B.getType() == B.getOperand(0)->getType(), 3515 "Logical operators must have same type for operands and result!", 3516 &B); 3517 break; 3518 case Instruction::Shl: 3519 case Instruction::LShr: 3520 case Instruction::AShr: 3521 Assert(B.getType()->isIntOrIntVectorTy(), 3522 "Shifts only work with integral types!", &B); 3523 Assert(B.getType() == B.getOperand(0)->getType(), 3524 "Shift return type must be same as operands!", &B); 3525 break; 3526 default: 3527 llvm_unreachable("Unknown BinaryOperator opcode!"); 3528 } 3529 3530 visitInstruction(B); 3531 } 3532 3533 void Verifier::visitICmpInst(ICmpInst &IC) { 3534 // Check that the operands are the same type 3535 Type *Op0Ty = IC.getOperand(0)->getType(); 3536 Type *Op1Ty = IC.getOperand(1)->getType(); 3537 Assert(Op0Ty == Op1Ty, 3538 "Both operands to ICmp instruction are not of the same type!", &IC); 3539 // Check that the operands are the right type 3540 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->isPtrOrPtrVectorTy(), 3541 "Invalid operand types for ICmp instruction", &IC); 3542 // Check that the predicate is valid. 3543 Assert(IC.isIntPredicate(), 3544 "Invalid predicate in ICmp instruction!", &IC); 3545 3546 visitInstruction(IC); 3547 } 3548 3549 void Verifier::visitFCmpInst(FCmpInst &FC) { 3550 // Check that the operands are the same type 3551 Type *Op0Ty = FC.getOperand(0)->getType(); 3552 Type *Op1Ty = FC.getOperand(1)->getType(); 3553 Assert(Op0Ty == Op1Ty, 3554 "Both operands to FCmp instruction are not of the same type!", &FC); 3555 // Check that the operands are the right type 3556 Assert(Op0Ty->isFPOrFPVectorTy(), 3557 "Invalid operand types for FCmp instruction", &FC); 3558 // Check that the predicate is valid. 3559 Assert(FC.isFPPredicate(), 3560 "Invalid predicate in FCmp instruction!", &FC); 3561 3562 visitInstruction(FC); 3563 } 3564 3565 void Verifier::visitExtractElementInst(ExtractElementInst &EI) { 3566 Assert( 3567 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)), 3568 "Invalid extractelement operands!", &EI); 3569 visitInstruction(EI); 3570 } 3571 3572 void Verifier::visitInsertElementInst(InsertElementInst &IE) { 3573 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1), 3574 IE.getOperand(2)), 3575 "Invalid insertelement operands!", &IE); 3576 visitInstruction(IE); 3577 } 3578 3579 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) { 3580 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1), 3581 SV.getShuffleMask()), 3582 "Invalid shufflevector operands!", &SV); 3583 visitInstruction(SV); 3584 } 3585 3586 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) { 3587 Type *TargetTy = GEP.getPointerOperandType()->getScalarType(); 3588 3589 Assert(isa<PointerType>(TargetTy), 3590 "GEP base pointer is not a vector or a vector of pointers", &GEP); 3591 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP); 3592 3593 SmallVector<Value *, 16> Idxs(GEP.indices()); 3594 Assert(all_of( 3595 Idxs, [](Value* V) { return V->getType()->isIntOrIntVectorTy(); }), 3596 "GEP indexes must be integers", &GEP); 3597 Type *ElTy = 3598 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs); 3599 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP); 3600 3601 Assert(GEP.getType()->isPtrOrPtrVectorTy() && 3602 GEP.getResultElementType() == ElTy, 3603 "GEP is not of right type for indices!", &GEP, ElTy); 3604 3605 if (auto *GEPVTy = dyn_cast<VectorType>(GEP.getType())) { 3606 // Additional checks for vector GEPs. 3607 ElementCount GEPWidth = GEPVTy->getElementCount(); 3608 if (GEP.getPointerOperandType()->isVectorTy()) 3609 Assert( 3610 GEPWidth == 3611 cast<VectorType>(GEP.getPointerOperandType())->getElementCount(), 3612 "Vector GEP result width doesn't match operand's", &GEP); 3613 for (Value *Idx : Idxs) { 3614 Type *IndexTy = Idx->getType(); 3615 if (auto *IndexVTy = dyn_cast<VectorType>(IndexTy)) { 3616 ElementCount IndexWidth = IndexVTy->getElementCount(); 3617 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP); 3618 } 3619 Assert(IndexTy->isIntOrIntVectorTy(), 3620 "All GEP indices should be of integer type"); 3621 } 3622 } 3623 3624 if (auto *PTy = dyn_cast<PointerType>(GEP.getType())) { 3625 Assert(GEP.getAddressSpace() == PTy->getAddressSpace(), 3626 "GEP address space doesn't match type", &GEP); 3627 } 3628 3629 visitInstruction(GEP); 3630 } 3631 3632 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) { 3633 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper(); 3634 } 3635 3636 void Verifier::visitRangeMetadata(Instruction &I, MDNode *Range, Type *Ty) { 3637 assert(Range && Range == I.getMetadata(LLVMContext::MD_range) && 3638 "precondition violation"); 3639 3640 unsigned NumOperands = Range->getNumOperands(); 3641 Assert(NumOperands % 2 == 0, "Unfinished range!", Range); 3642 unsigned NumRanges = NumOperands / 2; 3643 Assert(NumRanges >= 1, "It should have at least one range!", Range); 3644 3645 ConstantRange LastRange(1, true); // Dummy initial value 3646 for (unsigned i = 0; i < NumRanges; ++i) { 3647 ConstantInt *Low = 3648 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i)); 3649 Assert(Low, "The lower limit must be an integer!", Low); 3650 ConstantInt *High = 3651 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1)); 3652 Assert(High, "The upper limit must be an integer!", High); 3653 Assert(High->getType() == Low->getType() && High->getType() == Ty, 3654 "Range types must match instruction type!", &I); 3655 3656 APInt HighV = High->getValue(); 3657 APInt LowV = Low->getValue(); 3658 ConstantRange CurRange(LowV, HighV); 3659 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(), 3660 "Range must not be empty!", Range); 3661 if (i != 0) { 3662 Assert(CurRange.intersectWith(LastRange).isEmptySet(), 3663 "Intervals are overlapping", Range); 3664 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order", 3665 Range); 3666 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous", 3667 Range); 3668 } 3669 LastRange = ConstantRange(LowV, HighV); 3670 } 3671 if (NumRanges > 2) { 3672 APInt FirstLow = 3673 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue(); 3674 APInt FirstHigh = 3675 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue(); 3676 ConstantRange FirstRange(FirstLow, FirstHigh); 3677 Assert(FirstRange.intersectWith(LastRange).isEmptySet(), 3678 "Intervals are overlapping", Range); 3679 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous", 3680 Range); 3681 } 3682 } 3683 3684 void Verifier::checkAtomicMemAccessSize(Type *Ty, const Instruction *I) { 3685 unsigned Size = DL.getTypeSizeInBits(Ty); 3686 Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I); 3687 Assert(!(Size & (Size - 1)), 3688 "atomic memory access' operand must have a power-of-two size", Ty, I); 3689 } 3690 3691 void Verifier::visitLoadInst(LoadInst &LI) { 3692 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType()); 3693 Assert(PTy, "Load operand must be a pointer.", &LI); 3694 Type *ElTy = LI.getType(); 3695 Assert(LI.getAlignment() <= Value::MaximumAlignment, 3696 "huge alignment values are unsupported", &LI); 3697 Assert(ElTy->isSized(), "loading unsized types is not allowed", &LI); 3698 if (LI.isAtomic()) { 3699 Assert(LI.getOrdering() != AtomicOrdering::Release && 3700 LI.getOrdering() != AtomicOrdering::AcquireRelease, 3701 "Load cannot have Release ordering", &LI); 3702 Assert(LI.getAlignment() != 0, 3703 "Atomic load must specify explicit alignment", &LI); 3704 Assert(ElTy->isIntOrPtrTy() || ElTy->isFloatingPointTy(), 3705 "atomic load operand must have integer, pointer, or floating point " 3706 "type!", 3707 ElTy, &LI); 3708 checkAtomicMemAccessSize(ElTy, &LI); 3709 } else { 3710 Assert(LI.getSyncScopeID() == SyncScope::System, 3711 "Non-atomic load cannot have SynchronizationScope specified", &LI); 3712 } 3713 3714 visitInstruction(LI); 3715 } 3716 3717 void Verifier::visitStoreInst(StoreInst &SI) { 3718 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType()); 3719 Assert(PTy, "Store operand must be a pointer.", &SI); 3720 Type *ElTy = SI.getOperand(0)->getType(); 3721 Assert(PTy->isOpaqueOrPointeeTypeMatches(ElTy), 3722 "Stored value type does not match pointer operand type!", &SI, ElTy); 3723 Assert(SI.getAlignment() <= Value::MaximumAlignment, 3724 "huge alignment values are unsupported", &SI); 3725 Assert(ElTy->isSized(), "storing unsized types is not allowed", &SI); 3726 if (SI.isAtomic()) { 3727 Assert(SI.getOrdering() != AtomicOrdering::Acquire && 3728 SI.getOrdering() != AtomicOrdering::AcquireRelease, 3729 "Store cannot have Acquire ordering", &SI); 3730 Assert(SI.getAlignment() != 0, 3731 "Atomic store must specify explicit alignment", &SI); 3732 Assert(ElTy->isIntOrPtrTy() || ElTy->isFloatingPointTy(), 3733 "atomic store operand must have integer, pointer, or floating point " 3734 "type!", 3735 ElTy, &SI); 3736 checkAtomicMemAccessSize(ElTy, &SI); 3737 } else { 3738 Assert(SI.getSyncScopeID() == SyncScope::System, 3739 "Non-atomic store cannot have SynchronizationScope specified", &SI); 3740 } 3741 visitInstruction(SI); 3742 } 3743 3744 /// Check that SwiftErrorVal is used as a swifterror argument in CS. 3745 void Verifier::verifySwiftErrorCall(CallBase &Call, 3746 const Value *SwiftErrorVal) { 3747 for (const auto &I : llvm::enumerate(Call.args())) { 3748 if (I.value() == SwiftErrorVal) { 3749 Assert(Call.paramHasAttr(I.index(), Attribute::SwiftError), 3750 "swifterror value when used in a callsite should be marked " 3751 "with swifterror attribute", 3752 SwiftErrorVal, Call); 3753 } 3754 } 3755 } 3756 3757 void Verifier::verifySwiftErrorValue(const Value *SwiftErrorVal) { 3758 // Check that swifterror value is only used by loads, stores, or as 3759 // a swifterror argument. 3760 for (const User *U : SwiftErrorVal->users()) { 3761 Assert(isa<LoadInst>(U) || isa<StoreInst>(U) || isa<CallInst>(U) || 3762 isa<InvokeInst>(U), 3763 "swifterror value can only be loaded and stored from, or " 3764 "as a swifterror argument!", 3765 SwiftErrorVal, U); 3766 // If it is used by a store, check it is the second operand. 3767 if (auto StoreI = dyn_cast<StoreInst>(U)) 3768 Assert(StoreI->getOperand(1) == SwiftErrorVal, 3769 "swifterror value should be the second operand when used " 3770 "by stores", SwiftErrorVal, U); 3771 if (auto *Call = dyn_cast<CallBase>(U)) 3772 verifySwiftErrorCall(*const_cast<CallBase *>(Call), SwiftErrorVal); 3773 } 3774 } 3775 3776 void Verifier::visitAllocaInst(AllocaInst &AI) { 3777 SmallPtrSet<Type*, 4> Visited; 3778 Assert(AI.getAllocatedType()->isSized(&Visited), 3779 "Cannot allocate unsized type", &AI); 3780 Assert(AI.getArraySize()->getType()->isIntegerTy(), 3781 "Alloca array size must have integer type", &AI); 3782 Assert(AI.getAlignment() <= Value::MaximumAlignment, 3783 "huge alignment values are unsupported", &AI); 3784 3785 if (AI.isSwiftError()) { 3786 verifySwiftErrorValue(&AI); 3787 } 3788 3789 visitInstruction(AI); 3790 } 3791 3792 void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) { 3793 Type *ElTy = CXI.getOperand(1)->getType(); 3794 Assert(ElTy->isIntOrPtrTy(), 3795 "cmpxchg operand must have integer or pointer type", ElTy, &CXI); 3796 checkAtomicMemAccessSize(ElTy, &CXI); 3797 visitInstruction(CXI); 3798 } 3799 3800 void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) { 3801 Assert(RMWI.getOrdering() != AtomicOrdering::Unordered, 3802 "atomicrmw instructions cannot be unordered.", &RMWI); 3803 auto Op = RMWI.getOperation(); 3804 Type *ElTy = RMWI.getOperand(1)->getType(); 3805 if (Op == AtomicRMWInst::Xchg) { 3806 Assert(ElTy->isIntegerTy() || ElTy->isFloatingPointTy(), "atomicrmw " + 3807 AtomicRMWInst::getOperationName(Op) + 3808 " operand must have integer or floating point type!", 3809 &RMWI, ElTy); 3810 } else if (AtomicRMWInst::isFPOperation(Op)) { 3811 Assert(ElTy->isFloatingPointTy(), "atomicrmw " + 3812 AtomicRMWInst::getOperationName(Op) + 3813 " operand must have floating point type!", 3814 &RMWI, ElTy); 3815 } else { 3816 Assert(ElTy->isIntegerTy(), "atomicrmw " + 3817 AtomicRMWInst::getOperationName(Op) + 3818 " operand must have integer type!", 3819 &RMWI, ElTy); 3820 } 3821 checkAtomicMemAccessSize(ElTy, &RMWI); 3822 Assert(AtomicRMWInst::FIRST_BINOP <= Op && Op <= AtomicRMWInst::LAST_BINOP, 3823 "Invalid binary operation!", &RMWI); 3824 visitInstruction(RMWI); 3825 } 3826 3827 void Verifier::visitFenceInst(FenceInst &FI) { 3828 const AtomicOrdering Ordering = FI.getOrdering(); 3829 Assert(Ordering == AtomicOrdering::Acquire || 3830 Ordering == AtomicOrdering::Release || 3831 Ordering == AtomicOrdering::AcquireRelease || 3832 Ordering == AtomicOrdering::SequentiallyConsistent, 3833 "fence instructions may only have acquire, release, acq_rel, or " 3834 "seq_cst ordering.", 3835 &FI); 3836 visitInstruction(FI); 3837 } 3838 3839 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) { 3840 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(), 3841 EVI.getIndices()) == EVI.getType(), 3842 "Invalid ExtractValueInst operands!", &EVI); 3843 3844 visitInstruction(EVI); 3845 } 3846 3847 void Verifier::visitInsertValueInst(InsertValueInst &IVI) { 3848 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(), 3849 IVI.getIndices()) == 3850 IVI.getOperand(1)->getType(), 3851 "Invalid InsertValueInst operands!", &IVI); 3852 3853 visitInstruction(IVI); 3854 } 3855 3856 static Value *getParentPad(Value *EHPad) { 3857 if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad)) 3858 return FPI->getParentPad(); 3859 3860 return cast<CatchSwitchInst>(EHPad)->getParentPad(); 3861 } 3862 3863 void Verifier::visitEHPadPredecessors(Instruction &I) { 3864 assert(I.isEHPad()); 3865 3866 BasicBlock *BB = I.getParent(); 3867 Function *F = BB->getParent(); 3868 3869 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I); 3870 3871 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) { 3872 // The landingpad instruction defines its parent as a landing pad block. The 3873 // landing pad block may be branched to only by the unwind edge of an 3874 // invoke. 3875 for (BasicBlock *PredBB : predecessors(BB)) { 3876 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator()); 3877 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB, 3878 "Block containing LandingPadInst must be jumped to " 3879 "only by the unwind edge of an invoke.", 3880 LPI); 3881 } 3882 return; 3883 } 3884 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) { 3885 if (!pred_empty(BB)) 3886 Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(), 3887 "Block containg CatchPadInst must be jumped to " 3888 "only by its catchswitch.", 3889 CPI); 3890 Assert(BB != CPI->getCatchSwitch()->getUnwindDest(), 3891 "Catchswitch cannot unwind to one of its catchpads", 3892 CPI->getCatchSwitch(), CPI); 3893 return; 3894 } 3895 3896 // Verify that each pred has a legal terminator with a legal to/from EH 3897 // pad relationship. 3898 Instruction *ToPad = &I; 3899 Value *ToPadParent = getParentPad(ToPad); 3900 for (BasicBlock *PredBB : predecessors(BB)) { 3901 Instruction *TI = PredBB->getTerminator(); 3902 Value *FromPad; 3903 if (auto *II = dyn_cast<InvokeInst>(TI)) { 3904 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB, 3905 "EH pad must be jumped to via an unwind edge", ToPad, II); 3906 if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet)) 3907 FromPad = Bundle->Inputs[0]; 3908 else 3909 FromPad = ConstantTokenNone::get(II->getContext()); 3910 } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) { 3911 FromPad = CRI->getOperand(0); 3912 Assert(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI); 3913 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) { 3914 FromPad = CSI; 3915 } else { 3916 Assert(false, "EH pad must be jumped to via an unwind edge", ToPad, TI); 3917 } 3918 3919 // The edge may exit from zero or more nested pads. 3920 SmallSet<Value *, 8> Seen; 3921 for (;; FromPad = getParentPad(FromPad)) { 3922 Assert(FromPad != ToPad, 3923 "EH pad cannot handle exceptions raised within it", FromPad, TI); 3924 if (FromPad == ToPadParent) { 3925 // This is a legal unwind edge. 3926 break; 3927 } 3928 Assert(!isa<ConstantTokenNone>(FromPad), 3929 "A single unwind edge may only enter one EH pad", TI); 3930 Assert(Seen.insert(FromPad).second, 3931 "EH pad jumps through a cycle of pads", FromPad); 3932 } 3933 } 3934 } 3935 3936 void Verifier::visitLandingPadInst(LandingPadInst &LPI) { 3937 // The landingpad instruction is ill-formed if it doesn't have any clauses and 3938 // isn't a cleanup. 3939 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(), 3940 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI); 3941 3942 visitEHPadPredecessors(LPI); 3943 3944 if (!LandingPadResultTy) 3945 LandingPadResultTy = LPI.getType(); 3946 else 3947 Assert(LandingPadResultTy == LPI.getType(), 3948 "The landingpad instruction should have a consistent result type " 3949 "inside a function.", 3950 &LPI); 3951 3952 Function *F = LPI.getParent()->getParent(); 3953 Assert(F->hasPersonalityFn(), 3954 "LandingPadInst needs to be in a function with a personality.", &LPI); 3955 3956 // The landingpad instruction must be the first non-PHI instruction in the 3957 // block. 3958 Assert(LPI.getParent()->getLandingPadInst() == &LPI, 3959 "LandingPadInst not the first non-PHI instruction in the block.", 3960 &LPI); 3961 3962 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) { 3963 Constant *Clause = LPI.getClause(i); 3964 if (LPI.isCatch(i)) { 3965 Assert(isa<PointerType>(Clause->getType()), 3966 "Catch operand does not have pointer type!", &LPI); 3967 } else { 3968 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI); 3969 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause), 3970 "Filter operand is not an array of constants!", &LPI); 3971 } 3972 } 3973 3974 visitInstruction(LPI); 3975 } 3976 3977 void Verifier::visitResumeInst(ResumeInst &RI) { 3978 Assert(RI.getFunction()->hasPersonalityFn(), 3979 "ResumeInst needs to be in a function with a personality.", &RI); 3980 3981 if (!LandingPadResultTy) 3982 LandingPadResultTy = RI.getValue()->getType(); 3983 else 3984 Assert(LandingPadResultTy == RI.getValue()->getType(), 3985 "The resume instruction should have a consistent result type " 3986 "inside a function.", 3987 &RI); 3988 3989 visitTerminator(RI); 3990 } 3991 3992 void Verifier::visitCatchPadInst(CatchPadInst &CPI) { 3993 BasicBlock *BB = CPI.getParent(); 3994 3995 Function *F = BB->getParent(); 3996 Assert(F->hasPersonalityFn(), 3997 "CatchPadInst needs to be in a function with a personality.", &CPI); 3998 3999 Assert(isa<CatchSwitchInst>(CPI.getParentPad()), 4000 "CatchPadInst needs to be directly nested in a CatchSwitchInst.", 4001 CPI.getParentPad()); 4002 4003 // The catchpad instruction must be the first non-PHI instruction in the 4004 // block. 4005 Assert(BB->getFirstNonPHI() == &CPI, 4006 "CatchPadInst not the first non-PHI instruction in the block.", &CPI); 4007 4008 visitEHPadPredecessors(CPI); 4009 visitFuncletPadInst(CPI); 4010 } 4011 4012 void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) { 4013 Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)), 4014 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn, 4015 CatchReturn.getOperand(0)); 4016 4017 visitTerminator(CatchReturn); 4018 } 4019 4020 void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) { 4021 BasicBlock *BB = CPI.getParent(); 4022 4023 Function *F = BB->getParent(); 4024 Assert(F->hasPersonalityFn(), 4025 "CleanupPadInst needs to be in a function with a personality.", &CPI); 4026 4027 // The cleanuppad instruction must be the first non-PHI instruction in the 4028 // block. 4029 Assert(BB->getFirstNonPHI() == &CPI, 4030 "CleanupPadInst not the first non-PHI instruction in the block.", 4031 &CPI); 4032 4033 auto *ParentPad = CPI.getParentPad(); 4034 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad), 4035 "CleanupPadInst has an invalid parent.", &CPI); 4036 4037 visitEHPadPredecessors(CPI); 4038 visitFuncletPadInst(CPI); 4039 } 4040 4041 void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) { 4042 User *FirstUser = nullptr; 4043 Value *FirstUnwindPad = nullptr; 4044 SmallVector<FuncletPadInst *, 8> Worklist({&FPI}); 4045 SmallSet<FuncletPadInst *, 8> Seen; 4046 4047 while (!Worklist.empty()) { 4048 FuncletPadInst *CurrentPad = Worklist.pop_back_val(); 4049 Assert(Seen.insert(CurrentPad).second, 4050 "FuncletPadInst must not be nested within itself", CurrentPad); 4051 Value *UnresolvedAncestorPad = nullptr; 4052 for (User *U : CurrentPad->users()) { 4053 BasicBlock *UnwindDest; 4054 if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) { 4055 UnwindDest = CRI->getUnwindDest(); 4056 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) { 4057 // We allow catchswitch unwind to caller to nest 4058 // within an outer pad that unwinds somewhere else, 4059 // because catchswitch doesn't have a nounwind variant. 4060 // See e.g. SimplifyCFGOpt::SimplifyUnreachable. 4061 if (CSI->unwindsToCaller()) 4062 continue; 4063 UnwindDest = CSI->getUnwindDest(); 4064 } else if (auto *II = dyn_cast<InvokeInst>(U)) { 4065 UnwindDest = II->getUnwindDest(); 4066 } else if (isa<CallInst>(U)) { 4067 // Calls which don't unwind may be found inside funclet 4068 // pads that unwind somewhere else. We don't *require* 4069 // such calls to be annotated nounwind. 4070 continue; 4071 } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) { 4072 // The unwind dest for a cleanup can only be found by 4073 // recursive search. Add it to the worklist, and we'll 4074 // search for its first use that determines where it unwinds. 4075 Worklist.push_back(CPI); 4076 continue; 4077 } else { 4078 Assert(isa<CatchReturnInst>(U), "Bogus funclet pad use", U); 4079 continue; 4080 } 4081 4082 Value *UnwindPad; 4083 bool ExitsFPI; 4084 if (UnwindDest) { 4085 UnwindPad = UnwindDest->getFirstNonPHI(); 4086 if (!cast<Instruction>(UnwindPad)->isEHPad()) 4087 continue; 4088 Value *UnwindParent = getParentPad(UnwindPad); 4089 // Ignore unwind edges that don't exit CurrentPad. 4090 if (UnwindParent == CurrentPad) 4091 continue; 4092 // Determine whether the original funclet pad is exited, 4093 // and if we are scanning nested pads determine how many 4094 // of them are exited so we can stop searching their 4095 // children. 4096 Value *ExitedPad = CurrentPad; 4097 ExitsFPI = false; 4098 do { 4099 if (ExitedPad == &FPI) { 4100 ExitsFPI = true; 4101 // Now we can resolve any ancestors of CurrentPad up to 4102 // FPI, but not including FPI since we need to make sure 4103 // to check all direct users of FPI for consistency. 4104 UnresolvedAncestorPad = &FPI; 4105 break; 4106 } 4107 Value *ExitedParent = getParentPad(ExitedPad); 4108 if (ExitedParent == UnwindParent) { 4109 // ExitedPad is the ancestor-most pad which this unwind 4110 // edge exits, so we can resolve up to it, meaning that 4111 // ExitedParent is the first ancestor still unresolved. 4112 UnresolvedAncestorPad = ExitedParent; 4113 break; 4114 } 4115 ExitedPad = ExitedParent; 4116 } while (!isa<ConstantTokenNone>(ExitedPad)); 4117 } else { 4118 // Unwinding to caller exits all pads. 4119 UnwindPad = ConstantTokenNone::get(FPI.getContext()); 4120 ExitsFPI = true; 4121 UnresolvedAncestorPad = &FPI; 4122 } 4123 4124 if (ExitsFPI) { 4125 // This unwind edge exits FPI. Make sure it agrees with other 4126 // such edges. 4127 if (FirstUser) { 4128 Assert(UnwindPad == FirstUnwindPad, "Unwind edges out of a funclet " 4129 "pad must have the same unwind " 4130 "dest", 4131 &FPI, U, FirstUser); 4132 } else { 4133 FirstUser = U; 4134 FirstUnwindPad = UnwindPad; 4135 // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds 4136 if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) && 4137 getParentPad(UnwindPad) == getParentPad(&FPI)) 4138 SiblingFuncletInfo[&FPI] = cast<Instruction>(U); 4139 } 4140 } 4141 // Make sure we visit all uses of FPI, but for nested pads stop as 4142 // soon as we know where they unwind to. 4143 if (CurrentPad != &FPI) 4144 break; 4145 } 4146 if (UnresolvedAncestorPad) { 4147 if (CurrentPad == UnresolvedAncestorPad) { 4148 // When CurrentPad is FPI itself, we don't mark it as resolved even if 4149 // we've found an unwind edge that exits it, because we need to verify 4150 // all direct uses of FPI. 4151 assert(CurrentPad == &FPI); 4152 continue; 4153 } 4154 // Pop off the worklist any nested pads that we've found an unwind 4155 // destination for. The pads on the worklist are the uncles, 4156 // great-uncles, etc. of CurrentPad. We've found an unwind destination 4157 // for all ancestors of CurrentPad up to but not including 4158 // UnresolvedAncestorPad. 4159 Value *ResolvedPad = CurrentPad; 4160 while (!Worklist.empty()) { 4161 Value *UnclePad = Worklist.back(); 4162 Value *AncestorPad = getParentPad(UnclePad); 4163 // Walk ResolvedPad up the ancestor list until we either find the 4164 // uncle's parent or the last resolved ancestor. 4165 while (ResolvedPad != AncestorPad) { 4166 Value *ResolvedParent = getParentPad(ResolvedPad); 4167 if (ResolvedParent == UnresolvedAncestorPad) { 4168 break; 4169 } 4170 ResolvedPad = ResolvedParent; 4171 } 4172 // If the resolved ancestor search didn't find the uncle's parent, 4173 // then the uncle is not yet resolved. 4174 if (ResolvedPad != AncestorPad) 4175 break; 4176 // This uncle is resolved, so pop it from the worklist. 4177 Worklist.pop_back(); 4178 } 4179 } 4180 } 4181 4182 if (FirstUnwindPad) { 4183 if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) { 4184 BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest(); 4185 Value *SwitchUnwindPad; 4186 if (SwitchUnwindDest) 4187 SwitchUnwindPad = SwitchUnwindDest->getFirstNonPHI(); 4188 else 4189 SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext()); 4190 Assert(SwitchUnwindPad == FirstUnwindPad, 4191 "Unwind edges out of a catch must have the same unwind dest as " 4192 "the parent catchswitch", 4193 &FPI, FirstUser, CatchSwitch); 4194 } 4195 } 4196 4197 visitInstruction(FPI); 4198 } 4199 4200 void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) { 4201 BasicBlock *BB = CatchSwitch.getParent(); 4202 4203 Function *F = BB->getParent(); 4204 Assert(F->hasPersonalityFn(), 4205 "CatchSwitchInst needs to be in a function with a personality.", 4206 &CatchSwitch); 4207 4208 // The catchswitch instruction must be the first non-PHI instruction in the 4209 // block. 4210 Assert(BB->getFirstNonPHI() == &CatchSwitch, 4211 "CatchSwitchInst not the first non-PHI instruction in the block.", 4212 &CatchSwitch); 4213 4214 auto *ParentPad = CatchSwitch.getParentPad(); 4215 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad), 4216 "CatchSwitchInst has an invalid parent.", ParentPad); 4217 4218 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) { 4219 Instruction *I = UnwindDest->getFirstNonPHI(); 4220 Assert(I->isEHPad() && !isa<LandingPadInst>(I), 4221 "CatchSwitchInst must unwind to an EH block which is not a " 4222 "landingpad.", 4223 &CatchSwitch); 4224 4225 // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds 4226 if (getParentPad(I) == ParentPad) 4227 SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch; 4228 } 4229 4230 Assert(CatchSwitch.getNumHandlers() != 0, 4231 "CatchSwitchInst cannot have empty handler list", &CatchSwitch); 4232 4233 for (BasicBlock *Handler : CatchSwitch.handlers()) { 4234 Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()), 4235 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler); 4236 } 4237 4238 visitEHPadPredecessors(CatchSwitch); 4239 visitTerminator(CatchSwitch); 4240 } 4241 4242 void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) { 4243 Assert(isa<CleanupPadInst>(CRI.getOperand(0)), 4244 "CleanupReturnInst needs to be provided a CleanupPad", &CRI, 4245 CRI.getOperand(0)); 4246 4247 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) { 4248 Instruction *I = UnwindDest->getFirstNonPHI(); 4249 Assert(I->isEHPad() && !isa<LandingPadInst>(I), 4250 "CleanupReturnInst must unwind to an EH block which is not a " 4251 "landingpad.", 4252 &CRI); 4253 } 4254 4255 visitTerminator(CRI); 4256 } 4257 4258 void Verifier::verifyDominatesUse(Instruction &I, unsigned i) { 4259 Instruction *Op = cast<Instruction>(I.getOperand(i)); 4260 // If the we have an invalid invoke, don't try to compute the dominance. 4261 // We already reject it in the invoke specific checks and the dominance 4262 // computation doesn't handle multiple edges. 4263 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) { 4264 if (II->getNormalDest() == II->getUnwindDest()) 4265 return; 4266 } 4267 4268 // Quick check whether the def has already been encountered in the same block. 4269 // PHI nodes are not checked to prevent accepting preceding PHIs, because PHI 4270 // uses are defined to happen on the incoming edge, not at the instruction. 4271 // 4272 // FIXME: If this operand is a MetadataAsValue (wrapping a LocalAsMetadata) 4273 // wrapping an SSA value, assert that we've already encountered it. See 4274 // related FIXME in Mapper::mapLocalAsMetadata in ValueMapper.cpp. 4275 if (!isa<PHINode>(I) && InstsInThisBlock.count(Op)) 4276 return; 4277 4278 const Use &U = I.getOperandUse(i); 4279 Assert(DT.dominates(Op, U), 4280 "Instruction does not dominate all uses!", Op, &I); 4281 } 4282 4283 void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) { 4284 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null " 4285 "apply only to pointer types", &I); 4286 Assert((isa<LoadInst>(I) || isa<IntToPtrInst>(I)), 4287 "dereferenceable, dereferenceable_or_null apply only to load" 4288 " and inttoptr instructions, use attributes for calls or invokes", &I); 4289 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null " 4290 "take one operand!", &I); 4291 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0)); 4292 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, " 4293 "dereferenceable_or_null metadata value must be an i64!", &I); 4294 } 4295 4296 void Verifier::visitProfMetadata(Instruction &I, MDNode *MD) { 4297 Assert(MD->getNumOperands() >= 2, 4298 "!prof annotations should have no less than 2 operands", MD); 4299 4300 // Check first operand. 4301 Assert(MD->getOperand(0) != nullptr, "first operand should not be null", MD); 4302 Assert(isa<MDString>(MD->getOperand(0)), 4303 "expected string with name of the !prof annotation", MD); 4304 MDString *MDS = cast<MDString>(MD->getOperand(0)); 4305 StringRef ProfName = MDS->getString(); 4306 4307 // Check consistency of !prof branch_weights metadata. 4308 if (ProfName.equals("branch_weights")) { 4309 if (isa<InvokeInst>(&I)) { 4310 Assert(MD->getNumOperands() == 2 || MD->getNumOperands() == 3, 4311 "Wrong number of InvokeInst branch_weights operands", MD); 4312 } else { 4313 unsigned ExpectedNumOperands = 0; 4314 if (BranchInst *BI = dyn_cast<BranchInst>(&I)) 4315 ExpectedNumOperands = BI->getNumSuccessors(); 4316 else if (SwitchInst *SI = dyn_cast<SwitchInst>(&I)) 4317 ExpectedNumOperands = SI->getNumSuccessors(); 4318 else if (isa<CallInst>(&I)) 4319 ExpectedNumOperands = 1; 4320 else if (IndirectBrInst *IBI = dyn_cast<IndirectBrInst>(&I)) 4321 ExpectedNumOperands = IBI->getNumDestinations(); 4322 else if (isa<SelectInst>(&I)) 4323 ExpectedNumOperands = 2; 4324 else 4325 CheckFailed("!prof branch_weights are not allowed for this instruction", 4326 MD); 4327 4328 Assert(MD->getNumOperands() == 1 + ExpectedNumOperands, 4329 "Wrong number of operands", MD); 4330 } 4331 for (unsigned i = 1; i < MD->getNumOperands(); ++i) { 4332 auto &MDO = MD->getOperand(i); 4333 Assert(MDO, "second operand should not be null", MD); 4334 Assert(mdconst::dyn_extract<ConstantInt>(MDO), 4335 "!prof brunch_weights operand is not a const int"); 4336 } 4337 } 4338 } 4339 4340 void Verifier::visitAnnotationMetadata(MDNode *Annotation) { 4341 Assert(isa<MDTuple>(Annotation), "annotation must be a tuple"); 4342 Assert(Annotation->getNumOperands() >= 1, 4343 "annotation must have at least one operand"); 4344 for (const MDOperand &Op : Annotation->operands()) 4345 Assert(isa<MDString>(Op.get()), "operands must be strings"); 4346 } 4347 4348 /// verifyInstruction - Verify that an instruction is well formed. 4349 /// 4350 void Verifier::visitInstruction(Instruction &I) { 4351 BasicBlock *BB = I.getParent(); 4352 Assert(BB, "Instruction not embedded in basic block!", &I); 4353 4354 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential 4355 for (User *U : I.users()) { 4356 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB), 4357 "Only PHI nodes may reference their own value!", &I); 4358 } 4359 } 4360 4361 // Check that void typed values don't have names 4362 Assert(!I.getType()->isVoidTy() || !I.hasName(), 4363 "Instruction has a name, but provides a void value!", &I); 4364 4365 // Check that the return value of the instruction is either void or a legal 4366 // value type. 4367 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(), 4368 "Instruction returns a non-scalar type!", &I); 4369 4370 // Check that the instruction doesn't produce metadata. Calls are already 4371 // checked against the callee type. 4372 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I), 4373 "Invalid use of metadata!", &I); 4374 4375 // Check that all uses of the instruction, if they are instructions 4376 // themselves, actually have parent basic blocks. If the use is not an 4377 // instruction, it is an error! 4378 for (Use &U : I.uses()) { 4379 if (Instruction *Used = dyn_cast<Instruction>(U.getUser())) 4380 Assert(Used->getParent() != nullptr, 4381 "Instruction referencing" 4382 " instruction not embedded in a basic block!", 4383 &I, Used); 4384 else { 4385 CheckFailed("Use of instruction is not an instruction!", U); 4386 return; 4387 } 4388 } 4389 4390 // Get a pointer to the call base of the instruction if it is some form of 4391 // call. 4392 const CallBase *CBI = dyn_cast<CallBase>(&I); 4393 4394 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) { 4395 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I); 4396 4397 // Check to make sure that only first-class-values are operands to 4398 // instructions. 4399 if (!I.getOperand(i)->getType()->isFirstClassType()) { 4400 Assert(false, "Instruction operands must be first-class values!", &I); 4401 } 4402 4403 if (Function *F = dyn_cast<Function>(I.getOperand(i))) { 4404 // Check to make sure that the "address of" an intrinsic function is never 4405 // taken. 4406 Assert(!F->isIntrinsic() || 4407 (CBI && &CBI->getCalledOperandUse() == &I.getOperandUse(i)), 4408 "Cannot take the address of an intrinsic!", &I); 4409 Assert( 4410 !F->isIntrinsic() || isa<CallInst>(I) || 4411 F->getIntrinsicID() == Intrinsic::donothing || 4412 F->getIntrinsicID() == Intrinsic::seh_try_begin || 4413 F->getIntrinsicID() == Intrinsic::seh_try_end || 4414 F->getIntrinsicID() == Intrinsic::seh_scope_begin || 4415 F->getIntrinsicID() == Intrinsic::seh_scope_end || 4416 F->getIntrinsicID() == Intrinsic::coro_resume || 4417 F->getIntrinsicID() == Intrinsic::coro_destroy || 4418 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void || 4419 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 || 4420 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint || 4421 F->getIntrinsicID() == Intrinsic::wasm_rethrow, 4422 "Cannot invoke an intrinsic other than donothing, patchpoint, " 4423 "statepoint, coro_resume or coro_destroy", 4424 &I); 4425 Assert(F->getParent() == &M, "Referencing function in another module!", 4426 &I, &M, F, F->getParent()); 4427 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) { 4428 Assert(OpBB->getParent() == BB->getParent(), 4429 "Referring to a basic block in another function!", &I); 4430 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) { 4431 Assert(OpArg->getParent() == BB->getParent(), 4432 "Referring to an argument in another function!", &I); 4433 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) { 4434 Assert(GV->getParent() == &M, "Referencing global in another module!", &I, 4435 &M, GV, GV->getParent()); 4436 } else if (isa<Instruction>(I.getOperand(i))) { 4437 verifyDominatesUse(I, i); 4438 } else if (isa<InlineAsm>(I.getOperand(i))) { 4439 Assert(CBI && &CBI->getCalledOperandUse() == &I.getOperandUse(i), 4440 "Cannot take the address of an inline asm!", &I); 4441 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) { 4442 if (CE->getType()->isPtrOrPtrVectorTy()) { 4443 // If we have a ConstantExpr pointer, we need to see if it came from an 4444 // illegal bitcast. 4445 visitConstantExprsRecursively(CE); 4446 } 4447 } 4448 } 4449 4450 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) { 4451 Assert(I.getType()->isFPOrFPVectorTy(), 4452 "fpmath requires a floating point result!", &I); 4453 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I); 4454 if (ConstantFP *CFP0 = 4455 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) { 4456 const APFloat &Accuracy = CFP0->getValueAPF(); 4457 Assert(&Accuracy.getSemantics() == &APFloat::IEEEsingle(), 4458 "fpmath accuracy must have float type", &I); 4459 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(), 4460 "fpmath accuracy not a positive number!", &I); 4461 } else { 4462 Assert(false, "invalid fpmath accuracy!", &I); 4463 } 4464 } 4465 4466 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) { 4467 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I), 4468 "Ranges are only for loads, calls and invokes!", &I); 4469 visitRangeMetadata(I, Range, I.getType()); 4470 } 4471 4472 if (I.getMetadata(LLVMContext::MD_nonnull)) { 4473 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types", 4474 &I); 4475 Assert(isa<LoadInst>(I), 4476 "nonnull applies only to load instructions, use attributes" 4477 " for calls or invokes", 4478 &I); 4479 } 4480 4481 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable)) 4482 visitDereferenceableMetadata(I, MD); 4483 4484 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null)) 4485 visitDereferenceableMetadata(I, MD); 4486 4487 if (MDNode *TBAA = I.getMetadata(LLVMContext::MD_tbaa)) 4488 TBAAVerifyHelper.visitTBAAMetadata(I, TBAA); 4489 4490 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) { 4491 Assert(I.getType()->isPointerTy(), "align applies only to pointer types", 4492 &I); 4493 Assert(isa<LoadInst>(I), "align applies only to load instructions, " 4494 "use attributes for calls or invokes", &I); 4495 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I); 4496 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0)); 4497 Assert(CI && CI->getType()->isIntegerTy(64), 4498 "align metadata value must be an i64!", &I); 4499 uint64_t Align = CI->getZExtValue(); 4500 Assert(isPowerOf2_64(Align), 4501 "align metadata value must be a power of 2!", &I); 4502 Assert(Align <= Value::MaximumAlignment, 4503 "alignment is larger that implementation defined limit", &I); 4504 } 4505 4506 if (MDNode *MD = I.getMetadata(LLVMContext::MD_prof)) 4507 visitProfMetadata(I, MD); 4508 4509 if (MDNode *Annotation = I.getMetadata(LLVMContext::MD_annotation)) 4510 visitAnnotationMetadata(Annotation); 4511 4512 if (MDNode *N = I.getDebugLoc().getAsMDNode()) { 4513 AssertDI(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N); 4514 visitMDNode(*N, AreDebugLocsAllowed::Yes); 4515 } 4516 4517 if (auto *DII = dyn_cast<DbgVariableIntrinsic>(&I)) { 4518 verifyFragmentExpression(*DII); 4519 verifyNotEntryValue(*DII); 4520 } 4521 4522 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs; 4523 I.getAllMetadata(MDs); 4524 for (auto Attachment : MDs) { 4525 unsigned Kind = Attachment.first; 4526 auto AllowLocs = 4527 (Kind == LLVMContext::MD_dbg || Kind == LLVMContext::MD_loop) 4528 ? AreDebugLocsAllowed::Yes 4529 : AreDebugLocsAllowed::No; 4530 visitMDNode(*Attachment.second, AllowLocs); 4531 } 4532 4533 InstsInThisBlock.insert(&I); 4534 } 4535 4536 /// Allow intrinsics to be verified in different ways. 4537 void Verifier::visitIntrinsicCall(Intrinsic::ID ID, CallBase &Call) { 4538 Function *IF = Call.getCalledFunction(); 4539 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!", 4540 IF); 4541 4542 // Verify that the intrinsic prototype lines up with what the .td files 4543 // describe. 4544 FunctionType *IFTy = IF->getFunctionType(); 4545 bool IsVarArg = IFTy->isVarArg(); 4546 4547 SmallVector<Intrinsic::IITDescriptor, 8> Table; 4548 getIntrinsicInfoTableEntries(ID, Table); 4549 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table; 4550 4551 // Walk the descriptors to extract overloaded types. 4552 SmallVector<Type *, 4> ArgTys; 4553 Intrinsic::MatchIntrinsicTypesResult Res = 4554 Intrinsic::matchIntrinsicSignature(IFTy, TableRef, ArgTys); 4555 Assert(Res != Intrinsic::MatchIntrinsicTypes_NoMatchRet, 4556 "Intrinsic has incorrect return type!", IF); 4557 Assert(Res != Intrinsic::MatchIntrinsicTypes_NoMatchArg, 4558 "Intrinsic has incorrect argument type!", IF); 4559 4560 // Verify if the intrinsic call matches the vararg property. 4561 if (IsVarArg) 4562 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef), 4563 "Intrinsic was not defined with variable arguments!", IF); 4564 else 4565 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef), 4566 "Callsite was not defined with variable arguments!", IF); 4567 4568 // All descriptors should be absorbed by now. 4569 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF); 4570 4571 // Now that we have the intrinsic ID and the actual argument types (and we 4572 // know they are legal for the intrinsic!) get the intrinsic name through the 4573 // usual means. This allows us to verify the mangling of argument types into 4574 // the name. 4575 const std::string ExpectedName = 4576 Intrinsic::getName(ID, ArgTys, IF->getParent(), IFTy); 4577 Assert(ExpectedName == IF->getName(), 4578 "Intrinsic name not mangled correctly for type arguments! " 4579 "Should be: " + 4580 ExpectedName, 4581 IF); 4582 4583 // If the intrinsic takes MDNode arguments, verify that they are either global 4584 // or are local to *this* function. 4585 for (Value *V : Call.args()) { 4586 if (auto *MD = dyn_cast<MetadataAsValue>(V)) 4587 visitMetadataAsValue(*MD, Call.getCaller()); 4588 if (auto *Const = dyn_cast<Constant>(V)) 4589 Assert(!Const->getType()->isX86_AMXTy(), 4590 "const x86_amx is not allowed in argument!"); 4591 } 4592 4593 switch (ID) { 4594 default: 4595 break; 4596 case Intrinsic::assume: { 4597 for (auto &Elem : Call.bundle_op_infos()) { 4598 Assert(Elem.Tag->getKey() == "ignore" || 4599 Attribute::isExistingAttribute(Elem.Tag->getKey()), 4600 "tags must be valid attribute names"); 4601 Attribute::AttrKind Kind = 4602 Attribute::getAttrKindFromName(Elem.Tag->getKey()); 4603 unsigned ArgCount = Elem.End - Elem.Begin; 4604 if (Kind == Attribute::Alignment) { 4605 Assert(ArgCount <= 3 && ArgCount >= 2, 4606 "alignment assumptions should have 2 or 3 arguments"); 4607 Assert(Call.getOperand(Elem.Begin)->getType()->isPointerTy(), 4608 "first argument should be a pointer"); 4609 Assert(Call.getOperand(Elem.Begin + 1)->getType()->isIntegerTy(), 4610 "second argument should be an integer"); 4611 if (ArgCount == 3) 4612 Assert(Call.getOperand(Elem.Begin + 2)->getType()->isIntegerTy(), 4613 "third argument should be an integer if present"); 4614 return; 4615 } 4616 Assert(ArgCount <= 2, "to many arguments"); 4617 if (Kind == Attribute::None) 4618 break; 4619 if (Attribute::isIntAttrKind(Kind)) { 4620 Assert(ArgCount == 2, "this attribute should have 2 arguments"); 4621 Assert(isa<ConstantInt>(Call.getOperand(Elem.Begin + 1)), 4622 "the second argument should be a constant integral value"); 4623 } else if (Attribute::canUseAsParamAttr(Kind)) { 4624 Assert((ArgCount) == 1, "this attribute should have one argument"); 4625 } else if (Attribute::canUseAsFnAttr(Kind)) { 4626 Assert((ArgCount) == 0, "this attribute has no argument"); 4627 } 4628 } 4629 break; 4630 } 4631 case Intrinsic::coro_id: { 4632 auto *InfoArg = Call.getArgOperand(3)->stripPointerCasts(); 4633 if (isa<ConstantPointerNull>(InfoArg)) 4634 break; 4635 auto *GV = dyn_cast<GlobalVariable>(InfoArg); 4636 Assert(GV && GV->isConstant() && GV->hasDefinitiveInitializer(), 4637 "info argument of llvm.coro.id must refer to an initialized " 4638 "constant"); 4639 Constant *Init = GV->getInitializer(); 4640 Assert(isa<ConstantStruct>(Init) || isa<ConstantArray>(Init), 4641 "info argument of llvm.coro.id must refer to either a struct or " 4642 "an array"); 4643 break; 4644 } 4645 #define INSTRUCTION(NAME, NARGS, ROUND_MODE, INTRINSIC) \ 4646 case Intrinsic::INTRINSIC: 4647 #include "llvm/IR/ConstrainedOps.def" 4648 visitConstrainedFPIntrinsic(cast<ConstrainedFPIntrinsic>(Call)); 4649 break; 4650 case Intrinsic::dbg_declare: // llvm.dbg.declare 4651 Assert(isa<MetadataAsValue>(Call.getArgOperand(0)), 4652 "invalid llvm.dbg.declare intrinsic call 1", Call); 4653 visitDbgIntrinsic("declare", cast<DbgVariableIntrinsic>(Call)); 4654 break; 4655 case Intrinsic::dbg_addr: // llvm.dbg.addr 4656 visitDbgIntrinsic("addr", cast<DbgVariableIntrinsic>(Call)); 4657 break; 4658 case Intrinsic::dbg_value: // llvm.dbg.value 4659 visitDbgIntrinsic("value", cast<DbgVariableIntrinsic>(Call)); 4660 break; 4661 case Intrinsic::dbg_label: // llvm.dbg.label 4662 visitDbgLabelIntrinsic("label", cast<DbgLabelInst>(Call)); 4663 break; 4664 case Intrinsic::memcpy: 4665 case Intrinsic::memcpy_inline: 4666 case Intrinsic::memmove: 4667 case Intrinsic::memset: { 4668 const auto *MI = cast<MemIntrinsic>(&Call); 4669 auto IsValidAlignment = [&](unsigned Alignment) -> bool { 4670 return Alignment == 0 || isPowerOf2_32(Alignment); 4671 }; 4672 Assert(IsValidAlignment(MI->getDestAlignment()), 4673 "alignment of arg 0 of memory intrinsic must be 0 or a power of 2", 4674 Call); 4675 if (const auto *MTI = dyn_cast<MemTransferInst>(MI)) { 4676 Assert(IsValidAlignment(MTI->getSourceAlignment()), 4677 "alignment of arg 1 of memory intrinsic must be 0 or a power of 2", 4678 Call); 4679 } 4680 4681 break; 4682 } 4683 case Intrinsic::memcpy_element_unordered_atomic: 4684 case Intrinsic::memmove_element_unordered_atomic: 4685 case Intrinsic::memset_element_unordered_atomic: { 4686 const auto *AMI = cast<AtomicMemIntrinsic>(&Call); 4687 4688 ConstantInt *ElementSizeCI = 4689 cast<ConstantInt>(AMI->getRawElementSizeInBytes()); 4690 const APInt &ElementSizeVal = ElementSizeCI->getValue(); 4691 Assert(ElementSizeVal.isPowerOf2(), 4692 "element size of the element-wise atomic memory intrinsic " 4693 "must be a power of 2", 4694 Call); 4695 4696 auto IsValidAlignment = [&](uint64_t Alignment) { 4697 return isPowerOf2_64(Alignment) && ElementSizeVal.ule(Alignment); 4698 }; 4699 uint64_t DstAlignment = AMI->getDestAlignment(); 4700 Assert(IsValidAlignment(DstAlignment), 4701 "incorrect alignment of the destination argument", Call); 4702 if (const auto *AMT = dyn_cast<AtomicMemTransferInst>(AMI)) { 4703 uint64_t SrcAlignment = AMT->getSourceAlignment(); 4704 Assert(IsValidAlignment(SrcAlignment), 4705 "incorrect alignment of the source argument", Call); 4706 } 4707 break; 4708 } 4709 case Intrinsic::call_preallocated_setup: { 4710 auto *NumArgs = dyn_cast<ConstantInt>(Call.getArgOperand(0)); 4711 Assert(NumArgs != nullptr, 4712 "llvm.call.preallocated.setup argument must be a constant"); 4713 bool FoundCall = false; 4714 for (User *U : Call.users()) { 4715 auto *UseCall = dyn_cast<CallBase>(U); 4716 Assert(UseCall != nullptr, 4717 "Uses of llvm.call.preallocated.setup must be calls"); 4718 const Function *Fn = UseCall->getCalledFunction(); 4719 if (Fn && Fn->getIntrinsicID() == Intrinsic::call_preallocated_arg) { 4720 auto *AllocArgIndex = dyn_cast<ConstantInt>(UseCall->getArgOperand(1)); 4721 Assert(AllocArgIndex != nullptr, 4722 "llvm.call.preallocated.alloc arg index must be a constant"); 4723 auto AllocArgIndexInt = AllocArgIndex->getValue(); 4724 Assert(AllocArgIndexInt.sge(0) && 4725 AllocArgIndexInt.slt(NumArgs->getValue()), 4726 "llvm.call.preallocated.alloc arg index must be between 0 and " 4727 "corresponding " 4728 "llvm.call.preallocated.setup's argument count"); 4729 } else if (Fn && Fn->getIntrinsicID() == 4730 Intrinsic::call_preallocated_teardown) { 4731 // nothing to do 4732 } else { 4733 Assert(!FoundCall, "Can have at most one call corresponding to a " 4734 "llvm.call.preallocated.setup"); 4735 FoundCall = true; 4736 size_t NumPreallocatedArgs = 0; 4737 for (unsigned i = 0; i < UseCall->getNumArgOperands(); i++) { 4738 if (UseCall->paramHasAttr(i, Attribute::Preallocated)) { 4739 ++NumPreallocatedArgs; 4740 } 4741 } 4742 Assert(NumPreallocatedArgs != 0, 4743 "cannot use preallocated intrinsics on a call without " 4744 "preallocated arguments"); 4745 Assert(NumArgs->equalsInt(NumPreallocatedArgs), 4746 "llvm.call.preallocated.setup arg size must be equal to number " 4747 "of preallocated arguments " 4748 "at call site", 4749 Call, *UseCall); 4750 // getOperandBundle() cannot be called if more than one of the operand 4751 // bundle exists. There is already a check elsewhere for this, so skip 4752 // here if we see more than one. 4753 if (UseCall->countOperandBundlesOfType(LLVMContext::OB_preallocated) > 4754 1) { 4755 return; 4756 } 4757 auto PreallocatedBundle = 4758 UseCall->getOperandBundle(LLVMContext::OB_preallocated); 4759 Assert(PreallocatedBundle, 4760 "Use of llvm.call.preallocated.setup outside intrinsics " 4761 "must be in \"preallocated\" operand bundle"); 4762 Assert(PreallocatedBundle->Inputs.front().get() == &Call, 4763 "preallocated bundle must have token from corresponding " 4764 "llvm.call.preallocated.setup"); 4765 } 4766 } 4767 break; 4768 } 4769 case Intrinsic::call_preallocated_arg: { 4770 auto *Token = dyn_cast<CallBase>(Call.getArgOperand(0)); 4771 Assert(Token && Token->getCalledFunction()->getIntrinsicID() == 4772 Intrinsic::call_preallocated_setup, 4773 "llvm.call.preallocated.arg token argument must be a " 4774 "llvm.call.preallocated.setup"); 4775 Assert(Call.hasFnAttr(Attribute::Preallocated), 4776 "llvm.call.preallocated.arg must be called with a \"preallocated\" " 4777 "call site attribute"); 4778 break; 4779 } 4780 case Intrinsic::call_preallocated_teardown: { 4781 auto *Token = dyn_cast<CallBase>(Call.getArgOperand(0)); 4782 Assert(Token && Token->getCalledFunction()->getIntrinsicID() == 4783 Intrinsic::call_preallocated_setup, 4784 "llvm.call.preallocated.teardown token argument must be a " 4785 "llvm.call.preallocated.setup"); 4786 break; 4787 } 4788 case Intrinsic::gcroot: 4789 case Intrinsic::gcwrite: 4790 case Intrinsic::gcread: 4791 if (ID == Intrinsic::gcroot) { 4792 AllocaInst *AI = 4793 dyn_cast<AllocaInst>(Call.getArgOperand(0)->stripPointerCasts()); 4794 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", Call); 4795 Assert(isa<Constant>(Call.getArgOperand(1)), 4796 "llvm.gcroot parameter #2 must be a constant.", Call); 4797 if (!AI->getAllocatedType()->isPointerTy()) { 4798 Assert(!isa<ConstantPointerNull>(Call.getArgOperand(1)), 4799 "llvm.gcroot parameter #1 must either be a pointer alloca, " 4800 "or argument #2 must be a non-null constant.", 4801 Call); 4802 } 4803 } 4804 4805 Assert(Call.getParent()->getParent()->hasGC(), 4806 "Enclosing function does not use GC.", Call); 4807 break; 4808 case Intrinsic::init_trampoline: 4809 Assert(isa<Function>(Call.getArgOperand(1)->stripPointerCasts()), 4810 "llvm.init_trampoline parameter #2 must resolve to a function.", 4811 Call); 4812 break; 4813 case Intrinsic::prefetch: 4814 Assert(cast<ConstantInt>(Call.getArgOperand(1))->getZExtValue() < 2 && 4815 cast<ConstantInt>(Call.getArgOperand(2))->getZExtValue() < 4, 4816 "invalid arguments to llvm.prefetch", Call); 4817 break; 4818 case Intrinsic::stackprotector: 4819 Assert(isa<AllocaInst>(Call.getArgOperand(1)->stripPointerCasts()), 4820 "llvm.stackprotector parameter #2 must resolve to an alloca.", Call); 4821 break; 4822 case Intrinsic::localescape: { 4823 BasicBlock *BB = Call.getParent(); 4824 Assert(BB == &BB->getParent()->front(), 4825 "llvm.localescape used outside of entry block", Call); 4826 Assert(!SawFrameEscape, 4827 "multiple calls to llvm.localescape in one function", Call); 4828 for (Value *Arg : Call.args()) { 4829 if (isa<ConstantPointerNull>(Arg)) 4830 continue; // Null values are allowed as placeholders. 4831 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts()); 4832 Assert(AI && AI->isStaticAlloca(), 4833 "llvm.localescape only accepts static allocas", Call); 4834 } 4835 FrameEscapeInfo[BB->getParent()].first = Call.getNumArgOperands(); 4836 SawFrameEscape = true; 4837 break; 4838 } 4839 case Intrinsic::localrecover: { 4840 Value *FnArg = Call.getArgOperand(0)->stripPointerCasts(); 4841 Function *Fn = dyn_cast<Function>(FnArg); 4842 Assert(Fn && !Fn->isDeclaration(), 4843 "llvm.localrecover first " 4844 "argument must be function defined in this module", 4845 Call); 4846 auto *IdxArg = cast<ConstantInt>(Call.getArgOperand(2)); 4847 auto &Entry = FrameEscapeInfo[Fn]; 4848 Entry.second = unsigned( 4849 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1)); 4850 break; 4851 } 4852 4853 case Intrinsic::experimental_gc_statepoint: 4854 if (auto *CI = dyn_cast<CallInst>(&Call)) 4855 Assert(!CI->isInlineAsm(), 4856 "gc.statepoint support for inline assembly unimplemented", CI); 4857 Assert(Call.getParent()->getParent()->hasGC(), 4858 "Enclosing function does not use GC.", Call); 4859 4860 verifyStatepoint(Call); 4861 break; 4862 case Intrinsic::experimental_gc_result: { 4863 Assert(Call.getParent()->getParent()->hasGC(), 4864 "Enclosing function does not use GC.", Call); 4865 // Are we tied to a statepoint properly? 4866 const auto *StatepointCall = dyn_cast<CallBase>(Call.getArgOperand(0)); 4867 const Function *StatepointFn = 4868 StatepointCall ? StatepointCall->getCalledFunction() : nullptr; 4869 Assert(StatepointFn && StatepointFn->isDeclaration() && 4870 StatepointFn->getIntrinsicID() == 4871 Intrinsic::experimental_gc_statepoint, 4872 "gc.result operand #1 must be from a statepoint", Call, 4873 Call.getArgOperand(0)); 4874 4875 // Assert that result type matches wrapped callee. 4876 const Value *Target = StatepointCall->getArgOperand(2); 4877 auto *PT = cast<PointerType>(Target->getType()); 4878 auto *TargetFuncType = cast<FunctionType>(PT->getElementType()); 4879 Assert(Call.getType() == TargetFuncType->getReturnType(), 4880 "gc.result result type does not match wrapped callee", Call); 4881 break; 4882 } 4883 case Intrinsic::experimental_gc_relocate: { 4884 Assert(Call.getNumArgOperands() == 3, "wrong number of arguments", Call); 4885 4886 Assert(isa<PointerType>(Call.getType()->getScalarType()), 4887 "gc.relocate must return a pointer or a vector of pointers", Call); 4888 4889 // Check that this relocate is correctly tied to the statepoint 4890 4891 // This is case for relocate on the unwinding path of an invoke statepoint 4892 if (LandingPadInst *LandingPad = 4893 dyn_cast<LandingPadInst>(Call.getArgOperand(0))) { 4894 4895 const BasicBlock *InvokeBB = 4896 LandingPad->getParent()->getUniquePredecessor(); 4897 4898 // Landingpad relocates should have only one predecessor with invoke 4899 // statepoint terminator 4900 Assert(InvokeBB, "safepoints should have unique landingpads", 4901 LandingPad->getParent()); 4902 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed", 4903 InvokeBB); 4904 Assert(isa<GCStatepointInst>(InvokeBB->getTerminator()), 4905 "gc relocate should be linked to a statepoint", InvokeBB); 4906 } else { 4907 // In all other cases relocate should be tied to the statepoint directly. 4908 // This covers relocates on a normal return path of invoke statepoint and 4909 // relocates of a call statepoint. 4910 auto Token = Call.getArgOperand(0); 4911 Assert(isa<GCStatepointInst>(Token), 4912 "gc relocate is incorrectly tied to the statepoint", Call, Token); 4913 } 4914 4915 // Verify rest of the relocate arguments. 4916 const CallBase &StatepointCall = 4917 *cast<GCRelocateInst>(Call).getStatepoint(); 4918 4919 // Both the base and derived must be piped through the safepoint. 4920 Value *Base = Call.getArgOperand(1); 4921 Assert(isa<ConstantInt>(Base), 4922 "gc.relocate operand #2 must be integer offset", Call); 4923 4924 Value *Derived = Call.getArgOperand(2); 4925 Assert(isa<ConstantInt>(Derived), 4926 "gc.relocate operand #3 must be integer offset", Call); 4927 4928 const uint64_t BaseIndex = cast<ConstantInt>(Base)->getZExtValue(); 4929 const uint64_t DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue(); 4930 4931 // Check the bounds 4932 if (auto Opt = StatepointCall.getOperandBundle(LLVMContext::OB_gc_live)) { 4933 Assert(BaseIndex < Opt->Inputs.size(), 4934 "gc.relocate: statepoint base index out of bounds", Call); 4935 Assert(DerivedIndex < Opt->Inputs.size(), 4936 "gc.relocate: statepoint derived index out of bounds", Call); 4937 } 4938 4939 // Relocated value must be either a pointer type or vector-of-pointer type, 4940 // but gc_relocate does not need to return the same pointer type as the 4941 // relocated pointer. It can be casted to the correct type later if it's 4942 // desired. However, they must have the same address space and 'vectorness' 4943 GCRelocateInst &Relocate = cast<GCRelocateInst>(Call); 4944 Assert(Relocate.getDerivedPtr()->getType()->isPtrOrPtrVectorTy(), 4945 "gc.relocate: relocated value must be a gc pointer", Call); 4946 4947 auto ResultType = Call.getType(); 4948 auto DerivedType = Relocate.getDerivedPtr()->getType(); 4949 Assert(ResultType->isVectorTy() == DerivedType->isVectorTy(), 4950 "gc.relocate: vector relocates to vector and pointer to pointer", 4951 Call); 4952 Assert( 4953 ResultType->getPointerAddressSpace() == 4954 DerivedType->getPointerAddressSpace(), 4955 "gc.relocate: relocating a pointer shouldn't change its address space", 4956 Call); 4957 break; 4958 } 4959 case Intrinsic::eh_exceptioncode: 4960 case Intrinsic::eh_exceptionpointer: { 4961 Assert(isa<CatchPadInst>(Call.getArgOperand(0)), 4962 "eh.exceptionpointer argument must be a catchpad", Call); 4963 break; 4964 } 4965 case Intrinsic::get_active_lane_mask: { 4966 Assert(Call.getType()->isVectorTy(), "get_active_lane_mask: must return a " 4967 "vector", Call); 4968 auto *ElemTy = Call.getType()->getScalarType(); 4969 Assert(ElemTy->isIntegerTy(1), "get_active_lane_mask: element type is not " 4970 "i1", Call); 4971 break; 4972 } 4973 case Intrinsic::masked_load: { 4974 Assert(Call.getType()->isVectorTy(), "masked_load: must return a vector", 4975 Call); 4976 4977 Value *Ptr = Call.getArgOperand(0); 4978 ConstantInt *Alignment = cast<ConstantInt>(Call.getArgOperand(1)); 4979 Value *Mask = Call.getArgOperand(2); 4980 Value *PassThru = Call.getArgOperand(3); 4981 Assert(Mask->getType()->isVectorTy(), "masked_load: mask must be vector", 4982 Call); 4983 Assert(Alignment->getValue().isPowerOf2(), 4984 "masked_load: alignment must be a power of 2", Call); 4985 4986 PointerType *PtrTy = cast<PointerType>(Ptr->getType()); 4987 Assert(PtrTy->isOpaqueOrPointeeTypeMatches(Call.getType()), 4988 "masked_load: return must match pointer type", Call); 4989 Assert(PassThru->getType() == Call.getType(), 4990 "masked_load: pass through and return type must match", Call); 4991 Assert(cast<VectorType>(Mask->getType())->getElementCount() == 4992 cast<VectorType>(Call.getType())->getElementCount(), 4993 "masked_load: vector mask must be same length as return", Call); 4994 break; 4995 } 4996 case Intrinsic::masked_store: { 4997 Value *Val = Call.getArgOperand(0); 4998 Value *Ptr = Call.getArgOperand(1); 4999 ConstantInt *Alignment = cast<ConstantInt>(Call.getArgOperand(2)); 5000 Value *Mask = Call.getArgOperand(3); 5001 Assert(Mask->getType()->isVectorTy(), "masked_store: mask must be vector", 5002 Call); 5003 Assert(Alignment->getValue().isPowerOf2(), 5004 "masked_store: alignment must be a power of 2", Call); 5005 5006 PointerType *PtrTy = cast<PointerType>(Ptr->getType()); 5007 Assert(PtrTy->isOpaqueOrPointeeTypeMatches(Val->getType()), 5008 "masked_store: storee must match pointer type", Call); 5009 Assert(cast<VectorType>(Mask->getType())->getElementCount() == 5010 cast<VectorType>(Val->getType())->getElementCount(), 5011 "masked_store: vector mask must be same length as value", Call); 5012 break; 5013 } 5014 5015 case Intrinsic::masked_gather: { 5016 const APInt &Alignment = 5017 cast<ConstantInt>(Call.getArgOperand(1))->getValue(); 5018 Assert(Alignment.isNullValue() || Alignment.isPowerOf2(), 5019 "masked_gather: alignment must be 0 or a power of 2", Call); 5020 break; 5021 } 5022 case Intrinsic::masked_scatter: { 5023 const APInt &Alignment = 5024 cast<ConstantInt>(Call.getArgOperand(2))->getValue(); 5025 Assert(Alignment.isNullValue() || Alignment.isPowerOf2(), 5026 "masked_scatter: alignment must be 0 or a power of 2", Call); 5027 break; 5028 } 5029 5030 case Intrinsic::experimental_guard: { 5031 Assert(isa<CallInst>(Call), "experimental_guard cannot be invoked", Call); 5032 Assert(Call.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1, 5033 "experimental_guard must have exactly one " 5034 "\"deopt\" operand bundle"); 5035 break; 5036 } 5037 5038 case Intrinsic::experimental_deoptimize: { 5039 Assert(isa<CallInst>(Call), "experimental_deoptimize cannot be invoked", 5040 Call); 5041 Assert(Call.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1, 5042 "experimental_deoptimize must have exactly one " 5043 "\"deopt\" operand bundle"); 5044 Assert(Call.getType() == Call.getFunction()->getReturnType(), 5045 "experimental_deoptimize return type must match caller return type"); 5046 5047 if (isa<CallInst>(Call)) { 5048 auto *RI = dyn_cast<ReturnInst>(Call.getNextNode()); 5049 Assert(RI, 5050 "calls to experimental_deoptimize must be followed by a return"); 5051 5052 if (!Call.getType()->isVoidTy() && RI) 5053 Assert(RI->getReturnValue() == &Call, 5054 "calls to experimental_deoptimize must be followed by a return " 5055 "of the value computed by experimental_deoptimize"); 5056 } 5057 5058 break; 5059 } 5060 case Intrinsic::vector_reduce_and: 5061 case Intrinsic::vector_reduce_or: 5062 case Intrinsic::vector_reduce_xor: 5063 case Intrinsic::vector_reduce_add: 5064 case Intrinsic::vector_reduce_mul: 5065 case Intrinsic::vector_reduce_smax: 5066 case Intrinsic::vector_reduce_smin: 5067 case Intrinsic::vector_reduce_umax: 5068 case Intrinsic::vector_reduce_umin: { 5069 Type *ArgTy = Call.getArgOperand(0)->getType(); 5070 Assert(ArgTy->isIntOrIntVectorTy() && ArgTy->isVectorTy(), 5071 "Intrinsic has incorrect argument type!"); 5072 break; 5073 } 5074 case Intrinsic::vector_reduce_fmax: 5075 case Intrinsic::vector_reduce_fmin: { 5076 Type *ArgTy = Call.getArgOperand(0)->getType(); 5077 Assert(ArgTy->isFPOrFPVectorTy() && ArgTy->isVectorTy(), 5078 "Intrinsic has incorrect argument type!"); 5079 break; 5080 } 5081 case Intrinsic::vector_reduce_fadd: 5082 case Intrinsic::vector_reduce_fmul: { 5083 // Unlike the other reductions, the first argument is a start value. The 5084 // second argument is the vector to be reduced. 5085 Type *ArgTy = Call.getArgOperand(1)->getType(); 5086 Assert(ArgTy->isFPOrFPVectorTy() && ArgTy->isVectorTy(), 5087 "Intrinsic has incorrect argument type!"); 5088 break; 5089 } 5090 case Intrinsic::smul_fix: 5091 case Intrinsic::smul_fix_sat: 5092 case Intrinsic::umul_fix: 5093 case Intrinsic::umul_fix_sat: 5094 case Intrinsic::sdiv_fix: 5095 case Intrinsic::sdiv_fix_sat: 5096 case Intrinsic::udiv_fix: 5097 case Intrinsic::udiv_fix_sat: { 5098 Value *Op1 = Call.getArgOperand(0); 5099 Value *Op2 = Call.getArgOperand(1); 5100 Assert(Op1->getType()->isIntOrIntVectorTy(), 5101 "first operand of [us][mul|div]_fix[_sat] must be an int type or " 5102 "vector of ints"); 5103 Assert(Op2->getType()->isIntOrIntVectorTy(), 5104 "second operand of [us][mul|div]_fix[_sat] must be an int type or " 5105 "vector of ints"); 5106 5107 auto *Op3 = cast<ConstantInt>(Call.getArgOperand(2)); 5108 Assert(Op3->getType()->getBitWidth() <= 32, 5109 "third argument of [us][mul|div]_fix[_sat] must fit within 32 bits"); 5110 5111 if (ID == Intrinsic::smul_fix || ID == Intrinsic::smul_fix_sat || 5112 ID == Intrinsic::sdiv_fix || ID == Intrinsic::sdiv_fix_sat) { 5113 Assert( 5114 Op3->getZExtValue() < Op1->getType()->getScalarSizeInBits(), 5115 "the scale of s[mul|div]_fix[_sat] must be less than the width of " 5116 "the operands"); 5117 } else { 5118 Assert(Op3->getZExtValue() <= Op1->getType()->getScalarSizeInBits(), 5119 "the scale of u[mul|div]_fix[_sat] must be less than or equal " 5120 "to the width of the operands"); 5121 } 5122 break; 5123 } 5124 case Intrinsic::lround: 5125 case Intrinsic::llround: 5126 case Intrinsic::lrint: 5127 case Intrinsic::llrint: { 5128 Type *ValTy = Call.getArgOperand(0)->getType(); 5129 Type *ResultTy = Call.getType(); 5130 Assert(!ValTy->isVectorTy() && !ResultTy->isVectorTy(), 5131 "Intrinsic does not support vectors", &Call); 5132 break; 5133 } 5134 case Intrinsic::bswap: { 5135 Type *Ty = Call.getType(); 5136 unsigned Size = Ty->getScalarSizeInBits(); 5137 Assert(Size % 16 == 0, "bswap must be an even number of bytes", &Call); 5138 break; 5139 } 5140 case Intrinsic::invariant_start: { 5141 ConstantInt *InvariantSize = dyn_cast<ConstantInt>(Call.getArgOperand(0)); 5142 Assert(InvariantSize && 5143 (!InvariantSize->isNegative() || InvariantSize->isMinusOne()), 5144 "invariant_start parameter must be -1, 0 or a positive number", 5145 &Call); 5146 break; 5147 } 5148 case Intrinsic::matrix_multiply: 5149 case Intrinsic::matrix_transpose: 5150 case Intrinsic::matrix_column_major_load: 5151 case Intrinsic::matrix_column_major_store: { 5152 Function *IF = Call.getCalledFunction(); 5153 ConstantInt *Stride = nullptr; 5154 ConstantInt *NumRows; 5155 ConstantInt *NumColumns; 5156 VectorType *ResultTy; 5157 Type *Op0ElemTy = nullptr; 5158 Type *Op1ElemTy = nullptr; 5159 switch (ID) { 5160 case Intrinsic::matrix_multiply: 5161 NumRows = cast<ConstantInt>(Call.getArgOperand(2)); 5162 NumColumns = cast<ConstantInt>(Call.getArgOperand(4)); 5163 ResultTy = cast<VectorType>(Call.getType()); 5164 Op0ElemTy = 5165 cast<VectorType>(Call.getArgOperand(0)->getType())->getElementType(); 5166 Op1ElemTy = 5167 cast<VectorType>(Call.getArgOperand(1)->getType())->getElementType(); 5168 break; 5169 case Intrinsic::matrix_transpose: 5170 NumRows = cast<ConstantInt>(Call.getArgOperand(1)); 5171 NumColumns = cast<ConstantInt>(Call.getArgOperand(2)); 5172 ResultTy = cast<VectorType>(Call.getType()); 5173 Op0ElemTy = 5174 cast<VectorType>(Call.getArgOperand(0)->getType())->getElementType(); 5175 break; 5176 case Intrinsic::matrix_column_major_load: 5177 Stride = dyn_cast<ConstantInt>(Call.getArgOperand(1)); 5178 NumRows = cast<ConstantInt>(Call.getArgOperand(3)); 5179 NumColumns = cast<ConstantInt>(Call.getArgOperand(4)); 5180 ResultTy = cast<VectorType>(Call.getType()); 5181 Op0ElemTy = 5182 cast<PointerType>(Call.getArgOperand(0)->getType())->getElementType(); 5183 break; 5184 case Intrinsic::matrix_column_major_store: 5185 Stride = dyn_cast<ConstantInt>(Call.getArgOperand(2)); 5186 NumRows = cast<ConstantInt>(Call.getArgOperand(4)); 5187 NumColumns = cast<ConstantInt>(Call.getArgOperand(5)); 5188 ResultTy = cast<VectorType>(Call.getArgOperand(0)->getType()); 5189 Op0ElemTy = 5190 cast<VectorType>(Call.getArgOperand(0)->getType())->getElementType(); 5191 Op1ElemTy = 5192 cast<PointerType>(Call.getArgOperand(1)->getType())->getElementType(); 5193 break; 5194 default: 5195 llvm_unreachable("unexpected intrinsic"); 5196 } 5197 5198 Assert(ResultTy->getElementType()->isIntegerTy() || 5199 ResultTy->getElementType()->isFloatingPointTy(), 5200 "Result type must be an integer or floating-point type!", IF); 5201 5202 Assert(ResultTy->getElementType() == Op0ElemTy, 5203 "Vector element type mismatch of the result and first operand " 5204 "vector!", IF); 5205 5206 if (Op1ElemTy) 5207 Assert(ResultTy->getElementType() == Op1ElemTy, 5208 "Vector element type mismatch of the result and second operand " 5209 "vector!", IF); 5210 5211 Assert(cast<FixedVectorType>(ResultTy)->getNumElements() == 5212 NumRows->getZExtValue() * NumColumns->getZExtValue(), 5213 "Result of a matrix operation does not fit in the returned vector!"); 5214 5215 if (Stride) 5216 Assert(Stride->getZExtValue() >= NumRows->getZExtValue(), 5217 "Stride must be greater or equal than the number of rows!", IF); 5218 5219 break; 5220 } 5221 case Intrinsic::experimental_stepvector: { 5222 VectorType *VecTy = dyn_cast<VectorType>(Call.getType()); 5223 Assert(VecTy && VecTy->getScalarType()->isIntegerTy() && 5224 VecTy->getScalarSizeInBits() >= 8, 5225 "experimental_stepvector only supported for vectors of integers " 5226 "with a bitwidth of at least 8.", 5227 &Call); 5228 break; 5229 } 5230 case Intrinsic::experimental_vector_insert: { 5231 Value *Vec = Call.getArgOperand(0); 5232 Value *SubVec = Call.getArgOperand(1); 5233 Value *Idx = Call.getArgOperand(2); 5234 unsigned IdxN = cast<ConstantInt>(Idx)->getZExtValue(); 5235 5236 VectorType *VecTy = cast<VectorType>(Vec->getType()); 5237 VectorType *SubVecTy = cast<VectorType>(SubVec->getType()); 5238 5239 ElementCount VecEC = VecTy->getElementCount(); 5240 ElementCount SubVecEC = SubVecTy->getElementCount(); 5241 Assert(VecTy->getElementType() == SubVecTy->getElementType(), 5242 "experimental_vector_insert parameters must have the same element " 5243 "type.", 5244 &Call); 5245 Assert(IdxN % SubVecEC.getKnownMinValue() == 0, 5246 "experimental_vector_insert index must be a constant multiple of " 5247 "the subvector's known minimum vector length."); 5248 5249 // If this insertion is not the 'mixed' case where a fixed vector is 5250 // inserted into a scalable vector, ensure that the insertion of the 5251 // subvector does not overrun the parent vector. 5252 if (VecEC.isScalable() == SubVecEC.isScalable()) { 5253 Assert( 5254 IdxN < VecEC.getKnownMinValue() && 5255 IdxN + SubVecEC.getKnownMinValue() <= VecEC.getKnownMinValue(), 5256 "subvector operand of experimental_vector_insert would overrun the " 5257 "vector being inserted into."); 5258 } 5259 break; 5260 } 5261 case Intrinsic::experimental_vector_extract: { 5262 Value *Vec = Call.getArgOperand(0); 5263 Value *Idx = Call.getArgOperand(1); 5264 unsigned IdxN = cast<ConstantInt>(Idx)->getZExtValue(); 5265 5266 VectorType *ResultTy = cast<VectorType>(Call.getType()); 5267 VectorType *VecTy = cast<VectorType>(Vec->getType()); 5268 5269 ElementCount VecEC = VecTy->getElementCount(); 5270 ElementCount ResultEC = ResultTy->getElementCount(); 5271 5272 Assert(ResultTy->getElementType() == VecTy->getElementType(), 5273 "experimental_vector_extract result must have the same element " 5274 "type as the input vector.", 5275 &Call); 5276 Assert(IdxN % ResultEC.getKnownMinValue() == 0, 5277 "experimental_vector_extract index must be a constant multiple of " 5278 "the result type's known minimum vector length."); 5279 5280 // If this extraction is not the 'mixed' case where a fixed vector is is 5281 // extracted from a scalable vector, ensure that the extraction does not 5282 // overrun the parent vector. 5283 if (VecEC.isScalable() == ResultEC.isScalable()) { 5284 Assert(IdxN < VecEC.getKnownMinValue() && 5285 IdxN + ResultEC.getKnownMinValue() <= VecEC.getKnownMinValue(), 5286 "experimental_vector_extract would overrun."); 5287 } 5288 break; 5289 } 5290 case Intrinsic::experimental_noalias_scope_decl: { 5291 NoAliasScopeDecls.push_back(cast<IntrinsicInst>(&Call)); 5292 break; 5293 } 5294 }; 5295 } 5296 5297 /// Carefully grab the subprogram from a local scope. 5298 /// 5299 /// This carefully grabs the subprogram from a local scope, avoiding the 5300 /// built-in assertions that would typically fire. 5301 static DISubprogram *getSubprogram(Metadata *LocalScope) { 5302 if (!LocalScope) 5303 return nullptr; 5304 5305 if (auto *SP = dyn_cast<DISubprogram>(LocalScope)) 5306 return SP; 5307 5308 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope)) 5309 return getSubprogram(LB->getRawScope()); 5310 5311 // Just return null; broken scope chains are checked elsewhere. 5312 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope"); 5313 return nullptr; 5314 } 5315 5316 void Verifier::visitConstrainedFPIntrinsic(ConstrainedFPIntrinsic &FPI) { 5317 unsigned NumOperands; 5318 bool HasRoundingMD; 5319 switch (FPI.getIntrinsicID()) { 5320 #define INSTRUCTION(NAME, NARG, ROUND_MODE, INTRINSIC) \ 5321 case Intrinsic::INTRINSIC: \ 5322 NumOperands = NARG; \ 5323 HasRoundingMD = ROUND_MODE; \ 5324 break; 5325 #include "llvm/IR/ConstrainedOps.def" 5326 default: 5327 llvm_unreachable("Invalid constrained FP intrinsic!"); 5328 } 5329 NumOperands += (1 + HasRoundingMD); 5330 // Compare intrinsics carry an extra predicate metadata operand. 5331 if (isa<ConstrainedFPCmpIntrinsic>(FPI)) 5332 NumOperands += 1; 5333 Assert((FPI.getNumArgOperands() == NumOperands), 5334 "invalid arguments for constrained FP intrinsic", &FPI); 5335 5336 switch (FPI.getIntrinsicID()) { 5337 case Intrinsic::experimental_constrained_lrint: 5338 case Intrinsic::experimental_constrained_llrint: { 5339 Type *ValTy = FPI.getArgOperand(0)->getType(); 5340 Type *ResultTy = FPI.getType(); 5341 Assert(!ValTy->isVectorTy() && !ResultTy->isVectorTy(), 5342 "Intrinsic does not support vectors", &FPI); 5343 } 5344 break; 5345 5346 case Intrinsic::experimental_constrained_lround: 5347 case Intrinsic::experimental_constrained_llround: { 5348 Type *ValTy = FPI.getArgOperand(0)->getType(); 5349 Type *ResultTy = FPI.getType(); 5350 Assert(!ValTy->isVectorTy() && !ResultTy->isVectorTy(), 5351 "Intrinsic does not support vectors", &FPI); 5352 break; 5353 } 5354 5355 case Intrinsic::experimental_constrained_fcmp: 5356 case Intrinsic::experimental_constrained_fcmps: { 5357 auto Pred = cast<ConstrainedFPCmpIntrinsic>(&FPI)->getPredicate(); 5358 Assert(CmpInst::isFPPredicate(Pred), 5359 "invalid predicate for constrained FP comparison intrinsic", &FPI); 5360 break; 5361 } 5362 5363 case Intrinsic::experimental_constrained_fptosi: 5364 case Intrinsic::experimental_constrained_fptoui: { 5365 Value *Operand = FPI.getArgOperand(0); 5366 uint64_t NumSrcElem = 0; 5367 Assert(Operand->getType()->isFPOrFPVectorTy(), 5368 "Intrinsic first argument must be floating point", &FPI); 5369 if (auto *OperandT = dyn_cast<VectorType>(Operand->getType())) { 5370 NumSrcElem = cast<FixedVectorType>(OperandT)->getNumElements(); 5371 } 5372 5373 Operand = &FPI; 5374 Assert((NumSrcElem > 0) == Operand->getType()->isVectorTy(), 5375 "Intrinsic first argument and result disagree on vector use", &FPI); 5376 Assert(Operand->getType()->isIntOrIntVectorTy(), 5377 "Intrinsic result must be an integer", &FPI); 5378 if (auto *OperandT = dyn_cast<VectorType>(Operand->getType())) { 5379 Assert(NumSrcElem == cast<FixedVectorType>(OperandT)->getNumElements(), 5380 "Intrinsic first argument and result vector lengths must be equal", 5381 &FPI); 5382 } 5383 } 5384 break; 5385 5386 case Intrinsic::experimental_constrained_sitofp: 5387 case Intrinsic::experimental_constrained_uitofp: { 5388 Value *Operand = FPI.getArgOperand(0); 5389 uint64_t NumSrcElem = 0; 5390 Assert(Operand->getType()->isIntOrIntVectorTy(), 5391 "Intrinsic first argument must be integer", &FPI); 5392 if (auto *OperandT = dyn_cast<VectorType>(Operand->getType())) { 5393 NumSrcElem = cast<FixedVectorType>(OperandT)->getNumElements(); 5394 } 5395 5396 Operand = &FPI; 5397 Assert((NumSrcElem > 0) == Operand->getType()->isVectorTy(), 5398 "Intrinsic first argument and result disagree on vector use", &FPI); 5399 Assert(Operand->getType()->isFPOrFPVectorTy(), 5400 "Intrinsic result must be a floating point", &FPI); 5401 if (auto *OperandT = dyn_cast<VectorType>(Operand->getType())) { 5402 Assert(NumSrcElem == cast<FixedVectorType>(OperandT)->getNumElements(), 5403 "Intrinsic first argument and result vector lengths must be equal", 5404 &FPI); 5405 } 5406 } break; 5407 5408 case Intrinsic::experimental_constrained_fptrunc: 5409 case Intrinsic::experimental_constrained_fpext: { 5410 Value *Operand = FPI.getArgOperand(0); 5411 Type *OperandTy = Operand->getType(); 5412 Value *Result = &FPI; 5413 Type *ResultTy = Result->getType(); 5414 Assert(OperandTy->isFPOrFPVectorTy(), 5415 "Intrinsic first argument must be FP or FP vector", &FPI); 5416 Assert(ResultTy->isFPOrFPVectorTy(), 5417 "Intrinsic result must be FP or FP vector", &FPI); 5418 Assert(OperandTy->isVectorTy() == ResultTy->isVectorTy(), 5419 "Intrinsic first argument and result disagree on vector use", &FPI); 5420 if (OperandTy->isVectorTy()) { 5421 Assert(cast<FixedVectorType>(OperandTy)->getNumElements() == 5422 cast<FixedVectorType>(ResultTy)->getNumElements(), 5423 "Intrinsic first argument and result vector lengths must be equal", 5424 &FPI); 5425 } 5426 if (FPI.getIntrinsicID() == Intrinsic::experimental_constrained_fptrunc) { 5427 Assert(OperandTy->getScalarSizeInBits() > ResultTy->getScalarSizeInBits(), 5428 "Intrinsic first argument's type must be larger than result type", 5429 &FPI); 5430 } else { 5431 Assert(OperandTy->getScalarSizeInBits() < ResultTy->getScalarSizeInBits(), 5432 "Intrinsic first argument's type must be smaller than result type", 5433 &FPI); 5434 } 5435 } 5436 break; 5437 5438 default: 5439 break; 5440 } 5441 5442 // If a non-metadata argument is passed in a metadata slot then the 5443 // error will be caught earlier when the incorrect argument doesn't 5444 // match the specification in the intrinsic call table. Thus, no 5445 // argument type check is needed here. 5446 5447 Assert(FPI.getExceptionBehavior().hasValue(), 5448 "invalid exception behavior argument", &FPI); 5449 if (HasRoundingMD) { 5450 Assert(FPI.getRoundingMode().hasValue(), 5451 "invalid rounding mode argument", &FPI); 5452 } 5453 } 5454 5455 void Verifier::visitDbgIntrinsic(StringRef Kind, DbgVariableIntrinsic &DII) { 5456 auto *MD = DII.getRawLocation(); 5457 AssertDI(isa<ValueAsMetadata>(MD) || isa<DIArgList>(MD) || 5458 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()), 5459 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD); 5460 AssertDI(isa<DILocalVariable>(DII.getRawVariable()), 5461 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII, 5462 DII.getRawVariable()); 5463 AssertDI(isa<DIExpression>(DII.getRawExpression()), 5464 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII, 5465 DII.getRawExpression()); 5466 5467 // Ignore broken !dbg attachments; they're checked elsewhere. 5468 if (MDNode *N = DII.getDebugLoc().getAsMDNode()) 5469 if (!isa<DILocation>(N)) 5470 return; 5471 5472 BasicBlock *BB = DII.getParent(); 5473 Function *F = BB ? BB->getParent() : nullptr; 5474 5475 // The scopes for variables and !dbg attachments must agree. 5476 DILocalVariable *Var = DII.getVariable(); 5477 DILocation *Loc = DII.getDebugLoc(); 5478 AssertDI(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment", 5479 &DII, BB, F); 5480 5481 DISubprogram *VarSP = getSubprogram(Var->getRawScope()); 5482 DISubprogram *LocSP = getSubprogram(Loc->getRawScope()); 5483 if (!VarSP || !LocSP) 5484 return; // Broken scope chains are checked elsewhere. 5485 5486 AssertDI(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind + 5487 " variable and !dbg attachment", 5488 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc, 5489 Loc->getScope()->getSubprogram()); 5490 5491 // This check is redundant with one in visitLocalVariable(). 5492 AssertDI(isType(Var->getRawType()), "invalid type ref", Var, 5493 Var->getRawType()); 5494 verifyFnArgs(DII); 5495 } 5496 5497 void Verifier::visitDbgLabelIntrinsic(StringRef Kind, DbgLabelInst &DLI) { 5498 AssertDI(isa<DILabel>(DLI.getRawLabel()), 5499 "invalid llvm.dbg." + Kind + " intrinsic variable", &DLI, 5500 DLI.getRawLabel()); 5501 5502 // Ignore broken !dbg attachments; they're checked elsewhere. 5503 if (MDNode *N = DLI.getDebugLoc().getAsMDNode()) 5504 if (!isa<DILocation>(N)) 5505 return; 5506 5507 BasicBlock *BB = DLI.getParent(); 5508 Function *F = BB ? BB->getParent() : nullptr; 5509 5510 // The scopes for variables and !dbg attachments must agree. 5511 DILabel *Label = DLI.getLabel(); 5512 DILocation *Loc = DLI.getDebugLoc(); 5513 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment", 5514 &DLI, BB, F); 5515 5516 DISubprogram *LabelSP = getSubprogram(Label->getRawScope()); 5517 DISubprogram *LocSP = getSubprogram(Loc->getRawScope()); 5518 if (!LabelSP || !LocSP) 5519 return; 5520 5521 AssertDI(LabelSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind + 5522 " label and !dbg attachment", 5523 &DLI, BB, F, Label, Label->getScope()->getSubprogram(), Loc, 5524 Loc->getScope()->getSubprogram()); 5525 } 5526 5527 void Verifier::verifyFragmentExpression(const DbgVariableIntrinsic &I) { 5528 DILocalVariable *V = dyn_cast_or_null<DILocalVariable>(I.getRawVariable()); 5529 DIExpression *E = dyn_cast_or_null<DIExpression>(I.getRawExpression()); 5530 5531 // We don't know whether this intrinsic verified correctly. 5532 if (!V || !E || !E->isValid()) 5533 return; 5534 5535 // Nothing to do if this isn't a DW_OP_LLVM_fragment expression. 5536 auto Fragment = E->getFragmentInfo(); 5537 if (!Fragment) 5538 return; 5539 5540 // The frontend helps out GDB by emitting the members of local anonymous 5541 // unions as artificial local variables with shared storage. When SROA splits 5542 // the storage for artificial local variables that are smaller than the entire 5543 // union, the overhang piece will be outside of the allotted space for the 5544 // variable and this check fails. 5545 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs. 5546 if (V->isArtificial()) 5547 return; 5548 5549 verifyFragmentExpression(*V, *Fragment, &I); 5550 } 5551 5552 template <typename ValueOrMetadata> 5553 void Verifier::verifyFragmentExpression(const DIVariable &V, 5554 DIExpression::FragmentInfo Fragment, 5555 ValueOrMetadata *Desc) { 5556 // If there's no size, the type is broken, but that should be checked 5557 // elsewhere. 5558 auto VarSize = V.getSizeInBits(); 5559 if (!VarSize) 5560 return; 5561 5562 unsigned FragSize = Fragment.SizeInBits; 5563 unsigned FragOffset = Fragment.OffsetInBits; 5564 AssertDI(FragSize + FragOffset <= *VarSize, 5565 "fragment is larger than or outside of variable", Desc, &V); 5566 AssertDI(FragSize != *VarSize, "fragment covers entire variable", Desc, &V); 5567 } 5568 5569 void Verifier::verifyFnArgs(const DbgVariableIntrinsic &I) { 5570 // This function does not take the scope of noninlined function arguments into 5571 // account. Don't run it if current function is nodebug, because it may 5572 // contain inlined debug intrinsics. 5573 if (!HasDebugInfo) 5574 return; 5575 5576 // For performance reasons only check non-inlined ones. 5577 if (I.getDebugLoc()->getInlinedAt()) 5578 return; 5579 5580 DILocalVariable *Var = I.getVariable(); 5581 AssertDI(Var, "dbg intrinsic without variable"); 5582 5583 unsigned ArgNo = Var->getArg(); 5584 if (!ArgNo) 5585 return; 5586 5587 // Verify there are no duplicate function argument debug info entries. 5588 // These will cause hard-to-debug assertions in the DWARF backend. 5589 if (DebugFnArgs.size() < ArgNo) 5590 DebugFnArgs.resize(ArgNo, nullptr); 5591 5592 auto *Prev = DebugFnArgs[ArgNo - 1]; 5593 DebugFnArgs[ArgNo - 1] = Var; 5594 AssertDI(!Prev || (Prev == Var), "conflicting debug info for argument", &I, 5595 Prev, Var); 5596 } 5597 5598 void Verifier::verifyNotEntryValue(const DbgVariableIntrinsic &I) { 5599 DIExpression *E = dyn_cast_or_null<DIExpression>(I.getRawExpression()); 5600 5601 // We don't know whether this intrinsic verified correctly. 5602 if (!E || !E->isValid()) 5603 return; 5604 5605 AssertDI(!E->isEntryValue(), "Entry values are only allowed in MIR", &I); 5606 } 5607 5608 void Verifier::verifyCompileUnits() { 5609 // When more than one Module is imported into the same context, such as during 5610 // an LTO build before linking the modules, ODR type uniquing may cause types 5611 // to point to a different CU. This check does not make sense in this case. 5612 if (M.getContext().isODRUniquingDebugTypes()) 5613 return; 5614 auto *CUs = M.getNamedMetadata("llvm.dbg.cu"); 5615 SmallPtrSet<const Metadata *, 2> Listed; 5616 if (CUs) 5617 Listed.insert(CUs->op_begin(), CUs->op_end()); 5618 for (auto *CU : CUVisited) 5619 AssertDI(Listed.count(CU), "DICompileUnit not listed in llvm.dbg.cu", CU); 5620 CUVisited.clear(); 5621 } 5622 5623 void Verifier::verifyDeoptimizeCallingConvs() { 5624 if (DeoptimizeDeclarations.empty()) 5625 return; 5626 5627 const Function *First = DeoptimizeDeclarations[0]; 5628 for (auto *F : makeArrayRef(DeoptimizeDeclarations).slice(1)) { 5629 Assert(First->getCallingConv() == F->getCallingConv(), 5630 "All llvm.experimental.deoptimize declarations must have the same " 5631 "calling convention", 5632 First, F); 5633 } 5634 } 5635 5636 void Verifier::verifySourceDebugInfo(const DICompileUnit &U, const DIFile &F) { 5637 bool HasSource = F.getSource().hasValue(); 5638 if (!HasSourceDebugInfo.count(&U)) 5639 HasSourceDebugInfo[&U] = HasSource; 5640 AssertDI(HasSource == HasSourceDebugInfo[&U], 5641 "inconsistent use of embedded source"); 5642 } 5643 5644 void Verifier::verifyNoAliasScopeDecl() { 5645 if (NoAliasScopeDecls.empty()) 5646 return; 5647 5648 // only a single scope must be declared at a time. 5649 for (auto *II : NoAliasScopeDecls) { 5650 assert(II->getIntrinsicID() == Intrinsic::experimental_noalias_scope_decl && 5651 "Not a llvm.experimental.noalias.scope.decl ?"); 5652 const auto *ScopeListMV = dyn_cast<MetadataAsValue>( 5653 II->getOperand(Intrinsic::NoAliasScopeDeclScopeArg)); 5654 Assert(ScopeListMV != nullptr, 5655 "llvm.experimental.noalias.scope.decl must have a MetadataAsValue " 5656 "argument", 5657 II); 5658 5659 const auto *ScopeListMD = dyn_cast<MDNode>(ScopeListMV->getMetadata()); 5660 Assert(ScopeListMD != nullptr, "!id.scope.list must point to an MDNode", 5661 II); 5662 Assert(ScopeListMD->getNumOperands() == 1, 5663 "!id.scope.list must point to a list with a single scope", II); 5664 } 5665 5666 // Only check the domination rule when requested. Once all passes have been 5667 // adapted this option can go away. 5668 if (!VerifyNoAliasScopeDomination) 5669 return; 5670 5671 // Now sort the intrinsics based on the scope MDNode so that declarations of 5672 // the same scopes are next to each other. 5673 auto GetScope = [](IntrinsicInst *II) { 5674 const auto *ScopeListMV = cast<MetadataAsValue>( 5675 II->getOperand(Intrinsic::NoAliasScopeDeclScopeArg)); 5676 return &cast<MDNode>(ScopeListMV->getMetadata())->getOperand(0); 5677 }; 5678 5679 // We are sorting on MDNode pointers here. For valid input IR this is ok. 5680 // TODO: Sort on Metadata ID to avoid non-deterministic error messages. 5681 auto Compare = [GetScope](IntrinsicInst *Lhs, IntrinsicInst *Rhs) { 5682 return GetScope(Lhs) < GetScope(Rhs); 5683 }; 5684 5685 llvm::sort(NoAliasScopeDecls, Compare); 5686 5687 // Go over the intrinsics and check that for the same scope, they are not 5688 // dominating each other. 5689 auto ItCurrent = NoAliasScopeDecls.begin(); 5690 while (ItCurrent != NoAliasScopeDecls.end()) { 5691 auto CurScope = GetScope(*ItCurrent); 5692 auto ItNext = ItCurrent; 5693 do { 5694 ++ItNext; 5695 } while (ItNext != NoAliasScopeDecls.end() && 5696 GetScope(*ItNext) == CurScope); 5697 5698 // [ItCurrent, ItNext) represents the declarations for the same scope. 5699 // Ensure they are not dominating each other.. but only if it is not too 5700 // expensive. 5701 if (ItNext - ItCurrent < 32) 5702 for (auto *I : llvm::make_range(ItCurrent, ItNext)) 5703 for (auto *J : llvm::make_range(ItCurrent, ItNext)) 5704 if (I != J) 5705 Assert(!DT.dominates(I, J), 5706 "llvm.experimental.noalias.scope.decl dominates another one " 5707 "with the same scope", 5708 I); 5709 ItCurrent = ItNext; 5710 } 5711 } 5712 5713 //===----------------------------------------------------------------------===// 5714 // Implement the public interfaces to this file... 5715 //===----------------------------------------------------------------------===// 5716 5717 bool llvm::verifyFunction(const Function &f, raw_ostream *OS) { 5718 Function &F = const_cast<Function &>(f); 5719 5720 // Don't use a raw_null_ostream. Printing IR is expensive. 5721 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/true, *f.getParent()); 5722 5723 // Note that this function's return value is inverted from what you would 5724 // expect of a function called "verify". 5725 return !V.verify(F); 5726 } 5727 5728 bool llvm::verifyModule(const Module &M, raw_ostream *OS, 5729 bool *BrokenDebugInfo) { 5730 // Don't use a raw_null_ostream. Printing IR is expensive. 5731 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/!BrokenDebugInfo, M); 5732 5733 bool Broken = false; 5734 for (const Function &F : M) 5735 Broken |= !V.verify(F); 5736 5737 Broken |= !V.verify(); 5738 if (BrokenDebugInfo) 5739 *BrokenDebugInfo = V.hasBrokenDebugInfo(); 5740 // Note that this function's return value is inverted from what you would 5741 // expect of a function called "verify". 5742 return Broken; 5743 } 5744 5745 namespace { 5746 5747 struct VerifierLegacyPass : public FunctionPass { 5748 static char ID; 5749 5750 std::unique_ptr<Verifier> V; 5751 bool FatalErrors = true; 5752 5753 VerifierLegacyPass() : FunctionPass(ID) { 5754 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry()); 5755 } 5756 explicit VerifierLegacyPass(bool FatalErrors) 5757 : FunctionPass(ID), 5758 FatalErrors(FatalErrors) { 5759 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry()); 5760 } 5761 5762 bool doInitialization(Module &M) override { 5763 V = std::make_unique<Verifier>( 5764 &dbgs(), /*ShouldTreatBrokenDebugInfoAsError=*/false, M); 5765 return false; 5766 } 5767 5768 bool runOnFunction(Function &F) override { 5769 if (!V->verify(F) && FatalErrors) { 5770 errs() << "in function " << F.getName() << '\n'; 5771 report_fatal_error("Broken function found, compilation aborted!"); 5772 } 5773 return false; 5774 } 5775 5776 bool doFinalization(Module &M) override { 5777 bool HasErrors = false; 5778 for (Function &F : M) 5779 if (F.isDeclaration()) 5780 HasErrors |= !V->verify(F); 5781 5782 HasErrors |= !V->verify(); 5783 if (FatalErrors && (HasErrors || V->hasBrokenDebugInfo())) 5784 report_fatal_error("Broken module found, compilation aborted!"); 5785 return false; 5786 } 5787 5788 void getAnalysisUsage(AnalysisUsage &AU) const override { 5789 AU.setPreservesAll(); 5790 } 5791 }; 5792 5793 } // end anonymous namespace 5794 5795 /// Helper to issue failure from the TBAA verification 5796 template <typename... Tys> void TBAAVerifier::CheckFailed(Tys &&... Args) { 5797 if (Diagnostic) 5798 return Diagnostic->CheckFailed(Args...); 5799 } 5800 5801 #define AssertTBAA(C, ...) \ 5802 do { \ 5803 if (!(C)) { \ 5804 CheckFailed(__VA_ARGS__); \ 5805 return false; \ 5806 } \ 5807 } while (false) 5808 5809 /// Verify that \p BaseNode can be used as the "base type" in the struct-path 5810 /// TBAA scheme. This means \p BaseNode is either a scalar node, or a 5811 /// struct-type node describing an aggregate data structure (like a struct). 5812 TBAAVerifier::TBAABaseNodeSummary 5813 TBAAVerifier::verifyTBAABaseNode(Instruction &I, const MDNode *BaseNode, 5814 bool IsNewFormat) { 5815 if (BaseNode->getNumOperands() < 2) { 5816 CheckFailed("Base nodes must have at least two operands", &I, BaseNode); 5817 return {true, ~0u}; 5818 } 5819 5820 auto Itr = TBAABaseNodes.find(BaseNode); 5821 if (Itr != TBAABaseNodes.end()) 5822 return Itr->second; 5823 5824 auto Result = verifyTBAABaseNodeImpl(I, BaseNode, IsNewFormat); 5825 auto InsertResult = TBAABaseNodes.insert({BaseNode, Result}); 5826 (void)InsertResult; 5827 assert(InsertResult.second && "We just checked!"); 5828 return Result; 5829 } 5830 5831 TBAAVerifier::TBAABaseNodeSummary 5832 TBAAVerifier::verifyTBAABaseNodeImpl(Instruction &I, const MDNode *BaseNode, 5833 bool IsNewFormat) { 5834 const TBAAVerifier::TBAABaseNodeSummary InvalidNode = {true, ~0u}; 5835 5836 if (BaseNode->getNumOperands() == 2) { 5837 // Scalar nodes can only be accessed at offset 0. 5838 return isValidScalarTBAANode(BaseNode) 5839 ? TBAAVerifier::TBAABaseNodeSummary({false, 0}) 5840 : InvalidNode; 5841 } 5842 5843 if (IsNewFormat) { 5844 if (BaseNode->getNumOperands() % 3 != 0) { 5845 CheckFailed("Access tag nodes must have the number of operands that is a " 5846 "multiple of 3!", BaseNode); 5847 return InvalidNode; 5848 } 5849 } else { 5850 if (BaseNode->getNumOperands() % 2 != 1) { 5851 CheckFailed("Struct tag nodes must have an odd number of operands!", 5852 BaseNode); 5853 return InvalidNode; 5854 } 5855 } 5856 5857 // Check the type size field. 5858 if (IsNewFormat) { 5859 auto *TypeSizeNode = mdconst::dyn_extract_or_null<ConstantInt>( 5860 BaseNode->getOperand(1)); 5861 if (!TypeSizeNode) { 5862 CheckFailed("Type size nodes must be constants!", &I, BaseNode); 5863 return InvalidNode; 5864 } 5865 } 5866 5867 // Check the type name field. In the new format it can be anything. 5868 if (!IsNewFormat && !isa<MDString>(BaseNode->getOperand(0))) { 5869 CheckFailed("Struct tag nodes have a string as their first operand", 5870 BaseNode); 5871 return InvalidNode; 5872 } 5873 5874 bool Failed = false; 5875 5876 Optional<APInt> PrevOffset; 5877 unsigned BitWidth = ~0u; 5878 5879 // We've already checked that BaseNode is not a degenerate root node with one 5880 // operand in \c verifyTBAABaseNode, so this loop should run at least once. 5881 unsigned FirstFieldOpNo = IsNewFormat ? 3 : 1; 5882 unsigned NumOpsPerField = IsNewFormat ? 3 : 2; 5883 for (unsigned Idx = FirstFieldOpNo; Idx < BaseNode->getNumOperands(); 5884 Idx += NumOpsPerField) { 5885 const MDOperand &FieldTy = BaseNode->getOperand(Idx); 5886 const MDOperand &FieldOffset = BaseNode->getOperand(Idx + 1); 5887 if (!isa<MDNode>(FieldTy)) { 5888 CheckFailed("Incorrect field entry in struct type node!", &I, BaseNode); 5889 Failed = true; 5890 continue; 5891 } 5892 5893 auto *OffsetEntryCI = 5894 mdconst::dyn_extract_or_null<ConstantInt>(FieldOffset); 5895 if (!OffsetEntryCI) { 5896 CheckFailed("Offset entries must be constants!", &I, BaseNode); 5897 Failed = true; 5898 continue; 5899 } 5900 5901 if (BitWidth == ~0u) 5902 BitWidth = OffsetEntryCI->getBitWidth(); 5903 5904 if (OffsetEntryCI->getBitWidth() != BitWidth) { 5905 CheckFailed( 5906 "Bitwidth between the offsets and struct type entries must match", &I, 5907 BaseNode); 5908 Failed = true; 5909 continue; 5910 } 5911 5912 // NB! As far as I can tell, we generate a non-strictly increasing offset 5913 // sequence only from structs that have zero size bit fields. When 5914 // recursing into a contained struct in \c getFieldNodeFromTBAABaseNode we 5915 // pick the field lexically the latest in struct type metadata node. This 5916 // mirrors the actual behavior of the alias analysis implementation. 5917 bool IsAscending = 5918 !PrevOffset || PrevOffset->ule(OffsetEntryCI->getValue()); 5919 5920 if (!IsAscending) { 5921 CheckFailed("Offsets must be increasing!", &I, BaseNode); 5922 Failed = true; 5923 } 5924 5925 PrevOffset = OffsetEntryCI->getValue(); 5926 5927 if (IsNewFormat) { 5928 auto *MemberSizeNode = mdconst::dyn_extract_or_null<ConstantInt>( 5929 BaseNode->getOperand(Idx + 2)); 5930 if (!MemberSizeNode) { 5931 CheckFailed("Member size entries must be constants!", &I, BaseNode); 5932 Failed = true; 5933 continue; 5934 } 5935 } 5936 } 5937 5938 return Failed ? InvalidNode 5939 : TBAAVerifier::TBAABaseNodeSummary(false, BitWidth); 5940 } 5941 5942 static bool IsRootTBAANode(const MDNode *MD) { 5943 return MD->getNumOperands() < 2; 5944 } 5945 5946 static bool IsScalarTBAANodeImpl(const MDNode *MD, 5947 SmallPtrSetImpl<const MDNode *> &Visited) { 5948 if (MD->getNumOperands() != 2 && MD->getNumOperands() != 3) 5949 return false; 5950 5951 if (!isa<MDString>(MD->getOperand(0))) 5952 return false; 5953 5954 if (MD->getNumOperands() == 3) { 5955 auto *Offset = mdconst::dyn_extract<ConstantInt>(MD->getOperand(2)); 5956 if (!(Offset && Offset->isZero() && isa<MDString>(MD->getOperand(0)))) 5957 return false; 5958 } 5959 5960 auto *Parent = dyn_cast_or_null<MDNode>(MD->getOperand(1)); 5961 return Parent && Visited.insert(Parent).second && 5962 (IsRootTBAANode(Parent) || IsScalarTBAANodeImpl(Parent, Visited)); 5963 } 5964 5965 bool TBAAVerifier::isValidScalarTBAANode(const MDNode *MD) { 5966 auto ResultIt = TBAAScalarNodes.find(MD); 5967 if (ResultIt != TBAAScalarNodes.end()) 5968 return ResultIt->second; 5969 5970 SmallPtrSet<const MDNode *, 4> Visited; 5971 bool Result = IsScalarTBAANodeImpl(MD, Visited); 5972 auto InsertResult = TBAAScalarNodes.insert({MD, Result}); 5973 (void)InsertResult; 5974 assert(InsertResult.second && "Just checked!"); 5975 5976 return Result; 5977 } 5978 5979 /// Returns the field node at the offset \p Offset in \p BaseNode. Update \p 5980 /// Offset in place to be the offset within the field node returned. 5981 /// 5982 /// We assume we've okayed \p BaseNode via \c verifyTBAABaseNode. 5983 MDNode *TBAAVerifier::getFieldNodeFromTBAABaseNode(Instruction &I, 5984 const MDNode *BaseNode, 5985 APInt &Offset, 5986 bool IsNewFormat) { 5987 assert(BaseNode->getNumOperands() >= 2 && "Invalid base node!"); 5988 5989 // Scalar nodes have only one possible "field" -- their parent in the access 5990 // hierarchy. Offset must be zero at this point, but our caller is supposed 5991 // to Assert that. 5992 if (BaseNode->getNumOperands() == 2) 5993 return cast<MDNode>(BaseNode->getOperand(1)); 5994 5995 unsigned FirstFieldOpNo = IsNewFormat ? 3 : 1; 5996 unsigned NumOpsPerField = IsNewFormat ? 3 : 2; 5997 for (unsigned Idx = FirstFieldOpNo; Idx < BaseNode->getNumOperands(); 5998 Idx += NumOpsPerField) { 5999 auto *OffsetEntryCI = 6000 mdconst::extract<ConstantInt>(BaseNode->getOperand(Idx + 1)); 6001 if (OffsetEntryCI->getValue().ugt(Offset)) { 6002 if (Idx == FirstFieldOpNo) { 6003 CheckFailed("Could not find TBAA parent in struct type node", &I, 6004 BaseNode, &Offset); 6005 return nullptr; 6006 } 6007 6008 unsigned PrevIdx = Idx - NumOpsPerField; 6009 auto *PrevOffsetEntryCI = 6010 mdconst::extract<ConstantInt>(BaseNode->getOperand(PrevIdx + 1)); 6011 Offset -= PrevOffsetEntryCI->getValue(); 6012 return cast<MDNode>(BaseNode->getOperand(PrevIdx)); 6013 } 6014 } 6015 6016 unsigned LastIdx = BaseNode->getNumOperands() - NumOpsPerField; 6017 auto *LastOffsetEntryCI = mdconst::extract<ConstantInt>( 6018 BaseNode->getOperand(LastIdx + 1)); 6019 Offset -= LastOffsetEntryCI->getValue(); 6020 return cast<MDNode>(BaseNode->getOperand(LastIdx)); 6021 } 6022 6023 static bool isNewFormatTBAATypeNode(llvm::MDNode *Type) { 6024 if (!Type || Type->getNumOperands() < 3) 6025 return false; 6026 6027 // In the new format type nodes shall have a reference to the parent type as 6028 // its first operand. 6029 MDNode *Parent = dyn_cast_or_null<MDNode>(Type->getOperand(0)); 6030 if (!Parent) 6031 return false; 6032 6033 return true; 6034 } 6035 6036 bool TBAAVerifier::visitTBAAMetadata(Instruction &I, const MDNode *MD) { 6037 AssertTBAA(isa<LoadInst>(I) || isa<StoreInst>(I) || isa<CallInst>(I) || 6038 isa<VAArgInst>(I) || isa<AtomicRMWInst>(I) || 6039 isa<AtomicCmpXchgInst>(I), 6040 "This instruction shall not have a TBAA access tag!", &I); 6041 6042 bool IsStructPathTBAA = 6043 isa<MDNode>(MD->getOperand(0)) && MD->getNumOperands() >= 3; 6044 6045 AssertTBAA( 6046 IsStructPathTBAA, 6047 "Old-style TBAA is no longer allowed, use struct-path TBAA instead", &I); 6048 6049 MDNode *BaseNode = dyn_cast_or_null<MDNode>(MD->getOperand(0)); 6050 MDNode *AccessType = dyn_cast_or_null<MDNode>(MD->getOperand(1)); 6051 6052 bool IsNewFormat = isNewFormatTBAATypeNode(AccessType); 6053 6054 if (IsNewFormat) { 6055 AssertTBAA(MD->getNumOperands() == 4 || MD->getNumOperands() == 5, 6056 "Access tag metadata must have either 4 or 5 operands", &I, MD); 6057 } else { 6058 AssertTBAA(MD->getNumOperands() < 5, 6059 "Struct tag metadata must have either 3 or 4 operands", &I, MD); 6060 } 6061 6062 // Check the access size field. 6063 if (IsNewFormat) { 6064 auto *AccessSizeNode = mdconst::dyn_extract_or_null<ConstantInt>( 6065 MD->getOperand(3)); 6066 AssertTBAA(AccessSizeNode, "Access size field must be a constant", &I, MD); 6067 } 6068 6069 // Check the immutability flag. 6070 unsigned ImmutabilityFlagOpNo = IsNewFormat ? 4 : 3; 6071 if (MD->getNumOperands() == ImmutabilityFlagOpNo + 1) { 6072 auto *IsImmutableCI = mdconst::dyn_extract_or_null<ConstantInt>( 6073 MD->getOperand(ImmutabilityFlagOpNo)); 6074 AssertTBAA(IsImmutableCI, 6075 "Immutability tag on struct tag metadata must be a constant", 6076 &I, MD); 6077 AssertTBAA( 6078 IsImmutableCI->isZero() || IsImmutableCI->isOne(), 6079 "Immutability part of the struct tag metadata must be either 0 or 1", 6080 &I, MD); 6081 } 6082 6083 AssertTBAA(BaseNode && AccessType, 6084 "Malformed struct tag metadata: base and access-type " 6085 "should be non-null and point to Metadata nodes", 6086 &I, MD, BaseNode, AccessType); 6087 6088 if (!IsNewFormat) { 6089 AssertTBAA(isValidScalarTBAANode(AccessType), 6090 "Access type node must be a valid scalar type", &I, MD, 6091 AccessType); 6092 } 6093 6094 auto *OffsetCI = mdconst::dyn_extract_or_null<ConstantInt>(MD->getOperand(2)); 6095 AssertTBAA(OffsetCI, "Offset must be constant integer", &I, MD); 6096 6097 APInt Offset = OffsetCI->getValue(); 6098 bool SeenAccessTypeInPath = false; 6099 6100 SmallPtrSet<MDNode *, 4> StructPath; 6101 6102 for (/* empty */; BaseNode && !IsRootTBAANode(BaseNode); 6103 BaseNode = getFieldNodeFromTBAABaseNode(I, BaseNode, Offset, 6104 IsNewFormat)) { 6105 if (!StructPath.insert(BaseNode).second) { 6106 CheckFailed("Cycle detected in struct path", &I, MD); 6107 return false; 6108 } 6109 6110 bool Invalid; 6111 unsigned BaseNodeBitWidth; 6112 std::tie(Invalid, BaseNodeBitWidth) = verifyTBAABaseNode(I, BaseNode, 6113 IsNewFormat); 6114 6115 // If the base node is invalid in itself, then we've already printed all the 6116 // errors we wanted to print. 6117 if (Invalid) 6118 return false; 6119 6120 SeenAccessTypeInPath |= BaseNode == AccessType; 6121 6122 if (isValidScalarTBAANode(BaseNode) || BaseNode == AccessType) 6123 AssertTBAA(Offset == 0, "Offset not zero at the point of scalar access", 6124 &I, MD, &Offset); 6125 6126 AssertTBAA(BaseNodeBitWidth == Offset.getBitWidth() || 6127 (BaseNodeBitWidth == 0 && Offset == 0) || 6128 (IsNewFormat && BaseNodeBitWidth == ~0u), 6129 "Access bit-width not the same as description bit-width", &I, MD, 6130 BaseNodeBitWidth, Offset.getBitWidth()); 6131 6132 if (IsNewFormat && SeenAccessTypeInPath) 6133 break; 6134 } 6135 6136 AssertTBAA(SeenAccessTypeInPath, "Did not see access type in access path!", 6137 &I, MD); 6138 return true; 6139 } 6140 6141 char VerifierLegacyPass::ID = 0; 6142 INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false) 6143 6144 FunctionPass *llvm::createVerifierPass(bool FatalErrors) { 6145 return new VerifierLegacyPass(FatalErrors); 6146 } 6147 6148 AnalysisKey VerifierAnalysis::Key; 6149 VerifierAnalysis::Result VerifierAnalysis::run(Module &M, 6150 ModuleAnalysisManager &) { 6151 Result Res; 6152 Res.IRBroken = llvm::verifyModule(M, &dbgs(), &Res.DebugInfoBroken); 6153 return Res; 6154 } 6155 6156 VerifierAnalysis::Result VerifierAnalysis::run(Function &F, 6157 FunctionAnalysisManager &) { 6158 return { llvm::verifyFunction(F, &dbgs()), false }; 6159 } 6160 6161 PreservedAnalyses VerifierPass::run(Module &M, ModuleAnalysisManager &AM) { 6162 auto Res = AM.getResult<VerifierAnalysis>(M); 6163 if (FatalErrors && (Res.IRBroken || Res.DebugInfoBroken)) 6164 report_fatal_error("Broken module found, compilation aborted!"); 6165 6166 return PreservedAnalyses::all(); 6167 } 6168 6169 PreservedAnalyses VerifierPass::run(Function &F, FunctionAnalysisManager &AM) { 6170 auto res = AM.getResult<VerifierAnalysis>(F); 6171 if (res.IRBroken && FatalErrors) 6172 report_fatal_error("Broken function found, compilation aborted!"); 6173 6174 return PreservedAnalyses::all(); 6175 } 6176