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_targ_address.3 2072 2011-10-27 03:26:49Z jkoshy $ 26.\" 27.Dd September 4, 2011 28.Os 29.Dt DWARF_ADD_AT_TARG_ADDRESS 3 30.Sh NAME 31.Nm dwarf_add_AT_targ_address , 32.Nm dwarf_add_AT_targ_address_b 33.Nd create and attach address class attributes 34.Sh LIBRARY 35.Lb libdwarf 36.Sh SYNOPSIS 37.In libdwarf.h 38.Ft Dwarf_P_Attribute 39.Fo dwarf_add_AT_targ_address 40.Fa "Dwarf_P_Debug dbg" 41.Fa "Dwarf_P_Die die" 42.Fa "Dwarf_Half attr" 43.Fa "Dwarf_Unsigned pc_value" 44.Fa "Dwarf_Signed sym_index" 45.Fa "Dwarf_Error *err" 46.Fc 47.Ft Dwarf_P_Attribute 48.Fo dwarf_add_AT_targ_address_b 49.Fa "Dwarf_P_Debug dbg" 50.Fa "Dwarf_P_Die die" 51.Fa "Dwarf_Half attr" 52.Fa "Dwarf_Unsigned pc_value" 53.Fa "Dwarf_Unsigned sym_index" 54.Fa "Dwarf_Error *err" 55.Fc 56.Sh DESCRIPTION 57Function 58.Fn dwarf_add_AT_targ_address_b 59creates an attribute descriptor belonging to the 60.Sq address 61class and attaches it to the debugging information entry referenced by 62argument 63.Ar die . 64.Pp 65The created attribute descriptor will have DWARF form 66.Dv DW_FORM_addr . 67If flag 68.Dv DW_DLC_SIZE_64 69is set on the producer instance, the attribute value will be 8 bytes 70in size. 71Otherwise the attribute value will be 4 bytes in size. 72.Pp 73Argument 74.Ar dbg 75should reference a DWARF producer instance allocated using 76.Xr dwarf_producer_init 3 77or 78.Xr dwarf_producer_init_b 3 . 79.Pp 80Argument 81.Ar die 82should reference a debugging information entry allocated using 83.Xr dwarf_new_die 3 . 84.Pp 85Argument 86.Ar attr 87should specify the attribute code of the created attribute descriptor. 88.Pp 89Argument 90.Ar pc_value 91should hold a relocatable address value which will become the value of 92the created attribute descriptor. 93.Pp 94Argument 95.Ar sym_index 96should specify the ELF symbol index of the symbol to be used for 97relocating the address value. 98.Pp 99If argument 100.Ar err 101is not NULL, it will be used to store error information in case 102of an error. 103.Pp 104Function 105.Fn dwarf_add_AT_targ_address 106is deprecated. 107It is similar to function 108.Fn dwarf_add_AT_targ_address_b 109except that it cannot handle all possible symbol index values. 110.Sh RETURN VALUES 111On success, these functions return the created attribute descriptor. 112In case of an error, these functions return 113.Dv DW_DLV_BADADDR 114and sets the argument 115.Ar err . 116.Sh ERRORS 117These functions can fail with: 118.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 119.It Bq Er DW_DLE_ARGUMENT 120Either of the arguments 121.Ar dbg 122or 123.Ar die 124was NULL. 125.It Bq Er DW_DLE_MEMORY 126An out of memory condition was encountered during execution. 127.El 128.Sh SEE ALSO 129.Xr dwarf 3 , 130.Xr dwarf_add_AT_const_value_unsignedint 3 , 131.Xr dwarf_add_AT_dataref 3 , 132.Xr dwarf_add_AT_ref_address 3 , 133.Xr dwarf_add_AT_signed_const 3 , 134.Xr dwarf_add_AT_unsigned_const 3 , 135.Xr dwarf_new_die 3 , 136.Xr dwarf_producer_init 3 , 137.Xr dwarf_producer_init_b 3 138