lib/Bytecode/Writer/Writer.cpp

   1 //===-- Writer.cpp - Library for writing LLVM bytecode files --------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This library implements the functionality defined in llvm/Bytecode/Writer.h
  11 //
  12 // Note that this file uses an unusual technique of outputting all the bytecode
  13 // to a vector of unsigned char, then copies the vector to an ostream.  The
  14 // reason for this is that we must do "seeking" in the stream to do back-
  15 // patching, and some very important ostreams that we want to support (like
  16 // pipes) do not support seeking.  :( :( :(
  17 //
  18 //===----------------------------------------------------------------------===//
  19
  20 #define DEBUG_TYPE "bytecodewriter"
  21 #include "WriterInternals.h"
  22 #include "llvm/Bytecode/WriteBytecodePass.h"
  23 #include "llvm/CallingConv.h"
  24 #include "llvm/Constants.h"
  25 #include "llvm/DerivedTypes.h"
  26 #include "llvm/InlineAsm.h"
  27 #include "llvm/Instructions.h"
  28 #include "llvm/Module.h"
  29 #include "llvm/SymbolTable.h"
  30 #include "llvm/TypeSymbolTable.h"
  31 #include "llvm/Support/GetElementPtrTypeIterator.h"
  32 #include "llvm/Support/Compressor.h"
  33 #include "llvm/Support/MathExtras.h"
  34 #include "llvm/Support/Streams.h"
  35 #include "llvm/System/Program.h"
  36 #include "llvm/ADT/STLExtras.h"
  37 #include "llvm/ADT/Statistic.h"
  38 #include <cstring>
  39 #include <algorithm>
  40 using namespace llvm;
  41
  42 /// This value needs to be incremented every time the bytecode format changes
  43 /// so that the reader can distinguish which format of the bytecode file has
  44 /// been written.
  45 /// @brief The bytecode version number
  46 const unsigned BCVersionNum = 7;
  47
  48 static RegisterPass<WriteBytecodePass> X("emitbytecode", "Bytecode Writer");
  49
  50 STATISTIC(BytesWritten, "Number of bytecode bytes written");
  51
  52 //===----------------------------------------------------------------------===//
  53 //===                           Output Primitives                          ===//
  54 //===----------------------------------------------------------------------===//
  55
  56 // output - If a position is specified, it must be in the valid portion of the
  57 // string... note that this should be inlined always so only the relevant IF
  58 // body should be included.
  59 inline void BytecodeWriter::output(unsigned i, int pos) {
  60   if (pos == -1) { // Be endian clean, little endian is our friend
  61     Out.push_back((unsigned char)i);
  62     Out.push_back((unsigned char)(i >> 8));
  63     Out.push_back((unsigned char)(i >> 16));
  64     Out.push_back((unsigned char)(i >> 24));
  65   } else {
  66     Out[pos  ] = (unsigned char)i;
  67     Out[pos+1] = (unsigned char)(i >> 8);
  68     Out[pos+2] = (unsigned char)(i >> 16);
  69     Out[pos+3] = (unsigned char)(i >> 24);
  70   }
  71 }
  72
  73 inline void BytecodeWriter::output(int i) {
  74   output((unsigned)i);
  75 }
  76
  77 /// output_vbr - Output an unsigned value, by using the least number of bytes
  78 /// possible.  This is useful because many of our "infinite" values are really
  79 /// very small most of the time; but can be large a few times.
  80 /// Data format used:  If you read a byte with the high bit set, use the low
  81 /// seven bits as data and then read another byte.
  82 inline void BytecodeWriter::output_vbr(uint64_t i) {
  83   while (1) {
  84     if (i < 0x80) { // done?
  85       Out.push_back((unsigned char)i);   // We know the high bit is clear...
  86       return;
  87     }
  88
  89     // Nope, we are bigger than a character, output the next 7 bits and set the
  90     // high bit to say that there is more coming...
  91     Out.push_back(0x80 | ((unsigned char)i & 0x7F));
  92     i >>= 7;  // Shift out 7 bits now...
  93   }
  94 }
  95
  96 inline void BytecodeWriter::output_vbr(unsigned i) {
  97   while (1) {
  98     if (i < 0x80) { // done?
  99       Out.push_back((unsigned char)i);   // We know the high bit is clear...
 100       return;
 101     }
 102
 103     // Nope, we are bigger than a character, output the next 7 bits and set the
 104     // high bit to say that there is more coming...
 105     Out.push_back(0x80 | ((unsigned char)i & 0x7F));
 106     i >>= 7;  // Shift out 7 bits now...
 107   }
 108 }
 109
 110 inline void BytecodeWriter::output_typeid(unsigned i) {
 111   if (i <= 0x00FFFFFF)
 112     this->output_vbr(i);
 113   else {
 114     this->output_vbr(0x00FFFFFF);
 115     this->output_vbr(i);
 116   }
 117 }
 118
 119 inline void BytecodeWriter::output_vbr(int64_t i) {
 120   if (i < 0)
 121     output_vbr(((uint64_t)(-i) << 1) | 1); // Set low order sign bit...
 122   else
 123     output_vbr((uint64_t)i << 1);          // Low order bit is clear.
 124 }
 125
 126
 127 inline void BytecodeWriter::output_vbr(int i) {
 128   if (i < 0)
 129     output_vbr(((unsigned)(-i) << 1) | 1); // Set low order sign bit...
 130   else
 131     output_vbr((unsigned)i << 1);          // Low order bit is clear.
 132 }
 133
 134 inline void BytecodeWriter::output(const std::string &s) {
 135   unsigned Len = s.length();
 136   output_vbr(Len);             // Strings may have an arbitrary length.
 137   Out.insert(Out.end(), s.begin(), s.end());
 138 }
 139
 140 inline void BytecodeWriter::output_data(const void *Ptr, const void *End) {
 141   Out.insert(Out.end(), (const unsigned char*)Ptr, (const unsigned char*)End);
 142 }
 143
 144 inline void BytecodeWriter::output_float(float& FloatVal) {
 145   /// FIXME: This isn't optimal, it has size problems on some platforms
 146   /// where FP is not IEEE.
 147   uint32_t i = FloatToBits(FloatVal);
 148   Out.push_back( static_cast<unsigned char>( (i      ) & 0xFF));
 149   Out.push_back( static_cast<unsigned char>( (i >> 8 ) & 0xFF));
 150   Out.push_back( static_cast<unsigned char>( (i >> 16) & 0xFF));
 151   Out.push_back( static_cast<unsigned char>( (i >> 24) & 0xFF));
 152 }
 153
 154 inline void BytecodeWriter::output_double(double& DoubleVal) {
 155   /// FIXME: This isn't optimal, it has size problems on some platforms
 156   /// where FP is not IEEE.
 157   uint64_t i = DoubleToBits(DoubleVal);
 158   Out.push_back( static_cast<unsigned char>( (i      ) & 0xFF));
 159   Out.push_back( static_cast<unsigned char>( (i >> 8 ) & 0xFF));
 160   Out.push_back( static_cast<unsigned char>( (i >> 16) & 0xFF));
 161   Out.push_back( static_cast<unsigned char>( (i >> 24) & 0xFF));
 162   Out.push_back( static_cast<unsigned char>( (i >> 32) & 0xFF));
 163   Out.push_back( static_cast<unsigned char>( (i >> 40) & 0xFF));
 164   Out.push_back( static_cast<unsigned char>( (i >> 48) & 0xFF));
 165   Out.push_back( static_cast<unsigned char>( (i >> 56) & 0xFF));
 166 }
 167
 168 inline BytecodeBlock::BytecodeBlock(unsigned ID, BytecodeWriter &w,
 169                                     bool elideIfEmpty, bool hasLongFormat)
 170   : Id(ID), Writer(w), ElideIfEmpty(elideIfEmpty), HasLongFormat(hasLongFormat){
 171
 172   if (HasLongFormat) {
 173     w.output(ID);
 174     w.output(0U); // For length in long format
 175   } else {
 176     w.output(0U); /// Place holder for ID and length for this block
 177   }
 178   Loc = w.size();
 179 }
 180
 181 inline BytecodeBlock::~BytecodeBlock() { // Do backpatch when block goes out
 182                                          // of scope...
 183   if (Loc == Writer.size() && ElideIfEmpty) {
 184     // If the block is empty, and we are allowed to, do not emit the block at
 185     // all!
 186     Writer.resize(Writer.size()-(HasLongFormat?8:4));
 187     return;
 188   }
 189
 190   if (HasLongFormat)
 191     Writer.output(unsigned(Writer.size()-Loc), int(Loc-4));
 192   else
 193     Writer.output(unsigned(Writer.size()-Loc) << 5 | (Id & 0x1F), int(Loc-4));
 194 }
 195
 196 //===----------------------------------------------------------------------===//
 197 //===                           Constant Output                            ===//
 198 //===----------------------------------------------------------------------===//
 199
 200 void BytecodeWriter::outputType(const Type *T) {
 201   const StructType* STy = dyn_cast<StructType>(T);
 202   if(STy && STy->isPacked())
 203     output_vbr((unsigned)Type::PackedStructTyID);
 204   else
 205     output_vbr((unsigned)T->getTypeID());
 206
 207   // That's all there is to handling primitive types...
 208   if (T->isPrimitiveType())
 209     return;     // We might do this if we alias a prim type: %x = type int
 210
 211   switch (T->getTypeID()) {   // Handle derived types now.
 212   case Type::IntegerTyID:
 213     output_vbr(cast<IntegerType>(T)->getBitWidth());
 214     break;
 215   case Type::FunctionTyID: {
 216     const FunctionType *MT = cast<FunctionType>(T);
 217     int Slot = Table.getSlot(MT->getReturnType());
 218     assert(Slot != -1 && "Type used but not available!!");
 219     output_typeid((unsigned)Slot);
 220     output_vbr(unsigned(MT->getParamAttrs(0)));
 221
 222     // Output the number of arguments to function (+1 if varargs):
 223     output_vbr((unsigned)MT->getNumParams()+MT->isVarArg());
 224
 225     // Output all of the arguments...
 226     FunctionType::param_iterator I = MT->param_begin();
 227     unsigned Idx = 1;
 228     for (; I != MT->param_end(); ++I) {
 229       Slot = Table.getSlot(*I);
 230       assert(Slot != -1 && "Type used but not available!!");
 231       output_typeid((unsigned)Slot);
 232       output_vbr(unsigned(MT->getParamAttrs(Idx)));
 233       Idx++;
 234     }
 235
 236     // Terminate list with VoidTy if we are a varargs function...
 237     if (MT->isVarArg())
 238       output_typeid((unsigned)Type::VoidTyID);
 239     break;
 240   }
 241
 242   case Type::ArrayTyID: {
 243     const ArrayType *AT = cast<ArrayType>(T);
 244     int Slot = Table.getSlot(AT->getElementType());
 245     assert(Slot != -1 && "Type used but not available!!");
 246     output_typeid((unsigned)Slot);
 247     output_vbr(AT->getNumElements());
 248     break;
 249   }
 250
 251  case Type::PackedTyID: {
 252     const PackedType *PT = cast<PackedType>(T);
 253     int Slot = Table.getSlot(PT->getElementType());
 254     assert(Slot != -1 && "Type used but not available!!");
 255     output_typeid((unsigned)Slot);
 256     output_vbr(PT->getNumElements());
 257     break;
 258   }
 259
 260   case Type::StructTyID: {
 261     const StructType *ST = cast<StructType>(T);
 262     // Output all of the element types...
 263     for (StructType::element_iterator I = ST->element_begin(),
 264            E = ST->element_end(); I != E; ++I) {
 265       int Slot = Table.getSlot(*I);
 266       assert(Slot != -1 && "Type used but not available!!");
 267       output_typeid((unsigned)Slot);
 268     }
 269
 270     // Terminate list with VoidTy
 271     output_typeid((unsigned)Type::VoidTyID);
 272     break;
 273   }
 274
 275   case Type::PointerTyID: {
 276     const PointerType *PT = cast<PointerType>(T);
 277     int Slot = Table.getSlot(PT->getElementType());
 278     assert(Slot != -1 && "Type used but not available!!");
 279     output_typeid((unsigned)Slot);
 280     break;
 281   }
 282
 283   case Type::OpaqueTyID:
 284     // No need to emit anything, just the count of opaque types is enough.
 285     break;
 286
 287   default:
 288     cerr << __FILE__ << ":" << __LINE__ << ": Don't know how to serialize"
 289          << " Type '" << T->getDescription() << "'\n";
 290     break;
 291   }
 292 }
 293
 294 void BytecodeWriter::outputConstant(const Constant *CPV) {
 295   assert(((CPV->getType()->isPrimitiveType() || CPV->getType()->isIntegral()) ||
 296           !CPV->isNullValue()) && "Shouldn't output null constants!");
 297
 298   // We must check for a ConstantExpr before switching by type because
 299   // a ConstantExpr can be of any type, and has no explicit value.
 300   //
 301   if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CPV)) {
 302     // FIXME: Encoding of constant exprs could be much more compact!
 303     assert(CE->getNumOperands() > 0 && "ConstantExpr with 0 operands");
 304     assert(CE->getNumOperands() != 1 || CE->isCast());
 305     output_vbr(1+CE->getNumOperands());   // flags as an expr
 306     output_vbr(CE->getOpcode());          // Put out the CE op code
 307
 308     for (User::const_op_iterator OI = CE->op_begin(); OI != CE->op_end(); ++OI){
 309       int Slot = Table.getSlot(*OI);
 310       assert(Slot != -1 && "Unknown constant used in ConstantExpr!!");
 311       output_vbr((unsigned)Slot);
 312       Slot = Table.getSlot((*OI)->getType());
 313       output_typeid((unsigned)Slot);
 314     }
 315     if (CE->isCompare())
 316       output_vbr((unsigned)CE->getPredicate());
 317     return;
 318   } else if (isa<UndefValue>(CPV)) {
 319     output_vbr(1U);       // 1 -> UndefValue constant.
 320     return;
 321   } else {
 322     output_vbr(0U);       // flag as not a ConstantExpr (i.e. 0 operands)
 323   }
 324
 325   switch (CPV->getType()->getTypeID()) {
 326   case Type::IntegerTyID: { // Integer types...
 327     unsigned NumBits = cast<IntegerType>(CPV->getType())->getBitWidth();
 328     if (NumBits == 1)
 329       if (cast<ConstantInt>(CPV)->getZExtValue())
 330         output_vbr(1U);
 331       else
 332         output_vbr(0U);
 333     else if (NumBits <= 32)
 334       output_vbr(uint32_t(cast<ConstantInt>(CPV)->getZExtValue()));
 335     else if (NumBits <= 64)
 336       output_vbr(uint64_t(cast<ConstantInt>(CPV)->getZExtValue()));
 337     else
 338       assert("Integer types > 64 bits not supported.");
 339     break;
 340   }
 341
 342   case Type::ArrayTyID: {
 343     const ConstantArray *CPA = cast<ConstantArray>(CPV);
 344     assert(!CPA->isString() && "Constant strings should be handled specially!");
 345
 346     for (unsigned i = 0, e = CPA->getNumOperands(); i != e; ++i) {
 347       int Slot = Table.getSlot(CPA->getOperand(i));
 348       assert(Slot != -1 && "Constant used but not available!!");
 349       output_vbr((unsigned)Slot);
 350     }
 351     break;
 352   }
 353
 354   case Type::PackedTyID: {
 355     const ConstantPacked *CP = cast<ConstantPacked>(CPV);
 356
 357     for (unsigned i = 0, e = CP->getNumOperands(); i != e; ++i) {
 358       int Slot = Table.getSlot(CP->getOperand(i));
 359       assert(Slot != -1 && "Constant used but not available!!");
 360       output_vbr((unsigned)Slot);
 361     }
 362     break;
 363   }
 364
 365   case Type::StructTyID: {
 366     const ConstantStruct *CPS = cast<ConstantStruct>(CPV);
 367
 368     for (unsigned i = 0, e = CPS->getNumOperands(); i != e; ++i) {
 369       int Slot = Table.getSlot(CPS->getOperand(i));
 370       assert(Slot != -1 && "Constant used but not available!!");
 371       output_vbr((unsigned)Slot);
 372     }
 373     break;
 374   }
 375
 376   case Type::PointerTyID:
 377     assert(0 && "No non-null, non-constant-expr constants allowed!");
 378     abort();
 379
 380   case Type::FloatTyID: {   // Floating point types...
 381     float Tmp = (float)cast<ConstantFP>(CPV)->getValue();
 382     output_float(Tmp);
 383     break;
 384   }
 385   case Type::DoubleTyID: {
 386     double Tmp = cast<ConstantFP>(CPV)->getValue();
 387     output_double(Tmp);
 388     break;
 389   }
 390
 391   case Type::VoidTyID:
 392   case Type::LabelTyID:
 393   default:
 394     cerr << __FILE__ << ":" << __LINE__ << ": Don't know how to serialize"
 395          << " type '" << *CPV->getType() << "'\n";
 396     break;
 397   }
 398   return;
 399 }
 400
 401 /// outputInlineAsm - InlineAsm's get emitted to the constant pool, so they can
 402 /// be shared by multiple uses.
 403 void BytecodeWriter::outputInlineAsm(const InlineAsm *IA) {
 404   // Output a marker, so we know when we have one one parsing the constant pool.
 405   // Note that this encoding is 5 bytes: not very efficient for a marker.  Since
 406   // unique inline asms are rare, this should hardly matter.
 407   output_vbr(~0U);
 408
 409   output(IA->getAsmString());
 410   output(IA->getConstraintString());
 411   output_vbr(unsigned(IA->hasSideEffects()));
 412 }
 413
 414 void BytecodeWriter::outputConstantStrings() {
 415   SlotCalculator::string_iterator I = Table.string_begin();
 416   SlotCalculator::string_iterator E = Table.string_end();
 417   if (I == E) return;  // No strings to emit
 418
 419   // If we have != 0 strings to emit, output them now.  Strings are emitted into
 420   // the 'void' type plane.
 421   output_vbr(unsigned(E-I));
 422   output_typeid(Type::VoidTyID);
 423
 424   // Emit all of the strings.
 425   for (I = Table.string_begin(); I != E; ++I) {
 426     const ConstantArray *Str = *I;
 427     int Slot = Table.getSlot(Str->getType());
 428     assert(Slot != -1 && "Constant string of unknown type?");
 429     output_typeid((unsigned)Slot);
 430
 431     // Now that we emitted the type (which indicates the size of the string),
 432     // emit all of the characters.
 433     std::string Val = Str->getAsString();
 434     output_data(Val.c_str(), Val.c_str()+Val.size());
 435   }
 436 }
 437
 438 //===----------------------------------------------------------------------===//
 439 //===                           Instruction Output                         ===//
 440 //===----------------------------------------------------------------------===//
 441
 442 // outputInstructionFormat0 - Output those weird instructions that have a large
 443 // number of operands or have large operands themselves.
 444 //
 445 // Format: [opcode] [type] [numargs] [arg0] [arg1] ... [arg<numargs-1>]
 446 //
 447 void BytecodeWriter::outputInstructionFormat0(const Instruction *I,
 448                                               unsigned Opcode,
 449                                               const SlotCalculator &Table,
 450                                               unsigned Type) {
 451   // Opcode must have top two bits clear...
 452   output_vbr(Opcode << 2);                  // Instruction Opcode ID
 453   output_typeid(Type);                      // Result type
 454
 455   unsigned NumArgs = I->getNumOperands();
 456   output_vbr(NumArgs + (isa<CastInst>(I)  || isa<InvokeInst>(I) ||
 457                         isa<CmpInst>(I) || isa<VAArgInst>(I) || Opcode == 58));
 458
 459   if (!isa<GetElementPtrInst>(&I)) {
 460     for (unsigned i = 0; i < NumArgs; ++i) {
 461       int Slot = Table.getSlot(I->getOperand(i));
 462       assert(Slot >= 0 && "No slot number for value!?!?");
 463       output_vbr((unsigned)Slot);
 464     }
 465
 466     if (isa<CastInst>(I) || isa<VAArgInst>(I)) {
 467       int Slot = Table.getSlot(I->getType());
 468       assert(Slot != -1 && "Cast return type unknown?");
 469       output_typeid((unsigned)Slot);
 470     } else if (isa<CmpInst>(I)) {
 471       output_vbr(unsigned(cast<CmpInst>(I)->getPredicate()));
 472     } else if (isa<InvokeInst>(I)) {
 473       output_vbr(cast<InvokeInst>(I)->getCallingConv());
 474     } else if (Opcode == 58) {  // Call escape sequence
 475       output_vbr((cast<CallInst>(I)->getCallingConv() << 1) |
 476                  unsigned(cast<CallInst>(I)->isTailCall()));
 477     }
 478   } else {
 479     int Slot = Table.getSlot(I->getOperand(0));
 480     assert(Slot >= 0 && "No slot number for value!?!?");
 481     output_vbr(unsigned(Slot));
 482
 483     // We need to encode the type of sequential type indices into their slot #
 484     unsigned Idx = 1;
 485     for (gep_type_iterator TI = gep_type_begin(I), E = gep_type_end(I);
 486          Idx != NumArgs; ++TI, ++Idx) {
 487       Slot = Table.getSlot(I->getOperand(Idx));
 488       assert(Slot >= 0 && "No slot number for value!?!?");
 489
 490       if (isa<SequentialType>(*TI)) {
 491         // These should be either 32-bits or 64-bits, however, with bit
 492         // accurate types we just distinguish between less than or equal to
 493         // 32-bits or greater than 32-bits.
 494         const IntegerType *IdxTy =
 495           cast<IntegerType>(I->getOperand(Idx)->getType());
 496         unsigned IdxId = IdxTy->getBitWidth() <= 32 ? 0 : 1;
 497         Slot = (Slot << 1) | IdxId;
 498       }
 499       output_vbr(unsigned(Slot));
 500     }
 501   }
 502 }
 503
 504
 505 // outputInstrVarArgsCall - Output the absurdly annoying varargs function calls.
 506 // This are more annoying than most because the signature of the call does not
 507 // tell us anything about the types of the arguments in the varargs portion.
 508 // Because of this, we encode (as type 0) all of the argument types explicitly
 509 // before the argument value.  This really sucks, but you shouldn't be using
 510 // varargs functions in your code! *death to printf*!
 511 //
 512 // Format: [opcode] [type] [numargs] [arg0] [arg1] ... [arg<numargs-1>]
 513 //
 514 void BytecodeWriter::outputInstrVarArgsCall(const Instruction *I,
 515                                             unsigned Opcode,
 516                                             const SlotCalculator &Table,
 517                                             unsigned Type) {
 518   assert(isa<CallInst>(I) || isa<InvokeInst>(I));
 519   // Opcode must have top two bits clear...
 520   output_vbr(Opcode << 2);                  // Instruction Opcode ID
 521   output_typeid(Type);                      // Result type (varargs type)
 522
 523   const PointerType *PTy = cast<PointerType>(I->getOperand(0)->getType());
 524   const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
 525   unsigned NumParams = FTy->getNumParams();
 526
 527   unsigned NumFixedOperands;
 528   if (isa<CallInst>(I)) {
 529     // Output an operand for the callee and each fixed argument, then two for
 530     // each variable argument.
 531     NumFixedOperands = 1+NumParams;
 532   } else {
 533     assert(isa<InvokeInst>(I) && "Not call or invoke??");
 534     // Output an operand for the callee and destinations, then two for each
 535     // variable argument.
 536     NumFixedOperands = 3+NumParams;
 537   }
 538   output_vbr(2 * I->getNumOperands()-NumFixedOperands +
 539       unsigned(Opcode == 58 || isa<InvokeInst>(I)));
 540
 541   // The type for the function has already been emitted in the type field of the
 542   // instruction.  Just emit the slot # now.
 543   for (unsigned i = 0; i != NumFixedOperands; ++i) {
 544     int Slot = Table.getSlot(I->getOperand(i));
 545     assert(Slot >= 0 && "No slot number for value!?!?");
 546     output_vbr((unsigned)Slot);
 547   }
 548
 549   for (unsigned i = NumFixedOperands, e = I->getNumOperands(); i != e; ++i) {
 550     // Output Arg Type ID
 551     int Slot = Table.getSlot(I->getOperand(i)->getType());
 552     assert(Slot >= 0 && "No slot number for value!?!?");
 553     output_typeid((unsigned)Slot);
 554
 555     // Output arg ID itself
 556     Slot = Table.getSlot(I->getOperand(i));
 557     assert(Slot >= 0 && "No slot number for value!?!?");
 558     output_vbr((unsigned)Slot);
 559   }
 560
 561   if (isa<InvokeInst>(I)) {
 562     // Emit the tail call/calling conv for invoke instructions
 563     output_vbr(cast<InvokeInst>(I)->getCallingConv());
 564   } else if (Opcode == 58) {
 565     const CallInst *CI = cast<CallInst>(I);
 566     output_vbr((CI->getCallingConv() << 1) | unsigned(CI->isTailCall()));
 567   }
 568 }
 569
 570
 571 // outputInstructionFormat1 - Output one operand instructions, knowing that no
 572 // operand index is >= 2^12.
 573 //
 574 inline void BytecodeWriter::outputInstructionFormat1(const Instruction *I,
 575                                                      unsigned Opcode,
 576                                                      unsigned *Slots,
 577                                                      unsigned Type) {
 578   // bits   Instruction format:
 579   // --------------------------
 580   // 01-00: Opcode type, fixed to 1.
 581   // 07-02: Opcode
 582   // 19-08: Resulting type plane
 583   // 31-20: Operand #1 (if set to (2^12-1), then zero operands)
 584   //
 585   output(1 | (Opcode << 2) | (Type << 8) | (Slots[0] << 20));
 586 }
 587
 588
 589 // outputInstructionFormat2 - Output two operand instructions, knowing that no
 590 // operand index is >= 2^8.
 591 //
 592 inline void BytecodeWriter::outputInstructionFormat2(const Instruction *I,
 593                                                      unsigned Opcode,
 594                                                      unsigned *Slots,
 595                                                      unsigned Type) {
 596   // bits   Instruction format:
 597   // --------------------------
 598   // 01-00: Opcode type, fixed to 2.
 599   // 07-02: Opcode
 600   // 15-08: Resulting type plane
 601   // 23-16: Operand #1
 602   // 31-24: Operand #2
 603   //
 604   output(2 | (Opcode << 2) | (Type << 8) | (Slots[0] << 16) | (Slots[1] << 24));
 605 }
 606
 607
 608 // outputInstructionFormat3 - Output three operand instructions, knowing that no
 609 // operand index is >= 2^6.
 610 //
 611 inline void BytecodeWriter::outputInstructionFormat3(const Instruction *I,
 612                                                      unsigned Opcode,
 613                                                      unsigned *Slots,
 614                                                      unsigned Type) {
 615   // bits   Instruction format:
 616   // --------------------------
 617   // 01-00: Opcode type, fixed to 3.
 618   // 07-02: Opcode
 619   // 13-08: Resulting type plane
 620   // 19-14: Operand #1
 621   // 25-20: Operand #2
 622   // 31-26: Operand #3
 623   //
 624   output(3 | (Opcode << 2) | (Type << 8) |
 625           (Slots[0] << 14) | (Slots[1] << 20) | (Slots[2] << 26));
 626 }
 627
 628 void BytecodeWriter::outputInstruction(const Instruction &I) {
 629   assert(I.getOpcode() < 57 && "Opcode too big???");
 630   unsigned Opcode = I.getOpcode();
 631   unsigned NumOperands = I.getNumOperands();
 632
 633   // Encode 'tail call' as 61, 'volatile load' as 62, and 'volatile store' as
 634   // 63.
 635   if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
 636     if (CI->getCallingConv() == CallingConv::C) {
 637       if (CI->isTailCall())
 638         Opcode = 61;   // CCC + Tail Call
 639       else
 640         ;     // Opcode = Instruction::Call
 641     } else if (CI->getCallingConv() == CallingConv::Fast) {
 642       if (CI->isTailCall())
 643         Opcode = 59;    // FastCC + TailCall
 644       else
 645         Opcode = 60;    // FastCC + Not Tail Call
 646     } else {
 647       Opcode = 58;      // Call escape sequence.
 648     }
 649   } else if (isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) {
 650     Opcode = 62;
 651   } else if (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) {
 652     Opcode = 63;
 653   }
 654
 655   // Figure out which type to encode with the instruction.  Typically we want
 656   // the type of the first parameter, as opposed to the type of the instruction
 657   // (for example, with setcc, we always know it returns bool, but the type of
 658   // the first param is actually interesting).  But if we have no arguments
 659   // we take the type of the instruction itself.
 660   //
 661   const Type *Ty;
 662   switch (I.getOpcode()) {
 663   case Instruction::Select:
 664   case Instruction::Malloc:
 665   case Instruction::Alloca:
 666     Ty = I.getType();  // These ALWAYS want to encode the return type
 667     break;
 668   case Instruction::Store:
 669     Ty = I.getOperand(1)->getType();  // Encode the pointer type...
 670     assert(isa<PointerType>(Ty) && "Store to nonpointer type!?!?");
 671     break;
 672   default:              // Otherwise use the default behavior...
 673     Ty = NumOperands ? I.getOperand(0)->getType() : I.getType();
 674     break;
 675   }
 676
 677   unsigned Type;
 678   int Slot = Table.getSlot(Ty);
 679   assert(Slot != -1 && "Type not available!!?!");
 680   Type = (unsigned)Slot;
 681
 682   // Varargs calls and invokes are encoded entirely different from any other
 683   // instructions.
 684   if (const CallInst *CI = dyn_cast<CallInst>(&I)){
 685     const PointerType *Ty =cast<PointerType>(CI->getCalledValue()->getType());
 686     if (cast<FunctionType>(Ty->getElementType())->isVarArg()) {
 687       outputInstrVarArgsCall(CI, Opcode, Table, Type);
 688       return;
 689     }
 690   } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
 691     const PointerType *Ty =cast<PointerType>(II->getCalledValue()->getType());
 692     if (cast<FunctionType>(Ty->getElementType())->isVarArg()) {
 693       outputInstrVarArgsCall(II, Opcode, Table, Type);
 694       return;
 695     }
 696   }
 697
 698   if (NumOperands <= 3) {
 699     // Make sure that we take the type number into consideration.  We don't want
 700     // to overflow the field size for the instruction format we select.
 701     //
 702     unsigned MaxOpSlot = Type;
 703     unsigned Slots[3]; Slots[0] = (1 << 12)-1;   // Marker to signify 0 operands
 704
 705     for (unsigned i = 0; i != NumOperands; ++i) {
 706       int slot = Table.getSlot(I.getOperand(i));
 707       assert(slot != -1 && "Broken bytecode!");
 708       if (unsigned(slot) > MaxOpSlot) MaxOpSlot = unsigned(slot);
 709       Slots[i] = unsigned(slot);
 710     }
 711
 712     // Handle the special cases for various instructions...
 713     if (isa<CastInst>(I) || isa<VAArgInst>(I)) {
 714       // Cast has to encode the destination type as the second argument in the
 715       // packet, or else we won't know what type to cast to!
 716       Slots[1] = Table.getSlot(I.getType());
 717       assert(Slots[1] != ~0U && "Cast return type unknown?");
 718       if (Slots[1] > MaxOpSlot) MaxOpSlot = Slots[1];
 719       NumOperands++;
 720     } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
 721       assert(NumOperands == 1 && "Bogus allocation!");
 722       if (AI->getAlignment()) {
 723         Slots[1] = Log2_32(AI->getAlignment())+1;
 724         if (Slots[1] > MaxOpSlot) MaxOpSlot = Slots[1];
 725         NumOperands = 2;
 726       }
 727     } else if (isa<ICmpInst>(I) || isa<FCmpInst>(I)) {
 728       // We need to encode the compare instruction's predicate as the third
 729       // operand. Its not really a slot, but we don't want to break the
 730       // instruction format for these instructions.
 731       NumOperands++;
 732       assert(NumOperands == 3 && "CmpInst with wrong number of operands?");
 733       Slots[2] = unsigned(cast<CmpInst>(&I)->getPredicate());
 734       if (Slots[2] > MaxOpSlot)
 735         MaxOpSlot = Slots[2];
 736     } else if (const GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(&I)) {
 737       // We need to encode the type of sequential type indices into their slot #
 738       unsigned Idx = 1;
 739       for (gep_type_iterator I = gep_type_begin(GEP), E = gep_type_end(GEP);
 740            I != E; ++I, ++Idx)
 741         if (isa<SequentialType>(*I)) {
 742           // These should be either 32-bits or 64-bits, however, with bit
 743           // accurate types we just distinguish between less than or equal to
 744           // 32-bits or greater than 32-bits.
 745           const IntegerType *IdxTy =
 746             cast<IntegerType>(GEP->getOperand(Idx)->getType());
 747           unsigned IdxId = IdxTy->getBitWidth() <= 32 ? 0 : 1;
 748           Slots[Idx] = (Slots[Idx] << 1) | IdxId;
 749           if (Slots[Idx] > MaxOpSlot) MaxOpSlot = Slots[Idx];
 750         }
 751     } else if (Opcode == 58) {
 752       // If this is the escape sequence for call, emit the tailcall/cc info.
 753       const CallInst &CI = cast<CallInst>(I);
 754       ++NumOperands;
 755       if (NumOperands <= 3) {
 756         Slots[NumOperands-1] =
 757           (CI.getCallingConv() << 1)|unsigned(CI.isTailCall());
 758         if (Slots[NumOperands-1] > MaxOpSlot)
 759           MaxOpSlot = Slots[NumOperands-1];
 760       }
 761     } else if (isa<InvokeInst>(I)) {
 762       // Invoke escape seq has at least 4 operands to encode.
 763       ++NumOperands;
 764     }
 765
 766     // Decide which instruction encoding to use.  This is determined primarily
 767     // by the number of operands, and secondarily by whether or not the max
 768     // operand will fit into the instruction encoding.  More operands == fewer
 769     // bits per operand.
 770     //
 771     switch (NumOperands) {
 772     case 0:
 773     case 1:
 774       if (MaxOpSlot < (1 << 12)-1) { // -1 because we use 4095 to indicate 0 ops
 775         outputInstructionFormat1(&I, Opcode, Slots, Type);
 776         return;
 777       }
 778       break;
 779
 780     case 2:
 781       if (MaxOpSlot < (1 << 8)) {
 782         outputInstructionFormat2(&I, Opcode, Slots, Type);
 783         return;
 784       }
 785       break;
 786
 787     case 3:
 788       if (MaxOpSlot < (1 << 6)) {
 789         outputInstructionFormat3(&I, Opcode, Slots, Type);
 790         return;
 791       }
 792       break;
 793     default:
 794       break;
 795     }
 796   }
 797
 798   // If we weren't handled before here, we either have a large number of
 799   // operands or a large operand index that we are referring to.
 800   outputInstructionFormat0(&I, Opcode, Table, Type);
 801 }
 802
 803 //===----------------------------------------------------------------------===//
 804 //===                              Block Output                            ===//
 805 //===----------------------------------------------------------------------===//
 806
 807 BytecodeWriter::BytecodeWriter(std::vector<unsigned char> &o, const Module *M)
 808   : Out(o), Table(M) {
 809
 810   // Emit the signature...
 811   static const unsigned char *Sig = (const unsigned char*)"llvm";
 812   output_data(Sig, Sig+4);
 813
 814   // Emit the top level CLASS block.
 815   BytecodeBlock ModuleBlock(BytecodeFormat::ModuleBlockID, *this, false, true);
 816
 817   bool isBigEndian      = M->getEndianness() == Module::BigEndian;
 818   bool hasLongPointers  = M->getPointerSize() == Module::Pointer64;
 819   bool hasNoEndianness  = M->getEndianness() == Module::AnyEndianness;
 820   bool hasNoPointerSize = M->getPointerSize() == Module::AnyPointerSize;
 821
 822   // Output the version identifier and other information.
 823   unsigned Version = (BCVersionNum << 4) |
 824                      (unsigned)isBigEndian | (hasLongPointers << 1) |
 825                      (hasNoEndianness << 2) |
 826                      (hasNoPointerSize << 3);
 827   output_vbr(Version);
 828
 829   // The Global type plane comes first
 830   {
 831     BytecodeBlock CPool(BytecodeFormat::GlobalTypePlaneBlockID, *this);
 832     outputTypes(Type::FirstDerivedTyID);
 833   }
 834
 835   // The ModuleInfoBlock follows directly after the type information
 836   outputModuleInfoBlock(M);
 837
 838   // Output module level constants, used for global variable initializers
 839   outputConstants(false);
 840
 841   // Do the whole module now! Process each function at a time...
 842   for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
 843     outputFunction(I);
 844
 845   // Output the symbole table for types
 846   outputTypeSymbolTable(M->getTypeSymbolTable());
 847
 848   // Output the symbol table for values
 849   outputValueSymbolTable(M->getValueSymbolTable());
 850 }
 851
 852 void BytecodeWriter::outputTypes(unsigned TypeNum) {
 853   // Write the type plane for types first because earlier planes (e.g. for a
 854   // primitive type like float) may have constants constructed using types
 855   // coming later (e.g., via getelementptr from a pointer type).  The type
 856   // plane is needed before types can be fwd or bkwd referenced.
 857   const std::vector<const Type*>& Types = Table.getTypes();
 858   assert(!Types.empty() && "No types at all?");
 859   assert(TypeNum <= Types.size() && "Invalid TypeNo index");
 860
 861   unsigned NumEntries = Types.size() - TypeNum;
 862
 863   // Output type header: [num entries]
 864   output_vbr(NumEntries);
 865
 866   for (unsigned i = TypeNum; i < TypeNum+NumEntries; ++i)
 867     outputType(Types[i]);
 868 }
 869
 870 // Helper function for outputConstants().
 871 // Writes out all the constants in the plane Plane starting at entry StartNo.
 872 //
 873 void BytecodeWriter::outputConstantsInPlane(const std::vector<const Value*>
 874                                             &Plane, unsigned StartNo) {
 875   unsigned ValNo = StartNo;
 876
 877   // Scan through and ignore function arguments, global values, and constant
 878   // strings.
 879   for (; ValNo < Plane.size() &&
 880          (isa<Argument>(Plane[ValNo]) || isa<GlobalValue>(Plane[ValNo]) ||
 881           (isa<ConstantArray>(Plane[ValNo]) &&
 882            cast<ConstantArray>(Plane[ValNo])->isString())); ValNo++)
 883     /*empty*/;
 884
 885   unsigned NC = ValNo;              // Number of constants
 886   for (; NC < Plane.size() && (isa<Constant>(Plane[NC]) ||
 887                                isa<InlineAsm>(Plane[NC])); NC++)
 888     /*empty*/;
 889   NC -= ValNo;                      // Convert from index into count
 890   if (NC == 0) return;              // Skip empty type planes...
 891
 892   // FIXME: Most slabs only have 1 or 2 entries!  We should encode this much
 893   // more compactly.
 894
 895   // Put out type header: [num entries][type id number]
 896   //
 897   output_vbr(NC);
 898
 899   // Put out the Type ID Number...
 900   int Slot = Table.getSlot(Plane.front()->getType());
 901   assert (Slot != -1 && "Type in constant pool but not in function!!");
 902   output_typeid((unsigned)Slot);
 903
 904   for (unsigned i = ValNo; i < ValNo+NC; ++i) {
 905     const Value *V = Plane[i];
 906     if (const Constant *C = dyn_cast<Constant>(V))
 907       outputConstant(C);
 908     else
 909       outputInlineAsm(cast<InlineAsm>(V));
 910   }
 911 }
 912
 913 static inline bool hasNullValue(const Type *Ty) {
 914   return Ty != Type::LabelTy && Ty != Type::VoidTy && !isa<OpaqueType>(Ty);
 915 }
 916
 917 void BytecodeWriter::outputConstants(bool isFunction) {
 918   BytecodeBlock CPool(BytecodeFormat::ConstantPoolBlockID, *this,
 919                       true  /* Elide block if empty */);
 920
 921   unsigned NumPlanes = Table.getNumPlanes();
 922
 923   if (isFunction)
 924     // Output the type plane before any constants!
 925     outputTypes(Table.getModuleTypeLevel());
 926   else
 927     // Output module-level string constants before any other constants.
 928     outputConstantStrings();
 929
 930   for (unsigned pno = 0; pno != NumPlanes; pno++) {
 931     const std::vector<const Value*> &Plane = Table.getPlane(pno);
 932     if (!Plane.empty()) {              // Skip empty type planes...
 933       unsigned ValNo = 0;
 934       if (isFunction)                  // Don't re-emit module constants
 935         ValNo += Table.getModuleLevel(pno);
 936
 937       if (hasNullValue(Plane[0]->getType())) {
 938         // Skip zero initializer
 939         if (ValNo == 0)
 940           ValNo = 1;
 941       }
 942
 943       // Write out constants in the plane
 944       outputConstantsInPlane(Plane, ValNo);
 945     }
 946   }
 947 }
 948
 949 static unsigned getEncodedLinkage(const GlobalValue *GV) {
 950   switch (GV->getLinkage()) {
 951   default: assert(0 && "Invalid linkage!");
 952   case GlobalValue::ExternalLinkage:     return 0;
 953   case GlobalValue::WeakLinkage:         return 1;
 954   case GlobalValue::AppendingLinkage:    return 2;
 955   case GlobalValue::InternalLinkage:     return 3;
 956   case GlobalValue::LinkOnceLinkage:     return 4;
 957   case GlobalValue::DLLImportLinkage:    return 5;
 958   case GlobalValue::DLLExportLinkage:    return 6;
 959   case GlobalValue::ExternalWeakLinkage: return 7;
 960   }
 961 }
 962
 963 void BytecodeWriter::outputModuleInfoBlock(const Module *M) {
 964   BytecodeBlock ModuleInfoBlock(BytecodeFormat::ModuleGlobalInfoBlockID, *this);
 965
 966   // Give numbers to sections as we encounter them.
 967   unsigned SectionIDCounter = 0;
 968   std::vector<std::string> SectionNames;
 969   std::map<std::string, unsigned> SectionID;
 970
 971   // Output the types for the global variables in the module...
 972   for (Module::const_global_iterator I = M->global_begin(),
 973          End = M->global_end(); I != End; ++I) {
 974     int Slot = Table.getSlot(I->getType());
 975     assert(Slot != -1 && "Module global vars is broken!");
 976
 977     assert((I->hasInitializer() || !I->hasInternalLinkage()) &&
 978            "Global must have an initializer or have external linkage!");
 979
 980     // Fields: bit0 = isConstant, bit1 = hasInitializer, bit2-4=Linkage,
 981     // bit5+ = Slot # for type.
 982     bool HasExtensionWord = (I->getAlignment() != 0) || I->hasSection();
 983
 984     // If we need to use the extension byte, set linkage=3(internal) and
 985     // initializer = 0 (impossible!).
 986     if (!HasExtensionWord) {
 987       unsigned oSlot = ((unsigned)Slot << 5) | (getEncodedLinkage(I) << 2) |
 988                         (I->hasInitializer() << 1) | (unsigned)I->isConstant();
 989       output_vbr(oSlot);
 990     } else {
 991       unsigned oSlot = ((unsigned)Slot << 5) | (3 << 2) |
 992                         (0 << 1) | (unsigned)I->isConstant();
 993       output_vbr(oSlot);
 994
 995       // The extension word has this format: bit 0 = has initializer, bit 1-3 =
 996       // linkage, bit 4-8 = alignment (log2), bit 9 = has SectionID,
 997       // bits 10+ = future use.
 998       unsigned ExtWord = (unsigned)I->hasInitializer() |
 999                          (getEncodedLinkage(I) << 1) |
1000                          ((Log2_32(I->getAlignment())+1) << 4) |
1001                          ((unsigned)I->hasSection() << 9);
1002       output_vbr(ExtWord);
1003       if (I->hasSection()) {
1004         // Give section names unique ID's.
1005         unsigned &Entry = SectionID[I->getSection()];
1006         if (Entry == 0) {
1007           Entry = ++SectionIDCounter;
1008           SectionNames.push_back(I->getSection());
1009         }
1010         output_vbr(Entry);
1011       }
1012     }
1013
1014     // If we have an initializer, output it now.
1015     if (I->hasInitializer()) {
1016       Slot = Table.getSlot((Value*)I->getInitializer());
1017       assert(Slot != -1 && "No slot for global var initializer!");
1018       output_vbr((unsigned)Slot);
1019     }
1020   }
1021   output_typeid((unsigned)Table.getSlot(Type::VoidTy));
1022
1023   // Output the types of the functions in this module.
1024   for (Module::const_iterator I = M->begin(), End = M->end(); I != End; ++I) {
1025     int Slot = Table.getSlot(I->getType());
1026     assert(Slot != -1 && "Module slot calculator is broken!");
1027     assert(Slot >= Type::FirstDerivedTyID && "Derived type not in range!");
1028     assert(((Slot << 6) >> 6) == Slot && "Slot # too big!");
1029     unsigned CC = I->getCallingConv()+1;
1030     unsigned ID = (Slot << 5) | (CC & 15);
1031
1032     if (I->isExternal())   // If external, we don't have an FunctionInfo block.
1033       ID |= 1 << 4;
1034
1035     if (I->getAlignment() || I->hasSection() || (CC & ~15) != 0 ||
1036         (I->isExternal() && I->hasDLLImportLinkage()) ||
1037         (I->isExternal() && I->hasExternalWeakLinkage())
1038        )
1039       ID |= 1 << 31;       // Do we need an extension word?
1040
1041     output_vbr(ID);
1042
1043     if (ID & (1 << 31)) {
1044       // Extension byte: bits 0-4 = alignment, bits 5-9 = top nibble of calling
1045       // convention, bit 10 = hasSectionID., bits 11-12 = external linkage type
1046       unsigned extLinkage = 0;
1047
1048       if (I->isExternal()) {
1049         if (I->hasDLLImportLinkage()) {
1050           extLinkage = 1;
1051         } else if (I->hasExternalWeakLinkage()) {
1052           extLinkage = 2;
1053         }
1054       }
1055
1056       ID = (Log2_32(I->getAlignment())+1) | ((CC >> 4) << 5) |
1057         (I->hasSection() << 10) |
1058         ((extLinkage & 3) << 11);
1059       output_vbr(ID);
1060
1061       // Give section names unique ID's.
1062       if (I->hasSection()) {
1063         unsigned &Entry = SectionID[I->getSection()];
1064         if (Entry == 0) {
1065           Entry = ++SectionIDCounter;
1066           SectionNames.push_back(I->getSection());
1067         }
1068         output_vbr(Entry);
1069       }
1070     }
1071   }
1072   output_vbr((unsigned)Table.getSlot(Type::VoidTy) << 5);
1073
1074   // Emit the list of dependent libraries for the Module.
1075   Module::lib_iterator LI = M->lib_begin();
1076   Module::lib_iterator LE = M->lib_end();
1077   output_vbr(unsigned(LE - LI));   // Emit the number of dependent libraries.
1078   for (; LI != LE; ++LI)
1079     output(*LI);
1080
1081   // Output the target triple from the module
1082   output(M->getTargetTriple());
1083
1084   // Emit the table of section names.
1085   output_vbr((unsigned)SectionNames.size());
1086   for (unsigned i = 0, e = SectionNames.size(); i != e; ++i)
1087     output(SectionNames[i]);
1088
1089   // Output the inline asm string.
1090   output(M->getModuleInlineAsm());
1091 }
1092
1093 void BytecodeWriter::outputInstructions(const Function *F) {
1094   BytecodeBlock ILBlock(BytecodeFormat::InstructionListBlockID, *this);
1095   for (Function::const_iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
1096     for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I!=E; ++I)
1097       outputInstruction(*I);
1098 }
1099
1100 void BytecodeWriter::outputFunction(const Function *F) {
1101   // If this is an external function, there is nothing else to emit!
1102   if (F->isExternal()) return;
1103
1104   BytecodeBlock FunctionBlock(BytecodeFormat::FunctionBlockID, *this);
1105   output_vbr(getEncodedLinkage(F));
1106
1107   // Get slot information about the function...
1108   Table.incorporateFunction(F);
1109
1110   if (Table.getCompactionTable().empty()) {
1111     // Output information about the constants in the function if the compaction
1112     // table is not being used.
1113     outputConstants(true);
1114   } else {
1115     // Otherwise, emit the compaction table.
1116     outputCompactionTable();
1117   }
1118
1119   // Output all of the instructions in the body of the function
1120   outputInstructions(F);
1121
1122   // If needed, output the symbol table for the function...
1123   outputValueSymbolTable(F->getValueSymbolTable());
1124
1125   Table.purgeFunction();
1126 }
1127
1128 void BytecodeWriter::outputCompactionTablePlane(unsigned PlaneNo,
1129                                          const std::vector<const Value*> &Plane,
1130                                                 unsigned StartNo) {
1131   unsigned End = Table.getModuleLevel(PlaneNo);
1132   if (Plane.empty() || StartNo == End || End == 0) return;   // Nothing to emit
1133   assert(StartNo < End && "Cannot emit negative range!");
1134   assert(StartNo < Plane.size() && End <= Plane.size());
1135
1136   // Do not emit the null initializer!
1137   ++StartNo;
1138
1139   // Figure out which encoding to use.  By far the most common case we have is
1140   // to emit 0-2 entries in a compaction table plane.
1141   switch (End-StartNo) {
1142   case 0:         // Avoid emitting two vbr's if possible.
1143   case 1:
1144   case 2:
1145     output_vbr((PlaneNo << 2) | End-StartNo);
1146     break;
1147   default:
1148     // Output the number of things.
1149     output_vbr((unsigned(End-StartNo) << 2) | 3);
1150     output_typeid(PlaneNo);                 // Emit the type plane this is
1151     break;
1152   }
1153
1154   for (unsigned i = StartNo; i != End; ++i)
1155     output_vbr(Table.getGlobalSlot(Plane[i]));
1156 }
1157
1158 void BytecodeWriter::outputCompactionTypes(unsigned StartNo) {
1159   // Get the compaction type table from the slot calculator
1160   const std::vector<const Type*> &CTypes = Table.getCompactionTypes();
1161
1162   // The compaction types may have been uncompactified back to the
1163   // global types. If so, we just write an empty table
1164   if (CTypes.size() == 0) {
1165     output_vbr(0U);
1166     return;
1167   }
1168
1169   assert(CTypes.size() >= StartNo && "Invalid compaction types start index");
1170
1171   // Determine how many types to write
1172   unsigned NumTypes = CTypes.size() - StartNo;
1173
1174   // Output the number of types.
1175   output_vbr(NumTypes);
1176
1177   for (unsigned i = StartNo; i < StartNo+NumTypes; ++i)
1178     output_typeid(Table.getGlobalSlot(CTypes[i]));
1179 }
1180
1181 void BytecodeWriter::outputCompactionTable() {
1182   // Avoid writing the compaction table at all if there is no content.
1183   if (Table.getCompactionTypes().size() >= Type::FirstDerivedTyID ||
1184       (!Table.CompactionTableIsEmpty())) {
1185     BytecodeBlock CTB(BytecodeFormat::CompactionTableBlockID, *this,
1186                       true/*ElideIfEmpty*/);
1187     const std::vector<std::vector<const Value*> > &CT =
1188       Table.getCompactionTable();
1189
1190     // First things first, emit the type compaction table if there is one.
1191     outputCompactionTypes(Type::FirstDerivedTyID);
1192
1193     for (unsigned i = 0, e = CT.size(); i != e; ++i)
1194       outputCompactionTablePlane(i, CT[i], 0);
1195   }
1196 }
1197
1198 void BytecodeWriter::outputTypeSymbolTable(const TypeSymbolTable &TST) {
1199   // Do not output the block for an empty symbol table, it just wastes
1200   // space!
1201   if (TST.empty()) return;
1202
1203   // Create a header for the symbol table
1204   BytecodeBlock SymTabBlock(BytecodeFormat::TypeSymbolTableBlockID, *this,
1205                             true/*ElideIfEmpty*/);
1206   // Write the number of types
1207   output_vbr(TST.size());
1208
1209   // Write each of the types
1210   for (TypeSymbolTable::const_iterator TI = TST.begin(), TE = TST.end();
1211        TI != TE; ++TI) {
1212     // Symtab entry:[def slot #][name]
1213     output_typeid((unsigned)Table.getSlot(TI->second));
1214     output(TI->first);
1215   }
1216 }
1217
1218 void BytecodeWriter::outputValueSymbolTable(const SymbolTable &MST) {
1219   // Do not output the Bytecode block for an empty symbol table, it just wastes
1220   // space!
1221   if (MST.isEmpty()) return;
1222
1223   BytecodeBlock SymTabBlock(BytecodeFormat::ValueSymbolTableBlockID, *this,
1224                             true/*ElideIfEmpty*/);
1225
1226   // Now do each of the type planes in order.
1227   for (SymbolTable::plane_const_iterator PI = MST.plane_begin(),
1228        PE = MST.plane_end(); PI != PE;  ++PI) {
1229     SymbolTable::value_const_iterator I = MST.value_begin(PI->first);
1230     SymbolTable::value_const_iterator End = MST.value_end(PI->first);
1231     int Slot;
1232
1233     if (I == End) continue;  // Don't mess with an absent type...
1234
1235     // Write the number of values in this plane
1236     output_vbr((unsigned)PI->second.size());
1237
1238     // Write the slot number of the type for this plane
1239     Slot = Table.getSlot(PI->first);
1240     assert(Slot != -1 && "Type in symtab, but not in table!");
1241     output_typeid((unsigned)Slot);
1242
1243     // Write each of the values in this plane
1244     for (; I != End; ++I) {
1245       // Symtab entry: [def slot #][name]
1246       Slot = Table.getSlot(I->second);
1247       assert(Slot != -1 && "Value in symtab but has no slot number!!");
1248       output_vbr((unsigned)Slot);
1249       output(I->first);
1250     }
1251   }
1252 }
1253
1254 void llvm::WriteBytecodeToFile(const Module *M, OStream &Out,
1255                                bool compress) {
1256   assert(M && "You can't write a null module!!");
1257
1258   // Make sure that std::cout is put into binary mode for systems
1259   // that care.
1260   if (Out == cout)
1261     sys::Program::ChangeStdoutToBinary();
1262
1263   // Create a vector of unsigned char for the bytecode output. We
1264   // reserve 256KBytes of space in the vector so that we avoid doing
1265   // lots of little allocations. 256KBytes is sufficient for a large
1266   // proportion of the bytecode files we will encounter. Larger files
1267   // will be automatically doubled in size as needed (std::vector
1268   // behavior).
1269   std::vector<unsigned char> Buffer;
1270   Buffer.reserve(256 * 1024);
1271
1272   // The BytecodeWriter populates Buffer for us.
1273   BytecodeWriter BCW(Buffer, M);
1274
1275   // Keep track of how much we've written
1276   BytesWritten += Buffer.size();
1277
1278   // Determine start and end points of the Buffer
1279   const unsigned char *FirstByte = &Buffer.front();
1280
1281   // If we're supposed to compress this mess ...
1282   if (compress) {
1283
1284     // We signal compression by using an alternate magic number for the
1285     // file. The compressed bytecode file's magic number is "llvc" instead
1286     // of "llvm".
1287     char compressed_magic[4];
1288     compressed_magic[0] = 'l';
1289     compressed_magic[1] = 'l';
1290     compressed_magic[2] = 'v';
1291     compressed_magic[3] = 'c';
1292
1293     Out.stream()->write(compressed_magic,4);
1294
1295     // Compress everything after the magic number (which we altered)
1296     Compressor::compressToStream(
1297       (char*)(FirstByte+4),        // Skip the magic number
1298       Buffer.size()-4,             // Skip the magic number
1299       *Out.stream()                // Where to write compressed data
1300     );
1301
1302   } else {
1303
1304     // We're not compressing, so just write the entire block.
1305     Out.stream()->write((char*)FirstByte, Buffer.size());
1306   }
1307
1308   // make sure it hits disk now
1309   Out.stream()->flush();
1310 }