1 //===- RemoteMemoryManager.h - LLI MCJIT recording memory manager ------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This memory manager allocates local storage and keeps a record of each
11 // allocation. Iterators are provided for all data and code allocations.
13 //===----------------------------------------------------------------------===//
15 #ifndef REMOTEMEMORYMANAGER_H
16 #define REMOTEMEMORYMANAGER_H
18 #include "RemoteTarget.h"
19 #include "llvm/ADT/DenseMap.h"
20 #include "llvm/ADT/SmallVector.h"
21 #include "llvm/ExecutionEngine/JITMemoryManager.h"
22 #include "llvm/Support/ErrorHandling.h"
23 #include "llvm/Support/Memory.h"
28 class RemoteMemoryManager : public JITMemoryManager {
30 // Notice that this structure takes ownership of the memory allocated.
33 Allocation(sys::MemoryBlock mb, unsigned a, bool code)
34 : MB(mb), Alignment(a), IsCode(code) {}
42 // This vector contains Allocation objects for all sections which we have
43 // allocated. This vector effectively owns the memory associated with the
45 SmallVector<Allocation, 2> AllocatedSections;
47 // This vector contains pointers to Allocation objects for any sections we
48 // have allocated locally but have not yet remapped for the remote target.
49 // When we receive notification of a completed module load, we will map
50 // these sections into the remote target.
51 SmallVector<Allocation, 2> UnmappedSections;
53 // This map tracks the sections we have remapped for the remote target
54 // but have not yet copied to the target.
55 DenseMap<uint64_t, Allocation> MappedSections;
57 // FIXME: This is part of a work around to keep sections near one another
58 // when MCJIT performs relocations after code emission but before
59 // the generated code is moved to the remote target.
60 sys::MemoryBlock Near;
61 sys::MemoryBlock allocateSection(uintptr_t Size);
66 RemoteMemoryManager() : Target(NULL) {}
67 virtual ~RemoteMemoryManager();
69 uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
70 unsigned SectionID, StringRef SectionName);
72 uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
73 unsigned SectionID, StringRef SectionName,
76 // For now, remote symbol resolution is not support in lli. The MCJIT
77 // interface does support this, but clients must provide their own
78 // mechanism for finding remote symbol addresses. MCJIT will resolve
79 // symbols from Modules it contains.
80 uint64_t getSymbolAddress(const std::string &Name) { return 0; }
82 void notifyObjectLoaded(ExecutionEngine *EE, const ObjectImage *Obj);
84 bool finalizeMemory(std::string *ErrMsg);
86 // For now, remote EH frame registration isn't supported. Remote symbol
87 // resolution is a prerequisite to supporting remote EH frame registration.
88 void registerEHFrames(uint8_t *Addr, uint64_t LoadAddr, size_t Size) {}
89 void deregisterEHFrames(uint8_t *Addr, uint64_t LoadAddr, size_t Size) {}
91 // This is a non-interface function used by lli
92 void setRemoteTarget(RemoteTarget *T) { Target = T; }
94 // The following obsolete JITMemoryManager calls are stubbed out for
96 void setMemoryWritable();
97 void setMemoryExecutable();
98 void setPoisonMemory(bool poison);
100 uint8_t *getGOTBase() const;
101 uint8_t *startFunctionBody(const Function *F, uintptr_t &ActualSize);
102 uint8_t *allocateStub(const GlobalValue* F, unsigned StubSize,
104 void endFunctionBody(const Function *F, uint8_t *FunctionStart,
105 uint8_t *FunctionEnd);
106 uint8_t *allocateSpace(intptr_t Size, unsigned Alignment);
107 uint8_t *allocateGlobal(uintptr_t Size, unsigned Alignment);
108 void deallocateFunctionBody(void *Body);
111 } // end namespace llvm