xref: /netbsd-src/external/bsd/elftoolchain/dist/libdwarf/dwarf_producer_set_isa.3 (revision 5ac3bc719ce6e70593039505b491894133237d12)
1.\"	$NetBSD: dwarf_producer_set_isa.3,v 1.6 2024/03/03 17:37:32 christos Exp $
2.\"
3.\" Copyright (c) 2011 Joseph Koshy
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_producer_set_isa.3 3963 2022-03-12 16:07:32Z jkoshy
28.\"
29.Dd September 29, 2011
30.Dt DWARF_PRODUCER_SET_ISA 3
31.Os
32.Sh NAME
33.Nm dwarf_producer_set_isa
34.Nd specify the instruction set architecture for a DWARF producer instance
35.Sh LIBRARY
36.Lb libdwarf
37.Sh SYNOPSIS
38.In libdwarf.h
39.Ft int
40.Fo dwarf_producer_set_isa
41.Fa "Dwarf_P_Debug dbg"
42.Fa "enum Dwarf_ISA isa"
43.Fa "Dwarf_Error *err"
44.Fc
45.Sh DESCRIPTION
46The function
47.Fn dwarf_producer_set_isa
48sets the instruction set architecture for a DWARF producer instance.
49.Pp
50Argument
51.Fa dbg
52should reference a DWARF producer instance allocated using one of
53the functions
54.Xr dwarf_producer_init 3
55or
56.Xr dwarf_producer_init_b 3 .
57.Pp
58Argument
59.Fa isa
60specifies the desired instruction set architecture.
61Legal values for this argument are those defined by the
62.Vt "enum Dwarf_ISA"
63enumeration defined in the header file
64.In libdwarf.h .
65.Pp
66If the argument
67.Fa err
68is not
69.Dv NULL ,
70it will be used to store error information in case of an error.
71.Sh RETURN VALUES
72On success, the function
73.Fn dwarf_producer_set_isa
74returns
75.Dv DW_DLV_OK .
76In case of an error, this function returns
77.Dv DW_DLV_ERROR
78and sets the argument
79.Fa err .
80.Sh COMPATIBILITY
81The
82.Fn dwarf_producer_set_isa
83function is a local extension.
84.Sh ERRORS
85The
86.Fn dwarf_producer_set_isa
87function can fail with:
88.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
89.It Bq Er DW_DLE_ARGUMENT
90The argument
91.Fa dbg
92was
93.Dv NULL .
94.It Bq Er DW_DLE_ARGUMENT
95The argument
96.Fa isa
97was invalid.
98.El
99.Sh SEE ALSO
100.Xr dwarf 3 ,
101.Xr dwarf_producer_init 3 ,
102.Xr dwarf_producer_init_b 3
103