contrib/llvm/lib/IR/Verifier.cpp

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