Skip to content

Extract parameters parser to its own object #436

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rafaelfranca merged 2 commits into from
Nov 21, 2025
Merged

Extract parameters parser to its own object #436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0008f90
Extract parameters parser to its own object
rafaelfranca Nov 18, 2025
6afd8ff
Move default executable selection into ArgumentParser
rafaelfranca Nov 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
185 changes: 185 additions & 0 deletions lib/argument_parser.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,185 @@
require 'optparse'
require 'shellwords'
require 'rbconfig'

class ArgumentParser
Args = Struct.new(
:executables,
:out_path,
:out_override,
:harness,
:yjit_opts,
:categories,
:name_filters,
:rss,
:graph,
:no_pinning,
:turbo,
:skip_yjit,
:with_pre_init,
keyword_init: true
)

def self.parse(argv = ARGV, ruby_executable: RbConfig.ruby)
new(ruby_executable: ruby_executable).parse(argv)
end

def initialize(ruby_executable: RbConfig.ruby)
@ruby_executable = ruby_executable
end

def parse(argv)
args = default_args

OptionParser.new do |opts|
opts.on("-e=NAME::RUBY_PATH OPTIONS", "ruby executable and options to be benchmarked (default: interp, yjit)") do |v|
v.split(";").each do |name_executable|
name, executable = name_executable.split("::", 2)
if executable.nil?
executable = name # allow skipping `NAME::`
end
args.executables[name] = executable.shellsplit
end
end

opts.on("--chruby=NAME::VERSION OPTIONS", "ruby version under chruby and options to be benchmarked") do |v|
v.split(";").each do |name_version|
name, version = name_version.split("::", 2)
# Convert `ruby --yjit` to `ruby::ruby --yjit`
if version.nil?
version = name
name = name.shellsplit.first
end
version, *options = version.shellsplit
rubies_dir = ENV["RUBIES_DIR"] || "#{ENV["HOME"]}/.rubies"
unless executable = ["/opt/rubies/#{version}/bin/ruby", "#{rubies_dir}/#{version}/bin/ruby"].find { |path| File.executable?(path) }
abort "Cannot find '#{version}' in /opt/rubies or #{rubies_dir}"
end
args.executables[name] = [executable, *options]
end
end

opts.on("--out_path=OUT_PATH", "directory where to store output data files") do |v|
args.out_path = v
end

opts.on("--out-name=OUT_FILE", "write exactly this output file plus file extension, ignoring directories, overwriting if necessary") do |v|
args.out_override = v
end

opts.on("--category=headline,other,micro,ractor", "when given, only benchmarks with specified categories will run") do |v|
args.categories += v.split(",")
if args.categories == ["ractor"]
args.harness = "harness-ractor"
end
end

opts.on("--headline", "when given, headline benchmarks will be run") do
args.categories += ["headline"]
end

opts.on("--name_filters=x,y,z", Array, "when given, only benchmarks with names that contain one of these strings will run") do |list|
args.name_filters = list
end

opts.on("--skip-yjit", "Don't run with yjit after interpreter") do
args.skip_yjit = true
end

opts.on("--harness=HARNESS_DIR", "which harness to use") do |v|
v = "harness-#{v}" unless v.start_with?('harness')
args.harness = v
end

opts.on("--warmup=N", "the number of warmup iterations for the default harness (default: 15)") do |n|
ENV["WARMUP_ITRS"] = n
end

opts.on("--bench=N", "the number of benchmark iterations for the default harness (default: 10). Also defaults MIN_BENCH_TIME to 0.") do |n|
ENV["MIN_BENCH_ITRS"] = n
ENV["MIN_BENCH_TIME"] ||= "0"
end

opts.on("--once", "benchmarks only 1 iteration with no warmup for the default harness") do
ENV["WARMUP_ITRS"] = "0"
ENV["MIN_BENCH_ITRS"] = "1"
ENV["MIN_BENCH_TIME"] = "0"
end

opts.on("--yjit-stats=STATS", "print YJIT stats at each iteration for the default harness") do |str|
ENV["YJIT_BENCH_STATS"] = str
end

opts.on("--zjit-stats=STATS", "print ZJIT stats at each iteration for the default harness") do |str|
ENV["ZJIT_BENCH_STATS"] = str
end

opts.on("--yjit_opts=OPT_STRING", "string of command-line options to run YJIT with (ignored if you use -e)") do |str|
args.yjit_opts = str
end

opts.on("--with_pre-init=PRE_INIT_FILE",
"a file to require before each benchmark run, so settings can be tuned (eg. enable/disable GC compaction)") do |str|
args.with_pre_init = str
end

opts.on("--rss", "show RSS in the output (measured after benchmark iterations)") do
args.rss = true
end

opts.on("--graph", "generate a graph image of benchmark results") do
args.graph = true
end

opts.on("--no-pinning", "don't pin ruby to a specific CPU core") do
args.no_pinning = true
end

opts.on("--turbo", "don't disable CPU turbo boost") do
args.turbo = true
end
end.parse!(argv)

# Remaining arguments are treated as benchmark name filters
if argv.length > 0
args.name_filters += argv
end

# If -e is not specified, benchmark the current Ruby. Compare it with YJIT if available.
if args.executables.empty?
if have_yjit?(@ruby_executable) && !args.skip_yjit
args.executables["interp"] = [@ruby_executable]
args.executables["yjit"] = [@ruby_executable, "--yjit", *args.yjit_opts.shellsplit]
else
args.executables["ruby"] = [@ruby_executable]
end
end

args
end

private

def have_yjit?(ruby)
ruby_version = `#{ruby} -v --yjit 2> #{File::NULL}`.strip
ruby_version.downcase.include?("yjit")
end

def default_args
Args.new(
executables: {},
out_path: File.expand_path("./data"),
out_override: nil,
harness: "harness",
yjit_opts: "",
categories: [],
name_filters: [],
rss: false,
graph: false,
no_pinning: false,
turbo: false,
skip_yjit: false,
with_pre_init: nil,
)
end
end
150 changes: 3 additions & 147 deletions run_benchmarks.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
#!/usr/bin/env ruby

require 'optparse'
require 'ostruct'
require 'pathname'
require 'fileutils'
require 'shellwords'
require 'csv'
require 'json'
require 'shellwords'
require 'rbconfig'
require 'etc'
require 'yaml'
Expand All @@ -15,11 +13,7 @@
require_relative 'lib/benchmark_runner'
require_relative 'lib/table_formatter'
require_relative 'lib/benchmark_filter'

def have_yjit?(ruby)
ruby_version = `#{ruby} -v --yjit 2> #{File::NULL}`.strip
ruby_version.downcase.include?("yjit")
end
require_relative 'lib/argument_parser'

def mean(values)
Stats.new(values).mean
Expand Down Expand Up @@ -158,145 +152,7 @@ def run_benchmarks(ruby:, ruby_description:, categories:, name_filters:, out_pat
[bench_data, bench_failures]
end

# Default values for command-line arguments
args = OpenStruct.new({
executables: {},
out_path: File.expand_path("./data"),
out_override: nil,
harness: "harness",
yjit_opts: "",
categories: [],
name_filters: [],
rss: false,
graph: false,
no_pinning: false,
turbo: false,
skip_yjit: false,
})

OptionParser.new do |opts|
opts.on("-e=NAME::RUBY_PATH OPTIONS", "ruby executable and options to be benchmarked (default: interp, yjit)") do |v|
v.split(";").each do |name_executable|
name, executable = name_executable.split("::", 2)
if executable.nil?
executable = name # allow skipping `NAME::`
end
args.executables[name] = executable.shellsplit
end
end

opts.on("--chruby=NAME::VERSION OPTIONS", "ruby version under chruby and options to be benchmarked") do |v|
v.split(";").each do |name_version|
name, version = name_version.split("::", 2)
# Convert `ruby --yjit` to `ruby::ruby --yjit`
if version.nil?
version = name
name = name.shellsplit.first
end
version, *options = version.shellsplit
rubies_dir = ENV["RUBIES_DIR"] || "#{ENV["HOME"]}/.rubies"
unless executable = ["/opt/rubies/#{version}/bin/ruby", "#{rubies_dir}/#{version}/bin/ruby"].find { |path| File.executable?(path) }
abort "Cannot find '#{version}' in /opt/rubies or #{rubies_dir}"
end
args.executables[name] = [executable, *options]
end
end

opts.on("--out_path=OUT_PATH", "directory where to store output data files") do |v|
args.out_path = v
end

opts.on("--out-name=OUT_FILE", "write exactly this output file plus file extension, ignoring directories, overwriting if necessary") do |v|
args.out_override = v
end

opts.on("--category=headline,other,micro,ractor", "when given, only benchmarks with specified categories will run") do |v|
args.categories += v.split(",")
if args.categories == ["ractor"]
args.harness = "harness-ractor"
end
end

opts.on("--headline", "when given, headline benchmarks will be run") do
args.categories += ["headline"]
end

opts.on("--name_filters=x,y,z", Array, "when given, only benchmarks with names that contain one of these strings will run") do |list|
args.name_filters = list
end

opts.on("--skip-yjit", "Don't run with yjit after interpreter") do
args.skip_yjit = true
end

opts.on("--harness=HARNESS_DIR", "which harness to use") do |v|
v = "harness-#{v}" unless v.start_with?('harness')
args.harness = v
end

opts.on("--warmup=N", "the number of warmup iterations for the default harness (default: 15)") do |n|
ENV["WARMUP_ITRS"] = n
end

opts.on("--bench=N", "the number of benchmark iterations for the default harness (default: 10). Also defaults MIN_BENCH_TIME to 0.") do |n|
ENV["MIN_BENCH_ITRS"] = n
ENV["MIN_BENCH_TIME"] ||= "0"
end

opts.on("--once", "benchmarks only 1 iteration with no warmup for the default harness") do
ENV["WARMUP_ITRS"] = "0"
ENV["MIN_BENCH_ITRS"] = "1"
ENV["MIN_BENCH_TIME"] = "0"
end

opts.on("--yjit-stats=STATS", "print YJIT stats at each iteration for the default harness") do |str|
ENV["YJIT_BENCH_STATS"] = str
end

opts.on("--zjit-stats=STATS", "print ZJIT stats at each iteration for the default harness") do |str|
ENV["ZJIT_BENCH_STATS"] = str
end

opts.on("--yjit_opts=OPT_STRING", "string of command-line options to run YJIT with (ignored if you use -e)") do |str|
args.yjit_opts=str
end

opts.on("--with_pre-init=PRE_INIT_FILE",
"a file to require before each benchmark run, so settings can be tuned (eg. enable/disable GC compaction)") do |str|
args.with_pre_init = str
end

opts.on("--rss", "show RSS in the output (measured after benchmark iterations)") do
args.rss = true
end

opts.on("--graph", "generate a graph image of benchmark results") do
args.graph = true
end

opts.on("--no-pinning", "don't pin ruby to a specific CPU core") do
args.no_pinning = true
end

opts.on("--turbo", "don't disable CPU turbo boost") do
args.turbo = true
end
end.parse!

# Remaining arguments are treated as benchmark name filters
if ARGV.length > 0
args.name_filters += ARGV
end

# If -e is not specified, benchmark the current Ruby. Compare it with YJIT if available.
if args.executables.empty?
if have_yjit?(RbConfig.ruby) && !args.skip_yjit
args.executables["interp"] = [RbConfig.ruby]
args.executables["yjit"] = [RbConfig.ruby, "--yjit", *args.yjit_opts.shellsplit]
else
args.executables["ruby"] = [RbConfig.ruby]
end
end
args = ArgumentParser.parse(ARGV)

CPUConfig.configure_for_benchmarking(turbo: args.turbo)

Expand Down
Loading
Loading