xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_producer_set_isa.3 (revision ae500c1ff8974130f7f2692772cf288b90349e0d)
12de3b87aSKai Wang.\" Copyright (c) 2011 Joseph Koshy
22de3b87aSKai Wang.\" All rights reserved.
32de3b87aSKai Wang.\"
42de3b87aSKai Wang.\" Redistribution and use in source and binary forms, with or without
52de3b87aSKai Wang.\" modification, are permitted provided that the following conditions
62de3b87aSKai Wang.\" are met:
72de3b87aSKai Wang.\" 1. Redistributions of source code must retain the above copyright
82de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer.
92de3b87aSKai Wang.\" 2. Redistributions in binary form must reproduce the above copyright
102de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer in the
112de3b87aSKai Wang.\"    documentation and/or other materials provided with the distribution.
122de3b87aSKai Wang.\"
132de3b87aSKai Wang.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
142de3b87aSKai Wang.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
152de3b87aSKai Wang.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
162de3b87aSKai Wang.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
172de3b87aSKai Wang.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
182de3b87aSKai Wang.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
192de3b87aSKai Wang.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
202de3b87aSKai Wang.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
212de3b87aSKai Wang.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
222de3b87aSKai Wang.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
232de3b87aSKai Wang.\" SUCH DAMAGE.
242de3b87aSKai Wang.\"
25*ae500c1fSEd Maste.\" $Id: dwarf_producer_set_isa.3 3644 2018-10-15 19:55:01Z jkoshy $
262de3b87aSKai Wang.\"
272de3b87aSKai Wang.Dd September 29, 2011
282de3b87aSKai Wang.Dt DWARF_PRODUCER_SET_ISA 3
29*ae500c1fSEd Maste.Os
302de3b87aSKai Wang.Sh NAME
312de3b87aSKai Wang.Nm dwarf_producer_set_isa
322de3b87aSKai Wang.Nd specify the instruction set architecture for a DWARF producer instance
332de3b87aSKai Wang.Sh LIBRARY
342de3b87aSKai Wang.Lb libdwarf
352de3b87aSKai Wang.Sh SYNOPSIS
362de3b87aSKai Wang.In libdwarf.h
372de3b87aSKai Wang.Ft int
382de3b87aSKai Wang.Fo dwarf_producer_set_isa
392de3b87aSKai Wang.Fa "Dwarf_P_Debug dbg"
402de3b87aSKai Wang.Fa "enum Dwarf_ISA isa"
412de3b87aSKai Wang.Fa "Dwarf_Error *err"
422de3b87aSKai Wang.Fc
432de3b87aSKai Wang.Sh DESCRIPTION
442de3b87aSKai WangThe function
452de3b87aSKai Wang.Fn dwarf_producer_set_isa
462de3b87aSKai Wangsets the instruction set architecture for a DWARF producer instance.
472de3b87aSKai Wang.Pp
482de3b87aSKai WangArgument
492de3b87aSKai Wang.Ar dbg
502de3b87aSKai Wangshould reference a DWARF producer instance allocated using one of
512de3b87aSKai Wangthe functions
522de3b87aSKai Wang.Xr dwarf_producer_init 3
532de3b87aSKai Wangor
542de3b87aSKai Wang.Xr dwarf_producer_init_b 3 .
552de3b87aSKai Wang.Pp
562de3b87aSKai WangArgument
572de3b87aSKai Wang.Ar isa
582de3b87aSKai Wangspecifies the desired instruction set architecture.
592de3b87aSKai WangLegal values for this argument are those defined by the
602de3b87aSKai Wang.Vt "enum Dwarf_ISA"
612de3b87aSKai Wangenumeration defined in the header file
622de3b87aSKai Wang.In libdwarf.h .
632de3b87aSKai Wang.Pp
642de3b87aSKai WangIf the argument
652de3b87aSKai Wang.Ar err
662de3b87aSKai Wangis not NULL, it will be used to store error information in case of an
672de3b87aSKai Wangerror.
682de3b87aSKai Wang.Sh RETURN VALUES
692de3b87aSKai WangOn success, the function
702de3b87aSKai Wang.Fn dwarf_producer_set_isa
712de3b87aSKai Wangreturns
722de3b87aSKai Wang.Dv DW_DLV_OK .
732de3b87aSKai WangIn case of an error, this function returns
742de3b87aSKai Wang.Dv DW_DLV_ERROR
752de3b87aSKai Wangand sets the argument
762de3b87aSKai Wang.Ar err .
77*ae500c1fSEd Maste.Sh COMPATIBILITY
78*ae500c1fSEd MasteThe
79*ae500c1fSEd Maste.Fn dwarf_producer_set_isa
80*ae500c1fSEd Mastefunction is a local extension.
812de3b87aSKai Wang.Sh ERRORS
822de3b87aSKai WangThe
832de3b87aSKai Wang.Fn dwarf_producer_set_isa
842de3b87aSKai Wangfunction can fail with:
852de3b87aSKai Wang.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
862de3b87aSKai Wang.It Bq Er DW_DLE_ARGUMENT
872de3b87aSKai WangThe argument
882de3b87aSKai Wang.Ar dbg
892de3b87aSKai Wangwas NULL.
902de3b87aSKai Wang.It Bq Er DW_DLE_ARGUMENT
912de3b87aSKai WangThe argument
922de3b87aSKai Wang.Ar isa
932de3b87aSKai Wangwas invalid.
942de3b87aSKai Wang.El
952de3b87aSKai Wang.Sh SEE ALSO
962de3b87aSKai Wang.Xr dwarf 3 ,
972de3b87aSKai Wang.Xr dwarf_producer_init 3 ,
982de3b87aSKai Wang.Xr dwarf_producer_init_b 3
99