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

executor: change sort to parallel #9418

Closed
wants to merge 22 commits into from
Closed
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion executor/builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -1134,7 +1134,7 @@ func (b *executorBuilder) buildSort(v *plannercore.PhysicalSort) Executor {
b.err = errors.Trace(b.err)
return nil
}
sortExec := SortExec{
sortExec := MergeSortExec{
baseExecutor: newBaseExecutor(b.ctx, v.Schema(), v.ExplainID(), childExec),
ByItems: v.ByItems,
schema: v.Schema(),
Expand Down
1 change: 1 addition & 0 deletions executor/executor.go
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ var (
_ Executor = &HashJoinExec{}
_ Executor = &IndexLookUpExecutor{}
_ Executor = &MergeJoinExec{}
_ Executor = &MergeSortExec{}
)

type baseExecutor struct {
Expand Down
341 changes: 341 additions & 0 deletions executor/merge_sort.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,341 @@
// 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 executor

import (
"context"
"sort"
"sync"
"time"

"github.com/opentracing/opentracing-go"
"github.com/pingcap/errors"
"github.com/pingcap/tidb/expression"
plannercore "github.com/pingcap/tidb/planner/core"
"github.com/pingcap/tidb/types"
"github.com/pingcap/tidb/util"
"github.com/pingcap/tidb/util/chunk"
"github.com/pingcap/tidb/util/memory"
)

// MergeSortExec represents sorting executor.
type MergeSortExec struct {
baseExecutor

ByItems []*plannercore.ByItems
fetched bool
schema *expression.Schema

keyExprs []expression.Expression
keyTypes []*types.FieldType
// keyColumns is the column index of the by items.
keyColumns []int
// keyCmpFuncs is used to compare each ByItem.
keyCmpFuncs []chunk.CompareFunc
// keyChunks is used to store ByItems values when not all ByItems are column.
keyChunks *chunk.List
yu34po marked this conversation as resolved.
Show resolved Hide resolved
// rowChunks is the chunks to store row values.
rowChunks *chunk.List
// rowPointer store the chunk index and row index for each row.
workerRowPtrs []*[]chunk.RowPtr

workerRowLen []int
workerRowIdx []int

memTracker *memory.Tracker
concurrency int
allColumnExpr bool
}

// sortWorker represents worker routine to process sort.
type sortWorker struct {
MergeSortExec
chkIdx int
rowIdx int
len int
rowPtrs []chunk.RowPtr
}

func (sw *sortWorker) run() {
//sw.memTracker.Consume(int64(8 * sw.rowChunks.Len()))
for chkIdx := sw.chkIdx; chkIdx < sw.rowChunks.NumChunks() && len(sw.rowPtrs) < sw.len; chkIdx++ {
rowChk := sw.rowChunks.GetChunk(chkIdx)
rowIdx := 0
if chkIdx == sw.chkIdx {
rowIdx = sw.rowIdx
}
for ; rowIdx < rowChk.NumRows() && len(sw.rowPtrs) < sw.len; rowIdx++ {
sw.rowPtrs = append(sw.rowPtrs, chunk.RowPtr{ChkIdx: uint32(chkIdx), RowIdx: uint32(rowIdx)})
}
}
if sw.allColumnExpr {
sort.Slice(sw.rowPtrs, sw.keyColumnsLess)
} else {
sort.Slice(sw.rowPtrs, sw.keyChunksLess)
}
return
}

// Close implements the Executor Close interface.
func (e *MergeSortExec) Close() error {
e.memTracker.Detach()
e.memTracker = nil
return e.children[0].Close()
}

// Open implements the Executor Open interface.
func (e *MergeSortExec) Open(ctx context.Context) error {
e.fetched = false
e.concurrency = e.ctx.GetSessionVars().MergeSortConcurrency

e.workerRowIdx = make([]int, e.concurrency)
e.workerRowLen = make([]int, e.concurrency)
e.workerRowPtrs = make([]*[]chunk.RowPtr, e.concurrency)
// To avoid duplicated initialization for TopNExec.
if e.memTracker == nil {
e.memTracker = memory.NewTracker(e.id, e.ctx.GetSessionVars().MemQuotaSort)
e.memTracker.AttachTo(e.ctx.GetSessionVars().StmtCtx.MemTracker)
}
return errors.Trace(e.children[0].Open(ctx))
}

func (e *MergeSortExec) newsortWorker(workerID, chk, row, len int) *sortWorker {
sw := &sortWorker{
MergeSortExec: *e,
chkIdx: chk,
rowIdx: row,
len: len,
rowPtrs: make([]chunk.RowPtr, 0, len),
}
e.workerRowLen[workerID] = len
e.workerRowIdx[workerID] = 0
e.workerRowPtrs[workerID] = &sw.rowPtrs
return sw
}

func (e *MergeSortExec) wait4WorkerSort(wg *sync.WaitGroup, finishedCh chan struct{}) {
wg.Wait()
close(finishedCh)
}

//sortWorkerIndex calc the chunk index and row index with every worker start to sort, first column of swIdx is chunk idx, second columm of swIdx is row idx
func (e *MergeSortExec) sortWorkerIndex(workerRowsCount int) [][]int {
chkIdx := 0
rowIdx := 0
swIdx := make([][]int, e.concurrency)
swIdx[0] = []int{0, 0}
for i := 1; i < e.concurrency; i++ {
count := 0
swIdx[i] = []int{0, 0}
for j := chkIdx; j < e.rowChunks.NumChunks(); j++ {
curChk := e.rowChunks.GetChunk(j)
count += curChk.NumRows()
if j == chkIdx {
count -= rowIdx
}
if count > workerRowsCount {
rowIdx = curChk.NumRows() - (count - workerRowsCount)
chkIdx = j
swIdx[i] = []int{chkIdx, rowIdx}
break
}
}
}
return swIdx
}

// Next implements the Executor Next interface.
func (e *MergeSortExec) Next(ctx context.Context, req *chunk.RecordBatch) error {
if span := opentracing.SpanFromContext(ctx); span != nil && span.Tracer() != nil {
span1 := span.Tracer().StartSpan("sort.Next", opentracing.ChildOf(span.Context()))
defer span1.Finish()
}
if e.runtimeStats != nil {
start := time.Now()
defer func() { e.runtimeStats.Record(time.Since(start), req.NumRows()) }()
}
req.Reset()
if !e.fetched {
err := e.fetchRowChunks(ctx)
if err != nil {
return errors.Trace(err)
}

e.initCompareFuncs()
e.allColumnExpr = e.buildKeyColumns()
if !e.allColumnExpr {
e.buildKeyExprsAndTypes()
err := e.buildKeyChunks()
if err != nil {
return err
}
}
finishedCh := make(chan struct{})

workerRowsCount := e.rowChunks.Len() / e.concurrency
workerIdx := e.sortWorkerIndex(workerRowsCount)

wg := &sync.WaitGroup{}
wg.Add(int(e.concurrency))
go e.wait4WorkerSort(wg, finishedCh)
yu34po marked this conversation as resolved.
Show resolved Hide resolved

for i := 0; i < e.concurrency; i++ {
// Last worker must complete the rest of rows.
if i == e.concurrency-1 {
workerRowsCount += e.rowChunks.Len() % e.concurrency
}
sw := e.newsortWorker(i, workerIdx[i][0], workerIdx[i][1], workerRowsCount)
go util.WithRecovery(func() {
defer wg.Done()
sw.run()
}, nil)
}

<-finishedCh
e.fetched = true
}

for req.NumRows() < e.maxChunkSize {
yu34po marked this conversation as resolved.
Show resolved Hide resolved
j := 0
for j < e.concurrency && e.workerRowIdx[j] >= e.workerRowLen[j] {
j++
}
if j >= e.concurrency {
break
}
minRowPtr := (*e.workerRowPtrs[j])[e.workerRowIdx[j]]
for i := j + 1; i < e.concurrency; i++ {
yu34po marked this conversation as resolved.
Show resolved Hide resolved
if e.workerRowIdx[i] < e.workerRowLen[i] {
flag := false
if e.allColumnExpr {
keyRowI := e.rowChunks.GetRow(minRowPtr)
keyRowJ := e.rowChunks.GetRow((*e.workerRowPtrs[i])[e.workerRowIdx[i]])
flag = e.lessRow(keyRowI, keyRowJ)
} else {
keyRowI := e.keyChunks.GetRow(minRowPtr)
keyRowJ := e.keyChunks.GetRow((*e.workerRowPtrs[i])[e.workerRowIdx[i]])
flag = e.lessRow(keyRowI, keyRowJ)
}
if !flag {
minRowPtr = (*e.workerRowPtrs[i])[e.workerRowIdx[i]]
j = i
}
}
}
e.workerRowIdx[j]++
req.AppendRow(e.rowChunks.GetRow(minRowPtr))
}
return nil
}

func (e *MergeSortExec) fetchRowChunks(ctx context.Context) error {
fields := e.retTypes()
e.rowChunks = chunk.NewList(fields, e.initCap, e.maxChunkSize)
e.rowChunks.GetMemTracker().AttachTo(e.memTracker)
e.rowChunks.GetMemTracker().SetLabel("rowChunks")
for {
chk := e.children[0].newFirstChunk()
err := e.children[0].Next(ctx, chunk.NewRecordBatch(chk))
if err != nil {
return errors.Trace(err)
}
rowCount := chk.NumRows()
if rowCount == 0 {
break
}
e.rowChunks.Add(chk)
}
return nil
}

func (e *MergeSortExec) initCompareFuncs() {
e.keyCmpFuncs = make([]chunk.CompareFunc, len(e.ByItems))
for i := range e.ByItems {
keyType := e.ByItems[i].Expr.GetType()
e.keyCmpFuncs[i] = chunk.GetCompareFunc(keyType)
}
}

func (e *MergeSortExec) buildKeyColumns() (allColumnExpr bool) {
e.keyColumns = make([]int, 0, len(e.ByItems))
for _, by := range e.ByItems {
if col, ok := by.Expr.(*expression.Column); ok {
e.keyColumns = append(e.keyColumns, col.Index)
} else {
e.keyColumns = e.keyColumns[:0]
for i := range e.ByItems {
e.keyColumns = append(e.keyColumns, i)
}
return false
}
}
return true
}

func (e *MergeSortExec) buildKeyExprsAndTypes() {
keyLen := len(e.ByItems)
e.keyTypes = make([]*types.FieldType, keyLen)
e.keyExprs = make([]expression.Expression, keyLen)
for keyColIdx := range e.ByItems {
e.keyExprs[keyColIdx] = e.ByItems[keyColIdx].Expr
e.keyTypes[keyColIdx] = e.ByItems[keyColIdx].Expr.GetType()
}
}

func (e *MergeSortExec) buildKeyChunks() error {
e.keyChunks = chunk.NewList(e.keyTypes, e.initCap, e.maxChunkSize)
e.keyChunks.GetMemTracker().SetLabel("keyChunks")
e.keyChunks.GetMemTracker().AttachTo(e.memTracker)

for chkIdx := 0; chkIdx < e.rowChunks.NumChunks(); chkIdx++ {
keyChk := chunk.NewChunkWithCapacity(e.keyTypes, e.rowChunks.GetChunk(chkIdx).NumRows())
childIter := chunk.NewIterator4Chunk(e.rowChunks.GetChunk(chkIdx))
err := expression.VectorizedExecute(e.ctx, e.keyExprs, childIter, keyChk)
if err != nil {
return errors.Trace(err)
}
e.keyChunks.Add(keyChk)
}
return nil
}

func (e *MergeSortExec) lessRow(rowI, rowJ chunk.Row) bool {
for i, colIdx := range e.keyColumns {
cmpFunc := e.keyCmpFuncs[i]
cmp := cmpFunc(rowI, colIdx, rowJ, colIdx)
if e.ByItems[i].Desc {
cmp = -cmp
}
if cmp < 0 {
return true
} else if cmp > 0 {
return false
}
}
return false
}

// keyColumnsLess is the less function for key columns.
func (sw *sortWorker) keyColumnsLess(i, j int) bool {
rowI := sw.rowChunks.GetRow(sw.rowPtrs[i])
rowJ := sw.rowChunks.GetRow(sw.rowPtrs[j])
return sw.lessRow(rowI, rowJ)
}

// keyChunksLess is the less function for key chunk.
func (sw *sortWorker) keyChunksLess(i, j int) bool {
keyRowI := sw.keyChunks.GetRow(sw.rowPtrs[i])
keyRowJ := sw.keyChunks.GetRow(sw.rowPtrs[j])
return sw.lessRow(keyRowI, keyRowJ)
}
4 changes: 4 additions & 0 deletions sessionctx/variable/session.go
Original file line number Diff line number Diff line change
Expand Up @@ -367,6 +367,7 @@ func NewSessionVars() *SessionVars {
DistSQLScanConcurrency: DefDistSQLScanConcurrency,
HashAggPartialConcurrency: DefTiDBHashAggPartialConcurrency,
HashAggFinalConcurrency: DefTiDBHashAggFinalConcurrency,
MergeSortConcurrency: DefTiDBMergeSortConcurrency,
}
vars.MemQuota = MemQuota{
MemQuotaQuery: config.GetGlobalConfig().MemQuotaQuery,
Expand Down Expand Up @@ -759,6 +760,9 @@ type Concurrency struct {

// IndexSerialScanConcurrency is the number of concurrent index serial scan worker.
IndexSerialScanConcurrency int

//MergeSort is the number of concurrent sort worker
MergeSortConcurrency int
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we add a definition for this in sessionctx/variable/sysvar.go

yu34po marked this conversation as resolved.
Show resolved Hide resolved
}

// MemQuota defines memory quota values.
Expand Down
1 change: 1 addition & 0 deletions sessionctx/variable/tidb_vars.go
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,7 @@ const (
DefTiDBForcePriority = mysql.NoPriority
DefTiDBUseRadixJoin = false
DefEnableWindowFunction = false
DefTiDBMergeSortConcurrency = 8
)

// Process global variables.
Expand Down
1 change: 1 addition & 0 deletions sessionctx/variable/varsutil_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ func (s *testVarsutilSuite) TestNewSessionVars(c *C) {
c.Assert(vars.IndexLookupSize, Equals, DefIndexLookupSize)
c.Assert(vars.IndexLookupConcurrency, Equals, DefIndexLookupConcurrency)
c.Assert(vars.IndexSerialScanConcurrency, Equals, DefIndexSerialScanConcurrency)
//c.Assert(vars.MergeSortConcurrency, Equals, DefTiDBMergeSortConcurrency)
c.Assert(vars.IndexLookupJoinConcurrency, Equals, DefIndexLookupJoinConcurrency)
c.Assert(vars.HashJoinConcurrency, Equals, DefTiDBHashJoinConcurrency)
c.Assert(vars.ProjectionConcurrency, Equals, int64(DefTiDBProjectionConcurrency))
Expand Down