2002-12-24 00:01:05 +00:00
|
|
|
//===- ExecutionEngine.h - Abstract Execution Engine Interface --*- C++ -*-===//
|
2005-04-21 20:39:54 +00:00
|
|
|
//
|
2003-10-20 20:19:47 +00:00
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
|
|
|
// This file was developed by the LLVM research group and is distributed under
|
|
|
|
// the University of Illinois Open Source License. See LICENSE.TXT for details.
|
2005-04-21 20:39:54 +00:00
|
|
|
//
|
2003-10-20 20:19:47 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
2002-12-24 00:01:05 +00:00
|
|
|
//
|
|
|
|
// This file defines the abstract interface that implements execution support
|
|
|
|
// for LLVM.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#ifndef EXECUTION_ENGINE_H
|
|
|
|
#define EXECUTION_ENGINE_H
|
|
|
|
|
|
|
|
#include <vector>
|
|
|
|
#include <map>
|
2003-07-25 18:06:53 +00:00
|
|
|
#include <cassert>
|
2004-09-03 18:19:51 +00:00
|
|
|
#include <string>
|
2006-05-08 22:00:26 +00:00
|
|
|
#include "llvm/System/Mutex.h"
|
2006-08-16 01:24:12 +00:00
|
|
|
#include "llvm/ADT/SmallVector.h"
|
2003-11-11 22:41:34 +00:00
|
|
|
|
|
|
|
namespace llvm {
|
|
|
|
|
2003-12-20 02:45:16 +00:00
|
|
|
union GenericValue;
|
2002-12-24 00:01:05 +00:00
|
|
|
class Constant;
|
|
|
|
class Function;
|
2003-12-20 02:45:16 +00:00
|
|
|
class GlobalVariable;
|
2003-10-14 21:35:52 +00:00
|
|
|
class GlobalValue;
|
2002-12-24 00:01:05 +00:00
|
|
|
class Module;
|
2003-10-16 21:16:21 +00:00
|
|
|
class ModuleProvider;
|
2002-12-24 00:01:05 +00:00
|
|
|
class TargetData;
|
2003-10-14 21:35:52 +00:00
|
|
|
class Type;
|
2006-05-08 22:00:26 +00:00
|
|
|
class MutexGuard;
|
2002-12-24 00:01:05 +00:00
|
|
|
|
2005-07-12 15:51:55 +00:00
|
|
|
class ExecutionEngineState {
|
|
|
|
private:
|
2003-12-31 20:19:31 +00:00
|
|
|
/// GlobalAddressMap - A mapping between LLVM global values and their
|
|
|
|
/// actualized version...
|
|
|
|
std::map<const GlobalValue*, void *> GlobalAddressMap;
|
|
|
|
|
|
|
|
/// GlobalAddressReverseMap - This is the reverse mapping of GlobalAddressMap,
|
|
|
|
/// used to convert raw addresses into the LLVM global value that is emitted
|
|
|
|
/// at the address. This map is not computed unless getGlobalValueAtAddress
|
|
|
|
/// is called at some point.
|
|
|
|
std::map<void *, const GlobalValue*> GlobalAddressReverseMap;
|
2005-07-12 15:51:55 +00:00
|
|
|
|
|
|
|
public:
|
2006-03-22 06:06:37 +00:00
|
|
|
std::map<const GlobalValue*, void *> &
|
|
|
|
getGlobalAddressMap(const MutexGuard &locked) {
|
2005-07-12 15:51:55 +00:00
|
|
|
return GlobalAddressMap;
|
|
|
|
}
|
|
|
|
|
2006-03-22 06:06:37 +00:00
|
|
|
std::map<void*, const GlobalValue*> &
|
|
|
|
getGlobalAddressReverseMap(const MutexGuard& locked) {
|
2005-07-12 15:51:55 +00:00
|
|
|
return GlobalAddressReverseMap;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
class ExecutionEngine {
|
|
|
|
const TargetData *TD;
|
|
|
|
ExecutionEngineState state;
|
2003-12-20 03:35:50 +00:00
|
|
|
protected:
|
2006-08-16 01:24:12 +00:00
|
|
|
/// Modules - This is a list of ModuleProvider's that we are JIT'ing from. We
|
|
|
|
/// use a smallvector to optimize for the case where there is only one module.
|
|
|
|
SmallVector<ModuleProvider*, 1> Modules;
|
|
|
|
|
2006-05-03 01:29:57 +00:00
|
|
|
void setTargetData(const TargetData *td) {
|
|
|
|
TD = td;
|
2002-12-24 00:01:05 +00:00
|
|
|
}
|
2003-10-14 21:35:52 +00:00
|
|
|
|
2006-03-22 06:06:37 +00:00
|
|
|
// To avoid having libexecutionengine depend on the JIT and interpreter
|
|
|
|
// libraries, the JIT and Interpreter set these functions to ctor pointers
|
|
|
|
// at startup time if they are linked in.
|
2006-03-23 05:22:51 +00:00
|
|
|
typedef ExecutionEngine *(*EECtorFn)(ModuleProvider*);
|
2006-03-22 06:06:37 +00:00
|
|
|
static EECtorFn JITCtor, InterpCtor;
|
|
|
|
|
2002-12-24 00:01:05 +00:00
|
|
|
public:
|
2006-03-22 06:06:37 +00:00
|
|
|
/// lock - This lock is protects the ExecutionEngine, JIT, JITResolver and
|
|
|
|
/// JITEmitter classes. It must be held while changing the internal state of
|
|
|
|
/// any of those classes.
|
2005-07-12 15:51:55 +00:00
|
|
|
sys::Mutex lock; // Used to make this class and subclasses thread-safe
|
|
|
|
|
2003-10-16 21:16:21 +00:00
|
|
|
ExecutionEngine(ModuleProvider *P);
|
|
|
|
ExecutionEngine(Module *M);
|
2002-12-24 00:01:05 +00:00
|
|
|
virtual ~ExecutionEngine();
|
2005-04-21 20:39:54 +00:00
|
|
|
|
2006-05-03 01:29:57 +00:00
|
|
|
const TargetData *getTargetData() const { return TD; }
|
2002-12-24 00:01:05 +00:00
|
|
|
|
2006-08-16 02:53:27 +00:00
|
|
|
/// addModuleProvider - Add a ModuleProvider to the list of modules that we
|
|
|
|
/// can JIT from. Note that this takes ownership of the ModuleProvider: when
|
|
|
|
/// the ExecutionEngine is destroyed, it destroys the MP as well.
|
|
|
|
void addModuleProvider(ModuleProvider *P) {
|
|
|
|
Modules.push_back(P);
|
|
|
|
}
|
|
|
|
|
2006-08-16 01:24:12 +00:00
|
|
|
/// FindFunctionNamed - Search all of the active modules to find the one that
|
|
|
|
/// defines FnName. This is very slow operation and shouldn't be used for
|
|
|
|
/// general code.
|
|
|
|
Function *FindFunctionNamed(const char *FnName);
|
|
|
|
|
2003-12-26 06:12:25 +00:00
|
|
|
/// create - This is the factory method for creating an execution engine which
|
2006-03-23 05:22:51 +00:00
|
|
|
/// is appropriate for the current machine.
|
|
|
|
static ExecutionEngine *create(ModuleProvider *MP,
|
|
|
|
bool ForceInterpreter = false);
|
2003-09-03 20:34:19 +00:00
|
|
|
|
2003-12-26 06:12:25 +00:00
|
|
|
/// runFunction - Execute the specified function with the specified arguments,
|
|
|
|
/// and return the result.
|
|
|
|
///
|
|
|
|
virtual GenericValue runFunction(Function *F,
|
|
|
|
const std::vector<GenericValue> &ArgValues) = 0;
|
|
|
|
|
2006-03-08 18:42:46 +00:00
|
|
|
/// runStaticConstructorsDestructors - This method is used to execute all of
|
|
|
|
/// the static constructors or destructors for a module, depending on the
|
|
|
|
/// value of isDtors.
|
|
|
|
void runStaticConstructorsDestructors(bool isDtors);
|
|
|
|
|
|
|
|
|
2003-12-26 06:50:15 +00:00
|
|
|
/// runFunctionAsMain - This is a helper function which wraps runFunction to
|
|
|
|
/// handle the common task of starting up main with the specified argc, argv,
|
|
|
|
/// and envp parameters.
|
|
|
|
int runFunctionAsMain(Function *Fn, const std::vector<std::string> &argv,
|
|
|
|
const char * const * envp);
|
|
|
|
|
|
|
|
|
2006-05-08 22:00:26 +00:00
|
|
|
/// addGlobalMapping - Tell the execution engine that the specified global is
|
|
|
|
/// at the specified location. This is used internally as functions are JIT'd
|
|
|
|
/// and as global variables are laid out in memory. It can and should also be
|
|
|
|
/// used by clients of the EE that want to have an LLVM global overlay
|
|
|
|
/// existing data in memory.
|
|
|
|
void addGlobalMapping(const GlobalValue *GV, void *Addr);
|
|
|
|
|
2004-12-13 16:22:32 +00:00
|
|
|
/// clearAllGlobalMappings - Clear all global mappings and start over again
|
|
|
|
/// use in dynamic compilation scenarios when you want to move globals
|
2006-05-08 22:00:26 +00:00
|
|
|
void clearAllGlobalMappings();
|
|
|
|
|
2004-11-22 16:54:54 +00:00
|
|
|
/// updateGlobalMapping - Replace an existing mapping for GV with a new
|
2006-05-08 22:00:26 +00:00
|
|
|
/// address. This updates both maps as required. If "Addr" is null, the
|
|
|
|
/// entry for the global is removed from the mappings.
|
|
|
|
void updateGlobalMapping(const GlobalValue *GV, void *Addr);
|
|
|
|
|
2003-12-12 06:31:42 +00:00
|
|
|
/// getPointerToGlobalIfAvailable - This returns the address of the specified
|
2006-05-08 22:00:26 +00:00
|
|
|
/// global value if it is has already been codegen'd, otherwise it returns
|
|
|
|
/// null.
|
2003-12-12 06:31:42 +00:00
|
|
|
///
|
2006-05-08 22:00:26 +00:00
|
|
|
void *getPointerToGlobalIfAvailable(const GlobalValue *GV);
|
2003-05-09 03:29:03 +00:00
|
|
|
|
2003-12-12 06:31:42 +00:00
|
|
|
/// getPointerToGlobal - This returns the address of the specified global
|
|
|
|
/// value. This may involve code generation if it's a function.
|
|
|
|
///
|
2002-12-24 00:01:05 +00:00
|
|
|
void *getPointerToGlobal(const GlobalValue *GV);
|
|
|
|
|
2003-12-12 06:31:42 +00:00
|
|
|
/// getPointerToFunction - The different EE's represent function bodies in
|
|
|
|
/// different ways. They should each implement this to say what a function
|
|
|
|
/// pointer should look like.
|
|
|
|
///
|
2003-08-13 18:17:54 +00:00
|
|
|
virtual void *getPointerToFunction(Function *F) = 0;
|
2002-12-24 00:01:05 +00:00
|
|
|
|
2003-12-12 06:31:42 +00:00
|
|
|
/// getPointerToFunctionOrStub - If the specified function has been
|
|
|
|
/// code-gen'd, return a pointer to the function. If not, compile it, or use
|
|
|
|
/// a stub to implement lazy compilation if available.
|
|
|
|
///
|
2003-12-08 08:22:01 +00:00
|
|
|
virtual void *getPointerToFunctionOrStub(Function *F) {
|
|
|
|
// Default implementation, just codegen the function.
|
|
|
|
return getPointerToFunction(F);
|
|
|
|
}
|
|
|
|
|
2003-12-31 20:19:31 +00:00
|
|
|
/// getGlobalValueAtAddress - Return the LLVM global value object that starts
|
|
|
|
/// at the specified address.
|
|
|
|
///
|
|
|
|
const GlobalValue *getGlobalValueAtAddress(void *Addr);
|
|
|
|
|
|
|
|
|
2003-09-05 18:55:03 +00:00
|
|
|
void StoreValueToMemory(GenericValue Val, GenericValue *Ptr, const Type *Ty);
|
|
|
|
void InitializeMemory(const Constant *Init, void *Addr);
|
|
|
|
|
2003-12-08 08:22:01 +00:00
|
|
|
/// recompileAndRelinkFunction - This method is used to force a function
|
2003-12-12 06:31:42 +00:00
|
|
|
/// which has already been compiled to be compiled again, possibly
|
2003-12-08 08:22:01 +00:00
|
|
|
/// after it has been modified. Then the entry to the old copy is overwritten
|
|
|
|
/// with a branch to the new copy. If there was no old copy, this acts
|
|
|
|
/// just like VM::getPointerToFunction().
|
|
|
|
///
|
|
|
|
virtual void *recompileAndRelinkFunction(Function *F) = 0;
|
|
|
|
|
2004-11-07 23:58:02 +00:00
|
|
|
/// freeMachineCodeForFunction - Release memory in the ExecutionEngine
|
|
|
|
/// corresponding to the machine code emitted to execute this function, useful
|
|
|
|
/// for garbage-collecting generated code.
|
|
|
|
///
|
|
|
|
virtual void freeMachineCodeForFunction(Function *F) = 0;
|
|
|
|
|
2003-12-20 03:35:50 +00:00
|
|
|
/// getOrEmitGlobalVariable - Return the address of the specified global
|
|
|
|
/// variable, possibly emitting it to memory if needed. This is used by the
|
|
|
|
/// Emitter.
|
|
|
|
virtual void *getOrEmitGlobalVariable(const GlobalVariable *GV) {
|
|
|
|
return getPointerToGlobal((GlobalValue*)GV);
|
|
|
|
}
|
|
|
|
|
2003-05-12 02:14:34 +00:00
|
|
|
protected:
|
2002-12-24 00:01:05 +00:00
|
|
|
void emitGlobals();
|
2003-12-20 02:45:16 +00:00
|
|
|
|
|
|
|
// EmitGlobalVariable - This method emits the specified global variable to the
|
|
|
|
// address specified in GlobalAddresses, or allocates new memory if it's not
|
|
|
|
// already in the map.
|
2003-12-20 03:35:50 +00:00
|
|
|
void EmitGlobalVariable(const GlobalVariable *GV);
|
2003-12-20 02:45:16 +00:00
|
|
|
|
2002-12-24 00:01:05 +00:00
|
|
|
GenericValue getConstantValue(const Constant *C);
|
2003-05-08 16:52:16 +00:00
|
|
|
GenericValue LoadValueFromMemory(GenericValue *Ptr, const Type *Ty);
|
2002-12-24 00:01:05 +00:00
|
|
|
};
|
|
|
|
|
2003-11-11 22:41:34 +00:00
|
|
|
} // End llvm namespace
|
|
|
|
|
2002-12-24 00:01:05 +00:00
|
|
|
#endif
|