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/parser: fix memory leak of scanned comments #127759

Merged
merged 1 commit into from
Jul 29, 2024

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented Jul 26, 2024

Backport 1/1 commits from #127711 on behalf of @mgartner.

/cc @cockroachdb/release


This commit fixes a memory leak that cause a session's
scanner.Scanner, which is embedded in a pgwire.conn via a
parser.Parser, to retain previously scanned SQL comments in all parsed
SQL statements. The scanner's slice of comments would continue to grow
as it parsed new SQL strings with comments, as long as the session
remained open. Also, the slice of comments holds references to the bytes
in pgwire read buffers, preventing those buffers from being GC'd.

Fixes #127710

Release note (bug fix): A bug has been fixed that caused a memory leak
when executing SQL statements with comments, for example,
SELECT /* comment */ 1;. Memory owned by a SQL session would continue
to grow as these types of statements were executed. The memory would
only be released when closing the SQL session. This bug has been present
since version 23.1.


Release justification: Low-risk fix for a memory leak.

This commit fixes a memory leak that cause a session's
`scanner.Scanner`, which is embedded in a `pgwire.conn` via a
`parser.Parser`, to retain previously scanned SQL comments in all parsed
SQL statements. The scanner's slice of comments would continue to grow
as it parsed new SQL strings with comments, as long as the session
remained open. Also, the slice of comments holds references to the bytes
in `pgwire` read buffers, preventing those buffers from being GC'd.

Fixes #127710

Release note (bug fix): A bug has been fixed that caused a memory leak
when executing SQL statements with comments, for example,
`SELECT /* comment */ 1;`. Memory owned by a SQL session would continue
to grow as these types of statements were executed. The memory would
only be released when closing the SQL session. This bug has been present
since version 23.1.
@blathers-crl blathers-crl bot added blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot. labels Jul 26, 2024
Copy link
Author

blathers-crl bot commented Jul 26, 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. 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 requested review from fqazi, michae2 and yuzefovich July 26, 2024 18:27
@blathers-crl blathers-crl bot added the backport Label PR's that are backports to older release branches label Jul 26, 2024
Copy link
Author

blathers-crl bot commented Jul 26, 2024

It looks like your PR touches production code but doesn't add or edit any test code. Did you consider adding tests to your PR?

🦉 Hoot! I am a Blathers, a bot for CockroachDB. My owner is dev-inf.

@cockroach-teamcity
Copy link
Member

This change is Reviewable

Copy link
Collaborator

@michae2 michae2 left a comment

Choose a reason for hiding this comment

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

:lgtm:

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

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 1 of 1 files at r1, all commit messages.
Reviewable status: :shipit: complete! 1 of 0 LGTMs obtained (waiting on @fqazi)

@mgartner mgartner merged commit a0d07ba into release-24.1 Jul 29, 2024
19 of 20 checks passed
@mgartner mgartner deleted the blathers/backport-release-24.1-127711 branch July 29, 2024 17:07
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.

4 participants