-
Notifications
You must be signed in to change notification settings - Fork 13.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
compiler: Add
*-unikraft-linux-musl
documentation
Signed-off-by: Martin Kröning <[email protected]>
- Loading branch information
Showing
3 changed files
with
69 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# `*-unikraft-linux-musl` | ||
|
||
**Tier: 3** | ||
|
||
Targets for the [Unikraft] Unikernel Development Kit (with musl). | ||
|
||
[Unikraft]: https://unikraft.org/ | ||
|
||
Target triplets available so far: | ||
|
||
- `x86_64-unikraft-linux-musl` | ||
|
||
## Target maintainers | ||
|
||
- Martin Kröning ([@mkroening](https://github.com/mkroening)) | ||
|
||
## Requirements | ||
|
||
These targets only support cross-compilation. | ||
The targets do support std. | ||
|
||
Unikraft pretends to behave exactly like Linux. | ||
How much of that functionality is available depends on the individual unikernel configuration. | ||
For example, the basic Unikraft + musl config does not support `poll` or networking out of the box. | ||
That functionality requires enabling [`LIBPOSIX_EVENT`] or [lwIP] respectively. | ||
|
||
[`LIBPOSIX_EVENT`]: https://github.com/unikraft/unikraft/blob/RELEASE-0.13.1/lib/posix-event/Config.uk | ||
[lwIP]: https://github.com/unikraft/lib-lwip | ||
|
||
The Unikraft targets follow Linux's `extern "C"` calling convention. | ||
|
||
For these targets, `rustc` does not perform the final linking step. | ||
Instead, the Unikraft build system will produce the final Unikernel image for the selected platform (e.g., KVM, Linux user space, and Xen). | ||
|
||
## Building the targets | ||
|
||
You can build Rust with support for the targets by adding it to the `target` list in `config.toml`: | ||
|
||
```toml | ||
[build] | ||
build-stage = 1 | ||
target = [ "x86_64-unikraft-linux-musl" ] | ||
``` | ||
|
||
## Building Rust programs | ||
|
||
Rust does not yet ship pre-compiled artifacts for these targets. | ||
To compile for these targets, you will either need to build Rust with the targets enabled | ||
(see “Building the targets” above), or build your own copy of `core` by using `build-std` or similar. | ||
|
||
Linking requires a [KraftKit] shim. | ||
See [unikraft/kraftkit#612] for more information. | ||
|
||
[KraftKit]: https://github.com/unikraft/kraftkit | ||
[unikraft/kraftkit#612]: https://github.com/unikraft/kraftkit/issues/612 | ||
|
||
## Testing | ||
|
||
The targets do support running binaries in the form of unikernel images. | ||
How the unikernel image is run depends on the specific platform (e.g., KVM, Linux user space, and Xen). | ||
The targets do not support running the Rust test suite. | ||
|
||
## Cross-compilation toolchains and C code | ||
|
||
The targets do support C code. | ||
To build compatible C code, you have to use the same compiler and flags as does the Unikraft build system for your specific configuration. | ||
The easiest way to achieve that, is to build the C code with the Unikraft build system when building your unikernel image. |