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