12de3b87aSKai Wang.\" Copyright (c) 2011 Kai Wang 22de3b87aSKai Wang.\" All rights reserved. 32de3b87aSKai Wang.\" 42de3b87aSKai Wang.\" Redistribution and use in source and binary forms, with or without 52de3b87aSKai Wang.\" modification, are permitted provided that the following conditions 62de3b87aSKai Wang.\" are met: 72de3b87aSKai Wang.\" 1. Redistributions of source code must retain the above copyright 82de3b87aSKai Wang.\" notice, this list of conditions and the following disclaimer. 92de3b87aSKai Wang.\" 2. Redistributions in binary form must reproduce the above copyright 102de3b87aSKai Wang.\" notice, this list of conditions and the following disclaimer in the 112de3b87aSKai Wang.\" documentation and/or other materials provided with the distribution. 122de3b87aSKai Wang.\" 132de3b87aSKai Wang.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 142de3b87aSKai Wang.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 152de3b87aSKai Wang.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 162de3b87aSKai Wang.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 172de3b87aSKai Wang.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 182de3b87aSKai Wang.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 192de3b87aSKai Wang.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 202de3b87aSKai Wang.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 212de3b87aSKai Wang.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 222de3b87aSKai Wang.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 232de3b87aSKai Wang.\" SUCH DAMAGE. 242de3b87aSKai Wang.\" 25*ae500c1fSEd Maste.\" $Id: dwarf_get_arange.3 3644 2018-10-15 19:55:01Z jkoshy $ 262de3b87aSKai Wang.\" 272de3b87aSKai Wang.Dd April 16, 2011 282de3b87aSKai Wang.Dt DWARF_GET_ARANGE 3 29*ae500c1fSEd Maste.Os 302de3b87aSKai Wang.Sh NAME 312de3b87aSKai Wang.Nm dwarf_get_arange 322de3b87aSKai Wang.Nd retrieve the address range descriptor for an address 332de3b87aSKai Wang.Sh LIBRARY 342de3b87aSKai Wang.Lb libdwarf 352de3b87aSKai Wang.Sh SYNOPSIS 362de3b87aSKai Wang.In libdwarf.h 372de3b87aSKai Wang.Ft int 382de3b87aSKai Wang.Fo dwarf_get_arange 392de3b87aSKai Wang.Fa "Dwarf_Arange *ar_list" 402de3b87aSKai Wang.Fa "Dwarf_Unsigned ar_cnt" 412de3b87aSKai Wang.Fa "Dwarf_Addr addr" 422de3b87aSKai Wang.Fa "Dwarf_Arange *ret_ar" 432de3b87aSKai Wang.Fa "Dwarf_Error *err" 442de3b87aSKai Wang.Fc 452de3b87aSKai Wang.Sh DESCRIPTION 462de3b87aSKai WangFunction 472de3b87aSKai Wang.Fn dwarf_get_arange 482de3b87aSKai Wangsearches an array of 492de3b87aSKai Wang.Vt Dwarf_Arange 502de3b87aSKai Wangdescriptors for one that covers a given address. 512de3b87aSKai Wang.Pp 522de3b87aSKai WangArgument 532de3b87aSKai Wang.Ar ar_list 542de3b87aSKai Wangshould point to an array of 552de3b87aSKai Wang.Vt Dwarf_Arange 562de3b87aSKai Wangdescriptors. 572de3b87aSKai Wang.Pp 582de3b87aSKai WangArgument 592de3b87aSKai Wang.Ar ar_cnt 602de3b87aSKai Wangspecifies the number of 612de3b87aSKai Wang.Vt Dwarf_Arange 622de3b87aSKai Wangdescriptors in the array pointed to by argument 632de3b87aSKai Wang.Ar ar_list . 642de3b87aSKai Wang.Pp 652de3b87aSKai WangArgument 662de3b87aSKai Wang.Ar addr 672de3b87aSKai Wangspecifies the address being looked up. 682de3b87aSKai Wang.Pp 692de3b87aSKai WangArgument 702de3b87aSKai Wang.Ar ret_ar 712de3b87aSKai Wangwill be used to store the 722de3b87aSKai Wang.Vt Dwarf_Arange 732de3b87aSKai Wangdescriptor that covers the given address. 742de3b87aSKai Wang.Pp 752de3b87aSKai WangIf argument 762de3b87aSKai Wang.Ar err 772de3b87aSKai Wangis not NULL, it will be used to store error information in case of an 782de3b87aSKai Wangerror. 792de3b87aSKai Wang.Sh RETURN VALUES 802de3b87aSKai WangFunction 812de3b87aSKai Wang.Fn dwarf_get_arange 822de3b87aSKai Wangreturns 832de3b87aSKai Wang.Dv DW_DLV_OK 842de3b87aSKai Wangwhen it succeeds. 852de3b87aSKai WangIt returns 862de3b87aSKai Wang.Dv DW_DLV_NO_ENTRY 872de3b87aSKai Wangif there is no 882de3b87aSKai Wang.Vt Dwarf_Arange 892de3b87aSKai Wangdescriptor that covers the provided address. 902de3b87aSKai WangIn case of an error, it returns 912de3b87aSKai Wang.Dv DW_DLV_ERROR 922de3b87aSKai Wangand sets the argument 932de3b87aSKai Wang.Ar err . 942de3b87aSKai Wang.Sh ERRORS 952de3b87aSKai WangFunction 962de3b87aSKai Wang.Fn dwarf_get_arange 972de3b87aSKai Wangcan fail with: 982de3b87aSKai Wang.Bl -tag -width ".Bq Er DW_DLE_NO_ENTRY" 992de3b87aSKai Wang.It Bq Er DW_DLE_ARGUMENT 1002de3b87aSKai WangOne of the arguments 1012de3b87aSKai Wang.Ar dbg , 1022de3b87aSKai Wang.Ar ar_list 1032de3b87aSKai Wangor 1042de3b87aSKai Wang.Ar ret_ar 1052de3b87aSKai Wangwas NULL. 1062de3b87aSKai Wang.It Bq Er DW_DLE_ARGUMENT 1072de3b87aSKai WangValue of argument 1082de3b87aSKai Wang.Ar ar_cnt 1092de3b87aSKai Wangequals to 0. 1102de3b87aSKai Wang.It Bq Er DW_DLE_NO_ENTRY 1112de3b87aSKai WangA 1122de3b87aSKai Wang.Vt Dwarf_Arange 1132de3b87aSKai Wangdescriptor that covers the given address 1142de3b87aSKai Wangwas not found. 1152de3b87aSKai Wang.El 1162de3b87aSKai Wang.Sh SEE ALSO 1172de3b87aSKai Wang.Xr dwarf 3 , 1182de3b87aSKai Wang.Xr dwarf_get_arange_cu_header_offset 3 , 1192de3b87aSKai Wang.Xr dwarf_get_arange_info 3 , 120*ae500c1fSEd Maste.Xr dwarf_get_aranges 3 , 1212de3b87aSKai Wang.Xr dwarf_get_cu_die_offset 3 122