1*0a6a1f1dSLionel Sambuc.\" $NetBSD: dwarf_attr.3,v 1.2 2014/03/09 16:58:03 christos Exp $ 2*0a6a1f1dSLionel Sambuc.\" 3*0a6a1f1dSLionel Sambuc.\" Copyright (c) 2010 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_attr.3 2072 2011-10-27 03:26:49Z jkoshy 28*0a6a1f1dSLionel Sambuc.\" 29*0a6a1f1dSLionel Sambuc.Dd April 8, 2010 30*0a6a1f1dSLionel Sambuc.Os 31*0a6a1f1dSLionel Sambuc.Dt DWARF_ATTR 3 32*0a6a1f1dSLionel Sambuc.Sh NAME 33*0a6a1f1dSLionel Sambuc.Nm dwarf_attr 34*0a6a1f1dSLionel Sambuc.Nd retrieve an attribute descriptor associated with a DWARF debugging information entry 35*0a6a1f1dSLionel Sambuc.Sh LIBRARY 36*0a6a1f1dSLionel Sambuc.Lb libdwarf 37*0a6a1f1dSLionel Sambuc.Sh SYNOPSIS 38*0a6a1f1dSLionel Sambuc.In libdwarf.h 39*0a6a1f1dSLionel Sambuc.Ft int 40*0a6a1f1dSLionel Sambuc.Fo dwarf_attr 41*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Die die" 42*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Half attr" 43*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Attribute *atp" 44*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Error *err" 45*0a6a1f1dSLionel Sambuc.Fc 46*0a6a1f1dSLionel Sambuc.Sh DESCRIPTION 47*0a6a1f1dSLionel SambucFunction 48*0a6a1f1dSLionel Sambuc.Fn dwarf_attr 49*0a6a1f1dSLionel Sambucretrieves the attribute descriptor for an attribute associated 50*0a6a1f1dSLionel Sambucwith the DWARF debugging information entry descriptor in 51*0a6a1f1dSLionel Sambucargument 52*0a6a1f1dSLionel Sambuc.Ar die . 53*0a6a1f1dSLionel Sambuc.Pp 54*0a6a1f1dSLionel SambucDWARF attribute descriptors are represented by value of the opaque 55*0a6a1f1dSLionel Sambuctype 56*0a6a1f1dSLionel Sambuc.Vt Dwarf_Attribute , 57*0a6a1f1dSLionel Sambucsee 58*0a6a1f1dSLionel Sambuc.Xr dwarf 3 . 59*0a6a1f1dSLionel Sambuc.Pp 60*0a6a1f1dSLionel SambucArgument 61*0a6a1f1dSLionel Sambuc.Ar attr 62*0a6a1f1dSLionel Sambucnames the desired DWARF attribute. 63*0a6a1f1dSLionel SambucLegal values for argument 64*0a6a1f1dSLionel Sambuc.Ar attr 65*0a6a1f1dSLionel Sambucare those denoted by the 66*0a6a1f1dSLionel Sambuc.Dv DW_AT_* 67*0a6a1f1dSLionel Sambucconstants in the DWARF specification. 68*0a6a1f1dSLionel Sambuc.Pp 69*0a6a1f1dSLionel SambucArgument 70*0a6a1f1dSLionel Sambuc.Ar atp 71*0a6a1f1dSLionel Sambucpoints to a location into which the returned attribute descriptor 72*0a6a1f1dSLionel Sambucwill be written. 73*0a6a1f1dSLionel SambucThe returned descriptor may then be passed to the form query functions in the 74*0a6a1f1dSLionel Sambuc.Xr dwarf 3 75*0a6a1f1dSLionel SambucAPI set to access the data associated with the attribute. 76*0a6a1f1dSLionel Sambuc.Pp 77*0a6a1f1dSLionel SambucIf argument 78*0a6a1f1dSLionel Sambuc.Ar err 79*0a6a1f1dSLionel Sambucis non-NULL, it will be used to return an error descriptor in case 80*0a6a1f1dSLionel Sambucof an error. 81*0a6a1f1dSLionel Sambuc.Sh RETURN VALUES 82*0a6a1f1dSLionel SambucFunction 83*0a6a1f1dSLionel Sambuc.Fn dwarf_attr 84*0a6a1f1dSLionel Sambucreturns 85*0a6a1f1dSLionel Sambuc.Dv DW_DLV_OK on success. 86*0a6a1f1dSLionel Sambuc.Pp 87*0a6a1f1dSLionel SambucIf the debugging information entry descriptor denoted by argument 88*0a6a1f1dSLionel Sambuc.Ar die 89*0a6a1f1dSLionel Sambucdoes not contain the named attribute, the function returns 90*0a6a1f1dSLionel Sambuc.Dv DW_DLV_NO_ENTRY 91*0a6a1f1dSLionel Sambucand sets argument 92*0a6a1f1dSLionel Sambuc.Ar err . 93*0a6a1f1dSLionel SambucFor other errors, it returns 94*0a6a1f1dSLionel Sambuc.Dv DW_DLV_ERROR 95*0a6a1f1dSLionel Sambucand sets argument 96*0a6a1f1dSLionel Sambuc.Ar err . 97*0a6a1f1dSLionel Sambuc.Sh ERRORS 98*0a6a1f1dSLionel SambucFunction 99*0a6a1f1dSLionel Sambuc.Fn dwarf_attr 100*0a6a1f1dSLionel Sambuccan fail with the following errors: 101*0a6a1f1dSLionel Sambuc.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 102*0a6a1f1dSLionel Sambuc.It Bq Er DW_DLE_ARGUMENT 103*0a6a1f1dSLionel SambucEither of arguments 104*0a6a1f1dSLionel Sambuc.Ar die 105*0a6a1f1dSLionel Sambucor 106*0a6a1f1dSLionel Sambuc.Ar atp 107*0a6a1f1dSLionel Sambucwas NULL. 108*0a6a1f1dSLionel Sambuc.It Bq Er DW_DLE_NO_ENTRY 109*0a6a1f1dSLionel SambucArgument 110*0a6a1f1dSLionel Sambuc.Ar die 111*0a6a1f1dSLionel Sambuchad no attribute corresponding to the value 112*0a6a1f1dSLionel Sambucin argument 113*0a6a1f1dSLionel Sambuc.Ar attr . 114*0a6a1f1dSLionel Sambuc.El 115*0a6a1f1dSLionel Sambuc.Sh SEE ALSO 116*0a6a1f1dSLionel Sambuc.Xr dwarf 3 , 117*0a6a1f1dSLionel Sambuc.Xr dwarf_attrlist 3 , 118*0a6a1f1dSLionel Sambuc.Xr dwarf_hasattr 3 , 119*0a6a1f1dSLionel Sambuc.Xr dwarf_hasform 3 , 120*0a6a1f1dSLionel Sambuc.Xr dwarf_whatattr 3 , 121*0a6a1f1dSLionel Sambuc.Xr dwarf_whatform 3 122