xref: /freebsd/contrib/llvm-project/lldb/bindings/interface/SBMemoryRegionInfoDocstrings.i (revision a64729f5077d77e13b9497cb33ecb3c82e606ee8)
1 %feature("docstring",
2 "API clients can get information about memory regions in processes."
3 ) lldb::SBMemoryRegionInfo;
4 
5 %feature("autodoc", "
6         GetRegionEnd(SBMemoryRegionInfo self) -> lldb::addr_t
7         Returns whether this memory region has a list of modified (dirty)
8         pages available or not.  When calling GetNumDirtyPages(), you will
9         have 0 returned for both \"dirty page list is not known\" and
10         \"empty dirty page list\" (that is, no modified pages in this
11         memory region).  You must use this method to disambiguate."
12 ) lldb::SBMemoryRegionInfo::HasDirtyMemoryPageList;
13 
14 %feature("autodoc", "
15         GetNumDirtyPages(SBMemoryRegionInfo self) -> uint32_t
16         Return the number of dirty (modified) memory pages in this
17         memory region, if available.  You must use the
18         SBMemoryRegionInfo::HasDirtyMemoryPageList() method to
19         determine if a dirty memory list is available; it will depend
20         on the target system can provide this information."
21 ) lldb::SBMemoryRegionInfo::GetNumDirtyPages;
22 
23 %feature("autodoc", "
24         GetDirtyPageAddressAtIndex(SBMemoryRegionInfo self, uint32_t idx) -> lldb::addr_t
25         Return the address of a modified, or dirty, page of memory.
26         If the provided index is out of range, or this memory region
27         does not have dirty page information, LLDB_INVALID_ADDRESS
28         is returned."
29 ) lldb::SBMemoryRegionInfo::GetDirtyPageAddressAtIndex;
30 
31 %feature("autodoc", "
32         GetPageSize(SBMemoryRegionInfo self) -> int
33         Return the size of pages in this memory region.  0 will be returned
34         if this information was unavailable."
35 ) lldb::SBMemoryRegionInfo::GetPageSize();
36