*: adapt TopSQL naming for TopProfiling (prepare for TopRU) (#65820)

zimulala · web-flow · commit 3acb64681ff5 · 2026-02-03T11:56:42.000Z
close #65817
diff --git a/cmd/tidb-server/main.go b/cmd/tidb-server/main.go
@@ -411,7 +411,7 @@ func main() {
 		executor.Stop()
 		close(exited)
 	})
-	topsql.SetupTopSQL(keyspace.GetKeyspaceNameBytesBySettings(), svr)
+	topsql.SetupTopProfiling(keyspace.GetKeyspaceNameBytesBySettings(), svr)
 	terror.MustNil(svr.Run(dom))
 	<-exited
 	syncLog()
diff --git a/pkg/ddl/backfilling.go b/pkg/ddl/backfilling.go
@@ -442,7 +442,7 @@ func (w *backfillWorker) run(d *ddlCtx, bf backfiller, job *model.Job) {
 			return
 		}
 		curTaskID = task.id
-		d.setDDLLabelForTopSQL(job.ID, job.Query)
+		d.attachTopProfilingInfo(job.ID, job.Query)
 
 		logger.Debug("backfill worker got task", zap.Int("workerID", w.GetCtx().id), zap.Stringer("task", task))
 		failpoint.Inject("mockBackfillRunErr", func() {
diff --git a/pkg/ddl/backfilling_dist_executor.go b/pkg/ddl/backfilling_dist_executor.go
@@ -174,7 +174,7 @@ func (s *backfillDistExecutor) newBackfillStepExecutor(
 	switch stage {
 	case proto.BackfillStepReadIndex:
 		jc := ddlObj.jobContext(jobMeta.ID, jobMeta.ReorgMeta)
-		ddlObj.setDDLLabelForTopSQL(jobMeta.ID, jobMeta.Query)
+		ddlObj.attachTopProfilingInfo(jobMeta.ID, jobMeta.Query)
 		ddlObj.setDDLSourceForDiagnosis(jobMeta.ID, jobMeta.Type)
 		return newReadIndexExecutor(store, sessPool, ddlObj.etcdCli, jobMeta, indexInfos, tbl, jc, cloudStorageURI, estRowSize)
 	case proto.BackfillStepMergeSort:
diff --git a/pkg/ddl/ddl.go b/pkg/ddl/ddl.go
@@ -453,15 +453,15 @@ func (dc *ddlCtx) isOwner() bool {
 	return isOwner
 }
 
-func (dc *ddlCtx) setDDLLabelForTopSQL(jobID int64, jobQuery string) {
+func (dc *ddlCtx) attachTopProfilingInfo(jobID int64, jobQuery string) {
 	dc.jobCtx.Lock()
 	defer dc.jobCtx.Unlock()
 	ctx, exists := dc.jobCtx.jobCtxMap[jobID]
 	if !exists {
 		ctx = NewReorgContext()
 		dc.jobCtx.jobCtxMap[jobID] = ctx
 	}
-	ctx.setDDLLabelForTopSQL(jobQuery)
+	ctx.attachTopProfilingInfo(jobQuery)
 }
 
 func (dc *ddlCtx) setDDLSourceForDiagnosis(jobID int64, jobType model.ActionType) {
diff --git a/pkg/ddl/delete_range.go b/pkg/ddl/delete_range.go
@@ -215,7 +215,7 @@ func (dr *delRange) doTask(sctx sessionctx.Context, r util.DelRangeTask) error {
 		dr.keys = dr.keys[:0]
 		ctx := kv.WithInternalSourceType(context.Background(), kv.InternalTxnDDL)
 		err := kv.RunInNewTxn(ctx, dr.store, false, func(_ context.Context, txn kv.Transaction) error {
-			if topsqlstate.TopSQLEnabled() {
+			if topsqlstate.TopProfilingEnabled() {
 				// Only when TiDB run without PD(use unistore as storage for test) will run into here, so just set a mock internal resource tagger.
 				txn.SetOption(kv.ResourceGroupTagger, util.GetInternalResourceGroupTaggerForTopSQL())
 			}
diff --git a/pkg/ddl/index.go b/pkg/ddl/index.go
@@ -1571,7 +1571,7 @@ func checkIfTableReorgWorkCanSkip(
 	startTS := txn.StartTS()
 	ctx := NewReorgContext()
 	ctx.resourceGroupName = job.ReorgMeta.ResourceGroupName
-	ctx.setDDLLabelForTopSQL(job.Query)
+	ctx.attachTopProfilingInfo(job.Query)
 	if isEmpty, err := checkIfTableIsEmpty(ctx, store, tbl, startTS); err != nil || !isEmpty {
 		return false
 	}
@@ -1667,7 +1667,7 @@ func checkIfTempIndexReorgWorkCanSkip(
 	startTS := txn.StartTS()
 	ctx := NewReorgContext()
 	ctx.resourceGroupName = job.ReorgMeta.ResourceGroupName
-	ctx.setDDLLabelForTopSQL(job.Query)
+	ctx.attachTopProfilingInfo(job.Query)
 	firstIdxID := allIndexInfos[0].ID
 	lastIdxID := allIndexInfos[len(allIndexInfos)-1].ID
 	var globalIdxIDs []int64
diff --git a/pkg/ddl/job_worker.go b/pkg/ddl/job_worker.go
@@ -484,8 +484,8 @@ func finishRecoverSchema(w *worker, job *model.Job) error {
 	return nil
 }
 
-func (w *ReorgContext) setDDLLabelForTopSQL(jobQuery string) {
-	if !topsqlstate.TopSQLEnabled() || jobQuery == "" {
+func (w *ReorgContext) attachTopProfilingInfo(jobQuery string) {
+	if !topsqlstate.TopProfilingEnabled() || jobQuery == "" {
 		return
 	}
 
@@ -563,7 +563,7 @@ func (w *worker) prepareTxn(job *model.Job) (kv.Transaction, error) {
 	if w.tp != generalWorker && job.IsRunning() {
 		txn.SetDiskFullOpt(kvrpcpb.DiskFullOpt_NotAllowedOnFull)
 	}
-	w.setDDLLabelForTopSQL(job.ID, job.Query)
+	w.attachTopProfilingInfo(job.ID, job.Query)
 	w.setDDLSourceForDiagnosis(job.ID, job.Type)
 	jobContext := w.jobContext(job.ID, job.ReorgMeta)
 	if tagger := w.getResourceGroupTaggerForTopSQL(job.ID); tagger != nil {
diff --git a/pkg/executor/adapter.go b/pkg/executor/adapter.go
@@ -365,7 +365,7 @@ func (a *ExecStmt) PointGet(ctx context.Context) (*recordSet, error) {
 		sessiontxn.AssertTxnManagerInfoSchema(a.Ctx, a.InfoSchema)
 	})
 
-	ctx = a.observeStmtBeginForTopSQL(ctx)
+	ctx = a.observeStmtBeginForTopProfiling(ctx)
 	startTs, err := sessiontxn.GetTxnManager(a.Ctx).GetStmtReadTS()
 	if err != nil {
 		return nil, err
@@ -638,7 +638,7 @@ func (a *ExecStmt) Exec(ctx context.Context) (_ sqlexec.RecordSet, err error) {
 			stmtCtx.ResourceGroupName = switchGroupName
 		}
 	}
-	ctx = a.observeStmtBeginForTopSQL(ctx)
+	ctx = a.observeStmtBeginForTopProfiling(ctx)
 
 	// Record start time before buildExecutor() to include TSO waiting time in maxExecutionTime timeout.
 	// buildExecutor() may block waiting for TSO, so we should start the timer earlier.
@@ -1520,7 +1520,7 @@ func (a *ExecStmt) FinishExecuteStmt(txnTS uint64, err error, hasMoreResults boo
 	// `LowSlowQuery` and `SummaryStmt` must be called before recording `PrevStmt`.
 	a.LogSlowQuery(txnTS, succ, hasMoreResults)
 	a.SummaryStmt(succ)
-	a.observeStmtFinishedForTopSQL()
+	a.observeStmtFinishedForTopProfiling()
 	a.UpdatePlanCacheRuntimeInfo()
 	if sessVars.StmtCtx.IsTiFlash.Load() {
 		if succ {
@@ -2152,10 +2152,10 @@ func (a *ExecStmt) updatePrevStmt() {
 	}
 }
 
-func (a *ExecStmt) observeStmtBeginForTopSQL(ctx context.Context) context.Context {
-	if !topsqlstate.TopSQLEnabled() && IsFastPlan(a.Plan) {
+func (a *ExecStmt) observeStmtBeginForTopProfiling(ctx context.Context) context.Context {
+	if !topsqlstate.TopProfilingEnabled() && IsFastPlan(a.Plan) {
 		// To reduce the performance impact on fast plan.
-		// Drop them does not cause notable accuracy issue in TopSQL.
+		// Drop them does not cause notable accuracy issue in Top Profiling.
 		return ctx
 	}
 
@@ -2171,8 +2171,9 @@ func (a *ExecStmt) observeStmtBeginForTopSQL(ctx context.Context) context.Contex
 		planDigestByte = planDigest.Bytes()
 	}
 	stats := a.Ctx.GetStmtStats()
-	if !topsqlstate.TopSQLEnabled() {
-		// Always attach the SQL and plan info uses to catch the running SQL when Top SQL is enabled in execution.
+	if !topsqlstate.TopProfilingEnabled() {
+		// Always attach the SQL and plan info uses to catch the running SQL when Top Profiling is enabled in execution.
+		// Note: Goroutine labels for CPU profiling are only set when TopSQL is enabled.
 		if stats != nil {
 			stats.OnExecutionBegin(sqlDigestByte, planDigestByte, vars.InPacketBytes.Load())
 		}
@@ -2222,12 +2223,12 @@ func (a *ExecStmt) UpdatePlanCacheRuntimeInfo() {
 	a.Ctx.GetSessionVars().PlanCacheValue = nil // reset
 }
 
-func (a *ExecStmt) observeStmtFinishedForTopSQL() {
+func (a *ExecStmt) observeStmtFinishedForTopProfiling() {
 	vars := a.Ctx.GetSessionVars()
 	if vars == nil {
 		return
 	}
-	if stats := a.Ctx.GetStmtStats(); stats != nil && topsqlstate.TopSQLEnabled() {
+	if stats := a.Ctx.GetStmtStats(); stats != nil && topsqlstate.TopProfilingEnabled() {
 		sqlDigest, planDigest := a.getSQLPlanDigest()
 		execDuration := vars.GetTotalCostDuration()
 		stats.OnExecutionFinished(sqlDigest, planDigest, execDuration, vars.OutPacketBytes.Load())
diff --git a/pkg/executor/internal/exec/executor.go b/pkg/executor/internal/exec/executor.go
@@ -55,7 +55,7 @@ type Executor interface {
 	RuntimeStats() *execdetails.BasicRuntimeStats
 
 	HandleSQLKillerSignal() error
-	RegisterSQLAndPlanInExecForTopSQL()
+	RegisterSQLAndPlanInExecForTopProfiling()
 
 	AllChildren() []Executor
 	SetAllChildren([]Executor)
@@ -248,9 +248,9 @@ func (e *executorStats) RuntimeStats() *execdetails.BasicRuntimeStats {
 	return e.runtimeStats
 }
 
-// RegisterSQLAndPlanInExecForTopSQL registers the current SQL and Plan on top sql
-func (e *executorStats) RegisterSQLAndPlanInExecForTopSQL() {
-	if topsqlstate.TopSQLEnabled() && e.isSQLAndPlanRegistered.CompareAndSwap(false, true) {
+// RegisterSQLAndPlanInExecForTopProfiling registers the current SQL and Plan on top profiling.
+func (e *executorStats) RegisterSQLAndPlanInExecForTopProfiling() {
+	if topsqlstate.TopProfilingEnabled() && e.isSQLAndPlanRegistered.CompareAndSwap(false, true) {
 		topsql.RegisterSQL(e.normalizedSQL, e.sqlDigest, e.inRestrictedSQL)
 		if len(e.normalizedPlan) > 0 {
 			topsql.RegisterPlan(e.normalizedPlan, e.planDigest)
@@ -456,7 +456,7 @@ func Next(ctx context.Context, e Executor, req *chunk.Chunk) (err error) {
 	r, ctx := tracing.StartRegionEx(ctx, reflect.TypeOf(e).String()+".Next")
 	defer r.End()
 
-	e.RegisterSQLAndPlanInExecForTopSQL()
+	e.RegisterSQLAndPlanInExecForTopProfiling()
 	err = e.Next(ctx, req)
 
 	if err != nil {
diff --git a/pkg/executor/prepared.go b/pkg/executor/prepared.go
@@ -144,7 +144,7 @@ func (e *PrepareExec) Next(ctx context.Context, _ *chunk.Chunk) error {
 	if err != nil {
 		return err
 	}
-	if topsqlstate.TopSQLEnabled() {
+	if topsqlstate.TopProfilingEnabled() {
 		e.Ctx().GetSessionVars().StmtCtx.IsSQLRegistered.Store(true)
 		topsql.AttachAndRegisterSQLInfo(ctx, stmt.NormalizedSQL, stmt.SQLDigest, vars.InRestrictedSQL)
 	}
diff --git a/pkg/executor/select.go b/pkg/executor/select.go
@@ -1061,7 +1061,7 @@ func ResetContextOfStmt(ctx sessionctx.Context, s ast.StmtNode) (err error) {
 			goCtx = pprof.WithLabels(goCtx, pprof.Labels("sql", FormatSQL(prepareStmt.NormalizedSQL).String()))
 			pprof.SetGoroutineLabels(goCtx)
 		}
-		if topsqlstate.TopSQLEnabled() && prepareStmt.SQLDigest != nil {
+		if topsqlstate.TopProfilingEnabled() && prepareStmt.SQLDigest != nil {
 			sc.IsSQLRegistered.Store(true)
 			topsql.AttachAndRegisterSQLInfo(goCtx, prepareStmt.NormalizedSQL, prepareStmt.SQLDigest, vars.InRestrictedSQL)
 		}
diff --git a/pkg/server/conn.go b/pkg/server/conn.go
@@ -1345,7 +1345,7 @@ func (cc *clientConn) dispatch(ctx context.Context, data []byte) error {
 	cc.lastPacket = data
 	cmd := data[0]
 	data = data[1:]
-	if topsqlstate.TopSQLEnabled() {
+	if topsqlstate.TopProfilingEnabled() {
 		rawCtx := ctx
 		defer pprof.SetGoroutineLabels(rawCtx)
 		sqlID := cc.ctx.GetSessionVars().SQLCPUUsages.AllocNewSQLID()
@@ -2047,7 +2047,7 @@ func (cc *clientConn) prefetchPointPlanKeys(ctx context.Context, stmts []ast.Stm
 }
 
 func setResourceGroupTaggerForMultiStmtPrefetch(snapshot kv.Snapshot, sqls string) {
-	if !topsqlstate.TopSQLEnabled() {
+	if !topsqlstate.TopProfilingEnabled() {
 		return
 	}
 	normalized, digest := parser.NormalizeDigest(sqls)
diff --git a/pkg/server/conn_stmt.go b/pkg/server/conn_stmt.go
@@ -527,7 +527,7 @@ func (cc *clientConn) handleStmtFetch(ctx context.Context, data []byte) (err err
 		}
 	}()
 
-	if topsqlstate.TopSQLEnabled() {
+	if topsqlstate.TopProfilingEnabled() {
 		prepareObj, _ := cc.preparedStmtID2CachePreparedStmt(stmtID)
 		if prepareObj != nil && prepareObj.SQLDigest != nil {
 			ctx = topsql.AttachAndRegisterSQLInfo(ctx, prepareObj.NormalizedSQL, prepareObj.SQLDigest, false)
diff --git a/pkg/server/tests/commontest/tidb_test.go b/pkg/server/tests/commontest/tidb_test.go
@@ -1187,7 +1187,7 @@ func TestTopSQLCatchRunningSQL(t *testing.T) {
 	}()
 
 	mc := mockTopSQLTraceCPU.NewTopSQLCollector()
-	topsql.SetupTopSQLForTest(mc)
+	topsql.SetupTopProfilingForTest(mc)
 	sqlCPUCollector := collector.NewSQLCPUCollector(mc)
 	sqlCPUCollector.Start()
 	defer sqlCPUCollector.Stop()
@@ -1252,7 +1252,7 @@ func TestTopSQLCPUProfile(t *testing.T) {
 	defer topsqlstate.DisableTopSQL()
 
 	mc := mockTopSQLTraceCPU.NewTopSQLCollector()
-	topsql.SetupTopSQLForTest(mc)
+	topsql.SetupTopProfilingForTest(mc)
 	sqlCPUCollector := collector.NewSQLCPUCollector(mc)
 	sqlCPUCollector.SetProcessCPUUpdater(ts.Server)
 	sqlCPUCollector.Start()
diff --git a/pkg/session/session.go b/pkg/session/session.go
@@ -1998,7 +1998,7 @@ func (s *session) ParseWithParams(ctx context.Context, sql string, args ...any)
 	for _, warn := range warns {
 		s.sessionVars.StmtCtx.AppendWarning(util.SyntaxWarn(warn))
 	}
-	if topsqlstate.TopSQLEnabled() {
+	if topsqlstate.TopProfilingEnabled() {
 		normalized, digest := parser.NormalizeDigest(sql)
 		if digest != nil {
 			// Reset the goroutine label when internal sql execute finish.
@@ -2425,7 +2425,7 @@ func (s *session) executeStmtImpl(ctx context.Context, stmtNode ast.StmtNode) (s
 
 	normalizedSQL, digest := s.sessionVars.StmtCtx.SQLDigest()
 	cmdByte := byte(atomic.LoadUint32(&s.GetSessionVars().CommandValue))
-	if topsqlstate.TopSQLEnabled() {
+	if topsqlstate.TopProfilingEnabled() {
 		s.sessionVars.StmtCtx.IsSQLRegistered.Store(true)
 		ctx = topsql.AttachAndRegisterSQLInfo(ctx, normalizedSQL, digest, s.sessionVars.InRestrictedSQL)
 	}
diff --git a/pkg/util/topsql/BUILD.bazel b/pkg/util/topsql/BUILD.bazel
@@ -11,6 +11,7 @@ go_library(
         "//pkg/util/plancodec",
         "//pkg/util/topsql/collector",
         "//pkg/util/topsql/reporter",
+        "//pkg/util/topsql/state",
         "//pkg/util/topsql/stmtstats",
         "@com_github_pingcap_failpoint//:failpoint",
         "@com_github_pingcap_tipb//go-tipb",
diff --git a/pkg/util/topsql/state/state.go b/pkg/util/topsql/state/state.go
@@ -62,3 +62,14 @@ func DisableTopSQL() {
 func TopSQLEnabled() bool {
 	return GlobalState.enable.Load()
 }
+
+// TopProfilingEnabled returns true if any Top Profiling consumer is enabled.
+//
+// In current codebase it is equivalent to TopSQLEnabled(). It is introduced to
+// unify execution-path hooks (SQL/plan registration, stmt lifecycle callbacks,
+// resource group tagging) so they can later be extended to support TopRU.
+func TopProfilingEnabled() bool {
+	// TODO: include TopRUEnabled() here once TopRU is merged.
+	// return TopSQLEnabled() || TopRUEnabled()
+	return TopSQLEnabled()
+}
diff --git a/pkg/util/topsql/topsql.go b/pkg/util/topsql/topsql.go
diff --git a/pkg/util/topsql/topsql_test.go b/pkg/util/topsql/topsql_test.go

Original file line number	Diff line number	Diff line change
`@@ -442,7 +442,7 @@ func (w backfillWorker) run(d ddlCtx, bf backfiller, job *model.Job) {`
`442`	`442`	`return`
`443`	`443`	`}`
`444`	`444`	`curTaskID = task.id`
`445`		`- d.setDDLLabelForTopSQL(job.ID, job.Query)`
	`445`	`+ d.attachTopProfilingInfo(job.ID, job.Query)`
`446`	`446`
`447`	`447`	`logger.Debug("backfill worker got task", zap.Int("workerID", w.GetCtx().id), zap.Stringer("task", task))`
`448`	`448`	`failpoint.Inject("mockBackfillRunErr", func() {`
Original file line number	Diff line number	Diff line change
`@@ -453,15 +453,15 @@ func (dc *ddlCtx) isOwner() bool {`
`453`	`453`	`return isOwner`
`454`	`454`	`}`
`455`	`455`
`456`		`-func (dc *ddlCtx) setDDLLabelForTopSQL(jobID int64, jobQuery string) {`
	`456`	`+func (dc *ddlCtx) attachTopProfilingInfo(jobID int64, jobQuery string) {`
`457`	`457`	`dc.jobCtx.Lock()`
`458`	`458`	`defer dc.jobCtx.Unlock()`
`459`	`459`	`ctx, exists := dc.jobCtx.jobCtxMap[jobID]`
`460`	`460`	`if !exists {`
`461`	`461`	`ctx = NewReorgContext()`
`462`	`462`	`dc.jobCtx.jobCtxMap[jobID] = ctx`
`463`	`463`	`}`
`464`		`- ctx.setDDLLabelForTopSQL(jobQuery)`
	`464`	`+ ctx.attachTopProfilingInfo(jobQuery)`
`465`	`465`	`}`
`466`	`466`
`467`	`467`	`func (dc *ddlCtx) setDDLSourceForDiagnosis(jobID int64, jobType model.ActionType) {`
Original file line number	Diff line number	Diff line change
`@@ -215,7 +215,7 @@ func (dr *delRange) doTask(sctx sessionctx.Context, r util.DelRangeTask) error {`
`215`	`215`	`dr.keys = dr.keys[:0]`
`216`	`216`	`ctx := kv.WithInternalSourceType(context.Background(), kv.InternalTxnDDL)`
`217`	`217`	`err := kv.RunInNewTxn(ctx, dr.store, false, func(_ context.Context, txn kv.Transaction) error {`
`218`		`- if topsqlstate.TopSQLEnabled() {`
	`218`	`+ if topsqlstate.TopProfilingEnabled() {`
`219`	`219`	`// Only when TiDB run without PD(use unistore as storage for test) will run into here, so just set a mock internal resource tagger.`
`220`	`220`	`txn.SetOption(kv.ResourceGroupTagger, util.GetInternalResourceGroupTaggerForTopSQL())`
`221`	`221`	`}`
Original file line number	Diff line number	Diff line change
`@@ -484,8 +484,8 @@ func finishRecoverSchema(w worker, job model.Job) error {`
`484`	`484`	`return nil`
`485`	`485`	`}`
`486`	`486`
`487`		`-func (w *ReorgContext) setDDLLabelForTopSQL(jobQuery string) {`
`488`		`- if !topsqlstate.TopSQLEnabled() \|\| jobQuery == "" {`
	`487`	`+func (w *ReorgContext) attachTopProfilingInfo(jobQuery string) {`
	`488`	`+ if !topsqlstate.TopProfilingEnabled() \|\| jobQuery == "" {`
`489`	`489`	`return`
`490`	`490`	`}`
`491`	`491`
`@@ -563,7 +563,7 @@ func (w worker) prepareTxn(job model.Job) (kv.Transaction, error) {`
`563`	`563`	`if w.tp != generalWorker && job.IsRunning() {`
`564`	`564`	`txn.SetDiskFullOpt(kvrpcpb.DiskFullOpt_NotAllowedOnFull)`
`565`	`565`	`}`
`566`		`- w.setDDLLabelForTopSQL(job.ID, job.Query)`
	`566`	`+ w.attachTopProfilingInfo(job.ID, job.Query)`
`567`	`567`	`w.setDDLSourceForDiagnosis(job.ID, job.Type)`
`568`	`568`	`jobContext := w.jobContext(job.ID, job.ReorgMeta)`
`569`	`569`	`if tagger := w.getResourceGroupTaggerForTopSQL(job.ID); tagger != nil {`
Original file line number	Diff line number	Diff line change
`@@ -144,7 +144,7 @@ func (e PrepareExec) Next(ctx context.Context, _ chunk.Chunk) error {`
`144`	`144`	`if err != nil {`
`145`	`145`	`return err`
`146`	`146`	`}`
`147`		`- if topsqlstate.TopSQLEnabled() {`
	`147`	`+ if topsqlstate.TopProfilingEnabled() {`
`148`	`148`	`e.Ctx().GetSessionVars().StmtCtx.IsSQLRegistered.Store(true)`
`149`	`149`	`topsql.AttachAndRegisterSQLInfo(ctx, stmt.NormalizedSQL, stmt.SQLDigest, vars.InRestrictedSQL)`
`150`	`150`	`}`