xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_formudata.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_formudata.3 3640 2018-10-14 14:09:13Z jkoshy $
262de3b87aSKai Wang.\"
272de3b87aSKai Wang.Dd June 21, 2010
282de3b87aSKai Wang.Dt DWARF_FORMUDATA 3
29*ae500c1fSEd Maste.Os
302de3b87aSKai Wang.Sh NAME
312de3b87aSKai Wang.Nm dwarf_formudata ,
322de3b87aSKai Wang.Nm dwarf_formsdata
332de3b87aSKai Wang.Nd return the value of a CONSTANT class attribute
342de3b87aSKai Wang.Sh LIBRARY
352de3b87aSKai Wang.Lb libdwarf
362de3b87aSKai Wang.Sh SYNOPSIS
372de3b87aSKai Wang.In libdwarf.h
382de3b87aSKai Wang.Ft int
392de3b87aSKai Wang.Fo dwarf_formudata
402de3b87aSKai Wang.Fa "Dwarf_Attribute attr"
412de3b87aSKai Wang.Fa "Dwarf_Unsigned *ret"
422de3b87aSKai Wang.Fa "Dwarf_Error *err"
432de3b87aSKai Wang.Fc
442de3b87aSKai Wang.Ft int
452de3b87aSKai Wang.Fo dwarf_formsdata
462de3b87aSKai Wang.Fa "Dwarf_Attribute attr"
472de3b87aSKai Wang.Fa "Dwarf_Signed *ret"
482de3b87aSKai Wang.Fa "Dwarf_Error *err"
492de3b87aSKai Wang.Fc
502de3b87aSKai Wang.Sh DESCRIPTION
512de3b87aSKai WangThese functions return the value associated with a DWARF attribute
522de3b87aSKai Wangdescribing a constant.
532de3b87aSKai Wang.Pp
542de3b87aSKai WangFunction
552de3b87aSKai Wang.Fn dwarf_formudata
562de3b87aSKai Wangsets the location pointed to by argument
572de3b87aSKai Wang.Ar ret
582de3b87aSKai Wangto the value of the attribute referenced by argument
592de3b87aSKai Wang.Ar attr ,
602de3b87aSKai Wangtreating the value as an unsigned quantity.
612de3b87aSKai WangArgument
622de3b87aSKai Wang.Ar attr
632de3b87aSKai Wangmust have one of the following forms:
642de3b87aSKai Wang.Dv DW_FORM_data1 ,
652de3b87aSKai Wang.Dv DW_FORM_data2 ,
662de3b87aSKai Wang.Dv DW_FORM_data4 ,
672de3b87aSKai Wang.Dv DW_FORM_data8
682de3b87aSKai Wangand
692de3b87aSKai Wang.Dv DW_FORM_udata .
702de3b87aSKai Wang.Pp
712de3b87aSKai WangFunction
722de3b87aSKai Wang.Fn dwarf_formsdata
732de3b87aSKai Wangsets the location pointed to by argument
742de3b87aSKai Wang.Ar ret
752de3b87aSKai Wangto the value of the attribute referenced by argument
762de3b87aSKai Wang.Ar attr ,
772de3b87aSKai Wangappropriately sign extended.
782de3b87aSKai WangArgument
792de3b87aSKai Wang.Ar attr
802de3b87aSKai Wangmust have one of the following forms:
812de3b87aSKai Wang.Dv DW_FORM_data1 ,
822de3b87aSKai Wang.Dv DW_FORM_data2 ,
832de3b87aSKai Wang.Dv DW_FORM_data4 ,
842de3b87aSKai Wang.Dv DW_FORM_data8
852de3b87aSKai Wangand
862de3b87aSKai Wang.Dv DW_FORM_sdata .
872de3b87aSKai Wang.Pp
882de3b87aSKai WangIf argument
892de3b87aSKai Wang.Ar err
902de3b87aSKai Wangis not NULL, it will be used to return an error descriptor in case
912de3b87aSKai Wangof an error.
922de3b87aSKai Wang.Sh RETURN VALUES
932de3b87aSKai WangThese functions return
942de3b87aSKai Wang.Dv DW_DLV_OK
952de3b87aSKai Wangon success.
962de3b87aSKai WangIn case of an error, they return
972de3b87aSKai Wang.Dv DW_DLV_ERROR
982de3b87aSKai Wangand set argument
992de3b87aSKai Wang.Ar err .
1002de3b87aSKai Wang.Sh ERRORS
1012de3b87aSKai WangThese functions may fail with the following errors:
1022de3b87aSKai Wang.Bl -tag -width ".Bq Er DW_DLE_ATTR_FORM_BAD"
1032de3b87aSKai Wang.It Bq Er DW_DLE_ARGUMENT
1042de3b87aSKai WangEither of arguments
1052de3b87aSKai Wang.Ar attr
1062de3b87aSKai Wangor
1072de3b87aSKai Wang.Ar ret
1082de3b87aSKai Wangwas NULL.
1092de3b87aSKai Wang.It Bq Er DW_DLE_ATTR_FORM_BAD
1102de3b87aSKai WangThe attribute referenced by argument
1112de3b87aSKai Wang.Ar attr
1122de3b87aSKai Wangwas not of a permitted kind.
1132de3b87aSKai Wang.El
1142de3b87aSKai Wang.Sh SEE ALSO
1152de3b87aSKai Wang.Xr dwarf 3 ,
1162de3b87aSKai Wang.Xr dwarf_attr 3 ,
1172de3b87aSKai Wang.Xr dwarf_formblock 3 ,
1182de3b87aSKai Wang.Xr dwarf_formflag 3 ,
1192de3b87aSKai Wang.Xr dwarf_formref 3 ,
1202de3b87aSKai Wang.Xr dwarf_formsig8 3 ,
1212de3b87aSKai Wang.Xr dwarf_formstring 3 ,
1222de3b87aSKai Wang.Xr dwarf_hasattr 3
123