Skip to content

Commit

Permalink
Merge pull request kubewharf#667 from lubinszARM/pr_memory_compaction
Browse files Browse the repository at this point in the history
feat(fragmem): unified solution for memory compaction
  • Loading branch information
luomingmeng authored Oct 23, 2024
2 parents 56959bd + c364e14 commit 0c234bf
Show file tree
Hide file tree
Showing 15 changed files with 613 additions and 3 deletions.
18 changes: 18 additions & 0 deletions cmd/katalyst-agent/app/options/qrm/memory_plugin.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ type MemoryOptions struct {

SockMemOptions
LogCacheOptions
FragMemOptions
}

type SockMemOptions struct {
Expand Down Expand Up @@ -64,6 +65,13 @@ type LogCacheOptions struct {
FileFilters []string
}

type FragMemOptions struct {
EnableSettingFragMem bool
// SetMemFragScoreAsync sets the threashold of frag score for async memory compaction.
// The async compaction behavior will be triggered while exceeding this score.
SetMemFragScoreAsync int
}

func NewMemoryOptions() *MemoryOptions {
return &MemoryOptions{
PolicyName: "dynamic",
Expand All @@ -87,6 +95,10 @@ func NewMemoryOptions() *MemoryOptions {
PathList: []string{},
FileFilters: []string{".*\\.log.*"},
},
FragMemOptions: FragMemOptions{
EnableSettingFragMem: false,
SetMemFragScoreAsync: 80,
},
}
}

Expand Down Expand Up @@ -131,6 +143,10 @@ func (o *MemoryOptions) AddFlags(fss *cliflag.NamedFlagSets) {
"the absolute path list where files will be checked to evict page cache")
fs.StringSliceVar(&o.FileFilters, "qrm-memory-logcache-file-filters",
o.FileFilters, "string list to filter log files, default to *log*")
fs.BoolVar(&o.EnableSettingFragMem, "enable-setting-mem-compaction",
o.EnableSettingFragMem, "if set true, we will enable memory compaction related features")
fs.IntVar(&o.SetMemFragScoreAsync, "qrm-memory-frag-score-async",
o.SetMemFragScoreAsync, "set the threshold of frag score for async memory compaction")
}

func (o *MemoryOptions) ApplyTo(conf *qrmconfig.MemoryQRMPluginConfig) error {
Expand All @@ -153,5 +169,7 @@ func (o *MemoryOptions) ApplyTo(conf *qrmconfig.MemoryQRMPluginConfig) error {
conf.MaxInterval = o.MaxInterval
conf.PathList = o.PathList
conf.FileFilters = o.FileFilters
conf.EnableSettingFragMem = o.EnableSettingFragMem
conf.SetMemFragScoreAsync = o.SetMemFragScoreAsync
return nil
}
1 change: 1 addition & 0 deletions pkg/agent/qrm-plugins/memory/consts/consts.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,5 @@ const (
CommunicateWithAdvisor = MemoryPluginDynamicPolicyName + "_communicate_with_advisor"
DropCache = MemoryPluginDynamicPolicyName + "_drop_cache"
EvictLogCache = MemoryPluginDynamicPolicyName + "_evict_log_cache"
SetMemCompact = MemoryPluginDynamicPolicyName + "_mem_compact"
)
12 changes: 12 additions & 0 deletions pkg/agent/qrm-plugins/memory/dynamicpolicy/policy.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ import (
"github.com/kubewharf/katalyst-core/pkg/agent/qrm-plugins/memory/dynamicpolicy/memoryadvisor"
"github.com/kubewharf/katalyst-core/pkg/agent/qrm-plugins/memory/dynamicpolicy/oom"
"github.com/kubewharf/katalyst-core/pkg/agent/qrm-plugins/memory/dynamicpolicy/state"
"github.com/kubewharf/katalyst-core/pkg/agent/qrm-plugins/memory/handlers/fragmem"
"github.com/kubewharf/katalyst-core/pkg/agent/qrm-plugins/memory/handlers/logcache"
"github.com/kubewharf/katalyst-core/pkg/agent/qrm-plugins/memory/handlers/sockmem"
"github.com/kubewharf/katalyst-core/pkg/agent/qrm-plugins/util"
Expand Down Expand Up @@ -149,6 +150,7 @@ type DynamicPolicy struct {

enableSettingMemoryMigrate bool
enableSettingSockMem bool
enableSettingFragMem bool
enableMemoryAdvisor bool
memoryAdvisorSocketAbsPath string
memoryPluginSocketAbsPath string
Expand Down Expand Up @@ -219,6 +221,7 @@ func NewDynamicPolicy(agentCtx *agent.GenericContext, conf *config.Configuration
defaultAsyncLimitedWorkers: asyncworker.NewAsyncLimitedWorkers(memoryPluginAsyncWorkersName, defaultAsyncWorkLimit, wrappedEmitter),
enableSettingMemoryMigrate: conf.EnableSettingMemoryMigrate,
enableSettingSockMem: conf.EnableSettingSockMem,
enableSettingFragMem: conf.EnableSettingFragMem,
enableMemoryAdvisor: conf.EnableMemoryAdvisor,
memoryAdvisorSocketAbsPath: conf.MemoryAdvisorSocketAbsPath,
memoryPluginSocketAbsPath: conf.MemoryPluginSocketAbsPath,
Expand Down Expand Up @@ -414,6 +417,15 @@ func (p *DynamicPolicy) Start() (err error) {
general.Errorf("evictLogCache failed, err=%v", err)
}
}
if p.enableSettingFragMem {
general.Infof("setFragMem enabled")
err := periodicalhandler.RegisterPeriodicalHandlerWithHealthz(memconsts.SetMemCompact,
general.HealthzCheckStateNotReady, qrm.QRMMemoryPluginPeriodicalHandlerGroupName,
fragmem.SetMemCompact, 1800*time.Second, healthCheckTolerationTimes)
if err != nil {
general.Infof("setFragMem failed, err=%v", err)
}
}

go wait.Until(func() {
periodicalhandler.ReadyToStartHandlersByGroup(qrm.QRMMemoryPluginPeriodicalHandlerGroupName)
Expand Down
36 changes: 36 additions & 0 deletions pkg/agent/qrm-plugins/memory/handlers/fragmem/const.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
/*
Copyright 2022 The Katalyst Authors.
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 fragmem

const (
// Constants for fragmem related kernel features
hostCompactProactivenessFile = "/proc/sys/vm/compaction_proactiveness"
hostMemNodePath = "/sys/devices/system/node/node"

fragScoreMin = 60.0
fragScoreMax = 95.0
minFragScoreGap = 8
delayCompactTimes = 10
sleepCompactTime = 10
minHostLoad = 100

commandKcompactd = "kcompactd"
)

const (
metricNameMemoryCompaction = "async_handler_memory_compaction"
)
167 changes: 167 additions & 0 deletions pkg/agent/qrm-plugins/memory/handlers/fragmem/fragmem_linux.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
//go:build linux
// +build linux

/*
Copyright 2022 The Katalyst Authors.
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 fragmem

import (
"sync"
"time"

"k8s.io/apimachinery/pkg/util/errors"

memconsts "github.com/kubewharf/katalyst-core/pkg/agent/qrm-plugins/memory/consts"
coreconfig "github.com/kubewharf/katalyst-core/pkg/config"
dynamicconfig "github.com/kubewharf/katalyst-core/pkg/config/agent/dynamic"
"github.com/kubewharf/katalyst-core/pkg/consts"
"github.com/kubewharf/katalyst-core/pkg/metaserver"
"github.com/kubewharf/katalyst-core/pkg/metaserver/agent/metric/helper"
"github.com/kubewharf/katalyst-core/pkg/metrics"
"github.com/kubewharf/katalyst-core/pkg/util/general"
"github.com/kubewharf/katalyst-core/pkg/util/process"
)

var (
delayTimes int = 1
mu sync.RWMutex
)

// SetDelayValue sets the value of the global delayTimes
func SetDelayTimes(value int) {
mu.Lock()
defer mu.Unlock()
delayTimes = value
}

// GetDelayValue returns the value of the global delayTimes
func GetDelayTimes() int {
mu.RLock()
defer mu.RUnlock()
return delayTimes
}

func isHighSystemLoad(metaServer *metaserver.MetaServer, emitter metrics.MetricEmitter) bool {
load, err := helper.GetNodeMetricWithTime(metaServer.MetricsFetcher, emitter, consts.MetricLoad5MinSystem)
if err != nil {
general.Errorf("Failed to get load: %v", err)
return false
}

numCPU := metaServer.CPUTopology.NumCPUs
loadPerCPU := int(load.Value) * 100 / numCPU
general.Infof("Host load info: load: %v, numCPU: %v, loadPerCPU: %v", load.Value, numCPU, loadPerCPU)

return loadPerCPU > minHostLoad
}

func memCompacWithBestEffort(conf *coreconfig.Configuration, metaServer *metaserver.MetaServer, emitter metrics.MetricEmitter) {
fragScoreWatermark := uint64(general.Clamp(float64(conf.SetMemFragScoreAsync), fragScoreMin, fragScoreMax))
for _, numaID := range metaServer.CPUDetails.NUMANodes().ToSliceNoSortInt() {
// Step 1.0, get fragScore from Malachite
score, err := helper.GetNumaMetricWithTime(metaServer.MetricsFetcher, emitter, consts.MetricMemFragScoreNuma, numaID)
if err != nil {
general.Errorf("Failed to get frag score:%v", err)
continue
}
fragScore := int(score.Value)
general.Infof("NUMA fragScore info: node:%d, fragScore:%d, fragScoreGate:%d", numaID, fragScore, fragScoreWatermark)
// Step 1.1, if the fragScore exceeds the target, we will initiate memory compaction
if fragScore < int(fragScoreWatermark) {
continue
}

// Step 2, check if kcompactd is in D state
if process.IsCommandInDState(commandKcompactd) {
general.Infof("kcompactd is in D state")
return
}

// Step 3, do memory compaction in node level
_ = emitter.StoreInt64(metricNameMemoryCompaction, 1, metrics.MetricTypeNameRaw)
setHostMemCompact(numaID)
time.Sleep(sleepCompactTime * time.Second)

// Step 4, if memory compaction is not effective, extend the check interval
/*
* If mem fragScore shows no significant improvement after compaction
* (frag_score < (fragScoreWatermark-minFragScoreGap)),
* it indicates that the system has minimal physical memory fragmentation
*/
newScore, err := helper.GetNumaMetricWithTime(metaServer.MetricsFetcher, emitter, consts.MetricMemFragScoreNuma, numaID)
if err != nil {
continue
}
newFragScore := int(newScore.Value)
general.Infof("Node fragScore new info: node:%d, fragScore:%d", numaID, newFragScore)
// compare the new and old fragScore to avoid ineffective compaction.
if newFragScore >= int(fragScoreWatermark-minFragScoreGap) {
general.Infof("Not so much memory fragmentation in this node, increase the scanning cycle")
SetDelayTimes(delayCompactTimes)
}
}
}

/* SetMemCompact is the unified solution for memory compaction.
* it includes 3 parts:
* 1, set the threshold of fragmentation score that triggers synchronous memory compaction in the memory slow path.
* 2, if has proactive compaction feature, then set the threshold of fragmentation score for asynchronous memory compaction through compaction_proactiveness.
* 3, if no proactive compaction feature, then use the threshold of fragmentation score to trigger manually memory compaction.
*/
func SetMemCompact(conf *coreconfig.Configuration,
_ interface{}, _ *dynamicconfig.DynamicAgentConfiguration,
emitter metrics.MetricEmitter, metaServer *metaserver.MetaServer,
) {
general.Infof("called")

var errList []error
defer func() {
_ = general.UpdateHealthzStateByError(memconsts.SetMemCompact, errors.NewAggregate(errList))
}()

if conf == nil || emitter == nil || metaServer == nil {
general.Errorf("nil input, conf:%v, emitter:%v, metaServer:%v", conf, emitter, metaServer)
return
}

if delay := GetDelayTimes(); delay > 0 {
general.Infof("No memory fragmentation in this node, skip this scanning cycle, delay=%d", delay)
SetDelayTimes(delay - 1)
return
}

// EnableSettingMemCompact featuregate.
if !conf.EnableSettingFragMem {
general.Infof("EnableSettingFragMem disabled")
return
}

// Step1, check proactive compaction.
// if proactive compaction feature enabled, then return.
if !checkCompactionProactivenessDisabled(hostCompactProactivenessFile) {
general.Infof("proactive compaction enabled, then return")
return
}

// Step2, avoid too much host pressure.
if isHighSystemLoad(metaServer, emitter) {
return
}

// Step3, user space memory compaction will be trigger while exceeding fragScoreWatermark(default:80).
memCompacWithBestEffort(conf, metaServer, emitter)
}
Loading

0 comments on commit 0c234bf

Please sign in to comment.