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_add_fde_inst.3 3644 2018-10-15 19:55:01Z jkoshy $

.Dd September 26, 2011 .Dt DWARF_ADD_FDE_INST 3 .Os .Sh NAME .Nm dwarf_add_fde_inst .Nd add a call frame instruction to a DWARF frame descriptor .Sh LIBRARY .Lb libdwarf .Sh SYNOPSIS n libdwarf.h .Ft "Dwarf_P_Fde" .Fo dwarf_add_fde_inst .Fa "Dwarf_P_Fde fde" .Fa "Dwarf_Small op" .Fa "Dwarf_Unsigned val1" .Fa "Dwarf_Unsigned val2" .Fa "Dwarf_Error *err" .Fc .Sh DESCRIPTION Function .Fn dwarf_add_fde_inst adds a call frame instruction to the DWARF frame descriptor referenced by argument .Ar fde .

p Argument .Ar fde should reference a frame descriptor allocated using .Xr dwarf_new_fde 3 .

p Argument .Ar op specifies the operator for the frame instruction. The DWARF standard defines the set of legal values for this argument.

p Argument .Ar val1 specifies the first operand of the frame instruction.

p Argument .Ar val2 specifies the second operand of the frame instruction.

p If argument .Ar err is not NULL, it will be used to store error information in case of an error. .Sh RETURN VALUES On success, function .Fn dwarf_add_fde_inst returns the frame descriptor given in argument .Ar fde . In case of an error, function .Fn dwarf_add_fde_inst returns .Dv DW_DLV_BADADDR and sets the argument .Ar err . .Sh ERRORS Function .Fn dwarf_add_fde_inst can fail with: l -tag -width ".Bq Er DW_DLE_FRAME_INSTR_EXEC_ERROR" t Bq Er DW_DLE_ARGUMENT Argument .Ar fde was NULL. t Bq Er DW_DLE_FRAME_INSTR_EXEC_ERROR The frame instruction operator specified in argument .Ar op was invalid. t Bq Er DW_DLE_MEMORY An out of memory condition was encountered during the execution of the function. .El .Sh SEE ALSO .Xr dwarf 3 , .Xr dwarf_add_frame_cie 3 , .Xr dwarf_add_frame_fde 3 , .Xr dwarf_add_frame_fde_b 3 , .Xr dwarf_fde_cfa_offset 3 , .Xr dwarf_new_fde 3 .Rs .%T "The DWARF Debugging Information Format" .%V "Version 4" .%O "http://www.dwarfstd.org/" .Re