mrubyudf 0.1.0

data/README.md

@@ -0,0 +1,153 @@
+# mrubyudf
+
+これは mruby で MySQL のユーザー定義関数(UDF)を簡単に作成するためのツールです。
+
+## インストール
+
+```sh
+% gem install mrubyudf
+```
+
+## 準備
+
+mysql_config コマンドと MySQL のヘッダファイルが必要です。
+
+mysql-8.0.20-linux-glibc2.12-x86_64.tar.xz みたいなファイルを展開した中には入ってるはずです。
+
+それ以外の場合は MySQL 開発環境のインストールが必要になるかも知れません。
+Ubuntu の場合は libmysqlclient-dev パッケージをインストールすればいいと思います。
+
+## 使い方
+
+
+まず mruby をインストールする必要があります。mruby を動的リンクにするためのパッチをあてて make します。
+
+```sh
+% git clone git@github.com:mruby/mruby.git
+% cd mruby
+% patch -p1 < $GEM_HOME/gems/mrubyudf-0.*/misc/mruby-shared.patch
+% make
+```
+
+うまくいかない場合は頑張ってください。
+
+この mruby ディレクトリを MRUBY_PATH 環境変数に設定しておきます。
+
+```sh
+% export MRUBY_PATH=/path/to/mruby
+```
+
+関数本体を作ります。ここではフィボナッチ数を返す fib() 関数を fib.rb ファイルとして作ります。
+
+```ruby
+LONG_LONG_MAX = 9223372036854775807
+
+def fib(n)
+  b = 1
+  c = 0
+  n.times do
+    a, b = b, c
+    c = a + b
+    raise 'Overflow' if c > LONG_LONG_MAX
+  end
+  c
+end
+```
+
+mruby で実行して動きを確かめます。
+
+```sh
+% $MRUBY_PATH/bin/mruby -r ./fib.rb -e 'p fib(10)'
+55
+% $MRUBY_PATH/bin/mruby -r ./fib.rb -e 'p fib(92)'
+7540113804746346429
+% $MRUBY_PATH/bin/mruby -r ./fib.rb -e 'p fib(93)'
+trace (most recent call last):
+        [2] -e:1
+        [1] -e:6:in fib
+-e:9:in fib: Overflow (RuntimeError)
+```
+
+関数名、戻り値の型、引数の型等の情報を fib.spec ファイルで次のような感じで作ります。
+
+```ruby
+MrubyUdf.function do |f|
+  f.name = 'fib'           # 関数名は fib
+  f.return_type = Integer  # 戻り値は Integer
+  f.arguments = [          # 引数は一つで型は Integer
+    Integer
+  ]
+end
+```
+
+コンパイル。
+
+```sh
+% mrubyudf fib.spec
+```
+
+うまくいけば fib.so ファイルができます。
+
+これを MySQL のプラグインディレクトリにコピーします。
+
+```sh
+% mysql_config --plugindir
+/usr/local/mysql/lib/plugin
+% sudo cp fib.so /usr/local/mysql/lib/plugin/
+```
+
+MySQL に組み込みます。一度やっておけば mysqld を再起動しても自動的に組み込まれます。
+
+```sql
+% mysql -uroot
+mysql> create function fib returns int soname 'fib.so';
+```
+
+使ってみます。
+
+```sql
+mysql> select fib(10);
++---------+
+| fib(10) |
++---------+
+|      55 |
++---------+
+1 row in set (0.04 sec)
+
+mysql> select fib(92);
++---------------------+
+| fib(92)             |
++---------------------+
+| 7540113804746346429 |
++---------------------+
+1 row in set (0.04 sec)
+
+mysql> select fib(93);
++---------+
+| fib(93) |
++---------+
+|    NULL |
++---------+
+1 row in set (0.04 sec)
+```
+
+関数が要らなくなったら破棄します。
+
+```sql
+mysql> drop function fib;
+```
+
+drop しないで so ファイルを更新したりすると、mysqld が落ちるので注意。
+
+example 配下にテキトーなサンプルがいくつかあります。
+
+
+## ライセンス
+
+このツール自体は GPL 3 です。
+
+このツールによって作られた so ファイルは、このツールのライセンスとは無関係です。
+
+## 作者
+
+とみたまさひろ <https://twitter.com/tmtms>

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mrubyudf"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example/circumference.rb

@@ -0,0 +1,3 @@
+def circumference(r)
+  2 * Math::PI * r
+end

data/example/circumference.spec

@@ -0,0 +1,8 @@
+#!ruby
+MrubyUdf.function do |f|
+  f.name = 'circumference'
+  f.return_type = Float
+  f.arguments = [
+    Float
+  ]
+end

data/example/fib.rb

@@ -0,0 +1,12 @@
+LONG_LONG_MAX = 9223372036854775807
+
+def fib(n)
+  b = 1
+  c = 0
+  n.times do
+    a, b = b, c
+    c = a + b
+    raise 'Overflow' if c > LONG_LONG_MAX
+  end
+  c
+end

data/example/fib.spec

@@ -0,0 +1,8 @@
+#!ruby
+MrubyUdf.function do |f|
+  f.name = 'fib'
+  f.return_type = Integer
+  f.arguments = [
+    Integer
+  ]
+end

data/example/repeat_str.rb

@@ -0,0 +1,3 @@
+def repeat_str(str, n)
+  str * n
+end

data/example/repeat_str.spec

@@ -0,0 +1,9 @@
+#!ruby
+MrubyUdf.function do |f|
+  f.name = 'repeat_str'
+  f.return_type = String
+  f.arguments = [
+    String,
+    Integer,
+  ]
+end

data/example/rownum.rb

@@ -0,0 +1,4 @@
+$n = 0
+def rownum()
+  $n += 1
+end

data/example/rownum.spec

@@ -0,0 +1,6 @@
+#!ruby
+MrubyUdf.function do |f|
+  f.name = 'rownum'
+  f.return_type = Integer
+  f.arguments = []
+end

data/example/swapcase.rb

@@ -0,0 +1,3 @@
+def swapcase(s)
+  s.swapcase
+end

data/example/swapcase.spec

@@ -0,0 +1,8 @@
+#!ruby
+MrubyUdf.function do |f|
+  f.name = 'swapcase'
+  f.return_type = String
+  f.arguments = [
+    String
+  ]
+end

data/exe/mrubyudf

@@ -0,0 +1,4 @@
+#!/usr/bin/ruby
+require 'mrubyudf'
+
+MrubyUdf::Command.run

data/lib/mrubyudf.rb

@@ -0,0 +1,15 @@
+require_relative 'mrubyudf/version'
+require_relative 'mrubyudf/function'
+require_relative 'mrubyudf/template'
+require_relative 'mrubyudf/command'
+
+class MrubyUdf
+  class << self
+    def function(&block)
+      return @function unless block
+      f = MrubyUdf::Function.new
+      block.call f
+      @function = f
+    end
+  end
+end

data/lib/mrubyudf/command.rb

@@ -0,0 +1,53 @@
+class MrubyUdf
+  class Command
+    def self.run
+      self.new.run
+    end
+
+    def run
+      parse_args(ARGV)
+      load @spec
+      Dir.chdir(File.dirname(@spec)) do
+        compile
+      end
+    end
+
+    def parse_args(args)
+      raise "Usage: #$0 foo.spec" if args.size != 1
+      @spec = args.first
+    end
+
+    def compile
+      f = MrubyUdf.function
+      c = MrubyUdf::Template.new(f).result
+      File.write("#{f.name}_udf.c", c)
+      mruby_path = ENV['MRUBY_PATH'] || search_mruby_path
+      mrbc = [mruby_path, 'bin/mrbc'].join('/')
+      cc = ENV['CC'] || 'gcc'
+      cflags = ENV['CFLAGS'] || '-shared -fPIC'
+      cflags += " -I #{mruby_path}/include #{mysql_include}"
+      mruby_libpath = "#{mruby_path}/build/host/lib"
+      libflags = "-L#{mruby_libpath} -Wl,--rpath,#{mruby_libpath}"
+      exec_command "#{mrbc} -B #{f.name}_mrb #{f.name}.rb"
+      exec_command "#{cc} #{cflags} #{f.name}_udf.c #{f.name}.c #{libflags} -lmruby -lm -o #{f.name}.so"
+    end
+
+    def exec_command(str)
+      puts str
+      stdout = %x(#{str})
+      raise 'failed' unless $?.success?
+      stdout.chomp
+    end
+
+    def search_mruby_path
+      ENV['PATH'].split(/:/).each do |path|
+        return File.dirname(path) if File.executable? "#{path}/mrbc"
+      end
+      raise "command not found: mrbc"
+    end
+
+    def mysql_include
+      exec_command 'mysql_config --include'
+    end
+  end
+end

data/lib/mrubyudf/function.rb

@@ -0,0 +1,70 @@
+class MrubyUdf
+  class Function
+    attr_accessor :name
+    attr_accessor :return_type
+    attr_accessor :arguments
+
+    def initialize
+      @name = nil
+      @return_type = Integer
+      @arguments = []
+    end
+
+    def mysql_type(arg)
+      case
+      when arg == Integer
+        "INT_RESULT"
+      when arg == Float
+        "REAL_RESULT"
+      when arg == String
+        "STRING_RESULT"
+      else
+        raise "invalid type: #{arg}"
+      end
+    end
+
+    def arg_mysql_to_mruby
+      arguments.map.with_index do |arg, i|
+        case
+        when arg == Integer
+          "mrb_fixnum_value(*((long long *)args->args[#{i}]))"
+        when arg == Float
+          "mrb_float_value(mrb, *((double *)args->args[#{i}]))"
+        when arg == String
+          "mrb_str_new_cstr(mrb, (char *)args->args[#{i}])"
+        end
+      end.join(", ")
+    end
+
+    def return_ctype
+      case
+      when return_type == Integer
+        "long long"
+      when return_type == Float
+        "double"
+      when return_type == String
+        "char *"
+      else
+        raise "invalid return type: #{return_type}"
+      end
+    end
+
+
+    def return_mruby_to_mysql
+      case
+      when return_type == Integer
+        "mrb_fixnum(ret)"
+      when return_type == Float
+        "mrb_float(ret)"
+      when return_type == String
+        "RSTRING_PTR(ret)"
+      else
+        raise "invalid return type: #{return_type}"
+      end
+    end
+
+    def context
+      binding
+    end
+  end
+end

data/lib/mrubyudf/template.erb

@@ -0,0 +1,70 @@
+#include <stdio.h>
+#include <string.h>
+#include "mruby.h"
+#include "mruby/string.h"
+#include "mruby/irep.h"
+#include "mysql.h"
+
+extern const uint8_t <%= name %>_mrb[];
+
+bool <%= name %>_init(UDF_INIT *initid, UDF_ARGS *args, char *message)
+{
+  if (args->arg_count != <%= arguments.size %>) {
+    strcpy(message, "<%= name %>() requires <%= arguments.size %> argument(s)");
+    return true;
+  }
+<% arguments.each_with_index do |arg, i| %>
+  args->arg_type[<%= i %>] = <%= mysql_type arg %>;
+<% end %>
+  mrb_state *mrb = mrb_open();
+  if (!mrb) {
+    strcpy(message, "mrb_open() error");
+    return true;
+  }
+  initid->ptr = (void *)mrb;
+  mrb_load_irep(mrb, <%= name %>_mrb);
+  if (mrb->exc) {
+    mrb_value s = mrb_funcall(mrb, mrb_obj_value(mrb->exc), "inspect", 0);
+    const char *cs = mrb_string_value_cstr(mrb, &s);
+    strncpy(message, cs, MYSQL_ERRMSG_SIZE);
+    fprintf(stderr, "%s\n", cs);
+    return true;
+  }
+  return false;
+}
+
+void <%= name %>_deinit(UDF_INIT *initid)
+{
+  mrb_state *mrb = (mrb_state *)initid->ptr;
+  if (mrb) {
+    mrb_close(mrb);
+  }
+}
+
+<%= return_ctype %> <%= name %>(UDF_INIT *initid, UDF_ARGS *args,
+<% if return_type == String %>
+  char *result, unsigned long *length,
+<% end %>
+  char *is_null, char *error)
+{
+  mrb_state *mrb = (mrb_state *)initid->ptr;
+  mrb_value ret = mrb_funcall(mrb, mrb_top_self(mrb), "<%= name %>", <%= arguments.size %>
+<% if arguments.size > 0 %>
+  , <%= arg_mysql_to_mruby %>
+<% end %>
+  );
+  if (mrb->exc) {
+    mrb_value s = mrb_funcall(mrb, mrb_obj_value(mrb->exc), "inspect", 0);
+    fprintf(stderr, "<%= name %>: %s\n", mrb_string_value_cstr(mrb, &s));
+    *is_null = true;
+    return 0;
+  }
+  if (mrb_nil_p(ret)) {
+    *is_null = true;
+    return 0;
+  }
+<% if return_type == String %>
+  *length = RSTRING_LEN(ret);
+<% end %>
+  return <%= return_mruby_to_mysql %>;
+}