Convert assert(0) to llvm_unreachable
[oota-llvm.git] / lib / ExecutionEngine / MCJIT / MCJIT.h
1 //===-- MCJIT.h - Class definition for the MCJIT ----------------*- C++ -*-===//
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 #ifndef LLVM_LIB_EXECUTIONENGINE_MCJIT_H
11 #define LLVM_LIB_EXECUTIONENGINE_MCJIT_H
12
13 #include "llvm/PassManager.h"
14 #include "llvm/ExecutionEngine/ExecutionEngine.h"
15 #include "llvm/ExecutionEngine/RuntimeDyld.h"
16 #include "llvm/ADT/SmallVector.h"
17 #include "llvm/Support/raw_ostream.h"
18
19 namespace llvm {
20
21 // FIXME: This makes all kinds of horrible assumptions for the time being,
22 // like only having one module, not needing to worry about multi-threading,
23 // blah blah. Purely in get-it-up-and-limping mode for now.
24
25 class MCJIT : public ExecutionEngine {
26   MCJIT(Module *M, TargetMachine *tm, TargetJITInfo &tji,
27         RTDyldMemoryManager *MemMgr, bool AllocateGVsWithCode);
28
29   TargetMachine *TM;
30   MCContext *Ctx;
31   RTDyldMemoryManager *MemMgr;
32
33   // FIXME: These may need moved to a separate 'jitstate' member like the
34   // non-MC JIT does for multithreading and such. Just keep them here for now.
35   PassManager PM;
36   Module *M;
37   // FIXME: This really doesn't belong here.
38   SmallVector<char, 4096> Buffer; // Working buffer into which we JIT.
39   raw_svector_ostream OS;
40
41   RuntimeDyld Dyld;
42
43 public:
44   ~MCJIT();
45
46   /// @name ExecutionEngine interface implementation
47   /// @{
48
49   virtual void *getPointerToBasicBlock(BasicBlock *BB);
50
51   virtual void *getPointerToFunction(Function *F);
52
53   virtual void *recompileAndRelinkFunction(Function *F);
54
55   virtual void freeMachineCodeForFunction(Function *F);
56
57   virtual GenericValue runFunction(Function *F,
58                                    const std::vector<GenericValue> &ArgValues);
59
60   /// getPointerToNamedFunction - This method returns the address of the
61   /// specified function by using the dlsym function call.  As such it is only
62   /// useful for resolving library symbols, not code generated symbols.
63   ///
64   /// If AbortOnFailure is false and no function with the given name is
65   /// found, this function silently returns a null pointer. Otherwise,
66   /// it prints a message to stderr and aborts.
67   ///
68   virtual void *getPointerToNamedFunction(const std::string &Name,
69                                           bool AbortOnFailure = true);
70   /// mapSectionAddress - map a section to its target address space value.
71   /// Map the address of a JIT section as returned from the memory manager
72   /// to the address in the target process as the running code will see it.
73   /// This is the address which will be used for relocation resolution.
74   virtual void mapSectionAddress(void *LocalAddress, uint64_t TargetAddress) {
75     Dyld.mapSectionAddress(LocalAddress, TargetAddress);
76   }
77
78   /// @}
79   /// @name (Private) Registration Interfaces
80   /// @{
81
82   static void Register() {
83     MCJITCtor = createJIT;
84   }
85
86   static ExecutionEngine *createJIT(Module *M,
87                                     std::string *ErrorStr,
88                                     JITMemoryManager *JMM,
89                                     bool GVsWithCode,
90                                     TargetMachine *TM);
91
92   // @}
93 };
94
95 } // End llvm namespace
96
97 #endif