1.\" $NetBSD: dwarf_get_cie_info.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_info.3 2071 2011-10-27 03:20:00Z jkoshy 28.\" 29.Dd May 29, 2011 30.Os 31.Dt DWARF_GET_CIE_INFO 3 32.Sh NAME 33.Nm dwarf_get_cie_info 34.Nd retrieve information associated with a CIE descriptor 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft int 40.Fo dwarf_get_cie_info 41.Fa "Dwarf_Cie cie" 42.Fa "Dwarf_Unsigned *cie_byte_len" 43.Fa "Dwarf_Small *version" 44.Fa "char **augmentation" 45.Fa "Dwarf_Unsigned *caf" 46.Fa "Dwarf_Unsigned *daf" 47.Fa "Dwarf_Half *ra" 48.Fa "Dwarf_Ptr *init_inst" 49.Fa "Dwarf_Unsigned *inst_len" 50.Fa "Dwarf_Error *err" 51.Fc 52.Sh DESCRIPTION 53Function 54.Fn dwarf_get_cie_info 55retrieves the information associated with a given CIE descriptor. 56.Pp 57Argument 58.Ar cie 59should reference a valid DWARF CIE descriptor, such as would be 60returned by function 61.Xr dwarf_get_cie_of_fde 3 . 62.Pp 63Argument 64.Ar cie_byte_len 65should point to a location that will hold the length in bytes of 66the CIE descriptor itself. 67.Pp 68Argument 69.Ar version 70should point to a location that will hold the version number of 71the CIE descriptor. 72.Pp 73Arugment 74.Ar augmentation 75should point to a location that will be set to a pointer to a 76NUL-terminated string containing augmentation data encoded as UTF-8. 77.Pp 78Argument 79.Ar caf 80should point to a location that will hold the code alignment 81factor recorded in the CIE descriptor. 82.Pp 83Arugment 84.Ar daf 85should point to a location that will hold the data alignment 86factor recorded in the CIE descriptor. 87.Pp 88Argument 89.Ar ra 90should point to a location that will hold the return address 91recorded in the CIE descriptor. 92.Pp 93Argument 94.Ar init_inst 95should point to a location that will be set to a pointer to an array 96of bytes containing the initial instructions associated with the CIE 97descriptor. 98.Pp 99Argument 100.Ar inst_len 101should point to a location that will hold the length in bytes 102of the initial instructions returned in argument 103.Ar init_inst . 104.Pp 105If argument 106.Ar err 107is not NULL, it will be used to store error information in case of an 108error. 109.Sh RETURN VALUES 110Function 111.Fn dwarf_get_cie_info 112returns 113.Dv DW_DLV_OK 114when it succeeds. 115In case of an error, it returns 116.Dv DW_DLV_ERROR 117and sets the argument 118.Ar err . 119.Sh ERRORS 120Function 121.Fn dwarf_get_cie_info 122can fail with: 123.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 124.It Bq Er DW_DLE_ARGUMENT 125One of the arguments 126.Ar cie , 127.Ar cie_byte_len , 128.Ar version , 129.Ar augmentation , 130.Ar caf , 131.Ar daf , 132.Ar ra , 133.Ar init_inst 134or 135.Ar inst_len 136was NULL. 137.El 138.Sh SEE ALSO 139.Xr dwarf 3 , 140.Xr dwarf_get_cie_index 3 , 141.Xr dwarf_get_cie_of_fde 3 , 142.Xr dwarf_get_fde_at_pc 3 , 143.Xr dwarf_get_fde_info_for_all_regs 3 , 144.Xr dwarf_get_fde_info_for_all_regs3 3 , 145.Xr dwarf_get_fde_info_for_cfa_reg3 3 , 146.Xr dwarf_get_fde_info_for_reg 3 , 147.Xr dwarf_get_fde_info_for_reg3 3 , 148.Xr dwarf_get_fde_instr_bytes 3 , 149.Xr dwarf_get_fde_list 3 , 150.Xr dwarf_get_fde_list_eh 3 , 151.Xr dwarf_get_fde_n 3 , 152.Xr dwarf_get_fde_range 3 153