xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_get_cie_of_fde.3 (revision 2e3f49888ec8851bafb22011533217487764fdb0)
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_get_cie_of_fde.3 3644 2018-10-15 19:55:01Z jkoshy $
26.\"
27.Dd May 22, 2011
28.Dt DWARF_GET_CIE_OF_FDE 3
29.Os
30.Sh NAME
31.Nm dwarf_get_cie_of_fde
32.Nd retrieve CIE descriptor
33.Sh LIBRARY
34.Lb libdwarf
35.Sh SYNOPSIS
36.In libdwarf.h
37.Ft int
38.Fo dwarf_get_cie_of_fde
39.Fa "Dwarf_Fde fde"
40.Fa "Dwarf_Cie *ret_cie"
41.Fa "Dwarf_Error *err"
42.Fc
43.Sh DESCRIPTION
44Function
45.Fn dwarf_get_cie_of_fde
46retrieves the CIE descriptor associated with a given FDE descriptor.
47.Pp
48Argument
49.Ar fde
50should reference a valid FDE descriptor.
51.Pp
52Argument
53.Ar ret_cie
54should point to a location that will hold the returned CIE
55descriptor.
56.Pp
57If argument
58.Ar err
59is not NULL, it will be used to store error information in case of an
60error.
61.Sh RETURN VALUES
62Function
63.Fn dwarf_get_cie_of_fde
64returns
65.Dv DW_DLV_OK
66when it succeeds.
67In case of an error, it returns
68.Dv DW_DLV_ERROR
69and sets the argument
70.Ar err .
71.Sh ERRORS
72Function
73.Fn dwarf_get_cie_of_fde
74can fail with:
75.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
76.It Bq Er DW_DLE_ARGUMENT
77Either of arugments
78.Ar fde
79or
80.Ar ret_cie
81was NULL.
82.El
83.Sh SEE ALSO
84.Xr dwarf 3 ,
85.Xr dwarf_get_cie_index 3 ,
86.Xr dwarf_get_cie_info 3 ,
87.Xr dwarf_get_fde_at_pc 3 ,
88.Xr dwarf_get_fde_n 3
89