xref: /freebsd-13.1/share/man/man4/cloudabi.4 (revision ab3f1b67)
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
34Support for 32-bit CloudABI executables can be compiled into the kernel
35by adding this line to the kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "options COMPAT_CLOUDABI32"
38.Ed
39.Pp
40Similarly,
41support for 64-bit CloudABI executables can be enabled by adding this
42line:
43.Bd -ragged -offset indent
44.Cd "options COMPAT_CLOUDABI64"
45.Ed
46.Pp
47CloudABI support can also be loaded at boot time from
48.Xr loader.conf 5 :
49.Bd -literal -offset indent
50cloudabi_load="YES"
51cloudabi32_load="YES"
52cloudabi64_load="YES"
53.Ed
54.Sh DEPRECATION NOTICE
55.Nm
56support is not present in
57.Fx 14.0 .
58.Sh DESCRIPTION
59CloudABI is a POSIX-like pure capability-based runtime environment,
60similar to
61.Xr capsicum 4 .
62It can be used to develop applications that are cross-platform,
63easier to test,
64and hardened against security exploits.
65.Pp
66Support for CloudABI on
67.Fx
68consists of three separate kernel modules.
69The
70.Nm cloudabi
71kernel module implements all of the system calls that do not depend on
72data structures that differ between hardware architectures.
73.Pp
74The
75.Nm cloudabi32
76and
77.Nm cloudabi64
78kernel modules provide implementations of all of the machine-dependent
79system calls,
80assuming that pointers stored in data structures are either 32 bits or
8164 bits in size.
82These modules also provide the image activators that load and start ELF
83executables.
84.Pp
85Though the
86.Nm cloudabi
87module can be loaded on any architecture supported by
88.Fx ,
89the
90.Nm cloudabi32
91module is only available on amd64, arm64, armv6, armv7 and i386.
92The same holds for the
93.Nm cloudabi64
94module,
95which is only available for amd64 and arm64.
96.Pp
97A full cross compilation toolchain for CloudABI is available in the
98.Pa devel/cloudabi-toolchain
99port.
100.Pp
101The
102.Pa sysutils/cloudabi-utils
103port provides the
104.Xr cloudabi-run 1
105utility.
106.Xr cloudabi-run 1
107can be used to safely execute CloudABI processes with access to a
108restricted set of resources.
109.Sh SEE ALSO
110.Xr cloudabi-run 1 ,
111.Xr capsicum 4 ,
112.Xr linux 4 ,
113.Xr elf 5
114.Pp
115CloudABI for FreeBSD:
116.Pa https://nuxi.nl/cloudabi/freebsd/ .
117.Pp
118cloudlibc on GitHub:
119.Pa https://github.com/NuxiNL/cloudlibc .
120.Pp
121The CloudABI Ports Collection on GitHub:
122.Pa https://github.com/NuxiNL/cloudabi-ports .
123.Sh HISTORY
124CloudABI support first appeared in
125.Fx 11.0 .
126.Sh AUTHORS
127.An Nuxi : Pa https://nuxi.nl/ .
128