xref: /llvm-project/lldb/bindings/interface/SBMemoryRegionInfoDocstrings.i (revision e35fb3fb8bfcb732ace3738f9589989b3fac1508)
1662548c8SAlex Langford %feature("docstring",
2662548c8SAlex Langford "API clients can get information about memory regions in processes."
3662548c8SAlex Langford ) lldb::SBMemoryRegionInfo;
4662548c8SAlex Langford 
5*e35fb3fbSJason Molenda %feature("docstring", "
6662548c8SAlex Langford         Returns whether this memory region has a list of modified (dirty)
7662548c8SAlex Langford         pages available or not.  When calling GetNumDirtyPages(), you will
8662548c8SAlex Langford         have 0 returned for both \"dirty page list is not known\" and
9662548c8SAlex Langford         \"empty dirty page list\" (that is, no modified pages in this
10662548c8SAlex Langford         memory region).  You must use this method to disambiguate."
11662548c8SAlex Langford ) lldb::SBMemoryRegionInfo::HasDirtyMemoryPageList;
12662548c8SAlex Langford 
13*e35fb3fbSJason Molenda %feature("docstring", "
14662548c8SAlex Langford         Return the number of dirty (modified) memory pages in this
15662548c8SAlex Langford         memory region, if available.  You must use the
16662548c8SAlex Langford         SBMemoryRegionInfo::HasDirtyMemoryPageList() method to
17662548c8SAlex Langford         determine if a dirty memory list is available; it will depend
18662548c8SAlex Langford         on the target system can provide this information."
19662548c8SAlex Langford ) lldb::SBMemoryRegionInfo::GetNumDirtyPages;
20662548c8SAlex Langford 
21*e35fb3fbSJason Molenda %feature("docstring", "
22662548c8SAlex Langford         Return the address of a modified, or dirty, page of memory.
23662548c8SAlex Langford         If the provided index is out of range, or this memory region
24662548c8SAlex Langford         does not have dirty page information, LLDB_INVALID_ADDRESS
25662548c8SAlex Langford         is returned."
26662548c8SAlex Langford ) lldb::SBMemoryRegionInfo::GetDirtyPageAddressAtIndex;
27662548c8SAlex Langford 
28*e35fb3fbSJason Molenda %feature("docstring", "
29662548c8SAlex Langford         Return the size of pages in this memory region.  0 will be returned
30662548c8SAlex Langford         if this information was unavailable."
31662548c8SAlex Langford ) lldb::SBMemoryRegionInfo::GetPageSize();
32