1.\" $NetBSD: dwarf_add_frame_cie.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_frame_cie.3 3961 2022-03-12 15:13:22Z jkoshy 28.\" 29.Dd September 26, 2011 30.Dt DWARF_ADD_FRAME_CIE 3 31.Os 32.Sh NAME 33.Nm dwarf_add_frame_cie 34.Nd add a call frame common information entry to a DWARF producer instance 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft "Dwarf_Unsigned" 40.Fo dwarf_add_frame_cie 41.Fa "Dwarf_P_Debug dbg" 42.Fa "char *augmenter" 43.Fa "Dwarf_Small caf" 44.Fa "Dwarf_Small daf" 45.Fa "Dwarf_Small ra" 46.Fa "Dwarf_Ptr initinst" 47.Fa "Dwarf_Unsigned initlen" 48.Fa "Dwarf_Error *err" 49.Fc 50.Sh DESCRIPTION 51Function 52.Fn dwarf_add_frame_cie 53adds a DWARF call frame common information entry (CIE) to a producer 54instance. 55.Pp 56Argument 57.Fa dbg 58should reference a DWARF producer instance allocated using 59.Xr dwarf_producer_init 3 60or 61.Xr dwarf_producer_init_b 3 . 62.Pp 63Argument 64.Fa augmenter 65should point to a NUL-terminated augmentation string for the common 66information entry. 67.Pp 68Argument 69.Fa caf 70specifies the code alignment factor. 71.Pp 72Argument 73.Fa daf 74specifies the data alignment factor. 75.Pp 76Argument 77.Fa ra 78specifies the column number used for the return address register. 79.Pp 80Argument 81.Fa initinst 82should point to a byte stream containing the initial instructions 83for the common information entry. 84.Pp 85Argument 86.Fa initlen 87should hold the length in bytes of the byte stream pointed to by 88argument 89.Fa initinst . 90.Pp 91If argument 92.Fa err 93is not 94.Dv NULL , 95it will be used to store error information in case of an error. 96.Sh RETURN VALUES 97On success, function 98.Fn dwarf_add_frame_cie 99returns the index value of the created common information entry. 100In case of an error, function 101.Fn dwarf_add_frame_cie 102returns 103.Dv DW_DLV_NOCOUNT 104and sets the argument 105.Fa err . 106.Sh ERRORS 107Function 108.Fn dwarf_add_frame_cie 109can fail with: 110.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 111.It Bq Er DW_DLE_ARGUMENT 112Argument 113.Fa dbg 114was 115.Dv NULL . 116.It Bq Er DW_DLE_MEMORY 117An out of memory condition was encountered during the execution of the 118function. 119.El 120.Sh SEE ALSO 121.Xr dwarf 3 , 122.Xr dwarf_add_fde_inst 3 , 123.Xr dwarf_add_frame_fde 3 , 124.Xr dwarf_add_frame_fde_b 3 , 125.Xr dwarf_fde_cfa_offset 3 , 126.Xr dwarf_new_fde 3 , 127.Xr dwarf_producer_init 3 , 128.Xr dwarf_producer_init_b 3 129