lib/Bitcode/Reader/BitcodeReader.cpp

   1 //===- BitcodeReader.cpp - Internal BitcodeReader implementation ----------===//
   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 #include "llvm/Bitcode/ReaderWriter.h"
  11 #include "BitcodeReader.h"
  12 #include "llvm/ADT/SmallString.h"
  13 #include "llvm/ADT/SmallVector.h"
  14 #include "llvm/ADT/Triple.h"
  15 #include "llvm/Bitcode/LLVMBitCodes.h"
  16 #include "llvm/IR/AutoUpgrade.h"
  17 #include "llvm/IR/Constants.h"
  18 #include "llvm/IR/DebugInfoMetadata.h"
  19 #include "llvm/IR/DerivedTypes.h"
  20 #include "llvm/IR/DiagnosticPrinter.h"
  21 #include "llvm/IR/InlineAsm.h"
  22 #include "llvm/IR/IntrinsicInst.h"
  23 #include "llvm/IR/LLVMContext.h"
  24 #include "llvm/IR/Module.h"
  25 #include "llvm/IR/OperandTraits.h"
  26 #include "llvm/IR/Operator.h"
  27 #include "llvm/Support/DataStream.h"
  28 #include "llvm/Support/ManagedStatic.h"
  29 #include "llvm/Support/MathExtras.h"
  30 #include "llvm/Support/MemoryBuffer.h"
  31 #include "llvm/Support/raw_ostream.h"
  32
  33 using namespace llvm;
  34
  35 enum {
  36   SWITCH_INST_MAGIC = 0x4B5 // May 2012 => 1205 => Hex
  37 };
  38
  39 BitcodeDiagnosticInfo::BitcodeDiagnosticInfo(std::error_code EC,
  40                                              DiagnosticSeverity Severity,
  41                                              const Twine &Msg)
  42     : DiagnosticInfo(DK_Bitcode, Severity), Msg(Msg), EC(EC) {}
  43
  44 void BitcodeDiagnosticInfo::print(DiagnosticPrinter &DP) const { DP << Msg; }
  45
  46 static std::error_code Error(DiagnosticHandlerFunction DiagnosticHandler,
  47                              std::error_code EC, const Twine &Message) {
  48   BitcodeDiagnosticInfo DI(EC, DS_Error, Message);
  49   DiagnosticHandler(DI);
  50   return EC;
  51 }
  52
  53 static std::error_code Error(DiagnosticHandlerFunction DiagnosticHandler,
  54                              std::error_code EC) {
  55   return Error(DiagnosticHandler, EC, EC.message());
  56 }
  57
  58 std::error_code BitcodeReader::Error(BitcodeError E, const Twine &Message) {
  59   return ::Error(DiagnosticHandler, make_error_code(E), Message);
  60 }
  61
  62 std::error_code BitcodeReader::Error(const Twine &Message) {
  63   return ::Error(DiagnosticHandler,
  64                  make_error_code(BitcodeError::CorruptedBitcode), Message);
  65 }
  66
  67 std::error_code BitcodeReader::Error(BitcodeError E) {
  68   return ::Error(DiagnosticHandler, make_error_code(E));
  69 }
  70
  71 static DiagnosticHandlerFunction getDiagHandler(DiagnosticHandlerFunction F,
  72                                                 LLVMContext &C) {
  73   if (F)
  74     return F;
  75   return [&C](const DiagnosticInfo &DI) { C.diagnose(DI); };
  76 }
  77
  78 BitcodeReader::BitcodeReader(MemoryBuffer *buffer, LLVMContext &C,
  79                              DiagnosticHandlerFunction DiagnosticHandler)
  80     : Context(C), DiagnosticHandler(getDiagHandler(DiagnosticHandler, C)),
  81       TheModule(nullptr), Buffer(buffer), LazyStreamer(nullptr),
  82       NextUnreadBit(0), SeenValueSymbolTable(false), ValueList(C),
  83       MDValueList(C), SeenFirstFunctionBody(false), UseRelativeIDs(false),
  84       WillMaterializeAllForwardRefs(false) {}
  85
  86 BitcodeReader::BitcodeReader(DataStreamer *streamer, LLVMContext &C,
  87                              DiagnosticHandlerFunction DiagnosticHandler)
  88     : Context(C), DiagnosticHandler(getDiagHandler(DiagnosticHandler, C)),
  89       TheModule(nullptr), Buffer(nullptr), LazyStreamer(streamer),
  90       NextUnreadBit(0), SeenValueSymbolTable(false), ValueList(C),
  91       MDValueList(C), SeenFirstFunctionBody(false), UseRelativeIDs(false),
  92       WillMaterializeAllForwardRefs(false) {}
  93
  94 std::error_code BitcodeReader::materializeForwardReferencedFunctions() {
  95   if (WillMaterializeAllForwardRefs)
  96     return std::error_code();
  97
  98   // Prevent recursion.
  99   WillMaterializeAllForwardRefs = true;
 100
 101   while (!BasicBlockFwdRefQueue.empty()) {
 102     Function *F = BasicBlockFwdRefQueue.front();
 103     BasicBlockFwdRefQueue.pop_front();
 104     assert(F && "Expected valid function");
 105     if (!BasicBlockFwdRefs.count(F))
 106       // Already materialized.
 107       continue;
 108
 109     // Check for a function that isn't materializable to prevent an infinite
 110     // loop.  When parsing a blockaddress stored in a global variable, there
 111     // isn't a trivial way to check if a function will have a body without a
 112     // linear search through FunctionsWithBodies, so just check it here.
 113     if (!F->isMaterializable())
 114       return Error("Never resolved function from blockaddress");
 115
 116     // Try to materialize F.
 117     if (std::error_code EC = materialize(F))
 118       return EC;
 119   }
 120   assert(BasicBlockFwdRefs.empty() && "Function missing from queue");
 121
 122   // Reset state.
 123   WillMaterializeAllForwardRefs = false;
 124   return std::error_code();
 125 }
 126
 127 void BitcodeReader::FreeState() {
 128   Buffer = nullptr;
 129   std::vector<Type*>().swap(TypeList);
 130   ValueList.clear();
 131   MDValueList.clear();
 132   std::vector<Comdat *>().swap(ComdatList);
 133
 134   std::vector<AttributeSet>().swap(MAttributes);
 135   std::vector<BasicBlock*>().swap(FunctionBBs);
 136   std::vector<Function*>().swap(FunctionsWithBodies);
 137   DeferredFunctionInfo.clear();
 138   MDKindMap.clear();
 139
 140   assert(BasicBlockFwdRefs.empty() && "Unresolved blockaddress fwd references");
 141   BasicBlockFwdRefQueue.clear();
 142 }
 143
 144 //===----------------------------------------------------------------------===//
 145 //  Helper functions to implement forward reference resolution, etc.
 146 //===----------------------------------------------------------------------===//
 147
 148 /// ConvertToString - Convert a string from a record into an std::string, return
 149 /// true on failure.
 150 template<typename StrTy>
 151 static bool ConvertToString(ArrayRef<uint64_t> Record, unsigned Idx,
 152                             StrTy &Result) {
 153   if (Idx > Record.size())
 154     return true;
 155
 156   for (unsigned i = Idx, e = Record.size(); i != e; ++i)
 157     Result += (char)Record[i];
 158   return false;
 159 }
 160
 161 static bool hasImplicitComdat(size_t Val) {
 162   switch (Val) {
 163   default:
 164     return false;
 165   case 1:  // Old WeakAnyLinkage
 166   case 4:  // Old LinkOnceAnyLinkage
 167   case 10: // Old WeakODRLinkage
 168   case 11: // Old LinkOnceODRLinkage
 169     return true;
 170   }
 171 }
 172
 173 static GlobalValue::LinkageTypes getDecodedLinkage(unsigned Val) {
 174   switch (Val) {
 175   default: // Map unknown/new linkages to external
 176   case 0:
 177     return GlobalValue::ExternalLinkage;
 178   case 2:
 179     return GlobalValue::AppendingLinkage;
 180   case 3:
 181     return GlobalValue::InternalLinkage;
 182   case 5:
 183     return GlobalValue::ExternalLinkage; // Obsolete DLLImportLinkage
 184   case 6:
 185     return GlobalValue::ExternalLinkage; // Obsolete DLLExportLinkage
 186   case 7:
 187     return GlobalValue::ExternalWeakLinkage;
 188   case 8:
 189     return GlobalValue::CommonLinkage;
 190   case 9:
 191     return GlobalValue::PrivateLinkage;
 192   case 12:
 193     return GlobalValue::AvailableExternallyLinkage;
 194   case 13:
 195     return GlobalValue::PrivateLinkage; // Obsolete LinkerPrivateLinkage
 196   case 14:
 197     return GlobalValue::PrivateLinkage; // Obsolete LinkerPrivateWeakLinkage
 198   case 15:
 199     return GlobalValue::ExternalLinkage; // Obsolete LinkOnceODRAutoHideLinkage
 200   case 1: // Old value with implicit comdat.
 201   case 16:
 202     return GlobalValue::WeakAnyLinkage;
 203   case 10: // Old value with implicit comdat.
 204   case 17:
 205     return GlobalValue::WeakODRLinkage;
 206   case 4: // Old value with implicit comdat.
 207   case 18:
 208     return GlobalValue::LinkOnceAnyLinkage;
 209   case 11: // Old value with implicit comdat.
 210   case 19:
 211     return GlobalValue::LinkOnceODRLinkage;
 212   }
 213 }
 214
 215 static GlobalValue::VisibilityTypes GetDecodedVisibility(unsigned Val) {
 216   switch (Val) {
 217   default: // Map unknown visibilities to default.
 218   case 0: return GlobalValue::DefaultVisibility;
 219   case 1: return GlobalValue::HiddenVisibility;
 220   case 2: return GlobalValue::ProtectedVisibility;
 221   }
 222 }
 223
 224 static GlobalValue::DLLStorageClassTypes
 225 GetDecodedDLLStorageClass(unsigned Val) {
 226   switch (Val) {
 227   default: // Map unknown values to default.
 228   case 0: return GlobalValue::DefaultStorageClass;
 229   case 1: return GlobalValue::DLLImportStorageClass;
 230   case 2: return GlobalValue::DLLExportStorageClass;
 231   }
 232 }
 233
 234 static GlobalVariable::ThreadLocalMode GetDecodedThreadLocalMode(unsigned Val) {
 235   switch (Val) {
 236     case 0: return GlobalVariable::NotThreadLocal;
 237     default: // Map unknown non-zero value to general dynamic.
 238     case 1: return GlobalVariable::GeneralDynamicTLSModel;
 239     case 2: return GlobalVariable::LocalDynamicTLSModel;
 240     case 3: return GlobalVariable::InitialExecTLSModel;
 241     case 4: return GlobalVariable::LocalExecTLSModel;
 242   }
 243 }
 244
 245 static int GetDecodedCastOpcode(unsigned Val) {
 246   switch (Val) {
 247   default: return -1;
 248   case bitc::CAST_TRUNC   : return Instruction::Trunc;
 249   case bitc::CAST_ZEXT    : return Instruction::ZExt;
 250   case bitc::CAST_SEXT    : return Instruction::SExt;
 251   case bitc::CAST_FPTOUI  : return Instruction::FPToUI;
 252   case bitc::CAST_FPTOSI  : return Instruction::FPToSI;
 253   case bitc::CAST_UITOFP  : return Instruction::UIToFP;
 254   case bitc::CAST_SITOFP  : return Instruction::SIToFP;
 255   case bitc::CAST_FPTRUNC : return Instruction::FPTrunc;
 256   case bitc::CAST_FPEXT   : return Instruction::FPExt;
 257   case bitc::CAST_PTRTOINT: return Instruction::PtrToInt;
 258   case bitc::CAST_INTTOPTR: return Instruction::IntToPtr;
 259   case bitc::CAST_BITCAST : return Instruction::BitCast;
 260   case bitc::CAST_ADDRSPACECAST: return Instruction::AddrSpaceCast;
 261   }
 262 }
 263 static int GetDecodedBinaryOpcode(unsigned Val, Type *Ty) {
 264   switch (Val) {
 265   default: return -1;
 266   case bitc::BINOP_ADD:
 267     return Ty->isFPOrFPVectorTy() ? Instruction::FAdd : Instruction::Add;
 268   case bitc::BINOP_SUB:
 269     return Ty->isFPOrFPVectorTy() ? Instruction::FSub : Instruction::Sub;
 270   case bitc::BINOP_MUL:
 271     return Ty->isFPOrFPVectorTy() ? Instruction::FMul : Instruction::Mul;
 272   case bitc::BINOP_UDIV: return Instruction::UDiv;
 273   case bitc::BINOP_SDIV:
 274     return Ty->isFPOrFPVectorTy() ? Instruction::FDiv : Instruction::SDiv;
 275   case bitc::BINOP_UREM: return Instruction::URem;
 276   case bitc::BINOP_SREM:
 277     return Ty->isFPOrFPVectorTy() ? Instruction::FRem : Instruction::SRem;
 278   case bitc::BINOP_SHL:  return Instruction::Shl;
 279   case bitc::BINOP_LSHR: return Instruction::LShr;
 280   case bitc::BINOP_ASHR: return Instruction::AShr;
 281   case bitc::BINOP_AND:  return Instruction::And;
 282   case bitc::BINOP_OR:   return Instruction::Or;
 283   case bitc::BINOP_XOR:  return Instruction::Xor;
 284   }
 285 }
 286
 287 static AtomicRMWInst::BinOp GetDecodedRMWOperation(unsigned Val) {
 288   switch (Val) {
 289   default: return AtomicRMWInst::BAD_BINOP;
 290   case bitc::RMW_XCHG: return AtomicRMWInst::Xchg;
 291   case bitc::RMW_ADD: return AtomicRMWInst::Add;
 292   case bitc::RMW_SUB: return AtomicRMWInst::Sub;
 293   case bitc::RMW_AND: return AtomicRMWInst::And;
 294   case bitc::RMW_NAND: return AtomicRMWInst::Nand;
 295   case bitc::RMW_OR: return AtomicRMWInst::Or;
 296   case bitc::RMW_XOR: return AtomicRMWInst::Xor;
 297   case bitc::RMW_MAX: return AtomicRMWInst::Max;
 298   case bitc::RMW_MIN: return AtomicRMWInst::Min;
 299   case bitc::RMW_UMAX: return AtomicRMWInst::UMax;
 300   case bitc::RMW_UMIN: return AtomicRMWInst::UMin;
 301   }
 302 }
 303
 304 static AtomicOrdering GetDecodedOrdering(unsigned Val) {
 305   switch (Val) {
 306   case bitc::ORDERING_NOTATOMIC: return NotAtomic;
 307   case bitc::ORDERING_UNORDERED: return Unordered;
 308   case bitc::ORDERING_MONOTONIC: return Monotonic;
 309   case bitc::ORDERING_ACQUIRE: return Acquire;
 310   case bitc::ORDERING_RELEASE: return Release;
 311   case bitc::ORDERING_ACQREL: return AcquireRelease;
 312   default: // Map unknown orderings to sequentially-consistent.
 313   case bitc::ORDERING_SEQCST: return SequentiallyConsistent;
 314   }
 315 }
 316
 317 static SynchronizationScope GetDecodedSynchScope(unsigned Val) {
 318   switch (Val) {
 319   case bitc::SYNCHSCOPE_SINGLETHREAD: return SingleThread;
 320   default: // Map unknown scopes to cross-thread.
 321   case bitc::SYNCHSCOPE_CROSSTHREAD: return CrossThread;
 322   }
 323 }
 324
 325 static Comdat::SelectionKind getDecodedComdatSelectionKind(unsigned Val) {
 326   switch (Val) {
 327   default: // Map unknown selection kinds to any.
 328   case bitc::COMDAT_SELECTION_KIND_ANY:
 329     return Comdat::Any;
 330   case bitc::COMDAT_SELECTION_KIND_EXACT_MATCH:
 331     return Comdat::ExactMatch;
 332   case bitc::COMDAT_SELECTION_KIND_LARGEST:
 333     return Comdat::Largest;
 334   case bitc::COMDAT_SELECTION_KIND_NO_DUPLICATES:
 335     return Comdat::NoDuplicates;
 336   case bitc::COMDAT_SELECTION_KIND_SAME_SIZE:
 337     return Comdat::SameSize;
 338   }
 339 }
 340
 341 static void UpgradeDLLImportExportLinkage(llvm::GlobalValue *GV, unsigned Val) {
 342   switch (Val) {
 343   case 5: GV->setDLLStorageClass(GlobalValue::DLLImportStorageClass); break;
 344   case 6: GV->setDLLStorageClass(GlobalValue::DLLExportStorageClass); break;
 345   }
 346 }
 347
 348 namespace llvm {
 349 namespace {
 350   /// @brief A class for maintaining the slot number definition
 351   /// as a placeholder for the actual definition for forward constants defs.
 352   class ConstantPlaceHolder : public ConstantExpr {
 353     void operator=(const ConstantPlaceHolder &) LLVM_DELETED_FUNCTION;
 354   public:
 355     // allocate space for exactly one operand
 356     void *operator new(size_t s) {
 357       return User::operator new(s, 1);
 358     }
 359     explicit ConstantPlaceHolder(Type *Ty, LLVMContext& Context)
 360       : ConstantExpr(Ty, Instruction::UserOp1, &Op<0>(), 1) {
 361       Op<0>() = UndefValue::get(Type::getInt32Ty(Context));
 362     }
 363
 364     /// @brief Methods to support type inquiry through isa, cast, and dyn_cast.
 365     static bool classof(const Value *V) {
 366       return isa<ConstantExpr>(V) &&
 367              cast<ConstantExpr>(V)->getOpcode() == Instruction::UserOp1;
 368     }
 369
 370
 371     /// Provide fast operand accessors
 372     DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 373   };
 374 }
 375
 376 // FIXME: can we inherit this from ConstantExpr?
 377 template <>
 378 struct OperandTraits<ConstantPlaceHolder> :
 379   public FixedNumOperandTraits<ConstantPlaceHolder, 1> {
 380 };
 381 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ConstantPlaceHolder, Value)
 382 }
 383
 384
 385 void BitcodeReaderValueList::AssignValue(Value *V, unsigned Idx) {
 386   if (Idx == size()) {
 387     push_back(V);
 388     return;
 389   }
 390
 391   if (Idx >= size())
 392     resize(Idx+1);
 393
 394   WeakVH &OldV = ValuePtrs[Idx];
 395   if (!OldV) {
 396     OldV = V;
 397     return;
 398   }
 399
 400   // Handle constants and non-constants (e.g. instrs) differently for
 401   // efficiency.
 402   if (Constant *PHC = dyn_cast<Constant>(&*OldV)) {
 403     ResolveConstants.push_back(std::make_pair(PHC, Idx));
 404     OldV = V;
 405   } else {
 406     // If there was a forward reference to this value, replace it.
 407     Value *PrevVal = OldV;
 408     OldV->replaceAllUsesWith(V);
 409     delete PrevVal;
 410   }
 411 }
 412
 413
 414 Constant *BitcodeReaderValueList::getConstantFwdRef(unsigned Idx,
 415                                                     Type *Ty) {
 416   if (Idx >= size())
 417     resize(Idx + 1);
 418
 419   if (Value *V = ValuePtrs[Idx]) {
 420     assert(Ty == V->getType() && "Type mismatch in constant table!");
 421     return cast<Constant>(V);
 422   }
 423
 424   // Create and return a placeholder, which will later be RAUW'd.
 425   Constant *C = new ConstantPlaceHolder(Ty, Context);
 426   ValuePtrs[Idx] = C;
 427   return C;
 428 }
 429
 430 Value *BitcodeReaderValueList::getValueFwdRef(unsigned Idx, Type *Ty) {
 431   if (Idx >= size())
 432     resize(Idx + 1);
 433
 434   if (Value *V = ValuePtrs[Idx]) {
 435     assert((!Ty || Ty == V->getType()) && "Type mismatch in value table!");
 436     return V;
 437   }
 438
 439   // No type specified, must be invalid reference.
 440   if (!Ty) return nullptr;
 441
 442   // Create and return a placeholder, which will later be RAUW'd.
 443   Value *V = new Argument(Ty);
 444   ValuePtrs[Idx] = V;
 445   return V;
 446 }
 447
 448 /// ResolveConstantForwardRefs - Once all constants are read, this method bulk
 449 /// resolves any forward references.  The idea behind this is that we sometimes
 450 /// get constants (such as large arrays) which reference *many* forward ref
 451 /// constants.  Replacing each of these causes a lot of thrashing when
 452 /// building/reuniquing the constant.  Instead of doing this, we look at all the
 453 /// uses and rewrite all the place holders at once for any constant that uses
 454 /// a placeholder.
 455 void BitcodeReaderValueList::ResolveConstantForwardRefs() {
 456   // Sort the values by-pointer so that they are efficient to look up with a
 457   // binary search.
 458   std::sort(ResolveConstants.begin(), ResolveConstants.end());
 459
 460   SmallVector<Constant*, 64> NewOps;
 461
 462   while (!ResolveConstants.empty()) {
 463     Value *RealVal = operator[](ResolveConstants.back().second);
 464     Constant *Placeholder = ResolveConstants.back().first;
 465     ResolveConstants.pop_back();
 466
 467     // Loop over all users of the placeholder, updating them to reference the
 468     // new value.  If they reference more than one placeholder, update them all
 469     // at once.
 470     while (!Placeholder->use_empty()) {
 471       auto UI = Placeholder->user_begin();
 472       User *U = *UI;
 473
 474       // If the using object isn't uniqued, just update the operands.  This
 475       // handles instructions and initializers for global variables.
 476       if (!isa<Constant>(U) || isa<GlobalValue>(U)) {
 477         UI.getUse().set(RealVal);
 478         continue;
 479       }
 480
 481       // Otherwise, we have a constant that uses the placeholder.  Replace that
 482       // constant with a new constant that has *all* placeholder uses updated.
 483       Constant *UserC = cast<Constant>(U);
 484       for (User::op_iterator I = UserC->op_begin(), E = UserC->op_end();
 485            I != E; ++I) {
 486         Value *NewOp;
 487         if (!isa<ConstantPlaceHolder>(*I)) {
 488           // Not a placeholder reference.
 489           NewOp = *I;
 490         } else if (*I == Placeholder) {
 491           // Common case is that it just references this one placeholder.
 492           NewOp = RealVal;
 493         } else {
 494           // Otherwise, look up the placeholder in ResolveConstants.
 495           ResolveConstantsTy::iterator It =
 496             std::lower_bound(ResolveConstants.begin(), ResolveConstants.end(),
 497                              std::pair<Constant*, unsigned>(cast<Constant>(*I),
 498                                                             0));
 499           assert(It != ResolveConstants.end() && It->first == *I);
 500           NewOp = operator[](It->second);
 501         }
 502
 503         NewOps.push_back(cast<Constant>(NewOp));
 504       }
 505
 506       // Make the new constant.
 507       Constant *NewC;
 508       if (ConstantArray *UserCA = dyn_cast<ConstantArray>(UserC)) {
 509         NewC = ConstantArray::get(UserCA->getType(), NewOps);
 510       } else if (ConstantStruct *UserCS = dyn_cast<ConstantStruct>(UserC)) {
 511         NewC = ConstantStruct::get(UserCS->getType(), NewOps);
 512       } else if (isa<ConstantVector>(UserC)) {
 513         NewC = ConstantVector::get(NewOps);
 514       } else {
 515         assert(isa<ConstantExpr>(UserC) && "Must be a ConstantExpr.");
 516         NewC = cast<ConstantExpr>(UserC)->getWithOperands(NewOps);
 517       }
 518
 519       UserC->replaceAllUsesWith(NewC);
 520       UserC->destroyConstant();
 521       NewOps.clear();
 522     }
 523
 524     // Update all ValueHandles, they should be the only users at this point.
 525     Placeholder->replaceAllUsesWith(RealVal);
 526     delete Placeholder;
 527   }
 528 }
 529
 530 void BitcodeReaderMDValueList::AssignValue(Metadata *MD, unsigned Idx) {
 531   if (Idx == size()) {
 532     push_back(MD);
 533     return;
 534   }
 535
 536   if (Idx >= size())
 537     resize(Idx+1);
 538
 539   TrackingMDRef &OldMD = MDValuePtrs[Idx];
 540   if (!OldMD) {
 541     OldMD.reset(MD);
 542     return;
 543   }
 544
 545   // If there was a forward reference to this value, replace it.
 546   TempMDTuple PrevMD(cast<MDTuple>(OldMD.get()));
 547   PrevMD->replaceAllUsesWith(MD);
 548   --NumFwdRefs;
 549 }
 550
 551 Metadata *BitcodeReaderMDValueList::getValueFwdRef(unsigned Idx) {
 552   if (Idx >= size())
 553     resize(Idx + 1);
 554
 555   if (Metadata *MD = MDValuePtrs[Idx])
 556     return MD;
 557
 558   // Create and return a placeholder, which will later be RAUW'd.
 559   AnyFwdRefs = true;
 560   ++NumFwdRefs;
 561   Metadata *MD = MDNode::getTemporary(Context, None).release();
 562   MDValuePtrs[Idx].reset(MD);
 563   return MD;
 564 }
 565
 566 void BitcodeReaderMDValueList::tryToResolveCycles() {
 567   if (!AnyFwdRefs)
 568     // Nothing to do.
 569     return;
 570
 571   if (NumFwdRefs)
 572     // Still forward references... can't resolve cycles.
 573     return;
 574
 575   // Resolve any cycles.
 576   for (auto &MD : MDValuePtrs) {
 577     auto *N = dyn_cast_or_null<MDNode>(MD);
 578     if (!N)
 579       continue;
 580
 581     assert(!N->isTemporary() && "Unexpected forward reference");
 582     N->resolveCycles();
 583   }
 584 }
 585
 586 Type *BitcodeReader::getTypeByID(unsigned ID) {
 587   // The type table size is always specified correctly.
 588   if (ID >= TypeList.size())
 589     return nullptr;
 590
 591   if (Type *Ty = TypeList[ID])
 592     return Ty;
 593
 594   // If we have a forward reference, the only possible case is when it is to a
 595   // named struct.  Just create a placeholder for now.
 596   return TypeList[ID] = createIdentifiedStructType(Context);
 597 }
 598
 599 StructType *BitcodeReader::createIdentifiedStructType(LLVMContext &Context,
 600                                                       StringRef Name) {
 601   auto *Ret = StructType::create(Context, Name);
 602   IdentifiedStructTypes.push_back(Ret);
 603   return Ret;
 604 }
 605
 606 StructType *BitcodeReader::createIdentifiedStructType(LLVMContext &Context) {
 607   auto *Ret = StructType::create(Context);
 608   IdentifiedStructTypes.push_back(Ret);
 609   return Ret;
 610 }
 611
 612
 613 //===----------------------------------------------------------------------===//
 614 //  Functions for parsing blocks from the bitcode file
 615 //===----------------------------------------------------------------------===//
 616
 617
 618 /// \brief This fills an AttrBuilder object with the LLVM attributes that have
 619 /// been decoded from the given integer. This function must stay in sync with
 620 /// 'encodeLLVMAttributesForBitcode'.
 621 static void decodeLLVMAttributesForBitcode(AttrBuilder &B,
 622                                            uint64_t EncodedAttrs) {
 623   // FIXME: Remove in 4.0.
 624
 625   // The alignment is stored as a 16-bit raw value from bits 31--16.  We shift
 626   // the bits above 31 down by 11 bits.
 627   unsigned Alignment = (EncodedAttrs & (0xffffULL << 16)) >> 16;
 628   assert((!Alignment || isPowerOf2_32(Alignment)) &&
 629          "Alignment must be a power of two.");
 630
 631   if (Alignment)
 632     B.addAlignmentAttr(Alignment);
 633   B.addRawValue(((EncodedAttrs & (0xfffffULL << 32)) >> 11) |
 634                 (EncodedAttrs & 0xffff));
 635 }
 636
 637 std::error_code BitcodeReader::ParseAttributeBlock() {
 638   if (Stream.EnterSubBlock(bitc::PARAMATTR_BLOCK_ID))
 639     return Error("Invalid record");
 640
 641   if (!MAttributes.empty())
 642     return Error("Invalid multiple blocks");
 643
 644   SmallVector<uint64_t, 64> Record;
 645
 646   SmallVector<AttributeSet, 8> Attrs;
 647
 648   // Read all the records.
 649   while (1) {
 650     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
 651
 652     switch (Entry.Kind) {
 653     case BitstreamEntry::SubBlock: // Handled for us already.
 654     case BitstreamEntry::Error:
 655       return Error("Malformed block");
 656     case BitstreamEntry::EndBlock:
 657       return std::error_code();
 658     case BitstreamEntry::Record:
 659       // The interesting case.
 660       break;
 661     }
 662
 663     // Read a record.
 664     Record.clear();
 665     switch (Stream.readRecord(Entry.ID, Record)) {
 666     default:  // Default behavior: ignore.
 667       break;
 668     case bitc::PARAMATTR_CODE_ENTRY_OLD: { // ENTRY: [paramidx0, attr0, ...]
 669       // FIXME: Remove in 4.0.
 670       if (Record.size() & 1)
 671         return Error("Invalid record");
 672
 673       for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
 674         AttrBuilder B;
 675         decodeLLVMAttributesForBitcode(B, Record[i+1]);
 676         Attrs.push_back(AttributeSet::get(Context, Record[i], B));
 677       }
 678
 679       MAttributes.push_back(AttributeSet::get(Context, Attrs));
 680       Attrs.clear();
 681       break;
 682     }
 683     case bitc::PARAMATTR_CODE_ENTRY: { // ENTRY: [attrgrp0, attrgrp1, ...]
 684       for (unsigned i = 0, e = Record.size(); i != e; ++i)
 685         Attrs.push_back(MAttributeGroups[Record[i]]);
 686
 687       MAttributes.push_back(AttributeSet::get(Context, Attrs));
 688       Attrs.clear();
 689       break;
 690     }
 691     }
 692   }
 693 }
 694
 695 // Returns Attribute::None on unrecognized codes.
 696 static Attribute::AttrKind GetAttrFromCode(uint64_t Code) {
 697   switch (Code) {
 698   default:
 699     return Attribute::None;
 700   case bitc::ATTR_KIND_ALIGNMENT:
 701     return Attribute::Alignment;
 702   case bitc::ATTR_KIND_ALWAYS_INLINE:
 703     return Attribute::AlwaysInline;
 704   case bitc::ATTR_KIND_BUILTIN:
 705     return Attribute::Builtin;
 706   case bitc::ATTR_KIND_BY_VAL:
 707     return Attribute::ByVal;
 708   case bitc::ATTR_KIND_IN_ALLOCA:
 709     return Attribute::InAlloca;
 710   case bitc::ATTR_KIND_COLD:
 711     return Attribute::Cold;
 712   case bitc::ATTR_KIND_INLINE_HINT:
 713     return Attribute::InlineHint;
 714   case bitc::ATTR_KIND_IN_REG:
 715     return Attribute::InReg;
 716   case bitc::ATTR_KIND_JUMP_TABLE:
 717     return Attribute::JumpTable;
 718   case bitc::ATTR_KIND_MIN_SIZE:
 719     return Attribute::MinSize;
 720   case bitc::ATTR_KIND_NAKED:
 721     return Attribute::Naked;
 722   case bitc::ATTR_KIND_NEST:
 723     return Attribute::Nest;
 724   case bitc::ATTR_KIND_NO_ALIAS:
 725     return Attribute::NoAlias;
 726   case bitc::ATTR_KIND_NO_BUILTIN:
 727     return Attribute::NoBuiltin;
 728   case bitc::ATTR_KIND_NO_CAPTURE:
 729     return Attribute::NoCapture;
 730   case bitc::ATTR_KIND_NO_DUPLICATE:
 731     return Attribute::NoDuplicate;
 732   case bitc::ATTR_KIND_NO_IMPLICIT_FLOAT:
 733     return Attribute::NoImplicitFloat;
 734   case bitc::ATTR_KIND_NO_INLINE:
 735     return Attribute::NoInline;
 736   case bitc::ATTR_KIND_NON_LAZY_BIND:
 737     return Attribute::NonLazyBind;
 738   case bitc::ATTR_KIND_NON_NULL:
 739     return Attribute::NonNull;
 740   case bitc::ATTR_KIND_DEREFERENCEABLE:
 741     return Attribute::Dereferenceable;
 742   case bitc::ATTR_KIND_NO_RED_ZONE:
 743     return Attribute::NoRedZone;
 744   case bitc::ATTR_KIND_NO_RETURN:
 745     return Attribute::NoReturn;
 746   case bitc::ATTR_KIND_NO_UNWIND:
 747     return Attribute::NoUnwind;
 748   case bitc::ATTR_KIND_OPTIMIZE_FOR_SIZE:
 749     return Attribute::OptimizeForSize;
 750   case bitc::ATTR_KIND_OPTIMIZE_NONE:
 751     return Attribute::OptimizeNone;
 752   case bitc::ATTR_KIND_READ_NONE:
 753     return Attribute::ReadNone;
 754   case bitc::ATTR_KIND_READ_ONLY:
 755     return Attribute::ReadOnly;
 756   case bitc::ATTR_KIND_RETURNED:
 757     return Attribute::Returned;
 758   case bitc::ATTR_KIND_RETURNS_TWICE:
 759     return Attribute::ReturnsTwice;
 760   case bitc::ATTR_KIND_S_EXT:
 761     return Attribute::SExt;
 762   case bitc::ATTR_KIND_STACK_ALIGNMENT:
 763     return Attribute::StackAlignment;
 764   case bitc::ATTR_KIND_STACK_PROTECT:
 765     return Attribute::StackProtect;
 766   case bitc::ATTR_KIND_STACK_PROTECT_REQ:
 767     return Attribute::StackProtectReq;
 768   case bitc::ATTR_KIND_STACK_PROTECT_STRONG:
 769     return Attribute::StackProtectStrong;
 770   case bitc::ATTR_KIND_STRUCT_RET:
 771     return Attribute::StructRet;
 772   case bitc::ATTR_KIND_SANITIZE_ADDRESS:
 773     return Attribute::SanitizeAddress;
 774   case bitc::ATTR_KIND_SANITIZE_THREAD:
 775     return Attribute::SanitizeThread;
 776   case bitc::ATTR_KIND_SANITIZE_MEMORY:
 777     return Attribute::SanitizeMemory;
 778   case bitc::ATTR_KIND_UW_TABLE:
 779     return Attribute::UWTable;
 780   case bitc::ATTR_KIND_Z_EXT:
 781     return Attribute::ZExt;
 782   }
 783 }
 784
 785 std::error_code BitcodeReader::ParseAttrKind(uint64_t Code,
 786                                              Attribute::AttrKind *Kind) {
 787   *Kind = GetAttrFromCode(Code);
 788   if (*Kind == Attribute::None)
 789     return Error(BitcodeError::CorruptedBitcode,
 790                  "Unknown attribute kind (" + Twine(Code) + ")");
 791   return std::error_code();
 792 }
 793
 794 std::error_code BitcodeReader::ParseAttributeGroupBlock() {
 795   if (Stream.EnterSubBlock(bitc::PARAMATTR_GROUP_BLOCK_ID))
 796     return Error("Invalid record");
 797
 798   if (!MAttributeGroups.empty())
 799     return Error("Invalid multiple blocks");
 800
 801   SmallVector<uint64_t, 64> Record;
 802
 803   // Read all the records.
 804   while (1) {
 805     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
 806
 807     switch (Entry.Kind) {
 808     case BitstreamEntry::SubBlock: // Handled for us already.
 809     case BitstreamEntry::Error:
 810       return Error("Malformed block");
 811     case BitstreamEntry::EndBlock:
 812       return std::error_code();
 813     case BitstreamEntry::Record:
 814       // The interesting case.
 815       break;
 816     }
 817
 818     // Read a record.
 819     Record.clear();
 820     switch (Stream.readRecord(Entry.ID, Record)) {
 821     default:  // Default behavior: ignore.
 822       break;
 823     case bitc::PARAMATTR_GRP_CODE_ENTRY: { // ENTRY: [grpid, idx, a0, a1, ...]
 824       if (Record.size() < 3)
 825         return Error("Invalid record");
 826
 827       uint64_t GrpID = Record[0];
 828       uint64_t Idx = Record[1]; // Index of the object this attribute refers to.
 829
 830       AttrBuilder B;
 831       for (unsigned i = 2, e = Record.size(); i != e; ++i) {
 832         if (Record[i] == 0) {        // Enum attribute
 833           Attribute::AttrKind Kind;
 834           if (std::error_code EC = ParseAttrKind(Record[++i], &Kind))
 835             return EC;
 836
 837           B.addAttribute(Kind);
 838         } else if (Record[i] == 1) { // Integer attribute
 839           Attribute::AttrKind Kind;
 840           if (std::error_code EC = ParseAttrKind(Record[++i], &Kind))
 841             return EC;
 842           if (Kind == Attribute::Alignment)
 843             B.addAlignmentAttr(Record[++i]);
 844           else if (Kind == Attribute::StackAlignment)
 845             B.addStackAlignmentAttr(Record[++i]);
 846           else if (Kind == Attribute::Dereferenceable)
 847             B.addDereferenceableAttr(Record[++i]);
 848         } else {                     // String attribute
 849           assert((Record[i] == 3 || Record[i] == 4) &&
 850                  "Invalid attribute group entry");
 851           bool HasValue = (Record[i++] == 4);
 852           SmallString<64> KindStr;
 853           SmallString<64> ValStr;
 854
 855           while (Record[i] != 0 && i != e)
 856             KindStr += Record[i++];
 857           assert(Record[i] == 0 && "Kind string not null terminated");
 858
 859           if (HasValue) {
 860             // Has a value associated with it.
 861             ++i; // Skip the '0' that terminates the "kind" string.
 862             while (Record[i] != 0 && i != e)
 863               ValStr += Record[i++];
 864             assert(Record[i] == 0 && "Value string not null terminated");
 865           }
 866
 867           B.addAttribute(KindStr.str(), ValStr.str());
 868         }
 869       }
 870
 871       MAttributeGroups[GrpID] = AttributeSet::get(Context, Idx, B);
 872       break;
 873     }
 874     }
 875   }
 876 }
 877
 878 std::error_code BitcodeReader::ParseTypeTable() {
 879   if (Stream.EnterSubBlock(bitc::TYPE_BLOCK_ID_NEW))
 880     return Error("Invalid record");
 881
 882   return ParseTypeTableBody();
 883 }
 884
 885 std::error_code BitcodeReader::ParseTypeTableBody() {
 886   if (!TypeList.empty())
 887     return Error("Invalid multiple blocks");
 888
 889   SmallVector<uint64_t, 64> Record;
 890   unsigned NumRecords = 0;
 891
 892   SmallString<64> TypeName;
 893
 894   // Read all the records for this type table.
 895   while (1) {
 896     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
 897
 898     switch (Entry.Kind) {
 899     case BitstreamEntry::SubBlock: // Handled for us already.
 900     case BitstreamEntry::Error:
 901       return Error("Malformed block");
 902     case BitstreamEntry::EndBlock:
 903       if (NumRecords != TypeList.size())
 904         return Error("Malformed block");
 905       return std::error_code();
 906     case BitstreamEntry::Record:
 907       // The interesting case.
 908       break;
 909     }
 910
 911     // Read a record.
 912     Record.clear();
 913     Type *ResultTy = nullptr;
 914     switch (Stream.readRecord(Entry.ID, Record)) {
 915     default:
 916       return Error("Invalid value");
 917     case bitc::TYPE_CODE_NUMENTRY: // TYPE_CODE_NUMENTRY: [numentries]
 918       // TYPE_CODE_NUMENTRY contains a count of the number of types in the
 919       // type list.  This allows us to reserve space.
 920       if (Record.size() < 1)
 921         return Error("Invalid record");
 922       TypeList.resize(Record[0]);
 923       continue;
 924     case bitc::TYPE_CODE_VOID:      // VOID
 925       ResultTy = Type::getVoidTy(Context);
 926       break;
 927     case bitc::TYPE_CODE_HALF:     // HALF
 928       ResultTy = Type::getHalfTy(Context);
 929       break;
 930     case bitc::TYPE_CODE_FLOAT:     // FLOAT
 931       ResultTy = Type::getFloatTy(Context);
 932       break;
 933     case bitc::TYPE_CODE_DOUBLE:    // DOUBLE
 934       ResultTy = Type::getDoubleTy(Context);
 935       break;
 936     case bitc::TYPE_CODE_X86_FP80:  // X86_FP80
 937       ResultTy = Type::getX86_FP80Ty(Context);
 938       break;
 939     case bitc::TYPE_CODE_FP128:     // FP128
 940       ResultTy = Type::getFP128Ty(Context);
 941       break;
 942     case bitc::TYPE_CODE_PPC_FP128: // PPC_FP128
 943       ResultTy = Type::getPPC_FP128Ty(Context);
 944       break;
 945     case bitc::TYPE_CODE_LABEL:     // LABEL
 946       ResultTy = Type::getLabelTy(Context);
 947       break;
 948     case bitc::TYPE_CODE_METADATA:  // METADATA
 949       ResultTy = Type::getMetadataTy(Context);
 950       break;
 951     case bitc::TYPE_CODE_X86_MMX:   // X86_MMX
 952       ResultTy = Type::getX86_MMXTy(Context);
 953       break;
 954     case bitc::TYPE_CODE_INTEGER: { // INTEGER: [width]
 955       if (Record.size() < 1)
 956         return Error("Invalid record");
 957
 958       uint64_t NumBits = Record[0];
 959       if (NumBits < IntegerType::MIN_INT_BITS ||
 960           NumBits > IntegerType::MAX_INT_BITS)
 961         return Error("Bitwidth for integer type out of range");
 962       ResultTy = IntegerType::get(Context, NumBits);
 963       break;
 964     }
 965     case bitc::TYPE_CODE_POINTER: { // POINTER: [pointee type] or
 966                                     //          [pointee type, address space]
 967       if (Record.size() < 1)
 968         return Error("Invalid record");
 969       unsigned AddressSpace = 0;
 970       if (Record.size() == 2)
 971         AddressSpace = Record[1];
 972       ResultTy = getTypeByID(Record[0]);
 973       if (!ResultTy)
 974         return Error("Invalid type");
 975       ResultTy = PointerType::get(ResultTy, AddressSpace);
 976       break;
 977     }
 978     case bitc::TYPE_CODE_FUNCTION_OLD: {
 979       // FIXME: attrid is dead, remove it in LLVM 4.0
 980       // FUNCTION: [vararg, attrid, retty, paramty x N]
 981       if (Record.size() < 3)
 982         return Error("Invalid record");
 983       SmallVector<Type*, 8> ArgTys;
 984       for (unsigned i = 3, e = Record.size(); i != e; ++i) {
 985         if (Type *T = getTypeByID(Record[i]))
 986           ArgTys.push_back(T);
 987         else
 988           break;
 989       }
 990
 991       ResultTy = getTypeByID(Record[2]);
 992       if (!ResultTy || ArgTys.size() < Record.size()-3)
 993         return Error("Invalid type");
 994
 995       ResultTy = FunctionType::get(ResultTy, ArgTys, Record[0]);
 996       break;
 997     }
 998     case bitc::TYPE_CODE_FUNCTION: {
 999       // FUNCTION: [vararg, retty, paramty x N]
1000       if (Record.size() < 2)
1001         return Error("Invalid record");
1002       SmallVector<Type*, 8> ArgTys;
1003       for (unsigned i = 2, e = Record.size(); i != e; ++i) {
1004         if (Type *T = getTypeByID(Record[i]))
1005           ArgTys.push_back(T);
1006         else
1007           break;
1008       }
1009
1010       ResultTy = getTypeByID(Record[1]);
1011       if (!ResultTy || ArgTys.size() < Record.size()-2)
1012         return Error("Invalid type");
1013
1014       ResultTy = FunctionType::get(ResultTy, ArgTys, Record[0]);
1015       break;
1016     }
1017     case bitc::TYPE_CODE_STRUCT_ANON: {  // STRUCT: [ispacked, eltty x N]
1018       if (Record.size() < 1)
1019         return Error("Invalid record");
1020       SmallVector<Type*, 8> EltTys;
1021       for (unsigned i = 1, e = Record.size(); i != e; ++i) {
1022         if (Type *T = getTypeByID(Record[i]))
1023           EltTys.push_back(T);
1024         else
1025           break;
1026       }
1027       if (EltTys.size() != Record.size()-1)
1028         return Error("Invalid type");
1029       ResultTy = StructType::get(Context, EltTys, Record[0]);
1030       break;
1031     }
1032     case bitc::TYPE_CODE_STRUCT_NAME:   // STRUCT_NAME: [strchr x N]
1033       if (ConvertToString(Record, 0, TypeName))
1034         return Error("Invalid record");
1035       continue;
1036
1037     case bitc::TYPE_CODE_STRUCT_NAMED: { // STRUCT: [ispacked, eltty x N]
1038       if (Record.size() < 1)
1039         return Error("Invalid record");
1040
1041       if (NumRecords >= TypeList.size())
1042         return Error("Invalid TYPE table");
1043
1044       // Check to see if this was forward referenced, if so fill in the temp.
1045       StructType *Res = cast_or_null<StructType>(TypeList[NumRecords]);
1046       if (Res) {
1047         Res->setName(TypeName);
1048         TypeList[NumRecords] = nullptr;
1049       } else  // Otherwise, create a new struct.
1050         Res = createIdentifiedStructType(Context, TypeName);
1051       TypeName.clear();
1052
1053       SmallVector<Type*, 8> EltTys;
1054       for (unsigned i = 1, e = Record.size(); i != e; ++i) {
1055         if (Type *T = getTypeByID(Record[i]))
1056           EltTys.push_back(T);
1057         else
1058           break;
1059       }
1060       if (EltTys.size() != Record.size()-1)
1061         return Error("Invalid record");
1062       Res->setBody(EltTys, Record[0]);
1063       ResultTy = Res;
1064       break;
1065     }
1066     case bitc::TYPE_CODE_OPAQUE: {       // OPAQUE: []
1067       if (Record.size() != 1)
1068         return Error("Invalid record");
1069
1070       if (NumRecords >= TypeList.size())
1071         return Error("Invalid TYPE table");
1072
1073       // Check to see if this was forward referenced, if so fill in the temp.
1074       StructType *Res = cast_or_null<StructType>(TypeList[NumRecords]);
1075       if (Res) {
1076         Res->setName(TypeName);
1077         TypeList[NumRecords] = nullptr;
1078       } else  // Otherwise, create a new struct with no body.
1079         Res = createIdentifiedStructType(Context, TypeName);
1080       TypeName.clear();
1081       ResultTy = Res;
1082       break;
1083     }
1084     case bitc::TYPE_CODE_ARRAY:     // ARRAY: [numelts, eltty]
1085       if (Record.size() < 2)
1086         return Error("Invalid record");
1087       if ((ResultTy = getTypeByID(Record[1])))
1088         ResultTy = ArrayType::get(ResultTy, Record[0]);
1089       else
1090         return Error("Invalid type");
1091       break;
1092     case bitc::TYPE_CODE_VECTOR:    // VECTOR: [numelts, eltty]
1093       if (Record.size() < 2)
1094         return Error("Invalid record");
1095       if ((ResultTy = getTypeByID(Record[1])))
1096         ResultTy = VectorType::get(ResultTy, Record[0]);
1097       else
1098         return Error("Invalid type");
1099       break;
1100     }
1101
1102     if (NumRecords >= TypeList.size())
1103       return Error("Invalid TYPE table");
1104     if (TypeList[NumRecords])
1105       return Error(
1106           "Invalid TYPE table: Only named structs can be forward referenced");
1107     assert(ResultTy && "Didn't read a type?");
1108     TypeList[NumRecords++] = ResultTy;
1109   }
1110 }
1111
1112 std::error_code BitcodeReader::ParseValueSymbolTable() {
1113   if (Stream.EnterSubBlock(bitc::VALUE_SYMTAB_BLOCK_ID))
1114     return Error("Invalid record");
1115
1116   SmallVector<uint64_t, 64> Record;
1117
1118   Triple TT(TheModule->getTargetTriple());
1119
1120   // Read all the records for this value table.
1121   SmallString<128> ValueName;
1122   while (1) {
1123     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1124
1125     switch (Entry.Kind) {
1126     case BitstreamEntry::SubBlock: // Handled for us already.
1127     case BitstreamEntry::Error:
1128       return Error("Malformed block");
1129     case BitstreamEntry::EndBlock:
1130       return std::error_code();
1131     case BitstreamEntry::Record:
1132       // The interesting case.
1133       break;
1134     }
1135
1136     // Read a record.
1137     Record.clear();
1138     switch (Stream.readRecord(Entry.ID, Record)) {
1139     default:  // Default behavior: unknown type.
1140       break;
1141     case bitc::VST_CODE_ENTRY: {  // VST_ENTRY: [valueid, namechar x N]
1142       if (ConvertToString(Record, 1, ValueName))
1143         return Error("Invalid record");
1144       unsigned ValueID = Record[0];
1145       if (ValueID >= ValueList.size() || !ValueList[ValueID])
1146         return Error("Invalid record");
1147       Value *V = ValueList[ValueID];
1148
1149       V->setName(StringRef(ValueName.data(), ValueName.size()));
1150       if (auto *GO = dyn_cast<GlobalObject>(V)) {
1151         if (GO->getComdat() == reinterpret_cast<Comdat *>(1)) {
1152           if (TT.isOSBinFormatMachO())
1153             GO->setComdat(nullptr);
1154           else
1155             GO->setComdat(TheModule->getOrInsertComdat(V->getName()));
1156         }
1157       }
1158       ValueName.clear();
1159       break;
1160     }
1161     case bitc::VST_CODE_BBENTRY: {
1162       if (ConvertToString(Record, 1, ValueName))
1163         return Error("Invalid record");
1164       BasicBlock *BB = getBasicBlock(Record[0]);
1165       if (!BB)
1166         return Error("Invalid record");
1167
1168       BB->setName(StringRef(ValueName.data(), ValueName.size()));
1169       ValueName.clear();
1170       break;
1171     }
1172     }
1173   }
1174 }
1175
1176 std::error_code BitcodeReader::ParseMetadata() {
1177   unsigned NextMDValueNo = MDValueList.size();
1178
1179   if (Stream.EnterSubBlock(bitc::METADATA_BLOCK_ID))
1180     return Error("Invalid record");
1181
1182   SmallVector<uint64_t, 64> Record;
1183
1184   auto getMDString = [&](unsigned ID) -> MDString *{
1185     // This requires that the ID is not really a forward reference.  In
1186     // particular, the MDString must already have been resolved.
1187     if (ID)
1188       return cast<MDString>(MDValueList.getValueFwdRef(ID - 1));
1189     return nullptr;
1190   };
1191
1192 #define GET_OR_DISTINCT(CLASS, DISTINCT, ARGS)                                 \
1193   (DISTINCT ? CLASS::getDistinct ARGS : CLASS::get ARGS)
1194
1195   // Read all the records.
1196   while (1) {
1197     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1198
1199     switch (Entry.Kind) {
1200     case BitstreamEntry::SubBlock: // Handled for us already.
1201     case BitstreamEntry::Error:
1202       return Error("Malformed block");
1203     case BitstreamEntry::EndBlock:
1204       MDValueList.tryToResolveCycles();
1205       return std::error_code();
1206     case BitstreamEntry::Record:
1207       // The interesting case.
1208       break;
1209     }
1210
1211     // Read a record.
1212     Record.clear();
1213     unsigned Code = Stream.readRecord(Entry.ID, Record);
1214     bool IsDistinct = false;
1215     switch (Code) {
1216     default:  // Default behavior: ignore.
1217       break;
1218     case bitc::METADATA_NAME: {
1219       // Read name of the named metadata.
1220       SmallString<8> Name(Record.begin(), Record.end());
1221       Record.clear();
1222       Code = Stream.ReadCode();
1223
1224       // METADATA_NAME is always followed by METADATA_NAMED_NODE.
1225       unsigned NextBitCode = Stream.readRecord(Code, Record);
1226       assert(NextBitCode == bitc::METADATA_NAMED_NODE); (void)NextBitCode;
1227
1228       // Read named metadata elements.
1229       unsigned Size = Record.size();
1230       NamedMDNode *NMD = TheModule->getOrInsertNamedMetadata(Name);
1231       for (unsigned i = 0; i != Size; ++i) {
1232         MDNode *MD = dyn_cast_or_null<MDNode>(MDValueList.getValueFwdRef(Record[i]));
1233         if (!MD)
1234           return Error("Invalid record");
1235         NMD->addOperand(MD);
1236       }
1237       break;
1238     }
1239     case bitc::METADATA_OLD_FN_NODE: {
1240       // FIXME: Remove in 4.0.
1241       // This is a LocalAsMetadata record, the only type of function-local
1242       // metadata.
1243       if (Record.size() % 2 == 1)
1244         return Error("Invalid record");
1245
1246       // If this isn't a LocalAsMetadata record, we're dropping it.  This used
1247       // to be legal, but there's no upgrade path.
1248       auto dropRecord = [&] {
1249         MDValueList.AssignValue(MDNode::get(Context, None), NextMDValueNo++);
1250       };
1251       if (Record.size() != 2) {
1252         dropRecord();
1253         break;
1254       }
1255
1256       Type *Ty = getTypeByID(Record[0]);
1257       if (Ty->isMetadataTy() || Ty->isVoidTy()) {
1258         dropRecord();
1259         break;
1260       }
1261
1262       MDValueList.AssignValue(
1263           LocalAsMetadata::get(ValueList.getValueFwdRef(Record[1], Ty)),
1264           NextMDValueNo++);
1265       break;
1266     }
1267     case bitc::METADATA_OLD_NODE: {
1268       // FIXME: Remove in 4.0.
1269       if (Record.size() % 2 == 1)
1270         return Error("Invalid record");
1271
1272       unsigned Size = Record.size();
1273       SmallVector<Metadata *, 8> Elts;
1274       for (unsigned i = 0; i != Size; i += 2) {
1275         Type *Ty = getTypeByID(Record[i]);
1276         if (!Ty)
1277           return Error("Invalid record");
1278         if (Ty->isMetadataTy())
1279           Elts.push_back(MDValueList.getValueFwdRef(Record[i+1]));
1280         else if (!Ty->isVoidTy()) {
1281           auto *MD =
1282               ValueAsMetadata::get(ValueList.getValueFwdRef(Record[i + 1], Ty));
1283           assert(isa<ConstantAsMetadata>(MD) &&
1284                  "Expected non-function-local metadata");
1285           Elts.push_back(MD);
1286         } else
1287           Elts.push_back(nullptr);
1288       }
1289       MDValueList.AssignValue(MDNode::get(Context, Elts), NextMDValueNo++);
1290       break;
1291     }
1292     case bitc::METADATA_VALUE: {
1293       if (Record.size() != 2)
1294         return Error("Invalid record");
1295
1296       Type *Ty = getTypeByID(Record[0]);
1297       if (Ty->isMetadataTy() || Ty->isVoidTy())
1298         return Error("Invalid record");
1299
1300       MDValueList.AssignValue(
1301           ValueAsMetadata::get(ValueList.getValueFwdRef(Record[1], Ty)),
1302           NextMDValueNo++);
1303       break;
1304     }
1305     case bitc::METADATA_DISTINCT_NODE:
1306       IsDistinct = true;
1307       // fallthrough...
1308     case bitc::METADATA_NODE: {
1309       SmallVector<Metadata *, 8> Elts;
1310       Elts.reserve(Record.size());
1311       for (unsigned ID : Record)
1312         Elts.push_back(ID ? MDValueList.getValueFwdRef(ID - 1) : nullptr);
1313       MDValueList.AssignValue(IsDistinct ? MDNode::getDistinct(Context, Elts)
1314                                          : MDNode::get(Context, Elts),
1315                               NextMDValueNo++);
1316       break;
1317     }
1318     case bitc::METADATA_LOCATION: {
1319       if (Record.size() != 5)
1320         return Error("Invalid record");
1321
1322       auto get = Record[0] ? MDLocation::getDistinct : MDLocation::get;
1323       unsigned Line = Record[1];
1324       unsigned Column = Record[2];
1325       MDNode *Scope = cast<MDNode>(MDValueList.getValueFwdRef(Record[3]));
1326       Metadata *InlinedAt =
1327           Record[4] ? MDValueList.getValueFwdRef(Record[4] - 1) : nullptr;
1328       MDValueList.AssignValue(get(Context, Line, Column, Scope, InlinedAt),
1329                               NextMDValueNo++);
1330       break;
1331     }
1332     case bitc::METADATA_GENERIC_DEBUG: {
1333       if (Record.size() < 4)
1334         return Error("Invalid record");
1335
1336       unsigned Tag = Record[1];
1337       unsigned Version = Record[2];
1338
1339       if (Tag >= 1u << 16 || Version != 0)
1340         return Error("Invalid record");
1341
1342       auto *Header = getMDString(Record[3]);
1343       SmallVector<Metadata *, 8> DwarfOps;
1344       for (unsigned I = 4, E = Record.size(); I != E; ++I)
1345         DwarfOps.push_back(Record[I] ? MDValueList.getValueFwdRef(Record[I] - 1)
1346                                      : nullptr);
1347       MDValueList.AssignValue(GET_OR_DISTINCT(GenericDebugNode, Record[0],
1348                                               (Context, Tag, Header, DwarfOps)),
1349                               NextMDValueNo++);
1350       break;
1351     }
1352     case bitc::METADATA_STRING: {
1353       std::string String(Record.begin(), Record.end());
1354       llvm::UpgradeMDStringConstant(String);
1355       Metadata *MD = MDString::get(Context, String);
1356       MDValueList.AssignValue(MD, NextMDValueNo++);
1357       break;
1358     }
1359     case bitc::METADATA_KIND: {
1360       if (Record.size() < 2)
1361         return Error("Invalid record");
1362
1363       unsigned Kind = Record[0];
1364       SmallString<8> Name(Record.begin()+1, Record.end());
1365
1366       unsigned NewKind = TheModule->getMDKindID(Name.str());
1367       if (!MDKindMap.insert(std::make_pair(Kind, NewKind)).second)
1368         return Error("Conflicting METADATA_KIND records");
1369       break;
1370     }
1371     }
1372   }
1373 #undef GET_OR_DISTINCT
1374 }
1375
1376 /// decodeSignRotatedValue - Decode a signed value stored with the sign bit in
1377 /// the LSB for dense VBR encoding.
1378 uint64_t BitcodeReader::decodeSignRotatedValue(uint64_t V) {
1379   if ((V & 1) == 0)
1380     return V >> 1;
1381   if (V != 1)
1382     return -(V >> 1);
1383   // There is no such thing as -0 with integers.  "-0" really means MININT.
1384   return 1ULL << 63;
1385 }
1386
1387 /// ResolveGlobalAndAliasInits - Resolve all of the initializers for global
1388 /// values and aliases that we can.
1389 std::error_code BitcodeReader::ResolveGlobalAndAliasInits() {
1390   std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInitWorklist;
1391   std::vector<std::pair<GlobalAlias*, unsigned> > AliasInitWorklist;
1392   std::vector<std::pair<Function*, unsigned> > FunctionPrefixWorklist;
1393   std::vector<std::pair<Function*, unsigned> > FunctionPrologueWorklist;
1394
1395   GlobalInitWorklist.swap(GlobalInits);
1396   AliasInitWorklist.swap(AliasInits);
1397   FunctionPrefixWorklist.swap(FunctionPrefixes);
1398   FunctionPrologueWorklist.swap(FunctionPrologues);
1399
1400   while (!GlobalInitWorklist.empty()) {
1401     unsigned ValID = GlobalInitWorklist.back().second;
1402     if (ValID >= ValueList.size()) {
1403       // Not ready to resolve this yet, it requires something later in the file.
1404       GlobalInits.push_back(GlobalInitWorklist.back());
1405     } else {
1406       if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
1407         GlobalInitWorklist.back().first->setInitializer(C);
1408       else
1409         return Error("Expected a constant");
1410     }
1411     GlobalInitWorklist.pop_back();
1412   }
1413
1414   while (!AliasInitWorklist.empty()) {
1415     unsigned ValID = AliasInitWorklist.back().second;
1416     if (ValID >= ValueList.size()) {
1417       AliasInits.push_back(AliasInitWorklist.back());
1418     } else {
1419       if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
1420         AliasInitWorklist.back().first->setAliasee(C);
1421       else
1422         return Error("Expected a constant");
1423     }
1424     AliasInitWorklist.pop_back();
1425   }
1426
1427   while (!FunctionPrefixWorklist.empty()) {
1428     unsigned ValID = FunctionPrefixWorklist.back().second;
1429     if (ValID >= ValueList.size()) {
1430       FunctionPrefixes.push_back(FunctionPrefixWorklist.back());
1431     } else {
1432       if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
1433         FunctionPrefixWorklist.back().first->setPrefixData(C);
1434       else
1435         return Error("Expected a constant");
1436     }
1437     FunctionPrefixWorklist.pop_back();
1438   }
1439
1440   while (!FunctionPrologueWorklist.empty()) {
1441     unsigned ValID = FunctionPrologueWorklist.back().second;
1442     if (ValID >= ValueList.size()) {
1443       FunctionPrologues.push_back(FunctionPrologueWorklist.back());
1444     } else {
1445       if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
1446         FunctionPrologueWorklist.back().first->setPrologueData(C);
1447       else
1448         return Error("Expected a constant");
1449     }
1450     FunctionPrologueWorklist.pop_back();
1451   }
1452
1453   return std::error_code();
1454 }
1455
1456 static APInt ReadWideAPInt(ArrayRef<uint64_t> Vals, unsigned TypeBits) {
1457   SmallVector<uint64_t, 8> Words(Vals.size());
1458   std::transform(Vals.begin(), Vals.end(), Words.begin(),
1459                  BitcodeReader::decodeSignRotatedValue);
1460
1461   return APInt(TypeBits, Words);
1462 }
1463
1464 std::error_code BitcodeReader::ParseConstants() {
1465   if (Stream.EnterSubBlock(bitc::CONSTANTS_BLOCK_ID))
1466     return Error("Invalid record");
1467
1468   SmallVector<uint64_t, 64> Record;
1469
1470   // Read all the records for this value table.
1471   Type *CurTy = Type::getInt32Ty(Context);
1472   unsigned NextCstNo = ValueList.size();
1473   while (1) {
1474     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1475
1476     switch (Entry.Kind) {
1477     case BitstreamEntry::SubBlock: // Handled for us already.
1478     case BitstreamEntry::Error:
1479       return Error("Malformed block");
1480     case BitstreamEntry::EndBlock:
1481       if (NextCstNo != ValueList.size())
1482         return Error("Invalid ronstant reference");
1483
1484       // Once all the constants have been read, go through and resolve forward
1485       // references.
1486       ValueList.ResolveConstantForwardRefs();
1487       return std::error_code();
1488     case BitstreamEntry::Record:
1489       // The interesting case.
1490       break;
1491     }
1492
1493     // Read a record.
1494     Record.clear();
1495     Value *V = nullptr;
1496     unsigned BitCode = Stream.readRecord(Entry.ID, Record);
1497     switch (BitCode) {
1498     default:  // Default behavior: unknown constant
1499     case bitc::CST_CODE_UNDEF:     // UNDEF
1500       V = UndefValue::get(CurTy);
1501       break;
1502     case bitc::CST_CODE_SETTYPE:   // SETTYPE: [typeid]
1503       if (Record.empty())
1504         return Error("Invalid record");
1505       if (Record[0] >= TypeList.size() || !TypeList[Record[0]])
1506         return Error("Invalid record");
1507       CurTy = TypeList[Record[0]];
1508       continue;  // Skip the ValueList manipulation.
1509     case bitc::CST_CODE_NULL:      // NULL
1510       V = Constant::getNullValue(CurTy);
1511       break;
1512     case bitc::CST_CODE_INTEGER:   // INTEGER: [intval]
1513       if (!CurTy->isIntegerTy() || Record.empty())
1514         return Error("Invalid record");
1515       V = ConstantInt::get(CurTy, decodeSignRotatedValue(Record[0]));
1516       break;
1517     case bitc::CST_CODE_WIDE_INTEGER: {// WIDE_INTEGER: [n x intval]
1518       if (!CurTy->isIntegerTy() || Record.empty())
1519         return Error("Invalid record");
1520
1521       APInt VInt = ReadWideAPInt(Record,
1522                                  cast<IntegerType>(CurTy)->getBitWidth());
1523       V = ConstantInt::get(Context, VInt);
1524
1525       break;
1526     }
1527     case bitc::CST_CODE_FLOAT: {    // FLOAT: [fpval]
1528       if (Record.empty())
1529         return Error("Invalid record");
1530       if (CurTy->isHalfTy())
1531         V = ConstantFP::get(Context, APFloat(APFloat::IEEEhalf,
1532                                              APInt(16, (uint16_t)Record[0])));
1533       else if (CurTy->isFloatTy())
1534         V = ConstantFP::get(Context, APFloat(APFloat::IEEEsingle,
1535                                              APInt(32, (uint32_t)Record[0])));
1536       else if (CurTy->isDoubleTy())
1537         V = ConstantFP::get(Context, APFloat(APFloat::IEEEdouble,
1538                                              APInt(64, Record[0])));
1539       else if (CurTy->isX86_FP80Ty()) {
1540         // Bits are not stored the same way as a normal i80 APInt, compensate.
1541         uint64_t Rearrange[2];
1542         Rearrange[0] = (Record[1] & 0xffffLL) | (Record[0] << 16);
1543         Rearrange[1] = Record[0] >> 48;
1544         V = ConstantFP::get(Context, APFloat(APFloat::x87DoubleExtended,
1545                                              APInt(80, Rearrange)));
1546       } else if (CurTy->isFP128Ty())
1547         V = ConstantFP::get(Context, APFloat(APFloat::IEEEquad,
1548                                              APInt(128, Record)));
1549       else if (CurTy->isPPC_FP128Ty())
1550         V = ConstantFP::get(Context, APFloat(APFloat::PPCDoubleDouble,
1551                                              APInt(128, Record)));
1552       else
1553         V = UndefValue::get(CurTy);
1554       break;
1555     }
1556
1557     case bitc::CST_CODE_AGGREGATE: {// AGGREGATE: [n x value number]
1558       if (Record.empty())
1559         return Error("Invalid record");
1560
1561       unsigned Size = Record.size();
1562       SmallVector<Constant*, 16> Elts;
1563
1564       if (StructType *STy = dyn_cast<StructType>(CurTy)) {
1565         for (unsigned i = 0; i != Size; ++i)
1566           Elts.push_back(ValueList.getConstantFwdRef(Record[i],
1567                                                      STy->getElementType(i)));
1568         V = ConstantStruct::get(STy, Elts);
1569       } else if (ArrayType *ATy = dyn_cast<ArrayType>(CurTy)) {
1570         Type *EltTy = ATy->getElementType();
1571         for (unsigned i = 0; i != Size; ++i)
1572           Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
1573         V = ConstantArray::get(ATy, Elts);
1574       } else if (VectorType *VTy = dyn_cast<VectorType>(CurTy)) {
1575         Type *EltTy = VTy->getElementType();
1576         for (unsigned i = 0; i != Size; ++i)
1577           Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
1578         V = ConstantVector::get(Elts);
1579       } else {
1580         V = UndefValue::get(CurTy);
1581       }
1582       break;
1583     }
1584     case bitc::CST_CODE_STRING:    // STRING: [values]
1585     case bitc::CST_CODE_CSTRING: { // CSTRING: [values]
1586       if (Record.empty())
1587         return Error("Invalid record");
1588
1589       SmallString<16> Elts(Record.begin(), Record.end());
1590       V = ConstantDataArray::getString(Context, Elts,
1591                                        BitCode == bitc::CST_CODE_CSTRING);
1592       break;
1593     }
1594     case bitc::CST_CODE_DATA: {// DATA: [n x value]
1595       if (Record.empty())
1596         return Error("Invalid record");
1597
1598       Type *EltTy = cast<SequentialType>(CurTy)->getElementType();
1599       unsigned Size = Record.size();
1600
1601       if (EltTy->isIntegerTy(8)) {
1602         SmallVector<uint8_t, 16> Elts(Record.begin(), Record.end());
1603         if (isa<VectorType>(CurTy))
1604           V = ConstantDataVector::get(Context, Elts);
1605         else
1606           V = ConstantDataArray::get(Context, Elts);
1607       } else if (EltTy->isIntegerTy(16)) {
1608         SmallVector<uint16_t, 16> Elts(Record.begin(), Record.end());
1609         if (isa<VectorType>(CurTy))
1610           V = ConstantDataVector::get(Context, Elts);
1611         else
1612           V = ConstantDataArray::get(Context, Elts);
1613       } else if (EltTy->isIntegerTy(32)) {
1614         SmallVector<uint32_t, 16> Elts(Record.begin(), Record.end());
1615         if (isa<VectorType>(CurTy))
1616           V = ConstantDataVector::get(Context, Elts);
1617         else
1618           V = ConstantDataArray::get(Context, Elts);
1619       } else if (EltTy->isIntegerTy(64)) {
1620         SmallVector<uint64_t, 16> Elts(Record.begin(), Record.end());
1621         if (isa<VectorType>(CurTy))
1622           V = ConstantDataVector::get(Context, Elts);
1623         else
1624           V = ConstantDataArray::get(Context, Elts);
1625       } else if (EltTy->isFloatTy()) {
1626         SmallVector<float, 16> Elts(Size);
1627         std::transform(Record.begin(), Record.end(), Elts.begin(), BitsToFloat);
1628         if (isa<VectorType>(CurTy))
1629           V = ConstantDataVector::get(Context, Elts);
1630         else
1631           V = ConstantDataArray::get(Context, Elts);
1632       } else if (EltTy->isDoubleTy()) {
1633         SmallVector<double, 16> Elts(Size);
1634         std::transform(Record.begin(), Record.end(), Elts.begin(),
1635                        BitsToDouble);
1636         if (isa<VectorType>(CurTy))
1637           V = ConstantDataVector::get(Context, Elts);
1638         else
1639           V = ConstantDataArray::get(Context, Elts);
1640       } else {
1641         return Error("Invalid type for value");
1642       }
1643       break;
1644     }
1645
1646     case bitc::CST_CODE_CE_BINOP: {  // CE_BINOP: [opcode, opval, opval]
1647       if (Record.size() < 3)
1648         return Error("Invalid record");
1649       int Opc = GetDecodedBinaryOpcode(Record[0], CurTy);
1650       if (Opc < 0) {
1651         V = UndefValue::get(CurTy);  // Unknown binop.
1652       } else {
1653         Constant *LHS = ValueList.getConstantFwdRef(Record[1], CurTy);
1654         Constant *RHS = ValueList.getConstantFwdRef(Record[2], CurTy);
1655         unsigned Flags = 0;
1656         if (Record.size() >= 4) {
1657           if (Opc == Instruction::Add ||
1658               Opc == Instruction::Sub ||
1659               Opc == Instruction::Mul ||
1660               Opc == Instruction::Shl) {
1661             if (Record[3] & (1 << bitc::OBO_NO_SIGNED_WRAP))
1662               Flags |= OverflowingBinaryOperator::NoSignedWrap;
1663             if (Record[3] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
1664               Flags |= OverflowingBinaryOperator::NoUnsignedWrap;
1665           } else if (Opc == Instruction::SDiv ||
1666                      Opc == Instruction::UDiv ||
1667                      Opc == Instruction::LShr ||
1668                      Opc == Instruction::AShr) {
1669             if (Record[3] & (1 << bitc::PEO_EXACT))
1670               Flags |= SDivOperator::IsExact;
1671           }
1672         }
1673         V = ConstantExpr::get(Opc, LHS, RHS, Flags);
1674       }
1675       break;
1676     }
1677     case bitc::CST_CODE_CE_CAST: {  // CE_CAST: [opcode, opty, opval]
1678       if (Record.size() < 3)
1679         return Error("Invalid record");
1680       int Opc = GetDecodedCastOpcode(Record[0]);
1681       if (Opc < 0) {
1682         V = UndefValue::get(CurTy);  // Unknown cast.
1683       } else {
1684         Type *OpTy = getTypeByID(Record[1]);
1685         if (!OpTy)
1686           return Error("Invalid record");
1687         Constant *Op = ValueList.getConstantFwdRef(Record[2], OpTy);
1688         V = UpgradeBitCastExpr(Opc, Op, CurTy);
1689         if (!V) V = ConstantExpr::getCast(Opc, Op, CurTy);
1690       }
1691       break;
1692     }
1693     case bitc::CST_CODE_CE_INBOUNDS_GEP:
1694     case bitc::CST_CODE_CE_GEP: {  // CE_GEP:        [n x operands]
1695       if (Record.size() & 1)
1696         return Error("Invalid record");
1697       SmallVector<Constant*, 16> Elts;
1698       for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
1699         Type *ElTy = getTypeByID(Record[i]);
1700         if (!ElTy)
1701           return Error("Invalid record");
1702         Elts.push_back(ValueList.getConstantFwdRef(Record[i+1], ElTy));
1703       }
1704       ArrayRef<Constant *> Indices(Elts.begin() + 1, Elts.end());
1705       V = ConstantExpr::getGetElementPtr(Elts[0], Indices,
1706                                          BitCode ==
1707                                            bitc::CST_CODE_CE_INBOUNDS_GEP);
1708       break;
1709     }
1710     case bitc::CST_CODE_CE_SELECT: {  // CE_SELECT: [opval#, opval#, opval#]
1711       if (Record.size() < 3)
1712         return Error("Invalid record");
1713
1714       Type *SelectorTy = Type::getInt1Ty(Context);
1715
1716       // If CurTy is a vector of length n, then Record[0] must be a <n x i1>
1717       // vector. Otherwise, it must be a single bit.
1718       if (VectorType *VTy = dyn_cast<VectorType>(CurTy))
1719         SelectorTy = VectorType::get(Type::getInt1Ty(Context),
1720                                      VTy->getNumElements());
1721
1722       V = ConstantExpr::getSelect(ValueList.getConstantFwdRef(Record[0],
1723                                                               SelectorTy),
1724                                   ValueList.getConstantFwdRef(Record[1],CurTy),
1725                                   ValueList.getConstantFwdRef(Record[2],CurTy));
1726       break;
1727     }
1728     case bitc::CST_CODE_CE_EXTRACTELT
1729         : { // CE_EXTRACTELT: [opty, opval, opty, opval]
1730       if (Record.size() < 3)
1731         return Error("Invalid record");
1732       VectorType *OpTy =
1733         dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
1734       if (!OpTy)
1735         return Error("Invalid record");
1736       Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
1737       Constant *Op1 = nullptr;
1738       if (Record.size() == 4) {
1739         Type *IdxTy = getTypeByID(Record[2]);
1740         if (!IdxTy)
1741           return Error("Invalid record");
1742         Op1 = ValueList.getConstantFwdRef(Record[3], IdxTy);
1743       } else // TODO: Remove with llvm 4.0
1744         Op1 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
1745       if (!Op1)
1746         return Error("Invalid record");
1747       V = ConstantExpr::getExtractElement(Op0, Op1);
1748       break;
1749     }
1750     case bitc::CST_CODE_CE_INSERTELT
1751         : { // CE_INSERTELT: [opval, opval, opty, opval]
1752       VectorType *OpTy = dyn_cast<VectorType>(CurTy);
1753       if (Record.size() < 3 || !OpTy)
1754         return Error("Invalid record");
1755       Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
1756       Constant *Op1 = ValueList.getConstantFwdRef(Record[1],
1757                                                   OpTy->getElementType());
1758       Constant *Op2 = nullptr;
1759       if (Record.size() == 4) {
1760         Type *IdxTy = getTypeByID(Record[2]);
1761         if (!IdxTy)
1762           return Error("Invalid record");
1763         Op2 = ValueList.getConstantFwdRef(Record[3], IdxTy);
1764       } else // TODO: Remove with llvm 4.0
1765         Op2 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
1766       if (!Op2)
1767         return Error("Invalid record");
1768       V = ConstantExpr::getInsertElement(Op0, Op1, Op2);
1769       break;
1770     }
1771     case bitc::CST_CODE_CE_SHUFFLEVEC: { // CE_SHUFFLEVEC: [opval, opval, opval]
1772       VectorType *OpTy = dyn_cast<VectorType>(CurTy);
1773       if (Record.size() < 3 || !OpTy)
1774         return Error("Invalid record");
1775       Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
1776       Constant *Op1 = ValueList.getConstantFwdRef(Record[1], OpTy);
1777       Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
1778                                                  OpTy->getNumElements());
1779       Constant *Op2 = ValueList.getConstantFwdRef(Record[2], ShufTy);
1780       V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
1781       break;
1782     }
1783     case bitc::CST_CODE_CE_SHUFVEC_EX: { // [opty, opval, opval, opval]
1784       VectorType *RTy = dyn_cast<VectorType>(CurTy);
1785       VectorType *OpTy =
1786         dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
1787       if (Record.size() < 4 || !RTy || !OpTy)
1788         return Error("Invalid record");
1789       Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
1790       Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
1791       Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
1792                                                  RTy->getNumElements());
1793       Constant *Op2 = ValueList.getConstantFwdRef(Record[3], ShufTy);
1794       V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
1795       break;
1796     }
1797     case bitc::CST_CODE_CE_CMP: {     // CE_CMP: [opty, opval, opval, pred]
1798       if (Record.size() < 4)
1799         return Error("Invalid record");
1800       Type *OpTy = getTypeByID(Record[0]);
1801       if (!OpTy)
1802         return Error("Invalid record");
1803       Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
1804       Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
1805
1806       if (OpTy->isFPOrFPVectorTy())
1807         V = ConstantExpr::getFCmp(Record[3], Op0, Op1);
1808       else
1809         V = ConstantExpr::getICmp(Record[3], Op0, Op1);
1810       break;
1811     }
1812     // This maintains backward compatibility, pre-asm dialect keywords.
1813     // FIXME: Remove with the 4.0 release.
1814     case bitc::CST_CODE_INLINEASM_OLD: {
1815       if (Record.size() < 2)
1816         return Error("Invalid record");
1817       std::string AsmStr, ConstrStr;
1818       bool HasSideEffects = Record[0] & 1;
1819       bool IsAlignStack = Record[0] >> 1;
1820       unsigned AsmStrSize = Record[1];
1821       if (2+AsmStrSize >= Record.size())
1822         return Error("Invalid record");
1823       unsigned ConstStrSize = Record[2+AsmStrSize];
1824       if (3+AsmStrSize+ConstStrSize > Record.size())
1825         return Error("Invalid record");
1826
1827       for (unsigned i = 0; i != AsmStrSize; ++i)
1828         AsmStr += (char)Record[2+i];
1829       for (unsigned i = 0; i != ConstStrSize; ++i)
1830         ConstrStr += (char)Record[3+AsmStrSize+i];
1831       PointerType *PTy = cast<PointerType>(CurTy);
1832       V = InlineAsm::get(cast<FunctionType>(PTy->getElementType()),
1833                          AsmStr, ConstrStr, HasSideEffects, IsAlignStack);
1834       break;
1835     }
1836     // This version adds support for the asm dialect keywords (e.g.,
1837     // inteldialect).
1838     case bitc::CST_CODE_INLINEASM: {
1839       if (Record.size() < 2)
1840         return Error("Invalid record");
1841       std::string AsmStr, ConstrStr;
1842       bool HasSideEffects = Record[0] & 1;
1843       bool IsAlignStack = (Record[0] >> 1) & 1;
1844       unsigned AsmDialect = Record[0] >> 2;
1845       unsigned AsmStrSize = Record[1];
1846       if (2+AsmStrSize >= Record.size())
1847         return Error("Invalid record");
1848       unsigned ConstStrSize = Record[2+AsmStrSize];
1849       if (3+AsmStrSize+ConstStrSize > Record.size())
1850         return Error("Invalid record");
1851
1852       for (unsigned i = 0; i != AsmStrSize; ++i)
1853         AsmStr += (char)Record[2+i];
1854       for (unsigned i = 0; i != ConstStrSize; ++i)
1855         ConstrStr += (char)Record[3+AsmStrSize+i];
1856       PointerType *PTy = cast<PointerType>(CurTy);
1857       V = InlineAsm::get(cast<FunctionType>(PTy->getElementType()),
1858                          AsmStr, ConstrStr, HasSideEffects, IsAlignStack,
1859                          InlineAsm::AsmDialect(AsmDialect));
1860       break;
1861     }
1862     case bitc::CST_CODE_BLOCKADDRESS:{
1863       if (Record.size() < 3)
1864         return Error("Invalid record");
1865       Type *FnTy = getTypeByID(Record[0]);
1866       if (!FnTy)
1867         return Error("Invalid record");
1868       Function *Fn =
1869         dyn_cast_or_null<Function>(ValueList.getConstantFwdRef(Record[1],FnTy));
1870       if (!Fn)
1871         return Error("Invalid record");
1872
1873       // Don't let Fn get dematerialized.
1874       BlockAddressesTaken.insert(Fn);
1875
1876       // If the function is already parsed we can insert the block address right
1877       // away.
1878       BasicBlock *BB;
1879       unsigned BBID = Record[2];
1880       if (!BBID)
1881         // Invalid reference to entry block.
1882         return Error("Invalid ID");
1883       if (!Fn->empty()) {
1884         Function::iterator BBI = Fn->begin(), BBE = Fn->end();
1885         for (size_t I = 0, E = BBID; I != E; ++I) {
1886           if (BBI == BBE)
1887             return Error("Invalid ID");
1888           ++BBI;
1889         }
1890         BB = BBI;
1891       } else {
1892         // Otherwise insert a placeholder and remember it so it can be inserted
1893         // when the function is parsed.
1894         auto &FwdBBs = BasicBlockFwdRefs[Fn];
1895         if (FwdBBs.empty())
1896           BasicBlockFwdRefQueue.push_back(Fn);
1897         if (FwdBBs.size() < BBID + 1)
1898           FwdBBs.resize(BBID + 1);
1899         if (!FwdBBs[BBID])
1900           FwdBBs[BBID] = BasicBlock::Create(Context);
1901         BB = FwdBBs[BBID];
1902       }
1903       V = BlockAddress::get(Fn, BB);
1904       break;
1905     }
1906     }
1907
1908     ValueList.AssignValue(V, NextCstNo);
1909     ++NextCstNo;
1910   }
1911 }
1912
1913 std::error_code BitcodeReader::ParseUseLists() {
1914   if (Stream.EnterSubBlock(bitc::USELIST_BLOCK_ID))
1915     return Error("Invalid record");
1916
1917   // Read all the records.
1918   SmallVector<uint64_t, 64> Record;
1919   while (1) {
1920     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1921
1922     switch (Entry.Kind) {
1923     case BitstreamEntry::SubBlock: // Handled for us already.
1924     case BitstreamEntry::Error:
1925       return Error("Malformed block");
1926     case BitstreamEntry::EndBlock:
1927       return std::error_code();
1928     case BitstreamEntry::Record:
1929       // The interesting case.
1930       break;
1931     }
1932
1933     // Read a use list record.
1934     Record.clear();
1935     bool IsBB = false;
1936     switch (Stream.readRecord(Entry.ID, Record)) {
1937     default:  // Default behavior: unknown type.
1938       break;
1939     case bitc::USELIST_CODE_BB:
1940       IsBB = true;
1941       // fallthrough
1942     case bitc::USELIST_CODE_DEFAULT: {
1943       unsigned RecordLength = Record.size();
1944       if (RecordLength < 3)
1945         // Records should have at least an ID and two indexes.
1946         return Error("Invalid record");
1947       unsigned ID = Record.back();
1948       Record.pop_back();
1949
1950       Value *V;
1951       if (IsBB) {
1952         assert(ID < FunctionBBs.size() && "Basic block not found");
1953         V = FunctionBBs[ID];
1954       } else
1955         V = ValueList[ID];
1956       unsigned NumUses = 0;
1957       SmallDenseMap<const Use *, unsigned, 16> Order;
1958       for (const Use &U : V->uses()) {
1959         if (++NumUses > Record.size())
1960           break;
1961         Order[&U] = Record[NumUses - 1];
1962       }
1963       if (Order.size() != Record.size() || NumUses > Record.size())
1964         // Mismatches can happen if the functions are being materialized lazily
1965         // (out-of-order), or a value has been upgraded.
1966         break;
1967
1968       V->sortUseList([&](const Use &L, const Use &R) {
1969         return Order.lookup(&L) < Order.lookup(&R);
1970       });
1971       break;
1972     }
1973     }
1974   }
1975 }
1976
1977 /// RememberAndSkipFunctionBody - When we see the block for a function body,
1978 /// remember where it is and then skip it.  This lets us lazily deserialize the
1979 /// functions.
1980 std::error_code BitcodeReader::RememberAndSkipFunctionBody() {
1981   // Get the function we are talking about.
1982   if (FunctionsWithBodies.empty())
1983     return Error("Insufficient function protos");
1984
1985   Function *Fn = FunctionsWithBodies.back();
1986   FunctionsWithBodies.pop_back();
1987
1988   // Save the current stream state.
1989   uint64_t CurBit = Stream.GetCurrentBitNo();
1990   DeferredFunctionInfo[Fn] = CurBit;
1991
1992   // Skip over the function block for now.
1993   if (Stream.SkipBlock())
1994     return Error("Invalid record");
1995   return std::error_code();
1996 }
1997
1998 std::error_code BitcodeReader::GlobalCleanup() {
1999   // Patch the initializers for globals and aliases up.
2000   ResolveGlobalAndAliasInits();
2001   if (!GlobalInits.empty() || !AliasInits.empty())
2002     return Error("Malformed global initializer set");
2003
2004   // Look for intrinsic functions which need to be upgraded at some point
2005   for (Module::iterator FI = TheModule->begin(), FE = TheModule->end();
2006        FI != FE; ++FI) {
2007     Function *NewFn;
2008     if (UpgradeIntrinsicFunction(FI, NewFn))
2009       UpgradedIntrinsics.push_back(std::make_pair(FI, NewFn));
2010   }
2011
2012   // Look for global variables which need to be renamed.
2013   for (Module::global_iterator
2014          GI = TheModule->global_begin(), GE = TheModule->global_end();
2015        GI != GE;) {
2016     GlobalVariable *GV = GI++;
2017     UpgradeGlobalVariable(GV);
2018   }
2019
2020   // Force deallocation of memory for these vectors to favor the client that
2021   // want lazy deserialization.
2022   std::vector<std::pair<GlobalVariable*, unsigned> >().swap(GlobalInits);
2023   std::vector<std::pair<GlobalAlias*, unsigned> >().swap(AliasInits);
2024   return std::error_code();
2025 }
2026
2027 std::error_code BitcodeReader::ParseModule(bool Resume) {
2028   if (Resume)
2029     Stream.JumpToBit(NextUnreadBit);
2030   else if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
2031     return Error("Invalid record");
2032
2033   SmallVector<uint64_t, 64> Record;
2034   std::vector<std::string> SectionTable;
2035   std::vector<std::string> GCTable;
2036
2037   // Read all the records for this module.
2038   while (1) {
2039     BitstreamEntry Entry = Stream.advance();
2040
2041     switch (Entry.Kind) {
2042     case BitstreamEntry::Error:
2043       return Error("Malformed block");
2044     case BitstreamEntry::EndBlock:
2045       return GlobalCleanup();
2046
2047     case BitstreamEntry::SubBlock:
2048       switch (Entry.ID) {
2049       default:  // Skip unknown content.
2050         if (Stream.SkipBlock())
2051           return Error("Invalid record");
2052         break;
2053       case bitc::BLOCKINFO_BLOCK_ID:
2054         if (Stream.ReadBlockInfoBlock())
2055           return Error("Malformed block");
2056         break;
2057       case bitc::PARAMATTR_BLOCK_ID:
2058         if (std::error_code EC = ParseAttributeBlock())
2059           return EC;
2060         break;
2061       case bitc::PARAMATTR_GROUP_BLOCK_ID:
2062         if (std::error_code EC = ParseAttributeGroupBlock())
2063           return EC;
2064         break;
2065       case bitc::TYPE_BLOCK_ID_NEW:
2066         if (std::error_code EC = ParseTypeTable())
2067           return EC;
2068         break;
2069       case bitc::VALUE_SYMTAB_BLOCK_ID:
2070         if (std::error_code EC = ParseValueSymbolTable())
2071           return EC;
2072         SeenValueSymbolTable = true;
2073         break;
2074       case bitc::CONSTANTS_BLOCK_ID:
2075         if (std::error_code EC = ParseConstants())
2076           return EC;
2077         if (std::error_code EC = ResolveGlobalAndAliasInits())
2078           return EC;
2079         break;
2080       case bitc::METADATA_BLOCK_ID:
2081         if (std::error_code EC = ParseMetadata())
2082           return EC;
2083         break;
2084       case bitc::FUNCTION_BLOCK_ID:
2085         // If this is the first function body we've seen, reverse the
2086         // FunctionsWithBodies list.
2087         if (!SeenFirstFunctionBody) {
2088           std::reverse(FunctionsWithBodies.begin(), FunctionsWithBodies.end());
2089           if (std::error_code EC = GlobalCleanup())
2090             return EC;
2091           SeenFirstFunctionBody = true;
2092         }
2093
2094         if (std::error_code EC = RememberAndSkipFunctionBody())
2095           return EC;
2096         // For streaming bitcode, suspend parsing when we reach the function
2097         // bodies. Subsequent materialization calls will resume it when
2098         // necessary. For streaming, the function bodies must be at the end of
2099         // the bitcode. If the bitcode file is old, the symbol table will be
2100         // at the end instead and will not have been seen yet. In this case,
2101         // just finish the parse now.
2102         if (LazyStreamer && SeenValueSymbolTable) {
2103           NextUnreadBit = Stream.GetCurrentBitNo();
2104           return std::error_code();
2105         }
2106         break;
2107       case bitc::USELIST_BLOCK_ID:
2108         if (std::error_code EC = ParseUseLists())
2109           return EC;
2110         break;
2111       }
2112       continue;
2113
2114     case BitstreamEntry::Record:
2115       // The interesting case.
2116       break;
2117     }
2118
2119
2120     // Read a record.
2121     switch (Stream.readRecord(Entry.ID, Record)) {
2122     default: break;  // Default behavior, ignore unknown content.
2123     case bitc::MODULE_CODE_VERSION: {  // VERSION: [version#]
2124       if (Record.size() < 1)
2125         return Error("Invalid record");
2126       // Only version #0 and #1 are supported so far.
2127       unsigned module_version = Record[0];
2128       switch (module_version) {
2129         default:
2130           return Error("Invalid value");
2131         case 0:
2132           UseRelativeIDs = false;
2133           break;
2134         case 1:
2135           UseRelativeIDs = true;
2136           break;
2137       }
2138       break;
2139     }
2140     case bitc::MODULE_CODE_TRIPLE: {  // TRIPLE: [strchr x N]
2141       std::string S;
2142       if (ConvertToString(Record, 0, S))
2143         return Error("Invalid record");
2144       TheModule->setTargetTriple(S);
2145       break;
2146     }
2147     case bitc::MODULE_CODE_DATALAYOUT: {  // DATALAYOUT: [strchr x N]
2148       std::string S;
2149       if (ConvertToString(Record, 0, S))
2150         return Error("Invalid record");
2151       TheModule->setDataLayout(S);
2152       break;
2153     }
2154     case bitc::MODULE_CODE_ASM: {  // ASM: [strchr x N]
2155       std::string S;
2156       if (ConvertToString(Record, 0, S))
2157         return Error("Invalid record");
2158       TheModule->setModuleInlineAsm(S);
2159       break;
2160     }
2161     case bitc::MODULE_CODE_DEPLIB: {  // DEPLIB: [strchr x N]
2162       // FIXME: Remove in 4.0.
2163       std::string S;
2164       if (ConvertToString(Record, 0, S))
2165         return Error("Invalid record");
2166       // Ignore value.
2167       break;
2168     }
2169     case bitc::MODULE_CODE_SECTIONNAME: {  // SECTIONNAME: [strchr x N]
2170       std::string S;
2171       if (ConvertToString(Record, 0, S))
2172         return Error("Invalid record");
2173       SectionTable.push_back(S);
2174       break;
2175     }
2176     case bitc::MODULE_CODE_GCNAME: {  // SECTIONNAME: [strchr x N]
2177       std::string S;
2178       if (ConvertToString(Record, 0, S))
2179         return Error("Invalid record");
2180       GCTable.push_back(S);
2181       break;
2182     }
2183     case bitc::MODULE_CODE_COMDAT: { // COMDAT: [selection_kind, name]
2184       if (Record.size() < 2)
2185         return Error("Invalid record");
2186       Comdat::SelectionKind SK = getDecodedComdatSelectionKind(Record[0]);
2187       unsigned ComdatNameSize = Record[1];
2188       std::string ComdatName;
2189       ComdatName.reserve(ComdatNameSize);
2190       for (unsigned i = 0; i != ComdatNameSize; ++i)
2191         ComdatName += (char)Record[2 + i];
2192       Comdat *C = TheModule->getOrInsertComdat(ComdatName);
2193       C->setSelectionKind(SK);
2194       ComdatList.push_back(C);
2195       break;
2196     }
2197     // GLOBALVAR: [pointer type, isconst, initid,
2198     //             linkage, alignment, section, visibility, threadlocal,
2199     //             unnamed_addr, dllstorageclass]
2200     case bitc::MODULE_CODE_GLOBALVAR: {
2201       if (Record.size() < 6)
2202         return Error("Invalid record");
2203       Type *Ty = getTypeByID(Record[0]);
2204       if (!Ty)
2205         return Error("Invalid record");
2206       if (!Ty->isPointerTy())
2207         return Error("Invalid type for value");
2208       unsigned AddressSpace = cast<PointerType>(Ty)->getAddressSpace();
2209       Ty = cast<PointerType>(Ty)->getElementType();
2210
2211       bool isConstant = Record[1];
2212       uint64_t RawLinkage = Record[3];
2213       GlobalValue::LinkageTypes Linkage = getDecodedLinkage(RawLinkage);
2214       unsigned Alignment = (1 << Record[4]) >> 1;
2215       std::string Section;
2216       if (Record[5]) {
2217         if (Record[5]-1 >= SectionTable.size())
2218           return Error("Invalid ID");
2219         Section = SectionTable[Record[5]-1];
2220       }
2221       GlobalValue::VisibilityTypes Visibility = GlobalValue::DefaultVisibility;
2222       // Local linkage must have default visibility.
2223       if (Record.size() > 6 && !GlobalValue::isLocalLinkage(Linkage))
2224         // FIXME: Change to an error if non-default in 4.0.
2225         Visibility = GetDecodedVisibility(Record[6]);
2226
2227       GlobalVariable::ThreadLocalMode TLM = GlobalVariable::NotThreadLocal;
2228       if (Record.size() > 7)
2229         TLM = GetDecodedThreadLocalMode(Record[7]);
2230
2231       bool UnnamedAddr = false;
2232       if (Record.size() > 8)
2233         UnnamedAddr = Record[8];
2234
2235       bool ExternallyInitialized = false;
2236       if (Record.size() > 9)
2237         ExternallyInitialized = Record[9];
2238
2239       GlobalVariable *NewGV =
2240         new GlobalVariable(*TheModule, Ty, isConstant, Linkage, nullptr, "", nullptr,
2241                            TLM, AddressSpace, ExternallyInitialized);
2242       NewGV->setAlignment(Alignment);
2243       if (!Section.empty())
2244         NewGV->setSection(Section);
2245       NewGV->setVisibility(Visibility);
2246       NewGV->setUnnamedAddr(UnnamedAddr);
2247
2248       if (Record.size() > 10)
2249         NewGV->setDLLStorageClass(GetDecodedDLLStorageClass(Record[10]));
2250       else
2251         UpgradeDLLImportExportLinkage(NewGV, RawLinkage);
2252
2253       ValueList.push_back(NewGV);
2254
2255       // Remember which value to use for the global initializer.
2256       if (unsigned InitID = Record[2])
2257         GlobalInits.push_back(std::make_pair(NewGV, InitID-1));
2258
2259       if (Record.size() > 11) {
2260         if (unsigned ComdatID = Record[11]) {
2261           assert(ComdatID <= ComdatList.size());
2262           NewGV->setComdat(ComdatList[ComdatID - 1]);
2263         }
2264       } else if (hasImplicitComdat(RawLinkage)) {
2265         NewGV->setComdat(reinterpret_cast<Comdat *>(1));
2266       }
2267       break;
2268     }
2269     // FUNCTION:  [type, callingconv, isproto, linkage, paramattr,
2270     //             alignment, section, visibility, gc, unnamed_addr,
2271     //             prologuedata, dllstorageclass, comdat, prefixdata]
2272     case bitc::MODULE_CODE_FUNCTION: {
2273       if (Record.size() < 8)
2274         return Error("Invalid record");
2275       Type *Ty = getTypeByID(Record[0]);
2276       if (!Ty)
2277         return Error("Invalid record");
2278       if (!Ty->isPointerTy())
2279         return Error("Invalid type for value");
2280       FunctionType *FTy =
2281         dyn_cast<FunctionType>(cast<PointerType>(Ty)->getElementType());
2282       if (!FTy)
2283         return Error("Invalid type for value");
2284
2285       Function *Func = Function::Create(FTy, GlobalValue::ExternalLinkage,
2286                                         "", TheModule);
2287
2288       Func->setCallingConv(static_cast<CallingConv::ID>(Record[1]));
2289       bool isProto = Record[2];
2290       uint64_t RawLinkage = Record[3];
2291       Func->setLinkage(getDecodedLinkage(RawLinkage));
2292       Func->setAttributes(getAttributes(Record[4]));
2293
2294       Func->setAlignment((1 << Record[5]) >> 1);
2295       if (Record[6]) {
2296         if (Record[6]-1 >= SectionTable.size())
2297           return Error("Invalid ID");
2298         Func->setSection(SectionTable[Record[6]-1]);
2299       }
2300       // Local linkage must have default visibility.
2301       if (!Func->hasLocalLinkage())
2302         // FIXME: Change to an error if non-default in 4.0.
2303         Func->setVisibility(GetDecodedVisibility(Record[7]));
2304       if (Record.size() > 8 && Record[8]) {
2305         if (Record[8]-1 > GCTable.size())
2306           return Error("Invalid ID");
2307         Func->setGC(GCTable[Record[8]-1].c_str());
2308       }
2309       bool UnnamedAddr = false;
2310       if (Record.size() > 9)
2311         UnnamedAddr = Record[9];
2312       Func->setUnnamedAddr(UnnamedAddr);
2313       if (Record.size() > 10 && Record[10] != 0)
2314         FunctionPrologues.push_back(std::make_pair(Func, Record[10]-1));
2315
2316       if (Record.size() > 11)
2317         Func->setDLLStorageClass(GetDecodedDLLStorageClass(Record[11]));
2318       else
2319         UpgradeDLLImportExportLinkage(Func, RawLinkage);
2320
2321       if (Record.size() > 12) {
2322         if (unsigned ComdatID = Record[12]) {
2323           assert(ComdatID <= ComdatList.size());
2324           Func->setComdat(ComdatList[ComdatID - 1]);
2325         }
2326       } else if (hasImplicitComdat(RawLinkage)) {
2327         Func->setComdat(reinterpret_cast<Comdat *>(1));
2328       }
2329
2330       if (Record.size() > 13 && Record[13] != 0)
2331         FunctionPrefixes.push_back(std::make_pair(Func, Record[13]-1));
2332
2333       ValueList.push_back(Func);
2334
2335       // If this is a function with a body, remember the prototype we are
2336       // creating now, so that we can match up the body with them later.
2337       if (!isProto) {
2338         Func->setIsMaterializable(true);
2339         FunctionsWithBodies.push_back(Func);
2340         if (LazyStreamer)
2341           DeferredFunctionInfo[Func] = 0;
2342       }
2343       break;
2344     }
2345     // ALIAS: [alias type, aliasee val#, linkage]
2346     // ALIAS: [alias type, aliasee val#, linkage, visibility, dllstorageclass]
2347     case bitc::MODULE_CODE_ALIAS: {
2348       if (Record.size() < 3)
2349         return Error("Invalid record");
2350       Type *Ty = getTypeByID(Record[0]);
2351       if (!Ty)
2352         return Error("Invalid record");
2353       auto *PTy = dyn_cast<PointerType>(Ty);
2354       if (!PTy)
2355         return Error("Invalid type for value");
2356
2357       auto *NewGA =
2358           GlobalAlias::create(PTy->getElementType(), PTy->getAddressSpace(),
2359                               getDecodedLinkage(Record[2]), "", TheModule);
2360       // Old bitcode files didn't have visibility field.
2361       // Local linkage must have default visibility.
2362       if (Record.size() > 3 && !NewGA->hasLocalLinkage())
2363         // FIXME: Change to an error if non-default in 4.0.
2364         NewGA->setVisibility(GetDecodedVisibility(Record[3]));
2365       if (Record.size() > 4)
2366         NewGA->setDLLStorageClass(GetDecodedDLLStorageClass(Record[4]));
2367       else
2368         UpgradeDLLImportExportLinkage(NewGA, Record[2]);
2369       if (Record.size() > 5)
2370         NewGA->setThreadLocalMode(GetDecodedThreadLocalMode(Record[5]));
2371       if (Record.size() > 6)
2372         NewGA->setUnnamedAddr(Record[6]);
2373       ValueList.push_back(NewGA);
2374       AliasInits.push_back(std::make_pair(NewGA, Record[1]));
2375       break;
2376     }
2377     /// MODULE_CODE_PURGEVALS: [numvals]
2378     case bitc::MODULE_CODE_PURGEVALS:
2379       // Trim down the value list to the specified size.
2380       if (Record.size() < 1 || Record[0] > ValueList.size())
2381         return Error("Invalid record");
2382       ValueList.shrinkTo(Record[0]);
2383       break;
2384     }
2385     Record.clear();
2386   }
2387 }
2388
2389 std::error_code BitcodeReader::ParseBitcodeInto(Module *M) {
2390   TheModule = nullptr;
2391
2392   if (std::error_code EC = InitStream())
2393     return EC;
2394
2395   // Sniff for the signature.
2396   if (Stream.Read(8) != 'B' ||
2397       Stream.Read(8) != 'C' ||
2398       Stream.Read(4) != 0x0 ||
2399       Stream.Read(4) != 0xC ||
2400       Stream.Read(4) != 0xE ||
2401       Stream.Read(4) != 0xD)
2402     return Error("Invalid bitcode signature");
2403
2404   // We expect a number of well-defined blocks, though we don't necessarily
2405   // need to understand them all.
2406   while (1) {
2407     if (Stream.AtEndOfStream())
2408       return std::error_code();
2409
2410     BitstreamEntry Entry =
2411       Stream.advance(BitstreamCursor::AF_DontAutoprocessAbbrevs);
2412
2413     switch (Entry.Kind) {
2414     case BitstreamEntry::Error:
2415       return Error("Malformed block");
2416     case BitstreamEntry::EndBlock:
2417       return std::error_code();
2418
2419     case BitstreamEntry::SubBlock:
2420       switch (Entry.ID) {
2421       case bitc::BLOCKINFO_BLOCK_ID:
2422         if (Stream.ReadBlockInfoBlock())
2423           return Error("Malformed block");
2424         break;
2425       case bitc::MODULE_BLOCK_ID:
2426         // Reject multiple MODULE_BLOCK's in a single bitstream.
2427         if (TheModule)
2428           return Error("Invalid multiple blocks");
2429         TheModule = M;
2430         if (std::error_code EC = ParseModule(false))
2431           return EC;
2432         if (LazyStreamer)
2433           return std::error_code();
2434         break;
2435       default:
2436         if (Stream.SkipBlock())
2437           return Error("Invalid record");
2438         break;
2439       }
2440       continue;
2441     case BitstreamEntry::Record:
2442       // There should be no records in the top-level of blocks.
2443
2444       // The ranlib in Xcode 4 will align archive members by appending newlines
2445       // to the end of them. If this file size is a multiple of 4 but not 8, we
2446       // have to read and ignore these final 4 bytes :-(
2447       if (Stream.getAbbrevIDWidth() == 2 && Entry.ID == 2 &&
2448           Stream.Read(6) == 2 && Stream.Read(24) == 0xa0a0a &&
2449           Stream.AtEndOfStream())
2450         return std::error_code();
2451
2452       return Error("Invalid record");
2453     }
2454   }
2455 }
2456
2457 ErrorOr<std::string> BitcodeReader::parseModuleTriple() {
2458   if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
2459     return Error("Invalid record");
2460
2461   SmallVector<uint64_t, 64> Record;
2462
2463   std::string Triple;
2464   // Read all the records for this module.
2465   while (1) {
2466     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
2467
2468     switch (Entry.Kind) {
2469     case BitstreamEntry::SubBlock: // Handled for us already.
2470     case BitstreamEntry::Error:
2471       return Error("Malformed block");
2472     case BitstreamEntry::EndBlock:
2473       return Triple;
2474     case BitstreamEntry::Record:
2475       // The interesting case.
2476       break;
2477     }
2478
2479     // Read a record.
2480     switch (Stream.readRecord(Entry.ID, Record)) {
2481     default: break;  // Default behavior, ignore unknown content.
2482     case bitc::MODULE_CODE_TRIPLE: {  // TRIPLE: [strchr x N]
2483       std::string S;
2484       if (ConvertToString(Record, 0, S))
2485         return Error("Invalid record");
2486       Triple = S;
2487       break;
2488     }
2489     }
2490     Record.clear();
2491   }
2492   llvm_unreachable("Exit infinite loop");
2493 }
2494
2495 ErrorOr<std::string> BitcodeReader::parseTriple() {
2496   if (std::error_code EC = InitStream())
2497     return EC;
2498
2499   // Sniff for the signature.
2500   if (Stream.Read(8) != 'B' ||
2501       Stream.Read(8) != 'C' ||
2502       Stream.Read(4) != 0x0 ||
2503       Stream.Read(4) != 0xC ||
2504       Stream.Read(4) != 0xE ||
2505       Stream.Read(4) != 0xD)
2506     return Error("Invalid bitcode signature");
2507
2508   // We expect a number of well-defined blocks, though we don't necessarily
2509   // need to understand them all.
2510   while (1) {
2511     BitstreamEntry Entry = Stream.advance();
2512
2513     switch (Entry.Kind) {
2514     case BitstreamEntry::Error:
2515       return Error("Malformed block");
2516     case BitstreamEntry::EndBlock:
2517       return std::error_code();
2518
2519     case BitstreamEntry::SubBlock:
2520       if (Entry.ID == bitc::MODULE_BLOCK_ID)
2521         return parseModuleTriple();
2522
2523       // Ignore other sub-blocks.
2524       if (Stream.SkipBlock())
2525         return Error("Malformed block");
2526       continue;
2527
2528     case BitstreamEntry::Record:
2529       Stream.skipRecord(Entry.ID);
2530       continue;
2531     }
2532   }
2533 }
2534
2535 /// ParseMetadataAttachment - Parse metadata attachments.
2536 std::error_code BitcodeReader::ParseMetadataAttachment() {
2537   if (Stream.EnterSubBlock(bitc::METADATA_ATTACHMENT_ID))
2538     return Error("Invalid record");
2539
2540   SmallVector<uint64_t, 64> Record;
2541   while (1) {
2542     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
2543
2544     switch (Entry.Kind) {
2545     case BitstreamEntry::SubBlock: // Handled for us already.
2546     case BitstreamEntry::Error:
2547       return Error("Malformed block");
2548     case BitstreamEntry::EndBlock:
2549       return std::error_code();
2550     case BitstreamEntry::Record:
2551       // The interesting case.
2552       break;
2553     }
2554
2555     // Read a metadata attachment record.
2556     Record.clear();
2557     switch (Stream.readRecord(Entry.ID, Record)) {
2558     default:  // Default behavior: ignore.
2559       break;
2560     case bitc::METADATA_ATTACHMENT: {
2561       unsigned RecordLength = Record.size();
2562       if (Record.empty() || (RecordLength - 1) % 2 == 1)
2563         return Error("Invalid record");
2564       Instruction *Inst = InstructionList[Record[0]];
2565       for (unsigned i = 1; i != RecordLength; i = i+2) {
2566         unsigned Kind = Record[i];
2567         DenseMap<unsigned, unsigned>::iterator I =
2568           MDKindMap.find(Kind);
2569         if (I == MDKindMap.end())
2570           return Error("Invalid ID");
2571         Metadata *Node = MDValueList.getValueFwdRef(Record[i + 1]);
2572         if (isa<LocalAsMetadata>(Node))
2573           // Drop the attachment.  This used to be legal, but there's no
2574           // upgrade path.
2575           break;
2576         Inst->setMetadata(I->second, cast<MDNode>(Node));
2577         if (I->second == LLVMContext::MD_tbaa)
2578           InstsWithTBAATag.push_back(Inst);
2579       }
2580       break;
2581     }
2582     }
2583   }
2584 }
2585
2586 /// ParseFunctionBody - Lazily parse the specified function body block.
2587 std::error_code BitcodeReader::ParseFunctionBody(Function *F) {
2588   if (Stream.EnterSubBlock(bitc::FUNCTION_BLOCK_ID))
2589     return Error("Invalid record");
2590
2591   InstructionList.clear();
2592   unsigned ModuleValueListSize = ValueList.size();
2593   unsigned ModuleMDValueListSize = MDValueList.size();
2594
2595   // Add all the function arguments to the value table.
2596   for(Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
2597     ValueList.push_back(I);
2598
2599   unsigned NextValueNo = ValueList.size();
2600   BasicBlock *CurBB = nullptr;
2601   unsigned CurBBNo = 0;
2602
2603   DebugLoc LastLoc;
2604   auto getLastInstruction = [&]() -> Instruction * {
2605     if (CurBB && !CurBB->empty())
2606       return &CurBB->back();
2607     else if (CurBBNo && FunctionBBs[CurBBNo - 1] &&
2608              !FunctionBBs[CurBBNo - 1]->empty())
2609       return &FunctionBBs[CurBBNo - 1]->back();
2610     return nullptr;
2611   };
2612
2613   // Read all the records.
2614   SmallVector<uint64_t, 64> Record;
2615   while (1) {
2616     BitstreamEntry Entry = Stream.advance();
2617
2618     switch (Entry.Kind) {
2619     case BitstreamEntry::Error:
2620       return Error("Malformed block");
2621     case BitstreamEntry::EndBlock:
2622       goto OutOfRecordLoop;
2623
2624     case BitstreamEntry::SubBlock:
2625       switch (Entry.ID) {
2626       default:  // Skip unknown content.
2627         if (Stream.SkipBlock())
2628           return Error("Invalid record");
2629         break;
2630       case bitc::CONSTANTS_BLOCK_ID:
2631         if (std::error_code EC = ParseConstants())
2632           return EC;
2633         NextValueNo = ValueList.size();
2634         break;
2635       case bitc::VALUE_SYMTAB_BLOCK_ID:
2636         if (std::error_code EC = ParseValueSymbolTable())
2637           return EC;
2638         break;
2639       case bitc::METADATA_ATTACHMENT_ID:
2640         if (std::error_code EC = ParseMetadataAttachment())
2641           return EC;
2642         break;
2643       case bitc::METADATA_BLOCK_ID:
2644         if (std::error_code EC = ParseMetadata())
2645           return EC;
2646         break;
2647       case bitc::USELIST_BLOCK_ID:
2648         if (std::error_code EC = ParseUseLists())
2649           return EC;
2650         break;
2651       }
2652       continue;
2653
2654     case BitstreamEntry::Record:
2655       // The interesting case.
2656       break;
2657     }
2658
2659     // Read a record.
2660     Record.clear();
2661     Instruction *I = nullptr;
2662     unsigned BitCode = Stream.readRecord(Entry.ID, Record);
2663     switch (BitCode) {
2664     default: // Default behavior: reject
2665       return Error("Invalid value");
2666     case bitc::FUNC_CODE_DECLAREBLOCKS: {   // DECLAREBLOCKS: [nblocks]
2667       if (Record.size() < 1 || Record[0] == 0)
2668         return Error("Invalid record");
2669       // Create all the basic blocks for the function.
2670       FunctionBBs.resize(Record[0]);
2671
2672       // See if anything took the address of blocks in this function.
2673       auto BBFRI = BasicBlockFwdRefs.find(F);
2674       if (BBFRI == BasicBlockFwdRefs.end()) {
2675         for (unsigned i = 0, e = FunctionBBs.size(); i != e; ++i)
2676           FunctionBBs[i] = BasicBlock::Create(Context, "", F);
2677       } else {
2678         auto &BBRefs = BBFRI->second;
2679         // Check for invalid basic block references.
2680         if (BBRefs.size() > FunctionBBs.size())
2681           return Error("Invalid ID");
2682         assert(!BBRefs.empty() && "Unexpected empty array");
2683         assert(!BBRefs.front() && "Invalid reference to entry block");
2684         for (unsigned I = 0, E = FunctionBBs.size(), RE = BBRefs.size(); I != E;
2685              ++I)
2686           if (I < RE && BBRefs[I]) {
2687             BBRefs[I]->insertInto(F);
2688             FunctionBBs[I] = BBRefs[I];
2689           } else {
2690             FunctionBBs[I] = BasicBlock::Create(Context, "", F);
2691           }
2692
2693         // Erase from the table.
2694         BasicBlockFwdRefs.erase(BBFRI);
2695       }
2696
2697       CurBB = FunctionBBs[0];
2698       continue;
2699     }
2700
2701     case bitc::FUNC_CODE_DEBUG_LOC_AGAIN:  // DEBUG_LOC_AGAIN
2702       // This record indicates that the last instruction is at the same
2703       // location as the previous instruction with a location.
2704       I = getLastInstruction();
2705
2706       if (!I)
2707         return Error("Invalid record");
2708       I->setDebugLoc(LastLoc);
2709       I = nullptr;
2710       continue;
2711
2712     case bitc::FUNC_CODE_DEBUG_LOC: {      // DEBUG_LOC: [line, col, scope, ia]
2713       I = getLastInstruction();
2714       if (!I || Record.size() < 4)
2715         return Error("Invalid record");
2716
2717       unsigned Line = Record[0], Col = Record[1];
2718       unsigned ScopeID = Record[2], IAID = Record[3];
2719
2720       MDNode *Scope = nullptr, *IA = nullptr;
2721       if (ScopeID) Scope = cast<MDNode>(MDValueList.getValueFwdRef(ScopeID-1));
2722       if (IAID)    IA = cast<MDNode>(MDValueList.getValueFwdRef(IAID-1));
2723       LastLoc = DebugLoc::get(Line, Col, Scope, IA);
2724       I->setDebugLoc(LastLoc);
2725       I = nullptr;
2726       continue;
2727     }
2728
2729     case bitc::FUNC_CODE_INST_BINOP: {    // BINOP: [opval, ty, opval, opcode]
2730       unsigned OpNum = 0;
2731       Value *LHS, *RHS;
2732       if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
2733           popValue(Record, OpNum, NextValueNo, LHS->getType(), RHS) ||
2734           OpNum+1 > Record.size())
2735         return Error("Invalid record");
2736
2737       int Opc = GetDecodedBinaryOpcode(Record[OpNum++], LHS->getType());
2738       if (Opc == -1)
2739         return Error("Invalid record");
2740       I = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);
2741       InstructionList.push_back(I);
2742       if (OpNum < Record.size()) {
2743         if (Opc == Instruction::Add ||
2744             Opc == Instruction::Sub ||
2745             Opc == Instruction::Mul ||
2746             Opc == Instruction::Shl) {
2747           if (Record[OpNum] & (1 << bitc::OBO_NO_SIGNED_WRAP))
2748             cast<BinaryOperator>(I)->setHasNoSignedWrap(true);
2749           if (Record[OpNum] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
2750             cast<BinaryOperator>(I)->setHasNoUnsignedWrap(true);
2751         } else if (Opc == Instruction::SDiv ||
2752                    Opc == Instruction::UDiv ||
2753                    Opc == Instruction::LShr ||
2754                    Opc == Instruction::AShr) {
2755           if (Record[OpNum] & (1 << bitc::PEO_EXACT))
2756             cast<BinaryOperator>(I)->setIsExact(true);
2757         } else if (isa<FPMathOperator>(I)) {
2758           FastMathFlags FMF;
2759           if (0 != (Record[OpNum] & FastMathFlags::UnsafeAlgebra))
2760             FMF.setUnsafeAlgebra();
2761           if (0 != (Record[OpNum] & FastMathFlags::NoNaNs))
2762             FMF.setNoNaNs();
2763           if (0 != (Record[OpNum] & FastMathFlags::NoInfs))
2764             FMF.setNoInfs();
2765           if (0 != (Record[OpNum] & FastMathFlags::NoSignedZeros))
2766             FMF.setNoSignedZeros();
2767           if (0 != (Record[OpNum] & FastMathFlags::AllowReciprocal))
2768             FMF.setAllowReciprocal();
2769           if (FMF.any())
2770             I->setFastMathFlags(FMF);
2771         }
2772
2773       }
2774       break;
2775     }
2776     case bitc::FUNC_CODE_INST_CAST: {    // CAST: [opval, opty, destty, castopc]
2777       unsigned OpNum = 0;
2778       Value *Op;
2779       if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
2780           OpNum+2 != Record.size())
2781         return Error("Invalid record");
2782
2783       Type *ResTy = getTypeByID(Record[OpNum]);
2784       int Opc = GetDecodedCastOpcode(Record[OpNum+1]);
2785       if (Opc == -1 || !ResTy)
2786         return Error("Invalid record");
2787       Instruction *Temp = nullptr;
2788       if ((I = UpgradeBitCastInst(Opc, Op, ResTy, Temp))) {
2789         if (Temp) {
2790           InstructionList.push_back(Temp);
2791           CurBB->getInstList().push_back(Temp);
2792         }
2793       } else {
2794         I = CastInst::Create((Instruction::CastOps)Opc, Op, ResTy);
2795       }
2796       InstructionList.push_back(I);
2797       break;
2798     }
2799     case bitc::FUNC_CODE_INST_INBOUNDS_GEP:
2800     case bitc::FUNC_CODE_INST_GEP: { // GEP: [n x operands]
2801       unsigned OpNum = 0;
2802       Value *BasePtr;
2803       if (getValueTypePair(Record, OpNum, NextValueNo, BasePtr))
2804         return Error("Invalid record");
2805
2806       SmallVector<Value*, 16> GEPIdx;
2807       while (OpNum != Record.size()) {
2808         Value *Op;
2809         if (getValueTypePair(Record, OpNum, NextValueNo, Op))
2810           return Error("Invalid record");
2811         GEPIdx.push_back(Op);
2812       }
2813
2814       I = GetElementPtrInst::Create(BasePtr, GEPIdx);
2815       InstructionList.push_back(I);
2816       if (BitCode == bitc::FUNC_CODE_INST_INBOUNDS_GEP)
2817         cast<GetElementPtrInst>(I)->setIsInBounds(true);
2818       break;
2819     }
2820
2821     case bitc::FUNC_CODE_INST_EXTRACTVAL: {
2822                                        // EXTRACTVAL: [opty, opval, n x indices]
2823       unsigned OpNum = 0;
2824       Value *Agg;
2825       if (getValueTypePair(Record, OpNum, NextValueNo, Agg))
2826         return Error("Invalid record");
2827
2828       SmallVector<unsigned, 4> EXTRACTVALIdx;
2829       for (unsigned RecSize = Record.size();
2830            OpNum != RecSize; ++OpNum) {
2831         uint64_t Index = Record[OpNum];
2832         if ((unsigned)Index != Index)
2833           return Error("Invalid value");
2834         EXTRACTVALIdx.push_back((unsigned)Index);
2835       }
2836
2837       I = ExtractValueInst::Create(Agg, EXTRACTVALIdx);
2838       InstructionList.push_back(I);
2839       break;
2840     }
2841
2842     case bitc::FUNC_CODE_INST_INSERTVAL: {
2843                            // INSERTVAL: [opty, opval, opty, opval, n x indices]
2844       unsigned OpNum = 0;
2845       Value *Agg;
2846       if (getValueTypePair(Record, OpNum, NextValueNo, Agg))
2847         return Error("Invalid record");
2848       Value *Val;
2849       if (getValueTypePair(Record, OpNum, NextValueNo, Val))
2850         return Error("Invalid record");
2851
2852       SmallVector<unsigned, 4> INSERTVALIdx;
2853       for (unsigned RecSize = Record.size();
2854            OpNum != RecSize; ++OpNum) {
2855         uint64_t Index = Record[OpNum];
2856         if ((unsigned)Index != Index)
2857           return Error("Invalid value");
2858         INSERTVALIdx.push_back((unsigned)Index);
2859       }
2860
2861       I = InsertValueInst::Create(Agg, Val, INSERTVALIdx);
2862       InstructionList.push_back(I);
2863       break;
2864     }
2865
2866     case bitc::FUNC_CODE_INST_SELECT: { // SELECT: [opval, ty, opval, opval]
2867       // obsolete form of select
2868       // handles select i1 ... in old bitcode
2869       unsigned OpNum = 0;
2870       Value *TrueVal, *FalseVal, *Cond;
2871       if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
2872           popValue(Record, OpNum, NextValueNo, TrueVal->getType(), FalseVal) ||
2873           popValue(Record, OpNum, NextValueNo, Type::getInt1Ty(Context), Cond))
2874         return Error("Invalid record");
2875
2876       I = SelectInst::Create(Cond, TrueVal, FalseVal);
2877       InstructionList.push_back(I);
2878       break;
2879     }
2880
2881     case bitc::FUNC_CODE_INST_VSELECT: {// VSELECT: [ty,opval,opval,predty,pred]
2882       // new form of select
2883       // handles select i1 or select [N x i1]
2884       unsigned OpNum = 0;
2885       Value *TrueVal, *FalseVal, *Cond;
2886       if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
2887           popValue(Record, OpNum, NextValueNo, TrueVal->getType(), FalseVal) ||
2888           getValueTypePair(Record, OpNum, NextValueNo, Cond))
2889         return Error("Invalid record");
2890
2891       // select condition can be either i1 or [N x i1]
2892       if (VectorType* vector_type =
2893           dyn_cast<VectorType>(Cond->getType())) {
2894         // expect <n x i1>
2895         if (vector_type->getElementType() != Type::getInt1Ty(Context))
2896           return Error("Invalid type for value");
2897       } else {
2898         // expect i1
2899         if (Cond->getType() != Type::getInt1Ty(Context))
2900           return Error("Invalid type for value");
2901       }
2902
2903       I = SelectInst::Create(Cond, TrueVal, FalseVal);
2904       InstructionList.push_back(I);
2905       break;
2906     }
2907
2908     case bitc::FUNC_CODE_INST_EXTRACTELT: { // EXTRACTELT: [opty, opval, opval]
2909       unsigned OpNum = 0;
2910       Value *Vec, *Idx;
2911       if (getValueTypePair(Record, OpNum, NextValueNo, Vec) ||
2912           getValueTypePair(Record, OpNum, NextValueNo, Idx))
2913         return Error("Invalid record");
2914       I = ExtractElementInst::Create(Vec, Idx);
2915       InstructionList.push_back(I);
2916       break;
2917     }
2918
2919     case bitc::FUNC_CODE_INST_INSERTELT: { // INSERTELT: [ty, opval,opval,opval]
2920       unsigned OpNum = 0;
2921       Value *Vec, *Elt, *Idx;
2922       if (getValueTypePair(Record, OpNum, NextValueNo, Vec) ||
2923           popValue(Record, OpNum, NextValueNo,
2924                    cast<VectorType>(Vec->getType())->getElementType(), Elt) ||
2925           getValueTypePair(Record, OpNum, NextValueNo, Idx))
2926         return Error("Invalid record");
2927       I = InsertElementInst::Create(Vec, Elt, Idx);
2928       InstructionList.push_back(I);
2929       break;
2930     }
2931
2932     case bitc::FUNC_CODE_INST_SHUFFLEVEC: {// SHUFFLEVEC: [opval,ty,opval,opval]
2933       unsigned OpNum = 0;
2934       Value *Vec1, *Vec2, *Mask;
2935       if (getValueTypePair(Record, OpNum, NextValueNo, Vec1) ||
2936           popValue(Record, OpNum, NextValueNo, Vec1->getType(), Vec2))
2937         return Error("Invalid record");
2938
2939       if (getValueTypePair(Record, OpNum, NextValueNo, Mask))
2940         return Error("Invalid record");
2941       I = new ShuffleVectorInst(Vec1, Vec2, Mask);
2942       InstructionList.push_back(I);
2943       break;
2944     }
2945
2946     case bitc::FUNC_CODE_INST_CMP:   // CMP: [opty, opval, opval, pred]
2947       // Old form of ICmp/FCmp returning bool
2948       // Existed to differentiate between icmp/fcmp and vicmp/vfcmp which were
2949       // both legal on vectors but had different behaviour.
2950     case bitc::FUNC_CODE_INST_CMP2: { // CMP2: [opty, opval, opval, pred]
2951       // FCmp/ICmp returning bool or vector of bool
2952
2953       unsigned OpNum = 0;
2954       Value *LHS, *RHS;
2955       if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
2956           popValue(Record, OpNum, NextValueNo, LHS->getType(), RHS) ||
2957           OpNum+1 != Record.size())
2958         return Error("Invalid record");
2959
2960       if (LHS->getType()->isFPOrFPVectorTy())
2961         I = new FCmpInst((FCmpInst::Predicate)Record[OpNum], LHS, RHS);
2962       else
2963         I = new ICmpInst((ICmpInst::Predicate)Record[OpNum], LHS, RHS);
2964       InstructionList.push_back(I);
2965       break;
2966     }
2967
2968     case bitc::FUNC_CODE_INST_RET: // RET: [opty,opval<optional>]
2969       {
2970         unsigned Size = Record.size();
2971         if (Size == 0) {
2972           I = ReturnInst::Create(Context);
2973           InstructionList.push_back(I);
2974           break;
2975         }
2976
2977         unsigned OpNum = 0;
2978         Value *Op = nullptr;
2979         if (getValueTypePair(Record, OpNum, NextValueNo, Op))
2980           return Error("Invalid record");
2981         if (OpNum != Record.size())
2982           return Error("Invalid record");
2983
2984         I = ReturnInst::Create(Context, Op);
2985         InstructionList.push_back(I);
2986         break;
2987       }
2988     case bitc::FUNC_CODE_INST_BR: { // BR: [bb#, bb#, opval] or [bb#]
2989       if (Record.size() != 1 && Record.size() != 3)
2990         return Error("Invalid record");
2991       BasicBlock *TrueDest = getBasicBlock(Record[0]);
2992       if (!TrueDest)
2993         return Error("Invalid record");
2994
2995       if (Record.size() == 1) {
2996         I = BranchInst::Create(TrueDest);
2997         InstructionList.push_back(I);
2998       }
2999       else {
3000         BasicBlock *FalseDest = getBasicBlock(Record[1]);
3001         Value *Cond = getValue(Record, 2, NextValueNo,
3002                                Type::getInt1Ty(Context));
3003         if (!FalseDest || !Cond)
3004           return Error("Invalid record");
3005         I = BranchInst::Create(TrueDest, FalseDest, Cond);
3006         InstructionList.push_back(I);
3007       }
3008       break;
3009     }
3010     case bitc::FUNC_CODE_INST_SWITCH: { // SWITCH: [opty, op0, op1, ...]
3011       // Check magic
3012       if ((Record[0] >> 16) == SWITCH_INST_MAGIC) {
3013         // "New" SwitchInst format with case ranges. The changes to write this
3014         // format were reverted but we still recognize bitcode that uses it.
3015         // Hopefully someday we will have support for case ranges and can use
3016         // this format again.
3017
3018         Type *OpTy = getTypeByID(Record[1]);
3019         unsigned ValueBitWidth = cast<IntegerType>(OpTy)->getBitWidth();
3020
3021         Value *Cond = getValue(Record, 2, NextValueNo, OpTy);
3022         BasicBlock *Default = getBasicBlock(Record[3]);
3023         if (!OpTy || !Cond || !Default)
3024           return Error("Invalid record");
3025
3026         unsigned NumCases = Record[4];
3027
3028         SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);
3029         InstructionList.push_back(SI);
3030
3031         unsigned CurIdx = 5;
3032         for (unsigned i = 0; i != NumCases; ++i) {
3033           SmallVector<ConstantInt*, 1> CaseVals;
3034           unsigned NumItems = Record[CurIdx++];
3035           for (unsigned ci = 0; ci != NumItems; ++ci) {
3036             bool isSingleNumber = Record[CurIdx++];
3037
3038             APInt Low;
3039             unsigned ActiveWords = 1;
3040             if (ValueBitWidth > 64)
3041               ActiveWords = Record[CurIdx++];
3042             Low = ReadWideAPInt(makeArrayRef(&Record[CurIdx], ActiveWords),
3043                                 ValueBitWidth);
3044             CurIdx += ActiveWords;
3045
3046             if (!isSingleNumber) {
3047               ActiveWords = 1;
3048               if (ValueBitWidth > 64)
3049                 ActiveWords = Record[CurIdx++];
3050               APInt High =
3051                   ReadWideAPInt(makeArrayRef(&Record[CurIdx], ActiveWords),
3052                                 ValueBitWidth);
3053               CurIdx += ActiveWords;
3054
3055               // FIXME: It is not clear whether values in the range should be
3056               // compared as signed or unsigned values. The partially
3057               // implemented changes that used this format in the past used
3058               // unsigned comparisons.
3059               for ( ; Low.ule(High); ++Low)
3060                 CaseVals.push_back(ConstantInt::get(Context, Low));
3061             } else
3062               CaseVals.push_back(ConstantInt::get(Context, Low));
3063           }
3064           BasicBlock *DestBB = getBasicBlock(Record[CurIdx++]);
3065           for (SmallVector<ConstantInt*, 1>::iterator cvi = CaseVals.begin(),
3066                  cve = CaseVals.end(); cvi != cve; ++cvi)
3067             SI->addCase(*cvi, DestBB);
3068         }
3069         I = SI;
3070         break;
3071       }
3072
3073       // Old SwitchInst format without case ranges.
3074
3075       if (Record.size() < 3 || (Record.size() & 1) == 0)
3076         return Error("Invalid record");
3077       Type *OpTy = getTypeByID(Record[0]);
3078       Value *Cond = getValue(Record, 1, NextValueNo, OpTy);
3079       BasicBlock *Default = getBasicBlock(Record[2]);
3080       if (!OpTy || !Cond || !Default)
3081         return Error("Invalid record");
3082       unsigned NumCases = (Record.size()-3)/2;
3083       SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);
3084       InstructionList.push_back(SI);
3085       for (unsigned i = 0, e = NumCases; i != e; ++i) {
3086         ConstantInt *CaseVal =
3087           dyn_cast_or_null<ConstantInt>(getFnValueByID(Record[3+i*2], OpTy));
3088         BasicBlock *DestBB = getBasicBlock(Record[1+3+i*2]);
3089         if (!CaseVal || !DestBB) {
3090           delete SI;
3091           return Error("Invalid record");
3092         }
3093         SI->addCase(CaseVal, DestBB);
3094       }
3095       I = SI;
3096       break;
3097     }
3098     case bitc::FUNC_CODE_INST_INDIRECTBR: { // INDIRECTBR: [opty, op0, op1, ...]
3099       if (Record.size() < 2)
3100         return Error("Invalid record");
3101       Type *OpTy = getTypeByID(Record[0]);
3102       Value *Address = getValue(Record, 1, NextValueNo, OpTy);
3103       if (!OpTy || !Address)
3104         return Error("Invalid record");
3105       unsigned NumDests = Record.size()-2;
3106       IndirectBrInst *IBI = IndirectBrInst::Create(Address, NumDests);
3107       InstructionList.push_back(IBI);
3108       for (unsigned i = 0, e = NumDests; i != e; ++i) {
3109         if (BasicBlock *DestBB = getBasicBlock(Record[2+i])) {
3110           IBI->addDestination(DestBB);
3111         } else {
3112           delete IBI;
3113           return Error("Invalid record");
3114         }
3115       }
3116       I = IBI;
3117       break;
3118     }
3119
3120     case bitc::FUNC_CODE_INST_INVOKE: {
3121       // INVOKE: [attrs, cc, normBB, unwindBB, fnty, op0,op1,op2, ...]
3122       if (Record.size() < 4)
3123         return Error("Invalid record");
3124       AttributeSet PAL = getAttributes(Record[0]);
3125       unsigned CCInfo = Record[1];
3126       BasicBlock *NormalBB = getBasicBlock(Record[2]);
3127       BasicBlock *UnwindBB = getBasicBlock(Record[3]);
3128
3129       unsigned OpNum = 4;
3130       Value *Callee;
3131       if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
3132         return Error("Invalid record");
3133
3134       PointerType *CalleeTy = dyn_cast<PointerType>(Callee->getType());
3135       FunctionType *FTy = !CalleeTy ? nullptr :
3136         dyn_cast<FunctionType>(CalleeTy->getElementType());
3137
3138       // Check that the right number of fixed parameters are here.
3139       if (!FTy || !NormalBB || !UnwindBB ||
3140           Record.size() < OpNum+FTy->getNumParams())
3141         return Error("Invalid record");
3142
3143       SmallVector<Value*, 16> Ops;
3144       for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
3145         Ops.push_back(getValue(Record, OpNum, NextValueNo,
3146                                FTy->getParamType(i)));
3147         if (!Ops.back())
3148           return Error("Invalid record");
3149       }
3150
3151       if (!FTy->isVarArg()) {
3152         if (Record.size() != OpNum)
3153           return Error("Invalid record");
3154       } else {
3155         // Read type/value pairs for varargs params.
3156         while (OpNum != Record.size()) {
3157           Value *Op;
3158           if (getValueTypePair(Record, OpNum, NextValueNo, Op))
3159             return Error("Invalid record");
3160           Ops.push_back(Op);
3161         }
3162       }
3163
3164       I = InvokeInst::Create(Callee, NormalBB, UnwindBB, Ops);
3165       InstructionList.push_back(I);
3166       cast<InvokeInst>(I)->setCallingConv(
3167         static_cast<CallingConv::ID>(CCInfo));
3168       cast<InvokeInst>(I)->setAttributes(PAL);
3169       break;
3170     }
3171     case bitc::FUNC_CODE_INST_RESUME: { // RESUME: [opval]
3172       unsigned Idx = 0;
3173       Value *Val = nullptr;
3174       if (getValueTypePair(Record, Idx, NextValueNo, Val))
3175         return Error("Invalid record");
3176       I = ResumeInst::Create(Val);
3177       InstructionList.push_back(I);
3178       break;
3179     }
3180     case bitc::FUNC_CODE_INST_UNREACHABLE: // UNREACHABLE
3181       I = new UnreachableInst(Context);
3182       InstructionList.push_back(I);
3183       break;
3184     case bitc::FUNC_CODE_INST_PHI: { // PHI: [ty, val0,bb0, ...]
3185       if (Record.size() < 1 || ((Record.size()-1)&1))
3186         return Error("Invalid record");
3187       Type *Ty = getTypeByID(Record[0]);
3188       if (!Ty)
3189         return Error("Invalid record");
3190
3191       PHINode *PN = PHINode::Create(Ty, (Record.size()-1)/2);
3192       InstructionList.push_back(PN);
3193
3194       for (unsigned i = 0, e = Record.size()-1; i != e; i += 2) {
3195         Value *V;
3196         // With the new function encoding, it is possible that operands have
3197         // negative IDs (for forward references).  Use a signed VBR
3198         // representation to keep the encoding small.
3199         if (UseRelativeIDs)
3200           V = getValueSigned(Record, 1+i, NextValueNo, Ty);
3201         else
3202           V = getValue(Record, 1+i, NextValueNo, Ty);
3203         BasicBlock *BB = getBasicBlock(Record[2+i]);
3204         if (!V || !BB)
3205           return Error("Invalid record");
3206         PN->addIncoming(V, BB);
3207       }
3208       I = PN;
3209       break;
3210     }
3211
3212     case bitc::FUNC_CODE_INST_LANDINGPAD: {
3213       // LANDINGPAD: [ty, val, val, num, (id0,val0 ...)?]
3214       unsigned Idx = 0;
3215       if (Record.size() < 4)
3216         return Error("Invalid record");
3217       Type *Ty = getTypeByID(Record[Idx++]);
3218       if (!Ty)
3219         return Error("Invalid record");
3220       Value *PersFn = nullptr;
3221       if (getValueTypePair(Record, Idx, NextValueNo, PersFn))
3222         return Error("Invalid record");
3223
3224       bool IsCleanup = !!Record[Idx++];
3225       unsigned NumClauses = Record[Idx++];
3226       LandingPadInst *LP = LandingPadInst::Create(Ty, PersFn, NumClauses);
3227       LP->setCleanup(IsCleanup);
3228       for (unsigned J = 0; J != NumClauses; ++J) {
3229         LandingPadInst::ClauseType CT =
3230           LandingPadInst::ClauseType(Record[Idx++]); (void)CT;
3231         Value *Val;
3232
3233         if (getValueTypePair(Record, Idx, NextValueNo, Val)) {
3234           delete LP;
3235           return Error("Invalid record");
3236         }
3237
3238         assert((CT != LandingPadInst::Catch ||
3239                 !isa<ArrayType>(Val->getType())) &&
3240                "Catch clause has a invalid type!");
3241         assert((CT != LandingPadInst::Filter ||
3242                 isa<ArrayType>(Val->getType())) &&
3243                "Filter clause has invalid type!");
3244         LP->addClause(cast<Constant>(Val));
3245       }
3246
3247       I = LP;
3248       InstructionList.push_back(I);
3249       break;
3250     }
3251
3252     case bitc::FUNC_CODE_INST_ALLOCA: { // ALLOCA: [instty, opty, op, align]
3253       if (Record.size() != 4)
3254         return Error("Invalid record");
3255       PointerType *Ty =
3256         dyn_cast_or_null<PointerType>(getTypeByID(Record[0]));
3257       Type *OpTy = getTypeByID(Record[1]);
3258       Value *Size = getFnValueByID(Record[2], OpTy);
3259       unsigned AlignRecord = Record[3];
3260       bool InAlloca = AlignRecord & (1 << 5);
3261       unsigned Align = AlignRecord & ((1 << 5) - 1);
3262       if (!Ty || !Size)
3263         return Error("Invalid record");
3264       AllocaInst *AI = new AllocaInst(Ty->getElementType(), Size, (1 << Align) >> 1);
3265       AI->setUsedWithInAlloca(InAlloca);
3266       I = AI;
3267       InstructionList.push_back(I);
3268       break;
3269     }
3270     case bitc::FUNC_CODE_INST_LOAD: { // LOAD: [opty, op, align, vol]
3271       unsigned OpNum = 0;
3272       Value *Op;
3273       if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
3274           OpNum+2 != Record.size())
3275         return Error("Invalid record");
3276
3277       I = new LoadInst(Op, "", Record[OpNum+1], (1 << Record[OpNum]) >> 1);
3278       InstructionList.push_back(I);
3279       break;
3280     }
3281     case bitc::FUNC_CODE_INST_LOADATOMIC: {
3282        // LOADATOMIC: [opty, op, align, vol, ordering, synchscope]
3283       unsigned OpNum = 0;
3284       Value *Op;
3285       if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
3286           OpNum+4 != Record.size())
3287         return Error("Invalid record");
3288
3289       AtomicOrdering Ordering = GetDecodedOrdering(Record[OpNum+2]);
3290       if (Ordering == NotAtomic || Ordering == Release ||
3291           Ordering == AcquireRelease)
3292         return Error("Invalid record");
3293       if (Ordering != NotAtomic && Record[OpNum] == 0)
3294         return Error("Invalid record");
3295       SynchronizationScope SynchScope = GetDecodedSynchScope(Record[OpNum+3]);
3296
3297       I = new LoadInst(Op, "", Record[OpNum+1], (1 << Record[OpNum]) >> 1,
3298                        Ordering, SynchScope);
3299       InstructionList.push_back(I);
3300       break;
3301     }
3302     case bitc::FUNC_CODE_INST_STORE: { // STORE2:[ptrty, ptr, val, align, vol]
3303       unsigned OpNum = 0;
3304       Value *Val, *Ptr;
3305       if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
3306           popValue(Record, OpNum, NextValueNo,
3307                     cast<PointerType>(Ptr->getType())->getElementType(), Val) ||
3308           OpNum+2 != Record.size())
3309         return Error("Invalid record");
3310
3311       I = new StoreInst(Val, Ptr, Record[OpNum+1], (1 << Record[OpNum]) >> 1);
3312       InstructionList.push_back(I);
3313       break;
3314     }
3315     case bitc::FUNC_CODE_INST_STOREATOMIC: {
3316       // STOREATOMIC: [ptrty, ptr, val, align, vol, ordering, synchscope]
3317       unsigned OpNum = 0;
3318       Value *Val, *Ptr;
3319       if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
3320           popValue(Record, OpNum, NextValueNo,
3321                     cast<PointerType>(Ptr->getType())->getElementType(), Val) ||
3322           OpNum+4 != Record.size())
3323         return Error("Invalid record");
3324
3325       AtomicOrdering Ordering = GetDecodedOrdering(Record[OpNum+2]);
3326       if (Ordering == NotAtomic || Ordering == Acquire ||
3327           Ordering == AcquireRelease)
3328         return Error("Invalid record");
3329       SynchronizationScope SynchScope = GetDecodedSynchScope(Record[OpNum+3]);
3330       if (Ordering != NotAtomic && Record[OpNum] == 0)
3331         return Error("Invalid record");
3332
3333       I = new StoreInst(Val, Ptr, Record[OpNum+1], (1 << Record[OpNum]) >> 1,
3334                         Ordering, SynchScope);
3335       InstructionList.push_back(I);
3336       break;
3337     }
3338     case bitc::FUNC_CODE_INST_CMPXCHG: {
3339       // CMPXCHG:[ptrty, ptr, cmp, new, vol, successordering, synchscope,
3340       //          failureordering?, isweak?]
3341       unsigned OpNum = 0;
3342       Value *Ptr, *Cmp, *New;
3343       if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
3344           popValue(Record, OpNum, NextValueNo,
3345                     cast<PointerType>(Ptr->getType())->getElementType(), Cmp) ||
3346           popValue(Record, OpNum, NextValueNo,
3347                     cast<PointerType>(Ptr->getType())->getElementType(), New) ||
3348           (Record.size() < OpNum + 3 || Record.size() > OpNum + 5))
3349         return Error("Invalid record");
3350       AtomicOrdering SuccessOrdering = GetDecodedOrdering(Record[OpNum+1]);
3351       if (SuccessOrdering == NotAtomic || SuccessOrdering == Unordered)
3352         return Error("Invalid record");
3353       SynchronizationScope SynchScope = GetDecodedSynchScope(Record[OpNum+2]);
3354
3355       AtomicOrdering FailureOrdering;
3356       if (Record.size() < 7)
3357         FailureOrdering =
3358             AtomicCmpXchgInst::getStrongestFailureOrdering(SuccessOrdering);
3359       else
3360         FailureOrdering = GetDecodedOrdering(Record[OpNum+3]);
3361
3362       I = new AtomicCmpXchgInst(Ptr, Cmp, New, SuccessOrdering, FailureOrdering,
3363                                 SynchScope);
3364       cast<AtomicCmpXchgInst>(I)->setVolatile(Record[OpNum]);
3365
3366       if (Record.size() < 8) {
3367         // Before weak cmpxchgs existed, the instruction simply returned the
3368         // value loaded from memory, so bitcode files from that era will be
3369         // expecting the first component of a modern cmpxchg.
3370         CurBB->getInstList().push_back(I);
3371         I = ExtractValueInst::Create(I, 0);
3372       } else {
3373         cast<AtomicCmpXchgInst>(I)->setWeak(Record[OpNum+4]);
3374       }
3375
3376       InstructionList.push_back(I);
3377       break;
3378     }
3379     case bitc::FUNC_CODE_INST_ATOMICRMW: {
3380       // ATOMICRMW:[ptrty, ptr, val, op, vol, ordering, synchscope]
3381       unsigned OpNum = 0;
3382       Value *Ptr, *Val;
3383       if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
3384           popValue(Record, OpNum, NextValueNo,
3385                     cast<PointerType>(Ptr->getType())->getElementType(), Val) ||
3386           OpNum+4 != Record.size())
3387         return Error("Invalid record");
3388       AtomicRMWInst::BinOp Operation = GetDecodedRMWOperation(Record[OpNum]);
3389       if (Operation < AtomicRMWInst::FIRST_BINOP ||
3390           Operation > AtomicRMWInst::LAST_BINOP)
3391         return Error("Invalid record");
3392       AtomicOrdering Ordering = GetDecodedOrdering(Record[OpNum+2]);
3393       if (Ordering == NotAtomic || Ordering == Unordered)
3394         return Error("Invalid record");
3395       SynchronizationScope SynchScope = GetDecodedSynchScope(Record[OpNum+3]);
3396       I = new AtomicRMWInst(Operation, Ptr, Val, Ordering, SynchScope);
3397       cast<AtomicRMWInst>(I)->setVolatile(Record[OpNum+1]);
3398       InstructionList.push_back(I);
3399       break;
3400     }
3401     case bitc::FUNC_CODE_INST_FENCE: { // FENCE:[ordering, synchscope]
3402       if (2 != Record.size())
3403         return Error("Invalid record");
3404       AtomicOrdering Ordering = GetDecodedOrdering(Record[0]);
3405       if (Ordering == NotAtomic || Ordering == Unordered ||
3406           Ordering == Monotonic)
3407         return Error("Invalid record");
3408       SynchronizationScope SynchScope = GetDecodedSynchScope(Record[1]);
3409       I = new FenceInst(Context, Ordering, SynchScope);
3410       InstructionList.push_back(I);
3411       break;
3412     }
3413     case bitc::FUNC_CODE_INST_CALL: {
3414       // CALL: [paramattrs, cc, fnty, fnid, arg0, arg1...]
3415       if (Record.size() < 3)
3416         return Error("Invalid record");
3417
3418       AttributeSet PAL = getAttributes(Record[0]);
3419       unsigned CCInfo = Record[1];
3420
3421       unsigned OpNum = 2;
3422       Value *Callee;
3423       if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
3424         return Error("Invalid record");
3425
3426       PointerType *OpTy = dyn_cast<PointerType>(Callee->getType());
3427       FunctionType *FTy = nullptr;
3428       if (OpTy) FTy = dyn_cast<FunctionType>(OpTy->getElementType());
3429       if (!FTy || Record.size() < FTy->getNumParams()+OpNum)
3430         return Error("Invalid record");
3431
3432       SmallVector<Value*, 16> Args;
3433       // Read the fixed params.
3434       for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
3435         if (FTy->getParamType(i)->isLabelTy())
3436           Args.push_back(getBasicBlock(Record[OpNum]));
3437         else
3438           Args.push_back(getValue(Record, OpNum, NextValueNo,
3439                                   FTy->getParamType(i)));
3440         if (!Args.back())
3441           return Error("Invalid record");
3442       }
3443
3444       // Read type/value pairs for varargs params.
3445       if (!FTy->isVarArg()) {
3446         if (OpNum != Record.size())
3447           return Error("Invalid record");
3448       } else {
3449         while (OpNum != Record.size()) {
3450           Value *Op;
3451           if (getValueTypePair(Record, OpNum, NextValueNo, Op))
3452             return Error("Invalid record");
3453           Args.push_back(Op);
3454         }
3455       }
3456
3457       I = CallInst::Create(Callee, Args);
3458       InstructionList.push_back(I);
3459       cast<CallInst>(I)->setCallingConv(
3460           static_cast<CallingConv::ID>((~(1U << 14) & CCInfo) >> 1));
3461       CallInst::TailCallKind TCK = CallInst::TCK_None;
3462       if (CCInfo & 1)
3463         TCK = CallInst::TCK_Tail;
3464       if (CCInfo & (1 << 14))
3465         TCK = CallInst::TCK_MustTail;
3466       cast<CallInst>(I)->setTailCallKind(TCK);
3467       cast<CallInst>(I)->setAttributes(PAL);
3468       break;
3469     }
3470     case bitc::FUNC_CODE_INST_VAARG: { // VAARG: [valistty, valist, instty]
3471       if (Record.size() < 3)
3472         return Error("Invalid record");
3473       Type *OpTy = getTypeByID(Record[0]);
3474       Value *Op = getValue(Record, 1, NextValueNo, OpTy);
3475       Type *ResTy = getTypeByID(Record[2]);
3476       if (!OpTy || !Op || !ResTy)
3477         return Error("Invalid record");
3478       I = new VAArgInst(Op, ResTy);
3479       InstructionList.push_back(I);
3480       break;
3481     }
3482     }
3483
3484     // Add instruction to end of current BB.  If there is no current BB, reject
3485     // this file.
3486     if (!CurBB) {
3487       delete I;
3488       return Error("Invalid instruction with no BB");
3489     }
3490     CurBB->getInstList().push_back(I);
3491
3492     // If this was a terminator instruction, move to the next block.
3493     if (isa<TerminatorInst>(I)) {
3494       ++CurBBNo;
3495       CurBB = CurBBNo < FunctionBBs.size() ? FunctionBBs[CurBBNo] : nullptr;
3496     }
3497
3498     // Non-void values get registered in the value table for future use.
3499     if (I && !I->getType()->isVoidTy())
3500       ValueList.AssignValue(I, NextValueNo++);
3501   }
3502
3503 OutOfRecordLoop:
3504
3505   // Check the function list for unresolved values.
3506   if (Argument *A = dyn_cast<Argument>(ValueList.back())) {
3507     if (!A->getParent()) {
3508       // We found at least one unresolved value.  Nuke them all to avoid leaks.
3509       for (unsigned i = ModuleValueListSize, e = ValueList.size(); i != e; ++i){
3510         if ((A = dyn_cast_or_null<Argument>(ValueList[i])) && !A->getParent()) {
3511           A->replaceAllUsesWith(UndefValue::get(A->getType()));
3512           delete A;
3513         }
3514       }
3515       return Error("Never resolved value found in function");
3516     }
3517   }
3518
3519   // FIXME: Check for unresolved forward-declared metadata references
3520   // and clean up leaks.
3521
3522   // Trim the value list down to the size it was before we parsed this function.
3523   ValueList.shrinkTo(ModuleValueListSize);
3524   MDValueList.shrinkTo(ModuleMDValueListSize);
3525   std::vector<BasicBlock*>().swap(FunctionBBs);
3526   return std::error_code();
3527 }
3528
3529 /// Find the function body in the bitcode stream
3530 std::error_code BitcodeReader::FindFunctionInStream(
3531     Function *F,
3532     DenseMap<Function *, uint64_t>::iterator DeferredFunctionInfoIterator) {
3533   while (DeferredFunctionInfoIterator->second == 0) {
3534     if (Stream.AtEndOfStream())
3535       return Error("Could not find function in stream");
3536     // ParseModule will parse the next body in the stream and set its
3537     // position in the DeferredFunctionInfo map.
3538     if (std::error_code EC = ParseModule(true))
3539       return EC;
3540   }
3541   return std::error_code();
3542 }
3543
3544 //===----------------------------------------------------------------------===//
3545 // GVMaterializer implementation
3546 //===----------------------------------------------------------------------===//
3547
3548 void BitcodeReader::releaseBuffer() { Buffer.release(); }
3549
3550 std::error_code BitcodeReader::materialize(GlobalValue *GV) {
3551   Function *F = dyn_cast<Function>(GV);
3552   // If it's not a function or is already material, ignore the request.
3553   if (!F || !F->isMaterializable())
3554     return std::error_code();
3555
3556   DenseMap<Function*, uint64_t>::iterator DFII = DeferredFunctionInfo.find(F);
3557   assert(DFII != DeferredFunctionInfo.end() && "Deferred function not found!");
3558   // If its position is recorded as 0, its body is somewhere in the stream
3559   // but we haven't seen it yet.
3560   if (DFII->second == 0 && LazyStreamer)
3561     if (std::error_code EC = FindFunctionInStream(F, DFII))
3562       return EC;
3563
3564   // Move the bit stream to the saved position of the deferred function body.
3565   Stream.JumpToBit(DFII->second);
3566
3567   if (std::error_code EC = ParseFunctionBody(F))
3568     return EC;
3569   F->setIsMaterializable(false);
3570
3571   // Upgrade any old intrinsic calls in the function.
3572   for (UpgradedIntrinsicMap::iterator I = UpgradedIntrinsics.begin(),
3573        E = UpgradedIntrinsics.end(); I != E; ++I) {
3574     if (I->first != I->second) {
3575       for (auto UI = I->first->user_begin(), UE = I->first->user_end();
3576            UI != UE;) {
3577         if (CallInst* CI = dyn_cast<CallInst>(*UI++))
3578           UpgradeIntrinsicCall(CI, I->second);
3579       }
3580     }
3581   }
3582
3583   // Bring in any functions that this function forward-referenced via
3584   // blockaddresses.
3585   return materializeForwardReferencedFunctions();
3586 }
3587
3588 bool BitcodeReader::isDematerializable(const GlobalValue *GV) const {
3589   const Function *F = dyn_cast<Function>(GV);
3590   if (!F || F->isDeclaration())
3591     return false;
3592
3593   // Dematerializing F would leave dangling references that wouldn't be
3594   // reconnected on re-materialization.
3595   if (BlockAddressesTaken.count(F))
3596     return false;
3597
3598   return DeferredFunctionInfo.count(const_cast<Function*>(F));
3599 }
3600
3601 void BitcodeReader::Dematerialize(GlobalValue *GV) {
3602   Function *F = dyn_cast<Function>(GV);
3603   // If this function isn't dematerializable, this is a noop.
3604   if (!F || !isDematerializable(F))
3605     return;
3606
3607   assert(DeferredFunctionInfo.count(F) && "No info to read function later?");
3608
3609   // Just forget the function body, we can remat it later.
3610   F->dropAllReferences();
3611   F->setIsMaterializable(true);
3612 }
3613
3614 std::error_code BitcodeReader::MaterializeModule(Module *M) {
3615   assert(M == TheModule &&
3616          "Can only Materialize the Module this BitcodeReader is attached to.");
3617
3618   // Promise to materialize all forward references.
3619   WillMaterializeAllForwardRefs = true;
3620
3621   // Iterate over the module, deserializing any functions that are still on
3622   // disk.
3623   for (Module::iterator F = TheModule->begin(), E = TheModule->end();
3624        F != E; ++F) {
3625     if (std::error_code EC = materialize(F))
3626       return EC;
3627   }
3628   // At this point, if there are any function bodies, the current bit is
3629   // pointing to the END_BLOCK record after them. Now make sure the rest
3630   // of the bits in the module have been read.
3631   if (NextUnreadBit)
3632     ParseModule(true);
3633
3634   // Check that all block address forward references got resolved (as we
3635   // promised above).
3636   if (!BasicBlockFwdRefs.empty())
3637     return Error("Never resolved function from blockaddress");
3638
3639   // Upgrade any intrinsic calls that slipped through (should not happen!) and
3640   // delete the old functions to clean up. We can't do this unless the entire
3641   // module is materialized because there could always be another function body
3642   // with calls to the old function.
3643   for (std::vector<std::pair<Function*, Function*> >::iterator I =
3644        UpgradedIntrinsics.begin(), E = UpgradedIntrinsics.end(); I != E; ++I) {
3645     if (I->first != I->second) {
3646       for (auto UI = I->first->user_begin(), UE = I->first->user_end();
3647            UI != UE;) {
3648         if (CallInst* CI = dyn_cast<CallInst>(*UI++))
3649           UpgradeIntrinsicCall(CI, I->second);
3650       }
3651       if (!I->first->use_empty())
3652         I->first->replaceAllUsesWith(I->second);
3653       I->first->eraseFromParent();
3654     }
3655   }
3656   std::vector<std::pair<Function*, Function*> >().swap(UpgradedIntrinsics);
3657
3658   for (unsigned I = 0, E = InstsWithTBAATag.size(); I < E; I++)
3659     UpgradeInstWithTBAATag(InstsWithTBAATag[I]);
3660
3661   UpgradeDebugInfo(*M);
3662   return std::error_code();
3663 }
3664
3665 std::vector<StructType *> BitcodeReader::getIdentifiedStructTypes() const {
3666   return IdentifiedStructTypes;
3667 }
3668
3669 std::error_code BitcodeReader::InitStream() {
3670   if (LazyStreamer)
3671     return InitLazyStream();
3672   return InitStreamFromBuffer();
3673 }
3674
3675 std::error_code BitcodeReader::InitStreamFromBuffer() {
3676   const unsigned char *BufPtr = (const unsigned char*)Buffer->getBufferStart();
3677   const unsigned char *BufEnd = BufPtr+Buffer->getBufferSize();
3678
3679   if (Buffer->getBufferSize() & 3)
3680     return Error("Invalid bitcode signature");
3681
3682   // If we have a wrapper header, parse it and ignore the non-bc file contents.
3683   // The magic number is 0x0B17C0DE stored in little endian.
3684   if (isBitcodeWrapper(BufPtr, BufEnd))
3685     if (SkipBitcodeWrapperHeader(BufPtr, BufEnd, true))
3686       return Error("Invalid bitcode wrapper header");
3687
3688   StreamFile.reset(new BitstreamReader(BufPtr, BufEnd));
3689   Stream.init(&*StreamFile);
3690
3691   return std::error_code();
3692 }
3693
3694 std::error_code BitcodeReader::InitLazyStream() {
3695   // Check and strip off the bitcode wrapper; BitstreamReader expects never to
3696   // see it.
3697   auto OwnedBytes = llvm::make_unique<StreamingMemoryObject>(LazyStreamer);
3698   StreamingMemoryObject &Bytes = *OwnedBytes;
3699   StreamFile = llvm::make_unique<BitstreamReader>(std::move(OwnedBytes));
3700   Stream.init(&*StreamFile);
3701
3702   unsigned char buf[16];
3703   if (Bytes.readBytes(buf, 16, 0) != 16)
3704     return Error("Invalid bitcode signature");
3705
3706   if (!isBitcode(buf, buf + 16))
3707     return Error("Invalid bitcode signature");
3708
3709   if (isBitcodeWrapper(buf, buf + 4)) {
3710     const unsigned char *bitcodeStart = buf;
3711     const unsigned char *bitcodeEnd = buf + 16;
3712     SkipBitcodeWrapperHeader(bitcodeStart, bitcodeEnd, false);
3713     Bytes.dropLeadingBytes(bitcodeStart - buf);
3714     Bytes.setKnownObjectSize(bitcodeEnd - bitcodeStart);
3715   }
3716   return std::error_code();
3717 }
3718
3719 namespace {
3720 class BitcodeErrorCategoryType : public std::error_category {
3721   const char *name() const LLVM_NOEXCEPT override {
3722     return "llvm.bitcode";
3723   }
3724   std::string message(int IE) const override {
3725     BitcodeError E = static_cast<BitcodeError>(IE);
3726     switch (E) {
3727     case BitcodeError::InvalidBitcodeSignature:
3728       return "Invalid bitcode signature";
3729     case BitcodeError::CorruptedBitcode:
3730       return "Corrupted bitcode";
3731     }
3732     llvm_unreachable("Unknown error type!");
3733   }
3734 };
3735 }
3736
3737 static ManagedStatic<BitcodeErrorCategoryType> ErrorCategory;
3738
3739 const std::error_category &llvm::BitcodeErrorCategory() {
3740   return *ErrorCategory;
3741 }
3742
3743 //===----------------------------------------------------------------------===//
3744 // External interface
3745 //===----------------------------------------------------------------------===//
3746
3747 /// \brief Get a lazy one-at-time loading module from bitcode.
3748 ///
3749 /// This isn't always used in a lazy context.  In particular, it's also used by
3750 /// \a parseBitcodeFile().  If this is truly lazy, then we need to eagerly pull
3751 /// in forward-referenced functions from block address references.
3752 ///
3753 /// \param[in] WillMaterializeAll Set to \c true if the caller promises to
3754 /// materialize everything -- in particular, if this isn't truly lazy.
3755 static ErrorOr<Module *>
3756 getLazyBitcodeModuleImpl(std::unique_ptr<MemoryBuffer> &&Buffer,
3757                          LLVMContext &Context, bool WillMaterializeAll,
3758                          DiagnosticHandlerFunction DiagnosticHandler) {
3759   Module *M = new Module(Buffer->getBufferIdentifier(), Context);
3760   BitcodeReader *R =
3761       new BitcodeReader(Buffer.get(), Context, DiagnosticHandler);
3762   M->setMaterializer(R);
3763
3764   auto cleanupOnError = [&](std::error_code EC) {
3765     R->releaseBuffer(); // Never take ownership on error.
3766     delete M;  // Also deletes R.
3767     return EC;
3768   };
3769
3770   if (std::error_code EC = R->ParseBitcodeInto(M))
3771     return cleanupOnError(EC);
3772
3773   if (!WillMaterializeAll)
3774     // Resolve forward references from blockaddresses.
3775     if (std::error_code EC = R->materializeForwardReferencedFunctions())
3776       return cleanupOnError(EC);
3777
3778   Buffer.release(); // The BitcodeReader owns it now.
3779   return M;
3780 }
3781
3782 ErrorOr<Module *>
3783 llvm::getLazyBitcodeModule(std::unique_ptr<MemoryBuffer> &&Buffer,
3784                            LLVMContext &Context,
3785                            DiagnosticHandlerFunction DiagnosticHandler) {
3786   return getLazyBitcodeModuleImpl(std::move(Buffer), Context, false,
3787                                   DiagnosticHandler);
3788 }
3789
3790 ErrorOr<std::unique_ptr<Module>>
3791 llvm::getStreamedBitcodeModule(StringRef Name, DataStreamer *Streamer,
3792                                LLVMContext &Context,
3793                                DiagnosticHandlerFunction DiagnosticHandler) {
3794   std::unique_ptr<Module> M = make_unique<Module>(Name, Context);
3795   BitcodeReader *R = new BitcodeReader(Streamer, Context, DiagnosticHandler);
3796   M->setMaterializer(R);
3797   if (std::error_code EC = R->ParseBitcodeInto(M.get()))
3798     return EC;
3799   return std::move(M);
3800 }
3801
3802 ErrorOr<Module *>
3803 llvm::parseBitcodeFile(MemoryBufferRef Buffer, LLVMContext &Context,
3804                        DiagnosticHandlerFunction DiagnosticHandler) {
3805   std::unique_ptr<MemoryBuffer> Buf = MemoryBuffer::getMemBuffer(Buffer, false);
3806   ErrorOr<Module *> ModuleOrErr = getLazyBitcodeModuleImpl(
3807       std::move(Buf), Context, true, DiagnosticHandler);
3808   if (!ModuleOrErr)
3809     return ModuleOrErr;
3810   Module *M = ModuleOrErr.get();
3811   // Read in the entire module, and destroy the BitcodeReader.
3812   if (std::error_code EC = M->materializeAllPermanently()) {
3813     delete M;
3814     return EC;
3815   }
3816
3817   // TODO: Restore the use-lists to the in-memory state when the bitcode was
3818   // written.  We must defer until the Module has been fully materialized.
3819
3820   return M;
3821 }
3822
3823 std::string
3824 llvm::getBitcodeTargetTriple(MemoryBufferRef Buffer, LLVMContext &Context,
3825                              DiagnosticHandlerFunction DiagnosticHandler) {
3826   std::unique_ptr<MemoryBuffer> Buf = MemoryBuffer::getMemBuffer(Buffer, false);
3827   auto R = llvm::make_unique<BitcodeReader>(Buf.release(), Context,
3828                                             DiagnosticHandler);
3829   ErrorOr<std::string> Triple = R->parseTriple();
3830   if (Triple.getError())
3831     return "";
3832   return Triple.get();
3833 }