1.\" $NetBSD: dwarf_get_cie_of_fde.3,v 1.2 2014/03/09 16:58:04 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_get_cie_of_fde.3 2071 2011-10-27 03:20:00Z jkoshy 28.\" 29.Dd May 22, 2011 30.Os 31.Dt DWARF_GET_CIE_OF_FDE 3 32.Sh NAME 33.Nm dwarf_get_cie_of_fde 34.Nd retrieve CIE descriptor 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft int 40.Fo dwarf_get_cie_of_fde 41.Fa "Dwarf_Fde fde" 42.Fa "Dwarf_Cie *ret_cie" 43.Fa "Dwarf_Error *err" 44.Fc 45.Sh DESCRIPTION 46Function 47.Fn dwarf_get_cie_of_fde 48retrieves the CIE descriptor associated with a given FDE descriptor. 49.Pp 50Argument 51.Ar fde 52should reference a valid FDE descriptor. 53.Pp 54Argument 55.Ar ret_cie 56should point to a location that will hold the returned CIE 57descriptor. 58.Pp 59If argument 60.Ar err 61is not NULL, it will be used to store error information in case of an 62error. 63.Sh RETURN VALUES 64Function 65.Fn dwarf_get_cie_of_fde 66returns 67.Dv DW_DLV_OK 68when it succeeds. 69In case of an error, it returns 70.Dv DW_DLV_ERROR 71and sets the argument 72.Ar err . 73.Sh ERRORS 74Function 75.Fn dwarf_get_cie_of_fde 76can fail with: 77.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 78.It Bq Er DW_DLE_ARGUMENT 79Either of arugments 80.Ar fde 81or 82.Ar ret_cie 83was NULL. 84.El 85.Sh SEE ALSO 86.Xr dwarf 3 , 87.Xr dwarf_get_cie_info 3 , 88.Xr dwarf_get_cie_index 3 , 89.Xr dwarf_get_fde_at_pc 3 , 90.Xr dwarf_get_fde_n 3 91