xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_new_fde.3 (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
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_new_fde.3 3644 2018-10-15 19:55:01Z jkoshy $
26.\"
27.Dd September 24, 2011
28.Dt DWARF_NEW_FDE 3
29.Os
30.Sh NAME
31.Nm dwarf_new_fde
32.Nd allocate a DWARF frame descriptor
33.Sh LIBRARY
34.Lb libdwarf
35.Sh SYNOPSIS
36.In libdwarf.h
37.Ft "Dwarf_P_Fde"
38.Fo dwarf_new_fde
39.Fa "Dwarf_P_Debug dbg"
40.Fa "Dwarf_Error *err"
41.Fc
42.Sh DESCRIPTION
43Function
44.Fn dwarf_new_fde
45allocates a new DWARF frame descriptor.
46.Pp
47Argument
48.Ar dbg
49should reference a DWARF producer instance allocated using
50.Xr dwarf_producer_init 3
51or
52.Xr dwarf_producer_init_b 3 .
53.Pp
54If argument
55.Ar err
56is not NULL, it will be used to store error information in case of an
57error.
58.Sh RETURN VALUES
59On success, function
60.Fn dwarf_new_fde
61returns the newly created frame descriptor.
62In case of an error, function
63.Fn dwarf_new_fde
64returns
65.Dv DW_DLV_BADADDR
66and sets the argument
67.Ar err .
68.Sh ERRORS
69Function
70.Fn dwarf_new_fde
71can fail with:
72.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
73.It Bq Er DW_DLE_ARGUMENT
74Argument
75.Ar dbg
76was NULL.
77.It Bq Er DW_DLE_MEMORY
78An out of memory condition was encountered during the execution of the
79function.
80.El
81.Sh SEE ALSO
82.Xr dwarf 3 ,
83.Xr dwarf_add_fde_inst 3 ,
84.Xr dwarf_add_frame_cie 3 ,
85.Xr dwarf_add_frame_fde 3 ,
86.Xr dwarf_add_frame_fde_b 3 ,
87.Xr dwarf_fde_cfa_offset 3
88