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-21.2: kvserver: fix nil pointer dereferencing in replicaRankings.topQPS #74515

Merged
merged 1 commit into from Jan 6, 2022

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented Jan 6, 2022

Backport 1/1 commits from #74507 on behalf of @erikgrinaker.

/cc @cockroachdb/release


If replicaRankings.topQPS() was called before a QPS accumulator had
been set for the rankings, it would attempt to dereference a nil pointer
and panic. This could happen e.g. if the status server's
/_status/hotranges endpoint was accessed during node startup.

The initialization story here is a bit unclear -- it appears that the
accumulator is set up in Store.Capacity(), which is called by
Store.Descriptor(). So this will only be initialized once the store
descriptor is requested by someone, e.g. during Store.GossipStore() or
MetricsRecorder.GenerateNodeStatus(). I haven't made an attempt at
reviewing or revising this.

This patch explicitly checks if a QPS accumulator has been set before
attempting to access it, avoiding the nil pointer dereferencing.

Release note (bug fix): Fixed a panic when attempting to access the
hottest ranges (e.g. via the /_status/hotranges endpoint) before
initial statistics had been gathered.


Release justification: fixes a node crash.

If `replicaRankings.topQPS()` was called before a QPS accumulator had
been set for the rankings, it would attempt to dereference a nil pointer
and panic. This could happen e.g. if the status server's
`/_status/hotranges` endpoint was accessed during node startup.

The initialization story here is a bit unclear -- it appears that the
accumulator is set up in `Store.Capacity()`, which is called by
`Store.Descriptor()`. So this will only be initialized once the store
descriptor is requested by someone, e.g. during `Store.GossipStore()` or
`MetricsRecorder.GenerateNodeStatus()`. I haven't made an attempt at
reviewing or revising this.

This patch explicitly checks if a QPS accumulator has been set before
attempting to access it, avoiding the nil pointer dereferencing.

Release note (bug fix): Fixed a panic when attempting to access the
hottest ranges (e.g. via the `/_status/hotranges` endpoint) before
initial statistics had been gathered.
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-21.2-74507 branch from c054f18 to 7d62417 Compare January 6, 2022 15:01
@blathers-crl blathers-crl bot requested a review from a team as a code owner January 6, 2022 15:01
@blathers-crl blathers-crl bot added blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot. labels Jan 6, 2022
@blathers-crl
Copy link
Author

blathers-crl bot commented Jan 6, 2022

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Patches should only be created for serious issues or test-only changes.
  • Patches should not break backwards-compatibility.
  • Patches should change as little code as possible.
  • Patches should not change on-disk formats or node communication protocols.
  • Patches should not add new functionality.
  • Patches must not add, edit, or otherwise modify cluster versions; or add version gates.
If some of the basic criteria cannot be satisfied, ensure that the exceptional criteria are satisfied within.
  • 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.
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.

Add a brief release justification to the body of your PR to justify this backport.

Some other things to consider:

  • What did we do to ensure that a user that doesn’t know & care about this backport, has no idea that it happened?
  • Will this work in a cluster of mixed patch versions? Did we test that?
  • If a user upgrades a patch version, uses this feature, and then downgrades, what happens?

@cockroach-teamcity
Copy link
Member

This change is Reviewable

@erikgrinaker erikgrinaker merged commit 75a57fc into release-21.2 Jan 6, 2022
@erikgrinaker erikgrinaker deleted the blathers/backport-release-21.2-74507 branch January 6, 2022 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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

3 participants