xref: /netbsd-src/external/bsd/elftoolchain/dist/libdwarf/dwarf_add_AT_producer.3 (revision 5ac3bc719ce6e70593039505b491894133237d12)
1*5ac3bc71Schristos.\"	$NetBSD: dwarf_add_AT_producer.3,v 1.6 2024/03/03 17:37:30 christos Exp $
2e81373b4Schristos.\"
39dd9d0cfSchristos.\" Copyright (c) 2011 Kai Wang
49dd9d0cfSchristos.\" All rights reserved.
59dd9d0cfSchristos.\"
69dd9d0cfSchristos.\" Redistribution and use in source and binary forms, with or without
79dd9d0cfSchristos.\" modification, are permitted provided that the following conditions
89dd9d0cfSchristos.\" are met:
99dd9d0cfSchristos.\" 1. Redistributions of source code must retain the above copyright
109dd9d0cfSchristos.\"    notice, this list of conditions and the following disclaimer.
119dd9d0cfSchristos.\" 2. Redistributions in binary form must reproduce the above copyright
129dd9d0cfSchristos.\"    notice, this list of conditions and the following disclaimer in the
139dd9d0cfSchristos.\"    documentation and/or other materials provided with the distribution.
149dd9d0cfSchristos.\"
159dd9d0cfSchristos.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
169dd9d0cfSchristos.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
179dd9d0cfSchristos.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
189dd9d0cfSchristos.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
199dd9d0cfSchristos.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
209dd9d0cfSchristos.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
219dd9d0cfSchristos.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
229dd9d0cfSchristos.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
239dd9d0cfSchristos.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
249dd9d0cfSchristos.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
259dd9d0cfSchristos.\" SUCH DAMAGE.
269dd9d0cfSchristos.\"
27cdbf1fe1Sjkoshy.\" Id: dwarf_add_AT_producer.3 3961 2022-03-12 15:13:22Z jkoshy
289dd9d0cfSchristos.\"
299dd9d0cfSchristos.Dd September 4, 2011
309dd9d0cfSchristos.Dt DWARF_ADD_AT_PRODUCER 3
31604b0842Sjkoshy.Os
329dd9d0cfSchristos.Sh NAME
339dd9d0cfSchristos.Nm dwarf_add_AT_producer
349dd9d0cfSchristos.Nd create and attach a DW_AT_producer attribute
359dd9d0cfSchristos.Sh LIBRARY
369dd9d0cfSchristos.Lb libdwarf
379dd9d0cfSchristos.Sh SYNOPSIS
389dd9d0cfSchristos.In libdwarf.h
399dd9d0cfSchristos.Ft Dwarf_P_Attribute
409dd9d0cfSchristos.Fo dwarf_add_AT_producer
419dd9d0cfSchristos.Fa "Dwarf_P_Die die"
429dd9d0cfSchristos.Fa "char *producer"
439dd9d0cfSchristos.Fa "Dwarf_Error *err"
449dd9d0cfSchristos.Fc
459dd9d0cfSchristos.Sh DESCRIPTION
469dd9d0cfSchristosFunction
479dd9d0cfSchristos.Fn dwarf_add_AT_producer
489dd9d0cfSchristoscreates a
499dd9d0cfSchristos.Dv DW_AT_producer
509dd9d0cfSchristosattribute descriptor and attaches it to the debugging information
519dd9d0cfSchristosentry referenced by argument
52cdbf1fe1Sjkoshy.Fa die .
539dd9d0cfSchristosThe created attribute will have DWARF form
549dd9d0cfSchristos.Dv DW_FORM_strp .
559dd9d0cfSchristos.Pp
569dd9d0cfSchristosArgument
57cdbf1fe1Sjkoshy.Fa die
589dd9d0cfSchristosshould reference a debugging information entry allocated using
599dd9d0cfSchristos.Xr dwarf_new_die 3 .
609dd9d0cfSchristos.Pp
619dd9d0cfSchristosArgument
62cdbf1fe1Sjkoshy.Fa producer
639dd9d0cfSchristosshould point to a NUL-terminated string which will become the value of
649dd9d0cfSchristosthe created attribute.
659dd9d0cfSchristos.Pp
669dd9d0cfSchristosIf argument
67cdbf1fe1Sjkoshy.Fa err
68cdbf1fe1Sjkoshyis not
69cdbf1fe1Sjkoshy.Dv NULL ,
70cdbf1fe1Sjkoshyit will be used to store error information in case of an error.
719dd9d0cfSchristos.Sh RETURN VALUES
729dd9d0cfSchristosOn success, function
739dd9d0cfSchristos.Fn dwarf_add_AT_producer
749dd9d0cfSchristosreturns the created attribute descriptor.
759dd9d0cfSchristosIn case of an error, function
769dd9d0cfSchristos.Fn dwarf_add_AT_producer
779dd9d0cfSchristosreturns
789dd9d0cfSchristos.Dv DW_DLV_BADADDR
799dd9d0cfSchristosand sets the argument
80cdbf1fe1Sjkoshy.Fa err .
819dd9d0cfSchristos.Sh ERRORS
829dd9d0cfSchristosFunction
839dd9d0cfSchristos.Fn dwarf_add_AT_producer
849dd9d0cfSchristoscan fail with:
859dd9d0cfSchristos.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
869dd9d0cfSchristos.It Bq Er DW_DLE_ARGUMENT
879dd9d0cfSchristosEither of the arguments
88cdbf1fe1Sjkoshy.Fa die
899dd9d0cfSchristosor
90cdbf1fe1Sjkoshy.Fa producer
91cdbf1fe1Sjkoshywas
92cdbf1fe1Sjkoshy.Dv NULL .
939dd9d0cfSchristos.It Bq Er DW_DLE_MEMORY
949dd9d0cfSchristosAn out of memory condition was encountered during the execution of
959dd9d0cfSchristosthe function.
969dd9d0cfSchristos.El
979dd9d0cfSchristos.Sh SEE ALSO
989dd9d0cfSchristos.Xr dwarf 3 ,
999dd9d0cfSchristos.Xr dwarf_add_AT_comp_dir 3 ,
1009dd9d0cfSchristos.Xr dwarf_add_AT_const_value_string 3 ,
1019dd9d0cfSchristos.Xr dwarf_add_AT_name 3 ,
1029dd9d0cfSchristos.Xr dwarf_add_AT_string 3 ,
1039dd9d0cfSchristos.Xr dwarf_new_die 3
104