1.\" $NetBSD: dwarf_add_file_decl.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_file_decl.3 3961 2022-03-12 15:13:22Z jkoshy 28.\" 29.Dd September 17, 2011 30.Dt DWARF_ADD_FILE_DECL 3 31.Os 32.Sh NAME 33.Nm dwarf_add_file_decl 34.Nd add a source file entry to a producer instance 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft "Dwarf_Unsigned" 40.Fo dwarf_add_file_decl 41.Fa "Dwarf_P_Debug dbg" 42.Fa "char *name" 43.Fa "Dwarf_Unsigned dirndx" 44.Fa "Dwarf_Unsigned mtime" 45.Fa "Dwarf_Unsigned size" 46.Fa "Dwarf_Error *err" 47.Fc 48.Sh DESCRIPTION 49Function 50.Fn dwarf_add_file_decl 51adds a source file entry to a producer instance. 52.Pp 53Argument 54.Fa dbg 55should reference a DWARF producer instance allocated using 56.Xr dwarf_producer_init 3 57or 58.Xr dwarf_producer_init_b 3 . 59.Pp 60Argument 61.Fa name 62should point to a NUL-terminated string containing the name of 63the source file. 64.Pp 65If the file name in argument 66.Fa name 67is not a fully qualified pathname, argument 68.Fa dirndx 69should specify the index of the directory where the source file resides. 70Otherwise, argument 71.Fa dirndx 72should be 0. 73Valid directory indices are those returned by the function 74.Xr dwarf_add_directory_decl 3 . 75.Pp 76Argument 77.Fa mtime 78specifies the time when the file was last modified. 79.Pp 80Argument 81.Fa size 82specifies the size of the file in bytes. 83.Pp 84If argument 85.Fa err 86is not 87.Dv NULL , 88it will be used to store error information in case of an error. 89.Sh RETURN VALUES 90On success, function 91.Fn dwarf_add_file_decl 92returns the index value generated for the source file. 93In case of an error, function 94.Fn dwarf_add_file_decl 95returns 96.Dv DW_DLV_NOCOUNT 97and sets the argument 98.Fa err . 99.Sh ERRORS 100Function 101.Fn dwarf_add_file_decl 102can fail with: 103.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 104.It Bq Er DW_DLE_ARGUMENT 105Either arguments 106.Fa dbg 107or 108.Fa name 109was 110.Dv NULL . 111.It Bq Er DW_DLE_ARGUMENT 112The length of the NUL-teminated string pointed to by argument 113.Fa name 114was 0. 115.It Bq Er DW_DLE_MEMORY 116An out of memory condition was encountered during the execution of the 117function. 118.El 119.Sh SEE ALSO 120.Xr dwarf 3 , 121.Xr dwarf_add_directory_decl 3 , 122.Xr dwarf_add_line_entry 3 , 123.Xr dwarf_lne_end_sequence 3 , 124.Xr dwarf_lne_set_address 3 , 125.Xr dwarf_producer_init 3 , 126.Xr dwarf_producer_init_b 3 127