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