xref: /freebsd-src/contrib/elftoolchain/libdwarf/dwarf_add_expr_addr.3 (revision ae500c1ff8974130f7f2692772cf288b90349e0d)
12de3b87aSKai Wang.\" Copyright (c) 2011 Kai Wang
22de3b87aSKai Wang.\" All rights reserved.
32de3b87aSKai Wang.\"
42de3b87aSKai Wang.\" Redistribution and use in source and binary forms, with or without
52de3b87aSKai Wang.\" modification, are permitted provided that the following conditions
62de3b87aSKai Wang.\" are met:
72de3b87aSKai Wang.\" 1. Redistributions of source code must retain the above copyright
82de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer.
92de3b87aSKai Wang.\" 2. Redistributions in binary form must reproduce the above copyright
102de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer in the
112de3b87aSKai Wang.\"    documentation and/or other materials provided with the distribution.
122de3b87aSKai Wang.\"
132de3b87aSKai Wang.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
142de3b87aSKai Wang.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
152de3b87aSKai Wang.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
162de3b87aSKai Wang.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
172de3b87aSKai Wang.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
182de3b87aSKai Wang.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
192de3b87aSKai Wang.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
202de3b87aSKai Wang.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
212de3b87aSKai Wang.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
222de3b87aSKai Wang.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
232de3b87aSKai Wang.\" SUCH DAMAGE.
242de3b87aSKai Wang.\"
25*ae500c1fSEd Maste.\" $Id: dwarf_add_expr_addr.3 3640 2018-10-14 14:09:13Z jkoshy $
262de3b87aSKai Wang.\"
272de3b87aSKai Wang.Dd September 9, 2011
282de3b87aSKai Wang.Dt DWARF_ADD_EXPR_ADDR 3
29*ae500c1fSEd Maste.Os
302de3b87aSKai Wang.Sh NAME
312de3b87aSKai Wang.Nm dwarf_add_expr_addr ,
322de3b87aSKai Wang.Nm dwarf_add_expr_addr_b
332de3b87aSKai Wang.Nd add a DW_OP_addr location expression
342de3b87aSKai Wang.Sh LIBRARY
352de3b87aSKai Wang.Lb libdwarf
362de3b87aSKai Wang.Sh SYNOPSIS
372de3b87aSKai Wang.In libdwarf.h
382de3b87aSKai Wang.Ft "Dwarf_Unsigned"
392de3b87aSKai Wang.Fo dwarf_add_expr_addr
402de3b87aSKai Wang.Fa "Dwarf_P_Expr expr"
412de3b87aSKai Wang.Fa "Dwarf_Unsigned address"
422de3b87aSKai Wang.Fa "Dwarf_Signed sym_index"
432de3b87aSKai Wang.Fa "Dwarf_Error *err"
442de3b87aSKai Wang.Fc
452de3b87aSKai Wang.Ft "Dwarf_Unsigned"
462de3b87aSKai Wang.Fo dwarf_add_expr_addr_b
472de3b87aSKai Wang.Fa "Dwarf_P_Expr expr"
482de3b87aSKai Wang.Fa "Dwarf_Unsigned address"
492de3b87aSKai Wang.Fa "Dwarf_Unsigned sym_index"
502de3b87aSKai Wang.Fa "Dwarf_Error *err"
512de3b87aSKai Wang.Fc
522de3b87aSKai Wang.Sh DESCRIPTION
532de3b87aSKai WangFunction
542de3b87aSKai Wang.Fn dwarf_add_expr_addr_b
552de3b87aSKai Wangadds a
562de3b87aSKai Wang.Dv DW_OP_addr
572de3b87aSKai Wanglocation expression to the location expression descriptor referenced
582de3b87aSKai Wangby argument
592de3b87aSKai Wang.Ar expr .
602de3b87aSKai Wang.Pp
612de3b87aSKai WangArgument
622de3b87aSKai Wang.Ar expr
632de3b87aSKai Wangshould reference a location expression descriptor allocated using
642de3b87aSKai Wangthe function
652de3b87aSKai Wang.Xr dwarf_new_expr 3 .
662de3b87aSKai Wang.Pp
672de3b87aSKai WangArgument
682de3b87aSKai Wang.Ar address
692de3b87aSKai Wangspecifies the operand, a relocatable address value.
702de3b87aSKai Wang.Pp
712de3b87aSKai WangArgument
722de3b87aSKai Wang.Ar sym_index
732de3b87aSKai Wangspecifies the ELF symbol index of the symbol to be used for
742de3b87aSKai Wangrelocation.
752de3b87aSKai Wang.Pp
762de3b87aSKai WangIf argument
772de3b87aSKai Wang.Ar err
782de3b87aSKai Wangis not NULL, it will be used to store error information in case
792de3b87aSKai Wangof an error.
802de3b87aSKai Wang.Pp
812de3b87aSKai WangFunction
822de3b87aSKai Wang.Fn dwarf_add_expr_addr
832de3b87aSKai Wangis deprecated.
842de3b87aSKai WangIt is similar to function
852de3b87aSKai Wang.Fn dwarf_add_expr_addr_b
862de3b87aSKai Wangexcept that it cannot handle all possible symbol index values.
872de3b87aSKai Wang.Sh RETURN VALUES
882de3b87aSKai WangOn success, these functions return the size in bytes of the location
892de3b87aSKai Wangexpression byte stream generated.
902de3b87aSKai WangIn case of an error, these functions return
912de3b87aSKai Wang.Dv DW_DLV_NOCOUNT
922de3b87aSKai Wangand set the argument
932de3b87aSKai Wang.Ar err .
942de3b87aSKai Wang.Sh ERRORS
952de3b87aSKai WangThese functions can fail with:
962de3b87aSKai Wang.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
972de3b87aSKai Wang.It Bq Er DW_DLE_ARGUMENT
982de3b87aSKai WangArgument
992de3b87aSKai Wang.Ar expr
1002de3b87aSKai Wangwas NULL.
1012de3b87aSKai Wang.It Bq Er DW_DLE_MEMORY
1022de3b87aSKai WangAn out of memory condition was encountered during the execution of
1032de3b87aSKai Wangthe function.
1042de3b87aSKai Wang.El
1052de3b87aSKai Wang.Sh SEE ALSO
1062de3b87aSKai Wang.Xr dwarf 3 ,
1072de3b87aSKai Wang.Xr dwarf_add_AT_location_expr 3 ,
1082de3b87aSKai Wang.Xr dwarf_add_expr_gen 3 ,
1092de3b87aSKai Wang.Xr dwarf_expr_current_offset 3 ,
1102de3b87aSKai Wang.Xr dwarf_expr_into_block 3 ,
1112de3b87aSKai Wang.Xr dwarf_new_expr 3
112