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