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_frame_cie.3 3640 2018-10-14 14:09:13Z jkoshy $
.Dd September 26, 2011 .Dt DWARF_ADD_FRAME_CIE 3 .Os .Sh NAME .Nm dwarf_add_frame_cie .Nd add a call frame common information entry to a DWARF producer instance .Sh LIBRARY .Lb libdwarf .Sh SYNOPSIS n libdwarf.h .Ft "Dwarf_Unsigned" .Fo dwarf_add_frame_cie .Fa "Dwarf_P_Debug dbg" .Fa "char *augmenter" .Fa "Dwarf_Small caf" .Fa "Dwarf_Small daf" .Fa "Dwarf_Small ra" .Fa "Dwarf_Ptr initinst" .Fa "Dwarf_Unsigned initlen" .Fa "Dwarf_Error *err" .Fc .Sh DESCRIPTION Function .Fn dwarf_add_frame_cie adds a DWARF call frame common information entry (CIE) to a producer instance.
p Argument .Ar dbg should reference a DWARF producer instance allocated using .Xr dwarf_producer_init 3 or .Xr dwarf_producer_init_b 3 .
p Argument .Ar augmenter should point to a NUL-terminated augmentation string for the common information entry.
p Argument .Ar caf specifies the code alignment factor.
p Argument .Ar daf specifies the data alignment factor.
p Argument .Ar ra specifies the column number used for the return address register.
p Argument .Ar initinst should point to a byte stream containing the initial instructions for the common information entry.
p Argument .Ar initlen should hold the length in bytes of the byte stream pointed to by argument .Ar initinst .
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_frame_cie returns the index value of the created common information entry. In case of an error, function .Fn dwarf_add_frame_cie returns .Dv DW_DLV_NOCOUNT and sets the argument .Ar err . .Sh ERRORS Function .Fn dwarf_add_frame_cie can fail with: l -tag -width ".Bq Er DW_DLE_ARGUMENT" t Bq Er DW_DLE_ARGUMENT Argument .Ar dbg was NULL. 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_fde_inst 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 , .Xr dwarf_producer_init 3 , .Xr dwarf_producer_init_b 3