blob: 1797729b1cbdcbfd8eaeb1c85a1501c35fd81c3b [file] [log] [blame]
Chris Lattner87351e22007-04-29 05:31:57 +00001//===--- Bitcode/Writer/BitcodeWriter.cpp - Bitcode Writer ----------------===//
Chris Lattnerc1d10d62007-04-22 06:24:45 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file was developed by Chris Lattner and is distributed under
6// the University of Illinois Open Source License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// Bitcode writer implementation.
11//
12//===----------------------------------------------------------------------===//
13
14#include "llvm/Bitcode/ReaderWriter.h"
15#include "llvm/Bitcode/BitstreamWriter.h"
Chris Lattner362b4a12007-04-23 01:01:37 +000016#include "llvm/Bitcode/LLVMBitCodes.h"
Chris Lattnerc1d10d62007-04-22 06:24:45 +000017#include "ValueEnumerator.h"
Chris Lattner52523562007-04-24 00:16:04 +000018#include "llvm/Constants.h"
Chris Lattnerc1d10d62007-04-22 06:24:45 +000019#include "llvm/DerivedTypes.h"
Chris Lattnere6e364c2007-04-26 05:53:54 +000020#include "llvm/Instructions.h"
Chris Lattnerc1d10d62007-04-22 06:24:45 +000021#include "llvm/Module.h"
Chris Lattnere72bf9f2007-05-04 02:59:04 +000022#include "llvm/ParameterAttributes.h"
Chris Lattnerc1d10d62007-04-22 06:24:45 +000023#include "llvm/TypeSymbolTable.h"
Chris Lattner215e9cd2007-04-23 20:35:01 +000024#include "llvm/ValueSymbolTable.h"
Chris Lattnerc1d10d62007-04-22 06:24:45 +000025#include "llvm/Support/MathExtras.h"
26using namespace llvm;
27
Chris Lattner4d925982007-05-04 20:52:02 +000028/// These are manifest constants used by the bitcode writer. They do not need to
29/// be kept in sync with the reader, but need to be consistent within this file.
30enum {
31 CurVersion = 0,
32
33 // VALUE_SYMTAB_BLOCK abbrev id's.
34 VST_ENTRY_8_ABBREV = bitc::FIRST_APPLICATION_ABBREV,
Chris Lattnerfd1ad102007-05-04 20:58:35 +000035 VST_ENTRY_7_ABBREV,
Chris Lattnere760d6f2007-05-05 01:26:50 +000036 VST_ENTRY_6_ABBREV,
Chris Lattnerda5e5d22007-05-05 07:36:14 +000037 VST_BBENTRY_6_ABBREV,
38
39 // CONSTANTS_BLOCK abbrev id's.
40 CONSTANTS_SETTYPE_ABBREV = bitc::FIRST_APPLICATION_ABBREV,
41 CONSTANTS_INTEGER_ABBREV,
42 CONSTANTS_CE_CAST_Abbrev,
Chris Lattnerb80751d2007-05-05 07:44:49 +000043 CONSTANTS_NULL_Abbrev,
44
45 // FUNCTION_BLOCK abbrev id's.
46 FUNCTION_INST_LOAD_ABBREV = bitc::FIRST_APPLICATION_ABBREV
Chris Lattner4d925982007-05-04 20:52:02 +000047};
48
Chris Lattnerc1d10d62007-04-22 06:24:45 +000049
Chris Lattner1e16bcf72007-04-24 07:07:11 +000050static unsigned GetEncodedCastOpcode(unsigned Opcode) {
51 switch (Opcode) {
52 default: assert(0 && "Unknown cast instruction!");
53 case Instruction::Trunc : return bitc::CAST_TRUNC;
54 case Instruction::ZExt : return bitc::CAST_ZEXT;
55 case Instruction::SExt : return bitc::CAST_SEXT;
56 case Instruction::FPToUI : return bitc::CAST_FPTOUI;
57 case Instruction::FPToSI : return bitc::CAST_FPTOSI;
58 case Instruction::UIToFP : return bitc::CAST_UITOFP;
59 case Instruction::SIToFP : return bitc::CAST_SITOFP;
60 case Instruction::FPTrunc : return bitc::CAST_FPTRUNC;
61 case Instruction::FPExt : return bitc::CAST_FPEXT;
62 case Instruction::PtrToInt: return bitc::CAST_PTRTOINT;
63 case Instruction::IntToPtr: return bitc::CAST_INTTOPTR;
64 case Instruction::BitCast : return bitc::CAST_BITCAST;
65 }
66}
67
68static unsigned GetEncodedBinaryOpcode(unsigned Opcode) {
69 switch (Opcode) {
70 default: assert(0 && "Unknown binary instruction!");
71 case Instruction::Add: return bitc::BINOP_ADD;
72 case Instruction::Sub: return bitc::BINOP_SUB;
73 case Instruction::Mul: return bitc::BINOP_MUL;
74 case Instruction::UDiv: return bitc::BINOP_UDIV;
75 case Instruction::FDiv:
76 case Instruction::SDiv: return bitc::BINOP_SDIV;
77 case Instruction::URem: return bitc::BINOP_UREM;
78 case Instruction::FRem:
79 case Instruction::SRem: return bitc::BINOP_SREM;
80 case Instruction::Shl: return bitc::BINOP_SHL;
81 case Instruction::LShr: return bitc::BINOP_LSHR;
82 case Instruction::AShr: return bitc::BINOP_ASHR;
83 case Instruction::And: return bitc::BINOP_AND;
84 case Instruction::Or: return bitc::BINOP_OR;
85 case Instruction::Xor: return bitc::BINOP_XOR;
86 }
87}
88
89
90
Chris Lattnerc1d10d62007-04-22 06:24:45 +000091static void WriteStringRecord(unsigned Code, const std::string &Str,
92 unsigned AbbrevToUse, BitstreamWriter &Stream) {
93 SmallVector<unsigned, 64> Vals;
94
Chris Lattnere14cb882007-05-04 19:11:41 +000095 // Code: [strchar x N]
Chris Lattnerc1d10d62007-04-22 06:24:45 +000096 for (unsigned i = 0, e = Str.size(); i != e; ++i)
97 Vals.push_back(Str[i]);
98
99 // Emit the finished record.
100 Stream.EmitRecord(Code, Vals, AbbrevToUse);
101}
102
Chris Lattnere2f98ef2007-05-04 00:44:52 +0000103// Emit information about parameter attributes.
104static void WriteParamAttrTable(const ValueEnumerator &VE,
105 BitstreamWriter &Stream) {
106 const std::vector<const ParamAttrsList*> &Attrs = VE.getParamAttrs();
107 if (Attrs.empty()) return;
108
Chris Lattnere72bf9f2007-05-04 02:59:04 +0000109 Stream.EnterSubblock(bitc::PARAMATTR_BLOCK_ID, 3);
110
111 SmallVector<uint64_t, 64> Record;
112 for (unsigned i = 0, e = Attrs.size(); i != e; ++i) {
113 const ParamAttrsList *A = Attrs[i];
114 for (unsigned op = 0, e = A->size(); op != e; ++op) {
115 Record.push_back(A->getParamIndex(op));
Chris Lattnerfc5b6192007-05-04 03:14:09 +0000116 Record.push_back(A->getParamAttrsAtIndex(op));
Chris Lattnere72bf9f2007-05-04 02:59:04 +0000117 }
118
119 Stream.EmitRecord(bitc::PARAMATTR_CODE_ENTRY, Record);
120 Record.clear();
121 }
Chris Lattnere2f98ef2007-05-04 00:44:52 +0000122
Chris Lattnere72bf9f2007-05-04 02:59:04 +0000123 Stream.ExitBlock();
Chris Lattnere2f98ef2007-05-04 00:44:52 +0000124}
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000125
126/// WriteTypeTable - Write out the type table for a module.
127static void WriteTypeTable(const ValueEnumerator &VE, BitstreamWriter &Stream) {
128 const ValueEnumerator::TypeList &TypeList = VE.getTypes();
129
130 Stream.EnterSubblock(bitc::TYPE_BLOCK_ID, 4 /*count from # abbrevs */);
131 SmallVector<uint64_t, 64> TypeVals;
132
Chris Lattnerccee7062007-05-05 06:30:12 +0000133 // Abbrev for TYPE_CODE_POINTER.
134 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
135 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_POINTER));
136 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
137 Log2_32_Ceil(VE.getTypes().size()+1)));
138 unsigned PtrAbbrev = Stream.EmitAbbrev(Abbv);
139
140 // Abbrev for TYPE_CODE_FUNCTION.
141 Abbv = new BitCodeAbbrev();
142 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_FUNCTION));
143 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isvararg
144 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
145 Log2_32_Ceil(VE.getParamAttrs().size()+1)));
146 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
147 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
148 Log2_32_Ceil(VE.getTypes().size()+1)));
149 unsigned FunctionAbbrev = Stream.EmitAbbrev(Abbv);
150
151 // Abbrev for TYPE_CODE_STRUCT.
152 Abbv = new BitCodeAbbrev();
153 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_STRUCT));
154 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ispacked
155 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
156 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
157 Log2_32_Ceil(VE.getTypes().size()+1)));
158 unsigned StructAbbrev = Stream.EmitAbbrev(Abbv);
159
160 // Abbrev for TYPE_CODE_ARRAY.
161 Abbv = new BitCodeAbbrev();
162 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_ARRAY));
163 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // size
164 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
165 Log2_32_Ceil(VE.getTypes().size()+1)));
166 unsigned ArrayAbbrev = Stream.EmitAbbrev(Abbv);
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000167
168 // Emit an entry count so the reader can reserve space.
169 TypeVals.push_back(TypeList.size());
170 Stream.EmitRecord(bitc::TYPE_CODE_NUMENTRY, TypeVals);
171 TypeVals.clear();
172
173 // Loop over all of the types, emitting each in turn.
174 for (unsigned i = 0, e = TypeList.size(); i != e; ++i) {
175 const Type *T = TypeList[i].first;
176 int AbbrevToUse = 0;
177 unsigned Code = 0;
178
179 switch (T->getTypeID()) {
180 case Type::PackedStructTyID: // FIXME: Delete Type::PackedStructTyID.
181 default: assert(0 && "Unknown type!");
182 case Type::VoidTyID: Code = bitc::TYPE_CODE_VOID; break;
183 case Type::FloatTyID: Code = bitc::TYPE_CODE_FLOAT; break;
184 case Type::DoubleTyID: Code = bitc::TYPE_CODE_DOUBLE; break;
185 case Type::LabelTyID: Code = bitc::TYPE_CODE_LABEL; break;
186 case Type::OpaqueTyID: Code = bitc::TYPE_CODE_OPAQUE; break;
187 case Type::IntegerTyID:
188 // INTEGER: [width]
189 Code = bitc::TYPE_CODE_INTEGER;
190 TypeVals.push_back(cast<IntegerType>(T)->getBitWidth());
191 break;
192 case Type::PointerTyID:
193 // POINTER: [pointee type]
194 Code = bitc::TYPE_CODE_POINTER;
195 TypeVals.push_back(VE.getTypeID(cast<PointerType>(T)->getElementType()));
Chris Lattnerccee7062007-05-05 06:30:12 +0000196 AbbrevToUse = PtrAbbrev;
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000197 break;
198
199 case Type::FunctionTyID: {
200 const FunctionType *FT = cast<FunctionType>(T);
Chris Lattnerccee7062007-05-05 06:30:12 +0000201 // FUNCTION: [isvararg, attrid, retty, paramty x N]
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000202 Code = bitc::TYPE_CODE_FUNCTION;
203 TypeVals.push_back(FT->isVarArg());
Chris Lattner70f45662007-05-04 03:41:34 +0000204 TypeVals.push_back(VE.getParamAttrID(FT->getParamAttrs()));
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000205 TypeVals.push_back(VE.getTypeID(FT->getReturnType()));
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000206 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i)
207 TypeVals.push_back(VE.getTypeID(FT->getParamType(i)));
Chris Lattnerccee7062007-05-05 06:30:12 +0000208 AbbrevToUse = FunctionAbbrev;
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000209 break;
210 }
211 case Type::StructTyID: {
212 const StructType *ST = cast<StructType>(T);
Chris Lattnerccee7062007-05-05 06:30:12 +0000213 // STRUCT: [ispacked, eltty x N]
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000214 Code = bitc::TYPE_CODE_STRUCT;
215 TypeVals.push_back(ST->isPacked());
Chris Lattnere14cb882007-05-04 19:11:41 +0000216 // Output all of the element types.
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000217 for (StructType::element_iterator I = ST->element_begin(),
218 E = ST->element_end(); I != E; ++I)
219 TypeVals.push_back(VE.getTypeID(*I));
Chris Lattnerccee7062007-05-05 06:30:12 +0000220 AbbrevToUse = StructAbbrev;
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000221 break;
222 }
223 case Type::ArrayTyID: {
224 const ArrayType *AT = cast<ArrayType>(T);
225 // ARRAY: [numelts, eltty]
226 Code = bitc::TYPE_CODE_ARRAY;
227 TypeVals.push_back(AT->getNumElements());
228 TypeVals.push_back(VE.getTypeID(AT->getElementType()));
Chris Lattnerccee7062007-05-05 06:30:12 +0000229 AbbrevToUse = ArrayAbbrev;
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000230 break;
231 }
232 case Type::VectorTyID: {
233 const VectorType *VT = cast<VectorType>(T);
234 // VECTOR [numelts, eltty]
235 Code = bitc::TYPE_CODE_VECTOR;
236 TypeVals.push_back(VT->getNumElements());
237 TypeVals.push_back(VE.getTypeID(VT->getElementType()));
238 break;
239 }
240 }
241
242 // Emit the finished record.
243 Stream.EmitRecord(Code, TypeVals, AbbrevToUse);
244 TypeVals.clear();
245 }
246
247 Stream.ExitBlock();
248}
249
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000250static unsigned getEncodedLinkage(const GlobalValue *GV) {
251 switch (GV->getLinkage()) {
252 default: assert(0 && "Invalid linkage!");
253 case GlobalValue::ExternalLinkage: return 0;
254 case GlobalValue::WeakLinkage: return 1;
255 case GlobalValue::AppendingLinkage: return 2;
256 case GlobalValue::InternalLinkage: return 3;
257 case GlobalValue::LinkOnceLinkage: return 4;
258 case GlobalValue::DLLImportLinkage: return 5;
259 case GlobalValue::DLLExportLinkage: return 6;
260 case GlobalValue::ExternalWeakLinkage: return 7;
261 }
262}
263
264static unsigned getEncodedVisibility(const GlobalValue *GV) {
265 switch (GV->getVisibility()) {
266 default: assert(0 && "Invalid visibility!");
Anton Korobeynikov31fc4f92007-04-29 20:56:48 +0000267 case GlobalValue::DefaultVisibility: return 0;
268 case GlobalValue::HiddenVisibility: return 1;
269 case GlobalValue::ProtectedVisibility: return 2;
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000270 }
271}
272
273// Emit top-level description of module, including target triple, inline asm,
274// descriptors for global variables, and function prototype info.
275static void WriteModuleInfo(const Module *M, const ValueEnumerator &VE,
276 BitstreamWriter &Stream) {
277 // Emit the list of dependent libraries for the Module.
278 for (Module::lib_iterator I = M->lib_begin(), E = M->lib_end(); I != E; ++I)
279 WriteStringRecord(bitc::MODULE_CODE_DEPLIB, *I, 0/*TODO*/, Stream);
280
281 // Emit various pieces of data attached to a module.
282 if (!M->getTargetTriple().empty())
283 WriteStringRecord(bitc::MODULE_CODE_TRIPLE, M->getTargetTriple(),
284 0/*TODO*/, Stream);
285 if (!M->getDataLayout().empty())
286 WriteStringRecord(bitc::MODULE_CODE_DATALAYOUT, M->getDataLayout(),
287 0/*TODO*/, Stream);
288 if (!M->getModuleInlineAsm().empty())
289 WriteStringRecord(bitc::MODULE_CODE_ASM, M->getModuleInlineAsm(),
290 0/*TODO*/, Stream);
291
Chris Lattner4b00d922007-04-23 16:04:05 +0000292 // Emit information about sections, computing how many there are. Also
293 // compute the maximum alignment value.
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000294 std::map<std::string, unsigned> SectionMap;
Chris Lattner4b00d922007-04-23 16:04:05 +0000295 unsigned MaxAlignment = 0;
Chris Lattnerb5491372007-04-23 18:58:34 +0000296 unsigned MaxGlobalType = 0;
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000297 for (Module::const_global_iterator GV = M->global_begin(),E = M->global_end();
298 GV != E; ++GV) {
Chris Lattner4b00d922007-04-23 16:04:05 +0000299 MaxAlignment = std::max(MaxAlignment, GV->getAlignment());
Chris Lattnerb5491372007-04-23 18:58:34 +0000300 MaxGlobalType = std::max(MaxGlobalType, VE.getTypeID(GV->getType()));
Chris Lattner4b00d922007-04-23 16:04:05 +0000301
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000302 if (!GV->hasSection()) continue;
303 // Give section names unique ID's.
304 unsigned &Entry = SectionMap[GV->getSection()];
305 if (Entry != 0) continue;
306 WriteStringRecord(bitc::MODULE_CODE_SECTIONNAME, GV->getSection(),
307 0/*TODO*/, Stream);
308 Entry = SectionMap.size();
309 }
310 for (Module::const_iterator F = M->begin(), E = M->end(); F != E; ++F) {
Chris Lattner4b00d922007-04-23 16:04:05 +0000311 MaxAlignment = std::max(MaxAlignment, F->getAlignment());
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000312 if (!F->hasSection()) continue;
313 // Give section names unique ID's.
314 unsigned &Entry = SectionMap[F->getSection()];
315 if (Entry != 0) continue;
316 WriteStringRecord(bitc::MODULE_CODE_SECTIONNAME, F->getSection(),
317 0/*TODO*/, Stream);
318 Entry = SectionMap.size();
319 }
320
Chris Lattner4b00d922007-04-23 16:04:05 +0000321 // Emit abbrev for globals, now that we know # sections and max alignment.
322 unsigned SimpleGVarAbbrev = 0;
Chris Lattnerb5491372007-04-23 18:58:34 +0000323 if (!M->global_empty()) {
Chris Lattner4b00d922007-04-23 16:04:05 +0000324 // Add an abbrev for common globals with no visibility or thread localness.
325 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
326 Abbv->Add(BitCodeAbbrevOp(bitc::MODULE_CODE_GLOBALVAR));
Chris Lattner2eae59f2007-05-04 20:34:50 +0000327 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
Chris Lattnerb5491372007-04-23 18:58:34 +0000328 Log2_32_Ceil(MaxGlobalType+1)));
Chris Lattner2eae59f2007-05-04 20:34:50 +0000329 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Constant.
Chris Lattner4b00d922007-04-23 16:04:05 +0000330 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Initializer.
Chris Lattner2eae59f2007-05-04 20:34:50 +0000331 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); // Linkage.
332 if (MaxAlignment == 0) // Alignment.
Chris Lattner4b00d922007-04-23 16:04:05 +0000333 Abbv->Add(BitCodeAbbrevOp(0));
334 else {
335 unsigned MaxEncAlignment = Log2_32(MaxAlignment)+1;
Chris Lattner2eae59f2007-05-04 20:34:50 +0000336 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
Chris Lattnerb5491372007-04-23 18:58:34 +0000337 Log2_32_Ceil(MaxEncAlignment+1)));
Chris Lattner4b00d922007-04-23 16:04:05 +0000338 }
339 if (SectionMap.empty()) // Section.
340 Abbv->Add(BitCodeAbbrevOp(0));
341 else
Chris Lattner2eae59f2007-05-04 20:34:50 +0000342 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
Chris Lattner1e50c292007-04-24 03:29:47 +0000343 Log2_32_Ceil(SectionMap.size()+1)));
Chris Lattner4b00d922007-04-23 16:04:05 +0000344 // Don't bother emitting vis + thread local.
345 SimpleGVarAbbrev = Stream.EmitAbbrev(Abbv);
346 }
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000347
348 // Emit the global variable information.
349 SmallVector<unsigned, 64> Vals;
350 for (Module::const_global_iterator GV = M->global_begin(),E = M->global_end();
351 GV != E; ++GV) {
Chris Lattner4b00d922007-04-23 16:04:05 +0000352 unsigned AbbrevToUse = 0;
353
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000354 // GLOBALVAR: [type, isconst, initid,
355 // linkage, alignment, section, visibility, threadlocal]
356 Vals.push_back(VE.getTypeID(GV->getType()));
357 Vals.push_back(GV->isConstant());
358 Vals.push_back(GV->isDeclaration() ? 0 :
359 (VE.getValueID(GV->getInitializer()) + 1));
360 Vals.push_back(getEncodedLinkage(GV));
361 Vals.push_back(Log2_32(GV->getAlignment())+1);
362 Vals.push_back(GV->hasSection() ? SectionMap[GV->getSection()] : 0);
Chris Lattner4b00d922007-04-23 16:04:05 +0000363 if (GV->isThreadLocal() ||
364 GV->getVisibility() != GlobalValue::DefaultVisibility) {
365 Vals.push_back(getEncodedVisibility(GV));
366 Vals.push_back(GV->isThreadLocal());
367 } else {
368 AbbrevToUse = SimpleGVarAbbrev;
369 }
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000370
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000371 Stream.EmitRecord(bitc::MODULE_CODE_GLOBALVAR, Vals, AbbrevToUse);
372 Vals.clear();
373 }
374
375 // Emit the function proto information.
376 for (Module::const_iterator F = M->begin(), E = M->end(); F != E; ++F) {
377 // FUNCTION: [type, callingconv, isproto, linkage, alignment, section,
378 // visibility]
379 Vals.push_back(VE.getTypeID(F->getType()));
380 Vals.push_back(F->getCallingConv());
381 Vals.push_back(F->isDeclaration());
382 Vals.push_back(getEncodedLinkage(F));
383 Vals.push_back(Log2_32(F->getAlignment())+1);
384 Vals.push_back(F->hasSection() ? SectionMap[F->getSection()] : 0);
385 Vals.push_back(getEncodedVisibility(F));
386
387 unsigned AbbrevToUse = 0;
388 Stream.EmitRecord(bitc::MODULE_CODE_FUNCTION, Vals, AbbrevToUse);
389 Vals.clear();
390 }
Chris Lattner44c17072007-04-26 02:46:40 +0000391
392
393 // Emit the alias information.
394 for (Module::const_alias_iterator AI = M->alias_begin(), E = M->alias_end();
395 AI != E; ++AI) {
396 Vals.push_back(VE.getTypeID(AI->getType()));
397 Vals.push_back(VE.getValueID(AI->getAliasee()));
398 Vals.push_back(getEncodedLinkage(AI));
399 unsigned AbbrevToUse = 0;
400 Stream.EmitRecord(bitc::MODULE_CODE_ALIAS, Vals, AbbrevToUse);
401 Vals.clear();
402 }
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000403}
404
405
Chris Lattner52523562007-04-24 00:16:04 +0000406static void WriteConstants(unsigned FirstVal, unsigned LastVal,
407 const ValueEnumerator &VE,
Chris Lattnerda5e5d22007-05-05 07:36:14 +0000408 BitstreamWriter &Stream, bool isGlobal) {
Chris Lattner52523562007-04-24 00:16:04 +0000409 if (FirstVal == LastVal) return;
410
Chris Lattnerda5e5d22007-05-05 07:36:14 +0000411 Stream.EnterSubblock(bitc::CONSTANTS_BLOCK_ID, 4);
Chris Lattner215e9cd2007-04-23 20:35:01 +0000412
Chris Lattnerda5e5d22007-05-05 07:36:14 +0000413 unsigned AggregateAbbrev = 0;
414 unsigned GEPAbbrev = 0;
415 // If this is a constant pool for the module, emit module-specific abbrevs.
416 if (isGlobal) {
417 // Abbrev for CST_CODE_AGGREGATE.
418 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
419 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_AGGREGATE));
420 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
421 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, Log2_32_Ceil(LastVal+1)));
422 AggregateAbbrev = Stream.EmitAbbrev(Abbv);
423 }
424
Chris Lattnere6e364c2007-04-26 05:53:54 +0000425 // FIXME: Install and use abbrevs to reduce size. Install them globally so
426 // they don't need to be reemitted for each function body.
Chris Lattner52523562007-04-24 00:16:04 +0000427
428 SmallVector<uint64_t, 64> Record;
429
430 const ValueEnumerator::ValueList &Vals = VE.getValues();
431 const Type *LastTy = 0;
432 for (unsigned i = FirstVal; i != LastVal; ++i) {
433 const Value *V = Vals[i].first;
434 // If we need to switch types, do so now.
435 if (V->getType() != LastTy) {
436 LastTy = V->getType();
437 Record.push_back(VE.getTypeID(LastTy));
Chris Lattnerda5e5d22007-05-05 07:36:14 +0000438 Stream.EmitRecord(bitc::CST_CODE_SETTYPE, Record,
439 CONSTANTS_SETTYPE_ABBREV);
Chris Lattner52523562007-04-24 00:16:04 +0000440 Record.clear();
441 }
442
443 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
444 assert(0 && IA && "FIXME: Inline asm writing unimp!");
445 continue;
446 }
447 const Constant *C = cast<Constant>(V);
448 unsigned Code = -1U;
449 unsigned AbbrevToUse = 0;
450 if (C->isNullValue()) {
451 Code = bitc::CST_CODE_NULL;
452 } else if (isa<UndefValue>(C)) {
453 Code = bitc::CST_CODE_UNDEF;
454 } else if (const ConstantInt *IV = dyn_cast<ConstantInt>(C)) {
455 if (IV->getBitWidth() <= 64) {
456 int64_t V = IV->getSExtValue();
457 if (V >= 0)
458 Record.push_back(V << 1);
459 else
460 Record.push_back((-V << 1) | 1);
461 Code = bitc::CST_CODE_INTEGER;
Chris Lattnerda5e5d22007-05-05 07:36:14 +0000462 AbbrevToUse = CONSTANTS_INTEGER_ABBREV;
Chris Lattner52523562007-04-24 00:16:04 +0000463 } else { // Wide integers, > 64 bits in size.
464 // We have an arbitrary precision integer value to write whose
465 // bit width is > 64. However, in canonical unsigned integer
466 // format it is likely that the high bits are going to be zero.
467 // So, we only write the number of active words.
468 unsigned NWords = IV->getValue().getActiveWords();
469 const uint64_t *RawWords = IV->getValue().getRawData();
Chris Lattner52523562007-04-24 00:16:04 +0000470 for (unsigned i = 0; i != NWords; ++i) {
471 int64_t V = RawWords[i];
472 if (V >= 0)
473 Record.push_back(V << 1);
474 else
475 Record.push_back((-V << 1) | 1);
476 }
477 Code = bitc::CST_CODE_WIDE_INTEGER;
478 }
479 } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(C)) {
480 Code = bitc::CST_CODE_FLOAT;
481 if (CFP->getType() == Type::FloatTy) {
482 Record.push_back(FloatToBits((float)CFP->getValue()));
483 } else {
484 assert (CFP->getType() == Type::DoubleTy && "Unknown FP type!");
485 Record.push_back(DoubleToBits((double)CFP->getValue()));
486 }
487 } else if (isa<ConstantArray>(C) || isa<ConstantStruct>(V) ||
488 isa<ConstantVector>(V)) {
489 Code = bitc::CST_CODE_AGGREGATE;
Chris Lattner52523562007-04-24 00:16:04 +0000490 for (unsigned i = 0, e = C->getNumOperands(); i != e; ++i)
491 Record.push_back(VE.getValueID(C->getOperand(i)));
Chris Lattnerda5e5d22007-05-05 07:36:14 +0000492 AbbrevToUse = AggregateAbbrev;
Chris Lattner52523562007-04-24 00:16:04 +0000493 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
Chris Lattner1e16bcf72007-04-24 07:07:11 +0000494 switch (CE->getOpcode()) {
495 default:
496 if (Instruction::isCast(CE->getOpcode())) {
497 Code = bitc::CST_CODE_CE_CAST;
498 Record.push_back(GetEncodedCastOpcode(CE->getOpcode()));
499 Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
500 Record.push_back(VE.getValueID(C->getOperand(0)));
Chris Lattnerda5e5d22007-05-05 07:36:14 +0000501 AbbrevToUse = CONSTANTS_CE_CAST_Abbrev;
Chris Lattner1e16bcf72007-04-24 07:07:11 +0000502 } else {
503 assert(CE->getNumOperands() == 2 && "Unknown constant expr!");
504 Code = bitc::CST_CODE_CE_BINOP;
505 Record.push_back(GetEncodedBinaryOpcode(CE->getOpcode()));
506 Record.push_back(VE.getValueID(C->getOperand(0)));
507 Record.push_back(VE.getValueID(C->getOperand(1)));
508 }
509 break;
510 case Instruction::GetElementPtr:
511 Code = bitc::CST_CODE_CE_GEP;
Chris Lattner1e16bcf72007-04-24 07:07:11 +0000512 for (unsigned i = 0, e = CE->getNumOperands(); i != e; ++i) {
513 Record.push_back(VE.getTypeID(C->getOperand(i)->getType()));
514 Record.push_back(VE.getValueID(C->getOperand(i)));
515 }
Chris Lattnerda5e5d22007-05-05 07:36:14 +0000516 AbbrevToUse = GEPAbbrev;
Chris Lattner1e16bcf72007-04-24 07:07:11 +0000517 break;
518 case Instruction::Select:
519 Code = bitc::CST_CODE_CE_SELECT;
520 Record.push_back(VE.getValueID(C->getOperand(0)));
521 Record.push_back(VE.getValueID(C->getOperand(1)));
522 Record.push_back(VE.getValueID(C->getOperand(2)));
523 break;
524 case Instruction::ExtractElement:
525 Code = bitc::CST_CODE_CE_EXTRACTELT;
526 Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
527 Record.push_back(VE.getValueID(C->getOperand(0)));
528 Record.push_back(VE.getValueID(C->getOperand(1)));
529 break;
530 case Instruction::InsertElement:
531 Code = bitc::CST_CODE_CE_INSERTELT;
532 Record.push_back(VE.getValueID(C->getOperand(0)));
533 Record.push_back(VE.getValueID(C->getOperand(1)));
534 Record.push_back(VE.getValueID(C->getOperand(2)));
535 break;
536 case Instruction::ShuffleVector:
537 Code = bitc::CST_CODE_CE_SHUFFLEVEC;
538 Record.push_back(VE.getValueID(C->getOperand(0)));
539 Record.push_back(VE.getValueID(C->getOperand(1)));
540 Record.push_back(VE.getValueID(C->getOperand(2)));
541 break;
542 case Instruction::ICmp:
543 case Instruction::FCmp:
544 Code = bitc::CST_CODE_CE_CMP;
545 Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
546 Record.push_back(VE.getValueID(C->getOperand(0)));
547 Record.push_back(VE.getValueID(C->getOperand(1)));
548 Record.push_back(CE->getPredicate());
549 break;
550 }
Chris Lattner52523562007-04-24 00:16:04 +0000551 } else {
552 assert(0 && "Unknown constant!");
553 }
554 Stream.EmitRecord(Code, Record, AbbrevToUse);
555 Record.clear();
556 }
557
558 Stream.ExitBlock();
559}
560
561static void WriteModuleConstants(const ValueEnumerator &VE,
562 BitstreamWriter &Stream) {
563 const ValueEnumerator::ValueList &Vals = VE.getValues();
564
565 // Find the first constant to emit, which is the first non-globalvalue value.
566 // We know globalvalues have been emitted by WriteModuleInfo.
567 for (unsigned i = 0, e = Vals.size(); i != e; ++i) {
568 if (!isa<GlobalValue>(Vals[i].first)) {
Chris Lattnerda5e5d22007-05-05 07:36:14 +0000569 WriteConstants(i, Vals.size(), VE, Stream, true);
Chris Lattner52523562007-04-24 00:16:04 +0000570 return;
571 }
572 }
573}
Chris Lattner215e9cd2007-04-23 20:35:01 +0000574
Chris Lattnerdf1233d2007-05-06 00:00:00 +0000575/// PushValueAndType - The file has to encode both the value and type id for
576/// many values, because we need to know what type to create for forward
577/// references. However, most operands are not forward references, so this type
578/// field is not needed.
579///
580/// This function adds V's value ID to Vals. If the value ID is higher than the
581/// instruction ID, then it is a forward reference, and it also includes the
582/// type ID.
583static bool PushValueAndType(Value *V, unsigned InstID,
584 SmallVector<unsigned, 64> &Vals,
585 ValueEnumerator &VE) {
586 unsigned ValID = VE.getValueID(V);
587 Vals.push_back(ValID);
588 if (ValID >= InstID) {
589 Vals.push_back(VE.getTypeID(V->getType()));
590 return true;
591 }
592 return false;
593}
594
Chris Lattnere6e364c2007-04-26 05:53:54 +0000595/// WriteInstruction - Emit an instruction to the specified stream.
Chris Lattnerdf1233d2007-05-06 00:00:00 +0000596static void WriteInstruction(const Instruction &I, unsigned InstID,
597 ValueEnumerator &VE, BitstreamWriter &Stream,
Chris Lattnere6e364c2007-04-26 05:53:54 +0000598 SmallVector<unsigned, 64> &Vals) {
Chris Lattnere6e364c2007-04-26 05:53:54 +0000599 unsigned Code = 0;
600 unsigned AbbrevToUse = 0;
601 switch (I.getOpcode()) {
602 default:
603 if (Instruction::isCast(I.getOpcode())) {
Chris Lattner0a603252007-05-01 02:13:26 +0000604 Code = bitc::FUNC_CODE_INST_CAST;
Chris Lattnere6e364c2007-04-26 05:53:54 +0000605 Vals.push_back(GetEncodedCastOpcode(I.getOpcode()));
606 Vals.push_back(VE.getTypeID(I.getType()));
607 Vals.push_back(VE.getTypeID(I.getOperand(0)->getType()));
608 Vals.push_back(VE.getValueID(I.getOperand(0)));
609 } else {
610 assert(isa<BinaryOperator>(I) && "Unknown instruction!");
Chris Lattner9f35f912007-05-02 04:26:36 +0000611 Code = bitc::FUNC_CODE_INST_BINOP;
Chris Lattnere6e364c2007-04-26 05:53:54 +0000612 Vals.push_back(GetEncodedBinaryOpcode(I.getOpcode()));
613 Vals.push_back(VE.getTypeID(I.getType()));
614 Vals.push_back(VE.getValueID(I.getOperand(0)));
615 Vals.push_back(VE.getValueID(I.getOperand(1)));
616 }
617 break;
Chris Lattner0a603252007-05-01 02:13:26 +0000618
619 case Instruction::GetElementPtr:
620 Code = bitc::FUNC_CODE_INST_GEP;
Chris Lattnerdf1233d2007-05-06 00:00:00 +0000621 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
622 PushValueAndType(I.getOperand(i), InstID, Vals, VE);
Chris Lattner0a603252007-05-01 02:13:26 +0000623 break;
624 case Instruction::Select:
625 Code = bitc::FUNC_CODE_INST_SELECT;
626 Vals.push_back(VE.getTypeID(I.getType()));
627 Vals.push_back(VE.getValueID(I.getOperand(0)));
628 Vals.push_back(VE.getValueID(I.getOperand(1)));
629 Vals.push_back(VE.getValueID(I.getOperand(2)));
630 break;
631 case Instruction::ExtractElement:
632 Code = bitc::FUNC_CODE_INST_EXTRACTELT;
633 Vals.push_back(VE.getTypeID(I.getOperand(0)->getType()));
634 Vals.push_back(VE.getValueID(I.getOperand(0)));
635 Vals.push_back(VE.getValueID(I.getOperand(1)));
636 break;
637 case Instruction::InsertElement:
638 Code = bitc::FUNC_CODE_INST_INSERTELT;
639 Vals.push_back(VE.getTypeID(I.getType()));
640 Vals.push_back(VE.getValueID(I.getOperand(0)));
641 Vals.push_back(VE.getValueID(I.getOperand(1)));
642 Vals.push_back(VE.getValueID(I.getOperand(2)));
643 break;
644 case Instruction::ShuffleVector:
645 Code = bitc::FUNC_CODE_INST_SHUFFLEVEC;
646 Vals.push_back(VE.getTypeID(I.getType()));
647 Vals.push_back(VE.getValueID(I.getOperand(0)));
648 Vals.push_back(VE.getValueID(I.getOperand(1)));
649 Vals.push_back(VE.getValueID(I.getOperand(2)));
650 break;
651 case Instruction::ICmp:
652 case Instruction::FCmp:
653 Code = bitc::FUNC_CODE_INST_CMP;
Chris Lattnerdf1233d2007-05-06 00:00:00 +0000654 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
Chris Lattner0a603252007-05-01 02:13:26 +0000655 Vals.push_back(VE.getValueID(I.getOperand(1)));
656 Vals.push_back(cast<CmpInst>(I).getPredicate());
657 break;
658
659 case Instruction::Ret:
660 Code = bitc::FUNC_CODE_INST_RET;
Chris Lattnerdf1233d2007-05-06 00:00:00 +0000661 if (I.getNumOperands())
662 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
Chris Lattner0a603252007-05-01 02:13:26 +0000663 break;
664 case Instruction::Br:
665 Code = bitc::FUNC_CODE_INST_BR;
666 Vals.push_back(VE.getValueID(I.getOperand(0)));
667 if (cast<BranchInst>(I).isConditional()) {
668 Vals.push_back(VE.getValueID(I.getOperand(1)));
669 Vals.push_back(VE.getValueID(I.getOperand(2)));
670 }
671 break;
672 case Instruction::Switch:
673 Code = bitc::FUNC_CODE_INST_SWITCH;
674 Vals.push_back(VE.getTypeID(I.getOperand(0)->getType()));
Chris Lattner0a603252007-05-01 02:13:26 +0000675 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
676 Vals.push_back(VE.getValueID(I.getOperand(i)));
677 break;
Chris Lattnerb811e952007-05-01 07:03:37 +0000678 case Instruction::Invoke: {
Chris Lattner0a603252007-05-01 02:13:26 +0000679 Code = bitc::FUNC_CODE_INST_INVOKE;
Chris Lattner47045272007-05-03 22:34:03 +0000680 Vals.push_back(cast<InvokeInst>(I).getCallingConv());
Chris Lattnerdf1233d2007-05-06 00:00:00 +0000681 Vals.push_back(VE.getValueID(I.getOperand(1))); // normal dest
682 Vals.push_back(VE.getValueID(I.getOperand(2))); // unwind dest
683 PushValueAndType(I.getOperand(0), InstID, Vals, VE); // callee
Chris Lattnere6e364c2007-04-26 05:53:54 +0000684
Chris Lattner0a603252007-05-01 02:13:26 +0000685 // Emit value #'s for the fixed parameters.
686 const PointerType *PTy = cast<PointerType>(I.getOperand(0)->getType());
687 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
688 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
689 Vals.push_back(VE.getValueID(I.getOperand(i+3))); // fixed param.
690
691 // Emit type/value pairs for varargs params.
692 if (FTy->isVarArg()) {
Chris Lattnerdf1233d2007-05-06 00:00:00 +0000693 for (unsigned i = 3+FTy->getNumParams(), e = I.getNumOperands();
694 i != e; ++i)
695 PushValueAndType(I.getOperand(i), InstID, Vals, VE); // vararg
Chris Lattner0a603252007-05-01 02:13:26 +0000696 }
697 break;
Chris Lattnerb811e952007-05-01 07:03:37 +0000698 }
Chris Lattnere6e364c2007-04-26 05:53:54 +0000699 case Instruction::Unwind:
700 Code = bitc::FUNC_CODE_INST_UNWIND;
701 break;
702 case Instruction::Unreachable:
703 Code = bitc::FUNC_CODE_INST_UNREACHABLE;
704 break;
Chris Lattner0a603252007-05-01 02:13:26 +0000705
706 case Instruction::PHI:
707 Code = bitc::FUNC_CODE_INST_PHI;
708 Vals.push_back(VE.getTypeID(I.getType()));
Chris Lattner0a603252007-05-01 02:13:26 +0000709 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
710 Vals.push_back(VE.getValueID(I.getOperand(i)));
711 break;
Chris Lattnere6e364c2007-04-26 05:53:54 +0000712
Chris Lattner0a603252007-05-01 02:13:26 +0000713 case Instruction::Malloc:
714 Code = bitc::FUNC_CODE_INST_MALLOC;
715 Vals.push_back(VE.getTypeID(I.getType()));
716 Vals.push_back(VE.getValueID(I.getOperand(0))); // size.
717 Vals.push_back(Log2_32(cast<MallocInst>(I).getAlignment())+1);
718 break;
719
720 case Instruction::Free:
721 Code = bitc::FUNC_CODE_INST_FREE;
722 Vals.push_back(VE.getTypeID(I.getOperand(0)->getType()));
723 Vals.push_back(VE.getValueID(I.getOperand(0)));
724 break;
725
726 case Instruction::Alloca:
727 Code = bitc::FUNC_CODE_INST_ALLOCA;
728 Vals.push_back(VE.getTypeID(I.getType()));
729 Vals.push_back(VE.getValueID(I.getOperand(0))); // size.
730 Vals.push_back(Log2_32(cast<AllocaInst>(I).getAlignment())+1);
731 break;
732
733 case Instruction::Load:
734 Code = bitc::FUNC_CODE_INST_LOAD;
Chris Lattnerdf1233d2007-05-06 00:00:00 +0000735 if (!PushValueAndType(I.getOperand(0), InstID, Vals, VE)) // ptr
736 AbbrevToUse = FUNCTION_INST_LOAD_ABBREV;
737
Chris Lattner0a603252007-05-01 02:13:26 +0000738 Vals.push_back(Log2_32(cast<LoadInst>(I).getAlignment())+1);
739 Vals.push_back(cast<LoadInst>(I).isVolatile());
740 break;
741 case Instruction::Store:
742 Code = bitc::FUNC_CODE_INST_STORE;
743 Vals.push_back(VE.getTypeID(I.getOperand(1)->getType())); // Pointer
744 Vals.push_back(VE.getValueID(I.getOperand(0))); // val.
745 Vals.push_back(VE.getValueID(I.getOperand(1))); // ptr.
746 Vals.push_back(Log2_32(cast<StoreInst>(I).getAlignment())+1);
747 Vals.push_back(cast<StoreInst>(I).isVolatile());
748 break;
749 case Instruction::Call: {
750 Code = bitc::FUNC_CODE_INST_CALL;
Chris Lattner47045272007-05-03 22:34:03 +0000751 Vals.push_back((cast<CallInst>(I).getCallingConv() << 1) |
752 cast<CallInst>(I).isTailCall());
Chris Lattnerdf1233d2007-05-06 00:00:00 +0000753 PushValueAndType(I.getOperand(0), InstID, Vals, VE); // Callee
Chris Lattner0a603252007-05-01 02:13:26 +0000754
755 // Emit value #'s for the fixed parameters.
756 const PointerType *PTy = cast<PointerType>(I.getOperand(0)->getType());
757 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
758 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
759 Vals.push_back(VE.getValueID(I.getOperand(i+1))); // fixed param.
760
Chris Lattnerb811e952007-05-01 07:03:37 +0000761 // Emit type/value pairs for varargs params.
762 if (FTy->isVarArg()) {
763 unsigned NumVarargs = I.getNumOperands()-1-FTy->getNumParams();
Chris Lattnerb811e952007-05-01 07:03:37 +0000764 for (unsigned i = I.getNumOperands()-NumVarargs, e = I.getNumOperands();
Chris Lattnerdf1233d2007-05-06 00:00:00 +0000765 i != e; ++i)
766 PushValueAndType(I.getOperand(i), InstID, Vals, VE); // varargs
Chris Lattner0a603252007-05-01 02:13:26 +0000767 }
768 break;
Chris Lattnerb811e952007-05-01 07:03:37 +0000769 }
Chris Lattner0a603252007-05-01 02:13:26 +0000770 case Instruction::VAArg:
771 Code = bitc::FUNC_CODE_INST_VAARG;
772 Vals.push_back(VE.getTypeID(I.getOperand(0)->getType())); // valistty
773 Vals.push_back(VE.getValueID(I.getOperand(0))); // valist.
774 Vals.push_back(VE.getTypeID(I.getType())); // restype.
775 break;
Chris Lattnere6e364c2007-04-26 05:53:54 +0000776 }
777
778 Stream.EmitRecord(Code, Vals, AbbrevToUse);
779 Vals.clear();
780}
781
Chris Lattnerfb6f9402007-05-01 02:14:57 +0000782// Emit names for globals/functions etc.
783static void WriteValueSymbolTable(const ValueSymbolTable &VST,
784 const ValueEnumerator &VE,
785 BitstreamWriter &Stream) {
786 if (VST.empty()) return;
Chris Lattnere760d6f2007-05-05 01:26:50 +0000787 Stream.EnterSubblock(bitc::VALUE_SYMTAB_BLOCK_ID, 4);
Chris Lattner2eae59f2007-05-04 20:34:50 +0000788
Chris Lattnerfb6f9402007-05-01 02:14:57 +0000789 // FIXME: Set up the abbrev, we know how many values there are!
790 // FIXME: We know if the type names can use 7-bit ascii.
791 SmallVector<unsigned, 64> NameVals;
792
793 for (ValueSymbolTable::const_iterator SI = VST.begin(), SE = VST.end();
794 SI != SE; ++SI) {
Chris Lattner4d925982007-05-04 20:52:02 +0000795
796 const ValueName &Name = *SI;
797
798 // Figure out the encoding to use for the name.
799 bool is7Bit = true;
Chris Lattnere760d6f2007-05-05 01:26:50 +0000800 bool isChar6 = true;
801 for (const char *C = Name.getKeyData(), *E = C+Name.getKeyLength();
802 C != E; ++C) {
803 if (isChar6)
804 isChar6 = BitCodeAbbrevOp::isChar6(*C);
805 if ((unsigned char)*C & 128) {
Chris Lattner4d925982007-05-04 20:52:02 +0000806 is7Bit = false;
Chris Lattnere760d6f2007-05-05 01:26:50 +0000807 break; // don't bother scanning the rest.
Chris Lattner4d925982007-05-04 20:52:02 +0000808 }
Chris Lattnere760d6f2007-05-05 01:26:50 +0000809 }
Chris Lattner4d925982007-05-04 20:52:02 +0000810
Chris Lattnera0987962007-05-04 21:31:13 +0000811 unsigned AbbrevToUse = VST_ENTRY_8_ABBREV;
Chris Lattnerfb6f9402007-05-01 02:14:57 +0000812
Chris Lattnera0987962007-05-04 21:31:13 +0000813 // VST_ENTRY: [valueid, namechar x N]
814 // VST_BBENTRY: [bbid, namechar x N]
Chris Lattner6be58c62007-05-03 22:18:21 +0000815 unsigned Code;
816 if (isa<BasicBlock>(SI->getValue())) {
817 Code = bitc::VST_CODE_BBENTRY;
Chris Lattnere760d6f2007-05-05 01:26:50 +0000818 if (isChar6)
819 AbbrevToUse = VST_BBENTRY_6_ABBREV;
Chris Lattner6be58c62007-05-03 22:18:21 +0000820 } else {
821 Code = bitc::VST_CODE_ENTRY;
Chris Lattnere760d6f2007-05-05 01:26:50 +0000822 if (isChar6)
823 AbbrevToUse = VST_ENTRY_6_ABBREV;
824 else if (is7Bit)
825 AbbrevToUse = VST_ENTRY_7_ABBREV;
Chris Lattner6be58c62007-05-03 22:18:21 +0000826 }
Chris Lattnerfb6f9402007-05-01 02:14:57 +0000827
Chris Lattner6be58c62007-05-03 22:18:21 +0000828 NameVals.push_back(VE.getValueID(SI->getValue()));
Chris Lattner4d925982007-05-04 20:52:02 +0000829 for (const char *P = Name.getKeyData(),
830 *E = Name.getKeyData()+Name.getKeyLength(); P != E; ++P)
Chris Lattnerfb6f9402007-05-01 02:14:57 +0000831 NameVals.push_back((unsigned char)*P);
832
833 // Emit the finished record.
Chris Lattner6be58c62007-05-03 22:18:21 +0000834 Stream.EmitRecord(Code, NameVals, AbbrevToUse);
Chris Lattnerfb6f9402007-05-01 02:14:57 +0000835 NameVals.clear();
836 }
837 Stream.ExitBlock();
838}
839
Chris Lattner5f640b92007-04-26 03:50:57 +0000840/// WriteFunction - Emit a function body to the module stream.
Chris Lattner831d4202007-04-26 03:27:58 +0000841static void WriteFunction(const Function &F, ValueEnumerator &VE,
842 BitstreamWriter &Stream) {
Chris Lattnerf0a1eba2007-04-29 05:49:09 +0000843 Stream.EnterSubblock(bitc::FUNCTION_BLOCK_ID, 3);
Chris Lattner5f640b92007-04-26 03:50:57 +0000844 VE.incorporateFunction(F);
Chris Lattnere6e364c2007-04-26 05:53:54 +0000845
846 SmallVector<unsigned, 64> Vals;
847
848 // Emit the number of basic blocks, so the reader can create them ahead of
849 // time.
850 Vals.push_back(VE.getBasicBlocks().size());
851 Stream.EmitRecord(bitc::FUNC_CODE_DECLAREBLOCKS, Vals);
852 Vals.clear();
853
854 // FIXME: Function attributes?
855
856 // If there are function-local constants, emit them now.
857 unsigned CstStart, CstEnd;
858 VE.getFunctionConstantRange(CstStart, CstEnd);
Chris Lattnerda5e5d22007-05-05 07:36:14 +0000859 WriteConstants(CstStart, CstEnd, VE, Stream, false);
Chris Lattnere6e364c2007-04-26 05:53:54 +0000860
Chris Lattnerdf1233d2007-05-06 00:00:00 +0000861 // Keep a running idea of what the instruction ID is.
862 unsigned InstID = CstEnd;
863
Chris Lattnere6e364c2007-04-26 05:53:54 +0000864 // Finally, emit all the instructions, in order.
865 for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
Chris Lattnerdf1233d2007-05-06 00:00:00 +0000866 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end();
867 I != E; ++I) {
868 WriteInstruction(*I, InstID, VE, Stream, Vals);
869 if (I->getType() != Type::VoidTy)
870 ++InstID;
871 }
Chris Lattner831d4202007-04-26 03:27:58 +0000872
Chris Lattnerfb6f9402007-05-01 02:14:57 +0000873 // Emit names for all the instructions etc.
874 WriteValueSymbolTable(F.getValueSymbolTable(), VE, Stream);
875
Chris Lattner5f640b92007-04-26 03:50:57 +0000876 VE.purgeFunction();
Chris Lattnere6e364c2007-04-26 05:53:54 +0000877 Stream.ExitBlock();
Chris Lattner831d4202007-04-26 03:27:58 +0000878}
879
880/// WriteTypeSymbolTable - Emit a block for the specified type symtab.
881static void WriteTypeSymbolTable(const TypeSymbolTable &TST,
882 const ValueEnumerator &VE,
883 BitstreamWriter &Stream) {
884 if (TST.empty()) return;
885
886 Stream.EnterSubblock(bitc::TYPE_SYMTAB_BLOCK_ID, 3);
887
Chris Lattnerde05f6b2007-05-05 00:47:19 +0000888 // 7-bit fixed width VST_CODE_ENTRY strings.
889 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
890 Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_ENTRY));
891 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
892 Log2_32_Ceil(VE.getTypes().size()+1)));
893 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
894 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7));
895 unsigned V7Abbrev = Stream.EmitAbbrev(Abbv);
Chris Lattner831d4202007-04-26 03:27:58 +0000896
897 SmallVector<unsigned, 64> NameVals;
898
899 for (TypeSymbolTable::const_iterator TI = TST.begin(), TE = TST.end();
900 TI != TE; ++TI) {
Chris Lattnerde05f6b2007-05-05 00:47:19 +0000901 // TST_ENTRY: [typeid, namechar x N]
Chris Lattner831d4202007-04-26 03:27:58 +0000902 NameVals.push_back(VE.getTypeID(TI->second));
903
904 const std::string &Str = TI->first;
Chris Lattnerde05f6b2007-05-05 00:47:19 +0000905 bool is7Bit = true;
906 for (unsigned i = 0, e = Str.size(); i != e; ++i) {
907 NameVals.push_back((unsigned char)Str[i]);
908 if (Str[i] & 128)
909 is7Bit = false;
910 }
Chris Lattner831d4202007-04-26 03:27:58 +0000911
912 // Emit the finished record.
Chris Lattnerde05f6b2007-05-05 00:47:19 +0000913 Stream.EmitRecord(bitc::VST_CODE_ENTRY, NameVals, is7Bit ? V7Abbrev : 0);
Chris Lattner831d4202007-04-26 03:27:58 +0000914 NameVals.clear();
915 }
916
917 Stream.ExitBlock();
918}
919
Chris Lattner702658c2007-05-04 18:26:27 +0000920// Emit blockinfo, which defines the standard abbreviations etc.
Chris Lattnerda5e5d22007-05-05 07:36:14 +0000921static void WriteBlockInfo(const ValueEnumerator &VE, BitstreamWriter &Stream) {
Chris Lattner702658c2007-05-04 18:26:27 +0000922 // We only want to emit block info records for blocks that have multiple
923 // instances: CONSTANTS_BLOCK, FUNCTION_BLOCK and VALUE_SYMTAB_BLOCK. Other
924 // blocks can defined their abbrevs inline.
Chris Lattner982ec1e2007-05-05 00:17:00 +0000925 Stream.EnterBlockInfoBlock(2);
Chris Lattner702658c2007-05-04 18:26:27 +0000926
Chris Lattner982ec1e2007-05-05 00:17:00 +0000927 { // 8-bit fixed-width VST_ENTRY/VST_BBENTRY strings.
928 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
929 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3));
930 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
931 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
932 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
933 if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
934 Abbv) != VST_ENTRY_8_ABBREV)
935 assert(0 && "Unexpected abbrev ordering!");
936 }
937
938 { // 7-bit fixed width VST_ENTRY strings.
939 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
940 Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_ENTRY));
941 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
942 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
943 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7));
944 if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
945 Abbv) != VST_ENTRY_7_ABBREV)
946 assert(0 && "Unexpected abbrev ordering!");
947 }
Chris Lattnere760d6f2007-05-05 01:26:50 +0000948 { // 6-bit char6 VST_ENTRY strings.
949 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
950 Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_ENTRY));
951 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
952 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
953 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
954 if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
955 Abbv) != VST_ENTRY_6_ABBREV)
956 assert(0 && "Unexpected abbrev ordering!");
957 }
958 { // 6-bit char6 VST_BBENTRY strings.
Chris Lattner982ec1e2007-05-05 00:17:00 +0000959 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
960 Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_BBENTRY));
961 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
962 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
Chris Lattnere760d6f2007-05-05 01:26:50 +0000963 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
Chris Lattner982ec1e2007-05-05 00:17:00 +0000964 if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
Chris Lattnere760d6f2007-05-05 01:26:50 +0000965 Abbv) != VST_BBENTRY_6_ABBREV)
Chris Lattner982ec1e2007-05-05 00:17:00 +0000966 assert(0 && "Unexpected abbrev ordering!");
967 }
968
Chris Lattnerb80751d2007-05-05 07:44:49 +0000969
970
Chris Lattnerda5e5d22007-05-05 07:36:14 +0000971 { // SETTYPE abbrev for CONSTANTS_BLOCK.
972 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
973 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_SETTYPE));
974 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
975 Log2_32_Ceil(VE.getTypes().size()+1)));
976 if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
977 Abbv) != CONSTANTS_SETTYPE_ABBREV)
978 assert(0 && "Unexpected abbrev ordering!");
979 }
980
981 { // INTEGER abbrev for CONSTANTS_BLOCK.
982 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
983 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_INTEGER));
984 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
985 if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
986 Abbv) != CONSTANTS_INTEGER_ABBREV)
987 assert(0 && "Unexpected abbrev ordering!");
988 }
989
990 { // CE_CAST abbrev for CONSTANTS_BLOCK.
991 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
992 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_CE_CAST));
993 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // cast opc
994 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, // typeid
995 Log2_32_Ceil(VE.getTypes().size()+1)));
996 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // value id
997
998 if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
999 Abbv) != CONSTANTS_CE_CAST_Abbrev)
1000 assert(0 && "Unexpected abbrev ordering!");
1001 }
1002 { // NULL abbrev for CONSTANTS_BLOCK.
1003 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1004 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_NULL));
1005 if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
1006 Abbv) != CONSTANTS_NULL_Abbrev)
1007 assert(0 && "Unexpected abbrev ordering!");
1008 }
1009
Chris Lattnerb80751d2007-05-05 07:44:49 +00001010 // FIXME: This should only use space for first class types!
1011
1012 { // INST_LOAD abbrev for FUNCTION_BLOCK.
1013 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1014 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_LOAD));
Chris Lattnerb80751d2007-05-05 07:44:49 +00001015 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Ptr
1016 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // Align
1017 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // volatile
1018 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
1019 Abbv) != FUNCTION_INST_LOAD_ABBREV)
1020 assert(0 && "Unexpected abbrev ordering!");
1021 }
1022
Chris Lattnerda5e5d22007-05-05 07:36:14 +00001023 Stream.ExitBlock();
1024}
1025
1026
1027/// WriteModule - Emit the specified module to the bitstream.
1028static void WriteModule(const Module *M, BitstreamWriter &Stream) {
1029 Stream.EnterSubblock(bitc::MODULE_BLOCK_ID, 3);
1030
1031 // Emit the version number if it is non-zero.
1032 if (CurVersion) {
1033 SmallVector<unsigned, 1> Vals;
1034 Vals.push_back(CurVersion);
1035 Stream.EmitRecord(bitc::MODULE_CODE_VERSION, Vals);
1036 }
1037
1038 // Analyze the module, enumerating globals, functions, etc.
1039 ValueEnumerator VE(M);
1040
1041 // Emit blockinfo, which defines the standard abbreviations etc.
1042 WriteBlockInfo(VE, Stream);
1043
1044 // Emit information about parameter attributes.
1045 WriteParamAttrTable(VE, Stream);
1046
1047 // Emit information describing all of the types in the module.
1048 WriteTypeTable(VE, Stream);
1049
1050 // Emit top-level description of module, including target triple, inline asm,
1051 // descriptors for global variables, and function prototype info.
1052 WriteModuleInfo(M, VE, Stream);
1053
1054 // Emit constants.
1055 WriteModuleConstants(VE, Stream);
1056
1057 // If we have any aggregate values in the value table, purge them - these can
1058 // only be used to initialize global variables. Doing so makes the value
1059 // namespace smaller for code in functions.
1060 int NumNonAggregates = VE.PurgeAggregateValues();
1061 if (NumNonAggregates != -1) {
1062 SmallVector<unsigned, 1> Vals;
1063 Vals.push_back(NumNonAggregates);
1064 Stream.EmitRecord(bitc::MODULE_CODE_PURGEVALS, Vals);
1065 }
1066
1067 // Emit function bodies.
1068 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
1069 if (!I->isDeclaration())
1070 WriteFunction(*I, VE, Stream);
1071
1072 // Emit the type symbol table information.
1073 WriteTypeSymbolTable(M->getTypeSymbolTable(), VE, Stream);
1074
1075 // Emit names for globals/functions etc.
1076 WriteValueSymbolTable(M->getValueSymbolTable(), VE, Stream);
1077
Chris Lattner702658c2007-05-04 18:26:27 +00001078 Stream.ExitBlock();
1079}
1080
1081
Chris Lattnerc1d10d62007-04-22 06:24:45 +00001082/// WriteBitcodeToFile - Write the specified module to the specified output
1083/// stream.
1084void llvm::WriteBitcodeToFile(const Module *M, std::ostream &Out) {
1085 std::vector<unsigned char> Buffer;
1086 BitstreamWriter Stream(Buffer);
1087
1088 Buffer.reserve(256*1024);
1089
1090 // Emit the file header.
1091 Stream.Emit((unsigned)'B', 8);
1092 Stream.Emit((unsigned)'C', 8);
1093 Stream.Emit(0x0, 4);
1094 Stream.Emit(0xC, 4);
1095 Stream.Emit(0xE, 4);
1096 Stream.Emit(0xD, 4);
1097
Chris Lattnerc1d10d62007-04-22 06:24:45 +00001098 // Emit the module.
1099 WriteModule(M, Stream);
1100
1101 // Write the generated bitstream to "Out".
1102 Out.write((char*)&Buffer.front(), Buffer.size());
1103}