lib/ExecutionEngine/JIT/JITEmitter.cpp

   1 //===-- Emitter.cpp - Write machine code to executable memory -------------===//
   2 //
   3 // This file defines a MachineCodeEmitter object that is used by Jello to write
   4 // machine code to memory and remember where relocatable values lie.
   5 //
   6 //===----------------------------------------------------------------------===//
   7
   8 #include "VM.h"
   9 #include "Config/sys/mman.h"
  10 #include "llvm/CodeGen/MachineCodeEmitter.h"
  11 #include "llvm/CodeGen/MachineFunction.h"
  12 #include "llvm/CodeGen/MachineConstantPool.h"
  13 #include "llvm/Target/TargetData.h"
  14 #include "llvm/Module.h"
  15 #include "Support/Statistic.h"
  16 #include <stdio.h>
  17
  18 namespace {
  19   Statistic<> NumBytes("jello", "Number of bytes of machine code compiled");
  20   VM *TheVM = 0;
  21
  22   class Emitter : public MachineCodeEmitter {
  23     // CurBlock - The start of the current block of memory.  CurByte - The
  24     // current byte being emitted to.
  25     unsigned char *CurBlock, *CurByte;
  26
  27     // When outputting a function stub in the context of some other function, we
  28     // save CurBlock and CurByte here.
  29     unsigned char *SavedCurBlock, *SavedCurByte;
  30
  31     // ConstantPoolAddresses - Contains the location for each entry in the
  32     // constant pool.
  33     std::vector<void*> ConstantPoolAddresses;
  34   public:
  35     Emitter(VM &vm) { TheVM = &vm; }
  36
  37     virtual void startFunction(MachineFunction &F);
  38     virtual void finishFunction(MachineFunction &F);
  39     virtual void emitConstantPool(MachineConstantPool *MCP);
  40     virtual void startFunctionStub(const Function &F, unsigned StubSize);
  41     virtual void* finishFunctionStub(const Function &F);
  42     virtual void emitByte(unsigned char B);
  43     virtual void emitWord(unsigned W);
  44
  45     virtual uint64_t getGlobalValueAddress(GlobalValue *V);
  46     virtual uint64_t getGlobalValueAddress(const std::string &Name);
  47     virtual uint64_t getConstantPoolEntryAddress(unsigned Entry);
  48     virtual uint64_t getCurrentPCValue();
  49
  50     // forceCompilationOf - Force the compilation of the specified function, and
  51     // return its address, because we REALLY need the address now.
  52     //
  53     // FIXME: This is JIT specific!
  54     //
  55     virtual uint64_t forceCompilationOf(Function *F);
  56   };
  57 }
  58
  59 MachineCodeEmitter *VM::createEmitter(VM &V) {
  60   return new Emitter(V);
  61 }
  62
  63
  64 #define _POSIX_MAPPED_FILES
  65 #include <unistd.h>
  66 #include <sys/mman.h>
  67
  68 // FIXME: This should be rewritten to support a real memory manager for
  69 // executable memory pages!
  70 static void *getMemory(unsigned NumPages) {
  71   void *pa;
  72   if (NumPages == 0) return 0;
  73   static const long pageSize = sysconf(_SC_PAGESIZE);
  74
  75 #if defined(i386) || defined(__i386__) || defined(__x86__)
  76   /* Linux and *BSD tend to have these flags named differently. */
  77 #if defined(MAP_ANON) && !defined(MAP_ANONYMOUS)
  78 # define MAP_ANONYMOUS MAP_ANON
  79 #endif /* defined(MAP_ANON) && !defined(MAP_ANONYMOUS) */
  80 #define fd  0
  81 #elif defined(sparc) || defined(__sparc__) || defined(__sparcv9)
  82 #define fd -1
  83 #else
  84   std::cerr << "This architecture is not supported by the JIT!\n";
  85   abort();
  86 #endif
  87   pa = mmap(0, pageSize*NumPages, PROT_READ|PROT_WRITE|PROT_EXEC,
  88             MAP_PRIVATE|MAP_ANONYMOUS, fd, 0);
  89   if (pa == MAP_FAILED) {
  90     perror("mmap");
  91     abort();
  92   }
  93   return pa;
  94 }
  95
  96
  97 void Emitter::startFunction(MachineFunction &F) {
  98   CurBlock = (unsigned char *)getMemory(16);
  99   CurByte = CurBlock;  // Start writing at the beginning of the fn.
 100   TheVM->addGlobalMapping(F.getFunction(), CurBlock);
 101 }
 102
 103 void Emitter::finishFunction(MachineFunction &F) {
 104   ConstantPoolAddresses.clear();
 105   NumBytes += CurByte-CurBlock;
 106
 107   DEBUG(std::cerr << "Finished CodeGen of [" << (void*)CurBlock
 108                   << "] Function: " << F.getFunction()->getName()
 109                   << ": " << CurByte-CurBlock << " bytes of text\n");
 110 }
 111
 112 void Emitter::emitConstantPool(MachineConstantPool *MCP) {
 113   const std::vector<Constant*> &Constants = MCP->getConstants();
 114   for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
 115     // For now we just allocate some memory on the heap, this can be
 116     // dramatically improved.
 117     const Type *Ty = ((Value*)Constants[i])->getType();
 118     void *Addr = malloc(TheVM->getTargetData().getTypeSize(Ty));
 119     TheVM->InitializeMemory(Constants[i], Addr);
 120     ConstantPoolAddresses.push_back(Addr);
 121   }
 122 }
 123
 124 void Emitter::startFunctionStub(const Function &F, unsigned StubSize) {
 125   static const long pageSize = sysconf(_SC_PAGESIZE);
 126   SavedCurBlock = CurBlock;  SavedCurByte = CurByte;
 127   // FIXME: this is a huge waste of memory.
 128   CurBlock = (unsigned char *)getMemory((StubSize+pageSize-1)/pageSize);
 129   CurByte = CurBlock;  // Start writing at the beginning of the fn.
 130 }
 131
 132 void *Emitter::finishFunctionStub(const Function &F) {
 133   NumBytes += CurByte-CurBlock;
 134   DEBUG(std::cerr << "Finished CodeGen of [0x" << std::hex
 135                   << (unsigned)(intptr_t)CurBlock
 136                   << std::dec << "] Function stub for: " << F.getName()
 137                   << ": " << CurByte-CurBlock << " bytes of text\n");
 138   std::swap(CurBlock, SavedCurBlock);
 139   CurByte = SavedCurByte;
 140   return SavedCurBlock;
 141 }
 142
 143 void Emitter::emitByte(unsigned char B) {
 144   *CurByte++ = B;   // Write the byte to memory
 145 }
 146
 147 void Emitter::emitWord(unsigned W) {
 148   // FIXME: This won't work if the endianness of the host and target don't
 149   // agree!  (For a JIT this can't happen though.  :)
 150   *(unsigned*)CurByte = W;
 151   CurByte += sizeof(unsigned);
 152 }
 153
 154
 155 uint64_t Emitter::getGlobalValueAddress(GlobalValue *V) {
 156   // Try looking up the function to see if it is already compiled, if not return
 157   // 0.
 158   return (intptr_t)TheVM->getPointerToGlobalIfAvailable(V);
 159 }
 160 uint64_t Emitter::getGlobalValueAddress(const std::string &Name) {
 161   return (intptr_t)TheVM->getPointerToNamedFunction(Name);
 162 }
 163
 164 // getConstantPoolEntryAddress - Return the address of the 'ConstantNum' entry
 165 // in the constant pool that was last emitted with the 'emitConstantPool'
 166 // method.
 167 //
 168 uint64_t Emitter::getConstantPoolEntryAddress(unsigned ConstantNum) {
 169   assert(ConstantNum < ConstantPoolAddresses.size() &&
 170          "Invalid ConstantPoolIndex!");
 171   return (intptr_t)ConstantPoolAddresses[ConstantNum];
 172 }
 173
 174 // getCurrentPCValue - This returns the address that the next emitted byte
 175 // will be output to.
 176 //
 177 uint64_t Emitter::getCurrentPCValue() {
 178   return (intptr_t)CurByte;
 179 }
 180
 181 uint64_t Emitter::forceCompilationOf(Function *F) {
 182   return (intptr_t)TheVM->getPointerToFunction(F);
 183 }
 184
 185 // getPointerToNamedFunction - This function is used as a global wrapper to
 186 // VM::getPointerToNamedFunction for the purpose of resolving symbols when
 187 // bugpoint is debugging the JIT. In that scenario, we are loading an .so and
 188 // need to resolve function(s) that are being mis-codegenerated, so we need to
 189 // resolve their addresses at runtime, and this is the way to do it.
 190 extern "C" {
 191   void *getPointerToNamedFunction(const char *Name) {
 192     Module &M = TheVM->getModule();
 193     if (Function *F = M.getNamedFunction(Name))
 194       return TheVM->getPointerToFunction(F);
 195     return TheVM->getPointerToNamedFunction(Name);
 196   }
 197 }