contrib/elftoolchain/libdwarf/dwarf_add_fde_inst.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_add_fde_inst.3 3644 2018-10-15 19:55:01Z jkoshy $
  26 .\"
  27 .Dd September 26, 2011
  28 .Dt DWARF_ADD_FDE_INST 3
  29 .Os
  30 .Sh NAME
  31 .Nm dwarf_add_fde_inst
  32 .Nd add a call 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_add_fde_inst
  39 .Fa "Dwarf_P_Fde fde"
  40 .Fa "Dwarf_Small op"
  41 .Fa "Dwarf_Unsigned val1"
  42 .Fa "Dwarf_Unsigned val2"
  43 .Fa "Dwarf_Error *err"
  44 .Fc
  45 .Sh DESCRIPTION
  46 Function
  47 .Fn dwarf_add_fde_inst
  48 adds a call frame instruction to the DWARF frame descriptor
  49 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 op
  59 specifies the operator for the frame instruction.
  60 The DWARF standard defines the set of legal values for this argument.
  61 .Pp
  62 Argument
  63 .Ar val1
  64 specifies the first operand of the frame instruction.
  65 .Pp
  66 Argument
  67 .Ar val2
  68 specifies the second operand of the frame instruction.
  69 .Pp
  70 If argument
  71 .Ar err
  72 is not NULL, it will be used to store error information in case of an
  73 error.
  74 .Sh RETURN VALUES
  75 On success, function
  76 .Fn dwarf_add_fde_inst
  77 returns the frame descriptor given in argument
  78 .Ar fde .
  79 In case of an error, function
  80 .Fn dwarf_add_fde_inst
  81 returns
  82 .Dv DW_DLV_BADADDR
  83 and sets the argument
  84 .Ar err .
  85 .Sh ERRORS
  86 Function
  87 .Fn dwarf_add_fde_inst
  88 can fail with:
  89 .Bl -tag -width ".Bq Er DW_DLE_FRAME_INSTR_EXEC_ERROR"
  90 .It Bq Er DW_DLE_ARGUMENT
  91 Argument
  92 .Ar fde
  93 was NULL.
  94 .It Bq Er DW_DLE_FRAME_INSTR_EXEC_ERROR
  95 The frame instruction operator specified in argument
  96 .Ar op
  97 was invalid.
  98 .It Bq Er DW_DLE_MEMORY
  99 An out of memory condition was encountered during the execution of the
 100 function.
 101 .El
 102 .Sh SEE ALSO
 103 .Xr dwarf 3 ,
 104 .Xr dwarf_add_frame_cie 3 ,
 105 .Xr dwarf_add_frame_fde 3 ,
 106 .Xr dwarf_add_frame_fde_b 3 ,
 107 .Xr dwarf_fde_cfa_offset 3 ,
 108 .Xr dwarf_new_fde 3
 109 .Rs
 110 .%T "The DWARF Debugging Information Format"
 111 .%V "Version 4"
 112 .%O "http://www.dwarfstd.org/"
 113 .Re