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 *Params = N.getRawTemplateParams()) 941 visitTemplateParams(N, *Params); 942 if (auto *S = N.getRawDeclaration()) { 943 Assert(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(), 944 "invalid subprogram declaration", &N, S); 945 } 946 if (auto *RawVars = N.getRawVariables()) { 947 auto *Vars = dyn_cast<MDTuple>(RawVars); 948 Assert(Vars, "invalid variable list", &N, RawVars); 949 for (Metadata *Op : Vars->operands()) { 950 Assert(Op && isa<DILocalVariable>(Op), "invalid local variable", &N, Vars, 951 Op); 952 } 953 } 954 Assert(!hasConflictingReferenceFlags(N.getFlags()), "invalid reference flags", 955 &N); 956 957 if (N.isDefinition()) 958 Assert(N.isDistinct(), "subprogram definitions must be distinct", &N); 959 } 960 961 void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) { 962 Assert(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N); 963 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()), 964 "invalid local scope", &N, N.getRawScope()); 965 } 966 967 void Verifier::visitDILexicalBlock(const DILexicalBlock &N) { 968 visitDILexicalBlockBase(N); 969 970 Assert(N.getLine() || !N.getColumn(), 971 "cannot have column info without line info", &N); 972 } 973 974 void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) { 975 visitDILexicalBlockBase(N); 976 } 977 978 void Verifier::visitDINamespace(const DINamespace &N) { 979 Assert(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N); 980 if (auto *S = N.getRawScope()) 981 Assert(isa<DIScope>(S), "invalid scope ref", &N, S); 982 } 983 984 void Verifier::visitDIModule(const DIModule &N) { 985 Assert(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N); 986 Assert(!N.getName().empty(), "anonymous module", &N); 987 } 988 989 void Verifier::visitDITemplateParameter(const DITemplateParameter &N) { 990 Assert(isTypeRef(N, N.getType()), "invalid type ref", &N, N.getType()); 991 } 992 993 void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) { 994 visitDITemplateParameter(N); 995 996 Assert(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag", 997 &N); 998 } 999 1000 void Verifier::visitDITemplateValueParameter( 1001 const DITemplateValueParameter &N) { 1002 visitDITemplateParameter(N); 1003 1004 Assert(N.getTag() == dwarf::DW_TAG_template_value_parameter || 1005 N.getTag() == dwarf::DW_TAG_GNU_template_template_param || 1006 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack, 1007 "invalid tag", &N); 1008 } 1009 1010 void Verifier::visitDIVariable(const DIVariable &N) { 1011 if (auto *S = N.getRawScope()) 1012 Assert(isa<DIScope>(S), "invalid scope", &N, S); 1013 Assert(isTypeRef(N, N.getRawType()), "invalid type ref", &N, N.getRawType()); 1014 if (auto *F = N.getRawFile()) 1015 Assert(isa<DIFile>(F), "invalid file", &N, F); 1016 } 1017 1018 void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) { 1019 // Checks common to all variables. 1020 visitDIVariable(N); 1021 1022 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N); 1023 Assert(!N.getName().empty(), "missing global variable name", &N); 1024 if (auto *V = N.getRawVariable()) { 1025 Assert(isa<ConstantAsMetadata>(V) && 1026 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()), 1027 "invalid global varaible ref", &N, V); 1028 } 1029 if (auto *Member = N.getRawStaticDataMemberDeclaration()) { 1030 Assert(isa<DIDerivedType>(Member), "invalid static data member declaration", 1031 &N, Member); 1032 } 1033 } 1034 1035 void Verifier::visitDILocalVariable(const DILocalVariable &N) { 1036 // Checks common to all variables. 1037 visitDIVariable(N); 1038 1039 Assert(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N); 1040 Assert(N.getRawScope() && isa<DILocalScope>(N.getRawScope()), 1041 "local variable requires a valid scope", &N, N.getRawScope()); 1042 } 1043 1044 void Verifier::visitDIExpression(const DIExpression &N) { 1045 Assert(N.isValid(), "invalid expression", &N); 1046 } 1047 1048 void Verifier::visitDIObjCProperty(const DIObjCProperty &N) { 1049 Assert(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N); 1050 if (auto *T = N.getRawType()) 1051 Assert(isTypeRef(N, T), "invalid type ref", &N, T); 1052 if (auto *F = N.getRawFile()) 1053 Assert(isa<DIFile>(F), "invalid file", &N, F); 1054 } 1055 1056 void Verifier::visitDIImportedEntity(const DIImportedEntity &N) { 1057 Assert(N.getTag() == dwarf::DW_TAG_imported_module || 1058 N.getTag() == dwarf::DW_TAG_imported_declaration, 1059 "invalid tag", &N); 1060 if (auto *S = N.getRawScope()) 1061 Assert(isa<DIScope>(S), "invalid scope for imported entity", &N, S); 1062 Assert(isDIRef(N, N.getEntity()), "invalid imported entity", &N, 1063 N.getEntity()); 1064 } 1065 1066 void Verifier::visitComdat(const Comdat &C) { 1067 // The Module is invalid if the GlobalValue has private linkage. Entities 1068 // with private linkage don't have entries in the symbol table. 1069 if (const GlobalValue *GV = M->getNamedValue(C.getName())) 1070 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage", 1071 GV); 1072 } 1073 1074 void Verifier::visitModuleIdents(const Module &M) { 1075 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident"); 1076 if (!Idents) 1077 return; 1078 1079 // llvm.ident takes a list of metadata entry. Each entry has only one string. 1080 // Scan each llvm.ident entry and make sure that this requirement is met. 1081 for (unsigned i = 0, e = Idents->getNumOperands(); i != e; ++i) { 1082 const MDNode *N = Idents->getOperand(i); 1083 Assert(N->getNumOperands() == 1, 1084 "incorrect number of operands in llvm.ident metadata", N); 1085 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)), 1086 ("invalid value for llvm.ident metadata entry operand" 1087 "(the operand should be a string)"), 1088 N->getOperand(0)); 1089 } 1090 } 1091 1092 void Verifier::visitModuleFlags(const Module &M) { 1093 const NamedMDNode *Flags = M.getModuleFlagsMetadata(); 1094 if (!Flags) return; 1095 1096 // Scan each flag, and track the flags and requirements. 1097 DenseMap<const MDString*, const MDNode*> SeenIDs; 1098 SmallVector<const MDNode*, 16> Requirements; 1099 for (unsigned I = 0, E = Flags->getNumOperands(); I != E; ++I) { 1100 visitModuleFlag(Flags->getOperand(I), SeenIDs, Requirements); 1101 } 1102 1103 // Validate that the requirements in the module are valid. 1104 for (unsigned I = 0, E = Requirements.size(); I != E; ++I) { 1105 const MDNode *Requirement = Requirements[I]; 1106 const MDString *Flag = cast<MDString>(Requirement->getOperand(0)); 1107 const Metadata *ReqValue = Requirement->getOperand(1); 1108 1109 const MDNode *Op = SeenIDs.lookup(Flag); 1110 if (!Op) { 1111 CheckFailed("invalid requirement on flag, flag is not present in module", 1112 Flag); 1113 continue; 1114 } 1115 1116 if (Op->getOperand(2) != ReqValue) { 1117 CheckFailed(("invalid requirement on flag, " 1118 "flag does not have the required value"), 1119 Flag); 1120 continue; 1121 } 1122 } 1123 } 1124 1125 void 1126 Verifier::visitModuleFlag(const MDNode *Op, 1127 DenseMap<const MDString *, const MDNode *> &SeenIDs, 1128 SmallVectorImpl<const MDNode *> &Requirements) { 1129 // Each module flag should have three arguments, the merge behavior (a 1130 // constant int), the flag ID (an MDString), and the value. 1131 Assert(Op->getNumOperands() == 3, 1132 "incorrect number of operands in module flag", Op); 1133 Module::ModFlagBehavior MFB; 1134 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) { 1135 Assert( 1136 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)), 1137 "invalid behavior operand in module flag (expected constant integer)", 1138 Op->getOperand(0)); 1139 Assert(false, 1140 "invalid behavior operand in module flag (unexpected constant)", 1141 Op->getOperand(0)); 1142 } 1143 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1)); 1144 Assert(ID, "invalid ID operand in module flag (expected metadata string)", 1145 Op->getOperand(1)); 1146 1147 // Sanity check the values for behaviors with additional requirements. 1148 switch (MFB) { 1149 case Module::Error: 1150 case Module::Warning: 1151 case Module::Override: 1152 // These behavior types accept any value. 1153 break; 1154 1155 case Module::Require: { 1156 // The value should itself be an MDNode with two operands, a flag ID (an 1157 // MDString), and a value. 1158 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2)); 1159 Assert(Value && Value->getNumOperands() == 2, 1160 "invalid value for 'require' module flag (expected metadata pair)", 1161 Op->getOperand(2)); 1162 Assert(isa<MDString>(Value->getOperand(0)), 1163 ("invalid value for 'require' module flag " 1164 "(first value operand should be a string)"), 1165 Value->getOperand(0)); 1166 1167 // Append it to the list of requirements, to check once all module flags are 1168 // scanned. 1169 Requirements.push_back(Value); 1170 break; 1171 } 1172 1173 case Module::Append: 1174 case Module::AppendUnique: { 1175 // These behavior types require the operand be an MDNode. 1176 Assert(isa<MDNode>(Op->getOperand(2)), 1177 "invalid value for 'append'-type module flag " 1178 "(expected a metadata node)", 1179 Op->getOperand(2)); 1180 break; 1181 } 1182 } 1183 1184 // Unless this is a "requires" flag, check the ID is unique. 1185 if (MFB != Module::Require) { 1186 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second; 1187 Assert(Inserted, 1188 "module flag identifiers must be unique (or of 'require' type)", ID); 1189 } 1190 } 1191 1192 void Verifier::VerifyAttributeTypes(AttributeSet Attrs, unsigned Idx, 1193 bool isFunction, const Value *V) { 1194 unsigned Slot = ~0U; 1195 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I) 1196 if (Attrs.getSlotIndex(I) == Idx) { 1197 Slot = I; 1198 break; 1199 } 1200 1201 assert(Slot != ~0U && "Attribute set inconsistency!"); 1202 1203 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot); 1204 I != E; ++I) { 1205 if (I->isStringAttribute()) 1206 continue; 1207 1208 if (I->getKindAsEnum() == Attribute::NoReturn || 1209 I->getKindAsEnum() == Attribute::NoUnwind || 1210 I->getKindAsEnum() == Attribute::NoInline || 1211 I->getKindAsEnum() == Attribute::AlwaysInline || 1212 I->getKindAsEnum() == Attribute::OptimizeForSize || 1213 I->getKindAsEnum() == Attribute::StackProtect || 1214 I->getKindAsEnum() == Attribute::StackProtectReq || 1215 I->getKindAsEnum() == Attribute::StackProtectStrong || 1216 I->getKindAsEnum() == Attribute::SafeStack || 1217 I->getKindAsEnum() == Attribute::NoRedZone || 1218 I->getKindAsEnum() == Attribute::NoImplicitFloat || 1219 I->getKindAsEnum() == Attribute::Naked || 1220 I->getKindAsEnum() == Attribute::InlineHint || 1221 I->getKindAsEnum() == Attribute::StackAlignment || 1222 I->getKindAsEnum() == Attribute::UWTable || 1223 I->getKindAsEnum() == Attribute::NonLazyBind || 1224 I->getKindAsEnum() == Attribute::ReturnsTwice || 1225 I->getKindAsEnum() == Attribute::SanitizeAddress || 1226 I->getKindAsEnum() == Attribute::SanitizeThread || 1227 I->getKindAsEnum() == Attribute::SanitizeMemory || 1228 I->getKindAsEnum() == Attribute::MinSize || 1229 I->getKindAsEnum() == Attribute::NoDuplicate || 1230 I->getKindAsEnum() == Attribute::Builtin || 1231 I->getKindAsEnum() == Attribute::NoBuiltin || 1232 I->getKindAsEnum() == Attribute::Cold || 1233 I->getKindAsEnum() == Attribute::OptimizeNone || 1234 I->getKindAsEnum() == Attribute::JumpTable || 1235 I->getKindAsEnum() == Attribute::Convergent || 1236 I->getKindAsEnum() == Attribute::ArgMemOnly || 1237 I->getKindAsEnum() == Attribute::NoRecurse) { 1238 if (!isFunction) { 1239 CheckFailed("Attribute '" + I->getAsString() + 1240 "' only applies to functions!", V); 1241 return; 1242 } 1243 } else if (I->getKindAsEnum() == Attribute::ReadOnly || 1244 I->getKindAsEnum() == Attribute::ReadNone) { 1245 if (Idx == 0) { 1246 CheckFailed("Attribute '" + I->getAsString() + 1247 "' does not apply to function returns"); 1248 return; 1249 } 1250 } else if (isFunction) { 1251 CheckFailed("Attribute '" + I->getAsString() + 1252 "' does not apply to functions!", V); 1253 return; 1254 } 1255 } 1256 } 1257 1258 // VerifyParameterAttrs - Check the given attributes for an argument or return 1259 // value of the specified type. The value V is printed in error messages. 1260 void Verifier::VerifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty, 1261 bool isReturnValue, const Value *V) { 1262 if (!Attrs.hasAttributes(Idx)) 1263 return; 1264 1265 VerifyAttributeTypes(Attrs, Idx, false, V); 1266 1267 if (isReturnValue) 1268 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) && 1269 !Attrs.hasAttribute(Idx, Attribute::Nest) && 1270 !Attrs.hasAttribute(Idx, Attribute::StructRet) && 1271 !Attrs.hasAttribute(Idx, Attribute::NoCapture) && 1272 !Attrs.hasAttribute(Idx, Attribute::Returned) && 1273 !Attrs.hasAttribute(Idx, Attribute::InAlloca), 1274 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', and " 1275 "'returned' do not apply to return values!", 1276 V); 1277 1278 // Check for mutually incompatible attributes. Only inreg is compatible with 1279 // sret. 1280 unsigned AttrCount = 0; 1281 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal); 1282 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca); 1283 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) || 1284 Attrs.hasAttribute(Idx, Attribute::InReg); 1285 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest); 1286 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', " 1287 "and 'sret' are incompatible!", 1288 V); 1289 1290 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) && 1291 Attrs.hasAttribute(Idx, Attribute::ReadOnly)), 1292 "Attributes " 1293 "'inalloca and readonly' are incompatible!", 1294 V); 1295 1296 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) && 1297 Attrs.hasAttribute(Idx, Attribute::Returned)), 1298 "Attributes " 1299 "'sret and returned' are incompatible!", 1300 V); 1301 1302 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) && 1303 Attrs.hasAttribute(Idx, Attribute::SExt)), 1304 "Attributes " 1305 "'zeroext and signext' are incompatible!", 1306 V); 1307 1308 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) && 1309 Attrs.hasAttribute(Idx, Attribute::ReadOnly)), 1310 "Attributes " 1311 "'readnone and readonly' are incompatible!", 1312 V); 1313 1314 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) && 1315 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)), 1316 "Attributes " 1317 "'noinline and alwaysinline' are incompatible!", 1318 V); 1319 1320 Assert(!AttrBuilder(Attrs, Idx) 1321 .overlaps(AttributeFuncs::typeIncompatible(Ty)), 1322 "Wrong types for attribute: " + 1323 AttributeSet::get(*Context, Idx, 1324 AttributeFuncs::typeIncompatible(Ty)).getAsString(Idx), 1325 V); 1326 1327 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) { 1328 SmallPtrSet<Type*, 4> Visited; 1329 if (!PTy->getElementType()->isSized(&Visited)) { 1330 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) && 1331 !Attrs.hasAttribute(Idx, Attribute::InAlloca), 1332 "Attributes 'byval' and 'inalloca' do not support unsized types!", 1333 V); 1334 } 1335 } else { 1336 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal), 1337 "Attribute 'byval' only applies to parameters with pointer type!", 1338 V); 1339 } 1340 } 1341 1342 // VerifyFunctionAttrs - Check parameter attributes against a function type. 1343 // The value V is printed in error messages. 1344 void Verifier::VerifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs, 1345 const Value *V) { 1346 if (Attrs.isEmpty()) 1347 return; 1348 1349 bool SawNest = false; 1350 bool SawReturned = false; 1351 bool SawSRet = false; 1352 1353 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) { 1354 unsigned Idx = Attrs.getSlotIndex(i); 1355 1356 Type *Ty; 1357 if (Idx == 0) 1358 Ty = FT->getReturnType(); 1359 else if (Idx-1 < FT->getNumParams()) 1360 Ty = FT->getParamType(Idx-1); 1361 else 1362 break; // VarArgs attributes, verified elsewhere. 1363 1364 VerifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V); 1365 1366 if (Idx == 0) 1367 continue; 1368 1369 if (Attrs.hasAttribute(Idx, Attribute::Nest)) { 1370 Assert(!SawNest, "More than one parameter has attribute nest!", V); 1371 SawNest = true; 1372 } 1373 1374 if (Attrs.hasAttribute(Idx, Attribute::Returned)) { 1375 Assert(!SawReturned, "More than one parameter has attribute returned!", 1376 V); 1377 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()), 1378 "Incompatible " 1379 "argument and return types for 'returned' attribute", 1380 V); 1381 SawReturned = true; 1382 } 1383 1384 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) { 1385 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V); 1386 Assert(Idx == 1 || Idx == 2, 1387 "Attribute 'sret' is not on first or second parameter!", V); 1388 SawSRet = true; 1389 } 1390 1391 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) { 1392 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!", 1393 V); 1394 } 1395 } 1396 1397 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex)) 1398 return; 1399 1400 VerifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V); 1401 1402 Assert( 1403 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) && 1404 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)), 1405 "Attributes 'readnone and readonly' are incompatible!", V); 1406 1407 Assert( 1408 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) && 1409 Attrs.hasAttribute(AttributeSet::FunctionIndex, 1410 Attribute::AlwaysInline)), 1411 "Attributes 'noinline and alwaysinline' are incompatible!", V); 1412 1413 if (Attrs.hasAttribute(AttributeSet::FunctionIndex, 1414 Attribute::OptimizeNone)) { 1415 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline), 1416 "Attribute 'optnone' requires 'noinline'!", V); 1417 1418 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, 1419 Attribute::OptimizeForSize), 1420 "Attributes 'optsize and optnone' are incompatible!", V); 1421 1422 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize), 1423 "Attributes 'minsize and optnone' are incompatible!", V); 1424 } 1425 1426 if (Attrs.hasAttribute(AttributeSet::FunctionIndex, 1427 Attribute::JumpTable)) { 1428 const GlobalValue *GV = cast<GlobalValue>(V); 1429 Assert(GV->hasUnnamedAddr(), 1430 "Attribute 'jumptable' requires 'unnamed_addr'", V); 1431 } 1432 } 1433 1434 void Verifier::VerifyFunctionMetadata( 1435 const SmallVector<std::pair<unsigned, MDNode *>, 4> MDs) { 1436 if (MDs.empty()) 1437 return; 1438 1439 for (unsigned i = 0; i < MDs.size(); i++) { 1440 if (MDs[i].first == LLVMContext::MD_prof) { 1441 MDNode *MD = MDs[i].second; 1442 Assert(MD->getNumOperands() == 2, 1443 "!prof annotations should have exactly 2 operands", MD); 1444 1445 // Check first operand. 1446 Assert(MD->getOperand(0) != nullptr, "first operand should not be null", 1447 MD); 1448 Assert(isa<MDString>(MD->getOperand(0)), 1449 "expected string with name of the !prof annotation", MD); 1450 MDString *MDS = cast<MDString>(MD->getOperand(0)); 1451 StringRef ProfName = MDS->getString(); 1452 Assert(ProfName.equals("function_entry_count"), 1453 "first operand should be 'function_entry_count'", MD); 1454 1455 // Check second operand. 1456 Assert(MD->getOperand(1) != nullptr, "second operand should not be null", 1457 MD); 1458 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)), 1459 "expected integer argument to function_entry_count", MD); 1460 } 1461 } 1462 } 1463 1464 void Verifier::VerifyConstantExprBitcastType(const ConstantExpr *CE) { 1465 if (CE->getOpcode() != Instruction::BitCast) 1466 return; 1467 1468 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0), 1469 CE->getType()), 1470 "Invalid bitcast", CE); 1471 } 1472 1473 bool Verifier::VerifyAttributeCount(AttributeSet Attrs, unsigned Params) { 1474 if (Attrs.getNumSlots() == 0) 1475 return true; 1476 1477 unsigned LastSlot = Attrs.getNumSlots() - 1; 1478 unsigned LastIndex = Attrs.getSlotIndex(LastSlot); 1479 if (LastIndex <= Params 1480 || (LastIndex == AttributeSet::FunctionIndex 1481 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params))) 1482 return true; 1483 1484 return false; 1485 } 1486 1487 /// \brief Verify that statepoint intrinsic is well formed. 1488 void Verifier::VerifyStatepoint(ImmutableCallSite CS) { 1489 assert(CS.getCalledFunction() && 1490 CS.getCalledFunction()->getIntrinsicID() == 1491 Intrinsic::experimental_gc_statepoint); 1492 1493 const Instruction &CI = *CS.getInstruction(); 1494 1495 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() && 1496 !CS.onlyAccessesArgMemory(), 1497 "gc.statepoint must read and write all memory to preserve " 1498 "reordering restrictions required by safepoint semantics", 1499 &CI); 1500 1501 const Value *IDV = CS.getArgument(0); 1502 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer", 1503 &CI); 1504 1505 const Value *NumPatchBytesV = CS.getArgument(1); 1506 Assert(isa<ConstantInt>(NumPatchBytesV), 1507 "gc.statepoint number of patchable bytes must be a constant integer", 1508 &CI); 1509 const int64_t NumPatchBytes = 1510 cast<ConstantInt>(NumPatchBytesV)->getSExtValue(); 1511 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!"); 1512 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be " 1513 "positive", 1514 &CI); 1515 1516 const Value *Target = CS.getArgument(2); 1517 auto *PT = dyn_cast<PointerType>(Target->getType()); 1518 Assert(PT && PT->getElementType()->isFunctionTy(), 1519 "gc.statepoint callee must be of function pointer type", &CI, Target); 1520 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType()); 1521 1522 const Value *NumCallArgsV = CS.getArgument(3); 1523 Assert(isa<ConstantInt>(NumCallArgsV), 1524 "gc.statepoint number of arguments to underlying call " 1525 "must be constant integer", 1526 &CI); 1527 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue(); 1528 Assert(NumCallArgs >= 0, 1529 "gc.statepoint number of arguments to underlying call " 1530 "must be positive", 1531 &CI); 1532 const int NumParams = (int)TargetFuncType->getNumParams(); 1533 if (TargetFuncType->isVarArg()) { 1534 Assert(NumCallArgs >= NumParams, 1535 "gc.statepoint mismatch in number of vararg call args", &CI); 1536 1537 // TODO: Remove this limitation 1538 Assert(TargetFuncType->getReturnType()->isVoidTy(), 1539 "gc.statepoint doesn't support wrapping non-void " 1540 "vararg functions yet", 1541 &CI); 1542 } else 1543 Assert(NumCallArgs == NumParams, 1544 "gc.statepoint mismatch in number of call args", &CI); 1545 1546 const Value *FlagsV = CS.getArgument(4); 1547 Assert(isa<ConstantInt>(FlagsV), 1548 "gc.statepoint flags must be constant integer", &CI); 1549 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue(); 1550 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0, 1551 "unknown flag used in gc.statepoint flags argument", &CI); 1552 1553 // Verify that the types of the call parameter arguments match 1554 // the type of the wrapped callee. 1555 for (int i = 0; i < NumParams; i++) { 1556 Type *ParamType = TargetFuncType->getParamType(i); 1557 Type *ArgType = CS.getArgument(5 + i)->getType(); 1558 Assert(ArgType == ParamType, 1559 "gc.statepoint call argument does not match wrapped " 1560 "function type", 1561 &CI); 1562 } 1563 1564 const int EndCallArgsInx = 4 + NumCallArgs; 1565 1566 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1); 1567 Assert(isa<ConstantInt>(NumTransitionArgsV), 1568 "gc.statepoint number of transition arguments " 1569 "must be constant integer", 1570 &CI); 1571 const int NumTransitionArgs = 1572 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue(); 1573 Assert(NumTransitionArgs >= 0, 1574 "gc.statepoint number of transition arguments must be positive", &CI); 1575 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs; 1576 1577 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1); 1578 Assert(isa<ConstantInt>(NumDeoptArgsV), 1579 "gc.statepoint number of deoptimization arguments " 1580 "must be constant integer", 1581 &CI); 1582 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue(); 1583 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments " 1584 "must be positive", 1585 &CI); 1586 1587 const int ExpectedNumArgs = 1588 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs; 1589 Assert(ExpectedNumArgs <= (int)CS.arg_size(), 1590 "gc.statepoint too few arguments according to length fields", &CI); 1591 1592 // Check that the only uses of this gc.statepoint are gc.result or 1593 // gc.relocate calls which are tied to this statepoint and thus part 1594 // of the same statepoint sequence 1595 for (const User *U : CI.users()) { 1596 const CallInst *Call = dyn_cast<const CallInst>(U); 1597 Assert(Call, "illegal use of statepoint token", &CI, U); 1598 if (!Call) continue; 1599 Assert(isGCRelocate(Call) || isGCResult(Call), 1600 "gc.result or gc.relocate are the only value uses" 1601 "of a gc.statepoint", 1602 &CI, U); 1603 if (isGCResult(Call)) { 1604 Assert(Call->getArgOperand(0) == &CI, 1605 "gc.result connected to wrong gc.statepoint", &CI, Call); 1606 } else if (isGCRelocate(Call)) { 1607 Assert(Call->getArgOperand(0) == &CI, 1608 "gc.relocate connected to wrong gc.statepoint", &CI, Call); 1609 } 1610 } 1611 1612 // Note: It is legal for a single derived pointer to be listed multiple 1613 // times. It's non-optimal, but it is legal. It can also happen after 1614 // insertion if we strip a bitcast away. 1615 // Note: It is really tempting to check that each base is relocated and 1616 // that a derived pointer is never reused as a base pointer. This turns 1617 // out to be problematic since optimizations run after safepoint insertion 1618 // can recognize equality properties that the insertion logic doesn't know 1619 // about. See example statepoint.ll in the verifier subdirectory 1620 } 1621 1622 void Verifier::verifyFrameRecoverIndices() { 1623 for (auto &Counts : FrameEscapeInfo) { 1624 Function *F = Counts.first; 1625 unsigned EscapedObjectCount = Counts.second.first; 1626 unsigned MaxRecoveredIndex = Counts.second.second; 1627 Assert(MaxRecoveredIndex <= EscapedObjectCount, 1628 "all indices passed to llvm.localrecover must be less than the " 1629 "number of arguments passed ot llvm.localescape in the parent " 1630 "function", 1631 F); 1632 } 1633 } 1634 1635 // visitFunction - Verify that a function is ok. 1636 // 1637 void Verifier::visitFunction(const Function &F) { 1638 // Check function arguments. 1639 FunctionType *FT = F.getFunctionType(); 1640 unsigned NumArgs = F.arg_size(); 1641 1642 Assert(Context == &F.getContext(), 1643 "Function context does not match Module context!", &F); 1644 1645 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F); 1646 Assert(FT->getNumParams() == NumArgs, 1647 "# formal arguments must match # of arguments for function type!", &F, 1648 FT); 1649 Assert(F.getReturnType()->isFirstClassType() || 1650 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(), 1651 "Functions cannot return aggregate values!", &F); 1652 1653 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(), 1654 "Invalid struct return type!", &F); 1655 1656 AttributeSet Attrs = F.getAttributes(); 1657 1658 Assert(VerifyAttributeCount(Attrs, FT->getNumParams()), 1659 "Attribute after last parameter!", &F); 1660 1661 // Check function attributes. 1662 VerifyFunctionAttrs(FT, Attrs, &F); 1663 1664 // On function declarations/definitions, we do not support the builtin 1665 // attribute. We do not check this in VerifyFunctionAttrs since that is 1666 // checking for Attributes that can/can not ever be on functions. 1667 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin), 1668 "Attribute 'builtin' can only be applied to a callsite.", &F); 1669 1670 // Check that this function meets the restrictions on this calling convention. 1671 // Sometimes varargs is used for perfectly forwarding thunks, so some of these 1672 // restrictions can be lifted. 1673 switch (F.getCallingConv()) { 1674 default: 1675 case CallingConv::C: 1676 break; 1677 case CallingConv::Fast: 1678 case CallingConv::Cold: 1679 case CallingConv::Intel_OCL_BI: 1680 case CallingConv::PTX_Kernel: 1681 case CallingConv::PTX_Device: 1682 Assert(!F.isVarArg(), "Calling convention does not support varargs or " 1683 "perfect forwarding!", 1684 &F); 1685 break; 1686 } 1687 1688 bool isLLVMdotName = F.getName().size() >= 5 && 1689 F.getName().substr(0, 5) == "llvm."; 1690 1691 // Check that the argument values match the function type for this function... 1692 unsigned i = 0; 1693 for (Function::const_arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E; 1694 ++I, ++i) { 1695 Assert(I->getType() == FT->getParamType(i), 1696 "Argument value does not match function argument type!", I, 1697 FT->getParamType(i)); 1698 Assert(I->getType()->isFirstClassType(), 1699 "Function arguments must have first-class types!", I); 1700 if (!isLLVMdotName) { 1701 Assert(!I->getType()->isMetadataTy(), 1702 "Function takes metadata but isn't an intrinsic", I, &F); 1703 Assert(!I->getType()->isTokenTy(), 1704 "Function takes token but isn't an intrinsic", I, &F); 1705 } 1706 } 1707 1708 if (!isLLVMdotName) 1709 Assert(!F.getReturnType()->isTokenTy(), 1710 "Functions returns a token but isn't an intrinsic", &F); 1711 1712 // Get the function metadata attachments. 1713 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs; 1714 F.getAllMetadata(MDs); 1715 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync"); 1716 VerifyFunctionMetadata(MDs); 1717 1718 // Check validity of the personality function 1719 if (F.hasPersonalityFn()) { 1720 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts()); 1721 if (Per) 1722 Assert(Per->getParent() == F.getParent(), 1723 "Referencing personality function in another module!", &F, Per); 1724 } 1725 1726 if (F.isMaterializable()) { 1727 // Function has a body somewhere we can't see. 1728 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F, 1729 MDs.empty() ? nullptr : MDs.front().second); 1730 } else if (F.isDeclaration()) { 1731 Assert(F.hasExternalLinkage() || F.hasExternalWeakLinkage(), 1732 "invalid linkage type for function declaration", &F); 1733 Assert(MDs.empty(), "function without a body cannot have metadata", &F, 1734 MDs.empty() ? nullptr : MDs.front().second); 1735 Assert(!F.hasPersonalityFn(), 1736 "Function declaration shouldn't have a personality routine", &F); 1737 } else { 1738 // Verify that this function (which has a body) is not named "llvm.*". It 1739 // is not legal to define intrinsics. 1740 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F); 1741 1742 // Check the entry node 1743 const BasicBlock *Entry = &F.getEntryBlock(); 1744 Assert(pred_empty(Entry), 1745 "Entry block to function must not have predecessors!", Entry); 1746 1747 // The address of the entry block cannot be taken, unless it is dead. 1748 if (Entry->hasAddressTaken()) { 1749 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(), 1750 "blockaddress may not be used with the entry block!", Entry); 1751 } 1752 1753 // Visit metadata attachments. 1754 for (const auto &I : MDs) { 1755 // Verify that the attachment is legal. 1756 switch (I.first) { 1757 default: 1758 break; 1759 case LLVMContext::MD_dbg: 1760 Assert(isa<DISubprogram>(I.second), 1761 "function !dbg attachment must be a subprogram", &F, I.second); 1762 break; 1763 } 1764 1765 // Verify the metadata itself. 1766 visitMDNode(*I.second); 1767 } 1768 } 1769 1770 // If this function is actually an intrinsic, verify that it is only used in 1771 // direct call/invokes, never having its "address taken". 1772 if (F.getIntrinsicID()) { 1773 const User *U; 1774 if (F.hasAddressTaken(&U)) 1775 Assert(0, "Invalid user of intrinsic instruction!", U); 1776 } 1777 1778 Assert(!F.hasDLLImportStorageClass() || 1779 (F.isDeclaration() && F.hasExternalLinkage()) || 1780 F.hasAvailableExternallyLinkage(), 1781 "Function is marked as dllimport, but not external.", &F); 1782 1783 auto *N = F.getSubprogram(); 1784 if (!N) 1785 return; 1786 1787 // Check that all !dbg attachments lead to back to N (or, at least, another 1788 // subprogram that describes the same function). 1789 // 1790 // FIXME: Check this incrementally while visiting !dbg attachments. 1791 // FIXME: Only check when N is the canonical subprogram for F. 1792 SmallPtrSet<const MDNode *, 32> Seen; 1793 for (auto &BB : F) 1794 for (auto &I : BB) { 1795 // Be careful about using DILocation here since we might be dealing with 1796 // broken code (this is the Verifier after all). 1797 DILocation *DL = 1798 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode()); 1799 if (!DL) 1800 continue; 1801 if (!Seen.insert(DL).second) 1802 continue; 1803 1804 DILocalScope *Scope = DL->getInlinedAtScope(); 1805 if (Scope && !Seen.insert(Scope).second) 1806 continue; 1807 1808 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr; 1809 if (SP && !Seen.insert(SP).second) 1810 continue; 1811 1812 // FIXME: Once N is canonical, check "SP == &N". 1813 Assert(SP->describes(&F), 1814 "!dbg attachment points at wrong subprogram for function", N, &F, 1815 &I, DL, Scope, SP); 1816 } 1817 } 1818 1819 // verifyBasicBlock - Verify that a basic block is well formed... 1820 // 1821 void Verifier::visitBasicBlock(BasicBlock &BB) { 1822 InstsInThisBlock.clear(); 1823 1824 // Ensure that basic blocks have terminators! 1825 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB); 1826 1827 // Check constraints that this basic block imposes on all of the PHI nodes in 1828 // it. 1829 if (isa<PHINode>(BB.front())) { 1830 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB)); 1831 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values; 1832 std::sort(Preds.begin(), Preds.end()); 1833 PHINode *PN; 1834 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) { 1835 // Ensure that PHI nodes have at least one entry! 1836 Assert(PN->getNumIncomingValues() != 0, 1837 "PHI nodes must have at least one entry. If the block is dead, " 1838 "the PHI should be removed!", 1839 PN); 1840 Assert(PN->getNumIncomingValues() == Preds.size(), 1841 "PHINode should have one entry for each predecessor of its " 1842 "parent basic block!", 1843 PN); 1844 1845 // Get and sort all incoming values in the PHI node... 1846 Values.clear(); 1847 Values.reserve(PN->getNumIncomingValues()); 1848 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) 1849 Values.push_back(std::make_pair(PN->getIncomingBlock(i), 1850 PN->getIncomingValue(i))); 1851 std::sort(Values.begin(), Values.end()); 1852 1853 for (unsigned i = 0, e = Values.size(); i != e; ++i) { 1854 // Check to make sure that if there is more than one entry for a 1855 // particular basic block in this PHI node, that the incoming values are 1856 // all identical. 1857 // 1858 Assert(i == 0 || Values[i].first != Values[i - 1].first || 1859 Values[i].second == Values[i - 1].second, 1860 "PHI node has multiple entries for the same basic block with " 1861 "different incoming values!", 1862 PN, Values[i].first, Values[i].second, Values[i - 1].second); 1863 1864 // Check to make sure that the predecessors and PHI node entries are 1865 // matched up. 1866 Assert(Values[i].first == Preds[i], 1867 "PHI node entries do not match predecessors!", PN, 1868 Values[i].first, Preds[i]); 1869 } 1870 } 1871 } 1872 1873 // Check that all instructions have their parent pointers set up correctly. 1874 for (auto &I : BB) 1875 { 1876 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!"); 1877 } 1878 } 1879 1880 void Verifier::visitTerminatorInst(TerminatorInst &I) { 1881 // Ensure that terminators only exist at the end of the basic block. 1882 Assert(&I == I.getParent()->getTerminator(), 1883 "Terminator found in the middle of a basic block!", I.getParent()); 1884 visitInstruction(I); 1885 } 1886 1887 void Verifier::visitBranchInst(BranchInst &BI) { 1888 if (BI.isConditional()) { 1889 Assert(BI.getCondition()->getType()->isIntegerTy(1), 1890 "Branch condition is not 'i1' type!", &BI, BI.getCondition()); 1891 } 1892 visitTerminatorInst(BI); 1893 } 1894 1895 void Verifier::visitReturnInst(ReturnInst &RI) { 1896 Function *F = RI.getParent()->getParent(); 1897 unsigned N = RI.getNumOperands(); 1898 if (F->getReturnType()->isVoidTy()) 1899 Assert(N == 0, 1900 "Found return instr that returns non-void in Function of void " 1901 "return type!", 1902 &RI, F->getReturnType()); 1903 else 1904 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(), 1905 "Function return type does not match operand " 1906 "type of return inst!", 1907 &RI, F->getReturnType()); 1908 1909 // Check to make sure that the return value has necessary properties for 1910 // terminators... 1911 visitTerminatorInst(RI); 1912 } 1913 1914 void Verifier::visitSwitchInst(SwitchInst &SI) { 1915 // Check to make sure that all of the constants in the switch instruction 1916 // have the same type as the switched-on value. 1917 Type *SwitchTy = SI.getCondition()->getType(); 1918 SmallPtrSet<ConstantInt*, 32> Constants; 1919 for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end(); i != e; ++i) { 1920 Assert(i.getCaseValue()->getType() == SwitchTy, 1921 "Switch constants must all be same type as switch value!", &SI); 1922 Assert(Constants.insert(i.getCaseValue()).second, 1923 "Duplicate integer as switch case", &SI, i.getCaseValue()); 1924 } 1925 1926 visitTerminatorInst(SI); 1927 } 1928 1929 void Verifier::visitIndirectBrInst(IndirectBrInst &BI) { 1930 Assert(BI.getAddress()->getType()->isPointerTy(), 1931 "Indirectbr operand must have pointer type!", &BI); 1932 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i) 1933 Assert(BI.getDestination(i)->getType()->isLabelTy(), 1934 "Indirectbr destinations must all have pointer type!", &BI); 1935 1936 visitTerminatorInst(BI); 1937 } 1938 1939 void Verifier::visitSelectInst(SelectInst &SI) { 1940 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1), 1941 SI.getOperand(2)), 1942 "Invalid operands for select instruction!", &SI); 1943 1944 Assert(SI.getTrueValue()->getType() == SI.getType(), 1945 "Select values must have same type as select instruction!", &SI); 1946 visitInstruction(SI); 1947 } 1948 1949 /// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of 1950 /// a pass, if any exist, it's an error. 1951 /// 1952 void Verifier::visitUserOp1(Instruction &I) { 1953 Assert(0, "User-defined operators should not live outside of a pass!", &I); 1954 } 1955 1956 void Verifier::visitTruncInst(TruncInst &I) { 1957 // Get the source and destination types 1958 Type *SrcTy = I.getOperand(0)->getType(); 1959 Type *DestTy = I.getType(); 1960 1961 // Get the size of the types in bits, we'll need this later 1962 unsigned SrcBitSize = SrcTy->getScalarSizeInBits(); 1963 unsigned DestBitSize = DestTy->getScalarSizeInBits(); 1964 1965 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I); 1966 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I); 1967 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), 1968 "trunc source and destination must both be a vector or neither", &I); 1969 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I); 1970 1971 visitInstruction(I); 1972 } 1973 1974 void Verifier::visitZExtInst(ZExtInst &I) { 1975 // Get the source and destination types 1976 Type *SrcTy = I.getOperand(0)->getType(); 1977 Type *DestTy = I.getType(); 1978 1979 // Get the size of the types in bits, we'll need this later 1980 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I); 1981 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I); 1982 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), 1983 "zext source and destination must both be a vector or neither", &I); 1984 unsigned SrcBitSize = SrcTy->getScalarSizeInBits(); 1985 unsigned DestBitSize = DestTy->getScalarSizeInBits(); 1986 1987 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I); 1988 1989 visitInstruction(I); 1990 } 1991 1992 void Verifier::visitSExtInst(SExtInst &I) { 1993 // Get the source and destination types 1994 Type *SrcTy = I.getOperand(0)->getType(); 1995 Type *DestTy = I.getType(); 1996 1997 // Get the size of the types in bits, we'll need this later 1998 unsigned SrcBitSize = SrcTy->getScalarSizeInBits(); 1999 unsigned DestBitSize = DestTy->getScalarSizeInBits(); 2000 2001 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I); 2002 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I); 2003 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), 2004 "sext source and destination must both be a vector or neither", &I); 2005 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I); 2006 2007 visitInstruction(I); 2008 } 2009 2010 void Verifier::visitFPTruncInst(FPTruncInst &I) { 2011 // Get the source and destination types 2012 Type *SrcTy = I.getOperand(0)->getType(); 2013 Type *DestTy = I.getType(); 2014 // Get the size of the types in bits, we'll need this later 2015 unsigned SrcBitSize = SrcTy->getScalarSizeInBits(); 2016 unsigned DestBitSize = DestTy->getScalarSizeInBits(); 2017 2018 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I); 2019 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I); 2020 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), 2021 "fptrunc source and destination must both be a vector or neither", &I); 2022 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I); 2023 2024 visitInstruction(I); 2025 } 2026 2027 void Verifier::visitFPExtInst(FPExtInst &I) { 2028 // Get the source and destination types 2029 Type *SrcTy = I.getOperand(0)->getType(); 2030 Type *DestTy = I.getType(); 2031 2032 // Get the size of the types in bits, we'll need this later 2033 unsigned SrcBitSize = SrcTy->getScalarSizeInBits(); 2034 unsigned DestBitSize = DestTy->getScalarSizeInBits(); 2035 2036 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I); 2037 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I); 2038 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), 2039 "fpext source and destination must both be a vector or neither", &I); 2040 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I); 2041 2042 visitInstruction(I); 2043 } 2044 2045 void Verifier::visitUIToFPInst(UIToFPInst &I) { 2046 // Get the source and destination types 2047 Type *SrcTy = I.getOperand(0)->getType(); 2048 Type *DestTy = I.getType(); 2049 2050 bool SrcVec = SrcTy->isVectorTy(); 2051 bool DstVec = DestTy->isVectorTy(); 2052 2053 Assert(SrcVec == DstVec, 2054 "UIToFP source and dest must both be vector or scalar", &I); 2055 Assert(SrcTy->isIntOrIntVectorTy(), 2056 "UIToFP source must be integer or integer vector", &I); 2057 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector", 2058 &I); 2059 2060 if (SrcVec && DstVec) 2061 Assert(cast<VectorType>(SrcTy)->getNumElements() == 2062 cast<VectorType>(DestTy)->getNumElements(), 2063 "UIToFP source and dest vector length mismatch", &I); 2064 2065 visitInstruction(I); 2066 } 2067 2068 void Verifier::visitSIToFPInst(SIToFPInst &I) { 2069 // Get the source and destination types 2070 Type *SrcTy = I.getOperand(0)->getType(); 2071 Type *DestTy = I.getType(); 2072 2073 bool SrcVec = SrcTy->isVectorTy(); 2074 bool DstVec = DestTy->isVectorTy(); 2075 2076 Assert(SrcVec == DstVec, 2077 "SIToFP source and dest must both be vector or scalar", &I); 2078 Assert(SrcTy->isIntOrIntVectorTy(), 2079 "SIToFP source must be integer or integer vector", &I); 2080 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector", 2081 &I); 2082 2083 if (SrcVec && DstVec) 2084 Assert(cast<VectorType>(SrcTy)->getNumElements() == 2085 cast<VectorType>(DestTy)->getNumElements(), 2086 "SIToFP source and dest vector length mismatch", &I); 2087 2088 visitInstruction(I); 2089 } 2090 2091 void Verifier::visitFPToUIInst(FPToUIInst &I) { 2092 // Get the source and destination types 2093 Type *SrcTy = I.getOperand(0)->getType(); 2094 Type *DestTy = I.getType(); 2095 2096 bool SrcVec = SrcTy->isVectorTy(); 2097 bool DstVec = DestTy->isVectorTy(); 2098 2099 Assert(SrcVec == DstVec, 2100 "FPToUI source and dest must both be vector or scalar", &I); 2101 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector", 2102 &I); 2103 Assert(DestTy->isIntOrIntVectorTy(), 2104 "FPToUI result must be integer or integer vector", &I); 2105 2106 if (SrcVec && DstVec) 2107 Assert(cast<VectorType>(SrcTy)->getNumElements() == 2108 cast<VectorType>(DestTy)->getNumElements(), 2109 "FPToUI source and dest vector length mismatch", &I); 2110 2111 visitInstruction(I); 2112 } 2113 2114 void Verifier::visitFPToSIInst(FPToSIInst &I) { 2115 // Get the source and destination types 2116 Type *SrcTy = I.getOperand(0)->getType(); 2117 Type *DestTy = I.getType(); 2118 2119 bool SrcVec = SrcTy->isVectorTy(); 2120 bool DstVec = DestTy->isVectorTy(); 2121 2122 Assert(SrcVec == DstVec, 2123 "FPToSI source and dest must both be vector or scalar", &I); 2124 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector", 2125 &I); 2126 Assert(DestTy->isIntOrIntVectorTy(), 2127 "FPToSI result must be integer or integer vector", &I); 2128 2129 if (SrcVec && DstVec) 2130 Assert(cast<VectorType>(SrcTy)->getNumElements() == 2131 cast<VectorType>(DestTy)->getNumElements(), 2132 "FPToSI source and dest vector length mismatch", &I); 2133 2134 visitInstruction(I); 2135 } 2136 2137 void Verifier::visitPtrToIntInst(PtrToIntInst &I) { 2138 // Get the source and destination types 2139 Type *SrcTy = I.getOperand(0)->getType(); 2140 Type *DestTy = I.getType(); 2141 2142 Assert(SrcTy->getScalarType()->isPointerTy(), 2143 "PtrToInt source must be pointer", &I); 2144 Assert(DestTy->getScalarType()->isIntegerTy(), 2145 "PtrToInt result must be integral", &I); 2146 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch", 2147 &I); 2148 2149 if (SrcTy->isVectorTy()) { 2150 VectorType *VSrc = dyn_cast<VectorType>(SrcTy); 2151 VectorType *VDest = dyn_cast<VectorType>(DestTy); 2152 Assert(VSrc->getNumElements() == VDest->getNumElements(), 2153 "PtrToInt Vector width mismatch", &I); 2154 } 2155 2156 visitInstruction(I); 2157 } 2158 2159 void Verifier::visitIntToPtrInst(IntToPtrInst &I) { 2160 // Get the source and destination types 2161 Type *SrcTy = I.getOperand(0)->getType(); 2162 Type *DestTy = I.getType(); 2163 2164 Assert(SrcTy->getScalarType()->isIntegerTy(), 2165 "IntToPtr source must be an integral", &I); 2166 Assert(DestTy->getScalarType()->isPointerTy(), 2167 "IntToPtr result must be a pointer", &I); 2168 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch", 2169 &I); 2170 if (SrcTy->isVectorTy()) { 2171 VectorType *VSrc = dyn_cast<VectorType>(SrcTy); 2172 VectorType *VDest = dyn_cast<VectorType>(DestTy); 2173 Assert(VSrc->getNumElements() == VDest->getNumElements(), 2174 "IntToPtr Vector width mismatch", &I); 2175 } 2176 visitInstruction(I); 2177 } 2178 2179 void Verifier::visitBitCastInst(BitCastInst &I) { 2180 Assert( 2181 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()), 2182 "Invalid bitcast", &I); 2183 visitInstruction(I); 2184 } 2185 2186 void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) { 2187 Type *SrcTy = I.getOperand(0)->getType(); 2188 Type *DestTy = I.getType(); 2189 2190 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer", 2191 &I); 2192 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer", 2193 &I); 2194 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(), 2195 "AddrSpaceCast must be between different address spaces", &I); 2196 if (SrcTy->isVectorTy()) 2197 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(), 2198 "AddrSpaceCast vector pointer number of elements mismatch", &I); 2199 visitInstruction(I); 2200 } 2201 2202 /// visitPHINode - Ensure that a PHI node is well formed. 2203 /// 2204 void Verifier::visitPHINode(PHINode &PN) { 2205 // Ensure that the PHI nodes are all grouped together at the top of the block. 2206 // This can be tested by checking whether the instruction before this is 2207 // either nonexistent (because this is begin()) or is a PHI node. If not, 2208 // then there is some other instruction before a PHI. 2209 Assert(&PN == &PN.getParent()->front() || 2210 isa<PHINode>(--BasicBlock::iterator(&PN)), 2211 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent()); 2212 2213 // Check that a PHI doesn't yield a Token. 2214 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!"); 2215 2216 // Check that all of the values of the PHI node have the same type as the 2217 // result, and that the incoming blocks are really basic blocks. 2218 for (Value *IncValue : PN.incoming_values()) { 2219 Assert(PN.getType() == IncValue->getType(), 2220 "PHI node operands are not the same type as the result!", &PN); 2221 } 2222 2223 // All other PHI node constraints are checked in the visitBasicBlock method. 2224 2225 visitInstruction(PN); 2226 } 2227 2228 void Verifier::VerifyCallSite(CallSite CS) { 2229 Instruction *I = CS.getInstruction(); 2230 2231 Assert(CS.getCalledValue()->getType()->isPointerTy(), 2232 "Called function must be a pointer!", I); 2233 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType()); 2234 2235 Assert(FPTy->getElementType()->isFunctionTy(), 2236 "Called function is not pointer to function type!", I); 2237 2238 Assert(FPTy->getElementType() == CS.getFunctionType(), 2239 "Called function is not the same type as the call!", I); 2240 2241 FunctionType *FTy = CS.getFunctionType(); 2242 2243 // Verify that the correct number of arguments are being passed 2244 if (FTy->isVarArg()) 2245 Assert(CS.arg_size() >= FTy->getNumParams(), 2246 "Called function requires more parameters than were provided!", I); 2247 else 2248 Assert(CS.arg_size() == FTy->getNumParams(), 2249 "Incorrect number of arguments passed to called function!", I); 2250 2251 // Verify that all arguments to the call match the function type. 2252 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) 2253 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i), 2254 "Call parameter type does not match function signature!", 2255 CS.getArgument(i), FTy->getParamType(i), I); 2256 2257 AttributeSet Attrs = CS.getAttributes(); 2258 2259 Assert(VerifyAttributeCount(Attrs, CS.arg_size()), 2260 "Attribute after last parameter!", I); 2261 2262 // Verify call attributes. 2263 VerifyFunctionAttrs(FTy, Attrs, I); 2264 2265 // Conservatively check the inalloca argument. 2266 // We have a bug if we can find that there is an underlying alloca without 2267 // inalloca. 2268 if (CS.hasInAllocaArgument()) { 2269 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1); 2270 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets())) 2271 Assert(AI->isUsedWithInAlloca(), 2272 "inalloca argument for call has mismatched alloca", AI, I); 2273 } 2274 2275 if (FTy->isVarArg()) { 2276 // FIXME? is 'nest' even legal here? 2277 bool SawNest = false; 2278 bool SawReturned = false; 2279 2280 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) { 2281 if (Attrs.hasAttribute(Idx, Attribute::Nest)) 2282 SawNest = true; 2283 if (Attrs.hasAttribute(Idx, Attribute::Returned)) 2284 SawReturned = true; 2285 } 2286 2287 // Check attributes on the varargs part. 2288 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) { 2289 Type *Ty = CS.getArgument(Idx-1)->getType(); 2290 VerifyParameterAttrs(Attrs, Idx, Ty, false, I); 2291 2292 if (Attrs.hasAttribute(Idx, Attribute::Nest)) { 2293 Assert(!SawNest, "More than one parameter has attribute nest!", I); 2294 SawNest = true; 2295 } 2296 2297 if (Attrs.hasAttribute(Idx, Attribute::Returned)) { 2298 Assert(!SawReturned, "More than one parameter has attribute returned!", 2299 I); 2300 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()), 2301 "Incompatible argument and return types for 'returned' " 2302 "attribute", 2303 I); 2304 SawReturned = true; 2305 } 2306 2307 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet), 2308 "Attribute 'sret' cannot be used for vararg call arguments!", I); 2309 2310 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) 2311 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I); 2312 } 2313 } 2314 2315 // Verify that there's no metadata unless it's a direct call to an intrinsic. 2316 if (CS.getCalledFunction() == nullptr || 2317 !CS.getCalledFunction()->getName().startswith("llvm.")) { 2318 for (Type *ParamTy : FTy->params()) { 2319 Assert(!ParamTy->isMetadataTy(), 2320 "Function has metadata parameter but isn't an intrinsic", I); 2321 Assert(!ParamTy->isTokenTy(), 2322 "Function has token parameter but isn't an intrinsic", I); 2323 } 2324 } 2325 2326 // Verify that indirect calls don't return tokens. 2327 if (CS.getCalledFunction() == nullptr) 2328 Assert(!FTy->getReturnType()->isTokenTy(), 2329 "Return type cannot be token for indirect call!"); 2330 2331 if (Function *F = CS.getCalledFunction()) 2332 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID()) 2333 visitIntrinsicCallSite(ID, CS); 2334 2335 // Verify that a callsite has at most one "deopt" operand bundle. 2336 bool FoundDeoptBundle = false; 2337 for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) { 2338 if (CS.getOperandBundleAt(i).getTagID() == LLVMContext::OB_deopt) { 2339 Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I); 2340 FoundDeoptBundle = true; 2341 } 2342 } 2343 2344 visitInstruction(*I); 2345 } 2346 2347 /// Two types are "congruent" if they are identical, or if they are both pointer 2348 /// types with different pointee types and the same address space. 2349 static bool isTypeCongruent(Type *L, Type *R) { 2350 if (L == R) 2351 return true; 2352 PointerType *PL = dyn_cast<PointerType>(L); 2353 PointerType *PR = dyn_cast<PointerType>(R); 2354 if (!PL || !PR) 2355 return false; 2356 return PL->getAddressSpace() == PR->getAddressSpace(); 2357 } 2358 2359 static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) { 2360 static const Attribute::AttrKind ABIAttrs[] = { 2361 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca, 2362 Attribute::InReg, Attribute::Returned}; 2363 AttrBuilder Copy; 2364 for (auto AK : ABIAttrs) { 2365 if (Attrs.hasAttribute(I + 1, AK)) 2366 Copy.addAttribute(AK); 2367 } 2368 if (Attrs.hasAttribute(I + 1, Attribute::Alignment)) 2369 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1)); 2370 return Copy; 2371 } 2372 2373 void Verifier::verifyMustTailCall(CallInst &CI) { 2374 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI); 2375 2376 // - The caller and callee prototypes must match. Pointer types of 2377 // parameters or return types may differ in pointee type, but not 2378 // address space. 2379 Function *F = CI.getParent()->getParent(); 2380 FunctionType *CallerTy = F->getFunctionType(); 2381 FunctionType *CalleeTy = CI.getFunctionType(); 2382 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(), 2383 "cannot guarantee tail call due to mismatched parameter counts", &CI); 2384 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(), 2385 "cannot guarantee tail call due to mismatched varargs", &CI); 2386 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()), 2387 "cannot guarantee tail call due to mismatched return types", &CI); 2388 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) { 2389 Assert( 2390 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)), 2391 "cannot guarantee tail call due to mismatched parameter types", &CI); 2392 } 2393 2394 // - The calling conventions of the caller and callee must match. 2395 Assert(F->getCallingConv() == CI.getCallingConv(), 2396 "cannot guarantee tail call due to mismatched calling conv", &CI); 2397 2398 // - All ABI-impacting function attributes, such as sret, byval, inreg, 2399 // returned, and inalloca, must match. 2400 AttributeSet CallerAttrs = F->getAttributes(); 2401 AttributeSet CalleeAttrs = CI.getAttributes(); 2402 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) { 2403 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs); 2404 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs); 2405 Assert(CallerABIAttrs == CalleeABIAttrs, 2406 "cannot guarantee tail call due to mismatched ABI impacting " 2407 "function attributes", 2408 &CI, CI.getOperand(I)); 2409 } 2410 2411 // - The call must immediately precede a :ref:`ret <i_ret>` instruction, 2412 // or a pointer bitcast followed by a ret instruction. 2413 // - The ret instruction must return the (possibly bitcasted) value 2414 // produced by the call or void. 2415 Value *RetVal = &CI; 2416 Instruction *Next = CI.getNextNode(); 2417 2418 // Handle the optional bitcast. 2419 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) { 2420 Assert(BI->getOperand(0) == RetVal, 2421 "bitcast following musttail call must use the call", BI); 2422 RetVal = BI; 2423 Next = BI->getNextNode(); 2424 } 2425 2426 // Check the return. 2427 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next); 2428 Assert(Ret, "musttail call must be precede a ret with an optional bitcast", 2429 &CI); 2430 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal, 2431 "musttail call result must be returned", Ret); 2432 } 2433 2434 void Verifier::visitCallInst(CallInst &CI) { 2435 VerifyCallSite(&CI); 2436 2437 if (CI.isMustTailCall()) 2438 verifyMustTailCall(CI); 2439 } 2440 2441 void Verifier::visitInvokeInst(InvokeInst &II) { 2442 VerifyCallSite(&II); 2443 2444 // Verify that the first non-PHI instruction of the unwind destination is an 2445 // exception handling instruction. 2446 Assert( 2447 II.getUnwindDest()->isEHPad(), 2448 "The unwind destination does not have an exception handling instruction!", 2449 &II); 2450 2451 visitTerminatorInst(II); 2452 } 2453 2454 /// visitBinaryOperator - Check that both arguments to the binary operator are 2455 /// of the same type! 2456 /// 2457 void Verifier::visitBinaryOperator(BinaryOperator &B) { 2458 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(), 2459 "Both operands to a binary operator are not of the same type!", &B); 2460 2461 switch (B.getOpcode()) { 2462 // Check that integer arithmetic operators are only used with 2463 // integral operands. 2464 case Instruction::Add: 2465 case Instruction::Sub: 2466 case Instruction::Mul: 2467 case Instruction::SDiv: 2468 case Instruction::UDiv: 2469 case Instruction::SRem: 2470 case Instruction::URem: 2471 Assert(B.getType()->isIntOrIntVectorTy(), 2472 "Integer arithmetic operators only work with integral types!", &B); 2473 Assert(B.getType() == B.getOperand(0)->getType(), 2474 "Integer arithmetic operators must have same type " 2475 "for operands and result!", 2476 &B); 2477 break; 2478 // Check that floating-point arithmetic operators are only used with 2479 // floating-point operands. 2480 case Instruction::FAdd: 2481 case Instruction::FSub: 2482 case Instruction::FMul: 2483 case Instruction::FDiv: 2484 case Instruction::FRem: 2485 Assert(B.getType()->isFPOrFPVectorTy(), 2486 "Floating-point arithmetic operators only work with " 2487 "floating-point types!", 2488 &B); 2489 Assert(B.getType() == B.getOperand(0)->getType(), 2490 "Floating-point arithmetic operators must have same type " 2491 "for operands and result!", 2492 &B); 2493 break; 2494 // Check that logical operators are only used with integral operands. 2495 case Instruction::And: 2496 case Instruction::Or: 2497 case Instruction::Xor: 2498 Assert(B.getType()->isIntOrIntVectorTy(), 2499 "Logical operators only work with integral types!", &B); 2500 Assert(B.getType() == B.getOperand(0)->getType(), 2501 "Logical operators must have same type for operands and result!", 2502 &B); 2503 break; 2504 case Instruction::Shl: 2505 case Instruction::LShr: 2506 case Instruction::AShr: 2507 Assert(B.getType()->isIntOrIntVectorTy(), 2508 "Shifts only work with integral types!", &B); 2509 Assert(B.getType() == B.getOperand(0)->getType(), 2510 "Shift return type must be same as operands!", &B); 2511 break; 2512 default: 2513 llvm_unreachable("Unknown BinaryOperator opcode!"); 2514 } 2515 2516 visitInstruction(B); 2517 } 2518 2519 void Verifier::visitICmpInst(ICmpInst &IC) { 2520 // Check that the operands are the same type 2521 Type *Op0Ty = IC.getOperand(0)->getType(); 2522 Type *Op1Ty = IC.getOperand(1)->getType(); 2523 Assert(Op0Ty == Op1Ty, 2524 "Both operands to ICmp instruction are not of the same type!", &IC); 2525 // Check that the operands are the right type 2526 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(), 2527 "Invalid operand types for ICmp instruction", &IC); 2528 // Check that the predicate is valid. 2529 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE && 2530 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE, 2531 "Invalid predicate in ICmp instruction!", &IC); 2532 2533 visitInstruction(IC); 2534 } 2535 2536 void Verifier::visitFCmpInst(FCmpInst &FC) { 2537 // Check that the operands are the same type 2538 Type *Op0Ty = FC.getOperand(0)->getType(); 2539 Type *Op1Ty = FC.getOperand(1)->getType(); 2540 Assert(Op0Ty == Op1Ty, 2541 "Both operands to FCmp instruction are not of the same type!", &FC); 2542 // Check that the operands are the right type 2543 Assert(Op0Ty->isFPOrFPVectorTy(), 2544 "Invalid operand types for FCmp instruction", &FC); 2545 // Check that the predicate is valid. 2546 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE && 2547 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE, 2548 "Invalid predicate in FCmp instruction!", &FC); 2549 2550 visitInstruction(FC); 2551 } 2552 2553 void Verifier::visitExtractElementInst(ExtractElementInst &EI) { 2554 Assert( 2555 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)), 2556 "Invalid extractelement operands!", &EI); 2557 visitInstruction(EI); 2558 } 2559 2560 void Verifier::visitInsertElementInst(InsertElementInst &IE) { 2561 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1), 2562 IE.getOperand(2)), 2563 "Invalid insertelement operands!", &IE); 2564 visitInstruction(IE); 2565 } 2566 2567 void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) { 2568 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1), 2569 SV.getOperand(2)), 2570 "Invalid shufflevector operands!", &SV); 2571 visitInstruction(SV); 2572 } 2573 2574 void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) { 2575 Type *TargetTy = GEP.getPointerOperandType()->getScalarType(); 2576 2577 Assert(isa<PointerType>(TargetTy), 2578 "GEP base pointer is not a vector or a vector of pointers", &GEP); 2579 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP); 2580 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end()); 2581 Type *ElTy = 2582 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs); 2583 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP); 2584 2585 Assert(GEP.getType()->getScalarType()->isPointerTy() && 2586 GEP.getResultElementType() == ElTy, 2587 "GEP is not of right type for indices!", &GEP, ElTy); 2588 2589 if (GEP.getType()->isVectorTy()) { 2590 // Additional checks for vector GEPs. 2591 unsigned GEPWidth = GEP.getType()->getVectorNumElements(); 2592 if (GEP.getPointerOperandType()->isVectorTy()) 2593 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(), 2594 "Vector GEP result width doesn't match operand's", &GEP); 2595 for (unsigned i = 0, e = Idxs.size(); i != e; ++i) { 2596 Type *IndexTy = Idxs[i]->getType(); 2597 if (IndexTy->isVectorTy()) { 2598 unsigned IndexWidth = IndexTy->getVectorNumElements(); 2599 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP); 2600 } 2601 Assert(IndexTy->getScalarType()->isIntegerTy(), 2602 "All GEP indices should be of integer type"); 2603 } 2604 } 2605 visitInstruction(GEP); 2606 } 2607 2608 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) { 2609 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper(); 2610 } 2611 2612 void Verifier::visitRangeMetadata(Instruction& I, 2613 MDNode* Range, Type* Ty) { 2614 assert(Range && 2615 Range == I.getMetadata(LLVMContext::MD_range) && 2616 "precondition violation"); 2617 2618 unsigned NumOperands = Range->getNumOperands(); 2619 Assert(NumOperands % 2 == 0, "Unfinished range!", Range); 2620 unsigned NumRanges = NumOperands / 2; 2621 Assert(NumRanges >= 1, "It should have at least one range!", Range); 2622 2623 ConstantRange LastRange(1); // Dummy initial value 2624 for (unsigned i = 0; i < NumRanges; ++i) { 2625 ConstantInt *Low = 2626 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i)); 2627 Assert(Low, "The lower limit must be an integer!", Low); 2628 ConstantInt *High = 2629 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1)); 2630 Assert(High, "The upper limit must be an integer!", High); 2631 Assert(High->getType() == Low->getType() && High->getType() == Ty, 2632 "Range types must match instruction type!", &I); 2633 2634 APInt HighV = High->getValue(); 2635 APInt LowV = Low->getValue(); 2636 ConstantRange CurRange(LowV, HighV); 2637 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(), 2638 "Range must not be empty!", Range); 2639 if (i != 0) { 2640 Assert(CurRange.intersectWith(LastRange).isEmptySet(), 2641 "Intervals are overlapping", Range); 2642 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order", 2643 Range); 2644 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous", 2645 Range); 2646 } 2647 LastRange = ConstantRange(LowV, HighV); 2648 } 2649 if (NumRanges > 2) { 2650 APInt FirstLow = 2651 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue(); 2652 APInt FirstHigh = 2653 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue(); 2654 ConstantRange FirstRange(FirstLow, FirstHigh); 2655 Assert(FirstRange.intersectWith(LastRange).isEmptySet(), 2656 "Intervals are overlapping", Range); 2657 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous", 2658 Range); 2659 } 2660 } 2661 2662 void Verifier::visitLoadInst(LoadInst &LI) { 2663 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType()); 2664 Assert(PTy, "Load operand must be a pointer.", &LI); 2665 Type *ElTy = LI.getType(); 2666 Assert(LI.getAlignment() <= Value::MaximumAlignment, 2667 "huge alignment values are unsupported", &LI); 2668 if (LI.isAtomic()) { 2669 Assert(LI.getOrdering() != Release && LI.getOrdering() != AcquireRelease, 2670 "Load cannot have Release ordering", &LI); 2671 Assert(LI.getAlignment() != 0, 2672 "Atomic load must specify explicit alignment", &LI); 2673 if (!ElTy->isPointerTy()) { 2674 Assert(ElTy->isIntegerTy(), "atomic load operand must have integer type!", 2675 &LI, ElTy); 2676 unsigned Size = ElTy->getPrimitiveSizeInBits(); 2677 Assert(Size >= 8 && !(Size & (Size - 1)), 2678 "atomic load operand must be power-of-two byte-sized integer", &LI, 2679 ElTy); 2680 } 2681 } else { 2682 Assert(LI.getSynchScope() == CrossThread, 2683 "Non-atomic load cannot have SynchronizationScope specified", &LI); 2684 } 2685 2686 visitInstruction(LI); 2687 } 2688 2689 void Verifier::visitStoreInst(StoreInst &SI) { 2690 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType()); 2691 Assert(PTy, "Store operand must be a pointer.", &SI); 2692 Type *ElTy = PTy->getElementType(); 2693 Assert(ElTy == SI.getOperand(0)->getType(), 2694 "Stored value type does not match pointer operand type!", &SI, ElTy); 2695 Assert(SI.getAlignment() <= Value::MaximumAlignment, 2696 "huge alignment values are unsupported", &SI); 2697 if (SI.isAtomic()) { 2698 Assert(SI.getOrdering() != Acquire && SI.getOrdering() != AcquireRelease, 2699 "Store cannot have Acquire ordering", &SI); 2700 Assert(SI.getAlignment() != 0, 2701 "Atomic store must specify explicit alignment", &SI); 2702 if (!ElTy->isPointerTy()) { 2703 Assert(ElTy->isIntegerTy(), 2704 "atomic store operand must have integer type!", &SI, ElTy); 2705 unsigned Size = ElTy->getPrimitiveSizeInBits(); 2706 Assert(Size >= 8 && !(Size & (Size - 1)), 2707 "atomic store operand must be power-of-two byte-sized integer", 2708 &SI, ElTy); 2709 } 2710 } else { 2711 Assert(SI.getSynchScope() == CrossThread, 2712 "Non-atomic store cannot have SynchronizationScope specified", &SI); 2713 } 2714 visitInstruction(SI); 2715 } 2716 2717 void Verifier::visitAllocaInst(AllocaInst &AI) { 2718 SmallPtrSet<Type*, 4> Visited; 2719 PointerType *PTy = AI.getType(); 2720 Assert(PTy->getAddressSpace() == 0, 2721 "Allocation instruction pointer not in the generic address space!", 2722 &AI); 2723 Assert(AI.getAllocatedType()->isSized(&Visited), 2724 "Cannot allocate unsized type", &AI); 2725 Assert(AI.getArraySize()->getType()->isIntegerTy(), 2726 "Alloca array size must have integer type", &AI); 2727 Assert(AI.getAlignment() <= Value::MaximumAlignment, 2728 "huge alignment values are unsupported", &AI); 2729 2730 visitInstruction(AI); 2731 } 2732 2733 void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) { 2734 2735 // FIXME: more conditions??? 2736 Assert(CXI.getSuccessOrdering() != NotAtomic, 2737 "cmpxchg instructions must be atomic.", &CXI); 2738 Assert(CXI.getFailureOrdering() != NotAtomic, 2739 "cmpxchg instructions must be atomic.", &CXI); 2740 Assert(CXI.getSuccessOrdering() != Unordered, 2741 "cmpxchg instructions cannot be unordered.", &CXI); 2742 Assert(CXI.getFailureOrdering() != Unordered, 2743 "cmpxchg instructions cannot be unordered.", &CXI); 2744 Assert(CXI.getSuccessOrdering() >= CXI.getFailureOrdering(), 2745 "cmpxchg instructions be at least as constrained on success as fail", 2746 &CXI); 2747 Assert(CXI.getFailureOrdering() != Release && 2748 CXI.getFailureOrdering() != AcquireRelease, 2749 "cmpxchg failure ordering cannot include release semantics", &CXI); 2750 2751 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType()); 2752 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI); 2753 Type *ElTy = PTy->getElementType(); 2754 Assert(ElTy->isIntegerTy(), "cmpxchg operand must have integer type!", &CXI, 2755 ElTy); 2756 unsigned Size = ElTy->getPrimitiveSizeInBits(); 2757 Assert(Size >= 8 && !(Size & (Size - 1)), 2758 "cmpxchg operand must be power-of-two byte-sized integer", &CXI, ElTy); 2759 Assert(ElTy == CXI.getOperand(1)->getType(), 2760 "Expected value type does not match pointer operand type!", &CXI, 2761 ElTy); 2762 Assert(ElTy == CXI.getOperand(2)->getType(), 2763 "Stored value type does not match pointer operand type!", &CXI, ElTy); 2764 visitInstruction(CXI); 2765 } 2766 2767 void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) { 2768 Assert(RMWI.getOrdering() != NotAtomic, 2769 "atomicrmw instructions must be atomic.", &RMWI); 2770 Assert(RMWI.getOrdering() != Unordered, 2771 "atomicrmw instructions cannot be unordered.", &RMWI); 2772 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType()); 2773 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI); 2774 Type *ElTy = PTy->getElementType(); 2775 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!", 2776 &RMWI, ElTy); 2777 unsigned Size = ElTy->getPrimitiveSizeInBits(); 2778 Assert(Size >= 8 && !(Size & (Size - 1)), 2779 "atomicrmw operand must be power-of-two byte-sized integer", &RMWI, 2780 ElTy); 2781 Assert(ElTy == RMWI.getOperand(1)->getType(), 2782 "Argument value type does not match pointer operand type!", &RMWI, 2783 ElTy); 2784 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() && 2785 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP, 2786 "Invalid binary operation!", &RMWI); 2787 visitInstruction(RMWI); 2788 } 2789 2790 void Verifier::visitFenceInst(FenceInst &FI) { 2791 const AtomicOrdering Ordering = FI.getOrdering(); 2792 Assert(Ordering == Acquire || Ordering == Release || 2793 Ordering == AcquireRelease || Ordering == SequentiallyConsistent, 2794 "fence instructions may only have " 2795 "acquire, release, acq_rel, or seq_cst ordering.", 2796 &FI); 2797 visitInstruction(FI); 2798 } 2799 2800 void Verifier::visitExtractValueInst(ExtractValueInst &EVI) { 2801 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(), 2802 EVI.getIndices()) == EVI.getType(), 2803 "Invalid ExtractValueInst operands!", &EVI); 2804 2805 visitInstruction(EVI); 2806 } 2807 2808 void Verifier::visitInsertValueInst(InsertValueInst &IVI) { 2809 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(), 2810 IVI.getIndices()) == 2811 IVI.getOperand(1)->getType(), 2812 "Invalid InsertValueInst operands!", &IVI); 2813 2814 visitInstruction(IVI); 2815 } 2816 2817 void Verifier::visitEHPadPredecessors(Instruction &I) { 2818 assert(I.isEHPad()); 2819 2820 BasicBlock *BB = I.getParent(); 2821 Function *F = BB->getParent(); 2822 2823 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I); 2824 2825 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) { 2826 // The landingpad instruction defines its parent as a landing pad block. The 2827 // landing pad block may be branched to only by the unwind edge of an 2828 // invoke. 2829 for (BasicBlock *PredBB : predecessors(BB)) { 2830 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator()); 2831 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB, 2832 "Block containing LandingPadInst must be jumped to " 2833 "only by the unwind edge of an invoke.", 2834 LPI); 2835 } 2836 return; 2837 } 2838 2839 for (BasicBlock *PredBB : predecessors(BB)) { 2840 TerminatorInst *TI = PredBB->getTerminator(); 2841 if (auto *II = dyn_cast<InvokeInst>(TI)) 2842 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB, 2843 "EH pad must be jumped to via an unwind edge", &I, II); 2844 else if (auto *CPI = dyn_cast<CatchPadInst>(TI)) 2845 Assert(CPI->getUnwindDest() == BB && CPI->getNormalDest() != BB, 2846 "EH pad must be jumped to via an unwind edge", &I, CPI); 2847 else if (isa<CatchEndPadInst>(TI)) 2848 ; 2849 else if (isa<CleanupReturnInst>(TI)) 2850 ; 2851 else if (isa<CleanupEndPadInst>(TI)) 2852 ; 2853 else if (isa<TerminatePadInst>(TI)) 2854 ; 2855 else 2856 Assert(false, "EH pad must be jumped to via an unwind edge", &I, TI); 2857 } 2858 } 2859 2860 void Verifier::visitLandingPadInst(LandingPadInst &LPI) { 2861 // The landingpad instruction is ill-formed if it doesn't have any clauses and 2862 // isn't a cleanup. 2863 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(), 2864 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI); 2865 2866 visitEHPadPredecessors(LPI); 2867 2868 if (!LandingPadResultTy) 2869 LandingPadResultTy = LPI.getType(); 2870 else 2871 Assert(LandingPadResultTy == LPI.getType(), 2872 "The landingpad instruction should have a consistent result type " 2873 "inside a function.", 2874 &LPI); 2875 2876 Function *F = LPI.getParent()->getParent(); 2877 Assert(F->hasPersonalityFn(), 2878 "LandingPadInst needs to be in a function with a personality.", &LPI); 2879 2880 // The landingpad instruction must be the first non-PHI instruction in the 2881 // block. 2882 Assert(LPI.getParent()->getLandingPadInst() == &LPI, 2883 "LandingPadInst not the first non-PHI instruction in the block.", 2884 &LPI); 2885 2886 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) { 2887 Constant *Clause = LPI.getClause(i); 2888 if (LPI.isCatch(i)) { 2889 Assert(isa<PointerType>(Clause->getType()), 2890 "Catch operand does not have pointer type!", &LPI); 2891 } else { 2892 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI); 2893 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause), 2894 "Filter operand is not an array of constants!", &LPI); 2895 } 2896 } 2897 2898 visitInstruction(LPI); 2899 } 2900 2901 void Verifier::visitCatchPadInst(CatchPadInst &CPI) { 2902 visitEHPadPredecessors(CPI); 2903 2904 BasicBlock *BB = CPI.getParent(); 2905 Function *F = BB->getParent(); 2906 Assert(F->hasPersonalityFn(), 2907 "CatchPadInst needs to be in a function with a personality.", &CPI); 2908 2909 // The catchpad instruction must be the first non-PHI instruction in the 2910 // block. 2911 Assert(BB->getFirstNonPHI() == &CPI, 2912 "CatchPadInst not the first non-PHI instruction in the block.", 2913 &CPI); 2914 2915 if (!BB->getSinglePredecessor()) 2916 for (BasicBlock *PredBB : predecessors(BB)) { 2917 Assert(!isa<CatchPadInst>(PredBB->getTerminator()), 2918 "CatchPadInst with CatchPadInst predecessor cannot have any other " 2919 "predecessors.", 2920 &CPI); 2921 } 2922 2923 BasicBlock *UnwindDest = CPI.getUnwindDest(); 2924 Instruction *I = UnwindDest->getFirstNonPHI(); 2925 Assert( 2926 isa<CatchPadInst>(I) || isa<CatchEndPadInst>(I), 2927 "CatchPadInst must unwind to a CatchPadInst or a CatchEndPadInst.", 2928 &CPI); 2929 2930 visitTerminatorInst(CPI); 2931 } 2932 2933 void Verifier::visitCatchEndPadInst(CatchEndPadInst &CEPI) { 2934 visitEHPadPredecessors(CEPI); 2935 2936 BasicBlock *BB = CEPI.getParent(); 2937 Function *F = BB->getParent(); 2938 Assert(F->hasPersonalityFn(), 2939 "CatchEndPadInst needs to be in a function with a personality.", 2940 &CEPI); 2941 2942 // The catchendpad instruction must be the first non-PHI instruction in the 2943 // block. 2944 Assert(BB->getFirstNonPHI() == &CEPI, 2945 "CatchEndPadInst not the first non-PHI instruction in the block.", 2946 &CEPI); 2947 2948 unsigned CatchPadsSeen = 0; 2949 for (BasicBlock *PredBB : predecessors(BB)) 2950 if (isa<CatchPadInst>(PredBB->getTerminator())) 2951 ++CatchPadsSeen; 2952 2953 Assert(CatchPadsSeen <= 1, "CatchEndPadInst must have no more than one " 2954 "CatchPadInst predecessor.", 2955 &CEPI); 2956 2957 if (BasicBlock *UnwindDest = CEPI.getUnwindDest()) { 2958 Instruction *I = UnwindDest->getFirstNonPHI(); 2959 Assert( 2960 I->isEHPad() && !isa<LandingPadInst>(I), 2961 "CatchEndPad must unwind to an EH block which is not a landingpad.", 2962 &CEPI); 2963 } 2964 2965 visitTerminatorInst(CEPI); 2966 } 2967 2968 void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) { 2969 visitEHPadPredecessors(CPI); 2970 2971 BasicBlock *BB = CPI.getParent(); 2972 2973 Function *F = BB->getParent(); 2974 Assert(F->hasPersonalityFn(), 2975 "CleanupPadInst needs to be in a function with a personality.", &CPI); 2976 2977 // The cleanuppad instruction must be the first non-PHI instruction in the 2978 // block. 2979 Assert(BB->getFirstNonPHI() == &CPI, 2980 "CleanupPadInst not the first non-PHI instruction in the block.", 2981 &CPI); 2982 2983 User *FirstUser = nullptr; 2984 BasicBlock *FirstUnwindDest = nullptr; 2985 for (User *U : CPI.users()) { 2986 BasicBlock *UnwindDest; 2987 if (CleanupReturnInst *CRI = dyn_cast<CleanupReturnInst>(U)) { 2988 UnwindDest = CRI->getUnwindDest(); 2989 } else { 2990 UnwindDest = cast<CleanupEndPadInst>(U)->getUnwindDest(); 2991 } 2992 2993 if (!FirstUser) { 2994 FirstUser = U; 2995 FirstUnwindDest = UnwindDest; 2996 } else { 2997 Assert(UnwindDest == FirstUnwindDest, 2998 "Cleanuprets/cleanupendpads from the same cleanuppad must " 2999 "have the same unwind destination", 3000 FirstUser, U); 3001 } 3002 } 3003 3004 visitInstruction(CPI); 3005 } 3006 3007 void Verifier::visitCleanupEndPadInst(CleanupEndPadInst &CEPI) { 3008 visitEHPadPredecessors(CEPI); 3009 3010 BasicBlock *BB = CEPI.getParent(); 3011 Function *F = BB->getParent(); 3012 Assert(F->hasPersonalityFn(), 3013 "CleanupEndPadInst needs to be in a function with a personality.", 3014 &CEPI); 3015 3016 // The cleanupendpad instruction must be the first non-PHI instruction in the 3017 // block. 3018 Assert(BB->getFirstNonPHI() == &CEPI, 3019 "CleanupEndPadInst not the first non-PHI instruction in the block.", 3020 &CEPI); 3021 3022 if (BasicBlock *UnwindDest = CEPI.getUnwindDest()) { 3023 Instruction *I = UnwindDest->getFirstNonPHI(); 3024 Assert( 3025 I->isEHPad() && !isa<LandingPadInst>(I), 3026 "CleanupEndPad must unwind to an EH block which is not a landingpad.", 3027 &CEPI); 3028 } 3029 3030 visitTerminatorInst(CEPI); 3031 } 3032 3033 void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) { 3034 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) { 3035 Instruction *I = UnwindDest->getFirstNonPHI(); 3036 Assert(I->isEHPad() && !isa<LandingPadInst>(I), 3037 "CleanupReturnInst must unwind to an EH block which is not a " 3038 "landingpad.", 3039 &CRI); 3040 } 3041 3042 visitTerminatorInst(CRI); 3043 } 3044 3045 void Verifier::visitTerminatePadInst(TerminatePadInst &TPI) { 3046 visitEHPadPredecessors(TPI); 3047 3048 BasicBlock *BB = TPI.getParent(); 3049 Function *F = BB->getParent(); 3050 Assert(F->hasPersonalityFn(), 3051 "TerminatePadInst needs to be in a function with a personality.", 3052 &TPI); 3053 3054 // The terminatepad instruction must be the first non-PHI instruction in the 3055 // block. 3056 Assert(BB->getFirstNonPHI() == &TPI, 3057 "TerminatePadInst not the first non-PHI instruction in the block.", 3058 &TPI); 3059 3060 if (BasicBlock *UnwindDest = TPI.getUnwindDest()) { 3061 Instruction *I = UnwindDest->getFirstNonPHI(); 3062 Assert(I->isEHPad() && !isa<LandingPadInst>(I), 3063 "TerminatePadInst must unwind to an EH block which is not a " 3064 "landingpad.", 3065 &TPI); 3066 } 3067 3068 visitTerminatorInst(TPI); 3069 } 3070 3071 void Verifier::verifyDominatesUse(Instruction &I, unsigned i) { 3072 Instruction *Op = cast<Instruction>(I.getOperand(i)); 3073 // If the we have an invalid invoke, don't try to compute the dominance. 3074 // We already reject it in the invoke specific checks and the dominance 3075 // computation doesn't handle multiple edges. 3076 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) { 3077 if (II->getNormalDest() == II->getUnwindDest()) 3078 return; 3079 } 3080 3081 const Use &U = I.getOperandUse(i); 3082 Assert(InstsInThisBlock.count(Op) || DT.dominates(Op, U), 3083 "Instruction does not dominate all uses!", Op, &I); 3084 } 3085 3086 void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) { 3087 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null " 3088 "apply only to pointer types", &I); 3089 Assert(isa<LoadInst>(I), 3090 "dereferenceable, dereferenceable_or_null apply only to load" 3091 " instructions, use attributes for calls or invokes", &I); 3092 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null " 3093 "take one operand!", &I); 3094 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0)); 3095 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, " 3096 "dereferenceable_or_null metadata value must be an i64!", &I); 3097 } 3098 3099 /// verifyInstruction - Verify that an instruction is well formed. 3100 /// 3101 void Verifier::visitInstruction(Instruction &I) { 3102 BasicBlock *BB = I.getParent(); 3103 Assert(BB, "Instruction not embedded in basic block!", &I); 3104 3105 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential 3106 for (User *U : I.users()) { 3107 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB), 3108 "Only PHI nodes may reference their own value!", &I); 3109 } 3110 } 3111 3112 // Check that void typed values don't have names 3113 Assert(!I.getType()->isVoidTy() || !I.hasName(), 3114 "Instruction has a name, but provides a void value!", &I); 3115 3116 // Check that the return value of the instruction is either void or a legal 3117 // value type. 3118 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(), 3119 "Instruction returns a non-scalar type!", &I); 3120 3121 // Check that the instruction doesn't produce metadata. Calls are already 3122 // checked against the callee type. 3123 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I), 3124 "Invalid use of metadata!", &I); 3125 3126 // Check that all uses of the instruction, if they are instructions 3127 // themselves, actually have parent basic blocks. If the use is not an 3128 // instruction, it is an error! 3129 for (Use &U : I.uses()) { 3130 if (Instruction *Used = dyn_cast<Instruction>(U.getUser())) 3131 Assert(Used->getParent() != nullptr, 3132 "Instruction referencing" 3133 " instruction not embedded in a basic block!", 3134 &I, Used); 3135 else { 3136 CheckFailed("Use of instruction is not an instruction!", U); 3137 return; 3138 } 3139 } 3140 3141 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) { 3142 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I); 3143 3144 // Check to make sure that only first-class-values are operands to 3145 // instructions. 3146 if (!I.getOperand(i)->getType()->isFirstClassType()) { 3147 Assert(0, "Instruction operands must be first-class values!", &I); 3148 } 3149 3150 if (Function *F = dyn_cast<Function>(I.getOperand(i))) { 3151 // Check to make sure that the "address of" an intrinsic function is never 3152 // taken. 3153 Assert( 3154 !F->isIntrinsic() || 3155 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0), 3156 "Cannot take the address of an intrinsic!", &I); 3157 Assert( 3158 !F->isIntrinsic() || isa<CallInst>(I) || 3159 F->getIntrinsicID() == Intrinsic::donothing || 3160 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void || 3161 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 || 3162 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint, 3163 "Cannot invoke an intrinsinc other than" 3164 " donothing or patchpoint", 3165 &I); 3166 Assert(F->getParent() == M, "Referencing function in another module!", 3167 &I); 3168 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) { 3169 Assert(OpBB->getParent() == BB->getParent(), 3170 "Referring to a basic block in another function!", &I); 3171 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) { 3172 Assert(OpArg->getParent() == BB->getParent(), 3173 "Referring to an argument in another function!", &I); 3174 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) { 3175 Assert(GV->getParent() == M, "Referencing global in another module!", &I); 3176 } else if (isa<Instruction>(I.getOperand(i))) { 3177 verifyDominatesUse(I, i); 3178 } else if (isa<InlineAsm>(I.getOperand(i))) { 3179 Assert((i + 1 == e && isa<CallInst>(I)) || 3180 (i + 3 == e && isa<InvokeInst>(I)), 3181 "Cannot take the address of an inline asm!", &I); 3182 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) { 3183 if (CE->getType()->isPtrOrPtrVectorTy()) { 3184 // If we have a ConstantExpr pointer, we need to see if it came from an 3185 // illegal bitcast (inttoptr <constant int> ) 3186 SmallVector<const ConstantExpr *, 4> Stack; 3187 SmallPtrSet<const ConstantExpr *, 4> Visited; 3188 Stack.push_back(CE); 3189 3190 while (!Stack.empty()) { 3191 const ConstantExpr *V = Stack.pop_back_val(); 3192 if (!Visited.insert(V).second) 3193 continue; 3194 3195 VerifyConstantExprBitcastType(V); 3196 3197 for (unsigned I = 0, N = V->getNumOperands(); I != N; ++I) { 3198 if (ConstantExpr *Op = dyn_cast<ConstantExpr>(V->getOperand(I))) 3199 Stack.push_back(Op); 3200 } 3201 } 3202 } 3203 } 3204 } 3205 3206 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) { 3207 Assert(I.getType()->isFPOrFPVectorTy(), 3208 "fpmath requires a floating point result!", &I); 3209 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I); 3210 if (ConstantFP *CFP0 = 3211 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) { 3212 APFloat Accuracy = CFP0->getValueAPF(); 3213 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(), 3214 "fpmath accuracy not a positive number!", &I); 3215 } else { 3216 Assert(false, "invalid fpmath accuracy!", &I); 3217 } 3218 } 3219 3220 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) { 3221 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I), 3222 "Ranges are only for loads, calls and invokes!", &I); 3223 visitRangeMetadata(I, Range, I.getType()); 3224 } 3225 3226 if (I.getMetadata(LLVMContext::MD_nonnull)) { 3227 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types", 3228 &I); 3229 Assert(isa<LoadInst>(I), 3230 "nonnull applies only to load instructions, use attributes" 3231 " for calls or invokes", 3232 &I); 3233 } 3234 3235 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable)) 3236 visitDereferenceableMetadata(I, MD); 3237 3238 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null)) 3239 visitDereferenceableMetadata(I, MD); 3240 3241 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) { 3242 Assert(I.getType()->isPointerTy(), "align applies only to pointer types", 3243 &I); 3244 Assert(isa<LoadInst>(I), "align applies only to load instructions, " 3245 "use attributes for calls or invokes", &I); 3246 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I); 3247 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0)); 3248 Assert(CI && CI->getType()->isIntegerTy(64), 3249 "align metadata value must be an i64!", &I); 3250 uint64_t Align = CI->getZExtValue(); 3251 Assert(isPowerOf2_64(Align), 3252 "align metadata value must be a power of 2!", &I); 3253 Assert(Align <= Value::MaximumAlignment, 3254 "alignment is larger that implementation defined limit", &I); 3255 } 3256 3257 if (MDNode *N = I.getDebugLoc().getAsMDNode()) { 3258 Assert(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N); 3259 visitMDNode(*N); 3260 } 3261 3262 InstsInThisBlock.insert(&I); 3263 } 3264 3265 /// VerifyIntrinsicType - Verify that the specified type (which comes from an 3266 /// intrinsic argument or return value) matches the type constraints specified 3267 /// by the .td file (e.g. an "any integer" argument really is an integer). 3268 /// 3269 /// This return true on error but does not print a message. 3270 bool Verifier::VerifyIntrinsicType(Type *Ty, 3271 ArrayRef<Intrinsic::IITDescriptor> &Infos, 3272 SmallVectorImpl<Type*> &ArgTys) { 3273 using namespace Intrinsic; 3274 3275 // If we ran out of descriptors, there are too many arguments. 3276 if (Infos.empty()) return true; 3277 IITDescriptor D = Infos.front(); 3278 Infos = Infos.slice(1); 3279 3280 switch (D.Kind) { 3281 case IITDescriptor::Void: return !Ty->isVoidTy(); 3282 case IITDescriptor::VarArg: return true; 3283 case IITDescriptor::MMX: return !Ty->isX86_MMXTy(); 3284 case IITDescriptor::Token: return !Ty->isTokenTy(); 3285 case IITDescriptor::Metadata: return !Ty->isMetadataTy(); 3286 case IITDescriptor::Half: return !Ty->isHalfTy(); 3287 case IITDescriptor::Float: return !Ty->isFloatTy(); 3288 case IITDescriptor::Double: return !Ty->isDoubleTy(); 3289 case IITDescriptor::Integer: return !Ty->isIntegerTy(D.Integer_Width); 3290 case IITDescriptor::Vector: { 3291 VectorType *VT = dyn_cast<VectorType>(Ty); 3292 return !VT || VT->getNumElements() != D.Vector_Width || 3293 VerifyIntrinsicType(VT->getElementType(), Infos, ArgTys); 3294 } 3295 case IITDescriptor::Pointer: { 3296 PointerType *PT = dyn_cast<PointerType>(Ty); 3297 return !PT || PT->getAddressSpace() != D.Pointer_AddressSpace || 3298 VerifyIntrinsicType(PT->getElementType(), Infos, ArgTys); 3299 } 3300 3301 case IITDescriptor::Struct: { 3302 StructType *ST = dyn_cast<StructType>(Ty); 3303 if (!ST || ST->getNumElements() != D.Struct_NumElements) 3304 return true; 3305 3306 for (unsigned i = 0, e = D.Struct_NumElements; i != e; ++i) 3307 if (VerifyIntrinsicType(ST->getElementType(i), Infos, ArgTys)) 3308 return true; 3309 return false; 3310 } 3311 3312 case IITDescriptor::Argument: 3313 // Two cases here - If this is the second occurrence of an argument, verify 3314 // that the later instance matches the previous instance. 3315 if (D.getArgumentNumber() < ArgTys.size()) 3316 return Ty != ArgTys[D.getArgumentNumber()]; 3317 3318 // Otherwise, if this is the first instance of an argument, record it and 3319 // verify the "Any" kind. 3320 assert(D.getArgumentNumber() == ArgTys.size() && "Table consistency error"); 3321 ArgTys.push_back(Ty); 3322 3323 switch (D.getArgumentKind()) { 3324 case IITDescriptor::AK_Any: return false; // Success 3325 case IITDescriptor::AK_AnyInteger: return !Ty->isIntOrIntVectorTy(); 3326 case IITDescriptor::AK_AnyFloat: return !Ty->isFPOrFPVectorTy(); 3327 case IITDescriptor::AK_AnyVector: return !isa<VectorType>(Ty); 3328 case IITDescriptor::AK_AnyPointer: return !isa<PointerType>(Ty); 3329 } 3330 llvm_unreachable("all argument kinds not covered"); 3331 3332 case IITDescriptor::ExtendArgument: { 3333 // This may only be used when referring to a previous vector argument. 3334 if (D.getArgumentNumber() >= ArgTys.size()) 3335 return true; 3336 3337 Type *NewTy = ArgTys[D.getArgumentNumber()]; 3338 if (VectorType *VTy = dyn_cast<VectorType>(NewTy)) 3339 NewTy = VectorType::getExtendedElementVectorType(VTy); 3340 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy)) 3341 NewTy = IntegerType::get(ITy->getContext(), 2 * ITy->getBitWidth()); 3342 else 3343 return true; 3344 3345 return Ty != NewTy; 3346 } 3347 case IITDescriptor::TruncArgument: { 3348 // This may only be used when referring to a previous vector argument. 3349 if (D.getArgumentNumber() >= ArgTys.size()) 3350 return true; 3351 3352 Type *NewTy = ArgTys[D.getArgumentNumber()]; 3353 if (VectorType *VTy = dyn_cast<VectorType>(NewTy)) 3354 NewTy = VectorType::getTruncatedElementVectorType(VTy); 3355 else if (IntegerType *ITy = dyn_cast<IntegerType>(NewTy)) 3356 NewTy = IntegerType::get(ITy->getContext(), ITy->getBitWidth() / 2); 3357 else 3358 return true; 3359 3360 return Ty != NewTy; 3361 } 3362 case IITDescriptor::HalfVecArgument: 3363 // This may only be used when referring to a previous vector argument. 3364 return D.getArgumentNumber() >= ArgTys.size() || 3365 !isa<VectorType>(ArgTys[D.getArgumentNumber()]) || 3366 VectorType::getHalfElementsVectorType( 3367 cast<VectorType>(ArgTys[D.getArgumentNumber()])) != Ty; 3368 case IITDescriptor::SameVecWidthArgument: { 3369 if (D.getArgumentNumber() >= ArgTys.size()) 3370 return true; 3371 VectorType * ReferenceType = 3372 dyn_cast<VectorType>(ArgTys[D.getArgumentNumber()]); 3373 VectorType *ThisArgType = dyn_cast<VectorType>(Ty); 3374 if (!ThisArgType || !ReferenceType || 3375 (ReferenceType->getVectorNumElements() != 3376 ThisArgType->getVectorNumElements())) 3377 return true; 3378 return VerifyIntrinsicType(ThisArgType->getVectorElementType(), 3379 Infos, ArgTys); 3380 } 3381 case IITDescriptor::PtrToArgument: { 3382 if (D.getArgumentNumber() >= ArgTys.size()) 3383 return true; 3384 Type * ReferenceType = ArgTys[D.getArgumentNumber()]; 3385 PointerType *ThisArgType = dyn_cast<PointerType>(Ty); 3386 return (!ThisArgType || ThisArgType->getElementType() != ReferenceType); 3387 } 3388 case IITDescriptor::VecOfPtrsToElt: { 3389 if (D.getArgumentNumber() >= ArgTys.size()) 3390 return true; 3391 VectorType * ReferenceType = 3392 dyn_cast<VectorType> (ArgTys[D.getArgumentNumber()]); 3393 VectorType *ThisArgVecTy = dyn_cast<VectorType>(Ty); 3394 if (!ThisArgVecTy || !ReferenceType || 3395 (ReferenceType->getVectorNumElements() != 3396 ThisArgVecTy->getVectorNumElements())) 3397 return true; 3398 PointerType *ThisArgEltTy = 3399 dyn_cast<PointerType>(ThisArgVecTy->getVectorElementType()); 3400 if (!ThisArgEltTy) 3401 return true; 3402 return ThisArgEltTy->getElementType() != 3403 ReferenceType->getVectorElementType(); 3404 } 3405 } 3406 llvm_unreachable("unhandled"); 3407 } 3408 3409 /// \brief Verify if the intrinsic has variable arguments. 3410 /// This method is intended to be called after all the fixed arguments have been 3411 /// verified first. 3412 /// 3413 /// This method returns true on error and does not print an error message. 3414 bool 3415 Verifier::VerifyIntrinsicIsVarArg(bool isVarArg, 3416 ArrayRef<Intrinsic::IITDescriptor> &Infos) { 3417 using namespace Intrinsic; 3418 3419 // If there are no descriptors left, then it can't be a vararg. 3420 if (Infos.empty()) 3421 return isVarArg; 3422 3423 // There should be only one descriptor remaining at this point. 3424 if (Infos.size() != 1) 3425 return true; 3426 3427 // Check and verify the descriptor. 3428 IITDescriptor D = Infos.front(); 3429 Infos = Infos.slice(1); 3430 if (D.Kind == IITDescriptor::VarArg) 3431 return !isVarArg; 3432 3433 return true; 3434 } 3435 3436 /// Allow intrinsics to be verified in different ways. 3437 void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) { 3438 Function *IF = CS.getCalledFunction(); 3439 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!", 3440 IF); 3441 3442 // Verify that the intrinsic prototype lines up with what the .td files 3443 // describe. 3444 FunctionType *IFTy = IF->getFunctionType(); 3445 bool IsVarArg = IFTy->isVarArg(); 3446 3447 SmallVector<Intrinsic::IITDescriptor, 8> Table; 3448 getIntrinsicInfoTableEntries(ID, Table); 3449 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table; 3450 3451 SmallVector<Type *, 4> ArgTys; 3452 Assert(!VerifyIntrinsicType(IFTy->getReturnType(), TableRef, ArgTys), 3453 "Intrinsic has incorrect return type!", IF); 3454 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i) 3455 Assert(!VerifyIntrinsicType(IFTy->getParamType(i), TableRef, ArgTys), 3456 "Intrinsic has incorrect argument type!", IF); 3457 3458 // Verify if the intrinsic call matches the vararg property. 3459 if (IsVarArg) 3460 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef), 3461 "Intrinsic was not defined with variable arguments!", IF); 3462 else 3463 Assert(!VerifyIntrinsicIsVarArg(IsVarArg, TableRef), 3464 "Callsite was not defined with variable arguments!", IF); 3465 3466 // All descriptors should be absorbed by now. 3467 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF); 3468 3469 // Now that we have the intrinsic ID and the actual argument types (and we 3470 // know they are legal for the intrinsic!) get the intrinsic name through the 3471 // usual means. This allows us to verify the mangling of argument types into 3472 // the name. 3473 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys); 3474 Assert(ExpectedName == IF->getName(), 3475 "Intrinsic name not mangled correctly for type arguments! " 3476 "Should be: " + 3477 ExpectedName, 3478 IF); 3479 3480 // If the intrinsic takes MDNode arguments, verify that they are either global 3481 // or are local to *this* function. 3482 for (Value *V : CS.args()) 3483 if (auto *MD = dyn_cast<MetadataAsValue>(V)) 3484 visitMetadataAsValue(*MD, CS.getCaller()); 3485 3486 switch (ID) { 3487 default: 3488 break; 3489 case Intrinsic::ctlz: // llvm.ctlz 3490 case Intrinsic::cttz: // llvm.cttz 3491 Assert(isa<ConstantInt>(CS.getArgOperand(1)), 3492 "is_zero_undef argument of bit counting intrinsics must be a " 3493 "constant int", 3494 CS); 3495 break; 3496 case Intrinsic::dbg_declare: // llvm.dbg.declare 3497 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)), 3498 "invalid llvm.dbg.declare intrinsic call 1", CS); 3499 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction())); 3500 break; 3501 case Intrinsic::dbg_value: // llvm.dbg.value 3502 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction())); 3503 break; 3504 case Intrinsic::memcpy: 3505 case Intrinsic::memmove: 3506 case Intrinsic::memset: { 3507 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3)); 3508 Assert(AlignCI, 3509 "alignment argument of memory intrinsics must be a constant int", 3510 CS); 3511 const APInt &AlignVal = AlignCI->getValue(); 3512 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(), 3513 "alignment argument of memory intrinsics must be a power of 2", CS); 3514 Assert(isa<ConstantInt>(CS.getArgOperand(4)), 3515 "isvolatile argument of memory intrinsics must be a constant int", 3516 CS); 3517 break; 3518 } 3519 case Intrinsic::gcroot: 3520 case Intrinsic::gcwrite: 3521 case Intrinsic::gcread: 3522 if (ID == Intrinsic::gcroot) { 3523 AllocaInst *AI = 3524 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts()); 3525 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS); 3526 Assert(isa<Constant>(CS.getArgOperand(1)), 3527 "llvm.gcroot parameter #2 must be a constant.", CS); 3528 if (!AI->getAllocatedType()->isPointerTy()) { 3529 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)), 3530 "llvm.gcroot parameter #1 must either be a pointer alloca, " 3531 "or argument #2 must be a non-null constant.", 3532 CS); 3533 } 3534 } 3535 3536 Assert(CS.getParent()->getParent()->hasGC(), 3537 "Enclosing function does not use GC.", CS); 3538 break; 3539 case Intrinsic::init_trampoline: 3540 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()), 3541 "llvm.init_trampoline parameter #2 must resolve to a function.", 3542 CS); 3543 break; 3544 case Intrinsic::prefetch: 3545 Assert(isa<ConstantInt>(CS.getArgOperand(1)) && 3546 isa<ConstantInt>(CS.getArgOperand(2)) && 3547 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 && 3548 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4, 3549 "invalid arguments to llvm.prefetch", CS); 3550 break; 3551 case Intrinsic::stackprotector: 3552 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()), 3553 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS); 3554 break; 3555 case Intrinsic::lifetime_start: 3556 case Intrinsic::lifetime_end: 3557 case Intrinsic::invariant_start: 3558 Assert(isa<ConstantInt>(CS.getArgOperand(0)), 3559 "size argument of memory use markers must be a constant integer", 3560 CS); 3561 break; 3562 case Intrinsic::invariant_end: 3563 Assert(isa<ConstantInt>(CS.getArgOperand(1)), 3564 "llvm.invariant.end parameter #2 must be a constant integer", CS); 3565 break; 3566 3567 case Intrinsic::localescape: { 3568 BasicBlock *BB = CS.getParent(); 3569 Assert(BB == &BB->getParent()->front(), 3570 "llvm.localescape used outside of entry block", CS); 3571 Assert(!SawFrameEscape, 3572 "multiple calls to llvm.localescape in one function", CS); 3573 for (Value *Arg : CS.args()) { 3574 if (isa<ConstantPointerNull>(Arg)) 3575 continue; // Null values are allowed as placeholders. 3576 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts()); 3577 Assert(AI && AI->isStaticAlloca(), 3578 "llvm.localescape only accepts static allocas", CS); 3579 } 3580 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands(); 3581 SawFrameEscape = true; 3582 break; 3583 } 3584 case Intrinsic::localrecover: { 3585 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts(); 3586 Function *Fn = dyn_cast<Function>(FnArg); 3587 Assert(Fn && !Fn->isDeclaration(), 3588 "llvm.localrecover first " 3589 "argument must be function defined in this module", 3590 CS); 3591 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2)); 3592 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int", 3593 CS); 3594 auto &Entry = FrameEscapeInfo[Fn]; 3595 Entry.second = unsigned( 3596 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1)); 3597 break; 3598 } 3599 3600 case Intrinsic::experimental_gc_statepoint: 3601 Assert(!CS.isInlineAsm(), 3602 "gc.statepoint support for inline assembly unimplemented", CS); 3603 Assert(CS.getParent()->getParent()->hasGC(), 3604 "Enclosing function does not use GC.", CS); 3605 3606 VerifyStatepoint(CS); 3607 break; 3608 case Intrinsic::experimental_gc_result_int: 3609 case Intrinsic::experimental_gc_result_float: 3610 case Intrinsic::experimental_gc_result_ptr: 3611 case Intrinsic::experimental_gc_result: { 3612 Assert(CS.getParent()->getParent()->hasGC(), 3613 "Enclosing function does not use GC.", CS); 3614 // Are we tied to a statepoint properly? 3615 CallSite StatepointCS(CS.getArgOperand(0)); 3616 const Function *StatepointFn = 3617 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr; 3618 Assert(StatepointFn && StatepointFn->isDeclaration() && 3619 StatepointFn->getIntrinsicID() == 3620 Intrinsic::experimental_gc_statepoint, 3621 "gc.result operand #1 must be from a statepoint", CS, 3622 CS.getArgOperand(0)); 3623 3624 // Assert that result type matches wrapped callee. 3625 const Value *Target = StatepointCS.getArgument(2); 3626 auto *PT = cast<PointerType>(Target->getType()); 3627 auto *TargetFuncType = cast<FunctionType>(PT->getElementType()); 3628 Assert(CS.getType() == TargetFuncType->getReturnType(), 3629 "gc.result result type does not match wrapped callee", CS); 3630 break; 3631 } 3632 case Intrinsic::experimental_gc_relocate: { 3633 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS); 3634 3635 // Check that this relocate is correctly tied to the statepoint 3636 3637 // This is case for relocate on the unwinding path of an invoke statepoint 3638 if (ExtractValueInst *ExtractValue = 3639 dyn_cast<ExtractValueInst>(CS.getArgOperand(0))) { 3640 Assert(isa<LandingPadInst>(ExtractValue->getAggregateOperand()), 3641 "gc relocate on unwind path incorrectly linked to the statepoint", 3642 CS); 3643 3644 const BasicBlock *InvokeBB = 3645 ExtractValue->getParent()->getUniquePredecessor(); 3646 3647 // Landingpad relocates should have only one predecessor with invoke 3648 // statepoint terminator 3649 Assert(InvokeBB, "safepoints should have unique landingpads", 3650 ExtractValue->getParent()); 3651 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed", 3652 InvokeBB); 3653 Assert(isStatepoint(InvokeBB->getTerminator()), 3654 "gc relocate should be linked to a statepoint", InvokeBB); 3655 } 3656 else { 3657 // In all other cases relocate should be tied to the statepoint directly. 3658 // This covers relocates on a normal return path of invoke statepoint and 3659 // relocates of a call statepoint 3660 auto Token = CS.getArgOperand(0); 3661 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)), 3662 "gc relocate is incorrectly tied to the statepoint", CS, Token); 3663 } 3664 3665 // Verify rest of the relocate arguments 3666 3667 GCRelocateOperands Ops(CS); 3668 ImmutableCallSite StatepointCS(Ops.getStatepoint()); 3669 3670 // Both the base and derived must be piped through the safepoint 3671 Value* Base = CS.getArgOperand(1); 3672 Assert(isa<ConstantInt>(Base), 3673 "gc.relocate operand #2 must be integer offset", CS); 3674 3675 Value* Derived = CS.getArgOperand(2); 3676 Assert(isa<ConstantInt>(Derived), 3677 "gc.relocate operand #3 must be integer offset", CS); 3678 3679 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue(); 3680 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue(); 3681 // Check the bounds 3682 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(), 3683 "gc.relocate: statepoint base index out of bounds", CS); 3684 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(), 3685 "gc.relocate: statepoint derived index out of bounds", CS); 3686 3687 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters' 3688 // section of the statepoint's argument 3689 Assert(StatepointCS.arg_size() > 0, 3690 "gc.statepoint: insufficient arguments"); 3691 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)), 3692 "gc.statement: number of call arguments must be constant integer"); 3693 const unsigned NumCallArgs = 3694 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue(); 3695 Assert(StatepointCS.arg_size() > NumCallArgs + 5, 3696 "gc.statepoint: mismatch in number of call arguments"); 3697 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)), 3698 "gc.statepoint: number of transition arguments must be " 3699 "a constant integer"); 3700 const int NumTransitionArgs = 3701 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)) 3702 ->getZExtValue(); 3703 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1; 3704 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)), 3705 "gc.statepoint: number of deoptimization arguments must be " 3706 "a constant integer"); 3707 const int NumDeoptArgs = 3708 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))->getZExtValue(); 3709 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs; 3710 const int GCParamArgsEnd = StatepointCS.arg_size(); 3711 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd, 3712 "gc.relocate: statepoint base index doesn't fall within the " 3713 "'gc parameters' section of the statepoint call", 3714 CS); 3715 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd, 3716 "gc.relocate: statepoint derived index doesn't fall within the " 3717 "'gc parameters' section of the statepoint call", 3718 CS); 3719 3720 // Relocated value must be a pointer type, but gc_relocate does not need to return the 3721 // same pointer type as the relocated pointer. It can be casted to the correct type later 3722 // if it's desired. However, they must have the same address space. 3723 GCRelocateOperands Operands(CS); 3724 Assert(Operands.getDerivedPtr()->getType()->isPointerTy(), 3725 "gc.relocate: relocated value must be a gc pointer", CS); 3726 3727 // gc_relocate return type must be a pointer type, and is verified earlier in 3728 // VerifyIntrinsicType(). 3729 Assert(cast<PointerType>(CS.getType())->getAddressSpace() == 3730 cast<PointerType>(Operands.getDerivedPtr()->getType())->getAddressSpace(), 3731 "gc.relocate: relocating a pointer shouldn't change its address space", CS); 3732 break; 3733 } 3734 case Intrinsic::eh_exceptioncode: 3735 case Intrinsic::eh_exceptionpointer: { 3736 Assert(isa<CatchPadInst>(CS.getArgOperand(0)), 3737 "eh.exceptionpointer argument must be a catchpad", CS); 3738 break; 3739 } 3740 }; 3741 } 3742 3743 /// \brief Carefully grab the subprogram from a local scope. 3744 /// 3745 /// This carefully grabs the subprogram from a local scope, avoiding the 3746 /// built-in assertions that would typically fire. 3747 static DISubprogram *getSubprogram(Metadata *LocalScope) { 3748 if (!LocalScope) 3749 return nullptr; 3750 3751 if (auto *SP = dyn_cast<DISubprogram>(LocalScope)) 3752 return SP; 3753 3754 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope)) 3755 return getSubprogram(LB->getRawScope()); 3756 3757 // Just return null; broken scope chains are checked elsewhere. 3758 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope"); 3759 return nullptr; 3760 } 3761 3762 template <class DbgIntrinsicTy> 3763 void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) { 3764 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata(); 3765 Assert(isa<ValueAsMetadata>(MD) || 3766 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()), 3767 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD); 3768 Assert(isa<DILocalVariable>(DII.getRawVariable()), 3769 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII, 3770 DII.getRawVariable()); 3771 Assert(isa<DIExpression>(DII.getRawExpression()), 3772 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII, 3773 DII.getRawExpression()); 3774 3775 // Ignore broken !dbg attachments; they're checked elsewhere. 3776 if (MDNode *N = DII.getDebugLoc().getAsMDNode()) 3777 if (!isa<DILocation>(N)) 3778 return; 3779 3780 BasicBlock *BB = DII.getParent(); 3781 Function *F = BB ? BB->getParent() : nullptr; 3782 3783 // The scopes for variables and !dbg attachments must agree. 3784 DILocalVariable *Var = DII.getVariable(); 3785 DILocation *Loc = DII.getDebugLoc(); 3786 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment", 3787 &DII, BB, F); 3788 3789 DISubprogram *VarSP = getSubprogram(Var->getRawScope()); 3790 DISubprogram *LocSP = getSubprogram(Loc->getRawScope()); 3791 if (!VarSP || !LocSP) 3792 return; // Broken scope chains are checked elsewhere. 3793 3794 Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind + 3795 " variable and !dbg attachment", 3796 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc, 3797 Loc->getScope()->getSubprogram()); 3798 } 3799 3800 template <class MapTy> 3801 static uint64_t getVariableSize(const DILocalVariable &V, const MapTy &Map) { 3802 // Be careful of broken types (checked elsewhere). 3803 const Metadata *RawType = V.getRawType(); 3804 while (RawType) { 3805 // Try to get the size directly. 3806 if (auto *T = dyn_cast<DIType>(RawType)) 3807 if (uint64_t Size = T->getSizeInBits()) 3808 return Size; 3809 3810 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) { 3811 // Look at the base type. 3812 RawType = DT->getRawBaseType(); 3813 continue; 3814 } 3815 3816 if (auto *S = dyn_cast<MDString>(RawType)) { 3817 // Don't error on missing types (checked elsewhere). 3818 RawType = Map.lookup(S); 3819 continue; 3820 } 3821 3822 // Missing type or size. 3823 break; 3824 } 3825 3826 // Fail gracefully. 3827 return 0; 3828 } 3829 3830 template <class MapTy> 3831 void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I, 3832 const MapTy &TypeRefs) { 3833 DILocalVariable *V; 3834 DIExpression *E; 3835 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) { 3836 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable()); 3837 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression()); 3838 } else { 3839 auto *DDI = cast<DbgDeclareInst>(&I); 3840 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable()); 3841 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression()); 3842 } 3843 3844 // We don't know whether this intrinsic verified correctly. 3845 if (!V || !E || !E->isValid()) 3846 return; 3847 3848 // Nothing to do if this isn't a bit piece expression. 3849 if (!E->isBitPiece()) 3850 return; 3851 3852 // The frontend helps out GDB by emitting the members of local anonymous 3853 // unions as artificial local variables with shared storage. When SROA splits 3854 // the storage for artificial local variables that are smaller than the entire 3855 // union, the overhang piece will be outside of the allotted space for the 3856 // variable and this check fails. 3857 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs. 3858 if (V->isArtificial()) 3859 return; 3860 3861 // If there's no size, the type is broken, but that should be checked 3862 // elsewhere. 3863 uint64_t VarSize = getVariableSize(*V, TypeRefs); 3864 if (!VarSize) 3865 return; 3866 3867 unsigned PieceSize = E->getBitPieceSize(); 3868 unsigned PieceOffset = E->getBitPieceOffset(); 3869 Assert(PieceSize + PieceOffset <= VarSize, 3870 "piece is larger than or outside of variable", &I, V, E); 3871 Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E); 3872 } 3873 3874 void Verifier::visitUnresolvedTypeRef(const MDString *S, const MDNode *N) { 3875 // This is in its own function so we get an error for each bad type ref (not 3876 // just the first). 3877 Assert(false, "unresolved type ref", S, N); 3878 } 3879 3880 void Verifier::verifyTypeRefs() { 3881 auto *CUs = M->getNamedMetadata("llvm.dbg.cu"); 3882 if (!CUs) 3883 return; 3884 3885 // Visit all the compile units again to map the type references. 3886 SmallDenseMap<const MDString *, const DIType *, 32> TypeRefs; 3887 for (auto *CU : CUs->operands()) 3888 if (auto Ts = cast<DICompileUnit>(CU)->getRetainedTypes()) 3889 for (DIType *Op : Ts) 3890 if (auto *T = dyn_cast_or_null<DICompositeType>(Op)) 3891 if (auto *S = T->getRawIdentifier()) { 3892 UnresolvedTypeRefs.erase(S); 3893 TypeRefs.insert(std::make_pair(S, T)); 3894 } 3895 3896 // Verify debug info intrinsic bit piece expressions. This needs a second 3897 // pass through the intructions, since we haven't built TypeRefs yet when 3898 // verifying functions, and simply queuing the DbgInfoIntrinsics to evaluate 3899 // later/now would queue up some that could be later deleted. 3900 for (const Function &F : *M) 3901 for (const BasicBlock &BB : F) 3902 for (const Instruction &I : BB) 3903 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I)) 3904 verifyBitPieceExpression(*DII, TypeRefs); 3905 3906 // Return early if all typerefs were resolved. 3907 if (UnresolvedTypeRefs.empty()) 3908 return; 3909 3910 // Sort the unresolved references by name so the output is deterministic. 3911 typedef std::pair<const MDString *, const MDNode *> TypeRef; 3912 SmallVector<TypeRef, 32> Unresolved(UnresolvedTypeRefs.begin(), 3913 UnresolvedTypeRefs.end()); 3914 std::sort(Unresolved.begin(), Unresolved.end(), 3915 [](const TypeRef &LHS, const TypeRef &RHS) { 3916 return LHS.first->getString() < RHS.first->getString(); 3917 }); 3918 3919 // Visit the unresolved refs (printing out the errors). 3920 for (const TypeRef &TR : Unresolved) 3921 visitUnresolvedTypeRef(TR.first, TR.second); 3922 } 3923 3924 //===----------------------------------------------------------------------===// 3925 // Implement the public interfaces to this file... 3926 //===----------------------------------------------------------------------===// 3927 3928 bool llvm::verifyFunction(const Function &f, raw_ostream *OS) { 3929 Function &F = const_cast<Function &>(f); 3930 assert(!F.isDeclaration() && "Cannot verify external functions"); 3931 3932 raw_null_ostream NullStr; 3933 Verifier V(OS ? *OS : NullStr); 3934 3935 // Note that this function's return value is inverted from what you would 3936 // expect of a function called "verify". 3937 return !V.verify(F); 3938 } 3939 3940 bool llvm::verifyModule(const Module &M, raw_ostream *OS) { 3941 raw_null_ostream NullStr; 3942 Verifier V(OS ? *OS : NullStr); 3943 3944 bool Broken = false; 3945 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) 3946 if (!I->isDeclaration() && !I->isMaterializable()) 3947 Broken |= !V.verify(*I); 3948 3949 // Note that this function's return value is inverted from what you would 3950 // expect of a function called "verify". 3951 return !V.verify(M) || Broken; 3952 } 3953 3954 namespace { 3955 struct VerifierLegacyPass : public FunctionPass { 3956 static char ID; 3957 3958 Verifier V; 3959 bool FatalErrors; 3960 3961 VerifierLegacyPass() : FunctionPass(ID), V(dbgs()), FatalErrors(true) { 3962 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry()); 3963 } 3964 explicit VerifierLegacyPass(bool FatalErrors) 3965 : FunctionPass(ID), V(dbgs()), FatalErrors(FatalErrors) { 3966 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry()); 3967 } 3968 3969 bool runOnFunction(Function &F) override { 3970 if (!V.verify(F) && FatalErrors) 3971 report_fatal_error("Broken function found, compilation aborted!"); 3972 3973 return false; 3974 } 3975 3976 bool doFinalization(Module &M) override { 3977 if (!V.verify(M) && FatalErrors) 3978 report_fatal_error("Broken module found, compilation aborted!"); 3979 3980 return false; 3981 } 3982 3983 void getAnalysisUsage(AnalysisUsage &AU) const override { 3984 AU.setPreservesAll(); 3985 } 3986 }; 3987 } 3988 3989 char VerifierLegacyPass::ID = 0; 3990 INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false) 3991 3992 FunctionPass *llvm::createVerifierPass(bool FatalErrors) { 3993 return new VerifierLegacyPass(FatalErrors); 3994 } 3995 3996 PreservedAnalyses VerifierPass::run(Module &M) { 3997 if (verifyModule(M, &dbgs()) && FatalErrors) 3998 report_fatal_error("Broken module found, compilation aborted!"); 3999 4000 return PreservedAnalyses::all(); 4001 } 4002 4003 PreservedAnalyses VerifierPass::run(Function &F) { 4004 if (verifyFunction(F, &dbgs()) && FatalErrors) 4005 report_fatal_error("Broken function found, compilation aborted!"); 4006 4007 return PreservedAnalyses::all(); 4008 } 4009