xref: /netbsd-src/external/bsd/elftoolchain/dist/libdwarf/dwarf_add_expr_addr.3 (revision 5ac3bc719ce6e70593039505b491894133237d12)
1.\"	$NetBSD: dwarf_add_expr_addr.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_expr_addr.3 3961 2022-03-12 15:13:22Z jkoshy
28.\"
29.Dd September 9, 2011
30.Dt DWARF_ADD_EXPR_ADDR 3
31.Os
32.Sh NAME
33.Nm dwarf_add_expr_addr ,
34.Nm dwarf_add_expr_addr_b
35.Nd add a DW_OP_addr location expression
36.Sh LIBRARY
37.Lb libdwarf
38.Sh SYNOPSIS
39.In libdwarf.h
40.Ft "Dwarf_Unsigned"
41.Fo dwarf_add_expr_addr
42.Fa "Dwarf_P_Expr expr"
43.Fa "Dwarf_Unsigned address"
44.Fa "Dwarf_Signed sym_index"
45.Fa "Dwarf_Error *err"
46.Fc
47.Ft "Dwarf_Unsigned"
48.Fo dwarf_add_expr_addr_b
49.Fa "Dwarf_P_Expr expr"
50.Fa "Dwarf_Unsigned address"
51.Fa "Dwarf_Unsigned sym_index"
52.Fa "Dwarf_Error *err"
53.Fc
54.Sh DESCRIPTION
55Function
56.Fn dwarf_add_expr_addr_b
57adds a
58.Dv DW_OP_addr
59location expression to the location expression descriptor referenced
60by argument
61.Fa expr .
62.Pp
63Argument
64.Fa expr
65should reference a location expression descriptor allocated using
66the function
67.Xr dwarf_new_expr 3 .
68.Pp
69Argument
70.Fa address
71specifies the operand, a relocatable address value.
72.Pp
73Argument
74.Fa sym_index
75specifies the ELF symbol index of the symbol to be used for
76relocation.
77.Pp
78If argument
79.Fa err
80is not
81.Dv NULL ,
82it will be used to store error information in case of an error.
83.Pp
84Function
85.Fn dwarf_add_expr_addr
86is deprecated.
87It is similar to function
88.Fn dwarf_add_expr_addr_b
89except that it cannot handle all possible symbol index values.
90.Sh RETURN VALUES
91On success, these functions return the size in bytes of the location
92expression byte stream generated.
93In case of an error, these functions return
94.Dv DW_DLV_NOCOUNT
95and set the argument
96.Fa err .
97.Sh ERRORS
98These functions can fail with:
99.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
100.It Bq Er DW_DLE_ARGUMENT
101Argument
102.Fa expr
103was
104.Dv NULL .
105.It Bq Er DW_DLE_MEMORY
106An out of memory condition was encountered during the execution of
107the function.
108.El
109.Sh SEE ALSO
110.Xr dwarf 3 ,
111.Xr dwarf_add_AT_location_expr 3 ,
112.Xr dwarf_add_expr_gen 3 ,
113.Xr dwarf_expr_current_offset 3 ,
114.Xr dwarf_expr_into_block 3 ,
115.Xr dwarf_new_expr 3
116