2018-10-20 04:47:26 -04:00
require 'rbconfig'
2018-02-22 10:11:12 -05:00
module JITSupport
JIT_TIMEOUT = 600 # 10min for each...
JIT_SUCCESS_PREFIX = 'JIT success \(\d+\.\dms\)'
2020-03-31 01:27:01 -04:00
JIT_RECOMPILE_PREFIX = 'JIT recompile'
2019-09-25 23:53:41 -04:00
JIT_COMPACTION_PREFIX = 'JIT compaction \(\d+\.\dms\)'
2018-10-19 10:26:29 -04:00
UNSUPPORTED_COMPILERS = [
2020-03-03 22:31:11 -05:00
%r[ \ A.*/bin/intel64/icc \ b ] ,
2018-12-27 09:53:02 -05:00
%r[ \ A/opt/developerstudio \ d+ \ . \ d+/bin/cc \ z ] ,
2018-02-22 10:11:12 -05:00
]
2020-04-20 09:46:53 -04:00
# debian-riscv64: "gcc: internal compiler error: Segmentation fault signal terminated program cc1" https://rubyci.org/logs/rubyci.s3.amazonaws.com/debian-riscv64/ruby-master/log/20200420T083601Z.fail.html.gz
2020-03-06 23:19:56 -05:00
# freebsd12: cc1 internal failure https://rubyci.org/logs/rubyci.s3.amazonaws.com/freebsd12/ruby-master/log/20200306T103003Z.fail.html.gz
# rhel8: one or more PCH files were found, but they were invalid https://rubyci.org/logs/rubyci.s3.amazonaws.com/rhel8/ruby-master/log/20200306T153003Z.fail.html.gz
2020-05-12 04:47:27 -04:00
# centos8: ditto https://rubyci.org/logs/rubyci.s3.amazonaws.com/centos8/ruby-master/log/20200512T003004Z.fail.html.gz
2020-03-06 23:19:56 -05:00
PENDING_RUBYCI_NICKNAMES = %w[
2020-04-20 09:46:53 -04:00
debian - riscv64
2020-03-06 23:19:56 -05:00
freebsd12
rhel8
2020-05-12 04:47:27 -04:00
centos8
2020-03-06 23:19:56 -05:00
]
2018-02-22 10:11:12 -05:00
2018-05-27 01:47:43 -04:00
module_function
2018-08-09 05:58:07 -04:00
# Run Ruby script with --jit-wait (Synchronous JIT compilation).
# Returns [stdout, stderr]
def eval_with_jit ( env = nil , script , ** opts )
stdout , stderr = nil , nil
# retry 3 times while cc1 error happens.
3 . times do | i |
stdout , stderr , status = eval_with_jit_without_retry ( env , script , ** opts )
assert_equal ( true , status . success? , " Failed to run script with JIT: \n #{ code_block ( script ) } \n stdout: \n #{ code_block ( stdout ) } \n stderr: \n #{ code_block ( stderr ) } " )
break unless retried_stderr? ( stderr )
end
[ stdout , stderr ]
end
def eval_with_jit_without_retry ( env = nil , script , verbose : 0 , min_calls : 5 , save_temps : false , max_cache : 1000 , wait : true , timeout : JIT_TIMEOUT )
2018-07-27 01:52:01 -04:00
args = [
2018-08-09 05:58:07 -04:00
'--disable-gems' , " --jit-verbose= #{ verbose } " ,
2018-07-27 01:52:01 -04:00
" --jit-min-calls= #{ min_calls } " , " --jit-max-cache= #{ max_cache } " ,
]
2021-07-15 16:06:39 -04:00
args << '--disable-yjit'
2018-08-09 05:58:07 -04:00
args << '--jit-wait' if wait
2018-05-27 01:47:43 -04:00
args << '--jit-save-temps' if save_temps
2019-10-16 01:47:20 -04:00
args << '--jit-debug' if defined? ( @jit_debug ) && @jit_debug
2018-05-27 01:47:43 -04:00
args << '-e' << script
2018-07-31 08:43:06 -04:00
base_env = { 'MJIT_SEARCH_BUILD_DIR' = > 'true' } # workaround to skip requiring `make install` for `make test-all`
2018-11-06 21:49:26 -05:00
if preloadenv = RbConfig :: CONFIG [ 'PRELOADENV' ] and ! preloadenv . empty?
so = " mjit_build_dir. #{ RbConfig :: CONFIG [ 'SOEXT' ] } "
base_env [ preloadenv ] = File . realpath ( so ) rescue nil
end
2018-07-31 08:43:06 -04:00
args . unshift ( env ? base_env . merge! ( env ) : base_env )
2018-05-27 01:47:43 -04:00
EnvUtil . invoke_ruby ( args ,
'' , true , true , timeout : timeout ,
)
end
2018-10-19 10:26:29 -04:00
def supported?
return @supported if defined? ( @supported )
2020-05-03 03:41:27 -04:00
@supported = RbConfig :: CONFIG [ " MJIT_SUPPORT " ] != 'no' && UNSUPPORTED_COMPILERS . all? do | regexp |
2019-12-05 01:16:07 -05:00
! regexp . match? ( RbConfig :: CONFIG [ 'MJIT_CC' ] )
2020-05-03 19:15:45 -04:00
end && ! appveyor_pdb_corrupted? && ! PENDING_RUBYCI_NICKNAMES . include? ( ENV [ 'RUBYCI_NICKNAME' ] )
2018-10-19 10:26:29 -04:00
end
2020-05-03 03:41:27 -04:00
# AppVeyor's Visual Studio 2013 / 2015 are known to spuriously generate broken pch / pdb, like:
2020-04-14 02:08:24 -04:00
# error C2859: c:\projects\ruby\x64-mswin_120\include\ruby-2.8.0\x64-mswin64_120\rb_mjit_header-2.8.0.pdb
# is not the pdb file that was used when this precompiled header was created, recreate the precompiled header.
# https://ci.appveyor.com/project/ruby/ruby/builds/32159878/job/l2p38snw8yxxpp8h
#
# Until we figure out why, this allows us to skip testing JIT when it happens.
2020-05-03 03:41:27 -04:00
def appveyor_pdb_corrupted?
2020-04-14 02:48:39 -04:00
return false unless ENV . key? ( 'APPVEYOR' )
2020-04-18 21:39:32 -04:00
stdout , _stderr , _status = eval_with_jit_without_retry ( 'proc {}.call' , verbose : 2 , min_calls : 1 )
2020-05-03 03:41:27 -04:00
stdout . include? ( '.pdb is not the pdb file that was used when this precompiled header was created, recreate the precompiled header.' )
2020-04-14 02:08:24 -04:00
end
2018-04-28 05:22:07 -04:00
def remove_mjit_logs ( stderr )
2021-01-14 01:36:45 -05:00
if defined? ( RubyVM :: JIT ) && RubyVM :: JIT . enabled? # utility for -DFORCE_MJIT_ENABLE
2018-04-28 05:22:07 -04:00
stderr . gsub ( / ^MJIT warning: Skipped to compile unsupported instruction: \ w+ \ n /m , '' )
else
stderr
end
end
2018-08-09 05:58:07 -04:00
def code_block ( code )
2019-01-10 09:55:24 -05:00
%Q[ """ \n #{ code } \n """ \n \n ]
2018-08-09 05:58:07 -04:00
end
# We're retrying cc1 not found error on gcc, which should be solved in the future but ignored for now.
def retried_stderr? ( stderr )
RbConfig :: CONFIG [ 'CC' ] . start_with? ( 'gcc' ) &&
stderr . include? ( " error trying to exec 'cc1': execvp: No such file or directory " )
end
2018-02-22 10:11:12 -05:00
end