*: add new region score formula

pkg/mock/mockcluster/config.go

@@ -80,6 +80,11 @@ func (mc *Cluster) SetTolerantSizeRatio(v float64) {
 	mc.updateScheduleConfig(func(s *config.ScheduleConfig) { s.TolerantSizeRatio = v })
 }
 
+// SetRegionScoreFormulaVersion updates the RegionScoreFormulaVersion configuration.
+func (mc *Cluster) SetRegionScoreFormulaVersion(v string) {
+	mc.updateScheduleConfig(func(s *config.ScheduleConfig) { s.RegionScoreFormulaVersion = v })
+}
+
 // SetLeaderScheduleLimit updates the LeaderScheduleLimit configuration.
 func (mc *Cluster) SetLeaderScheduleLimit(v int) {
 	mc.updateScheduleConfig(func(s *config.ScheduleConfig) { s.LeaderScheduleLimit = uint64(v) })

server/api/config.go

@@ -63,7 +63,7 @@ func (h *confHandler) Get(w http.ResponseWriter, r *http.Request) {
 // @Router /config/default [get]
 func (h *confHandler) GetDefault(w http.ResponseWriter, r *http.Request) {
 	config := config.NewConfig()
-	err := config.Adjust(nil)
+	err := config.Adjust(nil, false)
 	if err != nil {
 		h.rd.JSON(w, http.StatusInternalServerError, err.Error())
 	}

server/api/store.go

@@ -89,7 +89,7 @@ func newStoreInfo(opt *config.ScheduleConfig, store *core.StoreInfo) *StoreInfo
 			LeaderSize:         store.GetLeaderSize(),
 			RegionCount:        store.GetRegionCount(),
 			RegionWeight:       store.GetRegionWeight(),
-			RegionScore:        store.RegionScore(opt.HighSpaceRatio, opt.LowSpaceRatio, 0),
+			RegionScore:        store.RegionScore(opt.RegionScoreFormulaVersion, opt.HighSpaceRatio, opt.LowSpaceRatio, 0, 0),
 			RegionSize:         store.GetRegionSize(),
 			SendingSnapCount:   store.GetSendingSnapCount(),
 			ReceivingSnapCount: store.GetReceivingSnapCount(),

server/cluster/cluster_test.go

@@ -768,7 +768,7 @@ type testCluster struct {
 func newTestScheduleConfig() (*config.ScheduleConfig, *config.PersistOptions, error) {
 	cfg := config.NewConfig()
 	cfg.Schedule.TolerantSizeRatio = 5
-	if err := cfg.Adjust(nil); err != nil {
+	if err := cfg.Adjust(nil, false); err != nil {
 		return nil, nil, err
 	}
 	opt := config.NewPersistOptions(cfg)

server/config/config.go

@@ -389,7 +389,7 @@ func (c *Config) Parse(arguments []string) error {
 		return errors.Errorf("'%s' is an invalid flag", c.flagSet.Arg(0))
 	}
 
-	err = c.Adjust(meta)
+	err = c.Adjust(meta, false)
 	return err
 }
 
@@ -461,7 +461,7 @@ func (m *configMetaData) CheckUndecoded() error {
 }
 
 // Adjust is used to adjust the PD configurations.
-func (c *Config) Adjust(meta *toml.MetaData) error {
+func (c *Config) Adjust(meta *toml.MetaData, reloading bool) error {
 	configMetaData := newConfigMetadata(meta)
 	if err := configMetaData.CheckUndecoded(); err != nil {
 		c.WarningMsgs = append(c.WarningMsgs, err.Error())
@@ -538,7 +538,7 @@ func (c *Config) Adjust(meta *toml.MetaData) error {
 
 	adjustString(&c.Metric.PushJob, c.Name)
 
-	if err := c.Schedule.adjust(configMetaData.Child("schedule")); err != nil {
+	if err := c.Schedule.adjust(configMetaData.Child("schedule"), reloading); err != nil {
 		return err
 	}
 	if err := c.Replication.adjust(configMetaData.Child("replication")); err != nil {
@@ -654,6 +654,8 @@ type ScheduleConfig struct {
 	// HighSpaceRatio is the highest usage ratio of store which regraded as high space.
 	// High space means there is a lot of spare capacity, and store region score varies directly with used size.
 	HighSpaceRatio float64 `toml:"high-space-ratio" json:"high-space-ratio"`
+	// RegionScoreFormulaVersion is used to control the formula used to calculate region score.
+	RegionScoreFormulaVersion string `toml:"region-score-formula-version" json:"region-score-formula-version"`
 	// SchedulerMaxWaitingOperator is the max coexist operators for each scheduler.
 	SchedulerMaxWaitingOperator uint64 `toml:"scheduler-max-waiting-operator" json:"scheduler-max-waiting-operator"`
 	// WARN: DisableLearner is deprecated.
@@ -728,22 +730,23 @@ func (c *ScheduleConfig) Clone() *ScheduleConfig {
 }
 
 const (
-	defaultMaxReplicas            = 3
-	defaultMaxSnapshotCount       = 3
-	defaultMaxPendingPeerCount    = 16
-	defaultMaxMergeRegionSize     = 20
-	defaultMaxMergeRegionKeys     = 200000
-	defaultSplitMergeInterval     = 1 * time.Hour
-	defaultPatrolRegionInterval   = 100 * time.Millisecond
-	defaultMaxStoreDownTime       = 30 * time.Minute
-	defaultLeaderScheduleLimit    = 4
-	defaultRegionScheduleLimit    = 2048
-	defaultReplicaScheduleLimit   = 64
-	defaultMergeScheduleLimit     = 8
-	defaultHotRegionScheduleLimit = 4
-	defaultTolerantSizeRatio      = 0
-	defaultLowSpaceRatio          = 0.8
-	defaultHighSpaceRatio         = 0.7
+	defaultMaxReplicas               = 3
+	defaultMaxSnapshotCount          = 3
+	defaultMaxPendingPeerCount       = 16
+	defaultMaxMergeRegionSize        = 20
+	defaultMaxMergeRegionKeys        = 200000
+	defaultSplitMergeInterval        = 1 * time.Hour
+	defaultPatrolRegionInterval      = 100 * time.Millisecond
+	defaultMaxStoreDownTime          = 30 * time.Minute
+	defaultLeaderScheduleLimit       = 4
+	defaultRegionScheduleLimit       = 2048
+	defaultReplicaScheduleLimit      = 64
+	defaultMergeScheduleLimit        = 8
+	defaultHotRegionScheduleLimit    = 4
+	defaultTolerantSizeRatio         = 0
+	defaultLowSpaceRatio             = 0.8
+	defaultHighSpaceRatio            = 0.7
+	defaultRegionScoreFormulaVersion = "v2"
 	// defaultHotRegionCacheHitsThreshold is the low hit number threshold of the
 	// hot region.
 	defaultHotRegionCacheHitsThreshold = 3
@@ -754,7 +757,7 @@ const (
 	defaultEnableCrossTableMerge       = true
 )
 
-func (c *ScheduleConfig) adjust(meta *configMetaData) error {
+func (c *ScheduleConfig) adjust(meta *configMetaData, reloading bool) error {
 	if !meta.IsDefined("max-snapshot-count") {
 		adjustUint64(&c.MaxSnapshotCount, defaultMaxSnapshotCount)
 	}
@@ -809,6 +812,11 @@ func (c *ScheduleConfig) adjust(meta *configMetaData) error {
 	adjustFloat64(&c.LowSpaceRatio, defaultLowSpaceRatio)
 	adjustFloat64(&c.HighSpaceRatio, defaultHighSpaceRatio)
 
+	// new cluster:v2, old cluster:v1
+	if !meta.IsDefined("region-score-formula-version") && !reloading {
+		adjustString(&c.RegionScoreFormulaVersion, defaultRegionScoreFormulaVersion)
+	}
+
 	adjustSchedulers(&c.Schedulers, DefaultSchedulers)
 
 	for k, b := range c.migrateConfigurationMap() {

server/config/config_test.go

@@ -59,7 +59,7 @@ func (s *testConfigSuite) TestTLS(c *C) {
 func (s *testConfigSuite) TestBadFormatJoinAddr(c *C) {
 	cfg := NewConfig()
 	cfg.Join = "127.0.0.1:2379" // Wrong join addr without scheme.
-	c.Assert(cfg.Adjust(nil), NotNil)
+	c.Assert(cfg.Adjust(nil, false), NotNil)
 }
 
 func (s *testConfigSuite) TestReloadConfig(c *C) {
@@ -114,9 +114,29 @@ func (s *testConfigSuite) TestReloadUpgrade(c *C) {
 	c.Assert(newOpt.GetPDServerConfig().KeyType, Equals, defaultKeyType) // should be set to default value.
 }
 
+func (s *testConfigSuite) TestReloadUpgrade2(c *C) {
+	opt, err := newTestScheduleOption()
+	c.Assert(err, IsNil)
+
+	// Simulate an old configuration that does not contain ScheduleConfig.
+	type OldConfig struct {
+		Replication ReplicationConfig `toml:"replication" json:"replication"`
+	}
+	old := &OldConfig{
+		Replication: *opt.GetReplicationConfig(),
+	}
+	storage := core.NewStorage(kv.NewMemoryKV())
+	c.Assert(storage.SaveConfig(old), IsNil)
+
+	newOpt, err := newTestScheduleOption()
+	c.Assert(err, IsNil)
+	c.Assert(newOpt.Reload(storage), IsNil)
+	c.Assert(newOpt.GetScheduleConfig().RegionScoreFormulaVersion, Equals, "") // formulaVersion keep old value when reloading.
+}
+
 func (s *testConfigSuite) TestValidation(c *C) {
 	cfg := NewConfig()
-	c.Assert(cfg.Adjust(nil), IsNil)
+	c.Assert(cfg.Adjust(nil, false), IsNil)
 
 	cfg.Log.File.Filename = path.Join(cfg.DataDir, "test")
 	c.Assert(cfg.Validate(), NotNil)
@@ -154,7 +174,7 @@ leader-schedule-limit = 0
 	cfg := NewConfig()
 	meta, err := toml.Decode(cfgData, &cfg)
 	c.Assert(err, IsNil)
-	err = cfg.Adjust(&meta)
+	err = cfg.Adjust(&meta, false)
 	c.Assert(err, IsNil)
 
 	// When invalid, use default values.
@@ -185,7 +205,7 @@ type = "random-merge"
 	cfg = NewConfig()
 	meta, err = toml.Decode(cfgData, &cfg)
 	c.Assert(err, IsNil)
-	err = cfg.Adjust(&meta)
+	err = cfg.Adjust(&meta, false)
 	c.Assert(err, IsNil)
 	c.Assert(strings.Contains(cfg.WarningMsgs[0], "Config contains undefined item"), IsTrue)
 
@@ -200,7 +220,7 @@ type = "random-merge-schedulers"
 	cfg = NewConfig()
 	meta, err = toml.Decode(cfgData, &cfg)
 	c.Assert(err, IsNil)
-	err = cfg.Adjust(&meta)
+	err = cfg.Adjust(&meta, false)
 	c.Assert(err, NotNil)
 
 	// Check correct schedulers name
@@ -214,7 +234,7 @@ type = "random-merge"
 	cfg = NewConfig()
 	meta, err = toml.Decode(cfgData, &cfg)
 	c.Assert(err, IsNil)
-	err = cfg.Adjust(&meta)
+	err = cfg.Adjust(&meta, false)
 	c.Assert(err, IsNil)
 
 	cfgData = `
@@ -225,7 +245,7 @@ address = "localhost:9090"
 	cfg = NewConfig()
 	meta, err = toml.Decode(cfgData, &cfg)
 	c.Assert(err, IsNil)
-	err = cfg.Adjust(&meta)
+	err = cfg.Adjust(&meta, false)
 	c.Assert(err, IsNil)
 
 	c.Assert(cfg.Metric.PushInterval.Duration, Equals, 35*time.Second)
@@ -238,7 +258,7 @@ tso-update-physical-interval = "10ms"
 	cfg = NewConfig()
 	meta, err = toml.Decode(cfgData, &cfg)
 	c.Assert(err, IsNil)
-	err = cfg.Adjust(&meta)
+	err = cfg.Adjust(&meta, false)
 	c.Assert(err, IsNil)
 
 	c.Assert(cfg.TSOUpdatePhysicalInterval.Duration, Equals, minTSOUpdatePhysicalInterval)
@@ -249,7 +269,7 @@ tso-update-physical-interval = "15s"
 	cfg = NewConfig()
 	meta, err = toml.Decode(cfgData, &cfg)
 	c.Assert(err, IsNil)
-	err = cfg.Adjust(&meta)
+	err = cfg.Adjust(&meta, false)
 	c.Assert(err, IsNil)
 
 	c.Assert(cfg.TSOUpdatePhysicalInterval.Duration, Equals, maxTSOUpdatePhysicalInterval)
@@ -260,7 +280,7 @@ func (s *testConfigSuite) TestMigrateFlags(c *C) {
 		cfg := NewConfig()
 		meta, err := toml.Decode(s, &cfg)
 		c.Assert(err, IsNil)
-		err = cfg.Adjust(&meta)
+		err = cfg.Adjust(&meta, false)
 		return cfg, err
 	}
 	cfg, err := load(`
@@ -290,7 +310,7 @@ disable-make-up-replica = false
 
 func newTestScheduleOption() (*PersistOptions, error) {
 	cfg := NewConfig()
-	if err := cfg.Adjust(nil); err != nil {
+	if err := cfg.Adjust(nil, false); err != nil {
 		return nil, err
 	}
 	opt := NewPersistOptions(cfg)
@@ -354,7 +374,7 @@ dashboard-address = "foo"
 		cfg := NewConfig()
 		meta, err := toml.Decode(t.cfgData, &cfg)
 		c.Assert(err, IsNil)
-		err = cfg.Adjust(&meta)
+		err = cfg.Adjust(&meta, false)
 		c.Assert(err != nil, Equals, t.hasErr)
 		if !t.hasErr {
 			c.Assert(cfg.PDServerCfg.DashboardAddress, Equals, t.dashboardAddress)
@@ -372,7 +392,7 @@ tidb-cert-path = "/path/client.pem"
 	cfg := NewConfig()
 	meta, err := toml.Decode(cfgData, &cfg)
 	c.Assert(err, IsNil)
-	err = cfg.Adjust(&meta)
+	err = cfg.Adjust(&meta, false)
 	c.Assert(err, IsNil)
 	c.Assert(cfg.Dashboard.TiDBCAPath, Equals, "/path/ca.pem")
 	c.Assert(cfg.Dashboard.TiDBKeyPath, Equals, "/path/client-key.pem")
@@ -393,7 +413,7 @@ tidb-cert-path = "/path/client.pem"
 		cfg = NewConfig()
 		meta, err = toml.Decode(cfgData, &cfg)
 		c.Assert(err, IsNil)
-		err = cfg.Adjust(&meta)
+		err = cfg.Adjust(&meta, false)
 		c.Assert(err, IsNil)
 		c.Assert(cfg.Dashboard.EnableTelemetry, Equals, test.EnableTelemetry)
 	}
@@ -415,7 +435,7 @@ wait-store-timeout = "120s"
 	cfg := NewConfig()
 	meta, err := toml.Decode(cfgData, &cfg)
 	c.Assert(err, IsNil)
-	err = cfg.Adjust(&meta)
+	err = cfg.Adjust(&meta, false)
 	c.Assert(err, IsNil)
 
 	c.Assert(cfg.ReplicationMode.ReplicationMode, Equals, "dr-auto-sync")
@@ -430,20 +450,20 @@ wait-store-timeout = "120s"
 	cfg = NewConfig()
 	meta, err = toml.Decode("", &cfg)
 	c.Assert(err, IsNil)
-	err = cfg.Adjust(&meta)
+	err = cfg.Adjust(&meta, false)
 	c.Assert(err, IsNil)
 	c.Assert(cfg.ReplicationMode.ReplicationMode, Equals, "majority")
 }
 
 func (s *testConfigSuite) TestConfigClone(c *C) {
 	cfg := &Config{}
-	cfg.Adjust(nil)
+	cfg.Adjust(nil, false)
 	c.Assert(cfg.Clone(), DeepEquals, cfg)
 
 	emptyConfigMetaData := newConfigMetadata(nil)
 
 	schedule := &ScheduleConfig{}
-	schedule.adjust(emptyConfigMetaData)
+	schedule.adjust(emptyConfigMetaData, false)
 	c.Assert(schedule.Clone(), DeepEquals, schedule)
 
 	replication := &ReplicationConfig{}

server/config/persist_options.go

@@ -413,6 +413,11 @@ func (o *PersistOptions) GetHighSpaceRatio() float64 {
 	return o.GetScheduleConfig().HighSpaceRatio
 }
 
+// GetRegionScoreFormulaVersion returns the formula version config.
+func (o *PersistOptions) GetRegionScoreFormulaVersion() string {
+	return o.GetScheduleConfig().RegionScoreFormulaVersion
+}
+
 // GetSchedulerMaxWaitingOperator returns the number of the max waiting operators.
 func (o *PersistOptions) GetSchedulerMaxWaitingOperator() uint64 {
 	return o.getTTLUintOr(schedulerMaxWaitingOperatorKey, o.GetScheduleConfig().SchedulerMaxWaitingOperator)
@@ -563,7 +568,7 @@ func (o *PersistOptions) Persist(storage *core.Storage) error {
 func (o *PersistOptions) Reload(storage *core.Storage) error {
 	cfg := &Config{}
 	// pass nil to initialize cfg to default values (all items undefined)
-	cfg.Adjust(nil)
+	cfg.Adjust(nil, true)
 
 	isExist, err := storage.LoadConfig(cfg)
 	if err != nil {

server/config/util.go

@@ -83,6 +83,6 @@ func NewTestOptions() *PersistOptions {
 		RegisterScheduler(d.Type)
 	}
 	c := NewConfig()
-	c.Adjust(nil)
+	c.Adjust(nil, false)
 	return NewPersistOptions(c)
 }