rinline 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc0964e6130a5e6bd8f80a5ada38a861082d5576b012c5557e90c07646942d76
+  data.tar.gz: c3a30e6a0c4c5de9c4e003abc2ace61c17a92cb375296de967ffff58e1acb308
+SHA512:
+  metadata.gz: 115a1a1f849277b1725e6c32555e9a85acc39a18dbcc5d7738a0825c3df0921f788dea8b1e34ccf3337d1add62aafe483c5178bd8c07ad1a4ad794b9b1809864
+  data.tar.gz: 5d00f2b9fccf4811176f91a4e3e96c7a966041c4bf0b4c2d719ee451944d0aa47c7525d035e3b116bd70509e99a3503f21c9cfc56e9b1c7f0a6b40b3cb12ba13

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rinline.gemspec
+gemspec

data/README.md

@@ -0,0 +1,44 @@
+# Rinline
+
+Inline expansion for Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rinline'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rinline
+
+## Usage
+
+Call `Rinline.optimize` after your program is loaded, but before your program is not ran yet.
+
+```ruby
+require 'your_program'
+require 'rinline'
+
+Rinline.optimize do |r|
+  r.optimize_namespace(YourProgram)
+end
+
+YourProgram.start
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pocke/rinline.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+task :default => :test
+
+Rake::TestTask.new do |test|
+  test.libs << 'test'
+  test.test_files = Dir['test/**/*_test.rb']
+  test.verbose = true
+end

data/benchmark/simple.rb

@@ -0,0 +1,36 @@
+# $ ruby benchmark/simple.rb
+#                            user     system      total        real
+# plain                  6.203292   0.000000   6.203292 (  6.206694)
+# optimized              3.623372   0.000000   3.623372 (  3.625261)
+
+require 'benchmark'
+
+class C
+  def plain
+    m + n
+  end
+
+  def optimized
+    m + n
+  end
+
+  def m
+    1
+  end
+
+  def n
+    2
+  end
+end
+
+require 'rinline'
+Rinline.optimize do |r|
+  r.optimize_instance_method(C, :optimized)
+end
+
+i = C.new
+
+Benchmark.bm(20) do |x|
+  x.report('plain')     { 100000000.times { i.plain } }
+  x.report('optimized') { 100000000.times { i.optimized } }
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rinline"
+
+# 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/lib/rinline.rb

@@ -0,0 +1,22 @@
+require 'securerandom'
+
+require_relative "./rinline/version"
+require_relative './rinline/ext/iseq_ext'
+require_relative './rinline/ext/ast_ext'
+require_relative './rinline/ext/method_ext'
+require_relative './rinline/optimizer'
+require_relative './rinline/location'
+require_relative './rinline/runner'
+
+module Rinline
+  extend self
+
+  def optimize(&block)
+    runner = Runner.new
+    Runner.current = runner
+    block.call runner
+    Runner.current = nil
+
+    $stderr.puts "[Rinline] Optimizing is finised" if runner.debug
+  end
+end

data/lib/rinline/ext/ast_ext.rb

@@ -0,0 +1,181 @@
+module Rinline
+  module Ext
+    module AstExt
+      refine RubyVM::AbstractSyntaxTree::Node do
+        def traverse(&block)
+          opt = {}
+          block.call self, opt
+
+          # workaround for modifiers
+          # TODO: Remove this workaround by refining offset
+          if ((type == :IF || type == :UNLESS) && children[2] == nil && children[1].before_than(children[0])) ||
+             ((type == :WHILE || type == :UNTIL) && children[1].before_than(children[0]))
+            children[1].traverse(&block)
+            children[0].traverse(&block)
+          else
+            self.children.each.with_index do |child, index|
+              next if opt[:ignore_index] == index
+              child.traverse(&block) if child.is_a?(RubyVM::AbstractSyntaxTree::Node)
+            end
+          end
+        end
+
+        def to_source(path)
+          file(path)[first_index(path)..last_index(path)]
+        end
+
+        def location(path)
+          Location.new(first_index(path), last_index(path))
+        end
+
+        def has_child?(*types)
+          traverse do |child|
+            return true if child.is_a?(RubyVM::AbstractSyntaxTree::Node) && types.include?(child.type)
+          end
+          return false
+        end
+
+        # var = 1
+        # ^^^
+        def location_variable_name_of_lasgn(path)
+          type! :LASGN
+          first_index = first_index(path)
+
+          Location.new(first_index, first_index + self.children[0].size - 1)
+        end
+
+        def method_body
+          type! :SCOPE
+          self.children[2]
+        end
+
+        def method_args
+          type! :SCOPE
+          self.children[1]
+        end
+
+        # Extensions for ARGS
+        def args_pre_num
+          type! :ARGS
+          self.children[0]
+        end
+
+        def args_pre_init
+          type! :ARGS
+          self.children[1]
+        end
+
+        def args_opt
+          type! :ARGS
+          self.children[2]
+        end
+
+        def args_first_post
+          type! :ARGS
+          self.children[3]
+        end
+
+        def args_post_num
+          type! :ARGS
+          self.children[4]
+        end
+
+        def args_post_init
+          type! :ARGS
+          self.children[5]
+        end
+
+        def args_rest
+          type! :ARGS
+          self.children[6]
+        end
+
+        def args_kw
+          type! :ARGS
+          self.children[7]
+        end
+
+        def args_kwrest
+          type! :ARGS
+          self.children[8]
+        end
+
+        def args_block
+          type! :ARGS
+          self.children[9]
+        end
+
+        def expandable_method?(parameter_size)
+          a = self.method_args
+          a.args_pre_num == parameter_size &&
+            a.args_pre_init == nil &&
+            a.args_opt == nil &&
+            a.args_first_post == nil &&
+            a.args_post_num == 0 &&
+            a.args_post_init == nil &&
+            a.args_rest == nil &&
+            a.args_kw == nil &&
+            a.args_kwrest == nil &&
+            a.args_block == nil
+        end
+
+        def array_size
+          type! :ARRAY
+          self.children.size - 1
+        end
+
+        def array_content
+          type! :ARRAY
+          self.children[0..-2]
+        end
+
+        def fcall_args
+          type! :FCALL
+          self.children[1]
+        end
+
+        def lasgn_opasgn?
+          type! :LASGN
+          right = children[1]
+          first_lineno == right.first_lineno &&
+            first_column == right.first_column
+        end
+
+        private def first_index(path)
+          return first_column if first_lineno == 1
+
+          lines = file(path).split("\n")
+          lines[0..(first_lineno - 2)].sum(&:size) +
+            first_lineno - 1 + # For \n
+            first_column
+        end
+
+        private def last_index(path)
+          last_column = self.last_column - 1
+          return last_column if last_lineno == 1
+
+          lines = file(path).split("\n")
+          lines[0..(last_lineno - 2)].sum(&:size) +
+            last_lineno - 1 + # For \n
+            last_column
+        end
+
+        private def type!(type)
+          raise "Unexpected type: #{self.type}" unless self.type == type
+        end
+
+        def before_than(right)
+          if self.first_lineno == right.first_lineno
+            self.first_column < right.first_column
+          else
+            self.first_lineno < right.first_lineno
+          end
+        end
+
+        private def file(path)
+          Runner.current.file_cache[path] ||= File.binread(path)
+        end
+      end
+    end
+  end
+end

data/lib/rinline/ext/iseq_ext.rb

@@ -0,0 +1,11 @@
+module Rinline
+  module Ext
+    module IseqExt
+      refine RubyVM::InstructionSequence do
+        def short?
+          self.to_a[13].size < Runner.current.iseq_threshold
+        end
+      end
+    end
+  end
+end

data/lib/rinline/ext/method_ext.rb

@@ -0,0 +1,40 @@
+module Rinline
+  module Ext
+    module MethodExt
+      refine UnboundMethod do
+        using IseqExt
+        using AstExt
+
+        def to_ast
+          RubyVM::AbstractSyntaxTree.of(self)
+        end
+
+        def to_iseq
+          RubyVM::InstructionSequence.of(self)
+        end
+
+        def expandable?
+          ruby_method? &&
+            to_iseq&.short? &&
+            !eval? &&
+            !to_ast.has_child?(:SUPER, :ZSUPER, :RETURN, :CONST) &&
+            # HACK: RubyVM::AST omits `return` from tree if it is meaningless.
+            # So checking AST is not enough.
+            !to_ast.to_source(absolute_path).match?(/\breturn\b/)
+        end
+
+        def ruby_method?
+          !!source_location
+        end
+
+        def eval?
+          absolute_path == '(eval)'
+        end
+
+        def absolute_path
+          source_location[0]
+        end
+      end
+    end
+  end
+end

data/lib/rinline/location.rb

@@ -0,0 +1,14 @@
+module Rinline
+  class Location
+    def initialize(first_index, last_index)
+      @first_index = first_index
+      @last_index = last_index
+    end
+
+    attr_reader :first_index, :last_index
+
+    def size
+      last_index - first_index + 1
+    end
+  end
+end

data/lib/rinline/optimizer.rb

@@ -0,0 +1,155 @@
+module Rinline
+  class Optimizer
+    using Ext::MethodExt
+    using Ext::AstExt
+    using Ext::IseqExt
+
+    # @param klass [Class]
+    # @param method_name [Symbol] an instance method name
+    # @return [String,nil] optimized code if optimized
+    def self.optimize(klass, method_name)
+      self.new(klass, method_name).optimize
+    end
+
+    def initialize(klass, method_name)
+      @klass = klass
+      @method_name = method_name
+      @method = klass.instance_method(method_name)
+    end
+
+    def optimize
+      return unless method.ruby_method?
+      return if method.eval?
+      ast = method.to_ast
+      return unless ast
+      return if ast.has_child?(:CONST)
+      path = method.absolute_path
+      replacements = []
+
+      ast.traverse do |node, opt|
+        case node.type
+        when :VCALL
+          target_method_name = node.children[0]
+          next if method_name == target_method_name
+          target_method =
+            begin
+              klass.instance_method(target_method_name)
+            rescue NameError
+              next
+            end
+          next unless target_method.expandable?
+
+          to_ast = target_method.to_ast
+          next unless to_ast.expandable_method?(0)
+
+          to_path = target_method.absolute_path
+          body = to_ast.method_body
+          to_code =
+            if body
+              "((#{replace_lvar(body, to_path)}))"
+            else
+              "()"
+            end
+          replacements << {
+            from: node.location(path),
+            to: to_code,
+          }
+        when :FCALL
+          target_method_name = node.children[0]
+          next if method_name == target_method_name
+          target_method =
+            begin
+              klass.instance_method(target_method_name)
+            rescue NameError
+              next
+            end
+          next unless target_method.expandable?
+
+          to_ast = target_method.to_ast
+          args = node.fcall_args
+          next unless args&.type == :ARRAY
+          next unless to_ast.expandable_method?(args.array_size)
+
+          to_path = target_method.absolute_path
+          lvar_suffix = gen_lvar_suffix
+
+          args = assign_args(to_ast, node, path, lvar_suffix)
+          body =
+            if to_ast.method_body
+              replace_lvar(to_ast.method_body, to_path, lvar_suffix: lvar_suffix)
+            else
+              "()"
+            end
+          to_code = "((#{args}#{body}))"
+          replacements << {
+            from: node.location(path),
+            to: to_code
+          }
+          opt[:ignore_index] = 1 # Ignore arguments
+        end
+      end
+
+      return if replacements.empty?
+      return replace(ast, path, replacements).force_encoding(Encoding::UTF_8) # TODO: Support other encodings
+    end
+
+    attr_reader :klass, :method_name, :method
+    private :klass, :method_name, :method
+
+    # @param original_method [Method]
+    # @param replacements [Array<{from: Rinline::Location, to: String}>]
+    private def replace(original_ast, original_path, replacements)
+      ret = original_ast.to_source(original_path)
+      offset = -original_ast.location(original_path).first_index
+
+      replacements.each do |replacement|
+        from = replacement[:from]
+        to_code = replacement[:to]
+
+        ret[(from.first_index + offset)..(from.last_index + offset)] = to_code
+        offset += to_code.size - from.size
+      end
+
+      ret
+    end
+
+    private def replace_lvar(ast, path, lvar_suffix: gen_lvar_suffix)
+      replacements = []
+
+      ast.traverse do |node, opt|
+        case node.type
+        when :LASGN
+          next if node.lasgn_opasgn?
+
+          replacements << {
+            from: node.location_variable_name_of_lasgn(path),
+            to: "#{node.children[0]}#{lvar_suffix}",
+          }
+        when :LVAR
+          replacements << {
+            from: node.location(path),
+            to: "#{node.children[0]}#{lvar_suffix}"
+          }
+        when :OP_ASGN_OR
+          opt[:ignore_index] = 0
+        when :OP_ASGN_AND
+          opt[:ignore_index] = 0
+        end
+      end
+
+      replace(ast, path, replacements)
+    end
+
+    private def assign_args(method_node, fcall_node, fcall_path, lvar_suffix)
+      params = method_node.children[0]
+      args = fcall_node.fcall_args.array_content
+      args.map.with_index do |arg, index|
+        "#{params[index]}#{lvar_suffix} = #{arg.to_source(fcall_path)}"
+      end.join(';') + ';'
+    end
+
+    private def gen_lvar_suffix
+      "__#{SecureRandom.hex(5)}"
+    end
+  end
+end

data/lib/rinline/runner.rb

@@ -0,0 +1,57 @@
+module Rinline
+  class Runner
+    class << self
+      attr_accessor :current
+    end
+
+    attr_accessor :debug, :iseq_threshold
+    attr_reader :file_cache
+
+    def initialize
+      @debug = false
+      @iseq_threshold = 50
+      @file_cache = {}
+    end
+
+    def optimize_instance_method(klass, method_name)
+      debug_print "optimizing: #{klass}##{method_name}"
+      optimized = Optimizer.optimize(klass, method_name)
+      unless optimized
+        debug_print "skipped: #{klass}##{method_name}"
+        return
+      end
+
+      klass.class_eval "undef :#{method_name}; #{optimized}"
+      debug_print "optimized: #{klass}##{method_name}"
+    end
+
+    def optimize_instance_methods(klass)
+      klass.instance_methods(false).each do |method|
+        optimize_instance_method(klass, method)
+      end
+    end
+
+    def optimize_class(klass)
+      debug_print "class: #{klass}"
+      optimize_instance_methods(klass)
+      optimize_instance_methods(klass.singleton_class)
+    end
+
+    alias optimize_module optimize_class
+
+    def optimize_namespace(mod)
+      debug_print "namespace: #{mod}"
+      optimize_module(mod)
+      constants = mod.constants
+      constants -= Struct.constants if mod < Struct
+      constants.each do |child|
+        child = mod.const_get(child)
+        optimize_namespace(child) if child.is_a?(Module)
+      end
+    end
+
+    def debug_print(*msg)
+      $stderr.puts(*msg) if debug
+    end
+  end
+end

data/lib/rinline/version.rb

@@ -0,0 +1,3 @@
+module Rinline
+  VERSION = "0.1.0"
+end

data/rinline.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rinline/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rinline"
+  spec.version       = Rinline::VERSION
+  spec.authors       = ["Masataka Pocke Kuwabara"]
+  spec.email         = ["kuwabara@pocke.me"]
+
+  spec.summary       = %q{Inline expansion for Ruby}
+  spec.description   = %q{Inline expansion for Ruby}
+  spec.homepage      = "https://github.com/pocke/rinline"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", ">= 2"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency 'minitest', '>= 5'
+  spec.add_development_dependency 'rr'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: rinline
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masataka Pocke Kuwabara
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Inline expansion for Ruby
+email:
+- kuwabara@pocke.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- benchmark/simple.rb
+- bin/console
+- bin/setup
+- lib/rinline.rb
+- lib/rinline/ext/ast_ext.rb
+- lib/rinline/ext/iseq_ext.rb
+- lib/rinline/ext/method_ext.rb
+- lib/rinline/location.rb
+- lib/rinline/optimizer.rb
+- lib/rinline/runner.rb
+- lib/rinline/version.rb
+- rinline.gemspec
+homepage: https://github.com/pocke/rinline
+licenses: []
+metadata:
+  homepage_uri: https://github.com/pocke/rinline
+  source_code_uri: https://github.com/pocke/rinline
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Inline expansion for Ruby
+test_files: []