summaryrefslogtreecommitdiff
path: root/benchmark/lib/benchmark_driver/runner/mjit_exec.rb
blob: 46e662bc7c6c626404741dfec5dfae1686790852 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
require 'benchmark_driver/struct'
require 'benchmark_driver/metric'
require 'erb'

# A special runner dedicated for measuring mjit_exec overhead.
class BenchmarkDriver::Runner::MjitExec
  METRIC = BenchmarkDriver::Metric.new(name: 'Iteration per second', unit: 'i/s')

  # JobParser returns this, `BenchmarkDriver::Runner.runner_for` searches "*::Job"
  Job = ::BenchmarkDriver::Struct.new(
    :name,        # @param [String] name - This is mandatory for all runner
    :metrics,     # @param [Array<BenchmarkDriver::Metric>]
    :num_methods, # @param [Integer] num_methods - The number of methods to be defined
    :loop_count,  # @param [Integer] loop_count
    :from_jit,    # @param [TrueClass,FalseClass] from_jit - Whether the mjit_exec() is from JIT or not
    :to_jit,      # @param [TrueClass,FalseClass] to_jit - Whether the mjit_exec() is to JIT or not
  )
  # Dynamically fetched and used by `BenchmarkDriver::JobParser.parse`
  class << JobParser = Module.new
    # @param [Array,String] num_methods
    # @param [Integer] loop_count
    # @param [TrueClass,FalseClass] from_jit
    # @param [TrueClass,FalseClass] to_jit
    def parse(num_methods:, loop_count:, from_jit:, to_jit:)
      if num_methods.is_a?(String)
        num_methods = eval(num_methods)
      end

      num_methods.map do |num|
        if num_methods.size > 1
          suffix = "[#{'%4d' % num}]"
        else
          suffix = "_#{num}"
        end
        Job.new(
          name: "mjit_exec_#{from_jit ? 'JT' : 'VM'}2#{to_jit ? 'JT' : 'VM'}#{suffix}",
          metrics: [METRIC],
          num_methods: num,
          loop_count: loop_count,
          from_jit: from_jit,
          to_jit: to_jit,
        )
      end
    end
  end

  # @param [BenchmarkDriver::Config::RunnerConfig] config
  # @param [BenchmarkDriver::Output] output
  # @param [BenchmarkDriver::Context] contexts
  def initialize(config:, output:, contexts:)
    @config = config
    @output = output
    @contexts = contexts
  end

  # This method is dynamically called by `BenchmarkDriver::JobRunner.run`
  # @param [Array<BenchmarkDriver::Runner::Peak::Job>] jobs
  def run(jobs)
    @output.with_benchmark do
      jobs.each do |job|
        @output.with_job(name: job.name) do
          @contexts.each do |context|
            result = BenchmarkDriver::Repeater.with_repeat(config: @config, larger_better: true, rest_on_average: :average) do
              run_benchmark(job, context: context)
            end
            value, duration = result.value
            @output.with_context(name: context.name, executable: context.executable, gems: context.gems, prelude: context.prelude) do
              @output.report(values: { METRIC => value }, duration: duration, loop_count: job.loop_count)
            end
          end
        end
      end
    end
  end

  private

  # @param [BenchmarkDriver::Runner::Ips::Job] job - loop_count is not nil
  # @param [BenchmarkDriver::Context] context
  # @return [BenchmarkDriver::Metrics]
  def run_benchmark(job, context:)
    if job.from_jit
      if job.to_jit
        benchmark = BenchmarkJT2JT.new(num_methods: job.num_methods, loop_count: job.loop_count)
      else
        raise NotImplementedError, "JT2VM is not implemented yet"
      end
    else
      if job.to_jit
        benchmark = BenchmarkVM2JT.new(num_methods: job.num_methods, loop_count: job.loop_count)
      else
        benchmark = BenchmarkVM2VM.new(num_methods: job.num_methods, loop_count: job.loop_count)
      end
    end

    duration = Tempfile.open(['benchmark_driver-result', '.txt']) do |f|
      with_script(benchmark.render(result: f.path)) do |path|
        opt = []
        if context.executable.command.any? { |c| c.start_with?('--jit') }
          opt << '--jit-min-calls=2'
        end
        IO.popen([*context.executable.command, '--disable-gems', *opt, path], &:read)
        if $?.success?
          Float(f.read)
        else
          BenchmarkDriver::Result::ERROR
        end
      end
    end

    [job.loop_count.to_f / duration, duration]
  end

  def with_script(script)
    if @config.verbose >= 2
      sep = '-' * 30
      $stdout.puts "\n\n#{sep}[Script begin]#{sep}\n#{script}#{sep}[Script end]#{sep}\n\n"
    end

    Tempfile.open(['benchmark_driver-', '.rb']) do |f|
      f.puts script
      f.close
      return yield(f.path)
    end
  end

  # @param [Integer] num_methods
  # @param [Integer] loop_count
  BenchmarkVM2VM = ::BenchmarkDriver::Struct.new(:num_methods, :loop_count) do
    # @param [String] result - A file to write result
    def render(result:)
      ERB.new(<<~EOS, trim_mode: '%').result(binding)
        % num_methods.times do |i|
        def a<%= i %>
          nil
        end
        % end
        RubyVM::JIT.pause if defined?(RubyVM::JIT) && RubyVM::JIT.enabled?

        def vm
          t = Process.clock_gettime(Process::CLOCK_MONOTONIC)
          i = 0
          while i < <%= loop_count / 1000 %>
        % 1000.times do |i|
            a<%= i % num_methods %>
        % end
            i += 1
          end
        % (loop_count % 1000).times do |i|
          a<%= i % num_methods %>
        % end
          Process.clock_gettime(Process::CLOCK_MONOTONIC) - t
        end

        vm # warmup call cache
        File.write(<%= result.dump %>, vm)
      EOS
    end
  end
  private_constant :BenchmarkVM2VM

  # @param [Integer] num_methods
  # @param [Integer] loop_count
  BenchmarkVM2JT = ::BenchmarkDriver::Struct.new(:num_methods, :loop_count) do
    # @param [String] result - A file to write result
    def render(result:)
      ERB.new(<<~EOS, trim_mode: '%').result(binding)
        % num_methods.times do |i|
        def a<%= i %>
          nil
        end
        a<%= i %>
        a<%= i %> # --jit-min-calls=2
        % end
        RubyVM::JIT.pause if defined?(RubyVM::JIT) && RubyVM::JIT.enabled?

        def vm
          t = Process.clock_gettime(Process::CLOCK_MONOTONIC)
          i = 0
          while i < <%= loop_count / 1000 %>
        % 1000.times do |i|
            a<%= i % num_methods %>
        % end
            i += 1
          end
        % (loop_count % 1000).times do |i|
          a<%= i % num_methods %>
        % end
          Process.clock_gettime(Process::CLOCK_MONOTONIC) - t
        end

        vm # warmup call cache
        File.write(<%= result.dump %>, vm)
      EOS
    end
  end
  private_constant :BenchmarkVM2JT

  # @param [Integer] num_methods
  # @param [Integer] loop_count
  BenchmarkJT2JT = ::BenchmarkDriver::Struct.new(:num_methods, :loop_count) do
    # @param [String] result - A file to write result
    def render(result:)
      ERB.new(<<~EOS, trim_mode: '%').result(binding)
        % num_methods.times do |i|
        def a<%= i %>
          nil
        end
        % end

        # You may need to:
        #   * Increase `JIT_ISEQ_SIZE_THRESHOLD` to 10000000 in mjit.h
        #   * Always return false in `inlinable_iseq_p()` of mjit_compile.c
        def jit
          t = Process.clock_gettime(Process::CLOCK_MONOTONIC)
          i = 0
          while i < <%= loop_count / 1000 %>
        % 1000.times do |i|
            a<%= i % num_methods %>
        % end
            i += 1
          end
        % (loop_count % 1000).times do |i|
          a<%= i % num_methods %>
        % end
          Process.clock_gettime(Process::CLOCK_MONOTONIC) - t
        end

        jit
        jit
        RubyVM::JIT.pause if defined?(RubyVM::JIT) && RubyVM::JIT.enabled?
        File.write(<%= result.dump %>, jit)
      EOS
    end
  end
  private_constant :BenchmarkJT2JT
end