Support OCaml 5.2

.cirrus.yml

@@ -6,9 +6,7 @@ freebsd_task:
     OPAMYES: 1
   env:
     matrix:
-      - OCAML_VERSION: 4.12.1
-      - OCAML_VERSION: 4.13.1
-      - OCAML_VERSION: 4.14.2
+      - OCAML_VERSION: 5.2.1
   pkg_install_script: pkg install -y ocaml-opam gmp gmake pkgconf bash
   opam_ocaml_cache:
     folder: $HOME/.opam

.github/workflows/test.yml

@@ -4,7 +4,7 @@ jobs:
   test:
     strategy:
       matrix:
-        ocaml-compiler: ["4.12", "4.13", "4.14"]
+        ocaml-compiler: [5.2.1]
     name: OCaml ${{ matrix.ocaml-compiler }}
     runs-on: ubuntu-latest
     steps:
@@ -23,6 +23,11 @@ jobs:
       run: MODE=spt opam exec -- dune build --root example
     - name: Run example with spt
       run: opam exec -- solo5-spt example/_build/solo5/main.exe
+    - name: Compile a failing example with spt
+      run: MODE=spt SOLO5TEST=sysfail opam exec -- dune build --root example
+    - name: Run a failing example with spt
+      run: |
+        ! opam exec -- solo5-spt example/_build/solo5/main.exe
     - name: Compile example with virtio
       run: MODE=virtio opam exec -- dune build --root example
     - name: Compile example with muen

.gitignore

@@ -5,3 +5,5 @@ nolibc/*.a
 nolibc/test-include/
 ocaml/
 _build/
+/ocaml-src.tar.gz
+/*.install

LICENSE

@@ -81,6 +81,38 @@ SUCH DAMAGE.
 
 ----------------------------------------------------------------------
 
+The file errlist.c in the nolibc/ directory is derived from OpenBSD,
+licensed under the following BSD license:
+
+Copyright (c) 1982, 1985, 1993
+  The Regents of the University of California.  All rights reserved.
+
+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.
+3. Neither the name of the University nor the names of its contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
+
+----------------------------------------------------------------------
+
 The file dtoa.c in the nolibc/ directory is licensed under the following
 MIT license:
 

Makefile

@@ -1,135 +1,181 @@
-.PHONY: all clean install distclean ocaml
-
 include Makeconf
 
-all:	openlibm/libopenlibm.a nolibc/libnolibc.a ocaml solo5.conf
+# The `all` target is moved to the end to use variables in its dependencies
+.PHONY: default
+default: all
 
 TOP=$(abspath .)
 
-# CFLAGS used to build nolibc / openlibm / ocaml runtime
-LOCAL_CFLAGS=$(MAKECONF_CFLAGS) -I$(TOP)/nolibc/include -include _solo5/overrides.h
-# CFLAGS used by the OCaml compiler to build C stubs
-GLOBAL_CFLAGS=$(MAKECONF_CFLAGS) -I$(MAKECONF_PREFIX)/solo5-sysroot/include/nolibc/ -include _solo5/overrides.h
-# LIBS used by the OCaml compiler to link executables
-GLOBAL_LIBS=-L$(MAKECONF_PREFIX)/solo5-sysroot/lib/nolibc/ -lnolibc -lopenlibm $(MAKECONF_EXTRA_LIBS)
+# Most parts (OCaml, nolibc, openlibm) currently build their result in-tree but
+# we reuse dune's `_build` dir, as familiar and already usable for `example`,
+# etc., for some generated files
+_build:
+	mkdir -p $@
+
+LIBS := openlibm/libopenlibm.a nolibc/libnolibc.a
+
+# CFLAGS used to build the nolibc and openlibm libraries
+LIB_CFLAGS=-I$(TOP)/nolibc/include -include _solo5/overrides.h
 
 # NOLIBC
-NOLIBC_CFLAGS=$(LOCAL_CFLAGS) -I$(TOP)/openlibm/src -I$(TOP)/openlibm/include
-nolibc/libnolibc.a:
-	$(MAKE) -C nolibc \
-	    "CC=$(MAKECONF_CC)" \
-	    "FREESTANDING_CFLAGS=$(NOLIBC_CFLAGS)" \
-	    "SYSDEP_OBJS=$(MAKECONF_NOLIBC_SYSDEP_OBJS)"
+# Use a phony target indirection, so that nolibc/Makefile is always checked to
+# see whether the library should be rebuilt while avoiding useless rebuild if
+# nolibc/libnolibc.a was up-to-date
+NOLIBC_CFLAGS=$(LIB_CFLAGS) -I$(TOP)/openlibm/src -I$(TOP)/openlibm/include
+nolibc/libnolibc.a: phony-nolibc
+
+.PHONY: phony-nolibc
+phony-nolibc:
+	$(MAKE) -C nolibc libnolibc.a \
+	    "CC=$(MAKECONF_TOOLCHAIN)-cc" \
+	    "FREESTANDING_CFLAGS=$(NOLIBC_CFLAGS)"
 
 # OPENLIBM
-openlibm/libopenlibm.a:
-	$(MAKE) -C openlibm "CC=$(MAKECONF_CC)" "CPPFLAGS=$(LOCAL_CFLAGS)" libopenlibm.a
+# See NOLIBC for explanations of the phony target
+openlibm/libopenlibm.a: phony-openlibm
+
+.PHONY: phony-openlibm
+phony-openlibm:
+	$(MAKE) -C openlibm libopenlibm.a \
+	     "CC=$(MAKECONF_TOOLCHAIN)-cc" \
+	     "CPPFLAGS=$(LIB_CFLAGS)"
+
+# TOOLCHAIN
+# We create prefix-gcc even when the actual compiler will be Clang because
+# autoconf toolchain detection will pick the first compiler that exists in the
+# list: prefix-gcc, gcc, prefix-cc, cc...
+# Anyway, configure scripts always explicitly test whether the compiler defines
+# Clang-specific macros when they want to distinguish GCC and Clang
+ALLTOOLS := gcc cc ar as ld nm objcopy objdump ranlib readelf strip
+ALLTOOLS := $(foreach tool,$(ALLTOOLS), \
+                $(MAKECONF_TARGET_ARCH)-solo5-ocaml-$(tool))
+
+TOOLDIR_FOR_BUILD := _build/build-toolchain
+TOOLCHAIN_FOR_BUILD := $(addprefix $(TOOLDIR_FOR_BUILD)/,$(ALLTOOLS))
+TOOLDIR_FINAL := _build/toolchain
+TOOLCHAIN_FINAL := $(addprefix $(TOOLDIR_FINAL)/,$(ALLTOOLS))
+
+# Options for the build version of the tools
+TOOLCHAIN_BUILD_CFLAGS := -I$(TOP)/nolibc/include \
+  -I$(TOP)/openlibm/include -I$(TOP)/openlibm/src
+TOOLCHAIN_BUILD_LDFLAGS := -L$(TOP)/nolibc -L$(TOP)/openlibm
+
+# Options for the installed version of the tools
+TOOLCHAIN_FINAL_CFLAGS := -I$(MAKECONF_SYSROOT)/include
+TOOLCHAIN_FINAL_LDFLAGS := -L$(MAKECONF_SYSROOT)/lib
+
+$(TOOLDIR_FOR_BUILD) $(TOOLDIR_FINAL):
+	mkdir -p $@
+
+$(TOOLDIR_FOR_BUILD)/$(MAKECONF_TARGET_ARCH)-solo5-ocaml-%: \
+    gen_toolchain_tool.sh | $(TOOLDIR_FOR_BUILD)
+	ARCH="$(MAKECONF_TARGET_ARCH)" \
+	  SOLO5_TOOLCHAIN="$(MAKECONF_TOOLCHAIN)" \
+	  OTHERTOOLPREFIX="$(MAKECONF_TOOLPREFIX)" \
+	  TOOL_CFLAGS="$(TOOLCHAIN_BUILD_CFLAGS)" \
+	  TOOL_LDFLAGS="$(TOOLCHAIN_BUILD_LDFLAGS)" \
+	  sh $< $* > $@
+	chmod +x $@
+
+$(TOOLDIR_FINAL)/$(MAKECONF_TARGET_ARCH)-solo5-ocaml-%: \
+    gen_toolchain_tool.sh | $(TOOLDIR_FINAL)
+	ARCH="$(MAKECONF_TARGET_ARCH)" \
+	  SOLO5_TOOLCHAIN="$(MAKECONF_TOOLCHAIN)" \
+	  OTHERTOOLPREFIX="$(MAKECONF_TOOLPREFIX)" \
+	  TOOL_CFLAGS="$(TOOLCHAIN_FINAL_CFLAGS)" \
+	  TOOL_LDFLAGS="$(TOOLCHAIN_FINAL_LDFLAGS)" \
+	  sh $< $* > $@
+	chmod +x $@
+
+.PHONY: toolchains
+toolchains: $(TOOLCHAIN_FOR_BUILD) $(TOOLCHAIN_FINAL)
 
 # OCAML
-ocaml/Makefile:
-	cp -r `ocamlfind query ocaml-src` ./ocaml
-
-# OCaml >= 4.08.0 uses an autotools-based build system. In this case we
-# convince it to think it's using the Solo5 compiler as a cross compiler, and
-# let the build system do its work with as little additional changes on our
-# side as possible.
-#
-# Notes:
-#
-# - CPPFLAGS must be set for configure as well as CC, otherwise it complains
-#   about headers due to differences of opinion between the preprocessor and
-#   compiler.
-# - ARCH must be overridden manually in Makefile.config due to the use of
-#   hardcoded combinations in the OCaml configure.
-# - We use LIBS with a stubbed out solo5 implementation to override the OCaml
-# 	configure link test
-# - We override OCAML_OS_TYPE since configure just hardcodes it to "Unix".
-OC_CFLAGS=$(LOCAL_CFLAGS) -I$(TOP)/openlibm/include -I$(TOP)/openlibm/src -nostdlib
-OC_LIBS=-L$(TOP)/nolibc -lnolibc -L$(TOP)/openlibm -lopenlibm -nostdlib $(MAKECONF_EXTRA_LIBS)
-ocaml/Makefile.config: ocaml/Makefile openlibm/libopenlibm.a nolibc/libnolibc.a
-# configure: Do not build dynlink
-	sed -i -e 's/otherlibraries="dynlink"/otherlibraries=""/g' ocaml/configure
-# configure: Allow precise input of flags and libs
-	sed -i -e 's/oc_cflags="/oc_cflags="$$OC_CFLAGS /g' ocaml/configure
-	sed -i -e 's/ocamlc_cflags="/ocamlc_cflags="$$OCAMLC_CFLAGS /g' ocaml/configure
-	sed -i -e 's/nativecclibs="$$cclibs $$DLLIBS"/nativecclibs="$$GLOBAL_LIBS"/g' ocaml/configure
-# runtime/Makefile: Runtime rules: don't build libcamlrun.a and import ocamlrun from the system
-	sed -i -e 's/^all: $$(BYTECODE_STATIC_LIBRARIES) $$(BYTECODE_SHARED_LIBRARIES)/all: primitives ld.conf/' ocaml/runtime/Makefile
-	sed -i -e 's/^ocamlrun$$(EXE):.*/dummy:/g' ocaml/runtime/Makefile
-	sed -i -e 's/^ocamlruni$$(EXE):.*/dummyi:/g' ocaml/runtime/Makefile
-	sed -i -e 's/^ocamlrund$$(EXE):.*/dummyd:/g' ocaml/runtime/Makefile
-	echo -e "ocamlrun:\n\tcp $(shell which ocamlrun) .\n" >> ocaml/runtime/Makefile
-	echo -e "ocamlrund:\n\tcp $(shell which ocamlrund) .\n" >> ocaml/runtime/Makefile
-	echo -e "ocamlruni:\n\tcp $(shell which ocamlruni) .\n" >> ocaml/runtime/Makefile
-	touch ocaml/runtime/libcamlrun.a ocaml/runtime/libcamlrund.a ocaml/runtime/libcamlruni.a
-# yacc/Makefile: import ocamlyacc from the system
-	sed -i -e 's/^ocamlyacc$$(EXE):.*/dummy:/g' ocaml/yacc/Makefile
-	echo -e "ocamlyacc:\n\tcp $(shell which ocamlyacc) .\n" >> ocaml/yacc/Makefile
-# tools/Makefile: stub out objinfo_helper
-	echo -e "objinfo_helper:\n\ttouch objinfo_helper\n" >> ocaml/tools/Makefile
-# av_cv_libm_cos=no is passed to configure to prevent -lm being used (which
-# would use the host system libm instead of the freestanding openlibm, see
-# https://github.com/mirage/ocaml-solo5/issues/101
+# Extract sources from the ocaml-src package and apply patches if there any in
+# `patches/<OCaml version>/`
+ocaml:
+# First make sure the ocaml directory doesn't exist, otherwise the cp would
+# create an ocaml-src subdirectory
+	test ! -d $@
+	cp -r "$$(ocamlfind query ocaml-src)" $@
+	VERSION="$$(head -n1 ocaml/VERSION)" ; \
+	if test -d "patches/$$VERSION" ; then \
+	  git apply --directory=$@ "patches/$$VERSION"/*; \
+	fi
+
+ocaml/Makefile.config: $(LIBS) $(TOOLCHAIN_FOR_BUILD) | ocaml
+	PATH="$$PWD/$(TOOLDIR_FOR_BUILD):$$PATH" ; \
 	cd ocaml && \
-		CC="$(MAKECONF_CC)" \
-		OC_CFLAGS="$(OC_CFLAGS)" \
-		OCAMLC_CFLAGS="$(GLOBAL_CFLAGS)" \
-		AS="$(MAKECONF_AS)" \
-		ASPP="$(MAKECONF_CC) $(OC_CFLAGS) -c" \
-		CPPFLAGS="$(OC_CFLAGS)" \
-		LIBS="$(OC_LIBS)"\
-		GLOBAL_LIBS="$(GLOBAL_LIBS)"\
-		LD="$(MAKECONF_LD)" \
-		ac_cv_prog_DIRECT_LD="$(MAKECONF_LD)" \
-		ac_cv_lib_m_cos="no" \
 	  ./configure \
-		-host=$(MAKECONF_ARCH)-unknown-none \
-		-target=$(MAKECONF_BUILD_ARCH)-solo5-none \
-		-prefix $(MAKECONF_PREFIX)/solo5-sysroot \
-		-disable-shared\
-		-disable-systhreads\
-		-disable-unix-lib\
-		-disable-instrumented-runtime\
-		-disable-ocamltest\
-		-disable-ocamldoc\
+		--target="$(MAKECONF_TARGET_ARCH)-solo5-ocaml" \
+		--prefix="$(MAKECONF_SYSROOT)" \
+		--disable-shared \
+		--disable-systhreads \
+		--disable-unix-lib \
+		--disable-instrumented-runtime \
+		--disable-debug-runtime \
+		--disable-ocamltest \
+		--disable-ocamldoc \
+		--without-zstd \
 		$(MAKECONF_OCAML_CONFIGURE_OPTIONS)
-	echo "ARCH=$(MAKECONF_OCAML_BUILD_ARCH)" >> ocaml/Makefile.config
-	echo 'SAK_CC=cc' >> ocaml/Makefile.config
-	echo 'SAK_CFLAGS=' >> ocaml/Makefile.config
-	echo 'SAK_LINK=cc $(SAK_CFLAGS) $$(OUTPUTEXE)$$(1) $$(2)' >> ocaml/Makefile.config
-	echo '#undef OCAML_OS_TYPE' >> ocaml/runtime/caml/s.h
-	echo '#define OCAML_OS_TYPE "None"' >> ocaml/runtime/caml/s.h
-
-# NOTE: ocaml/tools/make-version-header.sh is integrated into OCaml's ./configure script starting from OCaml 4.14
-ifneq (,$(wildcard ocaml/tools/make-version-header.sh))
-ocaml/runtime/caml/version.h: ocaml/Makefile.config
-	ocaml/tools/make-version-header.sh > $@
-else
-ocaml/runtime/caml/version.h: ocaml/Makefile.config
-	@
-endif
-
-ocaml: ocaml/Makefile.config ocaml/runtime/caml/version.h
-	$(MAKE) -C ocaml world
-	$(MAKE) -C ocaml opt
+
+OCAML_IS_BUILT := _build/ocaml_is_built
+$(OCAML_IS_BUILT): ocaml/Makefile.config | _build
+	PATH="$$PWD/$(TOOLDIR_FOR_BUILD):$$PATH" $(MAKE) -C ocaml cross.opt
+	cd ocaml && ocamlrun tools/stripdebug ocamlc ocamlc.tmp
+	cd ocaml && ocamlrun tools/stripdebug ocamlopt ocamlopt.tmp
+	touch $@
+
+DOT_INSTALL_PREFIX_FOR_OCAML := _build/ocaml.install
+DOT_INSTALL_CHUNKS_FOR_OCAML := $(addprefix $(DOT_INSTALL_PREFIX_FOR_OCAML),\
+    .lib .libexec)
+$(DOT_INSTALL_CHUNKS_FOR_OCAML): | ocaml/Makefile.config
+	MAKE="$(MAKE)" ./gen_ocaml_install.sh \
+	  $(DOT_INSTALL_PREFIX_FOR_OCAML) ocaml $(MAKECONF_SYSROOT)
 
 # CONFIGURATION FILES
-solo5.conf: solo5.conf.in
-	sed -e 's!@@PREFIX@@!$(MAKECONF_PREFIX)!' \
-	    solo5.conf.in > $@
+_build/solo5.conf: gen_solo5_conf.sh $(OCAML_IS_BUILT)
+	SYSROOT="$(MAKECONF_SYSROOT)" ./gen_solo5_conf.sh > $@
+
+_build/empty-META: | _build
+	touch $@
+
+# INSTALL
+PACKAGES := $(basename $(wildcard *.opam))
+INSTALL_FILES := $(foreach pkg,$(PACKAGES),$(pkg).install)
+
+$(INSTALL_FILES): $(TOOLCHAIN_FINAL) $(DOT_INSTALL_CHUNKS_FOR_OCAML)
+	./gen_dot_install.sh $(DOT_INSTALL_PREFIX_FOR_OCAML) $(TOOLCHAIN_FINAL)\
+	     > $@
 
 # COMMANDS
-install: all
-	MAKE=$(MAKE) PREFIX=$(MAKECONF_PREFIX) ./install.sh
+PACKAGE := ocaml-solo5
+.PHONY: install
+install: $(PACKAGE).install
+	opam-installer --prefix=$(MAKECONF_PREFIX) $<
 
+.PHONY: clean
 clean:
-	$(RM) -r ocaml/
-	$(RM) solo5.conf
+	$(RM) -rf _build
 	$(MAKE) -C openlibm clean
-	$(MAKE) -C nolibc \
-	    "FREESTANDING_CFLAGS=$(NOLIBC_CFLAGS)" \
-	    "SYSDEP_OBJS=$(MAKECONF_NOLIBC_SYSDEP_OBJS)" \
-	    clean
+	$(MAKE) -C nolibc clean FREESTANDING_CFLAGS=_
+	if [ -d ocaml ] ; then $(MAKE) -C ocaml clean ; fi
+	$(RM) -f $(INSTALL_FILES)
 
+.PHONY: distclean
 distclean: clean
-	rm Makeconf
+	$(RM) -f Makeconf
+# Don't remove the ocaml directory itself, to play nicer with
+# development in there
+	if [ -d ocaml ] ; then $(MAKE) -C ocaml distclean ; fi
+
+.PHONY: all
+all: $(LIBS) $(OCAML_IS_BUILT) \
+     _build/solo5.conf _build/empty-META \
+     $(TOOLCHAIN_FINAL)
+
+.PHONY: test
+test:
+	$(MAKE) -C nolibc test-headers \
+	    "CC=$(MAKECONF_TOOLCHAIN)-cc" \
+	    "FREESTANDING_CFLAGS=$(NOLIBC_CFLAGS)"

README.md

@@ -71,8 +71,8 @@ Run: `solo5-hvt _build/solo5/main.exe`
 
 ## Supported compiler versions
 
-Tested against OCaml 4.12.1 through 4.14.1. Other versions may require
-changing `configure.sh`.
+Tested against OCaml 5.2.1. Other versions would require specific patches (see
+the `patches` directory).
 
 ## Porting to a different (uni)kernel base layer