1*0a6a1f1dSLionel Sambuc.\" $NetBSD: dwarf_get_fde_n.3,v 1.2 2014/03/09 16:58:04 christos Exp $ 2*0a6a1f1dSLionel Sambuc.\" 3*0a6a1f1dSLionel Sambuc.\" Copyright (c) 2011 Kai Wang 4*0a6a1f1dSLionel Sambuc.\" All rights reserved. 5*0a6a1f1dSLionel Sambuc.\" 6*0a6a1f1dSLionel Sambuc.\" Redistribution and use in source and binary forms, with or without 7*0a6a1f1dSLionel Sambuc.\" modification, are permitted provided that the following conditions 8*0a6a1f1dSLionel Sambuc.\" are met: 9*0a6a1f1dSLionel Sambuc.\" 1. Redistributions of source code must retain the above copyright 10*0a6a1f1dSLionel Sambuc.\" notice, this list of conditions and the following disclaimer. 11*0a6a1f1dSLionel Sambuc.\" 2. Redistributions in binary form must reproduce the above copyright 12*0a6a1f1dSLionel Sambuc.\" notice, this list of conditions and the following disclaimer in the 13*0a6a1f1dSLionel Sambuc.\" documentation and/or other materials provided with the distribution. 14*0a6a1f1dSLionel Sambuc.\" 15*0a6a1f1dSLionel Sambuc.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16*0a6a1f1dSLionel Sambuc.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17*0a6a1f1dSLionel Sambuc.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18*0a6a1f1dSLionel Sambuc.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19*0a6a1f1dSLionel Sambuc.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20*0a6a1f1dSLionel Sambuc.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21*0a6a1f1dSLionel Sambuc.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22*0a6a1f1dSLionel Sambuc.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23*0a6a1f1dSLionel Sambuc.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24*0a6a1f1dSLionel Sambuc.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25*0a6a1f1dSLionel Sambuc.\" SUCH DAMAGE. 26*0a6a1f1dSLionel Sambuc.\" 27*0a6a1f1dSLionel Sambuc.\" Id: dwarf_get_fde_n.3 2071 2011-10-27 03:20:00Z jkoshy 28*0a6a1f1dSLionel Sambuc.\" 29*0a6a1f1dSLionel Sambuc.Dd May 14, 2011 30*0a6a1f1dSLionel Sambuc.Os 31*0a6a1f1dSLionel Sambuc.Dt DWARF_GET_FDE_N 3 32*0a6a1f1dSLionel Sambuc.Sh NAME 33*0a6a1f1dSLionel Sambuc.Nm dwarf_get_fde_n 34*0a6a1f1dSLionel Sambuc.Nd retrieve FDE descriptor 35*0a6a1f1dSLionel Sambuc.Sh LIBRARY 36*0a6a1f1dSLionel Sambuc.Lb libdwarf 37*0a6a1f1dSLionel Sambuc.Sh SYNOPSIS 38*0a6a1f1dSLionel Sambuc.In libdwarf.h 39*0a6a1f1dSLionel Sambuc.Ft int 40*0a6a1f1dSLionel Sambuc.Fo dwarf_get_fde_n 41*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Fde *fdelist" 42*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Unsigned fde_index" 43*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Fde *ret_fde" 44*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Error *err" 45*0a6a1f1dSLionel Sambuc.Fc 46*0a6a1f1dSLionel Sambuc.Sh DESCRIPTION 47*0a6a1f1dSLionel SambucFunction 48*0a6a1f1dSLionel Sambuc.Fn dwarf_get_fde_n 49*0a6a1f1dSLionel Sambucretrieves an FDE descriptor from an array of FDE descriptors. 50*0a6a1f1dSLionel Sambuc.Pp 51*0a6a1f1dSLionel SambucArgument 52*0a6a1f1dSLionel Sambuc.Ar fdelist 53*0a6a1f1dSLionel Sambucshould point to an array of FDE descriptors, as returned by the functions 54*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_list 3 55*0a6a1f1dSLionel Sambucor 56*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_list_eh 3 . 57*0a6a1f1dSLionel Sambuc.Pp 58*0a6a1f1dSLionel SambucArgument 59*0a6a1f1dSLionel Sambuc.Ar fde_index 60*0a6a1f1dSLionel Sambucspecifies the 0-based index of the desired FDE descriptor. 61*0a6a1f1dSLionel Sambuc.Pp 62*0a6a1f1dSLionel SambucArgument 63*0a6a1f1dSLionel Sambuc.Ar ret_fde 64*0a6a1f1dSLionel Sambucshould point to a location that will hold the returned FDE descriptor. 65*0a6a1f1dSLionel Sambuc.Pp 66*0a6a1f1dSLionel SambucIf argument 67*0a6a1f1dSLionel Sambuc.Ar err 68*0a6a1f1dSLionel Sambucis not NULL, it will be used to store error information in case of an 69*0a6a1f1dSLionel Sambucerror. 70*0a6a1f1dSLionel Sambuc.Sh RETURN VALUES 71*0a6a1f1dSLionel SambucFunction 72*0a6a1f1dSLionel Sambuc.Fn dwarf_get_fde_n 73*0a6a1f1dSLionel Sambucreturns 74*0a6a1f1dSLionel Sambuc.Dv DW_DLV_OK 75*0a6a1f1dSLionel Sambucwhen it succeeds. 76*0a6a1f1dSLionel SambucIt returns 77*0a6a1f1dSLionel Sambuc.Dv DW_DLV_NO_ENTRY 78*0a6a1f1dSLionel Sambucif the FDE descriptor index specified by argument 79*0a6a1f1dSLionel Sambuc.Ar fde_index 80*0a6a1f1dSLionel Sambucis out of range. 81*0a6a1f1dSLionel SambucIn case of an error, it returns 82*0a6a1f1dSLionel Sambuc.Dv DW_DLV_ERROR 83*0a6a1f1dSLionel Sambucand sets the argument 84*0a6a1f1dSLionel Sambuc.Ar err . 85*0a6a1f1dSLionel Sambuc.Sh ERRORS 86*0a6a1f1dSLionel SambucFunction 87*0a6a1f1dSLionel Sambuc.Fn dwarf_get_fde_n 88*0a6a1f1dSLionel Sambuccan fail with: 89*0a6a1f1dSLionel Sambuc.Bl -tag -width ".Bq Er DW_DLE_NO_ENTRY" 90*0a6a1f1dSLionel Sambuc.It Bq Er DW_DLE_ARGUMENT 91*0a6a1f1dSLionel SambucEither of the arguments 92*0a6a1f1dSLionel Sambuc.Ar fdelist 93*0a6a1f1dSLionel Sambucor 94*0a6a1f1dSLionel Sambuc.Ar ret_fde 95*0a6a1f1dSLionel Sambucwas NULL. 96*0a6a1f1dSLionel Sambuc.It Bq Er DW_DLE_NO_ENTRY 97*0a6a1f1dSLionel SambucThe FDE descriptor index specified by argument 98*0a6a1f1dSLionel Sambuc.Ar fde_index 99*0a6a1f1dSLionel Sambucwas out of range. 100*0a6a1f1dSLionel Sambuc.El 101*0a6a1f1dSLionel Sambuc.Sh SEE ALSO 102*0a6a1f1dSLionel Sambuc.Xr dwarf 3 , 103*0a6a1f1dSLionel Sambuc.Xr dwarf_get_cie_of_fde 3 , 104*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_at_pc 3 , 105*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_info_for_all_regs 3 , 106*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_info_for_all_regs3 3 , 107*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_info_for_cfa_reg3 3 , 108*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_info_for_reg 3 , 109*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_info_for_reg3 3 , 110*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_instr_bytes 3 , 111*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_list 3 , 112*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_list_eh 3 , 113*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_range 3 114