oshi.hardware.platform.mac

Class MacCentralProcessor

java.lang.Object

oshi.hardware.common.AbstractCentralProcessor

oshi.hardware.platform.mac.MacCentralProcessor

All Implemented Interfaces:

Serializable, CentralProcessor, OshiJsonObject

public class MacCentralProcessor
extends AbstractCentralProcessor

A CPU.

Author:

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

See Also:

Serialized Form

Field Summary

Fields inherited from class oshi.hardware.common.AbstractCentralProcessor

cpu64, cpuFamily, cpuIdentifier, cpuModel, cpuName, cpuSerialNumber, cpuStepping, cpuVendor, cpuVendorFreq, curProcTicks, curTicks, jsonFactory, logicalProcessorCount, physicalProcessorCount, prevProcTicks, prevTicks, procTickTime, tickTime

Constructor Summary

Constructors

Constructor and Description
MacCentralProcessor() Create a Processor

Method Summary

Modifier and Type	Method and Description
protected void	calculateProcessorCounts() Updates logical and physical processor counts from sysctl calls
OSProcess	getProcess(int pid) Gets information on a currently running process
int	getProcessCount() Get the number of processes currently running
OSProcess[]	getProcesses() Gets currently running processes
int	getProcessId() Gets the current process ID
long[][]	getProcessorCpuLoadTicks() Get Processor CPU Load tick counters.
long[]	getSystemCpuLoadTicks() Get System-wide CPU Load tick counters.
long	getSystemIOWaitTicks() Get System IOWait tick counters (if available on that Operating System).
long[]	getSystemIrqTicks() Get System IRQ tick counters (if available on that Operating System).
double[]	getSystemLoadAverage(int nelem) Returns the system load average for the number of elements specified, up to 3, representing 1, 5, and 15 minutes.
String	getSystemSerialNumber() Get the System/CPU Serial Number, if available.
long	getSystemUptime() Get the System uptime (time since boot).
int	getThreadCount() Get the number of threads currently running

Methods inherited from class oshi.hardware.common.AbstractCentralProcessor

getFamily, getIdentifier, getLogicalProcessorCount, getModel, getName, getPhysicalProcessorCount, getProcessorCpuLoadBetweenTicks, getStepping, getSystemCpuLoad, getSystemCpuLoadBetweenTicks, getSystemLoadAverage, getVendor, getVendorFreq, initTicks, isCpu64bit, setCpu64, setFamily, setIdentifier, setModel, setName, setStepping, setVendor, setVendorFreq, toJSON, toString, updateProcessorTicks, updateSystemTicks

Methods inherited from class java.lang.Object

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

Constructor Detail

MacCentralProcessor

public MacCentralProcessor()

Create a Processor

Method Detail

calculateProcessorCounts

protected void calculateProcessorCounts()

Updates logical and physical processor counts from sysctl calls

Specified by:

calculateProcessorCounts in class AbstractCentralProcessor

getSystemCpuLoadTicks

public long[] getSystemCpuLoadTicks()

Get System-wide CPU Load tick counters. Returns an array with four elements representing clock ticks or milliseconds (platform dependent) spent in User (0), Nice (1), System (2), and Idle (3) states. By measuring the difference between ticks across a time interval, CPU load over that interval may be calculated. The Idle time for this method includes system time spent idle waiting for IO as reported by CentralProcessor.getSystemIOWaitTicks(). The system time includes system time spent servicing Hardware and Software IRQ requests as reported by CentralProcessor.getSystemIrqTicks() as well as executing other virtual hosts (steal) or running a virtual cpu (guest).

Specified by:

getSystemCpuLoadTicks in interface CentralProcessor

Specified by:

getSystemCpuLoadTicks in class AbstractCentralProcessor

Returns:

An array of 4 long values representing time spent in User, Nice(if applicable), System, and Idle states.

getSystemIOWaitTicks

public long getSystemIOWaitTicks()

Get System IOWait tick counters (if available on that Operating System). Time spent waiting for IO to complete is included in the idle time calculated by CentralProcessor.getSystemCpuLoadTicks() but is provided separately for more detail.

Specified by:

getSystemIOWaitTicks in interface CentralProcessor

Specified by:

getSystemIOWaitTicks in class AbstractCentralProcessor

Returns:

a long value representing time spent idle waiting for IO to complete.

getSystemIrqTicks

public long[] getSystemIrqTicks()

Get System IRQ tick counters (if available on that Operating System). Time spent servicing hardware and software (Deferred Procedure Call) interrupts is included in the system time calculated by CentralProcessor.getSystemCpuLoadTicks() but is provided separately for more detail.

Specified by:

getSystemIrqTicks in interface CentralProcessor

Specified by:

getSystemIrqTicks in class AbstractCentralProcessor

Returns:

an array of two long values representing time spent servicing hardware interrupts and software interrupts (DPC)

getSystemLoadAverage

public double[] getSystemLoadAverage(int nelem)

Returns the system load average for the number of elements specified, up to 3, representing 1, 5, and 15 minutes. The system load average is the sum of the number of runnable entities queued to the available processors and the number of runnable entities running on the available processors averaged over a period of time. The way in which the load average is calculated is operating system specific but is typically a damped time-dependent average. If the load average is not available, a negative value is returned. This method is designed to provide a hint about the system load and may be queried frequently. The load average may be unavailable on some platforms (e.g., Windows) where it is expensive to implement this method.

Specified by:

getSystemLoadAverage in interface CentralProcessor

Specified by:

getSystemLoadAverage in class AbstractCentralProcessor

Parameters:

nelem - Number of elements to return.

Returns:

an array of the system load averages for 1, 5, and 15 minutes with the size of the array specified by nelem; or negative values if not available.

getProcessorCpuLoadTicks

public long[][] getProcessorCpuLoadTicks()

Get Processor CPU Load tick counters. Returns a two dimensional array, with CentralProcessor.getLogicalProcessorCount() arrays, each containing four elements representing clock ticks or milliseconds (platform dependent) spent in User (0), Nice (1), System (2), and Idle (3) states. By measuring the difference between ticks across a time interval, CPU load over that interval may be calculated. The Idle time for this method includes processor time spent idle waiting for IO as reported by CentralProcessor.getSystemIOWaitTicks(). The system time includes processor time spent servicing Hardware IRQ requests as reported by CentralProcessor.getSystemIrqTicks() as well as Software IRQ requests (softirq), executing other virtual hosts (steal) or running a virtual cpu (guest).

Specified by:

getProcessorCpuLoadTicks in interface CentralProcessor

Specified by:

getProcessorCpuLoadTicks in class AbstractCentralProcessor

Returns:

A 2D array of logicalProcessorCount x 4 long values representing time spent in User, Nice(if applicable), System, and Idle states.

getSystemUptime

public long getSystemUptime()

Get the System uptime (time since boot).

Specified by:

getSystemUptime in interface CentralProcessor

Specified by:

getSystemUptime in class AbstractCentralProcessor

Returns:

Number of seconds since boot.

getSystemSerialNumber

public String getSystemSerialNumber()

Get the System/CPU Serial Number, if available. On Linux, this requires either root permissions, or installation of the (deprecated) HAL library (lshal command).

Specified by:

getSystemSerialNumber in interface CentralProcessor

Specified by:

getSystemSerialNumber in class AbstractCentralProcessor

Returns:

the System/CPU Serial Number, if available, otherwise returns "unknown"

getProcesses

public OSProcess[] getProcesses()

Gets currently running processes

Returns:

An array of OSProcess objects for currently running processes

getProcess

public OSProcess getProcess(int pid)

Gets information on a currently running process

Parameters:

pid - A process ID

Returns:

An OSProcess object for the specified process id if it is running; null otherwise currently running processes

getProcessId

public int getProcessId()

Gets the current process ID

Returns:

the Process ID of the current process

getProcessCount

public int getProcessCount()

Get the number of processes currently running

Specified by:

getProcessCount in interface CentralProcessor

Specified by:

getProcessCount in class AbstractCentralProcessor

Returns:

The number of processes running

getThreadCount

public int getThreadCount()

Get the number of threads currently running

Specified by:

getThreadCount in interface CentralProcessor

Specified by:

getThreadCount in class AbstractCentralProcessor

Returns:

The number of threads running