12de3b87aSKai Wang.\" Copyright (c) 2011 Kai Wang 22de3b87aSKai Wang.\" All rights reserved. 32de3b87aSKai Wang.\" 42de3b87aSKai Wang.\" Redistribution and use in source and binary forms, with or without 52de3b87aSKai Wang.\" modification, are permitted provided that the following conditions 62de3b87aSKai Wang.\" are met: 72de3b87aSKai Wang.\" 1. Redistributions of source code must retain the above copyright 82de3b87aSKai Wang.\" notice, this list of conditions and the following disclaimer. 92de3b87aSKai Wang.\" 2. Redistributions in binary form must reproduce the above copyright 102de3b87aSKai Wang.\" notice, this list of conditions and the following disclaimer in the 112de3b87aSKai Wang.\" documentation and/or other materials provided with the distribution. 122de3b87aSKai Wang.\" 132de3b87aSKai Wang.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 142de3b87aSKai Wang.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 152de3b87aSKai Wang.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 162de3b87aSKai Wang.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 172de3b87aSKai Wang.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 182de3b87aSKai Wang.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 192de3b87aSKai Wang.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 202de3b87aSKai Wang.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 212de3b87aSKai Wang.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 222de3b87aSKai Wang.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 232de3b87aSKai Wang.\" SUCH DAMAGE. 242de3b87aSKai Wang.\" 25*ae500c1fSEd Maste.\" $Id: dwarf_get_fde_instr_bytes.3 3644 2018-10-15 19:55:01Z jkoshy $ 262de3b87aSKai Wang.\" 272de3b87aSKai Wang.Dd May 23, 2011 282de3b87aSKai Wang.Dt DWARF_GET_FDE_INSTR_BYTES 3 29*ae500c1fSEd Maste.Os 302de3b87aSKai Wang.Sh NAME 312de3b87aSKai Wang.Nm dwarf_get_fde_instr_bytes 322de3b87aSKai Wang.Nd retrieve instructions from FDE descritpor 332de3b87aSKai Wang.Sh LIBRARY 342de3b87aSKai Wang.Lb libdwarf 352de3b87aSKai Wang.Sh SYNOPSIS 362de3b87aSKai Wang.In libdwarf.h 372de3b87aSKai Wang.Ft int 382de3b87aSKai Wang.Fo dwarf_get_fde_instr_bytes 392de3b87aSKai Wang.Fa "Dwarf_Fde fde" 402de3b87aSKai Wang.Fa "Dwarf_Ptr *ret_inst" 412de3b87aSKai Wang.Fa "Dwarf_Unsigned *ret_len" 422de3b87aSKai Wang.Fa "Dwarf_Error *error" 432de3b87aSKai Wang.Fc 442de3b87aSKai Wang.Sh DESCRIPTION 452de3b87aSKai WangFunction 462de3b87aSKai Wang.Fn dwarf_get_fde_instr_bytes 472de3b87aSKai Wangretrieves instruction bytes from a given FDE descriptor. 482de3b87aSKai Wang.Pp 492de3b87aSKai WangArgument 502de3b87aSKai Wang.Ar fde 512de3b87aSKai Wangshould reference a valid DWARF FDE descriptor. 522de3b87aSKai Wang.Pp 532de3b87aSKai WangArgument 542de3b87aSKai Wang.Ar ret_inst 552de3b87aSKai Wangshould point to a location that will be set to a pointer 562de3b87aSKai Wangto an array of bytes containing the instructions of the 572de3b87aSKai WangFDE descriptor. 582de3b87aSKai Wang.Pp 592de3b87aSKai WangArgument 602de3b87aSKai Wang.Ar ret_len 612de3b87aSKai Wangshould point to a location that will hold the length in 622de3b87aSKai Wangbytes of the instructions returned in argument 632de3b87aSKai Wang.Ar ret_inst . 642de3b87aSKai Wang.Pp 652de3b87aSKai WangIf argument 662de3b87aSKai Wang.Ar err 672de3b87aSKai Wangis not NULL, it will be used to store error information in case of an 682de3b87aSKai Wangerror. 692de3b87aSKai Wang.Pp 702de3b87aSKai WangApplications can use the function 712de3b87aSKai Wang.Xr dwarf_expand_frame_instructions 3 722de3b87aSKai Wangto parse and expand the returned instruction bytes into an array of 732de3b87aSKai Wang.Vt Dwarf_Frame_Op 742de3b87aSKai Wangdescriptors. 752de3b87aSKai Wang.Sh RETURN VALUES 762de3b87aSKai WangFunction 772de3b87aSKai Wang.Fn dwarf_get_fde_instr_bytes 782de3b87aSKai Wangreturns 792de3b87aSKai Wang.Dv DW_DLV_OK 802de3b87aSKai Wangwhen it succeeds. 812de3b87aSKai WangIn case of an error, it returns 822de3b87aSKai Wang.Dv DW_DLV_ERROR 832de3b87aSKai Wangand sets the argument 842de3b87aSKai Wang.Ar err . 852de3b87aSKai Wang.Sh ERRORS 862de3b87aSKai WangFunction 872de3b87aSKai Wang.Fn dwarf_get_fde_instr_bytes 882de3b87aSKai Wangcan fail with: 892de3b87aSKai Wang.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 902de3b87aSKai Wang.It Bq Er DW_DLE_ARGUMENT 912de3b87aSKai WangOne of the arguments 922de3b87aSKai Wang.Ar fde , 932de3b87aSKai Wang.Ar ret_inst 942de3b87aSKai Wangor 952de3b87aSKai Wang.Ar ret_len 962de3b87aSKai Wangwas NULL. 972de3b87aSKai Wang.El 982de3b87aSKai Wang.Sh SEE ALSO 992de3b87aSKai Wang.Xr dwarf 3 , 1002de3b87aSKai Wang.Xr dwarf_expand_frame_instructions 3 , 1012de3b87aSKai Wang.Xr dwarf_get_cie_index 3 , 102*ae500c1fSEd Maste.Xr dwarf_get_cie_info 3 , 103*ae500c1fSEd Maste.Xr dwarf_get_cie_of_fde 3 , 1042de3b87aSKai Wang.Xr dwarf_get_fde_at_pc 3 , 1052de3b87aSKai Wang.Xr dwarf_get_fde_info_for_all_regs 3 , 1062de3b87aSKai Wang.Xr dwarf_get_fde_info_for_all_regs3 3 , 1072de3b87aSKai Wang.Xr dwarf_get_fde_info_for_cfa_reg3 3 , 1082de3b87aSKai Wang.Xr dwarf_get_fde_info_for_reg 3 , 1092de3b87aSKai Wang.Xr dwarf_get_fde_info_for_reg3 3 , 1102de3b87aSKai Wang.Xr dwarf_get_fde_list 3 , 1112de3b87aSKai Wang.Xr dwarf_get_fde_list_eh 3 , 1122de3b87aSKai Wang.Xr dwarf_get_fde_n 3 , 1132de3b87aSKai Wang.Xr dwarf_get_fde_range 3 114