1.\"	$NetBSD: dwarf_lne_end_sequence.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_end_sequence.3 2074 2011-10-27 03:34:33Z jkoshy
28.\"
29.Dd September 15, 2011
30.Os
31.Dt DWARF_LNE_END_SEQUENCE 3
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.Ar 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.Ar addr
60specifies an address value which is the first byte after the end of a
61instruction sequence.
62.Pp
63If argument
64.Ar err
65is not NULL, it will be used to store error information in case
66of an error.
67.Sh RETURN VALUES
68On success, function
69.Fn dwarf_lne_end_sequence
70returns
71.Dv DW_DLV_OK .
72In case of an error, function
73.Fn dwarf_lne_end_sequence
74returns
75.Dv DW_DLV_NOCOUNT
76and sets the argument
77.Ar err .
78.Sh ERRORS
79Function
80.Fn dwarf_lne_end_sequence
81can fail with:
82.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
83.It Bq Er DW_DLE_ARGUMENT
84Argument
85.Ar dbg
86was NULL.
87.It Bq Er DW_DLE_ARGUMENT
88The value in argument
89.Ar addr
90overlapped an existing line information entry.
91.It Bq Er DW_DLE_MEMORY
92An out of memory condition was encountered during the execution of the
93function.
94.El
95.Sh SEE ALSO
96.Xr dwarf 3 ,
97.Xr dwarf_add_directory_decl 3 ,
98.Xr dwarf_add_file_decl 3 ,
99.Xr dwarf_add_line_entry 3 ,
100.Xr dwarf_lne_set_address 3 ,
101.Xr dwarf_producer_init 3 ,
102.Xr dwarf_producer_init_b 3
103