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