JIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstReg - #126133

Closed
mangod9 with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-passing-variable-tags-parameters-test-again
Closed

JIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstReg#126133
mangod9 with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-passing-variable-tags-parameters-test-again

Conversation

CopilotAI commented Mar 25, 2026

Copy link
Copy Markdown
Contributor

MetricsTests.PassingVariableTagsParametersTest fails under JitStress=2 + JitStressRegs={2,0x80} on Linux x64 because the JIT emits incorrect code for GC-aware block copies (CpObjUnroll) when the LSRA allocates the source address to the same register required for the destination (rdi).

Description

Bug:genConsumeBlockOp unconditionally performs the destination move before the source move. When the source address is in dstReg, this silently overwrites it:

; LSRA under stress: srcAddr=rdi, dstAddr=rax
mov rdi, rax ; dst → dstReg — clobbers srcAddr already in rdi!
mov rsi, rdi ; src → srcReg — copies destination value, not source!

Fix (src/coreclr/jit/codegenlinear.cpp, genConsumeBlockOp):

  • When the source address (from a GT_IND CopyBlk) is currently in dstReg, emit the source move to srcRegfirst, then move the destination to dstReg.
  • Add assert(dstAddr->GetRegNum() != srcReg) to guard the unhandled cyclic-swap case (srcAddr in dstReg and dstAddr in srcReg simultaneously), which would need a temp register. The assert makes this fail loudly rather than silently corrupting data.
  • Update the existing comment that incorrectly claimed the LSRA always guarantees interference-free copies to required registers in execution order — this bug disproves that claim.

The fix is generic: it applies to all architectures that use genConsumeBlockOp with fixed destination/source register requirements (REG_RDI/REG_RSI on x64, REG_WRITE_BARRIER_DST_BYREF/REG_WRITE_BARRIER_SRC_BYREF on ARM64/LoongArch64/RISCV64).

Original prompt

This section details on the original issue you should resolve

<issue_title>Test failure: System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest</issue_title>
<issue_description>Failed in:runtime-coreclr libraries-jitstress2-jitstressregs 20260307.1

Failed tests:

net11.0-linux-Release-x64-jitstress2_jitstressregs2-AzureLinux.3.Amd64.Open
- System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest
net11.0-linux-Release-x64-jitstress2_jitstressregs0x80-AzureLinux.3.Amd64.Open
- System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest

Error message:

Microsoft.DotNet.RemoteExecutor.RemoteExecutionException : Remote process failed with an unhandled exception.

Stack trace:


Child exception:
Xunit.Sdk.EqualException: Assert.Equal() Failure: Collections differ
↓ (pos 0)
Expected: [["K1"] = "V1", ["K2"] = "V2", ["K3"] = "V3", ["K4"] = "V4", ["K5"] = "V5", ···]
Actual: [[null] = null, ["K2"] = "V2", ["K3"] = "V3", ["K4"] = "V4", ["K5"] = "V5", ···]
↑ (pos 0)
at System.Diagnostics.Metrics.Tests.MetricsTests.<>c__DisplayClass32_0`1.<InstrumentPassingVariableTagsParametersTest>b__1(Instrument inst, T measurement, ReadOnlySpan`1 tags, Object state) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 1965
at System.Diagnostics.Metrics.Instrument`1.RecordMeasurement(T measurement, ReadOnlySpan`1 tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/src/System/Diagnostics/Metrics/Instrument.common.cs:line 99
at System.Diagnostics.Metrics.Tests.MetricsTests.PublishCounterMeasurement[T](Counter`1 counter, T value, KeyValuePair`2[] tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 1791
at System.Diagnostics.Metrics.Tests.MetricsTests.<PassingVariableTagsParametersTest>b__10_3(Instrument`1 instrument, Int32 value, KeyValuePair`2[] tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 751
at System.Diagnostics.Metrics.Tests.MetricsTests.InstrumentPassingVariableTagsParametersTest[T](Instrument`1 instrument, Func`4 record) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 2015
at System.Diagnostics.Metrics.Tests.MetricsTests.<PassingVariableTagsParametersTest>b__10_0() in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 749
at System.Reflection.MethodBaseInvoker.InterpretedInvoke_Method(Object obj, IntPtr* args) in /_/src/coreclr/System.Private.CoreLib/src/System/Reflection/MethodBaseInvoker.CoreCLR.cs:line 36
at System.Reflection.MethodBaseInvoker.InvokeWithNoArgs(Object obj, BindingFlags invokeAttr) in /_/src/libraries/System.Private.CoreLib/src/System/Reflection/MethodBaseInvoker.cs:line 57
Child process:
System.Diagnostics.DiagnosticSource.Tests, Version=11.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51 System.Diagnostics.Metrics.Tests.MetricsTests Void <PassingVariableTagsParametersTest>b__10_0()
```</issue_description>
<agent_instructions>Please make a fix based on the analysis on the issue. </agent_instructions>
## Comments on the Issue (you are @copilot in this section)
<comments>
<comment_new><author>@mangod9</author><body>
Here is some copilot analysis for this failure:
```text Crash Context
┌────────────┬───────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Field │ Value │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Build │ runtime-coreclr libraries-jitstress2-jitstressregs 20260307.1 │
│ │ (https://dev.azure.com/dnceng-public/cbb18261-c48f-4abb-8651-8cdcb5474649/_buil │
│ │ d/results?buildId=1324993) │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Helix Job │ 3f3cc108-6550-42e6-80a5-5e70ed9c556a │
│ (regs2) │ │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Helix Job │ acfbbeb5-9555-4c5b-b5ea-892f475ef22b │
│ (regs0x80) │ │
├────────────┼───────────────────────────────────────────────────────────────────────...
</details>
<!-- START COPILOT CODING AGENT SUFFIX -->
- Fixes dotnet/runtime#125312
<!-- START COPILOT CODING AGENT TIPS -->
---
⌨️ Start Copilot coding agent tasks without leaving your editor — available in [VS Code](https://gh.io/cca-vs-code-docs), [Visual Studio](https://gh.io/cca-visual-studio-docs), [JetBrains IDEs](https://gh.io/cca-jetbrains-docs) and [Eclipse](https://gh.io/cca-eclipse-docs).

@github-actionsgithub-actionsBot added the area-CodeGen-coreclr CLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI label Mar 25, 2026
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @JulieLeeMSFT, @jakobbotsch
See info in area-owners.md if you want to be subscribed.

When the LSRA allocates the source address to the same register that
the destination address needs (dstReg), the original code would
incorrectly clobber the source address by copying the destination first:
mov rdi, rax ; dst -> dstReg (CLOBBERS srcAddr already in rdi!)
mov rsi, rdi ; src -> srcReg (copies destination, not source!)
Fix by detecting this case and moving the source to srcReg first when
srcAddr is currently in dstReg. Also update the existing comment which
incorrectly claimed the LSRA always guarantees safe copy ordering, and
add an assert to catch the unhandled swap case (srcAddr in dstReg AND
dstAddr in srcReg simultaneously) which would produce incorrect code.
Fixes: System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest
under JitStress=2 + JitStressRegs={2,0x80} on Linux x64.
Co-authored-by: mangod9 <61718172+mangod9@users.noreply.github.com>
Agent-Logs-Url: https://github.com/dotnet/runtime/sessions/1b13221b-a0c1-4742-8445-5ada9974b0de
CopilotAI changed the title [WIP] Fix test failure in PassingVariableTagsParametersTestJIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstRegMar 25, 2026
CopilotAI requested a review from mangod9March 25, 2026 23:48
@jakobbotsch

Copy link
Copy Markdown
Member

I don't think this is the right fix. Likely what I am working on in #125333 will fix this in a better way.

@mangod9

Copy link
Copy Markdown
Member

Ok will close this PR then if you are already working on a fix. Thx!

@mangod9

Copy link
Copy Markdown
Member

btw @jakobbotsch is the analysis on the issue incorrect or the proposed fix is not complete. Looks like as part of the analysis it validated the fix worked for a sample test case it had built.

@jakobbotsch

Copy link
Copy Markdown
Member

btw @jakobbotsch is the analysis on the issue incorrect or the proposed fix is not complete. Looks like as part of the analysis it validated the fix worked for a sample test case it had built.

The fix is not sufficient -- there is nothing that prevents the case that the comment is mentioning:

 // Note: a true swap (srcAddr in dstReg AND dstAddr in srcReg) would require a temporary
// register, but the register allocator should prevent this by ensuring at most one of the
// two operands ends up in the other's required register.

@jakobbotsch
jakobbotsch deleted the copilot/fix-passing-variable-tags-parameters-test-again branch April 20, 2026 11:21
@github-actionsgithub-actionsBot locked and limited conversation to collaborators May 21, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-CodeGen-coreclrCLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@jakobbotsch@mangod9
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

JIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstReg - #126133

Closed
mangod9 with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-passing-variable-tags-parameters-test-again
Closed

JIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstReg#126133
mangod9 with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-passing-variable-tags-parameters-test-again

Conversation

CopilotAI commented Mar 25, 2026

Copy link
Copy Markdown
Contributor

MetricsTests.PassingVariableTagsParametersTest fails under JitStress=2 + JitStressRegs={2,0x80} on Linux x64 because the JIT emits incorrect code for GC-aware block copies (CpObjUnroll) when the LSRA allocates the source address to the same register required for the destination (rdi).

Description

Bug:genConsumeBlockOp unconditionally performs the destination move before the source move. When the source address is in dstReg, this silently overwrites it:

; LSRA under stress: srcAddr=rdi, dstAddr=rax
mov rdi, rax ; dst → dstReg — clobbers srcAddr already in rdi!
mov rsi, rdi ; src → srcReg — copies destination value, not source!

Fix (src/coreclr/jit/codegenlinear.cpp, genConsumeBlockOp):

  • When the source address (from a GT_IND CopyBlk) is currently in dstReg, emit the source move to srcRegfirst, then move the destination to dstReg.
  • Add assert(dstAddr->GetRegNum() != srcReg) to guard the unhandled cyclic-swap case (srcAddr in dstReg and dstAddr in srcReg simultaneously), which would need a temp register. The assert makes this fail loudly rather than silently corrupting data.
  • Update the existing comment that incorrectly claimed the LSRA always guarantees interference-free copies to required registers in execution order — this bug disproves that claim.

The fix is generic: it applies to all architectures that use genConsumeBlockOp with fixed destination/source register requirements (REG_RDI/REG_RSI on x64, REG_WRITE_BARRIER_DST_BYREF/REG_WRITE_BARRIER_SRC_BYREF on ARM64/LoongArch64/RISCV64).

Original prompt

This section details on the original issue you should resolve

<issue_title>Test failure: System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest</issue_title>
<issue_description>Failed in:runtime-coreclr libraries-jitstress2-jitstressregs 20260307.1

Failed tests:

net11.0-linux-Release-x64-jitstress2_jitstressregs2-AzureLinux.3.Amd64.Open
- System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest
net11.0-linux-Release-x64-jitstress2_jitstressregs0x80-AzureLinux.3.Amd64.Open
- System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest

Error message:

Microsoft.DotNet.RemoteExecutor.RemoteExecutionException : Remote process failed with an unhandled exception.

Stack trace:


Child exception:
Xunit.Sdk.EqualException: Assert.Equal() Failure: Collections differ
↓ (pos 0)
Expected: [["K1"] = "V1", ["K2"] = "V2", ["K3"] = "V3", ["K4"] = "V4", ["K5"] = "V5", ···]
Actual: [[null] = null, ["K2"] = "V2", ["K3"] = "V3", ["K4"] = "V4", ["K5"] = "V5", ···]
↑ (pos 0)
at System.Diagnostics.Metrics.Tests.MetricsTests.<>c__DisplayClass32_0`1.<InstrumentPassingVariableTagsParametersTest>b__1(Instrument inst, T measurement, ReadOnlySpan`1 tags, Object state) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 1965
at System.Diagnostics.Metrics.Instrument`1.RecordMeasurement(T measurement, ReadOnlySpan`1 tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/src/System/Diagnostics/Metrics/Instrument.common.cs:line 99
at System.Diagnostics.Metrics.Tests.MetricsTests.PublishCounterMeasurement[T](Counter`1 counter, T value, KeyValuePair`2[] tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 1791
at System.Diagnostics.Metrics.Tests.MetricsTests.<PassingVariableTagsParametersTest>b__10_3(Instrument`1 instrument, Int32 value, KeyValuePair`2[] tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 751
at System.Diagnostics.Metrics.Tests.MetricsTests.InstrumentPassingVariableTagsParametersTest[T](Instrument`1 instrument, Func`4 record) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 2015
at System.Diagnostics.Metrics.Tests.MetricsTests.<PassingVariableTagsParametersTest>b__10_0() in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 749
at System.Reflection.MethodBaseInvoker.InterpretedInvoke_Method(Object obj, IntPtr* args) in /_/src/coreclr/System.Private.CoreLib/src/System/Reflection/MethodBaseInvoker.CoreCLR.cs:line 36
at System.Reflection.MethodBaseInvoker.InvokeWithNoArgs(Object obj, BindingFlags invokeAttr) in /_/src/libraries/System.Private.CoreLib/src/System/Reflection/MethodBaseInvoker.cs:line 57
Child process:
System.Diagnostics.DiagnosticSource.Tests, Version=11.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51 System.Diagnostics.Metrics.Tests.MetricsTests Void <PassingVariableTagsParametersTest>b__10_0()
```</issue_description>
<agent_instructions>Please make a fix based on the analysis on the issue. </agent_instructions>
## Comments on the Issue (you are @copilot in this section)
<comments>
<comment_new><author>@mangod9</author><body>
Here is some copilot analysis for this failure:
```text Crash Context
┌────────────┬───────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Field │ Value │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Build │ runtime-coreclr libraries-jitstress2-jitstressregs 20260307.1 │
│ │ (https://dev.azure.com/dnceng-public/cbb18261-c48f-4abb-8651-8cdcb5474649/_buil │
│ │ d/results?buildId=1324993) │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Helix Job │ 3f3cc108-6550-42e6-80a5-5e70ed9c556a │
│ (regs2) │ │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Helix Job │ acfbbeb5-9555-4c5b-b5ea-892f475ef22b │
│ (regs0x80) │ │
├────────────┼───────────────────────────────────────────────────────────────────────...
</details>
<!-- START COPILOT CODING AGENT SUFFIX -->
- Fixes dotnet/runtime#125312
<!-- START COPILOT CODING AGENT TIPS -->
---
⌨️ Start Copilot coding agent tasks without leaving your editor — available in [VS Code](https://gh.io/cca-vs-code-docs), [Visual Studio](https://gh.io/cca-visual-studio-docs), [JetBrains IDEs](https://gh.io/cca-jetbrains-docs) and [Eclipse](https://gh.io/cca-eclipse-docs).

@github-actionsgithub-actionsBot added the area-CodeGen-coreclr CLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI label Mar 25, 2026
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @JulieLeeMSFT, @jakobbotsch
See info in area-owners.md if you want to be subscribed.

When the LSRA allocates the source address to the same register that
the destination address needs (dstReg), the original code would
incorrectly clobber the source address by copying the destination first:
mov rdi, rax ; dst -> dstReg (CLOBBERS srcAddr already in rdi!)
mov rsi, rdi ; src -> srcReg (copies destination, not source!)
Fix by detecting this case and moving the source to srcReg first when
srcAddr is currently in dstReg. Also update the existing comment which
incorrectly claimed the LSRA always guarantees safe copy ordering, and
add an assert to catch the unhandled swap case (srcAddr in dstReg AND
dstAddr in srcReg simultaneously) which would produce incorrect code.
Fixes: System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest
under JitStress=2 + JitStressRegs={2,0x80} on Linux x64.
Co-authored-by: mangod9 <61718172+mangod9@users.noreply.github.com>
Agent-Logs-Url: https://github.com/dotnet/runtime/sessions/1b13221b-a0c1-4742-8445-5ada9974b0de
CopilotAI changed the title [WIP] Fix test failure in PassingVariableTagsParametersTestJIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstRegMar 25, 2026
CopilotAI requested a review from mangod9March 25, 2026 23:48
@jakobbotsch

Copy link
Copy Markdown
Member

I don't think this is the right fix. Likely what I am working on in #125333 will fix this in a better way.

@mangod9

Copy link
Copy Markdown
Member

Ok will close this PR then if you are already working on a fix. Thx!

@mangod9

Copy link
Copy Markdown
Member

btw @jakobbotsch is the analysis on the issue incorrect or the proposed fix is not complete. Looks like as part of the analysis it validated the fix worked for a sample test case it had built.

@jakobbotsch

Copy link
Copy Markdown
Member

btw @jakobbotsch is the analysis on the issue incorrect or the proposed fix is not complete. Looks like as part of the analysis it validated the fix worked for a sample test case it had built.

The fix is not sufficient -- there is nothing that prevents the case that the comment is mentioning:

 // Note: a true swap (srcAddr in dstReg AND dstAddr in srcReg) would require a temporary
// register, but the register allocator should prevent this by ensuring at most one of the
// two operands ends up in the other's required register.

@jakobbotsch
jakobbotsch deleted the copilot/fix-passing-variable-tags-parameters-test-again branch April 20, 2026 11:21
@github-actionsgithub-actionsBot locked and limited conversation to collaborators May 21, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-CodeGen-coreclrCLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@jakobbotsch@mangod9
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

JIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstReg - #126133

Closed
mangod9 with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-passing-variable-tags-parameters-test-again
Closed

JIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstReg#126133
mangod9 with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-passing-variable-tags-parameters-test-again

Conversation

CopilotAI commented Mar 25, 2026

Copy link
Copy Markdown
Contributor

MetricsTests.PassingVariableTagsParametersTest fails under JitStress=2 + JitStressRegs={2,0x80} on Linux x64 because the JIT emits incorrect code for GC-aware block copies (CpObjUnroll) when the LSRA allocates the source address to the same register required for the destination (rdi).

Description

Bug:genConsumeBlockOp unconditionally performs the destination move before the source move. When the source address is in dstReg, this silently overwrites it:

; LSRA under stress: srcAddr=rdi, dstAddr=rax
mov rdi, rax ; dst → dstReg — clobbers srcAddr already in rdi!
mov rsi, rdi ; src → srcReg — copies destination value, not source!

Fix (src/coreclr/jit/codegenlinear.cpp, genConsumeBlockOp):

  • When the source address (from a GT_IND CopyBlk) is currently in dstReg, emit the source move to srcRegfirst, then move the destination to dstReg.
  • Add assert(dstAddr->GetRegNum() != srcReg) to guard the unhandled cyclic-swap case (srcAddr in dstReg and dstAddr in srcReg simultaneously), which would need a temp register. The assert makes this fail loudly rather than silently corrupting data.
  • Update the existing comment that incorrectly claimed the LSRA always guarantees interference-free copies to required registers in execution order — this bug disproves that claim.

The fix is generic: it applies to all architectures that use genConsumeBlockOp with fixed destination/source register requirements (REG_RDI/REG_RSI on x64, REG_WRITE_BARRIER_DST_BYREF/REG_WRITE_BARRIER_SRC_BYREF on ARM64/LoongArch64/RISCV64).

Original prompt

This section details on the original issue you should resolve

<issue_title>Test failure: System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest</issue_title>
<issue_description>Failed in:runtime-coreclr libraries-jitstress2-jitstressregs 20260307.1

Failed tests:

net11.0-linux-Release-x64-jitstress2_jitstressregs2-AzureLinux.3.Amd64.Open
- System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest
net11.0-linux-Release-x64-jitstress2_jitstressregs0x80-AzureLinux.3.Amd64.Open
- System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest

Error message:

Microsoft.DotNet.RemoteExecutor.RemoteExecutionException : Remote process failed with an unhandled exception.

Stack trace:


Child exception:
Xunit.Sdk.EqualException: Assert.Equal() Failure: Collections differ
↓ (pos 0)
Expected: [["K1"] = "V1", ["K2"] = "V2", ["K3"] = "V3", ["K4"] = "V4", ["K5"] = "V5", ···]
Actual: [[null] = null, ["K2"] = "V2", ["K3"] = "V3", ["K4"] = "V4", ["K5"] = "V5", ···]
↑ (pos 0)
at System.Diagnostics.Metrics.Tests.MetricsTests.<>c__DisplayClass32_0`1.<InstrumentPassingVariableTagsParametersTest>b__1(Instrument inst, T measurement, ReadOnlySpan`1 tags, Object state) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 1965
at System.Diagnostics.Metrics.Instrument`1.RecordMeasurement(T measurement, ReadOnlySpan`1 tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/src/System/Diagnostics/Metrics/Instrument.common.cs:line 99
at System.Diagnostics.Metrics.Tests.MetricsTests.PublishCounterMeasurement[T](Counter`1 counter, T value, KeyValuePair`2[] tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 1791
at System.Diagnostics.Metrics.Tests.MetricsTests.<PassingVariableTagsParametersTest>b__10_3(Instrument`1 instrument, Int32 value, KeyValuePair`2[] tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 751
at System.Diagnostics.Metrics.Tests.MetricsTests.InstrumentPassingVariableTagsParametersTest[T](Instrument`1 instrument, Func`4 record) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 2015
at System.Diagnostics.Metrics.Tests.MetricsTests.<PassingVariableTagsParametersTest>b__10_0() in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 749
at System.Reflection.MethodBaseInvoker.InterpretedInvoke_Method(Object obj, IntPtr* args) in /_/src/coreclr/System.Private.CoreLib/src/System/Reflection/MethodBaseInvoker.CoreCLR.cs:line 36
at System.Reflection.MethodBaseInvoker.InvokeWithNoArgs(Object obj, BindingFlags invokeAttr) in /_/src/libraries/System.Private.CoreLib/src/System/Reflection/MethodBaseInvoker.cs:line 57
Child process:
System.Diagnostics.DiagnosticSource.Tests, Version=11.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51 System.Diagnostics.Metrics.Tests.MetricsTests Void <PassingVariableTagsParametersTest>b__10_0()
```</issue_description>
<agent_instructions>Please make a fix based on the analysis on the issue. </agent_instructions>
## Comments on the Issue (you are @copilot in this section)
<comments>
<comment_new><author>@mangod9</author><body>
Here is some copilot analysis for this failure:
```text Crash Context
┌────────────┬───────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Field │ Value │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Build │ runtime-coreclr libraries-jitstress2-jitstressregs 20260307.1 │
│ │ (https://dev.azure.com/dnceng-public/cbb18261-c48f-4abb-8651-8cdcb5474649/_buil │
│ │ d/results?buildId=1324993) │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Helix Job │ 3f3cc108-6550-42e6-80a5-5e70ed9c556a │
│ (regs2) │ │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Helix Job │ acfbbeb5-9555-4c5b-b5ea-892f475ef22b │
│ (regs0x80) │ │
├────────────┼───────────────────────────────────────────────────────────────────────...
</details>
<!-- START COPILOT CODING AGENT SUFFIX -->
- Fixes dotnet/runtime#125312
<!-- START COPILOT CODING AGENT TIPS -->
---
⌨️ Start Copilot coding agent tasks without leaving your editor — available in [VS Code](https://gh.io/cca-vs-code-docs), [Visual Studio](https://gh.io/cca-visual-studio-docs), [JetBrains IDEs](https://gh.io/cca-jetbrains-docs) and [Eclipse](https://gh.io/cca-eclipse-docs).

@github-actionsgithub-actionsBot added the area-CodeGen-coreclr CLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI label Mar 25, 2026
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @JulieLeeMSFT, @jakobbotsch
See info in area-owners.md if you want to be subscribed.

When the LSRA allocates the source address to the same register that
the destination address needs (dstReg), the original code would
incorrectly clobber the source address by copying the destination first:
mov rdi, rax ; dst -> dstReg (CLOBBERS srcAddr already in rdi!)
mov rsi, rdi ; src -> srcReg (copies destination, not source!)
Fix by detecting this case and moving the source to srcReg first when
srcAddr is currently in dstReg. Also update the existing comment which
incorrectly claimed the LSRA always guarantees safe copy ordering, and
add an assert to catch the unhandled swap case (srcAddr in dstReg AND
dstAddr in srcReg simultaneously) which would produce incorrect code.
Fixes: System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest
under JitStress=2 + JitStressRegs={2,0x80} on Linux x64.
Co-authored-by: mangod9 <61718172+mangod9@users.noreply.github.com>
Agent-Logs-Url: https://github.com/dotnet/runtime/sessions/1b13221b-a0c1-4742-8445-5ada9974b0de
CopilotAI changed the title [WIP] Fix test failure in PassingVariableTagsParametersTestJIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstRegMar 25, 2026
CopilotAI requested a review from mangod9March 25, 2026 23:48
@jakobbotsch

Copy link
Copy Markdown
Member

I don't think this is the right fix. Likely what I am working on in #125333 will fix this in a better way.

@mangod9

Copy link
Copy Markdown
Member

Ok will close this PR then if you are already working on a fix. Thx!

@mangod9

Copy link
Copy Markdown
Member

btw @jakobbotsch is the analysis on the issue incorrect or the proposed fix is not complete. Looks like as part of the analysis it validated the fix worked for a sample test case it had built.

@jakobbotsch

Copy link
Copy Markdown
Member

btw @jakobbotsch is the analysis on the issue incorrect or the proposed fix is not complete. Looks like as part of the analysis it validated the fix worked for a sample test case it had built.

The fix is not sufficient -- there is nothing that prevents the case that the comment is mentioning:

 // Note: a true swap (srcAddr in dstReg AND dstAddr in srcReg) would require a temporary
// register, but the register allocator should prevent this by ensuring at most one of the
// two operands ends up in the other's required register.

@jakobbotsch
jakobbotsch deleted the copilot/fix-passing-variable-tags-parameters-test-again branch April 20, 2026 11:21
@github-actionsgithub-actionsBot locked and limited conversation to collaborators May 21, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-CodeGen-coreclrCLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@jakobbotsch@mangod9
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

JIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstReg - #126133

Closed
mangod9 with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-passing-variable-tags-parameters-test-again
Closed

JIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstReg#126133
mangod9 with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-passing-variable-tags-parameters-test-again

Conversation

CopilotAI commented Mar 25, 2026

Copy link
Copy Markdown
Contributor

MetricsTests.PassingVariableTagsParametersTest fails under JitStress=2 + JitStressRegs={2,0x80} on Linux x64 because the JIT emits incorrect code for GC-aware block copies (CpObjUnroll) when the LSRA allocates the source address to the same register required for the destination (rdi).

Description

Bug:genConsumeBlockOp unconditionally performs the destination move before the source move. When the source address is in dstReg, this silently overwrites it:

; LSRA under stress: srcAddr=rdi, dstAddr=rax
mov rdi, rax ; dst → dstReg — clobbers srcAddr already in rdi!
mov rsi, rdi ; src → srcReg — copies destination value, not source!

Fix (src/coreclr/jit/codegenlinear.cpp, genConsumeBlockOp):

  • When the source address (from a GT_IND CopyBlk) is currently in dstReg, emit the source move to srcRegfirst, then move the destination to dstReg.
  • Add assert(dstAddr->GetRegNum() != srcReg) to guard the unhandled cyclic-swap case (srcAddr in dstReg and dstAddr in srcReg simultaneously), which would need a temp register. The assert makes this fail loudly rather than silently corrupting data.
  • Update the existing comment that incorrectly claimed the LSRA always guarantees interference-free copies to required registers in execution order — this bug disproves that claim.

The fix is generic: it applies to all architectures that use genConsumeBlockOp with fixed destination/source register requirements (REG_RDI/REG_RSI on x64, REG_WRITE_BARRIER_DST_BYREF/REG_WRITE_BARRIER_SRC_BYREF on ARM64/LoongArch64/RISCV64).

Original prompt

This section details on the original issue you should resolve

<issue_title>Test failure: System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest</issue_title>
<issue_description>Failed in:runtime-coreclr libraries-jitstress2-jitstressregs 20260307.1

Failed tests:

net11.0-linux-Release-x64-jitstress2_jitstressregs2-AzureLinux.3.Amd64.Open
- System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest
net11.0-linux-Release-x64-jitstress2_jitstressregs0x80-AzureLinux.3.Amd64.Open
- System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest

Error message:

Microsoft.DotNet.RemoteExecutor.RemoteExecutionException : Remote process failed with an unhandled exception.

Stack trace:


Child exception:
Xunit.Sdk.EqualException: Assert.Equal() Failure: Collections differ
↓ (pos 0)
Expected: [["K1"] = "V1", ["K2"] = "V2", ["K3"] = "V3", ["K4"] = "V4", ["K5"] = "V5", ···]
Actual: [[null] = null, ["K2"] = "V2", ["K3"] = "V3", ["K4"] = "V4", ["K5"] = "V5", ···]
↑ (pos 0)
at System.Diagnostics.Metrics.Tests.MetricsTests.<>c__DisplayClass32_0`1.<InstrumentPassingVariableTagsParametersTest>b__1(Instrument inst, T measurement, ReadOnlySpan`1 tags, Object state) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 1965
at System.Diagnostics.Metrics.Instrument`1.RecordMeasurement(T measurement, ReadOnlySpan`1 tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/src/System/Diagnostics/Metrics/Instrument.common.cs:line 99
at System.Diagnostics.Metrics.Tests.MetricsTests.PublishCounterMeasurement[T](Counter`1 counter, T value, KeyValuePair`2[] tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 1791
at System.Diagnostics.Metrics.Tests.MetricsTests.<PassingVariableTagsParametersTest>b__10_3(Instrument`1 instrument, Int32 value, KeyValuePair`2[] tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 751
at System.Diagnostics.Metrics.Tests.MetricsTests.InstrumentPassingVariableTagsParametersTest[T](Instrument`1 instrument, Func`4 record) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 2015
at System.Diagnostics.Metrics.Tests.MetricsTests.<PassingVariableTagsParametersTest>b__10_0() in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 749
at System.Reflection.MethodBaseInvoker.InterpretedInvoke_Method(Object obj, IntPtr* args) in /_/src/coreclr/System.Private.CoreLib/src/System/Reflection/MethodBaseInvoker.CoreCLR.cs:line 36
at System.Reflection.MethodBaseInvoker.InvokeWithNoArgs(Object obj, BindingFlags invokeAttr) in /_/src/libraries/System.Private.CoreLib/src/System/Reflection/MethodBaseInvoker.cs:line 57
Child process:
System.Diagnostics.DiagnosticSource.Tests, Version=11.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51 System.Diagnostics.Metrics.Tests.MetricsTests Void <PassingVariableTagsParametersTest>b__10_0()
```</issue_description>
<agent_instructions>Please make a fix based on the analysis on the issue. </agent_instructions>
## Comments on the Issue (you are @copilot in this section)
<comments>
<comment_new><author>@mangod9</author><body>
Here is some copilot analysis for this failure:
```text Crash Context
┌────────────┬───────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Field │ Value │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Build │ runtime-coreclr libraries-jitstress2-jitstressregs 20260307.1 │
│ │ (https://dev.azure.com/dnceng-public/cbb18261-c48f-4abb-8651-8cdcb5474649/_buil │
│ │ d/results?buildId=1324993) │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Helix Job │ 3f3cc108-6550-42e6-80a5-5e70ed9c556a │
│ (regs2) │ │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Helix Job │ acfbbeb5-9555-4c5b-b5ea-892f475ef22b │
│ (regs0x80) │ │
├────────────┼───────────────────────────────────────────────────────────────────────...
</details>
<!-- START COPILOT CODING AGENT SUFFIX -->
- Fixes dotnet/runtime#125312
<!-- START COPILOT CODING AGENT TIPS -->
---
⌨️ Start Copilot coding agent tasks without leaving your editor — available in [VS Code](https://gh.io/cca-vs-code-docs), [Visual Studio](https://gh.io/cca-visual-studio-docs), [JetBrains IDEs](https://gh.io/cca-jetbrains-docs) and [Eclipse](https://gh.io/cca-eclipse-docs).

@github-actionsgithub-actionsBot added the area-CodeGen-coreclr CLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI label Mar 25, 2026
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @JulieLeeMSFT, @jakobbotsch
See info in area-owners.md if you want to be subscribed.

When the LSRA allocates the source address to the same register that
the destination address needs (dstReg), the original code would
incorrectly clobber the source address by copying the destination first:
mov rdi, rax ; dst -> dstReg (CLOBBERS srcAddr already in rdi!)
mov rsi, rdi ; src -> srcReg (copies destination, not source!)
Fix by detecting this case and moving the source to srcReg first when
srcAddr is currently in dstReg. Also update the existing comment which
incorrectly claimed the LSRA always guarantees safe copy ordering, and
add an assert to catch the unhandled swap case (srcAddr in dstReg AND
dstAddr in srcReg simultaneously) which would produce incorrect code.
Fixes: System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest
under JitStress=2 + JitStressRegs={2,0x80} on Linux x64.
Co-authored-by: mangod9 <61718172+mangod9@users.noreply.github.com>
Agent-Logs-Url: https://github.com/dotnet/runtime/sessions/1b13221b-a0c1-4742-8445-5ada9974b0de
CopilotAI changed the title [WIP] Fix test failure in PassingVariableTagsParametersTestJIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstRegMar 25, 2026
CopilotAI requested a review from mangod9March 25, 2026 23:48
@jakobbotsch

Copy link
Copy Markdown
Member

I don't think this is the right fix. Likely what I am working on in #125333 will fix this in a better way.

@mangod9

Copy link
Copy Markdown
Member

Ok will close this PR then if you are already working on a fix. Thx!

@mangod9

Copy link
Copy Markdown
Member

btw @jakobbotsch is the analysis on the issue incorrect or the proposed fix is not complete. Looks like as part of the analysis it validated the fix worked for a sample test case it had built.

@jakobbotsch

Copy link
Copy Markdown
Member

btw @jakobbotsch is the analysis on the issue incorrect or the proposed fix is not complete. Looks like as part of the analysis it validated the fix worked for a sample test case it had built.

The fix is not sufficient -- there is nothing that prevents the case that the comment is mentioning:

 // Note: a true swap (srcAddr in dstReg AND dstAddr in srcReg) would require a temporary
// register, but the register allocator should prevent this by ensuring at most one of the
// two operands ends up in the other's required register.

@jakobbotsch
jakobbotsch deleted the copilot/fix-passing-variable-tags-parameters-test-again branch April 20, 2026 11:21
@github-actionsgithub-actionsBot locked and limited conversation to collaborators May 21, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-CodeGen-coreclrCLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@jakobbotsch@mangod9
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

JIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstReg - #126133

Closed
mangod9 with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-passing-variable-tags-parameters-test-again
Closed

JIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstReg#126133
mangod9 with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-passing-variable-tags-parameters-test-again

Conversation

CopilotAI commented Mar 25, 2026

Copy link
Copy Markdown
Contributor

MetricsTests.PassingVariableTagsParametersTest fails under JitStress=2 + JitStressRegs={2,0x80} on Linux x64 because the JIT emits incorrect code for GC-aware block copies (CpObjUnroll) when the LSRA allocates the source address to the same register required for the destination (rdi).

Description

Bug:genConsumeBlockOp unconditionally performs the destination move before the source move. When the source address is in dstReg, this silently overwrites it:

; LSRA under stress: srcAddr=rdi, dstAddr=rax
mov rdi, rax ; dst → dstReg — clobbers srcAddr already in rdi!
mov rsi, rdi ; src → srcReg — copies destination value, not source!

Fix (src/coreclr/jit/codegenlinear.cpp, genConsumeBlockOp):

  • When the source address (from a GT_IND CopyBlk) is currently in dstReg, emit the source move to srcRegfirst, then move the destination to dstReg.
  • Add assert(dstAddr->GetRegNum() != srcReg) to guard the unhandled cyclic-swap case (srcAddr in dstReg and dstAddr in srcReg simultaneously), which would need a temp register. The assert makes this fail loudly rather than silently corrupting data.
  • Update the existing comment that incorrectly claimed the LSRA always guarantees interference-free copies to required registers in execution order — this bug disproves that claim.

The fix is generic: it applies to all architectures that use genConsumeBlockOp with fixed destination/source register requirements (REG_RDI/REG_RSI on x64, REG_WRITE_BARRIER_DST_BYREF/REG_WRITE_BARRIER_SRC_BYREF on ARM64/LoongArch64/RISCV64).

Original prompt

This section details on the original issue you should resolve

<issue_title>Test failure: System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest</issue_title>
<issue_description>Failed in:runtime-coreclr libraries-jitstress2-jitstressregs 20260307.1

Failed tests:

net11.0-linux-Release-x64-jitstress2_jitstressregs2-AzureLinux.3.Amd64.Open
- System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest
net11.0-linux-Release-x64-jitstress2_jitstressregs0x80-AzureLinux.3.Amd64.Open
- System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest

Error message:

Microsoft.DotNet.RemoteExecutor.RemoteExecutionException : Remote process failed with an unhandled exception.

Stack trace:


Child exception:
Xunit.Sdk.EqualException: Assert.Equal() Failure: Collections differ
↓ (pos 0)
Expected: [["K1"] = "V1", ["K2"] = "V2", ["K3"] = "V3", ["K4"] = "V4", ["K5"] = "V5", ···]
Actual: [[null] = null, ["K2"] = "V2", ["K3"] = "V3", ["K4"] = "V4", ["K5"] = "V5", ···]
↑ (pos 0)
at System.Diagnostics.Metrics.Tests.MetricsTests.<>c__DisplayClass32_0`1.<InstrumentPassingVariableTagsParametersTest>b__1(Instrument inst, T measurement, ReadOnlySpan`1 tags, Object state) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 1965
at System.Diagnostics.Metrics.Instrument`1.RecordMeasurement(T measurement, ReadOnlySpan`1 tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/src/System/Diagnostics/Metrics/Instrument.common.cs:line 99
at System.Diagnostics.Metrics.Tests.MetricsTests.PublishCounterMeasurement[T](Counter`1 counter, T value, KeyValuePair`2[] tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 1791
at System.Diagnostics.Metrics.Tests.MetricsTests.<PassingVariableTagsParametersTest>b__10_3(Instrument`1 instrument, Int32 value, KeyValuePair`2[] tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 751
at System.Diagnostics.Metrics.Tests.MetricsTests.InstrumentPassingVariableTagsParametersTest[T](Instrument`1 instrument, Func`4 record) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 2015
at System.Diagnostics.Metrics.Tests.MetricsTests.<PassingVariableTagsParametersTest>b__10_0() in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 749
at System.Reflection.MethodBaseInvoker.InterpretedInvoke_Method(Object obj, IntPtr* args) in /_/src/coreclr/System.Private.CoreLib/src/System/Reflection/MethodBaseInvoker.CoreCLR.cs:line 36
at System.Reflection.MethodBaseInvoker.InvokeWithNoArgs(Object obj, BindingFlags invokeAttr) in /_/src/libraries/System.Private.CoreLib/src/System/Reflection/MethodBaseInvoker.cs:line 57
Child process:
System.Diagnostics.DiagnosticSource.Tests, Version=11.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51 System.Diagnostics.Metrics.Tests.MetricsTests Void <PassingVariableTagsParametersTest>b__10_0()
```</issue_description>
<agent_instructions>Please make a fix based on the analysis on the issue. </agent_instructions>
## Comments on the Issue (you are @copilot in this section)
<comments>
<comment_new><author>@mangod9</author><body>
Here is some copilot analysis for this failure:
```text Crash Context
┌────────────┬───────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Field │ Value │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Build │ runtime-coreclr libraries-jitstress2-jitstressregs 20260307.1 │
│ │ (https://dev.azure.com/dnceng-public/cbb18261-c48f-4abb-8651-8cdcb5474649/_buil │
│ │ d/results?buildId=1324993) │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Helix Job │ 3f3cc108-6550-42e6-80a5-5e70ed9c556a │
│ (regs2) │ │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Helix Job │ acfbbeb5-9555-4c5b-b5ea-892f475ef22b │
│ (regs0x80) │ │
├────────────┼───────────────────────────────────────────────────────────────────────...
</details>
<!-- START COPILOT CODING AGENT SUFFIX -->
- Fixes dotnet/runtime#125312
<!-- START COPILOT CODING AGENT TIPS -->
---
⌨️ Start Copilot coding agent tasks without leaving your editor — available in [VS Code](https://gh.io/cca-vs-code-docs), [Visual Studio](https://gh.io/cca-visual-studio-docs), [JetBrains IDEs](https://gh.io/cca-jetbrains-docs) and [Eclipse](https://gh.io/cca-eclipse-docs).

@github-actionsgithub-actionsBot added the area-CodeGen-coreclr CLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI label Mar 25, 2026
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @JulieLeeMSFT, @jakobbotsch
See info in area-owners.md if you want to be subscribed.

When the LSRA allocates the source address to the same register that
the destination address needs (dstReg), the original code would
incorrectly clobber the source address by copying the destination first:
mov rdi, rax ; dst -> dstReg (CLOBBERS srcAddr already in rdi!)
mov rsi, rdi ; src -> srcReg (copies destination, not source!)
Fix by detecting this case and moving the source to srcReg first when
srcAddr is currently in dstReg. Also update the existing comment which
incorrectly claimed the LSRA always guarantees safe copy ordering, and
add an assert to catch the unhandled swap case (srcAddr in dstReg AND
dstAddr in srcReg simultaneously) which would produce incorrect code.
Fixes: System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest
under JitStress=2 + JitStressRegs={2,0x80} on Linux x64.
Co-authored-by: mangod9 <61718172+mangod9@users.noreply.github.com>
Agent-Logs-Url: https://github.com/dotnet/runtime/sessions/1b13221b-a0c1-4742-8445-5ada9974b0de
CopilotAI changed the title [WIP] Fix test failure in PassingVariableTagsParametersTestJIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstRegMar 25, 2026
CopilotAI requested a review from mangod9March 25, 2026 23:48
@jakobbotsch

Copy link
Copy Markdown
Member

I don't think this is the right fix. Likely what I am working on in #125333 will fix this in a better way.

@mangod9

Copy link
Copy Markdown
Member

Ok will close this PR then if you are already working on a fix. Thx!

@mangod9

Copy link
Copy Markdown
Member

btw @jakobbotsch is the analysis on the issue incorrect or the proposed fix is not complete. Looks like as part of the analysis it validated the fix worked for a sample test case it had built.

@jakobbotsch

Copy link
Copy Markdown
Member

btw @jakobbotsch is the analysis on the issue incorrect or the proposed fix is not complete. Looks like as part of the analysis it validated the fix worked for a sample test case it had built.

The fix is not sufficient -- there is nothing that prevents the case that the comment is mentioning:

 // Note: a true swap (srcAddr in dstReg AND dstAddr in srcReg) would require a temporary
// register, but the register allocator should prevent this by ensuring at most one of the
// two operands ends up in the other's required register.

@jakobbotsch
jakobbotsch deleted the copilot/fix-passing-variable-tags-parameters-test-again branch April 20, 2026 11:21
@github-actionsgithub-actionsBot locked and limited conversation to collaborators May 21, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-CodeGen-coreclrCLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@jakobbotsch@mangod9
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

JIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstReg - #126133

Closed
mangod9 with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-passing-variable-tags-parameters-test-again
Closed

JIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstReg#126133
mangod9 with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-passing-variable-tags-parameters-test-again

Conversation

CopilotAI commented Mar 25, 2026

Copy link
Copy Markdown
Contributor

MetricsTests.PassingVariableTagsParametersTest fails under JitStress=2 + JitStressRegs={2,0x80} on Linux x64 because the JIT emits incorrect code for GC-aware block copies (CpObjUnroll) when the LSRA allocates the source address to the same register required for the destination (rdi).

Description

Bug:genConsumeBlockOp unconditionally performs the destination move before the source move. When the source address is in dstReg, this silently overwrites it:

; LSRA under stress: srcAddr=rdi, dstAddr=rax
mov rdi, rax ; dst → dstReg — clobbers srcAddr already in rdi!
mov rsi, rdi ; src → srcReg — copies destination value, not source!

Fix (src/coreclr/jit/codegenlinear.cpp, genConsumeBlockOp):

  • When the source address (from a GT_IND CopyBlk) is currently in dstReg, emit the source move to srcRegfirst, then move the destination to dstReg.
  • Add assert(dstAddr->GetRegNum() != srcReg) to guard the unhandled cyclic-swap case (srcAddr in dstReg and dstAddr in srcReg simultaneously), which would need a temp register. The assert makes this fail loudly rather than silently corrupting data.
  • Update the existing comment that incorrectly claimed the LSRA always guarantees interference-free copies to required registers in execution order — this bug disproves that claim.

The fix is generic: it applies to all architectures that use genConsumeBlockOp with fixed destination/source register requirements (REG_RDI/REG_RSI on x64, REG_WRITE_BARRIER_DST_BYREF/REG_WRITE_BARRIER_SRC_BYREF on ARM64/LoongArch64/RISCV64).

Original prompt

This section details on the original issue you should resolve

<issue_title>Test failure: System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest</issue_title>
<issue_description>Failed in:runtime-coreclr libraries-jitstress2-jitstressregs 20260307.1

Failed tests:

net11.0-linux-Release-x64-jitstress2_jitstressregs2-AzureLinux.3.Amd64.Open
- System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest
net11.0-linux-Release-x64-jitstress2_jitstressregs0x80-AzureLinux.3.Amd64.Open
- System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest

Error message:

Microsoft.DotNet.RemoteExecutor.RemoteExecutionException : Remote process failed with an unhandled exception.

Stack trace:


Child exception:
Xunit.Sdk.EqualException: Assert.Equal() Failure: Collections differ
↓ (pos 0)
Expected: [["K1"] = "V1", ["K2"] = "V2", ["K3"] = "V3", ["K4"] = "V4", ["K5"] = "V5", ···]
Actual: [[null] = null, ["K2"] = "V2", ["K3"] = "V3", ["K4"] = "V4", ["K5"] = "V5", ···]
↑ (pos 0)
at System.Diagnostics.Metrics.Tests.MetricsTests.<>c__DisplayClass32_0`1.<InstrumentPassingVariableTagsParametersTest>b__1(Instrument inst, T measurement, ReadOnlySpan`1 tags, Object state) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 1965
at System.Diagnostics.Metrics.Instrument`1.RecordMeasurement(T measurement, ReadOnlySpan`1 tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/src/System/Diagnostics/Metrics/Instrument.common.cs:line 99
at System.Diagnostics.Metrics.Tests.MetricsTests.PublishCounterMeasurement[T](Counter`1 counter, T value, KeyValuePair`2[] tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 1791
at System.Diagnostics.Metrics.Tests.MetricsTests.<PassingVariableTagsParametersTest>b__10_3(Instrument`1 instrument, Int32 value, KeyValuePair`2[] tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 751
at System.Diagnostics.Metrics.Tests.MetricsTests.InstrumentPassingVariableTagsParametersTest[T](Instrument`1 instrument, Func`4 record) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 2015
at System.Diagnostics.Metrics.Tests.MetricsTests.<PassingVariableTagsParametersTest>b__10_0() in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 749
at System.Reflection.MethodBaseInvoker.InterpretedInvoke_Method(Object obj, IntPtr* args) in /_/src/coreclr/System.Private.CoreLib/src/System/Reflection/MethodBaseInvoker.CoreCLR.cs:line 36
at System.Reflection.MethodBaseInvoker.InvokeWithNoArgs(Object obj, BindingFlags invokeAttr) in /_/src/libraries/System.Private.CoreLib/src/System/Reflection/MethodBaseInvoker.cs:line 57
Child process:
System.Diagnostics.DiagnosticSource.Tests, Version=11.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51 System.Diagnostics.Metrics.Tests.MetricsTests Void <PassingVariableTagsParametersTest>b__10_0()
```</issue_description>
<agent_instructions>Please make a fix based on the analysis on the issue. </agent_instructions>
## Comments on the Issue (you are @copilot in this section)
<comments>
<comment_new><author>@mangod9</author><body>
Here is some copilot analysis for this failure:
```text Crash Context
┌────────────┬───────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Field │ Value │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Build │ runtime-coreclr libraries-jitstress2-jitstressregs 20260307.1 │
│ │ (https://dev.azure.com/dnceng-public/cbb18261-c48f-4abb-8651-8cdcb5474649/_buil │
│ │ d/results?buildId=1324993) │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Helix Job │ 3f3cc108-6550-42e6-80a5-5e70ed9c556a │
│ (regs2) │ │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Helix Job │ acfbbeb5-9555-4c5b-b5ea-892f475ef22b │
│ (regs0x80) │ │
├────────────┼───────────────────────────────────────────────────────────────────────...
</details>
<!-- START COPILOT CODING AGENT SUFFIX -->
- Fixes dotnet/runtime#125312
<!-- START COPILOT CODING AGENT TIPS -->
---
⌨️ Start Copilot coding agent tasks without leaving your editor — available in [VS Code](https://gh.io/cca-vs-code-docs), [Visual Studio](https://gh.io/cca-visual-studio-docs), [JetBrains IDEs](https://gh.io/cca-jetbrains-docs) and [Eclipse](https://gh.io/cca-eclipse-docs).

@github-actionsgithub-actionsBot added the area-CodeGen-coreclr CLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI label Mar 25, 2026
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @JulieLeeMSFT, @jakobbotsch
See info in area-owners.md if you want to be subscribed.

When the LSRA allocates the source address to the same register that
the destination address needs (dstReg), the original code would
incorrectly clobber the source address by copying the destination first:
mov rdi, rax ; dst -> dstReg (CLOBBERS srcAddr already in rdi!)
mov rsi, rdi ; src -> srcReg (copies destination, not source!)
Fix by detecting this case and moving the source to srcReg first when
srcAddr is currently in dstReg. Also update the existing comment which
incorrectly claimed the LSRA always guarantees safe copy ordering, and
add an assert to catch the unhandled swap case (srcAddr in dstReg AND
dstAddr in srcReg simultaneously) which would produce incorrect code.
Fixes: System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest
under JitStress=2 + JitStressRegs={2,0x80} on Linux x64.
Co-authored-by: mangod9 <61718172+mangod9@users.noreply.github.com>
Agent-Logs-Url: https://github.com/dotnet/runtime/sessions/1b13221b-a0c1-4742-8445-5ada9974b0de
CopilotAI changed the title [WIP] Fix test failure in PassingVariableTagsParametersTestJIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstRegMar 25, 2026
CopilotAI requested a review from mangod9March 25, 2026 23:48
@jakobbotsch

Copy link
Copy Markdown
Member

I don't think this is the right fix. Likely what I am working on in #125333 will fix this in a better way.

@mangod9

Copy link
Copy Markdown
Member

Ok will close this PR then if you are already working on a fix. Thx!

@mangod9

Copy link
Copy Markdown
Member

btw @jakobbotsch is the analysis on the issue incorrect or the proposed fix is not complete. Looks like as part of the analysis it validated the fix worked for a sample test case it had built.

@jakobbotsch

Copy link
Copy Markdown
Member

btw @jakobbotsch is the analysis on the issue incorrect or the proposed fix is not complete. Looks like as part of the analysis it validated the fix worked for a sample test case it had built.

The fix is not sufficient -- there is nothing that prevents the case that the comment is mentioning:

 // Note: a true swap (srcAddr in dstReg AND dstAddr in srcReg) would require a temporary
// register, but the register allocator should prevent this by ensuring at most one of the
// two operands ends up in the other's required register.

@jakobbotsch
jakobbotsch deleted the copilot/fix-passing-variable-tags-parameters-test-again branch April 20, 2026 11:21
@github-actionsgithub-actionsBot locked and limited conversation to collaborators May 21, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-CodeGen-coreclrCLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@jakobbotsch@mangod9
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

JIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstReg - #126133

Closed
mangod9 with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-passing-variable-tags-parameters-test-again
Closed

JIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstReg#126133
mangod9 with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-passing-variable-tags-parameters-test-again

Conversation

CopilotAI commented Mar 25, 2026

Copy link
Copy Markdown
Contributor

MetricsTests.PassingVariableTagsParametersTest fails under JitStress=2 + JitStressRegs={2,0x80} on Linux x64 because the JIT emits incorrect code for GC-aware block copies (CpObjUnroll) when the LSRA allocates the source address to the same register required for the destination (rdi).

Description

Bug:genConsumeBlockOp unconditionally performs the destination move before the source move. When the source address is in dstReg, this silently overwrites it:

; LSRA under stress: srcAddr=rdi, dstAddr=rax
mov rdi, rax ; dst → dstReg — clobbers srcAddr already in rdi!
mov rsi, rdi ; src → srcReg — copies destination value, not source!

Fix (src/coreclr/jit/codegenlinear.cpp, genConsumeBlockOp):

  • When the source address (from a GT_IND CopyBlk) is currently in dstReg, emit the source move to srcRegfirst, then move the destination to dstReg.
  • Add assert(dstAddr->GetRegNum() != srcReg) to guard the unhandled cyclic-swap case (srcAddr in dstReg and dstAddr in srcReg simultaneously), which would need a temp register. The assert makes this fail loudly rather than silently corrupting data.
  • Update the existing comment that incorrectly claimed the LSRA always guarantees interference-free copies to required registers in execution order — this bug disproves that claim.

The fix is generic: it applies to all architectures that use genConsumeBlockOp with fixed destination/source register requirements (REG_RDI/REG_RSI on x64, REG_WRITE_BARRIER_DST_BYREF/REG_WRITE_BARRIER_SRC_BYREF on ARM64/LoongArch64/RISCV64).

Original prompt

This section details on the original issue you should resolve

<issue_title>Test failure: System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest</issue_title>
<issue_description>Failed in:runtime-coreclr libraries-jitstress2-jitstressregs 20260307.1

Failed tests:

net11.0-linux-Release-x64-jitstress2_jitstressregs2-AzureLinux.3.Amd64.Open
- System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest
net11.0-linux-Release-x64-jitstress2_jitstressregs0x80-AzureLinux.3.Amd64.Open
- System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest

Error message:

Microsoft.DotNet.RemoteExecutor.RemoteExecutionException : Remote process failed with an unhandled exception.

Stack trace:


Child exception:
Xunit.Sdk.EqualException: Assert.Equal() Failure: Collections differ
↓ (pos 0)
Expected: [["K1"] = "V1", ["K2"] = "V2", ["K3"] = "V3", ["K4"] = "V4", ["K5"] = "V5", ···]
Actual: [[null] = null, ["K2"] = "V2", ["K3"] = "V3", ["K4"] = "V4", ["K5"] = "V5", ···]
↑ (pos 0)
at System.Diagnostics.Metrics.Tests.MetricsTests.<>c__DisplayClass32_0`1.<InstrumentPassingVariableTagsParametersTest>b__1(Instrument inst, T measurement, ReadOnlySpan`1 tags, Object state) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 1965
at System.Diagnostics.Metrics.Instrument`1.RecordMeasurement(T measurement, ReadOnlySpan`1 tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/src/System/Diagnostics/Metrics/Instrument.common.cs:line 99
at System.Diagnostics.Metrics.Tests.MetricsTests.PublishCounterMeasurement[T](Counter`1 counter, T value, KeyValuePair`2[] tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 1791
at System.Diagnostics.Metrics.Tests.MetricsTests.<PassingVariableTagsParametersTest>b__10_3(Instrument`1 instrument, Int32 value, KeyValuePair`2[] tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 751
at System.Diagnostics.Metrics.Tests.MetricsTests.InstrumentPassingVariableTagsParametersTest[T](Instrument`1 instrument, Func`4 record) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 2015
at System.Diagnostics.Metrics.Tests.MetricsTests.<PassingVariableTagsParametersTest>b__10_0() in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 749
at System.Reflection.MethodBaseInvoker.InterpretedInvoke_Method(Object obj, IntPtr* args) in /_/src/coreclr/System.Private.CoreLib/src/System/Reflection/MethodBaseInvoker.CoreCLR.cs:line 36
at System.Reflection.MethodBaseInvoker.InvokeWithNoArgs(Object obj, BindingFlags invokeAttr) in /_/src/libraries/System.Private.CoreLib/src/System/Reflection/MethodBaseInvoker.cs:line 57
Child process:
System.Diagnostics.DiagnosticSource.Tests, Version=11.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51 System.Diagnostics.Metrics.Tests.MetricsTests Void <PassingVariableTagsParametersTest>b__10_0()
```</issue_description>
<agent_instructions>Please make a fix based on the analysis on the issue. </agent_instructions>
## Comments on the Issue (you are @copilot in this section)
<comments>
<comment_new><author>@mangod9</author><body>
Here is some copilot analysis for this failure:
```text Crash Context
┌────────────┬───────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Field │ Value │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Build │ runtime-coreclr libraries-jitstress2-jitstressregs 20260307.1 │
│ │ (https://dev.azure.com/dnceng-public/cbb18261-c48f-4abb-8651-8cdcb5474649/_buil │
│ │ d/results?buildId=1324993) │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Helix Job │ 3f3cc108-6550-42e6-80a5-5e70ed9c556a │
│ (regs2) │ │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Helix Job │ acfbbeb5-9555-4c5b-b5ea-892f475ef22b │
│ (regs0x80) │ │
├────────────┼───────────────────────────────────────────────────────────────────────...
</details>
<!-- START COPILOT CODING AGENT SUFFIX -->
- Fixes dotnet/runtime#125312
<!-- START COPILOT CODING AGENT TIPS -->
---
⌨️ Start Copilot coding agent tasks without leaving your editor — available in [VS Code](https://gh.io/cca-vs-code-docs), [Visual Studio](https://gh.io/cca-visual-studio-docs), [JetBrains IDEs](https://gh.io/cca-jetbrains-docs) and [Eclipse](https://gh.io/cca-eclipse-docs).

@github-actionsgithub-actionsBot added the area-CodeGen-coreclr CLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI label Mar 25, 2026
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @JulieLeeMSFT, @jakobbotsch
See info in area-owners.md if you want to be subscribed.

When the LSRA allocates the source address to the same register that
the destination address needs (dstReg), the original code would
incorrectly clobber the source address by copying the destination first:
mov rdi, rax ; dst -> dstReg (CLOBBERS srcAddr already in rdi!)
mov rsi, rdi ; src -> srcReg (copies destination, not source!)
Fix by detecting this case and moving the source to srcReg first when
srcAddr is currently in dstReg. Also update the existing comment which
incorrectly claimed the LSRA always guarantees safe copy ordering, and
add an assert to catch the unhandled swap case (srcAddr in dstReg AND
dstAddr in srcReg simultaneously) which would produce incorrect code.
Fixes: System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest
under JitStress=2 + JitStressRegs={2,0x80} on Linux x64.
Co-authored-by: mangod9 <61718172+mangod9@users.noreply.github.com>
Agent-Logs-Url: https://github.com/dotnet/runtime/sessions/1b13221b-a0c1-4742-8445-5ada9974b0de
CopilotAI changed the title [WIP] Fix test failure in PassingVariableTagsParametersTestJIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstRegMar 25, 2026
CopilotAI requested a review from mangod9March 25, 2026 23:48
@jakobbotsch

Copy link
Copy Markdown
Member

I don't think this is the right fix. Likely what I am working on in #125333 will fix this in a better way.

@mangod9

Copy link
Copy Markdown
Member

Ok will close this PR then if you are already working on a fix. Thx!

@mangod9

Copy link
Copy Markdown
Member

btw @jakobbotsch is the analysis on the issue incorrect or the proposed fix is not complete. Looks like as part of the analysis it validated the fix worked for a sample test case it had built.

@jakobbotsch

Copy link
Copy Markdown
Member

btw @jakobbotsch is the analysis on the issue incorrect or the proposed fix is not complete. Looks like as part of the analysis it validated the fix worked for a sample test case it had built.

The fix is not sufficient -- there is nothing that prevents the case that the comment is mentioning:

 // Note: a true swap (srcAddr in dstReg AND dstAddr in srcReg) would require a temporary
// register, but the register allocator should prevent this by ensuring at most one of the
// two operands ends up in the other's required register.

@jakobbotsch
jakobbotsch deleted the copilot/fix-passing-variable-tags-parameters-test-again branch April 20, 2026 11:21
@github-actionsgithub-actionsBot locked and limited conversation to collaborators May 21, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-CodeGen-coreclrCLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@jakobbotsch@mangod9
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

JIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstReg - #126133

Closed
mangod9 with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-passing-variable-tags-parameters-test-again
Closed

JIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstReg#126133
mangod9 with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-passing-variable-tags-parameters-test-again

Conversation

CopilotAI commented Mar 25, 2026

Copy link
Copy Markdown
Contributor

MetricsTests.PassingVariableTagsParametersTest fails under JitStress=2 + JitStressRegs={2,0x80} on Linux x64 because the JIT emits incorrect code for GC-aware block copies (CpObjUnroll) when the LSRA allocates the source address to the same register required for the destination (rdi).

Description

Bug:genConsumeBlockOp unconditionally performs the destination move before the source move. When the source address is in dstReg, this silently overwrites it:

; LSRA under stress: srcAddr=rdi, dstAddr=rax
mov rdi, rax ; dst → dstReg — clobbers srcAddr already in rdi!
mov rsi, rdi ; src → srcReg — copies destination value, not source!

Fix (src/coreclr/jit/codegenlinear.cpp, genConsumeBlockOp):

  • When the source address (from a GT_IND CopyBlk) is currently in dstReg, emit the source move to srcRegfirst, then move the destination to dstReg.
  • Add assert(dstAddr->GetRegNum() != srcReg) to guard the unhandled cyclic-swap case (srcAddr in dstReg and dstAddr in srcReg simultaneously), which would need a temp register. The assert makes this fail loudly rather than silently corrupting data.
  • Update the existing comment that incorrectly claimed the LSRA always guarantees interference-free copies to required registers in execution order — this bug disproves that claim.

The fix is generic: it applies to all architectures that use genConsumeBlockOp with fixed destination/source register requirements (REG_RDI/REG_RSI on x64, REG_WRITE_BARRIER_DST_BYREF/REG_WRITE_BARRIER_SRC_BYREF on ARM64/LoongArch64/RISCV64).

Original prompt

This section details on the original issue you should resolve

<issue_title>Test failure: System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest</issue_title>
<issue_description>Failed in:runtime-coreclr libraries-jitstress2-jitstressregs 20260307.1

Failed tests:

net11.0-linux-Release-x64-jitstress2_jitstressregs2-AzureLinux.3.Amd64.Open
- System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest
net11.0-linux-Release-x64-jitstress2_jitstressregs0x80-AzureLinux.3.Amd64.Open
- System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest

Error message:

Microsoft.DotNet.RemoteExecutor.RemoteExecutionException : Remote process failed with an unhandled exception.

Stack trace:


Child exception:
Xunit.Sdk.EqualException: Assert.Equal() Failure: Collections differ
↓ (pos 0)
Expected: [["K1"] = "V1", ["K2"] = "V2", ["K3"] = "V3", ["K4"] = "V4", ["K5"] = "V5", ···]
Actual: [[null] = null, ["K2"] = "V2", ["K3"] = "V3", ["K4"] = "V4", ["K5"] = "V5", ···]
↑ (pos 0)
at System.Diagnostics.Metrics.Tests.MetricsTests.<>c__DisplayClass32_0`1.<InstrumentPassingVariableTagsParametersTest>b__1(Instrument inst, T measurement, ReadOnlySpan`1 tags, Object state) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 1965
at System.Diagnostics.Metrics.Instrument`1.RecordMeasurement(T measurement, ReadOnlySpan`1 tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/src/System/Diagnostics/Metrics/Instrument.common.cs:line 99
at System.Diagnostics.Metrics.Tests.MetricsTests.PublishCounterMeasurement[T](Counter`1 counter, T value, KeyValuePair`2[] tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 1791
at System.Diagnostics.Metrics.Tests.MetricsTests.<PassingVariableTagsParametersTest>b__10_3(Instrument`1 instrument, Int32 value, KeyValuePair`2[] tags) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 751
at System.Diagnostics.Metrics.Tests.MetricsTests.InstrumentPassingVariableTagsParametersTest[T](Instrument`1 instrument, Func`4 record) in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 2015
at System.Diagnostics.Metrics.Tests.MetricsTests.<PassingVariableTagsParametersTest>b__10_0() in /_/src/libraries/System.Diagnostics.DiagnosticSource/tests/MetricsTests.cs:line 749
at System.Reflection.MethodBaseInvoker.InterpretedInvoke_Method(Object obj, IntPtr* args) in /_/src/coreclr/System.Private.CoreLib/src/System/Reflection/MethodBaseInvoker.CoreCLR.cs:line 36
at System.Reflection.MethodBaseInvoker.InvokeWithNoArgs(Object obj, BindingFlags invokeAttr) in /_/src/libraries/System.Private.CoreLib/src/System/Reflection/MethodBaseInvoker.cs:line 57
Child process:
System.Diagnostics.DiagnosticSource.Tests, Version=11.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51 System.Diagnostics.Metrics.Tests.MetricsTests Void <PassingVariableTagsParametersTest>b__10_0()
```</issue_description>
<agent_instructions>Please make a fix based on the analysis on the issue. </agent_instructions>
## Comments on the Issue (you are @copilot in this section)
<comments>
<comment_new><author>@mangod9</author><body>
Here is some copilot analysis for this failure:
```text Crash Context
┌────────────┬───────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Field │ Value │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Build │ runtime-coreclr libraries-jitstress2-jitstressregs 20260307.1 │
│ │ (https://dev.azure.com/dnceng-public/cbb18261-c48f-4abb-8651-8cdcb5474649/_buil │
│ │ d/results?buildId=1324993) │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Helix Job │ 3f3cc108-6550-42e6-80a5-5e70ed9c556a │
│ (regs2) │ │
├────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Helix Job │ acfbbeb5-9555-4c5b-b5ea-892f475ef22b │
│ (regs0x80) │ │
├────────────┼───────────────────────────────────────────────────────────────────────...
</details>
<!-- START COPILOT CODING AGENT SUFFIX -->
- Fixes dotnet/runtime#125312
<!-- START COPILOT CODING AGENT TIPS -->
---
⌨️ Start Copilot coding agent tasks without leaving your editor — available in [VS Code](https://gh.io/cca-vs-code-docs), [Visual Studio](https://gh.io/cca-visual-studio-docs), [JetBrains IDEs](https://gh.io/cca-jetbrains-docs) and [Eclipse](https://gh.io/cca-eclipse-docs).

@github-actionsgithub-actionsBot added the area-CodeGen-coreclr CLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI label Mar 25, 2026
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @JulieLeeMSFT, @jakobbotsch
See info in area-owners.md if you want to be subscribed.

When the LSRA allocates the source address to the same register that
the destination address needs (dstReg), the original code would
incorrectly clobber the source address by copying the destination first:
mov rdi, rax ; dst -> dstReg (CLOBBERS srcAddr already in rdi!)
mov rsi, rdi ; src -> srcReg (copies destination, not source!)
Fix by detecting this case and moving the source to srcReg first when
srcAddr is currently in dstReg. Also update the existing comment which
incorrectly claimed the LSRA always guarantees safe copy ordering, and
add an assert to catch the unhandled swap case (srcAddr in dstReg AND
dstAddr in srcReg simultaneously) which would produce incorrect code.
Fixes: System.Diagnostics.Metrics.Tests.MetricsTests.PassingVariableTagsParametersTest
under JitStress=2 + JitStressRegs={2,0x80} on Linux x64.
Co-authored-by: mangod9 <61718172+mangod9@users.noreply.github.com>
Agent-Logs-Url: https://github.com/dotnet/runtime/sessions/1b13221b-a0c1-4742-8445-5ada9974b0de
CopilotAI changed the title [WIP] Fix test failure in PassingVariableTagsParametersTestJIT: Fix register move ordering in genConsumeBlockOp when srcAddr is in dstRegMar 25, 2026
CopilotAI requested a review from mangod9March 25, 2026 23:48
@jakobbotsch

Copy link
Copy Markdown
Member

I don't think this is the right fix. Likely what I am working on in #125333 will fix this in a better way.

@mangod9

Copy link
Copy Markdown
Member

Ok will close this PR then if you are already working on a fix. Thx!

@mangod9

Copy link
Copy Markdown
Member

btw @jakobbotsch is the analysis on the issue incorrect or the proposed fix is not complete. Looks like as part of the analysis it validated the fix worked for a sample test case it had built.

@jakobbotsch

Copy link
Copy Markdown
Member

btw @jakobbotsch is the analysis on the issue incorrect or the proposed fix is not complete. Looks like as part of the analysis it validated the fix worked for a sample test case it had built.

The fix is not sufficient -- there is nothing that prevents the case that the comment is mentioning:

 // Note: a true swap (srcAddr in dstReg AND dstAddr in srcReg) would require a temporary
// register, but the register allocator should prevent this by ensuring at most one of the
// two operands ends up in the other's required register.

@jakobbotsch
jakobbotsch deleted the copilot/fix-passing-variable-tags-parameters-test-again branch April 20, 2026 11:21
@github-actionsgithub-actionsBot locked and limited conversation to collaborators May 21, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-CodeGen-coreclrCLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@jakobbotsch@mangod9