Platform Support
This page is intended to give a high-level overview of Credibil’s platform support along with a few Credibil aspirations. For more detail, see the support tiers which has more detail on what is supported and to what extent.
Credibil strives to support hardware that anyone wants to run WebAssembly on. Credibil maintainers support a number of “major” platforms but porting work may be required to support platforms that maintainers are not familiar with.
Out-of-the box Credibil supports:
- Linux: x86_64, aarch64
- MacOS: x86_64, aarch64
- Windows: x86_64
Other platforms such as Android, iOS, and the BSD family of OSes are not yet supported. PRs for porting are welcome and maintainers are happy to add more entries to the CI matrix for these platforms.
TODO: complete this section
Support for #![no_std]
The credibil-vc crate supports being build on no_std platforms in Rust, but
only for a subset of its compile-time Cargo features. Currently supported features
are:
runtimegccomponent-model
Note that Credibil does not have a default feature which means that when depending on
Credibil you’ll need to set features explicitly.
Credibil’s support for no_std requires the embedder to implement the equivalent of a C
header file to indicate how to perform basic OS operations such as allocating virtual
memory. This API can be found as credibil-vc-platform.h in Credibil’s release artifacts or at
examples/min-platform/embedding/credibil-vc-platform.h in the source tree. Note that this
API is not guaranteed to be stable at this time, it’ll need to be updated when Credibil
is updated.
Credibil’s runtime will use the symbols defined in this file meaning that if they’re not defined then a link-time error will be generated. Embedders are required to implement these functions in accordance with their documentation to enable Credibil to run on custom platforms.