1.\" $NetBSD: dwarf_lne_set_address.3,v 1.6 2024/03/03 17:37:31 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_lne_set_address.3 3963 2022-03-12 16:07:32Z jkoshy 28.\" 29.Dd September 14, 2011 30.Dt DWARF_LNE_SET_ADDRESS 3 31.Os 32.Sh NAME 33.Nm dwarf_lne_set_address 34.Nd set the base address for line number information 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft "Dwarf_Unsigned" 40.Fo dwarf_lne_set_address 41.Fa "Dwarf_P_Debug dbg" 42.Fa "Dwarf_Addr off" 43.Fa "Dwarf_Unsigned symndx" 44.Fa "Dwarf_Error *err" 45.Fc 46.Sh DESCRIPTION 47Function 48.Fn dwarf_lne_set_address 49sets the base address used by subsequent invocations of the 50.Xr dwarf_add_line_entry 3 51function. 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 off 62specifies a relocatable program address. 63.Pp 64Argument 65.Fa symndx 66specifies the index of the ELF symbol to be used for relocation. 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_lne_set_address 76returns 77.Dv DW_DLV_OK . 78In case of an error, function 79.Fn dwarf_lne_set_address 80returns 81.Dv DW_DLV_NOCOUNT 82and sets the argument 83.Fa err . 84.Sh ERRORS 85Function 86.Fn dwarf_lne_set_address 87can fail with: 88.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 89.It Bq Er DW_DLE_ARGUMENT 90Argument 91.Fa dbg 92was 93.Dv NULL . 94.It Bq Er DW_DLE_ARGUMENT 95The argument 96.Fa symndx 97had an illegal value. 98.It Bq Er DW_DLE_MEMORY 99An out of memory condition was encountered during the execution of the 100function. 101.El 102.Sh SEE ALSO 103.Xr dwarf 3 , 104.Xr dwarf_add_directory_decl 3 , 105.Xr dwarf_add_file_decl 3 , 106.Xr dwarf_add_line_entry 3 , 107.Xr dwarf_lne_end_sequence 3 , 108.Xr dwarf_producer_init 3 , 109.Xr dwarf_producer_init_b 3 110