freebsd-dev/contrib/elftoolchain/libdwarf/dwarf_producer_set_isa.3
Ed Maste ae500c1ff8 Update to ELF Tool Chain r3668
Highlights:
- Make sure that only TLS sections are sorted into TLS segment.
- Fixed multiple errors in "Section to Segment mapping".
- Man page updates
- ar improvements
- elfcopy: avoid filter_reloc uninitialized variable for rela
- elfcopy: avoid stripping relocations from static binaries
- readelf: avoid printing directory in front of absolute path
- readelf: add NT_FREEBSD_FEATURE_CTL FreeBSD note type
- test improvements

NOTES:

Some of these changes originated in FreeBSD and simply reduce diffs
between contrib and vendor.

ELF Tool Chain ar is not (currently) used in FreeBSD, and there are
improvements in both FreeBSD and ELF Tool Chain ar that are not in
the other.

Sponsored by:	The FreeBSD Foundation
2019-01-10 14:35:23 +00:00

99 lines
2.9 KiB
Groff

.\" Copyright (c) 2011 Joseph Koshy
.\" 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_producer_set_isa.3 3644 2018-10-15 19:55:01Z jkoshy $
.\"
.Dd September 29, 2011
.Dt DWARF_PRODUCER_SET_ISA 3
.Os
.Sh NAME
.Nm dwarf_producer_set_isa
.Nd specify the instruction set architecture for a DWARF producer instance
.Sh LIBRARY
.Lb libdwarf
.Sh SYNOPSIS
.In libdwarf.h
.Ft int
.Fo dwarf_producer_set_isa
.Fa "Dwarf_P_Debug dbg"
.Fa "enum Dwarf_ISA isa"
.Fa "Dwarf_Error *err"
.Fc
.Sh DESCRIPTION
The function
.Fn dwarf_producer_set_isa
sets the instruction set architecture for a DWARF producer instance.
.Pp
Argument
.Ar dbg
should reference a DWARF producer instance allocated using one of
the functions
.Xr dwarf_producer_init 3
or
.Xr dwarf_producer_init_b 3 .
.Pp
Argument
.Ar isa
specifies the desired instruction set architecture.
Legal values for this argument are those defined by the
.Vt "enum Dwarf_ISA"
enumeration defined in the header file
.In libdwarf.h .
.Pp
If the argument
.Ar err
is not NULL, it will be used to store error information in case of an
error.
.Sh RETURN VALUES
On success, the function
.Fn dwarf_producer_set_isa
returns
.Dv DW_DLV_OK .
In case of an error, this function returns
.Dv DW_DLV_ERROR
and sets the argument
.Ar err .
.Sh COMPATIBILITY
The
.Fn dwarf_producer_set_isa
function is a local extension.
.Sh ERRORS
The
.Fn dwarf_producer_set_isa
function can fail with:
.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
.It Bq Er DW_DLE_ARGUMENT
The argument
.Ar dbg
was NULL.
.It Bq Er DW_DLE_ARGUMENT
The argument
.Ar isa
was invalid.
.El
.Sh SEE ALSO
.Xr dwarf 3 ,
.Xr dwarf_producer_init 3 ,
.Xr dwarf_producer_init_b 3