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