aboutsummaryrefslogtreecommitdiff
path: root/include/lldb/Expression/IRMemoryMap.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/lldb/Expression/IRMemoryMap.h')
-rw-r--r--include/lldb/Expression/IRMemoryMap.h126
1 files changed, 126 insertions, 0 deletions
diff --git a/include/lldb/Expression/IRMemoryMap.h b/include/lldb/Expression/IRMemoryMap.h
new file mode 100644
index 000000000000..affe19350e3f
--- /dev/null
+++ b/include/lldb/Expression/IRMemoryMap.h
@@ -0,0 +1,126 @@
+//===-- IRExecutionUnit.h ---------------------------------------*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef lldb_IRMemoryMap_h_
+#define lldb_IRMemoryMap_h_
+
+#include "lldb/lldb-public.h"
+#include "lldb/Core/DataBufferHeap.h"
+#include "lldb/Core/UserID.h"
+
+#include <map>
+
+namespace lldb_private
+{
+
+//----------------------------------------------------------------------
+/// @class IRMemoryMap IRMemoryMap.h "lldb/Expression/IRMemoryMap.h"
+/// @brief Encapsulates memory that may exist in the process but must
+/// also be available in the host process.
+///
+/// This class encapsulates a group of memory objects that must be readable
+/// or writable from the host process regardless of whether the process
+/// exists. This allows the IR interpreter as well as JITted code to access
+/// the same memory.
+///
+/// Point queries against this group of memory objects can be made by the
+/// address in the tar at which they reside. If the inferior does not
+/// exist, allocations still get made-up addresses. If an inferior appears
+/// at some point, then those addresses need to be re-mapped.
+//----------------------------------------------------------------------
+class IRMemoryMap
+{
+public:
+ IRMemoryMap (lldb::TargetSP target_sp);
+ ~IRMemoryMap ();
+
+ enum AllocationPolicy {
+ eAllocationPolicyInvalid = 0, ///< It is an error for an allocation to have this policy.
+ eAllocationPolicyHostOnly, ///< This allocation was created in the host and will never make it into the process.
+ ///< It is an error to create other types of allocations while such allocations exist.
+ eAllocationPolicyMirror, ///< The intent is that this allocation exist both in the host and the process and have
+ ///< the same content in both.
+ eAllocationPolicyProcessOnly ///< The intent is that this allocation exist only in the process.
+ };
+
+ lldb::addr_t Malloc (size_t size, uint8_t alignment, uint32_t permissions, AllocationPolicy policy, Error &error);
+ void Leak (lldb::addr_t process_address, Error &error);
+ void Free (lldb::addr_t process_address, Error &error);
+
+ void WriteMemory (lldb::addr_t process_address, const uint8_t *bytes, size_t size, Error &error);
+ void WriteScalarToMemory (lldb::addr_t process_address, Scalar &scalar, size_t size, Error &error);
+ void WritePointerToMemory (lldb::addr_t process_address, lldb::addr_t address, Error &error);
+ void ReadMemory (uint8_t *bytes, lldb::addr_t process_address, size_t size, Error &error);
+ void ReadScalarFromMemory (Scalar &scalar, lldb::addr_t process_address, size_t size, Error &error);
+ void ReadPointerFromMemory (lldb::addr_t *address, lldb::addr_t process_address, Error &error);
+
+ void GetMemoryData (DataExtractor &extractor, lldb::addr_t process_address, size_t size, Error &error);
+
+ lldb::ByteOrder GetByteOrder();
+ uint32_t GetAddressByteSize();
+
+ // This function can return NULL.
+ ExecutionContextScope *GetBestExecutionContextScope();
+
+protected:
+ // This function should only be used if you know you are using the JIT.
+ // Any other cases should use GetBestExecutionContextScope().
+ lldb::ProcessWP GetProcessWP ()
+ {
+ return m_process_wp;
+ }
+
+private:
+ struct Allocation
+ {
+ lldb::addr_t m_process_alloc; ///< The (unaligned) base for the remote allocation
+ lldb::addr_t m_process_start; ///< The base address of the allocation in the process
+ size_t m_size; ///< The size of the requested allocation
+ uint32_t m_permissions; ///< The access permissions on the memory in the process. In the host, the memory is always read/write.
+ uint8_t m_alignment; ///< The alignment of the requested allocation
+ DataBufferHeap m_data;
+
+ ///< Flags
+ AllocationPolicy m_policy;
+ bool m_leak;
+ public:
+ Allocation (lldb::addr_t process_alloc,
+ lldb::addr_t process_start,
+ size_t size,
+ uint32_t permissions,
+ uint8_t alignment,
+ AllocationPolicy m_policy);
+
+ Allocation () :
+ m_process_alloc (LLDB_INVALID_ADDRESS),
+ m_process_start (LLDB_INVALID_ADDRESS),
+ m_size (0),
+ m_permissions (0),
+ m_alignment (0),
+ m_data (),
+ m_policy (eAllocationPolicyInvalid),
+ m_leak (false)
+ {
+ }
+ };
+
+ lldb::ProcessWP m_process_wp;
+ lldb::TargetWP m_target_wp;
+ typedef std::map<lldb::addr_t, Allocation> AllocationMap;
+ AllocationMap m_allocations;
+
+ lldb::addr_t FindSpace (size_t size);
+ bool ContainsHostOnlyAllocations ();
+ AllocationMap::iterator FindAllocation (lldb::addr_t addr, size_t size);
+ bool IntersectsAllocation (lldb::addr_t addr, size_t size);
+};
+
+}
+
+#endif