can pass features during comp, waiting to give some time to think about how best to expose these

wip: can conditioanlly load rayon functions waiting to decided if that is a good idea

cfg and cfg not prevent compiler warnings

removed codeloader now that cfg doesn't produce errors

temp add log to test package compliation

finish flag support, document, and expose update_with_join

Author: Thomas-Jean

README.md

@@ -1,23 +1,47 @@
 [![Hex.pm Version](http://img.shields.io/hexpm/v/blake3.svg?style=flat)](https://hex.pm/packages/blake3)
 
 # Blake3
+
 Elixir bindings for the Rust Blake3 implementation.
 These bindings use [`:rustler`](https://github.com/rusterlium/rustler) to connect to the hashing functions.
 
-
 ## Installation
+
 The package can be installed by adding `blake3` to your list of dependencies in `mix.exs`:
 
 ```elixir
 def deps do
   [
-    {:blake3, "~> 0.2.0"}
+    {:blake3, "~> 0.3.0"}
   ]
 end
 ```
 
 run `mix deps.get` and `mix deps.compile` to pull and build the bindings
 
+## Configuration
+
+There are feature options in the rust implementation that allow for additional SIMD instructions and multithreading. They can be set though environment variable or `Mix.Config`. 
+
+```shell
+export BLAKE3_SIMD_MODE=c
+export BLAKE3_RAYON=true
+```
+
+or
+
+```elixir
+config :blake3,
+   simd_mode: :c_neon,
+   rayon: :true
+```
+
+* `c` enables C/assembly implementations and AVX-512 support
+* `c_neon` enables ARM NEON support
+* `rayon` enables Rayon-based multithreading
+
+When changing configuration you will need to call `mix deps.compile` to enable the features.
+
 ## Example Usage
 
 ```elixir

config/config.exs

@@ -1 +1,3 @@
 use Mix.Config
+# config :blake3, simd_mode: "std"
+# config :blake3, rayon: :false

lib/blake3.ex

@@ -85,4 +85,14 @@ defmodule Blake3 do
   def reset(state) do
     Native.reset(state)
   end
+
+  @doc """
+  updates state with the potential to multithreading. The rayon
+  feature needs to be enabled and the input need to be large enough.
+  for more information see:
+  [comment](https://github.com/BLAKE3-team/BLAKE3/blob/fdd329ba57896faac4ae797775c175ad880cbe42/src/lib.rs#L948-L981)
+  """
+  def update_with_join(state, data) do
+    Native.update_with_join(state, data)
+  end
 end

lib/blake3/native.ex

@@ -9,6 +9,7 @@ defmodule Blake3.Native do
   def hash(_str), do: error()
   def new(), do: error()
   def update(_state, _str), do: error()
+  def update_with_join(_state, _str), do: error()
   def finalize(_state), do: error()
   def derive_key(_context, _key), do: error()
   def keyed_hash(_key, _str), do: error()

mix.exs

@@ -1,4 +1,4 @@
-defmodule Blake3.MixProject do
+defmodule MixBlake3.Project do
   use Mix.Project
 
   def project do
@@ -48,11 +48,43 @@ defmodule Blake3.MixProject do
     [
       blake3: [
         path: "native/blake3",
-        mode: rustc_mode(Mix.env())
+        mode: rustc_mode(Mix.env()),
+        default_features: default_features?(),
+        features: config_features()
       ]
     ]
   end
 
   defp rustc_mode(:prod), do: :release
   defp rustc_mode(_), do: :debug
+
+  defp default_features? do
+    simd = Application.get_env(:blake3, :simd_mode) || System.get_env("BLAKE3_SIMD_MODE")
+    rayon = Application.get_env(:blake3, :rayon) || System.get_env("BLAKE3_RAYON")
+
+    case {simd, rayon} do
+      {nil, nil} -> true
+      _ -> false
+    end
+  end
+
+  defp config_features() do
+    simd =
+      case Application.get_env(:blake3, :simd_mode) || System.get_env("BLAKE3_SIMD_MODE") do
+        "c" -> "c"
+        :c -> "c"
+        "c_neon" -> "c_neon"
+        :c_neon -> "c_neon"
+        _ -> "std"
+      end
+
+    rayon =
+      case Application.get_env(:blake3, :rayon) || System.get_env("BLAKE3_RAYON") do
+        "true" -> "rayon"
+        true -> "rayon"
+        _ -> nil
+      end
+
+    Enum.filter([simd, rayon], fn x -> x !== nil end)
+  end
 end

mix.lock

@@ -1,9 +1,9 @@
 %{
-  "earmark": {:hex, :earmark, "1.4.3", "364ca2e9710f6bff494117dbbd53880d84bebb692dafc3a78eb50aa3183f2bfd", [:mix], [], "hexpm"},
-  "ex_doc": {:hex, :ex_doc, "0.21.2", "caca5bc28ed7b3bdc0b662f8afe2bee1eedb5c3cf7b322feeeb7c6ebbde089d6", [:mix], [{:earmark, "~> 1.3.3 or ~> 1.4", [hex: :earmark, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}], "hexpm"},
-  "makeup": {:hex, :makeup, "1.0.0", "671df94cf5a594b739ce03b0d0316aa64312cee2574b6a44becb83cd90fb05dc", [:mix], [{:nimble_parsec, "~> 0.5.0", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm"},
-  "makeup_elixir": {:hex, :makeup_elixir, "0.14.0", "cf8b7c66ad1cff4c14679698d532f0b5d45a3968ffbcbfd590339cb57742f1ae", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm"},
-  "nimble_parsec": {:hex, :nimble_parsec, "0.5.3", "def21c10a9ed70ce22754fdeea0810dafd53c2db3219a0cd54cf5526377af1c6", [:mix], [], "hexpm"},
-  "rustler": {:hex, :rustler, "0.21.0", "68cc4fc015d0b9541865ea78e78e9ef2dd91ee4be80bf543fd15791102a45aca", [:mix], [{:toml, "~> 0.5.2", [hex: :toml, repo: "hexpm", optional: false]}], "hexpm"},
-  "toml": {:hex, :toml, "0.5.2", "e471388a8726d1ce51a6b32f864b8228a1eb8edc907a0edf2bb50eab9321b526", [:mix], [], "hexpm"},
+  "earmark": {:hex, :earmark, "1.4.3", "364ca2e9710f6bff494117dbbd53880d84bebb692dafc3a78eb50aa3183f2bfd", [:mix], [], "hexpm", "8cf8a291ebf1c7b9539e3cddb19e9cef066c2441b1640f13c34c1d3cfc825fec"},
+  "ex_doc": {:hex, :ex_doc, "0.21.2", "caca5bc28ed7b3bdc0b662f8afe2bee1eedb5c3cf7b322feeeb7c6ebbde089d6", [:mix], [{:earmark, "~> 1.3.3 or ~> 1.4", [hex: :earmark, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}], "hexpm", "f1155337ae17ff7a1255217b4c1ceefcd1860b7ceb1a1874031e7a861b052e39"},
+  "makeup": {:hex, :makeup, "1.0.0", "671df94cf5a594b739ce03b0d0316aa64312cee2574b6a44becb83cd90fb05dc", [:mix], [{:nimble_parsec, "~> 0.5.0", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "a10c6eb62cca416019663129699769f0c2ccf39428b3bb3c0cb38c718a0c186d"},
+  "makeup_elixir": {:hex, :makeup_elixir, "0.14.0", "cf8b7c66ad1cff4c14679698d532f0b5d45a3968ffbcbfd590339cb57742f1ae", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "d4b316c7222a85bbaa2fd7c6e90e37e953257ad196dc229505137c5e505e9eff"},
+  "nimble_parsec": {:hex, :nimble_parsec, "0.5.3", "def21c10a9ed70ce22754fdeea0810dafd53c2db3219a0cd54cf5526377af1c6", [:mix], [], "hexpm", "589b5af56f4afca65217a1f3eb3fee7e79b09c40c742fddc1c312b3ac0b3399f"},
+  "rustler": {:hex, :rustler, "0.21.0", "68cc4fc015d0b9541865ea78e78e9ef2dd91ee4be80bf543fd15791102a45aca", [:mix], [{:toml, "~> 0.5.2", [hex: :toml, repo: "hexpm", optional: false]}], "hexpm", "e5429378c397f37f1091a35593b153aee1925e197c6842d04648d802edb52f80"},
+  "toml": {:hex, :toml, "0.5.2", "e471388a8726d1ce51a6b32f864b8228a1eb8edc907a0edf2bb50eab9321b526", [:mix], [], "hexpm", "f1e3dabef71fb510d015fad18c0e05e7c57281001141504c6b69d94e99750a07"},
 }

native/blake3/Cargo.lock

@@ -3,6 +3,15 @@ name = "blake3"
 version = "0.2.1"
 authors = ["Thomas Jean <thomas.jean486@gmail.com>"]
 
+[features]
+
+default = ["blake3/default"]
+c = ["blake3/c"]
+c_neon = ["blake3/c_neon"]
+std = ["blake3/std"]
+rayon = ["blake3/rayon"]
+
+
 [lib]
 name = "blake3"
 path = "src/lib.rs"

native/blake3/Cargo.toml

@@ -8,14 +8,14 @@ use rustler::resource::ResourceArc;
 use std::io::Write;
 use std::sync::Mutex;
 
-
 pub struct HasherResource(Mutex<blake3::Hasher>);
 
 rustler_export_nifs!(
     "Elixir.Blake3.Native", 
     [("hash", 1, hash),
     ("new",0, new),
     ("update",2,update),
+    ("update_with_join",2,update_with_join),
     ("finalize",1,finalize),
     ("derive_key",2,derive_key),
     ("keyed_hash",2,keyed_hash),
@@ -131,3 +131,21 @@ fn reset<'a>(env: Env<'a>, args: &[Term<'a>]) -> NifResult<Term<'a>> {
 
     Ok((resource).encode(env))
 }
+
+fn update_with_join<'a>(env: Env<'a>, args: &[Term<'a>]) -> NifResult<Term<'a>> {
+    let resource: ResourceArc<HasherResource> = args[0].decode()?;
+    let buf : types::Binary = args[1].decode()?;
+
+
+    let mut hasher = resource.0.try_lock().unwrap();
+    #[cfg(feature = "rayon")]{
+        hasher.update_with_join::<blake3::join::RayonJoin>(&buf);
+    }
+
+    #[cfg(not(feature = "rayon"))]{
+        hasher.update_with_join::<blake3::join::SerialJoin>(&buf);
+    }
+
+    Ok((resource).encode(env))
+
+}