1*0a6a1f1dSLionel Sambuc.\" $NetBSD: dwarf_get_arange.3,v 1.2 2014/03/09 16:58:03 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_arange.3 2071 2011-10-27 03:20:00Z jkoshy 28*0a6a1f1dSLionel Sambuc.\" 29*0a6a1f1dSLionel Sambuc.Dd April 16, 2011 30*0a6a1f1dSLionel Sambuc.Os 31*0a6a1f1dSLionel Sambuc.Dt DWARF_GET_ARANGE 3 32*0a6a1f1dSLionel Sambuc.Sh NAME 33*0a6a1f1dSLionel Sambuc.Nm dwarf_get_arange 34*0a6a1f1dSLionel Sambuc.Nd retrieve the address range descriptor for an address 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_arange 41*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Arange *ar_list" 42*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Unsigned ar_cnt" 43*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Addr addr" 44*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Arange *ret_ar" 45*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Error *err" 46*0a6a1f1dSLionel Sambuc.Fc 47*0a6a1f1dSLionel Sambuc.Sh DESCRIPTION 48*0a6a1f1dSLionel SambucFunction 49*0a6a1f1dSLionel Sambuc.Fn dwarf_get_arange 50*0a6a1f1dSLionel Sambucsearches an array of 51*0a6a1f1dSLionel Sambuc.Vt Dwarf_Arange 52*0a6a1f1dSLionel Sambucdescriptors for one that covers a given address. 53*0a6a1f1dSLionel Sambuc.Pp 54*0a6a1f1dSLionel SambucArgument 55*0a6a1f1dSLionel Sambuc.Ar ar_list 56*0a6a1f1dSLionel Sambucshould point to an array of 57*0a6a1f1dSLionel Sambuc.Vt Dwarf_Arange 58*0a6a1f1dSLionel Sambucdescriptors. 59*0a6a1f1dSLionel Sambuc.Pp 60*0a6a1f1dSLionel SambucArgument 61*0a6a1f1dSLionel Sambuc.Ar ar_cnt 62*0a6a1f1dSLionel Sambucspecifies the number of 63*0a6a1f1dSLionel Sambuc.Vt Dwarf_Arange 64*0a6a1f1dSLionel Sambucdescriptors in the array pointed to by argument 65*0a6a1f1dSLionel Sambuc.Ar ar_list . 66*0a6a1f1dSLionel Sambuc.Pp 67*0a6a1f1dSLionel SambucArgument 68*0a6a1f1dSLionel Sambuc.Ar addr 69*0a6a1f1dSLionel Sambucspecifies the address being looked up. 70*0a6a1f1dSLionel Sambuc.Pp 71*0a6a1f1dSLionel SambucArgument 72*0a6a1f1dSLionel Sambuc.Ar ret_ar 73*0a6a1f1dSLionel Sambucwill be used to store the 74*0a6a1f1dSLionel Sambuc.Vt Dwarf_Arange 75*0a6a1f1dSLionel Sambucdescriptor that covers the given address. 76*0a6a1f1dSLionel Sambuc.Pp 77*0a6a1f1dSLionel SambucIf argument 78*0a6a1f1dSLionel Sambuc.Ar err 79*0a6a1f1dSLionel Sambucis not NULL, it will be used to store error information in case of an 80*0a6a1f1dSLionel Sambucerror. 81*0a6a1f1dSLionel Sambuc.Sh RETURN VALUES 82*0a6a1f1dSLionel SambucFunction 83*0a6a1f1dSLionel Sambuc.Fn dwarf_get_arange 84*0a6a1f1dSLionel Sambucreturns 85*0a6a1f1dSLionel Sambuc.Dv DW_DLV_OK 86*0a6a1f1dSLionel Sambucwhen it succeeds. 87*0a6a1f1dSLionel SambucIt returns 88*0a6a1f1dSLionel Sambuc.Dv DW_DLV_NO_ENTRY 89*0a6a1f1dSLionel Sambucif there is no 90*0a6a1f1dSLionel Sambuc.Vt Dwarf_Arange 91*0a6a1f1dSLionel Sambucdescriptor that covers the provided address. 92*0a6a1f1dSLionel SambucIn case of an error, it returns 93*0a6a1f1dSLionel Sambuc.Dv DW_DLV_ERROR 94*0a6a1f1dSLionel Sambucand sets the argument 95*0a6a1f1dSLionel Sambuc.Ar err . 96*0a6a1f1dSLionel Sambuc.Sh ERRORS 97*0a6a1f1dSLionel SambucFunction 98*0a6a1f1dSLionel Sambuc.Fn dwarf_get_arange 99*0a6a1f1dSLionel Sambuccan fail with: 100*0a6a1f1dSLionel Sambuc.Bl -tag -width ".Bq Er DW_DLE_NO_ENTRY" 101*0a6a1f1dSLionel Sambuc.It Bq Er DW_DLE_ARGUMENT 102*0a6a1f1dSLionel SambucOne of the arguments 103*0a6a1f1dSLionel Sambuc.Ar dbg , 104*0a6a1f1dSLionel Sambuc.Ar ar_list 105*0a6a1f1dSLionel Sambucor 106*0a6a1f1dSLionel Sambuc.Ar ret_ar 107*0a6a1f1dSLionel Sambucwas NULL. 108*0a6a1f1dSLionel Sambuc.It Bq Er DW_DLE_ARGUMENT 109*0a6a1f1dSLionel SambucValue of argument 110*0a6a1f1dSLionel Sambuc.Ar ar_cnt 111*0a6a1f1dSLionel Sambucequals to 0. 112*0a6a1f1dSLionel Sambuc.It Bq Er DW_DLE_NO_ENTRY 113*0a6a1f1dSLionel SambucA 114*0a6a1f1dSLionel Sambuc.Vt Dwarf_Arange 115*0a6a1f1dSLionel Sambucdescriptor that covers the given address 116*0a6a1f1dSLionel Sambucwas not found. 117*0a6a1f1dSLionel Sambuc.El 118*0a6a1f1dSLionel Sambuc.Sh SEE ALSO 119*0a6a1f1dSLionel Sambuc.Xr dwarf 3 , 120*0a6a1f1dSLionel Sambuc.Xr dwarf_get_aranges 3 , 121*0a6a1f1dSLionel Sambuc.Xr dwarf_get_arange_cu_header_offset 3 , 122*0a6a1f1dSLionel Sambuc.Xr dwarf_get_arange_info 3 , 123*0a6a1f1dSLionel Sambuc.Xr dwarf_get_cu_die_offset 3 124