File: benchmark_branch

package info (click to toggle)
ruby-dalli 5.0.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 992 kB
  • sloc: ruby: 9,447; sh: 19; makefile: 4
file content (300 lines) | stat: -rwxr-xr-x 9,550 bytes parent folder | download
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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
#!/usr/bin/env ruby
# frozen_string_literal: true

# Compare dalli performance between the current working tree and a base branch
# (default: main) within the SAME repo. Uses git stash to switch between versions.
#
# This script:
#   1. Stashes uncommitted changes
#   2. Benchmarks the base branch code (baseline)
#   3. Restores stashed changes
#   4. Benchmarks the current code (with changes)
#   5. Prints comparison
#
# Requirements:
#   - memcached running (set BENCH_CACHE_URL if not on localhost:11211)
#   - benchmark-ips gem installed (or in Gemfile)
#   - Uncommitted or staged changes to compare against base branch
#
# Usage:
#   bundle exec ruby bin/benchmark_branch
#
#   # Only benchmark get_multi:
#   BENCH_TARGET=get_multi bundle exec ruby bin/benchmark_branch
#
#   # Compare against a different base branch:
#   BENCH_BASE=develop bundle exec ruby bin/benchmark_branch
#
# Environment variables:
#   BENCH_BASE          - base branch to compare against (default: main)
#   BENCH_TARGET        - all, get, get_multi, set, set_multi (default: get_multi)
#   BENCH_TIME          - seconds per benchmark run (default: 10)
#   BENCH_WARMUP        - seconds warmup (default: 3)
#   BENCH_PAYLOAD_SIZE  - value size in bytes (default: 100)
#   BENCH_MULTI_COUNTS  - comma-separated multi key counts (default: 10,100,500)
#   BENCH_CACHE_URL     - memcached url (default: 127.0.0.1:11211)
#   BENCH_SAVE_FILE     - path for save! results file (default: /tmp/dalli_bench_branch)

require 'benchmark/ips'
require 'fileutils'

# ---------------------------------------------------------------------------
# Config
# ---------------------------------------------------------------------------
base_branch      = ENV.fetch('BENCH_BASE', 'main')
bench_target     = ENV.fetch('BENCH_TARGET', 'get_multi')
bench_time       = Integer(ENV.fetch('BENCH_TIME', '10'))
bench_warmup     = Integer(ENV.fetch('BENCH_WARMUP', '3'))
payload_size     = Integer(ENV.fetch('BENCH_PAYLOAD_SIZE', '100'))
multi_counts     = ENV.fetch('BENCH_MULTI_COUNTS', '10,100,500').split(',').map { |s| Integer(s) }
dalli_url        = ENV.fetch('BENCH_CACHE_URL', '127.0.0.1:11211')
save_file        = ENV.fetch('BENCH_SAVE_FILE', '/tmp/dalli_bench_branch')

# ---------------------------------------------------------------------------
# Helper: run benchmarks with the currently-loaded dalli code
# ---------------------------------------------------------------------------
def run_benchmarks(label:, client:, bench_target:, bench_time:, bench_warmup:,
                   suite:, payload_size:, multi_pairs:, multi_counts:, save_file:)
  if %w[all get].include?(bench_target)
    puts '-' * 70
    puts "Single GET (raw, #{payload_size}B payload)"
    puts '-' * 70
    Benchmark.ips do |x|
      x.config(warmup: bench_warmup, time: bench_time, suite: suite)
      x.report("#{label} get") { client.get('bench_key') }
      x.save! save_file
      x.compare!
    end
    puts
  end

  if %w[all get_multi].include?(bench_target)
    multi_counts.each do |count|
      puts '-' * 70
      puts "get_multi (#{count} keys, #{payload_size}B values)"
      puts '-' * 70
      keys = multi_pairs[count].keys
      Benchmark.ips do |x|
        x.config(warmup: bench_warmup, time: bench_time, suite: suite)
        x.report("#{label} get_multi(#{count})") { client.get_multi(*keys) }
        x.save! save_file
        x.compare!
      end
      puts
    end
  end

  if %w[all set].include?(bench_target)
    puts '-' * 70
    puts "Single SET (raw, #{payload_size}B payload)"
    puts '-' * 70
    Benchmark.ips do |x|
      x.config(warmup: bench_warmup, time: bench_time, suite: suite)
      x.report("#{label} set") { client.set('bench_key', 'x' * payload_size) }
      x.save! save_file
      x.compare!
    end
    puts
  end

  return unless %w[all set_multi].include?(bench_target)

  pairs = multi_pairs[100] || multi_pairs[multi_counts.first]
  count = pairs.size
  puts '-' * 70
  puts "set_multi (#{count} keys, #{payload_size}B values)"
  puts '-' * 70
  Benchmark.ips do |x|
    x.config(warmup: bench_warmup, time: bench_time, suite: suite)
    x.report("#{label} set_multi(#{count})") { client.set_multi(pairs, 3600) }
    x.save! save_file
    x.compare!
  end
  puts
end

# ---------------------------------------------------------------------------
# NoopSerializer - avoids Marshal overhead so we measure Dalli, not Marshal
# ---------------------------------------------------------------------------
class NoopSerializer
  def self.dump(value)
    value
  end

  def self.load(value)
    value
  end
end

# ---------------------------------------------------------------------------
# GCSuite - disable GC during benchmarks for consistent results
# ---------------------------------------------------------------------------
class GCSuite
  def warming(*)
    run_gc
  end

  def running(*)
    run_gc
  end

  def warmup_stats(*)
    GC.enable
  end

  def add_report(*)
    GC.enable
  end

  private

  def run_gc
    GC.enable
    GC.start
    GC.disable
  end
end

# ---------------------------------------------------------------------------
# Main
# ---------------------------------------------------------------------------

# Clean previous results
FileUtils.rm_f(save_file)

current_branch = `git rev-parse --abbrev-ref HEAD`.strip
current_sha    = `git rev-parse --short HEAD`.strip
has_changes    = !system('git diff --quiet HEAD')

puts '=' * 70
puts 'Dalli Branch Benchmark'
puts '=' * 70
puts "ruby:           #{RUBY_DESCRIPTION}"
yjit = defined?(RubyVM::YJIT) && RubyVM::YJIT.enabled?
puts "yjit:           #{yjit}"
puts "target:         #{bench_target}"
puts "payload size:   #{payload_size} bytes"
puts "multi counts:   #{multi_counts.join(', ')}"
puts "bench time:     #{bench_time}s (warmup: #{bench_warmup}s)"
puts "memcached:      #{dalli_url}"
puts "current branch: #{current_branch} (#{current_sha})"
puts "base branch:    #{base_branch}"
puts "has changes:    #{has_changes}"
puts '=' * 70
puts

suite = GCSuite.new
payload = 'x' * payload_size

# ---------------------------------------------------------------------------
# Phase 1: Benchmark the base branch (baseline)
# ---------------------------------------------------------------------------
puts '#' * 70
puts "PHASE 1: Benchmarking baseline (#{base_branch})"
puts '#' * 70
puts

if has_changes
  puts '=> Stashing uncommitted changes...'
  system('git stash --include-untracked -q') || abort('Failed to stash changes')
elsif current_branch != base_branch
  puts "=> Checking out #{base_branch}..."
  system("git checkout #{base_branch} -q") || abort("Failed to checkout #{base_branch}")
end

begin
  # Reload dalli from the base branch code
  # We need to fork a subprocess so we get a clean Ruby load
  pid = fork do
    # Re-require dalli fresh
    $LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
    load File.expand_path('../lib/dalli.rb', __dir__)

    label = "baseline (#{base_branch})"

    client_opts = { serializer: NoopSerializer, compress: false, raw: true }
    client = Dalli::Client.new(dalli_url, **client_opts)

    # Seed data
    client.set('bench_key', payload)

    multi_pairs = {}
    multi_counts.each do |count|
      pairs = {}
      count.times { |i| pairs["bench_multi_#{count}_#{i}"] = payload }
      multi_pairs[count] = pairs
      pairs.each { |k, v| client.set(k, v) }
    end

    puts "Baseline client verified. Seeded #{multi_pairs.values.sum(&:size)} multi keys."
    puts

    run_benchmarks(
      label: label, client: client, bench_target: bench_target,
      bench_time: bench_time, bench_warmup: bench_warmup, suite: suite,
      payload_size: payload_size, multi_pairs: multi_pairs,
      multi_counts: multi_counts, save_file: save_file
    )

    client.close
  end

  _, status = Process.waitpid2(pid)
  abort('Baseline benchmark failed!') unless status.success?
ensure
  # Restore to feature branch
  if has_changes
    puts '=> Restoring stashed changes...'
    system('git stash pop -q') || abort('Failed to restore stash')
  elsif current_branch != base_branch
    puts "=> Checking out #{current_branch}..."
    system("git checkout #{current_branch} -q") || abort("Failed to checkout #{current_branch}")
  end
end

puts
puts '#' * 70
puts "PHASE 2: Benchmarking current changes (#{current_branch})"
puts '#' * 70
puts

# Phase 2 runs in a fork too, for symmetry and clean loading
pid = fork do
  $LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
  load File.expand_path('../lib/dalli.rb', __dir__)

  label = "current (#{current_branch})"

  client_opts = { serializer: NoopSerializer, compress: false, raw: true }
  client = Dalli::Client.new(dalli_url, **client_opts)

  # Seed data
  client.set('bench_key', payload)

  multi_pairs = {}
  multi_counts.each do |count|
    pairs = {}
    count.times { |i| pairs["bench_multi_#{count}_#{i}"] = payload }
    multi_pairs[count] = pairs
    pairs.each { |k, v| client.set(k, v) }
  end

  puts "Current client verified. Seeded #{multi_pairs.values.sum(&:size)} multi keys."
  puts

  run_benchmarks(
    label: label, client: client, bench_target: bench_target,
    bench_time: bench_time, bench_warmup: bench_warmup, suite: suite,
    payload_size: payload_size, multi_pairs: multi_pairs,
    multi_counts: multi_counts, save_file: save_file
  )

  client.close
end

_, status = Process.waitpid2(pid)
abort('Current benchmark failed!') unless status.success?

puts '=' * 70
puts 'Done! Comparison shown above after each benchmark.'
puts '=' * 70