Erlang 21 - 6. Port Drivers

6 पोर्ट ड्राइवर




erlang

6 पोर्ट ड्राइवर

यह खंड लिंक-इन पोर्ट ड्राइवर का उपयोग करके Problem Example में Problem Example का समाधान करने के तरीके का एक उदाहरण बताता है।

एक पोर्ट ड्राइवर एक लिंक्ड-इन ड्राइवर होता है जो एक इरलांग प्रोग्राम से पोर्ट के रूप में सुलभ होता है। यह एक साझा पुस्तकालय है (SO in UNIX, DLL in Windows), जिसमें विशेष प्रवेश बिंदु हैं। Erlang रनटाइम सिस्टम इन एंट्री पॉइंट को कॉल करता है जब ड्राइवर को शुरू किया जाता है और जब डेटा पोर्ट पर भेजा जाता है। पोर्ट ड्राइवर भी डाटा को एरलैंग भेज सकता है।

पोर्ट ड्राइवर को गतिशील रूप से एमुलेटर प्रक्रिया में जोड़ा जाता है, यह एरलांग से सी-कोड को कॉल करने का सबसे तेज़ तरीका है। पोर्ट ड्राइवर में कॉलिंग फ़ंक्शन के लिए कोई संदर्भ स्विच की आवश्यकता नहीं है। लेकिन यह कम से कम सुरक्षित तरीका भी है, क्योंकि पोर्ट ड्राइवर में एक दुर्घटना एमुलेटर को भी नीचे लाती है।

परिदृश्य निम्न चित्र में चित्रित किया गया है:

चित्र 6.1: पोर्ट ड्राइवर संचार

6.1 एर्लांग कार्यक्रम

पोर्ट प्रोग्राम की तरह, पोर्ट एक एरलंग प्रक्रिया के साथ संचार करता है। सभी संचार एक एर्लांग प्रक्रिया से गुजरते हैं जो पोर्ट ड्राइवर की कनेक्टेड प्रक्रिया है। इस प्रक्रिया को समाप्त करने से पोर्ट ड्राइवर बंद हो जाता है।

पोर्ट बनाने से पहले, ड्राइवर को लोड किया जाना चाहिए। यह फ़ंक्शन erl_dll:load_driver/1 के साथ साझा लाइब्रेरी के तर्क के रूप में किया जाता है।

पोर्ट को तब BIF open_port/2 का उपयोग करके बनाया जाता है, पहले तर्क के रूप में टपल {spawn, DriverName} साथ। स्ट्रिंग SharedLib पोर्ट ड्राइवर का नाम है। दूसरा तर्क विकल्पों की एक सूची है, इस मामले में कोई नहीं:

-module(complex5).
-export([start/1, init/1]).

start(SharedLib) ->
    case erl_ddll:load_driver(".", SharedLib) of
        ok -> ok;
        {error, already_loaded} -> ok;
        _ -> exit({error, could_not_load_driver})
    end,
    spawn(?MODULE, init, [SharedLib]).

init(SharedLib) ->
  register(complex, self()),
  Port = open_port({spawn, SharedLib}, []),
  loop(Port).

अब complex5:foo/1 और complex5:bar/1 को लागू किया जा सकता है। दोनों complex प्रक्रिया के लिए एक संदेश भेजते हैं और निम्नलिखित उत्तर प्राप्त करते हैं:

foo(X) ->
    call_port({foo, X}).
bar(Y) ->
    call_port({bar, Y}).

call_port(Msg) ->
    complex ! {call, self(), Msg},
    receive
        {complex, Result} ->
            Result
    end.

complex प्रक्रिया निम्नलिखित कार्य करती है:

  • संदेश को बाइट्स के अनुक्रम में एन्कोड करता है।
  • इसे बंदरगाह पर भेजता है।
  • उत्तर की प्रतीक्षा करता है।
  • उत्तर को अस्वीकार करता है।
  • इसे वापस कॉलर को भेजता है:
loop(Port) ->
    receive
        {call, Caller, Msg} ->
            Port ! {self(), {command, encode(Msg)}},
            receive
                {Port, {data, Data}} ->
                    Caller ! {complex, decode(Data)}
            end,
            loop(Port)
    end.

यह मानते हुए कि दोनों फ़ंक्शन और सी फ़ंक्शन के परिणाम 256 से कम हैं, एक साधारण एन्कोडिंग / डिकोडिंग योजना कार्यरत है। इस योजना में, foo को बाइट 1 द्वारा दर्शाया गया है, bar को 2 द्वारा दर्शाया गया है, और तर्क / परिणाम एक एकल बाइट द्वारा दर्शाया गया है:

encode({foo, X}) -> [1, X];
encode({bar, Y}) -> [2, Y].

decode([Int]) -> Int.

पोर्ट को रोकने और पोर्ट फेल्योर का पता लगाने के कार्यों सहित परिणामी एरलांग कार्यक्रम इस प्रकार है:

-module(complex5).
-export([start/1, stop/0, init/1]).
-export([foo/1, bar/1]).

start(SharedLib) ->
    case erl_ddll:load_driver(".", SharedLib) of
	ok -> ok;
	{error, already_loaded} -> ok;
	_ -> exit({error, could_not_load_driver})
    end,
    spawn(?MODULE, init, [SharedLib]).

init(SharedLib) ->
    register(complex, self()),
    Port = open_port({spawn, SharedLib}, []),
    loop(Port).

stop() ->
    complex ! stop.

foo(X) ->
    call_port({foo, X}).
bar(Y) ->
    call_port({bar, Y}).

call_port(Msg) ->
    complex ! {call, self(), Msg},
    receive
	{complex, Result} ->
	    Result
    end.

loop(Port) ->
    receive
	{call, Caller, Msg} ->
	    Port ! {self(), {command, encode(Msg)}},
	    receive
		{Port, {data, Data}} ->
		    Caller ! {complex, decode(Data)}
	    end,
	    loop(Port);
	stop ->
	    Port ! {self(), close},
	    receive
		{Port, closed} ->
		    exit(normal)
	    end;
	{'EXIT', Port, Reason} ->
	    io:format("~p ~n", [Reason]),
	    exit(port_terminated)
    end.

encode({foo, X}) -> [1, X];
encode({bar, Y}) -> [2, Y].

decode([Int]) -> Int.

6.2 सी चालक

सी ड्राइवर एक मॉड्यूल है जो एक साझा लाइब्रेरी में संकलित और जुड़ा हुआ है। यह एक ड्राइवर संरचना का उपयोग करता है और इसमें हेडर फ़ाइल erl_driver.h

ड्राइवर संरचना ड्राइवर के नाम और फ़ंक्शन पॉइंटर्स से भरी हुई है। इसे मैक्रो DRIVER_INIT(<driver_name>) साथ घोषित विशेष प्रविष्टि बिंदु से लौटाया गया है।

डेटा प्राप्त करने और भेजने के लिए फ़ंक्शन को एक फ़ंक्शन में जोड़ा जाता है, जो ड्राइवर संरचना द्वारा इंगित किया गया है। पोर्ट में भेजे गए डेटा को तर्क के रूप में दिया गया है, और driver_output डेटा को C-function driver_output साथ भेजा गया है।

चूंकि ड्राइवर एक साझा मॉड्यूल है, न कि कोई प्रोग्राम, कोई मुख्य कार्य मौजूद नहीं है। इस फ़ंक्शन में सभी फ़ंक्शन पॉइंटर्स का उपयोग नहीं किया जाता है, और driver_entry संरचना में संबंधित फ़ील्ड NULL पर सेट होते हैं।

ड्राइवर में सभी फ़ंक्शन एक हैंडल लेता है ( start से लौटा हुआ) जो कि एर्लैंग प्रक्रिया के साथ ही पास हुआ है। यह किसी तरह से पोर्ट ड्राइवर उदाहरण को संदर्भित करना चाहिए।

example_drv_start , एकमात्र फ़ंक्शन है जिसे पोर्ट इंस्टेंस के हैंडल के साथ कहा जाता है, इसलिए इसे सहेजा जाना चाहिए। यह इस के लिए एक आवंटित ड्राइवर-परिभाषित संरचना का उपयोग करने के लिए, और एक संदर्भ के रूप में एक पॉइंटर वापस पारित करने के लिए प्रथागत है।

यह वैश्विक चर का उपयोग करने के लिए एक अच्छा विचार नहीं है क्योंकि पोर्ट ड्राइवर को कई एरलंग प्रक्रियाओं द्वारा पैदा किया जा सकता है। इस ड्राइवर-संरचना को कई बार त्वरित किया जाना है:

/* port_driver.c */

#include <stdio.h>
#include "erl_driver.h"

typedef struct {
    ErlDrvPort port;
} example_data;

static ErlDrvData example_drv_start(ErlDrvPort port, char *buff)
{
    example_data* d = (example_data*)driver_alloc(sizeof(example_data));
    d->port = port;
    return (ErlDrvData)d;
}

static void example_drv_stop(ErlDrvData handle)
{
    driver_free((char*)handle);
}

static void example_drv_output(ErlDrvData handle, char *buff, 
			       ErlDrvSizeT bufflen)
{
    example_data* d = (example_data*)handle;
    char fn = buff[0], arg = buff[1], res;
    if (fn == 1) {
      res = foo(arg);
    } else if (fn == 2) {
      res = bar(arg);
    }
    driver_output(d->port, &res, 1);
}

ErlDrvEntry example_driver_entry = {
    NULL,			/* F_PTR init, called when driver is loaded */
    example_drv_start,		/* L_PTR start, called when port is opened */
    example_drv_stop,		/* F_PTR stop, called when port is closed */
    example_drv_output,		/* F_PTR output, called when erlang has sent */
    NULL,			/* F_PTR ready_input, called when input descriptor ready */
    NULL,			/* F_PTR ready_output, called when output descriptor ready */
    "example_drv",		/* char *driver_name, the argument to open_port */
    NULL,			/* F_PTR finish, called when unloaded */
    NULL,                       /* void *handle, Reserved by VM */
    NULL,			/* F_PTR control, port_command callback */
    NULL,			/* F_PTR timeout, reserved */
    NULL,			/* F_PTR outputv, reserved */
    NULL,                       /* F_PTR ready_async, only for async drivers */
    NULL,                       /* F_PTR flush, called when port is about 
				   to be closed, but there is data in driver 
				   queue */
    NULL,                       /* F_PTR call, much like control, sync call
				   to driver */
    NULL,                       /* unused */
    ERL_DRV_EXTENDED_MARKER,    /* int extended marker, Should always be 
				   set to indicate driver versioning */
    ERL_DRV_EXTENDED_MAJOR_VERSION, /* int major_version, should always be 
				       set to this value */
    ERL_DRV_EXTENDED_MINOR_VERSION, /* int minor_version, should always be 
				       set to this value */
    0,                          /* int driver_flags, see documentation */
    NULL,                       /* void *handle2, reserved for VM use */
    NULL,                       /* F_PTR process_exit, called when a 
				   monitored process dies */
    NULL                        /* F_PTR stop_select, called to close an 
				   event object */
};

DRIVER_INIT(example_drv) /* must match name in driver_entry */
{
    return &example_driver_entry;
}

6.3 उदाहरण चल रहा है

चरण 1. सी कोड संकलित करें:

unix> gcc -o example_drv.so -fpic -shared complex.c port_driver.c
windows> cl -LD -MD -Fe example_drv.dll complex.c port_driver.c

चरण 2. Erlang प्रारंभ करें और Erlang कोड संकलित करें:

> erl
Erlang (BEAM) emulator version 5.1

Eshell V5.1 (abort with ^G)
1> c(complex5).
{ok,complex5}

चरण 3. उदाहरण चलाएँ:

2> complex5:start("example_drv").
<0.34.0>
3> complex5:foo(3).
4
4> complex5:bar(5).
10
5> complex5:stop().
stop