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_fde_info_for_all_regs.3 3644 2018-10-15 19:55:01Z jkoshy $ 26.\" 27.Dd June 4, 2011 28.Dt DWARF_GET_FDE_INFO_FOR_ALL_REGS 3 29.Os 30.Sh NAME 31.Nm dwarf_get_fde_info_for_all_regs 32.Nd retrieve register rule row 33.Sh LIBRARY 34.Lb libdwarf 35.Sh SYNOPSIS 36.In libdwarf.h 37.Ft int 38.Fo dwarf_get_fde_info_for_all_regs 39.Fa "Dwarf_Fde fde" 40.Fa "Dwarf_Addr pc" 41.Fa "Dwarf_Regtable *reg_table" 42.Fa "Dwarf_Addr *row_pc" 43.Fa "Dwarf_Error *err" 44.Fc 45.Sh DESCRIPTION 46Function 47.Fn dwarf_get_fde_info_for_all_regs 48retrieves a row from the register rule table associated with the given 49FDE descriptor. 50.Pp 51Argument 52.Ar fde 53should reference a valid DWARF FDE descriptor. 54.Pp 55Argument 56.Ar pc 57should hold the program counter address to be used to locate the 58desired table row. 59.Pp 60Argument 61.Ar reg_table 62should point to a 63.Vt Dwarf_Regtable 64descriptor which will hold the returned table row of register rules. 65.Pp 66Argument 67.Ar row_pc 68should point to a location which will be set to the lowest program 69counter address associated with the table row. 70.Pp 71If argument 72.Ar err 73is not NULL, it will be used to store error information in case of an 74error. 75.Pp 76The 77.Vt Dwarf_Regtable 78descriptor is defined in the header file 79.In libdwarf.h : 80.Bd -literal -offset indent 81typedef struct { 82 struct { 83 Dwarf_Small dw_offset_relevant; 84 Dwarf_Half dw_regnum; 85 Dwarf_Addr dw_offset; 86 } rules[DW_REG_TABLE_SIZE]; 87} Dwarf_Regtable; 88.Ed 89.Pp 90For each of the register rules returned, 91the 92.Va dw_offset_relevant 93field is set to 1 if the register rule has a offset value. 94The 95.Va dw_regnum 96field is set to the register number associated with the regsiter rule. 97The 98.Va dw_offset 99field is set to the offset value associated with the register rule. 100.Pp 101The number of register columns returned is either the constant 102value 103.Dv DW_REG_TABLE_SIZE as defined 104in the header file 105.In libdwarf.h , 106or the value set by function 107.Xr dwarf_set_frame_rule_table_size 3 , 108whichever is smaller. 109.Ss COMPATIBILITY 110Function 111.Fn dwarf_get_fde_info_for_all_regs 112is deprecated since it only supports DWARF2 frame sections. 113Applications should instead use function 114.Xr dwarf_get_fde_info_for_all_regs3 3 115which supports both DWARF2 and DWARF3 frame sections. 116.Sh RETURN VALUES 117Function 118.Fn dwarf_get_fde_info_for_all_regs 119returns 120.Dv DW_DLV_OK 121when it succeeds. 122In case of an error, it returns 123.Dv DW_DLV_ERROR 124and sets the argument 125.Ar err . 126.Sh ERRORS 127Function 128.Fn dwarf_get_fde_info_for_all_regs 129can fail with: 130.Bl -tag -width ".Bq Er DW_DLE_PC_NOT_IN_FDE_RANGE" 131.It Bq Er DW_DLE_ARGUMENT 132One of the arguments 133.Ar fde , 134.Ar reg_table 135or 136.Ar row_pc 137was NULL. 138.It Bq Er DW_DLE_PC_NOT_IN_FDE_RANGE 139The program counter value provided in argument 140.Ar pc 141did not fall in the range covered by argument 142.Ar fde . 143.El 144.Sh SEE ALSO 145.Xr dwarf 3 , 146.Xr dwarf_get_fde_at_pc 3 , 147.Xr dwarf_get_fde_info_for_all_regs3 3 , 148.Xr dwarf_get_fde_info_for_cfa_reg3 3 , 149.Xr dwarf_get_fde_info_for_reg 3 , 150.Xr dwarf_get_fde_info_for_reg3 3 , 151.Xr dwarf_get_fde_n 3 , 152.Xr dwarf_set_frame_cfa_value 3 , 153.Xr dwarf_set_frame_rule_initial_value 3 , 154.Xr dwarf_set_frame_rule_table_size 3 , 155.Xr dwarf_set_frame_same_value 3 , 156.Xr dwarf_set_frame_undefined_value 3 157