BitcodeReader.cpp revision f9be95f867745b6754b2402b9b72f9eaeabd637f
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/LLVMContext.h"
21#include "llvm/Metadata.h"
22#include "llvm/Module.h"
23#include "llvm/Operator.h"
24#include "llvm/AutoUpgrade.h"
25#include "llvm/ADT/SmallString.h"
26#include "llvm/ADT/SmallVector.h"
27#include "llvm/Support/MathExtras.h"
28#include "llvm/Support/MemoryBuffer.h"
29#include "llvm/OperandTraits.h"
30using namespace llvm;
31
32void BitcodeReader::FreeState() {
33  delete Buffer;
34  Buffer = 0;
35  std::vector<PATypeHolder>().swap(TypeList);
36  ValueList.clear();
37  MDValueList.clear();
38
39  std::vector<AttrListPtr>().swap(MAttributes);
40  std::vector<BasicBlock*>().swap(FunctionBBs);
41  std::vector<Function*>().swap(FunctionsWithBodies);
42  DeferredFunctionInfo.clear();
43}
44
45//===----------------------------------------------------------------------===//
46//  Helper functions to implement forward reference resolution, etc.
47//===----------------------------------------------------------------------===//
48
49/// ConvertToString - Convert a string from a record into an std::string, return
50/// true on failure.
51template<typename StrTy>
52static bool ConvertToString(SmallVector<uint64_t, 64> &Record, unsigned Idx,
53                            StrTy &Result) {
54  if (Idx > Record.size())
55    return true;
56
57  for (unsigned i = Idx, e = Record.size(); i != e; ++i)
58    Result += (char)Record[i];
59  return false;
60}
61
62static GlobalValue::LinkageTypes GetDecodedLinkage(unsigned Val) {
63  switch (Val) {
64  default: // Map unknown/new linkages to external
65  case 0:  return GlobalValue::ExternalLinkage;
66  case 1:  return GlobalValue::WeakAnyLinkage;
67  case 2:  return GlobalValue::AppendingLinkage;
68  case 3:  return GlobalValue::InternalLinkage;
69  case 4:  return GlobalValue::LinkOnceAnyLinkage;
70  case 5:  return GlobalValue::DLLImportLinkage;
71  case 6:  return GlobalValue::DLLExportLinkage;
72  case 7:  return GlobalValue::ExternalWeakLinkage;
73  case 8:  return GlobalValue::CommonLinkage;
74  case 9:  return GlobalValue::PrivateLinkage;
75  case 10: return GlobalValue::WeakODRLinkage;
76  case 11: return GlobalValue::LinkOnceODRLinkage;
77  case 12: return GlobalValue::AvailableExternallyLinkage;
78  case 13: return GlobalValue::LinkerPrivateLinkage;
79  }
80}
81
82static GlobalValue::VisibilityTypes GetDecodedVisibility(unsigned Val) {
83  switch (Val) {
84  default: // Map unknown visibilities to default.
85  case 0: return GlobalValue::DefaultVisibility;
86  case 1: return GlobalValue::HiddenVisibility;
87  case 2: return GlobalValue::ProtectedVisibility;
88  }
89}
90
91static int GetDecodedCastOpcode(unsigned Val) {
92  switch (Val) {
93  default: return -1;
94  case bitc::CAST_TRUNC   : return Instruction::Trunc;
95  case bitc::CAST_ZEXT    : return Instruction::ZExt;
96  case bitc::CAST_SEXT    : return Instruction::SExt;
97  case bitc::CAST_FPTOUI  : return Instruction::FPToUI;
98  case bitc::CAST_FPTOSI  : return Instruction::FPToSI;
99  case bitc::CAST_UITOFP  : return Instruction::UIToFP;
100  case bitc::CAST_SITOFP  : return Instruction::SIToFP;
101  case bitc::CAST_FPTRUNC : return Instruction::FPTrunc;
102  case bitc::CAST_FPEXT   : return Instruction::FPExt;
103  case bitc::CAST_PTRTOINT: return Instruction::PtrToInt;
104  case bitc::CAST_INTTOPTR: return Instruction::IntToPtr;
105  case bitc::CAST_BITCAST : return Instruction::BitCast;
106  }
107}
108static int GetDecodedBinaryOpcode(unsigned Val, const Type *Ty) {
109  switch (Val) {
110  default: return -1;
111  case bitc::BINOP_ADD:
112    return Ty->isFPOrFPVector() ? Instruction::FAdd : Instruction::Add;
113  case bitc::BINOP_SUB:
114    return Ty->isFPOrFPVector() ? Instruction::FSub : Instruction::Sub;
115  case bitc::BINOP_MUL:
116    return Ty->isFPOrFPVector() ? Instruction::FMul : Instruction::Mul;
117  case bitc::BINOP_UDIV: return Instruction::UDiv;
118  case bitc::BINOP_SDIV:
119    return Ty->isFPOrFPVector() ? Instruction::FDiv : Instruction::SDiv;
120  case bitc::BINOP_UREM: return Instruction::URem;
121  case bitc::BINOP_SREM:
122    return Ty->isFPOrFPVector() ? Instruction::FRem : Instruction::SRem;
123  case bitc::BINOP_SHL:  return Instruction::Shl;
124  case bitc::BINOP_LSHR: return Instruction::LShr;
125  case bitc::BINOP_ASHR: return Instruction::AShr;
126  case bitc::BINOP_AND:  return Instruction::And;
127  case bitc::BINOP_OR:   return Instruction::Or;
128  case bitc::BINOP_XOR:  return Instruction::Xor;
129  }
130}
131
132namespace llvm {
133namespace {
134  /// @brief A class for maintaining the slot number definition
135  /// as a placeholder for the actual definition for forward constants defs.
136  class ConstantPlaceHolder : public ConstantExpr {
137    ConstantPlaceHolder();                       // DO NOT IMPLEMENT
138    void operator=(const ConstantPlaceHolder &); // DO NOT IMPLEMENT
139  public:
140    // allocate space for exactly one operand
141    void *operator new(size_t s) {
142      return User::operator new(s, 1);
143    }
144    explicit ConstantPlaceHolder(const Type *Ty, LLVMContext& Context)
145      : ConstantExpr(Ty, Instruction::UserOp1, &Op<0>(), 1) {
146      Op<0>() = UndefValue::get(Type::getInt32Ty(Context));
147    }
148
149    /// @brief Methods to support type inquiry through isa, cast, and dyn_cast.
150    static inline bool classof(const ConstantPlaceHolder *) { return true; }
151    static bool classof(const Value *V) {
152      return isa<ConstantExpr>(V) &&
153             cast<ConstantExpr>(V)->getOpcode() == Instruction::UserOp1;
154    }
155
156
157    /// Provide fast operand accessors
158    //DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
159  };
160}
161
162// FIXME: can we inherit this from ConstantExpr?
163template <>
164struct OperandTraits<ConstantPlaceHolder> : public FixedNumOperandTraits<1> {
165};
166}
167
168
169void BitcodeReaderValueList::AssignValue(Value *V, unsigned Idx) {
170  if (Idx == size()) {
171    push_back(V);
172    return;
173  }
174
175  if (Idx >= size())
176    resize(Idx+1);
177
178  WeakVH &OldV = ValuePtrs[Idx];
179  if (OldV == 0) {
180    OldV = V;
181    return;
182  }
183
184  // Handle constants and non-constants (e.g. instrs) differently for
185  // efficiency.
186  if (Constant *PHC = dyn_cast<Constant>(&*OldV)) {
187    ResolveConstants.push_back(std::make_pair(PHC, Idx));
188    OldV = V;
189  } else {
190    // If there was a forward reference to this value, replace it.
191    Value *PrevVal = OldV;
192    OldV->replaceAllUsesWith(V);
193    delete PrevVal;
194  }
195}
196
197
198Constant *BitcodeReaderValueList::getConstantFwdRef(unsigned Idx,
199                                                    const Type *Ty) {
200  if (Idx >= size())
201    resize(Idx + 1);
202
203  if (Value *V = ValuePtrs[Idx]) {
204    assert(Ty == V->getType() && "Type mismatch in constant table!");
205    return cast<Constant>(V);
206  }
207
208  // Create and return a placeholder, which will later be RAUW'd.
209  Constant *C = new ConstantPlaceHolder(Ty, Context);
210  ValuePtrs[Idx] = C;
211  return C;
212}
213
214Value *BitcodeReaderValueList::getValueFwdRef(unsigned Idx, const Type *Ty) {
215  if (Idx >= size())
216    resize(Idx + 1);
217
218  if (Value *V = ValuePtrs[Idx]) {
219    assert((Ty == 0 || Ty == V->getType()) && "Type mismatch in value table!");
220    return V;
221  }
222
223  // No type specified, must be invalid reference.
224  if (Ty == 0) return 0;
225
226  // Create and return a placeholder, which will later be RAUW'd.
227  Value *V = new Argument(Ty);
228  ValuePtrs[Idx] = V;
229  return V;
230}
231
232/// ResolveConstantForwardRefs - Once all constants are read, this method bulk
233/// resolves any forward references.  The idea behind this is that we sometimes
234/// get constants (such as large arrays) which reference *many* forward ref
235/// constants.  Replacing each of these causes a lot of thrashing when
236/// building/reuniquing the constant.  Instead of doing this, we look at all the
237/// uses and rewrite all the place holders at once for any constant that uses
238/// a placeholder.
239void BitcodeReaderValueList::ResolveConstantForwardRefs() {
240  // Sort the values by-pointer so that they are efficient to look up with a
241  // binary search.
242  std::sort(ResolveConstants.begin(), ResolveConstants.end());
243
244  SmallVector<Constant*, 64> NewOps;
245
246  while (!ResolveConstants.empty()) {
247    Value *RealVal = operator[](ResolveConstants.back().second);
248    Constant *Placeholder = ResolveConstants.back().first;
249    ResolveConstants.pop_back();
250
251    // Loop over all users of the placeholder, updating them to reference the
252    // new value.  If they reference more than one placeholder, update them all
253    // at once.
254    while (!Placeholder->use_empty()) {
255      Value::use_iterator UI = Placeholder->use_begin();
256
257      // If the using object isn't uniqued, just update the operands.  This
258      // handles instructions and initializers for global variables.
259      if (!isa<Constant>(*UI) || isa<GlobalValue>(*UI)) {
260        UI.getUse().set(RealVal);
261        continue;
262      }
263
264      // Otherwise, we have a constant that uses the placeholder.  Replace that
265      // constant with a new constant that has *all* placeholder uses updated.
266      Constant *UserC = cast<Constant>(*UI);
267      for (User::op_iterator I = UserC->op_begin(), E = UserC->op_end();
268           I != E; ++I) {
269        Value *NewOp;
270        if (!isa<ConstantPlaceHolder>(*I)) {
271          // Not a placeholder reference.
272          NewOp = *I;
273        } else if (*I == Placeholder) {
274          // Common case is that it just references this one placeholder.
275          NewOp = RealVal;
276        } else {
277          // Otherwise, look up the placeholder in ResolveConstants.
278          ResolveConstantsTy::iterator It =
279            std::lower_bound(ResolveConstants.begin(), ResolveConstants.end(),
280                             std::pair<Constant*, unsigned>(cast<Constant>(*I),
281                                                            0));
282          assert(It != ResolveConstants.end() && It->first == *I);
283          NewOp = operator[](It->second);
284        }
285
286        NewOps.push_back(cast<Constant>(NewOp));
287      }
288
289      // Make the new constant.
290      Constant *NewC;
291      if (ConstantArray *UserCA = dyn_cast<ConstantArray>(UserC)) {
292        NewC = ConstantArray::get(UserCA->getType(), &NewOps[0],
293                                        NewOps.size());
294      } else if (ConstantStruct *UserCS = dyn_cast<ConstantStruct>(UserC)) {
295        NewC = ConstantStruct::get(Context, &NewOps[0], NewOps.size(),
296                                         UserCS->getType()->isPacked());
297      } else if (isa<ConstantVector>(UserC)) {
298        NewC = ConstantVector::get(&NewOps[0], NewOps.size());
299      } else {
300        assert(isa<ConstantExpr>(UserC) && "Must be a ConstantExpr.");
301        NewC = cast<ConstantExpr>(UserC)->getWithOperands(&NewOps[0],
302                                                          NewOps.size());
303      }
304
305      UserC->replaceAllUsesWith(NewC);
306      UserC->destroyConstant();
307      NewOps.clear();
308    }
309
310    // Update all ValueHandles, they should be the only users at this point.
311    Placeholder->replaceAllUsesWith(RealVal);
312    delete Placeholder;
313  }
314}
315
316void BitcodeReaderMDValueList::AssignValue(Value *V, unsigned Idx) {
317  if (Idx == size()) {
318    push_back(V);
319    return;
320  }
321
322  if (Idx >= size())
323    resize(Idx+1);
324
325  WeakVH &OldV = MDValuePtrs[Idx];
326  if (OldV == 0) {
327    OldV = V;
328    return;
329  }
330
331  // If there was a forward reference to this value, replace it.
332  Value *PrevVal = OldV;
333  OldV->replaceAllUsesWith(V);
334  delete PrevVal;
335  // Deleting PrevVal sets Idx value in MDValuePtrs to null. Set new
336  // value for Idx.
337  MDValuePtrs[Idx] = V;
338}
339
340Value *BitcodeReaderMDValueList::getValueFwdRef(unsigned Idx) {
341  if (Idx >= size())
342    resize(Idx + 1);
343
344  if (Value *V = MDValuePtrs[Idx]) {
345    assert(V->getType()->isMetadataTy() && "Type mismatch in value table!");
346    return V;
347  }
348
349  // Create and return a placeholder, which will later be RAUW'd.
350  Value *V = new Argument(Type::getMetadataTy(Context));
351  MDValuePtrs[Idx] = V;
352  return V;
353}
354
355const Type *BitcodeReader::getTypeByID(unsigned ID, bool isTypeTable) {
356  // If the TypeID is in range, return it.
357  if (ID < TypeList.size())
358    return TypeList[ID].get();
359  if (!isTypeTable) return 0;
360
361  // The type table allows forward references.  Push as many Opaque types as
362  // needed to get up to ID.
363  while (TypeList.size() <= ID)
364    TypeList.push_back(OpaqueType::get(Context));
365  return TypeList.back().get();
366}
367
368//===----------------------------------------------------------------------===//
369//  Functions for parsing blocks from the bitcode file
370//===----------------------------------------------------------------------===//
371
372bool BitcodeReader::ParseAttributeBlock() {
373  if (Stream.EnterSubBlock(bitc::PARAMATTR_BLOCK_ID))
374    return Error("Malformed block record");
375
376  if (!MAttributes.empty())
377    return Error("Multiple PARAMATTR blocks found!");
378
379  SmallVector<uint64_t, 64> Record;
380
381  SmallVector<AttributeWithIndex, 8> Attrs;
382
383  // Read all the records.
384  while (1) {
385    unsigned Code = Stream.ReadCode();
386    if (Code == bitc::END_BLOCK) {
387      if (Stream.ReadBlockEnd())
388        return Error("Error at end of PARAMATTR block");
389      return false;
390    }
391
392    if (Code == bitc::ENTER_SUBBLOCK) {
393      // No known subblocks, always skip them.
394      Stream.ReadSubBlockID();
395      if (Stream.SkipBlock())
396        return Error("Malformed block record");
397      continue;
398    }
399
400    if (Code == bitc::DEFINE_ABBREV) {
401      Stream.ReadAbbrevRecord();
402      continue;
403    }
404
405    // Read a record.
406    Record.clear();
407    switch (Stream.ReadRecord(Code, Record)) {
408    default:  // Default behavior: ignore.
409      break;
410    case bitc::PARAMATTR_CODE_ENTRY: { // ENTRY: [paramidx0, attr0, ...]
411      if (Record.size() & 1)
412        return Error("Invalid ENTRY record");
413
414      // FIXME : Remove this autoupgrade code in LLVM 3.0.
415      // If Function attributes are using index 0 then transfer them
416      // to index ~0. Index 0 is used for return value attributes but used to be
417      // used for function attributes.
418      Attributes RetAttribute = Attribute::None;
419      Attributes FnAttribute = Attribute::None;
420      for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
421        // FIXME: remove in LLVM 3.0
422        // The alignment is stored as a 16-bit raw value from bits 31--16.
423        // We shift the bits above 31 down by 11 bits.
424
425        unsigned Alignment = (Record[i+1] & (0xffffull << 16)) >> 16;
426        if (Alignment && !isPowerOf2_32(Alignment))
427          return Error("Alignment is not a power of two.");
428
429        Attributes ReconstitutedAttr = Record[i+1] & 0xffff;
430        if (Alignment)
431          ReconstitutedAttr |= Attribute::constructAlignmentFromInt(Alignment);
432        ReconstitutedAttr |= (Record[i+1] & (0xffffull << 32)) >> 11;
433        Record[i+1] = ReconstitutedAttr;
434
435        if (Record[i] == 0)
436          RetAttribute = Record[i+1];
437        else if (Record[i] == ~0U)
438          FnAttribute = Record[i+1];
439      }
440
441      unsigned OldRetAttrs = (Attribute::NoUnwind|Attribute::NoReturn|
442                              Attribute::ReadOnly|Attribute::ReadNone);
443
444      if (FnAttribute == Attribute::None && RetAttribute != Attribute::None &&
445          (RetAttribute & OldRetAttrs) != 0) {
446        if (FnAttribute == Attribute::None) { // add a slot so they get added.
447          Record.push_back(~0U);
448          Record.push_back(0);
449        }
450
451        FnAttribute  |= RetAttribute & OldRetAttrs;
452        RetAttribute &= ~OldRetAttrs;
453      }
454
455      for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
456        if (Record[i] == 0) {
457          if (RetAttribute != Attribute::None)
458            Attrs.push_back(AttributeWithIndex::get(0, RetAttribute));
459        } else if (Record[i] == ~0U) {
460          if (FnAttribute != Attribute::None)
461            Attrs.push_back(AttributeWithIndex::get(~0U, FnAttribute));
462        } else if (Record[i+1] != Attribute::None)
463          Attrs.push_back(AttributeWithIndex::get(Record[i], Record[i+1]));
464      }
465
466      MAttributes.push_back(AttrListPtr::get(Attrs.begin(), Attrs.end()));
467      Attrs.clear();
468      break;
469    }
470    }
471  }
472}
473
474
475bool BitcodeReader::ParseTypeTable() {
476  if (Stream.EnterSubBlock(bitc::TYPE_BLOCK_ID))
477    return Error("Malformed block record");
478
479  if (!TypeList.empty())
480    return Error("Multiple TYPE_BLOCKs found!");
481
482  SmallVector<uint64_t, 64> Record;
483  unsigned NumRecords = 0;
484
485  // Read all the records for this type table.
486  while (1) {
487    unsigned Code = Stream.ReadCode();
488    if (Code == bitc::END_BLOCK) {
489      if (NumRecords != TypeList.size())
490        return Error("Invalid type forward reference in TYPE_BLOCK");
491      if (Stream.ReadBlockEnd())
492        return Error("Error at end of type table block");
493      return false;
494    }
495
496    if (Code == bitc::ENTER_SUBBLOCK) {
497      // No known subblocks, always skip them.
498      Stream.ReadSubBlockID();
499      if (Stream.SkipBlock())
500        return Error("Malformed block record");
501      continue;
502    }
503
504    if (Code == bitc::DEFINE_ABBREV) {
505      Stream.ReadAbbrevRecord();
506      continue;
507    }
508
509    // Read a record.
510    Record.clear();
511    const Type *ResultTy = 0;
512    switch (Stream.ReadRecord(Code, Record)) {
513    default:  // Default behavior: unknown type.
514      ResultTy = 0;
515      break;
516    case bitc::TYPE_CODE_NUMENTRY: // TYPE_CODE_NUMENTRY: [numentries]
517      // TYPE_CODE_NUMENTRY contains a count of the number of types in the
518      // type list.  This allows us to reserve space.
519      if (Record.size() < 1)
520        return Error("Invalid TYPE_CODE_NUMENTRY record");
521      TypeList.reserve(Record[0]);
522      continue;
523    case bitc::TYPE_CODE_VOID:      // VOID
524      ResultTy = Type::getVoidTy(Context);
525      break;
526    case bitc::TYPE_CODE_FLOAT:     // FLOAT
527      ResultTy = Type::getFloatTy(Context);
528      break;
529    case bitc::TYPE_CODE_DOUBLE:    // DOUBLE
530      ResultTy = Type::getDoubleTy(Context);
531      break;
532    case bitc::TYPE_CODE_X86_FP80:  // X86_FP80
533      ResultTy = Type::getX86_FP80Ty(Context);
534      break;
535    case bitc::TYPE_CODE_FP128:     // FP128
536      ResultTy = Type::getFP128Ty(Context);
537      break;
538    case bitc::TYPE_CODE_PPC_FP128: // PPC_FP128
539      ResultTy = Type::getPPC_FP128Ty(Context);
540      break;
541    case bitc::TYPE_CODE_LABEL:     // LABEL
542      ResultTy = Type::getLabelTy(Context);
543      break;
544    case bitc::TYPE_CODE_OPAQUE:    // OPAQUE
545      ResultTy = 0;
546      break;
547    case bitc::TYPE_CODE_METADATA:  // METADATA
548      ResultTy = Type::getMetadataTy(Context);
549      break;
550    case bitc::TYPE_CODE_INTEGER:   // INTEGER: [width]
551      if (Record.size() < 1)
552        return Error("Invalid Integer type record");
553
554      ResultTy = IntegerType::get(Context, Record[0]);
555      break;
556    case bitc::TYPE_CODE_POINTER: { // POINTER: [pointee type] or
557                                    //          [pointee type, address space]
558      if (Record.size() < 1)
559        return Error("Invalid POINTER type record");
560      unsigned AddressSpace = 0;
561      if (Record.size() == 2)
562        AddressSpace = Record[1];
563      ResultTy = PointerType::get(getTypeByID(Record[0], true),
564                                        AddressSpace);
565      break;
566    }
567    case bitc::TYPE_CODE_FUNCTION: {
568      // FIXME: attrid is dead, remove it in LLVM 3.0
569      // FUNCTION: [vararg, attrid, retty, paramty x N]
570      if (Record.size() < 3)
571        return Error("Invalid FUNCTION type record");
572      std::vector<const Type*> ArgTys;
573      for (unsigned i = 3, e = Record.size(); i != e; ++i)
574        ArgTys.push_back(getTypeByID(Record[i], true));
575
576      ResultTy = FunctionType::get(getTypeByID(Record[2], true), ArgTys,
577                                   Record[0]);
578      break;
579    }
580    case bitc::TYPE_CODE_STRUCT: {  // STRUCT: [ispacked, eltty x N]
581      if (Record.size() < 1)
582        return Error("Invalid STRUCT type record");
583      std::vector<const Type*> EltTys;
584      for (unsigned i = 1, e = Record.size(); i != e; ++i)
585        EltTys.push_back(getTypeByID(Record[i], true));
586      ResultTy = StructType::get(Context, EltTys, Record[0]);
587      break;
588    }
589    case bitc::TYPE_CODE_ARRAY:     // ARRAY: [numelts, eltty]
590      if (Record.size() < 2)
591        return Error("Invalid ARRAY type record");
592      ResultTy = ArrayType::get(getTypeByID(Record[1], true), Record[0]);
593      break;
594    case bitc::TYPE_CODE_VECTOR:    // VECTOR: [numelts, eltty]
595      if (Record.size() < 2)
596        return Error("Invalid VECTOR type record");
597      ResultTy = VectorType::get(getTypeByID(Record[1], true), Record[0]);
598      break;
599    }
600
601    if (NumRecords == TypeList.size()) {
602      // If this is a new type slot, just append it.
603      TypeList.push_back(ResultTy ? ResultTy : OpaqueType::get(Context));
604      ++NumRecords;
605    } else if (ResultTy == 0) {
606      // Otherwise, this was forward referenced, so an opaque type was created,
607      // but the result type is actually just an opaque.  Leave the one we
608      // created previously.
609      ++NumRecords;
610    } else {
611      // Otherwise, this was forward referenced, so an opaque type was created.
612      // Resolve the opaque type to the real type now.
613      assert(NumRecords < TypeList.size() && "Typelist imbalance");
614      const OpaqueType *OldTy = cast<OpaqueType>(TypeList[NumRecords++].get());
615
616      // Don't directly push the new type on the Tab. Instead we want to replace
617      // the opaque type we previously inserted with the new concrete value. The
618      // refinement from the abstract (opaque) type to the new type causes all
619      // uses of the abstract type to use the concrete type (NewTy). This will
620      // also cause the opaque type to be deleted.
621      const_cast<OpaqueType*>(OldTy)->refineAbstractTypeTo(ResultTy);
622
623      // This should have replaced the old opaque type with the new type in the
624      // value table... or with a preexisting type that was already in the
625      // system.  Let's just make sure it did.
626      assert(TypeList[NumRecords-1].get() != OldTy &&
627             "refineAbstractType didn't work!");
628    }
629  }
630}
631
632
633bool BitcodeReader::ParseTypeSymbolTable() {
634  if (Stream.EnterSubBlock(bitc::TYPE_SYMTAB_BLOCK_ID))
635    return Error("Malformed block record");
636
637  SmallVector<uint64_t, 64> Record;
638
639  // Read all the records for this type table.
640  std::string TypeName;
641  while (1) {
642    unsigned Code = Stream.ReadCode();
643    if (Code == bitc::END_BLOCK) {
644      if (Stream.ReadBlockEnd())
645        return Error("Error at end of type symbol table block");
646      return false;
647    }
648
649    if (Code == bitc::ENTER_SUBBLOCK) {
650      // No known subblocks, always skip them.
651      Stream.ReadSubBlockID();
652      if (Stream.SkipBlock())
653        return Error("Malformed block record");
654      continue;
655    }
656
657    if (Code == bitc::DEFINE_ABBREV) {
658      Stream.ReadAbbrevRecord();
659      continue;
660    }
661
662    // Read a record.
663    Record.clear();
664    switch (Stream.ReadRecord(Code, Record)) {
665    default:  // Default behavior: unknown type.
666      break;
667    case bitc::TST_CODE_ENTRY:    // TST_ENTRY: [typeid, namechar x N]
668      if (ConvertToString(Record, 1, TypeName))
669        return Error("Invalid TST_ENTRY record");
670      unsigned TypeID = Record[0];
671      if (TypeID >= TypeList.size())
672        return Error("Invalid Type ID in TST_ENTRY record");
673
674      TheModule->addTypeName(TypeName, TypeList[TypeID].get());
675      TypeName.clear();
676      break;
677    }
678  }
679}
680
681bool BitcodeReader::ParseValueSymbolTable() {
682  if (Stream.EnterSubBlock(bitc::VALUE_SYMTAB_BLOCK_ID))
683    return Error("Malformed block record");
684
685  SmallVector<uint64_t, 64> Record;
686
687  // Read all the records for this value table.
688  SmallString<128> ValueName;
689  while (1) {
690    unsigned Code = Stream.ReadCode();
691    if (Code == bitc::END_BLOCK) {
692      if (Stream.ReadBlockEnd())
693        return Error("Error at end of value symbol table block");
694      return false;
695    }
696    if (Code == bitc::ENTER_SUBBLOCK) {
697      // No known subblocks, always skip them.
698      Stream.ReadSubBlockID();
699      if (Stream.SkipBlock())
700        return Error("Malformed block record");
701      continue;
702    }
703
704    if (Code == bitc::DEFINE_ABBREV) {
705      Stream.ReadAbbrevRecord();
706      continue;
707    }
708
709    // Read a record.
710    Record.clear();
711    switch (Stream.ReadRecord(Code, Record)) {
712    default:  // Default behavior: unknown type.
713      break;
714    case bitc::VST_CODE_ENTRY: {  // VST_ENTRY: [valueid, namechar x N]
715      if (ConvertToString(Record, 1, ValueName))
716        return Error("Invalid VST_ENTRY record");
717      unsigned ValueID = Record[0];
718      if (ValueID >= ValueList.size())
719        return Error("Invalid Value ID in VST_ENTRY record");
720      Value *V = ValueList[ValueID];
721
722      V->setName(StringRef(ValueName.data(), ValueName.size()));
723      ValueName.clear();
724      break;
725    }
726    case bitc::VST_CODE_BBENTRY: {
727      if (ConvertToString(Record, 1, ValueName))
728        return Error("Invalid VST_BBENTRY record");
729      BasicBlock *BB = getBasicBlock(Record[0]);
730      if (BB == 0)
731        return Error("Invalid BB ID in VST_BBENTRY record");
732
733      BB->setName(StringRef(ValueName.data(), ValueName.size()));
734      ValueName.clear();
735      break;
736    }
737    }
738  }
739}
740
741bool BitcodeReader::ParseMetadata() {
742  unsigned NextValueNo = MDValueList.size();
743
744  if (Stream.EnterSubBlock(bitc::METADATA_BLOCK_ID))
745    return Error("Malformed block record");
746
747  SmallVector<uint64_t, 64> Record;
748
749  // Read all the records.
750  while (1) {
751    unsigned Code = Stream.ReadCode();
752    if (Code == bitc::END_BLOCK) {
753      if (Stream.ReadBlockEnd())
754        return Error("Error at end of PARAMATTR block");
755      return false;
756    }
757
758    if (Code == bitc::ENTER_SUBBLOCK) {
759      // No known subblocks, always skip them.
760      Stream.ReadSubBlockID();
761      if (Stream.SkipBlock())
762        return Error("Malformed block record");
763      continue;
764    }
765
766    if (Code == bitc::DEFINE_ABBREV) {
767      Stream.ReadAbbrevRecord();
768      continue;
769    }
770
771    // Read a record.
772    Record.clear();
773    switch (Stream.ReadRecord(Code, Record)) {
774    default:  // Default behavior: ignore.
775      break;
776    case bitc::METADATA_NAME: {
777      // Read named of the named metadata.
778      unsigned NameLength = Record.size();
779      SmallString<8> Name;
780      Name.resize(NameLength);
781      for (unsigned i = 0; i != NameLength; ++i)
782        Name[i] = Record[i];
783      Record.clear();
784      Code = Stream.ReadCode();
785
786      // METADATA_NAME is always followed by METADATA_NAMED_NODE.
787      if (Stream.ReadRecord(Code, Record) != bitc::METADATA_NAMED_NODE)
788        assert ( 0 && "Inavlid Named Metadata record");
789
790      // Read named metadata elements.
791      unsigned Size = Record.size();
792      SmallVector<MetadataBase*, 8> Elts;
793      for (unsigned i = 0; i != Size; ++i) {
794        Value *MD = MDValueList.getValueFwdRef(Record[i]);
795        if (MetadataBase *B = dyn_cast<MetadataBase>(MD))
796        Elts.push_back(B);
797      }
798      Value *V = NamedMDNode::Create(Context, Name.str(), Elts.data(),
799                                     Elts.size(), TheModule);
800      MDValueList.AssignValue(V, NextValueNo++);
801      break;
802    }
803    case bitc::METADATA_NODE: {
804      if (Record.empty() || Record.size() % 2 == 1)
805        return Error("Invalid METADATA_NODE record");
806
807      unsigned Size = Record.size();
808      SmallVector<Value*, 8> Elts;
809      for (unsigned i = 0; i != Size; i += 2) {
810        const Type *Ty = getTypeByID(Record[i], false);
811        if (Ty->isMetadataTy())
812          Elts.push_back(MDValueList.getValueFwdRef(Record[i+1]));
813        else if (Ty != Type::getVoidTy(Context))
814          Elts.push_back(ValueList.getValueFwdRef(Record[i+1], Ty));
815        else
816          Elts.push_back(NULL);
817      }
818      Value *V = MDNode::get(Context, &Elts[0], Elts.size());
819      MDValueList.AssignValue(V, NextValueNo++);
820      break;
821    }
822    case bitc::METADATA_STRING: {
823      unsigned MDStringLength = Record.size();
824      SmallString<8> String;
825      String.resize(MDStringLength);
826      for (unsigned i = 0; i != MDStringLength; ++i)
827        String[i] = Record[i];
828      Value *V = MDString::get(Context,
829                               StringRef(String.data(), String.size()));
830      MDValueList.AssignValue(V, NextValueNo++);
831      break;
832    }
833    case bitc::METADATA_KIND: {
834      unsigned RecordLength = Record.size();
835      if (Record.empty() || RecordLength < 2)
836        return Error("Invalid METADATA_KIND record");
837      SmallString<8> Name;
838      Name.resize(RecordLength-1);
839      unsigned Kind = Record[0];
840      (void) Kind;
841      for (unsigned i = 1; i != RecordLength; ++i)
842        Name[i-1] = Record[i];
843      MetadataContext &TheMetadata = Context.getMetadata();
844      unsigned ExistingKind = TheMetadata.getMDKind(Name.str());
845      if (ExistingKind == 0) {
846        unsigned NewKind = TheMetadata.registerMDKind(Name.str());
847        (void) NewKind;
848        assert (Kind == NewKind
849                && "Unable to handle custom metadata mismatch!");
850      } else {
851        assert (ExistingKind == Kind
852                && "Unable to handle custom metadata mismatch!");
853      }
854      break;
855    }
856    }
857  }
858}
859
860/// DecodeSignRotatedValue - Decode a signed value stored with the sign bit in
861/// the LSB for dense VBR encoding.
862static uint64_t DecodeSignRotatedValue(uint64_t V) {
863  if ((V & 1) == 0)
864    return V >> 1;
865  if (V != 1)
866    return -(V >> 1);
867  // There is no such thing as -0 with integers.  "-0" really means MININT.
868  return 1ULL << 63;
869}
870
871/// ResolveGlobalAndAliasInits - Resolve all of the initializers for global
872/// values and aliases that we can.
873bool BitcodeReader::ResolveGlobalAndAliasInits() {
874  std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInitWorklist;
875  std::vector<std::pair<GlobalAlias*, unsigned> > AliasInitWorklist;
876
877  GlobalInitWorklist.swap(GlobalInits);
878  AliasInitWorklist.swap(AliasInits);
879
880  while (!GlobalInitWorklist.empty()) {
881    unsigned ValID = GlobalInitWorklist.back().second;
882    if (ValID >= ValueList.size()) {
883      // Not ready to resolve this yet, it requires something later in the file.
884      GlobalInits.push_back(GlobalInitWorklist.back());
885    } else {
886      if (Constant *C = dyn_cast<Constant>(ValueList[ValID]))
887        GlobalInitWorklist.back().first->setInitializer(C);
888      else
889        return Error("Global variable initializer is not a constant!");
890    }
891    GlobalInitWorklist.pop_back();
892  }
893
894  while (!AliasInitWorklist.empty()) {
895    unsigned ValID = AliasInitWorklist.back().second;
896    if (ValID >= ValueList.size()) {
897      AliasInits.push_back(AliasInitWorklist.back());
898    } else {
899      if (Constant *C = dyn_cast<Constant>(ValueList[ValID]))
900        AliasInitWorklist.back().first->setAliasee(C);
901      else
902        return Error("Alias initializer is not a constant!");
903    }
904    AliasInitWorklist.pop_back();
905  }
906  return false;
907}
908
909bool BitcodeReader::ParseConstants() {
910  if (Stream.EnterSubBlock(bitc::CONSTANTS_BLOCK_ID))
911    return Error("Malformed block record");
912
913  SmallVector<uint64_t, 64> Record;
914
915  // Read all the records for this value table.
916  const Type *CurTy = Type::getInt32Ty(Context);
917  unsigned NextCstNo = ValueList.size();
918  while (1) {
919    unsigned Code = Stream.ReadCode();
920    if (Code == bitc::END_BLOCK)
921      break;
922
923    if (Code == bitc::ENTER_SUBBLOCK) {
924      // No known subblocks, always skip them.
925      Stream.ReadSubBlockID();
926      if (Stream.SkipBlock())
927        return Error("Malformed block record");
928      continue;
929    }
930
931    if (Code == bitc::DEFINE_ABBREV) {
932      Stream.ReadAbbrevRecord();
933      continue;
934    }
935
936    // Read a record.
937    Record.clear();
938    Value *V = 0;
939    unsigned BitCode = Stream.ReadRecord(Code, Record);
940    switch (BitCode) {
941    default:  // Default behavior: unknown constant
942    case bitc::CST_CODE_UNDEF:     // UNDEF
943      V = UndefValue::get(CurTy);
944      break;
945    case bitc::CST_CODE_SETTYPE:   // SETTYPE: [typeid]
946      if (Record.empty())
947        return Error("Malformed CST_SETTYPE record");
948      if (Record[0] >= TypeList.size())
949        return Error("Invalid Type ID in CST_SETTYPE record");
950      CurTy = TypeList[Record[0]];
951      continue;  // Skip the ValueList manipulation.
952    case bitc::CST_CODE_NULL:      // NULL
953      V = Constant::getNullValue(CurTy);
954      break;
955    case bitc::CST_CODE_INTEGER:   // INTEGER: [intval]
956      if (!isa<IntegerType>(CurTy) || Record.empty())
957        return Error("Invalid CST_INTEGER record");
958      V = ConstantInt::get(CurTy, DecodeSignRotatedValue(Record[0]));
959      break;
960    case bitc::CST_CODE_WIDE_INTEGER: {// WIDE_INTEGER: [n x intval]
961      if (!isa<IntegerType>(CurTy) || Record.empty())
962        return Error("Invalid WIDE_INTEGER record");
963
964      unsigned NumWords = Record.size();
965      SmallVector<uint64_t, 8> Words;
966      Words.resize(NumWords);
967      for (unsigned i = 0; i != NumWords; ++i)
968        Words[i] = DecodeSignRotatedValue(Record[i]);
969      V = ConstantInt::get(Context,
970                           APInt(cast<IntegerType>(CurTy)->getBitWidth(),
971                           NumWords, &Words[0]));
972      break;
973    }
974    case bitc::CST_CODE_FLOAT: {    // FLOAT: [fpval]
975      if (Record.empty())
976        return Error("Invalid FLOAT record");
977      if (CurTy->isFloatTy())
978        V = ConstantFP::get(Context, APFloat(APInt(32, (uint32_t)Record[0])));
979      else if (CurTy->isDoubleTy())
980        V = ConstantFP::get(Context, APFloat(APInt(64, Record[0])));
981      else if (CurTy->isX86_FP80Ty()) {
982        // Bits are not stored the same way as a normal i80 APInt, compensate.
983        uint64_t Rearrange[2];
984        Rearrange[0] = (Record[1] & 0xffffLL) | (Record[0] << 16);
985        Rearrange[1] = Record[0] >> 48;
986        V = ConstantFP::get(Context, APFloat(APInt(80, 2, Rearrange)));
987      } else if (CurTy->isFP128Ty())
988        V = ConstantFP::get(Context, APFloat(APInt(128, 2, &Record[0]), true));
989      else if (CurTy->isPPC_FP128Ty())
990        V = ConstantFP::get(Context, APFloat(APInt(128, 2, &Record[0])));
991      else
992        V = UndefValue::get(CurTy);
993      break;
994    }
995
996    case bitc::CST_CODE_AGGREGATE: {// AGGREGATE: [n x value number]
997      if (Record.empty())
998        return Error("Invalid CST_AGGREGATE record");
999
1000      unsigned Size = Record.size();
1001      std::vector<Constant*> Elts;
1002
1003      if (const StructType *STy = dyn_cast<StructType>(CurTy)) {
1004        for (unsigned i = 0; i != Size; ++i)
1005          Elts.push_back(ValueList.getConstantFwdRef(Record[i],
1006                                                     STy->getElementType(i)));
1007        V = ConstantStruct::get(STy, Elts);
1008      } else if (const ArrayType *ATy = dyn_cast<ArrayType>(CurTy)) {
1009        const Type *EltTy = ATy->getElementType();
1010        for (unsigned i = 0; i != Size; ++i)
1011          Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
1012        V = ConstantArray::get(ATy, Elts);
1013      } else if (const VectorType *VTy = dyn_cast<VectorType>(CurTy)) {
1014        const Type *EltTy = VTy->getElementType();
1015        for (unsigned i = 0; i != Size; ++i)
1016          Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
1017        V = ConstantVector::get(Elts);
1018      } else {
1019        V = UndefValue::get(CurTy);
1020      }
1021      break;
1022    }
1023    case bitc::CST_CODE_STRING: { // STRING: [values]
1024      if (Record.empty())
1025        return Error("Invalid CST_AGGREGATE record");
1026
1027      const ArrayType *ATy = cast<ArrayType>(CurTy);
1028      const Type *EltTy = ATy->getElementType();
1029
1030      unsigned Size = Record.size();
1031      std::vector<Constant*> Elts;
1032      for (unsigned i = 0; i != Size; ++i)
1033        Elts.push_back(ConstantInt::get(EltTy, Record[i]));
1034      V = ConstantArray::get(ATy, Elts);
1035      break;
1036    }
1037    case bitc::CST_CODE_CSTRING: { // CSTRING: [values]
1038      if (Record.empty())
1039        return Error("Invalid CST_AGGREGATE record");
1040
1041      const ArrayType *ATy = cast<ArrayType>(CurTy);
1042      const Type *EltTy = ATy->getElementType();
1043
1044      unsigned Size = Record.size();
1045      std::vector<Constant*> Elts;
1046      for (unsigned i = 0; i != Size; ++i)
1047        Elts.push_back(ConstantInt::get(EltTy, Record[i]));
1048      Elts.push_back(Constant::getNullValue(EltTy));
1049      V = ConstantArray::get(ATy, Elts);
1050      break;
1051    }
1052    case bitc::CST_CODE_CE_BINOP: {  // CE_BINOP: [opcode, opval, opval]
1053      if (Record.size() < 3) return Error("Invalid CE_BINOP record");
1054      int Opc = GetDecodedBinaryOpcode(Record[0], CurTy);
1055      if (Opc < 0) {
1056        V = UndefValue::get(CurTy);  // Unknown binop.
1057      } else {
1058        Constant *LHS = ValueList.getConstantFwdRef(Record[1], CurTy);
1059        Constant *RHS = ValueList.getConstantFwdRef(Record[2], CurTy);
1060        unsigned Flags = 0;
1061        if (Record.size() >= 4) {
1062          if (Opc == Instruction::Add ||
1063              Opc == Instruction::Sub ||
1064              Opc == Instruction::Mul) {
1065            if (Record[3] & (1 << bitc::OBO_NO_SIGNED_WRAP))
1066              Flags |= OverflowingBinaryOperator::NoSignedWrap;
1067            if (Record[3] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
1068              Flags |= OverflowingBinaryOperator::NoUnsignedWrap;
1069          } else if (Opc == Instruction::SDiv) {
1070            if (Record[3] & (1 << bitc::SDIV_EXACT))
1071              Flags |= SDivOperator::IsExact;
1072          }
1073        }
1074        V = ConstantExpr::get(Opc, LHS, RHS, Flags);
1075      }
1076      break;
1077    }
1078    case bitc::CST_CODE_CE_CAST: {  // CE_CAST: [opcode, opty, opval]
1079      if (Record.size() < 3) return Error("Invalid CE_CAST record");
1080      int Opc = GetDecodedCastOpcode(Record[0]);
1081      if (Opc < 0) {
1082        V = UndefValue::get(CurTy);  // Unknown cast.
1083      } else {
1084        const Type *OpTy = getTypeByID(Record[1]);
1085        if (!OpTy) return Error("Invalid CE_CAST record");
1086        Constant *Op = ValueList.getConstantFwdRef(Record[2], OpTy);
1087        V = ConstantExpr::getCast(Opc, Op, CurTy);
1088      }
1089      break;
1090    }
1091    case bitc::CST_CODE_CE_INBOUNDS_GEP:
1092    case bitc::CST_CODE_CE_GEP: {  // CE_GEP:        [n x operands]
1093      if (Record.size() & 1) return Error("Invalid CE_GEP record");
1094      SmallVector<Constant*, 16> Elts;
1095      for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
1096        const Type *ElTy = getTypeByID(Record[i]);
1097        if (!ElTy) return Error("Invalid CE_GEP record");
1098        Elts.push_back(ValueList.getConstantFwdRef(Record[i+1], ElTy));
1099      }
1100      if (BitCode == bitc::CST_CODE_CE_INBOUNDS_GEP)
1101        V = ConstantExpr::getInBoundsGetElementPtr(Elts[0], &Elts[1],
1102                                                   Elts.size()-1);
1103      else
1104        V = ConstantExpr::getGetElementPtr(Elts[0], &Elts[1],
1105                                           Elts.size()-1);
1106      break;
1107    }
1108    case bitc::CST_CODE_CE_SELECT:  // CE_SELECT: [opval#, opval#, opval#]
1109      if (Record.size() < 3) return Error("Invalid CE_SELECT record");
1110      V = ConstantExpr::getSelect(ValueList.getConstantFwdRef(Record[0],
1111                                                              Type::getInt1Ty(Context)),
1112                                  ValueList.getConstantFwdRef(Record[1],CurTy),
1113                                  ValueList.getConstantFwdRef(Record[2],CurTy));
1114      break;
1115    case bitc::CST_CODE_CE_EXTRACTELT: { // CE_EXTRACTELT: [opty, opval, opval]
1116      if (Record.size() < 3) return Error("Invalid CE_EXTRACTELT record");
1117      const VectorType *OpTy =
1118        dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
1119      if (OpTy == 0) return Error("Invalid CE_EXTRACTELT record");
1120      Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
1121      Constant *Op1 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
1122      V = ConstantExpr::getExtractElement(Op0, Op1);
1123      break;
1124    }
1125    case bitc::CST_CODE_CE_INSERTELT: { // CE_INSERTELT: [opval, opval, opval]
1126      const VectorType *OpTy = dyn_cast<VectorType>(CurTy);
1127      if (Record.size() < 3 || OpTy == 0)
1128        return Error("Invalid CE_INSERTELT record");
1129      Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
1130      Constant *Op1 = ValueList.getConstantFwdRef(Record[1],
1131                                                  OpTy->getElementType());
1132      Constant *Op2 = ValueList.getConstantFwdRef(Record[2], Type::getInt32Ty(Context));
1133      V = ConstantExpr::getInsertElement(Op0, Op1, Op2);
1134      break;
1135    }
1136    case bitc::CST_CODE_CE_SHUFFLEVEC: { // CE_SHUFFLEVEC: [opval, opval, opval]
1137      const VectorType *OpTy = dyn_cast<VectorType>(CurTy);
1138      if (Record.size() < 3 || OpTy == 0)
1139        return Error("Invalid CE_SHUFFLEVEC record");
1140      Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
1141      Constant *Op1 = ValueList.getConstantFwdRef(Record[1], OpTy);
1142      const Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
1143                                                 OpTy->getNumElements());
1144      Constant *Op2 = ValueList.getConstantFwdRef(Record[2], ShufTy);
1145      V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
1146      break;
1147    }
1148    case bitc::CST_CODE_CE_SHUFVEC_EX: { // [opty, opval, opval, opval]
1149      const VectorType *RTy = dyn_cast<VectorType>(CurTy);
1150      const VectorType *OpTy = dyn_cast<VectorType>(getTypeByID(Record[0]));
1151      if (Record.size() < 4 || RTy == 0 || OpTy == 0)
1152        return Error("Invalid CE_SHUFVEC_EX record");
1153      Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
1154      Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
1155      const Type *ShufTy = VectorType::get(Type::getInt32Ty(Context),
1156                                                 RTy->getNumElements());
1157      Constant *Op2 = ValueList.getConstantFwdRef(Record[3], ShufTy);
1158      V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
1159      break;
1160    }
1161    case bitc::CST_CODE_CE_CMP: {     // CE_CMP: [opty, opval, opval, pred]
1162      if (Record.size() < 4) return Error("Invalid CE_CMP record");
1163      const Type *OpTy = getTypeByID(Record[0]);
1164      if (OpTy == 0) return Error("Invalid CE_CMP record");
1165      Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
1166      Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
1167
1168      if (OpTy->isFloatingPoint())
1169        V = ConstantExpr::getFCmp(Record[3], Op0, Op1);
1170      else
1171        V = ConstantExpr::getICmp(Record[3], Op0, Op1);
1172      break;
1173    }
1174    case bitc::CST_CODE_INLINEASM: {
1175      if (Record.size() < 2) return Error("Invalid INLINEASM record");
1176      std::string AsmStr, ConstrStr;
1177      bool HasSideEffects = Record[0] & 1;
1178      bool IsAlignStack = Record[0] >> 1;
1179      unsigned AsmStrSize = Record[1];
1180      if (2+AsmStrSize >= Record.size())
1181        return Error("Invalid INLINEASM record");
1182      unsigned ConstStrSize = Record[2+AsmStrSize];
1183      if (3+AsmStrSize+ConstStrSize > Record.size())
1184        return Error("Invalid INLINEASM record");
1185
1186      for (unsigned i = 0; i != AsmStrSize; ++i)
1187        AsmStr += (char)Record[2+i];
1188      for (unsigned i = 0; i != ConstStrSize; ++i)
1189        ConstrStr += (char)Record[3+AsmStrSize+i];
1190      const PointerType *PTy = cast<PointerType>(CurTy);
1191      V = InlineAsm::get(cast<FunctionType>(PTy->getElementType()),
1192                         AsmStr, ConstrStr, HasSideEffects, IsAlignStack);
1193      break;
1194    }
1195    }
1196
1197    ValueList.AssignValue(V, NextCstNo);
1198    ++NextCstNo;
1199  }
1200
1201  if (NextCstNo != ValueList.size())
1202    return Error("Invalid constant reference!");
1203
1204  if (Stream.ReadBlockEnd())
1205    return Error("Error at end of constants block");
1206
1207  // Once all the constants have been read, go through and resolve forward
1208  // references.
1209  ValueList.ResolveConstantForwardRefs();
1210  return false;
1211}
1212
1213/// RememberAndSkipFunctionBody - When we see the block for a function body,
1214/// remember where it is and then skip it.  This lets us lazily deserialize the
1215/// functions.
1216bool BitcodeReader::RememberAndSkipFunctionBody() {
1217  // Get the function we are talking about.
1218  if (FunctionsWithBodies.empty())
1219    return Error("Insufficient function protos");
1220
1221  Function *Fn = FunctionsWithBodies.back();
1222  FunctionsWithBodies.pop_back();
1223
1224  // Save the current stream state.
1225  uint64_t CurBit = Stream.GetCurrentBitNo();
1226  DeferredFunctionInfo[Fn] = std::make_pair(CurBit, Fn->getLinkage());
1227
1228  // Set the functions linkage to GhostLinkage so we know it is lazily
1229  // deserialized.
1230  Fn->setLinkage(GlobalValue::GhostLinkage);
1231
1232  // Skip over the function block for now.
1233  if (Stream.SkipBlock())
1234    return Error("Malformed block record");
1235  return false;
1236}
1237
1238bool BitcodeReader::ParseModule(const std::string &ModuleID) {
1239  // Reject multiple MODULE_BLOCK's in a single bitstream.
1240  if (TheModule)
1241    return Error("Multiple MODULE_BLOCKs in same stream");
1242
1243  if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
1244    return Error("Malformed block record");
1245
1246  // Otherwise, create the module.
1247  TheModule = new Module(ModuleID, Context);
1248
1249  SmallVector<uint64_t, 64> Record;
1250  std::vector<std::string> SectionTable;
1251  std::vector<std::string> GCTable;
1252
1253  // Read all the records for this module.
1254  while (!Stream.AtEndOfStream()) {
1255    unsigned Code = Stream.ReadCode();
1256    if (Code == bitc::END_BLOCK) {
1257      if (Stream.ReadBlockEnd())
1258        return Error("Error at end of module block");
1259
1260      // Patch the initializers for globals and aliases up.
1261      ResolveGlobalAndAliasInits();
1262      if (!GlobalInits.empty() || !AliasInits.empty())
1263        return Error("Malformed global initializer set");
1264      if (!FunctionsWithBodies.empty())
1265        return Error("Too few function bodies found");
1266
1267      // Look for intrinsic functions which need to be upgraded at some point
1268      for (Module::iterator FI = TheModule->begin(), FE = TheModule->end();
1269           FI != FE; ++FI) {
1270        Function* NewFn;
1271        if (UpgradeIntrinsicFunction(FI, NewFn))
1272          UpgradedIntrinsics.push_back(std::make_pair(FI, NewFn));
1273      }
1274
1275      // Force deallocation of memory for these vectors to favor the client that
1276      // want lazy deserialization.
1277      std::vector<std::pair<GlobalVariable*, unsigned> >().swap(GlobalInits);
1278      std::vector<std::pair<GlobalAlias*, unsigned> >().swap(AliasInits);
1279      std::vector<Function*>().swap(FunctionsWithBodies);
1280      return false;
1281    }
1282
1283    if (Code == bitc::ENTER_SUBBLOCK) {
1284      switch (Stream.ReadSubBlockID()) {
1285      default:  // Skip unknown content.
1286        if (Stream.SkipBlock())
1287          return Error("Malformed block record");
1288        break;
1289      case bitc::BLOCKINFO_BLOCK_ID:
1290        if (Stream.ReadBlockInfoBlock())
1291          return Error("Malformed BlockInfoBlock");
1292        break;
1293      case bitc::PARAMATTR_BLOCK_ID:
1294        if (ParseAttributeBlock())
1295          return true;
1296        break;
1297      case bitc::TYPE_BLOCK_ID:
1298        if (ParseTypeTable())
1299          return true;
1300        break;
1301      case bitc::TYPE_SYMTAB_BLOCK_ID:
1302        if (ParseTypeSymbolTable())
1303          return true;
1304        break;
1305      case bitc::VALUE_SYMTAB_BLOCK_ID:
1306        if (ParseValueSymbolTable())
1307          return true;
1308        break;
1309      case bitc::CONSTANTS_BLOCK_ID:
1310        if (ParseConstants() || ResolveGlobalAndAliasInits())
1311          return true;
1312        break;
1313      case bitc::METADATA_BLOCK_ID:
1314        if (ParseMetadata())
1315          return true;
1316        break;
1317      case bitc::FUNCTION_BLOCK_ID:
1318        // If this is the first function body we've seen, reverse the
1319        // FunctionsWithBodies list.
1320        if (!HasReversedFunctionsWithBodies) {
1321          std::reverse(FunctionsWithBodies.begin(), FunctionsWithBodies.end());
1322          HasReversedFunctionsWithBodies = true;
1323        }
1324
1325        if (RememberAndSkipFunctionBody())
1326          return true;
1327        break;
1328      }
1329      continue;
1330    }
1331
1332    if (Code == bitc::DEFINE_ABBREV) {
1333      Stream.ReadAbbrevRecord();
1334      continue;
1335    }
1336
1337    // Read a record.
1338    switch (Stream.ReadRecord(Code, Record)) {
1339    default: break;  // Default behavior, ignore unknown content.
1340    case bitc::MODULE_CODE_VERSION:  // VERSION: [version#]
1341      if (Record.size() < 1)
1342        return Error("Malformed MODULE_CODE_VERSION");
1343      // Only version #0 is supported so far.
1344      if (Record[0] != 0)
1345        return Error("Unknown bitstream version!");
1346      break;
1347    case bitc::MODULE_CODE_TRIPLE: {  // TRIPLE: [strchr x N]
1348      std::string S;
1349      if (ConvertToString(Record, 0, S))
1350        return Error("Invalid MODULE_CODE_TRIPLE record");
1351      TheModule->setTargetTriple(S);
1352      break;
1353    }
1354    case bitc::MODULE_CODE_DATALAYOUT: {  // DATALAYOUT: [strchr x N]
1355      std::string S;
1356      if (ConvertToString(Record, 0, S))
1357        return Error("Invalid MODULE_CODE_DATALAYOUT record");
1358      TheModule->setDataLayout(S);
1359      break;
1360    }
1361    case bitc::MODULE_CODE_ASM: {  // ASM: [strchr x N]
1362      std::string S;
1363      if (ConvertToString(Record, 0, S))
1364        return Error("Invalid MODULE_CODE_ASM record");
1365      TheModule->setModuleInlineAsm(S);
1366      break;
1367    }
1368    case bitc::MODULE_CODE_DEPLIB: {  // DEPLIB: [strchr x N]
1369      std::string S;
1370      if (ConvertToString(Record, 0, S))
1371        return Error("Invalid MODULE_CODE_DEPLIB record");
1372      TheModule->addLibrary(S);
1373      break;
1374    }
1375    case bitc::MODULE_CODE_SECTIONNAME: {  // SECTIONNAME: [strchr x N]
1376      std::string S;
1377      if (ConvertToString(Record, 0, S))
1378        return Error("Invalid MODULE_CODE_SECTIONNAME record");
1379      SectionTable.push_back(S);
1380      break;
1381    }
1382    case bitc::MODULE_CODE_GCNAME: {  // SECTIONNAME: [strchr x N]
1383      std::string S;
1384      if (ConvertToString(Record, 0, S))
1385        return Error("Invalid MODULE_CODE_GCNAME record");
1386      GCTable.push_back(S);
1387      break;
1388    }
1389    // GLOBALVAR: [pointer type, isconst, initid,
1390    //             linkage, alignment, section, visibility, threadlocal]
1391    case bitc::MODULE_CODE_GLOBALVAR: {
1392      if (Record.size() < 6)
1393        return Error("Invalid MODULE_CODE_GLOBALVAR record");
1394      const Type *Ty = getTypeByID(Record[0]);
1395      if (!isa<PointerType>(Ty))
1396        return Error("Global not a pointer type!");
1397      unsigned AddressSpace = cast<PointerType>(Ty)->getAddressSpace();
1398      Ty = cast<PointerType>(Ty)->getElementType();
1399
1400      bool isConstant = Record[1];
1401      GlobalValue::LinkageTypes Linkage = GetDecodedLinkage(Record[3]);
1402      unsigned Alignment = (1 << Record[4]) >> 1;
1403      std::string Section;
1404      if (Record[5]) {
1405        if (Record[5]-1 >= SectionTable.size())
1406          return Error("Invalid section ID");
1407        Section = SectionTable[Record[5]-1];
1408      }
1409      GlobalValue::VisibilityTypes Visibility = GlobalValue::DefaultVisibility;
1410      if (Record.size() > 6)
1411        Visibility = GetDecodedVisibility(Record[6]);
1412      bool isThreadLocal = false;
1413      if (Record.size() > 7)
1414        isThreadLocal = Record[7];
1415
1416      GlobalVariable *NewGV =
1417        new GlobalVariable(*TheModule, Ty, isConstant, Linkage, 0, "", 0,
1418                           isThreadLocal, AddressSpace);
1419      NewGV->setAlignment(Alignment);
1420      if (!Section.empty())
1421        NewGV->setSection(Section);
1422      NewGV->setVisibility(Visibility);
1423      NewGV->setThreadLocal(isThreadLocal);
1424
1425      ValueList.push_back(NewGV);
1426
1427      // Remember which value to use for the global initializer.
1428      if (unsigned InitID = Record[2])
1429        GlobalInits.push_back(std::make_pair(NewGV, InitID-1));
1430      break;
1431    }
1432    // FUNCTION:  [type, callingconv, isproto, linkage, paramattr,
1433    //             alignment, section, visibility, gc]
1434    case bitc::MODULE_CODE_FUNCTION: {
1435      if (Record.size() < 8)
1436        return Error("Invalid MODULE_CODE_FUNCTION record");
1437      const Type *Ty = getTypeByID(Record[0]);
1438      if (!isa<PointerType>(Ty))
1439        return Error("Function not a pointer type!");
1440      const FunctionType *FTy =
1441        dyn_cast<FunctionType>(cast<PointerType>(Ty)->getElementType());
1442      if (!FTy)
1443        return Error("Function not a pointer to function type!");
1444
1445      Function *Func = Function::Create(FTy, GlobalValue::ExternalLinkage,
1446                                        "", TheModule);
1447
1448      Func->setCallingConv(static_cast<CallingConv::ID>(Record[1]));
1449      bool isProto = Record[2];
1450      Func->setLinkage(GetDecodedLinkage(Record[3]));
1451      Func->setAttributes(getAttributes(Record[4]));
1452
1453      Func->setAlignment((1 << Record[5]) >> 1);
1454      if (Record[6]) {
1455        if (Record[6]-1 >= SectionTable.size())
1456          return Error("Invalid section ID");
1457        Func->setSection(SectionTable[Record[6]-1]);
1458      }
1459      Func->setVisibility(GetDecodedVisibility(Record[7]));
1460      if (Record.size() > 8 && Record[8]) {
1461        if (Record[8]-1 > GCTable.size())
1462          return Error("Invalid GC ID");
1463        Func->setGC(GCTable[Record[8]-1].c_str());
1464      }
1465      ValueList.push_back(Func);
1466
1467      // If this is a function with a body, remember the prototype we are
1468      // creating now, so that we can match up the body with them later.
1469      if (!isProto)
1470        FunctionsWithBodies.push_back(Func);
1471      break;
1472    }
1473    // ALIAS: [alias type, aliasee val#, linkage]
1474    // ALIAS: [alias type, aliasee val#, linkage, visibility]
1475    case bitc::MODULE_CODE_ALIAS: {
1476      if (Record.size() < 3)
1477        return Error("Invalid MODULE_ALIAS record");
1478      const Type *Ty = getTypeByID(Record[0]);
1479      if (!isa<PointerType>(Ty))
1480        return Error("Function not a pointer type!");
1481
1482      GlobalAlias *NewGA = new GlobalAlias(Ty, GetDecodedLinkage(Record[2]),
1483                                           "", 0, TheModule);
1484      // Old bitcode files didn't have visibility field.
1485      if (Record.size() > 3)
1486        NewGA->setVisibility(GetDecodedVisibility(Record[3]));
1487      ValueList.push_back(NewGA);
1488      AliasInits.push_back(std::make_pair(NewGA, Record[1]));
1489      break;
1490    }
1491    /// MODULE_CODE_PURGEVALS: [numvals]
1492    case bitc::MODULE_CODE_PURGEVALS:
1493      // Trim down the value list to the specified size.
1494      if (Record.size() < 1 || Record[0] > ValueList.size())
1495        return Error("Invalid MODULE_PURGEVALS record");
1496      ValueList.shrinkTo(Record[0]);
1497      break;
1498    }
1499    Record.clear();
1500  }
1501
1502  return Error("Premature end of bitstream");
1503}
1504
1505bool BitcodeReader::ParseBitcode() {
1506  TheModule = 0;
1507
1508  if (Buffer->getBufferSize() & 3)
1509    return Error("Bitcode stream should be a multiple of 4 bytes in length");
1510
1511  unsigned char *BufPtr = (unsigned char *)Buffer->getBufferStart();
1512  unsigned char *BufEnd = BufPtr+Buffer->getBufferSize();
1513
1514  // If we have a wrapper header, parse it and ignore the non-bc file contents.
1515  // The magic number is 0x0B17C0DE stored in little endian.
1516  if (isBitcodeWrapper(BufPtr, BufEnd))
1517    if (SkipBitcodeWrapperHeader(BufPtr, BufEnd))
1518      return Error("Invalid bitcode wrapper header");
1519
1520  StreamFile.init(BufPtr, BufEnd);
1521  Stream.init(StreamFile);
1522
1523  // Sniff for the signature.
1524  if (Stream.Read(8) != 'B' ||
1525      Stream.Read(8) != 'C' ||
1526      Stream.Read(4) != 0x0 ||
1527      Stream.Read(4) != 0xC ||
1528      Stream.Read(4) != 0xE ||
1529      Stream.Read(4) != 0xD)
1530    return Error("Invalid bitcode signature");
1531
1532  // We expect a number of well-defined blocks, though we don't necessarily
1533  // need to understand them all.
1534  while (!Stream.AtEndOfStream()) {
1535    unsigned Code = Stream.ReadCode();
1536
1537    if (Code != bitc::ENTER_SUBBLOCK)
1538      return Error("Invalid record at top-level");
1539
1540    unsigned BlockID = Stream.ReadSubBlockID();
1541
1542    // We only know the MODULE subblock ID.
1543    switch (BlockID) {
1544    case bitc::BLOCKINFO_BLOCK_ID:
1545      if (Stream.ReadBlockInfoBlock())
1546        return Error("Malformed BlockInfoBlock");
1547      break;
1548    case bitc::MODULE_BLOCK_ID:
1549      if (ParseModule(Buffer->getBufferIdentifier()))
1550        return true;
1551      break;
1552    default:
1553      if (Stream.SkipBlock())
1554        return Error("Malformed block record");
1555      break;
1556    }
1557  }
1558
1559  return false;
1560}
1561
1562/// ParseMetadataAttachment - Parse metadata attachments.
1563bool BitcodeReader::ParseMetadataAttachment() {
1564  if (Stream.EnterSubBlock(bitc::METADATA_ATTACHMENT_ID))
1565    return Error("Malformed block record");
1566
1567  MetadataContext &TheMetadata = Context.getMetadata();
1568  SmallVector<uint64_t, 64> Record;
1569  while(1) {
1570    unsigned Code = Stream.ReadCode();
1571    if (Code == bitc::END_BLOCK) {
1572      if (Stream.ReadBlockEnd())
1573        return Error("Error at end of PARAMATTR block");
1574      break;
1575    }
1576    if (Code == bitc::DEFINE_ABBREV) {
1577      Stream.ReadAbbrevRecord();
1578      continue;
1579    }
1580    // Read a metadata attachment record.
1581    Record.clear();
1582    switch (Stream.ReadRecord(Code, Record)) {
1583    default:  // Default behavior: ignore.
1584      break;
1585    case bitc::METADATA_ATTACHMENT: {
1586      unsigned RecordLength = Record.size();
1587      if (Record.empty() || (RecordLength - 1) % 2 == 1)
1588        return Error ("Invalid METADATA_ATTACHMENT reader!");
1589      Instruction *Inst = InstructionList[Record[0]];
1590      for (unsigned i = 1; i != RecordLength; i = i+2) {
1591        unsigned Kind = Record[i];
1592        Value *Node = MDValueList.getValueFwdRef(Record[i+1]);
1593        TheMetadata.addMD(Kind, cast<MDNode>(Node), Inst);
1594      }
1595      break;
1596    }
1597    }
1598  }
1599  return false;
1600}
1601
1602/// ParseFunctionBody - Lazily parse the specified function body block.
1603bool BitcodeReader::ParseFunctionBody(Function *F) {
1604  if (Stream.EnterSubBlock(bitc::FUNCTION_BLOCK_ID))
1605    return Error("Malformed block record");
1606
1607  unsigned ModuleValueListSize = ValueList.size();
1608
1609  // Add all the function arguments to the value table.
1610  for(Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
1611    ValueList.push_back(I);
1612
1613  unsigned NextValueNo = ValueList.size();
1614  BasicBlock *CurBB = 0;
1615  unsigned CurBBNo = 0;
1616
1617  // Read all the records.
1618  SmallVector<uint64_t, 64> Record;
1619  while (1) {
1620    unsigned Code = Stream.ReadCode();
1621    if (Code == bitc::END_BLOCK) {
1622      if (Stream.ReadBlockEnd())
1623        return Error("Error at end of function block");
1624      break;
1625    }
1626
1627    if (Code == bitc::ENTER_SUBBLOCK) {
1628      switch (Stream.ReadSubBlockID()) {
1629      default:  // Skip unknown content.
1630        if (Stream.SkipBlock())
1631          return Error("Malformed block record");
1632        break;
1633      case bitc::CONSTANTS_BLOCK_ID:
1634        if (ParseConstants()) return true;
1635        NextValueNo = ValueList.size();
1636        break;
1637      case bitc::VALUE_SYMTAB_BLOCK_ID:
1638        if (ParseValueSymbolTable()) return true;
1639        break;
1640      case bitc::METADATA_ATTACHMENT_ID:
1641        if (ParseMetadataAttachment()) return true;
1642        break;
1643      }
1644      continue;
1645    }
1646
1647    if (Code == bitc::DEFINE_ABBREV) {
1648      Stream.ReadAbbrevRecord();
1649      continue;
1650    }
1651
1652    // Read a record.
1653    Record.clear();
1654    Instruction *I = 0;
1655    unsigned BitCode = Stream.ReadRecord(Code, Record);
1656    switch (BitCode) {
1657    default: // Default behavior: reject
1658      return Error("Unknown instruction");
1659    case bitc::FUNC_CODE_DECLAREBLOCKS:     // DECLAREBLOCKS: [nblocks]
1660      if (Record.size() < 1 || Record[0] == 0)
1661        return Error("Invalid DECLAREBLOCKS record");
1662      // Create all the basic blocks for the function.
1663      FunctionBBs.resize(Record[0]);
1664      for (unsigned i = 0, e = FunctionBBs.size(); i != e; ++i)
1665        FunctionBBs[i] = BasicBlock::Create(Context, "", F);
1666      CurBB = FunctionBBs[0];
1667      continue;
1668
1669    case bitc::FUNC_CODE_INST_BINOP: {    // BINOP: [opval, ty, opval, opcode]
1670      unsigned OpNum = 0;
1671      Value *LHS, *RHS;
1672      if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
1673          getValue(Record, OpNum, LHS->getType(), RHS) ||
1674          OpNum+1 > Record.size())
1675        return Error("Invalid BINOP record");
1676
1677      int Opc = GetDecodedBinaryOpcode(Record[OpNum++], LHS->getType());
1678      if (Opc == -1) return Error("Invalid BINOP record");
1679      I = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);
1680      InstructionList.push_back(I);
1681      if (OpNum < Record.size()) {
1682        if (Opc == Instruction::Add ||
1683            Opc == Instruction::Sub ||
1684            Opc == Instruction::Mul) {
1685          if (Record[3] & (1 << bitc::OBO_NO_SIGNED_WRAP))
1686            cast<BinaryOperator>(I)->setHasNoSignedWrap(true);
1687          if (Record[3] & (1 << bitc::OBO_NO_UNSIGNED_WRAP))
1688            cast<BinaryOperator>(I)->setHasNoUnsignedWrap(true);
1689        } else if (Opc == Instruction::SDiv) {
1690          if (Record[3] & (1 << bitc::SDIV_EXACT))
1691            cast<BinaryOperator>(I)->setIsExact(true);
1692        }
1693      }
1694      break;
1695    }
1696    case bitc::FUNC_CODE_INST_CAST: {    // CAST: [opval, opty, destty, castopc]
1697      unsigned OpNum = 0;
1698      Value *Op;
1699      if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
1700          OpNum+2 != Record.size())
1701        return Error("Invalid CAST record");
1702
1703      const Type *ResTy = getTypeByID(Record[OpNum]);
1704      int Opc = GetDecodedCastOpcode(Record[OpNum+1]);
1705      if (Opc == -1 || ResTy == 0)
1706        return Error("Invalid CAST record");
1707      I = CastInst::Create((Instruction::CastOps)Opc, Op, ResTy);
1708      InstructionList.push_back(I);
1709      break;
1710    }
1711    case bitc::FUNC_CODE_INST_INBOUNDS_GEP:
1712    case bitc::FUNC_CODE_INST_GEP: { // GEP: [n x operands]
1713      unsigned OpNum = 0;
1714      Value *BasePtr;
1715      if (getValueTypePair(Record, OpNum, NextValueNo, BasePtr))
1716        return Error("Invalid GEP record");
1717
1718      SmallVector<Value*, 16> GEPIdx;
1719      while (OpNum != Record.size()) {
1720        Value *Op;
1721        if (getValueTypePair(Record, OpNum, NextValueNo, Op))
1722          return Error("Invalid GEP record");
1723        GEPIdx.push_back(Op);
1724      }
1725
1726      I = GetElementPtrInst::Create(BasePtr, GEPIdx.begin(), GEPIdx.end());
1727      InstructionList.push_back(I);
1728      if (BitCode == bitc::FUNC_CODE_INST_INBOUNDS_GEP)
1729        cast<GetElementPtrInst>(I)->setIsInBounds(true);
1730      break;
1731    }
1732
1733    case bitc::FUNC_CODE_INST_EXTRACTVAL: {
1734                                       // EXTRACTVAL: [opty, opval, n x indices]
1735      unsigned OpNum = 0;
1736      Value *Agg;
1737      if (getValueTypePair(Record, OpNum, NextValueNo, Agg))
1738        return Error("Invalid EXTRACTVAL record");
1739
1740      SmallVector<unsigned, 4> EXTRACTVALIdx;
1741      for (unsigned RecSize = Record.size();
1742           OpNum != RecSize; ++OpNum) {
1743        uint64_t Index = Record[OpNum];
1744        if ((unsigned)Index != Index)
1745          return Error("Invalid EXTRACTVAL index");
1746        EXTRACTVALIdx.push_back((unsigned)Index);
1747      }
1748
1749      I = ExtractValueInst::Create(Agg,
1750                                   EXTRACTVALIdx.begin(), EXTRACTVALIdx.end());
1751      InstructionList.push_back(I);
1752      break;
1753    }
1754
1755    case bitc::FUNC_CODE_INST_INSERTVAL: {
1756                           // INSERTVAL: [opty, opval, opty, opval, n x indices]
1757      unsigned OpNum = 0;
1758      Value *Agg;
1759      if (getValueTypePair(Record, OpNum, NextValueNo, Agg))
1760        return Error("Invalid INSERTVAL record");
1761      Value *Val;
1762      if (getValueTypePair(Record, OpNum, NextValueNo, Val))
1763        return Error("Invalid INSERTVAL record");
1764
1765      SmallVector<unsigned, 4> INSERTVALIdx;
1766      for (unsigned RecSize = Record.size();
1767           OpNum != RecSize; ++OpNum) {
1768        uint64_t Index = Record[OpNum];
1769        if ((unsigned)Index != Index)
1770          return Error("Invalid INSERTVAL index");
1771        INSERTVALIdx.push_back((unsigned)Index);
1772      }
1773
1774      I = InsertValueInst::Create(Agg, Val,
1775                                  INSERTVALIdx.begin(), INSERTVALIdx.end());
1776      InstructionList.push_back(I);
1777      break;
1778    }
1779
1780    case bitc::FUNC_CODE_INST_SELECT: { // SELECT: [opval, ty, opval, opval]
1781      // obsolete form of select
1782      // handles select i1 ... in old bitcode
1783      unsigned OpNum = 0;
1784      Value *TrueVal, *FalseVal, *Cond;
1785      if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
1786          getValue(Record, OpNum, TrueVal->getType(), FalseVal) ||
1787          getValue(Record, OpNum, Type::getInt1Ty(Context), Cond))
1788        return Error("Invalid SELECT record");
1789
1790      I = SelectInst::Create(Cond, TrueVal, FalseVal);
1791      InstructionList.push_back(I);
1792      break;
1793    }
1794
1795    case bitc::FUNC_CODE_INST_VSELECT: {// VSELECT: [ty,opval,opval,predty,pred]
1796      // new form of select
1797      // handles select i1 or select [N x i1]
1798      unsigned OpNum = 0;
1799      Value *TrueVal, *FalseVal, *Cond;
1800      if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
1801          getValue(Record, OpNum, TrueVal->getType(), FalseVal) ||
1802          getValueTypePair(Record, OpNum, NextValueNo, Cond))
1803        return Error("Invalid SELECT record");
1804
1805      // select condition can be either i1 or [N x i1]
1806      if (const VectorType* vector_type =
1807          dyn_cast<const VectorType>(Cond->getType())) {
1808        // expect <n x i1>
1809        if (vector_type->getElementType() != Type::getInt1Ty(Context))
1810          return Error("Invalid SELECT condition type");
1811      } else {
1812        // expect i1
1813        if (Cond->getType() != Type::getInt1Ty(Context))
1814          return Error("Invalid SELECT condition type");
1815      }
1816
1817      I = SelectInst::Create(Cond, TrueVal, FalseVal);
1818      InstructionList.push_back(I);
1819      break;
1820    }
1821
1822    case bitc::FUNC_CODE_INST_EXTRACTELT: { // EXTRACTELT: [opty, opval, opval]
1823      unsigned OpNum = 0;
1824      Value *Vec, *Idx;
1825      if (getValueTypePair(Record, OpNum, NextValueNo, Vec) ||
1826          getValue(Record, OpNum, Type::getInt32Ty(Context), Idx))
1827        return Error("Invalid EXTRACTELT record");
1828      I = ExtractElementInst::Create(Vec, Idx);
1829      InstructionList.push_back(I);
1830      break;
1831    }
1832
1833    case bitc::FUNC_CODE_INST_INSERTELT: { // INSERTELT: [ty, opval,opval,opval]
1834      unsigned OpNum = 0;
1835      Value *Vec, *Elt, *Idx;
1836      if (getValueTypePair(Record, OpNum, NextValueNo, Vec) ||
1837          getValue(Record, OpNum,
1838                   cast<VectorType>(Vec->getType())->getElementType(), Elt) ||
1839          getValue(Record, OpNum, Type::getInt32Ty(Context), Idx))
1840        return Error("Invalid INSERTELT record");
1841      I = InsertElementInst::Create(Vec, Elt, Idx);
1842      InstructionList.push_back(I);
1843      break;
1844    }
1845
1846    case bitc::FUNC_CODE_INST_SHUFFLEVEC: {// SHUFFLEVEC: [opval,ty,opval,opval]
1847      unsigned OpNum = 0;
1848      Value *Vec1, *Vec2, *Mask;
1849      if (getValueTypePair(Record, OpNum, NextValueNo, Vec1) ||
1850          getValue(Record, OpNum, Vec1->getType(), Vec2))
1851        return Error("Invalid SHUFFLEVEC record");
1852
1853      if (getValueTypePair(Record, OpNum, NextValueNo, Mask))
1854        return Error("Invalid SHUFFLEVEC record");
1855      I = new ShuffleVectorInst(Vec1, Vec2, Mask);
1856      InstructionList.push_back(I);
1857      break;
1858    }
1859
1860    case bitc::FUNC_CODE_INST_CMP:   // CMP: [opty, opval, opval, pred]
1861      // Old form of ICmp/FCmp returning bool
1862      // Existed to differentiate between icmp/fcmp and vicmp/vfcmp which were
1863      // both legal on vectors but had different behaviour.
1864    case bitc::FUNC_CODE_INST_CMP2: { // CMP2: [opty, opval, opval, pred]
1865      // FCmp/ICmp returning bool or vector of bool
1866
1867      unsigned OpNum = 0;
1868      Value *LHS, *RHS;
1869      if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
1870          getValue(Record, OpNum, LHS->getType(), RHS) ||
1871          OpNum+1 != Record.size())
1872        return Error("Invalid CMP record");
1873
1874      if (LHS->getType()->isFPOrFPVector())
1875        I = new FCmpInst((FCmpInst::Predicate)Record[OpNum], LHS, RHS);
1876      else
1877        I = new ICmpInst((ICmpInst::Predicate)Record[OpNum], LHS, RHS);
1878      InstructionList.push_back(I);
1879      break;
1880    }
1881
1882    case bitc::FUNC_CODE_INST_GETRESULT: { // GETRESULT: [ty, val, n]
1883      if (Record.size() != 2)
1884        return Error("Invalid GETRESULT record");
1885      unsigned OpNum = 0;
1886      Value *Op;
1887      getValueTypePair(Record, OpNum, NextValueNo, Op);
1888      unsigned Index = Record[1];
1889      I = ExtractValueInst::Create(Op, Index);
1890      InstructionList.push_back(I);
1891      break;
1892    }
1893
1894    case bitc::FUNC_CODE_INST_RET: // RET: [opty,opval<optional>]
1895      {
1896        unsigned Size = Record.size();
1897        if (Size == 0) {
1898          I = ReturnInst::Create(Context);
1899          InstructionList.push_back(I);
1900          break;
1901        }
1902
1903        unsigned OpNum = 0;
1904        SmallVector<Value *,4> Vs;
1905        do {
1906          Value *Op = NULL;
1907          if (getValueTypePair(Record, OpNum, NextValueNo, Op))
1908            return Error("Invalid RET record");
1909          Vs.push_back(Op);
1910        } while(OpNum != Record.size());
1911
1912        const Type *ReturnType = F->getReturnType();
1913        if (Vs.size() > 1 ||
1914            (isa<StructType>(ReturnType) &&
1915             (Vs.empty() || Vs[0]->getType() != ReturnType))) {
1916          Value *RV = UndefValue::get(ReturnType);
1917          for (unsigned i = 0, e = Vs.size(); i != e; ++i) {
1918            I = InsertValueInst::Create(RV, Vs[i], i, "mrv");
1919            InstructionList.push_back(I);
1920            CurBB->getInstList().push_back(I);
1921            ValueList.AssignValue(I, NextValueNo++);
1922            RV = I;
1923          }
1924          I = ReturnInst::Create(Context, RV);
1925          InstructionList.push_back(I);
1926          break;
1927        }
1928
1929        I = ReturnInst::Create(Context, Vs[0]);
1930        InstructionList.push_back(I);
1931        break;
1932      }
1933    case bitc::FUNC_CODE_INST_BR: { // BR: [bb#, bb#, opval] or [bb#]
1934      if (Record.size() != 1 && Record.size() != 3)
1935        return Error("Invalid BR record");
1936      BasicBlock *TrueDest = getBasicBlock(Record[0]);
1937      if (TrueDest == 0)
1938        return Error("Invalid BR record");
1939
1940      if (Record.size() == 1) {
1941        I = BranchInst::Create(TrueDest);
1942        InstructionList.push_back(I);
1943      }
1944      else {
1945        BasicBlock *FalseDest = getBasicBlock(Record[1]);
1946        Value *Cond = getFnValueByID(Record[2], Type::getInt1Ty(Context));
1947        if (FalseDest == 0 || Cond == 0)
1948          return Error("Invalid BR record");
1949        I = BranchInst::Create(TrueDest, FalseDest, Cond);
1950        InstructionList.push_back(I);
1951      }
1952      break;
1953    }
1954    case bitc::FUNC_CODE_INST_SWITCH: { // SWITCH: [opty, op0, op1, ...]
1955      if (Record.size() < 3 || (Record.size() & 1) == 0)
1956        return Error("Invalid SWITCH record");
1957      const Type *OpTy = getTypeByID(Record[0]);
1958      Value *Cond = getFnValueByID(Record[1], OpTy);
1959      BasicBlock *Default = getBasicBlock(Record[2]);
1960      if (OpTy == 0 || Cond == 0 || Default == 0)
1961        return Error("Invalid SWITCH record");
1962      unsigned NumCases = (Record.size()-3)/2;
1963      SwitchInst *SI = SwitchInst::Create(Cond, Default, NumCases);
1964      InstructionList.push_back(SI);
1965      for (unsigned i = 0, e = NumCases; i != e; ++i) {
1966        ConstantInt *CaseVal =
1967          dyn_cast_or_null<ConstantInt>(getFnValueByID(Record[3+i*2], OpTy));
1968        BasicBlock *DestBB = getBasicBlock(Record[1+3+i*2]);
1969        if (CaseVal == 0 || DestBB == 0) {
1970          delete SI;
1971          return Error("Invalid SWITCH record!");
1972        }
1973        SI->addCase(CaseVal, DestBB);
1974      }
1975      I = SI;
1976      break;
1977    }
1978    case bitc::FUNC_CODE_INST_INDBR: { // INDBR: [opty, op0, op1, ...]
1979      if (Record.size() < 2)
1980        return Error("Invalid INDBR record");
1981      const Type *OpTy = getTypeByID(Record[0]);
1982      Value *Address = getFnValueByID(Record[1], OpTy);
1983      if (OpTy == 0 || Address == 0)
1984        return Error("Invalid INDBR record");
1985      unsigned NumDests = Record.size()-2;
1986      IndBrInst *IBI = IndBrInst::Create(Address, NumDests);
1987      InstructionList.push_back(IBI);
1988      for (unsigned i = 0, e = NumDests; i != e; ++i) {
1989        if (BasicBlock *DestBB = getBasicBlock(Record[2+i])) {
1990          IBI->addDestination(DestBB);
1991        } else {
1992          delete IBI;
1993          return Error("Invalid INDBR record!");
1994        }
1995      }
1996      I = IBI;
1997      break;
1998    }
1999
2000    case bitc::FUNC_CODE_INST_INVOKE: {
2001      // INVOKE: [attrs, cc, normBB, unwindBB, fnty, op0,op1,op2, ...]
2002      if (Record.size() < 4) return Error("Invalid INVOKE record");
2003      AttrListPtr PAL = getAttributes(Record[0]);
2004      unsigned CCInfo = Record[1];
2005      BasicBlock *NormalBB = getBasicBlock(Record[2]);
2006      BasicBlock *UnwindBB = getBasicBlock(Record[3]);
2007
2008      unsigned OpNum = 4;
2009      Value *Callee;
2010      if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
2011        return Error("Invalid INVOKE record");
2012
2013      const PointerType *CalleeTy = dyn_cast<PointerType>(Callee->getType());
2014      const FunctionType *FTy = !CalleeTy ? 0 :
2015        dyn_cast<FunctionType>(CalleeTy->getElementType());
2016
2017      // Check that the right number of fixed parameters are here.
2018      if (FTy == 0 || NormalBB == 0 || UnwindBB == 0 ||
2019          Record.size() < OpNum+FTy->getNumParams())
2020        return Error("Invalid INVOKE record");
2021
2022      SmallVector<Value*, 16> Ops;
2023      for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
2024        Ops.push_back(getFnValueByID(Record[OpNum], FTy->getParamType(i)));
2025        if (Ops.back() == 0) return Error("Invalid INVOKE record");
2026      }
2027
2028      if (!FTy->isVarArg()) {
2029        if (Record.size() != OpNum)
2030          return Error("Invalid INVOKE record");
2031      } else {
2032        // Read type/value pairs for varargs params.
2033        while (OpNum != Record.size()) {
2034          Value *Op;
2035          if (getValueTypePair(Record, OpNum, NextValueNo, Op))
2036            return Error("Invalid INVOKE record");
2037          Ops.push_back(Op);
2038        }
2039      }
2040
2041      I = InvokeInst::Create(Callee, NormalBB, UnwindBB,
2042                             Ops.begin(), Ops.end());
2043      InstructionList.push_back(I);
2044      cast<InvokeInst>(I)->setCallingConv(
2045        static_cast<CallingConv::ID>(CCInfo));
2046      cast<InvokeInst>(I)->setAttributes(PAL);
2047      break;
2048    }
2049    case bitc::FUNC_CODE_INST_UNWIND: // UNWIND
2050      I = new UnwindInst(Context);
2051      InstructionList.push_back(I);
2052      break;
2053    case bitc::FUNC_CODE_INST_UNREACHABLE: // UNREACHABLE
2054      I = new UnreachableInst(Context);
2055      InstructionList.push_back(I);
2056      break;
2057    case bitc::FUNC_CODE_INST_PHI: { // PHI: [ty, val0,bb0, ...]
2058      if (Record.size() < 1 || ((Record.size()-1)&1))
2059        return Error("Invalid PHI record");
2060      const Type *Ty = getTypeByID(Record[0]);
2061      if (!Ty) return Error("Invalid PHI record");
2062
2063      PHINode *PN = PHINode::Create(Ty);
2064      InstructionList.push_back(PN);
2065      PN->reserveOperandSpace((Record.size()-1)/2);
2066
2067      for (unsigned i = 0, e = Record.size()-1; i != e; i += 2) {
2068        Value *V = getFnValueByID(Record[1+i], Ty);
2069        BasicBlock *BB = getBasicBlock(Record[2+i]);
2070        if (!V || !BB) return Error("Invalid PHI record");
2071        PN->addIncoming(V, BB);
2072      }
2073      I = PN;
2074      break;
2075    }
2076
2077    case bitc::FUNC_CODE_INST_MALLOC: { // MALLOC: [instty, op, align]
2078      // Autoupgrade malloc instruction to malloc call.
2079      // FIXME: Remove in LLVM 3.0.
2080      if (Record.size() < 3)
2081        return Error("Invalid MALLOC record");
2082      const PointerType *Ty =
2083        dyn_cast_or_null<PointerType>(getTypeByID(Record[0]));
2084      Value *Size = getFnValueByID(Record[1], Type::getInt32Ty(Context));
2085      if (!Ty || !Size) return Error("Invalid MALLOC record");
2086      if (!CurBB) return Error("Invalid malloc instruction with no BB");
2087      const Type *Int32Ty = IntegerType::getInt32Ty(CurBB->getContext());
2088      I = CallInst::CreateMalloc(CurBB, Int32Ty, Ty->getElementType(),
2089                                 Size, NULL);
2090      InstructionList.push_back(I);
2091      break;
2092    }
2093    case bitc::FUNC_CODE_INST_FREE: { // FREE: [op, opty]
2094      unsigned OpNum = 0;
2095      Value *Op;
2096      if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
2097          OpNum != Record.size())
2098        return Error("Invalid FREE record");
2099      if (!CurBB) return Error("Invalid free instruction with no BB");
2100      I = CallInst::CreateFree(Op, CurBB);
2101      InstructionList.push_back(I);
2102      break;
2103    }
2104    case bitc::FUNC_CODE_INST_ALLOCA: { // ALLOCA: [instty, op, align]
2105      if (Record.size() < 3)
2106        return Error("Invalid ALLOCA record");
2107      const PointerType *Ty =
2108        dyn_cast_or_null<PointerType>(getTypeByID(Record[0]));
2109      Value *Size = getFnValueByID(Record[1], Type::getInt32Ty(Context));
2110      unsigned Align = Record[2];
2111      if (!Ty || !Size) return Error("Invalid ALLOCA record");
2112      I = new AllocaInst(Ty->getElementType(), Size, (1 << Align) >> 1);
2113      InstructionList.push_back(I);
2114      break;
2115    }
2116    case bitc::FUNC_CODE_INST_LOAD: { // LOAD: [opty, op, align, vol]
2117      unsigned OpNum = 0;
2118      Value *Op;
2119      if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
2120          OpNum+2 != Record.size())
2121        return Error("Invalid LOAD record");
2122
2123      I = new LoadInst(Op, "", Record[OpNum+1], (1 << Record[OpNum]) >> 1);
2124      InstructionList.push_back(I);
2125      break;
2126    }
2127    case bitc::FUNC_CODE_INST_STORE2: { // STORE2:[ptrty, ptr, val, align, vol]
2128      unsigned OpNum = 0;
2129      Value *Val, *Ptr;
2130      if (getValueTypePair(Record, OpNum, NextValueNo, Ptr) ||
2131          getValue(Record, OpNum,
2132                    cast<PointerType>(Ptr->getType())->getElementType(), Val) ||
2133          OpNum+2 != Record.size())
2134        return Error("Invalid STORE record");
2135
2136      I = new StoreInst(Val, Ptr, Record[OpNum+1], (1 << Record[OpNum]) >> 1);
2137      InstructionList.push_back(I);
2138      break;
2139    }
2140    case bitc::FUNC_CODE_INST_STORE: { // STORE:[val, valty, ptr, align, vol]
2141      // FIXME: Legacy form of store instruction. Should be removed in LLVM 3.0.
2142      unsigned OpNum = 0;
2143      Value *Val, *Ptr;
2144      if (getValueTypePair(Record, OpNum, NextValueNo, Val) ||
2145          getValue(Record, OpNum,
2146                   PointerType::getUnqual(Val->getType()), Ptr)||
2147          OpNum+2 != Record.size())
2148        return Error("Invalid STORE record");
2149
2150      I = new StoreInst(Val, Ptr, Record[OpNum+1], (1 << Record[OpNum]) >> 1);
2151      InstructionList.push_back(I);
2152      break;
2153    }
2154    case bitc::FUNC_CODE_INST_CALL: {
2155      // CALL: [paramattrs, cc, fnty, fnid, arg0, arg1...]
2156      if (Record.size() < 3)
2157        return Error("Invalid CALL record");
2158
2159      AttrListPtr PAL = getAttributes(Record[0]);
2160      unsigned CCInfo = Record[1];
2161
2162      unsigned OpNum = 2;
2163      Value *Callee;
2164      if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
2165        return Error("Invalid CALL record");
2166
2167      const PointerType *OpTy = dyn_cast<PointerType>(Callee->getType());
2168      const FunctionType *FTy = 0;
2169      if (OpTy) FTy = dyn_cast<FunctionType>(OpTy->getElementType());
2170      if (!FTy || Record.size() < FTy->getNumParams()+OpNum)
2171        return Error("Invalid CALL record");
2172
2173      SmallVector<Value*, 16> Args;
2174      // Read the fixed params.
2175      for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
2176        if (FTy->getParamType(i)->getTypeID()==Type::LabelTyID)
2177          Args.push_back(getBasicBlock(Record[OpNum]));
2178        else
2179          Args.push_back(getFnValueByID(Record[OpNum], FTy->getParamType(i)));
2180        if (Args.back() == 0) return Error("Invalid CALL record");
2181      }
2182
2183      // Read type/value pairs for varargs params.
2184      if (!FTy->isVarArg()) {
2185        if (OpNum != Record.size())
2186          return Error("Invalid CALL record");
2187      } else {
2188        while (OpNum != Record.size()) {
2189          Value *Op;
2190          if (getValueTypePair(Record, OpNum, NextValueNo, Op))
2191            return Error("Invalid CALL record");
2192          Args.push_back(Op);
2193        }
2194      }
2195
2196      I = CallInst::Create(Callee, Args.begin(), Args.end());
2197      InstructionList.push_back(I);
2198      cast<CallInst>(I)->setCallingConv(
2199        static_cast<CallingConv::ID>(CCInfo>>1));
2200      cast<CallInst>(I)->setTailCall(CCInfo & 1);
2201      cast<CallInst>(I)->setAttributes(PAL);
2202      break;
2203    }
2204    case bitc::FUNC_CODE_INST_VAARG: { // VAARG: [valistty, valist, instty]
2205      if (Record.size() < 3)
2206        return Error("Invalid VAARG record");
2207      const Type *OpTy = getTypeByID(Record[0]);
2208      Value *Op = getFnValueByID(Record[1], OpTy);
2209      const Type *ResTy = getTypeByID(Record[2]);
2210      if (!OpTy || !Op || !ResTy)
2211        return Error("Invalid VAARG record");
2212      I = new VAArgInst(Op, ResTy);
2213      InstructionList.push_back(I);
2214      break;
2215    }
2216    }
2217
2218    // Add instruction to end of current BB.  If there is no current BB, reject
2219    // this file.
2220    if (CurBB == 0) {
2221      delete I;
2222      return Error("Invalid instruction with no BB");
2223    }
2224    CurBB->getInstList().push_back(I);
2225
2226    // If this was a terminator instruction, move to the next block.
2227    if (isa<TerminatorInst>(I)) {
2228      ++CurBBNo;
2229      CurBB = CurBBNo < FunctionBBs.size() ? FunctionBBs[CurBBNo] : 0;
2230    }
2231
2232    // Non-void values get registered in the value table for future use.
2233    if (I && I->getType() != Type::getVoidTy(Context))
2234      ValueList.AssignValue(I, NextValueNo++);
2235  }
2236
2237  // Check the function list for unresolved values.
2238  if (Argument *A = dyn_cast<Argument>(ValueList.back())) {
2239    if (A->getParent() == 0) {
2240      // We found at least one unresolved value.  Nuke them all to avoid leaks.
2241      for (unsigned i = ModuleValueListSize, e = ValueList.size(); i != e; ++i){
2242        if ((A = dyn_cast<Argument>(ValueList.back())) && A->getParent() == 0) {
2243          A->replaceAllUsesWith(UndefValue::get(A->getType()));
2244          delete A;
2245        }
2246      }
2247      return Error("Never resolved value found in function!");
2248    }
2249  }
2250
2251  // Trim the value list down to the size it was before we parsed this function.
2252  ValueList.shrinkTo(ModuleValueListSize);
2253  std::vector<BasicBlock*>().swap(FunctionBBs);
2254
2255  return false;
2256}
2257
2258//===----------------------------------------------------------------------===//
2259// ModuleProvider implementation
2260//===----------------------------------------------------------------------===//
2261
2262
2263bool BitcodeReader::materializeFunction(Function *F, std::string *ErrInfo) {
2264  // If it already is material, ignore the request.
2265  if (!F->hasNotBeenReadFromBitcode()) return false;
2266
2267  DenseMap<Function*, std::pair<uint64_t, unsigned> >::iterator DFII =
2268    DeferredFunctionInfo.find(F);
2269  assert(DFII != DeferredFunctionInfo.end() && "Deferred function not found!");
2270
2271  // Move the bit stream to the saved position of the deferred function body and
2272  // restore the real linkage type for the function.
2273  Stream.JumpToBit(DFII->second.first);
2274  F->setLinkage((GlobalValue::LinkageTypes)DFII->second.second);
2275
2276  if (ParseFunctionBody(F)) {
2277    if (ErrInfo) *ErrInfo = ErrorString;
2278    return true;
2279  }
2280
2281  // Upgrade any old intrinsic calls in the function.
2282  for (UpgradedIntrinsicMap::iterator I = UpgradedIntrinsics.begin(),
2283       E = UpgradedIntrinsics.end(); I != E; ++I) {
2284    if (I->first != I->second) {
2285      for (Value::use_iterator UI = I->first->use_begin(),
2286           UE = I->first->use_end(); UI != UE; ) {
2287        if (CallInst* CI = dyn_cast<CallInst>(*UI++))
2288          UpgradeIntrinsicCall(CI, I->second);
2289      }
2290    }
2291  }
2292
2293  return false;
2294}
2295
2296void BitcodeReader::dematerializeFunction(Function *F) {
2297  // If this function isn't materialized, or if it is a proto, this is a noop.
2298  if (F->hasNotBeenReadFromBitcode() || F->isDeclaration())
2299    return;
2300
2301  assert(DeferredFunctionInfo.count(F) && "No info to read function later?");
2302
2303  // Just forget the function body, we can remat it later.
2304  F->deleteBody();
2305  F->setLinkage(GlobalValue::GhostLinkage);
2306}
2307
2308
2309Module *BitcodeReader::materializeModule(std::string *ErrInfo) {
2310  // Iterate over the module, deserializing any functions that are still on
2311  // disk.
2312  for (Module::iterator F = TheModule->begin(), E = TheModule->end();
2313       F != E; ++F)
2314    if (F->hasNotBeenReadFromBitcode() &&
2315        materializeFunction(F, ErrInfo))
2316      return 0;
2317
2318  // Upgrade any intrinsic calls that slipped through (should not happen!) and
2319  // delete the old functions to clean up. We can't do this unless the entire
2320  // module is materialized because there could always be another function body
2321  // with calls to the old function.
2322  for (std::vector<std::pair<Function*, Function*> >::iterator I =
2323       UpgradedIntrinsics.begin(), E = UpgradedIntrinsics.end(); I != E; ++I) {
2324    if (I->first != I->second) {
2325      for (Value::use_iterator UI = I->first->use_begin(),
2326           UE = I->first->use_end(); UI != UE; ) {
2327        if (CallInst* CI = dyn_cast<CallInst>(*UI++))
2328          UpgradeIntrinsicCall(CI, I->second);
2329      }
2330      if (!I->first->use_empty())
2331        I->first->replaceAllUsesWith(I->second);
2332      I->first->eraseFromParent();
2333    }
2334  }
2335  std::vector<std::pair<Function*, Function*> >().swap(UpgradedIntrinsics);
2336
2337  // Check debug info intrinsics.
2338  CheckDebugInfoIntrinsics(TheModule);
2339
2340  return TheModule;
2341}
2342
2343
2344/// This method is provided by the parent ModuleProvde class and overriden
2345/// here. It simply releases the module from its provided and frees up our
2346/// state.
2347/// @brief Release our hold on the generated module
2348Module *BitcodeReader::releaseModule(std::string *ErrInfo) {
2349  // Since we're losing control of this Module, we must hand it back complete
2350  Module *M = ModuleProvider::releaseModule(ErrInfo);
2351  FreeState();
2352  return M;
2353}
2354
2355
2356//===----------------------------------------------------------------------===//
2357// External interface
2358//===----------------------------------------------------------------------===//
2359
2360/// getBitcodeModuleProvider - lazy function-at-a-time loading from a file.
2361///
2362ModuleProvider *llvm::getBitcodeModuleProvider(MemoryBuffer *Buffer,
2363                                               LLVMContext& Context,
2364                                               std::string *ErrMsg) {
2365  BitcodeReader *R = new BitcodeReader(Buffer, Context);
2366  if (R->ParseBitcode()) {
2367    if (ErrMsg)
2368      *ErrMsg = R->getErrorString();
2369
2370    // Don't let the BitcodeReader dtor delete 'Buffer'.
2371    R->releaseMemoryBuffer();
2372    delete R;
2373    return 0;
2374  }
2375  return R;
2376}
2377
2378/// ParseBitcodeFile - Read the specified bitcode file, returning the module.
2379/// If an error occurs, return null and fill in *ErrMsg if non-null.
2380Module *llvm::ParseBitcodeFile(MemoryBuffer *Buffer, LLVMContext& Context,
2381                               std::string *ErrMsg){
2382  BitcodeReader *R;
2383  R = static_cast<BitcodeReader*>(getBitcodeModuleProvider(Buffer, Context,
2384                                                           ErrMsg));
2385  if (!R) return 0;
2386
2387  // Read in the entire module.
2388  Module *M = R->materializeModule(ErrMsg);
2389
2390  // Don't let the BitcodeReader dtor delete 'Buffer', regardless of whether
2391  // there was an error.
2392  R->releaseMemoryBuffer();
2393
2394  // If there was no error, tell ModuleProvider not to delete it when its dtor
2395  // is run.
2396  if (M)
2397    M = R->releaseModule(ErrMsg);
2398
2399  delete R;
2400  return M;
2401}
2402