.\" 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_at_pc.3 2071 2011-10-27 03:20:00Z jkoshy $
.\"
.Dd May 22, 2011
.Os
.Dt DWARF_GET_FDE_AT_PC 3
.Sh NAME
.Nm dwarf_get_fde_at_pc
.Nd retrieve the FDE descriptor for an address
.Sh LIBRARY
.Lb libdwarf
.Sh SYNOPSIS
.In libdwarf.h
.Ft int
.Fo dwarf_get_fde_at_pc
.Fa "Dwarf_Fde *fdelist"
.Fa "Dwarf_Addr pc"
.Fa "Dwarf_Fde *ret_fde"
.Fa "Dwarf_Addr *lopc"
.Fa "Dwarf_Addr *hipc"
.Fa "Dwarf_Error *err"
.Fc
.Sh DESCRIPTION
Function
.Fn dwarf_get_fde_at_pc
searches the provided array of DWARF FDE descriptors for a descriptor
covering a given program counter address.
.Pp
Argument
.Ar 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
.Ar pc
should contain the program counter address being looked up.
.Pp
Argument
.Ar ret_fde
should point to a location that will hold the returned FDE descriptor.
.Pp
Argument
.Ar lopc
should point to a location that will be set to the lowest address
covered by the returned FDE descriptor.
.Pp
Argument
.Ar hipc
should point to a location that will be set to the highest address
covered by the returned FDE descriptor.
.Pp
If argument
.Ar err
is not NULL, it will be used to store error information in case of an
error.
.Sh RETURN VALUES
Function
.Fn dwarf_get_fde_at_pc
returns
.Dv DW_DLV_OK
when it succeeds.
It returns
.Dv DW_DLV_NO_ENTRY
if a FDE descriptor that covers the address specified by argument
.Ar pc
is not found.
In case of an error, it returns
.Dv DW_DLV_ERROR
and sets the argument
.Ar err .
.Sh ERRORS
Function
.Fn dwarf_get_fde_at_pc
can fail with:
.Bl -tag -width ".Bq Er DW_DLE_NO_ENTRY"
.It Bq Er DW_DLE_ARGUMENT
One of the arguments
.Va fdelist ,
.Va ret_fde ,
.Va lopc ,
or
.Va hipc
was NULL.
.It Bq Er DW_DLE_NO_ENTRY
These was no FDE descriptor covering the address specified by argument
.Ar pc .
.El
.Sh SEE ALSO
.Xr dwarf 3 ,
.Xr dwarf_get_cie_of_fde 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_n 3 ,
.Xr dwarf_get_fde_range 3