1.\" $NetBSD: dwarf_get_relocation_info_count.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_relocation_info_count.3 2071 2011-10-27 03:20:00Z jkoshy 28.\" 29.Dd September 3, 2011 30.Os 31.Dt DWARF_GET_RELOCATION_INFO_COUNT 3 32.Sh NAME 33.Nm dwarf_get_relocation_info_count 34.Nd return the number of relocation arrays 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft int 40.Fo dwarf_get_relocation_info_count 41.Fa "Dwarf_P_Debug dbg" 42.Fa "Dwarf_Unsigned *reloc_cnt" 43.Fa "int *drd_buffer_version" 44.Fa "Dwarf_Error *err" 45.Fc 46.Sh DESCRIPTION 47Function 48.Fn dwarf_get_relocation_info_count 49retrieves the total number of relocation arrays generated by a prior 50call to 51.Xr dwarf_transform_to_disk_form 3 . 52.Pp 53Argument 54.Ar dbg 55should reference a DWARF producer instance allocated using 56.Xr dwarf_producer_init 3 57or 58.Xr dwarf_producer_init_b 3 . 59The 60.Dv DW_DLC_SYMBOLIC_RELOCATIONS 61flag should have been set on the producer instance. 62.Pp 63Argument 64.Ar reloc_cnt 65should point to a location which will be set to the total number of 66relocation arrays generated. 67.Pp 68Argument 69.Ar drd_buffer_version 70should point to a location which will be set to the version number 71of the relocation structures returned (see the symbol 72.Dv DWARF_DRD_BUFFER_VERSION , 73defined in the header file 74.In libdwarf.h ) . 75.Pp 76If argument 77.Ar err 78is not NULL, it will be used to store error information in case 79of an error. 80.Sh RETURN VALUES 81On success, function 82.Fn dwarf_get_relocation_info_count 83returns 84.Dv DW_DLV_OK . 85It returns 86.Dv DW_DLV_NO_ENTRY 87if the 88.Dv DW_DLC_SYMBOLIC_RELOCATIONS 89flag is not set on the producer instance. 90In case of an error, function 91.Fn dwarf_get_relocation_info_count 92returns 93.Dv DW_DLV_ERROR 94and sets the argument 95.Ar err . 96.Sh ERRORS 97Function 98.Fn dwarf_get_relocation_info_count 99can fail with: 100.Bl -tag -width ".Bq Er DW_DLE_NO_ENTRY" 101.It Bq Er DW_DLE_ARGUMENT 102One of the arguments 103.Ar dbg , 104.Ar reloc_cnt 105or 106.Ar drd_buffer_version 107was NULL. 108.It Bq Er DW_DLE_NO_ENTRY 109The 110.Dv DW_DLC_SYMBOLIC_RELOCATIONS 111flag was not set. 112.El 113.Sh SEE ALSO 114.Xr dwarf 3 , 115.Xr dwarf_get_relocation_info 3 , 116.Xr dwarf_producer_init 3 , 117.Xr dwarf_producer_init_b 3 , 118.Xr dwarf_transform_to_disk_form 3 119