Skip to content

Commit

Permalink
feat: headroom policy for dedicated numa (kubewharf#172)
Browse files Browse the repository at this point in the history
Service performance score is considerd in new policy.

Signed-off-by: linzhecheng <linzhecheng@bytedance.com>
  • Loading branch information
cheney-lin authored and luomingmeng committed Oct 11, 2024
1 parent c8265f4 commit 5dfb126
Show file tree
Hide file tree
Showing 12 changed files with 279 additions and 39 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ func init() {
provisionpolicy.RegisterInitializer(types.CPUProvisionPolicyRama, provisionpolicy.NewPolicyRama)

headroompolicy.RegisterInitializer(types.CPUHeadroomPolicyCanonical, headroompolicy.NewPolicyCanonical)
headroompolicy.RegisterInitializer(types.CPUHeadroomPolicyNUMAExclusive, headroompolicy.NewPolicyNUMAExclusive)

provisionassembler.RegisterInitializer(types.CPUProvisionAssemblerCommon, provisionassembler.NewProvisionAssemblerCommon)

Expand Down
73 changes: 68 additions & 5 deletions pkg/agent/sysadvisor/plugin/qosaware/resource/cpu/advisor_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import (
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
k8stypes "k8s.io/apimachinery/pkg/types"
"k8s.io/kubelet/pkg/apis/resourceplugin/v1alpha1"

"github.com/kubewharf/katalyst-api/pkg/consts"
Expand Down Expand Up @@ -63,7 +64,7 @@ func generateTestConfiguration(t *testing.T, checkpointDir, stateFileDir string)
return conf
}

func newTestCPUResourceAdvisor(t *testing.T, pods []*v1.Pod, conf *config.Configuration, mf *metric.FakeMetricsFetcher, performanceLevel spd.PerformanceLevel) (*cpuResourceAdvisor, metacache.MetaCache) {
func newTestCPUResourceAdvisor(t *testing.T, pods []*v1.Pod, conf *config.Configuration, mf *metric.FakeMetricsFetcher, profiles map[k8stypes.UID]spd.DummyPodServiceProfile) (*cpuResourceAdvisor, metacache.MetaCache) {
metaCache, err := metacache.NewMetaCacheImp(conf, metric.NewFakeMetricsFetcher(metrics.DummyMetrics{}))
require.NoError(t, err)

Expand All @@ -88,7 +89,7 @@ func newTestCPUResourceAdvisor(t *testing.T, pods []*v1.Pod, conf *config.Config
MetricsFetcher: mf,
}

err = metaServer.SetServiceProfilingManager(spd.NewDummyServiceProfilingManager(performanceLevel))
err = metaServer.SetServiceProfilingManager(spd.NewDummyServiceProfilingManager(profiles))
require.NoError(t, err)

cra := NewCPUResourceAdvisor(conf, struct{}{}, metaCache, metaServer, nil)
Expand Down Expand Up @@ -144,7 +145,8 @@ func TestAdvisorUpdate(t *testing.T) {
pods []*v1.Pod
nodeEnableReclaim bool
headroomAssembler types.CPUHeadroomAssemblerName
pLevel spd.PerformanceLevel
headroomPolicies map[types.QoSRegionType][]types.CPUHeadroomPolicyName
podProfiles map[k8stypes.UID]spd.DummyPodServiceProfile
wantInternalCalculationResult types.InternalCPUCalculationResult
wantHeadroom resource.Quantity
metrics []metricItem
Expand Down Expand Up @@ -476,8 +478,12 @@ func TestAdvisorUpdate(t *testing.T) {
},
},
nodeEnableReclaim: true,
pLevel: spd.PerformanceLevelPoor,
podProfiles: map[k8stypes.UID]spd.DummyPodServiceProfile{"uid1": {PerformanceLevel: spd.PerformanceLevelPoor, Score: 0}},
headroomAssembler: types.CPUHeadroomAssemblerDedicated,
headroomPolicies: map[types.QoSRegionType][]types.CPUHeadroomPolicyName{
types.QoSRegionTypeShare: {types.CPUHeadroomPolicyCanonical},
types.QoSRegionTypeDedicatedNumaExclusive: {types.CPUHeadroomPolicyNUMAExclusive},
},
wantInternalCalculationResult: types.InternalCPUCalculationResult{
PoolEntries: map[string]map[int]int{
state.PoolNameReserve: {
Expand All @@ -491,6 +497,60 @@ func TestAdvisorUpdate(t *testing.T) {
},
wantHeadroom: *resource.NewQuantity(45, resource.DecimalSI),
},
{
name: "single_dedicated_numa_exclusive pod with performance score",
pools: map[string]*types.PoolInfo{
state.PoolNameReserve: {
PoolName: state.PoolNameReserve,
TopologyAwareAssignments: map[int]machine.CPUSet{
0: machine.MustParse("0"),
1: machine.MustParse("24"),
},
},
state.PoolNameReclaim: {
PoolName: state.PoolNameReclaim,
TopologyAwareAssignments: map[int]machine.CPUSet{
0: machine.MustParse("70-71"),
1: machine.MustParse("25-47,72-95"),
},
},
},
containers: []*types.ContainerInfo{
makeContainerInfo("uid1", "default", "pod1", "c1", consts.PodAnnotationQoSLevelDedicatedCores, state.PoolNameDedicated,
map[string]string{consts.PodAnnotationMemoryEnhancementNumaBinding: consts.PodAnnotationMemoryEnhancementNumaBindingEnable},
map[int]machine.CPUSet{
0: machine.MustParse("1-23,48-71"),
}, 36),
},
pods: []*v1.Pod{
{
ObjectMeta: metav1.ObjectMeta{
Name: "pod1",
Namespace: "default",
UID: "uid1",
},
},
},
nodeEnableReclaim: true,
podProfiles: map[k8stypes.UID]spd.DummyPodServiceProfile{"uid1": {PerformanceLevel: spd.PerformanceLevelPerfect, Score: 50}},
headroomAssembler: types.CPUHeadroomAssemblerDedicated,
headroomPolicies: map[types.QoSRegionType][]types.CPUHeadroomPolicyName{
types.QoSRegionTypeShare: {types.CPUHeadroomPolicyCanonical},
types.QoSRegionTypeDedicatedNumaExclusive: {types.CPUHeadroomPolicyNUMAExclusive},
},
wantInternalCalculationResult: types.InternalCPUCalculationResult{
PoolEntries: map[string]map[int]int{
state.PoolNameReserve: {
-1: 2,
},
state.PoolNameReclaim: {
0: 4,
-1: 47,
},
},
},
wantHeadroom: *resource.NewQuantity(49, resource.DecimalSI),
},
{
name: "dedicated_numa_exclusive_&_share",
pools: map[string]*types.PoolInfo{
Expand Down Expand Up @@ -837,8 +897,11 @@ func TestAdvisorUpdate(t *testing.T) {
if tt.headroomAssembler != "" {
conf.CPUAdvisorConfiguration.HeadroomAssembler = tt.headroomAssembler
}
if len(tt.headroomPolicies) != 0 {
conf.CPUAdvisorConfiguration.HeadroomPolicies = tt.headroomPolicies
}

advisor, metaCache := newTestCPUResourceAdvisor(t, tt.pods, conf, mf, tt.pLevel)
advisor, metaCache := newTestCPUResourceAdvisor(t, tt.pods, conf, mf, tt.podProfiles)
advisor.startTime = time.Now().Add(-types.StartUpPeriod)
advisor.conf.GetDynamicConfiguration().EnableReclaim = tt.nodeEnableReclaim

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,13 @@ import (
"math"

"k8s.io/klog/v2"
"k8s.io/kubelet/pkg/apis/resourceplugin/v1alpha1"

"github.com/kubewharf/katalyst-core/pkg/agent/sysadvisor/metacache"
"github.com/kubewharf/katalyst-core/pkg/agent/sysadvisor/plugin/qosaware/resource/helper"
"github.com/kubewharf/katalyst-core/pkg/agent/sysadvisor/types"
"github.com/kubewharf/katalyst-core/pkg/config"
"github.com/kubewharf/katalyst-core/pkg/metaserver"
"github.com/kubewharf/katalyst-core/pkg/metrics"
"github.com/kubewharf/katalyst-core/pkg/util/general"
"github.com/kubewharf/katalyst-core/pkg/util/machine"
)

Expand Down Expand Up @@ -63,22 +61,9 @@ func (p *PolicyCanonical) Update() error {
klog.Errorf("[qosaware-cpu-headroom] illegal container info of %v/%v", podUID, containerName)
continue
}
var containerEstimation float64 = 0
if ci.IsNumaBinding() && !enableReclaim {
if ci.ContainerType == v1alpha1.ContainerType_MAIN {
bindingNumas := machine.GetCPUAssignmentNUMAs(ci.TopologyAwareAssignments)
for range bindingNumas.ToSliceInt() {
containerEstimation += float64(p.metaServer.CPUsPerNuma())
}
general.Infof("container %s/%s occupied cpu %v", ci.PodName, ci.ContainerName, containerEstimation)
} else {
containerEstimation = 0
}
} else {
containerEstimation, err = helper.EstimateContainerCPUUsage(ci, p.metaReader, enableReclaim)
if err != nil {
return err
}
containerEstimation, err := helper.EstimateContainerCPUUsage(ci, p.metaReader, enableReclaim)
if err != nil {
return err
}

// FIXME: metric server doesn't support to report cpu usage in numa granularity,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
/*
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 headroompolicy

import (
"context"
"fmt"
"math"

"k8s.io/klog/v2"

"github.com/kubewharf/katalyst-core/pkg/agent/sysadvisor/metacache"
"github.com/kubewharf/katalyst-core/pkg/agent/sysadvisor/plugin/qosaware/resource/helper"
"github.com/kubewharf/katalyst-core/pkg/agent/sysadvisor/types"
"github.com/kubewharf/katalyst-core/pkg/config"
"github.com/kubewharf/katalyst-core/pkg/metaserver"
"github.com/kubewharf/katalyst-core/pkg/metaserver/spd"
"github.com/kubewharf/katalyst-core/pkg/metrics"
"github.com/kubewharf/katalyst-core/pkg/util/machine"
)

type PolicyNUMAExclusive struct {
*PolicyBase
headroom float64
}

// NOTE: NewPolicyNUMAExclusive can only for dedicated_cores with numa exclusive region

func NewPolicyNUMAExclusive(regionName string, regionType types.QoSRegionType, ownerPoolName string,
_ *config.Configuration, _ interface{}, metaReader metacache.MetaReader,
metaServer *metaserver.MetaServer, emitter metrics.MetricEmitter) HeadroomPolicy {
p := &PolicyNUMAExclusive{
PolicyBase: NewPolicyBase(regionName, regionType, ownerPoolName, metaReader, metaServer, emitter),
}
return p
}

func (p *PolicyNUMAExclusive) getContainerInfos() (string, []*types.ContainerInfo, error) {
if len(p.podSet) != 1 {
return "", nil, fmt.Errorf("more than one pod are assgined to this policy")
}
cis := make([]*types.ContainerInfo, 0)
for podUID, containers := range p.podSet {
for _, container := range containers.List() {
ci, ok := p.metaReader.GetContainerInfo(podUID, container)
if !ok {
return "", nil, fmt.Errorf("failed to find continaer(%s/%s)", podUID, container)
}
cis = append(cis, ci)
}
return podUID, cis, nil
}
return "", nil, fmt.Errorf("should never get here")
}

func (p *PolicyNUMAExclusive) Update() error {
cpuEstimation := 0.0
containerCnt := 0

podUID, containers, err := p.getContainerInfos()
if err != nil {
return err
}
enableReclaim, err := helper.PodEnableReclaim(context.Background(), p.metaServer, podUID, p.EnableReclaim)
if err != nil {
return err
}
if !enableReclaim {
p.headroom = 0
return nil
}

for _, ci := range containers {
containerEstimation, err := helper.EstimateContainerCPUUsage(ci, p.metaReader, enableReclaim)
if err != nil {
return err
}

// FIXME: metric server doesn't support to report cpu usage in numa granularity,
// so we split cpu usage evenly across the binding numas of container.
if p.bindingNumas.Size() > 0 {
cpuSize := 0
for _, numaID := range p.bindingNumas.ToSliceInt() {
cpuSize += ci.TopologyAwareAssignments[numaID].Size()
}
containerEstimation = containerEstimation * float64(cpuSize) / float64(machine.CountCPUAssignmentCPUs(ci.TopologyAwareAssignments))
}

cpuEstimation += containerEstimation
containerCnt += 1
}
cpuEstimation += p.ReservedForAllocate

originHeadroom := math.Max(p.ResourceUpperBound-cpuEstimation+p.ReservedForReclaim, 0)
score, err := helper.PodPerformanceScore(context.Background(), p.metaServer, podUID)
if err != nil {
return err
}
p.headroom = originHeadroom * (score - spd.MinPerformanceScore) / (spd.MaxPerformanceScore - spd.MinPerformanceScore)

klog.Infof("region %v cpuEstimation %v with reservedForAllocate %v reservedForReclaim %v"+
" originHeadroom %v headroom %v score %v #container %v", p.regionName, cpuEstimation, p.ReservedForAllocate,
p.ReservedForReclaim, originHeadroom, p.headroom, score, containerCnt)

return nil
}

func (p *PolicyNUMAExclusive) GetHeadroom() (float64, error) {
return p.headroom, nil
}
12 changes: 12 additions & 0 deletions pkg/agent/sysadvisor/plugin/qosaware/resource/helper/helper.go
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,15 @@ func PodEnableReclaim(ctx context.Context, metaServer *metaserver.MetaServer,
// if performance level not poor, it can not be reclaimed
return pLevel != spd.PerformanceLevelPoor, nil
}

func PodPerformanceScore(ctx context.Context, metaServer *metaserver.MetaServer, podUID string) (float64, error) {
if metaServer == nil {
return 0, fmt.Errorf("metaServer is nil")
}
pod, err := metaServer.GetPod(ctx, podUID)
if err != nil {
return 0, err
}

return metaServer.ServiceBusinessPerformanceScore(ctx, pod)
}
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ func (p *PolicyCanonical) estimateNonReclaimedQoSMemoryRequirement() (float64, e
return true
}

if ci.IsNumaBinding() && !enableReclaim {
if ci.IsNumaExclusive() && !enableReclaim {
if ci.ContainerType == v1alpha1.ContainerType_MAIN {
bindingNumas := machine.GetCPUAssignmentNUMAs(ci.TopologyAwareAssignments)
for _, numaID := range bindingNumas.ToSliceInt() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -458,7 +458,8 @@ func TestPolicyCanonical_calculateMemoryBuffer(t *testing.T) {
makeContainerInfo("pod1", "default",
"pod1", "container1",
consts.PodAnnotationQoSLevelDedicatedCores,
map[string]string{consts.PodAnnotationMemoryEnhancementNumaBinding: consts.PodAnnotationMemoryEnhancementNumaBindingEnable},
map[string]string{consts.PodAnnotationMemoryEnhancementNumaBinding: consts.PodAnnotationMemoryEnhancementNumaBindingEnable,
consts.PodAnnotationMemoryEnhancementNumaExclusive: consts.PodAnnotationMemoryEnhancementNumaExclusiveEnable},
types.TopologyAwareAssignment{0: machine.NewCPUSet(0, 1, 2, 3, 4)}, 1),
},
memoryHeadroomConfiguration: &memoryheadroom.MemoryHeadroomConfiguration{
Expand Down
5 changes: 3 additions & 2 deletions pkg/agent/sysadvisor/types/cpu.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,9 @@ const (
type CPUHeadroomPolicyName string

const (
CPUHeadroomPolicyNone CPUHeadroomPolicyName = "none"
CPUHeadroomPolicyCanonical CPUHeadroomPolicyName = "canonical"
CPUHeadroomPolicyNone CPUHeadroomPolicyName = "none"
CPUHeadroomPolicyCanonical CPUHeadroomPolicyName = "canonical"
CPUHeadroomPolicyNUMAExclusive CPUHeadroomPolicyName = "numa_exclusive"
)

// CPUProvisionAssemblerName defines assemblers for cpu advisor to generate node
Expand Down
10 changes: 7 additions & 3 deletions pkg/agent/sysadvisor/types/helper.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,17 @@ import (
"github.com/kubewharf/katalyst-api/pkg/consts"
"github.com/kubewharf/katalyst-core/pkg/util/general"
"github.com/kubewharf/katalyst-core/pkg/util/machine"
qosutil "github.com/kubewharf/katalyst-core/pkg/util/qos"
)

// IsNumaBinding returns true iff current container is for dedicated_cores with numa binding
// todo: support numa exclusive
// IsNumaBinding returns true if current container is for dedicated_cores with numa binding
func (ci *ContainerInfo) IsNumaBinding() bool {
return ci.QoSLevel == consts.PodAnnotationQoSLevelDedicatedCores &&
ci.Annotations[consts.PodAnnotationMemoryEnhancementNumaBinding] == consts.PodAnnotationMemoryEnhancementNumaBindingEnable
qosutil.AnnotationsIndicateNUMABinding(ci.Annotations)
}

func (ci *ContainerInfo) IsNumaExclusive() bool {
return ci.QoSLevel == consts.PodAnnotationQoSLevelDedicatedCores && qosutil.AnnotationsIndicateNUMAExclusive(ci.Annotations)
}

func (ci *ContainerInfo) Clone() *ContainerInfo {
Expand Down
Loading

0 comments on commit 5dfb126

Please sign in to comment.