mirror of
https://github.com/c64scene-ar/llvm-6502.git
synced 2025-09-06 19:28:57 +00:00
6eb43d2956
It's useful for the memory managers that are allocating a section to know what the name of the section is. At a minimum, this is useful for low-level debugging - it's customary for JITs to be able to tell you what memory they allocated, and as part of any such dump, they should be able to tell you some meta-data about what each allocation is for. This allows clients that supply their own memory managers to do this. Additionally, we also envision the SectionName being useful for passing meta-data from within LLVM to an LLVM client. This changes both the C and C++ APIs, and all of the clients of those APIs within LLVM. I'm assuming that it's safe to change the C++ API because that API is allowed to change. I'm assuming that it's safe to change the C API because we haven't shipped the API in a release yet (LLVM 3.3 doesn't include the MCJIT memory management C API). git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@191804 91177308-0d34-0410-b5e6-96231b3b80d8
90 lines
3.9 KiB
C++
90 lines
3.9 KiB
C++
//===-- RTDyldMemoryManager.cpp - Memory manager for MC-JIT -----*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// Interface of the runtime dynamic memory manager base class.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_EXECUTIONENGINE_RT_DYLD_MEMORY_MANAGER_H
|
|
#define LLVM_EXECUTIONENGINE_RT_DYLD_MEMORY_MANAGER_H
|
|
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/Support/CBindingWrapping.h"
|
|
#include "llvm/Support/Memory.h"
|
|
#include "llvm-c/ExecutionEngine.h"
|
|
|
|
namespace llvm {
|
|
|
|
// RuntimeDyld clients often want to handle the memory management of
|
|
// what gets placed where. For JIT clients, this is the subset of
|
|
// JITMemoryManager required for dynamic loading of binaries.
|
|
//
|
|
// FIXME: As the RuntimeDyld fills out, additional routines will be needed
|
|
// for the varying types of objects to be allocated.
|
|
class RTDyldMemoryManager {
|
|
RTDyldMemoryManager(const RTDyldMemoryManager&) LLVM_DELETED_FUNCTION;
|
|
void operator=(const RTDyldMemoryManager&) LLVM_DELETED_FUNCTION;
|
|
public:
|
|
RTDyldMemoryManager() {}
|
|
virtual ~RTDyldMemoryManager();
|
|
|
|
/// Allocate a memory block of (at least) the given size suitable for
|
|
/// executable code. The SectionID is a unique identifier assigned by the JIT
|
|
/// engine, and optionally recorded by the memory manager to access a loaded
|
|
/// section.
|
|
virtual uint8_t *allocateCodeSection(
|
|
uintptr_t Size, unsigned Alignment, unsigned SectionID,
|
|
StringRef SectionName) = 0;
|
|
|
|
/// Allocate a memory block of (at least) the given size suitable for data.
|
|
/// The SectionID is a unique identifier assigned by the JIT engine, and
|
|
/// optionally recorded by the memory manager to access a loaded section.
|
|
virtual uint8_t *allocateDataSection(
|
|
uintptr_t Size, unsigned Alignment, unsigned SectionID,
|
|
StringRef SectionName, bool IsReadOnly) = 0;
|
|
|
|
/// Register the EH frames with the runtime so that c++ exceptions work.
|
|
virtual void registerEHFrames(StringRef SectionData);
|
|
|
|
/// This method returns the address of the specified function or variable.
|
|
/// It is used to resolve symbols during module linking.
|
|
virtual uint64_t getSymbolAddress(const std::string &Name);
|
|
|
|
/// This method returns the address of the specified function. As such it is
|
|
/// only useful for resolving library symbols, not code generated symbols.
|
|
///
|
|
/// If \p AbortOnFailure is false and no function with the given name is
|
|
/// found, this function returns a null pointer. Otherwise, it prints a
|
|
/// message to stderr and aborts.
|
|
///
|
|
/// This function is deprecated for memory managers used to be used with
|
|
/// MCJIT or RuntimeDyld. Use getSymbolAddress instead.
|
|
virtual void *getPointerToNamedFunction(const std::string &Name,
|
|
bool AbortOnFailure = true);
|
|
|
|
/// This method is called when object loading is complete and section page
|
|
/// permissions can be applied. It is up to the memory manager implementation
|
|
/// to decide whether or not to act on this method. The memory manager will
|
|
/// typically allocate all sections as read-write and then apply specific
|
|
/// permissions when this method is called. Code sections cannot be executed
|
|
/// until this function has been called. In addition, any cache coherency
|
|
/// operations needed to reliably use the memory are also performed.
|
|
///
|
|
/// Returns true if an error occurred, false otherwise.
|
|
virtual bool finalizeMemory(std::string *ErrMsg = 0) = 0;
|
|
};
|
|
|
|
// Create wrappers for C Binding types (see CBindingWrapping.h).
|
|
DEFINE_SIMPLE_CONVERSION_FUNCTIONS(
|
|
RTDyldMemoryManager, LLVMMCJITMemoryManagerRef)
|
|
|
|
} // namespace llvm
|
|
|
|
#endif // LLVM_EXECUTIONENGINE_RT_DYLD_MEMORY_MANAGER_H
|