2 .\" Manual page created with latex2man on Wed Aug 16 11:09:44 PDT 2017
3 .\" NOTE: This file is generated, DO NOT EDIT.
13 .TH "UNW\\_REG\\_STATES\\_ITERATE" "3" "16 August 2017" "Programming Library " "Programming Library "
15 unw_reg_states_iterate
16 \-\- get register state info on current procedure
21 #include <libunwind.h>
25 unw_reg_states_iterate(unw_cursor_t *cp,
26 unw_reg_states_callbackcb,
33 The unw_reg_states_iterate()
35 information about the procedure that created the stack frame
36 identified by argument cp\&.
39 to a function of type unw_reg_states_callback
41 return the information. The function unw_reg_states_callback
46 ( *unw_reg_states_callback)(void *token,
47 void *reg_states_data,
55 The callback function may be invoked several times for each call of unw_reg_states_iterate\&.
56 Each call is associcated with a instruction address range and a set of instructions on how to update register values when returning from the procedure in that address range. For each invocation, the arguments to the callback function are:
59 The token value passed to unw_reg_states_callback\&.
62 void * reg_states_data
63 A pointer to data about
64 updating register values. This data, or a copy of it, can be passed
65 to unw_apply_reg_state\&.
68 int reg_states_data_size
69 The size of the register update data.
73 The address of the first
74 instruction of the address range.
78 The address of the first
79 instruction \fIbeyond\fP
80 the end of the address range.
86 On successful completion, unw_reg_states_iterate()
88 0. If the callback function returns a nonzero value, that indicates
89 failure and the function returns immediately. Otherwise the negative
90 value of one of the error\-codes below is returned.
92 .SH THREAD AND SIGNAL SAFETY
95 unw_reg_states_iterate()
96 is thread\-safe. If cursor cp
98 in the local address\-space, this routine is also safe to use from a
106 An unspecified error occurred.
111 unwind\-info for the procedure.
114 The unwind\-info for the procedure has
115 version or format that is not understood by libunwind\&.
117 In addition, unw_reg_states_iterate()
119 returned by the access_mem()
121 unw_create_addr_space(3)).
127 unw_apply_reg_state(3)
132 David Mosberger\-Tang
134 Email: \fBdmosberger@gmail.com\fP
136 WWW: \fBhttp://www.nongnu.org/libunwind/\fP\&.
137 .\" NOTE: This file is generated, DO NOT EDIT.