xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_vendor_ext.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_vendor_ext.3 3640 2018-10-14 14:09:13Z jkoshy $
.\"
.Dd September 25, 2011
.Dt DWARF_VENDOR_EXT 3
.Os
.Sh NAME
.Nm dwarf_vendor_ext
.Nd add vendor-specific macro information to a DWARF producer instance
.Sh LIBRARY
.Lb libdwarf
.Sh SYNOPSIS
.In libdwarf.h
.Ft "int"
.Fo dwarf_vendor_ext
.Fa "Dwarf_P_Debug dbg"
.Fa "Dwarf_Unsigned constant"
.Fa "char *string"
.Fa "Dwarf_Error *err"
.Fc
.Sh DESCRIPTION
Function
.Fn dwarf_vendor_ext
adds a vendor-specific macro information entry to a DWARF producer
instance.
.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 constant
specifies a constant value for the macro information entry.
.Pp
Argument
.Ar string
point to a NUL-terminated string containing the string value
for the macro information entry.
.Pp
If argument
.Ar err
is not NULL, it will be used to store error information in case of an
error.
.Pp
The meaning of the arguments
.Ar constant
and
.Ar string
are not defined by the DWARF specification, but are instead governed
by application and vendor conventions.
.Sh RETURN VALUES
On success, function
.Fn dwarf_vendor_ext
returns
.Dv DW_DLV_OK .
In case of an error, function
.Fn dwarf_vendor_ext
returns
.Dv DW_DLV_ERROR
and sets the argument
.Ar err .
.Sh ERRORS
Function
.Fn dwarf_vendor_ext
can fail with:
.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
.It Bq Er DW_DLE_ARGUMENT
Either arguments
.Ar dbg
or
.Ar string
was NULL.
.It Bq Er DW_DLE_MEMORY
An out of memory condition was encountered during the execution of the
function.
.El
.Sh SEE ALSO
.Xr dwarf 3 ,
.Xr dwarf_def_macro 3 ,
.Xr dwarf_end_macro_file 3 ,
.Xr dwarf_producer_init 3 ,
.Xr dwarf_producer_init_b 3 ,
.Xr dwarf_start_macro_file 3 ,
.Xr dwarf_undef_macro 3