xref: /freebsd-src/contrib/elftoolchain/libdwarf/dwarf_add_AT_const_value_string.3 (revision ae500c1ff8974130f7f2692772cf288b90349e0d)

.\" Copyright (c) 2011 Kai Wang
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: dwarf_add_AT_const_value_string.3 3640 2018-10-14 14:09:13Z jkoshy $
.\"
.Dd September 4, 2011
.Dt DWARF_ADD_AT_CONST_VALUE_STRING 3
.Os
.Sh NAME
.Nm dwarf_add_AT_const_value_signedint ,
.Nm dwarf_add_AT_const_value_string ,
.Nm dwarf_add_AT_const_value_unsignedint
.Nd create and attach a DW_AT_const_value attribute
.Sh LIBRARY
.Lb libdwarf
.Sh SYNOPSIS
.In libdwarf.h
.Ft Dwarf_P_Attribute
.Fo dwarf_add_AT_const_value_signedint
.Fa "Dwarf_P_Die die"
.Fa "Dwarf_Signed value"
.Fa "Dwarf_Error *err"
.Fc
.Ft Dwarf_P_Attribute
.Fo dwarf_add_AT_const_value_string
.Fa "Dwarf_P_Die die"
.Fa "char *str"
.Fa "Dwarf_Error *err"
.Fc
.Ft Dwarf_P_Attribute
.Fo dwarf_add_AT_const_value_unsignedint
.Fa "Dwarf_P_Die die"
.Fa "Dwarf_Unsigned value"
.Fa "Dwarf_Error *err"
.Fc
.Sh DESCRIPTION
These functions create a
.Dv DW_AT_const_value
attribute descriptor and attach it to the debugging information entry
referenced by argument
.Ar die .
.Pp
Argument
.Ar die
should reference a debugging information entry allocated using
.Xr dwarf_new_die 3 .
.Pp
Function
.Fn dwarf_add_AT_const_value_signedint
creates a
.Dv DW_AT_const_value
attribute descriptor containing the signed value specified by argument
.Ar value .
The created attribute descriptor will have DWARF form
.Dv DW_FORM_sdata .
.Pp
Function
.Fn dwarf_add_AT_const_value_unsignedint
creates a
.Dv DW_AT_const_value
attribute descriptor containing the unsigned value specified by
argument
.Ar value .
The created attribute descriptor will have DWARF form
.Dv DW_FORM_udata .
.Pp
Function
.Fn dwarf_add_AT_const_value_string
creates a
.Dv DW_AT_const_value
attribute descriptor containing the string pointed to by the
NUL-terminated argument
.Ar str .
The created attribute descriptor will have DWARF form
.Dv DW_FORM_strp .
.Pp
If argument
.Ar err
is not NULL, it will be used by these functions to store error
information in case of an error.
.Sh RETURN VALUES
On success, these functions return the created attribute descriptor.
In case of an error, these functions return
.Dv DW_DLV_BADADDR
and set the argument
.Ar err .
.Sh ERRORS
These functions can fail with:
.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
.It Bq Er DW_DLE_ARGUMENT
Either of the arguments
.Ar die
or
.Ar str
was NULL.
.It Bq Er DW_DLE_MEMORY
An out of memory condition was encountered during execution.
.El
.Sh SEE ALSO
.Xr dwarf 3 ,
.Xr dwarf_add_AT_name 3 ,
.Xr dwarf_add_AT_signed_const 3 ,
.Xr dwarf_add_AT_string 3 ,
.Xr dwarf_add_AT_unsigned_const 3 ,
.Xr dwarf_new_die 3