hwinfo

Documentation

Overview

Package hwinfo gathers hardware information.

Index

• type CoreInfo
• type Cores
  • func (cores Cores) ByID() (m map[int]CoreInfo)
  • func (cores Cores) ByNumaSocket() (m map[int]Cores)
  • func (cores Cores) ListPrimary() []int
  • func (cores Cores) ListSecondary() []int
  • func (cores Cores) MaxNumaSocket() int
• type Provider

Types

type CoreInfo

type CoreInfo struct {
	ID          int // logical core ID
	NumaSocket  int // NUMA socket number
	PhysicalKey int // physical core key, same value for hyper-threads on a physical core
}

CoreInfo describes a logical CPU core.

type Cores

type Cores []CoreInfo

Cores contains information about CPU cores.

func (Cores) ByID

func (cores Cores) ByID() (m map[int]CoreInfo)

ByID converts to map[ID]CoreInfo.

func (Cores) ByNumaSocket

func (cores Cores) ByNumaSocket() (m map[int]Cores)

ByNumaSocket classifies cores as map[NumaSocket]Cores.

func (Cores) ListPrimary

func (cores Cores) ListPrimary() []int

ListPrimary returns a list of logical cores that are the first logical core in each physical core.

func (Cores) ListSecondary

func (cores Cores) ListSecondary() []int

ListSecondary returns a list of logical cores that are not in ListPrimary().

func (Cores) MaxNumaSocket

func (cores Cores) MaxNumaSocket() int

MaxNumaSocket determines the maximum NUMA socket.

type Provider

type Provider interface {
	// Cores provides information about CPU cores.
	Cores() Cores
}

Provider provides information about hardware.

var Default Provider = &procinfoProvider{}

Default is the default Provider implementation.