Files
tidb/planner/core/optimizer_test.go

501 lines
20 KiB
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,
// 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 core
import (
"reflect"
"strings"
"testing"
"github.com/pingcap/failpoint"
"github.com/pingcap/tidb/expression"
"github.com/pingcap/tidb/parser/ast"
"github.com/pingcap/tidb/parser/mysql"
"github.com/pingcap/tidb/planner/property"
"github.com/pingcap/tidb/types"
"github.com/pingcap/tipb/go-tipb"
"github.com/stretchr/testify/require"
)
// LogicalOptimize exports the `logicalOptimize` function for test packages and
// doesn't affect the normal package and access control of Golang (tricky ^_^)
var LogicalOptimize = logicalOptimize
func testDecimalConvert(t *testing.T, lDec, lLen, rDec, rLen int, lConvert, rConvert bool, cDec, cLen int) {
lType := types.NewFieldType(mysql.TypeNewDecimal)
lType.SetDecimal(lDec)
lType.SetFlen(lLen)
rType := types.NewFieldType(mysql.TypeNewDecimal)
rType.SetDecimal(rDec)
rType.SetFlen(rLen)
cType, lCon, rCon := negotiateCommonType(lType, rType)
require.Equal(t, mysql.TypeNewDecimal, cType.GetType())
require.Equal(t, cDec, cType.GetDecimal())
require.Equal(t, cLen, cType.GetFlen())
require.Equal(t, lConvert, lCon)
require.Equal(t, rConvert, rCon)
}
func TestMPPDecimalConvert(t *testing.T) {
testDecimalConvert(t, 5, 9, 5, 8, false, false, 5, 9)
testDecimalConvert(t, 5, 8, 5, 9, false, false, 5, 9)
testDecimalConvert(t, 0, 8, 0, 11, true, false, 0, 11)
testDecimalConvert(t, 0, 16, 0, 11, false, false, 0, 16)
testDecimalConvert(t, 5, 9, 4, 9, true, true, 5, 10)
testDecimalConvert(t, 5, 8, 4, 9, true, true, 5, 10)
testDecimalConvert(t, 5, 9, 4, 8, false, true, 5, 9)
testDecimalConvert(t, 10, 16, 0, 11, true, true, 10, 21)
testDecimalConvert(t, 5, 19, 0, 20, false, true, 5, 25)
testDecimalConvert(t, 20, 20, 0, 60, true, true, 20, 65)
testDecimalConvert(t, 20, 40, 0, 60, false, true, 20, 65)
testDecimalConvert(t, 0, 40, 0, 60, false, false, 0, 60)
}
func testJoinKeyTypeConvert(t *testing.T, leftType, rightType, retType *types.FieldType, lConvert, rConvert bool) {
cType, lCon, rCon := negotiateCommonType(leftType, rightType)
require.Equal(t, retType.GetType(), cType.GetType())
require.Equal(t, retType.GetFlen(), cType.GetFlen())
require.Equal(t, retType.GetDecimal(), cType.GetDecimal())
require.Equal(t, retType.GetFlag(), cType.GetFlag())
require.Equal(t, lConvert, lCon)
require.Equal(t, rConvert, rCon)
}
func TestMPPJoinKeyTypeConvert(t *testing.T) {
tinyIntType := types.NewFieldTypeBuilder().SetType(mysql.TypeTiny).BuildP()
flen, decimal := mysql.GetDefaultFieldLengthAndDecimal(mysql.TypeTiny)
tinyIntType.SetFlen(flen)
tinyIntType.SetDecimal(decimal)
unsignedTinyIntType := types.NewFieldTypeBuilder().SetType(mysql.TypeTiny).BuildP()
unsignedTinyIntType.SetFlen(flen)
unsignedTinyIntType.SetDecimal(decimal)
unsignedTinyIntType.SetFlag(mysql.UnsignedFlag)
bigIntType := types.NewFieldTypeBuilder().SetType(mysql.TypeLonglong).BuildP()
flen, decimal = mysql.GetDefaultFieldLengthAndDecimal(mysql.TypeLonglong)
bigIntType.SetFlen(flen)
bigIntType.SetDecimal(decimal)
unsignedBigIntType := types.NewFieldTypeBuilder().SetType(mysql.TypeLonglong).BuildP()
unsignedBigIntType.SetFlen(flen)
unsignedBigIntType.SetDecimal(decimal)
unsignedBigIntType.SetFlag(mysql.UnsignedFlag)
decimalType := types.NewFieldTypeBuilder().SetType(mysql.TypeNewDecimal).SetFlen(20).SetDecimal(0).BuildP()
testJoinKeyTypeConvert(t, tinyIntType, tinyIntType, tinyIntType, false, false)
testJoinKeyTypeConvert(t, tinyIntType, unsignedTinyIntType, bigIntType, true, true)
testJoinKeyTypeConvert(t, tinyIntType, bigIntType, bigIntType, true, false)
testJoinKeyTypeConvert(t, bigIntType, tinyIntType, bigIntType, false, true)
testJoinKeyTypeConvert(t, unsignedBigIntType, tinyIntType, decimalType, true, true)
testJoinKeyTypeConvert(t, tinyIntType, unsignedBigIntType, decimalType, true, true)
testJoinKeyTypeConvert(t, bigIntType, bigIntType, bigIntType, false, false)
testJoinKeyTypeConvert(t, unsignedBigIntType, bigIntType, decimalType, true, true)
testJoinKeyTypeConvert(t, bigIntType, unsignedBigIntType, decimalType, true, true)
}
// Test for core.handleFineGrainedShuffle()
func TestHandleFineGrainedShuffle(t *testing.T) {
sortItem := property.SortItem{
Col: nil,
Desc: true,
}
var plans []*basePhysicalPlan
tableReader := &PhysicalTableReader{}
partWindow := &PhysicalWindow{
// Meaningless sort item, just for test.
PartitionBy: []property.SortItem{sortItem},
}
partialSort := &PhysicalSort{
IsPartialSort: true,
}
sort := &PhysicalSort{}
recv := &PhysicalExchangeReceiver{}
passSender := &PhysicalExchangeSender{
ExchangeType: tipb.ExchangeType_PassThrough,
}
hashSender := &PhysicalExchangeSender{
ExchangeType: tipb.ExchangeType_Hash,
}
tableScan := &PhysicalTableScan{}
plans = append(plans, &partWindow.basePhysicalPlan)
plans = append(plans, &partialSort.basePhysicalPlan)
plans = append(plans, &sort.basePhysicalPlan)
plans = append(plans, &recv.basePhysicalPlan)
plans = append(plans, &hashSender.basePhysicalPlan)
clear := func(plans []*basePhysicalPlan) {
for _, p := range plans {
p.children = nil
p.TiFlashFineGrainedShuffleStreamCount = 0
}
}
var check func(p PhysicalPlan, expStreamCount int64, expChildCount int, curChildCount int)
check = func(p PhysicalPlan, expStreamCount int64, expChildCount int, curChildCount int) {
if len(p.Children()) == 0 {
require.Equal(t, expChildCount, curChildCount)
_, isTableScan := p.(*PhysicalTableScan)
require.True(t, isTableScan)
return
}
val := reflect.ValueOf(p)
actStreamCount := reflect.Indirect(val).FieldByName("TiFlashFineGrainedShuffleStreamCount").Interface().(uint64)
require.Equal(t, uint64(expStreamCount), actStreamCount)
for _, child := range p.Children() {
check(child, expStreamCount, expChildCount, curChildCount+1)
}
}
const expStreamCount int64 = 8
sctx := MockContext()
sctx.GetSessionVars().TiFlashFineGrainedShuffleStreamCount = expStreamCount
start := func(p PhysicalPlan, expStreamCount int64, expChildCount int, curChildCount int) {
handleFineGrainedShuffle(nil, sctx, tableReader)
check(p, expStreamCount, expChildCount, curChildCount)
clear(plans)
}
// Window <- Sort <- ExchangeReceiver <- ExchangeSender
tableReader.tablePlan = passSender
passSender.children = []PhysicalPlan{partWindow}
partWindow.children = []PhysicalPlan{partialSort}
partialSort.children = []PhysicalPlan{recv}
recv.children = []PhysicalPlan{hashSender}
hashSender.children = []PhysicalPlan{tableScan}
start(partWindow, expStreamCount, 4, 0)
// Window <- ExchangeReceiver <- ExchangeSender
tableReader.tablePlan = passSender
passSender.children = []PhysicalPlan{partWindow}
partWindow.children = []PhysicalPlan{recv}
recv.children = []PhysicalPlan{hashSender}
hashSender.children = []PhysicalPlan{tableScan}
start(partWindow, expStreamCount, 3, 0)
// Window <- Sort(x) <- ExchangeReceiver <- ExchangeSender
// Fine-grained shuffle is disabled because sort is not partial.
tableReader.tablePlan = passSender
passSender.children = []PhysicalPlan{partWindow}
partWindow.children = []PhysicalPlan{sort}
sort.children = []PhysicalPlan{recv}
recv.children = []PhysicalPlan{hashSender}
hashSender.children = []PhysicalPlan{tableScan}
start(partWindow, 0, 4, 0)
// Window <- Sort <- Window <- Sort <- ExchangeReceiver <- ExchangeSender
partWindow1 := &PhysicalWindow{
// Meaningless sort item, just for test.
PartitionBy: []property.SortItem{sortItem},
}
partialSort1 := &PhysicalSort{
IsPartialSort: true,
}
tableReader.tablePlan = passSender
passSender.children = []PhysicalPlan{partWindow}
partWindow.children = []PhysicalPlan{partialSort}
partialSort.children = []PhysicalPlan{partWindow1}
partWindow1.children = []PhysicalPlan{partialSort1}
partialSort1.children = []PhysicalPlan{recv}
recv.children = []PhysicalPlan{hashSender}
hashSender.children = []PhysicalPlan{tableScan}
start(partWindow, expStreamCount, 6, 0)
// Window <- Sort <- Window(x) <- Sort <- ExchangeReceiver <- ExchangeSender(x)
// Fine-grained shuffle is disabled because Window is not hash partition.
nonPartWindow := &PhysicalWindow{}
partialSort1 = &PhysicalSort{
IsPartialSort: true,
}
tableReader.tablePlan = passSender
passSender.children = []PhysicalPlan{partWindow}
partWindow.children = []PhysicalPlan{partialSort}
partialSort.children = []PhysicalPlan{nonPartWindow}
nonPartWindow.children = []PhysicalPlan{partialSort1}
partialSort1.children = []PhysicalPlan{recv}
recv.children = []PhysicalPlan{passSender}
passSender.children = []PhysicalPlan{tableScan}
start(partWindow, 0, 6, 0)
// HashAgg <- Window <- ExchangeReceiver <- ExchangeSender
hashAgg := &PhysicalHashAgg{}
tableReader.tablePlan = passSender
passSender.children = []PhysicalPlan{hashAgg}
hashAgg.children = []PhysicalPlan{partWindow}
partWindow.children = []PhysicalPlan{recv}
recv.children = []PhysicalPlan{hashSender}
hashSender.children = []PhysicalPlan{tableScan}
require.Equal(t, uint64(0), hashAgg.TiFlashFineGrainedShuffleStreamCount)
start(partWindow, expStreamCount, 3, 0)
// Window <- HashAgg(x) <- ExchangeReceiver <- ExchangeSender
tableReader.tablePlan = passSender
passSender.children = []PhysicalPlan{partWindow}
hashAgg = &PhysicalHashAgg{}
partWindow.children = []PhysicalPlan{hashAgg}
hashAgg.children = []PhysicalPlan{recv}
recv.children = []PhysicalPlan{hashSender}
hashSender.children = []PhysicalPlan{tableScan}
start(partWindow, 0, 4, 0)
// Window <- Join(x) <- ExchangeReceiver <- ExchangeSender
// <- ExchangeReceiver <- ExchangeSender
tableReader.tablePlan = passSender
passSender.children = []PhysicalPlan{partWindow}
hashJoin := &PhysicalHashJoin{}
recv1 := &PhysicalExchangeReceiver{}
tableScan1 := &PhysicalTableScan{}
partWindow.children = []PhysicalPlan{hashJoin}
hashSender1 := &PhysicalExchangeSender{
ExchangeType: tipb.ExchangeType_Hash,
}
hashJoin.children = []PhysicalPlan{recv, recv1}
recv.children = []PhysicalPlan{hashSender}
recv1.children = []PhysicalPlan{hashSender1}
hashSender.children = []PhysicalPlan{tableScan}
hashSender1.children = []PhysicalPlan{tableScan1}
start(partWindow, 0, 4, 0)
// Join <- ExchangeReceiver <- ExchangeSender <- Window <- ExchangeReceiver(2) <- ExchangeSender(2)
// <- ExchangeReceiver(1) <- ExchangeSender(1)
tableReader.tablePlan = passSender
passSender.children = []PhysicalPlan{partWindow}
hashJoin = &PhysicalHashJoin{}
recv1 = &PhysicalExchangeReceiver{}
hashJoin.children = []PhysicalPlan{recv, recv1}
recv.children = []PhysicalPlan{hashSender}
hashSender.children = []PhysicalPlan{partWindow}
recv2 := &PhysicalExchangeReceiver{}
hashSender2 := &PhysicalExchangeSender{
ExchangeType: tipb.ExchangeType_Hash,
}
tableScan2 := &PhysicalTableScan{}
partWindow.children = []PhysicalPlan{recv2}
recv2.children = []PhysicalPlan{hashSender2}
hashSender2.children = []PhysicalPlan{tableScan2}
recv1.children = []PhysicalPlan{hashSender1}
tableScan1 = &PhysicalTableScan{}
hashSender1.children = []PhysicalPlan{tableScan1}
start(partWindow, expStreamCount, 3, 0)
instances := []string{
"tiflash,127.0.0.1:3933,127.0.0.1:7777,,",
"tikv,127.0.0.1:11080,127.0.0.1:10080,,",
}
fpName := "github.com/pingcap/tidb/infoschema/mockStoreServerInfo"
fpExpr := `return("` + strings.Join(instances, ";") + `")`
require.NoError(t, failpoint.Enable(fpName, fpExpr))
defer func() { require.NoError(t, failpoint.Disable(fpName)) }()
fpName2 := "github.com/pingcap/tidb/planner/core/mockTiFlashStreamCountUsingMinLogicalCores"
require.NoError(t, failpoint.Enable(fpName2, `return("8")`))
sctx.GetSessionVars().TiFlashFineGrainedShuffleStreamCount = 0
col0 := &expression.Column{
UniqueID: sctx.GetSessionVars().AllocPlanColumnID(),
RetType: types.NewFieldType(mysql.TypeLonglong),
}
cond, err := expression.NewFunction(sctx, ast.EQ, types.NewFieldType(mysql.TypeTiny), col0, col0)
require.True(t, err == nil)
sf, isSF := cond.(*expression.ScalarFunction)
require.True(t, isSF)
var partitionCols = make([]*property.MPPPartitionColumn, 0, 1)
partitionCols = append(partitionCols, &property.MPPPartitionColumn{
Col: col0,
CollateID: property.GetCollateIDByNameForPartition(col0.GetType().GetCollate()),
})
// HashAgg(x) <- ExchangeReceiver <- ExchangeSender
tableReader.tablePlan = passSender
hashAgg = &PhysicalHashAgg{}
passSender.children = []PhysicalPlan{hashAgg}
hashAgg.children = []PhysicalPlan{recv}
recv.children = []PhysicalPlan{hashSender}
hashSender.children = []PhysicalPlan{tableScan}
tableScan.Schema().Columns = append(tableScan.Schema().Columns, col0)
start(hashAgg, 8, 3, 0)
// Join(x) <- ExchangeReceiver <- ExchangeSender
// <- ExchangeReceiver <- ExchangeSender
tableReader.tablePlan = passSender
hashJoin = &PhysicalHashJoin{}
hashJoin.EqualConditions = append(hashJoin.EqualConditions, sf)
hashJoin.RightJoinKeys = append(hashJoin.RightJoinKeys, col0)
hashJoin.InnerChildIdx = 1
passSender.children = []PhysicalPlan{hashJoin}
recv = &PhysicalExchangeReceiver{}
recv1 = &PhysicalExchangeReceiver{}
tableScan = &PhysicalTableScan{}
tableScan1 = &PhysicalTableScan{}
hashSender = &PhysicalExchangeSender{
ExchangeType: tipb.ExchangeType_Hash,
}
hashSender1 = &PhysicalExchangeSender{
ExchangeType: tipb.ExchangeType_Hash,
}
hashJoin.children = []PhysicalPlan{recv, recv1}
recv.children = []PhysicalPlan{hashSender}
recv1.children = []PhysicalPlan{hashSender1}
hashSender.children = []PhysicalPlan{tableScan}
hashSender1.children = []PhysicalPlan{tableScan1}
hashSender1.HashCols = partitionCols
tableScan1.Schema().Columns = append(tableScan1.Schema().Columns, col0)
handleFineGrainedShuffle(nil, sctx, tableReader)
require.Equal(t, uint64(8), hashJoin.TiFlashFineGrainedShuffleStreamCount)
require.Equal(t, uint64(8), recv1.TiFlashFineGrainedShuffleStreamCount)
require.Equal(t, uint64(8), hashSender1.TiFlashFineGrainedShuffleStreamCount)
require.Equal(t, uint64(0), recv.TiFlashFineGrainedShuffleStreamCount)
require.Equal(t, uint64(0), hashSender.TiFlashFineGrainedShuffleStreamCount)
clear(plans)
require.NoError(t, failpoint.Disable(fpName2))
require.NoError(t, failpoint.Enable(fpName2, `return("8000")`))
// HashAgg(x) <- ExchangeReceiver <- ExchangeSender, exceed splitLimit
tableReader.tablePlan = passSender
hashAgg = &PhysicalHashAgg{}
passSender.children = []PhysicalPlan{hashAgg}
hashAgg.children = []PhysicalPlan{recv}
recv.children = []PhysicalPlan{hashSender}
hashSender.children = []PhysicalPlan{tableScan}
tableScan.Schema().Columns = append(tableScan.Schema().Columns, col0)
start(hashAgg, 0, 3, 0)
// exceed splitLimit
// Join(x) <- ExchangeReceiver <- ExchangeSender
// <- ExchangeReceiver <- ExchangeSender
tableReader.tablePlan = passSender
hashJoin = &PhysicalHashJoin{}
hashJoin.EqualConditions = append(hashJoin.EqualConditions, sf)
hashJoin.LeftJoinKeys = append(hashJoin.LeftJoinKeys, col0)
hashJoin.InnerChildIdx = 1
passSender.children = []PhysicalPlan{hashJoin}
recv1 = &PhysicalExchangeReceiver{}
tableScan1 = &PhysicalTableScan{}
hashSender1 = &PhysicalExchangeSender{
ExchangeType: tipb.ExchangeType_Hash,
}
hashJoin.children = []PhysicalPlan{recv, recv1}
recv.children = []PhysicalPlan{hashSender}
recv1.children = []PhysicalPlan{hashSender1}
hashSender.children = []PhysicalPlan{tableScan}
hashSender1.children = []PhysicalPlan{tableScan1}
hashSender1.HashCols = partitionCols
tableScan1.Schema().Columns = append(tableScan1.Schema().Columns, col0)
start(hashJoin, 0, 3, 0)
require.NoError(t, failpoint.Disable(fpName2))
}
// Test for core.prunePhysicalColumns()
func TestPrunePhysicalColumns(t *testing.T) {
sctx := MockContext()
col0 := &expression.Column{
UniqueID: sctx.GetSessionVars().AllocPlanColumnID(),
RetType: types.NewFieldType(mysql.TypeLonglong),
}
col1 := &expression.Column{
UniqueID: sctx.GetSessionVars().AllocPlanColumnID(),
RetType: types.NewFieldType(mysql.TypeLonglong),
}
col2 := &expression.Column{
UniqueID: sctx.GetSessionVars().AllocPlanColumnID(),
RetType: types.NewFieldType(mysql.TypeLonglong),
}
col3 := &expression.Column{
UniqueID: sctx.GetSessionVars().AllocPlanColumnID(),
RetType: types.NewFieldType(mysql.TypeLonglong),
}
// Join[col2, col3; col2==col3] <- ExchangeReceiver[col0, col1, col2] <- ExchangeSender[col0, col1, col2] <- Selection[col0, col1, col2; col0 < col1] <- TableScan[col0, col1, col2]
// <- ExchangeReceiver1[col3] <- ExchangeSender1[col3] <- TableScan1[col3]
tableReader := &PhysicalTableReader{}
passSender := &PhysicalExchangeSender{
ExchangeType: tipb.ExchangeType_PassThrough,
}
hashJoin := &PhysicalHashJoin{}
recv := &PhysicalExchangeReceiver{}
recv1 := &PhysicalExchangeReceiver{}
hashSender := &PhysicalExchangeSender{
ExchangeType: tipb.ExchangeType_Hash,
}
hashSender1 := &PhysicalExchangeSender{
ExchangeType: tipb.ExchangeType_Hash,
}
tableScan := &PhysicalTableScan{}
tableScan1 := &PhysicalTableScan{}
tableReader.tablePlan = passSender
passSender.children = []PhysicalPlan{hashJoin}
hashJoin.children = []PhysicalPlan{recv, recv1}
selection := &PhysicalSelection{}
cond, err := expression.NewFunction(sctx, ast.EQ, types.NewFieldType(mysql.TypeTiny), col2, col3)
require.True(t, err == nil)
sf, isSF := cond.(*expression.ScalarFunction)
require.True(t, isSF)
hashJoin.EqualConditions = append(hashJoin.EqualConditions, sf)
hashJoin.LeftJoinKeys = append(hashJoin.LeftJoinKeys, col2)
hashJoin.RightJoinKeys = append(hashJoin.RightJoinKeys, col3)
hashJoinSchema := make([]*expression.Column, 0)
hashJoinSchema = append(hashJoinSchema, col3)
hashJoin.SetSchema(expression.NewSchema(hashJoinSchema...))
selection.SetChildren(tableScan)
hashSender.SetChildren(selection)
var partitionCols = make([]*property.MPPPartitionColumn, 0, 1)
partitionCols = append(partitionCols, &property.MPPPartitionColumn{
Col: col2,
CollateID: property.GetCollateIDByNameForPartition(col2.GetType().GetCollate()),
})
hashSender.HashCols = partitionCols
recv.SetChildren(hashSender)
tableScan.Schema().Columns = append(tableScan.Schema().Columns, col0, col1, col2)
hashSender1.SetChildren(tableScan1)
recv1.SetChildren(hashSender1)
tableScan1.Schema().Columns = append(tableScan1.Schema().Columns, col3)
prunePhysicalColumns(sctx, tableReader)
// Optimized Plan:
// Join[col2, col3; col2==col3] <- ExchangeReceiver[col2] <- ExchangeSender[col2;col2] <- Projection[col2] <- Selection[col0, col1, col2; col0 < col1] <- TableScan[col0, col1, col2]
// <- ExchangeReceiver1[col3] <- ExchangeSender1[col3] <- TableScan1[col3]
require.True(t, len(recv.Schema().Columns) == 1)
require.True(t, recv.Schema().Contains(col2))
require.False(t, recv.Schema().Contains(col0))
require.False(t, recv.Schema().Contains(col1))
require.True(t, len(recv.children[0].Children()) == 1)
physicalProj := recv.children[0].Children()[0]
switch x := physicalProj.(type) {
case *PhysicalProjection:
require.True(t, x.Schema().Contains(col2))
require.False(t, recv.Schema().Contains(col0))
require.False(t, recv.Schema().Contains(col1))
// Check PhysicalProj resolved index
require.True(t, len(x.Exprs) == 1)
require.True(t, x.Exprs[0].(*expression.Column).Index == 2)
default:
require.True(t, false)
}
// Check resolved indices
require.True(t, hashJoin.LeftJoinKeys[0].Index == 0)
require.True(t, hashSender.HashCols[0].Col.Index == 0)
// Check recv1,no changes
require.True(t, len(recv1.Schema().Columns) == 1)
require.True(t, recv1.Schema().Contains(col3))
}