blob: 5e54ca13d3bb52e6ace436fd457b68496514c150 [file] [log] [blame]
mostang.com!davidm9eb9f312003-04-01 07:19:34 +00001'\" t
David Mosberger-Tang75f34cc2007-08-22 12:49:08 -06002.\" Manual page created with latex2man on Thu Aug 16 09:44:45 MDT 2007
mostang.com!davidm9eb9f312003-04-01 07:19:34 +00003.\" 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..
David Mosberger-Tang75f34cc2007-08-22 12:49:08 -060013.TH "UNW\\_GET\\_FPREG" "3" "16 August 2007" "Programming Library " "Programming Library "
mostang.com!davidm9eb9f312003-04-01 07:19:34 +000014.SH NAME
15unw_get_fpreg
16\-\- get contents of floating\-point register
17.PP
18.SH SYNOPSIS
19
20.PP
21#include <libunwind.h>
22.br
23.PP
24int
25unw_get_fpreg(unw_cursor_t *cp,
26unw_regnum_t
27reg,
28unw_fpreg_t *valp);
29.br
30.PP
31.SH DESCRIPTION
32
33.PP
34The unw_get_fpreg()
35routine reads the value of floating\-point
36register reg
37in the stack frame identified by cursor cp
38and stores the value in the variable pointed to by valp\&.
39.PP
40The register numbering is target\-dependent and described in separate
41manual pages (e.g., libunwind\-ia64(3) for the IA\-64 target).
42Furthermore, the exact set of accessible registers may depend on the
43type of frame that cp
44is referring to. For ordinary stack
45frames, it is normally possible to access only the preserved
46(``callee\-saved\&'') registers and frame\-related registers (such as the
47stack\-pointer). However, for signal frames (see
48unw_is_signal_frame(3)),
49it is usually possible to access
50all registers.
51.PP
52Note that unw_get_fpreg()
53can only read the contents of
54floating\-point registers. See unw_get_fpreg(3)
55for a way to
56read registers which fit in a single word.
57.PP
58.SH RETURN VALUE
59
60.PP
61On successful completion, unw_get_fpreg()
62returns 0.
63Otherwise the negative value of one of the error\-codes below is
64returned.
65.PP
66.SH THREAD AND SIGNAL SAFETY
67
68.PP
69unw_get_fpreg()
70is thread\-safe as well as safe to use
71from a signal handler.
72.PP
73.SH ERRORS
74
75.PP
76.TP
77UNW_EUNSPEC
78 An unspecified error occurred.
79.TP
80UNW_EBADREG
81 An attempt was made to read a register
82that is either invalid or not accessible in the current frame.
83.PP
84In addition, unw_get_fpreg()
85may return any error returned by
86the access_mem(),
87access_reg(),
88and
89access_fpreg()
90call\-backs (see
91unw_create_addr_space(3)).
92.PP
93.SH SEE ALSO
94
95.PP
96libunwind(3),
97libunwind\-ia64(3),
98unw_get_reg(3),
99unw_is_fpreg(3),
100unw_is_signal_frame(3),
101unw_set_fpreg(3)
102.PP
103.SH AUTHOR
104
105.PP
106David Mosberger\-Tang
mostang.com!davidm9eb9f312003-04-01 07:19:34 +0000107.br
David Mosberger-Tang75f34cc2007-08-22 12:49:08 -0600108Email: \fBdmosberger@gmail.com\fP
109.br
110WWW: \fBhttp://www.nongnu.org/libunwind/\fP\&.
mostang.com!davidm9eb9f312003-04-01 07:19:34 +0000111.\" NOTE: This file is generated, DO NOT EDIT.