https://github.com/okeuday/GEPD

Generic Erlang Port [Driver]: Automatically generate an Erlang port driver or Erlang port for C/C++ bindings using a single self-contained file, and easily switch between either.
https://github.com/okeuday/GEPD

erlang erlang-encoding erlang-port erlang-port-driver

Last synced: 28 days ago
JSON representation

Generic Erlang Port [Driver]: Automatically generate an Erlang port driver or Erlang port for C/C++ bindings using a single self-contained file, and easily switch between either.

• Host: GitHub
• URL: https://github.com/okeuday/GEPD
• Owner: okeuday
• License: mit
• Created: 2009-03-10T05:31:53.000Z (almost 16 years ago)
• Default Branch: master
• Last Pushed: 2023-02-11T04:47:17.000Z (almost 2 years ago)
• Last Synced: 2024-08-04T01:19:23.777Z (4 months ago)
• Topics: erlang, erlang-encoding, erlang-port, erlang-port-driver
• Language: C++
• Homepage:
• Size: 122 KB
• Stars: 82
• Watchers: 14
• Forks: 11
• Open Issues: 1
• Metadata Files:
  • Readme: README.markdown
  • License: LICENSE

Awesome Lists containing this project

• beamtoolbox - [erl

README

        
# GENERIC ERLANG PORT \[DRIVER\] (GEP[D])

## PURPOSE

To automatically generate an Erlang port driver or Erlang port

for C/C++ bindings using a single self-contained file.

Files:

* `test_bindings.h` contains the ONLY configuration to support the C functions

  (in `test_functions.h` and `test_functions.c`)

* `test_bindings.erl` provides the `gen_server` to manage the port or

  port driver

* `erlang_functions_hrl.h` creates the erlang function interface

* `port_driver.cpp` provides the Erlang port driver implementation

* `port.cpp` and `port.hpp` provide the Erlang port implementation

Whether `PORT_DRIVER_NAME_PREFIX` or `PORT_NAME_PREFIX` is defined determines

if a port driver or port is built, respectively (in `test_bindings.h`).

If both are defined, both are built and the port driver is used within

`test_bindings.erl` (undefine `ERL_PORT_DRIVER_NAME` if you want to use

the port).

Features:

* a function binding with only a single line tuple

* efficient passing of function types with no intermediate character buffer

* functionality like the Erlang Driver Tool Kit (EDTK) (no fd handling though)

* macro expansion to avoid code duplication errors

* floating point type handling

* stdout/stderr handling in the generated port code

Caveat:

(This is no longer true for `Erlang >= R15`)

The generated port driver code can not be used for hot code updating

if it performs an asynchronous call because erts will lock the driver

(making it "permanent") with `driver_lock_driver()`

(`http://erlang.org/doc/man/erl_driver.html#driver_lock_driver`).

With the driver locked, there is no possibility that an async

operation would create instability after a hot code update.

## BUILDING

`Erlang/OTP >= R14A` is required.

Boost is required for the preprocessor macro expansion code

([http://www.boost.org/](http://www.boost.org/)).

To build, use:

    ./autogen.sh

    ./configure

    make

    make install

## RUNNING

The `test_bindings` code should generate output similar to:

    $ erl +A 16

    1> test_bindings:start().

    using port driver

    {ok,<0.35.0>}

    2> test_bindings:test().

    sync sleep

    async sleep

    ...

    stdout writing before 2 second sleep

                                        ok

    3> stdout writing after 2 second sleep

                                          stderr

                                                line

                                                    break(s)

                                                            missasync function call returned: {ok,ok}

    3> 

## LICENSE

MIT License

## CONTACT

Michael Truog 

## THANKS

* Matt Stancliff (GEPD CMake integration)

* Scott Lystig Fritchie (EDTK, i.e., Erlang Driver Tool Kit)