external/bsd/elftoolchain/dist/libdwarf/dwarf_add_fde_inst.3

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