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