1.\" Copyright (c) 2011 Kai Wang 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $Id: dwarf_add_AT_dataref.3 2072 2011-10-27 03:26:49Z jkoshy $ 26.\" 27.Dd September 4, 2011 28.Os 29.Dt DWARF_ADD_AT_DATAREF 3 30.Sh NAME 31.Nm dwarf_add_AT_dataref 32.Nd create an attribute descriptor for a relocatable address 33.Sh LIBRARY 34.Lb libdwarf 35.Sh SYNOPSIS 36.In libdwarf.h 37.Ft "Dwarf_P_Attribute" 38.Fo dwarf_add_AT_dataref 39.Fa "Dwarf_P_Debug dbg" 40.Fa "Dwarf_P_Die die" 41.Fa "Dwarf_Half attr" 42.Fa "Dwarf_Unsigned pc_value" 43.Fa "Dwarf_Unsigned sym_index" 44.Fa "Dwarf_Error *err" 45.Fc 46.Sh DESCRIPTION 47Function 48.Fn dwarf_add_AT_dataref 49creates an attribute descriptor for a relocatable address and attaches 50it to the debugging information entry referenced by argument 51.Ar die . 52.Pp 53If flag 54.Dv DW_DLC_SIZE_64 55is set, the address value will be 8 bytes in size and of the DWARF form 56.Dv DW_FORM_data8 . 57Otherwise, the address value will be 4 bytes in size and of the DWARF form 58.Dv DW_FORM_data4 . 59.Pp 60Argument 61.Ar 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.Ar die 69should reference a debugging information entry allocated using 70.Xr dwarf_new_die 3 . 71.Pp 72Argument 73.Ar attr 74specifies the attribute code of the created attribute descriptor. 75.Pp 76Argument 77.Ar pc_value 78specifies the value of the relocatable address. 79.Pp 80Argument 81.Ar sym_index 82specifies the ELF symbol index of the symbol to be used for 83relocation. 84.Pp 85If argument 86.Ar err 87is not NULL, it will be used to store error information in case 88of an error. 89.Sh RETURN VALUES 90On success, function 91.Fn dwarf_add_AT_dataref 92returns the created attribute descriptor. 93In case of an error, function 94.Fn dwarf_add_AT_dataref 95returns 96.Dv DW_DLV_BADADDR 97and sets the argument 98.Ar err . 99.Sh ERRORS 100Function 101.Fn dwarf_add_AT_dataref 102can fail with: 103.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 104.It Bq Er DW_DLE_ARGUMENT 105Either of the arguments 106.Ar dbg 107or 108.Ar die 109was NULL. 110.It Bq Er DW_DLE_MEMORY 111An out of memory condition was encountered during the execution of the 112function. 113.El 114.Sh SEE ALSO 115.Xr dwarf 3 , 116.Xr dwarf_add_AT_reference 3 , 117.Xr dwarf_add_AT_ref_address 3 , 118.Xr dwarf_add_AT_signed_const 3 , 119.Xr dwarf_add_AT_unsigned_const 3 , 120.Xr dwarf_new_die 3 , 121.Xr dwarf_producer_init 3 , 122.Xr dwarf_producer_init_b 3 123