Skip to content

Commit

Permalink
Validate ts only for stale read (tikv#1592)
Browse files Browse the repository at this point in the history
ref pingcap/tidb#59402

Signed-off-by: ekexium <eke@fastmail.com>
  • Loading branch information
ekexium committed Feb 26, 2025
1 parent d561c89 commit 28b280d
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 37 deletions.
20 changes: 1 addition & 19 deletions oracle/oracles/local.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,9 @@ package oracles

import (
"context"
"math"
"sync"
"time"

"github.com/pingcap/errors"
"github.com/tikv/client-go/v2/oracle"
)

Expand Down Expand Up @@ -138,22 +136,6 @@ func (l *localOracle) GetExternalTimestamp(ctx context.Context) (uint64, error)
}

func (l *localOracle) ValidateReadTS(ctx context.Context, readTS uint64, isStaleRead bool, opt *oracle.Option) error {
if readTS == math.MaxUint64 {
if isStaleRead {
return oracle.ErrLatestStaleRead{}
}
return nil
}

currentTS, err := l.GetTimestamp(ctx, opt)
if err != nil {
return errors.Errorf("fail to validate read timestamp: %v", err)
}
if currentTS < readTS {
return oracle.ErrFutureTSRead{
ReadTS: readTS,
CurrentTS: currentTS,
}
}
// local oracle is not supposed to be used
return nil
}
18 changes: 0 additions & 18 deletions oracle/oracles/mock.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ package oracles

import (
"context"
"math"
"sync"
"time"

Expand Down Expand Up @@ -128,23 +127,6 @@ func (o *MockOracle) SetLowResolutionTimestampUpdateInterval(time.Duration) erro
}

func (o *MockOracle) ValidateReadTS(ctx context.Context, readTS uint64, isStaleRead bool, opt *oracle.Option) error {
if readTS == math.MaxUint64 {
if isStaleRead {
return oracle.ErrLatestStaleRead{}
}
return nil
}

currentTS, err := o.GetTimestamp(ctx, opt)
if err != nil {
return errors.Errorf("fail to validate read timestamp: %v", err)
}
if currentTS < readTS {
return oracle.ErrFutureTSRead{
ReadTS: readTS,
CurrentTS: currentTS,
}
}
return nil
}

Expand Down
15 changes: 15 additions & 0 deletions oracle/oracles/pd.go
Original file line number Diff line number Diff line change
Expand Up @@ -620,7 +620,22 @@ func (o *pdOracle) getCurrentTSForValidation(ctx context.Context, opt *oracle.Op
}
}

// ValidateReadTSForTidbSnapshot is a flag in context, indicating whether the read ts is for tidb_snapshot.
// This is a special approach for release branches to minimize code changes to reduce risks.
type ValidateReadTSForTidbSnapshot struct{}

func (o *pdOracle) ValidateReadTS(ctx context.Context, readTS uint64, isStaleRead bool, opt *oracle.Option) (errRet error) {
// For a mistake we've seen
if readTS >= math.MaxInt64 && readTS < math.MaxUint64 {
return errors.Errorf("MaxInt64 <= readTS < MaxUint64, readTS=%v", readTS)
}

// For release branches, only check stale reads and reads using `tidb_snapshot`
forTidbSnapshot := ctx.Value(ValidateReadTSForTidbSnapshot{}) != nil
if !forTidbSnapshot && !isStaleRead {
return nil
}

if readTS == math.MaxUint64 {
if isStaleRead {
return oracle.ErrLatestStaleRead{}
Expand Down

0 comments on commit 28b280d

Please sign in to comment.