planner: move logical sequence into logicalop pkg. (#54955)

ref #51664, ref #52714

pkg/planner/core/BUILD.bazel

@@ -36,7 +36,6 @@ go_library(
         "logical_plans.go",
         "logical_projection.go",
         "logical_selection.go",
-        "logical_sequence.go",
         "logical_sort.go",
         "logical_table_dual.go",
         "logical_table_scan.go",

pkg/planner/core/core_init.go

@@ -39,6 +39,7 @@ func init() {
 	utilfuncp.FindBestTask4LogicalCTETable = findBestTask4LogicalCTETable
 	utilfuncp.FindBestTask4LogicalMemTable = findBestTask4LogicalMemTable
 	utilfuncp.FindBestTask4LogicalShowDDLJobs = findBestTask4LogicalShowDDLJobs
+	utilfuncp.ExhaustPhysicalPlans4LogicalSequence = exhaustPhysicalPlans4LogicalSequence
 	utilfuncp.ExhaustPhysicalPlans4LogicalMaxOneRow = exhaustPhysicalPlans4LogicalMaxOneRow
 
 	utilfuncp.AppendCandidate4PhysicalOptimizeOp = appendCandidate4PhysicalOptimizeOp

pkg/planner/core/exhaust_physical_plans.go

@@ -3018,7 +3018,7 @@ func canPushToCopImpl(lp base.LogicalPlan, storeTp kv.StoreType, considerDual bo
 		// These operators can be partially push down to TiFlash, so we don't raise warning for them.
 		case *LogicalLimit, *LogicalTopN:
 			return false
-		case *LogicalSequence:
+		case *logicalop.LogicalSequence:
 			return storeTp == kv.TiFlash
 		case *LogicalCTE:
 			if storeTp != kv.TiFlash {
@@ -3574,7 +3574,8 @@ func exhaustPhysicalPlans4LogicalCTE(p *LogicalCTE, prop *property.PhysicalPrope
 	return []base.PhysicalPlan{(*PhysicalCTEStorage)(pcte)}, true, nil
 }
 
-func exhaustPhysicalPlans4LogicalSequence(p *LogicalSequence, prop *property.PhysicalProperty) ([]base.PhysicalPlan, bool, error) {
+func exhaustPhysicalPlans4LogicalSequence(lp base.LogicalPlan, prop *property.PhysicalProperty) ([]base.PhysicalPlan, bool, error) {
+	p := lp.(*logicalop.LogicalSequence)
 	possibleChildrenProps := make([][]*property.PhysicalProperty, 0, 2)
 	anyType := &property.PhysicalProperty{TaskTp: property.MppTaskType, ExpectedCnt: math.MaxFloat64, MPPPartitionTp: property.AnyType, CanAddEnforcer: true, RejectSort: true, CTEProducerStatus: prop.CTEProducerStatus}
 	if prop.TaskTp == property.MppTaskType {

pkg/planner/core/find_best_task.go

@@ -182,7 +182,7 @@ func enumeratePhysicalPlans4Task(
 	childCnts := make([]int64, p.ChildLen())
 	cntPlan = 0
 	iteration := iteratePhysicalPlan4BaseLogical
-	if _, ok := p.Self().(*LogicalSequence); ok {
+	if _, ok := p.Self().(*logicalop.LogicalSequence); ok {
 		iteration = iterateChildPlan4LogicalSequence
 	}
 

pkg/planner/core/logical_plan_builder.go

@@ -4058,7 +4058,7 @@ func (b *PlanBuilder) tryToBuildSequence(ctes []*cteInfo, p base.LogicalPlan) ba
 		lctes = append(lctes, lcte)
 	}
 	b.optFlag |= flagPushDownSequence
-	seq := LogicalSequence{}.Init(b.ctx, b.getSelectOffset())
+	seq := logicalop.LogicalSequence{}.Init(b.ctx, b.getSelectOffset())
 	seq.SetChildren(append(lctes, p)...)
 	seq.SetOutputNames(p.OutputNames().Shallow())
 	return seq

pkg/planner/core/logical_plans.go

@@ -47,7 +47,7 @@ var (
 	_ base.LogicalPlan = &logicalop.LogicalShowDDLJobs{}
 	_ base.LogicalPlan = &LogicalCTE{}
 	_ base.LogicalPlan = &logicalop.LogicalCTETable{}
-	_ base.LogicalPlan = &LogicalSequence{}
+	_ base.LogicalPlan = &logicalop.LogicalSequence{}
 )
 
 // ExtractNotNullFromConds extracts not-null columns from conditions.

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

@@ -8,6 +8,7 @@ go_library(
         "logical_max_one_row.go",
         "logical_mem_table.go",
         "logical_schema_producer.go",
+        "logical_sequence.go",
         "logical_show.go",
         "logical_show_ddl_jobs.go",
     ],

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

@@ -12,14 +12,14 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package core
+package logicalop
 
 import (
 	"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/property"
 	"github.com/pingcap/tidb/pkg/planner/util/optimizetrace"
+	"github.com/pingcap/tidb/pkg/planner/util/utilfuncp"
 	"github.com/pingcap/tidb/pkg/util/plancodec"
 )
 
@@ -34,12 +34,12 @@ import (
 //
 // We use this property to do complex optimizations for CTEs.
 type LogicalSequence struct {
-	logicalop.BaseLogicalPlan
+	BaseLogicalPlan
 }
 
 // Init initializes LogicalSequence
 func (p LogicalSequence) Init(ctx base.PlanContext, offset int) *LogicalSequence {
-	p.BaseLogicalPlan = logicalop.NewBaseLogicalPlan(ctx, plancodec.TypeSequence, &p, offset)
+	p.BaseLogicalPlan = NewBaseLogicalPlan(ctx, plancodec.TypeSequence, &p, offset)
 	return &p
 }
 
@@ -103,7 +103,7 @@ func (p *LogicalSequence) DeriveStats(childStats []*property.StatsInfo, _ *expre
 
 // ExhaustPhysicalPlans implements the base.LogicalPlan.<14th> interface.
 func (p *LogicalSequence) ExhaustPhysicalPlans(prop *property.PhysicalProperty) ([]base.PhysicalPlan, bool, error) {
-	return exhaustPhysicalPlans4LogicalSequence(p, prop)
+	return utilfuncp.ExhaustPhysicalPlans4LogicalSequence(p, prop)
 }
 
 // ExtractCorrelatedCols inherits BaseLogicalPlan.LogicalPlan.<15th> implementation.

pkg/planner/core/rule_push_down_sequence.go

@@ -18,6 +18,7 @@ import (
 	"context"
 
 	"github.com/pingcap/tidb/pkg/planner/core/base"
+	"github.com/pingcap/tidb/pkg/planner/core/operator/logicalop"
 	"github.com/pingcap/tidb/pkg/planner/util/optimizetrace"
 )
 
@@ -33,8 +34,8 @@ func (pdss *pushDownSequenceSolver) optimize(_ context.Context, lp base.LogicalP
 	return pdss.recursiveOptimize(nil, lp), planChanged, nil
 }
 
-func (pdss *pushDownSequenceSolver) recursiveOptimize(pushedSequence *LogicalSequence, lp base.LogicalPlan) base.LogicalPlan {
-	_, ok := lp.(*LogicalSequence)
+func (pdss *pushDownSequenceSolver) recursiveOptimize(pushedSequence *logicalop.LogicalSequence, lp base.LogicalPlan) base.LogicalPlan {
+	_, ok := lp.(*logicalop.LogicalSequence)
 	if !ok && pushedSequence == nil {
 		newChildren := make([]base.LogicalPlan, 0, len(lp.Children()))
 		for _, child := range lp.Children() {
@@ -44,9 +45,9 @@ func (pdss *pushDownSequenceSolver) recursiveOptimize(pushedSequence *LogicalSeq
 		return lp
 	}
 	switch x := lp.(type) {
-	case *LogicalSequence:
+	case *logicalop.LogicalSequence:
 		if pushedSequence == nil {
-			pushedSequence = LogicalSequence{}.Init(lp.SCtx(), lp.QueryBlockOffset())
+			pushedSequence = logicalop.LogicalSequence{}.Init(lp.SCtx(), lp.QueryBlockOffset())
 			pushedSequence.SetChildren(lp.Children()...)
 			return pdss.recursiveOptimize(pushedSequence, lp.Children()[len(lp.Children())-1])
 		}
@@ -55,7 +56,7 @@ func (pdss *pushDownSequenceSolver) recursiveOptimize(pushedSequence *LogicalSeq
 		allCTEs := make([]base.LogicalPlan, 0, childLen+pushedSequence.ChildLen()-2)
 		allCTEs = append(allCTEs, pushedSequence.Children()[:pushedSequence.ChildLen()-1]...)
 		allCTEs = append(allCTEs, x.Children()[:childLen-1]...)
-		pushedSequence = LogicalSequence{}.Init(lp.SCtx(), lp.QueryBlockOffset())
+		pushedSequence = logicalop.LogicalSequence{}.Init(lp.SCtx(), lp.QueryBlockOffset())
 		pushedSequence.SetChildren(append(allCTEs, mainQuery)...)
 		return pdss.recursiveOptimize(pushedSequence, mainQuery)
 	case *DataSource, *LogicalAggregation, *LogicalCTE:

pkg/planner/core/stringer.go

@@ -212,7 +212,7 @@ func toString(in base.Plan, strs []string, idxs []int) ([]string, []int) {
 		}
 		str = name + "{" + strings.Join(children, "->") + "}"
 		idxs = idxs[:last]
-	case *LogicalSequence:
+	case *logicalop.LogicalSequence:
 		last := len(idxs) - 1
 		idx := idxs[last]
 		children := strs[idx:]

pkg/planner/util/utilfuncp/func_pointer_misc.go

@@ -109,3 +109,7 @@ var FindBestTask4LogicalShow func(lp base.LogicalPlan, prop *property.PhysicalPr
 // FindBestTask4LogicalShowDDLJobs will be called by LogicalShowDDLJobs in logicalOp pkg.
 var FindBestTask4LogicalShowDDLJobs func(lp base.LogicalPlan, prop *property.PhysicalProperty,
 	planCounter *base.PlanCounterTp, _ *optimizetrace.PhysicalOptimizeOp) (base.Task, int64, error)
+
+// ExhaustPhysicalPlans4LogicalSequence will be called by LogicalSequence in logicalOp pkg.
+var ExhaustPhysicalPlans4LogicalSequence func(lp base.LogicalPlan, prop *property.PhysicalProperty) (
+	[]base.PhysicalPlan, bool, error)