1.\" $NetBSD: dwarf_lne_end_sequence.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_end_sequence.3 3963 2022-03-12 16:07:32Z jkoshy 28.\" 29.Dd September 15, 2011 30.Dt DWARF_LNE_END_SEQUENCE 3 31.Os 32.Sh NAME 33.Nm dwarf_lne_end_sequence 34.Nd set the end of instruction sequence 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft "Dwarf_Unsigned" 40.Fo dwarf_lne_end_sequence 41.Fa "Dwarf_P_Debug dbg" 42.Fa "Dwarf_Addr addr" 43.Fa "Dwarf_Error *err" 44.Fc 45.Sh DESCRIPTION 46Function 47.Fn dwarf_lne_end_sequence 48sets the address that indicates the end of a sequence of target machine 49instructions. 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 addr 60specifies an address value which is the first byte after the end of a 61instruction sequence. 62.Pp 63If argument 64.Fa err 65is not 66.Dv NULL , 67it will be used to store error information in case of an error. 68.Sh RETURN VALUES 69On success, function 70.Fn dwarf_lne_end_sequence 71returns 72.Dv DW_DLV_OK . 73In case of an error, function 74.Fn dwarf_lne_end_sequence 75returns 76.Dv DW_DLV_NOCOUNT 77and sets the argument 78.Fa err . 79.Sh ERRORS 80Function 81.Fn dwarf_lne_end_sequence 82can fail with: 83.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 84.It Bq Er DW_DLE_ARGUMENT 85Argument 86.Fa dbg 87was 88.Dv NULL . 89.It Bq Er DW_DLE_ARGUMENT 90The value in argument 91.Fa addr 92overlapped an existing line information entry. 93.It Bq Er DW_DLE_MEMORY 94An out of memory condition was encountered during the execution of the 95function. 96.El 97.Sh SEE ALSO 98.Xr dwarf 3 , 99.Xr dwarf_add_directory_decl 3 , 100.Xr dwarf_add_file_decl 3 , 101.Xr dwarf_add_line_entry 3 , 102.Xr dwarf_lne_set_address 3 , 103.Xr dwarf_producer_init 3 , 104.Xr dwarf_producer_init_b 3 105