1*0a6a1f1dSLionel Sambuc.\" $NetBSD: dwarf_get_fde_range.3,v 1.2 2014/03/09 16:58:04 christos Exp $ 2*0a6a1f1dSLionel Sambuc.\" 3*0a6a1f1dSLionel Sambuc.\" Copyright (c) 2011 Kai Wang 4*0a6a1f1dSLionel Sambuc.\" All rights reserved. 5*0a6a1f1dSLionel Sambuc.\" 6*0a6a1f1dSLionel Sambuc.\" Redistribution and use in source and binary forms, with or without 7*0a6a1f1dSLionel Sambuc.\" modification, are permitted provided that the following conditions 8*0a6a1f1dSLionel Sambuc.\" are met: 9*0a6a1f1dSLionel Sambuc.\" 1. Redistributions of source code must retain the above copyright 10*0a6a1f1dSLionel Sambuc.\" notice, this list of conditions and the following disclaimer. 11*0a6a1f1dSLionel Sambuc.\" 2. Redistributions in binary form must reproduce the above copyright 12*0a6a1f1dSLionel Sambuc.\" notice, this list of conditions and the following disclaimer in the 13*0a6a1f1dSLionel Sambuc.\" documentation and/or other materials provided with the distribution. 14*0a6a1f1dSLionel Sambuc.\" 15*0a6a1f1dSLionel Sambuc.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16*0a6a1f1dSLionel Sambuc.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17*0a6a1f1dSLionel Sambuc.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18*0a6a1f1dSLionel Sambuc.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19*0a6a1f1dSLionel Sambuc.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20*0a6a1f1dSLionel Sambuc.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21*0a6a1f1dSLionel Sambuc.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22*0a6a1f1dSLionel Sambuc.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23*0a6a1f1dSLionel Sambuc.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24*0a6a1f1dSLionel Sambuc.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25*0a6a1f1dSLionel Sambuc.\" SUCH DAMAGE. 26*0a6a1f1dSLionel Sambuc.\" 27*0a6a1f1dSLionel Sambuc.\" Id: dwarf_get_fde_range.3 2071 2011-10-27 03:20:00Z jkoshy 28*0a6a1f1dSLionel Sambuc.\" 29*0a6a1f1dSLionel Sambuc.Dd May 22, 2011 30*0a6a1f1dSLionel Sambuc.Os 31*0a6a1f1dSLionel Sambuc.Dt DWARF_GET_FDE_RANGE 3 32*0a6a1f1dSLionel Sambuc.Sh NAME 33*0a6a1f1dSLionel Sambuc.Nm dwarf_get_fde_range 34*0a6a1f1dSLionel Sambuc.Nd retrieve range information from an FDE descriptor 35*0a6a1f1dSLionel Sambuc.Sh LIBRARY 36*0a6a1f1dSLionel Sambuc.Lb libdwarf 37*0a6a1f1dSLionel Sambuc.Sh SYNOPSIS 38*0a6a1f1dSLionel Sambuc.In libdwarf.h 39*0a6a1f1dSLionel Sambuc.Ft int 40*0a6a1f1dSLionel Sambuc.Fo dwarf_get_fde_range 41*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Fde fde" 42*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Addr *low_pc" 43*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Unsigned *func_len" 44*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Ptr *fde_bytes" 45*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Unsigned *fde_byte_len" 46*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Off *cie_offset" 47*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Signed *cie_index" 48*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Off *fde_offset" 49*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Error *err" 50*0a6a1f1dSLionel Sambuc.Fc 51*0a6a1f1dSLionel Sambuc.Sh DESCRIPTION 52*0a6a1f1dSLionel SambucFunction 53*0a6a1f1dSLionel Sambuc.Fn dwarf_get_fde_range 54*0a6a1f1dSLionel Sambucretrieves range and offset information from a given FDE descriptor. 55*0a6a1f1dSLionel Sambuc.Pp 56*0a6a1f1dSLionel SambucArgument 57*0a6a1f1dSLionel Sambuc.Ar fde 58*0a6a1f1dSLionel Sambucshould reference a valid DWARF FDE descriptor. 59*0a6a1f1dSLionel Sambuc.Pp 60*0a6a1f1dSLionel SambucArgument 61*0a6a1f1dSLionel Sambuc.Ar low_pc 62*0a6a1f1dSLionel Sambucshould point to a location that will be set to the lowest 63*0a6a1f1dSLionel Sambucprogram counter address covered by the FDE descriptor. 64*0a6a1f1dSLionel Sambuc.Pp 65*0a6a1f1dSLionel SambucArgument 66*0a6a1f1dSLionel Sambuc.Ar func_len 67*0a6a1f1dSLionel Sambucshould point to a location that will hold the length in bytes of 68*0a6a1f1dSLionel Sambucthe address range covered by the FDE descriptor. 69*0a6a1f1dSLionel Sambuc.Pp 70*0a6a1f1dSLionel SambucArgument 71*0a6a1f1dSLionel Sambuc.Ar fde_bytes 72*0a6a1f1dSLionel Sambucshould point to a location that will be set to a pointer to the 73*0a6a1f1dSLionel Sambuccontent of the FDE descriptor itself. 74*0a6a1f1dSLionel Sambuc.Pp 75*0a6a1f1dSLionel SambucArgument 76*0a6a1f1dSLionel Sambuc.Ar fde_byte_len 77*0a6a1f1dSLionel Sambucshould point to a location that will hold the length in bytes of 78*0a6a1f1dSLionel Sambucthe FDE descriptor itself. 79*0a6a1f1dSLionel Sambuc.Pp 80*0a6a1f1dSLionel SambucArgument 81*0a6a1f1dSLionel Sambuc.Ar cie_offset 82*0a6a1f1dSLionel Sambucshould point to a location that will be set to the offset, relative to 83*0a6a1f1dSLionel Sambucthe DWARF 84*0a6a1f1dSLionel Sambuc.Dq ".debug_frame" 85*0a6a1f1dSLionel Sambucsection, of the CIE descriptor associated with the given FDE 86*0a6a1f1dSLionel Sambucdescriptor. 87*0a6a1f1dSLionel Sambuc.Pp 88*0a6a1f1dSLionel SambucArgument 89*0a6a1f1dSLionel Sambuc.Ar cie_index 90*0a6a1f1dSLionel Sambucshould point to a location that will hold the index of the CIE 91*0a6a1f1dSLionel Sambucdescriptor associated with the FDE descriptor. 92*0a6a1f1dSLionel SambucThe returned value is a zero-based index into the array of CIE 93*0a6a1f1dSLionel Sambucdescriptors returned by a prior call to functions 94*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_list 3 95*0a6a1f1dSLionel Sambucor 96*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_list_eh 3 . 97*0a6a1f1dSLionel Sambuc.Pp 98*0a6a1f1dSLionel SambucArgument 99*0a6a1f1dSLionel Sambuc.Ar fde_offset 100*0a6a1f1dSLionel Sambucshould point to a location that will be set to the offset, relative to 101*0a6a1f1dSLionel Sambucthe DWARF 102*0a6a1f1dSLionel Sambuc.Dq ".debug_frame" 103*0a6a1f1dSLionel Sambucsection, of the FDE descriptor. 104*0a6a1f1dSLionel Sambuc.Pp 105*0a6a1f1dSLionel SambucIf argument 106*0a6a1f1dSLionel Sambuc.Ar err 107*0a6a1f1dSLionel Sambucis not NULL, it will be used to store error information in case of an 108*0a6a1f1dSLionel Sambucerror. 109*0a6a1f1dSLionel Sambuc.Sh RETURN VALUES 110*0a6a1f1dSLionel SambucFunction 111*0a6a1f1dSLionel Sambuc.Fn dwarf_get_fde_range 112*0a6a1f1dSLionel Sambucreturns 113*0a6a1f1dSLionel Sambuc.Dv DW_DLV_OK 114*0a6a1f1dSLionel Sambucwhen it succeeds. 115*0a6a1f1dSLionel SambucIn case of an error, it returns 116*0a6a1f1dSLionel Sambuc.Dv DW_DLV_ERROR 117*0a6a1f1dSLionel Sambucand sets the argument 118*0a6a1f1dSLionel Sambuc.Ar err . 119*0a6a1f1dSLionel Sambuc.Sh ERRORS 120*0a6a1f1dSLionel SambucFunction 121*0a6a1f1dSLionel Sambuc.Fn dwarf_get_fde_range 122*0a6a1f1dSLionel Sambuccan fail with: 123*0a6a1f1dSLionel Sambuc.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 124*0a6a1f1dSLionel Sambuc.It Bq Er DW_DLE_ARGUMENT 125*0a6a1f1dSLionel SambucOne of the arguments 126*0a6a1f1dSLionel Sambuc.Ar fde , 127*0a6a1f1dSLionel Sambuc.Ar low_pc , 128*0a6a1f1dSLionel Sambuc.Ar func_len , 129*0a6a1f1dSLionel Sambuc.Ar fde_bytes , 130*0a6a1f1dSLionel Sambuc.Ar fde_byte_len , 131*0a6a1f1dSLionel Sambuc.Ar cie_offset , 132*0a6a1f1dSLionel Sambuc.Ar cie_index 133*0a6a1f1dSLionel Sambucor 134*0a6a1f1dSLionel Sambuc.Ar fde_offset 135*0a6a1f1dSLionel Sambucwas NULL. 136*0a6a1f1dSLionel Sambuc.El 137*0a6a1f1dSLionel Sambuc.Sh SEE ALSO 138*0a6a1f1dSLionel Sambuc.Xr dwarf 3 , 139*0a6a1f1dSLionel Sambuc.Xr dwarf_get_cie_info 3 , 140*0a6a1f1dSLionel Sambuc.Xr dwarf_get_cie_index 3 , 141*0a6a1f1dSLionel Sambuc.Xr dwarf_get_cie_of_fde , 142*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_at_pc 3 , 143*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_info_for_all_regs 3 , 144*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_info_for_all_regs3 3 , 145*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_info_for_cfa_reg3 3 , 146*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_info_for_reg 3 , 147*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_info_for_reg3 3 , 148*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_instr_bytes 3 , 149*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_list 3 , 150*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_list_eh 3 , 151*0a6a1f1dSLionel Sambuc.Xr dwarf_get_fde_n 3 152