Skip to content

Commit 41dc04e

Browse files
committed
[lldb] Add swig doc for SBProcess address mask methods
Add descriptions of `GetAddressMask`, `SetAddressMask`, `SetAddressableBits`, and `FixAddress` SBProcess methods.
1 parent f7d9337 commit 41dc04e

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

lldb/bindings/interface/SBProcessDocstrings.i

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,47 @@ SBProcess supports thread iteration. For example (from test/lldbutil.py), ::
199199
process_info.GetProcessID()"
200200
) lldb::SBProcess::GetProcessInfo;
201201

202+
%feature("docstring", "
203+
Get the current address mask in this Process of a given type.
204+
There are lldb.eAddressMaskTypeCode and lldb.eAddressMaskTypeData address
205+
masks, and on most Targets, the the Data address mask is more general
206+
because there are no alignment restrictions, as there can be with Code
207+
addresses.
208+
lldb.eAddressMaskTypeAny may be used to get the most general mask.
209+
The bits which are not used for addressing are set to 1 in the returned
210+
mask.
211+
In an unusual environment with different address masks for high and low
212+
memory, this may also be specified. This is uncommon, default is
213+
lldb.eAddressMaskRangeLow."
214+
) lldb::SBProcess::GetAddressMask;
215+
216+
%feature("docstring", "
217+
Set the current address mask in this Process for a given type,
218+
lldb.eAddressMaskTypeCode or lldb.eAddressMaskTypeData. Bits that are not
219+
used for addressing should be set to 1 in the mask.
220+
When setting all masks, lldb.eAddressMaskTypeAll may be specified.
221+
In an unusual environment with different address masks for high and low
222+
memory, this may also be specified. This is uncommon, default is
223+
lldb.eAddressMaskRangeLow."
224+
) lldb::SBProcess::SetAddressMask;
225+
226+
%feature("docstring", "
227+
Set the number of low bits relevant for addressing in this Process
228+
for a given type, lldb.eAddressMaskTypeCode or lldb.eAddressMaskTypeData.
229+
When setting all masks, lldb.eAddressMaskTypeAll may be specified.
230+
In an unusual environment with different address masks for high and low
231+
memory, the address range may also be specified. This is uncommon,
232+
default is lldb.eAddressMaskRangeLow."
233+
) lldb::SBProcess::SetAddressableBits;
234+
235+
%feature("docstring", "
236+
Given a virtual address, clear the bits that are not used for addressing
237+
(and may be used for metadata, memory tagging, point authentication, etc).
238+
By default the most general mask, lldb.eAddressMaskTypeAny is used to
239+
process the address, but lldb.eAddressMaskTypeData and
240+
lldb.eAddressMaskTypeCode may be specified if the type of address is known."
241+
) lldb::SBProcess::FixAddress;
242+
202243
%feature("docstring", "
203244
Allocates a block of memory within the process, with size and
204245
access permissions specified in the arguments. The permissions

0 commit comments

Comments
 (0)