platform

Documentation

Overview

Package platform provides OS-level helpers for CPU pinning and NUMA distribution.

Index

• func BindNumaNode(node int) error
• func CPUForNode(cpu int) int
• func DistributeWorkers(numWorkers, numCPU, numaNodes int) []int
• func PinToCPU(cpu int) error
• func ResetNumaPolicy() error
• type NUMATopology
  • func DetectNUMA() NUMATopology

Functions

func BindNumaNode

func BindNumaNode(node int) error

BindNumaNode sets the calling thread's memory allocation policy to MPOL_BIND for the given NUMA node. All subsequent mmap allocations will be satisfied from that node's memory. Returns an error if the syscall fails; the caller should treat failure as non-fatal (allocations will use default policy).

func CPUForNode

func CPUForNode(cpu int) int

CPUForNode returns the NUMA node that the given CPU belongs to. Returns 0 if the node cannot be determined (safe default).

func DistributeWorkers

func DistributeWorkers(numWorkers, numCPU, numaNodes int) []int

DistributeWorkers returns CPU IDs for numWorkers distributed across NUMA nodes. On multi-socket systems, workers are interleaved across sockets so that each socket handles roughly equal traffic. Falls back to sequential round-robin when NUMA topology is unavailable.

func PinToCPU

func PinToCPU(cpu int) error

PinToCPU pins the calling OS thread to the given CPU core via sched_setaffinity.

func ResetNumaPolicy

func ResetNumaPolicy() error

ResetNumaPolicy restores the default (local) memory allocation policy.

Types

type NUMATopology

type NUMATopology struct {
	NumNodes int
	NodeCPUs [][]int
}

NUMATopology holds detected NUMA topology information.

func DetectNUMA

func DetectNUMA() NUMATopology

DetectNUMA probes the system's NUMA topology via sysfs. Returns NumNodes=1 if NUMA info is unavailable.