machine

package
v0.5.28 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 3, 2025 License: Apache-2.0 Imports: 29 Imported by: 29

Documentation

Index

Constants

View Source 
const (
	DefaultNICNamespace = ""

	IPVersionV4 = 4
	IPVersionV6 = 6
)
View Source 
const (
	LargeNUMAsPoint = 16
)

Variables

This section is empty.

Functions

func CheckNUMACrossSockets 

func CheckNUMACrossSockets(numaNodes []int, cpuTopology *CPUTopology) (bool, error)

CheckNUMACrossSockets judges whether the given NUMA nodes are located in different sockets

func CountCPUAssignmentCPUs added in v0.2.0 

func CountCPUAssignmentCPUs(assignment map[int]CPUSet) int

CountCPUAssignmentCPUs returns sum of cpus among all numas in assignment

func DeepcopyCPUAssignment added in v0.2.0 

func DeepcopyCPUAssignment(assignment map[int]CPUSet) map[int]CPUSet

DeepcopyCPUAssignment returns a deep-copied assignments for the given one

func Discover 

func Discover(machineInfo *info.MachineInfo) (*CPUTopology, *MemoryTopology, error)

Discover returns CPUTopology based on cadvisor node info

func DoNetNS added in v0.5.22 

func DoNetNS(nsName, netNSDirAbsPath string, cb func(sysFsDir, nsAbsPath string) error) error

DoNetNS executes a callback function within the specified network namespace. For the default namespace, runs callback in current namespace without modification. For other namespaces: 1. Locks OS thread to maintain namespace context 2. Creates temporary sysfs mount to isolate from host 3. Executes callback with isolated sysfs path 4. Cleans up mount and restores original namespace

func GenerateDummyMachineInfo 

func GenerateDummyMachineInfo(numaNum int, memoryCapacityGB int) (*info.MachineInfo, error)

func GetCoreNumReservedForReclaim added in v0.3.0 

func GetCoreNumReservedForReclaim(numReservedCores, numNumaNodes int) map[int]int

GetCoreNumReservedForReclaim generates per numa reserved for reclaim resource value map. per numa reserved resource is taken in a fair way with even step, e.g. 4 -> 1 1 1 1; 2 -> 1 1 1 1; 8 -> 2 2 2 2;

func GetNumaAwareAssignments 

func GetNumaAwareAssignments(topology *CPUTopology, cset CPUSet) (map[int]CPUSet, error)

GetNumaAwareAssignments returns a mapping from NUMA id to cpu core

func IterateBitMasks added in v0.5.8 

func IterateBitMasks(bits []int, maxBits int, callback func(BitMask))

IterateBitMasks iterates all possible masks from a list of bits, issuing a callback on each mask.

func MaskToUInt64Array added in v0.2.0 

func MaskToUInt64Array(mask BitMask) []uint64

MaskToUInt64Array transforms bit mask to uint slices

func ParseCPUAssignmentFormat added in v0.2.0 

func ParseCPUAssignmentFormat(assignments map[int]CPUSet) map[uint64]string

ParseCPUAssignmentFormat parses the given assignments into string format

func ParseCPUAssignmentQuantityMap added in v0.3.0 

func ParseCPUAssignmentQuantityMap(csetMap map[string]map[int]CPUSet) map[string]map[int]int

ParseCPUAssignmentQuantityMap is used to generate cpu resource counting map based on the given CPUSet map

func SmtActive added in v0.5.16 

func SmtActive() bool

func StringToUint64 added in v0.5.9 

func StringToUint64(s string) uint64

func TransformCPUAssignmentFormat added in v0.2.0 

func TransformCPUAssignmentFormat(assignment map[uint64]string) map[int]CPUSet

TransformCPUAssignmentFormat transforms cpu assignment string format to cpuset format

Types

type AllocatableInterfaceSocketInfo added in v0.5.22 

type AllocatableInterfaceSocketInfo struct {
	// IfIndex2Sockets maps allocatable network interface indexes to
	// the sockets they belong to.
	// Socket2IfIndexes maps sockets to the allocatable network interface indexes
	// they contain.
	IfIndex2Sockets  map[int][]int
	Socket2IfIndexes map[int][]int
}

func GetInterfaceSocketInfo added in v0.5.22 

func GetInterfaceSocketInfo(nics []InterfaceInfo, cpuTopology *CPUTopology) (*AllocatableInterfaceSocketInfo, error)

GetInterfaceSocketInfo assigns network interfaces (NICs) to CPU sockets based on NUMA topology.

It takes a list of available network interfaces (`nics`) and a `cpuTopology` structure. The function attempts to distribute NICs evenly across sockets while considering NUMA affinity.

The resulting mappings are: - `IfIndex2Sockets`: Maps each NIC index to the socket(s) it is assigned to. - `Socket2IfIndexes`: Maps each socket to the NIC indices assigned to it.

The logic follows these steps: 1. If there are no sockets, return an error. 2. Retrieve available sockets from `cpuTopology`. 3. Initialize mappings and track socket usage. 4. Compute an ideal maximum number of NICs per socket to balance the distribution. 5. Assign NICs to sockets based on:

  • NUMA affinity when possible.
  • Least-used socket when NUMA binding is unavailable or overloaded.

6. Populate the mappings and return them.

type BitMask added in v0.5.8 

type BitMask interface {
	Add(bits ...int) error
	Remove(bits ...int) error
	And(masks ...BitMask)
	Or(masks ...BitMask)
	Clear()
	Fill()
	IsEqual(mask BitMask) bool
	IsEmpty() bool
	IsSet(bit int) bool
	AnySet(bits []int) bool
	IsNarrowerThan(mask BitMask) bool
	String() string
	Count() int
	GetBits() []int
}

BitMask interface allows hint providers to create BitMasks for TopologyHints

func And added in v0.5.8 

func And(first BitMask, masks ...BitMask) BitMask

And is a package level implementation of 'and' between first and masks

func NewBitMask added in v0.5.8 

func NewBitMask(bits ...int) (BitMask, error)

NewBitMask creates a new BitMask

func NewEmptyBitMask added in v0.5.8 

func NewEmptyBitMask() BitMask

NewEmptyBitMask creates a new, empty BitMask

func Or added in v0.5.8 

func Or(first BitMask, masks ...BitMask) BitMask

Or is a package level implementation of 'or' between first and masks

type CPUDetails 

type CPUDetails map[int]CPUInfo

CPUDetails is a map from CPU ID to Core ID, Socket ID, and NUMA ID.

func (CPUDetails) CPUs 

func (d CPUDetails) CPUs() CPUSet

CPUs returns all logical CPU IDs in this CPUDetails.

func (CPUDetails) CPUsInCores 

func (d CPUDetails) CPUsInCores(ids ...int) CPUSet

CPUsInCores returns all logical CPU IDs associated with the given core IDs in this CPUDetails.

func (CPUDetails) CPUsInNUMANodes 

func (d CPUDetails) CPUsInNUMANodes(ids ...int) CPUSet

CPUsInNUMANodes returns all logical CPU IDs associated with the given NUMANode IDs in this CPUDetails.

func (CPUDetails) CPUsInSockets 

func (d CPUDetails) CPUsInSockets(ids ...int) CPUSet

CPUsInSockets returns all logical CPU IDs associated with the given socket IDs in this CPUDetails.

func (CPUDetails) Cores 

func (d CPUDetails) Cores() CPUSet

Cores returns all core IDs associated with the CPUs in this CPUDetails.

func (CPUDetails) CoresInNUMANodes 

func (d CPUDetails) CoresInNUMANodes(ids ...int) CPUSet

CoresInNUMANodes returns all core IDs associated with the given NUMANode IDs in this CPUDetails.

func (CPUDetails) CoresInSockets 

func (d CPUDetails) CoresInSockets(ids ...int) CPUSet

CoresInSockets returns all core IDs associated with the given socket IDs in this CPUDetails.

func (CPUDetails) KeepOnly 

func (d CPUDetails) KeepOnly(cpus CPUSet) CPUDetails

KeepOnly returns a new CPUDetails object with only the supplied cpus.

func (CPUDetails) NUMANodes 

func (d CPUDetails) NUMANodes() CPUSet

NUMANodes returns all NUMANode IDs associated with the CPUs in this CPUDetails.

func (CPUDetails) NUMANodesInSockets 

func (d CPUDetails) NUMANodesInSockets(ids ...int) CPUSet

NUMANodesInSockets returns all logical NUMANode IDs associated with the given socket IDs in this CPUDetails.

func (CPUDetails) Sockets 

func (d CPUDetails) Sockets() CPUSet

Sockets returns all socket IDs associated with the CPUs in this CPUDetails.

func (CPUDetails) SocketsInNUMANodes 

func (d CPUDetails) SocketsInNUMANodes(ids ...int) CPUSet

SocketsInNUMANodes returns all logical Socket IDs associated with the given NUMANode IDs in this CPUDetails.

type CPUInfo 

type CPUInfo struct {
	NUMANodeID int
	SocketID   int
	CoreID     int
}

CPUInfo contains the NUMA, socket, and core IDs associated with a CPU.

type CPUSet 

type CPUSet struct {
	// nil elems and empty elems both will be unmarshal to
	// empty elems, so we must use Initialed property to identify them
	Initialed bool
	// contains filtered or unexported fields
}

func GetCPUAssignmentNUMAs added in v0.3.0 

func GetCPUAssignmentNUMAs(assignment map[int]CPUSet) CPUSet

GetCPUAssignmentNUMAs returns memset for cpuset

func GetNICAllocateNUMAs added in v0.5.22 

func GetNICAllocateNUMAs(nic InterfaceInfo, info *KatalystMachineInfo) (CPUSet, error)

GetNICAllocateNUMAs returns numa nodes that are allocated to the given nic

func MustParse 

func MustParse(s string) CPUSet

MustParse CPUSet constructs a new CPU set from a Linux CPU list formatted string. Unlike Parse, it does not return an error but rather panics if the input cannot be used to construct a CPU set.

func NewCPUSet 

func NewCPUSet(cpus ...int) CPUSet

func NewCPUSetUint64 added in v0.2.0 

func NewCPUSetUint64(cpus ...uint64) (CPUSet, error)

func Parse 

func Parse(s string) (CPUSet, error)

Parse CPUSet constructs a new CPU set from a Linux CPU list formatted string.

See: http://man7.org/linux/man-pages/man7/cpuset.7.html#FORMATS

func (CPUSet) Add 

func (s CPUSet) Add(elems ...int)

Add adds the supplied elements to the result.

func (CPUSet) AddUint64 added in v0.2.0 

func (s CPUSet) AddUint64(elems ...uint64) error

AddUint64 adds the supplied uint64 elements to the result.

func (CPUSet) Clone 

func (s CPUSet) Clone() CPUSet

func (CPUSet) Contains 

func (s CPUSet) Contains(cpu int) bool

Contains returns true if the supplied element is present in this set.

func (CPUSet) Difference 

func (s CPUSet) Difference(s2 CPUSet) CPUSet

Difference returns a new CPU set that contains all of the elements that are present in this set and not the supplied set, without mutating either source set.

func (CPUSet) Equals 

func (s CPUSet) Equals(s2 CPUSet) bool

Equals returns true if the supplied set contains exactly the same elements as this set (s IsSubsetOf s2 and s2 IsSubsetOf s).

func (CPUSet) Filter 

func (s CPUSet) Filter(predicate func(int) bool) CPUSet

Filter returns a new CPU set that contains all elements from this set that match the supplied predicate, without mutating the source set.

func (CPUSet) FilterNot 

func (s CPUSet) FilterNot(predicate func(int) bool) CPUSet

FilterNot returns a new CPU set that contains all elements from this set that do not match the supplied predicate, without mutating the source set.

func (CPUSet) Intersection 

func (s CPUSet) Intersection(s2 CPUSet) CPUSet

Intersection returns a new CPU set that contains all of the elements that are present in both this set and the supplied set, without mutating either source set.

func (CPUSet) IsEmpty 

func (s CPUSet) IsEmpty() bool

IsEmpty returns true if there are zero elements in this set.

func (CPUSet) IsSubsetOf 

func (s CPUSet) IsSubsetOf(s2 CPUSet) bool

IsSubsetOf returns true if the supplied set contains all the elements

func (CPUSet) MarshalJSON 

func (s CPUSet) MarshalJSON() ([]byte, error)

func (CPUSet) Size 

func (s CPUSet) Size() int

Size returns the number of elements in this set.

func (CPUSet) String 

func (s CPUSet) String() string

String returns a new string representation of the elements in this CPU set in canonical linux CPU list format.

See: http://man7.org/linux/man-pages/man7/cpuset.7.html#FORMATS

func (CPUSet) ToSliceInt 

func (s CPUSet) ToSliceInt() []int

ToSliceInt returns an ordered slice of int that contains all elements from this set

func (CPUSet) ToSliceInt64 

func (s CPUSet) ToSliceInt64() []int64

ToSliceInt64 returns an ordered slice of int64 that contains all elements from this set

func (CPUSet) ToSliceIntReversely added in v0.5.5 

func (s CPUSet) ToSliceIntReversely() []int

ToSliceInt returns an resersely ordered slice of int that contains all elements from this set

func (CPUSet) ToSliceNoSortInt 

func (s CPUSet) ToSliceNoSortInt() []int

ToSliceNoSortInt returns an ordered slice of int that contains all elements from this set

func (CPUSet) ToSliceNoSortInt64 

func (s CPUSet) ToSliceNoSortInt64() []int64

ToSliceNoSortInt64 returns an ordered slice of int64 that contains all elements from this set

func (CPUSet) ToSliceNoSortUInt64 

func (s CPUSet) ToSliceNoSortUInt64() []uint64

ToSliceNoSortUInt64 returns an ordered slice of uint64 that contains all elements from this set

func (CPUSet) ToSliceUInt64 

func (s CPUSet) ToSliceUInt64() []uint64

ToSliceUInt64 returns an ordered slice of uint64 that contains all elements from this set

func (CPUSet) Union 

func (s CPUSet) Union(s2 CPUSet) CPUSet

Union returns a new CPU set that contains all elements from this set and all elements from the supplied set, without mutating either source set.

func (CPUSet) UnionAll 

func (s CPUSet) UnionAll(s2 []CPUSet) CPUSet

UnionAll returns a new CPU set that contains all elements from this set and all elements from the supplied sets, without mutating either source set.

func (*CPUSet) UnmarshalJSON 

func (s *CPUSet) UnmarshalJSON(b []byte) error

type CPUTopology 

type CPUTopology struct {
	NumCPUs              int
	NumCores             int
	NumSockets           int
	NumNUMANodes         int
	NUMANodeIDToSocketID map[int]int
	NUMAToCPUs           NUMANodeInfo
	CPUDetails           CPUDetails
}

CPUTopology contains details of node cpu, where : CPU - logical CPU, cadvisor - thread Core - physical CPU, cadvisor - Core Socket - socket, cadvisor - Socket NUMA Node - NUMA cell, cadvisor - Node

func GenerateDummyCPUTopology 

func GenerateDummyCPUTopology(cpuNum, socketNum, numaNum int) (*CPUTopology, error)

func (*CPUTopology) CPUsPerCore 

func (topo *CPUTopology) CPUsPerCore() int

CPUsPerCore returns the number of logical CPUs associated with each core.

func (*CPUTopology) CPUsPerSocket 

func (topo *CPUTopology) CPUsPerSocket() int

CPUsPerSocket returns the number of logical CPUs associated with each socket.

func (*CPUTopology) GetSocketTopology 

func (topo *CPUTopology) GetSocketTopology() map[int]string

GetSocketTopology parses the given CPUTopology to a mapping from socket id to cpu id lists

func (*CPUTopology) NUMAsPerSocket 

func (topo *CPUTopology) NUMAsPerSocket() (int, error)

NUMAsPerSocket returns the the number of NUMA are associated with each socket.

type ExtraCPUInfo 

type ExtraCPUInfo struct {
	// SupportInstructionSet instructions all cpus support.
	SupportInstructionSet sets.String
}

func GetExtraCPUInfo 

func GetExtraCPUInfo() (*ExtraCPUInfo, error)

GetExtraCPUInfo get extend cpu info from proc system

type ExtraNetworkInfo 

type ExtraNetworkInfo struct {
	// Interface info list of all network interface.
	Interface []InterfaceInfo
}

func GetExtraNetworkInfo 

func GetExtraNetworkInfo(conf *global.MachineInfoConfiguration) (*ExtraNetworkInfo, error)

GetExtraNetworkInfo collects network interface information from /sys/class/net and net.Interfaces. When multiple network namespaces are enabled, it executes in each namespace to gather NIC information. Returns ExtraNetworkInfo containing all discovered network interfaces and their attributes.

func (ExtraNetworkInfo) GetAllocatableNICs added in v0.5.22 

func (e ExtraNetworkInfo) GetAllocatableNICs(conf *global.MachineInfoConfiguration) []InterfaceInfo

type ExtraTopologyInfo added in v0.4.1 

type ExtraTopologyInfo struct {
	NumaDistanceMap map[int][]NumaDistanceInfo
	*SiblingNumaInfo
	*AllocatableInterfaceSocketInfo
}

func GenerateDummyExtraTopology added in v0.4.1 

func GenerateDummyExtraTopology(numaNum int) (*ExtraTopologyInfo, error)

func GetExtraTopologyInfo added in v0.4.1 

func GetExtraTopologyInfo(conf *global.MachineInfoConfiguration, cpuTopology *CPUTopology, extraNetworkInfo *ExtraNetworkInfo) (*ExtraTopologyInfo, error)

type IfaceAddr 

type IfaceAddr struct {
	IPV4 []*net.IP
	IPV6 []*net.IP
}

func GetInterfaceAddr added in v0.5.22 

func GetInterfaceAddr(iface net.Interface) (*IfaceAddr, error)

func (*IfaceAddr) GetNICIPs added in v0.5.22 

func (addr *IfaceAddr) GetNICIPs(ipVersion int) []string

type InterfaceInfo 

type InterfaceInfo struct {
	// Iface name of this interface.
	Iface string
	// IfIndex is an index of network interface.
	IfIndex int
	// Speed of this interface.
	Speed int
	// NumaNode numa node of this interface belongs to.
	NumaNode int
	// Enable whether enable this interface.
	Enable bool
	// Addr address of this interface, which includes ipv4 and ipv6.
	Addr *IfaceAddr

	// NSName indicates the namespace for this interface
	NSName string
	// NSAbsolutePath indicates the namespace path for this interface
	NSAbsolutePath string
}

type KatalystMachineInfo 

type KatalystMachineInfo struct {
	*info.MachineInfo

	// actually, CPUTopology can be generated by info.MachineInfo,
	// but we still keep it since it construct topology info in a
	// more convenient way
	*CPUTopology

	*MemoryTopology

	// ExtraCPUInfo is extra cpu info not in MachineInfo, such as
	// supported instructions
	*ExtraCPUInfo

	// ExtraNetworkInfo is extra network info not in MachineInfo,
	// such as numa node of each interface
	*ExtraNetworkInfo

	// ExtraTopologyInfo is extra topology info not in MachineInfo,
	// such as numa node distance between each other
	*ExtraTopologyInfo
}

KatalystMachineInfo is a combination of machine info generated by cadvisor, along with the extra info customized in katalyst environment

func GetKatalystMachineInfo 

func GetKatalystMachineInfo(conf *global.MachineInfoConfiguration) (*KatalystMachineInfo, error)

GetKatalystMachineInfo returns KatalystMachineInfo by collecting machine info actually, this function should be only called in initial processes

type MemoryDetails added in v0.3.0 

type MemoryDetails map[int]uint64

func (MemoryDetails) Clone added in v0.4.0 

func (d MemoryDetails) Clone() MemoryDetails

Clone creates a new MemoryDetails instance with the same content.

func (MemoryDetails) Equal added in v0.4.0 

func (d MemoryDetails) Equal(want MemoryDetails) bool

Equal returns true if the MemoryDetails map is equal to the supplied MemoryDetails

func (MemoryDetails) FillNUMANodesWithZero added in v0.4.0 

func (d MemoryDetails) FillNUMANodesWithZero(allNUMAs CPUSet) MemoryDetails

FillNUMANodesWithZero takes a CPUSet containing NUMA node IDs and ensures that each ID is present in MemoryDetails. If a NUMA node ID from the CPUSet is not present in the MemoryDetails map, it is added with a value of 0. The method returns an updated MemoryDetails map with these changes.

type MemoryTopology added in v0.3.0 

type MemoryTopology struct {
	MemoryDetails MemoryDetails
}

func GenerateDummyMemoryTopology added in v0.3.0 

func GenerateDummyMemoryTopology(numaNum int, memoryCapacity uint64) (*MemoryTopology, error)

type NUMANodeInfo 

type NUMANodeInfo map[int]CPUSet

NUMANodeInfo is a map from NUMANode ID to a list of CPU IDs associated with that NUMANode.

func (NUMANodeInfo) CPUSizeInNUMAs added in v0.5.27 

func (i NUMANodeInfo) CPUSizeInNUMAs(nodes ...int) int

CPUSizeInNUMAs returns the number of logical CPUs associated with each numa nodes.

type NormalZoneInfo added in v0.5.9 

type NormalZoneInfo struct {
	Node         int64
	Free         uint64
	Min          uint64
	Low          uint64
	FileInactive uint64
}

func GetNormalZoneInfo added in v0.5.9 

func GetNormalZoneInfo(zoneInfoPath string) []NormalZoneInfo

type NumaDistanceInfo added in v0.4.1 

type NumaDistanceInfo struct {
	NumaID   int
	Distance int
}

type SiblingNumaInfo added in v0.5.1 

type SiblingNumaInfo struct {
	SiblingNumaMap map[int]sets.Int

	// SiblingNumaAvgMBWAllocatableMap maps NUMA IDs to the allocatable memory bandwidth,
	// averaged across each NUMA node and its siblings.
	// SiblingNumaAvgMBWCapacityMap maps NUMA IDs to the capacity memory bandwidth,
	// averaged similarly.
	SiblingNumaAvgMBWAllocatableMap map[int]int64
	SiblingNumaAvgMBWCapacityMap    map[int]int64
}

func GetSiblingNumaInfo added in v0.5.1 

func GetSiblingNumaInfo(
	conf *global.MachineInfoConfiguration,
	numaDistanceMap map[int][]NumaDistanceInfo,
) *SiblingNumaInfo

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.