1*2de3b87aSKai Wang.\" Copyright (c) 2011 Kai Wang 2*2de3b87aSKai Wang.\" All rights reserved. 3*2de3b87aSKai Wang.\" 4*2de3b87aSKai Wang.\" Redistribution and use in source and binary forms, with or without 5*2de3b87aSKai Wang.\" modification, are permitted provided that the following conditions 6*2de3b87aSKai Wang.\" are met: 7*2de3b87aSKai Wang.\" 1. Redistributions of source code must retain the above copyright 8*2de3b87aSKai Wang.\" notice, this list of conditions and the following disclaimer. 9*2de3b87aSKai Wang.\" 2. Redistributions in binary form must reproduce the above copyright 10*2de3b87aSKai Wang.\" notice, this list of conditions and the following disclaimer in the 11*2de3b87aSKai Wang.\" documentation and/or other materials provided with the distribution. 12*2de3b87aSKai Wang.\" 13*2de3b87aSKai Wang.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14*2de3b87aSKai Wang.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15*2de3b87aSKai Wang.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16*2de3b87aSKai Wang.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17*2de3b87aSKai Wang.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18*2de3b87aSKai Wang.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19*2de3b87aSKai Wang.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20*2de3b87aSKai Wang.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21*2de3b87aSKai Wang.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22*2de3b87aSKai Wang.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23*2de3b87aSKai Wang.\" SUCH DAMAGE. 24*2de3b87aSKai Wang.\" 25*2de3b87aSKai Wang.\" $Id: dwarf_add_AT_reference.3 2072 2011-10-27 03:26:49Z jkoshy $ 26*2de3b87aSKai Wang.\" 27*2de3b87aSKai Wang.Dd September 4, 2011 28*2de3b87aSKai Wang.Os 29*2de3b87aSKai Wang.Dt DWARF_ADD_AT_REFERENCE 3 30*2de3b87aSKai Wang.Sh NAME 31*2de3b87aSKai Wang.Nm dwarf_add_AT_reference 32*2de3b87aSKai Wang.Nd create and attach an attribute that references another DIE 33*2de3b87aSKai Wang.Sh LIBRARY 34*2de3b87aSKai Wang.Lb libdwarf 35*2de3b87aSKai Wang.Sh SYNOPSIS 36*2de3b87aSKai Wang.In libdwarf.h 37*2de3b87aSKai Wang.Ft "Dwarf_P_Attribute" 38*2de3b87aSKai Wang.Fo dwarf_add_AT_reference 39*2de3b87aSKai Wang.Fa "Dwarf_P_Debug dbg" 40*2de3b87aSKai Wang.Fa "Dwarf_P_Die die" 41*2de3b87aSKai Wang.Fa "Dwarf_Half attr" 42*2de3b87aSKai Wang.Fa "Dwarf_P_Die ref_die" 43*2de3b87aSKai Wang.Fa "Dwarf_Error *err" 44*2de3b87aSKai Wang.Fc 45*2de3b87aSKai Wang.Sh DESCRIPTION 46*2de3b87aSKai WangFunction 47*2de3b87aSKai Wang.Fn dwarf_add_AT_reference 48*2de3b87aSKai Wangcreates an attribute descriptor that references another debugging 49*2de3b87aSKai Wanginformation entry in the same compilation unit. 50*2de3b87aSKai WangThe attribute will be of DWARF form 51*2de3b87aSKai Wang.Dv DW_FORM_ref4 52*2de3b87aSKai Wangor 53*2de3b87aSKai Wang.Dv DW_FORM_ref8 54*2de3b87aSKai Wangdepending on the target address size, and will contain the 55*2de3b87aSKai Wangsection-relative offset of the referenced debugging information entry 56*2de3b87aSKai Wangas its value. 57*2de3b87aSKai Wang.Pp 58*2de3b87aSKai WangArgument 59*2de3b87aSKai Wang.Ar dbg 60*2de3b87aSKai Wangshould reference a DWARF producer instance allocated using 61*2de3b87aSKai Wang.Xr dwarf_producer_init 3 62*2de3b87aSKai Wangor 63*2de3b87aSKai Wang.Xr dwarf_producer_init_b 3 . 64*2de3b87aSKai Wang.Pp 65*2de3b87aSKai WangArgument 66*2de3b87aSKai Wang.Ar die 67*2de3b87aSKai Wangshould reference a debugging information entry allocated using 68*2de3b87aSKai Wang.Xr dwarf_new_die 3 . 69*2de3b87aSKai Wang.Pp 70*2de3b87aSKai WangArgument 71*2de3b87aSKai Wang.Ar attr 72*2de3b87aSKai Wangshould specify the attribute code of the created attribute descriptor. 73*2de3b87aSKai Wang.Pp 74*2de3b87aSKai WangArgument 75*2de3b87aSKai Wang.Ar ref_die 76*2de3b87aSKai Wangshould hold the debugging information entry descriptor that 77*2de3b87aSKai Wangthe attribute should refer to. 78*2de3b87aSKai Wang.Pp 79*2de3b87aSKai WangIf argument 80*2de3b87aSKai Wang.Ar err 81*2de3b87aSKai Wangis not NULL, it will be used to store error information in case 82*2de3b87aSKai Wangof an error. 83*2de3b87aSKai Wang.Sh RETURN VALUES 84*2de3b87aSKai WangOn success, function 85*2de3b87aSKai Wang.Fn dwarf_add_AT_reference 86*2de3b87aSKai Wangreturns the created attribute descriptor. 87*2de3b87aSKai WangIn case of an error, function 88*2de3b87aSKai Wang.Fn dwarf_add_AT_reference 89*2de3b87aSKai Wangreturns 90*2de3b87aSKai Wang.Dv DW_DLV_BADADDR 91*2de3b87aSKai Wangand sets the argument 92*2de3b87aSKai Wang.Ar err . 93*2de3b87aSKai Wang.Sh ERRORS 94*2de3b87aSKai WangFunction 95*2de3b87aSKai Wang.Fn dwarf_add_AT_reference 96*2de3b87aSKai Wangcan fail with: 97*2de3b87aSKai Wang.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 98*2de3b87aSKai Wang.It Bq Er DW_DLE_ARGUMENT 99*2de3b87aSKai WangOne of the arguments 100*2de3b87aSKai Wang.Ar dbg , 101*2de3b87aSKai Wang.Ar die 102*2de3b87aSKai Wangor 103*2de3b87aSKai Wang.Ar ref_die 104*2de3b87aSKai Wangwas NULL. 105*2de3b87aSKai Wang.It Bq Er DW_DLE_MEMORY 106*2de3b87aSKai WangAn out of memory condition was encountered during the execution of 107*2de3b87aSKai Wangthe function. 108*2de3b87aSKai Wang.El 109*2de3b87aSKai Wang.Sh SEE ALSO 110*2de3b87aSKai Wang.Xr dwarf 3 , 111*2de3b87aSKai Wang.Xr dwarf_add_AT_dataref 3 , 112*2de3b87aSKai Wang.Xr dwarf_add_AT_ref_address 3 , 113*2de3b87aSKai Wang.Xr dwarf_add_AT_signed_const 3 , 114*2de3b87aSKai Wang.Xr dwarf_add_AT_unsigned_const 3 , 115*2de3b87aSKai Wang.Xr dwarf_new_die 3 , 116*2de3b87aSKai Wang.Xr dwarf_producer_init 3 , 117*2de3b87aSKai Wang.Xr dwarf_producer_init_b 3 118