doc/unw_step.man

   1 '\" t
   2 .\" Manual page created with latex2man on Thu Aug 16 09:44:45 MDT 2007
   3 .\" NOTE: This file is generated, DO NOT EDIT.
   4 .de Vb
   5 .ft CW
   6 .nf
   7 ..
   8 .de Ve
   9 .ft R
  10
  11 .fi
  12 ..
  13 .TH "UNW\\_STEP" "3" "16 August 2007" "Programming Library " "Programming Library "
  14 .SH NAME
  15 unw_step
  16 \-\- advance to next stack frame
  17 .PP
  18 .SH SYNOPSIS
  19
  20 .PP
  21 #include <libunwind.h>
  22 .br
  23 .PP
  24 int
  25 unw_step(unw_cursor_t *cp);
  26 .br
  27 .PP
  28 .SH DESCRIPTION
  29
  30 .PP
  31 The unw_step()
  32 routine advances the unwind cursor cp
  33 to
  34 the next older, less deeply nested stack frame.
  35 .PP
  36 .SH RETURN VALUE
  37
  38 .PP
  39 On successful completion, unw_step()
  40 returns a positive value
  41 if the updated cursor refers to a valid stack frame, or 0 if the
  42 previous stack frame was the last frame in the chain. On error, the
  43 negative value of one of the error\-codes below is returned.
  44 .PP
  45 .SH THREAD AND SIGNAL SAFETY
  46
  47 .PP
  48 unw_step()
  49 is thread\-safe. If cursor cp
  50 is in the local
  51 address\-space, this routine is also safe to use from a signal handler.
  52 .PP
  53 .SH ERRORS
  54
  55 .PP
  56 .TP
  57 UNW_EUNSPEC
  58  An unspecified error occurred.
  59 .TP
  60 UNW_ENOINFO
  61  Libunwind
  62 was unable to locate the
  63 unwind\-info needed to complete the operation.
  64 .TP
  65 UNW_EBADVERSION
  66  The unwind\-info needed to complete the
  67 operation has a version or a format that is not understood by
  68 libunwind\&.
  69 .TP
  70 UNW_EINVALIDIP
  71  The instruction\-pointer
  72 (``program\-counter\&'') of the next stack frame is invalid (e.g., not
  73 properly aligned).
  74 .TP
  75 UNW_EBADFRAME
  76  The next stack frame is invalid.
  77 .TP
  78 UNW_ESTOPUNWIND
  79  Returned if a call to
  80 find_proc_info()
  81 returned \-UNW_ESTOPUNWIND\&.
  82 .PP
  83 In addition, unw_step()
  84 may return any error returned by the
  85 find_proc_info(),
  86 get_dyn_info_list_addr(),
  87 access_mem(),
  88 access_reg(),
  89 or access_fpreg()
  90 call\-backs (see unw_create_addr_space(3)).
  91 .PP
  92 .SH SEE ALSO
  93
  94 .PP
  95 libunwind(3),
  96 unw_create_addr_space(3)
  97 .PP
  98 .SH AUTHOR
  99
 100 .PP
 101 David Mosberger\-Tang
 102 .br
 103 Email: \fBdmosberger@gmail.com\fP
 104 .br
 105 WWW: \fBhttp://www.nongnu.org/libunwind/\fP\&.
 106 .\" NOTE: This file is generated, DO NOT EDIT.