xref: /netbsd-src/external/bsd/elftoolchain/dist/libdwarf/dwarf_vendor_ext.3 (revision 5ac3bc719ce6e70593039505b491894133237d12)
1.\"	$NetBSD: dwarf_vendor_ext.3,v 1.6 2024/03/03 17:37:32 christos Exp $
2.\"
3.\" Copyright (c) 2011 Kai Wang
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.\" Id: dwarf_vendor_ext.3 3963 2022-03-12 16:07:32Z jkoshy
28.\"
29.Dd September 25, 2011
30.Dt DWARF_VENDOR_EXT 3
31.Os
32.Sh NAME
33.Nm dwarf_vendor_ext
34.Nd add vendor-specific macro information to a DWARF producer instance
35.Sh LIBRARY
36.Lb libdwarf
37.Sh SYNOPSIS
38.In libdwarf.h
39.Ft "int"
40.Fo dwarf_vendor_ext
41.Fa "Dwarf_P_Debug dbg"
42.Fa "Dwarf_Unsigned constant"
43.Fa "char *string"
44.Fa "Dwarf_Error *err"
45.Fc
46.Sh DESCRIPTION
47Function
48.Fn dwarf_vendor_ext
49adds a vendor-specific macro information entry to a DWARF producer
50instance.
51.Pp
52Argument
53.Fa dbg
54should reference a DWARF producer instance allocated using
55.Xr dwarf_producer_init 3
56or
57.Xr dwarf_producer_init_b 3 .
58.Pp
59Argument
60.Fa constant
61specifies a constant value for the macro information entry.
62.Pp
63Argument
64.Fa string
65point to a NUL-terminated string containing the string value
66for the macro information entry.
67.Pp
68If argument
69.Fa err
70is not
71.Dv NULL ,
72it will be used to store error information in case of an error.
73.Pp
74The meaning of the arguments
75.Fa constant
76and
77.Fa string
78are not defined by the DWARF specification, but are instead governed
79by application and vendor conventions.
80.Sh RETURN VALUES
81On success, function
82.Fn dwarf_vendor_ext
83returns
84.Dv DW_DLV_OK .
85In case of an error, function
86.Fn dwarf_vendor_ext
87returns
88.Dv DW_DLV_ERROR
89and sets the argument
90.Fa err .
91.Sh ERRORS
92Function
93.Fn dwarf_vendor_ext
94can fail with:
95.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
96.It Bq Er DW_DLE_ARGUMENT
97Either arguments
98.Fa dbg
99or
100.Fa string
101was
102.Dv NULL .
103.It Bq Er DW_DLE_MEMORY
104An out of memory condition was encountered during the execution of the
105function.
106.El
107.Sh SEE ALSO
108.Xr dwarf 3 ,
109.Xr dwarf_def_macro 3 ,
110.Xr dwarf_end_macro_file 3 ,
111.Xr dwarf_producer_init 3 ,
112.Xr dwarf_producer_init_b 3 ,
113.Xr dwarf_start_macro_file 3 ,
114.Xr dwarf_undef_macro 3
115