1.\"	$NetBSD: dwarf_add_AT_producer.3,v 1.2 2014/03/09 16:58:03 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_add_AT_producer.3 2072 2011-10-27 03:26:49Z jkoshy
28.\"
29.Dd September 4, 2011
30.Os
31.Dt DWARF_ADD_AT_PRODUCER 3
32.Sh NAME
33.Nm dwarf_add_AT_producer
34.Nd create and attach a DW_AT_producer attribute
35.Sh LIBRARY
36.Lb libdwarf
37.Sh SYNOPSIS
38.In libdwarf.h
39.Ft Dwarf_P_Attribute
40.Fo dwarf_add_AT_producer
41.Fa "Dwarf_P_Die die"
42.Fa "char *producer"
43.Fa "Dwarf_Error *err"
44.Fc
45.Sh DESCRIPTION
46Function
47.Fn dwarf_add_AT_producer
48creates a
49.Dv DW_AT_producer
50attribute descriptor and attaches it to the debugging information
51entry referenced by argument
52.Ar die .
53The created attribute will have DWARF form
54.Dv DW_FORM_strp .
55.Pp
56Argument
57.Ar die
58should reference a debugging information entry allocated using
59.Xr dwarf_new_die 3 .
60.Pp
61Argument
62.Ar producer
63should point to a NUL-terminated string which will become the value of
64the created attribute.
65.Pp
66If argument
67.Ar err
68is not NULL, it will be used to store error information in case
69of an error.
70.Sh RETURN VALUES
71On success, function
72.Fn dwarf_add_AT_producer
73returns the created attribute descriptor.
74In case of an error, function
75.Fn dwarf_add_AT_producer
76returns
77.Dv DW_DLV_BADADDR
78and sets the argument
79.Ar err .
80.Sh ERRORS
81Function
82.Fn dwarf_add_AT_producer
83can fail with:
84.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
85.It Bq Er DW_DLE_ARGUMENT
86Either of the arguments
87.Ar die
88or
89.Ar producer
90was NULL.
91.It Bq Er DW_DLE_MEMORY
92An out of memory condition was encountered during the execution of
93the function.
94.El
95.Sh SEE ALSO
96.Xr dwarf 3 ,
97.Xr dwarf_add_AT_comp_dir 3 ,
98.Xr dwarf_add_AT_const_value_string 3 ,
99.Xr dwarf_add_AT_name 3 ,
100.Xr dwarf_add_AT_string 3 ,
101.Xr dwarf_new_die 3
102