1.\" $NetBSD: dwarf_get_cu_die_offset.3,v 1.2 2014/03/09 16:58:04 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_cu_die_offset.3 2071 2011-10-27 03:20:00Z jkoshy 28.\" 29.Dd April 10, 2011 30.Os 31.Dt DWARF_GET_CU_DIE_OFFSET 3 32.Sh NAME 33.Nm dwarf_get_arange_cu_header_offset , 34.Nm dwarf_get_cu_die_offset 35.Nd retrieve compilation unit offsets 36.Sh LIBRARY 37.Lb libdwarf 38.Sh SYNOPSIS 39.In libdwarf.h 40.Ft int 41.Fo dwarf_get_arange_cu_header_offset 42.Fa "Dwarf_Arange ar" 43.Fa "Dwarf_Off *ret" 44.Fa "Dwarf_Error *err" 45.Fc 46.Ft int 47.Fo dwarf_get_cu_die_offset 48.Fa "Dwarf_Arange ar" 49.Fa "Dwarf_Off *ret" 50.Fa "Dwarf_Error *err" 51.Fc 52.Sh DESCRIPTION 53These functions retrieve the offsets, relative to the 54.Dq ".debug_info" 55DWARF section, of the debugging information entries describing the 56compilation unit associated with a 57.Vt Dwarf_Arange 58descriptor. 59.Pp 60Function 61.Fn dwarf_get_arange_cu_header_offset 62retrieves the offset of the compilation unit header associated with 63argument 64.Ar ar , 65and stores it in the location pointed to by argument 66.Ar ret . 67.Pp 68Function 69.Fn dwarf_get_cu_die_offset 70retrieves the offset of the debugging information entry for the 71compilation unit associated with argument 72.Ar ar , 73and stores it in the location pointed to by argument 74.Ar ret . 75.Pp 76If argument 77.Ar err 78is not NULL, these functions will use it to store error information, 79in case of an error. 80.Sh RETURN VALUES 81On success, these functions returns 82.Dv DW_DLV_OK . 83In case of an error, they return 84.Dv DW_DLV_ERROR 85and set the argument 86.Ar err . 87.Sh ERRORS 88These functions may fail with: 89.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 90.It Bq Er DW_DLE_ARGUMENT 91Argument 92.Ar ar 93was not a valid 94.Vt Dwarf_Arange 95descriptor. 96.It Bq Er DW_DLE_ARGUMENT 97Argument 98.Ar ret 99was NULL. 100.El 101.Sh SEE ALSO 102.Xr dwarf 3 , 103.Xr dwarf_get_arange 3 , 104.Xr dwarf_get_arange_info 3 , 105.Xr dwarf_get_aranges 3 106