1.\" $NetBSD: dwarf_get_arange.3,v 1.2 2014/03/09 16:58:03 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_arange.3 2071 2011-10-27 03:20:00Z jkoshy 28.\" 29.Dd April 16, 2011 30.Os 31.Dt DWARF_GET_ARANGE 3 32.Sh NAME 33.Nm dwarf_get_arange 34.Nd retrieve the address range descriptor for an address 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft int 40.Fo dwarf_get_arange 41.Fa "Dwarf_Arange *ar_list" 42.Fa "Dwarf_Unsigned ar_cnt" 43.Fa "Dwarf_Addr addr" 44.Fa "Dwarf_Arange *ret_ar" 45.Fa "Dwarf_Error *err" 46.Fc 47.Sh DESCRIPTION 48Function 49.Fn dwarf_get_arange 50searches an array of 51.Vt Dwarf_Arange 52descriptors for one that covers a given address. 53.Pp 54Argument 55.Ar ar_list 56should point to an array of 57.Vt Dwarf_Arange 58descriptors. 59.Pp 60Argument 61.Ar ar_cnt 62specifies the number of 63.Vt Dwarf_Arange 64descriptors in the array pointed to by argument 65.Ar ar_list . 66.Pp 67Argument 68.Ar addr 69specifies the address being looked up. 70.Pp 71Argument 72.Ar ret_ar 73will be used to store the 74.Vt Dwarf_Arange 75descriptor that covers the given address. 76.Pp 77If argument 78.Ar err 79is not NULL, it will be used to store error information in case of an 80error. 81.Sh RETURN VALUES 82Function 83.Fn dwarf_get_arange 84returns 85.Dv DW_DLV_OK 86when it succeeds. 87It returns 88.Dv DW_DLV_NO_ENTRY 89if there is no 90.Vt Dwarf_Arange 91descriptor that covers the provided address. 92In case of an error, it returns 93.Dv DW_DLV_ERROR 94and sets the argument 95.Ar err . 96.Sh ERRORS 97Function 98.Fn dwarf_get_arange 99can fail with: 100.Bl -tag -width ".Bq Er DW_DLE_NO_ENTRY" 101.It Bq Er DW_DLE_ARGUMENT 102One of the arguments 103.Ar dbg , 104.Ar ar_list 105or 106.Ar ret_ar 107was NULL. 108.It Bq Er DW_DLE_ARGUMENT 109Value of argument 110.Ar ar_cnt 111equals to 0. 112.It Bq Er DW_DLE_NO_ENTRY 113A 114.Vt Dwarf_Arange 115descriptor that covers the given address 116was not found. 117.El 118.Sh SEE ALSO 119.Xr dwarf 3 , 120.Xr dwarf_get_aranges 3 , 121.Xr dwarf_get_arange_cu_header_offset 3 , 122.Xr dwarf_get_arange_info 3 , 123.Xr dwarf_get_cu_die_offset 3 124