xref: /netbsd-src/external/bsd/elftoolchain/dist/libdwarf/dwarf_hasattr.3 (revision 5ac3bc719ce6e70593039505b491894133237d12)
1*5ac3bc71Schristos.\"	$NetBSD: dwarf_hasattr.3,v 1.6 2024/03/03 17:37:31 christos Exp $
2e81373b4Schristos.\"
39dd9d0cfSchristos.\" Copyright (c) 2010 Kai Wang
49dd9d0cfSchristos.\" All rights reserved.
59dd9d0cfSchristos.\"
69dd9d0cfSchristos.\" Redistribution and use in source and binary forms, with or without
79dd9d0cfSchristos.\" modification, are permitted provided that the following conditions
89dd9d0cfSchristos.\" are met:
99dd9d0cfSchristos.\" 1. Redistributions of source code must retain the above copyright
109dd9d0cfSchristos.\"    notice, this list of conditions and the following disclaimer.
119dd9d0cfSchristos.\" 2. Redistributions in binary form must reproduce the above copyright
129dd9d0cfSchristos.\"    notice, this list of conditions and the following disclaimer in the
139dd9d0cfSchristos.\"    documentation and/or other materials provided with the distribution.
149dd9d0cfSchristos.\"
159dd9d0cfSchristos.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
169dd9d0cfSchristos.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
179dd9d0cfSchristos.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
189dd9d0cfSchristos.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
199dd9d0cfSchristos.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
209dd9d0cfSchristos.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
219dd9d0cfSchristos.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
229dd9d0cfSchristos.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
239dd9d0cfSchristos.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
249dd9d0cfSchristos.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
259dd9d0cfSchristos.\" SUCH DAMAGE.
269dd9d0cfSchristos.\"
27cdbf1fe1Sjkoshy.\" Id: dwarf_hasattr.3 3963 2022-03-12 16:07:32Z jkoshy
289dd9d0cfSchristos.\"
299dd9d0cfSchristos.Dd April 17, 2010
309dd9d0cfSchristos.Dt DWARF_HASATTR 3
31604b0842Sjkoshy.Os
329dd9d0cfSchristos.Sh NAME
339dd9d0cfSchristos.Nm dwarf_hasattr
349dd9d0cfSchristos.Nd check for the presence of an attribute
359dd9d0cfSchristos.Sh LIBRARY
369dd9d0cfSchristos.Lb libdwarf
379dd9d0cfSchristos.Sh SYNOPSIS
389dd9d0cfSchristos.In libdwarf.h
399dd9d0cfSchristos.Ft int
409dd9d0cfSchristos.Fo dwarf_hasattr
419dd9d0cfSchristos.Fa "Dwarf_Die die"
429dd9d0cfSchristos.Fa "Dwarf_Half attr"
439dd9d0cfSchristos.Fa "Dwarf_Bool *ret_bool"
449dd9d0cfSchristos.Fa "Dwarf_Error *err"
459dd9d0cfSchristos.Fc
469dd9d0cfSchristos.Sh DESCRIPTION
479dd9d0cfSchristosFunction
489dd9d0cfSchristos.Fn dwarf_hasattr
499dd9d0cfSchristostests whether the debugging information entry referenced in argument
50cdbf1fe1Sjkoshy.Fa die
519dd9d0cfSchristoscontains the attribute named by argument
52cdbf1fe1Sjkoshy.Fa attr .
539dd9d0cfSchristosLegal values for argument
54cdbf1fe1Sjkoshy.Fa attr
559dd9d0cfSchristosare those denoted by the
569dd9d0cfSchristos.Dv DW_AT_*
579dd9d0cfSchristosconstants in the DWARF specification.
589dd9d0cfSchristos.Pp
599dd9d0cfSchristosIf the named attribute is present in the debugging information entry,
609dd9d0cfSchristosfunction
619dd9d0cfSchristos.Fn dwarf_hasattr
629dd9d0cfSchristosreturns a non-zero value in the location pointed to by argument
63cdbf1fe1Sjkoshy.Fa ret_bool .
649dd9d0cfSchristosIf the named attribute is not present, a zero is written instead.
659dd9d0cfSchristos.Pp
669dd9d0cfSchristosIf argument
67cdbf1fe1Sjkoshy.Fa err
68cdbf1fe1Sjkoshyis not
69cdbf1fe1Sjkoshy.Dv NULL ,
70cdbf1fe1Sjkoshyit will be used to return an error descriptor in case of an error.
719dd9d0cfSchristos.Sh RETURN VALUES
729dd9d0cfSchristosOn success, function
739dd9d0cfSchristos.Fn dwarf_hasattr
749dd9d0cfSchristosreturns
759dd9d0cfSchristos.Dv DW_DLV_OK .
769dd9d0cfSchristosIn case of an error, it returns
779dd9d0cfSchristos.Dv DW_DLV_ERROR
789dd9d0cfSchristosand sets argument
79cdbf1fe1Sjkoshy.Fa err .
809dd9d0cfSchristos.Sh ERRORS
819dd9d0cfSchristosFunction
829dd9d0cfSchristos.Fn dwarf_hasattr
839dd9d0cfSchristoscan fail with the following error:
849dd9d0cfSchristos.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
859dd9d0cfSchristos.It Bq Er DW_DLE_ARGUMENT
869dd9d0cfSchristosEither of argument
879dd9d0cfSchristos.Va die
889dd9d0cfSchristosor
899dd9d0cfSchristos.Va ret_bool
90cdbf1fe1Sjkoshywas
91cdbf1fe1Sjkoshy.Dv NULL .
9242bd3019Schristos.El
939dd9d0cfSchristos.Sh SEE ALSO
949dd9d0cfSchristos.Xr dwarf 3 ,
959dd9d0cfSchristos.Xr dwarf_attr 3 ,
969dd9d0cfSchristos.Xr dwarf_whatattr 3
97