BitcodeWriter.cpp revision 164b86b4399559e45fab7846f1e3e09119cab4e2 
1//===--- Bitcode/Writer/BitcodeWriter.cpp - Bitcode Writer ----------------===//
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// Bitcode writer implementation.
11//
12//===----------------------------------------------------------------------===//
13
14#include "llvm/Bitcode/ReaderWriter.h"
15#include "llvm/Bitcode/BitstreamWriter.h"
16#include "llvm/Bitcode/LLVMBitCodes.h"
17#include "ValueEnumerator.h"
18#include "llvm/Constants.h"
19#include "llvm/DerivedTypes.h"
20#include "llvm/InlineAsm.h"
21#include "llvm/Instructions.h"
22#include "llvm/Module.h"
23#include "llvm/Operator.h"
24#include "llvm/ValueSymbolTable.h"
25#include "llvm/ADT/Triple.h"
26#include "llvm/Support/CommandLine.h"
27#include "llvm/Support/ErrorHandling.h"
28#include "llvm/Support/MathExtras.h"
29#include "llvm/Support/raw_ostream.h"
30#include "llvm/Support/Program.h"
31#include <cctype>
32#include <map>
33using namespace llvm;
34
35static cl::opt<bool>
36EnablePreserveUseListOrdering("enable-bc-uselist-preserve",
37                              cl::desc("Turn on experimental support for "
38                                       "use-list order preservation."),
39                              cl::init(false), cl::Hidden);
40
41/// These are manifest constants used by the bitcode writer. They do not need to
42/// be kept in sync with the reader, but need to be consistent within this file.
43enum {
44  CurVersion = 0,
45
46  // VALUE_SYMTAB_BLOCK abbrev id's.
47  VST_ENTRY_8_ABBREV = bitc::FIRST_APPLICATION_ABBREV,
48  VST_ENTRY_7_ABBREV,
49  VST_ENTRY_6_ABBREV,
50  VST_BBENTRY_6_ABBREV,
51
52  // CONSTANTS_BLOCK abbrev id's.
53  CONSTANTS_SETTYPE_ABBREV = bitc::FIRST_APPLICATION_ABBREV,
54  CONSTANTS_INTEGER_ABBREV,
55  CONSTANTS_CE_CAST_Abbrev,
56  CONSTANTS_NULL_Abbrev,
57
58  // FUNCTION_BLOCK abbrev id's.
59  FUNCTION_INST_LOAD_ABBREV = bitc::FIRST_APPLICATION_ABBREV,
60  FUNCTION_INST_BINOP_ABBREV,
61  FUNCTION_INST_BINOP_FLAGS_ABBREV,
62  FUNCTION_INST_CAST_ABBREV,
63  FUNCTION_INST_RET_VOID_ABBREV,
64  FUNCTION_INST_RET_VAL_ABBREV,
65  FUNCTION_INST_UNREACHABLE_ABBREV
66};
67
68static unsigned GetEncodedCastOpcode(unsigned Opcode) {
69  switch (Opcode) {
70  default: llvm_unreachable("Unknown cast instruction!");
71  case Instruction::Trunc   : return bitc::CAST_TRUNC;
72  case Instruction::ZExt    : return bitc::CAST_ZEXT;
73  case Instruction::SExt    : return bitc::CAST_SEXT;
74  case Instruction::FPToUI  : return bitc::CAST_FPTOUI;
75  case Instruction::FPToSI  : return bitc::CAST_FPTOSI;
76  case Instruction::UIToFP  : return bitc::CAST_UITOFP;
77  case Instruction::SIToFP  : return bitc::CAST_SITOFP;
78  case Instruction::FPTrunc : return bitc::CAST_FPTRUNC;
79  case Instruction::FPExt   : return bitc::CAST_FPEXT;
80  case Instruction::PtrToInt: return bitc::CAST_PTRTOINT;
81  case Instruction::IntToPtr: return bitc::CAST_INTTOPTR;
82  case Instruction::BitCast : return bitc::CAST_BITCAST;
83  }
84}
85
86static unsigned GetEncodedBinaryOpcode(unsigned Opcode) {
87  switch (Opcode) {
88  default: llvm_unreachable("Unknown binary instruction!");
89  case Instruction::Add:
90  case Instruction::FAdd: return bitc::BINOP_ADD;
91  case Instruction::Sub:
92  case Instruction::FSub: return bitc::BINOP_SUB;
93  case Instruction::Mul:
94  case Instruction::FMul: return bitc::BINOP_MUL;
95  case Instruction::UDiv: return bitc::BINOP_UDIV;
96  case Instruction::FDiv:
97  case Instruction::SDiv: return bitc::BINOP_SDIV;
98  case Instruction::URem: return bitc::BINOP_UREM;
99  case Instruction::FRem:
100  case Instruction::SRem: return bitc::BINOP_SREM;
101  case Instruction::Shl:  return bitc::BINOP_SHL;
102  case Instruction::LShr: return bitc::BINOP_LSHR;
103  case Instruction::AShr: return bitc::BINOP_ASHR;
104  case Instruction::And:  return bitc::BINOP_AND;
105  case Instruction::Or:   return bitc::BINOP_OR;
106  case Instruction::Xor:  return bitc::BINOP_XOR;
107  }
108}
109
110static unsigned GetEncodedRMWOperation(AtomicRMWInst::BinOp Op) {
111  switch (Op) {
112  default: llvm_unreachable("Unknown RMW operation!");
113  case AtomicRMWInst::Xchg: return bitc::RMW_XCHG;
114  case AtomicRMWInst::Add: return bitc::RMW_ADD;
115  case AtomicRMWInst::Sub: return bitc::RMW_SUB;
116  case AtomicRMWInst::And: return bitc::RMW_AND;
117  case AtomicRMWInst::Nand: return bitc::RMW_NAND;
118  case AtomicRMWInst::Or: return bitc::RMW_OR;
119  case AtomicRMWInst::Xor: return bitc::RMW_XOR;
120  case AtomicRMWInst::Max: return bitc::RMW_MAX;
121  case AtomicRMWInst::Min: return bitc::RMW_MIN;
122  case AtomicRMWInst::UMax: return bitc::RMW_UMAX;
123  case AtomicRMWInst::UMin: return bitc::RMW_UMIN;
124  }
125}
126
127static unsigned GetEncodedOrdering(AtomicOrdering Ordering) {
128  switch (Ordering) {
129  case NotAtomic: return bitc::ORDERING_NOTATOMIC;
130  case Unordered: return bitc::ORDERING_UNORDERED;
131  case Monotonic: return bitc::ORDERING_MONOTONIC;
132  case Acquire: return bitc::ORDERING_ACQUIRE;
133  case Release: return bitc::ORDERING_RELEASE;
134  case AcquireRelease: return bitc::ORDERING_ACQREL;
135  case SequentiallyConsistent: return bitc::ORDERING_SEQCST;
136  }
137  llvm_unreachable("Invalid ordering");
138}
139
140static unsigned GetEncodedSynchScope(SynchronizationScope SynchScope) {
141  switch (SynchScope) {
142  case SingleThread: return bitc::SYNCHSCOPE_SINGLETHREAD;
143  case CrossThread: return bitc::SYNCHSCOPE_CROSSTHREAD;
144  }
145  llvm_unreachable("Invalid synch scope");
146}
147
148static void WriteStringRecord(unsigned Code, StringRef Str,
149                              unsigned AbbrevToUse, BitstreamWriter &Stream) {
150  SmallVector<unsigned, 64> Vals;
151
152  // Code: [strchar x N]
153  for (unsigned i = 0, e = Str.size(); i != e; ++i) {
154    if (AbbrevToUse && !BitCodeAbbrevOp::isChar6(Str[i]))
155      AbbrevToUse = 0;
156    Vals.push_back(Str[i]);
157  }
158
159  // Emit the finished record.
160  Stream.EmitRecord(Code, Vals, AbbrevToUse);
161}
162
163// Emit information about parameter attributes.
164static void WriteAttributeTable(const ValueEnumerator &VE,
165                                BitstreamWriter &Stream) {
166  const std::vector<AttrListPtr> &Attrs = VE.getAttributes();
167  if (Attrs.empty()) return;
168
169  Stream.EnterSubblock(bitc::PARAMATTR_BLOCK_ID, 3);
170
171  SmallVector<uint64_t, 64> Record;
172  for (unsigned i = 0, e = Attrs.size(); i != e; ++i) {
173    const AttrListPtr &A = Attrs[i];
174    for (unsigned i = 0, e = A.getNumSlots(); i != e; ++i) {
175      const AttributeWithIndex &PAWI = A.getSlot(i);
176      Record.push_back(PAWI.Index);
177
178      // FIXME: remove in LLVM 3.0
179      // Store the alignment in the bitcode as a 16-bit raw value instead of a
180      // 5-bit log2 encoded value. Shift the bits above the alignment up by
181      // 11 bits.
182      uint64_t FauxAttr = PAWI.Attrs.Raw() & 0xffff;
183      if (PAWI.Attrs & Attribute::Alignment)
184        FauxAttr |= (1ull<<16)<<
185            (((PAWI.Attrs & Attribute::Alignment).Raw()-1) >> 16);
186      FauxAttr |= (PAWI.Attrs.Raw() & (0x3FFull << 21)) << 11;
187
188      Record.push_back(FauxAttr);
189    }
190
191    Stream.EmitRecord(bitc::PARAMATTR_CODE_ENTRY, Record);
192    Record.clear();
193  }
194
195  Stream.ExitBlock();
196}
197
198/// WriteTypeTable - Write out the type table for a module.
199static void WriteTypeTable(const ValueEnumerator &VE, BitstreamWriter &Stream) {
200  const ValueEnumerator::TypeList &TypeList = VE.getTypes();
201
202  Stream.EnterSubblock(bitc::TYPE_BLOCK_ID_NEW, 4 /*count from # abbrevs */);
203  SmallVector<uint64_t, 64> TypeVals;
204
205  uint64_t NumBits = Log2_32_Ceil(VE.getTypes().size()+1);
206
207  // Abbrev for TYPE_CODE_POINTER.
208  BitCodeAbbrev *Abbv = new BitCodeAbbrev();
209  Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_POINTER));
210  Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
211  Abbv->Add(BitCodeAbbrevOp(0));  // Addrspace = 0
212  unsigned PtrAbbrev = Stream.EmitAbbrev(Abbv);
213
214  // Abbrev for TYPE_CODE_FUNCTION.
215  Abbv = new BitCodeAbbrev();
216  Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_FUNCTION));
217  Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));  // isvararg
218  Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
219  Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
220
221  unsigned FunctionAbbrev = Stream.EmitAbbrev(Abbv);
222
223  // Abbrev for TYPE_CODE_STRUCT_ANON.
224  Abbv = new BitCodeAbbrev();
225  Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_STRUCT_ANON));
226  Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));  // ispacked
227  Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
228  Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
229
230  unsigned StructAnonAbbrev = Stream.EmitAbbrev(Abbv);
231
232  // Abbrev for TYPE_CODE_STRUCT_NAME.
233  Abbv = new BitCodeAbbrev();
234  Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_STRUCT_NAME));
235  Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
236  Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
237  unsigned StructNameAbbrev = Stream.EmitAbbrev(Abbv);
238
239  // Abbrev for TYPE_CODE_STRUCT_NAMED.
240  Abbv = new BitCodeAbbrev();
241  Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_STRUCT_NAMED));
242  Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));  // ispacked
243  Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
244  Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
245
246  unsigned StructNamedAbbrev = Stream.EmitAbbrev(Abbv);
247
248  // Abbrev for TYPE_CODE_ARRAY.
249  Abbv = new BitCodeAbbrev();
250  Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_ARRAY));
251  Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));   // size
252  Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
253
254  unsigned ArrayAbbrev = Stream.EmitAbbrev(Abbv);
255
256  // Emit an entry count so the reader can reserve space.
257  TypeVals.push_back(TypeList.size());
258  Stream.EmitRecord(bitc::TYPE_CODE_NUMENTRY, TypeVals);
259  TypeVals.clear();
260
261  // Loop over all of the types, emitting each in turn.
262  for (unsigned i = 0, e = TypeList.size(); i != e; ++i) {
263    Type *T = TypeList[i];
264    int AbbrevToUse = 0;
265    unsigned Code = 0;
266
267    switch (T->getTypeID()) {
268    default: llvm_unreachable("Unknown type!");
269    case Type::VoidTyID:      Code = bitc::TYPE_CODE_VOID;   break;
270    case Type::HalfTyID:      Code = bitc::TYPE_CODE_HALF;   break;
271    case Type::FloatTyID:     Code = bitc::TYPE_CODE_FLOAT;  break;
272    case Type::DoubleTyID:    Code = bitc::TYPE_CODE_DOUBLE; break;
273    case Type::X86_FP80TyID:  Code = bitc::TYPE_CODE_X86_FP80; break;
274    case Type::FP128TyID:     Code = bitc::TYPE_CODE_FP128; break;
275    case Type::PPC_FP128TyID: Code = bitc::TYPE_CODE_PPC_FP128; break;
276    case Type::LabelTyID:     Code = bitc::TYPE_CODE_LABEL;  break;
277    case Type::MetadataTyID:  Code = bitc::TYPE_CODE_METADATA; break;
278    case Type::X86_MMXTyID:   Code = bitc::TYPE_CODE_X86_MMX; break;
279    case Type::IntegerTyID:
280      // INTEGER: [width]
281      Code = bitc::TYPE_CODE_INTEGER;
282      TypeVals.push_back(cast<IntegerType>(T)->getBitWidth());
283      break;
284    case Type::PointerTyID: {
285      PointerType *PTy = cast<PointerType>(T);
286      // POINTER: [pointee type, address space]
287      Code = bitc::TYPE_CODE_POINTER;
288      TypeVals.push_back(VE.getTypeID(PTy->getElementType()));
289      unsigned AddressSpace = PTy->getAddressSpace();
290      TypeVals.push_back(AddressSpace);
291      if (AddressSpace == 0) AbbrevToUse = PtrAbbrev;
292      break;
293    }
294    case Type::FunctionTyID: {
295      FunctionType *FT = cast<FunctionType>(T);
296      // FUNCTION: [isvararg, retty, paramty x N]
297      Code = bitc::TYPE_CODE_FUNCTION;
298      TypeVals.push_back(FT->isVarArg());
299      TypeVals.push_back(VE.getTypeID(FT->getReturnType()));
300      for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i)
301        TypeVals.push_back(VE.getTypeID(FT->getParamType(i)));
302      AbbrevToUse = FunctionAbbrev;
303      break;
304    }
305    case Type::StructTyID: {
306      StructType *ST = cast<StructType>(T);
307      // STRUCT: [ispacked, eltty x N]
308      TypeVals.push_back(ST->isPacked());
309      // Output all of the element types.
310      for (StructType::element_iterator I = ST->element_begin(),
311           E = ST->element_end(); I != E; ++I)
312        TypeVals.push_back(VE.getTypeID(*I));
313
314      if (ST->isLiteral()) {
315        Code = bitc::TYPE_CODE_STRUCT_ANON;
316        AbbrevToUse = StructAnonAbbrev;
317      } else {
318        if (ST->isOpaque()) {
319          Code = bitc::TYPE_CODE_OPAQUE;
320        } else {
321          Code = bitc::TYPE_CODE_STRUCT_NAMED;
322          AbbrevToUse = StructNamedAbbrev;
323        }
324
325        // Emit the name if it is present.
326        if (!ST->getName().empty())
327          WriteStringRecord(bitc::TYPE_CODE_STRUCT_NAME, ST->getName(),
328                            StructNameAbbrev, Stream);
329      }
330      break;
331    }
332    case Type::ArrayTyID: {
333      ArrayType *AT = cast<ArrayType>(T);
334      // ARRAY: [numelts, eltty]
335      Code = bitc::TYPE_CODE_ARRAY;
336      TypeVals.push_back(AT->getNumElements());
337      TypeVals.push_back(VE.getTypeID(AT->getElementType()));
338      AbbrevToUse = ArrayAbbrev;
339      break;
340    }
341    case Type::VectorTyID: {
342      VectorType *VT = cast<VectorType>(T);
343      // VECTOR [numelts, eltty]
344      Code = bitc::TYPE_CODE_VECTOR;
345      TypeVals.push_back(VT->getNumElements());
346      TypeVals.push_back(VE.getTypeID(VT->getElementType()));
347      break;
348    }
349    }
350
351    // Emit the finished record.
352    Stream.EmitRecord(Code, TypeVals, AbbrevToUse);
353    TypeVals.clear();
354  }
355
356  Stream.ExitBlock();
357}
358
359static unsigned getEncodedLinkage(const GlobalValue *GV) {
360  switch (GV->getLinkage()) {
361  case GlobalValue::ExternalLinkage:                 return 0;
362  case GlobalValue::WeakAnyLinkage:                  return 1;
363  case GlobalValue::AppendingLinkage:                return 2;
364  case GlobalValue::InternalLinkage:                 return 3;
365  case GlobalValue::LinkOnceAnyLinkage:              return 4;
366  case GlobalValue::DLLImportLinkage:                return 5;
367  case GlobalValue::DLLExportLinkage:                return 6;
368  case GlobalValue::ExternalWeakLinkage:             return 7;
369  case GlobalValue::CommonLinkage:                   return 8;
370  case GlobalValue::PrivateLinkage:                  return 9;
371  case GlobalValue::WeakODRLinkage:                  return 10;
372  case GlobalValue::LinkOnceODRLinkage:              return 11;
373  case GlobalValue::AvailableExternallyLinkage:      return 12;
374  case GlobalValue::LinkerPrivateLinkage:            return 13;
375  case GlobalValue::LinkerPrivateWeakLinkage:        return 14;
376  case GlobalValue::LinkerPrivateWeakDefAutoLinkage: return 15;
377  }
378  llvm_unreachable("Invalid linkage");
379}
380
381static unsigned getEncodedVisibility(const GlobalValue *GV) {
382  switch (GV->getVisibility()) {
383  case GlobalValue::DefaultVisibility:   return 0;
384  case GlobalValue::HiddenVisibility:    return 1;
385  case GlobalValue::ProtectedVisibility: return 2;
386  }
387  llvm_unreachable("Invalid visibility");
388}
389
390// Emit top-level description of module, including target triple, inline asm,
391// descriptors for global variables, and function prototype info.
392static void WriteModuleInfo(const Module *M, const ValueEnumerator &VE,
393                            BitstreamWriter &Stream) {
394  // Emit the list of dependent libraries for the Module.
395  for (Module::lib_iterator I = M->lib_begin(), E = M->lib_end(); I != E; ++I)
396    WriteStringRecord(bitc::MODULE_CODE_DEPLIB, *I, 0/*TODO*/, Stream);
397
398  // Emit various pieces of data attached to a module.
399  if (!M->getTargetTriple().empty())
400    WriteStringRecord(bitc::MODULE_CODE_TRIPLE, M->getTargetTriple(),
401                      0/*TODO*/, Stream);
402  if (!M->getDataLayout().empty())
403    WriteStringRecord(bitc::MODULE_CODE_DATALAYOUT, M->getDataLayout(),
404                      0/*TODO*/, Stream);
405  if (!M->getModuleInlineAsm().empty())
406    WriteStringRecord(bitc::MODULE_CODE_ASM, M->getModuleInlineAsm(),
407                      0/*TODO*/, Stream);
408
409  // Emit information about sections and GC, computing how many there are. Also
410  // compute the maximum alignment value.
411  std::map<std::string, unsigned> SectionMap;
412  std::map<std::string, unsigned> GCMap;
413  unsigned MaxAlignment = 0;
414  unsigned MaxGlobalType = 0;
415  for (Module::const_global_iterator GV = M->global_begin(),E = M->global_end();
416       GV != E; ++GV) {
417    MaxAlignment = std::max(MaxAlignment, GV->getAlignment());
418    MaxGlobalType = std::max(MaxGlobalType, VE.getTypeID(GV->getType()));
419    if (GV->hasSection()) {
420      // Give section names unique ID's.
421      unsigned &Entry = SectionMap[GV->getSection()];
422      if (!Entry) {
423        WriteStringRecord(bitc::MODULE_CODE_SECTIONNAME, GV->getSection(),
424                          0/*TODO*/, Stream);
425        Entry = SectionMap.size();
426      }
427    }
428  }
429  for (Module::const_iterator F = M->begin(), E = M->end(); F != E; ++F) {
430    MaxAlignment = std::max(MaxAlignment, F->getAlignment());
431    if (F->hasSection()) {
432      // Give section names unique ID's.
433      unsigned &Entry = SectionMap[F->getSection()];
434      if (!Entry) {
435        WriteStringRecord(bitc::MODULE_CODE_SECTIONNAME, F->getSection(),
436                          0/*TODO*/, Stream);
437        Entry = SectionMap.size();
438      }
439    }
440    if (F->hasGC()) {
441      // Same for GC names.
442      unsigned &Entry = GCMap[F->getGC()];
443      if (!Entry) {
444        WriteStringRecord(bitc::MODULE_CODE_GCNAME, F->getGC(),
445                          0/*TODO*/, Stream);
446        Entry = GCMap.size();
447      }
448    }
449  }
450
451  // Emit abbrev for globals, now that we know # sections and max alignment.
452  unsigned SimpleGVarAbbrev = 0;
453  if (!M->global_empty()) {
454    // Add an abbrev for common globals with no visibility or thread localness.
455    BitCodeAbbrev *Abbv = new BitCodeAbbrev();
456    Abbv->Add(BitCodeAbbrevOp(bitc::MODULE_CODE_GLOBALVAR));
457    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
458                              Log2_32_Ceil(MaxGlobalType+1)));
459    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));      // Constant.
460    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));        // Initializer.
461    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4));      // Linkage.
462    if (MaxAlignment == 0)                                      // Alignment.
463      Abbv->Add(BitCodeAbbrevOp(0));
464    else {
465      unsigned MaxEncAlignment = Log2_32(MaxAlignment)+1;
466      Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
467                               Log2_32_Ceil(MaxEncAlignment+1)));
468    }
469    if (SectionMap.empty())                                    // Section.
470      Abbv->Add(BitCodeAbbrevOp(0));
471    else
472      Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
473                               Log2_32_Ceil(SectionMap.size()+1)));
474    // Don't bother emitting vis + thread local.
475    SimpleGVarAbbrev = Stream.EmitAbbrev(Abbv);
476  }
477
478  // Emit the global variable information.
479  SmallVector<unsigned, 64> Vals;
480  for (Module::const_global_iterator GV = M->global_begin(),E = M->global_end();
481       GV != E; ++GV) {
482    unsigned AbbrevToUse = 0;
483
484    // GLOBALVAR: [type, isconst, initid,
485    //             linkage, alignment, section, visibility, threadlocal,
486    //             unnamed_addr]
487    Vals.push_back(VE.getTypeID(GV->getType()));
488    Vals.push_back(GV->isConstant());
489    Vals.push_back(GV->isDeclaration() ? 0 :
490                   (VE.getValueID(GV->getInitializer()) + 1));
491    Vals.push_back(getEncodedLinkage(GV));
492    Vals.push_back(Log2_32(GV->getAlignment())+1);
493    Vals.push_back(GV->hasSection() ? SectionMap[GV->getSection()] : 0);
494    if (GV->isThreadLocal() ||
495        GV->getVisibility() != GlobalValue::DefaultVisibility ||
496        GV->hasUnnamedAddr()) {
497      Vals.push_back(getEncodedVisibility(GV));
498      Vals.push_back(GV->isThreadLocal());
499      Vals.push_back(GV->hasUnnamedAddr());
500    } else {
501      AbbrevToUse = SimpleGVarAbbrev;
502    }
503
504    Stream.EmitRecord(bitc::MODULE_CODE_GLOBALVAR, Vals, AbbrevToUse);
505    Vals.clear();
506  }
507
508  // Emit the function proto information.
509  for (Module::const_iterator F = M->begin(), E = M->end(); F != E; ++F) {
510    // FUNCTION:  [type, callingconv, isproto, linkage, paramattrs, alignment,
511    //             section, visibility, gc, unnamed_addr]
512    Vals.push_back(VE.getTypeID(F->getType()));
513    Vals.push_back(F->getCallingConv());
514    Vals.push_back(F->isDeclaration());
515    Vals.push_back(getEncodedLinkage(F));
516    Vals.push_back(VE.getAttributeID(F->getAttributes()));
517    Vals.push_back(Log2_32(F->getAlignment())+1);
518    Vals.push_back(F->hasSection() ? SectionMap[F->getSection()] : 0);
519    Vals.push_back(getEncodedVisibility(F));
520    Vals.push_back(F->hasGC() ? GCMap[F->getGC()] : 0);
521    Vals.push_back(F->hasUnnamedAddr());
522
523    unsigned AbbrevToUse = 0;
524    Stream.EmitRecord(bitc::MODULE_CODE_FUNCTION, Vals, AbbrevToUse);
525    Vals.clear();
526  }
527
528  // Emit the alias information.
529  for (Module::const_alias_iterator AI = M->alias_begin(), E = M->alias_end();
530       AI != E; ++AI) {
531    // ALIAS: [alias type, aliasee val#, linkage, visibility]
532    Vals.push_back(VE.getTypeID(AI->getType()));
533    Vals.push_back(VE.getValueID(AI->getAliasee()));
534    Vals.push_back(getEncodedLinkage(AI));
535    Vals.push_back(getEncodedVisibility(AI));
536    unsigned AbbrevToUse = 0;
537    Stream.EmitRecord(bitc::MODULE_CODE_ALIAS, Vals, AbbrevToUse);
538    Vals.clear();
539  }
540}
541
542static uint64_t GetOptimizationFlags(const Value *V) {
543  uint64_t Flags = 0;
544
545  if (const OverflowingBinaryOperator *OBO =
546        dyn_cast<OverflowingBinaryOperator>(V)) {
547    if (OBO->hasNoSignedWrap())
548      Flags |= 1 << bitc::OBO_NO_SIGNED_WRAP;
549    if (OBO->hasNoUnsignedWrap())
550      Flags |= 1 << bitc::OBO_NO_UNSIGNED_WRAP;
551  } else if (const PossiblyExactOperator *PEO =
552               dyn_cast<PossiblyExactOperator>(V)) {
553    if (PEO->isExact())
554      Flags |= 1 << bitc::PEO_EXACT;
555  }
556
557  return Flags;
558}
559
560static void WriteMDNode(const MDNode *N,
561                        const ValueEnumerator &VE,
562                        BitstreamWriter &Stream,
563                        SmallVector<uint64_t, 64> &Record) {
564  for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
565    if (N->getOperand(i)) {
566      Record.push_back(VE.getTypeID(N->getOperand(i)->getType()));
567      Record.push_back(VE.getValueID(N->getOperand(i)));
568    } else {
569      Record.push_back(VE.getTypeID(Type::getVoidTy(N->getContext())));
570      Record.push_back(0);
571    }
572  }
573  unsigned MDCode = N->isFunctionLocal() ? bitc::METADATA_FN_NODE :
574                                           bitc::METADATA_NODE;
575  Stream.EmitRecord(MDCode, Record, 0);
576  Record.clear();
577}
578
579static void WriteModuleMetadata(const Module *M,
580                                const ValueEnumerator &VE,
581                                BitstreamWriter &Stream) {
582  const ValueEnumerator::ValueList &Vals = VE.getMDValues();
583  bool StartedMetadataBlock = false;
584  unsigned MDSAbbrev = 0;
585  SmallVector<uint64_t, 64> Record;
586  for (unsigned i = 0, e = Vals.size(); i != e; ++i) {
587
588    if (const MDNode *N = dyn_cast<MDNode>(Vals[i].first)) {
589      if (!N->isFunctionLocal() || !N->getFunction()) {
590        if (!StartedMetadataBlock) {
591          Stream.EnterSubblock(bitc::METADATA_BLOCK_ID, 3);
592          StartedMetadataBlock = true;
593        }
594        WriteMDNode(N, VE, Stream, Record);
595      }
596    } else if (const MDString *MDS = dyn_cast<MDString>(Vals[i].first)) {
597      if (!StartedMetadataBlock)  {
598        Stream.EnterSubblock(bitc::METADATA_BLOCK_ID, 3);
599
600        // Abbrev for METADATA_STRING.
601        BitCodeAbbrev *Abbv = new BitCodeAbbrev();
602        Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_STRING));
603        Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
604        Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
605        MDSAbbrev = Stream.EmitAbbrev(Abbv);
606        StartedMetadataBlock = true;
607      }
608
609      // Code: [strchar x N]
610      Record.append(MDS->begin(), MDS->end());
611
612      // Emit the finished record.
613      Stream.EmitRecord(bitc::METADATA_STRING, Record, MDSAbbrev);
614      Record.clear();
615    }
616  }
617
618  // Write named metadata.
619  for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
620       E = M->named_metadata_end(); I != E; ++I) {
621    const NamedMDNode *NMD = I;
622    if (!StartedMetadataBlock)  {
623      Stream.EnterSubblock(bitc::METADATA_BLOCK_ID, 3);
624      StartedMetadataBlock = true;
625    }
626
627    // Write name.
628    StringRef Str = NMD->getName();
629    for (unsigned i = 0, e = Str.size(); i != e; ++i)
630      Record.push_back(Str[i]);
631    Stream.EmitRecord(bitc::METADATA_NAME, Record, 0/*TODO*/);
632    Record.clear();
633
634    // Write named metadata operands.
635    for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
636      Record.push_back(VE.getValueID(NMD->getOperand(i)));
637    Stream.EmitRecord(bitc::METADATA_NAMED_NODE, Record, 0);
638    Record.clear();
639  }
640
641  if (StartedMetadataBlock)
642    Stream.ExitBlock();
643}
644
645static void WriteFunctionLocalMetadata(const Function &F,
646                                       const ValueEnumerator &VE,
647                                       BitstreamWriter &Stream) {
648  bool StartedMetadataBlock = false;
649  SmallVector<uint64_t, 64> Record;
650  const SmallVector<const MDNode *, 8> &Vals = VE.getFunctionLocalMDValues();
651  for (unsigned i = 0, e = Vals.size(); i != e; ++i)
652    if (const MDNode *N = Vals[i])
653      if (N->isFunctionLocal() && N->getFunction() == &F) {
654        if (!StartedMetadataBlock) {
655          Stream.EnterSubblock(bitc::METADATA_BLOCK_ID, 3);
656          StartedMetadataBlock = true;
657        }
658        WriteMDNode(N, VE, Stream, Record);
659      }
660
661  if (StartedMetadataBlock)
662    Stream.ExitBlock();
663}
664
665static void WriteMetadataAttachment(const Function &F,
666                                    const ValueEnumerator &VE,
667                                    BitstreamWriter &Stream) {
668  Stream.EnterSubblock(bitc::METADATA_ATTACHMENT_ID, 3);
669
670  SmallVector<uint64_t, 64> Record;
671
672  // Write metadata attachments
673  // METADATA_ATTACHMENT - [m x [value, [n x [id, mdnode]]]
674  SmallVector<std::pair<unsigned, MDNode*>, 4> MDs;
675
676  for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
677    for (BasicBlock::const_iterator I = BB->begin(), E = BB->end();
678         I != E; ++I) {
679      MDs.clear();
680      I->getAllMetadataOtherThanDebugLoc(MDs);
681
682      // If no metadata, ignore instruction.
683      if (MDs.empty()) continue;
684
685      Record.push_back(VE.getInstructionID(I));
686
687      for (unsigned i = 0, e = MDs.size(); i != e; ++i) {
688        Record.push_back(MDs[i].first);
689        Record.push_back(VE.getValueID(MDs[i].second));
690      }
691      Stream.EmitRecord(bitc::METADATA_ATTACHMENT, Record, 0);
692      Record.clear();
693    }
694
695  Stream.ExitBlock();
696}
697
698static void WriteModuleMetadataStore(const Module *M, BitstreamWriter &Stream) {
699  SmallVector<uint64_t, 64> Record;
700
701  // Write metadata kinds
702  // METADATA_KIND - [n x [id, name]]
703  SmallVector<StringRef, 4> Names;
704  M->getMDKindNames(Names);
705
706  if (Names.empty()) return;
707
708  Stream.EnterSubblock(bitc::METADATA_BLOCK_ID, 3);
709
710  for (unsigned MDKindID = 0, e = Names.size(); MDKindID != e; ++MDKindID) {
711    Record.push_back(MDKindID);
712    StringRef KName = Names[MDKindID];
713    Record.append(KName.begin(), KName.end());
714
715    Stream.EmitRecord(bitc::METADATA_KIND, Record, 0);
716    Record.clear();
717  }
718
719  Stream.ExitBlock();
720}
721
722static void WriteConstants(unsigned FirstVal, unsigned LastVal,
723                           const ValueEnumerator &VE,
724                           BitstreamWriter &Stream, bool isGlobal) {
725  if (FirstVal == LastVal) return;
726
727  Stream.EnterSubblock(bitc::CONSTANTS_BLOCK_ID, 4);
728
729  unsigned AggregateAbbrev = 0;
730  unsigned String8Abbrev = 0;
731  unsigned CString7Abbrev = 0;
732  unsigned CString6Abbrev = 0;
733  // If this is a constant pool for the module, emit module-specific abbrevs.
734  if (isGlobal) {
735    // Abbrev for CST_CODE_AGGREGATE.
736    BitCodeAbbrev *Abbv = new BitCodeAbbrev();
737    Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_AGGREGATE));
738    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
739    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, Log2_32_Ceil(LastVal+1)));
740    AggregateAbbrev = Stream.EmitAbbrev(Abbv);
741
742    // Abbrev for CST_CODE_STRING.
743    Abbv = new BitCodeAbbrev();
744    Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_STRING));
745    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
746    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
747    String8Abbrev = Stream.EmitAbbrev(Abbv);
748    // Abbrev for CST_CODE_CSTRING.
749    Abbv = new BitCodeAbbrev();
750    Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_CSTRING));
751    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
752    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7));
753    CString7Abbrev = Stream.EmitAbbrev(Abbv);
754    // Abbrev for CST_CODE_CSTRING.
755    Abbv = new BitCodeAbbrev();
756    Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_CSTRING));
757    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
758    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
759    CString6Abbrev = Stream.EmitAbbrev(Abbv);
760  }
761
762  SmallVector<uint64_t, 64> Record;
763
764  const ValueEnumerator::ValueList &Vals = VE.getValues();
765  Type *LastTy = 0;
766  for (unsigned i = FirstVal; i != LastVal; ++i) {
767    const Value *V = Vals[i].first;
768    // If we need to switch types, do so now.
769    if (V->getType() != LastTy) {
770      LastTy = V->getType();
771      Record.push_back(VE.getTypeID(LastTy));
772      Stream.EmitRecord(bitc::CST_CODE_SETTYPE, Record,
773                        CONSTANTS_SETTYPE_ABBREV);
774      Record.clear();
775    }
776
777    if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
778      Record.push_back(unsigned(IA->hasSideEffects()) |
779                       unsigned(IA->isAlignStack()) << 1);
780
781      // Add the asm string.
782      const std::string &AsmStr = IA->getAsmString();
783      Record.push_back(AsmStr.size());
784      for (unsigned i = 0, e = AsmStr.size(); i != e; ++i)
785        Record.push_back(AsmStr[i]);
786
787      // Add the constraint string.
788      const std::string &ConstraintStr = IA->getConstraintString();
789      Record.push_back(ConstraintStr.size());
790      for (unsigned i = 0, e = ConstraintStr.size(); i != e; ++i)
791        Record.push_back(ConstraintStr[i]);
792      Stream.EmitRecord(bitc::CST_CODE_INLINEASM, Record);
793      Record.clear();
794      continue;
795    }
796    const Constant *C = cast<Constant>(V);
797    unsigned Code = -1U;
798    unsigned AbbrevToUse = 0;
799    if (C->isNullValue()) {
800      Code = bitc::CST_CODE_NULL;
801    } else if (isa<UndefValue>(C)) {
802      Code = bitc::CST_CODE_UNDEF;
803    } else if (const ConstantInt *IV = dyn_cast<ConstantInt>(C)) {
804      if (IV->getBitWidth() <= 64) {
805        uint64_t V = IV->getSExtValue();
806        if ((int64_t)V >= 0)
807          Record.push_back(V << 1);
808        else
809          Record.push_back((-V << 1) | 1);
810        Code = bitc::CST_CODE_INTEGER;
811        AbbrevToUse = CONSTANTS_INTEGER_ABBREV;
812      } else {                             // Wide integers, > 64 bits in size.
813        // We have an arbitrary precision integer value to write whose
814        // bit width is > 64. However, in canonical unsigned integer
815        // format it is likely that the high bits are going to be zero.
816        // So, we only write the number of active words.
817        unsigned NWords = IV->getValue().getActiveWords();
818        const uint64_t *RawWords = IV->getValue().getRawData();
819        for (unsigned i = 0; i != NWords; ++i) {
820          int64_t V = RawWords[i];
821          if (V >= 0)
822            Record.push_back(V << 1);
823          else
824            Record.push_back((-V << 1) | 1);
825        }
826        Code = bitc::CST_CODE_WIDE_INTEGER;
827      }
828    } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(C)) {
829      Code = bitc::CST_CODE_FLOAT;
830      Type *Ty = CFP->getType();
831      if (Ty->isHalfTy() || Ty->isFloatTy() || Ty->isDoubleTy()) {
832        Record.push_back(CFP->getValueAPF().bitcastToAPInt().getZExtValue());
833      } else if (Ty->isX86_FP80Ty()) {
834        // api needed to prevent premature destruction
835        // bits are not in the same order as a normal i80 APInt, compensate.
836        APInt api = CFP->getValueAPF().bitcastToAPInt();
837        const uint64_t *p = api.getRawData();
838        Record.push_back((p[1] << 48) | (p[0] >> 16));
839        Record.push_back(p[0] & 0xffffLL);
840      } else if (Ty->isFP128Ty() || Ty->isPPC_FP128Ty()) {
841        APInt api = CFP->getValueAPF().bitcastToAPInt();
842        const uint64_t *p = api.getRawData();
843        Record.push_back(p[0]);
844        Record.push_back(p[1]);
845      } else {
846        assert (0 && "Unknown FP type!");
847      }
848    } else if (isa<ConstantArray>(C) && cast<ConstantArray>(C)->isString()) {
849      const ConstantArray *CA = cast<ConstantArray>(C);
850      // Emit constant strings specially.
851      unsigned NumOps = CA->getNumOperands();
852      // If this is a null-terminated string, use the denser CSTRING encoding.
853      if (CA->getOperand(NumOps-1)->isNullValue()) {
854        Code = bitc::CST_CODE_CSTRING;
855        --NumOps;  // Don't encode the null, which isn't allowed by char6.
856      } else {
857        Code = bitc::CST_CODE_STRING;
858        AbbrevToUse = String8Abbrev;
859      }
860      bool isCStr7 = Code == bitc::CST_CODE_CSTRING;
861      bool isCStrChar6 = Code == bitc::CST_CODE_CSTRING;
862      for (unsigned i = 0; i != NumOps; ++i) {
863        unsigned char V = cast<ConstantInt>(CA->getOperand(i))->getZExtValue();
864        Record.push_back(V);
865        isCStr7 &= (V & 128) == 0;
866        if (isCStrChar6)
867          isCStrChar6 = BitCodeAbbrevOp::isChar6(V);
868      }
869
870      if (isCStrChar6)
871        AbbrevToUse = CString6Abbrev;
872      else if (isCStr7)
873        AbbrevToUse = CString7Abbrev;
874    } else if (isa<ConstantArray>(C) || isa<ConstantStruct>(V) ||
875               isa<ConstantVector>(V)) {
876      Code = bitc::CST_CODE_AGGREGATE;
877      for (unsigned i = 0, e = C->getNumOperands(); i != e; ++i)
878        Record.push_back(VE.getValueID(C->getOperand(i)));
879      AbbrevToUse = AggregateAbbrev;
880    } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
881      switch (CE->getOpcode()) {
882      default:
883        if (Instruction::isCast(CE->getOpcode())) {
884          Code = bitc::CST_CODE_CE_CAST;
885          Record.push_back(GetEncodedCastOpcode(CE->getOpcode()));
886          Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
887          Record.push_back(VE.getValueID(C->getOperand(0)));
888          AbbrevToUse = CONSTANTS_CE_CAST_Abbrev;
889        } else {
890          assert(CE->getNumOperands() == 2 && "Unknown constant expr!");
891          Code = bitc::CST_CODE_CE_BINOP;
892          Record.push_back(GetEncodedBinaryOpcode(CE->getOpcode()));
893          Record.push_back(VE.getValueID(C->getOperand(0)));
894          Record.push_back(VE.getValueID(C->getOperand(1)));
895          uint64_t Flags = GetOptimizationFlags(CE);
896          if (Flags != 0)
897            Record.push_back(Flags);
898        }
899        break;
900      case Instruction::GetElementPtr:
901        Code = bitc::CST_CODE_CE_GEP;
902        if (cast<GEPOperator>(C)->isInBounds())
903          Code = bitc::CST_CODE_CE_INBOUNDS_GEP;
904        for (unsigned i = 0, e = CE->getNumOperands(); i != e; ++i) {
905          Record.push_back(VE.getTypeID(C->getOperand(i)->getType()));
906          Record.push_back(VE.getValueID(C->getOperand(i)));
907        }
908        break;
909      case Instruction::Select:
910        Code = bitc::CST_CODE_CE_SELECT;
911        Record.push_back(VE.getValueID(C->getOperand(0)));
912        Record.push_back(VE.getValueID(C->getOperand(1)));
913        Record.push_back(VE.getValueID(C->getOperand(2)));
914        break;
915      case Instruction::ExtractElement:
916        Code = bitc::CST_CODE_CE_EXTRACTELT;
917        Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
918        Record.push_back(VE.getValueID(C->getOperand(0)));
919        Record.push_back(VE.getValueID(C->getOperand(1)));
920        break;
921      case Instruction::InsertElement:
922        Code = bitc::CST_CODE_CE_INSERTELT;
923        Record.push_back(VE.getValueID(C->getOperand(0)));
924        Record.push_back(VE.getValueID(C->getOperand(1)));
925        Record.push_back(VE.getValueID(C->getOperand(2)));
926        break;
927      case Instruction::ShuffleVector:
928        // If the return type and argument types are the same, this is a
929        // standard shufflevector instruction.  If the types are different,
930        // then the shuffle is widening or truncating the input vectors, and
931        // the argument type must also be encoded.
932        if (C->getType() == C->getOperand(0)->getType()) {
933          Code = bitc::CST_CODE_CE_SHUFFLEVEC;
934        } else {
935          Code = bitc::CST_CODE_CE_SHUFVEC_EX;
936          Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
937        }
938        Record.push_back(VE.getValueID(C->getOperand(0)));
939        Record.push_back(VE.getValueID(C->getOperand(1)));
940        Record.push_back(VE.getValueID(C->getOperand(2)));
941        break;
942      case Instruction::ICmp:
943      case Instruction::FCmp:
944        Code = bitc::CST_CODE_CE_CMP;
945        Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
946        Record.push_back(VE.getValueID(C->getOperand(0)));
947        Record.push_back(VE.getValueID(C->getOperand(1)));
948        Record.push_back(CE->getPredicate());
949        break;
950      }
951    } else if (const BlockAddress *BA = dyn_cast<BlockAddress>(C)) {
952      Code = bitc::CST_CODE_BLOCKADDRESS;
953      Record.push_back(VE.getTypeID(BA->getFunction()->getType()));
954      Record.push_back(VE.getValueID(BA->getFunction()));
955      Record.push_back(VE.getGlobalBasicBlockID(BA->getBasicBlock()));
956    } else {
957#ifndef NDEBUG
958      C->dump();
959#endif
960      llvm_unreachable("Unknown constant!");
961    }
962    Stream.EmitRecord(Code, Record, AbbrevToUse);
963    Record.clear();
964  }
965
966  Stream.ExitBlock();
967}
968
969static void WriteModuleConstants(const ValueEnumerator &VE,
970                                 BitstreamWriter &Stream) {
971  const ValueEnumerator::ValueList &Vals = VE.getValues();
972
973  // Find the first constant to emit, which is the first non-globalvalue value.
974  // We know globalvalues have been emitted by WriteModuleInfo.
975  for (unsigned i = 0, e = Vals.size(); i != e; ++i) {
976    if (!isa<GlobalValue>(Vals[i].first)) {
977      WriteConstants(i, Vals.size(), VE, Stream, true);
978      return;
979    }
980  }
981}
982
983/// PushValueAndType - The file has to encode both the value and type id for
984/// many values, because we need to know what type to create for forward
985/// references.  However, most operands are not forward references, so this type
986/// field is not needed.
987///
988/// This function adds V's value ID to Vals.  If the value ID is higher than the
989/// instruction ID, then it is a forward reference, and it also includes the
990/// type ID.
991static bool PushValueAndType(const Value *V, unsigned InstID,
992                             SmallVector<unsigned, 64> &Vals,
993                             ValueEnumerator &VE) {
994  unsigned ValID = VE.getValueID(V);
995  Vals.push_back(ValID);
996  if (ValID >= InstID) {
997    Vals.push_back(VE.getTypeID(V->getType()));
998    return true;
999  }
1000  return false;
1001}
1002
1003/// WriteInstruction - Emit an instruction to the specified stream.
1004static void WriteInstruction(const Instruction &I, unsigned InstID,
1005                             ValueEnumerator &VE, BitstreamWriter &Stream,
1006                             SmallVector<unsigned, 64> &Vals) {
1007  unsigned Code = 0;
1008  unsigned AbbrevToUse = 0;
1009  VE.setInstructionID(&I);
1010  switch (I.getOpcode()) {
1011  default:
1012    if (Instruction::isCast(I.getOpcode())) {
1013      Code = bitc::FUNC_CODE_INST_CAST;
1014      if (!PushValueAndType(I.getOperand(0), InstID, Vals, VE))
1015        AbbrevToUse = FUNCTION_INST_CAST_ABBREV;
1016      Vals.push_back(VE.getTypeID(I.getType()));
1017      Vals.push_back(GetEncodedCastOpcode(I.getOpcode()));
1018    } else {
1019      assert(isa<BinaryOperator>(I) && "Unknown instruction!");
1020      Code = bitc::FUNC_CODE_INST_BINOP;
1021      if (!PushValueAndType(I.getOperand(0), InstID, Vals, VE))
1022        AbbrevToUse = FUNCTION_INST_BINOP_ABBREV;
1023      Vals.push_back(VE.getValueID(I.getOperand(1)));
1024      Vals.push_back(GetEncodedBinaryOpcode(I.getOpcode()));
1025      uint64_t Flags = GetOptimizationFlags(&I);
1026      if (Flags != 0) {
1027        if (AbbrevToUse == FUNCTION_INST_BINOP_ABBREV)
1028          AbbrevToUse = FUNCTION_INST_BINOP_FLAGS_ABBREV;
1029        Vals.push_back(Flags);
1030      }
1031    }
1032    break;
1033
1034  case Instruction::GetElementPtr:
1035    Code = bitc::FUNC_CODE_INST_GEP;
1036    if (cast<GEPOperator>(&I)->isInBounds())
1037      Code = bitc::FUNC_CODE_INST_INBOUNDS_GEP;
1038    for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
1039      PushValueAndType(I.getOperand(i), InstID, Vals, VE);
1040    break;
1041  case Instruction::ExtractValue: {
1042    Code = bitc::FUNC_CODE_INST_EXTRACTVAL;
1043    PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1044    const ExtractValueInst *EVI = cast<ExtractValueInst>(&I);
1045    for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
1046      Vals.push_back(*i);
1047    break;
1048  }
1049  case Instruction::InsertValue: {
1050    Code = bitc::FUNC_CODE_INST_INSERTVAL;
1051    PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1052    PushValueAndType(I.getOperand(1), InstID, Vals, VE);
1053    const InsertValueInst *IVI = cast<InsertValueInst>(&I);
1054    for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
1055      Vals.push_back(*i);
1056    break;
1057  }
1058  case Instruction::Select:
1059    Code = bitc::FUNC_CODE_INST_VSELECT;
1060    PushValueAndType(I.getOperand(1), InstID, Vals, VE);
1061    Vals.push_back(VE.getValueID(I.getOperand(2)));
1062    PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1063    break;
1064  case Instruction::ExtractElement:
1065    Code = bitc::FUNC_CODE_INST_EXTRACTELT;
1066    PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1067    Vals.push_back(VE.getValueID(I.getOperand(1)));
1068    break;
1069  case Instruction::InsertElement:
1070    Code = bitc::FUNC_CODE_INST_INSERTELT;
1071    PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1072    Vals.push_back(VE.getValueID(I.getOperand(1)));
1073    Vals.push_back(VE.getValueID(I.getOperand(2)));
1074    break;
1075  case Instruction::ShuffleVector:
1076    Code = bitc::FUNC_CODE_INST_SHUFFLEVEC;
1077    PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1078    Vals.push_back(VE.getValueID(I.getOperand(1)));
1079    Vals.push_back(VE.getValueID(I.getOperand(2)));
1080    break;
1081  case Instruction::ICmp:
1082  case Instruction::FCmp:
1083    // compare returning Int1Ty or vector of Int1Ty
1084    Code = bitc::FUNC_CODE_INST_CMP2;
1085    PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1086    Vals.push_back(VE.getValueID(I.getOperand(1)));
1087    Vals.push_back(cast<CmpInst>(I).getPredicate());
1088    break;
1089
1090  case Instruction::Ret:
1091    {
1092      Code = bitc::FUNC_CODE_INST_RET;
1093      unsigned NumOperands = I.getNumOperands();
1094      if (NumOperands == 0)
1095        AbbrevToUse = FUNCTION_INST_RET_VOID_ABBREV;
1096      else if (NumOperands == 1) {
1097        if (!PushValueAndType(I.getOperand(0), InstID, Vals, VE))
1098          AbbrevToUse = FUNCTION_INST_RET_VAL_ABBREV;
1099      } else {
1100        for (unsigned i = 0, e = NumOperands; i != e; ++i)
1101          PushValueAndType(I.getOperand(i), InstID, Vals, VE);
1102      }
1103    }
1104    break;
1105  case Instruction::Br:
1106    {
1107      Code = bitc::FUNC_CODE_INST_BR;
1108      BranchInst &II = cast<BranchInst>(I);
1109      Vals.push_back(VE.getValueID(II.getSuccessor(0)));
1110      if (II.isConditional()) {
1111        Vals.push_back(VE.getValueID(II.getSuccessor(1)));
1112        Vals.push_back(VE.getValueID(II.getCondition()));
1113      }
1114    }
1115    break;
1116  case Instruction::Switch:
1117    Code = bitc::FUNC_CODE_INST_SWITCH;
1118    Vals.push_back(VE.getTypeID(I.getOperand(0)->getType()));
1119    for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
1120      Vals.push_back(VE.getValueID(I.getOperand(i)));
1121    break;
1122  case Instruction::IndirectBr:
1123    Code = bitc::FUNC_CODE_INST_INDIRECTBR;
1124    Vals.push_back(VE.getTypeID(I.getOperand(0)->getType()));
1125    for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
1126      Vals.push_back(VE.getValueID(I.getOperand(i)));
1127    break;
1128
1129  case Instruction::Invoke: {
1130    const InvokeInst *II = cast<InvokeInst>(&I);
1131    const Value *Callee(II->getCalledValue());
1132    PointerType *PTy = cast<PointerType>(Callee->getType());
1133    FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1134    Code = bitc::FUNC_CODE_INST_INVOKE;
1135
1136    Vals.push_back(VE.getAttributeID(II->getAttributes()));
1137    Vals.push_back(II->getCallingConv());
1138    Vals.push_back(VE.getValueID(II->getNormalDest()));
1139    Vals.push_back(VE.getValueID(II->getUnwindDest()));
1140    PushValueAndType(Callee, InstID, Vals, VE);
1141
1142    // Emit value #'s for the fixed parameters.
1143    for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
1144      Vals.push_back(VE.getValueID(I.getOperand(i)));  // fixed param.
1145
1146    // Emit type/value pairs for varargs params.
1147    if (FTy->isVarArg()) {
1148      for (unsigned i = FTy->getNumParams(), e = I.getNumOperands()-3;
1149           i != e; ++i)
1150        PushValueAndType(I.getOperand(i), InstID, Vals, VE); // vararg
1151    }
1152    break;
1153  }
1154  case Instruction::Resume:
1155    Code = bitc::FUNC_CODE_INST_RESUME;
1156    PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1157    break;
1158  case Instruction::Unwind:
1159    Code = bitc::FUNC_CODE_INST_UNWIND;
1160    break;
1161  case Instruction::Unreachable:
1162    Code = bitc::FUNC_CODE_INST_UNREACHABLE;
1163    AbbrevToUse = FUNCTION_INST_UNREACHABLE_ABBREV;
1164    break;
1165
1166  case Instruction::PHI: {
1167    const PHINode &PN = cast<PHINode>(I);
1168    Code = bitc::FUNC_CODE_INST_PHI;
1169    Vals.push_back(VE.getTypeID(PN.getType()));
1170    for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
1171      Vals.push_back(VE.getValueID(PN.getIncomingValue(i)));
1172      Vals.push_back(VE.getValueID(PN.getIncomingBlock(i)));
1173    }
1174    break;
1175  }
1176
1177  case Instruction::LandingPad: {
1178    const LandingPadInst &LP = cast<LandingPadInst>(I);
1179    Code = bitc::FUNC_CODE_INST_LANDINGPAD;
1180    Vals.push_back(VE.getTypeID(LP.getType()));
1181    PushValueAndType(LP.getPersonalityFn(), InstID, Vals, VE);
1182    Vals.push_back(LP.isCleanup());
1183    Vals.push_back(LP.getNumClauses());
1184    for (unsigned I = 0, E = LP.getNumClauses(); I != E; ++I) {
1185      if (LP.isCatch(I))
1186        Vals.push_back(LandingPadInst::Catch);
1187      else
1188        Vals.push_back(LandingPadInst::Filter);
1189      PushValueAndType(LP.getClause(I), InstID, Vals, VE);
1190    }
1191    break;
1192  }
1193
1194  case Instruction::Alloca:
1195    Code = bitc::FUNC_CODE_INST_ALLOCA;
1196    Vals.push_back(VE.getTypeID(I.getType()));
1197    Vals.push_back(VE.getTypeID(I.getOperand(0)->getType()));
1198    Vals.push_back(VE.getValueID(I.getOperand(0))); // size.
1199    Vals.push_back(Log2_32(cast<AllocaInst>(I).getAlignment())+1);
1200    break;
1201
1202  case Instruction::Load:
1203    if (cast<LoadInst>(I).isAtomic()) {
1204      Code = bitc::FUNC_CODE_INST_LOADATOMIC;
1205      PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1206    } else {
1207      Code = bitc::FUNC_CODE_INST_LOAD;
1208      if (!PushValueAndType(I.getOperand(0), InstID, Vals, VE))  // ptr
1209        AbbrevToUse = FUNCTION_INST_LOAD_ABBREV;
1210    }
1211    Vals.push_back(Log2_32(cast<LoadInst>(I).getAlignment())+1);
1212    Vals.push_back(cast<LoadInst>(I).isVolatile());
1213    if (cast<LoadInst>(I).isAtomic()) {
1214      Vals.push_back(GetEncodedOrdering(cast<LoadInst>(I).getOrdering()));
1215      Vals.push_back(GetEncodedSynchScope(cast<LoadInst>(I).getSynchScope()));
1216    }
1217    break;
1218  case Instruction::Store:
1219    if (cast<StoreInst>(I).isAtomic())
1220      Code = bitc::FUNC_CODE_INST_STOREATOMIC;
1221    else
1222      Code = bitc::FUNC_CODE_INST_STORE;
1223    PushValueAndType(I.getOperand(1), InstID, Vals, VE);  // ptrty + ptr
1224    Vals.push_back(VE.getValueID(I.getOperand(0)));       // val.
1225    Vals.push_back(Log2_32(cast<StoreInst>(I).getAlignment())+1);
1226    Vals.push_back(cast<StoreInst>(I).isVolatile());
1227    if (cast<StoreInst>(I).isAtomic()) {
1228      Vals.push_back(GetEncodedOrdering(cast<StoreInst>(I).getOrdering()));
1229      Vals.push_back(GetEncodedSynchScope(cast<StoreInst>(I).getSynchScope()));
1230    }
1231    break;
1232  case Instruction::AtomicCmpXchg:
1233    Code = bitc::FUNC_CODE_INST_CMPXCHG;
1234    PushValueAndType(I.getOperand(0), InstID, Vals, VE);  // ptrty + ptr
1235    Vals.push_back(VE.getValueID(I.getOperand(1)));       // cmp.
1236    Vals.push_back(VE.getValueID(I.getOperand(2)));       // newval.
1237    Vals.push_back(cast<AtomicCmpXchgInst>(I).isVolatile());
1238    Vals.push_back(GetEncodedOrdering(
1239                     cast<AtomicCmpXchgInst>(I).getOrdering()));
1240    Vals.push_back(GetEncodedSynchScope(
1241                     cast<AtomicCmpXchgInst>(I).getSynchScope()));
1242    break;
1243  case Instruction::AtomicRMW:
1244    Code = bitc::FUNC_CODE_INST_ATOMICRMW;
1245    PushValueAndType(I.getOperand(0), InstID, Vals, VE);  // ptrty + ptr
1246    Vals.push_back(VE.getValueID(I.getOperand(1)));       // val.
1247    Vals.push_back(GetEncodedRMWOperation(
1248                     cast<AtomicRMWInst>(I).getOperation()));
1249    Vals.push_back(cast<AtomicRMWInst>(I).isVolatile());
1250    Vals.push_back(GetEncodedOrdering(cast<AtomicRMWInst>(I).getOrdering()));
1251    Vals.push_back(GetEncodedSynchScope(
1252                     cast<AtomicRMWInst>(I).getSynchScope()));
1253    break;
1254  case Instruction::Fence:
1255    Code = bitc::FUNC_CODE_INST_FENCE;
1256    Vals.push_back(GetEncodedOrdering(cast<FenceInst>(I).getOrdering()));
1257    Vals.push_back(GetEncodedSynchScope(cast<FenceInst>(I).getSynchScope()));
1258    break;
1259  case Instruction::Call: {
1260    const CallInst &CI = cast<CallInst>(I);
1261    PointerType *PTy = cast<PointerType>(CI.getCalledValue()->getType());
1262    FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1263
1264    Code = bitc::FUNC_CODE_INST_CALL;
1265
1266    Vals.push_back(VE.getAttributeID(CI.getAttributes()));
1267    Vals.push_back((CI.getCallingConv() << 1) | unsigned(CI.isTailCall()));
1268    PushValueAndType(CI.getCalledValue(), InstID, Vals, VE);  // Callee
1269
1270    // Emit value #'s for the fixed parameters.
1271    for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
1272      Vals.push_back(VE.getValueID(CI.getArgOperand(i)));  // fixed param.
1273
1274    // Emit type/value pairs for varargs params.
1275    if (FTy->isVarArg()) {
1276      for (unsigned i = FTy->getNumParams(), e = CI.getNumArgOperands();
1277           i != e; ++i)
1278        PushValueAndType(CI.getArgOperand(i), InstID, Vals, VE);  // varargs
1279    }
1280    break;
1281  }
1282  case Instruction::VAArg:
1283    Code = bitc::FUNC_CODE_INST_VAARG;
1284    Vals.push_back(VE.getTypeID(I.getOperand(0)->getType()));   // valistty
1285    Vals.push_back(VE.getValueID(I.getOperand(0))); // valist.
1286    Vals.push_back(VE.getTypeID(I.getType())); // restype.
1287    break;
1288  }
1289
1290  Stream.EmitRecord(Code, Vals, AbbrevToUse);
1291  Vals.clear();
1292}
1293
1294// Emit names for globals/functions etc.
1295static void WriteValueSymbolTable(const ValueSymbolTable &VST,
1296                                  const ValueEnumerator &VE,
1297                                  BitstreamWriter &Stream) {
1298  if (VST.empty()) return;
1299  Stream.EnterSubblock(bitc::VALUE_SYMTAB_BLOCK_ID, 4);
1300
1301  // FIXME: Set up the abbrev, we know how many values there are!
1302  // FIXME: We know if the type names can use 7-bit ascii.
1303  SmallVector<unsigned, 64> NameVals;
1304
1305  for (ValueSymbolTable::const_iterator SI = VST.begin(), SE = VST.end();
1306       SI != SE; ++SI) {
1307
1308    const ValueName &Name = *SI;
1309
1310    // Figure out the encoding to use for the name.
1311    bool is7Bit = true;
1312    bool isChar6 = true;
1313    for (const char *C = Name.getKeyData(), *E = C+Name.getKeyLength();
1314         C != E; ++C) {
1315      if (isChar6)
1316        isChar6 = BitCodeAbbrevOp::isChar6(*C);
1317      if ((unsigned char)*C & 128) {
1318        is7Bit = false;
1319        break;  // don't bother scanning the rest.
1320      }
1321    }
1322
1323    unsigned AbbrevToUse = VST_ENTRY_8_ABBREV;
1324
1325    // VST_ENTRY:   [valueid, namechar x N]
1326    // VST_BBENTRY: [bbid, namechar x N]
1327    unsigned Code;
1328    if (isa<BasicBlock>(SI->getValue())) {
1329      Code = bitc::VST_CODE_BBENTRY;
1330      if (isChar6)
1331        AbbrevToUse = VST_BBENTRY_6_ABBREV;
1332    } else {
1333      Code = bitc::VST_CODE_ENTRY;
1334      if (isChar6)
1335        AbbrevToUse = VST_ENTRY_6_ABBREV;
1336      else if (is7Bit)
1337        AbbrevToUse = VST_ENTRY_7_ABBREV;
1338    }
1339
1340    NameVals.push_back(VE.getValueID(SI->getValue()));
1341    for (const char *P = Name.getKeyData(),
1342         *E = Name.getKeyData()+Name.getKeyLength(); P != E; ++P)
1343      NameVals.push_back((unsigned char)*P);
1344
1345    // Emit the finished record.
1346    Stream.EmitRecord(Code, NameVals, AbbrevToUse);
1347    NameVals.clear();
1348  }
1349  Stream.ExitBlock();
1350}
1351
1352/// WriteFunction - Emit a function body to the module stream.
1353static void WriteFunction(const Function &F, ValueEnumerator &VE,
1354                          BitstreamWriter &Stream) {
1355  Stream.EnterSubblock(bitc::FUNCTION_BLOCK_ID, 4);
1356  VE.incorporateFunction(F);
1357
1358  SmallVector<unsigned, 64> Vals;
1359
1360  // Emit the number of basic blocks, so the reader can create them ahead of
1361  // time.
1362  Vals.push_back(VE.getBasicBlocks().size());
1363  Stream.EmitRecord(bitc::FUNC_CODE_DECLAREBLOCKS, Vals);
1364  Vals.clear();
1365
1366  // If there are function-local constants, emit them now.
1367  unsigned CstStart, CstEnd;
1368  VE.getFunctionConstantRange(CstStart, CstEnd);
1369  WriteConstants(CstStart, CstEnd, VE, Stream, false);
1370
1371  // If there is function-local metadata, emit it now.
1372  WriteFunctionLocalMetadata(F, VE, Stream);
1373
1374  // Keep a running idea of what the instruction ID is.
1375  unsigned InstID = CstEnd;
1376
1377  bool NeedsMetadataAttachment = false;
1378
1379  DebugLoc LastDL;
1380
1381  // Finally, emit all the instructions, in order.
1382  for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
1383    for (BasicBlock::const_iterator I = BB->begin(), E = BB->end();
1384         I != E; ++I) {
1385      WriteInstruction(*I, InstID, VE, Stream, Vals);
1386
1387      if (!I->getType()->isVoidTy())
1388        ++InstID;
1389
1390      // If the instruction has metadata, write a metadata attachment later.
1391      NeedsMetadataAttachment |= I->hasMetadataOtherThanDebugLoc();
1392
1393      // If the instruction has a debug location, emit it.
1394      DebugLoc DL = I->getDebugLoc();
1395      if (DL.isUnknown()) {
1396        // nothing todo.
1397      } else if (DL == LastDL) {
1398        // Just repeat the same debug loc as last time.
1399        Stream.EmitRecord(bitc::FUNC_CODE_DEBUG_LOC_AGAIN, Vals);
1400      } else {
1401        MDNode *Scope, *IA;
1402        DL.getScopeAndInlinedAt(Scope, IA, I->getContext());
1403
1404        Vals.push_back(DL.getLine());
1405        Vals.push_back(DL.getCol());
1406        Vals.push_back(Scope ? VE.getValueID(Scope)+1 : 0);
1407        Vals.push_back(IA ? VE.getValueID(IA)+1 : 0);
1408        Stream.EmitRecord(bitc::FUNC_CODE_DEBUG_LOC, Vals);
1409        Vals.clear();
1410
1411        LastDL = DL;
1412      }
1413    }
1414
1415  // Emit names for all the instructions etc.
1416  WriteValueSymbolTable(F.getValueSymbolTable(), VE, Stream);
1417
1418  if (NeedsMetadataAttachment)
1419    WriteMetadataAttachment(F, VE, Stream);
1420  VE.purgeFunction();
1421  Stream.ExitBlock();
1422}
1423
1424// Emit blockinfo, which defines the standard abbreviations etc.
1425static void WriteBlockInfo(const ValueEnumerator &VE, BitstreamWriter &Stream) {
1426  // We only want to emit block info records for blocks that have multiple
1427  // instances: CONSTANTS_BLOCK, FUNCTION_BLOCK and VALUE_SYMTAB_BLOCK.  Other
1428  // blocks can defined their abbrevs inline.
1429  Stream.EnterBlockInfoBlock(2);
1430
1431  { // 8-bit fixed-width VST_ENTRY/VST_BBENTRY strings.
1432    BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1433    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3));
1434    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
1435    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1436    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
1437    if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
1438                                   Abbv) != VST_ENTRY_8_ABBREV)
1439      llvm_unreachable("Unexpected abbrev ordering!");
1440  }
1441
1442  { // 7-bit fixed width VST_ENTRY strings.
1443    BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1444    Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_ENTRY));
1445    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
1446    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1447    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7));
1448    if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
1449                                   Abbv) != VST_ENTRY_7_ABBREV)
1450      llvm_unreachable("Unexpected abbrev ordering!");
1451  }
1452  { // 6-bit char6 VST_ENTRY strings.
1453    BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1454    Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_ENTRY));
1455    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
1456    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1457    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
1458    if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
1459                                   Abbv) != VST_ENTRY_6_ABBREV)
1460      llvm_unreachable("Unexpected abbrev ordering!");
1461  }
1462  { // 6-bit char6 VST_BBENTRY strings.
1463    BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1464    Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_BBENTRY));
1465    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
1466    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1467    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
1468    if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
1469                                   Abbv) != VST_BBENTRY_6_ABBREV)
1470      llvm_unreachable("Unexpected abbrev ordering!");
1471  }
1472
1473
1474
1475  { // SETTYPE abbrev for CONSTANTS_BLOCK.
1476    BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1477    Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_SETTYPE));
1478    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
1479                              Log2_32_Ceil(VE.getTypes().size()+1)));
1480    if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
1481                                   Abbv) != CONSTANTS_SETTYPE_ABBREV)
1482      llvm_unreachable("Unexpected abbrev ordering!");
1483  }
1484
1485  { // INTEGER abbrev for CONSTANTS_BLOCK.
1486    BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1487    Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_INTEGER));
1488    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
1489    if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
1490                                   Abbv) != CONSTANTS_INTEGER_ABBREV)
1491      llvm_unreachable("Unexpected abbrev ordering!");
1492  }
1493
1494  { // CE_CAST abbrev for CONSTANTS_BLOCK.
1495    BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1496    Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_CE_CAST));
1497    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4));  // cast opc
1498    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,       // typeid
1499                              Log2_32_Ceil(VE.getTypes().size()+1)));
1500    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));    // value id
1501
1502    if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
1503                                   Abbv) != CONSTANTS_CE_CAST_Abbrev)
1504      llvm_unreachable("Unexpected abbrev ordering!");
1505  }
1506  { // NULL abbrev for CONSTANTS_BLOCK.
1507    BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1508    Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_NULL));
1509    if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
1510                                   Abbv) != CONSTANTS_NULL_Abbrev)
1511      llvm_unreachable("Unexpected abbrev ordering!");
1512  }
1513
1514  // FIXME: This should only use space for first class types!
1515
1516  { // INST_LOAD abbrev for FUNCTION_BLOCK.
1517    BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1518    Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_LOAD));
1519    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Ptr
1520    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // Align
1521    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // volatile
1522    if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
1523                                   Abbv) != FUNCTION_INST_LOAD_ABBREV)
1524      llvm_unreachable("Unexpected abbrev ordering!");
1525  }
1526  { // INST_BINOP abbrev for FUNCTION_BLOCK.
1527    BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1528    Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_BINOP));
1529    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LHS
1530    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // RHS
1531    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // opc
1532    if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
1533                                   Abbv) != FUNCTION_INST_BINOP_ABBREV)
1534      llvm_unreachable("Unexpected abbrev ordering!");
1535  }
1536  { // INST_BINOP_FLAGS abbrev for FUNCTION_BLOCK.
1537    BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1538    Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_BINOP));
1539    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LHS
1540    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // RHS
1541    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // opc
1542    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7)); // flags
1543    if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
1544                                   Abbv) != FUNCTION_INST_BINOP_FLAGS_ABBREV)
1545      llvm_unreachable("Unexpected abbrev ordering!");
1546  }
1547  { // INST_CAST abbrev for FUNCTION_BLOCK.
1548    BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1549    Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_CAST));
1550    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));    // OpVal
1551    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,       // dest ty
1552                              Log2_32_Ceil(VE.getTypes().size()+1)));
1553    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4));  // opc
1554    if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
1555                                   Abbv) != FUNCTION_INST_CAST_ABBREV)
1556      llvm_unreachable("Unexpected abbrev ordering!");
1557  }
1558
1559  { // INST_RET abbrev for FUNCTION_BLOCK.
1560    BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1561    Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_RET));
1562    if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
1563                                   Abbv) != FUNCTION_INST_RET_VOID_ABBREV)
1564      llvm_unreachable("Unexpected abbrev ordering!");
1565  }
1566  { // INST_RET abbrev for FUNCTION_BLOCK.
1567    BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1568    Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_RET));
1569    Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ValID
1570    if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
1571                                   Abbv) != FUNCTION_INST_RET_VAL_ABBREV)
1572      llvm_unreachable("Unexpected abbrev ordering!");
1573  }
1574  { // INST_UNREACHABLE abbrev for FUNCTION_BLOCK.
1575    BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1576    Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_UNREACHABLE));
1577    if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
1578                                   Abbv) != FUNCTION_INST_UNREACHABLE_ABBREV)
1579      llvm_unreachable("Unexpected abbrev ordering!");
1580  }
1581
1582  Stream.ExitBlock();
1583}
1584
1585// Sort the Users based on the order in which the reader parses the bitcode
1586// file.
1587static bool bitcodereader_order(const User *lhs, const User *rhs) {
1588  // TODO: Implement.
1589  return true;
1590}
1591
1592static void WriteUseList(const Value *V, const ValueEnumerator &VE,
1593                         BitstreamWriter &Stream) {
1594
1595  // One or zero uses can't get out of order.
1596  if (V->use_empty() || V->hasNUses(1))
1597    return;
1598
1599  // Make a copy of the in-memory use-list for sorting.
1600  unsigned UseListSize = std::distance(V->use_begin(), V->use_end());
1601  SmallVector<const User*, 8> UseList;
1602  UseList.reserve(UseListSize);
1603  for (Value::const_use_iterator I = V->use_begin(), E = V->use_end();
1604       I != E; ++I) {
1605    const User *U = *I;
1606    UseList.push_back(U);
1607  }
1608
1609  // Sort the copy based on the order read by the BitcodeReader.
1610  std::sort(UseList.begin(), UseList.end(), bitcodereader_order);
1611
1612  // TODO: Generate a diff between the BitcodeWriter in-memory use-list and the
1613  // sorted list (i.e., the expected BitcodeReader in-memory use-list).
1614
1615  // TODO: Emit the USELIST_CODE_ENTRYs.
1616}
1617
1618static void WriteFunctionUseList(const Function *F, ValueEnumerator &VE,
1619                                 BitstreamWriter &Stream) {
1620  VE.incorporateFunction(*F);
1621
1622  for (Function::const_arg_iterator AI = F->arg_begin(), AE = F->arg_end();
1623       AI != AE; ++AI)
1624    WriteUseList(AI, VE, Stream);
1625  for (Function::const_iterator BB = F->begin(), FE = F->end(); BB != FE;
1626       ++BB) {
1627    WriteUseList(BB, VE, Stream);
1628    for (BasicBlock::const_iterator II = BB->begin(), IE = BB->end(); II != IE;
1629         ++II) {
1630      WriteUseList(II, VE, Stream);
1631      for (User::const_op_iterator OI = II->op_begin(), E = II->op_end();
1632           OI != E; ++OI) {
1633        if ((isa<Constant>(*OI) && !isa<GlobalValue>(*OI)) ||
1634            isa<InlineAsm>(*OI))
1635          WriteUseList(*OI, VE, Stream);
1636      }
1637    }
1638  }
1639  VE.purgeFunction();
1640}
1641
1642// Emit use-lists.
1643static void WriteModuleUseLists(const Module *M, ValueEnumerator &VE,
1644                                BitstreamWriter &Stream) {
1645  Stream.EnterSubblock(bitc::USELIST_BLOCK_ID, 3);
1646
1647  // XXX: this modifies the module, but in a way that should never change the
1648  // behavior of any pass or codegen in LLVM. The problem is that GVs may
1649  // contain entries in the use_list that do not exist in the Module and are
1650  // not stored in the .bc file.
1651  for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
1652       I != E; ++I)
1653    I->removeDeadConstantUsers();
1654
1655  // Write the global variables.
1656  for (Module::const_global_iterator GI = M->global_begin(),
1657         GE = M->global_end(); GI != GE; ++GI) {
1658    WriteUseList(GI, VE, Stream);
1659
1660    // Write the global variable initializers.
1661    if (GI->hasInitializer())
1662      WriteUseList(GI->getInitializer(), VE, Stream);
1663  }
1664
1665  // Write the functions.
1666  for (Module::const_iterator FI = M->begin(), FE = M->end(); FI != FE; ++FI) {
1667    WriteUseList(FI, VE, Stream);
1668    if (!FI->isDeclaration())
1669      WriteFunctionUseList(FI, VE, Stream);
1670  }
1671
1672  // Write the aliases.
1673  for (Module::const_alias_iterator AI = M->alias_begin(), AE = M->alias_end();
1674       AI != AE; ++AI) {
1675    WriteUseList(AI, VE, Stream);
1676    WriteUseList(AI->getAliasee(), VE, Stream);
1677  }
1678
1679  Stream.ExitBlock();
1680}
1681
1682/// WriteModule - Emit the specified module to the bitstream.
1683static void WriteModule(const Module *M, BitstreamWriter &Stream) {
1684  Stream.EnterSubblock(bitc::MODULE_BLOCK_ID, 3);
1685
1686  // Emit the version number if it is non-zero.
1687  if (CurVersion) {
1688    SmallVector<unsigned, 1> Vals;
1689    Vals.push_back(CurVersion);
1690    Stream.EmitRecord(bitc::MODULE_CODE_VERSION, Vals);
1691  }
1692
1693  // Analyze the module, enumerating globals, functions, etc.
1694  ValueEnumerator VE(M);
1695
1696  // Emit blockinfo, which defines the standard abbreviations etc.
1697  WriteBlockInfo(VE, Stream);
1698
1699  // Emit information about parameter attributes.
1700  WriteAttributeTable(VE, Stream);
1701
1702  // Emit information describing all of the types in the module.
1703  WriteTypeTable(VE, Stream);
1704
1705  // Emit top-level description of module, including target triple, inline asm,
1706  // descriptors for global variables, and function prototype info.
1707  WriteModuleInfo(M, VE, Stream);
1708
1709  // Emit constants.
1710  WriteModuleConstants(VE, Stream);
1711
1712  // Emit metadata.
1713  WriteModuleMetadata(M, VE, Stream);
1714
1715  // Emit function bodies.
1716  for (Module::const_iterator F = M->begin(), E = M->end(); F != E; ++F)
1717    if (!F->isDeclaration())
1718      WriteFunction(*F, VE, Stream);
1719
1720  // Emit metadata.
1721  WriteModuleMetadataStore(M, Stream);
1722
1723  // Emit names for globals/functions etc.
1724  WriteValueSymbolTable(M->getValueSymbolTable(), VE, Stream);
1725
1726  // Emit use-lists.
1727  if (EnablePreserveUseListOrdering)
1728    WriteModuleUseLists(M, VE, Stream);
1729
1730  Stream.ExitBlock();
1731}
1732
1733/// EmitDarwinBCHeader - If generating a bc file on darwin, we have to emit a
1734/// header and trailer to make it compatible with the system archiver.  To do
1735/// this we emit the following header, and then emit a trailer that pads the
1736/// file out to be a multiple of 16 bytes.
1737///
1738/// struct bc_header {
1739///   uint32_t Magic;         // 0x0B17C0DE
1740///   uint32_t Version;       // Version, currently always 0.
1741///   uint32_t BitcodeOffset; // Offset to traditional bitcode file.
1742///   uint32_t BitcodeSize;   // Size of traditional bitcode file.
1743///   uint32_t CPUType;       // CPU specifier.
1744///   ... potentially more later ...
1745/// };
1746enum {
1747  DarwinBCSizeFieldOffset = 3*4, // Offset to bitcode_size.
1748  DarwinBCHeaderSize = 5*4
1749};
1750
1751static void EmitDarwinBCHeader(BitstreamWriter &Stream, const Triple &TT) {
1752  unsigned CPUType = ~0U;
1753
1754  // Match x86_64-*, i[3-9]86-*, powerpc-*, powerpc64-*, arm-*, thumb-*,
1755  // armv[0-9]-*, thumbv[0-9]-*, armv5te-*, or armv6t2-*. The CPUType is a magic
1756  // number from /usr/include/mach/machine.h.  It is ok to reproduce the
1757  // specific constants here because they are implicitly part of the Darwin ABI.
1758  enum {
1759    DARWIN_CPU_ARCH_ABI64      = 0x01000000,
1760    DARWIN_CPU_TYPE_X86        = 7,
1761    DARWIN_CPU_TYPE_ARM        = 12,
1762    DARWIN_CPU_TYPE_POWERPC    = 18
1763  };
1764
1765  Triple::ArchType Arch = TT.getArch();
1766  if (Arch == Triple::x86_64)
1767    CPUType = DARWIN_CPU_TYPE_X86 | DARWIN_CPU_ARCH_ABI64;
1768  else if (Arch == Triple::x86)
1769    CPUType = DARWIN_CPU_TYPE_X86;
1770  else if (Arch == Triple::ppc)
1771    CPUType = DARWIN_CPU_TYPE_POWERPC;
1772  else if (Arch == Triple::ppc64)
1773    CPUType = DARWIN_CPU_TYPE_POWERPC | DARWIN_CPU_ARCH_ABI64;
1774  else if (Arch == Triple::arm || Arch == Triple::thumb)
1775    CPUType = DARWIN_CPU_TYPE_ARM;
1776
1777  // Traditional Bitcode starts after header.
1778  unsigned BCOffset = DarwinBCHeaderSize;
1779
1780  Stream.Emit(0x0B17C0DE, 32);
1781  Stream.Emit(0         , 32);  // Version.
1782  Stream.Emit(BCOffset  , 32);
1783  Stream.Emit(0         , 32);  // Filled in later.
1784  Stream.Emit(CPUType   , 32);
1785}
1786
1787/// EmitDarwinBCTrailer - Emit the darwin epilog after the bitcode file and
1788/// finalize the header.
1789static void EmitDarwinBCTrailer(BitstreamWriter &Stream, unsigned BufferSize) {
1790  // Update the size field in the header.
1791  Stream.BackpatchWord(DarwinBCSizeFieldOffset, BufferSize-DarwinBCHeaderSize);
1792
1793  // If the file is not a multiple of 16 bytes, insert dummy padding.
1794  while (BufferSize & 15) {
1795    Stream.Emit(0, 8);
1796    ++BufferSize;
1797  }
1798}
1799
1800
1801/// WriteBitcodeToFile - Write the specified module to the specified output
1802/// stream.
1803void llvm::WriteBitcodeToFile(const Module *M, raw_ostream &Out) {
1804  std::vector<unsigned char> Buffer;
1805  BitstreamWriter Stream(Buffer);
1806
1807  Buffer.reserve(256*1024);
1808
1809  WriteBitcodeToStream( M, Stream );
1810
1811  // Write the generated bitstream to "Out".
1812  Out.write((char*)&Buffer.front(), Buffer.size());
1813}
1814
1815/// WriteBitcodeToStream - Write the specified module to the specified output
1816/// stream.
1817void llvm::WriteBitcodeToStream(const Module *M, BitstreamWriter &Stream) {
1818  // If this is darwin or another generic macho target, emit a file header and
1819  // trailer if needed.
1820  Triple TT(M->getTargetTriple());
1821  if (TT.isOSDarwin())
1822    EmitDarwinBCHeader(Stream, TT);
1823
1824  // Emit the file header.
1825  Stream.Emit((unsigned)'B', 8);
1826  Stream.Emit((unsigned)'C', 8);
1827  Stream.Emit(0x0, 4);
1828  Stream.Emit(0xC, 4);
1829  Stream.Emit(0xE, 4);
1830  Stream.Emit(0xD, 4);
1831
1832  // Emit the module.
1833  WriteModule(M, Stream);
1834
1835  if (TT.isOSDarwin())
1836    EmitDarwinBCTrailer(Stream, Stream.getBuffer().size());
1837}
1838