lib/libsysdecode/sysdecode_abi_to_freebsd_errno.3

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