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_info_for_all_regs.3 2071 2011-10-27 03:20:00Z jkoshy $
29 .Dt DWARF_GET_FDE_INFO_FOR_ALL_REGS 3
31 .Nm dwarf_get_fde_info_for_all_regs
32 .Nd retrieve register rule row
38 .Fo dwarf_get_fde_info_for_all_regs
41 .Fa "Dwarf_Regtable *reg_table"
42 .Fa "Dwarf_Addr *row_pc"
43 .Fa "Dwarf_Error *err"
47 .Fn dwarf_get_fde_info_for_all_regs
48 retrieves a row from the register rule table associated with the given
53 should reference a valid DWARF FDE descriptor.
57 should hold the program counter address to be used to locate the
64 descriptor which will hold the returned table row of register rules.
68 should point to a location which will be set to the lowest program
69 counter address associated with the table row.
73 is not NULL, it will be used to store error information in case of an
78 descriptor is defined in the header file
80 .Bd -literal -offset indent
83 Dwarf_Small dw_offset_relevant;
86 } rules[DW_REG_TABLE_SIZE];
90 For each of the register rules returned,
92 .Va dw_offset_relevant
93 field is set to 1 if the register rule has a offset value. The
95 field is set to the register number associated with the regsiter rule.
98 field is set to the offset value associated with the register rule.
100 The number of register columns returned is either the constant
102 .Dv DW_REG_TABLE_SIZE as defined
105 or the value set by function
106 .Xr dwarf_set_frame_rule_table_size 3 ,
107 whichever is smaller.
110 .Fn dwarf_get_fde_info_for_all_regs
111 is deprecated since it only supports DWARF2 frame sections.
112 Applications should instead use function
113 .Xr dwarf_get_fde_info_for_all_regs3 3
114 which supports both DWARF2 and DWARF3 frame sections.
117 .Fn dwarf_get_fde_info_for_all_regs
121 In case of an error, it returns
123 and sets the argument
127 .Fn dwarf_get_fde_info_for_all_regs
129 .Bl -tag -width ".Bq Er DW_DLE_PC_NOT_IN_FDE_RANGE"
130 .It Bq Er DW_DLE_ARGUMENT
137 .It Bq Er DW_DLE_PC_NOT_IN_FDE_RANGE
138 The program counter value provided in argument
140 did not fall in the range covered by argument
145 .Xr dwarf_get_fde_at_pc 3 ,
146 .Xr dwarf_get_fde_info_for_all_regs3 3 ,
147 .Xr dwarf_get_fde_info_for_cfa_reg3 3 ,
148 .Xr dwarf_get_fde_info_for_reg 3 ,
149 .Xr dwarf_get_fde_info_for_reg3 3 ,
150 .Xr dwarf_get_fde_n 3 ,
151 .Xr dwarf_set_frame_cfa_value 3 ,
152 .Xr dwarf_set_frame_rule_table_size 3 ,
153 .Xr dwarf_set_frame_rule_initial_value 3 ,
154 .Xr dwarf_set_frame_same_value 3 ,
155 .Xr dwarf_set_frame_undefined_value 3