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