feat: EMLX compiled mode (#68)

* feat: add nif_call-based function compilation

* fix: make tests pass

* wip

* feat: working callback

* wip: add benchmarks

* feat: use non-modified header

* chore: remove bench files

* test: add compile test

* chore: forat

* docs: add warning on EMLX compiler

* docs: show github installation

* chore: update to safe nif_call version

* wip: update nif_call

* use nif_call v0.1.3

Signed-off-by: Cocoa <[email protected]>

---------

Signed-off-by: Cocoa <[email protected]>
Co-authored-by: Cocoa <[email protected]>

Author: polvalente

Makefile

@@ -11,6 +11,7 @@ MLX_BUILD_DIR = $(EMLX_CACHE_DIR)/mlx/build-$(MLX_VERSION)$(MLX_VARIANT)
 MLX_INSTALL_DIR = $(MLX_DIR)
 MLX_SO = $(MLX_LIB_DIR)/libmlx.dylib
 
+$(info LIBMLX_ENABLE_DEBUG=$(LIBMLX_ENABLE_DEBUG))
 # Build flags
 CFLAGS = -fPIC -I$(ERTS_INCLUDE_DIR) -I$(MLX_INCLUDE_DIR) -Wall \
          -std=c++17
@@ -39,6 +40,7 @@ MAKE_JOBS ?= $(MAKE_DEFAULT_JOBS)
 
 # Source files
 SOURCES = c_src/emlx_nif.cpp
+HEADERS = c_src/nif_call.h c_src/nx_nif_utils.hpp
 OBJECTS = $(patsubst c_src/%.cpp,$(BUILD_DIR)/%.o,$(SOURCES))
 
 # Main targets
@@ -48,7 +50,7 @@ all: $(MLX_SO) $(EMLX_SO)
 $(PRIV_DIR):
 	@ mkdir -p $(PRIV_DIR)
 
-$(BUILD_DIR)/%.o: c_src/%.cpp
+$(BUILD_DIR)/%.o: c_src/%.cpp $(HEADERS)
 	@ mkdir -p $(BUILD_DIR)
 	$(CXX) $(CFLAGS) -c $< -o $@
 

README.md

@@ -23,7 +23,7 @@ To use EMLX, you can add it as a dependency in your `mix.exs`:
 ```elixir
 def deps do
   [
-    {:emlx, "~> 0.1.0"}
+    {:emlx, github: "elixir-nx/emlx", branch: "main"}
   ]
 end
 ```
@@ -40,7 +40,10 @@ Nx.default_backend({EMLX.Backend, device: :cpu})
 Nx.default_backend({EMLX.Backend, device: :gpu})
 ```
 
-If desireable, you can also set the default compiler:
+If you want to use the JIT compiler, you can set the default compiler as shown below.
+
+Currently, the underlying implementation is not totally safe and could lead to a deadlocked dirty NIF, so this must be used with care.
+Defaulting to Nx.Defn.Evaluator is the safest option for now.
 
 ```elixir
 Nx.Defn.default_options(compiler: EMLX)