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

   1 .\"     $NetBSD: dwarf_get_fde_n.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_n.3 2071 2011-10-27 03:20:00Z jkoshy
  28 .\"
  29 .Dd May 14, 2011
  30 .Os
  31 .Dt DWARF_GET_FDE_N 3
  32 .Sh NAME
  33 .Nm dwarf_get_fde_n
  34 .Nd retrieve FDE descriptor
  35 .Sh LIBRARY
  36 .Lb libdwarf
  37 .Sh SYNOPSIS
  38 .In libdwarf.h
  39 .Ft int
  40 .Fo dwarf_get_fde_n
  41 .Fa "Dwarf_Fde *fdelist"
  42 .Fa "Dwarf_Unsigned fde_index"
  43 .Fa "Dwarf_Fde *ret_fde"
  44 .Fa "Dwarf_Error *err"
  45 .Fc
  46 .Sh DESCRIPTION
  47 Function
  48 .Fn dwarf_get_fde_n
  49 retrieves an FDE descriptor from an array of FDE descriptors.
  50 .Pp
  51 Argument
  52 .Ar fdelist
  53 should point to an array of FDE descriptors, as returned by the functions
  54 .Xr dwarf_get_fde_list 3
  55 or
  56 .Xr dwarf_get_fde_list_eh 3 .
  57 .Pp
  58 Argument
  59 .Ar fde_index
  60 specifies the 0-based index of the desired FDE descriptor.
  61 .Pp
  62 Argument
  63 .Ar ret_fde
  64 should point to a location that will hold the returned FDE descriptor.
  65 .Pp
  66 If argument
  67 .Ar err
  68 is not NULL, it will be used to store error information in case of an
  69 error.
  70 .Sh RETURN VALUES
  71 Function
  72 .Fn dwarf_get_fde_n
  73 returns
  74 .Dv DW_DLV_OK
  75 when it succeeds.
  76 It returns
  77 .Dv DW_DLV_NO_ENTRY
  78 if the FDE descriptor index specified by argument
  79 .Ar fde_index
  80 is out of range.
  81 In case of an error, it returns
  82 .Dv DW_DLV_ERROR
  83 and sets the argument
  84 .Ar err .
  85 .Sh ERRORS
  86 Function
  87 .Fn dwarf_get_fde_n
  88 can fail with:
  89 .Bl -tag -width ".Bq Er DW_DLE_NO_ENTRY"
  90 .It Bq Er DW_DLE_ARGUMENT
  91 Either of the arguments
  92 .Ar fdelist
  93 or
  94 .Ar ret_fde
  95 was NULL.
  96 .It Bq Er DW_DLE_NO_ENTRY
  97 The FDE descriptor index specified by argument
  98 .Ar fde_index
  99 was out of range.
 100 .El
 101 .Sh SEE ALSO
 102 .Xr dwarf 3 ,
 103 .Xr dwarf_get_cie_of_fde 3 ,
 104 .Xr dwarf_get_fde_at_pc 3 ,
 105 .Xr dwarf_get_fde_info_for_all_regs 3 ,
 106 .Xr dwarf_get_fde_info_for_all_regs3 3 ,
 107 .Xr dwarf_get_fde_info_for_cfa_reg3 3 ,
 108 .Xr dwarf_get_fde_info_for_reg 3 ,
 109 .Xr dwarf_get_fde_info_for_reg3 3 ,
 110 .Xr dwarf_get_fde_instr_bytes 3 ,
 111 .Xr dwarf_get_fde_list 3 ,
 112 .Xr dwarf_get_fde_list_eh 3 ,
 113 .Xr dwarf_get_fde_range 3