Make SBMemoryRegionInfoList iterable with Python SWIG #117358
Conversation
|
Thank you for submitting a Pull Request (PR) to the LLVM Project! This PR will be automatically labeled and the relevant teams will be notified. If you wish to, you can add reviewers by using the "Reviewers" section on this page. If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers. If you have further questions, they may be answered by the LLVM GitHub User Guide. You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums. |
|
@lukejriddle Can we add a test for this? We just want to have a test case that iterates the regions. |
Done |
|
@llvm/pr-subscribers-lldb Author: Luke Riddle (lukejriddle) ChangesThis PR fixes a simple SWIG issue with SBMemoryRegionInfoList not being iterable out-of-the-box. This is mostly because of limitations to the Before: After: Full diff: https://github.com/llvm/llvm-project/pull/117358.diff 2 Files Affected:
diff --git a/lldb/bindings/interface/SBMemoryRegionInfoListExtensions.i b/lldb/bindings/interface/SBMemoryRegionInfoListExtensions.i
index 49d49110de7ff9..29c0179c0ffe3e 100644
--- a/lldb/bindings/interface/SBMemoryRegionInfoListExtensions.i
+++ b/lldb/bindings/interface/SBMemoryRegionInfoListExtensions.i
@@ -7,7 +7,12 @@
def __iter__(self):
'''Iterate over all the memory regions in a lldb.SBMemoryRegionInfoList object.'''
- return lldb_iter(self, 'GetSize', 'GetMemoryRegionAtIndex')
+ import lldb
+ size = self.GetSize()
+ region = lldb.SBMemoryRegionInfo()
+ for i in range(size):
+ self.GetMemoryRegionAtIndex(i, region)
+ yield region
%}
#endif
}
diff --git a/lldb/test/API/python_api/find_in_memory/TestFindInMemory.py b/lldb/test/API/python_api/find_in_memory/TestFindInMemory.py
index 04e807c5c6201d..1ef37d2ec98988 100644
--- a/lldb/test/API/python_api/find_in_memory/TestFindInMemory.py
+++ b/lldb/test/API/python_api/find_in_memory/TestFindInMemory.py
@@ -152,3 +152,16 @@ def test_find_in_memory_unaligned(self):
)
self.assertSuccess(error)
self.assertEqual(addr, lldb.LLDB_INVALID_ADDRESS)
+
+ def test_memory_info_list_iterable(self):
+ """Make sure the SBMemoryRegionInfoList is iterable"""
+ self.assertTrue(self.process, PROCESS_IS_VALID)
+ self.assertState(self.process.GetState(), lldb.eStateStopped, PROCESS_STOPPED)
+
+ info_list = self.process.GetMemoryRegions()
+ self.assertTrue(info_list.GetSize() > 0)
+ try:
+ for info in info_list:
+ pass
+ except Exception:
+ self.fail("SBMemoryRegionInfoList is not iterable")
|
| return lldb_iter(self, 'GetSize', 'GetMemoryRegionAtIndex') | ||
| import lldb | ||
| size = self.GetSize() | ||
| region = lldb.SBMemoryRegionInfo() | ||
| for i in range(size): | ||
| self.GetMemoryRegionAtIndex(i, region) | ||
| yield region |
There was a problem hiding this comment.
We might want to add a getitem and repr like found in SBAddressRangeListExtensions.i:
def __getitem__(self, idx):
'''Get the address range at a given index in an lldb.SBAddressRangeList object.'''
if not isinstance(idx, int):
raise TypeError("unsupported index type: %s" % type(idx))
count = len(self)
if not (-count <= idx < count):
raise IndexError("list index out of range")
idx %= count
return self.GetAddressRangeAtIndex(idx)
def __repr__(self):
import lldb
stream = lldb.SBStream()
self.GetDescription(stream, lldb.target if lldb.target else lldb.SBTarget())
return stream.GetData()
|
@lukejriddle Congratulations on having your first Pull Request (PR) merged into the LLVM Project! Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR. Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues. How to do this, and the rest of the post-merge process, is covered in detail here. If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again. If you don't get any reports, no action is required from you. Your changes are working as expected, well done! |
…ions is iterable (#125557) My colleague, @lukejriddle made the SBMemoryRegionList object iterable in #117358. This isn't documented anywhere and so I added a blurb about it to SBProcess.
…ions is iterable (llvm#125557) My colleague, @lukejriddle made the SBMemoryRegionList object iterable in llvm#117358. This isn't documented anywhere and so I added a blurb about it to SBProcess.
4 participants
This PR fixes a simple SWIG issue with SBMemoryRegionInfoList not being iterable out-of-the-box. This is mostly because of limitations to the
lldb_iterfunction, which doesn't allow for specifying arguments to the size / iter functions passed.Before:
After: