lib/libsysdecode/sysdecode_abi_to_freebsd_errno.3

   1 .\"
   2 .\" Copyright (c) 2016 John Baldwin <jhb@FreeBSD.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd October 17, 2016
  29 .Dt sysdecode_abi_to_freebsd_errno 3
  30 .Os
  31 .Sh NAME
  32 .Nm sysdecode_abi_to_freebsd_errno ,
  33 .Nm sysdecode_freebsd_to_abi_errno
  34 .Nd translate error numbers between process ABIs
  35 .Sh LIBRARY
  36 .Lb libsysdecode
  37 .Sh SYNOPSIS
  38 .In sys/types.h
  39 .In stdbool.h
  40 .In sysdecode.h
  41 .Ft int
  42 .Fn sysdecode_abi_to_freebsd_errno "enum sysdecode_abi abi" "int error"
  43 .Ft int
  44 .Fn sysdecode_freebsd_to_abi_errno "enum sysdecode_abi abi" "int error"
  45 .Sh DESCRIPTION
  46 The
  47 .Fn sysdecode_abi_to_freebsd_errno
  48 function returns the native
  49 .Xr errno 2
  50 value that corresponds to the error indicated by
  51 .Fa error
  52 for the process ABI
  53 .Fa abi .
  54 If
  55 .Fa error
  56 does not identify a valid error for
  57 .Fa abi ,
  58 .Dv INT_MAX
  59 is returned.
  60 .Pp
  61 The
  62 .Fn sysdecode_freebsd_to_abi_errno
  63 function the error value for the process ABI
  64 .Fa abi
  65 that corresponds to the native
  66 .Xr errno 2
  67 value
  68 .Fa error .
  69 If
  70 .Fa error
  71 does not identify a valid
  72 .Xr errno 2
  73 error,
  74 .Dv INT_MAX
  75 is returned.
  76 .Pp
  77 Note that the mappings between native
  78 .Xr errno 2
  79 values and errors for other ABIs are not exhaustive.
  80 If a mapping does not exist,
  81 these functions return
  82 .Dv INT_MAX .
  83 In addition, multiple error values in one ABI may map to a single
  84 error in another ABI.
  85 .Sh RETURN VALUES
  86 These functions return an error value on success or
  87 .Dv INT_MAX
  88 if
  89 .Fa error
  90 is not valid.
  91 .Pp
  92 For the list of supported ABIs,
  93 see
  94 .Xr sysdecode 3 .
  95 .Sh SEE ALSO
  96 .Xr sysdecode 3 ,
  97 .Xr sysdecode_syscallnames 3