Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
UNW_INIT_REMOTE(3libunwind)  Programming Library   UNW_INIT_REMOTE(3libunwind)

NAME
       unw_init_remote -- initialize cursor for	remote unwinding

SYNOPSIS
       #include	<libunwind.h>

       int unw_init_remote(unw_cursor_t	*c, unw_addr_space_t as, void *arg);

DESCRIPTION
       The  unw_init_remote() routine initializes the unwind cursor pointed to
       by c for	unwinding in the address space identified by as.  The as argu-
       ment can	either be set to unw_local_addr_space (local address space) or
       to an arbitrary address space created with unw_create_addr_space().

       The arg opaque pointer tells the	 address  space	 exactly  what	entity
       should  be  unwound.  For example, if unw_local_addr_space is passed in
       as, then	arg needs to be	a pointer to a	context	 structure  containing
       the  machine-state  of the initial stack	frame.	However, other address
       spaces may instead expect a process ID, a thread	ID, or a pointer to an
       arbitrary structure which identifies the	stack frame chain  to  be  un-
       wound.  In other	words, the interpretation of arg is entirely dependent
       on the address space in use; libunwind never interprets the argument in
       any way on its own.

       Note that unw_init_remote() can be used to initiate  unwinding  in  any
       process,	 including  the	 local process in which	the unwinder itself is
       running.	However, for local unwinding, it is  generally	preferable  to
       use  unw_init_local()  instead, because it is easier to use and because
       it may perform better.

RETURN VALUE
       On successful completion, unw_init_remote() returns 0.	Otherwise  the
       negative	value of one of	the error-codes	below is returned.

THREAD AND SIGNAL SAFETY
       unw_init_remote()  is thread safe. If the local address space is	passed
       in argument as, this routine is also safe to use	from a signal handler.

ERRORS
       UNW_EINVAL
	       unw_init_remote() was called in a version  of  libunwind	 which
	      supports local unwinding only (this normally happens when	defin-
	      ing UNW_LOCAL_ONLY before	including <libunwind.h>	and then call-
	      ing unw_init_remote()).

       UNW_EUNSPEC
	       An unspecified error occurred.

       UNW_EBADREG
	       A register needed by unw_init_remote() wasn't accessible.

SEE ALSO
       libunwind(3libunwind),  unw_create_addr_space(3libunwind), unw_init_lo-
       cal(3libunwind)

AUTHOR
       David Mosberger-Tang
       Email: dmosberger@gmail.com
       WWW: http://www.nongnu.org/libunwind/.

Programming Library		29 August 2023	   UNW_INIT_REMOTE(3libunwind)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=unw_init_remote&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help