1.\" $NetBSD: dwarf_add_AT_reference.3,v 1.5 2022/03/14 20:50:48 jkoshy 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_reference.3 3961 2022-03-12 15:13:22Z jkoshy 28.\" 29.Dd September 4, 2011 30.Dt DWARF_ADD_AT_REFERENCE 3 31.Os 32.Sh NAME 33.Nm dwarf_add_AT_reference 34.Nd create and attach an attribute that references another DIE 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft "Dwarf_P_Attribute" 40.Fo dwarf_add_AT_reference 41.Fa "Dwarf_P_Debug dbg" 42.Fa "Dwarf_P_Die die" 43.Fa "Dwarf_Half attr" 44.Fa "Dwarf_P_Die ref_die" 45.Fa "Dwarf_Error *err" 46.Fc 47.Sh DESCRIPTION 48Function 49.Fn dwarf_add_AT_reference 50creates an attribute descriptor that references another debugging 51information entry in the same compilation unit. 52The attribute will be of DWARF form 53.Dv DW_FORM_ref4 54or 55.Dv DW_FORM_ref8 56depending on the target address size, and will contain the 57section-relative offset of the referenced debugging information entry 58as its value. 59.Pp 60Argument 61.Fa dbg 62should reference a DWARF producer instance allocated using 63.Xr dwarf_producer_init 3 64or 65.Xr dwarf_producer_init_b 3 . 66.Pp 67Argument 68.Fa die 69should reference a debugging information entry allocated using 70.Xr dwarf_new_die 3 . 71.Pp 72Argument 73.Fa attr 74should specify the attribute code of the created attribute descriptor. 75.Pp 76Argument 77.Fa ref_die 78should hold the debugging information entry descriptor that 79the attribute should refer to. 80.Pp 81If argument 82.Fa err 83is not 84.Dv NULL , 85it will be used to store error information in case of an error. 86.Sh RETURN VALUES 87On success, function 88.Fn dwarf_add_AT_reference 89returns the created attribute descriptor. 90In case of an error, function 91.Fn dwarf_add_AT_reference 92returns 93.Dv DW_DLV_BADADDR 94and sets the argument 95.Fa err . 96.Sh ERRORS 97Function 98.Fn dwarf_add_AT_reference 99can fail with: 100.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 101.It Bq Er DW_DLE_ARGUMENT 102One of the arguments 103.Fa dbg , 104.Fa die 105or 106.Fa ref_die 107was 108.Dv NULL . 109.It Bq Er DW_DLE_MEMORY 110An out of memory condition was encountered during the execution of 111the function. 112.El 113.Sh SEE ALSO 114.Xr dwarf 3 , 115.Xr dwarf_add_AT_dataref 3 , 116.Xr dwarf_add_AT_ref_address 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