1.\" $NetBSD: dwarf_add_AT_ref_address.3,v 1.6 2024/03/03 17:37:30 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_add_AT_ref_address.3 3961 2022-03-12 15:13:22Z jkoshy 28.\" 29.Dd September 7, 2011 30.Dt DWARF_ADD_AT_REF_ADDRESS 3 31.Os 32.Sh NAME 33.Nm dwarf_add_AT_ref_address 34.Nd create a reference class attribute descriptor 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft "Dwarf_P_Attribute" 40.Fo dwarf_add_AT_ref_address 41.Fa "Dwarf_P_Debug dbg" 42.Fa "Dwarf_P_Die die" 43.Fa "Dwarf_Half attr" 44.Fa "Dwarf_Unsigned pc_value" 45.Fa "Dwarf_Unsigned sym_index" 46.Fa "Dwarf_Error *err" 47.Fc 48.Sh DESCRIPTION 49Function 50.Fn dwarf_add_AT_ref_address 51creates a 52.Sq reference 53class attribute descriptor containing a relocatable address value. 54The created attribute will use DWARF form 55.Dv DW_FORM_ref_addr . 56.Pp 57Argument 58.Fa dbg 59should reference a DWARF producer instance allocated using 60.Xr dwarf_producer_init 3 61or 62.Xr dwarf_producer_init_b 3 . 63.Pp 64Argument 65.Fa die 66should reference a debugging information entry allocated using 67.Xr dwarf_new_die 3 . 68.Pp 69Argument 70.Fa attr 71specifies the attribute code of the created attribute. 72.Pp 73Argument 74.Fa pc_value 75contains a relocatable address which will become the value of the 76created attribute. 77.Pp 78Argument 79.Fa sym_index 80should specify the ELF symbol index of the symbol to be used when 81relocating the address value. 82.Pp 83If argument 84.Fa err 85is not 86.Dv NULL , 87it will be used to store error information in case of an error. 88.Sh RETURN VALUES 89On success, function 90.Fn dwarf_add_AT_ref_address 91returns the created attribute descriptor. 92In case of an error, function 93.Fn dwarf_add_AT_ref_address 94returns 95.Dv DW_DLV_BADADDR 96and sets the argument 97.Fa err . 98.Sh ERRORS 99Function 100.Fn dwarf_add_AT_ref_address 101can fail with: 102.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 103.It Bq Er DW_DLE_ARGUMENT 104Either of the arguments 105.Fa dbg 106or 107.Fa die 108was 109.Dv NULL . 110.It Bq Er DW_DLE_MEMORY 111An out of memory condition was encountered during execution. 112.El 113.Sh SEE ALSO 114.Xr dwarf 3 , 115.Xr dwarf_add_AT_dataref 3 , 116.Xr dwarf_add_AT_reference 3 , 117.Xr dwarf_add_AT_signed_const 3 , 118.Xr dwarf_add_AT_unsigned_const 3 , 119.Xr dwarf_new_die 3 , 120.Xr dwarf_producer_init 3 , 121.Xr dwarf_producer_init_b 3 122