lib/Bytecode/Writer/Writer.cpp

   1 //===-- Writer.cpp - Library for writing VM bytecode files -------*- C++ -*--=//
   2 //
   3 // This library implements the functionality defined in llvm/Bytecode/Writer.h
   4 //
   5 // This library uses the Analysis library to figure out offsets for
   6 // variables in the method tables...
   7 //
   8 // Note that this file uses an unusual technique of outputting all the bytecode
   9 // to a deque of unsigned char's, then copies the deque to an ostream.  The
  10 // reason for this is that we must do "seeking" in the stream to do back-
  11 // patching, and some very important ostreams that we want to support (like
  12 // pipes) do not support seeking.  :( :( :(
  13 //
  14 // The choice of the deque data structure is influenced by the extremely fast
  15 // "append" speed, plus the free "seek"/replace in the middle of the stream. I
  16 // didn't use a vector because the stream could end up very large and copying
  17 // the whole thing to reallocate would be kinda silly.
  18 //
  19 // Note that the performance of this library is not terribly important, because
  20 // it shouldn't be used by JIT type applications... so it is not a huge focus
  21 // at least.  :)
  22 //
  23 //===----------------------------------------------------------------------===//
  24
  25 #include "WriterInternals.h"
  26 #include "llvm/Module.h"
  27 #include "llvm/GlobalVariable.h"
  28 #include "llvm/Method.h"
  29 #include "llvm/BasicBlock.h"
  30 #include "llvm/ConstPoolVals.h"
  31 #include "llvm/SymbolTable.h"
  32 #include "llvm/DerivedTypes.h"
  33 #include "llvm/Support/STLExtras.h"
  34 #include <string.h>
  35 #include <algorithm>
  36
  37 BytecodeWriter::BytecodeWriter(deque<unsigned char> &o, const Module *M)
  38   : Out(o), Table(M, false) {
  39
  40   outputSignature();
  41
  42   // Emit the top level CLASS block.
  43   BytecodeBlock ModuleBlock(BytecodeFormat::Module, Out);
  44
  45   // Output the ID of first "derived" type:
  46   output_vbr((unsigned)Type::FirstDerivedTyID, Out);
  47   align32(Out);
  48
  49   // Output module level constants, including types used by the method protos
  50   outputConstants(false);
  51
  52   // The ModuleInfoBlock follows directly after the Module constant pool
  53   outputModuleInfoBlock(M);
  54
  55   // Do the whole module now! Process each method at a time...
  56   for_each(M->begin(), M->end(),
  57            bind_obj(this, &BytecodeWriter::processMethod));
  58
  59   // If needed, output the symbol table for the module...
  60   if (M->hasSymbolTable())
  61     outputSymbolTable(*M->getSymbolTable());
  62 }
  63
  64 // TODO: REMOVE
  65 #include "llvm/Assembly/Writer.h"
  66
  67 void BytecodeWriter::outputConstants(bool isMethod) {
  68   BytecodeBlock CPool(BytecodeFormat::ConstantPool, Out);
  69
  70   unsigned NumPlanes = Table.getNumPlanes();
  71   for (unsigned pno = 0; pno < NumPlanes; pno++) {
  72     const vector<const Value*> &Plane = Table.getPlane(pno);
  73     if (Plane.empty()) continue;      // Skip empty type planes...
  74
  75     unsigned ValNo = 0;
  76     if (isMethod)                     // Don't reemit module constants
  77       ValNo = Table.getModuleLevel(pno);
  78     else if (pno == Type::TypeTyID)
  79       ValNo = Type::FirstDerivedTyID; // Start emitting at the derived types...
  80
  81     // Scan through and ignore method arguments...
  82     for (; ValNo < Plane.size() && Plane[ValNo]->isMethodArgument(); ValNo++)
  83       /*empty*/;
  84
  85     unsigned NC = ValNo;              // Number of constants
  86     for (; NC < Plane.size() &&
  87            (Plane[NC]->isConstant() || Plane[NC]->isType()); NC++) /*empty*/;
  88     NC -= ValNo;                      // Convert from index into count
  89     if (NC == 0) continue;            // Skip empty type planes...
  90
  91     // Output type header: [num entries][type id number]
  92     //
  93     output_vbr(NC, Out);
  94
  95     // Output the Type ID Number...
  96     int Slot = Table.getValSlot(Plane.front()->getType());
  97     assert (Slot != -1 && "Type in constant pool but not in method!!");
  98     output_vbr((unsigned)Slot, Out);
  99
 100     //cout << "Emitting " << NC << " constants of type '"
 101     //   << Plane.front()->getType()->getName() << "' = Slot #" << Slot << endl;
 102
 103     for (unsigned i = ValNo; i < ValNo+NC; ++i) {
 104       const Value *V = Plane[i];
 105       if (const ConstPoolVal *CPV = V->castConstant()) {
 106         //cerr << "Serializing value: <" << V->getType() << ">: "
 107         //     << ((const ConstPoolVal*)V)->getStrValue() << ":"
 108         //     << Out.size() << "\n";
 109         outputConstant(CPV);
 110       } else {
 111         const Type *Ty = V->castTypeAsserting();
 112         outputType(Ty);
 113       }
 114     }
 115   }
 116 }
 117
 118 void BytecodeWriter::outputModuleInfoBlock(const Module *M) {
 119   BytecodeBlock ModuleInfoBlock(BytecodeFormat::ModuleGlobalInfo, Out);
 120
 121   // Output the types for the global variables in the module...
 122   for (Module::const_giterator I = M->gbegin(), End = M->gend(); I != End;++I) {
 123     const GlobalVariable *GV = *I;
 124     int Slot = Table.getValSlot(GV->getType());
 125     assert(Slot != -1 && "Module global vars is broken!");
 126
 127     // Fields: bit0 = isConstant, bit1 = hasInitializer, bit2+ = slot#
 128     unsigned oSlot = ((unsigned)Slot << 2) | (GV->hasInitializer() << 1) |
 129                         GV->isConstant();
 130     output_vbr(oSlot, Out);
 131
 132     // If we have an initialized, output it now.
 133     if (GV->hasInitializer()) {
 134       Slot = Table.getValSlot(GV->getInitializer());
 135       assert(Slot != -1 && "No slot for global var initializer!");
 136       output_vbr((unsigned)Slot, Out);
 137     }
 138   }
 139   output_vbr((unsigned)Table.getValSlot(Type::VoidTy), Out);
 140
 141   // Output the types of the methods in this module...
 142   for (Module::const_iterator I = M->begin(), End = M->end(); I != End; ++I) {
 143     int Slot = Table.getValSlot((*I)->getType());
 144     assert(Slot != -1 && "Module const pool is broken!");
 145     assert(Slot >= Type::FirstDerivedTyID && "Derived type not in range!");
 146     output_vbr((unsigned)Slot, Out);
 147   }
 148   output_vbr((unsigned)Table.getValSlot(Type::VoidTy), Out);
 149
 150
 151   align32(Out);
 152 }
 153
 154 void BytecodeWriter::processMethod(const Method *M) {
 155   BytecodeBlock MethodBlock(BytecodeFormat::Method, Out);
 156
 157   // Only output the constant pool and other goodies if needed...
 158   if (!M->isExternal()) {
 159     // Get slot information about the method...
 160     Table.incorporateMethod(M);
 161
 162     // Output information about the constants in the method...
 163     outputConstants(true);
 164
 165     // Output basic block nodes...
 166     for_each(M->begin(), M->end(),
 167              bind_obj(this, &BytecodeWriter::processBasicBlock));
 168
 169     // If needed, output the symbol table for the method...
 170     if (M->hasSymbolTable())
 171       outputSymbolTable(*M->getSymbolTable());
 172
 173     Table.purgeMethod();
 174   }
 175 }
 176
 177
 178 void BytecodeWriter::processBasicBlock(const BasicBlock *BB) {
 179   BytecodeBlock MethodBlock(BytecodeFormat::BasicBlock, Out);
 180   // Process all the instructions in the bb...
 181   for_each(BB->begin(), BB->end(),
 182            bind_obj(this, &BytecodeWriter::processInstruction));
 183 }
 184
 185 void BytecodeWriter::outputSymbolTable(const SymbolTable &MST) {
 186   BytecodeBlock MethodBlock(BytecodeFormat::SymbolTable, Out);
 187
 188   for (SymbolTable::const_iterator TI = MST.begin(); TI != MST.end(); ++TI) {
 189     SymbolTable::type_const_iterator I = MST.type_begin(TI->first);
 190     SymbolTable::type_const_iterator End = MST.type_end(TI->first);
 191     int Slot;
 192
 193     if (I == End) continue;  // Don't mess with an absent type...
 194
 195     // Symtab block header: [num entries][type id number]
 196     output_vbr(MST.type_size(TI->first), Out);
 197
 198     Slot = Table.getValSlot(TI->first);
 199     assert(Slot != -1 && "Type in symtab, but not in table!");
 200     output_vbr((unsigned)Slot, Out);
 201
 202     for (; I != End; ++I) {
 203       // Symtab entry: [def slot #][name]
 204       Slot = Table.getValSlot(I->second);
 205       assert(Slot != -1 && "Value in symtab but has no slot number!!");
 206       output_vbr((unsigned)Slot, Out);
 207       output(I->first, Out, false); // Don't force alignment...
 208     }
 209   }
 210 }
 211
 212 void WriteBytecodeToFile(const Module *C, ostream &Out) {
 213   assert(C && "You can't write a null module!!");
 214
 215   deque<unsigned char> Buffer;
 216
 217   // This object populates buffer for us...
 218   BytecodeWriter BCW(Buffer, C);
 219
 220   // Okay, write the deque out to the ostream now... the deque is not
 221   // sequential in memory, however, so write out as much as possible in big
 222   // chunks, until we're done.
 223   //
 224   deque<unsigned char>::const_iterator I = Buffer.begin(), E = Buffer.end();
 225   while (I != E) {                           // Loop until it's all written
 226     // Scan to see how big this chunk is...
 227     const unsigned char *ChunkPtr = &*I;
 228     const unsigned char *LastPtr = ChunkPtr;
 229     while (I != E) {
 230       const unsigned char *ThisPtr = &*++I;
 231       if (LastPtr+1 != ThisPtr) break;// Advanced by more than a byte of memory?
 232       LastPtr = ThisPtr;
 233     }
 234
 235     // Write out the chunk...
 236     Out.write(ChunkPtr, LastPtr-ChunkPtr+(I != E));
 237   }
 238
 239   Out.flush();
 240 }