1*0a6a1f1dSLionel Sambuc.\" $NetBSD: dwarf_add_expr_addr.3,v 1.2 2014/03/09 16:58:03 christos Exp $ 2*0a6a1f1dSLionel Sambuc.\" 3*0a6a1f1dSLionel Sambuc.\" Copyright (c) 2011 Kai Wang 4*0a6a1f1dSLionel Sambuc.\" All rights reserved. 5*0a6a1f1dSLionel Sambuc.\" 6*0a6a1f1dSLionel Sambuc.\" Redistribution and use in source and binary forms, with or without 7*0a6a1f1dSLionel Sambuc.\" modification, are permitted provided that the following conditions 8*0a6a1f1dSLionel Sambuc.\" are met: 9*0a6a1f1dSLionel Sambuc.\" 1. Redistributions of source code must retain the above copyright 10*0a6a1f1dSLionel Sambuc.\" notice, this list of conditions and the following disclaimer. 11*0a6a1f1dSLionel Sambuc.\" 2. Redistributions in binary form must reproduce the above copyright 12*0a6a1f1dSLionel Sambuc.\" notice, this list of conditions and the following disclaimer in the 13*0a6a1f1dSLionel Sambuc.\" documentation and/or other materials provided with the distribution. 14*0a6a1f1dSLionel Sambuc.\" 15*0a6a1f1dSLionel Sambuc.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16*0a6a1f1dSLionel Sambuc.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17*0a6a1f1dSLionel Sambuc.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18*0a6a1f1dSLionel Sambuc.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19*0a6a1f1dSLionel Sambuc.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20*0a6a1f1dSLionel Sambuc.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21*0a6a1f1dSLionel Sambuc.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22*0a6a1f1dSLionel Sambuc.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23*0a6a1f1dSLionel Sambuc.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24*0a6a1f1dSLionel Sambuc.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25*0a6a1f1dSLionel Sambuc.\" SUCH DAMAGE. 26*0a6a1f1dSLionel Sambuc.\" 27*0a6a1f1dSLionel Sambuc.\" Id: dwarf_add_expr_addr.3 2072 2011-10-27 03:26:49Z jkoshy 28*0a6a1f1dSLionel Sambuc.\" 29*0a6a1f1dSLionel Sambuc.Dd September 9, 2011 30*0a6a1f1dSLionel Sambuc.Os 31*0a6a1f1dSLionel Sambuc.Dt DWARF_ADD_EXPR_ADDR 3 32*0a6a1f1dSLionel Sambuc.Sh NAME 33*0a6a1f1dSLionel Sambuc.Nm dwarf_add_expr_addr , 34*0a6a1f1dSLionel Sambuc.Nm dwarf_add_expr_addr_b 35*0a6a1f1dSLionel Sambuc.Nd add a DW_OP_addr location expression 36*0a6a1f1dSLionel Sambuc.Sh LIBRARY 37*0a6a1f1dSLionel Sambuc.Lb libdwarf 38*0a6a1f1dSLionel Sambuc.Sh SYNOPSIS 39*0a6a1f1dSLionel Sambuc.In libdwarf.h 40*0a6a1f1dSLionel Sambuc.Ft "Dwarf_Unsigned" 41*0a6a1f1dSLionel Sambuc.Fo dwarf_add_expr_addr 42*0a6a1f1dSLionel Sambuc.Fa "Dwarf_P_Expr expr" 43*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Unsigned address" 44*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Signed sym_index" 45*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Error *err" 46*0a6a1f1dSLionel Sambuc.Fc 47*0a6a1f1dSLionel Sambuc.Ft "Dwarf_Unsigned" 48*0a6a1f1dSLionel Sambuc.Fo dwarf_add_expr_addr_b 49*0a6a1f1dSLionel Sambuc.Fa "Dwarf_P_Expr expr" 50*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Unsigned address" 51*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Unsigned sym_index" 52*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Error *err" 53*0a6a1f1dSLionel Sambuc.Fc 54*0a6a1f1dSLionel Sambuc.Sh DESCRIPTION 55*0a6a1f1dSLionel SambucFunction 56*0a6a1f1dSLionel Sambuc.Fn dwarf_add_expr_addr_b 57*0a6a1f1dSLionel Sambucadds a 58*0a6a1f1dSLionel Sambuc.Dv DW_OP_addr 59*0a6a1f1dSLionel Sambuclocation expression to the location expression descriptor referenced 60*0a6a1f1dSLionel Sambucby argument 61*0a6a1f1dSLionel Sambuc.Ar expr . 62*0a6a1f1dSLionel Sambuc.Pp 63*0a6a1f1dSLionel SambucArgument 64*0a6a1f1dSLionel Sambuc.Ar expr 65*0a6a1f1dSLionel Sambucshould reference a location expression descriptor allocated using 66*0a6a1f1dSLionel Sambucthe function 67*0a6a1f1dSLionel Sambuc.Xr dwarf_new_expr 3 . 68*0a6a1f1dSLionel Sambuc.Pp 69*0a6a1f1dSLionel SambucArgument 70*0a6a1f1dSLionel Sambuc.Ar address 71*0a6a1f1dSLionel Sambucspecifies the operand, a relocatable address value. 72*0a6a1f1dSLionel Sambuc.Pp 73*0a6a1f1dSLionel SambucArgument 74*0a6a1f1dSLionel Sambuc.Ar sym_index 75*0a6a1f1dSLionel Sambucspecifies the ELF symbol index of the symbol to be used for 76*0a6a1f1dSLionel Sambucrelocation. 77*0a6a1f1dSLionel Sambuc.Pp 78*0a6a1f1dSLionel SambucIf argument 79*0a6a1f1dSLionel Sambuc.Ar err 80*0a6a1f1dSLionel Sambucis not NULL, it will be used to store error information in case 81*0a6a1f1dSLionel Sambucof an error. 82*0a6a1f1dSLionel Sambuc.Pp 83*0a6a1f1dSLionel SambucFunction 84*0a6a1f1dSLionel Sambuc.Fn dwarf_add_expr_addr 85*0a6a1f1dSLionel Sambucis deprecated. 86*0a6a1f1dSLionel SambucIt is similar to function 87*0a6a1f1dSLionel Sambuc.Fn dwarf_add_expr_addr_b 88*0a6a1f1dSLionel Sambucexcept that it cannot handle all possible symbol index values. 89*0a6a1f1dSLionel Sambuc.Sh RETURN VALUES 90*0a6a1f1dSLionel SambucOn success, these functions return the size in bytes of the location 91*0a6a1f1dSLionel Sambucexpression byte stream generated. 92*0a6a1f1dSLionel SambucIn case of an error, these functions return 93*0a6a1f1dSLionel Sambuc.Dv DW_DLV_NOCOUNT 94*0a6a1f1dSLionel Sambucand set the argument 95*0a6a1f1dSLionel Sambuc.Ar err . 96*0a6a1f1dSLionel Sambuc.Sh ERRORS 97*0a6a1f1dSLionel SambucThese functions can fail with: 98*0a6a1f1dSLionel Sambuc.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 99*0a6a1f1dSLionel Sambuc.It Bq Er DW_DLE_ARGUMENT 100*0a6a1f1dSLionel SambucArgument 101*0a6a1f1dSLionel Sambuc.Ar expr 102*0a6a1f1dSLionel Sambucwas NULL. 103*0a6a1f1dSLionel Sambuc.It Bq Er DW_DLE_MEMORY 104*0a6a1f1dSLionel SambucAn out of memory condition was encountered during the execution of 105*0a6a1f1dSLionel Sambucthe function. 106*0a6a1f1dSLionel Sambuc.El 107*0a6a1f1dSLionel Sambuc.Sh SEE ALSO 108*0a6a1f1dSLionel Sambuc.Xr dwarf 3 , 109*0a6a1f1dSLionel Sambuc.Xr dwarf_add_AT_location_expr 3 , 110*0a6a1f1dSLionel Sambuc.Xr dwarf_add_expr_gen 3 , 111*0a6a1f1dSLionel Sambuc.Xr dwarf_expr_current_offset 3 , 112*0a6a1f1dSLionel Sambuc.Xr dwarf_expr_into_block 3 , 113*0a6a1f1dSLionel Sambuc.Xr dwarf_new_expr 3 114