planner: move logical union scan into logicalop pkg. (pingcap#55159)

ref pingcap#51664, ref pingcap#52714

pkg/planner/core/BUILD.bazel

@@ -37,7 +37,6 @@ go_library(
         "logical_table_scan.go",
         "logical_tikv_single_gather.go",
         "logical_union_all.go",
-        "logical_union_scan.go",
         "memtable_infoschema_extractor.go",
         "memtable_predicate_extractor.go",
         "mock.go",

pkg/planner/core/core_init.go

@@ -44,9 +44,10 @@ func init() {
 	utilfuncp.ExhaustPhysicalPlans4LogicalTopN = exhaustPhysicalPlans4LogicalTopN
 	utilfuncp.ExhaustPhysicalPlans4LogicalLock = exhaustPhysicalPlans4LogicalLock
 	utilfuncp.ExhaustPhysicalPlans4LogicalLimit = exhaustPhysicalPlans4LogicalLimit
-	utilfuncp.ExhaustLogicalWindowPhysicalPlans = exhaustLogicalWindowPhysicalPlans
+	utilfuncp.ExhaustPhysicalPlans4LogicalWindow = exhaustPhysicalPlans4LogicalWindow
 	utilfuncp.ExhaustPhysicalPlans4LogicalSequence = exhaustPhysicalPlans4LogicalSequence
 	utilfuncp.ExhaustPhysicalPlans4LogicalMaxOneRow = exhaustPhysicalPlans4LogicalMaxOneRow
+	utilfuncp.ExhaustPhysicalPlans4LogicalUnionScan = exhaustPhysicalPlans4LogicalUnionScan
 	utilfuncp.ExhaustPhysicalPlans4LogicalProjection = exhaustPhysicalPlans4LogicalProjection
 
 	utilfuncp.AppendCandidate4PhysicalOptimizeOp = appendCandidate4PhysicalOptimizeOp

pkg/planner/core/exhaust_physical_plans.go

@@ -46,7 +46,8 @@ import (
 	"go.uber.org/zap"
 )
 
-func exhaustPhysicalPlans4LogicalUnionScan(p *LogicalUnionScan, prop *property.PhysicalProperty) ([]base.PhysicalPlan, bool, error) {
+func exhaustPhysicalPlans4LogicalUnionScan(lp base.LogicalPlan, prop *property.PhysicalProperty) ([]base.PhysicalPlan, bool, error) {
+	p := lp.(*logicalop.LogicalUnionScan)
 	if prop.IsFlashProp() {
 		p.SCtx().GetSessionVars().RaiseWarningWhenMPPEnforced(
 			"MPP mode may be blocked because operator `UnionScan` is not supported now.")
@@ -769,7 +770,7 @@ childLoop:
 				return nil
 			}
 			wrapper.zippedChildren = append(wrapper.zippedChildren, child)
-		case *LogicalUnionScan:
+		case *logicalop.LogicalUnionScan:
 			wrapper.hasDitryWrite = true
 			wrapper.zippedChildren = append(wrapper.zippedChildren, child)
 		default:
@@ -1029,7 +1030,7 @@ func constructInnerTableScanTask(
 func constructInnerByZippedChildren(prop *property.PhysicalProperty, zippedChildren []base.LogicalPlan, child base.PhysicalPlan) base.PhysicalPlan {
 	for i := len(zippedChildren) - 1; i >= 0; i-- {
 		switch x := zippedChildren[i].(type) {
-		case *LogicalUnionScan:
+		case *logicalop.LogicalUnionScan:
 			child = constructInnerUnionScan(prop, x, child)
 		case *logicalop.LogicalProjection:
 			child = constructInnerProj(prop, x, child)
@@ -1077,7 +1078,7 @@ func constructInnerProj(prop *property.PhysicalProperty, proj *logicalop.Logical
 	return physicalProj
 }
 
-func constructInnerUnionScan(prop *property.PhysicalProperty, us *LogicalUnionScan, reader base.PhysicalPlan) base.PhysicalPlan {
+func constructInnerUnionScan(prop *property.PhysicalProperty, us *logicalop.LogicalUnionScan, reader base.PhysicalPlan) base.PhysicalPlan {
 	if us == nil {
 		return reader
 	}
@@ -2282,7 +2283,7 @@ func tryToGetMppWindows(lw *logicalop.LogicalWindow, prop *property.PhysicalProp
 	return []base.PhysicalPlan{window}
 }
 
-func exhaustLogicalWindowPhysicalPlans(lp base.LogicalPlan, prop *property.PhysicalProperty) ([]base.PhysicalPlan, bool, error) {
+func exhaustPhysicalPlans4LogicalWindow(lp base.LogicalPlan, prop *property.PhysicalProperty) ([]base.PhysicalPlan, bool, error) {
 	lw := lp.(*logicalop.LogicalWindow)
 	windows := make([]base.PhysicalPlan, 0, 2)
 

pkg/planner/core/logical_plan_builder.go

@@ -4762,7 +4762,7 @@ func (b *PlanBuilder) buildDataSource(ctx context.Context, tn *ast.TableName, as
 	var result base.LogicalPlan = ds
 	dirty := tableHasDirtyContent(b.ctx, tableInfo)
 	if dirty || tableInfo.TempTableType == model.TempTableLocal || tableInfo.TableCacheStatusType == model.TableCacheStatusEnable {
-		us := LogicalUnionScan{HandleCols: handleCols}.Init(b.ctx, b.getSelectOffset())
+		us := logicalop.LogicalUnionScan{HandleCols: handleCols}.Init(b.ctx, b.getSelectOffset())
 		us.SetChildren(ds)
 		if tableInfo.Partition != nil && b.optFlag&flagPartitionProcessor == 0 {
 			// Adding ExtraPhysTblIDCol for UnionScan (transaction buffer handling)

pkg/planner/core/logical_plans.go

@@ -41,7 +41,7 @@ var (
 	_ base.LogicalPlan = &logicalop.LogicalLimit{}
 	_ base.LogicalPlan = &logicalop.LogicalWindow{}
 	_ base.LogicalPlan = &LogicalExpand{}
-	_ base.LogicalPlan = &LogicalUnionScan{}
+	_ base.LogicalPlan = &logicalop.LogicalUnionScan{}
 	_ base.LogicalPlan = &logicalop.LogicalMemTable{}
 	_ base.LogicalPlan = &logicalop.LogicalShow{}
 	_ base.LogicalPlan = &logicalop.LogicalShowDDLJobs{}

pkg/planner/core/operator/logicalop/BUILD.bazel

@@ -17,6 +17,7 @@ go_library(
         "logical_sort.go",
         "logical_table_dual.go",
         "logical_top_n.go",
+        "logical_union_scan.go",
         "logical_window.go",
     ],
     importpath = "github.com/pingcap/tidb/pkg/planner/core/operator/logicalop",

pkg/planner/core/logical_union_scan.go → pkg/planner/core/operator/logicalop/logical_union_scan.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package core
+package logicalop
 
 import (
 	"bytes"
@@ -21,16 +21,16 @@ import (
 	"github.com/pingcap/tidb/pkg/expression"
 	"github.com/pingcap/tidb/pkg/parser/model"
 	"github.com/pingcap/tidb/pkg/planner/core/base"
-	"github.com/pingcap/tidb/pkg/planner/core/operator/logicalop"
 	"github.com/pingcap/tidb/pkg/planner/property"
 	"github.com/pingcap/tidb/pkg/planner/util"
 	"github.com/pingcap/tidb/pkg/planner/util/optimizetrace"
+	"github.com/pingcap/tidb/pkg/planner/util/utilfuncp"
 	"github.com/pingcap/tidb/pkg/util/plancodec"
 )
 
 // LogicalUnionScan is used in non read-only txn or for scanning a local temporary table whose snapshot data is located in memory.
 type LogicalUnionScan struct {
-	logicalop.BaseLogicalPlan
+	BaseLogicalPlan
 
 	Conditions []expression.Expression
 
@@ -39,7 +39,7 @@ type LogicalUnionScan struct {
 
 // Init initializes LogicalUnionScan.
 func (p LogicalUnionScan) Init(ctx base.PlanContext, qbOffset int) *LogicalUnionScan {
-	p.BaseLogicalPlan = logicalop.NewBaseLogicalPlan(ctx, plancodec.TypeUnionScan, &p, qbOffset)
+	p.BaseLogicalPlan = NewBaseLogicalPlan(ctx, plancodec.TypeUnionScan, &p, qbOffset)
 	return &p
 }
 
@@ -125,7 +125,7 @@ func (p *LogicalUnionScan) PruneColumns(parentUsedCols []*expression.Column, opt
 
 // ExhaustPhysicalPlans implements base.LogicalPlan.<14th> interface.
 func (p *LogicalUnionScan) ExhaustPhysicalPlans(prop *property.PhysicalProperty) ([]base.PhysicalPlan, bool, error) {
-	return exhaustPhysicalPlans4LogicalUnionScan(p, prop)
+	return utilfuncp.ExhaustPhysicalPlans4LogicalUnionScan(p, prop)
 }
 
 // ExtractCorrelatedCols inherits BaseLogicalPlan.LogicalPlan.<15th> implementation.

pkg/planner/core/operator/logicalop/logical_window.go

@@ -312,7 +312,7 @@ func (p *LogicalWindow) PreparePossibleProperties(_ *expression.Schema, _ ...[][
 
 // ExhaustPhysicalPlans implements base.LogicalPlan.<14th> interface.
 func (p *LogicalWindow) ExhaustPhysicalPlans(prop *property.PhysicalProperty) ([]base.PhysicalPlan, bool, error) {
-	return utilfuncp.ExhaustLogicalWindowPhysicalPlans(p, prop)
+	return utilfuncp.ExhaustPhysicalPlans4LogicalWindow(p, prop)
 }
 
 // ExtractCorrelatedCols implements base.LogicalPlan.<15th> interface.

pkg/planner/core/rule_partition_processor.go

@@ -82,7 +82,7 @@ func (s *PartitionProcessor) rewriteDataSource(lp base.LogicalPlan, opt *optimiz
 	switch p := lp.(type) {
 	case *DataSource:
 		return s.prune(p, opt)
-	case *LogicalUnionScan:
+	case *logicalop.LogicalUnionScan:
 		ds := p.Children()[0]
 		ds, err := s.prune(ds.(*DataSource), opt)
 		if err != nil {
@@ -93,7 +93,7 @@ func (s *PartitionProcessor) rewriteDataSource(lp base.LogicalPlan, opt *optimiz
 			// Union->(UnionScan->DataSource1), (UnionScan->DataSource2)
 			children := make([]base.LogicalPlan, 0, len(ua.Children()))
 			for _, child := range ua.Children() {
-				us := LogicalUnionScan{
+				us := logicalop.LogicalUnionScan{
 					Conditions: p.Conditions,
 					HandleCols: p.HandleCols,
 				}.Init(ua.SCtx(), ua.QueryBlockOffset())

pkg/planner/pattern/pattern.go

@@ -93,7 +93,7 @@ func GetOperand(p base.LogicalPlan) Operand {
 		return OperandTableDual
 	case *plannercore.DataSource:
 		return OperandDataSource
-	case *plannercore.LogicalUnionScan:
+	case *logicalop.LogicalUnionScan:
 		return OperandUnionScan
 	case *plannercore.LogicalUnionAll:
 		return OperandUnionAll

pkg/planner/pattern/pattern_test.go

@@ -31,7 +31,7 @@ func TestGetOperand(t *testing.T) {
 	require.Equal(t, OperandMaxOneRow, GetOperand(&logicalop.LogicalMaxOneRow{}))
 	require.Equal(t, OperandTableDual, GetOperand(&logicalop.LogicalTableDual{}))
 	require.Equal(t, OperandDataSource, GetOperand(&plannercore.DataSource{}))
-	require.Equal(t, OperandUnionScan, GetOperand(&plannercore.LogicalUnionScan{}))
+	require.Equal(t, OperandUnionScan, GetOperand(&logicalop.LogicalUnionScan{}))
 	require.Equal(t, OperandUnionAll, GetOperand(&plannercore.LogicalUnionAll{}))
 	require.Equal(t, OperandSort, GetOperand(&logicalop.LogicalSort{}))
 	require.Equal(t, OperandTopN, GetOperand(&logicalop.LogicalTopN{}))

pkg/planner/util/utilfuncp/func_pointer_misc.go

@@ -134,10 +134,14 @@ var ExhaustPhysicalPlans4LogicalLimit func(lp base.LogicalPlan, prop *property.P
 var ExhaustPhysicalPlans4LogicalProjection func(lp base.LogicalPlan,
 	prop *property.PhysicalProperty) ([]base.PhysicalPlan, bool, error)
 
-// ExhaustLogicalWindowPhysicalPlans will be called by LogicalWindow in logicalOp pkg.
-var ExhaustLogicalWindowPhysicalPlans func(lp base.LogicalPlan, prop *property.PhysicalProperty) (
+// ExhaustPhysicalPlans4LogicalWindow will be called by LogicalWindow in logicalOp pkg.
+var ExhaustPhysicalPlans4LogicalWindow func(lp base.LogicalPlan, prop *property.PhysicalProperty) (
 	[]base.PhysicalPlan, bool, error)
 
 // ExhaustPhysicalPlans4LogicalLock will be called by LogicalLock in logicalOp pkg.
 var ExhaustPhysicalPlans4LogicalLock func(lp base.LogicalPlan, prop *property.PhysicalProperty) (
 	[]base.PhysicalPlan, bool, error)
+
+// ExhaustPhysicalPlans4LogicalUnionScan will be called by LogicalUnionScan in logicalOp pkg.
+var ExhaustPhysicalPlans4LogicalUnionScan func(lp base.LogicalPlan, prop *property.PhysicalProperty) (
+	[]base.PhysicalPlan, bool, error)