1.\" $NetBSD: dwarf_get_address_size.3,v 1.6 2024/03/03 17:37:31 christos Exp $ 2.\" 3.\" Copyright (c) 2010 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_address_size.3 3964 2022-03-13 21:41:26Z jkoshy 28.\" 29.Dd March 13, 2022 30.Dt DWARF_GET_ADDRESS_SIZE 3 31.Os 32.Sh NAME 33.Nm dwarf_get_address_size 34.Nd return the number of bytes needed to represent an address 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft int 40.Fo dwarf_get_address_size 41.Fa "Dwarf_Debug dbg" 42.Fa "Dwarf_Half *addr_size" 43.Fa "Dwarf_Error *err" 44.Fc 45.Sh DESCRIPTION 46Function 47.Fn dwarf_get_address_size 48returns the size in bytes of a native address for a program object. 49.Pp 50Argument 51.Fa dbg 52should denote a DWARF debug context created from a program object using 53.Xr dwarf_init 3 . 54Argument 55.Fa addr_size 56should point to a location that will hold the returned size. 57Argument 58.Fa err , 59if 60.No non- Ns Dv NULL , 61it will be used to return error information. 62.Sh RETURN VALUES 63On success, function 64.Fn dwarf_get_address_size 65returns 66.Dv DW_DLV_OK . 67In case of an error, it returns 68.Dv DW_DLV_ERROR 69and sets argument 70.Fa err . 71.Sh ERRORS 72Function 73.Fn dwarf_get_address_size 74can fail with the following error: 75.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 76.It Bq Er DW_DLE_ARGUMENT 77Either of arguments 78.Fa dbg 79or 80.Fa addr_size 81was 82.Dv NULL . 83.El 84.Sh SEE ALSO 85.Xr dwarf 3 , 86.Xr dwarf_finish 3 , 87.Xr dwarf_init 3 88