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