corkscrews 0.1.0

data/validate/benchmarks/b04_lock_contention/manifest.yml

@@ -0,0 +1,19 @@
+id: b04_lock_contention
+category: lock
+targets: both
+progress_point: work_done
+truth:
+  target:
+    kind: wait
+    name: lock_wait
+  decoys:
+    - { kind: line, file: base.rb, line: 10 }
+  optimized_speedup_of_target: 0.50
+run:
+  repeat: 3
+  iterations: 160
+  sample_period_ms: 0.5
+acceptance:
+  t1_mae_pct: 120.0
+  t3_decoy_max_effect_pct: 50.0
+  t4_overhead_pct: 40.0

data/validate/benchmarks/b04_lock_contention/optimized.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "../support"
+
+def critical_work
+  CorkscrewsBench.busy(600)
+end
+
+def outside_work
+  CorkscrewsBench.busy(600)
+end
+
+iterations = CorkscrewsBench.iterations(180)
+started = CorkscrewsBench.monotonic_ns
+mutex = Mutex.new
+done = Queue.new
+
+4.times do
+  Thread.new do
+    (iterations / 4).times do
+      mutex.synchronize { critical_work }
+      outside_work
+      Corkscrews.progress(:work_done)
+    end
+    done << true
+  end
+end
+
+4.times { done.pop }
+CorkscrewsBench.finish(progress: iterations - (iterations % 4), started_ns: started)

data/validate/benchmarks/b05_gvl_contention/base.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "../support"
+
+def gvl_work
+  20_000.times.sum { |i| Integer.sqrt((i * i) + 7) }
+end
+
+iterations = CorkscrewsBench.iterations(200)
+started = CorkscrewsBench.monotonic_ns
+done = Queue.new
+
+4.times do
+  Thread.new do
+    (iterations / 4).times do
+      gvl_work
+      Corkscrews.progress(:work_done)
+    end
+    done << true
+  end
+end
+
+4.times { done.pop }
+CorkscrewsBench.finish(progress: iterations - (iterations % 4), started_ns: started)

data/validate/benchmarks/b05_gvl_contention/manifest.yml

@@ -0,0 +1,17 @@
+id: b05_gvl_contention
+category: gvl
+targets: lines
+progress_point: work_done
+truth:
+  target:
+    kind: line
+    file: base.rb
+    line: 23
+  optimized_speedup_of_target: 0.50
+run:
+  repeat: 3
+  iterations: 160
+  sample_period_ms: 0.5
+acceptance:
+  t1_mae_pct: 80.0
+  t4_overhead_pct: 30.0

data/validate/benchmarks/b05_gvl_contention/optimized.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "../support"
+
+def gvl_work
+  10_000.times.sum { |i| Integer.sqrt((i * i) + 7) }
+end
+
+iterations = CorkscrewsBench.iterations(200)
+started = CorkscrewsBench.monotonic_ns
+done = Queue.new
+
+4.times do
+  Thread.new do
+    (iterations / 4).times do
+      gvl_work
+      Corkscrews.progress(:work_done)
+    end
+    done << true
+  end
+end
+
+4.times { done.pop }
+CorkscrewsBench.finish(progress: iterations - (iterations % 4), started_ns: started)

data/validate/benchmarks/b06_gc_pressure/base.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "../support"
+
+iterations = CorkscrewsBench.iterations(500)
+started = CorkscrewsBench.monotonic_ns
+checksum = 0
+
+iterations.times do
+  data = Array.new(400) { |i| "x#{i}" }
+  checksum ^= data.length
+  GC.start if (checksum % 17).zero?
+  Corkscrews.progress(:work_done)
+end
+
+CorkscrewsBench.finish(progress: iterations, started_ns: started, checksum: checksum)

data/validate/benchmarks/b06_gc_pressure/manifest.yml

@@ -0,0 +1,16 @@
+id: b06_gc_pressure
+category: gc
+targets: both
+progress_point: work_done
+truth:
+  target:
+    kind: wait
+    name: gc_pause
+  optimized_speedup_of_target: 0.50
+run:
+  repeat: 3
+  iterations: 400
+  sample_period_ms: 0.5
+acceptance:
+  t1_mae_pct: 120.0
+  t4_overhead_pct: 45.0

data/validate/benchmarks/b06_gc_pressure/optimized.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "../support"
+
+iterations = CorkscrewsBench.iterations(500)
+started = CorkscrewsBench.monotonic_ns
+buffer = Array.new(40)
+checksum = 0
+
+iterations.times do
+  buffer.each_index { |i| buffer[i] = i }
+  checksum ^= buffer.length
+  GC.start if (checksum % 101).zero?
+  Corkscrews.progress(:work_done)
+end
+
+CorkscrewsBench.finish(progress: iterations, started_ns: started, checksum: checksum)

data/validate/benchmarks/b07_pipeline/base.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "../support"
+
+iterations = CorkscrewsBench.iterations(160)
+started = CorkscrewsBench.monotonic_ns
+parse_q = Thread::SizedQueue.new(8)
+write_q = Thread::SizedQueue.new(8)
+
+parser = Thread.new do
+  iterations.times do |i|
+    CorkscrewsBench.busy(2_000)
+    parse_q << i
+  end
+end
+
+transformer = Thread.new do
+  iterations.times do
+    item = parse_q.pop
+    CorkscrewsBench.busy(8_000)
+    write_q << item
+  end
+end
+
+writer = Thread.new do
+  iterations.times do
+    write_q.pop
+    CorkscrewsBench.busy(2_000)
+    Corkscrews.progress(:work_done)
+  end
+end
+
+[parser, transformer, writer].each(&:join)
+CorkscrewsBench.finish(progress: iterations, started_ns: started)

data/validate/benchmarks/b07_pipeline/manifest.yml

@@ -0,0 +1,17 @@
+id: b07_pipeline
+category: pipeline
+targets: both
+progress_point: work_done
+truth:
+  target:
+    kind: line
+    file: base.rb
+    line: 33
+  optimized_speedup_of_target: 0.50
+run:
+  repeat: 3
+  iterations: 120
+  sample_period_ms: 0.5
+acceptance:
+  t1_mae_pct: 130.0
+  t4_overhead_pct: 45.0

data/validate/benchmarks/b07_pipeline/optimized.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "../support"
+
+iterations = CorkscrewsBench.iterations(160)
+started = CorkscrewsBench.monotonic_ns
+parse_q = Thread::SizedQueue.new(8)
+write_q = Thread::SizedQueue.new(8)
+
+parser = Thread.new do
+  iterations.times do |i|
+    CorkscrewsBench.busy(2_000)
+    parse_q << i
+  end
+end
+
+transformer = Thread.new do
+  iterations.times do
+    item = parse_q.pop
+    CorkscrewsBench.busy(4_000)
+    write_q << item
+  end
+end
+
+writer = Thread.new do
+  iterations.times do
+    write_q.pop
+    CorkscrewsBench.busy(2_000)
+    Corkscrews.progress(:work_done)
+  end
+end
+
+[parser, transformer, writer].each(&:join)
+CorkscrewsBench.finish(progress: iterations, started_ns: started)

data/validate/benchmarks/b08_native_attribution/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "../support"
+
+def native_call_work
+  1_800.times.sum { |i| Integer.sqrt((i * i) + 7) }
+end
+
+iterations = CorkscrewsBench.iterations(500)
+started = CorkscrewsBench.monotonic_ns
+checksum = 0
+
+iterations.times do
+  checksum ^= native_call_work
+  Corkscrews.progress(:work_done)
+end
+
+CorkscrewsBench.finish(progress: iterations, started_ns: started, checksum: checksum)

data/validate/benchmarks/b08_native_attribution/manifest.yml

@@ -0,0 +1,18 @@
+id: b08_native_attribution
+category: native
+targets: lines
+progress_point: work_done
+truth:
+  target:
+    kind: line
+    file: base.rb
+    line: 6
+  optimized_speedup_of_target: 0.50
+run:
+  repeat: 3
+  iterations: 400
+  sample_period_ms: 0.5
+  round_ms: 10
+acceptance:
+  t1_mae_pct: 80.0
+  t4_overhead_pct: 35.0

data/validate/benchmarks/b08_native_attribution/optimized.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "../support"
+
+def native_call_work
+  900.times.sum { |i| Integer.sqrt((i * i) + 7) }
+end
+
+iterations = CorkscrewsBench.iterations(500)
+started = CorkscrewsBench.monotonic_ns
+checksum = 0
+
+iterations.times do
+  checksum ^= native_call_work
+  Corkscrews.progress(:work_done)
+end
+
+CorkscrewsBench.finish(progress: iterations, started_ns: started, checksum: checksum)

data/validate/benchmarks/support.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "json"
+require "corkscrews"
+
+module CorkscrewsBench
+  module_function
+
+  def iterations(default)
+    ENV.fetch("CS_BENCH_ITERATIONS", default.to_s).to_i
+  end
+
+  def monotonic_ns
+    Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond)
+  end
+
+  def busy(iterations)
+    total = 0
+    iterations.times { |i| total += Integer.sqrt((i * i) + 7) }
+    total
+  end
+
+  def finish(progress:, started_ns:, checksum: 0)
+    elapsed_ns = monotonic_ns - started_ns
+    return unless ENV["CS_BENCH_JSON"] == "1"
+
+    puts JSON.generate(progress: progress, elapsed_ns: elapsed_ns, checksum: checksum)
+  end
+end

data/validate/harness/run_all.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../../lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "corkscrews/validate"
+
+quick = ARGV.delete("--quick")
+benchmark = nil
+if (index = ARGV.index("--benchmark"))
+  benchmark = ARGV.fetch(index + 1)
+end
+
+result = Corkscrews::Validate.run_all(quick: quick, benchmark: benchmark)
+puts JSON.pretty_generate(result.to_h)
+exit(result.ok? ? 0 : 1)

data/validate/harness/stats_check.py

@@ -0,0 +1,27 @@
+#!/usr/bin/env python3
+"""Independent smoke checks for validation statistics."""
+
+from __future__ import annotations
+
+import statistics
+
+
+def percentile(values: list[float], pct: float) -> float:
+    ordered = sorted(values)
+    index = round(pct * (len(ordered) - 1))
+    return ordered[index]
+
+
+def main() -> int:
+    values = [9.7, 10.1, 10.4, 9.9, 10.2, 10.0, 10.3, 9.8]
+    mean = statistics.fmean(values)
+    lo = percentile(values, 0.025)
+    hi = percentile(values, 0.975)
+    if not lo <= mean <= hi:
+        raise SystemExit("mean is outside percentile interval")
+    print({"mean": mean, "interval": [lo, hi]})
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

data/validate/harness/t1.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "../../lib/corkscrews/validate"
+
+module Corkscrews
+  module Validate
+    module T1
+      module_function
+
+      def check!(manifest, profile, actual)
+        Validate.t1_prediction_check(manifest, profile, actual)
+      end
+    end
+  end
+end

data/validate/harness/t4.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "../../lib/corkscrews/validate"
+
+module Corkscrews
+  module Validate
+    module T4
+      module_function
+
+      def check!(manifest, profile, actual)
+        Validate.t4_overhead_check(manifest, profile, actual)
+      end
+    end
+  end
+end

data/validate/harness/t5.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "../../lib/corkscrews/validate"
+
+module Corkscrews
+  module Validate
+    module T5
+      module_function
+
+      def check!
+        Validate.t5_statistics_check
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: corkscrews
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yudai Takada
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fiddle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: corkscrews records progress points, line samples, wait targets, and validation
+  benchmarks for Ruby causal profiling experiments.
+email:
+- t.yudai92@gmail.com
+executables:
+- corkscrews
+extensions:
+- ext/corkscrews/extconf.rb
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/corkscrews
+- ext/corkscrews/corkscrews.c
+- ext/corkscrews/corkscrews_native.h
+- ext/corkscrews/delay.c
+- ext/corkscrews/extconf.rb
+- ext/corkscrews/hooks.c
+- ext/corkscrews/monitor.c
+- ext/corkscrews/record.c
+- ext/corkscrews/sampler.c
+- lib/corkscrews.rb
+- lib/corkscrews/analysis.rb
+- lib/corkscrews/boot.rb
+- lib/corkscrews/cli.rb
+- lib/corkscrews/controller.rb
+- lib/corkscrews/firefox_profile.rb
+- lib/corkscrews/native.rb
+- lib/corkscrews/primitives.rb
+- lib/corkscrews/rack.rb
+- lib/corkscrews/recorder.rb
+- lib/corkscrews/report.rb
+- lib/corkscrews/statistics.rb
+- lib/corkscrews/time_source.rb
+- lib/corkscrews/validate.rb
+- lib/corkscrews/version.rb
+- validate/benchmarks/b01_serial_hotspot/base.rb
+- validate/benchmarks/b01_serial_hotspot/manifest.yml
+- validate/benchmarks/b01_serial_hotspot/optimized.rb
+- validate/benchmarks/b02_false_hotspot/base.rb
+- validate/benchmarks/b02_false_hotspot/manifest.yml
+- validate/benchmarks/b02_false_hotspot/optimized.rb
+- validate/benchmarks/b03_io_wait/base.rb
+- validate/benchmarks/b03_io_wait/manifest.yml
+- validate/benchmarks/b03_io_wait/optimized.rb
+- validate/benchmarks/b04_lock_contention/base.rb
+- validate/benchmarks/b04_lock_contention/manifest.yml
+- validate/benchmarks/b04_lock_contention/optimized.rb
+- validate/benchmarks/b05_gvl_contention/base.rb
+- validate/benchmarks/b05_gvl_contention/manifest.yml
+- validate/benchmarks/b05_gvl_contention/optimized.rb
+- validate/benchmarks/b06_gc_pressure/base.rb
+- validate/benchmarks/b06_gc_pressure/manifest.yml
+- validate/benchmarks/b06_gc_pressure/optimized.rb
+- validate/benchmarks/b07_pipeline/base.rb
+- validate/benchmarks/b07_pipeline/manifest.yml
+- validate/benchmarks/b07_pipeline/optimized.rb
+- validate/benchmarks/b08_native_attribution/base.rb
+- validate/benchmarks/b08_native_attribution/manifest.yml
+- validate/benchmarks/b08_native_attribution/optimized.rb
+- validate/benchmarks/support.rb
+- validate/harness/run_all.rb
+- validate/harness/stats_check.py
+- validate/harness/t1.rb
+- validate/harness/t4.rb
+- validate/harness/t5.rb
+homepage: https://github.com/ydah/corkscrews
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/ydah/corkscrews
+  source_code_uri: https://github.com/ydah/corkscrews
+  bug_tracker_uri: https://github.com/ydah/corkscrews/issues
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.6
+specification_version: 4
+summary: Causal profiling tools for Ruby bottleneck experiments.
+test_files: []