doc/unw_get_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\_get\_fpreg}{David Mosberger-Tang}{Programming Library}{unw\_get\_fpreg}unw\_get\_fpreg -- get contents of floating-point register
   9 \end{Name}
  10
  11 \section{Synopsis}
  12
  13 \File{\#include $<$libunwind.h$>$}\\
  14
  15 \Type{int} \Func{unw\_get\_fpreg}(\Type{unw\_cursor\_t~*}\Var{cp}, \Type{unw\_regnum\_t} \Var{reg}, \Type{unw\_fpreg\_t~*}\Var{valp});\\
  16
  17 \section{Description}
  18
  19 The \Func{unw\_get\_fpreg}() routine reads the value of floating-point
  20 register \Var{reg} in the stack frame identified by cursor \Var{cp}
  21 and stores the value in the variable pointed to by \Var{valp}.
  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\_get\_fpreg}() can only read the contents of
  34 floating-point registers.  See \Func{unw\_get\_fpreg}(3) for a way to
  35 read registers which fit in a single word.
  36
  37 \section{Return Value}
  38
  39 On successful completion, \Func{unw\_get\_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\_get\_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 read a register
  53   that is either invalid or not accessible in the current frame.
  54 \end{Description}
  55 In addition, \Func{unw\_get\_fpreg}() may return any error returned by
  56 the \Func{access\_mem}(), \Func{access\_reg}(), and
  57 \Func{access\_fpreg}() call-backs (see
  58 \Func{unw\_create\_addr\_space}(3)).
  59
  60 \section{See Also}
  61
  62 \SeeAlso{libunwind(3)},
  63 \SeeAlso{libunwind-ia64(3)},
  64 \SeeAlso{unw\_get\_reg(3)},
  65 \SeeAlso{unw\_is\_fpreg(3)},
  66 \SeeAlso{unw\_is\_signal\_frame(3)},
  67 \SeeAlso{unw\_set\_fpreg(3)}
  68
  69 \section{Author}
  70
  71 \noindent
  72 David Mosberger-Tang\\
  73 Email: \Email{dmosberger@gmail.com}\\
  74 WWW: \URL{http://www.nongnu.org/libunwind/}.
  75 \LatexManEnd
  76
  77 \end{document}