lib/Bitcode/Writer/BitcodeWriter.cpp

   1 //===--- Bitcode/Writer/BitcodeWriter.cpp - Bitcode Writer ----------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // Bitcode writer implementation.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Bitcode/ReaderWriter.h"
  15 #include "ValueEnumerator.h"
  16 #include "llvm/ADT/Triple.h"
  17 #include "llvm/Bitcode/BitstreamWriter.h"
  18 #include "llvm/Bitcode/LLVMBitCodes.h"
  19 #include "llvm/IR/Constants.h"
  20 #include "llvm/IR/DebugInfoMetadata.h"
  21 #include "llvm/IR/DerivedTypes.h"
  22 #include "llvm/IR/InlineAsm.h"
  23 #include "llvm/IR/Instructions.h"
  24 #include "llvm/IR/Module.h"
  25 #include "llvm/IR/Operator.h"
  26 #include "llvm/IR/UseListOrder.h"
  27 #include "llvm/IR/ValueSymbolTable.h"
  28 #include "llvm/Support/CommandLine.h"
  29 #include "llvm/Support/ErrorHandling.h"
  30 #include "llvm/Support/MathExtras.h"
  31 #include "llvm/Support/Program.h"
  32 #include "llvm/Support/raw_ostream.h"
  33 #include <cctype>
  34 #include <map>
  35 using namespace llvm;
  36
  37 /// These are manifest constants used by the bitcode writer. They do not need to
  38 /// be kept in sync with the reader, but need to be consistent within this file.
  39 enum {
  40   // VALUE_SYMTAB_BLOCK abbrev id's.
  41   VST_ENTRY_8_ABBREV = bitc::FIRST_APPLICATION_ABBREV,
  42   VST_ENTRY_7_ABBREV,
  43   VST_ENTRY_6_ABBREV,
  44   VST_BBENTRY_6_ABBREV,
  45
  46   // CONSTANTS_BLOCK abbrev id's.
  47   CONSTANTS_SETTYPE_ABBREV = bitc::FIRST_APPLICATION_ABBREV,
  48   CONSTANTS_INTEGER_ABBREV,
  49   CONSTANTS_CE_CAST_Abbrev,
  50   CONSTANTS_NULL_Abbrev,
  51
  52   // FUNCTION_BLOCK abbrev id's.
  53   FUNCTION_INST_LOAD_ABBREV = bitc::FIRST_APPLICATION_ABBREV,
  54   FUNCTION_INST_BINOP_ABBREV,
  55   FUNCTION_INST_BINOP_FLAGS_ABBREV,
  56   FUNCTION_INST_CAST_ABBREV,
  57   FUNCTION_INST_RET_VOID_ABBREV,
  58   FUNCTION_INST_RET_VAL_ABBREV,
  59   FUNCTION_INST_UNREACHABLE_ABBREV,
  60   FUNCTION_INST_GEP_ABBREV,
  61 };
  62
  63 static unsigned GetEncodedCastOpcode(unsigned Opcode) {
  64   switch (Opcode) {
  65   default: llvm_unreachable("Unknown cast instruction!");
  66   case Instruction::Trunc   : return bitc::CAST_TRUNC;
  67   case Instruction::ZExt    : return bitc::CAST_ZEXT;
  68   case Instruction::SExt    : return bitc::CAST_SEXT;
  69   case Instruction::FPToUI  : return bitc::CAST_FPTOUI;
  70   case Instruction::FPToSI  : return bitc::CAST_FPTOSI;
  71   case Instruction::UIToFP  : return bitc::CAST_UITOFP;
  72   case Instruction::SIToFP  : return bitc::CAST_SITOFP;
  73   case Instruction::FPTrunc : return bitc::CAST_FPTRUNC;
  74   case Instruction::FPExt   : return bitc::CAST_FPEXT;
  75   case Instruction::PtrToInt: return bitc::CAST_PTRTOINT;
  76   case Instruction::IntToPtr: return bitc::CAST_INTTOPTR;
  77   case Instruction::BitCast : return bitc::CAST_BITCAST;
  78   case Instruction::AddrSpaceCast: return bitc::CAST_ADDRSPACECAST;
  79   }
  80 }
  81
  82 static unsigned GetEncodedBinaryOpcode(unsigned Opcode) {
  83   switch (Opcode) {
  84   default: llvm_unreachable("Unknown binary instruction!");
  85   case Instruction::Add:
  86   case Instruction::FAdd: return bitc::BINOP_ADD;
  87   case Instruction::Sub:
  88   case Instruction::FSub: return bitc::BINOP_SUB;
  89   case Instruction::Mul:
  90   case Instruction::FMul: return bitc::BINOP_MUL;
  91   case Instruction::UDiv: return bitc::BINOP_UDIV;
  92   case Instruction::FDiv:
  93   case Instruction::SDiv: return bitc::BINOP_SDIV;
  94   case Instruction::URem: return bitc::BINOP_UREM;
  95   case Instruction::FRem:
  96   case Instruction::SRem: return bitc::BINOP_SREM;
  97   case Instruction::Shl:  return bitc::BINOP_SHL;
  98   case Instruction::LShr: return bitc::BINOP_LSHR;
  99   case Instruction::AShr: return bitc::BINOP_ASHR;
 100   case Instruction::And:  return bitc::BINOP_AND;
 101   case Instruction::Or:   return bitc::BINOP_OR;
 102   case Instruction::Xor:  return bitc::BINOP_XOR;
 103   }
 104 }
 105
 106 static unsigned GetEncodedRMWOperation(AtomicRMWInst::BinOp Op) {
 107   switch (Op) {
 108   default: llvm_unreachable("Unknown RMW operation!");
 109   case AtomicRMWInst::Xchg: return bitc::RMW_XCHG;
 110   case AtomicRMWInst::Add: return bitc::RMW_ADD;
 111   case AtomicRMWInst::Sub: return bitc::RMW_SUB;
 112   case AtomicRMWInst::And: return bitc::RMW_AND;
 113   case AtomicRMWInst::Nand: return bitc::RMW_NAND;
 114   case AtomicRMWInst::Or: return bitc::RMW_OR;
 115   case AtomicRMWInst::Xor: return bitc::RMW_XOR;
 116   case AtomicRMWInst::Max: return bitc::RMW_MAX;
 117   case AtomicRMWInst::Min: return bitc::RMW_MIN;
 118   case AtomicRMWInst::UMax: return bitc::RMW_UMAX;
 119   case AtomicRMWInst::UMin: return bitc::RMW_UMIN;
 120   }
 121 }
 122
 123 static unsigned GetEncodedOrdering(AtomicOrdering Ordering) {
 124   switch (Ordering) {
 125   case NotAtomic: return bitc::ORDERING_NOTATOMIC;
 126   case Unordered: return bitc::ORDERING_UNORDERED;
 127   case Monotonic: return bitc::ORDERING_MONOTONIC;
 128   case Acquire: return bitc::ORDERING_ACQUIRE;
 129   case Release: return bitc::ORDERING_RELEASE;
 130   case AcquireRelease: return bitc::ORDERING_ACQREL;
 131   case SequentiallyConsistent: return bitc::ORDERING_SEQCST;
 132   }
 133   llvm_unreachable("Invalid ordering");
 134 }
 135
 136 static unsigned GetEncodedSynchScope(SynchronizationScope SynchScope) {
 137   switch (SynchScope) {
 138   case SingleThread: return bitc::SYNCHSCOPE_SINGLETHREAD;
 139   case CrossThread: return bitc::SYNCHSCOPE_CROSSTHREAD;
 140   }
 141   llvm_unreachable("Invalid synch scope");
 142 }
 143
 144 static void WriteStringRecord(unsigned Code, StringRef Str,
 145                               unsigned AbbrevToUse, BitstreamWriter &Stream) {
 146   SmallVector<unsigned, 64> Vals;
 147
 148   // Code: [strchar x N]
 149   for (unsigned i = 0, e = Str.size(); i != e; ++i) {
 150     if (AbbrevToUse && !BitCodeAbbrevOp::isChar6(Str[i]))
 151       AbbrevToUse = 0;
 152     Vals.push_back(Str[i]);
 153   }
 154
 155   // Emit the finished record.
 156   Stream.EmitRecord(Code, Vals, AbbrevToUse);
 157 }
 158
 159 static uint64_t getAttrKindEncoding(Attribute::AttrKind Kind) {
 160   switch (Kind) {
 161   case Attribute::Alignment:
 162     return bitc::ATTR_KIND_ALIGNMENT;
 163   case Attribute::AlwaysInline:
 164     return bitc::ATTR_KIND_ALWAYS_INLINE;
 165   case Attribute::Builtin:
 166     return bitc::ATTR_KIND_BUILTIN;
 167   case Attribute::ByVal:
 168     return bitc::ATTR_KIND_BY_VAL;
 169   case Attribute::InAlloca:
 170     return bitc::ATTR_KIND_IN_ALLOCA;
 171   case Attribute::Cold:
 172     return bitc::ATTR_KIND_COLD;
 173   case Attribute::InlineHint:
 174     return bitc::ATTR_KIND_INLINE_HINT;
 175   case Attribute::InReg:
 176     return bitc::ATTR_KIND_IN_REG;
 177   case Attribute::JumpTable:
 178     return bitc::ATTR_KIND_JUMP_TABLE;
 179   case Attribute::MinSize:
 180     return bitc::ATTR_KIND_MIN_SIZE;
 181   case Attribute::Naked:
 182     return bitc::ATTR_KIND_NAKED;
 183   case Attribute::Nest:
 184     return bitc::ATTR_KIND_NEST;
 185   case Attribute::NoAlias:
 186     return bitc::ATTR_KIND_NO_ALIAS;
 187   case Attribute::NoBuiltin:
 188     return bitc::ATTR_KIND_NO_BUILTIN;
 189   case Attribute::NoCapture:
 190     return bitc::ATTR_KIND_NO_CAPTURE;
 191   case Attribute::NoDuplicate:
 192     return bitc::ATTR_KIND_NO_DUPLICATE;
 193   case Attribute::NoImplicitFloat:
 194     return bitc::ATTR_KIND_NO_IMPLICIT_FLOAT;
 195   case Attribute::NoInline:
 196     return bitc::ATTR_KIND_NO_INLINE;
 197   case Attribute::NonLazyBind:
 198     return bitc::ATTR_KIND_NON_LAZY_BIND;
 199   case Attribute::NonNull:
 200     return bitc::ATTR_KIND_NON_NULL;
 201   case Attribute::Dereferenceable:
 202     return bitc::ATTR_KIND_DEREFERENCEABLE;
 203   case Attribute::DereferenceableOrNull:
 204     return bitc::ATTR_KIND_DEREFERENCEABLE_OR_NULL;
 205   case Attribute::NoRedZone:
 206     return bitc::ATTR_KIND_NO_RED_ZONE;
 207   case Attribute::NoReturn:
 208     return bitc::ATTR_KIND_NO_RETURN;
 209   case Attribute::NoUnwind:
 210     return bitc::ATTR_KIND_NO_UNWIND;
 211   case Attribute::OptimizeForSize:
 212     return bitc::ATTR_KIND_OPTIMIZE_FOR_SIZE;
 213   case Attribute::OptimizeNone:
 214     return bitc::ATTR_KIND_OPTIMIZE_NONE;
 215   case Attribute::ReadNone:
 216     return bitc::ATTR_KIND_READ_NONE;
 217   case Attribute::ReadOnly:
 218     return bitc::ATTR_KIND_READ_ONLY;
 219   case Attribute::Returned:
 220     return bitc::ATTR_KIND_RETURNED;
 221   case Attribute::ReturnsTwice:
 222     return bitc::ATTR_KIND_RETURNS_TWICE;
 223   case Attribute::SExt:
 224     return bitc::ATTR_KIND_S_EXT;
 225   case Attribute::StackAlignment:
 226     return bitc::ATTR_KIND_STACK_ALIGNMENT;
 227   case Attribute::StackProtect:
 228     return bitc::ATTR_KIND_STACK_PROTECT;
 229   case Attribute::StackProtectReq:
 230     return bitc::ATTR_KIND_STACK_PROTECT_REQ;
 231   case Attribute::StackProtectStrong:
 232     return bitc::ATTR_KIND_STACK_PROTECT_STRONG;
 233   case Attribute::StructRet:
 234     return bitc::ATTR_KIND_STRUCT_RET;
 235   case Attribute::SanitizeAddress:
 236     return bitc::ATTR_KIND_SANITIZE_ADDRESS;
 237   case Attribute::SanitizeThread:
 238     return bitc::ATTR_KIND_SANITIZE_THREAD;
 239   case Attribute::SanitizeMemory:
 240     return bitc::ATTR_KIND_SANITIZE_MEMORY;
 241   case Attribute::UWTable:
 242     return bitc::ATTR_KIND_UW_TABLE;
 243   case Attribute::ZExt:
 244     return bitc::ATTR_KIND_Z_EXT;
 245   case Attribute::EndAttrKinds:
 246     llvm_unreachable("Can not encode end-attribute kinds marker.");
 247   case Attribute::None:
 248     llvm_unreachable("Can not encode none-attribute.");
 249   }
 250
 251   llvm_unreachable("Trying to encode unknown attribute");
 252 }
 253
 254 static void WriteAttributeGroupTable(const ValueEnumerator &VE,
 255                                      BitstreamWriter &Stream) {
 256   const std::vector<AttributeSet> &AttrGrps = VE.getAttributeGroups();
 257   if (AttrGrps.empty()) return;
 258
 259   Stream.EnterSubblock(bitc::PARAMATTR_GROUP_BLOCK_ID, 3);
 260
 261   SmallVector<uint64_t, 64> Record;
 262   for (unsigned i = 0, e = AttrGrps.size(); i != e; ++i) {
 263     AttributeSet AS = AttrGrps[i];
 264     for (unsigned i = 0, e = AS.getNumSlots(); i != e; ++i) {
 265       AttributeSet A = AS.getSlotAttributes(i);
 266
 267       Record.push_back(VE.getAttributeGroupID(A));
 268       Record.push_back(AS.getSlotIndex(i));
 269
 270       for (AttributeSet::iterator I = AS.begin(0), E = AS.end(0);
 271            I != E; ++I) {
 272         Attribute Attr = *I;
 273         if (Attr.isEnumAttribute()) {
 274           Record.push_back(0);
 275           Record.push_back(getAttrKindEncoding(Attr.getKindAsEnum()));
 276         } else if (Attr.isIntAttribute()) {
 277           Record.push_back(1);
 278           Record.push_back(getAttrKindEncoding(Attr.getKindAsEnum()));
 279           Record.push_back(Attr.getValueAsInt());
 280         } else {
 281           StringRef Kind = Attr.getKindAsString();
 282           StringRef Val = Attr.getValueAsString();
 283
 284           Record.push_back(Val.empty() ? 3 : 4);
 285           Record.append(Kind.begin(), Kind.end());
 286           Record.push_back(0);
 287           if (!Val.empty()) {
 288             Record.append(Val.begin(), Val.end());
 289             Record.push_back(0);
 290           }
 291         }
 292       }
 293
 294       Stream.EmitRecord(bitc::PARAMATTR_GRP_CODE_ENTRY, Record);
 295       Record.clear();
 296     }
 297   }
 298
 299   Stream.ExitBlock();
 300 }
 301
 302 static void WriteAttributeTable(const ValueEnumerator &VE,
 303                                 BitstreamWriter &Stream) {
 304   const std::vector<AttributeSet> &Attrs = VE.getAttributes();
 305   if (Attrs.empty()) return;
 306
 307   Stream.EnterSubblock(bitc::PARAMATTR_BLOCK_ID, 3);
 308
 309   SmallVector<uint64_t, 64> Record;
 310   for (unsigned i = 0, e = Attrs.size(); i != e; ++i) {
 311     const AttributeSet &A = Attrs[i];
 312     for (unsigned i = 0, e = A.getNumSlots(); i != e; ++i)
 313       Record.push_back(VE.getAttributeGroupID(A.getSlotAttributes(i)));
 314
 315     Stream.EmitRecord(bitc::PARAMATTR_CODE_ENTRY, Record);
 316     Record.clear();
 317   }
 318
 319   Stream.ExitBlock();
 320 }
 321
 322 /// WriteTypeTable - Write out the type table for a module.
 323 static void WriteTypeTable(const ValueEnumerator &VE, BitstreamWriter &Stream) {
 324   const ValueEnumerator::TypeList &TypeList = VE.getTypes();
 325
 326   Stream.EnterSubblock(bitc::TYPE_BLOCK_ID_NEW, 4 /*count from # abbrevs */);
 327   SmallVector<uint64_t, 64> TypeVals;
 328
 329   uint64_t NumBits = VE.computeBitsRequiredForTypeIndicies();
 330
 331   // Abbrev for TYPE_CODE_POINTER.
 332   BitCodeAbbrev *Abbv = new BitCodeAbbrev();
 333   Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_POINTER));
 334   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
 335   Abbv->Add(BitCodeAbbrevOp(0));  // Addrspace = 0
 336   unsigned PtrAbbrev = Stream.EmitAbbrev(Abbv);
 337
 338   // Abbrev for TYPE_CODE_FUNCTION.
 339   Abbv = new BitCodeAbbrev();
 340   Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_FUNCTION));
 341   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));  // isvararg
 342   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
 343   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
 344
 345   unsigned FunctionAbbrev = Stream.EmitAbbrev(Abbv);
 346
 347   // Abbrev for TYPE_CODE_STRUCT_ANON.
 348   Abbv = new BitCodeAbbrev();
 349   Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_STRUCT_ANON));
 350   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));  // ispacked
 351   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
 352   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
 353
 354   unsigned StructAnonAbbrev = Stream.EmitAbbrev(Abbv);
 355
 356   // Abbrev for TYPE_CODE_STRUCT_NAME.
 357   Abbv = new BitCodeAbbrev();
 358   Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_STRUCT_NAME));
 359   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
 360   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
 361   unsigned StructNameAbbrev = Stream.EmitAbbrev(Abbv);
 362
 363   // Abbrev for TYPE_CODE_STRUCT_NAMED.
 364   Abbv = new BitCodeAbbrev();
 365   Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_STRUCT_NAMED));
 366   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));  // ispacked
 367   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
 368   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
 369
 370   unsigned StructNamedAbbrev = Stream.EmitAbbrev(Abbv);
 371
 372   // Abbrev for TYPE_CODE_ARRAY.
 373   Abbv = new BitCodeAbbrev();
 374   Abbv->Add(BitCodeAbbrevOp(bitc::TYPE_CODE_ARRAY));
 375   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));   // size
 376   Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, NumBits));
 377
 378   unsigned ArrayAbbrev = Stream.EmitAbbrev(Abbv);
 379
 380   // Emit an entry count so the reader can reserve space.
 381   TypeVals.push_back(TypeList.size());
 382   Stream.EmitRecord(bitc::TYPE_CODE_NUMENTRY, TypeVals);
 383   TypeVals.clear();
 384
 385   // Loop over all of the types, emitting each in turn.
 386   for (unsigned i = 0, e = TypeList.size(); i != e; ++i) {
 387     Type *T = TypeList[i];
 388     int AbbrevToUse = 0;
 389     unsigned Code = 0;
 390
 391     switch (T->getTypeID()) {
 392     case Type::VoidTyID:      Code = bitc::TYPE_CODE_VOID;      break;
 393     case Type::HalfTyID:      Code = bitc::TYPE_CODE_HALF;      break;
 394     case Type::FloatTyID:     Code = bitc::TYPE_CODE_FLOAT;     break;
 395     case Type::DoubleTyID:    Code = bitc::TYPE_CODE_DOUBLE;    break;
 396     case Type::X86_FP80TyID:  Code = bitc::TYPE_CODE_X86_FP80;  break;
 397     case Type::FP128TyID:     Code = bitc::TYPE_CODE_FP128;     break;
 398     case Type::PPC_FP128TyID: Code = bitc::TYPE_CODE_PPC_FP128; break;
 399     case Type::LabelTyID:     Code = bitc::TYPE_CODE_LABEL;     break;
 400     case Type::MetadataTyID:  Code = bitc::TYPE_CODE_METADATA;  break;
 401     case Type::X86_MMXTyID:   Code = bitc::TYPE_CODE_X86_MMX;   break;
 402     case Type::IntegerTyID:
 403       // INTEGER: [width]
 404       Code = bitc::TYPE_CODE_INTEGER;
 405       TypeVals.push_back(cast<IntegerType>(T)->getBitWidth());
 406       break;
 407     case Type::PointerTyID: {
 408       PointerType *PTy = cast<PointerType>(T);
 409       // POINTER: [pointee type, address space]
 410       Code = bitc::TYPE_CODE_POINTER;
 411       TypeVals.push_back(VE.getTypeID(PTy->getElementType()));
 412       unsigned AddressSpace = PTy->getAddressSpace();
 413       TypeVals.push_back(AddressSpace);
 414       if (AddressSpace == 0) AbbrevToUse = PtrAbbrev;
 415       break;
 416     }
 417     case Type::FunctionTyID: {
 418       FunctionType *FT = cast<FunctionType>(T);
 419       // FUNCTION: [isvararg, retty, paramty x N]
 420       Code = bitc::TYPE_CODE_FUNCTION;
 421       TypeVals.push_back(FT->isVarArg());
 422       TypeVals.push_back(VE.getTypeID(FT->getReturnType()));
 423       for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i)
 424         TypeVals.push_back(VE.getTypeID(FT->getParamType(i)));
 425       AbbrevToUse = FunctionAbbrev;
 426       break;
 427     }
 428     case Type::StructTyID: {
 429       StructType *ST = cast<StructType>(T);
 430       // STRUCT: [ispacked, eltty x N]
 431       TypeVals.push_back(ST->isPacked());
 432       // Output all of the element types.
 433       for (StructType::element_iterator I = ST->element_begin(),
 434            E = ST->element_end(); I != E; ++I)
 435         TypeVals.push_back(VE.getTypeID(*I));
 436
 437       if (ST->isLiteral()) {
 438         Code = bitc::TYPE_CODE_STRUCT_ANON;
 439         AbbrevToUse = StructAnonAbbrev;
 440       } else {
 441         if (ST->isOpaque()) {
 442           Code = bitc::TYPE_CODE_OPAQUE;
 443         } else {
 444           Code = bitc::TYPE_CODE_STRUCT_NAMED;
 445           AbbrevToUse = StructNamedAbbrev;
 446         }
 447
 448         // Emit the name if it is present.
 449         if (!ST->getName().empty())
 450           WriteStringRecord(bitc::TYPE_CODE_STRUCT_NAME, ST->getName(),
 451                             StructNameAbbrev, Stream);
 452       }
 453       break;
 454     }
 455     case Type::ArrayTyID: {
 456       ArrayType *AT = cast<ArrayType>(T);
 457       // ARRAY: [numelts, eltty]
 458       Code = bitc::TYPE_CODE_ARRAY;
 459       TypeVals.push_back(AT->getNumElements());
 460       TypeVals.push_back(VE.getTypeID(AT->getElementType()));
 461       AbbrevToUse = ArrayAbbrev;
 462       break;
 463     }
 464     case Type::VectorTyID: {
 465       VectorType *VT = cast<VectorType>(T);
 466       // VECTOR [numelts, eltty]
 467       Code = bitc::TYPE_CODE_VECTOR;
 468       TypeVals.push_back(VT->getNumElements());
 469       TypeVals.push_back(VE.getTypeID(VT->getElementType()));
 470       break;
 471     }
 472     }
 473
 474     // Emit the finished record.
 475     Stream.EmitRecord(Code, TypeVals, AbbrevToUse);
 476     TypeVals.clear();
 477   }
 478
 479   Stream.ExitBlock();
 480 }
 481
 482 static unsigned getEncodedLinkage(const GlobalValue &GV) {
 483   switch (GV.getLinkage()) {
 484   case GlobalValue::ExternalLinkage:
 485     return 0;
 486   case GlobalValue::WeakAnyLinkage:
 487     return 16;
 488   case GlobalValue::AppendingLinkage:
 489     return 2;
 490   case GlobalValue::InternalLinkage:
 491     return 3;
 492   case GlobalValue::LinkOnceAnyLinkage:
 493     return 18;
 494   case GlobalValue::ExternalWeakLinkage:
 495     return 7;
 496   case GlobalValue::CommonLinkage:
 497     return 8;
 498   case GlobalValue::PrivateLinkage:
 499     return 9;
 500   case GlobalValue::WeakODRLinkage:
 501     return 17;
 502   case GlobalValue::LinkOnceODRLinkage:
 503     return 19;
 504   case GlobalValue::AvailableExternallyLinkage:
 505     return 12;
 506   }
 507   llvm_unreachable("Invalid linkage");
 508 }
 509
 510 static unsigned getEncodedVisibility(const GlobalValue &GV) {
 511   switch (GV.getVisibility()) {
 512   case GlobalValue::DefaultVisibility:   return 0;
 513   case GlobalValue::HiddenVisibility:    return 1;
 514   case GlobalValue::ProtectedVisibility: return 2;
 515   }
 516   llvm_unreachable("Invalid visibility");
 517 }
 518
 519 static unsigned getEncodedDLLStorageClass(const GlobalValue &GV) {
 520   switch (GV.getDLLStorageClass()) {
 521   case GlobalValue::DefaultStorageClass:   return 0;
 522   case GlobalValue::DLLImportStorageClass: return 1;
 523   case GlobalValue::DLLExportStorageClass: return 2;
 524   }
 525   llvm_unreachable("Invalid DLL storage class");
 526 }
 527
 528 static unsigned getEncodedThreadLocalMode(const GlobalValue &GV) {
 529   switch (GV.getThreadLocalMode()) {
 530     case GlobalVariable::NotThreadLocal:         return 0;
 531     case GlobalVariable::GeneralDynamicTLSModel: return 1;
 532     case GlobalVariable::LocalDynamicTLSModel:   return 2;
 533     case GlobalVariable::InitialExecTLSModel:    return 3;
 534     case GlobalVariable::LocalExecTLSModel:      return 4;
 535   }
 536   llvm_unreachable("Invalid TLS model");
 537 }
 538
 539 static unsigned getEncodedComdatSelectionKind(const Comdat &C) {
 540   switch (C.getSelectionKind()) {
 541   case Comdat::Any:
 542     return bitc::COMDAT_SELECTION_KIND_ANY;
 543   case Comdat::ExactMatch:
 544     return bitc::COMDAT_SELECTION_KIND_EXACT_MATCH;
 545   case Comdat::Largest:
 546     return bitc::COMDAT_SELECTION_KIND_LARGEST;
 547   case Comdat::NoDuplicates:
 548     return bitc::COMDAT_SELECTION_KIND_NO_DUPLICATES;
 549   case Comdat::SameSize:
 550     return bitc::COMDAT_SELECTION_KIND_SAME_SIZE;
 551   }
 552   llvm_unreachable("Invalid selection kind");
 553 }
 554
 555 static void writeComdats(const ValueEnumerator &VE, BitstreamWriter &Stream) {
 556   SmallVector<uint16_t, 64> Vals;
 557   for (const Comdat *C : VE.getComdats()) {
 558     // COMDAT: [selection_kind, name]
 559     Vals.push_back(getEncodedComdatSelectionKind(*C));
 560     size_t Size = C->getName().size();
 561     assert(isUInt<16>(Size));
 562     Vals.push_back(Size);
 563     for (char Chr : C->getName())
 564       Vals.push_back((unsigned char)Chr);
 565     Stream.EmitRecord(bitc::MODULE_CODE_COMDAT, Vals, /*AbbrevToUse=*/0);
 566     Vals.clear();
 567   }
 568 }
 569
 570 // Emit top-level description of module, including target triple, inline asm,
 571 // descriptors for global variables, and function prototype info.
 572 static void WriteModuleInfo(const Module *M, const ValueEnumerator &VE,
 573                             BitstreamWriter &Stream) {
 574   // Emit various pieces of data attached to a module.
 575   if (!M->getTargetTriple().empty())
 576     WriteStringRecord(bitc::MODULE_CODE_TRIPLE, M->getTargetTriple(),
 577                       0/*TODO*/, Stream);
 578   const std::string &DL = M->getDataLayoutStr();
 579   if (!DL.empty())
 580     WriteStringRecord(bitc::MODULE_CODE_DATALAYOUT, DL, 0 /*TODO*/, Stream);
 581   if (!M->getModuleInlineAsm().empty())
 582     WriteStringRecord(bitc::MODULE_CODE_ASM, M->getModuleInlineAsm(),
 583                       0/*TODO*/, Stream);
 584
 585   // Emit information about sections and GC, computing how many there are. Also
 586   // compute the maximum alignment value.
 587   std::map<std::string, unsigned> SectionMap;
 588   std::map<std::string, unsigned> GCMap;
 589   unsigned MaxAlignment = 0;
 590   unsigned MaxGlobalType = 0;
 591   for (const GlobalValue &GV : M->globals()) {
 592     MaxAlignment = std::max(MaxAlignment, GV.getAlignment());
 593     MaxGlobalType = std::max(MaxGlobalType, VE.getTypeID(GV.getValueType()));
 594     if (GV.hasSection()) {
 595       // Give section names unique ID's.
 596       unsigned &Entry = SectionMap[GV.getSection()];
 597       if (!Entry) {
 598         WriteStringRecord(bitc::MODULE_CODE_SECTIONNAME, GV.getSection(),
 599                           0/*TODO*/, Stream);
 600         Entry = SectionMap.size();
 601       }
 602     }
 603   }
 604   for (const Function &F : *M) {
 605     MaxAlignment = std::max(MaxAlignment, F.getAlignment());
 606     if (F.hasSection()) {
 607       // Give section names unique ID's.
 608       unsigned &Entry = SectionMap[F.getSection()];
 609       if (!Entry) {
 610         WriteStringRecord(bitc::MODULE_CODE_SECTIONNAME, F.getSection(),
 611                           0/*TODO*/, Stream);
 612         Entry = SectionMap.size();
 613       }
 614     }
 615     if (F.hasGC()) {
 616       // Same for GC names.
 617       unsigned &Entry = GCMap[F.getGC()];
 618       if (!Entry) {
 619         WriteStringRecord(bitc::MODULE_CODE_GCNAME, F.getGC(),
 620                           0/*TODO*/, Stream);
 621         Entry = GCMap.size();
 622       }
 623     }
 624   }
 625
 626   // Emit abbrev for globals, now that we know # sections and max alignment.
 627   unsigned SimpleGVarAbbrev = 0;
 628   if (!M->global_empty()) {
 629     // Add an abbrev for common globals with no visibility or thread localness.
 630     BitCodeAbbrev *Abbv = new BitCodeAbbrev();
 631     Abbv->Add(BitCodeAbbrevOp(bitc::MODULE_CODE_GLOBALVAR));
 632     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
 633                               Log2_32_Ceil(MaxGlobalType+1)));
 634     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // AddrSpace << 2
 635                                                            //| explicitType << 1
 636                                                            //| constant
 637     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // Initializer.
 638     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 5)); // Linkage.
 639     if (MaxAlignment == 0)                                 // Alignment.
 640       Abbv->Add(BitCodeAbbrevOp(0));
 641     else {
 642       unsigned MaxEncAlignment = Log2_32(MaxAlignment)+1;
 643       Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
 644                                Log2_32_Ceil(MaxEncAlignment+1)));
 645     }
 646     if (SectionMap.empty())                                    // Section.
 647       Abbv->Add(BitCodeAbbrevOp(0));
 648     else
 649       Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
 650                                Log2_32_Ceil(SectionMap.size()+1)));
 651     // Don't bother emitting vis + thread local.
 652     SimpleGVarAbbrev = Stream.EmitAbbrev(Abbv);
 653   }
 654
 655   // Emit the global variable information.
 656   SmallVector<unsigned, 64> Vals;
 657   for (const GlobalVariable &GV : M->globals()) {
 658     unsigned AbbrevToUse = 0;
 659
 660     // GLOBALVAR: [type, isconst, initid,
 661     //             linkage, alignment, section, visibility, threadlocal,
 662     //             unnamed_addr, externally_initialized, dllstorageclass,
 663     //             comdat]
 664     Vals.push_back(VE.getTypeID(GV.getValueType()));
 665     Vals.push_back(GV.getType()->getAddressSpace() << 2 | 2 | GV.isConstant());
 666     Vals.push_back(GV.isDeclaration() ? 0 :
 667                    (VE.getValueID(GV.getInitializer()) + 1));
 668     Vals.push_back(getEncodedLinkage(GV));
 669     Vals.push_back(Log2_32(GV.getAlignment())+1);
 670     Vals.push_back(GV.hasSection() ? SectionMap[GV.getSection()] : 0);
 671     if (GV.isThreadLocal() ||
 672         GV.getVisibility() != GlobalValue::DefaultVisibility ||
 673         GV.hasUnnamedAddr() || GV.isExternallyInitialized() ||
 674         GV.getDLLStorageClass() != GlobalValue::DefaultStorageClass ||
 675         GV.hasComdat()) {
 676       Vals.push_back(getEncodedVisibility(GV));
 677       Vals.push_back(getEncodedThreadLocalMode(GV));
 678       Vals.push_back(GV.hasUnnamedAddr());
 679       Vals.push_back(GV.isExternallyInitialized());
 680       Vals.push_back(getEncodedDLLStorageClass(GV));
 681       Vals.push_back(GV.hasComdat() ? VE.getComdatID(GV.getComdat()) : 0);
 682     } else {
 683       AbbrevToUse = SimpleGVarAbbrev;
 684     }
 685
 686     Stream.EmitRecord(bitc::MODULE_CODE_GLOBALVAR, Vals, AbbrevToUse);
 687     Vals.clear();
 688   }
 689
 690   // Emit the function proto information.
 691   for (const Function &F : *M) {
 692     // FUNCTION:  [type, callingconv, isproto, linkage, paramattrs, alignment,
 693     //             section, visibility, gc, unnamed_addr, prologuedata,
 694     //             dllstorageclass, comdat, prefixdata]
 695     Vals.push_back(VE.getTypeID(F.getFunctionType()));
 696     Vals.push_back(F.getCallingConv());
 697     Vals.push_back(F.isDeclaration());
 698     Vals.push_back(getEncodedLinkage(F));
 699     Vals.push_back(VE.getAttributeID(F.getAttributes()));
 700     Vals.push_back(Log2_32(F.getAlignment())+1);
 701     Vals.push_back(F.hasSection() ? SectionMap[F.getSection()] : 0);
 702     Vals.push_back(getEncodedVisibility(F));
 703     Vals.push_back(F.hasGC() ? GCMap[F.getGC()] : 0);
 704     Vals.push_back(F.hasUnnamedAddr());
 705     Vals.push_back(F.hasPrologueData() ? (VE.getValueID(F.getPrologueData()) + 1)
 706                                        : 0);
 707     Vals.push_back(getEncodedDLLStorageClass(F));
 708     Vals.push_back(F.hasComdat() ? VE.getComdatID(F.getComdat()) : 0);
 709     Vals.push_back(F.hasPrefixData() ? (VE.getValueID(F.getPrefixData()) + 1)
 710                                      : 0);
 711
 712     unsigned AbbrevToUse = 0;
 713     Stream.EmitRecord(bitc::MODULE_CODE_FUNCTION, Vals, AbbrevToUse);
 714     Vals.clear();
 715   }
 716
 717   // Emit the alias information.
 718   for (const GlobalAlias &A : M->aliases()) {
 719     // ALIAS: [alias type, aliasee val#, linkage, visibility]
 720     Vals.push_back(VE.getTypeID(A.getType()));
 721     Vals.push_back(VE.getValueID(A.getAliasee()));
 722     Vals.push_back(getEncodedLinkage(A));
 723     Vals.push_back(getEncodedVisibility(A));
 724     Vals.push_back(getEncodedDLLStorageClass(A));
 725     Vals.push_back(getEncodedThreadLocalMode(A));
 726     Vals.push_back(A.hasUnnamedAddr());
 727     unsigned AbbrevToUse = 0;
 728     Stream.EmitRecord(bitc::MODULE_CODE_ALIAS, Vals, AbbrevToUse);
 729     Vals.clear();
 730   }
 731 }
 732
 733 static uint64_t GetOptimizationFlags(const Value *V) {
 734   uint64_t Flags = 0;
 735
 736   if (const auto *OBO = dyn_cast<OverflowingBinaryOperator>(V)) {
 737     if (OBO->hasNoSignedWrap())
 738       Flags |= 1 << bitc::OBO_NO_SIGNED_WRAP;
 739     if (OBO->hasNoUnsignedWrap())
 740       Flags |= 1 << bitc::OBO_NO_UNSIGNED_WRAP;
 741   } else if (const auto *PEO = dyn_cast<PossiblyExactOperator>(V)) {
 742     if (PEO->isExact())
 743       Flags |= 1 << bitc::PEO_EXACT;
 744   } else if (const auto *FPMO = dyn_cast<FPMathOperator>(V)) {
 745     if (FPMO->hasUnsafeAlgebra())
 746       Flags |= FastMathFlags::UnsafeAlgebra;
 747     if (FPMO->hasNoNaNs())
 748       Flags |= FastMathFlags::NoNaNs;
 749     if (FPMO->hasNoInfs())
 750       Flags |= FastMathFlags::NoInfs;
 751     if (FPMO->hasNoSignedZeros())
 752       Flags |= FastMathFlags::NoSignedZeros;
 753     if (FPMO->hasAllowReciprocal())
 754       Flags |= FastMathFlags::AllowReciprocal;
 755   }
 756
 757   return Flags;
 758 }
 759
 760 static void WriteValueAsMetadata(const ValueAsMetadata *MD,
 761                                  const ValueEnumerator &VE,
 762                                  BitstreamWriter &Stream,
 763                                  SmallVectorImpl<uint64_t> &Record) {
 764   // Mimic an MDNode with a value as one operand.
 765   Value *V = MD->getValue();
 766   Record.push_back(VE.getTypeID(V->getType()));
 767   Record.push_back(VE.getValueID(V));
 768   Stream.EmitRecord(bitc::METADATA_VALUE, Record, 0);
 769   Record.clear();
 770 }
 771
 772 static void WriteMDTuple(const MDTuple *N, const ValueEnumerator &VE,
 773                          BitstreamWriter &Stream,
 774                          SmallVectorImpl<uint64_t> &Record, unsigned Abbrev) {
 775   for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
 776     Metadata *MD = N->getOperand(i);
 777     assert(!(MD && isa<LocalAsMetadata>(MD)) &&
 778            "Unexpected function-local metadata");
 779     Record.push_back(VE.getMetadataOrNullID(MD));
 780   }
 781   Stream.EmitRecord(N->isDistinct() ? bitc::METADATA_DISTINCT_NODE
 782                                     : bitc::METADATA_NODE,
 783                     Record, Abbrev);
 784   Record.clear();
 785 }
 786
 787 static void WriteDILocation(const DILocation *N, const ValueEnumerator &VE,
 788                             BitstreamWriter &Stream,
 789                             SmallVectorImpl<uint64_t> &Record,
 790                             unsigned Abbrev) {
 791   Record.push_back(N->isDistinct());
 792   Record.push_back(N->getLine());
 793   Record.push_back(N->getColumn());
 794   Record.push_back(VE.getMetadataID(N->getScope()));
 795   Record.push_back(VE.getMetadataOrNullID(N->getInlinedAt()));
 796
 797   Stream.EmitRecord(bitc::METADATA_LOCATION, Record, Abbrev);
 798   Record.clear();
 799 }
 800
 801 static void WriteGenericDINode(const GenericDINode *N,
 802                                const ValueEnumerator &VE,
 803                                BitstreamWriter &Stream,
 804                                SmallVectorImpl<uint64_t> &Record,
 805                                unsigned Abbrev) {
 806   Record.push_back(N->isDistinct());
 807   Record.push_back(N->getTag());
 808   Record.push_back(0); // Per-tag version field; unused for now.
 809
 810   for (auto &I : N->operands())
 811     Record.push_back(VE.getMetadataOrNullID(I));
 812
 813   Stream.EmitRecord(bitc::METADATA_GENERIC_DEBUG, Record, Abbrev);
 814   Record.clear();
 815 }
 816
 817 static uint64_t rotateSign(int64_t I) {
 818   uint64_t U = I;
 819   return I < 0 ? ~(U << 1) : U << 1;
 820 }
 821
 822 static void WriteDISubrange(const DISubrange *N, const ValueEnumerator &,
 823                             BitstreamWriter &Stream,
 824                             SmallVectorImpl<uint64_t> &Record,
 825                             unsigned Abbrev) {
 826   Record.push_back(N->isDistinct());
 827   Record.push_back(N->getCount());
 828   Record.push_back(rotateSign(N->getLowerBound()));
 829
 830   Stream.EmitRecord(bitc::METADATA_SUBRANGE, Record, Abbrev);
 831   Record.clear();
 832 }
 833
 834 static void WriteDIEnumerator(const DIEnumerator *N, const ValueEnumerator &VE,
 835                               BitstreamWriter &Stream,
 836                               SmallVectorImpl<uint64_t> &Record,
 837                               unsigned Abbrev) {
 838   Record.push_back(N->isDistinct());
 839   Record.push_back(rotateSign(N->getValue()));
 840   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
 841
 842   Stream.EmitRecord(bitc::METADATA_ENUMERATOR, Record, Abbrev);
 843   Record.clear();
 844 }
 845
 846 static void WriteDIBasicType(const DIBasicType *N, const ValueEnumerator &VE,
 847                              BitstreamWriter &Stream,
 848                              SmallVectorImpl<uint64_t> &Record,
 849                              unsigned Abbrev) {
 850   Record.push_back(N->isDistinct());
 851   Record.push_back(N->getTag());
 852   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
 853   Record.push_back(N->getSizeInBits());
 854   Record.push_back(N->getAlignInBits());
 855   Record.push_back(N->getEncoding());
 856
 857   Stream.EmitRecord(bitc::METADATA_BASIC_TYPE, Record, Abbrev);
 858   Record.clear();
 859 }
 860
 861 static void WriteDIDerivedType(const DIDerivedType *N,
 862                                const ValueEnumerator &VE,
 863                                BitstreamWriter &Stream,
 864                                SmallVectorImpl<uint64_t> &Record,
 865                                unsigned Abbrev) {
 866   Record.push_back(N->isDistinct());
 867   Record.push_back(N->getTag());
 868   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
 869   Record.push_back(VE.getMetadataOrNullID(N->getFile()));
 870   Record.push_back(N->getLine());
 871   Record.push_back(VE.getMetadataOrNullID(N->getScope()));
 872   Record.push_back(VE.getMetadataOrNullID(N->getBaseType()));
 873   Record.push_back(N->getSizeInBits());
 874   Record.push_back(N->getAlignInBits());
 875   Record.push_back(N->getOffsetInBits());
 876   Record.push_back(N->getFlags());
 877   Record.push_back(VE.getMetadataOrNullID(N->getExtraData()));
 878
 879   Stream.EmitRecord(bitc::METADATA_DERIVED_TYPE, Record, Abbrev);
 880   Record.clear();
 881 }
 882
 883 static void WriteDICompositeType(const DICompositeType *N,
 884                                  const ValueEnumerator &VE,
 885                                  BitstreamWriter &Stream,
 886                                  SmallVectorImpl<uint64_t> &Record,
 887                                  unsigned Abbrev) {
 888   Record.push_back(N->isDistinct());
 889   Record.push_back(N->getTag());
 890   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
 891   Record.push_back(VE.getMetadataOrNullID(N->getFile()));
 892   Record.push_back(N->getLine());
 893   Record.push_back(VE.getMetadataOrNullID(N->getScope()));
 894   Record.push_back(VE.getMetadataOrNullID(N->getBaseType()));
 895   Record.push_back(N->getSizeInBits());
 896   Record.push_back(N->getAlignInBits());
 897   Record.push_back(N->getOffsetInBits());
 898   Record.push_back(N->getFlags());
 899   Record.push_back(VE.getMetadataOrNullID(N->getElements().get()));
 900   Record.push_back(N->getRuntimeLang());
 901   Record.push_back(VE.getMetadataOrNullID(N->getVTableHolder()));
 902   Record.push_back(VE.getMetadataOrNullID(N->getTemplateParams().get()));
 903   Record.push_back(VE.getMetadataOrNullID(N->getRawIdentifier()));
 904
 905   Stream.EmitRecord(bitc::METADATA_COMPOSITE_TYPE, Record, Abbrev);
 906   Record.clear();
 907 }
 908
 909 static void WriteDISubroutineType(const DISubroutineType *N,
 910                                   const ValueEnumerator &VE,
 911                                   BitstreamWriter &Stream,
 912                                   SmallVectorImpl<uint64_t> &Record,
 913                                   unsigned Abbrev) {
 914   Record.push_back(N->isDistinct());
 915   Record.push_back(N->getFlags());
 916   Record.push_back(VE.getMetadataOrNullID(N->getTypeArray().get()));
 917
 918   Stream.EmitRecord(bitc::METADATA_SUBROUTINE_TYPE, Record, Abbrev);
 919   Record.clear();
 920 }
 921
 922 static void WriteDIFile(const DIFile *N, const ValueEnumerator &VE,
 923                         BitstreamWriter &Stream,
 924                         SmallVectorImpl<uint64_t> &Record, unsigned Abbrev) {
 925   Record.push_back(N->isDistinct());
 926   Record.push_back(VE.getMetadataOrNullID(N->getRawFilename()));
 927   Record.push_back(VE.getMetadataOrNullID(N->getRawDirectory()));
 928
 929   Stream.EmitRecord(bitc::METADATA_FILE, Record, Abbrev);
 930   Record.clear();
 931 }
 932
 933 static void WriteDICompileUnit(const DICompileUnit *N,
 934                                const ValueEnumerator &VE,
 935                                BitstreamWriter &Stream,
 936                                SmallVectorImpl<uint64_t> &Record,
 937                                unsigned Abbrev) {
 938   Record.push_back(N->isDistinct());
 939   Record.push_back(N->getSourceLanguage());
 940   Record.push_back(VE.getMetadataOrNullID(N->getFile()));
 941   Record.push_back(VE.getMetadataOrNullID(N->getRawProducer()));
 942   Record.push_back(N->isOptimized());
 943   Record.push_back(VE.getMetadataOrNullID(N->getRawFlags()));
 944   Record.push_back(N->getRuntimeVersion());
 945   Record.push_back(VE.getMetadataOrNullID(N->getRawSplitDebugFilename()));
 946   Record.push_back(N->getEmissionKind());
 947   Record.push_back(VE.getMetadataOrNullID(N->getEnumTypes().get()));
 948   Record.push_back(VE.getMetadataOrNullID(N->getRetainedTypes().get()));
 949   Record.push_back(VE.getMetadataOrNullID(N->getSubprograms().get()));
 950   Record.push_back(VE.getMetadataOrNullID(N->getGlobalVariables().get()));
 951   Record.push_back(VE.getMetadataOrNullID(N->getImportedEntities().get()));
 952
 953   Stream.EmitRecord(bitc::METADATA_COMPILE_UNIT, Record, Abbrev);
 954   Record.clear();
 955 }
 956
 957 static void WriteDISubprogram(const DISubprogram *N, const ValueEnumerator &VE,
 958                               BitstreamWriter &Stream,
 959                               SmallVectorImpl<uint64_t> &Record,
 960                               unsigned Abbrev) {
 961   Record.push_back(N->isDistinct());
 962   Record.push_back(VE.getMetadataOrNullID(N->getScope()));
 963   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
 964   Record.push_back(VE.getMetadataOrNullID(N->getRawLinkageName()));
 965   Record.push_back(VE.getMetadataOrNullID(N->getFile()));
 966   Record.push_back(N->getLine());
 967   Record.push_back(VE.getMetadataOrNullID(N->getType()));
 968   Record.push_back(N->isLocalToUnit());
 969   Record.push_back(N->isDefinition());
 970   Record.push_back(N->getScopeLine());
 971   Record.push_back(VE.getMetadataOrNullID(N->getContainingType()));
 972   Record.push_back(N->getVirtuality());
 973   Record.push_back(N->getVirtualIndex());
 974   Record.push_back(N->getFlags());
 975   Record.push_back(N->isOptimized());
 976   Record.push_back(VE.getMetadataOrNullID(N->getRawFunction()));
 977   Record.push_back(VE.getMetadataOrNullID(N->getTemplateParams().get()));
 978   Record.push_back(VE.getMetadataOrNullID(N->getDeclaration()));
 979   Record.push_back(VE.getMetadataOrNullID(N->getVariables().get()));
 980
 981   Stream.EmitRecord(bitc::METADATA_SUBPROGRAM, Record, Abbrev);
 982   Record.clear();
 983 }
 984
 985 static void WriteDILexicalBlock(const DILexicalBlock *N,
 986                                 const ValueEnumerator &VE,
 987                                 BitstreamWriter &Stream,
 988                                 SmallVectorImpl<uint64_t> &Record,
 989                                 unsigned Abbrev) {
 990   Record.push_back(N->isDistinct());
 991   Record.push_back(VE.getMetadataOrNullID(N->getScope()));
 992   Record.push_back(VE.getMetadataOrNullID(N->getFile()));
 993   Record.push_back(N->getLine());
 994   Record.push_back(N->getColumn());
 995
 996   Stream.EmitRecord(bitc::METADATA_LEXICAL_BLOCK, Record, Abbrev);
 997   Record.clear();
 998 }
 999
1000 static void WriteDILexicalBlockFile(const DILexicalBlockFile *N,
1001                                     const ValueEnumerator &VE,
1002                                     BitstreamWriter &Stream,
1003                                     SmallVectorImpl<uint64_t> &Record,
1004                                     unsigned Abbrev) {
1005   Record.push_back(N->isDistinct());
1006   Record.push_back(VE.getMetadataOrNullID(N->getScope()));
1007   Record.push_back(VE.getMetadataOrNullID(N->getFile()));
1008   Record.push_back(N->getDiscriminator());
1009
1010   Stream.EmitRecord(bitc::METADATA_LEXICAL_BLOCK_FILE, Record, Abbrev);
1011   Record.clear();
1012 }
1013
1014 static void WriteDINamespace(const DINamespace *N, const ValueEnumerator &VE,
1015                              BitstreamWriter &Stream,
1016                              SmallVectorImpl<uint64_t> &Record,
1017                              unsigned Abbrev) {
1018   Record.push_back(N->isDistinct());
1019   Record.push_back(VE.getMetadataOrNullID(N->getScope()));
1020   Record.push_back(VE.getMetadataOrNullID(N->getFile()));
1021   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1022   Record.push_back(N->getLine());
1023
1024   Stream.EmitRecord(bitc::METADATA_NAMESPACE, Record, Abbrev);
1025   Record.clear();
1026 }
1027
1028 static void WriteDITemplateTypeParameter(const DITemplateTypeParameter *N,
1029                                          const ValueEnumerator &VE,
1030                                          BitstreamWriter &Stream,
1031                                          SmallVectorImpl<uint64_t> &Record,
1032                                          unsigned Abbrev) {
1033   Record.push_back(N->isDistinct());
1034   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1035   Record.push_back(VE.getMetadataOrNullID(N->getType()));
1036
1037   Stream.EmitRecord(bitc::METADATA_TEMPLATE_TYPE, Record, Abbrev);
1038   Record.clear();
1039 }
1040
1041 static void WriteDITemplateValueParameter(const DITemplateValueParameter *N,
1042                                           const ValueEnumerator &VE,
1043                                           BitstreamWriter &Stream,
1044                                           SmallVectorImpl<uint64_t> &Record,
1045                                           unsigned Abbrev) {
1046   Record.push_back(N->isDistinct());
1047   Record.push_back(N->getTag());
1048   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1049   Record.push_back(VE.getMetadataOrNullID(N->getType()));
1050   Record.push_back(VE.getMetadataOrNullID(N->getValue()));
1051
1052   Stream.EmitRecord(bitc::METADATA_TEMPLATE_VALUE, Record, Abbrev);
1053   Record.clear();
1054 }
1055
1056 static void WriteDIGlobalVariable(const DIGlobalVariable *N,
1057                                   const ValueEnumerator &VE,
1058                                   BitstreamWriter &Stream,
1059                                   SmallVectorImpl<uint64_t> &Record,
1060                                   unsigned Abbrev) {
1061   Record.push_back(N->isDistinct());
1062   Record.push_back(VE.getMetadataOrNullID(N->getScope()));
1063   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1064   Record.push_back(VE.getMetadataOrNullID(N->getRawLinkageName()));
1065   Record.push_back(VE.getMetadataOrNullID(N->getFile()));
1066   Record.push_back(N->getLine());
1067   Record.push_back(VE.getMetadataOrNullID(N->getType()));
1068   Record.push_back(N->isLocalToUnit());
1069   Record.push_back(N->isDefinition());
1070   Record.push_back(VE.getMetadataOrNullID(N->getRawVariable()));
1071   Record.push_back(VE.getMetadataOrNullID(N->getStaticDataMemberDeclaration()));
1072
1073   Stream.EmitRecord(bitc::METADATA_GLOBAL_VAR, Record, Abbrev);
1074   Record.clear();
1075 }
1076
1077 static void WriteDILocalVariable(const DILocalVariable *N,
1078                                  const ValueEnumerator &VE,
1079                                  BitstreamWriter &Stream,
1080                                  SmallVectorImpl<uint64_t> &Record,
1081                                  unsigned Abbrev) {
1082   Record.push_back(N->isDistinct());
1083   Record.push_back(N->getTag());
1084   Record.push_back(VE.getMetadataOrNullID(N->getScope()));
1085   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1086   Record.push_back(VE.getMetadataOrNullID(N->getFile()));
1087   Record.push_back(N->getLine());
1088   Record.push_back(VE.getMetadataOrNullID(N->getType()));
1089   Record.push_back(N->getArg());
1090   Record.push_back(N->getFlags());
1091
1092   Stream.EmitRecord(bitc::METADATA_LOCAL_VAR, Record, Abbrev);
1093   Record.clear();
1094 }
1095
1096 static void WriteDIExpression(const DIExpression *N, const ValueEnumerator &,
1097                               BitstreamWriter &Stream,
1098                               SmallVectorImpl<uint64_t> &Record,
1099                               unsigned Abbrev) {
1100   Record.reserve(N->getElements().size() + 1);
1101
1102   Record.push_back(N->isDistinct());
1103   Record.append(N->elements_begin(), N->elements_end());
1104
1105   Stream.EmitRecord(bitc::METADATA_EXPRESSION, Record, Abbrev);
1106   Record.clear();
1107 }
1108
1109 static void WriteDIObjCProperty(const DIObjCProperty *N,
1110                                 const ValueEnumerator &VE,
1111                                 BitstreamWriter &Stream,
1112                                 SmallVectorImpl<uint64_t> &Record,
1113                                 unsigned Abbrev) {
1114   Record.push_back(N->isDistinct());
1115   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1116   Record.push_back(VE.getMetadataOrNullID(N->getFile()));
1117   Record.push_back(N->getLine());
1118   Record.push_back(VE.getMetadataOrNullID(N->getRawSetterName()));
1119   Record.push_back(VE.getMetadataOrNullID(N->getRawGetterName()));
1120   Record.push_back(N->getAttributes());
1121   Record.push_back(VE.getMetadataOrNullID(N->getType()));
1122
1123   Stream.EmitRecord(bitc::METADATA_OBJC_PROPERTY, Record, Abbrev);
1124   Record.clear();
1125 }
1126
1127 static void WriteDIImportedEntity(const DIImportedEntity *N,
1128                                   const ValueEnumerator &VE,
1129                                   BitstreamWriter &Stream,
1130                                   SmallVectorImpl<uint64_t> &Record,
1131                                   unsigned Abbrev) {
1132   Record.push_back(N->isDistinct());
1133   Record.push_back(N->getTag());
1134   Record.push_back(VE.getMetadataOrNullID(N->getScope()));
1135   Record.push_back(VE.getMetadataOrNullID(N->getEntity()));
1136   Record.push_back(N->getLine());
1137   Record.push_back(VE.getMetadataOrNullID(N->getRawName()));
1138
1139   Stream.EmitRecord(bitc::METADATA_IMPORTED_ENTITY, Record, Abbrev);
1140   Record.clear();
1141 }
1142
1143 static void WriteModuleMetadata(const Module *M,
1144                                 const ValueEnumerator &VE,
1145                                 BitstreamWriter &Stream) {
1146   const auto &MDs = VE.getMDs();
1147   if (MDs.empty() && M->named_metadata_empty())
1148     return;
1149
1150   Stream.EnterSubblock(bitc::METADATA_BLOCK_ID, 3);
1151
1152   unsigned MDSAbbrev = 0;
1153   if (VE.hasMDString()) {
1154     // Abbrev for METADATA_STRING.
1155     BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1156     Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_STRING));
1157     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1158     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
1159     MDSAbbrev = Stream.EmitAbbrev(Abbv);
1160   }
1161
1162   // Initialize MDNode abbreviations.
1163 #define HANDLE_MDNODE_LEAF(CLASS) unsigned CLASS##Abbrev = 0;
1164 #include "llvm/IR/Metadata.def"
1165
1166   if (VE.hasDILocation()) {
1167     // Abbrev for METADATA_LOCATION.
1168     //
1169     // Assume the column is usually under 128, and always output the inlined-at
1170     // location (it's never more expensive than building an array size 1).
1171     BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1172     Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_LOCATION));
1173     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));
1174     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
1175     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
1176     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
1177     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
1178     DILocationAbbrev = Stream.EmitAbbrev(Abbv);
1179   }
1180
1181   if (VE.hasGenericDINode()) {
1182     // Abbrev for METADATA_GENERIC_DEBUG.
1183     //
1184     // Assume the column is usually under 128, and always output the inlined-at
1185     // location (it's never more expensive than building an array size 1).
1186     BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1187     Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_GENERIC_DEBUG));
1188     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));
1189     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
1190     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));
1191     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
1192     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1193     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
1194     GenericDINodeAbbrev = Stream.EmitAbbrev(Abbv);
1195   }
1196
1197   unsigned NameAbbrev = 0;
1198   if (!M->named_metadata_empty()) {
1199     // Abbrev for METADATA_NAME.
1200     BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1201     Abbv->Add(BitCodeAbbrevOp(bitc::METADATA_NAME));
1202     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1203     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
1204     NameAbbrev = Stream.EmitAbbrev(Abbv);
1205   }
1206
1207   SmallVector<uint64_t, 64> Record;
1208   for (const Metadata *MD : MDs) {
1209     if (const MDNode *N = dyn_cast<MDNode>(MD)) {
1210       assert(N->isResolved() && "Expected forward references to be resolved");
1211
1212       switch (N->getMetadataID()) {
1213       default:
1214         llvm_unreachable("Invalid MDNode subclass");
1215 #define HANDLE_MDNODE_LEAF(CLASS)                                              \
1216   case Metadata::CLASS##Kind:                                                  \
1217     Write##CLASS(cast<CLASS>(N), VE, Stream, Record, CLASS##Abbrev);           \
1218     continue;
1219 #include "llvm/IR/Metadata.def"
1220       }
1221     }
1222     if (const auto *MDC = dyn_cast<ConstantAsMetadata>(MD)) {
1223       WriteValueAsMetadata(MDC, VE, Stream, Record);
1224       continue;
1225     }
1226     const MDString *MDS = cast<MDString>(MD);
1227     // Code: [strchar x N]
1228     Record.append(MDS->bytes_begin(), MDS->bytes_end());
1229
1230     // Emit the finished record.
1231     Stream.EmitRecord(bitc::METADATA_STRING, Record, MDSAbbrev);
1232     Record.clear();
1233   }
1234
1235   // Write named metadata.
1236   for (const NamedMDNode &NMD : M->named_metadata()) {
1237     // Write name.
1238     StringRef Str = NMD.getName();
1239     Record.append(Str.bytes_begin(), Str.bytes_end());
1240     Stream.EmitRecord(bitc::METADATA_NAME, Record, NameAbbrev);
1241     Record.clear();
1242
1243     // Write named metadata operands.
1244     for (const MDNode *N : NMD.operands())
1245       Record.push_back(VE.getMetadataID(N));
1246     Stream.EmitRecord(bitc::METADATA_NAMED_NODE, Record, 0);
1247     Record.clear();
1248   }
1249
1250   Stream.ExitBlock();
1251 }
1252
1253 static void WriteFunctionLocalMetadata(const Function &F,
1254                                        const ValueEnumerator &VE,
1255                                        BitstreamWriter &Stream) {
1256   bool StartedMetadataBlock = false;
1257   SmallVector<uint64_t, 64> Record;
1258   const SmallVectorImpl<const LocalAsMetadata *> &MDs =
1259       VE.getFunctionLocalMDs();
1260   for (unsigned i = 0, e = MDs.size(); i != e; ++i) {
1261     assert(MDs[i] && "Expected valid function-local metadata");
1262     if (!StartedMetadataBlock) {
1263       Stream.EnterSubblock(bitc::METADATA_BLOCK_ID, 3);
1264       StartedMetadataBlock = true;
1265     }
1266     WriteValueAsMetadata(MDs[i], VE, Stream, Record);
1267   }
1268
1269   if (StartedMetadataBlock)
1270     Stream.ExitBlock();
1271 }
1272
1273 static void WriteMetadataAttachment(const Function &F,
1274                                     const ValueEnumerator &VE,
1275                                     BitstreamWriter &Stream) {
1276   Stream.EnterSubblock(bitc::METADATA_ATTACHMENT_ID, 3);
1277
1278   SmallVector<uint64_t, 64> Record;
1279
1280   // Write metadata attachments
1281   // METADATA_ATTACHMENT - [m x [value, [n x [id, mdnode]]]
1282   SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1283   F.getAllMetadata(MDs);
1284   if (!MDs.empty()) {
1285     for (const auto &I : MDs) {
1286       Record.push_back(I.first);
1287       Record.push_back(VE.getMetadataID(I.second));
1288     }
1289     Stream.EmitRecord(bitc::METADATA_ATTACHMENT, Record, 0);
1290     Record.clear();
1291   }
1292
1293   for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
1294     for (BasicBlock::const_iterator I = BB->begin(), E = BB->end();
1295          I != E; ++I) {
1296       MDs.clear();
1297       I->getAllMetadataOtherThanDebugLoc(MDs);
1298
1299       // If no metadata, ignore instruction.
1300       if (MDs.empty()) continue;
1301
1302       Record.push_back(VE.getInstructionID(I));
1303
1304       for (unsigned i = 0, e = MDs.size(); i != e; ++i) {
1305         Record.push_back(MDs[i].first);
1306         Record.push_back(VE.getMetadataID(MDs[i].second));
1307       }
1308       Stream.EmitRecord(bitc::METADATA_ATTACHMENT, Record, 0);
1309       Record.clear();
1310     }
1311
1312   Stream.ExitBlock();
1313 }
1314
1315 static void WriteModuleMetadataStore(const Module *M, BitstreamWriter &Stream) {
1316   SmallVector<uint64_t, 64> Record;
1317
1318   // Write metadata kinds
1319   // METADATA_KIND - [n x [id, name]]
1320   SmallVector<StringRef, 8> Names;
1321   M->getMDKindNames(Names);
1322
1323   if (Names.empty()) return;
1324
1325   Stream.EnterSubblock(bitc::METADATA_BLOCK_ID, 3);
1326
1327   for (unsigned MDKindID = 0, e = Names.size(); MDKindID != e; ++MDKindID) {
1328     Record.push_back(MDKindID);
1329     StringRef KName = Names[MDKindID];
1330     Record.append(KName.begin(), KName.end());
1331
1332     Stream.EmitRecord(bitc::METADATA_KIND, Record, 0);
1333     Record.clear();
1334   }
1335
1336   Stream.ExitBlock();
1337 }
1338
1339 static void emitSignedInt64(SmallVectorImpl<uint64_t> &Vals, uint64_t V) {
1340   if ((int64_t)V >= 0)
1341     Vals.push_back(V << 1);
1342   else
1343     Vals.push_back((-V << 1) | 1);
1344 }
1345
1346 static void WriteConstants(unsigned FirstVal, unsigned LastVal,
1347                            const ValueEnumerator &VE,
1348                            BitstreamWriter &Stream, bool isGlobal) {
1349   if (FirstVal == LastVal) return;
1350
1351   Stream.EnterSubblock(bitc::CONSTANTS_BLOCK_ID, 4);
1352
1353   unsigned AggregateAbbrev = 0;
1354   unsigned String8Abbrev = 0;
1355   unsigned CString7Abbrev = 0;
1356   unsigned CString6Abbrev = 0;
1357   // If this is a constant pool for the module, emit module-specific abbrevs.
1358   if (isGlobal) {
1359     // Abbrev for CST_CODE_AGGREGATE.
1360     BitCodeAbbrev *Abbv = new BitCodeAbbrev();
1361     Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_AGGREGATE));
1362     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1363     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, Log2_32_Ceil(LastVal+1)));
1364     AggregateAbbrev = Stream.EmitAbbrev(Abbv);
1365
1366     // Abbrev for CST_CODE_STRING.
1367     Abbv = new BitCodeAbbrev();
1368     Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_STRING));
1369     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1370     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
1371     String8Abbrev = Stream.EmitAbbrev(Abbv);
1372     // Abbrev for CST_CODE_CSTRING.
1373     Abbv = new BitCodeAbbrev();
1374     Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_CSTRING));
1375     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1376     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7));
1377     CString7Abbrev = Stream.EmitAbbrev(Abbv);
1378     // Abbrev for CST_CODE_CSTRING.
1379     Abbv = new BitCodeAbbrev();
1380     Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_CSTRING));
1381     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1382     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
1383     CString6Abbrev = Stream.EmitAbbrev(Abbv);
1384   }
1385
1386   SmallVector<uint64_t, 64> Record;
1387
1388   const ValueEnumerator::ValueList &Vals = VE.getValues();
1389   Type *LastTy = nullptr;
1390   for (unsigned i = FirstVal; i != LastVal; ++i) {
1391     const Value *V = Vals[i].first;
1392     // If we need to switch types, do so now.
1393     if (V->getType() != LastTy) {
1394       LastTy = V->getType();
1395       Record.push_back(VE.getTypeID(LastTy));
1396       Stream.EmitRecord(bitc::CST_CODE_SETTYPE, Record,
1397                         CONSTANTS_SETTYPE_ABBREV);
1398       Record.clear();
1399     }
1400
1401     if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
1402       Record.push_back(unsigned(IA->hasSideEffects()) |
1403                        unsigned(IA->isAlignStack()) << 1 |
1404                        unsigned(IA->getDialect()&1) << 2);
1405
1406       // Add the asm string.
1407       const std::string &AsmStr = IA->getAsmString();
1408       Record.push_back(AsmStr.size());
1409       Record.append(AsmStr.begin(), AsmStr.end());
1410
1411       // Add the constraint string.
1412       const std::string &ConstraintStr = IA->getConstraintString();
1413       Record.push_back(ConstraintStr.size());
1414       Record.append(ConstraintStr.begin(), ConstraintStr.end());
1415       Stream.EmitRecord(bitc::CST_CODE_INLINEASM, Record);
1416       Record.clear();
1417       continue;
1418     }
1419     const Constant *C = cast<Constant>(V);
1420     unsigned Code = -1U;
1421     unsigned AbbrevToUse = 0;
1422     if (C->isNullValue()) {
1423       Code = bitc::CST_CODE_NULL;
1424     } else if (isa<UndefValue>(C)) {
1425       Code = bitc::CST_CODE_UNDEF;
1426     } else if (const ConstantInt *IV = dyn_cast<ConstantInt>(C)) {
1427       if (IV->getBitWidth() <= 64) {
1428         uint64_t V = IV->getSExtValue();
1429         emitSignedInt64(Record, V);
1430         Code = bitc::CST_CODE_INTEGER;
1431         AbbrevToUse = CONSTANTS_INTEGER_ABBREV;
1432       } else {                             // Wide integers, > 64 bits in size.
1433         // We have an arbitrary precision integer value to write whose
1434         // bit width is > 64. However, in canonical unsigned integer
1435         // format it is likely that the high bits are going to be zero.
1436         // So, we only write the number of active words.
1437         unsigned NWords = IV->getValue().getActiveWords();
1438         const uint64_t *RawWords = IV->getValue().getRawData();
1439         for (unsigned i = 0; i != NWords; ++i) {
1440           emitSignedInt64(Record, RawWords[i]);
1441         }
1442         Code = bitc::CST_CODE_WIDE_INTEGER;
1443       }
1444     } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(C)) {
1445       Code = bitc::CST_CODE_FLOAT;
1446       Type *Ty = CFP->getType();
1447       if (Ty->isHalfTy() || Ty->isFloatTy() || Ty->isDoubleTy()) {
1448         Record.push_back(CFP->getValueAPF().bitcastToAPInt().getZExtValue());
1449       } else if (Ty->isX86_FP80Ty()) {
1450         // api needed to prevent premature destruction
1451         // bits are not in the same order as a normal i80 APInt, compensate.
1452         APInt api = CFP->getValueAPF().bitcastToAPInt();
1453         const uint64_t *p = api.getRawData();
1454         Record.push_back((p[1] << 48) | (p[0] >> 16));
1455         Record.push_back(p[0] & 0xffffLL);
1456       } else if (Ty->isFP128Ty() || Ty->isPPC_FP128Ty()) {
1457         APInt api = CFP->getValueAPF().bitcastToAPInt();
1458         const uint64_t *p = api.getRawData();
1459         Record.push_back(p[0]);
1460         Record.push_back(p[1]);
1461       } else {
1462         assert (0 && "Unknown FP type!");
1463       }
1464     } else if (isa<ConstantDataSequential>(C) &&
1465                cast<ConstantDataSequential>(C)->isString()) {
1466       const ConstantDataSequential *Str = cast<ConstantDataSequential>(C);
1467       // Emit constant strings specially.
1468       unsigned NumElts = Str->getNumElements();
1469       // If this is a null-terminated string, use the denser CSTRING encoding.
1470       if (Str->isCString()) {
1471         Code = bitc::CST_CODE_CSTRING;
1472         --NumElts;  // Don't encode the null, which isn't allowed by char6.
1473       } else {
1474         Code = bitc::CST_CODE_STRING;
1475         AbbrevToUse = String8Abbrev;
1476       }
1477       bool isCStr7 = Code == bitc::CST_CODE_CSTRING;
1478       bool isCStrChar6 = Code == bitc::CST_CODE_CSTRING;
1479       for (unsigned i = 0; i != NumElts; ++i) {
1480         unsigned char V = Str->getElementAsInteger(i);
1481         Record.push_back(V);
1482         isCStr7 &= (V & 128) == 0;
1483         if (isCStrChar6)
1484           isCStrChar6 = BitCodeAbbrevOp::isChar6(V);
1485       }
1486
1487       if (isCStrChar6)
1488         AbbrevToUse = CString6Abbrev;
1489       else if (isCStr7)
1490         AbbrevToUse = CString7Abbrev;
1491     } else if (const ConstantDataSequential *CDS =
1492                   dyn_cast<ConstantDataSequential>(C)) {
1493       Code = bitc::CST_CODE_DATA;
1494       Type *EltTy = CDS->getType()->getElementType();
1495       if (isa<IntegerType>(EltTy)) {
1496         for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i)
1497           Record.push_back(CDS->getElementAsInteger(i));
1498       } else if (EltTy->isFloatTy()) {
1499         for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1500           union { float F; uint32_t I; };
1501           F = CDS->getElementAsFloat(i);
1502           Record.push_back(I);
1503         }
1504       } else {
1505         assert(EltTy->isDoubleTy() && "Unknown ConstantData element type");
1506         for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1507           union { double F; uint64_t I; };
1508           F = CDS->getElementAsDouble(i);
1509           Record.push_back(I);
1510         }
1511       }
1512     } else if (isa<ConstantArray>(C) || isa<ConstantStruct>(C) ||
1513                isa<ConstantVector>(C)) {
1514       Code = bitc::CST_CODE_AGGREGATE;
1515       for (unsigned i = 0, e = C->getNumOperands(); i != e; ++i)
1516         Record.push_back(VE.getValueID(C->getOperand(i)));
1517       AbbrevToUse = AggregateAbbrev;
1518     } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
1519       switch (CE->getOpcode()) {
1520       default:
1521         if (Instruction::isCast(CE->getOpcode())) {
1522           Code = bitc::CST_CODE_CE_CAST;
1523           Record.push_back(GetEncodedCastOpcode(CE->getOpcode()));
1524           Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
1525           Record.push_back(VE.getValueID(C->getOperand(0)));
1526           AbbrevToUse = CONSTANTS_CE_CAST_Abbrev;
1527         } else {
1528           assert(CE->getNumOperands() == 2 && "Unknown constant expr!");
1529           Code = bitc::CST_CODE_CE_BINOP;
1530           Record.push_back(GetEncodedBinaryOpcode(CE->getOpcode()));
1531           Record.push_back(VE.getValueID(C->getOperand(0)));
1532           Record.push_back(VE.getValueID(C->getOperand(1)));
1533           uint64_t Flags = GetOptimizationFlags(CE);
1534           if (Flags != 0)
1535             Record.push_back(Flags);
1536         }
1537         break;
1538       case Instruction::GetElementPtr: {
1539         Code = bitc::CST_CODE_CE_GEP;
1540         const auto *GO = cast<GEPOperator>(C);
1541         if (GO->isInBounds())
1542           Code = bitc::CST_CODE_CE_INBOUNDS_GEP;
1543         Record.push_back(VE.getTypeID(GO->getSourceElementType()));
1544         for (unsigned i = 0, e = CE->getNumOperands(); i != e; ++i) {
1545           Record.push_back(VE.getTypeID(C->getOperand(i)->getType()));
1546           Record.push_back(VE.getValueID(C->getOperand(i)));
1547         }
1548         break;
1549       }
1550       case Instruction::Select:
1551         Code = bitc::CST_CODE_CE_SELECT;
1552         Record.push_back(VE.getValueID(C->getOperand(0)));
1553         Record.push_back(VE.getValueID(C->getOperand(1)));
1554         Record.push_back(VE.getValueID(C->getOperand(2)));
1555         break;
1556       case Instruction::ExtractElement:
1557         Code = bitc::CST_CODE_CE_EXTRACTELT;
1558         Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
1559         Record.push_back(VE.getValueID(C->getOperand(0)));
1560         Record.push_back(VE.getTypeID(C->getOperand(1)->getType()));
1561         Record.push_back(VE.getValueID(C->getOperand(1)));
1562         break;
1563       case Instruction::InsertElement:
1564         Code = bitc::CST_CODE_CE_INSERTELT;
1565         Record.push_back(VE.getValueID(C->getOperand(0)));
1566         Record.push_back(VE.getValueID(C->getOperand(1)));
1567         Record.push_back(VE.getTypeID(C->getOperand(2)->getType()));
1568         Record.push_back(VE.getValueID(C->getOperand(2)));
1569         break;
1570       case Instruction::ShuffleVector:
1571         // If the return type and argument types are the same, this is a
1572         // standard shufflevector instruction.  If the types are different,
1573         // then the shuffle is widening or truncating the input vectors, and
1574         // the argument type must also be encoded.
1575         if (C->getType() == C->getOperand(0)->getType()) {
1576           Code = bitc::CST_CODE_CE_SHUFFLEVEC;
1577         } else {
1578           Code = bitc::CST_CODE_CE_SHUFVEC_EX;
1579           Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
1580         }
1581         Record.push_back(VE.getValueID(C->getOperand(0)));
1582         Record.push_back(VE.getValueID(C->getOperand(1)));
1583         Record.push_back(VE.getValueID(C->getOperand(2)));
1584         break;
1585       case Instruction::ICmp:
1586       case Instruction::FCmp:
1587         Code = bitc::CST_CODE_CE_CMP;
1588         Record.push_back(VE.getTypeID(C->getOperand(0)->getType()));
1589         Record.push_back(VE.getValueID(C->getOperand(0)));
1590         Record.push_back(VE.getValueID(C->getOperand(1)));
1591         Record.push_back(CE->getPredicate());
1592         break;
1593       }
1594     } else if (const BlockAddress *BA = dyn_cast<BlockAddress>(C)) {
1595       Code = bitc::CST_CODE_BLOCKADDRESS;
1596       Record.push_back(VE.getTypeID(BA->getFunction()->getType()));
1597       Record.push_back(VE.getValueID(BA->getFunction()));
1598       Record.push_back(VE.getGlobalBasicBlockID(BA->getBasicBlock()));
1599     } else {
1600 #ifndef NDEBUG
1601       C->dump();
1602 #endif
1603       llvm_unreachable("Unknown constant!");
1604     }
1605     Stream.EmitRecord(Code, Record, AbbrevToUse);
1606     Record.clear();
1607   }
1608
1609   Stream.ExitBlock();
1610 }
1611
1612 static void WriteModuleConstants(const ValueEnumerator &VE,
1613                                  BitstreamWriter &Stream) {
1614   const ValueEnumerator::ValueList &Vals = VE.getValues();
1615
1616   // Find the first constant to emit, which is the first non-globalvalue value.
1617   // We know globalvalues have been emitted by WriteModuleInfo.
1618   for (unsigned i = 0, e = Vals.size(); i != e; ++i) {
1619     if (!isa<GlobalValue>(Vals[i].first)) {
1620       WriteConstants(i, Vals.size(), VE, Stream, true);
1621       return;
1622     }
1623   }
1624 }
1625
1626 /// PushValueAndType - The file has to encode both the value and type id for
1627 /// many values, because we need to know what type to create for forward
1628 /// references.  However, most operands are not forward references, so this type
1629 /// field is not needed.
1630 ///
1631 /// This function adds V's value ID to Vals.  If the value ID is higher than the
1632 /// instruction ID, then it is a forward reference, and it also includes the
1633 /// type ID.  The value ID that is written is encoded relative to the InstID.
1634 static bool PushValueAndType(const Value *V, unsigned InstID,
1635                              SmallVectorImpl<unsigned> &Vals,
1636                              ValueEnumerator &VE) {
1637   unsigned ValID = VE.getValueID(V);
1638   // Make encoding relative to the InstID.
1639   Vals.push_back(InstID - ValID);
1640   if (ValID >= InstID) {
1641     Vals.push_back(VE.getTypeID(V->getType()));
1642     return true;
1643   }
1644   return false;
1645 }
1646
1647 /// pushValue - Like PushValueAndType, but where the type of the value is
1648 /// omitted (perhaps it was already encoded in an earlier operand).
1649 static void pushValue(const Value *V, unsigned InstID,
1650                       SmallVectorImpl<unsigned> &Vals,
1651                       ValueEnumerator &VE) {
1652   unsigned ValID = VE.getValueID(V);
1653   Vals.push_back(InstID - ValID);
1654 }
1655
1656 static void pushValueSigned(const Value *V, unsigned InstID,
1657                             SmallVectorImpl<uint64_t> &Vals,
1658                             ValueEnumerator &VE) {
1659   unsigned ValID = VE.getValueID(V);
1660   int64_t diff = ((int32_t)InstID - (int32_t)ValID);
1661   emitSignedInt64(Vals, diff);
1662 }
1663
1664 /// WriteInstruction - Emit an instruction to the specified stream.
1665 static void WriteInstruction(const Instruction &I, unsigned InstID,
1666                              ValueEnumerator &VE, BitstreamWriter &Stream,
1667                              SmallVectorImpl<unsigned> &Vals) {
1668   unsigned Code = 0;
1669   unsigned AbbrevToUse = 0;
1670   VE.setInstructionID(&I);
1671   switch (I.getOpcode()) {
1672   default:
1673     if (Instruction::isCast(I.getOpcode())) {
1674       Code = bitc::FUNC_CODE_INST_CAST;
1675       if (!PushValueAndType(I.getOperand(0), InstID, Vals, VE))
1676         AbbrevToUse = FUNCTION_INST_CAST_ABBREV;
1677       Vals.push_back(VE.getTypeID(I.getType()));
1678       Vals.push_back(GetEncodedCastOpcode(I.getOpcode()));
1679     } else {
1680       assert(isa<BinaryOperator>(I) && "Unknown instruction!");
1681       Code = bitc::FUNC_CODE_INST_BINOP;
1682       if (!PushValueAndType(I.getOperand(0), InstID, Vals, VE))
1683         AbbrevToUse = FUNCTION_INST_BINOP_ABBREV;
1684       pushValue(I.getOperand(1), InstID, Vals, VE);
1685       Vals.push_back(GetEncodedBinaryOpcode(I.getOpcode()));
1686       uint64_t Flags = GetOptimizationFlags(&I);
1687       if (Flags != 0) {
1688         if (AbbrevToUse == FUNCTION_INST_BINOP_ABBREV)
1689           AbbrevToUse = FUNCTION_INST_BINOP_FLAGS_ABBREV;
1690         Vals.push_back(Flags);
1691       }
1692     }
1693     break;
1694
1695   case Instruction::GetElementPtr: {
1696     Code = bitc::FUNC_CODE_INST_GEP;
1697     AbbrevToUse = FUNCTION_INST_GEP_ABBREV;
1698     auto &GEPInst = cast<GetElementPtrInst>(I);
1699     Vals.push_back(GEPInst.isInBounds());
1700     Vals.push_back(VE.getTypeID(GEPInst.getSourceElementType()));
1701     for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
1702       PushValueAndType(I.getOperand(i), InstID, Vals, VE);
1703     break;
1704   }
1705   case Instruction::ExtractValue: {
1706     Code = bitc::FUNC_CODE_INST_EXTRACTVAL;
1707     PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1708     const ExtractValueInst *EVI = cast<ExtractValueInst>(&I);
1709     Vals.append(EVI->idx_begin(), EVI->idx_end());
1710     break;
1711   }
1712   case Instruction::InsertValue: {
1713     Code = bitc::FUNC_CODE_INST_INSERTVAL;
1714     PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1715     PushValueAndType(I.getOperand(1), InstID, Vals, VE);
1716     const InsertValueInst *IVI = cast<InsertValueInst>(&I);
1717     Vals.append(IVI->idx_begin(), IVI->idx_end());
1718     break;
1719   }
1720   case Instruction::Select:
1721     Code = bitc::FUNC_CODE_INST_VSELECT;
1722     PushValueAndType(I.getOperand(1), InstID, Vals, VE);
1723     pushValue(I.getOperand(2), InstID, Vals, VE);
1724     PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1725     break;
1726   case Instruction::ExtractElement:
1727     Code = bitc::FUNC_CODE_INST_EXTRACTELT;
1728     PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1729     PushValueAndType(I.getOperand(1), InstID, Vals, VE);
1730     break;
1731   case Instruction::InsertElement:
1732     Code = bitc::FUNC_CODE_INST_INSERTELT;
1733     PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1734     pushValue(I.getOperand(1), InstID, Vals, VE);
1735     PushValueAndType(I.getOperand(2), InstID, Vals, VE);
1736     break;
1737   case Instruction::ShuffleVector:
1738     Code = bitc::FUNC_CODE_INST_SHUFFLEVEC;
1739     PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1740     pushValue(I.getOperand(1), InstID, Vals, VE);
1741     pushValue(I.getOperand(2), InstID, Vals, VE);
1742     break;
1743   case Instruction::ICmp:
1744   case Instruction::FCmp:
1745     // compare returning Int1Ty or vector of Int1Ty
1746     Code = bitc::FUNC_CODE_INST_CMP2;
1747     PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1748     pushValue(I.getOperand(1), InstID, Vals, VE);
1749     Vals.push_back(cast<CmpInst>(I).getPredicate());
1750     break;
1751
1752   case Instruction::Ret:
1753     {
1754       Code = bitc::FUNC_CODE_INST_RET;
1755       unsigned NumOperands = I.getNumOperands();
1756       if (NumOperands == 0)
1757         AbbrevToUse = FUNCTION_INST_RET_VOID_ABBREV;
1758       else if (NumOperands == 1) {
1759         if (!PushValueAndType(I.getOperand(0), InstID, Vals, VE))
1760           AbbrevToUse = FUNCTION_INST_RET_VAL_ABBREV;
1761       } else {
1762         for (unsigned i = 0, e = NumOperands; i != e; ++i)
1763           PushValueAndType(I.getOperand(i), InstID, Vals, VE);
1764       }
1765     }
1766     break;
1767   case Instruction::Br:
1768     {
1769       Code = bitc::FUNC_CODE_INST_BR;
1770       const BranchInst &II = cast<BranchInst>(I);
1771       Vals.push_back(VE.getValueID(II.getSuccessor(0)));
1772       if (II.isConditional()) {
1773         Vals.push_back(VE.getValueID(II.getSuccessor(1)));
1774         pushValue(II.getCondition(), InstID, Vals, VE);
1775       }
1776     }
1777     break;
1778   case Instruction::Switch:
1779     {
1780       Code = bitc::FUNC_CODE_INST_SWITCH;
1781       const SwitchInst &SI = cast<SwitchInst>(I);
1782       Vals.push_back(VE.getTypeID(SI.getCondition()->getType()));
1783       pushValue(SI.getCondition(), InstID, Vals, VE);
1784       Vals.push_back(VE.getValueID(SI.getDefaultDest()));
1785       for (SwitchInst::ConstCaseIt i = SI.case_begin(), e = SI.case_end();
1786            i != e; ++i) {
1787         Vals.push_back(VE.getValueID(i.getCaseValue()));
1788         Vals.push_back(VE.getValueID(i.getCaseSuccessor()));
1789       }
1790     }
1791     break;
1792   case Instruction::IndirectBr:
1793     Code = bitc::FUNC_CODE_INST_INDIRECTBR;
1794     Vals.push_back(VE.getTypeID(I.getOperand(0)->getType()));
1795     // Encode the address operand as relative, but not the basic blocks.
1796     pushValue(I.getOperand(0), InstID, Vals, VE);
1797     for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i)
1798       Vals.push_back(VE.getValueID(I.getOperand(i)));
1799     break;
1800
1801   case Instruction::Invoke: {
1802     const InvokeInst *II = cast<InvokeInst>(&I);
1803     const Value *Callee = II->getCalledValue();
1804     FunctionType *FTy = II->getFunctionType();
1805     Code = bitc::FUNC_CODE_INST_INVOKE;
1806
1807     Vals.push_back(VE.getAttributeID(II->getAttributes()));
1808     Vals.push_back(II->getCallingConv() | 1 << 13);
1809     Vals.push_back(VE.getValueID(II->getNormalDest()));
1810     Vals.push_back(VE.getValueID(II->getUnwindDest()));
1811     Vals.push_back(VE.getTypeID(FTy));
1812     PushValueAndType(Callee, InstID, Vals, VE);
1813
1814     // Emit value #'s for the fixed parameters.
1815     for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
1816       pushValue(I.getOperand(i), InstID, Vals, VE);  // fixed param.
1817
1818     // Emit type/value pairs for varargs params.
1819     if (FTy->isVarArg()) {
1820       for (unsigned i = FTy->getNumParams(), e = I.getNumOperands()-3;
1821            i != e; ++i)
1822         PushValueAndType(I.getOperand(i), InstID, Vals, VE); // vararg
1823     }
1824     break;
1825   }
1826   case Instruction::Resume:
1827     Code = bitc::FUNC_CODE_INST_RESUME;
1828     PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1829     break;
1830   case Instruction::Unreachable:
1831     Code = bitc::FUNC_CODE_INST_UNREACHABLE;
1832     AbbrevToUse = FUNCTION_INST_UNREACHABLE_ABBREV;
1833     break;
1834
1835   case Instruction::PHI: {
1836     const PHINode &PN = cast<PHINode>(I);
1837     Code = bitc::FUNC_CODE_INST_PHI;
1838     // With the newer instruction encoding, forward references could give
1839     // negative valued IDs.  This is most common for PHIs, so we use
1840     // signed VBRs.
1841     SmallVector<uint64_t, 128> Vals64;
1842     Vals64.push_back(VE.getTypeID(PN.getType()));
1843     for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
1844       pushValueSigned(PN.getIncomingValue(i), InstID, Vals64, VE);
1845       Vals64.push_back(VE.getValueID(PN.getIncomingBlock(i)));
1846     }
1847     // Emit a Vals64 vector and exit.
1848     Stream.EmitRecord(Code, Vals64, AbbrevToUse);
1849     Vals64.clear();
1850     return;
1851   }
1852
1853   case Instruction::LandingPad: {
1854     const LandingPadInst &LP = cast<LandingPadInst>(I);
1855     Code = bitc::FUNC_CODE_INST_LANDINGPAD;
1856     Vals.push_back(VE.getTypeID(LP.getType()));
1857     PushValueAndType(LP.getPersonalityFn(), InstID, Vals, VE);
1858     Vals.push_back(LP.isCleanup());
1859     Vals.push_back(LP.getNumClauses());
1860     for (unsigned I = 0, E = LP.getNumClauses(); I != E; ++I) {
1861       if (LP.isCatch(I))
1862         Vals.push_back(LandingPadInst::Catch);
1863       else
1864         Vals.push_back(LandingPadInst::Filter);
1865       PushValueAndType(LP.getClause(I), InstID, Vals, VE);
1866     }
1867     break;
1868   }
1869
1870   case Instruction::Alloca: {
1871     Code = bitc::FUNC_CODE_INST_ALLOCA;
1872     const AllocaInst &AI = cast<AllocaInst>(I);
1873     Vals.push_back(VE.getTypeID(AI.getAllocatedType()));
1874     Vals.push_back(VE.getTypeID(I.getOperand(0)->getType()));
1875     Vals.push_back(VE.getValueID(I.getOperand(0))); // size.
1876     unsigned AlignRecord = Log2_32(AI.getAlignment()) + 1;
1877     assert(Log2_32(Value::MaximumAlignment) + 1 < 1 << 5 &&
1878            "not enough bits for maximum alignment");
1879     assert(AlignRecord < 1 << 5 && "alignment greater than 1 << 64");
1880     AlignRecord |= AI.isUsedWithInAlloca() << 5;
1881     AlignRecord |= 1 << 6;
1882     Vals.push_back(AlignRecord);
1883     break;
1884   }
1885
1886   case Instruction::Load:
1887     if (cast<LoadInst>(I).isAtomic()) {
1888       Code = bitc::FUNC_CODE_INST_LOADATOMIC;
1889       PushValueAndType(I.getOperand(0), InstID, Vals, VE);
1890     } else {
1891       Code = bitc::FUNC_CODE_INST_LOAD;
1892       if (!PushValueAndType(I.getOperand(0), InstID, Vals, VE))  // ptr
1893         AbbrevToUse = FUNCTION_INST_LOAD_ABBREV;
1894     }
1895     Vals.push_back(VE.getTypeID(I.getType()));
1896     Vals.push_back(Log2_32(cast<LoadInst>(I).getAlignment())+1);
1897     Vals.push_back(cast<LoadInst>(I).isVolatile());
1898     if (cast<LoadInst>(I).isAtomic()) {
1899       Vals.push_back(GetEncodedOrdering(cast<LoadInst>(I).getOrdering()));
1900       Vals.push_back(GetEncodedSynchScope(cast<LoadInst>(I).getSynchScope()));
1901     }
1902     break;
1903   case Instruction::Store:
1904     if (cast<StoreInst>(I).isAtomic())
1905       Code = bitc::FUNC_CODE_INST_STOREATOMIC;
1906     else
1907       Code = bitc::FUNC_CODE_INST_STORE;
1908     PushValueAndType(I.getOperand(1), InstID, Vals, VE);  // ptrty + ptr
1909     PushValueAndType(I.getOperand(0), InstID, Vals, VE);  // valty + val
1910     Vals.push_back(Log2_32(cast<StoreInst>(I).getAlignment())+1);
1911     Vals.push_back(cast<StoreInst>(I).isVolatile());
1912     if (cast<StoreInst>(I).isAtomic()) {
1913       Vals.push_back(GetEncodedOrdering(cast<StoreInst>(I).getOrdering()));
1914       Vals.push_back(GetEncodedSynchScope(cast<StoreInst>(I).getSynchScope()));
1915     }
1916     break;
1917   case Instruction::AtomicCmpXchg:
1918     Code = bitc::FUNC_CODE_INST_CMPXCHG;
1919     PushValueAndType(I.getOperand(0), InstID, Vals, VE);  // ptrty + ptr
1920     PushValueAndType(I.getOperand(1), InstID, Vals, VE);         // cmp.
1921     pushValue(I.getOperand(2), InstID, Vals, VE);         // newval.
1922     Vals.push_back(cast<AtomicCmpXchgInst>(I).isVolatile());
1923     Vals.push_back(GetEncodedOrdering(
1924                      cast<AtomicCmpXchgInst>(I).getSuccessOrdering()));
1925     Vals.push_back(GetEncodedSynchScope(
1926                      cast<AtomicCmpXchgInst>(I).getSynchScope()));
1927     Vals.push_back(GetEncodedOrdering(
1928                      cast<AtomicCmpXchgInst>(I).getFailureOrdering()));
1929     Vals.push_back(cast<AtomicCmpXchgInst>(I).isWeak());
1930     break;
1931   case Instruction::AtomicRMW:
1932     Code = bitc::FUNC_CODE_INST_ATOMICRMW;
1933     PushValueAndType(I.getOperand(0), InstID, Vals, VE);  // ptrty + ptr
1934     pushValue(I.getOperand(1), InstID, Vals, VE);         // val.
1935     Vals.push_back(GetEncodedRMWOperation(
1936                      cast<AtomicRMWInst>(I).getOperation()));
1937     Vals.push_back(cast<AtomicRMWInst>(I).isVolatile());
1938     Vals.push_back(GetEncodedOrdering(cast<AtomicRMWInst>(I).getOrdering()));
1939     Vals.push_back(GetEncodedSynchScope(
1940                      cast<AtomicRMWInst>(I).getSynchScope()));
1941     break;
1942   case Instruction::Fence:
1943     Code = bitc::FUNC_CODE_INST_FENCE;
1944     Vals.push_back(GetEncodedOrdering(cast<FenceInst>(I).getOrdering()));
1945     Vals.push_back(GetEncodedSynchScope(cast<FenceInst>(I).getSynchScope()));
1946     break;
1947   case Instruction::Call: {
1948     const CallInst &CI = cast<CallInst>(I);
1949     FunctionType *FTy = CI.getFunctionType();
1950
1951     Code = bitc::FUNC_CODE_INST_CALL;
1952
1953     Vals.push_back(VE.getAttributeID(CI.getAttributes()));
1954     Vals.push_back((CI.getCallingConv() << 1) | unsigned(CI.isTailCall()) |
1955                    unsigned(CI.isMustTailCall()) << 14 | 1 << 15);
1956     Vals.push_back(VE.getTypeID(FTy));
1957     PushValueAndType(CI.getCalledValue(), InstID, Vals, VE);  // Callee
1958
1959     // Emit value #'s for the fixed parameters.
1960     for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i) {
1961       // Check for labels (can happen with asm labels).
1962       if (FTy->getParamType(i)->isLabelTy())
1963         Vals.push_back(VE.getValueID(CI.getArgOperand(i)));
1964       else
1965         pushValue(CI.getArgOperand(i), InstID, Vals, VE);  // fixed param.
1966     }
1967
1968     // Emit type/value pairs for varargs params.
1969     if (FTy->isVarArg()) {
1970       for (unsigned i = FTy->getNumParams(), e = CI.getNumArgOperands();
1971            i != e; ++i)
1972         PushValueAndType(CI.getArgOperand(i), InstID, Vals, VE);  // varargs
1973     }
1974     break;
1975   }
1976   case Instruction::VAArg:
1977     Code = bitc::FUNC_CODE_INST_VAARG;
1978     Vals.push_back(VE.getTypeID(I.getOperand(0)->getType()));   // valistty
1979     pushValue(I.getOperand(0), InstID, Vals, VE); // valist.
1980     Vals.push_back(VE.getTypeID(I.getType())); // restype.
1981     break;
1982   }
1983
1984   Stream.EmitRecord(Code, Vals, AbbrevToUse);
1985   Vals.clear();
1986 }
1987
1988 // Emit names for globals/functions etc.
1989 static void WriteValueSymbolTable(const ValueSymbolTable &VST,
1990                                   const ValueEnumerator &VE,
1991                                   BitstreamWriter &Stream) {
1992   if (VST.empty()) return;
1993   Stream.EnterSubblock(bitc::VALUE_SYMTAB_BLOCK_ID, 4);
1994
1995   // FIXME: Set up the abbrev, we know how many values there are!
1996   // FIXME: We know if the type names can use 7-bit ascii.
1997   SmallVector<unsigned, 64> NameVals;
1998
1999   for (ValueSymbolTable::const_iterator SI = VST.begin(), SE = VST.end();
2000        SI != SE; ++SI) {
2001
2002     const ValueName &Name = *SI;
2003
2004     // Figure out the encoding to use for the name.
2005     bool is7Bit = true;
2006     bool isChar6 = true;
2007     for (const char *C = Name.getKeyData(), *E = C+Name.getKeyLength();
2008          C != E; ++C) {
2009       if (isChar6)
2010         isChar6 = BitCodeAbbrevOp::isChar6(*C);
2011       if ((unsigned char)*C & 128) {
2012         is7Bit = false;
2013         break;  // don't bother scanning the rest.
2014       }
2015     }
2016
2017     unsigned AbbrevToUse = VST_ENTRY_8_ABBREV;
2018
2019     // VST_ENTRY:   [valueid, namechar x N]
2020     // VST_BBENTRY: [bbid, namechar x N]
2021     unsigned Code;
2022     if (isa<BasicBlock>(SI->getValue())) {
2023       Code = bitc::VST_CODE_BBENTRY;
2024       if (isChar6)
2025         AbbrevToUse = VST_BBENTRY_6_ABBREV;
2026     } else {
2027       Code = bitc::VST_CODE_ENTRY;
2028       if (isChar6)
2029         AbbrevToUse = VST_ENTRY_6_ABBREV;
2030       else if (is7Bit)
2031         AbbrevToUse = VST_ENTRY_7_ABBREV;
2032     }
2033
2034     NameVals.push_back(VE.getValueID(SI->getValue()));
2035     for (const char *P = Name.getKeyData(),
2036          *E = Name.getKeyData()+Name.getKeyLength(); P != E; ++P)
2037       NameVals.push_back((unsigned char)*P);
2038
2039     // Emit the finished record.
2040     Stream.EmitRecord(Code, NameVals, AbbrevToUse);
2041     NameVals.clear();
2042   }
2043   Stream.ExitBlock();
2044 }
2045
2046 static void WriteUseList(ValueEnumerator &VE, UseListOrder &&Order,
2047                          BitstreamWriter &Stream) {
2048   assert(Order.Shuffle.size() >= 2 && "Shuffle too small");
2049   unsigned Code;
2050   if (isa<BasicBlock>(Order.V))
2051     Code = bitc::USELIST_CODE_BB;
2052   else
2053     Code = bitc::USELIST_CODE_DEFAULT;
2054
2055   SmallVector<uint64_t, 64> Record(Order.Shuffle.begin(), Order.Shuffle.end());
2056   Record.push_back(VE.getValueID(Order.V));
2057   Stream.EmitRecord(Code, Record);
2058 }
2059
2060 static void WriteUseListBlock(const Function *F, ValueEnumerator &VE,
2061                               BitstreamWriter &Stream) {
2062   assert(VE.shouldPreserveUseListOrder() &&
2063          "Expected to be preserving use-list order");
2064
2065   auto hasMore = [&]() {
2066     return !VE.UseListOrders.empty() && VE.UseListOrders.back().F == F;
2067   };
2068   if (!hasMore())
2069     // Nothing to do.
2070     return;
2071
2072   Stream.EnterSubblock(bitc::USELIST_BLOCK_ID, 3);
2073   while (hasMore()) {
2074     WriteUseList(VE, std::move(VE.UseListOrders.back()), Stream);
2075     VE.UseListOrders.pop_back();
2076   }
2077   Stream.ExitBlock();
2078 }
2079
2080 /// WriteFunction - Emit a function body to the module stream.
2081 static void WriteFunction(const Function &F, ValueEnumerator &VE,
2082                           BitstreamWriter &Stream) {
2083   Stream.EnterSubblock(bitc::FUNCTION_BLOCK_ID, 4);
2084   VE.incorporateFunction(F);
2085
2086   SmallVector<unsigned, 64> Vals;
2087
2088   // Emit the number of basic blocks, so the reader can create them ahead of
2089   // time.
2090   Vals.push_back(VE.getBasicBlocks().size());
2091   Stream.EmitRecord(bitc::FUNC_CODE_DECLAREBLOCKS, Vals);
2092   Vals.clear();
2093
2094   // If there are function-local constants, emit them now.
2095   unsigned CstStart, CstEnd;
2096   VE.getFunctionConstantRange(CstStart, CstEnd);
2097   WriteConstants(CstStart, CstEnd, VE, Stream, false);
2098
2099   // If there is function-local metadata, emit it now.
2100   WriteFunctionLocalMetadata(F, VE, Stream);
2101
2102   // Keep a running idea of what the instruction ID is.
2103   unsigned InstID = CstEnd;
2104
2105   bool NeedsMetadataAttachment = F.hasMetadata();
2106
2107   DILocation *LastDL = nullptr;
2108
2109   // Finally, emit all the instructions, in order.
2110   for (Function::const_iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
2111     for (BasicBlock::const_iterator I = BB->begin(), E = BB->end();
2112          I != E; ++I) {
2113       WriteInstruction(*I, InstID, VE, Stream, Vals);
2114
2115       if (!I->getType()->isVoidTy())
2116         ++InstID;
2117
2118       // If the instruction has metadata, write a metadata attachment later.
2119       NeedsMetadataAttachment |= I->hasMetadataOtherThanDebugLoc();
2120
2121       // If the instruction has a debug location, emit it.
2122       DILocation *DL = I->getDebugLoc();
2123       if (!DL)
2124         continue;
2125
2126       if (DL == LastDL) {
2127         // Just repeat the same debug loc as last time.
2128         Stream.EmitRecord(bitc::FUNC_CODE_DEBUG_LOC_AGAIN, Vals);
2129         continue;
2130       }
2131
2132       Vals.push_back(DL->getLine());
2133       Vals.push_back(DL->getColumn());
2134       Vals.push_back(VE.getMetadataOrNullID(DL->getScope()));
2135       Vals.push_back(VE.getMetadataOrNullID(DL->getInlinedAt()));
2136       Stream.EmitRecord(bitc::FUNC_CODE_DEBUG_LOC, Vals);
2137       Vals.clear();
2138
2139       LastDL = DL;
2140     }
2141
2142   // Emit names for all the instructions etc.
2143   WriteValueSymbolTable(F.getValueSymbolTable(), VE, Stream);
2144
2145   if (NeedsMetadataAttachment)
2146     WriteMetadataAttachment(F, VE, Stream);
2147   if (VE.shouldPreserveUseListOrder())
2148     WriteUseListBlock(&F, VE, Stream);
2149   VE.purgeFunction();
2150   Stream.ExitBlock();
2151 }
2152
2153 // Emit blockinfo, which defines the standard abbreviations etc.
2154 static void WriteBlockInfo(const ValueEnumerator &VE, BitstreamWriter &Stream) {
2155   // We only want to emit block info records for blocks that have multiple
2156   // instances: CONSTANTS_BLOCK, FUNCTION_BLOCK and VALUE_SYMTAB_BLOCK.
2157   // Other blocks can define their abbrevs inline.
2158   Stream.EnterBlockInfoBlock(2);
2159
2160   { // 8-bit fixed-width VST_ENTRY/VST_BBENTRY strings.
2161     BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2162     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3));
2163     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
2164     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
2165     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 8));
2166     if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
2167                                    Abbv) != VST_ENTRY_8_ABBREV)
2168       llvm_unreachable("Unexpected abbrev ordering!");
2169   }
2170
2171   { // 7-bit fixed width VST_ENTRY strings.
2172     BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2173     Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_ENTRY));
2174     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
2175     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
2176     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7));
2177     if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
2178                                    Abbv) != VST_ENTRY_7_ABBREV)
2179       llvm_unreachable("Unexpected abbrev ordering!");
2180   }
2181   { // 6-bit char6 VST_ENTRY strings.
2182     BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2183     Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_ENTRY));
2184     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
2185     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
2186     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
2187     if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
2188                                    Abbv) != VST_ENTRY_6_ABBREV)
2189       llvm_unreachable("Unexpected abbrev ordering!");
2190   }
2191   { // 6-bit char6 VST_BBENTRY strings.
2192     BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2193     Abbv->Add(BitCodeAbbrevOp(bitc::VST_CODE_BBENTRY));
2194     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
2195     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
2196     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Char6));
2197     if (Stream.EmitBlockInfoAbbrev(bitc::VALUE_SYMTAB_BLOCK_ID,
2198                                    Abbv) != VST_BBENTRY_6_ABBREV)
2199       llvm_unreachable("Unexpected abbrev ordering!");
2200   }
2201
2202
2203
2204   { // SETTYPE abbrev for CONSTANTS_BLOCK.
2205     BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2206     Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_SETTYPE));
2207     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,
2208                               VE.computeBitsRequiredForTypeIndicies()));
2209     if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
2210                                    Abbv) != CONSTANTS_SETTYPE_ABBREV)
2211       llvm_unreachable("Unexpected abbrev ordering!");
2212   }
2213
2214   { // INTEGER abbrev for CONSTANTS_BLOCK.
2215     BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2216     Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_INTEGER));
2217     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));
2218     if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
2219                                    Abbv) != CONSTANTS_INTEGER_ABBREV)
2220       llvm_unreachable("Unexpected abbrev ordering!");
2221   }
2222
2223   { // CE_CAST abbrev for CONSTANTS_BLOCK.
2224     BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2225     Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_CE_CAST));
2226     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4));  // cast opc
2227     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,       // typeid
2228                               VE.computeBitsRequiredForTypeIndicies()));
2229     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8));    // value id
2230
2231     if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
2232                                    Abbv) != CONSTANTS_CE_CAST_Abbrev)
2233       llvm_unreachable("Unexpected abbrev ordering!");
2234   }
2235   { // NULL abbrev for CONSTANTS_BLOCK.
2236     BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2237     Abbv->Add(BitCodeAbbrevOp(bitc::CST_CODE_NULL));
2238     if (Stream.EmitBlockInfoAbbrev(bitc::CONSTANTS_BLOCK_ID,
2239                                    Abbv) != CONSTANTS_NULL_Abbrev)
2240       llvm_unreachable("Unexpected abbrev ordering!");
2241   }
2242
2243   // FIXME: This should only use space for first class types!
2244
2245   { // INST_LOAD abbrev for FUNCTION_BLOCK.
2246     BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2247     Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_LOAD));
2248     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Ptr
2249     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,    // dest ty
2250                               VE.computeBitsRequiredForTypeIndicies()));
2251     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // Align
2252     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // volatile
2253     if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
2254                                    Abbv) != FUNCTION_INST_LOAD_ABBREV)
2255       llvm_unreachable("Unexpected abbrev ordering!");
2256   }
2257   { // INST_BINOP abbrev for FUNCTION_BLOCK.
2258     BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2259     Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_BINOP));
2260     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LHS
2261     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // RHS
2262     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // opc
2263     if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
2264                                    Abbv) != FUNCTION_INST_BINOP_ABBREV)
2265       llvm_unreachable("Unexpected abbrev ordering!");
2266   }
2267   { // INST_BINOP_FLAGS abbrev for FUNCTION_BLOCK.
2268     BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2269     Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_BINOP));
2270     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LHS
2271     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // RHS
2272     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // opc
2273     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 7)); // flags
2274     if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
2275                                    Abbv) != FUNCTION_INST_BINOP_FLAGS_ABBREV)
2276       llvm_unreachable("Unexpected abbrev ordering!");
2277   }
2278   { // INST_CAST abbrev for FUNCTION_BLOCK.
2279     BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2280     Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_CAST));
2281     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));    // OpVal
2282     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed,       // dest ty
2283                               VE.computeBitsRequiredForTypeIndicies()));
2284     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4));  // opc
2285     if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
2286                                    Abbv) != FUNCTION_INST_CAST_ABBREV)
2287       llvm_unreachable("Unexpected abbrev ordering!");
2288   }
2289
2290   { // INST_RET abbrev for FUNCTION_BLOCK.
2291     BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2292     Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_RET));
2293     if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
2294                                    Abbv) != FUNCTION_INST_RET_VOID_ABBREV)
2295       llvm_unreachable("Unexpected abbrev ordering!");
2296   }
2297   { // INST_RET abbrev for FUNCTION_BLOCK.
2298     BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2299     Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_RET));
2300     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ValID
2301     if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
2302                                    Abbv) != FUNCTION_INST_RET_VAL_ABBREV)
2303       llvm_unreachable("Unexpected abbrev ordering!");
2304   }
2305   { // INST_UNREACHABLE abbrev for FUNCTION_BLOCK.
2306     BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2307     Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_UNREACHABLE));
2308     if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID,
2309                                    Abbv) != FUNCTION_INST_UNREACHABLE_ABBREV)
2310       llvm_unreachable("Unexpected abbrev ordering!");
2311   }
2312   {
2313     BitCodeAbbrev *Abbv = new BitCodeAbbrev();
2314     Abbv->Add(BitCodeAbbrevOp(bitc::FUNC_CODE_INST_GEP));
2315     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));
2316     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, // dest ty
2317                               Log2_32_Ceil(VE.getTypes().size() + 1)));
2318     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
2319     Abbv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
2320     if (Stream.EmitBlockInfoAbbrev(bitc::FUNCTION_BLOCK_ID, Abbv) !=
2321         FUNCTION_INST_GEP_ABBREV)
2322       llvm_unreachable("Unexpected abbrev ordering!");
2323   }
2324
2325   Stream.ExitBlock();
2326 }
2327
2328 /// WriteModule - Emit the specified module to the bitstream.
2329 static void WriteModule(const Module *M, BitstreamWriter &Stream,
2330                         bool ShouldPreserveUseListOrder) {
2331   Stream.EnterSubblock(bitc::MODULE_BLOCK_ID, 3);
2332
2333   SmallVector<unsigned, 1> Vals;
2334   unsigned CurVersion = 1;
2335   Vals.push_back(CurVersion);
2336   Stream.EmitRecord(bitc::MODULE_CODE_VERSION, Vals);
2337
2338   // Analyze the module, enumerating globals, functions, etc.
2339   ValueEnumerator VE(*M, ShouldPreserveUseListOrder);
2340
2341   // Emit blockinfo, which defines the standard abbreviations etc.
2342   WriteBlockInfo(VE, Stream);
2343
2344   // Emit information about attribute groups.
2345   WriteAttributeGroupTable(VE, Stream);
2346
2347   // Emit information about parameter attributes.
2348   WriteAttributeTable(VE, Stream);
2349
2350   // Emit information describing all of the types in the module.
2351   WriteTypeTable(VE, Stream);
2352
2353   writeComdats(VE, Stream);
2354
2355   // Emit top-level description of module, including target triple, inline asm,
2356   // descriptors for global variables, and function prototype info.
2357   WriteModuleInfo(M, VE, Stream);
2358
2359   // Emit constants.
2360   WriteModuleConstants(VE, Stream);
2361
2362   // Emit metadata.
2363   WriteModuleMetadata(M, VE, Stream);
2364
2365   // Emit metadata.
2366   WriteModuleMetadataStore(M, Stream);
2367
2368   // Emit names for globals/functions etc.
2369   WriteValueSymbolTable(M->getValueSymbolTable(), VE, Stream);
2370
2371   // Emit module-level use-lists.
2372   if (VE.shouldPreserveUseListOrder())
2373     WriteUseListBlock(nullptr, VE, Stream);
2374
2375   // Emit function bodies.
2376   for (Module::const_iterator F = M->begin(), E = M->end(); F != E; ++F)
2377     if (!F->isDeclaration())
2378       WriteFunction(*F, VE, Stream);
2379
2380   Stream.ExitBlock();
2381 }
2382
2383 /// EmitDarwinBCHeader - If generating a bc file on darwin, we have to emit a
2384 /// header and trailer to make it compatible with the system archiver.  To do
2385 /// this we emit the following header, and then emit a trailer that pads the
2386 /// file out to be a multiple of 16 bytes.
2387 ///
2388 /// struct bc_header {
2389 ///   uint32_t Magic;         // 0x0B17C0DE
2390 ///   uint32_t Version;       // Version, currently always 0.
2391 ///   uint32_t BitcodeOffset; // Offset to traditional bitcode file.
2392 ///   uint32_t BitcodeSize;   // Size of traditional bitcode file.
2393 ///   uint32_t CPUType;       // CPU specifier.
2394 ///   ... potentially more later ...
2395 /// };
2396 enum {
2397   DarwinBCSizeFieldOffset = 3*4, // Offset to bitcode_size.
2398   DarwinBCHeaderSize = 5*4
2399 };
2400
2401 static void WriteInt32ToBuffer(uint32_t Value, SmallVectorImpl<char> &Buffer,
2402                                uint32_t &Position) {
2403   Buffer[Position + 0] = (unsigned char) (Value >>  0);
2404   Buffer[Position + 1] = (unsigned char) (Value >>  8);
2405   Buffer[Position + 2] = (unsigned char) (Value >> 16);
2406   Buffer[Position + 3] = (unsigned char) (Value >> 24);
2407   Position += 4;
2408 }
2409
2410 static void EmitDarwinBCHeaderAndTrailer(SmallVectorImpl<char> &Buffer,
2411                                          const Triple &TT) {
2412   unsigned CPUType = ~0U;
2413
2414   // Match x86_64-*, i[3-9]86-*, powerpc-*, powerpc64-*, arm-*, thumb-*,
2415   // armv[0-9]-*, thumbv[0-9]-*, armv5te-*, or armv6t2-*. The CPUType is a magic
2416   // number from /usr/include/mach/machine.h.  It is ok to reproduce the
2417   // specific constants here because they are implicitly part of the Darwin ABI.
2418   enum {
2419     DARWIN_CPU_ARCH_ABI64      = 0x01000000,
2420     DARWIN_CPU_TYPE_X86        = 7,
2421     DARWIN_CPU_TYPE_ARM        = 12,
2422     DARWIN_CPU_TYPE_POWERPC    = 18
2423   };
2424
2425   Triple::ArchType Arch = TT.getArch();
2426   if (Arch == Triple::x86_64)
2427     CPUType = DARWIN_CPU_TYPE_X86 | DARWIN_CPU_ARCH_ABI64;
2428   else if (Arch == Triple::x86)
2429     CPUType = DARWIN_CPU_TYPE_X86;
2430   else if (Arch == Triple::ppc)
2431     CPUType = DARWIN_CPU_TYPE_POWERPC;
2432   else if (Arch == Triple::ppc64)
2433     CPUType = DARWIN_CPU_TYPE_POWERPC | DARWIN_CPU_ARCH_ABI64;
2434   else if (Arch == Triple::arm || Arch == Triple::thumb)
2435     CPUType = DARWIN_CPU_TYPE_ARM;
2436
2437   // Traditional Bitcode starts after header.
2438   assert(Buffer.size() >= DarwinBCHeaderSize &&
2439          "Expected header size to be reserved");
2440   unsigned BCOffset = DarwinBCHeaderSize;
2441   unsigned BCSize = Buffer.size()-DarwinBCHeaderSize;
2442
2443   // Write the magic and version.
2444   unsigned Position = 0;
2445   WriteInt32ToBuffer(0x0B17C0DE , Buffer, Position);
2446   WriteInt32ToBuffer(0          , Buffer, Position); // Version.
2447   WriteInt32ToBuffer(BCOffset   , Buffer, Position);
2448   WriteInt32ToBuffer(BCSize     , Buffer, Position);
2449   WriteInt32ToBuffer(CPUType    , Buffer, Position);
2450
2451   // If the file is not a multiple of 16 bytes, insert dummy padding.
2452   while (Buffer.size() & 15)
2453     Buffer.push_back(0);
2454 }
2455
2456 /// WriteBitcodeToFile - Write the specified module to the specified output
2457 /// stream.
2458 void llvm::WriteBitcodeToFile(const Module *M, raw_ostream &Out,
2459                               bool ShouldPreserveUseListOrder) {
2460   SmallVector<char, 0> Buffer;
2461   Buffer.reserve(256*1024);
2462
2463   // If this is darwin or another generic macho target, reserve space for the
2464   // header.
2465   Triple TT(M->getTargetTriple());
2466   if (TT.isOSDarwin())
2467     Buffer.insert(Buffer.begin(), DarwinBCHeaderSize, 0);
2468
2469   // Emit the module into the buffer.
2470   {
2471     BitstreamWriter Stream(Buffer);
2472
2473     // Emit the file header.
2474     Stream.Emit((unsigned)'B', 8);
2475     Stream.Emit((unsigned)'C', 8);
2476     Stream.Emit(0x0, 4);
2477     Stream.Emit(0xC, 4);
2478     Stream.Emit(0xE, 4);
2479     Stream.Emit(0xD, 4);
2480
2481     // Emit the module.
2482     WriteModule(M, Stream, ShouldPreserveUseListOrder);
2483   }
2484
2485   if (TT.isOSDarwin())
2486     EmitDarwinBCHeaderAndTrailer(Buffer, TT);
2487
2488   // Write the generated bitstream to "Out".
2489   Out.write((char*)&Buffer.front(), Buffer.size());
2490 }