ocaml-freestanding -- Freestanding OCaml runtime
This package provides a freestanding OCaml runtime suitable for linking with a unikernel base layer. Currently only Solo5 is supported.
License and contributions
All original contributions to this package are licensed under the standard MIT license.
This package incorporates components derived or copied from musl libc, OpenBSD, OpenLibm and other third parties. For full details of the licenses of these third party components refer to the included LICENSE file.
The OCaml runtime ("OCaml Core System") built by this package is distributed
under the terms of the GNU LGPL version 2.1 with a special exception for static
or dynamic linking to produce an executable file. For details refer to the
LICENSE file included in the version of the
ocaml-src OPAM package installed
on your system as a dependency when you build this package.
The following components are built and installed:
libnolibc.a: libc interfaces required by OCaml runtime.
libopenlibm.a: libm required by OCaml runtime.
libotherlibs.a: OCaml native code runtime.
- Header files for nolibc and openlibm.
- Header files for OCaml runtime.
Downstream packages should use
pkg-config --cflags ocaml-freestanding when
compiling C code using these components and
pkg-config --libs ocaml-freestanding during the link step.
Supported compiler versions
Tested against OCaml 4.05.0, 4.06.0 through 4.07.1. Other versions will require
Porting to a different (uni)kernel base layer
Assuming your unikernel base layer is packaged for OPAM in a similar fashion to Solo5 this should be as simple as:
- Adding the appropriate clauses to determine the OPAM packages required
FREESTANDING_CFLAGSfor compilation to
- Implementing a
Note that the nolibc code is intentionally strict about namespacing of APIs and header files. If your base layer exports symbols or defines types which conflict with nolibc then the recommended course of action is to fix your base layer to not export anything defined by "POSIX" or "standard C".
Updating the vendored copy of OpenLibm
OpenLibm is "vendored" into this repository using
git subtree add --prefix openlibm https://github.com/JuliaLang/openlibm.git v0.5.4 --squash
To update the vendored copy of OpenLibm to the newer upstream version
use the following command on a branch and then file a PR:
git subtree pull --prefix openlibm https://github.com/JuliaLang/openlibm.git TAG --squash