V0.14.0

.envrc

@@ -0,0 +1 @@
+export ZIGLER_TEST_BLAS=true

.github/workflows/freebsd.yml

@@ -0,0 +1,72 @@
+name: Elixir CI - FreeBSD
+
+on: push
+
+jobs:
+  freebsd:
+    runs-on: ubuntu-latest
+    name: FreeBSD / Elixir
+    steps:
+    - uses: actions/checkout@v4
+
+    - uses: erlef/setup-beam@v1
+      name: Setup Erlang
+      with:
+        otp-version: '27.3'
+        elixir-version: '1.18.3'
+
+    - uses: actions/cache@v3
+      id: deps-cache
+      with:
+        path: deps
+        key: mix-${{ hashFiles('/mix.lock') }}
+
+    - name: get deps
+      run: mix deps.get
+
+    - uses: actions/cache@v3
+      id: zig-cache
+      with:
+        path: zig
+        key: zig-freebsd
+
+    - name: get zig
+      run: |
+        if [ ! -d zig ]; then
+          git clone -b 0.14.0 https://github.com/ziglang/zig.git
+        fi 
+
+    - name: Test in FreeBSD
+      id: test
+      uses: vmactions/freebsd-vm@v1      
+      with:
+        mem: 8192
+        usesh: true
+        prepare: |
+          pkg install -y erlang-runtime27
+          pkg install -y elixir-devel
+          pkg install -y llvm19
+          pkg install -y ca_root_nss
+
+          pkg install -y cmake zstd libxml2 lzma ninja
+
+          ldconfig /usr/local/lib
+
+        run: |
+          cd zig
+          mkdir -p build
+
+          cd build
+          cmake .. -G Ninja -DZIG_STATIC_LLVM=ON -DCMAKE_PREFIX_PATH="/usr/local/llvm19;/usr/local;/usr/local/lib" -DCMAKE_EXE_LINKER_FLAGS="-L/usr/local/lib" -DCMAKE_BUILD_TYPE=ReleaseSafe
+
+          ninja -C .
+
+          export ZIG_EXECUTABLE_PATH="$(pwd)/stage3/bin/zig"
+          export PATH="/usr/local/lib/erlang27/bin:$PATH"
+          export SSL_CACERTFILE=/usr/local/etc/ssl/cert.pem
+
+          cd ../..
+
+          mix local.hex --force
+
+          mix test --exclude no_ci --exclude skip_freebsd

.github/workflows/linux.yml

@@ -4,40 +4,45 @@ on: push
 
 jobs:
   ubuntu:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     name: Linux OTP ${{matrix.pair.otp-version}} / Elixir ${{matrix.pair.elixir-version}}
     strategy:
       matrix:
         pair:
-          - otp-version: '27.0'
-            elixir-version: '1.17.2'
+          - otp-version: '27.3'
+            elixir-version: '1.18.3'
+          - otp-version: '27.3'
+            elixir-version: '1.17.3'
           - otp-version: '26.2'
             elixir-version: '1.16.3'
           - otp-version: '25.3'
-            elixir-version: '1.15.2'
+            elixir-version: '1.15.8'
           - otp-version: '24.3'
             elixir-version: '1.14.5'
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v4
     - uses: erlef/setup-beam@v1
       with:
         otp-version: ${{matrix.pair.otp-version}}
         elixir-version: ${{matrix.pair.elixir-version}}
 
-    - uses: actions/cache@v1
+    - uses: actions/cache@v3
       id: deps-cache
       with:
         path: deps
-        key: ${{ runner.os }}-mix-${{ matrix.otp }}-${{ matrix.elixir }}-${{ hashFiles(format('{0}{1}', github.workspace, '/mix.lock')) }}
+        key: ${{ runner.os }}-mix-${{ matrix.pair.otp-version }}-${{ matrix.pair.elixir-version }}-${{ hashFiles('/mix.lock') }}-${{ hashfiles('installer/**/*') }}
+
+    - name: Install ZIGLER_TEST_BLAS
+      run: sudo apt install -y libopenblas-dev
 
     - name: Install dependencies
       run: mix deps.get
 
-    - uses: actions/cache@v1
+    - uses: actions/cache@v3
       id: build-cache
       with:
         path: _build
-        key: ${{ runner.os }}-build-${{ matrix.otp }}-${{ matrix.elixir }}-${{ hashFiles(format('{0}{1}', github.workspace, '/mix.lock')) }}
+        key: ${{ runner.os }}-build-${{ matrix.pair.otp-version }}-${{ matrix.elixir-version }}-${{ hashFiles('/mix.lock') }}
 
     - name: Compile base
       run: mix compile
@@ -46,7 +51,7 @@ jobs:
       id: zig-version
       run: mix eval "IO.puts(Zig.version())"
 
-    - uses: actions/cache@v1
+    - uses: actions/cache@v3
       id: zig-cache
       with:
         path: zig
@@ -57,5 +62,6 @@ jobs:
 
     - name: Run Tests
       env:
-        RUNNING_CI: "true"
+        RUNNING_CI: "TRUE"
+        ZIGLER_TEST_BLAS: "TRUE"
       run: mix test --exclude no_ci

.github/workflows/macos.yml

@@ -5,7 +5,7 @@ jobs:
     runs-on: macos-latest
     name: MacOS-latest-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: update-brew
         run: brew update
@@ -23,33 +23,39 @@ jobs:
         id: elixir-version
         run: elixir --version | tail -n 1 | awk '{ print $2 }'
 
-      - uses: actions/cache@v1
+      - uses: actions/cache@v3
         id: deps-cache
         with:
           path: deps
-          key: ${{ runner.os }}-mix-${{ steps.elixir-version.outputs.stdout }}-${{ hashFiles(format('{0}{1}', github.workspace, '/mix.lock')) }}
-  
+          key: ${{ runner.os }}-mix-${{ steps.elixir-version.outputs.stdout }}-${{ hashFiles('/mix.lock') }}
+
       - name: Install dependencies
         run: mix deps.get
 
-      - uses: actions/cache@v1
+      - uses: actions/cache@v3
         id: build-cache
         with:
           path: _build
-          key: ${{ runner.os }}-build-${{ steps.elixir-version.outputs.stdout }}-${{ hashFiles(format('{0}{1}', github.workspace, '/mix.lock')) }}
+          key: ${{ runner.os }}-build-${{ steps.elixir-version.outputs.stdout }}-${{ hashFiles('/mix.lock') }}
 
       - name: Compile base
         run: mix compile
 
       - name: Get Zig version
         id: zig-version
         run: mix eval "IO.puts(Zig.version())"
+
+      - uses: actions/cache@v3
+        id: zig-cache
+        with:
+          path: zig
+          key: ${{ runner.os }}-zig-${{ steps.zig-version.outputs.stdout }}
 
       - name: Get Zig
         run: mix zig.get
 
       - name: Run Tests
         env:
-          RUNNING_CI: "true"
+          RUNNING_CI: "TRUE"
           CI_LOG_LEVEL: warning
         run: mix test --exclude no_ci

.github/workflows/windows.yml

@@ -0,0 +1,56 @@
+name: Elixir CI - Windows
+
+on: push
+
+jobs:
+  test:
+    runs-on: windows-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Elixir
+        uses: erlef/setup-beam@v1
+        with:
+          elixir-version: '1.18.3'  # adjust as needed
+          otp-version: '27.3'       # adjust as needed
+
+      - uses: actions/cache@v3
+        id: deps-cache
+        with:
+          path: deps
+          key: ${{ runner.os }}-mix-${{ hashFiles('/mix.lock') }}-${{ hashfiles('/installer/**/*') }}
+
+      - name: Install dependencies
+        run: mix deps.get
+
+      - uses: actions/cache@v3
+        id: build-cache
+        with:
+          path: _build
+          key: ${{ runner.os }}-build-${{ hashFiles('/mix.lock') }}
+
+      - name: Compile base
+        run: mix compile
+
+      - name: Get Zig version
+        id: zig-version
+        shell: bash
+        run: | 
+          VERSION=$(mix eval "IO.puts(Zig.version())" | tail -n 1)
+          echo "zig_version=$VERSION" >> $GITHUB_OUTPUT
+
+      - uses: actions/cache@v3
+        id: zig-cache
+        with:
+          path: zig
+          key: ${{ runner.os }}-zig-${{ steps.zig-version.outputs.zig_version }}
+
+      - name: Get Zig
+        run: mix zig.get
+
+      - name: Run Tests
+        env:
+          RUNNING_CI: "TRUE"
+        run: mix test --exclude no_ci --exclude on_upgrade --exclude skip_windows

README.md

@@ -4,12 +4,18 @@ Library test status:
 
 - ![](https://github.com/ityonemo/zigler/workflows/Elixir%20CI%20-%20Linux/badge.svg)
 - ![](https://github.com/ityonemo/zigler/workflows/Elixir%20CI%20-%20MacOS/badge.svg)
+- ![](https://github.com/ityonemo/zigler/workflows/Elixir%20CI%20-%20Windows/badge.svg)
+- ![](https://github.com/ityonemo/zigler/workflows/Elixir%20CI%20-%20FreeBSD/badge.svg)
 
 ## Installation: Elixir
 
 ### Obtaining Zig dependency
 
-Run `mix zig.get`
+Run `mix zig.get` after `mix deps.get`.  This will provide a zig installation
+in the directory pointed to by `:filename.basedir(:user_cache, "zigler")`.
+
+You may also use a local installation of zig by specifying the environment variable
+`ZIG_ARCHIVE_PATH`.
 
 ### Main Installation
 
@@ -30,7 +36,7 @@ end
 
 TBD.
 
-`~/.cache/zigler/zig-linux-<arch>-0.13.0`
+`~/.cache/zigler/zig-linux-<arch>-0.14.0`
 
 ### Main Installation
 

VERSIONS.md

@@ -137,13 +137,31 @@ Thanks to Dave Cottlehuber @dch for testing.
 
 ## 0.13.0
 - updated to zig 0.13.0
+- Breaking changes:
+  - threadlocal `context` in function calls, optional passing `beam.env` into your functions
+  - makes `beam.get/make` functions `context`-aware, with all context-dependent things overridable.
+
+## 0.14.0
+- Breaking changes:
+  - deprecation of General Purpose Allocator in favor of DebugAllocator
+  - beam.term_type now uses an options tuple with `env` field.
+  - struct module names are now assigned using the `struct` option instead of using `as`.
+- Windows support:
+  - Experimental windows support added.
+  - Error return traces not supported.
+  - on_upgrade hooks not supported pending module .so versioning changes.
+- Features:
+  - adds ZIG_EXECUTABLE_PATH environment variable
+  - path resolution from CWD when a path is specified as `./`
+  - adds the ability to override the default fallback function (elixir only)
+- Outstanding issues:
+  - c_ulonglong doesn't work on windows; c_long doesn't work on other platforms.
+- Etc:
+  - uses system `:json` module, if available.
+  - Experimental FreeBSD support added.
 
 ## Upcoming
 - `precompiled` mode that will let you obtain packages with precompiled assets.
-- Breaking changes:
-  - threadlocal `context` in function calls, elimination of passing `beam.env` into your functions
-  - makes `beam.get/make` functions `context`-aware, with all context-dependent things overridable.
 
 ## Possible
-- `beam.call` which lets you call back a beam function.
 - `struct` which lets you declare a struct inside your zig code as the module's struct

guides/01-nifs.md

@@ -210,6 +210,7 @@ pub fn erroring() !void {
 }
 """
 
+@tag :erroring
 test "erroring" do
   assert_raise ErlangError, "Erlang error: :oops", fn -> erroring() end
 end
@@ -225,3 +226,11 @@ end
   documentation.
 - zigler will translate the hoisted marshalling failures into detailed BEAM exceptions of type
   `ArgumentError`.
+
+## Overriding the default fallback function (elixir-only)
+
+If the module's .so file fails to load, you might want to override the default fallback function
+with a pure elixir function. To do so, simply write the function body in elixir elsewhere in the
+module. This will be overwritten with the NIF only if the NIF successfully loads. You might use
+this, for example, to detect CPU features in `on_load`, and fallback to a 'slower' elixir code if
+CPU features required for performance are not present.

guides/02-collections.md

@@ -269,6 +269,13 @@ end
 >
 > Be careful about the endianness of packed and extern structs!
 
+> #### Wide datatype slices .{: warning }
+>
+> Note:  Currently if your serializable datatype requires an alignment greater than 1 
+> (if it's bigger than a byte), the system could segfault if you pass a binary that is 
+> a sub-binary.  If this is a concern, always perform `:binary.copy/1` before passing
+> into a function that accepts slices.  This will be fixed in a future release.
+
 ### Pointers to structs.
 
 Pointers to structs can also be used to marshal data in and out. This is enabled under the