xref: /freebsd/lib/libsysdecode/sysdecode_abi_to_freebsd_errno.3 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1.\"
2.\" Copyright (c) 2016 John Baldwin <jhb@FreeBSD.org>
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.Dd October 17, 2016
26.Dt sysdecode_abi_to_freebsd_errno 3
27.Os
28.Sh NAME
29.Nm sysdecode_abi_to_freebsd_errno ,
30.Nm sysdecode_freebsd_to_abi_errno
31.Nd translate error numbers between process ABIs
32.Sh LIBRARY
33.Lb libsysdecode
34.Sh SYNOPSIS
35.In sysdecode.h
36.Ft int
37.Fn sysdecode_abi_to_freebsd_errno "enum sysdecode_abi abi" "int error"
38.Ft int
39.Fn sysdecode_freebsd_to_abi_errno "enum sysdecode_abi abi" "int error"
40.Sh DESCRIPTION
41The
42.Fn sysdecode_abi_to_freebsd_errno
43function returns the native
44.Xr errno 2
45value that corresponds to the error indicated by
46.Fa error
47for the process ABI
48.Fa abi .
49If
50.Fa error
51does not identify a valid error for
52.Fa abi ,
53.Dv INT_MAX
54is returned.
55.Pp
56The
57.Fn sysdecode_freebsd_to_abi_errno
58function the error value for the process ABI
59.Fa abi
60that corresponds to the native
61.Xr errno 2
62value
63.Fa error .
64If
65.Fa error
66does not identify a valid
67.Xr errno 2
68error,
69.Dv INT_MAX
70is returned.
71.Pp
72Note that the mappings between native
73.Xr errno 2
74values and errors for other ABIs are not exhaustive.
75If a mapping does not exist,
76these functions return
77.Dv INT_MAX .
78In addition, multiple error values in one ABI may map to a single
79error in another ABI.
80.Sh RETURN VALUES
81These functions return an error value on success or
82.Dv INT_MAX
83if
84.Fa error
85is not valid.
86.Pp
87For the list of supported ABIs,
88see
89.Xr sysdecode 3 .
90.Sh SEE ALSO
91.Xr sysdecode 3 ,
92.Xr sysdecode_syscallnames 3
93