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