Class MacCentralProcessor

java.lang.Object

oshi.hardware.common.AbstractCentralProcessor

oshi.hardware.common.platform.mac.MacCentralProcessor

All Implemented Interfaces:

CentralProcessor

@ThreadSafe
public abstract class MacCentralProcessor
extends AbstractCentralProcessor

Base class for macOS CentralProcessor implementations. Subclasses provide platform-specific sysctl, IOKit, and Mach kernel calls.

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.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	ARM_CPUTYPE	ARM CPU type constant.
protected static final long	DEFAULT_FREQUENCY	Default frequency in Hz.
protected static final int	M1_CPUFAMILY	M1 CPU family constant.
protected static final int	M2_CPUFAMILY	M2 CPU family constant.
protected static final int	M3_CPUFAMILY	M3 CPU family constant.
protected static final int	M3_PRO_CPUFAMILY	M3 Pro/Max CPU family constant.
protected static final int	M4_CPUFAMILY	M4 CPU family constant.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MacCentralProcessor()	Default constructor.

Method Summary

Modifier and Type	Method	Description
protected void	calculateNominalFrequencies()	Calculates nominal frequencies for performance and efficiency cores.
protected long	getEfficiencyCoreFrequency()	Gets the efficiency core frequency.
protected long	getMaxFreqFromByteArray(byte[] data)	Extracts the maximum frequency from a byte array property.
protected long	getPerformanceCoreFrequency()	Gets the performance core frequency.
protected Quartet<List<CentralProcessor.LogicalProcessor>, List<CentralProcessor.PhysicalProcessor>, List<CentralProcessor.ProcessorCache>, List<String>>	initProcessorCounts()	Initializes logical and physical processor lists and feature flags.
protected abstract IOKitProvider	ioKitProvider()	Returns the IOKit provider for this implementation.
protected boolean	isArm()	Checks if this is an ARM CPU.
protected String	platformExpert()	Queries the platform expert vendor string.
protected Map<Integer,String>	queryCompatibleStrings()	Queries compatible strings for CPU identification.
long	queryContextSwitches()	Get number of context switches
long[]	queryCurrentFreq()	Get processor current frequency.
long	queryInterrupts()	Get number of interrupts
long	queryMaxFreq()	Get processor max frequency.
protected CentralProcessor.ProcessorIdentifier	queryProcessorId()	Updates logical and physical processor counts and arrays
protected void	setEfficiencyCoreFrequency(long freq)	Sets the efficiency core frequency.
protected void	setPerformanceCoreFrequency(long freq)	Sets the performance core frequency.
protected int	sysctlInt(String name, int defaultValue)	Queries a sysctl integer value.
protected int	sysctlIntNoWarn(String name, int defaultValue)	Queries a sysctl integer value without logging warnings.
protected long	sysctlLong(String name, long defaultValue)	Queries a sysctl long value.
protected abstract SysctlProvider	sysctlProvider()	Returns the sysctl provider for this implementation.
protected String	sysctlString(String name, String defaultValue)	Queries a sysctl string value.
protected String	sysctlStringNoWarn(String name, String defaultValue)	Queries a sysctl string value without logging warnings.

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, queryProcessorCpuLoadTicks, 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[][]	queryProcessorCpuLoadTicks()	Get the processor CPU load ticks
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.

Field Details

ARM_CPUTYPE

protected static final int ARM_CPUTYPE

ARM CPU type constant.

See Also:

• Constant Field Values

M1_CPUFAMILY

protected static final int M1_CPUFAMILY

M1 CPU family constant.

See Also:

• Constant Field Values

M2_CPUFAMILY

protected static final int M2_CPUFAMILY

M2 CPU family constant.

See Also:

• Constant Field Values

M3_CPUFAMILY

protected static final int M3_CPUFAMILY

M3 CPU family constant.

See Also:

• Constant Field Values

M3_PRO_CPUFAMILY

protected static final int M3_PRO_CPUFAMILY

M3 Pro/Max CPU family constant.

See Also:

• Constant Field Values

M4_CPUFAMILY

protected static final int M4_CPUFAMILY

M4 CPU family constant.

See Also:

• Constant Field Values

DEFAULT_FREQUENCY

protected static final long DEFAULT_FREQUENCY

Default frequency in Hz.

See Also:

• Constant Field Values

Constructor Details

MacCentralProcessor

protected MacCentralProcessor()

Default constructor.

Method Details

sysctlProvider

protected abstract SysctlProvider sysctlProvider()

Returns the sysctl provider for this implementation.

Returns:

the sysctl provider

sysctlInt

protected int sysctlInt(String name,
 int defaultValue)

Queries a sysctl integer value.

Parameters:

name - the sysctl name

defaultValue - the default value if not found

Returns:

the sysctl value

sysctlIntNoWarn

protected int sysctlIntNoWarn(String name,
 int defaultValue)

Queries a sysctl integer value without logging warnings.

Parameters:

name - the sysctl name

defaultValue - the default value if not found

Returns:

the sysctl value

sysctlLong

protected long sysctlLong(String name,
 long defaultValue)

Queries a sysctl long value.

Parameters:

name - the sysctl name

defaultValue - the default value if not found

Returns:

the sysctl value

sysctlString

protected String sysctlString(String name,
 String defaultValue)

Queries a sysctl string value.

Parameters:

name - the sysctl name

defaultValue - the default value if not found

Returns:

the sysctl value

sysctlStringNoWarn

protected String sysctlStringNoWarn(String name,
 String defaultValue)

Queries a sysctl string value without logging warnings.

Parameters:

name - the sysctl name

defaultValue - the default value if not found

Returns:

the sysctl value

ioKitProvider

protected abstract IOKitProvider ioKitProvider()

Returns the IOKit provider for this implementation.

Returns:

the IOKit provider

platformExpert

protected String platformExpert()

Queries the platform expert vendor string.

Returns:

the vendor string

queryCompatibleStrings

protected Map<Integer,String> queryCompatibleStrings()

Queries compatible strings for CPU identification.

Returns:

a map of physical processor numbers to compatible strings

calculateNominalFrequencies

protected void calculateNominalFrequencies()

Calculates nominal frequencies for performance and efficiency cores.

getPerformanceCoreFrequency

protected long getPerformanceCoreFrequency()

Gets the performance core frequency.

Returns:

the performance core frequency in Hz

setPerformanceCoreFrequency

protected void setPerformanceCoreFrequency(long freq)

Sets the performance core frequency.

Parameters:

freq - the frequency in Hz

getEfficiencyCoreFrequency

protected long getEfficiencyCoreFrequency()

Gets the efficiency core frequency.

Returns:

the efficiency core frequency in Hz

setEfficiencyCoreFrequency

protected void setEfficiencyCoreFrequency(long freq)

Sets the efficiency core frequency.

Parameters:

freq - the frequency in Hz

isArm

protected boolean isArm()

Checks if this is an ARM CPU.

Returns:

true if ARM

queryProcessorId

protected CentralProcessor.ProcessorIdentifier queryProcessorId()

Description copied from class: AbstractCentralProcessor

Updates logical and physical processor counts and arrays

Specified by:

queryProcessorId in class AbstractCentralProcessor

Returns:

An array of initialized Logical Processors

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.

queryCurrentFreq

public long[] queryCurrentFreq()

Description copied from class: AbstractCentralProcessor

Get processor current frequency.

Specified by:

queryCurrentFreq in class AbstractCentralProcessor

Returns:

The current frequency.

queryMaxFreq

public long queryMaxFreq()

Description copied from class: AbstractCentralProcessor

Get processor max frequency.

Overrides:

queryMaxFreq in class AbstractCentralProcessor

Returns:

The max frequency.

queryContextSwitches

public long queryContextSwitches()

Description copied from class: AbstractCentralProcessor

Get number of context switches

Specified by:

queryContextSwitches in class AbstractCentralProcessor

Returns:

The context switches

queryInterrupts

public long queryInterrupts()

Description copied from class: AbstractCentralProcessor

Get number of interrupts

Specified by:

queryInterrupts in class AbstractCentralProcessor

Returns:

The interrupts

getMaxFreqFromByteArray

protected long getMaxFreqFromByteArray(byte[] data)

Extracts the maximum frequency from a byte array property.

Parameters:

data - the byte array from IOKit

Returns:

the frequency in Hz, or DEFAULT_FREQUENCY if unavailable