xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_producer_set_isa.3 (revision d4eeb02986980bf33dd56c41ceb9fc5f180c0d47)
1.\" Copyright (c) 2011 Joseph Koshy
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $Id: dwarf_producer_set_isa.3 3644 2018-10-15 19:55:01Z jkoshy $
26.\"
27.Dd September 29, 2011
28.Dt DWARF_PRODUCER_SET_ISA 3
29.Os
30.Sh NAME
31.Nm dwarf_producer_set_isa
32.Nd specify the instruction set architecture for a DWARF producer instance
33.Sh LIBRARY
34.Lb libdwarf
35.Sh SYNOPSIS
36.In libdwarf.h
37.Ft int
38.Fo dwarf_producer_set_isa
39.Fa "Dwarf_P_Debug dbg"
40.Fa "enum Dwarf_ISA isa"
41.Fa "Dwarf_Error *err"
42.Fc
43.Sh DESCRIPTION
44The function
45.Fn dwarf_producer_set_isa
46sets the instruction set architecture for a DWARF producer instance.
47.Pp
48Argument
49.Ar dbg
50should reference a DWARF producer instance allocated using one of
51the functions
52.Xr dwarf_producer_init 3
53or
54.Xr dwarf_producer_init_b 3 .
55.Pp
56Argument
57.Ar isa
58specifies the desired instruction set architecture.
59Legal values for this argument are those defined by the
60.Vt "enum Dwarf_ISA"
61enumeration defined in the header file
62.In libdwarf.h .
63.Pp
64If the argument
65.Ar err
66is not NULL, it will be used to store error information in case of an
67error.
68.Sh RETURN VALUES
69On success, the function
70.Fn dwarf_producer_set_isa
71returns
72.Dv DW_DLV_OK .
73In case of an error, this function returns
74.Dv DW_DLV_ERROR
75and sets the argument
76.Ar err .
77.Sh COMPATIBILITY
78The
79.Fn dwarf_producer_set_isa
80function is a local extension.
81.Sh ERRORS
82The
83.Fn dwarf_producer_set_isa
84function can fail with:
85.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
86.It Bq Er DW_DLE_ARGUMENT
87The argument
88.Ar dbg
89was NULL.
90.It Bq Er DW_DLE_ARGUMENT
91The argument
92.Ar isa
93was invalid.
94.El
95.Sh SEE ALSO
96.Xr dwarf 3 ,
97.Xr dwarf_producer_init 3 ,
98.Xr dwarf_producer_init_b 3
99