2 .\" Manual page created with latex2man on Wed Aug 16 12:11:05 PDT 2017
3 .\" NOTE: This file is generated, DO NOT EDIT.
13 .TH "UNW\\_INIT\\_LOCAL" "3" "16 August 2017" "Programming Library " "Programming Library "
16 \-\- initialize cursor for local unwinding
21 #include <libunwind.h>
25 unw_init_local(unw_cursor_t *c,
29 unw_init_local2(unw_cursor_t *c,
39 routine initializes the unwind cursor
41 with the machine\-state in the context structure
43 As such, the machine\-state pointed to by
45 identifies the initial stack frame at which unwinding
46 starts. The machine\-state is expected to be one provided by a call to
47 unw_getcontext; as such, the instruction pointer may point to the
48 instruction after the last instruction of a function, and libunwind
49 will back\-up the instruction pointer before beginning a walk up the
50 call stack. The machine\-state must remain valid for the duration for
55 routine can be used only for unwinding in
56 the address space of the current process (i.e., for local unwinding).
57 For all other cases, unw_init_remote()
59 However, unwind performance may be better when using
61 Also, unw_init_local()
63 available even when UNW_LOCAL_ONLY
64 has been defined before
65 including <libunwind.h>,
66 whereas unw_init_remote()
69 If the unw_context_t is known to be a signal frame (i.e., from the
70 third argument in a sigaction handler on linux),
72 should be used for correct initialization
73 on some platforms, passing the UNW_INIT_SIGNAL_FRAME flag.
78 On successful completion, unw_init_local()
80 Otherwise the negative value of one of the error\-codes below is
83 .SH THREAD AND SIGNAL SAFETY
87 is thread\-safe as well as safe to use from a
98 which supports remote unwinding only
99 (this normally happens when calling unw_init_local()
101 cross\-platform version of libunwind).
104 An unspecified error occurred.
107 A register needed by unw_init_local()
119 David Mosberger\-Tang
121 Email: \fBdmosberger@gmail.com\fP
123 WWW: \fBhttp://www.nongnu.org/libunwind/\fP\&.
124 .\" NOTE: This file is generated, DO NOT EDIT.