1 //===--- Bitcode/Writer/BitcodeWriter.cpp - Bitcode Writer ----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // Bitcode writer implementation.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/Bitcode/ReaderWriter.h"
15 #include "ValueEnumerator.h"
16 #include "llvm/ADT/Triple.h"
17 #include "llvm/Bitcode/BitstreamWriter.h"
18 #include "llvm/Bitcode/LLVMBitCodes.h"
19 #include "llvm/IR/Constants.h"
20 #include "llvm/IR/DerivedTypes.h"
21 #include "llvm/IR/InlineAsm.h"
22 #include "llvm/IR/Instructions.h"
23 #include "llvm/IR/Module.h"
24 #include "llvm/IR/Operator.h"
25 #include "llvm/IR/UseListOrder.h"
26 #include "llvm/IR/ValueSymbolTable.h"
27 #include "llvm/Support/CommandLine.h"
28 #include "llvm/Support/ErrorHandling.h"
29 #include "llvm/Support/MathExtras.h"
30 #include "llvm/Support/Program.h"
31 #include "llvm/Support/raw_ostream.h"
36 /// These are manifest constants used by the bitcode writer. They do not need to
37 /// be kept in sync with the reader, but need to be consistent within this file.
39 // VALUE_SYMTAB_BLOCK abbrev id's.
40 VST_ENTRY_8_ABBREV = bitc::FIRST_APPLICATION_ABBREV,
45 // CONSTANTS_BLOCK abbrev id's.
46 CONSTANTS_SETTYPE_ABBREV = bitc::FIRST_APPLICATION_ABBREV,
47 CONSTANTS_INTEGER_ABBREV,
48 CONSTANTS_CE_CAST_Abbrev,
49 CONSTANTS_NULL_Abbrev,
51 // FUNCTION_BLOCK abbrev id's.
52 FUNCTION_INST_LOAD_ABBREV = bitc::FIRST_APPLICATION_ABBREV,
53 FUNCTION_INST_BINOP_ABBREV,
54 FUNCTION_INST_BINOP_FLAGS_ABBREV,
55 FUNCTION_INST_CAST_ABBREV,
56 FUNCTION_INST_RET_VOID_ABBREV,
57 FUNCTION_INST_RET_VAL_ABBREV,
58 FUNCTION_INST_UNREACHABLE_ABBREV
61 static unsigned GetEncodedCastOpcode(unsigned Opcode) {
63 default: llvm_unreachable("Unknown cast instruction!");
64 case Instruction::Trunc : return bitc::CAST_TRUNC;
65 case Instruction::ZExt : return bitc::CAST_ZEXT;
66 case Instruction::SExt : return bitc::CAST_SEXT;
67 case Instruction::FPToUI : return bitc::CAST_FPTOUI;
68 case Instruction::FPToSI : return bitc::CAST_FPTOSI;
69 case Instruction::UIToFP : return bitc::CAST_UITOFP;
70 case Instruction::SIToFP : return bitc::CAST_SITOFP;
71 case Instruction::FPTrunc : return bitc::CAST_FPTRUNC;
72 case Instruction::FPExt : return bitc::CAST_FPEXT;
73 case Instruction::PtrToInt: return bitc::CAST_PTRTOINT;
74 case Instruction::IntToPtr: return bitc::CAST_INTTOPTR;
75 case Instruction::BitCast : return bitc::CAST_BITCAST;
76 case Instruction::AddrSpaceCast: return bitc::CAST_ADDRSPACECAST;
80 static unsigned GetEncodedBinaryOpcode(unsigned Opcode) {
82 default: llvm_unreachable("Unknown binary instruction!");
83 case Instruction::Add:
84 case Instruction::FAdd: return bitc::BINOP_ADD;
85 case Instruction::Sub:
86 case Instruction::FSub: return bitc::BINOP_SUB;
87 case Instruction::Mul:
88 case Instruction::FMul: return bitc::BINOP_MUL;
89 case Instruction::UDiv: return bitc::BINOP_UDIV;
90 case Instruction::FDiv:
91 case Instruction::SDiv: return bitc::BINOP_SDIV;
92 case Instruction::URem: return bitc::BINOP_UREM;
93 case Instruction::FRem:
94 case Instruction::SRem: return bitc::BINOP_SREM;
95 case Instruction::Shl: return bitc::BINOP_SHL;
96 case Instruction::LShr: return bitc::BINOP_LSHR;
97 case Instruction::AShr: return bitc::BINOP_ASHR;
98 case Instruction::And: return bitc::BINOP_AND;
99 case Instruction::Or: return bitc::BINOP_OR;
100 case Instruction::Xor: return bitc::BINOP_XOR;
104 static unsigned GetEncodedRMWOperation(AtomicRMWInst::BinOp Op) {
106 default: llvm_unreachable("Unknown RMW operation!");
107 case AtomicRMWInst::Xchg: return bitc::RMW_XCHG;
108 case AtomicRMWInst::Add: return bitc::RMW_ADD;
109 case AtomicRMWInst::Sub: return bitc::RMW_SUB;
110 case AtomicRMWInst::And: return bitc::RMW_AND;
111 case AtomicRMWInst::Nand: return bitc::RMW_NAND;
112 case AtomicRMWInst::Or: return bitc::RMW_OR;
113 case AtomicRMWInst::Xor: return bitc::RMW_XOR;
114 case AtomicRMWInst::Max: return bitc::RMW_MAX;
115 case AtomicRMWInst::Min: return bitc::RMW_MIN;
116 case AtomicRMWInst::UMax: return bitc::RMW_UMAX;
117 case AtomicRMWInst::UMin: return bitc::RMW_UMIN;
121 static unsigned GetEncodedOrdering(AtomicOrdering Ordering) {
123 case NotAtomic: return bitc::ORDERING_NOTATOMIC;
124 case Unordered: return bitc::ORDERING_UNORDERED;
125 case Monotonic: return bitc::ORDERING_MONOTONIC;
126 case Acquire: return bitc::ORDERING_ACQUIRE;
127 case Release: return bitc::ORDERING_RELEASE;
128 case AcquireRelease: return bitc::ORDERING_ACQREL;
129 case SequentiallyConsistent: return bitc::ORDERING_SEQCST;
131 llvm_unreachable("Invalid ordering");
134 static unsigned GetEncodedSynchScope(SynchronizationScope SynchScope) {
135 switch (SynchScope) {
136 case SingleThread: return bitc::SYNCHSCOPE_SINGLETHREAD;
137 case CrossThread: return bitc::SYNCHSCOPE_CROSSTHREAD;
139 llvm_unreachable("Invalid synch scope");
142 static void WriteStringRecord(unsigned Code, StringRef Str,
143 unsigned AbbrevToUse, BitstreamWriter &Stream) {
144 SmallVector<unsigned, 64> Vals;
146 // Code: [strchar x N]
147 for (unsigned i = 0, e = Str.size(); i != e; ++i) {
148 if (AbbrevToUse && !BitCodeAbbrevOp::isChar6(Str[i]))
150 Vals.push_back(Str[i]);
153 // Emit the finished record.
154 Stream.EmitRecord(Code, Vals, AbbrevToUse);
157 static uint64_t getAttrKindEncoding(Attribute::AttrKind Kind) {
159 case Attribute::Alignment:
160 return bitc::ATTR_KIND_ALIGNMENT;
161 case Attribute::AlwaysInline:
162 return bitc::ATTR_KIND_ALWAYS_INLINE;
163 case Attribute::Builtin:
164 return bitc::ATTR_KIND_BUILTIN;
165 case Attribute::ByVal:
166 return bitc::ATTR_KIND_BY_VAL;
167 case Attribute::InAlloca:
168 return bitc::ATTR_KIND_IN_ALLOCA;
169 case Attribute::Cold:
170 return bitc::ATTR_KIND_COLD;
171 case Attribute::InlineHint:
172 return bitc::ATTR_KIND_INLINE_HINT;
173 case Attribute::InReg:
174 return bitc::ATTR_KIND_IN_REG;
175 case Attribute::JumpTable:
176 return bitc::ATTR_KIND_JUMP_TABLE;
177 case Attribute::MinSize:
178 return bitc::ATTR_KIND_MIN_SIZE;
179 case Attribute::Naked:
180 return bitc::ATTR_KIND_NAKED;
181 case Attribute::Nest:
182 return bitc::ATTR_KIND_NEST;
183 case Attribute::NoAlias:
184 return bitc::ATTR_KIND_NO_ALIAS;
185 case Attribute::NoBuiltin:
186 return bitc::ATTR_KIND_NO_BUILTIN;
187 case Attribute::NoCapture:
188 return bitc::ATTR_KIND_NO_CAPTURE;
189 case Attribute::NoDuplicate:
190 return bitc::ATTR_KIND_NO_DUPLICATE;
191 case Attribute::NoImplicitFloat:
192 return bitc::ATTR_KIND_NO_IMPLICIT_FLOAT;
193 case Attribute::NoInline:
194 return bitc::ATTR_KIND_NO_INLINE;
195 case Attribute::NonLazyBind:
196 return bitc::ATTR_KIND_NON_LAZY_BIND;
197 case Attribute::NonNull:
198 return bitc::ATTR_KIND_NON_NULL;
199 case Attribute::Dereferenceable:
200 return bitc::ATTR_KIND_DEREFERENCEABLE;
201 case Attribute::NoRedZone:
202 return bitc::ATTR_KIND_NO_RED_ZONE;
203 case Attribute::NoReturn:
204 return bitc::ATTR_KIND_NO_RETURN;
205 case Attribute::NoUnwind:
206 return bitc::ATTR_KIND_NO_UNWIND;
207 case Attribute::OptimizeForSize:
208 return bitc::ATTR_KIND_OPTIMIZE_FOR_SIZE;
209 case Attribute::OptimizeNone:
210 return bitc::ATTR_KIND_OPTIMIZE_NONE;
211 case Attribute::ReadNone:
212 return bitc::ATTR_KIND_READ_NONE;
213 case Attribute::ReadOnly:
214 return bitc::ATTR_KIND_READ_ONLY;
215 case Attribute::Returned:
216 return bitc::ATTR_KIND_RETURNED;
217 case Attribute::ReturnsTwice:
218 return bitc::ATTR_KIND_RETURNS_TWICE;
219 case Attribute::SExt:
220 return bitc::ATTR_KIND_S_EXT;
221 case Attribute::StackAlignment:
222 return bitc::ATTR_KIND_STACK_ALIGNMENT;
223 case Attribute::StackProtect:
224 return bitc::ATTR_KIND_STACK_PROTECT;
225 case Attribute::StackProtectReq:
226 return bitc::ATTR_KIND_STACK_PROTECT_REQ;
227 case Attribute::StackProtectStrong:
228 return bitc::ATTR_KIND_STACK_PROTECT_STRONG;
229 case Attribute::StructRet:
230 return bitc::ATTR_KIND_STRUCT_RET;
231 case Attribute::SanitizeAddress:
232 return bitc::ATTR_KIND_SANITIZE_ADDRESS;
233 case Attribute::SanitizeThread:
234 return bitc::ATTR_KIND_SANITIZE_THREAD;
235 case Attribute::SanitizeMemory:
236 return bitc::ATTR_KIND_SANITIZE_MEMORY;
237 case Attribute::UWTable:
238 return bitc::ATTR_KIND_UW_TABLE;
239 case Attribute::ZExt:
240 return bitc::ATTR_KIND_Z_EXT;
241 case Attribute::EndAttrKinds:
242 llvm_unreachable("Can not encode end-attribute kinds marker.");
243 case Attribute::None:
244 llvm_unreachable("Can not encode none-attribute.");
247 llvm_unreachable("Trying to encode unknown attribute");
250 static void WriteAttributeGroupTable(const ValueEnumerator &VE,
251 BitstreamWriter &Stream) {
252 const std::vector<AttributeSet> &AttrGrps = VE.getAttributeGroups();
253 if (AttrGrps.empty()) return;
255 Stream.EnterSubblock(bitc::PARAMATTR_GROUP_BLOCK_ID, 3);
257 SmallVector<uint64_t, 64> Record;
258 for (unsigned i = 0, e = AttrGrps.size(); i != e; ++i) {
259 AttributeSet AS = AttrGrps[i];
260 for (unsigned i = 0, e = AS.getNumSlots(); i != e; ++i) {
261 AttributeSet A = AS.getSlotAttributes(i);
263 Record.push_back(VE.getAttributeGroupID(A));
264 Record.push_back(AS.getSlotIndex(i));
266 for (AttributeSet::iterator I = AS.begin(0), E = AS.end(0);
269 if (Attr.isEnumAttribute()) {
271 Record.push_back(getAttrKindEncoding(Attr.getKindAsEnum()));
272 } else if (Attr.isIntAttribute()) {
274 Record.push_back(getAttrKindEncoding(Attr.getKindAsEnum()));
275 Record.push_back(Attr.getValueAsInt());
277 StringRef Kind = Attr.getKindAsString();
278 StringRef Val = Attr.getValueAsString();
280 Record.push_back(Val.empty() ? 3 : 4);
281 Record.append(Kind.begin(), Kind.end());
284 Record.append(Val.begin(), Val.end());
290 Stream.EmitRecord(bitc::PARAMATTR_GRP_CODE_ENTRY, Record);
298 static void WriteAttributeTable(const ValueEnumerator &VE,
299 BitstreamWriter &Stream) {
300 const std::vector<AttributeSet> &Attrs = VE.getAttributes();
301 if (Attrs.empty()) return;
303 Stream.EnterSubblock(bitc::PARAMATTR_BLOCK_ID, 3);
305 SmallVector<uint64_t, 64> Record;
306 for (unsigned i = 0, e = Attrs.size(); i != e; ++i) {
307 const AttributeSet &A = Attrs[i];
308 for (unsigned i = 0, e = A.getNumSlots(); i != e; ++i)
309 Record.push_back(VE.getAttributeGroupID(A.getSlotAttributes(i)));
311 Stream.EmitRecord(bitc::PARAMATTR_CODE_ENTRY, Record);
318 /// WriteTypeTable - Write out the type table for a module.
319 static void WriteTypeTable(const ValueEnumerator &VE, BitstreamWriter &Stream) {
320 const ValueEnumerator::TypeList &TypeList = VE.getTypes();
322 Stream.EnterSubblock(bitc::TYPE_BLOCK_ID_NEW, 4 /*count from # abbrevs */);
323 SmallVector<uint64_t, 64> TypeVals;
325 uint64_t NumBits = Log2_32_Ceil(VE.getTypes().size()+1);
327 // Abbrev for TYPE_CODE_POINTER.
328 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
329 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_POINTER));
330 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
331 Abbv->Add(BitCodeAbbrevOp(0)); // Addrspace = 0
332 unsigned PtrAbbrev = Stream.EmitAbbrev(Abbv);
334 // Abbrev for TYPE_CODE_FUNCTION.
335 Abbv = new BitCodeAbbrev();
336 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_FUNCTION));
337 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isvararg
338 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
339 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
341 unsigned FunctionAbbrev = Stream.EmitAbbrev(Abbv);
343 // Abbrev for TYPE_CODE_STRUCT_ANON.
344 Abbv = new BitCodeAbbrev();
345 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_STRUCT_ANON));
346 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ispacked
347 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
348 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
350 unsigned StructAnonAbbrev = Stream.EmitAbbrev(Abbv);
352 // Abbrev for TYPE_CODE_STRUCT_NAME.
353 Abbv = new BitCodeAbbrev();
354 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_STRUCT_NAME));
355 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
356 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
357 unsigned StructNameAbbrev = Stream.EmitAbbrev(Abbv);
359 // Abbrev for TYPE_CODE_STRUCT_NAMED.
360 Abbv = new BitCodeAbbrev();
361 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_STRUCT_NAMED));
362 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ispacked
363 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
364 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
366 unsigned StructNamedAbbrev = Stream.EmitAbbrev(Abbv);
368 // Abbrev for TYPE_CODE_ARRAY.
369 Abbv = new BitCodeAbbrev();
370 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_ARRAY));
371 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // size
372 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
374 unsigned ArrayAbbrev = Stream.EmitAbbrev(Abbv);
376 // Emit an entry count so the reader can reserve space.
377 TypeVals.push_back(TypeList.size());
378 Stream.EmitRecord(bitc::TYPE_CODE_NUMENTRY, TypeVals);
381 // Loop over all of the types, emitting each in turn.
382 for (unsigned i = 0, e = TypeList.size(); i != e; ++i) {
383 Type *T = TypeList[i];
387 switch (T->getTypeID()) {
388 case Type::VoidTyID: Code = bitc::TYPE_CODE_VOID; break;
389 case Type::HalfTyID: Code = bitc::TYPE_CODE_HALF; break;
390 case Type::FloatTyID: Code = bitc::TYPE_CODE_FLOAT; break;
391 case Type::DoubleTyID: Code = bitc::TYPE_CODE_DOUBLE; break;
392 case Type::X86_FP80TyID: Code = bitc::TYPE_CODE_X86_FP80; break;
393 case Type::FP128TyID: Code = bitc::TYPE_CODE_FP128; break;
394 case Type::PPC_FP128TyID: Code = bitc::TYPE_CODE_PPC_FP128; break;
395 case Type::LabelTyID: Code = bitc::TYPE_CODE_LABEL; break;
396 case Type::MetadataTyID: Code = bitc::TYPE_CODE_METADATA; break;
397 case Type::X86_MMXTyID: Code = bitc::TYPE_CODE_X86_MMX; break;
398 case Type::IntegerTyID:
400 Code = bitc::TYPE_CODE_INTEGER;
401 TypeVals.push_back(cast<IntegerType>(T)->getBitWidth());
403 case Type::PointerTyID: {
404 PointerType *PTy = cast<PointerType>(T);
405 // POINTER: [pointee type, address space]
406 Code = bitc::TYPE_CODE_POINTER;
407 TypeVals.push_back(VE.getTypeID(PTy->getElementType()));
408 unsigned AddressSpace = PTy->getAddressSpace();
409 TypeVals.push_back(AddressSpace);
410 if (AddressSpace == 0) AbbrevToUse = PtrAbbrev;
413 case Type::FunctionTyID: {
414 FunctionType *FT = cast<FunctionType>(T);
415 // FUNCTION: [isvararg, retty, paramty x N]
416 Code = bitc::TYPE_CODE_FUNCTION;
417 TypeVals.push_back(FT->isVarArg());
418 TypeVals.push_back(VE.getTypeID(FT->getReturnType()));
419 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i)
420 TypeVals.push_back(VE.getTypeID(FT->getParamType(i)));
421 AbbrevToUse = FunctionAbbrev;
424 case Type::StructTyID: {
425 StructType *ST = cast<StructType>(T);
426 // STRUCT: [ispacked, eltty x N]
427 TypeVals.push_back(ST->isPacked());
428 // Output all of the element types.
429 for (StructType::element_iterator I = ST->element_begin(),
430 E = ST->element_end(); I != E; ++I)
431 TypeVals.push_back(VE.getTypeID(*I));
433 if (ST->isLiteral()) {
434 Code = bitc::TYPE_CODE_STRUCT_ANON;
435 AbbrevToUse = StructAnonAbbrev;
437 if (ST->isOpaque()) {
438 Code = bitc::TYPE_CODE_OPAQUE;
440 Code = bitc::TYPE_CODE_STRUCT_NAMED;
441 AbbrevToUse = StructNamedAbbrev;
444 // Emit the name if it is present.
445 if (!ST->getName().empty())
446 WriteStringRecord(bitc::TYPE_CODE_STRUCT_NAME, ST->getName(),
447 StructNameAbbrev, Stream);
451 case Type::ArrayTyID: {
452 ArrayType *AT = cast<ArrayType>(T);
453 // ARRAY: [numelts, eltty]
454 Code = bitc::TYPE_CODE_ARRAY;
455 TypeVals.push_back(AT->getNumElements());
456 TypeVals.push_back(VE.getTypeID(AT->getElementType()));
457 AbbrevToUse = ArrayAbbrev;
460 case Type::VectorTyID: {
461 VectorType *VT = cast<VectorType>(T);
462 // VECTOR [numelts, eltty]
463 Code = bitc::TYPE_CODE_VECTOR;
464 TypeVals.push_back(VT->getNumElements());
465 TypeVals.push_back(VE.getTypeID(VT->getElementType()));
470 // Emit the finished record.
471 Stream.EmitRecord(Code, TypeVals, AbbrevToUse);
478 static unsigned getEncodedLinkage(const GlobalValue &GV) {
479 switch (GV.getLinkage()) {
480 case GlobalValue::ExternalLinkage:
482 case GlobalValue::WeakAnyLinkage:
484 case GlobalValue::AppendingLinkage:
486 case GlobalValue::InternalLinkage:
488 case GlobalValue::LinkOnceAnyLinkage:
490 case GlobalValue::ExternalWeakLinkage:
492 case GlobalValue::CommonLinkage:
494 case GlobalValue::PrivateLinkage:
496 case GlobalValue::WeakODRLinkage:
498 case GlobalValue::LinkOnceODRLinkage:
500 case GlobalValue::AvailableExternallyLinkage:
503 llvm_unreachable("Invalid linkage");
506 static unsigned getEncodedVisibility(const GlobalValue &GV) {
507 switch (GV.getVisibility()) {
508 case GlobalValue::DefaultVisibility: return 0;
509 case GlobalValue::HiddenVisibility: return 1;
510 case GlobalValue::ProtectedVisibility: return 2;
512 llvm_unreachable("Invalid visibility");
515 static unsigned getEncodedDLLStorageClass(const GlobalValue &GV) {
516 switch (GV.getDLLStorageClass()) {
517 case GlobalValue::DefaultStorageClass: return 0;
518 case GlobalValue::DLLImportStorageClass: return 1;
519 case GlobalValue::DLLExportStorageClass: return 2;
521 llvm_unreachable("Invalid DLL storage class");
524 static unsigned getEncodedThreadLocalMode(const GlobalValue &GV) {
525 switch (GV.getThreadLocalMode()) {
526 case GlobalVariable::NotThreadLocal: return 0;
527 case GlobalVariable::GeneralDynamicTLSModel: return 1;
528 case GlobalVariable::LocalDynamicTLSModel: return 2;
529 case GlobalVariable::InitialExecTLSModel: return 3;
530 case GlobalVariable::LocalExecTLSModel: return 4;
532 llvm_unreachable("Invalid TLS model");
535 static unsigned getEncodedComdatSelectionKind(const Comdat &C) {
536 switch (C.getSelectionKind()) {
538 return bitc::COMDAT_SELECTION_KIND_ANY;
539 case Comdat::ExactMatch:
540 return bitc::COMDAT_SELECTION_KIND_EXACT_MATCH;
541 case Comdat::Largest:
542 return bitc::COMDAT_SELECTION_KIND_LARGEST;
543 case Comdat::NoDuplicates:
544 return bitc::COMDAT_SELECTION_KIND_NO_DUPLICATES;
545 case Comdat::SameSize:
546 return bitc::COMDAT_SELECTION_KIND_SAME_SIZE;
548 llvm_unreachable("Invalid selection kind");
551 static void writeComdats(const ValueEnumerator &VE, BitstreamWriter &Stream) {
552 SmallVector<uint8_t, 64> Vals;
553 for (const Comdat *C : VE.getComdats()) {
554 // COMDAT: [selection_kind, name]
555 Vals.push_back(getEncodedComdatSelectionKind(*C));
556 Vals.push_back(C->getName().size());
557 for (char Chr : C->getName())
558 Vals.push_back((unsigned char)Chr);
559 Stream.EmitRecord(bitc::MODULE_CODE_COMDAT, Vals, /*AbbrevToUse=*/0);
564 // Emit top-level description of module, including target triple, inline asm,
565 // descriptors for global variables, and function prototype info.
566 static void WriteModuleInfo(const Module *M, const ValueEnumerator &VE,
567 BitstreamWriter &Stream) {
568 // Emit various pieces of data attached to a module.
569 if (!M->getTargetTriple().empty())
570 WriteStringRecord(bitc::MODULE_CODE_TRIPLE, M->getTargetTriple(),
572 const std::string &DL = M->getDataLayoutStr();
574 WriteStringRecord(bitc::MODULE_CODE_DATALAYOUT, DL, 0 /*TODO*/, Stream);
575 if (!M->getModuleInlineAsm().empty())
576 WriteStringRecord(bitc::MODULE_CODE_ASM, M->getModuleInlineAsm(),
579 // Emit information about sections and GC, computing how many there are. Also
580 // compute the maximum alignment value.
581 std::map<std::string, unsigned> SectionMap;
582 std::map<std::string, unsigned> GCMap;
583 unsigned MaxAlignment = 0;
584 unsigned MaxGlobalType = 0;
585 for (const GlobalValue &GV : M->globals()) {
586 MaxAlignment = std::max(MaxAlignment, GV.getAlignment());
587 MaxGlobalType = std::max(MaxGlobalType, VE.getTypeID(GV.getType()));
588 if (GV.hasSection()) {
589 // Give section names unique ID's.
590 unsigned &Entry = SectionMap[GV.getSection()];
592 WriteStringRecord(bitc::MODULE_CODE_SECTIONNAME, GV.getSection(),
594 Entry = SectionMap.size();
598 for (const Function &F : *M) {
599 MaxAlignment = std::max(MaxAlignment, F.getAlignment());
600 if (F.hasSection()) {
601 // Give section names unique ID's.
602 unsigned &Entry = SectionMap[F.getSection()];
604 WriteStringRecord(bitc::MODULE_CODE_SECTIONNAME, F.getSection(),
606 Entry = SectionMap.size();
610 // Same for GC names.
611 unsigned &Entry = GCMap[F.getGC()];
613 WriteStringRecord(bitc::MODULE_CODE_GCNAME, F.getGC(),
615 Entry = GCMap.size();
620 // Emit abbrev for globals, now that we know # sections and max alignment.
621 unsigned SimpleGVarAbbrev = 0;
622 if (!M->global_empty()) {
623 // Add an abbrev for common globals with no visibility or thread localness.
624 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
625 Abbv->Add(BitCodeAbbrevOp(bitc::MODULE_CODE_GLOBALVAR));
626 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
627 Log2_32_Ceil(MaxGlobalType+1)));
628 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Constant.
629 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Initializer.
630 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // Linkage.
631 if (MaxAlignment == 0) // Alignment.
632 Abbv->Add(BitCodeAbbrevOp(0));
634 unsigned MaxEncAlignment = Log2_32(MaxAlignment)+1;
635 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
636 Log2_32_Ceil(MaxEncAlignment+1)));
638 if (SectionMap.empty()) // Section.
639 Abbv->Add(BitCodeAbbrevOp(0));
641 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
642 Log2_32_Ceil(SectionMap.size()+1)));
643 // Don't bother emitting vis + thread local.
644 SimpleGVarAbbrev = Stream.EmitAbbrev(Abbv);
647 // Emit the global variable information.
648 SmallVector<unsigned, 64> Vals;
649 for (const GlobalVariable &GV : M->globals()) {
650 unsigned AbbrevToUse = 0;
652 // GLOBALVAR: [type, isconst, initid,
653 // linkage, alignment, section, visibility, threadlocal,
654 // unnamed_addr, externally_initialized, dllstorageclass]
655 Vals.push_back(VE.getTypeID(GV.getType()));
656 Vals.push_back(GV.isConstant());
657 Vals.push_back(GV.isDeclaration() ? 0 :
658 (VE.getValueID(GV.getInitializer()) + 1));
659 Vals.push_back(getEncodedLinkage(GV));
660 Vals.push_back(Log2_32(GV.getAlignment())+1);
661 Vals.push_back(GV.hasSection() ? SectionMap[GV.getSection()] : 0);
662 if (GV.isThreadLocal() ||
663 GV.getVisibility() != GlobalValue::DefaultVisibility ||
664 GV.hasUnnamedAddr() || GV.isExternallyInitialized() ||
665 GV.getDLLStorageClass() != GlobalValue::DefaultStorageClass ||
667 Vals.push_back(getEncodedVisibility(GV));
668 Vals.push_back(getEncodedThreadLocalMode(GV));
669 Vals.push_back(GV.hasUnnamedAddr());
670 Vals.push_back(GV.isExternallyInitialized());
671 Vals.push_back(getEncodedDLLStorageClass(GV));
672 Vals.push_back(GV.hasComdat() ? VE.getComdatID(GV.getComdat()) : 0);
674 AbbrevToUse = SimpleGVarAbbrev;
677 Stream.EmitRecord(bitc::MODULE_CODE_GLOBALVAR, Vals, AbbrevToUse);
681 // Emit the function proto information.
682 for (const Function &F : *M) {
683 // FUNCTION: [type, callingconv, isproto, linkage, paramattrs, alignment,
684 // section, visibility, gc, unnamed_addr, prologuedata,
685 // dllstorageclass, comdat, prefixdata]
686 Vals.push_back(VE.getTypeID(F.getType()));
687 Vals.push_back(F.getCallingConv());
688 Vals.push_back(F.isDeclaration());
689 Vals.push_back(getEncodedLinkage(F));
690 Vals.push_back(VE.getAttributeID(F.getAttributes()));
691 Vals.push_back(Log2_32(F.getAlignment())+1);
692 Vals.push_back(F.hasSection() ? SectionMap[F.getSection()] : 0);
693 Vals.push_back(getEncodedVisibility(F));
694 Vals.push_back(F.hasGC() ? GCMap[F.getGC()] : 0);
695 Vals.push_back(F.hasUnnamedAddr());
696 Vals.push_back(F.hasPrologueData() ? (VE.getValueID(F.getPrologueData()) + 1)
698 Vals.push_back(getEncodedDLLStorageClass(F));
699 Vals.push_back(F.hasComdat() ? VE.getComdatID(F.getComdat()) : 0);
700 Vals.push_back(F.hasPrefixData() ? (VE.getValueID(F.getPrefixData()) + 1)
703 unsigned AbbrevToUse = 0;
704 Stream.EmitRecord(bitc::MODULE_CODE_FUNCTION, Vals, AbbrevToUse);
708 // Emit the alias information.
709 for (const GlobalAlias &A : M->aliases()) {
710 // ALIAS: [alias type, aliasee val#, linkage, visibility]
711 Vals.push_back(VE.getTypeID(A.getType()));
712 Vals.push_back(VE.getValueID(A.getAliasee()));
713 Vals.push_back(getEncodedLinkage(A));
714 Vals.push_back(getEncodedVisibility(A));
715 Vals.push_back(getEncodedDLLStorageClass(A));
716 Vals.push_back(getEncodedThreadLocalMode(A));
717 Vals.push_back(A.hasUnnamedAddr());
718 unsigned AbbrevToUse = 0;
719 Stream.EmitRecord(bitc::MODULE_CODE_ALIAS, Vals, AbbrevToUse);
724 static uint64_t GetOptimizationFlags(const Value *V) {
727 if (const auto *OBO = dyn_cast<OverflowingBinaryOperator>(V)) {
728 if (OBO->hasNoSignedWrap())
729 Flags |= 1 << bitc::OBO_NO_SIGNED_WRAP;
730 if (OBO->hasNoUnsignedWrap())
731 Flags |= 1 << bitc::OBO_NO_UNSIGNED_WRAP;
732 } else if (const auto *PEO = dyn_cast<PossiblyExactOperator>(V)) {
734 Flags |= 1 << bitc::PEO_EXACT;
735 } else if (const auto *FPMO = dyn_cast<FPMathOperator>(V)) {
736 if (FPMO->hasUnsafeAlgebra())
737 Flags |= FastMathFlags::UnsafeAlgebra;
738 if (FPMO->hasNoNaNs())
739 Flags |= FastMathFlags::NoNaNs;
740 if (FPMO->hasNoInfs())
741 Flags |= FastMathFlags::NoInfs;
742 if (FPMO->hasNoSignedZeros())
743 Flags |= FastMathFlags::NoSignedZeros;
744 if (FPMO->hasAllowReciprocal())
745 Flags |= FastMathFlags::AllowReciprocal;
751 static void WriteValueAsMetadata(const ValueAsMetadata *MD,
752 const ValueEnumerator &VE,
753 BitstreamWriter &Stream,
754 SmallVectorImpl<uint64_t> &Record) {
755 // Mimic an MDNode with a value as one operand.
756 Value *V = MD->getValue();
757 Record.push_back(VE.getTypeID(V->getType()));
758 Record.push_back(VE.getValueID(V));
759 Stream.EmitRecord(bitc::METADATA_VALUE, Record, 0);
763 static void WriteMDNode(const MDNode *N,
764 const ValueEnumerator &VE,
765 BitstreamWriter &Stream,
766 SmallVectorImpl<uint64_t> &Record) {
767 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
768 Metadata *MD = N->getOperand(i);
773 assert(!isa<LocalAsMetadata>(MD) && "Unexpected function-local metadata");
774 Record.push_back(VE.getMetadataID(MD) + 1);
776 Stream.EmitRecord(N->isDistinct() ? bitc::METADATA_DISTINCT_NODE
777 : bitc::METADATA_NODE,
782 static void WriteModuleMetadata(const Module *M,
783 const ValueEnumerator &VE,
784 BitstreamWriter &Stream) {
785 const auto &MDs = VE.getMDs();
786 if (MDs.empty() && M->named_metadata_empty())
789 Stream.EnterSubblock(bitc::METADATA_BLOCK_ID, 3);
791 unsigned MDSAbbrev = 0;
792 if (VE.hasMDString()) {
793 // Abbrev for METADATA_STRING.
794 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
795 Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_STRING));
796 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
797 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
798 MDSAbbrev = Stream.EmitAbbrev(Abbv);
801 SmallVector<uint64_t, 64> Record;
802 for (const Metadata *MD : MDs) {
803 if (const MDNode *N = dyn_cast<MDNode>(MD)) {
804 WriteMDNode(N, VE, Stream, Record);
807 if (const auto *MDC = dyn_cast<ConstantAsMetadata>(MD)) {
808 WriteValueAsMetadata(MDC, VE, Stream, Record);
811 const MDString *MDS = cast<MDString>(MD);
812 // Code: [strchar x N]
813 Record.append(MDS->bytes_begin(), MDS->bytes_end());
815 // Emit the finished record.
816 Stream.EmitRecord(bitc::METADATA_STRING, Record, MDSAbbrev);
820 // Write named metadata.
821 for (const NamedMDNode &NMD : M->named_metadata()) {
823 StringRef Str = NMD.getName();
824 for (unsigned i = 0, e = Str.size(); i != e; ++i)
825 Record.push_back(Str[i]);
826 Stream.EmitRecord(bitc::METADATA_NAME, Record, 0/*TODO*/);
829 // Write named metadata operands.
830 for (unsigned i = 0, e = NMD.getNumOperands(); i != e; ++i)
831 Record.push_back(VE.getMetadataID(NMD.getOperand(i)));
832 Stream.EmitRecord(bitc::METADATA_NAMED_NODE, Record, 0);
839 static void WriteFunctionLocalMetadata(const Function &F,
840 const ValueEnumerator &VE,
841 BitstreamWriter &Stream) {
842 bool StartedMetadataBlock = false;
843 SmallVector<uint64_t, 64> Record;
844 const SmallVectorImpl<const LocalAsMetadata *> &MDs =
845 VE.getFunctionLocalMDs();
846 for (unsigned i = 0, e = MDs.size(); i != e; ++i) {
847 assert(MDs[i] && "Expected valid function-local metadata");
848 if (!StartedMetadataBlock) {
849 Stream.EnterSubblock(bitc::METADATA_BLOCK_ID, 3);
850 StartedMetadataBlock = true;
852 WriteValueAsMetadata(MDs[i], VE, Stream, Record);
855 if (StartedMetadataBlock)
859 static void WriteMetadataAttachment(const Function &F,
860 const ValueEnumerator &VE,
861 BitstreamWriter &Stream) {
862 Stream.EnterSubblock(bitc::METADATA_ATTACHMENT_ID, 3);
864 SmallVector<uint64_t, 64> Record;
866 // Write metadata attachments
867 // METADATA_ATTACHMENT - [m x [value, [n x [id, mdnode]]]
868 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
870 for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
871 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end();
874 I->getAllMetadataOtherThanDebugLoc(MDs);
876 // If no metadata, ignore instruction.
877 if (MDs.empty()) continue;
879 Record.push_back(VE.getInstructionID(I));
881 for (unsigned i = 0, e = MDs.size(); i != e; ++i) {
882 Record.push_back(MDs[i].first);
883 Record.push_back(VE.getMetadataID(MDs[i].second));
885 Stream.EmitRecord(bitc::METADATA_ATTACHMENT, Record, 0);
892 static void WriteModuleMetadataStore(const Module *M, BitstreamWriter &Stream) {
893 SmallVector<uint64_t, 64> Record;
895 // Write metadata kinds
896 // METADATA_KIND - [n x [id, name]]
897 SmallVector<StringRef, 8> Names;
898 M->getMDKindNames(Names);
900 if (Names.empty()) return;
902 Stream.EnterSubblock(bitc::METADATA_BLOCK_ID, 3);
904 for (unsigned MDKindID = 0, e = Names.size(); MDKindID != e; ++MDKindID) {
905 Record.push_back(MDKindID);
906 StringRef KName = Names[MDKindID];
907 Record.append(KName.begin(), KName.end());
909 Stream.EmitRecord(bitc::METADATA_KIND, Record, 0);
916 static void emitSignedInt64(SmallVectorImpl<uint64_t> &Vals, uint64_t V) {
918 Vals.push_back(V << 1);
920 Vals.push_back((-V << 1) | 1);
923 static void WriteConstants(unsigned FirstVal, unsigned LastVal,
924 const ValueEnumerator &VE,
925 BitstreamWriter &Stream, bool isGlobal) {
926 if (FirstVal == LastVal) return;
928 Stream.EnterSubblock(bitc::CONSTANTS_BLOCK_ID, 4);
930 unsigned AggregateAbbrev = 0;
931 unsigned String8Abbrev = 0;
932 unsigned CString7Abbrev = 0;
933 unsigned CString6Abbrev = 0;
934 // If this is a constant pool for the module, emit module-specific abbrevs.
936 // Abbrev for CST_CODE_AGGREGATE.
937 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
938 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_AGGREGATE));
939 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
940 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, Log2_32_Ceil(LastVal+1)));
941 AggregateAbbrev = Stream.EmitAbbrev(Abbv);
943 // Abbrev for CST_CODE_STRING.
944 Abbv = new BitCodeAbbrev();
945 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_STRING));
946 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
947 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
948 String8Abbrev = Stream.EmitAbbrev(Abbv);
949 // Abbrev for CST_CODE_CSTRING.
950 Abbv = new BitCodeAbbrev();
951 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_CSTRING));
952 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
953 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7));
954 CString7Abbrev = Stream.EmitAbbrev(Abbv);
955 // Abbrev for CST_CODE_CSTRING.
956 Abbv = new BitCodeAbbrev();
957 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_CSTRING));
958 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
959 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
960 CString6Abbrev = Stream.EmitAbbrev(Abbv);
963 SmallVector<uint64_t, 64> Record;
965 const ValueEnumerator::ValueList &Vals = VE.getValues();
966 Type *LastTy = nullptr;
967 for (unsigned i = FirstVal; i != LastVal; ++i) {
968 const Value *V = Vals[i].first;
969 // If we need to switch types, do so now.
970 if (V->getType() != LastTy) {
971 LastTy = V->getType();
972 Record.push_back(VE.getTypeID(LastTy));
973 Stream.EmitRecord(bitc::CST_CODE_SETTYPE, Record,
974 CONSTANTS_SETTYPE_ABBREV);
978 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
979 Record.push_back(unsigned(IA->hasSideEffects()) |
980 unsigned(IA->isAlignStack()) << 1 |
981 unsigned(IA->getDialect()&1) << 2);
983 // Add the asm string.
984 const std::string &AsmStr = IA->getAsmString();
985 Record.push_back(AsmStr.size());
986 for (unsigned i = 0, e = AsmStr.size(); i != e; ++i)
987 Record.push_back(AsmStr[i]);
989 // Add the constraint string.
990 const std::string &ConstraintStr = IA->getConstraintString();
991 Record.push_back(ConstraintStr.size());
992 for (unsigned i = 0, e = ConstraintStr.size(); i != e; ++i)
993 Record.push_back(ConstraintStr[i]);
994 Stream.EmitRecord(bitc::CST_CODE_INLINEASM, Record);
998 const Constant *C = cast<Constant>(V);
1000 unsigned AbbrevToUse = 0;
1001 if (C->isNullValue()) {
1002 Code = bitc::CST_CODE_NULL;
1003 } else if (isa<UndefValue>(C)) {
1004 Code = bitc::CST_CODE_UNDEF;
1005 } else if (const ConstantInt *IV = dyn_cast<ConstantInt>(C)) {
1006 if (IV->getBitWidth() <= 64) {
1007 uint64_t V = IV->getSExtValue();
1008 emitSignedInt64(Record, V);
1009 Code = bitc::CST_CODE_INTEGER;
1010 AbbrevToUse = CONSTANTS_INTEGER_ABBREV;
1011 } else { // Wide integers, > 64 bits in size.
1012 // We have an arbitrary precision integer value to write whose
1013 // bit width is > 64. However, in canonical unsigned integer
1014 // format it is likely that the high bits are going to be zero.
1015 // So, we only write the number of active words.
1016 unsigned NWords = IV->getValue().getActiveWords();
1017 const uint64_t *RawWords = IV->getValue().getRawData();
1018 for (unsigned i = 0; i != NWords; ++i) {
1019 emitSignedInt64(Record, RawWords[i]);
1021 Code = bitc::CST_CODE_WIDE_INTEGER;
1023 } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(C)) {
1024 Code = bitc::CST_CODE_FLOAT;
1025 Type *Ty = CFP->getType();
1026 if (Ty->isHalfTy() || Ty->isFloatTy() || Ty->isDoubleTy()) {
1027 Record.push_back(CFP->getValueAPF().bitcastToAPInt().getZExtValue());
1028 } else if (Ty->isX86_FP80Ty()) {
1029 // api needed to prevent premature destruction
1030 // bits are not in the same order as a normal i80 APInt, compensate.
1031 APInt api = CFP->getValueAPF().bitcastToAPInt();
1032 const uint64_t *p = api.getRawData();
1033 Record.push_back((p[1] << 48) | (p[0] >> 16));
1034 Record.push_back(p[0] & 0xffffLL);
1035 } else if (Ty->isFP128Ty() || Ty->isPPC_FP128Ty()) {
1036 APInt api = CFP->getValueAPF().bitcastToAPInt();
1037 const uint64_t *p = api.getRawData();
1038 Record.push_back(p[0]);
1039 Record.push_back(p[1]);
1041 assert (0 && "Unknown FP type!");
1043 } else if (isa<ConstantDataSequential>(C) &&
1044 cast<ConstantDataSequential>(C)->isString()) {
1045 const ConstantDataSequential *Str = cast<ConstantDataSequential>(C);
1046 // Emit constant strings specially.
1047 unsigned NumElts = Str->getNumElements();
1048 // If this is a null-terminated string, use the denser CSTRING encoding.
1049 if (Str->isCString()) {
1050 Code = bitc::CST_CODE_CSTRING;
1051 --NumElts; // Don't encode the null, which isn't allowed by char6.
1053 Code = bitc::CST_CODE_STRING;
1054 AbbrevToUse = String8Abbrev;
1056 bool isCStr7 = Code == bitc::CST_CODE_CSTRING;
1057 bool isCStrChar6 = Code == bitc::CST_CODE_CSTRING;
1058 for (unsigned i = 0; i != NumElts; ++i) {
1059 unsigned char V = Str->getElementAsInteger(i);
1060 Record.push_back(V);
1061 isCStr7 &= (V & 128) == 0;
1063 isCStrChar6 = BitCodeAbbrevOp::isChar6(V);
1067 AbbrevToUse = CString6Abbrev;
1069 AbbrevToUse = CString7Abbrev;
1070 } else if (const ConstantDataSequential *CDS =
1071 dyn_cast<ConstantDataSequential>(C)) {
1072 Code = bitc::CST_CODE_DATA;
1073 Type *EltTy = CDS->getType()->getElementType();
1074 if (isa<IntegerType>(EltTy)) {
1075 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i)
1076 Record.push_back(CDS->getElementAsInteger(i));
1077 } else if (EltTy->isFloatTy()) {
1078 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1079 union { float F; uint32_t I; };
1080 F = CDS->getElementAsFloat(i);
1081 Record.push_back(I);
1084 assert(EltTy->isDoubleTy() && "Unknown ConstantData element type");
1085 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1086 union { double F; uint64_t I; };
1087 F = CDS->getElementAsDouble(i);
1088 Record.push_back(I);
1091 } else if (isa<ConstantArray>(C) || isa<ConstantStruct>(C) ||
1092 isa<ConstantVector>(C)) {
1093 Code = bitc::CST_CODE_AGGREGATE;
1094 for (unsigned i = 0, e = C->getNumOperands(); i != e; ++i)
1095 Record.push_back(VE.getValueID(C->getOperand(i)));
1096 AbbrevToUse = AggregateAbbrev;
1097 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
1098 switch (CE->getOpcode()) {
1100 if (Instruction::isCast(CE->getOpcode())) {
1101 Code = bitc::CST_CODE_CE_CAST;
1102 Record.push_back(GetEncodedCastOpcode(CE->getOpcode()));
1103 Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
1104 Record.push_back(VE.getValueID(C->getOperand(0)));
1105 AbbrevToUse = CONSTANTS_CE_CAST_Abbrev;
1107 assert(CE->getNumOperands() == 2 && "Unknown constant expr!");
1108 Code = bitc::CST_CODE_CE_BINOP;
1109 Record.push_back(GetEncodedBinaryOpcode(CE->getOpcode()));
1110 Record.push_back(VE.getValueID(C->getOperand(0)));
1111 Record.push_back(VE.getValueID(C->getOperand(1)));
1112 uint64_t Flags = GetOptimizationFlags(CE);
1114 Record.push_back(Flags);
1117 case Instruction::GetElementPtr:
1118 Code = bitc::CST_CODE_CE_GEP;
1119 if (cast<GEPOperator>(C)->isInBounds())
1120 Code = bitc::CST_CODE_CE_INBOUNDS_GEP;
1121 for (unsigned i = 0, e = CE->getNumOperands(); i != e; ++i) {
1122 Record.push_back(VE.getTypeID(C->getOperand(i)->getType()));
1123 Record.push_back(VE.getValueID(C->getOperand(i)));
1126 case Instruction::Select:
1127 Code = bitc::CST_CODE_CE_SELECT;
1128 Record.push_back(VE.getValueID(C->getOperand(0)));
1129 Record.push_back(VE.getValueID(C->getOperand(1)));
1130 Record.push_back(VE.getValueID(C->getOperand(2)));
1132 case Instruction::ExtractElement:
1133 Code = bitc::CST_CODE_CE_EXTRACTELT;
1134 Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
1135 Record.push_back(VE.getValueID(C->getOperand(0)));
1136 Record.push_back(VE.getTypeID(C->getOperand(1)->getType()));
1137 Record.push_back(VE.getValueID(C->getOperand(1)));
1139 case Instruction::InsertElement:
1140 Code = bitc::CST_CODE_CE_INSERTELT;
1141 Record.push_back(VE.getValueID(C->getOperand(0)));
1142 Record.push_back(VE.getValueID(C->getOperand(1)));
1143 Record.push_back(VE.getTypeID(C->getOperand(2)->getType()));
1144 Record.push_back(VE.getValueID(C->getOperand(2)));
1146 case Instruction::ShuffleVector:
1147 // If the return type and argument types are the same, this is a
1148 // standard shufflevector instruction. If the types are different,
1149 // then the shuffle is widening or truncating the input vectors, and
1150 // the argument type must also be encoded.
1151 if (C->getType() == C->getOperand(0)->getType()) {
1152 Code = bitc::CST_CODE_CE_SHUFFLEVEC;
1154 Code = bitc::CST_CODE_CE_SHUFVEC_EX;
1155 Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
1157 Record.push_back(VE.getValueID(C->getOperand(0)));
1158 Record.push_back(VE.getValueID(C->getOperand(1)));
1159 Record.push_back(VE.getValueID(C->getOperand(2)));
1161 case Instruction::ICmp:
1162 case Instruction::FCmp:
1163 Code = bitc::CST_CODE_CE_CMP;
1164 Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
1165 Record.push_back(VE.getValueID(C->getOperand(0)));
1166 Record.push_back(VE.getValueID(C->getOperand(1)));
1167 Record.push_back(CE->getPredicate());
1170 } else if (const BlockAddress *BA = dyn_cast<BlockAddress>(C)) {
1171 Code = bitc::CST_CODE_BLOCKADDRESS;
1172 Record.push_back(VE.getTypeID(BA->getFunction()->getType()));
1173 Record.push_back(VE.getValueID(BA->getFunction()));
1174 Record.push_back(VE.getGlobalBasicBlockID(BA->getBasicBlock()));
1179 llvm_unreachable("Unknown constant!");
1181 Stream.EmitRecord(Code, Record, AbbrevToUse);
1188 static void WriteModuleConstants(const ValueEnumerator &VE,
1189 BitstreamWriter &Stream) {
1190 const ValueEnumerator::ValueList &Vals = VE.getValues();
1192 // Find the first constant to emit, which is the first non-globalvalue value.
1193 // We know globalvalues have been emitted by WriteModuleInfo.
1194 for (unsigned i = 0, e = Vals.size(); i != e; ++i) {
1195 if (!isa<GlobalValue>(Vals[i].first)) {
1196 WriteConstants(i, Vals.size(), VE, Stream, true);
1202 /// PushValueAndType - The file has to encode both the value and type id for
1203 /// many values, because we need to know what type to create for forward
1204 /// references. However, most operands are not forward references, so this type
1205 /// field is not needed.
1207 /// This function adds V's value ID to Vals. If the value ID is higher than the
1208 /// instruction ID, then it is a forward reference, and it also includes the
1209 /// type ID. The value ID that is written is encoded relative to the InstID.
1210 static bool PushValueAndType(const Value *V, unsigned InstID,
1211 SmallVectorImpl<unsigned> &Vals,
1212 ValueEnumerator &VE) {
1213 unsigned ValID = VE.getValueID(V);
1214 // Make encoding relative to the InstID.
1215 Vals.push_back(InstID - ValID);
1216 if (ValID >= InstID) {
1217 Vals.push_back(VE.getTypeID(V->getType()));
1223 /// pushValue - Like PushValueAndType, but where the type of the value is
1224 /// omitted (perhaps it was already encoded in an earlier operand).
1225 static void pushValue(const Value *V, unsigned InstID,
1226 SmallVectorImpl<unsigned> &Vals,
1227 ValueEnumerator &VE) {
1228 unsigned ValID = VE.getValueID(V);
1229 Vals.push_back(InstID - ValID);
1232 static void pushValueSigned(const Value *V, unsigned InstID,
1233 SmallVectorImpl<uint64_t> &Vals,
1234 ValueEnumerator &VE) {
1235 unsigned ValID = VE.getValueID(V);
1236 int64_t diff = ((int32_t)InstID - (int32_t)ValID);
1237 emitSignedInt64(Vals, diff);
1240 /// WriteInstruction - Emit an instruction to the specified stream.
1241 static void WriteInstruction(const Instruction &I, unsigned InstID,
1242 ValueEnumerator &VE, BitstreamWriter &Stream,
1243 SmallVectorImpl<unsigned> &Vals) {
1245 unsigned AbbrevToUse = 0;
1246 VE.setInstructionID(&I);
1247 switch (I.getOpcode()) {
1249 if (Instruction::isCast(I.getOpcode())) {
1250 Code = bitc::FUNC_CODE_INST_CAST;
1251 if (!PushValueAndType(I.getOperand(0), InstID, Vals, VE))
1252 AbbrevToUse = FUNCTION_INST_CAST_ABBREV;
1253 Vals.push_back(VE.getTypeID(I.getType()));
1254 Vals.push_back(GetEncodedCastOpcode(I.getOpcode()));
1256 assert(isa<BinaryOperator>(I) && "Unknown instruction!");
1257 Code = bitc::FUNC_CODE_INST_BINOP;
1258 if (!PushValueAndType(I.getOperand(0), InstID, Vals, VE))
1259 AbbrevToUse = FUNCTION_INST_BINOP_ABBREV;
1260 pushValue(I.getOperand(1), InstID, Vals, VE);
1261 Vals.push_back(GetEncodedBinaryOpcode(I.getOpcode()));
1262 uint64_t Flags = GetOptimizationFlags(&I);
1264 if (AbbrevToUse == FUNCTION_INST_BINOP_ABBREV)
1265 AbbrevToUse = FUNCTION_INST_BINOP_FLAGS_ABBREV;
1266 Vals.push_back(Flags);
1271 case Instruction::GetElementPtr:
1272 Code = bitc::FUNC_CODE_INST_GEP;
1273 if (cast<GEPOperator>(&I)->isInBounds())
1274 Code = bitc::FUNC_CODE_INST_INBOUNDS_GEP;
1275 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
1276 PushValueAndType(I.getOperand(i), InstID, Vals, VE);
1278 case Instruction::ExtractValue: {
1279 Code = bitc::FUNC_CODE_INST_EXTRACTVAL;
1280 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1281 const ExtractValueInst *EVI = cast<ExtractValueInst>(&I);
1282 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
1286 case Instruction::InsertValue: {
1287 Code = bitc::FUNC_CODE_INST_INSERTVAL;
1288 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1289 PushValueAndType(I.getOperand(1), InstID, Vals, VE);
1290 const InsertValueInst *IVI = cast<InsertValueInst>(&I);
1291 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
1295 case Instruction::Select:
1296 Code = bitc::FUNC_CODE_INST_VSELECT;
1297 PushValueAndType(I.getOperand(1), InstID, Vals, VE);
1298 pushValue(I.getOperand(2), InstID, Vals, VE);
1299 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1301 case Instruction::ExtractElement:
1302 Code = bitc::FUNC_CODE_INST_EXTRACTELT;
1303 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1304 PushValueAndType(I.getOperand(1), InstID, Vals, VE);
1306 case Instruction::InsertElement:
1307 Code = bitc::FUNC_CODE_INST_INSERTELT;
1308 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1309 pushValue(I.getOperand(1), InstID, Vals, VE);
1310 PushValueAndType(I.getOperand(2), InstID, Vals, VE);
1312 case Instruction::ShuffleVector:
1313 Code = bitc::FUNC_CODE_INST_SHUFFLEVEC;
1314 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1315 pushValue(I.getOperand(1), InstID, Vals, VE);
1316 pushValue(I.getOperand(2), InstID, Vals, VE);
1318 case Instruction::ICmp:
1319 case Instruction::FCmp:
1320 // compare returning Int1Ty or vector of Int1Ty
1321 Code = bitc::FUNC_CODE_INST_CMP2;
1322 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1323 pushValue(I.getOperand(1), InstID, Vals, VE);
1324 Vals.push_back(cast<CmpInst>(I).getPredicate());
1327 case Instruction::Ret:
1329 Code = bitc::FUNC_CODE_INST_RET;
1330 unsigned NumOperands = I.getNumOperands();
1331 if (NumOperands == 0)
1332 AbbrevToUse = FUNCTION_INST_RET_VOID_ABBREV;
1333 else if (NumOperands == 1) {
1334 if (!PushValueAndType(I.getOperand(0), InstID, Vals, VE))
1335 AbbrevToUse = FUNCTION_INST_RET_VAL_ABBREV;
1337 for (unsigned i = 0, e = NumOperands; i != e; ++i)
1338 PushValueAndType(I.getOperand(i), InstID, Vals, VE);
1342 case Instruction::Br:
1344 Code = bitc::FUNC_CODE_INST_BR;
1345 const BranchInst &II = cast<BranchInst>(I);
1346 Vals.push_back(VE.getValueID(II.getSuccessor(0)));
1347 if (II.isConditional()) {
1348 Vals.push_back(VE.getValueID(II.getSuccessor(1)));
1349 pushValue(II.getCondition(), InstID, Vals, VE);
1353 case Instruction::Switch:
1355 Code = bitc::FUNC_CODE_INST_SWITCH;
1356 const SwitchInst &SI = cast<SwitchInst>(I);
1357 Vals.push_back(VE.getTypeID(SI.getCondition()->getType()));
1358 pushValue(SI.getCondition(), InstID, Vals, VE);
1359 Vals.push_back(VE.getValueID(SI.getDefaultDest()));
1360 for (SwitchInst::ConstCaseIt i = SI.case_begin(), e = SI.case_end();
1362 Vals.push_back(VE.getValueID(i.getCaseValue()));
1363 Vals.push_back(VE.getValueID(i.getCaseSuccessor()));
1367 case Instruction::IndirectBr:
1368 Code = bitc::FUNC_CODE_INST_INDIRECTBR;
1369 Vals.push_back(VE.getTypeID(I.getOperand(0)->getType()));
1370 // Encode the address operand as relative, but not the basic blocks.
1371 pushValue(I.getOperand(0), InstID, Vals, VE);
1372 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i)
1373 Vals.push_back(VE.getValueID(I.getOperand(i)));
1376 case Instruction::Invoke: {
1377 const InvokeInst *II = cast<InvokeInst>(&I);
1378 const Value *Callee(II->getCalledValue());
1379 PointerType *PTy = cast<PointerType>(Callee->getType());
1380 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1381 Code = bitc::FUNC_CODE_INST_INVOKE;
1383 Vals.push_back(VE.getAttributeID(II->getAttributes()));
1384 Vals.push_back(II->getCallingConv());
1385 Vals.push_back(VE.getValueID(II->getNormalDest()));
1386 Vals.push_back(VE.getValueID(II->getUnwindDest()));
1387 PushValueAndType(Callee, InstID, Vals, VE);
1389 // Emit value #'s for the fixed parameters.
1390 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
1391 pushValue(I.getOperand(i), InstID, Vals, VE); // fixed param.
1393 // Emit type/value pairs for varargs params.
1394 if (FTy->isVarArg()) {
1395 for (unsigned i = FTy->getNumParams(), e = I.getNumOperands()-3;
1397 PushValueAndType(I.getOperand(i), InstID, Vals, VE); // vararg
1401 case Instruction::Resume:
1402 Code = bitc::FUNC_CODE_INST_RESUME;
1403 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1405 case Instruction::Unreachable:
1406 Code = bitc::FUNC_CODE_INST_UNREACHABLE;
1407 AbbrevToUse = FUNCTION_INST_UNREACHABLE_ABBREV;
1410 case Instruction::PHI: {
1411 const PHINode &PN = cast<PHINode>(I);
1412 Code = bitc::FUNC_CODE_INST_PHI;
1413 // With the newer instruction encoding, forward references could give
1414 // negative valued IDs. This is most common for PHIs, so we use
1416 SmallVector<uint64_t, 128> Vals64;
1417 Vals64.push_back(VE.getTypeID(PN.getType()));
1418 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
1419 pushValueSigned(PN.getIncomingValue(i), InstID, Vals64, VE);
1420 Vals64.push_back(VE.getValueID(PN.getIncomingBlock(i)));
1422 // Emit a Vals64 vector and exit.
1423 Stream.EmitRecord(Code, Vals64, AbbrevToUse);
1428 case Instruction::LandingPad: {
1429 const LandingPadInst &LP = cast<LandingPadInst>(I);
1430 Code = bitc::FUNC_CODE_INST_LANDINGPAD;
1431 Vals.push_back(VE.getTypeID(LP.getType()));
1432 PushValueAndType(LP.getPersonalityFn(), InstID, Vals, VE);
1433 Vals.push_back(LP.isCleanup());
1434 Vals.push_back(LP.getNumClauses());
1435 for (unsigned I = 0, E = LP.getNumClauses(); I != E; ++I) {
1437 Vals.push_back(LandingPadInst::Catch);
1439 Vals.push_back(LandingPadInst::Filter);
1440 PushValueAndType(LP.getClause(I), InstID, Vals, VE);
1445 case Instruction::Alloca: {
1446 Code = bitc::FUNC_CODE_INST_ALLOCA;
1447 Vals.push_back(VE.getTypeID(I.getType()));
1448 Vals.push_back(VE.getTypeID(I.getOperand(0)->getType()));
1449 Vals.push_back(VE.getValueID(I.getOperand(0))); // size.
1450 const AllocaInst &AI = cast<AllocaInst>(I);
1451 unsigned AlignRecord = Log2_32(AI.getAlignment()) + 1;
1452 assert(Log2_32(Value::MaximumAlignment) + 1 < 1 << 5 &&
1453 "not enough bits for maximum alignment");
1454 assert(AlignRecord < 1 << 5 && "alignment greater than 1 << 64");
1455 AlignRecord |= AI.isUsedWithInAlloca() << 5;
1456 Vals.push_back(AlignRecord);
1460 case Instruction::Load:
1461 if (cast<LoadInst>(I).isAtomic()) {
1462 Code = bitc::FUNC_CODE_INST_LOADATOMIC;
1463 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1465 Code = bitc::FUNC_CODE_INST_LOAD;
1466 if (!PushValueAndType(I.getOperand(0), InstID, Vals, VE)) // ptr
1467 AbbrevToUse = FUNCTION_INST_LOAD_ABBREV;
1469 Vals.push_back(Log2_32(cast<LoadInst>(I).getAlignment())+1);
1470 Vals.push_back(cast<LoadInst>(I).isVolatile());
1471 if (cast<LoadInst>(I).isAtomic()) {
1472 Vals.push_back(GetEncodedOrdering(cast<LoadInst>(I).getOrdering()));
1473 Vals.push_back(GetEncodedSynchScope(cast<LoadInst>(I).getSynchScope()));
1476 case Instruction::Store:
1477 if (cast<StoreInst>(I).isAtomic())
1478 Code = bitc::FUNC_CODE_INST_STOREATOMIC;
1480 Code = bitc::FUNC_CODE_INST_STORE;
1481 PushValueAndType(I.getOperand(1), InstID, Vals, VE); // ptrty + ptr
1482 pushValue(I.getOperand(0), InstID, Vals, VE); // val.
1483 Vals.push_back(Log2_32(cast<StoreInst>(I).getAlignment())+1);
1484 Vals.push_back(cast<StoreInst>(I).isVolatile());
1485 if (cast<StoreInst>(I).isAtomic()) {
1486 Vals.push_back(GetEncodedOrdering(cast<StoreInst>(I).getOrdering()));
1487 Vals.push_back(GetEncodedSynchScope(cast<StoreInst>(I).getSynchScope()));
1490 case Instruction::AtomicCmpXchg:
1491 Code = bitc::FUNC_CODE_INST_CMPXCHG;
1492 PushValueAndType(I.getOperand(0), InstID, Vals, VE); // ptrty + ptr
1493 pushValue(I.getOperand(1), InstID, Vals, VE); // cmp.
1494 pushValue(I.getOperand(2), InstID, Vals, VE); // newval.
1495 Vals.push_back(cast<AtomicCmpXchgInst>(I).isVolatile());
1496 Vals.push_back(GetEncodedOrdering(
1497 cast<AtomicCmpXchgInst>(I).getSuccessOrdering()));
1498 Vals.push_back(GetEncodedSynchScope(
1499 cast<AtomicCmpXchgInst>(I).getSynchScope()));
1500 Vals.push_back(GetEncodedOrdering(
1501 cast<AtomicCmpXchgInst>(I).getFailureOrdering()));
1502 Vals.push_back(cast<AtomicCmpXchgInst>(I).isWeak());
1504 case Instruction::AtomicRMW:
1505 Code = bitc::FUNC_CODE_INST_ATOMICRMW;
1506 PushValueAndType(I.getOperand(0), InstID, Vals, VE); // ptrty + ptr
1507 pushValue(I.getOperand(1), InstID, Vals, VE); // val.
1508 Vals.push_back(GetEncodedRMWOperation(
1509 cast<AtomicRMWInst>(I).getOperation()));
1510 Vals.push_back(cast<AtomicRMWInst>(I).isVolatile());
1511 Vals.push_back(GetEncodedOrdering(cast<AtomicRMWInst>(I).getOrdering()));
1512 Vals.push_back(GetEncodedSynchScope(
1513 cast<AtomicRMWInst>(I).getSynchScope()));
1515 case Instruction::Fence:
1516 Code = bitc::FUNC_CODE_INST_FENCE;
1517 Vals.push_back(GetEncodedOrdering(cast<FenceInst>(I).getOrdering()));
1518 Vals.push_back(GetEncodedSynchScope(cast<FenceInst>(I).getSynchScope()));
1520 case Instruction::Call: {
1521 const CallInst &CI = cast<CallInst>(I);
1522 PointerType *PTy = cast<PointerType>(CI.getCalledValue()->getType());
1523 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1525 Code = bitc::FUNC_CODE_INST_CALL;
1527 Vals.push_back(VE.getAttributeID(CI.getAttributes()));
1528 Vals.push_back((CI.getCallingConv() << 1) | unsigned(CI.isTailCall()) |
1529 unsigned(CI.isMustTailCall()) << 14);
1530 PushValueAndType(CI.getCalledValue(), InstID, Vals, VE); // Callee
1532 // Emit value #'s for the fixed parameters.
1533 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) {
1534 // Check for labels (can happen with asm labels).
1535 if (FTy->getParamType(i)->isLabelTy())
1536 Vals.push_back(VE.getValueID(CI.getArgOperand(i)));
1538 pushValue(CI.getArgOperand(i), InstID, Vals, VE); // fixed param.
1541 // Emit type/value pairs for varargs params.
1542 if (FTy->isVarArg()) {
1543 for (unsigned i = FTy->getNumParams(), e = CI.getNumArgOperands();
1545 PushValueAndType(CI.getArgOperand(i), InstID, Vals, VE); // varargs
1549 case Instruction::VAArg:
1550 Code = bitc::FUNC_CODE_INST_VAARG;
1551 Vals.push_back(VE.getTypeID(I.getOperand(0)->getType())); // valistty
1552 pushValue(I.getOperand(0), InstID, Vals, VE); // valist.
1553 Vals.push_back(VE.getTypeID(I.getType())); // restype.
1557 Stream.EmitRecord(Code, Vals, AbbrevToUse);
1561 // Emit names for globals/functions etc.
1562 static void WriteValueSymbolTable(const ValueSymbolTable &VST,
1563 const ValueEnumerator &VE,
1564 BitstreamWriter &Stream) {
1565 if (VST.empty()) return;
1566 Stream.EnterSubblock(bitc::VALUE_SYMTAB_BLOCK_ID, 4);
1568 // FIXME: Set up the abbrev, we know how many values there are!
1569 // FIXME: We know if the type names can use 7-bit ascii.
1570 SmallVector<unsigned, 64> NameVals;
1572 for (ValueSymbolTable::const_iterator SI = VST.begin(), SE = VST.end();
1575 const ValueName &Name = *SI;
1577 // Figure out the encoding to use for the name.
1579 bool isChar6 = true;
1580 for (const char *C = Name.getKeyData(), *E = C+Name.getKeyLength();
1583 isChar6 = BitCodeAbbrevOp::isChar6(*C);
1584 if ((unsigned char)*C & 128) {
1586 break; // don't bother scanning the rest.
1590 unsigned AbbrevToUse = VST_ENTRY_8_ABBREV;
1592 // VST_ENTRY: [valueid, namechar x N]
1593 // VST_BBENTRY: [bbid, namechar x N]
1595 if (isa<BasicBlock>(SI->getValue())) {
1596 Code = bitc::VST_CODE_BBENTRY;
1598 AbbrevToUse = VST_BBENTRY_6_ABBREV;
1600 Code = bitc::VST_CODE_ENTRY;
1602 AbbrevToUse = VST_ENTRY_6_ABBREV;
1604 AbbrevToUse = VST_ENTRY_7_ABBREV;
1607 NameVals.push_back(VE.getValueID(SI->getValue()));
1608 for (const char *P = Name.getKeyData(),
1609 *E = Name.getKeyData()+Name.getKeyLength(); P != E; ++P)
1610 NameVals.push_back((unsigned char)*P);
1612 // Emit the finished record.
1613 Stream.EmitRecord(Code, NameVals, AbbrevToUse);
1619 static void WriteUseList(ValueEnumerator &VE, UseListOrder &&Order,
1620 BitstreamWriter &Stream) {
1621 assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
1623 if (isa<BasicBlock>(Order.V))
1624 Code = bitc::USELIST_CODE_BB;
1626 Code = bitc::USELIST_CODE_DEFAULT;
1628 SmallVector<uint64_t, 64> Record;
1629 for (unsigned I : Order.Shuffle)
1630 Record.push_back(I);
1631 Record.push_back(VE.getValueID(Order.V));
1632 Stream.EmitRecord(Code, Record);
1635 static void WriteUseListBlock(const Function *F, ValueEnumerator &VE,
1636 BitstreamWriter &Stream) {
1637 auto hasMore = [&]() {
1638 return !VE.UseListOrders.empty() && VE.UseListOrders.back().F == F;
1644 Stream.EnterSubblock(bitc::USELIST_BLOCK_ID, 3);
1646 WriteUseList(VE, std::move(VE.UseListOrders.back()), Stream);
1647 VE.UseListOrders.pop_back();
1652 /// WriteFunction - Emit a function body to the module stream.
1653 static void WriteFunction(const Function &F, ValueEnumerator &VE,
1654 BitstreamWriter &Stream) {
1655 Stream.EnterSubblock(bitc::FUNCTION_BLOCK_ID, 4);
1656 VE.incorporateFunction(F);
1658 SmallVector<unsigned, 64> Vals;
1660 // Emit the number of basic blocks, so the reader can create them ahead of
1662 Vals.push_back(VE.getBasicBlocks().size());
1663 Stream.EmitRecord(bitc::FUNC_CODE_DECLAREBLOCKS, Vals);
1666 // If there are function-local constants, emit them now.
1667 unsigned CstStart, CstEnd;
1668 VE.getFunctionConstantRange(CstStart, CstEnd);
1669 WriteConstants(CstStart, CstEnd, VE, Stream, false);
1671 // If there is function-local metadata, emit it now.
1672 WriteFunctionLocalMetadata(F, VE, Stream);
1674 // Keep a running idea of what the instruction ID is.
1675 unsigned InstID = CstEnd;
1677 bool NeedsMetadataAttachment = false;
1681 // Finally, emit all the instructions, in order.
1682 for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
1683 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end();
1685 WriteInstruction(*I, InstID, VE, Stream, Vals);
1687 if (!I->getType()->isVoidTy())
1690 // If the instruction has metadata, write a metadata attachment later.
1691 NeedsMetadataAttachment |= I->hasMetadataOtherThanDebugLoc();
1693 // If the instruction has a debug location, emit it.
1694 DebugLoc DL = I->getDebugLoc();
1695 if (DL.isUnknown()) {
1697 } else if (DL == LastDL) {
1698 // Just repeat the same debug loc as last time.
1699 Stream.EmitRecord(bitc::FUNC_CODE_DEBUG_LOC_AGAIN, Vals);
1702 DL.getScopeAndInlinedAt(Scope, IA, I->getContext());
1703 assert(Scope && "Expected valid scope");
1705 Vals.push_back(DL.getLine());
1706 Vals.push_back(DL.getCol());
1707 Vals.push_back(Scope ? VE.getMetadataID(Scope) + 1 : 0);
1708 Vals.push_back(IA ? VE.getMetadataID(IA) + 1 : 0);
1709 Stream.EmitRecord(bitc::FUNC_CODE_DEBUG_LOC, Vals);
1716 // Emit names for all the instructions etc.
1717 WriteValueSymbolTable(F.getValueSymbolTable(), VE, Stream);
1719 if (NeedsMetadataAttachment)
1720 WriteMetadataAttachment(F, VE, Stream);
1721 if (shouldPreserveBitcodeUseListOrder())
1722 WriteUseListBlock(&F, VE, Stream);
1727 // Emit blockinfo, which defines the standard abbreviations etc.
1728 static void WriteBlockInfo(const ValueEnumerator &VE, BitstreamWriter &Stream) {
1729 // We only want to emit block info records for blocks that have multiple
1730 // instances: CONSTANTS_BLOCK, FUNCTION_BLOCK and VALUE_SYMTAB_BLOCK.
1731 // Other blocks can define their abbrevs inline.
1732 Stream.EnterBlockInfoBlock(2);
1734 { // 8-bit fixed-width VST_ENTRY/VST_BBENTRY strings.
1735 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1736 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3));
1737 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
1738 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1739 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
1740 if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
1741 Abbv) != VST_ENTRY_8_ABBREV)
1742 llvm_unreachable("Unexpected abbrev ordering!");
1745 { // 7-bit fixed width VST_ENTRY strings.
1746 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1747 Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_ENTRY));
1748 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
1749 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1750 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7));
1751 if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
1752 Abbv) != VST_ENTRY_7_ABBREV)
1753 llvm_unreachable("Unexpected abbrev ordering!");
1755 { // 6-bit char6 VST_ENTRY strings.
1756 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1757 Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_ENTRY));
1758 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
1759 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1760 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
1761 if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
1762 Abbv) != VST_ENTRY_6_ABBREV)
1763 llvm_unreachable("Unexpected abbrev ordering!");
1765 { // 6-bit char6 VST_BBENTRY strings.
1766 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1767 Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_BBENTRY));
1768 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
1769 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1770 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
1771 if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
1772 Abbv) != VST_BBENTRY_6_ABBREV)
1773 llvm_unreachable("Unexpected abbrev ordering!");
1778 { // SETTYPE abbrev for CONSTANTS_BLOCK.
1779 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1780 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_SETTYPE));
1781 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
1782 Log2_32_Ceil(VE.getTypes().size()+1)));
1783 if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
1784 Abbv) != CONSTANTS_SETTYPE_ABBREV)
1785 llvm_unreachable("Unexpected abbrev ordering!");
1788 { // INTEGER abbrev for CONSTANTS_BLOCK.
1789 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1790 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_INTEGER));
1791 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
1792 if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
1793 Abbv) != CONSTANTS_INTEGER_ABBREV)
1794 llvm_unreachable("Unexpected abbrev ordering!");
1797 { // CE_CAST abbrev for CONSTANTS_BLOCK.
1798 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1799 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_CE_CAST));
1800 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // cast opc
1801 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, // typeid
1802 Log2_32_Ceil(VE.getTypes().size()+1)));
1803 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // value id
1805 if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
1806 Abbv) != CONSTANTS_CE_CAST_Abbrev)
1807 llvm_unreachable("Unexpected abbrev ordering!");
1809 { // NULL abbrev for CONSTANTS_BLOCK.
1810 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1811 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_NULL));
1812 if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
1813 Abbv) != CONSTANTS_NULL_Abbrev)
1814 llvm_unreachable("Unexpected abbrev ordering!");
1817 // FIXME: This should only use space for first class types!
1819 { // INST_LOAD abbrev for FUNCTION_BLOCK.
1820 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1821 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_LOAD));
1822 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Ptr
1823 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // Align
1824 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // volatile
1825 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
1826 Abbv) != FUNCTION_INST_LOAD_ABBREV)
1827 llvm_unreachable("Unexpected abbrev ordering!");
1829 { // INST_BINOP abbrev for FUNCTION_BLOCK.
1830 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1831 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_BINOP));
1832 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LHS
1833 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // RHS
1834 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // opc
1835 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
1836 Abbv) != FUNCTION_INST_BINOP_ABBREV)
1837 llvm_unreachable("Unexpected abbrev ordering!");
1839 { // INST_BINOP_FLAGS abbrev for FUNCTION_BLOCK.
1840 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1841 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_BINOP));
1842 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LHS
1843 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // RHS
1844 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // opc
1845 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7)); // flags
1846 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
1847 Abbv) != FUNCTION_INST_BINOP_FLAGS_ABBREV)
1848 llvm_unreachable("Unexpected abbrev ordering!");
1850 { // INST_CAST abbrev for FUNCTION_BLOCK.
1851 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1852 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_CAST));
1853 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // OpVal
1854 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, // dest ty
1855 Log2_32_Ceil(VE.getTypes().size()+1)));
1856 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // opc
1857 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
1858 Abbv) != FUNCTION_INST_CAST_ABBREV)
1859 llvm_unreachable("Unexpected abbrev ordering!");
1862 { // INST_RET abbrev for FUNCTION_BLOCK.
1863 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1864 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_RET));
1865 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
1866 Abbv) != FUNCTION_INST_RET_VOID_ABBREV)
1867 llvm_unreachable("Unexpected abbrev ordering!");
1869 { // INST_RET abbrev for FUNCTION_BLOCK.
1870 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1871 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_RET));
1872 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ValID
1873 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
1874 Abbv) != FUNCTION_INST_RET_VAL_ABBREV)
1875 llvm_unreachable("Unexpected abbrev ordering!");
1877 { // INST_UNREACHABLE abbrev for FUNCTION_BLOCK.
1878 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1879 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_UNREACHABLE));
1880 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
1881 Abbv) != FUNCTION_INST_UNREACHABLE_ABBREV)
1882 llvm_unreachable("Unexpected abbrev ordering!");
1888 /// WriteModule - Emit the specified module to the bitstream.
1889 static void WriteModule(const Module *M, BitstreamWriter &Stream) {
1890 Stream.EnterSubblock(bitc::MODULE_BLOCK_ID, 3);
1892 SmallVector<unsigned, 1> Vals;
1893 unsigned CurVersion = 1;
1894 Vals.push_back(CurVersion);
1895 Stream.EmitRecord(bitc::MODULE_CODE_VERSION, Vals);
1897 // Analyze the module, enumerating globals, functions, etc.
1898 ValueEnumerator VE(*M);
1900 // Emit blockinfo, which defines the standard abbreviations etc.
1901 WriteBlockInfo(VE, Stream);
1903 // Emit information about attribute groups.
1904 WriteAttributeGroupTable(VE, Stream);
1906 // Emit information about parameter attributes.
1907 WriteAttributeTable(VE, Stream);
1909 // Emit information describing all of the types in the module.
1910 WriteTypeTable(VE, Stream);
1912 writeComdats(VE, Stream);
1914 // Emit top-level description of module, including target triple, inline asm,
1915 // descriptors for global variables, and function prototype info.
1916 WriteModuleInfo(M, VE, Stream);
1919 WriteModuleConstants(VE, Stream);
1922 WriteModuleMetadata(M, VE, Stream);
1925 WriteModuleMetadataStore(M, Stream);
1927 // Emit names for globals/functions etc.
1928 WriteValueSymbolTable(M->getValueSymbolTable(), VE, Stream);
1930 // Emit module-level use-lists.
1931 if (shouldPreserveBitcodeUseListOrder())
1932 WriteUseListBlock(nullptr, VE, Stream);
1934 // Emit function bodies.
1935 for (Module::const_iterator F = M->begin(), E = M->end(); F != E; ++F)
1936 if (!F->isDeclaration())
1937 WriteFunction(*F, VE, Stream);
1942 /// EmitDarwinBCHeader - If generating a bc file on darwin, we have to emit a
1943 /// header and trailer to make it compatible with the system archiver. To do
1944 /// this we emit the following header, and then emit a trailer that pads the
1945 /// file out to be a multiple of 16 bytes.
1947 /// struct bc_header {
1948 /// uint32_t Magic; // 0x0B17C0DE
1949 /// uint32_t Version; // Version, currently always 0.
1950 /// uint32_t BitcodeOffset; // Offset to traditional bitcode file.
1951 /// uint32_t BitcodeSize; // Size of traditional bitcode file.
1952 /// uint32_t CPUType; // CPU specifier.
1953 /// ... potentially more later ...
1956 DarwinBCSizeFieldOffset = 3*4, // Offset to bitcode_size.
1957 DarwinBCHeaderSize = 5*4
1960 static void WriteInt32ToBuffer(uint32_t Value, SmallVectorImpl<char> &Buffer,
1961 uint32_t &Position) {
1962 Buffer[Position + 0] = (unsigned char) (Value >> 0);
1963 Buffer[Position + 1] = (unsigned char) (Value >> 8);
1964 Buffer[Position + 2] = (unsigned char) (Value >> 16);
1965 Buffer[Position + 3] = (unsigned char) (Value >> 24);
1969 static void EmitDarwinBCHeaderAndTrailer(SmallVectorImpl<char> &Buffer,
1971 unsigned CPUType = ~0U;
1973 // Match x86_64-*, i[3-9]86-*, powerpc-*, powerpc64-*, arm-*, thumb-*,
1974 // armv[0-9]-*, thumbv[0-9]-*, armv5te-*, or armv6t2-*. The CPUType is a magic
1975 // number from /usr/include/mach/machine.h. It is ok to reproduce the
1976 // specific constants here because they are implicitly part of the Darwin ABI.
1978 DARWIN_CPU_ARCH_ABI64 = 0x01000000,
1979 DARWIN_CPU_TYPE_X86 = 7,
1980 DARWIN_CPU_TYPE_ARM = 12,
1981 DARWIN_CPU_TYPE_POWERPC = 18
1984 Triple::ArchType Arch = TT.getArch();
1985 if (Arch == Triple::x86_64)
1986 CPUType = DARWIN_CPU_TYPE_X86 | DARWIN_CPU_ARCH_ABI64;
1987 else if (Arch == Triple::x86)
1988 CPUType = DARWIN_CPU_TYPE_X86;
1989 else if (Arch == Triple::ppc)
1990 CPUType = DARWIN_CPU_TYPE_POWERPC;
1991 else if (Arch == Triple::ppc64)
1992 CPUType = DARWIN_CPU_TYPE_POWERPC | DARWIN_CPU_ARCH_ABI64;
1993 else if (Arch == Triple::arm || Arch == Triple::thumb)
1994 CPUType = DARWIN_CPU_TYPE_ARM;
1996 // Traditional Bitcode starts after header.
1997 assert(Buffer.size() >= DarwinBCHeaderSize &&
1998 "Expected header size to be reserved");
1999 unsigned BCOffset = DarwinBCHeaderSize;
2000 unsigned BCSize = Buffer.size()-DarwinBCHeaderSize;
2002 // Write the magic and version.
2003 unsigned Position = 0;
2004 WriteInt32ToBuffer(0x0B17C0DE , Buffer, Position);
2005 WriteInt32ToBuffer(0 , Buffer, Position); // Version.
2006 WriteInt32ToBuffer(BCOffset , Buffer, Position);
2007 WriteInt32ToBuffer(BCSize , Buffer, Position);
2008 WriteInt32ToBuffer(CPUType , Buffer, Position);
2010 // If the file is not a multiple of 16 bytes, insert dummy padding.
2011 while (Buffer.size() & 15)
2012 Buffer.push_back(0);
2015 /// WriteBitcodeToFile - Write the specified module to the specified output
2017 void llvm::WriteBitcodeToFile(const Module *M, raw_ostream &Out) {
2018 SmallVector<char, 0> Buffer;
2019 Buffer.reserve(256*1024);
2021 // If this is darwin or another generic macho target, reserve space for the
2023 Triple TT(M->getTargetTriple());
2024 if (TT.isOSDarwin())
2025 Buffer.insert(Buffer.begin(), DarwinBCHeaderSize, 0);
2027 // Emit the module into the buffer.
2029 BitstreamWriter Stream(Buffer);
2031 // Emit the file header.
2032 Stream.Emit((unsigned)'B', 8);
2033 Stream.Emit((unsigned)'C', 8);
2034 Stream.Emit(0x0, 4);
2035 Stream.Emit(0xC, 4);
2036 Stream.Emit(0xE, 4);
2037 Stream.Emit(0xD, 4);
2040 WriteModule(M, Stream);
2043 if (TT.isOSDarwin())
2044 EmitDarwinBCHeaderAndTrailer(Buffer, TT);
2046 // Write the generated bitstream to "Out".
2047 Out.write((char*)&Buffer.front(), Buffer.size());