2004-09-11 04:20:58 +00:00
|
|
|
//===- llvm/System/Memory.h - Memory Support --------------------*- C++ -*-===//
|
2005-04-21 20:48:15 +00:00
|
|
|
//
|
2004-09-11 04:20:58 +00:00
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
2007-12-29 19:59:42 +00:00
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
2005-04-21 20:48:15 +00:00
|
|
|
//
|
2004-09-11 04:20:58 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// This file declares the llvm::sys::Memory class.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2004-09-13 22:38:11 +00:00
|
|
|
#ifndef LLVM_SYSTEM_MEMORY_H
|
|
|
|
#define LLVM_SYSTEM_MEMORY_H
|
2004-09-11 04:20:58 +00:00
|
|
|
|
2009-07-23 21:46:56 +00:00
|
|
|
#include "llvm/Support/DataTypes.h"
|
2006-07-07 17:32:37 +00:00
|
|
|
#include <string>
|
|
|
|
|
2004-09-11 04:20:58 +00:00
|
|
|
namespace llvm {
|
|
|
|
namespace sys {
|
|
|
|
|
2004-09-13 22:38:11 +00:00
|
|
|
/// This class encapsulates the notion of a memory block which has an address
|
|
|
|
/// and a size. It is used by the Memory class (a friend) as the result of
|
|
|
|
/// various memory allocation operations.
|
|
|
|
/// @see Memory
|
|
|
|
/// @brief Memory block abstraction.
|
|
|
|
class MemoryBlock {
|
|
|
|
public:
|
2009-07-23 21:46:56 +00:00
|
|
|
MemoryBlock() { }
|
|
|
|
MemoryBlock(void *addr, size_t size) : Address(addr), Size(size) { }
|
2006-07-07 17:32:37 +00:00
|
|
|
void *base() const { return Address; }
|
2009-07-23 21:46:56 +00:00
|
|
|
size_t size() const { return Size; }
|
2004-09-13 22:38:11 +00:00
|
|
|
private:
|
2006-07-07 17:32:37 +00:00
|
|
|
void *Address; ///< Address of first byte of memory area
|
2009-07-23 21:46:56 +00:00
|
|
|
size_t Size; ///< Size, in bytes of the memory area
|
2004-09-13 22:38:11 +00:00
|
|
|
friend class Memory;
|
|
|
|
};
|
|
|
|
|
|
|
|
/// This class provides various memory handling functions that manipulate
|
|
|
|
/// MemoryBlock instances.
|
2004-09-11 04:20:58 +00:00
|
|
|
/// @since 1.4
|
2004-09-13 22:38:11 +00:00
|
|
|
/// @brief An abstraction for memory operations.
|
2004-09-11 04:20:58 +00:00
|
|
|
class Memory {
|
2008-06-25 17:14:10 +00:00
|
|
|
public:
|
|
|
|
/// This method allocates a block of Read/Write/Execute memory that is
|
|
|
|
/// suitable for executing dynamically generated code (e.g. JIT). An
|
|
|
|
/// attempt to allocate \p NumBytes bytes of virtual memory is made.
|
|
|
|
/// \p NearBlock may point to an existing allocation in which case
|
|
|
|
/// an attempt is made to allocate more memory near the existing block.
|
|
|
|
///
|
|
|
|
/// On success, this returns a non-null memory block, otherwise it returns
|
|
|
|
/// a null memory block and fills in *ErrMsg.
|
|
|
|
///
|
|
|
|
/// @brief Allocate Read/Write/Execute memory.
|
2009-07-23 21:46:56 +00:00
|
|
|
static MemoryBlock AllocateRWX(size_t NumBytes,
|
2008-06-25 17:14:10 +00:00
|
|
|
const MemoryBlock *NearBlock,
|
|
|
|
std::string *ErrMsg = 0);
|
2004-09-13 22:38:11 +00:00
|
|
|
|
2008-06-25 17:14:10 +00:00
|
|
|
/// This method releases a block of Read/Write/Execute memory that was
|
|
|
|
/// allocated with the AllocateRWX method. It should not be used to
|
|
|
|
/// release any memory block allocated any other way.
|
|
|
|
///
|
|
|
|
/// On success, this returns false, otherwise it returns true and fills
|
|
|
|
/// in *ErrMsg.
|
|
|
|
/// @throws std::string if an error occurred.
|
|
|
|
/// @brief Release Read/Write/Execute memory.
|
|
|
|
static bool ReleaseRWX(MemoryBlock &block, std::string *ErrMsg = 0);
|
|
|
|
|
|
|
|
|
|
|
|
/// InvalidateInstructionCache - Before the JIT can run a block of code
|
|
|
|
/// that has been emitted it must invalidate the instruction cache on some
|
|
|
|
/// platforms.
|
|
|
|
static void InvalidateInstructionCache(const void *Addr, size_t Len);
|
2008-09-18 07:54:21 +00:00
|
|
|
|
2008-10-03 16:17:20 +00:00
|
|
|
/// setExecutable - Before the JIT can run a block of code, it has to be
|
2008-09-18 07:54:21 +00:00
|
|
|
/// given read and executable privilege. Return true if it is already r-x
|
|
|
|
/// or the system is able to change its previlege.
|
2008-10-03 16:17:20 +00:00
|
|
|
static bool setExecutable (MemoryBlock &M, std::string *ErrMsg = 0);
|
|
|
|
|
|
|
|
/// setWritable - When adding to a block of code, the JIT may need
|
|
|
|
/// to mark a block of code as RW since the protections are on page
|
|
|
|
/// boundaries, and the JIT internal allocations are not page aligned.
|
|
|
|
static bool setWritable (MemoryBlock &M, std::string *ErrMsg = 0);
|
2008-10-20 21:39:23 +00:00
|
|
|
|
|
|
|
/// setRangeExecutable - Mark the page containing a range of addresses
|
|
|
|
/// as executable.
|
|
|
|
static bool setRangeExecutable(const void *Addr, size_t Size);
|
|
|
|
|
|
|
|
/// setRangeWritable - Mark the page containing a range of addresses
|
|
|
|
/// as writable.
|
|
|
|
static bool setRangeWritable(const void *Addr, size_t Size);
|
2004-09-11 04:20:58 +00:00
|
|
|
};
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#endif
|