1.\" Copyright (c) 2011 Kai Wang 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $Id: dwarf_get_fde_at_pc.3 2071 2011-10-27 03:20:00Z jkoshy $ 26.\" 27.Dd May 22, 2011 28.Os 29.Dt DWARF_GET_FDE_AT_PC 3 30.Sh NAME 31.Nm dwarf_get_fde_at_pc 32.Nd retrieve the FDE descriptor for an address 33.Sh LIBRARY 34.Lb libdwarf 35.Sh SYNOPSIS 36.In libdwarf.h 37.Ft int 38.Fo dwarf_get_fde_at_pc 39.Fa "Dwarf_Fde *fdelist" 40.Fa "Dwarf_Addr pc" 41.Fa "Dwarf_Fde *ret_fde" 42.Fa "Dwarf_Addr *lopc" 43.Fa "Dwarf_Addr *hipc" 44.Fa "Dwarf_Error *err" 45.Fc 46.Sh DESCRIPTION 47Function 48.Fn dwarf_get_fde_at_pc 49searches the provided array of DWARF FDE descriptors for a descriptor 50covering a given program counter address. 51.Pp 52Argument 53.Ar fdelist 54should point to an array of FDE descriptors, as returned by the functions 55.Xr dwarf_get_fde_list 3 56or 57.Xr dwarf_get_fde_list_eh 3 . 58.Pp 59Argument 60.Ar pc 61should contain the program counter address being looked up. 62.Pp 63Argument 64.Ar ret_fde 65should point to a location that will hold the returned FDE descriptor. 66.Pp 67Argument 68.Ar lopc 69should point to a location that will be set to the lowest address 70covered by the returned FDE descriptor. 71.Pp 72Argument 73.Ar hipc 74should point to a location that will be set to the highest address 75covered by the returned FDE descriptor. 76.Pp 77If argument 78.Ar err 79is not NULL, it will be used to store error information in case of an 80error. 81.Sh RETURN VALUES 82Function 83.Fn dwarf_get_fde_at_pc 84returns 85.Dv DW_DLV_OK 86when it succeeds. 87It returns 88.Dv DW_DLV_NO_ENTRY 89if a FDE descriptor that covers the address specified by argument 90.Ar pc 91is not found. 92In case of an error, it returns 93.Dv DW_DLV_ERROR 94and sets the argument 95.Ar err . 96.Sh ERRORS 97Function 98.Fn dwarf_get_fde_at_pc 99can fail with: 100.Bl -tag -width ".Bq Er DW_DLE_NO_ENTRY" 101.It Bq Er DW_DLE_ARGUMENT 102One of the arguments 103.Va fdelist , 104.Va ret_fde , 105.Va lopc , 106or 107.Va hipc 108was NULL. 109.It Bq Er DW_DLE_NO_ENTRY 110These was no FDE descriptor covering the address specified by argument 111.Ar pc . 112.El 113.Sh SEE ALSO 114.Xr dwarf 3 , 115.Xr dwarf_get_cie_of_fde 3 , 116.Xr dwarf_get_fde_info_for_all_regs 3 , 117.Xr dwarf_get_fde_info_for_all_regs3 3 , 118.Xr dwarf_get_fde_info_for_cfa_reg3 3 , 119.Xr dwarf_get_fde_info_for_reg 3 , 120.Xr dwarf_get_fde_info_for_reg3 3 , 121.Xr dwarf_get_fde_instr_bytes 3 , 122.Xr dwarf_get_fde_list 3 , 123.Xr dwarf_get_fde_list_eh 3 , 124.Xr dwarf_get_fde_n 3 , 125.Xr dwarf_get_fde_range 3 126