Add BlockParamProxyModified side exit, fixes bug

Author: luke-gruber

zjit/src/codegen_tests.rs

@@ -644,6 +644,28 @@ fn test_block_param_proxy_iseq_guard_miss_recompiles() {
     assert_snapshot!(assert_compiles_allowing_exits("[invoke { |x| x + 1 }, invoke { 1000 }]"), @"[42, 1000]");
 }
 
+#[test]
+fn test_block_param_proxy_call_reassigned_when_no_block() {
+    // Regression: `blk ||= proc {...}` reassigns the block param when no block is passed, so
+    // getblockparamproxy takes its modified path and returns the reassigned proc, not the proxy.
+    // That path loads the local with no handler guard and feeds it to blk.call, which lowers to
+    // InvokeBlockParam here (the arity-mismatched `.call(41)` against a no-param block is not
+    // inlinable). Without the receiver identity guard, InvokeBlockParam yields the (absent) frame
+    // block and raises LocalJumpError. The guard must miss and recompile as a generic send.
+    set_call_threshold(2);
+    eval("
+        def invoke(&blk)
+          blk ||= proc { 2000 }
+          r = nil
+          [1].each { r = blk.call(41) }
+          r
+        end
+        invoke { 1000 }
+        invoke { 1000 }
+    ");
+    assert_snapshot!(assert_compiles_allowing_exits("[invoke { 1000 }, invoke]"), @"[1000, 2000]");
+}
+
 #[test]
 fn test_yield_iseq_guard_miss_recompiles() {
     set_call_threshold(2);

zjit/src/hir.rs

@@ -555,6 +555,7 @@ pub enum SideExitReason {
     BlockParamProxyProfileNotCovered,
     BlockParamProxyHandlerNotIseq,
     BlockParamProxyIseqChanged,
+    BlockParamProxyModified,
     BlockParamWbRequired,
     StackOverflow,
     FixnumModByZero,
@@ -4203,6 +4204,13 @@ impl Function {
                                         self.set_dynamic_send_reason(insn_id, SendWithoutBlockNotOptimizedMethodTypeOptimized(OptimizedMethodType::BlockCall));
                                         self.push_insn_id(block, insn_id); continue;
                                     }
+                                    self.push_insn(block, Insn::GuardBitEquals {
+                                        val: recv,
+                                        expected: Const::Value(unsafe { rb_block_param_proxy }),
+                                        reason: SideExitReason::BlockParamProxyModified,
+                                        state,
+                                        recompile: Some(Recompile),
+                                    });
                                     // if the block is a known simple ISEQ block with exact arity and no non-local
                                     // exit, push its frame inline instead of calling vm_yield.
                                     let inline_iseq = self.block_param_proxy_iseqs.get(&recv).copied()

zjit/src/hir/opt_tests.rs

@@ -3844,19 +3844,20 @@ mod hir_opt_tests {
           Jump bb8(v41, v51)
         bb8(v31:BasicObject, v32:BasicObject):
           PatchPoint BOPRedefined(4096, BOP_CALL)
-          v57:CPtr = GetEP 0
-          v58:CInt64 = LoadField v57, :VM_ENV_DATA_INDEX_SPECVAL@0x1042
-          v59:CInt64[3] = Const CInt64(3)
-          v60:CInt64 = IntAnd v58, v59
-          v61:CInt64[1] = GuardBitEquals v60, CInt64(1) recompile
-          v62:CInt64[-4] = Const CInt64(-4)
-          v63:CInt64 = IntAnd v58, v62
-          v64:CPtr = LoadField v63, :code_iseq@0x1050
-          v65:CPtr[CPtr(0x1051)] = GuardBitEquals v64, CPtr(0x1051) recompile
-          v66:BasicObject = InvokeBlockIseqDirect (0x1038), v63, v11, v13
+          v57:ObjectSubclass[BlockParamProxy] = GuardBitEquals v31, Value(VALUE(0x1048)) recompile
+          v58:CPtr = GetEP 0
+          v59:CInt64 = LoadField v58, :VM_ENV_DATA_INDEX_SPECVAL@0x1042
+          v60:CInt64[3] = Const CInt64(3)
+          v61:CInt64 = IntAnd v59, v60
+          v62:CInt64[1] = GuardBitEquals v61, CInt64(1) recompile
+          v63:CInt64[-4] = Const CInt64(-4)
+          v64:CInt64 = IntAnd v59, v63
+          v65:CPtr = LoadField v64, :code_iseq@0x1050
+          v66:CPtr[CPtr(0x1051)] = GuardBitEquals v65, CPtr(0x1051) recompile
+          v67:BasicObject = InvokeBlockIseqDirect (0x1038), v64, v11, v13
           CheckInterrupts
           PopInlineFrame
-          Return v66
+          Return v67
         ");
     }
 
@@ -3898,19 +3899,20 @@ mod hir_opt_tests {
           Jump bb8(v35, v43)
         bb8(v25:BasicObject, v26:BasicObject):
           PatchPoint BOPRedefined(4096, BOP_CALL)
-          v49:CPtr = GetEP 0
-          v50:CInt64 = LoadField v49, :VM_ENV_DATA_INDEX_SPECVAL@0x1042
-          v51:CInt64[3] = Const CInt64(3)
-          v52:CInt64 = IntAnd v50, v51
-          v53:CInt64[1] = GuardBitEquals v52, CInt64(1) recompile
-          v54:CInt64[-4] = Const CInt64(-4)
-          v55:CInt64 = IntAnd v50, v54
-          v56:CPtr = LoadField v55, :code_iseq@0x1050
-          v57:CPtr[CPtr(0x1051)] = GuardBitEquals v56, CPtr(0x1051) recompile
-          v58:BasicObject = InvokeBlockIseqDirect (0x1038), v55
+          v49:ObjectSubclass[BlockParamProxy] = GuardBitEquals v25, Value(VALUE(0x1048)) recompile
+          v50:CPtr = GetEP 0
+          v51:CInt64 = LoadField v50, :VM_ENV_DATA_INDEX_SPECVAL@0x1042
+          v52:CInt64[3] = Const CInt64(3)
+          v53:CInt64 = IntAnd v51, v52
+          v54:CInt64[1] = GuardBitEquals v53, CInt64(1) recompile
+          v55:CInt64[-4] = Const CInt64(-4)
+          v56:CInt64 = IntAnd v51, v55
+          v57:CPtr = LoadField v56, :code_iseq@0x1050
+          v58:CPtr[CPtr(0x1051)] = GuardBitEquals v57, CPtr(0x1051) recompile
+          v59:BasicObject = InvokeBlockIseqDirect (0x1038), v56
           CheckInterrupts
           PopInlineFrame
-          Return v58
+          Return v59
         ");
     }
 
@@ -3955,19 +3957,20 @@ mod hir_opt_tests {
           v38:ArrayExact[VALUE(0x1050)] = Const Value(VALUE(0x1050))
           v39:ArrayExact = ArrayDup v38
           PatchPoint BOPRedefined(4096, BOP_CALL)
-          v52:CPtr = GetEP 0
-          v53:CInt64 = LoadField v52, :VM_ENV_DATA_INDEX_SPECVAL@0x1042
-          v54:CInt64[3] = Const CInt64(3)
-          v55:CInt64 = IntAnd v53, v54
-          v56:CInt64[1] = GuardBitEquals v55, CInt64(1) recompile
-          v57:CInt64[-4] = Const CInt64(-4)
-          v58:CInt64 = IntAnd v53, v57
-          v59:CPtr = LoadField v58, :code_iseq@0x1058
-          v60:CPtr[CPtr(0x1059)] = GuardBitEquals v59, CPtr(0x1059) recompile
-          v61:BasicObject = InvokeBlockIseqDirect (0x1038), v58, v39
+          v52:ObjectSubclass[BlockParamProxy] = GuardBitEquals v25, Value(VALUE(0x1048)) recompile
+          v53:CPtr = GetEP 0
+          v54:CInt64 = LoadField v53, :VM_ENV_DATA_INDEX_SPECVAL@0x1042
+          v55:CInt64[3] = Const CInt64(3)
+          v56:CInt64 = IntAnd v54, v55
+          v57:CInt64[1] = GuardBitEquals v56, CInt64(1) recompile
+          v58:CInt64[-4] = Const CInt64(-4)
+          v59:CInt64 = IntAnd v54, v58
+          v60:CPtr = LoadField v59, :code_iseq@0x1058
+          v61:CPtr[CPtr(0x1059)] = GuardBitEquals v60, CPtr(0x1059) recompile
+          v62:BasicObject = InvokeBlockIseqDirect (0x1038), v59, v39
           CheckInterrupts
           PopInlineFrame
-          Return v61
+          Return v62
         ");
     }
 
@@ -4010,19 +4013,20 @@ mod hir_opt_tests {
           Jump bb8(v35, v43)
         bb8(v25:BasicObject, v26:BasicObject):
           PatchPoint BOPRedefined(4096, BOP_CALL)
-          v49:CPtr = GetEP 0
-          v50:CInt64 = LoadField v49, :VM_ENV_DATA_INDEX_SPECVAL@0x1042
-          v51:CInt64[3] = Const CInt64(3)
-          v52:CInt64 = IntAnd v50, v51
-          v53:CInt64[1] = GuardBitEquals v52, CInt64(1) recompile
-          v54:CInt64[-4] = Const CInt64(-4)
-          v55:CInt64 = IntAnd v50, v54
-          v56:CPtr = LoadField v55, :code_iseq@0x1050
-          v57:CPtr[CPtr(0x1051)] = GuardBitEquals v56, CPtr(0x1051) recompile
-          v58:BasicObject = InvokeBlockIseqDirect (0x1038), v55
+          v49:ObjectSubclass[BlockParamProxy] = GuardBitEquals v25, Value(VALUE(0x1048)) recompile
+          v50:CPtr = GetEP 0
+          v51:CInt64 = LoadField v50, :VM_ENV_DATA_INDEX_SPECVAL@0x1042
+          v52:CInt64[3] = Const CInt64(3)
+          v53:CInt64 = IntAnd v51, v52
+          v54:CInt64[1] = GuardBitEquals v53, CInt64(1) recompile
+          v55:CInt64[-4] = Const CInt64(-4)
+          v56:CInt64 = IntAnd v51, v55
+          v57:CPtr = LoadField v56, :code_iseq@0x1050
+          v58:CPtr[CPtr(0x1051)] = GuardBitEquals v57, CPtr(0x1051) recompile
+          v59:BasicObject = InvokeBlockIseqDirect (0x1038), v56
           CheckInterrupts
           PopInlineFrame
-          Return v58
+          Return v59
         ");
     }
 
@@ -4075,20 +4079,21 @@ mod hir_opt_tests {
           Jump bb8(v46, v54)
         bb8(v36:BasicObject, v37:BasicObject):
           PatchPoint BOPRedefined(4096, BOP_CALL)
-          v60:CPtr = GetEP 0
-          v61:CInt64 = LoadField v60, :VM_ENV_DATA_INDEX_SPECVAL@0x1042
-          v62:CInt64[3] = Const CInt64(3)
-          v63:CInt64 = IntAnd v61, v62
-          v64:CInt64[1] = GuardBitEquals v63, CInt64(1) recompile
-          v65:CInt64[-4] = Const CInt64(-4)
-          v66:CInt64 = IntAnd v61, v65
-          v67:CPtr = LoadField v66, :code_iseq@0x1050
-          v68:CPtr[CPtr(0x1051)] = GuardBitEquals v67, CPtr(0x1051) recompile
-          v69:BasicObject = InvokeBlockIseqDirect (0x1038), v66
+          v60:ObjectSubclass[BlockParamProxy] = GuardBitEquals v36, Value(VALUE(0x1048)) recompile
+          v61:CPtr = GetEP 0
+          v62:CInt64 = LoadField v61, :VM_ENV_DATA_INDEX_SPECVAL@0x1042
+          v63:CInt64[3] = Const CInt64(3)
+          v64:CInt64 = IntAnd v62, v63
+          v65:CInt64[1] = GuardBitEquals v64, CInt64(1) recompile
+          v66:CInt64[-4] = Const CInt64(-4)
+          v67:CInt64 = IntAnd v62, v66
+          v68:CPtr = LoadField v67, :code_iseq@0x1050
+          v69:CPtr[CPtr(0x1051)] = GuardBitEquals v68, CPtr(0x1051) recompile
+          v70:BasicObject = InvokeBlockIseqDirect (0x1038), v67
           CheckInterrupts
           PopInlineFrame
           PatchPoint NoEPEscape(test)
-          Return v69
+          Return v70
         ");
     }
 
@@ -4131,19 +4136,20 @@ mod hir_opt_tests {
           Jump bb8(v35, v43)
         bb8(v25:BasicObject, v26:BasicObject):
           PatchPoint BOPRedefined(4096, BOP_CALL)
-          v49:CPtr = GetEP 0
-          v50:CInt64 = LoadField v49, :VM_ENV_DATA_INDEX_SPECVAL@0x1042
-          v51:CInt64[3] = Const CInt64(3)
-          v52:CInt64 = IntAnd v50, v51
-          v53:CInt64[1] = GuardBitEquals v52, CInt64(1) recompile
-          v54:CInt64[-4] = Const CInt64(-4)
-          v55:CInt64 = IntAnd v50, v54
-          v56:CPtr = LoadField v55, :code_iseq@0x1050
-          v57:CPtr[CPtr(0x1051)] = GuardBitEquals v56, CPtr(0x1051) recompile
-          v58:BasicObject = InvokeBlockIseqDirect (0x1038), v55
+          v49:ObjectSubclass[BlockParamProxy] = GuardBitEquals v25, Value(VALUE(0x1048)) recompile
+          v50:CPtr = GetEP 0
+          v51:CInt64 = LoadField v50, :VM_ENV_DATA_INDEX_SPECVAL@0x1042
+          v52:CInt64[3] = Const CInt64(3)
+          v53:CInt64 = IntAnd v51, v52
+          v54:CInt64[1] = GuardBitEquals v53, CInt64(1) recompile
+          v55:CInt64[-4] = Const CInt64(-4)
+          v56:CInt64 = IntAnd v51, v55
+          v57:CPtr = LoadField v56, :code_iseq@0x1050
+          v58:CPtr[CPtr(0x1051)] = GuardBitEquals v57, CPtr(0x1051) recompile
+          v59:BasicObject = InvokeBlockIseqDirect (0x1038), v56
           CheckInterrupts
           PopInlineFrame
-          Return v58
+          Return v59
         ");
     }
 
@@ -4189,10 +4195,11 @@ mod hir_opt_tests {
           v38:ArrayExact[VALUE(0x1050)] = Const Value(VALUE(0x1050))
           v39:ArrayExact = ArrayDup v38
           PatchPoint BOPRedefined(4096, BOP_CALL)
-          v52:BasicObject = InvokeBlockParam v39
+          v52:ObjectSubclass[BlockParamProxy] = GuardBitEquals v25, Value(VALUE(0x1048)) recompile
+          v53:BasicObject = InvokeBlockParam v39
           CheckInterrupts
           PopInlineFrame
-          Return v52
+          Return v53
         ");
     }
 
@@ -4236,10 +4243,11 @@ mod hir_opt_tests {
         bb8(v25:BasicObject, v26:BasicObject):
           v38:Fixnum[9] = Const Value(9)
           PatchPoint BOPRedefined(4096, BOP_CALL)
-          v51:BasicObject = InvokeBlockParam v38
+          v51:ObjectSubclass[BlockParamProxy] = GuardBitEquals v25, Value(VALUE(0x1048)) recompile
+          v52:BasicObject = InvokeBlockParam v38
           CheckInterrupts
           PopInlineFrame
-          Return v51
+          Return v52
         ");
     }
 
@@ -4282,10 +4290,11 @@ mod hir_opt_tests {
           Jump bb8(v35, v43)
         bb8(v25:BasicObject, v26:BasicObject):
           PatchPoint BOPRedefined(4096, BOP_CALL)
-          v49:BasicObject = InvokeBlockParam
+          v49:ObjectSubclass[BlockParamProxy] = GuardBitEquals v25, Value(VALUE(0x1048)) recompile
+          v50:BasicObject = InvokeBlockParam
           CheckInterrupts
           PopInlineFrame
-          Return v49
+          Return v50
         ");
     }
 
@@ -4331,7 +4340,8 @@ mod hir_opt_tests {
           Jump bb8(v39, v47)
         bb8(v29:BasicObject, v30:BasicObject):
           PatchPoint BOPRedefined(4096, BOP_CALL)
-          v53:BasicObject = InvokeBlockParam
+          v53:ObjectSubclass[BlockParamProxy] = GuardBitEquals v29, Value(VALUE(0x1048)) recompile
+          v54:BasicObject = InvokeBlockParam
           CheckInterrupts
           PopInlineFrame
           v15:Fixnum[99] = Const Value(99)
@@ -19788,20 +19798,21 @@ mod hir_opt_tests {
           Jump bb8(v43, v52)
         bb8(v33:BasicObject, v34:BasicObject):
           PatchPoint BOPRedefined(4096, BOP_CALL)
-          v58:CPtr = GetEP 0
-          v59:CInt64 = LoadField v58, :VM_ENV_DATA_INDEX_SPECVAL@0x104a
-          v60:CInt64[3] = Const CInt64(3)
-          v61:CInt64 = IntAnd v59, v60
-          v62:CInt64[1] = GuardBitEquals v61, CInt64(1) recompile
-          v63:CInt64[-4] = Const CInt64(-4)
-          v64:CInt64 = IntAnd v59, v63
-          v65:CPtr = LoadField v64, :code_iseq@0x1058
-          v66:CPtr[CPtr(0x1059)] = GuardBitEquals v65, CPtr(0x1059) recompile
-          v67:BasicObject = InvokeBlockIseqDirect (0x1040), v64, v10
+          v58:ObjectSubclass[BlockParamProxy] = GuardBitEquals v33, Value(VALUE(0x1050)) recompile
+          v59:CPtr = GetEP 0
+          v60:CInt64 = LoadField v59, :VM_ENV_DATA_INDEX_SPECVAL@0x104a
+          v61:CInt64[3] = Const CInt64(3)
+          v62:CInt64 = IntAnd v60, v61
+          v63:CInt64[1] = GuardBitEquals v62, CInt64(1) recompile
+          v64:CInt64[-4] = Const CInt64(-4)
+          v65:CInt64 = IntAnd v60, v64
+          v66:CPtr = LoadField v65, :code_iseq@0x1058
+          v67:CPtr[CPtr(0x1059)] = GuardBitEquals v66, CPtr(0x1059) recompile
+          v68:BasicObject = InvokeBlockIseqDirect (0x1040), v65, v10
           CheckInterrupts
           PopInlineFrame
           PatchPoint NoEPEscape(test)
-          Return v67
+          Return v68
         ");
     }
 

zjit/src/stats.rs

@@ -233,6 +233,7 @@ make_counters! {
         exit_block_param_proxy_profile_not_covered,
         exit_block_param_proxy_handler_not_iseq,
         exit_block_param_proxy_iseq_changed,
+        exit_block_param_proxy_modified,
         exit_block_param_wb_required,
         exit_too_many_keyword_parameters,
         exit_too_many_args_for_lir,
@@ -639,6 +640,7 @@ pub fn side_exit_counter(reason: crate::hir::SideExitReason) -> Counter {
         BlockParamProxyProfileNotCovered => exit_block_param_proxy_profile_not_covered,
         BlockParamProxyHandlerNotIseq => exit_block_param_proxy_handler_not_iseq,
         BlockParamProxyIseqChanged    => exit_block_param_proxy_iseq_changed,
+        BlockParamProxyModified       => exit_block_param_proxy_modified,
         BlockParamWbRequired          => exit_block_param_wb_required,
         TooManyKeywordParameters      => exit_too_many_keyword_parameters,
         TooManyArgsForLir             => exit_too_many_args_for_lir,