defmodule Mix.Tasks.Compile.Rustler do use Mix.Task require Logger alias Rustler.Compiler.{Messages, Rustup} @recursive true def run(_args) do config = Mix.Project.config() crates = Keyword.get(config, :rustler_crates) || raise_missing_crates() File.mkdir_p!(priv_dir()) Enum.map(crates, &compile_crate/1) # Workaround for a mix problem. We should REALLY get this fixed properly. _ = symlink_or_copy(config, Path.expand("priv"), Path.join(Mix.Project.app_path(config), "priv")) end defp priv_dir, do: "priv/native" def compile_crate({name, config}) do crate_path = Keyword.get(config, :path, "native/#{name}") build_mode = Keyword.get(config, :mode, :release) Mix.shell.info "Compiling NIF crate #{inspect name} (#{crate_path})..." crate_full_path = Path.expand(crate_path, File.cwd!) target_dir = Keyword.get(config, :target_dir, Path.join([Mix.Project.build_path(), "rustler_crates", Atom.to_string(name)])) cargo_data = check_crate_env(crate_full_path) {output_name, output_type} = case get_name(cargo_data, "lib") do nil -> case get_name(cargo_data, "bin") do nil -> throw_error({:cargo_no_name, crate_path}) name -> {name, :bin} end name -> {name, :lib} end compile_command = make_base_command(Keyword.get(config, :cargo, :system)) |> make_no_default_features_flag(Keyword.get(config, :default_features, true)) |> make_features_flag(Keyword.get(config, :features, [])) |> make_build_mode_flag(build_mode) |> make_platform_hacks(crate_full_path, output_type, :os.type()) [cmd_bin | args] = compile_command compile_return = System.cmd(cmd_bin, args, [ cd: crate_full_path, stderr_to_stdout: true, env: [{"CARGO_TARGET_DIR", target_dir} | Keyword.get(config, :env, [])], into: IO.stream(:stdio, :line), ]) case compile_return do {_, 0} -> nil {_, code} -> raise "Rust NIF compile error (rustc exit code #{code})" end {src_file, dst_file} = make_file_names(output_name, output_type) compiled_lib = Path.join([target_dir, Atom.to_string(build_mode), src_file]) destination_lib = Path.join(priv_dir(), dst_file) # If the file exists already, we delete it first. This is to ensure that another # process, which might have the library dynamically linked in, does not generate # a segfault. By deleting it first, we ensure that the copy operation below does # not write into the existing file. File.rm(destination_lib) File.cp!(compiled_lib, destination_lib) end defp make_base_command(:system), do: ["cargo", "rustc"] defp make_base_command({:bin, path}), do: [path, "rustc"] defp make_base_command({:rustup, version}) do if Rustup.version == :none do throw_error(:rustup_not_installed) end unless Rustup.version_installed?(version) do throw_error({:rust_version_not_installed, version}) end ["rustup", "run", version, "cargo", "rustc"] end defp make_platform_hacks(args, crate_path, :lib, {:unix, :darwin}) do path = Path.join([crate_path, ".cargo", "config"]) if File.exists?(path) do args else IO.write([ "\n", IO.ANSI.yellow(), """ Compiling on macOS requires special link args in order to compile correctly. Rustler is currently working around this issue in the compiler task. This will be removed in v1.0.0 in favor of a user supplied .cargo/config file. To remove this warning, please create #{path} with the following content: [target.x86_64-apple-darwin] rustflags = [ "-C", "link-arg=-undefined", "-C", "link-arg=dynamic_lookup", ] See https://developer.apple.com/library/archive/documentation/DeveloperTools/Conceptual/MachOTopics/1-Articles/executing_files.html for more details. """, IO.ANSI.default_color(), "\n" ]) args ++ ["--", "-C", "link-arg=-undefined", "-C", "link-arg=dynamic_lookup"] end end defp make_platform_hacks(args, _, _, _), do: args defp make_no_default_features_flag(args, true), do: args ++ [] defp make_no_default_features_flag(args, false), do: args ++ ["--no-default-features"] defp make_features_flag(args, []), do: args ++ [] defp make_features_flag(args, flags), do: args ++ ["--features", Enum.join(flags, ",")] defp make_build_mode_flag(args, :release), do: args ++ ["--release"] defp make_build_mode_flag(args, :debug), do: args ++ [] defp get_name(cargo_data, section) do get_in(cargo_data, [section, "name"]) end def make_file_names(base_name, :lib) do case :os.type() do {:win32, _} -> {"#{base_name}.dll", "lib#{base_name}.dll"} {:unix, :darwin} -> {"lib#{base_name}.dylib", "lib#{base_name}.so"} {:unix, _} -> {"lib#{base_name}.so", "lib#{base_name}.so"} end end def make_file_names(base_name, :bin) do case :os.type() do {:win32, _} -> {"#{base_name}.exe", "#{base_name}.exe"} {:unix, _} -> {base_name, base_name} end end def throw_error(error_descr) do Mix.shell.error Messages.message(error_descr) raise "Compilation error" end def check_crate_env(crate) do unless File.dir?(crate) do throw_error({:nonexistent_crate_directory, crate}) end case File.read("#{crate}/Cargo.toml") do {:error, :enoent} -> throw_error({:cargo_toml_not_found, crate}) {:ok, text} -> Toml.decode!(text) end end defp raise_missing_crates do Mix.raise """ Missing required :rustler_crates option in mix.exs. """ end # https://github.com/elixir-lang/elixir/blob/b13404e913fff70e080c08c2da3dbd5c41793b54/lib/mix/lib/mix/project.ex#L553-L562 defp symlink_or_copy(config, source, target) do if config[:build_embedded] do if File.exists?(source) do File.rm_rf!(target) File.cp_r!(source, target) end :ok else Mix.Utils.symlink_or_copy(source, target) end end end