xref: /freebsd-src/contrib/llvm-project/lldb/bindings/interface/SBMemoryRegionInfoDocstrings.i (revision 0fca6ea1d4eea4c934cfff25ac9ee8ad6fe95583)
106c3fb27SDimitry Andric %feature("docstring",
206c3fb27SDimitry Andric "API clients can get information about memory regions in processes."
306c3fb27SDimitry Andric ) lldb::SBMemoryRegionInfo;
406c3fb27SDimitry Andric 
5*0fca6ea1SDimitry Andric %feature("docstring", "
606c3fb27SDimitry Andric         Returns whether this memory region has a list of modified (dirty)
706c3fb27SDimitry Andric         pages available or not.  When calling GetNumDirtyPages(), you will
806c3fb27SDimitry Andric         have 0 returned for both \"dirty page list is not known\" and
906c3fb27SDimitry Andric         \"empty dirty page list\" (that is, no modified pages in this
1006c3fb27SDimitry Andric         memory region).  You must use this method to disambiguate."
1106c3fb27SDimitry Andric ) lldb::SBMemoryRegionInfo::HasDirtyMemoryPageList;
1206c3fb27SDimitry Andric 
13*0fca6ea1SDimitry Andric %feature("docstring", "
1406c3fb27SDimitry Andric         Return the number of dirty (modified) memory pages in this
1506c3fb27SDimitry Andric         memory region, if available.  You must use the
1606c3fb27SDimitry Andric         SBMemoryRegionInfo::HasDirtyMemoryPageList() method to
1706c3fb27SDimitry Andric         determine if a dirty memory list is available; it will depend
1806c3fb27SDimitry Andric         on the target system can provide this information."
1906c3fb27SDimitry Andric ) lldb::SBMemoryRegionInfo::GetNumDirtyPages;
2006c3fb27SDimitry Andric 
21*0fca6ea1SDimitry Andric %feature("docstring", "
2206c3fb27SDimitry Andric         Return the address of a modified, or dirty, page of memory.
2306c3fb27SDimitry Andric         If the provided index is out of range, or this memory region
2406c3fb27SDimitry Andric         does not have dirty page information, LLDB_INVALID_ADDRESS
2506c3fb27SDimitry Andric         is returned."
2606c3fb27SDimitry Andric ) lldb::SBMemoryRegionInfo::GetDirtyPageAddressAtIndex;
2706c3fb27SDimitry Andric 
28*0fca6ea1SDimitry Andric %feature("docstring", "
2906c3fb27SDimitry Andric         Return the size of pages in this memory region.  0 will be returned
3006c3fb27SDimitry Andric         if this information was unavailable."
3106c3fb27SDimitry Andric ) lldb::SBMemoryRegionInfo::GetPageSize();
32