| mostang.com!davidm | 9eb9f31 | 2003-04-01 07:19:34 +0000 | [diff] [blame] | 1 | '\" t |
| 2 | .\" Manual page created with latex2man on Mon Mar 31 14:25:06 PST 2003 |
| 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\\_IS\\_SIGNAL\\_FRAME" "3" "31 March 2003" "Programming Library " "Programming Library " |
| 14 | .SH NAME |
| 15 | unw_is_signal_frame |
| 16 | \-\- check if current frame is a signal frame |
| 17 | .PP |
| 18 | .SH SYNOPSIS |
| 19 | |
| 20 | .PP |
| 21 | #include <libunwind.h> |
| 22 | .br |
| 23 | .PP |
| 24 | int |
| 25 | unw_is_signal_frame(unw_cursor_t *cp); |
| 26 | .br |
| 27 | .PP |
| 28 | .SH DESCRIPTION |
| 29 | |
| 30 | .PP |
| 31 | The unw_is_signal_frame() |
| 32 | routine returns a positive value |
| 33 | if the current frame identified by cp |
| 34 | is a signal frame, and a |
| 35 | value of 0 otherwise. For the purpose of this discussion, a signal |
| 36 | frame is a frame that was created in response to a potentially |
| 37 | asynchronous interruption. For UNIX and UNIX\-like platforms, such |
| 38 | frames are normally created by the kernel when delivering a signal. |
| 39 | In a kernel\-environment, a signal frame might, for example, correspond |
| 40 | to a frame created in response to a device interrupt. |
| 41 | .PP |
| 42 | Signal frames are somewhat unusual because the asynchronous nature of |
| 43 | the events that create them require storing the contents of registers |
| 44 | that are normally treated as scratch (``caller\-saved\&'') registers. |
| 45 | .PP |
| 46 | .SH RETURN VALUE |
| 47 | |
| 48 | .PP |
| 49 | On successful completion, unw_is_signal_frame() |
| 50 | returns a |
| 51 | positive value if the current frame is a signal frame, or 0 if it is |
| 52 | not. Otherwise, a negative value of one of the error\-codes below is |
| 53 | returned. |
| 54 | .PP |
| 55 | .SH THREAD AND SIGNAL SAFETY |
| 56 | |
| 57 | .PP |
| 58 | unw_is_signal_frame() |
| 59 | is thread\-safe as well as safe to use |
| 60 | from a signal handler. |
| 61 | .PP |
| 62 | .SH ERRORS |
| 63 | |
| 64 | .PP |
| 65 | .TP |
| 66 | UNW_ENOINFO |
| 67 | Libunwind |
| 68 | is unable to determine |
| 69 | whether or not the current frame is a signal frame. |
| 70 | .PP |
| 71 | .SH SEE ALSO |
| 72 | |
| 73 | .PP |
| 74 | libunwind(3), |
| 75 | unw_get_reg(3), |
| 76 | unw_set_reg(3), |
| 77 | unw_get_fpreg(3), |
| 78 | unw_set_fpreg(3) |
| 79 | .PP |
| 80 | .SH AUTHOR |
| 81 | |
| 82 | .PP |
| 83 | David Mosberger\-Tang |
| 84 | .br |
| 85 | Hewlett\-Packard Labs |
| 86 | .br |
| 87 | Palo\-Alto, CA 94304 |
| 88 | .br |
| 89 | Email: \fBdavidm@hpl.hp.com\fP |
| 90 | .br |
| 91 | WWW: \fBhttp://www.hpl.hp.com/research/linux/libunwind/\fP\&. |
| 92 | .\" NOTE: This file is generated, DO NOT EDIT. |