mirror of
https://github.com/ruby/ruby.git
synced 2025-08-15 13:39:04 +02:00
39effad486
This tells RDoc to not automatically link to the `ZJIT` module so we don't need to keep escaping the word ZJIT in the documentation/comments.
88 lines
2.2 KiB
Ruby
88 lines
2.2 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
# This module allows for introspection of ZJIT, CRuby's just-in-time compiler.
|
|
# Everything in the module is highly implementation specific and the API might
|
|
# be less stable compared to the standard library.
|
|
#
|
|
# This module may not exist if ZJIT does not support the particular platform
|
|
# for which CRuby is built.
|
|
module RubyVM::ZJIT
|
|
# Avoid calling a Ruby method here to avoid interfering with compilation tests
|
|
if Primitive.rb_zjit_stats_enabled_p
|
|
at_exit { print_stats }
|
|
end
|
|
end
|
|
|
|
class << RubyVM::ZJIT
|
|
# Check if ZJIT is enabled
|
|
def enabled?
|
|
Primitive.cexpr! 'RBOOL(rb_zjit_enabled_p)'
|
|
end
|
|
|
|
# Return ZJIT statistics as a Hash
|
|
def stats
|
|
stats = Primitive.rb_zjit_stats
|
|
return nil if stats.nil?
|
|
|
|
if stats.key?(:vm_insns_count) && stats.key?(:zjit_insns_count)
|
|
stats[:total_insns_count] = stats[:vm_insns_count] + stats[:zjit_insns_count]
|
|
stats[:ratio_in_zjit] = 100.0 * stats[:zjit_insns_count] / stats[:total_insns_count]
|
|
end
|
|
|
|
stats
|
|
end
|
|
|
|
# Get the summary of ZJIT statistics as a String
|
|
def stats_string
|
|
buf = +''
|
|
stats = self.stats
|
|
|
|
[
|
|
:compile_time_ns,
|
|
:profile_time_ns,
|
|
:gc_time_ns,
|
|
:invalidation_time_ns,
|
|
:total_insns_count,
|
|
:vm_insns_count,
|
|
:zjit_insns_count,
|
|
:ratio_in_zjit,
|
|
].each do |key|
|
|
# Some stats like vm_insns_count and ratio_in_zjit are not supported on the release build
|
|
next unless stats.key?(key)
|
|
value = stats[key]
|
|
|
|
case key
|
|
when :ratio_in_zjit
|
|
value = '%0.1f%%' % value
|
|
when /_time_ns\z/
|
|
key = key.to_s.sub(/_time_ns\z/, '_time')
|
|
value = "#{number_with_delimiter(value / 10**6)}ms"
|
|
else
|
|
value = number_with_delimiter(value)
|
|
end
|
|
|
|
buf << "#{'%-18s' % "#{key}:"} #{value}\n"
|
|
end
|
|
buf
|
|
end
|
|
|
|
# Assert that any future ZJIT compilation will return a function pointer
|
|
def assert_compiles # :nodoc:
|
|
Primitive.rb_zjit_assert_compiles
|
|
end
|
|
|
|
# :stopdoc:
|
|
private
|
|
|
|
def number_with_delimiter(number)
|
|
s = number.to_s
|
|
i = s.index('.') || s.size
|
|
s.insert(i -= 3, ',') while i > 3
|
|
s
|
|
end
|
|
|
|
# Print ZJIT stats
|
|
def print_stats
|
|
$stderr.write stats_string
|
|
end
|
|
end
|