execution, db: bind cache views to state versions and file views - #23095
execution, db: bind cache views to state versions and file views#23095yperbasis wants to merge 42 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
This PR refactors execution/cache so StateCache is published and consumed strictly as a single durable-state snapshot keyed by PlainStateVersion (state version), replacing the prior mix of applied-frontier tracking plus per-entry epoch/floor coherence. The goal is to close stale-fill windows around unwinds/commits by making cache usability contingent on an exact state-version match, and by revoking read views before any publication mutates cache contents.
Changes:
- Introduce a version-bound
cache.ReadView/publication token model (Publisher/Publication) and remove StateCache per-entry epoch/floor + applied-frontier coherence. - Rewire canonical vs speculative cache ownership (
SetCanonicalStateCachevsSetStateCacheReader) and update execution paths (FCU, SetHead, integration runner) accordingly. - Update read-ahead warmup and tests/benchmarks to use state-version-bound cache views and new step-based cache APIs.
Reviewed changes
Copilot reviewed 24 out of 24 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| execution/vm/contract.go | Update jumpdest cache usage to new Put signature. |
| execution/execmodule/set_head.go | Switch SetHead path to canonical cache publication API. |
| execution/execmodule/forkchoice.go | Switch FCU canonical contexts to canonical cache publication API; remove warmup draining. |
| execution/execmodule/exec_module.go | Remove read-ahead draining helper; use reader-only cache attachment in ValidateChain. |
| execution/exec/blocks_read_ahead.go | Bind read-ahead warmup fills to PlainStateVersion and domain visibility; fill using kv.Step. |
| execution/exec/blocks_read_ahead_test.go | Adapt warmup tests to version-bound ReadView and publisher initialization. |
| execution/cache/view.go | Redefine ReadView as a durable-state-version handle with generation checks around reads/fills. |
| execution/cache/state_cache.go | Implement generation token, Publisher/Publication, step-based updates, and version-gated View. |
| execution/cache/generic_cache.go | Remove unwind coherence from GenericCache; store (value, step) for domain caches. |
| execution/cache/generic_cache_concurrency_test.go | Update concurrency tests for new Put/PutIfAbsent signatures and semantics. |
| execution/cache/code_cache.go | Remove unwind coherence; make code layers generation-cleared; switch stamping from txNum/epoch to step where needed. |
| execution/cache/code_cache_concurrency_test.go | Update concurrency tests for new code-cache semantics (clear-fencing only). |
| execution/cache/code_cache_codehash_test.go | Replace unwind-based tests with clear/publication-based expectations; update APIs. |
| execution/cache/cache.go | Update Cache interface to step-based API and simplify package-level docs. |
| execution/cache/cache_test.go | Update StateCache/DomainCache/CodeCache tests to publisher-based publication model and step API. |
| db/state/execctx/statecache_rpc_integration_test.go | Add/adjust integration tests covering unwinds and RPC views under version-bound cache publication. |
| db/state/execctx/statecache_readfill_test.go | Rewrite read-fill/unwind tests to new inactive-during-publication behavior and version-bound views. |
| db/state/execctx/statecache_readfill_bench_test.go | Remove frontier memo benchmark; align benchmark description with generation-check model. |
| db/state/execctx/flush_storage_cache_test.go | Update storage-cache commit callback test to read via current version-bound cache view. |
| db/state/execctx/export_test.go | Adjust exported test helpers to use version-bound cache view wiring. |
| db/state/execctx/domain_visible_end_memo_test.go | Remove now-obsolete visible-end memo concurrency tests. |
| db/state/execctx/domain_shared.go | Replace frontier memo + applier model with version-bound view selection and canonical Publisher publication pipeline. |
| db/state/execctx/codehash_routing_test.go | Update derived codehash routing tests to new generation safety (cache-sourced record may seed mapping). |
| cmd/integration/commands/stages.go | Wire integration stage runner to canonical cache publication API. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 45 out of 45 changed files in this pull request and generated no new comments.
Suppressed comments (2)
db/state/aggregator.go:1931
- When a commitment files publication triggers a BranchCache clear (BeginFilesPublication returns a non-nil backing-change), the AdaptivePinController should be reset as well; otherwise the controller will keep residency/miss state for pins that were just cleared and may make promotion/demotion decisions based on stale cache contents.
// SharedDomains.Commit acquires cache publication in the same order.
if domain := a.d[kv.CommitmentDomain]; domain != nil && domain.branchCache != nil {
if commitmentVisible := visible.d[kv.CommitmentDomain]; commitmentVisible != nil {
publication.branch = domain.branchCache.BeginFilesPublication(visibleFiles(commitmentVisible.files).EndTxNum())
}
}
db/state/aggregator.go:742
- closeDirtyFilesNoReopen resets the commitment BranchCache but does not reset the paired AdaptivePinController. Since AdaptivePinController keeps per-contract residency state, leaving it intact after a BranchCache reset can make the controller treat removed pins as still resident (see AdaptivePinController.Reset doc) and delay re-promotion/extension decisions.
This issue also appears on line 1926 of the same file.
a.visibilityLoweringForbidden.Store(false)
if cd := a.d[kv.CommitmentDomain]; cd != nil && cd.branchCache != nil {
cd.branchCache.Reset()
}
…versioned-generation
…versioned-generation
…versioned-generation # Conflicts: # execution/cache/state_cache.go
Fixes #22463.
Fixes #23028.
This supersedes #23005 while retaining its regression scenarios. It also folds #23047 into the same cache-publication model instead of stacking a second coherence mechanism on top. #23139 describes a possible selective-invalidation optimization for canonical unwinds; it is not required for this correctness fix.
Problem
StateCacheandBranchCacheare process-global caches of latest state. A transaction may outlive a canonical commit, unwind, or immutable-files publication, so the caches must reject reads and fills from transactions backed by older state.The previous coherence mechanisms did not identify that complete backing state:
PlainStateVersionand without sending the downloaded values through cache applies. Existing positive or negative entries could remain live after their backing files changed.Review guide
A useful end-state reading order is:
execution/cache/generation_gate.go: generation identity, view revocation, fill admission, commit publication, abort, and files publication.execution/cache/view.goandexecution/commitment/branch_cache_view.go: how StateCache and BranchCache expose generation-bound reads, fills, and publication capabilities.db/state/execctx/domain_shared.go: deriving both cache views from a pinned transaction and publishing them after a canonical database commit.db/state/aggregator.go,execution/cache/state_cache.go, andexecution/commitment/branch_cache.go: coordinating cache identity with immutable-files visibility and file-provenance coverage.execution/stagedsync/rawdbreset/reset_stages.goandcmd/integration/commands/stages.go: whole-state reset and staged-unwind publication boundaries.Cache generation
Both caches now follow one invariant:
A StateCache generation contains the state version and the exclusive values-file ends for accounts, storage, and code. A BranchCache generation contains the state version and the commitment values-file end.
HasExactDomainVisibleEnddecides whether the transaction has an exact read frontier for every relevant domain. The numericDomainVisibleEndvalues are not used as file identity: they describe the combined database-and-history frontier, can remain unchanged when pinned values files change, and require database cursors to resolve.TxNumsInFilesprovides the cheap values-file ends that identify the relevant immutable backing. Equal ends remain compatible when physical files are merged or repacked.Each published generation also has an immutable pointer token. Pointer identity lets publication revoke readers before a new durable generation exists and prevents a previously revoked view from becoming valid if the same numeric identity is published again.
Publication behavior
SharedDomainsResetExecSharedDomains.Commituses the following durable order for both caches:Long flush and adaptive-planning work happens before revocation. If the database commit fails, publication restores the previous tokens and leaves entries unchanged.
ResetExecis the whole-state replacement path outsideSharedDomains.Commit. It revokes and clears both caches before starting the replacement transaction. That transaction wipes the execution tables and advancesPlainStateVersionatomically. The caches remain unpublished until canonical execution establishes a new generation, so a pre-reset view cannot match or refill post-reset state.Why stale data cannot cross a publication
Unwind behavior
An unwind detaches that
SharedDomainsfrom both shared-cache readers, so the rewound overlay cannot read from or fill either cache. The unwind itself does not clear or revoke the shared caches. If theSharedDomainshas canonical publication authority, its later successfulCommitrevokes existing views and clears both caches as part of publishing the rewound state.After a canonical unwind commits, both caches are cleared and published at the resulting state version. The full clear is intentional: an unwind diff is not a complete inventory of entries that may have entered either cache from the discarded fork. #23139 evaluates selective retention with change-diff tombstones, but keeps full clearing as the correctness fallback.
Files publication
Aggregator.recalcVisibleFilesis the common publication boundary for downloads, reopen, merge, and dependency recalculation. It reconciles both caches before the new immutable-files bundle becomes visible.The caches track how far their committed updates cover each relevant domain:
A transaction pinned to the previous files cannot bind to the cache after this boundary. Binding a StateCache after files are already visible performs the same reconciliation. Visibility lowering remains forbidden while the shared caches are attached because file-provenance watermarks only advance.
Intentional behavior and non-goals
kvcache.Simplification
The shared generation rule replaces the StateCache read-view epoch and the per-entry unwind epochs, floors, and transaction numbers in both caches. The separate
execution/cache/coherencepackage is removed.TxNumremains on transient committed updates only to advance file-provenance watermarks. Cached state entries still keep their sourceStep, which callers need independently of cache coherence.Performance
The cache-hit path remains lock-free and allocation-free. It adds an atomic pointer comparison before and after the existing lookup. A fill performs an early pointer check and one authoritative check under the admission lock.
Cache-view construction does not resolve numeric domain frontiers. It checks four cheap exactness conditions and four values-file ends from the transaction's pinned files. A transaction different from the
SharedDomainsbase view also readsPlainStateVersiononce per constructed getter. No database cursor is opened for cache eligibility.On darwin/arm64 with an Apple M2 Max, the
BenchmarkCacheGetterConstructionmedian over five 5,000-iteration runs is:Avoiding the four
LastKeycursors saves about 2.8 us per fresh cache-backed getter in this benchmark and makes construction about 4.9 times faster. Run it with:go test ./db/state/execctx -run '^$' -bench '^BenchmarkCacheGetterConstruction$' -benchtime=5000x -count=5Forward commits retain unchanged entries. Canonical unwinds and uncovered files extensions clear their affected caches and pay the re-warm cost.
Two workload-level costs remain to be measured:
Tests
The changes were developed with red-green-refactor regression tests. The main review paths are:
execution/cache/cache_test.goandexecution/cache/files_publication_test.go: generation matching, publication abort, stale read/fill rejection, canonical clear, and files reconciliation.execution/commitment/branch_cache_test.go,execution/commitment/branch_cache_absorb_test.go, andexecution/commitment/adaptive_pin_test.go: the equivalent BranchCache contract, file provenance, and adaptive-plan publication.db/state/execctx/statecache_readfill_test.go,db/state/execctx/statecache_rpc_integration_test.go, anddb/state/execctx/branch_cache_flush_test.go: speculative isolation, canonical unwind, bare-Flushmemory precedence, old transactions, commit failure, and RPC-visible behavior.db/state/aggregator_align_test.go: atomic files visibility, old-files transactions, cache binding, and visibility-lowering protection.execution/stagedsync/rawdbreset/reset_stages_test.goandcmd/integration/commands/stages_test.go: whole-state reset and staged-unwind publication.Together these cover pre-unwind reads and fills, transactions first attached after an unwind or files publication, negative entries, reset, publication abort, adaptive pins, and both process-global caches.
Local verification:
go test ./execution/cache ./execution/commitment ./db/state/execctx ./execution/exec -count=1go test ./db/state -count=1go test -race --timeout 20m ./execution/cache ./execution/commitment ./db/state/execctx ./execution/exec ./db/state -count=1make lintrepeatedlymake erigon integration