xref: /netbsd-src/external/bsd/elftoolchain/dist/libdwarf/dwarf_get_fde_n.3 (revision 5ac3bc719ce6e70593039505b491894133237d12)

.\"	$NetBSD: dwarf_get_fde_n.3,v 1.6 2024/03/03 17:37:31 christos Exp $
.\"
.\" Copyright (c) 2011 Kai Wang
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" Id: dwarf_get_fde_n.3 3962 2022-03-12 15:56:10Z jkoshy
.\"
.Dd May 14, 2011
.Dt DWARF_GET_FDE_N 3
.Os
.Sh NAME
.Nm dwarf_get_fde_n
.Nd retrieve FDE descriptor
.Sh LIBRARY
.Lb libdwarf
.Sh SYNOPSIS
.In libdwarf.h
.Ft int
.Fo dwarf_get_fde_n
.Fa "Dwarf_Fde *fdelist"
.Fa "Dwarf_Unsigned fde_index"
.Fa "Dwarf_Fde *ret_fde"
.Fa "Dwarf_Error *err"
.Fc
.Sh DESCRIPTION
Function
.Fn dwarf_get_fde_n
retrieves an FDE descriptor from an array of FDE descriptors.
.Pp
Argument
.Fa fdelist
should point to an array of FDE descriptors, as returned by the functions
.Xr dwarf_get_fde_list 3
or
.Xr dwarf_get_fde_list_eh 3 .
.Pp
Argument
.Fa fde_index
specifies the 0-based index of the desired FDE descriptor.
.Pp
Argument
.Fa ret_fde
should point to a location that will hold the returned FDE descriptor.
.Pp
If argument
.Fa err
is not
.Dv NULL ,
it will be used to store error information in case of an error.
.Sh RETURN VALUES
Function
.Fn dwarf_get_fde_n
returns
.Dv DW_DLV_OK
when it succeeds.
It returns
.Dv DW_DLV_NO_ENTRY
if the FDE descriptor index specified by argument
.Fa fde_index
is out of range.
In case of an error, it returns
.Dv DW_DLV_ERROR
and sets the argument
.Fa err .
.Sh ERRORS
Function
.Fn dwarf_get_fde_n
can fail with:
.Bl -tag -width ".Bq Er DW_DLE_NO_ENTRY"
.It Bq Er DW_DLE_ARGUMENT
Either of the arguments
.Fa fdelist
or
.Fa ret_fde
was
.Dv NULL .
.It Bq Er DW_DLE_NO_ENTRY
The FDE descriptor index specified by argument
.Fa fde_index
was out of range.
.El
.Sh SEE ALSO
.Xr dwarf 3 ,
.Xr dwarf_get_cie_of_fde 3 ,
.Xr dwarf_get_fde_at_pc 3 ,
.Xr dwarf_get_fde_info_for_all_regs 3 ,
.Xr dwarf_get_fde_info_for_all_regs3 3 ,
.Xr dwarf_get_fde_info_for_cfa_reg3 3 ,
.Xr dwarf_get_fde_info_for_reg 3 ,
.Xr dwarf_get_fde_info_for_reg3 3 ,
.Xr dwarf_get_fde_instr_bytes 3 ,
.Xr dwarf_get_fde_list 3 ,
.Xr dwarf_get_fde_list_eh 3 ,
.Xr dwarf_get_fde_range 3