1.\" $NetBSD: dwarf_lne_set_address.3,v 1.2 2014/03/09 16:58:04 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 2074 2011-10-27 03:34:33Z jkoshy 28.\" 29.Dd September 14, 2011 30.Os 31.Dt DWARF_LNE_SET_ADDRESS 3 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.Ar 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.Ar off 62specifies a relocatable program address. 63.Pp 64Argument 65.Ar symndx 66specifies the index of the ELF symbol to be used for relocation. 67.Pp 68If argument 69.Ar err 70is not NULL, it will be used to store error information in case 71of an error. 72.Sh RETURN VALUES 73On success, function 74.Fn dwarf_lne_set_address 75returns 76.Dv DW_DLV_OK . 77In case of an error, function 78.Fn dwarf_lne_set_address 79returns 80.Dv DW_DLV_NOCOUNT 81and sets the argument 82.Ar err . 83.Sh ERRORS 84Function 85.Fn dwarf_lne_set_address 86can fail with: 87.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 88.It Bq Er DW_DLE_ARGUMENT 89Argument 90.Ar dbg 91was NULL. 92.It Bq Er DW_DLE_ARGUMENT 93The argument 94.Ar symndx 95had an illegal value. 96.It Bq Er DW_DLE_MEMORY 97An out of memory condition was encountered during the execution of the 98function. 99.El 100.Sh SEE ALSO 101.Xr dwarf 3 , 102.Xr dwarf_add_directory_decl 3 , 103.Xr dwarf_add_file_decl 3 , 104.Xr dwarf_add_line_entry 3 , 105.Xr dwarf_lne_end_sequence 3 , 106.Xr dwarf_producer_init 3 , 107.Xr dwarf_producer_init_b 3 108