xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_add_AT_targ_address.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_targ_address.3 3640 2018-10-14 14:09:13Z jkoshy $
.\"
.Dd September 4, 2011
.Dt DWARF_ADD_AT_TARG_ADDRESS 3
.Os
.Sh NAME
.Nm dwarf_add_AT_targ_address ,
.Nm dwarf_add_AT_targ_address_b
.Nd create and attach address class attributes
.Sh LIBRARY
.Lb libdwarf
.Sh SYNOPSIS
.In libdwarf.h
.Ft Dwarf_P_Attribute
.Fo dwarf_add_AT_targ_address
.Fa "Dwarf_P_Debug dbg"
.Fa "Dwarf_P_Die die"
.Fa "Dwarf_Half attr"
.Fa "Dwarf_Unsigned pc_value"
.Fa "Dwarf_Signed sym_index"
.Fa "Dwarf_Error *err"
.Fc
.Ft Dwarf_P_Attribute
.Fo dwarf_add_AT_targ_address_b
.Fa "Dwarf_P_Debug dbg"
.Fa "Dwarf_P_Die die"
.Fa "Dwarf_Half attr"
.Fa "Dwarf_Unsigned pc_value"
.Fa "Dwarf_Unsigned sym_index"
.Fa "Dwarf_Error *err"
.Fc
.Sh DESCRIPTION
Function
.Fn dwarf_add_AT_targ_address_b
creates an attribute descriptor belonging to the
.Sq address
class and attaches it to the debugging information entry referenced by
argument
.Ar die .
.Pp
The created attribute descriptor will have DWARF form
.Dv DW_FORM_addr .
If flag
.Dv DW_DLC_SIZE_64
is set on the producer instance, the attribute value will be 8 bytes
in size.
Otherwise the attribute value will be 4 bytes in size.
.Pp
Argument
.Ar dbg
should reference a DWARF producer instance allocated using
.Xr dwarf_producer_init 3
or
.Xr dwarf_producer_init_b 3 .
.Pp
Argument
.Ar die
should reference a debugging information entry allocated using
.Xr dwarf_new_die 3 .
.Pp
Argument
.Ar attr
should specify the attribute code of the created attribute descriptor.
.Pp
Argument
.Ar pc_value
should hold a relocatable address value which will become the value of
the created attribute descriptor.
.Pp
Argument
.Ar sym_index
should specify the ELF symbol index of the symbol to be used for
relocating the address value.
.Pp
If argument
.Ar err
is not NULL, it will be used to store error information in case
of an error.
.Pp
Function
.Fn dwarf_add_AT_targ_address
is deprecated.
It is similar to function
.Fn dwarf_add_AT_targ_address_b
except that it cannot handle all possible symbol index values.
.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 sets 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 dbg
or
.Ar die
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_const_value_unsignedint 3 ,
.Xr dwarf_add_AT_dataref 3 ,
.Xr dwarf_add_AT_ref_address 3 ,
.Xr dwarf_add_AT_signed_const 3 ,
.Xr dwarf_add_AT_unsigned_const 3 ,
.Xr dwarf_new_die 3 ,
.Xr dwarf_producer_init 3 ,
.Xr dwarf_producer_init_b 3