xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_get_fde_range.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_fde_range.3 3644 2018-10-15 19:55:01Z jkoshy $
.\"
.Dd May 22, 2011
.Dt DWARF_GET_FDE_RANGE 3
.Os
.Sh NAME
.Nm dwarf_get_fde_range
.Nd retrieve range information from an FDE descriptor
.Sh LIBRARY
.Lb libdwarf
.Sh SYNOPSIS
.In libdwarf.h
.Ft int
.Fo dwarf_get_fde_range
.Fa "Dwarf_Fde fde"
.Fa "Dwarf_Addr *low_pc"
.Fa "Dwarf_Unsigned *func_len"
.Fa "Dwarf_Ptr *fde_bytes"
.Fa "Dwarf_Unsigned *fde_byte_len"
.Fa "Dwarf_Off *cie_offset"
.Fa "Dwarf_Signed *cie_index"
.Fa "Dwarf_Off *fde_offset"
.Fa "Dwarf_Error *err"
.Fc
.Sh DESCRIPTION
Function
.Fn dwarf_get_fde_range
retrieves range and offset information from a given FDE descriptor.
.Pp
Argument
.Ar fde
should reference a valid DWARF FDE descriptor.
.Pp
Argument
.Ar low_pc
should point to a location that will be set to the lowest
program counter address covered by the FDE descriptor.
.Pp
Argument
.Ar func_len
should point to a location that will hold the length in bytes of
the address range covered by the FDE descriptor.
.Pp
Argument
.Ar fde_bytes
should point to a location that will be set to a pointer to the
content of the FDE descriptor itself.
.Pp
Argument
.Ar fde_byte_len
should point to a location that will hold the length in bytes of
the FDE descriptor itself.
.Pp
Argument
.Ar cie_offset
should point to a location that will be set to the offset, relative to
the DWARF
.Dq ".debug_frame"
section, of the CIE descriptor associated with the given FDE
descriptor.
.Pp
Argument
.Ar cie_index
should point to a location that will hold the index of the CIE
descriptor associated with the FDE descriptor.
The returned value is a zero-based index into the array of CIE
descriptors returned by a prior call to functions
.Xr dwarf_get_fde_list 3
or
.Xr dwarf_get_fde_list_eh 3 .
.Pp
Argument
.Ar fde_offset
should point to a location that will be set to the offset, relative to
the DWARF
.Dq ".debug_frame"
section, of the FDE descriptor.
.Pp
If argument
.Ar err
is not NULL, it will be used to store error information in case of an
error.
.Sh RETURN VALUES
Function
.Fn dwarf_get_fde_range
returns
.Dv DW_DLV_OK
when it succeeds.
In case of an error, it returns
.Dv DW_DLV_ERROR
and sets the argument
.Ar err .
.Sh ERRORS
Function
.Fn dwarf_get_fde_range
can fail with:
.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
.It Bq Er DW_DLE_ARGUMENT
One of the arguments
.Ar fde ,
.Ar low_pc ,
.Ar func_len ,
.Ar fde_bytes ,
.Ar fde_byte_len ,
.Ar cie_offset ,
.Ar cie_index
or
.Ar fde_offset
was NULL.
.El
.Sh SEE ALSO
.Xr dwarf 3 ,
.Xr dwarf_get_cie_index 3 ,
.Xr dwarf_get_cie_info 3 ,
.Xr dwarf_get_cie_of_fde 3 ,
.Xr dwarf_get_fde_at_pc 3 ,
.Xr dwarf_get_fde_info_for_all_regs 3 ,
.Xr dwarf_get_fde_info_for_all_regs3 3 ,
.Xr dwarf_get_fde_info_for_cfa_reg3 3 ,
.Xr dwarf_get_fde_info_for_reg 3 ,
.Xr dwarf_get_fde_info_for_reg3 3 ,
.Xr dwarf_get_fde_instr_bytes 3 ,
.Xr dwarf_get_fde_list 3 ,
.Xr dwarf_get_fde_list_eh 3 ,
.Xr dwarf_get_fde_n 3