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_instr_bytes.3 2071 2011-10-27 03:20:00Z jkoshy $ 26.\" 27.Dd May 23, 2011 28.Os 29.Dt DWARF_GET_FDE_INSTR_BYTES 3 30.Sh NAME 31.Nm dwarf_get_fde_instr_bytes 32.Nd retrieve instructions from FDE descritpor 33.Sh LIBRARY 34.Lb libdwarf 35.Sh SYNOPSIS 36.In libdwarf.h 37.Ft int 38.Fo dwarf_get_fde_instr_bytes 39.Fa "Dwarf_Fde fde" 40.Fa "Dwarf_Ptr *ret_inst" 41.Fa "Dwarf_Unsigned *ret_len" 42.Fa "Dwarf_Error *error" 43.Fc 44.Sh DESCRIPTION 45Function 46.Fn dwarf_get_fde_instr_bytes 47retrieves instruction bytes from a given FDE descriptor. 48.Pp 49Argument 50.Ar fde 51should reference a valid DWARF FDE descriptor. 52.Pp 53Argument 54.Ar ret_inst 55should point to a location that will be set to a pointer 56to an array of bytes containing the instructions of the 57FDE descriptor. 58.Pp 59Argument 60.Ar ret_len 61should point to a location that will hold the length in 62bytes of the instructions returned in argument 63.Ar ret_inst . 64.Pp 65If argument 66.Ar err 67is not NULL, it will be used to store error information in case of an 68error. 69.Pp 70Applications can use the function 71.Xr dwarf_expand_frame_instructions 3 72to parse and expand the returned instruction bytes into an array of 73.Vt Dwarf_Frame_Op 74descriptors. 75.Sh RETURN VALUES 76Function 77.Fn dwarf_get_fde_instr_bytes 78returns 79.Dv DW_DLV_OK 80when it succeeds. 81In case of an error, it returns 82.Dv DW_DLV_ERROR 83and sets the argument 84.Ar err . 85.Sh ERRORS 86Function 87.Fn dwarf_get_fde_instr_bytes 88can fail with: 89.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 90.It Bq Er DW_DLE_ARGUMENT 91One of the arguments 92.Ar fde , 93.Ar ret_inst 94or 95.Ar ret_len 96was NULL. 97.El 98.Sh SEE ALSO 99.Xr dwarf 3 , 100.Xr dwarf_expand_frame_instructions 3 , 101.Xr dwarf_get_cie_info 3 , 102.Xr dwarf_get_cie_index 3 , 103.Xr dwarf_get_cie_of_fde , 104.Xr dwarf_get_fde_at_pc 3 , 105.Xr dwarf_get_fde_info_for_all_regs 3 , 106.Xr dwarf_get_fde_info_for_all_regs3 3 , 107.Xr dwarf_get_fde_info_for_cfa_reg3 3 , 108.Xr dwarf_get_fde_info_for_reg 3 , 109.Xr dwarf_get_fde_info_for_reg3 3 , 110.Xr dwarf_get_fde_list 3 , 111.Xr dwarf_get_fde_list_eh 3 , 112.Xr dwarf_get_fde_n 3 , 113.Xr dwarf_get_fde_range 3 114