Initial import
[external/libunwind.git] / doc / unw_set_fpreg.tex
1 \documentclass{article}
2 \usepackage[fancyhdr,pdf]{latex2man}
3
4 \input{common.tex}
5
6 \begin{document}
7
8 \begin{Name}{3}{unw\_set\_fpreg}{David Mosberger-Tang}{Programming Library}{unw\_set\_fpreg}unw\_set\_fpreg -- set contents of floating-point register
9 \end{Name}
10
11 \section{Synopsis}
12
13 \File{\#include $<$libunwind.h$>$}\\
14
15 \Type{int} \Func{unw\_set\_fpreg}(\Type{unw\_cursor\_t~*}\Var{cp}, \Type{unw\_regnum\_t} \Var{reg}, \Type{unw\_fpreg\_t} \Var{val});\\
16
17 \section{Description}
18
19 The \Func{unw\_set\_fpreg}() routine sets the value of register
20 \Var{reg} in the stack frame identified by cursor \Var{cp} to the
21 value passed in \Var{val}.
22
23 The register numbering is target-dependent and described in separate
24 manual pages (e.g., libunwind-ia64(3) for the IA-64 target).
25 Furthermore, the exact set of accessible registers may depend on the
26 type of frame that \Var{cp} is referring to.  For ordinary stack
27 frames, it is normally possible to access only the preserved
28 (``callee-saved'') registers and frame-related registers (such as the
29 stack-pointer).  However, for signal frames (see
30 \Func{unw\_is\_signal\_frame}(3)), it is usually possible to access
31 all registers.
32
33 Note that \Func{unw\_set\_fpreg}() can only write the contents of
34 floating-point registers.  See \Func{unw\_set\_reg}(3) for a way to
35 write registers which fit in a single word.
36
37 \section{Return Value}
38
39 On successful completion, \Func{unw\_set\_fpreg}() returns 0.
40 Otherwise the negative value of one of the error-codes below is
41 returned.
42
43 \section{Thread and Signal Safety}
44
45 \Func{unw\_set\_fpreg}() is thread-safe as well as safe to use
46 from a signal handler.
47
48 \section{Errors}
49
50 \begin{Description}
51 \item[\Const{UNW\_EUNSPEC}] An unspecified error occurred.
52 \item[\Const{UNW\_EBADREG}] An attempt was made to write a register
53   that is either invalid or not accessible in the current frame.
54 \item[\Const{UNW\_EREADONLY}] An attempt was made to write to a
55   read-only register.
56 \end{Description}
57 In addition, \Func{unw\_set\_fpreg}() may return any error returned by
58 the \Func{access\_mem}(), \Func{access\_reg}(), and
59 \Func{access\_fpreg}() call-backs (see
60 \Func{unw\_create\_addr\_space}(3)).
61
62 \section{See Also}
63
64 \SeeAlso{libunwind(3)},
65 \SeeAlso{libunwind-ia64(3)},
66 \SeeAlso{unw\_get\_fpreg(3)},
67 \SeeAlso{unw\_is\_fpreg(3)},
68 \SeeAlso{unw\_is\_signal\_frame(3)},
69 \SeeAlso{unw\_set\_reg(3)}
70
71 \section{Author}
72
73 \noindent
74 David Mosberger-Tang\\
75 Email: \Email{dmosberger@gmail.com}\\
76 WWW: \URL{http://www.nongnu.org/libunwind/}.
77 \LatexManEnd
78
79 \end{document}