Add experimental support for NetBSD (#495)

* Add experimental support for NetBSD
* On NetBSD, compile against libLLVM installed as a package.
* Support diff(1) implementations lacking the option --color.

Co-authored-by: Akuli <[email protected]>

.github/workflows/netbsd.yml

@@ -0,0 +1,26 @@
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: cross-platform-actions/[email protected]
+        env:
+          PKG_PATH: 'https://cdn.NetBSD.org/pub/pkgsrc/packages/NetBSD/amd64/9.3/All'
+        with:
+          operating_system: netbsd
+          version: '9.3' #TODO: bump to 10.0
+          environment_variables: PKG_PATH
+          run: |
+            sudo pkgin -y install clang libLLVM gmake diffutils && \
+            gmake && \
+            ./runtests.sh --verbose && \
+            ./runtests.sh --verbose --jou-flags "--verbose" && \
+            gmake clean && \
+            ./doctest.sh && \
+            ./compare_compilers.sh

Makefile.posix

@@ -1,20 +1,25 @@
 # Linux has llvm-config-xx in PATH, where xx is version number
 # On macos, brew installs LLVM to a weird place in /usr/local/
+# On NetBSD, use llvm-config from libLLVM (package from pkgsrc)
 LLVM_CONFIG ?= $(shell \
 	which llvm-config-14 \
 	|| which /usr/local/opt/llvm@14/bin/llvm-config \
 	|| which llvm-config-13 \
 	|| which /usr/local/opt/llvm@13/bin/llvm-config \
 	|| which llvm-config-11 \
 	|| which /usr/local/opt/llvm@11/bin/llvm-config \
+	|| which /usr/pkg/libexec/libLLVM/llvm-config \
 	)
 CFLAGS += $(shell $(LLVM_CONFIG) --cflags)
 CFLAGS += -gdwarf-4  # https://github.com/llvm/llvm-project/issues/56550
 LDFLAGS ?= $(shell $(LLVM_CONFIG) --ldflags --libs)
 
 ifeq ($(CC),cc)
 	# default c compiler --> use clang
-	CC := $(shell $(LLVM_CONFIG) --bindir)/clang
+	CC := $(shell \
+	which `$(LLVM_CONFIG) --bindir`/clang \
+	|| which clang \
+	)
 endif
 
 all: jou compile_flags.txt
@@ -26,18 +31,18 @@ compile_flags.txt:
 config.h:
 	@v=`$(LLVM_CONFIG) --version`; case "$$v" in 11.*|13.*|14.*) ;; *) echo "Error: Found unsupported LLVM version $$v. Only LLVM 11, 13 and 14 are supported."; exit 1; esac
 	echo "// auto-generated by Makefile" > config.h
-	echo "#define JOU_CLANG_PATH \"$(shell $(LLVM_CONFIG) --bindir)/clang\"" >> config.h
+	echo "#define JOU_CLANG_PATH \"$(CC)\"" >> config.h
 
 obj/%.o: src/%.c $(wildcard src/*.h) config.h
-	mkdir -vp obj && $(CC) -c $(CFLAGS) $< -o $@
+	mkdir -p obj && $(CC) -c $(CFLAGS) $< -o $@
 
 jou: $(SRC:src/%.c=obj/%.o)
 	$(CC) $(CFLAGS) $^ -o $@ $(LDFLAGS)
 
 config.jou:
 	echo "# auto-generated by Makefile" > config.jou
 	echo "def get_jou_clang_path() -> byte*:" >> config.jou
-	echo "    return \"$(shell $(LLVM_CONFIG) --bindir)/clang\"" >> config.jou
+	echo "    return \"$(CC)\"" >> config.jou
 
 self_hosted_compiler: jou config.jou $(wildcard self_hosted/*.jou)
 	./jou -o $@ --linker-flags "$(LDFLAGS)" self_hosted/main.jou

README.md

@@ -150,6 +150,38 @@ MacOS support is new. Please create an issue if something doesn't work.
 
 </details>
 
+<details> <summary>NetBSD</summary>
+Support for NetBSD is still experimental. Please report bugs and
+shortcomings.
+
+1. Install the dependencies:
+    ```
+    # pkgin install bash clang git gmake libLLVM
+    ```
+    Optionally `diffutils` can be installed for coloured diff outputs.
+2. Download and compile Jou.
+    ```
+    $ git clone https://github.com/Akuli/jou
+    $ cd jou
+    $ gmake
+    ```
+3. Run the hello world program to make sure that Jou works:
+    ```
+    $ ./jou examples/hello.jou
+    Hello World
+    ```
+    You can now run other Jou programs in the same way.
+4. (Optional) If you want to run Jou programs with simply `jou
+    filename` instead of something like `./jou filename` or
+    `/full/path/to/jou filename`, you can add the `jou` directory to
+    your PATH.  Refer to the manual page of your login shell for exact
+    syntax.
+
+NB: Using Clang and LLVM libraries built as a part of the base system
+is not currently supported.
+
+</details>
+
 <details> <summary>64-bit Windows</summary>
 
 1. Go to releases on GitHub. It's in the sidebar at right.

compare_compilers.sh

@@ -5,6 +5,7 @@
 # If tokenizing/parsing a Jou file fails, both compilers should fail with the same error message.
 
 set -e
+ulimit -c 0  # disable core dumps
 
 files=()
 actions=()
@@ -37,13 +38,18 @@ if [ ${#actions[@]} = 0 ]; then
 fi
 
 rm -rf tmp/compare_compilers
-mkdir -vp tmp/compare_compilers
+mkdir -p tmp/compare_compilers
 
 YELLOW="\x1b[33m"
 GREEN="\x1b[32m"
 RED="\x1b[31m"
 RESET="\x1b[0m"
 
+DIFF=$(which gdiff || which diff)
+if $DIFF --help | grep -q -- --color; then
+    diff_color="--color=always"
+fi
+
 function append_line()
 {
     local file="$1"
@@ -84,8 +90,10 @@ for error_list_file in self_hosted/*s_wrong.txt; do
 done
 
 echo "Compiling the self-hosted compiler..."
-if [[ "$OS" =~ Windows ]]; then
+if [[ "${OS:=$(uname)}" =~ Windows ]]; then
     mingw32-make self_hosted_compiler.exe
+elif [[ "$OS" =~ NetBSD ]]; then
+    gmake self_hosted_compiler
 else
     make self_hosted_compiler
 fi
@@ -126,7 +134,7 @@ for action in ${actions[@]}; do
             echo "  Compilers behave differently as expected (listed in $error_list_file)"
         fi
     else
-        if diff -u --color=always tmp/compare_compilers/compiler_written_in_c.txt tmp/compare_compilers/self_hosted.txt; then
+        if $DIFF -u $diff_color tmp/compare_compilers/compiler_written_in_c.txt tmp/compare_compilers/self_hosted.txt; then
             echo "  Compilers behave the same as expected"
         else
             if [ $fix = yes ]; then

doctest.sh

@@ -17,15 +17,24 @@ else
     files=("$@")
 fi
 
-if [[ "$OS" =~ Windows ]]; then
+if [[ "${OS:=$(uname)}" =~ Windows ]]; then
     source activate
     mingw32-make
     jou="$PWD/jou.exe"
+elif [[ "$OS" =~ NetBSD ]]; then
+    gmake
+    jou="$PWD/jou"
 else
     make
     jou="$PWD/jou"
 fi
 
+
+DIFF=$(which gdiff || which diff)
+if $DIFF --help | grep -q -- --color; then
+    diff_color="--color=always"
+fi
+
 function slice()
 {
     local first_lineno="$1"
@@ -71,7 +80,7 @@ for file in */*.jou; do
     echo -n "$(basename "$(dirname "$file")" | base64 -d):$(basename "$file" | cut -d'.' -f1): "
 
     cp "$file" test.jou
-    if diff --text -u --color=always <(generate_expected_output test.jou | tr -d '\r') <( ("$jou" test.jou 2>&1 || true) | tr -d '\r'); then
+    if $DIFF --text -u $diff_color <(generate_expected_output test.jou | tr -d '\r') <( ("$jou" test.jou 2>&1 || true) | tr -d '\r'); then
         echo "ok"
     else
         ((nfail++)) || true

examples/x11_window.jou

@@ -1,7 +1,9 @@
-# To run this program, you need linux:
+# To run this program, you need a system with X11:
 #
+#   Linux:
 #   $ ./jou --linker-flags "-lX11" examples/x11_window.jou
-#
+#   NetBSD:
+#   $ ./jou --linker-flags "-L/usr/X11R7/lib -Wl,-R/usr/X11R7/lib -lX11" examples/x11_window.jou
 
 declare usleep(x: int) -> int
 

runtests.sh

@@ -58,18 +58,30 @@ while [ $# != 0 ]; do
     esac
 done
 
-if [ $valgrind = yes ] && [[ "$OS" =~ Windows ]]; then
-    echo "valgrind doesn't work on Windows." >&2
-    exit 2
+if [ $valgrind = yes ]; then
+    case "${OS:=$(uname)}" in
+        Windows*|NetBSD*)
+            echo "valgrind doesn't work on $OS." >&2
+            exit 2
+            ;;
+    esac
 fi
 
 if [ $run_make = yes ]; then
-    if [[ "$OS" =~ Windows ]]; then
+    if [[ "${OS:=$(uname)}" =~ Windows ]]; then
         source activate
         mingw32-make
+    elif [[ "$OS" =~ NetBSD ]]; then
+        gmake
     else
         make
     fi
+
+fi
+
+DIFF=$(which gdiff || which diff)
+if $DIFF --help | grep -q -- --color; then
+    diff_color="--color=always"
 fi
 
 rm -rf tmp/tests
@@ -206,7 +218,7 @@ function run_test()
 
     printf "\n\n\x1b[33m*** Command: %s ***\x1b[0m\n\n" "$command" > $diffpath
 
-    if diff --text -u --color=always <(
+    if $DIFF --text -u $diff_color <(
         generate_expected_output $joufile $correct_exit_code | tr -d '\r'
     ) <(
         export PATH="$PWD:$PATH"

self_hosted/create_llvm_ir.jou

@@ -800,6 +800,8 @@ class AstToIR:
             name = "_jou_windows_startup"
         elif MACOS:
             name = "_jou_macos_startup"
+        elif NETBSD:
+            name = "_jou_netbsd_startup"
         else:
             return
 
@@ -817,7 +819,7 @@ class AstToIR:
         self->llvm_function = self->declare_function(sig)
         self->new_block("start")
 
-        if (WINDOWS or MACOS) and strcmp(sig->name, "main") == 0 and not sig->is_method():
+        if (WINDOWS or MACOS or NETBSD) and strcmp(sig->name, "main") == 0 and not sig->is_method():
             self->call_the_special_startup_function()
 
         # Allocate all local variables at the start of the function.

self_hosted/main.jou

@@ -178,6 +178,9 @@ class Compiler:
         if MACOS:
             self->automagic_files[1] = malloc(strlen(self->stdlib_path) + 40)
             sprintf(self->automagic_files[1], "%s/_macos_startup.jou", self->stdlib_path)
+        if NETBSD:
+            self->automagic_files[1] = malloc(strlen(self->stdlib_path) + 40)
+            sprintf(self->automagic_files[1], "%s/_netbsd_startup.jou", self->stdlib_path)
 
     def parse_all_files(self) -> None:
         queue: ParseQueueItem* = malloc(50 * sizeof queue[0])

src/codegen.c

@@ -414,14 +414,16 @@ static int find_block(const CfGraph *cfg, const CfBlock *b)
     assert(0);
 }
 
-#if defined(_WIN32) || defined(__APPLE__)
+#if defined(_WIN32) || defined(__APPLE__) || defined(__NetBSD__)
 static void codegen_call_to_the_special_startup_function(const struct State *st)
 {
     const char *name;
-#ifdef _WIN32
+#if defined _WIN32
     name = "_jou_windows_startup";
-#else
+#elif defined __APPLE__
     name = "_jou_macos_startup";
+#else
+    name = "_jou_netbsd_startup";
 #endif
 
     LLVMTypeRef functype = LLVMFunctionType(LLVMVoidType(), NULL, 0, false);
@@ -448,7 +450,7 @@ static void codegen_function_or_method_def(struct State *st, const CfGraph *cfg)
     assert(cfg->all_blocks.ptr[0] == &cfg->start_block);
     LLVMPositionBuilderAtEnd(st->builder, blocks[0]);
 
-#if defined(_WIN32) || defined(__APPLE__)
+#if defined(_WIN32) || defined(__APPLE__) || defined(__NetBSD__)
     if (!get_self_class(&cfg->signature) && !strcmp(cfg->signature.name, "main"))
         codegen_call_to_the_special_startup_function(st);
 #endif

src/evaluate.c

@@ -17,6 +17,13 @@ int get_special_constant(const char *name)
             return 0;
         #endif
     }
+    if (!strcmp(name, "NETBSD")) {
+        #ifdef __NetBSD__
+            return 1;
+        #else
+            return 0;
+        #endif
+    }
     return -1;
 }
 

src/main.c

@@ -461,6 +461,10 @@ int main(int argc, char **argv)
 #ifdef __APPLE__
     include_special_stdlib_file(&compst, "_macos_startup.jou");
 #endif
+#ifdef __NetBSD__
+    assert(sizeof(FILE) == 152);  // magic number in the startup file
+    include_special_stdlib_file(&compst, "_netbsd_startup.jou");
+#endif
 
     parse_file(&compst, command_line_args.infile, NULL);
     parse_all_pending_files(&compst);

src/update.c

@@ -17,6 +17,12 @@
 #include <stdnoreturn.h>
 #include "util.h"
 
+#ifdef __NetBSD__
+    #define MAKE "gmake"
+#else
+    #define MAKE "make"
+#endif
+
 static noreturn void fail()
 {
     char *s =
@@ -60,8 +66,8 @@ void update_jou_compiler()
     if (system("powershell -ExecutionPolicy bypass -File update.ps1") != 0)
         fail();
 #else
-    confirm("Run \"git pull && make\"?");
-    if (system("git pull && make"))
+    confirm("Run \"git pull && "MAKE"\"?");
+    if (system("git pull && " MAKE))
         fail();
 #endif
 

stdlib/_netbsd_startup.jou

@@ -0,0 +1,23 @@
+# A call to the _jou_netbsd_startup() function is inserted to the
+# start of every Jou program when compiling for NetBSD.
+
+# On NetBSD, these std* things are macros
+# expanding to elements of the __sF array
+# of FILE structs.
+
+declare global __sF: byte[152][3] # sizeof(FILE) == 152
+global stdin: void*
+global stdout: void*
+global stderr: void*
+
+def _jou_netbsd_startup() -> None:
+    stdin = &__sF[0]
+    stdout = &__sF[1]
+    stderr = &__sF[2]
+
+# Jou uses __errno_location,
+# NetBSD has __ernno()
+
+declare __errno() -> int*
+def __errno_location() -> int*:
+    return __errno()

tests/should_succeed/compiler_cli.jou

@@ -88,7 +88,10 @@ def main() -> int:
 
     # Compile a GUI program
     if not (WINDOWS or MACOS):
-        ret = system("./jou -o /dev/null --linker-flags \"-lX11\" examples/x11_window.jou")
+        if NETBSD:
+            ret = system("./jou -o /dev/null --linker-flags \"-L/usr/X11R7/lib -lX11\" examples/x11_window.jou")
+        else:
+            ret = system("./jou -o /dev/null --linker-flags \"-lX11\" examples/x11_window.jou")
         assert ret == 0
 
     # Compile a program with a memory leak.