xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_add_AT_producer.3 (revision 2de3b87a120614a3b053be7dd845b72f1e9ce804)
1*2de3b87aSKai Wang.\" Copyright (c) 2011 Kai Wang
2*2de3b87aSKai Wang.\" All rights reserved.
3*2de3b87aSKai Wang.\"
4*2de3b87aSKai Wang.\" Redistribution and use in source and binary forms, with or without
5*2de3b87aSKai Wang.\" modification, are permitted provided that the following conditions
6*2de3b87aSKai Wang.\" are met:
7*2de3b87aSKai Wang.\" 1. Redistributions of source code must retain the above copyright
8*2de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer.
9*2de3b87aSKai Wang.\" 2. Redistributions in binary form must reproduce the above copyright
10*2de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer in the
11*2de3b87aSKai Wang.\"    documentation and/or other materials provided with the distribution.
12*2de3b87aSKai Wang.\"
13*2de3b87aSKai Wang.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14*2de3b87aSKai Wang.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15*2de3b87aSKai Wang.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16*2de3b87aSKai Wang.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17*2de3b87aSKai Wang.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18*2de3b87aSKai Wang.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19*2de3b87aSKai Wang.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20*2de3b87aSKai Wang.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21*2de3b87aSKai Wang.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22*2de3b87aSKai Wang.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23*2de3b87aSKai Wang.\" SUCH DAMAGE.
24*2de3b87aSKai Wang.\"
25*2de3b87aSKai Wang.\" $Id: dwarf_add_AT_producer.3 2072 2011-10-27 03:26:49Z jkoshy $
26*2de3b87aSKai Wang.\"
27*2de3b87aSKai Wang.Dd September 4, 2011
28*2de3b87aSKai Wang.Os
29*2de3b87aSKai Wang.Dt DWARF_ADD_AT_PRODUCER 3
30*2de3b87aSKai Wang.Sh NAME
31*2de3b87aSKai Wang.Nm dwarf_add_AT_producer
32*2de3b87aSKai Wang.Nd create and attach a DW_AT_producer attribute
33*2de3b87aSKai Wang.Sh LIBRARY
34*2de3b87aSKai Wang.Lb libdwarf
35*2de3b87aSKai Wang.Sh SYNOPSIS
36*2de3b87aSKai Wang.In libdwarf.h
37*2de3b87aSKai Wang.Ft Dwarf_P_Attribute
38*2de3b87aSKai Wang.Fo dwarf_add_AT_producer
39*2de3b87aSKai Wang.Fa "Dwarf_P_Die die"
40*2de3b87aSKai Wang.Fa "char *producer"
41*2de3b87aSKai Wang.Fa "Dwarf_Error *err"
42*2de3b87aSKai Wang.Fc
43*2de3b87aSKai Wang.Sh DESCRIPTION
44*2de3b87aSKai WangFunction
45*2de3b87aSKai Wang.Fn dwarf_add_AT_producer
46*2de3b87aSKai Wangcreates a
47*2de3b87aSKai Wang.Dv DW_AT_producer
48*2de3b87aSKai Wangattribute descriptor and attaches it to the debugging information
49*2de3b87aSKai Wangentry referenced by argument
50*2de3b87aSKai Wang.Ar die .
51*2de3b87aSKai WangThe created attribute will have DWARF form
52*2de3b87aSKai Wang.Dv DW_FORM_strp .
53*2de3b87aSKai Wang.Pp
54*2de3b87aSKai WangArgument
55*2de3b87aSKai Wang.Ar die
56*2de3b87aSKai Wangshould reference a debugging information entry allocated using
57*2de3b87aSKai Wang.Xr dwarf_new_die 3 .
58*2de3b87aSKai Wang.Pp
59*2de3b87aSKai WangArgument
60*2de3b87aSKai Wang.Ar producer
61*2de3b87aSKai Wangshould point to a NUL-terminated string which will become the value of
62*2de3b87aSKai Wangthe created attribute.
63*2de3b87aSKai Wang.Pp
64*2de3b87aSKai WangIf argument
65*2de3b87aSKai Wang.Ar err
66*2de3b87aSKai Wangis not NULL, it will be used to store error information in case
67*2de3b87aSKai Wangof an error.
68*2de3b87aSKai Wang.Sh RETURN VALUES
69*2de3b87aSKai WangOn success, function
70*2de3b87aSKai Wang.Fn dwarf_add_AT_producer
71*2de3b87aSKai Wangreturns the created attribute descriptor.
72*2de3b87aSKai WangIn case of an error, function
73*2de3b87aSKai Wang.Fn dwarf_add_AT_producer
74*2de3b87aSKai Wangreturns
75*2de3b87aSKai Wang.Dv DW_DLV_BADADDR
76*2de3b87aSKai Wangand sets the argument
77*2de3b87aSKai Wang.Ar err .
78*2de3b87aSKai Wang.Sh ERRORS
79*2de3b87aSKai WangFunction
80*2de3b87aSKai Wang.Fn dwarf_add_AT_producer
81*2de3b87aSKai Wangcan fail with:
82*2de3b87aSKai Wang.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
83*2de3b87aSKai Wang.It Bq Er DW_DLE_ARGUMENT
84*2de3b87aSKai WangEither of the arguments
85*2de3b87aSKai Wang.Ar die
86*2de3b87aSKai Wangor
87*2de3b87aSKai Wang.Ar producer
88*2de3b87aSKai Wangwas NULL.
89*2de3b87aSKai Wang.It Bq Er DW_DLE_MEMORY
90*2de3b87aSKai WangAn out of memory condition was encountered during the execution of
91*2de3b87aSKai Wangthe function.
92*2de3b87aSKai Wang.El
93*2de3b87aSKai Wang.Sh SEE ALSO
94*2de3b87aSKai Wang.Xr dwarf 3 ,
95*2de3b87aSKai Wang.Xr dwarf_add_AT_comp_dir 3 ,
96*2de3b87aSKai Wang.Xr dwarf_add_AT_const_value_string 3 ,
97*2de3b87aSKai Wang.Xr dwarf_add_AT_name 3 ,
98*2de3b87aSKai Wang.Xr dwarf_add_AT_string 3 ,
99*2de3b87aSKai Wang.Xr dwarf_new_die 3
100