xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_formaddr.3 (revision ae500c1ff8974130f7f2692772cf288b90349e0d)
12de3b87aSKai Wang.\" Copyright (c) 2010 Joseph Koshy
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_formaddr.3 3640 2018-10-14 14:09:13Z jkoshy $
262de3b87aSKai Wang.\"
272de3b87aSKai Wang.Dd July 23, 2010
282de3b87aSKai Wang.Dt DWARF_FORMADDR 3
29*ae500c1fSEd Maste.Os
302de3b87aSKai Wang.Sh NAME
312de3b87aSKai Wang.Nm dwarf_formaddr
322de3b87aSKai Wang.Nd return the value of an ADDRESS class attribute
332de3b87aSKai Wang.Sh LIBRARY
342de3b87aSKai Wang.Lb libdwarf
352de3b87aSKai Wang.Sh SYNOPSIS
362de3b87aSKai Wang.In libdwarf.h
372de3b87aSKai Wang.Ft int
382de3b87aSKai Wang.Fo dwarf_formaddr
392de3b87aSKai Wang.Fa "Dwarf_Attribute attr"
402de3b87aSKai Wang.Fa "Dwarf_Addr *ret"
412de3b87aSKai Wang.Fa "Dwarf_Error *err"
422de3b87aSKai Wang.Fc
432de3b87aSKai Wang.Sh DESCRIPTION
442de3b87aSKai WangFunction
452de3b87aSKai Wang.Fn dwarf_formaddr
462de3b87aSKai Wangsets the location pointed to by argument
472de3b87aSKai Wang.Ar ret
482de3b87aSKai Wangto the address represented by the attribute referenced
492de3b87aSKai Wangby argument
502de3b87aSKai Wang.Ar attr .
512de3b87aSKai WangThe form of argument
522de3b87aSKai Wang.Ar attr
532de3b87aSKai Wangmust be
542de3b87aSKai Wang.Dv DW_FORM_addr .
552de3b87aSKai Wang.Pp
562de3b87aSKai WangIf argument
572de3b87aSKai Wang.Ar err
582de3b87aSKai Wangis not NULL, it will be used to return an error descriptor in case
592de3b87aSKai Wangof an error.
602de3b87aSKai Wang.Sh RETURN VALUES
612de3b87aSKai WangFunction
622de3b87aSKai Wang.Fn dwarf_formaddr
632de3b87aSKai Wangreturns
642de3b87aSKai Wang.Dv DW_DLV_OK
652de3b87aSKai Wangon success.
662de3b87aSKai WangIn case of an error, it returns
672de3b87aSKai Wang.Dv DW_DLV_ERROR
682de3b87aSKai Wangand sets argument
692de3b87aSKai Wang.Ar err .
702de3b87aSKai Wang.Sh ERRORS
712de3b87aSKai WangFunction
722de3b87aSKai Wang.Fn dwarf_formblock
732de3b87aSKai Wangmay fail with the following errors:
742de3b87aSKai Wang.Bl -tag -width ".Bq Er DW_DLE_ATTR_FORM_BAD"
752de3b87aSKai Wang.It Bq Er DW_DLE_ARGUMENT
762de3b87aSKai WangEither of arguments
772de3b87aSKai Wang.Ar attr
782de3b87aSKai Wangor
792de3b87aSKai Wang.Ar ret
802de3b87aSKai Wangwas NULL.
812de3b87aSKai Wang.It Bq Er DW_DLE_ATTR_FORM_BAD
822de3b87aSKai WangThe attribute referenced by argument
832de3b87aSKai Wang.Ar attr
842de3b87aSKai Wangwas not of form
852de3b87aSKai Wang.Dv DW_FORM_addr .
862de3b87aSKai Wang.El
872de3b87aSKai Wang.Sh SEE ALSO
882de3b87aSKai Wang.Xr dwarf 3 ,
892de3b87aSKai Wang.Xr dwarf_attr 3 ,
902de3b87aSKai Wang.Xr dwarf_formblock 3 ,
912de3b87aSKai Wang.Xr dwarf_formflag 3 ,
922de3b87aSKai Wang.Xr dwarf_formref 3 ,
932de3b87aSKai Wang.Xr dwarf_formsdata 3 ,
942de3b87aSKai Wang.Xr dwarf_formsig8 3 ,
952de3b87aSKai Wang.Xr dwarf_formstring 3 ,
962de3b87aSKai Wang.Xr dwarf_formudata 3 ,
972de3b87aSKai Wang.Xr dwarf_hasattr 3
98