containerd/vendor/github.com/intel/goresctrl/pkg/utils/sysfs.go

/*
Copyright 2022 Intel Corporation

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 utils

import (
	"fmt"
	"os"
	"strconv"
	"strings"

	goresctrlpath "github.com/intel/goresctrl/pkg/path"
)

const (
	SysfsUncoreBasepath = "sys/devices/system/cpu/intel_uncore_frequency"
	SysfsCpuBasepath    = "sys/devices/system/cpu"
)

func setCPUFreqValue(cpu ID, setting string, value int) error {
	return writeFileInt(cpuFreqPath(cpu, setting), value)
}

func SetCPUScalingGovernor(cpu ID, governor string) error {
	return writeFileStr(cpuFreqPath(cpu, "scaling_governor"), governor)
}

// GetCPUFreqValue returns information of the currently used CPU frequency
func GetCPUFreqValue(cpu ID, setting string) (int, error) {
	raw, err := os.ReadFile(cpuFreqPath(cpu, setting))
	if err != nil {
		return 0, err
	}

	value, err := strconv.Atoi(strings.TrimSpace(string(raw)))
	if err != nil {
		return 0, err
	}

	return value, nil
}

func cpuFreqPath(cpu ID, setting string) string {
	return goresctrlpath.Path(SysfsCpuBasepath, fmt.Sprintf("cpu%d", cpu), "cpufreq", setting)
}

// SetCPUScalingMinFreq sets the scaling_min_freq value of a given CPU
func SetCPUScalingMinFreq(cpu ID, freq int) error {
	return setCPUFreqValue(cpu, "scaling_min_freq", freq)
}

// SetCPUScalingMaxFreq sets the scaling_max_freq value of a given CPU
func SetCPUScalingMaxFreq(cpu ID, freq int) error {
	return setCPUFreqValue(cpu, "scaling_max_freq", freq)
}

// SetScalingGovernorForCPUs sets the scaling_governor of a given set of CPUs
func SetScalingGovernorForCPUs(cpus []ID, governor string) error {
	for _, cpu := range cpus {
		if err := SetCPUScalingGovernor(cpu, governor); err != nil {
			return err
		}
	}

	return nil
}

// SetCPUsScalingMinFreq sets the scaling_min_freq value of a given set of CPUs
func SetCPUsScalingMinFreq(cpus []ID, freq int) error {
	for _, cpu := range cpus {
		if err := SetCPUScalingMinFreq(cpu, freq); err != nil {
			return err
		}
	}

	return nil
}

// SetCPUsScalingMaxFreq sets the scaling_max_freq value of a given set of CPUs
func SetCPUsScalingMaxFreq(cpus []ID, freq int) error {
	for _, cpu := range cpus {
		if err := SetCPUScalingMaxFreq(cpu, freq); err != nil {
			return err
		}
	}

	return nil
}

// UncoreFreqAvailable returns true if the uncore frequency control functions are available.
func UncoreFreqAvailable() bool {
	_, err := os.Stat(goresctrlpath.Path(SysfsUncoreBasepath))
	return err == nil
}

// SetUncoreMinFreq sets the minimum uncore frequency of a CPU die. Frequency is specified in kHz.
func SetUncoreMinFreq(pkg, die ID, freqKhz int) error {
	return setUncoreFreqValue(pkg, die, "min_freq_khz", freqKhz)
}

// SetUncoreMaxFreq sets the maximum uncore frequency of a CPU die. Frequency is specified in kHz.
func SetUncoreMaxFreq(pkg, die ID, freqKhz int) error {
	return setUncoreFreqValue(pkg, die, "max_freq_khz", freqKhz)
}

func uncoreFreqPath(pkg, die ID, attribute string) string {
	return goresctrlpath.Path(SysfsUncoreBasepath, fmt.Sprintf("package_%02d_die_%02d", pkg, die), attribute)
}

func getUncoreFreqValue(pkg, die ID, attribute string) (int, error) {
	return readFileInt(uncoreFreqPath(pkg, die, attribute))
}

func setUncoreFreqValue(pkg, die ID, attribute string, value int) error {
	// Bounds checking
	if hwMinFreq, err := getUncoreFreqValue(pkg, die, "initial_min_freq_khz"); err != nil {
		return err
	} else if value < hwMinFreq {
		value = hwMinFreq
	}
	if hwMaxFreq, err := getUncoreFreqValue(pkg, die, "initial_max_freq_khz"); err != nil {
		return err
	} else if value > hwMaxFreq {
		value = hwMaxFreq
	}

	return writeFileInt(uncoreFreqPath(pkg, die, attribute), value)
}

func writeFileInt(path string, value int) error {
	return os.WriteFile(path, []byte(strconv.Itoa(value)), 0644)
}

func writeFileStr(path string, value string) error {
	return os.WriteFile(path, []byte(value), 0644)
}

func readFileInt(path string) (int, error) {
	data, err := os.ReadFile(path)
	if err != nil {
		return 0, err
	}
	i, err := strconv.ParseInt(strings.TrimSpace(string(data)), 10, 32)
	return int(i), err
}