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