cpuallocator

Documentation

Index

• type AllocFlag
• type CPUAllocator
  • func NewCPUAllocator(sys sysfs.System) CPUAllocator
• type CPUPriority
  • func (p CPUPriority) Option() Option
  • func (p CPUPriority) String() string
• type IDFilter
• type IDSorter
• type Option
  • func WithAllocFlags(flags AllocFlag) Option
  • func WithPriority(p CPUPriority) Option

Types

type AllocFlag

type AllocFlag uint

AllocFlag represents CPU allocation preferences.

const (
	// AllocIdlePackages requests allocation of full idle packages.
	AllocIdlePackages AllocFlag = 1 << iota
	// AllocIdleClusters requests allocation of full idle CPU clusters.
	AllocIdleClusters
	// AllocCacheGroups requests allocation and splitting of idle and used cache groups
	AllocCacheGroups
	// AllocIdleCores requests allocation of full idle cores (all threads in core).
	AllocIdleCores

	// AllocDefault is the default allocation preferences.
	AllocDefault = AllocIdlePackages | AllocIdleClusters | AllocCacheGroups | AllocIdleCores
)

type CPUAllocator

type CPUAllocator interface {
	AllocateCpus(from *cpuset.CPUSet, cnt int, options ...Option) (cpuset.CPUSet, error)
	ReleaseCpus(from *cpuset.CPUSet, cnt int, options ...Option) (cpuset.CPUSet, error)
	GetCPUPriorities() map[CPUPriority]cpuset.CPUSet
}

CPUAllocator is an interface for a generic CPU allocator

func NewCPUAllocator

func NewCPUAllocator(sys sysfs.System) CPUAllocator

NewCPUAllocator return a new cpuAllocator instance

type CPUPriority

type CPUPriority int

const (
	PriorityHigh CPUPriority = iota
	PriorityNormal
	PriorityLow
	NumCPUPriorities
	PriorityNone = NumCPUPriorities
)

func (CPUPriority) Option

func (p CPUPriority) Option() Option

func (CPUPriority) String

func (p CPUPriority) String() string

type IDFilter

type IDFilter func(idset.ID) bool

IDFilter helps filtering Ids.

type IDSorter

type IDSorter func(int, int) bool

IDSorter helps sorting Ids.

type Option

type Option func(*allocatorHelper) error

Option is an option for a CPU allocation or release.

func WithAllocFlags

func WithAllocFlags(flags AllocFlag) Option

WithAllocFlags sets the allocation flags for the allocation.

func WithPriority

func WithPriority(p CPUPriority) Option

WithPriority sets the preferred CPU priority for the allocation.