Add MemoryRegionInfo to SB API

Summary:
This adds new SB API calls and classes to allow a user of the SB API to obtain a full list of memory regions accessible within the process. Adding this to the API makes it possible use the API for tasks like scanning memory for blocks allocated with a header and footer to track down memory leaks, otherwise just inspecting every address is impractical especially for 64 bit processes.

These changes only add the API itself and a base implementation of GetMemoryRegions() to lldb_private::Process::GetMemoryRegions.
I will submit separate patches to fill in lldb_private::Process::GetMemoryRegionInfoList and GetMemoryRegionInfo for individual platforms.

The original discussion about this is here:
http://lists.llvm.org/pipermail/lldb-dev/2016-May/010203.html

Reviewers: clayborg

Subscribers: lldb-commits

Differential Revision: http://reviews.llvm.org/D20565

llvm-svn: 273547

6 files changed, 203 insertions, 0 deletions

diff --git a/lldb/include/lldb/API/LLDB.h b/lldb/include/lldb/API/LLDB.h
index eed10d08c6c..b6278160dbc 100644
--- a/lldb/include/lldb/API/LLDB.h
+++ b/lldb/include/lldb/API/LLDB.h
@@ -43,6 +43,8 @@
 #include "lldb/API/SBLaunchInfo.h"
 #include "lldb/API/SBLineEntry.h"
 #include "lldb/API/SBListener.h"
+#include "lldb/API/SBMemoryRegionInfo.h"
+#include "lldb/API/SBMemoryRegionInfoList.h"
 #include "lldb/API/SBModule.h"
 #include "lldb/API/SBModuleSpec.h"
 #include "lldb/API/SBPlatform.h"
diff --git a/lldb/include/lldb/API/SBDefines.h b/lldb/include/lldb/API/SBDefines.h
index d81bba5a2e2..4a95903ec92 100644
--- a/lldb/include/lldb/API/SBDefines.h
+++ b/lldb/include/lldb/API/SBDefines.h
@@ -59,6 +59,8 @@ class LLDB_API SBLanguageRuntime;
 class LLDB_API SBLaunchInfo;
 class LLDB_API SBLineEntry;
 class LLDB_API SBListener;
+class LLDB_API SBMemoryRegionInfo;
+class LLDB_API SBMemoryRegionInfoList;
 class LLDB_API SBModule;
 class LLDB_API SBModuleSpec;
 class LLDB_API SBModuleSpecList;
diff --git a/lldb/include/lldb/API/SBMemoryRegionInfo.h b/lldb/include/lldb/API/SBMemoryRegionInfo.h
new file mode 100644
index 00000000000..febb1828da4
--- /dev/null
+++ b/lldb/include/lldb/API/SBMemoryRegionInfo.h
@@ -0,0 +1,107 @@
+//===-- SBMemoryRegionInfo.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_SBMemoryRegionInfo_h_
+#define LLDB_SBMemoryRegionInfo_h_
+
+#include "lldb/API/SBDefines.h"
+#include "lldb/API/SBData.h"
+
+namespace lldb {
+
+class LLDB_API SBMemoryRegionInfo
+{
+public:
+
+    SBMemoryRegionInfo ();
+
+    SBMemoryRegionInfo (const lldb::SBMemoryRegionInfo &rhs);
+
+    ~SBMemoryRegionInfo ();
+
+    const lldb::SBMemoryRegionInfo &
+    operator = (const lldb::SBMemoryRegionInfo &rhs);
+
+    void
+    Clear();
+
+    //------------------------------------------------------------------
+    /// Get the base address of this memory range.
+    ///
+    /// @return
+    ///     The base address of this memory range.
+    //------------------------------------------------------------------
+    lldb::addr_t
+    GetRegionBase ();
+
+    //------------------------------------------------------------------
+    /// Get the end address of this memory range.
+    ///
+    /// @return
+    ///     The base address of this memory range.
+    //------------------------------------------------------------------
+    lldb::addr_t
+    GetRegionEnd ();
+
+    //------------------------------------------------------------------
+    /// Check if this memory address is marked readable to the process.
+    ///
+    /// @return
+    ///     true if this memory address is marked readable
+    //------------------------------------------------------------------
+    bool
+    IsReadable ();
+
+    //------------------------------------------------------------------
+    /// Check if this memory address is marked writable to the process.
+    ///
+    /// @return
+    ///     true if this memory address is marked writable
+    //------------------------------------------------------------------
+    bool
+    IsWritable ();
+
+    //------------------------------------------------------------------
+    /// Check if this memory address is marked executable to the process.
+    ///
+    /// @return
+    ///     true if this memory address is marked executable
+    //------------------------------------------------------------------
+    bool
+    IsExecutable ();
+
+    bool
+    operator == (const lldb::SBMemoryRegionInfo &rhs) const;
+
+    bool
+    operator != (const lldb::SBMemoryRegionInfo &rhs) const;
+
+    bool
+    GetDescription (lldb::SBStream &description);
+
+private:
+
+    friend class SBProcess;
+    friend class SBMemoryRegionInfoList;
+
+    lldb_private::MemoryRegionInfo &
+    ref();
+
+    const lldb_private::MemoryRegionInfo &
+    ref() const;
+
+    SBMemoryRegionInfo (const lldb_private::MemoryRegionInfo *lldb_object_ptr);
+
+    lldb::MemoryRegionInfoUP m_opaque_ap;
+};
+
+
+} // namespace lldb
+
+#endif // LLDB_SBMemoryRegionInfo_h_
diff --git a/lldb/include/lldb/API/SBMemoryRegionInfoList.h b/lldb/include/lldb/API/SBMemoryRegionInfoList.h
new file mode 100644
index 00000000000..7723820897d
--- /dev/null
+++ b/lldb/include/lldb/API/SBMemoryRegionInfoList.h
@@ -0,0 +1,63 @@
+//===-- SBMemoryRegionInfoList.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_SBMemoryRegionInfoList_h_
+#define LLDB_SBMemoryRegionInfoList_h_
+
+#include "lldb/API/SBDefines.h"
+
+class MemoryRegionInfoListImpl;
+
+namespace lldb {
+
+class LLDB_API SBMemoryRegionInfoList
+{
+public:
+
+    SBMemoryRegionInfoList ();
+
+    SBMemoryRegionInfoList (const lldb::SBMemoryRegionInfoList &rhs);
+
+    const SBMemoryRegionInfoList &
+    operator = (const SBMemoryRegionInfoList &rhs);
+
+    ~SBMemoryRegionInfoList ();
+
+    uint32_t
+    GetSize () const;
+
+    bool
+    GetMemoryRegionAtIndex (uint32_t idx, SBMemoryRegionInfo &region_info);
+
+    void
+    Append (lldb::SBMemoryRegionInfo &region);
+
+    void
+    Append (lldb::SBMemoryRegionInfoList &region_list);
+
+    void
+    Clear ();
+
+protected:
+
+    const MemoryRegionInfoListImpl *
+    operator->() const;
+
+    const MemoryRegionInfoListImpl &
+    operator*() const;
+
+private:
+
+    std::unique_ptr<MemoryRegionInfoListImpl> m_opaque_ap;
+
+};
+
+} // namespace lldb
+
+#endif // LLDB_SBMemoryRegionInfoList_h_
diff --git a/lldb/include/lldb/API/SBProcess.h b/lldb/include/lldb/API/SBProcess.h
index 1a9cc802288..a8881ad898c 100644
--- a/lldb/include/lldb/API/SBProcess.h
+++ b/lldb/include/lldb/API/SBProcess.h
@@ -393,6 +393,34 @@ public:
     lldb::SBError
     SaveCore(const char *file_name);
 
+    //------------------------------------------------------------------
+    /// Query the address load_addr and store the details of the memory
+    /// region that contains it in the supplied SBMemoryRegionInfo object.
+    /// To iterate over all memory regions use GetMemoryRegionList.
+    ///
+    /// @param[in] load_addr
+    ///     The address to be queried.
+    ///
+    /// @param[out] region_info
+    ///     A reference to an SBMemoryRegionInfo object that will contain
+    ///     the details of the memory region containing load_addr.
+    ///
+    /// @return
+    ///     An error object describes any errors that occurred while
+    ///     querying load_addr.
+    //------------------------------------------------------------------
+    lldb::SBError
+    GetMemoryRegionInfo (lldb::addr_t load_addr, lldb::SBMemoryRegionInfo &region_info);
+
+    //------------------------------------------------------------------
+    /// Return the list of memory regions within the process.
+    ///
+    /// @return
+    ///     A list of all witin the process memory regions.
+    //------------------------------------------------------------------
+    lldb::SBMemoryRegionInfoList
+    GetMemoryRegions();
+
 protected:
     friend class SBAddress;
     friend class SBBreakpoint;
diff --git a/lldb/include/lldb/API/SBStream.h b/lldb/include/lldb/API/SBStream.h
index e62723c2f37..717979977d1 100644
--- a/lldb/include/lldb/API/SBStream.h
+++ b/lldb/include/lldb/API/SBStream.h
@@ -76,6 +76,7 @@ protected:
     friend class SBInstruction;
     friend class SBInstructionList;
     friend class SBLineEntry;
+    friend class SBMemoryRegionInfo;
     friend class SBModule;
     friend class SBModuleSpec;
     friend class SBModuleSpecList;