oshi.hardware.platform.mac.MacCentralProcessor Maven / Gradle / Ivy
/**
* MIT License
*
* Copyright (c) 2010 - 2021 The OSHI Project Contributors: https://github.com/oshi/oshi/graphs/contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package oshi.hardware.platform.mac;
import static oshi.util.Memoizer.memoize;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.function.Supplier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.sun.jna.Native; // NOSONAR
import com.sun.jna.platform.mac.IOKit.IOIterator;
import com.sun.jna.platform.mac.IOKit.IORegistryEntry;
import com.sun.jna.platform.mac.IOKitUtil;
import com.sun.jna.platform.mac.SystemB;
import com.sun.jna.platform.mac.SystemB.HostCpuLoadInfo;
import com.sun.jna.platform.mac.SystemB.VMMeter;
import com.sun.jna.ptr.IntByReference;
import com.sun.jna.ptr.PointerByReference;
import oshi.annotation.concurrent.ThreadSafe;
import oshi.hardware.common.AbstractCentralProcessor;
import oshi.util.FormatUtil;
import oshi.util.ParseUtil;
import oshi.util.Util;
import oshi.util.platform.mac.SysctlUtil;
import oshi.util.tuples.Triplet;
/**
* A CPU.
*/
@ThreadSafe
final class MacCentralProcessor extends AbstractCentralProcessor {
private static final Logger LOG = LoggerFactory.getLogger(MacCentralProcessor.class);
private final Supplier vendor = memoize(MacCentralProcessor::platformExpert);
private final Supplier> typeFamilyFreq = memoize(MacCentralProcessor::queryArmCpu);
private static final int ROSETTA_CPUTYPE = 0x00000007;
private static final int ROSETTA_CPUFAMILY = 0x573b5eec;
private static final int M1_CPUTYPE = 0x0100000C;
private static final int M1_CPUFAMILY = 0x1b588bb3;
@Override
protected ProcessorIdentifier queryProcessorId() {
String cpuName = SysctlUtil.sysctl("machdep.cpu.brand_string", "");
String cpuVendor;
String cpuStepping;
String cpuModel;
String cpuFamily;
String processorID;
long cpuFreq = 0L;
if (cpuName.startsWith("Apple")) {
// Processing an M1 chip
cpuVendor = vendor.get();
cpuStepping = "0"; // No correlation yet
cpuModel = "0"; // No correlation yet
int type = SysctlUtil.sysctl("hw.cputype", 0);
int family = SysctlUtil.sysctl("hw.cpufamily", 0);
// M1 should have hw.cputype 0x0100000C (ARM64) and hw.cpufamily 0x1b588bb3 for
// an ARM SoC. However, under Rosetta 2, low level cpuid calls in the translated
// environment report hw.cputype for x86 (0x00000007) and hw.cpufamily for an
// Intel Westmere chip (0x573b5eec), family 6, model 44, stepping 0.
// Test if under Rosetta and generate correct chip
if (family == ROSETTA_CPUFAMILY) {
type = typeFamilyFreq.get().getA();
family = typeFamilyFreq.get().getB();
}
cpuFreq = typeFamilyFreq.get().getC();
// Translate to output
cpuFamily = String.format("0x%08x", family);
// Processor ID is an intel concept but CPU type + family conveys same info
processorID = String.format("%08x%08x", type, family);
} else {
// Processing an Intel chip
cpuVendor = SysctlUtil.sysctl("machdep.cpu.vendor", "");
int i = SysctlUtil.sysctl("machdep.cpu.stepping", -1);
cpuStepping = i < 0 ? "" : Integer.toString(i);
i = SysctlUtil.sysctl("machdep.cpu.model", -1);
cpuModel = i < 0 ? "" : Integer.toString(i);
i = SysctlUtil.sysctl("machdep.cpu.family", -1);
cpuFamily = i < 0 ? "" : Integer.toString(i);
long processorIdBits = 0L;
processorIdBits |= SysctlUtil.sysctl("machdep.cpu.signature", 0);
processorIdBits |= (SysctlUtil.sysctl("machdep.cpu.feature_bits", 0L) & 0xffffffff) << 32;
processorID = String.format("%016x", processorIdBits);
}
if (cpuFreq == 0) {
cpuFreq = SysctlUtil.sysctl("hw.cpufrequency", 0L);
}
boolean cpu64bit = SysctlUtil.sysctl("hw.cpu64bit_capable", 0) != 0;
return new ProcessorIdentifier(cpuVendor, cpuName, cpuFamily, cpuModel, cpuStepping, processorID, cpu64bit,
cpuFreq);
}
@Override
protected List initProcessorCounts() {
int logicalProcessorCount = SysctlUtil.sysctl("hw.logicalcpu", 1);
int physicalProcessorCount = SysctlUtil.sysctl("hw.physicalcpu", 1);
int physicalPackageCount = SysctlUtil.sysctl("hw.packages", 1);
List logProcs = new ArrayList<>(logicalProcessorCount);
for (int i = 0; i < logicalProcessorCount; i++) {
logProcs.add(new LogicalProcessor(i, i * physicalProcessorCount / logicalProcessorCount,
i * physicalPackageCount / logicalProcessorCount));
}
return logProcs;
}
@Override
public long[] querySystemCpuLoadTicks() {
long[] ticks = new long[TickType.values().length];
int machPort = SystemB.INSTANCE.mach_host_self();
HostCpuLoadInfo cpuLoadInfo = new HostCpuLoadInfo();
if (0 != SystemB.INSTANCE.host_statistics(machPort, SystemB.HOST_CPU_LOAD_INFO, cpuLoadInfo,
new IntByReference(cpuLoadInfo.size()))) {
LOG.error("Failed to get System CPU ticks. Error code: {} ", Native.getLastError());
return ticks;
}
ticks[TickType.USER.getIndex()] = cpuLoadInfo.cpu_ticks[SystemB.CPU_STATE_USER];
ticks[TickType.NICE.getIndex()] = cpuLoadInfo.cpu_ticks[SystemB.CPU_STATE_NICE];
ticks[TickType.SYSTEM.getIndex()] = cpuLoadInfo.cpu_ticks[SystemB.CPU_STATE_SYSTEM];
ticks[TickType.IDLE.getIndex()] = cpuLoadInfo.cpu_ticks[SystemB.CPU_STATE_IDLE];
// Leave IOWait and IRQ values as 0
return ticks;
}
@Override
public long[] queryCurrentFreq() {
long[] freq = new long[1];
freq[0] = SysctlUtil.sysctl("hw.cpufrequency", getProcessorIdentifier().getVendorFreq());
return freq;
}
@Override
public long queryMaxFreq() {
return SysctlUtil.sysctl("hw.cpufrequency_max", getProcessorIdentifier().getVendorFreq());
}
@Override
public double[] getSystemLoadAverage(int nelem) {
if (nelem < 1 || nelem > 3) {
throw new IllegalArgumentException("Must include from one to three elements.");
}
double[] average = new double[nelem];
int retval = SystemB.INSTANCE.getloadavg(average, nelem);
if (retval < nelem) {
Arrays.fill(average, -1d);
}
return average;
}
@Override
public long[][] queryProcessorCpuLoadTicks() {
long[][] ticks = new long[getLogicalProcessorCount()][TickType.values().length];
int machPort = SystemB.INSTANCE.mach_host_self();
IntByReference procCount = new IntByReference();
PointerByReference procCpuLoadInfo = new PointerByReference();
IntByReference procInfoCount = new IntByReference();
if (0 != SystemB.INSTANCE.host_processor_info(machPort, SystemB.PROCESSOR_CPU_LOAD_INFO, procCount,
procCpuLoadInfo, procInfoCount)) {
LOG.error("Failed to update CPU Load. Error code: {}", Native.getLastError());
return ticks;
}
int[] cpuTicks = procCpuLoadInfo.getValue().getIntArray(0, procInfoCount.getValue());
for (int cpu = 0; cpu < procCount.getValue(); cpu++) {
int offset = cpu * SystemB.CPU_STATE_MAX;
ticks[cpu][TickType.USER.getIndex()] = FormatUtil.getUnsignedInt(cpuTicks[offset + SystemB.CPU_STATE_USER]);
ticks[cpu][TickType.NICE.getIndex()] = FormatUtil.getUnsignedInt(cpuTicks[offset + SystemB.CPU_STATE_NICE]);
ticks[cpu][TickType.SYSTEM.getIndex()] = FormatUtil
.getUnsignedInt(cpuTicks[offset + SystemB.CPU_STATE_SYSTEM]);
ticks[cpu][TickType.IDLE.getIndex()] = FormatUtil.getUnsignedInt(cpuTicks[offset + SystemB.CPU_STATE_IDLE]);
}
return ticks;
}
@Override
public long queryContextSwitches() {
int machPort = SystemB.INSTANCE.mach_host_self();
VMMeter vmstats = new VMMeter();
if (0 != SystemB.INSTANCE.host_statistics(machPort, SystemB.HOST_VM_INFO, vmstats,
new IntByReference(vmstats.size()))) {
LOG.error("Failed to update vmstats. Error code: {}", Native.getLastError());
return -1;
}
return ParseUtil.unsignedIntToLong(vmstats.v_swtch);
}
@Override
public long queryInterrupts() {
int machPort = SystemB.INSTANCE.mach_host_self();
VMMeter vmstats = new VMMeter();
if (0 != SystemB.INSTANCE.host_statistics(machPort, SystemB.HOST_VM_INFO, vmstats,
new IntByReference(vmstats.size()))) {
LOG.error("Failed to update vmstats. Error code: {}", Native.getLastError());
return -1;
}
return ParseUtil.unsignedIntToLong(vmstats.v_intr);
}
private static String platformExpert() {
String manufacturer = null;
IORegistryEntry platformExpert = IOKitUtil.getMatchingService("IOPlatformExpertDevice");
if (platformExpert != null) {
// Get manufacturer from IOPlatformExpertDevice
byte[] data = platformExpert.getByteArrayProperty("manufacturer");
if (data != null) {
manufacturer = Native.toString(data, StandardCharsets.UTF_8);
}
platformExpert.release();
}
return Util.isBlank(manufacturer) ? "Apple Inc." : manufacturer;
}
private static Triplet queryArmCpu() {
int type = ROSETTA_CPUTYPE;
int family = ROSETTA_CPUFAMILY;
long freq = 0L;
// All CPUs are an IOPlatformDevice
// Iterate each CPU and save frequency and "compatible" strings
IOIterator iter = IOKitUtil.getMatchingServices("IOPlatformDevice");
if (iter != null) {
Set compatibleStrSet = new HashSet<>();
IORegistryEntry cpu = iter.next();
while (cpu != null) {
if (cpu.getName().startsWith("cpu")) {
// Accurate CPU vendor frequency in kHz as little-endian byte array
byte[] data = cpu.getByteArrayProperty("clock-frequency");
if (data != null) {
long cpuFreq = ParseUtil.byteArrayToLong(data, data.length, false) * 1000L;
if (cpuFreq > freq) {
freq = cpuFreq;
}
}
// Compatible key is null-delimited C string array in byte array
data = cpu.getByteArrayProperty("compatible");
if (data != null) {
for (String s : new String(data, StandardCharsets.UTF_8).split("\0")) {
if (!s.isEmpty()) {
compatibleStrSet.add(s);
}
}
}
}
cpu.release();
cpu = iter.next();
}
iter.release();
// Match strings in "compatible" field with expectation for M1 chip
// Hard coded for M1 for now. Need to update and make more configurable for M1X,
// M2, etc.
List m1compatible = Arrays.asList("ARM,v8", "apple,firestorm", "apple,icestorm");
compatibleStrSet.retainAll(m1compatible);
if (compatibleStrSet.size() == m1compatible.size()) {
type = M1_CPUTYPE;
family = M1_CPUFAMILY;
}
}
return new Triplet<>(type, family, freq);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy