share/man/man4/cloudabi.4

   1 .\" Copyright (c) 2015-2017 Nuxi, https://nuxi.nl/
   2 .\"
   3 .\" Redistribution and use in source and binary forms, with or without
   4 .\" modification, are permitted provided that the following conditions
   5 .\" are met:
   6 .\" 1. Redistributions of source code must retain the above copyright
   7 .\"    notice, this list of conditions and the following disclaimer.
   8 .\" 2. Redistributions in binary form must reproduce the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer in the
  10 .\"    documentation and/or other materials provided with the distribution.
  11 .\"
  12 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  13 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  14 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  15 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  16 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  17 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  18 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  19 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  20 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  21 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  22 .\" SUCH DAMAGE.
  23 .\"
  24 .\" $FreeBSD$
  25 .Dd November 30, 2017
  26 .Dt CLOUDABI 4
  27 .Os
  28 .Sh NAME
  29 .Nm cloudabi ,
  30 .Nm cloudabi32 ,
  31 .Nm cloudabi64
  32 .Nd CloudABI support
  33 .Sh SYNOPSIS
  34 Support for 32-bit CloudABI executables can be compiled into the kernel
  35 by adding this line to the kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd "options COMPAT_CLOUDABI32"
  38 .Ed
  39 .Pp
  40 Similarly,
  41 support for 64-bit CloudABI executables can be enabled by adding this
  42 line:
  43 .Bd -ragged -offset indent
  44 .Cd "options COMPAT_CLOUDABI64"
  45 .Ed
  46 .Pp
  47 CloudABI support can also be loaded at boot time from
  48 .Xr loader.conf 5 :
  49 .Bd -literal -offset indent
  50 cloudabi_load="YES"
  51 cloudabi32_load="YES"
  52 cloudabi64_load="YES"
  53 .Ed
  54 .Sh DESCRIPTION
  55 CloudABI is a POSIX-like pure capability-based runtime environment,
  56 similar to
  57 .Xr capsicum 4 .
  58 It can be used to develop applications that are cross-platform,
  59 easier to test,
  60 and hardened against security exploits.
  61 .Pp
  62 Support for CloudABI on
  63 .Fx
  64 consists of three separate kernel modules.
  65 The
  66 .Nm cloudabi
  67 kernel module implements all of the system calls that do not depend on
  68 data structures that differ between hardware architectures.
  69 .Pp
  70 The
  71 .Nm cloudabi32
  72 and
  73 .Nm cloudabi64
  74 kernel modules provide implementations of all of the machine-dependent
  75 system calls,
  76 assuming that pointers stored in data structures are either 32 bits or
  77 64 bits in size.
  78 These modules also provide the image activators that load and start ELF
  79 executables.
  80 .Pp
  81 Though the
  82 .Nm cloudabi
  83 module can be loaded on any architecture supported by
  84 .Fx ,
  85 the
  86 .Nm cloudabi32
  87 module is only available on amd64, arm64, armv6, armv7 and i386.
  88 The same holds for the
  89 .Nm cloudabi64
  90 module,
  91 which is only available for amd64 and arm64.
  92 .Pp
  93 A full cross compilation toolchain for CloudABI is available in the
  94 .Pa devel/cloudabi-toolchain
  95 port.
  96 .Pp
  97 The
  98 .Pa sysutils/cloudabi-utils
  99 port provides the
 100 .Xr cloudabi-run 1
 101 utility.
 102 .Xr cloudabi-run 1
 103 can be used to safely execute CloudABI processes with access to a
 104 restricted set of resources.
 105 .Sh SEE ALSO
 106 .Xr cloudabi-run 1 ,
 107 .Xr capsicum 4 ,
 108 .Xr linux 4 ,
 109 .Xr elf 5
 110 .Pp
 111 CloudABI for FreeBSD:
 112 .Pa https://nuxi.nl/cloudabi/freebsd/ .
 113 .Pp
 114 cloudlibc on GitHub:
 115 .Pa https://github.com/NuxiNL/cloudlibc .
 116 .Pp
 117 The CloudABI Ports Collection on GitHub:
 118 .Pa https://github.com/NuxiNL/cloudabi-ports .
 119 .Sh HISTORY
 120 CloudABI support first appeared in
 121 .Fx 11.0 .
 122 .Sh AUTHORS
 123 .An Nuxi : Pa https://nuxi.nl/ .