BitcodeReader.cpp revision 9d5f45607793052bf5b4436d1b43013fab9999ac 
1//===- BitcodeReader.cpp - Internal BitcodeReader implementation ----------===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file was developed by Chris Lattner and is distributed under
6// the University of Illinois Open Source 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/Instructions.h"
20#include "llvm/Module.h"
21#include "llvm/ParameterAttributes.h"
22#include "llvm/AutoUpgrade.h"
23#include "llvm/ADT/SmallString.h"
24#include "llvm/Support/MathExtras.h"
25#include "llvm/Support/MemoryBuffer.h"
26using namespace llvm;
27
28void BitcodeReader::FreeState() {
29  delete Buffer;
30  Buffer = 0;
31  std::vector<PATypeHolder>().swap(TypeList);
32  ValueList.clear();
33  std::vector<const ParamAttrsList*>().swap(ParamAttrs);
34  std::vector<BasicBlock*>().swap(FunctionBBs);
35  std::vector<Function*>().swap(FunctionsWithBodies);
36  DeferredFunctionInfo.clear();
37}
38
39//===----------------------------------------------------------------------===//
40//  Helper functions to implement forward reference resolution, etc.
41//===----------------------------------------------------------------------===//
42
43/// ConvertToString - Convert a string from a record into an std::string, return
44/// true on failure.
45template<typename StrTy>
46static bool ConvertToString(SmallVector<uint64_t, 64> &Record, unsigned Idx,
47                            StrTy &Result) {
48  if (Idx > Record.size())
49    return true;
50
51  for (unsigned i = Idx, e = Record.size(); i != e; ++i)
52    Result += (char)Record[i];
53  return false;
54}
55
56static GlobalValue::LinkageTypes GetDecodedLinkage(unsigned Val) {
57  switch (Val) {
58  default: // Map unknown/new linkages to external
59  case 0: return GlobalValue::ExternalLinkage;
60  case 1: return GlobalValue::WeakLinkage;
61  case 2: return GlobalValue::AppendingLinkage;
62  case 3: return GlobalValue::InternalLinkage;
63  case 4: return GlobalValue::LinkOnceLinkage;
64  case 5: return GlobalValue::DLLImportLinkage;
65  case 6: return GlobalValue::DLLExportLinkage;
66  case 7: return GlobalValue::ExternalWeakLinkage;
67  }
68}
69
70static GlobalValue::VisibilityTypes GetDecodedVisibility(unsigned Val) {
71  switch (Val) {
72  default: // Map unknown visibilities to default.
73  case 0: return GlobalValue::DefaultVisibility;
74  case 1: return GlobalValue::HiddenVisibility;
75  case 2: return GlobalValue::ProtectedVisibility;
76  }
77}
78
79static int GetDecodedCastOpcode(unsigned Val) {
80  switch (Val) {
81  default: return -1;
82  case bitc::CAST_TRUNC   : return Instruction::Trunc;
83  case bitc::CAST_ZEXT    : return Instruction::ZExt;
84  case bitc::CAST_SEXT    : return Instruction::SExt;
85  case bitc::CAST_FPTOUI  : return Instruction::FPToUI;
86  case bitc::CAST_FPTOSI  : return Instruction::FPToSI;
87  case bitc::CAST_UITOFP  : return Instruction::UIToFP;
88  case bitc::CAST_SITOFP  : return Instruction::SIToFP;
89  case bitc::CAST_FPTRUNC : return Instruction::FPTrunc;
90  case bitc::CAST_FPEXT   : return Instruction::FPExt;
91  case bitc::CAST_PTRTOINT: return Instruction::PtrToInt;
92  case bitc::CAST_INTTOPTR: return Instruction::IntToPtr;
93  case bitc::CAST_BITCAST : return Instruction::BitCast;
94  }
95}
96static int GetDecodedBinaryOpcode(unsigned Val, const Type *Ty) {
97  switch (Val) {
98  default: return -1;
99  case bitc::BINOP_ADD:  return Instruction::Add;
100  case bitc::BINOP_SUB:  return Instruction::Sub;
101  case bitc::BINOP_MUL:  return Instruction::Mul;
102  case bitc::BINOP_UDIV: return Instruction::UDiv;
103  case bitc::BINOP_SDIV:
104    return Ty->isFPOrFPVector() ? Instruction::FDiv : Instruction::SDiv;
105  case bitc::BINOP_UREM: return Instruction::URem;
106  case bitc::BINOP_SREM:
107    return Ty->isFPOrFPVector() ? Instruction::FRem : Instruction::SRem;
108  case bitc::BINOP_SHL:  return Instruction::Shl;
109  case bitc::BINOP_LSHR: return Instruction::LShr;
110  case bitc::BINOP_ASHR: return Instruction::AShr;
111  case bitc::BINOP_AND:  return Instruction::And;
112  case bitc::BINOP_OR:   return Instruction::Or;
113  case bitc::BINOP_XOR:  return Instruction::Xor;
114  }
115}
116
117
118namespace {
119  /// @brief A class for maintaining the slot number definition
120  /// as a placeholder for the actual definition for forward constants defs.
121  class ConstantPlaceHolder : public ConstantExpr {
122    ConstantPlaceHolder();                       // DO NOT IMPLEMENT
123    void operator=(const ConstantPlaceHolder &); // DO NOT IMPLEMENT
124  public:
125    Use Op;
126    ConstantPlaceHolder(const Type *Ty)
127      : ConstantExpr(Ty, Instruction::UserOp1, &Op, 1),
128        Op(UndefValue::get(Type::Int32Ty), this) {
129    }
130  };
131}
132
133Constant *BitcodeReaderValueList::getConstantFwdRef(unsigned Idx,
134                                                    const Type *Ty) {
135  if (Idx >= size()) {
136    // Insert a bunch of null values.
137    Uses.resize(Idx+1);
138    OperandList = &Uses[0];
139    NumOperands = Idx+1;
140  }
141
142  if (Value *V = Uses[Idx]) {
143    assert(Ty == V->getType() && "Type mismatch in constant table!");
144    return cast<Constant>(V);
145  }
146
147  // Create and return a placeholder, which will later be RAUW'd.
148  Constant *C = new ConstantPlaceHolder(Ty);
149  Uses[Idx].init(C, this);
150  return C;
151}
152
153Value *BitcodeReaderValueList::getValueFwdRef(unsigned Idx, const Type *Ty) {
154  if (Idx >= size()) {
155    // Insert a bunch of null values.
156    Uses.resize(Idx+1);
157    OperandList = &Uses[0];
158    NumOperands = Idx+1;
159  }
160
161  if (Value *V = Uses[Idx]) {
162    assert((Ty == 0 || Ty == V->getType()) && "Type mismatch in value table!");
163    return V;
164  }
165
166  // No type specified, must be invalid reference.
167  if (Ty == 0) return 0;
168
169  // Create and return a placeholder, which will later be RAUW'd.
170  Value *V = new Argument(Ty);
171  Uses[Idx].init(V, this);
172  return V;
173}
174
175
176const Type *BitcodeReader::getTypeByID(unsigned ID, bool isTypeTable) {
177  // If the TypeID is in range, return it.
178  if (ID < TypeList.size())
179    return TypeList[ID].get();
180  if (!isTypeTable) return 0;
181
182  // The type table allows forward references.  Push as many Opaque types as
183  // needed to get up to ID.
184  while (TypeList.size() <= ID)
185    TypeList.push_back(OpaqueType::get());
186  return TypeList.back().get();
187}
188
189//===----------------------------------------------------------------------===//
190//  Functions for parsing blocks from the bitcode file
191//===----------------------------------------------------------------------===//
192
193bool BitcodeReader::ParseParamAttrBlock() {
194  if (Stream.EnterSubBlock(bitc::PARAMATTR_BLOCK_ID))
195    return Error("Malformed block record");
196
197  if (!ParamAttrs.empty())
198    return Error("Multiple PARAMATTR blocks found!");
199
200  SmallVector<uint64_t, 64> Record;
201
202  ParamAttrsVector Attrs;
203
204  // Read all the records.
205  while (1) {
206    unsigned Code = Stream.ReadCode();
207    if (Code == bitc::END_BLOCK) {
208      if (Stream.ReadBlockEnd())
209        return Error("Error at end of PARAMATTR block");
210      return false;
211    }
212
213    if (Code == bitc::ENTER_SUBBLOCK) {
214      // No known subblocks, always skip them.
215      Stream.ReadSubBlockID();
216      if (Stream.SkipBlock())
217        return Error("Malformed block record");
218      continue;
219    }
220
221    if (Code == bitc::DEFINE_ABBREV) {
222      Stream.ReadAbbrevRecord();
223      continue;
224    }
225
226    // Read a record.
227    Record.clear();
228    switch (Stream.ReadRecord(Code, Record)) {
229    default:  // Default behavior: ignore.
230      break;
231    case bitc::PARAMATTR_CODE_ENTRY: { // ENTRY: [paramidx0, attr0, ...]
232      if (Record.size() & 1)
233        return Error("Invalid ENTRY record");
234
235      ParamAttrsWithIndex PAWI;
236      for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
237        PAWI.index = Record[i];
238        PAWI.attrs = Record[i+1];
239        Attrs.push_back(PAWI);
240      }
241      ParamAttrs.push_back(ParamAttrsList::get(Attrs));
242      Attrs.clear();
243      break;
244    }
245    }
246  }
247}
248
249
250bool BitcodeReader::ParseTypeTable() {
251  if (Stream.EnterSubBlock(bitc::TYPE_BLOCK_ID))
252    return Error("Malformed block record");
253
254  if (!TypeList.empty())
255    return Error("Multiple TYPE_BLOCKs found!");
256
257  SmallVector<uint64_t, 64> Record;
258  unsigned NumRecords = 0;
259
260  // Read all the records for this type table.
261  while (1) {
262    unsigned Code = Stream.ReadCode();
263    if (Code == bitc::END_BLOCK) {
264      if (NumRecords != TypeList.size())
265        return Error("Invalid type forward reference in TYPE_BLOCK");
266      if (Stream.ReadBlockEnd())
267        return Error("Error at end of type table block");
268      return false;
269    }
270
271    if (Code == bitc::ENTER_SUBBLOCK) {
272      // No known subblocks, always skip them.
273      Stream.ReadSubBlockID();
274      if (Stream.SkipBlock())
275        return Error("Malformed block record");
276      continue;
277    }
278
279    if (Code == bitc::DEFINE_ABBREV) {
280      Stream.ReadAbbrevRecord();
281      continue;
282    }
283
284    // Read a record.
285    Record.clear();
286    const Type *ResultTy = 0;
287    switch (Stream.ReadRecord(Code, Record)) {
288    default:  // Default behavior: unknown type.
289      ResultTy = 0;
290      break;
291    case bitc::TYPE_CODE_NUMENTRY: // TYPE_CODE_NUMENTRY: [numentries]
292      // TYPE_CODE_NUMENTRY contains a count of the number of types in the
293      // type list.  This allows us to reserve space.
294      if (Record.size() < 1)
295        return Error("Invalid TYPE_CODE_NUMENTRY record");
296      TypeList.reserve(Record[0]);
297      continue;
298    case bitc::TYPE_CODE_VOID:      // VOID
299      ResultTy = Type::VoidTy;
300      break;
301    case bitc::TYPE_CODE_FLOAT:     // FLOAT
302      ResultTy = Type::FloatTy;
303      break;
304    case bitc::TYPE_CODE_DOUBLE:    // DOUBLE
305      ResultTy = Type::DoubleTy;
306      break;
307    case bitc::TYPE_CODE_X86_FP80:  // X86_FP80
308      ResultTy = Type::X86_FP80Ty;
309      break;
310    case bitc::TYPE_CODE_FP128:     // FP128
311      ResultTy = Type::FP128Ty;
312      break;
313    case bitc::TYPE_CODE_PPC_FP128: // PPC_FP128
314      ResultTy = Type::PPC_FP128Ty;
315      break;
316    case bitc::TYPE_CODE_LABEL:     // LABEL
317      ResultTy = Type::LabelTy;
318      break;
319    case bitc::TYPE_CODE_OPAQUE:    // OPAQUE
320      ResultTy = 0;
321      break;
322    case bitc::TYPE_CODE_INTEGER:   // INTEGER: [width]
323      if (Record.size() < 1)
324        return Error("Invalid Integer type record");
325
326      ResultTy = IntegerType::get(Record[0]);
327      break;
328    case bitc::TYPE_CODE_POINTER:   // POINTER: [pointee type]
329      if (Record.size() < 1)
330        return Error("Invalid POINTER type record");
331      ResultTy = PointerType::get(getTypeByID(Record[0], true));
332      break;
333    case bitc::TYPE_CODE_FUNCTION: {
334      // FUNCTION: [vararg, attrid, retty, paramty x N]
335      if (Record.size() < 3)
336        return Error("Invalid FUNCTION type record");
337      std::vector<const Type*> ArgTys;
338      for (unsigned i = 3, e = Record.size(); i != e; ++i)
339        ArgTys.push_back(getTypeByID(Record[i], true));
340
341      ResultTy = FunctionType::get(getTypeByID(Record[2], true), ArgTys,
342                                   Record[0], getParamAttrs(Record[1]));
343      break;
344    }
345    case bitc::TYPE_CODE_STRUCT: {  // STRUCT: [ispacked, eltty x N]
346      if (Record.size() < 1)
347        return Error("Invalid STRUCT type record");
348      std::vector<const Type*> EltTys;
349      for (unsigned i = 1, e = Record.size(); i != e; ++i)
350        EltTys.push_back(getTypeByID(Record[i], true));
351      ResultTy = StructType::get(EltTys, Record[0]);
352      break;
353    }
354    case bitc::TYPE_CODE_ARRAY:     // ARRAY: [numelts, eltty]
355      if (Record.size() < 2)
356        return Error("Invalid ARRAY type record");
357      ResultTy = ArrayType::get(getTypeByID(Record[1], true), Record[0]);
358      break;
359    case bitc::TYPE_CODE_VECTOR:    // VECTOR: [numelts, eltty]
360      if (Record.size() < 2)
361        return Error("Invalid VECTOR type record");
362      ResultTy = VectorType::get(getTypeByID(Record[1], true), Record[0]);
363      break;
364    }
365
366    if (NumRecords == TypeList.size()) {
367      // If this is a new type slot, just append it.
368      TypeList.push_back(ResultTy ? ResultTy : OpaqueType::get());
369      ++NumRecords;
370    } else if (ResultTy == 0) {
371      // Otherwise, this was forward referenced, so an opaque type was created,
372      // but the result type is actually just an opaque.  Leave the one we
373      // created previously.
374      ++NumRecords;
375    } else {
376      // Otherwise, this was forward referenced, so an opaque type was created.
377      // Resolve the opaque type to the real type now.
378      assert(NumRecords < TypeList.size() && "Typelist imbalance");
379      const OpaqueType *OldTy = cast<OpaqueType>(TypeList[NumRecords++].get());
380
381      // Don't directly push the new type on the Tab. Instead we want to replace
382      // the opaque type we previously inserted with the new concrete value. The
383      // refinement from the abstract (opaque) type to the new type causes all
384      // uses of the abstract type to use the concrete type (NewTy). This will
385      // also cause the opaque type to be deleted.
386      const_cast<OpaqueType*>(OldTy)->refineAbstractTypeTo(ResultTy);
387
388      // This should have replaced the old opaque type with the new type in the
389      // value table... or with a preexisting type that was already in the
390      // system.  Let's just make sure it did.
391      assert(TypeList[NumRecords-1].get() != OldTy &&
392             "refineAbstractType didn't work!");
393    }
394  }
395}
396
397
398bool BitcodeReader::ParseTypeSymbolTable() {
399  if (Stream.EnterSubBlock(bitc::TYPE_SYMTAB_BLOCK_ID))
400    return Error("Malformed block record");
401
402  SmallVector<uint64_t, 64> Record;
403
404  // Read all the records for this type table.
405  std::string TypeName;
406  while (1) {
407    unsigned Code = Stream.ReadCode();
408    if (Code == bitc::END_BLOCK) {
409      if (Stream.ReadBlockEnd())
410        return Error("Error at end of type symbol table block");
411      return false;
412    }
413
414    if (Code == bitc::ENTER_SUBBLOCK) {
415      // No known subblocks, always skip them.
416      Stream.ReadSubBlockID();
417      if (Stream.SkipBlock())
418        return Error("Malformed block record");
419      continue;
420    }
421
422    if (Code == bitc::DEFINE_ABBREV) {
423      Stream.ReadAbbrevRecord();
424      continue;
425    }
426
427    // Read a record.
428    Record.clear();
429    switch (Stream.ReadRecord(Code, Record)) {
430    default:  // Default behavior: unknown type.
431      break;
432    case bitc::TST_CODE_ENTRY:    // TST_ENTRY: [typeid, namechar x N]
433      if (ConvertToString(Record, 1, TypeName))
434        return Error("Invalid TST_ENTRY record");
435      unsigned TypeID = Record[0];
436      if (TypeID >= TypeList.size())
437        return Error("Invalid Type ID in TST_ENTRY record");
438
439      TheModule->addTypeName(TypeName, TypeList[TypeID].get());
440      TypeName.clear();
441      break;
442    }
443  }
444}
445
446bool BitcodeReader::ParseValueSymbolTable() {
447  if (Stream.EnterSubBlock(bitc::VALUE_SYMTAB_BLOCK_ID))
448    return Error("Malformed block record");
449
450  SmallVector<uint64_t, 64> Record;
451
452  // Read all the records for this value table.
453  SmallString<128> ValueName;
454  while (1) {
455    unsigned Code = Stream.ReadCode();
456    if (Code == bitc::END_BLOCK) {
457      if (Stream.ReadBlockEnd())
458        return Error("Error at end of value symbol table block");
459      return false;
460    }
461    if (Code == bitc::ENTER_SUBBLOCK) {
462      // No known subblocks, always skip them.
463      Stream.ReadSubBlockID();
464      if (Stream.SkipBlock())
465        return Error("Malformed block record");
466      continue;
467    }
468
469    if (Code == bitc::DEFINE_ABBREV) {
470      Stream.ReadAbbrevRecord();
471      continue;
472    }
473
474    // Read a record.
475    Record.clear();
476    switch (Stream.ReadRecord(Code, Record)) {
477    default:  // Default behavior: unknown type.
478      break;
479    case bitc::VST_CODE_ENTRY: {  // VST_ENTRY: [valueid, namechar x N]
480      if (ConvertToString(Record, 1, ValueName))
481        return Error("Invalid TST_ENTRY record");
482      unsigned ValueID = Record[0];
483      if (ValueID >= ValueList.size())
484        return Error("Invalid Value ID in VST_ENTRY record");
485      Value *V = ValueList[ValueID];
486
487      V->setName(&ValueName[0], ValueName.size());
488      ValueName.clear();
489      break;
490    }
491    case bitc::VST_CODE_BBENTRY: {
492      if (ConvertToString(Record, 1, ValueName))
493        return Error("Invalid VST_BBENTRY record");
494      BasicBlock *BB = getBasicBlock(Record[0]);
495      if (BB == 0)
496        return Error("Invalid BB ID in VST_BBENTRY record");
497
498      BB->setName(&ValueName[0], ValueName.size());
499      ValueName.clear();
500      break;
501    }
502    }
503  }
504}
505
506/// DecodeSignRotatedValue - Decode a signed value stored with the sign bit in
507/// the LSB for dense VBR encoding.
508static uint64_t DecodeSignRotatedValue(uint64_t V) {
509  if ((V & 1) == 0)
510    return V >> 1;
511  if (V != 1)
512    return -(V >> 1);
513  // There is no such thing as -0 with integers.  "-0" really means MININT.
514  return 1ULL << 63;
515}
516
517/// ResolveGlobalAndAliasInits - Resolve all of the initializers for global
518/// values and aliases that we can.
519bool BitcodeReader::ResolveGlobalAndAliasInits() {
520  std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInitWorklist;
521  std::vector<std::pair<GlobalAlias*, unsigned> > AliasInitWorklist;
522
523  GlobalInitWorklist.swap(GlobalInits);
524  AliasInitWorklist.swap(AliasInits);
525
526  while (!GlobalInitWorklist.empty()) {
527    unsigned ValID = GlobalInitWorklist.back().second;
528    if (ValID >= ValueList.size()) {
529      // Not ready to resolve this yet, it requires something later in the file.
530      GlobalInits.push_back(GlobalInitWorklist.back());
531    } else {
532      if (Constant *C = dyn_cast<Constant>(ValueList[ValID]))
533        GlobalInitWorklist.back().first->setInitializer(C);
534      else
535        return Error("Global variable initializer is not a constant!");
536    }
537    GlobalInitWorklist.pop_back();
538  }
539
540  while (!AliasInitWorklist.empty()) {
541    unsigned ValID = AliasInitWorklist.back().second;
542    if (ValID >= ValueList.size()) {
543      AliasInits.push_back(AliasInitWorklist.back());
544    } else {
545      if (Constant *C = dyn_cast<Constant>(ValueList[ValID]))
546        AliasInitWorklist.back().first->setAliasee(C);
547      else
548        return Error("Alias initializer is not a constant!");
549    }
550    AliasInitWorklist.pop_back();
551  }
552  return false;
553}
554
555
556bool BitcodeReader::ParseConstants() {
557  if (Stream.EnterSubBlock(bitc::CONSTANTS_BLOCK_ID))
558    return Error("Malformed block record");
559
560  SmallVector<uint64_t, 64> Record;
561
562  // Read all the records for this value table.
563  const Type *CurTy = Type::Int32Ty;
564  unsigned NextCstNo = ValueList.size();
565  while (1) {
566    unsigned Code = Stream.ReadCode();
567    if (Code == bitc::END_BLOCK) {
568      if (NextCstNo != ValueList.size())
569        return Error("Invalid constant reference!");
570
571      if (Stream.ReadBlockEnd())
572        return Error("Error at end of constants block");
573      return false;
574    }
575
576    if (Code == bitc::ENTER_SUBBLOCK) {
577      // No known subblocks, always skip them.
578      Stream.ReadSubBlockID();
579      if (Stream.SkipBlock())
580        return Error("Malformed block record");
581      continue;
582    }
583
584    if (Code == bitc::DEFINE_ABBREV) {
585      Stream.ReadAbbrevRecord();
586      continue;
587    }
588
589    // Read a record.
590    Record.clear();
591    Value *V = 0;
592    switch (Stream.ReadRecord(Code, Record)) {
593    default:  // Default behavior: unknown constant
594    case bitc::CST_CODE_UNDEF:     // UNDEF
595      V = UndefValue::get(CurTy);
596      break;
597    case bitc::CST_CODE_SETTYPE:   // SETTYPE: [typeid]
598      if (Record.empty())
599        return Error("Malformed CST_SETTYPE record");
600      if (Record[0] >= TypeList.size())
601        return Error("Invalid Type ID in CST_SETTYPE record");
602      CurTy = TypeList[Record[0]];
603      continue;  // Skip the ValueList manipulation.
604    case bitc::CST_CODE_NULL:      // NULL
605      V = Constant::getNullValue(CurTy);
606      break;
607    case bitc::CST_CODE_INTEGER:   // INTEGER: [intval]
608      if (!isa<IntegerType>(CurTy) || Record.empty())
609        return Error("Invalid CST_INTEGER record");
610      V = ConstantInt::get(CurTy, DecodeSignRotatedValue(Record[0]));
611      break;
612    case bitc::CST_CODE_WIDE_INTEGER: {// WIDE_INTEGER: [n x intval]
613      if (!isa<IntegerType>(CurTy) || Record.empty())
614        return Error("Invalid WIDE_INTEGER record");
615
616      unsigned NumWords = Record.size();
617      SmallVector<uint64_t, 8> Words;
618      Words.resize(NumWords);
619      for (unsigned i = 0; i != NumWords; ++i)
620        Words[i] = DecodeSignRotatedValue(Record[i]);
621      V = ConstantInt::get(APInt(cast<IntegerType>(CurTy)->getBitWidth(),
622                                 NumWords, &Words[0]));
623      break;
624    }
625    case bitc::CST_CODE_FLOAT: {    // FLOAT: [fpval]
626      if (Record.empty())
627        return Error("Invalid FLOAT record");
628      if (CurTy == Type::FloatTy)
629        V = ConstantFP::get(CurTy, APFloat(APInt(32, (uint32_t)Record[0])));
630      else if (CurTy == Type::DoubleTy)
631        V = ConstantFP::get(CurTy, APFloat(APInt(64, Record[0])));
632      else if (CurTy == Type::X86_FP80Ty)
633        V = ConstantFP::get(CurTy, APFloat(APInt(80, 2, &Record[0])));
634      else if (CurTy == Type::FP128Ty)
635        V = ConstantFP::get(CurTy, APFloat(APInt(128, 2, &Record[0])));
636      else if (CurTy == Type::PPC_FP128Ty)
637        assert(0 && "PowerPC long double constants not handled yet.");
638      else
639        V = UndefValue::get(CurTy);
640      break;
641    }
642
643    case bitc::CST_CODE_AGGREGATE: {// AGGREGATE: [n x value number]
644      if (Record.empty())
645        return Error("Invalid CST_AGGREGATE record");
646
647      unsigned Size = Record.size();
648      std::vector<Constant*> Elts;
649
650      if (const StructType *STy = dyn_cast<StructType>(CurTy)) {
651        for (unsigned i = 0; i != Size; ++i)
652          Elts.push_back(ValueList.getConstantFwdRef(Record[i],
653                                                     STy->getElementType(i)));
654        V = ConstantStruct::get(STy, Elts);
655      } else if (const ArrayType *ATy = dyn_cast<ArrayType>(CurTy)) {
656        const Type *EltTy = ATy->getElementType();
657        for (unsigned i = 0; i != Size; ++i)
658          Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
659        V = ConstantArray::get(ATy, Elts);
660      } else if (const VectorType *VTy = dyn_cast<VectorType>(CurTy)) {
661        const Type *EltTy = VTy->getElementType();
662        for (unsigned i = 0; i != Size; ++i)
663          Elts.push_back(ValueList.getConstantFwdRef(Record[i], EltTy));
664        V = ConstantVector::get(Elts);
665      } else {
666        V = UndefValue::get(CurTy);
667      }
668      break;
669    }
670    case bitc::CST_CODE_STRING: { // STRING: [values]
671      if (Record.empty())
672        return Error("Invalid CST_AGGREGATE record");
673
674      const ArrayType *ATy = cast<ArrayType>(CurTy);
675      const Type *EltTy = ATy->getElementType();
676
677      unsigned Size = Record.size();
678      std::vector<Constant*> Elts;
679      for (unsigned i = 0; i != Size; ++i)
680        Elts.push_back(ConstantInt::get(EltTy, Record[i]));
681      V = ConstantArray::get(ATy, Elts);
682      break;
683    }
684    case bitc::CST_CODE_CSTRING: { // CSTRING: [values]
685      if (Record.empty())
686        return Error("Invalid CST_AGGREGATE record");
687
688      const ArrayType *ATy = cast<ArrayType>(CurTy);
689      const Type *EltTy = ATy->getElementType();
690
691      unsigned Size = Record.size();
692      std::vector<Constant*> Elts;
693      for (unsigned i = 0; i != Size; ++i)
694        Elts.push_back(ConstantInt::get(EltTy, Record[i]));
695      Elts.push_back(Constant::getNullValue(EltTy));
696      V = ConstantArray::get(ATy, Elts);
697      break;
698    }
699    case bitc::CST_CODE_CE_BINOP: {  // CE_BINOP: [opcode, opval, opval]
700      if (Record.size() < 3) return Error("Invalid CE_BINOP record");
701      int Opc = GetDecodedBinaryOpcode(Record[0], CurTy);
702      if (Opc < 0) {
703        V = UndefValue::get(CurTy);  // Unknown binop.
704      } else {
705        Constant *LHS = ValueList.getConstantFwdRef(Record[1], CurTy);
706        Constant *RHS = ValueList.getConstantFwdRef(Record[2], CurTy);
707        V = ConstantExpr::get(Opc, LHS, RHS);
708      }
709      break;
710    }
711    case bitc::CST_CODE_CE_CAST: {  // CE_CAST: [opcode, opty, opval]
712      if (Record.size() < 3) return Error("Invalid CE_CAST record");
713      int Opc = GetDecodedCastOpcode(Record[0]);
714      if (Opc < 0) {
715        V = UndefValue::get(CurTy);  // Unknown cast.
716      } else {
717        const Type *OpTy = getTypeByID(Record[1]);
718        if (!OpTy) return Error("Invalid CE_CAST record");
719        Constant *Op = ValueList.getConstantFwdRef(Record[2], OpTy);
720        V = ConstantExpr::getCast(Opc, Op, CurTy);
721      }
722      break;
723    }
724    case bitc::CST_CODE_CE_GEP: {  // CE_GEP:        [n x operands]
725      if (Record.size() & 1) return Error("Invalid CE_GEP record");
726      SmallVector<Constant*, 16> Elts;
727      for (unsigned i = 0, e = Record.size(); i != e; i += 2) {
728        const Type *ElTy = getTypeByID(Record[i]);
729        if (!ElTy) return Error("Invalid CE_GEP record");
730        Elts.push_back(ValueList.getConstantFwdRef(Record[i+1], ElTy));
731      }
732      V = ConstantExpr::getGetElementPtr(Elts[0], &Elts[1], Elts.size()-1);
733      break;
734    }
735    case bitc::CST_CODE_CE_SELECT:  // CE_SELECT: [opval#, opval#, opval#]
736      if (Record.size() < 3) return Error("Invalid CE_SELECT record");
737      V = ConstantExpr::getSelect(ValueList.getConstantFwdRef(Record[0],
738                                                              Type::Int1Ty),
739                                  ValueList.getConstantFwdRef(Record[1],CurTy),
740                                  ValueList.getConstantFwdRef(Record[2],CurTy));
741      break;
742    case bitc::CST_CODE_CE_EXTRACTELT: { // CE_EXTRACTELT: [opty, opval, opval]
743      if (Record.size() < 3) return Error("Invalid CE_EXTRACTELT record");
744      const VectorType *OpTy =
745        dyn_cast_or_null<VectorType>(getTypeByID(Record[0]));
746      if (OpTy == 0) return Error("Invalid CE_EXTRACTELT record");
747      Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
748      Constant *Op1 = ValueList.getConstantFwdRef(Record[2],
749                                                  OpTy->getElementType());
750      V = ConstantExpr::getExtractElement(Op0, Op1);
751      break;
752    }
753    case bitc::CST_CODE_CE_INSERTELT: { // CE_INSERTELT: [opval, opval, opval]
754      const VectorType *OpTy = dyn_cast<VectorType>(CurTy);
755      if (Record.size() < 3 || OpTy == 0)
756        return Error("Invalid CE_INSERTELT record");
757      Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
758      Constant *Op1 = ValueList.getConstantFwdRef(Record[1],
759                                                  OpTy->getElementType());
760      Constant *Op2 = ValueList.getConstantFwdRef(Record[2], Type::Int32Ty);
761      V = ConstantExpr::getInsertElement(Op0, Op1, Op2);
762      break;
763    }
764    case bitc::CST_CODE_CE_SHUFFLEVEC: { // CE_SHUFFLEVEC: [opval, opval, opval]
765      const VectorType *OpTy = dyn_cast<VectorType>(CurTy);
766      if (Record.size() < 3 || OpTy == 0)
767        return Error("Invalid CE_INSERTELT record");
768      Constant *Op0 = ValueList.getConstantFwdRef(Record[0], OpTy);
769      Constant *Op1 = ValueList.getConstantFwdRef(Record[1], OpTy);
770      const Type *ShufTy=VectorType::get(Type::Int32Ty, OpTy->getNumElements());
771      Constant *Op2 = ValueList.getConstantFwdRef(Record[2], ShufTy);
772      V = ConstantExpr::getShuffleVector(Op0, Op1, Op2);
773      break;
774    }
775    case bitc::CST_CODE_CE_CMP: {     // CE_CMP: [opty, opval, opval, pred]
776      if (Record.size() < 4) return Error("Invalid CE_CMP record");
777      const Type *OpTy = getTypeByID(Record[0]);
778      if (OpTy == 0) return Error("Invalid CE_CMP record");
779      Constant *Op0 = ValueList.getConstantFwdRef(Record[1], OpTy);
780      Constant *Op1 = ValueList.getConstantFwdRef(Record[2], OpTy);
781
782      if (OpTy->isFloatingPoint())
783        V = ConstantExpr::getFCmp(Record[3], Op0, Op1);
784      else
785        V = ConstantExpr::getICmp(Record[3], Op0, Op1);
786      break;
787    }
788    case bitc::CST_CODE_INLINEASM: {
789      if (Record.size() < 2) return Error("Invalid INLINEASM record");
790      std::string AsmStr, ConstrStr;
791      bool HasSideEffects = Record[0];
792      unsigned AsmStrSize = Record[1];
793      if (2+AsmStrSize >= Record.size())
794        return Error("Invalid INLINEASM record");
795      unsigned ConstStrSize = Record[2+AsmStrSize];
796      if (3+AsmStrSize+ConstStrSize > Record.size())
797        return Error("Invalid INLINEASM record");
798
799      for (unsigned i = 0; i != AsmStrSize; ++i)
800        AsmStr += (char)Record[2+i];
801      for (unsigned i = 0; i != ConstStrSize; ++i)
802        ConstrStr += (char)Record[3+AsmStrSize+i];
803      const PointerType *PTy = cast<PointerType>(CurTy);
804      V = InlineAsm::get(cast<FunctionType>(PTy->getElementType()),
805                         AsmStr, ConstrStr, HasSideEffects);
806      break;
807    }
808    }
809
810    ValueList.AssignValue(V, NextCstNo);
811    ++NextCstNo;
812  }
813}
814
815/// RememberAndSkipFunctionBody - When we see the block for a function body,
816/// remember where it is and then skip it.  This lets us lazily deserialize the
817/// functions.
818bool BitcodeReader::RememberAndSkipFunctionBody() {
819  // Get the function we are talking about.
820  if (FunctionsWithBodies.empty())
821    return Error("Insufficient function protos");
822
823  Function *Fn = FunctionsWithBodies.back();
824  FunctionsWithBodies.pop_back();
825
826  // Save the current stream state.
827  uint64_t CurBit = Stream.GetCurrentBitNo();
828  DeferredFunctionInfo[Fn] = std::make_pair(CurBit, Fn->getLinkage());
829
830  // Set the functions linkage to GhostLinkage so we know it is lazily
831  // deserialized.
832  Fn->setLinkage(GlobalValue::GhostLinkage);
833
834  // Skip over the function block for now.
835  if (Stream.SkipBlock())
836    return Error("Malformed block record");
837  return false;
838}
839
840bool BitcodeReader::ParseModule(const std::string &ModuleID) {
841  // Reject multiple MODULE_BLOCK's in a single bitstream.
842  if (TheModule)
843    return Error("Multiple MODULE_BLOCKs in same stream");
844
845  if (Stream.EnterSubBlock(bitc::MODULE_BLOCK_ID))
846    return Error("Malformed block record");
847
848  // Otherwise, create the module.
849  TheModule = new Module(ModuleID);
850
851  SmallVector<uint64_t, 64> Record;
852  std::vector<std::string> SectionTable;
853
854  // Read all the records for this module.
855  while (!Stream.AtEndOfStream()) {
856    unsigned Code = Stream.ReadCode();
857    if (Code == bitc::END_BLOCK) {
858      if (Stream.ReadBlockEnd())
859        return Error("Error at end of module block");
860
861      // Patch the initializers for globals and aliases up.
862      ResolveGlobalAndAliasInits();
863      if (!GlobalInits.empty() || !AliasInits.empty())
864        return Error("Malformed global initializer set");
865      if (!FunctionsWithBodies.empty())
866        return Error("Too few function bodies found");
867
868      // Look for intrinsic functions which need to be upgraded at some point
869      for (Module::iterator FI = TheModule->begin(), FE = TheModule->end();
870           FI != FE; ++FI) {
871        if (Function* NewFn = UpgradeIntrinsicFunction(FI))
872          UpgradedIntrinsics.push_back(std::make_pair(FI, NewFn));
873      }
874
875      // Force deallocation of memory for these vectors to favor the client that
876      // want lazy deserialization.
877      std::vector<std::pair<GlobalVariable*, unsigned> >().swap(GlobalInits);
878      std::vector<std::pair<GlobalAlias*, unsigned> >().swap(AliasInits);
879      std::vector<Function*>().swap(FunctionsWithBodies);
880      return false;
881    }
882
883    if (Code == bitc::ENTER_SUBBLOCK) {
884      switch (Stream.ReadSubBlockID()) {
885      default:  // Skip unknown content.
886        if (Stream.SkipBlock())
887          return Error("Malformed block record");
888        break;
889      case bitc::BLOCKINFO_BLOCK_ID:
890        if (Stream.ReadBlockInfoBlock())
891          return Error("Malformed BlockInfoBlock");
892        break;
893      case bitc::PARAMATTR_BLOCK_ID:
894        if (ParseParamAttrBlock())
895          return true;
896        break;
897      case bitc::TYPE_BLOCK_ID:
898        if (ParseTypeTable())
899          return true;
900        break;
901      case bitc::TYPE_SYMTAB_BLOCK_ID:
902        if (ParseTypeSymbolTable())
903          return true;
904        break;
905      case bitc::VALUE_SYMTAB_BLOCK_ID:
906        if (ParseValueSymbolTable())
907          return true;
908        break;
909      case bitc::CONSTANTS_BLOCK_ID:
910        if (ParseConstants() || ResolveGlobalAndAliasInits())
911          return true;
912        break;
913      case bitc::FUNCTION_BLOCK_ID:
914        // If this is the first function body we've seen, reverse the
915        // FunctionsWithBodies list.
916        if (!HasReversedFunctionsWithBodies) {
917          std::reverse(FunctionsWithBodies.begin(), FunctionsWithBodies.end());
918          HasReversedFunctionsWithBodies = true;
919        }
920
921        if (RememberAndSkipFunctionBody())
922          return true;
923        break;
924      }
925      continue;
926    }
927
928    if (Code == bitc::DEFINE_ABBREV) {
929      Stream.ReadAbbrevRecord();
930      continue;
931    }
932
933    // Read a record.
934    switch (Stream.ReadRecord(Code, Record)) {
935    default: break;  // Default behavior, ignore unknown content.
936    case bitc::MODULE_CODE_VERSION:  // VERSION: [version#]
937      if (Record.size() < 1)
938        return Error("Malformed MODULE_CODE_VERSION");
939      // Only version #0 is supported so far.
940      if (Record[0] != 0)
941        return Error("Unknown bitstream version!");
942      break;
943    case bitc::MODULE_CODE_TRIPLE: {  // TRIPLE: [strchr x N]
944      std::string S;
945      if (ConvertToString(Record, 0, S))
946        return Error("Invalid MODULE_CODE_TRIPLE record");
947      TheModule->setTargetTriple(S);
948      break;
949    }
950    case bitc::MODULE_CODE_DATALAYOUT: {  // DATALAYOUT: [strchr x N]
951      std::string S;
952      if (ConvertToString(Record, 0, S))
953        return Error("Invalid MODULE_CODE_DATALAYOUT record");
954      TheModule->setDataLayout(S);
955      break;
956    }
957    case bitc::MODULE_CODE_ASM: {  // ASM: [strchr x N]
958      std::string S;
959      if (ConvertToString(Record, 0, S))
960        return Error("Invalid MODULE_CODE_ASM record");
961      TheModule->setModuleInlineAsm(S);
962      break;
963    }
964    case bitc::MODULE_CODE_DEPLIB: {  // DEPLIB: [strchr x N]
965      std::string S;
966      if (ConvertToString(Record, 0, S))
967        return Error("Invalid MODULE_CODE_DEPLIB record");
968      TheModule->addLibrary(S);
969      break;
970    }
971    case bitc::MODULE_CODE_SECTIONNAME: {  // SECTIONNAME: [strchr x N]
972      std::string S;
973      if (ConvertToString(Record, 0, S))
974        return Error("Invalid MODULE_CODE_SECTIONNAME record");
975      SectionTable.push_back(S);
976      break;
977    }
978    // GLOBALVAR: [type, isconst, initid,
979    //             linkage, alignment, section, visibility, threadlocal]
980    case bitc::MODULE_CODE_GLOBALVAR: {
981      if (Record.size() < 6)
982        return Error("Invalid MODULE_CODE_GLOBALVAR record");
983      const Type *Ty = getTypeByID(Record[0]);
984      if (!isa<PointerType>(Ty))
985        return Error("Global not a pointer type!");
986      Ty = cast<PointerType>(Ty)->getElementType();
987
988      bool isConstant = Record[1];
989      GlobalValue::LinkageTypes Linkage = GetDecodedLinkage(Record[3]);
990      unsigned Alignment = (1 << Record[4]) >> 1;
991      std::string Section;
992      if (Record[5]) {
993        if (Record[5]-1 >= SectionTable.size())
994          return Error("Invalid section ID");
995        Section = SectionTable[Record[5]-1];
996      }
997      GlobalValue::VisibilityTypes Visibility = GlobalValue::DefaultVisibility;
998      if (Record.size() > 6)
999        Visibility = GetDecodedVisibility(Record[6]);
1000      bool isThreadLocal = false;
1001      if (Record.size() > 7)
1002        isThreadLocal = Record[7];
1003
1004      GlobalVariable *NewGV =
1005        new GlobalVariable(Ty, isConstant, Linkage, 0, "", TheModule);
1006      NewGV->setAlignment(Alignment);
1007      if (!Section.empty())
1008        NewGV->setSection(Section);
1009      NewGV->setVisibility(Visibility);
1010      NewGV->setThreadLocal(isThreadLocal);
1011
1012      ValueList.push_back(NewGV);
1013
1014      // Remember which value to use for the global initializer.
1015      if (unsigned InitID = Record[2])
1016        GlobalInits.push_back(std::make_pair(NewGV, InitID-1));
1017      break;
1018    }
1019    // FUNCTION:  [type, callingconv, isproto, linkage, paramattr,
1020    //             alignment, section, visibility]
1021    case bitc::MODULE_CODE_FUNCTION: {
1022      if (Record.size() < 8)
1023        return Error("Invalid MODULE_CODE_FUNCTION record");
1024      const Type *Ty = getTypeByID(Record[0]);
1025      if (!isa<PointerType>(Ty))
1026        return Error("Function not a pointer type!");
1027      const FunctionType *FTy =
1028        dyn_cast<FunctionType>(cast<PointerType>(Ty)->getElementType());
1029      if (!FTy)
1030        return Error("Function not a pointer to function type!");
1031
1032      Function *Func = new Function(FTy, GlobalValue::ExternalLinkage,
1033                                    "", TheModule);
1034
1035      Func->setCallingConv(Record[1]);
1036      bool isProto = Record[2];
1037      Func->setLinkage(GetDecodedLinkage(Record[3]));
1038
1039      assert(Func->getFunctionType()->getParamAttrs() ==
1040             getParamAttrs(Record[4]));
1041
1042      Func->setAlignment((1 << Record[5]) >> 1);
1043      if (Record[6]) {
1044        if (Record[6]-1 >= SectionTable.size())
1045          return Error("Invalid section ID");
1046        Func->setSection(SectionTable[Record[6]-1]);
1047      }
1048      Func->setVisibility(GetDecodedVisibility(Record[7]));
1049
1050      ValueList.push_back(Func);
1051
1052      // If this is a function with a body, remember the prototype we are
1053      // creating now, so that we can match up the body with them later.
1054      if (!isProto)
1055        FunctionsWithBodies.push_back(Func);
1056      break;
1057    }
1058    // ALIAS: [alias type, aliasee val#, linkage]
1059    case bitc::MODULE_CODE_ALIAS: {
1060      if (Record.size() < 3)
1061        return Error("Invalid MODULE_ALIAS record");
1062      const Type *Ty = getTypeByID(Record[0]);
1063      if (!isa<PointerType>(Ty))
1064        return Error("Function not a pointer type!");
1065
1066      GlobalAlias *NewGA = new GlobalAlias(Ty, GetDecodedLinkage(Record[2]),
1067                                           "", 0, TheModule);
1068      ValueList.push_back(NewGA);
1069      AliasInits.push_back(std::make_pair(NewGA, Record[1]));
1070      break;
1071    }
1072    /// MODULE_CODE_PURGEVALS: [numvals]
1073    case bitc::MODULE_CODE_PURGEVALS:
1074      // Trim down the value list to the specified size.
1075      if (Record.size() < 1 || Record[0] > ValueList.size())
1076        return Error("Invalid MODULE_PURGEVALS record");
1077      ValueList.shrinkTo(Record[0]);
1078      break;
1079    }
1080    Record.clear();
1081  }
1082
1083  return Error("Premature end of bitstream");
1084}
1085
1086
1087bool BitcodeReader::ParseBitcode() {
1088  TheModule = 0;
1089
1090  if (Buffer->getBufferSize() & 3)
1091    return Error("Bitcode stream should be a multiple of 4 bytes in length");
1092
1093  unsigned char *BufPtr = (unsigned char *)Buffer->getBufferStart();
1094  Stream.init(BufPtr, BufPtr+Buffer->getBufferSize());
1095
1096  // Sniff for the signature.
1097  if (Stream.Read(8) != 'B' ||
1098      Stream.Read(8) != 'C' ||
1099      Stream.Read(4) != 0x0 ||
1100      Stream.Read(4) != 0xC ||
1101      Stream.Read(4) != 0xE ||
1102      Stream.Read(4) != 0xD)
1103    return Error("Invalid bitcode signature");
1104
1105  // We expect a number of well-defined blocks, though we don't necessarily
1106  // need to understand them all.
1107  while (!Stream.AtEndOfStream()) {
1108    unsigned Code = Stream.ReadCode();
1109
1110    if (Code != bitc::ENTER_SUBBLOCK)
1111      return Error("Invalid record at top-level");
1112
1113    unsigned BlockID = Stream.ReadSubBlockID();
1114
1115    // We only know the MODULE subblock ID.
1116    switch (BlockID) {
1117    case bitc::BLOCKINFO_BLOCK_ID:
1118      if (Stream.ReadBlockInfoBlock())
1119        return Error("Malformed BlockInfoBlock");
1120      break;
1121    case bitc::MODULE_BLOCK_ID:
1122      if (ParseModule(Buffer->getBufferIdentifier()))
1123        return true;
1124      break;
1125    default:
1126      if (Stream.SkipBlock())
1127        return Error("Malformed block record");
1128      break;
1129    }
1130  }
1131
1132  return false;
1133}
1134
1135
1136/// ParseFunctionBody - Lazily parse the specified function body block.
1137bool BitcodeReader::ParseFunctionBody(Function *F) {
1138  if (Stream.EnterSubBlock(bitc::FUNCTION_BLOCK_ID))
1139    return Error("Malformed block record");
1140
1141  unsigned ModuleValueListSize = ValueList.size();
1142
1143  // Add all the function arguments to the value table.
1144  for(Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
1145    ValueList.push_back(I);
1146
1147  unsigned NextValueNo = ValueList.size();
1148  BasicBlock *CurBB = 0;
1149  unsigned CurBBNo = 0;
1150
1151  // Read all the records.
1152  SmallVector<uint64_t, 64> Record;
1153  while (1) {
1154    unsigned Code = Stream.ReadCode();
1155    if (Code == bitc::END_BLOCK) {
1156      if (Stream.ReadBlockEnd())
1157        return Error("Error at end of function block");
1158      break;
1159    }
1160
1161    if (Code == bitc::ENTER_SUBBLOCK) {
1162      switch (Stream.ReadSubBlockID()) {
1163      default:  // Skip unknown content.
1164        if (Stream.SkipBlock())
1165          return Error("Malformed block record");
1166        break;
1167      case bitc::CONSTANTS_BLOCK_ID:
1168        if (ParseConstants()) return true;
1169        NextValueNo = ValueList.size();
1170        break;
1171      case bitc::VALUE_SYMTAB_BLOCK_ID:
1172        if (ParseValueSymbolTable()) return true;
1173        break;
1174      }
1175      continue;
1176    }
1177
1178    if (Code == bitc::DEFINE_ABBREV) {
1179      Stream.ReadAbbrevRecord();
1180      continue;
1181    }
1182
1183    // Read a record.
1184    Record.clear();
1185    Instruction *I = 0;
1186    switch (Stream.ReadRecord(Code, Record)) {
1187    default: // Default behavior: reject
1188      return Error("Unknown instruction");
1189    case bitc::FUNC_CODE_DECLAREBLOCKS:     // DECLAREBLOCKS: [nblocks]
1190      if (Record.size() < 1 || Record[0] == 0)
1191        return Error("Invalid DECLAREBLOCKS record");
1192      // Create all the basic blocks for the function.
1193      FunctionBBs.resize(Record[0]);
1194      for (unsigned i = 0, e = FunctionBBs.size(); i != e; ++i)
1195        FunctionBBs[i] = new BasicBlock("", F);
1196      CurBB = FunctionBBs[0];
1197      continue;
1198
1199    case bitc::FUNC_CODE_INST_BINOP: {    // BINOP: [opval, ty, opval, opcode]
1200      unsigned OpNum = 0;
1201      Value *LHS, *RHS;
1202      if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
1203          getValue(Record, OpNum, LHS->getType(), RHS) ||
1204          OpNum+1 != Record.size())
1205        return Error("Invalid BINOP record");
1206
1207      int Opc = GetDecodedBinaryOpcode(Record[OpNum], LHS->getType());
1208      if (Opc == -1) return Error("Invalid BINOP record");
1209      I = BinaryOperator::create((Instruction::BinaryOps)Opc, LHS, RHS);
1210      break;
1211    }
1212    case bitc::FUNC_CODE_INST_CAST: {    // CAST: [opval, opty, destty, castopc]
1213      unsigned OpNum = 0;
1214      Value *Op;
1215      if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
1216          OpNum+2 != Record.size())
1217        return Error("Invalid CAST record");
1218
1219      const Type *ResTy = getTypeByID(Record[OpNum]);
1220      int Opc = GetDecodedCastOpcode(Record[OpNum+1]);
1221      if (Opc == -1 || ResTy == 0)
1222        return Error("Invalid CAST record");
1223      I = CastInst::create((Instruction::CastOps)Opc, Op, ResTy);
1224      break;
1225    }
1226    case bitc::FUNC_CODE_INST_GEP: { // GEP: [n x operands]
1227      unsigned OpNum = 0;
1228      Value *BasePtr;
1229      if (getValueTypePair(Record, OpNum, NextValueNo, BasePtr))
1230        return Error("Invalid GEP record");
1231
1232      SmallVector<Value*, 16> GEPIdx;
1233      while (OpNum != Record.size()) {
1234        Value *Op;
1235        if (getValueTypePair(Record, OpNum, NextValueNo, Op))
1236          return Error("Invalid GEP record");
1237        GEPIdx.push_back(Op);
1238      }
1239
1240      I = new GetElementPtrInst(BasePtr, GEPIdx.begin(), GEPIdx.end());
1241      break;
1242    }
1243
1244    case bitc::FUNC_CODE_INST_SELECT: { // SELECT: [opval, ty, opval, opval]
1245      unsigned OpNum = 0;
1246      Value *TrueVal, *FalseVal, *Cond;
1247      if (getValueTypePair(Record, OpNum, NextValueNo, TrueVal) ||
1248          getValue(Record, OpNum, TrueVal->getType(), FalseVal) ||
1249          getValue(Record, OpNum, Type::Int1Ty, Cond))
1250        return Error("Invalid SELECT record");
1251
1252      I = new SelectInst(Cond, TrueVal, FalseVal);
1253      break;
1254    }
1255
1256    case bitc::FUNC_CODE_INST_EXTRACTELT: { // EXTRACTELT: [opty, opval, opval]
1257      unsigned OpNum = 0;
1258      Value *Vec, *Idx;
1259      if (getValueTypePair(Record, OpNum, NextValueNo, Vec) ||
1260          getValue(Record, OpNum, Type::Int32Ty, Idx))
1261        return Error("Invalid EXTRACTELT record");
1262      I = new ExtractElementInst(Vec, Idx);
1263      break;
1264    }
1265
1266    case bitc::FUNC_CODE_INST_INSERTELT: { // INSERTELT: [ty, opval,opval,opval]
1267      unsigned OpNum = 0;
1268      Value *Vec, *Elt, *Idx;
1269      if (getValueTypePair(Record, OpNum, NextValueNo, Vec) ||
1270          getValue(Record, OpNum,
1271                   cast<VectorType>(Vec->getType())->getElementType(), Elt) ||
1272          getValue(Record, OpNum, Type::Int32Ty, Idx))
1273        return Error("Invalid INSERTELT record");
1274      I = new InsertElementInst(Vec, Elt, Idx);
1275      break;
1276    }
1277
1278    case bitc::FUNC_CODE_INST_SHUFFLEVEC: {// SHUFFLEVEC: [opval,ty,opval,opval]
1279      unsigned OpNum = 0;
1280      Value *Vec1, *Vec2, *Mask;
1281      if (getValueTypePair(Record, OpNum, NextValueNo, Vec1) ||
1282          getValue(Record, OpNum, Vec1->getType(), Vec2))
1283        return Error("Invalid SHUFFLEVEC record");
1284
1285      const Type *MaskTy =
1286        VectorType::get(Type::Int32Ty,
1287                        cast<VectorType>(Vec1->getType())->getNumElements());
1288
1289      if (getValue(Record, OpNum, MaskTy, Mask))
1290        return Error("Invalid SHUFFLEVEC record");
1291      I = new ShuffleVectorInst(Vec1, Vec2, Mask);
1292      break;
1293    }
1294
1295    case bitc::FUNC_CODE_INST_CMP: { // CMP: [opty, opval, opval, pred]
1296      unsigned OpNum = 0;
1297      Value *LHS, *RHS;
1298      if (getValueTypePair(Record, OpNum, NextValueNo, LHS) ||
1299          getValue(Record, OpNum, LHS->getType(), RHS) ||
1300          OpNum+1 != Record.size())
1301        return Error("Invalid CMP record");
1302
1303      if (LHS->getType()->isFPOrFPVector())
1304        I = new FCmpInst((FCmpInst::Predicate)Record[OpNum], LHS, RHS);
1305      else
1306        I = new ICmpInst((ICmpInst::Predicate)Record[OpNum], LHS, RHS);
1307      break;
1308    }
1309
1310    case bitc::FUNC_CODE_INST_RET: // RET: [opty,opval<optional>]
1311      if (Record.size() == 0) {
1312        I = new ReturnInst();
1313        break;
1314      } else {
1315        unsigned OpNum = 0;
1316        Value *Op;
1317        if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
1318            OpNum != Record.size())
1319          return Error("Invalid RET record");
1320        I = new ReturnInst(Op);
1321        break;
1322      }
1323    case bitc::FUNC_CODE_INST_BR: { // BR: [bb#, bb#, opval] or [bb#]
1324      if (Record.size() != 1 && Record.size() != 3)
1325        return Error("Invalid BR record");
1326      BasicBlock *TrueDest = getBasicBlock(Record[0]);
1327      if (TrueDest == 0)
1328        return Error("Invalid BR record");
1329
1330      if (Record.size() == 1)
1331        I = new BranchInst(TrueDest);
1332      else {
1333        BasicBlock *FalseDest = getBasicBlock(Record[1]);
1334        Value *Cond = getFnValueByID(Record[2], Type::Int1Ty);
1335        if (FalseDest == 0 || Cond == 0)
1336          return Error("Invalid BR record");
1337        I = new BranchInst(TrueDest, FalseDest, Cond);
1338      }
1339      break;
1340    }
1341    case bitc::FUNC_CODE_INST_SWITCH: { // SWITCH: [opty, opval, n, n x ops]
1342      if (Record.size() < 3 || (Record.size() & 1) == 0)
1343        return Error("Invalid SWITCH record");
1344      const Type *OpTy = getTypeByID(Record[0]);
1345      Value *Cond = getFnValueByID(Record[1], OpTy);
1346      BasicBlock *Default = getBasicBlock(Record[2]);
1347      if (OpTy == 0 || Cond == 0 || Default == 0)
1348        return Error("Invalid SWITCH record");
1349      unsigned NumCases = (Record.size()-3)/2;
1350      SwitchInst *SI = new SwitchInst(Cond, Default, NumCases);
1351      for (unsigned i = 0, e = NumCases; i != e; ++i) {
1352        ConstantInt *CaseVal =
1353          dyn_cast_or_null<ConstantInt>(getFnValueByID(Record[3+i*2], OpTy));
1354        BasicBlock *DestBB = getBasicBlock(Record[1+3+i*2]);
1355        if (CaseVal == 0 || DestBB == 0) {
1356          delete SI;
1357          return Error("Invalid SWITCH record!");
1358        }
1359        SI->addCase(CaseVal, DestBB);
1360      }
1361      I = SI;
1362      break;
1363    }
1364
1365    case bitc::FUNC_CODE_INST_INVOKE: { // INVOKE: [cc,fnty, op0,op1,op2, ...]
1366      if (Record.size() < 4) return Error("Invalid INVOKE record");
1367      unsigned CCInfo = Record[1];
1368      BasicBlock *NormalBB = getBasicBlock(Record[2]);
1369      BasicBlock *UnwindBB = getBasicBlock(Record[3]);
1370
1371      unsigned OpNum = 4;
1372      Value *Callee;
1373      if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
1374        return Error("Invalid INVOKE record");
1375
1376      const PointerType *CalleeTy = dyn_cast<PointerType>(Callee->getType());
1377      const FunctionType *FTy = !CalleeTy ? 0 :
1378        dyn_cast<FunctionType>(CalleeTy->getElementType());
1379
1380      // Check that the right number of fixed parameters are here.
1381      if (FTy == 0 || NormalBB == 0 || UnwindBB == 0 ||
1382          Record.size() < OpNum+FTy->getNumParams())
1383        return Error("Invalid INVOKE record");
1384
1385      assert(FTy->getParamAttrs() == getParamAttrs(Record[0]));
1386
1387      SmallVector<Value*, 16> Ops;
1388      for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
1389        Ops.push_back(getFnValueByID(Record[OpNum], FTy->getParamType(i)));
1390        if (Ops.back() == 0) return Error("Invalid INVOKE record");
1391      }
1392
1393      if (!FTy->isVarArg()) {
1394        if (Record.size() != OpNum)
1395          return Error("Invalid INVOKE record");
1396      } else {
1397        // Read type/value pairs for varargs params.
1398        while (OpNum != Record.size()) {
1399          Value *Op;
1400          if (getValueTypePair(Record, OpNum, NextValueNo, Op))
1401            return Error("Invalid INVOKE record");
1402          Ops.push_back(Op);
1403        }
1404      }
1405
1406      I = new InvokeInst(Callee, NormalBB, UnwindBB, Ops.begin(), Ops.end());
1407      cast<InvokeInst>(I)->setCallingConv(CCInfo);
1408      break;
1409    }
1410    case bitc::FUNC_CODE_INST_UNWIND: // UNWIND
1411      I = new UnwindInst();
1412      break;
1413    case bitc::FUNC_CODE_INST_UNREACHABLE: // UNREACHABLE
1414      I = new UnreachableInst();
1415      break;
1416    case bitc::FUNC_CODE_INST_PHI: { // PHI: [ty, val0,bb0, ...]
1417      if (Record.size() < 1 || ((Record.size()-1)&1))
1418        return Error("Invalid PHI record");
1419      const Type *Ty = getTypeByID(Record[0]);
1420      if (!Ty) return Error("Invalid PHI record");
1421
1422      PHINode *PN = new PHINode(Ty);
1423      PN->reserveOperandSpace(Record.size()-1);
1424
1425      for (unsigned i = 0, e = Record.size()-1; i != e; i += 2) {
1426        Value *V = getFnValueByID(Record[1+i], Ty);
1427        BasicBlock *BB = getBasicBlock(Record[2+i]);
1428        if (!V || !BB) return Error("Invalid PHI record");
1429        PN->addIncoming(V, BB);
1430      }
1431      I = PN;
1432      break;
1433    }
1434
1435    case bitc::FUNC_CODE_INST_MALLOC: { // MALLOC: [instty, op, align]
1436      if (Record.size() < 3)
1437        return Error("Invalid MALLOC record");
1438      const PointerType *Ty =
1439        dyn_cast_or_null<PointerType>(getTypeByID(Record[0]));
1440      Value *Size = getFnValueByID(Record[1], Type::Int32Ty);
1441      unsigned Align = Record[2];
1442      if (!Ty || !Size) return Error("Invalid MALLOC record");
1443      I = new MallocInst(Ty->getElementType(), Size, (1 << Align) >> 1);
1444      break;
1445    }
1446    case bitc::FUNC_CODE_INST_FREE: { // FREE: [op, opty]
1447      unsigned OpNum = 0;
1448      Value *Op;
1449      if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
1450          OpNum != Record.size())
1451        return Error("Invalid FREE record");
1452      I = new FreeInst(Op);
1453      break;
1454    }
1455    case bitc::FUNC_CODE_INST_ALLOCA: { // ALLOCA: [instty, op, align]
1456      if (Record.size() < 3)
1457        return Error("Invalid ALLOCA record");
1458      const PointerType *Ty =
1459        dyn_cast_or_null<PointerType>(getTypeByID(Record[0]));
1460      Value *Size = getFnValueByID(Record[1], Type::Int32Ty);
1461      unsigned Align = Record[2];
1462      if (!Ty || !Size) return Error("Invalid ALLOCA record");
1463      I = new AllocaInst(Ty->getElementType(), Size, (1 << Align) >> 1);
1464      break;
1465    }
1466    case bitc::FUNC_CODE_INST_LOAD: { // LOAD: [opty, op, align, vol]
1467      unsigned OpNum = 0;
1468      Value *Op;
1469      if (getValueTypePair(Record, OpNum, NextValueNo, Op) ||
1470          OpNum+2 != Record.size())
1471        return Error("Invalid LOAD record");
1472
1473      I = new LoadInst(Op, "", Record[OpNum+1], (1 << Record[OpNum]) >> 1);
1474      break;
1475    }
1476    case bitc::FUNC_CODE_INST_STORE: { // STORE:[val, valty, ptr, align, vol]
1477      unsigned OpNum = 0;
1478      Value *Val, *Ptr;
1479      if (getValueTypePair(Record, OpNum, NextValueNo, Val) ||
1480          getValue(Record, OpNum, PointerType::get(Val->getType()), Ptr) ||
1481          OpNum+2 != Record.size())
1482        return Error("Invalid STORE record");
1483
1484      I = new StoreInst(Val, Ptr, Record[OpNum+1], (1 << Record[OpNum]) >> 1);
1485      break;
1486    }
1487    case bitc::FUNC_CODE_INST_CALL: { // CALL: [cc, fnty, fnid, arg0, arg1...]
1488      if (Record.size() < 2)
1489        return Error("Invalid CALL record");
1490
1491      unsigned CCInfo = Record[1];
1492
1493      unsigned OpNum = 2;
1494      Value *Callee;
1495      if (getValueTypePair(Record, OpNum, NextValueNo, Callee))
1496        return Error("Invalid CALL record");
1497
1498      const PointerType *OpTy = dyn_cast<PointerType>(Callee->getType());
1499      const FunctionType *FTy = 0;
1500      if (OpTy) FTy = dyn_cast<FunctionType>(OpTy->getElementType());
1501      if (!FTy || Record.size() < FTy->getNumParams()+OpNum)
1502        return Error("Invalid CALL record");
1503
1504      assert(FTy->getParamAttrs() == getParamAttrs(Record[0]));
1505
1506      SmallVector<Value*, 16> Args;
1507      // Read the fixed params.
1508      for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i, ++OpNum) {
1509        Args.push_back(getFnValueByID(Record[OpNum], FTy->getParamType(i)));
1510        if (Args.back() == 0) return Error("Invalid CALL record");
1511      }
1512
1513      // Read type/value pairs for varargs params.
1514      if (!FTy->isVarArg()) {
1515        if (OpNum != Record.size())
1516          return Error("Invalid CALL record");
1517      } else {
1518        while (OpNum != Record.size()) {
1519          Value *Op;
1520          if (getValueTypePair(Record, OpNum, NextValueNo, Op))
1521            return Error("Invalid CALL record");
1522          Args.push_back(Op);
1523        }
1524      }
1525
1526      I = new CallInst(Callee, Args.begin(), Args.end());
1527      cast<CallInst>(I)->setCallingConv(CCInfo>>1);
1528      cast<CallInst>(I)->setTailCall(CCInfo & 1);
1529      break;
1530    }
1531    case bitc::FUNC_CODE_INST_VAARG: { // VAARG: [valistty, valist, instty]
1532      if (Record.size() < 3)
1533        return Error("Invalid VAARG record");
1534      const Type *OpTy = getTypeByID(Record[0]);
1535      Value *Op = getFnValueByID(Record[1], OpTy);
1536      const Type *ResTy = getTypeByID(Record[2]);
1537      if (!OpTy || !Op || !ResTy)
1538        return Error("Invalid VAARG record");
1539      I = new VAArgInst(Op, ResTy);
1540      break;
1541    }
1542    }
1543
1544    // Add instruction to end of current BB.  If there is no current BB, reject
1545    // this file.
1546    if (CurBB == 0) {
1547      delete I;
1548      return Error("Invalid instruction with no BB");
1549    }
1550    CurBB->getInstList().push_back(I);
1551
1552    // If this was a terminator instruction, move to the next block.
1553    if (isa<TerminatorInst>(I)) {
1554      ++CurBBNo;
1555      CurBB = CurBBNo < FunctionBBs.size() ? FunctionBBs[CurBBNo] : 0;
1556    }
1557
1558    // Non-void values get registered in the value table for future use.
1559    if (I && I->getType() != Type::VoidTy)
1560      ValueList.AssignValue(I, NextValueNo++);
1561  }
1562
1563  // Check the function list for unresolved values.
1564  if (Argument *A = dyn_cast<Argument>(ValueList.back())) {
1565    if (A->getParent() == 0) {
1566      // We found at least one unresolved value.  Nuke them all to avoid leaks.
1567      for (unsigned i = ModuleValueListSize, e = ValueList.size(); i != e; ++i){
1568        if ((A = dyn_cast<Argument>(ValueList.back())) && A->getParent() == 0) {
1569          A->replaceAllUsesWith(UndefValue::get(A->getType()));
1570          delete A;
1571        }
1572      }
1573      return Error("Never resolved value found in function!");
1574    }
1575  }
1576
1577  // Trim the value list down to the size it was before we parsed this function.
1578  ValueList.shrinkTo(ModuleValueListSize);
1579  std::vector<BasicBlock*>().swap(FunctionBBs);
1580
1581  return false;
1582}
1583
1584//===----------------------------------------------------------------------===//
1585// ModuleProvider implementation
1586//===----------------------------------------------------------------------===//
1587
1588
1589bool BitcodeReader::materializeFunction(Function *F, std::string *ErrInfo) {
1590  // If it already is material, ignore the request.
1591  if (!F->hasNotBeenReadFromBitcode()) return false;
1592
1593  DenseMap<Function*, std::pair<uint64_t, unsigned> >::iterator DFII =
1594    DeferredFunctionInfo.find(F);
1595  assert(DFII != DeferredFunctionInfo.end() && "Deferred function not found!");
1596
1597  // Move the bit stream to the saved position of the deferred function body and
1598  // restore the real linkage type for the function.
1599  Stream.JumpToBit(DFII->second.first);
1600  F->setLinkage((GlobalValue::LinkageTypes)DFII->second.second);
1601
1602  if (ParseFunctionBody(F)) {
1603    if (ErrInfo) *ErrInfo = ErrorString;
1604    return true;
1605  }
1606
1607  // Upgrade any old intrinsic calls in the function.
1608  for (UpgradedIntrinsicMap::iterator I = UpgradedIntrinsics.begin(),
1609       E = UpgradedIntrinsics.end(); I != E; ++I) {
1610    if (I->first != I->second) {
1611      for (Value::use_iterator UI = I->first->use_begin(),
1612           UE = I->first->use_end(); UI != UE; ) {
1613        if (CallInst* CI = dyn_cast<CallInst>(*UI++))
1614          UpgradeIntrinsicCall(CI, I->second);
1615      }
1616    }
1617  }
1618
1619  return false;
1620}
1621
1622void BitcodeReader::dematerializeFunction(Function *F) {
1623  // If this function isn't materialized, or if it is a proto, this is a noop.
1624  if (F->hasNotBeenReadFromBitcode() || F->isDeclaration())
1625    return;
1626
1627  assert(DeferredFunctionInfo.count(F) && "No info to read function later?");
1628
1629  // Just forget the function body, we can remat it later.
1630  F->deleteBody();
1631  F->setLinkage(GlobalValue::GhostLinkage);
1632}
1633
1634
1635Module *BitcodeReader::materializeModule(std::string *ErrInfo) {
1636  for (DenseMap<Function*, std::pair<uint64_t, unsigned> >::iterator I =
1637       DeferredFunctionInfo.begin(), E = DeferredFunctionInfo.end(); I != E;
1638       ++I) {
1639    Function *F = I->first;
1640    if (F->hasNotBeenReadFromBitcode() &&
1641        materializeFunction(F, ErrInfo))
1642      return 0;
1643  }
1644
1645  // Upgrade any intrinsic calls that slipped through (should not happen!) and
1646  // delete the old functions to clean up. We can't do this unless the entire
1647  // module is materialized because there could always be another function body
1648  // with calls to the old function.
1649  for (std::vector<std::pair<Function*, Function*> >::iterator I =
1650       UpgradedIntrinsics.begin(), E = UpgradedIntrinsics.end(); I != E; ++I) {
1651    if (I->first != I->second) {
1652      for (Value::use_iterator UI = I->first->use_begin(),
1653           UE = I->first->use_end(); UI != UE; ) {
1654        if (CallInst* CI = dyn_cast<CallInst>(*UI++))
1655          UpgradeIntrinsicCall(CI, I->second);
1656      }
1657      ValueList.replaceUsesOfWith(I->first, I->second);
1658      I->first->eraseFromParent();
1659    }
1660  }
1661  std::vector<std::pair<Function*, Function*> >().swap(UpgradedIntrinsics);
1662
1663  return TheModule;
1664}
1665
1666
1667/// This method is provided by the parent ModuleProvde class and overriden
1668/// here. It simply releases the module from its provided and frees up our
1669/// state.
1670/// @brief Release our hold on the generated module
1671Module *BitcodeReader::releaseModule(std::string *ErrInfo) {
1672  // Since we're losing control of this Module, we must hand it back complete
1673  Module *M = ModuleProvider::releaseModule(ErrInfo);
1674  FreeState();
1675  return M;
1676}
1677
1678
1679//===----------------------------------------------------------------------===//
1680// External interface
1681//===----------------------------------------------------------------------===//
1682
1683/// getBitcodeModuleProvider - lazy function-at-a-time loading from a file.
1684///
1685ModuleProvider *llvm::getBitcodeModuleProvider(MemoryBuffer *Buffer,
1686                                               std::string *ErrMsg) {
1687  BitcodeReader *R = new BitcodeReader(Buffer);
1688  if (R->ParseBitcode()) {
1689    if (ErrMsg)
1690      *ErrMsg = R->getErrorString();
1691
1692    // Don't let the BitcodeReader dtor delete 'Buffer'.
1693    R->releaseMemoryBuffer();
1694    delete R;
1695    return 0;
1696  }
1697  return R;
1698}
1699
1700/// ParseBitcodeFile - Read the specified bitcode file, returning the module.
1701/// If an error occurs, return null and fill in *ErrMsg if non-null.
1702Module *llvm::ParseBitcodeFile(MemoryBuffer *Buffer, std::string *ErrMsg){
1703  BitcodeReader *R;
1704  R = static_cast<BitcodeReader*>(getBitcodeModuleProvider(Buffer, ErrMsg));
1705  if (!R) return 0;
1706
1707  // Read in the entire module.
1708  Module *M = R->materializeModule(ErrMsg);
1709
1710  // Don't let the BitcodeReader dtor delete 'Buffer', regardless of whether
1711  // there was an error.
1712  R->releaseMemoryBuffer();
1713
1714  // If there was no error, tell ModuleProvider not to delete it when its dtor
1715  // is run.
1716  if (M)
1717    M = R->releaseModule(ErrMsg);
1718
1719  delete R;
1720  return M;
1721}
1722