Class BsdCentralProcessor

java.lang.Object

oshi.hardware.common.AbstractCentralProcessor

oshi.hardware.common.platform.unix.BsdCentralProcessor

All Implemented Interfaces:

CentralProcessor

Direct Known Subclasses:

NetBsdCentralProcessor, OpenBsdCentralProcessor

public abstract class BsdCentralProcessor
extends AbstractCentralProcessor

Shared CentralProcessor logic for the dmesg-parsing BSDs (OpenBSD and NetBSD). Both enumerate processors, caches, and feature flags from dmesg output and read counters from vmstat; the platform-specific sysctl backend and the vmstat parsing are supplied by the subclasses.

Nested Class Summary

Nested classes/interfaces inherited from interface CentralProcessor

CentralProcessor.LogicalProcessor, CentralProcessor.PhysicalProcessor, CentralProcessor.ProcessorCache, CentralProcessor.ProcessorIdentifier, CentralProcessor.TickType

Modifier and Type	Interface	Description
static class	CentralProcessor.LogicalProcessor	A class representing a Logical Processor and its replationship to physical processors, physical packages, and logical groupings such as NUMA Nodes and Processor groups, useful for identifying processor topology.
static class	CentralProcessor.PhysicalProcessor	A class representing a Physical Processor (a core) providing per-core statistics that may vary, particularly in hybrid/modular processors.
static class	CentralProcessor.ProcessorCache	A class representing CPU Cache Memory.
static final class	CentralProcessor.ProcessorIdentifier	A class encapsulating ghe CPU's identifier strings ,including name, vendor, stepping, model, and family information (also called the signature of a CPU)
static enum	CentralProcessor.TickType	Index of CPU tick counters in the CentralProcessor.getSystemCpuLoadTicks() and CentralProcessor.getProcessorCpuLoadTicks() arrays.

Constructor Summary

Constructors

Constructor	Description
BsdCentralProcessor()

Method Summary

Modifier and Type	Method	Description
protected Quartet<List<CentralProcessor.LogicalProcessor>, List<CentralProcessor.PhysicalProcessor>, List<CentralProcessor.ProcessorCache>, List<String>>	initProcessorCounts()	Initializes logical and physical processor lists and feature flags.
protected long	queryContextSwitches()	Get number of context switches
protected long	queryInterrupts()	Get number of interrupts
protected abstract Pair<Long,Long>	queryVmStats()	Reads the number of context switches and interrupts from vmstat.
protected abstract int	sysctl(String name, int def)	Reads an integer sysctl value by name.

Methods inherited from class AbstractCentralProcessor

createProcessorID, createProcessorID, createProcListFromDmesg, getContextSwitches, getCurrentFreq, getFeatureFlags, getInterrupts, getLogicalProcessorCount, getLogicalProcessors, getMaxFreq, getPhysicalPackageCount, getPhysicalProcessorCount, getPhysicalProcessors, getProcessorCaches, getProcessorCpuLoadBetweenTicks, getProcessorCpuLoadBetweenTicks, getProcessorCpuLoadTicks, getProcessorIdentifier, getSystemCpuLoadBetweenTicks, getSystemCpuLoadBetweenTicks, getSystemCpuLoadTicks, orderedProcCaches, queryCurrentFreq, queryMaxFreq, queryProcessorCpuLoadTicks, queryProcessorId, querySystemCpuLoadTicks, toString

Modifier and Type	Method	Description
protected static String	createProcessorID(String stepping, String model, String family, String[] flags)	Creates a Processor ID by encoding the stepping, model, family, and feature flags.
protected static String	createProcessorID(String stepping, String model, String family, String[] flags, long hwcap)	Creates a Processor ID by encoding the stepping, model, family, and feature flags.
protected List<CentralProcessor.PhysicalProcessor>	createProcListFromDmesg(List<CentralProcessor.LogicalProcessor> logProcs, Map<Integer,String> dmesg)	Creates a list of physical processors from dmesg output.
long	getContextSwitches()	Get the number of system-wide context switches which have occurred.
long[]	getCurrentFreq()	Attempts to return the current frequency (in Hz), of the logical processors on this CPU.
List<String>	getFeatureFlags()	Returns a list of platform-specific strings which identify CPU Feature Flags.
long	getInterrupts()	Get the number of system-wide interrupts which have occurred.
int	getLogicalProcessorCount()	Get the number of logical CPUs available for processing.
List<CentralProcessor.LogicalProcessor>	getLogicalProcessors()	Returns an UnmodifiableList of the CPU's logical processors.
long	getMaxFreq()	Maximum frequeny (in Hz), of the logical processors on this CPU.
int	getPhysicalPackageCount()	Get the number of packages/sockets in the system.
int	getPhysicalProcessorCount()	Get the number of physical CPUs/cores available for processing.
List<CentralProcessor.PhysicalProcessor>	getPhysicalProcessors()	Returns an UnmodifiableList of the CPU's physical processors.
List<CentralProcessor.ProcessorCache>	getProcessorCaches()	Makes a best-effort attempt to identify the CPU's processor caches.
double[]	getProcessorCpuLoadBetweenTicks(long[][] oldTicks)	Returns the "recent cpu usage" for all logical processors by counting ticks from CentralProcessor.getProcessorCpuLoadTicks() between the user-provided value from a previous call.
double[]	getProcessorCpuLoadBetweenTicks(long[][] oldTicks, long[][] ticks)	Returns the "recent cpu usage" for all logical processors by counting ticks from CentralProcessor.getProcessorCpuLoadTicks() between the user-provided value from a previous call.
long[][]	getProcessorCpuLoadTicks()	Get Processor CPU Load tick counters.
CentralProcessor.ProcessorIdentifier	getProcessorIdentifier()	The CPU's identifier strings ,including name, vendor, stepping, model, and family information (also called the signature of a CPU).
double	getSystemCpuLoadBetweenTicks(long[] oldTicks)	Returns the "recent cpu usage" for the whole system by counting ticks from CentralProcessor.getSystemCpuLoadTicks() between the user-provided value from a previous call.
double	getSystemCpuLoadBetweenTicks(long[] oldTicks, long[] ticks)	Returns the "recent cpu usage" for the whole system by counting ticks between two user-provided values, retrieved from CentralProcessor.getSystemCpuLoadTicks() at different points in time.
long[]	getSystemCpuLoadTicks()	Get System-wide CPU Load tick counters.
static List<CentralProcessor.ProcessorCache>	orderedProcCaches(Set<CentralProcessor.ProcessorCache> caches)	Filters a set of processor caches to an ordered list
protected abstract long[]	queryCurrentFreq()	Get processor current frequency.
protected long	queryMaxFreq()	Get processor max frequency.
protected abstract long[][]	queryProcessorCpuLoadTicks()	Get the processor CPU load ticks
protected abstract CentralProcessor.ProcessorIdentifier	queryProcessorId()	Updates logical and physical processor counts and arrays
protected abstract long[]	querySystemCpuLoadTicks()	Get the system CPU load ticks
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface CentralProcessor

getProcessorCpuLoad, getSystemCpuLoad, getSystemLoadAverage

Modifier and Type	Method	Description
default double[]	getProcessorCpuLoad(long delay)	This is a convenience method which collects an initial set of ticks using CentralProcessor.getProcessorCpuLoadTicks() and passes that result to CentralProcessor.getProcessorCpuLoadBetweenTicks(long[][]) after the specified delay.
default double	getSystemCpuLoad(long delay)	This is a convenience method which collects an initial set of ticks using CentralProcessor.getSystemCpuLoadTicks() and passes that result to CentralProcessor.getSystemCpuLoadBetweenTicks(long[]) after the specified delay.
double[]	getSystemLoadAverage(int nelem)	Returns the system load average for the number of elements specified, up to 3, representing 1, 5, and 15 minutes.

Constructor Details

BsdCentralProcessor

public BsdCentralProcessor()

Method Details

sysctl

protected abstract int sysctl(String name,
 int def)

Reads an integer sysctl value by name.

Parameters:

name - the sysctl name

def - the default value

Returns:

the sysctl integer value or the default

queryVmStats

protected abstract Pair<Long,Long> queryVmStats()

Reads the number of context switches and interrupts from vmstat. The label text and parsing differ between OpenBSD and NetBSD, so each subclass supplies its own implementation.

Returns:

a Pair of (context switches, interrupts)

initProcessorCounts

protected Quartet<List<CentralProcessor.LogicalProcessor>, List<CentralProcessor.PhysicalProcessor>, List<CentralProcessor.ProcessorCache>, List<String>> initProcessorCounts()

Description copied from class: AbstractCentralProcessor

Initializes logical and physical processor lists and feature flags.

Specified by:

initProcessorCounts in class AbstractCentralProcessor

Returns:

Lists of initialized Logical Processors, Physical Processors, Processor Caches, and Feature Flags.

queryContextSwitches

protected long queryContextSwitches()

Get number of context switches

Specified by:

queryContextSwitches in class AbstractCentralProcessor

Returns:

The context switches

queryInterrupts

protected long queryInterrupts()

Get number of interrupts

Specified by:

queryInterrupts in class AbstractCentralProcessor

Returns:

The interrupts