xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_lne_end_sequence.3 (revision 0b3105a37d7adcadcb720112fed4dc4e8040be99)
1.\" Copyright (c) 2011 Kai Wang
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $Id: dwarf_lne_end_sequence.3 2074 2011-10-27 03:34:33Z jkoshy $
26.\"
27.Dd September 15, 2011
28.Os
29.Dt DWARF_LNE_END_SEQUENCE 3
30.Sh NAME
31.Nm dwarf_lne_end_sequence
32.Nd set the end of instruction sequence
33.Sh LIBRARY
34.Lb libdwarf
35.Sh SYNOPSIS
36.In libdwarf.h
37.Ft "Dwarf_Unsigned"
38.Fo dwarf_lne_end_sequence
39.Fa "Dwarf_P_Debug dbg"
40.Fa "Dwarf_Addr addr"
41.Fa "Dwarf_Error *err"
42.Fc
43.Sh DESCRIPTION
44Function
45.Fn dwarf_lne_end_sequence
46sets the address that indicates the end of a sequence of target machine
47instructions.
48.Pp
49Argument
50.Ar dbg
51should reference a DWARF producer instance allocated using
52.Xr dwarf_producer_init 3
53or
54.Xr dwarf_producer_init_b 3 .
55.Pp
56Argument
57.Ar addr
58specifies an address value which is the first byte after the end of a
59instruction sequence.
60.Pp
61If argument
62.Ar err
63is not NULL, it will be used to store error information in case
64of an error.
65.Sh RETURN VALUES
66On success, function
67.Fn dwarf_lne_end_sequence
68returns
69.Dv DW_DLV_OK .
70In case of an error, function
71.Fn dwarf_lne_end_sequence
72returns
73.Dv DW_DLV_NOCOUNT
74and sets the argument
75.Ar err .
76.Sh ERRORS
77Function
78.Fn dwarf_lne_end_sequence
79can fail with:
80.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
81.It Bq Er DW_DLE_ARGUMENT
82Argument
83.Ar dbg
84was NULL.
85.It Bq Er DW_DLE_ARGUMENT
86The value in argument
87.Ar addr
88overlapped an existing line information entry.
89.It Bq Er DW_DLE_MEMORY
90An out of memory condition was encountered during the execution of the
91function.
92.El
93.Sh SEE ALSO
94.Xr dwarf 3 ,
95.Xr dwarf_add_directory_decl 3 ,
96.Xr dwarf_add_file_decl 3 ,
97.Xr dwarf_add_line_entry 3 ,
98.Xr dwarf_lne_set_address 3 ,
99.Xr dwarf_producer_init 3 ,
100.Xr dwarf_producer_init_b 3
101