// Copyright 2023 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 importer import ( "context" "fmt" "io" "math" "net" "os" "path/filepath" "strconv" "sync" "time" "unicode/utf8" "github.com/docker/go-units" "github.com/pingcap/errors" "github.com/pingcap/tidb/br/pkg/lightning/backend" "github.com/pingcap/tidb/br/pkg/lightning/backend/encode" "github.com/pingcap/tidb/br/pkg/lightning/backend/kv" "github.com/pingcap/tidb/br/pkg/lightning/backend/local" "github.com/pingcap/tidb/br/pkg/lightning/checkpoints" "github.com/pingcap/tidb/br/pkg/lightning/common" "github.com/pingcap/tidb/br/pkg/lightning/config" "github.com/pingcap/tidb/br/pkg/lightning/log" "github.com/pingcap/tidb/br/pkg/lightning/mydump" "github.com/pingcap/tidb/br/pkg/storage" tidb "github.com/pingcap/tidb/pkg/config" tidbkv "github.com/pingcap/tidb/pkg/kv" "github.com/pingcap/tidb/pkg/meta/autoid" "github.com/pingcap/tidb/pkg/table" "github.com/pingcap/tidb/pkg/table/tables" "github.com/pingcap/tidb/pkg/util/syncutil" pd "github.com/tikv/pd/client" "go.uber.org/multierr" "go.uber.org/zap" ) // NewTiKVModeSwitcher make it a var, so we can mock it in tests. var NewTiKVModeSwitcher = local.NewTiKVModeSwitcher var ( // CheckDiskQuotaInterval is the default time interval to check disk quota. // TODO: make it dynamically adjusting according to the speed of import and the disk size. CheckDiskQuotaInterval = 10 * time.Second // defaultMaxEngineSize is the default max engine size in bytes. // we make it 5 times larger than lightning default engine size to reduce range overlap, especially for index, // since we have an index engine per distributed subtask. // for 1TiB data, we can divide it into 2 engines that runs on 2 TiDB. it can have a good balance between // range overlap and sort speed in one of our test of: // - 10 columns, PK + 6 secondary index 2 of which is mv index // - 1.05 KiB per row, 527 MiB per file, 1024000000 rows, 1 TiB total // // it might not be the optimal value for other cases. defaultMaxEngineSize = int64(5 * config.DefaultBatchSize) ) // prepareSortDir creates a new directory for import, remove previous sort directory if exists. func prepareSortDir(e *LoadDataController, taskID int64, tidbCfg *tidb.Config) (string, error) { sortPathSuffix := "import-" + strconv.Itoa(int(tidbCfg.Port)) importDir := filepath.Join(tidbCfg.TempDir, sortPathSuffix) sortDir := filepath.Join(importDir, strconv.FormatInt(taskID, 10)) if info, err := os.Stat(importDir); err != nil || !info.IsDir() { if err != nil && !os.IsNotExist(err) { e.logger.Error("stat import dir failed", zap.String("import_dir", importDir), zap.Error(err)) return "", errors.Trace(err) } if info != nil && !info.IsDir() { e.logger.Warn("import dir is not a dir, remove it", zap.String("import_dir", importDir)) if err := os.RemoveAll(importDir); err != nil { return "", errors.Trace(err) } } e.logger.Info("import dir not exists, create it", zap.String("import_dir", importDir)) if err := os.MkdirAll(importDir, 0o700); err != nil { e.logger.Error("failed to make dir", zap.String("import_dir", importDir), zap.Error(err)) return "", errors.Trace(err) } } // todo: remove this after we support checkpoint if _, err := os.Stat(sortDir); err != nil { if !os.IsNotExist(err) { e.logger.Error("stat sort dir failed", zap.String("sort_dir", sortDir), zap.Error(err)) return "", errors.Trace(err) } } else { e.logger.Warn("sort dir already exists, remove it", zap.String("sort_dir", sortDir)) if err := os.RemoveAll(sortDir); err != nil { return "", errors.Trace(err) } } return sortDir, nil } // GetTiKVModeSwitcherWithPDClient creates a new TiKV mode switcher with its pd Client. func GetTiKVModeSwitcherWithPDClient(ctx context.Context, logger *zap.Logger) (pd.Client, local.TiKVModeSwitcher, error) { tidbCfg := tidb.GetGlobalConfig() hostPort := net.JoinHostPort("127.0.0.1", strconv.Itoa(int(tidbCfg.Status.StatusPort))) tls, err := common.NewTLS( tidbCfg.Security.ClusterSSLCA, tidbCfg.Security.ClusterSSLCert, tidbCfg.Security.ClusterSSLKey, hostPort, nil, nil, nil, ) if err != nil { return nil, nil, err } tlsOpt := tls.ToPDSecurityOption() pdCli, err := pd.NewClientWithContext(ctx, []string{tidbCfg.Path}, tlsOpt) if err != nil { return nil, nil, errors.Trace(err) } return pdCli, NewTiKVModeSwitcher(tls, pdCli, logger), nil } // GetCachedKVStoreFrom gets a cached kv store from PD address. // Callers should NOT close the kv store. func GetCachedKVStoreFrom(pdAddr string, tls *common.TLS) (tidbkv.Storage, error) { // Disable GC because TiDB enables GC already. keySpaceName := tidb.GetGlobalKeyspaceName() // the kv store we get is a cached store, so we can't close it. kvStore, err := GetKVStore(fmt.Sprintf("tikv://%s?disableGC=true&keyspaceName=%s", pdAddr, keySpaceName), tls.ToTiKVSecurityConfig()) if err != nil { return nil, errors.Trace(err) } return kvStore, nil } // GetRegionSplitSizeKeys gets the region split size and keys from PD. func GetRegionSplitSizeKeys(ctx context.Context) (regionSplitSize int64, regionSplitKeys int64, err error) { tidbCfg := tidb.GetGlobalConfig() tls, err := common.NewTLS( tidbCfg.Security.ClusterSSLCA, tidbCfg.Security.ClusterSSLCert, tidbCfg.Security.ClusterSSLKey, "", nil, nil, nil, ) if err != nil { return 0, 0, err } tlsOpt := tls.ToPDSecurityOption() pdCli, err := pd.NewClientWithContext(ctx, []string{tidbCfg.Path}, tlsOpt) if err != nil { return 0, 0, errors.Trace(err) } defer pdCli.Close() return local.GetRegionSplitSizeKeys(ctx, pdCli, tls) } // NewTableImporter creates a new table importer. func NewTableImporter(param *JobImportParam, e *LoadDataController, taskID int64) (ti *TableImporter, err error) { idAlloc := kv.NewPanickingAllocators(0) tbl, err := tables.TableFromMeta(idAlloc, e.Table.Meta()) if err != nil { return nil, errors.Annotatef(err, "failed to tables.TableFromMeta %s", e.Table.Meta().Name) } tidbCfg := tidb.GetGlobalConfig() // todo: we only need to prepare this once on each node(we might call it 3 times in distribution framework) dir, err := prepareSortDir(e, taskID, tidbCfg) if err != nil { return nil, err } hostPort := net.JoinHostPort("127.0.0.1", strconv.Itoa(int(tidbCfg.Status.StatusPort))) tls, err := common.NewTLS( tidbCfg.Security.ClusterSSLCA, tidbCfg.Security.ClusterSSLCert, tidbCfg.Security.ClusterSSLKey, hostPort, nil, nil, nil, ) if err != nil { return nil, err } // no need to close kvStore, since it's a cached store. kvStore, err := GetCachedKVStoreFrom(tidbCfg.Path, tls) if err != nil { return nil, errors.Trace(err) } backendConfig := e.getLocalBackendCfg(tidbCfg.Path, dir) // todo: use a real region size getter regionSizeGetter := &local.TableRegionSizeGetterImpl{} localBackend, err := local.NewBackend(param.GroupCtx, tls, backendConfig, regionSizeGetter) if err != nil { return nil, err } return &TableImporter{ JobImportParam: param, LoadDataController: e, backend: localBackend, tableInfo: &checkpoints.TidbTableInfo{ ID: e.Table.Meta().ID, Name: e.Table.Meta().Name.O, Core: e.Table.Meta(), }, encTable: tbl, dbID: e.DBID, kvStore: kvStore, logger: e.logger, // this is the value we use for 50TiB data parallel import. // this might not be the optimal value. // todo: use different default for single-node import and distributed import. regionSplitSize: 2 * int64(config.SplitRegionSize), regionSplitKeys: 2 * int64(config.SplitRegionKeys), diskQuota: adjustDiskQuota(int64(e.DiskQuota), dir, e.logger), diskQuotaLock: new(syncutil.RWMutex), }, nil } // TableImporter is a table importer. type TableImporter struct { *JobImportParam *LoadDataController backend *local.Backend tableInfo *checkpoints.TidbTableInfo // this table has a separate id allocator used to record the max row id allocated. encTable table.Table dbID int64 // the kv store we get is a cached store, so we can't close it. kvStore tidbkv.Storage logger *zap.Logger regionSplitSize int64 regionSplitKeys int64 diskQuota int64 diskQuotaLock *syncutil.RWMutex } func (ti *TableImporter) getParser(ctx context.Context, chunk *checkpoints.ChunkCheckpoint) (mydump.Parser, error) { info := LoadDataReaderInfo{ Opener: func(ctx context.Context) (io.ReadSeekCloser, error) { reader, err := mydump.OpenReader(ctx, &chunk.FileMeta, ti.dataStore, storage.DecompressConfig{ ZStdDecodeConcurrency: 1, }) if err != nil { return nil, errors.Trace(err) } return reader, nil }, Remote: &chunk.FileMeta, } parser, err := ti.LoadDataController.GetParser(ctx, info) if err != nil { return nil, err } if chunk.Chunk.Offset == 0 { // if data file is split, only the first chunk need to do skip. // see check in initOptions. if err = ti.LoadDataController.HandleSkipNRows(parser); err != nil { return nil, err } parser.SetRowID(chunk.Chunk.PrevRowIDMax) } else { // if we reached here, the file must be an uncompressed CSV file. if err = parser.SetPos(chunk.Chunk.Offset, chunk.Chunk.PrevRowIDMax); err != nil { return nil, err } } return parser, nil } func (ti *TableImporter) getKVEncoder(chunk *checkpoints.ChunkCheckpoint) (KVEncoder, error) { cfg := &encode.EncodingConfig{ SessionOptions: encode.SessionOptions{ SQLMode: ti.SQLMode, Timestamp: chunk.Timestamp, SysVars: ti.ImportantSysVars, AutoRandomSeed: chunk.Chunk.PrevRowIDMax, }, Path: chunk.FileMeta.Path, Table: ti.encTable, Logger: log.Logger{Logger: ti.logger.With(zap.String("path", chunk.FileMeta.Path))}, } return NewTableKVEncoder(cfg, ti) } func (e *LoadDataController) calculateSubtaskCnt() int { // we want to split data files into subtask of size close to MaxEngineSize to reduce range overlap, // and evenly distribute them to subtasks. // we calculate subtask count first by round(TotalFileSize / maxEngineSize) // AllocateEngineIDs is using ceil() to calculate subtask count, engine size might be too small in some case, // such as 501G data, maxEngineSize will be about 250G, so we don't relay on it. // see https://github.com/pingcap/tidb/blob/b4183e1dc9bb01fb81d3aa79ca4b5b74387c6c2a/br/pkg/lightning/mydump/region.go#L109 // // for default e.MaxEngineSize = 500GiB, we have: // data size range(G) cnt adjusted-engine-size range(G) // [0, 750) 1 [0, 750) // [750, 1250) 2 [375, 625) // [1250, 1750) 3 [416, 583) // [1750, 2250) 4 [437, 562) var ( subtaskCount float64 maxEngineSize = int64(e.MaxEngineSize) ) if e.TotalFileSize <= maxEngineSize { subtaskCount = 1 } else { subtaskCount = math.Round(float64(e.TotalFileSize) / float64(e.MaxEngineSize)) } // for global sort task, since there is no overlap, // we make sure subtask count is a multiple of execute nodes count if e.IsGlobalSort() && e.ExecuteNodesCnt > 0 { subtaskCount = math.Ceil(subtaskCount/float64(e.ExecuteNodesCnt)) * float64(e.ExecuteNodesCnt) } return int(subtaskCount) } func (e *LoadDataController) getAdjustedMaxEngineSize() int64 { subtaskCount := e.calculateSubtaskCnt() // we adjust MaxEngineSize to make sure each subtask has a similar amount of data to import. return int64(math.Ceil(float64(e.TotalFileSize) / float64(subtaskCount))) } // SetExecuteNodeCnt sets the execute node count. func (e *LoadDataController) SetExecuteNodeCnt(cnt int) { e.ExecuteNodesCnt = cnt } // PopulateChunks populates chunks from table regions. // in dist framework, this should be done in the tidb node which is responsible for splitting job into subtasks // then table-importer handles data belongs to the subtask. func (e *LoadDataController) PopulateChunks(ctx context.Context) (ecp map[int32]*checkpoints.EngineCheckpoint, err error) { task := log.BeginTask(e.logger, "populate chunks") defer func() { task.End(zap.ErrorLevel, err) }() tableMeta := &mydump.MDTableMeta{ DB: e.DBName, Name: e.Table.Meta().Name.O, DataFiles: e.toMyDumpFiles(), } adjustedMaxEngineSize := e.getAdjustedMaxEngineSize() e.logger.Info("adjust max engine size", zap.Int64("before", int64(e.MaxEngineSize)), zap.Int64("after", adjustedMaxEngineSize)) dataDivideCfg := &mydump.DataDivideConfig{ ColumnCnt: len(e.Table.Meta().Columns), EngineDataSize: adjustedMaxEngineSize, MaxChunkSize: int64(config.MaxRegionSize), Concurrency: int(e.ThreadCnt), IOWorkers: nil, Store: e.dataStore, TableMeta: tableMeta, StrictFormat: e.SplitFile, DataCharacterSet: *e.Charset, DataInvalidCharReplace: string(utf8.RuneError), ReadBlockSize: LoadDataReadBlockSize, CSV: *e.GenerateCSVConfig(), } tableRegions, err2 := mydump.MakeTableRegions(ctx, dataDivideCfg) if err2 != nil { e.logger.Error("populate chunks failed", zap.Error(err2)) return nil, err2 } var maxRowID int64 timestamp := time.Now().Unix() tableCp := &checkpoints.TableCheckpoint{ Engines: map[int32]*checkpoints.EngineCheckpoint{}, } for _, region := range tableRegions { engine, found := tableCp.Engines[region.EngineID] if !found { engine = &checkpoints.EngineCheckpoint{ Status: checkpoints.CheckpointStatusLoaded, } tableCp.Engines[region.EngineID] = engine } ccp := &checkpoints.ChunkCheckpoint{ Key: checkpoints.ChunkCheckpointKey{ Path: region.FileMeta.Path, Offset: region.Chunk.Offset, }, FileMeta: region.FileMeta, ColumnPermutation: nil, Chunk: region.Chunk, Timestamp: timestamp, } engine.Chunks = append(engine.Chunks, ccp) if region.Chunk.RowIDMax > maxRowID { maxRowID = region.Chunk.RowIDMax } } // Add index engine checkpoint tableCp.Engines[common.IndexEngineID] = &checkpoints.EngineCheckpoint{Status: checkpoints.CheckpointStatusLoaded} return tableCp.Engines, nil } // a simplified version of EstimateCompactionThreshold func (ti *TableImporter) getTotalRawFileSize(indexCnt int64) int64 { var totalSize int64 for _, file := range ti.dataFiles { size := file.RealSize if file.Type == mydump.SourceTypeParquet { // parquet file is compressed, thus estimates with a factor of 2 size *= 2 } totalSize += size } return totalSize * indexCnt } // OpenIndexEngine opens an index engine. func (ti *TableImporter) OpenIndexEngine(ctx context.Context, engineID int32) (*backend.OpenedEngine, error) { idxEngineCfg := &backend.EngineConfig{ TableInfo: ti.tableInfo, } idxCnt := len(ti.tableInfo.Core.Indices) if !common.TableHasAutoRowID(ti.tableInfo.Core) { idxCnt-- } // todo: getTotalRawFileSize returns size of all data files, but in distributed framework, // we create one index engine for each engine, should reflect this in the future. threshold := local.EstimateCompactionThreshold2(ti.getTotalRawFileSize(int64(idxCnt))) idxEngineCfg.Local = backend.LocalEngineConfig{ Compact: threshold > 0, CompactConcurrency: 4, CompactThreshold: threshold, } fullTableName := ti.fullTableName() // todo: cleanup all engine data on any error since we don't support checkpoint for now // some return path, didn't make sure all data engine and index engine are cleaned up. // maybe we can add this in upper level to clean the whole local-sort directory mgr := backend.MakeEngineManager(ti.backend) return mgr.OpenEngine(ctx, idxEngineCfg, fullTableName, engineID) } // OpenDataEngine opens a data engine. func (ti *TableImporter) OpenDataEngine(ctx context.Context, engineID int32) (*backend.OpenedEngine, error) { dataEngineCfg := &backend.EngineConfig{ TableInfo: ti.tableInfo, } // todo: support checking IsRowOrdered later. // also see test result here: https://github.com/pingcap/tidb/pull/47147 //if ti.tableMeta.IsRowOrdered { // dataEngineCfg.Local.Compact = true // dataEngineCfg.Local.CompactConcurrency = 4 // dataEngineCfg.Local.CompactThreshold = local.CompactionUpperThreshold //} mgr := backend.MakeEngineManager(ti.backend) return mgr.OpenEngine(ctx, dataEngineCfg, ti.fullTableName(), engineID) } // ImportAndCleanup imports the engine and cleanup the engine data. func (ti *TableImporter) ImportAndCleanup(ctx context.Context, closedEngine *backend.ClosedEngine) (int64, error) { var kvCount int64 importErr := closedEngine.Import(ctx, ti.regionSplitSize, ti.regionSplitKeys) if closedEngine.GetID() != common.IndexEngineID { // todo: change to a finer-grain progress later. // each row is encoded into 1 data key kvCount = ti.backend.GetImportedKVCount(closedEngine.GetUUID()) } // todo: if we need support checkpoint, engine should not be cleanup if import failed. cleanupErr := closedEngine.Cleanup(ctx) return kvCount, multierr.Combine(importErr, cleanupErr) } // FullTableName return FQDN of the table. func (ti *TableImporter) fullTableName() string { return common.UniqueTable(ti.DBName, ti.Table.Meta().Name.O) } // Backend returns the backend of the importer. func (ti *TableImporter) Backend() *local.Backend { return ti.backend } // Close implements the io.Closer interface. func (ti *TableImporter) Close() error { ti.backend.Close() return nil } // Allocators returns allocators used to record max used ID, i.e. PanickingAllocators. func (ti *TableImporter) Allocators() autoid.Allocators { return ti.encTable.Allocators(nil) } // CheckDiskQuota checks disk quota. func (ti *TableImporter) CheckDiskQuota(ctx context.Context) { var locker sync.Locker lockDiskQuota := func() { if locker == nil { ti.diskQuotaLock.Lock() locker = ti.diskQuotaLock } } unlockDiskQuota := func() { if locker != nil { locker.Unlock() locker = nil } } defer unlockDiskQuota() for { select { case <-ctx.Done(): return case <-time.After(CheckDiskQuotaInterval): } largeEngines, inProgressLargeEngines, totalDiskSize, totalMemSize := local.CheckDiskQuota(ti.backend, ti.diskQuota) if len(largeEngines) == 0 && inProgressLargeEngines == 0 { unlockDiskQuota() continue } ti.logger.Warn("disk quota exceeded", zap.Int64("diskSize", totalDiskSize), zap.Int64("memSize", totalMemSize), zap.Int64("quota", ti.diskQuota), zap.Int("largeEnginesCount", len(largeEngines)), zap.Int("inProgressLargeEnginesCount", inProgressLargeEngines)) lockDiskQuota() if len(largeEngines) == 0 { ti.logger.Warn("all large engines are already importing, keep blocking all writes") continue } if err := ti.backend.FlushAllEngines(ctx); err != nil { ti.logger.Error("flush engine for disk quota failed, check again later", log.ShortError(err)) unlockDiskQuota() continue } // at this point, all engines are synchronized on disk. // we then import every large engines one by one and complete. // if any engine failed to import, we just try again next time, since the data are still intact. var importErr error for _, engine := range largeEngines { // Use a larger split region size to avoid split the same region by many times. if err := ti.backend.UnsafeImportAndReset( ctx, engine, int64(config.SplitRegionSize)*int64(config.MaxSplitRegionSizeRatio), int64(config.SplitRegionKeys)*int64(config.MaxSplitRegionSizeRatio), ); err != nil { importErr = multierr.Append(importErr, err) } } if importErr != nil { // discuss: should we return the error and cancel the import? ti.logger.Error("import large engines failed, check again later", log.ShortError(importErr)) } unlockDiskQuota() } } func adjustDiskQuota(diskQuota int64, sortDir string, logger *zap.Logger) int64 { sz, err := common.GetStorageSize(sortDir) if err != nil { logger.Warn("failed to get storage size", zap.Error(err)) if diskQuota != 0 { return diskQuota } logger.Info("use default quota instead", zap.Int64("quota", int64(DefaultDiskQuota))) return int64(DefaultDiskQuota) } maxDiskQuota := int64(float64(sz.Capacity) * 0.8) switch { case diskQuota == 0: logger.Info("use 0.8 of the storage size as default disk quota", zap.String("quota", units.HumanSize(float64(maxDiskQuota)))) return maxDiskQuota case diskQuota > maxDiskQuota: logger.Warn("disk quota is larger than 0.8 of the storage size, use 0.8 of the storage size instead", zap.String("quota", units.HumanSize(float64(maxDiskQuota)))) return maxDiskQuota default: return diskQuota } }