Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release-24.1: sql: fix leak in memory accounting around TxnFingerprintIDCache #121873

Merged
merged 1 commit into from Apr 8, 2024

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented Apr 6, 2024

Backport 1/1 commits from #121847 on behalf of @yuzefovich.

/cc @cockroachdb/release


This commit is partial revert of 88ebd70. Until that change, we attempted to perform memory accounting for txn fingeprint IDs stored in the cache for each session, but we never initialized the bytes monitor, so it didn't actually count towards the root SQL memory budget. In that change, we derived an account from the "session" monitor to fix that.

However, this exposed another problem with how accounting was done: namely, on Cache.Add call we always grow the account and on Cache.OnEvicted we shrink the account. The problem is that if the txn fingerprint ID already exists in the cache, we still call Cache.Add (growing the account) but we will never shrink it because we didn't add a new entry. As a result, until the session is closed, we'll keep on accumulating the leak.

The fix in this commit is simple - just remove any attempt for memory accounting for this txn fingerprint ID cache. Effectively, this brings us back to the state of how we were before the change mentioned above (no accounting done) without the overhead of creating redundant BytesMonitor / BoundAccount objects (since they served no real purpose). Not having any accounting done for this cache seems acceptable given that the cache stores up to 100 txns (by default), and each txn results in about 56B of usage, so we'll have about 5KiB of unaccounted for (per session) memory usage. We have much larger omissions elsewhere, so for now I left a TODO to add memory accounting in the future.

Addresses: #121844.
Epic: None

Release note (bug fix): CockroachDB could previously "leak" reported memory usage (as accounted by the internal memory accounting system, the limit for which is configured via --max-sql-memory flag) on long-running sessions that issue many (hundreds of thousands or more) transactions. This, in turn, could result in "root: memory budget exceeded" errors for other queries. The bug is present in versions 23.1.17 and 23.2.3 and is now fixed.


Release justification: bug fix.

This commit is partial revert of 88ebd70.
Until that change, we attempted to perform memory accounting for txn
fingeprint IDs stored in the cache for each session, but we never
initialized the bytes monitor, so it didn't actually count towards the
root SQL memory budget. In that change, we derived an account from the
"session" monitor to fix that.

However, this exposed another problem with how accounting was done:
namely, on `Cache.Add` call we always grow the account and on
`Cache.OnEvicted` we shrink the account. The problem is that if the txn
fingerprint ID already exists in the cache, we still call `Cache.Add`
(growing the account) but we will never shrink it because we didn't add
a new entry. As a result, until the session is closed, we'll keep on
accumulating the leak.

The fix in this commit is simple - just remove any attempt for memory
accounting for this txn fingerprint ID cache. Effectively, this brings
us back to the state of how we were before the change mentioned above
(no accounting done) without the overhead of creating redundant
BytesMonitor / BoundAccount objects (since they served no real purpose).
Not having any accounting done for this cache seems acceptable given
that the cache stores up to 100 txns (by default), and each txn results
in about 56B of usage, so we'll have about 5KiB of unaccounted for (per
session) memory usage. We have much larger omissions elsewhere, so for
now I left a TODO to add memory accounting in the future.

Release note (bug fix): CockroachDB could previously "leak" reported
memory usage (as accounted by the internal memory accounting system, the
limit for which is configured via --max-sql-memory flag) on long-running
sessions that issue many (hundreds of thousands or more) transactions.
This, in turn, could result in "root: memory budget exceeded" errors for
other queries. The bug is present in versions 23.1.17 and 23.2.3 and is
now fixed.
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-24.1-121847 branch from d1e953a to 86d4d9f Compare April 6, 2024 00:01
@blathers-crl blathers-crl bot added blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot. labels Apr 6, 2024
Copy link
Author

blathers-crl bot commented Apr 6, 2024

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Backports should only be created for serious
    issues
    or test-only changes.
  • Backports should not break backwards-compatibility.
  • Backports should change as little code as possible.
  • Backports should not change on-disk formats or node communication protocols.
  • Backports should not add new functionality (except as defined
    here).
  • Backports must not add, edit, or otherwise modify cluster versions; or add version gates.
  • All backports must be reviewed by the owning areas TL and one additional
    TL. For more information as to how that review should be conducted, please consult the backport
    policy
    .
If your backport adds new functionality, please ensure that the following additional criteria are satisfied:
  • There is a high priority need for the functionality that cannot wait until the next release and is difficult to address in another way.
  • The new functionality is additive-only and only runs for clusters which have specifically “opted in” to it (e.g. by a cluster setting).
  • New code is protected by a conditional check that is trivial to verify and ensures that it only runs for opt-in clusters. State changes must be further protected such that nodes running old binaries will not be negatively impacted by the new state (with a mixed version test added).
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.
  • Your backport must be accompanied by a post to the appropriate Slack
    channel (#db-backports-point-releases or #db-backports-XX-X-release) for awareness and discussion.

Also, please add a brief release justification to the body of your PR to justify this
backport.

@blathers-crl blathers-crl bot added the backport Label PR's that are backports to older release branches label Apr 6, 2024
@cockroach-teamcity
Copy link
Member

This change is Reviewable

Copy link
Member

@yuzefovich yuzefovich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 4 of 4 files at r1, all commit messages.
Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained (waiting on @DrewKimball)

@yuzefovich yuzefovich merged commit 660bfd9 into release-24.1 Apr 8, 2024
32 of 34 checks passed
@yuzefovich yuzefovich deleted the blathers/backport-release-24.1-121847 branch April 8, 2024 18:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport Label PR's that are backports to older release branches blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants