xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_get_relocation_info_count.3 (revision ae500c1ff8974130f7f2692772cf288b90349e0d)

.\" Copyright (c) 2011 Kai Wang
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: dwarf_get_relocation_info_count.3 3640 2018-10-14 14:09:13Z jkoshy $
.\"
.Dd September 3, 2011
.Dt DWARF_GET_RELOCATION_INFO_COUNT 3
.Os
.Sh NAME
.Nm dwarf_get_relocation_info_count
.Nd return the number of relocation arrays
.Sh LIBRARY
.Lb libdwarf
.Sh SYNOPSIS
.In libdwarf.h
.Ft int
.Fo dwarf_get_relocation_info_count
.Fa "Dwarf_P_Debug dbg"
.Fa "Dwarf_Unsigned *reloc_cnt"
.Fa "int *drd_buffer_version"
.Fa "Dwarf_Error *err"
.Fc
.Sh DESCRIPTION
Function
.Fn dwarf_get_relocation_info_count
retrieves the total number of relocation arrays generated by a prior
call to
.Xr dwarf_transform_to_disk_form 3 .
.Pp
Argument
.Ar dbg
should reference a DWARF producer instance allocated using
.Xr dwarf_producer_init 3
or
.Xr dwarf_producer_init_b 3 .
The
.Dv DW_DLC_SYMBOLIC_RELOCATIONS
flag should have been set on the producer instance.
.Pp
Argument
.Ar reloc_cnt
should point to a location which will be set to the total number of
relocation arrays generated.
.Pp
Argument
.Ar drd_buffer_version
should point to a location which will be set to the version number
of the relocation structures returned (see the symbol
.Dv DWARF_DRD_BUFFER_VERSION ,
defined in the header file
.In libdwarf.h ) .
.Pp
If argument
.Ar err
is not NULL, it will be used to store error information in case
of an error.
.Sh RETURN VALUES
On success, function
.Fn dwarf_get_relocation_info_count
returns
.Dv DW_DLV_OK .
It returns
.Dv DW_DLV_NO_ENTRY
if the
.Dv DW_DLC_SYMBOLIC_RELOCATIONS
flag is not set on the producer instance.
In case of an error, function
.Fn dwarf_get_relocation_info_count
returns
.Dv DW_DLV_ERROR
and sets the argument
.Ar err .
.Sh ERRORS
Function
.Fn dwarf_get_relocation_info_count
can fail with:
.Bl -tag -width ".Bq Er DW_DLE_NO_ENTRY"
.It Bq Er DW_DLE_ARGUMENT
One of the arguments
.Ar dbg ,
.Ar reloc_cnt
or
.Ar drd_buffer_version
was NULL.
.It Bq Er DW_DLE_NO_ENTRY
The
.Dv DW_DLC_SYMBOLIC_RELOCATIONS
flag was not set.
.El
.Sh SEE ALSO
.Xr dwarf 3 ,
.Xr dwarf_get_relocation_info 3 ,
.Xr dwarf_producer_init 3 ,
.Xr dwarf_producer_init_b 3 ,
.Xr dwarf_transform_to_disk_form 3