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/DebugInfoMetadata.h"
21 #include "llvm/IR/DerivedTypes.h"
22 #include "llvm/IR/InlineAsm.h"
23 #include "llvm/IR/Instructions.h"
24 #include "llvm/IR/Module.h"
25 #include "llvm/IR/Operator.h"
26 #include "llvm/IR/UseListOrder.h"
27 #include "llvm/IR/ValueSymbolTable.h"
28 #include "llvm/Support/CommandLine.h"
29 #include "llvm/Support/ErrorHandling.h"
30 #include "llvm/Support/MathExtras.h"
31 #include "llvm/Support/Program.h"
32 #include "llvm/Support/raw_ostream.h"
37 /// These are manifest constants used by the bitcode writer. They do not need to
38 /// be kept in sync with the reader, but need to be consistent within this file.
40 // VALUE_SYMTAB_BLOCK abbrev id's.
41 VST_ENTRY_8_ABBREV = bitc::FIRST_APPLICATION_ABBREV,
46 // CONSTANTS_BLOCK abbrev id's.
47 CONSTANTS_SETTYPE_ABBREV = bitc::FIRST_APPLICATION_ABBREV,
48 CONSTANTS_INTEGER_ABBREV,
49 CONSTANTS_CE_CAST_Abbrev,
50 CONSTANTS_NULL_Abbrev,
52 // FUNCTION_BLOCK abbrev id's.
53 FUNCTION_INST_LOAD_ABBREV = bitc::FIRST_APPLICATION_ABBREV,
54 FUNCTION_INST_BINOP_ABBREV,
55 FUNCTION_INST_BINOP_FLAGS_ABBREV,
56 FUNCTION_INST_CAST_ABBREV,
57 FUNCTION_INST_RET_VOID_ABBREV,
58 FUNCTION_INST_RET_VAL_ABBREV,
59 FUNCTION_INST_UNREACHABLE_ABBREV
62 static unsigned GetEncodedCastOpcode(unsigned Opcode) {
64 default: llvm_unreachable("Unknown cast instruction!");
65 case Instruction::Trunc : return bitc::CAST_TRUNC;
66 case Instruction::ZExt : return bitc::CAST_ZEXT;
67 case Instruction::SExt : return bitc::CAST_SEXT;
68 case Instruction::FPToUI : return bitc::CAST_FPTOUI;
69 case Instruction::FPToSI : return bitc::CAST_FPTOSI;
70 case Instruction::UIToFP : return bitc::CAST_UITOFP;
71 case Instruction::SIToFP : return bitc::CAST_SITOFP;
72 case Instruction::FPTrunc : return bitc::CAST_FPTRUNC;
73 case Instruction::FPExt : return bitc::CAST_FPEXT;
74 case Instruction::PtrToInt: return bitc::CAST_PTRTOINT;
75 case Instruction::IntToPtr: return bitc::CAST_INTTOPTR;
76 case Instruction::BitCast : return bitc::CAST_BITCAST;
77 case Instruction::AddrSpaceCast: return bitc::CAST_ADDRSPACECAST;
81 static unsigned GetEncodedBinaryOpcode(unsigned Opcode) {
83 default: llvm_unreachable("Unknown binary instruction!");
84 case Instruction::Add:
85 case Instruction::FAdd: return bitc::BINOP_ADD;
86 case Instruction::Sub:
87 case Instruction::FSub: return bitc::BINOP_SUB;
88 case Instruction::Mul:
89 case Instruction::FMul: return bitc::BINOP_MUL;
90 case Instruction::UDiv: return bitc::BINOP_UDIV;
91 case Instruction::FDiv:
92 case Instruction::SDiv: return bitc::BINOP_SDIV;
93 case Instruction::URem: return bitc::BINOP_UREM;
94 case Instruction::FRem:
95 case Instruction::SRem: return bitc::BINOP_SREM;
96 case Instruction::Shl: return bitc::BINOP_SHL;
97 case Instruction::LShr: return bitc::BINOP_LSHR;
98 case Instruction::AShr: return bitc::BINOP_ASHR;
99 case Instruction::And: return bitc::BINOP_AND;
100 case Instruction::Or: return bitc::BINOP_OR;
101 case Instruction::Xor: return bitc::BINOP_XOR;
105 static unsigned GetEncodedRMWOperation(AtomicRMWInst::BinOp Op) {
107 default: llvm_unreachable("Unknown RMW operation!");
108 case AtomicRMWInst::Xchg: return bitc::RMW_XCHG;
109 case AtomicRMWInst::Add: return bitc::RMW_ADD;
110 case AtomicRMWInst::Sub: return bitc::RMW_SUB;
111 case AtomicRMWInst::And: return bitc::RMW_AND;
112 case AtomicRMWInst::Nand: return bitc::RMW_NAND;
113 case AtomicRMWInst::Or: return bitc::RMW_OR;
114 case AtomicRMWInst::Xor: return bitc::RMW_XOR;
115 case AtomicRMWInst::Max: return bitc::RMW_MAX;
116 case AtomicRMWInst::Min: return bitc::RMW_MIN;
117 case AtomicRMWInst::UMax: return bitc::RMW_UMAX;
118 case AtomicRMWInst::UMin: return bitc::RMW_UMIN;
122 static unsigned GetEncodedOrdering(AtomicOrdering Ordering) {
124 case NotAtomic: return bitc::ORDERING_NOTATOMIC;
125 case Unordered: return bitc::ORDERING_UNORDERED;
126 case Monotonic: return bitc::ORDERING_MONOTONIC;
127 case Acquire: return bitc::ORDERING_ACQUIRE;
128 case Release: return bitc::ORDERING_RELEASE;
129 case AcquireRelease: return bitc::ORDERING_ACQREL;
130 case SequentiallyConsistent: return bitc::ORDERING_SEQCST;
132 llvm_unreachable("Invalid ordering");
135 static unsigned GetEncodedSynchScope(SynchronizationScope SynchScope) {
136 switch (SynchScope) {
137 case SingleThread: return bitc::SYNCHSCOPE_SINGLETHREAD;
138 case CrossThread: return bitc::SYNCHSCOPE_CROSSTHREAD;
140 llvm_unreachable("Invalid synch scope");
143 static void WriteStringRecord(unsigned Code, StringRef Str,
144 unsigned AbbrevToUse, BitstreamWriter &Stream) {
145 SmallVector<unsigned, 64> Vals;
147 // Code: [strchar x N]
148 for (unsigned i = 0, e = Str.size(); i != e; ++i) {
149 if (AbbrevToUse && !BitCodeAbbrevOp::isChar6(Str[i]))
151 Vals.push_back(Str[i]);
154 // Emit the finished record.
155 Stream.EmitRecord(Code, Vals, AbbrevToUse);
158 static uint64_t getAttrKindEncoding(Attribute::AttrKind Kind) {
160 case Attribute::Alignment:
161 return bitc::ATTR_KIND_ALIGNMENT;
162 case Attribute::AlwaysInline:
163 return bitc::ATTR_KIND_ALWAYS_INLINE;
164 case Attribute::Builtin:
165 return bitc::ATTR_KIND_BUILTIN;
166 case Attribute::ByVal:
167 return bitc::ATTR_KIND_BY_VAL;
168 case Attribute::InAlloca:
169 return bitc::ATTR_KIND_IN_ALLOCA;
170 case Attribute::Cold:
171 return bitc::ATTR_KIND_COLD;
172 case Attribute::InlineHint:
173 return bitc::ATTR_KIND_INLINE_HINT;
174 case Attribute::InReg:
175 return bitc::ATTR_KIND_IN_REG;
176 case Attribute::JumpTable:
177 return bitc::ATTR_KIND_JUMP_TABLE;
178 case Attribute::MinSize:
179 return bitc::ATTR_KIND_MIN_SIZE;
180 case Attribute::Naked:
181 return bitc::ATTR_KIND_NAKED;
182 case Attribute::Nest:
183 return bitc::ATTR_KIND_NEST;
184 case Attribute::NoAlias:
185 return bitc::ATTR_KIND_NO_ALIAS;
186 case Attribute::NoBuiltin:
187 return bitc::ATTR_KIND_NO_BUILTIN;
188 case Attribute::NoCapture:
189 return bitc::ATTR_KIND_NO_CAPTURE;
190 case Attribute::NoDuplicate:
191 return bitc::ATTR_KIND_NO_DUPLICATE;
192 case Attribute::NoImplicitFloat:
193 return bitc::ATTR_KIND_NO_IMPLICIT_FLOAT;
194 case Attribute::NoInline:
195 return bitc::ATTR_KIND_NO_INLINE;
196 case Attribute::NonLazyBind:
197 return bitc::ATTR_KIND_NON_LAZY_BIND;
198 case Attribute::NonNull:
199 return bitc::ATTR_KIND_NON_NULL;
200 case Attribute::Dereferenceable:
201 return bitc::ATTR_KIND_DEREFERENCEABLE;
202 case Attribute::NoRedZone:
203 return bitc::ATTR_KIND_NO_RED_ZONE;
204 case Attribute::NoReturn:
205 return bitc::ATTR_KIND_NO_RETURN;
206 case Attribute::NoUnwind:
207 return bitc::ATTR_KIND_NO_UNWIND;
208 case Attribute::OptimizeForSize:
209 return bitc::ATTR_KIND_OPTIMIZE_FOR_SIZE;
210 case Attribute::OptimizeNone:
211 return bitc::ATTR_KIND_OPTIMIZE_NONE;
212 case Attribute::ReadNone:
213 return bitc::ATTR_KIND_READ_NONE;
214 case Attribute::ReadOnly:
215 return bitc::ATTR_KIND_READ_ONLY;
216 case Attribute::Returned:
217 return bitc::ATTR_KIND_RETURNED;
218 case Attribute::ReturnsTwice:
219 return bitc::ATTR_KIND_RETURNS_TWICE;
220 case Attribute::SExt:
221 return bitc::ATTR_KIND_S_EXT;
222 case Attribute::StackAlignment:
223 return bitc::ATTR_KIND_STACK_ALIGNMENT;
224 case Attribute::StackProtect:
225 return bitc::ATTR_KIND_STACK_PROTECT;
226 case Attribute::StackProtectReq:
227 return bitc::ATTR_KIND_STACK_PROTECT_REQ;
228 case Attribute::StackProtectStrong:
229 return bitc::ATTR_KIND_STACK_PROTECT_STRONG;
230 case Attribute::StructRet:
231 return bitc::ATTR_KIND_STRUCT_RET;
232 case Attribute::SanitizeAddress:
233 return bitc::ATTR_KIND_SANITIZE_ADDRESS;
234 case Attribute::SanitizeThread:
235 return bitc::ATTR_KIND_SANITIZE_THREAD;
236 case Attribute::SanitizeMemory:
237 return bitc::ATTR_KIND_SANITIZE_MEMORY;
238 case Attribute::UWTable:
239 return bitc::ATTR_KIND_UW_TABLE;
240 case Attribute::ZExt:
241 return bitc::ATTR_KIND_Z_EXT;
242 case Attribute::EndAttrKinds:
243 llvm_unreachable("Can not encode end-attribute kinds marker.");
244 case Attribute::None:
245 llvm_unreachable("Can not encode none-attribute.");
248 llvm_unreachable("Trying to encode unknown attribute");
251 static void WriteAttributeGroupTable(const ValueEnumerator &VE,
252 BitstreamWriter &Stream) {
253 const std::vector<AttributeSet> &AttrGrps = VE.getAttributeGroups();
254 if (AttrGrps.empty()) return;
256 Stream.EnterSubblock(bitc::PARAMATTR_GROUP_BLOCK_ID, 3);
258 SmallVector<uint64_t, 64> Record;
259 for (unsigned i = 0, e = AttrGrps.size(); i != e; ++i) {
260 AttributeSet AS = AttrGrps[i];
261 for (unsigned i = 0, e = AS.getNumSlots(); i != e; ++i) {
262 AttributeSet A = AS.getSlotAttributes(i);
264 Record.push_back(VE.getAttributeGroupID(A));
265 Record.push_back(AS.getSlotIndex(i));
267 for (AttributeSet::iterator I = AS.begin(0), E = AS.end(0);
270 if (Attr.isEnumAttribute()) {
272 Record.push_back(getAttrKindEncoding(Attr.getKindAsEnum()));
273 } else if (Attr.isIntAttribute()) {
275 Record.push_back(getAttrKindEncoding(Attr.getKindAsEnum()));
276 Record.push_back(Attr.getValueAsInt());
278 StringRef Kind = Attr.getKindAsString();
279 StringRef Val = Attr.getValueAsString();
281 Record.push_back(Val.empty() ? 3 : 4);
282 Record.append(Kind.begin(), Kind.end());
285 Record.append(Val.begin(), Val.end());
291 Stream.EmitRecord(bitc::PARAMATTR_GRP_CODE_ENTRY, Record);
299 static void WriteAttributeTable(const ValueEnumerator &VE,
300 BitstreamWriter &Stream) {
301 const std::vector<AttributeSet> &Attrs = VE.getAttributes();
302 if (Attrs.empty()) return;
304 Stream.EnterSubblock(bitc::PARAMATTR_BLOCK_ID, 3);
306 SmallVector<uint64_t, 64> Record;
307 for (unsigned i = 0, e = Attrs.size(); i != e; ++i) {
308 const AttributeSet &A = Attrs[i];
309 for (unsigned i = 0, e = A.getNumSlots(); i != e; ++i)
310 Record.push_back(VE.getAttributeGroupID(A.getSlotAttributes(i)));
312 Stream.EmitRecord(bitc::PARAMATTR_CODE_ENTRY, Record);
319 /// WriteTypeTable - Write out the type table for a module.
320 static void WriteTypeTable(const ValueEnumerator &VE, BitstreamWriter &Stream) {
321 const ValueEnumerator::TypeList &TypeList = VE.getTypes();
323 Stream.EnterSubblock(bitc::TYPE_BLOCK_ID_NEW, 4 /*count from # abbrevs */);
324 SmallVector<uint64_t, 64> TypeVals;
326 uint64_t NumBits = VE.computeBitsRequiredForTypeIndicies();
328 // Abbrev for TYPE_CODE_POINTER.
329 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
330 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_POINTER));
331 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
332 Abbv->Add(BitCodeAbbrevOp(0)); // Addrspace = 0
333 unsigned PtrAbbrev = Stream.EmitAbbrev(Abbv);
335 // Abbrev for TYPE_CODE_FUNCTION.
336 Abbv = new BitCodeAbbrev();
337 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_FUNCTION));
338 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isvararg
339 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
340 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
342 unsigned FunctionAbbrev = Stream.EmitAbbrev(Abbv);
344 // Abbrev for TYPE_CODE_STRUCT_ANON.
345 Abbv = new BitCodeAbbrev();
346 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_STRUCT_ANON));
347 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ispacked
348 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
349 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
351 unsigned StructAnonAbbrev = Stream.EmitAbbrev(Abbv);
353 // Abbrev for TYPE_CODE_STRUCT_NAME.
354 Abbv = new BitCodeAbbrev();
355 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_STRUCT_NAME));
356 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
357 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
358 unsigned StructNameAbbrev = Stream.EmitAbbrev(Abbv);
360 // Abbrev for TYPE_CODE_STRUCT_NAMED.
361 Abbv = new BitCodeAbbrev();
362 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_STRUCT_NAMED));
363 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ispacked
364 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
365 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
367 unsigned StructNamedAbbrev = Stream.EmitAbbrev(Abbv);
369 // Abbrev for TYPE_CODE_ARRAY.
370 Abbv = new BitCodeAbbrev();
371 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_ARRAY));
372 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // size
373 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
375 unsigned ArrayAbbrev = Stream.EmitAbbrev(Abbv);
377 // Emit an entry count so the reader can reserve space.
378 TypeVals.push_back(TypeList.size());
379 Stream.EmitRecord(bitc::TYPE_CODE_NUMENTRY, TypeVals);
382 // Loop over all of the types, emitting each in turn.
383 for (unsigned i = 0, e = TypeList.size(); i != e; ++i) {
384 Type *T = TypeList[i];
388 switch (T->getTypeID()) {
389 case Type::VoidTyID: Code = bitc::TYPE_CODE_VOID; break;
390 case Type::HalfTyID: Code = bitc::TYPE_CODE_HALF; break;
391 case Type::FloatTyID: Code = bitc::TYPE_CODE_FLOAT; break;
392 case Type::DoubleTyID: Code = bitc::TYPE_CODE_DOUBLE; break;
393 case Type::X86_FP80TyID: Code = bitc::TYPE_CODE_X86_FP80; break;
394 case Type::FP128TyID: Code = bitc::TYPE_CODE_FP128; break;
395 case Type::PPC_FP128TyID: Code = bitc::TYPE_CODE_PPC_FP128; break;
396 case Type::LabelTyID: Code = bitc::TYPE_CODE_LABEL; break;
397 case Type::MetadataTyID: Code = bitc::TYPE_CODE_METADATA; break;
398 case Type::X86_MMXTyID: Code = bitc::TYPE_CODE_X86_MMX; break;
399 case Type::IntegerTyID:
401 Code = bitc::TYPE_CODE_INTEGER;
402 TypeVals.push_back(cast<IntegerType>(T)->getBitWidth());
404 case Type::PointerTyID: {
405 PointerType *PTy = cast<PointerType>(T);
406 // POINTER: [pointee type, address space]
407 Code = bitc::TYPE_CODE_POINTER;
408 TypeVals.push_back(VE.getTypeID(PTy->getElementType()));
409 unsigned AddressSpace = PTy->getAddressSpace();
410 TypeVals.push_back(AddressSpace);
411 if (AddressSpace == 0) AbbrevToUse = PtrAbbrev;
414 case Type::FunctionTyID: {
415 FunctionType *FT = cast<FunctionType>(T);
416 // FUNCTION: [isvararg, retty, paramty x N]
417 Code = bitc::TYPE_CODE_FUNCTION;
418 TypeVals.push_back(FT->isVarArg());
419 TypeVals.push_back(VE.getTypeID(FT->getReturnType()));
420 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i)
421 TypeVals.push_back(VE.getTypeID(FT->getParamType(i)));
422 AbbrevToUse = FunctionAbbrev;
425 case Type::StructTyID: {
426 StructType *ST = cast<StructType>(T);
427 // STRUCT: [ispacked, eltty x N]
428 TypeVals.push_back(ST->isPacked());
429 // Output all of the element types.
430 for (StructType::element_iterator I = ST->element_begin(),
431 E = ST->element_end(); I != E; ++I)
432 TypeVals.push_back(VE.getTypeID(*I));
434 if (ST->isLiteral()) {
435 Code = bitc::TYPE_CODE_STRUCT_ANON;
436 AbbrevToUse = StructAnonAbbrev;
438 if (ST->isOpaque()) {
439 Code = bitc::TYPE_CODE_OPAQUE;
441 Code = bitc::TYPE_CODE_STRUCT_NAMED;
442 AbbrevToUse = StructNamedAbbrev;
445 // Emit the name if it is present.
446 if (!ST->getName().empty())
447 WriteStringRecord(bitc::TYPE_CODE_STRUCT_NAME, ST->getName(),
448 StructNameAbbrev, Stream);
452 case Type::ArrayTyID: {
453 ArrayType *AT = cast<ArrayType>(T);
454 // ARRAY: [numelts, eltty]
455 Code = bitc::TYPE_CODE_ARRAY;
456 TypeVals.push_back(AT->getNumElements());
457 TypeVals.push_back(VE.getTypeID(AT->getElementType()));
458 AbbrevToUse = ArrayAbbrev;
461 case Type::VectorTyID: {
462 VectorType *VT = cast<VectorType>(T);
463 // VECTOR [numelts, eltty]
464 Code = bitc::TYPE_CODE_VECTOR;
465 TypeVals.push_back(VT->getNumElements());
466 TypeVals.push_back(VE.getTypeID(VT->getElementType()));
471 // Emit the finished record.
472 Stream.EmitRecord(Code, TypeVals, AbbrevToUse);
479 static unsigned getEncodedLinkage(const GlobalValue &GV) {
480 switch (GV.getLinkage()) {
481 case GlobalValue::ExternalLinkage:
483 case GlobalValue::WeakAnyLinkage:
485 case GlobalValue::AppendingLinkage:
487 case GlobalValue::InternalLinkage:
489 case GlobalValue::LinkOnceAnyLinkage:
491 case GlobalValue::ExternalWeakLinkage:
493 case GlobalValue::CommonLinkage:
495 case GlobalValue::PrivateLinkage:
497 case GlobalValue::WeakODRLinkage:
499 case GlobalValue::LinkOnceODRLinkage:
501 case GlobalValue::AvailableExternallyLinkage:
504 llvm_unreachable("Invalid linkage");
507 static unsigned getEncodedVisibility(const GlobalValue &GV) {
508 switch (GV.getVisibility()) {
509 case GlobalValue::DefaultVisibility: return 0;
510 case GlobalValue::HiddenVisibility: return 1;
511 case GlobalValue::ProtectedVisibility: return 2;
513 llvm_unreachable("Invalid visibility");
516 static unsigned getEncodedDLLStorageClass(const GlobalValue &GV) {
517 switch (GV.getDLLStorageClass()) {
518 case GlobalValue::DefaultStorageClass: return 0;
519 case GlobalValue::DLLImportStorageClass: return 1;
520 case GlobalValue::DLLExportStorageClass: return 2;
522 llvm_unreachable("Invalid DLL storage class");
525 static unsigned getEncodedThreadLocalMode(const GlobalValue &GV) {
526 switch (GV.getThreadLocalMode()) {
527 case GlobalVariable::NotThreadLocal: return 0;
528 case GlobalVariable::GeneralDynamicTLSModel: return 1;
529 case GlobalVariable::LocalDynamicTLSModel: return 2;
530 case GlobalVariable::InitialExecTLSModel: return 3;
531 case GlobalVariable::LocalExecTLSModel: return 4;
533 llvm_unreachable("Invalid TLS model");
536 static unsigned getEncodedComdatSelectionKind(const Comdat &C) {
537 switch (C.getSelectionKind()) {
539 return bitc::COMDAT_SELECTION_KIND_ANY;
540 case Comdat::ExactMatch:
541 return bitc::COMDAT_SELECTION_KIND_EXACT_MATCH;
542 case Comdat::Largest:
543 return bitc::COMDAT_SELECTION_KIND_LARGEST;
544 case Comdat::NoDuplicates:
545 return bitc::COMDAT_SELECTION_KIND_NO_DUPLICATES;
546 case Comdat::SameSize:
547 return bitc::COMDAT_SELECTION_KIND_SAME_SIZE;
549 llvm_unreachable("Invalid selection kind");
552 static void writeComdats(const ValueEnumerator &VE, BitstreamWriter &Stream) {
553 SmallVector<uint16_t, 64> Vals;
554 for (const Comdat *C : VE.getComdats()) {
555 // COMDAT: [selection_kind, name]
556 Vals.push_back(getEncodedComdatSelectionKind(*C));
557 size_t Size = C->getName().size();
558 assert(isUInt<16>(Size));
559 Vals.push_back(Size);
560 for (char Chr : C->getName())
561 Vals.push_back((unsigned char)Chr);
562 Stream.EmitRecord(bitc::MODULE_CODE_COMDAT, Vals, /*AbbrevToUse=*/0);
567 // Emit top-level description of module, including target triple, inline asm,
568 // descriptors for global variables, and function prototype info.
569 static void WriteModuleInfo(const Module *M, const ValueEnumerator &VE,
570 BitstreamWriter &Stream) {
571 // Emit various pieces of data attached to a module.
572 if (!M->getTargetTriple().empty())
573 WriteStringRecord(bitc::MODULE_CODE_TRIPLE, M->getTargetTriple(),
575 const std::string &DL = M->getDataLayoutStr();
577 WriteStringRecord(bitc::MODULE_CODE_DATALAYOUT, DL, 0 /*TODO*/, Stream);
578 if (!M->getModuleInlineAsm().empty())
579 WriteStringRecord(bitc::MODULE_CODE_ASM, M->getModuleInlineAsm(),
582 // Emit information about sections and GC, computing how many there are. Also
583 // compute the maximum alignment value.
584 std::map<std::string, unsigned> SectionMap;
585 std::map<std::string, unsigned> GCMap;
586 unsigned MaxAlignment = 0;
587 unsigned MaxGlobalType = 0;
588 for (const GlobalValue &GV : M->globals()) {
589 MaxAlignment = std::max(MaxAlignment, GV.getAlignment());
590 MaxGlobalType = std::max(MaxGlobalType, VE.getTypeID(GV.getType()));
591 if (GV.hasSection()) {
592 // Give section names unique ID's.
593 unsigned &Entry = SectionMap[GV.getSection()];
595 WriteStringRecord(bitc::MODULE_CODE_SECTIONNAME, GV.getSection(),
597 Entry = SectionMap.size();
601 for (const Function &F : *M) {
602 MaxAlignment = std::max(MaxAlignment, F.getAlignment());
603 if (F.hasSection()) {
604 // Give section names unique ID's.
605 unsigned &Entry = SectionMap[F.getSection()];
607 WriteStringRecord(bitc::MODULE_CODE_SECTIONNAME, F.getSection(),
609 Entry = SectionMap.size();
613 // Same for GC names.
614 unsigned &Entry = GCMap[F.getGC()];
616 WriteStringRecord(bitc::MODULE_CODE_GCNAME, F.getGC(),
618 Entry = GCMap.size();
623 // Emit abbrev for globals, now that we know # sections and max alignment.
624 unsigned SimpleGVarAbbrev = 0;
625 if (!M->global_empty()) {
626 // Add an abbrev for common globals with no visibility or thread localness.
627 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
628 Abbv->Add(BitCodeAbbrevOp(bitc::MODULE_CODE_GLOBALVAR));
629 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
630 Log2_32_Ceil(MaxGlobalType+1)));
631 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Constant.
632 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Initializer.
633 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 5)); // Linkage.
634 if (MaxAlignment == 0) // Alignment.
635 Abbv->Add(BitCodeAbbrevOp(0));
637 unsigned MaxEncAlignment = Log2_32(MaxAlignment)+1;
638 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
639 Log2_32_Ceil(MaxEncAlignment+1)));
641 if (SectionMap.empty()) // Section.
642 Abbv->Add(BitCodeAbbrevOp(0));
644 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
645 Log2_32_Ceil(SectionMap.size()+1)));
646 // Don't bother emitting vis + thread local.
647 SimpleGVarAbbrev = Stream.EmitAbbrev(Abbv);
650 // Emit the global variable information.
651 SmallVector<unsigned, 64> Vals;
652 for (const GlobalVariable &GV : M->globals()) {
653 unsigned AbbrevToUse = 0;
655 // GLOBALVAR: [type, isconst, initid,
656 // linkage, alignment, section, visibility, threadlocal,
657 // unnamed_addr, externally_initialized, dllstorageclass,
659 Vals.push_back(VE.getTypeID(GV.getType()));
660 Vals.push_back(GV.isConstant());
661 Vals.push_back(GV.isDeclaration() ? 0 :
662 (VE.getValueID(GV.getInitializer()) + 1));
663 Vals.push_back(getEncodedLinkage(GV));
664 Vals.push_back(Log2_32(GV.getAlignment())+1);
665 Vals.push_back(GV.hasSection() ? SectionMap[GV.getSection()] : 0);
666 if (GV.isThreadLocal() ||
667 GV.getVisibility() != GlobalValue::DefaultVisibility ||
668 GV.hasUnnamedAddr() || GV.isExternallyInitialized() ||
669 GV.getDLLStorageClass() != GlobalValue::DefaultStorageClass ||
671 Vals.push_back(getEncodedVisibility(GV));
672 Vals.push_back(getEncodedThreadLocalMode(GV));
673 Vals.push_back(GV.hasUnnamedAddr());
674 Vals.push_back(GV.isExternallyInitialized());
675 Vals.push_back(getEncodedDLLStorageClass(GV));
676 Vals.push_back(GV.hasComdat() ? VE.getComdatID(GV.getComdat()) : 0);
678 AbbrevToUse = SimpleGVarAbbrev;
681 Stream.EmitRecord(bitc::MODULE_CODE_GLOBALVAR, Vals, AbbrevToUse);
685 // Emit the function proto information.
686 for (const Function &F : *M) {
687 // FUNCTION: [type, callingconv, isproto, linkage, paramattrs, alignment,
688 // section, visibility, gc, unnamed_addr, prologuedata,
689 // dllstorageclass, comdat, prefixdata]
690 Vals.push_back(VE.getTypeID(F.getType()));
691 Vals.push_back(F.getCallingConv());
692 Vals.push_back(F.isDeclaration());
693 Vals.push_back(getEncodedLinkage(F));
694 Vals.push_back(VE.getAttributeID(F.getAttributes()));
695 Vals.push_back(Log2_32(F.getAlignment())+1);
696 Vals.push_back(F.hasSection() ? SectionMap[F.getSection()] : 0);
697 Vals.push_back(getEncodedVisibility(F));
698 Vals.push_back(F.hasGC() ? GCMap[F.getGC()] : 0);
699 Vals.push_back(F.hasUnnamedAddr());
700 Vals.push_back(F.hasPrologueData() ? (VE.getValueID(F.getPrologueData()) + 1)
702 Vals.push_back(getEncodedDLLStorageClass(F));
703 Vals.push_back(F.hasComdat() ? VE.getComdatID(F.getComdat()) : 0);
704 Vals.push_back(F.hasPrefixData() ? (VE.getValueID(F.getPrefixData()) + 1)
707 unsigned AbbrevToUse = 0;
708 Stream.EmitRecord(bitc::MODULE_CODE_FUNCTION, Vals, AbbrevToUse);
712 // Emit the alias information.
713 for (const GlobalAlias &A : M->aliases()) {
714 // ALIAS: [alias type, aliasee val#, linkage, visibility]
715 Vals.push_back(VE.getTypeID(A.getType()));
716 Vals.push_back(VE.getValueID(A.getAliasee()));
717 Vals.push_back(getEncodedLinkage(A));
718 Vals.push_back(getEncodedVisibility(A));
719 Vals.push_back(getEncodedDLLStorageClass(A));
720 Vals.push_back(getEncodedThreadLocalMode(A));
721 Vals.push_back(A.hasUnnamedAddr());
722 unsigned AbbrevToUse = 0;
723 Stream.EmitRecord(bitc::MODULE_CODE_ALIAS, Vals, AbbrevToUse);
728 static uint64_t GetOptimizationFlags(const Value *V) {
731 if (const auto *OBO = dyn_cast<OverflowingBinaryOperator>(V)) {
732 if (OBO->hasNoSignedWrap())
733 Flags |= 1 << bitc::OBO_NO_SIGNED_WRAP;
734 if (OBO->hasNoUnsignedWrap())
735 Flags |= 1 << bitc::OBO_NO_UNSIGNED_WRAP;
736 } else if (const auto *PEO = dyn_cast<PossiblyExactOperator>(V)) {
738 Flags |= 1 << bitc::PEO_EXACT;
739 } else if (const auto *FPMO = dyn_cast<FPMathOperator>(V)) {
740 if (FPMO->hasUnsafeAlgebra())
741 Flags |= FastMathFlags::UnsafeAlgebra;
742 if (FPMO->hasNoNaNs())
743 Flags |= FastMathFlags::NoNaNs;
744 if (FPMO->hasNoInfs())
745 Flags |= FastMathFlags::NoInfs;
746 if (FPMO->hasNoSignedZeros())
747 Flags |= FastMathFlags::NoSignedZeros;
748 if (FPMO->hasAllowReciprocal())
749 Flags |= FastMathFlags::AllowReciprocal;
755 static void WriteValueAsMetadata(const ValueAsMetadata *MD,
756 const ValueEnumerator &VE,
757 BitstreamWriter &Stream,
758 SmallVectorImpl<uint64_t> &Record) {
759 // Mimic an MDNode with a value as one operand.
760 Value *V = MD->getValue();
761 Record.push_back(VE.getTypeID(V->getType()));
762 Record.push_back(VE.getValueID(V));
763 Stream.EmitRecord(bitc::METADATA_VALUE, Record, 0);
767 static void WriteMDTuple(const MDTuple *N, const ValueEnumerator &VE,
768 BitstreamWriter &Stream,
769 SmallVectorImpl<uint64_t> &Record, unsigned Abbrev) {
770 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
771 Metadata *MD = N->getOperand(i);
772 assert(!(MD && isa<LocalAsMetadata>(MD)) &&
773 "Unexpected function-local metadata");
774 Record.push_back(VE.getMetadataOrNullID(MD));
776 Stream.EmitRecord(N->isDistinct() ? bitc::METADATA_DISTINCT_NODE
777 : bitc::METADATA_NODE,
782 static void WriteMDLocation(const MDLocation *N, const ValueEnumerator &VE,
783 BitstreamWriter &Stream,
784 SmallVectorImpl<uint64_t> &Record,
786 Record.push_back(N->isDistinct());
787 Record.push_back(N->getLine());
788 Record.push_back(N->getColumn());
789 Record.push_back(VE.getMetadataID(N->getScope()));
790 Record.push_back(VE.getMetadataOrNullID(N->getInlinedAt()));
792 Stream.EmitRecord(bitc::METADATA_LOCATION, Record, Abbrev);
796 static void WriteGenericDebugNode(const GenericDebugNode *N,
797 const ValueEnumerator &VE,
798 BitstreamWriter &Stream,
799 SmallVectorImpl<uint64_t> &Record,
801 Record.push_back(N->isDistinct());
802 Record.push_back(N->getTag());
803 Record.push_back(0); // Per-tag version field; unused for now.
805 for (auto &I : N->operands())
806 Record.push_back(VE.getMetadataOrNullID(I));
808 Stream.EmitRecord(bitc::METADATA_GENERIC_DEBUG, Record, Abbrev);
812 static uint64_t rotateSign(int64_t I) {
814 return I < 0 ? ~(U << 1) : U << 1;
817 static void WriteMDSubrange(const MDSubrange *N, const ValueEnumerator &,
818 BitstreamWriter &Stream,
819 SmallVectorImpl<uint64_t> &Record,
821 Record.push_back(N->isDistinct());
822 Record.push_back(N->getCount());
823 Record.push_back(rotateSign(N->getLo()));
825 Stream.EmitRecord(bitc::METADATA_SUBRANGE, Record, Abbrev);
829 static void WriteMDEnumerator(const MDEnumerator *N, const ValueEnumerator &VE,
830 BitstreamWriter &Stream,
831 SmallVectorImpl<uint64_t> &Record,
833 Record.push_back(N->isDistinct());
834 Record.push_back(rotateSign(N->getValue()));
835 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
837 Stream.EmitRecord(bitc::METADATA_ENUMERATOR, Record, Abbrev);
841 static void WriteMDBasicType(const MDBasicType *N, const ValueEnumerator &VE,
842 BitstreamWriter &Stream,
843 SmallVectorImpl<uint64_t> &Record,
845 Record.push_back(N->isDistinct());
846 Record.push_back(N->getTag());
847 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
848 Record.push_back(N->getSizeInBits());
849 Record.push_back(N->getAlignInBits());
850 Record.push_back(N->getEncoding());
852 Stream.EmitRecord(bitc::METADATA_BASIC_TYPE, Record, Abbrev);
856 static void WriteMDDerivedType(const MDDerivedType *N,
857 const ValueEnumerator &VE,
858 BitstreamWriter &Stream,
859 SmallVectorImpl<uint64_t> &Record,
861 Record.push_back(N->isDistinct());
862 Record.push_back(N->getTag());
863 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
864 Record.push_back(VE.getMetadataOrNullID(N->getFile()));
865 Record.push_back(N->getLine());
866 Record.push_back(VE.getMetadataOrNullID(N->getScope()));
867 Record.push_back(VE.getMetadataOrNullID(N->getBaseType()));
868 Record.push_back(N->getSizeInBits());
869 Record.push_back(N->getAlignInBits());
870 Record.push_back(N->getOffsetInBits());
871 Record.push_back(N->getFlags());
872 Record.push_back(VE.getMetadataOrNullID(N->getExtraData()));
874 Stream.EmitRecord(bitc::METADATA_DERIVED_TYPE, Record, Abbrev);
878 static void WriteMDCompositeType(const MDCompositeType *N,
879 const ValueEnumerator &VE,
880 BitstreamWriter &Stream,
881 SmallVectorImpl<uint64_t> &Record,
883 Record.push_back(N->isDistinct());
884 Record.push_back(N->getTag());
885 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
886 Record.push_back(VE.getMetadataOrNullID(N->getFile()));
887 Record.push_back(N->getLine());
888 Record.push_back(VE.getMetadataOrNullID(N->getScope()));
889 Record.push_back(VE.getMetadataOrNullID(N->getBaseType()));
890 Record.push_back(N->getSizeInBits());
891 Record.push_back(N->getAlignInBits());
892 Record.push_back(N->getOffsetInBits());
893 Record.push_back(N->getFlags());
894 Record.push_back(VE.getMetadataOrNullID(N->getElements()));
895 Record.push_back(N->getRuntimeLang());
896 Record.push_back(VE.getMetadataOrNullID(N->getVTableHolder()));
897 Record.push_back(VE.getMetadataOrNullID(N->getTemplateParams()));
898 Record.push_back(VE.getMetadataOrNullID(N->getRawIdentifier()));
900 Stream.EmitRecord(bitc::METADATA_COMPOSITE_TYPE, Record, Abbrev);
904 static void WriteMDSubroutineType(const MDSubroutineType *N,
905 const ValueEnumerator &VE,
906 BitstreamWriter &Stream,
907 SmallVectorImpl<uint64_t> &Record,
909 Record.push_back(N->isDistinct());
910 Record.push_back(N->getFlags());
911 Record.push_back(VE.getMetadataOrNullID(N->getTypeArray()));
913 Stream.EmitRecord(bitc::METADATA_SUBROUTINE_TYPE, Record, Abbrev);
917 static void WriteMDFile(const MDFile *N, const ValueEnumerator &VE,
918 BitstreamWriter &Stream,
919 SmallVectorImpl<uint64_t> &Record, unsigned Abbrev) {
920 Record.push_back(N->isDistinct());
921 Record.push_back(VE.getMetadataOrNullID(N->getRawFilename()));
922 Record.push_back(VE.getMetadataOrNullID(N->getRawDirectory()));
924 Stream.EmitRecord(bitc::METADATA_FILE, Record, Abbrev);
928 static void WriteMDCompileUnit(const MDCompileUnit *N,
929 const ValueEnumerator &VE,
930 BitstreamWriter &Stream,
931 SmallVectorImpl<uint64_t> &Record,
933 Record.push_back(N->isDistinct());
934 Record.push_back(N->getSourceLanguage());
935 Record.push_back(VE.getMetadataOrNullID(N->getFile()));
936 Record.push_back(VE.getMetadataOrNullID(N->getRawProducer()));
937 Record.push_back(N->isOptimized());
938 Record.push_back(VE.getMetadataOrNullID(N->getRawFlags()));
939 Record.push_back(N->getRuntimeVersion());
940 Record.push_back(VE.getMetadataOrNullID(N->getRawSplitDebugFilename()));
941 Record.push_back(N->getEmissionKind());
942 Record.push_back(VE.getMetadataOrNullID(N->getEnumTypes()));
943 Record.push_back(VE.getMetadataOrNullID(N->getRetainedTypes()));
944 Record.push_back(VE.getMetadataOrNullID(N->getSubprograms()));
945 Record.push_back(VE.getMetadataOrNullID(N->getGlobalVariables()));
946 Record.push_back(VE.getMetadataOrNullID(N->getImportedEntities()));
948 Stream.EmitRecord(bitc::METADATA_COMPILE_UNIT, Record, Abbrev);
952 static void WriteMDSubprogram(const MDSubprogram *N,
953 const ValueEnumerator &VE,
954 BitstreamWriter &Stream,
955 SmallVectorImpl<uint64_t> &Record,
957 Record.push_back(N->isDistinct());
958 Record.push_back(VE.getMetadataOrNullID(N->getScope()));
959 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
960 Record.push_back(VE.getMetadataOrNullID(N->getRawLinkageName()));
961 Record.push_back(VE.getMetadataOrNullID(N->getFile()));
962 Record.push_back(N->getLine());
963 Record.push_back(VE.getMetadataOrNullID(N->getType()));
964 Record.push_back(N->isLocalToUnit());
965 Record.push_back(N->isDefinition());
966 Record.push_back(N->getScopeLine());
967 Record.push_back(VE.getMetadataOrNullID(N->getContainingType()));
968 Record.push_back(N->getVirtuality());
969 Record.push_back(N->getVirtualIndex());
970 Record.push_back(N->getFlags());
971 Record.push_back(N->isOptimized());
972 Record.push_back(VE.getMetadataOrNullID(N->getFunction()));
973 Record.push_back(VE.getMetadataOrNullID(N->getTemplateParams()));
974 Record.push_back(VE.getMetadataOrNullID(N->getDeclaration()));
975 Record.push_back(VE.getMetadataOrNullID(N->getVariables()));
977 Stream.EmitRecord(bitc::METADATA_SUBPROGRAM, Record, Abbrev);
981 static void WriteMDLexicalBlock(const MDLexicalBlock *N,
982 const ValueEnumerator &VE,
983 BitstreamWriter &Stream,
984 SmallVectorImpl<uint64_t> &Record,
986 Record.push_back(N->isDistinct());
987 Record.push_back(VE.getMetadataOrNullID(N->getScope()));
988 Record.push_back(VE.getMetadataOrNullID(N->getFile()));
989 Record.push_back(N->getLine());
990 Record.push_back(N->getColumn());
992 Stream.EmitRecord(bitc::METADATA_LEXICAL_BLOCK, Record, Abbrev);
996 static void WriteMDLexicalBlockFile(const MDLexicalBlockFile *N,
997 const ValueEnumerator &VE,
998 BitstreamWriter &Stream,
999 SmallVectorImpl<uint64_t> &Record,
1001 Record.push_back(N->isDistinct());
1002 Record.push_back(VE.getMetadataOrNullID(N->getScope()));
1003 Record.push_back(VE.getMetadataOrNullID(N->getFile()));
1004 Record.push_back(N->getDiscriminator());
1006 Stream.EmitRecord(bitc::METADATA_LEXICAL_BLOCK_FILE, Record, Abbrev);
1010 static void WriteMDNamespace(const MDNamespace *N, const ValueEnumerator &VE,
1011 BitstreamWriter &Stream,
1012 SmallVectorImpl<uint64_t> &Record,
1014 Record.push_back(N->isDistinct());
1015 Record.push_back(VE.getMetadataOrNullID(N->getScope()));
1016 Record.push_back(VE.getMetadataOrNullID(N->getFile()));
1017 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1018 Record.push_back(N->getLine());
1020 Stream.EmitRecord(bitc::METADATA_NAMESPACE, Record, Abbrev);
1024 static void WriteMDTemplateTypeParameter(const MDTemplateTypeParameter *N,
1025 const ValueEnumerator &VE,
1026 BitstreamWriter &Stream,
1027 SmallVectorImpl<uint64_t> &Record,
1029 Record.push_back(N->isDistinct());
1030 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1031 Record.push_back(VE.getMetadataOrNullID(N->getType()));
1033 Stream.EmitRecord(bitc::METADATA_TEMPLATE_TYPE, Record, Abbrev);
1037 static void WriteMDTemplateValueParameter(const MDTemplateValueParameter *N,
1038 const ValueEnumerator &VE,
1039 BitstreamWriter &Stream,
1040 SmallVectorImpl<uint64_t> &Record,
1042 Record.push_back(N->isDistinct());
1043 Record.push_back(N->getTag());
1044 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1045 Record.push_back(VE.getMetadataOrNullID(N->getType()));
1046 Record.push_back(VE.getMetadataOrNullID(N->getValue()));
1048 Stream.EmitRecord(bitc::METADATA_TEMPLATE_VALUE, Record, Abbrev);
1052 static void WriteMDGlobalVariable(const MDGlobalVariable *N,
1053 const ValueEnumerator &VE,
1054 BitstreamWriter &Stream,
1055 SmallVectorImpl<uint64_t> &Record,
1057 Record.push_back(N->isDistinct());
1058 Record.push_back(VE.getMetadataOrNullID(N->getScope()));
1059 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1060 Record.push_back(VE.getMetadataOrNullID(N->getRawLinkageName()));
1061 Record.push_back(VE.getMetadataOrNullID(N->getFile()));
1062 Record.push_back(N->getLine());
1063 Record.push_back(VE.getMetadataOrNullID(N->getType()));
1064 Record.push_back(N->isLocalToUnit());
1065 Record.push_back(N->isDefinition());
1066 Record.push_back(VE.getMetadataOrNullID(N->getVariable()));
1067 Record.push_back(VE.getMetadataOrNullID(N->getStaticDataMemberDeclaration()));
1069 Stream.EmitRecord(bitc::METADATA_GLOBAL_VAR, Record, Abbrev);
1073 static void WriteMDLocalVariable(const MDLocalVariable *N,
1074 const ValueEnumerator &VE,
1075 BitstreamWriter &Stream,
1076 SmallVectorImpl<uint64_t> &Record,
1078 Record.push_back(N->isDistinct());
1079 Record.push_back(N->getTag());
1080 Record.push_back(VE.getMetadataOrNullID(N->getScope()));
1081 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1082 Record.push_back(VE.getMetadataOrNullID(N->getFile()));
1083 Record.push_back(N->getLine());
1084 Record.push_back(VE.getMetadataOrNullID(N->getType()));
1085 Record.push_back(N->getArg());
1086 Record.push_back(N->getFlags());
1087 Record.push_back(VE.getMetadataOrNullID(N->getInlinedAt()));
1089 Stream.EmitRecord(bitc::METADATA_LOCAL_VAR, Record, Abbrev);
1093 static void WriteMDExpression(const MDExpression *N, const ValueEnumerator &,
1094 BitstreamWriter &Stream,
1095 SmallVectorImpl<uint64_t> &Record,
1097 Record.reserve(N->getElements().size() + 1);
1099 Record.push_back(N->isDistinct());
1100 Record.append(N->elements_begin(), N->elements_end());
1102 Stream.EmitRecord(bitc::METADATA_EXPRESSION, Record, Abbrev);
1106 static void WriteMDObjCProperty(const MDObjCProperty *N,
1107 const ValueEnumerator &VE,
1108 BitstreamWriter &Stream,
1109 SmallVectorImpl<uint64_t> &Record,
1111 Record.push_back(N->isDistinct());
1112 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1113 Record.push_back(VE.getMetadataOrNullID(N->getFile()));
1114 Record.push_back(N->getLine());
1115 Record.push_back(VE.getMetadataOrNullID(N->getRawSetterName()));
1116 Record.push_back(VE.getMetadataOrNullID(N->getRawGetterName()));
1117 Record.push_back(N->getAttributes());
1118 Record.push_back(VE.getMetadataOrNullID(N->getType()));
1120 Stream.EmitRecord(bitc::METADATA_OBJC_PROPERTY, Record, Abbrev);
1124 static void WriteMDImportedEntity(const MDImportedEntity *N,
1125 const ValueEnumerator &VE,
1126 BitstreamWriter &Stream,
1127 SmallVectorImpl<uint64_t> &Record,
1129 Record.push_back(N->isDistinct());
1130 Record.push_back(N->getTag());
1131 Record.push_back(VE.getMetadataOrNullID(N->getScope()));
1132 Record.push_back(VE.getMetadataOrNullID(N->getEntity()));
1133 Record.push_back(N->getLine());
1134 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1136 Stream.EmitRecord(bitc::METADATA_IMPORTED_ENTITY, Record, Abbrev);
1140 static void WriteModuleMetadata(const Module *M,
1141 const ValueEnumerator &VE,
1142 BitstreamWriter &Stream) {
1143 const auto &MDs = VE.getMDs();
1144 if (MDs.empty() && M->named_metadata_empty())
1147 Stream.EnterSubblock(bitc::METADATA_BLOCK_ID, 3);
1149 unsigned MDSAbbrev = 0;
1150 if (VE.hasMDString()) {
1151 // Abbrev for METADATA_STRING.
1152 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1153 Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_STRING));
1154 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1155 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
1156 MDSAbbrev = Stream.EmitAbbrev(Abbv);
1159 // Initialize MDNode abbreviations.
1160 #define HANDLE_MDNODE_LEAF(CLASS) unsigned CLASS##Abbrev = 0;
1161 #include "llvm/IR/Metadata.def"
1163 if (VE.hasMDLocation()) {
1164 // Abbrev for METADATA_LOCATION.
1166 // Assume the column is usually under 128, and always output the inlined-at
1167 // location (it's never more expensive than building an array size 1).
1168 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1169 Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_LOCATION));
1170 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));
1171 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
1172 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
1173 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
1174 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
1175 MDLocationAbbrev = Stream.EmitAbbrev(Abbv);
1178 if (VE.hasGenericDebugNode()) {
1179 // Abbrev for METADATA_GENERIC_DEBUG.
1181 // Assume the column is usually under 128, and always output the inlined-at
1182 // location (it's never more expensive than building an array size 1).
1183 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1184 Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_GENERIC_DEBUG));
1185 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));
1186 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
1187 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));
1188 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
1189 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1190 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
1191 GenericDebugNodeAbbrev = Stream.EmitAbbrev(Abbv);
1194 unsigned NameAbbrev = 0;
1195 if (!M->named_metadata_empty()) {
1196 // Abbrev for METADATA_NAME.
1197 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1198 Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_NAME));
1199 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1200 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
1201 NameAbbrev = Stream.EmitAbbrev(Abbv);
1204 SmallVector<uint64_t, 64> Record;
1205 for (const Metadata *MD : MDs) {
1206 if (const MDNode *N = dyn_cast<MDNode>(MD)) {
1207 switch (N->getMetadataID()) {
1209 llvm_unreachable("Invalid MDNode subclass");
1210 #define HANDLE_MDNODE_LEAF(CLASS) \
1211 case Metadata::CLASS##Kind: \
1212 Write##CLASS(cast<CLASS>(N), VE, Stream, Record, CLASS##Abbrev); \
1214 #include "llvm/IR/Metadata.def"
1217 if (const auto *MDC = dyn_cast<ConstantAsMetadata>(MD)) {
1218 WriteValueAsMetadata(MDC, VE, Stream, Record);
1221 const MDString *MDS = cast<MDString>(MD);
1222 // Code: [strchar x N]
1223 Record.append(MDS->bytes_begin(), MDS->bytes_end());
1225 // Emit the finished record.
1226 Stream.EmitRecord(bitc::METADATA_STRING, Record, MDSAbbrev);
1230 // Write named metadata.
1231 for (const NamedMDNode &NMD : M->named_metadata()) {
1233 StringRef Str = NMD.getName();
1234 Record.append(Str.bytes_begin(), Str.bytes_end());
1235 Stream.EmitRecord(bitc::METADATA_NAME, Record, NameAbbrev);
1238 // Write named metadata operands.
1239 for (const MDNode *N : NMD.operands())
1240 Record.push_back(VE.getMetadataID(N));
1241 Stream.EmitRecord(bitc::METADATA_NAMED_NODE, Record, 0);
1248 static void WriteFunctionLocalMetadata(const Function &F,
1249 const ValueEnumerator &VE,
1250 BitstreamWriter &Stream) {
1251 bool StartedMetadataBlock = false;
1252 SmallVector<uint64_t, 64> Record;
1253 const SmallVectorImpl<const LocalAsMetadata *> &MDs =
1254 VE.getFunctionLocalMDs();
1255 for (unsigned i = 0, e = MDs.size(); i != e; ++i) {
1256 assert(MDs[i] && "Expected valid function-local metadata");
1257 if (!StartedMetadataBlock) {
1258 Stream.EnterSubblock(bitc::METADATA_BLOCK_ID, 3);
1259 StartedMetadataBlock = true;
1261 WriteValueAsMetadata(MDs[i], VE, Stream, Record);
1264 if (StartedMetadataBlock)
1268 static void WriteMetadataAttachment(const Function &F,
1269 const ValueEnumerator &VE,
1270 BitstreamWriter &Stream) {
1271 Stream.EnterSubblock(bitc::METADATA_ATTACHMENT_ID, 3);
1273 SmallVector<uint64_t, 64> Record;
1275 // Write metadata attachments
1276 // METADATA_ATTACHMENT - [m x [value, [n x [id, mdnode]]]
1277 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1279 for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
1280 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end();
1283 I->getAllMetadataOtherThanDebugLoc(MDs);
1285 // If no metadata, ignore instruction.
1286 if (MDs.empty()) continue;
1288 Record.push_back(VE.getInstructionID(I));
1290 for (unsigned i = 0, e = MDs.size(); i != e; ++i) {
1291 Record.push_back(MDs[i].first);
1292 Record.push_back(VE.getMetadataID(MDs[i].second));
1294 Stream.EmitRecord(bitc::METADATA_ATTACHMENT, Record, 0);
1301 static void WriteModuleMetadataStore(const Module *M, BitstreamWriter &Stream) {
1302 SmallVector<uint64_t, 64> Record;
1304 // Write metadata kinds
1305 // METADATA_KIND - [n x [id, name]]
1306 SmallVector<StringRef, 8> Names;
1307 M->getMDKindNames(Names);
1309 if (Names.empty()) return;
1311 Stream.EnterSubblock(bitc::METADATA_BLOCK_ID, 3);
1313 for (unsigned MDKindID = 0, e = Names.size(); MDKindID != e; ++MDKindID) {
1314 Record.push_back(MDKindID);
1315 StringRef KName = Names[MDKindID];
1316 Record.append(KName.begin(), KName.end());
1318 Stream.EmitRecord(bitc::METADATA_KIND, Record, 0);
1325 static void emitSignedInt64(SmallVectorImpl<uint64_t> &Vals, uint64_t V) {
1326 if ((int64_t)V >= 0)
1327 Vals.push_back(V << 1);
1329 Vals.push_back((-V << 1) | 1);
1332 static void WriteConstants(unsigned FirstVal, unsigned LastVal,
1333 const ValueEnumerator &VE,
1334 BitstreamWriter &Stream, bool isGlobal) {
1335 if (FirstVal == LastVal) return;
1337 Stream.EnterSubblock(bitc::CONSTANTS_BLOCK_ID, 4);
1339 unsigned AggregateAbbrev = 0;
1340 unsigned String8Abbrev = 0;
1341 unsigned CString7Abbrev = 0;
1342 unsigned CString6Abbrev = 0;
1343 // If this is a constant pool for the module, emit module-specific abbrevs.
1345 // Abbrev for CST_CODE_AGGREGATE.
1346 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1347 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_AGGREGATE));
1348 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1349 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, Log2_32_Ceil(LastVal+1)));
1350 AggregateAbbrev = Stream.EmitAbbrev(Abbv);
1352 // Abbrev for CST_CODE_STRING.
1353 Abbv = new BitCodeAbbrev();
1354 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_STRING));
1355 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1356 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
1357 String8Abbrev = Stream.EmitAbbrev(Abbv);
1358 // Abbrev for CST_CODE_CSTRING.
1359 Abbv = new BitCodeAbbrev();
1360 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_CSTRING));
1361 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1362 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7));
1363 CString7Abbrev = Stream.EmitAbbrev(Abbv);
1364 // Abbrev for CST_CODE_CSTRING.
1365 Abbv = new BitCodeAbbrev();
1366 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_CSTRING));
1367 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1368 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
1369 CString6Abbrev = Stream.EmitAbbrev(Abbv);
1372 SmallVector<uint64_t, 64> Record;
1374 const ValueEnumerator::ValueList &Vals = VE.getValues();
1375 Type *LastTy = nullptr;
1376 for (unsigned i = FirstVal; i != LastVal; ++i) {
1377 const Value *V = Vals[i].first;
1378 // If we need to switch types, do so now.
1379 if (V->getType() != LastTy) {
1380 LastTy = V->getType();
1381 Record.push_back(VE.getTypeID(LastTy));
1382 Stream.EmitRecord(bitc::CST_CODE_SETTYPE, Record,
1383 CONSTANTS_SETTYPE_ABBREV);
1387 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1388 Record.push_back(unsigned(IA->hasSideEffects()) |
1389 unsigned(IA->isAlignStack()) << 1 |
1390 unsigned(IA->getDialect()&1) << 2);
1392 // Add the asm string.
1393 const std::string &AsmStr = IA->getAsmString();
1394 Record.push_back(AsmStr.size());
1395 Record.append(AsmStr.begin(), AsmStr.end());
1397 // Add the constraint string.
1398 const std::string &ConstraintStr = IA->getConstraintString();
1399 Record.push_back(ConstraintStr.size());
1400 Record.append(ConstraintStr.begin(), ConstraintStr.end());
1401 Stream.EmitRecord(bitc::CST_CODE_INLINEASM, Record);
1405 const Constant *C = cast<Constant>(V);
1406 unsigned Code = -1U;
1407 unsigned AbbrevToUse = 0;
1408 if (C->isNullValue()) {
1409 Code = bitc::CST_CODE_NULL;
1410 } else if (isa<UndefValue>(C)) {
1411 Code = bitc::CST_CODE_UNDEF;
1412 } else if (const ConstantInt *IV = dyn_cast<ConstantInt>(C)) {
1413 if (IV->getBitWidth() <= 64) {
1414 uint64_t V = IV->getSExtValue();
1415 emitSignedInt64(Record, V);
1416 Code = bitc::CST_CODE_INTEGER;
1417 AbbrevToUse = CONSTANTS_INTEGER_ABBREV;
1418 } else { // Wide integers, > 64 bits in size.
1419 // We have an arbitrary precision integer value to write whose
1420 // bit width is > 64. However, in canonical unsigned integer
1421 // format it is likely that the high bits are going to be zero.
1422 // So, we only write the number of active words.
1423 unsigned NWords = IV->getValue().getActiveWords();
1424 const uint64_t *RawWords = IV->getValue().getRawData();
1425 for (unsigned i = 0; i != NWords; ++i) {
1426 emitSignedInt64(Record, RawWords[i]);
1428 Code = bitc::CST_CODE_WIDE_INTEGER;
1430 } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(C)) {
1431 Code = bitc::CST_CODE_FLOAT;
1432 Type *Ty = CFP->getType();
1433 if (Ty->isHalfTy() || Ty->isFloatTy() || Ty->isDoubleTy()) {
1434 Record.push_back(CFP->getValueAPF().bitcastToAPInt().getZExtValue());
1435 } else if (Ty->isX86_FP80Ty()) {
1436 // api needed to prevent premature destruction
1437 // bits are not in the same order as a normal i80 APInt, compensate.
1438 APInt api = CFP->getValueAPF().bitcastToAPInt();
1439 const uint64_t *p = api.getRawData();
1440 Record.push_back((p[1] << 48) | (p[0] >> 16));
1441 Record.push_back(p[0] & 0xffffLL);
1442 } else if (Ty->isFP128Ty() || Ty->isPPC_FP128Ty()) {
1443 APInt api = CFP->getValueAPF().bitcastToAPInt();
1444 const uint64_t *p = api.getRawData();
1445 Record.push_back(p[0]);
1446 Record.push_back(p[1]);
1448 assert (0 && "Unknown FP type!");
1450 } else if (isa<ConstantDataSequential>(C) &&
1451 cast<ConstantDataSequential>(C)->isString()) {
1452 const ConstantDataSequential *Str = cast<ConstantDataSequential>(C);
1453 // Emit constant strings specially.
1454 unsigned NumElts = Str->getNumElements();
1455 // If this is a null-terminated string, use the denser CSTRING encoding.
1456 if (Str->isCString()) {
1457 Code = bitc::CST_CODE_CSTRING;
1458 --NumElts; // Don't encode the null, which isn't allowed by char6.
1460 Code = bitc::CST_CODE_STRING;
1461 AbbrevToUse = String8Abbrev;
1463 bool isCStr7 = Code == bitc::CST_CODE_CSTRING;
1464 bool isCStrChar6 = Code == bitc::CST_CODE_CSTRING;
1465 for (unsigned i = 0; i != NumElts; ++i) {
1466 unsigned char V = Str->getElementAsInteger(i);
1467 Record.push_back(V);
1468 isCStr7 &= (V & 128) == 0;
1470 isCStrChar6 = BitCodeAbbrevOp::isChar6(V);
1474 AbbrevToUse = CString6Abbrev;
1476 AbbrevToUse = CString7Abbrev;
1477 } else if (const ConstantDataSequential *CDS =
1478 dyn_cast<ConstantDataSequential>(C)) {
1479 Code = bitc::CST_CODE_DATA;
1480 Type *EltTy = CDS->getType()->getElementType();
1481 if (isa<IntegerType>(EltTy)) {
1482 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i)
1483 Record.push_back(CDS->getElementAsInteger(i));
1484 } else if (EltTy->isFloatTy()) {
1485 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1486 union { float F; uint32_t I; };
1487 F = CDS->getElementAsFloat(i);
1488 Record.push_back(I);
1491 assert(EltTy->isDoubleTy() && "Unknown ConstantData element type");
1492 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1493 union { double F; uint64_t I; };
1494 F = CDS->getElementAsDouble(i);
1495 Record.push_back(I);
1498 } else if (isa<ConstantArray>(C) || isa<ConstantStruct>(C) ||
1499 isa<ConstantVector>(C)) {
1500 Code = bitc::CST_CODE_AGGREGATE;
1501 for (unsigned i = 0, e = C->getNumOperands(); i != e; ++i)
1502 Record.push_back(VE.getValueID(C->getOperand(i)));
1503 AbbrevToUse = AggregateAbbrev;
1504 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
1505 switch (CE->getOpcode()) {
1507 if (Instruction::isCast(CE->getOpcode())) {
1508 Code = bitc::CST_CODE_CE_CAST;
1509 Record.push_back(GetEncodedCastOpcode(CE->getOpcode()));
1510 Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
1511 Record.push_back(VE.getValueID(C->getOperand(0)));
1512 AbbrevToUse = CONSTANTS_CE_CAST_Abbrev;
1514 assert(CE->getNumOperands() == 2 && "Unknown constant expr!");
1515 Code = bitc::CST_CODE_CE_BINOP;
1516 Record.push_back(GetEncodedBinaryOpcode(CE->getOpcode()));
1517 Record.push_back(VE.getValueID(C->getOperand(0)));
1518 Record.push_back(VE.getValueID(C->getOperand(1)));
1519 uint64_t Flags = GetOptimizationFlags(CE);
1521 Record.push_back(Flags);
1524 case Instruction::GetElementPtr:
1525 Code = bitc::CST_CODE_CE_GEP;
1526 if (cast<GEPOperator>(C)->isInBounds())
1527 Code = bitc::CST_CODE_CE_INBOUNDS_GEP;
1528 for (unsigned i = 0, e = CE->getNumOperands(); i != e; ++i) {
1529 Record.push_back(VE.getTypeID(C->getOperand(i)->getType()));
1530 Record.push_back(VE.getValueID(C->getOperand(i)));
1533 case Instruction::Select:
1534 Code = bitc::CST_CODE_CE_SELECT;
1535 Record.push_back(VE.getValueID(C->getOperand(0)));
1536 Record.push_back(VE.getValueID(C->getOperand(1)));
1537 Record.push_back(VE.getValueID(C->getOperand(2)));
1539 case Instruction::ExtractElement:
1540 Code = bitc::CST_CODE_CE_EXTRACTELT;
1541 Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
1542 Record.push_back(VE.getValueID(C->getOperand(0)));
1543 Record.push_back(VE.getTypeID(C->getOperand(1)->getType()));
1544 Record.push_back(VE.getValueID(C->getOperand(1)));
1546 case Instruction::InsertElement:
1547 Code = bitc::CST_CODE_CE_INSERTELT;
1548 Record.push_back(VE.getValueID(C->getOperand(0)));
1549 Record.push_back(VE.getValueID(C->getOperand(1)));
1550 Record.push_back(VE.getTypeID(C->getOperand(2)->getType()));
1551 Record.push_back(VE.getValueID(C->getOperand(2)));
1553 case Instruction::ShuffleVector:
1554 // If the return type and argument types are the same, this is a
1555 // standard shufflevector instruction. If the types are different,
1556 // then the shuffle is widening or truncating the input vectors, and
1557 // the argument type must also be encoded.
1558 if (C->getType() == C->getOperand(0)->getType()) {
1559 Code = bitc::CST_CODE_CE_SHUFFLEVEC;
1561 Code = bitc::CST_CODE_CE_SHUFVEC_EX;
1562 Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
1564 Record.push_back(VE.getValueID(C->getOperand(0)));
1565 Record.push_back(VE.getValueID(C->getOperand(1)));
1566 Record.push_back(VE.getValueID(C->getOperand(2)));
1568 case Instruction::ICmp:
1569 case Instruction::FCmp:
1570 Code = bitc::CST_CODE_CE_CMP;
1571 Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
1572 Record.push_back(VE.getValueID(C->getOperand(0)));
1573 Record.push_back(VE.getValueID(C->getOperand(1)));
1574 Record.push_back(CE->getPredicate());
1577 } else if (const BlockAddress *BA = dyn_cast<BlockAddress>(C)) {
1578 Code = bitc::CST_CODE_BLOCKADDRESS;
1579 Record.push_back(VE.getTypeID(BA->getFunction()->getType()));
1580 Record.push_back(VE.getValueID(BA->getFunction()));
1581 Record.push_back(VE.getGlobalBasicBlockID(BA->getBasicBlock()));
1586 llvm_unreachable("Unknown constant!");
1588 Stream.EmitRecord(Code, Record, AbbrevToUse);
1595 static void WriteModuleConstants(const ValueEnumerator &VE,
1596 BitstreamWriter &Stream) {
1597 const ValueEnumerator::ValueList &Vals = VE.getValues();
1599 // Find the first constant to emit, which is the first non-globalvalue value.
1600 // We know globalvalues have been emitted by WriteModuleInfo.
1601 for (unsigned i = 0, e = Vals.size(); i != e; ++i) {
1602 if (!isa<GlobalValue>(Vals[i].first)) {
1603 WriteConstants(i, Vals.size(), VE, Stream, true);
1609 /// PushValueAndType - The file has to encode both the value and type id for
1610 /// many values, because we need to know what type to create for forward
1611 /// references. However, most operands are not forward references, so this type
1612 /// field is not needed.
1614 /// This function adds V's value ID to Vals. If the value ID is higher than the
1615 /// instruction ID, then it is a forward reference, and it also includes the
1616 /// type ID. The value ID that is written is encoded relative to the InstID.
1617 static bool PushValueAndType(const Value *V, unsigned InstID,
1618 SmallVectorImpl<unsigned> &Vals,
1619 ValueEnumerator &VE) {
1620 unsigned ValID = VE.getValueID(V);
1621 // Make encoding relative to the InstID.
1622 Vals.push_back(InstID - ValID);
1623 if (ValID >= InstID) {
1624 Vals.push_back(VE.getTypeID(V->getType()));
1630 /// pushValue - Like PushValueAndType, but where the type of the value is
1631 /// omitted (perhaps it was already encoded in an earlier operand).
1632 static void pushValue(const Value *V, unsigned InstID,
1633 SmallVectorImpl<unsigned> &Vals,
1634 ValueEnumerator &VE) {
1635 unsigned ValID = VE.getValueID(V);
1636 Vals.push_back(InstID - ValID);
1639 static void pushValueSigned(const Value *V, unsigned InstID,
1640 SmallVectorImpl<uint64_t> &Vals,
1641 ValueEnumerator &VE) {
1642 unsigned ValID = VE.getValueID(V);
1643 int64_t diff = ((int32_t)InstID - (int32_t)ValID);
1644 emitSignedInt64(Vals, diff);
1647 /// WriteInstruction - Emit an instruction to the specified stream.
1648 static void WriteInstruction(const Instruction &I, unsigned InstID,
1649 ValueEnumerator &VE, BitstreamWriter &Stream,
1650 SmallVectorImpl<unsigned> &Vals) {
1652 unsigned AbbrevToUse = 0;
1653 VE.setInstructionID(&I);
1654 switch (I.getOpcode()) {
1656 if (Instruction::isCast(I.getOpcode())) {
1657 Code = bitc::FUNC_CODE_INST_CAST;
1658 if (!PushValueAndType(I.getOperand(0), InstID, Vals, VE))
1659 AbbrevToUse = FUNCTION_INST_CAST_ABBREV;
1660 Vals.push_back(VE.getTypeID(I.getType()));
1661 Vals.push_back(GetEncodedCastOpcode(I.getOpcode()));
1663 assert(isa<BinaryOperator>(I) && "Unknown instruction!");
1664 Code = bitc::FUNC_CODE_INST_BINOP;
1665 if (!PushValueAndType(I.getOperand(0), InstID, Vals, VE))
1666 AbbrevToUse = FUNCTION_INST_BINOP_ABBREV;
1667 pushValue(I.getOperand(1), InstID, Vals, VE);
1668 Vals.push_back(GetEncodedBinaryOpcode(I.getOpcode()));
1669 uint64_t Flags = GetOptimizationFlags(&I);
1671 if (AbbrevToUse == FUNCTION_INST_BINOP_ABBREV)
1672 AbbrevToUse = FUNCTION_INST_BINOP_FLAGS_ABBREV;
1673 Vals.push_back(Flags);
1678 case Instruction::GetElementPtr:
1679 Code = bitc::FUNC_CODE_INST_GEP;
1680 if (cast<GEPOperator>(&I)->isInBounds())
1681 Code = bitc::FUNC_CODE_INST_INBOUNDS_GEP;
1682 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
1683 PushValueAndType(I.getOperand(i), InstID, Vals, VE);
1685 case Instruction::ExtractValue: {
1686 Code = bitc::FUNC_CODE_INST_EXTRACTVAL;
1687 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1688 const ExtractValueInst *EVI = cast<ExtractValueInst>(&I);
1689 Vals.append(EVI->idx_begin(), EVI->idx_end());
1692 case Instruction::InsertValue: {
1693 Code = bitc::FUNC_CODE_INST_INSERTVAL;
1694 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1695 PushValueAndType(I.getOperand(1), InstID, Vals, VE);
1696 const InsertValueInst *IVI = cast<InsertValueInst>(&I);
1697 Vals.append(IVI->idx_begin(), IVI->idx_end());
1700 case Instruction::Select:
1701 Code = bitc::FUNC_CODE_INST_VSELECT;
1702 PushValueAndType(I.getOperand(1), InstID, Vals, VE);
1703 pushValue(I.getOperand(2), InstID, Vals, VE);
1704 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1706 case Instruction::ExtractElement:
1707 Code = bitc::FUNC_CODE_INST_EXTRACTELT;
1708 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1709 PushValueAndType(I.getOperand(1), InstID, Vals, VE);
1711 case Instruction::InsertElement:
1712 Code = bitc::FUNC_CODE_INST_INSERTELT;
1713 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1714 pushValue(I.getOperand(1), InstID, Vals, VE);
1715 PushValueAndType(I.getOperand(2), InstID, Vals, VE);
1717 case Instruction::ShuffleVector:
1718 Code = bitc::FUNC_CODE_INST_SHUFFLEVEC;
1719 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1720 pushValue(I.getOperand(1), InstID, Vals, VE);
1721 pushValue(I.getOperand(2), InstID, Vals, VE);
1723 case Instruction::ICmp:
1724 case Instruction::FCmp:
1725 // compare returning Int1Ty or vector of Int1Ty
1726 Code = bitc::FUNC_CODE_INST_CMP2;
1727 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1728 pushValue(I.getOperand(1), InstID, Vals, VE);
1729 Vals.push_back(cast<CmpInst>(I).getPredicate());
1732 case Instruction::Ret:
1734 Code = bitc::FUNC_CODE_INST_RET;
1735 unsigned NumOperands = I.getNumOperands();
1736 if (NumOperands == 0)
1737 AbbrevToUse = FUNCTION_INST_RET_VOID_ABBREV;
1738 else if (NumOperands == 1) {
1739 if (!PushValueAndType(I.getOperand(0), InstID, Vals, VE))
1740 AbbrevToUse = FUNCTION_INST_RET_VAL_ABBREV;
1742 for (unsigned i = 0, e = NumOperands; i != e; ++i)
1743 PushValueAndType(I.getOperand(i), InstID, Vals, VE);
1747 case Instruction::Br:
1749 Code = bitc::FUNC_CODE_INST_BR;
1750 const BranchInst &II = cast<BranchInst>(I);
1751 Vals.push_back(VE.getValueID(II.getSuccessor(0)));
1752 if (II.isConditional()) {
1753 Vals.push_back(VE.getValueID(II.getSuccessor(1)));
1754 pushValue(II.getCondition(), InstID, Vals, VE);
1758 case Instruction::Switch:
1760 Code = bitc::FUNC_CODE_INST_SWITCH;
1761 const SwitchInst &SI = cast<SwitchInst>(I);
1762 Vals.push_back(VE.getTypeID(SI.getCondition()->getType()));
1763 pushValue(SI.getCondition(), InstID, Vals, VE);
1764 Vals.push_back(VE.getValueID(SI.getDefaultDest()));
1765 for (SwitchInst::ConstCaseIt i = SI.case_begin(), e = SI.case_end();
1767 Vals.push_back(VE.getValueID(i.getCaseValue()));
1768 Vals.push_back(VE.getValueID(i.getCaseSuccessor()));
1772 case Instruction::IndirectBr:
1773 Code = bitc::FUNC_CODE_INST_INDIRECTBR;
1774 Vals.push_back(VE.getTypeID(I.getOperand(0)->getType()));
1775 // Encode the address operand as relative, but not the basic blocks.
1776 pushValue(I.getOperand(0), InstID, Vals, VE);
1777 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i)
1778 Vals.push_back(VE.getValueID(I.getOperand(i)));
1781 case Instruction::Invoke: {
1782 const InvokeInst *II = cast<InvokeInst>(&I);
1783 const Value *Callee(II->getCalledValue());
1784 PointerType *PTy = cast<PointerType>(Callee->getType());
1785 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1786 Code = bitc::FUNC_CODE_INST_INVOKE;
1788 Vals.push_back(VE.getAttributeID(II->getAttributes()));
1789 Vals.push_back(II->getCallingConv());
1790 Vals.push_back(VE.getValueID(II->getNormalDest()));
1791 Vals.push_back(VE.getValueID(II->getUnwindDest()));
1792 PushValueAndType(Callee, InstID, Vals, VE);
1794 // Emit value #'s for the fixed parameters.
1795 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
1796 pushValue(I.getOperand(i), InstID, Vals, VE); // fixed param.
1798 // Emit type/value pairs for varargs params.
1799 if (FTy->isVarArg()) {
1800 for (unsigned i = FTy->getNumParams(), e = I.getNumOperands()-3;
1802 PushValueAndType(I.getOperand(i), InstID, Vals, VE); // vararg
1806 case Instruction::Resume:
1807 Code = bitc::FUNC_CODE_INST_RESUME;
1808 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1810 case Instruction::Unreachable:
1811 Code = bitc::FUNC_CODE_INST_UNREACHABLE;
1812 AbbrevToUse = FUNCTION_INST_UNREACHABLE_ABBREV;
1815 case Instruction::PHI: {
1816 const PHINode &PN = cast<PHINode>(I);
1817 Code = bitc::FUNC_CODE_INST_PHI;
1818 // With the newer instruction encoding, forward references could give
1819 // negative valued IDs. This is most common for PHIs, so we use
1821 SmallVector<uint64_t, 128> Vals64;
1822 Vals64.push_back(VE.getTypeID(PN.getType()));
1823 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
1824 pushValueSigned(PN.getIncomingValue(i), InstID, Vals64, VE);
1825 Vals64.push_back(VE.getValueID(PN.getIncomingBlock(i)));
1827 // Emit a Vals64 vector and exit.
1828 Stream.EmitRecord(Code, Vals64, AbbrevToUse);
1833 case Instruction::LandingPad: {
1834 const LandingPadInst &LP = cast<LandingPadInst>(I);
1835 Code = bitc::FUNC_CODE_INST_LANDINGPAD;
1836 Vals.push_back(VE.getTypeID(LP.getType()));
1837 PushValueAndType(LP.getPersonalityFn(), InstID, Vals, VE);
1838 Vals.push_back(LP.isCleanup());
1839 Vals.push_back(LP.getNumClauses());
1840 for (unsigned I = 0, E = LP.getNumClauses(); I != E; ++I) {
1842 Vals.push_back(LandingPadInst::Catch);
1844 Vals.push_back(LandingPadInst::Filter);
1845 PushValueAndType(LP.getClause(I), InstID, Vals, VE);
1850 case Instruction::Alloca: {
1851 Code = bitc::FUNC_CODE_INST_ALLOCA;
1852 Vals.push_back(VE.getTypeID(I.getType()));
1853 Vals.push_back(VE.getTypeID(I.getOperand(0)->getType()));
1854 Vals.push_back(VE.getValueID(I.getOperand(0))); // size.
1855 const AllocaInst &AI = cast<AllocaInst>(I);
1856 unsigned AlignRecord = Log2_32(AI.getAlignment()) + 1;
1857 assert(Log2_32(Value::MaximumAlignment) + 1 < 1 << 5 &&
1858 "not enough bits for maximum alignment");
1859 assert(AlignRecord < 1 << 5 && "alignment greater than 1 << 64");
1860 AlignRecord |= AI.isUsedWithInAlloca() << 5;
1861 Vals.push_back(AlignRecord);
1865 case Instruction::Load:
1866 if (cast<LoadInst>(I).isAtomic()) {
1867 Code = bitc::FUNC_CODE_INST_LOADATOMIC;
1868 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1870 Code = bitc::FUNC_CODE_INST_LOAD;
1871 if (!PushValueAndType(I.getOperand(0), InstID, Vals, VE)) // ptr
1872 AbbrevToUse = FUNCTION_INST_LOAD_ABBREV;
1874 Vals.push_back(Log2_32(cast<LoadInst>(I).getAlignment())+1);
1875 Vals.push_back(cast<LoadInst>(I).isVolatile());
1876 if (cast<LoadInst>(I).isAtomic()) {
1877 Vals.push_back(GetEncodedOrdering(cast<LoadInst>(I).getOrdering()));
1878 Vals.push_back(GetEncodedSynchScope(cast<LoadInst>(I).getSynchScope()));
1881 case Instruction::Store:
1882 if (cast<StoreInst>(I).isAtomic())
1883 Code = bitc::FUNC_CODE_INST_STOREATOMIC;
1885 Code = bitc::FUNC_CODE_INST_STORE;
1886 PushValueAndType(I.getOperand(1), InstID, Vals, VE); // ptrty + ptr
1887 pushValue(I.getOperand(0), InstID, Vals, VE); // val.
1888 Vals.push_back(Log2_32(cast<StoreInst>(I).getAlignment())+1);
1889 Vals.push_back(cast<StoreInst>(I).isVolatile());
1890 if (cast<StoreInst>(I).isAtomic()) {
1891 Vals.push_back(GetEncodedOrdering(cast<StoreInst>(I).getOrdering()));
1892 Vals.push_back(GetEncodedSynchScope(cast<StoreInst>(I).getSynchScope()));
1895 case Instruction::AtomicCmpXchg:
1896 Code = bitc::FUNC_CODE_INST_CMPXCHG;
1897 PushValueAndType(I.getOperand(0), InstID, Vals, VE); // ptrty + ptr
1898 pushValue(I.getOperand(1), InstID, Vals, VE); // cmp.
1899 pushValue(I.getOperand(2), InstID, Vals, VE); // newval.
1900 Vals.push_back(cast<AtomicCmpXchgInst>(I).isVolatile());
1901 Vals.push_back(GetEncodedOrdering(
1902 cast<AtomicCmpXchgInst>(I).getSuccessOrdering()));
1903 Vals.push_back(GetEncodedSynchScope(
1904 cast<AtomicCmpXchgInst>(I).getSynchScope()));
1905 Vals.push_back(GetEncodedOrdering(
1906 cast<AtomicCmpXchgInst>(I).getFailureOrdering()));
1907 Vals.push_back(cast<AtomicCmpXchgInst>(I).isWeak());
1909 case Instruction::AtomicRMW:
1910 Code = bitc::FUNC_CODE_INST_ATOMICRMW;
1911 PushValueAndType(I.getOperand(0), InstID, Vals, VE); // ptrty + ptr
1912 pushValue(I.getOperand(1), InstID, Vals, VE); // val.
1913 Vals.push_back(GetEncodedRMWOperation(
1914 cast<AtomicRMWInst>(I).getOperation()));
1915 Vals.push_back(cast<AtomicRMWInst>(I).isVolatile());
1916 Vals.push_back(GetEncodedOrdering(cast<AtomicRMWInst>(I).getOrdering()));
1917 Vals.push_back(GetEncodedSynchScope(
1918 cast<AtomicRMWInst>(I).getSynchScope()));
1920 case Instruction::Fence:
1921 Code = bitc::FUNC_CODE_INST_FENCE;
1922 Vals.push_back(GetEncodedOrdering(cast<FenceInst>(I).getOrdering()));
1923 Vals.push_back(GetEncodedSynchScope(cast<FenceInst>(I).getSynchScope()));
1925 case Instruction::Call: {
1926 const CallInst &CI = cast<CallInst>(I);
1927 PointerType *PTy = cast<PointerType>(CI.getCalledValue()->getType());
1928 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1930 Code = bitc::FUNC_CODE_INST_CALL;
1932 Vals.push_back(VE.getAttributeID(CI.getAttributes()));
1933 Vals.push_back((CI.getCallingConv() << 1) | unsigned(CI.isTailCall()) |
1934 unsigned(CI.isMustTailCall()) << 14);
1935 PushValueAndType(CI.getCalledValue(), InstID, Vals, VE); // Callee
1937 // Emit value #'s for the fixed parameters.
1938 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) {
1939 // Check for labels (can happen with asm labels).
1940 if (FTy->getParamType(i)->isLabelTy())
1941 Vals.push_back(VE.getValueID(CI.getArgOperand(i)));
1943 pushValue(CI.getArgOperand(i), InstID, Vals, VE); // fixed param.
1946 // Emit type/value pairs for varargs params.
1947 if (FTy->isVarArg()) {
1948 for (unsigned i = FTy->getNumParams(), e = CI.getNumArgOperands();
1950 PushValueAndType(CI.getArgOperand(i), InstID, Vals, VE); // varargs
1954 case Instruction::VAArg:
1955 Code = bitc::FUNC_CODE_INST_VAARG;
1956 Vals.push_back(VE.getTypeID(I.getOperand(0)->getType())); // valistty
1957 pushValue(I.getOperand(0), InstID, Vals, VE); // valist.
1958 Vals.push_back(VE.getTypeID(I.getType())); // restype.
1962 Stream.EmitRecord(Code, Vals, AbbrevToUse);
1966 // Emit names for globals/functions etc.
1967 static void WriteValueSymbolTable(const ValueSymbolTable &VST,
1968 const ValueEnumerator &VE,
1969 BitstreamWriter &Stream) {
1970 if (VST.empty()) return;
1971 Stream.EnterSubblock(bitc::VALUE_SYMTAB_BLOCK_ID, 4);
1973 // FIXME: Set up the abbrev, we know how many values there are!
1974 // FIXME: We know if the type names can use 7-bit ascii.
1975 SmallVector<unsigned, 64> NameVals;
1977 for (ValueSymbolTable::const_iterator SI = VST.begin(), SE = VST.end();
1980 const ValueName &Name = *SI;
1982 // Figure out the encoding to use for the name.
1984 bool isChar6 = true;
1985 for (const char *C = Name.getKeyData(), *E = C+Name.getKeyLength();
1988 isChar6 = BitCodeAbbrevOp::isChar6(*C);
1989 if ((unsigned char)*C & 128) {
1991 break; // don't bother scanning the rest.
1995 unsigned AbbrevToUse = VST_ENTRY_8_ABBREV;
1997 // VST_ENTRY: [valueid, namechar x N]
1998 // VST_BBENTRY: [bbid, namechar x N]
2000 if (isa<BasicBlock>(SI->getValue())) {
2001 Code = bitc::VST_CODE_BBENTRY;
2003 AbbrevToUse = VST_BBENTRY_6_ABBREV;
2005 Code = bitc::VST_CODE_ENTRY;
2007 AbbrevToUse = VST_ENTRY_6_ABBREV;
2009 AbbrevToUse = VST_ENTRY_7_ABBREV;
2012 NameVals.push_back(VE.getValueID(SI->getValue()));
2013 for (const char *P = Name.getKeyData(),
2014 *E = Name.getKeyData()+Name.getKeyLength(); P != E; ++P)
2015 NameVals.push_back((unsigned char)*P);
2017 // Emit the finished record.
2018 Stream.EmitRecord(Code, NameVals, AbbrevToUse);
2024 static void WriteUseList(ValueEnumerator &VE, UseListOrder &&Order,
2025 BitstreamWriter &Stream) {
2026 assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
2028 if (isa<BasicBlock>(Order.V))
2029 Code = bitc::USELIST_CODE_BB;
2031 Code = bitc::USELIST_CODE_DEFAULT;
2033 SmallVector<uint64_t, 64> Record(Order.Shuffle.begin(), Order.Shuffle.end());
2034 Record.push_back(VE.getValueID(Order.V));
2035 Stream.EmitRecord(Code, Record);
2038 static void WriteUseListBlock(const Function *F, ValueEnumerator &VE,
2039 BitstreamWriter &Stream) {
2040 auto hasMore = [&]() {
2041 return !VE.UseListOrders.empty() && VE.UseListOrders.back().F == F;
2047 Stream.EnterSubblock(bitc::USELIST_BLOCK_ID, 3);
2049 WriteUseList(VE, std::move(VE.UseListOrders.back()), Stream);
2050 VE.UseListOrders.pop_back();
2055 /// WriteFunction - Emit a function body to the module stream.
2056 static void WriteFunction(const Function &F, ValueEnumerator &VE,
2057 BitstreamWriter &Stream) {
2058 Stream.EnterSubblock(bitc::FUNCTION_BLOCK_ID, 4);
2059 VE.incorporateFunction(F);
2061 SmallVector<unsigned, 64> Vals;
2063 // Emit the number of basic blocks, so the reader can create them ahead of
2065 Vals.push_back(VE.getBasicBlocks().size());
2066 Stream.EmitRecord(bitc::FUNC_CODE_DECLAREBLOCKS, Vals);
2069 // If there are function-local constants, emit them now.
2070 unsigned CstStart, CstEnd;
2071 VE.getFunctionConstantRange(CstStart, CstEnd);
2072 WriteConstants(CstStart, CstEnd, VE, Stream, false);
2074 // If there is function-local metadata, emit it now.
2075 WriteFunctionLocalMetadata(F, VE, Stream);
2077 // Keep a running idea of what the instruction ID is.
2078 unsigned InstID = CstEnd;
2080 bool NeedsMetadataAttachment = false;
2084 // Finally, emit all the instructions, in order.
2085 for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
2086 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end();
2088 WriteInstruction(*I, InstID, VE, Stream, Vals);
2090 if (!I->getType()->isVoidTy())
2093 // If the instruction has metadata, write a metadata attachment later.
2094 NeedsMetadataAttachment |= I->hasMetadataOtherThanDebugLoc();
2096 // If the instruction has a debug location, emit it.
2097 DebugLoc DL = I->getDebugLoc();
2098 if (DL.isUnknown()) {
2100 } else if (DL == LastDL) {
2101 // Just repeat the same debug loc as last time.
2102 Stream.EmitRecord(bitc::FUNC_CODE_DEBUG_LOC_AGAIN, Vals);
2105 DL.getScopeAndInlinedAt(Scope, IA, I->getContext());
2106 assert(Scope && "Expected valid scope");
2108 Vals.push_back(DL.getLine());
2109 Vals.push_back(DL.getCol());
2110 Vals.push_back(VE.getMetadataOrNullID(Scope));
2111 Vals.push_back(VE.getMetadataOrNullID(IA));
2112 Stream.EmitRecord(bitc::FUNC_CODE_DEBUG_LOC, Vals);
2119 // Emit names for all the instructions etc.
2120 WriteValueSymbolTable(F.getValueSymbolTable(), VE, Stream);
2122 if (NeedsMetadataAttachment)
2123 WriteMetadataAttachment(F, VE, Stream);
2124 if (shouldPreserveBitcodeUseListOrder())
2125 WriteUseListBlock(&F, VE, Stream);
2130 // Emit blockinfo, which defines the standard abbreviations etc.
2131 static void WriteBlockInfo(const ValueEnumerator &VE, BitstreamWriter &Stream) {
2132 // We only want to emit block info records for blocks that have multiple
2133 // instances: CONSTANTS_BLOCK, FUNCTION_BLOCK and VALUE_SYMTAB_BLOCK.
2134 // Other blocks can define their abbrevs inline.
2135 Stream.EnterBlockInfoBlock(2);
2137 { // 8-bit fixed-width VST_ENTRY/VST_BBENTRY strings.
2138 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2139 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3));
2140 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
2141 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
2142 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
2143 if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
2144 Abbv) != VST_ENTRY_8_ABBREV)
2145 llvm_unreachable("Unexpected abbrev ordering!");
2148 { // 7-bit fixed width VST_ENTRY strings.
2149 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2150 Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_ENTRY));
2151 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
2152 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
2153 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7));
2154 if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
2155 Abbv) != VST_ENTRY_7_ABBREV)
2156 llvm_unreachable("Unexpected abbrev ordering!");
2158 { // 6-bit char6 VST_ENTRY strings.
2159 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2160 Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_ENTRY));
2161 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
2162 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
2163 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
2164 if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
2165 Abbv) != VST_ENTRY_6_ABBREV)
2166 llvm_unreachable("Unexpected abbrev ordering!");
2168 { // 6-bit char6 VST_BBENTRY strings.
2169 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2170 Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_BBENTRY));
2171 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
2172 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
2173 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
2174 if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
2175 Abbv) != VST_BBENTRY_6_ABBREV)
2176 llvm_unreachable("Unexpected abbrev ordering!");
2181 { // SETTYPE abbrev for CONSTANTS_BLOCK.
2182 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2183 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_SETTYPE));
2184 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
2185 VE.computeBitsRequiredForTypeIndicies()));
2186 if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
2187 Abbv) != CONSTANTS_SETTYPE_ABBREV)
2188 llvm_unreachable("Unexpected abbrev ordering!");
2191 { // INTEGER abbrev for CONSTANTS_BLOCK.
2192 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2193 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_INTEGER));
2194 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
2195 if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
2196 Abbv) != CONSTANTS_INTEGER_ABBREV)
2197 llvm_unreachable("Unexpected abbrev ordering!");
2200 { // CE_CAST abbrev for CONSTANTS_BLOCK.
2201 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2202 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_CE_CAST));
2203 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // cast opc
2204 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, // typeid
2205 VE.computeBitsRequiredForTypeIndicies()));
2206 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // value id
2208 if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
2209 Abbv) != CONSTANTS_CE_CAST_Abbrev)
2210 llvm_unreachable("Unexpected abbrev ordering!");
2212 { // NULL abbrev for CONSTANTS_BLOCK.
2213 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2214 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_NULL));
2215 if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
2216 Abbv) != CONSTANTS_NULL_Abbrev)
2217 llvm_unreachable("Unexpected abbrev ordering!");
2220 // FIXME: This should only use space for first class types!
2222 { // INST_LOAD abbrev for FUNCTION_BLOCK.
2223 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2224 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_LOAD));
2225 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Ptr
2226 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // Align
2227 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // volatile
2228 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
2229 Abbv) != FUNCTION_INST_LOAD_ABBREV)
2230 llvm_unreachable("Unexpected abbrev ordering!");
2232 { // INST_BINOP abbrev for FUNCTION_BLOCK.
2233 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2234 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_BINOP));
2235 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LHS
2236 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // RHS
2237 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // opc
2238 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
2239 Abbv) != FUNCTION_INST_BINOP_ABBREV)
2240 llvm_unreachable("Unexpected abbrev ordering!");
2242 { // INST_BINOP_FLAGS abbrev for FUNCTION_BLOCK.
2243 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2244 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_BINOP));
2245 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LHS
2246 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // RHS
2247 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // opc
2248 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7)); // flags
2249 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
2250 Abbv) != FUNCTION_INST_BINOP_FLAGS_ABBREV)
2251 llvm_unreachable("Unexpected abbrev ordering!");
2253 { // INST_CAST abbrev for FUNCTION_BLOCK.
2254 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2255 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_CAST));
2256 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // OpVal
2257 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, // dest ty
2258 VE.computeBitsRequiredForTypeIndicies()));
2259 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // opc
2260 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
2261 Abbv) != FUNCTION_INST_CAST_ABBREV)
2262 llvm_unreachable("Unexpected abbrev ordering!");
2265 { // INST_RET abbrev for FUNCTION_BLOCK.
2266 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2267 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_RET));
2268 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
2269 Abbv) != FUNCTION_INST_RET_VOID_ABBREV)
2270 llvm_unreachable("Unexpected abbrev ordering!");
2272 { // INST_RET abbrev for FUNCTION_BLOCK.
2273 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2274 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_RET));
2275 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ValID
2276 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
2277 Abbv) != FUNCTION_INST_RET_VAL_ABBREV)
2278 llvm_unreachable("Unexpected abbrev ordering!");
2280 { // INST_UNREACHABLE abbrev for FUNCTION_BLOCK.
2281 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2282 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_UNREACHABLE));
2283 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
2284 Abbv) != FUNCTION_INST_UNREACHABLE_ABBREV)
2285 llvm_unreachable("Unexpected abbrev ordering!");
2291 /// WriteModule - Emit the specified module to the bitstream.
2292 static void WriteModule(const Module *M, BitstreamWriter &Stream) {
2293 Stream.EnterSubblock(bitc::MODULE_BLOCK_ID, 3);
2295 SmallVector<unsigned, 1> Vals;
2296 unsigned CurVersion = 1;
2297 Vals.push_back(CurVersion);
2298 Stream.EmitRecord(bitc::MODULE_CODE_VERSION, Vals);
2300 // Analyze the module, enumerating globals, functions, etc.
2301 ValueEnumerator VE(*M);
2303 // Emit blockinfo, which defines the standard abbreviations etc.
2304 WriteBlockInfo(VE, Stream);
2306 // Emit information about attribute groups.
2307 WriteAttributeGroupTable(VE, Stream);
2309 // Emit information about parameter attributes.
2310 WriteAttributeTable(VE, Stream);
2312 // Emit information describing all of the types in the module.
2313 WriteTypeTable(VE, Stream);
2315 writeComdats(VE, Stream);
2317 // Emit top-level description of module, including target triple, inline asm,
2318 // descriptors for global variables, and function prototype info.
2319 WriteModuleInfo(M, VE, Stream);
2322 WriteModuleConstants(VE, Stream);
2325 WriteModuleMetadata(M, VE, Stream);
2328 WriteModuleMetadataStore(M, Stream);
2330 // Emit names for globals/functions etc.
2331 WriteValueSymbolTable(M->getValueSymbolTable(), VE, Stream);
2333 // Emit module-level use-lists.
2334 if (shouldPreserveBitcodeUseListOrder())
2335 WriteUseListBlock(nullptr, VE, Stream);
2337 // Emit function bodies.
2338 for (Module::const_iterator F = M->begin(), E = M->end(); F != E; ++F)
2339 if (!F->isDeclaration())
2340 WriteFunction(*F, VE, Stream);
2345 /// EmitDarwinBCHeader - If generating a bc file on darwin, we have to emit a
2346 /// header and trailer to make it compatible with the system archiver. To do
2347 /// this we emit the following header, and then emit a trailer that pads the
2348 /// file out to be a multiple of 16 bytes.
2350 /// struct bc_header {
2351 /// uint32_t Magic; // 0x0B17C0DE
2352 /// uint32_t Version; // Version, currently always 0.
2353 /// uint32_t BitcodeOffset; // Offset to traditional bitcode file.
2354 /// uint32_t BitcodeSize; // Size of traditional bitcode file.
2355 /// uint32_t CPUType; // CPU specifier.
2356 /// ... potentially more later ...
2359 DarwinBCSizeFieldOffset = 3*4, // Offset to bitcode_size.
2360 DarwinBCHeaderSize = 5*4
2363 static void WriteInt32ToBuffer(uint32_t Value, SmallVectorImpl<char> &Buffer,
2364 uint32_t &Position) {
2365 Buffer[Position + 0] = (unsigned char) (Value >> 0);
2366 Buffer[Position + 1] = (unsigned char) (Value >> 8);
2367 Buffer[Position + 2] = (unsigned char) (Value >> 16);
2368 Buffer[Position + 3] = (unsigned char) (Value >> 24);
2372 static void EmitDarwinBCHeaderAndTrailer(SmallVectorImpl<char> &Buffer,
2374 unsigned CPUType = ~0U;
2376 // Match x86_64-*, i[3-9]86-*, powerpc-*, powerpc64-*, arm-*, thumb-*,
2377 // armv[0-9]-*, thumbv[0-9]-*, armv5te-*, or armv6t2-*. The CPUType is a magic
2378 // number from /usr/include/mach/machine.h. It is ok to reproduce the
2379 // specific constants here because they are implicitly part of the Darwin ABI.
2381 DARWIN_CPU_ARCH_ABI64 = 0x01000000,
2382 DARWIN_CPU_TYPE_X86 = 7,
2383 DARWIN_CPU_TYPE_ARM = 12,
2384 DARWIN_CPU_TYPE_POWERPC = 18
2387 Triple::ArchType Arch = TT.getArch();
2388 if (Arch == Triple::x86_64)
2389 CPUType = DARWIN_CPU_TYPE_X86 | DARWIN_CPU_ARCH_ABI64;
2390 else if (Arch == Triple::x86)
2391 CPUType = DARWIN_CPU_TYPE_X86;
2392 else if (Arch == Triple::ppc)
2393 CPUType = DARWIN_CPU_TYPE_POWERPC;
2394 else if (Arch == Triple::ppc64)
2395 CPUType = DARWIN_CPU_TYPE_POWERPC | DARWIN_CPU_ARCH_ABI64;
2396 else if (Arch == Triple::arm || Arch == Triple::thumb)
2397 CPUType = DARWIN_CPU_TYPE_ARM;
2399 // Traditional Bitcode starts after header.
2400 assert(Buffer.size() >= DarwinBCHeaderSize &&
2401 "Expected header size to be reserved");
2402 unsigned BCOffset = DarwinBCHeaderSize;
2403 unsigned BCSize = Buffer.size()-DarwinBCHeaderSize;
2405 // Write the magic and version.
2406 unsigned Position = 0;
2407 WriteInt32ToBuffer(0x0B17C0DE , Buffer, Position);
2408 WriteInt32ToBuffer(0 , Buffer, Position); // Version.
2409 WriteInt32ToBuffer(BCOffset , Buffer, Position);
2410 WriteInt32ToBuffer(BCSize , Buffer, Position);
2411 WriteInt32ToBuffer(CPUType , Buffer, Position);
2413 // If the file is not a multiple of 16 bytes, insert dummy padding.
2414 while (Buffer.size() & 15)
2415 Buffer.push_back(0);
2418 /// WriteBitcodeToFile - Write the specified module to the specified output
2420 void llvm::WriteBitcodeToFile(const Module *M, raw_ostream &Out) {
2421 SmallVector<char, 0> Buffer;
2422 Buffer.reserve(256*1024);
2424 // If this is darwin or another generic macho target, reserve space for the
2426 Triple TT(M->getTargetTriple());
2427 if (TT.isOSDarwin())
2428 Buffer.insert(Buffer.begin(), DarwinBCHeaderSize, 0);
2430 // Emit the module into the buffer.
2432 BitstreamWriter Stream(Buffer);
2434 // Emit the file header.
2435 Stream.Emit((unsigned)'B', 8);
2436 Stream.Emit((unsigned)'C', 8);
2437 Stream.Emit(0x0, 4);
2438 Stream.Emit(0xC, 4);
2439 Stream.Emit(0xE, 4);
2440 Stream.Emit(0xD, 4);
2443 WriteModule(M, Stream);
2446 if (TT.isOSDarwin())
2447 EmitDarwinBCHeaderAndTrailer(Buffer, TT);
2449 // Write the generated bitstream to "Out".
2450 Out.write((char*)&Buffer.front(), Buffer.size());