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_expand_frame_instructions.3 3181 2015-04-10 13:22:51Z emaste $
29 .Dt DWARF_EXPAND_FRAME_INSTRUCTIONS 3
31 .Nm dwarf_expand_frame_instructions
32 .Nd expand frame instructions
38 .Fo dwarf_expand_frame_instructions
40 .Fa "Dwarf_Ptr instructions"
41 .Fa "Dwarf_Unsigned len"
42 .Fa "Dwarf_Frame_Op **ret_ops"
43 .Fa "Dwarf_Signed *ret_opcnt"
44 .Fa "Dwarf_Error *error"
48 .Fn dwarf_expand_frame_instructions
49 translates DWARF frame instruction bytes into an array of
55 should reference the CIE descriptor associated with the instructions
60 should point to an array of frame instruction bytes, as
61 returned by the functions
62 .Xr dwarf_get_cie_info 3
64 .Xr dwarf_get_fde_instr_bytes 3 .
68 should specify the number of the frame instruction bytes to be
73 should point to a location that will be set to a pointer to
74 an array of translated
80 should point to a location that will hold the total number of the
85 is not NULL, it will be used to store error information in case of an
88 The memory area used for the descriptor array returned in argument
92 Application code should use function
95 .Dv DW_DLA_FRAME_BLOCK
96 to free the memory area when the descriptor array is no longer needed.
99 .Fn dwarf_expand_frame_instructions
103 In case of an error, it returns
105 and sets the argument
109 .Fn dwarf_expand_frame_instructions
111 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
112 .It Bq Er DW_DLE_ARGUMENT
120 .It Bq Er DW_DLE_ARGUMENT
124 .It Bq Er DW_DLE_MEMORY
125 An out of memory condition was encountered during the execution of
127 .It Bq Er DW_DLE_FRAME_INSTR_EXEC_ERROR
128 An unknown instruction was found in the instruction bytes provided
133 To retrieve and expand the frame instructions for a given FDE
135 .Bd -literal -offset indent
140 Dwarf_Unsigned fde_instlen;
145 /* ... assuming `dbg` references a valid DWARF debugging context,
146 `fde` references a valid FDE descriptor and `cie` holds the CIE
147 descriptor associated with the FDE descriptor ... */
149 if (dwarf_get_fde_instr_bytes(fde, &fde_inst, &fde_instlen,
151 errx(EXIT_FAILURE, "dwarf_get_fde_instr_bytes failed: %s",
154 if (dwarf_expand_frame_instructions(cie, fde_inst, fde_instlen,
155 &ops, &opcnt, &de) != DW_DLV_OK)
157 "dwarf_expand_frame_instructions failed: %s",
160 for (i = 0; i < opcnt; i++) {
161 /* ... use ops[i] ... */
164 /* Free the memory area when no longer needed. */
165 dwarf_dealloc(dbg, ops, DW_DLA_FRAME_BLOCK);
169 .Xr dwarf_frame_instructions_dealloc 3 ,
170 .Xr dwarf_get_cie_info 3 ,
171 .Xr dwarf_get_cie_index 3 ,
172 .Xr dwarf_get_cie_of_fde ,
173 .Xr dwarf_get_fde_at_pc 3 ,
174 .Xr dwarf_get_fde_info_for_all_regs 3 ,
175 .Xr dwarf_get_fde_info_for_all_regs3 3 ,
176 .Xr dwarf_get_fde_info_for_cfa_reg3 3 ,
177 .Xr dwarf_get_fde_info_for_reg 3 ,
178 .Xr dwarf_get_fde_info_for_reg3 3 ,
179 .Xr dwarf_get_fde_instr_bytes 3 ,
180 .Xr dwarf_get_fde_list 3 ,
181 .Xr dwarf_get_fde_list_eh 3 ,
182 .Xr dwarf_get_fde_n 3