rperf 0.7.0 → 0.9.0

data/exe/rperf

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 require "optparse"
 require "socket"
+require "fileutils"
 
 def find_available_port
   server = TCPServer.new("localhost", 0)
@@ -23,6 +24,12 @@ def run_pprof_subcommand(name, banner, min_files:)
       mode = :text
     end
 
+    if min_files == 1
+      opts.on("--html", "Output static HTML viewer to stdout") do
+        mode = :html
+      end
+    end
+
     opts.on("-h", "--help", "Show this help") do
       puts opts
       exit
@@ -31,7 +38,7 @@ def run_pprof_subcommand(name, banner, min_files:)
 
   begin
     parser.order!(ARGV)
-  rescue OptionParser::InvalidOption => e
+  rescue OptionParser::InvalidOption, OptionParser::MissingArgument, OptionParser::NeedlessArgument => e
     $stderr.puts e.message
     $stderr.puts parser
     exit 1
@@ -44,7 +51,7 @@ def run_pprof_subcommand(name, banner, min_files:)
   end
 
   files = ARGV.shift(min_files > 1 ? [ARGV.size, min_files].min : 1)
-  files = ["rperf.data"] if files.empty? && min_files == 1
+  files = ["rperf.json.gz"] if files.empty? && min_files == 1
 
   if min_files > 1 && files.size < min_files
     $stderr.puts "Two profile files required."
@@ -59,22 +66,19 @@ def run_pprof_subcommand(name, banner, min_files:)
     end
   end
 
-  unless system("go", "version", out: File::NULL, err: File::NULL)
-    $stderr.puts "'go' command not found. Install Go to use 'rperf #{name}'."
-    $stderr.puts "  https://go.dev/dl/"
-    exit 1
-  end
-
+  # Go check is deferred — only needed for pprof files, not marshal/json
   yield mode, files
 end
 
-HELP_TEXT = File.read(File.expand_path("../docs/help.md", __dir__))
+def self.help_text
+  @help_text ||= File.read(File.expand_path("../docs/help.md", __dir__))
+end
 
 USAGE = "Usage: rperf record [options] command [args...]\n" \
        "       rperf stat [options] command [args...]\n" \
        "       rperf exec [options] command [args...]\n" \
        "       rperf report [options] [file]\n" \
-       "       rperf diff [options] base.pb.gz target.pb.gz\n" \
+       "       rperf diff [options] base target\n" \
        "       rperf help\n"
 
 # Handle top-level flags before subcommand parsing
@@ -94,31 +98,127 @@ subcommand = ARGV.shift
 
 case subcommand
 when "help"
-  puts HELP_TEXT
+  puts help_text
   exit
 when "report"
   run_pprof_subcommand("report",
     "Usage: rperf report [options] [file]\n" \
-    "       Opens pprof profile in browser (default) or prints summary.\n" \
-    "       Default file: rperf.data",
+    "       Opens profile in browser (default) or prints summary.\n" \
+    "       Default file: rperf.json.gz\n" \
+    "       For .json.gz: opens rperf viewer (no Go required).\n" \
+    "       For .pb.gz: opens go tool pprof (requires Go).",
     min_files: 1) do |mode, files|
     report_file = files[0]
-    case mode
-    when :top  then exec("go", "tool", "pprof", "-top", report_file)
-    when :text then exec("go", "tool", "pprof", "-text", report_file)
-    else            exec("go", "tool", "pprof", "-http=localhost:#{find_available_port}", report_file)
+    if report_file =~ /\.json(\.gz)?\z/
+      # Use rperf viewer
+      require_relative "../lib/rperf"
+      require_relative "../lib/rperf/viewer"
+
+      data = Rperf.load(report_file)
+
+      case mode
+      when :top
+        $stdout.puts Rperf::Text.encode(data, top_n: 20, header: false)
+        exit
+      when :text
+        $stdout.puts Rperf::Text.encode(data)
+        exit
+      when :html
+        $stdout.puts Rperf::Viewer.render_static_html(data)
+        exit
+      end
+
+      port = find_available_port
+
+      app = Rperf::Viewer.new(
+        proc { |_| [404, { "content-type" => "text/plain" }, ["Not Found"]] },
+        path: ""
+      )
+      app.add_snapshot(data)
+
+      url = "http://localhost:#{port}/"
+      $stderr.puts "Serving rperf viewer at #{url}"
+      $stderr.puts "Press Ctrl-C to stop."
+
+      # Open browser after server is ready
+      Thread.new do
+        20.times do
+          TCPSocket.new("localhost", port).close
+          break
+        rescue Errno::ECONNREFUSED
+          sleep 0.1
+        end
+        case RUBY_PLATFORM
+        when /darwin/ then system("open", url)
+        when /linux/  then system("xdg-open", url, err: File::NULL) || system("sensible-browser", url, err: File::NULL)
+        end
+      end
+
+      # Find an available Rack handler
+      begin
+        require "rackup/handler"
+      rescue LoadError
+        $stderr.puts "Error: 'rackup' gem is required for 'rperf report'. Install it with:"
+        $stderr.puts "  gem install rackup"
+        exit 1
+      end
+      handler = Rackup::Handler.default
+      handler.run(app, Port: port, Host: "localhost", Silent: true)
+      exit
+    else
+      unless system("go", "version", out: File::NULL, err: File::NULL)
+        $stderr.puts "'go' command not found. Install Go to use pprof files, or use .json.gz format."
+        $stderr.puts "  https://go.dev/dl/"
+        exit 1
+      end
+      case mode
+      when :top  then exec("go", "tool", "pprof", "-top", report_file)
+      when :text then exec("go", "tool", "pprof", "-text", report_file)
+      else            exec("go", "tool", "pprof", "-http=localhost:#{find_available_port}", report_file)
+      end
     end
   end
 when "diff"
   run_pprof_subcommand("diff",
-    "Usage: rperf diff [options] base.pb.gz target.pb.gz\n" \
-    "       Compare two pprof profiles (shows target - base).",
+    "Usage: rperf diff [options] base target\n" \
+    "       Compare two profiles (shows target - base).\n" \
+    "       Accepts .json.gz (auto-converted) or .pb.gz files.\n" \
+    "       Requires Go (https://go.dev/dl/).",
     min_files: 2) do |mode, files|
+    unless system("go", "version", out: File::NULL, err: File::NULL)
+      $stderr.puts "'go' command not found. Install Go to use 'rperf diff'."
+      $stderr.puts "  https://go.dev/dl/"
+      exit 1
+    end
+
+    tmpfiles = []
+    files.each_with_index do |f, i|
+      if f =~ /\.json(\.gz)?\z/
+        require "tempfile"
+        require_relative "../lib/rperf"
+        data = Rperf.load(f)
+        tmp = Tempfile.new(["rperf_diff_#{i}", ".pb.gz"])
+        tmp.binmode
+        tmp.write(Rperf.__send__(:gzip, Rperf::PProf.encode(data)))
+        tmp.close
+        tmpfiles << tmp
+        files[i] = tmp.path
+      end
+    end
+
     base_file, target_file = files
-    case mode
-    when :top  then exec("go", "tool", "pprof", "-top", "-diff_base=#{base_file}", target_file)
-    when :text then exec("go", "tool", "pprof", "-text", "-diff_base=#{base_file}", target_file)
-    else            exec("go", "tool", "pprof", "-http=localhost:#{find_available_port}", "-diff_base=#{base_file}", target_file)
+    pprof_args = case mode
+                 when :top  then ["-top", "-diff_base=#{base_file}", target_file]
+                 when :text then ["-text", "-diff_base=#{base_file}", target_file]
+                 else            ["-http=localhost:#{find_available_port}", "-diff_base=#{base_file}", target_file]
+                 end
+    if tmpfiles.empty?
+      exec("go", "tool", "pprof", *pprof_args)
+    else
+      pid = spawn("go", "tool", "pprof", *pprof_args)
+      _, status = Process.wait2(pid)
+      tmpfiles.each(&:unlink)
+      exit(status.exitstatus || 1)
     end
   end
 when "record", "stat", "exec"
@@ -129,7 +229,7 @@ else
   exit 1
 end
 
-output = (subcommand == "record") ? "rperf.data" : nil
+output = (subcommand == "record") ? "rperf.json.gz" : nil
 frequency = 1000
 mode = (subcommand == "record") ? "cpu" : "wall"
 format = nil
@@ -137,6 +237,7 @@ signal = nil
 verbose = false
 aggregate = true
 stat_report = (subcommand == "exec")
+inherit = true
 
 parser = OptionParser.new do |opts|
   opts.banner = case subcommand
@@ -145,7 +246,7 @@ parser = OptionParser.new do |opts|
                 when "exec"   then "Usage: rperf exec [options] command [args...]"
                 end
 
-  opts.on("-o", "--output PATH", "Output file#{subcommand == 'record' ? ' (default: rperf.data)' : ' (default: none)'}") do |v|
+  opts.on("-o", "--output PATH", "Output file#{subcommand == 'record' ? ' (default: rperf.json.gz)' : ' (default: none)'}") do |v|
     output = v
   end
 
@@ -159,8 +260,8 @@ parser = OptionParser.new do |opts|
   end
 
   if subcommand == "record"
-    opts.on("--format FORMAT", %w[pprof collapsed text],
-            "Output format: pprof, collapsed, or text (default: auto from extension)") do |v|
+    opts.on("--format FORMAT", %w[pprof collapsed text json],
+            "Output format: json, pprof, collapsed, or text (default: auto from extension)") do |v|
       format = v
     end
 
@@ -171,7 +272,14 @@ parser = OptionParser.new do |opts|
   end
 
   opts.on("--signal VALUE", "Timer signal (Linux only): signal number, or 'false' for nanosleep thread") do |v|
-    signal = (v == "false") ? "false" : v
+    if v == "false"
+      signal = "false"
+    elsif v =~ /\A\d+\z/
+      signal = v
+    else
+      $stderr.puts "Error: --signal must be a signal number or 'false', got: #{v.inspect}"
+      exit 1
+    end
   end
 
   opts.on("--no-aggregate", "Disable sample aggregation (keep raw samples)") do
@@ -184,6 +292,10 @@ parser = OptionParser.new do |opts|
     end
   end
 
+  opts.on("--no-inherit", "Do not profile forked/spawned child processes (default: inherit)") do
+    inherit = false
+  end
+
   opts.on("-v", "--verbose", "Print sampling statistics to stderr") do
     verbose = true
   end
@@ -198,7 +310,7 @@ end
 
 begin
   parser.order!(ARGV)
-rescue OptionParser::InvalidOption => e
+rescue OptionParser::InvalidOption, OptionParser::MissingArgument, OptionParser::NeedlessArgument => e
   $stderr.puts e.message
   $stderr.puts parser
   exit 1
@@ -233,7 +345,9 @@ if signal && signal != "false"
   end
 end
 
-# Add lib dir to RUBYLIB so -rrperf can find the extension
+# Add lib dir to RUBYLIB so -rrperf can find the correct version.
+# RUBYLIB handles spaces in paths safely (PATH_SEPARATOR delimited).
+# RUBYOPT -r<path> does not support spaces, so we use RUBYLIB + -rrperf.
 lib_dir = File.expand_path("../lib", __dir__)
 ENV["RUBYLIB"] = [lib_dir, ENV["RUBYLIB"]].compact.join(File::PATH_SEPARATOR)
 ENV["RUBYOPT"] = "-rrperf #{ENV['RUBYOPT']}".strip
@@ -252,4 +366,14 @@ if subcommand == "stat" || subcommand == "exec"
   ENV["RPERF_STAT_REPORT"] = "1" if stat_report
 end
 
+# Multi-process (fork) support: create a session directory for aggregation
+if inherit
+  require_relative "../lib/rperf"
+  session_dir = Rperf.send(:_create_session_dir, clean_stale: true)
+  if session_dir
+    ENV["RPERF_ROOT_PROCESS"] = Process.pid.to_s
+    ENV["RPERF_SESSION_DIR"] = session_dir
+  end
+end
+
 exec(*ARGV)