contrib/elftoolchain/libdwarf/dwarf_fde_cfa_offset.3

   1 .\" Copyright (c) 2011 Kai Wang
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $Id: dwarf_fde_cfa_offset.3 2073 2011-10-27 03:30:47Z jkoshy $
  26 .\"
  27 .Dd September 26, 2011
  28 .Os
  29 .Dt DWARF_FDE_CFA_OFFSET 3
  30 .Sh NAME
  31 .Nm dwarf_fde_cfa_offset
  32 .Nd add a DW_CFA_offset frame instruction to a DWARF frame descriptor
  33 .Sh LIBRARY
  34 .Lb libdwarf
  35 .Sh SYNOPSIS
  36 .In libdwarf.h
  37 .Ft "Dwarf_P_Fde"
  38 .Fo dwarf_fde_cfa_offset
  39 .Fa "Dwarf_P_Fde fde"
  40 .Fa "Dwarf_Unsigned reg"
  41 .Fa "Dwarf_Signed offset"
  42 .Fa "Dwarf_Error *err"
  43 .Fc
  44 .Sh DESCRIPTION
  45 Function
  46 .Fn dwarf_fde_cfa_offset
  47 appends a
  48 .Dv DW_CFA_offset
  49 frame instruction to the frame descriptor referenced by argument
  50 .Ar fde .
  51 .Pp
  52 Argument
  53 .Ar fde
  54 should reference a frame descriptor allocated using
  55 .Xr dwarf_new_fde 3 .
  56 .Pp
  57 Argument
  58 .Ar reg
  59 specifies the register operand for the frame instruction.
  60 .Pp
  61 Argument
  62 .Ar offset
  63 specifies the offset operand for the frame instruction.
  64 .Pp
  65 If argument
  66 .Ar err
  67 is not NULL, it will be used to store error information in case of an
  68 error.
  69 .Sh RETURN VALUES
  70 On success, function
  71 .Fn dwarf_fde_cfa_offset
  72 returns the frame descriptor given in argument
  73 .Ar fde .
  74 In case of an error, function
  75 .Fn dwarf_fde_cfa_offset
  76 returns
  77 .Dv DW_DLV_BADADDR
  78 and sets the argument
  79 .Ar err .
  80 .Sh ERRORS
  81 Function
  82 .Fn dwarf_fde_cfa_offset
  83 can fail with:
  84 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
  85 .It Bq Er DW_DLE_ARGUMENT
  86 Argument
  87 .Ar fde
  88 was NULL.
  89 .It Bq Er DW_DLE_MEMORY
  90 An out of memory condition was encountered during the execution of the
  91 function.
  92 .El
  93 .Sh SEE ALSO
  94 .Xr dwarf 3 ,
  95 .Xr dwarf_add_fde_inst 3 ,
  96 .Xr dwarf_add_frame_fde 3 ,
  97 .Xr dwarf_add_frame_fde_b 3 ,
  98 .Xr dwarf_add_frame_cie 3 ,
  99 .Xr dwarf_new_fde 3