client-go/txnkv/store/store.go

// Copyright 2019 PingCAP, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.

package store

import (
	"context"
	"crypto/tls"
	"fmt"
	"sync"
	"time"

	pd "github.com/pingcap/pd/client"
	"github.com/pkg/errors"
	log "github.com/sirupsen/logrus"
	"github.com/tikv/client-go/config"
	"github.com/tikv/client-go/locate"
	"github.com/tikv/client-go/metrics"
	"github.com/tikv/client-go/retry"
	"github.com/tikv/client-go/rpc"
	"github.com/tikv/client-go/txnkv/latch"
	"github.com/tikv/client-go/txnkv/oracle"
	"github.com/tikv/client-go/txnkv/oracle/oracles"
)

// TiKVStore contains methods to interact with a TiKV cluster.
type TiKVStore struct {
	conf         *config.Config
	clusterID    uint64
	uuid         string
	oracle       oracle.Oracle
	client       rpc.Client
	pdClient     pd.Client
	regionCache  *locate.RegionCache
	lockResolver *LockResolver
	txnLatches   *latch.LatchesScheduler
	etcdAddrs    []string
	tlsConfig    *tls.Config

	spkv      SafePointKV
	safePoint uint64
	spTime    time.Time
	spMutex   sync.RWMutex  // this is used to update safePoint and spTime
	closed    chan struct{} // this is used to nofity when the store is closed
}

// NewStore creates a TiKVStore instance.
func NewStore(pdAddrs []string, conf config.Config) (*TiKVStore, error) {
	pdCli, err := pd.NewClient(pdAddrs, pd.SecurityOption{
		CAPath:   conf.RPC.Security.SSLCA,
		CertPath: conf.RPC.Security.SSLCert,
		KeyPath:  conf.RPC.Security.SSLKey,
	})
	if err != nil {
		return nil, err
	}

	pdClient := &locate.CodecPDClient{Client: pdCli}

	oracle, err := oracles.NewPdOracle(pdCli, &conf.Txn)
	if err != nil {
		return nil, err
	}

	tlsConfig, err := conf.RPC.Security.ToTLSConfig()
	if err != nil {
		return nil, err
	}

	spkv, err := NewEtcdSafePointKV(pdAddrs, tlsConfig)
	if err != nil {
		return nil, err
	}

	clusterID := pdCli.GetClusterID(context.TODO())

	store := &TiKVStore{
		conf:        &conf,
		clusterID:   clusterID,
		uuid:        fmt.Sprintf("tikv-%d", clusterID),
		oracle:      oracle,
		client:      rpc.NewRPCClient(&conf.RPC),
		pdClient:    pdClient,
		regionCache: locate.NewRegionCache(pdClient, &conf.RegionCache),
		etcdAddrs:   pdAddrs,
		tlsConfig:   tlsConfig,
		spkv:        spkv,
		spTime:      time.Now(),
		closed:      make(chan struct{}),
	}

	store.lockResolver = newLockResolver(store)

	if conf.Txn.Latch.Enable {
		store.txnLatches = latch.NewScheduler(&conf.Txn.Latch)
	}

	go store.runSafePointChecker()
	return store, nil
}

// GetConfig returns the store's configurations.
func (s *TiKVStore) GetConfig() *config.Config {
	return s.conf
}

// GetLockResolver returns the lock resolver instance.
func (s *TiKVStore) GetLockResolver() *LockResolver {
	return s.lockResolver
}

// GetOracle returns the oracle instance.
func (s *TiKVStore) GetOracle() oracle.Oracle {
	return s.oracle
}

// GetRegionCache returns the region cache instance.
func (s *TiKVStore) GetRegionCache() *locate.RegionCache {
	return s.regionCache
}

// GetRPCClient returns the rpc client instance.
func (s *TiKVStore) GetRPCClient() rpc.Client {
	return s.client
}

// GetTxnLatches returns the latch scheduler instance.
func (s *TiKVStore) GetTxnLatches() *latch.LatchesScheduler {
	return s.txnLatches
}

// GetSnapshot creates a snapshot for read.
func (s *TiKVStore) GetSnapshot(ts uint64) *TiKVSnapshot {
	return newTiKVSnapshot(s, ts)
}

// SendReq sends a request to TiKV server.
func (s *TiKVStore) SendReq(bo *retry.Backoffer, req *rpc.Request, regionID locate.RegionVerID, timeout time.Duration) (*rpc.Response, error) {
	sender := rpc.NewRegionRequestSender(s.regionCache, s.client)
	return sender.SendReq(bo, req, regionID, timeout)
}

// Closed returns a channel that will be closed when TiKVStore is closed.
func (s *TiKVStore) Closed() <-chan struct{} {
	return s.closed
}

// Close stops the TiKVStore instance and releases resources.
func (s *TiKVStore) Close() error {
	s.oracle.Close()
	s.pdClient.Close()

	close(s.closed)
	if err := s.client.Close(); err != nil {
		return err
	}

	if s.txnLatches != nil {
		s.txnLatches.Close()
	}
	return nil
}

// GetTimestampWithRetry queries PD for a new timestamp.
func (s *TiKVStore) GetTimestampWithRetry(bo *retry.Backoffer) (uint64, error) {
	for {
		startTS, err := s.oracle.GetTimestamp(bo.GetContext())
		if err == nil {
			return startTS, nil
		}
		err = bo.Backoff(retry.BoPDRPC, errors.Errorf("get timestamp failed: %v", err))
		if err != nil {
			return 0, err
		}
	}
}

func (s *TiKVStore) runSafePointChecker() {
	d := s.conf.Txn.GcSafePointUpdateInterval
	for {
		select {
		case spCachedTime := <-time.After(d):
			cachedSafePoint, err := loadSafePoint(s.spkv, s.conf.Txn.GcSavedSafePoint)
			if err == nil {
				metrics.LoadSafepointCounter.WithLabelValues("ok").Inc()
				s.spMutex.Lock()
				s.safePoint, s.spTime = cachedSafePoint, spCachedTime
				s.spMutex.Unlock()
				d = s.conf.Txn.GcSafePointUpdateInterval
			} else {
				metrics.LoadSafepointCounter.WithLabelValues("fail").Inc()
				log.Errorf("fail to load safepoint from pd: %v", err)
				d = s.conf.Txn.GcSafePointQuickRepeatInterval
			}
		case <-s.Closed():
			return
		}
	}
}

// CheckVisibility checks if it is safe to read using startTS (the startTS should
//  be greater than current GC safepoint).
func (s *TiKVStore) CheckVisibility(startTS uint64) error {
	s.spMutex.RLock()
	cachedSafePoint := s.safePoint
	cachedTime := s.spTime
	s.spMutex.RUnlock()
	diff := time.Since(cachedTime)

	if diff > (s.conf.Txn.GcSafePointCacheInterval - s.conf.Txn.GcCPUTimeInaccuracyBound) {
		return errors.WithStack(ErrPDServerTimeout)
	}

	if startTS < cachedSafePoint {
		return errors.WithStack(ErrStartTSFallBehind)
	}

	return nil
}