doc/unw_get_fpreg.man

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