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