oshi.driver.windows.DeviceTree Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2021-2022 The OSHI Project Contributors
* SPDX-License-Identifier: MIT
*/
package oshi.driver.windows;
import static com.sun.jna.platform.win32.Cfgmgr32.CM_DRP_CLASS;
import static com.sun.jna.platform.win32.Cfgmgr32.CM_DRP_DEVICEDESC;
import static com.sun.jna.platform.win32.Cfgmgr32.CM_DRP_FRIENDLYNAME;
import static com.sun.jna.platform.win32.Cfgmgr32.CM_DRP_MFG;
import static com.sun.jna.platform.win32.Cfgmgr32.CM_DRP_SERVICE;
import static com.sun.jna.platform.win32.SetupApi.DIGCF_DEVICEINTERFACE;
import static com.sun.jna.platform.win32.SetupApi.DIGCF_PRESENT;
import static com.sun.jna.platform.win32.WinBase.INVALID_HANDLE_VALUE;
import static com.sun.jna.platform.win32.WinError.ERROR_SUCCESS;
import java.util.ArrayDeque;
import java.util.HashMap;
import java.util.Map;
import java.util.Queue;
import java.util.Set;
import java.util.stream.Collectors;
import com.sun.jna.Memory;
import com.sun.jna.platform.win32.Cfgmgr32;
import com.sun.jna.platform.win32.Cfgmgr32Util;
import com.sun.jna.platform.win32.Guid.GUID;
import com.sun.jna.platform.win32.SetupApi;
import com.sun.jna.platform.win32.WinNT.HANDLE;
import com.sun.jna.ptr.IntByReference;
import oshi.annotation.concurrent.ThreadSafe;
import oshi.jna.ByRef.CloseableIntByReference;
import oshi.jna.Struct.CloseableSpDevinfoData;
import oshi.util.tuples.Quintet;
/**
* Utility to query device interfaces via Config Manager Device Tree functions
*/
@ThreadSafe
public final class DeviceTree {
private static final int MAX_PATH = 260;
private static final SetupApi SA = SetupApi.INSTANCE;
private static final Cfgmgr32 C32 = Cfgmgr32.INSTANCE;
private DeviceTree() {
}
/**
* Queries devices matching the specified device interface and returns maps representing device tree relationships,
* name, device ID, and manufacturer
*
* @param guidDevInterface The GUID of a device interface class for which the tree should be collected.
*
* @return A {@link Quintet} of maps indexed by node ID, where the key set represents node IDs for all devices
* matching the specified device interface GUID. The first element is a set containing devices with no
* parents, match the device interface requested.. The second element maps each node ID to its parents, if
* any. This map's key set excludes the no-parent devices returned in the first element. The third element
* maps a node ID to a name or description. The fourth element maps a node id to a device ID. The fifth
* element maps a node ID to a manufacturer.
*/
public static Quintet, Map, Map, Map, Map> queryDeviceTree(
GUID guidDevInterface) {
Map parentMap = new HashMap<>();
Map nameMap = new HashMap<>();
Map deviceIdMap = new HashMap<>();
Map mfgMap = new HashMap<>();
// Get device IDs for the top level devices
HANDLE hDevInfo = SA.SetupDiGetClassDevs(guidDevInterface, null, null, DIGCF_DEVICEINTERFACE | DIGCF_PRESENT);
if (!INVALID_HANDLE_VALUE.equals(hDevInfo)) {
try (Memory buf = new Memory(MAX_PATH);
CloseableIntByReference size = new CloseableIntByReference(MAX_PATH);
CloseableIntByReference child = new CloseableIntByReference();
CloseableIntByReference sibling = new CloseableIntByReference();
CloseableSpDevinfoData devInfoData = new CloseableSpDevinfoData()) {
devInfoData.cbSize = devInfoData.size();
// Enumerate Device Info using BFS queue
Queue deviceTree = new ArrayDeque<>();
for (int i = 0; SA.SetupDiEnumDeviceInfo(hDevInfo, i, devInfoData); i++) {
deviceTree.add(devInfoData.DevInst);
// Initialize parent and child objects
int node = 0;
while (!deviceTree.isEmpty()) {
// Process the next device in the queue
node = deviceTree.poll();
// Save the strings in their maps
String deviceId = Cfgmgr32Util.CM_Get_Device_ID(node);
deviceIdMap.put(node, deviceId);
// Prefer friendly name over desc if it is present.
// If neither, use class (service)
String name = getDevNodeProperty(node, CM_DRP_FRIENDLYNAME, buf, size);
if (name.isEmpty()) {
name = getDevNodeProperty(node, CM_DRP_DEVICEDESC, buf, size);
}
if (name.isEmpty()) {
name = getDevNodeProperty(node, CM_DRP_CLASS, buf, size);
String svc = getDevNodeProperty(node, CM_DRP_SERVICE, buf, size);
if (!svc.isEmpty()) {
name = name + " (" + svc + ")";
}
}
nameMap.put(node, name);
mfgMap.put(node, getDevNodeProperty(node, CM_DRP_MFG, buf, size));
// Add any children to the queue, tracking the parent node
if (ERROR_SUCCESS == C32.CM_Get_Child(child, node, 0)) {
parentMap.put(child.getValue(), node);
deviceTree.add(child.getValue());
while (ERROR_SUCCESS == C32.CM_Get_Sibling(sibling, child.getValue(), 0)) {
parentMap.put(sibling.getValue(), node);
deviceTree.add(sibling.getValue());
child.setValue(sibling.getValue());
}
}
}
}
} finally {
SA.SetupDiDestroyDeviceInfoList(hDevInfo);
}
}
// Look for output without parents, these are top of tree
Set controllerDevices = deviceIdMap.keySet().stream().filter(k -> !parentMap.containsKey(k))
.collect(Collectors.toSet());
return new Quintet<>(controllerDevices, parentMap, nameMap, deviceIdMap, mfgMap);
}
private static String getDevNodeProperty(int node, int cmDrp, Memory buf, IntByReference size) {
buf.clear();
size.setValue((int) buf.size());
C32.CM_Get_DevNode_Registry_Property(node, cmDrp, null, buf, size, 0);
return buf.getWideString(0);
}
}