1.\" $NetBSD: dwarf_add_funcname.3,v 1.6 2024/03/03 17:37:30 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_funcname.3 3961 2022-03-12 15:13:22Z jkoshy 28.\" 29.Dd September 24, 2011 30.Dt DWARF_ADD_FUNCNAME 3 31.Os 32.Sh NAME 33.Nm dwarf_add_funcname 34.Nd add information about a static function to a DWARF producer instance 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft "Dwarf_Unsigned" 40.Fo dwarf_add_funcname 41.Fa "Dwarf_P_Debug dbg" 42.Fa "Dwarf_P_Die die" 43.Fa "char *name" 44.Fa "Dwarf_Error *err" 45.Fc 46.Sh DESCRIPTION 47Function 48.Fn dwarf_add_funcname 49adds information about a static function to a DWARF producer instance. 50.Pp 51Argument 52.Fa dbg 53should reference a DWARF producer instance allocated using 54.Xr dwarf_producer_init 3 55or 56.Xr dwarf_producer_init_b 3 . 57.Pp 58Argument 59.Fa die 60specifies the debugging information entry associated with the static 61function. 62.Pp 63Argument 64.Fa name 65should point to a NUL-terminated string containing the name 66of the static function. 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.Sh RETURN VALUES 74On success, function 75.Fn dwarf_add_funcname 76returns a non-zero value. 77In case of an error, function 78.Fn dwarf_add_funcname 79returns 0 and sets 80the argument 81.Fa err . 82.Sh ERRORS 83Function 84.Fn dwarf_add_funcname 85can fail with: 86.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 87.It Bq Er DW_DLE_ARGUMENT 88One of the arguments 89.Fa dbg , 90.Fa die 91or 92.Fa name 93was 94.Dv NULL . 95.It Bq Er DW_DLE_MEMORY 96An out of memory condition was encountered during the execution of the 97function. 98.El 99.Sh SEE ALSO 100.Xr dwarf 3 , 101.Xr dwarf_add_pubname 3 , 102.Xr dwarf_add_typename 3 , 103.Xr dwarf_add_varname 3 , 104.Xr dwarf_add_weakname 3 , 105.Xr dwarf_new_die 3 , 106.Xr dwarf_producer_init 3 , 107.Xr dwarf_producer_init_b 3 108