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