Skip to content

Cache hash code in TypeStructure to fix O(n) GetHashCode perf regression#19369

Merged
T-Gro merged 5 commits intodotnet:mainfrom
OnurGumus:fix-type-structure-hash-perf
Apr 16, 2026
Merged

Cache hash code in TypeStructure to fix O(n) GetHashCode perf regression#19369
T-Gro merged 5 commits intodotnet:mainfrom
OnurGumus:fix-type-structure-hash-perf

Conversation

@OnurGumus
Copy link
Copy Markdown
Contributor

Summary

TypeStructure.GetHashCode calls GenericHashArbArray on the underlying TypeToken[] on every cache lookup, making each hash computation O(n) over the token array. In IDE mode with generative type providers, the type subsumption cache continuously rehashes all entries during rebuildStore, causing sustained ~150% CPU.

This PR pre-computes the hash when creating TypeStructure and stores it in the DU case, making GetHashCode O(1). It also adds [<CustomEquality; NoComparison>] with a fast-path Equals that checks the cached hash before comparing arrays.

Background

A 10-second dotnet-trace CPU sample on the FSAC process (166% CPU) with a solution using generative type providers shows:

Samples Function
2414 Thread.PollGC
1170 RuntimeTypeHandle.InternalAllocNoChecks
820 GenericEqualityArbArray
696 TTypeCacheKey.GetHashCodeGenericHashArbArray
96 ConcurrentDictionary.GrowTable
12 Cache.rebuildStore

PR #18926 memoized TypeStructure creation via a ConditionalWeakTable, but GetHashCode still delegates to F# structural hashing on ImmutableArray<TypeToken> (which wraps T[]), making each call O(n). The cache's rebuildStore re-hashes all existing entries, amplifying the cost.

Repro steps

  1. Create an F# solution targeting net10.0 (LangVersion 10) with 5+ projects.
  2. Add a generative type provider producing ~15 provided types.
  3. Reference the type provider from 2+ projects in the solution.
  4. Open the solution in VS Code with Ionide (FSAC).
  5. Observe sustained ~150% CPU on the dotnet fsautocomplete.dll process that does not settle down.

Setting <LangVersion>9.0</LangVersion> (disabling UseTypeSubsumptionCache) eliminates the CPU issue entirely.

Changes

  • src/Compiler/Utilities/TypeHashing.fs: Added hashTokenArray helper. Changed TypeStructure DU cases to carry a pre-computed hash: int. Added [<CustomEquality; NoComparison>] with O(1) GetHashCode and fast-path Equals.
  • src/Compiler/Checking/OverloadResolutionCache.fs: Updated pattern matches for new Stable(hash, tokens) / Unstable(hash, tokens) shape.

Related

TypeStructure.GetHashCode was calling GenericHashArbArray on the
underlying TypeToken[] on every cache lookup, making each hash O(n).
In IDE mode with generative type providers this caused sustained ~150%
CPU as the type subsumption cache continuously rehashed all entries.

Pre-compute the hash when creating TypeStructure and store it in the
DU case. Add [<CustomEquality; NoComparison>] with a fast-path Equals
that checks the cached hash before comparing arrays.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Feb 28, 2026

❗ Release notes required


✅ Found changes and release notes in following paths:

Change path Release notes path Description
src/Compiler docs/release-notes/.FSharp.Compiler.Service/11.0.100.md

OnurGumus added a commit to OnurGumus/HtmlTypeProvider that referenced this pull request Feb 28, 2026
Document the FSharp_CacheEvictionImmediate=1 env var workaround
for the FCS type subsumption cache hashing bug (dotnet/fsharp#19369).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@majocha
Copy link
Copy Markdown
Contributor

majocha commented Feb 28, 2026

Lots of calls to Cache.rebuildStore indicate a serious underlying problem.

@T-Gro
Copy link
Copy Markdown
Member

T-Gro commented Mar 2, 2026

We can get this in, but I am still worried about the "sustained" symptom. Something is creating a lot of unstable tokens which are not found when removing from the store, causing frequent (and likely useless in this scenario?) store rebuilds?

@majocha
Copy link
Copy Markdown
Contributor

majocha commented Mar 2, 2026

The optimization is ok but I'd make sure the underlying issue repros with current compiler.

If I'm not mistaken with current shape of type subsumption cache key:

type TTypeCacheKey = TTypeCacheKey of TypeStructure * TypeStructure * CanCoerce

there should be no eviction fails whatsoever. That means no rebuilds.
Everything in the key is immutable and uses built in hashing and equality. Eviction fail can happen when we cannot remove a key from cache because of unstable hash / unreliable equality but those keys are expected to be well behaved.

@OnurGumus
Copy link
Copy Markdown
Contributor Author

Verified, I went back to F# 9 (still .NET 10) and the issue doesn't repro there.

So the rebuildStore symptom was from an older build. The hash caching is still a net win since GetHashCode was O(n) on every cache hit/miss, but yeah the description was overblown. Happy to update it.

@github-project-automation github-project-automation bot moved this from New to In Progress in F# Compiler and Tooling Apr 10, 2026
@T-Gro
Copy link
Copy Markdown
Member

T-Gro commented Apr 10, 2026

This can go in to resolve current pain, but as discussed in the issue - problem of frequent rebuilding is the one to treat, and we would benefit a lot from more test data (repro, or even a project we could attach to our regression testing)

@OnurGumus
Copy link
Copy Markdown
Contributor Author

@T-Gro , thanks personally I am stuck to F# 9 for my project.

@OnurGumus
Copy link
Copy Markdown
Contributor Author

Are the remaining errors something I can help with?

T-Gro and others added 2 commits April 13, 2026 13:25
@T-Gro
Copy link
Copy Markdown
Member

T-Gro commented Apr 14, 2026

I resolved the errors, this is good to go.

@T-Gro T-Gro enabled auto-merge (squash) April 14, 2026 14:31
@OnurGumus
Copy link
Copy Markdown
Contributor Author

@OnurGumus please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@dotnet-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@dotnet-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@dotnet-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ), and conveys certain license rights to the .NET Foundation ( “.NET Foundation” ) for Your contributions to .NET Foundation open source projects. This Agreement is effective as of the latest signature date below.

1. Definitions.

“Code” means the computer software code, whether in human-readable or machine-executable form, that is delivered by You to .NET Foundation under this Agreement.

“Project” means any of the projects owned or managed by .NET Foundation and offered under a license approved by the Open Source Initiative (www.opensource.org).

“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any Project, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of discussing and improving that Project, but excluding communication that is conspicuously marked or otherwise designated in writing by You as “Not a Submission.”

“Submission” means the Code and any other copyrightable material Submitted by You, including any associated comments and documentation.

2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any Project. This Agreement covers any and all Submissions that You, now or in the future (except as described in Section 4 below), Submit to any Project.

3. Originality of Work. You represent that each of Your Submissions is entirely Your original work. Should You wish to Submit materials that are not Your original work, You may Submit them separately to the Project if You (a) retain all copyright and license information that was in the materials as you received them, (b) in the description accompanying your Submission, include the phrase "Submission containing materials of a third party:" followed by the names of the third party and any licenses or other restrictions of which You are aware, and (c) follow any other instructions in the Project's written guidelines concerning Submissions.

4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your Submission is made in the course of Your work for an employer or Your employer has intellectual property rights in Your Submission by contract or applicable law, You must secure permission from Your employer to make the Submission before signing this Agreement. In that case, the term “You” in this Agreement will refer to You and the employer collectively. If You change employers in the future and desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement and secure permission from the new employer before Submitting those Submissions.

5. Licenses.

a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly or indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third parties.

b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under Your patent claims that are necessarily infringed by the Submission or the combination of the Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and import or otherwise dispose of the Submission alone or with the Project.

c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above licenses. You represent that each of Your Submissions is entirely Your original work (except as You may have disclosed under Section 3 ). You represent that You have secured permission from Your employer to make the Submission in cases where Your Submission is made in the course of Your work for Your employer or Your employer has intellectual property rights in Your Submission by contract or applicable law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You have the necessary authority to bind the listed employer to the obligations contained in this Agreement. You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES EXPRESSLY STATED IN SECTIONS 3, 4, AND 6 , THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or circumstances of which You later become aware that would make Your representations in this Agreement inaccurate in any respect.

8. Information about Submissions. You agree that contributions to Projects and information about contributions may be maintained indefinitely and disclosed publicly, including Your name and other information that You submit with Your Submission.

9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County, Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all defenses of lack of personal jurisdiction and forum non-conveniens.

10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and supersedes any and all prior agreements, understandings or communications, written or oral, between the parties relating to the subject matter hereof. This Agreement may be assigned by .NET Foundation.

.NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1.

@dotnet-policy-service agree

auto-merge was automatically disabled April 16, 2026 07:25

Head branch was pushed to by a user without write access

@T-Gro T-Gro enabled auto-merge (squash) April 16, 2026 07:27
@T-Gro T-Gro merged commit db60550 into dotnet:main Apr 16, 2026
48 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in F# Compiler and Tooling Apr 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants