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