1 .\" Copyright (c) 2011 Kai Wang
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
25 .\" $Id: dwarf_get_fde_list.3 3644 2018-10-15 19:55:01Z jkoshy $
28 .Dt DWARF_GET_FDE_LIST 3
31 .Nm dwarf_get_fde_list
32 .Nd retrieve frame information
38 .Fo dwarf_get_fde_list
40 .Fa "Dwarf_Cie **cie_list"
41 .Fa "Dwarf_Signed *cie_count"
42 .Fa "Dwarf_Fde **fde_list"
43 .Fa "Dwarf_Signed *fde_count"
44 .Fa "Dwarf_Error *err"
47 .Fo dwarf_get_fde_list_eh
49 .Fa "Dwarf_Cie **cie_list"
50 .Fa "Dwarf_Signed *cie_count"
51 .Fa "Dwarf_Fde **fde_list"
52 .Fa "Dwarf_Signed *fde_count"
53 .Fa "Dwarf_Error *err"
56 These functions retrieve frame related information for the specified
60 .Fn dwarf_get_fde_list
61 retrieves frame information from the DWARF section named
63 For objects containing GNU style C++ exception handling
64 information, the function
65 .Fn dwarf_get_fde_list_eh
66 retrieves frame information from the section named
69 Frame information is returned using opaque descriptors
74 Applications need to use the other frame related functions in the
75 DWARF(3) API set to retrieve the information contained in these
80 should reference a DWARF debug context allocated using
85 should point to a location that will be set to a pointer to an array
92 should point to a location that will be set to the number of
98 should point to a location that will be set to a pointer to an array
105 should point to a location that will be set to the number of
107 descriptors returned.
111 is not NULL, it will be used to store error information in case of an
113 .Ss Memory Management
114 The memory areas used for the arrays returned in arguments
120 Application code should not attempt to directly free these areas.
121 Portable applications should instead use the
122 .Xr dwarf_fde_cie_list_dealloc 3
123 function to indicate that these memory areas may be freed.
125 On success, these functions returns
129 if there is no frame information associated with the given DWARF
131 In case of an error, they return
136 To obtain frame information from the
139 .Bd -literal -offset indent
141 Dwarf_Cie *cie_list, cie;
142 Dwarf_Fde *fde_list, fde;
143 Dwarf_Off fde_offset, cie_offset;
144 Dwarf_Unsigned func_len, fde_length, fde_instlen;
145 Dwarf_Signed cie_count, fde_count, cie_index;
147 Dwarf_Ptr fde_addr, fde_inst, cie_inst;
151 if (dwarf_get_fde_list(dbg, &cie_list, &cie_count,
152 &fde_list, &fde_count, &de) != DW_DLV_OK) {
153 errx(EXIT_FAILURE, "dwarf_get_fde_list failed: %s",
157 for (i = 0; i < fde_count; i++) {
158 if (dwarf_get_fde_n(fde_list, i, &fde, &de) != DW_DLV_OK) {
159 warnx("dwarf_get_fde_n failed: %s",
163 if (dwarf_get_cie_of_fde(fde, &cie, &de) != DW_DLV_OK) {
164 warnx("dwarf_get_fde_n failed: %s",
168 if (dwarf_get_fde_range(fde, &low_pc, &func_len, &fde_addr,
169 &fde_length, &cie_offset, &cie_index, &fde_offset,
171 warnx("dwarf_get_fde_range failed: %s",
175 if (dwarf_get_fde_instr_bytes(fde, &fde_inst, &fde_instlen,
177 warnx("dwarf_get_fde_instr_bytes failed: %s",
182 /* ... Use the retrieved frame information ... */
185 /* Indicate that the returned arrays may be freed. */
186 dwarf_fde_cie_list_dealloc(dbg, cie_list, cie_count, fde_list,
190 These functions may fail with the following errors:
191 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
192 .It Bq Er DW_DLE_ARGUMENT
201 .It Bq Er DW_DLE_NO_ENTRY
202 There is no frame information associated with the giving DWARF debug
207 .Xr dwarf_fde_cie_list_dealloc 3 ,
208 .Xr dwarf_get_cie_index 3 ,
209 .Xr dwarf_get_cie_of_fde 3 ,
210 .Xr dwarf_get_fde_at_pc 3 ,
211 .Xr dwarf_get_fde_instr_bytes 3 ,
212 .Xr dwarf_get_fde_n 3 ,
213 .Xr dwarf_get_fde_range 3 ,
214 .Xr dwarf_set_frame_cfa_value 3 ,
215 .Xr dwarf_set_frame_rule_initial_value 3 ,
216 .Xr dwarf_set_frame_rule_table_size 3 ,
217 .Xr dwarf_set_frame_same_value 3 ,
218 .Xr dwarf_set_frame_undefined_value 3