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 /// ResolveGlobalAndAliasInits - Resolve all of the initializers for global
1096 /// values and aliases that we can.
1097 error_code BitcodeReader::ResolveGlobalAndAliasInits() {
1098   std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInitWorklist;
1099   std::vector<std::pair<GlobalAlias*, unsigned> > AliasInitWorklist;
1100   std::vector<std::pair<Function*, unsigned> > FunctionPrefixWorklist;
1101
1102   GlobalInitWorklist.swap(GlobalInits);
1103   AliasInitWorklist.swap(AliasInits);
1104   FunctionPrefixWorklist.swap(FunctionPrefixes);
1105
1106   while (!GlobalInitWorklist.empty()) {
1107     unsigned ValID = GlobalInitWorklist.back().second;
1108     if (ValID >= ValueList.size()) {
1109       // Not ready to resolve this yet, it requires something later in the file.
1110       GlobalInits.push_back(GlobalInitWorklist.back());
1111     } else {
1112       if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
1113         GlobalInitWorklist.back().first->setInitializer(C);
1114       else
1115         return Error(ExpectedConstant);
1116     }
1117     GlobalInitWorklist.pop_back();
1118   }
1119
1120   while (!AliasInitWorklist.empty()) {
1121     unsigned ValID = AliasInitWorklist.back().second;
1122     if (ValID >= ValueList.size()) {
1123       AliasInits.push_back(AliasInitWorklist.back());
1124     } else {
1125       if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
1126         AliasInitWorklist.back().first->setAliasee(C);
1127       else
1128         return Error(ExpectedConstant);
1129     }
1130     AliasInitWorklist.pop_back();
1131   }
1132
1133   while (!FunctionPrefixWorklist.empty()) {
1134     unsigned ValID = FunctionPrefixWorklist.back().second;
1135     if (ValID >= ValueList.size()) {
1136       FunctionPrefixes.push_back(FunctionPrefixWorklist.back());
1137     } else {
1138       if (Constant *C = dyn_cast_or_null<Constant>(ValueList[ValID]))
1139         FunctionPrefixWorklist.back().first->setPrefixData(C);
1140       else
1141         return Error(ExpectedConstant);
1142     }
1143     FunctionPrefixWorklist.pop_back();
1144   }
1145
1146   return error_code::success();
1147 }
1148
1149 static APInt ReadWideAPInt(ArrayRef<uint64_t> Vals, unsigned TypeBits) {
1150   SmallVector<uint64_t, 8> Words(Vals.size());
1151   std::transform(Vals.begin(), Vals.end(), Words.begin(),
1152                  BitcodeReader::decodeSignRotatedValue);
1153
1154   return APInt(TypeBits, Words);
1155 }
1156
1157 error_code BitcodeReader::ParseConstants() {
1158   if (Stream.EnterSubBlock(bitc::CONSTANTS_BLOCK_ID))
1159     return Error(InvalidRecord);
1160
1161   SmallVector<uint64_t, 64> Record;
1162
1163   // Read all the records for this value table.
1164   Type *CurTy = Type::getInt32Ty(Context);
1165   unsigned NextCstNo = ValueList.size();
1166   while (1) {
1167     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1168
1169     switch (Entry.Kind) {
1170     case BitstreamEntry::SubBlock: // Handled for us already.
1171     case BitstreamEntry::Error:
1172       return Error(MalformedBlock);
1173     case BitstreamEntry::EndBlock:
1174       if (NextCstNo != ValueList.size())
1175         return Error(InvalidConstantReference);
1176
1177       // Once all the constants have been read, go through and resolve forward
1178       // references.
1179       ValueList.ResolveConstantForwardRefs();
1180       return error_code::success();
1181     case BitstreamEntry::Record:
1182       // The interesting case.
1183       break;
1184     }
1185
1186     // Read a record.
1187     Record.clear();
1188     Value *V = nullptr;
1189     unsigned BitCode = Stream.readRecord(Entry.ID, Record);
1190     switch (BitCode) {
1191     default:  // Default behavior: unknown constant
1192     case bitc::CST_CODE_UNDEF:     // UNDEF
1193       V = UndefValue::get(CurTy);
1194       break;
1195     case bitc::CST_CODE_SETTYPE:   // SETTYPE: [typeid]
1196       if (Record.empty())
1197         return Error(InvalidRecord);
1198       if (Record[0] >= TypeList.size() || !TypeList[Record[0]])
1199         return Error(InvalidRecord);
1200       CurTy = TypeList[Record[0]];
1201       continue;  // Skip the ValueList manipulation.
1202     case bitc::CST_CODE_NULL:      // NULL
1203       V = Constant::getNullValue(CurTy);
1204       break;
1205     case bitc::CST_CODE_INTEGER:   // INTEGER: [intval]
1206       if (!CurTy->isIntegerTy() || Record.empty())
1207         return Error(InvalidRecord);
1208       V = ConstantInt::get(CurTy, decodeSignRotatedValue(Record[0]));
1209       break;
1210     case bitc::CST_CODE_WIDE_INTEGER: {// WIDE_INTEGER: [n x intval]
1211       if (!CurTy->isIntegerTy() || Record.empty())
1212         return Error(InvalidRecord);
1213
1214       APInt VInt = ReadWideAPInt(Record,
1215                                  cast<IntegerType>(CurTy)->getBitWidth());
1216       V = ConstantInt::get(Context, VInt);
1217
1218       break;
1219     }
1220     case bitc::CST_CODE_FLOAT: {    // FLOAT: [fpval]
1221       if (Record.empty())
1222         return Error(InvalidRecord);
1223       if (CurTy->isHalfTy())
1224         V = ConstantFP::get(Context, APFloat(APFloat::IEEEhalf,
1225                                              APInt(16, (uint16_t)Record[0])));
1226       else if (CurTy->isFloatTy())
1227         V = ConstantFP::get(Context, APFloat(APFloat::IEEEsingle,
1228                                              APInt(32, (uint32_t)Record[0])));
1229       else if (CurTy->isDoubleTy())
1230         V = ConstantFP::get(Context, APFloat(APFloat::IEEEdouble,
1231                                              APInt(64, Record[0])));
1232       else if (CurTy->isX86_FP80Ty()) {
1233         // Bits are not stored the same way as a normal i80 APInt, compensate.
1234         uint64_t Rearrange[2];
1235         Rearrange[0] = (Record[1] & 0xffffLL) | (Record[0] << 16);
1236         Rearrange[1] = Record[0] >> 48;
1237         V = ConstantFP::get(Context, APFloat(APFloat::x87DoubleExtended,
1238                                              APInt(80, Rearrange)));
1239       } else if (CurTy->isFP128Ty())
1240         V = ConstantFP::get(Context, APFloat(APFloat::IEEEquad,
1241                                              APInt(128, Record)));
1242       else if (CurTy->isPPC_FP128Ty())
1243         V = ConstantFP::get(Context, APFloat(APFloat::PPCDoubleDouble,
1244                                              APInt(128, Record)));
1245       else
1246         V = UndefValue::get(CurTy);
1247       break;
1248     }
1249
1250     case bitc::CST_CODE_AGGREGATE: {// AGGREGATE: [n x value number]
1251       if (Record.empty())
1252         return Error(InvalidRecord);
1253
1254       unsigned Size = Record.size();
1255       SmallVector<Constant*, 16> Elts;
1256
1257       if (StructType *STy = dyn_cast<StructType>(CurTy)) {
1258         for (unsigned i = 0; i != Size; ++i)
1259           Elts.push_back(ValueList.getConstantFwdRef(Record[i],
1260                                                      STy->getElementType(i)));
1261         V = ConstantStruct::get(STy, Elts);
1262       } else if (ArrayType *ATy = dyn_cast<ArrayType>(CurTy)) {
1263         Type *EltTy = ATy->getElementType();
1264         for (unsigned i = 0; i != Size; ++i)
1265           Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
1266         V = ConstantArray::get(ATy, Elts);
1267       } else if (VectorType *VTy = dyn_cast<VectorType>(CurTy)) {
1268         Type *EltTy = VTy->getElementType();
1269         for (unsigned i = 0; i != Size; ++i)
1270           Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
1271         V = ConstantVector::get(Elts);
1272       } else {
1273         V = UndefValue::get(CurTy);
1274       }
1275       break;
1276     }
1277     case bitc::CST_CODE_STRING:    // STRING: [values]
1278     case bitc::CST_CODE_CSTRING: { // CSTRING: [values]
1279       if (Record.empty())
1280         return Error(InvalidRecord);
1281
1282       SmallString<16> Elts(Record.begin(), Record.end());
1283       V = ConstantDataArray::getString(Context, Elts,
1284                                        BitCode == bitc::CST_CODE_CSTRING);
1285       break;
1286     }
1287     case bitc::CST_CODE_DATA: {// DATA: [n x value]
1288       if (Record.empty())
1289         return Error(InvalidRecord);
1290
1291       Type *EltTy = cast<SequentialType>(CurTy)->getElementType();
1292       unsigned Size = Record.size();
1293
1294       if (EltTy->isIntegerTy(8)) {
1295         SmallVector<uint8_t, 16> Elts(Record.begin(), Record.end());
1296         if (isa<VectorType>(CurTy))
1297           V = ConstantDataVector::get(Context, Elts);
1298         else
1299           V = ConstantDataArray::get(Context, Elts);
1300       } else if (EltTy->isIntegerTy(16)) {
1301         SmallVector<uint16_t, 16> Elts(Record.begin(), Record.end());
1302         if (isa<VectorType>(CurTy))
1303           V = ConstantDataVector::get(Context, Elts);
1304         else
1305           V = ConstantDataArray::get(Context, Elts);
1306       } else if (EltTy->isIntegerTy(32)) {
1307         SmallVector<uint32_t, 16> Elts(Record.begin(), Record.end());
1308         if (isa<VectorType>(CurTy))
1309           V = ConstantDataVector::get(Context, Elts);
1310         else
1311           V = ConstantDataArray::get(Context, Elts);
1312       } else if (EltTy->isIntegerTy(64)) {
1313         SmallVector<uint64_t, 16> Elts(Record.begin(), Record.end());
1314         if (isa<VectorType>(CurTy))
1315           V = ConstantDataVector::get(Context, Elts);
1316         else
1317           V = ConstantDataArray::get(Context, Elts);
1318       } else if (EltTy->isFloatTy()) {
1319         SmallVector<float, 16> Elts(Size);
1320         std::transform(Record.begin(), Record.end(), Elts.begin(), BitsToFloat);
1321         if (isa<VectorType>(CurTy))
1322           V = ConstantDataVector::get(Context, Elts);
1323         else
1324           V = ConstantDataArray::get(Context, Elts);
1325       } else if (EltTy->isDoubleTy()) {
1326         SmallVector<double, 16> Elts(Size);
1327         std::transform(Record.begin(), Record.end(), Elts.begin(),
1328                        BitsToDouble);
1329         if (isa<VectorType>(CurTy))
1330           V = ConstantDataVector::get(Context, Elts);
1331         else
1332           V = ConstantDataArray::get(Context, Elts);
1333       } else {
1334         return Error(InvalidTypeForValue);
1335       }
1336       break;
1337     }
1338
1339     case bitc::CST_CODE_CE_BINOP: {  // CE_BINOP: [opcode, opval, opval]
1340       if (Record.size() < 3)
1341         return Error(InvalidRecord);
1342       int Opc = GetDecodedBinaryOpcode(Record[0], CurTy);
1343       if (Opc < 0) {
1344         V = UndefValue::get(CurTy);  // Unknown binop.
1345       } else {
1346         Constant *LHS = ValueList.getConstantFwdRef(Record[1], CurTy);
1347         Constant *RHS = ValueList.getConstantFwdRef(Record[2], CurTy);
1348         unsigned Flags = 0;
1349         if (Record.size() >= 4) {
1350           if (Opc == Instruction::Add ||
1351               Opc == Instruction::Sub ||
1352               Opc == Instruction::Mul ||
1353               Opc == Instruction::Shl) {
1354             if (Record[3] & (1 << bitc::OBO_NO_SIGNED_WRAP))
1355               Flags |= OverflowingBinaryOperator::NoSignedWrap;
1356             if (Record[3] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
1357               Flags |= OverflowingBinaryOperator::NoUnsignedWrap;
1358           } else if (Opc == Instruction::SDiv ||
1359                      Opc == Instruction::UDiv ||
1360                      Opc == Instruction::LShr ||
1361                      Opc == Instruction::AShr) {
1362             if (Record[3] & (1 << bitc::PEO_EXACT))
1363               Flags |= SDivOperator::IsExact;
1364           }
1365         }
1366         V = ConstantExpr::get(Opc, LHS, RHS, Flags);
1367       }
1368       break;
1369     }
1370     case bitc::CST_CODE_CE_CAST: {  // CE_CAST: [opcode, opty, opval]
1371       if (Record.size() < 3)
1372         return Error(InvalidRecord);
1373       int Opc = GetDecodedCastOpcode(Record[0]);
1374       if (Opc < 0) {
1375         V = UndefValue::get(CurTy);  // Unknown cast.
1376       } else {
1377         Type *OpTy = getTypeByID(Record[1]);
1378         if (!OpTy)
1379           return Error(InvalidRecord);
1380         Constant *Op = ValueList.getConstantFwdRef(Record[2], OpTy);
1381         V = UpgradeBitCastExpr(Opc, Op, CurTy);
1382         if (!V) V = ConstantExpr::getCast(Opc, Op, CurTy);
1383       }
1384       break;
1385     }
1386     case bitc::CST_CODE_CE_INBOUNDS_GEP:
1387     case bitc::CST_CODE_CE_GEP: {  // CE_GEP:        [n x operands]
1388       if (Record.size() & 1)
1389         return Error(InvalidRecord);
1390       SmallVector<Constant*, 16> Elts;
1391       for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
1392         Type *ElTy = getTypeByID(Record[i]);
1393         if (!ElTy)
1394           return Error(InvalidRecord);
1395         Elts.push_back(ValueList.getConstantFwdRef(Record[i+1], ElTy));
1396       }
1397       ArrayRef<Constant *> Indices(Elts.begin() + 1, Elts.end());
1398       V = ConstantExpr::getGetElementPtr(Elts[0], Indices,
1399                                          BitCode ==
1400                                            bitc::CST_CODE_CE_INBOUNDS_GEP);
1401       break;
1402     }
1403     case bitc::CST_CODE_CE_SELECT: {  // CE_SELECT: [opval#, opval#, opval#]
1404       if (Record.size() < 3)
1405         return Error(InvalidRecord);
1406
1407       Type *SelectorTy = Type::getInt1Ty(Context);
1408
1409       // If CurTy is a vector of length n, then Record[0] must be a <n x i1>
1410       // vector. Otherwise, it must be a single bit.
1411       if (VectorType *VTy = dyn_cast<VectorType>(CurTy))
1412         SelectorTy = VectorType::get(Type::getInt1Ty(Context),
1413                                      VTy->getNumElements());
1414
1415       V = ConstantExpr::getSelect(ValueList.getConstantFwdRef(Record[0],
1416                                                               SelectorTy),
1417                                   ValueList.getConstantFwdRef(Record[1],CurTy),
1418                                   ValueList.getConstantFwdRef(Record[2],CurTy));
1419       break;
1420     }
1421     case bitc::CST_CODE_CE_EXTRACTELT
1422         : { // CE_EXTRACTELT: [opty, opval, opty, opval]
1423       if (Record.size() < 3)
1424         return Error(InvalidRecord);
1425       VectorType *OpTy =
1426         dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
1427       if (!OpTy)
1428         return Error(InvalidRecord);
1429       Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
1430       Constant *Op1 = nullptr;
1431       if (Record.size() == 4) {
1432         Type *IdxTy = getTypeByID(Record[2]);
1433         if (!IdxTy)
1434           return Error(InvalidRecord);
1435         Op1 = ValueList.getConstantFwdRef(Record[3], IdxTy);
1436       } else // TODO: Remove with llvm 4.0
1437         Op1 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
1438       if (!Op1)
1439         return Error(InvalidRecord);
1440       V = ConstantExpr::getExtractElement(Op0, Op1);
1441       break;
1442     }
1443     case bitc::CST_CODE_CE_INSERTELT
1444         : { // CE_INSERTELT: [opval, opval, opty, opval]
1445       VectorType *OpTy = dyn_cast<VectorType>(CurTy);
1446       if (Record.size() < 3 || !OpTy)
1447         return Error(InvalidRecord);
1448       Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
1449       Constant *Op1 = ValueList.getConstantFwdRef(Record[1],
1450                                                   OpTy->getElementType());
1451       Constant *Op2 = nullptr;
1452       if (Record.size() == 4) {
1453         Type *IdxTy = getTypeByID(Record[2]);
1454         if (!IdxTy)
1455           return Error(InvalidRecord);
1456         Op2 = ValueList.getConstantFwdRef(Record[3], IdxTy);
1457       } else // TODO: Remove with llvm 4.0
1458         Op2 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
1459       if (!Op2)
1460         return Error(InvalidRecord);
1461       V = ConstantExpr::getInsertElement(Op0, Op1, Op2);
1462       break;
1463     }
1464     case bitc::CST_CODE_CE_SHUFFLEVEC: { // CE_SHUFFLEVEC: [opval, opval, opval]
1465       VectorType *OpTy = dyn_cast<VectorType>(CurTy);
1466       if (Record.size() < 3 || !OpTy)
1467         return Error(InvalidRecord);
1468       Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
1469       Constant *Op1 = ValueList.getConstantFwdRef(Record[1], OpTy);
1470       Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
1471                                                  OpTy->getNumElements());
1472       Constant *Op2 = ValueList.getConstantFwdRef(Record[2], ShufTy);
1473       V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
1474       break;
1475     }
1476     case bitc::CST_CODE_CE_SHUFVEC_EX: { // [opty, opval, opval, opval]
1477       VectorType *RTy = dyn_cast<VectorType>(CurTy);
1478       VectorType *OpTy =
1479         dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
1480       if (Record.size() < 4 || !RTy || !OpTy)
1481         return Error(InvalidRecord);
1482       Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
1483       Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
1484       Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
1485                                                  RTy->getNumElements());
1486       Constant *Op2 = ValueList.getConstantFwdRef(Record[3], ShufTy);
1487       V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
1488       break;
1489     }
1490     case bitc::CST_CODE_CE_CMP: {     // CE_CMP: [opty, opval, opval, pred]
1491       if (Record.size() < 4)
1492         return Error(InvalidRecord);
1493       Type *OpTy = getTypeByID(Record[0]);
1494       if (!OpTy)
1495         return Error(InvalidRecord);
1496       Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
1497       Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
1498
1499       if (OpTy->isFPOrFPVectorTy())
1500         V = ConstantExpr::getFCmp(Record[3], Op0, Op1);
1501       else
1502         V = ConstantExpr::getICmp(Record[3], Op0, Op1);
1503       break;
1504     }
1505     // This maintains backward compatibility, pre-asm dialect keywords.
1506     // FIXME: Remove with the 4.0 release.
1507     case bitc::CST_CODE_INLINEASM_OLD: {
1508       if (Record.size() < 2)
1509         return Error(InvalidRecord);
1510       std::string AsmStr, ConstrStr;
1511       bool HasSideEffects = Record[0] & 1;
1512       bool IsAlignStack = Record[0] >> 1;
1513       unsigned AsmStrSize = Record[1];
1514       if (2+AsmStrSize >= Record.size())
1515         return Error(InvalidRecord);
1516       unsigned ConstStrSize = Record[2+AsmStrSize];
1517       if (3+AsmStrSize+ConstStrSize > Record.size())
1518         return Error(InvalidRecord);
1519
1520       for (unsigned i = 0; i != AsmStrSize; ++i)
1521         AsmStr += (char)Record[2+i];
1522       for (unsigned i = 0; i != ConstStrSize; ++i)
1523         ConstrStr += (char)Record[3+AsmStrSize+i];
1524       PointerType *PTy = cast<PointerType>(CurTy);
1525       V = InlineAsm::get(cast<FunctionType>(PTy->getElementType()),
1526                          AsmStr, ConstrStr, HasSideEffects, IsAlignStack);
1527       break;
1528     }
1529     // This version adds support for the asm dialect keywords (e.g.,
1530     // inteldialect).
1531     case bitc::CST_CODE_INLINEASM: {
1532       if (Record.size() < 2)
1533         return Error(InvalidRecord);
1534       std::string AsmStr, ConstrStr;
1535       bool HasSideEffects = Record[0] & 1;
1536       bool IsAlignStack = (Record[0] >> 1) & 1;
1537       unsigned AsmDialect = Record[0] >> 2;
1538       unsigned AsmStrSize = Record[1];
1539       if (2+AsmStrSize >= Record.size())
1540         return Error(InvalidRecord);
1541       unsigned ConstStrSize = Record[2+AsmStrSize];
1542       if (3+AsmStrSize+ConstStrSize > Record.size())
1543         return Error(InvalidRecord);
1544
1545       for (unsigned i = 0; i != AsmStrSize; ++i)
1546         AsmStr += (char)Record[2+i];
1547       for (unsigned i = 0; i != ConstStrSize; ++i)
1548         ConstrStr += (char)Record[3+AsmStrSize+i];
1549       PointerType *PTy = cast<PointerType>(CurTy);
1550       V = InlineAsm::get(cast<FunctionType>(PTy->getElementType()),
1551                          AsmStr, ConstrStr, HasSideEffects, IsAlignStack,
1552                          InlineAsm::AsmDialect(AsmDialect));
1553       break;
1554     }
1555     case bitc::CST_CODE_BLOCKADDRESS:{
1556       if (Record.size() < 3)
1557         return Error(InvalidRecord);
1558       Type *FnTy = getTypeByID(Record[0]);
1559       if (!FnTy)
1560         return Error(InvalidRecord);
1561       Function *Fn =
1562         dyn_cast_or_null<Function>(ValueList.getConstantFwdRef(Record[1],FnTy));
1563       if (!Fn)
1564         return Error(InvalidRecord);
1565
1566       // If the function is already parsed we can insert the block address right
1567       // away.
1568       if (!Fn->empty()) {
1569         Function::iterator BBI = Fn->begin(), BBE = Fn->end();
1570         for (size_t I = 0, E = Record[2]; I != E; ++I) {
1571           if (BBI == BBE)
1572             return Error(InvalidID);
1573           ++BBI;
1574         }
1575         V = BlockAddress::get(Fn, BBI);
1576       } else {
1577         // Otherwise insert a placeholder and remember it so it can be inserted
1578         // when the function is parsed.
1579         GlobalVariable *FwdRef = new GlobalVariable(*Fn->getParent(),
1580                                                     Type::getInt8Ty(Context),
1581                                             false, GlobalValue::InternalLinkage,
1582                                                     nullptr, "");
1583         BlockAddrFwdRefs[Fn].push_back(std::make_pair(Record[2], FwdRef));
1584         V = FwdRef;
1585       }
1586       break;
1587     }
1588     }
1589
1590     ValueList.AssignValue(V, NextCstNo);
1591     ++NextCstNo;
1592   }
1593 }
1594
1595 error_code BitcodeReader::ParseUseLists() {
1596   if (Stream.EnterSubBlock(bitc::USELIST_BLOCK_ID))
1597     return Error(InvalidRecord);
1598
1599   SmallVector<uint64_t, 64> Record;
1600
1601   // Read all the records.
1602   while (1) {
1603     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
1604
1605     switch (Entry.Kind) {
1606     case BitstreamEntry::SubBlock: // Handled for us already.
1607     case BitstreamEntry::Error:
1608       return Error(MalformedBlock);
1609     case BitstreamEntry::EndBlock:
1610       return error_code::success();
1611     case BitstreamEntry::Record:
1612       // The interesting case.
1613       break;
1614     }
1615
1616     // Read a use list record.
1617     Record.clear();
1618     switch (Stream.readRecord(Entry.ID, Record)) {
1619     default:  // Default behavior: unknown type.
1620       break;
1621     case bitc::USELIST_CODE_ENTRY: { // USELIST_CODE_ENTRY: TBD.
1622       unsigned RecordLength = Record.size();
1623       if (RecordLength < 1)
1624         return Error(InvalidRecord);
1625       UseListRecords.push_back(Record);
1626       break;
1627     }
1628     }
1629   }
1630 }
1631
1632 /// RememberAndSkipFunctionBody - When we see the block for a function body,
1633 /// remember where it is and then skip it.  This lets us lazily deserialize the
1634 /// functions.
1635 error_code BitcodeReader::RememberAndSkipFunctionBody() {
1636   // Get the function we are talking about.
1637   if (FunctionsWithBodies.empty())
1638     return Error(InsufficientFunctionProtos);
1639
1640   Function *Fn = FunctionsWithBodies.back();
1641   FunctionsWithBodies.pop_back();
1642
1643   // Save the current stream state.
1644   uint64_t CurBit = Stream.GetCurrentBitNo();
1645   DeferredFunctionInfo[Fn] = CurBit;
1646
1647   // Skip over the function block for now.
1648   if (Stream.SkipBlock())
1649     return Error(InvalidRecord);
1650   return error_code::success();
1651 }
1652
1653 error_code BitcodeReader::GlobalCleanup() {
1654   // Patch the initializers for globals and aliases up.
1655   ResolveGlobalAndAliasInits();
1656   if (!GlobalInits.empty() || !AliasInits.empty())
1657     return Error(MalformedGlobalInitializerSet);
1658
1659   // Look for intrinsic functions which need to be upgraded at some point
1660   for (Module::iterator FI = TheModule->begin(), FE = TheModule->end();
1661        FI != FE; ++FI) {
1662     Function *NewFn;
1663     if (UpgradeIntrinsicFunction(FI, NewFn))
1664       UpgradedIntrinsics.push_back(std::make_pair(FI, NewFn));
1665   }
1666
1667   // Look for global variables which need to be renamed.
1668   for (Module::global_iterator
1669          GI = TheModule->global_begin(), GE = TheModule->global_end();
1670        GI != GE; ++GI)
1671     UpgradeGlobalVariable(GI);
1672   // Force deallocation of memory for these vectors to favor the client that
1673   // want lazy deserialization.
1674   std::vector<std::pair<GlobalVariable*, unsigned> >().swap(GlobalInits);
1675   std::vector<std::pair<GlobalAlias*, unsigned> >().swap(AliasInits);
1676   return error_code::success();
1677 }
1678
1679 error_code BitcodeReader::ParseModule(bool Resume) {
1680   if (Resume)
1681     Stream.JumpToBit(NextUnreadBit);
1682   else if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
1683     return Error(InvalidRecord);
1684
1685   SmallVector<uint64_t, 64> Record;
1686   std::vector<std::string> SectionTable;
1687   std::vector<std::string> GCTable;
1688
1689   // Read all the records for this module.
1690   while (1) {
1691     BitstreamEntry Entry = Stream.advance();
1692
1693     switch (Entry.Kind) {
1694     case BitstreamEntry::Error:
1695       return Error(MalformedBlock);
1696     case BitstreamEntry::EndBlock:
1697       return GlobalCleanup();
1698
1699     case BitstreamEntry::SubBlock:
1700       switch (Entry.ID) {
1701       default:  // Skip unknown content.
1702         if (Stream.SkipBlock())
1703           return Error(InvalidRecord);
1704         break;
1705       case bitc::BLOCKINFO_BLOCK_ID:
1706         if (Stream.ReadBlockInfoBlock())
1707           return Error(MalformedBlock);
1708         break;
1709       case bitc::PARAMATTR_BLOCK_ID:
1710         if (error_code EC = ParseAttributeBlock())
1711           return EC;
1712         break;
1713       case bitc::PARAMATTR_GROUP_BLOCK_ID:
1714         if (error_code EC = ParseAttributeGroupBlock())
1715           return EC;
1716         break;
1717       case bitc::TYPE_BLOCK_ID_NEW:
1718         if (error_code EC = ParseTypeTable())
1719           return EC;
1720         break;
1721       case bitc::VALUE_SYMTAB_BLOCK_ID:
1722         if (error_code EC = ParseValueSymbolTable())
1723           return EC;
1724         SeenValueSymbolTable = true;
1725         break;
1726       case bitc::CONSTANTS_BLOCK_ID:
1727         if (error_code EC = ParseConstants())
1728           return EC;
1729         if (error_code EC = ResolveGlobalAndAliasInits())
1730           return EC;
1731         break;
1732       case bitc::METADATA_BLOCK_ID:
1733         if (error_code EC = ParseMetadata())
1734           return EC;
1735         break;
1736       case bitc::FUNCTION_BLOCK_ID:
1737         // If this is the first function body we've seen, reverse the
1738         // FunctionsWithBodies list.
1739         if (!SeenFirstFunctionBody) {
1740           std::reverse(FunctionsWithBodies.begin(), FunctionsWithBodies.end());
1741           if (error_code EC = GlobalCleanup())
1742             return EC;
1743           SeenFirstFunctionBody = true;
1744         }
1745
1746         if (error_code EC = RememberAndSkipFunctionBody())
1747           return EC;
1748         // For streaming bitcode, suspend parsing when we reach the function
1749         // bodies. Subsequent materialization calls will resume it when
1750         // necessary. For streaming, the function bodies must be at the end of
1751         // the bitcode. If the bitcode file is old, the symbol table will be
1752         // at the end instead and will not have been seen yet. In this case,
1753         // just finish the parse now.
1754         if (LazyStreamer && SeenValueSymbolTable) {
1755           NextUnreadBit = Stream.GetCurrentBitNo();
1756           return error_code::success();
1757         }
1758         break;
1759       case bitc::USELIST_BLOCK_ID:
1760         if (error_code EC = ParseUseLists())
1761           return EC;
1762         break;
1763       }
1764       continue;
1765
1766     case BitstreamEntry::Record:
1767       // The interesting case.
1768       break;
1769     }
1770
1771
1772     // Read a record.
1773     switch (Stream.readRecord(Entry.ID, Record)) {
1774     default: break;  // Default behavior, ignore unknown content.
1775     case bitc::MODULE_CODE_VERSION: {  // VERSION: [version#]
1776       if (Record.size() < 1)
1777         return Error(InvalidRecord);
1778       // Only version #0 and #1 are supported so far.
1779       unsigned module_version = Record[0];
1780       switch (module_version) {
1781         default:
1782           return Error(InvalidValue);
1783         case 0:
1784           UseRelativeIDs = false;
1785           break;
1786         case 1:
1787           UseRelativeIDs = true;
1788           break;
1789       }
1790       break;
1791     }
1792     case bitc::MODULE_CODE_TRIPLE: {  // TRIPLE: [strchr x N]
1793       std::string S;
1794       if (ConvertToString(Record, 0, S))
1795         return Error(InvalidRecord);
1796       TheModule->setTargetTriple(S);
1797       break;
1798     }
1799     case bitc::MODULE_CODE_DATALAYOUT: {  // DATALAYOUT: [strchr x N]
1800       std::string S;
1801       if (ConvertToString(Record, 0, S))
1802         return Error(InvalidRecord);
1803       TheModule->setDataLayout(S);
1804       break;
1805     }
1806     case bitc::MODULE_CODE_ASM: {  // ASM: [strchr x N]
1807       std::string S;
1808       if (ConvertToString(Record, 0, S))
1809         return Error(InvalidRecord);
1810       TheModule->setModuleInlineAsm(S);
1811       break;
1812     }
1813     case bitc::MODULE_CODE_DEPLIB: {  // DEPLIB: [strchr x N]
1814       // FIXME: Remove in 4.0.
1815       std::string S;
1816       if (ConvertToString(Record, 0, S))
1817         return Error(InvalidRecord);
1818       // Ignore value.
1819       break;
1820     }
1821     case bitc::MODULE_CODE_SECTIONNAME: {  // SECTIONNAME: [strchr x N]
1822       std::string S;
1823       if (ConvertToString(Record, 0, S))
1824         return Error(InvalidRecord);
1825       SectionTable.push_back(S);
1826       break;
1827     }
1828     case bitc::MODULE_CODE_GCNAME: {  // SECTIONNAME: [strchr x N]
1829       std::string S;
1830       if (ConvertToString(Record, 0, S))
1831         return Error(InvalidRecord);
1832       GCTable.push_back(S);
1833       break;
1834     }
1835     // GLOBALVAR: [pointer type, isconst, initid,
1836     //             linkage, alignment, section, visibility, threadlocal,
1837     //             unnamed_addr, dllstorageclass]
1838     case bitc::MODULE_CODE_GLOBALVAR: {
1839       if (Record.size() < 6)
1840         return Error(InvalidRecord);
1841       Type *Ty = getTypeByID(Record[0]);
1842       if (!Ty)
1843         return Error(InvalidRecord);
1844       if (!Ty->isPointerTy())
1845         return Error(InvalidTypeForValue);
1846       unsigned AddressSpace = cast<PointerType>(Ty)->getAddressSpace();
1847       Ty = cast<PointerType>(Ty)->getElementType();
1848
1849       bool isConstant = Record[1];
1850       GlobalValue::LinkageTypes Linkage = GetDecodedLinkage(Record[3]);
1851       unsigned Alignment = (1 << Record[4]) >> 1;
1852       std::string Section;
1853       if (Record[5]) {
1854         if (Record[5]-1 >= SectionTable.size())
1855           return Error(InvalidID);
1856         Section = SectionTable[Record[5]-1];
1857       }
1858       GlobalValue::VisibilityTypes Visibility = GlobalValue::DefaultVisibility;
1859       // Local linkage must have default visibility.
1860       if (Record.size() > 6 && !GlobalValue::isLocalLinkage(Linkage))
1861         // FIXME: Change to an error if non-default in 4.0.
1862         Visibility = GetDecodedVisibility(Record[6]);
1863
1864       GlobalVariable::ThreadLocalMode TLM = GlobalVariable::NotThreadLocal;
1865       if (Record.size() > 7)
1866         TLM = GetDecodedThreadLocalMode(Record[7]);
1867
1868       bool UnnamedAddr = false;
1869       if (Record.size() > 8)
1870         UnnamedAddr = Record[8];
1871
1872       bool ExternallyInitialized = false;
1873       if (Record.size() > 9)
1874         ExternallyInitialized = Record[9];
1875
1876       GlobalVariable *NewGV =
1877         new GlobalVariable(*TheModule, Ty, isConstant, Linkage, nullptr, "", nullptr,
1878                            TLM, AddressSpace, ExternallyInitialized);
1879       NewGV->setAlignment(Alignment);
1880       if (!Section.empty())
1881         NewGV->setSection(Section);
1882       NewGV->setVisibility(Visibility);
1883       NewGV->setUnnamedAddr(UnnamedAddr);
1884
1885       if (Record.size() > 10)
1886         NewGV->setDLLStorageClass(GetDecodedDLLStorageClass(Record[10]));
1887       else
1888         UpgradeDLLImportExportLinkage(NewGV, Record[3]);
1889
1890       ValueList.push_back(NewGV);
1891
1892       // Remember which value to use for the global initializer.
1893       if (unsigned InitID = Record[2])
1894         GlobalInits.push_back(std::make_pair(NewGV, InitID-1));
1895       break;
1896     }
1897     // FUNCTION:  [type, callingconv, isproto, linkage, paramattr,
1898     //             alignment, section, visibility, gc, unnamed_addr,
1899     //             dllstorageclass]
1900     case bitc::MODULE_CODE_FUNCTION: {
1901       if (Record.size() < 8)
1902         return Error(InvalidRecord);
1903       Type *Ty = getTypeByID(Record[0]);
1904       if (!Ty)
1905         return Error(InvalidRecord);
1906       if (!Ty->isPointerTy())
1907         return Error(InvalidTypeForValue);
1908       FunctionType *FTy =
1909         dyn_cast<FunctionType>(cast<PointerType>(Ty)->getElementType());
1910       if (!FTy)
1911         return Error(InvalidTypeForValue);
1912
1913       Function *Func = Function::Create(FTy, GlobalValue::ExternalLinkage,
1914                                         "", TheModule);
1915
1916       Func->setCallingConv(static_cast<CallingConv::ID>(Record[1]));
1917       bool isProto = Record[2];
1918       Func->setLinkage(GetDecodedLinkage(Record[3]));
1919       Func->setAttributes(getAttributes(Record[4]));
1920
1921       Func->setAlignment((1 << Record[5]) >> 1);
1922       if (Record[6]) {
1923         if (Record[6]-1 >= SectionTable.size())
1924           return Error(InvalidID);
1925         Func->setSection(SectionTable[Record[6]-1]);
1926       }
1927       // Local linkage must have default visibility.
1928       if (!Func->hasLocalLinkage())
1929         // FIXME: Change to an error if non-default in 4.0.
1930         Func->setVisibility(GetDecodedVisibility(Record[7]));
1931       if (Record.size() > 8 && Record[8]) {
1932         if (Record[8]-1 > GCTable.size())
1933           return Error(InvalidID);
1934         Func->setGC(GCTable[Record[8]-1].c_str());
1935       }
1936       bool UnnamedAddr = false;
1937       if (Record.size() > 9)
1938         UnnamedAddr = Record[9];
1939       Func->setUnnamedAddr(UnnamedAddr);
1940       if (Record.size() > 10 && Record[10] != 0)
1941         FunctionPrefixes.push_back(std::make_pair(Func, Record[10]-1));
1942
1943       if (Record.size() > 11)
1944         Func->setDLLStorageClass(GetDecodedDLLStorageClass(Record[11]));
1945       else
1946         UpgradeDLLImportExportLinkage(Func, Record[3]);
1947
1948       ValueList.push_back(Func);
1949
1950       // If this is a function with a body, remember the prototype we are
1951       // creating now, so that we can match up the body with them later.
1952       if (!isProto) {
1953         FunctionsWithBodies.push_back(Func);
1954         if (LazyStreamer) DeferredFunctionInfo[Func] = 0;
1955       }
1956       break;
1957     }
1958     // ALIAS: [alias type, aliasee val#, linkage]
1959     // ALIAS: [alias type, aliasee val#, linkage, visibility, dllstorageclass]
1960     case bitc::MODULE_CODE_ALIAS: {
1961       if (Record.size() < 3)
1962         return Error(InvalidRecord);
1963       Type *Ty = getTypeByID(Record[0]);
1964       if (!Ty)
1965         return Error(InvalidRecord);
1966       auto *PTy = dyn_cast<PointerType>(Ty);
1967       if (!PTy)
1968         return Error(InvalidTypeForValue);
1969
1970       auto *NewGA =
1971           new GlobalAlias(PTy->getElementType(), GetDecodedLinkage(Record[2]),
1972                           "", nullptr, TheModule, PTy->getAddressSpace());
1973       // Old bitcode files didn't have visibility field.
1974       // Local linkage must have default visibility.
1975       if (Record.size() > 3 && !NewGA->hasLocalLinkage())
1976         // FIXME: Change to an error if non-default in 4.0.
1977         NewGA->setVisibility(GetDecodedVisibility(Record[3]));
1978       if (Record.size() > 4)
1979         NewGA->setDLLStorageClass(GetDecodedDLLStorageClass(Record[4]));
1980       else
1981         UpgradeDLLImportExportLinkage(NewGA, Record[2]);
1982       ValueList.push_back(NewGA);
1983       AliasInits.push_back(std::make_pair(NewGA, Record[1]));
1984       break;
1985     }
1986     /// MODULE_CODE_PURGEVALS: [numvals]
1987     case bitc::MODULE_CODE_PURGEVALS:
1988       // Trim down the value list to the specified size.
1989       if (Record.size() < 1 || Record[0] > ValueList.size())
1990         return Error(InvalidRecord);
1991       ValueList.shrinkTo(Record[0]);
1992       break;
1993     }
1994     Record.clear();
1995   }
1996 }
1997
1998 error_code BitcodeReader::ParseBitcodeInto(Module *M) {
1999   TheModule = nullptr;
2000
2001   if (error_code EC = InitStream())
2002     return EC;
2003
2004   // Sniff for the signature.
2005   if (Stream.Read(8) != 'B' ||
2006       Stream.Read(8) != 'C' ||
2007       Stream.Read(4) != 0x0 ||
2008       Stream.Read(4) != 0xC ||
2009       Stream.Read(4) != 0xE ||
2010       Stream.Read(4) != 0xD)
2011     return Error(InvalidBitcodeSignature);
2012
2013   // We expect a number of well-defined blocks, though we don't necessarily
2014   // need to understand them all.
2015   while (1) {
2016     if (Stream.AtEndOfStream())
2017       return error_code::success();
2018
2019     BitstreamEntry Entry =
2020       Stream.advance(BitstreamCursor::AF_DontAutoprocessAbbrevs);
2021
2022     switch (Entry.Kind) {
2023     case BitstreamEntry::Error:
2024       return Error(MalformedBlock);
2025     case BitstreamEntry::EndBlock:
2026       return error_code::success();
2027
2028     case BitstreamEntry::SubBlock:
2029       switch (Entry.ID) {
2030       case bitc::BLOCKINFO_BLOCK_ID:
2031         if (Stream.ReadBlockInfoBlock())
2032           return Error(MalformedBlock);
2033         break;
2034       case bitc::MODULE_BLOCK_ID:
2035         // Reject multiple MODULE_BLOCK's in a single bitstream.
2036         if (TheModule)
2037           return Error(InvalidMultipleBlocks);
2038         TheModule = M;
2039         if (error_code EC = ParseModule(false))
2040           return EC;
2041         if (LazyStreamer)
2042           return error_code::success();
2043         break;
2044       default:
2045         if (Stream.SkipBlock())
2046           return Error(InvalidRecord);
2047         break;
2048       }
2049       continue;
2050     case BitstreamEntry::Record:
2051       // There should be no records in the top-level of blocks.
2052
2053       // The ranlib in Xcode 4 will align archive members by appending newlines
2054       // to the end of them. If this file size is a multiple of 4 but not 8, we
2055       // have to read and ignore these final 4 bytes :-(
2056       if (Stream.getAbbrevIDWidth() == 2 && Entry.ID == 2 &&
2057           Stream.Read(6) == 2 && Stream.Read(24) == 0xa0a0a &&
2058           Stream.AtEndOfStream())
2059         return error_code::success();
2060
2061       return Error(InvalidRecord);
2062     }
2063   }
2064 }
2065
2066 error_code BitcodeReader::ParseModuleTriple(std::string &Triple) {
2067   if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
2068     return Error(InvalidRecord);
2069
2070   SmallVector<uint64_t, 64> Record;
2071
2072   // Read all the records for this module.
2073   while (1) {
2074     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
2075
2076     switch (Entry.Kind) {
2077     case BitstreamEntry::SubBlock: // Handled for us already.
2078     case BitstreamEntry::Error:
2079       return Error(MalformedBlock);
2080     case BitstreamEntry::EndBlock:
2081       return error_code::success();
2082     case BitstreamEntry::Record:
2083       // The interesting case.
2084       break;
2085     }
2086
2087     // Read a record.
2088     switch (Stream.readRecord(Entry.ID, Record)) {
2089     default: break;  // Default behavior, ignore unknown content.
2090     case bitc::MODULE_CODE_TRIPLE: {  // TRIPLE: [strchr x N]
2091       std::string S;
2092       if (ConvertToString(Record, 0, S))
2093         return Error(InvalidRecord);
2094       Triple = S;
2095       break;
2096     }
2097     }
2098     Record.clear();
2099   }
2100 }
2101
2102 error_code BitcodeReader::ParseTriple(std::string &Triple) {
2103   if (error_code EC = InitStream())
2104     return EC;
2105
2106   // Sniff for the signature.
2107   if (Stream.Read(8) != 'B' ||
2108       Stream.Read(8) != 'C' ||
2109       Stream.Read(4) != 0x0 ||
2110       Stream.Read(4) != 0xC ||
2111       Stream.Read(4) != 0xE ||
2112       Stream.Read(4) != 0xD)
2113     return Error(InvalidBitcodeSignature);
2114
2115   // We expect a number of well-defined blocks, though we don't necessarily
2116   // need to understand them all.
2117   while (1) {
2118     BitstreamEntry Entry = Stream.advance();
2119
2120     switch (Entry.Kind) {
2121     case BitstreamEntry::Error:
2122       return Error(MalformedBlock);
2123     case BitstreamEntry::EndBlock:
2124       return error_code::success();
2125
2126     case BitstreamEntry::SubBlock:
2127       if (Entry.ID == bitc::MODULE_BLOCK_ID)
2128         return ParseModuleTriple(Triple);
2129
2130       // Ignore other sub-blocks.
2131       if (Stream.SkipBlock())
2132         return Error(MalformedBlock);
2133       continue;
2134
2135     case BitstreamEntry::Record:
2136       Stream.skipRecord(Entry.ID);
2137       continue;
2138     }
2139   }
2140 }
2141
2142 /// ParseMetadataAttachment - Parse metadata attachments.
2143 error_code BitcodeReader::ParseMetadataAttachment() {
2144   if (Stream.EnterSubBlock(bitc::METADATA_ATTACHMENT_ID))
2145     return Error(InvalidRecord);
2146
2147   SmallVector<uint64_t, 64> Record;
2148   while (1) {
2149     BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
2150
2151     switch (Entry.Kind) {
2152     case BitstreamEntry::SubBlock: // Handled for us already.
2153     case BitstreamEntry::Error:
2154       return Error(MalformedBlock);
2155     case BitstreamEntry::EndBlock:
2156       return error_code::success();
2157     case BitstreamEntry::Record:
2158       // The interesting case.
2159       break;
2160     }
2161
2162     // Read a metadata attachment record.
2163     Record.clear();
2164     switch (Stream.readRecord(Entry.ID, Record)) {
2165     default:  // Default behavior: ignore.
2166       break;
2167     case bitc::METADATA_ATTACHMENT: {
2168       unsigned RecordLength = Record.size();
2169       if (Record.empty() || (RecordLength - 1) % 2 == 1)
2170         return Error(InvalidRecord);
2171       Instruction *Inst = InstructionList[Record[0]];
2172       for (unsigned i = 1; i != RecordLength; i = i+2) {
2173         unsigned Kind = Record[i];
2174         DenseMap<unsigned, unsigned>::iterator I =
2175           MDKindMap.find(Kind);
2176         if (I == MDKindMap.end())
2177           return Error(InvalidID);
2178         Value *Node = MDValueList.getValueFwdRef(Record[i+1]);
2179         Inst->setMetadata(I->second, cast<MDNode>(Node));
2180         if (I->second == LLVMContext::MD_tbaa)
2181           InstsWithTBAATag.push_back(Inst);
2182       }
2183       break;
2184     }
2185     }
2186   }
2187 }
2188
2189 /// ParseFunctionBody - Lazily parse the specified function body block.
2190 error_code BitcodeReader::ParseFunctionBody(Function *F) {
2191   if (Stream.EnterSubBlock(bitc::FUNCTION_BLOCK_ID))
2192     return Error(InvalidRecord);
2193
2194   InstructionList.clear();
2195   unsigned ModuleValueListSize = ValueList.size();
2196   unsigned ModuleMDValueListSize = MDValueList.size();
2197
2198   // Add all the function arguments to the value table.
2199   for(Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
2200     ValueList.push_back(I);
2201
2202   unsigned NextValueNo = ValueList.size();
2203   BasicBlock *CurBB = nullptr;
2204   unsigned CurBBNo = 0;
2205
2206   DebugLoc LastLoc;
2207
2208   // Read all the records.
2209   SmallVector<uint64_t, 64> Record;
2210   while (1) {
2211     BitstreamEntry Entry = Stream.advance();
2212
2213     switch (Entry.Kind) {
2214     case BitstreamEntry::Error:
2215       return Error(MalformedBlock);
2216     case BitstreamEntry::EndBlock:
2217       goto OutOfRecordLoop;
2218
2219     case BitstreamEntry::SubBlock:
2220       switch (Entry.ID) {
2221       default:  // Skip unknown content.
2222         if (Stream.SkipBlock())
2223           return Error(InvalidRecord);
2224         break;
2225       case bitc::CONSTANTS_BLOCK_ID:
2226         if (error_code EC = ParseConstants())
2227           return EC;
2228         NextValueNo = ValueList.size();
2229         break;
2230       case bitc::VALUE_SYMTAB_BLOCK_ID:
2231         if (error_code EC = ParseValueSymbolTable())
2232           return EC;
2233         break;
2234       case bitc::METADATA_ATTACHMENT_ID:
2235         if (error_code EC = ParseMetadataAttachment())
2236           return EC;
2237         break;
2238       case bitc::METADATA_BLOCK_ID:
2239         if (error_code EC = ParseMetadata())
2240           return EC;
2241         break;
2242       }
2243       continue;
2244
2245     case BitstreamEntry::Record:
2246       // The interesting case.
2247       break;
2248     }
2249
2250     // Read a record.
2251     Record.clear();
2252     Instruction *I = nullptr;
2253     unsigned BitCode = Stream.readRecord(Entry.ID, Record);
2254     switch (BitCode) {
2255     default: // Default behavior: reject
2256       return Error(InvalidValue);
2257     case bitc::FUNC_CODE_DECLAREBLOCKS:     // DECLAREBLOCKS: [nblocks]
2258       if (Record.size() < 1 || Record[0] == 0)
2259         return Error(InvalidRecord);
2260       // Create all the basic blocks for the function.
2261       FunctionBBs.resize(Record[0]);
2262       for (unsigned i = 0, e = FunctionBBs.size(); i != e; ++i)
2263         FunctionBBs[i] = BasicBlock::Create(Context, "", F);
2264       CurBB = FunctionBBs[0];
2265       continue;
2266
2267     case bitc::FUNC_CODE_DEBUG_LOC_AGAIN:  // DEBUG_LOC_AGAIN
2268       // This record indicates that the last instruction is at the same
2269       // location as the previous instruction with a location.
2270       I = nullptr;
2271
2272       // Get the last instruction emitted.
2273       if (CurBB && !CurBB->empty())
2274         I = &CurBB->back();
2275       else if (CurBBNo && FunctionBBs[CurBBNo-1] &&
2276                !FunctionBBs[CurBBNo-1]->empty())
2277         I = &FunctionBBs[CurBBNo-1]->back();
2278
2279       if (!I)
2280         return Error(InvalidRecord);
2281       I->setDebugLoc(LastLoc);
2282       I = nullptr;
2283       continue;
2284
2285     case bitc::FUNC_CODE_DEBUG_LOC: {      // DEBUG_LOC: [line, col, scope, ia]
2286       I = nullptr;     // Get the last instruction emitted.
2287       if (CurBB && !CurBB->empty())
2288         I = &CurBB->back();
2289       else if (CurBBNo && FunctionBBs[CurBBNo-1] &&
2290                !FunctionBBs[CurBBNo-1]->empty())
2291         I = &FunctionBBs[CurBBNo-1]->back();
2292       if (!I || Record.size() < 4)
2293         return Error(InvalidRecord);
2294
2295       unsigned Line = Record[0], Col = Record[1];
2296       unsigned ScopeID = Record[2], IAID = Record[3];
2297
2298       MDNode *Scope = nullptr, *IA = nullptr;
2299       if (ScopeID) Scope = cast<MDNode>(MDValueList.getValueFwdRef(ScopeID-1));
2300       if (IAID)    IA = cast<MDNode>(MDValueList.getValueFwdRef(IAID-1));
2301       LastLoc = DebugLoc::get(Line, Col, Scope, IA);
2302       I->setDebugLoc(LastLoc);
2303       I = nullptr;
2304       continue;
2305     }
2306
2307     case bitc::FUNC_CODE_INST_BINOP: {    // BINOP: [opval, ty, opval, opcode]
2308       unsigned OpNum = 0;
2309       Value *LHS, *RHS;
2310       if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
2311           popValue(Record, OpNum, NextValueNo, LHS->getType(), RHS) ||
2312           OpNum+1 > Record.size())
2313         return Error(InvalidRecord);
2314
2315       int Opc = GetDecodedBinaryOpcode(Record[OpNum++], LHS->getType());
2316       if (Opc == -1)
2317         return Error(InvalidRecord);
2318       I = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);
2319       InstructionList.push_back(I);
2320       if (OpNum < Record.size()) {
2321         if (Opc == Instruction::Add ||
2322             Opc == Instruction::Sub ||
2323             Opc == Instruction::Mul ||
2324             Opc == Instruction::Shl) {
2325           if (Record[OpNum] & (1 << bitc::OBO_NO_SIGNED_WRAP))
2326             cast<BinaryOperator>(I)->setHasNoSignedWrap(true);
2327           if (Record[OpNum] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
2328             cast<BinaryOperator>(I)->setHasNoUnsignedWrap(true);
2329         } else if (Opc == Instruction::SDiv ||
2330                    Opc == Instruction::UDiv ||
2331                    Opc == Instruction::LShr ||
2332                    Opc == Instruction::AShr) {
2333           if (Record[OpNum] & (1 << bitc::PEO_EXACT))
2334             cast<BinaryOperator>(I)->setIsExact(true);
2335         } else if (isa<FPMathOperator>(I)) {
2336           FastMathFlags FMF;
2337           if (0 != (Record[OpNum] & FastMathFlags::UnsafeAlgebra))
2338             FMF.setUnsafeAlgebra();
2339           if (0 != (Record[OpNum] & FastMathFlags::NoNaNs))
2340             FMF.setNoNaNs();
2341           if (0 != (Record[OpNum] & FastMathFlags::NoInfs))
2342             FMF.setNoInfs();
2343           if (0 != (Record[OpNum] & FastMathFlags::NoSignedZeros))
2344             FMF.setNoSignedZeros();
2345           if (0 != (Record[OpNum] & FastMathFlags::AllowReciprocal))
2346             FMF.setAllowReciprocal();
2347           if (FMF.any())
2348             I->setFastMathFlags(FMF);
2349         }
2350
2351       }
2352       break;
2353     }
2354     case bitc::FUNC_CODE_INST_CAST: {    // CAST: [opval, opty, destty, castopc]
2355       unsigned OpNum = 0;
2356       Value *Op;
2357       if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
2358           OpNum+2 != Record.size())
2359         return Error(InvalidRecord);
2360
2361       Type *ResTy = getTypeByID(Record[OpNum]);
2362       int Opc = GetDecodedCastOpcode(Record[OpNum+1]);
2363       if (Opc == -1 || !ResTy)
2364         return Error(InvalidRecord);
2365       Instruction *Temp = nullptr;
2366       if ((I = UpgradeBitCastInst(Opc, Op, ResTy, Temp))) {
2367         if (Temp) {
2368           InstructionList.push_back(Temp);
2369           CurBB->getInstList().push_back(Temp);
2370         }
2371       } else {
2372         I = CastInst::Create((Instruction::CastOps)Opc, Op, ResTy);
2373       }
2374       InstructionList.push_back(I);
2375       break;
2376     }
2377     case bitc::FUNC_CODE_INST_INBOUNDS_GEP:
2378     case bitc::FUNC_CODE_INST_GEP: { // GEP: [n x operands]
2379       unsigned OpNum = 0;
2380       Value *BasePtr;
2381       if (getValueTypePair(Record, OpNum, NextValueNo, BasePtr))
2382         return Error(InvalidRecord);
2383
2384       SmallVector<Value*, 16> GEPIdx;
2385       while (OpNum != Record.size()) {
2386         Value *Op;
2387         if (getValueTypePair(Record, OpNum, NextValueNo, Op))
2388           return Error(InvalidRecord);
2389         GEPIdx.push_back(Op);
2390       }
2391
2392       I = GetElementPtrInst::Create(BasePtr, GEPIdx);
2393       InstructionList.push_back(I);
2394       if (BitCode == bitc::FUNC_CODE_INST_INBOUNDS_GEP)
2395         cast<GetElementPtrInst>(I)->setIsInBounds(true);
2396       break;
2397     }
2398
2399     case bitc::FUNC_CODE_INST_EXTRACTVAL: {
2400                                        // EXTRACTVAL: [opty, opval, n x indices]
2401       unsigned OpNum = 0;
2402       Value *Agg;
2403       if (getValueTypePair(Record, OpNum, NextValueNo, Agg))
2404         return Error(InvalidRecord);
2405
2406       SmallVector<unsigned, 4> EXTRACTVALIdx;
2407       for (unsigned RecSize = Record.size();
2408            OpNum != RecSize; ++OpNum) {
2409         uint64_t Index = Record[OpNum];
2410         if ((unsigned)Index != Index)
2411           return Error(InvalidValue);
2412         EXTRACTVALIdx.push_back((unsigned)Index);
2413       }
2414
2415       I = ExtractValueInst::Create(Agg, EXTRACTVALIdx);
2416       InstructionList.push_back(I);
2417       break;
2418     }
2419
2420     case bitc::FUNC_CODE_INST_INSERTVAL: {
2421                            // INSERTVAL: [opty, opval, opty, opval, n x indices]
2422       unsigned OpNum = 0;
2423       Value *Agg;
2424       if (getValueTypePair(Record, OpNum, NextValueNo, Agg))
2425         return Error(InvalidRecord);
2426       Value *Val;
2427       if (getValueTypePair(Record, OpNum, NextValueNo, Val))
2428         return Error(InvalidRecord);
2429
2430       SmallVector<unsigned, 4> INSERTVALIdx;
2431       for (unsigned RecSize = Record.size();
2432            OpNum != RecSize; ++OpNum) {
2433         uint64_t Index = Record[OpNum];
2434         if ((unsigned)Index != Index)
2435           return Error(InvalidValue);
2436         INSERTVALIdx.push_back((unsigned)Index);
2437       }
2438
2439       I = InsertValueInst::Create(Agg, Val, INSERTVALIdx);
2440       InstructionList.push_back(I);
2441       break;
2442     }
2443
2444     case bitc::FUNC_CODE_INST_SELECT: { // SELECT: [opval, ty, opval, opval]
2445       // obsolete form of select
2446       // handles select i1 ... in old bitcode
2447       unsigned OpNum = 0;
2448       Value *TrueVal, *FalseVal, *Cond;
2449       if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
2450           popValue(Record, OpNum, NextValueNo, TrueVal->getType(), FalseVal) ||
2451           popValue(Record, OpNum, NextValueNo, Type::getInt1Ty(Context), Cond))
2452         return Error(InvalidRecord);
2453
2454       I = SelectInst::Create(Cond, TrueVal, FalseVal);
2455       InstructionList.push_back(I);
2456       break;
2457     }
2458
2459     case bitc::FUNC_CODE_INST_VSELECT: {// VSELECT: [ty,opval,opval,predty,pred]
2460       // new form of select
2461       // handles select i1 or select [N x i1]
2462       unsigned OpNum = 0;
2463       Value *TrueVal, *FalseVal, *Cond;
2464       if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
2465           popValue(Record, OpNum, NextValueNo, TrueVal->getType(), FalseVal) ||
2466           getValueTypePair(Record, OpNum, NextValueNo, Cond))
2467         return Error(InvalidRecord);
2468
2469       // select condition can be either i1 or [N x i1]
2470       if (VectorType* vector_type =
2471           dyn_cast<VectorType>(Cond->getType())) {
2472         // expect <n x i1>
2473         if (vector_type->getElementType() != Type::getInt1Ty(Context))
2474           return Error(InvalidTypeForValue);
2475       } else {
2476         // expect i1
2477         if (Cond->getType() != Type::getInt1Ty(Context))
2478           return Error(InvalidTypeForValue);
2479       }
2480
2481       I = SelectInst::Create(Cond, TrueVal, FalseVal);
2482       InstructionList.push_back(I);
2483       break;
2484     }
2485
2486     case bitc::FUNC_CODE_INST_EXTRACTELT: { // EXTRACTELT: [opty, opval, opval]
2487       unsigned OpNum = 0;
2488       Value *Vec, *Idx;
2489       if (getValueTypePair(Record, OpNum, NextValueNo, Vec) ||
2490           getValueTypePair(Record, OpNum, NextValueNo, Idx))
2491         return Error(InvalidRecord);
2492       I = ExtractElementInst::Create(Vec, Idx);
2493       InstructionList.push_back(I);
2494       break;
2495     }
2496
2497     case bitc::FUNC_CODE_INST_INSERTELT: { // INSERTELT: [ty, opval,opval,opval]
2498       unsigned OpNum = 0;
2499       Value *Vec, *Elt, *Idx;
2500       if (getValueTypePair(Record, OpNum, NextValueNo, Vec) ||
2501           popValue(Record, OpNum, NextValueNo,
2502                    cast<VectorType>(Vec->getType())->getElementType(), Elt) ||
2503           getValueTypePair(Record, OpNum, NextValueNo, Idx))
2504         return Error(InvalidRecord);
2505       I = InsertElementInst::Create(Vec, Elt, Idx);
2506       InstructionList.push_back(I);
2507       break;
2508     }
2509
2510     case bitc::FUNC_CODE_INST_SHUFFLEVEC: {// SHUFFLEVEC: [opval,ty,opval,opval]
2511       unsigned OpNum = 0;
2512       Value *Vec1, *Vec2, *Mask;
2513       if (getValueTypePair(Record, OpNum, NextValueNo, Vec1) ||
2514           popValue(Record, OpNum, NextValueNo, Vec1->getType(), Vec2))
2515         return Error(InvalidRecord);
2516
2517       if (getValueTypePair(Record, OpNum, NextValueNo, Mask))
2518         return Error(InvalidRecord);
2519       I = new ShuffleVectorInst(Vec1, Vec2, Mask);
2520       InstructionList.push_back(I);
2521       break;
2522     }
2523
2524     case bitc::FUNC_CODE_INST_CMP:   // CMP: [opty, opval, opval, pred]
2525       // Old form of ICmp/FCmp returning bool
2526       // Existed to differentiate between icmp/fcmp and vicmp/vfcmp which were
2527       // both legal on vectors but had different behaviour.
2528     case bitc::FUNC_CODE_INST_CMP2: { // CMP2: [opty, opval, opval, pred]
2529       // FCmp/ICmp returning bool or vector of bool
2530
2531       unsigned OpNum = 0;
2532       Value *LHS, *RHS;
2533       if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
2534           popValue(Record, OpNum, NextValueNo, LHS->getType(), RHS) ||
2535           OpNum+1 != Record.size())
2536         return Error(InvalidRecord);
2537
2538       if (LHS->getType()->isFPOrFPVectorTy())
2539         I = new FCmpInst((FCmpInst::Predicate)Record[OpNum], LHS, RHS);
2540       else
2541         I = new ICmpInst((ICmpInst::Predicate)Record[OpNum], LHS, RHS);
2542       InstructionList.push_back(I);
2543       break;
2544     }
2545
2546     case bitc::FUNC_CODE_INST_RET: // RET: [opty,opval<optional>]
2547       {
2548         unsigned Size = Record.size();
2549         if (Size == 0) {
2550           I = ReturnInst::Create(Context);
2551           InstructionList.push_back(I);
2552           break;
2553         }
2554
2555         unsigned OpNum = 0;
2556         Value *Op = nullptr;
2557         if (getValueTypePair(Record, OpNum, NextValueNo, Op))
2558           return Error(InvalidRecord);
2559         if (OpNum != Record.size())
2560           return Error(InvalidRecord);
2561
2562         I = ReturnInst::Create(Context, Op);
2563         InstructionList.push_back(I);
2564         break;
2565       }
2566     case bitc::FUNC_CODE_INST_BR: { // BR: [bb#, bb#, opval] or [bb#]
2567       if (Record.size() != 1 && Record.size() != 3)
2568         return Error(InvalidRecord);
2569       BasicBlock *TrueDest = getBasicBlock(Record[0]);
2570       if (!TrueDest)
2571         return Error(InvalidRecord);
2572
2573       if (Record.size() == 1) {
2574         I = BranchInst::Create(TrueDest);
2575         InstructionList.push_back(I);
2576       }
2577       else {
2578         BasicBlock *FalseDest = getBasicBlock(Record[1]);
2579         Value *Cond = getValue(Record, 2, NextValueNo,
2580                                Type::getInt1Ty(Context));
2581         if (!FalseDest || !Cond)
2582           return Error(InvalidRecord);
2583         I = BranchInst::Create(TrueDest, FalseDest, Cond);
2584         InstructionList.push_back(I);
2585       }
2586       break;
2587     }
2588     case bitc::FUNC_CODE_INST_SWITCH: { // SWITCH: [opty, op0, op1, ...]
2589       // Check magic
2590       if ((Record[0] >> 16) == SWITCH_INST_MAGIC) {
2591         // "New" SwitchInst format with case ranges. The changes to write this
2592         // format were reverted but we still recognize bitcode that uses it.
2593         // Hopefully someday we will have support for case ranges and can use
2594         // this format again.
2595
2596         Type *OpTy = getTypeByID(Record[1]);
2597         unsigned ValueBitWidth = cast<IntegerType>(OpTy)->getBitWidth();
2598
2599         Value *Cond = getValue(Record, 2, NextValueNo, OpTy);
2600         BasicBlock *Default = getBasicBlock(Record[3]);
2601         if (!OpTy || !Cond || !Default)
2602           return Error(InvalidRecord);
2603
2604         unsigned NumCases = Record[4];
2605
2606         SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);
2607         InstructionList.push_back(SI);
2608
2609         unsigned CurIdx = 5;
2610         for (unsigned i = 0; i != NumCases; ++i) {
2611           SmallVector<ConstantInt*, 1> CaseVals;
2612           unsigned NumItems = Record[CurIdx++];
2613           for (unsigned ci = 0; ci != NumItems; ++ci) {
2614             bool isSingleNumber = Record[CurIdx++];
2615
2616             APInt Low;
2617             unsigned ActiveWords = 1;
2618             if (ValueBitWidth > 64)
2619               ActiveWords = Record[CurIdx++];
2620             Low = ReadWideAPInt(makeArrayRef(&Record[CurIdx], ActiveWords),
2621                                 ValueBitWidth);
2622             CurIdx += ActiveWords;
2623
2624             if (!isSingleNumber) {
2625               ActiveWords = 1;
2626               if (ValueBitWidth > 64)
2627                 ActiveWords = Record[CurIdx++];
2628               APInt High =
2629                   ReadWideAPInt(makeArrayRef(&Record[CurIdx], ActiveWords),
2630                                 ValueBitWidth);
2631               CurIdx += ActiveWords;
2632
2633               // FIXME: It is not clear whether values in the range should be
2634               // compared as signed or unsigned values. The partially
2635               // implemented changes that used this format in the past used
2636               // unsigned comparisons.
2637               for ( ; Low.ule(High); ++Low)
2638                 CaseVals.push_back(ConstantInt::get(Context, Low));
2639             } else
2640               CaseVals.push_back(ConstantInt::get(Context, Low));
2641           }
2642           BasicBlock *DestBB = getBasicBlock(Record[CurIdx++]);
2643           for (SmallVector<ConstantInt*, 1>::iterator cvi = CaseVals.begin(),
2644                  cve = CaseVals.end(); cvi != cve; ++cvi)
2645             SI->addCase(*cvi, DestBB);
2646         }
2647         I = SI;
2648         break;
2649       }
2650
2651       // Old SwitchInst format without case ranges.
2652
2653       if (Record.size() < 3 || (Record.size() & 1) == 0)
2654         return Error(InvalidRecord);
2655       Type *OpTy = getTypeByID(Record[0]);
2656       Value *Cond = getValue(Record, 1, NextValueNo, OpTy);
2657       BasicBlock *Default = getBasicBlock(Record[2]);
2658       if (!OpTy || !Cond || !Default)
2659         return Error(InvalidRecord);
2660       unsigned NumCases = (Record.size()-3)/2;
2661       SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);
2662       InstructionList.push_back(SI);
2663       for (unsigned i = 0, e = NumCases; i != e; ++i) {
2664         ConstantInt *CaseVal =
2665           dyn_cast_or_null<ConstantInt>(getFnValueByID(Record[3+i*2], OpTy));
2666         BasicBlock *DestBB = getBasicBlock(Record[1+3+i*2]);
2667         if (!CaseVal || !DestBB) {
2668           delete SI;
2669           return Error(InvalidRecord);
2670         }
2671         SI->addCase(CaseVal, DestBB);
2672       }
2673       I = SI;
2674       break;
2675     }
2676     case bitc::FUNC_CODE_INST_INDIRECTBR: { // INDIRECTBR: [opty, op0, op1, ...]
2677       if (Record.size() < 2)
2678         return Error(InvalidRecord);
2679       Type *OpTy = getTypeByID(Record[0]);
2680       Value *Address = getValue(Record, 1, NextValueNo, OpTy);
2681       if (!OpTy || !Address)
2682         return Error(InvalidRecord);
2683       unsigned NumDests = Record.size()-2;
2684       IndirectBrInst *IBI = IndirectBrInst::Create(Address, NumDests);
2685       InstructionList.push_back(IBI);
2686       for (unsigned i = 0, e = NumDests; i != e; ++i) {
2687         if (BasicBlock *DestBB = getBasicBlock(Record[2+i])) {
2688           IBI->addDestination(DestBB);
2689         } else {
2690           delete IBI;
2691           return Error(InvalidRecord);
2692         }
2693       }
2694       I = IBI;
2695       break;
2696     }
2697
2698     case bitc::FUNC_CODE_INST_INVOKE: {
2699       // INVOKE: [attrs, cc, normBB, unwindBB, fnty, op0,op1,op2, ...]
2700       if (Record.size() < 4)
2701         return Error(InvalidRecord);
2702       AttributeSet PAL = getAttributes(Record[0]);
2703       unsigned CCInfo = Record[1];
2704       BasicBlock *NormalBB = getBasicBlock(Record[2]);
2705       BasicBlock *UnwindBB = getBasicBlock(Record[3]);
2706
2707       unsigned OpNum = 4;
2708       Value *Callee;
2709       if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
2710         return Error(InvalidRecord);
2711
2712       PointerType *CalleeTy = dyn_cast<PointerType>(Callee->getType());
2713       FunctionType *FTy = !CalleeTy ? nullptr :
2714         dyn_cast<FunctionType>(CalleeTy->getElementType());
2715
2716       // Check that the right number of fixed parameters are here.
2717       if (!FTy || !NormalBB || !UnwindBB ||
2718           Record.size() < OpNum+FTy->getNumParams())
2719         return Error(InvalidRecord);
2720
2721       SmallVector<Value*, 16> Ops;
2722       for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
2723         Ops.push_back(getValue(Record, OpNum, NextValueNo,
2724                                FTy->getParamType(i)));
2725         if (!Ops.back())
2726           return Error(InvalidRecord);
2727       }
2728
2729       if (!FTy->isVarArg()) {
2730         if (Record.size() != OpNum)
2731           return Error(InvalidRecord);
2732       } else {
2733         // Read type/value pairs for varargs params.
2734         while (OpNum != Record.size()) {
2735           Value *Op;
2736           if (getValueTypePair(Record, OpNum, NextValueNo, Op))
2737             return Error(InvalidRecord);
2738           Ops.push_back(Op);
2739         }
2740       }
2741
2742       I = InvokeInst::Create(Callee, NormalBB, UnwindBB, Ops);
2743       InstructionList.push_back(I);
2744       cast<InvokeInst>(I)->setCallingConv(
2745         static_cast<CallingConv::ID>(CCInfo));
2746       cast<InvokeInst>(I)->setAttributes(PAL);
2747       break;
2748     }
2749     case bitc::FUNC_CODE_INST_RESUME: { // RESUME: [opval]
2750       unsigned Idx = 0;
2751       Value *Val = nullptr;
2752       if (getValueTypePair(Record, Idx, NextValueNo, Val))
2753         return Error(InvalidRecord);
2754       I = ResumeInst::Create(Val);
2755       InstructionList.push_back(I);
2756       break;
2757     }
2758     case bitc::FUNC_CODE_INST_UNREACHABLE: // UNREACHABLE
2759       I = new UnreachableInst(Context);
2760       InstructionList.push_back(I);
2761       break;
2762     case bitc::FUNC_CODE_INST_PHI: { // PHI: [ty, val0,bb0, ...]
2763       if (Record.size() < 1 || ((Record.size()-1)&1))
2764         return Error(InvalidRecord);
2765       Type *Ty = getTypeByID(Record[0]);
2766       if (!Ty)
2767         return Error(InvalidRecord);
2768
2769       PHINode *PN = PHINode::Create(Ty, (Record.size()-1)/2);
2770       InstructionList.push_back(PN);
2771
2772       for (unsigned i = 0, e = Record.size()-1; i != e; i += 2) {
2773         Value *V;
2774         // With the new function encoding, it is possible that operands have
2775         // negative IDs (for forward references).  Use a signed VBR
2776         // representation to keep the encoding small.
2777         if (UseRelativeIDs)
2778           V = getValueSigned(Record, 1+i, NextValueNo, Ty);
2779         else
2780           V = getValue(Record, 1+i, NextValueNo, Ty);
2781         BasicBlock *BB = getBasicBlock(Record[2+i]);
2782         if (!V || !BB)
2783           return Error(InvalidRecord);
2784         PN->addIncoming(V, BB);
2785       }
2786       I = PN;
2787       break;
2788     }
2789
2790     case bitc::FUNC_CODE_INST_LANDINGPAD: {
2791       // LANDINGPAD: [ty, val, val, num, (id0,val0 ...)?]
2792       unsigned Idx = 0;
2793       if (Record.size() < 4)
2794         return Error(InvalidRecord);
2795       Type *Ty = getTypeByID(Record[Idx++]);
2796       if (!Ty)
2797         return Error(InvalidRecord);
2798       Value *PersFn = nullptr;
2799       if (getValueTypePair(Record, Idx, NextValueNo, PersFn))
2800         return Error(InvalidRecord);
2801
2802       bool IsCleanup = !!Record[Idx++];
2803       unsigned NumClauses = Record[Idx++];
2804       LandingPadInst *LP = LandingPadInst::Create(Ty, PersFn, NumClauses);
2805       LP->setCleanup(IsCleanup);
2806       for (unsigned J = 0; J != NumClauses; ++J) {
2807         LandingPadInst::ClauseType CT =
2808           LandingPadInst::ClauseType(Record[Idx++]); (void)CT;
2809         Value *Val;
2810
2811         if (getValueTypePair(Record, Idx, NextValueNo, Val)) {
2812           delete LP;
2813           return Error(InvalidRecord);
2814         }
2815
2816         assert((CT != LandingPadInst::Catch ||
2817                 !isa<ArrayType>(Val->getType())) &&
2818                "Catch clause has a invalid type!");
2819         assert((CT != LandingPadInst::Filter ||
2820                 isa<ArrayType>(Val->getType())) &&
2821                "Filter clause has invalid type!");
2822         LP->addClause(Val);
2823       }
2824
2825       I = LP;
2826       InstructionList.push_back(I);
2827       break;
2828     }
2829
2830     case bitc::FUNC_CODE_INST_ALLOCA: { // ALLOCA: [instty, opty, op, align]
2831       if (Record.size() != 4)
2832         return Error(InvalidRecord);
2833       PointerType *Ty =
2834         dyn_cast_or_null<PointerType>(getTypeByID(Record[0]));
2835       Type *OpTy = getTypeByID(Record[1]);
2836       Value *Size = getFnValueByID(Record[2], OpTy);
2837       unsigned Align = Record[3];
2838       if (!Ty || !Size)
2839         return Error(InvalidRecord);
2840       I = new AllocaInst(Ty->getElementType(), Size, (1 << Align) >> 1);
2841       InstructionList.push_back(I);
2842       break;
2843     }
2844     case bitc::FUNC_CODE_INST_LOAD: { // LOAD: [opty, op, align, vol]
2845       unsigned OpNum = 0;
2846       Value *Op;
2847       if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
2848           OpNum+2 != Record.size())
2849         return Error(InvalidRecord);
2850
2851       I = new LoadInst(Op, "", Record[OpNum+1], (1 << Record[OpNum]) >> 1);
2852       InstructionList.push_back(I);
2853       break;
2854     }
2855     case bitc::FUNC_CODE_INST_LOADATOMIC: {
2856        // LOADATOMIC: [opty, op, align, vol, ordering, synchscope]
2857       unsigned OpNum = 0;
2858       Value *Op;
2859       if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
2860           OpNum+4 != Record.size())
2861         return Error(InvalidRecord);
2862
2863
2864       AtomicOrdering Ordering = GetDecodedOrdering(Record[OpNum+2]);
2865       if (Ordering == NotAtomic || Ordering == Release ||
2866           Ordering == AcquireRelease)
2867         return Error(InvalidRecord);
2868       if (Ordering != NotAtomic && Record[OpNum] == 0)
2869         return Error(InvalidRecord);
2870       SynchronizationScope SynchScope = GetDecodedSynchScope(Record[OpNum+3]);
2871
2872       I = new LoadInst(Op, "", Record[OpNum+1], (1 << Record[OpNum]) >> 1,
2873                        Ordering, SynchScope);
2874       InstructionList.push_back(I);
2875       break;
2876     }
2877     case bitc::FUNC_CODE_INST_STORE: { // STORE2:[ptrty, ptr, val, align, vol]
2878       unsigned OpNum = 0;
2879       Value *Val, *Ptr;
2880       if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
2881           popValue(Record, OpNum, NextValueNo,
2882                     cast<PointerType>(Ptr->getType())->getElementType(), Val) ||
2883           OpNum+2 != Record.size())
2884         return Error(InvalidRecord);
2885
2886       I = new StoreInst(Val, Ptr, Record[OpNum+1], (1 << Record[OpNum]) >> 1);
2887       InstructionList.push_back(I);
2888       break;
2889     }
2890     case bitc::FUNC_CODE_INST_STOREATOMIC: {
2891       // STOREATOMIC: [ptrty, ptr, val, align, vol, ordering, synchscope]
2892       unsigned OpNum = 0;
2893       Value *Val, *Ptr;
2894       if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
2895           popValue(Record, OpNum, NextValueNo,
2896                     cast<PointerType>(Ptr->getType())->getElementType(), Val) ||
2897           OpNum+4 != Record.size())
2898         return Error(InvalidRecord);
2899
2900       AtomicOrdering Ordering = GetDecodedOrdering(Record[OpNum+2]);
2901       if (Ordering == NotAtomic || Ordering == Acquire ||
2902           Ordering == AcquireRelease)
2903         return Error(InvalidRecord);
2904       SynchronizationScope SynchScope = GetDecodedSynchScope(Record[OpNum+3]);
2905       if (Ordering != NotAtomic && Record[OpNum] == 0)
2906         return Error(InvalidRecord);
2907
2908       I = new StoreInst(Val, Ptr, Record[OpNum+1], (1 << Record[OpNum]) >> 1,
2909                         Ordering, SynchScope);
2910       InstructionList.push_back(I);
2911       break;
2912     }
2913     case bitc::FUNC_CODE_INST_CMPXCHG: {
2914       // CMPXCHG:[ptrty, ptr, cmp, new, vol, successordering, synchscope,
2915       //          failureordering]
2916       unsigned OpNum = 0;
2917       Value *Ptr, *Cmp, *New;
2918       if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
2919           popValue(Record, OpNum, NextValueNo,
2920                     cast<PointerType>(Ptr->getType())->getElementType(), Cmp) ||
2921           popValue(Record, OpNum, NextValueNo,
2922                     cast<PointerType>(Ptr->getType())->getElementType(), New) ||
2923           (OpNum + 3 != Record.size() && OpNum + 4 != Record.size()))
2924         return Error(InvalidRecord);
2925       AtomicOrdering SuccessOrdering = GetDecodedOrdering(Record[OpNum+1]);
2926       if (SuccessOrdering == NotAtomic || SuccessOrdering == Unordered)
2927         return Error(InvalidRecord);
2928       SynchronizationScope SynchScope = GetDecodedSynchScope(Record[OpNum+2]);
2929
2930       AtomicOrdering FailureOrdering;
2931       if (Record.size() < 7)
2932         FailureOrdering =
2933             AtomicCmpXchgInst::getStrongestFailureOrdering(SuccessOrdering);
2934       else
2935         FailureOrdering = GetDecodedOrdering(Record[OpNum+3]);
2936
2937       I = new AtomicCmpXchgInst(Ptr, Cmp, New, SuccessOrdering, FailureOrdering,
2938                                 SynchScope);
2939       cast<AtomicCmpXchgInst>(I)->setVolatile(Record[OpNum]);
2940       InstructionList.push_back(I);
2941       break;
2942     }
2943     case bitc::FUNC_CODE_INST_ATOMICRMW: {
2944       // ATOMICRMW:[ptrty, ptr, val, op, vol, ordering, synchscope]
2945       unsigned OpNum = 0;
2946       Value *Ptr, *Val;
2947       if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
2948           popValue(Record, OpNum, NextValueNo,
2949                     cast<PointerType>(Ptr->getType())->getElementType(), Val) ||
2950           OpNum+4 != Record.size())
2951         return Error(InvalidRecord);
2952       AtomicRMWInst::BinOp Operation = GetDecodedRMWOperation(Record[OpNum]);
2953       if (Operation < AtomicRMWInst::FIRST_BINOP ||
2954           Operation > AtomicRMWInst::LAST_BINOP)
2955         return Error(InvalidRecord);
2956       AtomicOrdering Ordering = GetDecodedOrdering(Record[OpNum+2]);
2957       if (Ordering == NotAtomic || Ordering == Unordered)
2958         return Error(InvalidRecord);
2959       SynchronizationScope SynchScope = GetDecodedSynchScope(Record[OpNum+3]);
2960       I = new AtomicRMWInst(Operation, Ptr, Val, Ordering, SynchScope);
2961       cast<AtomicRMWInst>(I)->setVolatile(Record[OpNum+1]);
2962       InstructionList.push_back(I);
2963       break;
2964     }
2965     case bitc::FUNC_CODE_INST_FENCE: { // FENCE:[ordering, synchscope]
2966       if (2 != Record.size())
2967         return Error(InvalidRecord);
2968       AtomicOrdering Ordering = GetDecodedOrdering(Record[0]);
2969       if (Ordering == NotAtomic || Ordering == Unordered ||
2970           Ordering == Monotonic)
2971         return Error(InvalidRecord);
2972       SynchronizationScope SynchScope = GetDecodedSynchScope(Record[1]);
2973       I = new FenceInst(Context, Ordering, SynchScope);
2974       InstructionList.push_back(I);
2975       break;
2976     }
2977     case bitc::FUNC_CODE_INST_CALL: {
2978       // CALL: [paramattrs, cc, fnty, fnid, arg0, arg1...]
2979       if (Record.size() < 3)
2980         return Error(InvalidRecord);
2981
2982       AttributeSet PAL = getAttributes(Record[0]);
2983       unsigned CCInfo = Record[1];
2984
2985       unsigned OpNum = 2;
2986       Value *Callee;
2987       if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
2988         return Error(InvalidRecord);
2989
2990       PointerType *OpTy = dyn_cast<PointerType>(Callee->getType());
2991       FunctionType *FTy = nullptr;
2992       if (OpTy) FTy = dyn_cast<FunctionType>(OpTy->getElementType());
2993       if (!FTy || Record.size() < FTy->getNumParams()+OpNum)
2994         return Error(InvalidRecord);
2995
2996       SmallVector<Value*, 16> Args;
2997       // Read the fixed params.
2998       for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
2999         if (FTy->getParamType(i)->isLabelTy())
3000           Args.push_back(getBasicBlock(Record[OpNum]));
3001         else
3002           Args.push_back(getValue(Record, OpNum, NextValueNo,
3003                                   FTy->getParamType(i)));
3004         if (!Args.back())
3005           return Error(InvalidRecord);
3006       }
3007
3008       // Read type/value pairs for varargs params.
3009       if (!FTy->isVarArg()) {
3010         if (OpNum != Record.size())
3011           return Error(InvalidRecord);
3012       } else {
3013         while (OpNum != Record.size()) {
3014           Value *Op;
3015           if (getValueTypePair(Record, OpNum, NextValueNo, Op))
3016             return Error(InvalidRecord);
3017           Args.push_back(Op);
3018         }
3019       }
3020
3021       I = CallInst::Create(Callee, Args);
3022       InstructionList.push_back(I);
3023       cast<CallInst>(I)->setCallingConv(
3024           static_cast<CallingConv::ID>((~(1U << 14) & CCInfo) >> 1));
3025       CallInst::TailCallKind TCK = CallInst::TCK_None;
3026       if (CCInfo & 1)
3027         TCK = CallInst::TCK_Tail;
3028       if (CCInfo & (1 << 14))
3029         TCK = CallInst::TCK_MustTail;
3030       cast<CallInst>(I)->setTailCallKind(TCK);
3031       cast<CallInst>(I)->setAttributes(PAL);
3032       break;
3033     }
3034     case bitc::FUNC_CODE_INST_VAARG: { // VAARG: [valistty, valist, instty]
3035       if (Record.size() < 3)
3036         return Error(InvalidRecord);
3037       Type *OpTy = getTypeByID(Record[0]);
3038       Value *Op = getValue(Record, 1, NextValueNo, OpTy);
3039       Type *ResTy = getTypeByID(Record[2]);
3040       if (!OpTy || !Op || !ResTy)
3041         return Error(InvalidRecord);
3042       I = new VAArgInst(Op, ResTy);
3043       InstructionList.push_back(I);
3044       break;
3045     }
3046     }
3047
3048     // Add instruction to end of current BB.  If there is no current BB, reject
3049     // this file.
3050     if (!CurBB) {
3051       delete I;
3052       return Error(InvalidInstructionWithNoBB);
3053     }
3054     CurBB->getInstList().push_back(I);
3055
3056     // If this was a terminator instruction, move to the next block.
3057     if (isa<TerminatorInst>(I)) {
3058       ++CurBBNo;
3059       CurBB = CurBBNo < FunctionBBs.size() ? FunctionBBs[CurBBNo] : nullptr;
3060     }
3061
3062     // Non-void values get registered in the value table for future use.
3063     if (I && !I->getType()->isVoidTy())
3064       ValueList.AssignValue(I, NextValueNo++);
3065   }
3066
3067 OutOfRecordLoop:
3068
3069   // Check the function list for unresolved values.
3070   if (Argument *A = dyn_cast<Argument>(ValueList.back())) {
3071     if (!A->getParent()) {
3072       // We found at least one unresolved value.  Nuke them all to avoid leaks.
3073       for (unsigned i = ModuleValueListSize, e = ValueList.size(); i != e; ++i){
3074         if ((A = dyn_cast_or_null<Argument>(ValueList[i])) && !A->getParent()) {
3075           A->replaceAllUsesWith(UndefValue::get(A->getType()));
3076           delete A;
3077         }
3078       }
3079       return Error(NeverResolvedValueFoundInFunction);
3080     }
3081   }
3082
3083   // FIXME: Check for unresolved forward-declared metadata references
3084   // and clean up leaks.
3085
3086   // See if anything took the address of blocks in this function.  If so,
3087   // resolve them now.
3088   DenseMap<Function*, std::vector<BlockAddrRefTy> >::iterator BAFRI =
3089     BlockAddrFwdRefs.find(F);
3090   if (BAFRI != BlockAddrFwdRefs.end()) {
3091     std::vector<BlockAddrRefTy> &RefList = BAFRI->second;
3092     for (unsigned i = 0, e = RefList.size(); i != e; ++i) {
3093       unsigned BlockIdx = RefList[i].first;
3094       if (BlockIdx >= FunctionBBs.size())
3095         return Error(InvalidID);
3096
3097       GlobalVariable *FwdRef = RefList[i].second;
3098       FwdRef->replaceAllUsesWith(BlockAddress::get(F, FunctionBBs[BlockIdx]));
3099       FwdRef->eraseFromParent();
3100     }
3101
3102     BlockAddrFwdRefs.erase(BAFRI);
3103   }
3104
3105   // Trim the value list down to the size it was before we parsed this function.
3106   ValueList.shrinkTo(ModuleValueListSize);
3107   MDValueList.shrinkTo(ModuleMDValueListSize);
3108   std::vector<BasicBlock*>().swap(FunctionBBs);
3109   return error_code::success();
3110 }
3111
3112 /// Find the function body in the bitcode stream
3113 error_code BitcodeReader::FindFunctionInStream(Function *F,
3114        DenseMap<Function*, uint64_t>::iterator DeferredFunctionInfoIterator) {
3115   while (DeferredFunctionInfoIterator->second == 0) {
3116     if (Stream.AtEndOfStream())
3117       return Error(CouldNotFindFunctionInStream);
3118     // ParseModule will parse the next body in the stream and set its
3119     // position in the DeferredFunctionInfo map.
3120     if (error_code EC = ParseModule(true))
3121       return EC;
3122   }
3123   return error_code::success();
3124 }
3125
3126 //===----------------------------------------------------------------------===//
3127 // GVMaterializer implementation
3128 //===----------------------------------------------------------------------===//
3129
3130
3131 bool BitcodeReader::isMaterializable(const GlobalValue *GV) const {
3132   if (const Function *F = dyn_cast<Function>(GV)) {
3133     return F->isDeclaration() &&
3134       DeferredFunctionInfo.count(const_cast<Function*>(F));
3135   }
3136   return false;
3137 }
3138
3139 error_code BitcodeReader::Materialize(GlobalValue *GV) {
3140   Function *F = dyn_cast<Function>(GV);
3141   // If it's not a function or is already material, ignore the request.
3142   if (!F || !F->isMaterializable())
3143     return error_code::success();
3144
3145   DenseMap<Function*, uint64_t>::iterator DFII = DeferredFunctionInfo.find(F);
3146   assert(DFII != DeferredFunctionInfo.end() && "Deferred function not found!");
3147   // If its position is recorded as 0, its body is somewhere in the stream
3148   // but we haven't seen it yet.
3149   if (DFII->second == 0 && LazyStreamer)
3150     if (error_code EC = FindFunctionInStream(F, DFII))
3151       return EC;
3152
3153   // Move the bit stream to the saved position of the deferred function body.
3154   Stream.JumpToBit(DFII->second);
3155
3156   if (error_code EC = ParseFunctionBody(F))
3157     return EC;
3158
3159   // Upgrade any old intrinsic calls in the function.
3160   for (UpgradedIntrinsicMap::iterator I = UpgradedIntrinsics.begin(),
3161        E = UpgradedIntrinsics.end(); I != E; ++I) {
3162     if (I->first != I->second) {
3163       for (auto UI = I->first->user_begin(), UE = I->first->user_end();
3164            UI != UE;) {
3165         if (CallInst* CI = dyn_cast<CallInst>(*UI++))
3166           UpgradeIntrinsicCall(CI, I->second);
3167       }
3168     }
3169   }
3170
3171   return error_code::success();
3172 }
3173
3174 bool BitcodeReader::isDematerializable(const GlobalValue *GV) const {
3175   const Function *F = dyn_cast<Function>(GV);
3176   if (!F || F->isDeclaration())
3177     return false;
3178   return DeferredFunctionInfo.count(const_cast<Function*>(F));
3179 }
3180
3181 void BitcodeReader::Dematerialize(GlobalValue *GV) {
3182   Function *F = dyn_cast<Function>(GV);
3183   // If this function isn't dematerializable, this is a noop.
3184   if (!F || !isDematerializable(F))
3185     return;
3186
3187   assert(DeferredFunctionInfo.count(F) && "No info to read function later?");
3188
3189   // Just forget the function body, we can remat it later.
3190   F->deleteBody();
3191 }
3192
3193
3194 error_code BitcodeReader::MaterializeModule(Module *M) {
3195   assert(M == TheModule &&
3196          "Can only Materialize the Module this BitcodeReader is attached to.");
3197   // Iterate over the module, deserializing any functions that are still on
3198   // disk.
3199   for (Module::iterator F = TheModule->begin(), E = TheModule->end();
3200        F != E; ++F) {
3201     if (F->isMaterializable()) {
3202       if (error_code EC = Materialize(F))
3203         return EC;
3204     }
3205   }
3206   // At this point, if there are any function bodies, the current bit is
3207   // pointing to the END_BLOCK record after them. Now make sure the rest
3208   // of the bits in the module have been read.
3209   if (NextUnreadBit)
3210     ParseModule(true);
3211
3212   // Upgrade any intrinsic calls that slipped through (should not happen!) and
3213   // delete the old functions to clean up. We can't do this unless the entire
3214   // module is materialized because there could always be another function body
3215   // with calls to the old function.
3216   for (std::vector<std::pair<Function*, Function*> >::iterator I =
3217        UpgradedIntrinsics.begin(), E = UpgradedIntrinsics.end(); I != E; ++I) {
3218     if (I->first != I->second) {
3219       for (auto UI = I->first->user_begin(), UE = I->first->user_end();
3220            UI != UE;) {
3221         if (CallInst* CI = dyn_cast<CallInst>(*UI++))
3222           UpgradeIntrinsicCall(CI, I->second);
3223       }
3224       if (!I->first->use_empty())
3225         I->first->replaceAllUsesWith(I->second);
3226       I->first->eraseFromParent();
3227     }
3228   }
3229   std::vector<std::pair<Function*, Function*> >().swap(UpgradedIntrinsics);
3230
3231   for (unsigned I = 0, E = InstsWithTBAATag.size(); I < E; I++)
3232     UpgradeInstWithTBAATag(InstsWithTBAATag[I]);
3233
3234   UpgradeDebugInfo(*M);
3235   return error_code::success();
3236 }
3237
3238 error_code BitcodeReader::InitStream() {
3239   if (LazyStreamer)
3240     return InitLazyStream();
3241   return InitStreamFromBuffer();
3242 }
3243
3244 error_code BitcodeReader::InitStreamFromBuffer() {
3245   const unsigned char *BufPtr = (const unsigned char*)Buffer->getBufferStart();
3246   const unsigned char *BufEnd = BufPtr+Buffer->getBufferSize();
3247
3248   if (Buffer->getBufferSize() & 3) {
3249     if (!isRawBitcode(BufPtr, BufEnd) && !isBitcodeWrapper(BufPtr, BufEnd))
3250       return Error(InvalidBitcodeSignature);
3251     else
3252       return Error(BitcodeStreamInvalidSize);
3253   }
3254
3255   // If we have a wrapper header, parse it and ignore the non-bc file contents.
3256   // The magic number is 0x0B17C0DE stored in little endian.
3257   if (isBitcodeWrapper(BufPtr, BufEnd))
3258     if (SkipBitcodeWrapperHeader(BufPtr, BufEnd, true))
3259       return Error(InvalidBitcodeWrapperHeader);
3260
3261   StreamFile.reset(new BitstreamReader(BufPtr, BufEnd));
3262   Stream.init(*StreamFile);
3263
3264   return error_code::success();
3265 }
3266
3267 error_code BitcodeReader::InitLazyStream() {
3268   // Check and strip off the bitcode wrapper; BitstreamReader expects never to
3269   // see it.
3270   StreamingMemoryObject *Bytes = new StreamingMemoryObject(LazyStreamer);
3271   StreamFile.reset(new BitstreamReader(Bytes));
3272   Stream.init(*StreamFile);
3273
3274   unsigned char buf[16];
3275   if (Bytes->readBytes(0, 16, buf) == -1)
3276     return Error(BitcodeStreamInvalidSize);
3277
3278   if (!isBitcode(buf, buf + 16))
3279     return Error(InvalidBitcodeSignature);
3280
3281   if (isBitcodeWrapper(buf, buf + 4)) {
3282     const unsigned char *bitcodeStart = buf;
3283     const unsigned char *bitcodeEnd = buf + 16;
3284     SkipBitcodeWrapperHeader(bitcodeStart, bitcodeEnd, false);
3285     Bytes->dropLeadingBytes(bitcodeStart - buf);
3286     Bytes->setKnownObjectSize(bitcodeEnd - bitcodeStart);
3287   }
3288   return error_code::success();
3289 }
3290
3291 namespace {
3292 class BitcodeErrorCategoryType : public error_category {
3293   const char *name() const override {
3294     return "llvm.bitcode";
3295   }
3296   std::string message(int IE) const override {
3297     BitcodeReader::ErrorType E = static_cast<BitcodeReader::ErrorType>(IE);
3298     switch (E) {
3299     case BitcodeReader::BitcodeStreamInvalidSize:
3300       return "Bitcode stream length should be >= 16 bytes and a multiple of 4";
3301     case BitcodeReader::ConflictingMETADATA_KINDRecords:
3302       return "Conflicting METADATA_KIND records";
3303     case BitcodeReader::CouldNotFindFunctionInStream:
3304       return "Could not find function in stream";
3305     case BitcodeReader::ExpectedConstant:
3306       return "Expected a constant";
3307     case BitcodeReader::InsufficientFunctionProtos:
3308       return "Insufficient function protos";
3309     case BitcodeReader::InvalidBitcodeSignature:
3310       return "Invalid bitcode signature";
3311     case BitcodeReader::InvalidBitcodeWrapperHeader:
3312       return "Invalid bitcode wrapper header";
3313     case BitcodeReader::InvalidConstantReference:
3314       return "Invalid ronstant reference";
3315     case BitcodeReader::InvalidID:
3316       return "Invalid ID";
3317     case BitcodeReader::InvalidInstructionWithNoBB:
3318       return "Invalid instruction with no BB";
3319     case BitcodeReader::InvalidRecord:
3320       return "Invalid record";
3321     case BitcodeReader::InvalidTypeForValue:
3322       return "Invalid type for value";
3323     case BitcodeReader::InvalidTYPETable:
3324       return "Invalid TYPE table";
3325     case BitcodeReader::InvalidType:
3326       return "Invalid type";
3327     case BitcodeReader::MalformedBlock:
3328       return "Malformed block";
3329     case BitcodeReader::MalformedGlobalInitializerSet:
3330       return "Malformed global initializer set";
3331     case BitcodeReader::InvalidMultipleBlocks:
3332       return "Invalid multiple blocks";
3333     case BitcodeReader::NeverResolvedValueFoundInFunction:
3334       return "Never resolved value found in function";
3335     case BitcodeReader::InvalidValue:
3336       return "Invalid value";
3337     }
3338     llvm_unreachable("Unknown error type!");
3339   }
3340 };
3341 }
3342
3343 const error_category &BitcodeReader::BitcodeErrorCategory() {
3344   static BitcodeErrorCategoryType O;
3345   return O;
3346 }
3347
3348 //===----------------------------------------------------------------------===//
3349 // External interface
3350 //===----------------------------------------------------------------------===//
3351
3352 /// getLazyBitcodeModule - lazy function-at-a-time loading from a file.
3353 ///
3354 ErrorOr<Module *> llvm::getLazyBitcodeModule(MemoryBuffer *Buffer,
3355                                              LLVMContext &Context) {
3356   Module *M = new Module(Buffer->getBufferIdentifier(), Context);
3357   BitcodeReader *R = new BitcodeReader(Buffer, Context);
3358   M->setMaterializer(R);
3359   if (error_code EC = R->ParseBitcodeInto(M)) {
3360     delete M;  // Also deletes R.
3361     return EC;
3362   }
3363   // Have the BitcodeReader dtor delete 'Buffer'.
3364   R->setBufferOwned(true);
3365
3366   R->materializeForwardReferencedFunctions();
3367
3368   return M;
3369 }
3370
3371
3372 Module *llvm::getStreamedBitcodeModule(const std::string &name,
3373                                        DataStreamer *streamer,
3374                                        LLVMContext &Context,
3375                                        std::string *ErrMsg) {
3376   Module *M = new Module(name, Context);
3377   BitcodeReader *R = new BitcodeReader(streamer, Context);
3378   M->setMaterializer(R);
3379   if (error_code EC = R->ParseBitcodeInto(M)) {
3380     if (ErrMsg)
3381       *ErrMsg = EC.message();
3382     delete M;  // Also deletes R.
3383     return nullptr;
3384   }
3385   R->setBufferOwned(false); // no buffer to delete
3386   return M;
3387 }
3388
3389 ErrorOr<Module *> llvm::parseBitcodeFile(MemoryBuffer *Buffer,
3390                                          LLVMContext &Context) {
3391   ErrorOr<Module *> ModuleOrErr = getLazyBitcodeModule(Buffer, Context);
3392   if (!ModuleOrErr)
3393     return ModuleOrErr;
3394   Module *M = ModuleOrErr.get();
3395
3396   // Don't let the BitcodeReader dtor delete 'Buffer', regardless of whether
3397   // there was an error.
3398   static_cast<BitcodeReader*>(M->getMaterializer())->setBufferOwned(false);
3399
3400   // Read in the entire module, and destroy the BitcodeReader.
3401   if (error_code EC = M->materializeAllPermanently()) {
3402     delete M;
3403     return EC;
3404   }
3405
3406   // TODO: Restore the use-lists to the in-memory state when the bitcode was
3407   // written.  We must defer until the Module has been fully materialized.
3408
3409   return M;
3410 }
3411
3412 std::string llvm::getBitcodeTargetTriple(MemoryBuffer *Buffer,
3413                                          LLVMContext& Context,
3414                                          std::string *ErrMsg) {
3415   BitcodeReader *R = new BitcodeReader(Buffer, Context);
3416   // Don't let the BitcodeReader dtor delete 'Buffer'.
3417   R->setBufferOwned(false);
3418
3419   std::string Triple("");
3420   if (error_code EC = R->ParseTriple(Triple))
3421     if (ErrMsg)
3422       *ErrMsg = EC.message();
3423
3424   delete R;
3425   return Triple;
3426 }