blob: 08724bd8c8158cbe912fa9b69062e9028015472a [file] [log] [blame]
Chris Lattner87351e22007-04-29 05:31:57 +00001//===--- Bitcode/Writer/BitcodeWriter.cpp - Bitcode Writer ----------------===//
Chris Lattnerc1d10d62007-04-22 06:24:45 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Chris Lattnerc1d10d62007-04-22 06:24:45 +00007//
8//===----------------------------------------------------------------------===//
9//
10// Bitcode writer implementation.
11//
12//===----------------------------------------------------------------------===//
13
Chandler Carruthed0881b2012-12-03 16:50:05 +000014#include "ValueEnumerator.h"
Teresa Johnson403a7872015-10-04 14:33:43 +000015#include "llvm/ADT/STLExtras.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000016#include "llvm/ADT/Triple.h"
Teresa Johnson76a1c1d2016-03-11 18:52:24 +000017#include "llvm/Analysis/BlockFrequencyInfo.h"
18#include "llvm/Analysis/BlockFrequencyInfoImpl.h"
19#include "llvm/Analysis/BranchProbabilityInfo.h"
20#include "llvm/Analysis/LoopInfo.h"
Chris Lattnerc1d10d62007-04-22 06:24:45 +000021#include "llvm/Bitcode/BitstreamWriter.h"
Chris Lattner362b4a12007-04-23 01:01:37 +000022#include "llvm/Bitcode/LLVMBitCodes.h"
Teresa Johnson76a1c1d2016-03-11 18:52:24 +000023#include "llvm/Bitcode/ReaderWriter.h"
Sanjoy Dasb513a9f2015-09-24 23:34:52 +000024#include "llvm/IR/CallSite.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000025#include "llvm/IR/Constants.h"
Duncan P. N. Exon Smithd9901ff2015-02-02 18:53:21 +000026#include "llvm/IR/DebugInfoMetadata.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000027#include "llvm/IR/DerivedTypes.h"
Teresa Johnson76a1c1d2016-03-11 18:52:24 +000028#include "llvm/IR/Dominators.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000029#include "llvm/IR/InlineAsm.h"
30#include "llvm/IR/Instructions.h"
Teresa Johnson403a7872015-10-04 14:33:43 +000031#include "llvm/IR/IntrinsicInst.h"
Teresa Johnson76a1c1d2016-03-11 18:52:24 +000032#include "llvm/IR/LLVMContext.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000033#include "llvm/IR/Module.h"
34#include "llvm/IR/Operator.h"
Duncan P. N. Exon Smith6b6fdc92014-07-25 14:49:26 +000035#include "llvm/IR/UseListOrder.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000036#include "llvm/IR/ValueSymbolTable.h"
Chad Rosierca2567b2011-12-07 21:44:12 +000037#include "llvm/Support/CommandLine.h"
Torok Edwin56d06592009-07-11 20:10:48 +000038#include "llvm/Support/ErrorHandling.h"
Chris Lattnerc1d10d62007-04-22 06:24:45 +000039#include "llvm/Support/MathExtras.h"
Michael J. Spencer447762d2010-11-29 18:16:10 +000040#include "llvm/Support/Program.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000041#include "llvm/Support/raw_ostream.h"
Nick Lewycky0de20af2010-12-19 20:43:38 +000042#include <cctype>
Chris Lattnerb1ed91f2011-07-09 17:41:24 +000043#include <map>
Chris Lattnerc1d10d62007-04-22 06:24:45 +000044using namespace llvm;
45
Chris Lattner4d925982007-05-04 20:52:02 +000046/// These are manifest constants used by the bitcode writer. They do not need to
47/// be kept in sync with the reader, but need to be consistent within this file.
48enum {
Chris Lattner4d925982007-05-04 20:52:02 +000049 // VALUE_SYMTAB_BLOCK abbrev id's.
50 VST_ENTRY_8_ABBREV = bitc::FIRST_APPLICATION_ABBREV,
Chris Lattnerfd1ad102007-05-04 20:58:35 +000051 VST_ENTRY_7_ABBREV,
Chris Lattnere760d6f2007-05-05 01:26:50 +000052 VST_ENTRY_6_ABBREV,
Chris Lattnerda5e5d22007-05-05 07:36:14 +000053 VST_BBENTRY_6_ABBREV,
Daniel Dunbar7d6781b2009-09-20 02:20:51 +000054
Chris Lattnerda5e5d22007-05-05 07:36:14 +000055 // CONSTANTS_BLOCK abbrev id's.
56 CONSTANTS_SETTYPE_ABBREV = bitc::FIRST_APPLICATION_ABBREV,
57 CONSTANTS_INTEGER_ABBREV,
58 CONSTANTS_CE_CAST_Abbrev,
Chris Lattnerb80751d2007-05-05 07:44:49 +000059 CONSTANTS_NULL_Abbrev,
Daniel Dunbar7d6781b2009-09-20 02:20:51 +000060
Chris Lattnerb80751d2007-05-05 07:44:49 +000061 // FUNCTION_BLOCK abbrev id's.
Chris Lattnercc6d4c92007-05-06 01:28:01 +000062 FUNCTION_INST_LOAD_ABBREV = bitc::FIRST_APPLICATION_ABBREV,
Chris Lattnerc67e6d92007-05-06 02:38:57 +000063 FUNCTION_INST_BINOP_ABBREV,
Dan Gohman0ebd6962009-07-20 21:19:07 +000064 FUNCTION_INST_BINOP_FLAGS_ABBREV,
Chris Lattnerc67e6d92007-05-06 02:38:57 +000065 FUNCTION_INST_CAST_ABBREV,
Chris Lattnercc6d4c92007-05-06 01:28:01 +000066 FUNCTION_INST_RET_VOID_ABBREV,
67 FUNCTION_INST_RET_VAL_ABBREV,
David Blaikieb5b5efd2015-02-25 01:08:52 +000068 FUNCTION_INST_UNREACHABLE_ABBREV,
69 FUNCTION_INST_GEP_ABBREV,
Chris Lattner4d925982007-05-04 20:52:02 +000070};
71
Chris Lattner1e16bcf72007-04-24 07:07:11 +000072static unsigned GetEncodedCastOpcode(unsigned Opcode) {
73 switch (Opcode) {
Torok Edwinfbcc6632009-07-14 16:55:14 +000074 default: llvm_unreachable("Unknown cast instruction!");
Chris Lattner1e16bcf72007-04-24 07:07:11 +000075 case Instruction::Trunc : return bitc::CAST_TRUNC;
76 case Instruction::ZExt : return bitc::CAST_ZEXT;
77 case Instruction::SExt : return bitc::CAST_SEXT;
78 case Instruction::FPToUI : return bitc::CAST_FPTOUI;
79 case Instruction::FPToSI : return bitc::CAST_FPTOSI;
80 case Instruction::UIToFP : return bitc::CAST_UITOFP;
81 case Instruction::SIToFP : return bitc::CAST_SITOFP;
82 case Instruction::FPTrunc : return bitc::CAST_FPTRUNC;
83 case Instruction::FPExt : return bitc::CAST_FPEXT;
84 case Instruction::PtrToInt: return bitc::CAST_PTRTOINT;
85 case Instruction::IntToPtr: return bitc::CAST_INTTOPTR;
86 case Instruction::BitCast : return bitc::CAST_BITCAST;
Matt Arsenault3aa9b032013-11-18 02:51:33 +000087 case Instruction::AddrSpaceCast: return bitc::CAST_ADDRSPACECAST;
Chris Lattner1e16bcf72007-04-24 07:07:11 +000088 }
89}
90
91static unsigned GetEncodedBinaryOpcode(unsigned Opcode) {
92 switch (Opcode) {
Torok Edwinfbcc6632009-07-14 16:55:14 +000093 default: llvm_unreachable("Unknown binary instruction!");
Dan Gohmana5b96452009-06-04 22:49:04 +000094 case Instruction::Add:
95 case Instruction::FAdd: return bitc::BINOP_ADD;
96 case Instruction::Sub:
97 case Instruction::FSub: return bitc::BINOP_SUB;
98 case Instruction::Mul:
99 case Instruction::FMul: return bitc::BINOP_MUL;
Chris Lattner1e16bcf72007-04-24 07:07:11 +0000100 case Instruction::UDiv: return bitc::BINOP_UDIV;
101 case Instruction::FDiv:
102 case Instruction::SDiv: return bitc::BINOP_SDIV;
103 case Instruction::URem: return bitc::BINOP_UREM;
104 case Instruction::FRem:
105 case Instruction::SRem: return bitc::BINOP_SREM;
106 case Instruction::Shl: return bitc::BINOP_SHL;
107 case Instruction::LShr: return bitc::BINOP_LSHR;
108 case Instruction::AShr: return bitc::BINOP_ASHR;
109 case Instruction::And: return bitc::BINOP_AND;
110 case Instruction::Or: return bitc::BINOP_OR;
111 case Instruction::Xor: return bitc::BINOP_XOR;
112 }
113}
114
Eli Friedmanc9a551e2011-07-28 21:48:00 +0000115static unsigned GetEncodedRMWOperation(AtomicRMWInst::BinOp Op) {
116 switch (Op) {
117 default: llvm_unreachable("Unknown RMW operation!");
118 case AtomicRMWInst::Xchg: return bitc::RMW_XCHG;
119 case AtomicRMWInst::Add: return bitc::RMW_ADD;
120 case AtomicRMWInst::Sub: return bitc::RMW_SUB;
121 case AtomicRMWInst::And: return bitc::RMW_AND;
122 case AtomicRMWInst::Nand: return bitc::RMW_NAND;
123 case AtomicRMWInst::Or: return bitc::RMW_OR;
124 case AtomicRMWInst::Xor: return bitc::RMW_XOR;
125 case AtomicRMWInst::Max: return bitc::RMW_MAX;
126 case AtomicRMWInst::Min: return bitc::RMW_MIN;
127 case AtomicRMWInst::UMax: return bitc::RMW_UMAX;
128 case AtomicRMWInst::UMin: return bitc::RMW_UMIN;
129 }
130}
131
Eli Friedmanfee02c62011-07-25 23:16:38 +0000132static unsigned GetEncodedOrdering(AtomicOrdering Ordering) {
133 switch (Ordering) {
Eli Friedmanfee02c62011-07-25 23:16:38 +0000134 case NotAtomic: return bitc::ORDERING_NOTATOMIC;
135 case Unordered: return bitc::ORDERING_UNORDERED;
136 case Monotonic: return bitc::ORDERING_MONOTONIC;
137 case Acquire: return bitc::ORDERING_ACQUIRE;
138 case Release: return bitc::ORDERING_RELEASE;
139 case AcquireRelease: return bitc::ORDERING_ACQREL;
140 case SequentiallyConsistent: return bitc::ORDERING_SEQCST;
141 }
Chandler Carruthf3e85022012-01-10 18:08:01 +0000142 llvm_unreachable("Invalid ordering");
Eli Friedmanfee02c62011-07-25 23:16:38 +0000143}
144
145static unsigned GetEncodedSynchScope(SynchronizationScope SynchScope) {
146 switch (SynchScope) {
Eli Friedmanfee02c62011-07-25 23:16:38 +0000147 case SingleThread: return bitc::SYNCHSCOPE_SINGLETHREAD;
148 case CrossThread: return bitc::SYNCHSCOPE_CROSSTHREAD;
149 }
Chandler Carruthf3e85022012-01-10 18:08:01 +0000150 llvm_unreachable("Invalid synch scope");
Eli Friedmanfee02c62011-07-25 23:16:38 +0000151}
152
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000153static void WriteStringRecord(unsigned Code, StringRef Str,
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000154 unsigned AbbrevToUse, BitstreamWriter &Stream) {
155 SmallVector<unsigned, 64> Vals;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000156
Chris Lattnere14cb882007-05-04 19:11:41 +0000157 // Code: [strchar x N]
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000158 for (unsigned i = 0, e = Str.size(); i != e; ++i) {
159 if (AbbrevToUse && !BitCodeAbbrevOp::isChar6(Str[i]))
160 AbbrevToUse = 0;
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000161 Vals.push_back(Str[i]);
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000162 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000163
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000164 // Emit the finished record.
165 Stream.EmitRecord(Code, Vals, AbbrevToUse);
166}
167
Tobias Grosser0a8e12f2013-07-26 04:16:55 +0000168static uint64_t getAttrKindEncoding(Attribute::AttrKind Kind) {
169 switch (Kind) {
170 case Attribute::Alignment:
171 return bitc::ATTR_KIND_ALIGNMENT;
172 case Attribute::AlwaysInline:
173 return bitc::ATTR_KIND_ALWAYS_INLINE;
Igor Laevsky39d662f2015-07-11 10:30:36 +0000174 case Attribute::ArgMemOnly:
175 return bitc::ATTR_KIND_ARGMEMONLY;
Tobias Grosser0a8e12f2013-07-26 04:16:55 +0000176 case Attribute::Builtin:
177 return bitc::ATTR_KIND_BUILTIN;
178 case Attribute::ByVal:
179 return bitc::ATTR_KIND_BY_VAL;
Owen Anderson85fa7d52015-05-26 23:48:40 +0000180 case Attribute::Convergent:
181 return bitc::ATTR_KIND_CONVERGENT;
Reid Klecknera534a382013-12-19 02:14:12 +0000182 case Attribute::InAlloca:
183 return bitc::ATTR_KIND_IN_ALLOCA;
Tobias Grosser0a8e12f2013-07-26 04:16:55 +0000184 case Attribute::Cold:
185 return bitc::ATTR_KIND_COLD;
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +0000186 case Attribute::InaccessibleMemOnly:
187 return bitc::ATTR_KIND_INACCESSIBLEMEM_ONLY;
188 case Attribute::InaccessibleMemOrArgMemOnly:
189 return bitc::ATTR_KIND_INACCESSIBLEMEM_OR_ARGMEMONLY;
Tobias Grosser0a8e12f2013-07-26 04:16:55 +0000190 case Attribute::InlineHint:
191 return bitc::ATTR_KIND_INLINE_HINT;
192 case Attribute::InReg:
193 return bitc::ATTR_KIND_IN_REG;
Tom Roeder44cb65f2014-06-05 19:29:43 +0000194 case Attribute::JumpTable:
195 return bitc::ATTR_KIND_JUMP_TABLE;
Tobias Grosser0a8e12f2013-07-26 04:16:55 +0000196 case Attribute::MinSize:
197 return bitc::ATTR_KIND_MIN_SIZE;
198 case Attribute::Naked:
199 return bitc::ATTR_KIND_NAKED;
200 case Attribute::Nest:
201 return bitc::ATTR_KIND_NEST;
202 case Attribute::NoAlias:
203 return bitc::ATTR_KIND_NO_ALIAS;
204 case Attribute::NoBuiltin:
205 return bitc::ATTR_KIND_NO_BUILTIN;
206 case Attribute::NoCapture:
207 return bitc::ATTR_KIND_NO_CAPTURE;
208 case Attribute::NoDuplicate:
209 return bitc::ATTR_KIND_NO_DUPLICATE;
210 case Attribute::NoImplicitFloat:
211 return bitc::ATTR_KIND_NO_IMPLICIT_FLOAT;
212 case Attribute::NoInline:
213 return bitc::ATTR_KIND_NO_INLINE;
James Molloye6f87ca2015-11-06 10:32:53 +0000214 case Attribute::NoRecurse:
215 return bitc::ATTR_KIND_NO_RECURSE;
Tobias Grosser0a8e12f2013-07-26 04:16:55 +0000216 case Attribute::NonLazyBind:
217 return bitc::ATTR_KIND_NON_LAZY_BIND;
Nick Lewyckyd52b1522014-05-20 01:23:40 +0000218 case Attribute::NonNull:
219 return bitc::ATTR_KIND_NON_NULL;
Hal Finkelb0407ba2014-07-18 15:51:28 +0000220 case Attribute::Dereferenceable:
221 return bitc::ATTR_KIND_DEREFERENCEABLE;
Sanjoy Das31ea6d12015-04-16 20:29:50 +0000222 case Attribute::DereferenceableOrNull:
223 return bitc::ATTR_KIND_DEREFERENCEABLE_OR_NULL;
Tobias Grosser0a8e12f2013-07-26 04:16:55 +0000224 case Attribute::NoRedZone:
225 return bitc::ATTR_KIND_NO_RED_ZONE;
226 case Attribute::NoReturn:
227 return bitc::ATTR_KIND_NO_RETURN;
228 case Attribute::NoUnwind:
229 return bitc::ATTR_KIND_NO_UNWIND;
230 case Attribute::OptimizeForSize:
231 return bitc::ATTR_KIND_OPTIMIZE_FOR_SIZE;
Andrea Di Biagio377496b2013-08-23 11:53:55 +0000232 case Attribute::OptimizeNone:
233 return bitc::ATTR_KIND_OPTIMIZE_NONE;
Tobias Grosser0a8e12f2013-07-26 04:16:55 +0000234 case Attribute::ReadNone:
235 return bitc::ATTR_KIND_READ_NONE;
236 case Attribute::ReadOnly:
237 return bitc::ATTR_KIND_READ_ONLY;
238 case Attribute::Returned:
239 return bitc::ATTR_KIND_RETURNED;
240 case Attribute::ReturnsTwice:
241 return bitc::ATTR_KIND_RETURNS_TWICE;
242 case Attribute::SExt:
243 return bitc::ATTR_KIND_S_EXT;
244 case Attribute::StackAlignment:
245 return bitc::ATTR_KIND_STACK_ALIGNMENT;
246 case Attribute::StackProtect:
247 return bitc::ATTR_KIND_STACK_PROTECT;
248 case Attribute::StackProtectReq:
249 return bitc::ATTR_KIND_STACK_PROTECT_REQ;
250 case Attribute::StackProtectStrong:
251 return bitc::ATTR_KIND_STACK_PROTECT_STRONG;
Peter Collingbourne82437bf2015-06-15 21:07:11 +0000252 case Attribute::SafeStack:
253 return bitc::ATTR_KIND_SAFESTACK;
Tobias Grosser0a8e12f2013-07-26 04:16:55 +0000254 case Attribute::StructRet:
255 return bitc::ATTR_KIND_STRUCT_RET;
256 case Attribute::SanitizeAddress:
257 return bitc::ATTR_KIND_SANITIZE_ADDRESS;
258 case Attribute::SanitizeThread:
259 return bitc::ATTR_KIND_SANITIZE_THREAD;
260 case Attribute::SanitizeMemory:
261 return bitc::ATTR_KIND_SANITIZE_MEMORY;
262 case Attribute::UWTable:
263 return bitc::ATTR_KIND_UW_TABLE;
264 case Attribute::ZExt:
265 return bitc::ATTR_KIND_Z_EXT;
266 case Attribute::EndAttrKinds:
267 llvm_unreachable("Can not encode end-attribute kinds marker.");
268 case Attribute::None:
269 llvm_unreachable("Can not encode none-attribute.");
270 }
271
272 llvm_unreachable("Trying to encode unknown attribute");
273}
274
Bill Wendlingdc095552013-02-10 23:09:32 +0000275static void WriteAttributeGroupTable(const ValueEnumerator &VE,
276 BitstreamWriter &Stream) {
Bill Wendling92ed7002013-02-11 22:33:26 +0000277 const std::vector<AttributeSet> &AttrGrps = VE.getAttributeGroups();
278 if (AttrGrps.empty()) return;
Bill Wendlingdc095552013-02-10 23:09:32 +0000279
280 Stream.EnterSubblock(bitc::PARAMATTR_GROUP_BLOCK_ID, 3);
281
282 SmallVector<uint64_t, 64> Record;
Bill Wendling92ed7002013-02-11 22:33:26 +0000283 for (unsigned i = 0, e = AttrGrps.size(); i != e; ++i) {
284 AttributeSet AS = AttrGrps[i];
Bill Wendlingdc095552013-02-10 23:09:32 +0000285 for (unsigned i = 0, e = AS.getNumSlots(); i != e; ++i) {
286 AttributeSet A = AS.getSlotAttributes(i);
287
Bill Wendling92ed7002013-02-11 22:33:26 +0000288 Record.push_back(VE.getAttributeGroupID(A));
Bill Wendlingdc095552013-02-10 23:09:32 +0000289 Record.push_back(AS.getSlotIndex(i));
290
291 for (AttributeSet::iterator I = AS.begin(0), E = AS.end(0);
292 I != E; ++I) {
293 Attribute Attr = *I;
294 if (Attr.isEnumAttribute()) {
295 Record.push_back(0);
Tobias Grosser0a8e12f2013-07-26 04:16:55 +0000296 Record.push_back(getAttrKindEncoding(Attr.getKindAsEnum()));
Hal Finkele15442c2014-07-18 06:51:55 +0000297 } else if (Attr.isIntAttribute()) {
Bill Wendlingdc095552013-02-10 23:09:32 +0000298 Record.push_back(1);
Tobias Grosser0a8e12f2013-07-26 04:16:55 +0000299 Record.push_back(getAttrKindEncoding(Attr.getKindAsEnum()));
Bill Wendlingdc095552013-02-10 23:09:32 +0000300 Record.push_back(Attr.getValueAsInt());
301 } else {
302 StringRef Kind = Attr.getKindAsString();
303 StringRef Val = Attr.getValueAsString();
304
305 Record.push_back(Val.empty() ? 3 : 4);
306 Record.append(Kind.begin(), Kind.end());
307 Record.push_back(0);
308 if (!Val.empty()) {
309 Record.append(Val.begin(), Val.end());
310 Record.push_back(0);
311 }
312 }
313 }
314
315 Stream.EmitRecord(bitc::PARAMATTR_GRP_CODE_ENTRY, Record);
316 Record.clear();
317 }
318 }
319
320 Stream.ExitBlock();
321}
322
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000323static void WriteAttributeTable(const ValueEnumerator &VE,
Chris Lattnere2f98ef2007-05-04 00:44:52 +0000324 BitstreamWriter &Stream) {
Bill Wendlinge94d8432012-12-07 23:16:57 +0000325 const std::vector<AttributeSet> &Attrs = VE.getAttributes();
Chris Lattnere2f98ef2007-05-04 00:44:52 +0000326 if (Attrs.empty()) return;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000327
Chris Lattnere72bf9f2007-05-04 02:59:04 +0000328 Stream.EnterSubblock(bitc::PARAMATTR_BLOCK_ID, 3);
329
330 SmallVector<uint64_t, 64> Record;
331 for (unsigned i = 0, e = Attrs.size(); i != e; ++i) {
Bill Wendlinge94d8432012-12-07 23:16:57 +0000332 const AttributeSet &A = Attrs[i];
Bill Wendling0dc08912013-02-12 08:13:50 +0000333 for (unsigned i = 0, e = A.getNumSlots(); i != e; ++i)
334 Record.push_back(VE.getAttributeGroupID(A.getSlotAttributes(i)));
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000335
Bill Wendling0dc08912013-02-12 08:13:50 +0000336 Stream.EmitRecord(bitc::PARAMATTR_CODE_ENTRY, Record);
Chris Lattnere72bf9f2007-05-04 02:59:04 +0000337 Record.clear();
338 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000339
Chris Lattnere72bf9f2007-05-04 02:59:04 +0000340 Stream.ExitBlock();
Chris Lattnere2f98ef2007-05-04 00:44:52 +0000341}
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000342
343/// WriteTypeTable - Write out the type table for a module.
344static void WriteTypeTable(const ValueEnumerator &VE, BitstreamWriter &Stream) {
345 const ValueEnumerator::TypeList &TypeList = VE.getTypes();
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000346
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000347 Stream.EnterSubblock(bitc::TYPE_BLOCK_ID_NEW, 4 /*count from # abbrevs */);
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000348 SmallVector<uint64_t, 64> TypeVals;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000349
David Blaikie7b028102015-02-25 00:51:52 +0000350 uint64_t NumBits = VE.computeBitsRequiredForTypeIndicies();
Chad Rosier9646c0d2011-12-08 00:38:45 +0000351
Chris Lattnerccee7062007-05-05 06:30:12 +0000352 // Abbrev for TYPE_CODE_POINTER.
353 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
354 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_POINTER));
Chad Rosier9646c0d2011-12-08 00:38:45 +0000355 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
Christopher Lamb25f50762007-12-12 08:44:39 +0000356 Abbv->Add(BitCodeAbbrevOp(0)); // Addrspace = 0
Chris Lattnerccee7062007-05-05 06:30:12 +0000357 unsigned PtrAbbrev = Stream.EmitAbbrev(Abbv);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000358
Chris Lattnerccee7062007-05-05 06:30:12 +0000359 // Abbrev for TYPE_CODE_FUNCTION.
360 Abbv = new BitCodeAbbrev();
361 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_FUNCTION));
362 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isvararg
Chris Lattnerccee7062007-05-05 06:30:12 +0000363 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
Chad Rosier9646c0d2011-12-08 00:38:45 +0000364 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
365
Chris Lattnerccee7062007-05-05 06:30:12 +0000366 unsigned FunctionAbbrev = Stream.EmitAbbrev(Abbv);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000367
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000368 // Abbrev for TYPE_CODE_STRUCT_ANON.
Chris Lattnerccee7062007-05-05 06:30:12 +0000369 Abbv = new BitCodeAbbrev();
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000370 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_STRUCT_ANON));
Chris Lattnerccee7062007-05-05 06:30:12 +0000371 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ispacked
372 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
Chad Rosier9646c0d2011-12-08 00:38:45 +0000373 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
374
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000375 unsigned StructAnonAbbrev = Stream.EmitAbbrev(Abbv);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000376
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000377 // Abbrev for TYPE_CODE_STRUCT_NAME.
378 Abbv = new BitCodeAbbrev();
379 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_STRUCT_NAME));
380 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
381 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
382 unsigned StructNameAbbrev = Stream.EmitAbbrev(Abbv);
383
384 // Abbrev for TYPE_CODE_STRUCT_NAMED.
385 Abbv = new BitCodeAbbrev();
386 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_STRUCT_NAMED));
387 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ispacked
388 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
Chad Rosier9646c0d2011-12-08 00:38:45 +0000389 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
390
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000391 unsigned StructNamedAbbrev = Stream.EmitAbbrev(Abbv);
Michael Ilseman26ee2b82012-11-15 22:34:00 +0000392
Chris Lattnerccee7062007-05-05 06:30:12 +0000393 // Abbrev for TYPE_CODE_ARRAY.
394 Abbv = new BitCodeAbbrev();
395 Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_ARRAY));
396 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // size
Chad Rosier9646c0d2011-12-08 00:38:45 +0000397 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
398
Chris Lattnerccee7062007-05-05 06:30:12 +0000399 unsigned ArrayAbbrev = Stream.EmitAbbrev(Abbv);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000400
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000401 // Emit an entry count so the reader can reserve space.
402 TypeVals.push_back(TypeList.size());
403 Stream.EmitRecord(bitc::TYPE_CODE_NUMENTRY, TypeVals);
404 TypeVals.clear();
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000405
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000406 // Loop over all of the types, emitting each in turn.
407 for (unsigned i = 0, e = TypeList.size(); i != e; ++i) {
Chris Lattner229907c2011-07-18 04:54:35 +0000408 Type *T = TypeList[i];
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000409 int AbbrevToUse = 0;
410 unsigned Code = 0;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000411
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000412 switch (T->getTypeID()) {
Joe Abbey2ad8df22012-11-25 15:23:39 +0000413 case Type::VoidTyID: Code = bitc::TYPE_CODE_VOID; break;
414 case Type::HalfTyID: Code = bitc::TYPE_CODE_HALF; break;
415 case Type::FloatTyID: Code = bitc::TYPE_CODE_FLOAT; break;
416 case Type::DoubleTyID: Code = bitc::TYPE_CODE_DOUBLE; break;
417 case Type::X86_FP80TyID: Code = bitc::TYPE_CODE_X86_FP80; break;
418 case Type::FP128TyID: Code = bitc::TYPE_CODE_FP128; break;
Dale Johannesenff4c3be2007-08-03 01:03:46 +0000419 case Type::PPC_FP128TyID: Code = bitc::TYPE_CODE_PPC_FP128; break;
Joe Abbey2ad8df22012-11-25 15:23:39 +0000420 case Type::LabelTyID: Code = bitc::TYPE_CODE_LABEL; break;
421 case Type::MetadataTyID: Code = bitc::TYPE_CODE_METADATA; break;
422 case Type::X86_MMXTyID: Code = bitc::TYPE_CODE_X86_MMX; break;
David Majnemerb611e3f2015-08-14 05:09:07 +0000423 case Type::TokenTyID: Code = bitc::TYPE_CODE_TOKEN; break;
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000424 case Type::IntegerTyID:
425 // INTEGER: [width]
426 Code = bitc::TYPE_CODE_INTEGER;
427 TypeVals.push_back(cast<IntegerType>(T)->getBitWidth());
428 break;
Duncan Sandsf41217d2007-12-11 12:20:47 +0000429 case Type::PointerTyID: {
Chris Lattner229907c2011-07-18 04:54:35 +0000430 PointerType *PTy = cast<PointerType>(T);
Christopher Lamb25f50762007-12-12 08:44:39 +0000431 // POINTER: [pointee type, address space]
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000432 Code = bitc::TYPE_CODE_POINTER;
Christopher Lamb54dd24c2007-12-11 08:59:05 +0000433 TypeVals.push_back(VE.getTypeID(PTy->getElementType()));
Christopher Lamb25f50762007-12-12 08:44:39 +0000434 unsigned AddressSpace = PTy->getAddressSpace();
435 TypeVals.push_back(AddressSpace);
436 if (AddressSpace == 0) AbbrevToUse = PtrAbbrev;
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000437 break;
Duncan Sandsf41217d2007-12-11 12:20:47 +0000438 }
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000439 case Type::FunctionTyID: {
Chris Lattner229907c2011-07-18 04:54:35 +0000440 FunctionType *FT = cast<FunctionType>(T);
Chad Rosier95898722011-11-03 00:14:01 +0000441 // FUNCTION: [isvararg, retty, paramty x N]
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000442 Code = bitc::TYPE_CODE_FUNCTION;
443 TypeVals.push_back(FT->isVarArg());
444 TypeVals.push_back(VE.getTypeID(FT->getReturnType()));
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000445 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i)
446 TypeVals.push_back(VE.getTypeID(FT->getParamType(i)));
Chris Lattnerccee7062007-05-05 06:30:12 +0000447 AbbrevToUse = FunctionAbbrev;
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000448 break;
449 }
450 case Type::StructTyID: {
Chris Lattner229907c2011-07-18 04:54:35 +0000451 StructType *ST = cast<StructType>(T);
Chris Lattnerccee7062007-05-05 06:30:12 +0000452 // STRUCT: [ispacked, eltty x N]
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000453 TypeVals.push_back(ST->isPacked());
Chris Lattnere14cb882007-05-04 19:11:41 +0000454 // Output all of the element types.
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000455 for (StructType::element_iterator I = ST->element_begin(),
456 E = ST->element_end(); I != E; ++I)
457 TypeVals.push_back(VE.getTypeID(*I));
Michael Ilseman26ee2b82012-11-15 22:34:00 +0000458
Chris Lattner335d3992011-08-12 18:06:37 +0000459 if (ST->isLiteral()) {
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000460 Code = bitc::TYPE_CODE_STRUCT_ANON;
461 AbbrevToUse = StructAnonAbbrev;
462 } else {
463 if (ST->isOpaque()) {
464 Code = bitc::TYPE_CODE_OPAQUE;
465 } else {
466 Code = bitc::TYPE_CODE_STRUCT_NAMED;
467 AbbrevToUse = StructNamedAbbrev;
468 }
469
470 // Emit the name if it is present.
471 if (!ST->getName().empty())
472 WriteStringRecord(bitc::TYPE_CODE_STRUCT_NAME, ST->getName(),
473 StructNameAbbrev, Stream);
474 }
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000475 break;
476 }
477 case Type::ArrayTyID: {
Chris Lattner229907c2011-07-18 04:54:35 +0000478 ArrayType *AT = cast<ArrayType>(T);
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000479 // ARRAY: [numelts, eltty]
480 Code = bitc::TYPE_CODE_ARRAY;
481 TypeVals.push_back(AT->getNumElements());
482 TypeVals.push_back(VE.getTypeID(AT->getElementType()));
Chris Lattnerccee7062007-05-05 06:30:12 +0000483 AbbrevToUse = ArrayAbbrev;
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000484 break;
485 }
486 case Type::VectorTyID: {
Chris Lattner229907c2011-07-18 04:54:35 +0000487 VectorType *VT = cast<VectorType>(T);
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000488 // VECTOR [numelts, eltty]
489 Code = bitc::TYPE_CODE_VECTOR;
490 TypeVals.push_back(VT->getNumElements());
491 TypeVals.push_back(VE.getTypeID(VT->getElementType()));
492 break;
493 }
494 }
495
496 // Emit the finished record.
497 Stream.EmitRecord(Code, TypeVals, AbbrevToUse);
498 TypeVals.clear();
499 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000500
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000501 Stream.ExitBlock();
502}
503
Teresa Johnson5e22e442016-02-06 16:07:35 +0000504static unsigned getEncodedLinkage(const GlobalValue::LinkageTypes Linkage) {
505 switch (Linkage) {
Rafael Espindola261d25b2015-01-08 16:25:01 +0000506 case GlobalValue::ExternalLinkage:
507 return 0;
508 case GlobalValue::WeakAnyLinkage:
Rafael Espindola12ca34f2015-01-19 15:16:06 +0000509 return 16;
Rafael Espindola261d25b2015-01-08 16:25:01 +0000510 case GlobalValue::AppendingLinkage:
511 return 2;
512 case GlobalValue::InternalLinkage:
513 return 3;
514 case GlobalValue::LinkOnceAnyLinkage:
Rafael Espindola12ca34f2015-01-19 15:16:06 +0000515 return 18;
Rafael Espindola261d25b2015-01-08 16:25:01 +0000516 case GlobalValue::ExternalWeakLinkage:
517 return 7;
518 case GlobalValue::CommonLinkage:
519 return 8;
520 case GlobalValue::PrivateLinkage:
521 return 9;
522 case GlobalValue::WeakODRLinkage:
Rafael Espindola12ca34f2015-01-19 15:16:06 +0000523 return 17;
Rafael Espindola261d25b2015-01-08 16:25:01 +0000524 case GlobalValue::LinkOnceODRLinkage:
Rafael Espindola12ca34f2015-01-19 15:16:06 +0000525 return 19;
Rafael Espindola261d25b2015-01-08 16:25:01 +0000526 case GlobalValue::AvailableExternallyLinkage:
527 return 12;
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000528 }
Chandler Carruthf3e85022012-01-10 18:08:01 +0000529 llvm_unreachable("Invalid linkage");
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000530}
531
Teresa Johnson5e22e442016-02-06 16:07:35 +0000532static unsigned getEncodedLinkage(const GlobalValue &GV) {
533 return getEncodedLinkage(GV.getLinkage());
534}
535
Rafael Espindolaacef6c72014-05-26 13:38:51 +0000536static unsigned getEncodedVisibility(const GlobalValue &GV) {
537 switch (GV.getVisibility()) {
Anton Korobeynikov31fc4f92007-04-29 20:56:48 +0000538 case GlobalValue::DefaultVisibility: return 0;
539 case GlobalValue::HiddenVisibility: return 1;
540 case GlobalValue::ProtectedVisibility: return 2;
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000541 }
Chandler Carruthf3e85022012-01-10 18:08:01 +0000542 llvm_unreachable("Invalid visibility");
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000543}
544
Rafael Espindolaacef6c72014-05-26 13:38:51 +0000545static unsigned getEncodedDLLStorageClass(const GlobalValue &GV) {
546 switch (GV.getDLLStorageClass()) {
Nico Rieck7157bb72014-01-14 15:22:47 +0000547 case GlobalValue::DefaultStorageClass: return 0;
548 case GlobalValue::DLLImportStorageClass: return 1;
549 case GlobalValue::DLLExportStorageClass: return 2;
550 }
551 llvm_unreachable("Invalid DLL storage class");
552}
553
Rafael Espindola59f7eba2014-05-28 18:15:43 +0000554static unsigned getEncodedThreadLocalMode(const GlobalValue &GV) {
Rafael Espindolaacef6c72014-05-26 13:38:51 +0000555 switch (GV.getThreadLocalMode()) {
Hans Wennborgcbe34b42012-06-23 11:37:03 +0000556 case GlobalVariable::NotThreadLocal: return 0;
557 case GlobalVariable::GeneralDynamicTLSModel: return 1;
558 case GlobalVariable::LocalDynamicTLSModel: return 2;
559 case GlobalVariable::InitialExecTLSModel: return 3;
560 case GlobalVariable::LocalExecTLSModel: return 4;
561 }
562 llvm_unreachable("Invalid TLS model");
563}
564
David Majnemerdad0a642014-06-27 18:19:56 +0000565static unsigned getEncodedComdatSelectionKind(const Comdat &C) {
566 switch (C.getSelectionKind()) {
567 case Comdat::Any:
568 return bitc::COMDAT_SELECTION_KIND_ANY;
569 case Comdat::ExactMatch:
570 return bitc::COMDAT_SELECTION_KIND_EXACT_MATCH;
571 case Comdat::Largest:
572 return bitc::COMDAT_SELECTION_KIND_LARGEST;
573 case Comdat::NoDuplicates:
574 return bitc::COMDAT_SELECTION_KIND_NO_DUPLICATES;
575 case Comdat::SameSize:
576 return bitc::COMDAT_SELECTION_KIND_SAME_SIZE;
577 }
578 llvm_unreachable("Invalid selection kind");
579}
580
581static void writeComdats(const ValueEnumerator &VE, BitstreamWriter &Stream) {
David Majnemer90a021f2016-03-13 08:01:03 +0000582 SmallVector<unsigned, 64> Vals;
David Majnemerdad0a642014-06-27 18:19:56 +0000583 for (const Comdat *C : VE.getComdats()) {
584 // COMDAT: [selection_kind, name]
585 Vals.push_back(getEncodedComdatSelectionKind(*C));
Rafael Espindola4e74d3b2015-01-14 18:25:45 +0000586 size_t Size = C->getName().size();
David Majnemer90a021f2016-03-13 08:01:03 +0000587 assert(isUInt<32>(Size));
Rafael Espindola4e74d3b2015-01-14 18:25:45 +0000588 Vals.push_back(Size);
David Majnemerdad0a642014-06-27 18:19:56 +0000589 for (char Chr : C->getName())
590 Vals.push_back((unsigned char)Chr);
591 Stream.EmitRecord(bitc::MODULE_CODE_COMDAT, Vals, /*AbbrevToUse=*/0);
592 Vals.clear();
593 }
594}
595
Teresa Johnsonff642b92015-09-17 20:12:00 +0000596/// Write a record that will eventually hold the word offset of the
597/// module-level VST. For now the offset is 0, which will be backpatched
598/// after the real VST is written. Returns the bit offset to backpatch.
Teresa Johnson76a1c1d2016-03-11 18:52:24 +0000599static uint64_t WriteValueSymbolTableForwardDecl(BitstreamWriter &Stream) {
Teresa Johnsonff642b92015-09-17 20:12:00 +0000600 // Write a placeholder value in for the offset of the real VST,
601 // which is written after the function blocks so that it can include
602 // the offset of each function. The placeholder offset will be
603 // updated when the real VST is written.
604 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
605 Abbv->Add(BitCodeAbbrevOp(bitc::MODULE_CODE_VSTOFFSET));
606 // Blocks are 32-bit aligned, so we can use a 32-bit word offset to
607 // hold the real VST offset. Must use fixed instead of VBR as we don't
608 // know how many VBR chunks to reserve ahead of time.
609 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
610 unsigned VSTOffsetAbbrev = Stream.EmitAbbrev(Abbv);
611
612 // Emit the placeholder
613 uint64_t Vals[] = {bitc::MODULE_CODE_VSTOFFSET, 0};
614 Stream.EmitRecordWithAbbrev(VSTOffsetAbbrev, Vals);
615
616 // Compute and return the bit offset to the placeholder, which will be
617 // patched when the real VST is written. We can simply subtract the 32-bit
618 // fixed size from the current bit number to get the location to backpatch.
619 return Stream.GetCurrentBitNo() - 32;
620}
621
Teresa Johnsone1164de2016-02-10 21:55:02 +0000622enum StringEncoding { SE_Char6, SE_Fixed7, SE_Fixed8 };
623
624/// Determine the encoding to use for the given string name and length.
625static StringEncoding getStringEncoding(const char *Str, unsigned StrLen) {
626 bool isChar6 = true;
627 for (const char *C = Str, *E = C + StrLen; C != E; ++C) {
628 if (isChar6)
629 isChar6 = BitCodeAbbrevOp::isChar6(*C);
630 if ((unsigned char)*C & 128)
631 // don't bother scanning the rest.
632 return SE_Fixed8;
633 }
634 if (isChar6)
635 return SE_Char6;
636 else
637 return SE_Fixed7;
638}
639
Teresa Johnsonff642b92015-09-17 20:12:00 +0000640/// Emit top-level description of module, including target triple, inline asm,
641/// descriptors for global variables, and function prototype info.
642/// Returns the bit offset to backpatch with the location of the real VST.
643static uint64_t WriteModuleInfo(const Module *M, const ValueEnumerator &VE,
644 BitstreamWriter &Stream) {
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000645 // Emit various pieces of data attached to a module.
646 if (!M->getTargetTriple().empty())
647 WriteStringRecord(bitc::MODULE_CODE_TRIPLE, M->getTargetTriple(),
648 0/*TODO*/, Stream);
Rafael Espindolaf863ee22014-02-25 20:01:08 +0000649 const std::string &DL = M->getDataLayoutStr();
650 if (!DL.empty())
651 WriteStringRecord(bitc::MODULE_CODE_DATALAYOUT, DL, 0 /*TODO*/, Stream);
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000652 if (!M->getModuleInlineAsm().empty())
653 WriteStringRecord(bitc::MODULE_CODE_ASM, M->getModuleInlineAsm(),
654 0/*TODO*/, Stream);
655
Gordon Henriksend930f912008-08-17 18:44:35 +0000656 // Emit information about sections and GC, computing how many there are. Also
657 // compute the maximum alignment value.
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000658 std::map<std::string, unsigned> SectionMap;
Gordon Henriksend930f912008-08-17 18:44:35 +0000659 std::map<std::string, unsigned> GCMap;
Chris Lattner4b00d922007-04-23 16:04:05 +0000660 unsigned MaxAlignment = 0;
Chris Lattnerb5491372007-04-23 18:58:34 +0000661 unsigned MaxGlobalType = 0;
Rafael Espindolaacef6c72014-05-26 13:38:51 +0000662 for (const GlobalValue &GV : M->globals()) {
663 MaxAlignment = std::max(MaxAlignment, GV.getAlignment());
David Blaikie1a848da2015-04-27 19:58:56 +0000664 MaxGlobalType = std::max(MaxGlobalType, VE.getTypeID(GV.getValueType()));
Rafael Espindolaacef6c72014-05-26 13:38:51 +0000665 if (GV.hasSection()) {
Chad Rosier75ec09c2011-08-12 16:45:18 +0000666 // Give section names unique ID's.
Rafael Espindolaacef6c72014-05-26 13:38:51 +0000667 unsigned &Entry = SectionMap[GV.getSection()];
Chad Rosier75ec09c2011-08-12 16:45:18 +0000668 if (!Entry) {
Rafael Espindolaacef6c72014-05-26 13:38:51 +0000669 WriteStringRecord(bitc::MODULE_CODE_SECTIONNAME, GV.getSection(),
Chad Rosier75ec09c2011-08-12 16:45:18 +0000670 0/*TODO*/, Stream);
671 Entry = SectionMap.size();
672 }
673 }
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000674 }
Rafael Espindolaacef6c72014-05-26 13:38:51 +0000675 for (const Function &F : *M) {
676 MaxAlignment = std::max(MaxAlignment, F.getAlignment());
677 if (F.hasSection()) {
Gordon Henriksen71183b62007-12-10 03:18:06 +0000678 // Give section names unique ID's.
Rafael Espindolaacef6c72014-05-26 13:38:51 +0000679 unsigned &Entry = SectionMap[F.getSection()];
Gordon Henriksen71183b62007-12-10 03:18:06 +0000680 if (!Entry) {
Rafael Espindolaacef6c72014-05-26 13:38:51 +0000681 WriteStringRecord(bitc::MODULE_CODE_SECTIONNAME, F.getSection(),
Gordon Henriksen71183b62007-12-10 03:18:06 +0000682 0/*TODO*/, Stream);
683 Entry = SectionMap.size();
684 }
685 }
Rafael Espindolaacef6c72014-05-26 13:38:51 +0000686 if (F.hasGC()) {
Gordon Henriksend930f912008-08-17 18:44:35 +0000687 // Same for GC names.
Rafael Espindolaacef6c72014-05-26 13:38:51 +0000688 unsigned &Entry = GCMap[F.getGC()];
Gordon Henriksen71183b62007-12-10 03:18:06 +0000689 if (!Entry) {
Rafael Espindolaacef6c72014-05-26 13:38:51 +0000690 WriteStringRecord(bitc::MODULE_CODE_GCNAME, F.getGC(),
Gordon Henriksen71183b62007-12-10 03:18:06 +0000691 0/*TODO*/, Stream);
Gordon Henriksend930f912008-08-17 18:44:35 +0000692 Entry = GCMap.size();
Gordon Henriksen71183b62007-12-10 03:18:06 +0000693 }
694 }
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000695 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000696
Chris Lattner4b00d922007-04-23 16:04:05 +0000697 // Emit abbrev for globals, now that we know # sections and max alignment.
698 unsigned SimpleGVarAbbrev = 0;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000699 if (!M->global_empty()) {
Chris Lattner4b00d922007-04-23 16:04:05 +0000700 // Add an abbrev for common globals with no visibility or thread localness.
701 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
702 Abbv->Add(BitCodeAbbrevOp(bitc::MODULE_CODE_GLOBALVAR));
Chris Lattner2eae59f2007-05-04 20:34:50 +0000703 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
Chris Lattnerb5491372007-04-23 18:58:34 +0000704 Log2_32_Ceil(MaxGlobalType+1)));
David Blaikie1a848da2015-04-27 19:58:56 +0000705 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // AddrSpace << 2
706 //| explicitType << 1
707 //| constant
708 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Initializer.
709 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 5)); // Linkage.
710 if (MaxAlignment == 0) // Alignment.
Chris Lattner4b00d922007-04-23 16:04:05 +0000711 Abbv->Add(BitCodeAbbrevOp(0));
712 else {
713 unsigned MaxEncAlignment = Log2_32(MaxAlignment)+1;
Chris Lattner2eae59f2007-05-04 20:34:50 +0000714 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
Chris Lattnerb5491372007-04-23 18:58:34 +0000715 Log2_32_Ceil(MaxEncAlignment+1)));
Chris Lattner4b00d922007-04-23 16:04:05 +0000716 }
717 if (SectionMap.empty()) // Section.
718 Abbv->Add(BitCodeAbbrevOp(0));
719 else
Chris Lattner2eae59f2007-05-04 20:34:50 +0000720 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
Chris Lattner1e50c292007-04-24 03:29:47 +0000721 Log2_32_Ceil(SectionMap.size()+1)));
Chris Lattner4b00d922007-04-23 16:04:05 +0000722 // Don't bother emitting vis + thread local.
723 SimpleGVarAbbrev = Stream.EmitAbbrev(Abbv);
724 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000725
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000726 // Emit the global variable information.
727 SmallVector<unsigned, 64> Vals;
Rafael Espindolaacef6c72014-05-26 13:38:51 +0000728 for (const GlobalVariable &GV : M->globals()) {
Chris Lattner4b00d922007-04-23 16:04:05 +0000729 unsigned AbbrevToUse = 0;
730
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000731 // GLOBALVAR: [type, isconst, initid,
Rafael Espindola45e6c192011-01-08 16:42:36 +0000732 // linkage, alignment, section, visibility, threadlocal,
Peter Collingbourne69ba0162015-02-04 00:42:45 +0000733 // unnamed_addr, externally_initialized, dllstorageclass,
734 // comdat]
David Blaikie1a848da2015-04-27 19:58:56 +0000735 Vals.push_back(VE.getTypeID(GV.getValueType()));
736 Vals.push_back(GV.getType()->getAddressSpace() << 2 | 2 | GV.isConstant());
Rafael Espindolaacef6c72014-05-26 13:38:51 +0000737 Vals.push_back(GV.isDeclaration() ? 0 :
738 (VE.getValueID(GV.getInitializer()) + 1));
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000739 Vals.push_back(getEncodedLinkage(GV));
Rafael Espindolaacef6c72014-05-26 13:38:51 +0000740 Vals.push_back(Log2_32(GV.getAlignment())+1);
741 Vals.push_back(GV.hasSection() ? SectionMap[GV.getSection()] : 0);
742 if (GV.isThreadLocal() ||
743 GV.getVisibility() != GlobalValue::DefaultVisibility ||
744 GV.hasUnnamedAddr() || GV.isExternallyInitialized() ||
David Majnemerdad0a642014-06-27 18:19:56 +0000745 GV.getDLLStorageClass() != GlobalValue::DefaultStorageClass ||
746 GV.hasComdat()) {
Chris Lattner4b00d922007-04-23 16:04:05 +0000747 Vals.push_back(getEncodedVisibility(GV));
Hans Wennborgcbe34b42012-06-23 11:37:03 +0000748 Vals.push_back(getEncodedThreadLocalMode(GV));
Rafael Espindolaacef6c72014-05-26 13:38:51 +0000749 Vals.push_back(GV.hasUnnamedAddr());
750 Vals.push_back(GV.isExternallyInitialized());
Nico Rieck7157bb72014-01-14 15:22:47 +0000751 Vals.push_back(getEncodedDLLStorageClass(GV));
David Majnemerdad0a642014-06-27 18:19:56 +0000752 Vals.push_back(GV.hasComdat() ? VE.getComdatID(GV.getComdat()) : 0);
Chris Lattner4b00d922007-04-23 16:04:05 +0000753 } else {
754 AbbrevToUse = SimpleGVarAbbrev;
755 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000756
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000757 Stream.EmitRecord(bitc::MODULE_CODE_GLOBALVAR, Vals, AbbrevToUse);
758 Vals.clear();
759 }
760
761 // Emit the function proto information.
Rafael Espindolaacef6c72014-05-26 13:38:51 +0000762 for (const Function &F : *M) {
Chad Rosier42ee1522011-12-07 23:57:55 +0000763 // FUNCTION: [type, callingconv, isproto, linkage, paramattrs, alignment,
Peter Collingbourne51d2de72014-12-03 02:08:38 +0000764 // section, visibility, gc, unnamed_addr, prologuedata,
David Majnemer7fddecc2015-06-17 20:52:32 +0000765 // dllstorageclass, comdat, prefixdata, personalityfn]
David Blaikie561a1572015-04-17 16:28:26 +0000766 Vals.push_back(VE.getTypeID(F.getFunctionType()));
Rafael Espindolaacef6c72014-05-26 13:38:51 +0000767 Vals.push_back(F.getCallingConv());
768 Vals.push_back(F.isDeclaration());
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000769 Vals.push_back(getEncodedLinkage(F));
Rafael Espindolaacef6c72014-05-26 13:38:51 +0000770 Vals.push_back(VE.getAttributeID(F.getAttributes()));
771 Vals.push_back(Log2_32(F.getAlignment())+1);
772 Vals.push_back(F.hasSection() ? SectionMap[F.getSection()] : 0);
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000773 Vals.push_back(getEncodedVisibility(F));
Rafael Espindolaacef6c72014-05-26 13:38:51 +0000774 Vals.push_back(F.hasGC() ? GCMap[F.getGC()] : 0);
775 Vals.push_back(F.hasUnnamedAddr());
Peter Collingbourne51d2de72014-12-03 02:08:38 +0000776 Vals.push_back(F.hasPrologueData() ? (VE.getValueID(F.getPrologueData()) + 1)
777 : 0);
Nico Rieck7157bb72014-01-14 15:22:47 +0000778 Vals.push_back(getEncodedDLLStorageClass(F));
David Majnemerdad0a642014-06-27 18:19:56 +0000779 Vals.push_back(F.hasComdat() ? VE.getComdatID(F.getComdat()) : 0);
Peter Collingbourne51d2de72014-12-03 02:08:38 +0000780 Vals.push_back(F.hasPrefixData() ? (VE.getValueID(F.getPrefixData()) + 1)
781 : 0);
David Majnemer7fddecc2015-06-17 20:52:32 +0000782 Vals.push_back(
783 F.hasPersonalityFn() ? (VE.getValueID(F.getPersonalityFn()) + 1) : 0);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000784
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000785 unsigned AbbrevToUse = 0;
786 Stream.EmitRecord(bitc::MODULE_CODE_FUNCTION, Vals, AbbrevToUse);
787 Vals.clear();
788 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000789
Chris Lattner44c17072007-04-26 02:46:40 +0000790 // Emit the alias information.
Rafael Espindolaacef6c72014-05-26 13:38:51 +0000791 for (const GlobalAlias &A : M->aliases()) {
Chad Rosiera966c312011-12-08 00:11:31 +0000792 // ALIAS: [alias type, aliasee val#, linkage, visibility]
David Blaikie6a51dbd2015-09-17 22:18:59 +0000793 Vals.push_back(VE.getTypeID(A.getValueType()));
794 Vals.push_back(A.getType()->getAddressSpace());
Rafael Espindolaacef6c72014-05-26 13:38:51 +0000795 Vals.push_back(VE.getValueID(A.getAliasee()));
796 Vals.push_back(getEncodedLinkage(A));
797 Vals.push_back(getEncodedVisibility(A));
798 Vals.push_back(getEncodedDLLStorageClass(A));
Rafael Espindola42a4c9f2014-06-06 01:20:28 +0000799 Vals.push_back(getEncodedThreadLocalMode(A));
800 Vals.push_back(A.hasUnnamedAddr());
Chris Lattner44c17072007-04-26 02:46:40 +0000801 unsigned AbbrevToUse = 0;
802 Stream.EmitRecord(bitc::MODULE_CODE_ALIAS, Vals, AbbrevToUse);
803 Vals.clear();
804 }
Teresa Johnsonff642b92015-09-17 20:12:00 +0000805
Teresa Johnsone1164de2016-02-10 21:55:02 +0000806 // Emit the module's source file name.
807 {
Mehdi Amini83efea82016-02-16 22:07:03 +0000808 StringEncoding Bits = getStringEncoding(M->getSourceFileName().data(),
809 M->getSourceFileName().size());
Teresa Johnsone1164de2016-02-10 21:55:02 +0000810 BitCodeAbbrevOp AbbrevOpToUse = BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8);
811 if (Bits == SE_Char6)
812 AbbrevOpToUse = BitCodeAbbrevOp(BitCodeAbbrevOp::Char6);
813 else if (Bits == SE_Fixed7)
814 AbbrevOpToUse = BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7);
815
816 // MODULE_CODE_SOURCE_FILENAME: [namechar x N]
817 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
818 Abbv->Add(BitCodeAbbrevOp(bitc::MODULE_CODE_SOURCE_FILENAME));
819 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
820 Abbv->Add(AbbrevOpToUse);
821 unsigned FilenameAbbrev = Stream.EmitAbbrev(Abbv);
822
823 for (const auto P : M->getSourceFileName())
824 Vals.push_back((unsigned char)P);
825
826 // Emit the finished record.
827 Stream.EmitRecord(bitc::MODULE_CODE_SOURCE_FILENAME, Vals, FilenameAbbrev);
828 Vals.clear();
829 }
Teresa Johnsond4d3dfd2015-11-20 14:51:27 +0000830
Teresa Johnson76a1c1d2016-03-11 18:52:24 +0000831 // If we have a VST, write the VSTOFFSET record placeholder and return
832 // its offset.
833 if (M->getValueSymbolTable().empty())
834 return 0;
835 return WriteValueSymbolTableForwardDecl(Stream);
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000836}
837
Dan Gohman0ebd6962009-07-20 21:19:07 +0000838static uint64_t GetOptimizationFlags(const Value *V) {
839 uint64_t Flags = 0;
840
Sanjay Patelc00017d2014-10-15 17:45:13 +0000841 if (const auto *OBO = dyn_cast<OverflowingBinaryOperator>(V)) {
Dan Gohman16f54152009-08-20 17:11:38 +0000842 if (OBO->hasNoSignedWrap())
843 Flags |= 1 << bitc::OBO_NO_SIGNED_WRAP;
844 if (OBO->hasNoUnsignedWrap())
845 Flags |= 1 << bitc::OBO_NO_UNSIGNED_WRAP;
Sanjay Patelc00017d2014-10-15 17:45:13 +0000846 } else if (const auto *PEO = dyn_cast<PossiblyExactOperator>(V)) {
Chris Lattner35315d02011-02-06 21:44:57 +0000847 if (PEO->isExact())
848 Flags |= 1 << bitc::PEO_EXACT;
Sanjay Patelc00017d2014-10-15 17:45:13 +0000849 } else if (const auto *FPMO = dyn_cast<FPMathOperator>(V)) {
Michael Ilseman9978d7e2012-11-27 00:43:38 +0000850 if (FPMO->hasUnsafeAlgebra())
Michael Ilseman65f14352012-12-09 21:12:04 +0000851 Flags |= FastMathFlags::UnsafeAlgebra;
Michael Ilseman9978d7e2012-11-27 00:43:38 +0000852 if (FPMO->hasNoNaNs())
Michael Ilseman65f14352012-12-09 21:12:04 +0000853 Flags |= FastMathFlags::NoNaNs;
Michael Ilseman9978d7e2012-11-27 00:43:38 +0000854 if (FPMO->hasNoInfs())
Michael Ilseman65f14352012-12-09 21:12:04 +0000855 Flags |= FastMathFlags::NoInfs;
Michael Ilseman9978d7e2012-11-27 00:43:38 +0000856 if (FPMO->hasNoSignedZeros())
Michael Ilseman65f14352012-12-09 21:12:04 +0000857 Flags |= FastMathFlags::NoSignedZeros;
Michael Ilseman9978d7e2012-11-27 00:43:38 +0000858 if (FPMO->hasAllowReciprocal())
Michael Ilseman65f14352012-12-09 21:12:04 +0000859 Flags |= FastMathFlags::AllowReciprocal;
Dan Gohman0ebd6962009-07-20 21:19:07 +0000860 }
861
862 return Flags;
863}
Chris Lattnerc1d10d62007-04-22 06:24:45 +0000864
Duncan P. N. Exon Smith5c7006e2014-12-11 23:02:24 +0000865static void WriteValueAsMetadata(const ValueAsMetadata *MD,
866 const ValueEnumerator &VE,
867 BitstreamWriter &Stream,
868 SmallVectorImpl<uint64_t> &Record) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000869 // Mimic an MDNode with a value as one operand.
870 Value *V = MD->getValue();
871 Record.push_back(VE.getTypeID(V->getType()));
872 Record.push_back(VE.getValueID(V));
Duncan P. N. Exon Smith5c7006e2014-12-11 23:02:24 +0000873 Stream.EmitRecord(bitc::METADATA_VALUE, Record, 0);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000874 Record.clear();
875}
876
Duncan P. N. Exon Smith6592dee2015-01-20 01:01:53 +0000877static void WriteMDTuple(const MDTuple *N, const ValueEnumerator &VE,
878 BitstreamWriter &Stream,
Duncan P. N. Exon Smithdb6bc8b2015-01-20 01:03:09 +0000879 SmallVectorImpl<uint64_t> &Record, unsigned Abbrev) {
Chris Lattner9b493022009-12-31 01:22:29 +0000880 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000881 Metadata *MD = N->getOperand(i);
Duncan P. N. Exon Smith9a6f64e2015-01-20 01:00:23 +0000882 assert(!(MD && isa<LocalAsMetadata>(MD)) &&
883 "Unexpected function-local metadata");
884 Record.push_back(VE.getMetadataOrNullID(MD));
Devang Patel8cca7b42009-08-04 05:01:35 +0000885 }
Duncan P. N. Exon Smith090a19b2015-01-08 22:38:29 +0000886 Stream.EmitRecord(N->isDistinct() ? bitc::METADATA_DISTINCT_NODE
887 : bitc::METADATA_NODE,
Duncan P. N. Exon Smithdb6bc8b2015-01-20 01:03:09 +0000888 Record, Abbrev);
Devang Patel8cca7b42009-08-04 05:01:35 +0000889 Record.clear();
890}
Devang Patele059ba6e2009-07-23 01:07:34 +0000891
Duncan P. N. Exon Smith625fda22016-03-24 16:25:51 +0000892static unsigned createDILocationAbbrev(BitstreamWriter &Stream) {
893 // Assume the column is usually under 128, and always output the inlined-at
894 // location (it's never more expensive than building an array size 1).
895 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
896 Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_LOCATION));
897 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));
898 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
899 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
900 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
901 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
902 return Stream.EmitAbbrev(Abbv);
903}
904
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000905static void WriteDILocation(const DILocation *N, const ValueEnumerator &VE,
Duncan P. N. Exon Smith6a484832015-01-13 21:10:44 +0000906 BitstreamWriter &Stream,
907 SmallVectorImpl<uint64_t> &Record,
Duncan P. N. Exon Smith625fda22016-03-24 16:25:51 +0000908 unsigned &Abbrev) {
909 if (!Abbrev)
910 Abbrev = createDILocationAbbrev(Stream);
911
Duncan P. N. Exon Smith6a484832015-01-13 21:10:44 +0000912 Record.push_back(N->isDistinct());
913 Record.push_back(N->getLine());
914 Record.push_back(N->getColumn());
915 Record.push_back(VE.getMetadataID(N->getScope()));
Duncan P. N. Exon Smith9a6f64e2015-01-20 01:00:23 +0000916 Record.push_back(VE.getMetadataOrNullID(N->getInlinedAt()));
Duncan P. N. Exon Smith6a484832015-01-13 21:10:44 +0000917
918 Stream.EmitRecord(bitc::METADATA_LOCATION, Record, Abbrev);
919 Record.clear();
920}
921
Duncan P. N. Exon Smitha5e25a52016-03-24 16:30:18 +0000922static unsigned createGenericDINodeAbbrev(BitstreamWriter &Stream) {
923 // Assume the column is usually under 128, and always output the inlined-at
924 // location (it's never more expensive than building an array size 1).
925 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
926 Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_GENERIC_DEBUG));
927 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));
928 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
929 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));
930 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
931 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
932 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
933 return Stream.EmitAbbrev(Abbv);
934}
935
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000936static void WriteGenericDINode(const GenericDINode *N,
937 const ValueEnumerator &VE,
938 BitstreamWriter &Stream,
939 SmallVectorImpl<uint64_t> &Record,
Duncan P. N. Exon Smitha5e25a52016-03-24 16:30:18 +0000940 unsigned &Abbrev) {
941 if (!Abbrev)
942 Abbrev = createGenericDINodeAbbrev(Stream);
943
Duncan P. N. Exon Smith4e4aa702015-02-03 21:54:14 +0000944 Record.push_back(N->isDistinct());
945 Record.push_back(N->getTag());
946 Record.push_back(0); // Per-tag version field; unused for now.
947
948 for (auto &I : N->operands())
949 Record.push_back(VE.getMetadataOrNullID(I));
950
951 Stream.EmitRecord(bitc::METADATA_GENERIC_DEBUG, Record, Abbrev);
952 Record.clear();
Duncan P. N. Exon Smithdb6bc8b2015-01-20 01:03:09 +0000953}
954
Duncan P. N. Exon Smithc7363f12015-02-13 01:10:38 +0000955static uint64_t rotateSign(int64_t I) {
956 uint64_t U = I;
957 return I < 0 ? ~(U << 1) : U << 1;
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000958}
Duncan P. N. Exon Smithc7363f12015-02-13 01:10:38 +0000959
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000960static void WriteDISubrange(const DISubrange *N, const ValueEnumerator &,
Duncan P. N. Exon Smithc7363f12015-02-13 01:10:38 +0000961 BitstreamWriter &Stream,
962 SmallVectorImpl<uint64_t> &Record,
963 unsigned Abbrev) {
964 Record.push_back(N->isDistinct());
965 Record.push_back(N->getCount());
Duncan P. N. Exon Smith5dcf6212015-04-07 00:39:59 +0000966 Record.push_back(rotateSign(N->getLowerBound()));
Duncan P. N. Exon Smithc7363f12015-02-13 01:10:38 +0000967
968 Stream.EmitRecord(bitc::METADATA_SUBRANGE, Record, Abbrev);
969 Record.clear();
970}
971
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000972static void WriteDIEnumerator(const DIEnumerator *N, const ValueEnumerator &VE,
Duncan P. N. Exon Smith87754762015-02-13 01:14:11 +0000973 BitstreamWriter &Stream,
974 SmallVectorImpl<uint64_t> &Record,
975 unsigned Abbrev) {
976 Record.push_back(N->isDistinct());
977 Record.push_back(rotateSign(N->getValue()));
978 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
979
980 Stream.EmitRecord(bitc::METADATA_ENUMERATOR, Record, Abbrev);
981 Record.clear();
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000982}
Duncan P. N. Exon Smith87754762015-02-13 01:14:11 +0000983
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000984static void WriteDIBasicType(const DIBasicType *N, const ValueEnumerator &VE,
Duncan P. N. Exon Smith09e03f32015-02-13 01:14:58 +0000985 BitstreamWriter &Stream,
986 SmallVectorImpl<uint64_t> &Record,
987 unsigned Abbrev) {
988 Record.push_back(N->isDistinct());
989 Record.push_back(N->getTag());
990 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
991 Record.push_back(N->getSizeInBits());
992 Record.push_back(N->getAlignInBits());
993 Record.push_back(N->getEncoding());
994
995 Stream.EmitRecord(bitc::METADATA_BASIC_TYPE, Record, Abbrev);
996 Record.clear();
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000997}
Duncan P. N. Exon Smith09e03f32015-02-13 01:14:58 +0000998
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000999static void WriteDIDerivedType(const DIDerivedType *N,
Duncan P. N. Exon Smith171d0772015-02-13 01:20:38 +00001000 const ValueEnumerator &VE,
1001 BitstreamWriter &Stream,
1002 SmallVectorImpl<uint64_t> &Record,
1003 unsigned Abbrev) {
1004 Record.push_back(N->isDistinct());
1005 Record.push_back(N->getTag());
1006 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1007 Record.push_back(VE.getMetadataOrNullID(N->getFile()));
1008 Record.push_back(N->getLine());
1009 Record.push_back(VE.getMetadataOrNullID(N->getScope()));
Duncan P. N. Exon Smithad6eb1272015-02-20 03:17:58 +00001010 Record.push_back(VE.getMetadataOrNullID(N->getBaseType()));
Duncan P. N. Exon Smith171d0772015-02-13 01:20:38 +00001011 Record.push_back(N->getSizeInBits());
1012 Record.push_back(N->getAlignInBits());
1013 Record.push_back(N->getOffsetInBits());
1014 Record.push_back(N->getFlags());
1015 Record.push_back(VE.getMetadataOrNullID(N->getExtraData()));
1016
1017 Stream.EmitRecord(bitc::METADATA_DERIVED_TYPE, Record, Abbrev);
1018 Record.clear();
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +00001019}
Duncan P. N. Exon Smith171d0772015-02-13 01:20:38 +00001020
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001021static void WriteDICompositeType(const DICompositeType *N,
Duncan P. N. Exon Smith171d0772015-02-13 01:20:38 +00001022 const ValueEnumerator &VE,
1023 BitstreamWriter &Stream,
1024 SmallVectorImpl<uint64_t> &Record,
1025 unsigned Abbrev) {
1026 Record.push_back(N->isDistinct());
1027 Record.push_back(N->getTag());
1028 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1029 Record.push_back(VE.getMetadataOrNullID(N->getFile()));
1030 Record.push_back(N->getLine());
1031 Record.push_back(VE.getMetadataOrNullID(N->getScope()));
1032 Record.push_back(VE.getMetadataOrNullID(N->getBaseType()));
1033 Record.push_back(N->getSizeInBits());
1034 Record.push_back(N->getAlignInBits());
1035 Record.push_back(N->getOffsetInBits());
1036 Record.push_back(N->getFlags());
Duncan P. N. Exon Smith11344732015-04-07 16:50:39 +00001037 Record.push_back(VE.getMetadataOrNullID(N->getElements().get()));
Duncan P. N. Exon Smith171d0772015-02-13 01:20:38 +00001038 Record.push_back(N->getRuntimeLang());
1039 Record.push_back(VE.getMetadataOrNullID(N->getVTableHolder()));
Duncan P. N. Exon Smith11344732015-04-07 16:50:39 +00001040 Record.push_back(VE.getMetadataOrNullID(N->getTemplateParams().get()));
Duncan P. N. Exon Smith171d0772015-02-13 01:20:38 +00001041 Record.push_back(VE.getMetadataOrNullID(N->getRawIdentifier()));
1042
1043 Stream.EmitRecord(bitc::METADATA_COMPOSITE_TYPE, Record, Abbrev);
1044 Record.clear();
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +00001045}
Duncan P. N. Exon Smith171d0772015-02-13 01:20:38 +00001046
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001047static void WriteDISubroutineType(const DISubroutineType *N,
Duncan P. N. Exon Smith54e2bc62015-02-13 01:22:59 +00001048 const ValueEnumerator &VE,
1049 BitstreamWriter &Stream,
1050 SmallVectorImpl<uint64_t> &Record,
1051 unsigned Abbrev) {
1052 Record.push_back(N->isDistinct());
1053 Record.push_back(N->getFlags());
Duncan P. N. Exon Smith11344732015-04-07 16:50:39 +00001054 Record.push_back(VE.getMetadataOrNullID(N->getTypeArray().get()));
Duncan P. N. Exon Smith54e2bc62015-02-13 01:22:59 +00001055
1056 Stream.EmitRecord(bitc::METADATA_SUBROUTINE_TYPE, Record, Abbrev);
1057 Record.clear();
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +00001058}
Duncan P. N. Exon Smithf14b9c72015-02-13 01:19:14 +00001059
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001060static void WriteDIFile(const DIFile *N, const ValueEnumerator &VE,
Duncan P. N. Exon Smithf14b9c72015-02-13 01:19:14 +00001061 BitstreamWriter &Stream,
1062 SmallVectorImpl<uint64_t> &Record, unsigned Abbrev) {
1063 Record.push_back(N->isDistinct());
1064 Record.push_back(VE.getMetadataOrNullID(N->getRawFilename()));
1065 Record.push_back(VE.getMetadataOrNullID(N->getRawDirectory()));
1066
1067 Stream.EmitRecord(bitc::METADATA_FILE, Record, Abbrev);
1068 Record.clear();
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +00001069}
Duncan P. N. Exon Smithf14b9c72015-02-13 01:19:14 +00001070
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001071static void WriteDICompileUnit(const DICompileUnit *N,
Duncan P. N. Exon Smithc1f1acc2015-02-13 01:25:10 +00001072 const ValueEnumerator &VE,
1073 BitstreamWriter &Stream,
1074 SmallVectorImpl<uint64_t> &Record,
1075 unsigned Abbrev) {
Duncan P. N. Exon Smith55ca9642015-08-03 17:26:41 +00001076 assert(N->isDistinct() && "Expected distinct compile units");
1077 Record.push_back(/* IsDistinct */ true);
Duncan P. N. Exon Smithc1f1acc2015-02-13 01:25:10 +00001078 Record.push_back(N->getSourceLanguage());
Duncan P. N. Exon Smithad6eb1272015-02-20 03:17:58 +00001079 Record.push_back(VE.getMetadataOrNullID(N->getFile()));
Duncan P. N. Exon Smithc1f1acc2015-02-13 01:25:10 +00001080 Record.push_back(VE.getMetadataOrNullID(N->getRawProducer()));
1081 Record.push_back(N->isOptimized());
1082 Record.push_back(VE.getMetadataOrNullID(N->getRawFlags()));
1083 Record.push_back(N->getRuntimeVersion());
1084 Record.push_back(VE.getMetadataOrNullID(N->getRawSplitDebugFilename()));
1085 Record.push_back(N->getEmissionKind());
Duncan P. N. Exon Smith11344732015-04-07 16:50:39 +00001086 Record.push_back(VE.getMetadataOrNullID(N->getEnumTypes().get()));
1087 Record.push_back(VE.getMetadataOrNullID(N->getRetainedTypes().get()));
1088 Record.push_back(VE.getMetadataOrNullID(N->getSubprograms().get()));
1089 Record.push_back(VE.getMetadataOrNullID(N->getGlobalVariables().get()));
1090 Record.push_back(VE.getMetadataOrNullID(N->getImportedEntities().get()));
Adrian Prantl1f599f92015-05-21 20:37:30 +00001091 Record.push_back(N->getDWOId());
Amjad Abouda9bcf162015-12-10 12:56:35 +00001092 Record.push_back(VE.getMetadataOrNullID(N->getMacros().get()));
Duncan P. N. Exon Smithc1f1acc2015-02-13 01:25:10 +00001093
1094 Stream.EmitRecord(bitc::METADATA_COMPILE_UNIT, Record, Abbrev);
1095 Record.clear();
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +00001096}
Duncan P. N. Exon Smithc1f1acc2015-02-13 01:25:10 +00001097
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001098static void WriteDISubprogram(const DISubprogram *N, const ValueEnumerator &VE,
1099 BitstreamWriter &Stream,
1100 SmallVectorImpl<uint64_t> &Record,
1101 unsigned Abbrev) {
Duncan P. N. Exon Smith19fc5ed2015-02-13 01:26:47 +00001102 Record.push_back(N->isDistinct());
1103 Record.push_back(VE.getMetadataOrNullID(N->getScope()));
1104 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1105 Record.push_back(VE.getMetadataOrNullID(N->getRawLinkageName()));
1106 Record.push_back(VE.getMetadataOrNullID(N->getFile()));
1107 Record.push_back(N->getLine());
1108 Record.push_back(VE.getMetadataOrNullID(N->getType()));
1109 Record.push_back(N->isLocalToUnit());
1110 Record.push_back(N->isDefinition());
1111 Record.push_back(N->getScopeLine());
1112 Record.push_back(VE.getMetadataOrNullID(N->getContainingType()));
1113 Record.push_back(N->getVirtuality());
1114 Record.push_back(N->getVirtualIndex());
1115 Record.push_back(N->getFlags());
1116 Record.push_back(N->isOptimized());
Duncan P. N. Exon Smith11344732015-04-07 16:50:39 +00001117 Record.push_back(VE.getMetadataOrNullID(N->getTemplateParams().get()));
Duncan P. N. Exon Smith19fc5ed2015-02-13 01:26:47 +00001118 Record.push_back(VE.getMetadataOrNullID(N->getDeclaration()));
Duncan P. N. Exon Smith11344732015-04-07 16:50:39 +00001119 Record.push_back(VE.getMetadataOrNullID(N->getVariables().get()));
Duncan P. N. Exon Smith19fc5ed2015-02-13 01:26:47 +00001120
1121 Stream.EmitRecord(bitc::METADATA_SUBPROGRAM, Record, Abbrev);
1122 Record.clear();
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +00001123}
Duncan P. N. Exon Smith19fc5ed2015-02-13 01:26:47 +00001124
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001125static void WriteDILexicalBlock(const DILexicalBlock *N,
1126 const ValueEnumerator &VE,
1127 BitstreamWriter &Stream,
1128 SmallVectorImpl<uint64_t> &Record,
1129 unsigned Abbrev) {
Duncan P. N. Exon Smitha96d4092015-02-13 01:29:28 +00001130 Record.push_back(N->isDistinct());
1131 Record.push_back(VE.getMetadataOrNullID(N->getScope()));
1132 Record.push_back(VE.getMetadataOrNullID(N->getFile()));
1133 Record.push_back(N->getLine());
1134 Record.push_back(N->getColumn());
1135
1136 Stream.EmitRecord(bitc::METADATA_LEXICAL_BLOCK, Record, Abbrev);
1137 Record.clear();
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +00001138}
Duncan P. N. Exon Smitha96d4092015-02-13 01:29:28 +00001139
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001140static void WriteDILexicalBlockFile(const DILexicalBlockFile *N,
Duncan P. N. Exon Smith06a07022015-02-13 01:30:42 +00001141 const ValueEnumerator &VE,
1142 BitstreamWriter &Stream,
1143 SmallVectorImpl<uint64_t> &Record,
1144 unsigned Abbrev) {
1145 Record.push_back(N->isDistinct());
1146 Record.push_back(VE.getMetadataOrNullID(N->getScope()));
1147 Record.push_back(VE.getMetadataOrNullID(N->getFile()));
1148 Record.push_back(N->getDiscriminator());
1149
1150 Stream.EmitRecord(bitc::METADATA_LEXICAL_BLOCK_FILE, Record, Abbrev);
1151 Record.clear();
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +00001152}
Duncan P. N. Exon Smith06a07022015-02-13 01:30:42 +00001153
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001154static void WriteDINamespace(const DINamespace *N, const ValueEnumerator &VE,
Duncan P. N. Exon Smithe1460002015-02-13 01:32:09 +00001155 BitstreamWriter &Stream,
1156 SmallVectorImpl<uint64_t> &Record,
1157 unsigned Abbrev) {
1158 Record.push_back(N->isDistinct());
1159 Record.push_back(VE.getMetadataOrNullID(N->getScope()));
1160 Record.push_back(VE.getMetadataOrNullID(N->getFile()));
1161 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1162 Record.push_back(N->getLine());
1163
1164 Stream.EmitRecord(bitc::METADATA_NAMESPACE, Record, Abbrev);
1165 Record.clear();
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +00001166}
Duncan P. N. Exon Smithe1460002015-02-13 01:32:09 +00001167
Amjad Abouda9bcf162015-12-10 12:56:35 +00001168static void WriteDIMacro(const DIMacro *N, const ValueEnumerator &VE,
1169 BitstreamWriter &Stream,
1170 SmallVectorImpl<uint64_t> &Record, unsigned Abbrev) {
1171 Record.push_back(N->isDistinct());
1172 Record.push_back(N->getMacinfoType());
1173 Record.push_back(N->getLine());
1174 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1175 Record.push_back(VE.getMetadataOrNullID(N->getRawValue()));
1176
1177 Stream.EmitRecord(bitc::METADATA_MACRO, Record, Abbrev);
1178 Record.clear();
1179}
1180
1181static void WriteDIMacroFile(const DIMacroFile *N, const ValueEnumerator &VE,
1182 BitstreamWriter &Stream,
1183 SmallVectorImpl<uint64_t> &Record,
1184 unsigned Abbrev) {
1185 Record.push_back(N->isDistinct());
1186 Record.push_back(N->getMacinfoType());
1187 Record.push_back(N->getLine());
1188 Record.push_back(VE.getMetadataOrNullID(N->getFile()));
1189 Record.push_back(VE.getMetadataOrNullID(N->getElements().get()));
1190
1191 Stream.EmitRecord(bitc::METADATA_MACRO_FILE, Record, Abbrev);
1192 Record.clear();
1193}
1194
Adrian Prantlab1243f2015-06-29 23:03:47 +00001195static void WriteDIModule(const DIModule *N, const ValueEnumerator &VE,
1196 BitstreamWriter &Stream,
1197 SmallVectorImpl<uint64_t> &Record, unsigned Abbrev) {
1198 Record.push_back(N->isDistinct());
1199 for (auto &I : N->operands())
1200 Record.push_back(VE.getMetadataOrNullID(I));
1201
1202 Stream.EmitRecord(bitc::METADATA_MODULE, Record, Abbrev);
1203 Record.clear();
1204}
1205
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001206static void WriteDITemplateTypeParameter(const DITemplateTypeParameter *N,
Duncan P. N. Exon Smith2847f382015-02-13 01:34:32 +00001207 const ValueEnumerator &VE,
1208 BitstreamWriter &Stream,
1209 SmallVectorImpl<uint64_t> &Record,
1210 unsigned Abbrev) {
1211 Record.push_back(N->isDistinct());
Duncan P. N. Exon Smith2847f382015-02-13 01:34:32 +00001212 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1213 Record.push_back(VE.getMetadataOrNullID(N->getType()));
1214
1215 Stream.EmitRecord(bitc::METADATA_TEMPLATE_TYPE, Record, Abbrev);
1216 Record.clear();
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +00001217}
Duncan P. N. Exon Smith2847f382015-02-13 01:34:32 +00001218
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001219static void WriteDITemplateValueParameter(const DITemplateValueParameter *N,
Duncan P. N. Exon Smith2847f382015-02-13 01:34:32 +00001220 const ValueEnumerator &VE,
1221 BitstreamWriter &Stream,
1222 SmallVectorImpl<uint64_t> &Record,
1223 unsigned Abbrev) {
1224 Record.push_back(N->isDistinct());
1225 Record.push_back(N->getTag());
Duncan P. N. Exon Smith2847f382015-02-13 01:34:32 +00001226 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1227 Record.push_back(VE.getMetadataOrNullID(N->getType()));
1228 Record.push_back(VE.getMetadataOrNullID(N->getValue()));
1229
1230 Stream.EmitRecord(bitc::METADATA_TEMPLATE_VALUE, Record, Abbrev);
1231 Record.clear();
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +00001232}
Duncan P. N. Exon Smith2847f382015-02-13 01:34:32 +00001233
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001234static void WriteDIGlobalVariable(const DIGlobalVariable *N,
Duncan P. N. Exon Smithc8f810a2015-02-13 01:35:40 +00001235 const ValueEnumerator &VE,
1236 BitstreamWriter &Stream,
1237 SmallVectorImpl<uint64_t> &Record,
1238 unsigned Abbrev) {
1239 Record.push_back(N->isDistinct());
1240 Record.push_back(VE.getMetadataOrNullID(N->getScope()));
1241 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1242 Record.push_back(VE.getMetadataOrNullID(N->getRawLinkageName()));
1243 Record.push_back(VE.getMetadataOrNullID(N->getFile()));
1244 Record.push_back(N->getLine());
1245 Record.push_back(VE.getMetadataOrNullID(N->getType()));
1246 Record.push_back(N->isLocalToUnit());
1247 Record.push_back(N->isDefinition());
Duncan P. N. Exon Smith7ad0bd52015-04-11 20:27:40 +00001248 Record.push_back(VE.getMetadataOrNullID(N->getRawVariable()));
Duncan P. N. Exon Smithc8f810a2015-02-13 01:35:40 +00001249 Record.push_back(VE.getMetadataOrNullID(N->getStaticDataMemberDeclaration()));
1250
1251 Stream.EmitRecord(bitc::METADATA_GLOBAL_VAR, Record, Abbrev);
1252 Record.clear();
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +00001253}
Duncan P. N. Exon Smithc8f810a2015-02-13 01:35:40 +00001254
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001255static void WriteDILocalVariable(const DILocalVariable *N,
Duncan P. N. Exon Smith72fe2d02015-02-13 01:39:44 +00001256 const ValueEnumerator &VE,
1257 BitstreamWriter &Stream,
1258 SmallVectorImpl<uint64_t> &Record,
1259 unsigned Abbrev) {
1260 Record.push_back(N->isDistinct());
Duncan P. N. Exon Smith72fe2d02015-02-13 01:39:44 +00001261 Record.push_back(VE.getMetadataOrNullID(N->getScope()));
1262 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1263 Record.push_back(VE.getMetadataOrNullID(N->getFile()));
1264 Record.push_back(N->getLine());
1265 Record.push_back(VE.getMetadataOrNullID(N->getType()));
1266 Record.push_back(N->getArg());
1267 Record.push_back(N->getFlags());
Duncan P. N. Exon Smith72fe2d02015-02-13 01:39:44 +00001268
1269 Stream.EmitRecord(bitc::METADATA_LOCAL_VAR, Record, Abbrev);
1270 Record.clear();
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +00001271}
Duncan P. N. Exon Smith72fe2d02015-02-13 01:39:44 +00001272
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001273static void WriteDIExpression(const DIExpression *N, const ValueEnumerator &,
Duncan P. N. Exon Smith0c5c0122015-02-13 01:42:09 +00001274 BitstreamWriter &Stream,
1275 SmallVectorImpl<uint64_t> &Record,
1276 unsigned Abbrev) {
1277 Record.reserve(N->getElements().size() + 1);
1278
1279 Record.push_back(N->isDistinct());
Benjamin Kramer6cd780f2015-02-17 15:29:18 +00001280 Record.append(N->elements_begin(), N->elements_end());
Duncan P. N. Exon Smith0c5c0122015-02-13 01:42:09 +00001281
1282 Stream.EmitRecord(bitc::METADATA_EXPRESSION, Record, Abbrev);
1283 Record.clear();
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +00001284}
Duncan P. N. Exon Smith0c5c0122015-02-13 01:42:09 +00001285
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001286static void WriteDIObjCProperty(const DIObjCProperty *N,
1287 const ValueEnumerator &VE,
1288 BitstreamWriter &Stream,
1289 SmallVectorImpl<uint64_t> &Record,
1290 unsigned Abbrev) {
Duncan P. N. Exon Smithd45ce962015-02-13 01:43:22 +00001291 Record.push_back(N->isDistinct());
1292 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1293 Record.push_back(VE.getMetadataOrNullID(N->getFile()));
1294 Record.push_back(N->getLine());
1295 Record.push_back(VE.getMetadataOrNullID(N->getRawSetterName()));
1296 Record.push_back(VE.getMetadataOrNullID(N->getRawGetterName()));
1297 Record.push_back(N->getAttributes());
1298 Record.push_back(VE.getMetadataOrNullID(N->getType()));
1299
1300 Stream.EmitRecord(bitc::METADATA_OBJC_PROPERTY, Record, Abbrev);
1301 Record.clear();
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +00001302}
Duncan P. N. Exon Smithd45ce962015-02-13 01:43:22 +00001303
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001304static void WriteDIImportedEntity(const DIImportedEntity *N,
Duncan P. N. Exon Smith1c931162015-02-13 01:46:02 +00001305 const ValueEnumerator &VE,
1306 BitstreamWriter &Stream,
1307 SmallVectorImpl<uint64_t> &Record,
1308 unsigned Abbrev) {
1309 Record.push_back(N->isDistinct());
1310 Record.push_back(N->getTag());
1311 Record.push_back(VE.getMetadataOrNullID(N->getScope()));
1312 Record.push_back(VE.getMetadataOrNullID(N->getEntity()));
1313 Record.push_back(N->getLine());
1314 Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1315
1316 Stream.EmitRecord(bitc::METADATA_IMPORTED_ENTITY, Record, Abbrev);
1317 Record.clear();
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +00001318}
1319
Duncan P. N. Exon Smithf8ecdf52016-03-24 16:16:08 +00001320static unsigned createNamedMetadataAbbrev(BitstreamWriter &Stream) {
1321 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1322 Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_NAME));
1323 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1324 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
1325 return Stream.EmitAbbrev(Abbv);
1326}
1327
1328static void writeNamedMetadata(const Module &M, const ValueEnumerator &VE,
1329 BitstreamWriter &Stream,
1330 SmallVectorImpl<uint64_t> &Record) {
1331 if (M.named_metadata_empty())
1332 return;
1333
1334 unsigned Abbrev = createNamedMetadataAbbrev(Stream);
1335 for (const NamedMDNode &NMD : M.named_metadata()) {
1336 // Write name.
1337 StringRef Str = NMD.getName();
1338 Record.append(Str.bytes_begin(), Str.bytes_end());
1339 Stream.EmitRecord(bitc::METADATA_NAME, Record, Abbrev);
1340 Record.clear();
1341
1342 // Write named metadata operands.
1343 for (const MDNode *N : NMD.operands())
1344 Record.push_back(VE.getMetadataID(N));
1345 Stream.EmitRecord(bitc::METADATA_NAMED_NODE, Record, 0);
1346 Record.clear();
1347 }
1348}
1349
Duncan P. N. Exon Smith6565a0d2016-03-27 23:17:54 +00001350static unsigned createMetadataStringsAbbrev(BitstreamWriter &Stream) {
1351 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1352 Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_STRINGS));
1353 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of strings
1354 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // offset to chars
1355 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1356 return Stream.EmitAbbrev(Abbv);
1357}
1358
1359/// Write out a record for MDString.
1360///
1361/// All the metadata strings in a metadata block are emitted in a single
1362/// record. The sizes and strings themselves are shoved into a blob.
1363static void writeMetadataStrings(ArrayRef<const Metadata *> Strings,
1364 BitstreamWriter &Stream,
1365 SmallVectorImpl<uint64_t> &Record) {
1366 if (Strings.empty())
1367 return;
1368
1369 // Start the record with the number of strings.
1370 Record.push_back(bitc::METADATA_STRINGS);
1371 Record.push_back(Strings.size());
1372
1373 // Emit the sizes of the strings in the blob.
1374 SmallString<256> Blob;
1375 {
1376 BitstreamWriter W(Blob);
1377 for (const Metadata *MD : Strings)
1378 W.EmitVBR(cast<MDString>(MD)->getLength(), 6);
1379 W.FlushToWord();
1380 }
1381
1382 // Add the offset to the strings to the record.
1383 Record.push_back(Blob.size());
1384
1385 // Add the strings to the blob.
1386 for (const Metadata *MD : Strings)
1387 Blob.append(cast<MDString>(MD)->getString());
1388
1389 // Emit the final record.
1390 Stream.EmitRecordWithBlob(createMetadataStringsAbbrev(Stream), Record, Blob);
1391 Record.clear();
1392}
1393
Duncan P. N. Exon Smith0b7243e2016-03-24 16:01:46 +00001394static void WriteModuleMetadata(const Module &M,
Dan Gohman2637cc12010-07-21 23:38:33 +00001395 const ValueEnumerator &VE,
Devang Patel8cca7b42009-08-04 05:01:35 +00001396 BitstreamWriter &Stream) {
Duncan P. N. Exon Smith6565a0d2016-03-27 23:17:54 +00001397 if (VE.getMDs().empty() && M.named_metadata_empty())
Duncan P. N. Exon Smith2fcf60e2015-01-12 22:30:34 +00001398 return;
1399
1400 Stream.EnterSubblock(bitc::METADATA_BLOCK_ID, 3);
1401
Duncan P. N. Exon Smith6b7b6802015-02-04 21:54:12 +00001402 // Initialize MDNode abbreviations.
1403#define HANDLE_MDNODE_LEAF(CLASS) unsigned CLASS##Abbrev = 0;
1404#include "llvm/IR/Metadata.def"
1405
Devang Patel8cca7b42009-08-04 05:01:35 +00001406 SmallVector<uint64_t, 64> Record;
Duncan P. N. Exon Smith6565a0d2016-03-27 23:17:54 +00001407 writeMetadataStrings(VE.getMDStrings(), Stream, Record);
1408 for (const Metadata *MD : VE.getNonMDStrings()) {
Duncan P. N. Exon Smith73d5aae2015-01-12 22:31:35 +00001409 if (const MDNode *N = dyn_cast<MDNode>(MD)) {
Duncan P. N. Exon Smith79f8d112015-03-17 00:16:35 +00001410 assert(N->isResolved() && "Expected forward references to be resolved");
1411
Duncan P. N. Exon Smithdb6bc8b2015-01-20 01:03:09 +00001412 switch (N->getMetadataID()) {
1413 default:
1414 llvm_unreachable("Invalid MDNode subclass");
1415#define HANDLE_MDNODE_LEAF(CLASS) \
1416 case Metadata::CLASS##Kind: \
1417 Write##CLASS(cast<CLASS>(N), VE, Stream, Record, CLASS##Abbrev); \
1418 continue;
1419#include "llvm/IR/Metadata.def"
1420 }
Devang Patel8cca7b42009-08-04 05:01:35 +00001421 }
Duncan P. N. Exon Smith6565a0d2016-03-27 23:17:54 +00001422 WriteValueAsMetadata(cast<ConstantAsMetadata>(MD), VE, Stream, Record);
Devang Patel8cca7b42009-08-04 05:01:35 +00001423 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001424
Duncan P. N. Exon Smithf8ecdf52016-03-24 16:16:08 +00001425 writeNamedMetadata(M, VE, Stream, Record);
Duncan P. N. Exon Smith2fcf60e2015-01-12 22:30:34 +00001426 Stream.ExitBlock();
Devang Patelaf206b82009-09-18 19:26:43 +00001427}
1428
Victor Hernandez36aee302010-01-14 19:38:44 +00001429static void WriteFunctionLocalMetadata(const Function &F,
1430 const ValueEnumerator &VE,
Victor Hernandezb00a6be2010-01-13 19:37:33 +00001431 BitstreamWriter &Stream) {
1432 bool StartedMetadataBlock = false;
1433 SmallVector<uint64_t, 64> Record;
Duncan P. N. Exon Smith2766e4d2016-03-27 23:22:31 +00001434 for (const Metadata *MD : VE.getFunctionMDs()) {
1435 auto *Local = cast<LocalAsMetadata>(MD);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001436 if (!StartedMetadataBlock) {
1437 Stream.EnterSubblock(bitc::METADATA_BLOCK_ID, 3);
1438 StartedMetadataBlock = true;
1439 }
Duncan P. N. Exon Smith2766e4d2016-03-27 23:22:31 +00001440 WriteValueAsMetadata(Local, VE, Stream, Record);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001441 }
Michael Ilseman26ee2b82012-11-15 22:34:00 +00001442
Victor Hernandezb00a6be2010-01-13 19:37:33 +00001443 if (StartedMetadataBlock)
1444 Stream.ExitBlock();
1445}
1446
Devang Patelaf206b82009-09-18 19:26:43 +00001447static void WriteMetadataAttachment(const Function &F,
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001448 const ValueEnumerator &VE,
1449 BitstreamWriter &Stream) {
Chris Lattner07d09ed2010-04-03 02:17:50 +00001450 Stream.EnterSubblock(bitc::METADATA_ATTACHMENT_ID, 3);
1451
Devang Patelaf206b82009-09-18 19:26:43 +00001452 SmallVector<uint64_t, 64> Record;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001453
Devang Patelaf206b82009-09-18 19:26:43 +00001454 // Write metadata attachments
Chris Lattnerbb95d5e2011-06-17 17:56:00 +00001455 // METADATA_ATTACHMENT - [m x [value, [n x [id, mdnode]]]
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00001456 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
Duncan P. N. Exon Smith3d4cd752015-04-24 22:04:41 +00001457 F.getAllMetadata(MDs);
1458 if (!MDs.empty()) {
1459 for (const auto &I : MDs) {
1460 Record.push_back(I.first);
1461 Record.push_back(VE.getMetadataID(I.second));
1462 }
1463 Stream.EmitRecord(bitc::METADATA_ATTACHMENT, Record, 0);
1464 Record.clear();
1465 }
Michael Ilseman26ee2b82012-11-15 22:34:00 +00001466
Duncan P. N. Exon Smith584af872015-10-13 03:26:19 +00001467 for (const BasicBlock &BB : F)
1468 for (const Instruction &I : BB) {
Devang Patel6da5dbf2009-10-22 18:55:16 +00001469 MDs.clear();
Duncan P. N. Exon Smith584af872015-10-13 03:26:19 +00001470 I.getAllMetadataOtherThanDebugLoc(MDs);
Michael Ilseman26ee2b82012-11-15 22:34:00 +00001471
Chris Lattner2f2aa2b2009-12-28 23:41:32 +00001472 // If no metadata, ignore instruction.
1473 if (MDs.empty()) continue;
1474
Duncan P. N. Exon Smith584af872015-10-13 03:26:19 +00001475 Record.push_back(VE.getInstructionID(&I));
Michael Ilseman26ee2b82012-11-15 22:34:00 +00001476
Chris Lattner2f2aa2b2009-12-28 23:41:32 +00001477 for (unsigned i = 0, e = MDs.size(); i != e; ++i) {
1478 Record.push_back(MDs[i].first);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001479 Record.push_back(VE.getMetadataID(MDs[i].second));
Devang Patelaf206b82009-09-18 19:26:43 +00001480 }
Chris Lattnerbb95d5e2011-06-17 17:56:00 +00001481 Stream.EmitRecord(bitc::METADATA_ATTACHMENT, Record, 0);
Chris Lattner2f2aa2b2009-12-28 23:41:32 +00001482 Record.clear();
Devang Patelaf206b82009-09-18 19:26:43 +00001483 }
1484
Chris Lattner07d09ed2010-04-03 02:17:50 +00001485 Stream.ExitBlock();
Devang Patelaf206b82009-09-18 19:26:43 +00001486}
1487
Chris Lattnerc9558df2009-12-28 20:10:43 +00001488static void WriteModuleMetadataStore(const Module *M, BitstreamWriter &Stream) {
Devang Patelaf206b82009-09-18 19:26:43 +00001489 SmallVector<uint64_t, 64> Record;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001490
Devang Patelaf206b82009-09-18 19:26:43 +00001491 // Write metadata kinds
1492 // METADATA_KIND - [n x [id, name]]
Michael Ilseman979dfbb2012-12-03 22:57:47 +00001493 SmallVector<StringRef, 8> Names;
Chris Lattnera0566972009-12-29 09:01:33 +00001494 M->getMDKindNames(Names);
Michael Ilseman26ee2b82012-11-15 22:34:00 +00001495
Dan Gohman43aa8f02010-07-20 21:42:28 +00001496 if (Names.empty()) return;
Chris Lattnerc9558df2009-12-28 20:10:43 +00001497
Teresa Johnson12545072015-11-15 02:00:09 +00001498 Stream.EnterSubblock(bitc::METADATA_KIND_BLOCK_ID, 3);
Michael Ilseman26ee2b82012-11-15 22:34:00 +00001499
Dan Gohman43aa8f02010-07-20 21:42:28 +00001500 for (unsigned MDKindID = 0, e = Names.size(); MDKindID != e; ++MDKindID) {
Chris Lattnerc9558df2009-12-28 20:10:43 +00001501 Record.push_back(MDKindID);
1502 StringRef KName = Names[MDKindID];
1503 Record.append(KName.begin(), KName.end());
Michael Ilseman26ee2b82012-11-15 22:34:00 +00001504
Devang Patelaf206b82009-09-18 19:26:43 +00001505 Stream.EmitRecord(bitc::METADATA_KIND, Record, 0);
1506 Record.clear();
1507 }
1508
Chris Lattnerc9558df2009-12-28 20:10:43 +00001509 Stream.ExitBlock();
Devang Patel8cca7b42009-08-04 05:01:35 +00001510}
1511
Sanjoy Dasb513a9f2015-09-24 23:34:52 +00001512static void WriteOperandBundleTags(const Module *M, BitstreamWriter &Stream) {
1513 // Write metadata kinds
1514 //
1515 // OPERAND_BUNDLE_TAGS_BLOCK_ID : N x OPERAND_BUNDLE_TAG
1516 //
1517 // OPERAND_BUNDLE_TAG - [strchr x N]
1518
1519 SmallVector<StringRef, 8> Tags;
1520 M->getOperandBundleTags(Tags);
1521
1522 if (Tags.empty())
1523 return;
1524
1525 Stream.EnterSubblock(bitc::OPERAND_BUNDLE_TAGS_BLOCK_ID, 3);
1526
1527 SmallVector<uint64_t, 64> Record;
1528
1529 for (auto Tag : Tags) {
1530 Record.append(Tag.begin(), Tag.end());
1531
1532 Stream.EmitRecord(bitc::OPERAND_BUNDLE_TAG, Record, 0);
1533 Record.clear();
1534 }
1535
1536 Stream.ExitBlock();
1537}
1538
Jan Wen Voungafaced02012-10-11 20:20:40 +00001539static void emitSignedInt64(SmallVectorImpl<uint64_t> &Vals, uint64_t V) {
1540 if ((int64_t)V >= 0)
1541 Vals.push_back(V << 1);
1542 else
1543 Vals.push_back((-V << 1) | 1);
1544}
1545
Devang Patel8cca7b42009-08-04 05:01:35 +00001546static void WriteConstants(unsigned FirstVal, unsigned LastVal,
1547 const ValueEnumerator &VE,
1548 BitstreamWriter &Stream, bool isGlobal) {
1549 if (FirstVal == LastVal) return;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001550
Devang Patel8cca7b42009-08-04 05:01:35 +00001551 Stream.EnterSubblock(bitc::CONSTANTS_BLOCK_ID, 4);
1552
1553 unsigned AggregateAbbrev = 0;
1554 unsigned String8Abbrev = 0;
1555 unsigned CString7Abbrev = 0;
1556 unsigned CString6Abbrev = 0;
1557 // If this is a constant pool for the module, emit module-specific abbrevs.
1558 if (isGlobal) {
1559 // Abbrev for CST_CODE_AGGREGATE.
1560 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1561 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_AGGREGATE));
1562 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1563 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, Log2_32_Ceil(LastVal+1)));
1564 AggregateAbbrev = Stream.EmitAbbrev(Abbv);
1565
1566 // Abbrev for CST_CODE_STRING.
1567 Abbv = new BitCodeAbbrev();
1568 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_STRING));
1569 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1570 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
1571 String8Abbrev = Stream.EmitAbbrev(Abbv);
1572 // Abbrev for CST_CODE_CSTRING.
1573 Abbv = new BitCodeAbbrev();
1574 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_CSTRING));
1575 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1576 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7));
1577 CString7Abbrev = Stream.EmitAbbrev(Abbv);
1578 // Abbrev for CST_CODE_CSTRING.
1579 Abbv = new BitCodeAbbrev();
1580 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_CSTRING));
1581 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1582 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
1583 CString6Abbrev = Stream.EmitAbbrev(Abbv);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001584 }
1585
Devang Patel8cca7b42009-08-04 05:01:35 +00001586 SmallVector<uint64_t, 64> Record;
1587
1588 const ValueEnumerator::ValueList &Vals = VE.getValues();
Craig Topper2617dcc2014-04-15 06:32:26 +00001589 Type *LastTy = nullptr;
Devang Patel8cca7b42009-08-04 05:01:35 +00001590 for (unsigned i = FirstVal; i != LastVal; ++i) {
1591 const Value *V = Vals[i].first;
Chris Lattner52523562007-04-24 00:16:04 +00001592 // If we need to switch types, do so now.
1593 if (V->getType() != LastTy) {
1594 LastTy = V->getType();
1595 Record.push_back(VE.getTypeID(LastTy));
Chris Lattnerda5e5d22007-05-05 07:36:14 +00001596 Stream.EmitRecord(bitc::CST_CODE_SETTYPE, Record,
1597 CONSTANTS_SETTYPE_ABBREV);
Chris Lattner52523562007-04-24 00:16:04 +00001598 Record.clear();
1599 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001600
Chris Lattner52523562007-04-24 00:16:04 +00001601 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
Dale Johannesenfd04c742009-10-13 20:46:56 +00001602 Record.push_back(unsigned(IA->hasSideEffects()) |
Chad Rosier18fcdcf2012-09-05 00:56:20 +00001603 unsigned(IA->isAlignStack()) << 1 |
1604 unsigned(IA->getDialect()&1) << 2);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001605
Chris Lattneraf8fffc2007-05-06 01:58:20 +00001606 // Add the asm string.
1607 const std::string &AsmStr = IA->getAsmString();
1608 Record.push_back(AsmStr.size());
Benjamin Kramer6cd780f2015-02-17 15:29:18 +00001609 Record.append(AsmStr.begin(), AsmStr.end());
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001610
Chris Lattneraf8fffc2007-05-06 01:58:20 +00001611 // Add the constraint string.
1612 const std::string &ConstraintStr = IA->getConstraintString();
1613 Record.push_back(ConstraintStr.size());
Benjamin Kramer6cd780f2015-02-17 15:29:18 +00001614 Record.append(ConstraintStr.begin(), ConstraintStr.end());
Chris Lattneraf8fffc2007-05-06 01:58:20 +00001615 Stream.EmitRecord(bitc::CST_CODE_INLINEASM, Record);
1616 Record.clear();
Chris Lattner52523562007-04-24 00:16:04 +00001617 continue;
1618 }
1619 const Constant *C = cast<Constant>(V);
1620 unsigned Code = -1U;
1621 unsigned AbbrevToUse = 0;
1622 if (C->isNullValue()) {
1623 Code = bitc::CST_CODE_NULL;
1624 } else if (isa<UndefValue>(C)) {
1625 Code = bitc::CST_CODE_UNDEF;
1626 } else if (const ConstantInt *IV = dyn_cast<ConstantInt>(C)) {
Bob Wilsone4077362013-09-09 19:14:35 +00001627 if (IV->getBitWidth() <= 64) {
1628 uint64_t V = IV->getSExtValue();
1629 emitSignedInt64(Record, V);
1630 Code = bitc::CST_CODE_INTEGER;
1631 AbbrevToUse = CONSTANTS_INTEGER_ABBREV;
1632 } else { // Wide integers, > 64 bits in size.
1633 // We have an arbitrary precision integer value to write whose
1634 // bit width is > 64. However, in canonical unsigned integer
1635 // format it is likely that the high bits are going to be zero.
1636 // So, we only write the number of active words.
1637 unsigned NWords = IV->getValue().getActiveWords();
1638 const uint64_t *RawWords = IV->getValue().getRawData();
1639 for (unsigned i = 0; i != NWords; ++i) {
1640 emitSignedInt64(Record, RawWords[i]);
1641 }
1642 Code = bitc::CST_CODE_WIDE_INTEGER;
1643 }
Chris Lattner52523562007-04-24 00:16:04 +00001644 } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(C)) {
1645 Code = bitc::CST_CODE_FLOAT;
Chris Lattner229907c2011-07-18 04:54:35 +00001646 Type *Ty = CFP->getType();
Dan Gohman518cda42011-12-17 00:04:22 +00001647 if (Ty->isHalfTy() || Ty->isFloatTy() || Ty->isDoubleTy()) {
Dale Johannesen54306fe2008-10-09 18:53:47 +00001648 Record.push_back(CFP->getValueAPF().bitcastToAPInt().getZExtValue());
Chris Lattnerfdd87902009-10-05 05:54:46 +00001649 } else if (Ty->isX86_FP80Ty()) {
Dale Johannesen34aa41c2007-09-26 23:20:33 +00001650 // api needed to prevent premature destruction
Dale Johannesen93eefa02009-03-23 21:16:53 +00001651 // bits are not in the same order as a normal i80 APInt, compensate.
Dale Johannesen54306fe2008-10-09 18:53:47 +00001652 APInt api = CFP->getValueAPF().bitcastToAPInt();
Dale Johannesen34aa41c2007-09-26 23:20:33 +00001653 const uint64_t *p = api.getRawData();
Dale Johannesen93eefa02009-03-23 21:16:53 +00001654 Record.push_back((p[1] << 48) | (p[0] >> 16));
1655 Record.push_back(p[0] & 0xffffLL);
Chris Lattnerfdd87902009-10-05 05:54:46 +00001656 } else if (Ty->isFP128Ty() || Ty->isPPC_FP128Ty()) {
Dale Johannesen54306fe2008-10-09 18:53:47 +00001657 APInt api = CFP->getValueAPF().bitcastToAPInt();
Dale Johannesen34aa41c2007-09-26 23:20:33 +00001658 const uint64_t *p = api.getRawData();
Dale Johannesen245dceb2007-09-11 18:32:33 +00001659 Record.push_back(p[0]);
1660 Record.push_back(p[1]);
Dale Johannesenbdad8092007-08-09 22:51:36 +00001661 } else {
1662 assert (0 && "Unknown FP type!");
Chris Lattner52523562007-04-24 00:16:04 +00001663 }
Chris Lattner372dd1e2012-01-30 00:51:16 +00001664 } else if (isa<ConstantDataSequential>(C) &&
1665 cast<ConstantDataSequential>(C)->isString()) {
1666 const ConstantDataSequential *Str = cast<ConstantDataSequential>(C);
1667 // Emit constant strings specially.
1668 unsigned NumElts = Str->getNumElements();
1669 // If this is a null-terminated string, use the denser CSTRING encoding.
1670 if (Str->isCString()) {
1671 Code = bitc::CST_CODE_CSTRING;
1672 --NumElts; // Don't encode the null, which isn't allowed by char6.
1673 } else {
1674 Code = bitc::CST_CODE_STRING;
1675 AbbrevToUse = String8Abbrev;
1676 }
1677 bool isCStr7 = Code == bitc::CST_CODE_CSTRING;
1678 bool isCStrChar6 = Code == bitc::CST_CODE_CSTRING;
1679 for (unsigned i = 0; i != NumElts; ++i) {
1680 unsigned char V = Str->getElementAsInteger(i);
1681 Record.push_back(V);
1682 isCStr7 &= (V & 128) == 0;
1683 if (isCStrChar6)
1684 isCStrChar6 = BitCodeAbbrevOp::isChar6(V);
1685 }
Michael Ilseman26ee2b82012-11-15 22:34:00 +00001686
Chris Lattner372dd1e2012-01-30 00:51:16 +00001687 if (isCStrChar6)
1688 AbbrevToUse = CString6Abbrev;
1689 else if (isCStr7)
1690 AbbrevToUse = CString7Abbrev;
Michael Ilseman26ee2b82012-11-15 22:34:00 +00001691 } else if (const ConstantDataSequential *CDS =
Chris Lattner372dd1e2012-01-30 00:51:16 +00001692 dyn_cast<ConstantDataSequential>(C)) {
Chris Lattner5d917072012-01-30 07:36:01 +00001693 Code = bitc::CST_CODE_DATA;
Chris Lattner372dd1e2012-01-30 00:51:16 +00001694 Type *EltTy = CDS->getType()->getElementType();
1695 if (isa<IntegerType>(EltTy)) {
1696 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i)
1697 Record.push_back(CDS->getElementAsInteger(i));
Chris Lattner372dd1e2012-01-30 00:51:16 +00001698 } else {
Justin Bognera43eacb2016-01-06 22:31:32 +00001699 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i)
1700 Record.push_back(
1701 CDS->getElementAsAPFloat(i).bitcastToAPInt().getLimitedValue());
Chris Lattner372dd1e2012-01-30 00:51:16 +00001702 }
1703 } else if (isa<ConstantArray>(C) || isa<ConstantStruct>(C) ||
1704 isa<ConstantVector>(C)) {
Chris Lattner52523562007-04-24 00:16:04 +00001705 Code = bitc::CST_CODE_AGGREGATE;
Pete Cooper125ad172015-06-25 20:51:38 +00001706 for (const Value *Op : C->operands())
1707 Record.push_back(VE.getValueID(Op));
Chris Lattnerda5e5d22007-05-05 07:36:14 +00001708 AbbrevToUse = AggregateAbbrev;
Chris Lattner52523562007-04-24 00:16:04 +00001709 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
Chris Lattner1e16bcf72007-04-24 07:07:11 +00001710 switch (CE->getOpcode()) {
1711 default:
1712 if (Instruction::isCast(CE->getOpcode())) {
1713 Code = bitc::CST_CODE_CE_CAST;
1714 Record.push_back(GetEncodedCastOpcode(CE->getOpcode()));
1715 Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
1716 Record.push_back(VE.getValueID(C->getOperand(0)));
Chris Lattnerda5e5d22007-05-05 07:36:14 +00001717 AbbrevToUse = CONSTANTS_CE_CAST_Abbrev;
Chris Lattner1e16bcf72007-04-24 07:07:11 +00001718 } else {
1719 assert(CE->getNumOperands() == 2 && "Unknown constant expr!");
1720 Code = bitc::CST_CODE_CE_BINOP;
1721 Record.push_back(GetEncodedBinaryOpcode(CE->getOpcode()));
1722 Record.push_back(VE.getValueID(C->getOperand(0)));
1723 Record.push_back(VE.getValueID(C->getOperand(1)));
Dan Gohman0ebd6962009-07-20 21:19:07 +00001724 uint64_t Flags = GetOptimizationFlags(CE);
1725 if (Flags != 0)
1726 Record.push_back(Flags);
Chris Lattner1e16bcf72007-04-24 07:07:11 +00001727 }
1728 break;
David Blaikieb9263572015-03-13 21:03:36 +00001729 case Instruction::GetElementPtr: {
Chris Lattner1e16bcf72007-04-24 07:07:11 +00001730 Code = bitc::CST_CODE_CE_GEP;
David Blaikieb9263572015-03-13 21:03:36 +00001731 const auto *GO = cast<GEPOperator>(C);
1732 if (GO->isInBounds())
Dan Gohman1639c392009-07-27 21:53:46 +00001733 Code = bitc::CST_CODE_CE_INBOUNDS_GEP;
David Blaikieb9263572015-03-13 21:03:36 +00001734 Record.push_back(VE.getTypeID(GO->getSourceElementType()));
Chris Lattner1e16bcf72007-04-24 07:07:11 +00001735 for (unsigned i = 0, e = CE->getNumOperands(); i != e; ++i) {
1736 Record.push_back(VE.getTypeID(C->getOperand(i)->getType()));
1737 Record.push_back(VE.getValueID(C->getOperand(i)));
1738 }
1739 break;
David Blaikieb9263572015-03-13 21:03:36 +00001740 }
Chris Lattner1e16bcf72007-04-24 07:07:11 +00001741 case Instruction::Select:
1742 Code = bitc::CST_CODE_CE_SELECT;
1743 Record.push_back(VE.getValueID(C->getOperand(0)));
1744 Record.push_back(VE.getValueID(C->getOperand(1)));
1745 Record.push_back(VE.getValueID(C->getOperand(2)));
1746 break;
1747 case Instruction::ExtractElement:
1748 Code = bitc::CST_CODE_CE_EXTRACTELT;
1749 Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
1750 Record.push_back(VE.getValueID(C->getOperand(0)));
Michael J. Spencer1f10c5ea2014-05-01 22:12:39 +00001751 Record.push_back(VE.getTypeID(C->getOperand(1)->getType()));
Chris Lattner1e16bcf72007-04-24 07:07:11 +00001752 Record.push_back(VE.getValueID(C->getOperand(1)));
1753 break;
1754 case Instruction::InsertElement:
1755 Code = bitc::CST_CODE_CE_INSERTELT;
1756 Record.push_back(VE.getValueID(C->getOperand(0)));
1757 Record.push_back(VE.getValueID(C->getOperand(1)));
Michael J. Spencer1f10c5ea2014-05-01 22:12:39 +00001758 Record.push_back(VE.getTypeID(C->getOperand(2)->getType()));
Chris Lattner1e16bcf72007-04-24 07:07:11 +00001759 Record.push_back(VE.getValueID(C->getOperand(2)));
1760 break;
1761 case Instruction::ShuffleVector:
Nate Begeman94aa38d2009-02-12 21:28:33 +00001762 // If the return type and argument types are the same, this is a
1763 // standard shufflevector instruction. If the types are different,
1764 // then the shuffle is widening or truncating the input vectors, and
1765 // the argument type must also be encoded.
1766 if (C->getType() == C->getOperand(0)->getType()) {
1767 Code = bitc::CST_CODE_CE_SHUFFLEVEC;
1768 } else {
1769 Code = bitc::CST_CODE_CE_SHUFVEC_EX;
1770 Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
1771 }
Chris Lattner1e16bcf72007-04-24 07:07:11 +00001772 Record.push_back(VE.getValueID(C->getOperand(0)));
1773 Record.push_back(VE.getValueID(C->getOperand(1)));
1774 Record.push_back(VE.getValueID(C->getOperand(2)));
1775 break;
1776 case Instruction::ICmp:
1777 case Instruction::FCmp:
Nick Lewyckya21d3da2009-07-08 03:04:38 +00001778 Code = bitc::CST_CODE_CE_CMP;
Chris Lattner1e16bcf72007-04-24 07:07:11 +00001779 Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
1780 Record.push_back(VE.getValueID(C->getOperand(0)));
1781 Record.push_back(VE.getValueID(C->getOperand(1)));
1782 Record.push_back(CE->getPredicate());
1783 break;
1784 }
Chris Lattnerf540d742009-10-28 05:24:40 +00001785 } else if (const BlockAddress *BA = dyn_cast<BlockAddress>(C)) {
Chris Lattnerf540d742009-10-28 05:24:40 +00001786 Code = bitc::CST_CODE_BLOCKADDRESS;
1787 Record.push_back(VE.getTypeID(BA->getFunction()->getType()));
1788 Record.push_back(VE.getValueID(BA->getFunction()));
1789 Record.push_back(VE.getGlobalBasicBlockID(BA->getBasicBlock()));
Chris Lattner52523562007-04-24 00:16:04 +00001790 } else {
Dan Gohman47dc8fd2010-07-21 21:18:37 +00001791#ifndef NDEBUG
1792 C->dump();
1793#endif
Torok Edwinfbcc6632009-07-14 16:55:14 +00001794 llvm_unreachable("Unknown constant!");
Chris Lattner52523562007-04-24 00:16:04 +00001795 }
1796 Stream.EmitRecord(Code, Record, AbbrevToUse);
1797 Record.clear();
1798 }
1799
1800 Stream.ExitBlock();
1801}
1802
1803static void WriteModuleConstants(const ValueEnumerator &VE,
1804 BitstreamWriter &Stream) {
1805 const ValueEnumerator::ValueList &Vals = VE.getValues();
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001806
Chris Lattner52523562007-04-24 00:16:04 +00001807 // Find the first constant to emit, which is the first non-globalvalue value.
1808 // We know globalvalues have been emitted by WriteModuleInfo.
1809 for (unsigned i = 0, e = Vals.size(); i != e; ++i) {
1810 if (!isa<GlobalValue>(Vals[i].first)) {
Devang Patel8cca7b42009-08-04 05:01:35 +00001811 WriteConstants(i, Vals.size(), VE, Stream, true);
Chris Lattner52523562007-04-24 00:16:04 +00001812 return;
1813 }
1814 }
1815}
Chris Lattner215e9cd2007-04-23 20:35:01 +00001816
Chris Lattnerdf1233d2007-05-06 00:00:00 +00001817/// PushValueAndType - The file has to encode both the value and type id for
1818/// many values, because we need to know what type to create for forward
1819/// references. However, most operands are not forward references, so this type
1820/// field is not needed.
1821///
1822/// This function adds V's value ID to Vals. If the value ID is higher than the
1823/// instruction ID, then it is a forward reference, and it also includes the
Jan Wen Voungafaced02012-10-11 20:20:40 +00001824/// type ID. The value ID that is written is encoded relative to the InstID.
Gabor Greif4b79e472009-01-16 18:40:27 +00001825static bool PushValueAndType(const Value *V, unsigned InstID,
Craig Topper2cd5ff82013-07-11 16:22:38 +00001826 SmallVectorImpl<unsigned> &Vals,
Chris Lattnerdf1233d2007-05-06 00:00:00 +00001827 ValueEnumerator &VE) {
1828 unsigned ValID = VE.getValueID(V);
Jan Wen Voungafaced02012-10-11 20:20:40 +00001829 // Make encoding relative to the InstID.
1830 Vals.push_back(InstID - ValID);
Chris Lattnerdf1233d2007-05-06 00:00:00 +00001831 if (ValID >= InstID) {
1832 Vals.push_back(VE.getTypeID(V->getType()));
1833 return true;
1834 }
1835 return false;
1836}
1837
Sanjoy Dasb513a9f2015-09-24 23:34:52 +00001838static void WriteOperandBundles(BitstreamWriter &Stream, ImmutableCallSite CS,
1839 unsigned InstID, ValueEnumerator &VE) {
1840 SmallVector<unsigned, 64> Record;
1841 LLVMContext &C = CS.getInstruction()->getContext();
1842
1843 for (unsigned i = 0, e = CS.getNumOperandBundles(); i != e; ++i) {
Sanjoy Das54c3ca62015-11-07 01:56:04 +00001844 const auto &Bundle = CS.getOperandBundleAt(i);
Sanjoy Dasb9ca6dc2015-11-10 20:13:15 +00001845 Record.push_back(C.getOperandBundleTagID(Bundle.getTagName()));
Sanjoy Dasb513a9f2015-09-24 23:34:52 +00001846
1847 for (auto &Input : Bundle.Inputs)
1848 PushValueAndType(Input, InstID, Record, VE);
1849
1850 Stream.EmitRecord(bitc::FUNC_CODE_OPERAND_BUNDLE, Record);
1851 Record.clear();
1852 }
1853}
1854
Jan Wen Voungafaced02012-10-11 20:20:40 +00001855/// pushValue - Like PushValueAndType, but where the type of the value is
1856/// omitted (perhaps it was already encoded in an earlier operand).
1857static void pushValue(const Value *V, unsigned InstID,
Craig Topper2cd5ff82013-07-11 16:22:38 +00001858 SmallVectorImpl<unsigned> &Vals,
Jan Wen Voungafaced02012-10-11 20:20:40 +00001859 ValueEnumerator &VE) {
1860 unsigned ValID = VE.getValueID(V);
1861 Vals.push_back(InstID - ValID);
1862}
1863
Jan Wen Voungafaced02012-10-11 20:20:40 +00001864static void pushValueSigned(const Value *V, unsigned InstID,
Craig Topper2cd5ff82013-07-11 16:22:38 +00001865 SmallVectorImpl<uint64_t> &Vals,
Jan Wen Voungafaced02012-10-11 20:20:40 +00001866 ValueEnumerator &VE) {
1867 unsigned ValID = VE.getValueID(V);
1868 int64_t diff = ((int32_t)InstID - (int32_t)ValID);
1869 emitSignedInt64(Vals, diff);
1870}
1871
Chris Lattnere6e364c2007-04-26 05:53:54 +00001872/// WriteInstruction - Emit an instruction to the specified stream.
Chris Lattnerdf1233d2007-05-06 00:00:00 +00001873static void WriteInstruction(const Instruction &I, unsigned InstID,
1874 ValueEnumerator &VE, BitstreamWriter &Stream,
Craig Topper2cd5ff82013-07-11 16:22:38 +00001875 SmallVectorImpl<unsigned> &Vals) {
Chris Lattnere6e364c2007-04-26 05:53:54 +00001876 unsigned Code = 0;
1877 unsigned AbbrevToUse = 0;
Devang Patelaf206b82009-09-18 19:26:43 +00001878 VE.setInstructionID(&I);
Chris Lattnere6e364c2007-04-26 05:53:54 +00001879 switch (I.getOpcode()) {
1880 default:
1881 if (Instruction::isCast(I.getOpcode())) {
Chris Lattner0a603252007-05-01 02:13:26 +00001882 Code = bitc::FUNC_CODE_INST_CAST;
Chris Lattnerc67e6d92007-05-06 02:38:57 +00001883 if (!PushValueAndType(I.getOperand(0), InstID, Vals, VE))
1884 AbbrevToUse = FUNCTION_INST_CAST_ABBREV;
Chris Lattnere6e364c2007-04-26 05:53:54 +00001885 Vals.push_back(VE.getTypeID(I.getType()));
Chris Lattnere9759c22007-05-06 00:21:25 +00001886 Vals.push_back(GetEncodedCastOpcode(I.getOpcode()));
Chris Lattnere6e364c2007-04-26 05:53:54 +00001887 } else {
1888 assert(isa<BinaryOperator>(I) && "Unknown instruction!");
Chris Lattner9f35f912007-05-02 04:26:36 +00001889 Code = bitc::FUNC_CODE_INST_BINOP;
Chris Lattnerc67e6d92007-05-06 02:38:57 +00001890 if (!PushValueAndType(I.getOperand(0), InstID, Vals, VE))
1891 AbbrevToUse = FUNCTION_INST_BINOP_ABBREV;
Jan Wen Voungafaced02012-10-11 20:20:40 +00001892 pushValue(I.getOperand(1), InstID, Vals, VE);
Chris Lattnere9759c22007-05-06 00:21:25 +00001893 Vals.push_back(GetEncodedBinaryOpcode(I.getOpcode()));
Dan Gohman0ebd6962009-07-20 21:19:07 +00001894 uint64_t Flags = GetOptimizationFlags(&I);
1895 if (Flags != 0) {
1896 if (AbbrevToUse == FUNCTION_INST_BINOP_ABBREV)
1897 AbbrevToUse = FUNCTION_INST_BINOP_FLAGS_ABBREV;
1898 Vals.push_back(Flags);
1899 }
Chris Lattnere6e364c2007-04-26 05:53:54 +00001900 }
1901 break;
Chris Lattner0a603252007-05-01 02:13:26 +00001902
David Blaikieb5b5efd2015-02-25 01:08:52 +00001903 case Instruction::GetElementPtr: {
Chris Lattner0a603252007-05-01 02:13:26 +00001904 Code = bitc::FUNC_CODE_INST_GEP;
David Blaikieb5b5efd2015-02-25 01:08:52 +00001905 AbbrevToUse = FUNCTION_INST_GEP_ABBREV;
1906 auto &GEPInst = cast<GetElementPtrInst>(I);
1907 Vals.push_back(GEPInst.isInBounds());
1908 Vals.push_back(VE.getTypeID(GEPInst.getSourceElementType()));
Chris Lattnerdf1233d2007-05-06 00:00:00 +00001909 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
1910 PushValueAndType(I.getOperand(i), InstID, Vals, VE);
Chris Lattner0a603252007-05-01 02:13:26 +00001911 break;
David Blaikieb5b5efd2015-02-25 01:08:52 +00001912 }
Dan Gohmanca0256a2008-05-31 19:11:15 +00001913 case Instruction::ExtractValue: {
Dan Gohman30499842008-05-23 01:55:30 +00001914 Code = bitc::FUNC_CODE_INST_EXTRACTVAL;
Dan Gohmanca0256a2008-05-31 19:11:15 +00001915 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1916 const ExtractValueInst *EVI = cast<ExtractValueInst>(&I);
Benjamin Kramer6cd780f2015-02-17 15:29:18 +00001917 Vals.append(EVI->idx_begin(), EVI->idx_end());
Dan Gohman30499842008-05-23 01:55:30 +00001918 break;
Dan Gohmanca0256a2008-05-31 19:11:15 +00001919 }
1920 case Instruction::InsertValue: {
Dan Gohman30499842008-05-23 01:55:30 +00001921 Code = bitc::FUNC_CODE_INST_INSERTVAL;
Dan Gohmanca0256a2008-05-31 19:11:15 +00001922 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1923 PushValueAndType(I.getOperand(1), InstID, Vals, VE);
1924 const InsertValueInst *IVI = cast<InsertValueInst>(&I);
Benjamin Kramer6cd780f2015-02-17 15:29:18 +00001925 Vals.append(IVI->idx_begin(), IVI->idx_end());
Dan Gohman30499842008-05-23 01:55:30 +00001926 break;
Dan Gohmanca0256a2008-05-31 19:11:15 +00001927 }
Chris Lattner0a603252007-05-01 02:13:26 +00001928 case Instruction::Select:
Dan Gohmanc5d28922008-09-16 01:01:33 +00001929 Code = bitc::FUNC_CODE_INST_VSELECT;
Chris Lattnere9759c22007-05-06 00:21:25 +00001930 PushValueAndType(I.getOperand(1), InstID, Vals, VE);
Jan Wen Voungafaced02012-10-11 20:20:40 +00001931 pushValue(I.getOperand(2), InstID, Vals, VE);
Dan Gohmanc5d28922008-09-16 01:01:33 +00001932 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
Chris Lattner0a603252007-05-01 02:13:26 +00001933 break;
1934 case Instruction::ExtractElement:
1935 Code = bitc::FUNC_CODE_INST_EXTRACTELT;
Chris Lattnere9759c22007-05-06 00:21:25 +00001936 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
Michael J. Spencer1f10c5ea2014-05-01 22:12:39 +00001937 PushValueAndType(I.getOperand(1), InstID, Vals, VE);
Chris Lattner0a603252007-05-01 02:13:26 +00001938 break;
1939 case Instruction::InsertElement:
1940 Code = bitc::FUNC_CODE_INST_INSERTELT;
Chris Lattnere9759c22007-05-06 00:21:25 +00001941 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
Jan Wen Voungafaced02012-10-11 20:20:40 +00001942 pushValue(I.getOperand(1), InstID, Vals, VE);
Michael J. Spencer1f10c5ea2014-05-01 22:12:39 +00001943 PushValueAndType(I.getOperand(2), InstID, Vals, VE);
Chris Lattner0a603252007-05-01 02:13:26 +00001944 break;
1945 case Instruction::ShuffleVector:
1946 Code = bitc::FUNC_CODE_INST_SHUFFLEVEC;
Chris Lattnere9759c22007-05-06 00:21:25 +00001947 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
Jan Wen Voungafaced02012-10-11 20:20:40 +00001948 pushValue(I.getOperand(1), InstID, Vals, VE);
1949 pushValue(I.getOperand(2), InstID, Vals, VE);
Chris Lattner0a603252007-05-01 02:13:26 +00001950 break;
1951 case Instruction::ICmp:
James Molloy88eb5352015-07-10 12:52:00 +00001952 case Instruction::FCmp: {
Nick Lewyckya21d3da2009-07-08 03:04:38 +00001953 // compare returning Int1Ty or vector of Int1Ty
1954 Code = bitc::FUNC_CODE_INST_CMP2;
Chris Lattnerdf1233d2007-05-06 00:00:00 +00001955 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
Jan Wen Voungafaced02012-10-11 20:20:40 +00001956 pushValue(I.getOperand(1), InstID, Vals, VE);
Chris Lattner0a603252007-05-01 02:13:26 +00001957 Vals.push_back(cast<CmpInst>(I).getPredicate());
James Molloy88eb5352015-07-10 12:52:00 +00001958 uint64_t Flags = GetOptimizationFlags(&I);
1959 if (Flags != 0)
1960 Vals.push_back(Flags);
Chris Lattner0a603252007-05-01 02:13:26 +00001961 break;
James Molloy88eb5352015-07-10 12:52:00 +00001962 }
Chris Lattner0a603252007-05-01 02:13:26 +00001963
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001964 case Instruction::Ret:
Devang Patelbbfd8742008-02-26 01:29:32 +00001965 {
1966 Code = bitc::FUNC_CODE_INST_RET;
1967 unsigned NumOperands = I.getNumOperands();
Devang Patelbbfd8742008-02-26 01:29:32 +00001968 if (NumOperands == 0)
1969 AbbrevToUse = FUNCTION_INST_RET_VOID_ABBREV;
1970 else if (NumOperands == 1) {
1971 if (!PushValueAndType(I.getOperand(0), InstID, Vals, VE))
1972 AbbrevToUse = FUNCTION_INST_RET_VAL_ABBREV;
1973 } else {
1974 for (unsigned i = 0, e = NumOperands; i != e; ++i)
1975 PushValueAndType(I.getOperand(i), InstID, Vals, VE);
1976 }
1977 }
Chris Lattner0a603252007-05-01 02:13:26 +00001978 break;
1979 case Instruction::Br:
Gabor Greif1933b002009-01-30 18:27:21 +00001980 {
1981 Code = bitc::FUNC_CODE_INST_BR;
David Blaikieb78e9e52013-02-11 01:16:51 +00001982 const BranchInst &II = cast<BranchInst>(I);
Gabor Greif1933b002009-01-30 18:27:21 +00001983 Vals.push_back(VE.getValueID(II.getSuccessor(0)));
1984 if (II.isConditional()) {
1985 Vals.push_back(VE.getValueID(II.getSuccessor(1)));
Jan Wen Voungafaced02012-10-11 20:20:40 +00001986 pushValue(II.getCondition(), InstID, Vals, VE);
Gabor Greif1933b002009-01-30 18:27:21 +00001987 }
Chris Lattner0a603252007-05-01 02:13:26 +00001988 }
1989 break;
1990 case Instruction::Switch:
Stepan Dyatkovskiy513aaa52012-02-01 07:49:51 +00001991 {
1992 Code = bitc::FUNC_CODE_INST_SWITCH;
David Blaikieb78e9e52013-02-11 01:16:51 +00001993 const SwitchInst &SI = cast<SwitchInst>(I);
Bob Wilsone4077362013-09-09 19:14:35 +00001994 Vals.push_back(VE.getTypeID(SI.getCondition()->getType()));
1995 pushValue(SI.getCondition(), InstID, Vals, VE);
1996 Vals.push_back(VE.getValueID(SI.getDefaultDest()));
Sanjay Patel225d65f2015-11-13 16:21:23 +00001997 for (SwitchInst::ConstCaseIt Case : SI.cases()) {
1998 Vals.push_back(VE.getValueID(Case.getCaseValue()));
1999 Vals.push_back(VE.getValueID(Case.getCaseSuccessor()));
Stepan Dyatkovskiy513aaa52012-02-01 07:49:51 +00002000 }
2001 }
Chris Lattner0a603252007-05-01 02:13:26 +00002002 break;
Chris Lattnerd04cb6d2009-10-28 00:19:10 +00002003 case Instruction::IndirectBr:
2004 Code = bitc::FUNC_CODE_INST_INDIRECTBR;
Chris Lattner3ed871f2009-10-27 19:13:16 +00002005 Vals.push_back(VE.getTypeID(I.getOperand(0)->getType()));
Jan Wen Voungafaced02012-10-11 20:20:40 +00002006 // Encode the address operand as relative, but not the basic blocks.
2007 pushValue(I.getOperand(0), InstID, Vals, VE);
2008 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i)
Chris Lattner3ed871f2009-10-27 19:13:16 +00002009 Vals.push_back(VE.getValueID(I.getOperand(i)));
2010 break;
Michael Ilseman26ee2b82012-11-15 22:34:00 +00002011
Chris Lattnerb811e952007-05-01 07:03:37 +00002012 case Instruction::Invoke: {
Gabor Greif4b79e472009-01-16 18:40:27 +00002013 const InvokeInst *II = cast<InvokeInst>(&I);
David Blaikie5ea1f7b2015-04-24 18:06:06 +00002014 const Value *Callee = II->getCalledValue();
2015 FunctionType *FTy = II->getFunctionType();
Sanjoy Dasb513a9f2015-09-24 23:34:52 +00002016
2017 if (II->hasOperandBundles())
2018 WriteOperandBundles(Stream, II, InstID, VE);
2019
Chris Lattner0a603252007-05-01 02:13:26 +00002020 Code = bitc::FUNC_CODE_INST_INVOKE;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002021
Devang Patel4c758ea2008-09-25 21:00:45 +00002022 Vals.push_back(VE.getAttributeID(II->getAttributes()));
David Blaikie5ea1f7b2015-04-24 18:06:06 +00002023 Vals.push_back(II->getCallingConv() | 1 << 13);
Gabor Greif6ecd6f42009-01-07 22:39:29 +00002024 Vals.push_back(VE.getValueID(II->getNormalDest()));
2025 Vals.push_back(VE.getValueID(II->getUnwindDest()));
David Blaikie5ea1f7b2015-04-24 18:06:06 +00002026 Vals.push_back(VE.getTypeID(FTy));
Gabor Greif4b79e472009-01-16 18:40:27 +00002027 PushValueAndType(Callee, InstID, Vals, VE);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002028
Chris Lattner0a603252007-05-01 02:13:26 +00002029 // Emit value #'s for the fixed parameters.
Chris Lattner0a603252007-05-01 02:13:26 +00002030 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Jan Wen Voungafaced02012-10-11 20:20:40 +00002031 pushValue(I.getOperand(i), InstID, Vals, VE); // fixed param.
Chris Lattner0a603252007-05-01 02:13:26 +00002032
2033 // Emit type/value pairs for varargs params.
2034 if (FTy->isVarArg()) {
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00002035 for (unsigned i = FTy->getNumParams(), e = I.getNumOperands()-3;
Chris Lattnerdf1233d2007-05-06 00:00:00 +00002036 i != e; ++i)
2037 PushValueAndType(I.getOperand(i), InstID, Vals, VE); // vararg
Chris Lattner0a603252007-05-01 02:13:26 +00002038 }
2039 break;
Chris Lattnerb811e952007-05-01 07:03:37 +00002040 }
Bill Wendlingf891bf82011-07-31 06:30:59 +00002041 case Instruction::Resume:
2042 Code = bitc::FUNC_CODE_INST_RESUME;
2043 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
2044 break;
David Majnemer654e1302015-07-31 17:58:14 +00002045 case Instruction::CleanupRet: {
2046 Code = bitc::FUNC_CODE_INST_CLEANUPRET;
2047 const auto &CRI = cast<CleanupReturnInst>(I);
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00002048 pushValue(CRI.getCleanupPad(), InstID, Vals, VE);
David Majnemer654e1302015-07-31 17:58:14 +00002049 if (CRI.hasUnwindDest())
2050 Vals.push_back(VE.getValueID(CRI.getUnwindDest()));
2051 break;
2052 }
2053 case Instruction::CatchRet: {
2054 Code = bitc::FUNC_CODE_INST_CATCHRET;
2055 const auto &CRI = cast<CatchReturnInst>(I);
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00002056 pushValue(CRI.getCatchPad(), InstID, Vals, VE);
David Majnemer654e1302015-07-31 17:58:14 +00002057 Vals.push_back(VE.getValueID(CRI.getSuccessor()));
2058 break;
2059 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00002060 case Instruction::CleanupPad:
David Majnemer654e1302015-07-31 17:58:14 +00002061 case Instruction::CatchPad: {
David Majnemer8a1c45d2015-12-12 05:38:55 +00002062 const auto &FuncletPad = cast<FuncletPadInst>(I);
2063 Code = isa<CatchPadInst>(FuncletPad) ? bitc::FUNC_CODE_INST_CATCHPAD
2064 : bitc::FUNC_CODE_INST_CLEANUPPAD;
2065 pushValue(FuncletPad.getParentPad(), InstID, Vals, VE);
2066
2067 unsigned NumArgOperands = FuncletPad.getNumArgOperands();
David Majnemer654e1302015-07-31 17:58:14 +00002068 Vals.push_back(NumArgOperands);
2069 for (unsigned Op = 0; Op != NumArgOperands; ++Op)
David Majnemer8a1c45d2015-12-12 05:38:55 +00002070 PushValueAndType(FuncletPad.getArgOperand(Op), InstID, Vals, VE);
2071 break;
2072 }
2073 case Instruction::CatchSwitch: {
2074 Code = bitc::FUNC_CODE_INST_CATCHSWITCH;
2075 const auto &CatchSwitch = cast<CatchSwitchInst>(I);
2076
2077 pushValue(CatchSwitch.getParentPad(), InstID, Vals, VE);
2078
2079 unsigned NumHandlers = CatchSwitch.getNumHandlers();
2080 Vals.push_back(NumHandlers);
2081 for (const BasicBlock *CatchPadBB : CatchSwitch.handlers())
2082 Vals.push_back(VE.getValueID(CatchPadBB));
2083
2084 if (CatchSwitch.hasUnwindDest())
2085 Vals.push_back(VE.getValueID(CatchSwitch.getUnwindDest()));
David Majnemer654e1302015-07-31 17:58:14 +00002086 break;
2087 }
Chris Lattnere6e364c2007-04-26 05:53:54 +00002088 case Instruction::Unreachable:
2089 Code = bitc::FUNC_CODE_INST_UNREACHABLE;
Chris Lattnercc6d4c92007-05-06 01:28:01 +00002090 AbbrevToUse = FUNCTION_INST_UNREACHABLE_ABBREV;
Chris Lattnere6e364c2007-04-26 05:53:54 +00002091 break;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002092
Jay Foad372ad642011-06-20 14:18:48 +00002093 case Instruction::PHI: {
2094 const PHINode &PN = cast<PHINode>(I);
Chris Lattner0a603252007-05-01 02:13:26 +00002095 Code = bitc::FUNC_CODE_INST_PHI;
Jan Wen Voungafaced02012-10-11 20:20:40 +00002096 // With the newer instruction encoding, forward references could give
2097 // negative valued IDs. This is most common for PHIs, so we use
2098 // signed VBRs.
2099 SmallVector<uint64_t, 128> Vals64;
2100 Vals64.push_back(VE.getTypeID(PN.getType()));
Jay Foad372ad642011-06-20 14:18:48 +00002101 for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
Jan Wen Voungafaced02012-10-11 20:20:40 +00002102 pushValueSigned(PN.getIncomingValue(i), InstID, Vals64, VE);
2103 Vals64.push_back(VE.getValueID(PN.getIncomingBlock(i)));
Jay Foad372ad642011-06-20 14:18:48 +00002104 }
Jan Wen Voungafaced02012-10-11 20:20:40 +00002105 // Emit a Vals64 vector and exit.
2106 Stream.EmitRecord(Code, Vals64, AbbrevToUse);
2107 Vals64.clear();
2108 return;
Jay Foad372ad642011-06-20 14:18:48 +00002109 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002110
Bill Wendlingfae14752011-08-12 20:24:12 +00002111 case Instruction::LandingPad: {
2112 const LandingPadInst &LP = cast<LandingPadInst>(I);
2113 Code = bitc::FUNC_CODE_INST_LANDINGPAD;
2114 Vals.push_back(VE.getTypeID(LP.getType()));
Bill Wendlingfae14752011-08-12 20:24:12 +00002115 Vals.push_back(LP.isCleanup());
2116 Vals.push_back(LP.getNumClauses());
2117 for (unsigned I = 0, E = LP.getNumClauses(); I != E; ++I) {
2118 if (LP.isCatch(I))
2119 Vals.push_back(LandingPadInst::Catch);
2120 else
2121 Vals.push_back(LandingPadInst::Filter);
2122 PushValueAndType(LP.getClause(I), InstID, Vals, VE);
2123 }
2124 break;
2125 }
2126
Reid Kleckner56b56ea2014-07-16 01:34:27 +00002127 case Instruction::Alloca: {
Chris Lattner0a603252007-05-01 02:13:26 +00002128 Code = bitc::FUNC_CODE_INST_ALLOCA;
David Blaikiebdb49102015-04-28 16:51:01 +00002129 const AllocaInst &AI = cast<AllocaInst>(I);
2130 Vals.push_back(VE.getTypeID(AI.getAllocatedType()));
Dan Gohman9da5bb02010-05-28 01:38:28 +00002131 Vals.push_back(VE.getTypeID(I.getOperand(0)->getType()));
Chris Lattner0a603252007-05-01 02:13:26 +00002132 Vals.push_back(VE.getValueID(I.getOperand(0))); // size.
Reid Kleckner56b56ea2014-07-16 01:34:27 +00002133 unsigned AlignRecord = Log2_32(AI.getAlignment()) + 1;
2134 assert(Log2_32(Value::MaximumAlignment) + 1 < 1 << 5 &&
2135 "not enough bits for maximum alignment");
2136 assert(AlignRecord < 1 << 5 && "alignment greater than 1 << 64");
2137 AlignRecord |= AI.isUsedWithInAlloca() << 5;
David Blaikiebdb49102015-04-28 16:51:01 +00002138 AlignRecord |= 1 << 6;
Bob Wilson043ee652015-07-28 04:05:45 +00002139 // Reserve bit 7 for SwiftError flag.
2140 // AlignRecord |= AI.isSwiftError() << 7;
Reid Kleckner56b56ea2014-07-16 01:34:27 +00002141 Vals.push_back(AlignRecord);
Chris Lattner0a603252007-05-01 02:13:26 +00002142 break;
Reid Kleckner56b56ea2014-07-16 01:34:27 +00002143 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002144
Chris Lattner0a603252007-05-01 02:13:26 +00002145 case Instruction::Load:
Eli Friedman59b66882011-08-09 23:02:53 +00002146 if (cast<LoadInst>(I).isAtomic()) {
2147 Code = bitc::FUNC_CODE_INST_LOADATOMIC;
2148 PushValueAndType(I.getOperand(0), InstID, Vals, VE);
2149 } else {
2150 Code = bitc::FUNC_CODE_INST_LOAD;
2151 if (!PushValueAndType(I.getOperand(0), InstID, Vals, VE)) // ptr
2152 AbbrevToUse = FUNCTION_INST_LOAD_ABBREV;
2153 }
David Blaikie85035652015-02-25 01:07:20 +00002154 Vals.push_back(VE.getTypeID(I.getType()));
Chris Lattner0a603252007-05-01 02:13:26 +00002155 Vals.push_back(Log2_32(cast<LoadInst>(I).getAlignment())+1);
2156 Vals.push_back(cast<LoadInst>(I).isVolatile());
Eli Friedman59b66882011-08-09 23:02:53 +00002157 if (cast<LoadInst>(I).isAtomic()) {
2158 Vals.push_back(GetEncodedOrdering(cast<LoadInst>(I).getOrdering()));
2159 Vals.push_back(GetEncodedSynchScope(cast<LoadInst>(I).getSynchScope()));
2160 }
Chris Lattner0a603252007-05-01 02:13:26 +00002161 break;
2162 case Instruction::Store:
Eli Friedman59b66882011-08-09 23:02:53 +00002163 if (cast<StoreInst>(I).isAtomic())
2164 Code = bitc::FUNC_CODE_INST_STOREATOMIC;
2165 else
2166 Code = bitc::FUNC_CODE_INST_STORE;
Christopher Lamb54dd24c2007-12-11 08:59:05 +00002167 PushValueAndType(I.getOperand(1), InstID, Vals, VE); // ptrty + ptr
David Blaikie612ddbf2015-04-22 04:14:42 +00002168 PushValueAndType(I.getOperand(0), InstID, Vals, VE); // valty + val
Chris Lattner0a603252007-05-01 02:13:26 +00002169 Vals.push_back(Log2_32(cast<StoreInst>(I).getAlignment())+1);
2170 Vals.push_back(cast<StoreInst>(I).isVolatile());
Eli Friedman59b66882011-08-09 23:02:53 +00002171 if (cast<StoreInst>(I).isAtomic()) {
2172 Vals.push_back(GetEncodedOrdering(cast<StoreInst>(I).getOrdering()));
2173 Vals.push_back(GetEncodedSynchScope(cast<StoreInst>(I).getSynchScope()));
2174 }
Chris Lattner0a603252007-05-01 02:13:26 +00002175 break;
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002176 case Instruction::AtomicCmpXchg:
2177 Code = bitc::FUNC_CODE_INST_CMPXCHG;
2178 PushValueAndType(I.getOperand(0), InstID, Vals, VE); // ptrty + ptr
Chris Rayb541a342016-01-19 18:01:20 +00002179 PushValueAndType(I.getOperand(1), InstID, Vals, VE); // cmp.
Jan Wen Voungafaced02012-10-11 20:20:40 +00002180 pushValue(I.getOperand(2), InstID, Vals, VE); // newval.
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002181 Vals.push_back(cast<AtomicCmpXchgInst>(I).isVolatile());
2182 Vals.push_back(GetEncodedOrdering(
Tim Northovere94a5182014-03-11 10:48:52 +00002183 cast<AtomicCmpXchgInst>(I).getSuccessOrdering()));
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002184 Vals.push_back(GetEncodedSynchScope(
2185 cast<AtomicCmpXchgInst>(I).getSynchScope()));
Tim Northovere94a5182014-03-11 10:48:52 +00002186 Vals.push_back(GetEncodedOrdering(
2187 cast<AtomicCmpXchgInst>(I).getFailureOrdering()));
Tim Northover420a2162014-06-13 14:24:07 +00002188 Vals.push_back(cast<AtomicCmpXchgInst>(I).isWeak());
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002189 break;
2190 case Instruction::AtomicRMW:
2191 Code = bitc::FUNC_CODE_INST_ATOMICRMW;
2192 PushValueAndType(I.getOperand(0), InstID, Vals, VE); // ptrty + ptr
Jan Wen Voungafaced02012-10-11 20:20:40 +00002193 pushValue(I.getOperand(1), InstID, Vals, VE); // val.
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002194 Vals.push_back(GetEncodedRMWOperation(
2195 cast<AtomicRMWInst>(I).getOperation()));
2196 Vals.push_back(cast<AtomicRMWInst>(I).isVolatile());
2197 Vals.push_back(GetEncodedOrdering(cast<AtomicRMWInst>(I).getOrdering()));
2198 Vals.push_back(GetEncodedSynchScope(
2199 cast<AtomicRMWInst>(I).getSynchScope()));
2200 break;
Eli Friedmanfee02c62011-07-25 23:16:38 +00002201 case Instruction::Fence:
2202 Code = bitc::FUNC_CODE_INST_FENCE;
2203 Vals.push_back(GetEncodedOrdering(cast<FenceInst>(I).getOrdering()));
2204 Vals.push_back(GetEncodedSynchScope(cast<FenceInst>(I).getSynchScope()));
2205 break;
Chris Lattner0a603252007-05-01 02:13:26 +00002206 case Instruction::Call: {
Gabor Greife9afee22010-06-26 09:35:09 +00002207 const CallInst &CI = cast<CallInst>(I);
David Blaikiedbe6e0f2015-04-17 06:40:14 +00002208 FunctionType *FTy = CI.getFunctionType();
Chris Lattner4c0a6d62007-05-08 05:38:01 +00002209
Sanjoy Dasb513a9f2015-09-24 23:34:52 +00002210 if (CI.hasOperandBundles())
2211 WriteOperandBundles(Stream, &CI, InstID, VE);
2212
Chris Lattnerc44070802011-06-17 18:17:37 +00002213 Code = bitc::FUNC_CODE_INST_CALL;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002214
Gabor Greife9afee22010-06-26 09:35:09 +00002215 Vals.push_back(VE.getAttributeID(CI.getAttributes()));
Sanjay Patelfa54ace2015-12-14 21:59:03 +00002216
2217 unsigned Flags = GetOptimizationFlags(&I);
Akira Hatanaka97cb3972015-11-07 02:48:49 +00002218 Vals.push_back(CI.getCallingConv() << bitc::CALL_CCONV |
2219 unsigned(CI.isTailCall()) << bitc::CALL_TAIL |
2220 unsigned(CI.isMustTailCall()) << bitc::CALL_MUSTTAIL |
2221 1 << bitc::CALL_EXPLICIT_TYPE |
Sanjay Patelfa54ace2015-12-14 21:59:03 +00002222 unsigned(CI.isNoTailCall()) << bitc::CALL_NOTAIL |
2223 unsigned(Flags != 0) << bitc::CALL_FMF);
2224 if (Flags != 0)
2225 Vals.push_back(Flags);
2226
David Blaikiedbe6e0f2015-04-17 06:40:14 +00002227 Vals.push_back(VE.getTypeID(FTy));
Gabor Greife9afee22010-06-26 09:35:09 +00002228 PushValueAndType(CI.getCalledValue(), InstID, Vals, VE); // Callee
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002229
Chris Lattner0a603252007-05-01 02:13:26 +00002230 // Emit value #'s for the fixed parameters.
Jan Wen Voungafaced02012-10-11 20:20:40 +00002231 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) {
2232 // Check for labels (can happen with asm labels).
2233 if (FTy->getParamType(i)->isLabelTy())
2234 Vals.push_back(VE.getValueID(CI.getArgOperand(i)));
2235 else
2236 pushValue(CI.getArgOperand(i), InstID, Vals, VE); // fixed param.
2237 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002238
Chris Lattnerb811e952007-05-01 07:03:37 +00002239 // Emit type/value pairs for varargs params.
2240 if (FTy->isVarArg()) {
Gabor Greife9afee22010-06-26 09:35:09 +00002241 for (unsigned i = FTy->getNumParams(), e = CI.getNumArgOperands();
Chris Lattnerdf1233d2007-05-06 00:00:00 +00002242 i != e; ++i)
Gabor Greife9afee22010-06-26 09:35:09 +00002243 PushValueAndType(CI.getArgOperand(i), InstID, Vals, VE); // varargs
Chris Lattner0a603252007-05-01 02:13:26 +00002244 }
2245 break;
Chris Lattnerb811e952007-05-01 07:03:37 +00002246 }
Chris Lattner0a603252007-05-01 02:13:26 +00002247 case Instruction::VAArg:
2248 Code = bitc::FUNC_CODE_INST_VAARG;
2249 Vals.push_back(VE.getTypeID(I.getOperand(0)->getType())); // valistty
Jan Wen Voungafaced02012-10-11 20:20:40 +00002250 pushValue(I.getOperand(0), InstID, Vals, VE); // valist.
Chris Lattner0a603252007-05-01 02:13:26 +00002251 Vals.push_back(VE.getTypeID(I.getType())); // restype.
2252 break;
Chris Lattnere6e364c2007-04-26 05:53:54 +00002253 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002254
Chris Lattnere6e364c2007-04-26 05:53:54 +00002255 Stream.EmitRecord(Code, Vals, AbbrevToUse);
2256 Vals.clear();
2257}
2258
Teresa Johnsonff642b92015-09-17 20:12:00 +00002259/// Emit names for globals/functions etc. The VSTOffsetPlaceholder,
Teresa Johnson26ab5772016-03-15 00:04:37 +00002260/// BitcodeStartBit and ModuleSummaryIndex are only passed for the module-level
Teresa Johnsonff642b92015-09-17 20:12:00 +00002261/// VST, where we are including a function bitcode index and need to
2262/// backpatch the VST forward declaration record.
2263static void WriteValueSymbolTable(
2264 const ValueSymbolTable &VST, const ValueEnumerator &VE,
2265 BitstreamWriter &Stream, uint64_t VSTOffsetPlaceholder = 0,
2266 uint64_t BitcodeStartBit = 0,
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002267 DenseMap<const Function *, std::unique_ptr<GlobalValueInfo>>
2268 *FunctionIndex = nullptr) {
Teresa Johnsonff642b92015-09-17 20:12:00 +00002269 if (VST.empty()) {
2270 // WriteValueSymbolTableForwardDecl should have returned early as
2271 // well. Ensure this handling remains in sync by asserting that
2272 // the placeholder offset is not set.
2273 assert(VSTOffsetPlaceholder == 0);
2274 return;
2275 }
2276
2277 if (VSTOffsetPlaceholder > 0) {
2278 // Get the offset of the VST we are writing, and backpatch it into
2279 // the VST forward declaration record.
2280 uint64_t VSTOffset = Stream.GetCurrentBitNo();
2281 // The BitcodeStartBit was the stream offset of the actual bitcode
2282 // (e.g. excluding any initial darwin header).
2283 VSTOffset -= BitcodeStartBit;
2284 assert((VSTOffset & 31) == 0 && "VST block not 32-bit aligned");
2285 Stream.BackpatchWord(VSTOffsetPlaceholder, VSTOffset / 32);
2286 }
2287
Chris Lattnere760d6f2007-05-05 01:26:50 +00002288 Stream.EnterSubblock(bitc::VALUE_SYMTAB_BLOCK_ID, 4);
Chris Lattner2eae59f2007-05-04 20:34:50 +00002289
Teresa Johnsonff642b92015-09-17 20:12:00 +00002290 // For the module-level VST, add abbrev Ids for the VST_CODE_FNENTRY
2291 // records, which are not used in the per-function VSTs.
2292 unsigned FnEntry8BitAbbrev;
2293 unsigned FnEntry7BitAbbrev;
2294 unsigned FnEntry6BitAbbrev;
2295 if (VSTOffsetPlaceholder > 0) {
Teresa Johnson79d4e2f2016-02-10 15:02:51 +00002296 // 8-bit fixed-width VST_CODE_FNENTRY function strings.
Teresa Johnsonff642b92015-09-17 20:12:00 +00002297 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2298 Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_FNENTRY));
Teresa Johnsonf72278f2015-11-02 18:02:11 +00002299 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // value id
2300 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // funcoffset
Teresa Johnsonff642b92015-09-17 20:12:00 +00002301 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
2302 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
2303 FnEntry8BitAbbrev = Stream.EmitAbbrev(Abbv);
2304
Teresa Johnson79d4e2f2016-02-10 15:02:51 +00002305 // 7-bit fixed width VST_CODE_FNENTRY function strings.
Teresa Johnsonff642b92015-09-17 20:12:00 +00002306 Abbv = new BitCodeAbbrev();
2307 Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_FNENTRY));
Teresa Johnsonf72278f2015-11-02 18:02:11 +00002308 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // value id
2309 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // funcoffset
Teresa Johnsonff642b92015-09-17 20:12:00 +00002310 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
2311 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7));
2312 FnEntry7BitAbbrev = Stream.EmitAbbrev(Abbv);
2313
Teresa Johnson79d4e2f2016-02-10 15:02:51 +00002314 // 6-bit char6 VST_CODE_FNENTRY function strings.
Teresa Johnsonff642b92015-09-17 20:12:00 +00002315 Abbv = new BitCodeAbbrev();
2316 Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_FNENTRY));
Teresa Johnsonf72278f2015-11-02 18:02:11 +00002317 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // value id
2318 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // funcoffset
Teresa Johnsonff642b92015-09-17 20:12:00 +00002319 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
2320 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
2321 FnEntry6BitAbbrev = Stream.EmitAbbrev(Abbv);
2322 }
2323
Chris Lattnerfb6f9402007-05-01 02:14:57 +00002324 // FIXME: Set up the abbrev, we know how many values there are!
2325 // FIXME: We know if the type names can use 7-bit ascii.
2326 SmallVector<unsigned, 64> NameVals;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002327
Yaron Keren001e2e42015-08-10 07:04:29 +00002328 for (const ValueName &Name : VST) {
Chris Lattner4d925982007-05-04 20:52:02 +00002329 // Figure out the encoding to use for the name.
Teresa Johnsonc01e4cb2015-09-17 14:37:35 +00002330 StringEncoding Bits =
2331 getStringEncoding(Name.getKeyData(), Name.getKeyLength());
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002332
Chris Lattnera0987962007-05-04 21:31:13 +00002333 unsigned AbbrevToUse = VST_ENTRY_8_ABBREV;
Teresa Johnsonff642b92015-09-17 20:12:00 +00002334 NameVals.push_back(VE.getValueID(Name.getValue()));
2335
2336 Function *F = dyn_cast<Function>(Name.getValue());
2337 if (!F) {
2338 // If value is an alias, need to get the aliased base object to
2339 // see if it is a function.
2340 auto *GA = dyn_cast<GlobalAlias>(Name.getValue());
2341 if (GA && GA->getBaseObject())
2342 F = dyn_cast<Function>(GA->getBaseObject());
2343 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002344
Teresa Johnson79d4e2f2016-02-10 15:02:51 +00002345 // VST_CODE_ENTRY: [valueid, namechar x N]
2346 // VST_CODE_FNENTRY: [valueid, funcoffset, namechar x N]
2347 // VST_CODE_BBENTRY: [bbid, namechar x N]
Chris Lattner6be58c62007-05-03 22:18:21 +00002348 unsigned Code;
Yaron Keren001e2e42015-08-10 07:04:29 +00002349 if (isa<BasicBlock>(Name.getValue())) {
Bill Wendling35a9c3c2011-04-10 23:18:04 +00002350 Code = bitc::VST_CODE_BBENTRY;
Teresa Johnsonc01e4cb2015-09-17 14:37:35 +00002351 if (Bits == SE_Char6)
Bill Wendling35a9c3c2011-04-10 23:18:04 +00002352 AbbrevToUse = VST_BBENTRY_6_ABBREV;
Teresa Johnsonff642b92015-09-17 20:12:00 +00002353 } else if (F && !F->isDeclaration()) {
2354 // Must be the module-level VST, where we pass in the Index and
2355 // have a VSTOffsetPlaceholder. The function-level VST should not
2356 // contain any Function symbols.
2357 assert(FunctionIndex);
2358 assert(VSTOffsetPlaceholder > 0);
2359
2360 // Save the word offset of the function (from the start of the
2361 // actual bitcode written to the stream).
Teresa Johnson403a7872015-10-04 14:33:43 +00002362 uint64_t BitcodeIndex =
2363 (*FunctionIndex)[F]->bitcodeIndex() - BitcodeStartBit;
Teresa Johnsonff642b92015-09-17 20:12:00 +00002364 assert((BitcodeIndex & 31) == 0 && "function block not 32-bit aligned");
2365 NameVals.push_back(BitcodeIndex / 32);
2366
2367 Code = bitc::VST_CODE_FNENTRY;
2368 AbbrevToUse = FnEntry8BitAbbrev;
2369 if (Bits == SE_Char6)
2370 AbbrevToUse = FnEntry6BitAbbrev;
2371 else if (Bits == SE_Fixed7)
2372 AbbrevToUse = FnEntry7BitAbbrev;
Chris Lattner6be58c62007-05-03 22:18:21 +00002373 } else {
2374 Code = bitc::VST_CODE_ENTRY;
Teresa Johnsonc01e4cb2015-09-17 14:37:35 +00002375 if (Bits == SE_Char6)
Chris Lattnere760d6f2007-05-05 01:26:50 +00002376 AbbrevToUse = VST_ENTRY_6_ABBREV;
Teresa Johnsonc01e4cb2015-09-17 14:37:35 +00002377 else if (Bits == SE_Fixed7)
Chris Lattnere760d6f2007-05-05 01:26:50 +00002378 AbbrevToUse = VST_ENTRY_7_ABBREV;
Chris Lattner6be58c62007-05-03 22:18:21 +00002379 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002380
Teresa Johnsonf72278f2015-11-02 18:02:11 +00002381 for (const auto P : Name.getKey())
2382 NameVals.push_back((unsigned char)P);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002383
Chris Lattnerfb6f9402007-05-01 02:14:57 +00002384 // Emit the finished record.
Chris Lattner6be58c62007-05-03 22:18:21 +00002385 Stream.EmitRecord(Code, NameVals, AbbrevToUse);
Chris Lattnerfb6f9402007-05-01 02:14:57 +00002386 NameVals.clear();
2387 }
2388 Stream.ExitBlock();
2389}
2390
Teresa Johnson403a7872015-10-04 14:33:43 +00002391/// Emit function names and summary offsets for the combined index
2392/// used by ThinLTO.
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002393static void
Teresa Johnson26ab5772016-03-15 00:04:37 +00002394WriteCombinedValueSymbolTable(const ModuleSummaryIndex &Index,
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002395 BitstreamWriter &Stream,
2396 std::map<uint64_t, unsigned> &GUIDToValueIdMap,
2397 uint64_t VSTOffsetPlaceholder) {
2398 assert(VSTOffsetPlaceholder > 0 && "Expected non-zero VSTOffsetPlaceholder");
2399 // Get the offset of the VST we are writing, and backpatch it into
2400 // the VST forward declaration record.
2401 uint64_t VSTOffset = Stream.GetCurrentBitNo();
2402 assert((VSTOffset & 31) == 0 && "VST block not 32-bit aligned");
2403 Stream.BackpatchWord(VSTOffsetPlaceholder, VSTOffset / 32);
2404
Teresa Johnson403a7872015-10-04 14:33:43 +00002405 Stream.EnterSubblock(bitc::VALUE_SYMTAB_BLOCK_ID, 4);
2406
Teresa Johnson403a7872015-10-04 14:33:43 +00002407 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002408 Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_COMBINED_GVDEFENTRY));
2409 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // valueid
2410 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // sumoffset
2411 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // guid
2412 unsigned DefEntryAbbrev = Stream.EmitAbbrev(Abbv);
2413
2414 Abbv = new BitCodeAbbrev();
2415 Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_COMBINED_ENTRY));
2416 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // valueid
2417 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // refguid
2418 unsigned EntryAbbrev = Stream.EmitAbbrev(Abbv);
Teresa Johnson403a7872015-10-04 14:33:43 +00002419
Teresa Johnsone1164de2016-02-10 21:55:02 +00002420 SmallVector<uint64_t, 64> NameVals;
Teresa Johnson403a7872015-10-04 14:33:43 +00002421
Teresa Johnson3da931f2015-10-19 19:06:06 +00002422 for (const auto &FII : Index) {
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002423 uint64_t FuncGUID = FII.first;
2424 const auto &VMI = GUIDToValueIdMap.find(FuncGUID);
2425 assert(VMI != GUIDToValueIdMap.end());
2426
Teresa Johnsone1164de2016-02-10 21:55:02 +00002427 for (const auto &FI : FII.second) {
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002428 // VST_CODE_COMBINED_GVDEFENTRY: [valueid, sumoffset, guid]
2429 NameVals.push_back(VMI->second);
Teresa Johnson403a7872015-10-04 14:33:43 +00002430 NameVals.push_back(FI->bitcodeIndex());
Teresa Johnsone1164de2016-02-10 21:55:02 +00002431 NameVals.push_back(FuncGUID);
Teresa Johnson403a7872015-10-04 14:33:43 +00002432
2433 // Emit the finished record.
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002434 Stream.EmitRecord(bitc::VST_CODE_COMBINED_GVDEFENTRY, NameVals,
2435 DefEntryAbbrev);
Teresa Johnson403a7872015-10-04 14:33:43 +00002436 NameVals.clear();
2437 }
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002438 GUIDToValueIdMap.erase(VMI);
2439 }
2440 for (const auto &GVI : GUIDToValueIdMap) {
2441 // VST_CODE_COMBINED_ENTRY: [valueid, refguid]
2442 NameVals.push_back(GVI.second);
2443 NameVals.push_back(GVI.first);
2444
2445 // Emit the finished record.
2446 Stream.EmitRecord(bitc::VST_CODE_COMBINED_ENTRY, NameVals, EntryAbbrev);
2447 NameVals.clear();
Teresa Johnson403a7872015-10-04 14:33:43 +00002448 }
2449 Stream.ExitBlock();
2450}
2451
Duncan P. N. Exon Smith1f66c852014-07-28 21:19:41 +00002452static void WriteUseList(ValueEnumerator &VE, UseListOrder &&Order,
2453 BitstreamWriter &Stream) {
2454 assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
2455 unsigned Code;
2456 if (isa<BasicBlock>(Order.V))
2457 Code = bitc::USELIST_CODE_BB;
2458 else
2459 Code = bitc::USELIST_CODE_DEFAULT;
2460
Benjamin Kramer6cd780f2015-02-17 15:29:18 +00002461 SmallVector<uint64_t, 64> Record(Order.Shuffle.begin(), Order.Shuffle.end());
Duncan P. N. Exon Smith1f66c852014-07-28 21:19:41 +00002462 Record.push_back(VE.getValueID(Order.V));
2463 Stream.EmitRecord(Code, Record);
2464}
2465
2466static void WriteUseListBlock(const Function *F, ValueEnumerator &VE,
2467 BitstreamWriter &Stream) {
Duncan P. N. Exon Smith458593a2015-04-14 23:45:11 +00002468 assert(VE.shouldPreserveUseListOrder() &&
2469 "Expected to be preserving use-list order");
2470
Duncan P. N. Exon Smith1f66c852014-07-28 21:19:41 +00002471 auto hasMore = [&]() {
2472 return !VE.UseListOrders.empty() && VE.UseListOrders.back().F == F;
2473 };
2474 if (!hasMore())
2475 // Nothing to do.
2476 return;
2477
2478 Stream.EnterSubblock(bitc::USELIST_BLOCK_ID, 3);
2479 while (hasMore()) {
2480 WriteUseList(VE, std::move(VE.UseListOrders.back()), Stream);
2481 VE.UseListOrders.pop_back();
2482 }
2483 Stream.ExitBlock();
2484}
2485
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002486// Walk through the operands of a given User via worklist iteration and populate
2487// the set of GlobalValue references encountered. Invoked either on an
2488// Instruction or a GlobalVariable (which walks its initializer).
2489static void findRefEdges(const User *CurUser, const ValueEnumerator &VE,
2490 DenseSet<unsigned> &RefEdges,
2491 SmallPtrSet<const User *, 8> &Visited) {
2492 SmallVector<const User *, 32> Worklist;
2493 Worklist.push_back(CurUser);
2494
2495 while (!Worklist.empty()) {
2496 const User *U = Worklist.pop_back_val();
2497
2498 if (!Visited.insert(U).second)
2499 continue;
2500
2501 ImmutableCallSite CS(U);
2502
2503 for (const auto &OI : U->operands()) {
2504 const User *Operand = dyn_cast<User>(OI);
2505 if (!Operand)
2506 continue;
2507 if (isa<BlockAddress>(Operand))
2508 continue;
2509 if (isa<GlobalValue>(Operand)) {
2510 // We have a reference to a global value. This should be added to
2511 // the reference set unless it is a callee. Callees are handled
2512 // specially by WriteFunction and are added to a separate list.
2513 if (!(CS && CS.isCallee(&OI)))
2514 RefEdges.insert(VE.getValueID(Operand));
2515 continue;
2516 }
2517 Worklist.push_back(Operand);
2518 }
Teresa Johnson403a7872015-10-04 14:33:43 +00002519 }
Teresa Johnson403a7872015-10-04 14:33:43 +00002520}
2521
2522/// Emit a function body to the module stream.
2523static void WriteFunction(
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002524 const Function &F, const Module *M, ValueEnumerator &VE,
2525 BitstreamWriter &Stream,
2526 DenseMap<const Function *, std::unique_ptr<GlobalValueInfo>> &FunctionIndex,
2527 bool EmitSummaryIndex) {
Teresa Johnsonff642b92015-09-17 20:12:00 +00002528 // Save the bitcode index of the start of this function block for recording
2529 // in the VST.
2530 uint64_t BitcodeIndex = Stream.GetCurrentBitNo();
Teresa Johnsonff642b92015-09-17 20:12:00 +00002531
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002532 bool HasProfileData = F.getEntryCount().hasValue();
2533 std::unique_ptr<BlockFrequencyInfo> BFI;
2534 if (EmitSummaryIndex && HasProfileData) {
2535 Function &Func = const_cast<Function &>(F);
2536 LoopInfo LI{DominatorTree(Func)};
2537 BranchProbabilityInfo BPI{Func, LI};
2538 BFI = llvm::make_unique<BlockFrequencyInfo>(Func, BPI, LI);
2539 }
2540
Chris Lattnerc67e6d92007-05-06 02:38:57 +00002541 Stream.EnterSubblock(bitc::FUNCTION_BLOCK_ID, 4);
Chad Rosier6a11b642011-06-03 17:02:19 +00002542 VE.incorporateFunction(F);
Chris Lattnere6e364c2007-04-26 05:53:54 +00002543
2544 SmallVector<unsigned, 64> Vals;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002545
Chris Lattnere6e364c2007-04-26 05:53:54 +00002546 // Emit the number of basic blocks, so the reader can create them ahead of
2547 // time.
2548 Vals.push_back(VE.getBasicBlocks().size());
2549 Stream.EmitRecord(bitc::FUNC_CODE_DECLAREBLOCKS, Vals);
2550 Vals.clear();
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002551
Chris Lattnere6e364c2007-04-26 05:53:54 +00002552 // If there are function-local constants, emit them now.
2553 unsigned CstStart, CstEnd;
2554 VE.getFunctionConstantRange(CstStart, CstEnd);
Devang Patel8cca7b42009-08-04 05:01:35 +00002555 WriteConstants(CstStart, CstEnd, VE, Stream, false);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002556
Victor Hernandez6c730de2010-01-14 01:50:08 +00002557 // If there is function-local metadata, emit it now.
Victor Hernandez36aee302010-01-14 19:38:44 +00002558 WriteFunctionLocalMetadata(F, VE, Stream);
Victor Hernandez6c730de2010-01-14 01:50:08 +00002559
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002560 // Keep a running idea of what the instruction ID is.
Chris Lattnerdf1233d2007-05-06 00:00:00 +00002561 unsigned InstID = CstEnd;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002562
Duncan P. N. Exon Smith3d4cd752015-04-24 22:04:41 +00002563 bool NeedsMetadataAttachment = F.hasMetadata();
Michael Ilseman26ee2b82012-11-15 22:34:00 +00002564
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00002565 DILocation *LastDL = nullptr;
Teresa Johnson403a7872015-10-04 14:33:43 +00002566 unsigned NumInsts = 0;
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002567 // Map from callee ValueId to profile count. Used to accumulate profile
2568 // counts for all static calls to a given callee.
2569 DenseMap<unsigned, CalleeInfo> CallGraphEdges;
2570 DenseSet<unsigned> RefEdges;
Michael Ilseman26ee2b82012-11-15 22:34:00 +00002571
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002572 SmallPtrSet<const User *, 8> Visited;
Chris Lattnere6e364c2007-04-26 05:53:54 +00002573 // Finally, emit all the instructions, in order.
Nick Lewycky4d43d3c2008-04-25 16:53:59 +00002574 for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
Chris Lattnerdf1233d2007-05-06 00:00:00 +00002575 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end();
2576 I != E; ++I) {
2577 WriteInstruction(*I, InstID, VE, Stream, Vals);
Michael Ilseman26ee2b82012-11-15 22:34:00 +00002578
Teresa Johnsonf72278f2015-11-02 18:02:11 +00002579 if (!isa<DbgInfoIntrinsic>(I))
2580 ++NumInsts;
Teresa Johnson403a7872015-10-04 14:33:43 +00002581
Chris Lattner2f2aa2b2009-12-28 23:41:32 +00002582 if (!I->getType()->isVoidTy())
Chris Lattnerdf1233d2007-05-06 00:00:00 +00002583 ++InstID;
Michael Ilseman26ee2b82012-11-15 22:34:00 +00002584
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002585 if (EmitSummaryIndex) {
2586 if (auto CS = ImmutableCallSite(&*I)) {
2587 auto *CalledFunction = CS.getCalledFunction();
2588 if (CalledFunction && CalledFunction->hasName() &&
2589 !CalledFunction->isIntrinsic()) {
Easwaran Raman12b79aa2016-03-23 18:18:26 +00002590 auto ScaledCount = BFI ? BFI->getBlockProfileCount(&*BB) : None;
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002591 unsigned CalleeId = VE.getValueID(
2592 M->getValueSymbolTable().lookup(CalledFunction->getName()));
Easwaran Raman12b79aa2016-03-23 18:18:26 +00002593 CallGraphEdges[CalleeId] +=
2594 (ScaledCount ? ScaledCount.getValue() : 0);
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002595 }
2596 }
2597 findRefEdges(&*I, VE, RefEdges, Visited);
2598 }
2599
Chris Lattner07d09ed2010-04-03 02:17:50 +00002600 // If the instruction has metadata, write a metadata attachment later.
2601 NeedsMetadataAttachment |= I->hasMetadataOtherThanDebugLoc();
Michael Ilseman26ee2b82012-11-15 22:34:00 +00002602
Chris Lattner07d09ed2010-04-03 02:17:50 +00002603 // If the instruction has a debug location, emit it.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00002604 DILocation *DL = I->getDebugLoc();
Duncan P. N. Exon Smithab659fb32015-03-30 19:40:05 +00002605 if (!DL)
Duncan P. N. Exon Smith1facf7a2015-03-30 18:29:18 +00002606 continue;
Duncan P. N. Exon Smith1facf7a2015-03-30 18:29:18 +00002607
2608 if (DL == LastDL) {
Chris Lattner07d09ed2010-04-03 02:17:50 +00002609 // Just repeat the same debug loc as last time.
2610 Stream.EmitRecord(bitc::FUNC_CODE_DEBUG_LOC_AGAIN, Vals);
Duncan P. N. Exon Smith1facf7a2015-03-30 18:29:18 +00002611 continue;
Chris Lattner07d09ed2010-04-03 02:17:50 +00002612 }
Duncan P. N. Exon Smith1facf7a2015-03-30 18:29:18 +00002613
Duncan P. N. Exon Smithab659fb32015-03-30 19:40:05 +00002614 Vals.push_back(DL->getLine());
2615 Vals.push_back(DL->getColumn());
2616 Vals.push_back(VE.getMetadataOrNullID(DL->getScope()));
2617 Vals.push_back(VE.getMetadataOrNullID(DL->getInlinedAt()));
Duncan P. N. Exon Smith1facf7a2015-03-30 18:29:18 +00002618 Stream.EmitRecord(bitc::FUNC_CODE_DEBUG_LOC, Vals);
2619 Vals.clear();
Duncan P. N. Exon Smith538ef562015-05-06 22:51:12 +00002620
2621 LastDL = DL;
Chris Lattnerdf1233d2007-05-06 00:00:00 +00002622 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002623
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002624 std::unique_ptr<FunctionSummary> FuncSummary;
2625 if (EmitSummaryIndex) {
2626 FuncSummary = llvm::make_unique<FunctionSummary>(F.getLinkage(), NumInsts);
2627 FuncSummary->addCallGraphEdges(CallGraphEdges);
2628 FuncSummary->addRefEdges(RefEdges);
2629 }
2630 FunctionIndex[&F] =
2631 llvm::make_unique<GlobalValueInfo>(BitcodeIndex, std::move(FuncSummary));
2632
Chris Lattnerfb6f9402007-05-01 02:14:57 +00002633 // Emit names for all the instructions etc.
2634 WriteValueSymbolTable(F.getValueSymbolTable(), VE, Stream);
Devang Patelaf206b82009-09-18 19:26:43 +00002635
Chris Lattner07d09ed2010-04-03 02:17:50 +00002636 if (NeedsMetadataAttachment)
2637 WriteMetadataAttachment(F, VE, Stream);
Duncan P. N. Exon Smith458593a2015-04-14 23:45:11 +00002638 if (VE.shouldPreserveUseListOrder())
Duncan P. N. Exon Smith1f66c852014-07-28 21:19:41 +00002639 WriteUseListBlock(&F, VE, Stream);
Chad Rosier6a11b642011-06-03 17:02:19 +00002640 VE.purgeFunction();
Chris Lattnere6e364c2007-04-26 05:53:54 +00002641 Stream.ExitBlock();
Chris Lattner831d4202007-04-26 03:27:58 +00002642}
2643
Chris Lattner702658c2007-05-04 18:26:27 +00002644// Emit blockinfo, which defines the standard abbreviations etc.
Chris Lattnerda5e5d22007-05-05 07:36:14 +00002645static void WriteBlockInfo(const ValueEnumerator &VE, BitstreamWriter &Stream) {
Chris Lattner702658c2007-05-04 18:26:27 +00002646 // We only want to emit block info records for blocks that have multiple
Jan Wen Voungafaced02012-10-11 20:20:40 +00002647 // instances: CONSTANTS_BLOCK, FUNCTION_BLOCK and VALUE_SYMTAB_BLOCK.
Jan Wen Voung8c9e9412012-10-11 21:45:16 +00002648 // Other blocks can define their abbrevs inline.
Chris Lattner982ec1e2007-05-05 00:17:00 +00002649 Stream.EnterBlockInfoBlock(2);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002650
Teresa Johnson79d4e2f2016-02-10 15:02:51 +00002651 { // 8-bit fixed-width VST_CODE_ENTRY/VST_CODE_BBENTRY strings.
Chris Lattner982ec1e2007-05-05 00:17:00 +00002652 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2653 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3));
2654 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
2655 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
2656 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002657 if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
Chris Lattner982ec1e2007-05-05 00:17:00 +00002658 Abbv) != VST_ENTRY_8_ABBREV)
Torok Edwinfbcc6632009-07-14 16:55:14 +00002659 llvm_unreachable("Unexpected abbrev ordering!");
Chris Lattner982ec1e2007-05-05 00:17:00 +00002660 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002661
Teresa Johnson79d4e2f2016-02-10 15:02:51 +00002662 { // 7-bit fixed width VST_CODE_ENTRY strings.
Chris Lattner982ec1e2007-05-05 00:17:00 +00002663 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2664 Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_ENTRY));
2665 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
2666 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
2667 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7));
2668 if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
2669 Abbv) != VST_ENTRY_7_ABBREV)
Torok Edwinfbcc6632009-07-14 16:55:14 +00002670 llvm_unreachable("Unexpected abbrev ordering!");
Chris Lattner982ec1e2007-05-05 00:17:00 +00002671 }
Teresa Johnson79d4e2f2016-02-10 15:02:51 +00002672 { // 6-bit char6 VST_CODE_ENTRY strings.
Chris Lattnere760d6f2007-05-05 01:26:50 +00002673 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2674 Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_ENTRY));
2675 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
2676 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
2677 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
2678 if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
2679 Abbv) != VST_ENTRY_6_ABBREV)
Torok Edwinfbcc6632009-07-14 16:55:14 +00002680 llvm_unreachable("Unexpected abbrev ordering!");
Chris Lattnere760d6f2007-05-05 01:26:50 +00002681 }
Teresa Johnson79d4e2f2016-02-10 15:02:51 +00002682 { // 6-bit char6 VST_CODE_BBENTRY strings.
Chris Lattner982ec1e2007-05-05 00:17:00 +00002683 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2684 Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_BBENTRY));
2685 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
2686 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
Chris Lattnere760d6f2007-05-05 01:26:50 +00002687 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
Chris Lattner982ec1e2007-05-05 00:17:00 +00002688 if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
Chris Lattnere760d6f2007-05-05 01:26:50 +00002689 Abbv) != VST_BBENTRY_6_ABBREV)
Torok Edwinfbcc6632009-07-14 16:55:14 +00002690 llvm_unreachable("Unexpected abbrev ordering!");
Chris Lattner982ec1e2007-05-05 00:17:00 +00002691 }
Bill Wendling35a9c3c2011-04-10 23:18:04 +00002692
2693
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002694
Chris Lattnerda5e5d22007-05-05 07:36:14 +00002695 { // SETTYPE abbrev for CONSTANTS_BLOCK.
2696 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2697 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_SETTYPE));
2698 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
David Blaikie7b028102015-02-25 00:51:52 +00002699 VE.computeBitsRequiredForTypeIndicies()));
Chris Lattnerda5e5d22007-05-05 07:36:14 +00002700 if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
2701 Abbv) != CONSTANTS_SETTYPE_ABBREV)
Torok Edwinfbcc6632009-07-14 16:55:14 +00002702 llvm_unreachable("Unexpected abbrev ordering!");
Chris Lattnerda5e5d22007-05-05 07:36:14 +00002703 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002704
Chris Lattnerda5e5d22007-05-05 07:36:14 +00002705 { // INTEGER abbrev for CONSTANTS_BLOCK.
2706 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2707 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_INTEGER));
2708 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
2709 if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
2710 Abbv) != CONSTANTS_INTEGER_ABBREV)
Torok Edwinfbcc6632009-07-14 16:55:14 +00002711 llvm_unreachable("Unexpected abbrev ordering!");
Chris Lattnerda5e5d22007-05-05 07:36:14 +00002712 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002713
Chris Lattnerda5e5d22007-05-05 07:36:14 +00002714 { // CE_CAST abbrev for CONSTANTS_BLOCK.
2715 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2716 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_CE_CAST));
2717 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // cast opc
2718 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, // typeid
David Blaikie7b028102015-02-25 00:51:52 +00002719 VE.computeBitsRequiredForTypeIndicies()));
Chris Lattnerda5e5d22007-05-05 07:36:14 +00002720 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // value id
2721
2722 if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
2723 Abbv) != CONSTANTS_CE_CAST_Abbrev)
Torok Edwinfbcc6632009-07-14 16:55:14 +00002724 llvm_unreachable("Unexpected abbrev ordering!");
Chris Lattnerda5e5d22007-05-05 07:36:14 +00002725 }
2726 { // NULL abbrev for CONSTANTS_BLOCK.
2727 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2728 Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_NULL));
2729 if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
2730 Abbv) != CONSTANTS_NULL_Abbrev)
Torok Edwinfbcc6632009-07-14 16:55:14 +00002731 llvm_unreachable("Unexpected abbrev ordering!");
Chris Lattnerda5e5d22007-05-05 07:36:14 +00002732 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002733
Chris Lattnerb80751d2007-05-05 07:44:49 +00002734 // FIXME: This should only use space for first class types!
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002735
Chris Lattnerb80751d2007-05-05 07:44:49 +00002736 { // INST_LOAD abbrev for FUNCTION_BLOCK.
2737 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2738 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_LOAD));
Chris Lattnerb80751d2007-05-05 07:44:49 +00002739 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Ptr
David Blaikie85035652015-02-25 01:07:20 +00002740 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, // dest ty
2741 VE.computeBitsRequiredForTypeIndicies()));
Chris Lattnerb80751d2007-05-05 07:44:49 +00002742 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // Align
2743 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // volatile
2744 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
2745 Abbv) != FUNCTION_INST_LOAD_ABBREV)
Torok Edwinfbcc6632009-07-14 16:55:14 +00002746 llvm_unreachable("Unexpected abbrev ordering!");
Chris Lattnerb80751d2007-05-05 07:44:49 +00002747 }
Chris Lattnerc67e6d92007-05-06 02:38:57 +00002748 { // INST_BINOP abbrev for FUNCTION_BLOCK.
2749 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2750 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_BINOP));
2751 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LHS
2752 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // RHS
2753 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // opc
2754 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
2755 Abbv) != FUNCTION_INST_BINOP_ABBREV)
Torok Edwinfbcc6632009-07-14 16:55:14 +00002756 llvm_unreachable("Unexpected abbrev ordering!");
Chris Lattnerc67e6d92007-05-06 02:38:57 +00002757 }
Dan Gohman0ebd6962009-07-20 21:19:07 +00002758 { // INST_BINOP_FLAGS abbrev for FUNCTION_BLOCK.
2759 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2760 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_BINOP));
2761 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LHS
2762 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // RHS
2763 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // opc
2764 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7)); // flags
2765 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
2766 Abbv) != FUNCTION_INST_BINOP_FLAGS_ABBREV)
2767 llvm_unreachable("Unexpected abbrev ordering!");
2768 }
Chris Lattnerc67e6d92007-05-06 02:38:57 +00002769 { // INST_CAST abbrev for FUNCTION_BLOCK.
2770 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2771 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_CAST));
2772 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // OpVal
2773 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, // dest ty
David Blaikie7b028102015-02-25 00:51:52 +00002774 VE.computeBitsRequiredForTypeIndicies()));
Chris Lattnerc67e6d92007-05-06 02:38:57 +00002775 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // opc
2776 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
2777 Abbv) != FUNCTION_INST_CAST_ABBREV)
Torok Edwinfbcc6632009-07-14 16:55:14 +00002778 llvm_unreachable("Unexpected abbrev ordering!");
Chris Lattnerc67e6d92007-05-06 02:38:57 +00002779 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002780
Chris Lattnercc6d4c92007-05-06 01:28:01 +00002781 { // INST_RET abbrev for FUNCTION_BLOCK.
2782 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2783 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_RET));
2784 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
2785 Abbv) != FUNCTION_INST_RET_VOID_ABBREV)
Torok Edwinfbcc6632009-07-14 16:55:14 +00002786 llvm_unreachable("Unexpected abbrev ordering!");
Chris Lattnercc6d4c92007-05-06 01:28:01 +00002787 }
2788 { // INST_RET abbrev for FUNCTION_BLOCK.
2789 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2790 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_RET));
2791 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ValID
2792 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
2793 Abbv) != FUNCTION_INST_RET_VAL_ABBREV)
Torok Edwinfbcc6632009-07-14 16:55:14 +00002794 llvm_unreachable("Unexpected abbrev ordering!");
Chris Lattnercc6d4c92007-05-06 01:28:01 +00002795 }
2796 { // INST_UNREACHABLE abbrev for FUNCTION_BLOCK.
2797 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2798 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_UNREACHABLE));
2799 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
2800 Abbv) != FUNCTION_INST_UNREACHABLE_ABBREV)
Torok Edwinfbcc6632009-07-14 16:55:14 +00002801 llvm_unreachable("Unexpected abbrev ordering!");
Chris Lattnercc6d4c92007-05-06 01:28:01 +00002802 }
David Blaikieb5b5efd2015-02-25 01:08:52 +00002803 {
2804 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2805 Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_GEP));
2806 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));
2807 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, // dest ty
2808 Log2_32_Ceil(VE.getTypes().size() + 1)));
2809 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
2810 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
2811 if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID, Abbv) !=
2812 FUNCTION_INST_GEP_ABBREV)
2813 llvm_unreachable("Unexpected abbrev ordering!");
2814 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002815
Chris Lattnerda5e5d22007-05-05 07:36:14 +00002816 Stream.ExitBlock();
2817}
2818
Teresa Johnson403a7872015-10-04 14:33:43 +00002819/// Write the module path strings, currently only used when generating
2820/// a combined index file.
Teresa Johnson26ab5772016-03-15 00:04:37 +00002821static void WriteModStrings(const ModuleSummaryIndex &I,
Teresa Johnson403a7872015-10-04 14:33:43 +00002822 BitstreamWriter &Stream) {
2823 Stream.EnterSubblock(bitc::MODULE_STRTAB_BLOCK_ID, 3);
2824
2825 // TODO: See which abbrev sizes we actually need to emit
2826
2827 // 8-bit fixed-width MST_ENTRY strings.
2828 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2829 Abbv->Add(BitCodeAbbrevOp(bitc::MST_CODE_ENTRY));
2830 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
2831 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
2832 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
2833 unsigned Abbrev8Bit = Stream.EmitAbbrev(Abbv);
2834
2835 // 7-bit fixed width MST_ENTRY strings.
2836 Abbv = new BitCodeAbbrev();
2837 Abbv->Add(BitCodeAbbrevOp(bitc::MST_CODE_ENTRY));
2838 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
2839 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
2840 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7));
2841 unsigned Abbrev7Bit = Stream.EmitAbbrev(Abbv);
2842
2843 // 6-bit char6 MST_ENTRY strings.
2844 Abbv = new BitCodeAbbrev();
2845 Abbv->Add(BitCodeAbbrevOp(bitc::MST_CODE_ENTRY));
2846 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
2847 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
2848 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
2849 unsigned Abbrev6Bit = Stream.EmitAbbrev(Abbv);
2850
2851 SmallVector<unsigned, 64> NameVals;
Mehdi Amini385cf282016-03-26 03:35:38 +00002852 for (const StringMapEntry<uint64_t> &MPSE : I.modulePaths()) {
Teresa Johnson403a7872015-10-04 14:33:43 +00002853 StringEncoding Bits =
2854 getStringEncoding(MPSE.getKey().data(), MPSE.getKey().size());
2855 unsigned AbbrevToUse = Abbrev8Bit;
2856 if (Bits == SE_Char6)
2857 AbbrevToUse = Abbrev6Bit;
2858 else if (Bits == SE_Fixed7)
2859 AbbrevToUse = Abbrev7Bit;
2860
2861 NameVals.push_back(MPSE.getValue());
2862
Teresa Johnsonf72278f2015-11-02 18:02:11 +00002863 for (const auto P : MPSE.getKey())
2864 NameVals.push_back((unsigned char)P);
Teresa Johnson403a7872015-10-04 14:33:43 +00002865
2866 // Emit the finished record.
2867 Stream.EmitRecord(bitc::MST_CODE_ENTRY, NameVals, AbbrevToUse);
2868 NameVals.clear();
2869 }
2870 Stream.ExitBlock();
2871}
2872
2873// Helper to emit a single function summary record.
2874static void WritePerModuleFunctionSummaryRecord(
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002875 SmallVector<uint64_t, 64> &NameVals, FunctionSummary *FS, unsigned ValueID,
2876 unsigned FSCallsAbbrev, unsigned FSCallsProfileAbbrev,
2877 BitstreamWriter &Stream, const Function &F) {
Teresa Johnson403a7872015-10-04 14:33:43 +00002878 assert(FS);
2879 NameVals.push_back(ValueID);
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002880 NameVals.push_back(getEncodedLinkage(FS->linkage()));
Teresa Johnson403a7872015-10-04 14:33:43 +00002881 NameVals.push_back(FS->instCount());
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002882 NameVals.push_back(FS->refs().size());
2883
2884 for (auto &RI : FS->refs())
2885 NameVals.push_back(RI);
2886
2887 bool HasProfileData = F.getEntryCount().hasValue();
Teresa Johnsonaae26102016-03-25 18:59:13 +00002888 for (auto &ECI : FS->calls()) {
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002889 NameVals.push_back(ECI.first);
2890 assert(ECI.second.CallsiteCount > 0 && "Expected at least one callsite");
2891 NameVals.push_back(ECI.second.CallsiteCount);
2892 if (HasProfileData)
2893 NameVals.push_back(ECI.second.ProfileCount);
2894 }
2895
2896 unsigned FSAbbrev = (HasProfileData ? FSCallsProfileAbbrev : FSCallsAbbrev);
2897 unsigned Code =
2898 (HasProfileData ? bitc::FS_PERMODULE_PROFILE : bitc::FS_PERMODULE);
Teresa Johnson403a7872015-10-04 14:33:43 +00002899
2900 // Emit the finished record.
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002901 Stream.EmitRecord(Code, NameVals, FSAbbrev);
Teresa Johnson403a7872015-10-04 14:33:43 +00002902 NameVals.clear();
2903}
2904
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002905// Collect the global value references in the given variable's initializer,
2906// and emit them in a summary record.
2907static void WriteModuleLevelReferences(const GlobalVariable &V,
2908 const ValueEnumerator &VE,
2909 SmallVector<uint64_t, 64> &NameVals,
2910 unsigned FSModRefsAbbrev,
2911 BitstreamWriter &Stream) {
Teresa Johnson13968092016-03-15 19:35:45 +00002912 // Only interested in recording variable defs in the summary.
2913 if (V.isDeclaration())
2914 return;
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002915 DenseSet<unsigned> RefEdges;
2916 SmallPtrSet<const User *, 8> Visited;
2917 findRefEdges(&V, VE, RefEdges, Visited);
Teresa Johnson13968092016-03-15 19:35:45 +00002918 NameVals.push_back(VE.getValueID(&V));
2919 NameVals.push_back(getEncodedLinkage(V.getLinkage()));
2920 for (auto RefId : RefEdges) {
2921 NameVals.push_back(RefId);
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002922 }
Teresa Johnson13968092016-03-15 19:35:45 +00002923 Stream.EmitRecord(bitc::FS_PERMODULE_GLOBALVAR_INIT_REFS, NameVals,
2924 FSModRefsAbbrev);
2925 NameVals.clear();
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002926}
Teresa Johnson403a7872015-10-04 14:33:43 +00002927
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002928/// Emit the per-module summary section alongside the rest of
2929/// the module's bitcode.
2930static void WritePerModuleGlobalValueSummary(
2931 DenseMap<const Function *, std::unique_ptr<GlobalValueInfo>> &FunctionIndex,
2932 const Module *M, const ValueEnumerator &VE, BitstreamWriter &Stream) {
2933 if (M->empty())
2934 return;
2935
2936 Stream.EnterSubblock(bitc::GLOBALVAL_SUMMARY_BLOCK_ID, 3);
2937
2938 // Abbrev for FS_PERMODULE.
Teresa Johnson403a7872015-10-04 14:33:43 +00002939 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002940 Abbv->Add(BitCodeAbbrevOp(bitc::FS_PERMODULE));
Teresa Johnsonf72278f2015-11-02 18:02:11 +00002941 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // valueid
Teresa Johnson5e22e442016-02-06 16:07:35 +00002942 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 5)); // linkage
Teresa Johnsonf72278f2015-11-02 18:02:11 +00002943 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // instcount
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002944 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // numrefs
2945 // numrefs x valueid, n x (valueid, callsitecount)
2946 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
2947 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
2948 unsigned FSCallsAbbrev = Stream.EmitAbbrev(Abbv);
Teresa Johnson403a7872015-10-04 14:33:43 +00002949
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002950 // Abbrev for FS_PERMODULE_PROFILE.
2951 Abbv = new BitCodeAbbrev();
2952 Abbv->Add(BitCodeAbbrevOp(bitc::FS_PERMODULE_PROFILE));
2953 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // valueid
2954 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 5)); // linkage
2955 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // instcount
2956 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // numrefs
2957 // numrefs x valueid, n x (valueid, callsitecount, profilecount)
2958 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
2959 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
2960 unsigned FSCallsProfileAbbrev = Stream.EmitAbbrev(Abbv);
2961
2962 // Abbrev for FS_PERMODULE_GLOBALVAR_INIT_REFS.
2963 Abbv = new BitCodeAbbrev();
2964 Abbv->Add(BitCodeAbbrevOp(bitc::FS_PERMODULE_GLOBALVAR_INIT_REFS));
2965 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // valueid
2966 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 5)); // linkage
2967 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); // valueids
2968 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
2969 unsigned FSModRefsAbbrev = Stream.EmitAbbrev(Abbv);
2970
2971 SmallVector<uint64_t, 64> NameVals;
Teresa Johnson2d9da4dc2016-02-01 20:16:35 +00002972 // Iterate over the list of functions instead of the FunctionIndex map to
2973 // ensure the ordering is stable.
2974 for (const Function &F : *M) {
2975 if (F.isDeclaration())
2976 continue;
Teresa Johnson403a7872015-10-04 14:33:43 +00002977 // Skip anonymous functions. We will emit a function summary for
2978 // any aliases below.
Teresa Johnson2d9da4dc2016-02-01 20:16:35 +00002979 if (!F.hasName())
Teresa Johnsonf72278f2015-11-02 18:02:11 +00002980 continue;
Teresa Johnson403a7872015-10-04 14:33:43 +00002981
Teresa Johnson2d9da4dc2016-02-01 20:16:35 +00002982 assert(FunctionIndex.count(&F) == 1);
2983
Teresa Johnson403a7872015-10-04 14:33:43 +00002984 WritePerModuleFunctionSummaryRecord(
Teresa Johnson2794f712016-03-15 02:41:29 +00002985 NameVals, cast<FunctionSummary>(FunctionIndex[&F]->summary()),
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002986 VE.getValueID(M->getValueSymbolTable().lookup(F.getName())),
2987 FSCallsAbbrev, FSCallsProfileAbbrev, Stream, F);
Teresa Johnson403a7872015-10-04 14:33:43 +00002988 }
2989
2990 for (const GlobalAlias &A : M->aliases()) {
Teresa Johnsonf72278f2015-11-02 18:02:11 +00002991 if (!A.getBaseObject())
2992 continue;
Teresa Johnson403a7872015-10-04 14:33:43 +00002993 const Function *F = dyn_cast<Function>(A.getBaseObject());
Teresa Johnsonf72278f2015-11-02 18:02:11 +00002994 if (!F || F->isDeclaration())
2995 continue;
Teresa Johnson403a7872015-10-04 14:33:43 +00002996
2997 assert(FunctionIndex.count(F) == 1);
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00002998 FunctionSummary *FS =
Teresa Johnson2794f712016-03-15 02:41:29 +00002999 cast<FunctionSummary>(FunctionIndex[F]->summary());
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003000 // Add the alias to the reference list of aliasee function.
3001 FS->addRefEdge(
3002 VE.getValueID(M->getValueSymbolTable().lookup(A.getName())));
Teresa Johnson403a7872015-10-04 14:33:43 +00003003 WritePerModuleFunctionSummaryRecord(
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003004 NameVals, FS,
3005 VE.getValueID(M->getValueSymbolTable().lookup(A.getName())),
3006 FSCallsAbbrev, FSCallsProfileAbbrev, Stream, *F);
3007 }
3008
3009 // Capture references from GlobalVariable initializers, which are outside
3010 // of a function scope.
3011 for (const GlobalVariable &G : M->globals())
3012 WriteModuleLevelReferences(G, VE, NameVals, FSModRefsAbbrev, Stream);
Teresa Johnson2794f712016-03-15 02:41:29 +00003013 for (const GlobalAlias &A : M->aliases())
3014 if (auto *GV = dyn_cast<GlobalVariable>(A.getBaseObject()))
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003015 WriteModuleLevelReferences(*GV, VE, NameVals, FSModRefsAbbrev, Stream);
Teresa Johnson403a7872015-10-04 14:33:43 +00003016
3017 Stream.ExitBlock();
3018}
3019
Teresa Johnson26ab5772016-03-15 00:04:37 +00003020/// Emit the combined summary section into the combined index file.
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003021static void WriteCombinedGlobalValueSummary(
Teresa Johnson26ab5772016-03-15 00:04:37 +00003022 const ModuleSummaryIndex &I, BitstreamWriter &Stream,
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003023 std::map<uint64_t, unsigned> &GUIDToValueIdMap, unsigned GlobalValueId) {
3024 Stream.EnterSubblock(bitc::GLOBALVAL_SUMMARY_BLOCK_ID, 3);
Teresa Johnson403a7872015-10-04 14:33:43 +00003025
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003026 // Abbrev for FS_COMBINED.
Teresa Johnson403a7872015-10-04 14:33:43 +00003027 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003028 Abbv->Add(BitCodeAbbrevOp(bitc::FS_COMBINED));
3029 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // modid
Teresa Johnson5e22e442016-02-06 16:07:35 +00003030 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 5)); // linkage
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003031 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // instcount
3032 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // numrefs
3033 // numrefs x valueid, n x (valueid, callsitecount)
3034 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
3035 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
3036 unsigned FSCallsAbbrev = Stream.EmitAbbrev(Abbv);
Teresa Johnson403a7872015-10-04 14:33:43 +00003037
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003038 // Abbrev for FS_COMBINED_PROFILE.
3039 Abbv = new BitCodeAbbrev();
3040 Abbv->Add(BitCodeAbbrevOp(bitc::FS_COMBINED_PROFILE));
3041 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // modid
3042 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 5)); // linkage
3043 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // instcount
3044 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // numrefs
3045 // numrefs x valueid, n x (valueid, callsitecount, profilecount)
3046 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
3047 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
3048 unsigned FSCallsProfileAbbrev = Stream.EmitAbbrev(Abbv);
3049
3050 // Abbrev for FS_COMBINED_GLOBALVAR_INIT_REFS.
3051 Abbv = new BitCodeAbbrev();
3052 Abbv->Add(BitCodeAbbrevOp(bitc::FS_COMBINED_GLOBALVAR_INIT_REFS));
3053 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // modid
3054 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 5)); // linkage
3055 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); // valueids
3056 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
3057 unsigned FSModRefsAbbrev = Stream.EmitAbbrev(Abbv);
3058
3059 SmallVector<uint64_t, 64> NameVals;
Teresa Johnson3da931f2015-10-19 19:06:06 +00003060 for (const auto &FII : I) {
Teresa Johnsone1164de2016-02-10 21:55:02 +00003061 for (auto &FI : FII.second) {
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003062 GlobalValueSummary *S = FI->summary();
3063 assert(S);
Teresa Johnson403a7872015-10-04 14:33:43 +00003064
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003065 if (auto *VS = dyn_cast<GlobalVarSummary>(S)) {
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003066 NameVals.push_back(I.getModuleId(VS->modulePath()));
3067 NameVals.push_back(getEncodedLinkage(VS->linkage()));
3068 for (auto &RI : VS->refs()) {
3069 const auto &VMI = GUIDToValueIdMap.find(RI);
3070 unsigned RefId;
3071 // If this GUID doesn't have an entry, assign one.
3072 if (VMI == GUIDToValueIdMap.end()) {
3073 GUIDToValueIdMap[RI] = ++GlobalValueId;
3074 RefId = GlobalValueId;
3075 } else {
3076 RefId = VMI->second;
3077 }
3078 NameVals.push_back(RefId);
3079 }
3080
3081 // Record the starting offset of this summary entry for use
3082 // in the VST entry. Add the current code size since the
3083 // reader will invoke readRecord after the abbrev id read.
3084 FI->setBitcodeIndex(Stream.GetCurrentBitNo() +
3085 Stream.GetAbbrevIDWidth());
3086
3087 // Emit the finished record.
3088 Stream.EmitRecord(bitc::FS_COMBINED_GLOBALVAR_INIT_REFS, NameVals,
3089 FSModRefsAbbrev);
3090 NameVals.clear();
3091 continue;
3092 }
3093
Teresa Johnson2794f712016-03-15 02:41:29 +00003094 auto *FS = cast<FunctionSummary>(S);
Teresa Johnson3da931f2015-10-19 19:06:06 +00003095 NameVals.push_back(I.getModuleId(FS->modulePath()));
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003096 NameVals.push_back(getEncodedLinkage(FS->linkage()));
Teresa Johnson403a7872015-10-04 14:33:43 +00003097 NameVals.push_back(FS->instCount());
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003098 NameVals.push_back(FS->refs().size());
3099
3100 for (auto &RI : FS->refs()) {
3101 const auto &VMI = GUIDToValueIdMap.find(RI);
3102 unsigned RefId;
3103 // If this GUID doesn't have an entry, assign one.
3104 if (VMI == GUIDToValueIdMap.end()) {
3105 GUIDToValueIdMap[RI] = ++GlobalValueId;
3106 RefId = GlobalValueId;
3107 } else {
3108 RefId = VMI->second;
3109 }
3110 NameVals.push_back(RefId);
3111 }
3112
3113 bool HasProfileData = false;
Teresa Johnsonaae26102016-03-25 18:59:13 +00003114 for (auto &EI : FS->calls()) {
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003115 HasProfileData |= EI.second.ProfileCount != 0;
3116 if (HasProfileData)
3117 break;
3118 }
3119
Teresa Johnsonaae26102016-03-25 18:59:13 +00003120 for (auto &EI : FS->calls()) {
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003121 const auto &VMI = GUIDToValueIdMap.find(EI.first);
3122 // If this GUID doesn't have an entry, it doesn't have a function
3123 // summary and we don't need to record any calls to it.
3124 if (VMI == GUIDToValueIdMap.end())
3125 continue;
3126 NameVals.push_back(VMI->second);
3127 assert(EI.second.CallsiteCount > 0 && "Expected at least one callsite");
3128 NameVals.push_back(EI.second.CallsiteCount);
3129 if (HasProfileData)
3130 NameVals.push_back(EI.second.ProfileCount);
3131 }
Teresa Johnson403a7872015-10-04 14:33:43 +00003132
3133 // Record the starting offset of this summary entry for use
3134 // in the VST entry. Add the current code size since the
3135 // reader will invoke readRecord after the abbrev id read.
3136 FI->setBitcodeIndex(Stream.GetCurrentBitNo() + Stream.GetAbbrevIDWidth());
3137
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003138 unsigned FSAbbrev =
3139 (HasProfileData ? FSCallsProfileAbbrev : FSCallsAbbrev);
3140 unsigned Code =
3141 (HasProfileData ? bitc::FS_COMBINED_PROFILE : bitc::FS_COMBINED);
3142
Teresa Johnson403a7872015-10-04 14:33:43 +00003143 // Emit the finished record.
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003144 Stream.EmitRecord(Code, NameVals, FSAbbrev);
Teresa Johnson403a7872015-10-04 14:33:43 +00003145 NameVals.clear();
3146 }
3147 }
3148
3149 Stream.ExitBlock();
3150}
3151
Mehdi Amini5d303282015-10-26 18:37:00 +00003152// Create the "IDENTIFICATION_BLOCK_ID" containing a single string with the
3153// current llvm version, and a record for the epoch number.
3154static void WriteIdentificationBlock(const Module *M, BitstreamWriter &Stream) {
3155 Stream.EnterSubblock(bitc::IDENTIFICATION_BLOCK_ID, 5);
3156
3157 // Write the "user readable" string identifying the bitcode producer
3158 BitCodeAbbrev *Abbv = new BitCodeAbbrev();
3159 Abbv->Add(BitCodeAbbrevOp(bitc::IDENTIFICATION_CODE_STRING));
3160 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
3161 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
3162 auto StringAbbrev = Stream.EmitAbbrev(Abbv);
3163 WriteStringRecord(bitc::IDENTIFICATION_CODE_STRING,
3164 "LLVM" LLVM_VERSION_STRING, StringAbbrev, Stream);
3165
3166 // Write the epoch version
3167 Abbv = new BitCodeAbbrev();
3168 Abbv->Add(BitCodeAbbrevOp(bitc::IDENTIFICATION_CODE_EPOCH));
3169 Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
Mehdi Aminiba19c6e2015-11-05 00:25:03 +00003170 auto EpochAbbrev = Stream.EmitAbbrev(Abbv);
Mehdi Amini5d303282015-10-26 18:37:00 +00003171 SmallVector<unsigned, 1> Vals = {bitc::BITCODE_CURRENT_EPOCH};
Mehdi Aminiba19c6e2015-11-05 00:25:03 +00003172 Stream.EmitRecord(bitc::IDENTIFICATION_CODE_EPOCH, Vals, EpochAbbrev);
Mehdi Amini5d303282015-10-26 18:37:00 +00003173 Stream.ExitBlock();
3174}
3175
Chris Lattnerda5e5d22007-05-05 07:36:14 +00003176/// WriteModule - Emit the specified module to the bitstream.
Duncan P. N. Exon Smitha052ed62015-04-15 00:10:50 +00003177static void WriteModule(const Module *M, BitstreamWriter &Stream,
Teresa Johnsonff642b92015-09-17 20:12:00 +00003178 bool ShouldPreserveUseListOrder,
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003179 uint64_t BitcodeStartBit, bool EmitSummaryIndex) {
Chris Lattnerda5e5d22007-05-05 07:36:14 +00003180 Stream.EnterSubblock(bitc::MODULE_BLOCK_ID, 3);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003181
Jan Wen Voungafaced02012-10-11 20:20:40 +00003182 SmallVector<unsigned, 1> Vals;
3183 unsigned CurVersion = 1;
3184 Vals.push_back(CurVersion);
3185 Stream.EmitRecord(bitc::MODULE_CODE_VERSION, Vals);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003186
Chris Lattnerda5e5d22007-05-05 07:36:14 +00003187 // Analyze the module, enumerating globals, functions, etc.
Duncan P. N. Exon Smitha052ed62015-04-15 00:10:50 +00003188 ValueEnumerator VE(*M, ShouldPreserveUseListOrder);
Chris Lattnerda5e5d22007-05-05 07:36:14 +00003189
3190 // Emit blockinfo, which defines the standard abbreviations etc.
3191 WriteBlockInfo(VE, Stream);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003192
Bill Wendlingdc095552013-02-10 23:09:32 +00003193 // Emit information about attribute groups.
3194 WriteAttributeGroupTable(VE, Stream);
3195
Chris Lattnerda5e5d22007-05-05 07:36:14 +00003196 // Emit information about parameter attributes.
Devang Patel4c758ea2008-09-25 21:00:45 +00003197 WriteAttributeTable(VE, Stream);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003198
Chris Lattnerda5e5d22007-05-05 07:36:14 +00003199 // Emit information describing all of the types in the module.
3200 WriteTypeTable(VE, Stream);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003201
David Majnemerdad0a642014-06-27 18:19:56 +00003202 writeComdats(VE, Stream);
3203
Chris Lattnerda5e5d22007-05-05 07:36:14 +00003204 // Emit top-level description of module, including target triple, inline asm,
3205 // descriptors for global variables, and function prototype info.
Teresa Johnsonff642b92015-09-17 20:12:00 +00003206 uint64_t VSTOffsetPlaceholder = WriteModuleInfo(M, VE, Stream);
Devang Patel7428d8a2009-07-22 17:43:22 +00003207
Devang Patele059ba6e2009-07-23 01:07:34 +00003208 // Emit constants.
3209 WriteModuleConstants(VE, Stream);
3210
Devang Patel8cca7b42009-08-04 05:01:35 +00003211 // Emit metadata.
Duncan P. N. Exon Smith0b7243e2016-03-24 16:01:46 +00003212 WriteModuleMetadata(*M, VE, Stream);
Devang Patel8cca7b42009-08-04 05:01:35 +00003213
Devang Patelaf206b82009-09-18 19:26:43 +00003214 // Emit metadata.
Chris Lattnerc9558df2009-12-28 20:10:43 +00003215 WriteModuleMetadataStore(M, Stream);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003216
Duncan P. N. Exon Smith1f66c852014-07-28 21:19:41 +00003217 // Emit module-level use-lists.
Duncan P. N. Exon Smith458593a2015-04-14 23:45:11 +00003218 if (VE.shouldPreserveUseListOrder())
Duncan P. N. Exon Smith1f66c852014-07-28 21:19:41 +00003219 WriteUseListBlock(nullptr, VE, Stream);
Chad Rosierca2567b2011-12-07 21:44:12 +00003220
Sanjoy Dasb513a9f2015-09-24 23:34:52 +00003221 WriteOperandBundleTags(M, Stream);
3222
Derek Schuff8b2dcad2012-02-06 22:30:29 +00003223 // Emit function bodies.
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003224 DenseMap<const Function *, std::unique_ptr<GlobalValueInfo>> FunctionIndex;
Derek Schuff8b2dcad2012-02-06 22:30:29 +00003225 for (Module::const_iterator F = M->begin(), E = M->end(); F != E; ++F)
3226 if (!F->isDeclaration())
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003227 WriteFunction(*F, M, VE, Stream, FunctionIndex, EmitSummaryIndex);
Teresa Johnson403a7872015-10-04 14:33:43 +00003228
3229 // Need to write after the above call to WriteFunction which populates
3230 // the summary information in the index.
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003231 if (EmitSummaryIndex)
3232 WritePerModuleGlobalValueSummary(FunctionIndex, M, VE, Stream);
Teresa Johnsonff642b92015-09-17 20:12:00 +00003233
3234 WriteValueSymbolTable(M->getValueSymbolTable(), VE, Stream,
3235 VSTOffsetPlaceholder, BitcodeStartBit, &FunctionIndex);
Derek Schuff8b2dcad2012-02-06 22:30:29 +00003236
Chris Lattner702658c2007-05-04 18:26:27 +00003237 Stream.ExitBlock();
3238}
3239
Chris Lattnera660f4b2008-07-09 05:14:23 +00003240/// EmitDarwinBCHeader - If generating a bc file on darwin, we have to emit a
3241/// header and trailer to make it compatible with the system archiver. To do
3242/// this we emit the following header, and then emit a trailer that pads the
3243/// file out to be a multiple of 16 bytes.
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003244///
Chris Lattnera660f4b2008-07-09 05:14:23 +00003245/// struct bc_header {
3246/// uint32_t Magic; // 0x0B17C0DE
3247/// uint32_t Version; // Version, currently always 0.
3248/// uint32_t BitcodeOffset; // Offset to traditional bitcode file.
3249/// uint32_t BitcodeSize; // Size of traditional bitcode file.
3250/// uint32_t CPUType; // CPU specifier.
3251/// ... potentially more later ...
3252/// };
Chris Lattnera660f4b2008-07-09 05:14:23 +00003253
Daniel Dunbar42fcf812012-02-29 20:31:09 +00003254static void WriteInt32ToBuffer(uint32_t Value, SmallVectorImpl<char> &Buffer,
Daniel Dunbar6e45c022012-02-29 20:31:01 +00003255 uint32_t &Position) {
Benjamin Kramer5014f402015-06-17 20:55:30 +00003256 support::endian::write32le(&Buffer[Position], Value);
Daniel Dunbar6e45c022012-02-29 20:31:01 +00003257 Position += 4;
3258}
3259
Daniel Dunbar42fcf812012-02-29 20:31:09 +00003260static void EmitDarwinBCHeaderAndTrailer(SmallVectorImpl<char> &Buffer,
Daniel Dunbar6e45c022012-02-29 20:31:01 +00003261 const Triple &TT) {
Chris Lattnera660f4b2008-07-09 05:14:23 +00003262 unsigned CPUType = ~0U;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003263
Evan Cheng9aa30fb2010-02-12 20:13:44 +00003264 // Match x86_64-*, i[3-9]86-*, powerpc-*, powerpc64-*, arm-*, thumb-*,
Evan Cheng545d3602010-02-12 20:39:35 +00003265 // armv[0-9]-*, thumbv[0-9]-*, armv5te-*, or armv6t2-*. The CPUType is a magic
3266 // number from /usr/include/mach/machine.h. It is ok to reproduce the
3267 // specific constants here because they are implicitly part of the Darwin ABI.
Chris Lattnera660f4b2008-07-09 05:14:23 +00003268 enum {
3269 DARWIN_CPU_ARCH_ABI64 = 0x01000000,
3270 DARWIN_CPU_TYPE_X86 = 7,
Evan Cheng9aa30fb2010-02-12 20:13:44 +00003271 DARWIN_CPU_TYPE_ARM = 12,
Chris Lattnera660f4b2008-07-09 05:14:23 +00003272 DARWIN_CPU_TYPE_POWERPC = 18
3273 };
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003274
Evan Chengcffdcae2011-06-14 01:51:33 +00003275 Triple::ArchType Arch = TT.getArch();
3276 if (Arch == Triple::x86_64)
Chris Lattnera660f4b2008-07-09 05:14:23 +00003277 CPUType = DARWIN_CPU_TYPE_X86 | DARWIN_CPU_ARCH_ABI64;
Evan Chengcffdcae2011-06-14 01:51:33 +00003278 else if (Arch == Triple::x86)
Chris Lattnera660f4b2008-07-09 05:14:23 +00003279 CPUType = DARWIN_CPU_TYPE_X86;
Evan Chengcffdcae2011-06-14 01:51:33 +00003280 else if (Arch == Triple::ppc)
Chris Lattnera660f4b2008-07-09 05:14:23 +00003281 CPUType = DARWIN_CPU_TYPE_POWERPC;
Evan Chengcffdcae2011-06-14 01:51:33 +00003282 else if (Arch == Triple::ppc64)
Chris Lattnera660f4b2008-07-09 05:14:23 +00003283 CPUType = DARWIN_CPU_TYPE_POWERPC | DARWIN_CPU_ARCH_ABI64;
Evan Chengcffdcae2011-06-14 01:51:33 +00003284 else if (Arch == Triple::arm || Arch == Triple::thumb)
Evan Cheng9aa30fb2010-02-12 20:13:44 +00003285 CPUType = DARWIN_CPU_TYPE_ARM;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003286
Chris Lattnera660f4b2008-07-09 05:14:23 +00003287 // Traditional Bitcode starts after header.
Akira Hatanaka4f472a882016-01-29 05:55:09 +00003288 assert(Buffer.size() >= BWH_HeaderSize &&
Daniel Dunbar6e45c022012-02-29 20:31:01 +00003289 "Expected header size to be reserved");
Akira Hatanaka4f472a882016-01-29 05:55:09 +00003290 unsigned BCOffset = BWH_HeaderSize;
3291 unsigned BCSize = Buffer.size() - BWH_HeaderSize;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003292
Daniel Dunbar6e45c022012-02-29 20:31:01 +00003293 // Write the magic and version.
3294 unsigned Position = 0;
3295 WriteInt32ToBuffer(0x0B17C0DE , Buffer, Position);
3296 WriteInt32ToBuffer(0 , Buffer, Position); // Version.
3297 WriteInt32ToBuffer(BCOffset , Buffer, Position);
3298 WriteInt32ToBuffer(BCSize , Buffer, Position);
3299 WriteInt32ToBuffer(CPUType , Buffer, Position);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003300
Chris Lattnera660f4b2008-07-09 05:14:23 +00003301 // If the file is not a multiple of 16 bytes, insert dummy padding.
Daniel Dunbar6e45c022012-02-29 20:31:01 +00003302 while (Buffer.size() & 15)
3303 Buffer.push_back(0);
Chris Lattnera660f4b2008-07-09 05:14:23 +00003304}
3305
Teresa Johnson403a7872015-10-04 14:33:43 +00003306/// Helper to write the header common to all bitcode files.
3307static void WriteBitcodeHeader(BitstreamWriter &Stream) {
3308 // Emit the file header.
3309 Stream.Emit((unsigned)'B', 8);
3310 Stream.Emit((unsigned)'C', 8);
3311 Stream.Emit(0x0, 4);
3312 Stream.Emit(0xC, 4);
3313 Stream.Emit(0xE, 4);
3314 Stream.Emit(0xD, 4);
3315}
3316
Chris Lattnerc1d10d62007-04-22 06:24:45 +00003317/// WriteBitcodeToFile - Write the specified module to the specified output
3318/// stream.
Duncan P. N. Exon Smitha052ed62015-04-15 00:10:50 +00003319void llvm::WriteBitcodeToFile(const Module *M, raw_ostream &Out,
Teresa Johnson403a7872015-10-04 14:33:43 +00003320 bool ShouldPreserveUseListOrder,
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003321 bool EmitSummaryIndex) {
Michael Ilsemane26658d2012-12-03 21:29:36 +00003322 SmallVector<char, 0> Buffer;
Chris Lattnerc1d10d62007-04-22 06:24:45 +00003323 Buffer.reserve(256*1024);
Chris Lattneraf4c0bf2008-12-19 18:37:59 +00003324
Daniel Dunbar6e45c022012-02-29 20:31:01 +00003325 // If this is darwin or another generic macho target, reserve space for the
3326 // header.
3327 Triple TT(M->getTargetTriple());
Akira Hatanaka1235d282016-01-23 16:02:10 +00003328 if (TT.isOSDarwin() || TT.isOSBinFormatMachO())
Akira Hatanaka4f472a882016-01-29 05:55:09 +00003329 Buffer.insert(Buffer.begin(), BWH_HeaderSize, 0);
Daniel Dunbar6e45c022012-02-29 20:31:01 +00003330
3331 // Emit the module into the buffer.
3332 {
3333 BitstreamWriter Stream(Buffer);
Teresa Johnsonff642b92015-09-17 20:12:00 +00003334 // Save the start bit of the actual bitcode, in case there is space
3335 // saved at the start for the darwin header above. The reader stream
3336 // will start at the bitcode, and we need the offset of the VST
3337 // to line up.
3338 uint64_t BitcodeStartBit = Stream.GetCurrentBitNo();
Daniel Dunbar6e45c022012-02-29 20:31:01 +00003339
3340 // Emit the file header.
Teresa Johnson403a7872015-10-04 14:33:43 +00003341 WriteBitcodeHeader(Stream);
Daniel Dunbar6e45c022012-02-29 20:31:01 +00003342
Mehdi Amini5d303282015-10-26 18:37:00 +00003343 WriteIdentificationBlock(M, Stream);
3344
Daniel Dunbar6e45c022012-02-29 20:31:01 +00003345 // Emit the module.
Teresa Johnson403a7872015-10-04 14:33:43 +00003346 WriteModule(M, Stream, ShouldPreserveUseListOrder, BitcodeStartBit,
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003347 EmitSummaryIndex);
Daniel Dunbar6e45c022012-02-29 20:31:01 +00003348 }
3349
Akira Hatanaka1235d282016-01-23 16:02:10 +00003350 if (TT.isOSDarwin() || TT.isOSBinFormatMachO())
Daniel Dunbar6e45c022012-02-29 20:31:01 +00003351 EmitDarwinBCHeaderAndTrailer(Buffer, TT);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00003352
Chris Lattneraf4c0bf2008-12-19 18:37:59 +00003353 // Write the generated bitstream to "Out".
3354 Out.write((char*)&Buffer.front(), Buffer.size());
Chris Lattneraf4c0bf2008-12-19 18:37:59 +00003355}
Teresa Johnson403a7872015-10-04 14:33:43 +00003356
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003357// Write the specified module summary index to the given raw output stream,
Teresa Johnson403a7872015-10-04 14:33:43 +00003358// where it will be written in a new bitcode block. This is used when
3359// writing the combined index file for ThinLTO.
Teresa Johnson26ab5772016-03-15 00:04:37 +00003360void llvm::WriteIndexToFile(const ModuleSummaryIndex &Index, raw_ostream &Out) {
Teresa Johnson403a7872015-10-04 14:33:43 +00003361 SmallVector<char, 0> Buffer;
3362 Buffer.reserve(256 * 1024);
3363
3364 BitstreamWriter Stream(Buffer);
3365
3366 // Emit the bitcode header.
3367 WriteBitcodeHeader(Stream);
3368
3369 Stream.EnterSubblock(bitc::MODULE_BLOCK_ID, 3);
3370
3371 SmallVector<unsigned, 1> Vals;
3372 unsigned CurVersion = 1;
3373 Vals.push_back(CurVersion);
3374 Stream.EmitRecord(bitc::MODULE_CODE_VERSION, Vals);
3375
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003376 // If we have a VST, write the VSTOFFSET record placeholder and record
3377 // its offset.
3378 uint64_t VSTOffsetPlaceholder = WriteValueSymbolTableForwardDecl(Stream);
3379
Teresa Johnson403a7872015-10-04 14:33:43 +00003380 // Write the module paths in the combined index.
3381 WriteModStrings(Index, Stream);
3382
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003383 // Assign unique value ids to all functions in the index for use
3384 // in writing out the call graph edges. Save the mapping from GUID
3385 // to the new global value id to use when writing those edges, which
3386 // are currently saved in the index in terms of GUID.
3387 std::map<uint64_t, unsigned> GUIDToValueIdMap;
3388 unsigned GlobalValueId = 0;
3389 for (auto &II : Index)
3390 GUIDToValueIdMap[II.first] = ++GlobalValueId;
3391
3392 // Write the summary combined index records.
3393 WriteCombinedGlobalValueSummary(Index, Stream, GUIDToValueIdMap,
3394 GlobalValueId);
Teresa Johnson403a7872015-10-04 14:33:43 +00003395
3396 // Need a special VST writer for the combined index (we don't have a
3397 // real VST and real values when this is invoked).
Teresa Johnson76a1c1d2016-03-11 18:52:24 +00003398 WriteCombinedValueSymbolTable(Index, Stream, GUIDToValueIdMap,
3399 VSTOffsetPlaceholder);
Teresa Johnson403a7872015-10-04 14:33:43 +00003400
3401 Stream.ExitBlock();
3402
3403 Out.write((char *)&Buffer.front(), Buffer.size());
3404}