1.\" $NetBSD: dwarf_fde_cfa_offset.3,v 1.2 2014/03/09 16:58:03 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_fde_cfa_offset.3 2073 2011-10-27 03:30:47Z jkoshy 28.\" 29.Dd September 26, 2011 30.Os 31.Dt DWARF_FDE_CFA_OFFSET 3 32.Sh NAME 33.Nm dwarf_fde_cfa_offset 34.Nd add a DW_CFA_offset 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_fde_cfa_offset 41.Fa "Dwarf_P_Fde fde" 42.Fa "Dwarf_Unsigned reg" 43.Fa "Dwarf_Signed offset" 44.Fa "Dwarf_Error *err" 45.Fc 46.Sh DESCRIPTION 47Function 48.Fn dwarf_fde_cfa_offset 49appends a 50.Dv DW_CFA_offset 51frame instruction to the frame descriptor referenced by argument 52.Ar fde . 53.Pp 54Argument 55.Ar fde 56should reference a frame descriptor allocated using 57.Xr dwarf_new_fde 3 . 58.Pp 59Argument 60.Ar reg 61specifies the register operand for the frame instruction. 62.Pp 63Argument 64.Ar offset 65specifies the offset operand for the frame instruction. 66.Pp 67If argument 68.Ar err 69is not NULL, it will be used to store error information in case of an 70error. 71.Sh RETURN VALUES 72On success, function 73.Fn dwarf_fde_cfa_offset 74returns the frame descriptor given in argument 75.Ar fde . 76In case of an error, function 77.Fn dwarf_fde_cfa_offset 78returns 79.Dv DW_DLV_BADADDR 80and sets the argument 81.Ar err . 82.Sh ERRORS 83Function 84.Fn dwarf_fde_cfa_offset 85can fail with: 86.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 87.It Bq Er DW_DLE_ARGUMENT 88Argument 89.Ar fde 90was NULL. 91.It Bq Er DW_DLE_MEMORY 92An out of memory condition was encountered during the execution of the 93function. 94.El 95.Sh SEE ALSO 96.Xr dwarf 3 , 97.Xr dwarf_add_fde_inst 3 , 98.Xr dwarf_add_frame_fde 3 , 99.Xr dwarf_add_frame_fde_b 3 , 100.Xr dwarf_add_frame_cie 3 , 101.Xr dwarf_new_fde 3 102