perfprof: enable exec-cpu-affinity by default

For High-performance configuration, cri-o started supporting exec-cpu-affinity
feature and when configured to `first` it provides the ability for exec
process to be pinned to the first CPU from the shared-CPUs IF set
or to the first one from the islolated set.
(see cri-o/cri-o@4dd7fb9)

In performance profile, we want to enable this high-performance feature
by default, and disbale it (legacy) it provides an annotation option.

The annotation is there just as a backup in case of bugs getting
reported by the consequences of this feature enablement, and should be
removed in 2 releases.

Signed-off-by: Shereen Haj <shajmakh@redhat.com>

Author: shajmakh

assets/performanceprofile/configs/99-runtimes.conf

@@ -11,4 +11,5 @@ infra_ctr_cpuset = "{{.ReservedCpus}}"
 # do not have high-performance binary under the $PATH that will point to it.
 [crio.runtime.runtimes.high-performance]
 inherit_default_runtime = true
+{{if .ExecCPUAffinity}}exec_cpu_affinity = "{{.ExecCPUAffinity}}"{{end}}
 allowed_annotations = ["cpu-load-balancing.crio.io", "cpu-quota.crio.io", "irq-load-balancing.crio.io", "cpu-c-states.crio.io", "cpu-freq-governor.crio.io"{{ if .CrioSharedCPUsAnnotation }}{{ printf ", %q" .CrioSharedCPUsAnnotation}}{{end}}]

pkg/apis/performanceprofile/v2/performanceprofile_types.go

@@ -34,6 +34,11 @@ const PerformanceProfileEnablePhysicalRpsAnnotation = "performance.openshift.io/
 // Valid values: "true", "enable" (to enable), "false", "disable" (to disable).
 const PerformanceProfileEnableRpsAnnotation = "performance.openshift.io/enable-rps"
 
+// PerformanceProfileDisableExecCPUAffinityAnnotation disables the exec-cpu-affinity setting for the node.
+// Valid values: "true". Other values are ignored and treated as "false".
+// remove in 4.23
+const PerformanceProfileDisableExecCPUAffinityAnnotation = "performance.openshift.io/disable-exec-cpu-affinity"
+
 // PerformanceProfileSpec defines the desired state of PerformanceProfile.
 type PerformanceProfileSpec struct {
 	// CPU defines a set of CPU related parameters.

pkg/performanceprofile/controller/performanceprofile/components/machineconfig/machineconfig.go

@@ -118,6 +118,7 @@ const (
 	templateOvsSliceUsageFile        = "01-use-ovs-slice.conf"
 	templateWorkload                 = "Workload"
 	templateCrioSharedCPUsAnnotation = "CrioSharedCPUsAnnotation"
+	templateExecCPUAffinity          = "ExecCPUAffinity"
 )
 
 // New returns new machine configuration object for performance sensitive workloads
@@ -587,6 +588,10 @@ func renderCrioConfigSnippet(profile *performancev2.PerformanceProfile, src stri
 		templateArgs[templateReservedCpus] = string(*profile.Spec.CPU.Reserved)
 	}
 
+	if profilecomponent.IsExecCPUAffinityEnabled(profile) {
+		templateArgs[templateExecCPUAffinity] = "first"
+	}
+
 	if opts.MixedCPUsEnabled {
 		templateArgs[templateSharedCpus] = string(*profile.Spec.CPU.Shared)
 		templateArgs[templateCrioSharedCPUsAnnotation] = "cpu-shared.crio.io"

pkg/performanceprofile/controller/performanceprofile/components/machineconfig/machineconfig_test.go

@@ -5,6 +5,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"path/filepath"
 	"regexp"
 	"strings"
 
@@ -141,6 +142,59 @@ var _ = Describe("Machine Config", func() {
 		})
 	})
 
+	Context("machine config creation with CRI-O runtime config", func() {
+		crioRuntimeConfigPath := filepath.Join(crioConfd, crioRuntimesConfig)
+
+		It("should create machine config with exec-cpu-affinity set by default", func() {
+			profile := testutils.NewPerformanceProfile("test")
+			profile.Spec.CPU.Shared = nil
+
+			mc, err := New(profile, &components.MachineConfigOptions{})
+			Expect(err).ToNot(HaveOccurred())
+
+			result := igntypes.Config{}
+			Expect(json.Unmarshal(mc.Spec.Config.Raw, &result)).To(Succeed())
+
+			var content string
+			for _, f := range result.Storage.Files {
+				if f.Path == crioRuntimeConfigPath {
+					base64Data := strings.TrimPrefix(*f.Contents.Source, "data:text/plain;charset=utf-8;base64,")
+					decoded, err := base64.StdEncoding.DecodeString(base64Data)
+					Expect(err).ToNot(HaveOccurred())
+					content = string(decoded)
+					break
+				}
+			}
+			Expect(content).ToNot(BeEmpty(), "crio runtime config not found")
+			Expect(content).To(ContainSubstring("exec_cpu_affinity = \"first\""))
+		})
+
+		It("should create machine config without exec-cpu-affinity when annotation is set to true", func() {
+			profile := testutils.NewPerformanceProfile("test")
+			profile.Annotations = map[string]string{}
+			profile.Annotations[performancev2.PerformanceProfileDisableExecCPUAffinityAnnotation] = "true"
+
+			mc, err := New(profile, &components.MachineConfigOptions{})
+			Expect(err).ToNot(HaveOccurred())
+
+			result := igntypes.Config{}
+			Expect(json.Unmarshal(mc.Spec.Config.Raw, &result)).To(Succeed())
+
+			var content string
+			for _, f := range result.Storage.Files {
+				if f.Path == crioRuntimeConfigPath {
+					base64Data := strings.TrimPrefix(*f.Contents.Source, "data:text/plain;charset=utf-8;base64,")
+					decoded, err := base64.StdEncoding.DecodeString(base64Data)
+					Expect(err).ToNot(HaveOccurred())
+					content = string(decoded)
+					break
+				}
+			}
+			Expect(content).ToNot(BeEmpty(), "crio runtime config not found")
+			Expect(content).To(Not(ContainSubstring("exec_cpu_affinity = \"first\"")))
+		})
+	})
+
 	Context("machine config creation with enabled RPS using alternative values", func() {
 		It("should create machine config with RPS configuration when enabled with 'enable'", func() {
 			profile := testutils.NewPerformanceProfile("test")

pkg/performanceprofile/controller/performanceprofile/components/profile/profile.go

@@ -94,3 +94,17 @@ func IsMixedCPUsEnabled(profile *performancev2.PerformanceProfile) bool {
 	}
 	return *profile.Spec.WorkloadHints.MixedCpus
 }
+
+// IsExecCPUAffinityEnabled checks if exec-cpu-affinity feature should be enabled
+func IsExecCPUAffinityEnabled(profile *performancev2.PerformanceProfile) bool {
+	if profile.Annotations != nil {
+		isExecCPUAffinityDisabled, ok := profile.Annotations[performancev2.PerformanceProfileDisableExecCPUAffinityAnnotation]
+		if ok && isExecCPUAffinityDisabled == "true" {
+			// run the legacy behavior and disable exec-cpu-affinity
+			return false
+		}
+	}
+
+	// The default behavior is to enable exec-cpu-affinity whenever profile is applied
+	return true
+}