xref: /netbsd-src/external/bsd/elftoolchain/dist/libdwarf/dwarf_lne_end_sequence.3 (revision 5ac3bc719ce6e70593039505b491894133237d12)
1*5ac3bc71Schristos.\"	$NetBSD: dwarf_lne_end_sequence.3,v 1.6 2024/03/03 17:37:31 christos Exp $
2e81373b4Schristos.\"
39dd9d0cfSchristos.\" Copyright (c) 2011 Kai Wang
49dd9d0cfSchristos.\" All rights reserved.
59dd9d0cfSchristos.\"
69dd9d0cfSchristos.\" Redistribution and use in source and binary forms, with or without
79dd9d0cfSchristos.\" modification, are permitted provided that the following conditions
89dd9d0cfSchristos.\" are met:
99dd9d0cfSchristos.\" 1. Redistributions of source code must retain the above copyright
109dd9d0cfSchristos.\"    notice, this list of conditions and the following disclaimer.
119dd9d0cfSchristos.\" 2. Redistributions in binary form must reproduce the above copyright
129dd9d0cfSchristos.\"    notice, this list of conditions and the following disclaimer in the
139dd9d0cfSchristos.\"    documentation and/or other materials provided with the distribution.
149dd9d0cfSchristos.\"
159dd9d0cfSchristos.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
169dd9d0cfSchristos.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
179dd9d0cfSchristos.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
189dd9d0cfSchristos.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
199dd9d0cfSchristos.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
209dd9d0cfSchristos.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
219dd9d0cfSchristos.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
229dd9d0cfSchristos.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
239dd9d0cfSchristos.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
249dd9d0cfSchristos.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
259dd9d0cfSchristos.\" SUCH DAMAGE.
269dd9d0cfSchristos.\"
27cdbf1fe1Sjkoshy.\" Id: dwarf_lne_end_sequence.3 3963 2022-03-12 16:07:32Z jkoshy
289dd9d0cfSchristos.\"
299dd9d0cfSchristos.Dd September 15, 2011
309dd9d0cfSchristos.Dt DWARF_LNE_END_SEQUENCE 3
31604b0842Sjkoshy.Os
329dd9d0cfSchristos.Sh NAME
339dd9d0cfSchristos.Nm dwarf_lne_end_sequence
349dd9d0cfSchristos.Nd set the end of instruction sequence
359dd9d0cfSchristos.Sh LIBRARY
369dd9d0cfSchristos.Lb libdwarf
379dd9d0cfSchristos.Sh SYNOPSIS
389dd9d0cfSchristos.In libdwarf.h
399dd9d0cfSchristos.Ft "Dwarf_Unsigned"
409dd9d0cfSchristos.Fo dwarf_lne_end_sequence
419dd9d0cfSchristos.Fa "Dwarf_P_Debug dbg"
429dd9d0cfSchristos.Fa "Dwarf_Addr addr"
439dd9d0cfSchristos.Fa "Dwarf_Error *err"
449dd9d0cfSchristos.Fc
459dd9d0cfSchristos.Sh DESCRIPTION
469dd9d0cfSchristosFunction
479dd9d0cfSchristos.Fn dwarf_lne_end_sequence
489dd9d0cfSchristossets the address that indicates the end of a sequence of target machine
499dd9d0cfSchristosinstructions.
509dd9d0cfSchristos.Pp
519dd9d0cfSchristosArgument
52cdbf1fe1Sjkoshy.Fa dbg
539dd9d0cfSchristosshould reference a DWARF producer instance allocated using
549dd9d0cfSchristos.Xr dwarf_producer_init 3
559dd9d0cfSchristosor
569dd9d0cfSchristos.Xr dwarf_producer_init_b 3 .
579dd9d0cfSchristos.Pp
589dd9d0cfSchristosArgument
59cdbf1fe1Sjkoshy.Fa addr
609dd9d0cfSchristosspecifies an address value which is the first byte after the end of a
619dd9d0cfSchristosinstruction sequence.
629dd9d0cfSchristos.Pp
639dd9d0cfSchristosIf argument
64cdbf1fe1Sjkoshy.Fa err
65cdbf1fe1Sjkoshyis not
66cdbf1fe1Sjkoshy.Dv NULL ,
67cdbf1fe1Sjkoshyit will be used to store error information in case of an error.
689dd9d0cfSchristos.Sh RETURN VALUES
699dd9d0cfSchristosOn success, function
709dd9d0cfSchristos.Fn dwarf_lne_end_sequence
719dd9d0cfSchristosreturns
729dd9d0cfSchristos.Dv DW_DLV_OK .
739dd9d0cfSchristosIn case of an error, function
749dd9d0cfSchristos.Fn dwarf_lne_end_sequence
759dd9d0cfSchristosreturns
769dd9d0cfSchristos.Dv DW_DLV_NOCOUNT
779dd9d0cfSchristosand sets the argument
78cdbf1fe1Sjkoshy.Fa err .
799dd9d0cfSchristos.Sh ERRORS
809dd9d0cfSchristosFunction
819dd9d0cfSchristos.Fn dwarf_lne_end_sequence
829dd9d0cfSchristoscan fail with:
839dd9d0cfSchristos.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
849dd9d0cfSchristos.It Bq Er DW_DLE_ARGUMENT
859dd9d0cfSchristosArgument
86cdbf1fe1Sjkoshy.Fa dbg
87cdbf1fe1Sjkoshywas
88cdbf1fe1Sjkoshy.Dv NULL .
899dd9d0cfSchristos.It Bq Er DW_DLE_ARGUMENT
909dd9d0cfSchristosThe value in argument
91cdbf1fe1Sjkoshy.Fa addr
929dd9d0cfSchristosoverlapped an existing line information entry.
939dd9d0cfSchristos.It Bq Er DW_DLE_MEMORY
949dd9d0cfSchristosAn out of memory condition was encountered during the execution of the
959dd9d0cfSchristosfunction.
969dd9d0cfSchristos.El
979dd9d0cfSchristos.Sh SEE ALSO
989dd9d0cfSchristos.Xr dwarf 3 ,
999dd9d0cfSchristos.Xr dwarf_add_directory_decl 3 ,
1009dd9d0cfSchristos.Xr dwarf_add_file_decl 3 ,
1019dd9d0cfSchristos.Xr dwarf_add_line_entry 3 ,
1029dd9d0cfSchristos.Xr dwarf_lne_set_address 3 ,
1039dd9d0cfSchristos.Xr dwarf_producer_init 3 ,
1049dd9d0cfSchristos.Xr dwarf_producer_init_b 3
105