Copyright (c) 2011 Kai Wang
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.

$Id: dwarf_get_fde_instr_bytes.3 3644 2018-10-15 19:55:01Z jkoshy $

.Dd May 23, 2011 .Dt DWARF_GET_FDE_INSTR_BYTES 3 .Os .Sh NAME .Nm dwarf_get_fde_instr_bytes .Nd retrieve instructions from FDE descritpor .Sh LIBRARY .Lb libdwarf .Sh SYNOPSIS n libdwarf.h .Ft int .Fo dwarf_get_fde_instr_bytes .Fa "Dwarf_Fde fde" .Fa "Dwarf_Ptr *ret_inst" .Fa "Dwarf_Unsigned *ret_len" .Fa "Dwarf_Error *error" .Fc .Sh DESCRIPTION Function .Fn dwarf_get_fde_instr_bytes retrieves instruction bytes from a given FDE descriptor.

p Argument .Ar fde should reference a valid DWARF FDE descriptor.

p Argument .Ar ret_inst should point to a location that will be set to a pointer to an array of bytes containing the instructions of the FDE descriptor.

p Argument .Ar ret_len should point to a location that will hold the length in bytes of the instructions returned in argument .Ar ret_inst .

p If argument .Ar err is not NULL, it will be used to store error information in case of an error.

p Applications can use the function .Xr dwarf_expand_frame_instructions 3 to parse and expand the returned instruction bytes into an array of .Vt Dwarf_Frame_Op descriptors. .Sh RETURN VALUES Function .Fn dwarf_get_fde_instr_bytes returns .Dv DW_DLV_OK when it succeeds. In case of an error, it returns .Dv DW_DLV_ERROR and sets the argument .Ar err . .Sh ERRORS Function .Fn dwarf_get_fde_instr_bytes can fail with: l -tag -width ".Bq Er DW_DLE_ARGUMENT" t Bq Er DW_DLE_ARGUMENT One of the arguments .Ar fde , .Ar ret_inst or .Ar ret_len was NULL. .El .Sh SEE ALSO .Xr dwarf 3 , .Xr dwarf_expand_frame_instructions 3 , .Xr dwarf_get_cie_index 3 , .Xr dwarf_get_cie_info 3 , .Xr dwarf_get_cie_of_fde 3 , .Xr dwarf_get_fde_at_pc 3 , .Xr dwarf_get_fde_info_for_all_regs 3 , .Xr dwarf_get_fde_info_for_all_regs3 3 , .Xr dwarf_get_fde_info_for_cfa_reg3 3 , .Xr dwarf_get_fde_info_for_reg 3 , .Xr dwarf_get_fde_info_for_reg3 3 , .Xr dwarf_get_fde_list 3 , .Xr dwarf_get_fde_list_eh 3 , .Xr dwarf_get_fde_n 3 , .Xr dwarf_get_fde_range 3