YJIT support for ruby 3.2

[seandilda]

YJIT currently works on the ruby 3.1 images, but not on the 3.2-preview images. It would be nice to have it enabled so that functionality isn't lost.

Starting with ruby 3.2, YJIT requires rust 1.58.1+ and using the --enable-yjit config option to be built into ruby. It also only works on the x86_64, arm64, and aarch64 platforms.

I started to update the Dockerfile.template to support this, but it turns out that alpine3.16 is the only build variant that ships with a new enough rust to support YJIT.

With the combination of limited build variants and limited platforms, what is the best way to support YJIT in this project? I didn't see a way to change which Dockerfile is used for each platform, but I'm not very familiar with the build infrastructure used by this project. If someone can point me in the right direction, I can put together a merge request.

[tianon]

Ah, this is a complicated one. 😞 😬

Maybe something like this? (Sorry, was easier to collect my thoughts via code than just looking at it 😅)

diff --git a/3.2-rc/alpine3.16/Dockerfile b/3.2-rc/alpine3.16/Dockerfile
index 08f210e..3f33acf 100644
--- a/3.2-rc/alpine3.16/Dockerfile
+++ b/3.2-rc/alpine3.16/Dockerfile
@@ -34,6 +34,11 @@ ENV RUBY_DOWNLOAD_SHA256 d3f5619de544240d92a5d03aa289e71bd1103379622c523a0e80ed0
 #   we purge system ruby later to make sure our final image uses what we just built
 RUN set -eux; \
 	\
+	yjit=; \
+	apkArch="$(apk --print-arch)"; \
+	case "$apkArch" in \
+		x86_64 | aarch64) yjit=1 ;; \
+	esac; \
 # readline-dev vs libedit-dev: https://bugs.ruby-lang.org/issues/11869 and https://github.com/docker-library/ruby/issues/75
 	apk add --no-cache --virtual .ruby-builddeps \
 		autoconf \
@@ -64,6 +69,7 @@ RUN set -eux; \
 		xz \
 		yaml-dev \
 		zlib-dev \
+		${yjit:+rust} \
 	; \
 	\
 	wget -O ruby.tar.xz "https://cache.ruby-lang.org/pub/ruby/${RUBY_MAJOR%-rc}/ruby-$RUBY_VERSION.tar.xz"; \
@@ -101,6 +107,7 @@ RUN set -eux; \
 		--build="$gnuArch" \
 		--disable-install-doc \
 		--enable-shared \
+		${yjit:+--enable-yjit} \
 	; \
 	make -j "$(nproc)"; \
 	make install; \
diff --git a/Dockerfile.template b/Dockerfile.template
index 16e1b33..e610059 100644
--- a/Dockerfile.template
+++ b/Dockerfile.template
@@ -4,6 +4,11 @@
 	;
 	def is_slim:
 		env.variant | startswith("slim-")
+	;
+	def should_yjit:
+		# https://github.com/docker-library/ruby/issues/390
+		([ "2.7", "3.0", "3.1" ] | index(env.version) | not)
+		and is_alpine and ([ "alpine3.15" ] | index(env.variant) | not)
 -}}
 {{ if is_alpine then ( -}}
 FROM alpine:{{ env.variant | ltrimstr("alpine") }}
@@ -59,6 +64,13 @@ ENV RUBY_DOWNLOAD_SHA256 {{ .sha256 }}
 RUN set -eux; \
 	\
 {{ if is_alpine then ( -}}
+{{ if should_yjit then ( -}}
+	yjit=; \
+	apkArch="$(apk --print-arch)"; \
+	case "$apkArch" in \
+		x86_64 | aarch64) yjit=1 ;; \
+	esac; \
+{{ ) else "" end -}}
 # readline-dev vs libedit-dev: https://bugs.ruby-lang.org/issues/11869 and https://github.com/docker-library/ruby/issues/75
 	apk add --no-cache --virtual .ruby-builddeps \
 		autoconf \
@@ -89,6 +101,9 @@ RUN set -eux; \
 		xz \
 		yaml-dev \
 		zlib-dev \
+{{ if should_yjit then ( -}}
+		${yjit:+rust} \
+{{ ) else "" end -}}
 	; \
 {{ ) else ( -}}
 	savedAptMark="$(apt-mark showmanual)"; \
@@ -152,7 +167,9 @@ RUN set -eux; \
 {{ if is_alpine and ( [ "2.7", "3.0" ] | index(env.version) ) then ( -}}
 	# fix builds on arm32v6/7 and s390x: https://github.com/docker-library/ruby/issues/308
 	# and don't break the other arches: https://github.com/docker-library/ruby/issues/365
+{{ if should_yjit then "" else ( -}}
 	apkArch="$(apk --print-arch)"; \
+{{ ) end -}}
 	case "$apkArch" in \
 		s390x | armhf | armv7) \
 			apk add --no-cache libucontext-dev; \
@@ -165,6 +182,9 @@ RUN set -eux; \
 		--build="$gnuArch" \
 		--disable-install-doc \
 		--enable-shared \
+{{ if should_yjit then ( -}}
+		${yjit:+--enable-yjit} \
+{{ ) else "" end -}}
 	; \
 	make -j "$(nproc)"; \
 	make install; \

This should make it reasonably straightforward to add Debian in the future once we get a release of Debian with a new enough Rust in it.

[seandilda]

Thanks for the quick response. That looks great, a lot more concise than what I was coming up with.

I don't think it'd be fair for me to put in a merge request when you did all the hard work. I'm very happy to see support for this added.

[tianon]

I stole your thunder so wanted to give you the first crack at making the PR! You pre-gave me all the info I needed to make it happen. 🙇

I'll get a PR up ASAP 👍

[rozhok]

YJIT support in Alpine is still missing. Is it something on the radar?

[yosifkit]

😕 The current image (ruby:alpine aka 3.2.2-alpine3.17) seems to work (trying out https://github.com/ruby/ruby/blob/5831f7c83177d6214aee1165df694bb4d4ae8ec6/doc/yjit/yjit.md#other-statistics):

Details

$ docker run -it --rm -e RUBYOPT="--yjit --yjit-stats" ruby:alpine
irb(main):001:0> RubyVM::YJIT.runtime_stats
=>
{:inline_code_size=>233281,
 :outlined_code_size=>232344,
 :freed_page_count=>0,
 :freed_code_size=>0,
 :live_page_count=>29,
 :code_gc_count=>0,
 :code_region_size=>471040,
 :all_stats=>true,
 :exec_instruction=>382327,
 :send_keywords=>0,
 :send_kw_splat=>0,
 :send_args_splat_super=>0,
 :send_iseq_zsuper=>0,
 :send_block_arg=>194,
 :send_ivar_set_method=>0,
 :send_zsuper_method=>0,
 :send_undef_method=>0,
 :send_optimized_method=>0,
 :send_optimized_method_call=>0,
 :send_optimized_method_block_call=>0,
 :send_call_block=>0,
 :send_call_kwarg=>0,
 :send_call_multi_ractor=>0,
 :send_missing_method=>0,
 :send_refined_method=>0,
 :send_cfunc_ruby_array_varg=>94,
 :send_cfunc_argc_mismatch=>0,
 :send_cfunc_toomany_args=>0,
 :send_cfunc_tracing=>0,
 :send_cfunc_kwargs=>0,
 :send_attrset_kwargs=>0,
 :send_iseq_tailcall=>0,
 :send_iseq_arity_error=>1,
 :send_iseq_only_keywords=>0,
 :send_iseq_kwargs_req_and_opt_missing=>0,
 :send_iseq_kwargs_mismatch=>0,
 :send_iseq_has_rest=>11,
 :send_iseq_has_post=>0,
 :send_iseq_has_kwrest=>0,
 :send_iseq_has_no_kw=>0,
 :send_iseq_accepts_no_kwarg=>0,
 :send_iseq_materialized_block=>0,
 :send_iseq_splat_with_opt=>0,
 :send_iseq_splat_with_kw=>0,
 :send_iseq_missing_optional_kw=>19,
 :send_iseq_too_many_kwargs=>0,
 :send_not_implemented_method=>0,
 :send_getter_arity=>0,
 :send_se_cf_overflow=>0,
 :send_se_protected_check_failed=>0,
 :send_splatarray_length_not_equal=>0,
 :send_splat_not_array=>0,
 :send_args_splat_non_iseq=>0,
 :send_args_splat_cfunc=>0,
 :send_iseq_ruby2_keywords=>0,
 :send_send_not_imm=>0,
 :send_send_wrong_args=>0,
 :send_send_null_mid=>0,
 :send_send_null_cme=>0,
 :send_send_nested=>0,
 :send_send_chain=>0,
 :send_send_chain_string=>0,
 :send_send_chain_not_string=>0,
 :send_send_chain_not_sym=>0,
 :send_send_chain_not_string_or_sym=>0,
 :send_send_getter=>0,
 :send_send_builtin=>0,
 :send_bmethod_ractor=>0,
 :send_bmethod_block_arg=>0,
 :traced_cfunc_return=>0,
 :invokesuper_me_changed=>0,
 :invokesuper_block=>0,
 :invokeblock_none=>0,
 :invokeblock_iseq_arg0_splat=>0,
 :invokeblock_iseq_block_changed=>0,
 :invokeblock_iseq_tag_changed=>375,
 :invokeblock_ifunc=>0,
 :invokeblock_proc=>77,
 :invokeblock_symbol=>0,
 :leave_se_interrupt=>0,
 :leave_interp_return=>10144,
 :leave_start_pc_non_zero=>23,
 :getivar_se_self_not_heap=>0,
 :getivar_idx_out_of_range=>0,
 :getivar_megamorphic=>0,
 :setivar_se_self_not_heap=>0,
 :setivar_idx_out_of_range=>0,
 :setivar_val_heapobject=>0,
 :setivar_name_not_mapped=>0,
 :setivar_not_object=>0,
 :setivar_frozen=>0,
 :oaref_argc_not_one=>0,
 :oaref_arg_not_fixnum=>0,
 :opt_getinlinecache_miss=>0,
 :expandarray_splat=>0,
 :expandarray_postarg=>0,
 :expandarray_not_array=>42,
 :expandarray_rhs_too_small=>0,
 :gbpp_block_param_modified=>0,
 :gbpp_block_handler_not_iseq=>0,
 :binding_allocations=>0,
 :binding_set=>0,
 :compiled_iseq_count=>249,
 :compiled_block_count=>2604,
 :compiled_branch_count=>4446,
 :compilation_failure=>0,
 :block_next_count=>1015,
 :defer_count=>888,
 :freed_iseq_count=>18,
 :exit_from_branch_stub=>0,
 :invalidation_count=>10,
 :invalidate_method_lookup=>0,
 :invalidate_bop_redefined=>0,
 :invalidate_ractor_spawn=>0,
 :invalidate_constant_state_bump=>8,
 :invalidate_constant_ic_fill=>2,
 :constant_state_bumps=>0,
 :exec_mem_non_bump_alloc=>29,
 :num_gc_obj_refs=>1624,
 :exit_nop=>0,
 :exit_getlocal=>0,
 :exit_setlocal=>0,
 :exit_getblockparam=>0,
 :exit_setblockparam=>0,
 :exit_getblockparamproxy=>0,
 :exit_getspecial=>0,
 :exit_setspecial=>0,
 :exit_getinstancevariable=>0,
 :exit_setinstancevariable=>0,
 :exit_getclassvariable=>0,
 :exit_setclassvariable=>0,
 :exit_opt_getconstant_path=>40,
 :exit_getconstant=>0,
 :exit_setconstant=>0,
 :exit_getglobal=>0,
 :exit_setglobal=>0,
 :exit_putnil=>0,
 :exit_putself=>0,
 :exit_putobject=>0,
 :exit_putspecialobject=>0,
 :exit_putstring=>0,
 :exit_concatstrings=>0,
 :exit_anytostring=>0,
 :exit_toregexp=>0,
 :exit_intern=>0,
 :exit_newarray=>0,
 :exit_newarraykwsplat=>0,
 :exit_duparray=>0,
 :exit_duphash=>0,
 :exit_expandarray=>42,
 :exit_concatarray=>0,
 :exit_splatarray=>0,
 :exit_newhash=>0,
 :exit_newrange=>0,
 :exit_pop=>0,
 :exit_dup=>0,
 :exit_dupn=>0,
 :exit_swap=>0,
 :exit_opt_reverse=>0,
 :exit_topn=>0,
 :exit_setn=>0,
 :exit_adjuststack=>0,
 :exit_defined=>0,
 :exit_checkmatch=>0,
 :exit_checkkeyword=>0,
 :exit_checktype=>0,
 :exit_defineclass=>25,
 :exit_definemethod=>0,
 :exit_definesmethod=>0,
 :exit_send=>194,
 :exit_opt_send_without_block=>131,
 :exit_objtostring=>0,
 :exit_opt_str_freeze=>0,
 :exit_opt_nil_p=>0,
 :exit_opt_str_uminus=>0,
 :exit_opt_newarray_max=>0,
 :exit_opt_newarray_min=>0,
 :exit_invokesuper=>0,
 :exit_invokeblock=>453,
 :exit_leave=>0,
 :exit_throw=>1725,
 :exit_jump=>0,
 :exit_branchif=>0,
 :exit_branchunless=>0,
 :exit_branchnil=>0,
 :exit_once=>0,
 :exit_opt_case_dispatch=>0,
 :exit_opt_plus=>0,
 :exit_opt_minus=>0,
 :exit_opt_mult=>0,
 :exit_opt_div=>0,
 :exit_opt_mod=>0,
 :exit_opt_eq=>2,
 :exit_opt_neq=>0,
 :exit_opt_lt=>0,
 :exit_opt_le=>0,
 :exit_opt_gt=>0,
 :exit_opt_ge=>0,
 :exit_opt_ltlt=>0,
 :exit_opt_and=>0,
 :exit_opt_or=>0,
 :exit_opt_aref=>0,
 :exit_opt_aset=>0,
 :exit_opt_aset_with=>0,
 :exit_opt_aref_with=>0,
 :exit_opt_length=>0,
 :exit_opt_size=>0,
 :exit_opt_empty_p=>0,
 :exit_opt_succ=>0,
 :exit_opt_not=>0,
 :exit_opt_regexpmatch2=>0,
 :exit_invokebuiltin=>0,
 :exit_opt_invokebuiltin_delegate=>0,
 :exit_opt_invokebuiltin_delegate_leave=>0,
 :exit_getlocal_WC_0=>0,
 :exit_getlocal_WC_1=>0,
 :exit_setlocal_WC_0=>0,
 :exit_setlocal_WC_1=>0,
 :exit_putobject_INT2FIX_0_=>0,
 :exit_putobject_INT2FIX_1_=>0,
 :exit_trace_nop=>0,
 :exit_trace_getlocal=>0,
 :exit_trace_setlocal=>0,
 :exit_trace_getblockparam=>0,
 :exit_trace_setblockparam=>0,
 :exit_trace_getblockparamproxy=>0,
 :exit_trace_getspecial=>0,
 :exit_trace_setspecial=>0,
 :exit_trace_getinstancevariable=>0,
 :exit_trace_setinstancevariable=>0,
 :exit_trace_getclassvariable=>0,
 :exit_trace_setclassvariable=>0,
 :exit_trace_opt_getconstant_path=>0,
 :exit_trace_getconstant=>0,
 :exit_trace_setconstant=>0,
 :exit_trace_getglobal=>0,
 :exit_trace_setglobal=>0,
 :exit_trace_putnil=>0,
 :exit_trace_putself=>0,
 :exit_trace_putobject=>0,
 :exit_trace_putspecialobject=>0,
 :exit_trace_putstring=>0,
 :exit_trace_concatstrings=>0,
 :exit_trace_anytostring=>0,
 :exit_trace_toregexp=>0,
 :exit_trace_intern=>0,
 :exit_trace_newarray=>0,
 :exit_trace_newarraykwsplat=>0,
 :exit_trace_duparray=>0,
 :exit_trace_duphash=>0,
 :exit_trace_expandarray=>0,
 :exit_trace_concatarray=>0,
 :exit_trace_splatarray=>0,
 :exit_trace_newhash=>0,
 :exit_trace_newrange=>0,
 :exit_trace_pop=>0,
 :exit_trace_dup=>0,
 :exit_trace_dupn=>0,
 :exit_trace_swap=>0,
 :exit_trace_opt_reverse=>0,
 :exit_trace_topn=>0,
 :exit_trace_setn=>0,
 :exit_trace_adjuststack=>0,
 :exit_trace_defined=>0,
 :exit_trace_checkmatch=>0,
 :exit_trace_checkkeyword=>0,
 :exit_trace_checktype=>0,
 :exit_trace_defineclass=>0,
 :exit_trace_definemethod=>0,
 :exit_trace_definesmethod=>0,
 :exit_trace_send=>0,
 :exit_trace_opt_send_without_block=>0,
 :exit_trace_objtostring=>0,
 :exit_trace_opt_str_freeze=>0,
 :exit_trace_opt_nil_p=>0,
 :exit_trace_opt_str_uminus=>0,
 :exit_trace_opt_newarray_max=>0,
 :exit_trace_opt_newarray_min=>0,
 :exit_trace_invokesuper=>0,
 :exit_trace_invokeblock=>0,
 :exit_trace_leave=>0,
 :exit_trace_throw=>0,
 :exit_trace_jump=>0,
 :exit_trace_branchif=>0,
 :exit_trace_branchunless=>0,
 :exit_trace_branchnil=>0,
 :exit_trace_once=>0,
 :exit_trace_opt_case_dispatch=>0,
 :exit_trace_opt_plus=>0,
 :exit_trace_opt_minus=>0,
 :exit_trace_opt_mult=>0,
 :exit_trace_opt_div=>0,
 :exit_trace_opt_mod=>0,
 :exit_trace_opt_eq=>0,
 :exit_trace_opt_neq=>0,
 :exit_trace_opt_lt=>0,
 :exit_trace_opt_le=>0,
 :exit_trace_opt_gt=>0,
 :exit_trace_opt_ge=>0,
 :exit_trace_opt_ltlt=>0,
 :exit_trace_opt_and=>0,
 :exit_trace_opt_or=>0,
 :exit_trace_opt_aref=>0,
 :exit_trace_opt_aset=>0,
 :exit_trace_opt_aset_with=>0,
 :exit_trace_opt_aref_with=>0,
 :exit_trace_opt_length=>0,
 :exit_trace_opt_size=>0,
 :exit_trace_opt_empty_p=>0,
 :exit_trace_opt_succ=>0,
 :exit_trace_opt_not=>0,
 :exit_trace_opt_regexpmatch2=>0,
 :exit_trace_invokebuiltin=>0,
 :exit_trace_opt_invokebuiltin_delegate=>0,
 :exit_trace_opt_invokebuiltin_delegate_leave=>0,
 :exit_trace_getlocal_WC_0=>0,
 :exit_trace_getlocal_WC_1=>0,
 :exit_trace_setlocal_WC_0=>0,
 :exit_trace_setlocal_WC_1=>0,
 :exit_trace_putobject_INT2FIX_0_=>0,
 :exit_trace_putobject_INT2FIX_1_=>0,
 :object_shape_count=>598,
 :side_exit_count=>2612,
 :total_exit_count=>12756,
 :avg_len_in_yjit=>29.76756036375039}

[rozhok]

@yosifkit my bad, used wrong env var. Everything works, thank you!