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

   1 .\"     $NetBSD: dwarf_get_fde_range.3,v 1.2 2014/03/09 16:58:04 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_get_fde_range.3 2071 2011-10-27 03:20:00Z jkoshy
  28 .\"
  29 .Dd May 22, 2011
  30 .Os
  31 .Dt DWARF_GET_FDE_RANGE 3
  32 .Sh NAME
  33 .Nm dwarf_get_fde_range
  34 .Nd retrieve range information from an FDE descriptor
  35 .Sh LIBRARY
  36 .Lb libdwarf
  37 .Sh SYNOPSIS
  38 .In libdwarf.h
  39 .Ft int
  40 .Fo dwarf_get_fde_range
  41 .Fa "Dwarf_Fde fde"
  42 .Fa "Dwarf_Addr *low_pc"
  43 .Fa "Dwarf_Unsigned *func_len"
  44 .Fa "Dwarf_Ptr *fde_bytes"
  45 .Fa "Dwarf_Unsigned *fde_byte_len"
  46 .Fa "Dwarf_Off *cie_offset"
  47 .Fa "Dwarf_Signed *cie_index"
  48 .Fa "Dwarf_Off *fde_offset"
  49 .Fa "Dwarf_Error *err"
  50 .Fc
  51 .Sh DESCRIPTION
  52 Function
  53 .Fn dwarf_get_fde_range
  54 retrieves range and offset information from a given FDE descriptor.
  55 .Pp
  56 Argument
  57 .Ar fde
  58 should reference a valid DWARF FDE descriptor.
  59 .Pp
  60 Argument
  61 .Ar low_pc
  62 should point to a location that will be set to the lowest
  63 program counter address covered by the FDE descriptor.
  64 .Pp
  65 Argument
  66 .Ar func_len
  67 should point to a location that will hold the length in bytes of
  68 the address range covered by the FDE descriptor.
  69 .Pp
  70 Argument
  71 .Ar fde_bytes
  72 should point to a location that will be set to a pointer to the
  73 content of the FDE descriptor itself.
  74 .Pp
  75 Argument
  76 .Ar fde_byte_len
  77 should point to a location that will hold the length in bytes of
  78 the FDE descriptor itself.
  79 .Pp
  80 Argument
  81 .Ar cie_offset
  82 should point to a location that will be set to the offset, relative to
  83 the DWARF
  84 .Dq ".debug_frame"
  85 section, of the CIE descriptor associated with the given FDE
  86 descriptor.
  87 .Pp
  88 Argument
  89 .Ar cie_index
  90 should point to a location that will hold the index of the CIE
  91 descriptor associated with the FDE descriptor.
  92 The returned value is a zero-based index into the array of CIE
  93 descriptors returned by a prior call to functions
  94 .Xr dwarf_get_fde_list 3
  95 or
  96 .Xr dwarf_get_fde_list_eh 3 .
  97 .Pp
  98 Argument
  99 .Ar fde_offset
 100 should point to a location that will be set to the offset, relative to
 101 the DWARF
 102 .Dq ".debug_frame"
 103 section, of the FDE descriptor.
 104 .Pp
 105 If argument
 106 .Ar err
 107 is not NULL, it will be used to store error information in case of an
 108 error.
 109 .Sh RETURN VALUES
 110 Function
 111 .Fn dwarf_get_fde_range
 112 returns
 113 .Dv DW_DLV_OK
 114 when it succeeds.
 115 In case of an error, it returns
 116 .Dv DW_DLV_ERROR
 117 and sets the argument
 118 .Ar err .
 119 .Sh ERRORS
 120 Function
 121 .Fn dwarf_get_fde_range
 122 can fail with:
 123 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
 124 .It Bq Er DW_DLE_ARGUMENT
 125 One of the arguments
 126 .Ar fde ,
 127 .Ar low_pc ,
 128 .Ar func_len ,
 129 .Ar fde_bytes ,
 130 .Ar fde_byte_len ,
 131 .Ar cie_offset ,
 132 .Ar cie_index
 133 or
 134 .Ar fde_offset
 135 was NULL.
 136 .El
 137 .Sh SEE ALSO
 138 .Xr dwarf 3 ,
 139 .Xr dwarf_get_cie_info 3 ,
 140 .Xr dwarf_get_cie_index 3 ,
 141 .Xr dwarf_get_cie_of_fde ,
 142 .Xr dwarf_get_fde_at_pc 3 ,
 143 .Xr dwarf_get_fde_info_for_all_regs 3 ,
 144 .Xr dwarf_get_fde_info_for_all_regs3 3 ,
 145 .Xr dwarf_get_fde_info_for_cfa_reg3 3 ,
 146 .Xr dwarf_get_fde_info_for_reg 3 ,
 147 .Xr dwarf_get_fde_info_for_reg3 3 ,
 148 .Xr dwarf_get_fde_instr_bytes 3 ,
 149 .Xr dwarf_get_fde_list 3 ,
 150 .Xr dwarf_get_fde_list_eh 3 ,
 151 .Xr dwarf_get_fde_n 3