xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_add_fde_inst.3 (revision ae500c1ff8974130f7f2692772cf288b90349e0d)
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_add_fde_inst.3 3644 2018-10-15 19:55:01Z jkoshy $
262de3b87aSKai Wang.\"
272de3b87aSKai Wang.Dd September 26, 2011
282de3b87aSKai Wang.Dt DWARF_ADD_FDE_INST 3
29*ae500c1fSEd Maste.Os
302de3b87aSKai Wang.Sh NAME
312de3b87aSKai Wang.Nm dwarf_add_fde_inst
322de3b87aSKai Wang.Nd add a call frame instruction to a DWARF frame descriptor
332de3b87aSKai Wang.Sh LIBRARY
342de3b87aSKai Wang.Lb libdwarf
352de3b87aSKai Wang.Sh SYNOPSIS
362de3b87aSKai Wang.In libdwarf.h
372de3b87aSKai Wang.Ft "Dwarf_P_Fde"
382de3b87aSKai Wang.Fo dwarf_add_fde_inst
392de3b87aSKai Wang.Fa "Dwarf_P_Fde fde"
402de3b87aSKai Wang.Fa "Dwarf_Small op"
412de3b87aSKai Wang.Fa "Dwarf_Unsigned val1"
422de3b87aSKai Wang.Fa "Dwarf_Unsigned val2"
432de3b87aSKai Wang.Fa "Dwarf_Error *err"
442de3b87aSKai Wang.Fc
452de3b87aSKai Wang.Sh DESCRIPTION
462de3b87aSKai WangFunction
472de3b87aSKai Wang.Fn dwarf_add_fde_inst
482de3b87aSKai Wangadds a call frame instruction to the DWARF frame descriptor
492de3b87aSKai Wangreferenced by argument
502de3b87aSKai Wang.Ar fde .
512de3b87aSKai Wang.Pp
522de3b87aSKai WangArgument
532de3b87aSKai Wang.Ar fde
542de3b87aSKai Wangshould reference a frame descriptor allocated using
552de3b87aSKai Wang.Xr dwarf_new_fde 3 .
562de3b87aSKai Wang.Pp
572de3b87aSKai WangArgument
582de3b87aSKai Wang.Ar op
592de3b87aSKai Wangspecifies the operator for the frame instruction.
602de3b87aSKai WangThe DWARF standard defines the set of legal values for this argument.
612de3b87aSKai Wang.Pp
622de3b87aSKai WangArgument
632de3b87aSKai Wang.Ar val1
642de3b87aSKai Wangspecifies the first operand of the frame instruction.
652de3b87aSKai Wang.Pp
662de3b87aSKai WangArgument
672de3b87aSKai Wang.Ar val2
682de3b87aSKai Wangspecifies the second operand of the frame instruction.
692de3b87aSKai Wang.Pp
702de3b87aSKai WangIf argument
712de3b87aSKai Wang.Ar err
722de3b87aSKai Wangis not NULL, it will be used to store error information in case of an
732de3b87aSKai Wangerror.
742de3b87aSKai Wang.Sh RETURN VALUES
752de3b87aSKai WangOn success, function
762de3b87aSKai Wang.Fn dwarf_add_fde_inst
772de3b87aSKai Wangreturns the frame descriptor given in argument
782de3b87aSKai Wang.Ar fde .
792de3b87aSKai WangIn case of an error, function
802de3b87aSKai Wang.Fn dwarf_add_fde_inst
812de3b87aSKai Wangreturns
822de3b87aSKai Wang.Dv DW_DLV_BADADDR
832de3b87aSKai Wangand sets the argument
842de3b87aSKai Wang.Ar err .
852de3b87aSKai Wang.Sh ERRORS
862de3b87aSKai WangFunction
872de3b87aSKai Wang.Fn dwarf_add_fde_inst
882de3b87aSKai Wangcan fail with:
892de3b87aSKai Wang.Bl -tag -width ".Bq Er DW_DLE_FRAME_INSTR_EXEC_ERROR"
902de3b87aSKai Wang.It Bq Er DW_DLE_ARGUMENT
912de3b87aSKai WangArgument
922de3b87aSKai Wang.Ar fde
932de3b87aSKai Wangwas NULL.
942de3b87aSKai Wang.It Bq Er DW_DLE_FRAME_INSTR_EXEC_ERROR
952de3b87aSKai WangThe frame instruction operator specified in argument
962de3b87aSKai Wang.Ar op
972de3b87aSKai Wangwas invalid.
982de3b87aSKai Wang.It Bq Er DW_DLE_MEMORY
992de3b87aSKai WangAn out of memory condition was encountered during the execution of the
1002de3b87aSKai Wangfunction.
1012de3b87aSKai Wang.El
1022de3b87aSKai Wang.Sh SEE ALSO
1032de3b87aSKai Wang.Xr dwarf 3 ,
104*ae500c1fSEd Maste.Xr dwarf_add_frame_cie 3 ,
1052de3b87aSKai Wang.Xr dwarf_add_frame_fde 3 ,
1062de3b87aSKai Wang.Xr dwarf_add_frame_fde_b 3 ,
1072de3b87aSKai Wang.Xr dwarf_fde_cfa_offset 3 ,
1082de3b87aSKai Wang.Xr dwarf_new_fde 3
1092de3b87aSKai Wang.Rs
1102de3b87aSKai Wang.%T "The DWARF Debugging Information Format"
1112de3b87aSKai Wang.%V "Version 4"
1122de3b87aSKai Wang.%O "http://www.dwarfstd.org/"
1132de3b87aSKai Wang.Re
114