d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
master
freebsd-skq/share/man/man4/cloudabi.4

124 lines
3.7 KiB
Groff
Raw Permalink Normal View History

Port cloudabi32.ko to FreeBSD/arm64. This change adds an implementation of a sysent for running CloudABI armv6 and armv7 binaries on FreeBSD/arm64. It is a somewhat literal copy of the armv6 version, except that it's been patched up to use the proper registers. Just like for cloudabi32.ko on FreeBSD/amd64, we make use of a vDSO that automatically pads system call parameters to 64-bit value. These are stored in a buffer on the stack, meaning we need to use copyin() and copyout() unconditionally.
2017-11-30 17:58:48 +00:00
.\" Copyright (c) 2015-2017 Nuxi, https://nuxi.nl/
Add a manual page for the cloudabi and cloudabi64 kernel modules. CloudABI has two separate kernel modules: cloudabi and cloudabi64. The first module contains all the pointer size independent code, whereas cloudabi64 contains the actual 64-bits specific system calls and the ELF loader. Reviewed by: wblock Obtained from: https://github.com/NuxiNL/freebsd Differential Revision: https://reviews.freebsd.org/D3258
2015-08-02 14:56:30 +00:00
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
Port cloudabi32.ko to FreeBSD/arm64. This change adds an implementation of a sysent for running CloudABI armv6 and armv7 binaries on FreeBSD/arm64. It is a somewhat literal copy of the armv6 version, except that it's been patched up to use the proper registers. Just like for cloudabi32.ko on FreeBSD/amd64, we make use of a vDSO that automatically pads system call parameters to 64-bit value. These are stored in a buffer on the stack, meaning we need to use copyin() and copyout() unconditionally.
2017-11-30 17:58:48 +00:00
.Dd November 30, 2017
Add a manual page for the cloudabi and cloudabi64 kernel modules. CloudABI has two separate kernel modules: cloudabi and cloudabi64. The first module contains all the pointer size independent code, whereas cloudabi64 contains the actual 64-bits specific system calls and the ELF loader. Reviewed by: wblock Obtained from: https://github.com/NuxiNL/freebsd Differential Revision: https://reviews.freebsd.org/D3258
2015-08-02 14:56:30 +00:00
.Dt CLOUDABI 4
.Os
.Sh NAME
.Nm cloudabi ,
Document the existence of the cloudabi32 kernel module.
2016-08-24 12:53:54 +00:00
.Nm cloudabi32 ,
Add a manual page for the cloudabi and cloudabi64 kernel modules. CloudABI has two separate kernel modules: cloudabi and cloudabi64. The first module contains all the pointer size independent code, whereas cloudabi64 contains the actual 64-bits specific system calls and the ELF loader. Reviewed by: wblock Obtained from: https://github.com/NuxiNL/freebsd Differential Revision: https://reviews.freebsd.org/D3258
2015-08-02 14:56:30 +00:00
.Nm cloudabi64
.Nd CloudABI support
.Sh SYNOPSIS
Document the existence of the cloudabi32 kernel module.
2016-08-24 12:53:54 +00:00
Support for 32-bit CloudABI executables can be compiled into the kernel
Add a manual page for the cloudabi and cloudabi64 kernel modules. CloudABI has two separate kernel modules: cloudabi and cloudabi64. The first module contains all the pointer size independent code, whereas cloudabi64 contains the actual 64-bits specific system calls and the ELF loader. Reviewed by: wblock Obtained from: https://github.com/NuxiNL/freebsd Differential Revision: https://reviews.freebsd.org/D3258
2015-08-02 14:56:30 +00:00
by adding this line to the kernel configuration file:
.Bd -ragged -offset indent
Document the existence of the cloudabi32 kernel module.
2016-08-24 12:53:54 +00:00
.Cd "options COMPAT_CLOUDABI32"
.Ed
.Pp
Similarly,
support for 64-bit CloudABI executables can be enabled by adding this
line:
.Bd -ragged -offset indent
Add a manual page for the cloudabi and cloudabi64 kernel modules. CloudABI has two separate kernel modules: cloudabi and cloudabi64. The first module contains all the pointer size independent code, whereas cloudabi64 contains the actual 64-bits specific system calls and the ELF loader. Reviewed by: wblock Obtained from: https://github.com/NuxiNL/freebsd Differential Revision: https://reviews.freebsd.org/D3258
2015-08-02 14:56:30 +00:00
.Cd "options COMPAT_CLOUDABI64"
.Ed
.Pp
CloudABI support can also be loaded at boot time from
.Xr loader.conf 5 :
.Bd -literal -offset indent
cloudabi_load="YES"
Document the existence of the cloudabi32 kernel module.
2016-08-24 12:53:54 +00:00
cloudabi32_load="YES"
Add a manual page for the cloudabi and cloudabi64 kernel modules. CloudABI has two separate kernel modules: cloudabi and cloudabi64. The first module contains all the pointer size independent code, whereas cloudabi64 contains the actual 64-bits specific system calls and the ELF loader. Reviewed by: wblock Obtained from: https://github.com/NuxiNL/freebsd Differential Revision: https://reviews.freebsd.org/D3258
2015-08-02 14:56:30 +00:00
cloudabi64_load="YES"
.Ed
.Sh DESCRIPTION
CloudABI is a POSIX-like pure capability-based runtime environment,
similar to
.Xr capsicum 4 .
It can be used to develop applications that are cross-platform,
easier to test,
and hardened against security exploits.
.Pp
Support for CloudABI on
.Fx
Document the existence of the cloudabi32 kernel module.
2016-08-24 12:53:54 +00:00
consists of three separate kernel modules.
Add a manual page for the cloudabi and cloudabi64 kernel modules. CloudABI has two separate kernel modules: cloudabi and cloudabi64. The first module contains all the pointer size independent code, whereas cloudabi64 contains the actual 64-bits specific system calls and the ELF loader. Reviewed by: wblock Obtained from: https://github.com/NuxiNL/freebsd Differential Revision: https://reviews.freebsd.org/D3258
2015-08-02 14:56:30 +00:00
The
.Nm cloudabi
kernel module implements all of the system calls that do not depend on
Document the existence of the cloudabi32 kernel module.
2016-08-24 12:53:54 +00:00
data structures that differ between hardware architectures.
Add a manual page for the cloudabi and cloudabi64 kernel modules. CloudABI has two separate kernel modules: cloudabi and cloudabi64. The first module contains all the pointer size independent code, whereas cloudabi64 contains the actual 64-bits specific system calls and the ELF loader. Reviewed by: wblock Obtained from: https://github.com/NuxiNL/freebsd Differential Revision: https://reviews.freebsd.org/D3258
2015-08-02 14:56:30 +00:00
.Pp
The
Document the existence of the cloudabi32 kernel module.
2016-08-24 12:53:54 +00:00
.Nm cloudabi32
and
Add a manual page for the cloudabi and cloudabi64 kernel modules. CloudABI has two separate kernel modules: cloudabi and cloudabi64. The first module contains all the pointer size independent code, whereas cloudabi64 contains the actual 64-bits specific system calls and the ELF loader. Reviewed by: wblock Obtained from: https://github.com/NuxiNL/freebsd Differential Revision: https://reviews.freebsd.org/D3258
2015-08-02 14:56:30 +00:00
.Nm cloudabi64
Document the existence of the cloudabi32 kernel module.
2016-08-24 12:53:54 +00:00
kernel modules provide implementations of all of the machine-dependent
system calls,
assuming that pointers stored in data structures are either 32 bits or
64 bits in size.
These modules also provide the image activators that load and start ELF
Add a manual page for the cloudabi and cloudabi64 kernel modules. CloudABI has two separate kernel modules: cloudabi and cloudabi64. The first module contains all the pointer size independent code, whereas cloudabi64 contains the actual 64-bits specific system calls and the ELF loader. Reviewed by: wblock Obtained from: https://github.com/NuxiNL/freebsd Differential Revision: https://reviews.freebsd.org/D3258
2015-08-02 14:56:30 +00:00
executables.
.Pp
Though the
.Nm cloudabi
module can be loaded on any architecture supported by
.Fx ,
the
Document the existence of the cloudabi32 kernel module.
2016-08-24 12:53:54 +00:00
.Nm cloudabi32
Port cloudabi32.ko to FreeBSD/arm64. This change adds an implementation of a sysent for running CloudABI armv6 and armv7 binaries on FreeBSD/arm64. It is a somewhat literal copy of the armv6 version, except that it's been patched up to use the proper registers. Just like for cloudabi32.ko on FreeBSD/amd64, we make use of a vDSO that automatically pads system call parameters to 64-bit value. These are stored in a buffer on the stack, meaning we need to use copyin() and copyout() unconditionally.
2017-11-30 17:58:48 +00:00
module is only available on amd64, arm64, armv6, armv7 and i386.
Document the existence of the cloudabi32 kernel module.
2016-08-24 12:53:54 +00:00
The same holds for the
Add a manual page for the cloudabi and cloudabi64 kernel modules. CloudABI has two separate kernel modules: cloudabi and cloudabi64. The first module contains all the pointer size independent code, whereas cloudabi64 contains the actual 64-bits specific system calls and the ELF loader. Reviewed by: wblock Obtained from: https://github.com/NuxiNL/freebsd Differential Revision: https://reviews.freebsd.org/D3258
2015-08-02 14:56:30 +00:00
.Nm cloudabi64
Document the existence of the cloudabi32 kernel module.
2016-08-24 12:53:54 +00:00
module,
which is only available for amd64 and arm64.
Add a manual page for the cloudabi and cloudabi64 kernel modules. CloudABI has two separate kernel modules: cloudabi and cloudabi64. The first module contains all the pointer size independent code, whereas cloudabi64 contains the actual 64-bits specific system calls and the ELF loader. Reviewed by: wblock Obtained from: https://github.com/NuxiNL/freebsd Differential Revision: https://reviews.freebsd.org/D3258
2015-08-02 14:56:30 +00:00
.Pp
A full cross compilation toolchain for CloudABI is available in the
.Pa devel/cloudabi-toolchain
port.
.Pp
The
.Pa sysutils/cloudabi-utils
port provides the
.Xr cloudabi-run 1
utility.
.Xr cloudabi-run 1
can be used to safely execute CloudABI processes with access to a
restricted set of resources.
.Sh SEE ALSO
.Xr cloudabi-run 1 ,
.Xr capsicum 4 ,
.Xr linux 4 ,
.Xr elf 5
.Pp
Document the existence of the cloudabi32 kernel module.
2016-08-24 12:53:54 +00:00
CloudABI for FreeBSD:
.Pa https://nuxi.nl/cloudabi/freebsd/ .
.Pp
Add a manual page for the cloudabi and cloudabi64 kernel modules. CloudABI has two separate kernel modules: cloudabi and cloudabi64. The first module contains all the pointer size independent code, whereas cloudabi64 contains the actual 64-bits specific system calls and the ELF loader. Reviewed by: wblock Obtained from: https://github.com/NuxiNL/freebsd Differential Revision: https://reviews.freebsd.org/D3258
2015-08-02 14:56:30 +00:00
cloudlibc on GitHub:
.Pa https://github.com/NuxiNL/cloudlibc .
Add support for CloudABI on ARM64. It turns out that it is pretty easy to make CloudABI work on ARM64. We essentially only need to copy over the sysvec from AMD64 and ensure that we use ARM64 specific registers. As there is an overlap between function argument and return registers, we do need to extend cloudabi64_schedtail() to only set its values if we're actually forking. Not when we're creating a new thread. Reviewed by: kib Differential Revision: https://reviews.freebsd.org/D3917
2015-10-22 11:09:25 +00:00
.Pp
The CloudABI Ports Collection on GitHub:
.Pa https://github.com/NuxiNL/cloudabi-ports .
Add a manual page for the cloudabi and cloudabi64 kernel modules. CloudABI has two separate kernel modules: cloudabi and cloudabi64. The first module contains all the pointer size independent code, whereas cloudabi64 contains the actual 64-bits specific system calls and the ELF loader. Reviewed by: wblock Obtained from: https://github.com/NuxiNL/freebsd Differential Revision: https://reviews.freebsd.org/D3258
2015-08-02 14:56:30 +00:00
.Sh HISTORY
CloudABI support first appeared in
.Fx 11.0 .
.Sh AUTHORS
Fix mandoc warnings/errors. MFC after: 1 week
2015-08-12 11:56:19 +00:00
.An Nuxi : Pa https://nuxi.nl/ .
Reference in New Issue Copy Permalink