oshi.driver.linux.Sysfs Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2020-2022 The OSHI Project Contributors
* SPDX-License-Identifier: MIT
*/
package oshi.driver.linux;
import oshi.annotation.concurrent.ThreadSafe;
import oshi.util.Constants;
import oshi.util.FileUtil;
import oshi.util.ParseUtil;
import oshi.util.Util;
/**
* Utility to read info from {@code sysfs}
*/
@ThreadSafe
public final class Sysfs {
private Sysfs() {
}
/**
* Query the vendor from sysfs
*
* @return The vendor if available, null otherwise
*/
public static String querySystemVendor() {
final String sysVendor = FileUtil.getStringFromFile(Constants.SYSFS_SERIAL_PATH + "sys_vendor").trim();
if (!sysVendor.isEmpty()) {
return sysVendor;
}
return null;
}
/**
* Query the model from sysfs
*
* @return The model if available, null otherwise
*/
public static String queryProductModel() {
final String productName = FileUtil.getStringFromFile(Constants.SYSFS_SERIAL_PATH + "product_name").trim();
final String productVersion = FileUtil.getStringFromFile(Constants.SYSFS_SERIAL_PATH + "product_version")
.trim();
if (productName.isEmpty()) {
if (!productVersion.isEmpty()) {
return productVersion;
}
} else {
if (!productVersion.isEmpty() && !"None".equals(productVersion)) {
return productName + " (version: " + productVersion + ")";
}
return productName;
}
return null;
}
/**
* Query the product serial number from sysfs
*
* @return The serial number if available, null otherwise
*/
public static String queryProductSerial() {
// These sysfs files accessible by root, or can be chmod'd at boot time
// to enable access without root
String serial = FileUtil.getStringFromFile(Constants.SYSFS_SERIAL_PATH + "product_serial");
if (!serial.isEmpty() && !"None".equals(serial)) {
return serial;
}
return queryBoardSerial();
}
/**
* Query the UUID from sysfs
*
* @return The UUID if available, null otherwise
*/
public static String queryUUID() {
// These sysfs files accessible by root, or can be chmod'd at boot time
// to enable access without root
String uuid = FileUtil.getStringFromFile(Constants.SYSFS_SERIAL_PATH + "product_uuid");
if (!uuid.isEmpty() && !"None".equals(uuid)) {
return uuid;
}
return null;
}
/**
* Query the board vendor from sysfs
*
* @return The board vendor if available, null otherwise
*/
public static String queryBoardVendor() {
final String boardVendor = FileUtil.getStringFromFile(Constants.SYSFS_SERIAL_PATH + "board_vendor").trim();
if (!boardVendor.isEmpty()) {
return boardVendor;
}
return null;
}
/**
* Query the board model from sysfs
*
* @return The board model if available, null otherwise
*/
public static String queryBoardModel() {
final String boardName = FileUtil.getStringFromFile(Constants.SYSFS_SERIAL_PATH + "board_name").trim();
if (!boardName.isEmpty()) {
return boardName;
}
return null;
}
/**
* Query the board version from sysfs
*
* @return The board version if available, null otherwise
*/
public static String queryBoardVersion() {
final String boardVersion = FileUtil.getStringFromFile(Constants.SYSFS_SERIAL_PATH + "board_version").trim();
if (!boardVersion.isEmpty()) {
return boardVersion;
}
return null;
}
/**
* Query the board serial number from sysfs
*
* @return The board serial number if available, null otherwise
*/
public static String queryBoardSerial() {
final String boardSerial = FileUtil.getStringFromFile(Constants.SYSFS_SERIAL_PATH + "board_serial").trim();
if (!boardSerial.isEmpty()) {
return boardSerial;
}
return null;
}
/**
* Query the bios vendor from sysfs
*
* @return The bios vendor if available, null otherwise
*/
public static String queryBiosVendor() {
final String biosVendor = FileUtil.getStringFromFile(Constants.SYSFS_SERIAL_PATH + "bios_vendor").trim();
if (biosVendor.isEmpty()) {
return biosVendor;
}
return null;
}
/**
* Query the bios description from sysfs
*
* @return The bios description if available, null otherwise
*/
public static String queryBiosDescription() {
final String modalias = FileUtil.getStringFromFile(Constants.SYSFS_SERIAL_PATH + "modalias").trim();
if (!modalias.isEmpty()) {
return modalias;
}
return null;
}
/**
* Query the bios version from sysfs
*
* @param biosRevision A revision string to append
* @return The bios version if available, null otherwise
*/
public static String queryBiosVersion(String biosRevision) {
final String biosVersion = FileUtil.getStringFromFile(Constants.SYSFS_SERIAL_PATH + "bios_version").trim();
if (!biosVersion.isEmpty()) {
return biosVersion + (Util.isBlank(biosRevision) ? "" : " (revision " + biosRevision + ")");
}
return null;
}
/**
* Query the bios release date from sysfs
*
* @return The bios release date if available, null otherwise
*/
public static String queryBiosReleaseDate() {
final String biosDate = FileUtil.getStringFromFile(Constants.SYSFS_SERIAL_PATH + "bios_date").trim();
if (!biosDate.isEmpty()) {
return ParseUtil.parseMmDdYyyyToYyyyMmDD(biosDate);
}
return null;
}
}