[ci-fix] Needs review: Normalize -1 bufferSize in StreamReader/StreamWriter String ctors (refs #128062)

[github-actions]

Workflow artifact: ci-fix
Artifact kind: help
Linked KBE: #128062

Note

This is an AI/Copilot-generated best-effort fix attempt that I could not fully validate. It is a starting point for a maintainer, not a finished change. Please review the analysis below before merging.

Root cause (best analysis)

StreamReader_StringCtorTests.NegativeOneBufferSize_ShouldNotThrowException and the equivalent StreamWriter test fail under PGO (runtime-coreclr libraries-pgo pipeline) because the JIT, guided by PGO data, optimizes away the if (bufferSize == -1) bufferSize = DefaultBufferSize; branch in the Stream-based constructor when it is inlined into the String-based constructor.

The failing log line:

System.IO.Tests.StreamReader_StringCtorTests.NegativeOneBufferSize_ShouldNotThrowException [FAIL]
System.ArgumentOutOfRangeException : bufferSize ('-1') must be a non-negative and non-zero value.
  at System.IO.StreamReader..ctor(String path, Encoding encoding, Boolean detectEncodingFromByteOrderMarks, Int32 bufferSize)

The String-based constructors (StreamReader(string, Encoding, bool, int) and StreamWriter(string, bool, Encoding, int)) pass their bufferSize parameter (which may be -1) directly to the Stream-based constructor via constructor chaining. The Stream-based constructor handles -1 by converting to DefaultBufferSize before calling ThrowIfNegativeOrZero. Under PGO inlining, this conversion branch is (incorrectly) optimized away.

Attempted fix

Normalize the -1 sentinel to DefaultBufferSize in the String-based constructors before passing to the Stream-based constructor, so the inlined code never sees -1 at the ThrowIfNegativeOrZero call site regardless of PGO optimization decisions. This is a defense-in-depth fix — the Stream-based constructor still handles -1 correctly for direct callers.

Changes:

• StreamReader.cs line 200: bufferSize → bufferSize == -1 ? DefaultBufferSize : bufferSize
• StreamWriter.cs line 148: same pattern

What is unverified / where I need help

• Build not validated: The .NET SDK is not available in the CI remediation environment. The change is a single ternary expression addition with no structural risk.
• Root cause is a JIT/PGO bug: This fix works around the JIT incorrectly eliminating the -1 conversion branch under PGO. The JIT team should investigate why PGO-guided optimization removes this branch — the bug could manifest in other code patterns.
• Assigned to @EgorBo: The issue is labeled area-CodeGen-coreclr and assigned to EgorBo, suggesting the team views this as a codegen issue. This defensive fix is a product-code hardening that makes the code PGO-safe without touching the JIT.

Validation

• Command: dotnet build src/libraries/System.Private.CoreLib/src/System.Private.CoreLib.csproj
• Result: not run (.NET SDK not available in CI remediation environment)
• Why the failing test validates this fix: NegativeOneBufferSize_ShouldNotThrowException calls new StreamReader(path, Encoding.UTF8, true, -1) which exercises exactly this constructor path. With the fix, -1 is converted to DefaultBufferSize before the inlined Stream ctor sees it, so ThrowIfNegativeOrZero never fires.

Evidence

• Failing build: https://dev.azure.com/dnceng-public/public/_build/results?buildId=1414905
• First build it occurred: build 1414533 (May 9, 2026)
• Suspected regressing change: none identified — this is likely a latent JIT/PGO optimization issue exposed when PGO profiles changed

Help wanted

• Area owners (area-CodeGen-coreclr): @EgorBo, @dotnet/jit-contrib
• The underlying JIT/PGO bug should still be investigated separately. The defensive fix prevents the test failure but the JIT eliminating a valid branch is a correctness issue.

---

Filed by ci-failure-fix. Comment here or on the workflow file to suggest changes; ci-failure-scan-feedback reads in-scope feedback daily and opens (or updates) a PR with prompt edits.

Generated by CI Outer-Loop Failure Fixer · ● 27.1M · ◷

[dotnet-policy-service]

Tagging subscribers to this area: @dotnet/area-system-io
See info in area-owners.md if you want to be subscribed.

[MihaZupan]

I don't see a point in trying to workaround a codegen bug like this

[kotlarmilos]

I don't see a point in trying to workaround a codegen bug like this

Thanks @MihaZupan, agreed - patching StreamReader/StreamWriter buffer handling was the wrong call. This feedback has been picked up by our feedback loop: we're changing ci-fix so that for JIT/GC/PGO/codegen failures it no longer attempts a product-code workaround, and instead posts root-cause analysis and loops in the area owners with a proposed direction.

[MihaZupan]

Neat, thank you