oshi.hardware.common

Class AbstractCentralProcessor

java.lang.Object

oshi.hardware.common.AbstractCentralProcessor

All Implemented Interfaces:

Serializable, CentralProcessor

Direct Known Subclasses:

FreeBsdCentralProcessor, LinuxCentralProcessor, MacCentralProcessor, SolarisCentralProcessor, WindowsCentralProcessor

public abstract class AbstractCentralProcessor
extends Object
implements CentralProcessor

A CPU as defined in Linux /proc.

Author:

alessandro[at]perucchi[dot]org, alessio.fachechi[at]gmail[dot]com, widdis[at]gmail[dot]com

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface oshi.hardware.CentralProcessor

CentralProcessor.TickType

Field Summary

Fields

Modifier and Type	Field and Description
protected int	logicalProcessorCount
protected int	physicalPackageCount
protected int	physicalProcessorCount

Constructor Summary

Constructors

Constructor and Description
AbstractCentralProcessor() Create a Processor

Method Summary

Modifier and Type	Method and Description
protected abstract void	calculateProcessorCounts() Updates logical and physical processor counts
protected String	createProcessorID(String stepping, String model, String family, String[] flags) Creates a Processor ID by encoding the stepping, model, family, and feature flags.
String	getFamily()
String	getIdentifier() Identifier, eg.
int	getLogicalProcessorCount() Get the number of logical CPUs available for processing.
String	getModel()
String	getName() Name, eg.
int	getPhysicalPackageCount() Get the number of packages/sockets in the system.
int	getPhysicalProcessorCount() Get the number of physical CPUs/cores available for processing.
double[]	getProcessorCpuLoadBetweenTicks() Returns the "recent cpu usage" for all logical processors by counting ticks for the processors from CentralProcessor.getProcessorCpuLoadTicks() between successive calls of this method, with a minimum interval slightly less than 1 second.
String	getProcessorID() Gets the Processor ID.
String	getStepping()
double	getSystemCpuLoad() Returns the "recent cpu usage" for the whole system from OperatingSystemMXBean.getSystemCpuLoad() if a user is running the Oracle JVM.
double	getSystemCpuLoadBetweenTicks() Returns the "recent cpu usage" for the whole system by counting ticks from CentralProcessor.getSystemCpuLoadTicks() between successive calls of this method, with a minimum interval slightly less than 1 second.
double	getSystemLoadAverage() Returns the system load average for the last minute.
String	getVendor() Processor vendor.
long	getVendorFreq() Vendor frequency (in Hz), eg.
protected void	initTicks() Initializes tick arrays
boolean	isCpu64bit() Is CPU 64bit?
void	setCpu64(boolean value) Set flag is cpu is 64bit.
void	setFamily(String family)
void	setIdentifier(String identifier) Set processor identifier.
void	setModel(String model)
void	setName(String name) Set processor name.
void	setProcessorID(String processorID) Set processor ID
void	setStepping(String stepping)
void	setVendor(String vendor) Set processor vendor.
void	setVendorFreq(long freq) Set processor vendor frequency (in Hz).
String	toString()
protected void	updateProcessorTicks() Updates per-processor tick information.
protected void	updateSystemTicks() Updates system tick information.

Methods inherited from class java.lang.Object

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

Methods inherited from interface oshi.hardware.CentralProcessor

getContextSwitches, getInterrupts, getProcessorCpuLoadTicks, getSystemCpuLoadTicks, getSystemLoadAverage, getSystemSerialNumber, getSystemUptime

Field Detail

logicalProcessorCount

protected int logicalProcessorCount

physicalProcessorCount

protected int physicalProcessorCount

physicalPackageCount

protected int physicalPackageCount

Constructor Detail

AbstractCentralProcessor

public AbstractCentralProcessor()

Create a Processor

Method Detail

initTicks

protected void initTicks()

Initializes tick arrays

calculateProcessorCounts

protected abstract void calculateProcessorCounts()

Updates logical and physical processor counts

getVendor

public String getVendor()

Processor vendor.

Specified by:

getVendor in interface CentralProcessor

Returns:

vendor string.

setVendor

public void setVendor(String vendor)

Set processor vendor.

Specified by:

setVendor in interface CentralProcessor

Parameters:

vendor - Vendor.

getName

public String getName()

Name, eg. Intel(R) Core(TM)2 Duo CPU T7300 @ 2.00GHz

Specified by:

getName in interface CentralProcessor

Returns:

Processor name.

setName

public void setName(String name)

Set processor name.

Specified by:

setName in interface CentralProcessor

Parameters:

name - Name.

getProcessorID

public String getProcessorID()

Gets the Processor ID. This is a hexidecimal string representing an 8-byte value, normally obtained using the CPUID opcode with the EAX register set to 1. The first four bytes are the resulting contents of the EAX register, which is the Processor signature, represented in human-readable form by CentralProcessor.getIdentifier() . The remaining four bytes are the contents of the EDX register, containing feature flags. NOTE: The order of returned bytes is platform and software dependent. Values may be in either Big Endian or Little Endian order.

Specified by:

getProcessorID in interface CentralProcessor

Returns:

A string representing the Processor ID

setProcessorID

public void setProcessorID(String processorID)

Set processor ID

Specified by:

setProcessorID in interface CentralProcessor

Parameters:

processorID - The processor ID

getVendorFreq

public long getVendorFreq()

Vendor frequency (in Hz), eg. for processor named Intel(R) Core(TM)2 Duo CPU T7300 @ 2.00GHz the vendor frequency is 2000000000.

Specified by:

getVendorFreq in interface CentralProcessor

Returns:

Processor frequency or -1 if unknown.

setVendorFreq

public void setVendorFreq(long freq)

Set processor vendor frequency (in Hz).

Specified by:

setVendorFreq in interface CentralProcessor

Parameters:

freq - Frequency.

getIdentifier

public String getIdentifier()

Identifier, eg. x86 Family 6 Model 15 Stepping 10.

Specified by:

getIdentifier in interface CentralProcessor

Returns:

Processor identifier.

setIdentifier

public void setIdentifier(String identifier)

Set processor identifier.

Specified by:

setIdentifier in interface CentralProcessor

Parameters:

identifier - Identifier.

isCpu64bit

public boolean isCpu64bit()

Is CPU 64bit?

Specified by:

isCpu64bit in interface CentralProcessor

Returns:

True if cpu is 64bit.

setCpu64

public void setCpu64(boolean value)

Set flag is cpu is 64bit.

Specified by:

setCpu64 in interface CentralProcessor

Parameters:

value - True if cpu is 64.

getStepping

public String getStepping()

Specified by:

getStepping in interface CentralProcessor

Returns:

the stepping

setStepping

public void setStepping(String stepping)

Specified by:

setStepping in interface CentralProcessor

Parameters:

stepping - the stepping to set

getModel

public String getModel()

Specified by:

getModel in interface CentralProcessor

Returns:

the model

setModel

public void setModel(String model)

Specified by:

setModel in interface CentralProcessor

Parameters:

model - the model to set

getFamily

public String getFamily()

Specified by:

getFamily in interface CentralProcessor

Returns:

the family

setFamily

public void setFamily(String family)

Specified by:

setFamily in interface CentralProcessor

Parameters:

family - the family to set

getSystemCpuLoadBetweenTicks

public double getSystemCpuLoadBetweenTicks()

Returns the "recent cpu usage" for the whole system by counting ticks from CentralProcessor.getSystemCpuLoadTicks() between successive calls of this method, with a minimum interval slightly less than 1 second. If less than one second has elapsed since the last call of this method, it will return a calculation based on the tick counts and times of the previous two calls. If at least a second has elapsed, it will return the average CPU load for the interval and update the "last called" times. This method is intended to be used for periodic polling at intervals of 1 second or longer.

Specified by:

getSystemCpuLoadBetweenTicks in interface CentralProcessor

Returns:

CPU load between 0 and 1 (100%)

updateSystemTicks

protected void updateSystemTicks()

Updates system tick information. Stores in array with seven elements representing clock ticks or milliseconds (platform dependent) spent in User (0), Nice (1), System (2), Idle (3), IOwait (4), IRQ (5), and SoftIRQ (6) states. By measuring the difference between ticks across a time interval, CPU load over that interval may be calculated.

getSystemCpuLoad

public double getSystemCpuLoad()

Returns the "recent cpu usage" for the whole system from OperatingSystemMXBean.getSystemCpuLoad() if a user is running the Oracle JVM. This value is a double in the [0.0,1.0] interval. A value of 0.0 means that all CPUs were idle during the recent period of time observed, while a value of 1.0 means that all CPUs were actively running 100% of the time during the recent period being observed. All values between 0.0 and 1.0 are possible depending of the activities going on in the system. If the system recent cpu usage is not available, the method returns a negative value. Calling this method immediately upon instantiating the CentralProcessor may give unreliable results. If a user is not running the Oracle JVM, this method will default to the behavior and return value of CentralProcessor.getSystemCpuLoadBetweenTicks().

Specified by:

getSystemCpuLoad in interface CentralProcessor

Returns:

the "recent cpu usage" for the whole system; a negative value if not available.

getSystemLoadAverage

public double getSystemLoadAverage()

Returns the system load average for the last minute. This is equivalent to calling CentralProcessor.getSystemLoadAverage(int) with an argument of 1 and returning the first value, and is retained for compatibility.

Specified by:

getSystemLoadAverage in interface CentralProcessor

Returns:

the system load average; or a negative value if not available.

getProcessorCpuLoadBetweenTicks

public double[] getProcessorCpuLoadBetweenTicks()

Returns the "recent cpu usage" for all logical processors by counting ticks for the processors from CentralProcessor.getProcessorCpuLoadTicks() between successive calls of this method, with a minimum interval slightly less than 1 second. If less than one second has elapsed since the last call of this method, it will return a calculation based on the tick counts and times of the previous two calls. If at least a second has elapsed, it will return the average CPU load for the interval and update the "last called" times. This method is intended to be used for periodic polling (iterating over all processors) at intervals of 1 second or longer.

Specified by:

getProcessorCpuLoadBetweenTicks in interface CentralProcessor

Returns:

array of CPU load between 0 and 1 (100%) for each logical processor

updateProcessorTicks

protected void updateProcessorTicks()

Updates per-processor tick information. Stores in 2D array; an array for each logical processor with with seven elements representing clock ticks or milliseconds (platform dependent) spent in User (0), Nice (1), System (2), Idle (3), IOwait (4), IRQ (5), and SoftIRQ (6) states. By measuring the difference between ticks across a time interval, CPU load over that interval may be calculated.

getLogicalProcessorCount

public int getLogicalProcessorCount()

Get the number of logical CPUs available for processing. This value may be higher than physical CPUs if hyperthreading is enabled.

Specified by:

getLogicalProcessorCount in interface CentralProcessor

Returns:

The number of logical CPUs available.

getPhysicalProcessorCount

public int getPhysicalProcessorCount()

Get the number of physical CPUs/cores available for processing.

Specified by:

getPhysicalProcessorCount in interface CentralProcessor

Returns:

The number of physical CPUs available.

getPhysicalPackageCount

public int getPhysicalPackageCount()

Get the number of packages/sockets in the system. A single package may contain multiple cores.

Specified by:

getPhysicalPackageCount in interface CentralProcessor

Returns:

The number of physical packages available.

toString

public String toString()

Overrides:

toString in class Object

createProcessorID

protected String createProcessorID(String stepping,
                                   String model,
                                   String family,
                                   String[] flags)

Creates a Processor ID by encoding the stepping, model, family, and feature flags.

Parameters:

stepping - The CPU stepping

model - The CPU model

family - The CPU family

flags - A space-delimited list of CPU feature flags

Returns:

The Processor ID string