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