1.\" $NetBSD: dwarf_add_fde_inst.3,v 1.6 2024/03/03 17:37:30 christos Exp $ 2.\" 3.\" Copyright (c) 2011 Kai Wang 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25.\" SUCH DAMAGE. 26.\" 27.\" Id: dwarf_add_fde_inst.3 3961 2022-03-12 15:13:22Z jkoshy 28.\" 29.Dd September 26, 2011 30.Dt DWARF_ADD_FDE_INST 3 31.Os 32.Sh NAME 33.Nm dwarf_add_fde_inst 34.Nd add a call frame instruction to a DWARF frame descriptor 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft "Dwarf_P_Fde" 40.Fo dwarf_add_fde_inst 41.Fa "Dwarf_P_Fde fde" 42.Fa "Dwarf_Small op" 43.Fa "Dwarf_Unsigned val1" 44.Fa "Dwarf_Unsigned val2" 45.Fa "Dwarf_Error *err" 46.Fc 47.Sh DESCRIPTION 48Function 49.Fn dwarf_add_fde_inst 50adds a call frame instruction to the DWARF frame descriptor 51referenced by argument 52.Fa fde . 53.Pp 54Argument 55.Fa fde 56should reference a frame descriptor allocated using 57.Xr dwarf_new_fde 3 . 58.Pp 59Argument 60.Fa op 61specifies the operator for the frame instruction. 62The DWARF standard defines the set of legal values for this argument. 63.Pp 64Argument 65.Fa val1 66specifies the first operand of the frame instruction. 67.Pp 68Argument 69.Fa val2 70specifies the second operand of the frame instruction. 71.Pp 72If argument 73.Fa err 74is not 75.Dv NULL , 76it will be used to store error information in case of an error. 77.Sh RETURN VALUES 78On success, function 79.Fn dwarf_add_fde_inst 80returns the frame descriptor given in argument 81.Fa fde . 82In case of an error, function 83.Fn dwarf_add_fde_inst 84returns 85.Dv DW_DLV_BADADDR 86and sets the argument 87.Fa err . 88.Sh ERRORS 89Function 90.Fn dwarf_add_fde_inst 91can fail with: 92.Bl -tag -width ".Bq Er DW_DLE_FRAME_INSTR_EXEC_ERROR" 93.It Bq Er DW_DLE_ARGUMENT 94Argument 95.Fa fde 96was 97.Dv NULL . 98.It Bq Er DW_DLE_FRAME_INSTR_EXEC_ERROR 99The frame instruction operator specified in argument 100.Fa op 101was invalid. 102.It Bq Er DW_DLE_MEMORY 103An out of memory condition was encountered during the execution of the 104function. 105.El 106.Sh SEE ALSO 107.Xr dwarf 3 , 108.Xr dwarf_add_frame_cie 3 , 109.Xr dwarf_add_frame_fde 3 , 110.Xr dwarf_add_frame_fde_b 3 , 111.Xr dwarf_fde_cfa_offset 3 , 112.Xr dwarf_new_fde 3 113.Rs 114.%T "The DWARF Debugging Information Format" 115.%V "Version 4" 116.%O "http://www.dwarfstd.org/" 117.Re 118