392 lines
12 KiB
Go
392 lines
12 KiB
Go
// Copyright 2015 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 (
|
|
"bytes"
|
|
"fmt"
|
|
"strings"
|
|
|
|
perrors "github.com/pingcap/errors"
|
|
"github.com/pingcap/tidb/pkg/expression"
|
|
"github.com/pingcap/tidb/pkg/planner/core/base"
|
|
"github.com/pingcap/tidb/pkg/planner/core/operator/logicalop"
|
|
"github.com/pingcap/tidb/pkg/planner/util"
|
|
"github.com/pingcap/tidb/pkg/util/plancodec"
|
|
)
|
|
|
|
// ToString explains a Plan, returns description string.
|
|
func ToString(p base.Plan) string {
|
|
strs, _ := toString(p, []string{}, []int{})
|
|
return strings.Join(strs, "->")
|
|
}
|
|
|
|
// FDToString explains fd transfer over a Plan, returns description string.
|
|
func FDToString(p base.LogicalPlan) string {
|
|
strs, _ := fdToString(p, []string{}, []int{})
|
|
for i, j := 0, len(strs)-1; i < j; i, j = i+1, j-1 {
|
|
strs[i], strs[j] = strs[j], strs[i]
|
|
}
|
|
return strings.Join(strs, " >>> ")
|
|
}
|
|
|
|
func needIncludeChildrenString(plan base.Plan) bool {
|
|
switch x := plan.(type) {
|
|
case *logicalop.LogicalUnionAll, *PhysicalUnionAll, *logicalop.LogicalPartitionUnionAll:
|
|
// after https://github.com/pingcap/tidb/pull/25218, the union may contain less than 2 children,
|
|
// but we still wants to include its child plan's information when calling `toString` on union.
|
|
return true
|
|
case base.LogicalPlan:
|
|
return len(x.Children()) > 1
|
|
case base.PhysicalPlan:
|
|
return len(x.Children()) > 1
|
|
default:
|
|
return false
|
|
}
|
|
}
|
|
|
|
func fdToString(in base.LogicalPlan, strs []string, idxs []int) ([]string, []int) {
|
|
switch x := in.(type) {
|
|
case *logicalop.LogicalProjection:
|
|
strs = append(strs, "{"+x.FDs().String()+"}")
|
|
for _, child := range x.Children() {
|
|
strs, idxs = fdToString(child, strs, idxs)
|
|
}
|
|
case *logicalop.LogicalAggregation:
|
|
strs = append(strs, "{"+x.FDs().String()+"}")
|
|
for _, child := range x.Children() {
|
|
strs, idxs = fdToString(child, strs, idxs)
|
|
}
|
|
case *logicalop.DataSource:
|
|
strs = append(strs, "{"+x.FDs().String()+"}")
|
|
case *logicalop.LogicalApply:
|
|
strs = append(strs, "{"+x.FDs().String()+"}")
|
|
case *logicalop.LogicalJoin:
|
|
strs = append(strs, "{"+x.FDs().String()+"}")
|
|
default:
|
|
}
|
|
return strs, idxs
|
|
}
|
|
|
|
func toString(in base.Plan, strs []string, idxs []int) ([]string, []int) {
|
|
var ectx expression.EvalContext
|
|
if in.SCtx() != nil {
|
|
// Not all `base.Plan` has a non-nil `SCtx`. For example, the `SCtx` of `Analyze` plan is nil.
|
|
ectx = in.SCtx().GetExprCtx().GetEvalCtx()
|
|
}
|
|
|
|
switch x := in.(type) {
|
|
case base.LogicalPlan:
|
|
if needIncludeChildrenString(in) {
|
|
idxs = append(idxs, len(strs))
|
|
}
|
|
|
|
for _, c := range x.Children() {
|
|
strs, idxs = toString(c, strs, idxs)
|
|
}
|
|
case *PhysicalExchangeReceiver: // do nothing
|
|
case base.PhysicalPlan:
|
|
if needIncludeChildrenString(in) {
|
|
idxs = append(idxs, len(strs))
|
|
}
|
|
|
|
for _, c := range x.Children() {
|
|
strs, idxs = toString(c, strs, idxs)
|
|
}
|
|
}
|
|
|
|
var str string
|
|
switch x := in.(type) {
|
|
case *CheckTable:
|
|
str = "CheckTable"
|
|
case *PhysicalIndexScan:
|
|
str = fmt.Sprintf("Index(%s.%s)%v", x.Table.Name.L, x.Index.Name.L, x.Ranges)
|
|
case *PhysicalTableScan:
|
|
str = fmt.Sprintf("Table(%s)", x.Table.Name.L)
|
|
case *PhysicalHashJoin:
|
|
last := len(idxs) - 1
|
|
idx := idxs[last]
|
|
children := strs[idx:]
|
|
strs = strs[:idx]
|
|
idxs = idxs[:last]
|
|
if x.InnerChildIdx == 0 {
|
|
str = "RightHashJoin{" + strings.Join(children, "->") + "}"
|
|
} else {
|
|
str = "LeftHashJoin{" + strings.Join(children, "->") + "}"
|
|
}
|
|
for _, eq := range x.EqualConditions {
|
|
l := eq.GetArgs()[0].StringWithCtx(ectx, perrors.RedactLogDisable)
|
|
r := eq.GetArgs()[1].StringWithCtx(ectx, perrors.RedactLogDisable)
|
|
str += fmt.Sprintf("(%s,%s)", l, r)
|
|
}
|
|
case *PhysicalMergeJoin:
|
|
last := len(idxs) - 1
|
|
idx := idxs[last]
|
|
children := strs[idx:]
|
|
strs = strs[:idx]
|
|
idxs = idxs[:last]
|
|
id := "MergeJoin"
|
|
switch x.JoinType {
|
|
case logicalop.SemiJoin:
|
|
id = "MergeSemiJoin"
|
|
case logicalop.AntiSemiJoin:
|
|
id = "MergeAntiSemiJoin"
|
|
case logicalop.LeftOuterSemiJoin:
|
|
id = "MergeLeftOuterSemiJoin"
|
|
case logicalop.AntiLeftOuterSemiJoin:
|
|
id = "MergeAntiLeftOuterSemiJoin"
|
|
case logicalop.LeftOuterJoin:
|
|
id = "MergeLeftOuterJoin"
|
|
case logicalop.RightOuterJoin:
|
|
id = "MergeRightOuterJoin"
|
|
case logicalop.InnerJoin:
|
|
id = "MergeInnerJoin"
|
|
}
|
|
str = id + "{" + strings.Join(children, "->") + "}"
|
|
for i := range x.LeftJoinKeys {
|
|
l := x.LeftJoinKeys[i].StringWithCtx(ectx, perrors.RedactLogDisable)
|
|
r := x.RightJoinKeys[i].StringWithCtx(ectx, perrors.RedactLogDisable)
|
|
str += fmt.Sprintf("(%s,%s)", l, r)
|
|
}
|
|
case *logicalop.LogicalApply, *PhysicalApply:
|
|
last := len(idxs) - 1
|
|
idx := idxs[last]
|
|
children := strs[idx:]
|
|
strs = strs[:idx]
|
|
idxs = idxs[:last]
|
|
str = "Apply{" + strings.Join(children, "->") + "}"
|
|
case *logicalop.LogicalMaxOneRow, *PhysicalMaxOneRow:
|
|
str = "MaxOneRow"
|
|
case *logicalop.LogicalLimit, *PhysicalLimit:
|
|
str = "Limit"
|
|
case *PhysicalLock, *logicalop.LogicalLock:
|
|
str = "Lock"
|
|
case *ShowDDL:
|
|
str = "ShowDDL"
|
|
case *logicalop.LogicalShow:
|
|
str = "Show"
|
|
if pl := in.(*logicalop.LogicalShow); pl.Extractor != nil {
|
|
str = str + "(" + pl.Extractor.ExplainInfo() + ")"
|
|
}
|
|
case *PhysicalShow:
|
|
str = "Show"
|
|
if pl := in.(*PhysicalShow); pl.Extractor != nil {
|
|
str = str + "(" + pl.Extractor.ExplainInfo() + ")"
|
|
}
|
|
case *logicalop.LogicalShowDDLJobs, *PhysicalShowDDLJobs:
|
|
str = "ShowDDLJobs"
|
|
case *logicalop.LogicalSort, *PhysicalSort:
|
|
str = "Sort"
|
|
case *logicalop.LogicalJoin:
|
|
last := len(idxs) - 1
|
|
idx := idxs[last]
|
|
children := strs[idx:]
|
|
strs = strs[:idx]
|
|
str = "Join{" + strings.Join(children, "->") + "}"
|
|
idxs = idxs[:last]
|
|
for _, eq := range x.EqualConditions {
|
|
l := eq.GetArgs()[0].StringWithCtx(ectx, perrors.RedactLogDisable)
|
|
r := eq.GetArgs()[1].StringWithCtx(ectx, perrors.RedactLogDisable)
|
|
str += fmt.Sprintf("(%s,%s)", l, r)
|
|
}
|
|
case *logicalop.LogicalUnionAll, *PhysicalUnionAll, *logicalop.LogicalPartitionUnionAll:
|
|
last := len(idxs) - 1
|
|
idx := idxs[last]
|
|
children := strs[idx:]
|
|
strs = strs[:idx]
|
|
name := "UnionAll"
|
|
if x.TP() == plancodec.TypePartitionUnion {
|
|
name = "PartitionUnionAll"
|
|
}
|
|
str = name + "{" + strings.Join(children, "->") + "}"
|
|
idxs = idxs[:last]
|
|
case *logicalop.LogicalSequence:
|
|
last := len(idxs) - 1
|
|
idx := idxs[last]
|
|
children := strs[idx:]
|
|
strs = strs[:idx]
|
|
name := "Sequence"
|
|
str = name + "{" + strings.Join(children, ",") + "}"
|
|
idxs = idxs[:last]
|
|
case *logicalop.DataSource:
|
|
if x.PartitionDefIdx != nil {
|
|
// TODO: Change this to:
|
|
//str = fmt.Sprintf("Partition(%d)", x.TableInfo.Partition.Definitions[*x.PartitionDefIdx].Name.O)
|
|
str = fmt.Sprintf("Partition(%d)", x.PhysicalTableID)
|
|
} else {
|
|
if x.TableAsName != nil && x.TableAsName.L != "" {
|
|
str = fmt.Sprintf("DataScan(%s)", x.TableAsName)
|
|
} else {
|
|
str = fmt.Sprintf("DataScan(%s)", x.TableInfo.Name)
|
|
}
|
|
}
|
|
case *logicalop.LogicalSelection:
|
|
str = fmt.Sprintf("Sel(%s)", expression.StringifyExpressionsWithCtx(ectx, x.Conditions))
|
|
case *PhysicalSelection:
|
|
str = fmt.Sprintf("Sel(%s)", expression.StringifyExpressionsWithCtx(ectx, x.Conditions))
|
|
case *logicalop.LogicalProjection, *PhysicalProjection:
|
|
str = "Projection"
|
|
case *logicalop.LogicalTopN:
|
|
str = fmt.Sprintf("TopN(%v,%d,%d)", util.StringifyByItemsWithCtx(ectx, x.ByItems), x.Offset, x.Count)
|
|
case *PhysicalTopN:
|
|
str = fmt.Sprintf("TopN(%v,%d,%d)", util.StringifyByItemsWithCtx(ectx, x.ByItems), x.Offset, x.Count)
|
|
case *logicalop.LogicalTableDual, *PhysicalTableDual:
|
|
str = "Dual"
|
|
case *PhysicalHashAgg:
|
|
str = "HashAgg"
|
|
case *PhysicalStreamAgg:
|
|
str = "StreamAgg"
|
|
case *logicalop.LogicalAggregation:
|
|
str = "Aggr("
|
|
for i, aggFunc := range x.AggFuncs {
|
|
str += aggFunc.StringWithCtx(ectx, perrors.RedactLogDisable)
|
|
if i != len(x.AggFuncs)-1 {
|
|
str += ","
|
|
}
|
|
}
|
|
str += ")"
|
|
case *PhysicalTableReader:
|
|
str = fmt.Sprintf("TableReader(%s)", ToString(x.tablePlan))
|
|
case *PhysicalIndexReader:
|
|
str = fmt.Sprintf("IndexReader(%s)", ToString(x.indexPlan))
|
|
case *PhysicalIndexLookUpReader:
|
|
str = fmt.Sprintf("IndexLookUp(%s, %s)", ToString(x.indexPlan), ToString(x.tablePlan))
|
|
case *PhysicalIndexMergeReader:
|
|
str = "IndexMergeReader(PartialPlans->["
|
|
for i, paritalPlan := range x.partialPlans {
|
|
if i > 0 {
|
|
str += ", "
|
|
}
|
|
str += ToString(paritalPlan)
|
|
}
|
|
str += "], TablePlan->" + ToString(x.tablePlan) + ")"
|
|
case *PhysicalUnionScan:
|
|
str = fmt.Sprintf("UnionScan(%s)", expression.StringifyExpressionsWithCtx(ectx, x.Conditions))
|
|
case *PhysicalIndexJoin:
|
|
last := len(idxs) - 1
|
|
idx := idxs[last]
|
|
children := strs[idx:]
|
|
strs = strs[:idx]
|
|
idxs = idxs[:last]
|
|
str = "IndexJoin{" + strings.Join(children, "->") + "}"
|
|
for i := range x.OuterJoinKeys {
|
|
l := x.OuterJoinKeys[i]
|
|
r := x.InnerJoinKeys[i]
|
|
str += fmt.Sprintf("(%s,%s)", l, r)
|
|
}
|
|
case *PhysicalIndexMergeJoin:
|
|
last := len(idxs) - 1
|
|
idx := idxs[last]
|
|
children := strs[idx:]
|
|
strs = strs[:idx]
|
|
idxs = idxs[:last]
|
|
str = "IndexMergeJoin{" + strings.Join(children, "->") + "}"
|
|
for i := range x.OuterJoinKeys {
|
|
l := x.OuterJoinKeys[i]
|
|
r := x.InnerJoinKeys[i]
|
|
str += fmt.Sprintf("(%s,%s)", l, r)
|
|
}
|
|
case *PhysicalIndexHashJoin:
|
|
last := len(idxs) - 1
|
|
idx := idxs[last]
|
|
children := strs[idx:]
|
|
strs = strs[:idx]
|
|
idxs = idxs[:last]
|
|
str = "IndexHashJoin{" + strings.Join(children, "->") + "}"
|
|
for i := range x.OuterJoinKeys {
|
|
l := x.OuterJoinKeys[i]
|
|
r := x.InnerJoinKeys[i]
|
|
str += fmt.Sprintf("(%s,%s)", l, r)
|
|
}
|
|
case *Analyze:
|
|
str = "Analyze{"
|
|
var children []string
|
|
for _, idx := range x.IdxTasks {
|
|
children = append(children, fmt.Sprintf("Index(%s)", idx.IndexInfo.Name.O))
|
|
}
|
|
for _, col := range x.ColTasks {
|
|
var colNames []string
|
|
if col.HandleCols != nil {
|
|
colNames = append(colNames, col.HandleCols.StringWithCtx(ectx, perrors.RedactLogDisable))
|
|
}
|
|
for _, c := range col.ColsInfo {
|
|
colNames = append(colNames, c.Name.O)
|
|
}
|
|
children = append(children, fmt.Sprintf("Table(%s)", strings.Join(colNames, ", ")))
|
|
}
|
|
str = str + strings.Join(children, ",") + "}"
|
|
case *Update:
|
|
str = fmt.Sprintf("%s->Update", ToString(x.SelectPlan))
|
|
case *Delete:
|
|
str = fmt.Sprintf("%s->Delete", ToString(x.SelectPlan))
|
|
case *Insert:
|
|
str = "Insert"
|
|
if x.SelectPlan != nil {
|
|
str = fmt.Sprintf("%s->Insert", ToString(x.SelectPlan))
|
|
}
|
|
case *logicalop.LogicalWindow:
|
|
buffer := bytes.NewBufferString("")
|
|
formatWindowFuncDescs(ectx, buffer, x.WindowFuncDescs, x.Schema())
|
|
str = fmt.Sprintf("Window(%s)", buffer.String())
|
|
case *PhysicalWindow:
|
|
str = fmt.Sprintf("Window(%s)", x.ExplainInfo())
|
|
case *PhysicalShuffle:
|
|
str = fmt.Sprintf("Partition(%s)", x.ExplainInfo())
|
|
case *PhysicalShuffleReceiverStub:
|
|
str = fmt.Sprintf("PartitionReceiverStub(%s)", x.ExplainInfo())
|
|
case *PointGetPlan:
|
|
str = "PointGet("
|
|
if x.IndexInfo != nil {
|
|
str += fmt.Sprintf("Index(%s.%s)%v)", x.TblInfo.Name.L, x.IndexInfo.Name.L, x.IndexValues)
|
|
} else {
|
|
str += fmt.Sprintf("Handle(%s.%s)%v)", x.TblInfo.Name.L, x.TblInfo.GetPkName().L, x.Handle)
|
|
}
|
|
case *BatchPointGetPlan:
|
|
str = "BatchPointGet("
|
|
if x.IndexInfo != nil {
|
|
str += fmt.Sprintf("Index(%s.%s)%v)", x.TblInfo.Name.L, x.IndexInfo.Name.L, x.IndexValues)
|
|
} else {
|
|
str += fmt.Sprintf("Handle(%s.%s)%v)", x.TblInfo.Name.L, x.TblInfo.GetPkName().L, x.Handles)
|
|
}
|
|
case *PhysicalExchangeReceiver:
|
|
str = "Recv("
|
|
for _, task := range x.Tasks {
|
|
str += fmt.Sprintf("%d, ", task.ID)
|
|
}
|
|
str += ")"
|
|
case *PhysicalExchangeSender:
|
|
str = "Send("
|
|
for _, task := range x.TargetTasks {
|
|
str += fmt.Sprintf("%d, ", task.ID)
|
|
}
|
|
for _, tasks := range x.TargetCTEReaderTasks {
|
|
str += "("
|
|
for _, task := range tasks {
|
|
str += fmt.Sprintf("%d, ", task.ID)
|
|
}
|
|
str += ")"
|
|
}
|
|
str += ")"
|
|
case *PhysicalCTE:
|
|
str = "CTEReader("
|
|
str += fmt.Sprintf("%v", x.CTE.IDForStorage)
|
|
str += ")"
|
|
default:
|
|
str = fmt.Sprintf("%T", in)
|
|
}
|
|
strs = append(strs, str)
|
|
return strs, idxs
|
|
}
|