node-feature-discovery/source/cpu/cpu.go

/*
Copyright 2018 The Kubernetes 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 cpu

import (
	"io/ioutil"
	"log"
	"path"

	"sigs.k8s.io/node-feature-discovery/source"
)

const (
	cpuDevicesBaseDir = "/sys/bus/cpu/devices"
)

// Configuration file options
type cpuidConfig struct {
	AttributeBlacklist []string `json:"attributeBlacklist,omitempty"`
	AttributeWhitelist []string `json:"attributeWhitelist,omitempty"`
}

// NFDConfig is the type holding configuration of the cpuid feature source
type NFDConfig struct {
	Cpuid cpuidConfig `json:"cpuid,omitempty"`
}

// Config contains the configuration of the cpuid source
var Config = NFDConfig{
	cpuidConfig{
		AttributeBlacklist: []string{
			"BMI1",
			"BMI2",
			"CLMUL",
			"CMOV",
			"CX16",
			"ERMS",
			"F16C",
			"HTT",
			"LZCNT",
			"MMX",
			"MMXEXT",
			"NX",
			"POPCNT",
			"RDRAND",
			"RDSEED",
			"RDTSCP",
			"SGX",
			"SSE",
			"SSE2",
			"SSE3",
			"SSE4.1",
			"SSE4.2",
			"SSSE3",
		},
		AttributeWhitelist: []string{},
	},
}

// Filter for cpuid labels
type keyFilter struct {
	keys      map[string]struct{}
	whitelist bool
}

var cpuidFilter *keyFilter

// Implement FeatureSource interface
type Source struct{}

func (s Source) Name() string { return "cpu" }

func (s Source) Discover() (source.Features, error) {
	features := source.Features{}

	if cpuidFilter == nil {
		initCpuidFilter()
	}
	log.Printf("CONF: %s", Config)

	// Check if hyper-threading seems to be enabled
	found, err := haveThreadSiblings()
	if err != nil {
		log.Printf("ERROR: failed to detect hyper-threading: %v", err)
	} else if found {
		features["hardware_multithreading"] = true
	}

	// Check SST-BF
	found, err = discoverSSTBF()
	if err != nil {
		log.Printf("ERROR: failed to detect SST-BF: %v", err)
	} else if found {
		features["power.sst_bf.enabled"] = true
	}

	// Detect CPUID
	cpuidFlags := getCpuidFlags()
	for _, f := range cpuidFlags {
		if cpuidFilter.unmask(f) {
			features["cpuid."+f] = true
		}
	}

	// Detect turbo boost
	turbo, err := turboEnabled()
	if err != nil {
		log.Printf("ERROR: %v", err)
	} else if turbo {
		features["pstate.turbo"] = true
	}

	// Detect RDT features
	rdt := discoverRDT()
	for _, f := range rdt {
		features["rdt."+f] = true
	}

	return features, nil
}

// Check if any (online) CPUs have thread siblings
func haveThreadSiblings() (bool, error) {
	files, err := ioutil.ReadDir(cpuDevicesBaseDir)
	if err != nil {
		return false, err
	}

	for _, file := range files {
		// Try to read siblings from topology
		siblings, err := ioutil.ReadFile(path.Join(cpuDevicesBaseDir, file.Name(), "topology/thread_siblings_list"))
		if err != nil {
			return false, err
		}
		for _, char := range siblings {
			// If list separator found, we determine that there are multiple siblings
			if char == ',' || char == '-' {
				return true, nil
			}
		}
	}
	// No siblings were found
	return false, nil
}

func initCpuidFilter() {
	newFilter := keyFilter{keys: map[string]struct{}{}}
	if len(Config.Cpuid.AttributeWhitelist) > 0 {
		for _, k := range Config.Cpuid.AttributeWhitelist {
			newFilter.keys[k] = struct{}{}
		}
		newFilter.whitelist = true
	} else {
		for _, k := range Config.Cpuid.AttributeBlacklist {
			newFilter.keys[k] = struct{}{}
		}
		newFilter.whitelist = false
	}
	cpuidFilter = &newFilter
}

func (f keyFilter) unmask(k string) bool {
	if f.whitelist {
		if _, ok := f.keys[k]; ok {
			return true
		}
	} else {
		if _, ok := f.keys[k]; !ok {
			return true
		}
	}
	return false
}