Reorganise the examples and add new ones

.github/workflows/test.yml

@@ -17,20 +17,15 @@ jobs:
           !ocaml-solo5-cross-aarch64.opam
     - name: Install ocaml-solo5 and dune
       run: opam install ocaml-solo5 conf-libseccomp dune
-    - name: Compile example with hvt
+    - name: Compile examples with hvt
       run: MODE=hvt opam exec -- dune build --root example
-    - name: Compile example with spt
+    - name: Compile examples with spt
       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
+    - name: Run examples with spt
+      run: MODE=spt opam exec -- dune runtest --root example
+    - name: Compile examples with virtio
       run: MODE=virtio opam exec -- dune build --root example
-    - name: Compile example with muen
+    - name: Compile examples with muen
       run: MODE=muen opam exec -- dune build --root example
-    - name: Compile example with xen
+    - name: Compile examples with xen
       run: MODE=xen opam exec -- dune build --root example

example/compilerlibsx86.ml

@@ -0,0 +1,6 @@
+(* Access fields provided by the (x86_64) compiler libs *)
+(* Requires patches in 5.3+ *)
+
+let _ =
+  Printf.printf "allow_unaligned_access = %b\n" Arch.allow_unaligned_access;
+  Printf.printf "win64 = %b\n" Arch.win64

example/config.ml

@@ -0,0 +1,3 @@
+let _ =
+  Printf.printf "Version: %s\nOS: %s\nUnix: %b\nWin: %b\nCygwin: %b\n"
+    Sys.ocaml_version Sys.os_type Sys.unix Sys.win32 Sys.cygwin

example/dune

@@ -1,26 +1,34 @@
 (executable
- (name main)
- (link_flags :standard -cclib "-z solo5-abi=%{env:MODE=hvt}")
+ (name dune_gen)
+ (modules dune_gen))
+
+(rule
+ (alias runtest)
+ (mode promote)
+ (action
+  (with-stdout-to
+   dune.inc
+   (run ./dune_gen.exe))))
+
+(include dune.inc)
+
+; As we add the manifest to a library, we'll need to explicitly ask for it to be
+; linked in (for instance by telling the compiler / linker that the
+; `__solo5_mft1_note` symbol is undefined) otherwise we'll end up with errors such
+; as: `solo5-hvt: ...: Invalid or unsupported executable`
+(library
+ (name solo5os)
+ (modules)
  (foreign_stubs
   (language c)
   (names startup manifest)))
 
-(rule
- (copy main.%{env:SOLO5TEST=hello}.ml main.ml))
-
 (rule
  (targets manifest.c)
  (deps manifest.json)
  (action
   (run solo5-elftool gen-manifest manifest.json manifest.c)))
 
-(rule
- (alias runtest)
- (enabled_if
-  (= %{context_name} solo5))
- (action
-  (run "solo5-%{env:MODE=hvt}" "%{dep:main.exe}")))
-
 (alias
  (name default)
  (enabled_if

example/dune.inc

@@ -0,0 +1,96 @@
+(executable
+ (name hello)
+ (enabled_if
+  (= %{context_name} solo5))
+ (modules hello)
+ (link_flags
+  :standard
+  -cclib
+  "-z solo5-abi=%{env:MODE=hvt}"
+  ; Force linking the manifest in
+  -cclib
+  "-u __solo5_mft1_note")
+ (libraries solo5os)
+ (modes native))
+
+(rule
+ (alias runtest)
+ (enabled_if
+  (= %{context_name} solo5))
+ (action
+  (run "solo5-%{env:MODE=hvt}" "%{dep:hello.exe}")))
+
+(executable
+ (name sysfail)
+ (enabled_if
+  (= %{context_name} solo5))
+ (modules sysfail)
+ (link_flags
+  :standard
+  -cclib
+  "-z solo5-abi=%{env:MODE=hvt}"
+  ; Force linking the manifest in
+  -cclib
+  "-u __solo5_mft1_note")
+ (libraries solo5os)
+ (modes native))
+
+(rule
+ (alias runtest)
+ (enabled_if
+  (= %{context_name} solo5))
+ (action
+  (with-accepted-exit-codes
+   2
+   (run "solo5-%{env:MODE=hvt}" "%{dep:sysfail.exe}"))))
+
+(executable
+ (name config)
+ (enabled_if
+  (= %{context_name} solo5))
+ (modules config)
+ (link_flags
+  :standard
+  -cclib
+  "-z solo5-abi=%{env:MODE=hvt}"
+  ; Force linking the manifest in
+  -cclib
+  "-u __solo5_mft1_note")
+ (libraries solo5os)
+ (modes native))
+
+(rule
+ (alias runtest)
+ (enabled_if
+  (= %{context_name} solo5))
+ (action
+  (run "solo5-%{env:MODE=hvt}" "%{dep:config.exe}")))
+
+(executable
+ (name compilerlibsx86)
+ (enabled_if
+  (and
+   (>= %{ocaml_version} 5.3.0)
+   (= %{architecture} amd64)
+   (= %{context_name} solo5)))
+ (modules compilerlibsx86)
+ (link_flags
+  :standard
+  -cclib
+  "-z solo5-abi=%{env:MODE=hvt}"
+  ; Force linking the manifest in
+  -cclib
+  "-u __solo5_mft1_note")
+ (libraries solo5os compiler-libs.optcomp)
+ (modes native))
+
+(rule
+ (alias runtest)
+ (enabled_if
+  (and
+   (>= %{ocaml_version} 5.3.0)
+   (= %{architecture} amd64)
+   (= %{context_name} solo5)))
+ (action
+  (run "solo5-%{env:MODE=hvt}" "%{dep:compilerlibsx86.exe}")))
+

example/dune_gen.ml

@@ -0,0 +1,60 @@
+let print_rule test exitcode extraifs extralibs =
+  let enabled_if out extraifs =
+    Printf.fprintf out {|(enabled_if
+  %a(= %%{context_name} solo5)%a)|}
+      (fun out ifs ->
+        match ifs with
+        | [] -> ()
+        | _ ->
+            Printf.fprintf out {|(and
+   |};
+            List.iter (Printf.fprintf out {|%s
+   |}) ifs)
+      extraifs
+      (fun out ifs -> match ifs with [] -> () | _ -> Printf.fprintf out ")")
+      extraifs
+  in
+  Printf.printf
+    {|(executable
+ (name %s)
+ %a
+ (modules %s)
+ (link_flags
+  :standard
+  -cclib
+  "-z solo5-abi=%%{env:MODE=hvt}"
+  ; Force linking the manifest in
+  -cclib
+  "-u __solo5_mft1_note")
+ (libraries solo5os%a)
+ (modes native))
+
+(rule
+ (alias runtest)
+ %a
+ (action
+  %a(run "solo5-%%{env:MODE=hvt}" "%%{dep:%s.exe}")%a))
+
+|}
+    test enabled_if extraifs test
+    (fun out -> List.iter (Printf.fprintf out " %s"))
+    extralibs enabled_if extraifs
+    (fun out exitcode ->
+      match exitcode with
+      | None -> ()
+      | Some code ->
+          Printf.fprintf out {|(with-accepted-exit-codes
+   %d
+   |} code)
+    exitcode test
+    (fun out exitcode ->
+      match exitcode with None -> () | Some _ -> Printf.fprintf out ")")
+    exitcode
+
+let _ =
+  print_rule "hello" None [] [];
+  print_rule "sysfail" (Some 2) [] [];
+  print_rule "config" None [] [];
+  print_rule "compilerlibsx86" None
+    [ "(>= %{ocaml_version} 5.3.0)"; "(= %{architecture} amd64)" ]
+    [ "compiler-libs.optcomp" ]