Files
tidb/pkg/store/driver/txn/error.go

261 lines
8.4 KiB
Go

// Copyright 2021 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,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package txn
import (
"bytes"
"context"
"encoding/hex"
"encoding/json"
"fmt"
"strconv"
"strings"
"time"
"github.com/pingcap/errors"
"github.com/pingcap/kvproto/pkg/kvrpcpb"
"github.com/pingcap/tidb/pkg/kv"
"github.com/pingcap/tidb/pkg/meta/model"
"github.com/pingcap/tidb/pkg/parser/mysql"
derr "github.com/pingcap/tidb/pkg/store/driver/error"
"github.com/pingcap/tidb/pkg/table/tables"
"github.com/pingcap/tidb/pkg/tablecodec"
"github.com/pingcap/tidb/pkg/types"
"github.com/pingcap/tidb/pkg/util"
"github.com/pingcap/tidb/pkg/util/logutil"
tikverr "github.com/tikv/client-go/v2/error"
"go.uber.org/zap"
)
// genKeyExistsError is the fallback path when can't extract key columns for
// kv.GenKeyExistsErr.
func genKeyExistsError(name string, value string, err error) error {
if err != nil {
logutil.BgLogger().Info("extractKeyExistsErr meets error", zap.Error(err))
}
return kv.ErrKeyExists.FastGenByArgs(value, name)
}
// ExtractKeyExistsErrFromHandle returns a ErrKeyExists error from a handle key.
func ExtractKeyExistsErrFromHandle(key kv.Key, value []byte, tblInfo *model.TableInfo) error {
name := tblInfo.Name.String() + ".PRIMARY"
_, handle, err := tablecodec.DecodeRecordKey(key)
if err != nil {
return genKeyExistsError(name, key.String(), err)
}
if handle.IsInt() {
if pkInfo := tblInfo.GetPkColInfo(); pkInfo != nil {
if mysql.HasUnsignedFlag(pkInfo.GetFlag()) {
handleStr := strconv.FormatUint(uint64(handle.IntValue()), 10)
return kv.GenKeyExistsErr([]string{handleStr}, name)
}
}
return kv.GenKeyExistsErr([]string{handle.String()}, name)
}
if len(value) == 0 {
return genKeyExistsError(name, handle.String(), errors.New("missing value"))
}
idxInfo := tables.FindPrimaryIndex(tblInfo)
if idxInfo == nil {
return genKeyExistsError(name, handle.String(), errors.New("cannot find index info"))
}
cols := make(map[int64]*types.FieldType, len(tblInfo.Columns))
for _, col := range tblInfo.Columns {
cols[col.ID] = &(col.FieldType)
}
handleColIDs := make([]int64, 0, len(idxInfo.Columns))
for _, col := range idxInfo.Columns {
handleColIDs = append(handleColIDs, tblInfo.Columns[col.Offset].ID)
}
row, err := tablecodec.DecodeRowToDatumMap(value, cols, time.Local)
if err != nil {
return genKeyExistsError(name, handle.String(), err)
}
data, err := tablecodec.DecodeHandleToDatumMap(handle, handleColIDs, cols, time.Local, row)
if err != nil {
return genKeyExistsError(name, handle.String(), err)
}
valueStr := make([]string, 0, len(data))
for _, col := range idxInfo.Columns {
d := data[tblInfo.Columns[col.Offset].ID]
str, err := d.ToString()
if err != nil {
return genKeyExistsError(name, key.String(), err)
}
if col.Length > 0 && len(str) > col.Length {
str = str[:col.Length]
}
if types.IsBinaryStr(&tblInfo.Columns[col.Offset].FieldType) || types.IsTypeBit(&tblInfo.Columns[col.Offset].FieldType) {
str = util.FmtNonASCIIPrintableCharToHex(str, len(str), true)
}
valueStr = append(valueStr, str)
}
return kv.GenKeyExistsErr(valueStr, name)
}
// ExtractKeyExistsErrFromIndex returns a ErrKeyExists error from a index key.
func ExtractKeyExistsErrFromIndex(key kv.Key, value []byte, tblInfo *model.TableInfo, indexID int64) error {
var idxInfo *model.IndexInfo
for _, index := range tblInfo.Indices {
if index.ID == indexID {
idxInfo = index
}
}
if idxInfo == nil {
return genKeyExistsError("UNKNOWN", key.String(), errors.New("cannot find index info"))
}
name := tblInfo.Name.String() + "." + idxInfo.Name.String()
if len(value) == 0 {
return genKeyExistsError(name, key.String(), errors.New("missing value"))
}
colInfo := tables.BuildRowcodecColInfoForIndexColumns(idxInfo, tblInfo)
values, err := tablecodec.DecodeIndexKV(key, value, len(idxInfo.Columns), tablecodec.HandleNotNeeded, colInfo)
if err != nil {
return genKeyExistsError(name, key.String(), err)
}
valueStr := make([]string, 0, len(values))
for i, val := range values {
d, err := tablecodec.DecodeColumnValue(val, colInfo[i].Ft, time.Local)
if err != nil {
return genKeyExistsError(name, key.String(), err)
}
str, err := d.ToString()
if err != nil {
return genKeyExistsError(name, key.String(), err)
}
if types.IsBinaryStr(colInfo[i].Ft) || types.IsTypeBit(colInfo[i].Ft) {
str = util.FmtNonASCIIPrintableCharToHex(str, len(str), true)
}
valueStr = append(valueStr, str)
}
return genKeyExistsError(name, strings.Join(valueStr, "-"), nil)
}
func extractKeyErr(err error) error {
if err == nil {
return nil
}
if e, ok := errors.Cause(err).(*tikverr.ErrWriteConflict); ok {
return newWriteConflictError(e.WriteConflict)
}
if e, ok := errors.Cause(err).(*tikverr.ErrRetryable); ok {
notFoundDetail := prettyLockNotFoundKey(e.Retryable)
return kv.ErrTxnRetryable.GenWithStackByArgs(e.Retryable + " " + notFoundDetail)
}
return derr.ToTiDBErr(err)
}
func newWriteConflictError(conflict *kvrpcpb.WriteConflict) error {
if conflict == nil {
return kv.ErrWriteConflict
}
var bufConflictKeyTableID bytes.Buffer // table id part of conflict key, which is used to be parsed by upper level to provide more information about the table
var bufConflictKeyRest bytes.Buffer // the rest part of conflict key
var bufPrimaryKeyTableID bytes.Buffer // table id part of primary key
var bufPrimaryKeyRest bytes.Buffer // the rest part of primary key
prettyWriteKey(&bufConflictKeyTableID, &bufConflictKeyRest, conflict.Key)
bufConflictKeyRest.WriteString(", originalKey=" + hex.EncodeToString(conflict.Key))
bufConflictKeyRest.WriteString(", primary=")
prettyWriteKey(&bufPrimaryKeyTableID, &bufPrimaryKeyRest, conflict.Primary)
bufPrimaryKeyRest.WriteString(", originalPrimaryKey=" + hex.EncodeToString(conflict.Primary))
return kv.ErrWriteConflict.FastGenByArgs(conflict.StartTs, conflict.ConflictTs, conflict.ConflictCommitTs,
bufConflictKeyTableID.String(), bufConflictKeyRest.String(), bufPrimaryKeyTableID.String(),
bufPrimaryKeyRest.String(), conflict.Reason.String(),
)
}
func prettyWriteKey(bufTableID, bufRest *bytes.Buffer, key []byte) {
tableID, indexID, indexValues, err := tablecodec.DecodeIndexKey(key)
if err == nil {
_, err1 := fmt.Fprintf(bufTableID, "{tableID=%d", tableID)
if err1 != nil {
logutil.BgLogger().Error("error", zap.Error(err1))
}
_, err1 = fmt.Fprintf(bufRest, ", indexID=%d, indexValues={", indexID)
if err1 != nil {
logutil.BgLogger().Error("error", zap.Error(err1))
}
for _, v := range indexValues {
_, err2 := fmt.Fprintf(bufRest, "%s, ", v)
if err2 != nil {
logutil.BgLogger().Error("error", zap.Error(err2))
}
}
bufRest.WriteString("}}")
return
}
tableID, handle, err := tablecodec.DecodeRecordKey(key)
if err == nil {
_, err3 := fmt.Fprintf(bufTableID, "{tableID=%d", tableID)
if err3 != nil {
logutil.BgLogger().Error("error", zap.Error(err3))
}
_, err3 = fmt.Fprintf(bufRest, ", handle=%s}", handle.String())
if err3 != nil {
logutil.BgLogger().Error("error", zap.Error(err3))
}
return
}
mKey, mField, err := tablecodec.DecodeMetaKey(key)
if err == nil {
_, err3 := fmt.Fprintf(bufRest, "{metaKey=true, key=%s, field=%s}", string(mKey), string(mField))
if err3 != nil {
logutil.Logger(context.Background()).Error("error", zap.Error(err3))
}
return
}
_, err4 := fmt.Fprintf(bufRest, "%#v", key)
if err4 != nil {
logutil.BgLogger().Error("error", zap.Error(err4))
}
}
func prettyLockNotFoundKey(rawRetry string) string {
if !strings.Contains(rawRetry, "TxnLockNotFound") {
return ""
}
start := strings.Index(rawRetry, "[")
if start == -1 {
return ""
}
rawRetry = rawRetry[start:]
end := strings.Index(rawRetry, "]")
if end == -1 {
return ""
}
rawRetry = rawRetry[:end+1]
var key []byte
err := json.Unmarshal([]byte(rawRetry), &key)
if err != nil {
return ""
}
var buf1 bytes.Buffer
var buf2 bytes.Buffer
prettyWriteKey(&buf1, &buf2, key)
return buf1.String() + buf2.String()
}