graaf

Graaf

Ruby FFI for Built a Shared Library by GraalVM Native Image

Motivation

Using a Shared Library built with GraalVM Native Image requires built-in control over IsolateThread.

This gem manages the control of IsolateThread.

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add graaf

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install graaf

Usage

module Example
  extend Graaf::Library

  graaf_lib('libexample.so')

  # @note
  #   The first argument `graal_isolatethread_t*` does not need to be specified.
  graaf_attach_function :add, [:int, :int], :int
end

Example.add(1, 2)
# => 3

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/graaf_rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Graaf project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.