unw_step.man 2.0 KB

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