Erlang Language
NIF

Definicja

Oficjalna dokumentacja: http://erlang.org/doc/tutorial/nif.html

NIF zostały wprowadzone w Erlang / OTP R13B03 jako funkcja eksperymentalna. Ma to na celu umożliwienie wywoływania kodu C z wnętrza kodu Erlang.

NIF są zaimplementowane w C zamiast Erlanga, ale pojawiają się one jako inne funkcje w zakresie kodu Erlanga, ponieważ należą do modułu, w którym nastąpiło włączenie. Biblioteki NIF są łączone podczas kompilacji i ładowane w czasie wykonywania.

Ponieważ biblioteki NIF są dynamicznie łączone z procesem emulatora, są szybkie, ale również niebezpieczne, ponieważ awaria w NIF powoduje również wyłączenie emulatora.

Przykład: aktualny czas UNIX

Oto bardzo prosty przykład ilustrujący sposób pisania NIF.

Struktura katalogów:

nif_test
├── c_src
│   ├── Makefile
│   └── nif_test.c
├── rebar.config
└── src
    ├── nif_test.app.src
    └── nif_test.erl

Tę strukturę można łatwo zainicjować za pomocą Rebar3:

$ rebar3 new lib nif_test && cd nif_test && rebar3 new cmake

Zawartość nif_test.c :

#include "erl_nif.h"
#include "time.h"

static ERL_NIF_TERM now(ErlNifEnv* env, int argc, const ERL_NIF_TERM argv[]) {
        return enif_make_int(env, time(0));
}

static ErlNifFunc nif_funcs[] = {
        {"now", 0, now}
};

ERL_NIF_INIT(nif_test,nif_funcs,NULL,NULL,NULL,NULL);

Zawartość nif_test.erl :

-module(nif_test).
-on_load(init/0).
-export([now/0]).

-define(APPNAME, nif_test).
-define(LIBNAME, nif_test).

%%====================================================================
%% API functions
%%====================================================================

now() -> nif_not_loaded.

%%====================================================================
%% Internal functions
%%====================================================================

init() ->
    SoName = case code:priv_dir(?APPNAME) of
        {error, bad_name} ->
            case filelib:is_dir(filename:join(["..", priv])) of
                true -> filename:join(["..", priv, ?LIBNAME]);
                _ -> filename:join([priv, ?LIBNAME])
            end;
        Dir -> filename:join(Dir, ?LIBNAME)
    end,
    erlang:load_nif(SoName, 0).

Zawartość rebar.config :

{erl_opts, [debug_info]}.
{deps, []}.

{pre_hooks, [
  {"(linux|darwin|solaris)", compile, "make -C c_src"},
  {"(freebsd)", compile, "gmake -C c_src"}
]}.
{post_hooks, [
  {"(linux|darwin|solaris)", clean, "make -C c_src clean"},
  {"(freebsd)", clean, "gmake -C c_src clean"}
]}.

Teraz możesz uruchomić przykład:

$ rebar3 shell                                                                                                                                        
===> Verifying dependencies...
===> Compiling nif_test
make: Entering directory '/home/vschroeder/Projects/nif_test/c_src'
cc -O3 -std=c99 -finline-functions -Wall -Wmissing-prototypes -fPIC -I /usr/local/lib/erlang/erts-7.3.1/include/ -I /usr/local/lib/erlang/lib/erl_interface-3.8.2/include  -c -o /home/vschroeder/Projects/nif_test/c_src/nif_test.o /home/vschroeder/Projects/nif_test/c_src/nif_test.c
cc /home/vschroeder/Projects/nif_test/c_src/nif_test.o -shared -L /usr/local/lib/erlang/lib/erl_interface-3.8.2/lib -lerl_interface -lei -o /home/vschroeder/Projects/nif_test/c_src/../priv/nif_test.so
make: Leaving directory '/home/vschroeder/Projects/nif_test/c_src'
Erlang/OTP 18 [erts-7.3.1] [source] [64-bit] [smp:4:4] [async-threads:0] [hipe] [kernel-poll:false]

Eshell V7.3.1  (abort with ^G)
1> nif_test:now().
1469732239
2> nif_test:now().
1469732264
3> 

Erlang C API (C do Erlang)

Oficjalna dokumentacja : http://erlang.org/doc/man/erl_nif.html

Najważniejsze struktury, typy i makra Erlang C API to:

• ERL_NIF_TERM : typ terminów Erlang. Jest to typ zwracany przez funkcje NIF.
• ERL_NIF_INIT(MODULE, ErlNifFunc funcs[], load, reload, upgrade, unload) : To makro, które faktycznie tworzy NIF zdefiniowane w określonym pliku C. Należy to ocenić w zakresie globalnym. Zwykle będzie to ostatni wiersz w pliku C.
• ErlNifFunc : typ, z którym każdy NIF jest przekazywany do ERL_NIF_INIT celu wyeksportowania. Struktura ta składa się z nazwy, arity, wiersza funkcji C i flag. Należy utworzyć tablicę tego typu ze wszystkimi definicjami NIF, aby przekazać ją do ERL_NIF_INIT .
• ErlNifEnv : środowisko Erlang, w którym wykonywany jest NIF. Przekazywanie środowiska jako pierwszego argumentu dla każdego NIF jest obowiązkowe. Ten typ jest nieprzejrzysty i można nim manipulować tylko za pomocą funkcji oferowanych przez interfejs API Erlang C.