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

storage/spanset: clarify and clean up "reversed" span checks #45085

Merged
merged 2 commits into from
Feb 14, 2020

Conversation

nvanbenschoten
Copy link
Member

The notion of "reversed" span checks was introduced in 5176bac. That was a good change which allowed for proper validation of spans when using spanset.Iterator.SeekLT. However, the semantics around the reversed argument added to SpanSet.checkAllowed were strange and under-specified. Now that the start key of the span was exclusive, what did it mean to provide a reversed multi-key span to checkAllowed? Was the start key before or after the end key? Was it ok that only the exclusive portion of the span was being provided by all callers? Were reversed multi-key spans even supported? The comment said that "the reversed arguments makes the lower bound exclusive and the upper bound inclusive, i.e. [a,b) will be considered (a,b]". It's unclear whether this was mistakenly meaning that "[a,b) will be considered (b,a]". This all led to a terribly confusing condition:

if cur.Contains(span) &&
.

This commit clarifies these semantics by removing the reversed flag while retaining roughly the same idea in a way that's consistent with the existing meaning of a "Span". SpanSet.checkAllowed now supports an extended span format with a nil start key and a non-nil end key (e.g. "[nil, c)"). In this form, s2.Key (inclusive) is considered to be the previous key to s2.EndKey (exclusive). This avoids any ambiguity around multi-key "reversed" spans and fits in better with the existing definition of a Span.

… bound

This commit improves TestSpanSetBatchBoundaries and makes it test operations
at the exclusive upper bound key of the declared span.
@cockroach-teamcity
Copy link
Member

This change is Reviewable

Copy link
Contributor

@ajwerner ajwerner left a comment

Choose a reason for hiding this comment

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

Thanks. This is much cleaner. :lgtm:

Reviewed 1 of 1 files at r1, 3 of 3 files at r2.
Reviewable status: :shipit: complete! 1 of 0 LGTMs obtained

@nvanbenschoten nvanbenschoten force-pushed the nvanbenschoten/spanRevCheck branch 2 times, most recently from 32bafa3 to 9edb8f2 Compare February 13, 2020 18:37
The notion of "reversed" span checks was introduced in 5176bac. That was a good
change which allowed for proper validation of spans when using
`spanset.Iterator.SeekLT`. However, the semantics around the `reversed` argument
added to `SpanSet.checkAllowed` were strange and under-specified. Now that the
start key of the span was exclusive, what did it mean to provide a reversed
multi-key span to `checkAllowed`? Was the start key before or after the end key?
Was it ok that only the exclusive portion of the span was being provided by all
callers? Were reversed multi-key spans even supported? The comment said that
"the reversed arguments makes the lower bound exclusive and the upper bound
inclusive, i.e. [a,b) will be considered (a,b]". It's unclear whether this was
mistakenly meaning that "[a,b) will be considered (b,a]". This all led to a
terribly confusing condition:
https://github.com/cockroachdb/cockroach/blob/5d69fd053ba52ae7ce94567b7b5fbb7cd857f1af/pkg/storage/spanset/spanset.go#L197.

This commit clarifies these semantics by removing the `reversed` flag while
retaining roughly the same idea in a way that's consistent with the existing
meaning of a "Span". `SpanSet.checkAllowed` now supports an extended span format
with a nil start key and a non-nil end key (e.g. "[nil, c)"). In this form,
s2.Key (inclusive) is considered to be the previous key to s2.EndKey
(exclusive). This avoids any ambiguity around multi-key "reversed" spans and
fits in better with the existing definition of a Span.
@nvanbenschoten nvanbenschoten force-pushed the nvanbenschoten/spanRevCheck branch from 9edb8f2 to aa13826 Compare February 13, 2020 20:20
@nvanbenschoten
Copy link
Member Author

bors r+

craig bot pushed a commit that referenced this pull request Feb 14, 2020
45085: storage/spanset: clarify and clean up "reversed" span checks r=nvanbenschoten a=nvanbenschoten

The notion of "reversed" span checks was introduced in 5176bac. That was a good change which allowed for proper validation of spans when using `spanset.Iterator.SeekLT`. However, the semantics around the `reversed` argument added to `SpanSet.checkAllowed` were strange and under-specified. Now that the start key of the span was exclusive, what did it mean to provide a reversed multi-key span to `checkAllowed`? Was the start key before or after the end key? Was it ok that only the exclusive portion of the span was being provided by all callers? Were reversed multi-key spans even supported? The comment said that "the reversed arguments makes the lower bound exclusive and the upper bound inclusive, i.e. [a,b) will be considered (a,b]". It's unclear whether this was mistakenly meaning that "[a,b) will be considered (b,a]". This all led to a terribly confusing condition: https://github.com/cockroachdb/cockroach/blob/5d69fd053ba52ae7ce94567b7b5fbb7cd857f1af/pkg/storage/spanset/spanset.go#L197.

This commit clarifies these semantics by removing the `reversed` flag while retaining roughly the same idea in a way that's consistent with the existing meaning of a "Span". `SpanSet.checkAllowed` now supports an extended span format with a nil start key and a non-nil end key (e.g. "[nil, c)"). In this form, s2.Key (inclusive) is considered to be the previous key to s2.EndKey (exclusive). This avoids any ambiguity around multi-key "reversed" spans and fits in better with the existing definition of a Span.

Co-authored-by: Nathan VanBenschoten <nvanbenschoten@gmail.com>
@craig
Copy link
Contributor

craig bot commented Feb 14, 2020

Build succeeded

@craig craig bot merged commit aa13826 into cockroachdb:master Feb 14, 2020
@nvanbenschoten nvanbenschoten deleted the nvanbenschoten/spanRevCheck branch February 18, 2020 01:21
nvanbenschoten added a commit to nvanbenschoten/cockroach that referenced this pull request Feb 20, 2020
This prevents the hazard described in
https://github.com/cockroachdb/cockroach/blob/5f63ac527becd4aae5cfbdaa76b7de28e07b8767/pkg/storage/concurrency/concurrency_control.go#L480.

I've been trying to (starting with cockroachdb#45085) clean up `spanset.Batch`
to the point where it would have been able to detect this unlatched
key access, but getting that all the way over the fence is a little
tricky due to:
- `GCRequest` span declaration - should this even latch?
- transactional `Put` span declaration - does this need to declare a
  write span all the way back to txn.MinTimestamp because it might move
  an existing intent forward?
- `spanset.Iterator` semantics and its interaction with `pebbleMVCCScanner` -
  what can the `spanset.Iterator` even assert here, given that the scanner
  itself is determining whether to ignore values or not.

Unfortunately, without a rework, the current attempt at asserting
correct timestamp access in `spanset.Batch` is hopelessly broken.
Not only does the verification not encode the correct rules for
declared timestamps (e.g. a write at time 10 should permit writing at
any time >= 10), but the timestamp it works with isn't even the correct
timestamp. It compares the declared span timestamps against the batch
header timestamp, which completely misses the point. It should be
comparing the declared span timestamps against the timestamps of actual
uses of the `spanset.Batch` so that we're actually asserting that the
batch is being used correctly.

I'd like to fix all of this, but not here.
craig bot pushed a commit that referenced this pull request Feb 26, 2020
45232: storage/batcheval: declare intent resolution at txn MinTimestamp r=nvanbenschoten a=nvanbenschoten

This prevents the hazard described in:
https://github.com/cockroachdb/cockroach/blob/5f63ac527becd4aae5cfbdaa76b7de28e07b8767/pkg/storage/concurrency/concurrency_control.go#L480

I've been trying to (starting with #45085) clean up `spanset.Batch` to the point where it would have been able to detect this unlatched key access, but getting that all the way over the fence is a little tricky due to:
- `GCRequest` span declaration - should this even latch?
- transactional `Put` span declaration - does this need to declare a write span all the way back to txn.MinTimestamp because it might move an existing intent forward?
- `spanset.Iterator` semantics and its interaction with `pebbleMVCCScanner` - what can the `spanset.Iterator` even assert here, given that the scanner itself is determining whether to ignore values or not.

Unfortunately, without a rework, the current attempt at asserting correct timestamp access in `spanset.Batch` is hopelessly broken. Not only does the verification not encode the correct rules for declared timestamps (e.g. a write at time 10 should permit writing at any time >= 10), but the timestamp it works with isn't even the correct timestamp. It compares the declared span timestamps against the batch header timestamp, which completely misses the point. It should be comparing the declared span timestamps against the timestamps of actual uses of the `spanset.Batch` so that we're actually asserting that the batch is being used correctly.

I'd like to fix all of this, but not here.

Co-authored-by: Nathan VanBenschoten <nvanbenschoten@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants