1.\" $NetBSD: dwarf_get_fde_range.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_range.3 3962 2022-03-12 15:56:10Z jkoshy 28.\" 29.Dd May 22, 2011 30.Dt DWARF_GET_FDE_RANGE 3 31.Os 32.Sh NAME 33.Nm dwarf_get_fde_range 34.Nd retrieve range information from an FDE descriptor 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft int 40.Fo dwarf_get_fde_range 41.Fa "Dwarf_Fde fde" 42.Fa "Dwarf_Addr *low_pc" 43.Fa "Dwarf_Unsigned *func_len" 44.Fa "Dwarf_Ptr *fde_bytes" 45.Fa "Dwarf_Unsigned *fde_byte_len" 46.Fa "Dwarf_Off *cie_offset" 47.Fa "Dwarf_Signed *cie_index" 48.Fa "Dwarf_Off *fde_offset" 49.Fa "Dwarf_Error *err" 50.Fc 51.Sh DESCRIPTION 52Function 53.Fn dwarf_get_fde_range 54retrieves range and offset information from a given FDE descriptor. 55.Pp 56Argument 57.Fa fde 58should reference a valid DWARF FDE descriptor. 59.Pp 60Argument 61.Fa low_pc 62should point to a location that will be set to the lowest 63program counter address covered by the FDE descriptor. 64.Pp 65Argument 66.Fa func_len 67should point to a location that will hold the length in bytes of 68the address range covered by the FDE descriptor. 69.Pp 70Argument 71.Fa fde_bytes 72should point to a location that will be set to a pointer to the 73content of the FDE descriptor itself. 74.Pp 75Argument 76.Fa fde_byte_len 77should point to a location that will hold the length in bytes of 78the FDE descriptor itself. 79.Pp 80Argument 81.Fa cie_offset 82should point to a location that will be set to the offset, relative to 83the DWARF 84.Dq ".debug_frame" 85section, of the CIE descriptor associated with the given FDE 86descriptor. 87.Pp 88Argument 89.Fa cie_index 90should point to a location that will hold the index of the CIE 91descriptor associated with the FDE descriptor. 92The returned value is a zero-based index into the array of CIE 93descriptors returned by a prior call to functions 94.Xr dwarf_get_fde_list 3 95or 96.Xr dwarf_get_fde_list_eh 3 . 97.Pp 98Argument 99.Fa fde_offset 100should point to a location that will be set to the offset, relative to 101the DWARF 102.Dq ".debug_frame" 103section, of the FDE descriptor. 104.Pp 105If argument 106.Fa err 107is not 108.Dv NULL , 109it will be used to store error information in case of an error. 110.Sh RETURN VALUES 111Function 112.Fn dwarf_get_fde_range 113returns 114.Dv DW_DLV_OK 115when it succeeds. 116In case of an error, it returns 117.Dv DW_DLV_ERROR 118and sets the argument 119.Fa err . 120.Sh ERRORS 121Function 122.Fn dwarf_get_fde_range 123can fail with: 124.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 125.It Bq Er DW_DLE_ARGUMENT 126One of the arguments 127.Fa fde , 128.Fa low_pc , 129.Fa func_len , 130.Fa fde_bytes , 131.Fa fde_byte_len , 132.Fa cie_offset , 133.Fa cie_index 134or 135.Fa fde_offset 136was 137.Dv NULL . 138.El 139.Sh SEE ALSO 140.Xr dwarf 3 , 141.Xr dwarf_get_cie_index 3 , 142.Xr dwarf_get_cie_info 3 , 143.Xr dwarf_get_cie_of_fde 3 , 144.Xr dwarf_get_fde_at_pc 3 , 145.Xr dwarf_get_fde_info_for_all_regs 3 , 146.Xr dwarf_get_fde_info_for_all_regs3 3 , 147.Xr dwarf_get_fde_info_for_cfa_reg3 3 , 148.Xr dwarf_get_fde_info_for_reg 3 , 149.Xr dwarf_get_fde_info_for_reg3 3 , 150.Xr dwarf_get_fde_instr_bytes 3 , 151.Xr dwarf_get_fde_list 3 , 152.Xr dwarf_get_fde_list_eh 3 , 153.Xr dwarf_get_fde_n 3 154