rabbit-slide-kou-rubykaigi-2016 2016.9.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b032ef54474e6fb2d6213f008397240691570368
+  data.tar.gz: 75d63b266c7db660d967f54ab5c7827ed490a8a7
+SHA512:
+  metadata.gz: ca2b829c46c709b8700c6a46cfae91de0598f0fc6914df855f1b79a64e92c0486b61d6e3c4e256d77086f6a7b4cee6950b495981f45ae7b3dcd6c70e064384ea
+  data.tar.gz: fd09c94ecb21cdd388c3c81f23d89e478b8a870f42e989d62a5eabeceadbca48c31af30f8f764c125e3f9425ee23988b5407587a77c073d64730e5b24c90b062

data/.rabbit

@@ -0,0 +1 @@
+how-to-create-bindings-2016.rab

data/README.rd

@@ -0,0 +1,24 @@
+= How to create bindings 2016
+
+This talk describes how to create Ruby bindings of a C library. It's the latest information in 2016.
+
+== For author
+
+=== Show
+
+  rake
+
+=== Publish
+
+  rake publish
+
+== For viewers
+
+=== Install
+
+  gem install rabbit-slide-kou-rubykaigi-2016
+
+=== Show
+
+  rabbit rabbit-slide-kou-rubykaigi-2016.gem
+

data/Rakefile

@@ -0,0 +1,17 @@
+require "rabbit/task/slide"
+
+# Edit ./config.yaml to customize meta data
+
+spec = nil
+Rabbit::Task::Slide.new do |task|
+  spec = task.spec
+  spec.files += Dir.glob("images/*.*")
+  # spec.files -= Dir.glob("private/**/*.*")
+  spec.add_runtime_dependency("rabbit-theme-clear-code")
+end
+
+desc "Tag #{spec.version}"
+task :tag do
+  sh("git", "tag", "-a", spec.version.to_s, "-m", "Publish #{spec.version}")
+  sh("git", "push", "--tags")
+end

data/a.md

@@ -0,0 +1,48 @@
+# [Ruby][会社] クリアコード：RubyKaigi 2016にスピーカー・スポンサーとして参加予定
+
+9月8日から10日の3日間[RubyKaigi 2016](http://rubykaigi.org/2016/)が開催されます。
+
+クリアコードは例年RubyKaigiのスポンサーをしています。去年の[RubyKaigi 2015のスポンサー](20151209)に引き続き、[RubyKaigi 2016もスポンサー](http://rubykaigi.org/2016/sponsors#clear-code)になりました。今年はブースを出します。ブースでは[OSS Gate](https://oss-gate.doorkeeper.jp/)とクリアコード自体のことを紹介する予定です。クリアコードが気になる人は遊びに来てください。
+
+また、須藤と沖元がスピーカーとして話します。どちらも[2日目の9月9日](http://rubykaigi.org/2016/schedule/#sep09)です。須藤は[10:30からのセッション](http://rubykaigi.org/2016/presentations/ktou.html)で最新のバインディングの作り方について話します。沖元は[14:20からのセッション](http://rubykaigi.org/2016/presentations/okkez.html)でRubyリファレンスマニュアルについて話します。
+
+ところで、8月21日にリリースされた[Rubyist Magazine 0054号](http://magazine.rubyist.net/?0054)では[東京 Ruby 会議 11 運営記録](http://magazine.rubyist.net/?0054-TokyoRubyKaigi11OrganizeReport)がよかったです。この記事の中に事前インタビューの目的が書いてあります。4つ目の目的として「発表者に事前インタビューすることで、発表の内容を事前に考えて貰う」が挙がっています。RubyKaigi 2016では事前インタビューはありませんが、ここに発表内容を事前にまとめることで同じ目的を達成できるはずです。ということで、須藤の発表内容を紹介します。
+
+## 2016年のバインディングの作り方
+
+バインディングとはRuby以外の言語（主にC言語とC++言語）で実装された機能をRubyで使うためのライブラリーです。バインディングを使うと、Rubyでその機能を実装しなくてもその機能を使えるようになるため、短時間で高品質の機能を手に入れ（られることがあり）ます。また、C言語での実装はRubyでの実装よりも10倍100倍速いことがざらにあるので、性能面でも有利です。画像処理・動画処理・音声処理・全文検索・機械学習・統計処理・暗号処理などは実装コスト・性能の両面からバインディングを利用して既存実装を活用するのが向いている分野です。
+
+というような背景があり、RubyをWebだけでなく様々な分野で活用するためにはバインディングは重要です。そんなバインディングの作り方を紹介するのが須藤の話です。
+
+バインディングを作るために使える仕組みが拡張ライブラリーです。拡張ライブラリーはC言語で実装された機能をRubyに組み込む仕組みです。C言語で既存の機能をラップする拡張ライブラリーを作ることでバインディングになります。
+
+拡張ライブラリーの難点の1つに「インストールするためにはCコンパイラーが必要なこと」があります。拡張ライブラリーを使うためにはコンパイルする必要があるため、Cコンパイラーがないと拡張ライブラリーを使えません。GNU/LinuxやBSD系などCコンパイラーを用意しやすいOSもあればそうでないOSもあります。たとえば、WindowsではCコンパイラーを用意することの敷居が高く、インストールが難しいです。
+
+この問題を解決する方法としてfat gemというやり方があります。これはgemの中にビルド済みバイナリーを入れるというやり方です。こうすることにより、ユーザーの環境にCコンパイラーがなくても拡張ライブラリーを使えるようになります。fat gemはWindowsユーザー向けだけに用意すればよいです。Windows以外のよく使われている環境ではCコンパイラーを用意することは比較的簡単だからです。
+
+拡張ライブラリーの難点はもう1つあります。バインディング対象の機能数に応じて実装コストがあがる点です。Rubyが拡張ライブラリー用に提供しているAPIは比較的使いやすいため、拡張ライブラリーとしてバインディングを作ることは技術的にそれほど難しくありません。ただし、対象機能を1つずつラップするため、対象機能が多いとその分手間がかかるのです。
+
+この難点を解決する方法としてバインディングを生成する方法があります。拡張ライブラリーによるバインディングの実装にはある程度パターンがあるので生成することができるのです。[SWIG](http://www.swig.org/)というツールはそれを実現するためのツールです。
+
+SWIGを使うと（多くの場合は）少ない記述でバインディング用の拡張ライブラリーのコードを生成できます。これで、少ない手間でたくさんの機能のバインディングを作ることができます。ただ、SWIGを使った場合でもいくつか難点があります。
+
+SWIGも拡張ライブラリーを使ったバインディングなのでインストールが難しい問題があります。これはfat gemというやり方で解決できるのは前述のとおりです。しかし、SWIGを使った場合は別の問題もあります。インストール時にCコンパイラーとSWIGが必要になる点です。通常、SWIGはシステムにインストールされていないので別途インストールする必要があります。インストール時にSWIGが必要なくする方法もあります。SWIGで生成した拡張ライブラリーのコードをgemに含める方法です。こうすることでインストール時にSWIGは必要なくなります。ただし、gemに含めたときに生成した機能しか含まれません。gemに含めたときの対象ライブラリーはバージョン1で、ユーザーがインストールしようとしたときはバージョン2になっていた、という場合、バージョン2で追加された機能は使えない、ということです。
+
+性能面でも幾分オーバーヘッドがあります。手書きでシンプルに実装したバインディングとSWIGで自動生成したバインディングではシンプルに実装したバインディングの方が高速です。バインディングのメソッドを大量に呼び出す（何万回とか）場合は影響があるでしょう。
+
+これまでのバインディングの作成方法ではインストールの難しさが難点としてでていました。これはC言語を使っていることが原因です。つまり、C言語を使わずにバインディングを作れればインストールが簡単になります。その方法はFFI（Foreign Function Interface）を使う方法です。なお、最近のRubyで使えるFFIの実装はすべてlibffiというライブラリーを使っています。
+
+FFIを使うとRubyでバインディングを書くことができます。拡張ライブラリーでやっていたことをRubyで書けるようになっただけで、1つずつ機能をラップしていかなければいけない点は変わりませんが、それをCではなくRubyで書けるようになることで書きやすくなっています。
+
+バインディングにC言語を使わなくなったことによりバインディングのインストールは確かに簡単になるのですが、バインディングが動くためにはラップ対象のライブラリーは依然として必要です。そのため、Windowsユーザーがインストールしにくいという点はそれほど解決されていません。
+
+また、バインディングを書く言語がCからRubyになっているので手間は減ってはいますが、対象の機能がたくさんあると結局手間なのは変わりません。
+
+さらに、FFIを使うとSWIGを使ったときよりも性能が落ちます。
+
+TODO
+
+
+## まとめ
+
+クリアコードは9月8日から10日にかけて開催されるRubyKaigi 2016にスピーカー・スポンサーとして参加します。この機会に多くの人と交流できることを期待しています。それでは、RubyKaigi 2016で会いましょう。

data/config.yaml

@@ -0,0 +1,23 @@
+---
+id: rubykaigi-2016
+base_name: how-to-create-bindings-2016
+tags:
+- rabbit
+- ruby
+- bindings
+presentation_date: 2016-09-08
+version: 2016.9.8.0
+licenses:
+- CC BY-SA 4.0
+slideshare_id: 
+speaker_deck_id: 
+ustream_id: 
+vimeo_id: 
+youtube_id: 
+author:
+  markup_language: :rd
+  name: Kouhei Sutou
+  email: kou@clear-code.com
+  rubygems_user: kou
+  slideshare_user: kou
+  speaker_deck_user: 

data/how-to-create-bindings-2016.rab

@@ -0,0 +1,421 @@
+= Ruby bindings 2016
+
+: subtitle
+   How to create bindings 2016
+
+: author
+   Kouhei Sutou
+: institution
+   ClearCode Inc.
+: content-source
+   RubyKaigi 2016
+: date
+   2016-09-08
+: allotted-time
+   35m
+: theme
+   .
+
+= Silver sponsor
+
+  # img
+  # src = images/clear-code-silver-sponsor.png
+  # relative_height = 100
+
+# == Slide properties
+
+# : enable-title-on-image
+#    false
+
+= Goal\n(('note:目標'))
+
+(('tag:center'))
+(('tag:large'))
+You know about\n
+how to create bindings
+
+(('tag:center'))
+(('note:バインディングの作り方を知ること'))
+
+= Bindings?\n(('note:バインディングとは'))
+
+  * Glue of (('note:(mainly)')) C and Ruby\n
+    (('note:主にCとRubyをつなぐもの'))
+
+    * (('wait'))You can use features implemented in C from Ruby\n
+      (('note:Cで実装された機能をRubyから使える'))
+
+    * (('wait'))e.g.: Socket, OpenSSL, YAML, ...\n
+      (('note:例：ソケット、OpenSSL、YAML…'))
+
+= Bindings\n(('note:バインディング'))
+
+  # image
+  # src = images/bindings.svg
+  # relative_height = 100
+
+== slide properties
+
+: enable-title-on-image
+   false
+
+= But why do I know?\n(('note:でも、どうして知るといいの？'))
+
+  * (('wait'))To use Ruby in more cases\n
+    (('note:Rubyをもっといろんな場面で使うため'))
+    * e.g.: (('tag:x-small:Machine leaning, multimedia, full text search, cipher and so on'))\n
+      (('note:例：機械学習、画像・動画・音声処理、全文検索・暗号'))
+  * (('wait'))We can use existing good features in Ruby by bindings\n
+    (('note:バインディングがあると既存のいい機能をRubyで使える'))
+
+= Incr. bindings developer\n(('note:バインディング開発者が増えるといいな'))
+
+  * How about becoming a bindings developer?\n
+    (('note:バインディング開発者になりませんか？'))
+    * (('wait'))To expand Ruby use cases!\n
+      (('note:Rubyの適用可能領域を増やすために！'))
+    * (('wait'))Not just an user for\n
+      provided features\n
+      (('note:提供された機能を使う1ユーザーではなく'))
+
+= Summary\n(('note:概要'))
+
+  # RT
+
+  , Ext★, SWIG, FFI, GI☆
+
+  Base\nTech, Ext, Ext, lib\nffi, lib\nffi
+  Impl.\nby, Hand, Gene-rate, Hand, Gene-rate
+
+(('note:★ Extension library（拡張ライブラリー）'))\n
+(('note:☆ GObject Introspection: Recommended（オススメ）'))
+
+= Demo\n(('note:デモ'))
+
+How powerful auto generated bindings\n
+(('note:自動生成されたバインディングがいかに強力か'))
+
+= What is ext?\n(('note:拡張ライブラリーってなに？'))
+
+  # RT
+
+  , Ext★, SWIG, FFI, GI☆
+
+  Base\nTech, ((*Ext*)), ((*Ext*)), lib\nffi, lib\nffi
+  Impl.\nby, Hand, Gene-rate, Hand, Gene-rate
+
+(('note:★ Extension library（拡張ライブラリー）'))\n
+(('note:☆ GObject Introspection: Recommended（オススメ）'))
+
+= Extension library\n(('note:拡張ライブラリーとは'))
+
+  * Ruby library written in ((*C*))\n
+    (('note:Cで書かれたRuby用ライブラリー'))
+  * (('wait'))Most bindings are ext lib\n
+    (('note:多くのバインディングは拡張ライブラリーとして実装'))
+    * (({openssl})) is ext lib and bindings\n
+      (('note:(({oepnssl}))は拡張ライブラリーでバインディング'))
+    * Exc.: (({stringio})) is ext lib but...\n
+      (('note:例外：(({stringio}))は拡張ライブラリーだが…'))
+
+= Ext lib and bindings\n(('note:拡張ライブラリーとバインディング'))
+
+  # image
+  # src = images/extension-library-and-bindings.svg
+  # relative_height = 100
+
+== slide properties
+
+: enable-title-on-image
+   false
+
+= What is libffi?\n(('note:libffiってなに？'))
+
+  # RT
+
+  , Ext★, SWIG, FFI, GI☆
+
+  Base\nTech, Ext, Ext, ((*lib\nffi*)), ((*lib\nffi*))
+  Impl.\nby, Hand, Gene-rate, Hand, Gene-rate
+
+(('note:★ Extension library（拡張ライブラリー）'))\n
+(('note:☆ GObject Introspection: Recommended（オススメ）'))
+
+= libffi and FFI: 1\n(('note:libffiとFFIとは：1'))
+
+  * libffi: Library to impl. FFI
+  * (('wait'))((*F*))oreign ((*F*))unction ((*I*))nterface
+    * Generally:\n
+      All APIs to impl. bindings\n
+      (('note:一般的にはバインディングを実装するためのすべてのAPI'))
+    * Ruby doesn't use "FFI" term\n
+      (('note:Rubyでは「FFI」という単語を使わない'))
+
+= libffi and FFI: 2\n(('note:libffiとFFIとは：2'))
+
+  * Ruby FFI
+    * (('wait'))Library based on libffi\n
+      (('note:libffiを使ったライブラリー'))
+    * (('wait'))Provides ((*Ruby*)) API\n
+      to implement bindings\n
+      (('note:バインディングを実装するためのRubyレベルのAPIを提供'))
+
+= libffi and bindings\n(('note:libffiとバインディング'))
+
+  # image
+  # src = images/libffi-and-bindings.svg
+  # relative_height = 100
+
+== slide properties
+
+: enable-title-on-image
+   false
+
+= Impl. language\n(('note:実装言語'))
+
+  # RT
+
+  , Ext★, SWIG, FFI, GI☆
+
+  Base\nTech, Ext, Ext, lib\nffi, lib\nffi
+  Impl.\nlang, C, C+α, Ruby, Ruby
+
+(('note:★ Extension library（拡張ライブラリー）'))\n
+(('note:☆ GObject Introspection: Recommended（オススメ）'))
+
+= Ext impl. by\n(('note:拡張ライブラリーの実装方法'))
+
+  # RT
+
+  , Ext★, SWIG, FFI, GI☆
+
+  Base\nTech, Ext, Ext, lib\nffi, lib\nffi
+  Impl.\nby, ((*Hand*)), ((*Generate*)), Hand, Gene-rate
+
+(('note:★ Extension library（拡張ライブラリー）'))\n
+(('note:☆ GObject Introspection: Recommended（オススメ）'))
+
+= Ext impl. by: Target\n(('note:拡張ライブラリーの実装方法：対象'))
+
+  # coderay c
+  /* hello.h */
+  #pragma once
+  typedef struct hello_t Hello;
+  Hello      *hello_new    (void);
+  void        hello_free   (Hello *hello);
+  const char *hello_message(Hello *hello);
+
+= Ext impl. by hand\n(('note:手動での拡張ライブラリーの実装'))
+
+(('note:https://github.com/kou/rabbit-slide-kou-rubykaigi-2016/blob/master/c-api/bindings/hello.c'))
+
+  # coderay c
+  #include <ruby.h>
+
+  #include <hello.h>
+
+  static void
+  rb_hello_free(void *data)
+  {
+    Hello *hello = data;
+    hello_free(hello);
+  }
+
+  static const rb_data_type_t rb_hello_type = {
+    "Hello",
+    {
+      NULL,
+      rb_hello_free,
+      NULL,
+    },
+    NULL,
+    NULL,
+    RUBY_TYPED_FREE_IMMEDIATELY,
+  };
+
+  static VALUE
+  rb_hello_alloc(VALUE klass)
+  {
+    return TypedData_Wrap_Struct(klass, &rb_hello_type, NULL);
+  }
+
+  static VALUE
+  rb_hello_initialize(VALUE self)
+  {
+    Hello *hello;
+    hello = hello_new();
+    DATA_PTR(self) = hello;
+    return Qnil;
+  }
+
+  static VALUE
+  rb_hello_message(VALUE self)
+  {
+    Hello *hello;
+    const char *message;
+
+    TypedData_Get_Struct(self, Hello, &rb_hello_type, hello);
+    message = hello_message(hello);
+
+    return rb_str_new_cstr(message);
+  }
+
+  void
+  Init_hello(void)
+  {
+    VALUE hello;
+
+    hello = rb_define_class("Hello", rb_cData);
+    rb_define_alloc_func(hello, rb_hello_alloc);
+    rb_define_method(hello, "initialize", rb_hello_initialize, 0);
+    rb_define_method(hello, "message", rb_hello_message, 0);
+  }
+
+= Ext impl. by generation\n(('note:自動生成での拡張ライブラリーの実装'))
+
+  * (('wait'))SWIG can generate impl.\n
+    (('note:Simplified Wrapper and Interface Generator'))\n
+    (('note:SWIGで実装を生成できる'))
+  * (('wait'))An user
+    * TensorFlow: A library for machine intelligence\n
+      (('note:TensorFlow：機械知能のライブラリー'))\n
+      Uses to generate Python bindings\n
+      (('note:Pythonバインディングを生成するために使用'))
+
+= Ext impl. by SWIG\n(('note:SWIGでの拡張ライブラリーの実装'))
+
+  # coderay c
+  // swig -ruby hello.i -> hello_wrap.c
+  %module hello
+  %{
+  #include <hello.h>
+  %}
+  %include <hello.h>
+
+= Use ext by SWIG\n(('note:SWIGで作った拡張ライブラリーを使う'))
+
+  irb(main):001:0> require "hello"
+  => true
+  irb(main):002:0> hello = Hello.hello_new
+  => #<SWIG::TYPE_p_hello_t:0x000...>
+  irb(main):003:0> Hello.hello_message(hello)
+  => "Hello"
+  irb(main):004:0> Hello.hello_free(hello)
+  => nil
+  # Raw C API... :<
+
+= By SWIG again\n(('note:SWIGでもう一度'))
+
+  # coderay c
+  %module hello
+  %{#include <hello.h>%}
+  typedef struct hello_t {
+    %extend {
+      hello_t() {return hello_new();}
+      ~hello_t() {hello_free($self);}
+      const char *message() {return hello_message($self);}
+    }
+  } Hello;
+
+= Use again\n(('note:もう一度使う'))
+
+  irb(main):001:0> require "hello"
+  => true
+  irb(main):002:0> hello = Hello::Hello.new
+  => #<Hello::Hello:0x000...>
+  irb(main):003:0> hello.message
+  => "Hello"
+  # Object oriented API!
+
+= Wrap up1: Ext\n(('note:まとめ1：拡張ライブラリー'))
+
+  * (('wait'))By hand: Need many works\n
+    (('note:手動：たくさん書かないといけない'))
+  * (('wait'))By generation: Less works\n
+    (('note:生成：書くことが少ない'))
+    * Need more works for easy to use\n
+      (('note:使いやすいAPIにするにはたくさん書かないといけない'))
+
+= Wrap up2: Ext\n(('note:まとめ2：拡張ライブラリー'))
+
+  * On maintenance\n
+    e.g.: New functions\n
+    (('note:メンテナンス時：（例：新しい関数が追加された）'))
+    * (('wait'))By hand: Need more works\n
+      (('note:手動：追加作業あり'))
+    * (('wait'))By generation: No more works\n
+      (('note:生成：追加作業なし'))\n
+      This is a large benefit!\n
+      (('note:これは大きな利点！'))
+
+= libffi impl. by\n(('note:libffiベースでの実装方法'))
+
+  # RT
+
+  , Ext★, SWIG, FFI, GI☆
+
+  Base\nTech, Ext, Ext, lib\nffi, lib\nffi
+  Impl.\nby, Hand, Gene-rate, ((*Hand*)), ((*Generate*))
+
+(('note:★ Extension library（拡張ライブラリー）'))\n
+(('note:☆ GObject Introspection: Recommended（オススメ）'))
+
+= libffi impl. by hand\n(('note:手動でのlibffiベースの実装'))
+
+  # coderay ruby
+  require "ffi"
+
+  module LibHello
+    extend FFI::Library
+    ffi_lib "../../libhello/lib/libhello.so"
+    attach_function :hello_new, [], :pointer
+    attach_function :hello_message, [:pointer], :string
+    attach_function :hello_free, [:pointer], :void
+  end
+
+= Use libffi impl. by hand\n(('note:手動でのlibffiベースの実装を使う'))
+
+  irb(main):001:0> require "hello"
+  => true
+  irb(main):002:0> hello = LibHello.hello_new
+  => #<FFI::Pointer address=0x00000002b07ef0>
+  irb(main):003:0> LibHello.hello_message(hello)
+  => "Hello"
+  irb(main):004:0> LibHello.hello_free(hello)
+  => nil
+  # Raw C API... :<
+
+= Wrap FFI impl. 1\n(('note:FFIでの実装をラップ1'))
+
+  # coderay ruby
+  class Hello
+    def initialize
+      hello = LibHello.hello_new
+      hello_free = LibHello.method(:hello_free)
+      @hello =
+        FFI::AutoPointer.new(hello, hello_free)
+    end
+  end
+
+= Wrap FFI impl. 2\n(('note:FFIでの実装をラップ2'))
+
+  # coderay ruby
+  class Hello
+    def message
+      LibHello.hello_message(@hello)
+    endg
+  end
+
+= Use wrapped impl.\n(('note:ラップした実装を使う'))
+
+  irb(main):001:0> require "hello"
+  => true
+  irb(main):002:0> hello = Hello.new
+  => #<Hello:0x000...>
+  irb(main):003:0> hello.message
+  => "Hello"
+  # Object oriented API!
+
+= libffi impl. by generation\n(('note:自動生成でのlibffiベースの実装'))
+
+TODO