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