1.\" $NetBSD: dwarf_get_fde_at_pc.3,v 1.6 2024/03/03 17:37:31 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_at_pc.3 3962 2022-03-12 15:56:10Z jkoshy 28.\" 29.Dd May 22, 2011 30.Dt DWARF_GET_FDE_AT_PC 3 31.Os 32.Sh NAME 33.Nm dwarf_get_fde_at_pc 34.Nd retrieve the FDE descriptor for an address 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft int 40.Fo dwarf_get_fde_at_pc 41.Fa "Dwarf_Fde *fdelist" 42.Fa "Dwarf_Addr pc" 43.Fa "Dwarf_Fde *ret_fde" 44.Fa "Dwarf_Addr *lopc" 45.Fa "Dwarf_Addr *hipc" 46.Fa "Dwarf_Error *err" 47.Fc 48.Sh DESCRIPTION 49Function 50.Fn dwarf_get_fde_at_pc 51searches the provided array of DWARF FDE descriptors for a descriptor 52covering a given program counter address. 53.Pp 54Argument 55.Fa fdelist 56should point to an array of FDE descriptors, as returned by the functions 57.Xr dwarf_get_fde_list 3 58or 59.Xr dwarf_get_fde_list_eh 3 . 60.Pp 61Argument 62.Fa pc 63should contain the program counter address being looked up. 64.Pp 65Argument 66.Fa ret_fde 67should point to a location that will hold the returned FDE descriptor. 68.Pp 69Argument 70.Fa lopc 71should point to a location that will be set to the lowest address 72covered by the returned FDE descriptor. 73.Pp 74Argument 75.Fa hipc 76should point to a location that will be set to the highest address 77covered by the returned FDE descriptor. 78.Pp 79If argument 80.Fa err 81is not 82.Dv NULL , 83it will be used to store error information in case of an error. 84.Sh RETURN VALUES 85Function 86.Fn dwarf_get_fde_at_pc 87returns 88.Dv DW_DLV_OK 89when it succeeds. 90It returns 91.Dv DW_DLV_NO_ENTRY 92if a FDE descriptor that covers the address specified by argument 93.Fa pc 94is not found. 95In case of an error, it returns 96.Dv DW_DLV_ERROR 97and sets the argument 98.Fa err . 99.Sh ERRORS 100Function 101.Fn dwarf_get_fde_at_pc 102can fail with: 103.Bl -tag -width ".Bq Er DW_DLE_NO_ENTRY" 104.It Bq Er DW_DLE_ARGUMENT 105One of the arguments 106.Va fdelist , 107.Va ret_fde , 108.Va lopc , 109or 110.Va hipc 111was 112.Dv NULL . 113.It Bq Er DW_DLE_NO_ENTRY 114These was no FDE descriptor covering the address specified by argument 115.Fa pc . 116.El 117.Sh SEE ALSO 118.Xr dwarf 3 , 119.Xr dwarf_get_cie_of_fde 3 , 120.Xr dwarf_get_fde_info_for_all_regs 3 , 121.Xr dwarf_get_fde_info_for_all_regs3 3 , 122.Xr dwarf_get_fde_info_for_cfa_reg3 3 , 123.Xr dwarf_get_fde_info_for_reg 3 , 124.Xr dwarf_get_fde_info_for_reg3 3 , 125.Xr dwarf_get_fde_instr_bytes 3 , 126.Xr dwarf_get_fde_list 3 , 127.Xr dwarf_get_fde_list_eh 3 , 128.Xr dwarf_get_fde_n 3 , 129.Xr dwarf_get_fde_range 3 130